cojson 0.8.3 → 0.8.11

package/src/coValueState.ts

@@ -0,0 +1,107 @@
+import { CoValueCore } from "./coValueCore.js";
+import { PeerID } from "./sync.js";
+
+function createResolvablePromise<T>() {
+    let resolve!: (value: T) => void;
+
+    const promise = new Promise<T>((res) => {
+        resolve = res;
+    });
+
+    return { promise, resolve };
+}
+
+class CoValueUnknownState {
+    type = "unknown" as const;
+    private peers: Map<PeerID, ReturnType<typeof createResolvablePromise<"available" | "unavailable">>>;
+    private resolve: (value: "available" | "unavailable") => void;
+
+    ready: Promise<"available" | "unavailable">;
+
+    constructor(peersIds: Iterable<PeerID>) {
+        this.peers = new Map();
+
+        for (const peerId of peersIds) {
+            this.peers.set(peerId, createResolvablePromise<"available" | "unavailable">());
+        }
+
+        const { resolve, promise } = createResolvablePromise<"available" | "unavailable">();
+
+        this.ready = promise;
+        this.resolve = resolve;
+    }
+
+    update(peerId: PeerID, value: "available" | "unavailable") {
+        const entry = this.peers.get(peerId);
+
+        if (entry) {
+            entry.resolve(value);
+        }
+
+        if (value === "available") {
+            this.resolve("available");
+            return;
+        }
+
+        this.peers.delete(peerId);
+
+        // If none of the peers have the coValue, we resolve to unavailable
+        if (this.peers.size === 0) {
+            this.resolve("unavailable");
+        }
+    }
+
+    // Wait for a specific peer to have a known state
+    waitForPeer(peerId: PeerID) {
+        const entry = this.peers.get(peerId);
+
+        if (!entry) {
+            return Promise.resolve();
+        }
+
+        return entry.promise;
+    }
+}
+
+class CoValueAvailableState {
+    type = "available" as const;
+
+    constructor(public coValue: CoValueCore) { }
+}
+
+type CoValueStateAction = {
+    type: "not-found";
+    peerId: PeerID;
+} | {
+    type: "found";
+    peerId: PeerID;
+    coValue: CoValueCore;
+};
+
+export class CoValueState {
+    constructor(public state: CoValueUnknownState | CoValueAvailableState) { }
+
+    static Unknown(peersToWaitFor: Set<PeerID>) {
+        return new CoValueState(new CoValueUnknownState(peersToWaitFor));
+    }
+
+    static Available(coValue: CoValueCore) {
+        return new CoValueState(new CoValueAvailableState(coValue));
+    }
+
+    dispatch(action: CoValueStateAction) {
+        if (this.state.type === "available") {
+            return;
+        }
+
+        switch (action.type) {
+            case "not-found":
+                this.state.update(action.peerId, "unavailable");
+                break;
+            case "found":
+                this.state.update(action.peerId, "available");
+                this.state = new CoValueAvailableState(action.coValue);
+                break;
+        }
+    }
+}

package/src/exports.ts

