@jaak.ai/stamps 1.0.0-dev.7

package/dist/types/components/shared/mb-component/mb-component.d.ts

@@ -0,0 +1,308 @@
+import { EventEmitter } from "../../../stencil-public-runtime";
+import { CameraExperienceStateDurations, EventReady, EventScanError, EventScanSuccess, FeedbackMessage, SDKError } from "../../../utils/data-structures";
+import { SdkService } from "../../../utils/sdk.service";
+import { BlinkIDVariant } from "@microblink/blinkid-in-browser-sdk";
+import { TranslationService } from "../../../utils/translation.service";
+export declare class MbComponent {
+  private screens;
+  private overlays;
+  private gracePeriodEntered;
+  private cameraExperience;
+  private dragAndDropZone;
+  private errorMessage;
+  private scanFromCameraButton;
+  private scanFromImageButton;
+  private scanFromImageInput;
+  private videoElement;
+  private licenseExperienceModal;
+  private scanReset;
+  private detectionSuccessLock;
+  private isBackSide;
+  private initialBodyOverflowValue;
+  private cameraChangeInProgress;
+  private blocked;
+  private multiSideGalleryOpened;
+  private imageRecognitionType;
+  private imageBoxFirst;
+  private imageBoxSecond;
+  private areHelpScreensOpen;
+  private galleryImageFirstFile;
+  private galleryImageSecondFile;
+  private multiSideScanFromImageButton;
+  private isCameraActive;
+  galleryExperienceModalErrorWindowVisible: boolean;
+  clearIsCameraActive: boolean;
+  apiProcessStatusVisible: boolean;
+  apiProcessStatusState: "ERROR" | "LOADING" | "NONE" | "SUCCESS";
+  /**
+   * Host element as variable for manipulation (CSS in this case)
+   */
+  hostEl: HTMLElement;
+  /**
+   * See description in public component.
+   */
+  allowHelloMessage: boolean;
+  /**
+   * See description in public component.
+   */
+  engineLocation: string;
+  /**
+   * See description in public component.
+   */
+  workerLocation: string;
+  /**
+   * See description in public component.
+   */
+  licenseKey: string;
+  /**
+   * See description in public component.
+   */
+  wasmType: string | null;
+  blinkIdVariant?: BlinkIDVariant;
+  /**
+   * See description in public component.
+   */
+  recognizers: Array<string>;
+  /**
+   * See description in public component.
+   */
+  recognizerOptions: {
+    [key: string]: any;
+  };
+  /**
+   * See description in public component.
+   */
+  recognitionTimeout: number;
+  /**
+   * See description in public component.
+   */
+  recognitionPauseTimeout: number;
+  /**
+   * See description in public component.
+   */
+  cameraExperienceStateDurations: CameraExperienceStateDurations;
+  /**
+   * See description in public component.
+   */
+  includeSuccessFrame: boolean;
+  /**
+   * See description in public component.
+   */
+  enableDrag: boolean;
+  /**
+   * See description in public component.
+   */
+  hideLoadingAndErrorUi: boolean;
+  /**
+   * See description in public component.
+   */
+  rtl: boolean;
+  /**
+   * See description in public component.
+   */
+  scanFromCamera: boolean;
+  /**
+   * See description in public component.
+   */
+  scanFromImage: boolean;
+  /**
+   * See description in public component.
+   */
+  thoroughScanFromImage: boolean;
+  /**
+   * See description in public component.
+   */
+  galleryOverlayType: "FULLSCREEN" | "INLINE";
+  /**
+   * See description in public component.
+   */
+  galleryDropType: "FULLSCREEN" | "INLINE";
+  /**
+   * See description in public component.
+   */
+  showActionLabels: boolean;
+  /**
+   * See description in public component.
+   */
+  showModalWindows: boolean;
+  /**
+   * See description in public component.
+   */
+  showCameraFeedbackBarcodeMessage: boolean;
+  /**
+   * See description in public component.
+   */
+  showScanningLine: boolean;
+  /**
+   * See description in public component.
+   */
+  iconCameraDefault: string;
+  /**
+   * See description in public component.
+   */
+  iconCameraActive: string;
+  /**
+   * See description in public component.
+   */
+  iconGalleryDefault: string;
+  /**
+   * See description in public component.
+   */
+  iconDragAndDropGalleryDefault: string;
+  /**
+   * See description in public component.
+   */
+  iconDragAndDropWarningDefault: string;
+  /**
+   * See description in public component.
+   */
+  iconGalleryActive: string;
+  /**
+   * See description in public component.
+   */
+  iconInvalidFormat: string;
+  /**
+   * See description in public component.
+   */
+  iconSpinnerScreenLoading: string;
+  /**
+   * See description in public component.
+   */
+  iconSpinnerFromGalleryExperience: string;
+  /**
+   * See description in public component.
+   */
+  iconGalleryScanningCompleted: string;
+  /**
+   * Instance of SdkService passed from root component.
+   */
+  sdkService: SdkService;
+  /**
+   * Instance of TranslationService passed from root component.
+   */
+  translationService: TranslationService;
+  /**
+   * Camera device ID passed from root component.
+   */
+  cameraId: string | null;
+  /**
+   * Dictates if Help Screens usage is allowed (turned on).
+   */
+  allowHelpScreens: boolean;
+  /**
+   * See description in public component.
+   */
+  allowHelpScreensFab: boolean;
+  /**
+   * See description in public component.
+   */
+  allowHelpScreensOnboarding: boolean;
+  /**
+   * See description in public component.
+   */
+  allowHelpScreensOnboardingPerpetuity: boolean;
+  /**
+   * See description in public component.
+   */
+  helpScreensTooltipPauseTimeout: number;
+  /**
+   * See description in public component.
+   */
+  pingProxyUrl: string | null;
+  /**
+   * Event containing boolean which used to check whether component is blocked.
+   */
+  block: EventEmitter<boolean>;
+  /**
+   * See event 'fatalError' in public component.
+   */
+  fatalError: EventEmitter<SDKError>;
+  /**
+   * See event 'ready' in public component.
+   */
+  ready: EventEmitter<EventReady>;
+  /**
+   * See event 'scanError' in public component.
+   */
+  scanError: EventEmitter<EventScanError>;
+  /**
+   * See event 'scanSuccess' in public component.
+   */
+  scanSuccess: EventEmitter<EventScanSuccess>;
+  /**
+   * Event containing FeedbackMessage which can be passed to MbFeedback component.
+   */
+  feedback: EventEmitter<FeedbackMessage>;
+  /**
+   * See event 'cameraScanStarted' in public component.
+   */
+  cameraScanStarted: EventEmitter<null>;
+  /**
+   * See event 'imageScanStarted' in public component.
+   */
+  imageScanStarted: EventEmitter<null>;
+  /**
+   * See event 'scanAborted' in public component.
+   */
+  scanAborted: EventEmitter<null>;
+  /**
+   * Emitted when camera stream becomes active.
+   */
+  setIsCameraActive: EventEmitter<boolean>;
+  componentDidLoad(): void;
+  componentDidUpdate(): void;
+  disconnectedCallback(): void;
+  handleKeyUp(ev: KeyboardEvent): void;
+  private handleSetIsCameraActive;
+  /**
+   * Starts camera scan using camera overlay with usage instructions.
+   */
+  startCameraScan(): Promise<void>;
+  /**
+   * Starts image scan, emits results from provided file.
+   *
+   * @param file File to scan
+   */
+  startImageScan(file: File): Promise<void>;
+  /**
+   * Starts multi-side image scan, emits results from provided files.
+   *
+   * @param firstFile File to scan as first image
+   * @param secondFile File to scan as second image
+   */
+  startMultiSideImageScan(firstFile: File, secondFile: File): Promise<void>;
+  /**
+   * Method is exposed outside which allow us to control UI state from parent component.
+   *
+   * In case of state `ERROR` and if `showModalWindows` is set to `true`, modal window
+   * with error message will be displayed.
+   */
+  setUiState(state: "ERROR" | "LOADING" | "NONE" | "SUCCESS"): Promise<void>;
+  closeApiProcessStatus(restart?: boolean): Promise<void>;
+  private init;
+  private flipCameraAction;
+  private changeCameraDevice;
+  private checkInputProperties;
+  private startScanFromCamera;
+  private startScanFromImage;
+  private startScanFromImageMultiSide;
+  private handleScanError;
+  private showLicenseInfoModal;
+  private showScreen;
+  private showOverlay;
+  private setDragAndDrop;
+  private setFatalError;
+  private abortScan;
+  private stopRecognition;
+  private closeGalleryExperienceModal;
+  private onFromImageClicked;
+  private clearInputImages;
+  private openMultiSideGalleryUpload;
+  private closeMultiSideGalleryUpload;
+  private onMultiSideImageChange;
+  private showScanFromImageUi;
+  private hideScanFromImageUi;
+  private terminateHelpScreens;
+  private initializeHelpScreensAndStartOnboarding;
+  render(): any;
+}

