@sprucelabs/data-stores 25.13.14 → 26.0.1

package/build/databases/NeDbDatabase.d.ts

@@ -10,6 +10,7 @@ export default class NeDbDatabase extends AbstractMutexer implements Database {
     private toMongoId;
     private prepQuery;
     private valuesToDocument;
+    getShouldAutoGenerateId(): boolean;
     setShouldAutoGenerateIds(collection: string, shouldAutoGenerateIds: boolean): Promise<void>;
     private randomDelay;
     isConnected(): boolean;

package/build/databases/NeDbDatabase.js

@@ -62,6 +62,9 @@ class NeDbDatabase extends AbstractMutexer_1.default {
         const undefinedToPlaceholder = this.handlePlaceholders(nullsToPlaceholder, UNDEFINED_PLACEHOLDER, (val) => val === undefined || val === UNDEFINED_PLACEHOLDER);
         return undefinedToPlaceholder;
     }
+    getShouldAutoGenerateId() {
+        return true;
+    }
     async setShouldAutoGenerateIds(collection, shouldAutoGenerateIds) {
         const col = this.loadCollection(collection);
         //@ts-ignore

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

@@ -10,6 +10,7 @@ export default class NeDbDatabase extends AbstractMutexer implements Database {
     private toMongoId;
     private prepQuery;
     private valuesToDocument;
+    getShouldAutoGenerateId(): boolean;
     setShouldAutoGenerateIds(collection: string, shouldAutoGenerateIds: boolean): Promise<void>;
     private randomDelay;
     isConnected(): boolean;

package/build/esm/databases/NeDbDatabase.js

@@ -70,6 +70,9 @@ export default class NeDbDatabase extends AbstractMutexer {
         const undefinedToPlaceholder = this.handlePlaceholders(nullsToPlaceholder, UNDEFINED_PLACEHOLDER, (val) => val === undefined || val === UNDEFINED_PLACEHOLDER);
         return undefinedToPlaceholder;
     }
+    getShouldAutoGenerateId() {
+        return true;
+    }
     setShouldAutoGenerateIds(collection, shouldAutoGenerateIds) {
         return __awaiter(this, void 0, void 0, function* () {
             const col = this.loadCollection(collection);

package/build/esm/factories/StoreFactory.d.ts

@@ -10,11 +10,6 @@ export default class StoreFactory {
     private stores;
     private constructor();
     static Factory(db: Database): StoreFactory;
-    /**
-     * @deprecated stores.Store(..) -> stores.getStore(...)
-     * This change has big speed improvements. This factory method
-     * will never be removed, but hopefully won't be needed often.
-     */
     Store<Name extends StoreName, Options extends StoreOptions<Name>>(name: Name, options?: Options): Promise<StoreMap[Name]>;
     getStoreNames(): StoreName[];
     setStoreClass(name: string, Class: StoreContructor): void;

package/build/esm/factories/StoreFactory.js

@@ -18,11 +18,6 @@ class StoreFactory {
     static Factory(db) {
         return new this(db);
     }
-    /**
-     * @deprecated stores.Store(..) -> stores.getStore(...)
-     * This change has big speed improvements. This factory method
-     * will never be removed, but hopefully won't be needed often.
-     */
     Store(name, options) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {

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

@@ -4,7 +4,7 @@ import AbstractMutexer from '../mutexers/AbstractMutexer';
 import { Database } from '../types/database.types';
 import { QueryBuilder, QueryOptions } from '../types/query.types';
 import { PrepareOptions, PrepareResults, SaveOperations, DataStore, DataStorePlugin } 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>, 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, PrimaryFieldName extends SchemaFieldNames<DatabaseSchema> | 'id' = 'id', 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;
@@ -13,12 +13,12 @@ export default abstract class AbstractStore<FullSchema extends Schema, CreateSch
     protected abstract databaseSchema: DatabaseSchema;
     protected scrambleFields?: string[];
     protected db: Database;
-    protected primaryFieldNames: string[];
+    protected primaryFieldNames: PrimaryFieldName[];
     protected shouldMapLowerCaseToCamelCase: boolean;
     protected plugins: DataStorePlugin[];
     initialize?(): Promise<void>;
     protected prepareRecord?<IncludePrivateFields extends boolean, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>>(record: DatabaseRecord, options?: PrepareOptions<IncludePrivateFields, FullSchema, F>): Promise<PrepareResults<FullSchema, IncludePrivateFields>>;
-    protected willCreate?(values: CreateRecord): Promise<Omit<DatabaseRecord, 'id'>>;
+    protected willCreate?(values: CreateRecord): Promise<Omit<DatabaseRecord, PrimaryFieldName>>;
     protected didCreate?(values: CreateRecord): Promise<void>;
     protected willUpdate?(updates: UpdateRecord, record: DatabaseRecord): Promise<Partial<DatabaseRecord>>;
     protected didUpdate?(old: DatabaseRecord, updated: DatabaseRecord): Promise<void>;
@@ -33,6 +33,7 @@ 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 normalizeBeforeSave;
     private handleWillCreatePlugins;
     private handleDidCreateForPlugins;
     private get primaryFieldName();

package/build/esm/stores/AbstractStore.js

@@ -18,7 +18,7 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
-import SchemaEntity, { normalizeSchemaValues, validateSchemaValues, } from '@sprucelabs/schema';
+import SchemaEntity, { normalizeSchemaValues, validateSchemaValues, dropFields, } from '@sprucelabs/schema';
 import { SCRAMBLE_VALUE } from '../constants.js';
 import BatchCursorImpl from '../cursors/BatchCursor.js';
 import SpruceError from '../errors/SpruceError.js';
@@ -77,15 +77,7 @@ export default class AbstractStore extends AbstractMutexer {
                 //@ts-ignore
                 values.forEach((v) => validateSchemaValues(this.createSchema, v));
                 const cleanedValues = yield Promise.all(values.map((v) => __awaiter(this, void 0, void 0, function* () { return (this.willCreate ? this.willCreate(v) : v); })));
-                const databaseRecords = cleanedValues.map((v) => {
-                    var _a;
-                    return (Object.assign(Object.assign({}, v), { [this.primaryFieldName]: 
-                        //@ts-ignore
-                        (_a = v[this.primaryFieldName]) !== null && _a !== void 0 ? _a : this.db.generateId() }));
-                });
-                const toSave = databaseRecords.map((r) => normalizeSchemaValues(this.databaseSchema, 
-                //@ts-ignore
-                r, { shouldCreateEntityInstances: false }));
+                const toSave = cleanedValues.map((v) => this.normalizeBeforeSave(v));
                 const records = yield this.db.create(this.collectionName, toSave);
                 return Promise.all(records.map((record) => __awaiter(this, void 0, void 0, function* () { return this.prepareAndNormalizeRecord(record, options); })));
             }
@@ -101,7 +93,7 @@ export default class AbstractStore extends AbstractMutexer {
         });
     }
     createOne(values, options) {
-        var _a, _b;
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 let valuesToMixinBeforeCreate = yield this.handleWillCreatePlugins(values);
@@ -110,14 +102,9 @@ export default class AbstractStore extends AbstractMutexer {
                 const cleanedValues = this.willCreate
                     ? yield this.willCreate(values)
                     : values;
-                const databaseRecord = Object.assign(Object.assign({}, cleanedValues), { [this.primaryFieldName]: 
-                    //@ts-ignore
-                    (_a = cleanedValues[this.primaryFieldName]) !== null && _a !== void 0 ? _a : this.db.generateId() });
-                const toSave = normalizeSchemaValues(this.databaseSchema, 
-                //@ts-ignore
-                databaseRecord, { shouldCreateEntityInstances: false });
+                const toSave = this.normalizeBeforeSave(cleanedValues);
                 const record = yield this.db.createOne(this.collectionName, Object.assign(Object.assign({}, toSave), valuesToMixinBeforeCreate));
-                yield ((_b = this.didCreate) === null || _b === void 0 ? void 0 : _b.call(this, record));
+                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);
                 return Object.assign(Object.assign({}, normalized), mixinValuesOnReturn);
@@ -133,6 +120,25 @@ export default class AbstractStore extends AbstractMutexer {
             }
         });
     }
+    normalizeBeforeSave(cleanedValues) {
+        var _a, _b, _c, _d;
+        const shouldAutoGenerateId = (_b = (_a = this.db).getShouldAutoGenerateId) === null || _b === void 0 ? void 0 : _b.call(_a);
+        const databaseRecord = !shouldAutoGenerateId
+            ? cleanedValues
+            : Object.assign(Object.assign({}, cleanedValues), { [this.primaryFieldName]: 
+                //@ts-ignore
+                (_c = cleanedValues[this.primaryFieldName]) !== null && _c !== void 0 ? _c : this.db.generateId() });
+        const fields = shouldAutoGenerateId
+            ? undefined
+            : Object.keys(dropFields((_d = this.databaseSchema.fields) !== null && _d !== void 0 ? _d : {}, this.primaryFieldNames));
+        const toSave = normalizeSchemaValues(this.databaseSchema, 
+        //@ts-ignore
+        databaseRecord, {
+            shouldCreateEntityInstances: false,
+            fields,
+        });
+        return toSave;
+    }
     handleWillCreatePlugins(values) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {

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

@@ -13,6 +13,7 @@ export interface Database {
     generateId(): string;
     connect(): Promise<void>;
     close(): Promise<void>;
+    getShouldAutoGenerateId?(): boolean;
     createOne(collection: string, values: Record<string, any>): Promise<Record<string, any>>;
     create(collection: string, values: Record<string, any>[]): Promise<Record<string, any>[]>;
     dropCollection(name: string): Promise<void>;

package/build/factories/StoreFactory.d.ts

@@ -10,11 +10,6 @@ export default class StoreFactory {
     private stores;
     private constructor();
     static Factory(db: Database): StoreFactory;
-    /**
-     * @deprecated stores.Store(..) -> stores.getStore(...)
-     * This change has big speed improvements. This factory method
-     * will never be removed, but hopefully won't be needed often.
-     */
     Store<Name extends StoreName, Options extends StoreOptions<Name>>(name: Name, options?: Options): Promise<StoreMap[Name]>;
     getStoreNames(): StoreName[];
     setStoreClass(name: string, Class: StoreContructor): void;

package/build/factories/StoreFactory.js

@@ -14,11 +14,6 @@ class StoreFactory {
     static Factory(db) {
         return new this(db);
     }
-    /**
-     * @deprecated stores.Store(..) -> stores.getStore(...)
-     * This change has big speed improvements. This factory method
-     * will never be removed, but hopefully won't be needed often.
-     */
     async Store(name, options) {
         var _a;
         const Store = this.storeMap[name];

package/build/stores/AbstractStore.d.ts

@@ -4,7 +4,7 @@ import AbstractMutexer from '../mutexers/AbstractMutexer';
 import { Database } from '../types/database.types';
 import { QueryBuilder, QueryOptions } from '../types/query.types';
 import { PrepareOptions, PrepareResults, SaveOperations, DataStore, DataStorePlugin } 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>, 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, PrimaryFieldName extends SchemaFieldNames<DatabaseSchema> | 'id' = 'id', 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;
@@ -13,12 +13,12 @@ export default abstract class AbstractStore<FullSchema extends Schema, CreateSch
     protected abstract databaseSchema: DatabaseSchema;
     protected scrambleFields?: string[];
     protected db: Database;
-    protected primaryFieldNames: string[];
+    protected primaryFieldNames: PrimaryFieldName[];
     protected shouldMapLowerCaseToCamelCase: boolean;
     protected plugins: DataStorePlugin[];
     initialize?(): Promise<void>;
     protected prepareRecord?<IncludePrivateFields extends boolean, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>>(record: DatabaseRecord, options?: PrepareOptions<IncludePrivateFields, FullSchema, F>): Promise<PrepareResults<FullSchema, IncludePrivateFields>>;
-    protected willCreate?(values: CreateRecord): Promise<Omit<DatabaseRecord, 'id'>>;
+    protected willCreate?(values: CreateRecord): Promise<Omit<DatabaseRecord, PrimaryFieldName>>;
     protected didCreate?(values: CreateRecord): Promise<void>;
     protected willUpdate?(updates: UpdateRecord, record: DatabaseRecord): Promise<Partial<DatabaseRecord>>;
     protected didUpdate?(old: DatabaseRecord, updated: DatabaseRecord): Promise<void>;
@@ -33,6 +33,7 @@ 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 normalizeBeforeSave;
     private handleWillCreatePlugins;
     private handleDidCreateForPlugins;
     private get primaryFieldName();

package/build/stores/AbstractStore.js

@@ -93,15 +93,7 @@ class AbstractStore extends AbstractMutexer_1.default {
             //@ts-ignore
             values.forEach((v) => (0, schema_1.validateSchemaValues)(this.createSchema, v));
             const cleanedValues = await Promise.all(values.map(async (v) => (this.willCreate ? this.willCreate(v) : v)));
-            const databaseRecords = cleanedValues.map((v) => {
-                var _a;
-                return (Object.assign(Object.assign({}, v), { [this.primaryFieldName]: 
-                    //@ts-ignore
-                    (_a = v[this.primaryFieldName]) !== null && _a !== void 0 ? _a : this.db.generateId() }));
-            });
-            const toSave = databaseRecords.map((r) => (0, schema_1.normalizeSchemaValues)(this.databaseSchema, 
-            //@ts-ignore
-            r, { shouldCreateEntityInstances: false }));
+            const toSave = cleanedValues.map((v) => this.normalizeBeforeSave(v));
             const records = await this.db.create(this.collectionName, toSave);
             return Promise.all(records.map(async (record) => this.prepareAndNormalizeRecord(record, options)));
         }
@@ -116,7 +108,7 @@ class AbstractStore extends AbstractMutexer_1.default {
         }
     }
     async createOne(values, options) {
-        var _a, _b;
+        var _a;
         try {
             let valuesToMixinBeforeCreate = await this.handleWillCreatePlugins(values);
             //@ts-ignore
@@ -124,14 +116,9 @@ class AbstractStore extends AbstractMutexer_1.default {
             const cleanedValues = this.willCreate
                 ? await this.willCreate(values)
                 : values;
-            const databaseRecord = Object.assign(Object.assign({}, cleanedValues), { [this.primaryFieldName]: 
-                //@ts-ignore
-                (_a = cleanedValues[this.primaryFieldName]) !== null && _a !== void 0 ? _a : this.db.generateId() });
-            const toSave = (0, schema_1.normalizeSchemaValues)(this.databaseSchema, 
-            //@ts-ignore
-            databaseRecord, { shouldCreateEntityInstances: false });
+            const toSave = this.normalizeBeforeSave(cleanedValues);
             const record = await this.db.createOne(this.collectionName, Object.assign(Object.assign({}, toSave), valuesToMixinBeforeCreate));
-            await ((_b = this.didCreate) === null || _b === void 0 ? void 0 : _b.call(this, record));
+            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);
             return Object.assign(Object.assign({}, normalized), mixinValuesOnReturn);
@@ -146,6 +133,25 @@ class AbstractStore extends AbstractMutexer_1.default {
             throw coded[0];
         }
     }
+    normalizeBeforeSave(cleanedValues) {
+        var _a, _b, _c, _d;
+        const shouldAutoGenerateId = (_b = (_a = this.db).getShouldAutoGenerateId) === null || _b === void 0 ? void 0 : _b.call(_a);
+        const databaseRecord = !shouldAutoGenerateId
+            ? cleanedValues
+            : Object.assign(Object.assign({}, cleanedValues), { [this.primaryFieldName]: 
+                //@ts-ignore
+                (_c = cleanedValues[this.primaryFieldName]) !== null && _c !== void 0 ? _c : this.db.generateId() });
+        const fields = shouldAutoGenerateId
+            ? undefined
+            : Object.keys((0, schema_1.dropFields)((_d = this.databaseSchema.fields) !== null && _d !== void 0 ? _d : {}, this.primaryFieldNames));
+        const toSave = (0, schema_1.normalizeSchemaValues)(this.databaseSchema, 
+        //@ts-ignore
+        databaseRecord, {
+            shouldCreateEntityInstances: false,
+            fields,
+        });
+        return toSave;
+    }
     async handleWillCreatePlugins(values) {
         var _a;
         let valuesToMixinBeforeCreate = {};

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

@@ -13,6 +13,7 @@ export interface Database {
     generateId(): string;
     connect(): Promise<void>;
     close(): Promise<void>;
+    getShouldAutoGenerateId?(): boolean;
     createOne(collection: string, values: Record<string, any>): Promise<Record<string, any>>;
     create(collection: string, values: Record<string, any>[]): Promise<Record<string, any>[]>;
     dropCollection(name: string): Promise<void>;

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "25.13.14",
+  "version": "26.0.1",
   "files": [
     "build/**/*",
     "!build/__tests__",
@@ -78,7 +78,7 @@
     "nedb": "^1.8.0"
   },
   "devDependencies": {
-    "@sprucelabs/esm-postbuild": "^5.0.102",
+    "@sprucelabs/esm-postbuild": "^5.0.103",
     "@sprucelabs/jest-json-reporter": "^7.0.128",
     "@sprucelabs/jest-sheets-reporter": "^3.0.26",
     "@sprucelabs/resolve-path-aliases": "^1.1.266",
@@ -87,11 +87,11 @@
     "@sprucelabs/test-utils": "^4.0.81",
     "@types/lodash": "^4.14.202",
     "@types/nedb": "^1.8.16",
-    "@types/node": "^20.10.0",
+    "@types/node": "^20.10.3",
     "chokidar-cli": "^3.0.0",
     "concurrently": "^8.2.2",
     "dotenv": "^16.3.1",
-    "eslint": "^8.54.0",
+    "eslint": "^8.55.0",
     "eslint-config-spruce": "^10.13.6",
     "jest": "^29.7.0",
     "jest-circus": "^29.7.0",