@sprucelabs/data-stores 26.2.0 → 26.2.2

package/build/esm/index.d.ts

@@ -20,6 +20,7 @@ export { default as CursorPager } from './cursors/CursorPager';
 export * from './cursors/CursorPager';
 export { default as CursorPagerFaker } from './cursors/CursorPagerFaker';
 export * from './cursors/CursorPager';
+export { default as DatabaseFieldMapperPlugin } from './plugins/DatabaseFieldMapperPlugin';
 /**
  * @deprecated databaseAssertUtil -> databaseAssert
  */

package/build/esm/index.js

@@ -20,6 +20,7 @@ export { default as CursorPager } from './cursors/CursorPager.js';
 export * from './cursors/CursorPager.js';
 export { default as CursorPagerFaker } from './cursors/CursorPagerFaker.js';
 export * from './cursors/CursorPager.js';
+export { default as DatabaseFieldMapperPlugin } from './plugins/DatabaseFieldMapperPlugin.js';
 /**
  * @deprecated databaseAssertUtil -> databaseAssert
  */

package/build/esm/plugins/DatabaseFieldMapperPlugin.d.ts

@@ -1,10 +1,11 @@
 import { QueryOptions } from '../types/query.types';
-import { DataStorePlugin, DataStorePluginPrepareResponse, DataStorePluginWillCreateOneResponse, DataStorePluginWillFindResponse } from '../types/stores.types';
+import { DataStorePlugin, DataStorePluginPrepareResponse, DataStorePluginWillCreateOneResponse, DataStorePluginWillFindResponse, DataStorePluginWillUpdateOneResponse } from '../types/stores.types';
 export default class DatabaseFieldMapperPlugin implements DataStorePlugin {
     private mapper;
     constructor(map: Record<string, any>);
     getName(): string;
     willCreateOne(values: Record<string, any>): Promise<void | DataStorePluginWillCreateOneResponse>;
     prepareRecord(record: Record<string, any>): Promise<void | DataStorePluginPrepareResponse>;
+    willUpdateOne(query: Record<string, any>, updates: Record<string, any>): Promise<void | DataStorePluginWillUpdateOneResponse>;
     willFind(query: Record<string, any>, options?: QueryOptions): Promise<void | DataStorePluginWillFindResponse>;
 }

package/build/esm/plugins/DatabaseFieldMapperPlugin.js

@@ -29,6 +29,14 @@ export default class DatabaseFieldMapperPlugin {
             };
         });
     }
