version 1.0.0. Ticket class replaced by Generator

CHANGELOG.md

@@ -1,3 +1,8 @@
+## [1.0.0]
+
+- `Ticket` class replaced by `Generator`.
+- New code generation concept: Unlike `Ticket`, each method returns corresponding command's byte code
+
 ## [0.4.9]
 
 - Xprinter profile: added cp1258 (vietnamese)

README.md

@@ -2,7 +2,7 @@
 
 [![Pub Version](https://img.shields.io/pub/v/esc_pos_utils)](https://pub.dev/packages/esc_pos_utils)
 
-Base Flutter/Dart classes for ESC/POS printing. `Ticket` class generates ESC/POS commands that can be sent to a thermal printer.
+Base Flutter/Dart classes for ESC/POS printing. `Generator` class generates ESC/POS commands that can be sent to a thermal printer.
 
 This is the "base" library that used for:
 
@@ -30,43 +30,45 @@ This is the "base" library that used for:
 ### Simple ticket with styles:
 
 ```dart
-Ticket testTicket() {
+List<int> testTicket() {
+  final List<int> bytes = [];
   // Using default profile
   final profile = await CapabilityProfile.load();
-  final Ticket ticket = Ticket(PaperSize.mm80, profile);
+  final generator = Generator(PaperSize.mm80, profile);
+  List<int> bytes = [];
 
-  ticket.text(
+  bytes += generator.text(
       'Regular: aA bB cC dD eE fF gG hH iI jJ kK lL mM nN oO pP qQ rR sS tT uU vV wW xX yY zZ');
-  ticket.text('Special 1: àÀ èÈ éÉ ûÛ üÜ çÇ ôÔ',
+  bytes += generator.text('Special 1: àÀ èÈ éÉ ûÛ üÜ çÇ ôÔ',
       styles: PosStyles(codeTable: PosCodeTable.westEur));
-  ticket.text('Special 2: blåbærgrød',
+  bytes += generator.text('Special 2: blåbærgrød',
       styles: PosStyles(codeTable: PosCodeTable.westEur));
 
-  ticket.text('Bold text', styles: PosStyles(bold: true));
-  ticket.text('Reverse text', styles: PosStyles(reverse: true));
-  ticket.text('Underlined text',
+  bytes += generator.text('Bold text', styles: PosStyles(bold: true));
+  bytes += generator.text('Reverse text', styles: PosStyles(reverse: true));
+  bytes += generator.text('Underlined text',
       styles: PosStyles(underline: true), linesAfter: 1);
-  ticket.text('Align left', styles: PosStyles(align: PosAlign.left));
-  ticket.text('Align center', styles: PosStyles(align: PosAlign.center));
-  ticket.text('Align right',
+  bytes += generator.text('Align left', styles: PosStyles(align: PosAlign.left));
+  bytes += generator.text('Align center', styles: PosStyles(align: PosAlign.center));
+  bytes += generator.text('Align right',
       styles: PosStyles(align: PosAlign.right), linesAfter: 1);
 
-  ticket.text('Text size 200%',
+  bytes += generator.text('Text size 200%',
       styles: PosStyles(
         height: PosTextSize.size2,
         width: PosTextSize.size2,
       ));
 
-  ticket.feed(2);
-  ticket.cut();
-  return ticket;
+  bytes += generator.feed(2);
+  bytes += generator.cut();
+  return bytes;
 }
 ```
 
 ### Print a table row:
 
 ```dart
-ticket.row([
+generator.row([
     PosColumn(
       text: 'col3',
       width: 3,
@@ -103,26 +105,26 @@ final ByteData data = await rootBundle.load('assets/logo.png');
 final Uint8List bytes = data.buffer.asUint8List();
 final Image image = decodeImage(bytes);
 // Using `ESC *`
-ticket.image(image);
+generator.image(image);
 // Using `GS v 0` (obsolete)
-ticket.imageRaster(image);
+generator.imageRaster(image);
 // Using `GS ( L`
-ticket.imageRaster(image, imageFn: PosImageFn.graphics);
+generator.imageRaster(image, imageFn: PosImageFn.graphics);
 ```
 
 ### Print a Barcode:
 
 ```dart
 final List<int> barData = [1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 4];
-ticket.barcode(Barcode.upcA(barData));
+generator.barcode(Barcode.upcA(barData));
 ```
 
 ### Print a QR Code:
 
 Using native ESC/POS commands:
 
 ```dart
-ticket.qrcode('example.com');
+generator.qrcode('example.com');
 ```
 
 To print a QR Code as an image (if your printer doesn't support native commands), add [qr_flutter](https://pub.dev/packages/qr_flutter) and [path_provider](https://pub.dev/packages/path_provider) as a dependency in your `pubspec.yaml` file.
@@ -142,7 +144,7 @@ try {
   final imgFile = await qrFile.writeAsBytes(uiImg.buffer.asUint8List());
   final img = decodeImage(imgFile.readAsBytesSync());
 
-  ticket.image(img);
+  generator.image(img);
 } catch (e) {
   print(e);
 }
@@ -155,8 +157,8 @@ Different printers support different sets of code tables. Some printer models ar
 ```dart
 // Xprinter XP-N160I
 final profile = await CapabilityProfile.load('XP-N160I');
-final Ticket ticket = Ticket(PaperSize.mm80, profile);
-ticket.setGlobalCodeTable('CP1252');
+final generator = Generator(PaperSize.mm80, profile);
+bytes += generator.setGlobalCodeTable('CP1252');
 ```
 
 All available profiles can be retrieved by calling :

example/example.dart

@@ -4,25 +4,29 @@ import 'package:flutter/services.dart';
 import 'package:esc_pos_utils/esc_pos_utils.dart';
 
 Future<void> main() async {
-  CapabilityProfile profile = await CapabilityProfile.load();
-  final Ticket ticket = Ticket(PaperSize.mm80, profile);
+  final profile = await CapabilityProfile.load();
+  final generator = Generator(PaperSize.mm80, profile);
+  List<int> bytes = [];
 
-  ticket.text(
+  bytes += generator.text(
       'Regular: aA bB cC dD eE fF gG hH iI jJ kK lL mM nN oO pP qQ rR sS tT uU vV wW xX yY zZ');
-  ticket.text('Special 1: àÀ èÈ éÉ ûÛ üÜ çÇ ôÔ',
+  bytes += generator.text('Special 1: àÀ èÈ éÉ ûÛ üÜ çÇ ôÔ',
+      styles: PosStyles(codeTable: 'CP1252'));
+  bytes += generator.text('Special 2: blåbærgrød',
       styles: PosStyles(codeTable: 'CP1252'));
-  ticket.text('Special 2: blåbærgrød', styles: PosStyles(codeTable: 'CP1252'));
 
-  ticket.text('Bold text', styles: PosStyles(bold: true));
-  ticket.text('Reverse text', styles: PosStyles(reverse: true));
-  ticket.text('Underlined text',
+  bytes += generator.text('Bold text', styles: PosStyles(bold: true));
+  bytes += generator.text('Reverse text', styles: PosStyles(reverse: true));
+  bytes += generator.text('Underlined text',
       styles: PosStyles(underline: true), linesAfter: 1);
-  ticket.text('Align left', styles: PosStyles(align: PosAlign.left));
-  ticket.text('Align center', styles: PosStyles(align: PosAlign.center));
-  ticket.text('Align right',
+  bytes +=
+      generator.text('Align left', styles: PosStyles(align: PosAlign.left));
+  bytes +=
+      generator.text('Align center', styles: PosStyles(align: PosAlign.center));
+  bytes += generator.text('Align right',
       styles: PosStyles(align: PosAlign.right), linesAfter: 1);
 
-  ticket.row([
+  bytes += generator.row([
     PosColumn(
       text: 'col3',
       width: 3,
@@ -40,23 +44,23 @@ Future<void> main() async {
     ),
   ]);
 
-  ticket.text('Text size 200%',
+  bytes += generator.text('Text size 200%',
       styles: PosStyles(
         height: PosTextSize.size2,
         width: PosTextSize.size2,
       ));
 
   // Print image:
   final ByteData data = await rootBundle.load('assets/logo.png');
-  final Uint8List bytes = data.buffer.asUint8List();
-  final Image image = decodeImage(bytes);
-  ticket.image(image);
+  final Uint8List imgBytes = data.buffer.asUint8List();
+  final Image image = decodeImage(imgBytes);
+  bytes += generator.image(image);
   // Print image using an alternative (obsolette) command
-  // ticket.imageRaster(image);
+  // bytes += generator.imageRaster(image);
 
   // Print barcode
   final List<int> barData = [1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 4];
-  ticket.barcode(Barcode.upcA(barData));
+  bytes += generator.barcode(Barcode.upcA(barData));
 
   // Print mixed (chinese + latin) text. Only for printers supporting Kanji mode
   // ticket.text(
@@ -65,7 +69,6 @@ Future<void> main() async {
   //   containsChinese: true,
   // );
 
-  ticket.feed(2);
-
-  ticket.cut();
+  bytes += generator.feed(2);
+  bytes += generator.cut();
 }

lib/esc_pos_utils.dart

@@ -14,4 +14,4 @@ export './src/enums.dart';
 export './src/pos_column.dart';
 export './src/pos_styles.dart';
 export './src/qrcode.dart';
-export './src/ticket.dart';
+export './src/generator.dart';