@snap/camera-kit 0.16.2 → 0.18.0

package/lib/extensions/RemoteApiServices.js

@@ -1,203 +0,0 @@
-import { Subject, catchError, filter, map, merge, retry, takeUntil, tap } from "rxjs";
-import { forActions } from "@snap/state-management";
-import { Injectable } from "../dependency-injection/Injectable";
-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 { extractSchemeAndRoute } from "./UriHandlers";
-// NOTE: There's potential for overloads when reporting metrics if reporting is triggered on each frame,
-// (i.e., when the lens sends Remote API requests every frame).
-// As of now, this isn't a concern because src/metrics/operational/operationalMetricsReporter.ts aggregates
-// "count" metrics into a single metric within a batch, and the Remote API service currently
-// reports only "count" metrics. For instance, if 30 metrics with the same name are generated per second,
-// given the current bundle size of 100 operational metrics, there will be one metrics report approximately
-// every 3.3 seconds.
-// In the future, if we opt to report "histogram" or other metric types, they must be approached with caution:
-// either the operationalMetricsReporter should be enhanced to aggregate such metrics,
-// or the Remote API service should manage it directly.
-// Mobiles ticket: https://jira.sc-corp.net/browse/CAMKIT-3092
-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 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,
-};
-/**
- * Invokes the cancellation handler associated with the provided key and removes it from the collection of handlers.
- */
-function callCancellationHandler(cancellationHandlers, ...keys) {
-    var _a;
-    for (const key of keys) {
-        (_a = cancellationHandlers.get(key)) === null || _a === void 0 ? void 0 : _a();
-        cancellationHandlers.delete(key);
-    }
-}
-/**
- * Removes the specified lenses' metadata from the cache and invokes their cancellation callbacks.
- *
- * @param lensRequestState The state representing the lens cache.
- * @param lensIds An array of lens IDs to be removed from the cache
- * and for which the cancellation callbacks will be invoked.
- */
-function handleLensApplicationEnd(lensRequestState, ...lensIds) {
-    for (const lensId of lensIds) {
-        const state = lensRequestState.get(lensId);
-        if (state) {
-            callCancellationHandler(state.cancellationHandlers, ...state.cancellationHandlers.keys());
-            lensRequestState.delete(lensId);
-        }
-    }
-}
-export const remoteApiServicesFactory = Injectable("remoteApiServices", () => {
-    const remoteApiServices = [];
-    return remoteApiServices;
-});
-/**
- * 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 function getRemoteApiUriHandler(registeredServices, sessionState, lensState, lensRepository, metrics) {
-    // Groups services by spec ID for faster lookups.
-    const registeredServiceMap = new Map();
-    for (const service of registeredServices) {
-        const existingServices = registeredServiceMap.get(service.apiSpecId) || [];
-        registeredServiceMap.set(service.apiSpecId, [...existingServices, service]);
-    }
-    const uriRequests = new Subject();
-    const uriCancelRequests = new Subject();
-    const lensRequestState = new Map();
-    const lensTurnOffEvents = lensState.events.pipe(forActions("turnedOff"), tap(([action]) => handleLensApplicationEnd(lensRequestState, action.data.id)));
-    const uriRequestEvents = uriRequests.pipe(map((uriRequest) => {
-        var _a, _b;
-        const lensId = uriRequest.lens.id;
-        if (!lensRequestState.has(lensId)) {
-            lensRequestState.set(lensId, {
-                // Prepares a collection to store cancellation handlers.
-                // A specific handler will be invoked when a cancellation request is issued by the lens.
-                // All handlers will be invoked when the lens is replaced with another one or the session
-                // is destroyed.
-                cancellationHandlers: new Map(),
-                // Parse lens metadata to obtain supported Remote API specs.
-                supportedSpecIds: new Set(((_b = (_a = lensRepository.getLensMetadata(lensId)) === 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)),
-            });
-        }
-        const requestState = lensRequestState.get(lensId);
-        // Extracts the spec ID and endpoint ID from the provided Remote API request URI.
-        // The given URI is expected to conform to the following specification:
-        // eslint-disable-next-line max-len
-        // https://docs.google.com/document/d/18fbGYDhD2N_aMTe4ZLY4QKeCSoMeJuklG28TutDzLZc/edit#bookmark=id.p2y39gwgbm4g
-        const { route } = extractSchemeAndRoute(uriRequest.request.uri);
-        const [specId, endpointIdWithQuery] = route.split("/").slice(2);
-        const [endpointId] = endpointIdWithQuery.split("?");
-        return { uriRequest, specId, endpointId, requestState };
-    }), 
-    // only handle requests for API spec ID that current lens supports
-    filter(({ specId, requestState }) => requestState.supportedSpecIds.has(specId)), 
-    // only handle requests if we have a registered service for it
-    filter(({ specId }) => registeredServiceMap.has(specId)), map(({ uriRequest, specId, endpointId, requestState }) => {
-        var _a;
-        const dimensions = { specId };
-        const reportSingleCount = (name) => {
-            metrics.setOperationalMetrics(Count.count(joinMetricNames(["lens", "remote-api", name]), 1, dimensions));
-        };
-        reportSingleCount("requests");
-        const remoteApiRequest = {
-            apiSpecId: specId,
-            body: uriRequest.request.data,
-            endpointId,
-            parameters: uriRequest.request.metadata,
-        };
-        // Looks for the first Remote API request handler.
-        for (const service of (_a = registeredServiceMap.get(specId)) !== null && _a !== void 0 ? _a : []) {
-            let requestHandler = undefined;
-            try {
-                requestHandler = service.getRequestHandler(remoteApiRequest, uriRequest.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 {
-                    // Calls client's Remote API handler to process the request.
-                    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() }),
-                        };
-                        uriRequest.reply(uriResponse);
-                    });
-                }
-                catch (error) {
-                    logger.warn("Client's Remote API request handler threw an error.", error);
-                }
-                if (typeof cancellationHandler === "function") {
-                    requestState.cancellationHandlers.set(uriRequest.request.identifier, () => {
-                        try {
-                            cancellationHandler();
-                        }
-                        catch (error) {
-                            logger.warn("Client's Remote API request cancellation handler threw an error.", error);
-                        }
-                    });
-                }
-                break;
-            }
-        }
-    }));
-    const uriCancelRequestEvents = uriCancelRequests.pipe(tap((uriRequest) => {
-        var _a;
-        const cancellationHandlers = (_a = lensRequestState.get(uriRequest.lens.id)) === null || _a === void 0 ? void 0 : _a.cancellationHandlers;
-        if (cancellationHandlers) {
-            callCancellationHandler(cancellationHandlers, uriRequest.request.requestId);
-        }
-    }));
-    merge(lensTurnOffEvents, uriRequestEvents, uriCancelRequestEvents)
-        .pipe(catchError((error, sourcePipe) => {
-        // The expectation is that if an error occurs, it happens in our own implementation,
-        // because app callbacks are wrapped with try..catch blocks.
-        // Therefore, we would like to report this error.
-        logger.error(error);
-        metrics.setOperationalMetrics(Count.count(joinMetricNames(["lens", "remote-api", "errors"]), 1));
-        // Return the source pipe so that we can retry the pipe instead of just completing it.
-        return sourcePipe;
-    }), 
-    // When the pipe completes due to an error,
-    // we want to resubscribe to the original pipe to keep it alive.
-    retry(), takeUntil(sessionState.events.pipe(forActions("destroy"))))
-        .subscribe({
-        complete: () => handleLensApplicationEnd(lensRequestState, ...lensRequestState.keys()),
-    });
-    return {
-        uri: "app://remote-api/performApiRequest",
-        handleRequest(request, reply, lens) {
-            uriRequests.next({ request, reply, lens });
-        },
-        cancelRequest(request, lens) {
-            uriCancelRequests.next({ request, lens });
-        },
-    };
-}
-//# sourceMappingURL=RemoteApiServices.js.map

package/lib/extensions/RemoteApiServices.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"RemoteApiServices.js","sourceRoot":"","sources":["../../src/extensions/RemoteApiServices.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AACtF,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,qEAAqE,CAAC;AACpG,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,mEAAmE,CAAC;AAKvH,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAG7C,OAAO,EAAE,KAAK,EAAE,MAAM,8BAA8B,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAyD,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAE7G,wGAAwG;AACxG,+DAA+D;AAC/D,2GAA2G;AAC3G,4FAA4F;AAC5F,yGAAyG;AACzG,2GAA2G;AAC3G,qBAAqB;AACrB,8GAA8G;AAC9G,sFAAsF;AACtF,uDAAuD;AACvD,8DAA8D;AAE9D,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;AAExG,MAAM,uBAAuB,GAAG;IAC5B,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;CACgD,CAAC;AAyBzF;;GAEG;AACH,SAAS,uBAAuB,CAC5B,oBAAmE,EACnE,GAAG,IAAiB;;IAEpB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACpB,MAAA,oBAAoB,CAAC,GAAG,CAAC,GAAG,CAAC,2CAAI,CAAC;QAClC,oBAAoB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;KACpC;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAS,wBAAwB,CAAC,gBAA+C,EAAE,GAAG,OAAiB;IACnG,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;QAC1B,MAAM,KAAK,GAAG,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC3C,IAAI,KAAK,EAAE;YACP,uBAAuB,CAAC,KAAK,CAAC,oBAAoB,EAAE,GAAG,KAAK,CAAC,oBAAoB,CAAC,IAAI,EAAE,CAAC,CAAC;YAC1F,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SACnC;KACJ;AACL,CAAC;AAmFD,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;AAEH;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CAClC,kBAAsC,EACtC,YAA0B,EAC1B,SAAoB,EACpB,cAA8B,EAC9B,OAAsB;IAEtB,iDAAiD;IACjD,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,MAAM,WAAW,GAAG,IAAI,OAAO,EAAmB,CAAC;IACnD,MAAM,iBAAiB,GAAG,IAAI,OAAO,EAAyB,CAAC;IAC/D,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAA4B,CAAC;IAE7D,MAAM,iBAAiB,GAAG,SAAS,CAAC,MAAM,CAAC,IAAI,CAC3C,UAAU,CAAC,WAAW,CAAC,EAEvB,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,wBAAwB,CAAC,gBAAgB,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAChF,CAAC;IAEF,MAAM,gBAAgB,GAAG,WAAW,CAAC,IAAI,CACrC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;;QACf,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QAElC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAC/B,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE;gBACzB,wDAAwD;gBACxD,wFAAwF;gBACxF,yFAAyF;gBACzF,gBAAgB;gBAChB,oBAAoB,EAAE,IAAI,GAAG,EAAE;gBAC/B,4DAA4D;gBAC5D,gBAAgB,EAAE,IAAI,GAAG,CACrB,CAAC,MAAA,MAAA,cAAc,CAAC,eAAe,CAAC,MAAM,CAAC,0CAAE,eAAe,mCAAI,EAAE,CAAC;qBAC1D,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,KAAK,4BAA4B,CAAC;qBACrE,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,CACpE;aACJ,CAAC,CAAC;SACN;QACD,MAAM,YAAY,GAAG,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC;QAEnD,iFAAiF;QACjF,uEAAuE;QACvE,mCAAmC;QACnC,gHAAgH;QAChH,MAAM,EAAE,KAAK,EAAE,GAAG,qBAAqB,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAChE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAChE,MAAM,CAAC,UAAU,CAAC,GAAG,mBAAmB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEpD,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC;IAC5D,CAAC,CAAC;IAEF,kEAAkE;IAClE,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC,YAAY,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAE/E,8DAA8D;IAC9D,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,oBAAoB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAExD,GAAG,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,EAAE,EAAE;;QACrD,MAAM,UAAU,GAAG,EAAE,MAAM,EAAE,CAAC;QAC9B,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAE,EAAE;YACvC,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;QACN,CAAC,CAAC;QAEF,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAE9B,MAAM,gBAAgB,GAAqB;YACvC,SAAS,EAAE,MAAM;YACjB,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,IAAI;YAC7B,UAAU;YACV,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,QAAQ;SAC1C,CAAC;QAEF,kDAAkD;QAClD,KAAK,MAAM,OAAO,IAAI,MAAA,oBAAoB,CAAC,GAAG,CAAC,MAAM,CAAC,mCAAI,EAAE,EAAE;YAC1D,IAAI,cAAc,GAAwC,SAAS,CAAC;YACpE,IAAI;gBACA,cAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;aACjF;YAAC,OAAO,KAAK,EAAE;gBACZ,MAAM,CAAC,IAAI,CAAC,6DAA6D,EAAE,KAAK,CAAC,CAAC;aACrF;YAED,IAAI,cAAc,EAAE;gBAChB,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;gBAEtC,IAAI,mBAAmB,GAAyC,SAAS,CAAC;gBAC1E,IAAI;oBACA,4DAA4D;oBAC5D,mBAAmB,GAAG,cAAc,CAAC,CAAC,QAAQ,EAAE,EAAE;;wBAC9C,iBAAiB,CAAC,WAAW,CAAC,CAAC;wBAE/B,MAAM,YAAY,GAAG,MAAA,uBAAuB,CAAC,QAAQ,CAAC,MAAM,CAAC,mCAAI,YAAY,CAAC,YAAY,CAAC;wBAC3F,MAAM,WAAW,GAAgB;4BAC7B,IAAI,EAAE,iBAAiB;4BACvB,WAAW,EAAE,EAAE;4BACf,WAAW,EAAE,oBAAoB;4BACjC,IAAI,EAAE,QAAQ,CAAC,IAAI;4BACnB,QAAQ,kCACD,QAAQ,CAAC,QAAQ,KACpB,CAAC,uBAAuB,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,GAC3E;yBACJ,CAAC;wBACF,UAAU,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;oBAClC,CAAC,CAAC,CAAC;iBACN;gBAAC,OAAO,KAAK,EAAE;oBACZ,MAAM,CAAC,IAAI,CAAC,qDAAqD,EAAE,KAAK,CAAC,CAAC;iBAC7E;gBAED,IAAI,OAAO,mBAAmB,KAAK,UAAU,EAAE;oBAC3C,YAAY,CAAC,oBAAoB,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,EAAE;wBACtE,IAAI;4BACA,mBAAoB,EAAE,CAAC;yBAC1B;wBAAC,OAAO,KAAK,EAAE;4BACZ,MAAM,CAAC,IAAI,CAAC,kEAAkE,EAAE,KAAK,CAAC,CAAC;yBAC1F;oBACL,CAAC,CAAC,CAAC;iBACN;gBAED,MAAM;aACT;SACJ;IACL,CAAC,CAAC,CACL,CAAC;IAEF,MAAM,sBAAsB,GAAG,iBAAiB,CAAC,IAAI,CACjD,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;;QACf,MAAM,oBAAoB,GAAG,MAAA,gBAAgB,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,0CAAE,oBAAoB,CAAC;QAC5F,IAAI,oBAAoB,EAAE;YACtB,uBAAuB,CAAC,oBAAoB,EAAE,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;SAC/E;IACL,CAAC,CAAC,CACL,CAAC;IAEF,KAAK,CAAC,iBAAiB,EAAE,gBAAgB,EAAE,sBAAsB,CAAC;SAC7D,IAAI,CACD,UAAU,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;QAC7B,oFAAoF;QACpF,4DAA4D;QAC5D,iDAAiD;QACjD,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACpB,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACjG,sFAAsF;QACtF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;IACF,2CAA2C;IAC3C,gEAAgE;IAChE,KAAK,EAAE,EACP,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAC7D;SACA,SAAS,CAAC;QACP,QAAQ,EAAE,GAAG,EAAE,CAAC,wBAAwB,CAAC,gBAAgB,EAAE,GAAG,gBAAgB,CAAC,IAAI,EAAE,CAAC;KACzF,CAAC,CAAC;IAEP,OAAO;QACH,GAAG,EAAE,oCAAoC;QAEzC,aAAa,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI;YAC9B,WAAW,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/C,CAAC;QAED,aAAa,CAAC,OAAO,EAAE,IAAI;YACvB,iBAAiB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9C,CAAC;KACJ,CAAC;AACN,CAAC","sourcesContent":["import { Subject, catchError, filter, map, merge, retry, takeUntil, tap } from \"rxjs\";\nimport { forActions } from \"@snap/state-management\";\nimport { Injectable } from \"../dependency-injection/Injectable\";\nimport { RemoteApiInfo } from \"../generated-proto/pb_schema/camera_kit/v3/features/remote_api_info\";\nimport { ResponseCode, responseCodeToNumber } from \"../generated-proto/pb_schema/lenses/remote_api/remote_api_service\";\nimport { LensRepository } from \"../lens/LensRepository\";\nimport { Lens } from \"../lens/Lens\";\nimport { LensState } from \"../session/lensState\";\nimport { SessionState } from \"../session/sessionState\";\nimport { getLogger } from \"../logger/logger\";\nimport { CamelToSnakeCase, SnakeToCamelCase } from \"../common/types\";\nimport { MetricsClient } from \"../clients/metricsClient\";\nimport { Count } from \"../metrics/operational/Count\";\nimport { joinMetricNames } from \"../metrics/operational/Metric\";\nimport { UriCancelRequest, UriHandler, UriRequest, UriResponse, 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\";\n\nconst statusToResponseCodeMap = {\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} satisfies { [Status in RemoteApiStatusInternal]: Uppercase<CamelToSnakeCase<Status>> };\n\ntype RemoteApiStatusInternal = SnakeToCamelCase<\n    Lowercase<Exclude<keyof typeof ResponseCode, \"RESPONSE_CODE_UNSET\" | \"UNRECOGNIZED\">>\n>;\n\ntype LensId = string;\ntype RequestId = string;\n\ntype UriRequestEvent = {\n    request: UriRequest;\n    reply: (response: UriResponse) => void;\n    lens: Lens;\n};\n\ntype UriCancelRequestEvent = {\n    request: UriCancelRequest;\n    lens: Lens;\n};\n\ninterface LensRequestState {\n    cancellationHandlers: Map<RequestId, RemoteApiCancelRequestHandler>;\n    supportedSpecIds: Set<string>;\n}\n\n/**\n * Invokes the cancellation handler associated with the provided key and removes it from the collection of handlers.\n */\nfunction callCancellationHandler(\n    cancellationHandlers: Map<RequestId, RemoteApiCancelRequestHandler>,\n    ...keys: RequestId[]\n) {\n    for (const key of keys) {\n        cancellationHandlers.get(key)?.();\n        cancellationHandlers.delete(key);\n    }\n}\n\n/**\n * Removes the specified lenses' metadata from the cache and invokes their cancellation callbacks.\n *\n * @param lensRequestState The state representing the lens cache.\n * @param lensIds An array of lens IDs to be removed from the cache\n * and for which the cancellation callbacks will be invoked.\n */\nfunction handleLensApplicationEnd(lensRequestState: Map<LensId, LensRequestState>, ...lensIds: LensId[]) {\n    for (const lensId of lensIds) {\n        const state = lensRequestState.get(lensId);\n        if (state) {\n            callCancellationHandler(state.cancellationHandlers, ...state.cancellationHandlers.keys());\n            lensRequestState.delete(lensId);\n        }\n    }\n}\n\n/**\n * Status of a Remote API response.\n */\nexport type RemoteApiStatus = keyof typeof statusToResponseCodeMap;\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 trigges 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 getRemoteApiUriHandler(\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    const uriRequests = new Subject<UriRequestEvent>();\n    const uriCancelRequests = new Subject<UriCancelRequestEvent>();\n    const lensRequestState = new Map<LensId, LensRequestState>();\n\n    const lensTurnOffEvents = lensState.events.pipe(\n        forActions(\"turnedOff\"),\n\n        tap(([action]) => handleLensApplicationEnd(lensRequestState, action.data.id))\n    );\n\n    const uriRequestEvents = uriRequests.pipe(\n        map((uriRequest) => {\n            const lensId = uriRequest.lens.id;\n\n            if (!lensRequestState.has(lensId)) {\n                lensRequestState.set(lensId, {\n                    // Prepares a collection to store cancellation handlers.\n                    // A specific handler will be invoked when a cancellation request is issued by the lens.\n                    // All handlers will be invoked when the lens is replaced with another one or the session\n                    // is destroyed.\n                    cancellationHandlers: new Map(),\n                    // Parse lens metadata to obtain supported Remote API specs.\n                    supportedSpecIds: new Set(\n                        (lensRepository.getLensMetadata(lensId)?.featureMetadata ?? [])\n                            .filter((feature) => feature.typeUrl === remoteApiInfoProtobufTypeUrl)\n                            .flatMap((any) => RemoteApiInfo.decode(any.value).apiSpecIds)\n                    ),\n                });\n            }\n            const requestState = lensRequestState.get(lensId)!;\n\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(uriRequest.request.uri);\n            const [specId, endpointIdWithQuery] = route.split(\"/\").slice(2);\n            const [endpointId] = endpointIdWithQuery.split(\"?\");\n\n            return { uriRequest, specId, endpointId, requestState };\n        }),\n\n        // only handle requests for API spec ID that current lens supports\n        filter(({ specId, requestState }) => requestState.supportedSpecIds.has(specId)),\n\n        // only handle requests if we have a registered service for it\n        filter(({ specId }) => registeredServiceMap.has(specId)),\n\n        map(({ uriRequest, specId, endpointId, requestState }) => {\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: uriRequest.request.data,\n                endpointId,\n                parameters: uriRequest.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, uriRequest.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                            uriRequest.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                        requestState.cancellationHandlers.set(uriRequest.request.identifier, () => {\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    );\n\n    const uriCancelRequestEvents = uriCancelRequests.pipe(\n        tap((uriRequest) => {\n            const cancellationHandlers = lensRequestState.get(uriRequest.lens.id)?.cancellationHandlers;\n            if (cancellationHandlers) {\n                callCancellationHandler(cancellationHandlers, uriRequest.request.requestId);\n            }\n        })\n    );\n\n    merge(lensTurnOffEvents, uriRequestEvents, uriCancelRequestEvents)\n        .pipe(\n            catchError((error, sourcePipe) => {\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                // Return the source pipe so that we can retry the pipe instead of just completing it.\n                return sourcePipe;\n            }),\n            // When the pipe completes due to an error,\n            // we want to resubscribe to the original pipe to keep it alive.\n            retry(),\n            takeUntil(sessionState.events.pipe(forActions(\"destroy\")))\n        )\n        .subscribe({\n            complete: () => handleLensApplicationEnd(lensRequestState, ...lensRequestState.keys()),\n        });\n\n    return {\n        uri: \"app://remote-api/performApiRequest\",\n\n        handleRequest(request, reply, lens) {\n            uriRequests.next({ request, reply, lens });\n        },\n\n        cancelRequest(request, lens) {\n            uriCancelRequests.next({ request, lens });\n        },\n    };\n}\n"]}

package/lib/extensions/UriHandlers.d.ts

@@ -1,47 +0,0 @@
-import { Uri, UriCancelRequest, UriRequest, UriResponse } from "../lens-core-module/generated-types";
-import { Lens } from "../lens/Lens";
-export declare function extractSchemeAndRoute(uri: Uri): {
-    scheme: string;
-    route: string;
-};
-export declare function isUriHandlers(value: unknown): value is UriHandlers;
-export declare function isUriResponse(value: unknown): value is UriResponse;
-/**
- * Provides a way for a lens to call into external services that work under HTTP-like protocol.
- * @internal
- */
-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.
- * @internal
- */
-export type UriHandlers = UriHandler[];
-/**
- * An extension point for client URI handlers.
- * @internal
- */
-export declare const uriHandlersFactory: {
-    (): UriHandlers;
-    token: "UriHandlers";
-    dependencies: [];
-};
-export { Uri, UriCancelRequest, UriRequest, UriResponse } from "../lens-core-module/generated-types";

package/lib/extensions/UriHandlers.js

@@ -1,38 +0,0 @@
-import { isArrayBuffer, isArrayOfType, isFunction, isNumber, isRecord, isString, isTypedArray, isUndefined, predicateRecordValues, } from "../common/typeguards";
-import { Injectable } from "../dependency-injection/Injectable";
-const SEPARATOR = "://";
-export 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)));
-}
-export function isUriHandlers(value) {
-    return isArrayOfType(isUriHandler, value);
-}
-export 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.
- * @internal
- */
-export const uriHandlersFactory = Injectable("UriHandlers", () => {
-    const uriHandlers = [];
-    return uriHandlers;
-});
-//# sourceMappingURL=UriHandlers.js.map

