@snap/camera-kit 1.0.1 → 1.2.0

package/dist/uri-handlers/internal-handlers/httpUriHandler.d.ts

@@ -0,0 +1,42 @@
+import type { RemoteApiSpecsClient } from "../../clients/remoteApiSpecsClient";
+import type { Lens } from "../../lens/Lens";
+import type { LensState } from "../../session/lensState";
+import type { SessionState } from "../../session/sessionState";
+import type { LensHttpHandler } from "../../configuration";
+import type { UriHandler, UriRequest, UriResponse } from "../UriHandlers";
+import type { RemoteApiSpec } from "../../generated-proto/pb_schema/camera_kit/v3/remote_api_spec";
+/**
+ *
+ * @internal
+ *
+ * @param lensState
+ * @param sessionState
+ * @param remoteApiSpecsClient
+ * @param clientLentHttpRequestHandler
+ * @returns
+ */
+export declare function createHttpUriHandler(lensState: LensState, sessionState: SessionState, remoteApiSpecsClient: RemoteApiSpecsClient, customLentFetchHandler: LensHttpHandler | undefined): UriHandler;
+/**
+ *
+ * @internal
+ *
+ * @param request
+ * @param lens
+ * @param reply
+ * @param setCancellationHandler
+ * @param allowlist
+ * @param clientLensHttpRequestHandler
+ */
+export declare function handleHttpUriRequest(request: UriRequest, lens: Lens, reply: (response: UriResponse) => void, setCancellationHandler: (fn: () => void) => void, allowlist: RemoteApiSpec[], customLensHttpHandler: LensHttpHandler | undefined): Promise<void>;
+/**
+ * @internal
+ */
+export declare function mapLensToFetchRequest({ uri, method, metadata, data }: UriRequest): {
+    url: string;
+    init: RequestInit;
+};
+/**
+ * @internal
+ */
+export declare function mapFetchToLensResponse(response: Response): Promise<UriResponse>;
+//# sourceMappingURL=httpUriHandler.d.ts.map

package/dist/uri-handlers/internal-handlers/httpUriHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpUriHandler.d.ts","sourceRoot":"","sources":["../../../src/uri-handlers/internal-handlers/httpUriHandler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC/E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE/D,OAAO,KAAK,EAAmC,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC5F,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE1E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+DAA+D,CAAC;AA2BnG;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAChC,SAAS,EAAE,SAAS,EACpB,YAAY,EAAE,YAAY,EAC1B,oBAAoB,EAAE,oBAAoB,EAC1C,sBAAsB,EAAE,eAAe,GAAG,SAAS,GACpD,UAAU,CAmBZ;AAQD;;;;;;;;;;GAUG;AACH,wBAAsB,oBAAoB,CACtC,OAAO,EAAE,UAAU,EACnB,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,CAAC,QAAQ,EAAE,WAAW,KAAK,IAAI,EACtC,sBAAsB,EAAE,CAAC,EAAE,EAAE,MAAM,IAAI,KAAK,IAAI,EAChD,SAAS,EAAE,aAAa,EAAE,EAC1B,qBAAqB,EAAE,eAAe,GAAG,SAAS,iBAgFrD;AAcD;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,UAAU,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,WAAW,CAAA;CAAE,CAcrH;AAED;;GAEG;AACH,wBAAsB,sBAAsB,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,CAmBrF"}

package/dist/uri-handlers/internal-handlers/httpUriHandler.js

@@ -0,0 +1,149 @@
+import { __awaiter } from "tslib";
+import { getLogger } from "../../logger/logger";
+import { namedError } from "../../namedErrors";
+import { createUriRequestProcessor } from "../uriRequestProcessor";
+import { isPromise } from "../../common/typeguards";
+import { requestValidationErrorName, validateRequest } from "./httpValidators";
+const logger = getLogger("lensHttpHandler");
+const lensHttpHandlerErrorName = "LensHttpHandlerError";
+const lensHttpHandlerError = namedError(lensHttpHandlerErrorName);
+const allowedResponseHeaders = [
+    "Accept-Ranges",
+    "Cache-Control",
+    "Content-Language",
+    "Content-Length",
+    "Content-Type",
+    "Date",
+    "ETag",
+    "Expires",
+    "Last-Modified",
+    "Location",
+];
+const requestHeadersToExclude = ["x-sc-lenses-remote-api-spec-id"];
+export function createHttpUriHandler(lensState, sessionState, remoteApiSpecsClient, customLentFetchHandler) {
+    let allowlistPromise = undefined;
+    return createUriRequestProcessor({
+        uri: ["http://", "https://"],
+        lensState,
+        sessionState,
+        processRequest({ request, lens, reply, setCancellationHandler }) {
+            return __awaiter(this, void 0, void 0, function* () {
+                allowlistPromise = allowlistPromise !== null && allowlistPromise !== void 0 ? allowlistPromise : getAllowlist(remoteApiSpecsClient);
+                const allowlist = yield allowlistPromise;
+                handleHttpUriRequest(request, lens, reply, setCancellationHandler, allowlist, customLentFetchHandler);
+            });
+        },
+        processInternalError(error) {
+            logger.error(error);
+        },
+    });
+}
+function getAllowlist(remoteApiSpecsClient) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        const result = yield remoteApiSpecsClient.getRemoteApiSpecs({});
+        if (!result.ok)
+            throw new Error("Failed getting Remote API specs.", { cause: result.unwrapErr() });
+        return (_b = (_a = result.unwrap().message) === null || _a === void 0 ? void 0 : _a.remoteApiSpecs) !== null && _b !== void 0 ? _b : [];
+    });
+}
+export function handleHttpUriRequest(request, lens, reply, setCancellationHandler, allowlist, customLensHttpHandler) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            validateRequest(request, allowlist);
+            const { url, init } = mapLensToFetchRequest(request);
+            const abortController = new AbortController();
+            init.signal = abortController.signal;
+            setCancellationHandler(() => abortController.abort());
+            let response;
+            if (customLensHttpHandler) {
+                const handlerName = "lensHttpHandler";
+                try {
+                    const { uri, identifier, method, metadata, data } = request;
+                    const responsePromise = customLensHttpHandler(url, init, {
+                        url: uri,
+                        identifier,
+                        method,
+                        data,
+                        headers: metadata,
+                        lens,
+                    });
+                    if (!isPromise(responsePromise)) {
+                        throw lensHttpHandlerError(`The '${handlerName}' callback provided to Camera Kit must return a Promise.`);
+                    }
+                    response = yield responsePromise;
+                }
+                catch (error) {
+                    error =
+                        error instanceof Error && error.name === lensHttpHandlerErrorName
+                            ? error
+                            : lensHttpHandlerError(`The '${handlerName}' callback provided to Camera Kit configuration failed.`, error);
+                    throw error;
+                }
+            }
+            else {
+                response = yield fetch(url, init);
+            }
+            reply(yield mapFetchToLensResponse(response));
+        }
+        catch (error) {
+            if (error instanceof Error && error.name === lensHttpHandlerErrorName) {
+                logger.warn(error);
+                reply(getErrorResponse("LensHttpHandlerError", `The lens HTTP request handler provided to Camera Kit failed.`));
+            }
+            else if (error instanceof Error && error.name === requestValidationErrorName) {
+                logger.warn(error);
+                reply(getErrorResponse("RequestValidationError", error.message));
+            }
+            else {
+                logger.error(error);
+                reply(getErrorResponse("UnknownError", "An unknown error occurred."));
+            }
+        }
+    });
+}
+function getErrorResponse(errorType, message) {
+    return {
+        code: 400,
+        description: "",
+        contentType: "text/plain",
+        metadata: {
+            "x-camera-kit-error-type": errorType,
+        },
+        data: new TextEncoder().encode(message),
+    };
+}
+export function mapLensToFetchRequest({ uri, method, metadata, data }) {
+    const headers = new Headers(metadata);
+    for (const header of requestHeadersToExclude) {
+        headers.delete(header);
+    }
+    return {
+        url: uri,
+        init: {
+            headers: Object.fromEntries(headers.entries()),
+            body: method !== "GET" && method !== "HEAD" && method !== undefined ? data : undefined,
+            method,
+        },
+    };
+}
+export function mapFetchToLensResponse(response) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const metadata = {};
+        for (const allowedHeader of allowedResponseHeaders) {
+            const value = response.headers.get(allowedHeader);
+            if (value) {
+                metadata[allowedHeader.toLowerCase()] = value;
+            }
+        }
+        return {
+            code: response.status,
+            description: "",
+            contentType: ((_a = response.headers.get("Content-Type")) !== null && _a !== void 0 ? _a : ""),
+            metadata,
+            data: yield response.arrayBuffer(),
+        };
+    });
+}
+//# sourceMappingURL=httpUriHandler.js.map

