@dxos/protocols 2.28.0

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

@@ -0,0 +1,190 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import * as dxos_bot from "./bot";
+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 dxos_rpc from "./rpc";
+import * as google_protobuf from "../google/protobuf";
+export interface SystemService {
+    getConfig: (request: void) => Promise<dxos_config.Config>;
+    reset: (request: void) => Promise<void>;
+}
+export enum InvitationState {
+    WAITING_FOR_CONNECTION = 1,
+    CONNECTED = 2,
+    SUCCESS = 3,
+    ERROR = 4
+}
+/**
+ * Invitation process created by sender.
+ */
+export interface InvitationRequest {
+    descriptor?: dxos_echo_invitation.InvitationDescriptor;
+    state?: InvitationState;
+    /**
+     * Only if state == ERROR.
+     */
+    error?: string;
+}
+/**
+ * Invitation that is being redeemed.
+ */
+export interface RedeemedInvitation {
+    id?: string;
+    state?: InvitationState;
+    /**
+     * Only if state == ERROR.
+     */
+    error?: string;
+    /**
+     * Only on party invitations that are finished.
+     */
+    partyKey?: dxos_halo_keys.PubKey;
+}
+export interface AuthenticateInvitationRequest {
+    /**
+     * Id from corresponding RedeemedInvitation.
+     */
+    processId?: string;
+    secret?: Uint8Array;
+}
+export interface Profile {
+    publicKey: dxos_halo_keys.PubKey;
+    username?: string;
+}
+export interface SubscribeProfileResponse {
+    profile?: Profile;
+}
+export interface CreateProfileRequest {
+    username?: string;
+    publicKey?: Uint8Array;
+    secretKey?: Uint8Array;
+}
+export interface RecoverProfileRequest {
+    seedPhrase?: string;
+}
+export interface Contact {
+    publicKey?: dxos_halo_keys.PubKey;
+    displayName?: string;
+}
+export interface Contacts {
+    contacts?: Contact[];
+}
+export interface ProfileService {
+    subscribeProfile: (request: void) => Stream<SubscribeProfileResponse>;
+    createProfile: (request: CreateProfileRequest) => Promise<Profile>;
+    recoverProfile: (request: RecoverProfileRequest) => Promise<Profile>;
+    createInvitation: (request: void) => Stream<InvitationRequest>;
+    acceptInvitation: (request: dxos_echo_invitation.InvitationDescriptor) => Stream<RedeemedInvitation>;
+    authenticateInvitation: (request: AuthenticateInvitationRequest) => Promise<void>;
+}
+export interface AddKeyRecordRequest {
+    keyRecord?: dxos_halo_keys.KeyRecord;
+}
+export interface SignRequest {
+    /**
+     * - The public key of the key that is supposed to be used for signing.
+     */
+    publicKey?: dxos_halo_keys.PubKey;
+    payload?: Uint8Array;
+}
+export interface SignResponse {
+    signed?: Uint8Array;
+}
+export interface SetPreferenceRequest {
+    key?: string;
+    value?: string;
+}
+export interface GetPreferenceRequest {
+    key?: string;
+}
+export interface GetPreferenceResponse {
+    value?: string;
+}
+export interface HaloService {
+    subscribeContacts: (request: void) => Stream<Contacts>;
+    addKeyRecord: (request: AddKeyRecordRequest) => Promise<void>;
+    sign: (request: SignRequest) => Promise<SignResponse>;
+    setGlobalPreference: (request: SetPreferenceRequest) => Promise<void>;
+    getGlobalPreference: (request: GetPreferenceRequest) => Promise<GetPreferenceResponse>;
+    setDevicePreference: (request: SetPreferenceRequest) => Promise<void>;
+    getDevicePreference: (request: GetPreferenceRequest) => Promise<GetPreferenceResponse>;
+}
+export interface Party {
+    publicKey: dxos_halo_keys.PubKey;
+    isOpen: boolean;
+    isActive: boolean;
+    members?: Party.Member[];
+}
+export namespace Party {
+    export interface Member {
+        publicKey: dxos_halo_keys.PubKey;
+        displayName?: string;
+    }
+}
+export interface SubscribePartyRequest {
+    partyKey: dxos_halo_keys.PubKey;
+}
+export interface SubscribePartyResponse {
+    party?: Party;
+}
+export interface SubscribePartiesResponse {
+    parties?: Party[];
+}
+export interface CreateInvitationRequest {
+    partyKey: dxos_halo_keys.PubKey;
+    /**
+     * When specified the invitation will be of OFFLINE type, not requiring secret exchange.
+     */
+    inviteeKey?: dxos_halo_keys.PubKey;
+}
+export interface PartyActivationOptions {
+    global?: boolean;
+    device?: boolean;
+}
+export interface SetPartyStateRequest {
+    partyKey: dxos_halo_keys.PubKey;
+    open?: boolean;
+    activeGlobal?: boolean;
+    activeDevice?: boolean;
+}
+export interface SubscribeMembersRequest {
+    partyKey: dxos_halo_keys.PubKey;
+}
+export interface SubscribeMembersResponse {
+    members?: SubscribeMembersResponse.PartyMember[];
+}
+export namespace SubscribeMembersResponse {
+    export interface PartyMember {
+        publicKey: dxos_halo_keys.PubKey;
+        displayName?: string;
+    }
+}
+export interface CreateSnaspotRequest {
+    partyKey?: dxos_halo_keys.PubKey;
+}
+export interface PartyService {
+    subscribeToParty: (request: SubscribePartyRequest) => Stream<SubscribePartyResponse>;
+    subscribeParties: (request: void) => Stream<SubscribePartiesResponse>;
+    createParty: (request: void) => Promise<Party>;
+    cloneParty: (request: dxos_echo_snapshot.PartySnapshot) => Promise<Party>;
+    /**
+     * Open and close or activate and deactivate a party.
+     */
+    setPartyState: (request: SetPartyStateRequest) => Promise<Party>;
+    createInvitation: (request: CreateInvitationRequest) => Stream<InvitationRequest>;
+    acceptInvitation: (request: dxos_echo_invitation.InvitationDescriptor) => Stream<RedeemedInvitation>;
+    authenticateInvitation: (request: AuthenticateInvitationRequest) => Promise<void>;
+    subscribeMembers: (request: SubscribeMembersRequest) => Stream<SubscribeMembersResponse>;
+    createSnapshot: (request: CreateSnaspotRequest) => Promise<dxos_echo_snapshot.PartySnapshot>;
+}

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