+    willUpdateOne(query, updates) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return {
+                query: this.mapper.mapTo(query),
+                newValues: this.mapper.mapTo(updates),
+            };
+        });
+    }
     willFind(query, options) {
         return __awaiter(this, void 0, void 0, function* () {
             let { sort } = options !== null && options !== void 0 ? options : {};

package/build/esm/stores/AbstractStore.d.ts

@@ -52,6 +52,7 @@ export default abstract class AbstractStore<FullSchema extends Schema, CreateSch
     updateOne<IncludePrivateFields extends boolean = false, CreateEntityInstances extends boolean = false, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>, PF extends SchemaPublicFieldNames<FullSchema> = SchemaPublicFieldNames<FullSchema>>(query: QueryBuilder<QueryRecord>, updates: UpdateRecord, options?: PrepareOptions<IncludePrivateFields, FullSchema, F>): Promise<Response<FullSchema, CreateEntityInstances, IncludePrivateFields, PF, F>>;
     update(query: QueryBuilder<QueryRecord>, updates: UpdateRecord): Promise<number>;
     private findOneAndUpdate;
+    private handleWillUpdateOnePlugins;
     private pluckOperations;
     scramble(id: string): Promise<SchemaValues<FullSchema, false, false, false, Extract<keyof FullSchema["fields"], string>, SchemaPublicFieldNames<FullSchema>>>;
     private isScrambled;

package/build/esm/stores/AbstractStore.js

@@ -306,22 +306,19 @@ export default class AbstractStore extends AbstractMutexer {
         });
     }
     findOneAndUpdate(query, updates, notFoundHandler, options = {}) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
-            const { ops, updates: initialUpdates } = this.pluckOperations(updates);
+            let { ops, updates: initialUpdates } = this.pluckOperations(updates);
             let q = (_b = (yield ((_a = this.willFind) === null || _a === void 0 ? void 0 : _a.call(this, Object.assign({}, query))))) !== null && _b !== void 0 ? _b : query;
-            let shouldUpdate = true;
             try {
                 const isScrambled = this.isScrambled(initialUpdates);
-                for (const plugin of this.plugins) {
-                    const results = yield ((_c = plugin.willUpdateOne) === null || _c === void 0 ? void 0 : _c.call(plugin, q, initialUpdates));
-                    if ((results === null || results === void 0 ? void 0 : results.shouldUpdate) === false) {
-                        shouldUpdate = false;
-                    }
-                    if (results === null || results === void 0 ? void 0 : results.query) {
-                        q = results.query;
-                    }
+                if (!isScrambled) {
+                    //@ts-ignore
+                    validateSchemaValues(this.updateSchema, initialUpdates);
                 }
+                const { query: qPlugins, shouldUpdate, updates: qUpdates, } = yield this.handleWillUpdateOnePlugins(q, initialUpdates);
+                q = qPlugins;
+                initialUpdates = qUpdates;
                 let current = yield this._findOne(q, Object.assign(Object.assign({}, options), { shouldIncludePrivateFields: true }), { shouldTriggerWillQuery: false });
                 if (!current) {
                     current = yield notFoundHandler();
@@ -332,10 +329,6 @@ export default class AbstractStore extends AbstractMutexer {
                         throw new Error('Make sure your notFoundHandler returns a record or throws');
                     }
                 }
-                if (!isScrambled) {
-                    //@ts-ignore
-                    validateSchemaValues(this.updateSchema, initialUpdates);
-                }
                 if (!shouldUpdate) {
                     return current;
                 }
@@ -353,7 +346,7 @@ export default class AbstractStore extends AbstractMutexer {
                     normalizedValues[name] = value;
                 }
                 const results = yield this.db.updateOne(this.collectionName, q, normalizedValues);
-                yield ((_d = this.didUpdate) === null || _d === void 0 ? void 0 : _d.call(this, current, results));
+                yield ((_c = this.didUpdate) === null || _c === void 0 ? void 0 : _c.call(this, current, results));
                 return this.prepareAndNormalizeRecord(results, options);
             }
             catch (err) {
@@ -367,6 +360,27 @@ export default class AbstractStore extends AbstractMutexer {
             }
         });
     }
