@dxos/plugin-help 0.8.4-main.c1de068 → 0.8.4-main.c85a9c8dae

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/components/Shortcuts/ShortcutsDialog.d.ts

@@ -1,4 +0,0 @@
-import React from 'react';
-export declare const SHORTCUTS_DIALOG = "dxos.org/plugin/help/ShortcutsDialog";
-export declare const ShortcutsDialogContent: () => React.JSX.Element;
-//# sourceMappingURL=ShortcutsDialog.d.ts.map

package/dist/types/src/components/Shortcuts/ShortcutsDialog.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ShortcutsDialog.d.ts","sourceRoot":"","sources":["../../../../../src/components/Shortcuts/ShortcutsDialog.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,OAAO,CAAC;AAO1B,eAAO,MAAM,gBAAgB,yCAAmC,CAAC;AAEjE,eAAO,MAAM,sBAAsB,yBAoBlC,CAAC"}

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);
-};

package/src/components/Shortcuts/ShortcutsDialog.tsx

@@ -1,34 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React from 'react';
-
-import { Button, Dialog, Icon, useTranslation } from '@dxos/react-ui';
-
-import { ShortcutsList } from './ShortcutsList';
-import { HELP_PLUGIN } from '../../meta';
-
-export const SHORTCUTS_DIALOG = `${HELP_PLUGIN}/ShortcutsDialog`;
-
-export const ShortcutsDialogContent = () => {
-  const { t } = useTranslation(HELP_PLUGIN);
-
-  return (
-    <Dialog.Content classNames='p-0 bs-content max-bs-full md:max-is-[25rem] overflow-hidden'>
-      <div role='none' className='flex justify-between mbe-1 pbs-3 pis-2 pie-3 @md:pbs-4 @md:pis-4 @md:pie-5'>
-        <Dialog.Title>{t('shortcuts dialog title')}</Dialog.Title>
-
-        <Dialog.Close asChild>
-          <Button density='fine' variant='ghost' autoFocus>
-            <Icon icon='ph--x--bold' size={3} />
-          </Button>
-        </Dialog.Close>
-      </div>
-
-      <div className='flex items-center justify-center'>
-        <ShortcutsList />
-      </div>
-    </Dialog.Content>
-  );
-};