@dxos/protocols 0.8.4-main.f9ba587 → 0.8.4-main.fcfe5033a5

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

@@ -185,7 +185,8 @@ export namespace Platform {
     export enum PLATFORM_TYPE {
         BROWSER = 0,
         SHARED_WORKER = 1,
-        NODE = 2
+        NODE = 2,
+        DEDICATED_WORKER = 3
     }
 }
 /**
@@ -490,6 +491,8 @@ export interface Space {
      *   - proto3_optional = true
      */
     edgeReplication?: dxos_echo_metadata.EdgeReplicationSetting;
+    tags?: string[];
+    membershipPolicy: dxos_halo_credentials.MembershipPolicy;
     members?: SpaceMember[];
     /**
      * Options:
@@ -646,6 +649,14 @@ export namespace Space {
         spaceRootUrl?: string;
     }
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface CreateSpaceRequest {
+    tags?: string[];
+    membershipPolicy: dxos_halo_credentials.MembershipPolicy;
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
@@ -808,6 +819,21 @@ export interface JoinBySpaceKeyRequest {
 export interface SpaceArchive {
     filename: string;
     contents: Uint8Array;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    format?: SpaceArchive.Format;
+}
+export namespace SpaceArchive {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/services.proto}
+     */
+    export enum Format {
+        BINARY = 0,
+        JSON = 1
+    }
 }
 /**
  * Defined in:
@@ -815,6 +841,11 @@ export interface SpaceArchive {
  */
 export interface ExportSpaceRequest {
     spaceId: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    format?: SpaceArchive.Format;
 }
 /**
  * Defined in:
@@ -845,7 +876,7 @@ export interface ImportSpaceResponse {
  *   {@link file://./../../../dxos/client/services.proto}
  */
 export interface SpacesService {
-    createSpace: (request: void, options?: RequestOptions) => Promise<Space>;
+    createSpace: (request: CreateSpaceRequest, options?: RequestOptions) => Promise<Space>;
     updateSpace: (request: UpdateSpaceRequest, options?: RequestOptions) => Promise<void>;
     querySpaces: (request: void, options?: RequestOptions) => Stream<QuerySpacesResponse>;
     updateMemberRole: (request: UpdateMemberRoleRequest, options?: RequestOptions) => Promise<void>;
@@ -1029,9 +1060,36 @@ export interface EdgeAgentService {
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
  */
-export enum EdgeStatus {
-    NOT_CONNECTED = 0,
-    CONNECTED = 1
+export interface EdgeStatus {
+    state: EdgeStatus.ConnectionState;
+    /**
+     * Latency in ms
+     */
+    rtt: number;
+    /**
+     * How long the connection has been up
+     */
+    uptime: number;
+    /**
+     * Upload rate in bytes per second
+     */
+    rateBytesUp: number;
+    /**
+     * Download rate in bytes per second
+     */
+    rateBytesDown: number;
+    messagesSent: number;
+    messagesReceived: number;
+}
+export namespace EdgeStatus {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/services.proto}
+     */
+    export enum ConnectionState {
+        NOT_CONNECTED = 0,
+        CONNECTED = 1
+    }
 }
 /**
  * Defined in:
@@ -1059,6 +1117,133 @@ export namespace QueryAgentStatusResponse {
         NOT_FOUND = 3
     }
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/queue.proto}
+ */
+export interface QueueQuery {
+    spaceId: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    queuesNamespace?: string;
+    /**
+     * Queries the whole space if missing.
+     */
+    queueIds?: string[];
+    /**
+     * Filter items after this cursor. Exclusive.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    after?: string;
+    /**
+     * Filter items before this cursor. Exclusive.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    before?: string;
+    /**
+     * Filter items after this position. Inclusive.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    beginPosition?: string;
+    /**
+     * Filter items before this position. Exclusive.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    endPosition?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    limit?: number;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    reverse?: boolean;
+    objectIds?: string[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/queue.proto}
+ */
+export interface QueueQueryResult {
+    objects?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>[];
+    /**
+     * Cursor to query the next items. Can be passed to `after` in query to keep querying.
+     */
+    nextCursor: string;
+    prevCursor: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/queue.proto}
+ */
+export interface QueryQueueRequest {
+    query: QueueQuery;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/queue.proto}
+ */
+export interface InsertIntoQueueRequest {
+    subspaceTag: string;
+    spaceId: string;
+    queueId: string;
+    objects?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/queue.proto}
+ */
+export interface DeleteFromQueueRequest {
+    subspaceTag: string;
+    spaceId: string;
+    queueId: string;
+    objectIds?: string[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/queue.proto}
+ */
+export interface SyncQueueRequest {
+    subspaceTag: string;
+    spaceId: string;
+    queueId: string;
+    /**
+     * Whether to push local changes to the server. Defaults to true.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    shouldPush?: boolean;
+    /**
+     * Whether to pull remote changes from the server. Defaults to true.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    shouldPull?: boolean;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/queue.proto}
+ */
+export interface QueueService {
+    queryQueue: (request: QueryQueueRequest, options?: RequestOptions) => Promise<QueueQueryResult>;
+    insertIntoQueue: (request: InsertIntoQueueRequest, options?: RequestOptions) => Promise<void>;
+    deleteFromQueue: (request: DeleteFromQueueRequest, options?: RequestOptions) => Promise<void>;
+    syncQueue: (request: SyncQueueRequest, options?: RequestOptions) => Promise<void>;
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/invitation.proto}

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

@@ -309,7 +309,7 @@ export namespace Runtime {
          */
         devtoolsProxy?: string;
         /**
-         * Spaces will stay in SpaceState.CLOSED until explicitly opened. Speeds up client-services initialization.
+         * client-services initialization.
          *
          * Options:
          *   - proto3_optional = true
@@ -332,8 +332,48 @@ export namespace Runtime {
          *   - proto3_optional = true
          */
         edgeFeatures?: Runtime.Client.EdgeFeatures;
+        /**
+         * value (last-writer-wins); the first client still determines the worker's other config.
+         *
+         * Options:
+         *   - proto3_optional = true
+         */
+        observabilityGroup?: string;
+        /**
+         * value (last-writer-wins); the first client still determines the worker's other config.
+         *
+         * Options:
+         *   - proto3_optional = true
+         */
+        signalTelemetryEnabled?: boolean;
+        /**
+         * Bypasses SharedWorker; used for WKWebView where the coordinator SharedWorker port is unreliable.
+         *
+         * Options:
+         *   - proto3_optional = true
+         */
+        singleClientMode?: boolean;
+        /**
+         * `remote_source` is configured.
+         *
+         * Options:
+         *   - proto3_optional = true
+         */
+        servicesMode?: Runtime.Client.ServicesMode;
     }
     export namespace Client {
+        /**
+         * Where client services run. Drives `createClientServices` routing.
+         *
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        export enum ServicesMode {
+            UNSPECIFIED_SERVICES_MODE = 0,
+            HOST = 1,
+            SHARED_WORKER = 2,
+            DEDICATED_WORKER = 3
+        }
         /**
          * Defined in:
          *   {@link file://./../../dxos/config.proto}
@@ -366,6 +406,13 @@ export namespace Runtime {
              *   - proto3_optional = true
              */
             spaceFragmentation?: boolean;
+            /**
+             * Backing store for SQLite runtimes. Defaults to MEMORY when unset.
+             *
+             * Options:
+             *   - proto3_optional = true
+             */
+            sqliteMode?: Runtime.Client.Storage.SqliteMode;
         }
         export namespace Storage {
             /**
@@ -382,6 +429,18 @@ export namespace Runtime {
                 LEVELJS = 11,
                 JSONDOWN = 12
             }
+            /**
+             * presence of options.
+             *
+             * Defined in:
+             *   {@link file://./../../dxos/config.proto}
+             */
+            export enum SqliteMode {
+                UNSPECIFIED_SQLITE_MODE = 0,
+                MEMORY = 1,
+                OPFS = 2,
+                FILE = 3
+            }
         }
         /**
          * Defined in:
@@ -789,6 +848,8 @@ export namespace Runtime {
      */
     export interface Services {
         /**
+         * Deprecated
+         *
          * Options:
          *   - proto3_optional = true
          */
@@ -827,21 +888,29 @@ export namespace Runtime {
          */
         publisher?: Runtime.Services.Publisher;
         /**
+         * Deprecated
+         *
          * Options:
          *   - proto3_optional = true
          */
         supervisor?: Runtime.Services.Supervisor;
         /**
+         * Deprecated
+         *
          * Options:
          *   - proto3_optional = true
          */
         tunneling?: Runtime.Services.Tunneling;
         /**
+         * Deprecated
+         *
          * Options:
          *   - proto3_optional = true
          */
         faasd?: Runtime.Services.Faasd;
         /**
+         * Deprecated
+         *
          * Options:
          *   - proto3_optional = true
          */
@@ -856,6 +925,11 @@ export namespace Runtime {
          *   - proto3_optional = true
          */
         ai?: Runtime.Services.Ai;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        hub?: Runtime.Services.Hub;
     }
     export namespace Services {
         /**
@@ -971,7 +1045,7 @@ export namespace Runtime {
              */
             gateway?: string;
             /**
-             * Same secret format as https://github.com/ipfs/kubo/blob/master/docs/config.md#apiauthorizations
+             * https://github.com/ipfs/kubo/blob/master/docs/config.md#apiauthorizations
              *
              * Options:
              *   - proto3_optional = true
@@ -1153,6 +1227,17 @@ export namespace Runtime {
              */
             server?: string;
         }
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        export interface Hub {
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            url?: string;
+        }
     }
     /**
      * Defined in:

package/src/proto/gen/dxos/devtools/host.ts

@@ -65,37 +65,6 @@ import * as dxos_value from "../value.js";
 import * as example_testing_data from "../../example/testing/data.js";
 import * as example_testing_rpc from "../../example/testing/rpc.js";
 import * as google_protobuf from "../../google/protobuf.js";
-/**
- * Defined in:
- *   {@link file://./../../../dxos/devtools/diagnostics.proto}
- */
-export interface Services {
-    spaces?: SpaceStats[];
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/devtools/diagnostics.proto}
- */
-export interface SpaceStats {
-    key: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    peers?: PeerStats[];
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/devtools/diagnostics.proto}
- */
-export interface PeerStats {
-    controlFeed: FeedStats;
-    dataFeed: FeedStats;
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/devtools/diagnostics.proto}
- */
-export interface FeedStats {
-    key: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    length: number;
-}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/devtools/host.proto}
@@ -531,3 +500,34 @@ export interface SubscribeToSwarmInfoRequest {
 export interface SubscribeToSwarmInfoResponse {
     data?: dxos_devtools_swarm.SwarmInfo[];
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/devtools/diagnostics.proto}
+ */
+export interface Services {
+    spaces?: SpaceStats[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/devtools/diagnostics.proto}
+ */
+export interface SpaceStats {
+    key: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    peers?: PeerStats[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/devtools/diagnostics.proto}
+ */
+export interface PeerStats {
+    controlFeed: FeedStats;
+    dataFeed: FeedStats;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/devtools/diagnostics.proto}
+ */
+export interface FeedStats {
+    key: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    length: number;
+}

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

@@ -134,6 +134,10 @@ export interface SpaceMetadata {
      * Space key.
      */
     key: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Immutable tags assigned at space creation time.
+     */
+    tags?: string[];
     /**
      * ACTIVE, INACTIVE, etc.
      *

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

@@ -106,9 +106,25 @@ export interface Heads {
 export interface QueryResult {
     id: string;
     spaceId: string;
-    documentId: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    documentId?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    queueId?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    queueNamespace?: string;
     rank: number;
     /**
+     * In the ECHO Json object format.
+     *
      * Options:
      *   - proto3_optional = true
      */

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

@@ -133,14 +133,6 @@ export interface DocumentUpdate {
      * Value returned by `Automerge.saveSince()`.
      */
     mutation: Uint8Array;
-    /**
-     * Set to true for init mutation of document.
-     * default: undefined.
-     *
-     * Options:
-     *   - proto3_optional = true
-     */
-    isNew?: boolean;
 }
 /**
  * Defined in:
@@ -187,6 +179,34 @@ export interface WaitUntilHeadsReplicatedRequest {
 export interface ReIndexHeadsRequest {
     documentIds?: string[];
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/echo/service.proto}
+ */
+export interface CreateDocumentRequest {
+    /**
+     * Space id where the document will be created.
+     */
+    spaceId: string;
+    /**
+     * Automerge encoded initial document value.
+     * Optional - if not provided, an empty document will be created.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    initialValue?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/echo/service.proto}
+ */
+export interface CreateDocumentResponse {
+    /**
+     * The generated document id.
+     */
+    documentId: string;
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/echo/service.proto}
@@ -228,6 +248,15 @@ export namespace SpaceSyncState {
          * Total number of documents on the remote peer.
          */
         remoteDocumentCount: number;
+        /**
+         * Total number of documents across this peer and the remote peer.
+         */
+        totalDocumentCount: number;
+        /**
+         * Total number of documents that are not synced.
+         * Includes documents that are present only locally, only on the remote peer, or whether the peers have different versions.
+         */
+        unsyncedDocumentCount: number;
     }
 }
 /**
@@ -245,6 +274,11 @@ export interface DataService {
      * Change which documents are subscribed to for specific subscription.
      */
     updateSubscription: (request: UpdateSubscriptionRequest, options?: RequestOptions) => Promise<void>;
+    /**
+     * Create a new automerge document.
+     * Returns the generated document id which is controlled by the host.
+     */
+    createDocument: (request: CreateDocumentRequest, options?: RequestOptions) => Promise<CreateDocumentResponse>;
     /**
      * Write incremental updates to multiple automerge documents.
      * Used to propagate changes from client to services.

package/src/proto/gen/dxos/edge/messenger.ts

@@ -142,12 +142,36 @@ export interface Message {
      *   - proto3_optional = true
      */
     serviceId?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    traceContext?: TraceContext;
     /**
      * Options:
      *   - proto3_optional = true
      */
     payload?: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>;
 }
+/**
+ * W3C Trace Context propagation (https://www.w3.org/TR/trace-context/).
+ *
+ * Defined in:
+ *   {@link file://./../../../dxos/edge/messenger.proto}
+ */
+export interface TraceContext {
+    /**
+     * W3C `traceparent` header value (e.g. "00-<trace-id>-<parent-id>-<trace-flags>").
+     */
+    traceparent: string;
+    /**
+     * W3C `tracestate` header value; vendor-specific key-value pairs.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    tracestate?: string;
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/edge/messenger.proto}

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

@@ -65,12 +65,22 @@ import * as dxos_value from "../value.js";
 import * as example_testing_data from "../../example/testing/data.js";
 import * as example_testing_rpc from "../../example/testing/rpc.js";
 import * as google_protobuf from "../../google/protobuf.js";
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/halo/credentials.proto}
+ */
+export enum MembershipPolicy {
+    INVITE = 0,
+    LOCKED = 1
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/halo/credentials.proto}
  */
 export interface SpaceGenesis {
     spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    tags?: string[];
+    membershipPolicy: MembershipPolicy;
 }
 /**
  * Defined in:
@@ -79,6 +89,10 @@ export interface SpaceGenesis {
 export interface SpaceMember {
     spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     role: SpaceMember.Role;
+    /**
+     * Immutable tags assigned at space creation time.
+     */
+    tags?: string[];
     /**
      * Options:
      *   - proto3_optional = true
@@ -329,7 +343,7 @@ export interface DeviceProfile {
     profile: DeviceProfileDocument;
 }
 /**
- * [ASSERTION]: Sets default space for identity.
+ * @deprecated Default space is no longer managed by the SDK. Existing credentials are ignored.
  *
  * Defined in:
  *   {@link file://./../../../dxos/halo/credentials.proto}

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

@@ -78,16 +78,6 @@ export interface StartRequest {
      *   - proto3_optional = true
      */
     lockKey?: string;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    observabilityGroup?: string;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    signalTelemetryEnabled?: boolean;
 }
 /**
  * Iframe-to-worker RPCs.