@verdant-web/store 2.7.5 → 2.7.7-next.0

package/dist/esm/reactives/DocumentFamiliyCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocumentFamiliyCache.js","sourceRoot":"","sources":["../../../src/reactives/DocumentFamiliyCache.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,UAAU,EACV,SAAS,EACT,SAAS,EAET,eAAe,GAIf,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,MAAM,EAAE,aAAa,EAAc,MAAM,aAAa,CAAC;AAEhE,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAG3C,MAAM,OAAO,mBAAoB,SAAQ,eAIxC;IAWA,YAAY,EACX,GAAG,EACH,KAAK,EACL,OAAO,GAKP;QACA,KAAK,EAAE,CAAC;QAdD,aAAQ,GAA2C,IAAI,GAAG,EAAE,CAAC;QA6BrE,gCAA2B,GAAG,CAAC,UAAuB,EAAE,EAAE;YACzD,MAAM,MAAM,GAAG,IAAI,GAAG,EAAoB,CAAC;YAC3C,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;gBACnC,MAAM,EAAE,GAAG,EAAE,GAAG,SAAS,CAAC;gBAC1B,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAChB,MAAM,kBAAkB,GAAG,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;gBACxE,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBACnC,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;aAC3D;YACD,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;gBACzB,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBACzC,MAAM,MAAM,GAAG,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,KAAK,EAAE,CAAC;gBAClC,IAAI,MAAM,EAAE;oBACX,aAAa,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;oBACzC,IAAI,CAAC,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC,CAAC;oBAC3B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;iBAC3B;aACD;QACF,CAAC,CAAC;QAEF,qBAAgB,GAAG,CAClB,UAAuB,EACvB,IAAgE,EAC/D,EAAE;;YACH,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;gBACnC,MAAM,EAAE,GAAG,EAAE,GAAG,SAAS,CAAC;gBAC1B,MAAA,IAAI,CAAC,YAAY,0CAAE,GAAG,CAAC,GAAG,CAAC,CAAC;gBAC5B,MAAM,kBAAkB,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;gBAC7D,+BAA+B;gBAC/B,MAAM,KAAK,GAAG,kBAAkB,CAAC,SAAS,CACzC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,SAAS,IAAI,SAAS,CAAC,SAAS,CAC3C,CAAC;gBACF,8DAA8D;gBAC9D,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;oBACjB,IAAI,kBAAkB,CAAC,KAAK,CAAC,CAAC,SAAS,KAAK,SAAS,CAAC,SAAS,EAAE;wBAChE,SAAS;qBACT;oBACD,kBAAkB,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,SAAS,CAAC,CAAC;iBAC/C;qBAAM;oBACN,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;iBACnC;gBACD,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;gBAEhD,2BAA2B;gBAC3B,MAAM,qBAAqB,GAAG,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBACrE,IAAI,qBAAqB,EAAE;oBAC1B,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAChC,GAAG,EACH,qBAAqB,CAAC,MAAM,CAC3B,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,SAAS,KAAK,SAAS,CAAC,SAAS,CAC5C,CACD,CAAC;iBACF;aACD;QACF,CAAC,CAAC;QAEF,oBAAe,GAAG,CACjB,SAA6B,EAC7B,EACC,YAAY,GACgD,EAC5D,EAAE;;YACH,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;gBACjC,MAAM,EAAE,GAAG,EAAE,GAAG,QAAQ,CAAC;gBACzB,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,GAAG,CAAC,GAAG,CAAC,CAAC;gBACvB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;gBACrC,sCAAsC;gBACtC,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;gBAC9C,OAAO,CAAA,MAAA,GAAG,CAAC,CAAC,CAAC,0CAAE,SAAS,IAAG,QAAQ,CAAC,SAAS,EAAE;oBAC9C,GAAG,CAAC,KAAK,EAAE,CAAC;iBACZ;aACD;QACF,CAAC,CAAC;QAEF,qBAAgB,GAAG,CAAC,EACnB,UAAU,EACV,SAAS,EACT,KAAK,EACL,OAAO,GAMP,EAAE,EAAE;YACJ,IAAI,KAAK,EAAE;gBACV,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;gBAC3B,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;aAC1B;YACD,MAAM,IAAI,GAAG;gBACZ,OAAO,EAAE,OAAO,IAAI,KAAK;gBACzB,YAAY,EAAE,IAAI,GAAG,EAAoB;aACzC,CAAC;YACF,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YACtC,yDAAyD;YACzD,wCAAwC;YACxC,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YACxC,IAAI,KAAK,EAAE;gBACV,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE;oBAC/C,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,EAAE,CAAC;oBACjC,IAAI,MAAM,EAAE;wBACX,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;qBAC5B;iBACD;aACD;iBAAM;gBACN,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,YAAY,EAAE;oBACpC,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBACzC,MAAM,MAAM,GAAG,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,KAAK,EAAE,CAAC;oBAClC,IAAI,MAAM,EAAE;wBACX,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;wBAC5B,IAAI,CAAC,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC,CAAC;wBAC3B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;qBAC3B;iBACD;aACD;QACF,CAAC,CAAC;QAEM,oBAAe,GAAG,CACzB,IAAS,EACT,OAAgB,EAChB,UAAuB,EACvB,KAAc,EACb,EAAE;YACH,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;gBACnC,IAAI,KAAK,IAAI,SAAS,CAAC,SAAS,IAAI,KAAK,EAAE;oBAC1C,SAAS;iBACT;gBACD,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,KAAK,QAAQ,EAAE;oBACnC,OAAO,GAAG,IAAI,CAAC;iBACf;qBAAM;oBACN,IAAI,GAAG,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;oBACxC,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,EAAE;wBACvC,OAAO,GAAG,KAAK,CAAC;qBAChB;iBACD;aACD;YACD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;QAC1B,CAAC,CAAC;QAEF,gBAAW,GAAG,CAAC,GAAqB,EAAE,EAAE;YACvC,MAAM,SAAS,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;YACjD,MAAM,qBAAqB,GAAG,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YAC3E,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,eAAe,CAC3C,SAAS,CAAC,IAAI,EACd,SAAS,CAAC,OAAO,EACjB,qBAAqB,CACrB,CAAC;YACF,IAAI,IAAI,EAAE;gBACT,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;aACrB;YACD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,EAAE,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC;QACrE,CAAC,CAAC;QAEF,yBAAoB,GAAG,CAAC,GAAqB,EAAE,EAAE;YAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YACrD,IAAI,IAAI,GAAG,SAAS,CAAC,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,QAAQ,KAAI,SAAS,CAAC,CAAC;YACtD,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,SAAS,CAAC,CAAC;YAC1E,IAAI,IAAI,EAAE;gBACT,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;aACrB;YACD,IAAI,CAAC,QAAQ,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;gBACpC,IAAI,CAAC,OAAO,CAAC,GAAG,CACf,OAAO,EACP,UAAU,GAAG,kCAAkC,CAC/C,CAAC;aACF;YACD,OAAO,IAAI,CAAC;QACb,CAAC,CAAC;QAEF,qBAAgB,GAAG,CAAC,GAAqB,EAAE,EAAE;;YAC5C,IAAI,UAAU,GAAG,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACxD,IAAI,CAAC,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,MAAM,CAAA,EAAE;gBACxB,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;aAC/C;YACD,IAAI,gBAAgB,GAAkB,IAAI,CAAC;YAC3C,IAAI,UAAU,CAAC,MAAM,EAAE;gBACtB,gBAAgB,GAAG,MAAA,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,0CAAE,SAAS,CAAC;aAChE;iBAAM;gBACN,gBAAgB,GAAG,MAAA,MAAA,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,0CAAE,SAAS,mCAAI,IAAI,CAAC;aACjE;YACD,IAAI,CAAC,gBAAgB;gBAAE,OAAO,IAAI,CAAC;YACnC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;QAChE,CAAC,CAAC;QAEF,cAAS,GAAG,CACX,GAAqB,EACrB,MAA0B,EAC1B,MAAe,EACN,EAAE;YACX,IAAI,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACvC,IAAI,MAAM,GAAG,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,KAAK,EAAE,CAAC;YAChC,IAAI,CAAC,MAAM,EAAE;gBACZ,MAAM,GAAG,IAAI,MAAM,CAAC;oBACnB,GAAG;oBACH,KAAK,EAAE,IAAI;oBACX,WAAW,EAAE,MAAM;oBACnB,KAAK,EAAE,IAAI,CAAC,UAAU;oBACtB,MAAM;iBACN,CAAC,CAAC;gBAEH,oEAAoE;gBACpE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;aAC5C;YAED,OAAO,MAAa,CAAC;QACtB,CAAC,CAAC;QAEF,WAAM,GAAG,CAAC,GAAqB,EAAE,EAAE;YAClC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClE,CAAC,CAAC;QAEF,YAAO,GAAG,GAAG,EAAE;YACd,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,WAAC,OAAA,MAAA,MAAM,CAAC,KAAK,EAAE,0CAAE,OAAO,EAAE,CAAA,EAAA,CAAC,CAAC;YAC7D,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACvB,CAAC,CAAC;QAEF,UAAK,GAAG,CAAC,UAAuB,EAAE,SAA6B,EAAE,EAAE;YAClE,MAAM,IAAI,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,GAAG,EAAoB,EAAE,CAAC;YAC3E,IAAI,CAAC,YAAY,GAAG,IAAI,GAAG,CAC1B,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CACrD,CAAC;YACF,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,EAAE,CAAC;YAC/B,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YACxC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE;gBACvC,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBACzC,MAAM,MAAM,GAAG,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,KAAK,EAAE,CAAC;gBAClC,IAAI,MAAM,EAAE;oBACX,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;oBAC5B,IAAI,CAAC,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC,CAAC;oBAC3B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;iBAC3B;aACD;QACF,CAAC,CAAC;QAvPD,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,EAAE,CAAC;QAC/B,IAAI,CAAC,wBAAwB,GAAG,IAAI,GAAG,EAAE,CAAC;QAC1C,IAAI,CAAC,YAAY,GAAG,IAAI,GAAG,EAAE,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG;YACjB,kBAAkB,EAAE,KAAK,CAAC,kBAAkB;YAC5C,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,YAAY;YACrC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG;YACxB,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG;YACxB,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI;SACrB,CAAC;QACF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACxB,CAAC;CA4OD"}

