@snap/camera-kit 0.7.0

package/lib/extensions/LensSources.js

@@ -0,0 +1,50 @@
+import { __awaiter } from "tslib";
+import { isUndefined } from "../common/typeguards";
+import { Injectable } from "../dependency-injection/Injectable";
+/**
+ * A chain of {@link LensSource} objects to be registered in Camera Kit on bootstrap. Camera Kit evaluates all
+ * registered {@link LensSource} objects for a group ownership during Lens retrieval ({@link CameraKit.lenses}).
+ * And if a source claims the ownership, its {@link LensSource.getLens} or {@link LensSource.getLensGroup}
+ * methods are called.
+ */
+export class LensSources {
+    /**
+     * Creates an instance of Lens sources.
+     * @param fallbackSources A fallback sources if given {@link LensSource} doesn't claim a group ownership.
+     * @param source Lens source.
+     */
+    constructor(fallbackSources, source) {
+        this.fallbackSources = fallbackSources;
+        this.source = source;
+    }
+    /**
+     * Returns empty LensSources instance.
+     * @internal
+     */
+    static empty() {
+        // NOTE: we want to keep LensSources constructor to require arguments
+        // but internally we don't need them for the base case
+        // @ts-expect-error
+        return new LensSources();
+    }
+    /**
+     * Returns envelopes of lens/groups taking into account group ownership.
+     * @internal
+     * @param groupId A group to test ownership and get lens envelopes of.
+     * @param lensId An optional lens ID to narrow envelopes down to a single lens.
+     * @returns Envelopes or undefined if not applicable.
+     */
+    retrieveLenses({ groupId, lensId }) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            if ((_a = this.source) === null || _a === void 0 ? void 0 : _a.isGroupOwner(groupId)) {
+                return isUndefined(lensId)
+                    ? this.source.getLensGroup(groupId)
+                    : this.source.getLens(lensId, groupId).then((envelope) => [envelope]);
+            }
+            return (_b = this.fallbackSources) === null || _b === void 0 ? void 0 : _b.retrieveLenses({ groupId, lensId });
+        });
+    }
+}
+export const lensSourcesFactory = Injectable("lensSources", () => LensSources.empty());
+//# sourceMappingURL=LensSources.js.map

package/lib/extensions/LensSources.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LensSources.js","sourceRoot":"","sources":["../../src/extensions/LensSources.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AA0BhE;;;;;GAKG;AACH,MAAM,OAAO,WAAW;IAIpB;;;;OAIG;IACH,YAAY,eAA4B,EAAE,MAAkB;QACxD,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,KAAK;QACR,qEAAqE;QACrE,sDAAsD;QACtD,mBAAmB;QACnB,OAAO,IAAI,WAAW,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACG,cAAc,CAAC,EAAE,OAAO,EAAE,MAAM,EAAwC;;;YAC1E,IAAI,MAAA,IAAI,CAAC,MAAM,0CAAE,YAAY,CAAC,OAAO,CAAC,EAAE;gBACpC,OAAO,WAAW,CAAC,MAAM,CAAC;oBACtB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC;oBACnC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;aAC7E;YACD,OAAO,MAAA,IAAI,CAAC,eAAe,0CAAE,cAAc,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;;KACpE;CACJ;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAC,aAAa,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC,CAAC","sourcesContent":["import { isUndefined } from \"../common/typeguards\";\nimport { Injectable } from \"../dependency-injection/Injectable\";\n\n/**\n * A source of a lens group.\n */\nexport interface LensSource {\n    /**\n     * Whether the given source is able to load lenses of the supplied group.\n     * @param groupId Group ID to check.\n     */\n    isGroupOwner(groupId: string): boolean;\n\n    /**\n     * Returns an encoded lens object.\n     * @param lensId Lens ID to get.\n     * @param groupId Group ID the lens belongs to.\n     */\n    getLens(lensId: string, groupId: string): Promise<ArrayBuffer>;\n\n    /**\n     * Returns encoded lens objects.\n     * @param groupId Group ID to get lenses of.\n     */\n    getLensGroup(groupId: string): Promise<ArrayBuffer[]>;\n}\n\n/**\n * A chain of {@link LensSource} objects to be registered in Camera Kit on bootstrap. Camera Kit evaluates all\n * registered {@link LensSource} objects for a group ownership during Lens retrieval ({@link CameraKit.lenses}).\n * And if a source claims the ownership, its {@link LensSource.getLens} or {@link LensSource.getLensGroup}\n * methods are called.\n */\nexport class LensSources {\n    private readonly fallbackSources: LensSources | undefined;\n    private readonly source: LensSource | undefined;\n\n    /**\n     * Creates an instance of Lens sources.\n     * @param fallbackSources A fallback sources if given {@link LensSource} doesn't claim a group ownership.\n     * @param source Lens source.\n     */\n    constructor(fallbackSources: LensSources, source: LensSource) {\n        this.fallbackSources = fallbackSources;\n        this.source = source;\n    }\n\n    /**\n     * Returns empty LensSources instance.\n     * @internal\n     */\n    static empty() {\n        // NOTE: we want to keep LensSources constructor to require arguments\n        // but internally we don't need them for the base case\n        // @ts-expect-error\n        return new LensSources();\n    }\n\n    /**\n     * Returns envelopes of lens/groups taking into account group ownership.\n     * @internal\n     * @param groupId A group to test ownership and get lens envelopes of.\n     * @param lensId An optional lens ID to narrow envelopes down to a single lens.\n     * @returns Envelopes or undefined if not applicable.\n     */\n    async retrieveLenses({ groupId, lensId }: { groupId: string; lensId?: string }): Promise<ArrayBuffer[] | void> {\n        if (this.source?.isGroupOwner(groupId)) {\n            return isUndefined(lensId)\n                ? this.source.getLensGroup(groupId)\n                : this.source.getLens(lensId, groupId).then((envelope) => [envelope]);\n        }\n        return this.fallbackSources?.retrieveLenses({ groupId, lensId });\n    }\n}\n\nexport const lensSourcesFactory = Injectable(\"lensSources\", () => LensSources.empty());\n"]}

