@openstax/ts-utils 1.27.6 → 1.29.0

package/dist/cjs/errors/index.d.ts

@@ -75,3 +75,14 @@ export declare class SessionExpiredError extends Error {
     static matches: (e: any) => e is typeof SessionExpiredError;
     constructor(message?: string);
 }
+/**
+ * Conflict error
+ *
+ * `ConflictError.matches(error)` is a reliable way to check if an error is a
+ * `ConflictError`; `instanceof` checks may not work if code is split into multiple bundles
+ */
+export declare class ConflictError extends Error {
+    static readonly TYPE = "ConflictError";
+    static matches: (e: any) => e is typeof ConflictError;
+    constructor(message?: string);
+}

package/dist/cjs/errors/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SessionExpiredError = exports.NotFoundError = exports.ForbiddenError = exports.UnauthorizedError = exports.ValidationError = exports.InvalidRequestError = exports.isAppError = void 0;
+exports.ConflictError = exports.SessionExpiredError = exports.NotFoundError = exports.ForbiddenError = exports.UnauthorizedError = exports.ValidationError = exports.InvalidRequestError = exports.isAppError = void 0;
 /*
  * if code is split into multiple bundles, sometimes each bundle
  * will get its own definition of this module and then instanceof checks
@@ -107,3 +107,17 @@ class SessionExpiredError extends Error {
 exports.SessionExpiredError = SessionExpiredError;
 SessionExpiredError.TYPE = 'SessionExpiredError';
 SessionExpiredError.matches = errorIsType(SessionExpiredError);
+/**
+ * Conflict error
+ *
+ * `ConflictError.matches(error)` is a reliable way to check if an error is a
+ * `ConflictError`; `instanceof` checks may not work if code is split into multiple bundles
+ */
+class ConflictError extends Error {
+    constructor(message) {
+        super(message || ConflictError.TYPE);
+    }
+}
+exports.ConflictError = ConflictError;
+ConflictError.TYPE = 'ConflictError';
+ConflictError.matches = errorIsType(ConflictError);

package/dist/cjs/fetch/fetchStatusRetry.d.ts

@@ -2,6 +2,7 @@ import { RetryOptions } from '../misc/helpers';
 import { GenericFetch } from '.';
 interface Options extends RetryOptions {
     status?: number[];
+    timeout?: number;
 }
 export declare const fetchStatusRetry: (base: GenericFetch, options: Options) => GenericFetch;
 export {};

package/dist/cjs/fetch/fetchStatusRetry.js