package/dist/esm/reactives/Entity.d.ts

@@ -0,0 +1,191 @@
+import { EventSubscriber, FileData, ObjectIdentifier, Operation, PatchCreator, StorageFieldSchema, StorageFieldsSchema, TimestampProvider } from '@verdant-web/common';
+import { EntityFile } from '../files/EntityFile.js';
+import { WeakRef } from './FakeWeakRef.js';
+export declare const ADD_OPERATIONS = "@@addOperations";
+export declare const DELETE = "@@delete";
+export declare const REBASE = "@@rebase";
+declare const REFRESH = "@@refresh";
+export declare const DEEP_CHANGE = "@@deepChange";
+export interface CacheTools {
+    computeView(oid: ObjectIdentifier): {
+        view: any;
+        deleted: boolean;
+        lastTimestamp: number | null;
+    };
+    getEntity(oid: ObjectIdentifier, schema: StorageFieldSchema, parent?: Entity): Entity;
+    hasOid(oid: ObjectIdentifier): boolean;
+}
+export interface StoreTools {
+    addLocalOperations(operations: Operation[]): void;
+    patchCreator: PatchCreator;
+    addFile: (file: FileData) => void;
+    getFile: (id: string) => EntityFile;
+    time: TimestampProvider;
+}
+export type AccessibleEntityProperty<T> = T extends Array<any> ? number : T extends object ? keyof T : never;
+type DataFromInit<Init> = Init extends {
+    [key: string]: any;
+} ? {
+    [Key in keyof Init]: Init[Key];
+} : Init extends Array<any> ? Init : any;
+export type EntityShape<E extends Entity<any, any>> = E extends Entity<infer Value, any> ? Value : never;
+type DeletableKeys<T> = keyof {
+    [Key in keyof T as IfNullableThen<T[Key], Key>]: Key;
+};
+type IfNullableThen<T, Out> = undefined extends T ? Out : null extends T ? Out : never;
+export declare function refreshEntity(entity: Entity<any, any>, info: EntityChangeInfo): void;
+export interface EntityChangeInfo {
+    isLocal?: boolean;
+}
+type EntityEvents = {
+    change: (info: EntityChangeInfo) => void;
+    changeDeep: (target: Entity<any, any>, info: EntityChangeInfo) => void;
+    delete: (info: EntityChangeInfo) => void;
+    restore: (info: EntityChangeInfo) => void;
+};
+type BaseEntityValue = {
+    [Key: string]: any;
+} | any[];
+export declare class Entity<Init = any, KeyValue extends BaseEntityValue = any, Snapshot extends any = DataFromInit<Init>> implements ObjectEntity<Init, KeyValue, Snapshot>, ListEntity<Init, KeyValue, Snapshot> {
+    protected _current: any | null;
+    readonly oid: ObjectIdentifier;
+    readonly collection: string;
+    protected readonly store: StoreTools;
+    protected readonly fieldSchema: StorageFieldSchema | StorageFieldsSchema;
+    protected readonly keyPath: import("@verdant-web/common").KeyPath;
+    protected readonly cache: CacheTools;
+    protected _deleted: boolean;
+    protected parent: WeakRef<Entity<any, any>> | undefined;
+    private cachedSnapshot;
+    private cachedDestructure;
+    private cachedDeepUpdatedAt;
+    private _updatedAt;
+    protected events: EventSubscriber<EntityEvents>;
+    protected hasSubscribersToDeepChanges(): boolean;
+    get hasSubscribers(): boolean;
+    get deleted(): boolean;
+    protected get value(): any;
+    get isList(): any;
+    get updatedAt(): number | null;
+    get deepUpdatedAt(): number | null;
+    get uid(): string;
+    constructor({ oid, store, fieldSchema, cache, parent, }: {
+        oid: ObjectIdentifier;
+        store: StoreTools;
+        fieldSchema: StorageFieldSchema | StorageFieldsSchema;
+        cache: CacheTools;
+        parent?: Entity<any, any>;
+    });
+    private [REFRESH];
+    private [DEEP_CHANGE];
+    protected getChildFieldSchema: (key: any) => any;
+    dispose: () => void;
+    subscribe: <EventName extends keyof EntityEvents>(event: EventName, callback: EntityEvents[EventName]) => () => void;
+    protected addPatches: (patches: Operation[]) => void;
+    protected cloneCurrent: () => any;
+    protected getSubObject: (oid: ObjectIdentifier, key: any) => Entity<any, any>;
+    protected wrapValue: <Key extends keyof KeyValue>(value: any, key: Key) => KeyValue[Key];
+    protected processInputValue: (value: any, key: any) => any;
+    get: <Key extends keyof KeyValue>(key: Key) => KeyValue[Key];
+    getAll: () => KeyValue;
+    /**
+     * Returns a copy of the entity and all sub-objects as
+     * a plain object or array.
+     */
+    getSnapshot: () => any;
+    /**
+     * Object methods
+     */
+    keys: () => string[];
+    entries: () => [string, any][];
+    values: () => any[];
+    set: <Key extends keyof Init>(key: Key, value: Init[Key]) => void;
+    delete: (key: any) => void;
+    private getDeleteMode;
+    /** @deprecated - renamed to delete */
+    remove: (key: any) => void;
+    update: (value: Partial<Snapshot>, { replaceSubObjects, merge, }?: {
+        replaceSubObjects?: boolean | undefined;
+        merge?: boolean | undefined;
+    }) => void;
+    /**
+     * List methods
+     */
+    /**
+     * 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;
+    get length(): any;
+    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;
+    removeAll: (item: ListItemValue<KeyValue>) => void;
+    removeFirst: (item: ListItemValue<KeyValue>) => void;
+    removeLast: (item: ListItemValue<KeyValue>) => void;
+    add: (item: ListItemValue<KeyValue>) => void;
+    has: (item: ListItemValue<KeyValue>) => any;
+    [Symbol.iterator](): {
+        next: () => {
+            readonly value: ListItemValue<KeyValue>;
+            readonly done: false;
+        } | {
+            readonly value: undefined;
+            readonly done: true;
+        };
+    };
+    private getAsWrapped;
+    map: <U>(callback: (value: ListItemValue<KeyValue>, index: number) => U) => U[];
+    filter: (callback: (value: ListItemValue<KeyValue>, index: number) => boolean) => ListItemValue<KeyValue>[];
+    forEach: (callback: (value: ListItemValue<KeyValue>, index: number) => void) => void;
+}
+export interface BaseEntity<Init, Value extends BaseEntityValue, Snapshot = DataFromInit<Init>> {
+    dispose: () => void;
+    subscribe<EventName extends keyof EntityEvents>(event: EventName, callback: EntityEvents[EventName]): () => void;
+    get<Key extends keyof Value>(key: Key): Value[Key];
+    getAll(): Value;
+    getSnapshot(): Snapshot;
+    readonly deleted: boolean;
+    readonly hasSubscribers: boolean;
+}
+export interface ObjectEntity<Init, Value extends BaseEntityValue, Snapshot = DataFromInit<Init>> extends BaseEntity<Init, Value, Snapshot> {
+    keys(): string[];
+    entries(): [string, Exclude<Value[keyof Value], undefined>][];
+    values(): Exclude<Value[keyof Value], undefined>[];
+    set<Key extends keyof Init>(key: Key, value: Init[Key]): void;
+    delete(key: DeletableKeys<Value>): void;
+    update(value: Partial<Snapshot>, options?: {
+        replaceSubObjects?: boolean;
+        merge?: boolean;
+    }): void;
+    readonly isList: false;
+}
+export interface ListEntity<Init, Value extends BaseEntityValue, Snapshot = DataFromInit<Init>> extends Iterable<ListItemValue<Value>>, BaseEntity<Init, Value, Snapshot> {
+    readonly isList: true;
+    readonly length: number;
+    push(value: ListItemInit<Init>): void;
+    insert(index: number, value: ListItemInit<Init>): void;
+    move(from: number, to: number): void;
+    moveItem(item: ListItemValue<Value>, to: number): void;
+    /**
+     * A Set operation which adds a value if an equivalent value is not already present.
+     * Object values are never the same.
+     */
+    add(value: ListItemValue<Value>): void;
+    removeAll(item: ListItemValue<Value>): void;
+    removeFirst(item: ListItemValue<Value>): void;
+    removeLast(item: ListItemValue<Value>): void;
+    map<U>(callback: (value: ListItemValue<Value>, index: number) => U): U[];
+    filter(callback: (value: ListItemValue<Value>, index: number) => boolean): ListItemValue<Value>[];
+    delete(index: number): void;
+    has(value: ListItemValue<Value>): boolean;
+    forEach(callback: (value: ListItemValue<Value>, index: number) => void): void;
+}
+export type AnyEntity<Init, KeyValue extends BaseEntityValue, Snapshot extends any> = ListEntity<Init, KeyValue, Snapshot> | ObjectEntity<Init, KeyValue, Snapshot>;
+type ListItemValue<KeyValue> = KeyValue extends Array<infer T> ? T : never;
+type ListItemInit<Init> = Init extends Array<infer T> ? T : never;
+export type EntityDestructured<T extends AnyEntity<any, any, any> | null> = (T extends ListEntity<any, infer KeyValue, any> ? KeyValue : T extends ObjectEntity<any, infer KeyValue, any> ? KeyValue : never) | (T extends null ? null : never);
+export {};

