@openstax/ts-utils 1.24.6 → 1.25.1-pre2

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

@@ -5,7 +5,9 @@ interface Initializer<C> {
 }
 export declare const dynamoUnversionedDocumentStore: <C extends string = "dynamodb">(initializer?: Initializer<C> | undefined) => <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;
+} | undefined) => {
     loadAllDocumentsTheBadWay: () => Promise<T[]>;
     batchGetItem: (ids: T[K][]) => Promise<T[]>;
     getItem: (id: T[K]) => Promise<T | undefined>;

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

@@ -8,9 +8,9 @@ const errors_1 = require("../../../errors");
 const guards_1 = require("../../../guards");
 const dynamoEncoding_1 = require("../dynamoEncoding");
 const dynamodb = (0, __1.once)(() => new client_dynamodb_1.DynamoDB({ apiVersion: '2012-08-10' }));
-const dynamoUnversionedDocumentStore = (initializer) => () => (configProvider) => (_, hashKey) => {
-    const options = (0, guards_1.ifDefined)(initializer, {});
-    const tableName = (0, __1.once)(() => (0, config_1.resolveConfigValue)(configProvider[(0, guards_1.ifDefined)(options.configSpace, 'dynamodb')].tableName));
+const dynamoUnversionedDocumentStore = (initializer) => () => (configProvider) => (_, hashKey, options) => {
+    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) => {
@@ -57,14 +57,19 @@ const dynamoUnversionedDocumentStore = (initializer) => () => (configProvider) =
                 ConditionExpression: 'attribute_exists(#k)',
                 ExpressionAttributeNames: { '#k': hashKey.toString(), '#f': field },
                 ExpressionAttributeValues: { ':one': { N: '1' } },
-                ReturnValues: 'UPDATED_NEW',
+                ReturnValues: 'ALL_NEW',
             });
-            return dynamodb().send(cmd).then((item) => {
-                var _a;
-                const result = (_a = item.Attributes) === null || _a === void 0 ? void 0 : _a[field]['N'];
-                if (!result) {
+            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' ?
@@ -99,11 +104,14 @@ const dynamoUnversionedDocumentStore = (initializer) => () => (configProvider) =
                 ExpressionAttributeValues: expressionAttributeValues,
                 ReturnValues: 'ALL_NEW',
             });
-            return dynamodb().send(cmd).then((item) => {
+            return dynamodb().send(cmd).then(async (item) => {
+                var _a;
                 if (!item.Attributes) {
                     throw new errors_1.NotFoundError(`Item with ${key} "${id}" does not exist`);
                 }
-                return (0, dynamoEncoding_1.decodeDynamoDocument)(item.Attributes);
+                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;
@@ -111,11 +119,14 @@ const dynamoUnversionedDocumentStore = (initializer) => () => (configProvider) =
         },
         /* 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),
             });
-            return dynamodb().send(cmd).then(() => 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;
         },
     };
 };

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

@@ -6,7 +6,10 @@ interface Initializer<C> {
 }
 export declare const dynamoVersionedDocumentStore: <C extends string = "dynamodb">(initializer?: Initializer<C> | undefined) => <T extends VersionedTDocument<T>>() => (configProvider: { [key in C]: {
     tableName: import("../../../config").ConfigValueProvider<string>;
-}; }) => <K extends keyof T, A extends ((...a: any[]) => Promise<VersionedDocumentAuthor>) | undefined>(_: {}, hashKey: K, getAuthor: A) => {
+}; }) => <K extends keyof T, A extends ((...a: any[]) => Promise<VersionedDocumentAuthor>) | undefined>(_: {}, hashKey: K, options?: {
+    afterWrite?: ((item: T) => void | Promise<void>) | undefined;
+    getAuthor?: A | undefined;
+} | undefined) => {
     loadAllDocumentsTheBadWay: () => Promise<T[]>;
     getVersions: (id: T[K], startVersion?: number | undefined) => Promise<{
         items: T[];

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

@@ -8,9 +8,9 @@ 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, getAuthor) => {
-    const options = (0, guards_1.ifDefined)(initializer, {});
-    const tableName = (0, __1.once)(() => (0, config_1.resolveConfigValue)(configProvider[(0, guards_1.ifDefined)(options.configSpace, 'dynamodb')].tableName));
+const dynamoVersionedDocumentStore = (initializer) => () => (configProvider) => (_, hashKey, options) => {
+    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) => {
@@ -94,11 +94,12 @@ const dynamoVersionedDocumentStore = (initializer) => () => (configProvider) =>
          * cannot be modified */
         prepareItem: async (item, ...authorArgs) => {
             // this getAuthor type is terrible
-            const author = getAuthor ? await getAuthor(...authorArgs) : authorArgs[0];
+            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,
@@ -109,15 +110,18 @@ const dynamoVersionedDocumentStore = (initializer) => () => (configProvider) =>
                         TableName: await tableName(),
                         Item: (0, dynamoEncoding_1.encodeDynamoDocument)(document),
                     });
-                    return dynamodb().send(cmd)
+                    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 = getAuthor ? await getAuthor(...authorArgs) : authorArgs[0];
+            const author = (options === null || options === void 0 ? void 0 : options.getAuthor) ? await options.getAuthor(...authorArgs) : authorArgs[0];
             const document = {
                 ...item,
                 timestamp: new Date().getTime(),
@@ -127,8 +131,10 @@ const dynamoVersionedDocumentStore = (initializer) => () => (configProvider) =>
                 TableName: await tableName(),
                 Item: (0, dynamoEncoding_1.encodeDynamoDocument)(document),
             });
-            return dynamodb().send(cmd)
+            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;
         },
     };
 };

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

