@juicemantics/veloiq-ui 0.2.2 → 0.6.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 JuiceMantics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.mts

@@ -8,6 +8,36 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as _tanstack_query_core from '@tanstack/query-core';
 import * as antd from 'antd';
 
+/** One entry in navigation.config.json — one per module or model. */
+interface NavConfigEntry {
+    /** Refine resource key: "module:tasks", "task", "dashboard" */
+    key: string;
+    /** Human-readable display label */
+    label: string;
+    /** Ant Design icon component name, e.g. "UserOutlined" */
+    icon: string;
+    /** Display order — lower numbers appear first; ties keep original registration order */
+    sequence: number;
+    /** "module" for a top-level group, "model" for a leaf resource */
+    type: "module" | "model";
+}
+type NavConfig = NavConfigEntry[];
+/** Guess an Ant Design icon name from a resource name or label. */
+declare function guessIcon(text: string, isModule?: boolean): string;
+/** Resolve an icon name string to a React element using the AntD icon registry. */
+declare function resolveIcon(iconName: string): React__default.ReactNode;
+/** Find a NavConfigEntry by exact resource key. */
+declare function getNavEntry(navConfig: NavConfig, key: string): NavConfigEntry | undefined;
+/**
+ * Sort items by the `sequence` values in navConfig.
+ * Items without a matching entry sort to the end (sequence = 999).
+ * Original array order serves as a stable tiebreaker.
+ */
+declare function sortItemsByNavConfig<T extends {
+    key?: string;
+    name?: string;
+}>(items: T[], navConfig: NavConfig): T[];
+
 interface LayoutWrapperProps {
     children?: React__default.ReactNode;
     /** Logo element or image URL shown in header and sider. */
@@ -21,9 +51,18 @@ interface LayoutWrapperProps {
         icon?: React__default.ReactNode;
         onClick?: () => void;
     }>;
+    /** Navigation config loaded from navigation.config.json — drives icons and sort order. */
+    navConfig?: NavConfig;
 }
 declare const LayoutWrapper: React__default.FC<LayoutWrapperProps>;
 
+interface CommandCenterPortalProps {
+    open: boolean;
+    onClose: () => void;
+    navConfig?: NavConfig;
+}
+declare const CommandCenterPortal: React__default.FC<CommandCenterPortalProps>;
+
 declare const MultiPaneLayout: React__default.FC<{
     children: React__default.ReactNode;
 }>;
@@ -44,9 +83,12 @@ declare const CustomSider: React__default.FC<{
     collapsed?: boolean;
     logo?: React__default.ReactNode | string;
     appTitle?: string;
+    navConfig?: NavConfig;
 }>;
 
