@dxos/protocols 0.1.57 → 0.1.58-main.0009f6a

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/proto/gen/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAuDhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AA8e7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,44zFAA44zF,CAAC,CAAC,CAAC;AACr8zF,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAkB,UAAU,EAAE,aAAa,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/proto/gen/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAuDhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AA+e7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,gn0FAAgn0F,CAAC,CAAC,CAAC;AACzq0F,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAkB,UAAU,EAAE,aAAa,CAAC,CAAC"}

package/dist/esm/src/storage.d.ts

@@ -1,7 +1,6 @@
 /**
  * Version for the schema of the stored data as defined in dxos.echo.metadata.EchoMetadata.
- *
- * Should be incremented every time there's a breaking change to the stored data.
+ * update when making breaking changes to the protocols or other stored data.
  */
-export declare const STORAGE_VERSION = 1;
+export declare const STORAGE_VERSION = 2;
 //# sourceMappingURL=storage.d.ts.map

package/dist/esm/src/storage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../../src/storage.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,eAAO,MAAM,eAAe,IAAI,CAAC"}
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../../src/storage.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,eAAO,MAAM,eAAe,IAAI,CAAC"}

package/dist/esm/src/storage.js

@@ -3,8 +3,7 @@
 //
 /**
  * Version for the schema of the stored data as defined in dxos.echo.metadata.EchoMetadata.
- *
- * Should be incremented every time there's a breaking change to the stored data.
+ * update when making breaking changes to the protocols or other stored data.
  */
-export const STORAGE_VERSION = 1;
+export const STORAGE_VERSION = 2;
 //# sourceMappingURL=storage.js.map

package/dist/esm/src/storage.js.map

