@dxos/app-framework 0.3.3-main.3806cc2

package/.eslintrc.js

@@ -0,0 +1,9 @@
+module.exports = {
+  "extends": [
+    "../../../.eslintrc.js"
+  ],
+  "parserOptions": {
+    "project": "tsconfig.json",
+    "tsconfigRootDir": __dirname,
+  }
+}

package/.storybook/main.cjs

@@ -0,0 +1,36 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+const { mergeConfig } = require('vite');
+const { resolve } = require('path');
+
+const { ThemePlugin } = require('@dxos/react-ui-theme/plugin');
+
+module.exports = {
+  stories: ['../src/**/*.stories.mdx', '../src/**/*.stories.@(js|jsx|ts|tsx)'],
+  addons: [
+    '@storybook/addon-links',
+    '@storybook/addon-essentials',
+    '@storybook/addon-interactions'
+  ],
+  framework: {
+    name: '@storybook/react-vite',
+    options: {
+      // TODO(wittjosiah): Enable strict mode.
+      strictMode: false
+    }
+  },
+  viteFinal: async (config) =>
+    mergeConfig(config, {
+      plugins: [
+        ThemePlugin({
+          root: __dirname,
+          content: [
+            resolve(__dirname, '../src') + '/**/*.{ts,tsx,js,jsx}',
+            resolve(__dirname, '../node_modules/@dxos/kai-frames/dist/**/*.mjs')
+          ]
+        })
+      ]
+    })
+};

package/.storybook/preview-head.html

@@ -0,0 +1,3 @@
+<script>
+  window.global = window;
+</script>

package/.storybook/preview.cjs

@@ -0,0 +1,45 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+// import React, { createElement, useEffect } from 'react';
+// import { ThemeProvider } from '@dxos/react-appkit';
+
+export const parameters = {
+  actions: { argTypesRegex: '^on[A-Z].*' },
+  controls: {
+    matchers: {
+      color: /(background|color)$/i,
+      date: /Date$/
+    }
+  }
+};
+
+export const globalTypes = {
+  theme: {
+    name: 'Theme',
+    description: 'Global theme for components',
+    defaultValue: 'light',
+    toolbar: {
+      // The icon for the toolbar item
+      icon: 'circlehollow',
+      // Array of options
+      items: [
+        { value: 'light', icon: 'circlehollow', title: 'light' },
+        { value: 'dark', icon: 'circle', title: 'dark' },
+      ],
+      // Property that specifies if the name of the item will be displayed
+      showName: true,
+    },
+  },
+}
+
+// const withTheme = (StoryFn, context) => {
+//   const theme = context?.parameters?.theme || context?.globals?.theme;
+//   useEffect(()=>{
+//     document.documentElement.classList[theme === 'dark' ? 'add' : 'remove']('dark')
+//   }, [theme])
+//   return createElement(ThemeProvider, {children: createElement(StoryFn)})
+// }
+
+// export const decorators = [withTheme];

package/LICENSE

