@dxos/app-framework 0.7.4 → 0.7.5-labs.5f04cf6

package/dist/lib/node-esm/index.mjs

@@ -1,572 +1,181 @@
 import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
 import {
+  ActiveParts,
+  Capabilities,
+  ErrorBoundary,
+  Events,
+  FileInfoSchema,
+  INTENT_ACTION,
+  INTENT_PLUGIN,
   IntentAction,
+  IntentPlugin,
   IntentProvider,
-  meta_default,
-  parseIntentPlugin,
-  parseIntentResolverPlugin,
-  useIntent,
-  useIntentDispatcher,
-  useIntentResolver
-} from "./chunk-YFMFQBB4.mjs";
-import {
-  ErrorBoundary,
+  LAYOUT_ACTION,
+  LAYOUT_PLUGIN,
+  Label,
+  Layout,
+  LayoutAction,
+  NAVIGATION_ACTION,
+  NAVIGATION_PLUGIN,
+  NavigationAction,
+  Plugin,
+  PluginManager,
+  PluginManagerProvider,
+  PluginModule,
+  PluginsContext,
+  Resource,
+  ResourceKey,
+  ResourceLanguage,
+  SLUG_COLLECTION_INDICATOR,
+  SLUG_ENTRY_SEPARATOR,
+  SLUG_KEY_VALUE_SEPARATOR,
+  SLUG_LIST_SEPARATOR,
+  SLUG_PATH_SEPARATOR,
   Surface,
-  SurfaceProvider,
-  isObject,
-  meta_default as meta_default2,
-  parseRootSurfacePlugin,
-  parseSurfacePlugin,
-  useSurface,
-  useSurfaceRoot
-} from "./chunk-2R4GVK7O.mjs";
-import {
+  Toast,
+  allOf,
+  chain,
+  contributes,
+  createApp,
+  createDispatcher,
+  createIntent,
+  createResolver,
+  createSurface,
+  defaultFileTypes,
+  defineCapability,
+  defineEvent,
+  defineModule,
   definePlugin,
-  filterPlugins,
-  findPlugin,
-  getPlugin,
-  resolvePlugin
-} from "./chunk-EYCTSFEJ.mjs";
-import {
-  SettingsAction,
-  meta_default as meta_default3,
-  parseSettingsPlugin
-} from "./chunk-YNU7FTGJ.mjs";
-
-// packages/sdk/app-framework/src/plugins/common/file.ts
-var defaultFileTypes = {
-  images: [
-    "png",
-    "jpg",
-    "jpeg",
-    "gif"
-  ],
-  media: [
-    "mp3",
-    "mp4",
-    "mov",
-    "avi"
-  ],
-  text: [
-    "pdf",
-    "txt",
-    "md"
-  ]
-};
-var parseFileManagerPlugin = (plugin) => {
-  return plugin.provides.file ? plugin : void 0;
-};
-
-// 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;
-var parseGraphSerializerPlugin = (plugin) => plugin.provides.graph?.serializer ? plugin : void 0;
-
-// packages/sdk/app-framework/src/plugins/common/layout.ts
-import { z } from "zod";
-var Toast = z.object({
-  id: z.string(),
-  title: z.string().optional(),
-  description: z.string().optional(),
-  // TODO(wittjosiah): `icon` should be string to be parsed by an `Icon` component.
-  icon: z.any().optional(),
-  duration: z.number().optional(),
-  closeLabel: z.string().optional(),
-  actionLabel: z.string().optional(),
-  actionAlt: z.string().optional(),
-  onAction: z.function().optional()
-});
-var LayoutMode = z.union([
-  z.literal("deck"),
-  z.literal("solo"),
-  z.literal("fullscreen")
-]);
-var isLayoutMode = (value) => LayoutMode.safeParse(value).success;
-var Layout = z.object({
-  layoutMode: z.union([
-    z.literal("deck"),
-    z.literal("solo"),
-    z.literal("fullscreen")
-  ]),
-  sidebarOpen: z.boolean(),
-  complementarySidebarOpen: z.boolean(),
-  /**
-  * @deprecated
-  */
-  complementarySidebarContent: z.any().optional().describe("DEPRECATED. Data to be passed to the complementary sidebar Surface."),
-  dialogOpen: z.boolean(),
-  dialogContent: z.any().optional().describe("Data to be passed to the dialog Surface."),
-  // TODO(wittjosiah): Custom properties?
-  dialogBlockAlign: z.union([
-    z.literal("start"),
-    z.literal("center")
-  ]).optional(),
-  dialogType: z.union([
-    z.literal("default"),
-    z.literal("alert")
-  ]).optional(),
-  popoverOpen: z.boolean(),
-  popoverContent: z.any().optional().describe("Data to be passed to the popover Surface."),
-  popoverAnchorId: z.string().optional(),
-  toasts: z.array(Toast),
-  scrollIntoView: z.string().optional().describe("The identifier of a component to scroll into view when it is mounted.")
-});
-var parseLayoutPlugin = (plugin) => {
-  const { success } = Layout.safeParse(plugin.provides.layout);
-  return success ? plugin : void 0;
-};
-var LAYOUT_PLUGIN = "dxos.org/plugin/layout";
-var LAYOUT_ACTION = `${LAYOUT_PLUGIN}/action`;
-var LayoutAction;
-(function(LayoutAction2) {
-  LayoutAction2[LayoutAction2["SET_LAYOUT"] = `${LAYOUT_ACTION}/set-layout`] = "SET_LAYOUT";
-  LayoutAction2[LayoutAction2["SET_LAYOUT_MODE"] = `${LAYOUT_ACTION}/set-layout-mode`] = "SET_LAYOUT_MODE";
-  LayoutAction2[LayoutAction2["SCROLL_INTO_VIEW"] = `${LAYOUT_ACTION}/scroll-into-view`] = "SCROLL_INTO_VIEW";
-  LayoutAction2[LayoutAction2["UPDATE_PLANK_SIZE"] = `${LAYOUT_ACTION}/update-plank-size`] = "UPDATE_PLANK_SIZE";
-})(LayoutAction || (LayoutAction = {}));
-
-// packages/sdk/app-framework/src/plugins/common/metadata.ts
-var parseMetadataRecordsPlugin = (plugin) => {
-  return plugin.provides.metadata?.records ? plugin : void 0;
-};
-var parseMetadataResolverPlugin = (plugin) => {
-  return plugin.provides.metadata?.resolver ? plugin : void 0;
-};
-
-// packages/sdk/app-framework/src/plugins/common/navigation.ts
-import { Schema as S } from "@effect/schema";
-import { z as z2 } from "zod";
-import { pick } from "@dxos/util";
-var SLUG_LIST_SEPARATOR = "+";
-var SLUG_ENTRY_SEPARATOR = "_";
-var SLUG_KEY_VALUE_SEPARATOR = "-";
-var SLUG_PATH_SEPARATOR = "~";
-var SLUG_COLLECTION_INDICATOR = "";
-var LayoutEntrySchema = S.mutable(S.Struct({
-  id: S.String,
-  path: S.optional(S.String)
-}));
-var LayoutPartSchema = S.Union(S.Literal("sidebar"), S.Literal("main"), S.Literal("solo"), S.Literal("complementary"), S.Literal("fullScreen"));
-var LayoutPartsSchema = S.partial(S.mutable(S.Record({
-  key: LayoutPartSchema,
-  value: S.mutable(S.Array(LayoutEntrySchema))
-})));
-var LayoutCoordinateSchema = S.mutable(S.Struct({
-  part: LayoutPartSchema,
-  entryId: S.String
-}));
-var PartAdjustmentSchema = S.Union(S.Literal("increment-start"), S.Literal("increment-end"), S.Literal("solo"));
-var LayoutAdjustmentSchema = S.mutable(S.Struct({
-  layoutCoordinate: LayoutCoordinateSchema,
-  type: PartAdjustmentSchema
-}));
-var ActiveParts = z2.record(z2.string(), z2.union([
-  z2.string(),
-  z2.array(z2.string())
-]));
-var LocationProvidesSchema = S.mutable(S.Struct({
-  location: S.Struct({
-    active: LayoutPartsSchema,
-    closed: S.Array(S.String)
-  })
-}));
-var isLayoutParts = (value) => {
-  return S.is(LayoutPartsSchema)(value);
-};
-var isLayoutAdjustment = (value) => {
-  return S.is(LayoutAdjustmentSchema)(value);
-};
-var parseNavigationPlugin = (plugin) => {
-  const location = plugin.provides?.location;
-  if (!location) {
-    return void 0;
-  }
-  if (S.is(LocationProvidesSchema)({
-    location
-  })) {
-    return plugin;
-  }
-  return void 0;
-};
-var openIds = (layout, parts) => {
-  return Object.values(parts ? pick(layout, parts) : layout).flatMap((part) => part?.map((entry) => entry.id) ?? []).filter((id) => id !== void 0);
-};
-var firstIdInPart = (layout, part) => {
-  if (!layout) {
-    return void 0;
-  }
-  return layout[part]?.at(0)?.id;
-};
-var indexInPart = (layout, layoutCoordinate) => {
-  if (!layout || !layoutCoordinate) {
-    return void 0;
-  }
-  const { part, entryId } = layoutCoordinate;
-  return layout[part]?.findIndex((entry) => entry.id === entryId);
-};
-var partLength = (layout, part) => {
-  if (!layout || !part) {
-    return 0;
-  }
-  return layout[part]?.length ?? 0;
-};
-var NAVIGATION_PLUGIN = "dxos.org/plugin/navigation";
-var NAVIGATION_ACTION = `${NAVIGATION_PLUGIN}/action`;
-var NavigationAction;
-(function(NavigationAction2) {
-  NavigationAction2[NavigationAction2["OPEN"] = `${NAVIGATION_ACTION}/open`] = "OPEN";
-  NavigationAction2[NavigationAction2["ADD_TO_ACTIVE"] = `${NAVIGATION_ACTION}/add-to-active`] = "ADD_TO_ACTIVE";
-  NavigationAction2[NavigationAction2["SET"] = `${NAVIGATION_ACTION}/set`] = "SET";
-  NavigationAction2[NavigationAction2["ADJUST"] = `${NAVIGATION_ACTION}/adjust`] = "ADJUST";
-  NavigationAction2[NavigationAction2["CLOSE"] = `${NAVIGATION_ACTION}/close`] = "CLOSE";
-  NavigationAction2[NavigationAction2["EXPOSE"] = `${NAVIGATION_ACTION}/expose`] = "EXPOSE";
-})(NavigationAction || (NavigationAction = {}));
-
-// packages/sdk/app-framework/src/plugins/common/translations.ts
-import { z as z3 } from "zod";
-var ResourceKey = z3.union([
-  z3.string(),
-  z3.record(z3.any())
-]);
-var ResourceLanguage = z3.record(ResourceKey);
-var Resource = z3.record(ResourceLanguage);
-var parseTranslationsPlugin = (plugin) => {
-  const { success } = z3.array(Resource).safeParse(plugin.provides.translations);
-  return success ? plugin : void 0;
-};
-
-// packages/sdk/app-framework/src/plugins/plugin-host/plugin.ts
-var Plugin;
-(function(Plugin2) {
-  Plugin2.lazy = (p, props) => {
-    return () => p().then(({ default: definition }) => {
-      return definition(props);
-    });
-  };
-})(Plugin || (Plugin = {}));
-
-// packages/sdk/app-framework/src/plugins/plugin-host/HostPlugin.tsx
-import React2 from "react";
-import { LocalStorageStore } from "@dxos/local-storage";
+  eventKey,
+  firstIdInPart,
+  getEvents,
+  indexInPart,
+  isAllOf,
+  isLayoutAdjustment,
+  isLayoutMode,
+  isLayoutParts,
+  isOneOf,
+  isSurfaceAvailable,
+  lazy,
+  oneOf,
+  openIds,
+  partLength,
+  useCapabilities,
+  useCapability,
+  useIntentDispatcher,
+  useIntentResolver,
+  usePluginManager
+} from "./chunk-ZFOOPWBG.mjs";
 