@@ -3,14 +3,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetchStatusRetry = void 0;
 const helpers_1 = require("../misc/helpers");
 const fetchStatusRetry = (base, options) => {
-    return (...params) => (0, helpers_1.retryWithDelay)(() => base(...params).then(r => {
-        var _a;
-        if ((_a = options.status) === null || _a === void 0 ? void 0 : _a.includes(r.status)) {
-            return r.text().then(text => {
-                throw new Error(`fetch failed ${params[0]} -- ${r.status}: ${text}`);
+    return (...params) => (0, helpers_1.retryWithDelay)(() => {
+        const fetchPromise = base(...params).then(r => {
+            var _a;
+            if ((_a = options.status) === null || _a === void 0 ? void 0 : _a.includes(r.status)) {
+                return r.text().then(text => {
+                    throw new Error(`fetch failed ${params[0]} -- ${r.status}: ${text}`);
+                });
+            }
+            return r;
+        });
+        if (options.timeout) {
+            const timeoutPromise = new Promise((_, reject) => {
+                setTimeout(() => {
+                    reject(new Error(`fetch timeout after ${options.timeout}ms: ${params[0]}`));
+                }, options.timeout);
             });
+            return Promise.race([fetchPromise, timeoutPromise]);
         }
-        return r;
-    }), options);
+        return fetchPromise;
+    }, options);
 };
 exports.fetchStatusRetry = fetchStatusRetry;

package/dist/cjs/guards/index.d.ts

@@ -6,6 +6,14 @@
  * `const result = (array as Array<string | undefined>).filter(isDefined);`
  */
 export declare const isDefined: <X>(x: X) => x is Exclude<X, undefined>;
+/**
+ * checks if a thing is not null. while often easy to do with a simple if statement,
+ * in certain situations the guard is required and its nice to have one pre-defined.
+ * E.g. in the following example, the result is `Array<string>`.
+ *
+ * `const result = (array as Array<string | null>).filter(isNotNull);`
+ */
+export declare const isNotNull: <X>(x: X) => x is Exclude<X, null>;
 /**
  * checks if a thing is a number. while often easy to do with a simple if statement, in certain
  * situations the guard is required and its nice to have one pre-defined. E.g. in the following

package/dist/cjs/guards/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ifDefined = exports.isPlainObject = exports.isNumber = exports.isDefined = void 0;
+exports.ifDefined = exports.isPlainObject = exports.isNumber = exports.isNotNull = exports.isDefined = void 0;
 /**
  * checks if a thing is defined. while often easy to do with a simple if statement, in certain
  * situations the guard is required and its nice to have one pre-defined. E.g. in the following
@@ -10,6 +10,15 @@ exports.ifDefined = exports.isPlainObject = exports.isNumber = exports.isDefined
  */
 const isDefined = (x) => x !== undefined;
 exports.isDefined = isDefined;
+/**
+ * checks if a thing is not null. while often easy to do with a simple if statement,
+ * in certain situations the guard is required and its nice to have one pre-defined.
+ * E.g. in the following example, the result is `Array<string>`.
+ *
+ * `const result = (array as Array<string | null>).filter(isNotNull);`
+ */
+const isNotNull = (x) => x !== null;
+exports.isNotNull = isNotNull;
 /**
  * checks if a thing is a number. while often easy to do with a simple if statement, in certain
  * situations the guard is required and its nice to have one pre-defined. E.g. in the following

package/dist/cjs/services/documentStore/unversioned/dynamodb.d.ts

@@ -9,6 +9,7 @@ export declare const dynamoUnversionedDocumentStore: <C extends string = "dynamo
     tableName: import("../../../config").ConfigValueProvider<string>;
 }; }) => <K extends keyof T>(_: {}, hashKey: K, options?: {
     afterWrite?: ((item: T) => void | Promise<void>) | undefined;
+    batchAfterWrite?: ((items: T[]) => void | Promise<void>) | undefined;
 } | undefined) => {
     loadAllDocumentsTheBadWay: () => Promise<T[]>;
     getItemsByField: (key: keyof T, value: T[K], pageKey?: string | undefined) => Promise<{
@@ -20,5 +21,13 @@ export declare const dynamoUnversionedDocumentStore: <C extends string = "dynamo
     incrementItemAttribute: (id: T[K], attribute: keyof T) => Promise<number>;
     patchItem: (item: Partial<T>) => Promise<T>;
     putItem: (item: T) => Promise<T>;
+    createItem: (item: T) => Promise<T>;
+    batchCreateItem: (items: T[], concurrency?: number) => Promise<{
+        successful: T[];
+        failed: {
+            item: T;
+            error: Error;
+        }[];
+    }>;
 };
 export {};

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

@@ -1,7 +1,11 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.dynamoUnversionedDocumentStore = void 0;
 const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
+const tiny_async_pool_1 = __importDefault(require("tiny-async-pool"));
 const __1 = require("../../..");
 const config_1 = require("../../../config");
 const errors_1 = require("../../../errors");
@@ -160,6 +164,69 @@ const dynamoUnversionedDocumentStore = (initializer) => {
                 await ((_a = options === null || options === void 0 ? void 0 : options.afterWrite) === null || _a === void 0 ? void 0 : _a.call(options, updatedDoc));
                 return updatedDoc;
             },
+            /* creates a new document, fails if the primary key already exists */
+            createItem: async (item) => {
+                const cmd = new client_dynamodb_1.PutItemCommand({
+                    TableName: await tableName(),
+                    Item: (0, dynamoEncoding_1.encodeDynamoDocument)(item),
+                    ConditionExpression: 'attribute_not_exists(#k)',
+                    ExpressionAttributeNames: {
+                        '#k': hashKey.toString(),
+                    },
+                });
+                return await dynamodb().send(cmd).then(() => item).catch((error) => {
+                    throw error.name === 'ConditionalCheckFailedException' ?
+                        new errors_1.ConflictError(`Item with ${String(hashKey)} "${item[hashKey]}" already exists`) : error;
+                }).then(async (createdDoc) => {
+                    var _a;
+                    await ((_a = options === null || options === void 0 ? void 0 : options.afterWrite) === null || _a === void 0 ? void 0 : _a.call(options, createdDoc));
+                    return createdDoc;
+                });
+            },
+            /* creates multiple new documents, returns successful and failed items separately */
+            batchCreateItem: async (items, concurrency = 10) => {
+                if (items.length === 0)
+                    return { successful: [], failed: [] };
+                const successful = [];
+                const failed = [];
+                // Process using async iterator (tiny-async-pool v2)
+                for await (const result of (0, tiny_async_pool_1.default)(concurrency, items, async (item) => {
+                    var _a;
+                    try {
+                        const cmd = new client_dynamodb_1.PutItemCommand({
+                            TableName: await tableName(),
+                            Item: (0, dynamoEncoding_1.encodeDynamoDocument)(item),
+                            ConditionExpression: 'attribute_not_exists(#k)',
+                            ExpressionAttributeNames: {
+                                '#k': hashKey.toString(),
+                            },
+                        });
+                        await dynamodb().send(cmd);
+                        // Only call individual afterWrite if batchAfterWrite is not defined
+                        if (!(options === null || options === void 0 ? void 0 : options.batchAfterWrite)) {
+                            await ((_a = options === null || options === void 0 ? void 0 : options.afterWrite) === null || _a === void 0 ? void 0 : _a.call(options, item));
+                        }
+                        return { success: true, item };
+                    }
+                    catch (error) {
+                        const processedError = error.name === 'ConditionalCheckFailedException' ?
+                            new errors_1.ConflictError(`Item with ${String(hashKey)} "${item[hashKey]}" already exists`) : error;
+                        return { success: false, item, error: processedError };
+                    }
+                })) {
+                    if (result.success) {
+                        successful.push(result.item);
+                    }
+                    else {
+                        failed.push({ item: result.item, error: result.error });
+                    }
+                }
+                // Call batchAfterWrite with all successful items if defined
+                if ((options === null || options === void 0 ? void 0 : options.batchAfterWrite) && successful.length > 0) {
+                    await options.batchAfterWrite(successful);
+                }
+                return { successful, failed };
+            },
         };
     };
 };