@@ -1 +1 @@
-{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../../src/storage.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC"}
+{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../../src/storage.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/protocols",
-  "version": "0.1.57",
+  "version": "0.1.58-main.0009f6a",
   "description": "Protobuf definitions for DXOS protocols.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -33,9 +33,10 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/codec-protobuf": "0.1.57",
-    "@dxos/keys": "0.1.57",
-    "@dxos/timeframe": "0.1.57"
+    "@dxos/codec-protobuf": "0.1.58-main.0009f6a",
+    "@dxos/invariant": "0.1.58-main.0009f6a",
+    "@dxos/keys": "0.1.58-main.0009f6a",
+    "@dxos/timeframe": "0.1.58-main.0009f6a"
   },
   "devDependencies": {
     "glob": "~7.1.6"

package/src/errors/encoding.ts

@@ -0,0 +1,40 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { reconstructError } from './helpers';
+import { Error as SerializedErrorProto } from '../proto/gen/dxos/error';
+
+export const encodeError = (err: any): SerializedErrorProto => {
+  if (typeof err === 'object' && err?.message) {
+    return {
+      name: err.name,
+      message: err.message,
+      context: err.context,
+      stack: err.stack,
+    };
+  } else if (typeof err === 'string') {
+    return {
+      message: err,
+    };
+  } else {
+    return {
+      message: JSON.stringify(err),
+    };
+  }
+};
+
+export type DecodeOptions = {
+  appendStack?: string;
+};
+
+export const decodeError = (err: SerializedErrorProto, { appendStack }: DecodeOptions = {}) => {
+  const error = reconstructError(err);
+  if (appendStack) {
+    error.stack = (err.stack ?? `${error.message}\n`) + appendStack;
+  } else {
+    error.stack = err.stack;
+  }
+
+  return error;
+};

package/src/errors/errors.test.ts

@@ -0,0 +1,22 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+import chai, { expect } from 'chai';
+import chaiAsPromised from 'chai-as-promised';
+
+import { describe, test } from '@dxos/test';
+
+import { ApiError } from './errors';
+
+chai.use(chaiAsPromised);
+
+describe('Errors', () => {
+  test('test', async () => {
+    const runTest = async () => {
+      throw new ApiError('Test error');
+    };
+
+    await expect(runTest()).to.be.rejectedWith('Test error');
+  });
+});

package/src/errors/errors.ts

@@ -0,0 +1,170 @@
+//
+// Copyright 2021 DXOS.org
+//
+
+import type { PublicKey } from '@dxos/keys';
+
+import type { ItemID } from '../types';
+
+/**
+ * NOTE: Messages should be sentences (Start with a capital letter and end with a period).
+ * Errors can optionally include a JSON context object.
+ */
+class BaseError extends Error {
+  constructor(
+    readonly code: string,
+    message?: string,
+    readonly context?: Record<string, any>,
+  ) {
+    super(message ?? code);
+    this.name = code;
+    // NOTE: Restores prototype chain (https://stackoverflow.com/a/48342359).
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+}
+
+/**
+ * User facing API Errors.
+ * E.g., something was misconfigured.
+ */
+export class ApiError extends BaseError {}
+
+/**
+ * Internal system errors.
+ * E.g., unexpected/unrecoverable runtime error.
+ */
+export class SystemError extends BaseError {}
+
+/**
+ * Database errors.
+ */
+// TODO(wittjosiah): Same as ApiError?
+export class DatabaseError extends BaseError {}
+
+/**
+ * Thrown when request was terminated because the RPC endpoint has been closed.
+ */
+export class RpcClosedError extends SystemError {
+  constructor() {
+    super('RPC_CLOSED', 'Request was terminated because the RPC endpoint is closed.');
+  }
+}
+
+/**
+ * Thrown when `request` is called when RPC has not been opened.
+ */
+export class RpcNotOpenError extends SystemError {
+  constructor() {
+    super('RPC_NOT_OPEN', 'RPC has not been opened.');
+  }
+}
+
+export class CancelledError extends SystemError {
+  constructor(message?: string, context?: Record<string, any>) {
+    super('CANCELLED', message, context);
+  }
+}
+
+export class InvalidConfigError extends ApiError {
+  constructor(message?: string, context?: Record<string, any>) {
+    super('INVALID_CONFIG', message, context);
+  }
+}
+
+/**
+ * Explicit failure to connect with remote client services.
+ */
+export class RemoteServiceConnectionError extends ApiError {
+  constructor(message?: string, context?: Record<string, any>) {
+    super('REMOTE_SERVICE_CONNECTION_ERROR', message, context);
+  }
+}
+
+/**
+ * Failed to open a connection to remote client services.
+ */
+export class RemoteServiceConnectionTimeout extends ApiError {
+  constructor(message?: string, context?: Record<string, any>) {
+    super('REMOTE_SERVICE_CONNECTION_TIMEOUT', message, context);
+  }
+}
+
+export class DataCorruptionError extends SystemError {
+  constructor(message?: string, context?: Record<string, any>) {
+    super('DATA_CORRUPTION', message, context);
+  }
+}
+
+export class InvalidInvitationExtensionRoleError extends SystemError {
+  constructor(message?: string, context?: Record<string, any>) {
+    super('INVALID_INVITATION_EXTENSION_ROLE', message, context);
+  }
+}
+
+export class IdentityNotInitializedError extends DatabaseError {
+  constructor(message?: string, context?: Record<string, any>) {
+    super('IDENTITY_NOT_INITIALIZED', message, context);
+  }
+}
+
+export class InvalidInvitationError extends DatabaseError {
+  constructor(message?: string, context?: Record<string, any>) {
+    super('INVALID_INVITATION', message, context);
+  }
+}
+
+export class ConnectionResetError extends BaseError {
+  constructor(message?: string, context?: any) {
+    super('CONNECTION_RESET', message, context);
+  }
+}
+
+export class TimeoutError extends BaseError {
+  constructor(message?: string, context?: any) {
+    super('TIMEOUT', message, context);
+  }
+}
+
+// General protocol error.
+export class ProtocolError extends BaseError {
+  constructor(message?: string, context?: any) {
+    super('PROTOCOL_ERROR', message, context);
+  }
+}
+
+// General connectivity errors.
+export class ConnectivityError extends BaseError {
+  constructor(message?: string, context?: any) {
+    super('CONNECTIVITY_ERROR', message, context);
+  }
+}
+
+// TODO(nf): Rename? the protocol isn't what's unknown...
+export class UnknownProtocolError extends BaseError {
+  constructor(message?: string, innerError?: Error) {
+    super('UNKNOWN_PROTOCOL_ERROR', message, innerError);
+  }
+}
+export class InvalidStorageVersionError extends DatabaseError {
+  constructor(expected: number, actual: number) {
+    super('INVALID_STORAGE_VERSION', 'Invalid storage version.', { expected, actual });
+  }
+}
+
+export class SpaceNotFoundError extends DatabaseError {
+  constructor(spaceKey: PublicKey) {
+    super('SPACE_NOT_FOUND', 'Space not found.', { spaceKey });
+  }
+}
+
+export class EntityNotFoundError extends DatabaseError {
+  constructor(entityId: ItemID) {
+    super('ITEM_NOT_FOUND', 'Item not found.', { entityId });
+  }
+}
+
+export class UnknownModelError extends DatabaseError {
+  constructor(model: string) {
+    super('UNKNOWN_MODEL', 'Unknown model.', { model });
+  }
+}

package/src/errors/helpers.ts

@@ -0,0 +1,113 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { invariant } from '@dxos/invariant';
+import { PublicKey } from '@dxos/keys';
+
+import {
+  CancelledError,
+  ConnectionResetError,
+  ConnectivityError,
+  DataCorruptionError,
+  EntityNotFoundError,
+  IdentityNotInitializedError,
+  InvalidConfigError,
+  InvalidInvitationError,
+  InvalidInvitationExtensionRoleError,
+  InvalidStorageVersionError,
+  ProtocolError,
+  RemoteServiceConnectionError,
+  RemoteServiceConnectionTimeout,
+  RpcClosedError,
+  RpcNotOpenError,
+  SpaceNotFoundError,
+  SystemError,
+  TimeoutError,
+  UnknownModelError,
+  UnknownProtocolError,
+} from './errors';
+import { Error as SerializedErrorProto } from '../proto/gen/dxos/error';
+
+export const reconstructError = (error: SerializedErrorProto) => {
+  const { name, message, context } = error;
+  return errorFromCode(name, message, context);
+};
+
+export const errorFromCode = (code?: string, message?: string, context?: any) => {
+  switch (code) {
+    case 'RPC_CLOSED':
+      return new RpcClosedError();
+
+    case 'RPC_NOT_OPEN':
+      return new RpcNotOpenError();
+
+    case 'CANCELLED':
+      return new CancelledError(message, context);
+
+    case 'INVALID_CONFIG':
+      return new InvalidConfigError(message, context);
+
+    case 'REMOTE_SERVICE_CONNECTION_ERROR':
+      return new RemoteServiceConnectionError(message, context);
+
+    case 'REMOTE_SERVICE_CONNECTION_TIMEOUT':
+      return new RemoteServiceConnectionTimeout(message, context);
+
+    case 'DATA_CORRUPTION':
+      return new DataCorruptionError(message, context);
+
+    case 'INVALID_INVITATION_EXTENSION_ROLE':
+      return new InvalidInvitationExtensionRoleError(message, context);
+
+    case 'CONNECTION_RESET':
+      return new ConnectionResetError(message, context);
+
+    case 'TIMEOUT':
+      return new TimeoutError(message, context);
+
+    case 'PROTOCOL_ERROR':
+      return new ProtocolError(message, context);
+
+    case 'CONNECTIVITY_ERROR':
+      return new ConnectivityError(message, context);
+
+    case 'UNKNOWN_PROTOCOL_ERROR':
+      return new UnknownProtocolError(message, context);
+
+    case 'IDENTITY_NOT_INITIALIZED':
+      return new IdentityNotInitializedError(message, context);
+
+    case 'INVALID_INVITATION':
+      return new InvalidInvitationError(message, context);
+
+    case 'INVALID_STORAGE_VERSION': {
+      const { expected, actual } = context;
+      invariant(expected);
+      invariant(actual);
+      return new InvalidStorageVersionError(expected, actual);
+    }
+
+    case 'SPACE_NOT_FOUND': {
+      const { spaceKey: key } = context;
+      const spaceKey = PublicKey.safeFrom(key);
+      invariant(spaceKey);
+      return new SpaceNotFoundError(spaceKey);
+    }
+
+    case 'ITEM_NOT_FOUND': {
+      const { entityId } = context;
+      invariant(typeof entityId === 'string');
+      return new EntityNotFoundError(entityId);
+    }
+
+    case 'UNKNOWN_MODEL': {
+      const { model } = context;
+      invariant(typeof model === 'string');
+      return new UnknownModelError(model);
+    }
+
+    default:
+      return new SystemError(code ?? 'Error', message, context);
+  }
+};

package/src/errors/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+export * from './encoding';
+export * from './errors';
+export * from './helpers';

package/src/index.ts

@@ -2,9 +2,9 @@
 // Copyright 2021 DXOS.org
 //
 
+export * from './errors';
 export * from './proto';
 export * from './storage';
 export * from './testing';
-export * from './types';
 export * from './tracing';
-export * from './errors';
+export * from './types';

package/src/proto/dxos/client/services.proto

@@ -163,6 +163,7 @@ message SpaceMember {
   enum PresenceState {
     OFFLINE = 0;
     ONLINE = 1;
+    REMOVED = 2;
   }
 
   Identity identity = 1;
@@ -301,6 +302,7 @@ message WriteCredentialsRequest {
 
 message QueryCredentialsRequest {
   dxos.keys.PublicKey space_key = 1;
+  optional bool no_tail = 2;
 }
 
 message CreateEpochRequest {

package/src/proto/dxos/config.proto

@@ -45,6 +45,9 @@ message Repo {
   optional string version = 3;
 }
 
+//
+// Unit of deployment.
+//
 message Module {
   message Build {
     optional string command = 1;
@@ -55,22 +58,23 @@ message Module {
     optional google.protobuf.Struct env = 10;
   }
 
-  optional string name = 1;   // TODO(burdon): Replace with id (or key?)
   optional string id = 8;     // TODO(burdon): Ensured FQ (e.g., 'dxos.app.xxx')
-  optional string type = 2;   // TODO(burdon): Define namespace (e.g., 'dxos:type/frame' vs. 'dxos.type.frame')
+  optional string name = 1;   // TODO(burdon): Replace with id (or key?)
+  optional string type = 2;   // TODO(burdon): Define namespace (e.g., 'dxos.org/type/frame' vs. 'dxos.type.frame')
 
   // TODO(burdon): Developer info message.
 
+  // TODO(burdon): Start at 10.
   optional string display_name = 3;
   optional string description = 4;
   repeated string tags = 5;
-  optional bytes bundle = 6;
+  optional bytes bundle = 6; // TODO(burdon): ???
 
   // TODO(burdon): Remove.
   optional bool tunnel = 7;
 
+  // TODO(burdon): Start at 100.
   repeated Module deps = 10;  // TODO(burdon): E.g., types.
-
   optional Build build = 100;
   repeated Repo repos = 101;
 
@@ -90,15 +94,15 @@ message Runtime {
         NODE = 4;
         WEBFS = 5;
 
-        // Key storage only
+        // Key storage only.
         LEVELJS = 11;
         JSONDOWN = 12;
       }
 
-      optional bool persistent = 1;               // TODO(burdon): Replace with type.
-      optional StorageDriver key_storage = 3;     // TODO(burdon): Rename key_store.
-      optional StorageDriver storage_type = 2;    // TODO(burdon): Rename data_store.
-      optional string path = 4;                   // TODO(burdon): Rename data_path.
+      optional bool persistent = 1;
+      optional StorageDriver key_store = 2;
+      optional StorageDriver data_store = 3;
+      optional string data_root = 4;
     }
 
     message Log {

package/src/proto/dxos/error.proto

@@ -12,5 +12,6 @@ option go_package = "github.com/dxos/kube/proto/def/dxos/error";
 message Error {
   optional string name = 1;
   optional string message = 2;
+  optional google.protobuf.Struct context = 4;
   optional string stack = 3;
 }

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

@@ -38,6 +38,13 @@ message SpaceGenesis {
 // Claims can be written directly to a feed or used within Credentials.
 //
 
+/**
+ * Revocation of another credential.
+ * Subject must be the credential id being revoked.
+ */
+message Revocation {
+}
+
 // TODO(burdon): Reconcile with dxos.client.SpaceMember.
 // [ASSERTION]: Agent is authorized to access Space.
 message SpaceMember {
@@ -219,7 +226,7 @@ message Credential {
   optional google.protobuf.Timestamp expiration_date = 4;
   optional bytes expiration_ref = 5;                        // Could reference blockchain or epoch number.
   Claim subject = 10;
-  Proof proof = 11;
+  optional Proof proof = 11;
 }
 
 //

package/src/proto/dxos/iframe.proto

@@ -31,10 +31,9 @@ enum ShellDisplay {
 message AppContextRequest {
   /// The display mode that shell should use
   optional ShellDisplay display = 1;
+
   /// The key of the joined space
   optional dxos.keys.PublicKey space_key = 2;
-  /// The invitation code which has become invalidated
-  optional string invalidated_invitation_code = 3;
 }
 
 /// App RPCs for the shell.
@@ -45,9 +44,11 @@ service AppService {
 enum ShellLayout {
   DEFAULT = 0;
   INITIALIZE_IDENTITY = 1;
-  DEVICE_INVITATIONS = 2;
-  SPACE_INVITATIONS = 3;
-  JOIN_SPACE = 4;
+  IDENTITY = 2;
+  SHARE_IDENTITY = 3;
+  EDIT_PROFILE = 4;
+  SPACE = 5;
+  JOIN_SPACE = 6;
 }
 
 message LayoutRequest {

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

@@ -442,7 +442,8 @@ export namespace SpaceMember {
      */
     export enum PresenceState {
         OFFLINE = 0,
-        ONLINE = 1
+        ONLINE = 1,
+        REMOVED = 2
     }
 }
 /**
@@ -678,6 +679,11 @@ export interface WriteCredentialsRequest {
  */
 export interface QueryCredentialsRequest {
     spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    noTail?: boolean;
 }
 /**
  * Defined in:

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

@@ -117,12 +117,12 @@ export interface Module {
      * Options:
      *   - proto3_optional = true
      */
-    name?: string;
+    id?: string;
     /**
      * Options:
      *   - proto3_optional = true
      */
-    id?: string;
+    name?: string;
     /**
      * Options:
      *   - proto3_optional = true
@@ -307,17 +307,17 @@ export namespace Runtime {
              * Options:
              *   - proto3_optional = true
              */
-            keyStorage?: Runtime.Client.Storage.StorageDriver;
+            keyStore?: Runtime.Client.Storage.StorageDriver;
             /**
              * Options:
              *   - proto3_optional = true
              */
-            storageType?: Runtime.Client.Storage.StorageDriver;
+            dataStore?: Runtime.Client.Storage.StorageDriver;
             /**
              * Options:
              *   - proto3_optional = true
              */
-            path?: string;
+            dataRoot?: string;
         }
         export namespace Storage {
             /**

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

@@ -70,6 +70,11 @@ export interface Error {
      *   - proto3_optional = true
      */
     message?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    context?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
     /**
      * Options:
      *   - proto3_optional = true

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

@@ -60,6 +60,15 @@ import * as google_protobuf from "../../google/protobuf";
 export interface SpaceGenesis {
     spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
 }
+/**
+ * Revocation of another credential.
+ * Subject must be the credential id being revoked.
+ *
+ * Defined in:
+ *   {@link file://./../../../dxos/halo/credentials.proto}
+ */
+export interface Revocation {
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/halo/credentials.proto}
@@ -314,7 +323,11 @@ export interface Credential {
      */
     expirationRef?: Uint8Array;
     subject: Claim;
-    proof: Proof;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    proof?: Proof;
 }
 /**
  * Defined in: