@dxos/app-framework 0.6.13-main.548ca8d → 0.6.13-staging.1e988a3

package/src/plugins/PluginHost/plugin.ts

@@ -2,6 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
+import type { IconProps } from '@phosphor-icons/react';
 import type { FC, PropsWithChildren } from 'react';
 
 /**
@@ -20,56 +21,60 @@ export type PluginProvides<TProvides> = TProvides & {
   root?: FC<PropsWithChildren>;
 };
 
-export type PluginMeta = {
-  /**
-   * Globally unique ID.
-   *
-   * Expected to be in the form of a valid URL.
-   *
-   * @example dxos.org/plugin/example
-   */
-  id: string;
-
-  /**
-   * Short ID for use in URLs.
-   *
-   * NOTE: This is especially experimental and likely to change.
-   */
-  // TODO(wittjosiah): How should these be managed?
-  shortId?: string;
-
-  /**
-   * Human-readable name.
-   */
-  name?: string;
-
-  /**
-   * Short description of plugin functionality.
-   */
-  description?: string;
-
-  /**
-   * URL of home page.
-   */
-  homePage?: string;
-
-  /**
-   * Tags to help categorize the plugin.
-   */
-  tags?: string[];
-
-  /**
-   * A grep-able symbol string which can be resolved to an icon asset by @ch-ui/icons, via @ch-ui/vite-plugin-icons.
-   */
-  icon?: string;
-};
-
 /**
  * A unit of containment of modular functionality that can be provided to an application.
  * Plugins provide things like components, state, actions, etc. to the application.
  */
 export type Plugin<TProvides = {}> = {
-  meta: PluginMeta;
+  meta: {
+    /**
+     * Globally unique ID.
+     *
+     * Expected to be in the form of a valid URL.
+     *
+     * @example dxos.org/plugin/example
+     */
+    id: string;
+
+    /**
+     * Short ID for use in URLs.
+     *
+     * NOTE: This is especially experimental and likely to change.
+     */
+    // TODO(wittjosiah): How should these be managed?
+    shortId?: string;
+
+    /**
+     * Human-readable name.
+     */
+    name?: string;
+
+    /**
+     * Short description of plugin functionality.
+     */
+    description?: string;
+
+    /**
+     * URL of home page.
+     */
+    homePage?: string;
+
+    /**
+     * Tags to help categorize the plugin.
+     */
+    tags?: string[];
+
+    /**
+     * Component to render icon for the plugin when displayed in a list.
+     * @deprecated
+     */
+    iconComponent?: FC<IconProps>;
+
+    /**
+     * A grep-able symbol string which can be resolved to an icon asset by @ch-ui/icons, via @ch-ui/vite-plugin-icons.
+     */
+    iconSymbol?: string;
+  };
 
   /**
    * Capabilities provided by the plugin.
@@ -109,6 +114,8 @@ export type PluginDefinition<TProvides = {}, TInitializeProvides = {}> = Omit<Pl
   unload?: () => Promise<void>;
 };
 
+export const pluginMeta = (meta: Plugin['meta']) => meta;
+
 type LazyPlugin<T> = () => Promise<{ default: (props: T) => PluginDefinition }>;
 
 export namespace Plugin {

package/src/plugins/common/navigation.ts

@@ -2,9 +2,10 @@
 // Copyright 2024 DXOS.org
 //
 
-import { Schema as S } from '@effect/schema';
 import { z } from 'zod';
 
+import { S } from '@dxos/echo-schema';
+
 import type { IntentData } from '../IntentPlugin';
 import type { Plugin } from '../PluginHost';
 
@@ -18,6 +19,7 @@ export const SLUG_COLLECTION_INDICATOR = '';
 const LayoutEntrySchema = S.mutable(S.Struct({ id: S.String, path: S.optional(S.String) }));
 export type LayoutEntry = S.Schema.Type<typeof LayoutEntrySchema>;
 
+// TODO(Zan): Consider making solo it's own part. It's not really a function of the 'main' part?
 // TODO(Zan): Consider renaming the 'main' part to 'deck' part now that we are throwing out the old layout plugin.
 // TODO(Zan): Extend to all strings?
 const LayoutPartSchema = S.Union(
@@ -29,9 +31,7 @@ const LayoutPartSchema = S.Union(
 );
 export type LayoutPart = S.Schema.Type<typeof LayoutPartSchema>;
 
-const LayoutPartsSchema = S.partial(
-  S.mutable(S.Record({ key: LayoutPartSchema, value: S.mutable(S.Array(LayoutEntrySchema)) })),
-);
+const LayoutPartsSchema = S.partial(S.mutable(S.Record(LayoutPartSchema, S.mutable(S.Array(LayoutEntrySchema)))));
 export type LayoutParts = S.Schema.Type<typeof LayoutPartsSchema>;
 
 const LayoutCoordinateSchema = S.mutable(S.Struct({ part: LayoutPartSchema, entryId: S.String }));
@@ -52,6 +52,14 @@ export type ActiveParts = z.infer<typeof ActiveParts>;
 // TODO(burdon): Where should this go?
 export type LayoutContainerProps<T> = T & { role?: string; coordinate?: LayoutCoordinate };
 
+/**
+ * Basic state provided by a navigation plugin.
+ */
+export const Attention = z.object({
+  attended: z.set(z.string()).optional().describe('Ids of items which have focus.'),
+});
+export type Attention = z.infer<typeof Attention>;
+
 /**
  * Provides for a plugin that can manage the app navigation.
  */

package/tsconfig.json

@@ -16,7 +16,35 @@
   "include": [
     "src"
   ],
-  "references": [],
+  "references": [
+    {
+      "path": "../../common/async"
+    },
+    {
+      "path": "../../common/debug"
+    },
+    {
+      "path": "../../common/invariant"
+    },
+    {
+      "path": "../../common/local-storage"
+    },
+    {
+      "path": "../../common/log"
+    },
+    {
+      "path": "../../common/util"
+    },
+    {
+      "path": "../../core/echo/echo-schema"
+    },
+    {
+      "path": "../app-graph"
+    },
+    {
+      "path": "../client-protocol"
+    }
+  ],
   "ts-node": {
     "compilerOptions": {
       "module": "CommonJS"

package/dist/lib/node-esm/chunk-ERPIGFBI.mjs

@@ -1,28 +0,0 @@
-import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
-
-// packages/sdk/app-framework/src/plugins/SurfacePlugin/provides.ts
-var parseRootSurfacePlugin = (plugin) => plugin?.provides?.surface?.components ? plugin : void 0;
-var parseSurfacePlugin = (plugin) => plugin?.provides?.surface?.component ? plugin : void 0;
-
-// packages/sdk/app-framework/src/plugins/SurfacePlugin/SurfaceRootContext.tsx
-import { createContext, useContext } from "react";
-var SurfaceRootContext = /* @__PURE__ */ createContext({
-  components: {}
-});
-var useSurfaceRoot = () => useContext(SurfaceRootContext);
-var SurfaceProvider = SurfaceRootContext.Provider;
-
-// packages/sdk/app-framework/src/plugins/SurfacePlugin/meta.ts
-var SurfaceMeta = {
-  id: "dxos.org/plugin/surface"
-};
-var meta_default = SurfaceMeta;
-
-export {
-  parseRootSurfacePlugin,
-  parseSurfacePlugin,
-  useSurfaceRoot,
-  SurfaceProvider,
-  meta_default
-};
-//# sourceMappingURL=chunk-ERPIGFBI.mjs.map

package/dist/lib/node-esm/chunk-ERPIGFBI.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/plugins/SurfacePlugin/provides.ts", "../../../src/plugins/SurfacePlugin/SurfaceRootContext.tsx", "../../../src/plugins/SurfacePlugin/meta.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type SurfaceComponent, type SurfaceRootContext } from './SurfaceRootContext';\nimport { type Plugin } from '../PluginHost';\n\nexport type SurfaceProvides = {\n  surface: {\n    /**\n     * Used by the `Surface` resolver to find a component to render.\n     */\n    component: SurfaceComponent;\n  };\n};\n\nexport type SurfacePluginProvides = {\n  surface: SurfaceRootContext;\n};\n\nexport const parseRootSurfacePlugin = (plugin?: Plugin) =>\n  (plugin?.provides as any)?.surface?.components ? (plugin as Plugin<SurfacePluginProvides>) : undefined;\n\nexport const parseSurfacePlugin = (plugin?: Plugin) =>\n  (plugin?.provides as any)?.surface?.component ? (plugin as Plugin<SurfaceProvides>) : undefined;\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { createContext, useContext, type Context, type JSX, type Provider, type ForwardedRef } from 'react';\n\nimport { type SurfaceProps } from './Surface';\n\n// TODO(wittjosiah): Factor out.\ntype WithRequiredProperty<Type, Key extends keyof Type> = Type & {\n  [Property in Key]-?: Type[Property];\n};\n\ntype SurfaceComponentProps = WithRequiredProperty<SurfaceProps, 'data'>;\n\n/**\n * Determines the priority of the surface when multiple components are resolved.\n */\nexport type SurfaceDisposition = 'hoist' | 'fallback';\n\nexport type SurfaceResult = {\n  node: JSX.Element;\n  disposition?: SurfaceDisposition;\n};\n\n/**\n * Function which resolves a Surface.\n *\n * If a null value is returned, the rendering is deferred to other plugins.\n */\nexport type SurfaceComponent = (\n  props: SurfaceComponentProps,\n  forwardedRef: ForwardedRef<HTMLElement>,\n) => JSX.Element | SurfaceResult | null;\n\nexport type SurfaceRootContext = {\n  components: Record<string, SurfaceComponent>;\n};\n\nconst SurfaceRootContext: Context<SurfaceRootContext> = createContext<SurfaceRootContext>({ components: {} });\n\nexport const useSurfaceRoot = () => useContext(SurfaceRootContext);\n\nexport const SurfaceProvider: Provider<SurfaceRootContext> = SurfaceRootContext.Provider;\n", "//\n// Copyright 2023 DXOS.org\n//\n\nconst SurfaceMeta = {\n  id: 'dxos.org/plugin/surface',\n};\n\nexport default SurfaceMeta;\n"],
-  "mappings": ";;;AAoBO,IAAMA,yBAAyB,CAACC,WACpCA,QAAQC,UAAkBC,SAASC,aAAcH,SAA2CI;AAExF,IAAMC,qBAAqB,CAACL,WAChCA,QAAQC,UAAkBC,SAASI,YAAaN,SAAqCI;;;ACpBxF,SAASG,eAAeC,kBAA4E;AAmCpG,IAAMC,qBAAkDC,8BAAkC;EAAEC,YAAY,CAAC;AAAE,CAAA;AAEpG,IAAMC,iBAAiB,MAAMC,WAAWJ,kBAAAA;AAExC,IAAMK,kBAAgDL,mBAAmBM;;;ACvChF,IAAMC,cAAc;EAClBC,IAAI;AACN;AAEA,IAAA,eAAeD;",
-  "names": ["parseRootSurfacePlugin", "plugin", "provides", "surface", "components", "undefined", "parseSurfacePlugin", "component", "createContext", "useContext", "SurfaceRootContext", "createContext", "components", "useSurfaceRoot", "useContext", "SurfaceProvider", "Provider", "SurfaceMeta", "id"]
-}

package/dist/lib/node-esm/chunk-IY7HCP4K.mjs

@@ -1,22 +0,0 @@
-import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
-
-// packages/sdk/app-framework/src/plugins/helpers.ts
-import { raise } from "@dxos/debug";
-var definePlugin = (plugin) => plugin;
-var findPlugin = (plugins, id) => {
-  return plugins.find((plugin) => plugin.meta.id === id || typeof plugin.meta.shortId === "string" && plugin.meta.shortId === id);
-};
-var getPlugin = (plugins, id) => {
-  return findPlugin(plugins, id) ?? raise(new Error(`Plugin not found: ${id}`));
-};
-var filterPlugins = (plugins, predicate) => plugins.map((plugin) => predicate(plugin)).filter((plugin) => !!plugin);
-var resolvePlugin = (plugins, predicate) => filterPlugins(plugins, predicate)[0];
-
-export {
-  definePlugin,
-  findPlugin,
-  getPlugin,
-  filterPlugins,
-  resolvePlugin
-};
-//# sourceMappingURL=chunk-IY7HCP4K.mjs.map

package/dist/lib/node-esm/chunk-IY7HCP4K.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/plugins/helpers.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { raise } from '@dxos/debug';\n\nimport { type Plugin } from './PluginHost';\n\n/**\n * Define a plugin\n */\nexport const definePlugin = <TProvides>(plugin: Plugin<TProvides>): Plugin<TProvides> => plugin;\n\n/**\n * Find a plugin by ID.\n */\nexport const findPlugin = <T>(plugins: Plugin[], id: string): Plugin<T> | undefined => {\n  return plugins.find(\n    (plugin) => plugin.meta.id === id || (typeof plugin.meta.shortId === 'string' && plugin.meta.shortId === id),\n  ) as Plugin<T>;\n};\n\n/**\n * Find a plugin by ID, or raise an error if not found.\n */\nexport const getPlugin = <T>(plugins: Plugin[], id: string): Plugin<T> => {\n  return findPlugin(plugins, id) ?? raise(new Error(`Plugin not found: ${id}`));\n};\n\n/**\n * Filter a list of plugins to only those that match a predicate.\n */\nexport const filterPlugins = <T>(\n  plugins: Plugin[],\n  predicate: (plugin: Plugin) => Plugin<T> | undefined,\n): Plugin<T>[] => plugins.map((plugin) => predicate(plugin)).filter((plugin): plugin is Plugin<T> => !!plugin);\n\n/**\n * Resolves a plugin by predicate.\n *\n * @example\n * import { parseIntentPlugin, resolvePlugin } from '@dxos/app-framework';\n * const intentPlugin = resolvePlugin(plugins, parseIntentPlugin);\n */\nexport const resolvePlugin = <T>(\n  plugins: Plugin[],\n  predicate: (plugin: Plugin) => Plugin<T> | undefined,\n): Plugin<T> | undefined => filterPlugins(plugins, predicate)[0];\n"],
-  "mappings": ";;;AAIA,SAASA,aAAa;AAOf,IAAMC,eAAe,CAAYC,WAAiDA;AAKlF,IAAMC,aAAa,CAAIC,SAAmBC,OAAAA;AAC/C,SAAOD,QAAQE,KACb,CAACJ,WAAWA,OAAOK,KAAKF,OAAOA,MAAO,OAAOH,OAAOK,KAAKC,YAAY,YAAYN,OAAOK,KAAKC,YAAYH,EAAAA;AAE7G;AAKO,IAAMI,YAAY,CAAIL,SAAmBC,OAAAA;AAC9C,SAAOF,WAAWC,SAASC,EAAAA,KAAOK,MAAM,IAAIC,MAAM,qBAAqBN,EAAAA,EAAI,CAAA;AAC7E;AAKO,IAAMO,gBAAgB,CAC3BR,SACAS,cACgBT,QAAQU,IAAI,CAACZ,WAAWW,UAAUX,MAAAA,CAAAA,EAASa,OAAO,CAACb,WAAgC,CAAC,CAACA,MAAAA;AAShG,IAAMc,gBAAgB,CAC3BZ,SACAS,cAC0BD,cAAcR,SAASS,SAAAA,EAAW,CAAA;",
-  "names": ["raise", "definePlugin", "plugin", "findPlugin", "plugins", "id", "find", "meta", "shortId", "getPlugin", "raise", "Error", "filterPlugins", "predicate", "map", "filter", "resolvePlugin"]
-}

