@snap/camera-kit 0.13.2 → 0.14.0

package/lib/namedErrors.d.ts

@@ -83,6 +83,23 @@ export declare const platformNotSupportedError: (message: string, cause?: unknow
 export type LensExecutionError = NamedError<"LensExecutionError">;
 /** @internal */
 export declare const lensExecutionError: (message: string, cause?: unknown) => LensExecutionError;
+/**
+ * This error occurs when a session becomes inoperable.
+ *
+ * It's always a good idea to handle this error and update the user experience accordingly.
+ * For example, you could show a message to a user.
+ *
+ * ```ts
+ * cameraKitSession.events.addEventListener('error', ({ detail }) => {
+ *   if (detail.error.name === 'LensAbortError') {
+ *     console.log(`Camera Kit encountered an unrecoverable error and became inoperable. Please refresh the page.`)
+ *   }
+ * })
+ * ```
+ */
+export type LensAbortError = NamedError<"LensAbortError">;
+/** @internal */
+export declare const lensAbortError: (message: string, cause?: unknown) => LensAbortError;
 /**
  * Error thrown when LensCore asked to store lens data, but CameraKit failed storing that.
  */

package/lib/namedErrors.js

@@ -48,6 +48,8 @@ export const platformNotSupportedError = namedError("PlatformNotSupportedError")
 /** @internal */
 export const lensExecutionError = namedError("LensExecutionError");
 /** @internal */
+export const lensAbortError = namedError("LensAbortError");
+/** @internal */
 export const persistentStoreError = namedError("PersistentStoreError");
 /** @internal */
 export const lensAssetError = namedError("LensAssetError");

package/lib/namedErrors.js.map

@@ -1 +1 @@
-{"version":3,"file":"namedErrors.js","sourceRoot":"","sources":["../src/namedErrors.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,yFAAyF;AAczF;;GAEG;AACH,SAAS,eAAe,CAAC,KAAa;IAClC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC9C,OAAO,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,UAAU,CAKxB,IAAW;IACT,OAAO,CAAC,OAAe,EAAE,KAAe,EAAU,EAAE;QAChD,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5C,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QAClB,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1D,4EAA4E;QAC5E,OAAO,KAAe,CAAC;IAC3B,CAAC,CAAC;AACN,CAAC;AAGD,gBAAgB;AAChB,MAAM,CAAC,MAAM,UAAU,GAAG,UAAU,CAAa,YAAY,CAAC,CAAC;AAG/D,gBAAgB;AAChB,MAAM,CAAC,MAAM,0BAA0B,GAAG,UAAU,CAA6B,4BAA4B,CAAC,CAAC;AAG/G,gBAAgB;AAChB,MAAM,CAAC,MAAM,SAAS,GAAG,UAAU,CAAY,WAAW,CAAC,CAAC;AAG5D,gBAAgB;AAChB,MAAM,CAAC,MAAM,oBAAoB,GAAG,UAAU,CAAuB,sBAAsB,CAAC,CAAC;AAO7F,gBAAgB;AAChB,MAAM,CAAC,MAAM,oBAAoB,GAAG,UAAU,CAAuB,sBAAsB,CAAC,CAAC;AAG7F,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAAG,UAAU,CAAwB,uBAAuB,CAAC,CAAC;AAQhG,gBAAgB;AAChB,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAqB,oBAAoB,CAAC,CAAC;AAGvF,gBAAgB;AAChB,MAAM,CAAC,MAAM,UAAU,GAAG,UAAU,CAAa,YAAY,CAAC,CAAC;AAG/D,gBAAgB;AAChB,MAAM,CAAC,MAAM,cAAc,GAAG,UAAU,CAAiB,gBAAgB,CAAC,CAAC;AAU3E,gBAAgB;AAChB,MAAM,CAAC,MAAM,yBAAyB,GAAG,UAAU,CAA4B,2BAA2B,CAAC,CAAC;AAkB5G,gBAAgB;AAChB,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAqB,oBAAoB,CAAC,CAAC;AAMvF,gBAAgB;AAChB,MAAM,CAAC,MAAM,oBAAoB,GAAG,UAAU,CAAuB,sBAAsB,CAAC,CAAC;AAM7F,gBAAgB;AAChB,MAAM,CAAC,MAAM,cAAc,GAAG,UAAU,CAAiB,gBAAgB,CAAC,CAAC;AAS3E,gBAAgB;AAChB,MAAM,CAAC,MAAM,cAAc,GAAG,UAAU,CAAiB,gBAAgB,CAAC,CAAC","sourcesContent":["// NOTE: All errors thrown in the CameraKit package have to be defined here.\n// Error types are not infered from error factories for API doc purposes and consistency.\n\n/**\n * Helper type to extract type generic parameter.\n */\ntype ExtractName<P> = P extends NamedError<infer T> ? T : never;\n\n/**\n * All errors are expected to have \"Error\" suffix.\n */\ntype ErrorName = `${string}Error`;\n\ntype NamedError<Name extends ErrorName> = Error & { name: Name };\n\n/**\n * Removes the top trace line from the stack.\n */\nfunction cleanErrorStack(stack: string): string {\n    const [first, _, ...rest] = stack.split(\"\\n\");\n    return [first, ...rest].join(\"\\n\");\n}\n\n/**\n * Creates error factory that ensures Error.prototype.name field value.\n *\n * NOTE: exported only for unit tests.\n *\n * @param name Error name.\n * @returns Error factory function.\n * @internal\n */\nexport function namedError<\n    // default to never to ensure the type argument is specified\n    TError extends NamedError<TName> = never,\n    // default to provided error name to make this type argument optional to reduce boilerplate\n    TName extends ErrorName = ExtractName<TError>\n>(name: TName) {\n    return (message: string, cause?: unknown): TError => {\n        const error = new Error(message, { cause });\n        error.name = name;\n        error.stack = error.stack && cleanErrorStack(error.stack);\n        // Safety: we set name above and therefore sure the type of error is correct\n        return error as TError;\n    };\n}\n\nexport type LegalError = NamedError<\"LegalError\">;\n/** @internal */\nexport const legalError = namedError<LegalError>(\"LegalError\");\n\nexport type LensContentValidationError = NamedError<\"LensContentValidationError\">;\n/** @internal */\nexport const lensContentValidationError = namedError<LensContentValidationError>(\"LensContentValidationError\");\n\nexport type LensError = NamedError<\"LensError\">;\n/** @internal */\nexport const lensError = namedError<LensError>(\"LensError\");\n\nexport type CameraKitSourceError = NamedError<\"CameraKitSourceError\">;\n/** @internal */\nexport const cameraKitSourceError = namedError<CameraKitSourceError>(\"CameraKitSourceError\");\n\n/**\n * The error triggered when a lens prompts the user to select an image, but the image fails to be successfully delivered\n * to the lens.\n */\nexport type LensImagePickerError = NamedError<\"LensImagePickerError\">;\n/** @internal */\nexport const lensImagePickerError = namedError<LensImagePickerError>(\"LensImagePickerError\");\n\nexport type CacheKeyNotFoundError = NamedError<\"CacheKeyNotFoundError\">;\n/** @internal */\nexport const cacheKeyNotFoundError = namedError<CacheKeyNotFoundError>(\"CacheKeyNotFoundError\");\n\n/**\n * Thrown by {@link bootstrapCameraKit} if provided configuration is invalid.\n *\n * @category Bootstrapping and Configuration\n */\nexport type ConfigurationError = NamedError<\"ConfigurationError\">;\n/** @internal */\nexport const configurationError = namedError<ConfigurationError>(\"ConfigurationError\");\n\nexport type WebGLError = NamedError<\"WebGLError\">;\n/** @internal */\nexport const webGLError = namedError<WebGLError>(\"WebGLError\");\n\nexport type BenchmarkError = NamedError<\"BenchmarkError\">;\n/** @internal */\nexport const benchmarkError = namedError<BenchmarkError>(\"BenchmarkError\");\n\n/**\n * Thrown by {@link bootstrapCameraKit} when the current platform is not supported by CameraKit.\n *\n * This can happen if the browser doesn't support a required feature (e.g. WebGL).\n *\n * @category Bootstrapping and Configuration\n */\nexport type PlatformNotSupportedError = NamedError<\"PlatformNotSupportedError\">;\n/** @internal */\nexport const platformNotSupportedError = namedError<PlatformNotSupportedError>(\"PlatformNotSupportedError\");\n\n/**\n * This error occurs if a Lens is unable to continue rendering.\n *\n * If this error occurs, Camera Kit automatically removes the Lens from the session.\n * It's always a good idea to handle this error and update the user experience accordingly.\n * For example, you could remove the faulty Lens from your Lens selection UI.\n *\n * ```ts\n * cameraKitSession.events.addEventListener('error', ({ detail }) => {\n *   if (detail.error.name === 'LensExecutionError') {\n *     console.log(`Lens ${detail.lens.name} encountered an error and was removed. Please pick a different lens.`)\n *   }\n * })\n * ```\n */\nexport type LensExecutionError = NamedError<\"LensExecutionError\">;\n/** @internal */\nexport const lensExecutionError = namedError<LensExecutionError>(\"LensExecutionError\");\n\n/**\n * Error thrown when LensCore asked to store lens data, but CameraKit failed storing that.\n */\nexport type PersistentStoreError = NamedError<\"PersistentStoreError\">;\n/** @internal */\nexport const persistentStoreError = namedError<PersistentStoreError>(\"PersistentStoreError\");\n\n/**\n * Error thrown when LensCore asked to provide an asset, but CameraKit failed providing that.\n */\nexport type LensAssetError = NamedError<\"LensAssetError\">;\n/** @internal */\nexport const lensAssetError = namedError<LensAssetError>(\"LensAssetError\");\n\n/**\n * Thrown by {@link bootstrapCameraKit} if an error occurs during SDK initializion or while downloading the render\n * engine WebAssembly.\n *\n * @category Bootstrapping and Configuration\n */\nexport type BootstrapError = NamedError<\"BootstrapError\">;\n/** @internal */\nexport const bootstrapError = namedError<BootstrapError>(\"BootstrapError\");\n"]}
+{"version":3,"file":"namedErrors.js","sourceRoot":"","sources":["../src/namedErrors.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,yFAAyF;AAczF;;GAEG;AACH,SAAS,eAAe,CAAC,KAAa;IAClC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC9C,OAAO,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,UAAU,CAKxB,IAAW;IACT,OAAO,CAAC,OAAe,EAAE,KAAe,EAAU,EAAE;QAChD,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5C,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QAClB,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1D,4EAA4E;QAC5E,OAAO,KAAe,CAAC;IAC3B,CAAC,CAAC;AACN,CAAC;AAGD,gBAAgB;AAChB,MAAM,CAAC,MAAM,UAAU,GAAG,UAAU,CAAa,YAAY,CAAC,CAAC;AAG/D,gBAAgB;AAChB,MAAM,CAAC,MAAM,0BAA0B,GAAG,UAAU,CAA6B,4BAA4B,CAAC,CAAC;AAG/G,gBAAgB;AAChB,MAAM,CAAC,MAAM,SAAS,GAAG,UAAU,CAAY,WAAW,CAAC,CAAC;AAG5D,gBAAgB;AAChB,MAAM,CAAC,MAAM,oBAAoB,GAAG,UAAU,CAAuB,sBAAsB,CAAC,CAAC;AAO7F,gBAAgB;AAChB,MAAM,CAAC,MAAM,oBAAoB,GAAG,UAAU,CAAuB,sBAAsB,CAAC,CAAC;AAG7F,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAAG,UAAU,CAAwB,uBAAuB,CAAC,CAAC;AAQhG,gBAAgB;AAChB,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAqB,oBAAoB,CAAC,CAAC;AAGvF,gBAAgB;AAChB,MAAM,CAAC,MAAM,UAAU,GAAG,UAAU,CAAa,YAAY,CAAC,CAAC;AAG/D,gBAAgB;AAChB,MAAM,CAAC,MAAM,cAAc,GAAG,UAAU,CAAiB,gBAAgB,CAAC,CAAC;AAU3E,gBAAgB;AAChB,MAAM,CAAC,MAAM,yBAAyB,GAAG,UAAU,CAA4B,2BAA2B,CAAC,CAAC;AAkB5G,gBAAgB;AAChB,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAqB,oBAAoB,CAAC,CAAC;AAiBvF,gBAAgB;AAChB,MAAM,CAAC,MAAM,cAAc,GAAG,UAAU,CAAiB,gBAAgB,CAAC,CAAC;AAM3E,gBAAgB;AAChB,MAAM,CAAC,MAAM,oBAAoB,GAAG,UAAU,CAAuB,sBAAsB,CAAC,CAAC;AAM7F,gBAAgB;AAChB,MAAM,CAAC,MAAM,cAAc,GAAG,UAAU,CAAiB,gBAAgB,CAAC,CAAC;AAS3E,gBAAgB;AAChB,MAAM,CAAC,MAAM,cAAc,GAAG,UAAU,CAAiB,gBAAgB,CAAC,CAAC","sourcesContent":["// NOTE: All errors thrown in the CameraKit package have to be defined here.\n// Error types are not infered from error factories for API doc purposes and consistency.\n\n/**\n * Helper type to extract type generic parameter.\n */\ntype ExtractName<P> = P extends NamedError<infer T> ? T : never;\n\n/**\n * All errors are expected to have \"Error\" suffix.\n */\ntype ErrorName = `${string}Error`;\n\ntype NamedError<Name extends ErrorName> = Error & { name: Name };\n\n/**\n * Removes the top trace line from the stack.\n */\nfunction cleanErrorStack(stack: string): string {\n    const [first, _, ...rest] = stack.split(\"\\n\");\n    return [first, ...rest].join(\"\\n\");\n}\n\n/**\n * Creates error factory that ensures Error.prototype.name field value.\n *\n * NOTE: exported only for unit tests.\n *\n * @param name Error name.\n * @returns Error factory function.\n * @internal\n */\nexport function namedError<\n    // default to never to ensure the type argument is specified\n    TError extends NamedError<TName> = never,\n    // default to provided error name to make this type argument optional to reduce boilerplate\n    TName extends ErrorName = ExtractName<TError>\n>(name: TName) {\n    return (message: string, cause?: unknown): TError => {\n        const error = new Error(message, { cause });\n        error.name = name;\n        error.stack = error.stack && cleanErrorStack(error.stack);\n        // Safety: we set name above and therefore sure the type of error is correct\n        return error as TError;\n    };\n}\n\nexport type LegalError = NamedError<\"LegalError\">;\n/** @internal */\nexport const legalError = namedError<LegalError>(\"LegalError\");\n\nexport type LensContentValidationError = NamedError<\"LensContentValidationError\">;\n/** @internal */\nexport const lensContentValidationError = namedError<LensContentValidationError>(\"LensContentValidationError\");\n\nexport type LensError = NamedError<\"LensError\">;\n/** @internal */\nexport const lensError = namedError<LensError>(\"LensError\");\n\nexport type CameraKitSourceError = NamedError<\"CameraKitSourceError\">;\n/** @internal */\nexport const cameraKitSourceError = namedError<CameraKitSourceError>(\"CameraKitSourceError\");\n\n/**\n * The error triggered when a lens prompts the user to select an image, but the image fails to be successfully delivered\n * to the lens.\n */\nexport type LensImagePickerError = NamedError<\"LensImagePickerError\">;\n/** @internal */\nexport const lensImagePickerError = namedError<LensImagePickerError>(\"LensImagePickerError\");\n\nexport type CacheKeyNotFoundError = NamedError<\"CacheKeyNotFoundError\">;\n/** @internal */\nexport const cacheKeyNotFoundError = namedError<CacheKeyNotFoundError>(\"CacheKeyNotFoundError\");\n\n/**\n * Thrown by {@link bootstrapCameraKit} if provided configuration is invalid.\n *\n * @category Bootstrapping and Configuration\n */\nexport type ConfigurationError = NamedError<\"ConfigurationError\">;\n/** @internal */\nexport const configurationError = namedError<ConfigurationError>(\"ConfigurationError\");\n\nexport type WebGLError = NamedError<\"WebGLError\">;\n/** @internal */\nexport const webGLError = namedError<WebGLError>(\"WebGLError\");\n\nexport type BenchmarkError = NamedError<\"BenchmarkError\">;\n/** @internal */\nexport const benchmarkError = namedError<BenchmarkError>(\"BenchmarkError\");\n\n/**\n * Thrown by {@link bootstrapCameraKit} when the current platform is not supported by CameraKit.\n *\n * This can happen if the browser doesn't support a required feature (e.g. WebGL).\n *\n * @category Bootstrapping and Configuration\n */\nexport type PlatformNotSupportedError = NamedError<\"PlatformNotSupportedError\">;\n/** @internal */\nexport const platformNotSupportedError = namedError<PlatformNotSupportedError>(\"PlatformNotSupportedError\");\n\n/**\n * This error occurs if a Lens is unable to continue rendering.\n *\n * If this error occurs, Camera Kit automatically removes the Lens from the session.\n * It's always a good idea to handle this error and update the user experience accordingly.\n * For example, you could remove the faulty Lens from your Lens selection UI.\n *\n * ```ts\n * cameraKitSession.events.addEventListener('error', ({ detail }) => {\n *   if (detail.error.name === 'LensExecutionError') {\n *     console.log(`Lens ${detail.lens.name} encountered an error and was removed. Please pick a different lens.`)\n *   }\n * })\n * ```\n */\nexport type LensExecutionError = NamedError<\"LensExecutionError\">;\n/** @internal */\nexport const lensExecutionError = namedError<LensExecutionError>(\"LensExecutionError\");\n\n/**\n * This error occurs when a session becomes inoperable.\n *\n * It's always a good idea to handle this error and update the user experience accordingly.\n * For example, you could show a message to a user.\n *\n * ```ts\n * cameraKitSession.events.addEventListener('error', ({ detail }) => {\n *   if (detail.error.name === 'LensAbortError') {\n *     console.log(`Camera Kit encountered an unrecoverable error and became inoperable. Please refresh the page.`)\n *   }\n * })\n * ```\n */\nexport type LensAbortError = NamedError<\"LensAbortError\">;\n/** @internal */\nexport const lensAbortError = namedError<LensAbortError>(\"LensAbortError\");\n\n/**\n * Error thrown when LensCore asked to store lens data, but CameraKit failed storing that.\n */\nexport type PersistentStoreError = NamedError<\"PersistentStoreError\">;\n/** @internal */\nexport const persistentStoreError = namedError<PersistentStoreError>(\"PersistentStoreError\");\n\n/**\n * Error thrown when LensCore asked to provide an asset, but CameraKit failed providing that.\n */\nexport type LensAssetError = NamedError<\"LensAssetError\">;\n/** @internal */\nexport const lensAssetError = namedError<LensAssetError>(\"LensAssetError\");\n\n/**\n * Thrown by {@link bootstrapCameraKit} if an error occurs during SDK initializion or while downloading the render\n * engine WebAssembly.\n *\n * @category Bootstrapping and Configuration\n */\nexport type BootstrapError = NamedError<\"BootstrapError\">;\n/** @internal */\nexport const bootstrapError = namedError<BootstrapError>(\"BootstrapError\");\n"]}

package/lib/platform/assertPlatformSupported.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Throw if the current platform is not capable of running Camera Kit.
+ */
+export declare function assertPlatformSupported(): Promise<void>;

package/lib/platform/assertPlatformSupported.js

@@ -0,0 +1,15 @@
+import { __awaiter } from "tslib";
+import { getPlatformCapabilities } from "./platformCapabilities";
+/**
+ * Throw if the current platform is not capable of running Camera Kit.
+ */
+export function assertPlatformSupported() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { wasm, webgl } = yield getPlatformCapabilities();
+        if (!wasm.supported)
+            throw wasm.error;
+        if (!webgl.supported)
+            throw webgl.error;
+    });
+}
+//# sourceMappingURL=assertPlatformSupported.js.map

