@dxos/plugin-settings 0.6.14-main.7bd9c89 → 0.8.4-main.1c7ec43d41

package/package.json

@@ -1,62 +1,72 @@
 {
   "name": "@dxos/plugin-settings",
-  "version": "0.6.14-main.7bd9c89",
-  "description": "DXOS app plugin for aggregating and rendering plugin settings.",
+  "version": "0.8.4-main.1c7ec43d41",
+  "description": "DXOS Settings plugin for managing application settings.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
   "license": "MIT",
   "author": "DXOS.org",
+  "sideEffects": true,
+  "type": "module",
+  "imports": {
+    "#plugin": "./src/SettingsPlugin.ts",
+    "#capabilities": "./src/capabilities/index.ts",
+    "#meta": "./src/meta.ts",
+    "#operations": "./src/operations/index.ts",
+    "#translations": "./src/translations.ts",
+    "#types": "./src/types/index.ts"
+  },
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "browser": "./dist/lib/browser/index.mjs",
-      "node": {
-        "require": "./dist/lib/node/index.cjs",
-        "default": "./dist/lib/node-esm/index.mjs"
-      },
+      "node": "./dist/lib/node-esm/index.mjs",
       "types": "./dist/types/src/index.d.ts"
     },
-    "./meta": {
-      "browser": "./dist/lib/browser/meta.mjs",
-      "node": {
-        "require": "./dist/lib/node/meta.cjs",
-        "default": "./dist/lib/node-esm/meta.mjs"
-      },
-      "types": "./dist/types/src/meta.d.ts"
+    "./plugin": {
+      "source": "./src/plugin.ts",
+      "types": "./dist/types/src/plugin.d.ts",
+      "browser": "./dist/lib/browser/plugin.mjs",
+      "node": "./dist/lib/node-esm/plugin.mjs"
+    },
+    "./translations": {
+      "source": "./src/translations.ts",
+      "types": "./dist/types/src/translations.d.ts",
+      "browser": "./dist/lib/browser/translations.mjs",
+      "node": "./dist/lib/node-esm/translations.mjs"
+    },
+    "./types": {
+      "source": "./src/types/index.ts",
+      "types": "./dist/types/src/types/index.d.ts",
+      "browser": "./dist/lib/browser/types/index.mjs",
+      "node": "./dist/lib/node-esm/types/index.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
-  "typesVersions": {
-    "*": {
-      "meta": [
-        "dist/types/src/meta.d.ts"
-      ]
-    }
-  },
   "files": [
     "dist",
     "src"
   ],
   "dependencies": {
-    "@dxos/app-framework": "0.6.14-main.7bd9c89",
-    "@dxos/local-storage": "0.6.14-main.7bd9c89",
-    "@dxos/react-ui-tabs": "0.6.14-main.7bd9c89",
-    "@dxos/plugin-graph": "0.6.14-main.7bd9c89",
-    "@dxos/util": "0.6.14-main.7bd9c89"
+    "@dxos/app-framework": "0.8.4-main.1c7ec43d41",
+    "@dxos/app-toolkit": "0.8.4-main.1c7ec43d41",
+    "@dxos/compute": "0.8.4-main.1c7ec43d41",
+    "@dxos/app-graph": "0.8.4-main.1c7ec43d41",
+    "@dxos/util": "0.8.4-main.1c7ec43d41"
   },
   "devDependencies": {
-    "@phosphor-icons/react": "^2.1.5",
-    "@types/react": "~18.2.0",
-    "react": "~18.2.0",
-    "vite": "5.4.7",
-    "@dxos/react-ui": "0.6.14-main.7bd9c89",
-    "@dxos/react-ui-theme": "0.6.14-main.7bd9c89",
-    "@dxos/storybook-utils": "0.6.14-main.7bd9c89"
+    "@types/react": "~19.2.7",
+    "effect": "3.20.0",
+    "react": "~19.2.3",
+    "@dxos/plugin-graph": "0.8.4-main.1c7ec43d41"
   },
   "peerDependencies": {
-    "@phosphor-icons/react": "^2.1.5",
-    "react": "~18.2.0",
-    "@dxos/react-ui": "0.6.14-main.7bd9c89",
-    "@dxos/react-ui-theme": "0.6.14-main.7bd9c89"
+    "effect": "3.20.0",
+    "react": "~19.2.3"
   },
   "publishConfig": {
     "access": "public"

package/src/SettingsPlugin.test.ts

@@ -0,0 +1,33 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { describe, test } from 'vitest';
+
+import { OperationPlugin, RuntimePlugin } from '@dxos/app-framework';
+import { createTestApp } from '@dxos/app-framework/testing';
+import { GraphPlugin } from '@dxos/plugin-graph';
+
+import { SettingsPlugin } from '#plugin';
+
+import { meta } from './meta';
+
+const moduleId = (name: string) => `${meta.id}.module.${name}`;
+
+describe('SettingsPlugin', () => {
+  test('modules activate on the expected events', async ({ expect }) => {
+    // Use createTestApp directly to avoid a circular dep with plugin-testing.
+    // GraphPlugin fires SetupAppGraph (via firesBeforeActivation) during Startup,
+    // activating SettingsAppGraphBuilder. OperationPlugin fires SetupOperationHandler
+    // during Startup, activating OperationHandler.
+    await using harness = await createTestApp({
+      plugins: [GraphPlugin(), OperationPlugin(), RuntimePlugin(), SettingsPlugin()],
+    });
+
+    // SettingsAppGraphBuilder activates on SetupAppGraph (fired by GraphPlugin during Startup).
+    // OperationHandler activates on SetupOperationHandler (fired by OperationPlugin during Startup).
+    expect(harness.manager.getActive()).toEqual(
+      expect.arrayContaining([moduleId('SettingsAppGraphBuilder'), moduleId('OperationHandler')]),
+    );
+  });
+});

package/src/SettingsPlugin.ts

@@ -0,0 +1,19 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Plugin } from '@dxos/app-framework';
+import { AppPlugin } from '@dxos/app-toolkit';
+
+import { OperationHandler, SettingsAppGraphBuilder } from '#capabilities';
+import { meta } from '#meta';
+import { translations } from '#translations';
+
+export const SettingsPlugin = Plugin.define(meta).pipe(
+  AppPlugin.addAppGraphModule({ activate: SettingsAppGraphBuilder }),
+  AppPlugin.addOperationHandlerModule({ activate: OperationHandler }),
+  AppPlugin.addTranslationsModule({ translations }),
+  Plugin.make,
+);
+
+export default SettingsPlugin;

package/src/actions.ts

@@ -0,0 +1,24 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { meta } from '#meta';
+import { SETTINGS_ID, SETTINGS_KEY } from '#types';
+
+export { SETTINGS_ID, SETTINGS_KEY };
+
+export namespace SettingsAction {
+  export class Open extends Schema.TaggedClass<Open>()(`${meta.id}.open`, {
+    input: Schema.Struct({
+      plugin: Schema.optional(Schema.String),
+    }),
+    output: Schema.Void,
+  }) {}
+
+  export class OpenPluginRegistry extends Schema.TaggedClass<OpenPluginRegistry>()(`${meta.id}.open-plugin-registry`, {
+    input: Schema.Void,
+    output: Schema.Void,
+  }) {}
+}

package/src/capabilities/app-graph-builder.ts

@@ -0,0 +1,99 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capabilities, Capability, type Plugin as Plugin$ } from '@dxos/app-framework';
+import { GraphBuilder, Node, NodeMatcher } from '@dxos/app-graph';
+import { AppCapabilities, SettingsOperation, getSpacePath } from '@dxos/app-toolkit';
+import { Operation } from '@dxos/compute';
+import { isNonNullable } from '@dxos/util';
+
+import { meta } from '#meta';
+
+import { SETTINGS_ID, SETTINGS_KEY } from '../actions';
+
+export default Capability.makeModule(
+  Effect.fnUntraced(function* () {
+    // Get context for lazy capability access in callbacks.
+    const capabilities = yield* Capability.Service;
+    const managerAtom = capabilities.atom(Capabilities.PluginManager);
+    const settingsAtom = capabilities.atom(AppCapabilities.Settings);
+
+    const extensions = yield* Effect.all([
+      GraphBuilder.createExtension({
+        id: 'action',
+        match: NodeMatcher.whenRoot,
+        actions: () =>
+          Effect.succeed([
+            {
+              id: 'root',
+              data: () => Operation.invoke(SettingsOperation.Open, {}),
+              properties: {
+                label: ['plugin-settings.label', { ns: meta.id }],
+                icon: 'ph--gear--regular',
+                disposition: 'menu',
+                keyBinding: {
+                  macos: 'meta+,',
+                  windows: 'alt+,',
+                },
+              },
+            },
+          ]),
+      }),
+      GraphBuilder.createExtension({
+        id: 'core',
+        match: NodeMatcher.whenRoot,
+        connector: () =>
+          Effect.succeed([
+            Node.make({
+              id: SETTINGS_ID,
+              type: meta.id,
+              properties: {
+                label: ['plugin-settings.label', { ns: meta.id }],
+                icon: 'ph--gear--regular',
+                disposition: 'pin-end',
+                position: 'hoist',
+                testId: 'treeView.appSettings',
+              },
+            }),
+          ]),
+      }),
+      GraphBuilder.createExtension({
+        id: 'plugins',
+        match: NodeMatcher.whenId(getSpacePath(SETTINGS_ID)),
+        connector: (node, get) => {
+          const [manager] = get(managerAtom);
+          const allSettings = get(settingsAtom);
+          return Effect.succeed(
+            manager
+              .getPlugins()
+              .map((plugin: Plugin$.Plugin): [Plugin$.Meta, AppCapabilities.Settings] | null => {
+                const settings = allSettings.find((s) => s.prefix === plugin.meta.id);
+                if (!settings) {
+                  return null;
+                }
+
+                return [plugin.meta, settings];
+              })
+              .filter(isNonNullable)
+              .map(([meta, settings]: [Plugin$.Meta, AppCapabilities.Settings]) =>
+                Node.make({
+                  id: `${SETTINGS_KEY}:${meta.id.replaceAll('/', ':')}`,
+                  type: 'category',
+                  data: settings,
+                  properties: {
+                    label: meta.name ?? meta.id,
+                    icon: meta.icon ?? 'ph--circle--regular',
+                  },
+                }),
+              ),
+          );
+        },
+      }),
+    ]);
+
+    return Capability.contributes(AppCapabilities.AppGraphBuilder, extensions);
+  }),
+);

package/src/capabilities/index.ts

@@ -0,0 +1,12 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capability } from '@dxos/app-framework';
+import { OperationHandlerSet } from '@dxos/compute';
+
+export const SettingsAppGraphBuilder = Capability.lazy('SettingsAppGraphBuilder', () => import('./app-graph-builder'));
+export const OperationHandler = Capability.lazy<OperationHandlerSet.OperationHandlerSet>(
+  'OperationHandler',
+  () => import('./operation-handler'),
+);

