@openstax/ts-utils 1.34.0 → 1.35.0

package/dist/esm/routing/index.js

@@ -0,0 +1,246 @@
+import * as pathToRegexp from 'path-to-regexp';
+import queryString from 'query-string';
+import { mapFind, memoize } from '../misc/helpers';
+import { createConsoleLogger } from '../services/logger/console';
+/** this utility simplifies the route type to remove stuff that is only
+ * relevant internal to the route, like the service types, keeping only
+ * the payload type which is necessary for the apiGateway
+ *
+ * this helps avoid the "type too complicated" error that typescript throws
+ * when there are a lot of routes with complex services
+ **/
+export const routesList = (routes) => routes;
+/**
+ * Makes a createRoute function that can be used to create routes (this is a factory factory). The
+ * `makeCreateRoute` function is typically called once in the backend and once in the frontend to
+ * set the types for the resulting `createRoute` function -- that latter function is called once
+ * per route. E.g. for the backend, the call could look like:
+ *
+ * ```
+ * export const createRoute = makeCreateRoute<AppServices, ApiRouteRequest, {
+ *   method: METHOD;
+ * }>();
+ * ```
+ *
+ * Notes:
+ * * The `{method: METHOD}` defines the `Ex` extension type; here, the `method` property is only
+ *   relevant to backend routes.
+ * * when defining the `createRoute` method, only the request input format is defined, the output
+ *   format is derived from the routes.
+ *
+ * When calling the resulting `createRoute` function, the only required params of the route are the
+ * name, path, and handler. Other params can be added to the type and then later used in the
+ * routeMatcher.
+ *
+ * eg when defining requestServiceProvider in line, the types have a hard time, it helps to put in another argument:
+ * ```
+ * export const exampleRoute = createRoute({
+ *   name: 'exampleRoute', method: METHOD.GET, path: '/api/example/:key',
+ *   requestServiceProvider: composeServiceMiddleware({
+ *     cookieAuthMiddleware,
+ *     documentStoreMiddleware,
+ *   }},
+ *   async(params: {key: string}, services) => {
+ *     const result = await services.myDocumentStore.getItem(params.key);
+ *
+ *     if (!result) {
+ *       throw new NotFoundError('requested item not found');
+ *     }
+ *
+ *     return apiJsonResponse(200, result);
+ *   }
+ * );
+ * ```
+ * eg when using a pre-existing provider variable the types work better:
+ * ```
+ * export const exampleRoute = createRoute({
+ *   name: 'exampleRoute', method: METHOD.GET, path: '/api/example/:key',
+ *   requestServiceProvider,
+ *   handler: async(params: {key: string}, services) => {
+ *     const result = await services.myDocumentStore.getItem(params.key);
+ *
+ *     if (!result) {
+ *       throw new NotFoundError('requested item not found');
+ *     }
+ *
+ *     return apiJsonResponse(200, result);
+ *   }
+ * });
+ * ```
+ */
+export const makeCreateRoute = () => (...args) => {
+    return (args.length === 1
+        ? args[0]
+        : { ...args[0], handler: args[1] });
+};
+/* begin reverse routing utils */
+/**
+ * Makes a renderRouteUrl function that can be used to render route paths (this is a factory
+ * factory). The returned function takes a `route`, `params`, and `query` and returns a string
+ * with the params and query substituted into the route path.
+ *
+ * this function is initialized using the Ru type which indicates the specific routes wired into
+ * the application, which means that if you try to build a url with a route which is not wired
+ * into the router you will get a type error. this is a feature to prevent referencing routes that
+ * don't exist or aren't handling requests properly.
+ *
+ * if you are making a helper function or need to render a route outside your application, you
+ * can use the `renderAnyRouteUrl` function
+ */
+export const makeRenderRouteUrl = () => (route, params, query = {}) => {
+    const getPathForParams = pathToRegexp.compile(route.path, { encode: encodeURIComponent });
+    const search = queryString.stringify(query);
+    const path = getPathForParams(params) + (search ? `?${search}` : '');
+    return path;
+};
+/**
+ * A pre-made result from `makeRenderRouteUrl`, this function interpolates parameter and query
+ * arguments into a route path.
+ *
+ * prefer using `renderRouteUrl` initialized with your applications route union
+ * when possible to help catch improperly initialized routes.
+ *
+ * @param route the route that has a `path` to be interpolated
+ * @param params the parameters to interpolate into the route path
+ * @param query the query parameters to add to the route path
+ * @returns the interpolated route path
+ */
+export const renderAnyRouteUrl = makeRenderRouteUrl();
+const bindRoute = (services, appBinder, pathExtractor, matcher) => (route) => {
+    const getParamsFromPath = pathToRegexp.match(route.path, { decode: decodeURIComponent });
+    const boundServiceProvider = route.requestServiceProvider && appBinder(services, route.requestServiceProvider);
+    return (request, logger) => {
+        const path = pathExtractor(request);
+        const match = getParamsFromPath(path);
+        if ((!matcher || matcher(request, route)) && match) {
+            return {
+                name: route.name,
+                executor: () => route.handler(match.params, boundServiceProvider ? boundServiceProvider({ request, logger }, { route, params: match.params }) : undefined)
+            };
+        }
+    };
+};
+/**
+ * A factory factory for creating request responders (functions that take a request and return a
+ * response -- these functions let us implement Lambda `handler` functions).
+ *
+ * Use it in two steps. First, call it with the general business logic that defines routes, logs,
+ * errors, etc:
+ * ```
+ * const getRequestResponder = makeGetRequestResponder<
+ *    AppServices, TRoutes, ApiRouteRequest, Promise<ApiRouteResponse>
+ *   >()  // this empty invocation helps typescript mix defined and inferred types
+ *   ({
+ *     routes: apiRoutes, // the route definitions
+ *     pathExtractor,     // how to get the path out of the request format
+ *     routeMatcher,      // logic for matching route (beyond path matching, optional)
+ *     errorHandler,      // any special error handling
+ *   });
+ * ```
+ * Note here that among other things we're specifying a generic response format that the response
+ * and error handling middleware can use, if any routes have responses that don't adhere to this
+ * it'll complain about it.
+ *
+ * Next, we use the `getRequestResponder` to create a responder for a specific lambda entrypoint:
+ * ```
+ * export const handler: (request: APIGatewayProxyEventV2): Promise<ApiRouteResponse> =>
+ *   getRequestResponder(
+ *     lambdaServices,  // the AppServices for this entrypoint
+ *     lambdaMiddleware // environment specific response middleware (like cors)
+ *   );
+ * ```
+ */
+export const makeGetRequestResponder = () => ({ routes, pathExtractor, routeMatcher, errorHandler, logExtractor }) => (services, responseMiddleware) => {
+    const appBinderImpl = (app, middleware) => middleware(app, appBinder);
+    const appBinder = memoize(appBinderImpl);
+    const boundRoutes = routes().map(bindRoute(services, appBinder, pathExtractor, routeMatcher));
+    const boundResponseMiddleware = responseMiddleware ? responseMiddleware(services) : undefined;
+    const appLogger = services.logger || createConsoleLogger();
+    // *note* this opaque promise guard is less generic than i hoped so
+    //   i'm leaving it here instead of the guards file.
+    //
+    // its less than ideal because it enforces that the handlers return
+    // the same type as the parent promise, usually a handler can be either a
+    // promise or a non-promise value and the promise figures it out, but those
+    // types are getting complicated quickly here.
+    const isPromise = (thing) => thing instanceof Promise;
+    return (request) => {
+        const logger = appLogger.createSubContext();
+        if (logExtractor) {
+            logger.setContext(logExtractor(request));
+        }
+        logger.log('begin request');
+        try {
+            const route = mapFind(boundRoutes, (route) => route(request, logger));
+            if (route) {
+                logger.log(`route matched ${route.name}`);
+                const result = boundResponseMiddleware ?
+                    boundResponseMiddleware(route.executor(), { request, logger }) : route.executor();
+                if (isPromise(result) && errorHandler) {
+                    const errorHandlerWithMiddleware = (e) => boundResponseMiddleware ?
+                        boundResponseMiddleware(errorHandler(e, logger), { request, logger }) : errorHandler(e, logger);
+                    return result.catch(errorHandlerWithMiddleware);
+                }
+                else {
+                    return result;
+                }
+            }
+            else if (boundResponseMiddleware) {
+                logger.log('no route matched, returning 404');
+                return boundResponseMiddleware(undefined, { request, logger });
+            }
+        }
+        catch (e) {
+            if (errorHandler && e instanceof Error) {
+                return boundResponseMiddleware
+                    ? boundResponseMiddleware(errorHandler(e, logger), { request, logger })
+                    : errorHandler(e, logger);
+            }
+            throw e;
+        }
+        return undefined;
+    };
+};
+/**
+ * Returns a JSON response. Handles serializing the data to JSON and setting the content-type header.
+ * @param statusCode e.g. 201
+ * @param data the object to be serialized to JSON
+ * @param headers HTTP headers
+ * @example
+ * return apiJsonResponse(
+ *   200, {
+ *     message: "hello, world!",
+ *     foo: "bar",
+ *   },
+ *   { 'X-Frame-Options': 'DENY' }
+ * );
+ */
+export const apiJsonResponse = (statusCode, data, headers) => ({ statusCode, data, body: JSON.stringify(data), headers: { ...headers, 'content-type': 'application/json' } });
+/**
+ * Returns a plain text response. Handles setting the content-type header.
+ * @param statusCode e.g. 201
+ * @param data some string
+ * @param headers HTTP headers
+ * @example return apiTextResponse(200, 'some text')
+ */
+export const apiTextResponse = (statusCode, data, headers) => ({ statusCode, data, body: data, headers: { ...headers, 'content-type': 'text/plain' } });
+/**
+ * Returns an HTML response. Handles setting the content-type header.
+ * @param statusCode e.g. 201
+ * @param data some string
+ * @param headers HTTP headers
+ * @example return apiHtmlResponse(200, '<b>some text</b>')
+ */
+export const apiHtmlResponse = (statusCode, data, headers) => ({ statusCode, data, body: data, headers: { ...headers, 'content-type': 'text/html' } });
+/** HTTP method enum */
+export var METHOD;
+(function (METHOD) {
+    METHOD["GET"] = "GET";
+    METHOD["HEAD"] = "HEAD";
+    METHOD["POST"] = "POST";
+    METHOD["PUT"] = "PUT";
+    METHOD["PATCH"] = "PATCH";
+    METHOD["DELETE"] = "DELETE";
+    METHOD["OPTIONS"] = "OPTIONS";
+})(METHOD || (METHOD = {}));
+export * from './helpers';