package/dist/uri-handlers/internal-handlers/httpUriHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpUriHandler.js","sourceRoot":"","sources":["../../../src/uri-handlers/internal-handlers/httpUriHandler.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEhD,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAG/C,OAAO,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAEnE,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEpD,OAAO,EAAE,0BAA0B,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAE/E,MAAM,MAAM,GAAG,SAAS,CAAC,iBAAiB,CAAC,CAAC;AAE5C,MAAM,wBAAwB,GAAG,sBAAsB,CAAC;AACxD,MAAM,oBAAoB,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAC;AAIlE,MAAM,sBAAsB,GAAG;IAC3B,eAAe;IACf,eAAe;IACf,kBAAkB;IAClB,gBAAgB;IAChB,cAAc;IACd,MAAM;IACN,MAAM;IACN,SAAS;IACT,eAAe;IACf,UAAU;CACb,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAAC,gCAAgC,CAAC,CAAC;AAYnE,MAAM,UAAU,oBAAoB,CAChC,SAAoB,EACpB,YAA0B,EAC1B,oBAA0C,EAC1C,sBAAmD;IAEnD,IAAI,gBAAgB,GAAyC,SAAS,CAAC;IAEvE,OAAO,yBAAyB,CAAC;QAC7B,GAAG,EAAE,CAAC,SAAS,EAAE,UAAU,CAAC;QAC5B,SAAS;QACT,YAAY;QACN,cAAc,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,sBAAsB,EAAE;;gBACjE,gBAAgB,GAAG,gBAAgB,aAAhB,gBAAgB,cAAhB,gBAAgB,GAAI,YAAY,CAAC,oBAAoB,CAAC,CAAC;gBAC1E,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC;gBACzC,oBAAoB,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,sBAAsB,EAAE,SAAS,EAAE,sBAAsB,CAAC,CAAC;YAC1G,CAAC;SAAA;QACD,oBAAoB,CAAC,KAAY;YAI7B,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC;KACJ,CAAC,CAAC;AACP,CAAC;AAED,SAAe,YAAY,CAAC,oBAA0C;;;QAClE,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;QAChE,IAAI,CAAC,MAAM,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QACnG,OAAO,MAAA,MAAA,MAAM,CAAC,MAAM,EAAE,CAAC,OAAO,0CAAE,cAAc,mCAAI,EAAE,CAAC;;CACxD;AAaD,MAAM,UAAgB,oBAAoB,CACtC,OAAmB,EACnB,IAAU,EACV,KAAsC,EACtC,sBAAgD,EAChD,SAA0B,EAC1B,qBAAkD;;QAElD,IAAI;YACA,eAAe,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YACpC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;YAGrD,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;YAC9C,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC;YACrC,sBAAsB,CAAC,GAAG,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC,CAAC;YAEtD,IAAI,QAAkB,CAAC;YACvB,IAAI,qBAAqB,EAAE;gBACvB,MAAM,WAAW,GAAG,iBAAiE,CAAC;gBACtF,IAAI;oBACA,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;oBAC5D,MAAM,eAAe,GAAG,qBAAqB,CAAC,GAAG,EAAE,IAAI,EAAE;wBACrD,GAAG,EAAE,GAAG;wBACR,UAAU;wBACV,MAAM;wBACN,IAAI;wBACJ,OAAO,EAAE,QAAQ;wBACjB,IAAI;qBACP,CAAC,CAAC;oBACH,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE;wBAC7B,MAAM,oBAAoB,CACtB,QAAQ,WAAW,0DAA0D,CAChF,CAAC;qBACL;oBACD,QAAQ,GAAG,MAAM,eAAe,CAAC;iBACpC;gBAAC,OAAO,KAAK,EAAE;oBAEZ,KAAK;wBACD,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,wBAAwB;4BAC7D,CAAC,CAAC,KAAK;4BACP,CAAC,CAAC,oBAAoB,CAChB,QAAQ,WAAW,yDAAyD,EAC5E,KAAK,CACR,CAAC;oBACZ,MAAM,KAAK,CAAC;iBACf;aACJ;iBAAM;gBACH,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;aACrC;YAED,KAAK,CAAC,MAAM,sBAAsB,CAAC,QAAQ,CAAC,CAAC,CAAC;SACjD;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,wBAAwB,EAAE;gBAEnE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACnB,KAAK,CACD,gBAAgB,CACZ,sBAAsB,EAGtB,8DAA8D,CACjE,CACJ,CAAC;aACL;iBAAM,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,0BAA0B,EAAE;gBAE5E,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACnB,KAAK,CACD,gBAAgB,CACZ,wBAAwB,EAExB,KAAK,CAAC,OAAO,CAChB,CACJ,CAAC;aACL;iBAAM;gBAEH,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACpB,KAAK,CACD,gBAAgB,CACZ,cAAc,EAEd,4BAA4B,CAC/B,CACJ,CAAC;aACL;SACJ;IACL,CAAC;CAAA;AAED,SAAS,gBAAgB,CAAC,SAAmC,EAAE,OAAe;IAC1E,OAAO;QACH,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,EAAE;QACf,WAAW,EAAE,YAAY;QACzB,QAAQ,EAAE;YACN,yBAAyB,EAAE,SAAS;SACvC;QACD,IAAI,EAAE,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC;KAC1C,CAAC;AACN,CAAC;AAKD,MAAM,UAAU,qBAAqB,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAc;IAC7E,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEtC,KAAK,MAAM,MAAM,IAAI,uBAAuB,EAAE;QAC1C,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;KAC1B;IACD,OAAO;QACH,GAAG,EAAE,GAAG;QACR,IAAI,EAAE;YACF,OAAO,EAAE,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YAC9C,IAAI,EAAE,MAAM,KAAK,KAAK,IAAK,MAAc,KAAK,MAAM,IAAI,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;YAC/F,MAAM;SACT;KACJ,CAAC;AACN,CAAC;AAKD,MAAM,UAAgB,sBAAsB,CAAC,QAAkB;;;QAC3D,MAAM,QAAQ,GAA2B,EAAE,CAAC;QAC5C,KAAK,MAAM,aAAa,IAAI,sBAAsB,EAAE;YAChD,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YAClD,IAAI,KAAK,EAAE;gBACP,QAAQ,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,GAAG,KAAK,CAAC;aACjD;SACJ;QACD,OAAO;YACH,IAAI,EAAE,QAAQ,CAAC,MAAM;YACrB,WAAW,EAAE,EAAE;YAKf,WAAW,EAAE,CAAC,MAAA,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,mCAAI,EAAE,CAAgB;YACxE,QAAQ;YACR,IAAI,EAAE,MAAM,QAAQ,CAAC,WAAW,EAAE;SACrC,CAAC;;CACL","sourcesContent":["import type { RemoteApiSpecsClient } from \"../../clients/remoteApiSpecsClient\";\nimport type { Lens } from \"../../lens/Lens\";\nimport type { LensState } from \"../../session/lensState\";\nimport { getLogger } from \"../../logger/logger\";\nimport type { SessionState } from \"../../session/sessionState\";\nimport { namedError } from \"../../namedErrors\";\nimport type { CameraKitBootstrapConfiguration, LensHttpHandler } from \"../../configuration\";\nimport type { UriHandler, UriRequest, UriResponse } from \"../UriHandlers\";\nimport { createUriRequestProcessor } from \"../uriRequestProcessor\";\nimport type { RemoteApiSpec } from \"../../generated-proto/pb_schema/camera_kit/v3/remote_api_spec\";\nimport { isPromise } from \"../../common/typeguards\";\nimport type { ContentType } from \"../../lens-core-module/generated-types\";\nimport { requestValidationErrorName, validateRequest } from \"./httpValidators\";\n\nconst logger = getLogger(\"lensHttpHandler\");\n\nconst lensHttpHandlerErrorName = \"LensHttpHandlerError\";\nconst lensHttpHandlerError = namedError(lensHttpHandlerErrorName);\n\ntype LensHttpRequestErrorType = \"UnknownError\" | \"LensHttpHandlerError\" | \"RequestValidationError\";\n\nconst allowedResponseHeaders = [\n    \"Accept-Ranges\",\n    \"Cache-Control\",\n    \"Content-Language\",\n    \"Content-Length\",\n    \"Content-Type\",\n    \"Date\",\n    \"ETag\",\n    \"Expires\",\n    \"Last-Modified\",\n    \"Location\",\n];\n\nconst requestHeadersToExclude = [\"x-sc-lenses-remote-api-spec-id\"];\n\n/**\n *\n * @internal\n *\n * @param lensState\n * @param sessionState\n * @param remoteApiSpecsClient\n * @param clientLentHttpRequestHandler\n * @returns\n */\nexport function createHttpUriHandler(\n    lensState: LensState,\n    sessionState: SessionState,\n    remoteApiSpecsClient: RemoteApiSpecsClient,\n    customLentFetchHandler: LensHttpHandler | undefined\n): UriHandler {\n    let allowlistPromise: Promise<RemoteApiSpec[]> | undefined = undefined;\n\n    return createUriRequestProcessor({\n        uri: [\"http://\", \"https://\"],\n        lensState,\n        sessionState,\n        async processRequest({ request, lens, reply, setCancellationHandler }) {\n            allowlistPromise = allowlistPromise ?? getAllowlist(remoteApiSpecsClient);\n            const allowlist = await allowlistPromise;\n            handleHttpUriRequest(request, lens, reply, setCancellationHandler, allowlist, customLentFetchHandler);\n        },\n        processInternalError(error: Error) {\n            // The expectation is that if an error occurs, it happens in our own implementation,\n            // because app callbacks are wrapped with try..catch blocks.\n            // Therefore, we would like to report this error.\n            logger.error(error);\n        },\n    });\n}\n\nasync function getAllowlist(remoteApiSpecsClient: RemoteApiSpecsClient) {\n    const result = await remoteApiSpecsClient.getRemoteApiSpecs({});\n    if (!result.ok) throw new Error(\"Failed getting Remote API specs.\", { cause: result.unwrapErr() });\n    return result.unwrap().message?.remoteApiSpecs ?? [];\n}\n\n/**\n *\n * @internal\n *\n * @param request\n * @param lens\n * @param reply\n * @param setCancellationHandler\n * @param allowlist\n * @param clientLensHttpRequestHandler\n */\nexport async function handleHttpUriRequest(\n    request: UriRequest,\n    lens: Lens,\n    reply: (response: UriResponse) => void,\n    setCancellationHandler: (fn: () => void) => void,\n    allowlist: RemoteApiSpec[],\n    customLensHttpHandler: LensHttpHandler | undefined\n) {\n    try {\n        validateRequest(request, allowlist);\n        const { url, init } = mapLensToFetchRequest(request);\n\n        // abort controller to abort fetch request when lens sends cancellation request\n        const abortController = new AbortController();\n        init.signal = abortController.signal;\n        setCancellationHandler(() => abortController.abort());\n\n        let response: Response;\n        if (customLensHttpHandler) {\n            const handlerName = \"lensHttpHandler\" satisfies keyof CameraKitBootstrapConfiguration;\n            try {\n                const { uri, identifier, method, metadata, data } = request;\n                const responsePromise = customLensHttpHandler(url, init, {\n                    url: uri,\n                    identifier,\n                    method,\n                    data,\n                    headers: metadata,\n                    lens,\n                });\n                if (!isPromise(responsePromise)) {\n                    throw lensHttpHandlerError(\n                        `The '${handlerName}' callback provided to Camera Kit must return a Promise.`\n                    );\n                }\n                response = await responsePromise;\n            } catch (error) {\n                // NOTE: This error message will be displayed in browser only\n                error =\n                    error instanceof Error && error.name === lensHttpHandlerErrorName\n                        ? error\n                        : lensHttpHandlerError(\n                              `The '${handlerName}' callback provided to Camera Kit configuration failed.`,\n                              error\n                          );\n                throw error;\n            }\n        } else {\n            response = await fetch(url, init);\n        }\n\n        reply(await mapFetchToLensResponse(response));\n    } catch (error) {\n        if (error instanceof Error && error.name === lensHttpHandlerErrorName) {\n            // We do not report errors generated in partners's app code\n            logger.warn(error);\n            reply(\n                getErrorResponse(\n                    \"LensHttpHandlerError\",\n                    // In case of an error in partner provided callback,\n                    // we just send a generic message to lens, which is common for all Camera Kit SDKs.\n                    `The lens HTTP request handler provided to Camera Kit failed.`\n                )\n            );\n        } else if (error instanceof Error && error.name === requestValidationErrorName) {\n            // We do not report validation error caused by lens code\n            logger.warn(error);\n            reply(\n                getErrorResponse(\n                    \"RequestValidationError\",\n                    // NOTE: Validation errors sent to lens should be consistent with the other Camera Kit SDKs\n                    error.message\n                )\n            );\n        } else {\n            // We report error to our backend only in case of unknown error\n            logger.error(error);\n            reply(\n                getErrorResponse(\n                    \"UnknownError\",\n                    // NOTE: we don't want to expose error details to lens\n                    \"An unknown error occurred.\"\n                )\n            );\n        }\n    }\n}\n\nfunction getErrorResponse(errorType: LensHttpRequestErrorType, message: string): UriResponse {\n    return {\n        code: 400,\n        description: \"\",\n        contentType: \"text/plain\",\n        metadata: {\n            \"x-camera-kit-error-type\": errorType,\n        },\n        data: new TextEncoder().encode(message),\n    };\n}\n\n/**\n * @internal\n */\nexport function mapLensToFetchRequest({ uri, method, metadata, data }: UriRequest): { url: string; init: RequestInit } {\n    const headers = new Headers(metadata);\n    // remove internal headers that LensCore adds\n    for (const header of requestHeadersToExclude) {\n        headers.delete(header);\n    }\n    return {\n        url: uri,\n        init: {\n            headers: Object.fromEntries(headers.entries()),\n            body: method !== \"GET\" && (method as any) !== \"HEAD\" && method !== undefined ? data : undefined,\n            method,\n        },\n    };\n}\n\n/**\n * @internal\n */\nexport async function mapFetchToLensResponse(response: Response): Promise<UriResponse> {\n    const metadata: Record<string, string> = {};\n    for (const allowedHeader of allowedResponseHeaders) {\n        const value = response.headers.get(allowedHeader);\n        if (value) {\n            metadata[allowedHeader.toLowerCase()] = value;\n        }\n    }\n    return {\n        code: response.status,\n        description: \"\",\n        // Safety: At the time of writing any contentType value provided in the response object will be ignored:\n        // eslint-disable-next-line max-len\n        // https://github.sc-corp.net/Snapchat/LensCore/blob/722629250973cdf1064baef85d9360229f9dff76/Src/Scenarium/Primitives/RemoteServiceModule.cpp#L517-L533\n        // But we still try to provide it with the correct value for consistency with mobile SDKs.\n        contentType: (response.headers.get(\"Content-Type\") ?? \"\") as ContentType,\n        metadata,\n        data: await response.arrayBuffer(),\n    };\n}\n"]}