package/src/capabilities/operation-handler.ts

@@ -0,0 +1,16 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import type { OperationHandlerSet } from '@dxos/compute';
+
+import { SettingsOperationHandlerSet } from '#operations';
+
+export default Capability.makeModule<OperationHandlerSet.OperationHandlerSet>(
+  Effect.fnUntraced(function* () {
+    return Capability.contributes(Capabilities.OperationHandler, SettingsOperationHandlerSet);
+  }),
+);

package/src/index.ts

@@ -1,13 +1,13 @@
 //
-// Copyright 2023 DXOS.org
+// Copyright 2024 DXOS.org
 //
 
-import { SettingsPlugin } from './SettingsPlugin';
+import { Plugin } from '@dxos/app-framework';
 
-export default SettingsPlugin;
+import { meta } from './meta';
 
-export * from './SettingsPlugin';
+export const SettingsPlugin = Plugin.lazy(meta, () => import('./SettingsPlugin'));
 
-// TODO(wittjosiah): Remove.
-//  Settings should be exposed from plugins as state and intents rather than components.
-export * from './components';
+export * from './meta';
+
+export * from './actions';

package/src/meta.ts

@@ -1,11 +1,11 @@
 //
-// Copyright 2023 DXOS.org
+// Copyright 2025 DXOS.org
 //
 
