@sprucelabs/data-stores 25.9.0 → 25.11.0

package/build/esm/index.d.ts

@@ -25,6 +25,7 @@ export * from './cursors/CursorPager';
  */
 export { default as databaseAssertUtil } from './tests/databaseAssertUtil';
 export { default as databaseAssert } from './tests/databaseAssertUtil';
+export { default as storePluginAssert } from './tests/storePluginAssert';
 export { default as BatchCursorImpl } from './cursors/BatchCursor';
 export * from './cursors/BatchCursor';
 export { default as BatchArrayCursor } from './cursors/BatchArrayCursor';

package/build/esm/index.js

@@ -25,6 +25,7 @@ export * from './cursors/CursorPager.js';
  */
 export { default as databaseAssertUtil } from './tests/databaseAssertUtil.js';
 export { default as databaseAssert } from './tests/databaseAssertUtil.js';
+export { default as storePluginAssert } from './tests/storePluginAssert.js';
 export { default as BatchCursorImpl } from './cursors/BatchCursor.js';
 export * from './cursors/BatchCursor.js';
 export { default as BatchArrayCursor } from './cursors/BatchArrayCursor.js';

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

@@ -4,9 +4,7 @@ import AbstractMutexer from '../mutexers/AbstractMutexer';
 import { DataStorePlugin, Database } from '../types/database.types';
 import { QueryBuilder, QueryOptions } from '../types/query.types';
 import { PrepareOptions, PrepareResults, SaveOperations, DataStore } from '../types/stores.types';
-export default abstract class AbstractStore<FullSchema extends Schema, CreateSchema extends Schema = FullSchema, UpdateSchema extends Schema = CreateSchema, DatabaseSchema extends Schema = FullSchema, DatabaseRecord = SchemaValues<DatabaseSchema> & {
-    id: string;
-}, QueryRecord = SchemaPartialValues<FullSchema>, FullRecord = SchemaValues<FullSchema>, CreateRecord = SchemaValues<CreateSchema>, UpdateRecord = SchemaValues<UpdateSchema> & SaveOperations> extends AbstractMutexer implements DataStore {
+export default abstract class AbstractStore<FullSchema extends Schema, CreateSchema extends Schema = FullSchema, UpdateSchema extends Schema = CreateSchema, DatabaseSchema extends Schema = FullSchema, DatabaseRecord = SchemaValues<DatabaseSchema>, QueryRecord = SchemaPartialValues<FullSchema>, FullRecord = SchemaValues<FullSchema>, CreateRecord = SchemaValues<CreateSchema>, UpdateRecord = SchemaValues<UpdateSchema> & SaveOperations> extends AbstractMutexer implements DataStore {
     abstract readonly name: string;
     protected abstract collectionName: string;
     protected abstract createSchema: CreateSchema;
@@ -35,8 +33,10 @@ export default abstract class AbstractStore<FullSchema extends Schema, CreateSch
     private mapCasing;
     create<IncludePrivateFields extends boolean = true, CreateEntityInstances extends boolean = false, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>, PF extends SchemaPublicFieldNames<FullSchema> = SchemaPublicFieldNames<FullSchema>>(values: CreateRecord[], options?: PrepareOptions<CreateEntityInstances, FullSchema, F>): Promise<Response<FullSchema, CreateEntityInstances, IncludePrivateFields, PF, F>[]>;
     createOne<CreateEntityInstances extends boolean, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>>(values: CreateRecord, options?: PrepareOptions<CreateEntityInstances, FullSchema, F>): Promise<SchemaValues<FullSchema, false, CreateEntityInstances, false, F, SchemaPublicFieldNames<FullSchema>> & {}>;
+    private handleWillCreateForPlugins;
     private get primaryFieldName();
     findOne<CreateEntityInstances extends boolean, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>>(query: QueryBuilder<QueryRecord>, options?: PrepareOptions<CreateEntityInstances, FullSchema, F>): Promise<SchemaValues<FullSchema, false, CreateEntityInstances, false, F, SchemaPublicFieldNames<FullSchema>> | null>;
+    private handleDidFindForPlugins;
     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>>>[]>;
     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>>>;

package/build/esm/stores/AbstractStore.js

@@ -101,7 +101,7 @@ export default class AbstractStore extends AbstractMutexer {
         });
     }
     createOne(values, options) {
-        var _a, _b, _c;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 //@ts-ignore
@@ -115,13 +115,9 @@ export default class AbstractStore extends AbstractMutexer {
                 const toSave = normalizeSchemaValues(this.databaseSchema, 
                 //@ts-ignore
                 databaseRecord, { shouldCreateEntityInstances: false });
-                let mixinValuesOnReturn = {};
-                for (const plugin of this.plugins) {
-                    const r = yield ((_b = plugin.willCreateOne) === null || _b === void 0 ? void 0 : _b.call(plugin, toSave));
-                    mixinValuesOnReturn = Object.assign(Object.assign({}, mixinValuesOnReturn), r === null || r === void 0 ? void 0 : r.valuesToMixinBeforeReturning);
-                }
+                const mixinValuesOnReturn = yield this.handleWillCreateForPlugins(toSave);
                 const record = yield this.db.createOne(this.collectionName, toSave);
-                yield ((_c = this.didCreate) === null || _c === void 0 ? void 0 : _c.call(this, record));
+                yield ((_b = this.didCreate) === null || _b === void 0 ? void 0 : _b.call(this, record));
                 const normalized = yield this.prepareAndNormalizeRecord(record, options);
                 return Object.assign(Object.assign({}, normalized), mixinValuesOnReturn);
             }
@@ -136,18 +132,43 @@ export default class AbstractStore extends AbstractMutexer {
             }
         });
     }
