@openstax/ts-utils 1.34.0 → 1.35.0

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

@@ -0,0 +1,233 @@
+"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");
+const guards_1 = require("../../../guards");
+const dynamoEncoding_1 = require("../dynamoEncoding");
+const dynamoUnversionedDocumentStore = (initializer) => {
+    const init = (0, guards_1.ifDefined)(initializer, {});
+    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, _b;
+                    const cmd = new client_dynamodb_1.ScanCommand({ TableName: await tableName(), ExclusiveStartKey });
+                    const result = await dynamodb().send(cmd);
+                    const resultItems = (_b = (_a = result.Items) === null || _a === void 0 ? void 0 : _a.map((item) => (0, dynamoEncoding_1.decodeDynamoDocument)(item))) !== null && _b !== void 0 ? _b : [];
+                    if (result.LastEvaluatedKey) {
+                        return [...resultItems, ...await loadAllResults(result.LastEvaluatedKey)];
+                    }
+                    return resultItems;
+                };
+                return loadAllResults();
+            },
+            /*
+             * requires that a global secondary index exist on the table
+             */
+            getItemsByField: async (key, value, pageKey) => {
+                var _a, _b;
+                const ExclusiveStartKey = pageKey
+                    ? JSON.parse(Buffer.from(pageKey, 'base64').toString('utf-8'))
+                    : undefined;
+                const table = await tableName();
+                const cmd = new client_dynamodb_1.QueryCommand({
+                    TableName: table,
+                    IndexName: key.toString(),
+                    ExclusiveStartKey,
+                    KeyConditionExpression: '#hk = :hkv',
+                    ExpressionAttributeValues: {
+                        ':hkv': (0, dynamoEncoding_1.encodeDynamoAttribute)(value),
+                    },
+                    ExpressionAttributeNames: {
+                        '#hk': key.toString(),
+                    },
+                });
+                const response = await dynamodb().send(cmd);
+                const items = (_b = (_a = response.Items) === null || _a === void 0 ? void 0 : _a.map((item) => (0, dynamoEncoding_1.decodeDynamoDocument)(item))) !== null && _b !== void 0 ? _b : [];
+                const nextPageToken = response.LastEvaluatedKey;
+                return {
+                    items,
+                    nextPageToken: nextPageToken
+                        ? Buffer.from(JSON.stringify(nextPageToken)).toString('base64')
+                        : undefined,
+                };
+            },
+            batchGetItem: async (ids) => {
+                const table = await tableName();
+                const key = hashKey.toString();
+                const getBatches = async (requestItems) => {
+                    const cmd = new client_dynamodb_1.BatchGetItemCommand({
+                        RequestItems: requestItems !== null && requestItems !== void 0 ? requestItems : { [table]: { Keys: ids.map((id) => ({ [key]: (0, dynamoEncoding_1.encodeDynamoAttribute)(id) })) } },
+                    });
+                    const response = await dynamodb().send(cmd);
+                    const currentResponses = response.Responses ?
+                        response.Responses[table].map(response => (0, dynamoEncoding_1.decodeDynamoDocument)(response)) : [];
+                    return currentResponses.concat(response.UnprocessedKeys ? await getBatches(response.UnprocessedKeys) : []);
+                };
+                return getBatches();
+            },
+            getItem: async (id) => {
+                const cmd = new client_dynamodb_1.GetItemCommand({
+                    Key: { [hashKey.toString()]: (0, dynamoEncoding_1.encodeDynamoAttribute)(id) },
+                    TableName: await tableName(),
+                });
+                return dynamodb().send(cmd).then(result => result.Item ? (0, dynamoEncoding_1.decodeDynamoDocument)(result.Item) : undefined);
+            },
+            /* atomically increments the given item attribute by 1 */
+            incrementItemAttribute: async (id, attribute) => {
+                const key = hashKey.toString();
+                const field = attribute.toString();
+                const cmd = new client_dynamodb_1.UpdateItemCommand({
+                    Key: { [key]: (0, dynamoEncoding_1.encodeDynamoAttribute)(id) },
+                    TableName: await tableName(),
+                    UpdateExpression: 'ADD #f :one',
+                    ConditionExpression: 'attribute_exists(#k)',
+                    ExpressionAttributeNames: { '#k': hashKey.toString(), '#f': field },
+                    ExpressionAttributeValues: { ':one': { N: '1' } },
+                    ReturnValues: 'ALL_NEW',
+                });
+                return dynamodb().send(cmd).then(async (item) => {
+                    var _a, _b, _c;
+                    const result = (_b = (_a = item.Attributes) === null || _a === void 0 ? void 0 : _a[field]) === null || _b === void 0 ? void 0 : _b['N'];
+                    if (!item.Attributes) {
+                        throw new errors_1.NotFoundError(`Item with ${key} "${id}" does not exist`);
+                    }
+                    if (!result) {
+                        throw new errors_1.NotFoundError(`Item with ${key} "${id}" did not produce field "${field}"`);
+                    }
+                    const updatedDoc = (0, dynamoEncoding_1.decodeDynamoDocument)(item.Attributes);
+                    await ((_c = options === null || options === void 0 ? void 0 : options.afterWrite) === null || _c === void 0 ? void 0 : _c.call(options, updatedDoc));
+                    return parseFloat(result);
+                }).catch((error) => {
+                    throw error.name === 'ConditionalCheckFailedException' ?
+                        new errors_1.NotFoundError(`Item with ${key} "${id}" does not exist`) : error;
+                });
+            },
+            /* replaces only specified attributes with the given data */
+            patchItem: async (item) => {
+                const id = item[hashKey];
+                const key = hashKey.toString();
+                if (!id) {
+                    throw new Error(`Key attribute "${key}" is required for patchItem`);
+                }
+                const entries = Object.entries(item).filter(([field]) => field !== key);
+                if (entries.length === 0) {
+                    throw new Error('No attributes to update');
+                }
+                const updates = [];
+                const expressionAttributeNames = { '#k': key };
+                const expressionAttributeValues = {};
+                entries.forEach(([field, value], index) => {
+                    updates.push(`#f${index} = :f${index}`);
+                    expressionAttributeNames[`#f${index}`] = field;
+                    expressionAttributeValues[`:f${index}`] = (0, dynamoEncoding_1.encodeDynamoAttribute)(value);
+                });
+                const cmd = new client_dynamodb_1.UpdateItemCommand({
+                    Key: { [key]: (0, dynamoEncoding_1.encodeDynamoAttribute)(id) },
+                    TableName: await tableName(),
+                    UpdateExpression: `SET ${updates.join(', ')}`,
+                    ConditionExpression: 'attribute_exists(#k)',
+                    ExpressionAttributeNames: expressionAttributeNames,
+                    ExpressionAttributeValues: expressionAttributeValues,
+                    ReturnValues: 'ALL_NEW',
+                });
+                return dynamodb().send(cmd).then(async (item) => {
+                    var _a;
+                    if (!item.Attributes) {
+                        throw new errors_1.NotFoundError(`Item with ${key} "${id}" does not exist`);
+                    }
+                    const updatedDoc = (0, dynamoEncoding_1.decodeDynamoDocument)(item.Attributes);
+                    await ((_a = options === null || options === void 0 ? void 0 : options.afterWrite) === null || _a === void 0 ? void 0 : _a.call(options, updatedDoc));
+                    return updatedDoc;
+                }).catch((error) => {
+                    throw error.name === 'ConditionalCheckFailedException' ?
+                        new errors_1.NotFoundError(`Item with ${key} "${id}" does not exist`) : error;
+                });
+            },
+            /* replaces the entire document with the given data */
+            putItem: async (item) => {
+                var _a;
+                const cmd = new client_dynamodb_1.PutItemCommand({
+                    TableName: await tableName(),
+                    Item: (0, dynamoEncoding_1.encodeDynamoDocument)(item),
+                });
+                const updatedDoc = await dynamodb().send(cmd).then(() => item);
+                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 };
+            },
+        };
+    };
+};
+exports.dynamoUnversionedDocumentStore = dynamoUnversionedDocumentStore;

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

