@dxos/app-framework 0.5.1-next.7f021b8 → 0.5.1-next.823fe3b

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

@@ -1,20 +1,41 @@
 import { z } from 'zod';
 import type { IntentData } from '../IntentPlugin';
 import type { Plugin } from '../PluginHost';
+export declare const SLUG_LIST_SEPARATOR = ".";
+export declare const SLUG_ENTRY_SEPARATOR = "_";
+export declare const SLUG_KEY_VALUE_SEPARATOR = "-";
+export declare const SLUG_PATH_SEPARATOR = "~";
+export declare const SLUG_COLLECTION_INDICATOR = "";
+export declare const ActiveParts: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
 /**
  * Basic state provided by a navigation plugin.
  */
 export declare const Location: z.ZodObject<{
-    active: z.ZodOptional<z.ZodString>;
-    previous: z.ZodOptional<z.ZodString>;
+    active: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>]>>;
+    closed: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
 }, "strip", z.ZodTypeAny, {
-    active?: string | undefined;
-    previous?: string | undefined;
+    active?: string | Record<string, string | string[]> | undefined;
+    closed?: string | string[] | undefined;
 }, {
-    active?: string | undefined;
-    previous?: string | undefined;
+    active?: string | Record<string, string | string[]> | undefined;
+    closed?: string | string[] | undefined;
 }>;
+export type ActiveParts = z.infer<typeof ActiveParts>;
 export type Location = z.infer<typeof Location>;
+/**
+ * Composed of [ part name, index within the part, size of the part ]
+ */
+export type PartIdentifier = [string, number, number];
+export type NavigationAdjustmentType = `${'pin' | 'increment'}-${'start' | 'end'}`;
+export type NavigationAdjustment = {
+    part: PartIdentifier;
+    type: NavigationAdjustmentType;
+};
+export declare const isActiveParts: (active: string | ActiveParts | undefined) => active is Record<string, string | string[]>;
+export declare const isAdjustTransaction: (data: IntentData | undefined) => data is NavigationAdjustment;
+export declare const firstMainId: (active: Location['active']) => string;
+export declare const activeIds: (active: string | ActiveParts | undefined) => Set<string>;
+export declare const isIdActive: (active: string | ActiveParts | undefined, id: string) => boolean;
 /**
  * Provides for a plugin that can manage the app navigation.
  */
@@ -26,22 +47,29 @@ export type LocationProvides = {
  */
 export declare const parseNavigationPlugin: (plugin: Plugin) => Plugin<LocationProvides> | undefined;
 export declare enum NavigationAction {
-    ACTIVATE = "dxos.org/plugin/navigation/activate"
+    OPEN = "dxos.org/plugin/navigation/open",
+    ADJUST = "dxos.org/plugin/navigation/adjust",
+    CLOSE = "dxos.org/plugin/navigation/close"
 }
 /**
  * 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;
+    /**
+     * An additive overlay to apply to `location.active` (i.e. the result is a union of previous active and the argument)
+     */
+    type Open = IntentData<{
+        activeParts: ActiveParts;
+    }>;
+    /**
+     * A subtractive overlay to apply to `location.active` (i.e. the result is a subtraction from the previous active of the argument)
+     */
+    type Close = IntentData<{
+        activeParts: ActiveParts;
     }>;
+    /**
+     * An atomic transaction to apply to `location.active`, describing which element to (attempt to) move to which location.
+     */
+    type Adjust = IntentData<NavigationAdjustment>;
 }
 //# sourceMappingURL=navigation.d.ts.map

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

