@dxos/protocols 0.8.4-main.b97322e → 0.8.4-main.f5c0578

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/protocols",
-  "version": "0.8.4-main.b97322e",
+  "version": "0.8.4-main.f5c0578",
   "description": "Protobuf definitions for DXOS protocols.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -60,18 +60,18 @@
   ],
   "dependencies": {
     "@bufbuild/protobuf": "^2.1.0",
-    "@dxos/codec-protobuf": "0.8.4-main.b97322e",
-    "@dxos/invariant": "0.8.4-main.b97322e",
-    "@dxos/keys": "0.8.4-main.b97322e",
-    "@dxos/timeframe": "0.8.4-main.b97322e",
-    "@dxos/util": "0.8.4-main.b97322e",
-    "@dxos/effect": "0.8.4-main.b97322e"
+    "@dxos/codec-protobuf": "0.8.4-main.f5c0578",
+    "@dxos/effect": "0.8.4-main.f5c0578",
+    "@dxos/invariant": "0.8.4-main.f5c0578",
+    "@dxos/timeframe": "0.8.4-main.f5c0578",
+    "@dxos/util": "0.8.4-main.f5c0578",
+    "@dxos/keys": "0.8.4-main.f5c0578"
   },
   "devDependencies": {
     "@bufbuild/buf": "^1.43.0",
     "@bufbuild/protoc-gen-es": "^2.1.0",
-    "effect": "3.17.0",
-    "@dxos/protobuf-compiler": "0.8.4-main.b97322e"
+    "effect": "3.17.7",
+    "@dxos/protobuf-compiler": "0.8.4-main.f5c0578"
   },
   "peerDependencies": {
     "effect": "^3.13.3"

package/src/edge.ts

@@ -6,12 +6,14 @@ import { Schema } from 'effect';
 
 import { SpaceId } from '@dxos/keys';
 
-// TODO(burdon): Rename EdgerRouterEndpoint?
+// TODO(burdon): Rename EdgerRouterEndpoint.
+// If we would rename it, we need to be careful to not break composer production.
 export enum EdgeService {
   AUTOMERGE_REPLICATOR = 'automerge-replicator',
   FEED_REPLICATOR = 'feed-replicator',
   SWARM = 'swarm',
   SIGNAL = 'signal',
+  STATUS = 'status',
 }
 
 export type EdgeHttpSuccess<T> = {
@@ -138,12 +140,18 @@ export type UploadFunctionResponseBody = {
 };
 
 export type CreateSpaceRequest = {
+  /**
+   * HEX encoded public key of the agent.
+   */
   agentKey: string;
 };
 
 export type CreateSpaceResponseBody = {
+  /**
+   * HEX encoded public key of the space.
+   */
   spaceKey: string;
-  spaceId: string; // TODO(burdon): Use SpaceId.
+  spaceId: SpaceId;
   automergeRoot: string;
 };
 
@@ -220,3 +228,49 @@ export type EdgeStatus = {
     fetchError?: string;
   };
 };
+
+//
+// Space import/export.
+//
+
+export type ImportBundleRequest = {
+  bundle: {
+    /**
+     * DocumentId.
+     */
+    documentId: string;
+    /**
+     * Encoded mutation.
+     */
+    mutation: string;
+    /**
+     * Heads of the document.
+     */
+    heads: string[];
+  }[];
+};
+
+export type ExportBundleRequest = {
+  /**
+   * DocumentId -> Heads (decoded heads since which we want to export).
+   */
+  docHeads: Record<string, string[]>;
+};
+
+export type ExportBundleResponse = {
+  bundle: {
+    /**
+     * DocumentId.
+     */
+    documentId: string;
+    /**
+     * Encoded mutation.
+     */
+    mutation: string;
+  }[];
+};
+
+export const DocumentCodec = {
+  encode: (doc: Uint8Array) => Buffer.from(doc).toString('base64'),
+  decode: (doc: string) => new Uint8Array(Buffer.from(doc, 'base64')),
+};

package/src/errors/encoding.ts

@@ -2,9 +2,10 @@
 // Copyright 2023 DXOS.org
 //
 
-import { reconstructError } from './helpers.js';
 import { type Error as SerializedErrorProto } from '../proto/gen/dxos/error.js';
 
+import { reconstructError } from './helpers.js';
+
 export const encodeError = (err: any): SerializedErrorProto => {
   if (typeof err === 'object' && err?.message) {
     return {

package/src/errors/errors.ts

@@ -4,9 +4,10 @@
 
 import { PublicKey } from '@dxos/keys';
 
+import type { ObjectId } from '../types.js';
+
 import { ApiError, BaseError, DatabaseError, SystemError } from './base-errors.js';
 import { registerError, registerErrorMessageContext, registerErrorNoArgs } from './helpers.js';
-import type { ObjectId } from '../types.js';
 
 /**
  * Thrown when request was terminated because the RPC endpoint has been closed.

package/src/errors/helpers.ts

@@ -4,9 +4,10 @@
 
 import { invariant } from '@dxos/invariant';
 
-import { SystemError } from './base-errors.js';
 import { type Error as SerializedErrorProto } from '../proto/gen/dxos/error.js';
 
+import { SystemError } from './base-errors.js';
+
 export const reconstructError = (error: SerializedErrorProto) => {
   const { name, message, context } = error;
   return errorFromCode(name, message, context);

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;
+}