package/dist/uri-handlers/internal-handlers/httpValidators.d.ts

@@ -0,0 +1,9 @@
+import type { RemoteApiSpec, RemoteParameter } from "../../generated-proto/pb_schema/camera_kit/v3/remote_api_spec";
+import type { UriRequest } from "../UriHandlers";
+export declare const requestValidationErrorName = "RequestValidationError";
+export declare const requestValidationError: (message: string, cause?: unknown) => never;
+export declare function validateRequest(request: UriRequest, specs: RemoteApiSpec[]): void;
+export declare function validatePath(path: string, parameters: RemoteParameter[]): void;
+export declare function validateHeaders(headers: Record<string, string>, parameters: RemoteParameter[]): void;
+export declare function validateQuery(uri: string, parameters: RemoteParameter[]): void;
+//# sourceMappingURL=httpValidators.d.ts.map

package/dist/uri-handlers/internal-handlers/httpValidators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpValidators.d.ts","sourceRoot":"","sources":["../../../src/uri-handlers/internal-handlers/httpValidators.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,+DAA+D,CAAC;AAIpH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAEjD,eAAO,MAAM,0BAA0B,2BAA2B,CAAC;AACnE,eAAO,MAAM,sBAAsB,6CAAyC,CAAC;AAE7E,wBAAgB,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,aAAa,EAAE,QA2B1E;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,EAAE,QA8CvE;AAED,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,UAAU,EAAE,eAAe,EAAE,QA4B7F;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,EAAE,QAgCvE"}

package/dist/uri-handlers/internal-handlers/httpValidators.js

