@microblink/camera-manager 7.2.1 → 7.2.3

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.
Files changed (58) hide show
  1. package/dist/camera-manager.js +182 -48
  2. package/dist/camera-manager.js.map +1 -1
  3. package/package.json +1 -1
  4. package/types/core/Camera.d.ts +73 -0
  5. package/types/core/Camera.d.ts.map +1 -1
  6. package/types/core/CameraManager.d.ts +87 -7
  7. package/types/core/CameraManager.d.ts.map +1 -1
  8. package/types/core/VideoFrameProcessor.d.ts +28 -6
  9. package/types/core/VideoFrameProcessor.d.ts.map +1 -1
  10. package/types/core/cameraError.d.ts +22 -0
  11. package/types/core/cameraError.d.ts.map +1 -0
  12. package/types/core/cameraManagerStore.d.ts +10 -3
  13. package/types/core/cameraManagerStore.d.ts.map +1 -1
  14. package/types/core/cameraNames.d.ts +21 -5
  15. package/types/core/cameraNames.d.ts.map +1 -1
  16. package/types/core/cameraUtils.d.ts +34 -13
  17. package/types/core/cameraUtils.d.ts.map +1 -1
  18. package/types/core/iosCameraNames.d.ts +3 -0
  19. package/types/core/iosCameraNames.d.ts.map +1 -1
  20. package/types/core/utils.d.ts +18 -0
  21. package/types/core/utils.d.ts.map +1 -1
  22. package/types/index.d.ts +11 -1
  23. package/types/index.d.ts.map +1 -1
  24. package/types/index.rollup.d.ts +264 -21
  25. package/types/media-mock/MediaMocker.d.ts +67 -0
  26. package/types/media-mock/MediaMocker.d.ts.map +1 -1
  27. package/types/media-mock/createInputDeviceInfo.d.ts +9 -0
  28. package/types/media-mock/createInputDeviceInfo.d.ts.map +1 -1
  29. package/types/media-mock/defineProperty.d.ts +6 -3
  30. package/types/media-mock/defineProperty.d.ts.map +1 -1
  31. package/types/media-mock/fake-devices.d.ts +6 -0
  32. package/types/media-mock/fake-devices.d.ts.map +1 -1
  33. package/types/ui/CameraErrorModal.d.ts +3 -0
  34. package/types/ui/CameraErrorModal.d.ts.map +1 -1
  35. package/types/ui/CameraSelector.d.ts +3 -0
  36. package/types/ui/CameraSelector.d.ts.map +1 -1
  37. package/types/ui/CameraUiStoreContext.d.ts +14 -0
  38. package/types/ui/CameraUiStoreContext.d.ts.map +1 -1
  39. package/types/ui/CaptureScreen.d.ts +12 -0
  40. package/types/ui/CaptureScreen.d.ts.map +1 -1
  41. package/types/ui/Header.d.ts +3 -0
  42. package/types/ui/Header.d.ts.map +1 -1
  43. package/types/ui/LocalizationContext.d.ts +12 -0
  44. package/types/ui/LocalizationContext.d.ts.map +1 -1
  45. package/types/ui/RootComponent.d.ts +3 -0
  46. package/types/ui/RootComponent.d.ts.map +1 -1
  47. package/types/ui/SolidShadowRoot.d.ts +16 -3
  48. package/types/ui/SolidShadowRoot.d.ts.map +1 -1
  49. package/types/ui/createCameraManagerUi.d.ts +33 -3
  50. package/types/ui/createCameraManagerUi.d.ts.map +1 -1
  51. package/types/ui/determineFitMode.d.ts +7 -6
  52. package/types/ui/determineFitMode.d.ts.map +1 -1
  53. package/types/ui/getVisibleVideoArea.d.ts +7 -1
  54. package/types/ui/getVisibleVideoArea.d.ts.map +1 -1
  55. package/types/ui/locales/en.d.ts +3 -0
  56. package/types/ui/locales/en.d.ts.map +1 -1
  57. package/types/ui/zustandRefStore.d.ts +12 -0
  58. package/types/ui/zustandRefStore.d.ts.map +1 -1
@@ -3,35 +3,102 @@
3
3
  */
4
4
  import { FacingMode } from "../core/Camera";
5
5
  import { ExtendedCameraInfo, fakeDevices } from "./fake-devices";
6
+ /**
7
+ * Options for the MediaMocker.
8
+ */
6
9
  export type MediaMockerOptions = Partial<{
7
10
  device: keyof typeof fakeDevices;
8
11
  facing: FacingMode;
9
12
  reverseCameraOrder: boolean;
10
13
  }>;