@@ -0,0 +1,149 @@
+import {
+    CoValueCore,
+    type CoValueUniqueness,
+    MAX_RECOMMENDED_TX_SIZE,
+    idforHeader,
+} from "./coValueCore.js";
+import { accountOrAgentIDfromSessionID } from "./typeUtils/accountOrAgentIDfromSessionID.js";
+import { LocalNode } from "./localNode.js";
+import { type RawCoValue } from "./coValue.js";
+import { RawCoMap } from "./coValues/coMap.js";
+import { RawCoList } from "./coValues/coList.js";
+import { RawCoStream, RawBinaryCoStream } from "./coValues/coStream.js";
+import {
+    secretSeedLength,
+    shortHashLength,
+    StreamingHash,
+    CryptoProvider,
+} from "./crypto/crypto.js";
+import { connectedPeers, Channel } from "./streamUtils.js";
+import { ControlledAgent, RawControlledAccount } from "./coValues/account.js";
+import type { Role } from "./permissions.js";
+import { rawCoIDtoBytes, rawCoIDfromBytes, isRawCoID } from "./ids.js";
+import { RawGroup, EVERYONE } from "./coValues/group.js";
+import type { Everyone } from "./coValues/group.js";
+import { base64URLtoBytes, bytesToBase64url } from "./base64url.js";
+import { parseJSON } from "./jsonStringify.js";
+import {
+    RawAccount,
+    RawProfile,
+    accountHeaderForInitialAgentSecret,
+} from "./coValues/account.js";
+import { expectGroup } from "./typeUtils/expectGroup.js";
+import { isAccountID } from "./typeUtils/isAccountID.js";
+
+import type { SessionID, AgentID } from "./ids.js";
+import type { CoID, AnyRawCoValue } from "./coValue.js";
+import type {
+    BinaryStreamInfo,
+    BinaryCoStreamMeta,
+} from "./coValues/coStream.js";
+import type { JsonValue } from "./jsonValue.js";
+import type {
+    SyncMessage,
+    Peer,
+    IncomingSyncStream,
+    OutgoingSyncQueue,
+} from "./sync.js";
+import { DisconnectedError, PingTimeoutError } from "./sync.js";
+import type { AgentSecret } from "./crypto/crypto.js";
+import type {
+    RawAccountID,
+    AccountMeta,
+    RawAccountMigration,
+} from "./coValues/account.js";
+import type { InviteSecret } from "./coValues/group.js";
+import type * as Media from "./media.js";
+
+type Value = JsonValue | AnyRawCoValue;
+
+import { LSMStorage, BlockFilename, WalFilename } from "./storage/index.js";
+import { FileSystem } from "./storage/FileSystem.js";
+import { getPriorityFromHeader } from "./priority.js";
+
+/** @hidden */
+export const cojsonInternals = {
+    connectedPeers,
+    rawCoIDtoBytes,
+    rawCoIDfromBytes,
+    secretSeedLength,
+    shortHashLength,
+    expectGroup,
+    base64URLtoBytes,
+    bytesToBase64url,
+    parseJSON,
+    accountOrAgentIDfromSessionID,
+    isAccountID,
+    accountHeaderForInitialAgentSecret,
+    idforHeader,
+    StreamingHash,
+    Channel,
+    getPriorityFromHeader,
+};
+
+export {
+    LocalNode,
+    RawGroup,
+    Role,
+    EVERYONE,
+    Everyone,
+    RawCoMap,
+    RawCoList,
+    RawCoStream,
+    RawBinaryCoStream,
+    RawCoValue,
+    CoID,
+    AnyRawCoValue,
+    RawAccount,
+    RawAccountID,
+    AccountMeta,
+    RawAccountMigration,
+    RawProfile as Profile,
+    SessionID,
+    Media,
+    CoValueCore,
+    ControlledAgent,
+    RawControlledAccount,
+    MAX_RECOMMENDED_TX_SIZE,
+    JsonValue,
+    Peer,
+    BinaryStreamInfo,
+    BinaryCoStreamMeta,
+    AgentID,
+    AgentSecret,
+    InviteSecret,
+    CryptoProvider,
+    SyncMessage,
+    isRawCoID,
+    LSMStorage,
+};
+
+export type {
+    Value,
+    FileSystem,
+    BlockFilename,
+    WalFilename,
+    IncomingSyncStream,
+    OutgoingSyncQueue,
+    DisconnectedError,
+    PingTimeoutError,
+    CoValueUniqueness,
+};
+
+// eslint-disable-next-line @typescript-eslint/no-namespace
+export namespace CojsonInternalTypes {
+    export type CoValueKnownState = import("./sync.js").CoValueKnownState;
+    export type DoneMessage = import("./sync.js").DoneMessage;
+    export type KnownStateMessage = import("./sync.js").KnownStateMessage;
+    export type LoadMessage = import("./sync.js").LoadMessage;
+    export type NewContentMessage = import("./sync.js").NewContentMessage;
+    export type CoValueHeader = import("./coValueCore.js").CoValueHeader;
+    export type Transaction = import("./coValueCore.js").Transaction;
+    export type TransactionID = import("./ids.js").TransactionID;
+    export type Signature = import("./crypto/crypto.js").Signature;
+    export type RawCoID = import("./ids.js").RawCoID;
+    export type ProfileShape = import("./coValues/account.js").ProfileShape;
+    export type SealerSecret = import("./crypto/crypto.js").SealerSecret;
+    export type SignerSecret = import("./crypto/crypto.js").SignerSecret;
+    export type JsonObject = import("./jsonValue.js").JsonObject;
+}

package/src/index.native.ts

