@dxos/protocols 2.28.0

package/src/proto/gen/dxos/devtools.ts

@@ -0,0 +1,206 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import * as dxos_bot from "./bot";
+import * as dxos_client from "./client";
+import * as dxos_config from "./config";
+import * as dxos_credentials from "./credentials";
+import * as dxos_credentials_auth from "./credentials/auth";
+import * as dxos_credentials_greet from "./credentials/greet";
+import * as dxos_credentials_identity from "./credentials/identity";
+import * as dxos_credentials_party from "./credentials/party";
+import * as dxos_echo_feed from "./echo/feed";
+import * as dxos_echo_invitation from "./echo/invitation";
+import * as dxos_echo_metadata from "./echo/metadata";
+import * as dxos_echo_service from "./echo/service";
+import * as dxos_echo_snapshot from "./echo/snapshot";
+import * as dxos_halo_keys from "./halo/keys";
+import * as dxos_rpc from "./rpc";
+import * as google_protobuf from "../google/protobuf";
+export interface DevtoolsHost {
+    events: (request: void) => Stream<Event>;
+    getConfig: (request: void) => Promise<GetConfigResponse>;
+    resetStorage: (request: ResetStorageRequest) => Promise<void>;
+    enableDebugLogging: (request: EnableDebugLoggingRequest) => Promise<EnableDebugLoggingResponse>;
+    disableDebugLogging: (request: EnableDebugLoggingRequest) => Promise<EnableDebugLoggingResponse>;
+    subscribeToKeyringKeys: (request: SubscribeToKeyringKeysRequest) => Stream<SubscribeToKeyringKeysResponse>;
+    subscribeToCredentialMessages: (request: SubscribeToCredentialMessagesRequest) => Stream<SubscribeToCredentialMessagesResponse>;
+    subscribeToParties: (request: SubscribeToPartiesRequest) => Stream<SubscribeToPartiesResponse>;
+    subscribeToItems: (request: SubscribeToItemsRequest) => Stream<SubscribeToItemsResponse>;
+    subscribeToFeeds: (request: SubscribeToFeedsRequest) => Stream<SubscribeToFeedsResponse>;
+    subscribeToFeed: (request: SubscribeToFeedRequest) => Stream<SubscribeToFeedResponse>;
+    getPartySnapshot: (request: GetPartySnapshotRequest) => Promise<GetPartySnapshotResponse>;
+    savePartySnapshot: (request: SavePartySnapshotRequest) => Promise<SavePartySnapshotResponse>;
+    clearSnapshots: (request: ClearSnapshotsRequest) => Promise<void>;
+    getNetworkPeers: (request: GetNetworkPeersRequest) => Promise<GetNetworkPeersResponse>;
+    subscribeToNetworkTopics: (request: void) => Stream<SubscribeToNetworkTopicsResponse>;
+    subscribeToSignalStatus: (request: void) => Stream<SubscribeToSignalStatusResponse>;
+    subscribeToSignalTrace: (request: void) => Stream<SubscribeToSignalTraceResponse>;
+    subscribeToSwarmInfo: (request: SubscribeToSwarmInfoRequest) => Stream<SubscribeToSwarmInfoResponse>;
+}
+export interface Event {
+    ready?: ReadyEvent;
+}
+export interface ReadyEvent {
+}
+export interface GetConfigResponse {
+    config?: string;
+}
+export interface EnableDebugLoggingRequest {
+    namespaces?: string;
+}
+export interface EnableDebugLoggingResponse {
+    enabledNamespaces?: string;
+}
+export interface DisableDebugLoggingRequest {
+    namespaces?: string;
+}
+export interface DisableDebugLoggingResponse {
+    enabledNamespaces?: string;
+}
+export interface SubscribeToKeyringKeysRequest {
+}
+export interface SubscribeToKeyringKeysResponse {
+    keys?: dxos_halo_keys.KeyRecord[];
+}
+export interface SubscribeToCredentialMessagesRequest {
+    partyKey?: dxos_halo_keys.PubKey;
+}
+export interface SubscribeToCredentialMessagesResponse {
+    messages?: dxos_credentials.SignedMessage[];
+}
+export interface ResetStorageRequest {
+}
+export interface GetNetworkPeersRequest {
+    topic?: Uint8Array;
+}
+export interface GetNetworkPeersResponse {
+    peers?: GetNetworkPeersResponse.PeerInfo[];
+}
+export namespace GetNetworkPeersResponse {
+    export interface PeerInfo {
+        id?: dxos_halo_keys.PubKey;
+        state?: string;
+        connections?: Uint8Array[];
+    }
+}
+export interface SubscribeToPartiesRequest {
+}
+export interface SubscribeToPartiesResponse {
+    parties?: SubscribeToPartiesResponse.PartyInfo[];
+}
+export namespace SubscribeToPartiesResponse {
+    export interface PartyInfo {
+        key?: string;
+        isOpen?: boolean;
+        isActive?: boolean;
+        feedKeys?: number;
+        properties?: Partial<Record<string, string>>;
+        timeframe?: dxos_echo_feed.TimeframeVector;
+    }
+}
+export interface SubscribeToItemsRequest {
+}
+export interface SubscribeToItemsResponse {
+    data?: string;
+}
+export interface SubscribeToFeedsRequest {
+}
+export interface SubscribeToFeedsResponse {
+    parties?: SubscribeToFeedsResponse.Party[];
+}
+export namespace SubscribeToFeedsResponse {
+    export interface Party {
+        key?: dxos_halo_keys.PubKey;
+        feeds?: dxos_halo_keys.PubKey[];
+    }
+}
+export interface SubscribeToFeedRequest {
+    partyKey?: dxos_halo_keys.PubKey;
+    feedKey?: dxos_halo_keys.PubKey;
+}
+export interface SubscribeToFeedResponse {
+    blocks?: SubscribeToFeedResponse.EchoFeedBlock[];
+}
+export namespace SubscribeToFeedResponse {
+    export interface EchoFeedBlock {
+        key?: Uint8Array;
+        seq?: number;
+        sync?: boolean;
+        path?: string;
+        data?: dxos_echo_feed.FeedMessage;
+    }
+}
+export interface GetPartySnapshotRequest {
+    partyKey: dxos_halo_keys.PubKey;
+}
+export interface GetPartySnapshotResponse {
+    snapshot?: dxos_echo_snapshot.PartySnapshot;
+}
+export interface SavePartySnapshotRequest {
+    partyKey: dxos_halo_keys.PubKey;
+}
+export interface SavePartySnapshotResponse {
+    snapshot?: dxos_echo_snapshot.PartySnapshot;
+}
+export interface ClearSnapshotsRequest {
+}
+export interface SubscribeToNetworkTopicsResponse {
+    topics?: SubscribeToNetworkTopicsResponse.Topic[];
+}
+export namespace SubscribeToNetworkTopicsResponse {
+    export interface Topic {
+        topic?: dxos_halo_keys.PubKey;
+        label?: string;
+    }
+}
+export interface SubscribeToSignalStatusResponse {
+    servers?: SubscribeToSignalStatusResponse.SignalServer[];
+}
+export namespace SubscribeToSignalStatusResponse {
+    export interface SignalServer {
+        host?: string;
+        state?: string;
+        error?: string;
+        reconnectIn?: number;
+        connectionStarted?: number;
+        lastStateChange?: number;
+    }
+}
+export interface SubscribeToSignalTraceResponse {
+    events?: string[];
+}
+export interface SubscribeToSwarmInfoRequest {
+}
+export interface SubscribeToSwarmInfoResponse {
+    data?: SubscribeToSwarmInfoResponse.SwarmInfo[];
+}
+export namespace SubscribeToSwarmInfoResponse {
+    export interface SwarmInfo {
+        id?: dxos_halo_keys.PubKey;
+        topic?: dxos_halo_keys.PubKey;
+        label?: string;
+        isActive?: boolean;
+        connections?: SubscribeToSwarmInfoResponse.SwarmInfo.ConnectionInfo[];
+    }
+    export namespace SwarmInfo {
+        export interface ConnectionInfo {
+            state?: string;
+            sessionId?: dxos_halo_keys.PubKey;
+            remotePeerId?: dxos_halo_keys.PubKey;
+            transport?: string;
+            protocolExtensions?: string[];
+            events?: SubscribeToSwarmInfoResponse.SwarmInfo.ConnectionInfo.Json[];
+        }
+        export namespace ConnectionInfo {
+            export interface Json {
+                data?: string;
+            }
+        }
+    }
+}
+export interface SetTracingOptionsRequest {
+    enable?: boolean;
+}
+export interface TracingService {
+    setTracingOptions: (request: SetTracingOptionsRequest) => Promise<void>;
+    subscribeToRpcTrace: (request: void) => Stream<dxos_rpc.RpcMessage>;
+}