package/lib/platform/assertPlatformSupported.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assertPlatformSupported.js","sourceRoot":"","sources":["../../src/platform/assertPlatformSupported.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAEjE;;GAEG;AACH,MAAM,UAAgB,uBAAuB;;QACzC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,uBAAuB,EAAE,CAAC;QACxD,IAAI,CAAC,IAAI,CAAC,SAAS;YAAE,MAAM,IAAI,CAAC,KAAK,CAAC;QACtC,IAAI,CAAC,KAAK,CAAC,SAAS;YAAE,MAAM,KAAK,CAAC,KAAK,CAAC;IAC5C,CAAC;CAAA","sourcesContent":["import { getPlatformCapabilities } from \"./platformCapabilities\";\n\n/**\n * Throw if the current platform is not capable of running Camera Kit.\n */\nexport async function assertPlatformSupported(): Promise<void> {\n    const { wasm, webgl } = await getPlatformCapabilities();\n    if (!wasm.supported) throw wasm.error;\n    if (!webgl.supported) throw webgl.error;\n}\n"]}

package/lib/platform/cameraKitUserAgent.d.ts

@@ -0,0 +1,2 @@
+/** @internal */
+export declare const getCameraKitUserAgent: import("../common/memoize").Memoized<() => string>;

package/lib/platform/cameraKitUserAgent.js