@@ -1,152 +1,2 @@
-import { PureJSCrypto } from "./crypto/PureJSCrypto.js";
-
-import {
-    CoValueCore,
-    type CoValueUniqueness,
-    MAX_RECOMMENDED_TX_SIZE,
-    idforHeader,
-} from "./coValueCore.js";
-import { accountOrAgentIDfromSessionID } from "./typeUtils/accountOrAgentIDfromSessionID.js";
-import { LocalNode } from "./localNode.js";
-import { type RawCoValue } from "./coValue.js";
-import { RawCoMap } from "./coValues/coMap.js";
-import { RawCoList } from "./coValues/coList.js";
-import { RawCoStream, RawBinaryCoStream } from "./coValues/coStream.js";
-import {
-    secretSeedLength,
-    shortHashLength,
-    StreamingHash,
-    CryptoProvider,
-} from "./crypto/crypto.js";
-import { connectedPeers, Channel } from "./streamUtils.js";
-import { ControlledAgent, RawControlledAccount } from "./coValues/account.js";
-import type { Role } from "./permissions.js";
-import { rawCoIDtoBytes, rawCoIDfromBytes, isRawCoID } from "./ids.js";
-import { RawGroup, EVERYONE } from "./coValues/group.js";
-import type { Everyone } from "./coValues/group.js";
-import { base64URLtoBytes, bytesToBase64url } from "./base64url.js";
-import { parseJSON } from "./jsonStringify.js";
-import {
-    RawAccount,
-    RawProfile,
-    accountHeaderForInitialAgentSecret,
-} from "./coValues/account.js";
-import { expectGroup } from "./typeUtils/expectGroup.js";
-import { isAccountID } from "./typeUtils/isAccountID.js";
-
-import type { SessionID, AgentID } from "./ids.js";
-import type { CoID, AnyRawCoValue } from "./coValue.js";
-import type {
-    BinaryStreamInfo,
-    BinaryCoStreamMeta,
-} from "./coValues/coStream.js";
-import type { JsonValue } from "./jsonValue.js";
-import type {
-    SyncMessage,
-    Peer,
-    IncomingSyncStream,
-    OutgoingSyncQueue,
-} from "./sync.js";
-import { DisconnectedError, PingTimeoutError } from "./sync.js";
-import type { AgentSecret } from "./crypto/crypto.js";
-import type {
-    RawAccountID,
-    AccountMeta,
-    RawAccountMigration,
-} from "./coValues/account.js";
-import type { InviteSecret } from "./coValues/group.js";
-import type * as Media from "./media.js";
-
-type Value = JsonValue | AnyRawCoValue;
-
-import { LSMStorage, BlockFilename, WalFilename } from "./storage/index.js";
-import { FileSystem } from "./storage/FileSystem.js";
-import { getPriorityFromHeader } from "./priority.js";
-
-/** @hidden */
-export const cojsonInternals = {
-    connectedPeers,
-    rawCoIDtoBytes,
-    rawCoIDfromBytes,
-    secretSeedLength,
-    shortHashLength,
-    expectGroup,
-    base64URLtoBytes,
-    bytesToBase64url,
-    parseJSON,
-    accountOrAgentIDfromSessionID,
-    isAccountID,
-    accountHeaderForInitialAgentSecret,
-    idforHeader,
-    StreamingHash,
-    Channel,
-    getPriorityFromHeader,
-};
-
-export {
-    LocalNode,
-    RawGroup,
-    Role,
-    EVERYONE,
-    Everyone,
-    RawCoMap,
-    RawCoList,
-    RawCoStream,
-    RawBinaryCoStream,
-    RawCoValue,
-    CoID,
-    AnyRawCoValue,
-    RawAccount,
-    RawAccountID,
-    AccountMeta,
-    RawAccountMigration,
-    RawProfile as Profile,
-    SessionID,
-    Media,
-    CoValueCore,
-    ControlledAgent,
-    RawControlledAccount,
-    MAX_RECOMMENDED_TX_SIZE,
-    JsonValue,
-    Peer,
-    BinaryStreamInfo,
-    BinaryCoStreamMeta,
-    AgentID,
-    AgentSecret,
-    InviteSecret,
-    CryptoProvider,
-    SyncMessage,
-    isRawCoID,
-    LSMStorage,
-    PureJSCrypto,
-};
-
-export type {
-    Value,
-    FileSystem,
-    BlockFilename,
-    WalFilename,
-    IncomingSyncStream,
-    OutgoingSyncQueue,
-    DisconnectedError,
-    PingTimeoutError,
-    CoValueUniqueness,
-};
-
-// eslint-disable-next-line @typescript-eslint/no-namespace
-export namespace CojsonInternalTypes {
-    export type CoValueKnownState = import("./sync.js").CoValueKnownState;
-    export type DoneMessage = import("./sync.js").DoneMessage;
-    export type KnownStateMessage = import("./sync.js").KnownStateMessage;
-    export type LoadMessage = import("./sync.js").LoadMessage;
-    export type NewContentMessage = import("./sync.js").NewContentMessage;
-    export type CoValueHeader = import("./coValueCore.js").CoValueHeader;
-    export type Transaction = import("./coValueCore.js").Transaction;
-    export type TransactionID = import("./ids.js").TransactionID;
-    export type Signature = import("./crypto/crypto.js").Signature;
-    export type RawCoID = import("./ids.js").RawCoID;
-    export type ProfileShape = import("./coValues/account.js").ProfileShape;
-    export type SealerSecret = import("./crypto/crypto.js").SealerSecret;
-    export type SignerSecret = import("./crypto/crypto.js").SignerSecret;
-    export type JsonObject = import("./jsonValue.js").JsonObject;
-}
+export * from "./exports.js";
+export { PureJSCrypto } from "./crypto/PureJSCrypto.js";