package/src/proto/gen/dxos/echo/feed.ts

@@ -0,0 +1,84 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import * as dxos_bot from "../bot";
+import * as dxos_client from "../client";
+import * as dxos_config from "../config";
+import * as dxos_credentials from "../credentials";
+import * as dxos_credentials_auth from "../credentials/auth";
+import * as dxos_credentials_greet from "../credentials/greet";
+import * as dxos_credentials_identity from "../credentials/identity";
+import * as dxos_credentials_party from "../credentials/party";
+import * as dxos_devtools from "../devtools";
+import * as dxos_echo_invitation from "./invitation";
+import * as dxos_echo_metadata from "./metadata";
+import * as dxos_echo_service from "./service";
+import * as dxos_echo_snapshot from "./snapshot";
+import * as dxos_halo_keys from "../halo/keys";
+import * as dxos_rpc from "../rpc";
+import * as google_protobuf from "../../google/protobuf";
+/**
+ * Outer message type decoded by Codec.
+ * This is what is written to the feeds.
+ */
+export interface FeedMessage {
+    halo?: CredentialsMessage;
+    echo?: EchoEnvelope;
+}
+/**
+ * A container for dxos.credentials.Message
+ */
+export interface CredentialsMessage {
+    data?: Uint8Array;
+}
+/**
+ * Vector timestamp used to order messages.
+ */
+export interface TimeframeVector {
+    frames?: TimeframeVector.Frame[];
+}
+export namespace TimeframeVector {
+    export interface Frame {
+        feedKey?: Uint8Array;
+        seq?: number;
+    }
+}
+/**
+ * Wrapper for all ECHO messages.
+ */
+export interface EchoEnvelope {
+    itemId?: string;
+    timeframe?: TimeframeVector;
+    genesis?: ItemGenesis;
+    itemMutation?: ItemMutation;
+    mutation?: Uint8Array;
+    /**
+     * Set the model to the provided snapshot.
+     */
+    snapshot?: dxos_echo_snapshot.ModelSnapshot;
+}
+export interface LinkData {
+    source?: string;
+    target?: string;
+}
+/**
+ * Item creation.
+ */
+export interface ItemGenesis {
+    itemType?: string;
+    modelType?: string;
+    modelVersion?: string;
+    link?: LinkData;
+}
+/**
+ * Item mutation.
+ */
+export interface ItemMutation {
+    parentId?: string;
+    action?: ItemMutation.Action;
+}
+export namespace ItemMutation {
+    export enum Action {
+        NOOP = 0,
+        DELETE = 1,
+        RESTORE = 2
+    }
+}

