@dxos/client 2.33.9-dev.002e8917 → 2.33.9-dev.227ba79d

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/client",
-  "version": "2.33.9-dev.002e8917",
+  "version": "2.33.9-dev.227ba79d",
   "license": "MIT",
   "author": "DXOS.org",
   "main": "dist/src/index.js",
@@ -14,14 +14,14 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/async": "2.33.9-dev.002e8917",
-    "@dxos/codec-protobuf": "2.33.9-dev.002e8917",
-    "@dxos/config": "2.33.9-dev.002e8917",
-    "@dxos/debug": "2.33.9-dev.002e8917",
-    "@dxos/model-factory": "2.33.9-dev.002e8917",
-    "@dxos/protocols": "2.33.9-dev.002e8917",
-    "@dxos/rpc": "2.33.9-dev.002e8917",
-    "@dxos/util": "2.33.9-dev.002e8917",
+    "@dxos/async": "2.33.9-dev.227ba79d",
+    "@dxos/codec-protobuf": "2.33.9-dev.227ba79d",
+    "@dxos/config": "2.33.9-dev.227ba79d",
+    "@dxos/debug": "2.33.9-dev.227ba79d",
+    "@dxos/model-factory": "2.33.9-dev.227ba79d",
+    "@dxos/protocols": "2.33.9-dev.227ba79d",
+    "@dxos/rpc": "2.33.9-dev.227ba79d",
+    "@dxos/util": "2.33.9-dev.227ba79d",
     "abstract-leveldown": "~7.0.0",
     "assert": "^2.0.0",
     "debug": "^4.3.3",
@@ -34,16 +34,16 @@
     "uuid": "^8.3.2"
   },
   "devDependencies": {
-    "@dxos/credentials": "2.33.9-dev.002e8917",
-    "@dxos/crypto": "2.33.9-dev.002e8917",
-    "@dxos/echo-db": "2.33.9-dev.002e8917",
-    "@dxos/echo-protocol": "2.33.9-dev.002e8917",
+    "@dxos/credentials": "2.33.9-dev.227ba79d",
+    "@dxos/crypto": "2.33.9-dev.227ba79d",
+    "@dxos/echo-db": "2.33.9-dev.227ba79d",
+    "@dxos/echo-protocol": "2.33.9-dev.227ba79d",
     "@dxos/eslint-plugin": "~1.0.34",
-    "@dxos/feed-store": "2.33.9-dev.002e8917",
-    "@dxos/network-manager": "2.33.9-dev.002e8917",
-    "@dxos/object-model": "2.33.9-dev.002e8917",
+    "@dxos/feed-store": "2.33.9-dev.227ba79d",
+    "@dxos/network-manager": "2.33.9-dev.227ba79d",
+    "@dxos/object-model": "2.33.9-dev.227ba79d",
     "@dxos/protocols-toolchain": "2.33.8",
-    "@dxos/random-access-multi-storage": "2.33.9-dev.002e8917",
+    "@dxos/random-access-multi-storage": "2.33.9-dev.227ba79d",
     "@dxos/testutils": "2.33.8",
     "@koush/wrtc": "^0.5.3",
     "@types/debug": "^4.1.7",
@@ -75,10 +75,11 @@
       "@dxos/network-manager",
       "@dxos/object-model"
     ],
