@dxos/echo-protocol 2.18.1 → 2.18.2

package/src/proto/gen/dxos/halo/keys.ts

@@ -0,0 +1,65 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import substitutions from "../../../substitutions";
+import * as dxos_credentials from "../credentials";
+import * as dxos_echo_feed from "../echo/feed";
+import * as dxos_echo_metadata from "../echo/metadata";
+import * as dxos_echo_service from "../echo/service";
+import * as dxos_echo_snapshot from "../echo/snapshot";
+import * as dxos_echo_testing from "../echo/testing";
+import * as google_protobuf from "../../google/protobuf";
+export enum KeyType {
+    UNKNOWN = 0,
+    IDENTITY = 1,
+    DEVICE = 2,
+    PARTY = 3,
+    FEED = 4
+}
+export interface PubKey {
+    data?: Uint8Array;
+}
+export interface PrivKey {
+    data?: Uint8Array;
+}
+export interface KeyRecord {
+    /**
+     * - The `KeyType` type of the key. This is often unknown for keys from other sources.
+     */
+    type: KeyType;
+    /**
+     * - The public key as a Buffer (required).
+     */
+    publicKey: ReturnType<typeof substitutions["dxos.halo.keys.PubKey"]["decode"]>;
+    /**
+     * - The secret key as a Buffer (this will never be visible outside the Keyring).
+     */
+    secretKey?: PrivKey;
+    /**
+     * - Is this key from a Greeting "hint"?
+     */
+    hint?: boolean;
+    /**
+     * - Is this our key? Usually true if `secretKey` is present,
+     * may be false for "inception keys" such as the Party key.
+     */
+    own?: boolean;
+    /**
+     * - Is this key to be trusted?
+     */
+    trusted?: boolean;
+    /**
+     * - An RFC-3339 date/time string for when the key was added to the Keyring.
+     */
+    added?: string;
+    /**
+     * - An RFC-3339 date/time string for when the key was created.
+     */
+    created?: string;
+}
+export interface KeyRecordList {
+    keys?: KeyRecord[];
+}
+export interface KeyChain {
+    publicKey: ReturnType<typeof substitutions["dxos.halo.keys.PubKey"]["decode"]>;
+    message: dxos_credentials.SignedMessage;
+    parents?: KeyChain[];
+}

package/src/proto/gen/google/protobuf.ts

@@ -1,12 +1,12 @@
 import type { Stream } from "@dxos/codec-protobuf";
 import substitutions from "../../substitutions";
-import * as dxos from "../dxos";
-import * as dxos_echo from "../dxos/echo";
-import * as dxos_echo_keys from "../dxos/echo/keys";
+import * as dxos_credentials from "../dxos/credentials";
+import * as dxos_echo_feed from "../dxos/echo/feed";
 import * as dxos_echo_metadata from "../dxos/echo/metadata";
-import * as dxos_echo_remote from "../dxos/echo/remote";
+import * as dxos_echo_service from "../dxos/echo/service";
 import * as dxos_echo_snapshot from "../dxos/echo/snapshot";
 import * as dxos_echo_testing from "../dxos/echo/testing";
