@dxos/app-framework 0.4.1-main.2495eb8 → 0.4.1-main.31058a6

package/dist/types/src/plugins/common/layout.d.ts

@@ -1,8 +1,44 @@
 import { z } from 'zod';
 import { type IntentData } from '../IntentPlugin';
 import type { Plugin } from '../PluginHost';
+export declare const Toast: z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodAny>;
+    duration: z.ZodOptional<z.ZodNumber>;
+    closeLabel: z.ZodOptional<z.ZodString>;
+    actionLabel: z.ZodOptional<z.ZodString>;
+    actionAlt: z.ZodOptional<z.ZodString>;
+    onAction: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnknown>>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    title?: string | undefined;
+    description?: string | undefined;
+    icon?: any;
+    duration?: number | undefined;
+    closeLabel?: string | undefined;
+    actionLabel?: string | undefined;
+    actionAlt?: string | undefined;
+    onAction?: ((...args: unknown[]) => unknown) | undefined;
+}, {
+    id: string;
+    title?: string | undefined;
+    description?: string | undefined;
+    icon?: any;
+    duration?: number | undefined;
+    closeLabel?: string | undefined;
+    actionLabel?: string | undefined;
+    actionAlt?: string | undefined;
+    onAction?: ((...args: unknown[]) => unknown) | undefined;
+}>;
+export type Toast = z.infer<typeof Toast>;
 /**
  * Basic state provided by a layout plugin.
+ *
+ * Layout provides the state of global UI landmarks, such as the sidebar, dialog, and popover.
+ * Generally only one dialog or popover should be open at a time, a layout plugin should manage this.
+ * For other landmarks, such as toasts, rendering them in the layout prevents them from unmounting when navigating.
  */
 export declare const Layout: z.ZodObject<{
     fullscreen: z.ZodBoolean;
@@ -13,30 +49,77 @@ export declare const Layout: z.ZodObject<{
     popoverOpen: z.ZodBoolean;
     popoverContent: z.ZodOptional<z.ZodAny>;
     popoverAnchorId: z.ZodOptional<z.ZodString>;
-    active: z.ZodOptional<z.ZodString>;
-    previous: z.ZodOptional<z.ZodString>;
+    toasts: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        icon: z.ZodOptional<z.ZodAny>;
+        duration: z.ZodOptional<z.ZodNumber>;
+        closeLabel: z.ZodOptional<z.ZodString>;
+        actionLabel: z.ZodOptional<z.ZodString>;
+        actionAlt: z.ZodOptional<z.ZodString>;
+        onAction: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnknown>>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        title?: string | undefined;
+        description?: string | undefined;
+        icon?: any;
+        duration?: number | undefined;
+        closeLabel?: string | undefined;
+        actionLabel?: string | undefined;
+        actionAlt?: string | undefined;
+        onAction?: ((...args: unknown[]) => unknown) | undefined;
+    }, {
+        id: string;
+        title?: string | undefined;
+        description?: string | undefined;
+        icon?: any;
+        duration?: number | undefined;
+        closeLabel?: string | undefined;
+        actionLabel?: string | undefined;
+        actionAlt?: string | undefined;
+        onAction?: ((...args: unknown[]) => unknown) | undefined;
+    }>, "many">;
 }, "strip", z.ZodTypeAny, {
     fullscreen: boolean;
     sidebarOpen: boolean;
     complementarySidebarOpen: boolean;
     dialogOpen: boolean;
     popoverOpen: boolean;
+    toasts: {
+        id: string;
+        title?: string | undefined;
+        description?: string | undefined;
+        icon?: any;
+        duration?: number | undefined;
+        closeLabel?: string | undefined;
+        actionLabel?: string | undefined;
+        actionAlt?: string | undefined;
+        onAction?: ((...args: unknown[]) => unknown) | undefined;
+    }[];
     dialogContent?: any;
     popoverContent?: any;
     popoverAnchorId?: string | undefined;
-    active?: string | undefined;
-    previous?: string | undefined;
 }, {
     fullscreen: boolean;
     sidebarOpen: boolean;
     complementarySidebarOpen: boolean;
     dialogOpen: boolean;
     popoverOpen: boolean;
+    toasts: {
+        id: string;
+        title?: string | undefined;
+        description?: string | undefined;
+        icon?: any;
+        duration?: number | undefined;
+        closeLabel?: string | undefined;
+        actionLabel?: string | undefined;
+        actionAlt?: string | undefined;
+        onAction?: ((...args: unknown[]) => unknown) | undefined;
+    }[];
     dialogContent?: any;
     popoverContent?: any;
     popoverAnchorId?: string | undefined;
-    active?: string | undefined;
-    previous?: string | undefined;
 }>;
 export type Layout = z.infer<typeof Layout>;
 /**
@@ -50,42 +133,38 @@ export type LayoutProvides = {
  */
 export declare const parseLayoutPlugin: (plugin: Plugin) => Plugin<LayoutProvides> | undefined;
 export declare enum LayoutAction {
-    TOGGLE_FULLSCREEN = "dxos.org/plugin/layout/toggle-fullscreen",
-    TOGGLE_SIDEBAR = "dxos.org/plugin/layout/toggle-sidebar",
-    TOGGLE_COMPLEMENTARY_SIDEBAR = "dxos.org/plugin/layout/toggle-complementary-sidebar",
-    OPEN_DIALOG = "dxos.org/plugin/layout/open-dialog",
-    CLOSE_DIALOG = "dxos.org/plugin/layout/close-dialog",
-    OPEN_POPOVER = "dxos.org/plugin/layout/open-popover",
-    CLOSE_POPOVER = "dxos.org/plugin/layout/close-popover",
-    ACTIVATE = "dxos.org/plugin/layout/activate",
+    SET_LAYOUT = "dxos.org/plugin/layout/set-layout",
+    /** @deprecated */
     FOCUS = "dxos.org/plugin/layout/focus"
 }
 /**
  * Expected payload for layout actions.
  */
 export declare namespace LayoutAction {
-    type ToggleFullscreen = IntentData<{
+    type SetLayout = IntentData<{
+        /**
+         * Element to set the state of.
+         */
+        element: '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?: boolean;
-    }>;
-    type ToggleSidebar = IntentData<{
-        state?: boolean;
-    }>;
-    type ToggleComplementarySidebar = IntentData<{
-        state?: boolean;
-    }>;
-    type OpenDialog = IntentData<{
-        component: string;
-        subject: any;
-    }>;
-    type CloseDialog = IntentData<{}>;
-    type OpenPopover = IntentData<{
-        anchorId: string;
-        component: string;
-        subject: any;
-    }>;
-    type ClosePopover = IntentData<{}>;
-    type Activate = IntentData<{
-        id: string;
+        /**
+         * Component to render in the dialog or popover.
+         */
+        component?: string;
+        /**
+         * Data to be passed to the dialog or popover Surface.
+         */
+        subject?: any;
+        /**
+         * Anchor ID for the popover.
+         */
+        anchorId?: string;
     }>;
 }
 //# sourceMappingURL=layout.d.ts.map

package/dist/types/src/plugins/common/layout.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"layout.d.ts","sourceRoot":"","sources":["../../../../../src/plugins/common/layout.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAM5C;;GAEG;AAEH,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiBjB,CAAC;AAEH,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,CAAC;AAE5C;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB,WAAY,MAAM,uCAG/C,CAAC;AAQF,oBAAY,YAAY;IACtB,iBAAiB,6CAAuC;IACxD,cAAc,0CAAoC;IAClD,4BAA4B,wDAAkD;IAC9E,WAAW,uCAAiC;IAC5C,YAAY,wCAAkC;IAC9C,YAAY,wCAAkC;IAC9C,aAAa,yCAAmC;IAChD,QAAQ,oCAA8B;IACtC,KAAK,iCAA2B;CACjC;AAED;;GAEG;AACH,yBAAiB,YAAY,CAAC;IAC5B,KAAY,gBAAgB,GAAG,UAAU,CAAC;QACxC,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB,CAAC,CAAC;IAEH,KAAY,aAAa,GAAG,UAAU,CAAC;QACrC,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB,CAAC,CAAC;IAEH,KAAY,0BAA0B,GAAG,UAAU,CAAC;QAClD,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB,CAAC,CAAC;IAEH,KAAY,UAAU,GAAG,UAAU,CAAC;QAClC,SAAS,EAAE,MAAM,CAAC;QAClB,OAAO,EAAE,GAAG,CAAC;KACd,CAAC,CAAC;IAEH,KAAY,WAAW,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC;IAEzC,KAAY,WAAW,GAAG,UAAU,CAAC;QACnC,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;QAClB,OAAO,EAAE,GAAG,CAAC;KACd,CAAC,CAAC;IAEH,KAAY,YAAY,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC;IAE1C,KAAY,QAAQ,GAAG,UAAU,CAAC;QAChC,EAAE,EAAE,MAAM,CAAC;KACZ,CAAC,CAAC;CACJ"}
+{"version":3,"file":"layout.d.ts","sourceRoot":"","sources":["../../../../../src/plugins/common/layout.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAM5C,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAWhB,CAAC;AAEH,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,KAAK,CAAC,CAAC;AAE1C;;;;;;GAMG;AAEH,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAajB,CAAC;AAEH,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,CAAC;AAE5C;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB,WAAY,MAAM,uCAG/C,CAAC;AAOF,oBAAY,YAAY;IACtB,UAAU,sCAAgC;IAE1C,kBAAkB;IAGlB,KAAK,iCAA2B;CACjC;AAED;;GAEG;AACH,yBAAiB,YAAY,CAAC;IAC5B,KAAY,SAAS,GAAG,UAAU,CAAC;QACjC;;WAEG;QACH,OAAO,EAAE,YAAY,GAAG,SAAS,GAAG,eAAe,GAAG,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC;QAErF;;;;;WAKG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,CAAC,EAAE,GAAG,CAAC;QAEd;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC,CAAC;CACJ"}

package/dist/types/src/plugins/common/navigation.d.ts

@@ -0,0 +1,47 @@
+import { z } from 'zod';
+import type { IntentData } from '../IntentPlugin';
+import type { Plugin } from '../PluginHost';
+/**
+ * Basic state provided by a navigation plugin.
+ */
+export declare const Location: z.ZodObject<{
+    active: z.ZodOptional<z.ZodString>;
+    previous: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    active?: string | undefined;
+    previous?: string | undefined;
+}, {
+    active?: string | undefined;
+    previous?: string | undefined;
+}>;
+export type Location = z.infer<typeof Location>;
+/**
+ * Provides for a plugin that can manage the app navigation.
+ */
+export type LocationProvides = {
+    location: Readonly<Location>;
+};
+/**
+ * Type guard for layout plugins.
+ */
+export declare const parseNavigationPlugin: (plugin: Plugin) => Plugin<LocationProvides> | undefined;
+export declare enum NavigationAction {
+    ACTIVATE = "dxos.org/plugin/navigation/activate"
+}
+/**
+ * Expected payload for navigation actions.
+ */
+export declare namespace NavigationAction {
+    type Activate = IntentData<{
+        /**
+         * Id to set as active.
+         */
+        id: string;
+        /**
+         * Location of the active item.
+         * Defaults to 'main'.
+         */
+        key?: string;
+    }>;
+}
+//# sourceMappingURL=navigation.d.ts.map

package/dist/types/src/plugins/common/navigation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigation.d.ts","sourceRoot":"","sources":["../../../../../src/plugins/common/navigation.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAM5C;;GAEG;AAGH,eAAO,MAAM,QAAQ;;;;;;;;;EAInB,CAAC;AAEH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC;AAEhD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qBAAqB,WAAY,MAAM,yCAGnD,CAAC;AAOF,oBAAY,gBAAgB;IAC1B,QAAQ,wCAAkC;CAC3C;AAED;;GAEG;AACH,yBAAiB,gBAAgB,CAAC;IAChC,KAAY,QAAQ,GAAG,UAAU,CAAC;QAChC;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd,CAAC,CAAC;CACJ"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/app-framework",
-  "version": "0.4.1-main.2495eb8",
+  "version": "0.4.1-main.31058a6",
   "description": "A framework for building applications from composible plugins.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -16,13 +16,13 @@
     "@preact/signals-react": "^1.3.6",
     "deepsignal": "1.4.0-shallow.0",
     "zod": "^3.22.4",
-    "@dxos/app-graph": "0.4.1-main.2495eb8",
-    "@dxos/async": "0.4.1-main.2495eb8",
-    "@dxos/debug": "0.4.1-main.2495eb8",
-    "@dxos/invariant": "0.4.1-main.2495eb8",
-    "@dxos/util": "0.4.1-main.2495eb8",
-    "@dxos/local-storage": "0.4.1-main.2495eb8",
-    "@dxos/log": "0.4.1-main.2495eb8"
+    "@dxos/app-graph": "0.4.1-main.31058a6",
+    "@dxos/debug": "0.4.1-main.31058a6",
+    "@dxos/local-storage": "0.4.1-main.31058a6",
+    "@dxos/invariant": "0.4.1-main.31058a6",
+    "@dxos/log": "0.4.1-main.31058a6",
+    "@dxos/util": "0.4.1-main.31058a6",
+    "@dxos/async": "0.4.1-main.31058a6"
   },
   "devDependencies": {
     "@types/react": "^18.0.21",

package/src/plugins/common/index.ts

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

package/src/plugins/common/layout.ts

@@ -11,16 +11,34 @@ import type { Plugin } from '../PluginHost';
 // Provides
 //
 
+export const 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(),
+});
+
+export type Toast = z.infer<typeof Toast>;
+
 /**
  * Basic state provided by a layout plugin.
+ *
+ * Layout provides the state of global UI landmarks, such as the sidebar, dialog, and popover.
+ * Generally only one dialog or popover should be open at a time, a layout plugin should manage this.
+ * For other landmarks, such as toasts, rendering them in the layout prevents them from unmounting when navigating.
  */