+    handleWillCreateForPlugins(toSave) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            let mixinValuesOnReturn = {};
+            for (const plugin of this.plugins) {
+                const r = yield ((_a = plugin.willCreateOne) === null || _a === void 0 ? void 0 : _a.call(plugin, toSave));
+                mixinValuesOnReturn = Object.assign(Object.assign({}, mixinValuesOnReturn), r === null || r === void 0 ? void 0 : r.valuesToMixinBeforeReturning);
+            }
+            return mixinValuesOnReturn;
+        });
+    }
     get primaryFieldName() {
         return this.primaryFieldNames[0];
     }
     findOne(query, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const results = yield this.find(query, { limit: 1 }, options);
-            if (results.length > 0) {
-                return results[0];
+            let match = results[0];
+            if (match) {
+                match = (yield this.handleDidFindForPlugins(query, match));
+                return match;
             }
             return null;
         });
     }
+    handleDidFindForPlugins(query, match) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const plugin of this.plugins) {
+                const { valuesToMixinBeforeReturning: values } = (_b = (yield ((_a = plugin.didFindOne) === null || _a === void 0 ? void 0 : _a.call(plugin, query, match)))) !== null && _b !== void 0 ? _b : {};
+                if (values) {
+                    match = Object.assign(Object.assign({}, match), values);
+                }
+            }
+            return match;
+        });
+    }
     count(query) {
         return __awaiter(this, void 0, void 0, function* () {
             const count = yield this.db.count(this.collectionName, query);

package/build/esm/tests/storePluginAssert.d.ts

@@ -0,0 +1,6 @@
+import { Schema } from '@sprucelabs/schema';
+import AbstractStore from '../stores/AbstractStore';
+declare const storePluginAssert: {
+    storeHasPlugin: (store: AbstractStore<Schema>, pluginName: string) => import("..").DataStorePlugin;
+};
+export default storePluginAssert;

package/build/esm/tests/storePluginAssert.js

@@ -0,0 +1,21 @@
+import { assertOptions } from '@sprucelabs/schema';
+import { assert } from '@sprucelabs/test-utils';
+const storePluginAssert = {
+    storeHasPlugin: (store, pluginName) => {
+        assertOptions({
+            store,
+            pluginName,
+        }, ['store', 'pluginName']);
+        //@ts-ignore
+        const { plugins } = store;
+        if (!(plugins === null || plugins === void 0 ? void 0 : plugins.length)) {
+            assert.fail(`The store you passed has no plugins. Add one to 'protected plugins: DataStorePlugin[] = [...]' or add it in the constructor of your store with 'this.plugins[...]'`);
+        }
+        const plugin = plugins === null || plugins === void 0 ? void 0 : plugins.find((p) => p.getName() === pluginName);
+        if ((plugin === null || plugin === void 0 ? void 0 : plugin.getName()) !== pluginName) {
+            assert.fail(`I could not find the plugin '${pluginName}' in the store you passed. Make sure you added it to 'protected plugins: DataStorePlugin[] = [...]' or added it in the constructor of your store with 'this.plugins[...]'`);
+        }
+        return plugin;
+    },
+};
+export default storePluginAssert;

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

@@ -43,6 +43,7 @@ export interface DataStorePlugin {
     willCreateOne?: (values: Record<string, any>) => Promise<void | DataStorePluginHookResponse>;
     willUpdateOne?: (query: Record<string, any>, updates: Record<string, any>) => Promise<void | DataStorePluginWillUpdateOneResponse>;
     willDeleteOne?: (query: Record<string, any>) => Promise<void | DataStorePluginWillDeleteOneResponse>;
+    didFindOne?: (query: Record<string, any>, record: Record<string, any>) => Promise<void | DataStorePluginDidFindOneResponse>;
     getName(): string;
 }
 export interface DataStorePluginHookResponse {
@@ -54,3 +55,6 @@ export interface DataStorePluginWillUpdateOneResponse {
 export interface DataStorePluginWillDeleteOneResponse {
     query?: Record<string, any>;
 }
+export interface DataStorePluginDidFindOneResponse {
+    valuesToMixinBeforeReturning?: Record<string, any>;
+}

package/build/index.d.ts

@@ -25,6 +25,7 @@ export * from './cursors/CursorPager';
  */
 export { default as databaseAssertUtil } from './tests/databaseAssertUtil';
 export { default as databaseAssert } from './tests/databaseAssertUtil';
+export { default as storePluginAssert } from './tests/storePluginAssert';
 export { default as BatchCursorImpl } from './cursors/BatchCursor';
 export * from './cursors/BatchCursor';
 export { default as BatchArrayCursor } from './cursors/BatchArrayCursor';

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.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.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");
@@ -60,6 +60,8 @@ var databaseAssertUtil_1 = require("./tests/databaseAssertUtil");
 Object.defineProperty(exports, "databaseAssertUtil", { enumerable: true, get: function () { return __importDefault(databaseAssertUtil_1).default; } });
 var databaseAssertUtil_2 = require("./tests/databaseAssertUtil");
 Object.defineProperty(exports, "databaseAssert", { enumerable: true, get: function () { return __importDefault(databaseAssertUtil_2).default; } });
+var storePluginAssert_1 = require("./tests/storePluginAssert");
+Object.defineProperty(exports, "storePluginAssert", { enumerable: true, get: function () { return __importDefault(storePluginAssert_1).default; } });
 var BatchCursor_1 = require("./cursors/BatchCursor");
 Object.defineProperty(exports, "BatchCursorImpl", { enumerable: true, get: function () { return __importDefault(BatchCursor_1).default; } });
 __exportStar(require("./cursors/BatchCursor"), exports);

package/build/stores/AbstractStore.d.ts

@@ -4,9 +4,7 @@ import AbstractMutexer from '../mutexers/AbstractMutexer';
 import { DataStorePlugin, Database } from '../types/database.types';
 import { QueryBuilder, QueryOptions } from '../types/query.types';
 import { PrepareOptions, PrepareResults, SaveOperations, DataStore } from '../types/stores.types';
-export default abstract class AbstractStore<FullSchema extends Schema, CreateSchema extends Schema = FullSchema, UpdateSchema extends Schema = CreateSchema, DatabaseSchema extends Schema = FullSchema, DatabaseRecord = SchemaValues<DatabaseSchema> & {
-    id: string;
-}, QueryRecord = SchemaPartialValues<FullSchema>, FullRecord = SchemaValues<FullSchema>, CreateRecord = SchemaValues<CreateSchema>, UpdateRecord = SchemaValues<UpdateSchema> & SaveOperations> extends AbstractMutexer implements DataStore {
+export default abstract class AbstractStore<FullSchema extends Schema, CreateSchema extends Schema = FullSchema, UpdateSchema extends Schema = CreateSchema, DatabaseSchema extends Schema = FullSchema, DatabaseRecord = SchemaValues<DatabaseSchema>, QueryRecord = SchemaPartialValues<FullSchema>, FullRecord = SchemaValues<FullSchema>, CreateRecord = SchemaValues<CreateSchema>, UpdateRecord = SchemaValues<UpdateSchema> & SaveOperations> extends AbstractMutexer implements DataStore {
     abstract readonly name: string;
     protected abstract collectionName: string;
     protected abstract createSchema: CreateSchema;
@@ -35,8 +33,10 @@ export default abstract class AbstractStore<FullSchema extends Schema, CreateSch
     private mapCasing;
     create<IncludePrivateFields extends boolean = true, CreateEntityInstances extends boolean = false, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>, PF extends SchemaPublicFieldNames<FullSchema> = SchemaPublicFieldNames<FullSchema>>(values: CreateRecord[], options?: PrepareOptions<CreateEntityInstances, FullSchema, F>): Promise<Response<FullSchema, CreateEntityInstances, IncludePrivateFields, PF, F>[]>;
     createOne<CreateEntityInstances extends boolean, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>>(values: CreateRecord, options?: PrepareOptions<CreateEntityInstances, FullSchema, F>): Promise<SchemaValues<FullSchema, false, CreateEntityInstances, false, F, SchemaPublicFieldNames<FullSchema>> & {}>;
+    private handleWillCreateForPlugins;
     private get primaryFieldName();
     findOne<CreateEntityInstances extends boolean, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>>(query: QueryBuilder<QueryRecord>, options?: PrepareOptions<CreateEntityInstances, FullSchema, F>): Promise<SchemaValues<FullSchema, false, CreateEntityInstances, false, F, SchemaPublicFieldNames<FullSchema>> | null>;
+    private handleDidFindForPlugins;
     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>>>[]>;
     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>>>;

package/build/stores/AbstractStore.js

@@ -116,7 +116,7 @@ class AbstractStore extends AbstractMutexer_1.default {
         }
     }
     async createOne(values, options) {
-        var _a, _b, _c;
+        var _a, _b;
         try {
             //@ts-ignore
             (0, schema_1.validateSchemaValues)(this.createSchema, values);
@@ -129,13 +129,9 @@ class AbstractStore extends AbstractMutexer_1.default {
             const toSave = (0, schema_1.normalizeSchemaValues)(this.databaseSchema, 
             //@ts-ignore
             databaseRecord, { shouldCreateEntityInstances: false });
-            let mixinValuesOnReturn = {};
-            for (const plugin of this.plugins) {
-                const r = await ((_b = plugin.willCreateOne) === null || _b === void 0 ? void 0 : _b.call(plugin, toSave));
-                mixinValuesOnReturn = Object.assign(Object.assign({}, mixinValuesOnReturn), r === null || r === void 0 ? void 0 : r.valuesToMixinBeforeReturning);
-            }
+            const mixinValuesOnReturn = await this.handleWillCreateForPlugins(toSave);
             const record = await this.db.createOne(this.collectionName, toSave);
-            await ((_c = this.didCreate) === null || _c === void 0 ? void 0 : _c.call(this, record));
+            await ((_b = this.didCreate) === null || _b === void 0 ? void 0 : _b.call(this, record));
             const normalized = await this.prepareAndNormalizeRecord(record, options);
             return Object.assign(Object.assign({}, normalized), mixinValuesOnReturn);
         }
@@ -149,16 +145,37 @@ class AbstractStore extends AbstractMutexer_1.default {
             throw coded[0];
         }
     }
+    async handleWillCreateForPlugins(toSave) {
+        var _a;
+        let mixinValuesOnReturn = {};
+        for (const plugin of this.plugins) {
+            const r = await ((_a = plugin.willCreateOne) === null || _a === void 0 ? void 0 : _a.call(plugin, toSave));
+            mixinValuesOnReturn = Object.assign(Object.assign({}, mixinValuesOnReturn), r === null || r === void 0 ? void 0 : r.valuesToMixinBeforeReturning);
+        }
+        return mixinValuesOnReturn;
+    }
     get primaryFieldName() {
         return this.primaryFieldNames[0];
     }
     async findOne(query, options = {}) {
         const results = await this.find(query, { limit: 1 }, options);
-        if (results.length > 0) {
-            return results[0];
+        let match = results[0];
+        if (match) {
+            match = (await this.handleDidFindForPlugins(query, match));
+            return match;
         }
         return null;
     }
+    async handleDidFindForPlugins(query, match) {
+        var _a, _b;
+        for (const plugin of this.plugins) {
+            const { valuesToMixinBeforeReturning: values } = (_b = (await ((_a = plugin.didFindOne) === null || _a === void 0 ? void 0 : _a.call(plugin, query, match)))) !== null && _b !== void 0 ? _b : {};
+            if (values) {
+                match = Object.assign(Object.assign({}, match), values);
+            }
+        }
+        return match;
+    }
     async count(query) {
         const count = await this.db.count(this.collectionName, query);
         return count;

package/build/tests/storePluginAssert.d.ts

@@ -0,0 +1,6 @@
+import { Schema } from '@sprucelabs/schema';
+import AbstractStore from '../stores/AbstractStore';
+declare const storePluginAssert: {
+    storeHasPlugin: (store: AbstractStore<Schema>, pluginName: string) => import("..").DataStorePlugin;
+};
+export default storePluginAssert;

package/build/tests/storePluginAssert.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const schema_1 = require("@sprucelabs/schema");
+const test_utils_1 = require("@sprucelabs/test-utils");
+const storePluginAssert = {
+    storeHasPlugin: (store, pluginName) => {
+        (0, schema_1.assertOptions)({
+            store,
+            pluginName,
+        }, ['store', 'pluginName']);
+        //@ts-ignore
+        const { plugins } = store;
+        if (!(plugins === null || plugins === void 0 ? void 0 : plugins.length)) {
+            test_utils_1.assert.fail(`The store you passed has no plugins. Add one to 'protected plugins: DataStorePlugin[] = [...]' or add it in the constructor of your store with 'this.plugins[...]'`);
+        }
+        const plugin = plugins === null || plugins === void 0 ? void 0 : plugins.find((p) => p.getName() === pluginName);
+        if ((plugin === null || plugin === void 0 ? void 0 : plugin.getName()) !== pluginName) {
+            test_utils_1.assert.fail(`I could not find the plugin '${pluginName}' in the store you passed. Make sure you added it to 'protected plugins: DataStorePlugin[] = [...]' or added it in the constructor of your store with 'this.plugins[...]'`);
+        }
+        return plugin;
+    },
+};
+exports.default = storePluginAssert;

package/build/types/database.types.d.ts

@@ -43,6 +43,7 @@ export interface DataStorePlugin {
     willCreateOne?: (values: Record<string, any>) => Promise<void | DataStorePluginHookResponse>;
     willUpdateOne?: (query: Record<string, any>, updates: Record<string, any>) => Promise<void | DataStorePluginWillUpdateOneResponse>;
     willDeleteOne?: (query: Record<string, any>) => Promise<void | DataStorePluginWillDeleteOneResponse>;
+    didFindOne?: (query: Record<string, any>, record: Record<string, any>) => Promise<void | DataStorePluginDidFindOneResponse>;
     getName(): string;
 }
 export interface DataStorePluginHookResponse {
@@ -54,3 +55,6 @@ export interface DataStorePluginWillUpdateOneResponse {
 export interface DataStorePluginWillDeleteOneResponse {
     query?: Record<string, any>;
 }
+export interface DataStorePluginDidFindOneResponse {
+    valuesToMixinBeforeReturning?: Record<string, any>;
+}

package/package.json

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