@@ -8,7 +8,9 @@ interface Initializer<C> {
 }
 export declare const fileSystemVersionedDocumentStore: <C extends string = "fileSystem">(initializer: Initializer<C>) => <T extends VersionedTDocument<T>>() => (configProvider: { [key in C]: {
     tableName: import("../../../config").ConfigValueProvider<string>;
-}; }) => <K extends keyof T, A extends ((...a: any[]) => Promise<VersionedDocumentAuthor>) | undefined>(_: {}, hashKey: K, getAuthor: A) => {
+}; }) => <K extends keyof T, A extends ((...a: any[]) => Promise<VersionedDocumentAuthor>) | undefined>(_: {}, hashKey: K, options?: {
+    getAuthor?: A | undefined;
+} | undefined) => {
     loadAllDocumentsTheBadWay: () => Promise<T[]>;
     getVersions: (id: T[K], startVersion?: number | undefined) => Promise<{
         items: T[];

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

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.fileSystemVersionedDocumentStore = void 0;
 const file_system_1 = require("../unversioned/file-system");
 const PAGE_LIMIT = 5;
-const fileSystemVersionedDocumentStore = (initializer) => () => (configProvider) => (_, hashKey, getAuthor) => {
+const fileSystemVersionedDocumentStore = (initializer) => () => (configProvider) => (_, hashKey, options) => {
     const unversionedDocuments = (0, file_system_1.fileSystemUnversionedDocumentStore)(initializer)()(configProvider)({}, 'id');
     return {
         loadAllDocumentsTheBadWay: () => {
@@ -34,7 +34,7 @@ const fileSystemVersionedDocumentStore = (initializer) => () => (configProvider)
         },
         prepareItem: async (item, ...authorArgs) => {
             // this getAuthor type is terrible
-            const author = getAuthor ? await getAuthor(...authorArgs) : authorArgs[0];
+            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 },
@@ -50,7 +50,7 @@ const fileSystemVersionedDocumentStore = (initializer) => () => (configProvider)
         },
         putItem: async (item, ...authorArgs) => {
             var _a;
-            const author = getAuthor ? await getAuthor(...authorArgs) : authorArgs[0];
+            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 container = (_a = await unversionedDocuments.getItem(document[hashKey])) !== null && _a !== void 0 ? _a : { id: document[hashKey], items: [] };
             const updated = { ...container, items: [...container.items, document] };