@opencxh/domain 1.296.1 → 1.297.0

package/dist/platform/nav-model.d.ts

@@ -0,0 +1,66 @@
+import { IconDefinition } from './common';
+import { AppManifest } from './manifest';
+import { NavEntry, OrgWorkspaceConfig, UserWorkspacePrefs, WorkspaceDefinition, WorkspaceIndex } from './navigation';
+/** i18n key (shell or app namespace) or text an organization typed. */
+export type NavLabel = {
+    key: string;
+} | {
+    text: string;
+};
+/** A label to text: typed text as is, a bare key from the shell namespace, `app:key` as given. */
+export declare function navLabelText(label: NavLabel | undefined, t: (key: string) => string): string;
+export interface NavItem {
+    app: string;
+    entry: NavEntry;
+}
+export interface NavSection {
+    key: string;
+    /** Absent = no heading. */
+    label?: NavLabel;
+    items: NavItem[];
+}
+export interface NavWorkspace {
+    /** Workspace key; `"apps"` for an app's own, together with `app`. */
+    key: string;
+    app?: string;
+    group: "workspaces" | "apps";
+    label: NavLabel;
+    /** A Lucide name for a workspace; an app's own icon definition for its own workspace. */
+    icon: string | IconDefinition;
+    sections: NavSection[];
+}
+/** A shared workspace as the organization and the user can change it, shown to them or not. */
+export interface NavWorkspaceChoice extends NavWorkspace {
+    /** `own`: the organization made it; `default`: from domain, `customized` when it has config. */
+    kind: "default" | "own";
+    customized: boolean;
+    /** In this user's switcher. */
+    visible: boolean;
+    /** In it without the user's own on/off (organization default and audience). */
+    visibleByDefault: boolean;
+}
+export interface NavModel {
+    /** What the switcher lists, in order: shared workspaces, then the apps' own. */
+    workspaces: NavWorkspace[];
+    /**
+     * Every shared workspace that exists, in switcher order, visible or not, sections before
+     * permissions: the organization's editor and the user's "customize" list.
+     */
+    all: NavWorkspaceChoice[];
+    index: WorkspaceIndex;
+    /** The column of `/apps/<app>` for every app with entries, listed in the switcher or not. */
+    ownColumn: (app: string) => NavWorkspace | undefined;
+    /** A default or organization key, visible to this user or not: a URL segment to correct. */
+    isWorkspaceKey: (key: string) => boolean;
+}
+export interface NavModelInput {
+    /** Installed and allowed apps. */
+    manifests: readonly AppManifest[];
+    defaults: readonly WorkspaceDefinition[];
+    org: readonly OrgWorkspaceConfig[];
+    prefs: UserWorkspacePrefs;
+    teamIds: readonly string[];
+    can: (permission: string) => boolean;
+}
+/** Manifests + organization config + user prefs + permissions → the switcher and every column. */
+export declare function buildNavModel(input: NavModelInput): NavModel;

package/dist/platform/nav-model.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/platform/navigation.d.ts

@@ -150,6 +150,11 @@ export interface OrgWorkspaceConfig {
     /** Default entries the organization took out of a default workspace. */
     excluded?: NavEntryRef[];
 }
+/**
+ * The URL key of an organization's own workspace, from its name at creation: never a default key, a
+ * reserved segment or one already `taken`. It never changes after, so a rename keeps every link.
+ */
+export declare function ownWorkspaceKey(label: string, taken: readonly string[]): string;
 /** What one user changes: which workspaces they see. Never the contents. */
 export interface UserWorkspacePrefs {
     /** Turned on although hidden by default. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opencxh/domain",
-  "version": "1.296.1",
+  "version": "1.297.0",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",