@dxos/client 2.29.2-dev.f64f2a6f → 2.30.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/client",
-  "version": "2.29.2-dev.f64f2a6f",
+  "version": "2.30.0",
   "license": "MIT",
   "author": "DXOS.org",
   "main": "dist/src/index.js",
@@ -9,32 +9,22 @@
     "dist",
     "src"
   ],
-  "scripts": {
-    "prebuild": "node -p \"'export const DXOS_VERSION = ' + JSON.stringify(require('./package.json').version) + ';'\" > src/version.ts",
-    "build": "npm run prebuild && toolchain build",
-    "build:test": "toolchain build:test",
-    "lint": "toolchain lint",
-    "test": "toolchain test"
-  },
   "dependencies": {
-    "@dxos/async": "workspace:*",
-    "@dxos/codec-protobuf": "workspace:*",
-    "@dxos/config": "workspace:*",
-    "@dxos/credentials": "workspace:*",
-    "@dxos/crypto": "workspace:*",
-    "@dxos/debug": "workspace:*",
-    "@dxos/echo-db": "workspace:*",
-    "@dxos/echo-protocol": "workspace:*",
-    "@dxos/feed-store": "workspace:*",
-    "@dxos/model-factory": "workspace:*",
-    "@dxos/network-manager": "workspace:*",
-    "@dxos/object-model": "workspace:*",
-    "@dxos/protocols": "workspace:*",
-    "@dxos/rpc": "workspace:*",
-    "@dxos/util": "workspace:*",
-    "@polkadot/keyring": "6.11.1",
-    "@polkadot/util": "6.11.1",
-    "@polkadot/util-crypto": "6.11.1",
+    "@dxos/async": "2.30.0",
+    "@dxos/codec-protobuf": "2.30.0",
+    "@dxos/config": "2.30.0",
+    "@dxos/credentials": "2.30.0",
+    "@dxos/crypto": "2.30.0",
+    "@dxos/debug": "2.30.0",
+    "@dxos/echo-db": "2.30.0",
+    "@dxos/echo-protocol": "2.30.0",
+    "@dxos/feed-store": "2.30.0",
+    "@dxos/model-factory": "2.30.0",
+    "@dxos/network-manager": "2.30.0",
+    "@dxos/object-model": "2.30.0",
+    "@dxos/protocols": "2.30.0",
+    "@dxos/rpc": "2.30.0",
+    "@dxos/util": "2.30.0",
     "abstract-leveldown": "~7.0.0",
     "assert": "^2.0.0",
     "debug": "^4.3.3",
@@ -48,9 +38,9 @@
   },
   "devDependencies": {
     "@dxos/eslint-plugin": "~1.0.27",
-    "@dxos/protocols-toolchain": "workspace:*",
-    "@dxos/random-access-multi-storage": "workspace:*",
-    "@dxos/testutils": "workspace:*",
+    "@dxos/protocols-toolchain": "2.30.0",
+    "@dxos/random-access-multi-storage": "2.30.0",
+    "@dxos/testutils": "2.30.0",
     "@types/debug": "^4.1.7",
     "@types/jest": "^26.0.7",
     "@types/level-js": "~4.0.1",
@@ -70,5 +60,13 @@
   },
   "toolchain": {
     "testingFramework": "mocha"
-  }
-}
+  },
+  "scripts": {
+    "prebuild": "node -p \"'export const DXOS_VERSION = ' + JSON.stringify(require('./package.json').version) + ';'\" > src/version.ts",
+    "build": "npm run prebuild && toolchain build",
+    "build:test": "toolchain build:test",
+    "lint": "toolchain lint",
+    "test": "toolchain test"
+  },
+  "readme": "# @dxos/client\n\n[![js-semistandard-style](https://img.shields.io/badge/code%20style-semistandard-brightgreen.svg?style=flat-square)](https://github.com/standard/semistandard)\n[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n\nDescription...\n\n## Install\n\n## Usage\n\n...\n\n## Contributing\n\nPRs accepted.\n\n## License\n\nAGPL-3.0 © DXOS\n"
+}

