jazz-tools 0.10.14 → 0.11.0

package/dist/coValues/coMap.d.ts

@@ -0,0 +1,500 @@
+import { AgentID, type CoValueUniqueness, CojsonInternalTypes, type JsonValue, RawAccountID, type RawCoMap } from "cojson";
+import type { AnonymousJazzAgent, CoValue, CoValueClass, DeeplyLoaded, DepthsIn, ID, IfCo, RefIfCoValue, Schema, co } from "../internal.js";
+import { CoValueBase, ItemsSym, Ref, inspect } from "../internal.js";
+import { type Account } from "./account.js";
+import { type Group } from "./group.js";
+type CoMapEdit<V> = {
+    value?: V;
+    ref?: RefIfCoValue<V>;
+    by?: Account;
+    madeAt: Date;
+    key?: string;
+};
+type LastAndAllCoMapEdits<V> = CoMapEdit<V> & {
+    all: CoMapEdit<V>[];
+};
+export type Simplify<A> = {
+    [K in keyof A]: A[K];
+} extends infer B ? B : never;
+/**
+ * CoMaps are collaborative versions of plain objects, mapping string-like keys to values.
+ *
+ * @categoryDescription Declaration
+ * Declare your own CoMap schemas by subclassing `CoMap` and assigning field schemas with `co`.
+ *
+ * Optional `co.ref(...)` fields must be marked with `{ optional: true }`.
+ *
+ * ```ts
+ * import { co, CoMap } from "jazz-tools";
+ *
+ * class Person extends CoMap {
+ *   name = co.string;
+ *   age = co.number;
+ *   pet = co.ref(Animal);
+ *   car = co.ref(Car, { optional: true });
+ * }
+ * ```
+ *
+ * @categoryDescription Content
+ * You can access properties you declare on a `CoMap` (using `co`) as if they were normal properties on a plain object, using dot notation, `Object.keys()`, etc.
+ *
+ * ```ts
+ * person.name;
+ * person["age"];
+ * person.age = 42;
+ * person.pet?.name;
+ * Object.keys(person);
+ * // => ["name", "age", "pet"]
+ * ```
+ *
+ * @category CoValues
+ *  */
+export declare class CoMap extends CoValueBase implements CoValue {
+    /**
+     * The ID of this `CoMap`
+     * @category Content */
+    id: ID<this>;
+    /** @category Type Helpers */
+    _type: "CoMap";
+    /** @category Internals */
+    _raw: RawCoMap;
+    /** @internal */
+    static _schema: any;
+    /** @internal */
+    get _schema(): {
+        [key: string]: Schema;
+    } & {
+        [ItemsSym]?: Schema;
+    };
+    /**
+     * If property `prop` is a `co.ref(...)`, you can use `coMaps._refs.prop` to access
+     * the `Ref` instead of the potentially loaded/null value.
+     *
+     * This allows you to always get the ID or load the value manually.
+     *
+     * @example
+     * ```ts
+     * person._refs.pet.id; // => ID<Animal>
+     * person._refs.pet.value;
+     * // => Animal | null
+     * const pet = await person._refs.pet.load();
+     * ```
+     *
+     * @category Content
+     **/
+    get _refs(): {
+        [Key in CoKeys<this>]: IfCo<this[Key], RefIfCoValue<this[Key]>>;
+    };
+    /** @internal */
+    getEditFromRaw(target: CoMap, rawEdit: {
+        by: RawAccountID | AgentID;
+        tx: CojsonInternalTypes.TransactionID;
+        at: Date;
+        value?: JsonValue | undefined;
+    }, descriptor: Schema, key: string): {
+        value: any;
+        ref: Ref<CoValue> | undefined;
+        by: Account | null;
+        madeAt: Date;
+        key: string;
+    };
+    /** @category Collaboration */
+    get _edits(): { [Key in CoKeys<this>]: IfCo<this[Key], LastAndAllCoMapEdits<this[Key]>>; };
+    /** @internal */
+    constructor(options: {
+        fromRaw: RawCoMap;
+    } | undefined);
+    /**
+     * Create a new CoMap with the given initial values and owner.
+     *
+     * The owner (a Group or Account) determines access rights to the CoMap.
+     *
+     * The CoMap will immediately be persisted and synced to connected peers.
+     *
+     * @example
+     * ```ts
+     * const person = Person.create({
+     *   name: "Alice",
+     *   age: 42,
+     *   pet: cat,
+     * }, { owner: friendGroup });
+     * ```
+     *
+     * @category Creation
+     **/
+    static create<M extends CoMap>(this: CoValueClass<M>, init: Simplify<CoMapInit<M>>, options?: {
+        owner: Account | Group;
+        unique?: CoValueUniqueness["uniqueness"];
+    } | Account | Group): M;
+    /**
+     * Return a JSON representation of the `CoMap`
+     * @category Content
+     */
+    toJSON(_key?: string, seenAbove?: ID<CoValue>[]): any[];
+    [inspect](): any[];
+    /**
+     * Create a new `RawCoMap` from an initialization object
+     * @internal
+     */
+    rawFromInit<Fields extends object = Record<string, any>>(init: Simplify<CoMapInit<Fields>> | undefined, owner: Account | Group, uniqueness?: CoValueUniqueness): RawCoMap<{
+        [key: string]: JsonValue | undefined;
+    }, import("cojson").JsonObject | null>;
+    /**
+     * Declare a Record-like CoMap schema, by extending `CoMap.Record(...)` and passing the value schema using `co`. Keys are always `string`.
+     *
+     * @example
+     * ```ts
+     * import { co, CoMap } from "jazz-tools";
+     *
+     * class ColorToFruitMap extends CoMap.Record(
+     *  co.ref(Fruit)
+     * ) {}
+     *
+     * // assume we have map: ColorToFruitMap
+     * // and strawberry: Fruit
+     * map["red"] = strawberry;
+     * ```
+     *
+     * @category Declaration
+     */
+    static Record<Value>(value: IfCo<Value, Value>): {
+        new (options: {
+            fromRaw: RawCoMap;
+        } | undefined): {
+            [x: string]: Value;
+            $items$: IfCo<Value, Value>;
+            /**
+             * The ID of this `CoMap`
+             * @category Content */
+            id: ID<any>;
+            /** @category Type Helpers */
+            _type: "CoMap";
+            /** @category Internals */
+            _raw: RawCoMap;
+            /** @internal */
+            readonly _schema: {
+                [key: string]: Schema;
+            } & {
+                $items$?: Schema;
+            };
+            /**
+             * If property `prop` is a `co.ref(...)`, you can use `coMaps._refs.prop` to access
+             * the `Ref` instead of the potentially loaded/null value.
+             *
+             * This allows you to always get the ID or load the value manually.
+             *
+             * @example
+             * ```ts
+             * person._refs.pet.id; // => ID<Animal>
+             * person._refs.pet.value;
+             * // => Animal | null
+             * const pet = await person._refs.pet.load();
+             * ```
+             *
+             * @category Content
+             **/
+            readonly _refs: {
+                [x: string]: IfCo<Value, RefIfCoValue<Value>>;
+            };
+            /** @internal */
+            getEditFromRaw(target: CoMap, rawEdit: {
+                by: RawAccountID | AgentID;
+                tx: CojsonInternalTypes.TransactionID;
+                at: Date;
+                value?: JsonValue | undefined;
+            }, descriptor: Schema, key: string): {
+                value: any;
+                ref: Ref<CoValue> | undefined;
+                by: Account | null;
+                madeAt: Date;
+                key: string;
+            };
+            /** @category Collaboration */
+            readonly _edits: {
+                [x: string]: IfCo<Value, LastAndAllCoMapEdits<Value>>;
+            };
+            /**
+             * Return a JSON representation of the `CoMap`
+             * @category Content
+             */
+            toJSON(_key?: string, seenAbove?: ID<CoValue>[]): any[];
+            /**
+             * Create a new `RawCoMap` from an initialization object
+             * @internal
+             */
+            rawFromInit<Fields extends object = Record<string, any>>(init: Simplify<CoMapInit<Fields>> | undefined, owner: Account | Group, uniqueness?: CoValueUniqueness): RawCoMap<{
+                [key: string]: JsonValue | undefined;
+            }, import("cojson").JsonObject | null>;
+            /**
+             * Given an already loaded `CoMap`, ensure that the specified fields are loaded to the specified depth.
+             *
+             * Works like `CoMap.load()`, but you don't need to pass the ID or the account to load as again.
+             *
+             * @category Subscription & Loading
+             */
+            ensureLoaded<M extends CoMap, Depth>(this: M, depth: Depth & DepthsIn<M>): Promise<DeeplyLoaded<M, Depth>>;
+            /**
+             * Given an already loaded `CoMap`, subscribe to updates to the `CoMap` and ensure that the specified fields are loaded to the specified depth.
+             *
+             * Works like `CoMap.subscribe()`, but you don't need to pass the ID or the account to load as again.
+             *
+             * Returns an unsubscribe function that you should call when you no longer need updates.
+             *
+             * @category Subscription & Loading
+             **/
+            subscribe<M extends CoMap, Depth>(this: M, depth: Depth & DepthsIn<M>, listener: (value: DeeplyLoaded<M, Depth>) => void): () => void;
+            applyDiff<N extends Partial<CoMapInit<any>>>(newValues: N): any;
+            /**
+             * Wait for the `CoMap` to be uploaded to the other peers.
+             *
+             * @category Subscription & Loading
+             */
+            waitForSync(options?: {
+                timeout?: number;
+            }): Promise<unknown[]>;
+            [inspect](): any[];
+            _instanceID: string;
+            readonly _owner: Account | Group;
+            readonly _loadedAs: Account | AnonymousJazzAgent;
+            castAs<Cl extends CoValueClass & import("./interfaces.js").CoValueFromRaw<CoValue>>(cl: Cl): InstanceType<Cl>;
+        };
+        /** @internal */
+        _schema: any;
+        /**
+         * Create a new CoMap with the given initial values and owner.
+         *
+         * The owner (a Group or Account) determines access rights to the CoMap.
+         *
+         * The CoMap will immediately be persisted and synced to connected peers.
+         *
+         * @example
+         * ```ts
+         * const person = Person.create({
+         *   name: "Alice",
+         *   age: 42,
+         *   pet: cat,
+         * }, { owner: friendGroup });
+         * ```
+         *
+         * @category Creation
+         **/
+        create<M extends CoMap>(this: CoValueClass<M>, init: Simplify<CoMapInit<M>>, options?: {
+            owner: Account | Group;
+            unique?: CoValueUniqueness["uniqueness"];
+        } | Account | Group): M;
+        Record<Value>(value: IfCo<Value, Value>): any;
+        /**
+         * Load a `CoMap` with a given ID, as a given account.
+         *
+         * `depth` specifies which (if any) fields that reference other CoValues to load as well before resolving.
+         * The `DeeplyLoaded` return type guarantees that corresponding referenced CoValues are loaded to the specified depth.
+         *
+         * You can pass `[]` or `{}` for shallowly loading only this CoMap, or `{ fieldA: depthA, fieldB: depthB }` for recursively loading referenced CoValues.
+         *
+         * Check out the `load` methods on `CoMap`/`CoList`/`CoFeed`/`Group`/`Account` to see which depth structures are valid to nest.
+         *
+         * @example
+         * ```ts
+         * const person = await Person.load(
+         *   "co_zdsMhHtfG6VNKt7RqPUPvUtN2Ax",
+         *   { pet: {} }
+         * );
+         * ```
+         *
+         * @category Subscription & Loading
+         */
+        load<C extends CoMap, Depth>(this: CoValueClass<C>, id: ID<C>, depth: Depth & DepthsIn<C>): Promise<DeeplyLoaded<C, Depth> | undefined>;
+        /**
+         * Load a `CoMap` with a given ID, as a given account.
+         *
+         * `depth` specifies which (if any) fields that reference other CoValues to load as well before resolving.
+         * The `DeeplyLoaded` return type guarantees that corresponding referenced CoValues are loaded to the specified depth.
+         *
+         * You can pass `[]` or `{}` for shallowly loading only this CoMap, or `{ fieldA: depthA, fieldB: depthB }` for recursively loading referenced CoValues.
+         *
+         * Check out the `load` methods on `CoMap`/`CoList`/`CoFeed`/`Group`/`Account` to see which depth structures are valid to nest.
+         *
+         * @example
+         * ```ts
+         * const person = await Person.load(
+         *   "co_zdsMhHtfG6VNKt7RqPUPvUtN2Ax",
+         *   { pet: {} }
+         * );
+         * ```
+         *
+         * @category Subscription & Loading
+         */
+        load<C extends CoMap, Depth>(this: CoValueClass<C>, id: ID<C>, as: Account, depth: Depth & DepthsIn<C>): Promise<DeeplyLoaded<C, Depth> | undefined>;
+        /**
+         * Load and subscribe to a `CoMap` with a given ID, as a given account.
+         *
+         * Automatically also subscribes to updates to all referenced/nested CoValues as soon as they are accessed in the listener.
+         *
+         * `depth` specifies which (if any) fields that reference other CoValues to load as well before calling `listener` for the first time.
+         * The `DeeplyLoaded` return type guarantees that corresponding referenced CoValues are loaded to the specified depth.
+         *
+         * You can pass `[]` or `{}` for shallowly loading only this CoMap, or `{ fieldA: depthA, fieldB: depthB }` for recursively loading referenced CoValues.
+         *
+         * Check out the `load` methods on `CoMap`/`CoList`/`CoFeed`/`Group`/`Account` to see which depth structures are valid to nest.
+         *
+         * Returns an unsubscribe function that you should call when you no longer need updates.
+         *
+         * Also see the `useCoState` hook to reactively subscribe to a CoValue in a React component.
+         *
+         * @example
+         * ```ts
+         * const unsub = Person.subscribe(
+         *   "co_zdsMhHtfG6VNKt7RqPUPvUtN2Ax",
+         *   { pet: {} },
+         *   (person) => console.log(person)
+         * );
+         * ```
+         *
+         * @category Subscription & Loading
+         */
+        subscribe<C extends CoMap, Depth>(this: CoValueClass<C>, id: ID<C>, depth: Depth & DepthsIn<C>, listener: (value: DeeplyLoaded<C, Depth>) => void): () => void;
+        /**
+         * Load and subscribe to a `CoMap` with a given ID, as a given account.
+         *
+         * Automatically also subscribes to updates to all referenced/nested CoValues as soon as they are accessed in the listener.
+         *
+         * `depth` specifies which (if any) fields that reference other CoValues to load as well before calling `listener` for the first time.
+         * The `DeeplyLoaded` return type guarantees that corresponding referenced CoValues are loaded to the specified depth.
+         *
+         * You can pass `[]` or `{}` for shallowly loading only this CoMap, or `{ fieldA: depthA, fieldB: depthB }` for recursively loading referenced CoValues.
+         *
+         * Check out the `load` methods on `CoMap`/`CoList`/`CoFeed`/`Group`/`Account` to see which depth structures are valid to nest.
+         *
+         * Returns an unsubscribe function that you should call when you no longer need updates.
+         *
+         * Also see the `useCoState` hook to reactively subscribe to a CoValue in a React component.
+         *
+         * @example
+         * ```ts
+         * const unsub = Person.subscribe(
+         *   "co_zdsMhHtfG6VNKt7RqPUPvUtN2Ax",
+         *   { pet: {} },
+         *   (person) => console.log(person)
+         * );
+         * ```
+         *
+         * @category Subscription & Loading
+         */
+        subscribe<C extends CoMap, Depth>(this: CoValueClass<C>, id: ID<C>, as: Account, depth: Depth & DepthsIn<C>, listener: (value: DeeplyLoaded<C, Depth>) => void): () => void;
+        findUnique<M extends CoMap>(this: CoValueClass<M>, unique: CoValueUniqueness["uniqueness"], ownerID: ID<Account> | ID<Group>, as?: Account | Group | AnonymousJazzAgent): ID<M>;
+        fromRaw<V extends CoValue>(this: CoValueClass<V>, raw: import("cojson").RawCoValue): V;
+    };
+    /**
+     * Load a `CoMap` with a given ID, as a given account.
+     *
+     * `depth` specifies which (if any) fields that reference other CoValues to load as well before resolving.
+     * The `DeeplyLoaded` return type guarantees that corresponding referenced CoValues are loaded to the specified depth.
+     *
+     * You can pass `[]` or `{}` for shallowly loading only this CoMap, or `{ fieldA: depthA, fieldB: depthB }` for recursively loading referenced CoValues.
+     *
+     * Check out the `load` methods on `CoMap`/`CoList`/`CoFeed`/`Group`/`Account` to see which depth structures are valid to nest.
+     *
+     * @example
+     * ```ts
+     * const person = await Person.load(
+     *   "co_zdsMhHtfG6VNKt7RqPUPvUtN2Ax",
+     *   { pet: {} }
+     * );
+     * ```
+     *
+     * @category Subscription & Loading
+     */
+    static load<C extends CoMap, Depth>(this: CoValueClass<C>, id: ID<C>, depth: Depth & DepthsIn<C>): Promise<DeeplyLoaded<C, Depth> | undefined>;
+    static load<C extends CoMap, Depth>(this: CoValueClass<C>, id: ID<C>, as: Account, depth: Depth & DepthsIn<C>): Promise<DeeplyLoaded<C, Depth> | undefined>;
+    /**
+     * Load and subscribe to a `CoMap` with a given ID, as a given account.
+     *
+     * Automatically also subscribes to updates to all referenced/nested CoValues as soon as they are accessed in the listener.
+     *
+     * `depth` specifies which (if any) fields that reference other CoValues to load as well before calling `listener` for the first time.
+     * The `DeeplyLoaded` return type guarantees that corresponding referenced CoValues are loaded to the specified depth.
+     *
+     * You can pass `[]` or `{}` for shallowly loading only this CoMap, or `{ fieldA: depthA, fieldB: depthB }` for recursively loading referenced CoValues.
+     *
+     * Check out the `load` methods on `CoMap`/`CoList`/`CoFeed`/`Group`/`Account` to see which depth structures are valid to nest.
+     *
+     * Returns an unsubscribe function that you should call when you no longer need updates.
+     *
+     * Also see the `useCoState` hook to reactively subscribe to a CoValue in a React component.
+     *
+     * @example
+     * ```ts
+     * const unsub = Person.subscribe(
+     *   "co_zdsMhHtfG6VNKt7RqPUPvUtN2Ax",
+     *   { pet: {} },
+     *   (person) => console.log(person)
+     * );
+     * ```
+     *
+     * @category Subscription & Loading
+     */
+    static subscribe<C extends CoMap, Depth>(this: CoValueClass<C>, id: ID<C>, depth: Depth & DepthsIn<C>, listener: (value: DeeplyLoaded<C, Depth>) => void): () => void;
+    static subscribe<C extends CoMap, Depth>(this: CoValueClass<C>, id: ID<C>, as: Account, depth: Depth & DepthsIn<C>, listener: (value: DeeplyLoaded<C, Depth>) => void): () => void;
+    static findUnique<M extends CoMap>(this: CoValueClass<M>, unique: CoValueUniqueness["uniqueness"], ownerID: ID<Account> | ID<Group>, as?: Account | Group | AnonymousJazzAgent): ID<M>;
+    /**
+     * Given an already loaded `CoMap`, ensure that the specified fields are loaded to the specified depth.
+     *
+     * Works like `CoMap.load()`, but you don't need to pass the ID or the account to load as again.
+     *
+     * @category Subscription & Loading
+     */
+    ensureLoaded<M extends CoMap, Depth>(this: M, depth: Depth & DepthsIn<M>): Promise<DeeplyLoaded<M, Depth>>;
+    /**
+     * Given an already loaded `CoMap`, subscribe to updates to the `CoMap` and ensure that the specified fields are loaded to the specified depth.
+     *
+     * Works like `CoMap.subscribe()`, but you don't need to pass the ID or the account to load as again.
+     *
+     * Returns an unsubscribe function that you should call when you no longer need updates.
+     *
+     * @category Subscription & Loading
+     **/
+    subscribe<M extends CoMap, Depth>(this: M, depth: Depth & DepthsIn<M>, listener: (value: DeeplyLoaded<M, Depth>) => void): () => void;
+    applyDiff<N extends Partial<CoMapInit<this>>>(newValues: N): this;
+    /**
+     * Wait for the `CoMap` to be uploaded to the other peers.
+     *
+     * @category Subscription & Loading
+     */
+    waitForSync(options?: {
+        timeout?: number;
+    }): Promise<unknown[]>;
+}
+export type CoKeys<Map extends object> = Exclude<keyof Map & string, keyof CoMap>;
+/**
+ * Force required ref fields to be non nullable
+ *
+ * Considering that:
+ * - Optional refs are typed as co<InstanceType<CoValueClass> | null | undefined>
+ * - Required refs are typed as co<InstanceType<CoValueClass> | null>
+ *
+ * This type works in two steps:
+ * - Remove the null from both types
+ * - Then we check if the input type accepts undefined, if positive we put the null union back
+ *
+ * So the optional refs stays unchanged while we safely remove the null union
+ * from required refs
+ *
+ * This way required refs can be marked as required in the CoMapInit while
+ * staying a nullable property for value access.
+ *
+ * Example:
+ *
+ * const map = MyCoMap.create({
+ *   requiredRef: NestedMap.create({}) // null is not valid here
+ * })
+ *
+ * map.requiredRef // this value is still nullable
+ */
+type ForceRequiredRef<V> = V extends co<InstanceType<CoValueClass> | null> ? NonNullable<V> : V extends co<InstanceType<CoValueClass> | undefined> ? V | null : V;
+export type CoMapInit<Map extends object> = {
+    [Key in CoKeys<Map> as undefined extends Map[Key] ? never : IfCo<Map[Key], Key>]: ForceRequiredRef<Map[Key]>;
+} & {
+    [Key in CoKeys<Map> as IfCo<Map[Key], Key>]?: ForceRequiredRef<Map[Key]>;
+};
+export {};
+//# sourceMappingURL=coMap.d.ts.map

