@dxos/plugin-client 0.8.4-main.b97322e → 0.8.4-main.bcb3aa67d6

package/src/cli/commands/profile/delete.ts

@@ -0,0 +1,36 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Command from '@effect/cli/Command';
+import * as Options from '@effect/cli/Options';
+import * as FileSystem from '@effect/platform/FileSystem';
+import * as Console from 'effect/Console';
+import * as Effect from 'effect/Effect';
+import * as Option from 'effect/Option';
+
+import { CommandConfig, print } from '@dxos/cli-util';
+import { DX_CONFIG, getProfileConfigPath } from '@dxos/client-protocol';
+
+import { printProfileDeleted } from './util';
+
+export const del = Command.make(
+  'delete',
+  {
+    name: Options.text('name').pipe(Options.withDescription('Profile name'), Options.optional),
+  },
+  Effect.fnUntraced(function* ({ name }) {
+    const { json } = yield* CommandConfig;
+    const fs = yield* FileSystem.FileSystem;
+    const profileName = name.pipe(Option.getOrElse(() => 'default'));
+    const configPath = getProfileConfigPath(DX_CONFIG, profileName);
+    const pluginsPath = `${DX_CONFIG}/plugins/${profileName}.yml`;
+    yield* fs.remove(configPath).pipe(Effect.ignore);
+    yield* fs.remove(pluginsPath).pipe(Effect.ignore);
+    if (json) {
+      yield* Console.log(JSON.stringify({ name: profileName, deleted: true }, null, 2));
+    } else {
+      yield* Console.log(print(printProfileDeleted(profileName)));
+    }
+  }),
+);

package/src/cli/commands/profile/import.ts

@@ -0,0 +1,101 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Command from '@effect/cli/Command';
+import * as Options from '@effect/cli/Options';
+import * as Prompt from '@effect/cli/Prompt';
+import * as FileSystem from '@effect/platform/FileSystem';
+import * as Path from '@effect/platform/Path';
+import * as Console from 'effect/Console';
+import * as Effect from 'effect/Effect';
+import * as Option from 'effect/Option';
+
+import { CommandConfig } from '@dxos/cli-util';
+import { ConfigService } from '@dxos/config';
+import { log } from '@dxos/log';
+import type { Runtime } from '@dxos/protocols/proto/dxos/config';
+
+export const handler = Effect.fn(function* ({
+  file,
+  dataDir,
+  force,
+}: {
+  file: string;
+  dataDir: Option.Option<string>;
+  force: boolean;
+}) {
+  const dataDirValue = Option.getOrUndefined(dataDir);
+  const { json, profile } = yield* CommandConfig;
+  const fs = yield* FileSystem.FileSystem;
+  const path = yield* Path.Path;
+  const config = yield* ConfigService;
+
+  const { createLevel, createStorageObjects, importProfileData, decodeProfileArchive } = yield* Effect.promise(
+    () => import('@dxos/client-services'),
+  );
+
+  let storageConfig: Runtime.Client.Storage;
+  if (!dataDirValue) {
+    if (!force) {
+      yield* Console.log(`Will overwrite profile: ${profile}`);
+      const confirmed = yield* Prompt.confirm({
+        message: `Delete all data? (Profile: ${profile})`,
+        initial: false,
+      }).pipe(Prompt.run);
+      if (!confirmed) {
+        return;
+      }
+    }
+    storageConfig = config.values.runtime!.client!.storage!;
+  } else {
+    const fullPath = path.resolve(dataDirValue);
+    yield* Console.log(`Importing into: ${fullPath}`);
+    storageConfig = {
+      persistent: true,
+      dataRoot: fullPath,
+    };
+  }
+
+  if (yield* fs.exists(storageConfig.dataRoot!)) {
+    log.error('data directory already exists', { path: storageConfig.dataRoot! });
+    if (json) {
+      yield* Console.log(JSON.stringify({ error: 'Data directory already exists' }, null, 2));
+    } else {
+      yield* Console.log('Data directory already exists.');
+    }
+    return;
+  }
+
+  const data = yield* fs.readFile(file);
+
+  const archive = decodeProfileArchive(data);
+  yield* Console.log(`Importing archive with ${archive.storage.length} entries`);
+
+  const { storage } = createStorageObjects(storageConfig);
+  const level = yield* Effect.tryPromise({
+    try: () => createLevel(storageConfig),
+    catch: (error) => new Error(`Failed to create level: ${error}`),
+  });
+
+  yield* Console.log('Beginning profile import...');
+  yield* Effect.tryPromise({
+    try: () => importProfileData({ storage, level }, archive),
+    catch: (error) => new Error(`Failed to import profile data: ${error}`),
+  });
+  yield* Console.log('Profile import complete');
+
+  if (json) {
+    yield* Console.log(JSON.stringify({ success: true, profile, entries: archive.storage.length }, null, 2));
+  }
+});
+
+export const importCommand = Command.make(
+  'import',
+  {
+    file: Options.text('file').pipe(Options.withDescription('Archive filename.'), Options.withAlias('f')),
+    dataDir: Options.text('data-dir').pipe(Options.withDescription('Storage directory.'), Options.optional),
+    force: Options.boolean('force', { ifPresent: true }).pipe(Options.withDescription('Skip confirmation prompt.')),
+  },
+  handler,
+).pipe(Command.withDescription('Import profile.'));