package/src/{client → api}/client.test.ts

@@ -17,7 +17,7 @@ import { ObjectModel } from '@dxos/object-model';
 import { createBundledRpcServer, createLinkedPorts } from '@dxos/rpc';
 import { afterTest } from '@dxos/testutils';
 
-import { clientServiceBundle } from '../interfaces';
+import { clientServiceBundle } from '../services';
 import { Client } from './client';
 
 describe('Client', () => {

package/src/{client → api}/client.ts

@@ -12,15 +12,13 @@ import { OpenProgress } from '@dxos/echo-db';
 import { ModelConstructor } from '@dxos/model-factory';
 import { RpcPort } from '@dxos/rpc';
 
-import { EchoProxy, HaloProxy } from '../api';
 import { DevtoolsHook } from '../devtools';
-import { ClientServiceProvider, ClientServices, RemoteServiceConnectionTimeout } from '../interfaces';
-import { InvalidConfigurationError } from '../interfaces/errors';
 import { Runtime } from '../proto/gen/dxos/config';
+import { ClientServiceProvider, ClientServices, ClientServiceHost, ClientServiceProxy, HaloSigner } from '../services';
 import { createWindowMessagePort, isNode } from '../util';
 import { DXOS_VERSION } from '../version';
-import { ClientServiceHost } from './service-host';
-import { ClientServiceProxy } from './service-proxy';
+import { InvalidConfigurationError, RemoteServiceConnectionTimeout } from './errors';
+import { Echo, EchoProxy, Halo, HaloProxy } from './proxies';
 
 const log = debug('dxos:client');
 
@@ -44,6 +42,11 @@ export interface ClientOptions {
    * Only used when remote=true.
    */
   rpcPort?: RpcPort;
+
+  /**
+   *
+   */
+  signer?: HaloSigner
 }
 
 /**
@@ -67,7 +70,8 @@ export class Client {
    * Creates the client object based on supplied configuration.
    * Requires initialization after creating by calling `.initialize()`.
    */
-  constructor (config: ConfigObject | Config = { version: 1 }, options: ClientOptions = {}) {
+  // TODO(burdon): Remove or factor out default config?
+  constructor (config: ConfigObject | Config = defaultConfig, options: ClientOptions = {}) {
     if (typeof config !== 'object' || config == null) {
       throw new InvalidParameterError('Invalid config.');
     }
@@ -113,7 +117,7 @@ export class Client {
   /**
    * ECHO database.
    */
-  get echo (): EchoProxy {
+  get echo (): Echo {
     assert(this._echo, 'Client not initialized.');
     return this._echo;
   }
@@ -121,17 +125,12 @@ export class Client {
   /**
    * HALO credentials.
    */
-  get halo (): HaloProxy {
+  get halo (): Halo {
     assert(this._halo, 'Client not initialized.');
     return this._halo;
   }
 
-  /**
-   * Client services that can be proxied.
-   */
-  get services (): ClientServices {
-    return this._serviceProvider.services;
-  }
+  // TODO(burdon): Expose mesh for messaging?
 
   /**
    * Returns true if client is connected to a remote services protvider.
@@ -140,6 +139,14 @@ export class Client {
     return this._serviceProvider instanceof ClientServiceProxy;
   }
 
+  /**
+   * Client services that can be proxied.
+   */
+  // TODO(burdon): Remove from API?
+  get services (): ClientServices {
+    return this._serviceProvider.services;
+  }
+
   /**
    * Initializes internal resources in an idempotent way.
    * Required before using the Client instance.
@@ -240,7 +247,7 @@ export class Client {
    * Registers a new ECHO model.
    */
   registerModel (constructor: ModelConstructor<any>): this {
-    this.echo.modelFactory.registerModel(constructor);
+    this._echo.modelFactory.registerModel(constructor);
     return this;
   }
 

package/src/api/index.ts

@@ -2,7 +2,11 @@
 // Copyright 2021 DXOS.org
 //
 
-export * from './echo-proxy';
-export * from './halo-proxy';
+export { SignRequest, SignResponse } from '../proto/gen/dxos/client';
+export { HaloSigner } from '../services';
+
+export * from './client';
+export * from './errors';
 export * from './invitations';
-export * from './party-proxy';
+export * from './proxies';
+export * from './serializer';

package/src/{client/local-client.test.ts → api/local.test.ts}

@@ -11,9 +11,7 @@ import { ConfigObject } from '@dxos/config';
 import { Client } from './client';
 
 describe('Client', () => {
-  describe('Local-only tests', () => {
-
-  });
+  describe('Local-only tests', () => {});
 
   describe('With persistent storage', () => {
     test('persistent storage', async () => {
@@ -32,11 +30,8 @@ describe('Client', () => {
       {
         const client = new Client(config);
         await client.initialize();
-
         await client.halo.createProfile({ username: 'test-user' });
-
         expect(client.halo.profile).toBeDefined();
-
         await client.destroy();
       }
 
@@ -44,7 +39,6 @@ describe('Client', () => {
         const client = new Client(config);
         await client.initialize();
         await waitForCondition(() => !!client.halo.profile);
-
         expect(client.halo.profile).toBeDefined();
         await client.destroy();
       }

package/src/api/{echo-proxy.ts → proxies/echo-proxy.ts}

@@ -13,11 +13,10 @@ import { ModelFactory } from '@dxos/model-factory';
 import { ObjectModel } from '@dxos/object-model';
 import { ComplexMap, SubscriptionGroup } from '@dxos/util';
 
-import { ClientServiceHost } from '../client/service-host';
-import { ClientServiceProvider } from '../interfaces';
+import { ClientServiceHost, ClientServiceProvider } from '../../services';
+import { Invitation, InvitationProxy } from '../invitations';
 import { HaloProxy } from './halo-proxy';
-import { Invitation, InvitationProxy } from './invitations';
-import { Party } from './party-proxy';
+import { Party, PartyProxy } from './party-proxy';
 
 export class PartyInvitation extends Invitation<Party> {
   /**
@@ -28,11 +27,24 @@ export class PartyInvitation extends Invitation<Party> {
   }
 }
 
+/**
+ * ECHO API.
+ */
+// TODO(burdon): Separate public API form implementation (move comments here).
+export interface Echo {
+  info (): { parties: number }
+  createParty (): Promise<Party>
+  cloneParty (snapshot: PartySnapshot): Promise<Party>
+  getParty (partyKey: PartyKey): Party | undefined
+  queryParties (): ResultSet<Party>
+  acceptInvitation (invitationDescriptor: InvitationDescriptor): PartyInvitation
+}
+
 /**
  * Client proxy to local/remote ECHO service.
  */
-export class EchoProxy {
-  private readonly _parties = new ComplexMap<PublicKey, Party>(key => key.toHex());
+export class EchoProxy implements Echo {
+  private readonly _parties = new ComplexMap<PublicKey, PartyProxy>(key => key.toHex());
   private readonly _partiesChanged = new Event();
   private readonly _subscriptions = new SubscriptionGroup();
   private readonly _modelFactory: ModelFactory;
@@ -41,8 +53,8 @@ export class EchoProxy {
     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,6 +67,7 @@ export class EchoProxy {
     if (this._serviceProvider instanceof ClientServiceHost) {
       return this._serviceProvider.echo.networkManager;
     }
+
     throw new Error('Network Manager not available in service proxy.');
   }
 
@@ -80,7 +93,7 @@ export class EchoProxy {
         if (!this._parties.has(party.publicKey)) {
           await this._haloProxy.profileChanged.waitForCondition(() => !!this._haloProxy.profile);
 
-          const partyProxy = new Party(this._serviceProvider, this._modelFactory, party, this._haloProxy.profile!.publicKey);
+          const partyProxy = new PartyProxy(this._serviceProvider, this._modelFactory, party, this._haloProxy.profile!.publicKey);
           await partyProxy.initialize();
           this._parties.set(partyProxy.key, partyProxy);
 
@@ -139,8 +152,10 @@ export class EchoProxy {
         partyReceived();
       }
     };
+
     this._partiesChanged.on(handler);
     handler();
+
     await partyReceivedPromise;
     this._partiesChanged.off(handler);
 
@@ -177,8 +192,11 @@ export class EchoProxy {
     return this._parties.get(partyKey);
   }
 
+  /**
+   *
+   */
   queryParties (): ResultSet<Party> {
-    return new ResultSet(this._partiesChanged, () => Array.from(this._parties.values()));
+    return new ResultSet<Party>(this._partiesChanged, () => Array.from(this._parties.values()));
   }
 
   /**

package/src/api/{halo-proxy.ts → proxies/halo-proxy.ts}

@@ -4,17 +4,47 @@
 
 import { Event } from '@dxos/async';
 import { KeyRecord } from '@dxos/credentials';
+import { PublicKey } from '@dxos/crypto';
 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';
+import { Profile, SignRequest, SignResponse } from '../../proto/gen/dxos/client';
+import { ClientServiceProvider } from '../../services';
+import { Invitation, InvitationProxy, InvitationRequest } from '../invitations';
+
+/**
+ * HALO API.
+ */
+// TODO(burdon): Separate public API form implementation (move comments here).
+export interface Halo {
+  info (): { key?: PublicKey }
+
+  get profile (): Profile | undefined
+  createProfile (options?: CreateProfileOptions): Promise<Profile>
+  recoverProfile (seedPhrase: string): Promise<Profile>
+
+  /**
+   * @deprecated
+   */
+  subscribeToProfile (callback: (profile: Profile) => void): void
+
+  queryContacts (): ResultSet<Contact>
+  createInvitation (): Promise<InvitationRequest>
+  acceptInvitation (invitationDescriptor: InvitationDescriptor): Invitation
+
+  addKeyRecord (keyRecord: KeyRecord): Promise<void>
+  sign (request: SignRequest): Promise<SignResponse>
+
+  setGlobalPreference (key: string, value: string): Promise<void>
+  getGlobalPreference (key: string): Promise<string | undefined>
+  setDevicePreference (key: string, value: string): Promise<void>
+  getDevicePreference (key: string): Promise<string | undefined>
+}
 
 /**
  * Client proxy to local/remote HALO service.
  */
-export class HaloProxy {
+export class HaloProxy implements Halo {
   private readonly _invitationProxy = new InvitationProxy();
   private readonly _subscriptions = new SubscriptionGroup();
 
@@ -49,9 +79,12 @@ export class HaloProxy {
     return this._profile;
   }
 
-  // TODO(burdon): Should be part of profile object. Or use standard Result object.
-  subscribeToProfile (cb: () => void): () => void {
-    return this.profileChanged.on(cb);
+  /**
+   * @deprecated
+   */
+  // TODO(burdon): Remove and expose event handler?
+  subscribeToProfile (callback: (profile: Profile) => void): () => void {
+    return this.profileChanged.on(() => callback(this._profile!));
   }
 
   /**
@@ -64,13 +97,6 @@ export class HaloProxy {
     return this._profile;
   }
 
-  /**
-   * Query for contacts. Contacts represent member keys across all known Parties.
-   */
-  queryContacts (): ResultSet<Contact> {
-    return new ResultSet(this._contactsChanged, () => this._contacts);
-  }
-
   /**
    * Joins an existing identity HALO from a recovery seed phrase.
    */
@@ -79,6 +105,13 @@ export class HaloProxy {
     return this._profile;
   }
 
+  /**
+   * Query for contacts. Contacts represent member keys across all known Parties.
+   */
+  queryContacts (): ResultSet<Contact> {
+    return new ResultSet(this._contactsChanged, () => this._contacts);
+  }
+
   /**
    * Creates an invitation to an existing HALO party.
    * Used to authorize another device of the same user.

package/src/api/proxies/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2021 DXOS.org
+//
+
+export * from './echo-proxy';
+export * from './halo-proxy';
+export * from './party-proxy';

package/src/api/{party-proxy.ts → proxies/party-proxy.ts}

@@ -5,28 +5,72 @@
 import { PublicKey } from '@dxos/crypto';
 import { failUndefined } from '@dxos/debug';
 import {
-  PARTY_ITEM_TYPE, PARTY_TITLE_PROPERTY, ActivationOptions, Database, Item, RemoteDatabaseBackend
+  PARTY_ITEM_TYPE,
+  PARTY_TITLE_PROPERTY,
+  ActivationOptions,
+  Database,
+  Item,
+  RemoteDatabaseBackend,
+  ResultSet,
+  PartyMember
 } from '@dxos/echo-db';
-import { PartyKey } from '@dxos/echo-protocol';
+import { PartyKey, PartySnapshot } from '@dxos/echo-protocol';
 import { ModelFactory } from '@dxos/model-factory';
 import { ObjectModel, ObjectProperties } from '@dxos/object-model';
 
-import { ClientServiceHost } from '../client/service-host';
-import { ClientServiceProxy } from '../client/service-proxy';
-import { ClientServiceProvider } from '../interfaces';
-import { Party as PartyProto } from '../proto/gen/dxos/client';
-import { streamToResultSet } from '../util';
-import { InvitationRequest, InvitationProxy } from './invitations';
+import { Party as PartyProto } from '../../proto/gen/dxos/client';
+import { ClientServiceHost, ClientServiceProvider, ClientServiceProxy } from '../../services';
+import { streamToResultSet } from '../../util';
+import { InvitationRequest, InvitationProxy } from '../invitations';
 
 export interface CreationInvitationOptions {
   inviteeKey?: PublicKey
 }
 
+/**
+ * Party API.
+ */
+// TODO(burdon): Separate public API form implementation (move comments here).
+export interface Party {
+  get key (): PublicKey
+  get isOpen (): boolean
+  get isActive (): boolean
+
+  get database (): Database
+  get select (): Database['select']
+  get reduce (): Database['reduce']
+
+  initialize (): Promise<void>
+  destroy (): Promise<void>
+
+  open (): Promise<void>
+  close (): Promise<void>
+  setActive (active: boolean, options: ActivationOptions): Promise<void>
+
+  setTitle (title: string): Promise<void>
+  getTitle (): string
+
+  get properties (): ObjectProperties
+  /**
+   * @deprecated
+   */
+  setProperty (key: string, value?: any): Promise<void>
+  /**
+   * @deprecated
+   */
+  getProperty (key: string, defaultValue?: any): any
+
+  queryMembers (): ResultSet<PartyMember>
+  createInvitation (options?: CreationInvitationOptions): Promise<InvitationRequest>
+
+  createSnapshot (): Promise<PartySnapshot>
+}
+
 /**
  * Main public Party API.
  * Proxies requests to local/remove services.
  */
-export class Party {
+export class PartyProxy implements Party {
   private readonly _database?: Database;
   private readonly _invitationProxy = new InvitationProxy();
 
@@ -65,6 +109,7 @@ export class Party {
     }
   }
 
+  // TODO(burdon): Getter require by react hook.
   get invitationProxy () {
     return this._invitationProxy;
   }
@@ -89,6 +134,20 @@ export class Party {
     return this._database;
   }
 
+  /**
+   * Returns a selection context, which can be used to traverse the object graph.
+   */
+  get select (): Database['select'] {
+    return this.database.select.bind(this.database);
+  }
+
+  /**
+   * Returns a selection context, which can be used to traverse the object graph.
+   */
+  get reduce (): Database['reduce'] {
+    return this.database.reduce.bind(this.database);
+  }
+
   /**
    * Called by EchoProxy open.
    */
@@ -111,11 +170,14 @@ export class Party {
   }
 
   async open () {
-    return this.setOpen(true);
+    await this._setOpen(true);
   }
 
-  // TODO(burdon): Requires comment.
-  async setOpen (open: boolean) {
+  async close () {
+    await this._setOpen(false);
+  }
+
+  async _setOpen (open: boolean) {
     await this._serviceProvider.services.PartyService.setPartyState({
       partyKey: this.key,
       open
@@ -142,7 +204,6 @@ export class Party {
    */
   async setTitle (title: string) {
     await this.setProperty(PARTY_TITLE_PROPERTY, title);
-    return this;
   }
 
   /**
@@ -157,7 +218,6 @@ export class Party {
    */
   async setProperty (key: string, value?: any) {
     await this.properties.set(key, value);
-    return this;
   }
 
   /**
@@ -167,20 +227,6 @@ export class Party {
     return this.properties.get(key, defaultValue);
   }
 
-  /**
-   * Returns a selection context, which can be used to traverse the object graph.
-   */
-  get select (): Database['select'] {
-    return this.database.select.bind(this.database);
-  }
-
-  /**
-   * Returns a selection context, which can be used to traverse the object graph.
-   */
-  get reduce (): Database['reduce'] {
-    return this.database.reduce.bind(this.database);
-  }
-
   /**
    * Return set of party members.
    */
@@ -208,6 +254,9 @@ export class Party {
     return this._invitationProxy.createInvitationRequest({ stream });
   }
 
+  /**
+   * Implementation method.
+   */
   createSnapshot () {
     return this._serviceProvider.services.PartyService.createSnapshot({ partyKey: this.key });
   }

package/src/{util/partySerializer.ts → api/serializer.ts}

@@ -2,12 +2,14 @@
 // Copyright 2022 DXOS.org
 //
 
-import { Party } from '../api';
-import { Client } from '../client';
-import { schema } from '../proto/gen/';
+import { Client, Party } from '../api';
+import { schema } from '../proto/gen';
 
 const partyCodec = schema.getCodecForType('dxos.echo.snapshot.PartySnapshot');
 
+/**
+ * Import/export party.
+ */
 export class PartySerializer {
   constructor (
     private readonly _client: Client
@@ -18,13 +20,7 @@ export class PartySerializer {
     return new Blob([partyCodec.encode(snapshot)]);
   }
 
-  async deserializeParty (partyToImport: File | Uint8Array) {
-    let data;
-    if (partyToImport instanceof File) {
-      data = await new Uint8Array(await partyToImport.arrayBuffer());
-    } else {
-      data = partyToImport;
-    }
+  async deserializeParty (data: Uint8Array) {
     return await this._client.echo.cloneParty(partyCodec.decode(data));
   }
 }

package/src/devtools/devtools-context.ts

@@ -9,25 +9,24 @@ import { FeedStore } from '@dxos/feed-store';
 import { ModelFactory } from '@dxos/model-factory';
 import { NetworkManager } from '@dxos/network-manager';
 
-import { Client } from '../client';
-import { ClientServiceProvider } from '../interfaces';
+import { Client } from '../api';
+import { ClientServiceProvider } from '../services';
 
 /**
  * A hook bound to window.__DXOS__.
  */
 export interface DevtoolsHook {
   // TODO(marik-d): Reduce to just exporting ClientServices.
-
-  serviceHost: ClientServiceProvider,
-  client: Client,
+  serviceHost: ClientServiceProvider
+  client: Client
 }
 
 export interface DevtoolsServiceDependencies {
-  echo: ECHO,
-  feedStore: FeedStore,
-  networkManager: NetworkManager,
-  modelFactory: ModelFactory,
-  keyring: Keyring,
   debug: any
   config: Config
+  feedStore: FeedStore
+  networkManager: NetworkManager
+  keyring: Keyring
+  echo: ECHO
+  modelFactory: ModelFactory
 }