@dxos/client 2.28.17-dev.f9da0804 → 2.28.17

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/client",
-  "version": "2.28.17-dev.f9da0804",
+  "version": "2.28.17",
   "license": "MIT",
   "author": "DXOS.org",
   "main": "dist/src/index.js",
@@ -10,21 +10,21 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/async": "2.28.17-dev.f9da0804",
-    "@dxos/codec-protobuf": "2.28.17-dev.f9da0804",
-    "@dxos/config": "2.28.17-dev.f9da0804",
-    "@dxos/credentials": "2.28.17-dev.f9da0804",
-    "@dxos/crypto": "2.28.17-dev.f9da0804",
-    "@dxos/debug": "2.28.17-dev.f9da0804",
-    "@dxos/echo-db": "2.28.17-dev.f9da0804",
-    "@dxos/echo-protocol": "2.28.17-dev.f9da0804",
-    "@dxos/feed-store": "2.28.17-dev.f9da0804",
-    "@dxos/model-factory": "2.28.17-dev.f9da0804",
-    "@dxos/network-manager": "2.28.17-dev.f9da0804",
-    "@dxos/object-model": "2.28.17-dev.f9da0804",
-    "@dxos/protocols": "2.28.17-dev.f9da0804",
-    "@dxos/rpc": "2.28.17-dev.f9da0804",
-    "@dxos/util": "2.28.17-dev.f9da0804",
+    "@dxos/async": "2.28.17",
+    "@dxos/codec-protobuf": "2.28.17",
+    "@dxos/config": "2.28.17",
+    "@dxos/credentials": "2.28.17",
+    "@dxos/crypto": "2.28.17",
+    "@dxos/debug": "2.28.17",
+    "@dxos/echo-db": "2.28.17",
+    "@dxos/echo-protocol": "2.28.17",
+    "@dxos/feed-store": "2.28.17",
+    "@dxos/model-factory": "2.28.17",
+    "@dxos/network-manager": "2.28.17",
+    "@dxos/object-model": "2.28.17",
+    "@dxos/protocols": "2.28.17",
+    "@dxos/rpc": "2.28.17",
+    "@dxos/util": "2.28.17",
     "@polkadot/keyring": "6.11.1",
     "@polkadot/util": "6.11.1",
     "@polkadot/util-crypto": "6.11.1",