package/src/cli/commands/profile/index.ts

@@ -0,0 +1,17 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Command from '@effect/cli/Command';
+
+import { create } from './create';
+import { del } from './delete';
+import { importCommand } from './import';
+import { inspect } from './inspect';
+import { list } from './list';
+import { reset } from './reset';
+
+export const profile = Command.make('profile').pipe(
+  Command.withDescription('Profile commands.'),
+  Command.withSubcommands([create, del, importCommand, inspect, list, reset]),
+);

package/src/cli/commands/profile/inspect.ts

@@ -0,0 +1,64 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Command from '@effect/cli/Command';
+import * as Options from '@effect/cli/Options';
+import * as FileSystem from '@effect/platform/FileSystem';
+import * as Console from 'effect/Console';
+import * as Effect from 'effect/Effect';
+
+import { CommandConfig, FormBuilder, print } from '@dxos/cli-util';
+import { ProfileArchiveEntryType } from '@dxos/protocols';
+import { arrayToBuffer } from '@dxos/util';
+
+export const handler = Effect.fn(function* ({ file, storage }: { file: string; storage: boolean }) {
+  const { json } = yield* CommandConfig;
+  const fs = yield* FileSystem.FileSystem;
+
+  const { decodeProfileArchive } = yield* Effect.promise(() => import('@dxos/client-services'));
+
+  const data = yield* fs.readFile(file);
+
+  const archive = decodeProfileArchive(data);
+
+  if (json) {
+    yield* Console.log(
+      JSON.stringify(
+        {
+          meta: archive.meta,
+          ...(storage ? { storage: archive.storage } : {}),
+        },
+        null,
+        2,
+      ),
+    );
+  } else {
+    const builder = FormBuilder.make({ title: 'Profile Archive' }).pipe(
+      FormBuilder.when(
+        archive.meta,
+        FormBuilder.each(Object.entries(archive.meta ?? {}), ([key, value]) => FormBuilder.set(key, String(value))),
+      ),
+      FormBuilder.build,
+    );
+    yield* Console.log(print(builder));
+
+    if (storage) {
+      yield* Console.log('\nStorage entries:\n');
+      for (const entry of archive.storage) {
+        const key =
+          typeof entry.key === 'string' ? entry.key : JSON.stringify(arrayToBuffer(entry.key).toString()).slice(1, -1);
+        yield* Console.log(`  ${ProfileArchiveEntryType[entry.type]} ${key}`);
+      }
+    }
+  }
+});
+
+export const inspect = Command.make(
+  'inspect',
+  {
+    file: Options.text('file').pipe(Options.withDescription('Archive filename.'), Options.withAlias('f')),
+    storage: Options.boolean('storage', { ifPresent: true }).pipe(Options.withDescription('List storage entries.')),
+  },
+  handler,
+).pipe(Command.withDescription('Inspect profile archive.'));

