@sprucelabs/data-stores 26.1.1 → 26.1.3

package/build/databases/NeDbDatabase.d.ts

@@ -1,5 +1,5 @@
 import AbstractMutexer from '../mutexers/AbstractMutexer';
-import { Database } from '../types/database.types';
+import { CreateOptions, Database } from '../types/database.types';
 import { QueryOptions } from '../types/query.types';
 export default class NeDbDatabase extends AbstractMutexer implements Database {
     private collections;
@@ -17,8 +17,8 @@ export default class NeDbDatabase extends AbstractMutexer implements Database {
     private normalizeRecord;
     private handlePlaceholders;
     count(collection: string, query?: Record<string, any>): Promise<number>;
-    createOne(collection: string, values: Record<string, any>): Promise<Record<string, any>>;
-    create(collection: string, values: Record<string, any>[]): Promise<Record<string, any>[]>;
+    createOne(collection: string, values: Record<string, any>, options?: CreateOptions): Promise<Record<string, any>>;
+    create(collection: string, values: Record<string, any>[], options?: CreateOptions): Promise<Record<string, any>[]>;
     private loadCollection;
     dropCollection(name: string): Promise<void>;
     dropDatabase(): Promise<void>;

package/build/databases/NeDbDatabase.js

@@ -80,10 +80,11 @@ class NeDbDatabase extends AbstractMutexer_1.default {
     isConnected() {
         return this._isConnected;
     }
-    normalizeRecord(record) {
+    normalizeRecord(record, options) {
         const { _id } = record, rest = __rest(record, ["_id"]);
         let values = this.handlePlaceholders(rest, null, (val) => val === null || val === NULL_PLACEHOLDER);
-        if (!_id) {
+        const { primaryFieldNames = ['id'] } = options !== null && options !== void 0 ? options : {};
+        if (!_id || !primaryFieldNames.includes('id')) {
             return values;
         }
         return Object.assign({ id: _id }, values);
@@ -125,19 +126,21 @@ class NeDbDatabase extends AbstractMutexer_1.default {
             });
         });
     }
-    async createOne(collection, values) {
+    async createOne(collection, values, options) {
         await this.randomDelay();
-        const all = await this.create(collection, [values]);
+        const all = await this.create(collection, [values], options);
         return all[0];
     }
-    async create(collection, values) {
+    async create(collection, values, options) {
         const mutexName = 'createMutex';
         await this.lock(mutexName);
         await this.randomDelay();
+        const { primaryFieldNames = ['id'] } = options !== null && options !== void 0 ? options : {};
+        const firstPrimaryFieldName = primaryFieldNames[0] === 'id' ? '_id' : primaryFieldNames[0];
         const col = this.loadCollection(collection);
         const mapped = values
             .map((v) => this.valuesToDocument(v))
-            .map((v) => (Object.assign({ _id: this.generateId() }, v)));
+            .map((v) => (Object.assign({ [firstPrimaryFieldName]: this.generateId() }, v)));
         try {
             await Promise.all(mapped.map((m) => this.assertPassesUniqueIndexes(collection, undefined, m, 'create')));
         }
@@ -152,7 +155,7 @@ class NeDbDatabase extends AbstractMutexer_1.default {
                     reject(err);
                 }
                 else {
-                    resolve(docs.map((doc) => this.normalizeRecord(doc)));
+                    resolve(docs.map((doc) => this.normalizeRecord(doc, options)));
                 }
             });
         });

package/build/esm/databases/NeDbDatabase.d.ts

@@ -1,5 +1,5 @@
 import AbstractMutexer from '../mutexers/AbstractMutexer';
-import { Database } from '../types/database.types';
+import { CreateOptions, Database } from '../types/database.types';
 import { QueryOptions } from '../types/query.types';
 export default class NeDbDatabase extends AbstractMutexer implements Database {
     private collections;
@@ -17,8 +17,8 @@ export default class NeDbDatabase extends AbstractMutexer implements Database {
     private normalizeRecord;
     private handlePlaceholders;
     count(collection: string, query?: Record<string, any>): Promise<number>;
-    createOne(collection: string, values: Record<string, any>): Promise<Record<string, any>>;
-    create(collection: string, values: Record<string, any>[]): Promise<Record<string, any>[]>;
+    createOne(collection: string, values: Record<string, any>, options?: CreateOptions): Promise<Record<string, any>>;
+    create(collection: string, values: Record<string, any>[], options?: CreateOptions): Promise<Record<string, any>[]>;
     private loadCollection;
     dropCollection(name: string): Promise<void>;
     dropDatabase(): Promise<void>;

package/build/esm/databases/NeDbDatabase.js

@@ -92,10 +92,11 @@ export default class NeDbDatabase extends AbstractMutexer {
     isConnected() {
         return this._isConnected;
     }
-    normalizeRecord(record) {
+    normalizeRecord(record, options) {
         const { _id } = record, rest = __rest(record, ["_id"]);
         let values = this.handlePlaceholders(rest, null, (val) => val === null || val === NULL_PLACEHOLDER);
-        if (!_id) {
+        const { primaryFieldNames = ['id'] } = options !== null && options !== void 0 ? options : {};
+        if (!_id || !primaryFieldNames.includes('id')) {
             return values;
         }
         return Object.assign({ id: _id }, values);
@@ -139,22 +140,24 @@ export default class NeDbDatabase extends AbstractMutexer {
             });
         });
     }
-    createOne(collection, values) {
+    createOne(collection, values, options) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.randomDelay();
-            const all = yield this.create(collection, [values]);
+            const all = yield this.create(collection, [values], options);
             return all[0];
         });
     }
-    create(collection, values) {
+    create(collection, values, options) {
         return __awaiter(this, void 0, void 0, function* () {
             const mutexName = 'createMutex';
             yield this.lock(mutexName);
             yield this.randomDelay();
+            const { primaryFieldNames = ['id'] } = options !== null && options !== void 0 ? options : {};
+            const firstPrimaryFieldName = primaryFieldNames[0] === 'id' ? '_id' : primaryFieldNames[0];
             const col = this.loadCollection(collection);
             const mapped = values
                 .map((v) => this.valuesToDocument(v))
-                .map((v) => (Object.assign({ _id: this.generateId() }, v)));
+                .map((v) => (Object.assign({ [firstPrimaryFieldName]: this.generateId() }, v)));
             try {
                 yield Promise.all(mapped.map((m) => this.assertPassesUniqueIndexes(collection, undefined, m, 'create')));
             }
@@ -169,7 +172,7 @@ export default class NeDbDatabase extends AbstractMutexer {
                         reject(err);
                     }
                     else {
-                        resolve(docs.map((doc) => this.normalizeRecord(doc)));
+                        resolve(docs.map((doc) => this.normalizeRecord(doc, options)));
                     }
                 });
             });

package/build/esm/stores/AbstractStore.js

@@ -46,10 +46,15 @@ export default class AbstractStore extends AbstractMutexer {
         return this.collectionName;
     }
     prepareAndNormalizeRecord(record, options = {}) {
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
-            const preparedRecord = this.prepareRecord
+            let preparedRecord = this.prepareRecord
                 ? yield this.prepareRecord(record, options)
                 : record;
+            const pluginResults = yield ((_b = (_a = this.plugins[0]) === null || _a === void 0 ? void 0 : _a.prepareRecord) === null || _b === void 0 ? void 0 : _b.call(_a, preparedRecord));
+            if (pluginResults === null || pluginResults === void 0 ? void 0 : pluginResults.newValues) {
+                preparedRecord = pluginResults.newValues;
+            }
             const isScrambled = this.isScrambled(preparedRecord);
             if (isScrambled) {
                 return preparedRecord;
@@ -96,14 +101,17 @@ export default class AbstractStore extends AbstractMutexer {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                let valuesToMixinBeforeCreate = yield this.handleWillCreatePlugins(values);
                 //@ts-ignore
                 validateSchemaValues(this.createSchema, values);
                 const cleanedValues = this.willCreate
                     ? yield this.willCreate(values)
                     : values;
-                const toSave = this.normalizeBeforeSave(cleanedValues);
-                const record = yield this.db.createOne(this.collectionName, Object.assign(Object.assign({}, toSave), valuesToMixinBeforeCreate));
+                let { valuesToMixinBeforeCreate, values: nv } = yield this.handleWillCreatePlugins(cleanedValues);
+                const newValues = (nv !== null && nv !== void 0 ? nv : cleanedValues);
+                const toSave = this.normalizeBeforeSave(newValues);
+                const record = yield this.db.createOne(this.collectionName, Object.assign(Object.assign({}, toSave), valuesToMixinBeforeCreate), {
+                    primaryFieldNames: this.primaryFieldNames,
+                });
                 yield ((_a = this.didCreate) === null || _a === void 0 ? void 0 : _a.call(this, record));
                 const normalized = yield this.prepareAndNormalizeRecord(record, options);
                 const mixinValuesOnReturn = yield this.handleDidCreateForPlugins(normalized);
@@ -143,14 +151,18 @@ export default class AbstractStore extends AbstractMutexer {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             let valuesToMixinBeforeCreate = {};
+            let newValues;
             for (const plugin of this.plugins) {
                 const r = yield ((_a = plugin.willCreateOne) === null || _a === void 0 ? void 0 : _a.call(plugin, values));
-                const { valuesToMixinBeforeCreate: v } = r !== null && r !== void 0 ? r : {};
+                const { valuesToMixinBeforeCreate: v, newValues: nv } = r !== null && r !== void 0 ? r : {};
+                if (nv) {
+                    newValues = nv;
+                }
                 if (v) {
                     valuesToMixinBeforeCreate = Object.assign(Object.assign({}, valuesToMixinBeforeCreate), v);
                 }
             }
-            return valuesToMixinBeforeCreate;
+            return { valuesToMixinBeforeCreate, values: newValues };
         });
     }
     handleDidCreateForPlugins(record) {

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

@@ -1,7 +1,5 @@
 import { Log } from '@sprucelabs/spruce-skill-utils';
 import { QueryOptions } from './query.types';
-export type UniqueIndex = string[];
-export type Index = string[];
 export interface Database {
     [x: string]: any;
     syncUniqueIndexes(collectionName: string, indexes: UniqueIndex[]): Promise<void>;
@@ -14,7 +12,7 @@ export interface Database {
     connect(): Promise<void>;
     close(): Promise<void>;
     getShouldAutoGenerateId?(): boolean;
-    createOne(collection: string, values: Record<string, any>): Promise<Record<string, any>>;
+    createOne(collection: string, values: Record<string, any>, options?: CreateOptions): Promise<Record<string, any>>;
     create(collection: string, values: Record<string, any>[]): Promise<Record<string, any>[]>;
     dropCollection(name: string): Promise<void>;
     dropDatabase(): Promise<void>;
@@ -40,3 +38,8 @@ export type TestConnect = (connectionString?: string, dbName?: string) => Promis
     connectionStringWithRandomBadDatabaseName: string;
     badDatabaseName: string;
 }>;
+export type UniqueIndex = string[];
+export type Index = string[];
+export interface CreateOptions {
+    primaryFieldNames?: string[];
+}

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

@@ -37,12 +37,17 @@ export interface DataStorePlugin {
     willDeleteOne?: (query: Record<string, any>) => Promise<void | DataStorePluginWillDeleteOneResponse>;
     didFindOne?: (query: Record<string, any>, record: Record<string, any>) => Promise<void | DataStorePluginDidFindOneResponse>;
     getName(): string;
+    prepareRecord?: (record: Record<string, any>) => Promise<void | DataStorePluginPrepareResponse>;
+}
+export interface DataStorePluginPrepareResponse {
+    newValues?: Record<string, any>;
 }
 export interface DataStorePluginDidCreateOneResponse {
     valuesToMixinBeforeReturning?: Record<string, any>;
 }
 export interface DataStorePluginWillCreateOneResponse {
     valuesToMixinBeforeCreate?: Record<string, any>;
+    newValues?: Record<string, any>;
 }
 export interface DataStorePluginWillUpdateOneResponse {
     query?: Record<string, any>;

package/build/stores/AbstractStore.js

@@ -65,9 +65,14 @@ class AbstractStore extends AbstractMutexer_1.default {
         return this.collectionName;
     }
     async prepareAndNormalizeRecord(record, options = {}) {
-        const preparedRecord = this.prepareRecord
+        var _a, _b;
+        let preparedRecord = this.prepareRecord
             ? await this.prepareRecord(record, options)
             : record;
+        const pluginResults = await ((_b = (_a = this.plugins[0]) === null || _a === void 0 ? void 0 : _a.prepareRecord) === null || _b === void 0 ? void 0 : _b.call(_a, preparedRecord));
+        if (pluginResults === null || pluginResults === void 0 ? void 0 : pluginResults.newValues) {
+            preparedRecord = pluginResults.newValues;
+        }
         const isScrambled = this.isScrambled(preparedRecord);
         if (isScrambled) {
             return preparedRecord;
@@ -110,14 +115,17 @@ class AbstractStore extends AbstractMutexer_1.default {
     async createOne(values, options) {
         var _a;
         try {
-            let valuesToMixinBeforeCreate = await this.handleWillCreatePlugins(values);
             //@ts-ignore
             (0, schema_1.validateSchemaValues)(this.createSchema, values);
             const cleanedValues = this.willCreate
                 ? await this.willCreate(values)
                 : values;
-            const toSave = this.normalizeBeforeSave(cleanedValues);
-            const record = await this.db.createOne(this.collectionName, Object.assign(Object.assign({}, toSave), valuesToMixinBeforeCreate));
+            let { valuesToMixinBeforeCreate, values: nv } = await this.handleWillCreatePlugins(cleanedValues);
+            const newValues = (nv !== null && nv !== void 0 ? nv : cleanedValues);
+            const toSave = this.normalizeBeforeSave(newValues);
+            const record = await this.db.createOne(this.collectionName, Object.assign(Object.assign({}, toSave), valuesToMixinBeforeCreate), {
+                primaryFieldNames: this.primaryFieldNames,
+            });
             await ((_a = this.didCreate) === null || _a === void 0 ? void 0 : _a.call(this, record));
             const normalized = await this.prepareAndNormalizeRecord(record, options);
             const mixinValuesOnReturn = await this.handleDidCreateForPlugins(normalized);
@@ -155,14 +163,18 @@ class AbstractStore extends AbstractMutexer_1.default {
     async handleWillCreatePlugins(values) {
         var _a;
         let valuesToMixinBeforeCreate = {};
+        let newValues;
         for (const plugin of this.plugins) {
             const r = await ((_a = plugin.willCreateOne) === null || _a === void 0 ? void 0 : _a.call(plugin, values));
-            const { valuesToMixinBeforeCreate: v } = r !== null && r !== void 0 ? r : {};
+            const { valuesToMixinBeforeCreate: v, newValues: nv } = r !== null && r !== void 0 ? r : {};
+            if (nv) {
+                newValues = nv;
+            }
             if (v) {
                 valuesToMixinBeforeCreate = Object.assign(Object.assign({}, valuesToMixinBeforeCreate), v);
             }
         }
-        return valuesToMixinBeforeCreate;
+        return { valuesToMixinBeforeCreate, values: newValues };
     }
     async handleDidCreateForPlugins(record) {
         var _a;

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

@@ -1,7 +1,5 @@
 import { Log } from '@sprucelabs/spruce-skill-utils';
 import { QueryOptions } from './query.types';
-export type UniqueIndex = string[];
-export type Index = string[];
 export interface Database {
     [x: string]: any;
     syncUniqueIndexes(collectionName: string, indexes: UniqueIndex[]): Promise<void>;
@@ -14,7 +12,7 @@ export interface Database {
     connect(): Promise<void>;
     close(): Promise<void>;
     getShouldAutoGenerateId?(): boolean;
-    createOne(collection: string, values: Record<string, any>): Promise<Record<string, any>>;
+    createOne(collection: string, values: Record<string, any>, options?: CreateOptions): Promise<Record<string, any>>;
     create(collection: string, values: Record<string, any>[]): Promise<Record<string, any>[]>;
     dropCollection(name: string): Promise<void>;
     dropDatabase(): Promise<void>;
@@ -40,3 +38,8 @@ export type TestConnect = (connectionString?: string, dbName?: string) => Promis
     connectionStringWithRandomBadDatabaseName: string;
     badDatabaseName: string;
 }>;
+export type UniqueIndex = string[];
+export type Index = string[];
+export interface CreateOptions {
+    primaryFieldNames?: string[];
+}

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

@@ -37,12 +37,17 @@ export interface DataStorePlugin {
     willDeleteOne?: (query: Record<string, any>) => Promise<void | DataStorePluginWillDeleteOneResponse>;
     didFindOne?: (query: Record<string, any>, record: Record<string, any>) => Promise<void | DataStorePluginDidFindOneResponse>;
     getName(): string;
+    prepareRecord?: (record: Record<string, any>) => Promise<void | DataStorePluginPrepareResponse>;
+}
+export interface DataStorePluginPrepareResponse {
+    newValues?: Record<string, any>;
 }
 export interface DataStorePluginDidCreateOneResponse {
     valuesToMixinBeforeReturning?: Record<string, any>;
 }
 export interface DataStorePluginWillCreateOneResponse {
     valuesToMixinBeforeCreate?: Record<string, any>;
+    newValues?: Record<string, any>;
 }
 export interface DataStorePluginWillUpdateOneResponse {
     query?: Record<string, any>;

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "26.1.1",
+  "version": "26.1.3",
   "files": [
     "build/**/*",
     "!build/__tests__",
@@ -68,23 +68,23 @@
     "upgrade.packages.test": "yarn upgrade.packages.all && yarn lint && yarn build.dev && yarn test"
   },
   "dependencies": {
-    "@sprucelabs/error": "^5.1.50",
+    "@sprucelabs/error": "^5.1.51",
     "@sprucelabs/globby": "^1.0.3",
-    "@sprucelabs/schema": "^29.0.93",
-    "@sprucelabs/spruce-skill-utils": "^30.1.35",
+    "@sprucelabs/schema": "^29.1.0",
+    "@sprucelabs/spruce-skill-utils": "^30.1.36",
     "just-clone": "^6.2.0",
     "lodash": "^4.17.21",
     "mongodb": "^6.3.0",
     "nedb": "^1.8.0"
   },
   "devDependencies": {
-    "@sprucelabs/esm-postbuild": "^5.0.104",
-    "@sprucelabs/jest-json-reporter": "^7.0.129",
+    "@sprucelabs/esm-postbuild": "^5.0.105",
+    "@sprucelabs/jest-json-reporter": "^7.0.130",
     "@sprucelabs/jest-sheets-reporter": "^3.0.26",
-    "@sprucelabs/resolve-path-aliases": "^1.1.267",
+    "@sprucelabs/resolve-path-aliases": "^1.1.268",
     "@sprucelabs/semantic-release": "^4.0.8",
-    "@sprucelabs/test": "^8.0.33",
-    "@sprucelabs/test-utils": "^4.0.82",
+    "@sprucelabs/test": "^8.0.34",
+    "@sprucelabs/test-utils": "^4.0.83",
     "@types/lodash": "^4.14.202",
     "@types/nedb": "^1.8.16",
     "@types/node": "^20.10.3",
@@ -129,10 +129,7 @@
         {
           "sheetId": "1DoWM7mYgGDa-PJXptLomrZmbIBZiuxS1YiAsRXU2Gm0",
           "worksheetId": 843037832,
-          "testMap": {
-            "canCountRecords": "I35",
-            "syncing Unique Index On Duped Fields Throws SpruceError (mongo)": "Y107"
-          }
+          "testMap": {}
         }
       ]
     ]