package/src/index.web.ts

@@ -1,152 +1,2 @@
-import { WasmCrypto } from "./crypto/WasmCrypto.js";
-
-import {
-    CoValueCore,
-    type CoValueUniqueness,
-    MAX_RECOMMENDED_TX_SIZE,
-    idforHeader,
-} from "./coValueCore.js";
-import { accountOrAgentIDfromSessionID } from "./typeUtils/accountOrAgentIDfromSessionID.js";
-import { LocalNode } from "./localNode.js";
-import { type RawCoValue } from "./coValue.js";
-import { RawCoMap } from "./coValues/coMap.js";
-import { RawCoList } from "./coValues/coList.js";
-import { RawCoStream, RawBinaryCoStream } from "./coValues/coStream.js";
-import {
-    secretSeedLength,
-    shortHashLength,
-    StreamingHash,
-    CryptoProvider,
-} from "./crypto/crypto.js";
-import { connectedPeers, Channel } from "./streamUtils.js";
-import { ControlledAgent, RawControlledAccount } from "./coValues/account.js";
-import type { Role } from "./permissions.js";
-import { rawCoIDtoBytes, rawCoIDfromBytes, isRawCoID } from "./ids.js";
-import { RawGroup, EVERYONE } from "./coValues/group.js";
-import type { Everyone } from "./coValues/group.js";
-import { base64URLtoBytes, bytesToBase64url } from "./base64url.js";
-import { parseJSON } from "./jsonStringify.js";
-import {
-    RawAccount,
-    RawProfile,
-    accountHeaderForInitialAgentSecret,
-} from "./coValues/account.js";
-import { expectGroup } from "./typeUtils/expectGroup.js";
-import { isAccountID } from "./typeUtils/isAccountID.js";
-
-import type { SessionID, AgentID } from "./ids.js";
-import type { CoID, AnyRawCoValue } from "./coValue.js";
-import type {
-    BinaryStreamInfo,
-    BinaryCoStreamMeta,
-} from "./coValues/coStream.js";
-import type { JsonValue } from "./jsonValue.js";
-import type {
-    SyncMessage,
-    Peer,
-    IncomingSyncStream,
-    OutgoingSyncQueue,
-} from "./sync.js";
-import { DisconnectedError, PingTimeoutError } from "./sync.js";
-import type { AgentSecret } from "./crypto/crypto.js";
-import type {
-    RawAccountID,
-    AccountMeta,
-    RawAccountMigration,
-} from "./coValues/account.js";
-import type { InviteSecret } from "./coValues/group.js";
-import type * as Media from "./media.js";
-
-type Value = JsonValue | AnyRawCoValue;
-
-import { LSMStorage, BlockFilename, WalFilename } from "./storage/index.js";
-import { FileSystem } from "./storage/FileSystem.js";
-import { getPriorityFromHeader } from "./priority.js";
-
-/** @hidden */
-export const cojsonInternals = {
-    connectedPeers,
-    rawCoIDtoBytes,
-    rawCoIDfromBytes,
-    secretSeedLength,
-    shortHashLength,
-    expectGroup,
-    base64URLtoBytes,
-    bytesToBase64url,
-    parseJSON,
-    accountOrAgentIDfromSessionID,
-    isAccountID,
-    accountHeaderForInitialAgentSecret,
-    idforHeader,
-    StreamingHash,
-    Channel,
-    getPriorityFromHeader,
-};
-
-export {
-    LocalNode,
-    RawGroup,
-    Role,
-    EVERYONE,
-    Everyone,
-    RawCoMap,
-    RawCoList,
-    RawCoStream,
-    RawBinaryCoStream,
-    RawCoValue,
-    CoID,
-    AnyRawCoValue,
-    RawAccount,
-    RawAccountID,
-    AccountMeta,
-    RawAccountMigration,
-    RawProfile as Profile,
-    SessionID,
-    Media,
-    CoValueCore,
-    ControlledAgent,
-    RawControlledAccount,
-    MAX_RECOMMENDED_TX_SIZE,
-    JsonValue,
-    Peer,
-    BinaryStreamInfo,
-    BinaryCoStreamMeta,
-    AgentID,
-    AgentSecret,
-    InviteSecret,
-    CryptoProvider,
-    SyncMessage,
-    isRawCoID,
-    LSMStorage,
-    WasmCrypto,
-};
-
-export type {
-    Value,
-    FileSystem,
-    BlockFilename,
-    WalFilename,
-    IncomingSyncStream,
-    OutgoingSyncQueue,
-    DisconnectedError,
-    PingTimeoutError,
-    CoValueUniqueness,
-};
-
-// eslint-disable-next-line @typescript-eslint/no-namespace
-export namespace CojsonInternalTypes {
-    export type CoValueKnownState = import("./sync.js").CoValueKnownState;
-    export type DoneMessage = import("./sync.js").DoneMessage;
-    export type KnownStateMessage = import("./sync.js").KnownStateMessage;
-    export type LoadMessage = import("./sync.js").LoadMessage;
-    export type NewContentMessage = import("./sync.js").NewContentMessage;
-    export type CoValueHeader = import("./coValueCore.js").CoValueHeader;
-    export type Transaction = import("./coValueCore.js").Transaction;
-    export type TransactionID = import("./ids.js").TransactionID;
-    export type Signature = import("./crypto/crypto.js").Signature;
-    export type RawCoID = import("./ids.js").RawCoID;
-    export type ProfileShape = import("./coValues/account.js").ProfileShape;
-    export type SealerSecret = import("./crypto/crypto.js").SealerSecret;
-    export type SignerSecret = import("./crypto/crypto.js").SignerSecret;
-    export type JsonObject = import("./jsonValue.js").JsonObject;
-}
+export * from "./exports.js";
+export { WasmCrypto } from "./crypto/WasmCrypto.js";

