@dxos/plugin-help 0.8.3 → 0.8.4-main.03d5cd7b56

package/src/types/HelpCapabilities.ts

@@ -0,0 +1,24 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// @import-as-namespace
+
+import { type Atom } from '@effect-atom/atom-react';
+import * as Schema from 'effect/Schema';
+
+import { Capability } from '@dxos/app-framework';
+
+import { meta } from '#meta';
+
+export const StateSchema = Schema.mutable(
+  Schema.Struct({
+    running: Schema.Boolean,
+    showHints: Schema.Boolean,
+    showWelcome: Schema.Boolean,
+  }),
+);
+
+export type State = Schema.Schema.Type<typeof StateSchema>;
+
+export const State = Capability.make<Atom.Writable<State>>(`${meta.id}.capability.state`);

package/src/types/HelpOperation.ts

@@ -0,0 +1,21 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// @import-as-namespace
+
+import * as Schema from 'effect/Schema';
+
+import { Capability } from '@dxos/app-framework';
+import { Operation } from '@dxos/compute';
+
+import { meta } from '#meta';
+
+const HELP_OPERATION = `${meta.id}.operation`;
+
+export const Start = Operation.make({
+  meta: { key: `${HELP_OPERATION}.start`, name: 'Start Help' },
+  services: [Capability.Service],
+  input: Schema.Void,
+  output: Schema.Void,
+});

package/src/types/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * as HelpCapabilities from './HelpCapabilities';
+export * as HelpOperation from './HelpOperation';
+export * from './schema';

package/src/{types.ts → types/schema.ts}

@@ -2,16 +2,13 @@
 // Copyright 2023 DXOS.org
 //
 
-import { Schema } from 'effect';
 import { type Context, createContext } from 'react';
 import { type Step as BaseStep } from 'react-joyride';
 
-import { type PluginContext } from '@dxos/app-framework';
-
-import { HELP_PLUGIN } from './meta';
+import { type CapabilityManager } from '@dxos/app-framework';
 
 export type Step = BaseStep & {
-  before?: (context: PluginContext) => void;
+  before?: (capabilities: CapabilityManager.CapabilityManager) => void;
 };
 
 export type HelpContextType = {
@@ -31,11 +28,3 @@ export const HelpContext: Context<HelpContextType> = createContext<HelpContextTy
   start: () => {},
   stop: () => {},
 });
-
-export const HELP_ACTION = `${HELP_PLUGIN}/action`;
-export namespace HelpAction {
-  export class Start extends Schema.TaggedClass<Start>()(`${HELP_ACTION}/start`, {
-    input: Schema.Void,
-    output: Schema.Void,
-  }) {}
-}

package/dist/lib/browser/app-graph-builder-2TXP7S56.mjs

@@ -1,79 +0,0 @@
-import {
-  SHORTCUTS_DIALOG
-} from "./chunk-JNDWLTUJ.mjs";
-import {
-  HelpAction
-} from "./chunk-BZUIJQPN.mjs";
-import {
-  HelpCapabilities
-} from "./chunk-ACLT6V7I.mjs";
-import {
-  HELP_PLUGIN
-} from "./chunk-4KTRSNO5.mjs";
-
-// packages/plugins/plugin-help/src/capabilities/app-graph-builder.ts
-import { Rx } from "@effect-rx/rx-react";
-import { Option, pipe } from "effect";
-import { Capabilities, contributes, createIntent, LayoutAction } from "@dxos/app-framework";
-import { createExtension } from "@dxos/app-graph";
-var app_graph_builder_default = (context) => contributes(Capabilities.AppGraphBuilder, createExtension({
-  id: HELP_PLUGIN,
-  actions: (node) => Rx.make((get) => pipe(get(node), Option.flatMap((node2) => node2.id === "root" ? Option.some(node2) : Option.none()), Option.map(() => [
-    {
-      id: HelpAction.Start._tag,
-      data: async () => {
-        const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-        const state = context.getCapability(HelpCapabilities.MutableState);
-        state.showHints = true;
-        await dispatch(createIntent(HelpAction.Start));
-      },
-      properties: {
-        label: [
-          "open help tour",
-          {
-            ns: HELP_PLUGIN
-          }
-        ],
-        icon: "ph--info--regular",
-        keyBinding: {
-          macos: "shift+meta+/",
-          // TODO(wittjosiah): Test on windows to see if it behaves the same as linux.
-          windows: "shift+ctrl+/",
-          linux: "shift+ctrl+?"
-        },
-        testId: "helpPlugin.openHelp"
-      }
-    },
-    {
-      id: "dxos.org/plugin/help/open-shortcuts",
-      data: async () => {
-        const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);
-        const state = context.getCapability(HelpCapabilities.MutableState);
-        state.showHints = true;
-        await dispatch(createIntent(LayoutAction.UpdateDialog, {
-          part: "dialog",
-          subject: SHORTCUTS_DIALOG,
-          options: {
-            blockAlign: "center"
-          }
-        }));
-      },
-      properties: {
-        label: [
-          "open shortcuts label",
-          {
-            ns: HELP_PLUGIN
-          }
-        ],
-        icon: "ph--keyboard--regular",
-        keyBinding: {
-          macos: "meta+ctrl+/"
-        }
-      }
-    }
-  ]), Option.getOrElse(() => [])))
-}));
-export {
-  app_graph_builder_default as default
-};
-//# sourceMappingURL=app-graph-builder-2TXP7S56.mjs.map

