jazz-tools 0.7.0-alpha.0 → 0.7.0-alpha.2

package/src/coValues/coList.ts

@@ -0,0 +1,320 @@
+import type { RawCoList } from "cojson";
+import { RawAccount } from "cojson";
+import type { Effect, Stream } from "effect";
+import type {
+    AccountCtx,
+    CoValue,
+    EnsureItemNullable,
+    FieldDescriptor,
+    FieldDescriptorFor,
+    ID,
+    RefField,
+    SubclassedConstructor,
+    UnavailableError,
+} from "../internal.js";
+import {
+    Account,
+    CoValueBase,
+    Group,
+    ValueRef,
+    inspect,
+    makeRefs,
+} from "../internal.js";
+import { Schema } from "@effect/schema";
+
+export class CoList<Item extends EnsureItemNullable<Item, 'Co.List'> = any>
+    extends Array<Item>
+    implements CoValue<"CoList", RawCoList>
+{
+    id!: ID<this>;
+    _type!: "CoList";
+    static {
+        this.prototype._type = "CoList";
+    }
+    _raw!: RawCoList;
+
+    static _encoding: any;
+    get _encoding(): {
+        _item: FieldDescriptorFor<Item>;
+    } {
+        return (this.constructor as typeof CoList)._encoding;
+    }
+
+    get _owner(): Account | Group {
+        return this._raw.group instanceof RawAccount
+            ? Account.fromRaw(this._raw.group)
+            : Group.fromRaw(this._raw.group);
+    }
+
+    get _refs(): {
+        [idx: number]: NonNullable<Item> extends CoValue
+            ? ValueRef<NonNullable<Item>>
+            : never;
+    } {
+        return makeRefs<number>(
+            (idx) => this._raw.get(idx) as unknown as ID<CoValue>,
+            () =>
+                Array.from(
+                    { length: this._raw.entries().length },
+                    (_, idx) => idx
+                ),
+            this._loadedAs,
+            (_idx) => (this._encoding._item as RefField<CoValue>).ref()
+        ) as any;
+    }
+
+    get _edits(): {
+        [idx: number]: {
+            value?: Item;
+            ref?: Item extends CoValue ? ValueRef<Item> : never;
+            by?: Account;
+            madeAt: Date;
+        };
+    } {
+        throw new Error("Not implemented");
+    }
+
+    get _loadedAs() {
+        return Account.fromNode(this._raw.core.node);
+    }
+
+    constructor(_init: undefined, options: { fromRaw: RawCoList });
+    constructor(init: Item[], options: { owner: Account | Group });
+    constructor(init: number);
+    constructor(
+        init: Item[] | undefined | number,
+        options?: { owner: Account | Group } | { fromRaw: RawCoList }
+    ) {
+        if (typeof init === "number") {
+            // this might be called from an intrinsic, like map, trying to create an empty array
+            // passing `0` as the only parameter
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            return new Array(init) as any;
+        }
+
+        super();
+
+        if (!options) {
+            throw new Error("Must provide options");
+        }
+
+        let raw: RawCoList;
+
+        if ("fromRaw" in options) {
+            raw = options.fromRaw;
+        } else {
+            const rawOwner = options.owner._raw;
+
+            const rawInit = init && this.toRawItems(init);
+
+            raw = rawOwner.createList(rawInit);
+        }
+
+        Object.defineProperties(this, {
+            id: {
+                value: raw.id,
+                enumerable: false,
+            },
+            _raw: { value: raw, enumerable: false },
+        });
+
+        return new Proxy(this, CoListProxyHandler<Item>(this._encoding._item));
+    }
+
+    private toRawItems(items: Item[]) {
+        const itemDescriptor = this._encoding._item as FieldDescriptor;
+        const rawItems =
+            itemDescriptor === "json"
+                ? items
+                : "encoded" in itemDescriptor
+                  ? items?.map((e) =>
+                        Schema.encodeSync(itemDescriptor.encoded)(e)
+                    )
+                  : "ref" in itemDescriptor
+                    ? items?.map((v) => (v as unknown as CoValue).id)
+                    : (() => {
+                          throw new Error("Invalid element descriptor");
+                      })();
+        return rawItems;
+    }
+
+    push(...items: Item[]): number;
+    /** @private For exact type compatibility with Array superclass */
+    push(...items: Item[]): number;
+    push(...items: Item[]): number {
+        for (const item of this.toRawItems(items as Item[])) {
+            this._raw.append(item);
+        }
+
+        return this._raw.entries().length;
+    }
+
+    unshift(...items: Item[]): number;
+    /** @private For exact type compatibility with Array superclass */
+    unshift(...items: Item[]): number;
+    unshift(...items: Item[]): number {
+        for (const item of this.toRawItems(items as Item[])) {
+            this._raw.prepend(item);
+        }
+
+        return this._raw.entries().length;
+    }
+
+    pop(): Item | undefined {
+        const last = this[this.length - 1];
+
+        this._raw.delete(this.length - 1);
+
+        return last;
+    }
+
+    shift(): Item | undefined {
+        const first = this[0];
+
+        this._raw.delete(0);
+
+        return first;
+    }
+
+    splice(start: number, deleteCount: number, ...items: Item[]): Item[];
+    splice(start: number, deleteCount: number, ...items: Item[]): Item[];
+    splice(start: number, deleteCount: number, ...items: Item[]): Item[] {
+        const deleted = this.slice(start, start + deleteCount);
+
+        for (
+            let idxToDelete = start + deleteCount;
+            idxToDelete > start;
+            idxToDelete--
+        ) {
+            this._raw.delete(idxToDelete);
+        }
+
+        let appendAfter = start;
+        for (const item of this.toRawItems(items as Item[])) {
+            this._raw.append(item, appendAfter);
+            appendAfter++;
+        }
+
+        return deleted;
+    }
+
+    toJSON() {
+        const itemDescriptor = this._encoding._item as FieldDescriptor;
+        if (itemDescriptor === "json") {
+            return this._raw.asArray();
+        } else if ("encoded" in itemDescriptor) {
+            return this._raw
+                .asArray()
+                .map((e) => Schema.encodeSync(itemDescriptor.encoded)(e));
+        } else if ("ref" in itemDescriptor) {
+            return this.map((item) => (item as unknown as CoValue)?.toJSON());
+        } else {
+            return [];
+        }
+    }
+
+    [inspect]() {
+        return this.toJSON();
+    }
+
+    subscribe!: (listener: (update: this) => void) => () => void;
+    static {
+        this.prototype.subscribe = CoValueBase.prototype.subscribe as any;
+    }
+
+    subscribeEf!: () => Stream.Stream<this, "unavailable", never>;
+    static {
+        this.prototype.subscribeEf = CoValueBase.prototype.subscribeEf as any;
+    }
+
+    static fromRaw<V extends CoList>(
+        this: SubclassedConstructor<V> & typeof CoList,
+        raw: RawCoList
+    ) {
+        return new this(undefined, { fromRaw: raw });
+    }
+
+    static loadEf = CoValueBase.loadEf as unknown as <V extends CoValue>(
+        this: SubclassedConstructor<V>,
+        id: ID<V>
+    ) => Effect.Effect<V, UnavailableError, AccountCtx>;
+    static load = CoValueBase.load as unknown as <V extends CoValue>(
+        this: SubclassedConstructor<V>,
+        id: ID<V>,
+        options: { as: Account | Group }
+    ) => Promise<V | undefined>;
+    static subscribeEf = CoValueBase.subscribeEf as unknown as <
+        V extends CoValue,
+    >(
+        this: SubclassedConstructor<V>,
+        id: ID<V>
+    ) => Stream.Stream<V, UnavailableError, AccountCtx>;
+    static subscribe = CoValueBase.subscribe as unknown as <V extends CoValue>(
+        this: SubclassedConstructor<V>,
+        id: ID<V>,
+        options: { as: Account | Group },
+        onUpdate: (value: V) => void
+    ) => () => void;
+
+    static encoding<V extends CoList>(
+        this: { new (...args: any): V } & typeof CoList,
+        def: { _item: V["_encoding"]["_item"] }
+    ) {
+        this._encoding ||= {};
+        Object.assign(this._encoding, def);
+    }
+}
+
+function CoListProxyHandler<Item extends EnsureItemNullable<Item, "Co.List">>(
+    itemDescriptor: FieldDescriptor
+): ProxyHandler<CoList<Item>> {
+    return {
+        get(target, key, receiver) {
+            if (typeof key === "string" && !isNaN(+key)) {
+                const rawValue = target._raw.get(Number(key));
+                if (itemDescriptor === "json") {
+                    return rawValue;
+                } else if ("encoded" in itemDescriptor) {
+                    return rawValue === undefined
+                        ? undefined
+                        : Schema.decodeSync(itemDescriptor.encoded)(rawValue);
+                } else if ("ref" in itemDescriptor) {
+                    return rawValue === undefined
+                        ? undefined
+                        : new ValueRef(
+                              rawValue as unknown as ID<CoValue>,
+                              target._loadedAs,
+                              itemDescriptor.ref()
+                          ).accessFrom(receiver);
+                }
+            } else if (key === "length") {
+                return target._raw.entries().length;
+            } else {
+                return Reflect.get(target, key, receiver);
+            }
+        },
+        set(target, key, value, receiver) {
+            if (typeof key === "string" && !isNaN(+key)) {
+                let rawValue;
+                if (itemDescriptor === "json") {
+                    rawValue = value;
+                } else if ("encoded" in itemDescriptor) {
+                    rawValue = Schema.encodeSync(itemDescriptor.encoded)(value);
+                } else if ("ref" in itemDescriptor) {
+                    rawValue = value.id;
+                }
+                target._raw.replace(Number(key), rawValue);
+                return true;
+            } else {
+                return Reflect.set(target, key, value, receiver);
+            }
+        },
+        has(target, key) {
+            if (typeof key === "string" && !isNaN(+key)) {
+                return Number(key) < target._raw.entries().length;
+            } else {
+                return Reflect.has(target, key);
+            }
+        },
+    };
+}