@dxos/protocols 0.1.8 → 0.1.10

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/proto/gen/index.ts"],"names":[],"mappings":";;;;;;AAAA,yDAA8C;AAyC9C,qEAA6C;AAqWhC,QAAA,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,qmiHAAqmiH,CAAC,CAAC;AAC/niH,QAAA,MAAM,GAAG,uBAAM,CAAC,QAAQ,CAAkB,kBAAU,EAAE,uBAAa,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/proto/gen/index.ts"],"names":[],"mappings":";;;;;;AAAA,yDAA8C;AAyC9C,qEAA6C;AAsWhC,QAAA,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,ygjHAAygjH,CAAC,CAAC;AACnijH,QAAA,MAAM,GAAG,uBAAM,CAAC,QAAQ,CAAkB,kBAAU,EAAE,uBAAa,CAAC,CAAC"}

package/dist/src/types.d.ts

@@ -3,17 +3,17 @@ import { PublicKey } from '@dxos/keys';
 import { Timeframe } from '@dxos/timeframe';
 import { TYPES } from './proto';
 import { EchoEnvelope, FeedMessage, CredentialsMessage } from './proto/gen/dxos/echo/feed';
-export declare type TypedMessage = TypedProtoMessage<TYPES>;
-export declare type FeedMeta = {
+export type TypedMessage = TypedProtoMessage<TYPES>;
+export type FeedMeta = {
     feedKey: PublicKey;
     seq: number;
 };
-export declare type FeedBlock<T> = {
+export type FeedBlock<T> = {
     feedKey: PublicKey;
     seq: number;
     data: T;
 };
-export declare type FeedMessageBlock = FeedBlock<FeedMessage>;
+export type FeedMessageBlock = FeedBlock<FeedMessage>;
 export interface MutationMeta extends FeedMeta {
     memberKey: PublicKey;
 }
@@ -28,6 +28,6 @@ export interface IEchoStream {
     meta: MutationMetaWithTimeframe;
     data: EchoEnvelope;
 }
-export declare type ItemID = string;
-export declare type ItemType = string;
+export type ItemID = string;
+export type ItemType = string;
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAG3F,oBAAY,YAAY,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;AAGpD,oBAAY,QAAQ,GAAG;IACrB,OAAO,EAAE,SAAS,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,oBAAY,SAAS,CAAC,CAAC,IAAI;IACzB,OAAO,EAAE,SAAS,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,CAAC,CAAC;CACT,CAAC;AAEF,oBAAY,gBAAgB,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC;AAEtD,MAAM,WAAW,YAAa,SAAQ,QAAQ;IAC5C,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,yBAA0B,SAAQ,YAAY;IAC7D,SAAS,EAAE,SAAS,CAAC;CACtB;AAGD,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAGD,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,yBAAyB,CAAC;IAChC,IAAI,EAAE,YAAY,CAAC;CACpB;AAGD,oBAAY,MAAM,GAAG,MAAM,CAAC;AAC5B,oBAAY,QAAQ,GAAG,MAAM,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAG3F,MAAM,MAAM,YAAY,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;AAGpD,MAAM,MAAM,QAAQ,GAAG;IACrB,OAAO,EAAE,SAAS,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI;IACzB,OAAO,EAAE,SAAS,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,CAAC,CAAC;CACT,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC;AAEtD,MAAM,WAAW,YAAa,SAAQ,QAAQ;IAC5C,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,yBAA0B,SAAQ,YAAY;IAC7D,SAAS,EAAE,SAAS,CAAC;CACtB;AAGD,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAGD,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,yBAAyB,CAAC;IAChC,IAAI,EAAE,YAAY,CAAC;CACpB;AAGD,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC;AAC5B,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/protocols",
-  "version": "0.1.8",
+  "version": "0.1.10",
   "description": "Protobuf definitions for DXOS protocols.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -18,12 +18,12 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/codec-protobuf": "0.1.8",
-    "@dxos/hypercore": "0.1.8",
-    "@dxos/keys": "0.1.8",
-    "@dxos/timeframe": "0.1.8",
     "assert": "^2.0.0",
-    "util": "^0.12.4"
+    "util": "^0.12.4",
+    "@dxos/codec-protobuf": "0.1.10",
+    "@dxos/hypercore": "0.1.10",
+    "@dxos/keys": "0.1.10",
+    "@dxos/timeframe": "0.1.10"
   },
   "devDependencies": {
     "@types/debug": "^4.1.7",

package/src/proto/dxos/client.proto

@@ -74,6 +74,8 @@ message Profile {
   // TODO(burdon): Remove identity from Profile (space of identity).
   dxos.keys.PublicKey identity_key = 1;
   optional string displayName = 2;
+  // TODO(mykola): Factor out. It was added to make deviceKey available in the HaloProxy.
+  optional dxos.keys.PublicKey device_key = 3;
 }
 
 message SubscribeProfileResponse {

package/src/proto/dxos/halo/credentials.proto

@@ -12,7 +12,7 @@ import "google/protobuf/timestamp.proto";
 import "dxos/keys.proto";
 
 //
-// TODO(burdon): Move these notes to the design doc commentary.
+// TODO(burdon): Reference/extract these notes to the design doc commentary.
 // Peers maintain Feeds that are admitted to HALO and ECHO Spaces.
 // Peers act as Verifiers for Credentials that may be Presented from other Peers.
 // Since Feeds implement a signed hash-linked data structure, they constitute a chain-of-authority for chained Credentials.
@@ -21,21 +21,22 @@ import "dxos/keys.proto";
 
 //
 // **SpaceGenesis** -
-//  First message written to initial Feed in a new Space.
+// First message written to initial Feed in a new Space.
 //
 
+// [ASSERTION]
 message SpaceGenesis {
   dxos.keys.PublicKey space_key = 1; // Feeds belong to Spaces.
 }
 
 //
 // **Claim** -
-//  Statement about a subject.
-//  Claims can be written directly to a feed or used within Credentials.
+// Statement about a subject.
+// Claims can be written directly to a feed or used within Credentials.
 //
 
 // TODO(burdon): Reconcile with dxos.client.SpaceMember.
-// Agent is authorized to access Space.
+// [ASSERTION]:  Agent is authorized to access Space.
 message SpaceMember {
   // TODO(burdon): Consider permissions (e.g., for Bots).
   enum Role {
@@ -50,16 +51,19 @@ message SpaceMember {
 
   dxos.keys.PublicKey space_key = 1;
   Role role = 2;
+
+  // TODO: Move elsewhere.
+  optional ProfileDocument profile = 3;
 }
 
-// Device is authorized to sign messages for a given Agent (Identity).
+// [ASSERTION]: Device is authorized to sign messages for a given Agent (Identity).
 // NOTE: Devices are Admitted to Identities.
 message AuthorizedDevice {
   dxos.keys.PublicKey identity_key = 1;
   dxos.keys.PublicKey device_key = 2; // Existing authorized device.
 }
 
-// Feed is admitted to the Space for replication.
+// [ASSERTION]: Feed is admitted to the Space for replication.
 // NOTE: Feeds are Admitted to Spaces.
 message AdmittedFeed {
   enum Designation {
@@ -78,18 +82,19 @@ message AdmittedFeed {
   /// Owning device.
   dxos.keys.PublicKey device_key = 3;
 
-  /// Controls sets the feed designation. Feeds with different designations are consumed by separate pipelines.
+  /// Controls sets the feed designation.
+  /// Feeds with different designations are consumed by separate pipelines.
   Designation designation = 4;
 }
 
-/// Associtaes a space that will implement Agent's HALO with an Identity.
+/// [ASSERTION]: Associtaes a space that will implement Agent's HALO with an Identity.
 message HaloSpace {
   dxos.keys.PublicKey identity_key = 1;
   /// Space key.
   dxos.keys.PublicKey halo_key = 2;
 }
 
-/// Grants recovery permissions to a recovery key.
+/// [ASSERTION]: Grants recovery permissions to a recovery key.
 message IdentityRecovery {
   dxos.keys.PublicKey identity_key = 1;
   /// Public key derrived from the recovery seedphrase.
@@ -101,7 +106,7 @@ message ProfileDocument {
   optional string avatar_cid = 2;
 }
 
-/// Sets profile information.
+/// [ASSERTION]: Sets profile information.
 message IdentityProfile {
 
   // TODO(dmaretskyi): This could also be a DXNS link or stored in user's public HALO (we could also index the public HALO in the DMG).
@@ -120,8 +125,8 @@ message Auth {
 
 //
 // **Claim** -
-//  Statement about a subject.
-//  Claims can be written directly to a feed or used within Credentials.
+// Statement about a subject.
+// Claims can be written directly to a feed or used within Credentials.
 //
 
 message Claim {
@@ -131,9 +136,9 @@ message Claim {
 
 //
 // **Proof** -
-//  Signature that makes Credential tamper-evident.
-//  The proof is signed by the issuer of the Credential.
-//  Ref: https://www.w3.org/TR/vc-data-model/#proofs-signatures
+// Signature that makes Credential tamper-evident.
+// The proof is signed by the issuer of the Credential.
+// Ref: https://www.w3.org/TR/vc-data-model/#proofs-signatures
 //
 
 message Proof {
@@ -171,9 +176,9 @@ message Chain {
 
 //
 // **Credential** -
-//  Set of claims containing a proof signed by the issuer.
-//  Credentials may be stored in a Credential Repository (e.g., digital wallet.)
-//  Credentials may also be store within feeds (e.g., an agent's HALO).
+// Set of claims containing a proof signed by the issuer.
+// Credentials may be stored in a Credential Repository (e.g., digital wallet.)
+// Credentials may also be store within feeds (e.g., an agent's HALO).
 //
 
 message Credential {
@@ -188,9 +193,9 @@ message Credential {
 
 //
 // **Presentation** -
-//  Signed Credential(s) sent to a Verifier.
-//  Presentations are typically NOT stored any may include a challenge (e.g., nonce).
-//  Presentations may contain multiple Credentials (and require multiple proofs).
+// Signed Credential(s) sent to a Verifier.
+// Presentations are typically NOT stored any may include a challenge (e.g., nonce).
+// Presentations may contain multiple Credentials (and require multiple proofs).
 //
 
 message Presentation {
@@ -200,20 +205,23 @@ message Presentation {
 
 //
 // **Metadata** -
-//   Persistant metadata stored outside of used to bootsrapt the stack.
+// Persistent metadata stored outside of used to bootsrapt the stack.
 //
 
 /// Information needed to bootstrap a Space.
 message SpaceRecord {
   dxos.keys.PublicKey space_key = 1;
 
-  /// All feeds in the space must form a DAG (or a tree?). This is the root feed of that structure.
+  /// All feeds in the space must form a DAG (or a tree?)
+  ///   This is the root feed of that structure.
   dxos.keys.PublicKey genesis_feed_key = 2;
 
-  /// Key of the writable feed for control messages. Keyring must have the asscoiated private key.
+  /// Key of the writable feed for control messages.
+  ///   Keyring must have the associated private key.
   dxos.keys.PublicKey write_control_feed_key = 3;
 
-  /// Key of the writable feed for data messages. Keyring must have the asscoiated private key.
+  /// Key of the writable feed for data messages.
+  ///   Keyring must have the associated private key.
   dxos.keys.PublicKey write_data_feed_key = 4;
 }
 
@@ -225,7 +233,7 @@ message IdentityRecord {
   SpaceRecord halo_space = 3;
 
   /// Public profile information.
-  /// Not yet implemented. Must be null.
+  /// TODO(burdon): Not yet implemented. Must be null.
   optional SpaceRecord profile_space = 4;
 
   /// Cached profile.

package/src/proto/dxos/halo/invitations.proto

@@ -57,9 +57,14 @@ message SpaceAdmissionCredentials {
   dxos.keys.PublicKey data_feed_key = 4;
 }
 
+message AdmissionParameters {
+  /// Guest's profile.
+  optional ProfileDocument profile = 1;
+}
+
 service SpaceHostService {
   /// Process admission request.
-  rpc RequestAdmission(google.protobuf.Empty) returns (SpaceAdmissionOffer);
+  rpc RequestAdmission(AdmissionParameters) returns (SpaceAdmissionOffer);
 
   /// Authenticate request.
   rpc Authenticate(AuthenticationRequest) returns (google.protobuf.Empty);

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

@@ -128,6 +128,11 @@ export interface Profile {
      *   - proto3_optional = true
      */
     displayName?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    deviceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
 }
 /**
  * Defined in:

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

@@ -53,6 +53,11 @@ export interface SpaceGenesis {
 export interface SpaceMember {
     spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     role: SpaceMember.Role;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    profile?: ProfileDocument;
 }
 export namespace SpaceMember {
     /**
@@ -86,7 +91,7 @@ export interface AdmittedFeed {
     identityKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     deviceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     /**
-     * Controls sets the feed designation. Feeds with different designations are consumed by separate pipelines.
+     * Feeds with different designations are consumed by separate pipelines.
      */
     designation: AdmittedFeed.Designation;
 }
@@ -102,7 +107,7 @@ export namespace AdmittedFeed {
     }
 }
 /**
- * Associtaes a space that will implement Agent's HALO with an Identity.
+ * [ASSERTION]: Associtaes a space that will implement Agent's HALO with an Identity.
  *
  * Defined in:
  *   {@link file://./../../../dxos/halo/credentials.proto}
@@ -115,7 +120,7 @@ export interface HaloSpace {
     haloKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
 }
 /**
- * Grants recovery permissions to a recovery key.
+ * [ASSERTION]: Grants recovery permissions to a recovery key.
  *
  * Defined in:
  *   {@link file://./../../../dxos/halo/credentials.proto}
@@ -144,7 +149,7 @@ export interface ProfileDocument {
     avatarCid?: string;
 }
 /**
- * Sets profile information.
+ * [ASSERTION]: Sets profile information.
  *
  * Defined in:
  *   {@link file://./../../../dxos/halo/credentials.proto}
@@ -270,15 +275,15 @@ export interface Presentation {
 export interface SpaceRecord {
     spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     /**
-     * All feeds in the space must form a DAG (or a tree?). This is the root feed of that structure.
+     * This is the root feed of that structure.
      */
     genesisFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     /**
-     * Key of the writable feed for control messages. Keyring must have the asscoiated private key.
+     * Keyring must have the associated private key.
      */
     writeControlFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     /**
-     * Key of the writable feed for data messages. Keyring must have the asscoiated private key.
+     * Keyring must have the associated private key.
      */
     writeDataFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
 }
@@ -293,7 +298,7 @@ export interface IdentityRecord {
     deviceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     haloSpace: SpaceRecord;
     /**
-     * Not yet implemented. Must be null.
+     * TODO(burdon): Not yet implemented. Must be null.
      *
      * Options:
      *   - proto3_optional = true

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

@@ -100,6 +100,19 @@ export interface SpaceAdmissionCredentials {
     controlFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     dataFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/halo/invitations.proto}
+ */
+export interface AdmissionParameters {
+    /**
+     * Guest's profile.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    profile?: dxos_halo_credentials.ProfileDocument;
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/halo/invitations.proto}
@@ -108,7 +121,7 @@ export interface SpaceHostService {
     /**
      * Process admission request.
      */
-    requestAdmission: (request: void) => Promise<SpaceAdmissionOffer>;
+    requestAdmission: (request: AdmissionParameters) => Promise<SpaceAdmissionOffer>;
     /**
      * Authenticate request.
      */