-import { type PluginMeta } from '@dxos/app-framework';
+import { type Plugin } from '@dxos/app-framework';
 
-export const SETTINGS_PLUGIN = 'dxos.org/plugin/settings';
-
-export default {
-  id: SETTINGS_PLUGIN,
-} satisfies PluginMeta;
+export const meta: Plugin.Meta = {
+  id: 'org.dxos.plugin.settings',
+  name: 'Settings',
+  tags: ['system'],
+};

package/src/operations/index.ts

@@ -0,0 +1,10 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { OperationHandlerSet } from '@dxos/compute';
+
+export const SettingsOperationHandlerSet = OperationHandlerSet.lazy(
+  () => import('./open'),
+  () => import('./open-plugin-registry'),
+);

package/src/operations/open-plugin-registry.ts

@@ -0,0 +1,28 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { LayoutOperation, SettingsOperation, getSpacePath } from '@dxos/app-toolkit';
+import { Operation } from '@dxos/compute';
+
+import { SETTINGS_ID, SETTINGS_KEY } from '../actions';
+
+const handler: Operation.WithHandler<typeof SettingsOperation.OpenPluginRegistry> =
+  SettingsOperation.OpenPluginRegistry.pipe(
+    Operation.withHandler(() =>
+      Effect.gen(function* () {
+        const { invoke } = yield* Capability.get(Capabilities.OperationInvoker);
+        yield* invoke(LayoutOperation.SwitchWorkspace, { subject: getSpacePath(SETTINGS_ID) });
+        yield* Effect.fork(
+          invoke(LayoutOperation.Open, {
+            subject: [`${getSpacePath(SETTINGS_ID)}/${SETTINGS_KEY}:plugins`],
+          }),
+        );
+      }),
+    ),
+  );
+
+export default handler;

