@dxos/client 2.28.2-dev.8a42e72c → 2.28.2-dev.c4856dba

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/client",
-  "version": "2.28.2-dev.8a42e72c",
+  "version": "2.28.2-dev.c4856dba",
   "license": "MIT",
   "author": "DXOS.org",
   "main": "dist/src/index.js",
@@ -10,21 +10,21 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/async": "2.28.2-dev.8a42e72c",
-    "@dxos/codec-protobuf": "2.28.2-dev.8a42e72c",
-    "@dxos/config": "2.28.2-dev.8a42e72c",
-    "@dxos/credentials": "2.28.2-dev.8a42e72c",
-    "@dxos/crypto": "2.28.2-dev.8a42e72c",
-    "@dxos/debug": "2.28.2-dev.8a42e72c",
-    "@dxos/echo-db": "2.28.2-dev.8a42e72c",
-    "@dxos/echo-protocol": "2.28.2-dev.8a42e72c",
-    "@dxos/feed-store": "2.28.2-dev.8a42e72c",
-    "@dxos/model-factory": "2.28.2-dev.8a42e72c",
-    "@dxos/network-manager": "2.28.2-dev.8a42e72c",
-    "@dxos/object-model": "2.28.2-dev.8a42e72c",
-    "@dxos/protocols": "2.28.2-dev.8a42e72c",
-    "@dxos/rpc": "2.28.2-dev.8a42e72c",
-    "@dxos/util": "2.28.2-dev.8a42e72c",
+    "@dxos/async": "2.28.2-dev.c4856dba",
+    "@dxos/codec-protobuf": "2.28.2-dev.c4856dba",
+    "@dxos/config": "2.28.2-dev.c4856dba",
+    "@dxos/credentials": "2.28.2-dev.c4856dba",
+    "@dxos/crypto": "2.28.2-dev.c4856dba",
+    "@dxos/debug": "2.28.2-dev.c4856dba",
+    "@dxos/echo-db": "2.28.2-dev.c4856dba",
+    "@dxos/echo-protocol": "2.28.2-dev.c4856dba",
+    "@dxos/feed-store": "2.28.2-dev.c4856dba",
+    "@dxos/model-factory": "2.28.2-dev.c4856dba",
+    "@dxos/network-manager": "2.28.2-dev.c4856dba",
+    "@dxos/object-model": "2.28.2-dev.c4856dba",
+    "@dxos/protocols": "2.28.2-dev.c4856dba",
+    "@dxos/rpc": "2.28.2-dev.c4856dba",
+    "@dxos/util": "2.28.2-dev.c4856dba",
     "@polkadot/keyring": "6.11.1",
     "@polkadot/util": "6.11.1",
     "@polkadot/util-crypto": "6.11.1",
@@ -41,7 +41,7 @@
     "uuid": "^8.3.2"
   },
   "devDependencies": {
-    "@dxos/random-access-multi-storage": "2.28.2-dev.8a42e72c",
+    "@dxos/random-access-multi-storage": "2.28.2-dev.c4856dba",
     "@dxos/testutils": "2.28.1",
     "@dxos/toolchain-node-library": "2.28.1",
     "@types/debug": "^4.1.7",

package/src/api/echo-proxy.ts

@@ -28,17 +28,21 @@ export class PartyInvitation extends Invitation<Party> {
   }
 }
 
