@sprucelabs/data-stores 26.1.7 → 26.2.1

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

@@ -0,0 +1,10 @@
+import { QueryOptions } from '../types/query.types';
+import { DataStorePlugin, DataStorePluginPrepareResponse, DataStorePluginWillCreateOneResponse, DataStorePluginWillFindResponse } 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>;
+    willFind(query: Record<string, any>, options?: QueryOptions): Promise<void | DataStorePluginWillFindResponse>;
+}

package/build/esm/plugins/DatabaseFieldMapperPlugin.js

@@ -0,0 +1,42 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { KeyMapper } from '@sprucelabs/schema';
+export default class DatabaseFieldMapperPlugin {
+    constructor(map) {
+        this.mapper = new KeyMapper(map);
+    }
+    getName() {
+        return 'fieldMapper';
+    }
+    willCreateOne(values) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return {
+                newValues: this.mapper.mapTo(values),
+            };
+        });
+    }
+    prepareRecord(record) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return {
+                newValues: this.mapper.mapFrom(record),
+            };
+        });
+    }
+    willFind(query, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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) })));
+            return {
+                query: this.mapper.mapTo(query),
+                options: Object.assign(Object.assign({}, options), { sort }),
+            };
+        });
+    }
+}

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

@@ -25,7 +25,7 @@ export default abstract class AbstractStore<FullSchema extends Schema, CreateSch
     protected willScramble?(values: Partial<DatabaseRecord> & {
         _isScrambled: true;
     }): Promise<Partial<DatabaseRecord>>;
-    protected willQuery?(query: QueryBuilder<QueryRecord>): Promise<QueryBuilder<Partial<DatabaseRecord>>>;
+    protected willFind?(query: QueryBuilder<QueryRecord>): Promise<QueryBuilder<Partial<DatabaseRecord>>>;
     protected constructor(db: Database, collectionName?: string);
     protected setCollectionName(name: string): void;
     getDb(): Database;
@@ -44,6 +44,7 @@ export default abstract class AbstractStore<FullSchema extends Schema, CreateSch
     count(query?: QueryBuilder<QueryRecord>): Promise<number>;
     find<CreateEntityInstances extends boolean, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>>(query: QueryBuilder<QueryRecord>, queryOptions?: Omit<QueryOptions, 'includeFields'>, options?: PrepareOptions<CreateEntityInstances, FullSchema, F>): Promise<Awaited<SchemaValues<FullSchema, false, CreateEntityInstances, false, F, SchemaPublicFieldNames<FullSchema>>>[]>;
     private _find;
+    private handleWillFindPlugins;
     findBatch<IncludePrivateFields extends boolean = true, CreateEntityInstances extends boolean = false, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>, PF extends SchemaPublicFieldNames<FullSchema> = SchemaPublicFieldNames<FullSchema>>(query?: QueryBuilder<QueryRecord>, options?: FindBatchOptions<IncludePrivateFields, FullSchema, F>): Promise<import("../cursors/BatchCursor").BatchCursor<SchemaValues<FullSchema, CreateEntityInstances, IncludePrivateFields, false, F, PF>>>;
     upsertOne<IncludePrivateFields extends boolean = true, CreateEntityInstances extends boolean = false, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>, PF extends SchemaPublicFieldNames<FullSchema> = SchemaPublicFieldNames<FullSchema>>(query: QueryBuilder<QueryRecord>, updates: UpdateRecord & CreateRecord & {
         id?: string;

package/build/esm/stores/AbstractStore.js

@@ -225,12 +225,15 @@ export default class AbstractStore extends AbstractMutexer {
     }) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
-            let mappedQuery = query;
+            let resolvedQuery = query;
             const { shouldTriggerWillQuery } = internalOptions;
             if (shouldTriggerWillQuery) {
-                mappedQuery = ((_b = (yield ((_a = this.willQuery) === null || _a === void 0 ? void 0 : _a.call(this, query)))) !== null && _b !== void 0 ? _b : query);
+                resolvedQuery = ((_b = (yield ((_a = this.willFind) === null || _a === void 0 ? void 0 : _a.call(this, query)))) !== null && _b !== void 0 ? _b : query);
             }
-            const results = yield this.db.find(this.collectionName, mappedQuery, Object.assign(Object.assign({}, queryOptions), { includeFields: options === null || options === void 0 ? void 0 : options.includeFields }));
+            const { query: q, options: o } = yield this.handleWillFindPlugins(resolvedQuery, queryOptions);
+            resolvedQuery = q;
+            const resolvedOptions = o !== null && o !== void 0 ? o : queryOptions;
+            const results = yield this.db.find(this.collectionName, resolvedQuery, Object.assign(Object.assign({}, resolvedOptions), { includeFields: options === null || options === void 0 ? void 0 : options.includeFields }));
             if (results) {
                 const all = results.map((result) => this.prepareAndNormalizeRecord(result, Object.assign(Object.assign({}, options), { shouldStripUndefinedAndNullValues: true })));
                 const records = yield Promise.all(all);
@@ -239,6 +242,16 @@ export default class AbstractStore extends AbstractMutexer {
             return [];
         });
     }