14
+ /**
15
+ * The MediaMocker class.
16
+ */
11
17
  declare class MediaMocker {
12
18
  #private;
13
19
  fakeDevice: keyof typeof fakeDevices;
14
20
  facing: FacingMode;
15
21
  cameras: ExtendedCameraInfo[];
22
+ /**
23
+ * Creates a new MediaMocker.
24
+ *
25
+ * @param options - The options for the MediaMocker.
26
+ */
16
27
  constructor(options?: MediaMockerOptions);
28
+ /**
29
+ * Reverses the camera order.
30
+ */
17
31
  reverseCameraOrder(): void;
32
+ /**
33
+ * Gets the camera devices.
34
+ *
35
+ * @returns The camera devices.
36
+ */
18
37
  getCameraDevices(): ExtendedCameraInfo[];
38
+ /**
39
+ * Sets the device.
40
+ *
41
+ * @param device - The device to set.
42
+ */
19
43
  setDevice(device: keyof typeof fakeDevices): void;
44
+ /**
45
+ * Configures the MediaMocker.
46
+ *
47
+ * @param options - The options for the MediaMocker.
48
+ */
20
49
  configure(options: MediaMockerOptions): void;
50
+ /**
51
+ * Mocks the enumerateDevices method.
52
+ */
21
53
  mockEnumerateDevices(): void;
54
+ /**
55
+ * Unmocks the enumerateDevices method.
56
+ */
22
57
  unmockEnumerateDevices(): void;
58
+ /**
59
+ * Mocks the MediaDevices methods.
60
+ */
23
61
  mock(): void;
62
+ /**
63
+ * Mocks the getUserMedia method.
64
+ */
24
65
  mockGetUserMedia(): void;
66
+ /**
67
+ * Unmocks the getUserMedia method.
68
+ */
25
69
  unmockGetUserMedia(): void;
70
+ /**
71
+ * Unmocks the MediaDevices methods.
72
+ */
26
73
  unmock(): void;
74
+ /**
75
+ * Resets the stream constraints.
76
+ */
27
77
  resetStreamConstraints(): void;
28
78
  /**
79
+ * Creates a fake stream.
80
+ *
81
+ * @param constraints - The constraints for the stream.
82
+ * @returns The fake stream.
29
83
  * @see MediaDevices.getUserMedia
30
84
  */
31
85
  createFakeStream(constraints: MediaStreamConstraints): Promise<MediaStream>;
86
+ /**
87
+ * Creates a fake track.
88
+ *
89
+ * @returns The fake track.
90
+ */
32
91
  createFakeTrack(): MediaStreamTrack;
92
+ /**
93
+ * Finds a device matching the constraints.
94
+ *
95
+ * @returns The device matching the constraints.
96
+ */
33
97
  findDeviceMatchingConstraints(): ExtendedCameraInfo;
34
98
  }
99
+ /**
100
+ * The media mocker singleton instance.
101
+ */
35
102
  export declare const mediaMocker: MediaMocker;
36
103
  export {};
37
104
  //# sourceMappingURL=MediaMocker.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"MediaMocker.d.ts","sourceRoot":"","sources":["../../src/media-mock/MediaMocker.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAG5C,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAGjE,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC;IACvC,MAAM,EAAE,MAAM,OAAO,WAAW,CAAC;IACjC,MAAM,EAAE,UAAU,CAAC;IACnB,kBAAkB,EAAE,OAAO,CAAC;CAC7B,CAAC,CAAC;AAEH,cAAM,WAAW;;IACf,UAAU,EAAE,MAAM,OAAO,WAAW,CAAe;IACnD,MAAM,EAAE,UAAU,CAAU;IAC5B,OAAO,EAAE,kBAAkB,EAAE,CAAC;gBAOlB,OAAO,CAAC,EAAE,kBAAkB;IAUxC,kBAAkB;IAIlB,gBAAgB;IAIhB,SAAS,CAAC,MAAM,EAAE,MAAM,OAAO,WAAW;IAK1C,SAAS,CAAC,OAAO,EAAE,kBAAkB;IAerC,oBAAoB;IAepB,sBAAsB;IAMtB,IAAI;IAKJ,gBAAgB;IAYhB,kBAAkB;IAMlB,MAAM;IAMN,sBAAsB;IAItB;;OAEG;IACH,gBAAgB,CAAC,WAAW,EAAE,sBAAsB,GAAG,OAAO,CAAC,WAAW,CAAC;IAa3E,eAAe,IAAI,gBAAgB;IA8DnC,6BAA6B;CAmD9B;AAED,eAAO,MAAM,WAAW,aAAoB,CAAC"}