-// TODO(burdon): Josiah: why do we use zod here?
+// TODO(wittjosiah): Replace Zod w/ Effect Schema to align with ECHO.
 export const Layout = z.object({
   fullscreen: z.boolean(),
   sidebarOpen: z.boolean(),
   complementarySidebarOpen: z.boolean(),
 
-  // 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.'),
 
@@ -28,10 +46,7 @@ export const Layout = z.object({
   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.'),
-  // TODO(wittjosiah): History?
-  previous: z.string().optional(),
+  toasts: z.array(Toast),
 });
 
 export type Layout = z.infer<typeof Layout>;
@@ -56,16 +71,12 @@ export const parseLayoutPlugin = (plugin: Plugin) => {
 //
 
 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`,
-  TOGGLE_SIDEBAR = `${LAYOUT_ACTION}/toggle-sidebar`,
-  TOGGLE_COMPLEMENTARY_SIDEBAR = `${LAYOUT_ACTION}/toggle-complementary-sidebar`,
-  OPEN_DIALOG = `${LAYOUT_ACTION}/open-dialog`,
-  CLOSE_DIALOG = `${LAYOUT_ACTION}/close-dialog`,
-  OPEN_POPOVER = `${LAYOUT_ACTION}/open-popover`,
-  CLOSE_POPOVER = `${LAYOUT_ACTION}/close-popover`,
-  ACTIVATE = `${LAYOUT_ACTION}/activate`,
+  SET_LAYOUT = `${LAYOUT_ACTION}/set-layout`,
+
+  /** @deprecated */
+  // TODO(wittjosiah): At minimum this should be renamed, "focus" means something very specific on a web page.
+  //   Consider removing this action entirely, it's maybe not generic enough to live here.
   FOCUS = `${LAYOUT_ACTION}/focus`,
 }
 
@@ -73,34 +84,33 @@ export enum LayoutAction {
  * Expected payload for layout actions.
  */
 export namespace LayoutAction {
-  export type ToggleFullscreen = IntentData<{
+  export type SetLayout = IntentData<{
+    /**
+     * Element to set the state of.
+     */
+    element: '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?: boolean;
-  }>;
-
-  export type ToggleSidebar = IntentData<{
-    state?: boolean;
-  }>;
 
-  export type ToggleComplementarySidebar = IntentData<{
-    state?: boolean;
-  }>;
-
-  export type OpenDialog = IntentData<{
-    component: string;
-    subject: any;
-  }>;
-
-  export type CloseDialog = IntentData<{}>;
-
-  export type OpenPopover = IntentData<{
-    anchorId: string;
-    component: string;
-    subject: any;
-  }>;
+    /**
+     * Component to render in the dialog or popover.
+     */
+    component?: string;
 
-  export type ClosePopover = IntentData<{}>;
+    /**
+     * Data to be passed to the dialog or popover Surface.
+     */
+    subject?: any;
 
-  export type Activate = IntentData<{
-    id: string;
+    /**
+     * Anchor ID for the popover.
+     */
+    anchorId?: string;
   }>;
 }

package/src/plugins/common/navigation.ts

@@ -0,0 +1,67 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { z } from 'zod';
+
+import type { IntentData } from '../IntentPlugin';
+import type { Plugin } from '../PluginHost';
+
+//
+// Provides
+//
+
+/**
+ * Basic state provided by a navigation plugin.
+ */
+// TODO(wittjosiah): Replace Zod w/ Effect Schema to align with ECHO.
+// TODO(wittjosiah): We should align this more with `window.location` along the lines of what React Router does.
+export const Location = z.object({
+  active: z.string().optional().describe('Id of the currently active item.'),
+  // TODO(wittjosiah): History?
+  previous: z.string().optional(),
+});
+
+export type Location = z.infer<typeof Location>;
+
+/**
+ * Provides for a plugin that can manage the app navigation.
+ */
+export type LocationProvides = {
+  location: Readonly<Location>;
+};
+
+/**
+ * Type guard for layout plugins.
+ */
+export const parseNavigationPlugin = (plugin: Plugin) => {
+  const { success } = Location.safeParse((plugin.provides as any).location);
+  return success ? (plugin as Plugin<LocationProvides>) : undefined;
+};
+
+//
+// Intents
+//
+
+const NAVIGATION_ACTION = 'dxos.org/plugin/navigation';
+export enum NavigationAction {
+  ACTIVATE = `${NAVIGATION_ACTION}/activate`,
+}
+
+/**
+ * Expected payload for navigation actions.
+ */
+export namespace NavigationAction {
+  export type Activate = IntentData<{
+    /**
+     * Id to set as active.
+     */
+    id: string;
+
+    /**
+     * Location of the active item.
+     * Defaults to 'main'.
+     */
+    key?: string;
+  }>;
+}