package/dist/types/components/shared/mb-component/mb-component.utils.d.ts

@@ -0,0 +1,3 @@
+import * as BlinkIDSDK from "@microblink/blinkid-in-browser-sdk";
+declare function getSDKWasmType(wasmType: string): BlinkIDSDK.WasmType | null;
+export { getSDKWasmType };

package/dist/types/components/shared/mb-container/mb-container.d.ts

@@ -0,0 +1,8 @@
+export declare class MbContainer {
+  /**
+   * Host element as variable for manipulation
+   */
+  hostEl: HTMLElement;
+  componentDidLoad(): void;
+  render(): any;
+}

package/dist/types/components/shared/mb-feedback/mb-feedback.d.ts

@@ -0,0 +1,19 @@
+import { FeedbackMessage } from "../../../utils/data-structures";
+export declare class MbFeedback {
+  paragraphClassName: string;
+  paragraphValue: string;
+  /**
+   * Set to 'true' if component should be visible.
+   */
+  visible: boolean;
+  /**
+   * Call when FeedbackMessage which should be displayed.
+   */
+  show(feedback: FeedbackMessage): Promise<void>;
+  /**
+   * Host element as variable for manipulation
+   */
+  hostEl: HTMLElement;
+  componentDidLoad(): void;
+  render(): any;
+}