@@ -42,9 +42,9 @@
   },
   "devDependencies": {
     "@dxos/eslint-plugin": "~1.0.27",
-    "@dxos/protocols-toolchain": "2.28.16",
-    "@dxos/random-access-multi-storage": "2.28.17-dev.f9da0804",
-    "@dxos/testutils": "2.28.16",
+    "@dxos/protocols-toolchain": "2.28.17",
+    "@dxos/random-access-multi-storage": "2.28.17",
+    "@dxos/testutils": "2.28.17",
     "@types/debug": "^4.1.7",
     "@types/jest": "^26.0.7",
     "@types/level-js": "~4.0.1",

package/src/api/echo-proxy.ts

@@ -81,7 +81,7 @@ export class EchoProxy {
           await this._haloProxy.profileChanged.waitForCondition(() => !!this._haloProxy.profile);
 
           const partyProxy = new Party(this._serviceProvider, this._modelFactory, party, this._haloProxy.profile!.publicKey);
-          await partyProxy.init();
+          await partyProxy.initialize();
           this._parties.set(partyProxy.key, partyProxy);
 
           // TODO(dmaretskyi): Replace with selection API when it has update filtering.
@@ -160,8 +160,10 @@ export class EchoProxy {
         partyReceived();
       }
     };
+
     this._partiesChanged.on(handler);
     handler();
+
     await partyReceivedPromise;
     this._partiesChanged.off(handler);
 

package/src/api/party-proxy.ts

@@ -5,10 +5,11 @@
 import { PublicKey } from '@dxos/crypto';
 import { failUndefined } from '@dxos/debug';
 import {
-  PARTY_ITEM_TYPE, PARTY_TITLE_PROPERTY, ActivationOptions, Database, RemoteDatabaseBackend
+  PARTY_ITEM_TYPE, PARTY_TITLE_PROPERTY, ActivationOptions, Database, Item, RemoteDatabaseBackend
 } from '@dxos/echo-db';
 import { PartyKey } 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';
@@ -32,6 +33,7 @@ export class Party {
   private _key: PartyKey;
   private _isOpen: boolean;
   private _isActive: boolean;
+  private _item?: Item<ObjectModel>;
 
   /**
    * @internal
@@ -67,30 +69,27 @@ export class Party {
     return this._invitationProxy;
   }
 
-  async init () {
+  /**
+   * Called by EchoProxy open.
+   */
+  async initialize () {
     if (this._database && this._serviceProvider instanceof ClientServiceProxy) {
-      await this._database.init();
+      await this._database.initialize();
     }
 
-    await this._database?.waitForItem({ type: PARTY_ITEM_TYPE });
+    // Root item for properties.
+    this._item = await this._database?.waitForItem({ type: PARTY_ITEM_TYPE });
   }
 
+  /**
+   * Called by EchoProxy close.
+   */
   async destroy () {
     if (this._database && this._serviceProvider instanceof ClientServiceProxy) {
       await this._database.destroy();
     }
   }
 
-  /**
-   * Called by EchoProxy to update this party instance.
-   * @internal
-   */
-  _processPartyUpdate (party: PartyProto) {
-    this._key = party.publicKey;
-    this._isOpen = party.isOpen;
-    this._isActive = party.isActive;
-  }
-
   get key () {
     return this._key;
   }
@@ -103,12 +102,9 @@ export class Party {
     return this._isActive;
   }
 
-  /**
-   * Database instance of the current party.
-   */
   get database (): Database {
     if (!this._database) {
-      throw Error('Party not open');
+      throw Error('Party not open.');
     }
 
     return this._database;
@@ -118,6 +114,7 @@ export class Party {
     return this.setOpen(true);
   }
 
+  // TODO(burdon): Requires comment.
   async setOpen (open: boolean) {
     await this._serviceProvider.services.PartyService.setPartyState({
       partyKey: this.key,
@@ -125,6 +122,7 @@ export class Party {
     });
   }
 
+  // TODO(burdon): Requires comment.
   async setActive (active: boolean, options: ActivationOptions) {
     const activeGlobal = options.global ? active : undefined;
     const activeDevice = options.device ? active : undefined;
@@ -135,6 +133,40 @@ export class Party {
     });
   }
 
+  get properties (): ObjectProperties {
+    return this._item!.model;
+  }
+
+  /**
+   * @deprecated Use party.properties.
+   */
+  async setTitle (title: string) {
+    await this.setProperty(PARTY_TITLE_PROPERTY, title);
+    return this;
+  }
+
+  /**
+   * @deprecated Use party.properties.
+   */
+  getTitle () {
+    return this.getProperty(PARTY_TITLE_PROPERTY);
+  }
+
+  /**
+   * @deprecated Use party.properties.
+   */
+  async setProperty (key: string, value?: any) {
+    await this.properties.set(key, value);
+    return this;
+  }
+
+  /**
+   * @deprecated Use party.properties.
+   */
+  getProperty (key: string, defaultValue?: any) {
+    return this.properties.get(key, defaultValue);
+  }
+
   /**
    * Returns a selection context, which can be used to traverse the object graph.
    */
@@ -149,6 +181,17 @@ export class Party {
     return this.database.reduce.bind(this.database);
   }
 
+  /**
+   * Return set of party members.
+   */
+  // TODO(burdon): Don't expose result object and provide type.
+  queryMembers () {
+    return streamToResultSet(
+      this._serviceProvider.services.PartyService.subscribeMembers({ partyKey: this.key }),
+      (response) => response?.members ?? []
+    );
+  }
+
   /**
    * Creates an invitation to a given party.
    * The Invitation flow requires the inviter and invitee to be online at the same time.
@@ -165,36 +208,17 @@ export class Party {
     return this._invitationProxy.createInvitationRequest({ stream });
   }
 
-  queryMembers () {
-    return streamToResultSet(
-      this._serviceProvider.services.PartyService.subscribeMembers({ partyKey: this.key }),
-      (response) => response?.members ?? []
-    );
-  }
-
-  async setTitle (title: string) {
-    await this.setProperty(PARTY_TITLE_PROPERTY, title);
-    return this;
-  }
-
-  async setProperty (key: string, value?: any) {
-    await this.database.waitForItem({ type: PARTY_ITEM_TYPE });
-    const item = this.getPropertiesItem();
-    await item.model.setProperty(key, value);
-    return this;
-  }
-
-  getProperty (key: string) {
-    const item = this.getPropertiesItem();
-    return item?.model.getProperty(key);
-  }
-
-  private getPropertiesItem () {
-    const items = this.database.select({ type: PARTY_ITEM_TYPE }).query().entities;
-    return items[0];
-  }
-
   createSnapshot () {
     return this._serviceProvider.services.PartyService.createSnapshot({ partyKey: this.key });
   }
+
+  /**
+   * Called by EchoProxy to update this party instance.
+   * @internal
+   */
+  _processPartyUpdate (party: PartyProto) {
+    this._key = party.publicKey;
+    this._isOpen = party.isOpen;
+    this._isActive = party.isActive;
+  }
 }

package/src/client/client.test.ts

@@ -234,9 +234,9 @@ describe('Client', () => {
         const party = await client.echo.createParty();
 
         const item = await party.database.createItem({ model: ObjectModel });
-        await item.model.setProperty('foo', 'bar');
+        await item.model.set('foo', 'bar');
 
-        expect(item.model.getProperty('foo')).toEqual('bar');
+        expect(item.model.get('foo')).toEqual('bar');
       });
 
       test('set party properties', async () => {
@@ -261,11 +261,11 @@ describe('Client', () => {
         const party = await client.echo.createParty();
 
         const item1 = await party.database.createItem({ model: ObjectModel, type: 'test' });
-        await item1.model.setProperty('prop1', 'x');
+        await item1.model.set('prop1', 'x');
         const item2 = await party.database.createItem({ model: ObjectModel, type: 'test' });
-        await item2.model.setProperty('prop1', 'y');
+        await item2.model.set('prop1', 'y');
 
-        expect(item1.model.getProperty('prop1')).toEqual('x');
+        expect(item1.model.get('prop1')).toEqual('x');
       });
     });
   }
@@ -316,7 +316,7 @@ describe('Client', () => {
       await client.halo.createProfile({ username: 'test-user' });
       const party = await client.echo.createParty();
       const item = await party.database.createItem({ model: TestModel, type: 'test' });
-      await item.model.setProperty('prop', 'value1');
+      await item.model.set('prop', 'value1');
 
       await client.destroy();
     }
@@ -334,10 +334,10 @@ describe('Client', () => {
       await result.update.waitForCondition(() => result.entities.length > 0);
       const item = result.expectOne();
 
-      expect(item.model.getProperty('prop')).toEqual('value1');
+      expect(item.model.get('prop')).toEqual('value1');
 
-      await item.model.setProperty('prop', 'value2');
-      expect(item.model.getProperty('prop')).toEqual('value2');
+      await item.model.set('prop', 'value2');
+      expect(item.model.get('prop')).toEqual('value2');
 
       await client.destroy();
     }

package/src/version.ts

@@ -2,4 +2,4 @@
 // Copyright 2022 DXOS.org
 //
 
-export const DXOS_VERSION = '2.28.14';
+export const DXOS_VERSION = '2.28.15';