@dxos/client-protocol 0.8.4-main.84f28bd → 0.8.4-main.a4bbb77

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/client-protocol",
-  "version": "0.8.4-main.84f28bd",
+  "version": "0.8.4-main.a4bbb77",
   "description": "Core DXOS Client API.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -11,6 +11,7 @@
   "type": "module",
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
       "node": "./dist/lib/node-esm/index.mjs"
@@ -26,19 +27,19 @@
   ],
   "dependencies": {
     "base-x": "~3.0.9",
-    "effect": "3.16.13",
-    "@dxos/async": "0.8.4-main.84f28bd",
-    "@dxos/config": "0.8.4-main.84f28bd",
-    "@dxos/context": "0.8.4-main.84f28bd",
-    "@dxos/credentials": "0.8.4-main.84f28bd",
-    "@dxos/echo": "0.8.4-main.84f28bd",
-    "@dxos/echo-db": "0.8.4-main.84f28bd",
-    "@dxos/echo-schema": "0.8.4-main.84f28bd",
-    "@dxos/invariant": "0.8.4-main.84f28bd",
-    "@dxos/keys": "0.8.4-main.84f28bd",
-    "@dxos/node-std": "0.8.4-main.84f28bd",
-    "@dxos/protocols": "0.8.4-main.84f28bd",
-    "@dxos/rpc": "0.8.4-main.84f28bd"
+    "effect": "3.18.3",
+    "@dxos/config": "0.8.4-main.a4bbb77",
+    "@dxos/context": "0.8.4-main.a4bbb77",
+    "@dxos/async": "0.8.4-main.a4bbb77",
+    "@dxos/echo": "0.8.4-main.a4bbb77",
+    "@dxos/echo-db": "0.8.4-main.a4bbb77",
+    "@dxos/credentials": "0.8.4-main.a4bbb77",
+    "@dxos/echo-schema": "0.8.4-main.a4bbb77",
+    "@dxos/invariant": "0.8.4-main.a4bbb77",
+    "@dxos/node-std": "0.8.4-main.a4bbb77",
+    "@dxos/keys": "0.8.4-main.a4bbb77",
+    "@dxos/protocols": "0.8.4-main.a4bbb77",
+    "@dxos/rpc": "0.8.4-main.a4bbb77"
   },
   "peerDependencies": {
     "effect": "^3.13.3"

package/src/config.ts

@@ -18,7 +18,7 @@ export const EXPECTED_CONFIG_VERSION = 1;
 export const defaultConfig: ConfigProto = { version: 1 };
 
 // TODO(burdon): Allow override via env? Generalize since currently NodeJS only.
-const HOME = typeof process !== 'undefined' ? process?.env?.HOME ?? '' : '';
+const HOME = typeof process !== 'undefined' ? (process?.env?.HOME ?? '') : '';
 
 // Base directories.
 // TODO(burdon): Consider Windows, Linux, OSX.

package/src/echo.ts

@@ -3,7 +3,7 @@
 //
 
 import type { MulticastObservable } from '@dxos/async';
-import type { QueryFn } from '@dxos/echo-db';
+import type { Queryable } from '@dxos/echo-db';
 import type { PublicKey, SpaceId } from '@dxos/keys';
 import type { Invitation, SpaceArchive } from '@dxos/protocols/proto/dxos/client/services';
 
@@ -12,17 +12,10 @@ import type { PropertiesTypeProps } from './schema';
 import type { Space } from './space';
 
 /**
- * TODO(burdon): Public API (move comments here).
+ * Public database API.
  */
-// TODO(wittjosiah): Rename?
-//   https://ts.dev/style/#naming-style
-//   ClientApi? ClientProtocol?
-export interface Echo extends MulticastObservable<Space[]> {
-  /**
-   * Resolves when the default space is available.
-   */
-  waitUntilReady(): Promise<void>;
-
+// TODO(wittjosiah): Rename Database (not product name).
+export interface Echo extends MulticastObservable<Space[]>, Queryable {
   /**
    * Observable which indicates when the default space is available.
    */
@@ -50,6 +43,11 @@ export interface Echo extends MulticastObservable<Space[]> {
    */
   get default(): Space;
 
+  /**
+   * Resolves when the default space is available.
+   */
+  waitUntilReady(): Promise<void>;
+
   /**
    * Creates a new space.
    */
@@ -66,11 +64,4 @@ export interface Echo extends MulticastObservable<Space[]> {
   join(invitation: Invitation | string): AuthenticatingInvitation;
 
   joinBySpaceKey(spaceKey: PublicKey): Promise<Space>;
-
-  /**
-   * Query all spaces.
-   * @param filter
-   * @param options
-   */
-  query: QueryFn;
 }

package/src/halo.ts

@@ -6,8 +6,8 @@ import { type MulticastObservable } from '@dxos/async';
 import { type PublicKey } from '@dxos/keys';
 import { type Contact, type Device, type Identity, type Invitation } from '@dxos/protocols/proto/dxos/client/services';
 import {
-  type DeviceProfileDocument,
   type Credential,
+  type DeviceProfileDocument,
   type Presentation,
   type ProfileDocument,
 } from '@dxos/protocols/proto/dxos/halo/credentials';

package/src/index.ts

@@ -4,11 +4,11 @@
 
 export * from './client';
 export * from './config';
-export * from './echo';
-export * from './halo';
+export type * from './echo';
+export type * from './halo';
 export * from './invitations';
 export * from './service-definitions';
-export * from './shell';
-export * from './space';
+export type * from './shell';
+export type * from './space';
 export * from './timeouts';
 export * from './schema';

package/src/schema.ts

@@ -5,6 +5,7 @@
 import { Schema } from 'effect';
 
 import { Type } from '@dxos/echo';
+import { Queue } from '@dxos/echo-db';
 import { TypedObject } from '@dxos/echo-schema';
 
 export const TYPE_PROPERTIES = 'dxos.org/type/Properties';
@@ -19,7 +20,7 @@ export class PropertiesType extends TypedObject({
     // TODO(wittjosiah): Make generic?
     hue: Schema.optional(Schema.String),
     icon: Schema.optional(Schema.String),
-    invocationTraceQueue: Schema.optional(Type.Ref(Type.Expando)),
+    invocationTraceQueue: Schema.optional(Type.Ref(Queue)),
   },
   { record: true },
 ) {}

package/src/service-definitions.ts

@@ -6,15 +6,15 @@ import { type Event } from '@dxos/async';
 import { schema } from '@dxos/protocols/proto';
 import type { FunctionRegistryService } from '@dxos/protocols/proto/dxos/agent/functions';
 import type {
+  ContactsService,
   DevicesService,
+  EdgeAgentService,
   IdentityService,
   InvitationsService,
   LoggingService,
   NetworkService,
   SpacesService,
   SystemService,
-  ContactsService,
-  EdgeAgentService,
 } from '@dxos/protocols/proto/dxos/client/services';
 import type { DevtoolsHost } from '@dxos/protocols/proto/dxos/devtools/host';
 import type { QueryService } from '@dxos/protocols/proto/dxos/echo/query';

package/src/shell.ts

@@ -5,8 +5,8 @@
 import { type Event } from '@dxos/async';
 import { type PublicKey } from '@dxos/keys';
 import {
-  type InvitationUrlRequest,
   type AppContextRequest,
+  type InvitationUrlRequest,
   type LayoutRequest,
   type ShellLayout,
 } from '@dxos/protocols/proto/dxos/iframe';

package/src/space.ts

@@ -2,16 +2,16 @@
 // Copyright 2021 DXOS.org
 //
 
-import { type MulticastObservable, type CleanupFn } from '@dxos/async';
+import { type CleanupFn, type MulticastObservable } from '@dxos/async';
 import { type SpecificCredential } from '@dxos/credentials';
-import { type QueueFactory, type EchoDatabase, type AnyLiveObject } from '@dxos/echo-db';
+import { type AnyLiveObject, type EchoDatabase, type QueueFactory } from '@dxos/echo-db';
 import { type PublicKey, type SpaceId } from '@dxos/keys';
 import {
   type Contact,
   type CreateEpochRequest,
   type Invitation,
-  type Space as SpaceData,
   type SpaceArchive,
+  type Space as SpaceData,
   type SpaceMember,
   type SpaceState,
   type UpdateMemberRoleRequest,