@dxos/echo-protocol 2.33.8 → 2.33.9-dev.0cfaca1b

package/src/feeds/feed.test.ts

@@ -6,7 +6,7 @@ import pify from 'pify';
 
 import { createKeyPair } from '@dxos/crypto';
 import { FeedStore } from '@dxos/feed-store';
-import { PublicKey } from '@dxos/protocols';
+import { PublicKey, Timeframe } from '@dxos/protocols';
 import { createStorage, StorageType } from '@dxos/random-access-multi-storage';
 
 import { codec, FeedMessage } from '../proto';
@@ -14,7 +14,7 @@ import { createFeedWriter } from './feed-writer';
 
 describe('Feed tests:', () => {
   test('codec', () => {
-    const message1: FeedMessage = {};
+    const message1: FeedMessage = { timeframe: new Timeframe() };
 
     const buffer = codec.encode(message1);
 
@@ -30,7 +30,7 @@ describe('Feed tests:', () => {
     const { feed } = await feedStore.openReadWriteFeed(PublicKey.from(publicKey), secretKey);
     expect(feed.length).toBe(0);
 
-    const data: FeedMessage = {};
+    const data: FeedMessage = { timeframe: new Timeframe() };
 
     await pify(feed.append.bind(feed))(data);
 
@@ -47,9 +47,12 @@ describe('Feed tests:', () => {
     const writer = createFeedWriter<FeedMessage>(feed);
 
     const data: FeedMessage = {
+      timeframe: new Timeframe(),
       echo: {
+        itemId: 'id',
         genesis: {
-          itemType: 'foo'
+          itemType: 'foo',
+          modelType: 'bar'
         }
       }
     };

package/src/index.ts

@@ -4,5 +4,4 @@
 
 export * from './feeds';
 export * from './proto';
-export * from './spacetime';
 export * from './types';

package/src/proto/defs/import.proto

@@ -3,7 +3,9 @@ syntax = "proto3";
 package dxos;
 
 import "@dxos/protocols/src/proto/dxos/echo/feed.proto";
-import "@dxos/protocols/src/proto/dxos/echo/snapshot.proto";
-import "@dxos/protocols/src/proto/dxos/echo/service.proto";
-import "@dxos/protocols/src/proto/dxos/echo/metadata.proto";
 import "@dxos/protocols/src/proto/dxos/echo/invitation.proto";
+import "@dxos/protocols/src/proto/dxos/echo/metadata.proto";
+import "@dxos/protocols/src/proto/dxos/echo/service.proto";
+import "@dxos/protocols/src/proto/dxos/echo/snapshot.proto";
+
+import "@dxos/protocols/src/proto/dxos/test/echo.proto";

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

@@ -8,26 +8,66 @@ import * as dxos_echo_snapshot from "./echo/snapshot";
 import * as dxos_echo_testing from "./echo/testing";
 import * as dxos_echo_timeframe from "./echo/timeframe";
 import * as dxos_halo_keys from "./halo/keys";
+import * as dxos_test_echo from "./test/echo";
 import * as google_protobuf from "../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../common/protocols/src/proto/dxos/halo/signed.proto}
+ */
 export interface Message {
     payload: google_protobuf.Any;
 }
 /**
  * A generic container message used whenever messages are signed (e.g. PartyCredential)
+ *
+ * Defined in:
+ *   {@link file://./../../../../../../common/protocols/src/proto/dxos/halo/signed.proto}
  */
 export interface SignedMessage {
+    /**
+     * The signed message contents.
+     */
     signed: SignedMessage.Signed;
+    /**
+     * An array of Signatures, one for each key that signed the message.
+     */
     signatures?: SignedMessage.Signature[];
 }
 export namespace SignedMessage {
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../common/protocols/src/proto/dxos/halo/signed.proto}
+     */
     export interface Signed {
+        /**
+         * RFC-3339 datetime string.
+         */
         created: string;
         nonce: Uint8Array;
+        /**
+         * The payload to be signed.
+         */
         payload: google_protobuf.Any;
     }
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../common/protocols/src/proto/dxos/halo/signed.proto}
+     */
     export interface Signature {
+        /**
+         * The publicKey of the keypair that made this signature.
+         */
         key: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+        /**
+         * The bytes of the signature.
+         */
         signature: Uint8Array;
+        /**
+         * The certification chain of SignedMessages for this key.
+         *
+         * Options:
+         *   - proto3_optional = true
+         */
         keyChain?: dxos_halo_keys.KeyChain;
     }
 }

package/src/proto/gen/dxos/echo/feed.ts

@@ -8,53 +8,113 @@ import * as dxos_echo_snapshot from "./snapshot";
 import * as dxos_echo_testing from "./testing";
 import * as dxos_echo_timeframe from "./timeframe";
 import * as dxos_halo_keys from "../halo/keys";
+import * as dxos_test_echo from "../test/echo";
 import * as google_protobuf from "../../google/protobuf";
 /**
  * Outer message type decoded by Codec.
  * This is what is written to the feeds.
+ *
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/feed.proto}
  */
 export interface FeedMessage {
-    timeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
+    timeframe: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
     halo?: ReturnType<(typeof substitutions)["dxos.echo.feed.CredentialsMessage"]["decode"]>;
     echo?: EchoEnvelope;
 }
 /**
  * A container for dxos.credentials.Message
+ *
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/feed.proto}
  */
 export interface CredentialsMessage {
-    data?: Uint8Array;
+    data: Uint8Array;
 }
 /**
  * Wrapper for all ECHO messages.
+ *
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/feed.proto}
  */
 export interface EchoEnvelope {
-    itemId?: string;
+    itemId: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     genesis?: ItemGenesis;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     itemMutation?: ItemMutation;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     mutation?: Uint8Array;
     /**
      * Set the model to the provided snapshot.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     snapshot?: dxos_echo_snapshot.ModelSnapshot;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/feed.proto}
+ */
 export interface LinkData {
-    source?: string;
-    target?: string;
+    source: string;
+    target: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/feed.proto}
+ */
 export interface ItemGenesis {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     itemType?: string;
-    modelType?: string;
+    modelType: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     modelVersion?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     link?: LinkData;
 }
 /**
  * Item mutation.
+ *
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/feed.proto}
  */
 export interface ItemMutation {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     parentId?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     action?: ItemMutation.Action;
 }
 export namespace ItemMutation {
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/feed.proto}
+     */
     export enum Action {
         NOOP = 0,
         DELETE = 1,

package/src/proto/gen/dxos/echo/invitation.ts

@@ -8,21 +8,38 @@ import * as dxos_echo_snapshot from "./snapshot";
 import * as dxos_echo_testing from "./testing";
 import * as dxos_echo_timeframe from "./timeframe";
 import * as dxos_halo_keys from "../halo/keys";
+import * as dxos_test_echo from "../test/echo";
 import * as google_protobuf from "../../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/invitation.proto}
+ */
 export interface InvitationDescriptor {
-    type?: InvitationDescriptor.Type;
-    swarmKey?: Uint8Array;
-    invitation?: Uint8Array;
+    type: InvitationDescriptor.Type;
+    swarmKey: Uint8Array;
+    invitation: Uint8Array;
     /**
      * Only present if type == OFFLINE.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     identityKey?: Uint8Array;
     /**
      * Must be stripped out when passing to another peer.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     secret?: Uint8Array;
 }
 export namespace InvitationDescriptor {
+    /**
+     * Defines an invitation type.
+     *
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/invitation.proto}
+     */
     export enum Type {
         INTERACTIVE = 1,
         OFFLINE = 2

package/src/proto/gen/dxos/echo/metadata.ts

@@ -8,7 +8,12 @@ import * as dxos_echo_snapshot from "./snapshot";
 import * as dxos_echo_testing from "./testing";
 import * as dxos_echo_timeframe from "./timeframe";
 import * as dxos_halo_keys from "../halo/keys";
+import * as dxos_test_echo from "../test/echo";
 import * as google_protobuf from "../../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/metadata.proto}
+ */
 export interface EchoMetadata {
     /**
      * Version number that is inceremnted every time there's a breaking change to the storage schema.
@@ -16,27 +21,46 @@ export interface EchoMetadata {
      * This is used to detect if the storage schema has changed since the last time the client was run.
      * Loading data from a different version will might result in an error.
      */
-    version?: number;
+    version: number;
     parties?: PartyMetadata[];
-    created?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
-    updated?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+    created: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+    updated: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/metadata.proto}
+ */
 export interface PartyMetadata {
     /**
      * Party key.
      */
-    key?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    key: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
     /**
-     * List of all feed associated with the party.
+     * Options:
+     *   - proto3_optional = true
      */
-    feedKeys?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>[];
+    genesisFeedKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    /**
+     * Key of the wriatable control feed.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    controlFeedKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
     /**
      * Key of the wriatable data feed.
+     *
+     * Options:
+     *   - proto3_optional = true
      */
     dataFeedKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
     /**
-     * Key of the wriatable control feed.
+     * Options:
+     *   - proto3_optional = true
      */
-    controlFeedKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
     latestTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
+    /**
+     * List of all feed associated with the party.
+     */
+    feedKeys?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>[];
 }

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

@@ -8,44 +8,81 @@ import * as dxos_echo_snapshot from "./snapshot";
 import * as dxos_echo_testing from "./testing";
 import * as dxos_echo_timeframe from "./timeframe";
 import * as dxos_halo_keys from "../halo/keys";
+import * as dxos_test_echo from "../test/echo";
 import * as google_protobuf from "../../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/service.proto}
+ */
 export interface SubscribeEntitySetRequest {
-    partyKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    partyKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/service.proto}
+ */
 export interface SubscribeEntitySetResponse {
     added?: dxos_echo_feed.EchoEnvelope[];
     deleted?: dxos_echo_feed.EchoEnvelope[];
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/service.proto}
+ */
 export interface SubscribeEntityStreamRequest {
-    partyKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
-    itemId?: string;
+    partyKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    itemId: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/service.proto}
+ */
 export interface SubscribeEntityStreamResponse {
     snapshot?: dxos_echo_snapshot.ItemSnapshot;
     mutation?: SubscribeEntityStreamResponse.Mutation;
 }
 export namespace SubscribeEntityStreamResponse {
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/service.proto}
+     */
     export interface Mutation {
-        data?: dxos_echo_feed.EchoEnvelope;
-        meta?: SubscribeEntityStreamResponse.Mutation.Metadata;
+        data: dxos_echo_feed.EchoEnvelope;
+        meta: SubscribeEntityStreamResponse.Mutation.Metadata;
     }
     export namespace Mutation {
+        /**
+         * Defined in:
+         *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/service.proto}
+         */
         export interface Metadata {
-            feedKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
-            memberKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
-            seq?: number;
-            timeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
+            feedKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+            memberKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+            seq: number;
+            timeframe: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
         }
     }
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/service.proto}
+ */
 export interface WriteRequest {
-    partyKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
-    mutation?: dxos_echo_feed.EchoEnvelope;
+    partyKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    mutation: dxos_echo_feed.EchoEnvelope;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/service.proto}
+ */
 export interface MutationReceipt {
-    feedKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
-    seq?: number;
+    feedKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    seq: number;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/service.proto}
+ */
 export interface DataService {
     subscribeEntitySet: (request: SubscribeEntitySetRequest) => Stream<SubscribeEntitySetResponse>;
     subscribeEntityStream: (request: SubscribeEntityStreamRequest) => Stream<SubscribeEntityStreamResponse>;

package/src/proto/gen/dxos/echo/snapshot.ts

@@ -8,21 +8,46 @@ import * as dxos_echo_service from "./service";
 import * as dxos_echo_testing from "./testing";
 import * as dxos_echo_timeframe from "./timeframe";
 import * as dxos_halo_keys from "../halo/keys";
+import * as dxos_test_echo from "../test/echo";
 import * as google_protobuf from "../../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/snapshot.proto}
+ */
 export interface PartySnapshot {
-    partyKey?: Uint8Array;
+    partyKey: Uint8Array;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     timeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
     timestamp?: number;
-    halo?: HaloStateSnapshot;
-    database?: DatabaseSnapshot;
+    halo: HaloStateSnapshot;
+    database: DatabaseSnapshot;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/snapshot.proto}
+ */
 export interface HaloStateSnapshot {
     messages?: ReturnType<(typeof substitutions)["dxos.echo.feed.CredentialsMessage"]["decode"]>[];
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/snapshot.proto}
+ */
 export interface DatabaseSnapshot {
     items?: ItemSnapshot[];
     links?: LinkSnapshot[];
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/snapshot.proto}
+ */
 export interface ItemSnapshot {
     /**
      * Options:
@@ -34,11 +59,7 @@ export interface ItemSnapshot {
      *   - proto3_optional = true
      */
     itemType?: string;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    modelType?: string;
+    modelType: string;
     /**
      * Options:
      *   - proto3_optional = true
@@ -55,6 +76,10 @@ export interface ItemSnapshot {
      */
     model?: ModelSnapshot;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/snapshot.proto}
+ */
 export interface LinkSnapshot {
     /**
      * Options:
@@ -66,11 +91,7 @@ export interface LinkSnapshot {
      *   - proto3_optional = true
      */
     linkType?: string;
-    /**
-     * Options:
-     *   - proto3_optional = true
-     */
-    modelType?: string;
+    modelType: string;
     /**
      * Options:
      *   - proto3_optional = true
@@ -84,6 +105,10 @@ export interface LinkSnapshot {
      */
     model?: ModelSnapshot;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/snapshot.proto}
+ */
 export interface ModelSnapshot {
     /**
      * Encoded model snapshot (defined by the model's codec).
@@ -98,10 +123,18 @@ export interface ModelSnapshot {
      */
     mutations?: ModelMutation[];
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/snapshot.proto}
+ */
 export interface ModelMutation {
     mutation: Uint8Array;
     meta: ModelMutationMeta;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/snapshot.proto}
+ */
 export interface ModelMutationMeta {
     feedKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
     seq: number;

package/src/proto/gen/dxos/echo/testing.ts

@@ -8,14 +8,27 @@ import * as dxos_echo_service from "./service";
 import * as dxos_echo_snapshot from "./snapshot";
 import * as dxos_echo_timeframe from "./timeframe";
 import * as dxos_halo_keys from "../halo/keys";
+import * as dxos_test_echo from "../test/echo";
 import * as google_protobuf from "../../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../../defs/testing.proto}
+ */
 export interface TestItemMutation {
-    key?: string;
-    value?: string;
+    key: string;
+    value: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../defs/testing.proto}
+ */
 export interface TestListMutation {
-    data?: string;
+    data: string;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../defs/testing.proto}
+ */
 export interface TestItemSnapshot {
     keys?: TestItemMutation[];
 }

package/src/proto/gen/dxos/echo/timeframe.ts

@@ -8,16 +8,24 @@ import * as dxos_echo_service from "./service";
 import * as dxos_echo_snapshot from "./snapshot";
 import * as dxos_echo_testing from "./testing";
 import * as dxos_halo_keys from "../halo/keys";
+import * as dxos_test_echo from "../test/echo";
 import * as google_protobuf from "../../google/protobuf";
 /**
  * Vector timestamp used to order messages.
+ *
+ * Defined in:
+ *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/timeframe.proto}
  */
 export interface TimeframeVector {
     frames?: TimeframeVector.Frame[];
 }
 export namespace TimeframeVector {
+    /**
+     * Defined in:
+     *   {@link file://./../../../../../../../common/protocols/src/proto/dxos/echo/timeframe.proto}
+     */
     export interface Frame {
-        feedKey?: Uint8Array;
-        seq?: number;
+        feedKey: Uint8Array;
+        seq: number;
     }
 }