1
+ {"version":3,"file":"MediaMocker.d.ts","sourceRoot":"","sources":["../../src/media-mock/MediaMocker.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAG5C,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAGjE;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC;IACvC,MAAM,EAAE,MAAM,OAAO,WAAW,CAAC;IACjC,MAAM,EAAE,UAAU,CAAC;IACnB,kBAAkB,EAAE,OAAO,CAAC;CAC7B,CAAC,CAAC;AAEH;;GAEG;AACH,cAAM,WAAW;;IACf,UAAU,EAAE,MAAM,OAAO,WAAW,CAAe;IACnD,MAAM,EAAE,UAAU,CAAU;IAC5B,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAO9B;;;;OAIG;gBACS,OAAO,CAAC,EAAE,kBAAkB;IAUxC;;OAEG;IACH,kBAAkB;IAIlB;;;;OAIG;IACH,gBAAgB;IAIhB;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,OAAO,WAAW;IAK1C;;;;OAIG;IACH,SAAS,CAAC,OAAO,EAAE,kBAAkB;IAerC;;OAEG;IACH,oBAAoB;IAepB;;OAEG;IACH,sBAAsB;IAMtB;;OAEG;IACH,IAAI;IAKJ;;OAEG;IACH,gBAAgB;IAYhB;;OAEG;IACH,kBAAkB;IAMlB;;OAEG;IACH,MAAM;IAMN;;OAEG;IACH,sBAAsB;IAItB;;;;;;OAMG;IACH,gBAAgB,CAAC,WAAW,EAAE,sBAAsB,GAAG,OAAO,CAAC,WAAW,CAAC;IAa3E;;;;OAIG;IACH,eAAe,IAAI,gBAAgB;IA8DnC;;;;OAIG;IACH,6BAA6B;CAmD9B;AAED;;GAEG;AACH,eAAO,MAAM,WAAW,aAAoB,CAAC"}
@@ -1,7 +1,13 @@
1
1
  /**
2
2
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
3
3
  */
4
+ /**
5
+ * Options for creating a fake `InputDeviceInfo` info object.
6
+ */
4
7
  interface CreateInputDeviceProps extends Partial<InputDeviceInfo> {
8
+ /**
9
+ * The label of the device.
10
+ */
5
11
  label: string;
6
12
  /**
7
13
  * The mock capabilities are used to simulate the capabilities of the device.
@@ -11,6 +17,9 @@ interface CreateInputDeviceProps extends Partial<InputDeviceInfo> {
11
17
  }
12
18
  /**
13
19
  * Creates a fake `InputDeviceInfo` info object.
20
+ *
21
+ * @param props - The properties for the device.
22
+ * @returns The fake `InputDeviceInfo` info object.
14
23
  */
15
24
  export declare const createInputDeviceInfo: ({ label, deviceId, groupId, kind, mockCapabilities, }: CreateInputDeviceProps) => InputDeviceInfo;
16
25
  export {};
@@ -1 +1 @@
1
- {"version":3,"file":"createInputDeviceInfo.d.ts","sourceRoot":"","sources":["../../src/media-mock/createInputDeviceInfo.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,UAAU,sBAAuB,SAAQ,OAAO,CAAC,eAAe,CAAC;IAC/D,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,CAAC;CACpD;AAED;;GAEG;AACH,eAAO,MAAM,qBAAqB,GAAI,uDASnC,sBAAsB,KAAG,eA0B3B,CAAC"}
1
+ {"version":3,"file":"createInputDeviceInfo.d.ts","sourceRoot":"","sources":["../../src/media-mock/createInputDeviceInfo.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,UAAU,sBAAuB,SAAQ,OAAO,CAAC,eAAe,CAAC;IAC/D;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,CAAC;CACpD;AAED;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,GAAI,uDASnC,sBAAsB,KAAG,eA0B3B,CAAC"}
@@ -2,9 +2,12 @@
2
2
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
3
3
  */
4
4
  /**
5
- * Taken from
6
- * https://github.com/eatsjobs/media-mock/blob/main/lib/defineProperty.ts
7
- * @returns a function that reverts the property to its original value
5
+ * Defines a property on an object.
6
+ *
7
+ * @param targetObject - The object to define the property on.
8
+ * @param property - The property to define.
9
+ * @param newValue - The value to define the property to.
10
+ * @returns A function that reverts the property to its original value.
8
11
  */
9
12
  export declare function defineProperty<T extends Record<string | symbol | number, any>>(targetObject: T, property: keyof T, newValue: unknown): () => void;
10
13
  //# sourceMappingURL=defineProperty.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"defineProperty.d.ts","sourceRoot":"","sources":["../../src/media-mock/defineProperty.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;GAIG;AAGH,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,EAC5E,YAAY,EAAE,CAAC,EACf,QAAQ,EAAE,MAAM,CAAC,EACjB,QAAQ,EAAE,OAAO,GAChB,MAAM,IAAI,CAeZ"}
1
+ {"version":3,"file":"defineProperty.d.ts","sourceRoot":"","sources":["../../src/media-mock/defineProperty.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;;;GAOG;AAGH,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,EAC5E,YAAY,EAAE,CAAC,EACf,QAAQ,EAAE,MAAM,CAAC,EACjB,QAAQ,EAAE,OAAO,GAChB,MAAM,IAAI,CAeZ"}
@@ -10,9 +10,15 @@ export type ExtendedCameraInfo = {
10
10
  streamCapabilities: ReturnType<MediaStreamTrack["getCapabilities"]>;
11
11
  mediaTrackSettings: ReturnType<MediaStreamTrack["getSettings"]>;
12
12
  };
13
+ /**
14
+ * A fake device.
15
+ */
13
16
  export type FakeDevice = {
14
17
  name: string;
15
18
  cameras: ExtendedCameraInfo[];
16
19
  };
20
+ /**
21
+ * The fake devices.
22
+ */
17
23
  export declare const fakeDevices: Record<string, FakeDevice>;
18
24
  //# sourceMappingURL=fake-devices.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"fake-devices.d.ts","sourceRoot":"","sources":["../../src/media-mock/fake-devices.ts"],"names":[],"mappings":"AAAA;;GAEG;AAOH;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,eAAe,EAAE,IAAI,CAAC,eAAe,EAAE,iBAAiB,GAAG,QAAQ,CAAC,CAAC;IACrE,kBAAkB,EAAE,UAAU,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACnE,kBAAkB,EAAE,UAAU,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACpE,kBAAkB,EAAE,UAAU,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC;CACjE,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,kBAAkB,EAAE,CAAC;CAC/B,CAAC;AAEF,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAKzC,CAAC"}
1
+ {"version":3,"file":"fake-devices.d.ts","sourceRoot":"","sources":["../../src/media-mock/fake-devices.ts"],"names":[],"mappings":"AAAA;;GAEG;AAOH;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,eAAe,EAAE,IAAI,CAAC,eAAe,EAAE,iBAAiB,GAAG,QAAQ,CAAC,CAAC;IACrE,kBAAkB,EAAE,UAAU,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACnE,kBAAkB,EAAE,UAAU,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACpE,kBAAkB,EAAE,UAAU,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC;CACjE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,kBAAkB,EAAE,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAKzC,CAAC"}
@@ -2,6 +2,9 @@
2
2
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
3
3
  */
4
4
  import { Component } from "solid-js";
5
+ /**
6
+ * The CameraErrorModal component.
7
+ */
5
8
  declare const CameraErrorModal: Component;
6
9
  export { CameraErrorModal };
7
10
  //# sourceMappingURL=CameraErrorModal.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"CameraErrorModal.d.ts","sourceRoot":"","sources":["../../src/ui/CameraErrorModal.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,SAAS,EAAQ,MAAM,UAAU,CAAC;AAK3C,QAAA,MAAM,gBAAgB,EAAE,SA0BvB,CAAC;AAEF,OAAO,EAAE,gBAAgB,EAAE,CAAC"}
1
+ {"version":3,"file":"CameraErrorModal.d.ts","sourceRoot":"","sources":["../../src/ui/CameraErrorModal.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,SAAS,EAAQ,MAAM,UAAU,CAAC;AAK3C;;GAEG;AACH,QAAA,MAAM,gBAAgB,EAAE,SA0BvB,CAAC;AAEF,OAAO,EAAE,gBAAgB,EAAE,CAAC"}
@@ -2,5 +2,8 @@
2
2
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
3
3
  */
4
4
  import { Component } from "solid-js";
5
+ /**
6
+ * The CameraSelector component.
7
+ */
5
8
  export declare const CameraSelector: Component;
6
9
  //# sourceMappingURL=CameraSelector.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"CameraSelector.d.ts","sourceRoot":"","sources":["../../src/ui/CameraSelector.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAKH,OAAO,EAAE,SAAS,EAA6B,MAAM,UAAU,CAAC;AAahE,eAAO,MAAM,cAAc,EAAE,SA2J5B,CAAC"}
1
+ {"version":3,"file":"CameraSelector.d.ts","sourceRoot":"","sources":["../../src/ui/CameraSelector.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAKH,OAAO,EAAE,SAAS,EAA6B,MAAM,UAAU,CAAC;AAgBhE;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,SA2J5B,CAAC"}
@@ -5,6 +5,9 @@ import { ParentComponent } from "solid-js";
5
5
  import { MountableElement } from "solid-js/web";
6
6
  import { CameraManager } from "../core/CameraManager";
7
7
  import { DismountCallback } from "./createCameraManagerUi";
8
+ /**
9
+ * Creates a camera manager solid store.
10
+ */
8
11
  declare function createCameraManagerSolidStore(): {
9
12
  (): import("solid-js").Accessor<import("..").CameraManagerStore>;
10
13
  <U>(selector: (state: import("..").CameraManagerStore) => U, equals?: ((a: U, b: U) => boolean) | undefined): U extends (U extends (...args: any[]) => any ? U : never) ? U : import("solid-js").Accessor<U>;
@@ -25,9 +28,11 @@ declare function createCameraManagerSolidStore(): {
25
28
  export type CameraUiStore = {
26
29
  /** Function which will dismount the component */
27
30
  dismountCameraUi: () => void;
31
+ /** The camera manager. */
28
32
  cameraManager: CameraManager;
29
33
  /** This is the camera manager zustand store converted to SolidJS' signal store via `solid-zustand` */
30
34
  cameraManagerSolidStore: ReturnType<typeof createCameraManagerSolidStore>;
35
+ /** The mountable HTML element. */
31
36
  mountTarget: MountableElement;
32
37
  /** Whether to show the mirror camera button */
33
38
  showMirrorCameraButton: boolean;
@@ -35,11 +40,16 @@ export type CameraUiStore = {
35
40
  showTorchButton: boolean;
36
41
  /** Whether to show the close button */
37
42
  showCloseButton: boolean;
43
+ /** Whether to show the camera error modal */
44
+ showCameraErrorModal: boolean;
38
45
  /** Sets a callback to be called when the component is unmounted.
39
46
  * Returns a cleanup function that removes the callback when called.
40
47
  */
41
48
  addOnDismountCallback: (fn: DismountCallback) => () => void;
42
49
  };
50
+ /**
51
+ * The CameraUiStoreProvider component.
52
+ */
43
53
  export declare const CameraUiStoreProvider: ParentComponent<{
44
54
  dismountCameraUi: () => void;
45
55
  cameraManager: CameraManager;
@@ -47,8 +57,12 @@ export declare const CameraUiStoreProvider: ParentComponent<{
47
57
  showMirrorCameraButton: boolean;
48
58
  showTorchButton: boolean;
49
59
  showCloseButton: boolean;
60
+ showCameraErrorModal: boolean;
50
61
  addOnDismountCallback: (fn: DismountCallback) => () => void;
51
62
  }>;
63
+ /**
64
+ * The useCameraUiStore hook.
65
+ */
52
66
  export declare function useCameraUiStore(): CameraUiStore;
53
67
  export {};
54
68
  //# sourceMappingURL=CameraUiStoreContext.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"CameraUiStoreContext.d.ts","sourceRoot":"","sources":["../../src/ui/CameraUiStoreContext.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAGL,eAAe,EAEhB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAEtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAI3D,iBAAS,6BAA6B;;;;;;;;;;;EAErC;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,iDAAiD;IACjD,gBAAgB,EAAE,MAAM,IAAI,CAAC;IAC7B,aAAa,EAAE,aAAa,CAAC;IAC7B,sGAAsG;IACtG,uBAAuB,EAAE,UAAU,CAAC,OAAO,6BAA6B,CAAC,CAAC;IAC1E,WAAW,EAAE,gBAAgB,CAAC;IAC9B,+CAA+C;IAC/C,sBAAsB,EAAE,OAAO,CAAC;IAChC,uCAAuC;IACvC,eAAe,EAAE,OAAO,CAAC;IACzB,uCAAuC;IACvC,eAAe,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,qBAAqB,EAAE,CAAC,EAAE,EAAE,gBAAgB,KAAK,MAAM,IAAI,CAAC;CAC7D,CAAC;AAEF,eAAO,MAAM,qBAAqB,EAAE,eAAe,CAAC;IAClD,gBAAgB,EAAE,MAAM,IAAI,CAAC;IAC7B,aAAa,EAAE,aAAa,CAAC;IAC7B,WAAW,EAAE,gBAAgB,CAAC;IAC9B,sBAAsB,EAAE,OAAO,CAAC;IAChC,eAAe,EAAE,OAAO,CAAC;IACzB,eAAe,EAAE,OAAO,CAAC;IACzB,qBAAqB,EAAE,CAAC,EAAE,EAAE,gBAAgB,KAAK,MAAM,IAAI,CAAC;CAC7D,CAiCA,CAAC;AAEF,wBAAgB,gBAAgB,kBAO/B"}
1
+ {"version":3,"file":"CameraUiStoreContext.d.ts","sourceRoot":"","sources":["../../src/ui/CameraUiStoreContext.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAGL,eAAe,EAEhB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAEtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAO3D;;GAEG;AACH,iBAAS,6BAA6B;;;;;;;;;;;EAErC;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,iDAAiD;IACjD,gBAAgB,EAAE,MAAM,IAAI,CAAC;IAE7B,0BAA0B;IAC1B,aAAa,EAAE,aAAa,CAAC;IAE7B,sGAAsG;IACtG,uBAAuB,EAAE,UAAU,CAAC,OAAO,6BAA6B,CAAC,CAAC;IAE1E,kCAAkC;IAClC,WAAW,EAAE,gBAAgB,CAAC;IAE9B,+CAA+C;IAC/C,sBAAsB,EAAE,OAAO,CAAC;IAChC,uCAAuC;IACvC,eAAe,EAAE,OAAO,CAAC;IACzB,uCAAuC;IACvC,eAAe,EAAE,OAAO,CAAC;IACzB,6CAA6C;IAC7C,oBAAoB,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,qBAAqB,EAAE,CAAC,EAAE,EAAE,gBAAgB,KAAK,MAAM,IAAI,CAAC;CAC7D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qBAAqB,EAAE,eAAe,CAAC;IAClD,gBAAgB,EAAE,MAAM,IAAI,CAAC;IAC7B,aAAa,EAAE,aAAa,CAAC;IAC7B,WAAW,EAAE,gBAAgB,CAAC;IAC9B,sBAAsB,EAAE,OAAO,CAAC;IAChC,eAAe,EAAE,OAAO,CAAC;IACzB,eAAe,EAAE,OAAO,CAAC;IACzB,oBAAoB,EAAE,OAAO,CAAC;IAC9B,qBAAqB,EAAE,CAAC,EAAE,EAAE,gBAAgB,KAAK,MAAM,IAAI,CAAC;CAC7D,CAmCA,CAAC;AAEF;;GAEG;AACH,wBAAgB,gBAAgB,kBAO/B"}
@@ -2,8 +2,20 @@
2
2
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
3
3
  */
4
4
  import { Component } from "solid-js";
5
+ /**
6
+ * The capture screen shadow root host ID.
7
+ */
5
8
  export declare const CAPTURE_SCREEN_SHADOW_ROOT_HOST_ID = "capture-screen-host";
9
+ /**
10
+ * The fit mode.
11
+ */
6
12
  export type FitMode = "contain" | "cover";
13
+ /**
14
+ * The CaptureScreen component.
15
+ */
7
16
  export declare const CaptureScreen: Component;
17
+ /**
18
+ * The CaptureScreenPortalled component.
19
+ */
8
20
  export declare const CaptureScreenPortalled: Component;
9
21
  //# sourceMappingURL=CaptureScreen.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"CaptureScreen.d.ts","sourceRoot":"","sources":["../../src/ui/CaptureScreen.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EACL,SAAS,EAMV,MAAM,UAAU,CAAC;AAwBlB,eAAO,MAAM,kCAAkC,wBAAwB,CAAC;AAExE,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,OAAO,CAAC;AAE1C,eAAO,MAAM,aAAa,EAAE,SAgK3B,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,SA4DpC,CAAC"}
1
+ {"version":3,"file":"CaptureScreen.d.ts","sourceRoot":"","sources":["../../src/ui/CaptureScreen.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EACL,SAAS,EAOV,MAAM,UAAU,CAAC;AAwBlB;;GAEG;AACH,eAAO,MAAM,kCAAkC,wBAAwB,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,OAAO,CAAC;AAE1C;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,SAsK3B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,EAAE,SA4DpC,CAAC"}
@@ -2,5 +2,8 @@
2
2
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
3
3
  */
4
4
  import { Component } from "solid-js";
5
+ /**
6
+ * The Header component.
7
+ */
5
8
  export declare const Header: Component;
6
9
  //# sourceMappingURL=Header.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Header.d.ts","sourceRoot":"","sources":["../../src/ui/Header.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,SAAS,EAA8B,MAAM,UAAU,CAAC;AAajE,eAAO,MAAM,MAAM,EAAE,SA4GpB,CAAC"}
1
+ {"version":3,"file":"Header.d.ts","sourceRoot":"","sources":["../../src/ui/Header.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,SAAS,EAA8B,MAAM,UAAU,CAAC;AAajE;;GAEG;AACH,eAAO,MAAM,MAAM,EAAE,SA4GpB,CAAC"}
@@ -4,14 +4,26 @@
4
4
  import { ParentComponent } from "solid-js";
5
5
  import { SetStoreFunction } from "solid-js/store";
6
6
  import enLocaleStrings from "./locales/en";
7
+ /**
8
+ * The camera UI locale record.
9
+ */
7
10
  export type CameraUiLocaleRecord = typeof enLocaleStrings;
11
+ /**
12
+ * The camera UI localization strings.
13
+ */
8
14
  export type CameraUiLocalizationStrings = {
9
15
  [K in keyof CameraUiLocaleRecord]: CameraUiLocaleRecord[K] | (string & {});
10
16
  };
17
+ /**
18
+ * The localization provider.
19
+ */
11
20
  export declare const LocalizationProvider: ParentComponent<{
12
21
  userStrings?: Partial<CameraUiLocalizationStrings>;
13
22
  setLocalizationRef: (fn: SetStoreFunction<CameraUiLocalizationStrings>) => void;
14
23
  }>;
24
+ /**
25
+ * The use localization hook.
26
+ */
15
27
  export declare function useLocalization(): {
16
28
  t: CameraUiLocalizationStrings;
17
29
  updateLocalization: SetStoreFunction<CameraUiLocalizationStrings>;
@@ -1 +1 @@
1
- {"version":3,"file":"LocalizationContext.d.ts","sourceRoot":"","sources":["../../src/ui/LocalizationContext.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAsC,MAAM,UAAU,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAe,MAAM,gBAAgB,CAAC;AAE/D,OAAO,eAAe,MAAM,cAAc,CAAC;AAE3C,MAAM,MAAM,oBAAoB,GAAG,OAAO,eAAe,CAAC;AAE1D,MAAM,MAAM,2BAA2B,GAAG;KAIvC,CAAC,IAAI,MAAM,oBAAoB,GAAG,oBAAoB,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC;CAC3E,CAAC;AAOF,eAAO,MAAM,oBAAoB,EAAE,eAAe,CAAC;IACjD,WAAW,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAEnD,kBAAkB,EAAE,CAClB,EAAE,EAAE,gBAAgB,CAAC,2BAA2B,CAAC,KAC9C,IAAI,CAAC;CACX,CA0BA,CAAC;AAEF,wBAAgB,eAAe;OAtC1B,2BAA2B;wBACV,gBAAgB,CAAC,2BAA2B,CAAC;EA2ClE"}
1
+ {"version":3,"file":"LocalizationContext.d.ts","sourceRoot":"","sources":["../../src/ui/LocalizationContext.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAsC,MAAM,UAAU,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAe,MAAM,gBAAgB,CAAC;AAE/D,OAAO,eAAe,MAAM,cAAc,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,OAAO,eAAe,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;KAIvC,CAAC,IAAI,MAAM,oBAAoB,GAAG,oBAAoB,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC;CAC3E,CAAC;AAUF;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,eAAe,CAAC;IACjD,WAAW,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAEnD,kBAAkB,EAAE,CAClB,EAAE,EAAE,gBAAgB,CAAC,2BAA2B,CAAC,KAC9C,IAAI,CAAC;CACX,CA0BA,CAAC;AAEF;;GAEG;AACH,wBAAgB,eAAe;OA5C1B,2BAA2B;wBACV,gBAAgB,CAAC,2BAA2B,CAAC;EAiDlE"}
@@ -2,6 +2,9 @@
2
2
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
3
3
  */
4
4
  import { Component } from "solid-js";
5
+ /**
6
+ * The root component.
7
+ */
5
8
  declare const RootComponent: Component;
6
9
  export { RootComponent };
7
10
  //# sourceMappingURL=RootComponent.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"RootComponent.d.ts","sourceRoot":"","sources":["../../src/ui/RootComponent.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAMrC,QAAA,MAAM,aAAa,EAAE,SAcpB,CAAC;AAEF,OAAO,EAAE,aAAa,EAAE,CAAC"}
1
+ {"version":3,"file":"RootComponent.d.ts","sourceRoot":"","sources":["../../src/ui/RootComponent.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAMrC;;GAEG;AACH,QAAA,MAAM,aAAa,EAAE,SAcpB,CAAC;AAEF,OAAO,EAAE,aAAa,EAAE,CAAC"}
@@ -2,9 +2,22 @@
2
2
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
3
3
  */
4
4
  import { JSX, ParentComponent } from "solid-js";
5
- export declare const SolidShadowRoot: ParentComponent<{
6
- /** Disables shadow root, mostly useful for debugging */
5
+ /**
6
+ * The SolidShadowRoot props.
7
+ */
8
+ type SolidShadowRootProps = {
9
+ /**
10
+ * Disables shadow root, mostly useful for debugging.
11
+ */
7
12
  disableShadowRoot?: boolean;
13
+ /**
14
+ * A ref to the div element.
15
+ */
8
16
  getRef?: (el: HTMLDivElement) => void;
9
- } & JSX.HTMLAttributes<HTMLDivElement>>;
17
+ } & JSX.HTMLAttributes<HTMLDivElement>;
18
+ /**
19
+ * The SolidShadowRoot component.
20
+ */
21
+ export declare const SolidShadowRoot: ParentComponent<SolidShadowRootProps>;
22
+ export {};
10
23
  //# sourceMappingURL=SolidShadowRoot.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SolidShadowRoot.d.ts","sourceRoot":"","sources":["../../src/ui/SolidShadowRoot.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAY,GAAG,EAAE,eAAe,EAAoB,MAAM,UAAU,CAAC;AAE5E,eAAO,MAAM,eAAe,EAAE,eAAe,CAC3C;IACE,wDAAwD;IACxD,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,cAAc,KAAK,IAAI,CAAC;CACvC,GAAG,GAAG,CAAC,cAAc,CAAC,cAAc,CAAC,CA2BvC,CAAC"}
1
+ {"version":3,"file":"SolidShadowRoot.d.ts","sourceRoot":"","sources":["../../src/ui/SolidShadowRoot.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAY,GAAG,EAAE,eAAe,EAAoB,MAAM,UAAU,CAAC;AAE5E;;GAEG;AACH,KAAK,oBAAoB,GAAG;IAC1B;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,cAAc,KAAK,IAAI,CAAC;CACvC,GAAG,GAAG,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;AAEvC;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,eAAe,CAAC,oBAAoB,CA4BjE,CAAC"}
@@ -4,16 +4,24 @@
4
4
  import { SetStoreFunction } from "solid-js/store";
5
5
  import { CameraManager } from "../core/CameraManager";
6
6
  import { CameraUiLocalizationStrings } from "./LocalizationContext";
7
+ /**
8
+ * The default mount point ID.
9
+ */
7
10
  export declare const MOUNT_POINT_ID = "camera-manager-mount-point";
8
11
  import { Owner } from "solid-js";
9
12
  import "virtual:uno.css";
13
+ /**
14
+ * The camera manager component.
15
+ */
10
16
  export type CameraManagerComponent = {
17
+ /** The camera manager. */
11
18
  cameraManager: CameraManager;
12
19
  /** Updates the localization strings */
13
20
  updateLocalization: SetStoreFunction<CameraUiLocalizationStrings>;
14
21
  /** Dismounts the component from the DOM and unloads the SDK */
15
22
  dismount: () => void;
16
- /** Sets a callback to be called when the component is unmounted.
23
+ /**
24
+ * Sets a callback to be called when the component is unmounted.
17
25
  * Returns a cleanup function that removes the callback when called.
18
26
  */
19
27
  addOnDismountCallback: (fn: DismountCallback) => () => void;
@@ -26,12 +34,23 @@ export type CameraManagerComponent = {
26
34
  */
27
35
  overlayLayerNode: HTMLDivElement;
28
36
  /**
29
- * https://docs.solidjs.com/reference/reactive-utilities/get-owner
37
+ * The owner of the component.
38
+ *
39
+ * @see https://docs.solidjs.com/reference/reactive-utilities/get-owner
30
40
  */
31
41
  owner: Owner;
32
42
  };
43
+ /**
44
+ * A dismount callback.
45
+ */
33
46
  export type DismountCallback = () => void;
47
+ /**
48
+ * The camera manager UI options.
49
+ */
34
50
  export type CameraManagerUiOptions = {
51
+ /**
52
+ * The localization strings.
53
+ */
35
54
  localizationStrings?: Partial<CameraUiLocalizationStrings>;
36
55
  /**
37
56
  * If set to `true`, the mirror camera button will be shown.
@@ -51,9 +70,20 @@ export type CameraManagerUiOptions = {
51
70
  * @defaultValue true
52
71
  */
53
72
  showCloseButton?: boolean;
73
+ /**
74
+ * If set to `true`, the camera error modal will be shown.
75
+ *
76
+ * @defaultValue true
77
+ */
78
+ showCameraErrorModal?: boolean;
54
79
  };
55
80
  /**
56
81
  * Creates a new Camera Manager UI component.
82
+ *
83
+ * @param cameraManager - The camera manager.
84
+ * @param target - The target element to mount the component to.
85
+ * @param options - The options for the camera manager UI.
86
+ * @returns The camera manager UI component.
57
87
  */
58
- export declare function createCameraManagerUi(cameraManager: CameraManager, target?: HTMLElement, { localizationStrings, showMirrorCameraButton, showTorchButton, showCloseButton, }?: CameraManagerUiOptions): Promise<CameraManagerComponent>;
88
+ export declare function createCameraManagerUi(cameraManager: CameraManager, target?: HTMLElement, { localizationStrings, showMirrorCameraButton, showTorchButton, showCloseButton, showCameraErrorModal, }?: CameraManagerUiOptions): Promise<CameraManagerComponent>;
59
89
  //# sourceMappingURL=createCameraManagerUi.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"createCameraManagerUi.d.ts","sourceRoot":"","sources":["../../src/ui/createCameraManagerUi.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAEtD,OAAO,EACL,2BAA2B,EAE5B,MAAM,uBAAuB,CAAC;AAI/B,eAAO,MAAM,cAAc,+BAA+B,CAAC;AAG3D,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,iBAAiB,CAAC;AAEzB,MAAM,MAAM,sBAAsB,GAAG;IACnC,aAAa,EAAE,aAAa,CAAC;IAC7B,uCAAuC;IACvC,kBAAkB,EAAE,gBAAgB,CAAC,2BAA2B,CAAC,CAAC;IAClE,+DAA+D;IAC/D,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB;;OAEG;IACH,qBAAqB,EAAE,CAAC,EAAE,EAAE,gBAAgB,KAAK,MAAM,IAAI,CAAC;IAC5D;;OAEG;IACH,iBAAiB,EAAE,cAAc,CAAC;IAClC;;OAEG;IACH,gBAAgB,EAAE,cAAc,CAAC;IAEjC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC;AAE1C,MAAM,MAAM,sBAAsB,GAAG;IACnC,mBAAmB,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAC3D;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,aAAa,EAAE,aAAa,EAC5B,MAAM,CAAC,EAAE,WAAW,EACpB,EACE,mBAAmB,EACnB,sBAA8B,EAC9B,eAAsB,EACtB,eAAsB,GACvB,GAAE,sBAA2B,mCAsM/B"}
1
+ {"version":3,"file":"createCameraManagerUi.d.ts","sourceRoot":"","sources":["../../src/ui/createCameraManagerUi.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAEtD,OAAO,EACL,2BAA2B,EAE5B,MAAM,uBAAuB,CAAC;AAI/B;;GAEG;AACH,eAAO,MAAM,cAAc,+BAA+B,CAAC;AAG3D,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,iBAAiB,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,0BAA0B;IAC1B,aAAa,EAAE,aAAa,CAAC;IAC7B,uCAAuC;IACvC,kBAAkB,EAAE,gBAAgB,CAAC,2BAA2B,CAAC,CAAC;IAClE,+DAA+D;IAC/D,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB;;;OAGG;IACH,qBAAqB,EAAE,CAAC,EAAE,EAAE,gBAAgB,KAAK,MAAM,IAAI,CAAC;IAC5D;;OAEG;IACH,iBAAiB,EAAE,cAAc,CAAC;IAClC;;OAEG;IACH,gBAAgB,EAAE,cAAc,CAAC;IAEjC;;;;OAIG;IACH,KAAK,EAAE,KAAK,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAC3D;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,aAAa,EAAE,aAAa,EAC5B,MAAM,CAAC,EAAE,WAAW,EACpB,EACE,mBAAmB,EACnB,sBAA8B,EAC9B,eAAsB,EACtB,eAAsB,EACtB,oBAA2B,GAC5B,GAAE,sBAA2B,GAC7B,OAAO,CAAC,sBAAsB,CAAC,CA+MjC"}
@@ -3,7 +3,8 @@
3
3
  */
4
4
  import { FitMode } from "./CaptureScreen";
5
5
  /**
6
- * Determine the fit mode for the video element based on the container and video dimensions.
6
+ * Determines the fit mode for the video element based on the container and video dimensions.
7
+ *
7
8
  * `cover` is only used when the cropped fraction is less than 10%.
8
9
  *
9
10
  * When using object-fit: cover, the video is scaled by
@@ -25,11 +26,11 @@ import { FitMode } from "./CaptureScreen";
25
26
  * The croppedFraction represents the relative amount (fraction) of the video that is cropped
26
27
  * along the overflowing dimension. We choose "cover" only when the croppedFraction is below 10%.
27
28
  *
28
- * @param Cw container width
29
- * @param Ch container height
30
- * @param Vw video width
31
- * @param Vh video height
32
- * @returns `FitMode` ("cover" or "contain")
29
+ * @param Cw - The container width.
30
+ * @param Ch - The container height.
31
+ * @param Vw - The video width.
32
+ * @param Vh - The video height.
33
+ * @returns The fit mode.
33
34
  */
34
35
  export declare const determineFitMode: (Cw: number, Ch: number, Vw: number, Vh: number) => FitMode;
35
36
  //# sourceMappingURL=determineFitMode.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"determineFitMode.d.ts","sourceRoot":"","sources":["../../src/ui/determineFitMode.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,gBAAgB,GAC3B,IAAI,MAAM,EACV,IAAI,MAAM,EACV,IAAI,MAAM,EACV,IAAI,MAAM,KACT,OA+BF,CAAC"}
1
+ {"version":3,"file":"determineFitMode.d.ts","sourceRoot":"","sources":["../../src/ui/determineFitMode.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,gBAAgB,GAC3B,IAAI,MAAM,EACV,IAAI,MAAM,EACV,IAAI,MAAM,EACV,IAAI,MAAM,KACT,OA+BF,CAAC"}
@@ -3,8 +3,14 @@
3
3
  */
4
4
  import { ExtractionArea } from "../core/VideoFrameProcessor";
5
5
  /**
6
- * Compute the visible portion of the video (in the videos natural coordinate space)
6
+ * Computes the visible portion of the video (in the video's natural coordinate space)
7
7
  * when rendered with object-fit: cover.
8
+ *
9
+ * @param containerWidth - The width of the container.
10
+ * @param containerHeight - The height of the container.
11
+ * @param videoWidth - The width of the video.
12
+ * @param videoHeight - The height of the video.
13
+ * @returns The visible portion of the video.
8
14
  */
9
15
  export declare function getVisibleVideoArea(containerWidth: number, containerHeight: number, videoWidth: number, videoHeight: number): ExtractionArea;
10
16
  //# sourceMappingURL=getVisibleVideoArea.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"getVisibleVideoArea.d.ts","sourceRoot":"","sources":["../../src/ui/getVisibleVideoArea.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAE7D;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,cAAc,EAAE,MAAM,EACtB,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,MAAM,GAClB,cAAc,CA0BhB"}
1
+ {"version":3,"file":"getVisibleVideoArea.d.ts","sourceRoot":"","sources":["../../src/ui/getVisibleVideoArea.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAE7D;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CACjC,cAAc,EAAE,MAAM,EACtB,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,MAAM,GAClB,cAAc,CA0BhB"}
@@ -1,6 +1,9 @@
1
1
  /**
2
2
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
3
3
  */
4
+ /**
5
+ * The default English localization strings.
6
+ */
4
7
  declare const _default: {
5
8
  readonly selected_camera: "Selected camera";
6
9
  readonly loading_cameras: "Loading cameras...";
@@ -1 +1 @@
1
- {"version":3,"file":"en.d.ts","sourceRoot":"","sources":["../../../src/ui/locales/en.ts"],"names":[],"mappings":"AAAA;;GAEG;;;;;;;;;;;;;;;AAEH,wBAcW"}
1
+ {"version":3,"file":"en.d.ts","sourceRoot":"","sources":["../../../src/ui/locales/en.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;;;;;;;;;;;;;;;AACH,wBAcW"}
@@ -2,11 +2,20 @@
2
2
  * Copyright (c) 2025 Microblink Ltd. All rights reserved.
3
3
  */
4
4
  import { Owner } from "solid-js";
5
+ /**
6
+ * The camera UI refs.
7
+ */
5
8
  export type CameraUiRefs = {
9
+ /** The feedback layer. */
6
10
  feedbackLayer: HTMLDivElement;
11
+ /** The overlay layer. */
7
12
  overlayLayer: HTMLDivElement;
13
+ /** The owner of the component. */
8
14
  owner: Owner;
9
15
  };
16
+ /**
17
+ * The camera UI ref store.
18
+ */
10
19
  export declare const cameraUiRefStore: Omit<import("zustand/vanilla").StoreApi<CameraUiRefs>, "subscribe"> & {
11
20
  subscribe: {
12
21
  (listener: (selectedState: CameraUiRefs, previousSelectedState: CameraUiRefs) => void): () => void;
@@ -16,6 +25,9 @@ export declare const cameraUiRefStore: Omit<import("zustand/vanilla").StoreApi<C
16
25
  } | undefined): () => void;
17
26
  };
18
27
  };
28
+ /**
29
+ * The camera UI ref signal store.
30
+ */
19
31
  export declare const cameraUiRefSignalStore: {
20
32
  (): import("solid-js").Accessor<CameraUiRefs>;
21
33
  <U>(selector: (state: CameraUiRefs) => U, equals?: ((a: U, b: U) => boolean) | undefined): U extends (U extends (...args: any[]) => any ? U : never) ? U : import("solid-js").Accessor<U>;
@@ -1 +1 @@
1
- {"version":3,"file":"zustandRefStore.d.ts","sourceRoot":"","sources":["../../src/ui/zustandRefStore.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAKjC,MAAM,MAAM,YAAY,GAAG;IACzB,aAAa,EAAE,cAAc,CAAC;IAC9B,YAAY,EAAE,cAAc,CAAC;IAC7B,KAAK,EAAE,KAAK,CAAC;CACd,CAAC;AAUF,eAAO,MAAM,gBAAgB;;;;;;;;CAG5B,CAAC;AAEF,eAAO,MAAM,sBAAsB;;;;;;;;;;;CAAqC,CAAC"}
1
+ {"version":3,"file":"zustandRefStore.d.ts","sourceRoot":"","sources":["../../src/ui/zustandRefStore.tsx"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAKjC;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,0BAA0B;IAC1B,aAAa,EAAE,cAAc,CAAC;IAC9B,yBAAyB;IACzB,YAAY,EAAE,cAAc,CAAC;IAC7B,kCAAkC;IAClC,KAAK,EAAE,KAAK,CAAC;CACd,CAAC;AAWF;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;CAG5B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;CAAqC,CAAC"}