@@ -0,0 +1,20 @@
+import { memoize } from "../common/memoize";
+import { getConfigurationOverrides } from "../configurationOverrides";
+import { getPlatformInfo } from "./platformInfo";
+/** @internal */
+export const getCameraKitUserAgent = memoize(function getCameraKitUserAgent() {
+    var _a;
+    const { browser, deviceModel, origin, osName, osVersion, sdkShortVersion, lensCore } = getPlatformInfo();
+    // Set this to `DEBUG` manually while testing / root-causing.
+    const { userAgentFlavor } = (_a = getConfigurationOverrides()) !== null && _a !== void 0 ? _a : { userAgentFlavor: "release" };
+    const flavor = userAgentFlavor === "release" ? "" : "DEBUG ";
+    // This full string is defined here:
+    // eslint-disable-next-line max-len
+    // https://github.sc-corp.net/Snapchat/useragent/blob/9333afe7cc6ac00503ad46cb234bcf94006dff98/java/useragent/src/main/java/snapchat/client/UserAgent.java#L124
+    return (`CameraKitWeb/${sdkShortVersion} ${flavor}(${deviceModel}; ${osName} ${osVersion}) ` +
+        `${browser.brand}/${browser.version} Core/${lensCore.version} ` +
+        // We overload appId, using the origin instead of the true appId parsed from the apiToken -- we do this because
+        // origin is human-readable, and this is used to populate the appId dimension in operational metrics.
+        `AppId/${origin}`);
+});
+//# sourceMappingURL=cameraKitUserAgent.js.map

