@dxos/client 2.33.9-dev.d9963f00 → 2.33.9-dev.eb69ac10

package/src/proto/gen/dxos/echo/service.ts

@@ -11,43 +11,79 @@ import * as dxos_echo_timeframe from "./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/echo/service.proto}
+ */
 export interface SubscribeEntitySetRequest {
-    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/echo/service.proto}
+ */
 export interface SubscribeEntitySetResponse {
     added?: dxos_echo_feed.EchoEnvelope[];
     deleted?: dxos_echo_feed.EchoEnvelope[];
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/service.proto}
+ */
 export interface SubscribeEntityStreamRequest {
-    partyKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
-    itemId?: string;
+    partyKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    itemId: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/service.proto}
+ */
 export interface SubscribeEntityStreamResponse {
     snapshot?: dxos_echo_snapshot.ItemSnapshot;
     mutation?: SubscribeEntityStreamResponse.Mutation;
 }
 export namespace SubscribeEntityStreamResponse {
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/service.proto}
+     */
     export interface Mutation {
-        data?: dxos_echo_feed.EchoEnvelope;
-        meta?: SubscribeEntityStreamResponse.Mutation.Metadata;
+        data: dxos_echo_feed.EchoEnvelope;
+        meta: SubscribeEntityStreamResponse.Mutation.Metadata;
     }
     export namespace Mutation {
+        /**
+         * Defined in:
+         *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/service.proto}
+         */
         export interface Metadata {
-            feedKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
-            memberKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
-            seq?: number;
-            timeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
+            feedKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+            memberKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+            seq: number;
+            timeframe: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
         }
     }
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/service.proto}
+ */
 export interface WriteRequest {
-    partyKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
-    mutation?: dxos_echo_feed.EchoEnvelope;
+    partyKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    mutation: dxos_echo_feed.EchoEnvelope;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/service.proto}
+ */
 export interface MutationReceipt {
-    feedKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
-    seq?: number;
+    feedKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    seq: number;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/service.proto}
+ */
 export interface DataService {
     subscribeEntitySet: (request: SubscribeEntitySetRequest) => Stream<SubscribeEntitySetResponse>;
     subscribeEntityStream: (request: SubscribeEntityStreamRequest) => Stream<SubscribeEntityStreamResponse>;

package/src/proto/gen/dxos/echo/snapshot.ts

@@ -11,20 +11,44 @@ import * as dxos_echo_timeframe from "./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/echo/snapshot.proto}
+ */
 export interface PartySnapshot {
-    partyKey?: Uint8Array;
+    partyKey: Uint8Array;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     timeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     timestamp?: number;
-    halo?: HaloStateSnapshot;
-    database?: DatabaseSnapshot;
+    halo: HaloStateSnapshot;
+    database: DatabaseSnapshot;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/snapshot.proto}
+ */
 export interface HaloStateSnapshot {
     messages?: ReturnType<(typeof substitutions)["dxos.echo.feed.CredentialsMessage"]["decode"]>[];
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/snapshot.proto}
+ */
 export interface DatabaseSnapshot {
     items?: ItemSnapshot[];
     links?: LinkSnapshot[];
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/snapshot.proto}
+ */
 export interface ItemSnapshot {
     /**
      * Options:
@@ -36,11 +60,7 @@ export interface ItemSnapshot {
      *   - proto3_optional = true
      */
     itemType?: string;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    modelType?: string;
+    modelType: string;
     /**
      * Options:
      *   - proto3_optional = true
@@ -57,6 +77,10 @@ export interface ItemSnapshot {
      */
     model?: ModelSnapshot;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/snapshot.proto}
+ */
 export interface LinkSnapshot {
     /**
      * Options:
@@ -68,11 +92,7 @@ export interface LinkSnapshot {
      *   - proto3_optional = true
      */
     linkType?: string;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    modelType?: string;
+    modelType: string;
     /**
      * Options:
      *   - proto3_optional = true
@@ -86,6 +106,10 @@ export interface LinkSnapshot {
      */
     model?: ModelSnapshot;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/snapshot.proto}
+ */
 export interface ModelSnapshot {
     /**
      * Encoded model snapshot (defined by the model's codec).
@@ -100,10 +124,18 @@ export interface ModelSnapshot {
      */
     mutations?: ModelMutation[];
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/snapshot.proto}
+ */
 export interface ModelMutation {
     mutation: Uint8Array;
     meta: ModelMutationMeta;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/snapshot.proto}
+ */
 export interface ModelMutationMeta {
     feedKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
     seq: number;

package/src/proto/gen/dxos/echo/timeframe.ts

@@ -13,13 +13,20 @@ import * as dxos_rpc from "../rpc";
 import * as google_protobuf from "../../google/protobuf";
 /**
  * Vector timestamp used to order messages.
+ *
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/timeframe.proto}
  */
 export interface TimeframeVector {
     frames?: TimeframeVector.Frame[];
 }
 export namespace TimeframeVector {
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/timeframe.proto}
+     */
     export interface Frame {
-        feedKey?: Uint8Array;
-        seq?: number;
+        feedKey: Uint8Array;
+        seq: number;
     }
 }

package/src/proto/gen/dxos/halo/keys.ts

@@ -11,6 +11,10 @@ import * as dxos_echo_snapshot from "../echo/snapshot";
 import * as dxos_echo_timeframe from "../echo/timeframe";
 import * as dxos_rpc from "../rpc";
 import * as google_protobuf from "../../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/keys.proto}
+ */
 export enum KeyType {
     UNKNOWN = 0,
     IDENTITY = 1,
@@ -19,12 +23,24 @@ export enum KeyType {
     FEED = 4,
     DXNS_ADDRESS = 5
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/keys.proto}
+ */
 export interface PubKey {
-    data?: Uint8Array;
+    data: Uint8Array;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/keys.proto}
+ */
 export interface PrivKey {
-    data?: Uint8Array;
+    data: Uint8Array;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/keys.proto}
+ */
 export interface KeyRecord {
     /**
      * The `KeyType` type of the key. This is often unknown for keys from other sources.
@@ -36,33 +52,59 @@ export interface KeyRecord {
     publicKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
     /**
      * The secret key as a Buffer (this will never be visible outside the Keyring).
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     secretKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PrivKey"]["decode"]>;
     /**
      * Is this key from a Greeting "hint"?
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     hint?: boolean;
     /**
      * Determines if this is our key?
      * Usually true if `secretKey` is present; may be false for "inception keys" such as the Party key.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     own?: boolean;
     /**
      * Is this key to be trusted?
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     trusted?: boolean;
     /**
      * An RFC-3339 date/time string for when the key was added to the Keyring.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     added?: string;
     /**
      * An RFC-3339 date/time string for when the key was created.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     created?: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/keys.proto}
+ */
 export interface KeyRecordList {
     keys?: KeyRecord[];
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/halo/keys.proto}
+ */
 export interface KeyChain {
     publicKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
     message: dxos_credentials.SignedMessage;

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

@@ -11,6 +11,10 @@ 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 google_protobuf from "../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../common/protocols/src/proto/dxos/rpc.proto}
+ */
 export interface RpcMessage {
     request?: Request;
     response?: Response;
@@ -24,31 +28,77 @@ export interface RpcMessage {
     openAck?: boolean;
     streamClose?: StreamClose;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../common/protocols/src/proto/dxos/rpc.proto}
+ */
 export interface Request {
-    id?: number;
-    method?: string;
-    payload?: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>;
-    stream?: boolean;
+    id: number;
+    method: string;
+    payload: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>;
+    stream: boolean;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../common/protocols/src/proto/dxos/rpc.proto}
+ */
 export interface Response {
-    id?: number;
+    id: number;
     payload?: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>;
     error?: Error;
+    /**
+     * Sent when stream is closed without an error.
+     */
     close?: boolean;
+    /**
+     * Sent when the server has processed a request with a streaming response.
+     *
+     * Can be skipped by the server.
+     * In this case the first payload should be treated as the server being ready.
+     */
+    streamReady?: boolean;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../common/protocols/src/proto/dxos/rpc.proto}
+ */
 export interface StreamClose {
-    id?: number;
+    id: number;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../common/protocols/src/proto/dxos/rpc.proto}
+ */
 export interface Error {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     name?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     message?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     stack?: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../common/protocols/src/proto/dxos/rpc.proto}
+ */
 export interface MessageTrace {
-    direction?: MessageTrace.Direction;
-    data?: Uint8Array;
+    direction: MessageTrace.Direction;
+    data: Uint8Array;
 }
 export namespace MessageTrace {
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../common/protocols/src/proto/dxos/rpc.proto}
+     */
     export enum Direction {
         INCOMING = 0,
         OUTGOING = 1