package/dist/lib/browser/app-graph-builder-2TXP7S56.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/capabilities/app-graph-builder.ts"],
-  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { Rx } from '@effect-rx/rx-react';\nimport { Option, pipe } from 'effect';\n\nimport { Capabilities, contributes, createIntent, LayoutAction, type PluginContext } from '@dxos/app-framework';\nimport { createExtension } from '@dxos/app-graph';\n\nimport { HelpCapabilities } from './capabilities';\nimport { SHORTCUTS_DIALOG } from '../components';\nimport { HELP_PLUGIN } from '../meta';\nimport { HelpAction } from '../types';\n\nexport default (context: PluginContext) =>\n  contributes(\n    Capabilities.AppGraphBuilder,\n    createExtension({\n      id: HELP_PLUGIN,\n      actions: (node) =>\n        Rx.make((get) =>\n          pipe(\n            get(node),\n            Option.flatMap((node) => (node.id === 'root' ? Option.some(node) : Option.none())),\n            Option.map(() => [\n              {\n                id: HelpAction.Start._tag,\n                data: async () => {\n                  const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);\n                  const state = context.getCapability(HelpCapabilities.MutableState);\n                  state.showHints = true;\n                  await dispatch(createIntent(HelpAction.Start));\n                },\n                properties: {\n                  label: ['open help tour', { ns: HELP_PLUGIN }],\n                  icon: 'ph--info--regular',\n                  keyBinding: {\n                    macos: 'shift+meta+/',\n                    // TODO(wittjosiah): Test on windows to see if it behaves the same as linux.\n                    windows: 'shift+ctrl+/',\n                    linux: 'shift+ctrl+?',\n                  },\n                  testId: 'helpPlugin.openHelp',\n                },\n              },\n              {\n                id: 'dxos.org/plugin/help/open-shortcuts',\n                data: async () => {\n                  const { dispatchPromise: dispatch } = context.getCapability(Capabilities.IntentDispatcher);\n                  const state = context.getCapability(HelpCapabilities.MutableState);\n                  state.showHints = true;\n                  await dispatch(\n                    createIntent(LayoutAction.UpdateDialog, {\n                      part: 'dialog',\n                      subject: SHORTCUTS_DIALOG,\n                      options: {\n                        blockAlign: 'center',\n                      },\n                    }),\n                  );\n                },\n                properties: {\n                  label: ['open shortcuts label', { ns: HELP_PLUGIN }],\n                  icon: 'ph--keyboard--regular',\n                  keyBinding: {\n                    macos: 'meta+ctrl+/',\n                  },\n                },\n              },\n            ]),\n            Option.getOrElse(() => []),\n          ),\n        ),\n    }),\n  );\n"],
-  "mappings": ";;;;;;;;;;;;;;AAIA,SAASA,UAAU;AACnB,SAASC,QAAQC,YAAY;AAE7B,SAASC,cAAcC,aAAaC,cAAcC,oBAAwC;AAC1F,SAASC,uBAAuB;AAOhC,IAAA,4BAAe,CAACC,YACdC,YACEC,aAAaC,iBACbC,gBAAgB;EACdC,IAAIC;EACJC,SAAS,CAACC,SACRC,GAAGC,KAAK,CAACC,QACPC,KACED,IAAIH,IAAAA,GACJK,OAAOC,QAAQ,CAACN,UAAUA,MAAKH,OAAO,SAASQ,OAAOE,KAAKP,KAAAA,IAAQK,OAAOG,KAAI,CAAA,GAC9EH,OAAOI,IAAI,MAAM;IACf;MACEZ,IAAIa,WAAWC,MAAMC;MACrBC,MAAM,YAAA;AACJ,cAAM,EAAEC,iBAAiBC,SAAQ,IAAKvB,QAAQwB,cAActB,aAAauB,gBAAgB;AACzF,cAAMC,QAAQ1B,QAAQwB,cAAcG,iBAAiBC,YAAY;AACjEF,cAAMG,YAAY;AAClB,cAAMN,SAASO,aAAaZ,WAAWC,KAAK,CAAA;MAC9C;MACAY,YAAY;QACVC,OAAO;UAAC;UAAkB;YAAEC,IAAI3B;UAAY;;QAC5C4B,MAAM;QACNC,YAAY;UACVC,OAAO;;UAEPC,SAAS;UACTC,OAAO;QACT;QACAC,QAAQ;MACV;IACF;IACA;MACElC,IAAI;MACJgB,MAAM,YAAA;AACJ,cAAM,EAAEC,iBAAiBC,SAAQ,IAAKvB,QAAQwB,cAActB,aAAauB,gBAAgB;AACzF,cAAMC,QAAQ1B,QAAQwB,cAAcG,iBAAiBC,YAAY;AACjEF,cAAMG,YAAY;AAClB,cAAMN,SACJO,aAAaU,aAAaC,cAAc;UACtCC,MAAM;UACNC,SAASC;UACTC,SAAS;YACPC,YAAY;UACd;QACF,CAAA,CAAA;MAEJ;MACAf,YAAY;QACVC,OAAO;UAAC;UAAwB;YAAEC,IAAI3B;UAAY;;QAClD4B,MAAM;QACNC,YAAY;UACVC,OAAO;QACT;MACF;IACF;GACD,GACDvB,OAAOkC,UAAU,MAAM,CAAA,CAAE,CAAA,CAAA;AAGjC,CAAA,CAAA;",
-  "names": ["Rx", "Option", "pipe", "Capabilities", "contributes", "createIntent", "LayoutAction", "createExtension", "context", "contributes", "Capabilities", "AppGraphBuilder", "createExtension", "id", "HELP_PLUGIN", "actions", "node", "Rx", "make", "get", "pipe", "Option", "flatMap", "some", "none", "map", "HelpAction", "Start", "_tag", "data", "dispatchPromise", "dispatch", "getCapability", "IntentDispatcher", "state", "HelpCapabilities", "MutableState", "showHints", "createIntent", "properties", "label", "ns", "icon", "keyBinding", "macos", "windows", "linux", "testId", "LayoutAction", "UpdateDialog", "part", "subject", "SHORTCUTS_DIALOG", "options", "blockAlign", "getOrElse"]
-}

package/dist/lib/browser/chunk-4KTRSNO5.mjs

@@ -1,13 +0,0 @@
-// packages/plugins/plugin-help/src/meta.ts
-var HELP_PLUGIN = "dxos.org/plugin/help";
-var meta = {
-  id: HELP_PLUGIN,
-  name: "Help",
-  icon: "ph--info--regular"
-};
-
-export {
-  HELP_PLUGIN,
-  meta
-};
-//# sourceMappingURL=chunk-4KTRSNO5.mjs.map

package/dist/lib/browser/chunk-4KTRSNO5.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\n// TODO(burdon): Rename Guide? Help?\nexport const HELP_PLUGIN = 'dxos.org/plugin/help';\n\nexport const meta: PluginMeta = {\n  id: HELP_PLUGIN,\n  name: 'Help',\n  icon: 'ph--info--regular',\n};\n"],
-  "mappings": ";AAOO,IAAMA,cAAc;AAEpB,IAAMC,OAAmB;EAC9BC,IAAIF;EACJG,MAAM;EACNC,MAAM;AACR;",
-  "names": ["HELP_PLUGIN", "meta", "id", "name", "icon"]
-}

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

@@ -1,16 +0,0 @@
-import {
-  HELP_PLUGIN
-} from "./chunk-4KTRSNO5.mjs";
-
-// packages/plugins/plugin-help/src/capabilities/capabilities.ts
-import { defineCapability } from "@dxos/app-framework";
-(function(HelpCapabilities2) {
-  HelpCapabilities2.State = defineCapability(`${HELP_PLUGIN}/capability/state`);
-  HelpCapabilities2.MutableState = defineCapability(`${HELP_PLUGIN}/capability/state`);
-})(HelpCapabilities || (HelpCapabilities = {}));
-var HelpCapabilities;
-
-export {
-  HelpCapabilities
-};
-//# sourceMappingURL=chunk-ACLT6V7I.mjs.map

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

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/capabilities/capabilities.ts"],
-  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { defineCapability } from '@dxos/app-framework';\n\nimport { HELP_PLUGIN } from '../meta';\n\nexport namespace HelpCapabilities {\n  export type State = { running: boolean; showHints: boolean; showWelcome: boolean };\n  export const State = defineCapability<Readonly<State>>(`${HELP_PLUGIN}/capability/state`);\n  export const MutableState = defineCapability<State>(`${HELP_PLUGIN}/capability/state`);\n}\n"],
-  "mappings": ";;;;;AAIA,SAASA,wBAAwB;UAIhBC,mBAAAA;oBAEFC,QAAQC,iBAAkC,GAAGC,WAAAA,mBAA8B;oBAC3EC,eAAeF,iBAAwB,GAAGC,WAAAA,mBAA8B;AACvF,GAJiBH,qBAAAA,mBAAAA,CAAAA,EAAAA;;",
-  "names": ["defineCapability", "HelpCapabilities", "State", "defineCapability", "HELP_PLUGIN", "MutableState"]
-}

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

@@ -1,36 +0,0 @@
-import {
-  HELP_PLUGIN
-} from "./chunk-4KTRSNO5.mjs";
-
-// packages/plugins/plugin-help/src/types.ts
-import { Schema } from "effect";
-import { createContext } from "react";
-var HelpContext = createContext({
-  running: false,
-  steps: [],
-  setSteps: () => {
-  },
-  setIndex: () => {
-  },
-  start: () => {
-  },
-  stop: () => {
-  }
-});
-var HELP_ACTION = `${HELP_PLUGIN}/action`;
-(function(HelpAction2) {
-  class Start extends Schema.TaggedClass()(`${HELP_ACTION}/start`, {
-    input: Schema.Void,
-    output: Schema.Void
-  }) {
-  }
-  HelpAction2.Start = Start;
-})(HelpAction || (HelpAction = {}));
-var HelpAction;
-
-export {
-  HelpContext,
-  HELP_ACTION,
-  HelpAction
-};
-//# sourceMappingURL=chunk-BZUIJQPN.mjs.map

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

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/types.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { Schema } from 'effect';\nimport { type Context, createContext } from 'react';\nimport { type Step as BaseStep } from 'react-joyride';\n\nimport { type PluginContext } from '@dxos/app-framework';\n\nimport { HELP_PLUGIN } from './meta';\n\nexport type Step = BaseStep & {\n  before?: (context: PluginContext) => void;\n};\n\nexport type HelpContextType = {\n  running: boolean;\n  steps: Step[];\n  setSteps: (steps: Step[]) => void;\n  setIndex: (index: number) => void;\n  start: () => void;\n  stop: () => void;\n};\n\nexport const HelpContext: Context<HelpContextType> = createContext<HelpContextType>({\n  running: false,\n  steps: [],\n  setSteps: () => {},\n  setIndex: () => {},\n  start: () => {},\n  stop: () => {},\n});\n\nexport const HELP_ACTION = `${HELP_PLUGIN}/action`;\nexport namespace HelpAction {\n  export class Start extends Schema.TaggedClass<Start>()(`${HELP_ACTION}/start`, {\n    input: Schema.Void,\n    output: Schema.Void,\n  }) {}\n}\n"],
-  "mappings": ";;;;;AAIA,SAASA,cAAc;AACvB,SAAuBC,qBAAqB;AAoBrC,IAAMC,cAAwCC,cAA+B;EAClFC,SAAS;EACTC,OAAO,CAAA;EACPC,UAAU,MAAA;EAAO;EACjBC,UAAU,MAAA;EAAO;EACjBC,OAAO,MAAA;EAAO;EACdC,MAAM,MAAA;EAAO;AACf,CAAA;AAEO,IAAMC,cAAc,GAAGC,WAAAA;UACbC,aAAAA;EACR,MAAMC,cAAcC,OAAOC,YAAW,EAAU,GAAGL,WAAAA,UAAqB;IAC7EM,OAAOF,OAAOG;IACdC,QAAQJ,OAAOG;EACjB,CAAA,EAAA;EAAI;cAHSJ,QAAAA;AAIf,GALiBD,eAAAA,aAAAA,CAAAA,EAAAA;;",
-  "names": ["Schema", "createContext", "HelpContext", "createContext", "running", "steps", "setSteps", "setIndex", "start", "stop", "HELP_ACTION", "HELP_PLUGIN", "HelpAction", "Start", "Schema", "TaggedClass", "input", "Void", "output"]
-}