@dxos/plugin-help 0.8.3 → 0.8.4-main.1068cf700f

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;yBAErB,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<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/live-object").Live<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":"AAOA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;;AAGlD,wBAYE"}

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

@@ -1,29 +0,0 @@
-import { Schema } from 'effect';
-import { type Context } from 'react';
-import { type Step as BaseStep } from 'react-joyride';
-import { type PluginContext } from '@dxos/app-framework';
-export type Step = BaseStep & {
-    before?: (context: PluginContext) => void;
-};
-export type HelpContextType = {
-    running: boolean;
-    steps: Step[];
-    setSteps: (steps: Step[]) => void;
-    setIndex: (index: number) => void;
-    start: () => void;
-    stop: () => void;
-};
-export declare const HelpContext: Context<HelpContextType>;
-export declare const HELP_ACTION = "dxos.org/plugin/help/action";
-export declare namespace HelpAction {
-    const Start_base: Schema.TaggedClass<Start, "dxos.org/plugin/help/action/start", {
-        readonly _tag: Schema.tag<"dxos.org/plugin/help/action/start">;
-    } & {
-        input: typeof Schema.Void;
-        output: typeof Schema.Void;
-    }>;
-    export class Start extends Start_base {
-    }
-    export {};
-}
-//# sourceMappingURL=types.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,KAAK,OAAO,EAAiB,MAAM,OAAO,CAAC;AACpD,OAAO,EAAE,KAAK,IAAI,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEtD,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAIzD,MAAM,MAAM,IAAI,GAAG,QAAQ,GAAG;IAC5B,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,IAAI,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,QAAQ,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,IAAI,CAAC;IAClC,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,IAAI,EAAE,MAAM,IAAI,CAAC;CAClB,CAAC;AAEF,eAAO,MAAM,WAAW,EAAE,OAAO,CAAC,eAAe,CAO/C,CAAC;AAEH,eAAO,MAAM,WAAW,gCAA0B,CAAC;AACnD,yBAAiB,UAAU,CAAC;;;;;;;IAC1B,MAAM,OAAO,KAAM,SAAQ,UAGzB;KAAG;;CACN"}

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

@@ -1,76 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Rx } from '@effect-rx/rx-react';
-import { Option, pipe } from 'effect';
-
-import { Capabilities, contributes, createIntent, LayoutAction, type PluginContext } from '@dxos/app-framework';
-import { createExtension } from '@dxos/app-graph';
-
-import { HelpCapabilities } from './capabilities';
-import { SHORTCUTS_DIALOG } from '../components';
-import { HELP_PLUGIN } from '../meta';
-import { HelpAction } from '../types';
-
-export default (context: PluginContext) =>
-  contributes(
-    Capabilities.AppGraphBuilder,
-    createExtension({
-      id: HELP_PLUGIN,
-      actions: (node) =>
-        Rx.make((get) =>
-          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: 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(() => []),
-          ),
-        ),
-    }),
-  );

package/src/capabilities/capabilities.ts

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

package/src/capabilities/react-root.tsx

@@ -1,32 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React from 'react';
-
-import { Capabilities, contributes, useCapability } from '@dxos/app-framework';
-
-import { HelpCapabilities } from './capabilities';
-import { WelcomeTour } from '../components';
-import { HELP_PLUGIN } from '../meta';
-import { type Step } from '../types';
-
-export default (steps: Step[]) =>
-  contributes(Capabilities.ReactRoot, {
-    id: HELP_PLUGIN,
-    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 { HELP_PLUGIN } from '../meta';
-
-export default () =>
-  contributes(Capabilities.ReactSurface, [
-    createSurface({
-      id: `${HELP_PLUGIN}/hints`,
-      role: 'hints',
-      component: () => <ShortcutsHints />,
-    }),
-    createSurface({
-      id: `${HELP_PLUGIN}/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,23 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { contributes } from '@dxos/app-framework';
-import { LocalStorageStore } from '@dxos/local-storage';
-
-import { HelpCapabilities } from './capabilities';
-import { HELP_PLUGIN } from '../meta';
-
-export default () => {
-  const state = new LocalStorageStore<HelpCapabilities.State>(HELP_PLUGIN, {
-    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);
-};