@sprucelabs/data-stores 26.2.8 → 26.3.0

package/build/.spruce/errors/dataStores/queryNotFaked.schema.d.ts

@@ -0,0 +1,3 @@
+import { SpruceErrors } from '../errors.types';
+declare const queryNotFakedSchema: SpruceErrors.DataStores.QueryNotFakedSchema;
+export default queryNotFakedSchema;

package/build/.spruce/errors/dataStores/queryNotFaked.schema.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const schema_1 = require("@sprucelabs/schema");
+const queryNotFakedSchema = {
+    id: 'queryNotFaked',
+    namespace: 'DataStores',
+    name: 'Query not faked',
+    fields: {
+        /** . */
+        'query': {
+            type: 'text',
+            isRequired: true,
+            options: undefined
+        },
+        /** . */
+        'params': {
+            type: 'raw',
+            options: { valueType: `Record<string, any>`, }
+        },
+    }
+};
+schema_1.SchemaRegistry.getInstance().trackSchema(queryNotFakedSchema);
+exports.default = queryNotFakedSchema;

package/build/.spruce/errors/errors.types.d.ts

@@ -134,6 +134,33 @@ export declare namespace SpruceErrors.DataStores {
     }
     type RecordNotFoundEntity = SchemaEntity<SpruceErrors.DataStores.RecordNotFoundSchema>;
 }