package/src/jsonValue.ts

@@ -4,3 +4,28 @@ export type JsonAtom = string | number | boolean | null;
 export type JsonValue = JsonAtom | JsonArray | JsonObject | RawCoID;
 export type JsonArray = JsonValue[] | readonly JsonValue[];
 export type JsonObject = { [key: string]: JsonValue | undefined };
+
+type AtLeastOne<T, U = {[K in keyof T]: Pick<T, K> }> = Partial<T> & U[keyof U];
+type ExcludeEmpty<T> = T extends AtLeastOne<T> ? T : never; 
+
+export type CoJsonValue<T> = JsonValue | CoJsonObjectWithIndex<T> | CoJsonArray<T>;
+export type CoJsonArray<T> = CoJsonValue<T>[] | readonly CoJsonValue<T>[];
+
+/**
+ * Since we are forcing Typescript to elaborate the indexes from the given type passing
+ * non-object values to CoJsonObjectWithIndex will return an empty object
+ * E.g. 
+ *   CoJsonObjectWithIndex<() => void> --> {}
+ *   CoJsonObjectWithIndex<RegExp> --> {}
+ * 
+ * Applying the ExcludeEmpty type here to make sure we don't accept functions or non-serializable values
+ */
+export type CoJsonObjectWithIndex<T> = ExcludeEmpty<{ [K in keyof T & string]: CoJsonValue1L<T[K]> | undefined }>;
+
+/**
+ * Manually handling the nested interface types to not get into infinite recursion issues.
+ */
+export type CoJsonValue1L<T> = ExcludeEmpty<{ [K in keyof T & string]: CoJsonValue2L<T[K]> | undefined }> | JsonValue;
+export type CoJsonValue2L<T> = ExcludeEmpty<{ [K in keyof T & string]: CoJsonValue3L<T[K]> | undefined }> | JsonValue;
+export type CoJsonValue3L<T> = ExcludeEmpty<{ [K in keyof T & string]: CoJsonValue4L<T[K]> | undefined }> | JsonValue;
+export type CoJsonValue4L<T> = ExcludeEmpty<{ [K in keyof T & string]: JsonValue | undefined }> | JsonValue;