package/dist/coValues/coMap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"coMap.d.ts","sourceRoot":"","sources":["../../src/coValues/coMap.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,KAAK,iBAAiB,EACtB,mBAAmB,EACnB,KAAK,SAAS,EACd,YAAY,EACZ,KAAK,QAAQ,EAEd,MAAM,QAAQ,CAAC;AAEhB,OAAO,KAAK,EACV,kBAAkB,EAClB,OAAO,EACP,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,EAAE,EACF,IAAI,EAEJ,YAAY,EACZ,MAAM,EACN,EAAE,EACH,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,WAAW,EACX,QAAQ,EACR,GAAG,EAGH,OAAO,EAQR,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,YAAY,CAAC;AAGxC,KAAK,SAAS,CAAC,CAAC,IAAI;IAClB,KAAK,CAAC,EAAE,CAAC,CAAC;IACV,GAAG,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IACtB,EAAE,CAAC,EAAE,OAAO,CAAC;IACb,MAAM,EAAE,IAAI,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,KAAK,oBAAoB,CAAC,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,GAAG;IAAE,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAA;CAAE,CAAC;AAEtE,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI;KACvB,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACrB,SAAS,MAAM,CAAC,GACb,CAAC,GACD,KAAK,CAAC;AAEV;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAgCM;AACN,qBAAa,KAAM,SAAQ,WAAY,YAAW,OAAO;IACvD;;2BAEuB;IACf,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;IACrB,6BAA6B;IACrB,KAAK,EAAE,OAAO,CAAC;IAIvB,0BAA0B;IAClB,IAAI,EAAE,QAAQ,CAAC;IAEvB,gBAAgB;IAEhB,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC;IACpB,gBAAgB;IAChB,IAAI,OAAO,IAC4C;QACnD,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KACvB,GAAG;QAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAC5B;IAED;;;;;;;;;;;;;;;QAeI;IACJ,IAAI,KAAK,IAAI;SACV,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;KAChE,CAkBA;IAED,gBAAgB;IACT,cAAc,CACnB,MAAM,EAAE,KAAK,EACb,OAAO,EAAE;QACP,EAAE,EAAE,YAAY,GAAG,OAAO,CAAC;QAC3B,EAAE,EAAE,mBAAmB,CAAC,aAAa,CAAC;QACtC,EAAE,EAAE,IAAI,CAAC;QACT,KAAK,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;KAC/B,EACD,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,MAAM;;;;;;;IA8Bb,8BAA8B;IAC9B,IAAI,MAAM,IAkCH,GACF,GAAmB,IAAZ,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GACxE,CACF;IAED,gBAAgB;gBAGd,OAAO,EAAE;QAAE,OAAO,EAAE,QAAQ,CAAA;KAAE,GAAG,SAAS;IAqB5C;;;;;;;;;;;;;;;;;QAiBI;IACJ,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,KAAK,EAC3B,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,IAAI,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAC5B,OAAO,CAAC,EACJ;QACE,KAAK,EAAE,OAAO,GAAG,KAAK,CAAC;QACvB,MAAM,CAAC,EAAE,iBAAiB,CAAC,YAAY,CAAC,CAAC;KAC1C,GACD,OAAO,GACP,KAAK;IAiBX;;;OAGG;IAEH,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,GAAG,EAAE;IAgCvD,CAAC,OAAO,CAAC;IAIT;;;OAGG;IAEH,WAAW,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACrD,IAAI,EAAE,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,SAAS,EAC7C,KAAK,EAAE,OAAO,GAAG,KAAK,EACtB,UAAU,CAAC,EAAE,iBAAiB;;;IAoChC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC;sBAxKnC;YAAE,OAAO,EAAE,QAAQ,CAAA;SAAE,GAAG,SAAS;;;YA/I5C;;mCAEuB;;YAEvB,6BAA6B;mBACd,OAAO;YAItB,0BAA0B;kBACZ,QAAQ;YAKtB,gBAAgB;;;;0BAIK,MAAM;;YAG3B;;;;;;;;;;;;;;;gBAeI;;;;YAuBJ,gBAAgB;mCAEN,KAAK,WACJ;gBACP,EAAE,EAAE,YAAY,GAAG,OAAO,CAAC;gBAC3B,EAAE,EAAE,mBAAmB,CAAC,aAAa,CAAC;gBACtC,EAAE,EAAE,IAAI,CAAC;gBACT,KAAK,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;aAC/B,cACW,MAAM,OACb,MAAM;;;;;;;YA8Bb,8BAA8B;;;;YA4G9B;;;eAGG;0BAEW,MAAM,cAAc,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,GAAG,EAAE;YAoCvD;;;eAGG;wBAES,MAAM,SAAS,MAAM,8EAExB,OAAO,GAAG,KAAK,eACT,iBAAiB;;;YAyLhC;;;;;;eAMG;yBACU,CAAC,SAAS,KAAK,EAAE,KAAK,QAC3B,CAAC,SACA,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,GACzB,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAIlC;;;;;;;;gBAQI;sBACM,CAAC,SAAS,KAAK,EAAE,KAAK,QACxB,CAAC,SACA,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,YAChB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,IAAI,GAChD,MAAM,IAAI;sBAIH,CAAC;YA8BX;;;;eAIG;kCACmB;gBAAE,OAAO,CAAC,EAAE,MAAM,CAAA;aAAE;;;;;;;QAhf1C,gBAAgB;iBAEA,GAAG;QAsJnB;;;;;;;;;;;;;;;;;YAiBI;eACU,CAAC,SAAS,KAAK,QACrB,YAAY,CAAC,CAAC,CAAC,QACf,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,YAExB;YACE,KAAK,EAAE,OAAO,GAAG,KAAK,CAAC;YACvB,MAAM,CAAC,EAAE,iBAAiB,CAAC,YAAY,CAAC,CAAC;SAC1C,GACD,OAAO,GACP,KAAK;eAwHG,KAAK,SAAS,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC;QAW9C;;;;;;;;;;;;;;;;;;;WAmBG;aACS,CAAC,SAAS,KAAK,EAAE,KAAK,QAC1B,YAAY,CAAC,CAAC,CAAC,MACjB,EAAE,CAAC,CAAC,CAAC,SACF,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,GACzB,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,SAAS,CAAC;QAxB9C;;;;;;;;;;;;;;;;;;;WAmBG;aAMS,CAAC,SAAS,KAAK,EAAE,KAAK,QAC1B,YAAY,CAAC,CAAC,CAAC,MACjB,EAAE,CAAC,CAAC,CAAC,MACL,OAAO,SACJ,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,GACzB,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,SAAS,CAAC;QAU9C;;;;;;;;;;;;;;;;;;;;;;;;;;WA0BG;kBACc,CAAC,SAAS,KAAK,EAAE,KAAK,QAC/B,YAAY,CAAC,CAAC,CAAC,MACjB,EAAE,CAAC,CAAC,CAAC,SACF,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,YAChB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,IAAI,GAChD,MAAM,IAAI;QAhCb;;;;;;;;;;;;;;;;;;;;;;;;;;WA0BG;kBAOc,CAAC,SAAS,KAAK,EAAE,KAAK,QAC/B,YAAY,CAAC,CAAC,CAAC,MACjB,EAAE,CAAC,CAAC,CAAC,MACL,OAAO,SACJ,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,YAChB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,IAAI,GAChD,MAAM,IAAI;mBAmBK,CAAC,SAAS,KAAK,QACzB,YAAY,CAAC,CAAC,CAAC,UACb,iBAAiB,CAAC,YAAY,CAAC,WAC9B,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,OAC3B,OAAO,GAAG,KAAK,GAAG,kBAAkB,GAea,EAAE,CAAC,CAAC,CAAC;;;IArH7D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,KAAK,EAAE,KAAK,EAChC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EACT,KAAK,EAAE,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,GACzB,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,SAAS,CAAC;IAC9C,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,KAAK,EAAE,KAAK,EAChC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EACT,EAAE,EAAE,OAAO,EACX,KAAK,EAAE,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,GACzB,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,SAAS,CAAC;IAU9C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,KAAK,EAAE,KAAK,EACrC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EACT,KAAK,EAAE,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,EAC1B,QAAQ,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,IAAI,GAChD,MAAM,IAAI;IACb,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,KAAK,EAAE,KAAK,EACrC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EACT,EAAE,EAAE,OAAO,EACX,KAAK,EAAE,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,EAC1B,QAAQ,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,IAAI,GAChD,MAAM,IAAI;IAmBb,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,KAAK,EAC/B,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,MAAM,EAAE,iBAAiB,CAAC,YAAY,CAAC,EACvC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,EAChC,EAAE,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,kBAAkB,GAea,EAAE,CAAC,CAAC,CAAC;IAG7D;;;;;;OAMG;IACH,YAAY,CAAC,CAAC,SAAS,KAAK,EAAE,KAAK,EACjC,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,GACzB,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAIlC;;;;;;;;QAQI;IACJ,SAAS,CAAC,CAAC,SAAS,KAAK,EAAE,KAAK,EAC9B,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,EAC1B,QAAQ,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,IAAI,GAChD,MAAM,IAAI;IAIb,SAAS,CAAC,CAAC,SAAS,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC;IA8B1D;;;;OAIG;IACH,WAAW,CAAC,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE;CAG3C;AAED,MAAM,MAAM,MAAM,CAAC,GAAG,SAAS,MAAM,IAAI,OAAO,CAC9C,MAAM,GAAG,GAAG,MAAM,EAClB,MAAM,KAAK,CACZ,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,KAAK,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,YAAY,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,GACtE,WAAW,CAAC,CAAC,CAAC,GACd,CAAC,SAAS,EAAE,CAAC,YAAY,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,GAClD,CAAC,GAAG,IAAI,GACR,CAAC,CAAC;AAER,MAAM,MAAM,SAAS,CAAC,GAAG,SAAS,MAAM,IAAI;KACzC,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,IAAI,SAAS,SAAS,GAAG,CAAC,GAAG,CAAC,GAC7C,KAAK,GACL,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,GAAG,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CACrD,GAAG;KACD,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CACzE,CAAC"}

package/dist/coValues/coPlainText.d.ts

@@ -0,0 +1,69 @@
+import { type OpID, type RawCoPlainText } from "cojson";
+import type { CoValue, CoValueClass, ID } from "../internal.js";
+import { inspect } from "../internal.js";
+import { Account } from "./account.js";
+import { Group } from "./group.js";
+export type TextPos = OpID;
+export declare class CoPlainText extends String implements CoValue {
+    id: ID<this>;
+    _type: "CoPlainText";
+    _raw: RawCoPlainText;
+    get _owner(): Account | Group;
+    get _loadedAs(): Account;
+    constructor(options: {
+        fromRaw: RawCoPlainText;
+    } | {
+        text: string;
+        owner: Account | Group;
+    });
+    static create<T extends CoPlainText>(this: CoValueClass<T>, text: string, options: {
+        owner: Account | Group;
+    }): T;
+    get length(): number;
+    toString(): string;
+    valueOf(): string;
+    toJSON(): string;
+    [inspect](): string;
+    insertAfter(idx: number, text: string): void;
+    deleteRange(range: {
+        from: number;
+        to: number;
+    }): void;
+    posBefore(idx: number): TextPos | undefined;
+    posAfter(idx: number): TextPos | undefined;
+    idxBefore(pos: TextPos): number | undefined;
+    idxAfter(pos: TextPos): number | undefined;
+    static fromRaw<V extends CoPlainText>(this: CoValueClass<V> & typeof CoPlainText, raw: RawCoPlainText): V & CoPlainText;
+    /**
+     * Load a `CoPlainText` with a given ID, as a given account.
+     *
+     * @category Subscription & Loading
+     */
+    static load<T extends CoPlainText>(this: CoValueClass<T>, id: ID<T>, as?: Account): Promise<T | undefined>;
+    /**
+     * Load and subscribe to a `CoPlainText` with a given ID, as a given account.
+     *
+     * Automatically also subscribes to updates to all referenced/nested CoValues as soon as they are accessed in the listener.
+     *
+     * Check out the `load` methods on `CoMap`/`CoList`/`CoStream`/`Group`/`Account` to see which depth structures are valid to nest.
+     *
+     * Returns an unsubscribe function that you should call when you no longer need updates.
+     *
+     * Also see the `useCoState` hook to reactively subscribe to a CoValue in a React component.
+     *
+     * @category Subscription & Loading
+     */
+    static subscribe<T extends CoPlainText>(this: CoValueClass<T>, id: ID<T>, listener: (value: T) => void): () => void;
+    static subscribe<T extends CoPlainText>(this: CoValueClass<T>, id: ID<T>, as: Account, listener: (value: T) => void): () => void;
+    /**
+     * Given an already loaded `CoPlainText`, subscribe to updates to the `CoPlainText` and ensure that the specified fields are loaded to the specified depth.
+     *
+     * Works like `CoPlainText.subscribe()`, but you don't need to pass the ID or the account to load as again.
+     *
+     * Returns an unsubscribe function that you should call when you no longer need updates.
+     *
+     * @category Subscription & Loading
+     **/
+    subscribe<T extends CoPlainText>(this: T, listener: (value: T) => void): () => void;
+}
+//# sourceMappingURL=coPlainText.d.ts.map