package/lib/platform/cameraKitUserAgent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cameraKitUserAgent.js","sourceRoot":"","sources":["../../src/platform/cameraKitUserAgent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEjD,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAAG,OAAO,CAAC,SAAS,qBAAqB;;IACvE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,eAAe,EAAE,QAAQ,EAAE,GAAG,eAAe,EAAE,CAAC;IAEzG,6DAA6D;IAC7D,MAAM,EAAE,eAAe,EAAE,GAAG,MAAA,yBAAyB,EAAE,mCAAI,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC;IAC1F,MAAM,MAAM,GAAkB,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;IAE5E,oCAAoC;IACpC,mCAAmC;IACnC,+JAA+J;IAC/J,OAAO,CACH,gBAAgB,eAAe,IAAI,MAAM,IAAI,WAAW,KAAK,MAAM,IAAI,SAAS,IAAI;QACpF,GAAG,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,OAAO,SAAS,QAAQ,CAAC,OAAO,GAAG;QAC/D,+GAA+G;QAC/G,qGAAqG;QACrG,SAAS,MAAM,EAAE,CACpB,CAAC;AACN,CAAC,CAAC,CAAC","sourcesContent":["import { memoize } from \"../common/memoize\";\nimport { getConfigurationOverrides } from \"../configurationOverrides\";\nimport { getPlatformInfo } from \"./platformInfo\";\n\n/** @internal */\nexport const getCameraKitUserAgent = memoize(function getCameraKitUserAgent(): string {\n    const { browser, deviceModel, origin, osName, osVersion, sdkShortVersion, lensCore } = getPlatformInfo();\n\n    // Set this to `DEBUG` manually while testing / root-causing.\n    const { userAgentFlavor } = getConfigurationOverrides() ?? { userAgentFlavor: \"release\" };\n    const flavor: \"\" | \"DEBUG \" = userAgentFlavor === \"release\" ? \"\" : \"DEBUG \";\n\n    // This full string is defined here:\n    // eslint-disable-next-line max-len\n    // https://github.sc-corp.net/Snapchat/useragent/blob/9333afe7cc6ac00503ad46cb234bcf94006dff98/java/useragent/src/main/java/snapchat/client/UserAgent.java#L124\n    return (\n        `CameraKitWeb/${sdkShortVersion} ${flavor}(${deviceModel}; ${osName} ${osVersion}) ` +\n        `${browser.brand}/${browser.version} Core/${lensCore.version} ` +\n        // We overload appId, using the origin instead of the true appId parsed from the apiToken -- we do this because\n        // origin is human-readable, and this is used to populate the appId dimension in operational metrics.\n        `AppId/${origin}`\n    );\n});\n"]}

package/lib/platform/platformCapabilities.d.ts

@@ -0,0 +1,50 @@
+import { XrCapabilities } from "../lens-core-module";
+/** @internal */
+export type SupportedCapability<T> = T & {
+    supported: true;
+};
+/** @internal */
+export type UnsupportedCapability = {
+    supported: false;
+    error: Error;
+};
+/** @internal */
+export type Capability<T = void> = SupportedCapability<T> | UnsupportedCapability;
+type WebGlCapability = Capability<{
+    maxTextureSize: number;
+}>;
+type WasmCapability = Capability<{
+    wasmFeatures: number;
+}>;
+/**
+ * Because there may be a large number of WASM-related capabilities, and because these may correspond to various builds
+ * of LensCore, we encode the various WASM capabilities into a single number by bitwise OR-ing together the numbers
+ * corresponding to each capability.
+ *
+ * Since each combindation of capabilities is represented by a single number, we can easily map between that number and
+ * the corresponding LensCore build name that makes use of those capabilities.
+ *
+ * @internal
+ */
+export declare enum WasmFeatures {
+    Default = 0,
+    SIMD = 1,
+    ExceptionHandling = 2
+}
+type WebXrCapability = Capability<XrCapabilities>;
+/** @internal */
+export interface PlatformCapabilities {
+    webgl: WebGlCapability;
+    wasm: WasmCapability;
+    webxr: WebXrCapability;
+}
+/**
+ * Get information about the current platform capabilities, including:
+ * - WebGL support and various WebGL parameters.
+ * - WASM support and support for various WASM features.
+ * - WebXR support and support for various WebXR features.
+ *
+ * @internal
+ */
+export declare const getPlatformCapabilities: import("../common/memoize").Memoized<() => Promise<PlatformCapabilities>>;
+export {};

package/lib/platform/platformCapabilities.js

