@dxos/plugin-help 0.8.4-main.7ace549 → 0.8.4-main.937b3ca

package/dist/lib/browser/react-root-QJH33RNI.mjs

@@ -1,35 +0,0 @@
-import {
-  WelcomeTour
-} from "./chunk-W4AUSEGO.mjs";
-import "./chunk-I7FKM6VC.mjs";
-import {
-  HelpCapabilities
-} from "./chunk-AZJJLAG7.mjs";
-import {
-  meta
-} from "./chunk-BCYK4LXW.mjs";
-
-// src/capabilities/react-root.tsx
-import React from "react";
-import { Capabilities, contributes } from "@dxos/app-framework";
-import { useCapability } from "@dxos/app-framework/react";
-var react_root_default = ((steps) => contributes(Capabilities.ReactRoot, {
-  id: meta.id,
-  root: () => {
-    const state = useCapability(HelpCapabilities.MutableState);
-    return /* @__PURE__ */ React.createElement(WelcomeTour, {
-      steps,
-      running: state.running,
-      onRunningChanged: (newState) => {
-        state.running = newState;
-        if (!newState) {
-          state.showHints = false;
-        }
-      }
-    });
-  }
-}));
-export {
-  react_root_default as default
-};
-//# sourceMappingURL=react-root-QJH33RNI.mjs.map

package/dist/lib/browser/react-root-QJH33RNI.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/capabilities/react-root.tsx"],
-  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport React from 'react';\n\nimport { Capabilities, contributes } from '@dxos/app-framework';\nimport { useCapability } from '@dxos/app-framework/react';\n\nimport { WelcomeTour } from '../components';\nimport { meta } from '../meta';\nimport { type Step } from '../types';\n\nimport { HelpCapabilities } from './capabilities';\n\nexport default (steps: Step[]) =>\n  contributes(Capabilities.ReactRoot, {\n    id: meta.id,\n    root: () => {\n      const state = useCapability(HelpCapabilities.MutableState);\n      return (\n        <WelcomeTour\n          steps={steps}\n          running={state.running}\n          onRunningChanged={(newState) => {\n            state.running = newState;\n            if (!newState) {\n              state.showHints = false;\n            }\n          }}\n        />\n      );\n    },\n  });\n"],
-  "mappings": ";;;;;;;;;;;;AAIA,OAAOA,WAAW;AAElB,SAASC,cAAcC,mBAAmB;AAC1C,SAASC,qBAAqB;AAQ9B,IAAA,sBAAe,CAACC,UACdC,YAAYC,aAAaC,WAAW;EAClCC,IAAIC,KAAKD;EACTE,MAAM,MAAA;AACJ,UAAMC,QAAQC,cAAcC,iBAAiBC,YAAY;AACzD,WACE,sBAAA,cAACC,aAAAA;MACCX;MACAY,SAASL,MAAMK;MACfC,kBAAkB,CAACC,aAAAA;AACjBP,cAAMK,UAAUE;AAChB,YAAI,CAACA,UAAU;AACbP,gBAAMQ,YAAY;QACpB;MACF;;EAGN;AACF,CAAA;",
-  "names": ["React", "Capabilities", "contributes", "useCapability", "steps", "contributes", "Capabilities", "ReactRoot", "id", "meta", "root", "state", "useCapability", "HelpCapabilities", "MutableState", "WelcomeTour", "running", "onRunningChanged", "newState", "showHints"]
-}

