@sprucelabs/data-stores 28.3.232 → 28.3.234

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

@@ -2,7 +2,7 @@ import { Schema, SchemaFieldNames, SchemaPartialValues, SchemaPublicFieldNames,
 import { FindBatchOptions } from '../cursors/BatchCursor';
 import AbstractMutexer from '../mutexers/AbstractMutexer';
 import { Database } from '../types/database.types';
-import { QueryBuilder, QueryOptions } from '../types/query.types';
+import { QueryBuilder, QueryOptions, ValuesWithPaths } 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, 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;
@@ -49,7 +49,7 @@ export default abstract class AbstractStore<FullSchema extends Schema, CreateSch
     upsertOne<IncludePrivateFields extends boolean = true, CreateEntityInstances extends boolean = false, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>, PF extends SchemaPublicFieldNames<FullSchema> = SchemaPublicFieldNames<FullSchema>>(query: QueryBuilder<QueryRecord>, updates: UpdateRecord & CreateRecord & {
         id?: string;
     }, options?: PrepareOptions<IncludePrivateFields, FullSchema, F>): Promise<Response<FullSchema, CreateEntityInstances, IncludePrivateFields, PF, F>>;
-    updateOne<IncludePrivateFields extends boolean = false, CreateEntityInstances extends boolean = false, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>, PF extends SchemaPublicFieldNames<FullSchema> = SchemaPublicFieldNames<FullSchema>>(query: QueryBuilder<QueryRecord>, updates: UpdateRecord, options?: PrepareOptions<IncludePrivateFields, FullSchema, F>): Promise<Response<FullSchema, CreateEntityInstances, IncludePrivateFields, PF, F>>;
+    updateOne<IncludePrivateFields extends boolean = false, CreateEntityInstances extends boolean = false, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>, PF extends SchemaPublicFieldNames<FullSchema> = SchemaPublicFieldNames<FullSchema>>(query: QueryBuilder<QueryRecord>, updates: ValuesWithPaths<UpdateRecord>, options?: PrepareOptions<IncludePrivateFields, FullSchema, F>): Promise<Response<FullSchema, CreateEntityInstances, IncludePrivateFields, PF, F>>;
     update(query: QueryBuilder<QueryRecord>, updates: UpdateRecord): Promise<number>;
     private findOneAndUpdate;
     private handleWillUpdateOnePlugins;

package/build/esm/stores/AbstractStore.js

@@ -351,6 +351,7 @@ export default class AbstractStore extends AbstractMutexer {
                     ? databaseRecord
                     : normalizeSchemaValues(this.databaseSchema, databaseRecord, {
                         shouldCreateEntityInstances: false,
+                        shouldRetainDotSyntaxKeys: true,
                         fields: Object.keys(cleanedUpdates),
                     });
                 for (const { name, value } of ops) {

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

@@ -85,6 +85,8 @@ declare const databaseAssertUtil: {
     _assertThrowsExpectedNotFoundOnUpdateOne(db: Database, query: Record<string, any>): Promise<void>;
     _assert$orReturnsExpectedTotalRecords(db: Database, $or: Record<string, any>[], expected: number): Promise<void>;
     _assertCanCreateMultiFieldIndex(connect: TestConnect, fields: string[]): Promise<void>;
+    canUpdateNestedField(connect: TestConnect): Promise<void>;
+    canUpsertNestedField(connect: TestConnect): Promise<void>;
     assertHasLowerCaseToCamelCaseMappingEnabled(store: DataStore): void;
 };
 export default databaseAssertUtil;

package/build/esm/tests/databaseAssertUtil.js

@@ -1958,6 +1958,53 @@ const databaseAssertUtil = {
             yield this.shutdown(db);
         });
     },
+    canUpdateNestedField(connect) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const db = yield connectToDabatase(connect);
+            const locationId = generateId();
+            const values = {
+                name: 'first',
+                target: {
+                    organizationId: generateId(),
+                    locationId,
+                },
+            };
+            yield db.createOne(this.collectionName, values);
+            const newOrganizationId = generateId();
+            const updated = yield db.updateOne(this.collectionName, {}, {
+                'target.organizationId': newOrganizationId,
+            });
+            assert.isEqual(updated.target.organizationId, newOrganizationId, 'Could not update nested field target.organizationId using key "target.organizationId"');
+            const match = yield db.findOne(this.collectionName, { id: updated.id });
+            assert.isEqualDeep(match.target, {
+                organizationId: newOrganizationId,
+                locationId,
+            }, `Updating nested field lost existing key 'target.locationId'`);
+            yield this.shutdown(db);
+        });
+    },
+    canUpsertNestedField(connect) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const db = yield connectToDabatase(connect);
+            const locationId = generateId();
+            const values = {
+                name: 'first',
+                target: {
+                    organizationId: generateId(),
+                    locationId,
+                },
+            };
+            const record = yield db.createOne(this.collectionName, values);
+            const newOrganizationId = generateId();
+            yield db.upsertOne(this.collectionName, { id: record.id }, {
+                'target.organizationId': newOrganizationId,
+            });
+            const match = yield db.findOne(this.collectionName, { id: record.id });
+            assert.isEqual(match.target.organizationId, newOrganizationId, 'Could not find updated record with key "target.organizationId" set');
+            assert.isEqual(match.target.locationId, locationId, `Upserting lost existing key 'target.locationId'`);
+            yield this.shutdown(db);
+        });
+    },
     assertHasLowerCaseToCamelCaseMappingEnabled(store) {
         assert.isTrue(
         //@ts-ignore

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

@@ -5,6 +5,21 @@ export type QueryBuilder<Query, Keys extends Paths<Query> = Paths<Query>> = {
 } & {
     id?: string | QuerySelector<string>;
 } & RootQuerySelector<Query>;
+export type ValuesWithPaths<Values, Keys extends Paths<Values> = Paths<Values>> = {
+    [K in RequiredKeys<Values, Keys>]: TypeAtPath<Values, K>;
+} & {
+    [K in OptionalKeys<Values, Keys>]?: TypeAtPath<Values, K>;
+};
+type IsOptional<T, K extends keyof T> = {} extends Pick<T, K> ? true : false;
+type IsPathOptional<T, P extends string> = P extends `${infer K}.${infer Rest}` ? K extends keyof T ? IsOptional<T, K> extends true ? true : IsPathOptional<T[K], Rest> : true : P extends keyof T ? IsOptional<T, P> : true;
+type RequiredKeys<Values, Keys extends Paths<Values>> = {
+    [K in Keys]: IsPathOptional<Values, K> extends true ? never : K;
+}[Keys];
+type OptionalKeys<Values, Keys extends Paths<Values>> = Exclude<Keys, RequiredKeys<Values, Keys>>;
+type Paths<T, D extends number = 3> = [D] extends [never] ? never : T extends object ? {
+    [K in keyof T]-?: K extends string | number ? `${K}` | Join<K, Paths<T[K], Prev[D]>> : never;
+}[keyof T] : '';
+type TypeAtPath<T, P extends string> = P extends `${infer K}.${infer Rest}` ? K extends keyof T ? TypeAtPath<T[K], Rest> : any : P extends keyof T ? T[P] : any;
 export interface QuerySortField {
     field: string;
     direction: 'asc' | 'desc';
@@ -44,8 +59,4 @@ type Prev = [
     20,
     ...0[]
 ];
-type Paths<T, D extends number = 3> = [D] extends [never] ? never : T extends object ? {
-    [K in keyof T]-?: K extends string | number ? `${K}` | Join<K, Paths<T[K], Prev[D]>> : never;
-}[keyof T] : '';
-type TypeAtPath<T, P extends string> = P extends `${infer K}.${infer Rest}` ? K extends keyof T ? TypeAtPath<T[K], Rest> : any : P extends keyof T ? T[P] : any;
 export {};

package/build/stores/AbstractStore.d.ts

@@ -2,7 +2,7 @@ import { Schema, SchemaFieldNames, SchemaPartialValues, SchemaPublicFieldNames,
 import { FindBatchOptions } from '../cursors/BatchCursor';
 import AbstractMutexer from '../mutexers/AbstractMutexer';
 import { Database } from '../types/database.types';
-import { QueryBuilder, QueryOptions } from '../types/query.types';
+import { QueryBuilder, QueryOptions, ValuesWithPaths } 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, 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;
@@ -49,7 +49,7 @@ export default abstract class AbstractStore<FullSchema extends Schema, CreateSch
     upsertOne<IncludePrivateFields extends boolean = true, CreateEntityInstances extends boolean = false, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>, PF extends SchemaPublicFieldNames<FullSchema> = SchemaPublicFieldNames<FullSchema>>(query: QueryBuilder<QueryRecord>, updates: UpdateRecord & CreateRecord & {
         id?: string;
     }, options?: PrepareOptions<IncludePrivateFields, FullSchema, F>): Promise<Response<FullSchema, CreateEntityInstances, IncludePrivateFields, PF, F>>;
-    updateOne<IncludePrivateFields extends boolean = false, CreateEntityInstances extends boolean = false, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>, PF extends SchemaPublicFieldNames<FullSchema> = SchemaPublicFieldNames<FullSchema>>(query: QueryBuilder<QueryRecord>, updates: UpdateRecord, options?: PrepareOptions<IncludePrivateFields, FullSchema, F>): Promise<Response<FullSchema, CreateEntityInstances, IncludePrivateFields, PF, F>>;
+    updateOne<IncludePrivateFields extends boolean = false, CreateEntityInstances extends boolean = false, F extends SchemaFieldNames<FullSchema> = SchemaFieldNames<FullSchema>, PF extends SchemaPublicFieldNames<FullSchema> = SchemaPublicFieldNames<FullSchema>>(query: QueryBuilder<QueryRecord>, updates: ValuesWithPaths<UpdateRecord>, options?: PrepareOptions<IncludePrivateFields, FullSchema, F>): Promise<Response<FullSchema, CreateEntityInstances, IncludePrivateFields, PF, F>>;
     update(query: QueryBuilder<QueryRecord>, updates: UpdateRecord): Promise<number>;
     private findOneAndUpdate;
     private handleWillUpdateOnePlugins;

package/build/stores/AbstractStore.js

@@ -347,6 +347,7 @@ class AbstractStore extends AbstractMutexer_1.default {
                 ? databaseRecord
                 : (0, schema_1.normalizeSchemaValues)(this.databaseSchema, databaseRecord, {
                     shouldCreateEntityInstances: false,
+                    shouldRetainDotSyntaxKeys: true,
                     fields: Object.keys(cleanedUpdates),
                 });
             for (const { name, value } of ops) {

package/build/tests/databaseAssertUtil.d.ts

@@ -85,6 +85,8 @@ declare const databaseAssertUtil: {
     _assertThrowsExpectedNotFoundOnUpdateOne(db: Database, query: Record<string, any>): Promise<void>;
     _assert$orReturnsExpectedTotalRecords(db: Database, $or: Record<string, any>[], expected: number): Promise<void>;
     _assertCanCreateMultiFieldIndex(connect: TestConnect, fields: string[]): Promise<void>;
+    canUpdateNestedField(connect: TestConnect): Promise<void>;
+    canUpsertNestedField(connect: TestConnect): Promise<void>;
     assertHasLowerCaseToCamelCaseMappingEnabled(store: DataStore): void;
 };
 export default databaseAssertUtil;

package/build/tests/databaseAssertUtil.js

@@ -1798,6 +1798,49 @@ const databaseAssertUtil = {
         test_utils_1.assert.isEqualDeep(indexes[0].fields.map((i) => i.toLowerCase()), fields.map((f) => f.toLowerCase()));
         await this.shutdown(db);
     },
+    async canUpdateNestedField(connect) {
+        const db = await connectToDabatase(connect);
+        const locationId = (0, generateId_1.default)();
+        const values = {
+            name: 'first',
+            target: {
+                organizationId: (0, generateId_1.default)(),
+                locationId,
+            },
+        };
+        await db.createOne(this.collectionName, values);
+        const newOrganizationId = (0, generateId_1.default)();
+        const updated = await db.updateOne(this.collectionName, {}, {
+            'target.organizationId': newOrganizationId,
+        });
+        test_utils_1.assert.isEqual(updated.target.organizationId, newOrganizationId, 'Could not update nested field target.organizationId using key "target.organizationId"');
+        const match = await db.findOne(this.collectionName, { id: updated.id });
+        test_utils_1.assert.isEqualDeep(match.target, {
+            organizationId: newOrganizationId,
+            locationId,
+        }, `Updating nested field lost existing key 'target.locationId'`);
+        await this.shutdown(db);
+    },
+    async canUpsertNestedField(connect) {
+        const db = await connectToDabatase(connect);
+        const locationId = (0, generateId_1.default)();
+        const values = {
+            name: 'first',
+            target: {
+                organizationId: (0, generateId_1.default)(),
+                locationId,
+            },
+        };
+        const record = await db.createOne(this.collectionName, values);
+        const newOrganizationId = (0, generateId_1.default)();
+        await db.upsertOne(this.collectionName, { id: record.id }, {
+            'target.organizationId': newOrganizationId,
+        });
+        const match = await db.findOne(this.collectionName, { id: record.id });
+        test_utils_1.assert.isEqual(match.target.organizationId, newOrganizationId, 'Could not find updated record with key "target.organizationId" set');
+        test_utils_1.assert.isEqual(match.target.locationId, locationId, `Upserting lost existing key 'target.locationId'`);
+        await this.shutdown(db);
+    },
     assertHasLowerCaseToCamelCaseMappingEnabled(store) {
         test_utils_1.assert.isTrue(
         //@ts-ignore

package/build/types/query.types.d.ts

@@ -5,6 +5,21 @@ export type QueryBuilder<Query, Keys extends Paths<Query> = Paths<Query>> = {
 } & {
     id?: string | QuerySelector<string>;
 } & RootQuerySelector<Query>;
+export type ValuesWithPaths<Values, Keys extends Paths<Values> = Paths<Values>> = {
+    [K in RequiredKeys<Values, Keys>]: TypeAtPath<Values, K>;
+} & {
+    [K in OptionalKeys<Values, Keys>]?: TypeAtPath<Values, K>;
+};
+type IsOptional<T, K extends keyof T> = {} extends Pick<T, K> ? true : false;
+type IsPathOptional<T, P extends string> = P extends `${infer K}.${infer Rest}` ? K extends keyof T ? IsOptional<T, K> extends true ? true : IsPathOptional<T[K], Rest> : true : P extends keyof T ? IsOptional<T, P> : true;
+type RequiredKeys<Values, Keys extends Paths<Values>> = {
+    [K in Keys]: IsPathOptional<Values, K> extends true ? never : K;
+}[Keys];
+type OptionalKeys<Values, Keys extends Paths<Values>> = Exclude<Keys, RequiredKeys<Values, Keys>>;
+type Paths<T, D extends number = 3> = [D] extends [never] ? never : T extends object ? {
+    [K in keyof T]-?: K extends string | number ? `${K}` | Join<K, Paths<T[K], Prev[D]>> : never;
+}[keyof T] : '';
+type TypeAtPath<T, P extends string> = P extends `${infer K}.${infer Rest}` ? K extends keyof T ? TypeAtPath<T[K], Rest> : any : P extends keyof T ? T[P] : any;
 export interface QuerySortField {
     field: string;
     direction: 'asc' | 'desc';
@@ -44,8 +59,4 @@ type Prev = [
     20,
     ...0[]
 ];
-type Paths<T, D extends number = 3> = [D] extends [never] ? never : T extends object ? {
-    [K in keyof T]-?: K extends string | number ? `${K}` | Join<K, Paths<T[K], Prev[D]>> : never;
-}[keyof T] : '';
-type TypeAtPath<T, P extends string> = P extends `${infer K}.${infer Rest}` ? K extends keyof T ? TypeAtPath<T[K], Rest> : any : P extends keyof T ? T[P] : any;
 export {};

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "28.3.232",
+  "version": "28.3.234",
   "files": [
     "build/**/*",
     "!build/__tests__",
@@ -65,31 +65,31 @@
   },
   "dependencies": {
     "@seald-io/nedb": "^4.0.4",
-    "@sprucelabs/error": "^6.0.547",
+    "@sprucelabs/error": "^6.0.548",
     "@sprucelabs/globby": "^2.0.499",
-    "@sprucelabs/schema": "^30.0.572",
-    "@sprucelabs/spruce-skill-utils": "^31.0.639",
+    "@sprucelabs/schema": "^30.0.577",
+    "@sprucelabs/spruce-skill-utils": "^31.0.641",
     "just-clone": "^6.2.0",
     "lodash": "^4.17.21",
     "mongodb": "^6.11.0"
   },
   "devDependencies": {
-    "@sprucelabs/esm-postbuild": "^6.0.527",
-    "@sprucelabs/jest-json-reporter": "^8.0.549",
-    "@sprucelabs/resolve-path-aliases": "^2.0.518",
+    "@sprucelabs/esm-postbuild": "^6.0.528",
+    "@sprucelabs/jest-json-reporter": "^8.0.550",
+    "@sprucelabs/resolve-path-aliases": "^2.0.519",
     "@sprucelabs/semantic-release": "^5.0.2",
-    "@sprucelabs/test": "^9.0.61",
-    "@sprucelabs/test-utils": "^5.1.513",
+    "@sprucelabs/test": "^9.0.62",
+    "@sprucelabs/test-utils": "^5.1.515",
     "@types/lodash": "^4.17.13",
-    "@types/node": "^22.10.0",
+    "@types/node": "^22.10.1",
     "chokidar-cli": "^3.0.0",
     "concurrently": "^9.1.0",
     "dotenv": "^16.4.5",
-    "eslint": "^9.15.0",
+    "eslint": "^9.16.0",
     "eslint-config-spruce": "^11.2.26",
     "jest": "^29.7.0",
     "jest-circus": "^29.7.0",
-    "prettier": "^3.4.0",
+    "prettier": "^3.4.1",
     "ts-node": "^10.9.2",
     "tsc-watch": "^6.2.1",
     "tsconfig-paths": "^4.2.0",