@@ -0,0 +1,32 @@
+import { Config, TDocument } from '..';
+import { ConfigProviderForConfig } from '../../../config';
+interface Initializer<C> {
+    dataDir: string;
+    fs?: Pick<typeof import('fs'), 'mkdir' | 'readdir' | 'readFile' | 'writeFile'>;
+    configSpace?: C;
+}
+export declare const fileSystemUnversionedDocumentStore: <C extends string = "fileSystem">(initializer: Initializer<C>) => <T extends TDocument<T>>() => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => <K extends keyof T>(_: {}, hashKey: K, options?: {
+    afterWrite?: (item: T) => void | Promise<void>;
+    batchAfterWrite?: (items: T[]) => void | Promise<void>;
+    skipAssert?: boolean;
+}) => {
+    loadAllDocumentsTheBadWay: () => Promise<T[]>;
+    getItemsByField: (key: keyof T, value: T[K], pageKey?: string) => Promise<{
+        items: T[];
+        nextPageToken: string | undefined;
+    }>;
+    batchGetItem: (ids: T[K][]) => Promise<Exclude<Awaited<T>, undefined>[]>;
+    getItem: (id: T[K]) => Promise<T | undefined>;
+    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: Array<{
+            item: T;
+            error: Error;
+        }>;
+    }>;
+};
+export {};

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