+import * as dxos_halo_keys from "../dxos/halo/keys";
 export interface Any {
     type_url?: string;
     value?: Uint8Array;

package/src/proto/gen/index.ts

@@ -1,24 +1,36 @@
 import { Schema } from "@dxos/codec-protobuf";
-import * as dxos from "./dxos";
-import * as dxos_echo from "./dxos/echo";
-import * as dxos_echo_keys from "./dxos/echo/keys";
+import * as dxos_credentials from "./dxos/credentials";
+import * as dxos_echo_feed from "./dxos/echo/feed";
 import * as dxos_echo_metadata from "./dxos/echo/metadata";
-import * as dxos_echo_remote from "./dxos/echo/remote";
+import * as dxos_echo_service from "./dxos/echo/service";
 import * as dxos_echo_snapshot from "./dxos/echo/snapshot";
 import * as dxos_echo_testing from "./dxos/echo/testing";
+import * as dxos_halo_keys from "./dxos/halo/keys";
 import * as google_protobuf from "./google/protobuf";
 import substitutions from "../substitutions";
 export interface TYPES {
-    "dxos.CredentialsMessage": dxos.CredentialsMessage;
-    "dxos.echo.EchoEnvelope": dxos_echo.EchoEnvelope;
-    "dxos.echo.ItemGenesis": dxos_echo.ItemGenesis;
-    "dxos.echo.ItemMutation": dxos_echo.ItemMutation;
-    "dxos.echo.keys.Key": dxos_echo_keys.Key;
-    "dxos.echo.LinkData": dxos_echo.LinkData;
+    "dxos.credentials.Message": dxos_credentials.Message;
+    "dxos.credentials.SignedMessage": dxos_credentials.SignedMessage;
+    "dxos.credentials.SignedMessage.Signature": dxos_credentials.SignedMessage.Signature;
+    "dxos.credentials.SignedMessage.Signed": dxos_credentials.SignedMessage.Signed;
+    "dxos.echo.feed.CredentialsMessage": dxos_echo_feed.CredentialsMessage;
+    "dxos.echo.feed.EchoEnvelope": dxos_echo_feed.EchoEnvelope;
+    "dxos.echo.feed.FeedMessage": dxos_echo_feed.FeedMessage;
+    "dxos.echo.feed.ItemGenesis": dxos_echo_feed.ItemGenesis;
+    "dxos.echo.feed.ItemMutation": dxos_echo_feed.ItemMutation;
+    "dxos.echo.feed.LinkData": dxos_echo_feed.LinkData;
+    "dxos.echo.feed.TimeframeVector": dxos_echo_feed.TimeframeVector;
+    "dxos.echo.feed.TimeframeVector.Frame": dxos_echo_feed.TimeframeVector.Frame;
     "dxos.echo.metadata.EchoMetadata": dxos_echo_metadata.EchoMetadata;
     "dxos.echo.metadata.PartyMetadata": dxos_echo_metadata.PartyMetadata;
-    "dxos.echo.remote.ClientMessage": dxos_echo_remote.ClientMessage;
-    "dxos.echo.remote.ServerMessage": dxos_echo_remote.ServerMessage;
+    "dxos.echo.service.MutationReceipt": dxos_echo_service.MutationReceipt;
+    "dxos.echo.service.SubscribeEntitySetRequest": dxos_echo_service.SubscribeEntitySetRequest;
+    "dxos.echo.service.SubscribeEntitySetResponse": dxos_echo_service.SubscribeEntitySetResponse;
+    "dxos.echo.service.SubscribeEntityStreamRequest": dxos_echo_service.SubscribeEntityStreamRequest;
+    "dxos.echo.service.SubscribeEntityStreamResponse": dxos_echo_service.SubscribeEntityStreamResponse;
+    "dxos.echo.service.SubscribeEntityStreamResponse.Mutation": dxos_echo_service.SubscribeEntityStreamResponse.Mutation;
+    "dxos.echo.service.SubscribeEntityStreamResponse.Mutation.Metadata": dxos_echo_service.SubscribeEntityStreamResponse.Mutation.Metadata;
+    "dxos.echo.service.WriteRequest": dxos_echo_service.WriteRequest;
     "dxos.echo.snapshot.DatabaseSnapshot": dxos_echo_snapshot.DatabaseSnapshot;
     "dxos.echo.snapshot.HaloStateSnapshot": dxos_echo_snapshot.HaloStateSnapshot;
     "dxos.echo.snapshot.ItemSnapshot": dxos_echo_snapshot.ItemSnapshot;
@@ -28,12 +40,16 @@ export interface TYPES {
     "dxos.echo.snapshot.ModelSnapshot": dxos_echo_snapshot.ModelSnapshot;
     "dxos.echo.snapshot.PartySnapshot": dxos_echo_snapshot.PartySnapshot;
     "dxos.echo.testing.TestItemMutation": dxos_echo_testing.TestItemMutation;
-    "dxos.echo.TimeframeVector": dxos_echo.TimeframeVector;
-    "dxos.echo.TimeframeVector.Frame": dxos_echo.TimeframeVector.Frame;
-    "dxos.FeedMessage": dxos.FeedMessage;
+    "dxos.halo.keys.KeyChain": dxos_halo_keys.KeyChain;
+    "dxos.halo.keys.KeyRecord": dxos_halo_keys.KeyRecord;
+    "dxos.halo.keys.KeyRecordList": dxos_halo_keys.KeyRecordList;
+    "dxos.halo.keys.KeyType": dxos_halo_keys.KeyType;
+    "dxos.halo.keys.PrivKey": dxos_halo_keys.PrivKey;
+    "dxos.halo.keys.PubKey": dxos_halo_keys.PubKey;
     "google.protobuf.Any": google_protobuf.Any;
 }
 export interface SERVICES {
+    "dxos.echo.service.DataService": dxos_echo_service.DataService;
 }
-export const schemaJson = JSON.parse("{\"nested\":{\"dxos\":{\"nested\":{\"CredentialsMessage\":{\"fields\":{\"data\":{\"type\":\"bytes\",\"id\":1,\"comment\":null}},\"comment\":null},\"echo\":{\"nested\":{\"EchoEnvelope\":{\"fields\":{\"itemId\":{\"type\":\"string\",\"id\":1,\"comment\":null},\"timeframe\":{\"type\":\"TimeframeVector\",\"id\":2,\"comment\":null},\"genesis\":{\"type\":\"ItemGenesis\",\"id\":10,\"comment\":null},\"itemMutation\":{\"type\":\"ItemMutation\",\"id\":11,\"comment\":null},\"mutation\":{\"type\":\"bytes\",\"id\":12,\"comment\":null}},\"comment\":null},\"ItemGenesis\":{\"fields\":{\"itemType\":{\"type\":\"string\",\"id\":1,\"comment\":null},\"modelType\":{\"type\":\"string\",\"id\":2,\"comment\":null},\"modelVersion\":{\"type\":\"string\",\"id\":3,\"comment\":null},\"link\":{\"type\":\"LinkData\",\"id\":4,\"comment\":null}},\"comment\":null},\"ItemMutation\":{\"fields\":{\"parentId\":{\"type\":\"string\",\"id\":1,\"comment\":null}},\"comment\":null},\"keys\":{\"nested\":{\"Key\":{\"fields\":{\"data\":{\"type\":\"bytes\",\"id\":1,\"comment\":null}},\"comment\":null}}},\"LinkData\":{\"fields\":{\"source\":{\"type\":\"string\",\"id\":1,\"comment\":null},\"target\":{\"type\":\"string\",\"id\":2,\"comment\":null}},\"comment\":null},\"metadata\":{\"nested\":{\"EchoMetadata\":{\"fields\":{\"parties\":{\"rule\":\"repeated\",\"type\":\"PartyMetadata\",\"id\":1,\"comment\":null}},\"comment\":null},\"PartyMetadata\":{\"fields\":{\"key\":{\"type\":\"dxos.echo.keys.Key\",\"id\":1,\"comment\":null},\"feedKeys\":{\"rule\":\"repeated\",\"type\":\"dxos.echo.keys.Key\",\"id\":2,\"comment\":null}},\"comment\":null}}},\"remote\":{\"nested\":{\"ClientMessage\":{\"oneofs\":{\"msg\":{\"oneof\":[\"mutation\"],\"comment\":null}},\"fields\":{\"mutation\":{\"type\":\"EchoEnvelope\",\"id\":1,\"comment\":null}},\"comment\":null},\"ServerMessage\":{\"oneofs\":{\"msg\":{\"oneof\":[\"snapshot\",\"update\"],\"comment\":null}},\"fields\":{\"snapshot\":{\"type\":\"DatabaseSnapshot\",\"id\":1,\"comment\":null},\"update\":{\"type\":\"EchoEnvelope\",\"id\":2,\"comment\":null}},\"comment\":null}}},\"snapshot\":{\"nested\":{\"DatabaseSnapshot\":{\"fields\":{\"items\":{\"rule\":\"repeated\",\"type\":\"ItemSnapshot\",\"id\":1,\"comment\":null}},\"comment\":null},\"HaloStateSnapshot\":{\"fields\":{\"messages\":{\"rule\":\"repeated\",\"type\":\"dxos.CredentialsMessage\",\"id\":1,\"comment\":null}},\"comment\":null},\"ItemSnapshot\":{\"fields\":{\"itemId\":{\"type\":\"string\",\"id\":1,\"comment\":null},\"itemType\":{\"type\":\"string\",\"id\":2,\"comment\":null},\"modelType\":{\"type\":\"string\",\"id\":3,\"comment\":null},\"modelVersion\":{\"type\":\"string\",\"id\":4,\"comment\":null},\"parentId\":{\"type\":\"string\",\"id\":5,\"comment\":null},\"model\":{\"type\":\"ModelSnapshot\",\"id\":6,\"comment\":null}},\"comment\":null},\"ModelMutation\":{\"fields\":{\"mutation\":{\"rule\":\"required\",\"type\":\"bytes\",\"id\":1,\"comment\":null},\"meta\":{\"rule\":\"required\",\"type\":\"ModelMutationMeta\",\"id\":2,\"comment\":null}},\"comment\":null},\"ModelMutationArray\":{\"fields\":{\"mutations\":{\"rule\":\"repeated\",\"type\":\"ModelMutation\",\"id\":1,\"comment\":null}},\"comment\":null},\"ModelMutationMeta\":{\"fields\":{\"feedKey\":{\"rule\":\"required\",\"type\":\"bytes\",\"id\":1,\"comment\":null},\"seq\":{\"rule\":\"required\",\"type\":\"int32\",\"id\":2,\"comment\":null},\"memberKey\":{\"rule\":\"required\",\"type\":\"bytes\",\"id\":3,\"comment\":null}},\"comment\":null},\"ModelSnapshot\":{\"oneofs\":{\"snapshot\":{\"oneof\":[\"custom\",\"array\"],\"comment\":null}},\"fields\":{\"custom\":{\"type\":\"bytes\",\"id\":1,\"comment\":null},\"array\":{\"type\":\"ModelMutationArray\",\"id\":2,\"comment\":null}},\"comment\":null},\"PartySnapshot\":{\"fields\":{\"partyKey\":{\"type\":\"bytes\",\"id\":1,\"comment\":null},\"timeframe\":{\"type\":\"TimeframeVector\",\"id\":2,\"comment\":null},\"timestamp\":{\"type\":\"int32\",\"id\":3,\"comment\":null},\"halo\":{\"type\":\"HaloStateSnapshot\",\"id\":11,\"comment\":null},\"database\":{\"type\":\"DatabaseSnapshot\",\"id\":12,\"comment\":null}},\"comment\":null}}},\"testing\":{\"nested\":{\"TestItemMutation\":{\"fields\":{\"key\":{\"type\":\"string\",\"id\":1,\"comment\":null},\"value\":{\"type\":\"string\",\"id\":2,\"comment\":null}},\"comment\":null}}},\"TimeframeVector\":{\"fields\":{\"frames\":{\"rule\":\"repeated\",\"type\":\"Frame\",\"id\":1,\"comment\":null}},\"nested\":{\"Frame\":{\"fields\":{\"feedKey\":{\"type\":\"bytes\",\"id\":1,\"comment\":null},\"seq\":{\"type\":\"int32\",\"id\":3,\"comment\":null}},\"comment\":null}},\"comment\":null}}},\"FeedMessage\":{\"fields\":{\"halo\":{\"type\":\"CredentialsMessage\",\"id\":1,\"comment\":null},\"echo\":{\"type\":\"dxos.echo.EchoEnvelope\",\"id\":2,\"comment\":null}},\"comment\":null}}},\"google\":{\"nested\":{\"protobuf\":{\"nested\":{\"Any\":{\"fields\":{\"type_url\":{\"type\":\"string\",\"id\":1},\"value\":{\"type\":\"bytes\",\"id\":2}},\"comment\":null}}}}}}}");
+export const schemaJson = JSON.parse("{\"nested\":{\"dxos\":{\"nested\":{\"credentials\":{\"nested\":{\"Message\":{\"fields\":{\"payload\":{\"rule\":\"required\",\"type\":\"google.protobuf.Any\",\"id\":1,\"comment\":null}},\"comment\":null},\"SignedMessage\":{\"fields\":{\"signed\":{\"rule\":\"required\",\"type\":\"Signed\",\"id\":1,\"comment\":null},\"signatures\":{\"rule\":\"repeated\",\"type\":\"Signature\",\"id\":2,\"comment\":null}},\"nested\":{\"Signature\":{\"fields\":{\"key\":{\"rule\":\"required\",\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"signature\":{\"rule\":\"required\",\"type\":\"bytes\",\"id\":2,\"comment\":null},\"keyChain\":{\"type\":\"KeyChain\",\"id\":3,\"comment\":null}},\"comment\":null},\"Signed\":{\"fields\":{\"created\":{\"rule\":\"required\",\"type\":\"string\",\"id\":1,\"comment\":null},\"nonce\":{\"rule\":\"required\",\"type\":\"bytes\",\"id\":2,\"comment\":null},\"payload\":{\"rule\":\"required\",\"type\":\"google.protobuf.Any\",\"id\":10,\"comment\":null}},\"comment\":null}},\"comment\":\"A generic container message used whenever messages are signed (e.g. PartyCredential)\"}}},\"echo\":{\"nested\":{\"feed\":{\"nested\":{\"CredentialsMessage\":{\"fields\":{\"data\":{\"type\":\"bytes\",\"id\":1,\"comment\":null}},\"comment\":\"A container for dxos.credentials.Message\"},\"EchoEnvelope\":{\"fields\":{\"itemId\":{\"type\":\"string\",\"id\":1,\"comment\":null},\"timeframe\":{\"type\":\"TimeframeVector\",\"id\":2,\"comment\":null},\"genesis\":{\"type\":\"ItemGenesis\",\"id\":10,\"comment\":null},\"itemMutation\":{\"type\":\"ItemMutation\",\"id\":11,\"comment\":null},\"mutation\":{\"type\":\"bytes\",\"id\":12,\"comment\":null}},\"comment\":\"Wrapper for all ECHO messages.\"},\"FeedMessage\":{\"fields\":{\"halo\":{\"type\":\"CredentialsMessage\",\"id\":1,\"comment\":null},\"echo\":{\"type\":\"EchoEnvelope\",\"id\":2,\"comment\":null}},\"comment\":\"Outer message type decoded by Codec.\\nThis is what is written to the feeds.\"},\"ItemGenesis\":{\"fields\":{\"itemType\":{\"type\":\"string\",\"id\":1,\"comment\":null},\"modelType\":{\"type\":\"string\",\"id\":2,\"comment\":null},\"modelVersion\":{\"type\":\"string\",\"id\":3,\"comment\":null},\"link\":{\"type\":\"LinkData\",\"id\":4,\"comment\":null}},\"comment\":\"Item creation.\"},\"ItemMutation\":{\"fields\":{\"parentId\":{\"type\":\"string\",\"id\":1,\"comment\":null}},\"comment\":\"Item mutation.\"},\"LinkData\":{\"fields\":{\"source\":{\"type\":\"string\",\"id\":1,\"comment\":null},\"target\":{\"type\":\"string\",\"id\":2,\"comment\":null}},\"comment\":null},\"TimeframeVector\":{\"fields\":{\"frames\":{\"rule\":\"repeated\",\"type\":\"Frame\",\"id\":1,\"comment\":null}},\"nested\":{\"Frame\":{\"fields\":{\"feedKey\":{\"type\":\"bytes\",\"id\":1,\"comment\":null},\"seq\":{\"type\":\"int32\",\"id\":3,\"comment\":null}},\"comment\":null}},\"comment\":\"Vector timestamp used to order messages.\"}}},\"metadata\":{\"nested\":{\"EchoMetadata\":{\"fields\":{\"parties\":{\"rule\":\"repeated\",\"type\":\"PartyMetadata\",\"id\":1,\"comment\":null}},\"comment\":null},\"PartyMetadata\":{\"fields\":{\"key\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"feedKeys\":{\"rule\":\"repeated\",\"type\":\"PubKey\",\"id\":2,\"comment\":null}},\"comment\":null}}},\"service\":{\"nested\":{\"DataService\":{\"methods\":{\"SubscribeEntitySet\":{\"requestType\":\"SubscribeEntitySetRequest\",\"responseType\":\"SubscribeEntitySetResponse\",\"responseStream\":true,\"comment\":null},\"SubscribeEntityStream\":{\"requestType\":\"SubscribeEntityStreamRequest\",\"responseType\":\"SubscribeEntityStreamResponse\",\"responseStream\":true,\"comment\":null},\"Write\":{\"requestType\":\"WriteRequest\",\"responseType\":\"MutationReceipt\",\"comment\":null}},\"comment\":null},\"MutationReceipt\":{\"fields\":{\"feedKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"seq\":{\"type\":\"int32\",\"id\":2,\"comment\":null}},\"comment\":null},\"SubscribeEntitySetRequest\":{\"fields\":{\"partyKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null}},\"comment\":null},\"SubscribeEntitySetResponse\":{\"fields\":{\"added\":{\"rule\":\"repeated\",\"type\":\"EchoEnvelope\",\"id\":1,\"comment\":null},\"deleted\":{\"rule\":\"repeated\",\"type\":\"EchoEnvelope\",\"id\":2,\"comment\":null}},\"comment\":null},\"SubscribeEntityStreamRequest\":{\"fields\":{\"partyKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"itemId\":{\"type\":\"string\",\"id\":2,\"comment\":null}},\"comment\":null},\"SubscribeEntityStreamResponse\":{\"oneofs\":{\"kind\":{\"oneof\":[\"snapshot\",\"mutation\"],\"comment\":null}},\"fields\":{\"snapshot\":{\"type\":\"ItemSnapshot\",\"id\":1,\"comment\":null},\"mutation\":{\"type\":\"Mutation\",\"id\":2,\"comment\":null}},\"nested\":{\"Mutation\":{\"fields\":{\"data\":{\"type\":\"EchoEnvelope\",\"id\":1,\"comment\":null},\"meta\":{\"type\":\"Metadata\",\"id\":2,\"comment\":null}},\"nested\":{\"Metadata\":{\"fields\":{\"feedKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"memberKey\":{\"type\":\"PubKey\",\"id\":2,\"comment\":null},\"seq\":{\"type\":\"int32\",\"id\":3,\"comment\":null}},\"comment\":null}},\"comment\":null}},\"comment\":null},\"WriteRequest\":{\"fields\":{\"partyKey\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"mutation\":{\"type\":\"EchoEnvelope\",\"id\":2,\"comment\":null}},\"comment\":null}}},\"snapshot\":{\"nested\":{\"DatabaseSnapshot\":{\"fields\":{\"items\":{\"rule\":\"repeated\",\"type\":\"ItemSnapshot\",\"id\":1,\"comment\":null}},\"comment\":null},\"HaloStateSnapshot\":{\"fields\":{\"messages\":{\"rule\":\"repeated\",\"type\":\"dxos.CredentialsMessage\",\"id\":1,\"comment\":null}},\"comment\":null},\"ItemSnapshot\":{\"fields\":{\"itemId\":{\"type\":\"string\",\"id\":1,\"comment\":null},\"itemType\":{\"type\":\"string\",\"id\":2,\"comment\":null},\"modelType\":{\"type\":\"string\",\"id\":3,\"comment\":null},\"modelVersion\":{\"type\":\"string\",\"id\":4,\"comment\":null},\"parentId\":{\"type\":\"string\",\"id\":5,\"comment\":null},\"model\":{\"type\":\"ModelSnapshot\",\"id\":6,\"comment\":null}},\"comment\":null},\"ModelMutation\":{\"fields\":{\"mutation\":{\"rule\":\"required\",\"type\":\"bytes\",\"id\":1,\"comment\":null},\"meta\":{\"rule\":\"required\",\"type\":\"ModelMutationMeta\",\"id\":2,\"comment\":null}},\"comment\":null},\"ModelMutationArray\":{\"fields\":{\"mutations\":{\"rule\":\"repeated\",\"type\":\"ModelMutation\",\"id\":1,\"comment\":null}},\"comment\":null},\"ModelMutationMeta\":{\"fields\":{\"feedKey\":{\"rule\":\"required\",\"type\":\"bytes\",\"id\":1,\"comment\":null},\"seq\":{\"rule\":\"required\",\"type\":\"int32\",\"id\":2,\"comment\":null},\"memberKey\":{\"rule\":\"required\",\"type\":\"bytes\",\"id\":3,\"comment\":null}},\"comment\":null},\"ModelSnapshot\":{\"oneofs\":{\"snapshot\":{\"oneof\":[\"custom\",\"array\"],\"comment\":null}},\"fields\":{\"custom\":{\"type\":\"bytes\",\"id\":1,\"comment\":null},\"array\":{\"type\":\"ModelMutationArray\",\"id\":2,\"comment\":null}},\"comment\":null},\"PartySnapshot\":{\"fields\":{\"partyKey\":{\"type\":\"bytes\",\"id\":1,\"comment\":null},\"timeframe\":{\"type\":\"TimeframeVector\",\"id\":2,\"comment\":null},\"timestamp\":{\"type\":\"int32\",\"id\":3,\"comment\":null},\"halo\":{\"type\":\"HaloStateSnapshot\",\"id\":11,\"comment\":null},\"database\":{\"type\":\"DatabaseSnapshot\",\"id\":12,\"comment\":null}},\"comment\":null}}},\"testing\":{\"nested\":{\"TestItemMutation\":{\"fields\":{\"key\":{\"type\":\"string\",\"id\":1,\"comment\":null},\"value\":{\"type\":\"string\",\"id\":2,\"comment\":null}},\"comment\":null}}}}},\"halo\":{\"nested\":{\"keys\":{\"nested\":{\"KeyChain\":{\"fields\":{\"publicKey\":{\"rule\":\"required\",\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"message\":{\"rule\":\"required\",\"type\":\"SignedMessage\",\"id\":2,\"comment\":null},\"parents\":{\"rule\":\"repeated\",\"type\":\"KeyChain\",\"id\":3,\"comment\":null}},\"comment\":null},\"KeyRecord\":{\"fields\":{\"type\":{\"rule\":\"required\",\"type\":\"KeyType\",\"id\":1,\"comment\":\"- The `KeyType` type of the key. This is often unknown for keys from other sources.\"},\"publicKey\":{\"rule\":\"required\",\"type\":\"PubKey\",\"id\":2,\"comment\":\"- The public key as a Buffer (required).\"},\"secretKey\":{\"type\":\"PrivKey\",\"id\":3,\"comment\":\"- The secret key as a Buffer (this will never be visible outside the Keyring).\"},\"hint\":{\"type\":\"bool\",\"id\":4,\"comment\":\"- Is this key from a Greeting \\\"hint\\\"?\"},\"own\":{\"type\":\"bool\",\"id\":5,\"comment\":\"- Is this our key? Usually true if `secretKey` is present,\\nmay be false for \\\"inception keys\\\" such as the Party key.\"},\"trusted\":{\"type\":\"bool\",\"id\":6,\"comment\":\"- Is this key to be trusted?\"},\"added\":{\"type\":\"string\",\"id\":7,\"comment\":\"- An RFC-3339 date/time string for when the key was added to the Keyring.\"},\"created\":{\"type\":\"string\",\"id\":8,\"comment\":\"- An RFC-3339 date/time string for when the key was created.\"}},\"comment\":null},\"KeyRecordList\":{\"fields\":{\"keys\":{\"rule\":\"repeated\",\"type\":\"KeyRecord\",\"id\":1,\"comment\":null}},\"comment\":null},\"KeyType\":{\"values\":{\"UNKNOWN\":0,\"IDENTITY\":1,\"DEVICE\":2,\"PARTY\":3,\"FEED\":4},\"comment\":null,\"comments\":{\"UNKNOWN\":null,\"IDENTITY\":null,\"DEVICE\":null,\"PARTY\":null,\"FEED\":null}},\"PrivKey\":{\"fields\":{\"data\":{\"type\":\"bytes\",\"id\":1,\"comment\":null}},\"comment\":null},\"PubKey\":{\"fields\":{\"data\":{\"type\":\"bytes\",\"id\":1,\"comment\":null}},\"comment\":null}}}}}}},\"google\":{\"nested\":{\"protobuf\":{\"nested\":{\"Any\":{\"fields\":{\"type_url\":{\"type\":\"string\",\"id\":1},\"value\":{\"type\":\"bytes\",\"id\":2}},\"comment\":null}}}}}}}");
 export const schema = Schema.fromJson<TYPES, SERVICES>(schemaJson, substitutions);

package/src/proto/index.ts

@@ -5,12 +5,12 @@
 import { schema } from './gen';
 
 export * from './gen';
-export * from './gen/dxos';
-export * from './gen/dxos/echo';
+export * from './gen/dxos/echo/feed';
 export * from './gen/dxos/echo/metadata';
 export * from './gen/dxos/echo/snapshot';
 export * from './gen/dxos/echo/testing';
+export * from './gen/dxos/echo/service';
 
 export * from './messages';
 
-export const codec = schema.getCodecForType('dxos.FeedMessage');
+export const codec = schema.getCodecForType('dxos.echo.feed.FeedMessage');

package/src/proto/messages.ts

@@ -5,7 +5,7 @@
 import { Timeframe } from '../spacetime';
 import { ItemID, ItemType } from '../types';
 import { schema } from './gen';
-import { FeedMessage } from './gen/dxos';
+import { FeedMessage } from './gen/dxos/echo/feed';
 
 //
 // ECHO generators.

package/src/proto/substitutions.ts

@@ -9,11 +9,11 @@ import { Timeframe } from '../spacetime';
 
 export default {
   // TODO(marik-d): Temporary codec bridging logic until we can require proto declarations across package boundaries.
-  'dxos.CredentialsMessage': {
+  'dxos.echo.feed.CredentialsMessage': {
     encode: (msg: Message) => ({ data: codec.encode(msg) }),
     decode: (msg: any): Message => codec.decode(msg.data)
   },
-  'dxos.echo.TimeframeVector': {
+  'dxos.echo.feed.TimeframeVector': {
     encode: (timeframe: Timeframe) => ({
       frames: timeframe.frames().map(([feedKey, seq]) => ({ feedKey: feedKey.asUint8Array(), seq }))
     }),
@@ -23,7 +23,7 @@ export default {
         .map((frame: any) => [PublicKey.from(frame.feedKey), frame.seq])
     )
   },
-  'dxos.echo.keys.Key': {
+  'dxos.halo.keys.PubKey': {
     encode: (value: PublicKey) => ({ data: value.asUint8Array() }),
     decode: (value: any) => PublicKey.from(value.data)
   }

package/dist/src/proto/gen/dxos/echo/keys.d.ts

@@ -1,4 +0,0 @@
-export interface Key {
-    data?: Uint8Array;
-}
-//# sourceMappingURL=keys.d.ts.map

package/dist/src/proto/gen/dxos/echo/keys.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"keys.d.ts","sourceRoot":"","sources":["../../../../../../src/proto/gen/dxos/echo/keys.ts"],"names":[],"mappings":"AASA,MAAM,WAAW,GAAG;IAChB,IAAI,CAAC,EAAE,UAAU,CAAC;CACrB"}

package/dist/src/proto/gen/dxos/echo/keys.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"keys.js","sourceRoot":"","sources":["../../../../../../src/proto/gen/dxos/echo/keys.ts"],"names":[],"mappings":""}

package/dist/src/proto/gen/dxos/echo/remote.d.ts

@@ -1,10 +0,0 @@
-import * as dxos_echo from "../echo";
-import * as dxos_echo_snapshot from "./snapshot";
-export interface ServerMessage {
-    snapshot?: dxos_echo_snapshot.DatabaseSnapshot;
-    update?: dxos_echo.EchoEnvelope;
-}
-export interface ClientMessage {
-    mutation?: dxos_echo.EchoEnvelope;
-}
-//# sourceMappingURL=remote.d.ts.map

package/dist/src/proto/gen/dxos/echo/remote.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"remote.d.ts","sourceRoot":"","sources":["../../../../../../src/proto/gen/dxos/echo/remote.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,SAAS,MAAM,SAAS,CAAC;AAGrC,OAAO,KAAK,kBAAkB,MAAM,YAAY,CAAC;AAGjD,MAAM,WAAW,aAAa;IAC1B,QAAQ,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,CAAC;IAC/C,MAAM,CAAC,EAAE,SAAS,CAAC,YAAY,CAAC;CACnC;AACD,MAAM,WAAW,aAAa;IAC1B,QAAQ,CAAC,EAAE,SAAS,CAAC,YAAY,CAAC;CACrC"}

package/dist/src/proto/gen/dxos/echo/remote.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=remote.js.map

package/dist/src/proto/gen/dxos/echo/remote.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"remote.js","sourceRoot":"","sources":["../../../../../../src/proto/gen/dxos/echo/remote.ts"],"names":[],"mappings":""}

package/dist/src/proto/gen/dxos/echo.d.ts

@@ -1,31 +0,0 @@
-import substitutions from "../../substitutions";
-export interface TimeframeVector {
-    frames?: TimeframeVector.Frame[];
-}
-export declare namespace TimeframeVector {
-    interface Frame {
-        feedKey?: Uint8Array;
-        seq?: number;
-    }
-}
-export interface EchoEnvelope {
-    itemId?: string;
-    timeframe?: ReturnType<typeof substitutions["dxos.echo.TimeframeVector"]["decode"]>;
-    genesis?: ItemGenesis;
-    itemMutation?: ItemMutation;
-    mutation?: Uint8Array;
-}
-export interface ItemGenesis {
-    itemType?: string;
-    modelType?: string;
-    modelVersion?: string;
-    link?: LinkData;
-}
-export interface LinkData {
-    source?: string;
-    target?: string;
-}
-export interface ItemMutation {
-    parentId?: string;
-}
-//# sourceMappingURL=echo.d.ts.map

package/dist/src/proto/gen/dxos/echo.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"echo.d.ts","sourceRoot":"","sources":["../../../../../src/proto/gen/dxos/echo.ts"],"names":[],"mappings":"AACA,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAQhD,MAAM,WAAW,eAAe;IAC5B,MAAM,CAAC,EAAE,eAAe,CAAC,KAAK,EAAE,CAAC;CACpC;AACD,yBAAiB,eAAe,CAAC;IAC7B,UAAiB,KAAK;QAClB,OAAO,CAAC,EAAE,UAAU,CAAC;QACrB,GAAG,CAAC,EAAE,MAAM,CAAC;KAChB;CACJ;AACD,MAAM,WAAW,YAAY;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,UAAU,CAAC,OAAO,aAAa,CAAC,2BAA2B,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IACpF,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,EAAE,UAAU,CAAC;CACzB;AACD,MAAM,WAAW,WAAW;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,QAAQ,CAAC;CACnB;AACD,MAAM,WAAW,QAAQ;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AACD,MAAM,WAAW,YAAY;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB"}

package/dist/src/proto/gen/dxos/echo.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"echo.js","sourceRoot":"","sources":["../../../../../src/proto/gen/dxos/echo.ts"],"names":[],"mappings":""}

package/dist/src/proto/gen/dxos.d.ts

@@ -1,10 +0,0 @@
-import substitutions from "../substitutions";
-import * as dxos_echo from "./dxos/echo";
-export interface FeedMessage {
-    halo?: ReturnType<typeof substitutions["dxos.CredentialsMessage"]["decode"]>;
-    echo?: dxos_echo.EchoEnvelope;
-}
-export interface CredentialsMessage {
-    data?: Uint8Array;
-}
-//# sourceMappingURL=dxos.d.ts.map

package/dist/src/proto/gen/dxos.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"dxos.d.ts","sourceRoot":"","sources":["../../../../src/proto/gen/dxos.ts"],"names":[],"mappings":"AACA,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAC7C,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC;AAOzC,MAAM,WAAW,WAAW;IACxB,IAAI,CAAC,EAAE,UAAU,CAAC,OAAO,aAAa,CAAC,yBAAyB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC7E,IAAI,CAAC,EAAE,SAAS,CAAC,YAAY,CAAC;CACjC;AACD,MAAM,WAAW,kBAAkB;IAC/B,IAAI,CAAC,EAAE,UAAU,CAAC;CACrB"}