@@ -0,0 +1,8 @@
+MIT License 
+Copyright (c) 2022 DXOS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,29 @@
+# @dxos/app-framework
+
+A framework for building applications from composible plugins.
+
+## Installation
+
+```bash
+pnpm i @dxos/app-framework
+```
+
+## Usage
+
+Run with
+
+```bash
+pnpm nx storybook app-framework
+```
+
+## DXOS Resources
+
+- [Website](https://dxos.org)
+- [Developer Documentation](https://docs.dxos.org)
+- Talk to us on [Discord](https://discord.gg/eXVfryv3sW)
+
+## Contributions
+
+Your ideas, issues, and code are most welcome. Please take a look at our [community code of conduct](https://github.com/dxos/dxos/blob/main/CODE_OF_CONDUCT.md), the [issue guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-issues), and the [PR contribution guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-prs).
+
+License: [MIT](./LICENSE) Copyright 2022 © DXOS

package/README.yml

@@ -0,0 +1,5 @@
+usage: |
+  Run with 
+  ```bash
+  pnpm nx storybook surface
+  ```

package/dist/lib/browser/index.mjs

@@ -0,0 +1,453 @@
+// packages/sdk/app-framework/src/plugins/common/graph.ts
+var parseGraphPlugin = (plugin) => plugin.provides.graph?.root ? plugin : void 0;
+var parseGraphBuilderPlugin = (plugin) => plugin.provides.graph?.builder ? plugin : void 0;
+
+// packages/sdk/app-framework/src/plugins/common/layout.ts
+import { z } from "zod";
+var 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."),
+  dialogOpen: z.boolean(),
+  popoverAnchorId: z.string().optional(),
+  popoverContent: z.any().optional().describe("Data to be passed to the popover Surface."),
+  popoverOpen: z.boolean(),
+  // TODO(wittjosiah): Array?
+  active: z.string().optional().describe("Id of the currently active item."),
+  // TODO(wittjosiah): History?
+  previous: z.string().optional()
+});
+var parseLayoutPlugin = (plugin) => {
+  const { success } = Layout.safeParse(plugin.provides.layout);
+  return success ? plugin : void 0;
+};
+var LAYOUT_ACTION = "dxos.org/plugin/intent";
+var LayoutAction;
+(function(LayoutAction2) {
+  LayoutAction2[LayoutAction2["TOGGLE_FULLSCREEN"] = `${LAYOUT_ACTION}/toggle-fullscreen`] = "TOGGLE_FULLSCREEN";
+  LayoutAction2[LayoutAction2["TOGGLE_SIDEBAR"] = `${LAYOUT_ACTION}/toggle-sidebar`] = "TOGGLE_SIDEBAR";
+  LayoutAction2[LayoutAction2["TOGGLE_COMPLEMENTARY_SIDEBAR"] = `${LAYOUT_ACTION}/toggle-complementary-sidebar`] = "TOGGLE_COMPLEMENTARY_SIDEBAR";
+  LayoutAction2[LayoutAction2["OPEN_DIALOG"] = `${LAYOUT_ACTION}/open-dialog`] = "OPEN_DIALOG";
+  LayoutAction2[LayoutAction2["CLOSE_DIALOG"] = `${LAYOUT_ACTION}/close-dialog`] = "CLOSE_DIALOG";
+  LayoutAction2[LayoutAction2["OPEN_POPOVER"] = `${LAYOUT_ACTION}/open-popover`] = "OPEN_POPOVER";
+  LayoutAction2[LayoutAction2["CLOSE_POPOVER"] = `${LAYOUT_ACTION}/close-popover`] = "CLOSE_POPOVER";
+  LayoutAction2[LayoutAction2["ACTIVATE"] = `${LAYOUT_ACTION}/activate`] = "ACTIVATE";
+})(LayoutAction || (LayoutAction = {}));
+
+// packages/sdk/app-framework/src/plugins/common/translations.ts
+import { z as z2 } from "zod";
+var ResourceKey = z2.union([
+  z2.string(),
+  z2.record(z2.any())
+]);
+var ResourceLanguage = z2.record(ResourceKey);
+var Resource = z2.record(ResourceLanguage);
+var parseTranslationsPlugin = (plugin) => {
+  const { success } = z2.array(Resource).safeParse(plugin.provides.translations);
+  return success ? plugin : void 0;
+};
+
+// packages/sdk/app-framework/src/plugins/helpers.ts
+import { raise } from "@dxos/debug";
+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];
+
+// packages/sdk/app-framework/src/plugins/IntentPlugin/IntentContext.tsx
+import { createContext, useContext } from "react";
+var IntentContext = /* @__PURE__ */ createContext({
+  dispatch: async () => {
+  }
+});
+var useIntent = () => useContext(IntentContext);
+var IntentProvider = IntentContext.Provider;
+
+// packages/sdk/app-framework/src/plugins/IntentPlugin/IntentPlugin.tsx
+import { deepSignal } from "deepsignal/react";
+import React from "react";
+var parseIntentPlugin = (plugin) => plugin.provides.intent?.dispatch ? plugin : void 0;
+var parseIntentResolverPlugin = (plugin) => plugin.provides.intent?.resolver ? plugin : void 0;
+var IntentPlugin = () => {
+  const state = deepSignal({
+    dispatch: async () => {
+    }
+  });
+  return {
+    meta: {
+      id: "dxos.org/plugin/intent"
+    },
+    ready: async (plugins) => {
+      const dispatch = (intent) => {
+        if (intent.plugin) {
+          const plugin = findPlugin(plugins, intent.plugin);
+          return plugin?.provides.intent.resolver(intent, plugins);
+        }
+        return filterPlugins(plugins, parseIntentResolverPlugin).reduce((acc, plugin) => {
+          return acc ?? plugin.provides.intent.resolver(intent, plugins);
+        }, void 0);
+      };
+      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)
+    }
+  };
+};
+
+// packages/sdk/app-framework/src/plugins/PluginHost/PluginContext.tsx
+import { createContext as createContext2, useContext as useContext2 } from "react";
+var PluginContext = /* @__PURE__ */ createContext2({
+  ready: false,
+  initializing: [],
+  loading: [],
+  plugins: []
+});
+var usePlugins = () => useContext2(PluginContext);
+var usePlugin = (id) => {
+  const { plugins } = usePlugins();
+  return findPlugin(plugins, id);
+};
+var useResolvePlugin = (predicate) => {
+  const { plugins } = usePlugins();
+  return resolvePlugin(plugins, predicate);
+};
+var PluginProvider = PluginContext.Provider;
+
+// packages/sdk/app-framework/src/plugins/PluginHost/PluginHost.tsx
+import { deepSignal as deepSignal2, shallow } from "deepsignal/react";
+import React2, { useEffect } from "react";
+import { log } from "@dxos/log";
+var __dxlog_file = "/home/runner/work/dxos/dxos/packages/sdk/app-framework/src/plugins/PluginHost/PluginHost.tsx";
+var parsePluginHost = (plugin) => plugin.provides.plugins ? plugin : void 0;
+var PluginHost = ({ plugins: definitions, fallback }) => {
+  const state = deepSignal2({
+    ready: false,
+    initializing: [],
+    loading: [],
+    plugins: []
+  });
+  return {
+    meta: {
+      id: "dxos.org/plugin/host"
+    },
+    provides: {
+      plugins: state,
+      context: ({ children }) => /* @__PURE__ */ React2.createElement(PluginProvider, {
+        value: state
+      }, children),
+      root: () => {
+        useEffect(() => {
+          log("initializing plugins", {
+            definitions
+          }, {
+            F: __dxlog_file,
+            L: 43,
+            S: void 0,
+            C: (f, a) => f(...a)
+          });
+          const timeout = setTimeout(async () => {
+            state.initializing = shallow(definitions);
+            const plugins = await Promise.all(definitions.map(async (definition) => {
+              const plugin = await initializePlugin(definition).catch((err) => {
+                console.error("Failed to initialize plugin:", definition.meta.id, err);
+                return void 0;
+              });
+              state.initializing = shallow(state.initializing.filter((plugin2) => plugin2 !== definition));
+              return plugin;
+            })).then((plugins2) => plugins2.filter((plugin) => Boolean(plugin)));
+            log("plugins initialized", {
+              plugins
+            }, {
+              F: __dxlog_file,
+              L: 57,
+              S: void 0,
+              C: (f, a) => f(...a)
+            });
+            state.loading = shallow(definitions);
+            await Promise.all(definitions.map(async (pluginDefinition) => {
+              await pluginDefinition.ready?.(plugins);
+              state.loading = shallow(state.loading.filter((plugin) => plugin !== pluginDefinition));
+            }));
+            log("plugins ready", {
+              plugins
+            }, {
+              F: __dxlog_file,
+              L: 66,
+              S: void 0,
+              C: (f, a) => f(...a)
+            });
+            state.plugins = shallow(plugins);
+            state.ready = true;
+          });
+          return () => {
+            clearTimeout(timeout);
+            state.ready = false;
+            void Promise.all(definitions.map((definition) => definition.unload?.()));
+          };
+        }, []);
+        if (!state.ready) {
+          if (typeof fallback === "function") {
+            const FallbackComponent = fallback;
+            return /* @__PURE__ */ React2.createElement(FallbackComponent, {
+              initializing: state.initializing,
+              loading: state.loading,
+              plugins: state.plugins
+            });
+          }
+          return /* @__PURE__ */ React2.createElement(React2.Fragment, null, fallback ?? null);
+        }
+        const ComposedContext = composeContext(state.plugins);
+        return /* @__PURE__ */ React2.createElement(ComposedContext, null, rootComponents(state.plugins));
+      }
+    }
+  };
+};
+var initializePlugin = async (pluginDefinition) => {
+  const provides = await pluginDefinition.initialize?.();
+  return {
+    ...pluginDefinition,
+    provides: {
+      ...pluginDefinition.provides,
+      ...provides
+    }
+  };
+};
+var rootComponents = (plugins) => {
+  return plugins.map((plugin) => {
+    const Component2 = plugin.provides.root;
+    if (Component2) {
+      return /* @__PURE__ */ React2.createElement(Component2, {
+        key: plugin.meta.id
+      });
+    } else {
+      return null;
+    }
+  }).filter((node) => Boolean(node));
+};
+var composeContext = (plugins) => {
+  return compose(plugins.map((p) => p.provides.context).filter(Boolean));
+};
+var compose = (contexts) => {
+  return [
+    ...contexts
+  ].reduce((Acc, Next) => ({ children }) => /* @__PURE__ */ React2.createElement(Acc, null, /* @__PURE__ */ React2.createElement(Next, null, children)));
+};
+
+// packages/sdk/app-framework/src/plugins/SurfacePlugin/ErrorBoundary.tsx
+import React3, { Component } from "react";
+var ErrorBoundary = class extends Component {
+  constructor(props) {
+    super(props);
+    this.state = {
+      error: void 0
+    };
+  }
+  static getDerivedStateFromError(error) {
+    return {
+      error
+    };
+  }
+  componentDidUpdate(prevProps) {
+    if (prevProps.data !== this.props.data) {
+      this.resetError();
+    }
+  }
+  render() {
+    if (this.state.error) {
+      return /* @__PURE__ */ React3.createElement(this.props.fallback, {
+        error: this.state.error,
+        reset: this.resetError
+      });
+    }
+    return this.props.children;
+  }
+  resetError() {
+    this.setState({
+      error: void 0
+    });
+  }
+};
+
+// packages/sdk/app-framework/src/plugins/SurfacePlugin/Surface.tsx
+import React4 from "react";
+import { createContext as createContext4, useContext as useContext4 } from "react";
+
+// packages/sdk/app-framework/src/plugins/SurfacePlugin/SurfaceRootContext.tsx
+import { createContext as createContext3, useContext as useContext3 } from "react";
+var SurfaceRootContext = /* @__PURE__ */ createContext3({
+  components: {}
+});
+var useSurface = () => useContext3(SurfaceRootContext);
+var SurfaceProvider = SurfaceRootContext.Provider;
+
+// packages/sdk/app-framework/src/plugins/SurfacePlugin/Surface.tsx
+var Surface = ({ role, name = role, fallback, ...rest }) => {
+  const props = {
+    role,
+    name,
+    fallback,
+    ...rest
+  };
+  const context = useContext4(SurfaceContext);
+  const data = props.data ?? (name && context?.surfaces?.[name]?.data || {});
+  return /* @__PURE__ */ React4.createElement(React4.Fragment, null, fallback ? /* @__PURE__ */ React4.createElement(ErrorBoundary, {
+    data,
+    fallback
+  }, /* @__PURE__ */ React4.createElement(SurfaceResolver, props)) : /* @__PURE__ */ React4.createElement(SurfaceResolver, props));
+};
+var SurfaceContext = /* @__PURE__ */ createContext4(null);
+var SurfaceResolver = (props) => {
+  const { components } = useSurface();
+  const parent = useContext4(SurfaceContext);
+  const nodes = resolveNodes(components, props, parent);
+  const currentContext = {
+    ...props,
+    surfaces: {
+      ...props.name && parent?.surfaces?.[props.name]?.surfaces || {},
+      ...props.surfaces
+    }
+  };
+  return /* @__PURE__ */ React4.createElement(SurfaceContext.Provider, {
+    value: currentContext
+  }, nodes);
+};
+var resolveNodes = (components, props, context) => {
+  const data = {
+    ...props.name && context?.surfaces?.[props.name]?.data || {},
+    ...props.data
+  };
+  const nodes = Object.entries(components).map(([key, component]) => {
+    const result = component(data, props.role);
+    return result ? /* @__PURE__ */ React4.createElement(Wrapper, {
+      key
+    }, result) : void 0;
+  }).filter((Component2) => Boolean(Component2));
+  return props.limit ? nodes.slice(0, props.limit) : nodes;
+};
+var Wrapper = ({ children }) => /* @__PURE__ */ React4.createElement(React4.Fragment, null, children);
+
+// packages/sdk/app-framework/src/plugins/SurfacePlugin/SurfacePlugin.tsx
+import { deepSignal as deepSignal3, shallow as shallow2 } from "deepsignal/react";
+import React5 from "react";
+var parseRootSurfacePlugin = (plugin) => plugin?.provides?.surface?.components ? plugin : void 0;
+var parseSurfacePlugin = (plugin) => plugin?.provides?.surface?.component ? plugin : void 0;
+var SurfacePlugin = () => {
+  const state = deepSignal3({
+    components: {}
+  });
+  return {
+    meta: {
+      id: "dxos.org/plugin/surface"
+    },
+    ready: async (plugins) => {
+      state.components = shallow2(filterPlugins(plugins, parseSurfacePlugin).reduce((acc, plugin) => {
+        return {
+          ...acc,
+          [plugin.meta.id]: plugin.provides.surface.component
+        };
+      }, {}));
+    },
+    provides: {
+      surface: state,
+      context: ({ children }) => /* @__PURE__ */ React5.createElement(SurfaceProvider, {
+        value: state
+      }, children)
+    }
+  };
+};
+
+// packages/sdk/app-framework/src/App.tsx
+import React6 from "react";
+import { invariant } from "@dxos/invariant";
+var __dxlog_file2 = "/home/runner/work/dxos/dxos/packages/sdk/app-framework/src/App.tsx";
+var createApp = ({ plugins, fallback }) => {
+  const host = PluginHost({
+    plugins: [
+      SurfacePlugin(),
+      IntentPlugin(),
+      ...plugins
+    ],
+    fallback
+  });
+  invariant(host.provides?.context, void 0, {
+    F: __dxlog_file2,
+    L: 33,
+    S: void 0,
+    A: [
+      "host.provides?.context",
+      ""
+    ]
+  });
+  invariant(host.provides?.root, void 0, {
+    F: __dxlog_file2,
+    L: 34,
+    S: void 0,
+    A: [
+      "host.provides?.root",
+      ""
+    ]
+  });
+  const Context = host.provides.context;
+  const Root = host.provides.root;
+  return () => /* @__PURE__ */ React6.createElement(Context, null, /* @__PURE__ */ React6.createElement(Root, null));
+};
+export {
+  ErrorBoundary,
+  IntentPlugin,
+  IntentProvider,
+  Layout,
+  LayoutAction,
+  PluginHost,
+  PluginProvider,
+  Resource,
+  ResourceKey,
+  ResourceLanguage,
+  Surface,
+  SurfacePlugin,
+  SurfaceProvider,
+  createApp,
+  filterPlugins,
+  findPlugin,
+  getPlugin,
+  initializePlugin,
+  parseGraphBuilderPlugin,
+  parseGraphPlugin,
+  parseIntentPlugin,
+  parseIntentResolverPlugin,
+  parseLayoutPlugin,
+  parsePluginHost,
+  parseRootSurfacePlugin,
+  parseSurfacePlugin,
+  parseTranslationsPlugin,
+  resolvePlugin,
+  useIntent,
+  usePlugin,
+  usePlugins,
+  useResolvePlugin,
+  useSurface
+};
+//# sourceMappingURL=index.mjs.map