@openstax/ts-utils 1.27.1 → 1.27.3

package/dist/cjs/services/documentStore/versioned/dynamodb.js

@@ -6,136 +6,138 @@ const __1 = require("../../..");
 const config_1 = require("../../../config");
 const guards_1 = require("../../../guards");
 const dynamoEncoding_1 = require("../dynamoEncoding");
-const dynamodb = (0, __1.once)(() => new client_dynamodb_1.DynamoDB({ apiVersion: '2012-08-10' }));
 // i'm not really excited about getAuthor being required, but ts is getting confused about the type when unspecified
-const dynamoVersionedDocumentStore = (initializer) => () => (configProvider) => (_, hashKey, options) => {
+const dynamoVersionedDocumentStore = (initializer) => {
     const init = (0, guards_1.ifDefined)(initializer, {});
-    const tableName = (0, __1.once)(() => (0, config_1.resolveConfigValue)(configProvider[(0, guards_1.ifDefined)(init.configSpace, 'dynamodb')].tableName));
-    return {
-        loadAllDocumentsTheBadWay: async () => {
-            const loadAllResults = async (ExclusiveStartKey) => {
-                var _a;
-                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(dynamoEncoding_1.decodeDynamoDocument)) || [];
-                if (result.LastEvaluatedKey) {
-                    return [...resultItems, ...await loadAllResults(result.LastEvaluatedKey)];
-                }
-                return resultItems;
-            };
-            const allResults = await loadAllResults().then(results => results.reduce((result, document) => {
-                const current = result.get(document[hashKey]);
-                if (!current || current.timestamp < document.timestamp) {
-                    return result.set(document[hashKey], document);
-                }
-                return result;
-            }, new Map()));
-            return Array.from(allResults.values());
-        },
-        getVersions: async (id, startVersion) => {
-            const cmd = new client_dynamodb_1.QueryCommand({
-                TableName: await tableName(),
-                KeyConditionExpression: '#hk = :hkv',
-                ExpressionAttributeValues: {
-                    ':hkv': (0, dynamoEncoding_1.encodeDynamoAttribute)(id)
-                },
-                ExpressionAttributeNames: {
+    const dynamodb = (0, __1.once)(() => { var _a; return (_a = init.dynamoClient) !== null && _a !== void 0 ? _a : new client_dynamodb_1.DynamoDB({ apiVersion: '2012-08-10' }); });
+    return () => (configProvider) => (_, hashKey, options) => {
+        const tableName = (0, __1.once)(() => (0, config_1.resolveConfigValue)(configProvider[(0, guards_1.ifDefined)(init.configSpace, 'dynamodb')].tableName));
+        return {
+            loadAllDocumentsTheBadWay: async () => {
+                const loadAllResults = async (ExclusiveStartKey) => {
+                    var _a;
+                    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(dynamoEncoding_1.decodeDynamoDocument)) || [];
+                    if (result.LastEvaluatedKey) {
+                        return [...resultItems, ...await loadAllResults(result.LastEvaluatedKey)];
+                    }
+                    return resultItems;
+                };
+                const allResults = await loadAllResults().then(results => results.reduce((result, document) => {
+                    const current = result.get(document[hashKey]);
+                    if (!current || current.timestamp < document.timestamp) {
+                        return result.set(document[hashKey], document);
+                    }
+                    return result;
+                }, new Map()));
+                return Array.from(allResults.values());
+            },
+            getVersions: async (id, startVersion) => {
+                const cmd = new client_dynamodb_1.QueryCommand({
+                    TableName: await tableName(),
+                    KeyConditionExpression: '#hk = :hkv',
+                    ExpressionAttributeValues: {
+                        ':hkv': (0, dynamoEncoding_1.encodeDynamoAttribute)(id)
+                    },
+                    ExpressionAttributeNames: {
+                        '#hk': hashKey.toString()
+                    },
+                    ...(startVersion
+                        ? { ExclusiveStartKey: {
+                                [hashKey]: (0, dynamoEncoding_1.encodeDynamoAttribute)(id),
+                                timestamp: { N: startVersion.toString() }
+                            } }
+                        : {}),
+                    ScanIndexForward: false,
+                });
+                return dynamodb().send(cmd).then(result => {
+                    var _a;
+                    const items = (_a = result.Items) === null || _a === void 0 ? void 0 : _a.map(dynamoEncoding_1.decodeDynamoDocument);
+                    if (!items || items.length === 0) {
+                        return undefined;
+                    }
+                    return {
+                        items,
+                        nextPageToken: result.LastEvaluatedKey ? (0, dynamoEncoding_1.decodeDynamoDocument)(result.LastEvaluatedKey).timestamp : undefined
+                    };
+                });
+            },
+            getItem: async (id, timestamp) => {
+                let keyConditionExpression = '#hk = :hkv';
+                const expressionAttributeNames = {
                     '#hk': hashKey.toString()
-                },
-                ...(startVersion
-                    ? { ExclusiveStartKey: {
-                            [hashKey]: (0, dynamoEncoding_1.encodeDynamoAttribute)(id),
-                            timestamp: { N: startVersion.toString() }
-                        } }
-                    : {}),
-                ScanIndexForward: false,
-            });
-            return dynamodb().send(cmd).then(result => {
-                var _a;
-                const items = (_a = result.Items) === null || _a === void 0 ? void 0 : _a.map(dynamoEncoding_1.decodeDynamoDocument);
-                if (!items || items.length === 0) {
-                    return undefined;
+                };
+                const expressionAttributeValues = {
+                    ':hkv': (0, dynamoEncoding_1.encodeDynamoAttribute)(id)
+                };
+                if (timestamp) {
+                    keyConditionExpression += ' and #ts = :tsv';
+                    expressionAttributeNames['#ts'] = 'timestamp';
+                    expressionAttributeValues[':tsv'] = (0, dynamoEncoding_1.encodeDynamoAttribute)(timestamp);
                 }
+                const cmd = new client_dynamodb_1.QueryCommand({
+                    TableName: await tableName(),
+                    KeyConditionExpression: keyConditionExpression,
+                    ExpressionAttributeNames: expressionAttributeNames,
+                    ExpressionAttributeValues: expressionAttributeValues,
+                    ScanIndexForward: false,
+                    Limit: 1
+                });
+                return dynamodb().send(cmd).then(result => {
+                    var _a;
+                    return (_a = result.Items) === null || _a === void 0 ? void 0 : _a.map(dynamoEncoding_1.decodeDynamoDocument)[0];
+                });
+            },
+            /* prepares a new version of a document with the given data, then allows some additional
+             * changes to be input to a `save` function that actually saves it. useful for additional
+             * changes based on the new document version or author. the document version and author
+             * cannot be modified */
+            prepareItem: async (item, ...authorArgs) => {
+                // this getAuthor type is terrible
+                const author = (options === null || options === void 0 ? void 0 : options.getAuthor) ? await options.getAuthor(...authorArgs) : authorArgs[0];
+                const timestamp = new Date().getTime();
                 return {
-                    items,
-                    nextPageToken: result.LastEvaluatedKey ? (0, dynamoEncoding_1.decodeDynamoDocument)(result.LastEvaluatedKey).timestamp : undefined
+                    document: { ...item, timestamp, author },
+                    save: async (changes) => {
+                        var _a;
+                        const document = {
+                            ...item,
+                            ...changes,
+                            timestamp,
+                            author
+                        };
+                        const cmd = new client_dynamodb_1.PutItemCommand({
+                            TableName: await tableName(),
+                            Item: (0, dynamoEncoding_1.encodeDynamoDocument)(document),
+                        });
+                        const updatedDoc = await dynamodb().send(cmd)
+                            .then(() => document);
+                        await ((_a = options === null || options === void 0 ? void 0 : options.afterWrite) === null || _a === void 0 ? void 0 : _a.call(options, updatedDoc));
+                        return updatedDoc;
+                    }
                 };
-            });
-        },
-        getItem: async (id, timestamp) => {
-            let keyConditionExpression = '#hk = :hkv';
-            const expressionAttributeNames = {
-                '#hk': hashKey.toString()
-            };
-            const expressionAttributeValues = {
-                ':hkv': (0, dynamoEncoding_1.encodeDynamoAttribute)(id)
-            };
-            if (timestamp) {
-                keyConditionExpression += ' and #ts = :tsv';
-                expressionAttributeNames['#ts'] = 'timestamp';
-                expressionAttributeValues[':tsv'] = (0, dynamoEncoding_1.encodeDynamoAttribute)(timestamp);
-            }
-            const cmd = new client_dynamodb_1.QueryCommand({
-                TableName: await tableName(),
-                KeyConditionExpression: keyConditionExpression,
-                ExpressionAttributeNames: expressionAttributeNames,
-                ExpressionAttributeValues: expressionAttributeValues,
-                ScanIndexForward: false,
-                Limit: 1
-            });
-            return dynamodb().send(cmd).then(result => {
+            },
+            /* saves a new version of a document with the given data */
+            putItem: async (item, ...authorArgs) => {
                 var _a;
-                return (_a = result.Items) === null || _a === void 0 ? void 0 : _a.map(dynamoEncoding_1.decodeDynamoDocument)[0];
-            });
-        },
-        /* prepares a new version of a document with the given data, then allows some additional
-         * changes to be input to a `save` function that actually saves it. useful for additional
-         * changes based on the new document version or author. the document version and author
-         * cannot be modified */
-        prepareItem: async (item, ...authorArgs) => {
-            // this getAuthor type is terrible
-            const author = (options === null || options === void 0 ? void 0 : options.getAuthor) ? await options.getAuthor(...authorArgs) : authorArgs[0];
-            const timestamp = new Date().getTime();
-            return {
-                document: { ...item, timestamp, author },
-                save: async (changes) => {
-                    var _a;
-                    const document = {
-                        ...item,
-                        ...changes,
-                        timestamp,
-                        author
-                    };
-                    const cmd = new client_dynamodb_1.PutItemCommand({
-                        TableName: await tableName(),
-                        Item: (0, dynamoEncoding_1.encodeDynamoDocument)(document),
-                    });
-                    const updatedDoc = await dynamodb().send(cmd)
-                        .then(() => document);
-                    await ((_a = options === null || options === void 0 ? void 0 : options.afterWrite) === null || _a === void 0 ? void 0 : _a.call(options, updatedDoc));
-                    return updatedDoc;
-                }
-            };
-        },
-        /* saves a new version of a document with the given data */
-        putItem: async (item, ...authorArgs) => {
-            var _a;
-            // this getAuthor type is terrible
-            const author = (options === null || options === void 0 ? void 0 : options.getAuthor) ? await options.getAuthor(...authorArgs) : authorArgs[0];
-            const document = {
-                ...item,
-                timestamp: new Date().getTime(),
-                author
-            };
-            const cmd = new client_dynamodb_1.PutItemCommand({
-                TableName: await tableName(),
-                Item: (0, dynamoEncoding_1.encodeDynamoDocument)(document),
-            });
-            const updatedDoc = await dynamodb().send(cmd)
-                .then(() => document);
-            await ((_a = options === null || options === void 0 ? void 0 : options.afterWrite) === null || _a === void 0 ? void 0 : _a.call(options, updatedDoc));
-            return updatedDoc;
-        },
+                // this getAuthor type is terrible
+                const author = (options === null || options === void 0 ? void 0 : options.getAuthor) ? await options.getAuthor(...authorArgs) : authorArgs[0];
+                const document = {
+                    ...item,
+                    timestamp: new Date().getTime(),
+                    author
+                };
+                const cmd = new client_dynamodb_1.PutItemCommand({
+                    TableName: await tableName(),
+                    Item: (0, dynamoEncoding_1.encodeDynamoDocument)(document),
+                });
+                const updatedDoc = await dynamodb().send(cmd)
+                    .then(() => document);
+                await ((_a = options === null || options === void 0 ? void 0 : options.afterWrite) === null || _a === void 0 ? void 0 : _a.call(options, updatedDoc));
+                return updatedDoc;
+            },
+        };
     };
 };
 exports.dynamoVersionedDocumentStore = dynamoVersionedDocumentStore;

package/dist/cjs/services/fileServer/s3FileServer.d.ts

@@ -7,7 +7,7 @@ export declare type Config = {
 };
 interface Initializer<C> {
     configSpace?: C;
-    s3Client?: typeof S3Client;
+    getS3Client?: (...args: ConstructorParameters<typeof S3Client>) => S3Client;
 }
 export declare const s3FileServer: <C extends string = "deployed">(initializer: Initializer<C>) => (configProvider: { [key in C]: {
     bucketName: import("../../config").ConfigValueProvider<string>;

package/dist/cjs/services/fileServer/s3FileServer.js

@@ -12,8 +12,11 @@ const s3FileServer = (initializer) => (configProvider) => {
     const config = configProvider[(0, guards_1.ifDefined)(initializer.configSpace, 'deployed')];
     const bucketName = (0, __1.once)(() => (0, config_1.resolveConfigValue)(config.bucketName));
     const bucketRegion = (0, __1.once)(() => (0, config_1.resolveConfigValue)(config.bucketRegion));
-    const client = (0, guards_1.ifDefined)(initializer.s3Client, client_s3_1.S3Client);
-    const s3Service = (0, __1.once)(async () => new client({ apiVersion: '2012-08-10', region: await bucketRegion() }));
+    const s3Service = (0, __1.once)(async () => {
+        var _a, _b;
+        const args = { apiVersion: '2012-08-10', region: await bucketRegion() };
+        return (_b = (_a = initializer.getS3Client) === null || _a === void 0 ? void 0 : _a.call(initializer, args)) !== null && _b !== void 0 ? _b : new client_s3_1.S3Client(args);
+    });
     /*
      * https://docs.aws.amazon.com/AmazonS3/latest/userguide/ShareObjectPreSignedURL.html
      */

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

@@ -30,11 +30,13 @@ const __1 = require("../..");
 const config_1 = require("../../config");
 const errors_1 = require("../../errors");
 const guards_1 = require("../../guards");
+const helpers_1 = require("../../misc/helpers");
 /**
  * Creates a class that can verify launch params
  */
 const createLaunchVerifier = ({ configSpace, fetcher }) => (configProvider) => {
     const config = configProvider[(0, guards_1.ifDefined)(configSpace, 'launch')];
+    const getTrustedDomain = (0, helpers_1.once)(() => (0, config_1.resolveConfigValue)(config.trustedDomain));
     const getJwksClient = (0, __1.memoize)((jwksUri) => new jwks_rsa_1.JwksClient({ fetcher, jwksUri }));
     const getJwksKey = (0, __1.memoize)(async (jwksUri, kid) => {
         const client = getJwksClient(jwksUri);
@@ -50,7 +52,7 @@ const createLaunchVerifier = ({ configSpace, fetcher }) => (configProvider) => {
         try {
             const jwksUrl = new URL('/.well-known/jwks.json', iss);
             const launchDomain = jwksUrl.hostname;
-            const trustedDomain = await (0, config_1.resolveConfigValue)(config.trustedDomain);
+            const trustedDomain = await getTrustedDomain();
             if (launchDomain !== trustedDomain && !launchDomain.endsWith(`.${trustedDomain}`)) {
                 return callback(new Error(`Untrusted launch domain: "${launchDomain}"`));
             }

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

@@ -31,6 +31,10 @@ declare type Field = {
 } | {
     key: string;
     type: 'keyword';
+} | {
+    key: string;
+    type: 'date';
+    format?: string;
 } | {
     key: string;
     type: 'boolean';