+export declare namespace SpruceErrors.DataStores {
+    interface QueryNotFaked {
+        'query': string;
+        'params'?: (Record<string, any>) | undefined | null;
+    }
+    interface QueryNotFakedSchema extends SpruceSchema.Schema {
+        id: 'queryNotFaked';
+        namespace: 'DataStores';
+        name: 'Query not faked';
+        fields: {
+            /** . */
+            'query': {
+                type: 'text';
+                isRequired: true;
+                options: undefined;
+            };
+            /** . */
+            'params': {
+                type: 'raw';
+                options: {
+                    valueType: `Record<string, any>`;
+                };
+            };
+        };
+    }
+    type QueryNotFakedEntity = SchemaEntity<SpruceErrors.DataStores.QueryNotFakedSchema>;
+}
 export declare namespace SpruceErrors.DataStores {
     interface NotImplemented {
     }

package/build/.spruce/errors/options.types.d.ts

@@ -18,6 +18,9 @@ export interface ScrambleNotConfiguredErrorOptions extends SpruceErrors.DataStor
 export interface RecordNotFoundErrorOptions extends SpruceErrors.DataStores.RecordNotFound, ISpruceErrorOptions {
     code: 'RECORD_NOT_FOUND';
 }
+export interface QueryNotFakedErrorOptions extends SpruceErrors.DataStores.QueryNotFaked, ISpruceErrorOptions {
+    code: 'QUERY_NOT_FAKED';
+}
 export interface NotImplementedErrorOptions extends SpruceErrors.DataStores.NotImplemented, ISpruceErrorOptions {
     code: 'NOT_IMPLEMENTED';
 }
@@ -60,5 +63,5 @@ export interface DuplicateKeyErrorOptions extends SpruceErrors.DataStores.Duplic
 export interface DatabaseNotConnectedErrorOptions extends SpruceErrors.DataStores.DatabaseNotConnected, ISpruceErrorOptions {
     code: 'DATABASE_NOT_CONNECTED';
 }
-type ErrorOptions = UnknownStoreErrorErrorOptions | UnknownErrorErrorOptions | UnknownDatabaseErrorErrorOptions | UnableToConnectToDbErrorOptions | ScrambleNotConfiguredErrorOptions | RecordNotFoundErrorOptions | NotImplementedErrorOptions | MongoIdMappingErrorErrorOptions | InvalidStoreNameErrorOptions | InvalidStoreErrorOptions | InvalidDbConnectionStringErrorOptions | InvalidDatabaseNameErrorOptions | InvalidConnectionStringSchemeErrorOptions | IndexNotFoundErrorOptions | IndexExistsErrorOptions | FailedToLoadStoresErrorOptions | FailedToLoadStoreErrorOptions | DuplicateRecordErrorOptions | DuplicateKeyErrorOptions | DatabaseNotConnectedErrorOptions;
+type ErrorOptions = UnknownStoreErrorErrorOptions | UnknownErrorErrorOptions | UnknownDatabaseErrorErrorOptions | UnableToConnectToDbErrorOptions | ScrambleNotConfiguredErrorOptions | RecordNotFoundErrorOptions | QueryNotFakedErrorOptions | NotImplementedErrorOptions | MongoIdMappingErrorErrorOptions | InvalidStoreNameErrorOptions | InvalidStoreErrorOptions | InvalidDbConnectionStringErrorOptions | InvalidDatabaseNameErrorOptions | InvalidConnectionStringSchemeErrorOptions | IndexNotFoundErrorOptions | IndexExistsErrorOptions | FailedToLoadStoresErrorOptions | FailedToLoadStoreErrorOptions | DuplicateRecordErrorOptions | DuplicateKeyErrorOptions | DatabaseNotConnectedErrorOptions;
 export default ErrorOptions;

package/build/databases/MongoDatabase.js

@@ -444,6 +444,7 @@ class MongoDatabase {
     async query() {
         throw new SpruceError_1.default({
             code: 'NOT_IMPLEMENTED',
+            friendlyMessage: `You cannot run a query using mongodb. Try a different database adapter!`,
         });
     }
 }

package/build/databases/NeDbDatabase.d.ts

@@ -4,6 +4,7 @@ import { QueryOptions } from '../types/query.types';
 export default class NeDbDatabase extends AbstractMutexer implements Database {
     private collections;
     private _isConnected;
+    private fakedQueries;
     generateId(): string;
     connect(): Promise<void>;
     close(): Promise<void>;
@@ -39,5 +40,7 @@ export default class NeDbDatabase extends AbstractMutexer implements Database {
     createIndex(collection: string, fields: string[]): Promise<void>;
     syncUniqueIndexes(collectionName: string, indexes: string[][]): Promise<void>;
     syncIndexes(collectionName: string, indexes: string[][]): Promise<void>;
-    query<T>(): Promise<T>;
+    query<T>(query: string, params?: Record<string, any>): Promise<T>;
+    fakeQuery<T>(query: string, cb: FakeQueryHandler<T>): void;
 }
+export type FakeQueryHandler<T> = (params?: Record<string, any>) => Promise<T> | T;

package/build/databases/NeDbDatabase.js

@@ -36,6 +36,7 @@ class NeDbDatabase extends AbstractMutexer_1.default {
         super(...arguments);
         this.collections = {};
         this._isConnected = false;
+        this.fakedQueries = {};
     }
     generateId() {
         return (0, generateId_1.default)();
@@ -458,10 +459,18 @@ class NeDbDatabase extends AbstractMutexer_1.default {
             await this.dropIndex(collectionName, extra);
         }
     }
-    async query() {
+    async query(query, params) {
+        const cb = this.fakedQueries[query];
+        if (cb) {
+            return cb(params);
+        }
         throw new SpruceError_1.default({
-            code: 'NOT_IMPLEMENTED',
+            code: 'QUERY_NOT_FAKED',
+            query,
         });
     }
+    fakeQuery(query, cb) {
+        this.fakedQueries[query] = cb;
+    }
 }
 exports.default = NeDbDatabase;

package/build/errors/SpruceError.js

@@ -102,6 +102,9 @@ If you are on a mac, using brew is recommended: https://brew.sh`;
             case 'NOT_IMPLEMENTED':
                 message = 'A Not implemented just happened!';
                 break;
+            case 'QUERY_NOT_FAKED':
+                message = `The query '${options.query}' was not faked. Try this.stores.fakeQuery(...).`;
+                break;
             default:
                 message = super.friendlyMessage();
         }

package/build/errors/queryNotFaked.builder.d.ts

@@ -0,0 +1,17 @@
+declare const _default: {
+    id: string;
+    name: string;
+    fields: {
+        query: {
+            type: "text";
+            isRequired: true;
+        };
+        params: {
+            type: "raw";
+            options: {
+                valueType: string;
+            };
+        };
+    };
+};
+export default _default;

package/build/errors/queryNotFaked.builder.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const schema_1 = require("@sprucelabs/schema");
+exports.default = (0, schema_1.buildErrorSchema)({
+    id: 'queryNotFaked',
+    name: 'Query not faked',
+    fields: {
+        query: {
+            type: 'text',
+            isRequired: true,
+        },
+        params: {
+            type: 'raw',
+            options: { valueType: 'Record<string, any>' },
+        },
+    },
+});

package/build/esm/.spruce/errors/errors.types.d.ts

@@ -134,6 +134,33 @@ export declare namespace SpruceErrors.DataStores {
     }
     type RecordNotFoundEntity = SchemaEntity<SpruceErrors.DataStores.RecordNotFoundSchema>;
 }
