@dxos/protocols 0.1.1 → 0.1.3

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

@@ -0,0 +1,283 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import substitutions from "../../../substitutions";
+import * as dxos_bot from "../bot";
+import * as dxos_client from "../client";
+import * as dxos_config from "../config";
+import * as dxos_devtools_host from "../devtools/host";
+import * as dxos_devtools_swarm from "../devtools/swarm";
+import * as dxos_echo_feed from "../echo/feed";
+import * as dxos_echo_metadata from "../echo/metadata";
+import * as dxos_echo_model_messenger from "../echo/model/messenger";
+import * as dxos_echo_model_object from "../echo/model/object";
+import * as dxos_echo_model_text from "../echo/model/text";
+import * as dxos_echo_service from "../echo/service";
+import * as dxos_echo_snapshot from "../echo/snapshot";
+import * as dxos_echo_timeframe from "../echo/timeframe";
+import * as dxos_halo_credentials from "../halo/credentials";
+import * as dxos_halo_credentials_auth from "../halo/credentials/auth";
+import * as dxos_halo_credentials_greet from "../halo/credentials/greet";
+import * as dxos_halo_credentials_identity from "../halo/credentials/identity";
+import * as dxos_halo_invitations from "../halo/invitations";
+import * as dxos_halo_keyring from "../halo/keyring";
+import * as dxos_halo_keys from "../halo/keys";
+import * as dxos_halo_signed from "../halo/signed";
+import * as dxos_iframe from "../iframe";
+import * as dxos_keys from "../keys";
+import * as dxos_mesh_bridge from "../mesh/bridge";
+import * as dxos_mesh_broadcast from "../mesh/broadcast";
+import * as dxos_mesh_messaging from "../mesh/messaging";
+import * as dxos_mesh_presence from "../mesh/presence";
+import * as dxos_mesh_protocol from "../mesh/protocol";
+import * as dxos_mesh_replicator from "../mesh/replicator";
+import * as dxos_mesh_signal from "../mesh/signal";
+import * as dxos_mesh_swarm from "../mesh/swarm";
+import * as dxos_registry from "../registry";
+import * as dxos_rpc from "../rpc";
+import * as dxos_service_publisher from "../service/publisher";
+import * as dxos_service_scheduler from "../service/scheduler";
+import * as dxos_type from "../type";
+import * as example_testing_data from "../../example/testing/data";
+import * as example_testing_rpc from "../../example/testing/rpc";
+import * as google_protobuf from "../../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface SystemService {
+    getConfig: (request: void) => Promise<dxos_config.Config>;
+    reset: (request: void) => Promise<void>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface KeyRecord {
+    publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface SignRequest {
+    publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    payload: Uint8Array;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface SignResponse {
+    signed: Uint8Array;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface SigningService {
+    updateKeyRecord: (request: KeyRecord) => Promise<KeyRecord>;
+    sign: (request: SignRequest) => Promise<SignResponse>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface Identity {
+    identityKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    profile: dxos_halo_credentials.ProfileDocument;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface RecoverProfileRequest {
+    recoveryKey: Uint8Array;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface HaloService {
+    recoverProfile: (request: RecoverProfileRequest) => Promise<Identity>;
+    updateProfile: (request: Identity) => Promise<void>;
+    queryProfile: (request: void) => Stream<Identity>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface Device {
+    deviceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface QueryDevicesResponse {
+    devices?: Device[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface DevicesService {
+    updateDevice: (request: void) => Promise<Device>;
+    queryDevices: (request: void) => Stream<QueryDevicesResponse>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface Contact {
+    profile: dxos_halo_credentials.ProfileDocument;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface ContactsService {
+    updateContact: (request: void) => Promise<Contact>;
+    queryContacts: (request: void) => Stream<Contact>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface Space {
+    spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface QueryMembersRequest {
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface QueryMembersResponse {
+    members: dxos_halo_credentials.IdentityProfile;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface SpacesService {
+    createSpace: (request: void) => Promise<Space>;
+    querySpaces: (request: void) => Stream<Space>;
+    queryMembers: (request: QueryMembersRequest) => Stream<QueryMembersResponse>;
+}
+/**
+ * Represents the invitation state passed between client and service.
+ *
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface Invitation {
+    /**
+     * Local identifier.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    invitationId?: string;
+    /**
+     * Determined when created.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    type?: Invitation.Type;
+    /**
+     * Local state.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    state?: Invitation.State;
+    /**
+     * Local error code.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    errorCode?: number;
+    /**
+     * Swarm rendezvous (random).
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    swarmKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Guest's identity (only present if OFFLINE).
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    identityKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Authentication code created by host.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    authenticationCode?: string;
+    /**
+     * Space key (if data invitation).
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+}
+export namespace Invitation {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/services.proto}
+     */
+    export enum Type {
+        INTERACTIVE = 0,
+        INTERACTIVE_TESTING = 1,
+        OFFLINE = 2
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/services.proto}
+     */
+    export enum State {
+        INIT = 0,
+        CONNECTING = 1,
+        CONNECTED = 2,
+        AUTHENTICATING = 3,
+        SUCCESS = 4,
+        CANCELLED = 5,
+        TIMEOUT = 6,
+        ERROR = 7
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface AuthenticationRequest {
+    invitationId: string;
+    authenticationCode: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface CancelInvitationRequest {
+    invitationId: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface InvitationsService {
+    createInvitation: (request: Invitation) => Stream<Invitation>;
+    authenticate: (request: AuthenticationRequest) => Promise<void>;
+    acceptInvitation: (request: Invitation) => Stream<Invitation>;
+    cancelInvitation: (request: CancelInvitationRequest) => Promise<void>;
+}

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

@@ -1,9 +1,10 @@
 import type { Stream } from "@dxos/codec-protobuf";
 import substitutions from "../../substitutions";
 import * as dxos_bot from "./bot";
+import * as dxos_client_services from "./client/services";
 import * as dxos_config from "./config";
 import * as dxos_devtools_host from "./devtools/host";
-import * as dxos_devtools_swarmLog from "./devtools/swarmLog";
+import * as dxos_devtools_swarm from "./devtools/swarm";
 import * as dxos_echo_feed from "./echo/feed";
 import * as dxos_echo_metadata from "./echo/metadata";
 import * as dxos_echo_model_messenger from "./echo/model/messenger";
@@ -16,7 +17,6 @@ import * as dxos_halo_credentials from "./halo/credentials";
 import * as dxos_halo_credentials_auth from "./halo/credentials/auth";
 import * as dxos_halo_credentials_greet from "./halo/credentials/greet";
 import * as dxos_halo_credentials_identity from "./halo/credentials/identity";
-import * as dxos_halo_credentials_party from "./halo/credentials/party";
 import * as dxos_halo_invitations from "./halo/invitations";
 import * as dxos_halo_keyring from "./halo/keyring";
 import * as dxos_halo_keys from "./halo/keys";
@@ -68,7 +68,7 @@ export interface InvitationRequest {
      * Options:
      *   - proto3_optional = true
      */
-    descriptor?: dxos_halo_invitations.InvitationDescriptor;
+    descriptor?: dxos_client_services.Invitation;
     state: InvitationState;
     /**
      * Only if state == ERROR.
@@ -95,12 +95,12 @@ export interface RedeemedInvitation {
      */
     error?: string;
     /**
-     * Only on party invitations that are finished.
+     * Only on space invitations that are finished.
      *
      * Options:
      *   - proto3_optional = true
      */
-    partyKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
 }
 /**
  * Defined in:
@@ -118,12 +118,12 @@ export interface AuthenticateInvitationRequest {
  *   {@link file://./../../dxos/client.proto}
  */
 export interface Profile {
-    publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    identityKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     /**
      * Options:
      *   - proto3_optional = true
      */
-    username?: string;
+    displayName?: string;
 }
 /**
  * Defined in:
@@ -145,17 +145,17 @@ export interface CreateProfileRequest {
      * Options:
      *   - proto3_optional = true
      */
-    username?: string;
+    publicKey?: Uint8Array;
     /**
      * Options:
      *   - proto3_optional = true
      */
-    publicKey?: Uint8Array;
+    secretKey?: Uint8Array;
     /**
      * Options:
      *   - proto3_optional = true
      */
-    secretKey?: Uint8Array;
+    displayName?: string;
 }
 /**
  * Defined in:
@@ -192,7 +192,7 @@ export interface ProfileService {
     recoverProfile: (request: RecoverProfileRequest) => Promise<Profile>;
     subscribeProfile: (request: void) => Stream<SubscribeProfileResponse>;
     createInvitation: (request: void) => Stream<InvitationRequest>;
-    acceptInvitation: (request: dxos_halo_invitations.InvitationDescriptor) => Stream<RedeemedInvitation>;
+    acceptInvitation: (request: dxos_client_services.Invitation) => Stream<RedeemedInvitation>;
     authenticateInvitation: (request: AuthenticateInvitationRequest) => Promise<void>;
 }
 /**
@@ -259,45 +259,31 @@ export interface HaloService {
  * Defined in:
  *   {@link file://./../../dxos/client.proto}
  */
-export interface Party {
+export interface Space {
     publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     isOpen: boolean;
     isActive: boolean;
-    members?: Party.Member[];
-}
-export namespace Party {
-    /**
-     * Defined in:
-     *   {@link file://./../../dxos/client.proto}
-     */
-    export interface Member {
-        publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        displayName?: string;
-    }
+    members?: SpaceMember[];
 }
 /**
  * Defined in:
  *   {@link file://./../../dxos/client.proto}
  */
-export interface SubscribePartyRequest {
-    partyKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+export interface SubscribeSpaceRequest {
+    spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
 }
 /**
  * Defined in:
  *   {@link file://./../../dxos/client.proto}
  */
-export interface GetPartyDetailsRequest {
-    partyKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+export interface GetSpaceDetailsRequest {
+    spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
 }
 /**
  * Defined in:
  *   {@link file://./../../dxos/client.proto}
  */
-export interface PartyDetails {
+export interface SpaceDetails {
     /**
      * The timeframe of mutations processed by the client.
      */
@@ -307,26 +293,38 @@ export interface PartyDetails {
  * Defined in:
  *   {@link file://./../../dxos/client.proto}
  */
-export interface SubscribePartyResponse {
+export interface SpaceMember {
+    identityKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    profile?: Profile;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface SubscribeSpaceResponse {
     /**
      * Options:
      *   - proto3_optional = true
      */
-    party?: Party;
+    space?: Space;
 }
 /**
  * Defined in:
  *   {@link file://./../../dxos/client.proto}
  */
-export interface SubscribePartiesResponse {
-    parties?: Party[];
+export interface SubscribeSpacesResponse {
+    spaces?: Space[];
 }
 /**
  * Defined in:
  *   {@link file://./../../dxos/client.proto}
  */
 export interface CreateInvitationRequest {
-    partyKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     /**
      * When specified the invitation will be of OFFLINE type, not requiring secret exchange.
      *
@@ -339,7 +337,7 @@ export interface CreateInvitationRequest {
  * Defined in:
  *   {@link file://./../../dxos/client.proto}
  */
-export interface PartyActivationOptions {
+export interface SpaceActivationOptions {
     global: boolean;
     device: boolean;
 }
@@ -347,8 +345,8 @@ export interface PartyActivationOptions {
  * Defined in:
  *   {@link file://./../../dxos/client.proto}
  */
-export interface SetPartyStateRequest {
-    partyKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+export interface SetSpaceStateRequest {
+    spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     /**
      * Options:
      *   - proto3_optional = true
@@ -370,53 +368,36 @@ export interface SetPartyStateRequest {
  *   {@link file://./../../dxos/client.proto}
  */
 export interface SubscribeMembersRequest {
-    partyKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
 }
 /**
  * Defined in:
  *   {@link file://./../../dxos/client.proto}
  */
 export interface SubscribeMembersResponse {
-    members?: SubscribeMembersResponse.PartyMember[];
-}
-export namespace SubscribeMembersResponse {
-    /**
-     * Defined in:
-     *   {@link file://./../../dxos/client.proto}
-     */
-    export interface PartyMember {
-        publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        displayName?: string;
-    }
+    members?: SpaceMember[];
 }
 /**
  * Defined in:
  *   {@link file://./../../dxos/client.proto}
  */
 export interface CreateSnapshotRequest {
-    partyKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
 }
 /**
  * Defined in:
  *   {@link file://./../../dxos/client.proto}
  */
-export interface PartyService {
-    subscribeToParty: (request: SubscribePartyRequest) => Stream<SubscribePartyResponse>;
-    subscribeParties: (request: void) => Stream<SubscribePartiesResponse>;
-    getPartyDetails: (request: GetPartyDetailsRequest) => Promise<PartyDetails>;
-    createParty: (request: void) => Promise<Party>;
-    cloneParty: (request: dxos_echo_snapshot.PartySnapshot) => Promise<Party>;
+export interface SpaceService {
+    subscribeToSpace: (request: SubscribeSpaceRequest) => Stream<SubscribeSpaceResponse>;
+    subscribeSpaces: (request: void) => Stream<SubscribeSpacesResponse>;
+    getSpaceDetails: (request: GetSpaceDetailsRequest) => Promise<SpaceDetails>;
+    createSpace: (request: void) => Promise<Space>;
+    cloneSpace: (request: dxos_echo_snapshot.SpaceSnapshot) => Promise<Space>;
     /**
-     * Open and close or activate and deactivate a party.
+     * Open and close or activate and deactivate a space.
      */
-    setPartyState: (request: SetPartyStateRequest) => Promise<Party>;
-    createInvitation: (request: CreateInvitationRequest) => Stream<InvitationRequest>;
-    acceptInvitation: (request: dxos_halo_invitations.InvitationDescriptor) => Stream<RedeemedInvitation>;
-    authenticateInvitation: (request: AuthenticateInvitationRequest) => Promise<void>;
+    setSpaceState: (request: SetSpaceStateRequest) => Promise<Space>;
     subscribeMembers: (request: SubscribeMembersRequest) => Stream<SubscribeMembersResponse>;
-    createSnapshot: (request: CreateSnapshotRequest) => Promise<dxos_echo_snapshot.PartySnapshot>;
+    createSnapshot: (request: CreateSnapshotRequest) => Promise<dxos_echo_snapshot.SpaceSnapshot>;
 }

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

@@ -2,8 +2,9 @@ import type { Stream } from "@dxos/codec-protobuf";
 import substitutions from "../../substitutions";
 import * as dxos_bot from "./bot";
 import * as dxos_client from "./client";
+import * as dxos_client_services from "./client/services";
 import * as dxos_devtools_host from "./devtools/host";
-import * as dxos_devtools_swarmLog from "./devtools/swarmLog";
+import * as dxos_devtools_swarm from "./devtools/swarm";
 import * as dxos_echo_feed from "./echo/feed";
 import * as dxos_echo_metadata from "./echo/metadata";
 import * as dxos_echo_model_messenger from "./echo/model/messenger";
@@ -16,7 +17,6 @@ import * as dxos_halo_credentials from "./halo/credentials";
 import * as dxos_halo_credentials_auth from "./halo/credentials/auth";
 import * as dxos_halo_credentials_greet from "./halo/credentials/greet";
 import * as dxos_halo_credentials_identity from "./halo/credentials/identity";
-import * as dxos_halo_credentials_party from "./halo/credentials/party";
 import * as dxos_halo_invitations from "./halo/invitations";
 import * as dxos_halo_keyring from "./halo/keyring";
 import * as dxos_halo_keys from "./halo/keys";
@@ -244,11 +244,6 @@ export namespace Runtime {
          *   - proto3_optional = true
          */
         invitationExpiration?: number;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        mode?: Runtime.Client.Mode;
         /**
          * Options:
          *   - proto3_optional = true
@@ -256,17 +251,6 @@ export namespace Runtime {
         remoteSource?: string;
     }
     export namespace Client {
-        /**
-         * Whether the client services are local with ClientServiceHost or remote and need to be accessed via ClientServiceProxy. Defaults to AUTOMATIC.
-         *
-         * Defined in:
-         *   {@link file://./../../dxos/config.proto}
-         */
-        export enum Mode {
-            AUTOMATIC = 0,
-            LOCAL = 1,
-            REMOTE = 2
-        }
         /**
          * Defined in:
          *   {@link file://./../../dxos/config.proto}