package/lib/extensions/UriHandlers.d.ts

@@ -0,0 +1,54 @@
+import { LensCoreModule, Uri, UriCancelRequest, UriRequest, UriResponse } from "../lens-core-module/generated-types";
+import { Lens } from "../lens/Lens";
+import { LensKeyboard } from "../session/LensKeyboard";
+/**
+ * Provides a way for a lens to call into external services that work under HTTP-like protocol.
+ */
+export interface UriHandler {
+    /**
+     * [scheme]://[route] pattern that this handler processes or an array of patterns.
+     */
+    uri: Uri | Uri[];
+    /**
+     * Called to process the provided request.
+     * @param request Lens request.
+     * @param reply A callback function to send response back.
+     * The function can be called none or multiple number of times.
+     * @param lens Lens the request is coming from.
+     */
+    handleRequest(request: UriRequest, reply: (response: UriResponse) => void, lens: Lens): void;
+    /**
+     * Called to indicated that URI request initated earlier is cancelled.
+     * @param request Lens request.
+     * @param lens Lens the request is coming from.
+     */
+    cancelRequest?(request: UriCancelRequest, lens: Lens): void;
+}
+/**
+ * Array of {@link UriHandler} objects.
+ */
+export declare type UriHandlers = UriHandler[];
+/**
+ * An extension point for client URI handlers.
+ */
+export declare const uriHandlersFactory: {
+    (): UriHandlers;
+    token: "UriHandlers";
+    dependencies: [];
+};
+/**
+ * Registers URI handlers within LensCore.
+ * @internal
+ */
+export declare const registerUriHandlers: {
+    (args_0: LensCoreModule, args_1: import("@snap/state-management").StateMachine<import("@snap/state-management").Action<"applyLens", {
+        lens: Lens;
+        launchParams?: import("..").LensLaunchParams | undefined;
+    }> | import("@snap/state-management").Action<"downloadComplete", Lens> | import("@snap/state-management").Action<"turnedOn", Lens> | import("@snap/state-management").Action<"resourcesLoaded", Lens> | import("@snap/state-management").Action<"firstFrameProcessed", Lens> | import("@snap/state-management").Action<"applyLensComplete", Lens> | import("@snap/state-management").Action<"applyLensFailed", {
+        error: import("../session/lensState").LensErrors;
+        lens: Lens;
+    }> | import("@snap/state-management").Action<"removeLens", undefined> | import("@snap/state-management").Action<"turnedOff", Lens> | import("@snap/state-management").Action<"removeLensComplete", undefined> | import("@snap/state-management").Action<"removeLensFailed", Error>, import("@snap/state-management").State<"noLensApplied", undefined> | import("@snap/state-management").State<"applyingLens", Lens> | import("@snap/state-management").State<"lensApplied", Lens>>, args_2: UriHandlers, args_3: LensKeyboard): void;
+    token: "registerUriHandlers";
+    dependencies: readonly ["lensCore", "lensState", "UriHandlers", "lensKeyboard"];
+};
+export { Uri, UriCancelRequest, UriRequest, UriResponse } from "../lens-core-module/generated-types";