package/dist/lib/node-esm/chunk-P2TQLXZR.mjs

@@ -1,54 +0,0 @@
-import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
-
-// packages/sdk/app-framework/src/plugins/IntentPlugin/provides.ts
-var parseIntentPlugin = (plugin) => plugin.provides.intent?.dispatch ? plugin : void 0;
-var parseIntentResolverPlugin = (plugin) => plugin.provides.intent?.resolver ? plugin : void 0;
-var INTENT_ACTION = "dxos.org/plugin/intent";
-var IntentAction;
-(function(IntentAction2) {
-  IntentAction2[IntentAction2["SHOW_UNDO"] = `${INTENT_ACTION}/show-undo`] = "SHOW_UNDO";
-})(IntentAction || (IntentAction = {}));
-
-// packages/sdk/app-framework/src/plugins/IntentPlugin/IntentContext.tsx
-import { createContext, useContext } from "react";
-import { useEffect } from "react";
-var IntentContext = /* @__PURE__ */ createContext({
-  dispatch: async () => ({}),
-  undo: async () => ({}),
-  history: [],
-  registerResolver: () => () => {
-  }
-});
-var useIntent = () => useContext(IntentContext);
-var useIntentDispatcher = () => {
-  const { dispatch } = useIntent();
-  return dispatch;
-};
-var useIntentResolver = (plugin, resolver) => {
-  const { registerResolver } = useIntent();
-  useEffect(() => {
-    return registerResolver(plugin, resolver);
-  }, [
-    plugin,
-    resolver
-  ]);
-};
-var IntentProvider = IntentContext.Provider;
-
-// packages/sdk/app-framework/src/plugins/IntentPlugin/meta.ts
-var IntentMeta = {
-  id: "dxos.org/plugin/intent"
-};
-var meta_default = IntentMeta;
-
-export {
-  parseIntentPlugin,
-  parseIntentResolverPlugin,
-  IntentAction,
-  useIntent,
-  useIntentDispatcher,
-  useIntentResolver,
-  IntentProvider,
-  meta_default
-};
-//# sourceMappingURL=chunk-P2TQLXZR.mjs.map