package/src/proto/gen/dxos/echo/invitation.ts

@@ -0,0 +1,36 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import * as dxos_bot from "../bot";
+import * as dxos_client from "../client";
+import * as dxos_config from "../config";
+import * as dxos_credentials from "../credentials";
+import * as dxos_credentials_auth from "../credentials/auth";
+import * as dxos_credentials_greet from "../credentials/greet";
+import * as dxos_credentials_identity from "../credentials/identity";
+import * as dxos_credentials_party from "../credentials/party";
+import * as dxos_devtools from "../devtools";
+import * as dxos_echo_feed from "./feed";
+import * as dxos_echo_metadata from "./metadata";
+import * as dxos_echo_service from "./service";
+import * as dxos_echo_snapshot from "./snapshot";
+import * as dxos_halo_keys from "../halo/keys";
+import * as dxos_rpc from "../rpc";
+import * as google_protobuf from "../../google/protobuf";
+export interface InvitationDescriptor {
+    type?: InvitationDescriptor.Type;
+    swarmKey?: Uint8Array;
+    invitation?: Uint8Array;
+    /**
+     * Only present if type == OFFLINE.
+     */
+    identityKey?: Uint8Array;
+    /**
+     * Must be stripped out when passing to another peer.
+     */
+    secret?: Uint8Array;
+}
+export namespace InvitationDescriptor {
+    export enum Type {
+        INTERACTIVE = 1,
+        OFFLINE = 2
+    }
+}