-declare const HorizontalMenu: React__default.FC;
+declare const HorizontalMenu: React__default.FC<{
+    navConfig?: NavConfig;
+}>;
 
 type ExecutableHtmlProps = {
     html?: string;
@@ -110,7 +152,7 @@ interface FieldDef {
     /** Roles allowed to write this field (absent = all roles). Emitted by veloiq_field(write_roles=…). */
     writeRoles?: string[];
 }
-type RelationViewType = "table" | "editable-table" | "editable-list" | "list" | "csv" | "read-and-edit-list" | "read-and-edit-csv" | "editable-csv" | "gallery" | "calendar" | "primary" | "totals-details" | "tree" | "tree-details";
+type RelationViewType = "table" | "editable-table" | "crosstab" | "editable-crosstab" | "editable-list" | "list" | "csv" | "read-and-edit-list" | "read-and-edit-csv" | "editable-csv" | "gallery" | "calendar" | "primary" | "totals-details" | "tree" | "tree-details";
 interface MillerLeafConfig {
     relationPath: string;
     targetKey: string;
@@ -247,7 +289,11 @@ declare const ModelHeading: React__default.FC<{
     actionLabel?: string;
 }>;
 
-declare const useShowActionsPreferences: (model: ModelDef, allModels?: ModelDef[], record?: any, saveButtonProps?: any) => {
+declare const useShowActionsPreferences: (model: ModelDef, allModels?: ModelDef[], record?: any, saveButtonProps?: any, configureLayoutButtonRef?: {
+    current: React__default.ReactNode;
+}, saveLayoutRef?: {
+    current: () => void;
+}) => {
     actionsState: {
         showActions: boolean;
         showCreate: boolean;
@@ -301,10 +347,19 @@ declare const useStandardShowTabs: (model: ModelDef | undefined, record: any, al
     formProps?: any;
     effectiveFields?: FieldDef[];
 }, overrideConfigRows?: ViewConfigRow[]) => {
-    key: string;
-    label: React__default.ReactNode;
-    children: React__default.ReactNode;
-}[];
+    tabs: {
+        key: string;
+        label: React__default.ReactNode;
+        children: React__default.ReactNode;
+    }[];
+    layoutConfig: {
+        isConfiguring: boolean;
+        enterConfigMode: () => void;
+        saveLayout: () => void;
+        cancelLayout: () => void;
+        hasConfig: boolean;
+    };
+};
 
 declare const renderRelationBlock: ({ rel, relationModel, relatedModel, record, mode, parentResource, allModels, showLabel, showActions, showCreate, relationViewTypeDefaults, labelStyle, valueStyle, fieldLayoutStyle, }: {
     rel: RelationDef;
@@ -335,7 +390,7 @@ declare const DynamicList: React__default.FC<{
     showActions?: boolean;
     showCreate?: boolean;
     layoutPreferenceType?: "ShowLayout" | "EditLayout";
-    listViewType?: "table" | "gallery" | "calendar" | "totals-details";
+    listViewType?: "table" | "gallery" | "calendar" | "totals-details" | "crosstab" | "editable-crosstab";
     rowSelection?: any;
     extraHeaderButtons?: React__default.ReactNode;
     bulkActions?: BulkActionDef[];
@@ -407,6 +462,19 @@ interface ResourceContextValue {
 }
 declare const ResourceContext: React$1.Context<ResourceContextValue>;
 
+/**
+ * Makes the app's navigation.config.json available to any component rendered
+ * inside LayoutWrapper (including extension-contributed routes). This is the
+ * authoritative list of modules ("module:{name}" entries) and their labels.
+ */
+declare const NavConfigContext: React$1.Context<NavConfig>;
+declare const useNavConfig: () => NavConfig;
+/** Convenience: module entries from the nav config as {value, label} options. */
+declare function useNavModules(): {
+    value: string;
+    label: string;
+}[];
+
 interface LoginPageProps {
     /** App title shown on the login card. Defaults to "VeloIQ". */
     appTitle?: string;
@@ -417,10 +485,11 @@ declare const LoginPage: React__default.FC<LoginPageProps>;
 
 declare const DashboardPage: React__default.FC;
 
+type CellSourceType = "model" | "named_query" | "field" | "relation" | "custom";
 interface DashboardCell {
     id: string;
     model: string;
-    source_type: "model";
+    source_type: CellSourceType;
     row: number;
     col: number;
     view_type: string | null;
@@ -429,6 +498,8 @@ interface DashboardCell {
     max_width: string | null;
     min_height: string | null;
     max_height: string | null;
+    section_name?: string;
+    section_id?: string;
 }
 interface DashboardTab {
     id: string;
@@ -440,12 +511,22 @@ interface DashboardConfig {
     tabs: DashboardTab[];
 }
 
-interface Props {
+interface Props$1 {
     config: DashboardConfig;
     allModels: ModelDef[];
     onConfigChange: (next: DashboardConfig) => void;
 }
-declare const ViewsGrid: React__default.FC<Props>;
+declare const ViewsGrid: React__default.FC<Props$1>;
+
+interface Props {
+    cells: DashboardCell[];
+    config: DashboardConfig;
+    tabId: string;
+    renderContent: (cell: DashboardCell) => React__default.ReactNode;
+    onConfigChange: (next: DashboardConfig) => void;
+    isConfiguring?: boolean;
+}
+declare const SectionsGrid: React__default.FC<Props>;
 
 declare const RecentActivityPanel: React__default.FC;
 
@@ -480,6 +561,24 @@ type ShortcutDef = {
 };
 declare function useKeyboardShortcuts(shortcuts: ShortcutDef[]): void;
 
+interface RecordResult {
+    id: number | string;
+    label: string;
+}
+interface ModelSearchResult {
+    modelName: string;
+    modelLabel: string;
+    resource: string;
+    records: RecordResult[];
+}
+interface UseRecordSearchReturn {
+    results: ModelSearchResult[];
+    searching: boolean;
+    search: (query: string) => void;
+    clear: () => void;
+}
+declare function useRecordSearch(): UseRecordSearchReturn;
+
 interface ResourceDef {
     name: string;
     list: string;
@@ -537,4 +636,4 @@ declare const getModelTone: (modelLike?: string | {
 
 declare const authSystemModels: ModelDef[];
 
-export { API_URL, AllModelsProvider, type BulkActionDef, ColorModeContext, ColorModeContextProvider, CustomSider, type DashboardCell, type DashboardConfig, DashboardPage, type DashboardTab, DynamicCreate, DynamicEdit, DynamicList, DynamicShow, ExecutableHtml, type FieldDef, GlobalSearch, HierarchyView, HorizontalMenu, InlinePlotlyHtml, LayoutWrapper, type LayoutWrapperProps, LoginPage, type LoginPageProps, type MillerLeafConfig, type ModelDef, ModelHeading, MultiPaneLayout, PaneNavigationContext, PinnedRecordsPanel, PrimaryShowContext, type PrimaryShowRendererProps, type RecentActivityData, type RecentActivityGroup, RecentActivityPanel, type RecentRecord, ReferenceField, type RelationDef, ResourceContext, type ResourceDef, ShowFooterButtons, StandardList, StandardShow, type ViewConfigRow, ViewsGrid, accessControlProvider, authProvider, authSystemModels, authenticatedFetch, buildShowTabFormOptions, generateResources, getModelTone, httpClient, normalizeToneKey, renderRelationBlock, setColorSchemas, useAllModels, useKeyboardShortcuts, useMetadataModal, usePaneNavigation, useShowActionsPreferences, useShowEditableForm, useStandardShowTabs };
+export { API_URL, AllModelsProvider, type BulkActionDef, type CellSourceType, ColorModeContext, ColorModeContextProvider, CommandCenterPortal, type CommandCenterPortalProps, CustomSider, type DashboardCell, type DashboardConfig, DashboardPage, type DashboardTab, DynamicCreate, DynamicEdit, DynamicList, DynamicShow, ExecutableHtml, type FieldDef, GlobalSearch, HierarchyView, HorizontalMenu, InlinePlotlyHtml, LayoutWrapper, type LayoutWrapperProps, LoginPage, type LoginPageProps, type MillerLeafConfig, type ModelDef, ModelHeading, type ModelSearchResult, MultiPaneLayout, type NavConfig, NavConfigContext, type NavConfigEntry, PaneNavigationContext, PinnedRecordsPanel, PrimaryShowContext, type PrimaryShowRendererProps, type RecentActivityData, type RecentActivityGroup, RecentActivityPanel, type RecentRecord, type RecordResult, ReferenceField, type RelationDef, ResourceContext, type ResourceDef, SectionsGrid, ShowFooterButtons, StandardList, StandardShow, type UseRecordSearchReturn, type ViewConfigRow, ViewsGrid, accessControlProvider, authProvider, authSystemModels, authenticatedFetch, buildShowTabFormOptions, generateResources, getModelTone, getNavEntry, guessIcon, httpClient, normalizeToneKey, renderRelationBlock, resolveIcon, setColorSchemas, sortItemsByNavConfig, useAllModels, useKeyboardShortcuts, useMetadataModal, useNavConfig, useNavModules, usePaneNavigation, useRecordSearch, useShowActionsPreferences, useShowEditableForm, useStandardShowTabs };

package/dist/index.d.ts

@@ -8,6 +8,36 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as _tanstack_query_core from '@tanstack/query-core';
 import * as antd from 'antd';
 
+/** One entry in navigation.config.json — one per module or model. */
+interface NavConfigEntry {
+    /** Refine resource key: "module:tasks", "task", "dashboard" */
+    key: string;
+    /** Human-readable display label */
+    label: string;
+    /** Ant Design icon component name, e.g. "UserOutlined" */
+    icon: string;
+    /** Display order — lower numbers appear first; ties keep original registration order */
+    sequence: number;
+    /** "module" for a top-level group, "model" for a leaf resource */
+    type: "module" | "model";
+}
+type NavConfig = NavConfigEntry[];
+/** Guess an Ant Design icon name from a resource name or label. */
+declare function guessIcon(text: string, isModule?: boolean): string;
+/** Resolve an icon name string to a React element using the AntD icon registry. */
+declare function resolveIcon(iconName: string): React__default.ReactNode;
+/** Find a NavConfigEntry by exact resource key. */
+declare function getNavEntry(navConfig: NavConfig, key: string): NavConfigEntry | undefined;
+/**
+ * Sort items by the `sequence` values in navConfig.
+ * Items without a matching entry sort to the end (sequence = 999).
+ * Original array order serves as a stable tiebreaker.
+ */
+declare function sortItemsByNavConfig<T extends {
+    key?: string;
+    name?: string;
+}>(items: T[], navConfig: NavConfig): T[];
+
 interface LayoutWrapperProps {
     children?: React__default.ReactNode;
     /** Logo element or image URL shown in header and sider. */
@@ -21,9 +51,18 @@ interface LayoutWrapperProps {
         icon?: React__default.ReactNode;
         onClick?: () => void;
     }>;
+    /** Navigation config loaded from navigation.config.json — drives icons and sort order. */
+    navConfig?: NavConfig;
 }
 declare const LayoutWrapper: React__default.FC<LayoutWrapperProps>;
 
+interface CommandCenterPortalProps {
+    open: boolean;
+    onClose: () => void;
+    navConfig?: NavConfig;
+}
+declare const CommandCenterPortal: React__default.FC<CommandCenterPortalProps>;
+
 declare const MultiPaneLayout: React__default.FC<{
     children: React__default.ReactNode;
 }>;
@@ -44,9 +83,12 @@ declare const CustomSider: React__default.FC<{
     collapsed?: boolean;
     logo?: React__default.ReactNode | string;
     appTitle?: string;
+    navConfig?: NavConfig;
 }>;
 
-declare const HorizontalMenu: React__default.FC;
+declare const HorizontalMenu: React__default.FC<{
+    navConfig?: NavConfig;
+}>;
 
 type ExecutableHtmlProps = {
     html?: string;
@@ -110,7 +152,7 @@ interface FieldDef {
     /** Roles allowed to write this field (absent = all roles). Emitted by veloiq_field(write_roles=…). */
     writeRoles?: string[];
 }
-type RelationViewType = "table" | "editable-table" | "editable-list" | "list" | "csv" | "read-and-edit-list" | "read-and-edit-csv" | "editable-csv" | "gallery" | "calendar" | "primary" | "totals-details" | "tree" | "tree-details";
+type RelationViewType = "table" | "editable-table" | "crosstab" | "editable-crosstab" | "editable-list" | "list" | "csv" | "read-and-edit-list" | "read-and-edit-csv" | "editable-csv" | "gallery" | "calendar" | "primary" | "totals-details" | "tree" | "tree-details";
 interface MillerLeafConfig {
     relationPath: string;
     targetKey: string;
@@ -247,7 +289,11 @@ declare const ModelHeading: React__default.FC<{
     actionLabel?: string;
 }>;
 
-declare const useShowActionsPreferences: (model: ModelDef, allModels?: ModelDef[], record?: any, saveButtonProps?: any) => {
+declare const useShowActionsPreferences: (model: ModelDef, allModels?: ModelDef[], record?: any, saveButtonProps?: any, configureLayoutButtonRef?: {
+    current: React__default.ReactNode;
+}, saveLayoutRef?: {
+    current: () => void;
+}) => {
     actionsState: {
         showActions: boolean;
         showCreate: boolean;
@@ -301,10 +347,19 @@ declare const useStandardShowTabs: (model: ModelDef | undefined, record: any, al
     formProps?: any;
     effectiveFields?: FieldDef[];
 }, overrideConfigRows?: ViewConfigRow[]) => {
-    key: string;
-    label: React__default.ReactNode;
-    children: React__default.ReactNode;
-}[];
+    tabs: {
+        key: string;
+        label: React__default.ReactNode;
+        children: React__default.ReactNode;
+    }[];
+    layoutConfig: {
+        isConfiguring: boolean;
+        enterConfigMode: () => void;
+        saveLayout: () => void;
+        cancelLayout: () => void;
+        hasConfig: boolean;
+    };
+};
 
 declare const renderRelationBlock: ({ rel, relationModel, relatedModel, record, mode, parentResource, allModels, showLabel, showActions, showCreate, relationViewTypeDefaults, labelStyle, valueStyle, fieldLayoutStyle, }: {
     rel: RelationDef;
@@ -335,7 +390,7 @@ declare const DynamicList: React__default.FC<{
     showActions?: boolean;
     showCreate?: boolean;
     layoutPreferenceType?: "ShowLayout" | "EditLayout";
-    listViewType?: "table" | "gallery" | "calendar" | "totals-details";
+    listViewType?: "table" | "gallery" | "calendar" | "totals-details" | "crosstab" | "editable-crosstab";
     rowSelection?: any;
     extraHeaderButtons?: React__default.ReactNode;
     bulkActions?: BulkActionDef[];
@@ -407,6 +462,19 @@ interface ResourceContextValue {
 }
 declare const ResourceContext: React$1.Context<ResourceContextValue>;
 
+/**
+ * Makes the app's navigation.config.json available to any component rendered
+ * inside LayoutWrapper (including extension-contributed routes). This is the
+ * authoritative list of modules ("module:{name}" entries) and their labels.
+ */
+declare const NavConfigContext: React$1.Context<NavConfig>;
+declare const useNavConfig: () => NavConfig;
+/** Convenience: module entries from the nav config as {value, label} options. */
+declare function useNavModules(): {
+    value: string;
+    label: string;
+}[];
+
 interface LoginPageProps {
     /** App title shown on the login card. Defaults to "VeloIQ". */
     appTitle?: string;
@@ -417,10 +485,11 @@ declare const LoginPage: React__default.FC<LoginPageProps>;
 
 declare const DashboardPage: React__default.FC;
 
+type CellSourceType = "model" | "named_query" | "field" | "relation" | "custom";
 interface DashboardCell {
     id: string;
     model: string;
-    source_type: "model";
+    source_type: CellSourceType;
     row: number;
     col: number;
     view_type: string | null;
@@ -429,6 +498,8 @@ interface DashboardCell {
     max_width: string | null;
     min_height: string | null;
     max_height: string | null;
+    section_name?: string;
+    section_id?: string;
 }
 interface DashboardTab {
     id: string;
@@ -440,12 +511,22 @@ interface DashboardConfig {
     tabs: DashboardTab[];
 }
 
-interface Props {
+interface Props$1 {
     config: DashboardConfig;
     allModels: ModelDef[];
     onConfigChange: (next: DashboardConfig) => void;
 }
-declare const ViewsGrid: React__default.FC<Props>;
+declare const ViewsGrid: React__default.FC<Props$1>;
+
+interface Props {
+    cells: DashboardCell[];
+    config: DashboardConfig;
+    tabId: string;
+    renderContent: (cell: DashboardCell) => React__default.ReactNode;
+    onConfigChange: (next: DashboardConfig) => void;
+    isConfiguring?: boolean;
+}
+declare const SectionsGrid: React__default.FC<Props>;
 
 declare const RecentActivityPanel: React__default.FC;
 
@@ -480,6 +561,24 @@ type ShortcutDef = {
 };
 declare function useKeyboardShortcuts(shortcuts: ShortcutDef[]): void;
 
+interface RecordResult {
+    id: number | string;
+    label: string;
+}
+interface ModelSearchResult {
+    modelName: string;
+    modelLabel: string;
+    resource: string;
+    records: RecordResult[];
+}
+interface UseRecordSearchReturn {
+    results: ModelSearchResult[];
+    searching: boolean;
+    search: (query: string) => void;
+    clear: () => void;
+}
+declare function useRecordSearch(): UseRecordSearchReturn;
+
 interface ResourceDef {
     name: string;
     list: string;
@@ -537,4 +636,4 @@ declare const getModelTone: (modelLike?: string | {
 
 declare const authSystemModels: ModelDef[];
 
-export { API_URL, AllModelsProvider, type BulkActionDef, ColorModeContext, ColorModeContextProvider, CustomSider, type DashboardCell, type DashboardConfig, DashboardPage, type DashboardTab, DynamicCreate, DynamicEdit, DynamicList, DynamicShow, ExecutableHtml, type FieldDef, GlobalSearch, HierarchyView, HorizontalMenu, InlinePlotlyHtml, LayoutWrapper, type LayoutWrapperProps, LoginPage, type LoginPageProps, type MillerLeafConfig, type ModelDef, ModelHeading, MultiPaneLayout, PaneNavigationContext, PinnedRecordsPanel, PrimaryShowContext, type PrimaryShowRendererProps, type RecentActivityData, type RecentActivityGroup, RecentActivityPanel, type RecentRecord, ReferenceField, type RelationDef, ResourceContext, type ResourceDef, ShowFooterButtons, StandardList, StandardShow, type ViewConfigRow, ViewsGrid, accessControlProvider, authProvider, authSystemModels, authenticatedFetch, buildShowTabFormOptions, generateResources, getModelTone, httpClient, normalizeToneKey, renderRelationBlock, setColorSchemas, useAllModels, useKeyboardShortcuts, useMetadataModal, usePaneNavigation, useShowActionsPreferences, useShowEditableForm, useStandardShowTabs };
+export { API_URL, AllModelsProvider, type BulkActionDef, type CellSourceType, ColorModeContext, ColorModeContextProvider, CommandCenterPortal, type CommandCenterPortalProps, CustomSider, type DashboardCell, type DashboardConfig, DashboardPage, type DashboardTab, DynamicCreate, DynamicEdit, DynamicList, DynamicShow, ExecutableHtml, type FieldDef, GlobalSearch, HierarchyView, HorizontalMenu, InlinePlotlyHtml, LayoutWrapper, type LayoutWrapperProps, LoginPage, type LoginPageProps, type MillerLeafConfig, type ModelDef, ModelHeading, type ModelSearchResult, MultiPaneLayout, type NavConfig, NavConfigContext, type NavConfigEntry, PaneNavigationContext, PinnedRecordsPanel, PrimaryShowContext, type PrimaryShowRendererProps, type RecentActivityData, type RecentActivityGroup, RecentActivityPanel, type RecentRecord, type RecordResult, ReferenceField, type RelationDef, ResourceContext, type ResourceDef, SectionsGrid, ShowFooterButtons, StandardList, StandardShow, type UseRecordSearchReturn, type ViewConfigRow, ViewsGrid, accessControlProvider, authProvider, authSystemModels, authenticatedFetch, buildShowTabFormOptions, generateResources, getModelTone, getNavEntry, guessIcon, httpClient, normalizeToneKey, renderRelationBlock, resolveIcon, setColorSchemas, sortItemsByNavConfig, useAllModels, useKeyboardShortcuts, useMetadataModal, useNavConfig, useNavModules, usePaneNavigation, useRecordSearch, useShowActionsPreferences, useShowEditableForm, useStandardShowTabs };