@openstax/ts-utils 1.1.20 → 1.1.22

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import { UnionToIntersection } from './types';
 export declare const getKeyValue: <K extends string>(key: K) => <O extends { [key in K]?: any; }>(obj: O) => O[K];
 export declare const getKeyValueOr: <K extends string, V, Od extends { [key in K]?: any; } = { [key_1 in K]?: any; }>(key: K, defaultValue: V) => <O extends Od extends undefined ? { [key_2 in K]?: any; } : Od>(obj: O) => V | NonNullable<O[K]>;
 export declare const putKeyValue: <K extends string>(key: K) => <O extends { [key in K]?: any; }>(obj: O, value: O[K]) => O;
+export declare const coerceArray: <T>(thing: T | T[] | undefined) => T[];
 declare type FlowFn<A, R> = (...args: [A]) => R;
 declare type AnyFlowFn = FlowFn<any, any>;
 declare type FlowFnResult<F, A> = F extends FlowFn<A, infer R> ? R : never;

package/dist/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tuple = exports.merge = exports.getCommonProperties = exports.roundToPrecision = exports.memoize = exports.partitionSequence = exports.once = exports.hashValue = exports.mapFind = exports.fnIf = exports.flow = exports.putKeyValue = exports.getKeyValueOr = exports.getKeyValue = void 0;
+exports.tuple = exports.merge = exports.getCommonProperties = exports.roundToPrecision = exports.memoize = exports.partitionSequence = exports.once = exports.hashValue = exports.mapFind = exports.fnIf = exports.flow = exports.coerceArray = exports.putKeyValue = exports.getKeyValueOr = exports.getKeyValue = void 0;
 const crypto_1 = require("crypto");
 const deep_equal_1 = __importDefault(require("deep-equal"));
 const guards_1 = require("./guards");
@@ -26,6 +26,8 @@ const getKeyValueOr = (key, defaultValue) => (obj) => obj[key] || defaultValue;
 exports.getKeyValueOr = getKeyValueOr;
 const putKeyValue = (key) => (obj, value) => ({ ...obj, [key]: value });
 exports.putKeyValue = putKeyValue;
+const coerceArray = (thing) => thing instanceof Array ? thing : thing !== undefined ? [thing] : [];
+exports.coerceArray = coerceArray;
 /*
  * this is like lodash/flow but it uses a recursive type instead of hard-coding parameters
  */