package/dist/lib/browser/react-surface-OTMERRAV.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/capabilities/react-surface.tsx"],
-  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport React from 'react';\n\nimport { Capabilities, contributes, createSurface } from '@dxos/app-framework';\n\nimport { SHORTCUTS_DIALOG, ShortcutsDialogContent, ShortcutsHints, ShortcutsList } from '../components';\nimport { meta } from '../meta';\n\nexport default () =>\n  contributes(Capabilities.ReactSurface, [\n    createSurface({\n      id: `${meta.id}/hints`,\n      role: 'hints',\n      component: () => <ShortcutsHints />,\n    }),\n    createSurface({\n      id: `${meta.id}/keyshortcuts`,\n      role: 'keyshortcuts',\n      component: () => <ShortcutsList />,\n    }),\n    createSurface({\n      id: SHORTCUTS_DIALOG,\n      role: 'dialog',\n      filter: (data): data is any => data.component === SHORTCUTS_DIALOG,\n      component: () => <ShortcutsDialogContent />,\n    }),\n  ]);\n"],
-  "mappings": ";;;;;;;;;;;;AAIA,OAAOA,WAAW;AAElB,SAASC,cAAcC,aAAaC,qBAAqB;AAKzD,IAAA,yBAAe,MACbC,YAAYC,aAAaC,cAAc;EACrCC,cAAc;IACZC,IAAI,GAAGC,KAAKD,EAAE;IACdE,MAAM;IACNC,WAAW,MAAM,sBAAA,cAACC,gBAAAA,IAAAA;EACpB,CAAA;EACAL,cAAc;IACZC,IAAI,GAAGC,KAAKD,EAAE;IACdE,MAAM;IACNC,WAAW,MAAM,sBAAA,cAACE,eAAAA,IAAAA;EACpB,CAAA;EACAN,cAAc;IACZC,IAAIM;IACJJ,MAAM;IACNK,QAAQ,CAACC,SAAsBA,KAAKL,cAAcG;IAClDH,WAAW,MAAM,sBAAA,cAACM,wBAAAA,IAAAA;EACpB,CAAA;CACD;",
-  "names": ["React", "Capabilities", "contributes", "createSurface", "contributes", "Capabilities", "ReactSurface", "createSurface", "id", "meta", "role", "component", "ShortcutsHints", "ShortcutsList", "SHORTCUTS_DIALOG", "filter", "data", "ShortcutsDialogContent"]
-}

package/dist/lib/browser/state-5PVJCYWJ.mjs

@@ -1,29 +0,0 @@
-import {
-  HelpCapabilities
-} from "./chunk-AZJJLAG7.mjs";
-import {
-  meta
-} from "./chunk-BCYK4LXW.mjs";
-
-// src/capabilities/state.ts
-import { contributes } from "@dxos/app-framework";
-import { LocalStorageStore } from "@dxos/local-storage";
-var state_default = (() => {
-  const state = new LocalStorageStore(meta.id, {
-    running: false,
-    showHints: true,
-    showWelcome: true
-  });
-  state.prop({
-    key: "showHints",
-    type: LocalStorageStore.bool()
-  }).prop({
-    key: "showWelcome",
-    type: LocalStorageStore.bool()
-  });
-  return contributes(HelpCapabilities.State, state.values);
-});
-export {
-  state_default as default
-};
-//# sourceMappingURL=state-5PVJCYWJ.mjs.map

package/dist/lib/browser/state-5PVJCYWJ.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/capabilities/state.ts"],
-  "sourcesContent": ["//\n// Copyright 2025 DXOS.org\n//\n\nimport { contributes } from '@dxos/app-framework';\nimport { LocalStorageStore } from '@dxos/local-storage';\n\nimport { meta } from '../meta';\n\nimport { HelpCapabilities } from './capabilities';\n\nexport default () => {\n  const state = new LocalStorageStore<HelpCapabilities.State>(meta.id, {\n    running: false,\n    showHints: true,\n    showWelcome: true,\n  });\n\n  state\n    .prop({ key: 'showHints', type: LocalStorageStore.bool() })\n    .prop({ key: 'showWelcome', type: LocalStorageStore.bool() });\n\n  return contributes(HelpCapabilities.State, state.values);\n};\n"],
-  "mappings": ";;;;;;;;AAIA,SAASA,mBAAmB;AAC5B,SAASC,yBAAyB;AAMlC,IAAA,iBAAe,MAAA;AACb,QAAMC,QAAQ,IAAIC,kBAA0CC,KAAKC,IAAI;IACnEC,SAAS;IACTC,WAAW;IACXC,aAAa;EACf,CAAA;AAEAN,QACGO,KAAK;IAAEC,KAAK;IAAaC,MAAMR,kBAAkBS,KAAI;EAAG,CAAA,EACxDH,KAAK;IAAEC,KAAK;IAAeC,MAAMR,kBAAkBS,KAAI;EAAG,CAAA;AAE7D,SAAOC,YAAYC,iBAAiBC,OAAOb,MAAMc,MAAM;AACzD;",
-  "names": ["contributes", "LocalStorageStore", "state", "LocalStorageStore", "meta", "id", "running", "showHints", "showWelcome", "prop", "key", "type", "bool", "contributes", "HelpCapabilities", "State", "values"]
-}

