@bigbinary/neeto-playwright-commons 1.19.2 → 1.19.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -838,6 +838,48 @@ declare class MailerUtils {
838
838
  expectedEmailCount
839
839
  }?: Partial<FindMessageFilterOptions> | undefined, shouldThrowErrorOnTimeout?: boolean) => Promise<AttachmentDetails | undefined>;
840
840
  }
841
+ /**
842
+ *
843
+ * Decodes a QR code from an image file and returns the decoded string.
844
+ *
845
+ * filePath: A string representing the path to the image file containing the QR code.
846
+ *
847
+ * Returns: A string representing the decoded content of the QR code, or undefined if decoding fails.
848
+ *
849
+ * @example
850
+ *
851
+ * import { decodeQRCodeFromFile } from "@bigbinary/neeto-playwright-commons";
852
+ *
853
+ * const filePath = "path/to/qrCodeImage.png";
854
+ *
855
+ * const decodedString = await decodeQRCodeFromFile(filePath);
856
+ * @endexample
857
+ */
858
+ declare const decodeQRCodeFromFile: (filePath: string) => Promise<string | undefined>;
859
+ declare class QRCodeUtils {
860
+ private page;
861
+ constructor(page: Page);
862
+ verifyQRCodeInFile: (qrCodeDownloadButton: Locator, qrCodeContent: string) => Promise<void>;
863
+ verifyQRCodeOnScreen: (qrCodeCanvas: Locator, qrCodeContent: string) => Promise<void>;
864
+ /**
865
+ *
866
+ * Decodes a QR code from an image file and returns the decoded string.
867
+ *
868
+ * filePath: A string representing the path to the image file containing the QR code.
869
+ *
870
+ * Returns: A string representing the decoded content of the QR code, or undefined if decoding fails.
871
+ *
872
+ * @example
873
+ *
874
+ * import { decodeQRCodeFromFile } from "@bigbinary/neeto-playwright-commons";
875
+ *
876
+ * const filePath = "path/to/qrCodeImage.png";
877
+ *
878
+ * const decodedString = await decodeQRCodeFromFile(filePath);
879
+ * @endexample
880
+ */
881
+ decodeQRCodeFromFile: (filePath: string) => Promise<string | undefined>;
882
+ }
841
883
  type Hex = Lowercase<`#${string}`>;
842
884
  interface BaseThemeStyle {
843
885
  primaryColor: Hex;
@@ -910,6 +952,7 @@ interface CustomFixture {
910
952
  page: Page;
911
953
  mailerUtils: MailerUtils;
912
954
  colorPicker: ColorPickerUtils;
955
+ qrCodeUtils: QRCodeUtils;
913
956
  }
914
957
  type Commands = Fixtures<CustomFixture, PlaywrightWorkerArgs & PlaywrightWorkerOptions, PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
915
958
  declare const commands: Commands;
@@ -6413,24 +6456,6 @@ declare const headerUtils: {
6413
6456
  titlesAndRoutes
6414
6457
  }: VerifyBreadcrumbProps) => Promise<void>;
6415
6458
  };
6416
- /**
6417
- *
6418
- * Decodes a QR code from an image file and returns the decoded string.
6419
- *
6420
- * filePath: A string representing the path to the image file containing the QR code.
6421
- *
6422
- * Returns: A string representing the decoded content of the QR code, or undefined if decoding fails.
6423
- *
6424
- * @example
6425
- *
6426
- * import { decodeQRCodeFromFile } from "@bigbinary/neeto-playwright-commons";
6427
- *
6428
- * const filePath = "path/to/qrCodeImage.png";
6429
- *
6430
- * const decodedString = await decodeQRCodeFromFile(filePath);
6431
- * @endexample
6432
- */
6433
- declare const decodeQRCodeFromFile: (filePath: string) => Promise<string | undefined>;
6434
6459
  /**
6435
6460
  *
6436
6461
  * Initializes TOTP authentication by creating a TOTP instance with the specified issuer and secret. It takes the following parameters: