cojson 0.4.1 → 0.4.5

package/src/localNode.ts

@@ -17,14 +17,12 @@ import {
 import {
     InviteSecret,
     Group,
-    GroupShape,
     expectGroup,
     secretSeedFromInviteSecret,
 } from "./coValues/group.js";
 import { Peer, SyncManager } from "./sync.js";
 import { AgentID, RawCoID, SessionID, isAgentID } from "./ids.js";
 import { CoID } from "./coValue.js";
-import { Queried, query } from "./queries.js";
 import {
     Account,
     AccountMeta,
@@ -34,12 +32,10 @@ import {
     AnonymousControlledAccount,
     AccountID,
     Profile,
-    isAccountID,
     AccountMigration,
 } from "./coValues/account.js";
 import { CoMap } from "./coValues/coMap.js";
 import { CoValue } from "./index.js";
-import { QueriedAccount } from "./queriedCoValues/queriedAccount.js";
 
 /** A `LocalNode` represents a local view of a set of loaded `CoValue`s, from the perspective of a particular account (or primitive cryptographic agent).
 
@@ -103,7 +99,8 @@ export class LocalNode {
             newRandomSessionID(account.id)
         );
 
-        const accountOnNodeWithAccount = nodeWithAccount.account as ControlledAccount<P, R, Meta>;
+        const accountOnNodeWithAccount =
+            nodeWithAccount.account as ControlledAccount<P, R, Meta>;
 
         const profile = nodeWithAccount.expectProfileLoaded(
             accountOnNodeWithAccount.id,
@@ -256,47 +253,6 @@ export class LocalNode {
         };
     }
 
-    /** @category 1. High-level */
-
-    query<T extends CoValue>(
-        id: CoID<T>,
-        callback: (update: Queried<T> | undefined) => void
-    ): () => void;
-    query<
-        P extends Profile = Profile,
-        R extends CoMap = CoMap,
-        Meta extends AccountMeta = AccountMeta
-    >(
-        id: "me",
-        callback: (
-            update: QueriedAccount<Account<P, R, Meta>> | undefined
-        ) => void
-    ): () => void;
-    query(
-        id: CoID<CoValue> | "me",
-        callback: (
-            update: Queried<CoValue> | QueriedAccount | undefined
-        ) => void
-    ): () => void;
-    query(
-        id: CoID<CoValue> | "me",
-        callback: (
-            // TODO: sort this out
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            update: any
-        ) => void
-    ): () => void {
-        if (id === "me") {
-            const meId = this.account.id;
-            if (!isAccountID(meId)) {
-                throw new Error("Can only query 'me' for accounts");
-            }
-            return query(meId, this, callback);
-        } else {
-            return query(id, this, callback);
-        }
-    }
-
     /** @deprecated Use Account.acceptInvite instead */
     async acceptInvite<T extends CoValue>(
         groupOrOwnedValueID: CoID<T>,
@@ -601,7 +557,10 @@ export class LocalNode {
 
         if (account instanceof ControlledAccount) {
             // To make sure that when we edit the account, we're modifying the correct sessions
-            const accountInNode = new ControlledAccount(newNode.expectCoValueLoaded(account.id), account.agentSecret);
+            const accountInNode = new ControlledAccount(
+                newNode.expectCoValueLoaded(account.id),
+                account.agentSecret
+            );
             if (accountInNode.core.node !== newNode) {
                 throw new Error("Account's node is not the new node");
             }

package/src/tests/coValue.test.ts

@@ -315,14 +315,14 @@ test("Empty BinaryCoStream works", () => {
 
     if (
         content.type !== "costream" ||
-        content.meta?.type !== "binary" ||
+        content.headerMeta?.type !== "binary" ||
         !(content instanceof BinaryCoStream)
     ) {
         throw new Error("Expected binary stream");
     }
 
     expect(content.type).toEqual("costream");
-    expect(content.meta.type).toEqual("binary");
+    expect(content.headerMeta.type).toEqual("binary");
     expect(content.toJSON()).toEqual({});
     expect(content.getBinaryChunks()).toEqual(undefined);
 });
@@ -341,7 +341,7 @@ test("Can push into BinaryCoStream", () => {
 
     if (
         content.type !== "costream" ||
-        content.meta?.type !== "binary" ||
+        content.headerMeta?.type !== "binary" ||
         !(content instanceof BinaryCoStream)
     ) {
         throw new Error("Expected binary stream");
@@ -398,7 +398,7 @@ test("When adding large transactions (small fraction of MAX_RECOMMENDED_TX_SIZE)
 
     if (
         content.type !== "costream" ||
-        content.meta?.type !== "binary" ||
+        content.headerMeta?.type !== "binary" ||
         !(content instanceof BinaryCoStream)
     ) {
         throw new Error("Expected binary stream");
@@ -474,7 +474,7 @@ test("When adding large transactions (bigger than MAX_RECOMMENDED_TX_SIZE), we s
 
     if (
         content.type !== "costream" ||
-        content.meta?.type !== "binary" ||
+        content.headerMeta?.type !== "binary" ||
         !(content instanceof BinaryCoStream)
     ) {
         throw new Error("Expected binary stream");

package/src/tests/group.test.ts

@@ -46,6 +46,6 @@ test("Can create a BinaryCoStream in a group", () => {
     const stream = group.createBinaryStream();
 
     expect(stream.core.getCurrentContent().type).toEqual("costream");
-    expect(stream.meta.type).toEqual("binary");
+    expect(stream.headerMeta.type).toEqual("binary");
     expect(stream instanceof BinaryCoStream).toEqual(true);
 })

package/dist/base64url.d.ts

@@ -1,2 +0,0 @@
-export declare function base64URLtoBytes(base64: string): Uint8Array;
-export declare function bytesToBase64url(bytes: Uint8Array): string;

package/dist/coValue.d.ts

@@ -1,38 +0,0 @@
-import { JsonObject, JsonValue } from "./jsonValue.js";
-import { RawCoID } from "./ids.js";
-import { CoMap } from "./coValues/coMap.js";
-import { BinaryCoStream, CoStream } from "./coValues/coStream.js";
-import { CoList } from "./coValues/coList.js";
-import { CoValueCore } from "./coValueCore.js";
-import { Group } from "./coValues/group.js";
-import { Account, Profile } from "./index.js";
-export type CoID<T extends CoValue> = RawCoID & {
-    readonly __type: T;
-};
-export interface CoValue {
-    /** The `CoValue`'s (precisely typed) `CoID` */
-    id: CoID<this>;
-    core: CoValueCore;
-    /** Specifies which kind of `CoValue` this is */
-    type: string;
-    /** The `CoValue`'s (precisely typed) static metadata */
-    meta: JsonObject | null;
-    /** The `Group` this `CoValue` belongs to (determining permissions) */
-    group: Group;
-    /** Returns an immutable JSON presentation of this `CoValue` */
-    toJSON(): JsonValue;
-    atTime(time: number): this;
-    /** Lets you subscribe to future updates to this CoValue (whether made locally or by other users).
-     *
-     * Takes a listener function that will be called with the current state for each update.
-     *
-     * Returns an unsubscribe function.
-     *
-     * Used internally by `useTelepathicData()` for reactive updates on changes to a `CoValue`. */
-    subscribe(listener: (coValue: this) => void): () => void;
-}
-export type AnyCoValue = CoMap | Group | Account | Profile | CoList | CoStream | BinaryCoStream;
-export declare function expectMap(content: CoValue): CoMap;
-export declare function expectList(content: CoValue): CoList;
-export declare function expectStream(content: CoValue): CoStream;
-export declare function isCoValue(value: JsonValue | CoValue | undefined): value is CoValue;

package/dist/coValueCore.d.ts

@@ -1,103 +0,0 @@
-import { AnyCoValue, CoValue } from "./coValue.js";
-import { Encrypted, Hash, KeySecret, Signature, StreamingHash, KeyID } from "./crypto.js";
-import { JsonObject, JsonValue } from "./jsonValue.js";
-import { PermissionsDef as RulesetDef } from "./permissions.js";
-import { Group } from "./coValues/group.js";
-import { LocalNode } from "./localNode.js";
-import { CoValueKnownState, NewContentMessage } from "./sync.js";
-import { AgentID, RawCoID, SessionID, TransactionID } from "./ids.js";
-import { AccountID, GeneralizedControlledAccount } from "./coValues/account.js";
-import { Stringified } from "./jsonStringify.js";
-export declare const MAX_RECOMMENDED_TX_SIZE: number;
-export type CoValueHeader = {
-    type: AnyCoValue["type"];
-    ruleset: RulesetDef;
-    meta: JsonObject | null;
-    createdAt: `2${string}` | null;
-    uniqueness: `z${string}` | null;
-};
-export declare function idforHeader(header: CoValueHeader): RawCoID;
-export declare function accountOrAgentIDfromSessionID(sessionID: SessionID): AccountID | AgentID;
-export declare function newRandomSessionID(accountID: AccountID | AgentID): SessionID;
-type SessionLog = {
-    transactions: Transaction[];
-    lastHash?: Hash;
-    streamingHash: StreamingHash;
-    signatureAfter: {
-        [txIdx: number]: Signature | undefined;
-    };
-    lastSignature: Signature;
-};
-export type PrivateTransaction = {
-    privacy: "private";
-    madeAt: number;
-    keyUsed: KeyID;
-    encryptedChanges: Encrypted<JsonValue[], {
-        in: RawCoID;
-        tx: TransactionID;
-    }>;
-};
-export type TrustingTransaction = {
-    privacy: "trusting";
-    madeAt: number;
-    changes: Stringified<JsonValue[]>;
-};
-export type Transaction = PrivateTransaction | TrustingTransaction;
-export type DecryptedTransaction = {
-    txID: TransactionID;
-    changes: Stringified<JsonValue[]>;
-    madeAt: number;
-};
-export declare class CoValueCore {
-    id: RawCoID;
-    node: LocalNode;
-    header: CoValueHeader;
-    _sessions: {
-        [key: SessionID]: SessionLog;
-    };
-    _cachedContent?: CoValue;
-    listeners: Set<(content?: CoValue) => void>;
-    _decryptionCache: {
-        [key: Encrypted<JsonValue[], JsonValue>]: Stringified<JsonValue[]> | undefined;
-    };
-    constructor(header: CoValueHeader, node: LocalNode, internalInitSessions?: {
-        [key: SessionID]: SessionLog;
-    });
-    get sessions(): Readonly<{
-        [key: SessionID]: SessionLog;
-    }>;
-    testWithDifferentAccount(account: GeneralizedControlledAccount, currentSessionID: SessionID): CoValueCore;
-    knownState(): CoValueKnownState;
-    get meta(): JsonValue;
-    nextTransactionID(): TransactionID;
-    tryAddTransactions(sessionID: SessionID, newTransactions: Transaction[], givenExpectedNewHash: Hash | undefined, newSignature: Signature): boolean;
-    tryAddTransactionsAsync(sessionID: SessionID, newTransactions: Transaction[], givenExpectedNewHash: Hash | undefined, newSignature: Signature): Promise<boolean>;
-    private doAddTransactions;
-    subscribe(listener: (content?: CoValue) => void): () => void;
-    expectedNewHashAfter(sessionID: SessionID, newTransactions: Transaction[]): {
-        expectedNewHash: Hash;
-        newStreamingHash: StreamingHash;
-    };
-    expectedNewHashAfterAsync(sessionID: SessionID, newTransactions: Transaction[]): Promise<{
-        expectedNewHash: Hash;
-        newStreamingHash: StreamingHash;
-    }>;
-    makeTransaction(changes: JsonValue[], privacy: "private" | "trusting"): boolean;
-    getCurrentContent(options?: {
-        ignorePrivateTransactions: true;
-    }): CoValue;
-    getValidSortedTransactions(options?: {
-        ignorePrivateTransactions: true;
-    }): DecryptedTransaction[];
-    getCurrentReadKey(): {
-        secret: KeySecret | undefined;
-        id: KeyID;
-    };
-    getReadKey(keyID: KeyID): KeySecret | undefined;
-    getUncachedReadKey(keyID: KeyID): KeySecret | undefined;
-    getGroup(): Group;
-    getTx(txID: TransactionID): Transaction | undefined;
-    newContentSince(knownState: CoValueKnownState | undefined): NewContentMessage[] | undefined;
-    getDependedOnCoValues(): RawCoID[];
-}
-export {};

package/dist/coValues/account.d.ts

@@ -1,62 +0,0 @@
-import { CoValueCore, CoValueHeader } from "../coValueCore.js";
-import { CoID, CoValue } from "../coValue.js";
-import { AgentSecret, SealerID, SealerSecret, SignerID, SignerSecret } from "../crypto.js";
-import { AgentID } from "../ids.js";
-import { CoMap } from "./coMap.js";
-import { Group, InviteSecret } from "./group.js";
-export declare function accountHeaderForInitialAgentSecret(agentSecret: AgentSecret): CoValueHeader;
-export declare class Account<P extends Profile = Profile, R extends CoMap = CoMap, Meta extends AccountMeta = AccountMeta> extends Group<P, R, Meta> {
-    getCurrentAgentID(): AgentID;
-}
-export interface GeneralizedControlledAccount {
-    id: AccountID | AgentID;
-    agentSecret: AgentSecret;
-    currentAgentID: () => AgentID;
-    currentSignerID: () => SignerID;
-    currentSignerSecret: () => SignerSecret;
-    currentSealerID: () => SealerID;
-    currentSealerSecret: () => SealerSecret;
-}
-/** @hidden */
-export declare class ControlledAccount<P extends Profile = Profile, R extends CoMap = CoMap, Meta extends AccountMeta = AccountMeta> extends Account<P, R, Meta> implements GeneralizedControlledAccount {
-    agentSecret: AgentSecret;
-    constructor(core: CoValueCore, agentSecret: AgentSecret);
-    /**
-     * Creates a new group (with the current account as the group's first admin).
-     * @category 1. High-level
-     */
-    createGroup(): Group<Profile<ProfileShape, ProfileMeta>, CoMap<{
-        [key: string]: import("../jsonValue.js").JsonValue | undefined;
-    }, import("../jsonValue.js").JsonObject | null>, import("../jsonValue.js").JsonObject | null>;
-    acceptInvite<T extends CoValue>(groupOrOwnedValueID: CoID<T>, inviteSecret: InviteSecret): Promise<void>;
-    currentAgentID(): AgentID;
-    currentSignerID(): SignerID;
-    currentSignerSecret(): SignerSecret;
-    currentSealerID(): SealerID;
-    currentSealerSecret(): SealerSecret;
-}
-/** @hidden */
-export declare class AnonymousControlledAccount implements GeneralizedControlledAccount {
-    agentSecret: AgentSecret;
-    constructor(agentSecret: AgentSecret);
-    get id(): AgentID;
-    currentAgentID(): AgentID;
-    currentSignerID(): SignerID;
-    currentSignerSecret(): SignerSecret;
-    currentSealerID(): SealerID;
-    currentSealerSecret(): SealerSecret;
-}
-export type AccountMeta = {
-    type: "account";
-};
-export type AccountID = CoID<Account>;
-export declare function isAccountID(id: AccountID | AgentID): id is AccountID;
-export type ProfileShape = {
-    name: string;
-};
-export type ProfileMeta = {
-    type: "profile";
-};
-export declare class Profile<Shape extends ProfileShape = ProfileShape, Meta extends ProfileMeta = ProfileMeta> extends CoMap<Shape, Meta> {
-}
-export type AccountMigration<P extends Profile = Profile, R extends CoMap = CoMap, Meta extends AccountMeta = AccountMeta> = (account: ControlledAccount<P, R, Meta>, profile: P) => void;

package/dist/coValues/coList.d.ts

@@ -1,179 +0,0 @@
-import { JsonObject, JsonValue } from "../jsonValue.js";
-import { CoID, CoValue } from "../coValue.js";
-import { CoValueCore } from "../coValueCore.js";
-import { AgentID, SessionID, TransactionID } from "../ids.js";
-import { AccountID } from "./account.js";
-import { Group } from "./group.js";
-type OpID = TransactionID & {
-    changeIdx: number;
-};
-type InsertionOpPayload<T extends JsonValue> = {
-    op: "pre";
-    value: T;
-    before: OpID | "end";
-} | {
-    op: "app";
-    value: T;
-    after: OpID | "start";
-};
-type DeletionOpPayload = {
-    op: "del";
-    insertion: OpID;
-};
-export type ListOpPayload<T extends JsonValue> = InsertionOpPayload<T> | DeletionOpPayload;
-type InsertionEntry<T extends JsonValue> = {
-    madeAt: number;
-    predecessors: OpID[];
-    successors: OpID[];
-} & InsertionOpPayload<T>;
-type DeletionEntry = {
-    madeAt: number;
-    deletionID: OpID;
-} & DeletionOpPayload;
-export declare class CoListView<Item extends JsonValue = JsonValue, Meta extends JsonObject | null = null> implements CoValue {
-    /** @category 6. Meta */
-    id: CoID<this>;
-    /** @category 6. Meta */
-    type: "colist";
-    /** @category 6. Meta */
-    core: CoValueCore;
-    /** @internal */
-    afterStart: OpID[];
-    /** @internal */
-    beforeEnd: OpID[];
-    /** @internal */
-    insertions: {
-        [sessionID: SessionID]: {
-            [txIdx: number]: {
-                [changeIdx: number]: InsertionEntry<Item>;
-            };
-        };
-    };
-    /** @internal */
-    deletionsByInsertion: {
-        [deletedSessionID: SessionID]: {
-            [deletedTxIdx: number]: {
-                [deletedChangeIdx: number]: DeletionEntry[];
-            };
-        };
-    };
-    /** @category 6. Meta */
-    readonly _item: Item;
-    /** @internal */
-    constructor(core: CoValueCore);
-    /** @category 6. Meta */
-    get meta(): Meta;
-    /** @category 6. Meta */
-    get group(): Group;
-    /**
-     * Not yet implemented
-     *
-     * @category 4. Time travel
-     */
-    atTime(_time: number): this;
-    /**
-     * Get the item currently at `idx`.
-     *
-     * @category 1. Reading
-     */
-    get(idx: number): Item | undefined;
-    /**
-     * Returns the current items in the CoList as an array.
-     *
-     * @category 1. Reading
-     **/
-    asArray(): Item[];
-    /** @internal */
-    entries(): {
-        value: Item;
-        madeAt: number;
-        opID: OpID;
-    }[];
-    /** @internal */
-    private fillArrayFromOpID;
-    /**
-     * Returns the current items in the CoList as an array. (alias of `asArray`)
-     *
-     * @category 1. Reading
-     */
-    toJSON(): Item[];
-    /** @category 5. Edit history */
-    editAt(idx: number): {
-        by: AccountID | AgentID;
-        tx: TransactionID;
-        at: Date;
-        value: Item;
-    } | undefined;
-    /** @category 5. Edit history */
-    deletionEdits(): {
-        by: AccountID | AgentID;
-        tx: TransactionID;
-        at: Date;
-    }[];
-    /** @category 3. Subscription */
-    subscribe(listener: (coList: this) => void): () => void;
-}
-export declare class CoList<Item extends JsonValue = JsonValue, Meta extends JsonObject | null = JsonObject | null> extends CoListView<Item, Meta> implements CoValue {
-    /** Returns a new version of this CoList with `item` appended after the item currently at index `after`.
-     *
-     * If `privacy` is `"private"` **(default)**, `item` is encrypted in the transaction, only readable by other members of the group this `CoList` belongs to. Not even sync servers can see the content in plaintext.
-     *
-     * If `privacy` is `"trusting"`, `item` is stored in plaintext in the transaction, visible to everyone who gets a hold of it, including sync servers.
-     *
-     * @category 2. Editing
-     **/
-    append(item: Item, after?: number, privacy?: "private" | "trusting"): this;
-    /**
-     * Returns a new version of this CoList with `item` prepended before the item currently at index `before`.
-     *
-     * If `privacy` is `"private"` **(default)**, `item` is encrypted in the transaction, only readable by other members of the group this `CoList` belongs to. Not even sync servers can see the content in plaintext.
-     *
-     * If `privacy` is `"trusting"`, `item` is stored in plaintext in the transaction, visible to everyone who gets a hold of it, including sync servers.
-     *
-     * @category 2. Editing
-     */
-    prepend(item: Item, before?: number, privacy?: "private" | "trusting"): this;
-    /** Returns a new version of this CoList with the item at index `at` deleted from the list.
-     *
-     * If `privacy` is `"private"` **(default)**, the fact of this deletion is encrypted in the transaction, only readable by other members of the group this `CoList` belongs to. Not even sync servers can see the content in plaintext.
-     *
-     * If `privacy` is `"trusting"`, the fact of this deletion is stored in plaintext in the transaction, visible to everyone who gets a hold of it, including sync servers.
-     *
-     * @category 2. Editing
-     **/
-    delete(at: number, privacy?: "private" | "trusting"): this;
-    /** @category 2. Editing */
-    mutate(mutator: (mutable: MutableCoList<Item, Meta>) => void): this;
-    /** @deprecated Use `mutate` instead. */
-    edit(mutator: (mutable: MutableCoList<Item, Meta>) => void): this;
-}
-export declare class MutableCoList<Item extends JsonValue = JsonValue, Meta extends JsonObject | null = JsonObject | null> extends CoListView<Item, Meta> implements CoValue {
-    /** Appends `item` after the item currently at index `after`.
-     *
-     * If `privacy` is `"private"` **(default)**, `item` is encrypted in the transaction, only readable by other members of the group this `CoList` belongs to. Not even sync servers can see the content in plaintext.
-     *
-     * If `privacy` is `"trusting"`, `item` is stored in plaintext in the transaction, visible to everyone who gets a hold of it, including sync servers.
-     *
-     * @category 2. Mutating
-     **/
-    append(item: Item, after?: number, privacy?: "private" | "trusting"): void;
-    /** Prepends `item` before the item currently at index `before`.
-     *
-     * If `privacy` is `"private"` **(default)**, `item` is encrypted in the transaction, only readable by other members of the group this `CoList` belongs to. Not even sync servers can see the content in plaintext.
-     *
-     * If `privacy` is `"trusting"`, `item` is stored in plaintext in the transaction, visible to everyone who gets a hold of it, including sync servers.
-     *
-     * * @category 2. Mutating
-     **/
-    prepend(item: Item, before?: number, privacy?: "private" | "trusting"): void;
-    /** Deletes the item at index `at` from the list.
-     *
-     * If `privacy` is `"private"` **(default)**, the fact of this deletion is encrypted in the transaction, only readable by other members of the group this `CoList` belongs to. Not even sync servers can see the content in plaintext.
-     *
-     * If `privacy` is `"trusting"`, the fact of this deletion is stored in plaintext in the transaction, visible to everyone who gets a hold of it, including sync servers.
-     *
-     * * @category 2. Mutating
-     **/
-    delete(at: number, privacy?: "private" | "trusting"): void;
-}
-export {};