package/dist/cjs/services/documentStore/unversioned/file-system.d.ts

@@ -7,7 +7,10 @@ interface Initializer<C> {
 }
 export declare const fileSystemUnversionedDocumentStore: <C extends string = "fileSystem">(initializer: Initializer<C>) => <T extends TDocument<T>>() => (configProvider: { [key in C]: {
     tableName: import("../../../config").ConfigValueProvider<string>;
-}; }) => <K extends keyof T>(_: {}, hashKey: K) => {
+}; }) => <K extends keyof T>(_: {}, hashKey: K, options?: {
+    afterWrite?: ((item: T) => void | Promise<void>) | undefined;
+    batchAfterWrite?: ((items: T[]) => void | Promise<void>) | undefined;
+} | undefined) => {
     loadAllDocumentsTheBadWay: () => Promise<T[]>;
     getItemsByField: (key: keyof T, value: T[K], pageKey?: string | undefined) => Promise<{
         items: T[];
@@ -18,5 +21,13 @@ export declare const fileSystemUnversionedDocumentStore: <C extends string = "fi
     incrementItemAttribute: (id: T[K], attribute: keyof T) => Promise<number>;
     patchItem: (item: Partial<T>) => Promise<T>;
     putItem: (item: T) => Promise<T>;
+    createItem: (item: T) => Promise<T>;
+    batchCreateItem: (items: T[], _concurrency?: number) => Promise<{
+        successful: T[];
+        failed: {
+            item: T;
+            error: Error;
+        }[];
+    }>;
 };
 export {};

package/dist/cjs/services/documentStore/unversioned/file-system.js

@@ -33,7 +33,7 @@ const __1 = require("../../..");
 const config_1 = require("../../../config");
 const errors_1 = require("../../../errors");
 const guards_1 = require("../../../guards");
-const fileSystemUnversionedDocumentStore = (initializer) => () => (configProvider) => (_, hashKey) => {
+const fileSystemUnversionedDocumentStore = (initializer) => () => (configProvider) => (_, hashKey, options) => {
     const tableName = (0, config_1.resolveConfigValue)(configProvider[initializer.configSpace || 'fileSystem'].tableName);
     const tablePath = tableName.then((table) => path_1.default.join(initializer.dataDir, table));
     const { mkdir, readdir, readFile, writeFile } = (0, guards_1.ifDefined)(initializer.fs, fsModule);
@@ -128,6 +128,54 @@ const fileSystemUnversionedDocumentStore = (initializer) => () => (configProvide
                 writeFile(path, JSON.stringify(item, null, 2), (err) => err ? reject(err) : resolve(item));
             });
         },
+        createItem: async (item) => {
+            const hashed = hashFilename(item[hashKey]);
+            const existingItem = await load(hashed);
+            if (existingItem) {
+                throw new errors_1.ConflictError(`Item with ${String(hashKey)} "${item[hashKey]}" already exists`);
+            }
+            const path = await filePath(hashed);
+            await mkTableDir;
+            return new Promise((resolve, reject) => {
+                writeFile(path, JSON.stringify(item, null, 2), (err) => err ? reject(err) : resolve(item));
+            });
+        },
+        batchCreateItem: async (items, _concurrency = 1) => {
+            var _a;
+            if (items.length === 0)
+                return { successful: [], failed: [] };
+            const successful = [];
+            const failed = [];
+            // Process items sequentially to ensure consistent conflict detection
+            // Note: concurrency parameter is ignored for filesystem to avoid race conditions
+            for (const item of items) {
+                try {
+                    const hashed = hashFilename(item[hashKey]);
+                    const existingItem = await load(hashed);
+                    if (existingItem) {
+                        throw new errors_1.ConflictError(`Item with ${String(hashKey)} "${item[hashKey]}" already exists`);
+                    }
+                    const path = await filePath(hashed);
+                    await mkTableDir;
+                    const createdItem = await new Promise((resolve, reject) => {
+                        writeFile(path, JSON.stringify(item, null, 2), (err) => err ? reject(err) : resolve(item));
+                    });
+                    successful.push(createdItem);
+                    // Only call individual afterWrite if batchAfterWrite is not defined
+                    if (!(options === null || options === void 0 ? void 0 : options.batchAfterWrite)) {
+                        await ((_a = options === null || options === void 0 ? void 0 : options.afterWrite) === null || _a === void 0 ? void 0 : _a.call(options, createdItem));
+                    }
+                }
+                catch (error) {
+                    failed.push({ item, error: error });
+                }
+            }
+            // Call batchAfterWrite with all successful items if defined
+            if ((options === null || options === void 0 ? void 0 : options.batchAfterWrite) && successful.length > 0) {
+                await options.batchAfterWrite(successful);
+            }
+            return { successful, failed };
+        },
     };
 };
 exports.fileSystemUnversionedDocumentStore = fileSystemUnversionedDocumentStore;

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