+export declare namespace SpruceErrors.DataStores {
+    interface QueryNotFaked {
+        'query': string;
+        'params'?: (Record<string, any>) | undefined | null;
+    }
+    interface QueryNotFakedSchema extends SpruceSchema.Schema {
+        id: 'queryNotFaked';
+        namespace: 'DataStores';
+        name: 'Query not faked';
+        fields: {
+            /** . */
+            'query': {
+                type: 'text';
+                isRequired: true;
+                options: undefined;
+            };
+            /** . */
+            'params': {
+                type: 'raw';
+                options: {
+                    valueType: `Record<string, any>`;
+                };
+            };
+        };
+    }
+    type QueryNotFakedEntity = SchemaEntity<SpruceErrors.DataStores.QueryNotFakedSchema>;
+}
 export declare namespace SpruceErrors.DataStores {
     interface NotImplemented {
     }

package/build/esm/.spruce/errors/options.types.d.ts

@@ -18,6 +18,9 @@ export interface ScrambleNotConfiguredErrorOptions extends SpruceErrors.DataStor
 export interface RecordNotFoundErrorOptions extends SpruceErrors.DataStores.RecordNotFound, ISpruceErrorOptions {
     code: 'RECORD_NOT_FOUND';
 }
+export interface QueryNotFakedErrorOptions extends SpruceErrors.DataStores.QueryNotFaked, ISpruceErrorOptions {
+    code: 'QUERY_NOT_FAKED';
+}
 export interface NotImplementedErrorOptions extends SpruceErrors.DataStores.NotImplemented, ISpruceErrorOptions {
     code: 'NOT_IMPLEMENTED';
 }
@@ -60,5 +63,5 @@ export interface DuplicateKeyErrorOptions extends SpruceErrors.DataStores.Duplic
 export interface DatabaseNotConnectedErrorOptions extends SpruceErrors.DataStores.DatabaseNotConnected, ISpruceErrorOptions {
     code: 'DATABASE_NOT_CONNECTED';
 }
-type ErrorOptions = UnknownStoreErrorErrorOptions | UnknownErrorErrorOptions | UnknownDatabaseErrorErrorOptions | UnableToConnectToDbErrorOptions | ScrambleNotConfiguredErrorOptions | RecordNotFoundErrorOptions | NotImplementedErrorOptions | MongoIdMappingErrorErrorOptions | InvalidStoreNameErrorOptions | InvalidStoreErrorOptions | InvalidDbConnectionStringErrorOptions | InvalidDatabaseNameErrorOptions | InvalidConnectionStringSchemeErrorOptions | IndexNotFoundErrorOptions | IndexExistsErrorOptions | FailedToLoadStoresErrorOptions | FailedToLoadStoreErrorOptions | DuplicateRecordErrorOptions | DuplicateKeyErrorOptions | DatabaseNotConnectedErrorOptions;
+type ErrorOptions = UnknownStoreErrorErrorOptions | UnknownErrorErrorOptions | UnknownDatabaseErrorErrorOptions | UnableToConnectToDbErrorOptions | ScrambleNotConfiguredErrorOptions | RecordNotFoundErrorOptions | QueryNotFakedErrorOptions | NotImplementedErrorOptions | MongoIdMappingErrorErrorOptions | InvalidStoreNameErrorOptions | InvalidStoreErrorOptions | InvalidDbConnectionStringErrorOptions | InvalidDatabaseNameErrorOptions | InvalidConnectionStringSchemeErrorOptions | IndexNotFoundErrorOptions | IndexExistsErrorOptions | FailedToLoadStoresErrorOptions | FailedToLoadStoreErrorOptions | DuplicateRecordErrorOptions | DuplicateKeyErrorOptions | DatabaseNotConnectedErrorOptions;
 export default ErrorOptions;

package/build/esm/databases/MongoDatabase.js

@@ -490,6 +490,7 @@ export default class MongoDatabase {
         return __awaiter(this, void 0, void 0, function* () {
             throw new SpruceError({
                 code: 'NOT_IMPLEMENTED',
+                friendlyMessage: `You cannot run a query using mongodb. Try a different database adapter!`,
             });
         });
     }

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

@@ -4,6 +4,7 @@ import { QueryOptions } from '../types/query.types';
 export default class NeDbDatabase extends AbstractMutexer implements Database {
     private collections;
     private _isConnected;
+    private fakedQueries;
     generateId(): string;
     connect(): Promise<void>;
     close(): Promise<void>;
@@ -39,5 +40,7 @@ export default class NeDbDatabase extends AbstractMutexer implements Database {
     createIndex(collection: string, fields: string[]): Promise<void>;
     syncUniqueIndexes(collectionName: string, indexes: string[][]): Promise<void>;
     syncIndexes(collectionName: string, indexes: string[][]): Promise<void>;
-    query<T>(): Promise<T>;
+    query<T>(query: string, params?: Record<string, any>): Promise<T>;
+    fakeQuery<T>(query: string, cb: FakeQueryHandler<T>): void;
 }
+export type FakeQueryHandler<T> = (params?: Record<string, any>) => Promise<T> | T;

package/build/esm/databases/NeDbDatabase.js

@@ -40,6 +40,7 @@ export default class NeDbDatabase extends AbstractMutexer {
         super(...arguments);
         this.collections = {};
         this._isConnected = false;
+        this.fakedQueries = {};
     }
     generateId() {
         return generateId();
@@ -508,11 +509,19 @@ export default class NeDbDatabase extends AbstractMutexer {
             }
         });
     }