package/src/cli/commands/profile/list.ts

@@ -0,0 +1,55 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Command from '@effect/cli/Command';
+import * as FileSystem from '@effect/platform/FileSystem';
+import * as Path from '@effect/platform/Path';
+import * as Console from 'effect/Console';
+import * as Effect from 'effect/Effect';
+import * as Yaml from 'yaml';
+
+import { CommandConfig, printList } from '@dxos/cli-util';
+import { Config } from '@dxos/client';
+import { DX_CONFIG, DX_DATA, getProfilePath } from '@dxos/client-protocol';
+
+import { printProfile } from './util';
+
+export const list = Command.make(
+  'list',
+  {},
+  Effect.fnUntraced(function* () {
+    const { profile: currentProfile } = yield* CommandConfig;
+    const fs = yield* FileSystem.FileSystem;
+    const path = yield* Path.Path;
+    const profileDir = path.join(DX_CONFIG, 'profile');
+    const entries = yield* fs.readDirectory(profileDir);
+    const profileFiles = entries.filter((entry) => entry.endsWith('.yml'));
+    const profiles = yield* Effect.forEach(profileFiles, (filename) =>
+      Effect.gen(function* () {
+        const name = filename.slice(0, -4);
+        const configPath = path.join(profileDir, filename);
+        const configContent = yield* fs
+          .readFileString(configPath)
+          .pipe(Effect.catchTag('SystemError', () => Effect.succeed('{}')));
+        const configValues = Yaml.parse(configContent) ?? {};
+        const config = new Config(configValues);
+        return {
+          name,
+          isCurrent: name === currentProfile,
+          fullPath: configPath,
+          storagePath: getProfilePath(configValues?.runtime?.client?.storage?.dataRoot ?? DX_DATA, name),
+          edge: config.values.runtime?.services?.edge?.url,
+        };
+      }),
+    );
+
+    const { json } = yield* CommandConfig;
+    if (json) {
+      yield* Console.log(JSON.stringify(profiles, null, 2));
+    } else {
+      const formatted = profiles.map(printProfile);
+      yield* Console.log(printList(formatted));
+    }
+  }),
+);

package/src/cli/commands/profile/reset.ts

@@ -0,0 +1,45 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Command from '@effect/cli/Command';
+import * as Options from '@effect/cli/Options';
+import * as Prompt from '@effect/cli/Prompt';
+import * as FileSystem from '@effect/platform/FileSystem';
+import * as Console from 'effect/Console';
+import * as Effect from 'effect/Effect';
+
+import { CommandConfig, print } from '@dxos/cli-util';
+import { DX_DATA, getProfilePath } from '@dxos/client-protocol';
+import { ConfigService } from '@dxos/config';
+
+import { printProfileReset } from './util';
+
+export const reset = Command.make(
+  'reset',
+  {
+    force: Options.boolean('force', { ifPresent: true }).pipe(Options.withDescription('Skip confirmation prompt')),
+  },
+  Effect.fnUntraced(function* ({ force }) {
+    const fs = yield* FileSystem.FileSystem;
+    const config = yield* ConfigService;
+    const { json, profile } = yield* CommandConfig;
+    const path = config.values.runtime?.client?.storage?.dataRoot ?? getProfilePath(DX_DATA, profile);
+    if (!force) {
+      const confirmed = yield* Prompt.confirm({
+        message: `Are you sure you want to reset the profile (${profile})?`,
+        initial: false,
+      });
+      if (!confirmed) {
+        return;
+      }
+    }
+
+    yield* fs.remove(path, { recursive: true });
+    if (json) {
+      yield* Console.log(JSON.stringify({ profile, reset: true }, null, 2));
+    } else {
+      yield* Console.log(print(printProfileReset(profile)));
+    }
+  }),
+);