+    "protoBase": "./src/packlets/proto",
     "testingFramework": "mocha"
   },
   "scripts": {
-    "prebuild": "node -p \"'export const DXOS_VERSION = ' + JSON.stringify(require('./package.json').version) + ';'\" > src/version.ts",
+    "prebuild": "node -p \"'export const DXOS_VERSION = ' + JSON.stringify(require('./package.json').version) + ';'\" > src/packlets/proxy/version.ts",
     "build": "npm run prebuild && toolchain bundle:library",
     "build:test": "toolchain build:test --bundle",
     "lint": "toolchain lint",

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

@@ -18,14 +18,15 @@ import { Timeframe } from '@dxos/protocols';
 import { createBundledRpcServer, createLinkedPorts } from '@dxos/rpc';
 import { afterTest } from '@dxos/testutils';
 
-import { clientServiceBundle } from '../services';
 import { Client } from './client';
+import { clientServiceBundle } from './packlets/api';
+import { Client as ClientProxy } from './packlets/proxy';
 
 describe('Client', () => {
   //
   // Suite is called for local and remote client configurations.
   //
-  const testSuite = (createClient: () => Promise<Client>) => {
+  const testSuite = (createClient: () => Promise<ClientProxy>) => {
     describe('initialization', () => {
       test('initialize and destroy', async () => {
         const client = await createClient();
@@ -308,7 +309,7 @@ describe('Client', () => {
       void server.open(); // This blocks until the other client connects.
       afterTest(() => server.close());
 
-      return new Client({ }, { rpcPort: proxyPort });
+      return new ClientProxy({ }, { rpcPort: proxyPort });
     });
   });
 

package/src/client.ts

@@ -0,0 +1,21 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+import debug from 'debug';
+
+import { Config, ConfigObject } from '@dxos/config';
+
+import { ClientOptions, Client as ClientProxy, defaultConfig } from './packlets/proxy';
+import { ClientServiceHost } from './packlets/services';
+
+const log = debug('dxos:client');
+
+export class Client extends ClientProxy {
+  constructor (config: ConfigObject | Config = defaultConfig, options: ClientOptions = {}) {
+    log('Creating client host.');
+    config = (config instanceof Config) ? config : new Config(config);
+    const serviceProvider = new ClientServiceHost(config, options.signer);
+    super(config, { ...options, serviceProvider });
+  }
+}

package/src/index.ts

@@ -40,9 +40,16 @@ export {
   NetworkManager
 } from '@dxos/network-manager';
 
-export * from './api';
-export * from './devtools';
-export * from './proto';
-export * from './services';
-export * from './util';
-export * from './version';
+export {
+  proto,
+  KeyRecord,
+  KeyType,
+  Profile,
+  SignRequest,
+  SignResponse
+} from './packlets/proto';
+
+export * from './packlets/api';
+export * from './packlets/devtools';
+export * from './packlets/proxy';
+export * from './packlets/services';

package/src/{services → packlets/api}/client-service.ts

@@ -6,9 +6,7 @@ import { OpenProgress } from '@dxos/echo-db';
 import { DataService, schema as schemaProtocol } from '@dxos/echo-protocol';
 import { createServiceBundle } from '@dxos/rpc';
 
-import { schema } from '../proto/gen';
-import { PartyService, ProfileService, SystemService, HaloService } from '../proto/gen/dxos/client';
-import { DevtoolsHost, TracingService } from '../proto/gen/dxos/devtools';
+import { PartyService, ProfileService, SystemService, HaloService, DevtoolsHost, TracingService, schema } from '../proto';
 
 // TODO(burdon): Change to lowercase?
 // TODO(burdon): Is there a way to mark TS (generics) so cast isn't required for result of stream?

package/src/packlets/api/echo.ts

@@ -0,0 +1,88 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+import {
+  ActivationOptions,
+  Database,
+  InvitationDescriptor,
+  PartyMember,
+  ResultSet
+} from '@dxos/echo-db';
+import { PartyKey, PartySnapshot } from '@dxos/echo-protocol';
+import { ModelConstructor } from '@dxos/model-factory';
+import { ObjectProperties } from '@dxos/object-model';
+import { PublicKey } from '@dxos/protocols';
+
+import { PartyDetails } from '../proto';
+import { Invitation, InvitationRequest } 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
+
+  // TODO(burdon): Verbs should be on same interface.
+  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
+
+  // TODO(burdon): Rename (info?)
+  getDetails(): Promise<PartyDetails>
+
+  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>
+}
+
+export class PartyInvitation extends Invitation<Party> {
+  /**
+   * Wait for the invitation flow to complete and return the target party.
+   */
+  getParty (): Promise<Party> {
+    return this.wait();
+  }
+}
+
+/**
+ * ECHO API.
+ */
+// TODO(burdon): Separate public API form implementation (move comments here).
+export interface Echo {
+  info: { parties: number }
+  registerModel (constructor: ModelConstructor<any>): void
+  createParty (): Promise<Party>
+  cloneParty (snapshot: PartySnapshot): Promise<Party>
+  getParty (partyKey: PartyKey): Party | undefined
+  queryParties (): ResultSet<Party>
+  acceptInvitation (invitationDescriptor: InvitationDescriptor): PartyInvitation
+}

package/src/packlets/api/halo.ts

@@ -0,0 +1,48 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+import { DeviceInfo, KeyRecord } from '@dxos/credentials';
+import { Contact, CreateProfileOptions, InvitationDescriptor, ResultSet } from '@dxos/echo-db';
+import { PublicKey } from '@dxos/protocols';
+
+import { Profile, SignRequest, SignResponse } from '../proto';
+import { Invitation, InvitationRequest } from './invitations';
+
+/**
+ * Signer plugin.
+ */
+export interface HaloSigner {
+  sign: (request: SignRequest, key: KeyRecord) => Promise<SignResponse>
+}
+
+/**
+ * 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>
+
+  sign (request: SignRequest): Promise<SignResponse>
+  addKeyRecord (keyRecord: KeyRecord): Promise<void>
+
+  /**
+   * @deprecated
+   */
+  subscribeToProfile (callback: (profile: Profile) => void): void
+
+  queryContacts (): ResultSet<Contact>
+  createInvitation (): Promise<InvitationRequest>
+  acceptInvitation (invitationDescriptor: InvitationDescriptor): Invitation
+
+  queryDevices (): Promise<DeviceInfo[]>
+  setDevicePreference (key: string, value: string): Promise<void>
+  getDevicePreference (key: string): Promise<string | undefined>
+
+  setGlobalPreference (key: string, value: string): Promise<void>
+  getGlobalPreference (key: string): Promise<string | undefined>
+}

package/src/packlets/api/index.ts

@@ -0,0 +1,9 @@
+//
+// Copyright 2021 DXOS.org
+//
+
+export * from './client-service';
+export * from './echo';
+export * from './errors';
+export * from './halo';
+export * from './invitations';

package/src/{api → packlets/api}/invitations/index.ts

@@ -1,7 +1,6 @@
 //
-// Copyright 2021 DXOS.org
+// Copyright 2022 DXOS.org
 //
 
-export * from './invitation-proxy';
-export * from './invitation-request';
 export * from './invitation';
+export * from './invitation-request';

package/src/{api → packlets/api}/invitations/invitation.ts

@@ -19,6 +19,7 @@ export class Invitation<T = void> {
     return this._descriptor;
   }
 
+  // TODO(burdon): Change to async API that blocks here.
   authenticate (secret: Uint8Array) {
     this._onAuthenticate(secret);
   }

package/src/{devtools → packlets/devtools}/config.ts

@@ -2,7 +2,7 @@
 // Copyright 2020 DXOS.org
 //
 
-import { GetConfigResponse } from '../proto/gen/dxos/devtools';
+import { GetConfigResponse } from '../proto';
 import { DevtoolsServiceDependencies } from './devtools-context';
 
 export const getConfig = (hook: DevtoolsServiceDependencies): GetConfigResponse => ({

package/src/{devtools → packlets/devtools}/debug-logging.ts

@@ -2,7 +2,7 @@
 // Copyright 2020 DXOS.org
 //
 
-import { EnableDebugLoggingRequest } from '../proto/gen/dxos/devtools';
+import { EnableDebugLoggingRequest } from '../proto';
 import { DevtoolsServiceDependencies } from './devtools-context';
 
 /* Note that we can not simply import the debug module here and call its enable, disable

package/src/{devtools → packlets/devtools}/devtools-context.ts

@@ -9,16 +9,6 @@ import { FeedStore } from '@dxos/feed-store';
 import { ModelFactory } from '@dxos/model-factory';
 import { NetworkManager } from '@dxos/network-manager';
 
-import { Client } from '../api';
-
-/**
- * A hook bound to window.__DXOS__.
- */
-export interface DevtoolsHook {
-  client: Client
-  openClientRpcServer: () => Promise<boolean>
-}
-
 export interface DevtoolsServiceDependencies {
   debug: any
   config: Config

package/src/{devtools → packlets/devtools}/devtools-host.ts

@@ -4,7 +4,7 @@
 
 import { Stream } from '@dxos/codec-protobuf';
 
-import { DevtoolsHost, Event as ClientAPIEvent } from '../proto/gen/dxos/devtools';
+import { DevtoolsHost, Event as ClientAPIEvent } from '../proto';
 import { getConfig } from './config';
 import { enableDebugLogging, disableDebugLogging } from './debug-logging';
 import { DevtoolsServiceDependencies } from './devtools-context';

package/src/{devtools → packlets/devtools}/feeds.ts

@@ -13,7 +13,7 @@ import {
   SubscribeToFeedsResponse,
   SubscribeToFeedBlocksRequest,
   SubscribeToFeedBlocksResponse
-} from '../proto/gen/dxos/devtools';
+} from '../proto';
 import { DevtoolsServiceDependencies } from './devtools-context';
 
 export const subscribeToFeeds = (

package/src/{devtools → packlets/devtools}/index.ts

@@ -5,4 +5,3 @@
 export * from './devtools-context';
 export * from './devtools-host';
 export * from './devtools-host-events';
-export * from './devtools-rpc-server';

package/src/{devtools → packlets/devtools}/items.ts

@@ -4,7 +4,7 @@
 
 import { Stream } from '@dxos/codec-protobuf';
 
-import { SubscribeToItemsResponse } from '../proto/gen/dxos/devtools';
+import { SubscribeToItemsResponse } from '../proto';
 import { DevtoolsServiceDependencies } from './devtools-context';
 
 const getData = (echo: DevtoolsServiceDependencies['echo']): SubscribeToItemsResponse => {

package/src/{devtools → packlets/devtools}/keys.ts

@@ -9,7 +9,7 @@ import {
   SubscribeToCredentialMessagesRequest,
   SubscribeToCredentialMessagesResponse,
   SubscribeToKeyringKeysResponse
-} from '../proto/gen/dxos/devtools';
+} from '../proto';
 import { DevtoolsServiceDependencies } from './devtools-context';
 
 export const subscribeToKeyringKeys = ({ keyring }: DevtoolsServiceDependencies) => new Stream<SubscribeToKeyringKeysResponse>(({ next }) => {

package/src/{devtools → packlets/devtools}/network.ts

@@ -13,7 +13,7 @@ import {
   SubscribeToSignalStatusResponse,
   SubscribeToSignalTraceResponse,
   SubscribeToSwarmInfoResponse
-} from '../proto/gen/dxos/devtools';
+} from '../proto';
 import { DevtoolsServiceDependencies } from './devtools-context';
 
 export const subscribeToNetworkStatus = (hook: DevtoolsServiceDependencies) => new Stream<SubscribeToSignalStatusResponse>(({ next, close }) => {

package/src/{devtools → packlets/devtools}/parties.ts

@@ -11,7 +11,7 @@ import {
   SavePartySnapshotResponse,
   SubscribeToPartiesRequest,
   SubscribeToPartiesResponse
-} from '../proto/gen/dxos/devtools';
+} from '../proto';
 import { DevtoolsServiceDependencies } from './devtools-context';
 
 export const subscribeToParties = (