@dxos/protocols 0.8.4-main.fbb7a13 → 0.8.4-main.fcc0d83b33

package/src/proto/index.ts

@@ -2,5 +2,5 @@
 // Copyright 2020 DXOS.org
 //
 
-export { schema, schemaJson, type TYPES } from './gen/index.js';
-export type * from './types.js';
+export { schema, schemaJson, type TYPES } from './gen/index.ts';
+export type * from './types.ts';

package/src/proto/types.ts

@@ -4,7 +4,7 @@
 
 import { type TypedProtoMessage } from '@dxos/codec-protobuf';
 
-import { type TYPES } from './gen/index.js';
+import { type TYPES } from './gen/index.ts';
 
 // TODO(burdon): Rename ProtocolMessage.
 export type TypedMessage = TypedProtoMessage<TYPES>;

package/src/space-archive.ts

@@ -11,8 +11,13 @@ import type { IdentityDid, SpaceId } from '@dxos/keys';
  *
  * A tar archive with files:
  *  - metadata.json -- JSON-encoded {@link SpaceArchiveMetadata} file.
- *  - documents
+ *  - documents/
  *    - <document-id>.bin -- Automerge document.
+ *  - feeds/
+ *    - <feed-id>/
+ *      - metadata.json -- JSON-encoded {@link FeedArchiveMetadata} file.
+ *      - blocks-0.json -- JSON array of {@link FeedArchiveBlock} (chunks of 100).
+ *      - blocks-1.json -- ...
  */
 
 /**
@@ -60,7 +65,71 @@ export interface SpaceArchiveMetadata {
   };
 }
 
+/**
+ * Feed metadata stored in `feeds/<feed-id>/metadata.json`.
+ */
+export interface FeedArchiveMetadata {
+  /**
+   * Feed identifier.
+   */
+  id: string;
+
+  /**
+   * Feed namespace (e.g., 'data', 'trace').
+   */
+  namespace: string;
+}
+
+/**
+ * Feed block stored in `feeds/<feed-id>/blocks-N.json`.
+ * Represents a single block from the feed.
+ */
+export interface FeedArchiveBlock {
+  /**
+   * Actor that produced this block.
+   */
+  actorId: string;
+
+  /**
+   * Per-feed monotonic sequence assigned by the actor.
+   */
+  sequence: number;
+
+  /**
+   * Actor of the immediate predecessor block, if any.
+   */
+  prevActorId: string | null;
+
+  /**
+   * Sequence of the immediate predecessor block, if any.
+   */
+  prevSequence: number | null;
+
+  /**
+   * Globally ordered position assigned by a position authority.
+   */
+  position: number | null;
+
+  /**
+   * Milliseconds since Unix epoch when the block was created.
+   */
+  timestamp: number;
+
+  /**
+   * Base64-encoded serialized application payload.
+   */
+  data: string;
+}
+
+/**
+ * Number of blocks per chunk file.
+ */
+export const FEED_ARCHIVE_BLOCKS_PER_CHUNK = 100;
+
 export const SpaceArchiveFileStructure = {
   metadata: 'metadata.json',
   documents: 'documents',
+  feeds: 'feeds',
+  feedMetadata: 'metadata.json',
+  feedBlocksPrefix: 'blocks-',
 } as const;

package/src/types.ts

@@ -5,8 +5,8 @@
 import { type PublicKey } from '@dxos/keys';
 import { type Timeframe } from '@dxos/timeframe';
 
