@openstax/ts-utils 1.32.5 → 1.32.7

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

@@ -8,6 +8,7 @@ interface Initializer<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<{

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

@@ -45,9 +45,11 @@ 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);
@@ -82,7 +84,8 @@ const fileSystemUnversionedDocumentStore = (initializer) => () => (configProvide
     return {
         loadAllDocumentsTheBadWay,
         getItemsByField: async (key, value, pageKey) => {
-            (0, fileSystemAssert_1.assertNoUndefined)(value, [key]);
+            if (!skipAssert)
+                (0, fileSystemAssert_1.assertNoUndefined)(value, [key]);
             const pageSize = 10;
             const items = await loadAllDocumentsTheBadWay();
             const filteredItems = items.filter((item) => item[key] === value);
@@ -95,17 +98,20 @@ const fileSystemUnversionedDocumentStore = (initializer) => () => (configProvide
         },
         batchGetItem: async (ids) => {
             const items = await Promise.all(ids.map((id) => {
-                (0, fileSystemAssert_1.assertNoUndefined)(id, ['id']);
+                if (!skipAssert)
+                    (0, fileSystemAssert_1.assertNoUndefined)(id, ['id']);
                 return load(hashFilename(id));
             }));
             return items.filter(guards_1.isDefined);
         },
         getItem: (id) => {
-            (0, fileSystemAssert_1.assertNoUndefined)(id, ['id']);
+            if (!skipAssert)
+                (0, fileSystemAssert_1.assertNoUndefined)(id, ['id']);
             return load(hashFilename(id));
         },
         incrementItemAttribute: async (id, attribute) => {
-            (0, fileSystemAssert_1.assertNoUndefined)(id, ['id']);
+            if (!skipAssert)
+                (0, fileSystemAssert_1.assertNoUndefined)(id, ['id']);
             const filename = hashFilename(id);
             const path = await filePath(filename);
             await mkTableDir;
@@ -136,13 +142,15 @@ const fileSystemUnversionedDocumentStore = (initializer) => () => (configProvide
                 throw new errors_1.NotFoundError(`Item with ${hashKey.toString()} "${id}" does not exist`);
             }
             const newItem = { ...data, ...item };
-            (0, fileSystemAssert_1.assertNoUndefined)(newItem);
+            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) => {
-            (0, fileSystemAssert_1.assertNoUndefined)(item);
+            if (!skipAssert)
+                (0, fileSystemAssert_1.assertNoUndefined)(item);
             const path = await filePath(hashFilename(item[hashKey]));
             await mkTableDir;
             return new Promise((resolve, reject) => {
@@ -150,7 +158,8 @@ const fileSystemUnversionedDocumentStore = (initializer) => () => (configProvide
             });
         },
         createItem: async (item) => {
-            (0, fileSystemAssert_1.assertNoUndefined)(item);
+            if (!skipAssert)
+                (0, fileSystemAssert_1.assertNoUndefined)(item);
             const hashed = hashFilename(item[hashKey]);
             const existingItem = await load(hashed);
             if (existingItem) {
@@ -171,7 +180,8 @@ const fileSystemUnversionedDocumentStore = (initializer) => () => (configProvide
             // Process items sequentially to ensure consistent conflict detection
             // Note: concurrency parameter is ignored for filesystem to avoid race conditions
             for (const item of items) {
-                (0, fileSystemAssert_1.assertNoUndefined)(item);
+                if (!skipAssert)
+                    (0, fileSystemAssert_1.assertNoUndefined)(item);
                 try {
                     const hashed = hashFilename(item[hashKey]);
                     const existingItem = await load(hashed);

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

@@ -8,6 +8,7 @@ interface Initializer<C> {
 }
 export declare const fileSystemVersionedDocumentStore: <C extends string = "fileSystem">(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?: {
     getAuthor?: A;
+    skipAssert?: boolean;
 }) => {
     loadAllDocumentsTheBadWay: () => Promise<T[]>;
     getVersions: (id: T[K], startVersion?: number) => Promise<{

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

@@ -5,7 +5,9 @@ const fileSystemAssert_1 = require("../fileSystemAssert");
 const file_system_1 = require("../unversioned/file-system");
 const PAGE_LIMIT = 5;
 const fileSystemVersionedDocumentStore = (initializer) => () => (configProvider) => (_, hashKey, options) => {
-    const unversionedDocuments = (0, file_system_1.fileSystemUnversionedDocumentStore)(initializer)()(configProvider)({}, 'id');
+    var _a;
+    const skipAssert = (_a = options === null || options === void 0 ? void 0 : options.skipAssert) !== null && _a !== void 0 ? _a : false;
+    const unversionedDocuments = (0, file_system_1.fileSystemUnversionedDocumentStore)(initializer)()(configProvider)({}, 'id', { skipAssert });
     return {
         loadAllDocumentsTheBadWay: () => {
             return unversionedDocuments.loadAllDocumentsTheBadWay().then(documents => documents.map(document => {
@@ -13,7 +15,8 @@ const fileSystemVersionedDocumentStore = (initializer) => () => (configProvider)
             }));
         },
         getVersions: async (id, startVersion) => {
-            (0, fileSystemAssert_1.assertNoUndefined)(id, ['id']);
+            if (!skipAssert)
+                (0, fileSystemAssert_1.assertNoUndefined)(id, ['id']);
             const item = await unversionedDocuments.getItem(id);
             const versions = item === null || item === void 0 ? void 0 : item.items.reverse();
             if (!versions) {
@@ -28,7 +31,8 @@ const fileSystemVersionedDocumentStore = (initializer) => () => (configProvider)
             };
         },
         getItem: async (id, timestamp) => {
-            (0, fileSystemAssert_1.assertNoUndefined)(id, ['id']);
+            if (!skipAssert)
+                (0, fileSystemAssert_1.assertNoUndefined)(id, ['id']);
             const item = await unversionedDocuments.getItem(id);
             if (timestamp) {
                 return item === null || item === void 0 ? void 0 : item.items.find(version => version.timestamp === timestamp);
@@ -44,7 +48,8 @@ const fileSystemVersionedDocumentStore = (initializer) => () => (configProvider)
                 save: async (changes) => {
                     var _a;
                     const document = { ...item, ...changes, timestamp, author };
-                    (0, fileSystemAssert_1.assertNoUndefined)(document);
+                    if (!skipAssert)
+                        (0, fileSystemAssert_1.assertNoUndefined)(document);
                     const container = (_a = await unversionedDocuments.getItem(document[hashKey])) !== null && _a !== void 0 ? _a : { id: document[hashKey], items: [] };
                     const updated = { ...container, items: [...container.items, document] };
                     await unversionedDocuments.putItem(updated);
@@ -56,7 +61,8 @@ const fileSystemVersionedDocumentStore = (initializer) => () => (configProvider)
             var _a;
             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 };
-            (0, fileSystemAssert_1.assertNoUndefined)(document);
+            if (!skipAssert)
+                (0, fileSystemAssert_1.assertNoUndefined)(document);
             const container = (_a = await unversionedDocuments.getItem(document[hashKey])) !== null && _a !== void 0 ? _a : { id: document[hashKey], items: [] };
             const updated = { ...container, items: [...container.items, document] };
             await unversionedDocuments.putItem(updated);