-    query() {
+    query(query, params) {
         return __awaiter(this, void 0, void 0, function* () {
+            const cb = this.fakedQueries[query];
+            if (cb) {
+                return cb(params);
+            }
             throw new SpruceError({
-                code: 'NOT_IMPLEMENTED',
+                code: 'QUERY_NOT_FAKED',
+                query,
             });
         });
     }
+    fakeQuery(query, cb) {
+        this.fakedQueries[query] = cb;
+    }
 }

package/build/esm/errors/SpruceError.js

@@ -97,6 +97,9 @@ If you are on a mac, using brew is recommended: https://brew.sh`;
             case 'NOT_IMPLEMENTED':
                 message = 'A Not implemented just happened!';
                 break;
+            case 'QUERY_NOT_FAKED':
+                message = `The query '${options.query}' was not faked. Try this.stores.fakeQuery(...).`;
+                break;
             default:
                 message = super.friendlyMessage();
         }

package/build/esm/errors/queryNotFaked.builder.d.ts

@@ -0,0 +1,17 @@
+declare const _default: {
+    id: string;
+    name: string;
+    fields: {
+        query: {
+            type: "text";
+            isRequired: true;
+        };
+        params: {
+            type: "raw";
+            options: {
+                valueType: string;
+            };
+        };
+    };
+};
+export default _default;

