@dxos/app-framework 0.7.4 → 0.7.5-main.499c70c

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

@@ -1,25 +1,30 @@
 import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
 import {
+  INTENT_ACTION,
   IntentAction,
   IntentProvider,
+  Label,
+  chain,
+  createDispatcher,
+  createIntent,
+  createResolver,
   meta_default,
   parseIntentPlugin,
   parseIntentResolverPlugin,
-  useIntent,
   useIntentDispatcher,
   useIntentResolver
-} from "./chunk-YFMFQBB4.mjs";
+} from "./chunk-CFOUYXQ6.mjs";
 import {
   ErrorBoundary,
   Surface,
   SurfaceProvider,
+  createSurface,
   isObject,
   meta_default as meta_default2,
   parseRootSurfacePlugin,
   parseSurfacePlugin,
-  useSurface,
   useSurfaceRoot
-} from "./chunk-2R4GVK7O.mjs";
+} from "./chunk-4GX7V5ZE.mjs";
 import {
   definePlugin,
   filterPlugins,
@@ -28,10 +33,12 @@ import {
   resolvePlugin
 } from "./chunk-EYCTSFEJ.mjs";
 import {
+  SETTINGS_ACTION,
+  SETTINGS_PLUGIN,
   SettingsAction,
   meta_default as meta_default3,
   parseSettingsPlugin
-} from "./chunk-YNU7FTGJ.mjs";
+} from "./chunk-3T5UIJY3.mjs";
 
 // packages/sdk/app-framework/src/plugins/common/file.ts
 var defaultFileTypes = {
@@ -63,66 +70,117 @@ var parseGraphBuilderPlugin = (plugin) => plugin.provides.graph?.builder ? plugi
 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()
+import { S } from "@dxos/echo-schema";
+var Toast = S.Struct({
+  id: S.String,
+  title: S.optional(Label),
+  description: S.optional(Label),
+  icon: S.optional(S.String),
+  duration: S.optional(S.Number),
+  closeLabel: S.optional(Label),
+  actionLabel: S.optional(Label),
+  actionAlt: S.optional(Label),
+  // TODO(wittjosiah): Make class with customizable method?
+  onAction: S.optional(S.Any)
 });
-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(),
+var LayoutMode = S.Union(S.Literal("deck"), S.Literal("solo"), S.Literal("fullscreen"));
+var isLayoutMode = (value) => S.is(LayoutMode)(value);
+var Layout = S.mutable(S.Struct({
+  layoutMode: LayoutMode,
+  sidebarOpen: S.Boolean,
+  complementarySidebarOpen: S.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."),
+   * @deprecated Data to be passed to the complementary sidebar Surface.
+   */
+  complementarySidebarContent: S.optional(S.Any),
+  dialogOpen: S.Boolean,
+  /**
+   * Data to be passed to the dialog Surface.
+   */
+  dialogContent: S.optional(S.Any),
   // 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.")
-});
+  dialogBlockAlign: S.optional(S.Literal("start", "center")),
+  dialogType: S.optional(S.Literal("default", "alert")),
+  popoverOpen: S.Boolean,
+  /**
+   * Data to be passed to the popover Surface.
+   */
+  popoverContent: S.optional(S.Any),
+  popoverAnchorId: S.optional(S.String),
+  toasts: S.mutable(S.Array(Toast)),
+  /**
+   * The identifier of a component to scroll into view when it is mounted.
+   */
+  scrollIntoView: S.optional(S.String)
+}));
 var parseLayoutPlugin = (plugin) => {
-  const { success } = Layout.safeParse(plugin.provides.layout);
+  const success = S.is(Layout)(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";
+  class SetLayout extends S.TaggedClass()(`${LAYOUT_ACTION}/set-layout`, {
+    input: S.Struct({
+      /**
+      * Element to set the state of.
+      */
+      element: S.Literal("fullscreen", "sidebar", "complementary", "dialog", "popover", "toast"),
+      /**
+      * Whether the element is on or off.
+      *
+      * If omitted, the element's state will be toggled or set based on other provided data.
+      * For example, if `component` is provided, the state will be set to `true`.
+      */
+      state: S.optional(S.Boolean),
+      /**
+      * Component to render in the dialog or popover.
+      */
+      component: S.optional(S.String),
+      /**
+      * Data to be passed to the dialog or popover Surface.
+      */
+      subject: S.optional(S.Any),
+      /**
+      * Anchor ID for the popover.
+      */
+      anchorId: S.optional(S.String),
+      // TODO(wittjosiah): Custom properties?
+      /**
+      * Block alignment for the dialog.
+      */
+      dialogBlockAlign: S.optional(S.Literal("start", "center")),
+      /**
+      * Type of dialog.
+      */
+      dialogType: S.optional(S.Literal("default", "alert"))
+    }),
+    output: S.Void
+  }) {
+  }
+  LayoutAction2.SetLayout = SetLayout;
+  class SetLayoutMode extends S.TaggedClass()(`${LAYOUT_ACTION}/set-layout-mode`, {
+    input: S.Union(S.Struct({
+      layoutMode: LayoutMode
+    }), S.Struct({
+      revert: S.Literal(true)
+    })),
+    output: S.Void
+  }) {
+  }
+  LayoutAction2.SetLayoutMode = SetLayoutMode;
+  class ScrollIntoView extends S.TaggedClass()(`${LAYOUT_ACTION}/scroll-into-view`, {
+    input: S.Struct({
+      id: S.optional(S.String),
+      // TODO(wittjosiah): Factor out to thread scroll into view action?
+      cursor: S.optional(S.String),
+      ref: S.optional(S.String)
+    }),
+    output: S.Void
+  }) {
+  }
+  LayoutAction2.ScrollIntoView = ScrollIntoView;
 })(LayoutAction || (LayoutAction = {}));
 
 // packages/sdk/app-framework/src/plugins/common/metadata.ts