package/dist/types/components/shared/mb-feedback/mb-feedback.utils.d.ts

@@ -0,0 +1,2 @@
+declare function getFeedbackClassName(state: "FEEDBACK_ERROR" | "FEEDBACK_INFO" | "FEEDBACK_OK"): string;
+export { getFeedbackClassName };

package/dist/types/components/shared/mb-help/mb-help.d.ts

@@ -0,0 +1,66 @@
+import { TranslationService } from "../../../utils/translation.service";
+import { MbHelpCallbacks } from "./mb-help.model";
+export declare class MbHelp {
+  private readonly ONBOARDING_OPEN_DELAY_MS;
+  private texts;
+  private onboardingOpenCount;
+  private tooltipTimerId;
+  private callbacks;
+  isInitialized: boolean;
+  isTooltipShownHover: boolean;
+  isTooltipShownTimer: boolean;
+  isModalShown: boolean;
+  activeStepIndex: number;
+  /**
+   * Dictates if usage is allowed (turned on).
+   */
+  allow: boolean;
+  /**
+   * Dictates if Floating-Action-Button (Fab) is shown.
+   */
+  allowFab: boolean;
+  /**
+   * Dictates if the onboarding is allowed.
+   */
+  allowOnboarding: boolean;
+  /**
+   * Dictates if onboarding is executed all the time, or just once.
+   */
+  allowOnboardingPerpetuity: boolean;
+  /**
+   * Dictates Milliseconds after which a "Need Help?" tooltip will be shown.
+   */
+  tooltipPauseTimeout: number;
+  /**
+   * Translation service.
+   */
+  translationService: TranslationService;
+  /**
+   * Initializes - starts tooltip timer, etc.
+   */
+  initialize(callbacks: MbHelpCallbacks): Promise<void>;
+  /**
+   * Opens modal for Onboarding purpose.
+   */
+  openOnboarding(): Promise<void>;
+  /**
+   * Opens modal for Help Screens purpose.
+   */
+  openHelpScreens(): Promise<void>;
+  /**
+   * Closes modal.
+   */
+  close(): Promise<void>;
+  /**
+   * Terminates - cancels tooltip timer, closes modal, etc.
+   */
+  terminate(): Promise<void>;
+  constructor();
+  private openInternal;
+  private closeInternal;
+  private startTooltipTimer;
+  private cancelTooltipTimer;
+  private amIVisible;
+  render(): any;
+  private prepareTexts;
+}

package/dist/types/components/shared/mb-help/mb-help.model.d.ts

@@ -0,0 +1,9 @@
+export declare const DEFEAULT_MB_HELP_ALLOW = false;
+export declare const DEFEAULT_MB_HELP_ALLOW_LOBBY = false;
+export declare const DEFEAULT_MB_HELP_ALLOW_ONBOARDING = false;
+export declare const DEFEAULT_MB_HELP_ALLOW_ONBOARDING_PERPETUITY = false;
+export declare const DEFAULT_MB_HELP_TOOLTOP_PAUSE_TIMEOUT_MS = 15000;
+export interface MbHelpCallbacks {
+  onOpen: () => void;
+  onClose: () => void;
+}

package/dist/types/components/shared/mb-image-box/mb-image-box.d.ts

@@ -0,0 +1,35 @@
+import { EventEmitter } from "../../../stencil-public-runtime";
+export declare class MbImageBox {
+  private scanFromImageInput;
+  private ctaLabel;
+  private addIcon;
+  private removeIcon;
+  private hasImage;
+  /**
+   * Text which represents name of the image.
+   */
+  boxTitle: string;
+  /**
+   * Text which should be displayed inside 'Add image' anchor element when file
+   * is not selected.
+   */
+  anchorText: string;
+  /**
+   * Event which is triggered when selected image file is changed.
+   */
+  imageChange: EventEmitter<FileList>;
+  /**
+   * Host element as variable for manipulation
+   */
+  hostEl: HTMLElement;
+  componentDidLoad(): void;
+  componentDidRender(): void;
+  /**
+   * Clear input image.
+   */
+  clear(): Promise<void>;
+  private onFromImageClicked;
+  private onImageChange;
+  private onClearImage;
+  render(): any;
+}