package/build/esm/errors/queryNotFaked.builder.js

@@ -0,0 +1,15 @@
+import { buildErrorSchema } from '@sprucelabs/schema';
+export default buildErrorSchema({
+    id: 'queryNotFaked',
+    name: 'Query not faked',
+    fields: {
+        query: {
+            type: 'text',
+            isRequired: true,
+        },
+        params: {
+            type: 'raw',
+            options: { valueType: 'Record<string, any>' },
+        },
+    },
+});

package/build/esm/stores/AbstractStore.js

@@ -46,7 +46,7 @@ export default class AbstractStore extends AbstractMutexer {
         return this.collectionName;
     }
     prepareAndNormalizeRecord(record, options = {}) {
-        var _a, _b;
+        var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
             let preparedRecord = this.prepareRecord
                 ? yield this.prepareRecord(record, options)
@@ -62,7 +62,7 @@ export default class AbstractStore extends AbstractMutexer {
             if (this.shouldMapLowerCaseToCamelCase) {
                 this.mapCasing(preparedRecord);
             }
-            return normalizeSchemaValues(this.fullSchema, preparedRecord, Object.assign(Object.assign({}, options), { fields: options.includeFields, shouldIncludePrivateFields: options.shouldIncludePrivateFields === true, shouldCreateEntityInstances: false, shouldIncludeNullAndUndefinedFields: false }));
+            return normalizeSchemaValues(this.fullSchema, preparedRecord, Object.assign(Object.assign({}, options), { fields: options.includeFields, shouldIncludePrivateFields: options.shouldIncludePrivateFields === true, shouldCreateEntityInstances: false, shouldIncludeNullAndUndefinedFields: !((_c = options.shouldStripUndefinedAndNullValues) !== null && _c !== void 0 ? _c : true) }));
         });
     }
     mapCasing(preparedRecord) {
@@ -241,7 +241,10 @@ export default class AbstractStore extends AbstractMutexer {
                 primaryFieldNames: this.primaryFieldNames,
             });
             if (results) {
-                const all = results.map((result) => this.prepareAndNormalizeRecord(result, Object.assign(Object.assign({}, options), { shouldStripUndefinedAndNullValues: true })));
+                const all = results.map((result) => {
+                    var _a;
+                    return this.prepareAndNormalizeRecord(result, Object.assign(Object.assign({}, options), { shouldStripUndefinedAndNullValues: (_a = options === null || options === void 0 ? void 0 : options.shouldStripUndefinedAndNullValues) !== null && _a !== void 0 ? _a : true }));
+                });
                 const records = yield Promise.all(all);
                 return records;
             }

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