@@ -0,0 +1,225 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import * as dxos_bot from "./bot";
+import * as dxos_client from "./client";
+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 dxos_rpc from "./rpc";
+import * as google_protobuf from "../google/protobuf";
+export interface Config {
+    version?: number;
+    module?: Module;
+    build?: Build;
+    runtime?: Runtime;
+}
+export interface Module {
+    name?: string;
+    type?: string;
+    version?: string;
+    author?: string;
+    license?: string;
+    description?: string;
+    repository?: string;
+    repositoryVersion?: string;
+    keywords?: string[];
+    displayName?: string;
+    npmUrl?: string;
+    build?: Module.Build;
+    record?: Module.Record;
+}
+export namespace Module {
+    export interface Record {
+        app?: Module.Record.App;
+    }
+    export namespace Record {
+        export interface App {
+            contentType?: string[];
+        }
+    }
+    export interface Build {
+        version?: string;
+        commitHash?: string;
+        timestamp?: google_protobuf.Timestamp;
+    }
+}
+export interface Build {
+    command?: string;
+    out?: string;
+}
+export interface Runtime {
+    client?: Runtime.Client;
+    app?: Runtime.App;
+    cli?: Runtime.CLI;
+    props?: Runtime.Props;
+    services?: Runtime.Services;
+    system?: Runtime.System;
+}
+export namespace Runtime {
+    export interface Client {
+        /**
+         * Options:
+         *   - (env) = "DEBUG"
+         */
+        debug?: string;
+        storage?: Runtime.Client.Storage;
+        enableSnapshots?: boolean;
+        /**
+         * Milliseconds
+         */
+        snapshotInterval?: number;
+        /**
+         * Milliseconds
+         */
+        invitationExpiration?: number;
+        mode?: Runtime.Client.Mode;
+    }
+    export namespace Client {
+        export enum Mode {
+            AUTOMATIC = 0,
+            LOCAL = 1,
+            REMOTE = 2
+        }
+        export interface Storage {
+            persistent?: boolean;
+            storageType?: Runtime.Client.Storage.StorageDriver;
+            keyStorage?: Runtime.Client.Storage.StorageDriver;
+            path?: string;
+        }
+        export namespace Storage {
+            export enum StorageDriver {
+                RAM = 0,
+                IDB = 1,
+                CHROME = 2,
+                FIREFOX = 3,
+                NODE = 4,
+                LEVELJS = 11,
+                JSONDOWN = 12
+            }
+        }
+    }
+    export interface App {
+        org?: string;
+        theme?: string;
+        website?: string;
+        /**
+         * Options:
+         *   - (env) = "PUBLIC_URL"
+         */
+        publicUrl?: string;
+    }
+    export interface CLI {
+        nodePath?: string;
+        app?: Runtime.CLI.AppServe;
+        console?: Runtime.CLI.Package;
+        mdns?: Runtime.CLI.Package;
+        signal?: Runtime.CLI.Package;
+        npmClient?: string;
+        channel?: string;
+    }
+    export namespace CLI {
+        export interface AppServe {
+            serve?: Runtime.CLI.AppServe.Serve;
+        }
+        export namespace AppServe {
+            export interface Serve {
+                config?: string;
+                loginApp?: string;
+                keyPhrase?: string;
+            }
+        }
+        export interface Package {
+            package?: string;
+            channel?: string;
+            bin?: string;
+            config?: string;
+        }
+    }
+    export interface Props {
+        title?: string;
+    }
+    export interface System {
+        debug?: string;
+    }
+    export interface Services {
+        kube?: Runtime.Services.Kube;
+        app?: Runtime.Services.AppServer;
+        dxns?: Runtime.Services.Dxns;
+        ipfs?: Runtime.Services.Ipfs;
+        signal?: Runtime.Services.Signal;
+        ice?: Runtime.Services.Ice[];
+        machine?: Runtime.Services.Machine;
+        bot?: Runtime.Services.BotFactory;
+    }
+    export namespace Services {
+        export interface Kube {
+            endpoints?: Runtime.Services.Kube.Endpoints;
+            publicUrl?: string;
+        }
+        export namespace Kube {
+            export interface Endpoints {
+                logs?: string;
+                services?: string;
+                cert?: string;
+            }
+        }
+        export interface AppServer {
+            prefix?: string;
+            server?: string;
+        }
+        export interface Dxns {
+            /**
+             * DXNS endpoint.
+             */
+            server?: string;
+            /**
+             * Substrate account URI. This is a secret.
+             * KUBEs do not serve this with the config but we store it in profile.yml.
+             *
+             * TODO(dmaretskyi): Deprecate this and move it to keyring.
+             */
+            accountUri?: string;
+            /**
+             * Public Polkadot Address.
+             */
+            address?: string;
+            /**
+             * Public address of a DXNS Account.
+             */
+            account?: string;
+            faucet?: string;
+        }
+        export interface Ipfs {
+            server?: string;
+            gateway?: string;
+        }
+        export interface Signal {
+            server?: string;
+            api?: string;
+            status?: string;
+        }
+        export interface Ice {
+            urls?: string;
+            username?: string;
+            credential?: string;
+        }
+        export interface Machine {
+            doAccessToken?: string;
+            githubAccessToken?: string;
+            githubUsername?: string;
+            dnsDomain?: string;
+            npmAccessToken?: string;
+        }
+        export interface BotFactory {
+            topic?: string;
+        }
+    }
+}

