@dxos/protocols 0.4.10-main.0be5154 → 0.4.10-main.109a137

package/dist/esm/src/proto/gen/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/proto/gen/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AA8DhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AA4hB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,y+rGAAy+rG,CAAC,CAAC,CAAC;AAClisG,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAkB,UAAU,EAAE,aAAa,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/proto/gen/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AA8DhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AA6hB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,u+tGAAu+tG,CAAC,CAAC,CAAC;AAChiuG,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAkB,UAAU,EAAE,aAAa,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/protocols",
-  "version": "0.4.10-main.0be5154",
+  "version": "0.4.10-main.109a137",
   "description": "Protobuf definitions for DXOS protocols.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -33,10 +33,10 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/codec-protobuf": "0.4.10-main.0be5154",
-    "@dxos/keys": "0.4.10-main.0be5154",
-    "@dxos/timeframe": "0.4.10-main.0be5154",
-    "@dxos/invariant": "0.4.10-main.0be5154"
+    "@dxos/codec-protobuf": "0.4.10-main.109a137",
+    "@dxos/keys": "0.4.10-main.109a137",
+    "@dxos/invariant": "0.4.10-main.109a137",
+    "@dxos/timeframe": "0.4.10-main.109a137"
   },
   "devDependencies": {
     "glob": "~7.1.6"

package/src/indexing.ts

@@ -2,14 +2,16 @@
 // Copyright 2024 DXOS.org
 //
 
-export type IdDecoded = {
+export type ObjectPointerDecoded = {
   documentId: string;
   objectId: string;
 };
 
+export type ObjectPointerEncoded = string;
+
 export const idCodec = {
-  encode: ({ documentId, objectId }: IdDecoded) => `${documentId}|${objectId}`,
-  decode: (id: string): IdDecoded => {
+  encode: ({ documentId, objectId }: ObjectPointerDecoded): ObjectPointerEncoded => `${documentId}|${objectId}`,
+  decode: (id: ObjectPointerEncoded): ObjectPointerDecoded => {
     const [documentId, objectId] = id.split('|');
     return { documentId, objectId };
   },

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

@@ -390,7 +390,8 @@ service SpacesService {
 
 service IndexService {
   rpc SetConfig(dxos.echo.indexing.IndexConfig) returns (google.protobuf.Empty);
-  rpc Find(dxos.agent.query.QueryRequest) returns (dxos.agent.query.QueryResponse);
+  rpc Find(dxos.agent.query.QueryRequest) returns (stream dxos.agent.query.QueryResponse);
+  
 }
 
 //
@@ -404,9 +405,12 @@ message Invitation {
   enum Type {
     /// Requires both to be online to complete key exchange.
     INTERACTIVE = 0;
-    /// Guest's identity key is known; invitation can be accepted by any valid peer.
-    OFFLINE = 1;
-    /// Multiple-use interactive invitation.
+    /// Invitation can be accepted by any valid peer.
+    DELEGATED = 1;
+    /**
+     * Multi-use interactive invitations.
+     * @deprecated use multiUse flag with type=interactive instead.
+     */
     MULTIUSE = 2;
   }
 
@@ -421,6 +425,9 @@ message Invitation {
 
     /// Guest should call `Authenticate` with the shared secret.
     SHARED_SECRET = 1;
+
+    /// Guest should prove they possess a private key corresponding to the known public key recorded in an invitation.
+    KNOWN_PUBLIC_KEY = 2;
   }
 
   enum State {
@@ -479,6 +486,17 @@ message Invitation {
   // TODO(nf): some feedback mechanism or GC for immortal invitations?
   // TODO(nf): should the creator have a way to make an invitation last as long as the client? this was the previous behavior.
   optional int32 lifetime = 14;
+
+  /// Whether an invitation can be used multiple times.
+  optional bool multi_use = 15;
+
+  /// Guest's keypair required for AuthMethod.KNOWN_PUBLIC_KEY.
+  optional AdmissionKeypair guest_keypair = 16;
+}
+
+message AdmissionKeypair {
+  dxos.keys.PublicKey public_key = 1;
+  optional dxos.keys.PrivateKey private_key = 2;
 }
 
 message AcceptInvitationRequest {
@@ -533,7 +551,6 @@ service InvitationsService {
   rpc Authenticate(AuthenticationRequest) returns (google.protobuf.Empty);
   rpc CancelInvitation(CancelInvitationRequest) returns (google.protobuf.Empty);
   rpc QueryInvitations(google.protobuf.Empty) returns (stream QueryInvitationsResponse);
-  rpc LoadPersistentInvitations(google.protobuf.Empty) returns (LoadPersistentInvitationsResponse);
 }
 
 //

package/src/proto/dxos/config.proto

@@ -103,6 +103,10 @@ message Runtime {
       optional StorageDriver key_store = 2;
       optional StorageDriver data_store = 3;
       optional string data_root = 4;
+      
+      /**
+       * @deprecated
+       */
       optional bool space_fragmentation = 5;
     }
     
@@ -127,12 +131,13 @@ message Runtime {
     /// Location of the remote client host.
     // TODO(burdon): Rename vault_endpoint (generalize http/ws; drop vault.html).
     optional string remote_source = 6;
-    
+
+    // Authenticate via `Sec-WebSocket-Protocol` header hack.
+    optional string remote_source_authentication_token = 8;
+
     /// Connect to and serve client services to a remote proxy.
     optional string devtools_proxy = 7;
 
-    /// Enable E.object api
-    optional bool use_reactive_object_api = 8;
   }
 
   message App {

package/src/proto/dxos/echo/model/document.proto

@@ -32,9 +32,6 @@ message Value {
     Array array                       = 21;
 
     Reference reference               = 30;
-
-    // YJS state snapshot.
-    YJS yjs                           = 40;
   }
 }
 

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

@@ -47,7 +47,11 @@ message MutationReceipt {
 }
 
 message FlushRequest {
-  dxos.keys.PublicKey space_key = 1;
+  optional dxos.keys.PublicKey space_key = 1;
+  /**
+   * Automerge specific document ids to wait to flush.
+   */
+  repeated string document_ids = 2;
 }
 
 // Automerge specific.

package/src/proto/dxos/halo/invitations.proto

@@ -33,12 +33,19 @@ message IntroductionRequest {
 message IntroductionResponse {
   dxos.client.services.Invitation.AuthMethod auth_method = 1;
 
+  /// Present when auth_method is KNOWN_PUBLIC_KEY.
+  optional bytes challenge = 2;
+
   /// Only present for testing invitation types.
   optional dxos.keys.PublicKey space_key = 100;
 }
 
 message AuthenticationRequest {
-  string auth_code = 1;
+  /// Present when auth_method is SHARED_SECRET.
+  optional string auth_code = 1;
+
+  /// Present when auth_method is KNOWN_PUBLIC_KEY.
+  optional bytes signed_challenge = 2;
 }
 
 message AuthenticationResponse {
@@ -47,6 +54,7 @@ message AuthenticationResponse {
     INVALID_OTP = 1;
     INVALID_OPT_ATTEMPTS = 2;
     INTERNAL_ERROR = 3;
+    INVALID_SIGNATURE = 4;
   }
 
   optional Status status = 1;

package/src/proto/dxos/iframe.proto

@@ -55,11 +55,13 @@ service AppService {
 enum ShellLayout {
   DEFAULT = 0;
   INITIALIZE_IDENTITY = 1;
-  IDENTITY = 2;
-  SHARE_IDENTITY = 3;
-  EDIT_PROFILE = 4;
-  SPACE = 5;
-  JOIN_SPACE = 6;
+  INITIALIZE_IDENTITY_FROM_INVITATION = 2;
+  IDENTITY = 3;
+  SHARE_IDENTITY = 4;
+  EDIT_PROFILE = 5;
+  SPACE = 6;
+  JOIN_SPACE = 7;
+  STATUS = 8;
 }
 
 message LayoutRequest {

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

@@ -60,181 +60,6 @@ import * as dxos_value from "../value";
 import * as example_testing_data from "../../example/testing/data";
 import * as example_testing_rpc from "../../example/testing/rpc";
 import * as google_protobuf from "../../google/protobuf";
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface Metrics {
-    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
-    values?: Metrics.KeyPair[];
-}
-export namespace Metrics {
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/logging.proto}
-     */
-    export interface KeyPair {
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        key?: string;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        value?: dxos_value.Value;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        stats?: dxos_value.Stats;
-    }
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface ControlMetricsRequest {
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    reset?: boolean;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    record?: boolean;
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface ControlMetricsResponse {
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    recording?: boolean;
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface QueryMetricsRequest {
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    interval?: number;
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface QueryMetricsResponse {
-    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
-    metrics: Metrics;
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export enum LogLevel {
-    TRACE = 5,
-    DEBUG = 10,
-    INFO = 11,
-    WARN = 12,
-    ERROR = 13
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface QueryLogsRequest {
-    filters?: QueryLogsRequest.Filter[];
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    options?: QueryLogsRequest.MatchingOptions;
-}
-export namespace QueryLogsRequest {
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/logging.proto}
-     */
-    export enum MatchingOptions {
-        INCLUSIVE = 1,
-        EXPLICIT = 2
-    }
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/logging.proto}
-     */
-    export interface Filter {
-        level: LogLevel;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        pattern?: string;
-    }
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface LogEntry {
-    level: LogLevel;
-    message: string;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    context?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    meta?: LogEntry.Meta;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    error?: dxos_error.Error;
-    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
-}
-export namespace LogEntry {
-    /**
-     * Defined in:
-     *   {@link file://./../../../dxos/client/logging.proto}
-     */
-    export interface Meta {
-        file: string;
-        line: number;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        scope?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
-        /**
-         * Options:
-         *   - proto3_optional = true
-         */
-        resourceId?: number;
-    }
-}
-/**
- * Defined in:
- *   {@link file://./../../../dxos/client/logging.proto}
- */
-export interface LoggingService {
-    controlMetrics: (request: ControlMetricsRequest, options?: RequestOptions) => Promise<ControlMetricsResponse>;
-    queryMetrics: (request: QueryMetricsRequest, options?: RequestOptions) => Stream<QueryMetricsResponse>;
-    queryLogs: (request: QueryLogsRequest, options?: RequestOptions) => Stream<LogEntry>;
-}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
@@ -840,7 +665,7 @@ export interface SpacesService {
  */
 export interface IndexService {
     setConfig: (request: dxos_echo_indexing.IndexConfig, options?: RequestOptions) => Promise<void>;
-    find: (request: dxos_agent_query.QueryRequest, options?: RequestOptions) => Promise<dxos_agent_query.QueryResponse>;
+    find: (request: dxos_agent_query.QueryRequest, options?: RequestOptions) => Stream<dxos_agent_query.QueryResponse>;
 }
 /**
  * Represents the invitation state passed between client and service.
@@ -925,6 +750,20 @@ export interface Invitation {
      *   - 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;
 }
 export namespace Invitation {
     /**
@@ -933,7 +772,7 @@ export namespace Invitation {
      */
     export enum Type {
         INTERACTIVE = 0,
-        OFFLINE = 1,
+        DELEGATED = 1,
         MULTIUSE = 2
     }
     /**
@@ -950,7 +789,8 @@ export namespace Invitation {
      */
     export enum AuthMethod {
         NONE = 0,
-        SHARED_SECRET = 1
+        SHARED_SECRET = 1,
+        KNOWN_PUBLIC_KEY = 2
     }
     /**
      * Defined in:
@@ -969,6 +809,18 @@ export namespace Invitation {
         EXPIRED = 9
     }
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface AdmissionKeypair {
+    publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    privateKey?: ReturnType<(typeof substitutions)["dxos.keys.PrivateKey"]["decode"]>;
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
@@ -1055,7 +907,6 @@ export interface InvitationsService {
     authenticate: (request: AuthenticationRequest, options?: RequestOptions) => Promise<void>;
     cancelInvitation: (request: CancelInvitationRequest, options?: RequestOptions) => Promise<void>;
     queryInvitations: (request: void, options?: RequestOptions) => Stream<QueryInvitationsResponse>;
-    loadPersistentInvitations: (request: void, options?: RequestOptions) => Promise<LoadPersistentInvitationsResponse>;
 }
 /**
  * Defined in:
@@ -1099,3 +950,178 @@ export interface NetworkService {
     updateConfig: (request: UpdateConfigRequest, options?: RequestOptions) => Promise<void>;
     queryStatus: (request: void, options?: RequestOptions) => Stream<NetworkStatus>;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface Metrics {
+    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+    values?: Metrics.KeyPair[];
+}
+export namespace Metrics {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/logging.proto}
+     */
+    export interface KeyPair {
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        key?: string;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        value?: dxos_value.Value;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        stats?: dxos_value.Stats;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface ControlMetricsRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    reset?: boolean;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    record?: boolean;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface ControlMetricsResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    recording?: boolean;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface QueryMetricsRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    interval?: number;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface QueryMetricsResponse {
+    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+    metrics: Metrics;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export enum LogLevel {
+    TRACE = 5,
+    DEBUG = 10,
+    INFO = 11,
+    WARN = 12,
+    ERROR = 13
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface QueryLogsRequest {
+    filters?: QueryLogsRequest.Filter[];
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    options?: QueryLogsRequest.MatchingOptions;
+}
+export namespace QueryLogsRequest {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/logging.proto}
+     */
+    export enum MatchingOptions {
+        INCLUSIVE = 1,
+        EXPLICIT = 2
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/logging.proto}
+     */
+    export interface Filter {
+        level: LogLevel;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        pattern?: string;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface LogEntry {
+    level: LogLevel;
+    message: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    context?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    meta?: LogEntry.Meta;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    error?: dxos_error.Error;
+    timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+}
+export namespace LogEntry {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/client/logging.proto}
+     */
+    export interface Meta {
+        file: string;
+        line: number;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        scope?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        resourceId?: number;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/logging.proto}
+ */
+export interface LoggingService {
+    controlMetrics: (request: ControlMetricsRequest, options?: RequestOptions) => Promise<ControlMetricsResponse>;
+    queryMetrics: (request: QueryMetricsRequest, options?: RequestOptions) => Stream<QueryMetricsResponse>;
+    queryLogs: (request: QueryLogsRequest, options?: RequestOptions) => Stream<LogEntry>;
+}

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

@@ -292,19 +292,17 @@ export namespace Runtime {
          */
         remoteSource?: string;
         /**
-         * Connect to and serve client services to a remote proxy.
-         *
          * Options:
          *   - proto3_optional = true
          */
-        devtoolsProxy?: string;
+        remoteSourceAuthenticationToken?: string;
         /**
-         * Enable E.object api
+         * Connect to and serve client services to a remote proxy.
          *
          * Options:
          *   - proto3_optional = true
          */
-        useReactiveObjectApi?: boolean;
+        devtoolsProxy?: string;
     }
     export namespace Client {
         /**
@@ -333,6 +331,8 @@ export namespace Runtime {
              */
             dataRoot?: string;
             /**
+             * @deprecated
+             *
              * Options:
              *   - proto3_optional = true
              */

package/src/proto/gen/dxos/echo/model/document.ts

@@ -78,7 +78,6 @@ export interface Value {
     object?: KeyValueObject;
     array?: Array;
     reference?: Reference;
-    yjs?: YJS;
 }
 /**
  * Ordered collection of values.