package/lib/extensions/UriHandlers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"UriHandlers.js","sourceRoot":"","sources":["../../src/extensions/UriHandlers.ts"],"names":[],"mappings":"AAAA,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;AAIhE,MAAM,SAAS,GAAG,KAAK,CAAC;AAExB,MAAM,UAAU,qBAAqB,CAAC,GAAQ;IAC1C,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,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;AAC7B,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,MAAM,UAAU,aAAa,CAAC,KAAc;IACxC,OAAO,aAAa,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,KAAc;IACxC,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;AAmCD;;;GAGG;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","sourcesContent":["import {\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 { Uri, UriCancelRequest, UriRequest, UriResponse } from \"../lens-core-module/generated-types\";\nimport { Lens } from \"../lens/Lens\";\n\nconst SEPARATOR = \"://\";\n\nexport function 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\nexport function isUriHandlers(value: unknown): value is UriHandlers {\n    return isArrayOfType(isUriHandler, value);\n}\n\nexport function 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 * @internal\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 * @internal\n */\nexport type UriHandlers = UriHandler[];\n\n/**\n * An extension point for client URI handlers.\n * @internal\n */\nexport const uriHandlersFactory = Injectable(\"UriHandlers\", () => {\n    const uriHandlers: UriHandlers = [];\n    return uriHandlers;\n});\n\nexport { Uri, UriCancelRequest, UriRequest, UriResponse } from \"../lens-core-module/generated-types\";\n"]}