@@ -0,0 +1,115 @@
+import { isEmptyString } from "../../common/typeguards";
+import { RemoteEndpoint_HttpRequestMethod } from "../../generated-proto/pb_schema/camera_kit/v3/remote_api_spec";
+import { RemoteParameter_ParameterLocation } from "../../generated-proto/pb_schema/camera_kit/v3/remote_api_spec";
+import { namedError } from "../../namedErrors";
+export const requestValidationErrorName = "RequestValidationError";
+export const requestValidationError = namedError(requestValidationErrorName);
+export function validateRequest(request, specs) {
+    var _a, _b, _c;
+    for (const spec of specs) {
+        const url = `${spec.tlsRequired ? "https://" : "http://"}${spec.host}`;
+        if (!request.uri.startsWith(url))
+            continue;
+        const path = ((_a = request.uri.split(url)[1]) !== null && _a !== void 0 ? _a : "").replace(/^\//, "").replace(/\/$/, "");
+        for (const endpoint of spec.endpoints) {
+            const endpointPath = endpoint.path.replace(/^\//, "").replace(/\/$/, "");
+            if (!path.startsWith(endpointPath))
+                continue;
+            const method = (_b = RemoteEndpoint_HttpRequestMethod[request.method]) !== null && _b !== void 0 ? _b : RemoteEndpoint_HttpRequestMethod.UNRECOGNIZED;
+            if (!endpoint.methods.includes(method))
+                continue;
+            validatePath((_c = path.split(endpointPath)[1]) !== null && _c !== void 0 ? _c : "", endpoint.parameters);
+            validateHeaders(request.metadata, endpoint.parameters);
+            validateQuery(request.uri, endpoint.parameters);
+            return;
+        }
+    }
+    throw requestValidationError("The request does not match any of the Remote API specifications.");
+}
+export function validatePath(path, parameters) {
+    const pathComponents = path.split("/").filter(Boolean);
+    let paramIndex = 0;
+    for (const param of parameters) {
+        if (param.location !== RemoteParameter_ParameterLocation.PATH)
+            continue;
+        const paramNameComponent = pathComponents[paramIndex];
+        const paramValueComponent = pathComponents[paramIndex + 1];
+        if (param.constant) {
+            if (paramNameComponent === param.name && paramValueComponent === param.defaultValue) {
+                paramIndex += 2;
+            }
+            else {
+                throw requestValidationError(`Expected constant parameter '${param.name}' with value '${param.defaultValue}' ` +
+                    `at position ${paramIndex}, but found '${paramNameComponent}' and '${paramValueComponent}'.`);
+            }
+        }
+        else if (param.optional) {
+            if (paramNameComponent === param.name) {
+                paramIndex += 2;
+            }
+        }
+        else {
+            if (paramNameComponent === param.name && paramValueComponent !== undefined) {
+                paramIndex += 2;
+            }
+            else {
+                throw requestValidationError(`Expected parameter '${param.name}' with a value at position ${paramIndex}, ` +
+                    `but found '${paramNameComponent}' and '${paramValueComponent}'.`);
+            }
+        }
+    }
+    if (paramIndex !== pathComponents.length) {
+        const invalidPath = pathComponents.slice(paramIndex).join("/");
+        throw requestValidationError(`Unexpected extra path components starting at position ${paramIndex}: '${invalidPath}'.`);
+    }
+}
+export function validateHeaders(headers, parameters) {
+    for (const param of parameters) {
+        if (param.location !== RemoteParameter_ParameterLocation.HEADER)
+            continue;
+        const headerValue = headers[param.name];
+        if (param.constant) {
+            if (headerValue !== param.defaultValue) {
+                throw requestValidationError(`Expected constant header '${param.name}' with value '${param.defaultValue}', ` +
+                    `but found '${headerValue !== null && headerValue !== void 0 ? headerValue : "undefined"}'.`);
+            }
+        }
+        else if (param.optional) {
+            if (headerValue != undefined && isEmptyString(headerValue)) {
+                throw requestValidationError(`Header '${param.name}' is present but empty. If provided, it should not be empty.`);
+            }
+        }
+        else {
+            if (headerValue == undefined || isEmptyString(headerValue)) {
+                throw requestValidationError(`Required header '${param.name}' is missing or empty.`);
+            }
+        }
+    }
+}
+export function validateQuery(uri, parameters) {
+    const url = new URL(uri);
+    const queryParams = new URLSearchParams(url.search);
+    for (const param of parameters) {
+        if (param.location !== RemoteParameter_ParameterLocation.QUERY)
+            continue;
+        const paramValue = queryParams.get(param.name);
+        if (param.constant) {
+            if (paramValue !== param.defaultValue) {
+                throw requestValidationError(`Expected constant query parameter '${param.name}' with value '${param.defaultValue}', ` +
+                    `but found '${paramValue !== null && paramValue !== void 0 ? paramValue : "undefined"}'.`);
+            }
+        }
+        else if (param.optional) {
+            if (paramValue != undefined && isEmptyString(paramValue)) {
+                throw requestValidationError(`Optional query parameter '${param.name}' is present but empty. ` +
+                    `If provided, it should not be empty.`);
+            }
+        }
+        else {
+            if (paramValue == undefined || isEmptyString(paramValue)) {
+                throw requestValidationError(`Required query parameter '${param.name}' is missing or empty.`);
+            }
+        }
+    }
+}
+//# sourceMappingURL=httpValidators.js.map

package/dist/uri-handlers/internal-handlers/httpValidators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpValidators.js","sourceRoot":"","sources":["../../../src/uri-handlers/internal-handlers/httpValidators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAE,gCAAgC,EAAE,MAAM,+DAA+D,CAAC;AACjH,OAAO,EAAE,iCAAiC,EAAE,MAAM,+DAA+D,CAAC;AAClH,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAG/C,MAAM,CAAC,MAAM,0BAA0B,GAAG,wBAAwB,CAAC;AACnE,MAAM,CAAC,MAAM,sBAAsB,GAAG,UAAU,CAAC,0BAA0B,CAAC,CAAC;AAE7E,MAAM,UAAU,eAAe,CAAC,OAAmB,EAAE,KAAsB;;IAEvE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;QACtB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAEvE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,SAAS;QAG3C,MAAM,IAAI,GAAG,CAAC,MAAA,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,mCAAI,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACrF,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE;YACnC,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YACzE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;gBAAE,SAAS;YAE7C,MAAM,MAAM,GACR,MAAA,gCAAgC,CAAC,OAAO,CAAC,MAAM,CAAC,mCAAI,gCAAgC,CAAC,YAAY,CAAC;YACtG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;gBAAE,SAAS;YAEjD,YAAY,CAAC,MAAA,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,mCAAI,EAAE,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;YACrE,eAAe,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;YACvD,aAAa,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;YAEhD,OAAO;SACV;KACJ;IAGD,MAAM,sBAAsB,CAAC,kEAAkE,CAAC,CAAC;AACrG,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,IAAY,EAAE,UAA6B;IACpE,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAEvD,IAAI,UAAU,GAAG,CAAC,CAAC;IAEnB,KAAK,MAAM,KAAK,IAAI,UAAU,EAAE;QAC5B,IAAI,KAAK,CAAC,QAAQ,KAAK,iCAAiC,CAAC,IAAI;YAAE,SAAS;QAExE,MAAM,kBAAkB,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC;QACtD,MAAM,mBAAmB,GAAG,cAAc,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;QAE3D,IAAI,KAAK,CAAC,QAAQ,EAAE;YAEhB,IAAI,kBAAkB,KAAK,KAAK,CAAC,IAAI,IAAI,mBAAmB,KAAK,KAAK,CAAC,YAAY,EAAE;gBACjF,UAAU,IAAI,CAAC,CAAC;aACnB;iBAAM;gBACH,MAAM,sBAAsB,CACxB,gCAAgC,KAAK,CAAC,IAAI,iBAAiB,KAAK,CAAC,YAAY,IAAI;oBAC7E,eAAe,UAAU,gBAAgB,kBAAkB,UAAU,mBAAmB,IAAI,CACnG,CAAC;aACL;SACJ;aAAM,IAAI,KAAK,CAAC,QAAQ,EAAE;YACvB,IAAI,kBAAkB,KAAK,KAAK,CAAC,IAAI,EAAE;gBACnC,UAAU,IAAI,CAAC,CAAC;aACnB;SAEJ;aAAM;YAEH,IAAI,kBAAkB,KAAK,KAAK,CAAC,IAAI,IAAI,mBAAmB,KAAK,SAAS,EAAE;gBACxE,UAAU,IAAI,CAAC,CAAC;aACnB;iBAAM;gBACH,MAAM,sBAAsB,CACxB,uBAAuB,KAAK,CAAC,IAAI,8BAA8B,UAAU,IAAI;oBACzE,cAAc,kBAAkB,UAAU,mBAAmB,IAAI,CACxE,CAAC;aACL;SACJ;KACJ;IAGD,IAAI,UAAU,KAAK,cAAc,CAAC,MAAM,EAAE;QACtC,MAAM,WAAW,GAAG,cAAc,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC/D,MAAM,sBAAsB,CACxB,yDAAyD,UAAU,MAAM,WAAW,IAAI,CAC3F,CAAC;KACL;AACL,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,OAA+B,EAAE,UAA6B;IAC1F,KAAK,MAAM,KAAK,IAAI,UAAU,EAAE;QAC5B,IAAI,KAAK,CAAC,QAAQ,KAAK,iCAAiC,CAAC,MAAM;YAAE,SAAS;QAE1E,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAExC,IAAI,KAAK,CAAC,QAAQ,EAAE;YAEhB,IAAI,WAAW,KAAK,KAAK,CAAC,YAAY,EAAE;gBACpC,MAAM,sBAAsB,CACxB,6BAA6B,KAAK,CAAC,IAAI,iBAAiB,KAAK,CAAC,YAAY,KAAK;oBAC3E,cAAc,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,WAAW,IAAI,CACnD,CAAC;aACL;SACJ;aAAM,IAAI,KAAK,CAAC,QAAQ,EAAE;YAEvB,IAAI,WAAW,IAAI,SAAS,IAAI,aAAa,CAAC,WAAW,CAAC,EAAE;gBACxD,MAAM,sBAAsB,CACxB,WAAW,KAAK,CAAC,IAAI,8DAA8D,CACtF,CAAC;aACL;SACJ;aAAM;YAEH,IAAI,WAAW,IAAI,SAAS,IAAI,aAAa,CAAC,WAAW,CAAC,EAAE;gBACxD,MAAM,sBAAsB,CAAC,oBAAoB,KAAK,CAAC,IAAI,wBAAwB,CAAC,CAAC;aACxF;SACJ;KACJ;AACL,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,GAAW,EAAE,UAA6B;IACpE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IACzB,MAAM,WAAW,GAAG,IAAI,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACpD,KAAK,MAAM,KAAK,IAAI,UAAU,EAAE;QAC5B,IAAI,KAAK,CAAC,QAAQ,KAAK,iCAAiC,CAAC,KAAK;YAAE,SAAS;QAEzE,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAE/C,IAAI,KAAK,CAAC,QAAQ,EAAE;YAEhB,IAAI,UAAU,KAAK,KAAK,CAAC,YAAY,EAAE;gBACnC,MAAM,sBAAsB,CACxB,sCAAsC,KAAK,CAAC,IAAI,iBAAiB,KAAK,CAAC,YAAY,KAAK;oBACpF,cAAc,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,WAAW,IAAI,CAClD,CAAC;aACL;SACJ;aAAM,IAAI,KAAK,CAAC,QAAQ,EAAE;YAEvB,IAAI,UAAU,IAAI,SAAS,IAAI,aAAa,CAAC,UAAU,CAAC,EAAE;gBACtD,MAAM,sBAAsB,CACxB,6BAA6B,KAAK,CAAC,IAAI,0BAA0B;oBAC7D,sCAAsC,CAC7C,CAAC;aACL;SACJ;aAAM;YAEH,IAAI,UAAU,IAAI,SAAS,IAAI,aAAa,CAAC,UAAU,CAAC,EAAE;gBACtD,MAAM,sBAAsB,CAAC,6BAA6B,KAAK,CAAC,IAAI,wBAAwB,CAAC,CAAC;aACjG;SACJ;KACJ;AAEL,CAAC","sourcesContent":["import { isEmptyString } from \"../../common/typeguards\";\nimport type { RemoteApiSpec, RemoteParameter } from \"../../generated-proto/pb_schema/camera_kit/v3/remote_api_spec\";\nimport { RemoteEndpoint_HttpRequestMethod } from \"../../generated-proto/pb_schema/camera_kit/v3/remote_api_spec\";\nimport { RemoteParameter_ParameterLocation } from \"../../generated-proto/pb_schema/camera_kit/v3/remote_api_spec\";\nimport { namedError } from \"../../namedErrors\";\nimport type { UriRequest } from \"../UriHandlers\";\n\nexport const requestValidationErrorName = \"RequestValidationError\";\nexport const requestValidationError = namedError(requestValidationErrorName);\n\nexport function validateRequest(request: UriRequest, specs: RemoteApiSpec[]) {\n    // 1. Given url, method and headers and spec:\n    for (const spec of specs) {\n        const url = `${spec.tlsRequired ? \"https://\" : \"http://\"}${spec.host}`;\n        // 2. Check url starts with schema + the host. If yes trim that part and split by /\n        if (!request.uri.startsWith(url)) continue;\n\n        // 3. Split the rest by / and go for each part together with the path parameters.\n        const path = (request.uri.split(url)[1] ?? \"\").replace(/^\\//, \"\").replace(/\\/$/, \"\");\n        for (const endpoint of spec.endpoints) {\n            const endpointPath = endpoint.path.replace(/^\\//, \"\").replace(/\\/$/, \"\");\n            if (!path.startsWith(endpointPath)) continue;\n\n            const method =\n                RemoteEndpoint_HttpRequestMethod[request.method] ?? RemoteEndpoint_HttpRequestMethod.UNRECOGNIZED;\n            if (!endpoint.methods.includes(method)) continue;\n\n            validatePath(path.split(endpointPath)[1] ?? \"\", endpoint.parameters);\n            validateHeaders(request.metadata, endpoint.parameters);\n            validateQuery(request.uri, endpoint.parameters);\n            // The request matches the current endpoint\n            return;\n        }\n    }\n\n    // The request does not match any of the endpoints\n    throw requestValidationError(\"The request does not match any of the Remote API specifications.\");\n}\n\nexport function validatePath(path: string, parameters: RemoteParameter[]) {\n    const pathComponents = path.split(\"/\").filter(Boolean);\n\n    let paramIndex = 0;\n\n    for (const param of parameters) {\n        if (param.location !== RemoteParameter_ParameterLocation.PATH) continue;\n\n        const paramNameComponent = pathComponents[paramIndex];\n        const paramValueComponent = pathComponents[paramIndex + 1];\n\n        if (param.constant) {\n            // For constant parameters, the value must match the defaultValue\n            if (paramNameComponent === param.name && paramValueComponent === param.defaultValue) {\n                paramIndex += 2; // Move to the next parameter pair\n            } else {\n                throw requestValidationError(\n                    `Expected constant parameter '${param.name}' with value '${param.defaultValue}' ` +\n                        `at position ${paramIndex}, but found '${paramNameComponent}' and '${paramValueComponent}'.`\n                );\n            }\n        } else if (param.optional) {\n            if (paramNameComponent === param.name) {\n                paramIndex += 2; // Move to the next parameter pair if optional parameter exists\n            }\n            // If optional and not present, continue without incrementing paramIndex\n        } else {\n            // For regular parameters, we just need to ensure a name/value pair exists\n            if (paramNameComponent === param.name && paramValueComponent !== undefined) {\n                paramIndex += 2; // Move to the next parameter pair\n            } else {\n                throw requestValidationError(\n                    `Expected parameter '${param.name}' with a value at position ${paramIndex}, ` +\n                        `but found '${paramNameComponent}' and '${paramValueComponent}'.`\n                );\n            }\n        }\n    }\n\n    // After processing all parameters, there should be no extra path components\n    if (paramIndex !== pathComponents.length) {\n        const invalidPath = pathComponents.slice(paramIndex).join(\"/\");\n        throw requestValidationError(\n            `Unexpected extra path components starting at position ${paramIndex}: '${invalidPath}'.`\n        );\n    }\n}\n\nexport function validateHeaders(headers: Record<string, string>, parameters: RemoteParameter[]) {\n    for (const param of parameters) {\n        if (param.location !== RemoteParameter_ParameterLocation.HEADER) continue;\n\n        const headerValue = headers[param.name];\n\n        if (param.constant) {\n            // For constant parameters, the header must exist and match defaultValue\n            if (headerValue !== param.defaultValue) {\n                throw requestValidationError(\n                    `Expected constant header '${param.name}' with value '${param.defaultValue}', ` +\n                        `but found '${headerValue ?? \"undefined\"}'.`\n                );\n            }\n        } else if (param.optional) {\n            // If optional, we only validate if the header exists\n            if (headerValue != undefined && isEmptyString(headerValue)) {\n                throw requestValidationError(\n                    `Header '${param.name}' is present but empty. If provided, it should not be empty.`\n                );\n            }\n        } else {\n            // For regular parameters, the header must exist and have a non-empty value\n            if (headerValue == undefined || isEmptyString(headerValue)) {\n                throw requestValidationError(`Required header '${param.name}' is missing or empty.`);\n            }\n        }\n    }\n}\n\nexport function validateQuery(uri: string, parameters: RemoteParameter[]) {\n    const url = new URL(uri);\n    const queryParams = new URLSearchParams(url.search);\n    for (const param of parameters) {\n        if (param.location !== RemoteParameter_ParameterLocation.QUERY) continue;\n\n        const paramValue = queryParams.get(param.name);\n\n        if (param.constant) {\n            // For constant parameters, the query parameter must exist and match defaultValue\n            if (paramValue !== param.defaultValue) {\n                throw requestValidationError(\n                    `Expected constant query parameter '${param.name}' with value '${param.defaultValue}', ` +\n                        `but found '${paramValue ?? \"undefined\"}'.`\n                );\n            }\n        } else if (param.optional) {\n            // If optional, validate only if the query parameter exists\n            if (paramValue != undefined && isEmptyString(paramValue)) {\n                throw requestValidationError(\n                    `Optional query parameter '${param.name}' is present but empty. ` +\n                        `If provided, it should not be empty.`\n                );\n            }\n        } else {\n            // For regular parameters, the query parameter must exist and have a non-empty value\n            if (paramValue == undefined || isEmptyString(paramValue)) {\n                throw requestValidationError(`Required query parameter '${param.name}' is missing or empty.`);\n            }\n        }\n    }\n    // All query parameters are valid\n}\n"]}