package/dist/src/proto/gen/dxos.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"dxos.js","sourceRoot":"","sources":["../../../../src/proto/gen/dxos.ts"],"names":[],"mappings":""}

package/src/proto/defs/dxos.proto

@@ -1,33 +0,0 @@
-//
-// Copyright 2020 DXOS.org
-//
-
-syntax = "proto3";
-
-package dxos;
-
-import "echo.proto";
-import "testing.proto";
-import "snapshot.proto";
-import "remote.proto";
-
-//
-// Typescript Note:
-// Use the interface name in code (e.g., IFeedEvenlope) and the concrete class name in the __type_url reference.
-//
-
-//
-// Outer message type decoded by Codec.
-//
-message FeedMessage {
-  CredentialsMessage halo = 1;
-  dxos.echo.EchoEnvelope echo = 2;
-}
-
-//
-// A container for dxos.credentials.Message
-// TODO(marik-d): Figure out how to import a protobuf type from @dxos/credentials package.
-//
-message CredentialsMessage {
-  bytes data = 1;
-}

package/src/proto/defs/echo.proto

@@ -1,62 +0,0 @@
-//
-// Copyright 2020 DXOS.org
-//
-
-syntax = "proto3";
-
-package dxos.echo;
-
-import "google/protobuf/any.proto";
-
-//
-// Vector timestamp used to order messages.
-//
-message TimeframeVector {
-  message Frame {
-    // TODO(marik-d): Compress using numeric feed indexes.
-    // TODO(burdon): Determine if admit DAG can be ordered. Requires party messages to be ordered (by lexical feed key).
-    bytes feedKey = 1;
-    int32 seq = 3;
-  }
-
-  repeated Frame frames = 1;
-}
-
-//
-// Wrapper for all ECHO messages.
-//
-message EchoEnvelope {
-  string itemId = 1;
-  TimeframeVector timeframe = 2;
-
-  // Create item.
-  ItemGenesis genesis = 10;
-
-  // Item system mutations.
-  ItemMutation itemMutation = 11;
-
-  // Model-specific mutations.
-  bytes mutation = 12;
-}
-
-//
-// Item creation.
-//
-message ItemGenesis {
-  string itemType = 1;
-  string modelType = 2;
-  string modelVersion = 3;
-  LinkData link = 4;
-}
-
-message LinkData {
-  string source = 1;
-  string target = 2;
-}
-
-//
-// Item mutation.
-//
-message ItemMutation {
-  string parentId = 1;
-}

