@dxos/client 2.23.1-dev.f5b1145e → 2.24.1-dev.4c2329ab

package/src/api/party-proxy.ts

@@ -13,7 +13,7 @@ import { ModelFactory } from '@dxos/model-factory';
 import { ClientServiceHost } from '../client/service-host';
 import { ClientServiceProxy } from '../client/service-proxy';
 import { ClientServiceProvider } from '../interfaces';
-import { Party } from '../proto/gen/dxos/client';
+import { Party as PartyProto } from '../proto/gen/dxos/client';
 import { streamToResultSet } from '../util';
 import { InvitationRequest, InvitationProxy } from './invitations';
 
@@ -21,17 +21,20 @@ export interface CreationInvitationOptions {
   inviteeKey?: PublicKey
 }
 
-export class PartyProxy extends InvitationProxy {
+export class Party extends InvitationProxy {
   private readonly _database?: Database;
 
   private _key: PartyKey;
   private _isOpen: boolean;
   private _isActive: boolean;
 
+  /**
+   * @internal
+   */
   constructor (
     private _serviceProvider: ClientServiceProvider,
     private _modelFactory: ModelFactory,
-    _party: Party
+    _party: PartyProto
   ) {
     super();
     this._key = _party.publicKey;
@@ -72,7 +75,7 @@ export class PartyProxy extends InvitationProxy {
    * Called by EchoProxy to update this party instance.
    * @internal
    */
-  _processPartyUpdate (party: Party) {
+  _processPartyUpdate (party: PartyProto) {
     this._key = party.publicKey;
     this._isOpen = party.isOpen;
     this._isActive = party.isActive;

package/src/client/client.test.ts

@@ -7,7 +7,7 @@ import expect from 'expect';
 import { it as test } from 'mocha';
 
 import { sleep, waitForCondition } from '@dxos/async';
-import { defs } from '@dxos/config';
+import { ConfigV1Object } from '@dxos/config';
 import { generateSeedPhrase, keyPairFromSeedPhrase } from '@dxos/crypto';
 import { throwUnhandledRejection } from '@dxos/debug';
 import { InvitationDescriptor } from '@dxos/echo-db';
@@ -61,10 +61,10 @@ describe('Client', () => {
         afterTest(() => client.destroy());
 
         await client.halo.createProfile({ username: 'test-user' });
-        expect(client.halo.hasProfile()).toBeTruthy();
+        expect(!!client.halo.profile).toBeTruthy();
 
         await expect(client.halo.createProfile({ username: 'test-user' })).rejects.toThrow();
-        expect(client.halo.hasProfile()).toBeTruthy();
+        expect(!!client.halo.profile).toBeTruthy();
       });
 
       test('Recovers a profile with a seed phrase', async () => {
@@ -87,7 +87,7 @@ describe('Client', () => {
         afterTest(() => recoveredClient.destroy());
 
         await recoveredClient.halo.recoverProfile(seedPhrase);
-        await waitForCondition(() => !!recoveredClient.halo.hasProfile(), 2000);
+        await waitForCondition(() => !!recoveredClient.halo.profile, 2000);
 
         expect(recoveredClient.halo.profile).toBeDefined();
         expect(recoveredClient.halo.profile!.publicKey).toEqual(client.halo.profile!.publicKey);
@@ -276,11 +276,14 @@ describe('Client', () => {
   });
 
   test('late-register models after refresh', async () => {
-    const config: defs.Config = {
-      system: {
-        storage: {
-          persistent: true,
-          path: `/tmp/dxos-${Date.now()}`
+    const config: ConfigV1Object = {
+      version: 1,
+      runtime: {
+        client: {
+          storage: {
+            persistent: true,
+            path: `/tmp/dxos-${Date.now()}`
+          }
         }
       }
     };
@@ -300,7 +303,7 @@ describe('Client', () => {
     {
       const client = new Client(config);
       await client.initialize();
-      await waitForCondition(() => client.halo.hasProfile());
+      await waitForCondition(() => !!client.halo.profile);
       await sleep(10); // Make sure all events were processed.
 
       client.registerModel(TestModel);

package/src/client/client.ts

@@ -6,7 +6,7 @@ import assert from 'assert';
 import debug from 'debug';
 
 import { synchronized } from '@dxos/async';
-import { Config, defs } from '@dxos/config';
+import { Config, ConfigV1Object } from '@dxos/config';
 import { InvalidParameterError, TimeoutError } from '@dxos/debug';
 import { OpenProgress, sortItemsTopologically } from '@dxos/echo-db';
 import { DatabaseSnapshot } from '@dxos/echo-protocol';
@@ -17,6 +17,7 @@ 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 { System } from '../proto/gen/dxos/config';
 import { createWindowMessagePort, isNode } from '../util';
 import { ClientServiceHost } from './service-host';
@@ -24,12 +25,17 @@ import { ClientServiceProxy } from './service-proxy';
 
 const log = debug('dxos:client');
 
-export const defaultConfig: defs.Config = {};
+const EXPECTED_CONFIG_VERSION = 1;
 
-export const defaultTestingConfig: defs.Config = {
-  services: {
-    signal: {
-      server: 'ws://localhost:4000'
+export const defaultConfig: ConfigV1Object = { version: 1 };
+
+export const defaultTestingConfig: ConfigV1Object = {
+  version: 1,
+  runtime: {
+    services: {
+      signal: {
+        server: 'ws://localhost:4000'
+      }
     }
   }
 };
@@ -63,19 +69,23 @@ export class Client {
    * Creates the client object based on supplied configuration.
    * Requires initialization after creating by calling `.initialize()`.
    */
-  constructor (config: defs.Config | Config = {}, options: ClientOptions = {}) {
+  constructor (config: ConfigV1Object | Config = { version: 1 }, options: ClientOptions = {}) {
     if (typeof config !== 'object' || config == null) {
       throw new InvalidParameterError('Invalid config.');
     }
     this._config = (config instanceof Config) ? config : new Config(config);
 
+    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.system?.debug ?? process.env.DEBUG ?? 'dxos:*:error');
+    debug.enable(this._config.values.runtime?.system?.debug ?? process.env.DEBUG ?? 'dxos:*:error');
 
-    this._mode = this._config.get('system.mode', System.Mode.AUTOMATIC)!;
+    this._mode = this._config.get('runtime.client.mode', System.Mode.AUTOMATIC)!;
     log(`mode=${System.Mode[this._mode]}`);
   }
 

package/src/client/local-client.test.ts

@@ -6,7 +6,7 @@ import expect from 'expect';
 import { it as test } from 'mocha';
 
 import { waitForCondition } from '@dxos/async';
-import { defs } from '@dxos/config';
+import { ConfigV1Object } from '@dxos/config';
 
 import { Client } from './client';
 
@@ -31,11 +31,14 @@ describe('Client', () => {
 
   describe('With persistent storage', () => {
     test('persistent storage', async () => {
-      const config: defs.Config = {
-        system: {
-          storage: {
-            persistent: true,
-            path: `/tmp/dxos-${Date.now()}`
+      const config: ConfigV1Object = {
+        version: 1,
+        runtime: {
+          client: {
+            storage: {
+              persistent: true,
+              path: `/tmp/dxos-${Date.now()}`
+            }
           }
         }
       };
@@ -54,7 +57,7 @@ describe('Client', () => {
       {
         const client = new Client(config);
         await client.initialize();
-        await waitForCondition(() => client.halo.hasProfile());
+        await waitForCondition(() => !!client.halo.profile);
 
         expect(client.halo.profile).toBeDefined();
         await client.destroy();

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

@@ -20,8 +20,8 @@ export class ClientServiceHost implements ClientServiceProvider {
     private readonly _config: Config
   ) {
     const { feedStorage, keyStorage, snapshotStorage, metadataStorage } = createStorageObjects(
-      this._config.get('system.storage', {})!,
-      this._config.get('system.enableSnapshots', false)
+      this._config.get('runtime.client.storage', {})!,
+      this._config.get('runtime.client.enableSnapshots', false)
     );
 
     this._echo = new ECHO({
@@ -30,12 +30,12 @@ export class ClientServiceHost implements ClientServiceProvider {
       snapshotStorage,
       metadataStorage,
       networkManagerOptions: {
-        signal: this._config.get('services.signal.server') ? [this._config.get('services.signal.server')!] : undefined,
-        ice: this._config.get('services.ice'),
+        signal: this._config.get('runtime.services.signal.server') ? [this._config.get('runtime.services.signal.server')!] : undefined,
+        ice: this._config.get('runtime.services.ice'),
         log: true
       },
-      snapshots: this._config.get('system.enableSnapshots', false),
-      snapshotInterval: this._config.get('system.snapshotInterval')
+      snapshots: this._config.get('runtime.client.enableSnapshots', false),
+      snapshotInterval: this._config.get('runtime.client.snapshotInterval')
     });
 
     this.services = {

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

@@ -8,8 +8,8 @@ import { v4 } from 'uuid';
 import { latch } from '@dxos/async';
 import { Stream } from '@dxos/codec-protobuf';
 import { defaultSecretValidator, generatePasscode, SecretProvider } from '@dxos/credentials';
-import { raise } from '@dxos/debug';
-import { ECHO, EchoNotOpenError, InvitationDescriptor, InvitationDescriptorType, PartyNotFoundError } from '@dxos/echo-db';
+import { InvalidStateError, raise } from '@dxos/debug';
+import { ECHO, InvitationDescriptor, InvitationDescriptorType, PartyNotFoundError } from '@dxos/echo-db';
 
 import {
   InvitationState,
@@ -50,7 +50,7 @@ class PartyService implements IPartyService {
           }
         });
       } catch (error) {
-        if (error instanceof EchoNotOpenError) {
+        if (error instanceof InvalidStateError) {
           // Do nothing.
         } else {
           throw error;
@@ -156,7 +156,7 @@ class PartyService implements IPartyService {
               next({ state: InvitationState.CONNECTED });
               return Buffer.from(secret);
             };
-            invitation = await party.createInvitation({
+            invitation = await party.invitationManager.createInvitation({
               secretProvider,
               secretValidator: defaultSecretValidator
             }, {
@@ -169,7 +169,7 @@ class PartyService implements IPartyService {
             assert(invitation.type === InvitationDescriptorType.INTERACTIVE);
             invitation.secret = Buffer.from(secret);
           } else {
-            invitation = await party.createOfflineInvitation(request.inviteeKey);
+            invitation = await party.invitationManager.createOfflineInvitation(request.inviteeKey);
           }
 
           next({ state: InvitationState.WAITING_FOR_CONNECTION, descriptor: invitation.toProto() });
@@ -256,7 +256,7 @@ class PartyService implements IPartyService {
     }
   }
 
-  CreateSnapshot (request: CreateSnaspotRequest): Promise<PartySnapshot> {
+  async CreateSnapshot (request: CreateSnaspotRequest): Promise<PartySnapshot> {
     assert(request.partyKey);
     const party = this.echo.getParty(request.partyKey) ?? raise(new PartyNotFoundError(request.partyKey));
     return party.createSnapshot();

package/src/index.ts

@@ -9,3 +9,18 @@ export * from './devtools/devtools-context';
 export * from './devtools/devtools-host-events';
 export * from './util';
 export * as proto from './proto/gen';
+
+export {
+  Entity,
+  Item,
+  Link,
+  Database,
+  Selection,
+  SelectionResult,
+  InvitationDescriptor,
+  InvitationDescriptorType,
+  OpenProgress,
+  PartyMember,
+  ResultSet,
+  PARTY_ITEM_TYPE
+} from '@dxos/echo-db';

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

@@ -15,7 +15,8 @@ export enum KeyType {
     IDENTITY = 1,
     DEVICE = 2,
     PARTY = 3,
-    FEED = 4
+    FEED = 4,
+    DXNS = 5
 }
 export interface PubKey {
     data?: Uint8Array;