@@ -83,8 +85,9 @@ exports.hashValue = hashValue;
  *   butOnlyOnce() // returns `hello`;
  */
 const once = (fn) => {
-    let result;
-    return ((...args) => result || (result = fn(...args)));
+    const initialValue = {};
+    let result = initialValue;
+    return ((...args) => result === initialValue ? (result = fn(...args)) : result);
 };
 exports.once = once;
 /*

package/dist/services/authProvider/browser.js

@@ -7,7 +7,7 @@ const guards_1 = require("../../guards");
 const embeddedAuthProvider_1 = require("./utils/embeddedAuthProvider");
 const browserAuthProvider = ({ window, configSpace }) => (configProvider) => {
     const config = configProvider[(0, guards_1.ifDefined)(configSpace, 'auth')];
-    const accountsUrl = (0, config_1.resolveConfigValue)(config.accountsUrl);
+    const accountsUrl = (0, __1.once)(() => (0, config_1.resolveConfigValue)(config.accountsUrl));
     const queryString = window.location.search;
     const queryKey = 'auth';
     const authQuery = new URLSearchParams(queryString).get(queryKey);
@@ -71,7 +71,7 @@ const browserAuthProvider = ({ window, configSpace }) => (configProvider) => {
      * requests user identity from accounts api using given token or cookie
      */
     const getFetchUser = async () => {
-        const response = await window.fetch((await accountsUrl).replace(/\/+$/, '') + '/accounts/api/user', getAuthorizedFetchConfigFromData(userData));
+        const response = await window.fetch((await accountsUrl()).replace(/\/+$/, '') + '/accounts/api/user', getAuthorizedFetchConfigFromData(userData));
         if (response.status === 200) {
             return { ...userData, user: await response.json() };
         }

package/dist/services/authProvider/decryption.js

@@ -2,21 +2,22 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.decryptionAuthProvider = void 0;
 const jose_1 = require("jose");
+const __1 = require("../..");
 const config_1 = require("../../config");
 const guards_1 = require("../../guards");
 const _1 = require(".");
 const decryptionAuthProvider = (initializer) => (configProvider) => {
     const config = configProvider[(0, guards_1.ifDefined)(initializer.configSpace, 'decryption')];
-    const cookieName = (0, config_1.resolveConfigValue)(config.cookieName);
-    const encryptionPrivateKey = (0, config_1.resolveConfigValue)(config.encryptionPrivateKey);
-    const signaturePublicKey = (0, config_1.resolveConfigValue)(config.signaturePublicKey);
+    const cookieName = (0, __1.once)(() => (0, config_1.resolveConfigValue)(config.cookieName));
+    const encryptionPrivateKey = (0, __1.once)(() => (0, config_1.resolveConfigValue)(config.encryptionPrivateKey));
+    const signaturePublicKey = (0, __1.once)(() => (0, config_1.resolveConfigValue)(config.signaturePublicKey));
     const decryptAndVerify = async (jwt) => {
         try {
             // Decrypt SSO cookie
-            const { plaintext } = await (0, jose_1.compactDecrypt)(jwt, Buffer.from(await encryptionPrivateKey), // Note: Buffer.from() is node-js only
+            const { plaintext } = await (0, jose_1.compactDecrypt)(jwt, Buffer.from(await encryptionPrivateKey()), // Note: Buffer.from() is node-js only
             { contentEncryptionAlgorithms: ['A256GCM'], keyManagementAlgorithms: ['dir'] });
             // Verify SSO cookie signature
-            const { payload } = await (0, jose_1.compactVerify)(plaintext, await (0, jose_1.importSPKI)(await signaturePublicKey, 'RS256'), { algorithms: ['RS256'] });
+            const { payload } = await (0, jose_1.compactVerify)(plaintext, await (0, jose_1.importSPKI)(await signaturePublicKey(), 'RS256'), { algorithms: ['RS256'] });
             return payload;
         }
         catch {
@@ -26,14 +27,14 @@ const decryptionAuthProvider = (initializer) => (configProvider) => {
     return ({ request, profile }) => {
         let user;
         const getAuthorizedFetchConfig = profile.track('getAuthorizedFetchConfig', () => async () => {
-            const [token, headers] = (0, _1.getAuthTokenOrCookie)(request, await cookieName);
+            const [token, headers] = (0, _1.getAuthTokenOrCookie)(request, await cookieName());
             if (!token) {
                 return {};
             }
             return { headers };
         });
         const loadUser = profile.track('loadUser', () => async () => {
-            const [token] = (0, _1.getAuthTokenOrCookie)(request, await cookieName);
+            const [token] = (0, _1.getAuthTokenOrCookie)(request, await cookieName());
             if (!token) {
                 return undefined;
             }

package/dist/services/authProvider/subrequest.js

@@ -1,28 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.subrequestAuthProvider = void 0;
+const __1 = require("../..");
 const config_1 = require("../../config");
 const guards_1 = require("../../guards");
 const _1 = require(".");
 const subrequestAuthProvider = (initializer) => (configProvider) => {
     const config = configProvider[(0, guards_1.ifDefined)(initializer.configSpace, 'subrequest')];
-    const cookieName = (0, config_1.resolveConfigValue)(config.cookieName);
-    const accountsUrl = (0, config_1.resolveConfigValue)(config.accountsUrl);
+    const cookieName = (0, __1.once)(() => (0, config_1.resolveConfigValue)(config.cookieName));
+    const accountsUrl = (0, __1.once)(() => (0, config_1.resolveConfigValue)(config.accountsUrl));
     return ({ request, profile }) => {
         let user;
         const getAuthorizedFetchConfig = profile.track('getAuthorizedFetchConfig', () => async () => {
-            const [token, headers] = (0, _1.getAuthTokenOrCookie)(request, await cookieName);
+            const [token, headers] = (0, _1.getAuthTokenOrCookie)(request, await cookieName());
             if (!token) {
                 return {};
             }
             return { headers };
         });
         const loadUser = profile.track('loadUser', p => async () => {
-            const [token, headers] = (0, _1.getAuthTokenOrCookie)(request, await cookieName);
+            const [token, headers] = (0, _1.getAuthTokenOrCookie)(request, await cookieName());
             if (!token) {
                 return undefined;
             }
-            return p.trackFetch(initializer.fetch)(await accountsUrl, { headers })
+            return p.trackFetch(initializer.fetch)(await accountsUrl(), { headers })
                 .then(response => response.json());
         });
         return {

package/dist/services/exercisesGateway/index.js

@@ -25,17 +25,18 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.exercisesGateway = void 0;
 const queryString = __importStar(require("query-string"));
+const __1 = require("../..");
 const assertions_1 = require("../../assertions");
 const config_1 = require("../../config");
 const guards_1 = require("../../guards");
 const routing_1 = require("../../routing");
 const exercisesGateway = (initializer) => (configProvider) => {
     const config = configProvider[(0, guards_1.ifDefined)(initializer.configSpace, 'exercises')];
-    const exercisesHost = (0, config_1.resolveConfigValue)(config.exercisesHost);
-    const exercisesAuthToken = (0, config_1.resolveConfigValue)(config.exercisesAuthToken);
-    const defaultCorrectness = (0, config_1.resolveConfigValue)(config.defaultCorrectness || '');
+    const exercisesHost = (0, __1.once)(() => (0, config_1.resolveConfigValue)(config.exercisesHost));
+    const exercisesAuthToken = (0, __1.once)(() => (0, config_1.resolveConfigValue)(config.exercisesAuthToken));
+    const defaultCorrectness = (0, __1.once)(() => (0, config_1.resolveConfigValue)(config.defaultCorrectness || ''));
     const doDefaultCorrectness = async (exercise) => {
-        if (await defaultCorrectness !== 'true') {
+        if (await defaultCorrectness() !== 'true') {
             return exercise;
         }
         for (const question of exercise.questions) {
@@ -58,12 +59,12 @@ const exercisesGateway = (initializer) => (configProvider) => {
         return exercise;
     };
     const request = async (method, path, query = undefined) => {
-        const host = (await exercisesHost).replace(/\/+$/, '');
+        const host = (await exercisesHost()).replace(/\/+$/, '');
         const baseUrl = `${host}/api/${path}`;
         const url = query ? `${baseUrl}?${queryString.stringify(query)}` : baseUrl;
         return initializer.fetch(url, {
             headers: {
-                Authorization: `Bearer ${await exercisesAuthToken}`,
+                Authorization: `Bearer ${await exercisesAuthToken()}`,
             },
             method,
         });

package/dist/services/lrsGateway/index.js

@@ -29,6 +29,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.lrsGateway = void 0;
 const formatISO_1 = __importDefault(require("date-fns/formatISO"));
 const queryString = __importStar(require("query-string"));
+const __1 = require("../..");
 const assertions_1 = require("../../assertions");
 const config_1 = require("../../config");
 const errors_1 = require("../../errors");
@@ -36,8 +37,8 @@ const guards_1 = require("../../guards");
 const routing_1 = require("../../routing");
 const lrsGateway = (initializer) => (configProvider) => {
     const config = configProvider[(0, guards_1.ifDefined)(initializer.configSpace, 'lrs')];
-    const lrsHost = (0, config_1.resolveConfigValue)(config.lrsHost);
-    const lrsAuthorization = (0, config_1.resolveConfigValue)(config.lrsAuthorization);
+    const lrsHost = (0, __1.once)(() => (0, config_1.resolveConfigValue)(config.lrsHost));
+    const lrsAuthorization = (0, __1.once)(() => (0, config_1.resolveConfigValue)(config.lrsAuthorization));
     return (authProvider) => {
         const putXapiStatements = async (statements) => {
             const user = (0, assertions_1.assertDefined)(await authProvider.getUser(), new errors_1.UnauthorizedError);
@@ -52,10 +53,10 @@ const lrsGateway = (initializer) => (configProvider) => {
                 },
                 timestamp: (0, formatISO_1.default)(new Date())
             }));
-            return initializer.fetch((await lrsHost).replace(/\/+$/, '') + '/data/xAPI/statements', {
+            return initializer.fetch((await lrsHost()).replace(/\/+$/, '') + '/data/xAPI/statements', {
                 body: JSON.stringify(statementsWithDefaults),
                 headers: {
-                    Authorization: await lrsAuthorization,
+                    Authorization: await lrsAuthorization(),
                     'Content-Type': 'application/json',
                     'X-Experience-API-Version': '1.0.0',
                 },
@@ -65,9 +66,9 @@ const lrsGateway = (initializer) => (configProvider) => {
                 .then(ids => ids.map((id, index) => ({ id, ...statementsWithDefaults[index] })));
         };
         const getMoreXapiStatements = async (more) => {
-            return initializer.fetch((await lrsHost).replace(/\/+$/, '') + more, {
+            return initializer.fetch((await lrsHost()).replace(/\/+$/, '') + more, {
                 headers: {
-                    Authorization: await lrsAuthorization,
+                    Authorization: await lrsAuthorization(),
                     'X-Experience-API-Version': '1.0.0',
                 },
             })
@@ -75,7 +76,7 @@ const lrsGateway = (initializer) => (configProvider) => {
                 .then(json => json);
         };
         const getXapiStatements = async ({ user, anyUser, ...options }) => {
-            return initializer.fetch((await lrsHost).replace(/\/+$/, '') + '/data/xAPI/statements?' + queryString.stringify({
+            return initializer.fetch((await lrsHost()).replace(/\/+$/, '') + '/data/xAPI/statements?' + queryString.stringify({
                 ...options,
                 ...(anyUser === true ? {} : {
                     agent: JSON.stringify({
@@ -88,7 +89,7 @@ const lrsGateway = (initializer) => (configProvider) => {
                 })
             }), {
                 headers: {
-                    Authorization: await lrsAuthorization,
+                    Authorization: await lrsAuthorization(),
                     'X-Experience-API-Version': '1.0.0',
                 },
             })

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

@@ -1,25 +1,19 @@
-declare type KeysMatching<T, V> = {
-    [K in keyof T]-?: T[K] extends V ? K : never;
-}[keyof T];
-declare type UnArray<T> = T extends Array<infer I> ? I : T;
-declare type FilterFieldTypes = string | string[];
-declare type Filter<F extends keyof T, T> = F extends KeysMatching<T, FilterFieldTypes> ? {
-    key: F;
-    value: UnArray<T[F]> | UnArray<T[F]>[];
-} : never;
-declare type QueryFieldTypes = string | string[] | undefined | null;
-declare type Field<F extends keyof T, T> = F extends KeysMatching<T, QueryFieldTypes> ? ({
-    key: F;
+declare type Filter = {
+    key: string;
+    value: string | string[];
+};
+declare type Field = {
+    key: string;
     type?: 'text';
     weight: number;
 } | {
-    key: F;
+    key: string;
     type: 'keyword';
-}) : never;
-export interface SearchOptions<T> {
+};
+export interface SearchOptions {
     page?: number;
     query: string | undefined;
-    fields: Field<keyof T, T>[];
-    filter?: Filter<keyof T, T>[];
+    fields: Field[];
+    filter?: Filter[];
 }
 export {};

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

@@ -2,7 +2,7 @@ import { SearchOptions } from '.';
 export declare const memorySearchTheBadWay: <T>({ loadAllDocumentsTheBadWay }: {
     loadAllDocumentsTheBadWay: () => Promise<T[]>;
 }) => {
-    search: (options: SearchOptions<T>) => Promise<{
+    search: (options: SearchOptions) => Promise<{
         items: T[];
         pageSize: number;
         currentPage: number;

package/dist/services/searchProvider/memorySearchTheBadWay.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.memorySearchTheBadWay = void 0;
+const __1 = require("../..");
 const guards_1 = require("../../guards");
 const MIN_MATCH = 0.5;
 const MAX_RESULTS = 10;
+const resolveField = (document, field) => field.key.toString().split('.').reduce((result, key) => result[key], document);
 const memorySearchTheBadWay = ({ loadAllDocumentsTheBadWay }) => {
     return {
         search: async (options) => {
@@ -15,7 +17,7 @@ const memorySearchTheBadWay = ({ loadAllDocumentsTheBadWay }) => {
                         if (field.type !== undefined && field.type !== 'text') {
                             continue;
                         }
-                        const value = document[field.key];
+                        const value = resolveField(document, field);
                         if (value === undefined || value === null) {
                             continue;
                         }
@@ -30,14 +32,8 @@ const memorySearchTheBadWay = ({ loadAllDocumentsTheBadWay }) => {
                     }
                 }
                 for (const field of options.filter || []) {
-                    const value = document[field.key];
-                    if (value instanceof Array) {
-                        if (!(field.value instanceof Array && field.value.some(v => value.includes(v)))
-                            && !(!(field.value instanceof Array) && value.includes(field.value))) {
-                            return undefined;
-                        }
-                    }
-                    else if (value !== field.value) {
+                    const value = resolveField(document, field);
+                    if (!(0, __1.coerceArray)(field.value).some(v => (0, __1.coerceArray)(value).includes(v))) {
                         return undefined;
                     }
                 }

package/dist/services/versionedDocumentStore/dynamodb.js

@@ -53,12 +53,12 @@ const decodeDynamoDocument = (document) => Object.fromEntries(Object.entries(doc
 // i'm not really excited about getAuthor being required, but ts is getting confused about the type when unspecified
 const dynamoVersionedDocumentStore = (initializer) => () => (configProvider) => ({ profile }, hashKey, getAuthor) => {
     const options = (0, guards_1.ifDefined)(initializer, {});
-    const tableName = (0, config_1.resolveConfigValue)(configProvider[(0, guards_1.ifDefined)(options.configSpace, 'dynamodb')].tableName);
+    const tableName = (0, __1.once)(() => (0, config_1.resolveConfigValue)(configProvider[(0, guards_1.ifDefined)(options.configSpace, 'dynamodb')].tableName));
     return {
         loadAllDocumentsTheBadWay: profile.track('versionedDocumentStore.loadAllDocumentsTheBadWay', () => async () => {
             const loadAllResults = async (ExclusiveStartKey) => {
                 var _a;
-                const cmd = new client_dynamodb_1.ScanCommand({ TableName: await tableName, ExclusiveStartKey });
+                const cmd = new client_dynamodb_1.ScanCommand({ TableName: await tableName(), ExclusiveStartKey });
                 const result = await dynamodb().send(cmd);
                 const resultItems = ((_a = result.Items) === null || _a === void 0 ? void 0 : _a.map(decodeDynamoDocument)) || [];
                 if (result.LastEvaluatedKey) {
@@ -77,7 +77,7 @@ const dynamoVersionedDocumentStore = (initializer) => () => (configProvider) =>
         }),
         getVersions: profile.track('versionedDocumentStore.getVersions', () => async (id, startVersion) => {
             const cmd = new client_dynamodb_1.QueryCommand({
-                TableName: await tableName,
+                TableName: await tableName(),
                 KeyConditionExpression: '#hk = :hkv',
                 ExpressionAttributeValues: {
                     ':hkv': encodeDynamoAttribute(id)
@@ -119,7 +119,7 @@ const dynamoVersionedDocumentStore = (initializer) => () => (configProvider) =>
                 expressionAttributeValues[':tsv'] = encodeDynamoAttribute(timestamp);
             }
             const cmd = new client_dynamodb_1.QueryCommand({
-                TableName: await tableName,
+                TableName: await tableName(),
                 KeyConditionExpression: keyConditionExpression,
                 ExpressionAttributeNames: expressionAttributeNames,
                 ExpressionAttributeValues: expressionAttributeValues,
@@ -140,7 +140,7 @@ const dynamoVersionedDocumentStore = (initializer) => () => (configProvider) =>
                 author
             };
             const cmd = new client_dynamodb_1.PutItemCommand({
-                TableName: await tableName,
+                TableName: await tableName(),
                 Item: encodeDynamoDocument(document),
             });
             return dynamodb().send(cmd)