@@ -26,7 +26,7 @@ export interface Database {
     count(collection: string, query?: Record<string, any>): Promise<number>;
     createUniqueIndex(collection: string, fields: UniqueIndex): Promise<void>;
     createIndex(collection: string, fields: Index): Promise<void>;
-    query<T>(query: string): Promise<T>;
+    query<T>(query: string, params?: Record<string, any>): Promise<T>;
 }
 export interface DatabaseOptions {
     dbName?: string;

package/build/stores/AbstractStore.js

@@ -65,7 +65,7 @@ class AbstractStore extends AbstractMutexer_1.default {
         return this.collectionName;
     }
     async prepareAndNormalizeRecord(record, options = {}) {
-        var _a, _b;
+        var _a, _b, _c;
         let preparedRecord = this.prepareRecord
             ? await this.prepareRecord(record, options)
             : record;
@@ -80,7 +80,7 @@ class AbstractStore extends AbstractMutexer_1.default {
         if (this.shouldMapLowerCaseToCamelCase) {
             this.mapCasing(preparedRecord);
         }
-        return (0, schema_1.normalizeSchemaValues)(this.fullSchema, preparedRecord, Object.assign(Object.assign({}, options), { fields: options.includeFields, shouldIncludePrivateFields: options.shouldIncludePrivateFields === true, shouldCreateEntityInstances: false, shouldIncludeNullAndUndefinedFields: false }));
+        return (0, schema_1.normalizeSchemaValues)(this.fullSchema, preparedRecord, Object.assign(Object.assign({}, options), { fields: options.includeFields, shouldIncludePrivateFields: options.shouldIncludePrivateFields === true, shouldCreateEntityInstances: false, shouldIncludeNullAndUndefinedFields: !((_c = options.shouldStripUndefinedAndNullValues) !== null && _c !== void 0 ? _c : true) }));
     }
     mapCasing(preparedRecord) {
         var _a;
@@ -239,7 +239,10 @@ class AbstractStore extends AbstractMutexer_1.default {
             primaryFieldNames: this.primaryFieldNames,
         });
         if (results) {
-            const all = results.map((result) => this.prepareAndNormalizeRecord(result, Object.assign(Object.assign({}, options), { shouldStripUndefinedAndNullValues: true })));
+            const all = results.map((result) => {
+                var _a;
+                return this.prepareAndNormalizeRecord(result, Object.assign(Object.assign({}, options), { shouldStripUndefinedAndNullValues: (_a = options === null || options === void 0 ? void 0 : options.shouldStripUndefinedAndNullValues) !== null && _a !== void 0 ? _a : true }));
+            });
             const records = await Promise.all(all);
             return records;
         }

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

@@ -26,7 +26,7 @@ export interface Database {
     count(collection: string, query?: Record<string, any>): Promise<number>;
     createUniqueIndex(collection: string, fields: UniqueIndex): Promise<void>;
     createIndex(collection: string, fields: Index): Promise<void>;
-    query<T>(query: string): Promise<T>;
+    query<T>(query: string, params?: Record<string, any>): Promise<T>;
 }
 export interface DatabaseOptions {
     dbName?: string;

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "26.2.8",
+  "version": "26.3.0",
   "files": [
     "build/**/*",
     "!build/__tests__",
@@ -68,7 +68,7 @@
     "upgrade.packages.test": "yarn upgrade.packages.all && yarn lint && yarn build.dev && yarn test"
   },
   "dependencies": {
-    "@sprucelabs/error": "^5.1.52",
+    "@sprucelabs/error": "^5.1.53",
     "@sprucelabs/globby": "^1.0.3",
     "@sprucelabs/schema": "^29.3.0",
     "@sprucelabs/spruce-skill-utils": "^30.1.44",
@@ -78,10 +78,10 @@
     "nedb": "^1.8.0"
   },
   "devDependencies": {
-    "@sprucelabs/esm-postbuild": "^5.0.108",
-    "@sprucelabs/jest-json-reporter": "^7.0.133",
+    "@sprucelabs/esm-postbuild": "^5.0.109",
+    "@sprucelabs/jest-json-reporter": "^7.0.134",
     "@sprucelabs/jest-sheets-reporter": "^3.0.26",
-    "@sprucelabs/resolve-path-aliases": "^1.1.270",
+    "@sprucelabs/resolve-path-aliases": "^1.1.271",
     "@sprucelabs/semantic-release": "^4.0.8",
     "@sprucelabs/test": "^8.0.35",
     "@sprucelabs/test-utils": "^4.0.86",
@@ -95,7 +95,7 @@
     "eslint-config-spruce": "^10.13.6",
     "jest": "^29.7.0",
     "jest-circus": "^29.7.0",
-    "prettier": "^3.1.0",
+    "prettier": "^3.1.1",
     "ts-node": "^10.9.2",
     "tsc-watch": "^6.0.4",
     "tsconfig-paths": "^4.2.0",