+    handleWillUpdateOnePlugins(query, updates) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            let shouldUpdate = true;
+            let resolvedQuery = query;
+            let resolvedUpdates = updates;
+            for (const plugin of this.plugins) {
+                const results = yield ((_a = plugin.willUpdateOne) === null || _a === void 0 ? void 0 : _a.call(plugin, query, updates));
+                if ((results === null || results === void 0 ? void 0 : results.shouldUpdate) === false) {
+                    shouldUpdate = false;
+                }
+                if (results === null || results === void 0 ? void 0 : results.query) {
+                    resolvedQuery = results.query;
+                }
+                if (results === null || results === void 0 ? void 0 : results.newValues) {
+                    resolvedUpdates = results.newValues;
+                }
+            }
+            return { query: resolvedQuery, shouldUpdate, updates: resolvedUpdates };
+        });
+    }
     pluckOperations(updates) {
         const initialUpdates = __rest(updates, []);
         const ops = saveOperations

package/build/esm/types/stores.types.d.ts

@@ -54,6 +54,7 @@ export interface DataStorePluginWillCreateOneResponse {
 export interface DataStorePluginWillUpdateOneResponse {
     query?: Record<string, any>;
     shouldUpdate?: boolean;
+    newValues?: Record<string, any>;
 }
 export interface DataStorePluginWillDeleteOneResponse {
     query?: Record<string, any>;

package/build/index.d.ts

@@ -20,6 +20,7 @@ export { default as CursorPager } from './cursors/CursorPager';
 export * from './cursors/CursorPager';
 export { default as CursorPagerFaker } from './cursors/CursorPagerFaker';
 export * from './cursors/CursorPager';
+export { default as DatabaseFieldMapperPlugin } from './plugins/DatabaseFieldMapperPlugin';
 /**
  * @deprecated databaseAssertUtil -> databaseAssert
  */

package/build/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BatchArrayCursor = exports.BatchCursorImpl = exports.storePluginAssert = exports.databaseAssert = exports.databaseAssertUtil = exports.CursorPagerFaker = exports.CursorPager = exports.generateId = exports.DataStoresError = exports.mongoUtil = exports.NeDbDatabase = exports.MongoDatabase = exports.StoreLoader = exports.DatabaseFactory = exports.StoreFactory = exports.AbstractStore = exports.DatabaseFixture = exports.AbstractDatabaseTest = void 0;
+exports.BatchArrayCursor = exports.BatchCursorImpl = exports.storePluginAssert = exports.databaseAssert = exports.databaseAssertUtil = exports.DatabaseFieldMapperPlugin = exports.CursorPagerFaker = exports.CursorPager = exports.generateId = exports.DataStoresError = exports.mongoUtil = exports.NeDbDatabase = exports.MongoDatabase = exports.StoreLoader = exports.DatabaseFactory = exports.StoreFactory = exports.AbstractStore = exports.DatabaseFixture = exports.AbstractDatabaseTest = void 0;
 var AbstractDatabaseTest_1 = require("./tests/AbstractDatabaseTest");
 Object.defineProperty(exports, "AbstractDatabaseTest", { enumerable: true, get: function () { return __importDefault(AbstractDatabaseTest_1).default; } });
 var DatabaseFixture_1 = require("./fixtures/DatabaseFixture");
@@ -53,6 +53,8 @@ __exportStar(require("./cursors/CursorPager"), exports);
 var CursorPagerFaker_1 = require("./cursors/CursorPagerFaker");
 Object.defineProperty(exports, "CursorPagerFaker", { enumerable: true, get: function () { return __importDefault(CursorPagerFaker_1).default; } });
 __exportStar(require("./cursors/CursorPager"), exports);
+var DatabaseFieldMapperPlugin_1 = require("./plugins/DatabaseFieldMapperPlugin");
+Object.defineProperty(exports, "DatabaseFieldMapperPlugin", { enumerable: true, get: function () { return __importDefault(DatabaseFieldMapperPlugin_1).default; } });
 /**
  * @deprecated databaseAssertUtil -> databaseAssert
  */

package/build/plugins/DatabaseFieldMapperPlugin.d.ts

@@ -1,10 +1,11 @@
 import { QueryOptions } from '../types/query.types';
-import { DataStorePlugin, DataStorePluginPrepareResponse, DataStorePluginWillCreateOneResponse, DataStorePluginWillFindResponse } from '../types/stores.types';
+import { DataStorePlugin, DataStorePluginPrepareResponse, DataStorePluginWillCreateOneResponse, DataStorePluginWillFindResponse, DataStorePluginWillUpdateOneResponse } from '../types/stores.types';
 export default class DatabaseFieldMapperPlugin implements DataStorePlugin {
     private mapper;
     constructor(map: Record<string, any>);
     getName(): string;
     willCreateOne(values: Record<string, any>): Promise<void | DataStorePluginWillCreateOneResponse>;
     prepareRecord(record: Record<string, any>): Promise<void | DataStorePluginPrepareResponse>;
+    willUpdateOne(query: Record<string, any>, updates: Record<string, any>): Promise<void | DataStorePluginWillUpdateOneResponse>;
     willFind(query: Record<string, any>, options?: QueryOptions): Promise<void | DataStorePluginWillFindResponse>;
 }

package/build/plugins/DatabaseFieldMapperPlugin.js

@@ -18,6 +18,12 @@ class DatabaseFieldMapperPlugin {
             newValues: this.mapper.mapFrom(record),
         };
     }
+    async willUpdateOne(query, updates) {
+        return {
+            query: this.mapper.mapTo(query),
+            newValues: this.mapper.mapTo(updates),
+        };
+    }
     async willFind(query, options) {
         let { sort } = options !== null && options !== void 0 ? options : {};
         sort = sort === null || sort === void 0 ? void 0 : sort.map((s) => (Object.assign(Object.assign({}, s), { field: this.mapper.mapFieldNameTo(s.field) })));

package/build/stores/AbstractStore.d.ts

@@ -52,6 +52,7 @@ export default abstract class AbstractStore<FullSchema extends Schema, CreateSch
     updateOne<IncludePrivateFields extends boolean = false, CreateEntityInstances extends boolean = false, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>, PF extends SchemaPublicFieldNames<FullSchema> = SchemaPublicFieldNames<FullSchema>>(query: QueryBuilder<QueryRecord>, updates: UpdateRecord, options?: PrepareOptions<IncludePrivateFields, FullSchema, F>): Promise<Response<FullSchema, CreateEntityInstances, IncludePrivateFields, PF, F>>;
     update(query: QueryBuilder<QueryRecord>, updates: UpdateRecord): Promise<number>;
     private findOneAndUpdate;
+    private handleWillUpdateOnePlugins;
     private pluckOperations;
     scramble(id: string): Promise<SchemaValues<FullSchema, false, false, false, Extract<keyof FullSchema["fields"], string>, SchemaPublicFieldNames<FullSchema>>>;
     private isScrambled;

package/build/stores/AbstractStore.js

@@ -293,21 +293,18 @@ class AbstractStore extends AbstractMutexer_1.default {
         return this.db.update(this.collectionName, query, updates);
     }
     async findOneAndUpdate(query, updates, notFoundHandler, options = {}) {
-        var _a, _b, _c, _d;
-        const { ops, updates: initialUpdates } = this.pluckOperations(updates);
+        var _a, _b, _c;
+        let { ops, updates: initialUpdates } = this.pluckOperations(updates);
         let q = (_b = (await ((_a = this.willFind) === null || _a === void 0 ? void 0 : _a.call(this, Object.assign({}, query))))) !== null && _b !== void 0 ? _b : query;
-        let shouldUpdate = true;
         try {
             const isScrambled = this.isScrambled(initialUpdates);
-            for (const plugin of this.plugins) {
-                const results = await ((_c = plugin.willUpdateOne) === null || _c === void 0 ? void 0 : _c.call(plugin, q, initialUpdates));
-                if ((results === null || results === void 0 ? void 0 : results.shouldUpdate) === false) {
-                    shouldUpdate = false;
-                }
-                if (results === null || results === void 0 ? void 0 : results.query) {
-                    q = results.query;
-                }
+            if (!isScrambled) {
+                //@ts-ignore
+                (0, schema_1.validateSchemaValues)(this.updateSchema, initialUpdates);
             }
+            const { query: qPlugins, shouldUpdate, updates: qUpdates, } = await this.handleWillUpdateOnePlugins(q, initialUpdates);
+            q = qPlugins;
+            initialUpdates = qUpdates;
             let current = await this._findOne(q, Object.assign(Object.assign({}, options), { shouldIncludePrivateFields: true }), { shouldTriggerWillQuery: false });
             if (!current) {
                 current = await notFoundHandler();
@@ -318,10 +315,6 @@ class AbstractStore extends AbstractMutexer_1.default {
                     throw new Error('Make sure your notFoundHandler returns a record or throws');
                 }
             }
-            if (!isScrambled) {
-                //@ts-ignore
-                (0, schema_1.validateSchemaValues)(this.updateSchema, initialUpdates);
-            }
             if (!shouldUpdate) {
                 return current;
             }
@@ -339,7 +332,7 @@ class AbstractStore extends AbstractMutexer_1.default {
                 normalizedValues[name] = value;
             }
             const results = await this.db.updateOne(this.collectionName, q, normalizedValues);
-            await ((_d = this.didUpdate) === null || _d === void 0 ? void 0 : _d.call(this, current, results));
+            await ((_c = this.didUpdate) === null || _c === void 0 ? void 0 : _c.call(this, current, results));
             return this.prepareAndNormalizeRecord(results, options);
         }
         catch (err) {
@@ -352,6 +345,25 @@ class AbstractStore extends AbstractMutexer_1.default {
             throw coded[0];
         }
     }
+    async handleWillUpdateOnePlugins(query, updates) {
+        var _a;
+        let shouldUpdate = true;
+        let resolvedQuery = query;
+        let resolvedUpdates = updates;
+        for (const plugin of this.plugins) {
+            const results = await ((_a = plugin.willUpdateOne) === null || _a === void 0 ? void 0 : _a.call(plugin, query, updates));
+            if ((results === null || results === void 0 ? void 0 : results.shouldUpdate) === false) {
+                shouldUpdate = false;
+            }
+            if (results === null || results === void 0 ? void 0 : results.query) {
+                resolvedQuery = results.query;
+            }
+            if (results === null || results === void 0 ? void 0 : results.newValues) {
+                resolvedUpdates = results.newValues;
+            }
+        }
+        return { query: resolvedQuery, shouldUpdate, updates: resolvedUpdates };
+    }
     pluckOperations(updates) {
         const initialUpdates = __rest(updates, []);
         const ops = stores_types_1.saveOperations

package/build/types/stores.types.d.ts

@@ -54,6 +54,7 @@ export interface DataStorePluginWillCreateOneResponse {
 export interface DataStorePluginWillUpdateOneResponse {
     query?: Record<string, any>;
     shouldUpdate?: boolean;
+    newValues?: Record<string, any>;
 }
 export interface DataStorePluginWillDeleteOneResponse {
     query?: Record<string, any>;

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "26.2.0",
+  "version": "26.2.2",
   "files": [
     "build/**/*",
     "!build/__tests__",