package/dist/esm/routing/validators/zod.d.ts

@@ -0,0 +1,4 @@
+import type { z } from 'zod';
+export declare const zodPayloadValidator: <T extends {}>(validator: z.ZodType<T, T>) => (input: {
+    [key: string]: any;
+}) => input is T;

package/dist/esm/routing/validators/zod.js

@@ -0,0 +1,10 @@
+/* spell-checker: ignore treeify */
+import { treeifyError } from 'zod';
+import { ValidationError } from '../../errors';
+export const zodPayloadValidator = (validator) => (input) => {
+    const result = validator.safeParse(input);
+    if (result.success) {
+        return true;
+    }
+    throw new ValidationError(treeifyError(result.error));
+};

package/dist/esm/services/accountsGateway/index.d.ts

@@ -0,0 +1,92 @@
+import { ConfigProviderForConfig } from '../../config';
+import { GenericFetch } from '../../fetch';
+import { JsonCompatibleStruct } from '../../routing';
+import { ApiUser, ConsentPreferences } from '../authProvider';
+import { Logger } from '../logger';
+export type Config = {
+    accountsBase: string;
+    accountsAuthToken: string;
+};
+interface Initializer<C> {
+    configSpace?: C;
+    fetch: GenericFetch;
+}
+export type FindUserPayload = ({
+    external_id: string;
+} | {
+    uuid: string;
+}) & {
+    sso?: string;
+};
+export type FindOrCreateUserPayload = {
+    external_id: string;
+    email?: string;
+    already_verified?: boolean;
+    first_name?: string;
+    last_name?: string;
+    full_name?: string;
+    salesforce_contact_id?: string;
+    faculty_status?: string;
+    role?: string;
+    school_type?: string;
+    is_test?: boolean;
+    sso?: string;
+};
+export type FindOrCreateUserResponse = {
+    id: number;
+    uuid: string;
+    external_ids: string[];
+    is_test: boolean;
+    sso: string;
+};
+export type FindUserResponse = (FindOrCreateUserResponse & {
+    external_ids: string[];
+}) | undefined;
+export type LinkUserPayload = {
+    userId: number;
+    externalId: string;
+};
+export type LinkUserResponse = {
+    user_id: number;
+    external_id: string;
+};
+export type SearchUsersPayload = {
+    q: string;
+    order_by?: string;
+};
+export type SearchUsersResponse = {
+    items: Array<ApiUser & {
+        external_ids: string[];
+    } & JsonCompatibleStruct>;
+    total_count: number;
+};
+export type UpdateUserPayload = ConsentPreferences;
+export type MappedUserInfo<T> = {
+    data: T;
+    fullName: string;
+    platformUserId?: string;
+    uuid: string;
+};
+export declare const accountsGateway: <C extends string = "accounts">(initializer: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => ({ logger }: {
+    logger: Logger;
+}) => {
+    findOrCreateUser: (body: FindOrCreateUserPayload) => Promise<FindOrCreateUserResponse>;
+    findUser: (body: FindUserPayload) => Promise<FindUserResponse>;
+    getUser: (token: string) => Promise<ApiUser & JsonCompatibleStruct>;
+    linkUser: (body: LinkUserPayload) => Promise<LinkUserResponse>;
+    mapUserUuids: <T>(userUuidsMap: {
+        [uuid: string]: T;
+    }, platformId?: string) => Promise<{
+        data: T;
+        fullName: string;
+        platformUserId: string | undefined;
+        uuid: string;
+    }[]>;
+    searchUsers: (payload: SearchUsersPayload) => Promise<SearchUsersResponse>;
+    updateUser: (token: string, body: UpdateUserPayload) => Promise<ApiUser & JsonCompatibleStruct>;
+    getUserMap: <R>(userUuids: Set<string>, mapper: ((user: ApiUser) => R)) => Promise<Map<string, R>>;
+    mapUserData: <T, R>(input: T[], getUserUuid: (item: T) => string, mapper: ((user: ApiUser | undefined, item: T) => R)) => Promise<R[]>;
+    mapUsersData: <T, R_1>(input: T[], getUserUuids: (item: T) => string[], mapper: ((users: Map<string, ApiUser | undefined>, item: T) => R_1)) => Promise<R_1[]>;
+};
+export type AccountsGateway = ReturnType<ReturnType<ReturnType<typeof accountsGateway>>>;
+export {};

package/dist/esm/services/accountsGateway/index.js

@@ -0,0 +1,131 @@
+import { chunk, isEqual } from 'lodash';
+import queryString from 'query-string';
+import { resolveConfigValue } from '../../config';
+import { ifDefined, isDefined } from '../../guards';
+import { once } from '../../misc/helpers';
+import { METHOD } from '../../routing';
+import { Level } from '../logger';
+class ApiError extends Error {
+    constructor(message, status) {
+        super(message);
+        this.status = status;
+    }
+}
+export const accountsGateway = (initializer) => (configProvider) => {
+    const config = configProvider[ifDefined(initializer.configSpace, 'accounts')];
+    const accountsBase = once(() => resolveConfigValue(config.accountsBase));
+    const accountsAuthToken = once(() => resolveConfigValue(config.accountsAuthToken));
+    return ({ logger }) => {
+        const request = async (method, path, options, statuses = [200, 201]) => {
+            const host = (await accountsBase()).replace(/\/+$/, '');
+            const url = `${host}/api/${path}`;
+            const config = {
+                headers: {
+                    Authorization: `Bearer ${options.token || await accountsAuthToken()}`,
+                },
+                method,
+            };
+            if (options.body) {
+                config.body = JSON.stringify(options.body);
+            }
+            const response = await initializer.fetch(url, config);
+            if (!statuses.includes(response.status)) {
+                throw new ApiError(`Received unexpected status code ${response.status} for Accounts API call: ${method} ${url}`, response.status);
+            }
+            return response.json();
+        };
+        const findOrCreateUser = async (body) => request(METHOD.POST, 'user/find-or-create', { body });
+        const findUser = async (body) => {
+            try {
+                return await request(METHOD.POST, 'user/find', { body });
+            }
+            catch (error) {
+                if (error instanceof ApiError && error.status === 404) {
+                    return undefined;
+                }
+                else {
+                    throw error;
+                }
+            }
+        };
+        const getUser = async (token) => request(METHOD.GET, 'user', { token });
+        const linkUser = async (body) => request(METHOD.POST, 'user/external-ids', {
+            body: {
+                external_id: body.externalId,
+                user_id: body.userId,
+            }
+        });
+        const searchUsers = async (payload) => request(METHOD.GET, `users?${queryString.stringify(payload)}`, {});
+        const updateUser = async (token, body) => request(METHOD.PUT, 'user', { body, token });
+        const getPlatformUserId = (externalIds, platformId) => {
+            for (const externalId of externalIds) {
+                const [userPlatformId, userId] = externalId.split('/', 2);
+                if (userPlatformId === platformId) {
+                    return userId;
+                }
+            }
+        };
+        /*
+         * If a platformId is given, returns an array where
+         * the first element is the user id from the platform
+         * and the second is the value from the map
+         * Otherwise, returns an array where
+         * the first element is the user's full_name
+         * and the second is the value from the map
+         */
+        const mapUserUuids = async (userUuidsMap, platformId) => {
+            const results = await mapUserData(Object.entries(userUuidsMap), ([id]) => id, (user, [, data]) => {
+                if (!user)
+                    return undefined;
+                const platformUserId = platformId ? getPlatformUserId(user.external_ids, platformId) : undefined;
+                if (platformId && !platformUserId) {
+                    logger.logEvent(Level.Warn, {
+                        message: 'Accounts user has no external_id matching the given platformId',
+                        accountsUuid: user.uuid,
+                        platformId,
+                    });
+                }
+                if (!user.full_name) {
+                    logger.logEvent(Level.Warn, {
+                        message: 'Accounts user has no full_name',
+                        accountsUuid: user.uuid,
+                    });
+                }
+                return { data, fullName: user.full_name, platformUserId, uuid: user.uuid };
+            });
+            return results.filter(isDefined);
+        };
+        const getUserMap = async (userUuids, mapper) => {
+            if (userUuids.size === 0)
+                return new Map();
+            const chunked = chunk([...userUuids], 10);
+            const results = await Promise.all(chunked.map(async (inputChunk) => {
+                const { items } = await searchUsers({ q: inputChunk.map(userUuid => `uuid:${userUuid}`).join(' ')
+                });
+                const accountsUuids = items.map((user) => user.uuid);
+                if (!isEqual(accountsUuids.sort(), inputChunk.sort())) {
+                    logger.logEvent(Level.Warn, {
+                        message: 'Unexpected Accounts user search results',
+                        uuids: inputChunk,
+                        accountsUuids,
+                    });
+                }
+                return items;
+            }));
+            return new Map(results.flat(1).map(user => [user.uuid, mapper(user)]));
+        };
+        const mapUserData = async (input, getUserUuid, mapper) => {
+            const userMap = await getUserMap(new Set(input.flatMap(getUserUuid)), user => user);
+            return input.map(item => mapper(userMap.get(getUserUuid(item)), item));
+        };
+        const mapUsersData = async (input, getUserUuids, mapper) => {
+            const userMap = await getUserMap(new Set(input.flatMap(getUserUuids)), user => user);
+            return input.map(item => {
+                const userUuids = getUserUuids(item);
+                const itemUserMap = new Map(userUuids.map(uuid => [uuid, userMap.get(uuid)]));
+                return mapper(itemUserMap, item);
+            });
+        };
+        return { findOrCreateUser, findUser, getUser, linkUser, mapUserUuids, searchUsers, updateUser, getUserMap, mapUserData, mapUsersData };
+    };
+};

package/dist/esm/services/apiGateway/index.d.ts

@@ -0,0 +1,68 @@
+import { Headers } from 'node-fetch';
+import { ConfigProviderForConfig } from '../../config';
+import { ConfigForFetch, GenericFetch, Response } from '../../fetch';
+import { AnyRoute, ApiResponse, OutputForRoute, ParamsForRoute, PayloadForRoute, QueryParams } from '../../routing';
+import { UnwrapPromise } from '../../types';
+import { Logger } from '../logger';
+export type TResponsePayload<R> = R extends ApiResponse<any, infer P> ? P : never;
+export type TResponseStatus<R> = R extends ApiResponse<infer S, any> ? S : never;
+export type RouteClient<R> = {
+    (config: {
+        fetchConfig?: any;
+        query?: QueryParams;
+    } & (ParamsForRoute<R> extends undefined ? {} : {
+        params: ParamsForRoute<R>;
+    }) & (PayloadForRoute<R> extends undefined ? {} : {
+        payload: PayloadForRoute<R>;
+    })): Promise<UnsafeApiClientResponse<UnwrapPromise<OutputForRoute<R>>>>;
+    renderUrl: (config: {
+        query?: QueryParams;
+    } & (ParamsForRoute<R> extends undefined ? {} : {
+        params: ParamsForRoute<R>;
+    })) => Promise<string>;
+};
+export interface AcceptStatus<Ro> {
+    <S extends TResponseStatus<Ro>[]>(...args: S): Promise<ApiClientResponse<Extract<Ro, Record<'statusCode', S[number]>>>>;
+    <S extends number[]>(...args: S): Promise<ApiClientResponse<any>>;
+}
+export type UnsafeApiClientResponse<Ro> = {
+    headers: Headers;
+    load: () => Promise<any>;
+    status: number;
+    acceptStatus: AcceptStatus<Ro>;
+};
+export type ApiClientResponse<Ro> = Ro extends any ? {
+    headers: Headers;
+    status: TResponseStatus<Ro>;
+    load: () => Promise<TResponsePayload<Ro>>;
+} : never;
+export type ExpandRoute<T> = T extends ((...args: infer A) => infer R) & {
+    renderUrl: (...args: infer Ar) => Promise<string>;
+} ? ((...args: A) => R) & {
+    renderUrl: (...args: Ar) => Promise<string>;
+} : never;
+export type MapRoutesToClient<Ru> = [Ru] extends [AnyRoute<Ru>] ? {
+    [N in Ru['name']]: ExpandRoute<RouteClient<Extract<Ru, Record<'name', N>>>>;
+} : never;
+export type MapRoutesToConfig<Ru> = [Ru] extends [AnyRoute<Ru>] ? {
+    [_N in Ru['name']]: {
+        path: string;
+        method: string;
+    };
+} : never;
+/** Pulls the content out of a response based on the content type */
+export declare const loadResponse: (response: Response) => () => Promise<any>;
+export interface MakeApiGateway<F> {
+    <Ru>(config: ConfigProviderForConfig<{
+        apiBase: string;
+    }>, routes: MapRoutesToConfig<Ru>, app?: {
+        authProvider?: {
+            getAuthorizedFetchConfig: () => Promise<ConfigForFetch<F>>;
+        };
+        logger?: Logger;
+        launchToken?: string;
+    }): MapRoutesToClient<Ru>;
+}
+export declare const createApiGateway: <F extends GenericFetch>(initializer: {
+    fetch: F;
+}) => MakeApiGateway<F>;

package/dist/esm/services/apiGateway/index.js

@@ -0,0 +1,77 @@
+import * as pathToRegexp from 'path-to-regexp';
+import queryString from 'query-string';
+import { v4 as uuid } from 'uuid';
+import { merge } from '../..';
+import { resolveConfigValue } from '../../config';
+import { SessionExpiredError, UnauthorizedError } from '../../errors';
+import { fetchStatusRetry } from '../../fetch/fetchStatusRetry';
+import { Level } from '../logger';
+/** Pulls the content out of a response based on the content type */
+export const loadResponse = (response) => () => {
+    const [contentType] = (response.headers.get('content-type') || '').split(';');
+    switch (contentType) {
+        case 'text/plain':
+            return response.text();
+        case 'application/json':
+            return response.json();
+        default:
+            throw new Error(`unknown content type ${contentType}`);
+    }
+};
+const makeRouteClient = (initializer, config, route, app) => {
+    /* TODO this duplicates code with makeRenderRouteUrl, reuse that */
+    const renderUrl = async ({ params, query }) => {
+        const apiBase = await resolveConfigValue(config.apiBase);
+        const getPathForParams = pathToRegexp.compile(route.path, { encode: encodeURIComponent });
+        const search = query && queryString.stringify(query);
+        return apiBase.replace(/\/+$/, '') + getPathForParams(params || {}) + (search ? `?${search}` : '');
+    };
+    const routeClient = async ({ params, payload, query, fetchConfig }) => {
+        var _a, _b;
+        const { fetch } = initializer;
+        const url = await renderUrl({ params, query });
+        const body = payload ? JSON.stringify(payload) : undefined;
+        const baseOptions = merge((await ((_a = app === null || app === void 0 ? void 0 : app.authProvider) === null || _a === void 0 ? void 0 : _a.getAuthorizedFetchConfig())) || {}, fetchConfig || {});
+        const requestId = uuid();
+        const requestLogger = (_b = app === null || app === void 0 ? void 0 : app.logger) === null || _b === void 0 ? void 0 : _b.createSubContext();
+        requestLogger === null || requestLogger === void 0 ? void 0 : requestLogger.setContext({ requestId, url, timeStamp: new Date().getTime() });
+        const fetcher = fetchStatusRetry(fetch, { retries: 1, status: [502], logger: requestLogger });
+        requestLogger === null || requestLogger === void 0 ? void 0 : requestLogger.log('Request Initiated', Level.Info);
+        return fetcher(url, merge(baseOptions, {
+            method: route.method,
+            body,
+            headers: {
+                ...fetchConfig === null || fetchConfig === void 0 ? void 0 : fetchConfig.headers,
+                ...(body ? { 'content-type': 'application/json' } : {}),
+                'x-request-id': requestId,
+                ...((app === null || app === void 0 ? void 0 : app.launchToken) ? {
+                    'x-launch-token': app.launchToken,
+                } : {}),
+            }
+        })).then(response => {
+            if (response.status === 401) {
+                throw new UnauthorizedError();
+            }
+            if (response.status === 440) {
+                throw new SessionExpiredError();
+            }
+            return {
+                status: response.status,
+                acceptStatus: async (...status) => {
+                    if (!status.includes(response.status)) {
+                        throw new Error(`unexpected HTTP ${response.status} response from api: ${await response.text()}`);
+                    }
+                    return { status: response.status, headers: response.headers, load: loadResponse(response) };
+                },
+                headers: response.headers,
+                load: loadResponse(response),
+            };
+        });
+    };
+    routeClient.renderUrl = renderUrl;
+    return routeClient;
+};
+export const createApiGateway = (initializer) => (config, routes, app) => {
+    return Object.fromEntries(Object.entries(routes)
+        .map(([key, routeConfig]) => ([key, makeRouteClient(initializer, config, routeConfig, app)])));
+};

package/dist/esm/services/authProvider/browser.d.ts

@@ -0,0 +1,40 @@
+import { ConfigProviderForConfig } from '../../config';
+import { GenericFetch } from '../../fetch';
+import { UserData } from './utils/embeddedAuthProvider';
+import { ApiUser, AuthProvider } from '.';
+type Config = {
+    accountsBase: string;
+};
+interface Initializer<C> {
+    configSpace?: C;
+    window: Window;
+}
+export type EventHandler = (e: {
+    data: any;
+    origin: string;
+    source: Pick<Window, 'postMessage'>;
+}) => void;
+export interface Window {
+    fetch: GenericFetch;
+    parent: Pick<Window, 'postMessage'>;
+    location: {
+        search: string;
+    };
+    document: {
+        referrer: string;
+    };
+    postMessage: (data: any, origin: string) => void;
+    addEventListener: (event: 'message', callback: EventHandler) => void;
+    removeEventListener: (event: 'message', callback: EventHandler) => void;
+}
+export type UpdatableUserFields = Partial<Pick<ApiUser, 'consent_preferences' | 'first_name' | 'last_name'>>;
+export type BrowserAuthProvider = AuthProvider & {
+    getAuthorizedUrl: (urlString: string) => string;
+    getAuthorizedLinkUrl: (urlString: string) => string;
+    getAuthorizedEmbedUrl: (urlString: string, extraParams?: {
+        [key: string]: string;
+    }) => string;
+    updateUser: (updates: UpdatableUserFields) => Promise<UserData<ApiUser>>;
+};
+export declare const browserAuthProvider: <C extends string = "auth">({ window, configSpace }: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => BrowserAuthProvider;
+export {};