@ikonai/sdk 1.0.66 → 1.0.68
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/client/ikon-client.d.ts +28 -7
- package/index.js +6502 -6435
- package/media/device-detection.d.ts +11 -0
- package/media/ikon-image-capture.d.ts +1 -7
- package/media/index.d.ts +2 -1
- package/package.json +1 -1
- package/utils/query-params.d.ts +7 -0
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Best-effort detection of a mobile browser. Used to decide whether the
|
|
3
|
+
* `<input type="file" capture>` flow will actually trigger the OS camera UI
|
|
4
|
+
* (mobile) or fall through to a regular file picker (desktop). Callers that
|
|
5
|
+
* support a headless fallback should prefer it on desktop.
|
|
6
|
+
*
|
|
7
|
+
* Kept in its own dependency-free module so the eagerly-loaded capture function
|
|
8
|
+
* registrations can use it without statically pulling in the heavy image-capture
|
|
9
|
+
* pipeline (which is part of the lazily-loaded capture chunk).
|
|
10
|
+
*/
|
|
11
|
+
export declare function isMobileBrowserLikely(): boolean;
|
|
@@ -7,13 +7,7 @@ export interface IkonImageCaptureRequest {
|
|
|
7
7
|
height?: number;
|
|
8
8
|
}
|
|
9
9
|
export type IkonNativeCameraFacing = 'user' | 'environment';
|
|
10
|
-
|
|
11
|
-
* Best-effort detection of a mobile browser. Used to decide whether the
|
|
12
|
-
* `<input type="file" capture>` flow will actually trigger the OS camera UI
|
|
13
|
-
* (mobile) or fall through to a regular file picker (desktop). Callers that
|
|
14
|
-
* support a headless fallback should prefer it on desktop.
|
|
15
|
-
*/
|
|
16
|
-
export declare function isMobileBrowserLikely(): boolean;
|
|
10
|
+
export { isMobileBrowserLikely } from './device-detection';
|
|
17
11
|
export interface IkonNativeCameraCaptureRequest {
|
|
18
12
|
facing?: IkonNativeCameraFacing;
|
|
19
13
|
mime?: 'image/jpeg' | 'image/png';
|
package/media/index.d.ts
CHANGED
|
@@ -11,5 +11,6 @@ export { IkonVideoCapture } from './ikon-video-capture';
|
|
|
11
11
|
export type { IkonVideoCaptureHandle, IkonVideoCaptureRequest, IkonVideoCaptureOptions, VideoCaptureSource } from './ikon-video-capture';
|
|
12
12
|
export { IkonAudioCapture } from './ikon-audio-capture';
|
|
13
13
|
export type { IkonAudioCaptureHandle, IkonAudioCaptureRequest, IkonAudioCaptureConfig, IkonAudioCaptureOptions } from './ikon-audio-capture';
|
|
14
|
-
export { IkonImageCapture
|
|
14
|
+
export { IkonImageCapture } from './ikon-image-capture';
|
|
15
15
|
export type { IkonImageCaptureRequest, IkonImageCaptureResult, IkonNativeCameraCaptureRequest, IkonNativeCameraFacing } from './ikon-image-capture';
|
|
16
|
+
export { isMobileBrowserLikely } from './device-detection';
|
package/package.json
CHANGED
package/utils/query-params.d.ts
CHANGED
|
@@ -20,6 +20,7 @@
|
|
|
20
20
|
* - ikon-inspect Enable element inspection overlay (true)
|
|
21
21
|
* - ikon-retry Enable retry loops in auth/channel connect (default true; set false to fail fast)
|
|
22
22
|
* - ikon-api Route backend API calls through same-origin /ikon/api (default true on deployed apps; false to force direct calls to api.{env}.ikon.live; always off in local dev)
|
|
23
|
+
* - ikon-snapshot Connect as a build-time snapshot client (true). Sets Context.IsSnapshot so app/Parallax code can branch on snapshot-mode rendering. Dev affordance for tuning the boot-snapshot UI.
|
|
23
24
|
*/
|
|
24
25
|
export declare const IKON_PARAM_PROXY = "ikon-proxy";
|
|
25
26
|
export declare const IKON_PARAM_WEBSOCKET = "ikon-websocket";
|
|
@@ -37,6 +38,7 @@ export declare const IKON_PARAM_DEBUG_OVERLAY = "ikon-debug-overlay";
|
|
|
37
38
|
export declare const IKON_PARAM_AUTH = "ikon-auth";
|
|
38
39
|
export declare const IKON_PARAM_RETRY = "ikon-retry";
|
|
39
40
|
export declare const IKON_PARAM_API = "ikon-api";
|
|
41
|
+
export declare const IKON_PARAM_SNAPSHOT = "ikon-snapshot";
|
|
40
42
|
/**
|
|
41
43
|
* Set an SDK query parameter in the URL via history.replaceState.
|
|
42
44
|
*/
|
|
@@ -67,3 +69,8 @@ export declare function getDebugOverlayParam(): boolean;
|
|
|
67
69
|
export declare function getAuthSameOriginParam(): boolean;
|
|
68
70
|
export declare function getRetryParam(): boolean;
|
|
69
71
|
export declare function getApiParam(): boolean | null;
|
|
72
|
+
/**
|
|
73
|
+
* Connect as a build-time snapshot client (`?ikon-snapshot=true`). Sets `Context.IsSnapshot` so
|
|
74
|
+
* the app / Parallax can render in snapshot mode. A dev affordance for tuning the boot-snapshot UI.
|
|
75
|
+
*/
|
|
76
|
+
export declare function getSnapshotParam(): boolean;
|