@verdant-web/store 4.1.6 → 4.2.0

package/src/index.ts

@@ -1,60 +1,60 @@
+import { Client } from './client/Client.js';
 import {
 	ClientDescriptor,
 	ClientDescriptorOptions,
 } from './client/ClientDescriptor.js';
-import { Client } from './client/Client.js';
 export type { ClientWithCollections } from './client/Client.js';
-export { ClientDescriptor };
-export { Client };
+export { Client, ClientDescriptor };
 // backward compat
-export { ClientDescriptor as StorageDescriptor };
-export { Client as Storage };
-export type { ClientDescriptorOptions };
-export type { ClientDescriptorOptions as StorageInitOptions };
-export { Entity } from './entities/Entity.js';
-export type {
-	ObjectEntity,
-	ListEntity,
-	EntityShape,
-	AccessibleEntityProperty,
-	AnyEntity,
-	EntityDestructured,
-	EntityInit,
-} from './entities/types.js';
-export { ServerSync } from './sync/Sync.js';
-export type { SyncTransportMode } from './sync/Sync.js';
-export { EntityFile, type EntityFileSnapshot } from './files/EntityFile.js';
-export { schema, createMigration } from '@verdant-web/common';
+export { createMigration, schema } from '@verdant-web/common';
 export type {
-	StorageDocument,
-	StorageSchema,
-	StorageCollectionSchema,
+	CollectionFilter,
+	DocumentBaseline,
+	FileData,
+	IndexValueTag,
+	Migration,
+	ObjectIdentifier,
 	StorageAnyFieldSchema,
 	StorageArrayFieldSchema,
-	StorageObjectFieldSchema,
 	StorageBooleanFieldSchema,
+	StorageCollectionSchema,
+	StorageDocument,
 	StorageFieldSchema,
+	StorageFieldsSchema,
 	StorageFileFieldSchema,
 	StorageMapFieldSchema,
 	StorageNumberFieldSchema,
+	StorageObjectFieldSchema,
+	StorageSchema,
 	StorageStringFieldSchema,
-	StorageFieldsSchema,
-	IndexValueTag,
-	Migration,
+	UserInfo,
 	VerdantError,
 	VerdantErrorCode,
-	ObjectIdentifier,
-	CollectionFilter,
-	FileData,
-	DocumentBaseline,
-	UserInfo,
 } from '@verdant-web/common';
-export type { Query } from './queries/types.js';
+export * from './authorization.js';
+export { Entity, getEntityClient } from './entities/Entity.js';
+export type {
+	AccessibleEntityProperty,
+	AnyEntity,
+	EntityDestructured,
+	EntityInit,
+	EntityShape,
+	ListEntity,
+	ObjectEntity,
+} from './entities/types.js';
+export { EntityFile, type EntityFileSnapshot } from './files/EntityFile.js';
+export { IdbPersistence } from './persistence/idb/idbPersistence.js';
+export type * from './persistence/interfaces.js';
 export type { QueryStatus } from './queries/BaseQuery.js';
 export type { CollectionQueries } from './queries/CollectionQueries.js';
-export * from './utils/id.js';
-export { UndoHistory } from './UndoHistory.js';
-export * from './authorization.js';
+export type { Query } from './queries/types.js';
 export * from './sync/cliSync.js';
-export type * from './persistence/interfaces.js';
-export { IdbPersistence } from './persistence/idb/idbPersistence.js';
+export { ServerSync } from './sync/Sync.js';
+export type { SyncTransportMode } from './sync/Sync.js';
+export { UndoHistory } from './UndoHistory.js';
+export * from './utils/id.js';
+export { Client as Storage, ClientDescriptor as StorageDescriptor };
+export type {
+	ClientDescriptorOptions,
+	ClientDescriptorOptions as StorageInitOptions,
+};

package/src/persistence/migration/engine.ts

@@ -1,4 +1,5 @@
 import {
+	AuthorizationKey,
 	CollectionFilter,
 	Migration,
 	MigrationEngine,
@@ -11,10 +12,9 @@ import {
 	diffToPatches,
 	getOid,
 	removeOidPropertiesFromAllSubObjects,
-	AuthorizationKey,
 } from '@verdant-web/common';
-import { OpenDocumentDbContext } from './types.js';
 import { PersistenceDocumentDb, PersistenceNamespace } from '../interfaces.js';
+import { OpenDocumentDbContext } from './types.js';
 
 function getMigrationMutations({
 	migration,
@@ -184,7 +184,14 @@ export async function getMigrationEngine({
 							undefined,
 							[],
 							{
+								// incoming unknown objects are assumed to be the same
+								// as any pre-existing object.
 								mergeUnknownObjects: true,
+								// if a field is undefined in the new value, it should be
+								// erased. this is the only way to allow users to remove
+								// entries in maps during migrations. it is a little
+								// dangerous for other types, though.
+								defaultUndefined: false,
 								authz,
 							},
 						);