package/lib/extensions/extensionRequestContext.d.ts

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

package/lib/extensions/extensionRequestContext.js

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

package/lib/extensions/extensionRequestContext.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"extensionRequestContext.js","sourceRoot":"","sources":["../../src/extensions/extensionRequestContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AACvE,OAAO,EAAE,uBAAuB,EAAE,MAAM,mDAAmD,CAAC;AAC5F,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAE3D,SAAS,0BAA0B;IAC/B,OAAO,uBAAuB,CAAC,MAAM,CAAC;QAClC,SAAS,EAAE,qBAAqB,EAAE;QAClC,MAAM,EAAE,eAAe,EAAE,CAAC,UAAU;KACvC,CAAC,CAAC,MAAM,EAAE,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,0BAA0B,EAAE,CAAC","sourcesContent":["import { getCameraKitUserAgent } from \"../platform/cameraKitUserAgent\";\nimport { ExtensionRequestContext } from \"../generated-proto/pb_schema/camera_kit/v3/export\";\nimport { getPlatformInfo } from \"../platform/platformInfo\";\n\nfunction getExtensionRequestContext(): ArrayBuffer {\n    return ExtensionRequestContext.encode({\n        userAgent: getCameraKitUserAgent(),\n        locale: getPlatformInfo().fullLocale,\n    }).finish();\n}\n\n/**\n * Extension request context.\n */\nexport const extensionRequestContext = getExtensionRequestContext();\n"]}

