@dxos/protocols 0.1.0

package/src/proto/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2020 DXOS.org
+//
+
+export { schema, schemaJson, TYPES } from './gen';

package/src/proto/substitutions.ts

@@ -0,0 +1,39 @@
+//
+// Copyright 2020 DXOS.org
+//
+
+import { anySubstitutions, timestampSubstitutions } from '@dxos/codec-protobuf';
+import { PublicKey } from '@dxos/keys';
+import { Timeframe } from '@dxos/timeframe';
+
+export const substitutions = {
+  'dxos.keys.PublicKey': {
+    encode: (value: PublicKey) => ({ data: value.asUint8Array() }),
+    decode: (value: any) => PublicKey.from(new Uint8Array(value.data))
+  },
+
+  // TODO(dmaretskyi): Shouldn't be substituted to PublicKey.
+  'dxos.keys.PrivateKey': {
+    encode: (value: Buffer) => ({ data: new Uint8Array(value) }),
+    decode: (value: any) => PublicKey.from(new Uint8Array(value.data)).asBuffer()
+  },
+
+  'dxos.echo.timeframe.TimeframeVector': {
+    encode: (timeframe: Timeframe) => ({
+      frames: timeframe.frames().map(([feedKey, seq]) => ({ feedKey: feedKey.asUint8Array(), seq }))
+    }),
+
+    decode: (vector: any) =>
+      new Timeframe(
+        (vector.frames ?? [])
+          .filter((frame: any) => frame.feedKey != null && frame.seq != null)
+          .map((frame: any) => [PublicKey.from(new Uint8Array(frame.feedKey)), frame.seq])
+      )
+  }
+};
+
+export default {
+  ...anySubstitutions,
+  ...substitutions,
+  ...timestampSubstitutions
+};

package/src/testing.ts

@@ -0,0 +1,28 @@
+//
+// Copyright 2020 DXOS.org
+//
+
+import { Timeframe } from '@dxos/timeframe';
+
+import { schema } from './proto';
+import type { FeedMessage } from './proto/gen/dxos/echo/feed';
+import { ItemID } from './types';
+
+//
+// Testing.
+//
+
+// TODO(burdon): Move to testing package (with other fakers, etc.)
+export const createTestItemMutation = (
+  itemId: ItemID,
+  key: string,
+  value: string,
+  timeframe = new Timeframe()
+): FeedMessage => ({
+  timeframe,
+  payload: {
+    '@type': 'dxos.echo.feed.EchoEnvelope',
+    itemId,
+    mutation: schema.getCodecForType('example.testing.data.TestItemMutation').encode({ key, value })
+  }
+});

package/src/types.ts

@@ -0,0 +1,51 @@
+//
+// Copyright 2020 DXOS.org
+//
+
+import { TypedProtoMessage } from '@dxos/codec-protobuf';
+import { PublicKey } from '@dxos/keys';
+import { Timeframe } from '@dxos/timeframe';
+
+import { TYPES } from './proto';
+import { EchoEnvelope, FeedMessage, CredentialsMessage } from './proto/gen/dxos/echo/feed';
+
+// TODO(burdon): Rename ProtocolMessage.
+export type TypedMessage = TypedProtoMessage<TYPES>;
+
+// TODO(burdon): Replace with proto definition.
+export type FeedMeta = {
+  feedKey: PublicKey;
+  seq: number;
+};
+
+export type FeedBlock<T> = {
+  feedKey: PublicKey;
+  seq: number;
+  data: T;
+};
+
+export type FeedMessageBlock = FeedBlock<FeedMessage>;
+
+export interface MutationMeta extends FeedMeta {
+  memberKey: PublicKey;
+}
+
+export interface MutationMetaWithTimeframe extends MutationMeta {
+  timeframe: Timeframe;
+}
+
+// TODO(burdon): Reconcile HaloMessage with CredentialsMessage.
+export interface IHaloStream {
+  meta: FeedMeta;
+  data: CredentialsMessage;
+}
+
+// TODO(burdon): EchoMessageWrapper.
+export interface IEchoStream {
+  meta: MutationMetaWithTimeframe;
+  data: EchoEnvelope;
+}
+
+// TODO(burdon): Change to Buffer (same as key).
+export type ItemID = string;
+export type ItemType = string;