package/src/proto/gen/dxos/echo/metadata.ts

@@ -0,0 +1,33 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import * as dxos_bot from "../bot";
+import * as dxos_client from "../client";
+import * as dxos_config from "../config";
+import * as dxos_credentials from "../credentials";
+import * as dxos_credentials_auth from "../credentials/auth";
+import * as dxos_credentials_greet from "../credentials/greet";
+import * as dxos_credentials_identity from "../credentials/identity";
+import * as dxos_credentials_party from "../credentials/party";
+import * as dxos_devtools from "../devtools";
+import * as dxos_echo_feed from "./feed";
+import * as dxos_echo_invitation from "./invitation";
+import * as dxos_echo_service from "./service";
+import * as dxos_echo_snapshot from "./snapshot";
+import * as dxos_halo_keys from "../halo/keys";
+import * as dxos_rpc from "../rpc";
+import * as google_protobuf from "../../google/protobuf";
+export interface EchoMetadata {
+    /**
+     * Version number that is inceremnted every time there's a breaking change to the storage schema.
+     *
+     * This is used to detect if the storage schema has changed since the last time the client was run.
+     * Loading data from a different version will might result in an error.
+     */
+    version?: number;
+    parties?: PartyMetadata[];
+    created?: google_protobuf.Timestamp;
+    updated?: google_protobuf.Timestamp;
+}
+export interface PartyMetadata {
+    key?: dxos_halo_keys.PubKey;
+    feedKeys?: dxos_halo_keys.PubKey[];
+}

package/src/proto/gen/dxos/echo/service.ts

@@ -0,0 +1,59 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import * as dxos_bot from "../bot";
+import * as dxos_client from "../client";
+import * as dxos_config from "../config";
+import * as dxos_credentials from "../credentials";
+import * as dxos_credentials_auth from "../credentials/auth";
+import * as dxos_credentials_greet from "../credentials/greet";
+import * as dxos_credentials_identity from "../credentials/identity";
+import * as dxos_credentials_party from "../credentials/party";
+import * as dxos_devtools from "../devtools";
+import * as dxos_echo_feed from "./feed";
+import * as dxos_echo_invitation from "./invitation";
+import * as dxos_echo_metadata from "./metadata";
+import * as dxos_echo_snapshot from "./snapshot";
+import * as dxos_halo_keys from "../halo/keys";
+import * as dxos_rpc from "../rpc";
+import * as google_protobuf from "../../google/protobuf";
+export interface SubscribeEntitySetRequest {
+    partyKey?: dxos_halo_keys.PubKey;
+}
+export interface SubscribeEntitySetResponse {
+    added?: dxos_echo_feed.EchoEnvelope[];
+    deleted?: dxos_echo_feed.EchoEnvelope[];
+}
+export interface SubscribeEntityStreamRequest {
+    partyKey?: dxos_halo_keys.PubKey;
+    itemId?: string;
+}
+export interface SubscribeEntityStreamResponse {
+    snapshot?: dxos_echo_snapshot.ItemSnapshot;
+    mutation?: SubscribeEntityStreamResponse.Mutation;
+}
+export namespace SubscribeEntityStreamResponse {
+    export interface Mutation {
+        data?: dxos_echo_feed.EchoEnvelope;
+        meta?: SubscribeEntityStreamResponse.Mutation.Metadata;
+    }
+    export namespace Mutation {
+        export interface Metadata {
+            feedKey?: dxos_halo_keys.PubKey;
+            memberKey?: dxos_halo_keys.PubKey;
+            seq?: number;
+            timeframe?: dxos_echo_feed.TimeframeVector;
+        }
+    }
+}
+export interface WriteRequest {
+    partyKey?: dxos_halo_keys.PubKey;
+    mutation?: dxos_echo_feed.EchoEnvelope;
+}
+export interface MutationReceipt {
+    feedKey?: dxos_halo_keys.PubKey;
+    seq?: number;
+}
+export interface DataService {
+    subscribeEntitySet: (request: SubscribeEntitySetRequest) => Stream<SubscribeEntitySetResponse>;
+    subscribeEntityStream: (request: SubscribeEntityStreamRequest) => Stream<SubscribeEntityStreamResponse>;
+    write: (request: WriteRequest) => Promise<MutationReceipt>;
+}

