@dxos/protocols 0.8.4-main.ead640a → 0.8.4-main.ef1bc66f44

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

@@ -6,6 +6,7 @@ syntax = "proto3";
 
 import "dxos/keys.proto";
 import "google/protobuf/empty.proto";
+import "google/protobuf/struct.proto";
 
 package dxos.echo.service;
 
@@ -61,12 +62,6 @@ message DocumentUpdate {
    * Value returned by `Automerge.saveSince()`.
    */
   bytes mutation = 2;
-
-  /**
-   * Set to true for init mutation of document.
-   * default: undefined.
-   */
-   optional bool is_new = 3;
 }
 
 message DocHeadsList {
@@ -94,6 +89,26 @@ message ReIndexHeadsRequest {
   repeated string document_ids = 1;
 }
 
+message CreateDocumentRequest {
+  /**
+   * Space id where the document will be created.
+   */
+  string space_id = 1;
+
+  /**
+   * Automerge encoded initial document value.
+   * Optional - if not provided, an empty document will be created.
+   */
+  optional google.protobuf.Struct initial_value = 2;
+}
+
+message CreateDocumentResponse {
+  /**
+   * The generated document id.
+   */
+  string document_id = 1;
+}
+
 message GetSpaceSyncStateRequest {
   string space_id = 1;
 }
@@ -157,6 +172,12 @@ service DataService {
    */
   rpc UpdateSubscription(UpdateSubscriptionRequest) returns (google.protobuf.Empty);
 
+  /**
+   * Create a new automerge document.
+   * Returns the generated document id which is controlled by the host.
+   */
+   rpc CreateDocument(CreateDocumentRequest) returns (CreateDocumentResponse);
+
   /**
    * Write incremental updates to multiple automerge documents.
    * Used to propagate changes from client to services.

package/src/proto/dxos/iframe.proto

@@ -39,6 +39,7 @@ message AppContextRequest {
   /// The key of the joined space.
   optional dxos.keys.PublicKey space_key = 2;
 
+  // TODO(wittjosiah): Make the generated type be `SpaceId`.
   /// The id of the joined space.
   optional string space_id = 5;
 

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

@@ -65,6 +65,198 @@ 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/client/invitation.proto}
+ */
+export interface AdmissionKeypair {
+    publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    privateKey?: ReturnType<(typeof substitutions)["dxos.keys.PrivateKey"]["decode"]>;
+}
+/**
+ * Runtime state of the space object.
+ *
+ * Defined in:
+ *   {@link file://./../../../dxos/client/invitation.proto}
+ */
+export enum SpaceState {
+    INVALID = 0,
+    SPACE_INACTIVE = 2,
+    SPACE_ACTIVE = 6,
+    SPACE_CLOSED = 1,
+    SPACE_CONTROL_ONLY = 7,
+    SPACE_INITIALIZING = 4,
+    SPACE_READY = 3,
+    SPACE_ERROR = 5,
+    SPACE_REQUIRES_MIGRATION = 8
+}
+/**
+ * Represents the invitation state passed between client and service.
+ *
+ * Defined in:
+ *   {@link file://./../../../dxos/client/invitation.proto}
+ */
+export interface Invitation {
+    /**
+     * Local identifier (random).
+     */
+    invitationId: string;
+    /**
+     * Determines the behavior of the invitation.
+     */
+    type: Invitation.Type;
+    /**
+     * Kind of access the invitation will grant.
+     */
+    kind: Invitation.Kind;
+    /**
+     * How the invitation is authenticated.
+     */
+    authMethod: Invitation.AuthMethod;
+    /**
+     * Swarm rendezvous (random).
+     */
+    swarmKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Local state.
+     */
+    state: Invitation.State;
+    /**
+     * Timeout for guest to complete invitation once connected (ms).
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    timeout?: number;
+    /**
+     * Guest's identity.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    identityKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Space to join (only present if kind is SPACE).
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Authentication code created by host (only present if auth_method is SHARED_SECRET).
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    authCode?: string;
+    /**
+     * Path or identifier to navigate to after successful authentication.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    target?: string;
+    /**
+     * Host should resume invitation on startup until timeout.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    persistent?: boolean;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    created?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    lifetime?: number;
+    /**
+     * Whether an invitation can be used multiple times.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    multiUse?: boolean;
+    /**
+     * Guest's keypair required for AuthMethod.KNOWN_PUBLIC_KEY.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    guestKeypair?: AdmissionKeypair;
+    /**
+     * Present on Type.DELEGATED invitations.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    delegationCredentialId?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Role of the admitted member, defaults to ADMIN.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    role?: dxos_halo_credentials.SpaceMember.Role;
+    /**
+     * Id of a the space to join (only present if kind is SPACE).
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    spaceId?: string;
+}
+export namespace Invitation {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/invitation.proto}
+     */
+    export enum Type {
+        INTERACTIVE = 0,
+        DELEGATED = 1,
+        MULTIUSE = 2
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/invitation.proto}
+     */
+    export enum Kind {
+        DEVICE = 0,
+        SPACE = 1
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/invitation.proto}
+     */
+    export enum AuthMethod {
+        NONE = 0,
+        SHARED_SECRET = 1,
+        KNOWN_PUBLIC_KEY = 2
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/invitation.proto}
+     */
+    export enum State {
+        INIT = 0,
+        CONNECTING = 1,
+        CONNECTED = 2,
+        READY_FOR_AUTHENTICATION = 3,
+        AUTHENTICATING = 4,
+        SUCCESS = 5,
+        CANCELLED = 6,
+        TIMEOUT = 7,
+        ERROR = 8,
+        EXPIRED = 9
+    }
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/logging.proto}
@@ -245,195 +437,106 @@ export interface LoggingService {
 }
 /**
  * Defined in:
- *   {@link file://./../../../dxos/client/invitation.proto}
- */
-export interface AdmissionKeypair {
-    publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    privateKey?: ReturnType<(typeof substitutions)["dxos.keys.PrivateKey"]["decode"]>;
-}
-/**
- * Runtime state of the space object.
- *
- * Defined in:
- *   {@link file://./../../../dxos/client/invitation.proto}
- */
-export enum SpaceState {
-    INVALID = 0,
-    SPACE_INACTIVE = 2,
-    SPACE_ACTIVE = 6,
-    SPACE_CLOSED = 1,
-    SPACE_CONTROL_ONLY = 7,
-    SPACE_INITIALIZING = 4,
-    SPACE_READY = 3,
-    SPACE_ERROR = 5,
-    SPACE_REQUIRES_MIGRATION = 8
-}
-/**
- * Represents the invitation state passed between client and service.
- *
- * Defined in:
- *   {@link file://./../../../dxos/client/invitation.proto}
+ *   {@link file://./../../../dxos/client/queue.proto}
  */
-export interface Invitation {
-    /**
-     * Local identifier (random).
-     */
-    invitationId: string;
-    /**
-     * Determines the behavior of the invitation.
-     */
-    type: Invitation.Type;
-    /**
-     * Kind of access the invitation will grant.
-     */
-    kind: Invitation.Kind;
-    /**
-     * How the invitation is authenticated.
-     */
-    authMethod: Invitation.AuthMethod;
-    /**
-     * Swarm rendezvous (random).
-     */
-    swarmKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    /**
-     * Local state.
-     */
-    state: Invitation.State;
-    /**
-     * Timeout for guest to complete invitation once connected (ms).
-     *
-     * Options:
-     *   - proto3_optional = true
-     */
-    timeout?: number;
-    /**
-     * Guest's identity.
-     *
-     * Options:
-     *   - proto3_optional = true
-     */
-    identityKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
-    /**
-     * Space to join (only present if kind is SPACE).
-     *
-     * Options:
-     *   - proto3_optional = true
-     */
-    spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+export interface QueueQuery {
+    spaceId: string;
     /**
-     * Authentication code created by host (only present if auth_method is SHARED_SECRET).
-     *
      * Options:
      *   - proto3_optional = true
      */
-    authCode?: string;
+    queuesNamespace?: string;
     /**
-     * Path or identifier to navigate to after successful authentication.
-     *
-     * Options:
-     *   - proto3_optional = true
+     * Queries the whole space if missing.
      */
-    target?: string;
+    queueIds?: string[];
     /**
-     * Host should resume invitation on startup until timeout.
+     * Filter items after this cursor. Exclusive.
      *
      * Options:
      *   - proto3_optional = true
      */
-    persistent?: boolean;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    created?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+    after?: string;
     /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    lifetime?: number;
-    /**
-     * Whether an invitation can be used multiple times.
+     * Filter items before this cursor. Exclusive.
      *
      * Options:
      *   - proto3_optional = true
      */
-    multiUse?: boolean;
+    before?: string;
     /**
-     * Guest's keypair required for AuthMethod.KNOWN_PUBLIC_KEY.
+     * Filter items after this position. Inclusive.
      *
      * Options:
      *   - proto3_optional = true
      */
-    guestKeypair?: AdmissionKeypair;
+    beginPosition?: string;
     /**
-     * Present on Type.DELEGATED invitations.
+     * Filter items before this position. Exclusive.
      *
      * Options:
      *   - proto3_optional = true
      */
-    delegationCredentialId?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    endPosition?: string;
     /**
-     * Role of the admitted member, defaults to ADMIN.
-     *
      * Options:
      *   - proto3_optional = true
      */
-    role?: dxos_halo_credentials.SpaceMember.Role;
+    limit?: number;
     /**
-     * Id of a the space to join (only present if kind is SPACE).
-     *
      * Options:
      *   - proto3_optional = true
      */
-    spaceId?: string;
+    reverse?: boolean;
+    objectIds?: string[];
 }
-export namespace Invitation {
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/invitation.proto}
-     */
-    export enum Type {
-        INTERACTIVE = 0,
-        DELEGATED = 1,
-        MULTIUSE = 2
-    }
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/invitation.proto}
-     */
-    export enum Kind {
-        DEVICE = 0,
-        SPACE = 1
-    }
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/invitation.proto}
-     */
-    export enum AuthMethod {
-        NONE = 0,
-        SHARED_SECRET = 1,
-        KNOWN_PUBLIC_KEY = 2
-    }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/queue.proto}
+ */
+export interface QueueQueryResult {
+    objects?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>[];
     /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/invitation.proto}
