@verdant-web/store 2.0.1 → 2.0.3

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

@@ -1,191 +1,192 @@
-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 {};
+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, onAllUnsubscribed, }: {
+        oid: ObjectIdentifier;
+        store: StoreTools;
+        fieldSchema: StorageFieldSchema | StorageFieldsSchema;
+        cache: CacheTools;
+        parent?: Entity<any, any>;
+        onAllUnsubscribed?: () => void;
+    });
+    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 {};