package/src/proto/gen/dxos/credentials/auth.ts

@@ -0,0 +1,26 @@
+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_greet from "./greet";
+import * as dxos_credentials_identity from "./identity";
+import * as dxos_credentials_party from "./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 dxos_rpc from "../rpc";
+import * as google_protobuf from "../../google/protobuf";
+/**
+ * The payload for a SignedMessage sent during handshake for replication authentication.
+ */
+export interface Auth {
+    partyKey?: dxos_halo_keys.PubKey;
+    deviceKey?: dxos_halo_keys.PubKey;
+    identityKey?: dxos_halo_keys.PubKey;
+    feedKey?: dxos_halo_keys.PubKey;
+}

package/src/proto/gen/dxos/credentials/greet.ts

@@ -0,0 +1,53 @@
+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 "./auth";
+import * as dxos_credentials_identity from "./identity";
+import * as dxos_credentials_party from "./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 dxos_rpc from "../rpc";
+import * as google_protobuf from "../../google/protobuf";
+/**
+ * A Greeter command.
+ */
+export interface Command {
+    command?: Command.Type;
+    secret?: Uint8Array;
+    params?: google_protobuf.Any[];
+}
+export namespace Command {
+    export enum Type {
+        BEGIN = 0,
+        HANDSHAKE = 1,
+        NOTARIZE = 2,
+        FINISH = 3,
+        CLAIM = 10
+    }
+}
+export interface BeginResponse {
+    info?: Partial<Record<string, google_protobuf.Any>>;
+}
+export interface HandshakeResponse {
+    nonce?: Uint8Array;
+    partyKey?: dxos_halo_keys.PubKey;
+}
+export interface NotarizeResponse {
+    copies?: google_protobuf.Any[];
+    hints?: KeyHint[];
+}
+export interface KeyHint {
+    publicKey?: dxos_halo_keys.PubKey;
+    type?: dxos_halo_keys.KeyType;
+}
+export interface ClaimResponse {
+    id?: Uint8Array;
+    rendezvousKey?: Uint8Array;
+}