package/src/cli/commands/profile/util.ts

@@ -0,0 +1,48 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { FormBuilder } from '@dxos/cli-util';
+
+export type ProfileInfo = {
+  name: string;
+  isCurrent: boolean;
+  fullPath: string;
+  storagePath: string;
+  edge?: string;
+};
+
+/**
+ * Pretty prints profile creation result with ANSI colors.
+ */
+export const printProfileCreated = (name: string, path: string) =>
+  FormBuilder.make({ title: 'Profile created' }).pipe(
+    FormBuilder.set('name', name),
+    FormBuilder.set('path', path),
+    FormBuilder.build,
+  );
+
+/**
+ * Pretty prints profile deletion result with ANSI colors.
+ */
+export const printProfileDeleted = (name: string) =>
+  FormBuilder.make({ title: 'Profile deleted' }).pipe(FormBuilder.set('name', name), FormBuilder.build);
+
+/**
+ * Pretty prints profile reset result with ANSI colors.
+ */
+export const printProfileReset = (profile: string) =>
+  FormBuilder.make({ title: 'Profile reset' }).pipe(FormBuilder.set('profile', profile), FormBuilder.build);
+
+/**
+ * Pretty prints a profile with ANSI colors.
+ */
+export const printProfile = (profile: ProfileInfo) => {
+  const title = profile.isCurrent ? `${profile.name} (current)` : profile.name;
+  return FormBuilder.make({ title }).pipe(
+    FormBuilder.set('fullPath', profile.fullPath),
+    FormBuilder.set('storagePath', profile.storagePath),
+    FormBuilder.set('edge', profile.edge ?? '<none>'),
+    FormBuilder.build,
+  );
+};

package/src/cli/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './plugin';

package/src/cli/plugin.ts

@@ -0,0 +1,32 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { ActivationEvents, Capability, Plugin } from '@dxos/app-framework';
+import { AppActivationEvents, AppPlugin } from '@dxos/app-toolkit';
+
+import { Client, OperationHandler, SchemaDefs } from '#capabilities';
+
+import { meta } from '#meta';
+import { ClientEvents } from '#types';
+import { type ClientPluginOptions } from '#types';
+
+import { config, device, edge, halo, profile } from './commands';
+
+export const ClientPlugin = Plugin.define<ClientPluginOptions>(meta).pipe(
+  // TODO(wittjosiah): Could some of these commands make use of operations?
+  AppPlugin.addCommandModule({ commands: [config, device, edge, halo, profile] }),
+  AppPlugin.addOperationHandlerModule({ activate: OperationHandler }),
+  Plugin.addModule((options) => ({
+    id: Capability.getModuleTag(Client),
+    activatesOn: ActivationEvents.Startup,
+    activatesAfter: [ClientEvents.ClientReady],
+    activate: () => Client(options),
+  })),
+  Plugin.addModule({
+    activatesOn: ClientEvents.ClientReady,
+    activatesBefore: [AppActivationEvents.SetupSchema],
+    activate: SchemaDefs,
+  }),
+  Plugin.make,
+);

package/src/cli/testing/test-console.ts