+     * Cursor to query the next items. Can be passed to `after` in query to keep querying.
      */
-    export enum State {
-        INIT = 0,
-        CONNECTING = 1,
-        CONNECTED = 2,
-        READY_FOR_AUTHENTICATION = 3,
-        AUTHENTICATING = 4,
-        SUCCESS = 5,
-        CANCELLED = 6,
-        TIMEOUT = 7,
-        ERROR = 8,
-        EXPIRED = 9
-    }
+    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 QueueService {
+    queryQueue: (request: QueryQueueRequest, options?: RequestOptions) => Promise<QueueQueryResult>;
+    insertIntoQueue: (request: InsertIntoQueueRequest, options?: RequestOptions) => Promise<void>;
+    deleteFromQueue: (request: DeleteFromQueueRequest, options?: RequestOptions) => Promise<void>;
 }
 /**
  * Defined in:
@@ -555,7 +658,8 @@ export namespace Platform {
     export enum PLATFORM_TYPE {
         BROWSER = 0,
         SHARED_WORKER = 1,
-        NODE = 2
+        NODE = 2,
+        DEDICATED_WORKER = 3
     }
 }
 /**

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

@@ -332,6 +332,11 @@ export namespace Runtime {
          *   - proto3_optional = true
          */
         edgeFeatures?: Runtime.Client.EdgeFeatures;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        enableLocalQueues?: boolean;
     }
     export namespace Client {
         /**

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}
@@ -254,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.