+    handleWillFindPlugins(query, queryOptions) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const plugin = this.plugins[0];
+            const { query: pluginQuery, options: pluginOptions } = (_b = (yield ((_a = plugin === null || plugin === void 0 ? void 0 : plugin.willFind) === null || _a === void 0 ? void 0 : _a.call(plugin, query, queryOptions)))) !== null && _b !== void 0 ? _b : {};
+            query = pluginQuery !== null && pluginQuery !== void 0 ? pluginQuery : query;
+            const options = pluginOptions !== null && pluginOptions !== void 0 ? pluginOptions : queryOptions;
+            return { options, query };
+        });
+    }
     findBatch(query, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return BatchCursorImpl.Cursor(this, query, options);
@@ -296,7 +309,7 @@ export default class AbstractStore extends AbstractMutexer {
         var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
             const { ops, updates: initialUpdates } = this.pluckOperations(updates);
-            let q = (_b = (yield ((_a = this.willQuery) === null || _a === void 0 ? void 0 : _a.call(this, Object.assign({}, query))))) !== null && _b !== void 0 ? _b : query;
+            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);
@@ -406,7 +419,7 @@ export default class AbstractStore extends AbstractMutexer {
     deleteOne(query) {
         var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
-            let q = (_b = (yield ((_a = this.willQuery) === null || _a === void 0 ? void 0 : _a.call(this, Object.assign({}, query))))) !== null && _b !== void 0 ? _b : Object.assign({}, query);
+            let q = (_b = (yield ((_a = this.willFind) === null || _a === void 0 ? void 0 : _a.call(this, Object.assign({}, query))))) !== null && _b !== void 0 ? _b : Object.assign({}, query);
             for (const plugin of this.plugins) {
                 const { query } = (_d = (yield ((_c = plugin.willDeleteOne) === null || _c === void 0 ? void 0 : _c.call(plugin, q)))) !== null && _d !== void 0 ? _d : {};
                 if (query) {
@@ -419,7 +432,7 @@ export default class AbstractStore extends AbstractMutexer {
     delete(query) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
-            const q = (_b = (yield ((_a = this.willQuery) === null || _a === void 0 ? void 0 : _a.call(this, Object.assign({}, query))))) !== null && _b !== void 0 ? _b : Object.assign({}, query);
+            const q = (_b = (yield ((_a = this.willFind) === null || _a === void 0 ? void 0 : _a.call(this, Object.assign({}, query))))) !== null && _b !== void 0 ? _b : Object.assign({}, query);
             return yield this.db.delete(this.collectionName, q);
         });
     }

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

@@ -1,6 +1,7 @@
 import { Schema, SchemaFieldNames, SchemaPublicValues, SchemaValues } from '@sprucelabs/schema';
 import StoreFactory from '../factories/StoreFactory';
 import { Database } from './database.types';
+import { QueryOptions } from './query.types';
 export declare const saveOperations: readonly ["$push", "$inc", "$min", "$max", "$mul", "$push", "$pull", "$pop"];
 export type SaveOperation = (typeof saveOperations)[number];
 export type SaveOperations = Partial<Record<SaveOperation, Record<string, any>>>;
@@ -38,6 +39,7 @@ export interface DataStorePlugin {
     didFindOne?: (query: Record<string, any>, record: Record<string, any>) => Promise<void | DataStorePluginDidFindOneResponse>;
     getName(): string;
     prepareRecord?: (record: Record<string, any>) => Promise<void | DataStorePluginPrepareResponse>;
+    willFind?: (query: Record<string, any>, options?: QueryOptions) => Promise<void | DataStorePluginWillFindResponse>;
 }
 export interface DataStorePluginPrepareResponse {
     newValues?: Record<string, any>;
@@ -59,3 +61,7 @@ export interface DataStorePluginWillDeleteOneResponse {
 export interface DataStorePluginDidFindOneResponse {
     valuesToMixinBeforeReturning?: Record<string, any>;
 }
+export interface DataStorePluginWillFindResponse {
+    query?: Record<string, any>;
+    options?: QueryOptions;
+}

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

@@ -0,0 +1,10 @@
+import { QueryOptions } from '../types/query.types';
+import { DataStorePlugin, DataStorePluginPrepareResponse, DataStorePluginWillCreateOneResponse, DataStorePluginWillFindResponse } 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>;
+    willFind(query: Record<string, any>, options?: QueryOptions): Promise<void | DataStorePluginWillFindResponse>;
+}

package/build/plugins/DatabaseFieldMapperPlugin.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const schema_1 = require("@sprucelabs/schema");
+class DatabaseFieldMapperPlugin {
+    constructor(map) {
+        this.mapper = new schema_1.KeyMapper(map);
+    }
+    getName() {
+        return 'fieldMapper';
+    }
+    async willCreateOne(values) {
+        return {
+            newValues: this.mapper.mapTo(values),
+        };
+    }
+    async prepareRecord(record) {
+        return {
+            newValues: this.mapper.mapFrom(record),
+        };
+    }
+    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) })));
+        return {
+            query: this.mapper.mapTo(query),
+            options: Object.assign(Object.assign({}, options), { sort }),
+        };
+    }
+}
+exports.default = DatabaseFieldMapperPlugin;

