@snap/camera-kit 0.11.0 → 0.13.0

package/docs/md/interfaces/LensSource.md

@@ -1,4 +1,4 @@
-[CameraKit Web SDK - v0.11.0-alpha.1](../README.md) / [Exports](../modules.md) / LensSource
+[CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / LensSource
 
 # Interface: LensSource
 
@@ -34,7 +34,7 @@ ___
 
 ### getLens
 
-▸ **getLens**(`lensId`, `groupId`): `Promise`<`ArrayBuffer`\>
+▸ `Optional` **getLens**(`lensId`, `groupId`): `Promise`<`ArrayBuffer`\>
 
 Returns an encoded lens object.
 
@@ -53,7 +53,7 @@ ___
 
 ### getLensGroup
 
-▸ **getLensGroup**(`groupId`): `Promise`<`ArrayBuffer`[]\>
+▸ `Optional` **getLensGroup**(`groupId`): `Promise`<`ArrayBuffer`[]\>
 
 Returns encoded lens objects.
 

package/docs/md/interfaces/MediaStreamSourceOptions.md

@@ -1,4 +1,4 @@
-[CameraKit Web SDK - v0.11.0-alpha.1](../README.md) / [Exports](../modules.md) / MediaStreamSourceOptions
+[CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / MediaStreamSourceOptions
 
 # Interface: MediaStreamSourceOptions
 

package/docs/md/interfaces/Preview.md

@@ -1,4 +1,4 @@
-[CameraKit Web SDK - v0.11.0-alpha.1](../README.md) / [Exports](../modules.md) / Preview
+[CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / Preview
 
 # Interface: Preview
 

package/docs/md/interfaces/RemoteApiRequest.md

@@ -0,0 +1,46 @@
+[CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / RemoteApiRequest
+
+# Interface: RemoteApiRequest
+
+Remote API request sent by a lens.
+
+## Table of contents
+
+### Properties
+
+- [apiSpecId](RemoteApiRequest.md#apispecid)
+- [endpointId](RemoteApiRequest.md#endpointid)
+- [parameters](RemoteApiRequest.md#parameters)
+- [body](RemoteApiRequest.md#body)
+
+## Properties
+
+### apiSpecId
+
+• **apiSpecId**: `string`
+
+Unique id of the remote API service specification.
+
+___
+
+### endpointId
+
+• **endpointId**: `string`
+
+Unique id of the remote API service endpoint requested by this request.
+
+___
+
+### parameters
+
+• **parameters**: `Record`<`string`, `string`\>
+
+A map of named parameters associated with the request.
+
+___
+
+### body
+
+• **body**: `ArrayBuffer`
+
+Additional binary request payload.

package/docs/md/interfaces/RemoteApiResponse.md

@@ -0,0 +1,37 @@
+[CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / RemoteApiResponse
+
+# Interface: RemoteApiResponse
+
+Remote API response to a request sent by a lens.
+
+## Table of contents
+
+### Properties
+
+- [status](RemoteApiResponse.md#status)
+- [metadata](RemoteApiResponse.md#metadata)
+- [body](RemoteApiResponse.md#body)
+
+## Properties
+
+### status
+
+• **status**: ``"timeout"`` \| ``"success"`` \| ``"redirected"`` \| ``"cancelled"`` \| ``"notFound"`` \| ``"badRequest"`` \| ``"accessDenied"`` \| ``"requestTooLarge"`` \| ``"serverError"`` \| ``"proxyError"``
+
+Status of the response
+
+___
+
+### metadata
+
+• **metadata**: `Record`<`string`, `string`\>
+
+A map of named metadata associated with the response.
+
+___
+
+### body
+
+• **body**: `ArrayBuffer`
+
+Additional binary request payload.

package/docs/md/interfaces/RemoteApiService.md

@@ -0,0 +1,45 @@
+[CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / RemoteApiService
+
+# Interface: RemoteApiService
+
+Service to handle a lens Remote API request.
+
+## Table of contents
+
+### Properties
+
+- [apiSpecId](RemoteApiService.md#apispecid)
+
+### Methods
+
+- [getRequestHandler](RemoteApiService.md#getrequesthandler)
+
+## Properties
+
+### apiSpecId
+
+• **apiSpecId**: `string`
+
+Remote API spec ID(s).
+
+## Methods
+
+### getRequestHandler
+
+▸ **getRequestHandler**(`request`, `lens`): `undefined` \| [`RemoteApiRequestHandler`](../modules.md#remoteapirequesthandler)
+
+This method is called by Camera Kit when a lens triggers a Remote API request with a corresponding spec ID.
+If the service can handle the request, the method returns a request handler; otherwise, it returns nothing.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `request` | [`RemoteApiRequest`](RemoteApiRequest.md) | Remote API request object. |
+| `lens` | [`Lens`](Lens.md) | Lens that trigges the request. |
+
+#### Returns
+
+`undefined` \| [`RemoteApiRequestHandler`](../modules.md#remoteapirequesthandler)
+
+A request handler if applicable.

package/docs/md/interfaces/Snapcode.md

@@ -1,4 +1,4 @@
-[CameraKit Web SDK - v0.11.0-alpha.1](../README.md) / [Exports](../modules.md) / Snapcode
+[CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / Snapcode
 
 # Interface: Snapcode
 

package/docs/md/interfaces/UriCancelRequest.md

@@ -1,4 +1,4 @@
-[CameraKit Web SDK - v0.11.0-alpha.1](../README.md) / [Exports](../modules.md) / UriCancelRequest
+[CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / UriCancelRequest
 
 # Interface: UriCancelRequest
 

package/docs/md/interfaces/UriRequest.md

@@ -1,4 +1,4 @@
-[CameraKit Web SDK - v0.11.0-alpha.1](../README.md) / [Exports](../modules.md) / UriRequest
+[CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / UriRequest
 
 # Interface: UriRequest
 
@@ -11,6 +11,7 @@
 - [method](UriRequest.md#method)
 - [contentType](UriRequest.md#contenttype)
 - [data](UriRequest.md#data)
+- [metadata](UriRequest.md#metadata)
 
 ## Properties
 
@@ -28,7 +29,7 @@ ___
 
 ### method
 
-• **method**: ``"GET"`` \| ``"POST"``
+• **method**: ``"POST"`` \| ``"GET"``
 
 ___
 
@@ -41,3 +42,9 @@ ___
 ### data
 
 • **data**: `ArrayBuffer`
+
+___
+
+### metadata
+
+• **metadata**: `Record`<`string`, `string`\>

package/docs/md/interfaces/UriResponse.md

@@ -1,4 +1,4 @@
-[CameraKit Web SDK - v0.11.0-alpha.1](../README.md) / [Exports](../modules.md) / UriResponse
+[CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / UriResponse
 
 # Interface: UriResponse
 

package/docs/md/interfaces/VideoSourceOptions.md

@@ -1,4 +1,4 @@
-[CameraKit Web SDK - v0.11.0-alpha.1](../README.md) / [Exports](../modules.md) / VideoSourceOptions
+[CameraKit Web SDK - v0.13.0-alpha.1](../README.md) / [Exports](../modules.md) / VideoSourceOptions
 
 # Interface: VideoSourceOptions
 

package/docs/md/modules.md

@@ -1,6 +1,6 @@
-[CameraKit Web SDK - v0.11.0-alpha.1](README.md) / Exports
+[CameraKit Web SDK - v0.13.0-alpha.1](README.md) / Exports
 
-# CameraKit Web SDK - v0.11.0-alpha.1
+# CameraKit Web SDK - v0.13.0-alpha.1
 
 ## Table of contents
 
@@ -23,7 +23,9 @@
 - [EstimatedLensPerformance](interfaces/EstimatedLensPerformance.md)
 - [CameraKitBootstrapConfiguration](interfaces/CameraKitBootstrapConfiguration.md)
 - [LensSource](interfaces/LensSource.md)
-- [UriHandler](interfaces/UriHandler.md)
+- [RemoteApiRequest](interfaces/RemoteApiRequest.md)
+- [RemoteApiResponse](interfaces/RemoteApiResponse.md)
+- [RemoteApiService](interfaces/RemoteApiService.md)
 - [UriRequest](interfaces/UriRequest.md)
 - [UriResponse](interfaces/UriResponse.md)
 - [UriCancelRequest](interfaces/UriCancelRequest.md)
@@ -40,12 +42,15 @@
 - [LensMetricsEvents](modules.md#lensmetricsevents)
 - [LensPerformanceCluster](modules.md#lensperformancecluster)
 - [PublicContainer](modules.md#publiccontainer)
-- [UriHandlers](modules.md#urihandlers)
+- [RemoteApiStatus](modules.md#remoteapistatus)
+- [RemoteApiRequestHandler](modules.md#remoteapirequesthandler)
+- [RemoteApiServices](modules.md#remoteapiservices)
 - [Uri](modules.md#uri)
 - [LensLaunchParams](modules.md#lenslaunchparams)
 - [AssetTiming](modules.md#assettiming)
 - [AssetLoader](modules.md#assetloader)
 - [CameraKitDeviceInfo](modules.md#camerakitdeviceinfo)
+- [CameraKitDeviceOptions](modules.md#camerakitdeviceoptions)
 - [CameraKitSourceInfo](modules.md#camerakitsourceinfo)
 - [CameraKitSourceOptions](modules.md#camerakitsourceoptions)
 - [LensView](modules.md#lensview)
@@ -81,7 +86,7 @@
 - [createExtension](modules.md#createextension)
 - [Injectable](modules.md#injectable)
 - [lensSourcesFactory](modules.md#lenssourcesfactory)
-- [uriHandlersFactory](modules.md#urihandlersfactory)
+- [remoteApiServicesFactory](modules.md#remoteapiservicesfactory)
 - [getRequiredBootstrapURLs](modules.md#getrequiredbootstrapurls)
 - [createImageSource](modules.md#createimagesource)
 - [createUserMediaSource](modules.md#createusermediasource)
@@ -460,11 +465,42 @@ should decrease – we measure between the request to apply a lens and when the
 
 ## Other
 
-### UriHandlers
+### RemoteApiStatus
 
-Ƭ **UriHandlers**: [`UriHandler`](interfaces/UriHandler.md)[]
+Ƭ **RemoteApiStatus**: keyof typeof `statusToResponseCodeMap`
 
-Array of [UriHandler](interfaces/UriHandler.md) objects.
+Status of a Remote API response.
+
+___
+
+### RemoteApiRequestHandler
+
+Ƭ **RemoteApiRequestHandler**: (`reply`: (`response`: [`RemoteApiResponse`](interfaces/RemoteApiResponse.md)) => `void`) => `RemoteApiCancelRequestHandler` \| `void`
+
+#### Type declaration
+
+▸ (`reply`): `RemoteApiCancelRequestHandler` \| `void`
+
+Represents a Remote API request handler function.
+It is provided with a reply callback that must be invoked to send a response back to the lens.
+The reply callback can be invoked multiple times if needed.
+Additionally, the handler can return a cancellation callback, which is triggered when the lens cancels the request.
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `reply` | (`response`: [`RemoteApiResponse`](interfaces/RemoteApiResponse.md)) => `void` |
+
+##### Returns
+
+`RemoteApiCancelRequestHandler` \| `void`
+
+___
+
+### RemoteApiServices
+
+Ƭ **RemoteApiServices**: [`RemoteApiService`](interfaces/RemoteApiService.md)[]
 
 ___
 
@@ -679,11 +715,9 @@ ___
 
 ___
 
-### uriHandlersFactory
-
-▸ **uriHandlersFactory**(`...args`): [`UriHandlers`](modules.md#urihandlers)
+### remoteApiServicesFactory
 
-An extension point for client URI handlers.
+▸ **remoteApiServicesFactory**(`...args`): [`RemoteApiServices`](modules.md#remoteapiservices)
 
 #### Parameters
 
@@ -693,7 +727,7 @@ An extension point for client URI handlers.
 
 #### Returns
 
-[`UriHandlers`](modules.md#urihandlers)
+[`RemoteApiServices`](modules.md#remoteapiservices)
 
 ## Rendering
 
@@ -701,18 +735,35 @@ An extension point for client URI handlers.
 
 Ƭ **CameraKitDeviceInfo**: `Object`
 
+**`Deprecated`**
+
+use [CameraKitDeviceOptions](modules.md#camerakitdeviceoptions)
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `cameraType` | ``"front"`` \| ``"back"`` | **`Deprecated`** "front" and "back" are deprecated please use "user" or "enviroment" for cameraType instead |
+| `fpsLimit` | `number` | - |
+
+___
+
+### CameraKitDeviceOptions
+
+Ƭ **CameraKitDeviceOptions**: `Object`
+
 #### Type declaration
 
 | Name | Type |
 | :------ | :------ |
-| `cameraType` | ``"front"`` \| ``"back"`` |
+| `cameraType` | ``"user"`` \| ``"environment"`` |
 | `fpsLimit` | `number` |
 
 ___
 
 ### CameraKitSourceOptions
 
-Ƭ **CameraKitSourceOptions**<`T`\>: `Partial`<`T`\> & `Partial`<[`CameraKitDeviceInfo`](modules.md#camerakitdeviceinfo)\>
+Ƭ **CameraKitSourceOptions**<`T`\>: `Partial`<`T`\> & `Partial`<[`CameraKitDeviceInfo`](modules.md#camerakitdeviceinfo) \| [`CameraKitDeviceOptions`](modules.md#camerakitdeviceoptions)\>
 
 #### Type parameters
 

package/lib/CameraKit.d.ts

@@ -130,13 +130,23 @@ export declare const cameraKitFactory: {
         token: "cameraKitServiceFetchHandler";
         dependencies: readonly ["configuration", "defaultFetchHandler"];
     }, {
-        (args_0: import("./configuration").CameraKitConfiguration, args_1: import("./handlers/requestStateEmittingHandler").RequestStateEventTarget, args_2: import("./metrics/operational/operationalMetricsReporter").OperationalMetricsReporter, args_3: import("./handlers").FetchHandler): import("./remote-configuration/remoteConfiguration").RemoteConfiguration;
+        (args_0: import("./configuration").CameraKitConfiguration, args_1: import("./handlers/requestStateEmittingHandler").RequestStateEventTarget, args_2: import("./metrics/operational/operationalMetricsReporter").OperationalMetricsReporter): import("./handlers/HandlerChainBuilder").Handler<Partial<import("./generated-proto/pb_schema/cdp/cof/config_request").ConfigTargetingRequest>, import("./generated-proto/pb_schema/cdp/cof/config_response").ConfigTargetingResponse, import("./remote-configuration/cofHandler").Metadata & {
+            signal?: AbortSignal | null | undefined;
+            isSideEffect?: boolean | undefined;
+        }>;
+        token: "cofHandler";
+        dependencies: readonly ["configuration", "requestStateEventTarget", "operationalMetricsReporter"];
+    }, {
+        (args_0: import("./configuration").CameraKitConfiguration, args_1: import("./handlers/HandlerChainBuilder").Handler<Partial<import("./generated-proto/pb_schema/cdp/cof/config_request").ConfigTargetingRequest>, import("./generated-proto/pb_schema/cdp/cof/config_response").ConfigTargetingResponse, import("./remote-configuration/cofHandler").Metadata & {
+            signal?: AbortSignal | null | undefined;
+            isSideEffect?: boolean | undefined;
+        }>, args_2: import("./handlers").FetchHandler): import("./remote-configuration/remoteConfiguration").RemoteConfiguration;
         token: "remoteConfiguration";
-        dependencies: readonly ["configuration", "requestStateEventTarget", "operationalMetricsReporter", "cameraKitServiceFetchHandler"];
+        dependencies: readonly ["configuration", "cofHandler", "cameraKitServiceFetchHandler"];
     }, {
-        (args_0: import("./handlers/requestStateEmittingHandler").RequestStateEventTarget, args_1: import("./handlers").FetchHandler, args_2: import("./handlers").FetchHandler, args_3: import("./lens").LensSources, args_4: import("./lens").LensAssetRepository): LensRepository;
+        (args_0: import("./handlers/requestStateEmittingHandler").RequestStateEventTarget, args_1: import("./handlers").FetchHandler, args_2: import("./handlers").FetchHandler, args_3: import("./lens").LensSources, args_4: import("./lens").LensAssetRepository, args_5: import("./configuration").CameraKitConfiguration): LensRepository;
         token: "LensRepository";
-        dependencies: readonly ["requestStateEventTarget", "cameraKitServiceFetchHandler", "defaultFetchHandler", "lensSources", "lensAssetRepository"];
+        dependencies: readonly ["requestStateEventTarget", "cameraKitServiceFetchHandler", "defaultFetchHandler", "lensSources", "lensAssetRepository", "configuration"];
     }, {
         (args_0: LensCoreModule): import("./persistence/IndexedDBPersistence").IndexedDBPersistence<ArrayBuffer>;
         token: "lensPersistenceStore";
@@ -146,9 +156,9 @@ export declare const cameraKitFactory: {
         token: "metricsHandler";
         dependencies: readonly ["cameraKitServiceFetchHandler", "pageVisibility"];
     }, {
-        (args_0: import("./handlers").FetchHandler, args_1: PageVisibility): import("./metrics/operational/operationalMetricsReporter").OperationalMetricsReporter;
+        (args_0: import("./handlers").FetchHandler, args_1: PageVisibility, args_2: import("./configuration").CameraKitConfiguration): import("./metrics/operational/operationalMetricsReporter").OperationalMetricsReporter;
         token: "operationalMetricsReporter";
-        dependencies: readonly ["metricsHandler", "pageVisibility"];
+        dependencies: readonly ["metricsHandler", "pageVisibility", "configuration"];
     }, {
         (args_0: LensCoreModule, args_1: import("./lens").AssetLoader, args_2: import("./lens").AssetLoader, args_3: import("./lens").AssetLoader, args_4: MetricsEventTarget, args_5: import("./handlers/requestStateEmittingHandler").RequestStateEventTarget): import("./lens").LensAssetRepository;
         token: "lensAssetRepository";

package/lib/CameraKit.js

@@ -6,7 +6,7 @@ import { cameraKitSessionFactory } from "./session/CameraKitSession";
 import { registerLensAssetsProvider } from "./lens/assets/LensAssetsProvider";
 import { lensCoreFactory } from "./lens-core-module/loader/lensCoreFactory";
 import { configurationToken } from "./configuration";
-import { registerUriHandlers } from "./extensions/UriHandlers";
+import { registerUriHandlers } from "./extensions/uriHandlersRegister";
 import { metricsEventTargetFactory } from "./metrics/metricsEventTarget";
 import { reportSessionScopedMetrics } from "./metrics/reporters/reporters";
 import { lensStateFactory } from "./session/lensState";
@@ -18,6 +18,7 @@ import { getLogger, resetLogger } from "./logger/logger";
 import { errorLoggingDecorator } from "./logger/errorLoggingDecorator";
 import { TypedEventTarget } from "./events/TypedEventTarget";
 import { pageVisibilityFactory } from "./common/pageVisibility";
+import { setPreloadedConfiguration } from "./remote-configuration/preloadConfiguration";
 const logger = getLogger("CameraKit");
 const log = errorLoggingDecorator(logger);
 /**
@@ -127,6 +128,7 @@ export class CameraKit {
                 .provides(cameraKitSessionFactory)
                 .run(registerLensAssetsProvider)
                 .run(registerLensClientInterfaceHandler)
+                .run(setPreloadedConfiguration)
                 // We'll run a PartialContainer containing reporters for session-scoped metrics. Running this container
                 // allows each metric reporter to initialize itself (e.g. by adding event listeners to detect when certain
                 // actions occur).

package/lib/CameraKit.js.map

@@ -1 +1 @@
-{"version":3,"file":"CameraKit.js","sourceRoot":"","sources":["../src/CameraKit.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,qBAAqB,EAAkB,MAAM,uBAAuB,CAAC;AAC9E,OAAO,EAAE,SAAS,EAAa,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAC;AAE/D,OAAO,EAAoB,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AACvF,OAAO,EAAE,0BAA0B,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,EAAE,eAAe,EAAE,MAAM,2CAA2C,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAErD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAsB,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AAC7F,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,kCAAkC,EAAE,MAAM,6CAA6C,CAAC;AACjG,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAI7D,OAAO,EAAkB,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhF,MAAM,MAAM,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC;AACtC,MAAM,GAAG,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;AAE1C;;GAEG;AACH,MAAM,uBAAuB,GAA+C,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;AAsCrG;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,OAAO,SAAS;IAWlB,gBAAgB;IAChB;IACI;;OAEG;IACM,cAA8B,EAEtB,QAAwB,EACxB,cAA8B,EAC9B,SAAkC,EACnD,UAA8B;QALrB,mBAAc,GAAd,cAAc,CAAgB;QAEtB,aAAQ,GAAR,QAAQ,CAAgB;QACxB,mBAAc,GAAd,cAAc,CAAgB;QAC9B,cAAS,GAAT,SAAS,CAAyB;QAhBvD;;WAEG;QACM,YAAO,GAAwC,IAAI,gBAAgB,EAAE,CAAC;QAEvE,aAAQ,GAAuB,EAAE,CAAC;QActC,IAAI,CAAC,MAAM,GAAG,EAAE,UAAU,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC;QAClD,uGAAuG;QACvG,0BAA0B;QAC1B,uBAAuB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAC1C,UAAU,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;QACjF,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IAEG,aAAa,CAAC,EAChB,gBAAgB,EAChB,oBAAoB,MACE,EAAE;;YACxB,4FAA4F;YAC5F,MAAM,gBAAgB,GAAG,CAAC,KAAoB,EAAE,EAAE,CAC9C,MAAM,CAAC,KAAK,CACR,kBAAkB,CACd,wCAAwC;gBACpC,4EAA4E,EAChF,KAAK,CACR,CACJ,CAAC;YAEN;;;;;;;;eAQG;YACH,MAAM,IAAI,OAAO,CAAO,CAAC,SAAS,EAAE,SAAS,EAAE,EAAE;gBAC7C,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;oBACrB,MAAM,EAAE,gBAAgB;oBACxB,eAAe,EAAE,CAAC,oBAAoB,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,eAAe;oBAChG,gBAAgB;oBAChB,SAAS;oBACT,SAAS;iBACZ,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YAEH,MAAM,IAAI,OAAO,CAAO,CAAC,SAAS,EAAE,SAAS,EAAE,EAAE;gBAC7C,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC;oBAC5B,IAAI,EAAE,oBAAoB;wBACtB,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,UAAU;wBACzC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,qBAAqB;oBACxD,SAAS;oBACT,SAAS;iBACZ,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YAEH,2GAA2G;YAC3G,wGAAwG;YACxG,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS;gBACnC,oGAAoG;gBACpG,mCAAmC;iBAClC,IAAI,EAAE;iBAEN,QAAQ,CAAC,mBAAmB,CAAC;iBAC7B,QAAQ,CAAC,gBAAgB,CAAC;iBAC1B,QAAQ,CAAC,mBAAmB,CAAC;iBAC7B,QAAQ,CAAC,uBAAuB,CAAC;iBAEjC,GAAG,CAAC,0BAA0B,CAAC;iBAC/B,GAAG,CAAC,kCAAkC,CAAC;gBAExC,uGAAuG;gBACvG,0GAA0G;gBAC1G,kBAAkB;iBACjB,GAAG,CAAC,0BAA0B,CAAC;gBAEhC,0GAA0G;gBAC1G,oCAAoC;iBACnC,GAAG,CAAC,mBAAmB,CAAC,CAAC;YAE9B,MAAM,OAAO,GAAG,gBAAgB,CAAC,GAAG,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC;YACpE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC5B,OAAO,OAAO,CAAC;QACnB,CAAC;KAAA;IAED;;OAEG;IAEG,OAAO;;YACT,WAAW,EAAE,CAAC;YACd,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;YAC9B,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;YACrE,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACvB,CAAC;KAAA;CACJ;AAlFS;IADL,GAAG;;;;8CAuEH;AAMK;IADL,GAAG;;;;wCAMH;AAGL,gBAAgB;AAChB,MAAM,CAAC,MAAM,gBAAgB,GAAG,UAAU,CACtC,WAAW,EACX;IACI,qBAAqB,CAAC,KAAK;IAC3B,yBAAyB,CAAC,KAAK;IAC/B,eAAe,CAAC,KAAK;IACrB,qBAAqB,CAAC,KAAK;IAC3B,SAAS;CACH,EACV,CACI,cAA8B,EAC9B,OAA2B,EAC3B,QAAwB,EACxB,cAA8B,EAC9B,SAAkC,EACpC,EAAE,CAAC,IAAI,SAAS,CAAC,cAAc,EAAE,QAAQ,EAAE,cAAc,EAAE,SAAS,EAAE,OAAO,CAAC,CACnF,CAAC","sourcesContent":["import { lensRepositoryFactory, LensRepository } from \"./lens/LensRepository\";\nimport { CONTAINER, Container } from \"./dependency-injection/Container\";\nimport { Injectable } from \"./dependency-injection/Injectable\";\nimport { LensCoreError, LensCoreModule } from \"./lens-core-module/generated-types\";\nimport { CameraKitSession, cameraKitSessionFactory } from \"./session/CameraKitSession\";\nimport { registerLensAssetsProvider } from \"./lens/assets/LensAssetsProvider\";\nimport { lensCoreFactory } from \"./lens-core-module/loader/lensCoreFactory\";\nimport { configurationToken } from \"./configuration\";\nimport { RootServices } from \"./dependency-injection/RootServices\";\nimport { registerUriHandlers } from \"./extensions/UriHandlers\";\nimport { MetricsEventTarget, metricsEventTargetFactory } from \"./metrics/metricsEventTarget\";\nimport { reportSessionScopedMetrics } from \"./metrics/reporters/reporters\";\nimport { lensStateFactory } from \"./session/lensState\";\nimport { lensKeyboardFactory } from \"./session/LensKeyboard\";\nimport { registerLensClientInterfaceHandler } from \"./lens-client-interface/lensClientInterface\";\nimport { sessionStateFactory } from \"./session/sessionState\";\nimport { lensExecutionError } from \"./namedErrors\";\nimport { getLogger, resetLogger } from \"./logger/logger\";\nimport { errorLoggingDecorator } from \"./logger/errorLoggingDecorator\";\nimport { TypedEventTarget } from \"./events/TypedEventTarget\";\nimport { TypedCustomEvent } from \"./events/TypedCustomEvent\";\nimport { LensView } from \"./metrics/reporters/reportLensView\";\nimport { LensWait } from \"./metrics/reporters/reportLensWait\";\nimport { PageVisibility, pageVisibilityFactory } from \"./common/pageVisibility\";\n\nconst logger = getLogger(\"CameraKit\");\nconst log = errorLoggingDecorator(logger);\n\n/**\n * Metrics event names that are exposed to apps.\n */\nconst publicMetricsEventNames: Array<LensMetricsEvents[\"detail\"][\"name\"]> = [\"lensView\", \"lensWait\"];\n\n/**\n * Lens metrics events.\n *\n * These events are emitted by {@link CameraKit} to report lens usage, performance, apply latency, etc.\n *\n * @category Lenses\n * @category Metrics\n */\nexport type LensMetricsEvents =\n    | TypedCustomEvent<LensView[\"name\"], LensView>\n    | TypedCustomEvent<LensWait[\"name\"], LensWait>;\n\n/**\n * Options available when creating a {@link CameraKitSession}.\n *\n * @category Rendering\n */\nexport interface CreateSessionOptions {\n    /**\n     * Optionally provide an existing canvas element, on which the Live RenderTarget will be rendered.\n     *\n     * If this is not provided, CameraKit will create a new canvas element which can be added to the DOM.\n     */\n    liveRenderTarget?: HTMLCanvasElement;\n\n    /**\n     * Browsers optimize tabs when they are hidden - for example, by pausing the execution of requestAnimationFrame\n     * callbacks.\n     *\n     * If you need the CameraKitSession to continue rendering even when the tab is in the background, set this to true.\n     * There is a small performance penalty, and it's a good practice to only render in the background if absolutely\n     * necessary.\n     */\n    renderWhileTabHidden?: boolean;\n}\n\n/**\n * The entry point to the CameraKit SDK's API. Most of CameraKit's features are accessed via this class.\n *\n * Applications obtain an instance of CameraKit by calling {@link bootstrapCameraKit}.\n *\n * @example\n * ```ts\n * const cameraKit = await bootstrapCameraKit(config)\n * ```\n *\n * Then this class can be used to:\n * - Create a {@link CameraKitSession} instance, which provides the API for setting up media inputs, applying Lenses,\n * and obtaining rendered `<canvas>` outputs.\n * - Query for lenses using {@link LensRepository}.\n * - Listen for lens usage metrics events using {@link MetricsEventTarget}.\n *\n * @category Rendering\n * @category Lenses\n */\nexport class CameraKit {\n    /** @deprecated Use {@link lensRepository} */\n    readonly lenses: { repository: LensRepository };\n\n    /**\n     * Business metrics (e.g. each time a lens is viewed) are emitted here.\n     */\n    readonly metrics: TypedEventTarget<LensMetricsEvents> = new TypedEventTarget();\n\n    private sessions: CameraKitSession[] = [];\n\n    /** @internal */\n    constructor(\n        /**\n         * Used to query for lenses and lens groups.\n         */\n        readonly lensRepository: LensRepository,\n\n        private readonly lensCore: LensCoreModule,\n        private readonly pageVisibility: PageVisibility,\n        private readonly container: Container<RootServices>,\n        allMetrics: MetricsEventTarget\n    ) {\n        this.lenses = { repository: this.lensRepository };\n        // Proxy only a subset of all metrics events to the public-facing emitter -- applications don't need to\n        // know about most events.\n        publicMetricsEventNames.forEach((eventName) => {\n            allMetrics.addEventListener(eventName, (e) => this.metrics.dispatchEvent(e));\n        });\n    }\n\n    /**\n     * Create a CameraKitSession.\n     *\n     * This initializes the rendering engine and returns a {@link CameraKitSession} instance, which provides access\n     * to Lens rendering.\n     *\n     * @example\n     * ```ts\n     * const cameraKit = await bootstrapCameraKit(config)\n     * const session = await cameraKit.createSession()\n     *\n     * const lens = await cameraKit.lensRepository.loadLens(lensId, groupId)\n     * session.applyLens(lens)\n     * ```\n     *\n     * @param options\n     */\n    @log\n    async createSession({\n        liveRenderTarget,\n        renderWhileTabHidden,\n    }: CreateSessionOptions = {}): Promise<CameraKitSession> {\n        // Any error happened during lens rendering can be processed by subscribing to sessionErrors\n        const exceptionHandler = (error: LensCoreError) =>\n            logger.error(\n                lensExecutionError(\n                    \"Error occurred during lens execution. \" +\n                        \"The lens cannot be rendered and will be removed from the CameraKitSession.\",\n                    error\n                )\n            );\n\n        /**\n         * If/when we add support for multiple concurrent sessions, we'll need to create a copy of the LensCore WASM\n         * module. If we move managing web workers into JS, spawing a new worker thread with its own copy of LensCore\n         * probably becomes a lot more straightforward.\n         *\n         * Currently chromium has a bug preventing rendering while tab is hidden when LensCore is in worker mode.\n         * In order to process tab while it is hidden, the current stopgap is to pass in renderWhileTabHidden as true,\n         * which will initiate session in non worker mode, and set the RenderLoopMode to `SetTimeout`.\n         */\n        await new Promise<void>((onSuccess, onFailure) => {\n            this.lensCore.initialize({\n                canvas: liveRenderTarget,\n                shouldUseWorker: !renderWhileTabHidden && this.container.get(configurationToken).shouldUseWorker,\n                exceptionHandler,\n                onSuccess,\n                onFailure,\n            });\n        });\n\n        await new Promise<void>((onSuccess, onFailure) => {\n            this.lensCore.setRenderLoopMode({\n                mode: renderWhileTabHidden\n                    ? this.lensCore.RenderLoopMode.SetTimeout\n                    : this.lensCore.RenderLoopMode.RequestAnimationFrame,\n                onSuccess,\n                onFailure,\n            });\n        });\n\n        // Each session gets its own DI Container – some Services provided by this Container may be shared with the\n        // root CameraKit Container, but others may be scoped to the session by passing their token to `copy()`.\n        const sessionContainer = this.container\n            // Right now this is a no-op. If/when we add support for multiple concurrent sessions, we may end up\n            // scoping LensCore to the session.\n            .copy()\n\n            .provides(sessionStateFactory)\n            .provides(lensStateFactory)\n            .provides(lensKeyboardFactory)\n            .provides(cameraKitSessionFactory)\n\n            .run(registerLensAssetsProvider)\n            .run(registerLensClientInterfaceHandler)\n\n            // We'll run a PartialContainer containing reporters for session-scoped metrics. Running this container\n            // allows each metric reporter to initialize itself (e.g. by adding event listeners to detect when certain\n            // actions occur).\n            .run(reportSessionScopedMetrics)\n\n            // UriHandlers may have dependencies on session-scoped services (e.g. LensState, LensKeyboard), so they'll\n            // be registered with LensCore here.\n            .run(registerUriHandlers);\n\n        const session = sessionContainer.get(cameraKitSessionFactory.token);\n        this.sessions.push(session);\n        return session;\n    }\n\n    /**\n     * Destroys all sessions and frees all resources.\n     */\n    @log\n    async destroy() {\n        resetLogger();\n        this.pageVisibility.destroy();\n        await Promise.all(this.sessions.map((session) => session.destroy()));\n        this.sessions = [];\n    }\n}\n\n/** @internal */\nexport const cameraKitFactory = Injectable(\n    \"CameraKit\",\n    [\n        lensRepositoryFactory.token,\n        metricsEventTargetFactory.token,\n        lensCoreFactory.token,\n        pageVisibilityFactory.token,\n        CONTAINER,\n    ] as const,\n    (\n        lensRepository: LensRepository,\n        metrics: MetricsEventTarget,\n        lensCore: LensCoreModule,\n        pageVisibility: PageVisibility,\n        container: Container<RootServices>\n    ) => new CameraKit(lensRepository, lensCore, pageVisibility, container, metrics)\n);\n"]}
+{"version":3,"file":"CameraKit.js","sourceRoot":"","sources":["../src/CameraKit.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,qBAAqB,EAAkB,MAAM,uBAAuB,CAAC;AAC9E,OAAO,EAAE,SAAS,EAAa,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAC;AAE/D,OAAO,EAAoB,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AACvF,OAAO,EAAE,0BAA0B,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,EAAE,eAAe,EAAE,MAAM,2CAA2C,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAErD,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAsB,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AAC7F,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,kCAAkC,EAAE,MAAM,6CAA6C,CAAC;AACjG,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAI7D,OAAO,EAAkB,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChF,OAAO,EAAE,yBAAyB,EAAE,MAAM,6CAA6C,CAAC;AAExF,MAAM,MAAM,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC;AACtC,MAAM,GAAG,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;AAE1C;;GAEG;AACH,MAAM,uBAAuB,GAA+C,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;AAsCrG;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,OAAO,SAAS;IAWlB,gBAAgB;IAChB;IACI;;OAEG;IACM,cAA8B,EAEtB,QAAwB,EACxB,cAA8B,EAC9B,SAAkC,EACnD,UAA8B;QALrB,mBAAc,GAAd,cAAc,CAAgB;QAEtB,aAAQ,GAAR,QAAQ,CAAgB;QACxB,mBAAc,GAAd,cAAc,CAAgB;QAC9B,cAAS,GAAT,SAAS,CAAyB;QAhBvD;;WAEG;QACM,YAAO,GAAwC,IAAI,gBAAgB,EAAE,CAAC;QAEvE,aAAQ,GAAuB,EAAE,CAAC;QActC,IAAI,CAAC,MAAM,GAAG,EAAE,UAAU,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC;QAClD,uGAAuG;QACvG,0BAA0B;QAC1B,uBAAuB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAC1C,UAAU,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;QACjF,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IAEG,aAAa,CAAC,EAChB,gBAAgB,EAChB,oBAAoB,MACE,EAAE;;YACxB,4FAA4F;YAC5F,MAAM,gBAAgB,GAAG,CAAC,KAAoB,EAAE,EAAE,CAC9C,MAAM,CAAC,KAAK,CACR,kBAAkB,CACd,wCAAwC;gBACpC,4EAA4E,EAChF,KAAK,CACR,CACJ,CAAC;YAEN;;;;;;;;eAQG;YACH,MAAM,IAAI,OAAO,CAAO,CAAC,SAAS,EAAE,SAAS,EAAE,EAAE;gBAC7C,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;oBACrB,MAAM,EAAE,gBAAgB;oBACxB,eAAe,EAAE,CAAC,oBAAoB,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,eAAe;oBAChG,gBAAgB;oBAChB,SAAS;oBACT,SAAS;iBACZ,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YAEH,MAAM,IAAI,OAAO,CAAO,CAAC,SAAS,EAAE,SAAS,EAAE,EAAE;gBAC7C,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC;oBAC5B,IAAI,EAAE,oBAAoB;wBACtB,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,UAAU;wBACzC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,qBAAqB;oBACxD,SAAS;oBACT,SAAS;iBACZ,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YAEH,2GAA2G;YAC3G,wGAAwG;YACxG,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS;gBACnC,oGAAoG;gBACpG,mCAAmC;iBAClC,IAAI,EAAE;iBAEN,QAAQ,CAAC,mBAAmB,CAAC;iBAC7B,QAAQ,CAAC,gBAAgB,CAAC;iBAC1B,QAAQ,CAAC,mBAAmB,CAAC;iBAC7B,QAAQ,CAAC,uBAAuB,CAAC;iBAEjC,GAAG,CAAC,0BAA0B,CAAC;iBAC/B,GAAG,CAAC,kCAAkC,CAAC;iBACvC,GAAG,CAAC,yBAAyB,CAAC;gBAE/B,uGAAuG;gBACvG,0GAA0G;gBAC1G,kBAAkB;iBACjB,GAAG,CAAC,0BAA0B,CAAC;gBAEhC,0GAA0G;gBAC1G,oCAAoC;iBACnC,GAAG,CAAC,mBAAmB,CAAC,CAAC;YAE9B,MAAM,OAAO,GAAG,gBAAgB,CAAC,GAAG,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC;YACpE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC5B,OAAO,OAAO,CAAC;QACnB,CAAC;KAAA;IAED;;OAEG;IAEG,OAAO;;YACT,WAAW,EAAE,CAAC;YACd,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;YAC9B,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;YACrE,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACvB,CAAC;KAAA;CACJ;AAnFS;IADL,GAAG;;;;8CAwEH;AAMK;IADL,GAAG;;;;wCAMH;AAGL,gBAAgB;AAChB,MAAM,CAAC,MAAM,gBAAgB,GAAG,UAAU,CACtC,WAAW,EACX;IACI,qBAAqB,CAAC,KAAK;IAC3B,yBAAyB,CAAC,KAAK;IAC/B,eAAe,CAAC,KAAK;IACrB,qBAAqB,CAAC,KAAK;IAC3B,SAAS;CACH,EACV,CACI,cAA8B,EAC9B,OAA2B,EAC3B,QAAwB,EACxB,cAA8B,EAC9B,SAAkC,EACpC,EAAE,CAAC,IAAI,SAAS,CAAC,cAAc,EAAE,QAAQ,EAAE,cAAc,EAAE,SAAS,EAAE,OAAO,CAAC,CACnF,CAAC","sourcesContent":["import { lensRepositoryFactory, LensRepository } from \"./lens/LensRepository\";\nimport { CONTAINER, Container } from \"./dependency-injection/Container\";\nimport { Injectable } from \"./dependency-injection/Injectable\";\nimport { LensCoreError, LensCoreModule } from \"./lens-core-module/generated-types\";\nimport { CameraKitSession, cameraKitSessionFactory } from \"./session/CameraKitSession\";\nimport { registerLensAssetsProvider } from \"./lens/assets/LensAssetsProvider\";\nimport { lensCoreFactory } from \"./lens-core-module/loader/lensCoreFactory\";\nimport { configurationToken } from \"./configuration\";\nimport { RootServices } from \"./dependency-injection/RootServices\";\nimport { registerUriHandlers } from \"./extensions/uriHandlersRegister\";\nimport { MetricsEventTarget, metricsEventTargetFactory } from \"./metrics/metricsEventTarget\";\nimport { reportSessionScopedMetrics } from \"./metrics/reporters/reporters\";\nimport { lensStateFactory } from \"./session/lensState\";\nimport { lensKeyboardFactory } from \"./session/LensKeyboard\";\nimport { registerLensClientInterfaceHandler } from \"./lens-client-interface/lensClientInterface\";\nimport { sessionStateFactory } from \"./session/sessionState\";\nimport { lensExecutionError } from \"./namedErrors\";\nimport { getLogger, resetLogger } from \"./logger/logger\";\nimport { errorLoggingDecorator } from \"./logger/errorLoggingDecorator\";\nimport { TypedEventTarget } from \"./events/TypedEventTarget\";\nimport { TypedCustomEvent } from \"./events/TypedCustomEvent\";\nimport { LensView } from \"./metrics/reporters/reportLensView\";\nimport { LensWait } from \"./metrics/reporters/reportLensWait\";\nimport { PageVisibility, pageVisibilityFactory } from \"./common/pageVisibility\";\nimport { setPreloadedConfiguration } from \"./remote-configuration/preloadConfiguration\";\n\nconst logger = getLogger(\"CameraKit\");\nconst log = errorLoggingDecorator(logger);\n\n/**\n * Metrics event names that are exposed to apps.\n */\nconst publicMetricsEventNames: Array<LensMetricsEvents[\"detail\"][\"name\"]> = [\"lensView\", \"lensWait\"];\n\n/**\n * Lens metrics events.\n *\n * These events are emitted by {@link CameraKit} to report lens usage, performance, apply latency, etc.\n *\n * @category Lenses\n * @category Metrics\n */\nexport type LensMetricsEvents =\n    | TypedCustomEvent<LensView[\"name\"], LensView>\n    | TypedCustomEvent<LensWait[\"name\"], LensWait>;\n\n/**\n * Options available when creating a {@link CameraKitSession}.\n *\n * @category Rendering\n */\nexport interface CreateSessionOptions {\n    /**\n     * Optionally provide an existing canvas element, on which the Live RenderTarget will be rendered.\n     *\n     * If this is not provided, CameraKit will create a new canvas element which can be added to the DOM.\n     */\n    liveRenderTarget?: HTMLCanvasElement;\n\n    /**\n     * Browsers optimize tabs when they are hidden - for example, by pausing the execution of requestAnimationFrame\n     * callbacks.\n     *\n     * If you need the CameraKitSession to continue rendering even when the tab is in the background, set this to true.\n     * There is a small performance penalty, and it's a good practice to only render in the background if absolutely\n     * necessary.\n     */\n    renderWhileTabHidden?: boolean;\n}\n\n/**\n * The entry point to the CameraKit SDK's API. Most of CameraKit's features are accessed via this class.\n *\n * Applications obtain an instance of CameraKit by calling {@link bootstrapCameraKit}.\n *\n * @example\n * ```ts\n * const cameraKit = await bootstrapCameraKit(config)\n * ```\n *\n * Then this class can be used to:\n * - Create a {@link CameraKitSession} instance, which provides the API for setting up media inputs, applying Lenses,\n * and obtaining rendered `<canvas>` outputs.\n * - Query for lenses using {@link LensRepository}.\n * - Listen for lens usage metrics events using {@link MetricsEventTarget}.\n *\n * @category Rendering\n * @category Lenses\n */\nexport class CameraKit {\n    /** @deprecated Use {@link lensRepository} */\n    readonly lenses: { repository: LensRepository };\n\n    /**\n     * Business metrics (e.g. each time a lens is viewed) are emitted here.\n     */\n    readonly metrics: TypedEventTarget<LensMetricsEvents> = new TypedEventTarget();\n\n    private sessions: CameraKitSession[] = [];\n\n    /** @internal */\n    constructor(\n        /**\n         * Used to query for lenses and lens groups.\n         */\n        readonly lensRepository: LensRepository,\n\n        private readonly lensCore: LensCoreModule,\n        private readonly pageVisibility: PageVisibility,\n        private readonly container: Container<RootServices>,\n        allMetrics: MetricsEventTarget\n    ) {\n        this.lenses = { repository: this.lensRepository };\n        // Proxy only a subset of all metrics events to the public-facing emitter -- applications don't need to\n        // know about most events.\n        publicMetricsEventNames.forEach((eventName) => {\n            allMetrics.addEventListener(eventName, (e) => this.metrics.dispatchEvent(e));\n        });\n    }\n\n    /**\n     * Create a CameraKitSession.\n     *\n     * This initializes the rendering engine and returns a {@link CameraKitSession} instance, which provides access\n     * to Lens rendering.\n     *\n     * @example\n     * ```ts\n     * const cameraKit = await bootstrapCameraKit(config)\n     * const session = await cameraKit.createSession()\n     *\n     * const lens = await cameraKit.lensRepository.loadLens(lensId, groupId)\n     * session.applyLens(lens)\n     * ```\n     *\n     * @param options\n     */\n    @log\n    async createSession({\n        liveRenderTarget,\n        renderWhileTabHidden,\n    }: CreateSessionOptions = {}): Promise<CameraKitSession> {\n        // Any error happened during lens rendering can be processed by subscribing to sessionErrors\n        const exceptionHandler = (error: LensCoreError) =>\n            logger.error(\n                lensExecutionError(\n                    \"Error occurred during lens execution. \" +\n                        \"The lens cannot be rendered and will be removed from the CameraKitSession.\",\n                    error\n                )\n            );\n\n        /**\n         * If/when we add support for multiple concurrent sessions, we'll need to create a copy of the LensCore WASM\n         * module. If we move managing web workers into JS, spawing a new worker thread with its own copy of LensCore\n         * probably becomes a lot more straightforward.\n         *\n         * Currently chromium has a bug preventing rendering while tab is hidden when LensCore is in worker mode.\n         * In order to process tab while it is hidden, the current stopgap is to pass in renderWhileTabHidden as true,\n         * which will initiate session in non worker mode, and set the RenderLoopMode to `SetTimeout`.\n         */\n        await new Promise<void>((onSuccess, onFailure) => {\n            this.lensCore.initialize({\n                canvas: liveRenderTarget,\n                shouldUseWorker: !renderWhileTabHidden && this.container.get(configurationToken).shouldUseWorker,\n                exceptionHandler,\n                onSuccess,\n                onFailure,\n            });\n        });\n\n        await new Promise<void>((onSuccess, onFailure) => {\n            this.lensCore.setRenderLoopMode({\n                mode: renderWhileTabHidden\n                    ? this.lensCore.RenderLoopMode.SetTimeout\n                    : this.lensCore.RenderLoopMode.RequestAnimationFrame,\n                onSuccess,\n                onFailure,\n            });\n        });\n\n        // Each session gets its own DI Container – some Services provided by this Container may be shared with the\n        // root CameraKit Container, but others may be scoped to the session by passing their token to `copy()`.\n        const sessionContainer = this.container\n            // Right now this is a no-op. If/when we add support for multiple concurrent sessions, we may end up\n            // scoping LensCore to the session.\n            .copy()\n\n            .provides(sessionStateFactory)\n            .provides(lensStateFactory)\n            .provides(lensKeyboardFactory)\n            .provides(cameraKitSessionFactory)\n\n            .run(registerLensAssetsProvider)\n            .run(registerLensClientInterfaceHandler)\n            .run(setPreloadedConfiguration)\n\n            // We'll run a PartialContainer containing reporters for session-scoped metrics. Running this container\n            // allows each metric reporter to initialize itself (e.g. by adding event listeners to detect when certain\n            // actions occur).\n            .run(reportSessionScopedMetrics)\n\n            // UriHandlers may have dependencies on session-scoped services (e.g. LensState, LensKeyboard), so they'll\n            // be registered with LensCore here.\n            .run(registerUriHandlers);\n\n        const session = sessionContainer.get(cameraKitSessionFactory.token);\n        this.sessions.push(session);\n        return session;\n    }\n\n    /**\n     * Destroys all sessions and frees all resources.\n     */\n    @log\n    async destroy() {\n        resetLogger();\n        this.pageVisibility.destroy();\n        await Promise.all(this.sessions.map((session) => session.destroy()));\n        this.sessions = [];\n    }\n}\n\n/** @internal */\nexport const cameraKitFactory = Injectable(\n    \"CameraKit\",\n    [\n        lensRepositoryFactory.token,\n        metricsEventTargetFactory.token,\n        lensCoreFactory.token,\n        pageVisibilityFactory.token,\n        CONTAINER,\n    ] as const,\n    (\n        lensRepository: LensRepository,\n        metrics: MetricsEventTarget,\n        lensCore: LensCoreModule,\n        pageVisibility: PageVisibility,\n        container: Container<RootServices>\n    ) => new CameraKit(lensRepository, lensCore, pageVisibility, container, metrics)\n);\n"]}

package/lib/__tests__/data.d.ts

@@ -4,6 +4,6 @@ import { LensCoreModule, AssetType as LensCoreAssetType } from "../lens-core-mod
 export declare const falsyValues: readonly [false, null, undefined, 0, ""];
 export declare const truthyValues: readonly [true, 1, {}, Date, readonly []];
 export declare function createLensFixture(name: string, content?: Partial<ContentProto>): LensProto;
-export type LensCoreMock = Pick<jest.Mocked<LensCoreModule>, "AssetType" | "CanvasType" | "InterfaceAction" | "InterfaceControl" | "ExternalMediaOrientation" | "initialize" | "setRemoteAssetsProvider" | "provideRemoteAssetsResponse" | "getOutputCanvases" | "setRenderLoopMode" | "RenderLoopMode" | "setOnFrameProcessedCallback" | "setClientInterfaceRequestHandler" | "provideExternalImage" | "provideExternalVideo" | "registerSavePersistentStoreCallback">;
+export type LensCoreMock = Pick<jest.Mocked<LensCoreModule>, "AssetType" | "CanvasType" | "InterfaceAction" | "InterfaceControl" | "ExternalMediaOrientation" | "initialize" | "setRemoteAssetsProvider" | "provideRemoteAssetsResponse" | "getOutputCanvases" | "setRenderLoopMode" | "RenderLoopMode" | "setPreloadedConfiguration" | "setOnFrameProcessedCallback" | "setClientInterfaceRequestHandler" | "provideExternalImage" | "provideExternalVideo" | "registerSavePersistentStoreCallback">;
 export declare const AssetType: Record<keyof LensCoreModule["AssetType"], LensCoreAssetType>;
 export declare function createLensCore(): LensCoreMock;

package/lib/__tests__/data.js

@@ -47,6 +47,7 @@ export function createLensCore() {
         setRemoteAssetsProvider: jest.fn(),
         provideRemoteAssetsResponse: jest.fn(),
         getOutputCanvases: jest.fn(),
+        setPreloadedConfiguration: jest.fn(),
         setRenderLoopMode: jest.fn(),
         setOnFrameProcessedCallback: jest.fn(),
         setClientInterfaceRequestHandler: jest.fn(),

package/lib/__tests__/data.js.map

@@ -1 +1 @@
-{"version":3,"file":"data.js","sourceRoot":"","sources":["../../src/__tests__/data.ts"],"names":[],"mappings":"AAAA,4BAA4B;AAC5B,OAAO,EAA2B,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAGrE,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE,CAAU,CAAC;AACpE,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,IAAI,EAAE,EAAE,EAAE,CAAU,CAAC;AAEnE,MAAM,UAAU,iBAAiB,CAAC,IAAY,EAAE,OAA+B;IAC3E,OAAO;QACH,EAAE,EAAE,IAAI;QACR,IAAI;QACJ,UAAU,EAAE,EAAE;QACd,OAAO,kBACH,WAAW,EAAE,2BAA2B,EACxC,SAAS,EAAE,EAAE,EACb,UAAU,EAAE,EAAE,EACd,OAAO,EAAE;gBACL,QAAQ,EAAE,8BAA8B;gBACxC,iBAAiB,EAAE,GAAG;gBACtB,2BAA2B,EAAE,+BAA+B;aAC/D,EACD,aAAa,EAAE,EAAE,EACjB,aAAa,EAAE,EAAE,EACjB,gBAAgB,EAAE,EAAE,IACjB,OAAO,CACb;QACD,SAAS,EAAE;YACP,gBAAgB,EAAE,8BAA8B;YAChD,gBAAgB,EAAE,8BAA8B;SACnD;QACD,YAAY,EAAE,KAAK;QACnB,sBAAsB,EAAE,iBAAiB,CAAC,YAAY;QACtD,eAAe,EAAE,EAAE;QACnB,WAAW,EAAE;YACT,WAAW,EAAE,EAAE;SAClB;KACJ,CAAC;AACN,CAAC;AAsBD,6EAA6E;AAC7E,MAAM,CAAC,MAAM,SAAS,GAAiE;IACnF,eAAe,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;IAC7B,gBAAgB,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;IAC9B,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;IACpB,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;IACjB,mBAAmB,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;CACpC,CAAC;AAEF,MAAM,UAAU,cAAc;IAC1B,OAAO;QACH,SAAS;QACT,UAAU,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;QACnG,cAAc,EAAE,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,qBAAqB,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;QACjF,6IAA6I;QAC7I,eAAe,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAS;QAC9C,6IAA6I;QAC7I,gBAAgB,EAAE,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAS;QACtD,+IAA+I;QAC/I,wBAAwB,EAAE,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;QAC7G,UAAU,EAAE,IAAI,CAAC,EAAE,EAAE;QACrB,uBAAuB,EAAE,IAAI,CAAC,EAAE,EAAE;QAClC,2BAA2B,EAAE,IAAI,CAAC,EAAE,EAAE;QACtC,iBAAiB,EAAE,IAAI,CAAC,EAAE,EAAE;QAC5B,iBAAiB,EAAE,IAAI,CAAC,EAAE,EAAE;QAC5B,2BAA2B,EAAE,IAAI,CAAC,EAAE,EAAE;QACtC,gCAAgC,EAAE,IAAI,CAAC,EAAE,EAAE;QAC3C,oBAAoB,EAAE,IAAI,CAAC,EAAE,EAAE;QAC/B,oBAAoB,EAAE,IAAI,CAAC,EAAE,EAAE;QAC/B,mCAAmC,EAAE,IAAI,CAAC,EAAE,EAAE;KACjD,CAAC;AACN,CAAC","sourcesContent":["/* eslint-disable max-len */\nimport { ContentProto, LensProto, Lens_CameraFacing } from \"../lens\";\nimport { LensCoreModule, AssetType as LensCoreAssetType } from \"../lens-core-module/generated-types\";\n\nexport const falsyValues = [false, null, undefined, 0, \"\"] as const;\nexport const truthyValues = [true, 1, {}, new Date(), []] as const;\n\nexport function createLensFixture(name: string, content?: Partial<ContentProto>): LensProto {\n    return {\n        id: name,\n        name,\n        vendorData: {},\n        content: {\n            iconUrlBolt: \"https://bolt.com/iconUrl1\",\n            lnsSha256: \"\",\n            lnsUrlBolt: \"\",\n            preview: {\n                imageUrl: \"https://bolt.com/previewUrl1\",\n                imageSequenceSize: 100,\n                imageSequenceWebpUrlPattern: \"http://images.com/face-%d.com\",\n            },\n            assetManifest: [],\n            defaultHintId: \"\",\n            hintTranslations: {},\n            ...content,\n        },\n        scannable: {\n            snapcodeImageUrl: \"https://snapcodeImageUrl.com\",\n            snapcodeDeeplink: \"https://snapcodeDeeplink.com\",\n        },\n        isThirdParty: false,\n        cameraFacingPreference: Lens_CameraFacing.UNRECOGNIZED,\n        featureMetadata: [],\n        lensCreator: {\n            displayName: \"\",\n        },\n    };\n}\n\nexport type LensCoreMock = Pick<\n    jest.Mocked<LensCoreModule>,\n    | \"AssetType\"\n    | \"CanvasType\"\n    | \"InterfaceAction\"\n    | \"InterfaceControl\"\n    | \"ExternalMediaOrientation\"\n    | \"initialize\"\n    | \"setRemoteAssetsProvider\"\n    | \"provideRemoteAssetsResponse\"\n    | \"getOutputCanvases\"\n    | \"setRenderLoopMode\"\n    | \"RenderLoopMode\"\n    | \"setOnFrameProcessedCallback\"\n    | \"setClientInterfaceRequestHandler\"\n    | \"provideExternalImage\"\n    | \"provideExternalVideo\"\n    | \"registerSavePersistentStoreCallback\"\n>;\n\n// NOTE: type of the record ensures newly added asset types break compilation\nexport const AssetType: Record<keyof LensCoreModule[\"AssetType\"], LensCoreAssetType> = {\n    DeviceDependent: { value: 3 },\n    RemoteMediaByUrl: { value: 6 },\n    Static: { value: 1 },\n    URL: { value: 2 },\n    BitmojiDynamicAsset: { value: 4 },\n};\n\nexport function createLensCore(): LensCoreMock {\n    return {\n        AssetType,\n        CanvasType: { Preview: { value: 1 }, Capture: { value: 2 }, None: { value: 0 }, All: { value: 3 } },\n        RenderLoopMode: { SetTimeout: { value: 1 }, RequestAnimationFrame: { value: 0 } },\n        // https://github.sc-corp.net/Snapchat/LensCore/blob/502b54b9a663203bcdf3b90c63214cdf8cc1e713/Src/CoreManager/ClientInterfaceDelegate.hpp#L39\n        InterfaceAction: { Show: { value: 3 } } as any,\n        // https://github.sc-corp.net/Snapchat/LensCore/blob/502b54b9a663203bcdf3b90c63214cdf8cc1e713/Src/CoreManager/ClientInterfaceDelegate.hpp#L21\n        InterfaceControl: { ImagePicker: { value: 1 } } as any,\n        // https://github.sc-corp.net/Snapchat/LensCore/blob/2d538ecc41f67dd2c199e0ff0eefd96aac6f22dc/Src/Common/IExternalMediaFilePickedObserver.h#L21\n        ExternalMediaOrientation: { CW0: { value: 0 }, CW90: { value: 1 }, CW180: { value: 2 }, CW270: { value: 3 } },\n        initialize: jest.fn(),\n        setRemoteAssetsProvider: jest.fn(),\n        provideRemoteAssetsResponse: jest.fn(),\n        getOutputCanvases: jest.fn(),\n        setRenderLoopMode: jest.fn(),\n        setOnFrameProcessedCallback: jest.fn(),\n        setClientInterfaceRequestHandler: jest.fn(),\n        provideExternalImage: jest.fn(),\n        provideExternalVideo: jest.fn(),\n        registerSavePersistentStoreCallback: jest.fn(),\n    };\n}\n"]}
+{"version":3,"file":"data.js","sourceRoot":"","sources":["../../src/__tests__/data.ts"],"names":[],"mappings":"AAAA,4BAA4B;AAC5B,OAAO,EAA2B,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAGrE,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE,CAAU,CAAC;AACpE,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,IAAI,EAAE,EAAE,EAAE,CAAU,CAAC;AAEnE,MAAM,UAAU,iBAAiB,CAAC,IAAY,EAAE,OAA+B;IAC3E,OAAO;QACH,EAAE,EAAE,IAAI;QACR,IAAI;QACJ,UAAU,EAAE,EAAE;QACd,OAAO,kBACH,WAAW,EAAE,2BAA2B,EACxC,SAAS,EAAE,EAAE,EACb,UAAU,EAAE,EAAE,EACd,OAAO,EAAE;gBACL,QAAQ,EAAE,8BAA8B;gBACxC,iBAAiB,EAAE,GAAG;gBACtB,2BAA2B,EAAE,+BAA+B;aAC/D,EACD,aAAa,EAAE,EAAE,EACjB,aAAa,EAAE,EAAE,EACjB,gBAAgB,EAAE,EAAE,IACjB,OAAO,CACb;QACD,SAAS,EAAE;YACP,gBAAgB,EAAE,8BAA8B;YAChD,gBAAgB,EAAE,8BAA8B;SACnD;QACD,YAAY,EAAE,KAAK;QACnB,sBAAsB,EAAE,iBAAiB,CAAC,YAAY;QACtD,eAAe,EAAE,EAAE;QACnB,WAAW,EAAE;YACT,WAAW,EAAE,EAAE;SAClB;KACJ,CAAC;AACN,CAAC;AAuBD,6EAA6E;AAC7E,MAAM,CAAC,MAAM,SAAS,GAAiE;IACnF,eAAe,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;IAC7B,gBAAgB,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;IAC9B,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;IACpB,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;IACjB,mBAAmB,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;CACpC,CAAC;AAEF,MAAM,UAAU,cAAc;IAC1B,OAAO;QACH,SAAS;QACT,UAAU,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;QACnG,cAAc,EAAE,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,qBAAqB,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;QACjF,6IAA6I;QAC7I,eAAe,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAS;QAC9C,6IAA6I;QAC7I,gBAAgB,EAAE,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAS;QACtD,+IAA+I;QAC/I,wBAAwB,EAAE,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;QAC7G,UAAU,EAAE,IAAI,CAAC,EAAE,EAAE;QACrB,uBAAuB,EAAE,IAAI,CAAC,EAAE,EAAE;QAClC,2BAA2B,EAAE,IAAI,CAAC,EAAE,EAAE;QACtC,iBAAiB,EAAE,IAAI,CAAC,EAAE,EAAE;QAC5B,yBAAyB,EAAE,IAAI,CAAC,EAAE,EAAE;QACpC,iBAAiB,EAAE,IAAI,CAAC,EAAE,EAAE;QAC5B,2BAA2B,EAAE,IAAI,CAAC,EAAE,EAAE;QACtC,gCAAgC,EAAE,IAAI,CAAC,EAAE,EAAE;QAC3C,oBAAoB,EAAE,IAAI,CAAC,EAAE,EAAE;QAC/B,oBAAoB,EAAE,IAAI,CAAC,EAAE,EAAE;QAC/B,mCAAmC,EAAE,IAAI,CAAC,EAAE,EAAE;KACjD,CAAC;AACN,CAAC","sourcesContent":["/* eslint-disable max-len */\nimport { ContentProto, LensProto, Lens_CameraFacing } from \"../lens\";\nimport { LensCoreModule, AssetType as LensCoreAssetType } from \"../lens-core-module/generated-types\";\n\nexport const falsyValues = [false, null, undefined, 0, \"\"] as const;\nexport const truthyValues = [true, 1, {}, new Date(), []] as const;\n\nexport function createLensFixture(name: string, content?: Partial<ContentProto>): LensProto {\n    return {\n        id: name,\n        name,\n        vendorData: {},\n        content: {\n            iconUrlBolt: \"https://bolt.com/iconUrl1\",\n            lnsSha256: \"\",\n            lnsUrlBolt: \"\",\n            preview: {\n                imageUrl: \"https://bolt.com/previewUrl1\",\n                imageSequenceSize: 100,\n                imageSequenceWebpUrlPattern: \"http://images.com/face-%d.com\",\n            },\n            assetManifest: [],\n            defaultHintId: \"\",\n            hintTranslations: {},\n            ...content,\n        },\n        scannable: {\n            snapcodeImageUrl: \"https://snapcodeImageUrl.com\",\n            snapcodeDeeplink: \"https://snapcodeDeeplink.com\",\n        },\n        isThirdParty: false,\n        cameraFacingPreference: Lens_CameraFacing.UNRECOGNIZED,\n        featureMetadata: [],\n        lensCreator: {\n            displayName: \"\",\n        },\n    };\n}\n\nexport type LensCoreMock = Pick<\n    jest.Mocked<LensCoreModule>,\n    | \"AssetType\"\n    | \"CanvasType\"\n    | \"InterfaceAction\"\n    | \"InterfaceControl\"\n    | \"ExternalMediaOrientation\"\n    | \"initialize\"\n    | \"setRemoteAssetsProvider\"\n    | \"provideRemoteAssetsResponse\"\n    | \"getOutputCanvases\"\n    | \"setRenderLoopMode\"\n    | \"RenderLoopMode\"\n    | \"setPreloadedConfiguration\"\n    | \"setOnFrameProcessedCallback\"\n    | \"setClientInterfaceRequestHandler\"\n    | \"provideExternalImage\"\n    | \"provideExternalVideo\"\n    | \"registerSavePersistentStoreCallback\"\n>;\n\n// NOTE: type of the record ensures newly added asset types break compilation\nexport const AssetType: Record<keyof LensCoreModule[\"AssetType\"], LensCoreAssetType> = {\n    DeviceDependent: { value: 3 },\n    RemoteMediaByUrl: { value: 6 },\n    Static: { value: 1 },\n    URL: { value: 2 },\n    BitmojiDynamicAsset: { value: 4 },\n};\n\nexport function createLensCore(): LensCoreMock {\n    return {\n        AssetType,\n        CanvasType: { Preview: { value: 1 }, Capture: { value: 2 }, None: { value: 0 }, All: { value: 3 } },\n        RenderLoopMode: { SetTimeout: { value: 1 }, RequestAnimationFrame: { value: 0 } },\n        // https://github.sc-corp.net/Snapchat/LensCore/blob/502b54b9a663203bcdf3b90c63214cdf8cc1e713/Src/CoreManager/ClientInterfaceDelegate.hpp#L39\n        InterfaceAction: { Show: { value: 3 } } as any,\n        // https://github.sc-corp.net/Snapchat/LensCore/blob/502b54b9a663203bcdf3b90c63214cdf8cc1e713/Src/CoreManager/ClientInterfaceDelegate.hpp#L21\n        InterfaceControl: { ImagePicker: { value: 1 } } as any,\n        // https://github.sc-corp.net/Snapchat/LensCore/blob/2d538ecc41f67dd2c199e0ff0eefd96aac6f22dc/Src/Common/IExternalMediaFilePickedObserver.h#L21\n        ExternalMediaOrientation: { CW0: { value: 0 }, CW90: { value: 1 }, CW180: { value: 2 }, CW270: { value: 3 } },\n        initialize: jest.fn(),\n        setRemoteAssetsProvider: jest.fn(),\n        provideRemoteAssetsResponse: jest.fn(),\n        getOutputCanvases: jest.fn(),\n        setPreloadedConfiguration: jest.fn(),\n        setRenderLoopMode: jest.fn(),\n        setOnFrameProcessedCallback: jest.fn(),\n        setClientInterfaceRequestHandler: jest.fn(),\n        provideExternalImage: jest.fn(),\n        provideExternalVideo: jest.fn(),\n        registerSavePersistentStoreCallback: jest.fn(),\n    };\n}\n"]}

package/lib/assertPlatformSupported.d.ts

@@ -1,4 +1,6 @@
 /**
- * Assert current platform is supported.
+ * Assert that the current platform supports the necessary WebGL features.
+ * Specifically, it checks for WebGL or WebGL2 support and ensures that
+ * the maximum texture size is at least 1024.
  */
 export declare function assertPlatformSupported(): void;

package/lib/assertPlatformSupported.js

@@ -1,10 +1,21 @@
 import { assert } from "./common/assertions";
 import { platformNotSupportedError } from "./namedErrors";
+const minTextureSize = 1024;
 /**
- * Assert current platform is supported.
+ * Assert that the current platform supports the necessary WebGL features.
+ * Specifically, it checks for WebGL or WebGL2 support and ensures that
+ * the maximum texture size is at least 1024.
  */
 export function assertPlatformSupported() {
     const canvas = document.createElement("canvas");
-    assert(!!canvas.getContext("webgl2") || !!canvas.getContext("webgl"), platformNotSupportedError("Camera Kit cannot be bootstrapped because the browser does not support WebGL canvas rendering context."));
+    const webglContext = canvas.getContext("webgl2") || canvas.getContext("webgl");
+    const maxTextureSize = webglContext === null || webglContext === void 0 ? void 0 : webglContext.getParameter(webglContext.MAX_TEXTURE_SIZE);
+    assert(!!webglContext, platformNotSupportedError("Camera Kit cannot be bootstrapped because the browser does not support WebGL canvas rendering context."));
+    // Assert that the maximum texture size supported by WebGL is at least 1024.
+    // This is based on the information available at https://web3dsurvey.com/webgl/parameters/MAX_TEXTURE_SIZE
+    // and ensures that the application avoids future errors due to incompatibility with smaller texture sizes.
+    assert(maxTextureSize >= minTextureSize, platformNotSupportedError(
+    // eslint-disable-next-line max-len
+    `Camera Kit cannot be bootstrapped because this browser's WebGL MAX_TEXTURE_SIZE is ${maxTextureSize}, which is below the minimum requirement of ${minTextureSize}.`));
 }
 //# sourceMappingURL=assertPlatformSupported.js.map

package/lib/assertPlatformSupported.js.map

@@ -1 +1 @@
-{"version":3,"file":"assertPlatformSupported.js","sourceRoot":"","sources":["../src/assertPlatformSupported.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAE1D;;GAEG;AACH,MAAM,UAAU,uBAAuB;IACnC,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,MAAM,CACF,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,EAC7D,yBAAyB,CACrB,wGAAwG,CAC3G,CACJ,CAAC;AACN,CAAC","sourcesContent":["import { assert } from \"./common/assertions\";\nimport { platformNotSupportedError } from \"./namedErrors\";\n\n/**\n * Assert current platform is supported.\n */\nexport function assertPlatformSupported() {\n    const canvas = document.createElement(\"canvas\");\n    assert(\n        !!canvas.getContext(\"webgl2\") || !!canvas.getContext(\"webgl\"),\n        platformNotSupportedError(\n            \"Camera Kit cannot be bootstrapped because the browser does not support WebGL canvas rendering context.\"\n        )\n    );\n}\n"]}
+{"version":3,"file":"assertPlatformSupported.js","sourceRoot":"","sources":["../src/assertPlatformSupported.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAE1D,MAAM,cAAc,GAAG,IAAI,CAAC;AAE5B;;;;GAIG;AACH,MAAM,UAAU,uBAAuB;IACnC,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,MAAM,YAAY,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC/E,MAAM,cAAc,GAAG,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,YAAY,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;IAEjF,MAAM,CACF,CAAC,CAAC,YAAY,EACd,yBAAyB,CACrB,wGAAwG,CAC3G,CACJ,CAAC;IAEF,4EAA4E;IAC5E,0GAA0G;IAC1G,2GAA2G;IAC3G,MAAM,CACF,cAAc,IAAI,cAAc,EAChC,yBAAyB;IACrB,mCAAmC;IACnC,sFAAsF,cAAc,+CAA+C,cAAc,GAAG,CACvK,CACJ,CAAC;AACN,CAAC","sourcesContent":["import { assert } from \"./common/assertions\";\nimport { platformNotSupportedError } from \"./namedErrors\";\n\nconst minTextureSize = 1024;\n\n/**\n * Assert that the current platform supports the necessary WebGL features.\n * Specifically, it checks for WebGL or WebGL2 support and ensures that\n * the maximum texture size is at least 1024.\n */\nexport function assertPlatformSupported() {\n    const canvas = document.createElement(\"canvas\");\n    const webglContext = canvas.getContext(\"webgl2\") || canvas.getContext(\"webgl\");\n    const maxTextureSize = webglContext?.getParameter(webglContext.MAX_TEXTURE_SIZE);\n\n    assert(\n        !!webglContext,\n        platformNotSupportedError(\n            \"Camera Kit cannot be bootstrapped because the browser does not support WebGL canvas rendering context.\"\n        )\n    );\n\n    // Assert that the maximum texture size supported by WebGL is at least 1024.\n    // This is based on the information available at https://web3dsurvey.com/webgl/parameters/MAX_TEXTURE_SIZE\n    // and ensures that the application avoids future errors due to incompatibility with smaller texture sizes.\n    assert(\n        maxTextureSize >= minTextureSize,\n        platformNotSupportedError(\n            // eslint-disable-next-line max-len\n            `Camera Kit cannot be bootstrapped because this browser's WebGL MAX_TEXTURE_SIZE is ${maxTextureSize}, which is below the minimum requirement of ${minTextureSize}.`\n        )\n    );\n}\n"]}