package/src/operations/open.ts

@@ -0,0 +1,29 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Capabilities, Capability } from '@dxos/app-framework';
+import { LayoutOperation, SettingsOperation, getSpacePath } from '@dxos/app-toolkit';
+import { Operation } from '@dxos/compute';
+
+import { SETTINGS_ID, SETTINGS_KEY } from '../actions';
+
+const handler: Operation.WithHandler<typeof SettingsOperation.Open> = SettingsOperation.Open.pipe(
+  Operation.withHandler((input) =>
+    Effect.gen(function* () {
+      const { invoke } = yield* Capability.get(Capabilities.OperationInvoker);
+      yield* invoke(LayoutOperation.SwitchWorkspace, { subject: getSpacePath(SETTINGS_ID) });
+      if (input.plugin) {
+        yield* Effect.fork(
+          invoke(LayoutOperation.Open, {
+            subject: [`${getSpacePath(SETTINGS_ID)}/${SETTINGS_KEY}:${input.plugin.replaceAll('/', ':')}`],
+          }),
+        );
+      }
+    }),
+  ),
+);
+
+export default handler;

package/src/plugin.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// Eager re-export of `SettingsPlugin`. See `@dxos/plugin-testing/src/core.ts`
+// for the rationale.
+export * from './SettingsPlugin';

package/src/translations.ts

@@ -1,18 +1,17 @@
 //
-// Copyright 2023 DXOS.org
+// Copyright 2025 DXOS.org
 //
 
-import { SETTINGS_PLUGIN } from './meta';
+import { type Resource } from '@dxos/app-toolkit';
 