package/lib/extensions/UriHandlers.js

@@ -0,0 +1,93 @@
+import { isState } from "@snap/state-management";
+import { isArrayBuffer, isArrayOfType, isFunction, isNumber, isRecord, isString, isTypedArray, isUndefined, predicateRecordValues, } from "../common/typeguards";
+import { Injectable } from "../dependency-injection/Injectable";
+import { lensCoreFactory } from "../lens-core-module";
+import { getLogger } from "../logger/logger";
+import { lensKeyboardFactory } from "../session/LensKeyboard";
+import { lensStateFactory } from "../session/lensState";
+const logger = getLogger("UriHandlers");
+const SEPARATOR = "://";
+function extractSchemeAndRoute(uri) {
+    const separatorIndex = uri.indexOf(SEPARATOR);
+    const scheme = uri.slice(0, separatorIndex);
+    const route = uri.slice(separatorIndex + SEPARATOR.length);
+    return [scheme, route];
+}
+function isUri(value) {
+    return isString(value) && value.includes(SEPARATOR);
+}
+function isUriHandler(value) {
+    return (isRecord(value) &&
+        (isUri(value.uri) || isArrayOfType(isUri, value.uri)) &&
+        isFunction(value.handleRequest) &&
+        (isUndefined(value.cancelRequest) || isFunction(value.cancelRequest)));
+}
+function isUriHandlers(value) {
+    return isArrayOfType(isUriHandler, value);
+}
+function isUriResponse(value) {
+    return (isRecord(value) &&
+        isNumber(value.code) &&
+        isString(value.description) &&
+        isString(value.contentType) &&
+        (isArrayBuffer(value.data) || isTypedArray(value.data)) &&
+        (isUndefined(value.metadata) || predicateRecordValues(isString)(value.metadata)));
+}
+/**
+ * An extension point for client URI handlers.
+ */
+export const uriHandlersFactory = Injectable("UriHandlers", () => {
+    const uriHandlers = [];
+    return uriHandlers;
+});
+/**
+ * Registers URI handlers within LensCore.
+ * @internal
+ */
+export const registerUriHandlers = Injectable("registerUriHandlers", [lensCoreFactory.token, lensStateFactory.token, uriHandlersFactory.token, lensKeyboardFactory.token], (lensCore, lensState, userHandlers, lensKeyboard) => {
+    if (!isUriHandlers(userHandlers)) {
+        throw new Error("Expected an array of UriHandler objects");
+    }
+    // Users may define UriHandlers using the uriHandlersFactory.token, but we need to add some internally-defined
+    // handlers (e.g. lens keyboard handler) before registering handlers with LensCore.
+    const allHandlers = userHandlers.concat(lensKeyboard.uriHandler);
+    for (const { uri, handleRequest, cancelRequest } of allHandlers) {
+        const uris = Array.isArray(uri) ? uri : [uri];
+        for (const [scheme, route] of uris.map(extractSchemeAndRoute)) {
+            lensCore.registerUriListener(scheme, route, {
+                handleRequest: (request) => {
+                    const reply = (response) => {
+                        if (!isUriResponse(response)) {
+                            throw new Error("Expected UriResponse object");
+                        }
+                        lensCore.provideUriResponse(request.identifier, response);
+                    };
+                    // Since lenses are the only things that make URI requests, we expect to always be in the
+                    // "lensApplied" state – we'll sanity check, though, and log a warning if we're not.
+                    const state = lensState.getState();
+                    if (isState(state, "noLensApplied")) {
+                        logger.warn(`Got a URI request for ${request.uri}, but there is no active lens. The ` +
+                            `request will not be processed.`);
+                        return;
+                    }
+                    // NOTE: we do not handle any error thrown on an extension side when handleRequest() is called.
+                    // That responsibility is delegated to the extension by design and that is exactly what Android
+                    // and iOS SDKs do.
+                    handleRequest(request, reply, state.data);
+                },
+                cancelRequest: (request) => {
+                    if (cancelRequest) {
+                        const state = lensState.getState();
+                        if (isState(state, "noLensApplied")) {
+                            logger.warn(`Got a URI cancel request for ${request.uri}, but there is no active ` +
+                                `lens. The cancel request will not be processed.`);
+                            return;
+                        }
+                        cancelRequest(request, state.data);
+                    }
+                },
+            });
+        }
+    }
+});
+//# sourceMappingURL=UriHandlers.js.map