@@ -0,0 +1,121 @@
+import { __awaiter } from "tslib";
+import { exceptions, simd } from "wasm-feature-detect";
+import { memoize } from "../common/memoize";
+import { platformNotSupportedError } from "../namedErrors";
+import { getPlatformInfo } from "./platformInfo";
+// This required minimum max texture size is based on data from
+// https://web3dsurvey.com/webgl/parameters/MAX_TEXTURE_SIZE. Checking for a reasonable minimum MAX_TEXTURE_SIZE avoids
+// attempting to run lenses on platforms that will not support them -- most commonly, we've seen some platforms that
+// report 0 MAX_TEXTURE_SIZE, which will cause errors for all lenses.
+const minRequiredMaxTextureSize = 1024;
+/**
+ * @returns An object with fields describing support for various WebGL features.
+ *
+ * @internal
+ */
+function getWebGlSupport() {
+    const ctx = document.createElement("canvas").getContext("webgl2");
+    if (!ctx)
+        return {
+            supported: false,
+            error: platformNotSupportedError("CameraKit requires WebGL2, but this browser does not support WebGL2."),
+        };
+    const maxTextureSize = ctx.getParameter(ctx.MAX_TEXTURE_SIZE);
+    const supported = maxTextureSize >= minRequiredMaxTextureSize;
+    return supported
+        ? { supported, maxTextureSize }
+        : {
+            supported,
+            error: platformNotSupportedError(`CameraKit requires WebGL's MAX_TEXTURE_SIZE exceed a minimum value of ` +
+                `${minRequiredMaxTextureSize}, but the browser's reported MAX_TEXTURE_SIZE is ${maxTextureSize}.`),
+        };
+}
+/**
+ * Because there may be a large number of WASM-related capabilities, and because these may correspond to various builds
+ * of LensCore, we encode the various WASM capabilities into a single number by bitwise OR-ing together the numbers
+ * corresponding to each capability.
+ *
+ * Since each combindation of capabilities is represented by a single number, we can easily map between that number and
+ * the corresponding LensCore build name that makes use of those capabilities.
+ *
+ * @internal
+ */
+export var WasmFeatures;
+(function (WasmFeatures) {
+    WasmFeatures[WasmFeatures["Default"] = 0] = "Default";
+    WasmFeatures[WasmFeatures["SIMD"] = 1] = "SIMD";
+    WasmFeatures[WasmFeatures["ExceptionHandling"] = 2] = "ExceptionHandling";
+})(WasmFeatures || (WasmFeatures = {}));
+/**
+ * @returns A non-negative integer representing the combination of supported WebAssembly features, or -1 if WebAssembly
+ * is not supported at all.
+ *
+ * @internal
+ */
+function getWebAssemblyCapabilities() {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (globalThis.WebAssembly === undefined)
+            return {
+                supported: false,
+                error: platformNotSupportedError("CameraKit requires WebAssembly, but this browser does not support WebAssembly."),
+            };
+        return {
+            supported: true,
+            wasmFeatures: (yield Promise.all([
+                simd().then((supported) => {
+                    // Although Safari 16.4 reports SIMD support, LensCore encounters rendering bugs when using
+                    // SIMD in Safari 16.4. We will disable SIMD for now until Safari stabilizes the feature.
+                    if (getPlatformInfo().browser.brand === "Safari")
+                        return WasmFeatures.Default;
+                    return supported ? WasmFeatures.SIMD : WasmFeatures.Default;
+                }),
+                exceptions().then((supported) => (supported ? WasmFeatures.ExceptionHandling : WasmFeatures.Default)),
+            ])).reduce((features, feature) => features | feature, WasmFeatures.Default),
+        };
+    });
+}
+/**
+ * @returns A Promise containing an object with fields describing the support of various WebXR features. This object's
+ * type is defined by LensCore, as they consume these capabilities and adjust behavior accordingly.
+ *
+ * @internal
+ */
+function getWebXrCapabilities() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const notSupported = {
+            supported: false,
+            error: platformNotSupportedError(`Use of this feature requires WebXR support for immersive AR sessions, but ` +
+                `this browser does not support immersive AR sessions.`),
+        };
+        if (!isSecureContext)
+            return notSupported;
+        if (!navigator.xr)
+            return notSupported;
+        const isImmersiveArSupported = yield navigator.xr.isSessionSupported("immersive-ar");
+        return isImmersiveArSupported
+            ? {
+                supported: true,
+                sixDofSupported: true,
+                sceneDepthSupported: true,
+            }
+            : notSupported;
+    });
+}
+/**
+ * Get information about the current platform capabilities, including:
+ * - WebGL support and various WebGL parameters.
+ * - WASM support and support for various WASM features.
+ * - WebXR support and support for various WebXR features.
+ *
+ * @internal
+ */
+export const getPlatformCapabilities = memoize(function getPlatformCapabilities() {
+    return __awaiter(this, void 0, void 0, function* () {
+        return {
+            webgl: getWebGlSupport(),
+            wasm: yield getWebAssemblyCapabilities(),
+            webxr: yield getWebXrCapabilities(),
+        };
+    });
+});
+//# sourceMappingURL=platformCapabilities.js.map

