@dxos/client-services 0.8.4-main.fffef41 → 0.9.0

package/package.json

@@ -1,13 +1,37 @@
 {
   "name": "@dxos/client-services",
-  "version": "0.8.4-main.fffef41",
+  "version": "0.9.0",
   "description": "DXOS client services implementation",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
-  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
+  "license": "FSL-1.1-Apache-2.0",
   "author": "DXOS.org",
-  "sideEffects": true,
+  "sideEffects": false,
   "type": "module",
+  "imports": {
+    "#locks-platform": {
+      "source": {
+        "browser": "./src/packlets/locks/browser.ts",
+        "default": "./src/packlets/locks/node.ts"
+      },
+      "types": "./dist/types/src/packlets/locks/node.d.ts",
+      "browser": "./dist/lib/browser/packlets/locks/browser.mjs",
+      "default": "./dist/lib/node-esm/packlets/locks/node.mjs"
+    },
+    "#diagnostics-broadcast": {
+      "source": {
+        "browser": "./src/packlets/diagnostics/browser-diagnostics-broadcast.ts",
+        "default": "./src/packlets/diagnostics/diagnostics-broadcast.ts"
+      },
+      "types": "./dist/types/src/packlets/diagnostics/diagnostics-broadcast.d.ts",
+      "browser": "./dist/lib/browser/packlets/diagnostics/browser-diagnostics-broadcast.mjs",
+      "default": "./dist/lib/node-esm/packlets/diagnostics/diagnostics-broadcast.mjs"
+    }
+  },
   "exports": {
     ".": {
       "source": "./src/index.ts",
@@ -22,73 +46,63 @@
       "node": "./dist/lib/node-esm/testing/index.mjs"
     }
   },
-  "browser": {
-    "jsondown": false,
-    "./src/packlets/locks/node.ts": "./src/packlets/locks/browser.ts",
-    "./src/packlets/diagnostics/diagnostics-broadcast.ts": "./src/packlets/diagnostics/browser-diagnostics-broadcast.ts",
-    "./testing.js": "./dist/lib/browser/packlets/testing/index.mjs"
-  },
   "types": "dist/types/src/index.d.ts",
-  "typesVersions": {
-    "*": {
-      "testing": [
-        "dist/types/src/testing/index.d.ts"
-      ]
-    }
-  },
   "files": [
-    "testing.d.ts",
-    "testing.js",
     "dist",
     "src"
   ],
   "dependencies": {
-    "@automerge/automerge": "3.1.2",
-    "@automerge/automerge-repo": "2.4.0",
+    "@automerge/automerge": "3.3.0-fragments.1",
+    "@automerge/automerge-repo": "2.6.0-subduction.23",
+    "@effect/experimental": "0.60.0",
+    "@effect/sql": "0.51.1",
     "@obsidize/tar-browserify": "^5.2.0",
     "cbor-x": "^1.5.4",
+    "effect": "3.21.3",
     "platform": "^1.3.6",
-    "@dxos/async": "0.8.4-main.fffef41",
-    "@dxos/client-protocol": "0.8.4-main.fffef41",
-    "@dxos/config": "0.8.4-main.fffef41",
-    "@dxos/codec-protobuf": "0.8.4-main.fffef41",
-    "@dxos/credentials": "0.8.4-main.fffef41",
-    "@dxos/crypto": "0.8.4-main.fffef41",
-    "@dxos/context": "0.8.4-main.fffef41",
-    "@dxos/debug": "0.8.4-main.fffef41",
-    "@dxos/echo": "0.8.4-main.fffef41",
-    "@dxos/echo-pipeline": "0.8.4-main.fffef41",
-    "@dxos/edge-client": "0.8.4-main.fffef41",
-    "@dxos/echo-protocol": "0.8.4-main.fffef41",
-    "@dxos/indexing": "0.8.4-main.fffef41",
-    "@dxos/invariant": "0.8.4-main.fffef41",
-    "@dxos/echo-db": "0.8.4-main.fffef41",
-    "@dxos/feed-store": "0.8.4-main.fffef41",
-    "@dxos/keyring": "0.8.4-main.fffef41",
-    "@dxos/keys": "0.8.4-main.fffef41",
-    "@dxos/kv-store": "0.8.4-main.fffef41",
-    "@dxos/lock-file": "0.8.4-main.fffef41",
-    "@dxos/messaging": "0.8.4-main.fffef41",
-    "@dxos/log": "0.8.4-main.fffef41",
-    "@dxos/network-manager": "0.8.4-main.fffef41",
-    "@dxos/protocols": "0.8.4-main.fffef41",
-    "@dxos/random-access-storage": "0.8.4-main.fffef41",
-    "@dxos/rpc": "0.8.4-main.fffef41",
-    "@dxos/node-std": "0.8.4-main.fffef41",
-    "@dxos/teleport": "0.8.4-main.fffef41",
-    "@dxos/teleport-extension-gossip": "0.8.4-main.fffef41",
-    "@dxos/teleport-extension-object-sync": "0.8.4-main.fffef41",
-    "@dxos/tracing": "0.8.4-main.fffef41",
-    "@dxos/util": "0.8.4-main.fffef41",
-    "@dxos/websocket-rpc": "0.8.4-main.fffef41",
-    "@dxos/timeframe": "0.8.4-main.fffef41"
+    "@dxos/async": "0.9.0",
+    "@dxos/codec-protobuf": "0.9.0",
+    "@dxos/client-protocol": "0.9.0",
+    "@dxos/credentials": "0.9.0",
+    "@dxos/config": "0.9.0",
+    "@dxos/crypto": "0.9.0",
+    "@dxos/context": "0.9.0",
+    "@dxos/echo": "0.9.0",
+    "@dxos/debug": "0.9.0",
+    "@dxos/echo-client": "0.9.0",
+    "@dxos/edge-client": "0.9.0",
+    "@dxos/echo-protocol": "0.9.0",
+    "@dxos/feed": "0.9.0",
+    "@dxos/feed-store": "0.9.0",
+    "@dxos/invariant": "0.9.0",
+    "@dxos/keyring": "0.9.0",
+    "@dxos/kv-store": "0.9.0",
+    "@dxos/keys": "0.9.0",
+    "@dxos/lock-file": "0.9.0",
+    "@dxos/effect": "0.9.0",
+    "@dxos/log": "0.9.0",
+    "@dxos/messaging": "0.9.0",
+    "@dxos/echo-host": "0.9.0",
+    "@dxos/protocols": "0.9.0",
+    "@dxos/network-manager": "0.9.0",
+    "@dxos/random-access-storage": "0.9.0",
+    "@dxos/node-std": "0.9.0",
+    "@dxos/rpc": "0.9.0",
+    "@dxos/sql-sqlite": "0.9.0",
+    "@dxos/teleport-extension-gossip": "0.9.0",
+    "@dxos/teleport": "0.9.0",
+    "@dxos/timeframe": "0.9.0",
+    "@dxos/tracing": "0.9.0",
+    "@dxos/websocket-rpc": "0.9.0",
+    "@dxos/teleport-extension-object-sync": "0.9.0",
+    "@dxos/util": "0.9.0"
   },
   "devDependencies": {
     "@types/platform": "^1.3.4",
     "@types/readable-stream": "^2.3.9",
     "get-port-please": "^3.1.1",
-    "@dxos/signal": "0.8.4-main.fffef41",
-    "@dxos/test-utils": "0.8.4-main.fffef41"
+    "@dxos/signal": "0.9.0",
+    "@dxos/test-utils": "0.9.0"
   },
   "publishConfig": {
     "access": "public"
@@ -98,7 +112,7 @@
       {
         "root": "src/packlets/services/service-host.ts",
         "dependencies": [
-          "@dxos/echo-db"
+          "@dxos/echo-client"
         ]
       }
     ]

package/src/index.ts

@@ -8,6 +8,7 @@ export * from './packlets/identity';
 export * from './packlets/invitations';
 export * from './packlets/locks';
 export * from './packlets/services';
+export * from './packlets/space-export';
 export * from './packlets/spaces';
 export * from './packlets/storage';
 export * from './packlets/worker';

package/src/packlets/agents/edge-agent-manager.ts

@@ -3,6 +3,7 @@
 //
 
 import { DeferredTask, Event, scheduleTask, synchronized } from '@dxos/async';
+import { Context } from '@dxos/context';
 import { Resource } from '@dxos/context';
 import { type EdgeHttpClient } from '@dxos/edge-client';
 import { invariant } from '@dxos/invariant';
@@ -50,12 +51,12 @@ export class EdgeAgentManager extends Resource {
   }
 
   @synchronized
-  public async createAgent(): Promise<void> {
+  public async createAgent(ctx: Context): Promise<void> {
     invariant(this.isOpen);
     invariant(this._edgeHttpClient);
     invariant(this._edgeFeatures?.agents);
 
-    const response = await this._edgeHttpClient.createAgent({
+    const response = await this._edgeHttpClient.createAgent(ctx, {
       identityKey: this._identity.identityKey.toHex(),
       haloSpaceId: this._identity.haloSpaceId,
       haloSpaceKey: this._identity.haloSpaceKey.toHex(),
@@ -92,7 +93,7 @@ export class EdgeAgentManager extends Resource {
 
     this._lastKnownDeviceCount = this._identity.authorizedDeviceKeys.size;
     this._fetchAgentStatusTask = new DeferredTask(this._ctx, async () => {
-      await this._fetchAgentStatus();
+      await this._fetchAgentStatus(this._ctx);
     });
     this._fetchAgentStatusTask.schedule();
 
@@ -117,11 +118,13 @@ export class EdgeAgentManager extends Resource {
     this._lastKnownDeviceCount = 0;
   }
 
-  protected async _fetchAgentStatus(): Promise<void> {
+  protected async _fetchAgentStatus(ctx: Context): Promise<void> {
     invariant(this._edgeHttpClient);
     try {
       log('fetching agent status');
-      const { agent } = await this._edgeHttpClient.getAgentStatus({ ownerIdentityKey: this._identity.identityKey });
+      const { agent } = await this._edgeHttpClient.getAgentStatus(ctx, {
+        ownerIdentityKey: this._identity.identityKey,
+      });
       const wasAgentCreatedDuringQuery = this._agentStatus === EdgeAgentStatus.ACTIVE;
       if (!wasAgentCreatedDuringQuery) {
         const deviceKey = agent.deviceKey ? PublicKey.fromHex(agent.deviceKey) : undefined;

package/src/packlets/agents/edge-agent-service.ts

@@ -2,7 +2,9 @@
 // Copyright 2024 DXOS.org
 //
 
+import { type RequestOptions } from '@dxos/codec-protobuf';
 import { Stream } from '@dxos/codec-protobuf/stream';
+import { Context } from '@dxos/context';
 import { type EdgeConnection } from '@dxos/edge-client';
 import { EdgeAgentStatus } from '@dxos/protocols';
 import {
@@ -43,8 +45,8 @@ export class EdgeAgentServiceImpl implements EdgeAgentService {
     });
   }
 
-  async createAgent(): Promise<void> {
-    return (await this._agentManagerProvider()).createAgent();
+  async createAgent(_request: void, options?: RequestOptions): Promise<void> {
+    return (await this._agentManagerProvider()).createAgent(options?.ctx ?? Context.default());
   }
 
   queryAgentStatus(): Stream<QueryAgentStatusResponse> {

package/src/packlets/devices/devices-service.test.ts

@@ -11,7 +11,6 @@ import { type Device, type DevicesService } from '@dxos/protocols/proto/dxos/cli
 
 import { type ServiceContext } from '../services';
 import { createServiceContext } from '../testing';
-
 import { DevicesServiceImpl } from './devices-service';
 
 describe('DevicesService', () => {

package/src/packlets/devtools/devtools.ts

@@ -11,6 +11,7 @@ import {
   type EnableDebugLoggingRequest,
   type EnableDebugLoggingResponse,
   type Event,
+  type ExportSqliteDatabaseResponse,
   type GetBlobsResponse,
   type GetConfigResponse,
   type GetNetworkPeersRequest,
@@ -19,6 +20,8 @@ import {
   type GetSpaceSnapshotRequest,
   type GetSpaceSnapshotResponse,
   type ResetStorageRequest,
+  type RunSqliteQueryRequest,
+  type RunSqliteQueryResponse,
   type SaveSpaceSnapshotRequest,
   type SaveSpaceSnapshotResponse,
   type SignalResponse,
@@ -42,7 +45,6 @@ import {
 } from '@dxos/protocols/proto/dxos/devtools/host';
 
 import { type ServiceContext } from '../services';
-
 import { subscribeToFeedBlocks, subscribeToFeeds } from './feeds';
 import { subscribeToKeyringKeys } from './keys';
 import { subscribeToMetadata } from './metadata';
@@ -53,17 +55,19 @@ export class DevtoolsHostEvents {
   readonly ready = new AsyncEvent();
 }
 
-export type DevtoolsServiceParams = {
+export type DevtoolsServiceProps = {
   events: DevtoolsHostEvents;
   config: Config;
   context: ServiceContext;
+  exportSqliteDatabase: () => Promise<Uint8Array>;
+  runSqliteQuery: (query: string, params?: unknown[]) => Promise<readonly Record<string, unknown>[]>;
 };
 
 /**
  * @deprecated
  */
 export class DevtoolsServiceImpl implements DevtoolsHost {
-  constructor(private readonly params: DevtoolsServiceParams) {}
+  constructor(private readonly params: DevtoolsServiceProps) {}
 
   events(_request: void): Stream<Event> {
     return new Stream<Event>(({ next }) => {
@@ -78,13 +82,11 @@ export class DevtoolsServiceImpl implements DevtoolsHost {
   }
 
   async getStorageInfo(): Promise<StorageInfo> {
-    const storageUsage = (await this.params.context.storage.getDiskInfo?.()) ?? { used: 0 };
-
     const navigatorInfo = typeof navigator === 'object' ? await navigator.storage.estimate() : undefined;
 
     return {
-      type: this.params.context.storage.type,
-      storageUsage: storageUsage.used,
+      type: 'sqlite',
+      storageUsage: navigatorInfo?.usage ?? 0,
       originUsage: navigatorInfo?.usage ?? 0,
       usageQuota: navigatorInfo?.quota ?? 0,
     };
@@ -175,4 +177,23 @@ export class DevtoolsServiceImpl implements DevtoolsHost {
   subscribeToMetadata(): Stream<SubscribeToMetadataResponse> {
     return subscribeToMetadata({ context: this.params.context });
   }
+
+  async exportSqliteDatabase(): Promise<ExportSqliteDatabaseResponse> {
+    return {
+      data: await this.params.exportSqliteDatabase(),
+    };
+  }
+
+  async runSqliteQuery(request: RunSqliteQueryRequest): Promise<RunSqliteQueryResponse> {
+    try {
+      const parsedParams = request.params ? JSON.parse(request.params) : undefined;
+      if (parsedParams !== undefined && !Array.isArray(parsedParams)) {
+        throw new Error('Query params must be a JSON array.');
+      }
+      const rows = await this.params.runSqliteQuery(request.query, parsedParams);
+      return { rows: JSON.stringify(rows) };
+    } catch (err) {
+      return { rows: '[]', error: err instanceof Error ? err.message : String(err) };
+    }
+  }
 }

package/src/packlets/devtools/feeds.ts

@@ -4,7 +4,7 @@
 
 import { SubscriptionList } from '@dxos/async';
 import { Stream } from '@dxos/codec-protobuf/stream';
-import { type SpaceManager } from '@dxos/echo-pipeline';
+import { type SpaceManager } from '@dxos/echo-host';
 import { FeedIterator, type FeedStore, type FeedWrapper } from '@dxos/feed-store';
 import { PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';

package/src/packlets/devtools/keys.ts

@@ -4,10 +4,10 @@
 
 import { scheduleTask } from '@dxos/async';
 import { Stream } from '@dxos/codec-protobuf/stream';
-import { type Keyring } from '@dxos/keyring';
+import { type KeyringApi } from '@dxos/keyring';
 import { type SubscribeToKeyringKeysResponse } from '@dxos/protocols/proto/dxos/devtools/host';
 
-export const subscribeToKeyringKeys = ({ keyring }: { keyring: Keyring }) =>
+export const subscribeToKeyringKeys = ({ keyring }: { keyring: KeyringApi }) =>
   new Stream<SubscribeToKeyringKeysResponse>(({ next, ctx }) => {
     const update = async () => {
       next({

package/src/packlets/devtools/spaces.ts

@@ -3,7 +3,7 @@
 //
 
 import { Stream } from '@dxos/codec-protobuf/stream';
-import { type Space } from '@dxos/echo-pipeline';
+import { type Space } from '@dxos/echo-host';
 import {
   type SubscribeToSpacesRequest,
   type SubscribeToSpacesResponse,

package/src/packlets/diagnostics/diagnostics.ts

@@ -23,7 +23,7 @@ import {
 import { type SubscribeToFeedsResponse } from '@dxos/protocols/proto/dxos/devtools/host';
 import { type SwarmInfo } from '@dxos/protocols/proto/dxos/devtools/swarm';
 import { type Epoch } from '@dxos/protocols/proto/dxos/halo/credentials';
-import { type Resource, type Span } from '@dxos/protocols/proto/dxos/tracing';
+import { type Resource } from '@dxos/protocols/proto/dxos/tracing';
 import { TRACE_PROCESSOR } from '@dxos/tracing';
 
 import { DXOS_VERSION } from '../../version';
@@ -62,7 +62,6 @@ export type Diagnostics = {
 
 export type TraceDiagnostic = {
   resources: Record<string, Resource>;
-  spans: Span[];
   logs: LogEntry[];
 };
 

package/src/packlets/diagnostics/index.ts

@@ -4,4 +4,4 @@
 
 export * from './diagnostics';
 export * from './diagnostics-collector';
-export * from './diagnostics-broadcast';
+export * from '#diagnostics-broadcast';

package/src/packlets/identity/authenticator.ts

@@ -5,7 +5,7 @@
 import { type Event, Trigger } from '@dxos/async';
 import { Context } from '@dxos/context';
 import { type CredentialSigner, verifyCredential } from '@dxos/credentials';
-import { type AuthProvider, type AuthVerifier } from '@dxos/echo-pipeline';
+import { type AuthProvider, type AuthVerifier } from '@dxos/echo-host';
 import { type PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
 import { schema } from '@dxos/protocols/proto';
@@ -27,7 +27,7 @@ export const createAuthProvider =
     return Credential.encode(credential);
   };
 
-export type TrustedKeySetAuthVerifierParams = {
+export type TrustedKeySetAuthVerifierProps = {
   // TODO(dmaretskyi): Change to `isTrusted: (key) => bool`.
   trustedKeysProvider: () => ComplexSet<PublicKey>;
   update: Event<void>;
@@ -44,7 +44,7 @@ export type TrustedKeySetAuthVerifierParams = {
 export class TrustedKeySetAuthVerifier {
   private _ctx = new Context();
 
-  constructor(private readonly _params: TrustedKeySetAuthVerifierParams) {}
+  constructor(private readonly _params: TrustedKeySetAuthVerifierProps) {}
 
   async close(): Promise<void> {
     await this._ctx.dispose();

package/src/packlets/identity/contacts-service.ts

@@ -5,13 +5,12 @@
 import { SubscriptionList, UpdateScheduler, scheduleTask } from '@dxos/async';
 import { Stream } from '@dxos/codec-protobuf/stream';
 import { type MemberInfo } from '@dxos/credentials';
-import { type SpaceManager } from '@dxos/echo-pipeline';
+import { type SpaceManager } from '@dxos/echo-host';
 import { PublicKey } from '@dxos/keys';
 import { type Contact, type ContactBook, type ContactsService } from '@dxos/protocols/proto/dxos/client/services';
 import { ComplexMap, ComplexSet } from '@dxos/util';
 
 import { type DataSpaceManager } from '../spaces';
-
 import { type IdentityManager } from './identity-manager';
 
 export class ContactsServiceImpl implements ContactsService {

package/src/packlets/identity/identity-manager.test.ts

@@ -5,7 +5,7 @@
 import { describe, expect, onTestFinished, test } from 'vitest';
 
 import { Context } from '@dxos/context';
-import { AuthStatus, MetadataStore, SpaceManager, valueEncoding } from '@dxos/echo-pipeline';
+import { AuthStatus, MetadataStore, SpaceManager, valueEncoding } from '@dxos/echo-host';
 import { FeedFactory, FeedStore } from '@dxos/feed-store';
 import { Keyring } from '@dxos/keyring';
 import { MemorySignalManager, MemorySignalManagerContext } from '@dxos/messaging';
@@ -64,7 +64,7 @@ describe('identity/identity-manager', () => {
   test('creates identity', async () => {
     const { identityManager } = await setupPeer();
     await identityManager.open(new Context());
-    onTestFinished(() => identityManager.close());
+    onTestFinished(() => identityManager.close(Context.default()));
 
     const identity = await identityManager.createIdentity();
     expect(identity).to.exist;
@@ -77,7 +77,7 @@ describe('identity/identity-manager', () => {
     await peer1.metadataStore.load();
     await peer1.identityManager.open(new Context());
     const identity1 = await peer1.identityManager.createIdentity();
-    await peer1.identityManager.close();
+    await peer1.identityManager.close(Context.default());
     await peer1.feedStore.close();
     await peer1.metadataStore.close();
 
@@ -95,7 +95,7 @@ describe('identity/identity-manager', () => {
   test('update profile', async () => {
     const { identityManager } = await setupPeer();
     await identityManager.open(new Context());
-    onTestFinished(() => identityManager.close());
+    onTestFinished(() => identityManager.close(Context.default()));
 
     const identity = await identityManager.createIdentity();
     expect(identity.profileDocument?.displayName).to.be.undefined;
@@ -112,7 +112,7 @@ describe('identity/identity-manager', () => {
       peerKey: identity1.deviceKey.toHex(),
       identityKey: identity1.identityKey.toHex(),
     });
-    await identity1.joinNetwork();
+    await identity1.joinNetwork(Context.default());
 
     const peer2 = await setupPeer({ signalContext });
 
@@ -148,7 +148,7 @@ describe('identity/identity-manager', () => {
       peerKey: identity2.deviceKey.toHex(),
       identityKey: identity2.identityKey.toHex(),
     });
-    await identity2.joinNetwork();
+    await identity2.joinNetwork(Context.default());
 
     // Identity2 is not yet ready at this point. Peer1 needs to admit peer2 device key and feed keys.
     await peer2.identityManager.acceptIdentity(identity2, identityRecord);