@@ -0,0 +1,214 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fileSystemUnversionedDocumentStore = void 0;
+const fsModule = __importStar(require("fs"));
+const path_1 = __importDefault(require("path"));
+const __1 = require("../../..");
+const config_1 = require("../../../config");
+const errors_1 = require("../../../errors");
+const guards_1 = require("../../../guards");
+const fileSystemAssert_1 = require("../fileSystemAssert");
+const fileSystemUnversionedDocumentStore = (initializer) => () => (configProvider) => (_, hashKey, options) => {
+    var _a;
+    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);
+    const skipAssert = (_a = options === null || options === void 0 ? void 0 : options.skipAssert) !== null && _a !== void 0 ? _a : false;
+    const mkTableDir = new Promise((resolve, reject) => tablePath.then((path) => mkdir(path, { recursive: true }, (err) => err && err.code !== 'EEXIST' ? reject(err) : resolve())));
+    const hashFilename = (value) => `${(0, __1.hashValue)(value)}.json`;
+    const filePath = async (filename) => path_1.default.join(await tablePath, filename);
+    const load = async (filename) => {
+        const path = await filePath(filename);
+        await mkTableDir;
+        return new Promise((resolve, reject) => {
+            readFile(path, (err, readData) => {
+                if (err) {
+                    err.code === 'ENOENT' ? resolve(undefined) : reject(err);
+                }
+                else {
+                    try {
+                        const data = JSON.parse(readData.toString());
+                        typeof data === 'object' ? resolve(data) : reject(new Error('unexpected non-object JSON'));
+                    }
+                    catch (err) {
+                        reject(err);
+                    }
+                }
+            });
+        });
+    };
+    const loadAllDocumentsTheBadWay = async () => {
+        const path = await tablePath;
+        await mkTableDir;
+        return new Promise((resolve, reject) => readdir(path, (err, files) => err ?
+            reject(err) :
+            Promise.all(files.map((file) => load(file)))
+                .then((allData) => resolve(allData.filter(guards_1.isDefined)), (err) => reject(err))));
+    };
+    return {
+        loadAllDocumentsTheBadWay,
+        getItemsByField: async (key, value, pageKey) => {
+            if (!skipAssert)
+                (0, fileSystemAssert_1.assertNoUndefined)(value, [key]);
+            const pageSize = 10;
+            const items = await loadAllDocumentsTheBadWay();
+            const filteredItems = items.filter((item) => item[key] === value);
+            const startIndex = pageKey ? parseInt(pageKey, 10) : 0;
+            const paginatedItems = filteredItems.slice(startIndex, startIndex + pageSize);
+            const nextPageToken = startIndex + pageSize < filteredItems.length
+                ? (startIndex + pageSize).toString()
+                : undefined;
+            return { items: paginatedItems, nextPageToken };
+        },
+        batchGetItem: async (ids) => {
+            const items = await Promise.all(ids.map((id) => {
+                if (!skipAssert)
+                    (0, fileSystemAssert_1.assertNoUndefined)(id, ['id']);
+                return load(hashFilename(id));
+            }));
+            return items.filter(guards_1.isDefined);
+        },
+        getItem: (id) => {
+            if (!skipAssert)
+                (0, fileSystemAssert_1.assertNoUndefined)(id, ['id']);
+            return load(hashFilename(id));
+        },
+        incrementItemAttribute: async (id, attribute) => {
+            if (!skipAssert)
+                (0, fileSystemAssert_1.assertNoUndefined)(id, ['id']);
+            const filename = hashFilename(id);
+            const path = await filePath(filename);
+            await mkTableDir;
+            const data = await load(filename);
+            if (!data) {
+                throw new errors_1.NotFoundError(`Item with ${hashKey.toString()} "${id}" does not exist`);
+            }
+            const newValue = typeof data[attribute] === 'number' ? data[attribute] + 1 : 1;
+            const newItem = { ...data, [hashKey]: id, [attribute]: newValue };
+            return new Promise((resolve, reject) => {
+                writeFile(path, JSON.stringify(newItem, null, 2), (err) => err ? reject(err) : resolve(newValue));
+            });
+        },
+        patchItem: async (item) => {
+            const id = item[hashKey];
+            if (!id) {
+                throw new Error(`Key attribute "${hashKey.toString()}" is required for patchItem`);
+            }
+            // This check is just to make this adapter consistent with the dynamo adapter
+            if (Object.keys(item).filter((key) => key !== hashKey.toString()).length === 0) {
+                throw new Error('No attributes to update');
+            }
+            const filename = hashFilename(id);
+            const path = await filePath(filename);
+            await mkTableDir;
+            const data = await load(filename);
+            if (!data) {
+                throw new errors_1.NotFoundError(`Item with ${hashKey.toString()} "${id}" does not exist`);
+            }
+            const newItem = { ...data, ...item };
+            if (!skipAssert)
+                (0, fileSystemAssert_1.assertNoUndefined)(newItem);
+            return new Promise((resolve, reject) => {
+                writeFile(path, JSON.stringify(newItem, null, 2), (err) => err ? reject(err) : resolve(newItem));
+            });
+        },
+        putItem: async (item) => {
+            if (!skipAssert)
+                (0, fileSystemAssert_1.assertNoUndefined)(item);
+            const path = await filePath(hashFilename(item[hashKey]));
+            await mkTableDir;
+            return new Promise((resolve, reject) => {
+                writeFile(path, JSON.stringify(item, null, 2), (err) => err ? reject(err) : resolve(item));
+            });
+        },
+        createItem: async (item) => {
+            if (!skipAssert)
+                (0, fileSystemAssert_1.assertNoUndefined)(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) {
+                if (!skipAssert)
+                    (0, fileSystemAssert_1.assertNoUndefined)(item);
+                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/{packages/utils/src/services/documentStore/unversioned/index.ts → dist/cjs/services/documentStore/unversioned/index.d.ts}

@@ -1,4 +1,2 @@
-/* istanbul ignore file */
 import { dynamoUnversionedDocumentStore } from './dynamodb';
-
 export type UnversionedDocumentStoreCreator = typeof dynamoUnversionedDocumentStore;

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,25 @@
+import { DynamoDB } from '@aws-sdk/client-dynamodb';
+import { Config } from '..';
+import { ConfigProviderForConfig } from '../../../config';
+import { VersionedDocumentAuthor, VersionedTDocument } from '.';
+interface Initializer<C> {
+    configSpace?: C;
+    dynamoClient?: DynamoDB;
+}
+export declare const dynamoVersionedDocumentStore: <C extends string = "dynamodb">(initializer?: Initializer<C>) => <T extends VersionedTDocument<T>>() => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => <K extends keyof T, A extends undefined | ((...a: any[]) => Promise<VersionedDocumentAuthor>)>(_: {}, hashKey: K, options?: {
+    afterWrite?: (item: T) => void | Promise<void>;
+    getAuthor?: A;
+}) => {
+    loadAllDocumentsTheBadWay: () => Promise<T[]>;
+    getVersions: (id: T[K], startVersion?: number) => Promise<{
+        items: T[];
+        nextPageToken: number | undefined;
+    } | undefined>;
+    getItem: (id: T[K], timestamp?: number) => Promise<T | undefined>;
+    prepareItem: (item: Omit<T, "timestamp" | "author">, ...authorArgs: A extends Function ? Parameters<A> : [VersionedDocumentAuthor]) => Promise<{
+        document: T;
+        save: (changes?: Partial<Omit<T, "timestamp" | "author">>) => Promise<T>;
+    }>;
+    putItem: (item: Omit<T, "timestamp" | "author">, ...authorArgs: A extends Function ? Parameters<A> : [VersionedDocumentAuthor]) => Promise<T>;
+};
+export {};

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

@@ -0,0 +1,143 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dynamoVersionedDocumentStore = void 0;
+const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
+const __1 = require("../../..");
+const config_1 = require("../../../config");
+const guards_1 = require("../../../guards");
+const dynamoEncoding_1 = require("../dynamoEncoding");
+// i'm not really excited about getAuthor being required, but ts is getting confused about the type when unspecified
+const dynamoVersionedDocumentStore = (initializer) => {
+    const init = (0, guards_1.ifDefined)(initializer, {});
+    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()
+                };
+                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 {
+                    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;
+            },
+        };
+    };
+};
+exports.dynamoVersionedDocumentStore = dynamoVersionedDocumentStore;