package/lib/platform/platformCapabilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"platformCapabilities.js","sourceRoot":"","sources":["../../src/platform/platformCapabilities.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C,OAAO,EAAE,yBAAyB,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAejD,+DAA+D;AAC/D,uHAAuH;AACvH,oHAAoH;AACpH,qEAAqE;AACrE,MAAM,yBAAyB,GAAG,IAAI,CAAC;AAEvC;;;;GAIG;AACH,SAAS,eAAe;IACpB,MAAM,GAAG,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAClE,IAAI,CAAC,GAAG;QACJ,OAAO;YACH,SAAS,EAAE,KAAK;YAChB,KAAK,EAAE,yBAAyB,CAAC,sEAAsE,CAAC;SAC3G,CAAC;IACN,MAAM,cAAc,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAC9D,MAAM,SAAS,GAAG,cAAc,IAAI,yBAAyB,CAAC;IAC9D,OAAO,SAAS;QACZ,CAAC,CAAC,EAAE,SAAS,EAAE,cAAc,EAAE;QAC/B,CAAC,CAAC;YACI,SAAS;YACT,KAAK,EAAE,yBAAyB,CAC5B,wEAAwE;gBACpE,GAAG,yBAAyB,oDAAoD,cAAc,GAAG,CACxG;SACJ,CAAC;AACZ,CAAC;AAQD;;;;;;;;;GASG;AACH,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACpB,qDAAoB,CAAA;IACpB,+CAAiB,CAAA;IACjB,yEAA8B,CAAA;AAClC,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB;AAED;;;;;GAKG;AACH,SAAe,0BAA0B;;QACrC,IAAI,UAAU,CAAC,WAAW,KAAK,SAAS;YACpC,OAAO;gBACH,SAAS,EAAE,KAAK;gBAChB,KAAK,EAAE,yBAAyB,CAC5B,gFAAgF,CACnF;aACJ,CAAC;QACN,OAAO;YACH,SAAS,EAAE,IAAI;YACf,YAAY,EAAE,CACV,MAAM,OAAO,CAAC,GAAG,CAAC;gBACd,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE;oBACtB,2FAA2F;oBAC3F,yFAAyF;oBACzF,IAAI,eAAe,EAAE,CAAC,OAAO,CAAC,KAAK,KAAK,QAAQ;wBAAE,OAAO,YAAY,CAAC,OAAO,CAAC;oBAC9E,OAAO,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC;gBAChE,CAAC,CAAC;gBACF,UAAU,EAAE,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;aACxG,CAAC,CACL,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,CAAC,QAAQ,GAAG,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;SAC5E,CAAC;IACN,CAAC;CAAA;AAQD;;;;;GAKG;AACH,SAAe,oBAAoB;;QAC/B,MAAM,YAAY,GAAoB;YAClC,SAAS,EAAE,KAAK;YAChB,KAAK,EAAE,yBAAyB,CAC5B,4EAA4E;gBACxE,sDAAsD,CAC7D;SACJ,CAAC;QACF,IAAI,CAAC,eAAe;YAAE,OAAO,YAAY,CAAC;QAC1C,IAAI,CAAC,SAAS,CAAC,EAAE;YAAE,OAAO,YAAY,CAAC;QACvC,MAAM,sBAAsB,GAAG,MAAM,SAAS,CAAC,EAAE,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC;QACrF,OAAO,sBAAsB;YACzB,CAAC,CAAC;gBACI,SAAS,EAAE,IAAI;gBACf,eAAe,EAAE,IAAI;gBACrB,mBAAmB,EAAE,IAAI;aAC5B;YACH,CAAC,CAAC,YAAY,CAAC;IACvB,CAAC;CAAA;AASD;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,OAAO,CAAC,SAAe,uBAAuB;;QACjF,OAAO;YACH,KAAK,EAAE,eAAe,EAAE;YACxB,IAAI,EAAE,MAAM,0BAA0B,EAAE;YACxC,KAAK,EAAE,MAAM,oBAAoB,EAAE;SACtC,CAAC;IACN,CAAC;CAAA,CAAC,CAAC","sourcesContent":["import { exceptions, simd } from \"wasm-feature-detect\";\nimport { memoize } from \"../common/memoize\";\nimport { XrCapabilities } from \"../lens-core-module\";\nimport { platformNotSupportedError } from \"../namedErrors\";\nimport { getPlatformInfo } from \"./platformInfo\";\n\n/** @internal */\nexport type SupportedCapability<T> = T & { supported: true };\n/** @internal */\nexport type UnsupportedCapability = { supported: false; error: Error };\n/** @internal */\nexport type Capability<T = void> = SupportedCapability<T> | UnsupportedCapability;\n\n//-----------\n// WebGL\n//-----------\n\ntype WebGlCapability = Capability<{ maxTextureSize: number }>;\n\n// This required minimum max texture size is based on data from\n// https://web3dsurvey.com/webgl/parameters/MAX_TEXTURE_SIZE. Checking for a reasonable minimum MAX_TEXTURE_SIZE avoids\n// attempting to run lenses on platforms that will not support them -- most commonly, we've seen some platforms that\n// report 0 MAX_TEXTURE_SIZE, which will cause errors for all lenses.\nconst minRequiredMaxTextureSize = 1024;\n\n/**\n * @returns An object with fields describing support for various WebGL features.\n *\n * @internal\n */\nfunction getWebGlSupport(): WebGlCapability {\n    const ctx = document.createElement(\"canvas\").getContext(\"webgl2\");\n    if (!ctx)\n        return {\n            supported: false,\n            error: platformNotSupportedError(\"CameraKit requires WebGL2, but this browser does not support WebGL2.\"),\n        };\n    const maxTextureSize = ctx.getParameter(ctx.MAX_TEXTURE_SIZE);\n    const supported = maxTextureSize >= minRequiredMaxTextureSize;\n    return supported\n        ? { supported, maxTextureSize }\n        : {\n              supported,\n              error: platformNotSupportedError(\n                  `CameraKit requires WebGL's MAX_TEXTURE_SIZE exceed a minimum value of ` +\n                      `${minRequiredMaxTextureSize}, but the browser's reported MAX_TEXTURE_SIZE is ${maxTextureSize}.`\n              ),\n          };\n}\n\n//-----------\n// WASM\n//-----------\n\ntype WasmCapability = Capability<{ wasmFeatures: number }>;\n\n/**\n * Because there may be a large number of WASM-related capabilities, and because these may correspond to various builds\n * of LensCore, we encode the various WASM capabilities into a single number by bitwise OR-ing together the numbers\n * corresponding to each capability.\n *\n * Since each combindation of capabilities is represented by a single number, we can easily map between that number and\n * the corresponding LensCore build name that makes use of those capabilities.\n *\n * @internal\n */\nexport enum WasmFeatures {\n    Default = 0b00000000,\n    SIMD = 0b00000001,\n    ExceptionHandling = 0b00000010,\n}\n\n/**\n * @returns A non-negative integer representing the combination of supported WebAssembly features, or -1 if WebAssembly\n * is not supported at all.\n *\n * @internal\n */\nasync function getWebAssemblyCapabilities(): Promise<WasmCapability> {\n    if (globalThis.WebAssembly === undefined)\n        return {\n            supported: false,\n            error: platformNotSupportedError(\n                \"CameraKit requires WebAssembly, but this browser does not support WebAssembly.\"\n            ),\n        };\n    return {\n        supported: true,\n        wasmFeatures: (\n            await Promise.all([\n                simd().then((supported) => {\n                    // Although Safari 16.4 reports SIMD support, LensCore encounters rendering bugs when using\n                    // SIMD in Safari 16.4. We will disable SIMD for now until Safari stabilizes the feature.\n                    if (getPlatformInfo().browser.brand === \"Safari\") return WasmFeatures.Default;\n                    return supported ? WasmFeatures.SIMD : WasmFeatures.Default;\n                }),\n                exceptions().then((supported) => (supported ? WasmFeatures.ExceptionHandling : WasmFeatures.Default)),\n            ])\n        ).reduce((features, feature) => features | feature, WasmFeatures.Default),\n    };\n}\n\n//-----------\n// WebXR\n//-----------\n\ntype WebXrCapability = Capability<XrCapabilities>;\n\n/**\n * @returns A Promise containing an object with fields describing the support of various WebXR features. This object's\n * type is defined by LensCore, as they consume these capabilities and adjust behavior accordingly.\n *\n * @internal\n */\nasync function getWebXrCapabilities(): Promise<WebXrCapability> {\n    const notSupported: WebXrCapability = {\n        supported: false,\n        error: platformNotSupportedError(\n            `Use of this feature requires WebXR support for immersive AR sessions, but ` +\n                `this browser does not support immersive AR sessions.`\n        ),\n    };\n    if (!isSecureContext) return notSupported;\n    if (!navigator.xr) return notSupported;\n    const isImmersiveArSupported = await navigator.xr.isSessionSupported(\"immersive-ar\");\n    return isImmersiveArSupported\n        ? {\n              supported: true,\n              sixDofSupported: true,\n              sceneDepthSupported: true,\n          }\n        : notSupported;\n}\n\n/** @internal */\nexport interface PlatformCapabilities {\n    webgl: WebGlCapability;\n    wasm: WasmCapability;\n    webxr: WebXrCapability;\n}\n\n/**\n * Get information about the current platform capabilities, including:\n * - WebGL support and various WebGL parameters.\n * - WASM support and support for various WASM features.\n * - WebXR support and support for various WebXR features.\n *\n * @internal\n */\nexport const getPlatformCapabilities = memoize(async function getPlatformCapabilities(): Promise<PlatformCapabilities> {\n    return {\n        webgl: getWebGlSupport(),\n        wasm: await getWebAssemblyCapabilities(),\n        webxr: await getWebXrCapabilities(),\n    };\n});\n"]}