package/dist/esm/reactives/Entity.js

@@ -0,0 +1,458 @@
+var _a, _b;
+import { assert, assignOid, cloneDeep, decomposeOid, EventSubscriber, isFileRef, isObjectRef, maybeGetOid, traverseCollectionFieldsAndApplyDefaults, } from '@verdant-web/common';
+import { processValueFiles } from '../files/utils.js';
+import { WeakRef } from './FakeWeakRef.js';
+export const ADD_OPERATIONS = '@@addOperations';
+export const DELETE = '@@delete';
+export const REBASE = '@@rebase';
+const REFRESH = '@@refresh';
+export const DEEP_CHANGE = '@@deepChange';
+export function refreshEntity(entity, info) {
+    return entity[REFRESH](info);
+}
+export class Entity {
+    hasSubscribersToDeepChanges() {
+        return this.events.subscriberCount('changeDeep') > 0;
+    }
+    get hasSubscribers() {
+        var _c, _d;
+        if (this.events.totalSubscriberCount() > 0) {
+            return true;
+        }
+        // even if nobody subscribes directly to this entity, if a parent
+        // has a deep subscription that counts.
+        let parent = (_c = this.parent) === null || _c === void 0 ? void 0 : _c.deref();
+        while (parent) {
+            if (parent.hasSubscribersToDeepChanges()) {
+                return true;
+            }
+            parent = (_d = parent.parent) === null || _d === void 0 ? void 0 : _d.deref();
+        }
+        return false;
+    }
+    get deleted() {
+        return this._deleted;
+    }
+    get value() {
+        return this._current;
+    }
+    get isList() {
+        return Array.isArray(this._current);
+    }
+    get updatedAt() {
+        return this._updatedAt;
+    }
+    get deepUpdatedAt() {
+        if (this.cachedDeepUpdatedAt)
+            return this.cachedDeepUpdatedAt;
+        // iterate over all children and take the latest timestamp
+        let latest = this._updatedAt;
+        if (this.isList) {
+            this.forEach((child) => {
+                if (child instanceof Entity) {
+                    const childTimestamp = child.deepUpdatedAt;
+                    if (childTimestamp && (!latest || childTimestamp > latest)) {
+                        latest = childTimestamp;
+                    }
+                }
+            });
+        }
+        else {
+            this.values().forEach((child) => {
+                if (child instanceof Entity) {
+                    const childTimestamp = child.deepUpdatedAt;
+                    if (childTimestamp && (!latest || childTimestamp > latest)) {
+                        latest = childTimestamp;
+                    }
+                }
+            });
+        }
+        this.cachedDeepUpdatedAt = latest;
+        return latest;
+    }
+    get uid() {
+        return this.oid;
+    }
+    constructor({ oid, store, fieldSchema, cache, parent, }) {
+        // if current is null, the entity was deleted.
+        this._current = null;
+        this._deleted = false;
+        this.cachedSnapshot = null;
+        this.cachedDestructure = null;
+        this.cachedDeepUpdatedAt = null;
+        this._updatedAt = null;
+        this.events = new EventSubscriber();
+        this[_a] = (info) => {
+            const { view, deleted, lastTimestamp } = this.cache.computeView(this.oid);
+            this._current = view;
+            const restored = this._deleted && !deleted;
+            this._deleted = deleted;
+            this.cachedDestructure = null;
+            this._updatedAt = lastTimestamp ? lastTimestamp : null;
+            this.cachedDeepUpdatedAt = null;
+            if (this._deleted) {
+                this.events.emit('delete', info);
+            }
+            else {
+                this.events.emit('change', info);
+                this[DEEP_CHANGE](this, info);
+            }
+            if (restored) {
+                this.cachedSnapshot = null;
+                this.events.emit('restore', info);
+            }
+        };
+        this[_b] = (source, info) => {
+            var _c;
+            this.cachedSnapshot = null;
+            this.cachedDeepUpdatedAt = null;
+            this.events.emit('changeDeep', source, info);
+            const parent = (_c = this.parent) === null || _c === void 0 ? void 0 : _c.deref();
+            if (parent) {
+                parent[DEEP_CHANGE](source, info);
+            }
+        };
+        this.getChildFieldSchema = (key) => {
+            if (this.fieldSchema.type === 'object') {
+                return this.fieldSchema.properties[key];
+            }
+            else if (this.fieldSchema.type === 'array') {
+                return this.fieldSchema.items;
+            }
+            else if (this.fieldSchema.type === 'map') {
+                return this.fieldSchema.values;
+            }
+            else if (this.fieldSchema.type === 'any') {
+                return this.fieldSchema;
+            }
+            throw new Error('Invalid field schema');
+        };
+        this.dispose = () => {
+            this.events.dispose();
+        };
+        this.subscribe = (event, callback) => {
+            const unsubscribe = this.events.subscribe(event, callback);
+            return unsubscribe;
+        };
+        this.addPatches = (patches) => {
+            this.store.addLocalOperations(patches);
+        };
+        this.cloneCurrent = () => {
+            if (this._current === undefined) {
+                return undefined;
+            }
+            return cloneDeep(this._current);
+        };
+        this.getSubObject = (oid, key) => {
+            const fieldSchema = this.getChildFieldSchema(key);
+            // this is a failure case, but trying to be graceful about it...
+            // @ts-ignore
+            // if (!fieldSchema) return null;
+            return this.cache.getEntity(oid, fieldSchema, this);
+        };
+        this.wrapValue = (value, key) => {
+            if (isObjectRef(value)) {
+                const oid = value.id;
+                const subObject = this.getSubObject(oid, key);
+                if (subObject) {
+                    return subObject;
+                }
+                throw new Error(`CACHE MISS: Subobject ${oid} does not exist on ${this.oid}`);
+            }
+            else if (isFileRef(value)) {
+                const file = this.store.getFile(value.id);
+                if (file) {
+                    file.subscribe('change', () => {
+                        this[DEEP_CHANGE](this, {
+                            isLocal: false,
+                        });
+                    });
+                    return file;
+                }
+            }
+            return value;
+        };
+        this.processInputValue = (value, key) => {
+            const fieldSchema = this.getChildFieldSchema(key);
+            if (fieldSchema) {
+                traverseCollectionFieldsAndApplyDefaults(value, fieldSchema);
+            }
+            return processValueFiles(value, this.store.addFile);
+        };
+        this.get = (key) => {
+            if (this.value === undefined || this.value === null) {
+                throw new Error('Cannot access deleted entity');
+            }
+            const value = this.value[key];
+            return this.wrapValue(value, key);
+        };
+        this.getAll = () => {
+            if (this.value === undefined || this.value === null) {
+                throw new Error('Cannot access deleted entity');
+            }
+            if (this.cachedDestructure)
+                return this.cachedDestructure;
+            let result;
+            if (Array.isArray(this.value)) {
+                result = this.value.map((value, index) => this.wrapValue(value, index));
+            }
+            else {
+                result = {};
+                for (const key in this.value) {
+                    result[key] = this.get(key);
+                }
+            }
+            this.cachedDestructure = result;
+            return result;
+        };
+        /**
+         * Returns a copy of the entity and all sub-objects as
+         * a plain object or array.
+         */
+        this.getSnapshot = () => {
+            var _c;
+            if (!this.value) {
+                return null;
+            }
+            if (this.deleted) {
+                return null;
+            }
+            if (this.cachedSnapshot) {
+                return this.cachedSnapshot;
+            }
+            let snapshot;
+            if (Array.isArray(this.value)) {
+                snapshot = this.value.map((item, idx) => {
+                    var _c;
+                    if (isObjectRef(item)) {
+                        return (_c = this.getSubObject(item.id, idx)) === null || _c === void 0 ? void 0 : _c.getSnapshot();
+                    }
+                    return item;
+                });
+            }
+            else {
+                snapshot = Object.assign({}, this.value);
+                for (const [key, value] of Object.entries(snapshot)) {
+                    if (isObjectRef(value)) {
+                        snapshot[key] = (_c = this.getSubObject(value.id, key)) === null || _c === void 0 ? void 0 : _c.getSnapshot();
+                    }
+                }
+            }
+            assignOid(snapshot, this.oid);
+            this.cachedSnapshot = snapshot;
+            return snapshot;
+        };
+        /**
+         * Object methods
+         */
+        this.keys = () => {
+            return Object.keys(this.value || {});
+        };
+        this.entries = () => {
+            return Object.entries(this.getAll());
+        };
+        this.values = () => {
+            return Object.values(this.getAll());
+        };
+        this.set = (key, value) => {
+            this.addPatches(this.store.patchCreator.createSet(this.oid, key, this.processInputValue(value, key), this.keyPath));
+        };
+        this.delete = (key) => {
+            if (Array.isArray(this.value)) {
+                this.addPatches(this.store.patchCreator.createListDelete(this.oid, key, 1));
+            }
+            else {
+                // the key must be deletable - i.e. optional in the schema
+                const deleteMode = this.getDeleteMode(key);
+                if (!deleteMode) {
+                    throw new Error(`Cannot delete key ${key} - the property is not marked as optional in the schema`);
+                }
+                if (deleteMode === 'delete') {
+                    this.addPatches(this.store.patchCreator.createRemove(this.oid, key));
+                }
+                else {
+                    this.addPatches(this.store.patchCreator.createSet(this.oid, key, null, this.keyPath));
+                }
+            }
+        };
+        this.getDeleteMode = (key) => {
+            // 'any' is always deletable, and map values can be removed completely
+            if (this.fieldSchema.type === 'any' || this.fieldSchema.type === 'map') {
+                return 'delete';
+            }
+            if (this.fieldSchema.type === 'object') {
+                const property = this.fieldSchema.properties[key];
+                if (!property) {
+                    // huh, trying to delete a field that isn't specified
+                    // in the schema. we should use 'delete' mode.
+                    return 'delete';
+                }
+                if (property.type === 'any')
+                    return 'delete';
+                // map can't be nullable
+                // TODO: should it be?
+                if (property.type === 'map')
+                    return false;
+                // nullable properties can only be set null
+                if (property.nullable)
+                    return 'null';
+            }
+            // no other parent objects support deleting
+            return false;
+        };
+        /** @deprecated - renamed to delete */
+        this.remove = this.delete.bind(this);
+        this.update = (value, { replaceSubObjects = false, merge = true, } = {
+            /**
+             * If true, merged sub-objects will be replaced entirely if there's
+             * ambiguity about their identity.
+             */
+            replaceSubObjects: false,
+            /**
+             * If false, omitted keys will erase their respective fields.
+             */
+            merge: true,
+        }) => {
+            if (!merge &&
+                this.fieldSchema.type !== 'any' &&
+                this.fieldSchema.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.');
+            }
+            for (const [key, field] of Object.entries(value)) {
+                const fieldSchema = this.getChildFieldSchema(key);
+                if (fieldSchema) {
+                    traverseCollectionFieldsAndApplyDefaults(field, fieldSchema);
+                }
+            }
+            const withoutFiles = processValueFiles(value, this.store.addFile);
+            this.addPatches(this.store.patchCreator.createDiff(this.getSnapshot(), assignOid(withoutFiles, this.oid), this.keyPath, {
+                mergeUnknownObjects: !replaceSubObjects,
+                defaultUndefined: merge,
+            }));
+        };
+        /**
+         * List methods
+         */
+        /**
+         * 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.
+         */
+        this.getItemRefValue = (item) => {
+            if (typeof item === 'object') {
+                const itemOid = maybeGetOid(item);
+                if (!itemOid || !this.cache.hasOid(itemOid)) {
+                    throw new Error(`Cannot move object ${JSON.stringify(item)} which does not exist in this list`);
+                }
+                return itemOid;
+            }
+            else {
+                return item;
+            }
+        };
+        this.push = (value) => {
+            this.addPatches(this.store.patchCreator.createListPush(this.oid, this.processInputValue(value, this.value.length)));
+        };
+        this.insert = (index, value) => {
+            this.addPatches(this.store.patchCreator.createListInsert(this.oid, index, this.processInputValue(value, index)));
+        };
+        this.move = (from, to) => {
+            this.addPatches(this.store.patchCreator.createListMoveByIndex(this.oid, from, to));
+        };
+        this.moveItem = (item, to) => {
+            const itemRef = this.getItemRefValue(item);
+            if (isObjectRef(itemRef)) {
+                this.addPatches(this.store.patchCreator.createListMoveByRef(this.oid, itemRef, to));
+            }
+            else {
+                const index = this.value.indexOf(itemRef);
+                this.addPatches(this.store.patchCreator.createListMoveByIndex(this.oid, index, to));
+            }
+        };
+        this.removeAll = (item) => {
+            this.addPatches(this.store.patchCreator.createListRemove(this.oid, this.getItemRefValue(item)));
+        };
+        this.removeFirst = (item) => {
+            this.addPatches(this.store.patchCreator.createListRemove(this.oid, this.getItemRefValue(item), 'first'));
+        };
+        this.removeLast = (item) => {
+            this.addPatches(this.store.patchCreator.createListRemove(this.oid, this.getItemRefValue(item), 'last'));
+        };
+        this.add = (item) => {
+            this.addPatches(this.store.patchCreator.createListAdd(this.oid, this.processInputValue(item, this.value.length)));
+        };
+        this.has = (item) => {
+            if (typeof item === 'object') {
+                return this.value.some((val) => {
+                    if (isObjectRef(val))
+                        return val.id === maybeGetOid(item);
+                    // Sets of files don't work right now, there's no way to compare them
+                    // effectively.
+                    if (isFileRef(val))
+                        return false;
+                    return false;
+                });
+            }
+            return this.value.includes(item);
+        };
+        // additional access methods
+        this.getAsWrapped = () => {
+            if (!this.isList)
+                throw new Error('Cannot map items of a non-list');
+            return this.value.map(this.wrapValue);
+        };
+        this.map = (callback) => {
+            return this.getAsWrapped().map(callback);
+        };
+        this.filter = (callback) => {
+            return this.getAsWrapped().filter((val, index) => {
+                return callback(val, index);
+            });
+        };
+        this.forEach = (callback) => {
+            this.getAsWrapped().forEach(callback);
+        };
+        this.oid = oid;
+        const { collection, keyPath } = decomposeOid(oid);
+        this.collection = collection;
+        this.parent = parent && new WeakRef(parent);
+        this.store = store;
+        this.fieldSchema = fieldSchema;
+        // TODO: remove, this is not safe
+        this.keyPath = keyPath;
+        this.cache = cache;
+        const { view, deleted, lastTimestamp } = this.cache.computeView(oid);
+        this._current = view;
+        this._deleted = deleted;
+        this._updatedAt = lastTimestamp ? lastTimestamp : null;
+        this.cachedDeepUpdatedAt = null;
+        if (this.oid.includes('.') && !this.parent) {
+            throw new Error('Parent must be provided for sub entities');
+        }
+        assert(!!fieldSchema, 'Field schema must be provided');
+    }
+    get length() {
+        return this.value.length;
+    }
+    // list implements an iterator which maps items to wrapped
+    // versions
+    [(_a = REFRESH, _b = DEEP_CHANGE, Symbol.iterator)]() {
+        let index = 0;
+        return {
+            next: () => {
+                if (index < this.value.length) {
+                    return {
+                        value: this.get(index++),
+                        done: false,
+                    };
+                }
+                return {
+                    value: undefined,
+                    done: true,
+                };
+            },
+        };
+    }
+}
+//# sourceMappingURL=Entity.js.map