+/**
+ * Client proxy to local/remote ECHO service.
+ */
 export class EchoProxy {
-  private readonly _modelFactory: ModelFactory;
-  private _parties = new ComplexMap<PublicKey, Party>(key => key.toHex());
+  private readonly _parties = new ComplexMap<PublicKey, Party>(key => key.toHex());
   private readonly _partiesChanged = new Event();
   private readonly _subscriptions = new SubscriptionGroup();
+  private readonly _modelFactory: ModelFactory;
 
   constructor (
     private readonly _serviceProvider: ClientServiceProvider,
     private readonly _haloProxy: HaloProxy
   ) {
-    this._modelFactory = _serviceProvider instanceof ClientServiceHost ? _serviceProvider.echo.modelFactory : new ModelFactory();
+    this._modelFactory = _serviceProvider instanceof ClientServiceHost
+      ? _serviceProvider.echo.modelFactory : new ModelFactory();
 
     this._modelFactory.registerModel(ObjectModel); // Register object-model by default.
   }
@@ -55,11 +59,13 @@ export class EchoProxy {
   }
 
   toString () {
-    return 'EchoProxy';
+    return `EchoProxy(${JSON.stringify(this.info())})`;
   }
 
   info () {
-    return this.toString();
+    return {
+      parties: this._parties.size
+    };
   }
 
   /**
@@ -99,6 +105,7 @@ export class EchoProxy {
       }
       this._partiesChanged.emit();
     }, () => {});
+
     this._subscriptions.push(() => partiesStream.close());
 
     await gotParties;
@@ -112,7 +119,7 @@ export class EchoProxy {
       await party.destroy();
     }
 
-    this._subscriptions.unsubscribe();
+    await this._subscriptions.unsubscribe();
   }
 
   //
@@ -178,7 +185,8 @@ export class EchoProxy {
    * To be used with `party.createInvitation` on the inviter side.
    */
   acceptInvitation (invitationDescriptor: InvitationDescriptor): PartyInvitation {
-    const invitationProcessStream = this._serviceProvider.services.PartyService.acceptInvitation(invitationDescriptor.toProto());
+    const invitationProcessStream = this._serviceProvider.services.PartyService.acceptInvitation(
+      invitationDescriptor.toProto());
     const { authenticate, waitForFinish } = InvitationProxy.handleInvitationRedemption({
       stream: invitationProcessStream,
       invitationDescriptor,

package/src/api/halo-proxy.ts

@@ -4,32 +4,42 @@
 
 import { Event } from '@dxos/async';
 import { KeyRecord } from '@dxos/credentials';
-import { Contact, CreateProfileOptions, InvitationDescriptor, InvitationOptions, PartyMember, ResultSet } from '@dxos/echo-db';
+import { Contact, CreateProfileOptions, InvitationDescriptor, PartyMember, ResultSet } from '@dxos/echo-db';
 import { SubscriptionGroup } from '@dxos/util';
 
 import { ClientServiceProvider } from '../interfaces';
 import { Profile, SignRequest } from '../proto/gen/dxos/client';
 import { Invitation, InvitationProxy, InvitationRequest } from './invitations';
 
-export interface CreateInvitationOptions extends InvitationOptions {
-  onPinGenerated?: (pin: string) => void
-}
+/**
+ * Client proxy to local/remote HALO service.
+ */
+export class HaloProxy {
+  private readonly _invitationProxy = new InvitationProxy();
+  private readonly _subscriptions = new SubscriptionGroup();
 
-export class HaloProxy extends InvitationProxy {
   private _profile?: Profile;
   private _contacts: PartyMember[] = [];
 
-  public readonly profileChanged = new Event();
   private readonly _contactsChanged = new Event();
+  public readonly profileChanged = new Event();
 
-  private readonly _subscriptions = new SubscriptionGroup();
+  constructor (
+    private readonly _serviceProvider: ClientServiceProvider
+  ) {}
+
+  toString () {
+    return `HaloProxy(${JSON.stringify(this.info())})`;
+  }
 
-  constructor (private readonly _serviceProvider: ClientServiceProvider) {
-    super();
+  info () {
+    return {
+      key: this._profile?.publicKey
+    };
   }
 
-  override toString () {
-    return `HaloProxy(${this._profile?.publicKey})`;
+  get invitationProxy () {
+    return this._invitationProxy;
   }
 
   /**
@@ -87,7 +97,7 @@ export class HaloProxy extends InvitationProxy {
    */
   async createInvitation (): Promise<InvitationRequest> {
     const stream = await this._serviceProvider.services.ProfileService.createInvitation();
-    return this.createInvitationRequest({ stream });
+    return this._invitationProxy.createInvitationRequest({ stream });
   }
 
   /**

package/src/api/invitations/invitation-proxy.ts

@@ -32,7 +32,7 @@ export class InvitationProxy {
   readonly activeInvitations: InvitationRequest[] = [];
   readonly invitationsUpdate = new Event();
 
-  protected async createInvitationRequest ({ stream }: CreateInvitationRequestOpts): Promise<InvitationRequest> {
+  async createInvitationRequest ({ stream }: CreateInvitationRequestOpts): Promise<InvitationRequest> {
     return new Promise((resolve, reject) => {
       const connected = new Event();
       const finished = new Event();

package/src/api/party-proxy.ts

@@ -5,7 +5,7 @@
 import { PublicKey } from '@dxos/crypto';
 import { failUndefined } from '@dxos/debug';
 import {
-  ActivationOptions, Database, PARTY_ITEM_TYPE, PARTY_TITLE_PROPERTY, RemoteDatabaseBackend, RootSelector
+  PARTY_ITEM_TYPE, PARTY_TITLE_PROPERTY, ActivationOptions, Database, RemoteDatabaseBackend, RootSelector
 } from '@dxos/echo-db';
 import { PartyKey } from '@dxos/echo-protocol';
 import { ModelFactory } from '@dxos/model-factory';
@@ -21,8 +21,13 @@ export interface CreationInvitationOptions {
   inviteeKey?: PublicKey
 }
 
-export class Party extends InvitationProxy {
+/**
+ * Main public Party API.
+ * Proxies requests to local/remove services.
+ */
+export class Party {
   private readonly _database?: Database;
+  private readonly _invitationProxy = new InvitationProxy();
 
   private _key: PartyKey;
   private _isOpen: boolean;
@@ -37,11 +42,9 @@ export class Party extends InvitationProxy {
     party: PartyProto,
     memberKey: PublicKey
   ) {
-    super();
     this._key = party.publicKey;
     this._isOpen = party.isOpen;
     this._isActive = party.isActive;
-
     if (!party.isOpen) {
       return;
     }
@@ -60,6 +63,10 @@ export class Party extends InvitationProxy {
     }
   }
 
+  get invitationProxy () {
+    return this._invitationProxy;
+  }
+
   async init () {
     if (this._database && this._serviceProvider instanceof ClientServiceProxy) {
       await this._database.init();
@@ -142,11 +149,12 @@ export class Party extends InvitationProxy {
    *
    * To be used with `client.echo.acceptInvitation` on the invitee side.
    *
-   * @param inviteeKey Public key of the invitee. In this case no secret exchange is required, but only the specified recipient can accept the invitation.
+   * @param inviteeKey Public key of the invitee. In this case no secret exchange is required,
+   *   but only the specified recipient can accept the invitation.
    */
   async createInvitation ({ inviteeKey }: CreationInvitationOptions = {}): Promise<InvitationRequest> {
     const stream = this._serviceProvider.services.PartyService.createInvitation({ partyKey: this.key, inviteeKey });
-    return this.createInvitationRequest({ stream });
+    return this._invitationProxy.createInvitationRequest({ stream });
   }
 
   queryMembers () {
@@ -156,8 +164,9 @@ export class Party extends InvitationProxy {
     );
   }
 
-  setTitle (title: string) {
-    return this.setProperty(PARTY_TITLE_PROPERTY, title);
+  async setTitle (title: string) {
+    await this.setProperty(PARTY_TITLE_PROPERTY, title);
+    return this;
   }
 
   async setProperty (key: string, value?: any) {

package/src/client/client.ts

@@ -55,9 +55,9 @@ export class Client {
 
   private readonly _config: Config;
   private readonly _options: ClientOptions;
+
   private readonly _mode: Runtime.Client.Mode;
   private _serviceProvider!: ClientServiceProvider;
-
   private _halo!: HaloProxy;
   private _echo!: EchoProxy;
 
@@ -71,14 +71,14 @@ export class Client {
     if (typeof config !== 'object' || config == null) {
       throw new InvalidParameterError('Invalid config.');
     }
+
     this._config = (config instanceof Config) ? config : new Config(config);
+    this._options = options;
 
     if (Object.keys(this._config.values).length > 0 && this._config.values.version !== EXPECTED_CONFIG_VERSION) {
       throw new InvalidConfigurationError(`Expected config version 1, got ${this._config.values.version}.`);
     }
 
-    this._options = options;
-
     // TODO(burdon): Default error level: 'dxos:*:error'
     // TODO(burdon): config.getProperty('system.debug', process.env.DEBUG, '');
     debug.enable(this._config.values.runtime?.client?.debug ?? process.env.DEBUG ?? 'dxos:*:error');

package/src/client/service-host/service-host.ts

@@ -3,7 +3,7 @@
 //
 
 import { Config } from '@dxos/config';
-import * as debug from '@dxos/debug'; // TODO(burdon): ???
+import * as debug from '@dxos/debug'; // TODO(burdon): Why import *?
 import { ECHO, OpenProgress } from '@dxos/echo-db';
 
 import { createDevtoolsHost, DevtoolsHostEvents, DevtoolsServiceDependencies } from '../../devtools';
@@ -13,8 +13,8 @@ import { createServices } from './services';
 import { createStorageObjects } from './storage';
 
 export class ClientServiceHost implements ClientServiceProvider {
-  private readonly _echo: ECHO;
   private readonly _devtoolsEvents = new DevtoolsHostEvents();
+  private readonly _echo: ECHO;
 
   constructor (
     private readonly _config: Config