@dxos/app-framework 0.3.10-next.ef70620 → 0.3.11-main.008b7c6

package/src/plugins/IntentPlugin/provides.ts

@@ -3,12 +3,12 @@
 //
 
 import { type IntentContext } from './IntentContext';
-import { type Intent } from './intent';
+import { type IntentResolver } from './intent';
 import { type Plugin } from '../PluginHost';
 
 export type IntentResolverProvides = {
   intent: {
-    resolver: (intent: Intent, plugins: Plugin[]) => any;
+    resolver: IntentResolver;
   };
 };
 

package/src/plugins/PluginHost/PluginContext.tsx

@@ -30,17 +30,9 @@ export type PluginContext = {
 
   /**
    * Mark plugin as enabled.
-   *
    * Requires reload to take effect.
    */
-  enablePlugin: (id: string) => void;
-
-  /**
-   * Mark plugin as disabled.
-   *
-   * Requires reload to take effect.
-   */
-  disablePlugin: (id: string) => void;
+  setPlugin: (id: string, enabled: boolean) => void;
 };
 
 const PluginContext: Context<PluginContext> = createContext<PluginContext>({
@@ -48,8 +40,7 @@ const PluginContext: Context<PluginContext> = createContext<PluginContext>({
   enabled: [],
   plugins: [],
   available: [],
-  enablePlugin: () => {},
-  disablePlugin: () => {},
+  setPlugin: () => {},
 });
 
 /**

package/src/plugins/PluginHost/PluginHost.tsx

@@ -43,11 +43,12 @@ export const PluginHost = ({
     enabled: [...defaults],
     plugins: [],
     available: order.filter(({ id }) => !core.includes(id)),
-    enablePlugin: (id: string) => {
-      state.values.enabled = [...state.values.enabled, id];
-    },
-    disablePlugin: (id: string) => {
-      state.values.enabled = state.values.enabled.filter((enabled) => enabled !== id);
+    setPlugin: (id: string, enabled: boolean) => {
+      if (enabled) {
+        state.values.enabled = [...state.values.enabled, id];
+      } else {
+        state.values.enabled = state.values.enabled.filter((enabled) => enabled !== id);
+      }
     },
   });
 

package/src/plugins/PluginHost/plugin.ts

@@ -54,6 +54,11 @@ export type Plugin<TProvides = {}> = {
      */
     description?: string;
 
+    /**
+     * URL of home page.
+     */
+    homePage?: string;
+
     /**
      * Tags to help categorize the plugin.
      */

package/src/plugins/common/index.ts

@@ -5,4 +5,5 @@
 export * from './graph';
 export * from './layout';
 export * from './metadata';
+export * from './settings';
 export * from './translations';

package/src/plugins/common/layout.ts

@@ -13,17 +13,19 @@ import type { Plugin } from '../PluginHost';
 /**
  * Basic state provided by a layout plugin.
  */
+// TODO(burdon): Josiah: why do we use zod here?
 export const Layout = z.object({
   fullscreen: z.boolean(),
   sidebarOpen: z.boolean(),
   complementarySidebarOpen: z.boolean(),
 
-  dialogContent: z.any().optional().describe('Data to be passed to the dialog Surface.'),
+  // TODO(burdon): Why do we have a single root?
   dialogOpen: z.boolean(),
+  dialogContent: z.any().optional().describe('Data to be passed to the dialog Surface.'),
 
-  popoverAnchorId: z.string().optional(),
-  popoverContent: z.any().optional().describe('Data to be passed to the popover Surface.'),
   popoverOpen: z.boolean(),
+  popoverContent: z.any().optional().describe('Data to be passed to the popover Surface.'),
+  popoverAnchorId: z.string().optional(),
 
   // TODO(wittjosiah): Array?
   active: z.string().optional().describe('Id of the currently active item.'),
@@ -52,7 +54,7 @@ export const parseLayoutPlugin = (plugin: Plugin) => {
 // Intents
 //
 
-const LAYOUT_ACTION = 'dxos.org/plugin/intent';
+const LAYOUT_ACTION = 'dxos.org/plugin/layout';
 // TODO(wittjosiah): Consider consolidating some action types (e.g. toggle).
 export enum LayoutAction {
   TOGGLE_FULLSCREEN = `${LAYOUT_ACTION}/toggle-fullscreen`,
@@ -63,6 +65,7 @@ export enum LayoutAction {
   OPEN_POPOVER = `${LAYOUT_ACTION}/open-popover`,
   CLOSE_POPOVER = `${LAYOUT_ACTION}/close-popover`,
   ACTIVATE = `${LAYOUT_ACTION}/activate`,
+  FOCUS = `${LAYOUT_ACTION}/focus`,
 }
 
 /**

package/src/plugins/common/settings.ts

@@ -0,0 +1,22 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Plugin } from '../PluginHost';
+
+// TODO(burdon): Plugins should export ts-effect object (see local-storage).
+// TODO(burdon): Auto generate form.
+// TODO(burdon): Set surface's data.type to plugin id (allow custom settings surface).
+
+export type SettingsProvides<T extends Record<string, any> = Record<string, any>> = {
+  settings: T; // TODO(burdon): Read-only.
+};
+
+export const parseSettingsPlugin = (plugin: Plugin) => {
+  return typeof (plugin.provides as any).settings === 'object' ? (plugin as Plugin<SettingsProvides>) : undefined;
+};
+
+const SETTINGS_ACTION = 'dxos.org/plugin/settings';
+export enum SettingsAction {
+  OPEN = `${SETTINGS_ACTION}/open`,
+}

package/dist/lib/browser/chunk-C2K6M6WC.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 Intent } from './intent';\nimport { type Plugin } from '../PluginHost';\n\nexport type IntentResolverProvides = {\n  intent: {\n    resolver: (intent: Intent, plugins: Plugin[]) => any;\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// Copyright 2023 DXOS.org\n//\n\nimport { type Context, createContext, useContext, type Provider } from 'react';\n\nimport { type DispatchIntent } from './intent';\n\nexport type IntentContext = {\n  dispatch: DispatchIntent;\n};\n\nconst IntentContext: Context<IntentContext> = createContext<IntentContext>({ dispatch: async () => {} });\n\nexport const useIntent = () => useContext(IntentContext);\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;;;AClB3F,SAAuBG,eAAeC,kBAAiC;AAQvE,IAAMC,gBAAwCC,8BAA6B;EAAEC,UAAU,YAAA;EAAa;AAAE,CAAA;AAE/F,IAAMC,YAAY,MAAMC,WAAWJ,aAAAA;AAEnC,IAAMK,iBAA0CL,cAAcM;;;ACZrE,IAAMC,aAAa;EACjBC,IAAI;AACN;AAEA,IAAA,eAAeD;",
-  "names": ["parseIntentPlugin", "plugin", "provides", "intent", "dispatch", "undefined", "parseIntentResolverPlugin", "resolver", "createContext", "useContext", "IntentContext", "createContext", "dispatch", "useIntent", "useContext", "IntentProvider", "Provider", "IntentMeta", "id"]
-}

package/dist/lib/browser/plugin-CBPJO5NB.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/plugins/IntentPlugin/plugin.tsx"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { deepSignal } from 'deepsignal/react';\nimport React from 'react';\n\nimport { type IntentContext, IntentProvider } from './IntentContext';\nimport type { Intent } from './intent';\nimport IntentMeta from './meta';\nimport { type IntentPluginProvides, type IntentResolverProvides, parseIntentResolverPlugin } from './provides';\nimport type { PluginDefinition } from '../PluginHost';\nimport { filterPlugins, findPlugin } from '../helpers';\n\n/**\n * Allows plugins to register intent handlers and routes sent intents to the appropriate plugin.\n * Inspired by https://developer.android.com/reference/android/content/Intent.\n */\nconst IntentPlugin = (): PluginDefinition<IntentPluginProvides> => {\n  const state = deepSignal<IntentContext>({ dispatch: async () => {} });\n\n  return {\n    meta: IntentMeta,\n    ready: async (plugins) => {\n      // Dispatch intent to associated plugin.\n      const dispatch = async (intent: Intent) => {\n        if (intent.plugin) {\n          const plugin = findPlugin<IntentResolverProvides>(plugins, intent.plugin);\n          return plugin?.provides.intent.resolver(intent, plugins);\n        }\n\n        // Return resolved value from first plugin that handles the intent.\n        for (const plugin of filterPlugins(plugins, parseIntentResolverPlugin)) {\n          const result = await plugin.provides.intent.resolver(intent, plugins);\n          if (result) {\n            return result;\n          }\n        }\n      };\n\n      // Sequentially dispatch array of invents.\n      state.dispatch = async (intentOrArray) => {\n        let result: any = null;\n        for (const intent of Array.isArray(intentOrArray) ? intentOrArray : [intentOrArray]) {\n          const data = intent.data ? { ...result, ...intent.data } : result;\n          result = await dispatch({ ...intent, data });\n        }\n        return result;\n      };\n    },\n    provides: {\n      intent: state,\n      context: ({ children }) => <IntentProvider value={state}>{children}</IntentProvider>,\n    },\n  };\n};\n\nexport default IntentPlugin;\n"],
-  "mappings": ";;;;;;;;;;;AAIA,SAASA,kBAAkB;AAC3B,OAAOC,WAAW;AAalB,IAAMC,eAAe,MAAA;AACnB,QAAMC,QAAQC,WAA0B;IAAEC,UAAU,YAAA;IAAa;EAAE,CAAA;AAEnE,SAAO;IACLC,MAAMC;IACNC,OAAO,OAAOC,YAAAA;AAEZ,YAAMJ,WAAW,OAAOK,WAAAA;AACtB,YAAIA,OAAOC,QAAQ;AACjB,gBAAMA,SAASC,WAAmCH,SAASC,OAAOC,MAAM;AACxE,iBAAOA,QAAQE,SAASH,OAAOI,SAASJ,QAAQD,OAAAA;QAClD;AAGA,mBAAWE,UAAUI,cAAcN,SAASO,yBAAAA,GAA4B;AACtE,gBAAMC,SAAS,MAAMN,OAAOE,SAASH,OAAOI,SAASJ,QAAQD,OAAAA;AAC7D,cAAIQ,QAAQ;AACV,mBAAOA;UACT;QACF;MACF;AAGAd,YAAME,WAAW,OAAOa,kBAAAA;AACtB,YAAID,SAAc;AAClB,mBAAWP,UAAUS,MAAMC,QAAQF,aAAAA,IAAiBA,gBAAgB;UAACA;WAAgB;AACnF,gBAAMG,OAAOX,OAAOW,OAAO;YAAE,GAAGJ;YAAQ,GAAGP,OAAOW;UAAK,IAAIJ;AAC3DA,mBAAS,MAAMZ,SAAS;YAAE,GAAGK;YAAQW;UAAK,CAAA;QAC5C;AACA,eAAOJ;MACT;IACF;IACAJ,UAAU;MACRH,QAAQP;MACRmB,SAAS,CAAC,EAAEC,SAAQ,MAAO,sBAAA,cAACC,gBAAAA;QAAeC,OAAOtB;SAAQoB,QAAAA;IAC5D;EACF;AACF;AAEA,IAAA,iBAAerB;",
-  "names": ["deepSignal", "React", "IntentPlugin", "state", "deepSignal", "dispatch", "meta", "IntentMeta", "ready", "plugins", "intent", "plugin", "findPlugin", "provides", "resolver", "filterPlugins", "parseIntentResolverPlugin", "result", "intentOrArray", "Array", "isArray", "data", "context", "children", "IntentProvider", "value"]
-}

package/dist/lib/node/chunk-BOQBLWMX.cjs.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 Intent } from './intent';\nimport { type Plugin } from '../PluginHost';\n\nexport type IntentResolverProvides = {\n  intent: {\n    resolver: (intent: Intent, plugins: Plugin[]) => any;\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// Copyright 2023 DXOS.org\n//\n\nimport { type Context, createContext, useContext, type Provider } from 'react';\n\nimport { type DispatchIntent } from './intent';\n\nexport type IntentContext = {\n  dispatch: DispatchIntent;\n};\n\nconst IntentContext: Context<IntentContext> = createContext<IntentContext>({ dispatch: async () => {} });\n\nexport const useIntent = () => useContext(IntentContext);\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": ";;;;;;;;;;;;;;;;;;;;;;;;;;;ACIA,mBAAuE;ADchE,IAAMA,oBAAoB,CAACC,WAC/BA,OAAOC,SAAiBC,QAAQC,WAAYH,SAA0CI;AAElF,IAAMC,4BAA4B,CAACL,WACvCA,OAAOC,SAAiBC,QAAQI,WAAYN,SAA4CI;ACV3F,IAAMG,gBAAwCC,gDAA6B;EAAEL,UAAU,YAAA;EAAa;AAAE,CAAA;AAE/F,IAAMM,YAAY,UAAMC,yBAAWH,aAAAA;AAEnC,IAAMI,iBAA0CJ,cAAcK;ACZrE,IAAMC,aAAa;EACjBC,IAAI;AACN;AAEA,IAAA,eAAeD;",
-  "names": ["parseIntentPlugin", "plugin", "provides", "intent", "dispatch", "undefined", "parseIntentResolverPlugin", "resolver", "IntentContext", "createContext", "useIntent", "useContext", "IntentProvider", "Provider", "IntentMeta", "id"]
-}

package/dist/lib/node/plugin-WDNRX2SR.cjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/plugins/IntentPlugin/plugin.tsx"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { deepSignal } from 'deepsignal/react';\nimport React from 'react';\n\nimport { type IntentContext, IntentProvider } from './IntentContext';\nimport type { Intent } from './intent';\nimport IntentMeta from './meta';\nimport { type IntentPluginProvides, type IntentResolverProvides, parseIntentResolverPlugin } from './provides';\nimport type { PluginDefinition } from '../PluginHost';\nimport { filterPlugins, findPlugin } from '../helpers';\n\n/**\n * Allows plugins to register intent handlers and routes sent intents to the appropriate plugin.\n * Inspired by https://developer.android.com/reference/android/content/Intent.\n */\nconst IntentPlugin = (): PluginDefinition<IntentPluginProvides> => {\n  const state = deepSignal<IntentContext>({ dispatch: async () => {} });\n\n  return {\n    meta: IntentMeta,\n    ready: async (plugins) => {\n      // Dispatch intent to associated plugin.\n      const dispatch = async (intent: Intent) => {\n        if (intent.plugin) {\n          const plugin = findPlugin<IntentResolverProvides>(plugins, intent.plugin);\n          return plugin?.provides.intent.resolver(intent, plugins);\n        }\n\n        // Return resolved value from first plugin that handles the intent.\n        for (const plugin of filterPlugins(plugins, parseIntentResolverPlugin)) {\n          const result = await plugin.provides.intent.resolver(intent, plugins);\n          if (result) {\n            return result;\n          }\n        }\n      };\n\n      // Sequentially dispatch array of invents.\n      state.dispatch = async (intentOrArray) => {\n        let result: any = null;\n        for (const intent of Array.isArray(intentOrArray) ? intentOrArray : [intentOrArray]) {\n          const data = intent.data ? { ...result, ...intent.data } : result;\n          result = await dispatch({ ...intent, data });\n        }\n        return result;\n      };\n    },\n    provides: {\n      intent: state,\n      context: ({ children }) => <IntentProvider value={state}>{children}</IntentProvider>,\n    },\n  };\n};\n\nexport default IntentPlugin;\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,mBAA2B;AAC3B,IAAAA,gBAAkB;AAalB,IAAMC,eAAe,MAAA;AACnB,QAAMC,YAAQC,yBAA0B;IAAEC,UAAU,YAAA;IAAa;EAAE,CAAA;AAEnE,SAAO;IACLC,MAAMC;IACNC,OAAO,OAAOC,YAAAA;AAEZ,YAAMJ,WAAW,OAAOK,WAAAA;AACtB,YAAIA,OAAOC,QAAQ;AACjB,gBAAMA,aAASC,kCAAmCH,SAASC,OAAOC,MAAM;AACxE,iBAAOA,QAAQE,SAASH,OAAOI,SAASJ,QAAQD,OAAAA;QAClD;AAGA,mBAAWE,cAAUI,qCAAcN,SAASO,+CAAAA,GAA4B;AACtE,gBAAMC,SAAS,MAAMN,OAAOE,SAASH,OAAOI,SAASJ,QAAQD,OAAAA;AAC7D,cAAIQ,QAAQ;AACV,mBAAOA;UACT;QACF;MACF;AAGAd,YAAME,WAAW,OAAOa,kBAAAA;AACtB,YAAID,SAAc;AAClB,mBAAWP,UAAUS,MAAMC,QAAQF,aAAAA,IAAiBA,gBAAgB;UAACA;WAAgB;AACnF,gBAAMG,OAAOX,OAAOW,OAAO;YAAE,GAAGJ;YAAQ,GAAGP,OAAOW;UAAK,IAAIJ;AAC3DA,mBAAS,MAAMZ,SAAS;YAAE,GAAGK;YAAQW;UAAK,CAAA;QAC5C;AACA,eAAOJ;MACT;IACF;IACAJ,UAAU;MACRH,QAAQP;MACRmB,SAAS,CAAC,EAAEC,SAAQ,MAAO,8BAAAC,QAAA,cAACC,sCAAAA;QAAeC,OAAOvB;SAAQoB,QAAAA;IAC5D;EACF;AACF;AAEA,IAAA,iBAAerB;",
-  "names": ["import_react", "IntentPlugin", "state", "deepSignal", "dispatch", "meta", "IntentMeta", "ready", "plugins", "intent", "plugin", "findPlugin", "provides", "resolver", "filterPlugins", "parseIntentResolverPlugin", "result", "intentOrArray", "Array", "isArray", "data", "context", "children", "React", "IntentProvider", "value"]
-}