@@ -134,54 +192,53 @@ var parseMetadataResolverPlugin = (plugin) => {
 };
 
 // packages/sdk/app-framework/src/plugins/common/navigation.ts
-import { Schema as S } from "@effect/schema";
-import { z as z2 } from "zod";
+import { Schema as S2 } from "@effect/schema";
 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 LayoutEntrySchema = S2.mutable(S2.Struct({
+  id: S2.String,
+  path: S2.optional(S2.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({
+var LayoutPartSchema = S2.Union(S2.Literal("sidebar"), S2.Literal("main"), S2.Literal("solo"), S2.Literal("complementary"), S2.Literal("fullScreen"));
+var LayoutPartsSchema = S2.partial(S2.mutable(S2.Record({
   key: LayoutPartSchema,
-  value: S.mutable(S.Array(LayoutEntrySchema))
+  value: S2.mutable(S2.Array(LayoutEntrySchema))
 })));
-var LayoutCoordinateSchema = S.mutable(S.Struct({
+var LayoutCoordinateSchema = S2.mutable(S2.Struct({
   part: LayoutPartSchema,
-  entryId: S.String
+  entryId: S2.String
 }));
-var PartAdjustmentSchema = S.Union(S.Literal("increment-start"), S.Literal("increment-end"), S.Literal("solo"));
-var LayoutAdjustmentSchema = S.mutable(S.Struct({
+var PartAdjustmentSchema = S2.Union(S2.Literal("increment-start"), S2.Literal("increment-end"), S2.Literal("pin-start"), S2.Literal("pin-end"), S2.Literal("close"), S2.Literal("solo"));
+var LayoutAdjustmentSchema = S2.mutable(S2.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({
+var ActiveParts = S2.Record({
+  key: S2.String,
+  value: S2.Union(S2.String, S2.mutable(S2.Array(S2.String)))
+});
+var LocationProvidesSchema = S2.mutable(S2.Struct({
+  location: S2.Struct({
     active: LayoutPartsSchema,
-    closed: S.Array(S.String)
+    closed: S2.Array(S2.String)
   })
 }));
 var isLayoutParts = (value) => {
-  return S.is(LayoutPartsSchema)(value);
+  return S2.is(LayoutPartsSchema)(value);
 };
 var isLayoutAdjustment = (value) => {
-  return S.is(LayoutAdjustmentSchema)(value);
+  return S2.is(LayoutAdjustmentSchema)(value);
 };
 var parseNavigationPlugin = (plugin) => {
   const location = plugin.provides?.location;
   if (!location) {
     return void 0;
   }
-  if (S.is(LocationProvidesSchema)({
+  if (S2.is(LocationProvidesSchema)({
     location
   })) {
     return plugin;
@@ -214,37 +271,75 @@ 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";
+  class Open extends S2.TaggedClass()(`${NAVIGATION_ACTION}/open`, {
+    input: S2.Struct({
+      activeParts: ActiveParts,
+      noToggle: S2.optional(S2.Boolean)
+    }),
+    output: S2.Struct({
+      open: S2.Array(S2.String)
+    })
+  }) {
+  }
+  NavigationAction2.Open = Open;
+  class AddToActive extends S2.TaggedClass()(`${NAVIGATION_ACTION}/add-to-active`, {
+    input: S2.Struct({
+      id: S2.String,
+      part: LayoutPartSchema,
+      scrollIntoView: S2.optional(S2.Boolean),
+      pivotId: S2.optional(S2.String),
+      positioning: S2.optional(S2.Literal("start", "end"))
+    }),
+    output: S2.Void
+  }) {
+  }
+  NavigationAction2.AddToActive = AddToActive;
+  class Set extends S2.TaggedClass()(`${NAVIGATION_ACTION}/set`, {
+    input: S2.Struct({
+      activeParts: ActiveParts
+    }),
+    output: S2.Void
+  }) {
+  }
+  NavigationAction2.Set = Set;
+  class Close extends S2.TaggedClass()(`${NAVIGATION_ACTION}/close`, {
+    input: S2.Struct({
+      activeParts: ActiveParts,
+      noToggle: S2.optional(S2.Boolean)
+    }),
+    output: S2.Void
+  }) {
+  }
+  NavigationAction2.Close = Close;
+  class Adjust extends S2.TaggedClass()(`${NAVIGATION_ACTION}/adjust`, {
+    input: LayoutAdjustmentSchema,
+    output: S2.Void
+  }) {
+  }
+  NavigationAction2.Adjust = Adjust;
+  class Expose extends S2.TaggedClass()(`${NAVIGATION_ACTION}/expose`, {
+    input: S2.Struct({
+      id: S2.String
+    }),
+    output: S2.Void
+  }) {
+  }
+  NavigationAction2.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())
+import { z } from "zod";
+var ResourceKey = z.union([
+  z.string(),
+  z.record(z.any())
 ]);
-var ResourceLanguage = z3.record(ResourceKey);
-var Resource = z3.record(ResourceLanguage);
+var ResourceLanguage = z.record(ResourceKey);
+var Resource = z.record(ResourceLanguage);
 var parseTranslationsPlugin = (plugin) => {
-  const { success } = z3.array(Resource).safeParse(plugin.provides.translations);
+  const { success } = z.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";
@@ -302,7 +397,9 @@ var PluginContainer = ({ plugins: definitions, core, state, placeholder }) => {
           S: void 0,
           C: (f, a) => f(...a)
         });
-        await Promise.all(enabled.map((plugin) => plugin.ready?.(initialized)));
+        await Promise.all(enabled.map((plugin) => plugin.ready?.({
+          plugins: initialized
+        })));
         log("plugins ready", {
           plugins: initialized
         }, {
@@ -386,7 +483,6 @@ var useResolvePlugins = (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, {
@@ -417,7 +513,6 @@ var HostPlugin = ({ plugins, meta, core, defaults = [], fallback = DefaultFallba
       name: "Plugin host"
     },
     provides: {
-      plugins: state.values,
       context: ({ children }) => {
         return /* @__PURE__ */ React2.createElement(PluginProvider, {
           value: state.values
@@ -450,6 +545,16 @@ var DefaultFallback = ({ error }) => {
   }, error.message), /* @__PURE__ */ React2.createElement("pre", null, error.stack));
 };
 
+// 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/App.tsx
 import React3 from "react";
 import { invariant } from "@dxos/invariant";
@@ -458,9 +563,9 @@ 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_default.id]: Plugin.lazy(() => import("./plugin-intent-W2HQC6LC.mjs")),
+      [meta_default3.id]: Plugin.lazy(() => import("./plugin-settings-H5RHNFVC.mjs")),
+      [meta_default2.id]: Plugin.lazy(() => import("./plugin-surface-V3YET3UL.mjs"))
     },
     meta: [
       meta_default,
@@ -510,16 +615,24 @@ export {
   ActiveParts,
   ErrorBoundary,
   HostPlugin,
+  INTENT_ACTION,
   IntentAction,
   IntentProvider,
+  LAYOUT_ACTION,
+  LAYOUT_PLUGIN,
+  Label,
   Layout,
   LayoutAction,
+  NAVIGATION_ACTION,
+  NAVIGATION_PLUGIN,
   NavigationAction,
   Plugin,
   PluginProvider,
   Resource,
   ResourceKey,
   ResourceLanguage,
+  SETTINGS_ACTION,
+  SETTINGS_PLUGIN,
   SLUG_COLLECTION_INDICATOR,
   SLUG_ENTRY_SEPARATOR,
   SLUG_KEY_VALUE_SEPARATOR,
@@ -529,7 +642,12 @@ export {
   Surface,
   SurfaceProvider,
   Toast,
+  chain,
   createApp,
+  createDispatcher,
+  createIntent,
+  createResolver,
+  createSurface,
   defaultFileTypes,
   definePlugin,
   filterPlugins,
@@ -552,21 +670,18 @@ export {
   parseMetadataRecordsPlugin,
   parseMetadataResolverPlugin,
   parseNavigationPlugin,
-  parsePluginHost,
   parseRootSurfacePlugin,
   parseSettingsPlugin,
   parseSurfacePlugin,
   parseTranslationsPlugin,
   partLength,
   resolvePlugin,
-  useIntent,
   useIntentDispatcher,
   useIntentResolver,
   usePlugin,
   usePlugins,
   useResolvePlugin,
   useResolvePlugins,
-  useSurface,
   useSurfaceRoot
 };
 //# sourceMappingURL=index.mjs.map