package/dist/types/src/capabilities/app-graph-builder.d.ts

@@ -1,4 +0,0 @@
-import { type PluginContext } from '@dxos/app-framework';
-declare const _default: (context: PluginContext) => import("@dxos/app-framework").Capability<import("@dxos/app-framework").InterfaceDef<import("@dxos/app-graph").BuilderExtensions>>;
-export default _default;
-//# sourceMappingURL=app-graph-builder.d.ts.map

package/dist/types/src/capabilities/app-graph-builder.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"app-graph-builder.d.ts","sourceRoot":"","sources":["../../../../src/capabilities/app-graph-builder.ts"],"names":[],"mappings":"AAQA,OAAO,EAA8B,KAAK,aAAa,EAA6B,MAAM,qBAAqB,CAAC;yBAShG,SAAS,aAAa;AAAtC,wBA4DI"}

package/dist/types/src/capabilities/capabilities.d.ts

@@ -1,10 +0,0 @@
-export declare namespace HelpCapabilities {
-    type State = {
-        running: boolean;
-        showHints: boolean;
-        showWelcome: boolean;
-    };
-    const State: import("@dxos/app-framework").InterfaceDef<Readonly<State>>;
-    const MutableState: import("@dxos/app-framework").InterfaceDef<State>;
-}
-//# sourceMappingURL=capabilities.d.ts.map

package/dist/types/src/capabilities/capabilities.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../../../../src/capabilities/capabilities.ts"],"names":[],"mappings":"AAQA,yBAAiB,gBAAgB,CAAC;IAChC,KAAY,KAAK,GAAG;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,SAAS,EAAE,OAAO,CAAC;QAAC,WAAW,EAAE,OAAO,CAAA;KAAE,CAAC;IAC5E,MAAM,KAAK,6DAAmE,CAAC;IAC/E,MAAM,YAAY,mDAAyD,CAAC;CACpF"}

package/dist/types/src/capabilities/react-root.d.ts

@@ -1,8 +0,0 @@
-import React from 'react';
-import { type Step } from '../types';
-declare const _default: (steps: Step[]) => import("@dxos/app-framework").Capability<import("@dxos/app-framework").InterfaceDef<Readonly<{
-    id: string;
-    root: React.FC<React.PropsWithChildren>;
-}>>>;
-export default _default;
-//# sourceMappingURL=react-root.d.ts.map

package/dist/types/src/capabilities/react-root.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"react-root.d.ts","sourceRoot":"","sources":["../../../../src/capabilities/react-root.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,OAAO,CAAC;AAO1B,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,UAAU,CAAC;yBAIrB,OAAO,IAAI,EAAE;;;;AAA7B,wBAkBK"}

package/dist/types/src/capabilities/react-surface.d.ts

@@ -1,4 +0,0 @@
-import { Capabilities } from '@dxos/app-framework';
-declare const _default: () => import("@dxos/app-framework").Capability<import("@dxos/app-framework").InterfaceDef<Capabilities.ReactSurface>>;
-export default _default;
-//# sourceMappingURL=react-surface.d.ts.map

package/dist/types/src/capabilities/react-surface.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"react-surface.d.ts","sourceRoot":"","sources":["../../../../src/capabilities/react-surface.tsx"],"names":[],"mappings":"AAMA,OAAO,EAAE,YAAY,EAA8B,MAAM,qBAAqB,CAAC;;AAK/E,wBAkBK"}

package/dist/types/src/capabilities/state.d.ts

@@ -1,4 +0,0 @@
-import { HelpCapabilities } from './capabilities';
-declare const _default: () => import("@dxos/app-framework").Capability<import("@dxos/app-framework").InterfaceDef<Readonly<HelpCapabilities.State>>>;
-export default _default;
-//# sourceMappingURL=state.d.ts.map

package/dist/types/src/capabilities/state.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../../../src/capabilities/state.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;;AAElD,wBAYE"}

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