package/dist/lib/node-esm/chunk-P2TQLXZR.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/plugins/IntentPlugin/provides.ts", "../../../src/plugins/IntentPlugin/IntentContext.tsx", "../../../src/plugins/IntentPlugin/meta.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type IntentContext } from './IntentContext';\nimport { type IntentResolver } from './intent';\nimport { type Plugin } from '../PluginHost';\n\nexport type IntentResolverProvides = {\n  intent: {\n    resolver: IntentResolver;\n  };\n};\n\nexport type IntentPluginProvides = {\n  intent: IntentContext;\n};\n\nexport const parseIntentPlugin = (plugin: Plugin) =>\n  (plugin.provides as any).intent?.dispatch ? (plugin as Plugin<IntentPluginProvides>) : undefined;\n\nexport const parseIntentResolverPlugin = (plugin: Plugin) =>\n  (plugin.provides as any).intent?.resolver ? (plugin as Plugin<IntentResolverProvides>) : undefined;\n\n//\n// Intents\n//\n\nconst INTENT_ACTION = 'dxos.org/plugin/intent';\nexport enum IntentAction {\n  /**\n   * Fired after an intent is dispatched if the intent is undoable.\n   */\n  SHOW_UNDO = `${INTENT_ACTION}/show-undo`,\n}\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { type Context, createContext, useContext, type Provider } from 'react';\nimport { useEffect } from 'react';\n\nimport type { UnsubscribeCallback } from '@dxos/async';\n\nimport type { Intent, IntentDispatcher, IntentResolver, IntentResult } from './intent';\n\nexport type IntentExecution = {\n  intent: Intent;\n  result: IntentResult;\n};\n\nexport type IntentContext = {\n  dispatch: IntentDispatcher;\n  undo: () => Promise<IntentResult | void>;\n  history: IntentExecution[][];\n  registerResolver: (pluginId: string, resolver: IntentResolver) => UnsubscribeCallback;\n};\n\nconst IntentContext: Context<IntentContext> = createContext<IntentContext>({\n  dispatch: async () => ({}),\n  undo: async () => ({}),\n  history: [],\n  registerResolver: () => () => {},\n});\n\n/**\n * @deprecated Prefer granular hooks.\n */\n// TODO(burdon): Remove. Use useIntentDispatcher.\nexport const useIntent = () => useContext(IntentContext);\n\nexport const useIntentDispatcher = (): IntentDispatcher => {\n  const { dispatch } = useIntent();\n  return dispatch;\n};\n\nexport const useIntentResolver = (plugin: string, resolver: IntentResolver) => {\n  const { registerResolver } = useIntent();\n  useEffect(() => {\n    return registerResolver(plugin, resolver);\n  }, [plugin, resolver]);\n};\n\nexport const IntentProvider: Provider<IntentContext> = IntentContext.Provider;\n", "//\n// Copyright 2023 DXOS.org\n//\n\nconst IntentMeta = {\n  id: 'dxos.org/plugin/intent',\n};\n\nexport default IntentMeta;\n"],
-  "mappings": ";;;AAkBO,IAAMA,oBAAoB,CAACC,WAC/BA,OAAOC,SAAiBC,QAAQC,WAAYH,SAA0CI;AAElF,IAAMC,4BAA4B,CAACL,WACvCA,OAAOC,SAAiBC,QAAQI,WAAYN,SAA4CI;AAM3F,IAAMG,gBAAgB;;UACVC,eAAAA;AAGT,EAAAA,cAAAA,cAAA,WAAA,IACW,GAAGD,aAAAA,YAAyB,IAAA;GAJ9BC,iBAAAA,eAAAA,CAAAA,EAAAA;;;ACzBZ,SAAuBC,eAAeC,kBAAiC;AACvE,SAASC,iBAAiB;AAkB1B,IAAMC,gBAAwCC,8BAA6B;EACzEC,UAAU,aAAa,CAAC;EACxBC,MAAM,aAAa,CAAC;EACpBC,SAAS,CAAA;EACTC,kBAAkB,MAAM,MAAA;EAAO;AACjC,CAAA;AAMO,IAAMC,YAAY,MAAMC,WAAWP,aAAAA;AAEnC,IAAMQ,sBAAsB,MAAA;AACjC,QAAM,EAAEN,SAAQ,IAAKI,UAAAA;AACrB,SAAOJ;AACT;AAEO,IAAMO,oBAAoB,CAACC,QAAgBC,aAAAA;AAChD,QAAM,EAAEN,iBAAgB,IAAKC,UAAAA;AAC7BM,YAAU,MAAA;AACR,WAAOP,iBAAiBK,QAAQC,QAAAA;EAClC,GAAG;IAACD;IAAQC;GAAS;AACvB;AAEO,IAAME,iBAA0Cb,cAAcc;;;AC5CrE,IAAMC,aAAa;EACjBC,IAAI;AACN;AAEA,IAAA,eAAeD;",
-  "names": ["parseIntentPlugin", "plugin", "provides", "intent", "dispatch", "undefined", "parseIntentResolverPlugin", "resolver", "INTENT_ACTION", "IntentAction", "createContext", "useContext", "useEffect", "IntentContext", "createContext", "dispatch", "undo", "history", "registerResolver", "useIntent", "useContext", "useIntentDispatcher", "useIntentResolver", "plugin", "resolver", "useEffect", "IntentProvider", "Provider", "IntentMeta", "id"]
-}