@dxos/client 2.33.9-dev.002e8917 → 2.33.9-dev.227ba79d

package/src/{proto → packlets/proto}/gen/dxos/client.ts

@@ -11,10 +11,18 @@ 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,
@@ -23,59 +31,134 @@ export enum InvitationState {
 }
 /**
  * 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;
+    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;
+    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;
+    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;
+    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"]>;
+    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>;
@@ -84,29 +167,57 @@ export interface ProfileService {
     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;
+    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;
+    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;
+    signed: Uint8Array;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
 export interface SetPreferenceRequest {
-    key?: string;
-    value?: string;
+    key: string;
+    value: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
 export interface GetPreferenceRequest {
-    key?: string;
+    key: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/client.proto}
+ */
 export interface GetPreferenceResponse {
-    value?: string;
+    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>;
@@ -116,6 +227,10 @@ export interface HaloService {
     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;
@@ -123,61 +238,144 @@ export interface Party {
     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;
+    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"]>;
+    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>;