package/dist/types/components/shared/mb-modal/mb-modal.d.ts

@@ -0,0 +1,53 @@
+import { EventEmitter } from "../../../stencil-public-runtime";
+export declare class MbModal {
+  /**
+   * Show modal content
+   */
+  visible: boolean;
+  /**
+   * Show shadow drop
+   */
+  elevated: boolean;
+  /**
+   * Center component
+   */
+  centered: boolean;
+  /**
+   * Passed title content from parent component
+   */
+  modalTitle: string;
+  /**
+   * Passed body content from parent component
+   */
+  content: string;
+  /**
+   * Center content inside modal
+   */
+  contentCentered: boolean;
+  /**
+   * Whether to show back arrow or not
+   */
+  showBackButton: boolean;
+  /**
+   * Whether to hide the footer or not
+   */
+  hideFooter: boolean;
+  /**
+   * Whether to hide the close button or not.
+   */
+  hideCloseButton: boolean;
+  /**
+   * Emitted when user clicks on 'X' button.
+   */
+  close: EventEmitter<void>;
+  /**
+   * Emitted when user clicks on 'Back Arrow' button.
+   */
+  back: EventEmitter<void>;
+  /**
+   * Host element as variable for manipulation
+   */
+  hostEl: HTMLElement;
+  componentDidLoad(): void;
+  render(): any;
+}

package/dist/types/components/shared/mb-overlay/mb-overlay.d.ts

@@ -0,0 +1,17 @@
+export declare class MbOverlay {
+  /**
+   * Set to 'false' if overlay should not cover whole screen.
+   */
+  fullscreen: boolean;
+  /**
+   * Set to 'true' if overlay should be visible.
+   */
+  visible: boolean;
+  /**
+   * Host element as variable for manipulation
+   */
+  hostEl: HTMLElement;
+  componentDidLoad(): void;
+  getHostClassNames(): string;
+  render(): any;
+}

package/dist/types/components/shared/mb-progress-tracker/mb-progress-tracker.d.ts

@@ -0,0 +1,19 @@
+export declare class MbProgressTracker {
+  /**
+   * Steps count.
+   *
+   * Default is 3.
+   */
+  size: number;
+  /**
+   * Current step.
+   *
+   * Steps start from 1 up to the size number.
+   *
+   * Default is 1.
+   */
+  current: number;
+  render(): any;
+  private getCurrentCorrected;
+  private getSteps;
+}

package/dist/types/components/shared/mb-screen/mb-screen.d.ts

@@ -0,0 +1,12 @@
+export declare class MbScreen {
+  /**
+   * Set to 'true' if screen should be visible.
+   */
+  visible: boolean;
+  /**
+   * Host element as variable for manipulation
+   */
+  hostEl: HTMLElement;
+  componentDidLoad(): void;
+  render(): any;
+}

package/dist/types/components/shared/mb-spinner/mb-spinner.d.ts

@@ -0,0 +1,16 @@
+export declare class MbSpinner {
+  /**
+   * Value of `src` attribute for <img> element.
+   */
+  icon: string;
+  /**
+   * Spinner size, can be 'default' or 'large'.
+   */
+  size: string;
+  /**
+   * Host element as variable for manipulation
+   */
+  hostEl: HTMLElement;
+  componentDidLoad(): void;
+  render(): any;
+}

package/dist/types/components/shared/mb-tooltip/mb-tooltip.d.ts

@@ -0,0 +1,10 @@
+export declare class MbTooltip {
+  show: boolean;
+  message: string;
+  arrowPosition?: "arrow-left" | "arrow-right" | "arrow-up" | "arrow-down" | "arrow-none";
+  showWarningIcon?: boolean;
+  showInfoIcon?: boolean;
+  textAlign?: "text-center" | "text-left" | "text-right";
+  containerWidth?: string;
+  render(): any;
+}

package/dist/types/components/shared/mb-tooltip-advanced/mb-tooltip-advanced.d.ts

@@ -0,0 +1,7 @@
+export declare class MbTooltipAdvanced {
+  show: boolean;
+  message: string;
+  arrowPosition?: "arrow-left" | "arrow-right" | "arrow-up" | "arrow-up-left" | "arrow-up-right" | "arrow-down" | "arrow-down-left" | "arrow-down-right";
+  textAlign?: "text-center" | "text-left" | "text-right";
+  render(): any;
+}