package/build/stores/AbstractStore.d.ts

@@ -25,7 +25,7 @@ export default abstract class AbstractStore<FullSchema extends Schema, CreateSch
     protected willScramble?(values: Partial<DatabaseRecord> & {
         _isScrambled: true;
     }): Promise<Partial<DatabaseRecord>>;
-    protected willQuery?(query: QueryBuilder<QueryRecord>): Promise<QueryBuilder<Partial<DatabaseRecord>>>;
+    protected willFind?(query: QueryBuilder<QueryRecord>): Promise<QueryBuilder<Partial<DatabaseRecord>>>;
     protected constructor(db: Database, collectionName?: string);
     protected setCollectionName(name: string): void;
     getDb(): Database;
@@ -44,6 +44,7 @@ export default abstract class AbstractStore<FullSchema extends Schema, CreateSch
     count(query?: QueryBuilder<QueryRecord>): Promise<number>;
     find<CreateEntityInstances extends boolean, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>>(query: QueryBuilder<QueryRecord>, queryOptions?: Omit<QueryOptions, 'includeFields'>, options?: PrepareOptions<CreateEntityInstances, FullSchema, F>): Promise<Awaited<SchemaValues<FullSchema, false, CreateEntityInstances, false, F, SchemaPublicFieldNames<FullSchema>>>[]>;
     private _find;