package/src/proto/gen/dxos/credentials/identity.ts

@@ -0,0 +1,25 @@
+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 "./auth";
+import * as dxos_credentials_greet from "./greet";
+import * as dxos_credentials_party from "./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 dxos_rpc from "../rpc";
+import * as google_protobuf from "../../google/protobuf";
+export interface IdentityInfo {
+    publicKey?: dxos_halo_keys.PubKey;
+    displayName?: string;
+}
+export interface DeviceInfo {
+    publicKey?: dxos_halo_keys.PubKey;
+    displayName?: string;
+}

package/src/proto/gen/dxos/credentials/party.ts

@@ -0,0 +1,63 @@
+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 "./auth";
+import * as dxos_credentials_greet from "./greet";
+import * as dxos_credentials_identity from "./identity";
+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 dxos_rpc from "../rpc";
+import * as google_protobuf from "../../google/protobuf";
+export interface PartyCredential {
+    type?: PartyCredential.Type;
+    envelope?: Envelope;
+    partyGenesis?: PartyGenesis;
+    keyAdmit?: KeyAdmit;
+    feedAdmit?: FeedAdmit;
+    feedGenesis?: FeedGenesis;
+}
+export namespace PartyCredential {
+    export enum Type {
+        ENVELOPE = 0,
+        PARTY_GENESIS = 1,
+        FEED_GENESIS = 2,
+        KEY_ADMIT = 3,
+        FEED_ADMIT = 4
+    }
+}
+export interface PartyGenesis {
+    partyKey?: dxos_halo_keys.PubKey;
+    feedKey?: dxos_halo_keys.PubKey;
+    admitKey?: dxos_halo_keys.PubKey;
+    admitKeyType?: dxos_halo_keys.KeyType;
+}
+export interface KeyAdmit {
+    partyKey?: dxos_halo_keys.PubKey;
+    admitKey?: dxos_halo_keys.PubKey;
+    admitKeyType?: dxos_halo_keys.KeyType;
+}
+export interface FeedAdmit {
+    partyKey?: dxos_halo_keys.PubKey;
+    feedKey?: dxos_halo_keys.PubKey;
+}
+export interface FeedGenesis {
+    feedKey?: dxos_halo_keys.PubKey;
+    ownerKey?: dxos_halo_keys.PubKey;
+}
+export interface Envelope {
+    partyKey?: dxos_halo_keys.PubKey;
+    message?: dxos_credentials.Message;
+}
+export interface PartyInvitation {
+    id?: Uint8Array;
+    partyKey?: dxos_halo_keys.PubKey;
+    issuerKey?: dxos_halo_keys.PubKey;
+    inviteeKey?: dxos_halo_keys.PubKey;
+}

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

@@ -0,0 +1,39 @@
+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_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 dxos_rpc from "./rpc";
+import * as google_protobuf from "../google/protobuf";
+export interface Message {
+    payload: google_protobuf.Any;
+}
+/**
+ * A generic container message used whenever messages are signed (e.g. PartyCredential)
+ */
+export interface SignedMessage {
+    signed: SignedMessage.Signed;
+    signatures?: SignedMessage.Signature[];
+}
+export namespace SignedMessage {
+    export interface Signed {
+        created: string;
+        nonce: Uint8Array;
+        payload: google_protobuf.Any;
+    }
+    export interface Signature {
+        key: dxos_halo_keys.PubKey;
+        signature: Uint8Array;
+        keyChain?: dxos_halo_keys.KeyChain;
+    }
+}