@openstax/ts-utils 1.25.5 → 1.26.2

package/dist/cjs/coolFile.d.ts

@@ -0,0 +1 @@
+content

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

@@ -50,11 +50,12 @@ export declare const loadResponse: (response: Response) => () => Promise<any>;
 interface MakeApiGateway<F> {
     <Ru>(config: ConfigProviderForConfig<{
         apiBase: string;
-    }>, routes: MapRoutesToConfig<Ru>, appProvider?: {
+    }>, routes: MapRoutesToConfig<Ru>, app?: {
         authProvider?: {
             getAuthorizedFetchConfig: () => Promise<ConfigForFetch<F>>;
         };
         logger?: Logger;
+        launchToken?: string;
     }): MapRoutesToClient<Ru>;
 }
 export declare const createApiGateway: <F extends GenericFetch<import("../../fetch").FetchConfig, Response>>(initializer: {

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

@@ -48,7 +48,7 @@ const loadResponse = (response) => () => {
     }
 };
 exports.loadResponse = loadResponse;
-const makeRouteClient = (initializer, config, route, appProvider) => {
+const makeRouteClient = (initializer, config, route, app) => {
     /* TODO this duplicates code with makeRenderRouteUrl, reuse that */
     const renderUrl = async ({ params, query }) => {
         const apiBase = await (0, config_1.resolveConfigValue)(config.apiBase);
@@ -61,9 +61,9 @@ const makeRouteClient = (initializer, config, route, appProvider) => {
         const { fetch } = initializer;
         const url = await renderUrl({ params, query });
         const body = payload ? JSON.stringify(payload) : undefined;
-        const baseOptions = (0, __1.merge)((await ((_a = appProvider === null || appProvider === void 0 ? void 0 : appProvider.authProvider) === null || _a === void 0 ? void 0 : _a.getAuthorizedFetchConfig())) || {}, fetchConfig || {});
+        const baseOptions = (0, __1.merge)((await ((_a = app === null || app === void 0 ? void 0 : app.authProvider) === null || _a === void 0 ? void 0 : _a.getAuthorizedFetchConfig())) || {}, fetchConfig || {});
         const requestId = (0, uuid_1.v4)();
-        const requestLogger = (_b = appProvider === null || appProvider === void 0 ? void 0 : appProvider.logger) === null || _b === void 0 ? void 0 : _b.createSubContext();
+        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 = (0, fetchStatusRetry_1.fetchStatusRetry)(fetch, { retries: 1, status: [502], logger: requestLogger });
         requestLogger === null || requestLogger === void 0 ? void 0 : requestLogger.log('Request Initiated', logger_1.Level.Info);
@@ -73,7 +73,10 @@ const makeRouteClient = (initializer, config, route, appProvider) => {
             headers: {
                 ...fetchConfig === null || fetchConfig === void 0 ? void 0 : fetchConfig.headers,
                 ...(body ? { 'content-type': 'application/json' } : {}),
-                'X-Request-ID': requestId,
+                'x-request-id': requestId,
+                ...((app === null || app === void 0 ? void 0 : app.launchToken) ? {
+                    'x-launch-token': app.launchToken,
+                } : {}),
             }
         })).then(response => {
             if (response.status === 401) {
@@ -98,8 +101,8 @@ const makeRouteClient = (initializer, config, route, appProvider) => {
     routeClient.renderUrl = renderUrl;
     return routeClient;
 };
-const createApiGateway = (initializer) => (config, routes, appProvider) => {
+const createApiGateway = (initializer) => (config, routes, app) => {
     return Object.fromEntries(Object.entries(routes)
-        .map(([key, routeConfig]) => ([key, makeRouteClient(initializer, config, routeConfig, appProvider)])));
+        .map(([key, routeConfig]) => ([key, makeRouteClient(initializer, config, routeConfig, app)])));
 };
 exports.createApiGateway = createApiGateway;

package/dist/cjs/services/launchParams/verifier.d.ts

@@ -15,8 +15,8 @@ interface Initializer<C> {
  */
 export declare const createLaunchVerifier: <C extends string = "launch">({ configSpace, fetcher }: Initializer<C>) => (configProvider: { [key in C]: {
     trustedDomain: import("../../config").ConfigValueProvider<string>;
-}; }) => {
-    verify: <T = undefined>(...[token, validator]: T extends undefined ? [string] : [string, (input: any) => T]) => Promise<T extends undefined ? jwt.JwtPayload : T>;
+}; }) => (_services: {}, getDefaultToken?: (() => string) | undefined) => {
+    verify: <T = undefined>(...args: T extends undefined ? [] | [string] : [(input: any) => T] | [string, (input: any) => T]) => Promise<T extends undefined ? jwt.JwtPayload : T>;
 };
-export declare type LaunchVerifier = ReturnType<ReturnType<typeof createLaunchVerifier>>;
+export declare type LaunchVerifier = ReturnType<ReturnType<ReturnType<typeof createLaunchVerifier>>>;
 export {};

package/dist/cjs/services/launchParams/verifier.js

@@ -60,35 +60,50 @@ const createLaunchVerifier = ({ configSpace, fetcher }) => (configProvider) => {
             callback(error);
         }
     };
-    const verify = (...[token, validator]) => new Promise((resolve, reject) => jsonwebtoken_1.default.verify(token, getKey, {}, (err, payload) => {
-        if (err && err instanceof jsonwebtoken_1.TokenExpiredError) {
-            reject(new errors_1.SessionExpiredError());
-        }
-        else if (err) {
-            reject(err);
-        }
-        else if (typeof payload !== 'object') {
-            reject(new Error('received JWT token with unexpected non-JSON payload'));
-        }
-        else if (!payload.sub) {
-            reject(new Error('JWT payload missing sub claim'));
-        }
-        else {
-            // we are migrating away from json encoding all the parameters into the `sub` claim
-            // and into using separate claims for each parameter. in transition, we check if the sub
-            // is json and return it if it is. this is still a breaking change when using this
-            // utility because applications no longer need to independently json parse the result
-            // starting now.
-            const parsed = payload;
-            try {
-                const jsonSubContents = JSON.parse(payload.sub);
-                Object.assign(parsed, jsonSubContents);
-            }
-            catch (e) { } // eslint-disable-line no-empty
-            // conditional return types are annoying
-            resolve((validator ? validator(parsed) : parsed));
-        }
-    }));
-    return { verify };
+    return (_services, getDefaultToken) => {
+        const verify = (...args) => {
+            const [inputToken, validator] = args.length === 1
+                ? typeof args[0] === 'string'
+                    ? [args[0], undefined]
+                    : [undefined, args[0]]
+                : args;
+            return new Promise((resolve, reject) => {
+                const token = inputToken !== null && inputToken !== void 0 ? inputToken : getDefaultToken === null || getDefaultToken === void 0 ? void 0 : getDefaultToken();
+                if (!token) {
+                    return reject(new errors_1.InvalidRequestError('Missing token for launch verification'));
+                }
+                return jsonwebtoken_1.default.verify(token, getKey, {}, (err, payload) => {
+                    if (err && err instanceof jsonwebtoken_1.TokenExpiredError) {
+                        reject(new errors_1.SessionExpiredError());
+                    }
+                    else if (err) {
+                        reject(err);
+                    }
+                    else if (typeof payload !== 'object') {
+                        reject(new Error('received JWT token with unexpected non-JSON payload'));
+                    }
+                    else if (!payload.sub) {
+                        reject(new Error('JWT payload missing sub claim'));
+                    }
+                    else {
+                        // we are migrating away from json encoding all the parameters into the `sub` claim
+                        // and into using separate claims for each parameter. in transition, we check if the sub
+                        // is json and return it if it is. this is still a breaking change when using this
+                        // utility because applications no longer need to independently json parse the result
+                        // starting now.
+                        const parsed = payload;
+                        try {
+                            const jsonSubContents = JSON.parse(payload.sub);
+                            Object.assign(parsed, jsonSubContents);
+                        }
+                        catch (e) { } // eslint-disable-line no-empty
+                        // conditional return types are annoying
+                        resolve((validator ? validator(parsed) : parsed));
+                    }
+                });
+            });
+        };
+        return { verify };
+    };
 };
 exports.createLaunchVerifier = createLaunchVerifier;

package/dist/cjs/services/searchProvider/index.d.ts

@@ -1,8 +1,9 @@
+export declare type FieldType = string | string[] | number | boolean;
 export declare type Filter = {
     key: string;
-    value: string | string[] | boolean;
+    value: FieldType;
 } | {
-    terms: Record<string, string | string[] | number | boolean>;
+    terms: Record<string, FieldType>;
 } | {
     exists: {
         field: string;

package/dist/cjs/services/searchProvider/memorySearchTheBadWay.d.ts

@@ -7,6 +7,7 @@ export declare const memorySearchTheBadWay: () => <T>({ store }: {
     deleteIndexIfExists: () => Promise<undefined>;
     ensureIndexCreated: () => Promise<undefined>;
     index: (_options: IndexOptions<T>) => Promise<undefined>;
+    bulkIndex: (_items: IndexOptions<T>[]) => Promise<undefined>;
     search: (options: SearchOptions) => Promise<{
         items: T[];
         pageSize: number;

package/dist/cjs/services/searchProvider/memorySearchTheBadWay.js

@@ -12,37 +12,56 @@ var MatchType;
     MatchType[MatchType["MustNot"] = 1] = "MustNot";
     MatchType[MatchType["Should"] = 2] = "Should";
 })(MatchType || (MatchType = {}));
-const resolveField = (document, field) => field.key.toString().split('.').reduce((result, key) => result[key], document);
+const resolveField = (document, field) => field.split('.').reduce((result, key) => result[key], document);
+const matchExists = (exists, document) => {
+    const value = resolveField(document, exists.field);
+    return value !== undefined && value !== null;
+};
+const matchTerms = (options, terms, document) => {
+    const getFieldType = (field) => { var _a; return (_a = options.fields.find(f => f.key == field)) === null || _a === void 0 ? void 0 : _a.type; };
+    for (const key in terms) {
+        const docValues = (0, __1.coerceArray)(resolveField(document, key));
+        const coerceValue = getFieldType(key) === 'boolean'
+            ? (input) => {
+                if ([true, 'true', '1', 1].includes(input)) {
+                    return true;
+                }
+                if ([false, 'false', '0', 0, ''].includes(input)) {
+                    return false;
+                }
+                throw new errors_1.InvalidRequestError('input is not a valid boolean filter');
+            }
+            : (x) => x;
+        const hasMatch = (0, __1.coerceArray)(terms[key]).map(coerceValue).some(v => docValues.includes(v));
+        if (!hasMatch) {
+            return false;
+        }
+    }
+    return true;
+};
 const memorySearchTheBadWay = () => ({ store }) => {
     return {
         // This method is intentionally stubbed because index deletion is not applicable for in-memory storage.
         deleteIndexIfExists: async () => undefined,
         ensureIndexCreated: async () => undefined,
         index: async (_options) => undefined,
+        bulkIndex: async (_items) => undefined,
         search: async (options) => {
-            const getFieldType = (field) => { var _a; return (_a = options.fields.find(f => f.key == field.key)) === null || _a === void 0 ? void 0 : _a.type; };
             const results = (await store.loadAllDocumentsTheBadWay())
                 .map(document => {
                 let weight = 0;
                 const matchFilters = (filters, matchType) => {
                     for (const field of filters) {
-                        if (!('key' in field && 'value' in field)) {
-                            console.warn('local search only supports key/value filters');
-                            continue;
-                        }
-                        const docValues = (0, __1.coerceArray)(resolveField(document, field));
-                        const coerceValue = getFieldType(field) === 'boolean'
-                            ? (input) => {
-                                if ([true, 'true', '1', 1].includes(input)) {
-                                    return true;
-                                }
-                                if ([false, 'false', '0', 0, ''].includes(input)) {
-                                    return false;
-                                }
-                                throw new errors_1.InvalidRequestError('input is not a valid boolean filter');
-                            }
-                            : (x) => x;
-                        const hasMatch = (0, __1.coerceArray)(field.value).map(coerceValue).some(v => docValues.includes(v));
+                        const filter = ('key' in field && 'value' in field)
+                            ? { terms: { [field.key]: field.value } }
+                            : field;
+                        let hasMatch;
+                        if ('terms' in filter)
+                            hasMatch = matchTerms(options, filter.terms, document);
+                        else if ('exists' in filter)
+                            hasMatch = matchExists(filter.exists, document);
+                        else
+                            throw new errors_1.InvalidRequestError('invalid filter type');
                         if ((matchType === MatchType.Must && !hasMatch) || (matchType === MatchType.MustNot && hasMatch)) {
                             return false;
                         }
@@ -57,7 +76,7 @@ const memorySearchTheBadWay = () => ({ store }) => {
                         if (field.type !== undefined && field.type !== 'text') {
                             continue;
                         }
-                        const value = resolveField(document, field);
+                        const value = resolveField(document, field.key);
                         if (value === undefined || value === null) {
                             continue;
                         }
@@ -88,8 +107,8 @@ const memorySearchTheBadWay = () => ({ store }) => {
                 .filter(r => !options.query || r.weight >= MIN_MATCH);
             results.sort((a, b) => {
                 for (const sort of (options.sort || [])) {
-                    const aValue = resolveField(a.document, { key: sort.key });
-                    const bValue = resolveField(b.document, { key: sort.key });
+                    const aValue = resolveField(a.document, sort.key);
+                    const bValue = resolveField(b.document, sort.key);
                     if (aValue < bValue) {
                         return sort.order === 'asc' ? -1 : 1;
                     }

package/dist/cjs/services/searchProvider/openSearch.d.ts

@@ -19,6 +19,7 @@ export declare const openSearchService: <C extends string = "deployed">(initiali
     ensureIndexCreated: () => Promise<void>;
     deleteIndexIfExists: () => Promise<void>;
     index: (params: IndexOptions<T>) => Promise<void>;
+    bulkIndex: (items: IndexOptions<T>[]) => Promise<void>;
     search: (options: SearchOptions) => Promise<{
         items: Exclude<T, undefined>[];
         pageSize: number;

package/dist/cjs/services/searchProvider/openSearch.js

@@ -8,6 +8,16 @@ const aws_1 = require("@opensearch-project/opensearch/aws");
 const config_1 = require("../../config");
 const guards_1 = require("../../guards");
 const helpers_1 = require("../../misc/helpers");
+const mapFilter = (filter) => {
+    if ('key' in filter && 'value' in filter) {
+        const { key } = filter;
+        const values = filter.value instanceof Array ? filter.value : [filter.value];
+        return { terms: { [key]: values } };
+    }
+    else {
+        return filter;
+    }
+};
 const openSearchService = (initializer = {}) => (configProvider) => {
     const config = configProvider[(0, guards_1.ifDefined)(initializer.configSpace, 'deployed')];
     const client = (0, helpers_1.once)(async () => new opensearch_1.Client({
@@ -53,6 +63,17 @@ const openSearchService = (initializer = {}) => (configProvider) => {
                 refresh: true
             });
         };
+        const bulkIndex = async (items) => {
+            const openSearchClient = await client();
+            await openSearchClient.bulk({
+                index: indexConfig.name,
+                body: items.flatMap((item) => [
+                    { index: { _id: item.id } },
+                    item.body
+                ]),
+                refresh: true
+            });
+        };
         const search = async (options) => {
             const body = {
                 query: { bool: {} },
@@ -67,45 +88,16 @@ const openSearchService = (initializer = {}) => (configProvider) => {
                     }
                 };
             }
-            const { must_not } = options;
+            const { must_not, should } = options;
             const must = 'filter' in options ? options.filter : options.must;
             if (must && must.length > 0) {
-                body.query.bool.filter = [];
-                must.forEach((filter) => {
-                    if ('key' in filter && 'value' in filter) {
-                        const { key } = filter;
-                        const values = filter.value instanceof Array ? filter.value : [filter.value];
-                        body.query.bool.filter.push({ terms: { [key]: values } });
-                    }
-                    else {
-                        body.query.bool.filter.push(filter);
-                    }
-                });
+                body.query.bool.filter = must.map(mapFilter);
             }
             if (must_not && must_not.length > 0) {
-                body.query.bool.must_not = [];
-                must_not.forEach((filter) => {
-                    if ('key' in filter && 'value' in filter) {
-                        const { key } = filter;
-                        const values = filter.value instanceof Array ? filter.value : [filter.value];
-                        values.forEach((value) => body.query.bool.must_not.push({ term: { [key]: value } }));
-                    }
-                    else {
-                        body.query.bool.must_not.push(filter);
-                    }
-                });
+                body.query.bool.must_not = must_not.map(mapFilter);
             }
-            if (options.should && options.should.length > 0) {
-                body.query.bool.should = options.should.map(filter => {
-                    if ('key' in filter && 'value' in filter) {
-                        const { key } = filter;
-                        const values = filter.value instanceof Array ? filter.value : [filter.value];
-                        return { terms: { [key]: values } };
-                    }
-                    else {
-                        return filter;
-                    }
-                });
+            if (should && should.length > 0) {
+                body.query.bool.should = should.map(mapFilter);
                 body.query.bool.minimum_should_match = 1;
             }
             if (options.sort && options.sort.length > 0) {
@@ -131,7 +123,7 @@ const openSearchService = (initializer = {}) => (configProvider) => {
             const totalPages = Math.ceil(totalItems / pageSize) || 1;
             return { items, pageSize, currentPage, totalItems, totalPages };
         };
-        return { ensureIndexCreated, deleteIndexIfExists, index, search };
+        return { ensureIndexCreated, deleteIndexIfExists, index, bulkIndex, search };
     };
 };
 exports.openSearchService = openSearchService;