package/lib/{common/cameraKitUserAgent.d.ts → platform/platformInfo.d.ts}

@@ -17,23 +17,26 @@ declare global {
     }
 }
 /** @internal */
-export interface CameraKitUserAgent {
-    osType: string;
-    osVersion: string;
-    locale: string;
+export interface PlatformInfo {
     sdkShortVersion: string;
     sdkLongVersion: string;
-    flavor: "release" | "debug";
-    lensCoreVersion: string;
-    deviceModel: string;
+    lensCore: {
+        version: string;
+        buildNumber: string;
+        baseUrl: string;
+    };
     browser: {
         brand: string;
         version: string;
     };
+    osName: string;
+    osVersion: string;
+    deviceModel: string;
+    locale: string;
+    fullLocale: string;
     origin: string;
-    userAgent: string;
-    connectionType: ConnectionType | undefined;
+    connectionType: ConnectionType;
 }
 /** @internal */
-export declare const cameraKitUserAgent: CameraKitUserAgent;
+export declare const getPlatformInfo: import("../common/memoize").Memoized<() => PlatformInfo>;
 export {};

package/lib/{common/cameraKitUserAgent.js → platform/platformInfo.js}

@@ -1,7 +1,7 @@
+import { memoize } from "../common/memoize";
+import { isRecord } from "../common/typeguards";
 import environment from "../environment.json";
 import lensCoreWasm from "../lensCoreWasmVersions.json";
-import { locale } from "./locale";
-import { isRecord } from "./typeguards";
 /**
  * Some user agents may not properly implement the NavigatorUAData interface, so we have to do our own validation here
  * to make sure we're dealing with a well-formed value.
@@ -16,7 +16,66 @@ function isNavigatorUAData(value) {
         typeof value["platform"] === "string");
 }
 /**
- * Parse the platform (i.e. OS) version.
+ * In the future, we may invest in more robust device-detection (e.g. a UA string database), but for now this will give
+ * us some sense of device usage.
+ */
+function parseDeviceModel(userAgent) {
+    // from user agent like "(Linux; Android 11; Pixel 2)" extact "Pixel 2"
+    const userAgentWithModel = userAgent.match(/;[^;]+?;([^\)]+?)\)/);
+    if (userAgentWithModel) {
+        return userAgentWithModel[1].trim();
+    }
+    // from user agent like "... (iPad; CPU OS 15_1 like Mac OS X) ..." extract "IPad"
+    const userAgentWithModel2 = userAgent.match(/\(([^;]+);/);
+    if (userAgentWithModel2) {
+        return userAgentWithModel2[1].trim();
+    }
+    return "unknown";
+}
+/**
+ * The origin may be useful to identify the running application (e.g. to attribute metrics).
+ *
+ * We need to handle cases in which we run inside a child browsing context (e.g. an iframe), which may not have a
+ * hostname – in this case we'll check each ancestor context until we find a valid hostname.
+ */
+function parseOrigin() {
+    var _a, _b, _c;
+    if (location.hostname !== "")
+        return location.hostname;
+    // Firefox does not implement ancestorOrigins, so we need a fallback.
+    // Context here: https://github.com/whatwg/html/issues/1918
+    const possibleOrigins = location.ancestorOrigins === undefined && typeof window !== "undefined"
+        ? [window.parent.origin, (_b = (_a = window.top) === null || _a === void 0 ? void 0 : _a.origin) !== null && _b !== void 0 ? _b : ""]
+        : (_c = location.ancestorOrigins) !== null && _c !== void 0 ? _c : [];
+    for (let origin of possibleOrigins) {
+        try {
+            origin = new URL(origin).hostname;
+            if (origin)
+                return origin;
+        }
+        catch (_) { }
+    }
+    return "unknown";
+}
+function parseOSName(userAgent) {
+    const knownPlatforms = new Map([
+        ["android", "android"],
+        ["linux", "linux"],
+        ["iphone os", "ios"],
+        ["ipad", "ipados"],
+        ["mac os", "macos"],
+        ["macos", "macos"],
+        ["windows", "windows"],
+    ]);
+    const normalizedUserAgent = userAgent.toLowerCase();
+    for (const [match, platform] of knownPlatforms.entries()) {
+        if (normalizedUserAgent.includes(match))
+            return platform;
+    }
+    return "unknown";
+}
+/**
+ * Parse the OS (a.k.a. platform) version.
  *
  * From limited testing, this seems to often produce incorrect results – the userAgent string does not typically include
  * the actual OS version.
@@ -28,7 +87,7 @@ function isNavigatorUAData(value) {
  *
  * So, at least for now, we'll be satisfied with the incorrect version number.
  */
