@dxos/client 2.33.9-dev.d0ae5f95 → 2.33.9-dev.d0dce35f

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

@@ -0,0 +1,491 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import substitutions from "../../substitutions";
+import * as dxos_config from "./config";
+import * as dxos_credentials from "./credentials";
+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_service from "./echo/service";
+import * as dxos_echo_snapshot from "./echo/snapshot";
+import * as dxos_echo_timeframe from "./echo/timeframe";
+import * as dxos_halo_keys from "./halo/keys";
+import * as dxos_rpc from "./rpc";
+import * as google_protobuf from "../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface SystemService {
+    getConfig: (request: void) => Promise<dxos_config.Config>;
+    reset: (request: void) => Promise<void>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export enum InvitationState {
+    WAITING_FOR_CONNECTION = 1,
+    CONNECTED = 2,
+    SUCCESS = 3,
+    ERROR = 4
+}
+/**
+ * Invitation process created by sender.
+ *
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface InvitationRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    descriptor?: dxos_echo_invitation.InvitationDescriptor;
+    state: InvitationState;
+    /**
+     * Only if state == ERROR.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    error?: string;
+}
+/**
+ * Invitation that is being redeemed.
+ *
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/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.halo.keys.PubKey"]["decode"]>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface AuthenticateInvitationRequest {
+    /**
+     * Id from corresponding RedeemedInvitation.
+     */
+    processId: string;
+    secret: Uint8Array;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface Profile {
+    publicKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    username?: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface SubscribeProfileResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    profile?: Profile;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/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://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface RecoverProfileRequest {
+    seedPhrase: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface Contact {
+    publicKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    displayName?: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface Contacts {
+    contacts?: Contact[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+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>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface AddKeyRecordRequest {
+    keyRecord: dxos_halo_keys.KeyRecord;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/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.halo.keys.PubKey"]["decode"]>;
+    payload: Uint8Array;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface SignResponse {
+    signed: Uint8Array;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface SetPreferenceRequest {
+    key: string;
+    value: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface GetPreferenceRequest {
+    key: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface GetPreferenceResponse {
+    value: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/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://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface Party {
+    publicKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    isOpen: boolean;
+    isActive: boolean;
+    members?: Party.Member[];
+}
+export namespace Party {
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+     */
+    export interface Member {
+        publicKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        displayName?: string;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface SubscribePartyRequest {
+    partyKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface GetPartyDetailsRequest {
+    partyKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/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://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface SubscribePartyResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    party?: Party;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface SubscribePartiesResponse {
+    parties?: Party[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface CreateInvitationRequest {
+    partyKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    /**
+     * When specified the invitation will be of OFFLINE type, not requiring secret exchange.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    inviteeKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface PartyActivationOptions {
+    global: boolean;
+    device: boolean;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface SetPartyStateRequest {
+    partyKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    open?: boolean;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    activeGlobal?: boolean;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    activeDevice?: boolean;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface SubscribeMembersRequest {
+    partyKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface SubscribeMembersResponse {
+    members?: SubscribeMembersResponse.PartyMember[];
+}
+export namespace SubscribeMembersResponse {
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+     */
+    export interface PartyMember {
+        publicKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        displayName?: string;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface CreateSnaspotRequest {
+    partyKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/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_echo_invitation.InvitationDescriptor) => Stream<RedeemedInvitation>;
+    authenticateInvitation: (request: AuthenticateInvitationRequest) => Promise<void>;
+    subscribeMembers: (request: SubscribeMembersRequest) => Stream<SubscribeMembersResponse>;
+    createSnapshot: (request: CreateSnaspotRequest) => Promise<dxos_echo_snapshot.PartySnapshot>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
+export interface SingletonMessage {
+    type: SingletonMessage.Type;
+    data?: Uint8Array;
+    reconnect?: SingletonMessage.Reconnect;
+    resend?: SingletonMessage.Resend;
+    setupClient?: SingletonMessage.SetupClient;
+    clientReady?: SingletonMessage.ClientReady;
+    setupPort?: SingletonMessage.SetupPort;
+    portReady?: SingletonMessage.PortReady;
+    portClosing?: SingletonMessage.PortClosing;
+    clientMessage?: SingletonMessage.ClientMessage;
+    proxyMessage?: SingletonMessage.ProxyMessage;
+}
+export namespace SingletonMessage {
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+     */
+    export enum Type {
+        WINDOW_MESSAGE = 0,
+        RECONNECT = 1,
+        RESEND = 2,
+        SETUP_CLIENT = 3,
+        CLIENT_READY = 4,
+        SETUP_PORT = 5,
+        PORT_READY = 6,
+        PORT_CLOSING = 7,
+        CLIENT_MESSAGE = 8,
+        PROXY_MESSAGE = 9
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+     */
+    export interface Reconnect {
+        attempt: number;
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+     */
+    export interface Resend {
+        message: SingletonMessage;
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+     */
+    export interface SetupClient {
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+     */
+    export interface ClientReady {
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+     */
+    export interface SetupPort {
+        sourceId: number;
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+     */
+    export interface PortReady {
+        sourceId: number;
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+     */
+    export interface PortClosing {
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+     */
+    export interface ClientMessage {
+        sourceId: number;
+        data: Uint8Array;
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+     */
+    export interface ProxyMessage {
+        sourceId: number;
+        data: Uint8Array;
+    }
+}