package/src/proto/defs/key.proto

@@ -1,11 +0,0 @@
-//
-// Copyright 2020 DXOS.org
-//
-
-syntax = "proto3";
-
-package dxos.echo.keys;
-
-message Key {
-  bytes data = 1;
-}

package/src/proto/defs/remote.proto

@@ -1,25 +0,0 @@
-//
-// Copyright 2020 DXOS.org
-//
-
-syntax = "proto3";
-
-package dxos.echo.remote;
-
-import "echo.proto";
-import "snapshot.proto";
-
-// Message from server to client.
-message ServerMessage {
-  oneof msg {
-    DatabaseSnapshot snapshot = 1;
-    EchoEnvelope update = 2;
-  }
-}
-
-// Message from client to server.
-message ClientMessage {
-  oneof msg {
-    EchoEnvelope mutation = 1;
-  }
-}

package/src/proto/defs/snapshot.proto

@@ -1,82 +0,0 @@
-//
-// Copyright 2020 DXOS.org
-//
-
-syntax = "proto3";
-
-package dxos.echo.snapshot;
-
-import "echo.proto";
-
-//
-// Snapshots define full party state at a given point in time.
-// They must have enough information to be able to recover the party state without reading the feed messages.
-//
-// Each snapshot is identified by a party key and a timeframe.
-// The timeframe defines the set of feed messages that have already been processed.
-// When loading from the snapshot, application would skip all of the feed messages up to (and including) the provided timeframe.
-//
-
-message PartySnapshot {
-  bytes partyKey = 1;
-  TimeframeVector timeframe = 2;
-
-  // Unix timestamp of the snapshot creation time. For information purposes only.
-  int32 timestamp = 3;
-
-  HaloStateSnapshot halo = 11;
-  DatabaseSnapshot database = 12;
-}
-
-message DatabaseSnapshot {
-  repeated ItemSnapshot items = 1;
-}
-
-// For now we just store and replay a list of all halo messages as thier number is expected to be relatively low.
-message HaloStateSnapshot {
-  repeated dxos.CredentialsMessage messages = 1;
-}
-
-message ItemSnapshot {
-  string itemId = 1;
-
-  string itemType = 2;
-  string modelType = 3;
-  string modelVersion = 4;
-
-  string parentId = 5;
-
-  // TODO(burdon): = 10 (make room for other meta?)
-  ModelSnapshot model = 6;
-}
-
-message ModelSnapshot {
-  oneof snapshot {
-    // Encoding is defined by model.
-    bytes custom = 1;
-
-    // Fallback to storing array of mutations.
-    ModelMutationArray array = 2;
-  }
-}
-
-message ModelMutationArray {
-  repeated ModelMutation mutations = 1;
-}
-
-message ModelMutation {
-  // TODO(burdon): Remove required.
-  // Encoded model mutation, format is defined by model's codec.
-  required bytes mutation = 1;
-  required ModelMutationMeta meta = 2;
-}
-
-message ModelMutationMeta {
-  // TODO(burdon): Remove required.
-  required bytes feedKey = 1;
-  required int32 seq = 2;
-  required bytes memberKey = 3;
-}
-
-
-

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

