@dxos/app-framework 0.3.11-main.f5e7551 → 0.3.11-main.f7c1031

package/src/plugins/SurfacePlugin/Surface.tsx

@@ -4,12 +4,12 @@
 
 import React, {
   forwardRef,
-  type FC,
   type ReactNode,
   Fragment,
   type ForwardedRef,
   type PropsWithChildren,
   isValidElement,
+  Suspense,
 } from 'react';
 import { createContext, useContext } from 'react';
 
@@ -50,11 +50,10 @@ export type SurfaceProps = PropsWithChildren<{
   fallback?: ErrorBoundary['props']['fallback'];
 
   /**
-   * If specified, this will render if no plugin can offer renderable content for the surface.
-   *
-   * @deprecated Provide a component with `disposition: 'fallback'` instead.
+   * If specified, the Surface will be wrapped in a suspense boundary.
+   * The placeholder component will be rendered while the surface component is loading.
    */
-  contentFallback?: FC<{}>;
+  placeholder?: ReactNode;
 
   /**
    * If more than one component is resolved, the limit determines how many are rendered.
@@ -78,21 +77,20 @@ export type SurfaceProps = PropsWithChildren<{
  * A surface is a named region of the screen that can be populated by plugins.
  */
 export const Surface = forwardRef<HTMLElement, SurfaceProps>(
-  ({ role, name = role, fallback, ...rest }, forwardedRef) => {
+  ({ role, name = role, fallback, placeholder, ...rest }, forwardedRef) => {
     const props = { role, name, fallback, ...rest };
     const context = useContext(SurfaceContext);
     const data = props.data ?? ((name && context?.surfaces?.[name]?.data) || {});
 
-    return (
-      <>
-        {fallback ? (
-          <ErrorBoundary data={data} fallback={fallback}>
-            <SurfaceResolver {...props} ref={forwardedRef} />
-          </ErrorBoundary>
-        ) : (
-          <SurfaceResolver {...props} ref={forwardedRef} />
-        )}
-      </>
+    const resolver = <SurfaceResolver {...props} ref={forwardedRef} />;
+    const suspense = placeholder ? <Suspense fallback={placeholder}>{resolver}</Suspense> : resolver;
+
+    return fallback ? (
+      <ErrorBoundary data={data} fallback={fallback}>
+        {suspense}
+      </ErrorBoundary>
+    ) : (
+      suspense
     );
   },
 );
@@ -111,11 +109,7 @@ const SurfaceResolver = forwardRef<HTMLElement, SurfaceProps>((props, forwardedR
     },
   };
 
-  return (
-    <SurfaceContext.Provider value={currentContext}>
-      {nodes.length > 0 ? nodes : props.contentFallback ? <props.contentFallback /> : null}
-    </SurfaceContext.Provider>
-  );
+  return <SurfaceContext.Provider value={currentContext}>{nodes}</SurfaceContext.Provider>;
 });
 
 const resolveNodes = (

package/src/plugins/common/layout.ts

@@ -4,6 +4,7 @@
 
 import { z } from 'zod';
 
+import { type IntentData } from '../IntentPlugin';
 import type { Plugin } from '../PluginHost';
 
 //
@@ -65,40 +66,41 @@ export enum LayoutAction {
   OPEN_POPOVER = `${LAYOUT_ACTION}/open-popover`,
   CLOSE_POPOVER = `${LAYOUT_ACTION}/close-popover`,
   ACTIVATE = `${LAYOUT_ACTION}/activate`,
+  FOCUS = `${LAYOUT_ACTION}/focus`,
 }
 
 /**
  * Expected payload for layout actions.
  */
 export namespace LayoutAction {
-  export type ToggleFullscreen = {
+  export type ToggleFullscreen = IntentData<{
     state?: boolean;
-  };
+  }>;
 
-  export type ToggleSidebar = {
+  export type ToggleSidebar = IntentData<{
     state?: boolean;
-  };
+  }>;
 
-  export type ToggleComplementarySidebar = {
+  export type ToggleComplementarySidebar = IntentData<{
     state?: boolean;
-  };
+  }>;
 
-  export type OpenDialog = {
+  export type OpenDialog = IntentData<{
     component: string;
     subject: any;
-  };
+  }>;
 
-  export type CloseDialog = {};
+  export type CloseDialog = IntentData<{}>;
 
-  export type OpenPopover = {
+  export type OpenPopover = IntentData<{
     anchorId: string;
     component: string;
     subject: any;
-  };
+  }>;
 
-  export type ClosePopover = {};
+  export type ClosePopover = IntentData<{}>;
 
-  export type Activate = {
+  export type Activate = IntentData<{
     id: string;
-  };
+  }>;
 }

package/src/vite-env.d.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+/// <reference types="vite/client" />

package/tsconfig.json

@@ -32,6 +32,9 @@
     {
       "path": "../../common/log"
     },
+    {
+      "path": "../../common/util"
+    },
     {
       "path": "../app-graph"
     }

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

@@ -1,63 +0,0 @@
-import {
-  IntentProvider,
-  meta_default,
-  parseIntentResolverPlugin
-} from "./chunk-C2K6M6WC.mjs";
-import {
-  filterPlugins,
-  findPlugin
-} from "./chunk-CFZ5JAJF.mjs";
-
-// packages/sdk/app-framework/src/plugins/IntentPlugin/plugin.tsx
-import { deepSignal } from "deepsignal/react";
-import React from "react";
-var IntentPlugin = () => {
-  const state = deepSignal({
-    dispatch: async () => {
-    }
-  });
-  return {
-    meta: meta_default,
-    ready: async (plugins) => {
-      const dispatch = async (intent) => {
-        if (intent.plugin) {
-          const plugin = findPlugin(plugins, intent.plugin);
-          return plugin?.provides.intent.resolver(intent, plugins);
-        }
-        for (const plugin of filterPlugins(plugins, parseIntentResolverPlugin)) {
-          const result = await plugin.provides.intent.resolver(intent, plugins);
-          if (result) {
-            return result;
-          }
-        }
-      };
-      state.dispatch = async (intentOrArray) => {
-        let result = null;
-        for (const intent of Array.isArray(intentOrArray) ? intentOrArray : [
-          intentOrArray
-        ]) {
-          const data = intent.data ? {
-            ...result,
-            ...intent.data
-          } : result;
-          result = await dispatch({
-            ...intent,
-            data
-          });
-        }
-        return result;
-      };
-    },
-    provides: {
-      intent: state,
-      context: ({ children }) => /* @__PURE__ */ React.createElement(IntentProvider, {
-        value: state
-      }, children)
-    }
-  };
-};
-var plugin_default = IntentPlugin;
-export {
-  plugin_default as default
-};
-//# sourceMappingURL=plugin-CBPJO5NB.mjs.map

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"]
-}