package/lib/extensions/uriHandlersRegister.d.ts

@@ -1,21 +0,0 @@
-import { MetricsClient } from "../clients/metricsClient";
-import { LensKeyboard } from "../session/LensKeyboard";
-import { LensRepository } from "../lens/LensRepository";
-import { LensCore } from "../lens-core-module/lensCore";
-import { RemoteApiServices } from "./RemoteApiServices";
-import { UriHandlers } from "./UriHandlers";
-/**
- * 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", {
-        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("..").CameraKitSession> | import("@snap/state-management").Action<"resume", import("..").CameraKitSession> | import("@snap/state-management").Action<"destroy", undefined>, import("@snap/state-management").State<"inactive", undefined> | import("@snap/state-management").State<"active", import("..").CameraKitSession> | import("@snap/state-management").State<"destroyed", undefined>>, args_7: MetricsClient): void;
-    token: "registerUriHandlers";
-    dependencies: readonly ["lensCore", "lensState", "UriHandlers", "lensKeyboard", "remoteApiServices", "LensRepository", "sessionState", "metricsClient"];
-};

package/lib/extensions/uriHandlersRegister.js

@@ -1,72 +0,0 @@
-import { isState } from "@snap/state-management";
-import { metricsClientFactory } from "../clients/metricsClient";
-import { Injectable } from "../dependency-injection/Injectable";
-import { lensKeyboardFactory } from "../session/LensKeyboard";
-import { lensStateFactory } from "../session/lensState";
-import { lensRepositoryFactory } from "../lens/LensRepository";
-import { sessionStateFactory } from "../session/sessionState";
-import { getLogger } from "../logger/logger";
-import { lensCoreFactory } from "../lens-core-module/loader/lensCoreFactory";
-import { getRemoteApiUriHandler, remoteApiServicesFactory } from "./RemoteApiServices";
-import { extractSchemeAndRoute, isUriHandlers, isUriResponse, uriHandlersFactory, } from "./UriHandlers";
-const logger = getLogger("uriHandlersRegister");
-/**
- * Registers URI handlers within LensCore.
- * @internal
- */
-export const registerUriHandlers = Injectable("registerUriHandlers", [
-    lensCoreFactory.token,
-    lensStateFactory.token,
-    uriHandlersFactory.token,
-    lensKeyboardFactory.token,
-    remoteApiServicesFactory.token,
-    lensRepositoryFactory.token,
-    sessionStateFactory.token,
-    metricsClientFactory.token,
-], (lensCore, lensState, userHandlers, lensKeyboard, remoteApiServices, lensRepository, sessionState, metrics) => {
-    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 (lens keyboard and Remote API) before registering handlers with LensCore.
-    const allHandlers = userHandlers.concat(lensKeyboard.uriHandler, getRemoteApiUriHandler(remoteApiServices, sessionState, lensState, lensRepository, metrics));
-    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=uriHandlersRegister.js.map

package/lib/extensions/uriHandlersRegister.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"uriHandlersRegister.js","sourceRoot":"","sources":["../../src/extensions/uriHandlersRegister.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAiB,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAC/E,OAAO,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAChE,OAAO,EAAgB,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC5E,OAAO,EAAa,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACnE,OAAO,EAAkB,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAC/E,OAAO,EAAgB,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,4CAA4C,CAAC;AAE7E,OAAO,EAAqB,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAC1G,OAAO,EAGH,qBAAqB,EACrB,aAAa,EACb,aAAa,EACb,kBAAkB,GACrB,MAAM,eAAe,CAAC;AAEvB,MAAM,MAAM,GAAG,SAAS,CAAC,qBAAqB,CAAC,CAAC;AAEhD;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,UAAU,CACzC,qBAAqB,EACrB;IACI,eAAe,CAAC,KAAK;IACrB,gBAAgB,CAAC,KAAK;IACtB,kBAAkB,CAAC,KAAK;IACxB,mBAAmB,CAAC,KAAK;IACzB,wBAAwB,CAAC,KAAK;IAC9B,qBAAqB,CAAC,KAAK;IAC3B,mBAAmB,CAAC,KAAK;IACzB,oBAAoB,CAAC,KAAK;CACpB,EACV,CACI,QAAkB,EAClB,SAAoB,EACpB,YAAyB,EACzB,YAA0B,EAC1B,iBAAoC,EACpC,cAA8B,EAC9B,YAA0B,EAC1B,OAAsB,EAClB,EAAE;IACN,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE;QAC9B,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;KAC9D;IAED,8GAA8G;IAC9G,qFAAqF;IACrF,MAAM,WAAW,GAAG,YAAY,CAAC,MAAM,CACnC,YAAY,CAAC,UAAU,EACvB,sBAAsB,CAAC,iBAAiB,EAAE,YAAY,EAAE,SAAS,EAAE,cAAc,EAAE,OAAO,CAAC,CAC9F,CAAC;IAEF,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,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,qBAAqB,CAAC,EAAE;YAC7D,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 { MetricsClient, metricsClientFactory } from \"../clients/metricsClient\";\nimport { Injectable } from \"../dependency-injection/Injectable\";\nimport { LensKeyboard, lensKeyboardFactory } from \"../session/LensKeyboard\";\nimport { LensState, lensStateFactory } from \"../session/lensState\";\nimport { LensRepository, lensRepositoryFactory } from \"../lens/LensRepository\";\nimport { SessionState, sessionStateFactory } from \"../session/sessionState\";\nimport { getLogger } from \"../logger/logger\";\nimport { lensCoreFactory } from \"../lens-core-module/loader/lensCoreFactory\";\nimport { LensCore } from \"../lens-core-module/lensCore\";\nimport { RemoteApiServices, getRemoteApiUriHandler, remoteApiServicesFactory } from \"./RemoteApiServices\";\nimport {\n    UriHandlers,\n    UriResponse,\n    extractSchemeAndRoute,\n    isUriHandlers,\n    isUriResponse,\n    uriHandlersFactory,\n} from \"./UriHandlers\";\n\nconst logger = getLogger(\"uriHandlersRegister\");\n\n/**\n * Registers URI handlers within LensCore.\n * @internal\n */\nexport const registerUriHandlers = Injectable(\n    \"registerUriHandlers\",\n    [\n        lensCoreFactory.token,\n        lensStateFactory.token,\n        uriHandlersFactory.token,\n        lensKeyboardFactory.token,\n        remoteApiServicesFactory.token,\n        lensRepositoryFactory.token,\n        sessionStateFactory.token,\n        metricsClientFactory.token,\n    ] as const,\n    (\n        lensCore: LensCore,\n        lensState: LensState,\n        userHandlers: UriHandlers,\n        lensKeyboard: LensKeyboard,\n        remoteApiServices: RemoteApiServices,\n        lensRepository: LensRepository,\n        sessionState: SessionState,\n        metrics: MetricsClient\n    ): 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 (lens keyboard and Remote API) before registering handlers with LensCore.\n        const allHandlers = userHandlers.concat(\n            lensKeyboard.uriHandler,\n            getRemoteApiUriHandler(remoteApiServices, sessionState, lensState, lensRepository, metrics)\n        );\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"]}