@@ -1,78 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Atom } from '@effect-atom/atom-react';
-import * as Function from 'effect/Function';
-import * as Option from 'effect/Option';
-
-import { Capabilities, LayoutAction, type PluginContext, contributes, createIntent } from '@dxos/app-framework';
-import { createExtension } from '@dxos/app-graph';
-
-import { SHORTCUTS_DIALOG } from '../components';
-import { meta } from '../meta';
-import { HelpAction } from '../types';
-
-import { HelpCapabilities } from './capabilities';
-
-export default (context: PluginContext) =>
-  contributes(
-    Capabilities.AppGraphBuilder,
-    createExtension({
-      id: meta.id,
-      actions: (node) =>
-        Atom.make((get) =>
-          Function.pipe(
-            get(node),
-            Option.flatMap((node) => (node.id === 'root' ? Option.some(node) : 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: meta.id }],
-                  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: `${meta.id}/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: meta.id }],
-                  icon: 'ph--keyboard--regular',
-                  keyBinding: {
-                    macos: 'meta+ctrl+/',
-                  },
-                },
-              },
-            ]),
-            Option.getOrElse(() => []),
-          ),
-        ),
-    }),
-  );

package/src/capabilities/capabilities.ts

@@ -1,13 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { defineCapability } from '@dxos/app-framework';
-
-import { meta } from '../meta';
-
-export namespace HelpCapabilities {
-  export type State = { running: boolean; showHints: boolean; showWelcome: boolean };
-  export const State = defineCapability<Readonly<State>>(`${meta.id}/capability/state`);
-  export const MutableState = defineCapability<State>(`${meta.id}/capability/state`);
-}

package/src/capabilities/react-root.tsx

@@ -1,34 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React from 'react';
-
-import { Capabilities, contributes } from '@dxos/app-framework';
-import { useCapability } from '@dxos/app-framework/react';
-
-import { WelcomeTour } from '../components';
-import { meta } from '../meta';
-import { type Step } from '../types';
-
-import { HelpCapabilities } from './capabilities';
-
-export default (steps: Step[]) =>
-  contributes(Capabilities.ReactRoot, {
-    id: meta.id,
-    root: () => {
-      const state = useCapability(HelpCapabilities.MutableState);
-      return (
-        <WelcomeTour
-          steps={steps}
-          running={state.running}
-          onRunningChanged={(newState) => {
-            state.running = newState;
-            if (!newState) {
-              state.showHints = false;
-            }
-          }}
-        />
-      );
-    },
-  });

package/src/capabilities/react-surface.tsx

@@ -1,30 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React from 'react';
-
-import { Capabilities, contributes, createSurface } from '@dxos/app-framework';
-
-import { SHORTCUTS_DIALOG, ShortcutsDialogContent, ShortcutsHints, ShortcutsList } from '../components';
-import { meta } from '../meta';
-
-export default () =>
-  contributes(Capabilities.ReactSurface, [
-    createSurface({
-      id: `${meta.id}/hints`,
-      role: 'hints',
-      component: () => <ShortcutsHints />,
-    }),
-    createSurface({
-      id: `${meta.id}/keyshortcuts`,
-      role: 'keyshortcuts',
-      component: () => <ShortcutsList />,
-    }),
-    createSurface({
-      id: SHORTCUTS_DIALOG,
-      role: 'dialog',
-      filter: (data): data is any => data.component === SHORTCUTS_DIALOG,
-      component: () => <ShortcutsDialogContent />,
-    }),
-  ]);

package/src/capabilities/state.ts

@@ -1,24 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { contributes } from '@dxos/app-framework';
-import { LocalStorageStore } from '@dxos/local-storage';
-
-import { meta } from '../meta';
-
-import { HelpCapabilities } from './capabilities';
-
-export default () => {
-  const state = new LocalStorageStore<HelpCapabilities.State>(meta.id, {
-    running: false,
-    showHints: true,
-    showWelcome: true,
-  });
-
-  state
-    .prop({ key: 'showHints', type: LocalStorageStore.bool() })
-    .prop({ key: 'showWelcome', type: LocalStorageStore.bool() });
-
-  return contributes(HelpCapabilities.State, state.values);
-};