@@ -3,6 +3,7 @@ import type { JWK } from 'node-jose';
 import { ConfigProviderForConfig } from '../../config';
 declare type Config = {
     trustedDomain: string;
+    bypassSignatureVerification: string;
 };
 interface Initializer<C> {
     configSpace?: C;
@@ -15,6 +16,7 @@ interface Initializer<C> {
  */
 export declare const createLaunchVerifier: <C extends string = "launch">({ configSpace, fetcher }: Initializer<C>) => (configProvider: { [key in C]: {
     trustedDomain: import("../../config").ConfigValueProvider<string>;
+    bypassSignatureVerification: import("../../config").ConfigValueProvider<string>;
 }; }) => (_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>;
 };

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

@@ -37,6 +37,7 @@ const helpers_1 = require("../../misc/helpers");
 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 getBypassSignatureVerification = (0, helpers_1.once)(async () => (await (0, config_1.resolveConfigValue)(config.bypassSignatureVerification)) === 'true');
     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);
@@ -63,25 +64,26 @@ const createLaunchVerifier = ({ configSpace, fetcher }) => (configProvider) => {
         }
     };
     return (_services, getDefaultToken) => {
-        const verify = (...args) => {
+        const verify = async (...args) => {
             const [inputToken, validator] = args.length === 1
                 ? typeof args[0] === 'string'
                     ? [args[0], undefined]
                     : [undefined, args[0]]
                 : args;
+            const bypassSignatureVerification = await getBypassSignatureVerification();
             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) => {
+                const resolvePayload = (err, payload) => {
                     if (err && err instanceof jsonwebtoken_1.TokenExpiredError) {
                         reject(new errors_1.SessionExpiredError());
                     }
                     else if (err) {
                         reject(err);
                     }
-                    else if (typeof payload !== 'object') {
+                    else if (typeof payload !== 'object' || payload === null) {
                         reject(new Error('received JWT token with unexpected non-JSON payload'));
                     }
                     else if (!payload.sub) {
@@ -102,7 +104,13 @@ const createLaunchVerifier = ({ configSpace, fetcher }) => (configProvider) => {
                         // conditional return types are annoying
                         resolve((validator ? validator(parsed) : parsed));
                     }
-                });
+                };
+                if (bypassSignatureVerification) {
+                    return resolvePayload(null, jsonwebtoken_1.default.decode(token));
+                }
+                else {
+                    return jsonwebtoken_1.default.verify(token, getKey, {}, resolvePayload);
+                }
             });
         };
         return { verify };

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

@@ -26,6 +26,9 @@ const openSearchService = (initializer = {}) => (configProvider) => {
             region: await (0, config_1.resolveConfigValue)(config.region),
             service: 'es',
         }),
+        maxRetries: 3,
+        requestTimeout: 3000,
+        pingTimeout: 1000,
         node: await (0, config_1.resolveConfigValue)(config.node),
     }));
     return (indexConfig) => {