package/src/proto/gen/dxos/echo/snapshot.ts

@@ -0,0 +1,66 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import * as dxos_bot from "../bot";
+import * as dxos_client from "../client";
+import * as dxos_config from "../config";
+import * as dxos_credentials from "../credentials";
+import * as dxos_credentials_auth from "../credentials/auth";
+import * as dxos_credentials_greet from "../credentials/greet";
+import * as dxos_credentials_identity from "../credentials/identity";
+import * as dxos_credentials_party from "../credentials/party";
+import * as dxos_devtools from "../devtools";
+import * as dxos_echo_feed from "./feed";
+import * as dxos_echo_invitation from "./invitation";
+import * as dxos_echo_metadata from "./metadata";
+import * as dxos_echo_service from "./service";
+import * as dxos_halo_keys from "../halo/keys";
+import * as dxos_rpc from "../rpc";
+import * as google_protobuf from "../../google/protobuf";
+export interface PartySnapshot {
+    partyKey?: Uint8Array;
+    timeframe?: dxos_echo_feed.TimeframeVector;
+    timestamp?: number;
+    halo?: HaloStateSnapshot;
+    database?: DatabaseSnapshot;
+}
+export interface DatabaseSnapshot {
+    items?: ItemSnapshot[];
+}
+export interface HaloStateSnapshot {
+    messages?: dxos_echo_feed.CredentialsMessage[];
+}
+export interface ItemSnapshot {
+    itemId?: string;
+    itemType?: string;
+    modelType?: string;
+    modelVersion?: string;
+    parentId?: string;
+    model?: ModelSnapshot;
+}
+/**
+ * Represents the reified state of a state machine.
+ * The snapshots make consist of a custom snapshot object and/or a list of mutations
+ * that are applied to the snapshot or the initial state.
+ */
+export interface ModelSnapshot {
+    /**
+     * Encoded model snapshot (defined by the model's codec).
+     * If undefined the state machine will be initialized with it's default state.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    snapshot?: Uint8Array;
+    /**
+     * Mutations to be applied on top of the snapshot, or on top of initial state if the snapshot is undefined.
+     */
+    mutations?: ModelMutation[];
+}
+export interface ModelMutation {
+    mutation: Uint8Array;
+    meta: ModelMutationMeta;
+}
+export interface ModelMutationMeta {
+    feedKey: Uint8Array;
+    seq: number;
+    memberKey: Uint8Array;
+}

package/src/proto/gen/dxos/halo/keys.ts