-import { type CredentialsMessage, type FeedMessage } from './proto/gen/dxos/echo/feed.js';
-import { type EchoObjectBatch } from './proto/gen/dxos/echo/object.js';
+import { type CredentialsMessage, type FeedMessage } from './proto/gen/dxos/echo/feed.ts';
+import { type EchoObjectBatch } from './proto/gen/dxos/echo/object.ts';
 
 // TODO(burdon): Replace with proto definition.
 export type FeedMeta = {

package/dist/src/queue.d.ts

@@ -1,3 +0,0 @@
-export { type QueueService, type QueueQuery, type QueueQueryResult as QueryResult, type QueryQueueRequest, type InsertIntoQueueRequest, type DeleteFromQueueRequest, } from './proto/gen/dxos/client/services.js';
-export declare const KEY_QUEUE_POSITION = "dxos.org/key/queue-position";
-//# sourceMappingURL=queue.d.ts.map

package/dist/src/queue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"queue.d.ts","sourceRoot":"","sources":["../../src/queue.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,KAAK,gBAAgB,IAAI,WAAW,EACpC,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,GAC5B,MAAM,qCAAqC,CAAC;AAE7C,eAAO,MAAM,kBAAkB,gCAAgC,CAAC"}

package/dist/src/queue.js

@@ -1,5 +0,0 @@
-//
-// Copyright 2026 DXOS.org
-//
-export const KEY_QUEUE_POSITION = 'dxos.org/key/queue-position';
-//# sourceMappingURL=queue.js.map

package/dist/src/queue.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"queue.js","sourceRoot":"","sources":["../../src/queue.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAWF,MAAM,CAAC,MAAM,kBAAkB,GAAG,6BAA6B,CAAC"}

package/dist/src/tracing.d.ts

@@ -1,40 +0,0 @@
-export type Command = 'begin' | 'end' | 'update';
-export type TraceStatus = 'ok' | 'error';
-export type DataType = Record<string, any>;
-export type TracingContext = {
-    span?: {
-        id: string;
-        command?: Command;
-        parent?: string;
-        status?: TraceStatus;
-        data?: DataType;
-    };
-};
-export type Trace = {
-    begin: (opts: {
-        id: string;
-        parentId?: string;
-        data?: DataType;
-    }) => TracingContext;
-    end: (opts: {
-        id: string;
-        status?: 'ok' | 'error';
-        data?: DataType;
-    }) => TracingContext;
-    update: (opts: {
-        id: string;
-        data: DataType;
-    }) => TracingContext;
-    error: (opts: {
-        id: string;
-        error: Error;
-        data?: DataType;
-    }) => TracingContext;
-};
-export declare const trace: Trace;
-export type DataPipelineProcessed = {
-    spaceKey: string;
-    feedKey: string;
-    seq: number;
-};
-//# sourceMappingURL=tracing.d.ts.map

package/dist/src/tracing.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"tracing.d.ts","sourceRoot":"","sources":["../../src/tracing.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,OAAO,GAAG,OAAO,GAAG,KAAK,GAAG,QAAQ,CAAC;AAEjD,MAAM,MAAM,WAAW,GAAG,IAAI,GAAG,OAAO,CAAC;AAEzC,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE3C,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,CAAC,EAAE;QACL,EAAE,EAAE,MAAM,CAAC;QACX,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,IAAI,CAAC,EAAE,QAAQ,CAAC;KACjB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,KAAK,EAAE,CAAC,IAAI,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,QAAQ,CAAA;KAAE,KAAK,cAAc,CAAC;IACpF,GAAG,EAAE,CAAC,IAAI,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,IAAI,GAAG,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,QAAQ,CAAA;KAAE,KAAK,cAAc,CAAC;IACxF,MAAM,EAAE,CAAC,IAAI,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,QAAQ,CAAA;KAAE,KAAK,cAAc,CAAC;IACjE,KAAK,EAAE,CAAC,IAAI,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,KAAK,CAAC;QAAC,IAAI,CAAC,EAAE,QAAQ,CAAA;KAAE,KAAK,cAAc,CAAC;CAChF,CAAC;AAEF,eAAO,MAAM,KAAK,EAAE,KAgDnB,CAAC;AAMF,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC"}

package/dist/src/tracing.js

@@ -1,50 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-export const trace = {
-    begin: ({ id, parentId, data }) => {
-        return {
-            span: {
-                command: 'begin',
-                id,
-                parent: parentId,
-                data,
-            },
-        };
-    },
-    end: ({ id, status, data }) => {
-        return {
-            span: {
-                command: 'end',
-                id,
-                status: status ?? 'ok',
-                data,
-            },
-        };
-    },
-    update: ({ id, data }) => {
-        return {
-            span: {
-                command: 'update',
-                id,
-                data,
-            },
-        };
-    },
-    error: ({ id, error, data }) => {
-        return {
-            span: {
-                command: 'end',
-                id,
-                status: 'error',
-                data: {
-                    errorMessage: error.message,
-                    errorName: error.name,
-                    errorStack: error.stack,
-                    ...data,
-                },
-            },
-        };
-    },
-};
-//# sourceMappingURL=tracing.js.map

package/dist/src/tracing.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"tracing.js","sourceRoot":"","sources":["../../src/tracing.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAyBF,MAAM,CAAC,MAAM,KAAK,GAAU;IAC1B,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE;QAChC,OAAO;YACL,IAAI,EAAE;gBACJ,OAAO,EAAE,OAAO;gBAChB,EAAE;gBACF,MAAM,EAAE,QAAQ;gBAChB,IAAI;aACL;SACF,CAAC;IACJ,CAAC;IAED,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE;QAC5B,OAAO;YACL,IAAI,EAAE;gBACJ,OAAO,EAAE,KAAK;gBACd,EAAE;gBACF,MAAM,EAAE,MAAM,IAAI,IAAI;gBACtB,IAAI;aACL;SACF,CAAC;IACJ,CAAC;IAED,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;QACvB,OAAO;YACL,IAAI,EAAE;gBACJ,OAAO,EAAE,QAAQ;gBACjB,EAAE;gBACF,IAAI;aACL;SACF,CAAC;IACJ,CAAC;IAED,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE;QAC7B,OAAO;YACL,IAAI,EAAE;gBACJ,OAAO,EAAE,KAAK;gBACd,EAAE;gBACF,MAAM,EAAE,OAAO;gBACf,IAAI,EAAE;oBACJ,YAAY,EAAE,KAAK,CAAC,OAAO;oBAC3B,SAAS,EAAE,KAAK,CAAC,IAAI;oBACrB,UAAU,EAAE,KAAK,CAAC,KAAK;oBACvB,GAAG,IAAI;iBACR;aACF;SACF,CAAC;IACJ,CAAC;CACF,CAAC"}

package/src/queue.ts

@@ -1,14 +0,0 @@
-//
-// Copyright 2026 DXOS.org
-//
-
-export {
-  type QueueService,
-  type QueueQuery,
-  type QueueQueryResult as QueryResult,
-  type QueryQueueRequest,
-  type InsertIntoQueueRequest,
-  type DeleteFromQueueRequest,
-} from './proto/gen/dxos/client/services.js';
-
-export const KEY_QUEUE_POSITION = 'dxos.org/key/queue-position';

package/src/tracing.ts

@@ -1,86 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-export type Command = 'begin' | 'end' | 'update';
-
-export type TraceStatus = 'ok' | 'error';
-
-export type DataType = Record<string, any>;
-
-export type TracingContext = {
-  span?: {
-    id: string;
-    command?: Command;
-    parent?: string;
-    status?: TraceStatus;
-    data?: DataType;
-  };
-};
-
-export type Trace = {
-  begin: (opts: { id: string; parentId?: string; data?: DataType }) => TracingContext;
-  end: (opts: { id: string; status?: 'ok' | 'error'; data?: DataType }) => TracingContext;
-  update: (opts: { id: string; data: DataType }) => TracingContext;
-  error: (opts: { id: string; error: Error; data?: DataType }) => TracingContext;
-};
-
-export const trace: Trace = {
-  begin: ({ id, parentId, data }) => {
-    return {
-      span: {
-        command: 'begin',
-        id,
-        parent: parentId,
-        data,
-      },
-    };
-  },
-
-  end: ({ id, status, data }) => {
-    return {
-      span: {
-        command: 'end',
-        id,
-        status: status ?? 'ok',
-        data,
-      },
-    };
-  },
-
-  update: ({ id, data }) => {
-    return {
-      span: {
-        command: 'update',
-        id,
-        data,
-      },
-    };
-  },
-
-  error: ({ id, error, data }) => {
-    return {
-      span: {
-        command: 'end',
-        id,
-        status: 'error',
-        data: {
-          errorMessage: error.message,
-          errorName: error.name,
-          errorStack: error.stack,
-          ...data,
-        },
-      },
-    };
-  },
-};
-
-//
-// Domain-specific tracing
-//
-
-export type DataPipelineProcessed = {
-  spaceKey: string;
-  feedKey: string;
-  seq: number;
-};