package/lib/extensions/UriHandlers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UriHandlers.js","sourceRoot":"","sources":["../../src/extensions/UriHandlers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EACH,aAAa,EACb,aAAa,EACb,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,YAAY,EACZ,WAAW,EACX,qBAAqB,GACxB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAGtD,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAgB,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC5E,OAAO,EAAa,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAEnE,MAAM,MAAM,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;AAExC,MAAM,SAAS,GAAG,KAAK,CAAC;AAExB,SAAS,qBAAqB,CAAC,GAAQ;IACnC,MAAM,cAAc,GAAG,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC9C,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;IAC5C,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,cAAc,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IAC3D,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAC3B,CAAC;AAED,SAAS,KAAK,CAAC,KAAc;IACzB,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;AACxD,CAAC;AAED,SAAS,YAAY,CAAC,KAAc;IAChC,OAAO,CACH,QAAQ,CAAC,KAAK,CAAC;QACf,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;QACrD,UAAU,CAAC,KAAK,CAAC,aAAa,CAAC;QAC/B,CAAC,WAAW,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CACxE,CAAC;AACN,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACjC,OAAO,aAAa,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;AAC9C,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACjC,OAAO,CACH,QAAQ,CAAC,KAAK,CAAC;QACf,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;QACpB,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC;QAC3B,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC;QAC3B,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvD,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,qBAAqB,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CACnF,CAAC;AACN,CAAC;AAiCD;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAC,aAAa,EAAE,GAAG,EAAE;IAC7D,MAAM,WAAW,GAAgB,EAAE,CAAC;IACpC,OAAO,WAAW,CAAC;AACvB,CAAC,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,UAAU,CACzC,qBAAqB,EACrB,CAAC,eAAe,CAAC,KAAK,EAAE,gBAAgB,CAAC,KAAK,EAAE,kBAAkB,CAAC,KAAK,EAAE,mBAAmB,CAAC,KAAK,CAAU,EAC7G,CAAC,QAAwB,EAAE,SAAoB,EAAE,YAAyB,EAAE,YAA0B,EAAQ,EAAE;IAC5G,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE;QAC9B,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;KAC9D;IAED,8GAA8G;IAC9G,mFAAmF;IACnF,MAAM,WAAW,GAAG,YAAY,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IAEjE,KAAK,MAAM,EAAE,GAAG,EAAE,aAAa,EAAE,aAAa,EAAE,IAAI,WAAW,EAAE;QAC7D,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAC9C,KAAK,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,qBAAqB,CAAC,EAAE;YAC3D,QAAQ,CAAC,mBAAmB,CAAC,MAAM,EAAE,KAAK,EAAE;gBACxC,aAAa,EAAE,CAAC,OAAO,EAAE,EAAE;oBACvB,MAAM,KAAK,GAAG,CAAC,QAAqB,EAAE,EAAE;wBACpC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE;4BAC1B,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;yBAClD;wBACD,QAAQ,CAAC,kBAAkB,CAAC,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;oBAC9D,CAAC,CAAC;oBAEF,yFAAyF;oBACzF,oFAAoF;oBACpF,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC;oBACnC,IAAI,OAAO,CAAC,KAAK,EAAE,eAAe,CAAC,EAAE;wBACjC,MAAM,CAAC,IAAI,CACP,yBAAyB,OAAO,CAAC,GAAG,qCAAqC;4BACrE,gCAAgC,CACvC,CAAC;wBACF,OAAO;qBACV;oBAED,+FAA+F;oBAC/F,+FAA+F;oBAC/F,mBAAmB;oBACnB,aAAa,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC9C,CAAC;gBACD,aAAa,EAAE,CAAC,OAAO,EAAE,EAAE;oBACvB,IAAI,aAAa,EAAE;wBACf,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC;wBACnC,IAAI,OAAO,CAAC,KAAK,EAAE,eAAe,CAAC,EAAE;4BACjC,MAAM,CAAC,IAAI,CACP,gCAAgC,OAAO,CAAC,GAAG,2BAA2B;gCAClE,iDAAiD,CACxD,CAAC;4BACF,OAAO;yBACV;wBACD,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;qBACtC;gBACL,CAAC;aACJ,CAAC,CAAC;SACN;KACJ;AACL,CAAC,CACJ,CAAC","sourcesContent":["import { isState } from \"@snap/state-management\";\nimport {\n    isArrayBuffer,\n    isArrayOfType,\n    isFunction,\n    isNumber,\n    isRecord,\n    isString,\n    isTypedArray,\n    isUndefined,\n    predicateRecordValues,\n} from \"../common/typeguards\";\nimport { Injectable } from \"../dependency-injection/Injectable\";\nimport { lensCoreFactory } from \"../lens-core-module\";\nimport { LensCoreModule, Uri, UriCancelRequest, UriRequest, UriResponse } from \"../lens-core-module/generated-types\";\nimport { Lens } from \"../lens/Lens\";\nimport { getLogger } from \"../logger/logger\";\nimport { LensKeyboard, lensKeyboardFactory } from \"../session/LensKeyboard\";\nimport { LensState, lensStateFactory } from \"../session/lensState\";\n\nconst logger = getLogger(\"UriHandlers\");\n\nconst SEPARATOR = \"://\";\n\nfunction extractSchemeAndRoute(uri: Uri) {\n    const separatorIndex = uri.indexOf(SEPARATOR);\n    const scheme = uri.slice(0, separatorIndex);\n    const route = uri.slice(separatorIndex + SEPARATOR.length);\n    return [scheme, route];\n}\n\nfunction isUri(value: unknown): value is Uri {\n    return isString(value) && value.includes(SEPARATOR);\n}\n\nfunction isUriHandler(value: unknown): value is UriHandler {\n    return (\n        isRecord(value) &&\n        (isUri(value.uri) || isArrayOfType(isUri, value.uri)) &&\n        isFunction(value.handleRequest) &&\n        (isUndefined(value.cancelRequest) || isFunction(value.cancelRequest))\n    );\n}\n\nfunction isUriHandlers(value: unknown): value is UriHandlers {\n    return isArrayOfType(isUriHandler, value);\n}\n\nfunction isUriResponse(value: unknown): value is UriResponse {\n    return (\n        isRecord(value) &&\n        isNumber(value.code) &&\n        isString(value.description) &&\n        isString(value.contentType) &&\n        (isArrayBuffer(value.data) || isTypedArray(value.data)) &&\n        (isUndefined(value.metadata) || predicateRecordValues(isString)(value.metadata))\n    );\n}\n\n/**\n * Provides a way for a lens to call into external services that work under HTTP-like protocol.\n */\nexport interface UriHandler {\n    /**\n     * [scheme]://[route] pattern that this handler processes or an array of patterns.\n     */\n    uri: Uri | Uri[];\n\n    /**\n     * Called to process the provided request.\n     * @param request Lens request.\n     * @param reply A callback function to send response back.\n     * The function can be called none or multiple number of times.\n     * @param lens Lens the request is coming from.\n     */\n    handleRequest(request: UriRequest, reply: (response: UriResponse) => void, lens: Lens): void;\n\n    /**\n     * Called to indicated that URI request initated earlier is cancelled.\n     * @param request Lens request.\n     * @param lens Lens the request is coming from.\n     */\n    cancelRequest?(request: UriCancelRequest, lens: Lens): void;\n}\n\n/**\n * Array of {@link UriHandler} objects.\n */\nexport type UriHandlers = UriHandler[];\n\n/**\n * An extension point for client URI handlers.\n */\nexport const uriHandlersFactory = Injectable(\"UriHandlers\", () => {\n    const uriHandlers: UriHandlers = [];\n    return uriHandlers;\n});\n\n/**\n * Registers URI handlers within LensCore.\n * @internal\n */\nexport const registerUriHandlers = Injectable(\n    \"registerUriHandlers\",\n    [lensCoreFactory.token, lensStateFactory.token, uriHandlersFactory.token, lensKeyboardFactory.token] as const,\n    (lensCore: LensCoreModule, lensState: LensState, userHandlers: UriHandlers, lensKeyboard: LensKeyboard): void => {\n        if (!isUriHandlers(userHandlers)) {\n            throw new Error(\"Expected an array of UriHandler objects\");\n        }\n\n        // Users may define UriHandlers using the uriHandlersFactory.token, but we need to add some internally-defined\n        // handlers (e.g. lens keyboard handler) before registering handlers with LensCore.\n        const allHandlers = userHandlers.concat(lensKeyboard.uriHandler);\n\n        for (const { uri, handleRequest, cancelRequest } of allHandlers) {\n            const uris = Array.isArray(uri) ? uri : [uri];\n            for (const [scheme, route] of uris.map(extractSchemeAndRoute)) {\n                lensCore.registerUriListener(scheme, route, {\n                    handleRequest: (request) => {\n                        const reply = (response: UriResponse) => {\n                            if (!isUriResponse(response)) {\n                                throw new Error(\"Expected UriResponse object\");\n                            }\n                            lensCore.provideUriResponse(request.identifier, response);\n                        };\n\n                        // Since lenses are the only things that make URI requests, we expect to always be in the\n                        // \"lensApplied\" state – we'll sanity check, though, and log a warning if we're not.\n                        const state = lensState.getState();\n                        if (isState(state, \"noLensApplied\")) {\n                            logger.warn(\n                                `Got a URI request for ${request.uri}, but there is no active lens. The ` +\n                                    `request will not be processed.`\n                            );\n                            return;\n                        }\n\n                        // NOTE: we do not handle any error thrown on an extension side when handleRequest() is called.\n                        // That responsibility is delegated to the extension by design and that is exactly what Android\n                        // and iOS SDKs do.\n                        handleRequest(request, reply, state.data);\n                    },\n                    cancelRequest: (request) => {\n                        if (cancelRequest) {\n                            const state = lensState.getState();\n                            if (isState(state, \"noLensApplied\")) {\n                                logger.warn(\n                                    `Got a URI cancel request for ${request.uri}, but there is no active ` +\n                                        `lens. The cancel request will not be processed.`\n                                );\n                                return;\n                            }\n                            cancelRequest(request, state.data);\n                        }\n                    },\n                });\n            }\n        }\n    }\n);\n\nexport { Uri, UriCancelRequest, UriRequest, UriResponse } from \"../lens-core-module/generated-types\";\n"]}