@@ -0,0 +1,74 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import * as dxos_bot from "../bot";
+import * as dxos_client from "../client";
+import * as dxos_config from "../config";
+import * as dxos_credentials from "../credentials";
+import * as dxos_credentials_auth from "../credentials/auth";
+import * as dxos_credentials_greet from "../credentials/greet";
+import * as dxos_credentials_identity from "../credentials/identity";
+import * as dxos_credentials_party from "../credentials/party";
+import * as dxos_devtools from "../devtools";
+import * as dxos_echo_feed from "../echo/feed";
+import * as dxos_echo_invitation from "../echo/invitation";
+import * as dxos_echo_metadata from "../echo/metadata";
+import * as dxos_echo_service from "../echo/service";
+import * as dxos_echo_snapshot from "../echo/snapshot";
+import * as dxos_rpc from "../rpc";
+import * as google_protobuf from "../../google/protobuf";
+export enum KeyType {
+    UNKNOWN = 0,
+    IDENTITY = 1,
+    DEVICE = 2,
+    PARTY = 3,
+    FEED = 4,
+    DXNS_ADDRESS = 5
+}
+export interface PubKey {
+    data?: Uint8Array;
+}
+export interface PrivKey {
+    data?: Uint8Array;
+}
+export interface KeyRecord {
+    /**
+     * - The `KeyType` type of the key. This is often unknown for keys from other sources.
+     */
+    type: KeyType;
+    /**
+     * - The public key as a Buffer (required).
+     */
+    publicKey: PubKey;
+    /**
+     * - The secret key as a Buffer (this will never be visible outside the Keyring).
+     */
+    secretKey?: PrivKey;
+    /**
+     * - Is this key from a Greeting "hint"?
+     */
+    hint?: boolean;
+    /**
+     * - Is this our key? Usually true if `secretKey` is present,
+     * may be false for "inception keys" such as the Party key.
+     */
+    own?: boolean;
+    /**
+     * - Is this key to be trusted?
+     */
+    trusted?: boolean;
+    /**
+     * - An RFC-3339 date/time string for when the key was added to the Keyring.
+     */
+    added?: string;
+    /**
+     * - An RFC-3339 date/time string for when the key was created.
+     */
+    created?: string;
+}
+export interface KeyRecordList {
+    keys?: KeyRecord[];
+}
+export interface KeyChain {
+    publicKey: PubKey;
+    message: dxos_credentials.SignedMessage;
+    parents?: KeyChain[];
+}

package/src/proto/gen/dxos/rpc.ts

@@ -0,0 +1,56 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import * as dxos_bot from "./bot";
+import * as dxos_client from "./client";
+import * as dxos_config from "./config";
+import * as dxos_credentials from "./credentials";
+import * as dxos_credentials_auth from "./credentials/auth";
+import * as dxos_credentials_greet from "./credentials/greet";
+import * as dxos_credentials_identity from "./credentials/identity";
+import * as dxos_credentials_party from "./credentials/party";
+import * as dxos_devtools from "./devtools";
+import * as dxos_echo_feed from "./echo/feed";
+import * as dxos_echo_invitation from "./echo/invitation";
+import * as dxos_echo_metadata from "./echo/metadata";
+import * as dxos_echo_service from "./echo/service";
+import * as dxos_echo_snapshot from "./echo/snapshot";
+import * as dxos_halo_keys from "./halo/keys";
+import * as google_protobuf from "../google/protobuf";
+export interface RpcMessage {
+    request?: Request;
+    response?: Response;
+    /**
+     * Means that the node is open to receiving requests. Second stage of the hasnshake protocol.
+     */
+    open?: boolean;
+    streamClose?: StreamClose;
+}
+export interface Request {
+    id?: number;
+    method?: string;
+    payload?: google_protobuf.Any;
+    stream?: boolean;
+}
+export interface Response {
+    id?: number;
+    payload?: google_protobuf.Any;
+    error?: Error;
+    close?: boolean;
+}
+export interface StreamClose {
+    id?: number;
+}
+export interface Error {
+    name?: string;
+    message?: string;
+    stack?: string;
+}
+export interface MessageTrace {
+    direction?: MessageTrace.Direction;
+    data?: Uint8Array;
+}
+export namespace MessageTrace {
+    export enum Direction {
+        INCOMING = 0,
+        OUTGOING = 1
+    }
+}