@@ -0,0 +1,88 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { inspect } from 'node:util';
+
+import * as Console from 'effect/Console';
+import * as Context from 'effect/Context';
+import * as Effect from 'effect/Effect';
+import * as Layer from 'effect/Layer';
+
+function logToString(...args: any[]): string {
+  return args
+    .map((arg) => {
+      if (typeof arg === 'string') {
+        return arg;
+      }
+
+      return inspect(arg, { colors: false, depth: null });
+    })
+    .join(' ');
+}
+
+class TestConsoleService {
+  private _logs: Array<{ level: string; args: unknown; message: string }> = [];
+
+  readonly console: Console.Console;
+
+  constructor(console: Console.Console) {
+    const pusher =
+      (level: string) =>
+      (...args: readonly any[]) => {
+        this._logs.push({ level, args, message: logToString(...args) });
+      };
+
+    this.console = {
+      ...console,
+      log: (...args: readonly any[]) => Effect.sync(() => pusher('log')(...args)),
+    };
+  }
+
+  get logs() {
+    return [...this._logs];
+  }
+
+  clear() {
+    this._logs.length = 0;
+  }
+}
+
+// TODO(burdon): We could have a single namespace "Testing" with all test utilities.
+export namespace TestConsole {
+  export class TestConsole extends Context.Tag('TestConsole')<TestConsole, TestConsoleService>() {}
+
+  /**
+   * Extract JSON string from log arguments.
+   * Handles both array and string argument formats.
+   */
+  export const extractJsonString = (log: { args: unknown }): string => {
+    if (Array.isArray(log.args) && log.args.length > 0) {
+      return String(log.args[0]);
+    }
+    return log.args as string;
+  };
+
+  /**
+   * Parse JSON from log arguments.
+   * Handles both array and string argument formats.
+   */
+  export const parseJson = <T = unknown>(log: { args: unknown }): T => {
+    const jsonString = extractJsonString(log);
+    return JSON.parse(jsonString) as T;
+  };
+
+  const testConsole = Layer.effect(
+    TestConsole,
+    Effect.gen(function* () {
+      return new TestConsoleService(yield* Effect.console);
+    }),
+  );
+
+  const setConsole = Effect.gen(function* () {
+    const { console } = yield* TestConsole;
+    return Console.setConsole(console);
+  }).pipe(Layer.unwrapEffect);
+
+  export const layer = Layer.provideMerge(setConsole, testConsole);
+}

package/src/components/index.ts

@@ -1,10 +1,3 @@
 //
 // Copyright 2024 DXOS.org
 //
-
-export * from './DevicesContainer';
-export * from './JoinDialog';
-export * from './ProfileContainer';
-export * from './RecoveryCodeDialog';
-export * from './RecoveryCredentialsContainer';
-export * from './ResetDialog';

package/src/constants.ts

@@ -0,0 +1,9 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { meta } from '#meta';
+
+export const JOIN_DIALOG = `${meta.id}.JoinDialog`;
+export const RECOVERY_CODE_DIALOG = `${meta.id}.RecoveryCodeDialog`;
+export const RESET_DIALOG = `${meta.id}.ResetDialog`;

package/src/containers/DevicesContainer/DevicesContainer.stories.tsx

@@ -0,0 +1,52 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import * as Effect from 'effect/Effect';
+
+import { OperationPlugin, RuntimePlugin } from '@dxos/app-framework';
+import { withPluginManager } from '@dxos/app-framework/testing';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { translations as shellTranslations } from '@dxos/shell/react';
+
+import { ClientPlugin } from '../../ClientPlugin';
+import { initializeIdentity } from '#testing';
+import { translations } from '../../translations';
+
+import { DevicesContainer } from './DevicesContainer';
+
+const meta = {
+  title: 'plugins/plugin-client/containers/DevicesContainer',
+  component: DevicesContainer,
+  decorators: [
+    withTheme(),
+    withLayout({ layout: 'fullscreen' }),
+    withPluginManager({
+      plugins: [
+        ClientPlugin({
+          onClientInitialized: ({ client }) =>
+            Effect.gen(function* () {
+              yield* initializeIdentity(client);
+            }),
+        }),
+        OperationPlugin(),
+        RuntimePlugin(),
+      ],
+    }),
+  ],
+  parameters: {
+    layout: 'fullscreen',
+    translations: [...translations, ...shellTranslations],
+  },
+} satisfies Meta<typeof DevicesContainer>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {
+    createInvitationUrl: () => 'https://example.com',
+  },
+};