@sprucelabs/data-stores 25.8.1 → 25.10.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;

package/build/esm/stores/AbstractStore.js

@@ -323,12 +323,16 @@ export default class AbstractStore extends AbstractMutexer {
         });
     }
     deleteOne(query) {
-        var _a;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            let q = Object.assign({}, query);
             for (const plugin of this.plugins) {
-                yield ((_a = plugin.willDeleteOne) === null || _a === void 0 ? void 0 : _a.call(plugin, query));
+                const { query } = (_b = (yield ((_a = plugin.willDeleteOne) === null || _a === void 0 ? void 0 : _a.call(plugin, q)))) !== null && _b !== void 0 ? _b : {};
+                if (query) {
+                    q = query;
+                }
             }
-            return yield this.db.deleteOne(this.collectionName, query);
+            return yield this.db.deleteOne(this.collectionName, q);
         });
     }
     delete(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

@@ -42,7 +42,7 @@ export type TestConnect = (connectionString?: string, dbName?: string) => Promis
 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>;
+    willDeleteOne?: (query: Record<string, any>) => Promise<void | DataStorePluginWillDeleteOneResponse>;
     getName(): string;
 }
 export interface DataStorePluginHookResponse {
@@ -51,3 +51,6 @@ export interface DataStorePluginHookResponse {
 export interface DataStorePluginWillUpdateOneResponse {
     query?: Record<string, any>;
 }
+export interface DataStorePluginWillDeleteOneResponse {
+    query?: 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;

package/build/stores/AbstractStore.js

@@ -316,11 +316,15 @@ class AbstractStore extends AbstractMutexer_1.default {
         return cleanedValues;
     }
     async deleteOne(query) {
-        var _a;
+        var _a, _b;
+        let q = Object.assign({}, query);
         for (const plugin of this.plugins) {
-            await ((_a = plugin.willDeleteOne) === null || _a === void 0 ? void 0 : _a.call(plugin, query));
+            const { query } = (_b = (await ((_a = plugin.willDeleteOne) === null || _a === void 0 ? void 0 : _a.call(plugin, q)))) !== null && _b !== void 0 ? _b : {};
+            if (query) {
+                q = query;
+            }
         }
-        return await this.db.deleteOne(this.collectionName, query);
+        return await this.db.deleteOne(this.collectionName, q);
     }
     async delete(query) {
         return await this.db.delete(this.collectionName, query);

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

@@ -42,7 +42,7 @@ export type TestConnect = (connectionString?: string, dbName?: string) => Promis
 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>;
+    willDeleteOne?: (query: Record<string, any>) => Promise<void | DataStorePluginWillDeleteOneResponse>;
     getName(): string;
 }
 export interface DataStorePluginHookResponse {
@@ -51,3 +51,6 @@ export interface DataStorePluginHookResponse {
 export interface DataStorePluginWillUpdateOneResponse {
     query?: Record<string, any>;
 }
+export interface DataStorePluginWillDeleteOneResponse {
+    query?: Record<string, any>;
+}

package/package.json

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