package/lib/extensions/extensionRequestContext.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Extension request context.
+ */
+export declare const extensionRequestContext: ArrayBuffer;

package/lib/extensions/extensionRequestContext.js

@@ -0,0 +1,14 @@
+import { cameraKitUserAgent } from "../common/cameraKitUserAgent";
+import { fullLocale } from "../common/locale";
+import { ExtensionRequestContext } from "../generated-proto/pb_schema/camera_kit/v3/export";
+function getExtensionRequestContext() {
+    return ExtensionRequestContext.encode({
+        userAgent: cameraKitUserAgent.userAgent,
+        locale: fullLocale,
+    }).finish();
+}
+/**
+ * Extension request context.
+ */
+export const extensionRequestContext = getExtensionRequestContext();
+//# sourceMappingURL=extensionRequestContext.js.map

package/lib/extensions/extensionRequestContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extensionRequestContext.js","sourceRoot":"","sources":["../../src/extensions/extensionRequestContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,uBAAuB,EAAE,MAAM,mDAAmD,CAAC;AAE5F,SAAS,0BAA0B;IAC/B,OAAO,uBAAuB,CAAC,MAAM,CAAC;QAClC,SAAS,EAAE,kBAAkB,CAAC,SAAS;QACvC,MAAM,EAAE,UAAU;KACrB,CAAC,CAAC,MAAM,EAAE,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,0BAA0B,EAAE,CAAC","sourcesContent":["import { cameraKitUserAgent } from \"../common/cameraKitUserAgent\";\nimport { fullLocale } from \"../common/locale\";\nimport { ExtensionRequestContext } from \"../generated-proto/pb_schema/camera_kit/v3/export\";\n\nfunction getExtensionRequestContext(): ArrayBuffer {\n    return ExtensionRequestContext.encode({\n        userAgent: cameraKitUserAgent.userAgent,\n        locale: fullLocale,\n    }).finish();\n}\n\n/**\n * Extension request context.\n */\nexport const extensionRequestContext = getExtensionRequestContext();\n"]}