+    private handleWillFindPlugins;
     findBatch<IncludePrivateFields extends boolean = true, CreateEntityInstances extends boolean = false, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>, PF extends SchemaPublicFieldNames<FullSchema> = SchemaPublicFieldNames<FullSchema>>(query?: QueryBuilder<QueryRecord>, options?: FindBatchOptions<IncludePrivateFields, FullSchema, F>): Promise<import("../cursors/BatchCursor").BatchCursor<SchemaValues<FullSchema, CreateEntityInstances, IncludePrivateFields, false, F, PF>>>;
     upsertOne<IncludePrivateFields extends boolean = true, CreateEntityInstances extends boolean = false, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>, PF extends SchemaPublicFieldNames<FullSchema> = SchemaPublicFieldNames<FullSchema>>(query: QueryBuilder<QueryRecord>, updates: UpdateRecord & CreateRecord & {
         id?: string;

package/build/stores/AbstractStore.js

@@ -223,12 +223,15 @@ class AbstractStore extends AbstractMutexer_1.default {
         shouldTriggerWillQuery: true,
     }) {
         var _a, _b;
-        let mappedQuery = query;
+        let resolvedQuery = query;
         const { shouldTriggerWillQuery } = internalOptions;
         if (shouldTriggerWillQuery) {
-            mappedQuery = ((_b = (await ((_a = this.willQuery) === null || _a === void 0 ? void 0 : _a.call(this, query)))) !== null && _b !== void 0 ? _b : query);
+            resolvedQuery = ((_b = (await ((_a = this.willFind) === null || _a === void 0 ? void 0 : _a.call(this, query)))) !== null && _b !== void 0 ? _b : query);
         }
-        const results = await this.db.find(this.collectionName, mappedQuery, Object.assign(Object.assign({}, queryOptions), { includeFields: options === null || options === void 0 ? void 0 : options.includeFields }));
+        const { query: q, options: o } = await this.handleWillFindPlugins(resolvedQuery, queryOptions);
+        resolvedQuery = q;
+        const resolvedOptions = o !== null && o !== void 0 ? o : queryOptions;
+        const results = await this.db.find(this.collectionName, resolvedQuery, Object.assign(Object.assign({}, resolvedOptions), { includeFields: options === null || options === void 0 ? void 0 : options.includeFields }));
         if (results) {
             const all = results.map((result) => this.prepareAndNormalizeRecord(result, Object.assign(Object.assign({}, options), { shouldStripUndefinedAndNullValues: true })));
             const records = await Promise.all(all);
@@ -236,6 +239,14 @@ class AbstractStore extends AbstractMutexer_1.default {
         }
         return [];
     }
+    async handleWillFindPlugins(query, queryOptions) {
+        var _a, _b;
+        const plugin = this.plugins[0];
+        const { query: pluginQuery, options: pluginOptions } = (_b = (await ((_a = plugin === null || plugin === void 0 ? void 0 : plugin.willFind) === null || _a === void 0 ? void 0 : _a.call(plugin, query, queryOptions)))) !== null && _b !== void 0 ? _b : {};
+        query = pluginQuery !== null && pluginQuery !== void 0 ? pluginQuery : query;
+        const options = pluginOptions !== null && pluginOptions !== void 0 ? pluginOptions : queryOptions;
+        return { options, query };
+    }
     async findBatch(query, options) {
         return BatchCursor_1.default.Cursor(this, query, options);
     }
@@ -284,7 +295,7 @@ class AbstractStore extends AbstractMutexer_1.default {
     async findOneAndUpdate(query, updates, notFoundHandler, options = {}) {
         var _a, _b, _c, _d;
         const { ops, updates: initialUpdates } = this.pluckOperations(updates);
-        let q = (_b = (await ((_a = this.willQuery) === null || _a === void 0 ? void 0 : _a.call(this, Object.assign({}, query))))) !== null && _b !== void 0 ? _b : query;
+        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);
@@ -388,7 +399,7 @@ class AbstractStore extends AbstractMutexer_1.default {
     }
     async deleteOne(query) {
         var _a, _b, _c, _d;
-        let q = (_b = (await ((_a = this.willQuery) === null || _a === void 0 ? void 0 : _a.call(this, Object.assign({}, query))))) !== null && _b !== void 0 ? _b : Object.assign({}, query);
+        let q = (_b = (await ((_a = this.willFind) === null || _a === void 0 ? void 0 : _a.call(this, Object.assign({}, query))))) !== null && _b !== void 0 ? _b : Object.assign({}, query);
         for (const plugin of this.plugins) {
             const { query } = (_d = (await ((_c = plugin.willDeleteOne) === null || _c === void 0 ? void 0 : _c.call(plugin, q)))) !== null && _d !== void 0 ? _d : {};
             if (query) {
@@ -399,7 +410,7 @@ class AbstractStore extends AbstractMutexer_1.default {
     }
     async delete(query) {
         var _a, _b;
-        const q = (_b = (await ((_a = this.willQuery) === null || _a === void 0 ? void 0 : _a.call(this, Object.assign({}, query))))) !== null && _b !== void 0 ? _b : Object.assign({}, query);
+        const q = (_b = (await ((_a = this.willFind) === null || _a === void 0 ? void 0 : _a.call(this, Object.assign({}, query))))) !== null && _b !== void 0 ? _b : Object.assign({}, query);
         return await this.db.delete(this.collectionName, q);
     }
 }

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

@@ -1,6 +1,7 @@
 import { Schema, SchemaFieldNames, SchemaPublicValues, SchemaValues } from '@sprucelabs/schema';
 import StoreFactory from '../factories/StoreFactory';
 import { Database } from './database.types';
+import { QueryOptions } from './query.types';
 export declare const saveOperations: readonly ["$push", "$inc", "$min", "$max", "$mul", "$push", "$pull", "$pop"];
 export type SaveOperation = (typeof saveOperations)[number];
 export type SaveOperations = Partial<Record<SaveOperation, Record<string, any>>>;
@@ -38,6 +39,7 @@ export interface DataStorePlugin {
     didFindOne?: (query: Record<string, any>, record: Record<string, any>) => Promise<void | DataStorePluginDidFindOneResponse>;
     getName(): string;
     prepareRecord?: (record: Record<string, any>) => Promise<void | DataStorePluginPrepareResponse>;
+    willFind?: (query: Record<string, any>, options?: QueryOptions) => Promise<void | DataStorePluginWillFindResponse>;
 }
 export interface DataStorePluginPrepareResponse {
     newValues?: Record<string, any>;
@@ -59,3 +61,7 @@ export interface DataStorePluginWillDeleteOneResponse {
 export interface DataStorePluginDidFindOneResponse {
     valuesToMixinBeforeReturning?: Record<string, any>;
 }
+export interface DataStorePluginWillFindResponse {
+    query?: Record<string, any>;
+    options?: QueryOptions;
+}

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "26.1.7",
+  "version": "26.2.1",
   "files": [
     "build/**/*",
     "!build/__tests__",
@@ -70,8 +70,8 @@
   "dependencies": {
     "@sprucelabs/error": "^5.1.52",
     "@sprucelabs/globby": "^1.0.3",
-    "@sprucelabs/schema": "^29.1.2",
-    "@sprucelabs/spruce-skill-utils": "^30.1.39",
+    "@sprucelabs/schema": "^29.2.0",
+    "@sprucelabs/spruce-skill-utils": "^30.1.40",
     "just-clone": "^6.2.0",
     "lodash": "^4.17.21",
     "mongodb": "^6.3.0",