package/dist/coValues/coPlainText.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"coPlainText.d.ts","sourceRoot":"","sources":["../../src/coValues/coPlainText.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,IAAI,EAET,KAAK,cAAc,EAEpB,MAAM,QAAQ,CAAC;AAEhB,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAChE,OAAO,EACL,OAAO,EAKR,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEnC,MAAM,MAAM,OAAO,GAAG,IAAI,CAAC;AAE3B,qBAAa,WAAY,SAAQ,MAAO,YAAW,OAAO;IAChD,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;IACb,KAAK,EAAE,aAAa,CAAC;IACrB,IAAI,EAAE,cAAc,CAAC;IAE7B,IAAI,MAAM,IAAI,OAAO,GAAG,KAAK,CAI5B;IAED,IAAI,SAAS,YAEZ;gBAGC,OAAO,EACH;QAAE,OAAO,EAAE,cAAc,CAAA;KAAE,GAC3B;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,OAAO,GAAG,KAAK,CAAA;KAAE;IAmB9C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,WAAW,EACjC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE;QAAE,KAAK,EAAE,OAAO,GAAG,KAAK,CAAA;KAAE;IAKrC,IAAI,MAAM,WAET;IAED,QAAQ;IAIR,OAAO;IAIP,MAAM,IAAI,MAAM;IAIhB,CAAC,OAAO,CAAC;IAIT,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAIrC,WAAW,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE;IAI/C,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAI3C,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAI1C,SAAS,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IAI3C,QAAQ,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IAI1C,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,WAAW,EAClC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,WAAW,EAC1C,GAAG,EAAE,cAAc;IAKrB;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,WAAW,EAC/B,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EACT,EAAE,CAAC,EAAE,OAAO,GACX,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAkBzB;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,WAAW,EACpC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EACT,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,GAC3B,MAAM,IAAI;IACb,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,WAAW,EACpC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EACT,EAAE,EAAE,OAAO,EACX,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,GAC3B,MAAM,IAAI;IAkCb;;;;;;;;QAQI;IACJ,SAAS,CAAC,CAAC,SAAS,WAAW,EAC7B,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,GAC3B,MAAM,IAAI;CAGd"}