@@ -1,12 +0,0 @@
-import type { Stream } from "@dxos/codec-protobuf";
-import substitutions from "../../../substitutions";
-import * as dxos from "../../dxos";
-import * as dxos_echo from "../echo";
-import * as dxos_echo_metadata from "./metadata";
-import * as dxos_echo_remote from "./remote";
-import * as dxos_echo_snapshot from "./snapshot";
-import * as dxos_echo_testing from "./testing";
-import * as google_protobuf from "../../google/protobuf";
-export interface Key {
-    data?: Uint8Array;
-}

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

@@ -1,16 +0,0 @@
-import type { Stream } from "@dxos/codec-protobuf";
-import substitutions from "../../../substitutions";
-import * as dxos from "../../dxos";
-import * as dxos_echo from "../echo";
-import * as dxos_echo_keys from "./keys";
-import * as dxos_echo_metadata from "./metadata";
-import * as dxos_echo_snapshot from "./snapshot";
-import * as dxos_echo_testing from "./testing";
-import * as google_protobuf from "../../google/protobuf";
-export interface ServerMessage {
-    snapshot?: dxos_echo_snapshot.DatabaseSnapshot;
-    update?: dxos_echo.EchoEnvelope;
-}
-export interface ClientMessage {
-    mutation?: dxos_echo.EchoEnvelope;
-}

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

