@dxos/protocols 0.8.4-main.c4373fc → 0.8.4-main.c85a9c8dae

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

@@ -67,195 +67,130 @@ 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}
+ *   {@link file://./../../../dxos/client/queue.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;
+export interface QueueQuery {
+    spaceId: string;
     /**
-     * Timeout for guest to complete invitation once connected (ms).
-     *
      * Options:
      *   - proto3_optional = true
      */
-    timeout?: number;
+    queuesNamespace?: string;
     /**
-     * Guest's identity.
-     *
-     * Options:
-     *   - proto3_optional = true
+     * Queries the whole space if missing.
      */
-    identityKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    queueIds?: string[];
     /**
-     * Space to join (only present if kind is SPACE).
+     * Filter items after this cursor. Exclusive.
      *
      * Options:
      *   - proto3_optional = true
      */
-    spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    after?: string;
     /**
-     * Authentication code created by host (only present if auth_method is SHARED_SECRET).
+     * Filter items before this cursor. Exclusive.
      *
      * Options:
      *   - proto3_optional = true
      */
-    authCode?: string;
+    before?: string;
     /**
-     * Path or identifier to navigate to after successful authentication.
+     * Filter items after this position. Inclusive.
      *
      * Options:
      *   - proto3_optional = true
      */
-    target?: string;
+    beginPosition?: string;
     /**
-     * Host should resume invitation on startup until timeout.
+     * Filter items before this position. Exclusive.
      *
      * Options:
      *   - proto3_optional = true
      */
-    persistent?: boolean;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    created?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+    endPosition?: string;
     /**
      * Options:
      *   - proto3_optional = true
      */
-    lifetime?: number;
+    limit?: number;
     /**
-     * Whether an invitation can be used multiple times.
-     *
      * Options:
      *   - proto3_optional = true
      */
-    multiUse?: boolean;
+    reverse?: boolean;
+    objectIds?: string[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/queue.proto}
+ */
+export interface QueueQueryResult {
+    objects?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>[];
     /**
-     * Guest's keypair required for AuthMethod.KNOWN_PUBLIC_KEY.
-     *
-     * Options:
-     *   - proto3_optional = true
+     * Cursor to query the next items. Can be passed to `after` in query to keep querying.
      */
-    guestKeypair?: AdmissionKeypair;
-    /**
-     * Present on Type.DELEGATED invitations.
-     *
-     * Options:
-     *   - proto3_optional = true
-     */
-    delegationCredentialId?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    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;
     /**
-     * Role of the admitted member, defaults to ADMIN.
+     * Whether to push local changes to the server. Defaults to true.
      *
      * Options:
      *   - proto3_optional = true
      */
-    role?: dxos_halo_credentials.SpaceMember.Role;
+    shouldPush?: boolean;
     /**
-     * Id of a the space to join (only present if kind is SPACE).
+     * Whether to pull remote changes from the server. Defaults to true.
      *
      * Options:
      *   - proto3_optional = true
      */
-    spaceId?: string;
+    shouldPull?: boolean;
 }
-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/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:
@@ -435,6 +370,198 @@ export interface LoggingService {
     queryMetrics: (request: QueryMetricsRequest, options?: RequestOptions) => Stream<QueryMetricsResponse>;
     queryLogs: (request: QueryLogsRequest, options?: RequestOptions) => Stream<LogEntry>;
 }
+/**
+ * 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/services.proto}
@@ -555,7 +682,8 @@ export namespace Platform {
     export enum PLATFORM_TYPE {
         BROWSER = 0,
         SHARED_WORKER = 1,
-        NODE = 2
+        NODE = 2,
+        DEDICATED_WORKER = 3
     }
 }
 /**
@@ -1399,9 +1527,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:

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/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.