-// packages/sdk/app-framework/src/plugins/plugin-host/PluginContainer.tsx
-import React, { useEffect, useState } from "react";
-import { log } from "@dxos/log";
-var __dxlog_file = "/home/runner/work/dxos/dxos/packages/sdk/app-framework/src/plugins/plugin-host/PluginContainer.tsx";
-var PluginContainer = ({ plugins: definitions, core, state, placeholder }) => {
-  const [error, setError] = useState();
-  useEffect(() => {
-    log("initializing plugins", {
-      enabled: state.enabled
-    }, {
-      F: __dxlog_file,
-      L: 26,
-      S: void 0,
-      C: (f, a) => f(...a)
-    });
-    const t = setTimeout(async () => {
-      try {
-        const enabledIds = [
-          ...core,
-          ...state.enabled
-        ];
-        const enabled = await Promise.all(enabledIds.map((id) => definitions[id]).filter((definition) => Boolean(definition)).map((definition) => definition()));
-        const plugins = await Promise.all(enabled.map(async (definition) => {
-          const plugin = await initializePlugin(definition).catch((err) => {
-            log.error("Failed to initialize plugin:", {
-              id: definition.meta.id,
-              err
-            }, {
-              F: __dxlog_file,
-              L: 41,
-              S: void 0,
-              C: (f, a) => f(...a)
-            });
-          });
-          log("initialized", {
-            plugin: definition.meta.id
-          }, {
-            F: __dxlog_file,
-            L: 44,
-            S: void 0,
-            C: (f, a) => f(...a)
-          });
-          return plugin;
-        }));
-        const initialized = plugins.filter((plugin) => Boolean(plugin));
-        log("plugins initialized", {
-          plugins: initialized
-        }, {
-          F: __dxlog_file,
-          L: 50,
-          S: void 0,
-          C: (f, a) => f(...a)
-        });
-        await Promise.all(enabled.map((plugin) => plugin.ready?.(initialized)));
-        log("plugins ready", {
-          plugins: initialized
-        }, {
-          F: __dxlog_file,
-          L: 53,
-          S: void 0,
-          C: (f, a) => f(...a)
-        });
-        state.plugins = initialized;
-        state.ready = true;
-      } catch (err) {
-        setError(err);
-      }
-    });
-    return () => {
-      clearTimeout(t);
-      state.ready = false;
-    };
-  }, []);
-  if (error) {
-    throw error;
+// packages/sdk/app-framework/src/plugin-settings/actions.ts
+import { S } from "@dxos/echo-schema";
+var SETTINGS_PLUGIN = "dxos.org/plugin/settings";
+var SETTINGS_ACTION = `${SETTINGS_PLUGIN}/action`;
+var SettingsAction;
+(function(SettingsAction2) {
+  class Open extends S.TaggedClass()(`${SETTINGS_ACTION}/open`, {
+    input: S.Struct({
+      plugin: S.optional(S.String)
+    }),
+    output: S.Void
+  }) {
   }
-  if (!state.ready) {
-    return /* @__PURE__ */ React.createElement(React.Fragment, null, placeholder);
-  }
-  const ComposedContext = composeContext(state.plugins);
-  return /* @__PURE__ */ React.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 Component = plugin.provides.root;
-    if (Component) {
-      return /* @__PURE__ */ React.createElement(Component, {
-        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__ */ React.createElement(Acc, null, /* @__PURE__ */ React.createElement(Next, null, children)));
-};
+  SettingsAction2.Open = Open;
+})(SettingsAction || (SettingsAction = {}));
 
-// packages/sdk/app-framework/src/plugins/plugin-host/PluginContext.tsx
-import { createContext, useContext, useMemo } from "react";
-import { raise } from "@dxos/debug";
-import { nonNullable } from "@dxos/util";
-var PluginContext = /* @__PURE__ */ createContext(void 0);
-var usePlugins = () => useContext(PluginContext) ?? raise(new Error("Missing PluginContext"));
-var usePlugin = (id) => {
-  const { plugins } = usePlugins();
-  return findPlugin(plugins, id);
-};
-var useResolvePlugin = (predicate) => {
-  const { plugins } = usePlugins();
-  return resolvePlugin(plugins, predicate);
-};
-var useResolvePlugins = (predicate) => {
-  const { plugins } = usePlugins();
-  return useMemo(() => plugins.map(predicate).filter(nonNullable), [
-    plugins,
-    predicate
-  ]);
-};
-var PluginProvider = PluginContext.Provider;
-
-// packages/sdk/app-framework/src/plugins/plugin-host/HostPlugin.tsx
-var parsePluginHost = (plugin) => plugin.provides.plugins ? plugin : void 0;
-var HOST_PLUGIN = "dxos.org/plugin/host";
-var HostPlugin = ({ plugins, meta, core, defaults = [], fallback = DefaultFallback, placeholder = null }) => {
-  const state = new LocalStorageStore(HOST_PLUGIN, {
-    ready: false,
-    core,
-    enabled: [
-      ...defaults
+// packages/sdk/app-framework/src/plugin-settings/SettingsPlugin.ts
+import { RootSettingsStore } from "@dxos/local-storage";
+var SettingsPlugin = () => definePlugin({
+  id: SETTINGS_PLUGIN
+}, [
+  defineModule({
+    id: `${SETTINGS_PLUGIN}/module/store`,
+    activatesOn: Events.Startup,
+    activatesBefore: [
+      Events.SetupSettings
     ],
-    plugins: [],
-    available: meta.filter(({ id }) => !core.includes(id)),
-    // TODO(burdon): Functions should not be part of the settings type.
-    setPlugin: (id, enabled) => {
-      if (enabled) {
-        state.values.enabled.push(id);
-      } else {
-        const index = state.values.enabled.findIndex((enabled2) => enabled2 === id);
-        index !== -1 && state.values.enabled.splice(index, 1);
-      }
-    }
-  });
-  state.prop({
-    key: "enabled",
-    type: LocalStorageStore.json()
-  });
-  return {
-    meta: {
-      id: HOST_PLUGIN,
-      name: "Plugin host"
-    },
-    provides: {
-      plugins: state.values,
-      context: ({ children }) => {
-        return /* @__PURE__ */ React2.createElement(PluginProvider, {
-          value: state.values
-        }, children);
-      },
-      root: () => {
-        return /* @__PURE__ */ React2.createElement(ErrorBoundary, {
-          fallback
-        }, /* @__PURE__ */ React2.createElement(PluginContainer, {
-          plugins,
-          core,
-          state: state.values,
-          placeholder
-        }));
-      }
-    }
-  };
-};
-var DefaultFallback = ({ error }) => {
-  return /* @__PURE__ */ React2.createElement("div", {
-    style: {
-      padding: "1rem"
-    }
-  }, /* @__PURE__ */ React2.createElement("h1", {
-    style: {
-      fontSize: "1.2rem",
-      fontWeight: 700,
-      margin: "0.5rem 0"
-    }
-  }, error.message), /* @__PURE__ */ React2.createElement("pre", null, error.stack));
-};
-
-// packages/sdk/app-framework/src/App.tsx
-import React3 from "react";
-import { invariant } from "@dxos/invariant";
-var __dxlog_file2 = "/home/runner/work/dxos/dxos/packages/sdk/app-framework/src/App.tsx";
-var createApp = ({ meta, plugins, core, ...params }) => {
-  const hostPlugin = HostPlugin({
-    plugins: {
-      ...plugins,
-      [meta_default.id]: Plugin.lazy(() => import("./plugin-intent-V7ER24Y6.mjs")),
-      [meta_default3.id]: Plugin.lazy(() => import("./plugin-settings-37UVWF2V.mjs")),
-      [meta_default2.id]: Plugin.lazy(() => import("./plugin-surface-TEU42XQN.mjs"))
-    },
-    meta: [
-      meta_default,
-      meta_default3,
-      meta_default2,
-      ...meta
-    ],
-    core: [
-      meta_default.id,
-      meta_default3.id,
-      meta_default2.id,
-      ...core
+    activatesAfter: [
+      Events.SettingsReady
     ],
-    ...params
-  });
-  invariant(hostPlugin.provides, void 0, {
-    F: __dxlog_file2,
-    L: 53,
-    S: void 0,
-    A: [
-      "hostPlugin.provides",
-      ""
-    ]
-  });
-  const { context: Context, root: Root } = hostPlugin.provides;
-  invariant(Context, void 0, {
-    F: __dxlog_file2,
-    L: 55,
-    S: void 0,
-    A: [
-      "Context",
-      ""
-    ]
-  });
-  invariant(Root, void 0, {
-    F: __dxlog_file2,
-    L: 56,
-    S: void 0,
-    A: [
-      "Root",
-      ""
-    ]
-  });
-  return () => /* @__PURE__ */ React3.createElement(Context, null, /* @__PURE__ */ React3.createElement(Root, null));
-};
+    activate: (context) => {
+      const allSettings = context.requestCapabilities(Capabilities.Settings);
+      const settingsStore = new RootSettingsStore();
+      allSettings.forEach((setting) => {
+        settingsStore.createStore(setting);
+      });
+      return contributes(Capabilities.SettingsStore, settingsStore);
+    }
+  })
+]);
 export {
   ActiveParts,
+  Capabilities,
   ErrorBoundary,
-  HostPlugin,
+  Events,
+  FileInfoSchema,
+  INTENT_ACTION,
+  INTENT_PLUGIN,
   IntentAction,
+  IntentPlugin,
   IntentProvider,
+  LAYOUT_ACTION,
+  LAYOUT_PLUGIN,
+  Label,
   Layout,
   LayoutAction,
+  NAVIGATION_ACTION,
+  NAVIGATION_PLUGIN,
   NavigationAction,
   Plugin,
-  PluginProvider,
+  PluginManager,
+  PluginManagerProvider,
+  PluginModule,
+  PluginsContext,
   Resource,
   ResourceKey,
   ResourceLanguage,
+  SETTINGS_ACTION,
+  SETTINGS_PLUGIN,
   SLUG_COLLECTION_INDICATOR,
   SLUG_ENTRY_SEPARATOR,
   SLUG_KEY_VALUE_SEPARATOR,
   SLUG_LIST_SEPARATOR,
   SLUG_PATH_SEPARATOR,
   SettingsAction,
+  SettingsPlugin,
   Surface,
-  SurfaceProvider,
   Toast,
+  allOf,
+  chain,
+  contributes,
   createApp,
+  createDispatcher,
+  createIntent,
+  createResolver,
+  createSurface,
   defaultFileTypes,
+  defineCapability,
+  defineEvent,
+  defineModule,
   definePlugin,
-  filterPlugins,
-  findPlugin,
+  eventKey,
   firstIdInPart,
-  getPlugin,
+  getEvents,
   indexInPart,
+  isAllOf,
   isLayoutAdjustment,
   isLayoutMode,
   isLayoutParts,
-  isObject,
+  isOneOf,
+  isSurfaceAvailable,
+  lazy,
+  oneOf,
   openIds,
-  parseFileManagerPlugin,
-  parseGraphBuilderPlugin,
-  parseGraphPlugin,
-  parseGraphSerializerPlugin,
-  parseIntentPlugin,
-  parseIntentResolverPlugin,
-  parseLayoutPlugin,
-  parseMetadataRecordsPlugin,
-  parseMetadataResolverPlugin,
-  parseNavigationPlugin,
-  parsePluginHost,
-  parseRootSurfacePlugin,
-  parseSettingsPlugin,
-  parseSurfacePlugin,
-  parseTranslationsPlugin,
   partLength,
-  resolvePlugin,
-  useIntent,
+  useCapabilities,
+  useCapability,
   useIntentDispatcher,
   useIntentResolver,
-  usePlugin,
-  usePlugins,
-  useResolvePlugin,
-  useResolvePlugins,
-  useSurface,
-  useSurfaceRoot
+  usePluginManager
 };
 //# sourceMappingURL=index.mjs.map