@@ -1,38 +0,0 @@
-import type { Stream } from "@dxos/codec-protobuf";
-import substitutions from "../../substitutions";
-import * as dxos from "../dxos";
-import * as dxos_echo_keys from "./echo/keys";
-import * as dxos_echo_metadata from "./echo/metadata";
-import * as dxos_echo_remote from "./echo/remote";
-import * as dxos_echo_snapshot from "./echo/snapshot";
-import * as dxos_echo_testing from "./echo/testing";
-import * as google_protobuf from "../google/protobuf";
-export interface TimeframeVector {
-    frames?: TimeframeVector.Frame[];
-}
-export namespace TimeframeVector {
-    export interface Frame {
-        feedKey?: Uint8Array;
-        seq?: number;
-    }
-}
-export interface EchoEnvelope {
-    itemId?: string;
-    timeframe?: ReturnType<typeof substitutions["dxos.echo.TimeframeVector"]["decode"]>;
-    genesis?: ItemGenesis;
-    itemMutation?: ItemMutation;
-    mutation?: Uint8Array;
-}
-export interface ItemGenesis {
-    itemType?: string;
-    modelType?: string;
-    modelVersion?: string;
-    link?: LinkData;
-}
-export interface LinkData {
-    source?: string;
-    target?: string;
-}
-export interface ItemMutation {
-    parentId?: string;
-}