-function parsePlatformVersion(userAgent) {
+function parseOSVersion(userAgent) {
     // possible platform version values inside of user agent string
     // " 11;"
     // " 10_15_7)"
@@ -41,23 +100,6 @@ function parsePlatformVersion(userAgent) {
     }
     return "";
 }
-/**
- * In the future, we may invest in more robust device-detection (e.g. a UA string database), but for now this will give
- * us some sense of device usage.
- */
-function parseDeviceModel(userAgent) {
-    // from user agent like "(Linux; Android 11; Pixel 2)" extact "Pixel 2"
-    const userAgentWithModel = userAgent.match(/;[^;]+?;([^\)]+?)\)/);
-    if (userAgentWithModel) {
-        return userAgentWithModel[1].trim();
-    }
-    // from user agent like "... (iPad; CPU OS 15_1 like Mac OS X) ..." extract "IPad"
-    const userAgentWithModel2 = userAgent.match(/\(([^;]+);/);
-    if (userAgentWithModel2) {
-        return userAgentWithModel2[1].trim();
-    }
-    return "unknown";
-}
 /**
  * Some browsers (e.g. Safari) do not support the `Navigator.userAgentData` API. We'll attempt a sort of polyfill by
  * parsing the data found in [NavigatorUAData](https://developer.mozilla.org/en-US/docs/Web/API/NavigatorUAData) from
@@ -96,7 +138,7 @@ function parseUserAgentData(userAgent) {
     // We'll set it to false, but this should not be used – instead, we'll need to rely on more sophisticated methods
     // (e.g. a userAgent database) to determine actual device.
     const mobile = false;
-    const platform = parsePlaftformName(userAgent);
+    const platform = parseOSName(userAgent);
     return {
         brands: [brand],
         mobile,
@@ -105,6 +147,7 @@ function parseUserAgentData(userAgent) {
 }
 function normalizeBrands(brands) {
     const knownBrands = new Map([
+        ["Google Chrome", "Chrome"],
         ["Chrome", "Chrome"],
         ["Chromium", "Chrome"],
         ["Firefox", "Firefox"],
@@ -139,96 +182,47 @@ function normalizeUserAgentData(userAgentData) {
     return {
         brands: normalizeBrands(userAgentData.brands),
         mobile: userAgentData.mobile,
-        platform: parsePlaftformName(userAgentData.platform),
+        platform: parseOSName(userAgentData.platform),
     };
 }
-function parsePlaftformName(userAgent) {
-    const knownPlatforms = new Map([
-        ["android", "android"],
-        ["linux", "linux"],
-        ["iphone os", "ios"],
-        ["ipad", "ipados"],
-        ["mac os", "macos"],
-        ["macos", "macos"],
-        ["windows", "windows"],
-    ]);
-    const normalizedUserAgent = userAgent.toLowerCase();
-    for (const [match, platform] of knownPlatforms.entries()) {
-        if (normalizedUserAgent.includes(match))
-            return platform;
-    }
-    return "unknown";
-}
-/**
- * We'll use the application's origin as an identifier – this isn't used for any kind of authentication, but it may be
- * useful metadata to have in the future.
- *
- * We also need to handle cases in which the SDK is used in a child browsing context (e.g. an iframe), which may not
- * have a hostname – in this case we'll check each ancestor context until we find a valid hostname.
- */
-function parseApplicationOrigin() {
+/** @internal */
+export const getPlatformInfo = memoize(function getPlatformIno() {
     var _a, _b, _c;
-    let origin = location.hostname;
-    // Firefox does not implement ancestorOrigins, so we need a fallback.
-    // Context here: https://github.com/whatwg/html/issues/1918
-    const ancestorOrigins = location.ancestorOrigins === undefined
-        ? typeof window !== "undefined"
-            ? [window.parent.origin, (_b = (_a = window.top) === null || _a === void 0 ? void 0 : _a.origin) !== null && _b !== void 0 ? _b : ""]
-            : []
-        : Array.from((_c = location.ancestorOrigins) !== null && _c !== void 0 ? _c : []);
-    while (origin === "" && ancestorOrigins.length > 0) {
-        // Safety: ancestorOrigins must contain at least one element, so shift() will always be defined.
-        origin = new URL(ancestorOrigins.shift()).hostname;
-    }
-    return origin;
-}
-function getCameraKitUserAgent() {
-    var _a, _b;
-    const userAgent = (_a = navigator.userAgent) !== null && _a !== void 0 ? _a : "";
     // [NavigatorUAData](https://developer.mozilla.org/en-US/docs/Web/API/NavigatorUAData) is currently only
     // available on Chromium-based browsers – it's nice because it gives us clear, well-documented information. But
     // we'll have to fallback to parsing the userAgent string when it's not available.
+    const userAgent = navigator.userAgent;
     const userAgentData = isNavigatorUAData(navigator.userAgentData)
         ? normalizeUserAgentData(navigator.userAgentData)
         : parseUserAgentData(userAgent);
-    const platformVersion = parsePlatformVersion(userAgent);
+    const osVersion = parseOSVersion(userAgent);
     const deviceModel = parseDeviceModel(userAgent);
-    // In cases where we've parsed the userAgent string to find the brand, there will only ever be a single brand –
-    // in browsers which support NavigatorUAData there could be more than one (e.g. Chrome and Chromium), but they
-    // should be equivalent for our purposes.
-    const browser = userAgentData.brands[0];
-    const origin = parseApplicationOrigin();
-    const sdkLongVersion = environment.PACKAGE_VERSION;
     // Remove any `-prerelease` or `+buildmetadata` portions from the semver string.
-    const sdkShortVersion = sdkLongVersion.replace(/[-+]\S+$/, "");
-    // Set this to `debug` manually while testing / root-causing.
-    const flavor = "release";
-    // This full string is defined here:
-    // eslint-disable-next-line max-len
-    // https://github.sc-corp.net/Snapchat/useragent/blob/9333afe7cc6ac00503ad46cb234bcf94006dff98/java/useragent/src/main/java/snapchat/client/UserAgent.java#L124
-    const cameraKitUserAgent = `CameraKitWeb/${sdkShortVersion} ` +
-        `${flavor === "release" ? "" : "DEBUG"}` +
-        `(${deviceModel}; ${userAgentData.platform} ${platformVersion}) ` +
-        `${browser.brand}/${browser.version} ` +
-        `Core/${lensCoreWasm.version} ` +
-        // We overload appId, using the origin instead of the true appId parsed from the apiToken -- we do this because
-        // origin is human-readable, and this is used to populate the appId dimension in operational metrics.
-        `AppId/${origin}`;
+    const sdkShortVersion = environment.PACKAGE_VERSION.replace(/[-+]\S+$/, "");
+    const locale = navigator.language;
+    // The full locale string includes all the languages with qvalues -- this is needed for some API calls.
+    // More on qvalues: https://developer.mozilla.org/en-US/docs/Glossary/Quality_values
+    const fullLocale = ((_a = navigator.languages) !== null && _a !== void 0 ? _a : [])
+        .map((lang, index) => {
+        const qvalue = Math.max(0, (10 - index) / 10);
+        return `${lang};q=${qvalue.toFixed(1)}`;
+    })
+        .join(", ") || locale;
     return {
-        osType: userAgentData.platform,
-        osVersion: platformVersion,
-        locale,
         sdkShortVersion,
-        sdkLongVersion,
-        flavor,
-        lensCoreVersion: `${lensCoreWasm.version}`,
+        sdkLongVersion: environment.PACKAGE_VERSION,
+        lensCore: lensCoreWasm,
+        // In cases where we've parsed the userAgent string to find the brand, there will only ever be a single brand –
+        // in browsers which support NavigatorUAData there could be more than one (e.g. Chrome and Chromium), but they
+        // should be equivalent for our purposes -- either way we're okay just picking the first one.
+        browser: userAgentData.brands[0],
+        osName: userAgentData.platform,
+        osVersion,
         deviceModel,
-        browser,
-        origin,
-        userAgent: cameraKitUserAgent,
-        connectionType: (_b = navigator.connection) === null || _b === void 0 ? void 0 : _b.type,
+        locale,
+        fullLocale,
+        origin: parseOrigin(),
+        connectionType: (_c = (_b = navigator.connection) === null || _b === void 0 ? void 0 : _b.type) !== null && _c !== void 0 ? _c : "unknown",
     };
-}
-/** @internal */
-export const cameraKitUserAgent = getCameraKitUserAgent();
-//# sourceMappingURL=cameraKitUserAgent.js.map
+});
+//# sourceMappingURL=platformInfo.js.map