package/dist/{extensions/RemoteApiServices.d.ts → uri-handlers/internal-handlers/remoteApiUriHandler.d.ts}

@@ -1,9 +1,9 @@
-import type { LensRepository } from "../lens/LensRepository";
-import type { Lens } from "../lens/Lens";
-import type { LensState } from "../session/lensState";
-import type { SessionState } from "../session/sessionState";
-import type { MetricsClient } from "../clients/metricsClient";
-import type { UriHandler } from "./UriHandlers";
+import type { LensRepository } from "../../lens/LensRepository";
+import type { Lens } from "../../lens/Lens";
+import type { LensState } from "../../session/lensState";
+import type { SessionState } from "../../session/sessionState";
+import type { MetricsClient } from "../../clients/metricsClient";
+import type { UriHandler } from "../UriHandlers";
 /**
  * Status of a Remote API response.
  */
@@ -84,5 +84,5 @@ export declare const remoteApiServicesFactory: {
  * Provides a URI handler that searches for a match within the provided services to handle Remote API requests,
  * i.e., those whose URI starts with 'app://remote-api/performApiRequest'.
  */
-export declare function getRemoteApiUriHandler(registeredServices: RemoteApiService[], sessionState: SessionState, lensState: LensState, lensRepository: LensRepository, metrics: MetricsClient): UriHandler;
-//# sourceMappingURL=RemoteApiServices.d.ts.map
+export declare function createRemoteApiUriHandler(registeredServices: RemoteApiService[], sessionState: SessionState, lensState: LensState, lensRepository: LensRepository, metrics: MetricsClient): UriHandler;
+//# sourceMappingURL=remoteApiUriHandler.d.ts.map

package/dist/uri-handlers/internal-handlers/remoteApiUriHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remoteApiUriHandler.d.ts","sourceRoot":"","sources":["../../../src/uri-handlers/internal-handlers/remoteApiUriHandler.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAG/D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAIjE,OAAO,KAAK,EAAE,UAAU,EAAe,MAAM,gBAAgB,CAAC;AAyC9D;;GAEG;AACH,MAAM,MAAM,eAAe,GACrB,SAAS,GACT,YAAY,GACZ,YAAY,GACZ,cAAc,GACd,UAAU,GACV,SAAS,GACT,iBAAiB,GACjB,aAAa,GACb,WAAW,GACX,YAAY,CAAC;AAEnB;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IACxB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,MAAM,IAAI,CAAC;AAEvD;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAClC,KAAK,EAAE,CAAC,QAAQ,EAAE,iBAAiB,KAAK,IAAI,KAC3C,6BAA6B,GAAG,IAAI,CAAC;AAE1C;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;OAMG;IACH,iBAAiB,CAAC,OAAO,EAAE,gBAAgB,EAAE,IAAI,EAAE,IAAI,GAAG,uBAAuB,GAAG,SAAS,CAAC;CACjG;AAED,MAAM,MAAM,iBAAiB,GAAG,gBAAgB,EAAE,CAAC;AAEnD,eAAO,MAAM,wBAAwB;;;;CAGnC,CAAC;AAEH;;;GAGG;AACH,wBAAgB,yBAAyB,CACrC,kBAAkB,EAAE,gBAAgB,EAAE,EACtC,YAAY,EAAE,YAAY,EAC1B,SAAS,EAAE,SAAS,EACpB,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,aAAa,GACvB,UAAU,CAiHZ"}

package/dist/uri-handlers/internal-handlers/remoteApiUriHandler.js

@@ -0,0 +1,121 @@
+import { Injectable } from "@snap/ts-inject";
+import { RemoteApiInfo } from "../../generated-proto/pb_schema/camera_kit/v3/features/remote_api_info";
+import { ResponseCode, responseCodeToNumber, } from "../../generated-proto/pb_schema/lenses/remote_api/remote_api_service";
+import { getLogger } from "../../logger/logger";
+import { Count } from "../../metrics/operational/Count";
+import { joinMetricNames } from "../../metrics/operational/Metric";
+import { createUriRequestProcessor } from "../uriRequestProcessor";
+import { extractSchemeAndRoute } from "../UriHandlers";
+const logger = getLogger("RemoteApiServices");
+const uriResponseOkCode = 200;
+const apiResponseStatusHeader = ":sc_lens_api_status";
+const apiBinaryContentType = "application/octet-stream";
+const remoteApiInfoProtobufTypeUrl = "type.googleapis.com/com.snap.camerakit.v3.features.RemoteApiInfo";
+const remoteApiUploadImageSpecId = "af3f69c8-2e62-441f-8b1c-d3956f7b336c";
+const statusToResponseCodeMap = {
+    success: ResponseCode.SUCCESS,
+    redirected: ResponseCode.REDIRECTED,
+    badRequest: ResponseCode.BAD_REQUEST,
+    accessDenied: ResponseCode.ACCESS_DENIED,
+    notFound: ResponseCode.NOT_FOUND,
+    timeout: ResponseCode.TIMEOUT,
+    requestTooLarge: ResponseCode.REQUEST_TOO_LARGE,
+    serverError: ResponseCode.SERVER_ERROR,
+    cancelled: ResponseCode.CANCELLED,
+    proxyError: ResponseCode.PROXY_ERROR,
+};
+export const remoteApiServicesFactory = Injectable("remoteApiServices", () => {
+    const remoteApiServices = [];
+    return remoteApiServices;
+});
+export function createRemoteApiUriHandler(registeredServices, sessionState, lensState, lensRepository, metrics) {
+    const registeredServiceMap = new Map();
+    for (const service of registeredServices) {
+        const existingServices = registeredServiceMap.get(service.apiSpecId) || [];
+        registeredServiceMap.set(service.apiSpecId, [...existingServices, service]);
+    }
+    return createUriRequestProcessor({
+        uri: "app://remote-api/performApiRequest",
+        lensState,
+        sessionState,
+        createLensRequestState(_request, lens) {
+            var _a, _b;
+            return {
+                supportedSpecIds: new Set([
+                    ...((_b = (_a = lensRepository.getLensMetadata(lens.id)) === null || _a === void 0 ? void 0 : _a.featureMetadata) !== null && _b !== void 0 ? _b : [])
+                        .filter((feature) => feature.typeUrl === remoteApiInfoProtobufTypeUrl)
+                        .flatMap((any) => RemoteApiInfo.decode(any.value).apiSpecIds),
+                    remoteApiUploadImageSpecId,
+                ]),
+            };
+        },
+        processRequest({ request, reply, lens, setCancellationHandler, state }) {
+            var _a;
+            const { route } = extractSchemeAndRoute(request.uri);
+            const [specId, endpointIdWithQuery] = route.split("/").slice(2);
+            const [endpointId] = endpointIdWithQuery.split("?");
+            if (!(state === null || state === void 0 ? void 0 : state.supportedSpecIds.has(specId)))
+                return;
+            if (!registeredServiceMap.has(specId))
+                return;
+            const dimensions = { specId };
+            const reportSingleCount = (name) => {
+                metrics.setOperationalMetrics(Count.count(joinMetricNames(["lens", "remote-api", name]), 1, dimensions));
+            };
+            reportSingleCount("requests");
+            const remoteApiRequest = {
+                apiSpecId: specId,
+                body: request.data,
+                endpointId,
+                parameters: request.metadata,
+            };
+            for (const service of (_a = registeredServiceMap.get(specId)) !== null && _a !== void 0 ? _a : []) {
+                let requestHandler = undefined;
+                try {
+                    requestHandler = service.getRequestHandler(remoteApiRequest, lens);
+                }
+                catch (error) {
+                    logger.warn("Client's Remote API request handler factory threw an error.", error);
+                }
+                if (requestHandler) {
+                    reportSingleCount("handled-requests");
+                    let cancellationHandler = undefined;
+                    try {
+                        cancellationHandler = requestHandler((response) => {
+                            var _a;
+                            reportSingleCount("responses");
+                            const responseCode = (_a = statusToResponseCodeMap[response.status]) !== null && _a !== void 0 ? _a : ResponseCode.UNRECOGNIZED;
+                            const uriResponse = {
+                                code: uriResponseOkCode,
+                                description: "",
+                                contentType: apiBinaryContentType,
+                                data: response.body,
+                                metadata: Object.assign(Object.assign({}, response.metadata), { [apiResponseStatusHeader]: responseCodeToNumber(responseCode).toString() }),
+                            };
+                            reply(uriResponse);
+                        });
+                    }
+                    catch (error) {
+                        logger.warn("Client's Remote API request handler threw an error.", error);
+                    }
+                    if (typeof cancellationHandler === "function") {
+                        setCancellationHandler(() => {
+                            try {
+                                cancellationHandler();
+                            }
+                            catch (error) {
+                                logger.warn("Client's Remote API request cancellation handler threw an error.", error);
+                            }
+                        });
+                    }
+                    break;
+                }
+            }
+        },
+        processInternalError(error) {
+            logger.error(error);
+            metrics.setOperationalMetrics(Count.count(joinMetricNames(["lens", "remote-api", "errors"]), 1));
+        },
+    });
+}
+//# sourceMappingURL=remoteApiUriHandler.js.map

package/dist/uri-handlers/internal-handlers/remoteApiUriHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remoteApiUriHandler.js","sourceRoot":"","sources":["../../../src/uri-handlers/internal-handlers/remoteApiUriHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,wEAAwE,CAAC;AACvG,OAAO,EACH,YAAY,EACZ,oBAAoB,GACvB,MAAM,sEAAsE,CAAC;AAK9E,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAGhD,OAAO,EAAE,KAAK,EAAE,MAAM,iCAAiC,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACnE,OAAO,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAEnE,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAcvD,MAAM,MAAM,GAAG,SAAS,CAAC,mBAAmB,CAAC,CAAC;AAE9C,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAC9B,MAAM,uBAAuB,GAAG,qBAAqB,CAAC;AACtD,MAAM,oBAAoB,GAAG,0BAA0B,CAAC;AACxD,MAAM,4BAA4B,GAAG,kEAAkE,CAAC;AACxG,MAAM,0BAA0B,GAAG,sCAAsC,CAAC;AAE1E,MAAM,uBAAuB,GAGzB;IACA,OAAO,EAAE,YAAY,CAAC,OAAO;IAC7B,UAAU,EAAE,YAAY,CAAC,UAAU;IACnC,UAAU,EAAE,YAAY,CAAC,WAAW;IACpC,YAAY,EAAE,YAAY,CAAC,aAAa;IACxC,QAAQ,EAAE,YAAY,CAAC,SAAS;IAChC,OAAO,EAAE,YAAY,CAAC,OAAO;IAC7B,eAAe,EAAE,YAAY,CAAC,iBAAiB;IAC/C,WAAW,EAAE,YAAY,CAAC,YAAY;IACtC,SAAS,EAAE,YAAY,CAAC,SAAS;IACjC,UAAU,EAAE,YAAY,CAAC,WAAW;CAGS,CAAC;AA6FlD,MAAM,CAAC,MAAM,wBAAwB,GAAG,UAAU,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACzE,MAAM,iBAAiB,GAAsB,EAAE,CAAC;IAChD,OAAO,iBAAiB,CAAC;AAC7B,CAAC,CAAC,CAAC;AAMH,MAAM,UAAU,yBAAyB,CACrC,kBAAsC,EACtC,YAA0B,EAC1B,SAAoB,EACpB,cAA8B,EAC9B,OAAsB;IAGtB,MAAM,oBAAoB,GAAG,IAAI,GAAG,EAA8B,CAAC;IACnE,KAAK,MAAM,OAAO,IAAI,kBAAkB,EAAE;QACtC,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QAC3E,oBAAoB,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,GAAG,gBAAgB,EAAE,OAAO,CAAC,CAAC,CAAC;KAC/E;IAED,OAAO,yBAAyB,CAAC;QAC7B,GAAG,EAAE,oCAAoC;QACzC,SAAS;QACT,YAAY;QACZ,sBAAsB,CAAC,QAAQ,EAAE,IAAI;;YACjC,OAAO;gBACH,gBAAgB,EAAE,IAAI,GAAG,CAAC;oBAEtB,GAAG,CAAC,MAAA,MAAA,cAAc,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,0CAAE,eAAe,mCAAI,EAAE,CAAC;yBAC9D,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,KAAK,4BAA4B,CAAC;yBACrE,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC;oBAGjE,0BAA0B;iBAC7B,CAAC;aACL,CAAC;QACN,CAAC;QACD,cAAc,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,sBAAsB,EAAE,KAAK,EAAE;;YAKlE,MAAM,EAAE,KAAK,EAAE,GAAG,qBAAqB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAChE,MAAM,CAAC,UAAU,CAAC,GAAG,mBAAmB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAGpD,IAAI,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;gBAAE,OAAO;YAGjD,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,MAAM,CAAC;gBAAE,OAAO;YAE9C,MAAM,UAAU,GAAG,EAAE,MAAM,EAAE,CAAC;YAC9B,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAE,EAAE;gBACvC,OAAO,CAAC,qBAAqB,CACzB,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,UAAU,CAAC,CAC5E,CAAC;YACN,CAAC,CAAC;YAEF,iBAAiB,CAAC,UAAU,CAAC,CAAC;YAE9B,MAAM,gBAAgB,GAAqB;gBACvC,SAAS,EAAE,MAAM;gBACjB,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,UAAU;gBACV,UAAU,EAAE,OAAO,CAAC,QAAQ;aAC/B,CAAC;YAGF,KAAK,MAAM,OAAO,IAAI,MAAA,oBAAoB,CAAC,GAAG,CAAC,MAAM,CAAC,mCAAI,EAAE,EAAE;gBAC1D,IAAI,cAAc,GAAwC,SAAS,CAAC;gBACpE,IAAI;oBACA,cAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;iBACtE;gBAAC,OAAO,KAAK,EAAE;oBACZ,MAAM,CAAC,IAAI,CAAC,6DAA6D,EAAE,KAAK,CAAC,CAAC;iBACrF;gBAED,IAAI,cAAc,EAAE;oBAChB,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;oBAEtC,IAAI,mBAAmB,GAAyC,SAAS,CAAC;oBAC1E,IAAI;wBAEA,mBAAmB,GAAG,cAAc,CAAC,CAAC,QAAQ,EAAE,EAAE;;4BAC9C,iBAAiB,CAAC,WAAW,CAAC,CAAC;4BAE/B,MAAM,YAAY,GAAG,MAAA,uBAAuB,CAAC,QAAQ,CAAC,MAAM,CAAC,mCAAI,YAAY,CAAC,YAAY,CAAC;4BAC3F,MAAM,WAAW,GAAgB;gCAC7B,IAAI,EAAE,iBAAiB;gCACvB,WAAW,EAAE,EAAE;gCACf,WAAW,EAAE,oBAAoB;gCACjC,IAAI,EAAE,QAAQ,CAAC,IAAI;gCACnB,QAAQ,kCACD,QAAQ,CAAC,QAAQ,KACpB,CAAC,uBAAuB,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,GAC3E;6BACJ,CAAC;4BACF,KAAK,CAAC,WAAW,CAAC,CAAC;wBACvB,CAAC,CAAC,CAAC;qBACN;oBAAC,OAAO,KAAK,EAAE;wBACZ,MAAM,CAAC,IAAI,CAAC,qDAAqD,EAAE,KAAK,CAAC,CAAC;qBAC7E;oBAED,IAAI,OAAO,mBAAmB,KAAK,UAAU,EAAE;wBAC3C,sBAAsB,CAAC,GAAG,EAAE;4BACxB,IAAI;gCACA,mBAAoB,EAAE,CAAC;6BAC1B;4BAAC,OAAO,KAAK,EAAE;gCACZ,MAAM,CAAC,IAAI,CAAC,kEAAkE,EAAE,KAAK,CAAC,CAAC;6BAC1F;wBACL,CAAC,CAAC,CAAC;qBACN;oBAED,MAAM;iBACT;aACJ;QACL,CAAC;QACD,oBAAoB,CAAC,KAAK;YAItB,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACpB,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACrG,CAAC;KACJ,CAAC,CAAC;AACP,CAAC","sourcesContent":["import { Injectable } from \"@snap/ts-inject\";\nimport { RemoteApiInfo } from \"../../generated-proto/pb_schema/camera_kit/v3/features/remote_api_info\";\nimport {\n    ResponseCode,\n    responseCodeToNumber,\n} from \"../../generated-proto/pb_schema/lenses/remote_api/remote_api_service\";\nimport type { LensRepository } from \"../../lens/LensRepository\";\nimport type { Lens } from \"../../lens/Lens\";\nimport type { LensState } from \"../../session/lensState\";\nimport type { SessionState } from \"../../session/sessionState\";\nimport { getLogger } from \"../../logger/logger\";\nimport type { EnumToPublicStringLiteralMap, ExcludeKeys } from \"../../common/types\";\nimport type { MetricsClient } from \"../../clients/metricsClient\";\nimport { Count } from \"../../metrics/operational/Count\";\nimport { joinMetricNames } from \"../../metrics/operational/Metric\";\nimport { createUriRequestProcessor } from \"../uriRequestProcessor\";\nimport type { UriHandler, UriResponse } from \"../UriHandlers\";\nimport { extractSchemeAndRoute } from \"../UriHandlers\";\n\n// NOTE: There's potential for overloads when reporting metrics if reporting is triggered on each frame,\n// (i.e., when the lens sends Remote API requests every frame).\n// As of now, this isn't a concern because src/metrics/operational/operationalMetricsReporter.ts aggregates\n// \"count\" metrics into a single metric within a batch, and the Remote API service currently\n// reports only \"count\" metrics. For instance, if 30 metrics with the same name are generated per second,\n// given the current bundle size of 100 operational metrics, there will be one metrics report approximately\n// every 3.3 seconds.\n// In the future, if we opt to report \"histogram\" or other metric types, they must be approached with caution:\n// either the operationalMetricsReporter should be enhanced to aggregate such metrics,\n// or the Remote API service should manage it directly.\n// Mobiles ticket: https://jira.sc-corp.net/browse/CAMKIT-3092\n\nconst logger = getLogger(\"RemoteApiServices\");\n\nconst uriResponseOkCode = 200;\nconst apiResponseStatusHeader = \":sc_lens_api_status\";\nconst apiBinaryContentType = \"application/octet-stream\";\nconst remoteApiInfoProtobufTypeUrl = \"type.googleapis.com/com.snap.camerakit.v3.features.RemoteApiInfo\";\nconst remoteApiUploadImageSpecId = \"af3f69c8-2e62-441f-8b1c-d3956f7b336c\";\n\nconst statusToResponseCodeMap: ExcludeKeys<\n    EnumToPublicStringLiteralMap<typeof ResponseCode>,\n    \"responseCodeUnset\" | \"unrecognized\"\n> = {\n    success: ResponseCode.SUCCESS,\n    redirected: ResponseCode.REDIRECTED,\n    badRequest: ResponseCode.BAD_REQUEST,\n    accessDenied: ResponseCode.ACCESS_DENIED,\n    notFound: ResponseCode.NOT_FOUND,\n    timeout: ResponseCode.TIMEOUT,\n    requestTooLarge: ResponseCode.REQUEST_TOO_LARGE,\n    serverError: ResponseCode.SERVER_ERROR,\n    cancelled: ResponseCode.CANCELLED,\n    proxyError: ResponseCode.PROXY_ERROR,\n    // NOTE: This rule helps keep the public-facing RemoteApiStatus type consistent with the proto.\n    // We prefer using a separate type for TypeDoc purposes.\n} satisfies Record<RemoteApiStatus, ResponseCode>;\n\n/**\n * Status of a Remote API response.\n */\nexport type RemoteApiStatus =\n    | \"success\"\n    | \"redirected\"\n    | \"badRequest\"\n    | \"accessDenied\"\n    | \"notFound\"\n    | \"timeout\"\n    | \"requestTooLarge\"\n    | \"serverError\"\n    | \"cancelled\"\n    | \"proxyError\";\n\n/**\n * Remote API request sent by a lens.\n */\nexport interface RemoteApiRequest {\n    /**\n     * Unique id of the remote API service specification.\n     */\n    apiSpecId: string;\n    /**\n     * Unique id of the remote API service endpoint requested by this request.\n     */\n    endpointId: string;\n    /**\n     * A map of named parameters associated with the request.\n     */\n    parameters: Record<string, string>;\n    /**\n     * Additional binary request payload.\n     */\n    body: ArrayBuffer;\n}\n\n/**\n * Remote API response to a request sent by a lens.\n */\nexport interface RemoteApiResponse {\n    /**\n     * Status of the response\n     */\n    status: RemoteApiStatus;\n    /**\n     * A map of named metadata associated with the response.\n     */\n    metadata: Record<string, string>;\n    /**\n     * Additional binary request payload.\n     */\n    body: ArrayBuffer;\n}\n\n/**\n * Represents a Remote API request cancellation handler function.\n */\nexport type RemoteApiCancelRequestHandler = () => void;\n\n/**\n * Represents a Remote API request handler function.\n * It is provided with a reply callback that must be invoked to send a response back to the lens.\n * The reply callback can be invoked multiple times if needed.\n * Additionally, the handler can return a cancellation callback, which is triggered when the lens cancels the request.\n */\nexport type RemoteApiRequestHandler = (\n    reply: (response: RemoteApiResponse) => void\n) => RemoteApiCancelRequestHandler | void;\n\n/**\n * Service to handle a lens Remote API request.\n */\nexport interface RemoteApiService {\n    /**\n     * Remote API spec ID(s).\n     */\n    apiSpecId: string;\n\n    /**\n     * This method is called by Camera Kit when a lens triggers a Remote API request with a corresponding spec ID.\n     * If the service can handle the request, the method returns a request handler; otherwise, it returns nothing.\n     * @param request Remote API request object.\n     * @param lens Lens that triggers the request.\n     * @returns A request handler if applicable.\n     */\n    getRequestHandler(request: RemoteApiRequest, lens: Lens): RemoteApiRequestHandler | undefined;\n}\n\nexport type RemoteApiServices = RemoteApiService[];\n\nexport const remoteApiServicesFactory = Injectable(\"remoteApiServices\", () => {\n    const remoteApiServices: RemoteApiServices = [];\n    return remoteApiServices;\n});\n\n/**\n * Provides a URI handler that searches for a match within the provided services to handle Remote API requests,\n * i.e., those whose URI starts with 'app://remote-api/performApiRequest'.\n */\nexport function createRemoteApiUriHandler(\n    registeredServices: RemoteApiService[],\n    sessionState: SessionState,\n    lensState: LensState,\n    lensRepository: LensRepository,\n    metrics: MetricsClient\n): UriHandler {\n    // Groups services by spec ID for faster lookups.\n    const registeredServiceMap = new Map<string, RemoteApiService[]>();\n    for (const service of registeredServices) {\n        const existingServices = registeredServiceMap.get(service.apiSpecId) || [];\n        registeredServiceMap.set(service.apiSpecId, [...existingServices, service]);\n    }\n\n    return createUriRequestProcessor({\n        uri: \"app://remote-api/performApiRequest\",\n        lensState,\n        sessionState,\n        createLensRequestState(_request, lens) {\n            return {\n                supportedSpecIds: new Set([\n                    // Parse lens metadata to obtain supported Remote API specs.\n                    ...(lensRepository.getLensMetadata(lens.id)?.featureMetadata ?? [])\n                        .filter((feature) => feature.typeUrl === remoteApiInfoProtobufTypeUrl)\n                        .flatMap((any) => RemoteApiInfo.decode(any.value).apiSpecIds),\n                    // Also add remoteApiUploadImageSpecId as this spec should be available for all lenses.\n                    // See https://jira.sc-corp.net/browse/CAMKIT-6245.\n                    remoteApiUploadImageSpecId,\n                ]),\n            };\n        },\n        processRequest({ request, reply, lens, setCancellationHandler, state }) {\n            // Extracts the spec ID and endpoint ID from the provided Remote API request URI.\n            // The given URI is expected to conform to the following specification:\n            // eslint-disable-next-line max-len\n            // https://docs.google.com/document/d/18fbGYDhD2N_aMTe4ZLY4QKeCSoMeJuklG28TutDzLZc/edit#bookmark=id.p2y39gwgbm4g\n            const { route } = extractSchemeAndRoute(request.uri);\n            const [specId, endpointIdWithQuery] = route.split(\"/\").slice(2);\n            const [endpointId] = endpointIdWithQuery.split(\"?\");\n\n            // only handle requests for API spec ID that current lens supports\n            if (!state?.supportedSpecIds.has(specId)) return;\n\n            // only handle requests if we have a registered service for it\n            if (!registeredServiceMap.has(specId)) return;\n\n            const dimensions = { specId };\n            const reportSingleCount = (name: string) => {\n                metrics.setOperationalMetrics(\n                    Count.count(joinMetricNames([\"lens\", \"remote-api\", name]), 1, dimensions)\n                );\n            };\n\n            reportSingleCount(\"requests\");\n\n            const remoteApiRequest: RemoteApiRequest = {\n                apiSpecId: specId,\n                body: request.data,\n                endpointId,\n                parameters: request.metadata,\n            };\n\n            // Looks for the first Remote API request handler.\n            for (const service of registeredServiceMap.get(specId) ?? []) {\n                let requestHandler: RemoteApiRequestHandler | undefined = undefined;\n                try {\n                    requestHandler = service.getRequestHandler(remoteApiRequest, lens);\n                } catch (error) {\n                    logger.warn(\"Client's Remote API request handler factory threw an error.\", error);\n                }\n\n                if (requestHandler) {\n                    reportSingleCount(\"handled-requests\");\n\n                    let cancellationHandler: RemoteApiCancelRequestHandler | void = undefined;\n                    try {\n                        // Calls client's Remote API handler to process the request.\n                        cancellationHandler = requestHandler((response) => {\n                            reportSingleCount(\"responses\");\n\n                            const responseCode = statusToResponseCodeMap[response.status] ?? ResponseCode.UNRECOGNIZED;\n                            const uriResponse: UriResponse = {\n                                code: uriResponseOkCode,\n                                description: \"\",\n                                contentType: apiBinaryContentType,\n                                data: response.body,\n                                metadata: {\n                                    ...response.metadata,\n                                    [apiResponseStatusHeader]: responseCodeToNumber(responseCode).toString(),\n                                },\n                            };\n                            reply(uriResponse);\n                        });\n                    } catch (error) {\n                        logger.warn(\"Client's Remote API request handler threw an error.\", error);\n                    }\n\n                    if (typeof cancellationHandler === \"function\") {\n                        setCancellationHandler(() => {\n                            try {\n                                cancellationHandler!();\n                            } catch (error) {\n                                logger.warn(\"Client's Remote API request cancellation handler threw an error.\", error);\n                            }\n                        });\n                    }\n\n                    break;\n                }\n            }\n        },\n        processInternalError(error) {\n            // The expectation is that if an error occurs, it happens in our own implementation,\n            // because app callbacks are wrapped with try..catch blocks.\n            // Therefore, we would like to report this error.\n            logger.error(error);\n            metrics.setOperationalMetrics(Count.count(joinMetricNames([\"lens\", \"remote-api\", \"errors\"]), 1));\n        },\n    });\n}\n"]}