-export default [
+import { meta } from '#meta';
+
+export const translations = [
   {
     'en-US': {
-      [SETTINGS_PLUGIN]: {
-        'open settings label': 'Show settings',
-        'settings dialog title': 'Settings',
-        'back label': 'Back',
-        'click to return to tablist description': 'Click the title to return to the settings menu',
+      [meta.id]: {
+        'plugin-settings.label': 'Plugin Settings',
       },
     },
   },
-];
+] as const satisfies Resource[];

package/src/types/index.ts

@@ -0,0 +1,8 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { pinnedWorkspaceId } from '@dxos/app-toolkit';
+
+export const SETTINGS_ID = pinnedWorkspaceId('dxos:settings');
+export const SETTINGS_KEY = 'settings';

package/README.md

@@ -1,15 +0,0 @@
-# @dxos/plugin-settings
-
-DXOS app plugin for aggregating and rendering plugin settings.
-
-## DXOS Resources
-
-- [Website](https://dxos.org)
-- [Developer Documentation](https://docs.dxos.org)
-- Talk to us on [Discord](https://dxos.org/discord)
-
-## Contributions
-
-Your ideas, issues, and code are most welcome. Please take a look at our [community code of conduct](https://github.com/dxos/dxos/blob/main/CODE_OF_CONDUCT.md), the [issue guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-issues), and the [PR contribution guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-prs).
-
-License: [MIT](./LICENSE) Copyright 2023 © DXOS

package/dist/lib/browser/chunk-PD3C4TDW.mjs

@@ -1,11 +0,0 @@
-// packages/plugins/plugin-settings/src/meta.ts
-var SETTINGS_PLUGIN = "dxos.org/plugin/settings";
-var meta_default = {
-  id: SETTINGS_PLUGIN
-};
-
-export {
-  SETTINGS_PLUGIN,
-  meta_default
-};
-//# sourceMappingURL=chunk-PD3C4TDW.mjs.map

package/dist/lib/browser/chunk-PD3C4TDW.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/meta.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type PluginMeta } from '@dxos/app-framework';\n\nexport const SETTINGS_PLUGIN = 'dxos.org/plugin/settings';\n\nexport default {\n  id: SETTINGS_PLUGIN,\n} satisfies PluginMeta;\n"],
-  "mappings": ";AAMO,IAAMA,kBAAkB;AAE/B,IAAA,eAAe;EACbC,IAAID;AACN;",
-  "names": ["SETTINGS_PLUGIN", "id"]
-}

package/dist/lib/browser/meta.mjs

@@ -1,9 +0,0 @@
-import {
-  SETTINGS_PLUGIN,
-  meta_default
-} from "./chunk-PD3C4TDW.mjs";
-export {
-  SETTINGS_PLUGIN,
-  meta_default as default
-};
-//# sourceMappingURL=meta.mjs.map

package/dist/lib/node/chunk-AHM6OLF2.cjs

@@ -1,34 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var chunk_AHM6OLF2_exports = {};
-__export(chunk_AHM6OLF2_exports, {
-  SETTINGS_PLUGIN: () => SETTINGS_PLUGIN,
-  meta_default: () => meta_default
-});
-module.exports = __toCommonJS(chunk_AHM6OLF2_exports);
-var SETTINGS_PLUGIN = "dxos.org/plugin/settings";
-var meta_default = {
-  id: SETTINGS_PLUGIN
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  SETTINGS_PLUGIN,
-  meta_default
-});
-//# sourceMappingURL=chunk-AHM6OLF2.cjs.map

package/dist/lib/node/chunk-AHM6OLF2.cjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/meta.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type PluginMeta } from '@dxos/app-framework';\n\nexport const SETTINGS_PLUGIN = 'dxos.org/plugin/settings';\n\nexport default {\n  id: SETTINGS_PLUGIN,\n} satisfies PluginMeta;\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;AAMO,IAAMA,kBAAkB;AAE/B,IAAA,eAAe;EACbC,IAAID;AACN;",
-  "names": ["SETTINGS_PLUGIN", "id"]
-}