@verdant-web/store 4.1.3 → 4.1.5

package/src/context/ShutdownHandler.ts

@@ -1,6 +1,12 @@
 export class ShutdownHandler {
 	private consumed = false;
 	private readonly handlers: (() => Promise<void>)[] = [];
+	constructor(
+		private log?: (
+			level: 'debug' | 'info' | 'warn' | 'error' | 'critical',
+			...args: any[]
+		) => void,
+	) {}
 
 	register(handler: () => Promise<void>) {
 		this.handlers.push(handler);
@@ -8,7 +14,7 @@ export class ShutdownHandler {
 
 	async shutdown() {
 		if (this.consumed) {
-			console.warn('ShutdownHandler already consumed');
+			this.log?.('warn', 'ShutdownHandler already consumed');
 		}
 
 		this.consumed = true;

package/src/entities/Entity.ts

@@ -11,7 +11,7 @@ import {
 	createFileRef,
 	createRef,
 	getChildFieldSchema,
-	getDefault,
+	getFieldDefault,
 	hasDefault,
 	isFile,
 	isFileRef,
@@ -199,7 +199,7 @@ export class Entity<
 		if (viewIsWrongType) {
 			// this will cover lists and maps, too.
 			if (hasDefault(this.schema)) {
-				return getDefault(this.schema);
+				return getFieldDefault(this.schema);
 			}
 			// force null - invalid - will require parent prune
 			return null as any;
@@ -656,17 +656,11 @@ export class Entity<
 					requireDefaults: true,
 				})
 			) {
-				if (hasDefault(fieldSchema)) {
-					// FIXME: this returns []/{} for arrays and objects, but the contract
-					// of this method should return an Entity for such object fields.
-					// I want to write a test case for this one before attempting to fix
-					// just to be sure the fix works.
-					return getDefault(fieldSchema);
-				}
-				if (isNullable(fieldSchema)) {
-					return null as any;
-				}
-				return undefined as any;
+				// FIXME: this returns []/{} for arrays and objects, but the contract
+				// of this method should return an Entity for such object fields.
+				// I want to write a test case for this one before attempting to fix
+				// just to be sure the fix works.
+				return getFieldDefault(fieldSchema);
 			}
 			return child as KeyValue[Key];
 		}
@@ -890,13 +884,20 @@ export class Entity<
 			merge = true,
 			replaceSubObjects = false,
 			preserveUndefined = false,
+			dangerouslyDisableMerge = false,
 		}: {
 			replaceSubObjects?: boolean;
 			merge?: boolean;
 			preserveUndefined?: boolean;
+			dangerouslyDisableMerge?: boolean;
 		} = {},
 	): void => {
-		if (!merge && this.schema.type !== 'any' && this.schema.type !== 'map') {
+		if (
+			!merge &&
+			!dangerouslyDisableMerge &&
+			this.schema.type !== 'any' &&
+			this.schema.type !== 'map'
+		) {
 			throw new Error(
 				'Cannot use .update without merge if the field has a strict schema type. merge: false is only available on "any" or "map" types.',
 			);

package/src/entities/types.ts

@@ -163,6 +163,13 @@ export interface ObjectEntity<
 			 * Default: true
 			 */
 			merge?: boolean;
+			/**
+			 * If set to true, bypasses the restrictions around merge: false for
+			 * object fields. This means you can accidentally erase required fields
+			 * on this object or a sub-object. Unless you are certain your passed
+			 * data conforms to the expected schema, you should not use this option.
+			 */
+			dangerouslyDisableMerge?: boolean;
 		},
 	): void;
 	/**

package/src/persistence/migration/migrate.ts

@@ -1,10 +1,10 @@
 import { Migration } from '@verdant-web/common';
-import { getMigrationPath } from './paths.js';
-import { OpenDocumentDbContext } from './types.js';
+import { ShutdownHandler } from '../../context/ShutdownHandler.js';
+import { PersistenceNamespace } from '../interfaces.js';
 import { getMigrationEngine } from './engine.js';
 import { finalizeMigration } from './finalize.js';
-import { PersistenceNamespace } from '../interfaces.js';
-import { ShutdownHandler } from '../../context/ShutdownHandler.js';
+import { getMigrationPath } from './paths.js';
+import { OpenDocumentDbContext } from './types.js';
 
 export async function migrate({
 	context,
@@ -79,7 +79,7 @@ export async function runMigrations({
 		const migrationContext = {
 			...context,
 			schema: migration.oldSchema,
-			shutdownHandler: new ShutdownHandler(),
+			shutdownHandler: new ShutdownHandler(context.log),
 		};
 		// this will only write to our metadata store via operations!
 		const engine = await getMigrationEngine({

package/src/persistence/persistence.ts

@@ -139,7 +139,7 @@ export async function importPersistence(
 				disableRebasing: true,
 			},
 		},
-		persistenceShutdownHandler: new ShutdownHandler(),
+		persistenceShutdownHandler: new ShutdownHandler(ctx.log),
 	});
 	// load imported data into persistence
 	await importedContext.meta.resetFrom(exportedData.data);
@@ -176,7 +176,7 @@ export async function importPersistence(
 		const currentSchema = ctx.schema;
 		const upgradedContext = await initializePersistence({
 			...importedContext,
-			persistenceShutdownHandler: new ShutdownHandler(),
+			persistenceShutdownHandler: new ShutdownHandler(ctx.log),
 			schema: currentSchema,
 		});