@verdant-web/store 3.0.0-next.0 → 3.0.1

package/src/entities/{2/EntityStore.ts → EntityStore.ts}

@@ -14,16 +14,16 @@ import {
 	isRootOid,
 	removeOidsFromAllSubObjects,
 } from '@verdant-web/common';
-import { Context } from '../../context.js';
-import { Metadata } from '../../metadata/Metadata.js';
+import { Context } from '../context.js';
+import { Metadata } from '../metadata/Metadata.js';
 import { Entity } from './Entity.js';
-import { Disposable } from '../../utils/Disposable.js';
+import { Disposable } from '../utils/Disposable.js';
 import { EntityFamilyMetadata } from './EntityMetadata.js';
-import { FileManager } from '../../files/FileManager.js';
+import { FileManager } from '../files/FileManager.js';
 import { OperationBatcher } from './OperationBatcher.js';
-import { QueryableStorage } from '../../queries/QueryableStorage.js';
+import { QueryableStorage } from '../queries/QueryableStorage.js';
 import { WeakEvent } from 'weak-event';
-import { processValueFiles } from '../../files/utils.js';
+import { processValueFiles } from '../files/utils.js';
 import { abort } from 'process';
 
 enum AbortReason {
@@ -315,7 +315,11 @@ export class EntityStore extends Disposable {
 	/**
 	 * Creates a new Entity with the given initial data.
 	 */
-	create = async (initial: any, oid: ObjectIdentifier) => {
+	create = async (
+		initial: any,
+		oid: ObjectIdentifier,
+		{ undoable = true }: { undoable?: boolean } = {},
+	) => {
 		this.ctx.log('debug', 'Creating new entity', oid);
 		const { collection } = decomposeOid(oid);
 		// remove any OID associations from the initial data
@@ -335,7 +339,7 @@ export class EntityStore extends Disposable {
 
 		const operations = this.meta.patchCreator.createInitialize(processed, oid);
 		await this.batcher.commitOperations(operations, {
-			undoable: true,
+			undoable: !!undoable,
 			source: entity,
 		});
 

package/src/entities/{2/OperationBatcher.ts → OperationBatcher.ts}

@@ -6,8 +6,8 @@ import {
 	getUndoOperations,
 	groupPatchesByOid,
 } from '@verdant-web/common';
-import { Metadata } from '../../metadata/Metadata.js';
-import { Context } from '../../context.js';
+import { Metadata } from '../metadata/Metadata.js';
+import { Context } from '../context.js';
 import type { EntityStore } from './EntityStore.js';
 import { Entity } from './Entity.js';
 

package/src/files/EntityFile.ts

@@ -7,6 +7,11 @@ export type EntityFileEvents = {
 export const UPDATE = Symbol('entity-file-update');
 export const MARK_FAILED = Symbol('entity-file-mark-failed');
 
+export type EntityFileSnapshot = {
+	id: string;
+	url?: string | null;
+};
+
 /**
  * Provides a consistent interface for files used in an app via
  * Entity access.
@@ -83,7 +88,7 @@ export class EntityFile extends EventSubscriber<EntityFileEvents> {
 		this.dispose();
 	};
 
-	getSnapshot() {
+	getSnapshot(): EntityFileSnapshot {
 		return {
 			id: this.id,
 			url: this.loading || this.failed ? undefined : this.url,

package/src/index.ts

@@ -11,7 +11,7 @@ export { ClientDescriptor as StorageDescriptor };
 export { Client as Storage };
 export type { ClientDescriptorOptions };
 export type { ClientDescriptorOptions as StorageInitOptions };
-export { Entity } from './entities/2/Entity.js';
+export { Entity } from './entities/Entity.js';
 export type {
 	ObjectEntity,
 	ListEntity,
@@ -19,10 +19,10 @@ export type {
 	AccessibleEntityProperty,
 	AnyEntity,
 	EntityDestructured,
-} from './entities/2/types.js';
+} from './entities/types.js';
 export { ServerSync } from './sync/Sync.js';
 export type { SyncTransportMode } from './sync/Sync.js';
-export { EntityFile } from './files/EntityFile.js';
+export { EntityFile, type EntityFileSnapshot } from './files/EntityFile.js';
 export {
 	collection,
 	schema,

package/src/queries/BaseQuery.ts

@@ -1,6 +1,6 @@
 import { EventSubscriber } from '@verdant-web/common';
 import { Context } from '../context.js';
-import { Entity } from '../entities/2/Entity.js';
+import { Entity } from '../entities/Entity.js';
 import { Disposable } from '../utils/Disposable.js';
 import { filterResultSet } from './utils.js';
 

package/src/queries/CollectionQueries.ts

@@ -1,6 +1,6 @@
 import { CollectionFilter, hashObject } from '@verdant-web/common';
 import { Context } from '../context.js';
-import { EntityStore } from '../entities/2/EntityStore.js';
+import { EntityStore } from '../entities/EntityStore.js';
 import { GetQuery } from './GetQuery.js';
 import { QueryCache } from './QueryCache.js';
 import { FindOneQuery } from './FindOneQuery.js';
@@ -22,7 +22,7 @@ export class CollectionQueries<
 	private context;
 	private documentManager;
 
-	put: (init: Init) => Promise<T>;
+	put: (init: Init, options?: { undoable?: boolean }) => Promise<T>;
 	delete: (id: string, options?: { undoable?: boolean }) => Promise<void>;
 	deleteAll: (ids: string[], options?: { undoable?: boolean }) => Promise<void>;
 

package/src/queries/utils.ts

@@ -1,5 +1,5 @@
 import { CollectionIndexFilter, hashObject } from '@verdant-web/common';
-import { Entity } from '../entities/2/Entity.js';
+import { Entity } from '../entities/Entity.js';
 
 function existsFilter<T>(x: T | null): x is T {
 	return x !== null;

package/dist/cjs/entities/2/Entity.d.ts

@@ -1,148 +0,0 @@
-import { EntityValidationProblem, EventSubscriber, ObjectIdentifier, PatchCreator, StorageFieldSchema } from '@verdant-web/common';
-import { Context } from '../../context.js';
-import { FileManager } from '../../files/FileManager.js';
-import { EntityCache } from './EntityCache.js';
-import { EntityFamilyMetadata, EntityMetadataView } from './EntityMetadata.js';
-import { BaseEntityValue, DataFromInit, DeepPartial, EntityChange, EntityEvents, ListEntity, ListItemInit, ListItemValue, ObjectEntity } from './types.js';
-import { EntityStoreEvents } from './EntityStore.js';
-export interface EntityInit {
-    oid: ObjectIdentifier;
-    schema: StorageFieldSchema;
-    entityFamily?: EntityCache;
-    metadataFamily: EntityFamilyMetadata;
-    parent?: Entity;
-    ctx: Context;
-    files: FileManager;
-    readonlyKeys?: string[];
-    fieldPath?: (string | number)[];
-    patchCreator: PatchCreator;
-    events: EntityStoreEvents;
-}
-export declare class Entity<Init = any, KeyValue extends BaseEntityValue = any, Snapshot extends any = DataFromInit<Init>> extends EventSubscriber<EntityEvents> implements ObjectEntity<Init, KeyValue, Snapshot>, ListEntity<Init, KeyValue, Snapshot> {
-    readonly oid: ObjectIdentifier;
-    private readonlyKeys;
-    private fieldPath;
-    private entityFamily;
-    private metadataFamily;
-    private schema;
-    private parent;
-    private ctx;
-    private files;
-    private patchCreator;
-    private events;
-    private _viewData;
-    private validationError;
-    private cachedDeepUpdatedAt;
-    private wasDeletedLastChange;
-    private cachedView;
-    constructor({ oid, schema, entityFamily: childCache, parent, ctx, metadataFamily, readonlyKeys, files, patchCreator, events, }: EntityInit);
-    private onAdd;
-    private onReplace;
-    private onResetAll;
-    private get metadata();
-    /**
-     * The view of this Entity, not including nested
-     * entities (that's the snapshot - see #getSnapshot())
-     *
-     * Nested entities are represented by refs.
-     */
-    private get viewData();
-    /** convenience getter for viewData.view */
-    private get rawView();
-    /**
-     * An Entity's View includes the rendering of its underlying data,
-     * connecting of children where refs were, and validation
-     * and pruning according to schema.
-     */
-    private get view();
-    private childIsNull;
-    get uid(): string;
-    get deleted(): boolean;
-    get invalid(): boolean;
-    get isList(): any;
-    get updatedAt(): number;
-    get deepUpdatedAt(): number;
-    /**
-     * @internal - this is relevant to Verdant's system, not users.
-     *
-     * Indicates whether this document is from an outdated version
-     * of the schema - which means it cannot be used until it is upgraded.
-     */
-    get isOutdatedVersion(): boolean;
-    /**
-     * Pruning - when entities have invalid children, we 'prune' that
-     * data up to the nearest prunable point - a nullable field,
-     * or a list.
-     */
-    protected validate: (...args: unknown[]) => EntityValidationProblem | undefined;
-    private viewWithMappedChildren;
-    /**
-     * A current snapshot of this Entity's data, including nested
-     * Entities.
-     */
-    getSnapshot: () => any;
-    private addPendingOperations;
-    private addConfirmedData;
-    private replaceAllData;
-    private resetAllData;
-    private change;
-    protected deepChange: (target: Entity, ev: EntityChange) => void;
-    private getChild;
-    /**
-     * Gets a value from this Entity. If the value
-     * is an object, it will be wrapped in another
-     * Entity.
-     */
-    get: <Key extends keyof KeyValue>(key: Key) => KeyValue[Key];
-    private processInputValue;
-    private getDeleteMode;
-    /**
-     * Returns the referent value of an item in the list, used for
-     * operations which act on items. if the item is an object,
-     * it will attempt to create an OID reference to it. If it
-     * is a primitive, it will return the primitive.
-     */
-    private getItemRefValue;
-    set: <Key extends keyof Init>(key: Key, value: Init[Key]) => void;
-    /**
-     * Returns a destructured version of this Entity, where child
-     * Entities are accessible at their respective keys.
-     */
-    getAll: () => KeyValue;
-    delete: (key: any) => void;
-    keys: () => string[];
-    entries: () => [string, Exclude<KeyValue[keyof KeyValue], undefined>][];
-    values: () => Exclude<KeyValue[keyof KeyValue], undefined>[];
-    update: (data: DeepPartial<Init>, { merge, replaceSubObjects, }?: {
-        replaceSubObjects?: boolean | undefined;
-        merge?: boolean | undefined;
-    }) => void;
-    get length(): number;
-    push: (value: ListItemInit<Init>) => void;
-    insert: (index: number, value: ListItemInit<Init>) => void;
-    move: (from: number, to: number) => void;
-    moveItem: (item: ListItemValue<KeyValue>, to: number) => void;
-    add: (value: ListItemValue<KeyValue>) => void;
-    removeAll: (item: ListItemValue<KeyValue>) => void;
-    removeFirst: (item: ListItemValue<KeyValue>) => void;
-    removeLast: (item: ListItemValue<KeyValue>) => void;
-    [Symbol.iterator](): {
-        next: () => {
-            readonly value: ListItemValue<KeyValue>;
-            readonly done: false;
-        } | {
-            readonly value: undefined;
-            readonly done: true;
-        };
-    };
-    map: <U>(callback: (value: ListItemValue<KeyValue>, index: number) => U) => U[];
-    filter: (callback: (value: ListItemValue<KeyValue>, index: number) => boolean) => ListItemValue<KeyValue>[];
-    has: (value: ListItemValue<KeyValue>) => boolean;
-    forEach: (callback: (value: ListItemValue<KeyValue>, index: number) => void) => void;
-    some: (predicate: (value: ListItemValue<KeyValue>) => boolean) => boolean;
-    every: (predicate: (value: ListItemValue<KeyValue>) => boolean) => boolean;
-    find: (predicate: (value: ListItemValue<KeyValue>) => boolean) => ListItemValue<KeyValue> | undefined;
-    includes: (value: ListItemValue<KeyValue>) => boolean;
-    __getViewData__: (oid: ObjectIdentifier, type: 'confirmed' | 'pending') => EntityMetadataView;
-    __getFamilyOids__: () => string[];
-}