@dxos/protocols 0.1.0

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

@@ -0,0 +1,422 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import substitutions from "../../substitutions";
+import * as dxos_bot from "./bot";
+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_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_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";
+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.proto}
+ */
+export interface SystemService {
+    getConfig: (request: void) => Promise<dxos_config.Config>;
+    reset: (request: void) => Promise<void>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export enum InvitationState {
+    WAITING_FOR_CONNECTION = 0,
+    CONNECTED = 1,
+    SUCCESS = 2,
+    ERROR = 3
+}
+/**
+ * Invitation process created by sender.
+ *
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface InvitationRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    descriptor?: dxos_halo_invitations.InvitationDescriptor;
+    state: InvitationState;
+    /**
+     * Only if state == ERROR.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    error?: string;
+}
+/**
+ * Invitation that is being redeemed.
+ *
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface RedeemedInvitation {
+    id: string;
+    state: InvitationState;
+    /**
+     * Only if state == ERROR.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    error?: string;
+    /**
+     * Only on party invitations that are finished.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    partyKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface AuthenticateInvitationRequest {
+    /**
+     * Id from corresponding RedeemedInvitation.
+     */
+    processId: string;
+    secret: Uint8Array;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface Profile {
+    publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    username?: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface SubscribeProfileResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    profile?: Profile;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface CreateProfileRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    username?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    publicKey?: Uint8Array;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    secretKey?: Uint8Array;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface RecoverProfileRequest {
+    seedPhrase: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface Contact {
+    publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    displayName?: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface Contacts {
+    contacts?: Contact[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface ProfileService {
+    createProfile: (request: CreateProfileRequest) => Promise<Profile>;
+    recoverProfile: (request: RecoverProfileRequest) => Promise<Profile>;
+    subscribeProfile: (request: void) => Stream<SubscribeProfileResponse>;
+    createInvitation: (request: void) => Stream<InvitationRequest>;
+    acceptInvitation: (request: dxos_halo_invitations.InvitationDescriptor) => Stream<RedeemedInvitation>;
+    authenticateInvitation: (request: AuthenticateInvitationRequest) => Promise<void>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface AddKeyRecordRequest {
+    keyRecord: dxos_halo_keys.KeyRecord;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface SignRequest {
+    /**
+     * - The public key of the key that is supposed to be used for signing.
+     */
+    publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    payload: Uint8Array;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface SignResponse {
+    signed: Uint8Array;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface SetPreferenceRequest {
+    key: string;
+    value: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface GetPreferenceRequest {
+    key: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface GetPreferenceResponse {
+    value: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface HaloService {
+    sign: (request: SignRequest) => Promise<SignResponse>;
+    addKeyRecord: (request: AddKeyRecordRequest) => Promise<void>;
+    subscribeContacts: (request: void) => Stream<Contacts>;
+    setGlobalPreference: (request: SetPreferenceRequest) => Promise<void>;
+    getGlobalPreference: (request: GetPreferenceRequest) => Promise<GetPreferenceResponse>;
+    setDevicePreference: (request: SetPreferenceRequest) => Promise<void>;
+    getDevicePreference: (request: GetPreferenceRequest) => Promise<GetPreferenceResponse>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface Party {
+    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;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface SubscribePartyRequest {
+    partyKey: 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"]>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface PartyDetails {
+    /**
+     * The timeframe of mutations processed by the client.
+     */
+    processedTimeframe: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface SubscribePartyResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    party?: Party;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface SubscribePartiesResponse {
+    parties?: Party[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface CreateInvitationRequest {
+    partyKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * When specified the invitation will be of OFFLINE type, not requiring secret exchange.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    inviteeKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface PartyActivationOptions {
+    global: boolean;
+    device: boolean;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface SetPartyStateRequest {
+    partyKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    open?: boolean;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    activeGlobal?: boolean;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    activeDevice?: boolean;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface SubscribeMembersRequest {
+    partyKey: 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;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/client.proto}
+ */
+export interface CreateSnapshotRequest {
+    partyKey: 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>;
+    /**
+     * Open and close or activate and deactivate a party.
+     */
+    setPartyState: (request: SetPartyStateRequest) => Promise<Party>;
+    createInvitation: (request: CreateInvitationRequest) => Stream<InvitationRequest>;
+    acceptInvitation: (request: dxos_halo_invitations.InvitationDescriptor) => Stream<RedeemedInvitation>;
+    authenticateInvitation: (request: AuthenticateInvitationRequest) => Promise<void>;
+    subscribeMembers: (request: SubscribeMembersRequest) => Stream<SubscribeMembersResponse>;
+    createSnapshot: (request: CreateSnapshotRequest) => Promise<dxos_echo_snapshot.PartySnapshot>;
+}