@@ -1 +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"}
+{"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;AAG5C,eAAO,MAAM,mBAAmB,MAAM,CAAC;AACvC,eAAO,MAAM,oBAAoB,MAAM,CAAC;AACxC,eAAO,MAAM,wBAAwB,MAAM,CAAC;AAC5C,eAAO,MAAM,mBAAmB,MAAM,CAAC;AACvC,eAAO,MAAM,yBAAyB,KAAK,CAAC;AAM5C,eAAO,MAAM,WAAW,sFAAmE,CAAC;AAE5F;;GAEG;AAGH,eAAO,MAAM,QAAQ;;;;;;;;;EASnB,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AACtD,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC;AAChD;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AACtD,MAAM,MAAM,wBAAwB,GAAG,GAAG,KAAK,GAAG,WAAW,IAAI,OAAO,GAAG,KAAK,EAAE,CAAC;AACnF,MAAM,MAAM,oBAAoB,GAAG;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,IAAI,EAAE,wBAAwB,CAAA;CAAE,CAAC;AAE5F,eAAO,MAAM,aAAa,WAAY,MAAM,GAAG,WAAW,GAAG,SAAS,gDAC9B,CAAC;AAEzC,eAAO,MAAM,mBAAmB,SAAU,UAAU,GAAG,SAAS,iCACpB,CAAC;AAE7C,eAAO,MAAM,WAAW,WAAY,QAAQ,CAAC,QAAQ,CAAC,KAAG,MAC2C,CAAC;AAErG,eAAO,MAAM,SAAS,WAAY,MAAM,GAAG,WAAW,GAAG,SAAS,KAAG,IAAI,MAAM,CAQhE,CAAC;AAEhB,eAAO,MAAM,UAAU,WAAY,MAAM,GAAG,WAAW,GAAG,SAAS,MAAM,MAAM,KAAG,OAMjF,CAAC;AAEF;;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,IAAI,oCAA8B;IAClC,MAAM,sCAAgC;IACtC,KAAK,qCAA+B;CACrC;AAED;;GAEG;AACH,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,KAAY,IAAI,GAAG,UAAU,CAAC;QAAE,WAAW,EAAE,WAAW,CAAA;KAAE,CAAC,CAAC;IAC5D;;OAEG;IACH,KAAY,KAAK,GAAG,UAAU,CAAC;QAAE,WAAW,EAAE,WAAW,CAAA;KAAE,CAAC,CAAC;IAC7D;;OAEG;IACH,KAAY,MAAM,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;CACvD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/app-framework",
-  "version": "0.5.1-next.7f021b8",
+  "version": "0.5.1-next.823fe3b",
   "description": "A framework for building applications from composible plugins.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -15,14 +15,14 @@
     "@phosphor-icons/react": "^2.1.5",
     "@preact/signals-core": "^1.6.0",
     "zod": "^3.22.4",
-    "@dxos/app-graph": "0.5.1-next.7f021b8",
-    "@dxos/debug": "0.5.1-next.7f021b8",
-    "@dxos/async": "0.5.1-next.7f021b8",
-    "@dxos/echo-schema": "0.5.1-next.7f021b8",
-    "@dxos/invariant": "0.5.1-next.7f021b8",
-    "@dxos/local-storage": "0.5.1-next.7f021b8",
-    "@dxos/log": "0.5.1-next.7f021b8",
-    "@dxos/util": "0.5.1-next.7f021b8"
+    "@dxos/app-graph": "0.5.1-next.823fe3b",
+    "@dxos/async": "0.5.1-next.823fe3b",
+    "@dxos/debug": "0.5.1-next.823fe3b",
+    "@dxos/echo-schema": "0.5.1-next.823fe3b",
+    "@dxos/invariant": "0.5.1-next.823fe3b",
+    "@dxos/local-storage": "0.5.1-next.823fe3b",
+    "@dxos/log": "0.5.1-next.823fe3b",
+    "@dxos/util": "0.5.1-next.823fe3b"
   },
   "devDependencies": {
     "@types/react": "^18.0.21",

package/src/plugins/common/layout.ts

@@ -36,10 +36,17 @@ export type Toast = z.infer<typeof Toast>;
 // 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(),
-  complementarySidebarContent: z.any().optional().describe('Data to be passed to the complementary sidebar Surface.'),
+  /**
+   * @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.'),

package/src/plugins/common/navigation.ts

@@ -7,22 +7,70 @@ import { z } from 'zod';
 import type { IntentData } from '../IntentPlugin';
 import type { Plugin } from '../PluginHost';
 
+// NOTE(thure): These are chosen from RFC 1738’s `safe` characters: http://www.faqs.org/rfcs/rfc1738.html
+export const SLUG_LIST_SEPARATOR = '.';
+export const SLUG_ENTRY_SEPARATOR = '_';
+export const SLUG_KEY_VALUE_SEPARATOR = '-';
+export const SLUG_PATH_SEPARATOR = '~';
+export const SLUG_COLLECTION_INDICATOR = '';
+
 //
 // Provides
 //
 
+export const ActiveParts = z.record(z.string(), z.union([z.string(), z.array(z.string())]));
+
 /**
  * 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(),
+  active: z
+    .union([z.string(), ActiveParts])
+    .optional()
+    .describe('Id of currently active item, or record of item id(s) keyed by the app part in which they are active.'),
+  closed: z
+    .union([z.string(), z.array(z.string())])
+    .optional()
+    .describe('Id or ids of recently closed items, in order of when they were closed.'),
 });
 
+export type ActiveParts = z.infer<typeof ActiveParts>;
 export type Location = z.infer<typeof Location>;
+/**
+ * Composed of [ part name, index within the part, size of the part ]
+ */
+export type PartIdentifier = [string, number, number];
+export type NavigationAdjustmentType = `${'pin' | 'increment'}-${'start' | 'end'}`;
+export type NavigationAdjustment = { part: PartIdentifier; type: NavigationAdjustmentType };
+
+export const isActiveParts = (active: string | ActiveParts | undefined): active is ActiveParts =>
+  !!active && typeof active !== 'string';
+
+export const isAdjustTransaction = (data: IntentData | undefined): data is NavigationAdjustment =>
+  !!data && 'part' in data && 'type' in data;
+
+export const firstMainId = (active: Location['active']): string =>
+  isActiveParts(active) ? (Array.isArray(active.main) ? active.main[0] : active.main) : active ?? '';
+
+export const activeIds = (active: string | ActiveParts | undefined): Set<string> =>
+  active
+    ? isActiveParts(active)
+      ? Object.values(active).reduce((acc, ids) => {
+          Array.isArray(ids) ? ids.forEach((id) => acc.add(id)) : acc.add(ids);
+          return acc;
+        }, new Set<string>())
+      : new Set([active])
+    : new Set();
+
+export const isIdActive = (active: string | ActiveParts | undefined, id: string): boolean => {
+  return active
+    ? isActiveParts(active)
+      ? Object.values(active).findIndex((ids) => (Array.isArray(ids) ? ids.indexOf(id) > -1 : ids === id)) > -1
+      : active === id
+    : false;
+};
 
 /**
  * Provides for a plugin that can manage the app navigation.
@@ -45,23 +93,25 @@ export const parseNavigationPlugin = (plugin: Plugin) => {
 
 const NAVIGATION_ACTION = 'dxos.org/plugin/navigation';
 export enum NavigationAction {
-  ACTIVATE = `${NAVIGATION_ACTION}/activate`,
+  OPEN = `${NAVIGATION_ACTION}/open`,
+  ADJUST = `${NAVIGATION_ACTION}/adjust`,
+  CLOSE = `${NAVIGATION_ACTION}/close`,
 }
 
 /**
  * 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;
-  }>;
+  /**
+   * An additive overlay to apply to `location.active` (i.e. the result is a union of previous active and the argument)
+   */
+  export type Open = IntentData<{ activeParts: ActiveParts }>;
+  /**
+   * A subtractive overlay to apply to `location.active` (i.e. the result is a subtraction from the previous active of the argument)
+   */
+  export type Close = IntentData<{ activeParts: ActiveParts }>;
+  /**
+   * An atomic transaction to apply to `location.active`, describing which element to (attempt to) move to which location.
+   */
+  export type Adjust = IntentData<NavigationAdjustment>;
 }