package/dist/{extensions → uri-handlers}/uriHandlersRegister.d.ts

@@ -2,21 +2,23 @@ import type { MetricsClient } from "../clients/metricsClient";
 import type { LensKeyboard } from "../session/LensKeyboard";
 import type { LensRepository } from "../lens/LensRepository";
 import type { LensCore } from "../lens-core-module/lensCore";
-import type { RemoteApiServices } from "./RemoteApiServices";
+import type { CameraKitConfiguration } from "../configuration";
+import type { RemoteApiSpecsClient } from "../clients/remoteApiSpecsClient";
 import type { UriHandlers } from "./UriHandlers";
+import type { RemoteApiServices } from "./internal-handlers/remoteApiUriHandler";
 /**
  * Registers URI handlers within LensCore.
  * @internal
  */
 export declare const registerUriHandlers: {
-    (args_0: LensCore, args_1: import("@snap/state-management").StateMachine<import("@snap/state-management").Action<"applyLens", {
+    (args_0: CameraKitConfiguration, args_1: LensCore, args_2: import("@snap/state-management").StateMachine<import("@snap/state-management").Action<"applyLens", {
         lens: import("..").Lens;
         launchData?: import("..").LensLaunchData | undefined;
     }> | import("@snap/state-management").Action<"downloadComplete", import("..").Lens> | import("@snap/state-management").Action<"turnedOn", import("..").Lens> | import("@snap/state-management").Action<"resourcesLoaded", import("..").Lens> | import("@snap/state-management").Action<"firstFrameProcessed", import("..").Lens> | import("@snap/state-management").Action<"applyLensComplete", import("..").Lens> | import("@snap/state-management").Action<"applyLensFailed", {
         error: import("../session/lensState").LensErrors;
         lens: import("..").Lens;
-    }> | import("@snap/state-management").Action<"applyLensAborted", import("..").Lens> | import("@snap/state-management").Action<"removeLens", undefined> | import("@snap/state-management").Action<"turnedOff", import("..").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", import("..").Lens> | import("@snap/state-management").State<"lensApplied", import("..").Lens>>, args_2: UriHandlers, args_3: LensKeyboard, args_4: RemoteApiServices, args_5: LensRepository, args_6: import("@snap/state-management").StateMachine<import("@snap/state-management").Action<"suspend", import("../session/CameraKitSession").CameraKitSession> | import("@snap/state-management").Action<"resume", import("../session/CameraKitSession").CameraKitSession> | import("@snap/state-management").Action<"destroy", undefined>, import("@snap/state-management").State<"inactive", undefined> | import("@snap/state-management").State<"active", import("../session/CameraKitSession").CameraKitSession> | import("@snap/state-management").State<"destroyed", undefined>>, args_7: MetricsClient): void;
+    }> | import("@snap/state-management").Action<"applyLensAborted", import("..").Lens> | import("@snap/state-management").Action<"removeLens", undefined> | import("@snap/state-management").Action<"turnedOff", import("..").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", import("..").Lens> | import("@snap/state-management").State<"lensApplied", import("..").Lens>>, args_3: UriHandlers, args_4: LensKeyboard, args_5: RemoteApiServices, args_6: LensRepository, args_7: import("@snap/state-management").StateMachine<import("@snap/state-management").Action<"suspend", import("../session/CameraKitSession").CameraKitSession> | import("@snap/state-management").Action<"resume", import("../session/CameraKitSession").CameraKitSession> | import("@snap/state-management").Action<"destroy", undefined>, import("@snap/state-management").State<"inactive", undefined> | import("@snap/state-management").State<"active", import("../session/CameraKitSession").CameraKitSession> | import("@snap/state-management").State<"destroyed", undefined>>, args_8: MetricsClient, args_9: RemoteApiSpecsClient): void;
     token: "registerUriHandlers";
-    dependencies: readonly ["lensCore", "lensState", "UriHandlers", "lensKeyboard", "remoteApiServices", "LensRepository", "sessionState", "metricsClient"];
+    dependencies: readonly ["configuration", "lensCore", "lensState", "UriHandlers", "lensKeyboard", "remoteApiServices", "LensRepository", "sessionState", "metricsClient", "remoteApiSpecsClient"];
 };
 //# sourceMappingURL=uriHandlersRegister.d.ts.map

package/dist/uri-handlers/uriHandlersRegister.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uriHandlersRegister.d.ts","sourceRoot":"","sources":["../../src/uri-handlers/uriHandlersRegister.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAE9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAI5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAM7D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAE/D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAG5E,OAAO,KAAK,EAAE,WAAW,EAAe,MAAM,eAAe,CAAC;AAE9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yCAAyC,CAAC;AAKjF;;;GAGG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;CAsF/B,CAAC"}