@objectstack/platform-objects 0.1.0

package/dist/apps/index.d.ts

@@ -0,0 +1,427 @@
+import { App, ListView } from '@objectstack/spec/ui';
+import * as _objectstack_spec_data from '@objectstack/spec/data';
+
+/**
+ * Platform Setup App — static definition.
+ *
+ * Lists every `sys_*` administrative object as a left-hand navigation
+ * entry in ObjectUI's "Setup" area. Lives here (alongside the object
+ * schemas it references) instead of being assembled at runtime by
+ * `@objectstack/plugin-setup` — that plugin existed only because the
+ * referenced objects used to live in three different runtime plugins
+ * (auth/security/audit). Now that all `sys_*` objects are centralized
+ * in `@objectstack/platform-objects`, the Setup App is a fixed metadata
+ * artifact too and can be exported as plain data.
+ *
+ * The runtime registration happens in `plugin-auth` (which is always
+ * loaded alongside security + audit and already calls
+ * `manifest.register({...})`).
+ *
+ * Menu shape: flat `navigation[]` with `type: 'group'` category nodes,
+ * matching the convention used by the CRM example app
+ * (`examples/app-crm/src/apps/crm.app.ts`). The legacy `areas[]` shape
+ * was abandoned because it rendered poorly compared to the category
+ * style ObjectUI is built around.
+ */
+
+declare const SETUP_APP: App;
+
+/**
+ * Default list view for sys_user administration.
+ * Displays all users with key identity fields.
+ */
+declare const UsersView: ListView;
+
+/**
+ * Default list view for sys_organization administration.
+ * Displays all organizations with key metadata.
+ */
+declare const OrganizationsView: ListView;
+
+/**
+ * Default list view for sys_role administration.
+ * Displays all platform roles with permission summary.
+ */
+declare const RolesView: ListView;
+
+/**
+ * Default list view for sys_session administration.
+ * Displays all active user sessions with metadata.
+ */
+declare const SessionsView: ListView;
+
+/**
+ * Default list view for sys_audit_log administration.
+ * Displays platform audit trail with action and target information.
+ */
+declare const AuditLogsView: ListView;
+
+/**
+ * Default list view for sys_package_installation administration.
+ * Displays package installations with version and status information.
+ */
+declare const PackageInstallationsView: ListView;
+
+/**
+ * System Overview Dashboard
+ *
+ * Provides at-a-glance monitoring of platform health and key metrics:
+ * - Active user sessions
+ * - Audit activity (recent events)
+ * - Package installation status
+ * - Platform configuration
+ */
+declare const SystemOverviewDashboard: {
+    name: string;
+    label: string;
+    widgets: {
+        id: string;
+        type: "table" | "bar" | "horizontal-bar" | "column" | "grouped-bar" | "stacked-bar" | "bi-polar-bar" | "line" | "area" | "stacked-area" | "step-line" | "spline" | "pie" | "donut" | "funnel" | "pyramid" | "scatter" | "bubble" | "treemap" | "sunburst" | "sankey" | "word-cloud" | "gauge" | "solid-gauge" | "metric" | "kpi" | "bullet" | "choropleth" | "bubble-map" | "gl-map" | "heatmap" | "radar" | "waterfall" | "box-plot" | "violin" | "candlestick" | "stock" | "pivot";
+        aggregate: "min" | "max" | "count" | "sum" | "avg";
+        layout: {
+            x: number;
+            y: number;
+            w: number;
+            h: number;
+        };
+        title?: string | undefined;
+        description?: string | undefined;
+        chartConfig?: {
+            type: "table" | "bar" | "horizontal-bar" | "column" | "grouped-bar" | "stacked-bar" | "bi-polar-bar" | "line" | "area" | "stacked-area" | "step-line" | "spline" | "pie" | "donut" | "funnel" | "pyramid" | "scatter" | "bubble" | "treemap" | "sunburst" | "sankey" | "word-cloud" | "gauge" | "solid-gauge" | "metric" | "kpi" | "bullet" | "choropleth" | "bubble-map" | "gl-map" | "heatmap" | "radar" | "waterfall" | "box-plot" | "violin" | "candlestick" | "stock" | "pivot";
+            showLegend: boolean;
+            showDataLabels: boolean;
+            title?: string | undefined;
+            subtitle?: string | undefined;
+            description?: string | undefined;
+            xAxis?: {
+                field: string;
+                showGridLines: boolean;
+                logarithmic: boolean;
+                title?: string | undefined;
+                format?: string | undefined;
+                min?: number | undefined;
+                max?: number | undefined;
+                stepSize?: number | undefined;
+                position?: "top" | "bottom" | "left" | "right" | undefined;
+            } | undefined;
+            yAxis?: {
+                field: string;
+                showGridLines: boolean;
+                logarithmic: boolean;
+                title?: string | undefined;
+                format?: string | undefined;
+                min?: number | undefined;
+                max?: number | undefined;
+                stepSize?: number | undefined;
+                position?: "top" | "bottom" | "left" | "right" | undefined;
+            }[] | undefined;
+            series?: {
+                name: string;
+                yAxis: "left" | "right";
+                label?: string | undefined;
+                type?: "table" | "bar" | "horizontal-bar" | "column" | "grouped-bar" | "stacked-bar" | "bi-polar-bar" | "line" | "area" | "stacked-area" | "step-line" | "spline" | "pie" | "donut" | "funnel" | "pyramid" | "scatter" | "bubble" | "treemap" | "sunburst" | "sankey" | "word-cloud" | "gauge" | "solid-gauge" | "metric" | "kpi" | "bullet" | "choropleth" | "bubble-map" | "gl-map" | "heatmap" | "radar" | "waterfall" | "box-plot" | "violin" | "candlestick" | "stock" | "pivot" | undefined;
+                color?: string | undefined;
+                stack?: string | undefined;
+            }[] | undefined;
+            colors?: string[] | undefined;
+            height?: number | undefined;
+            annotations?: {
+                type: "line" | "region";
+                axis: "x" | "y";
+                value: string | number;
+                style: "solid" | "dashed" | "dotted";
+                endValue?: string | number | undefined;
+                color?: string | undefined;
+                label?: string | undefined;
+            }[] | undefined;
+            interaction?: {
+                tooltips: boolean;
+                zoom: boolean;
+                brush: boolean;
+                clickAction?: string | undefined;
+            } | undefined;
+            aria?: {
+                ariaLabel?: string | undefined;
+                ariaDescribedBy?: string | undefined;
+                role?: string | undefined;
+            } | undefined;
+        } | undefined;
+        colorVariant?: "default" | "danger" | "success" | "warning" | "blue" | "teal" | "orange" | "purple" | undefined;
+        actionUrl?: string | undefined;
+        actionType?: "url" | "flow" | "api" | "script" | "modal" | undefined;
+        actionIcon?: string | undefined;
+        object?: string | undefined;
+        filter?: _objectstack_spec_data.FilterCondition | undefined;
+        categoryField?: string | undefined;
+        valueField?: string | undefined;
+        measures?: {
+            valueField: string;
+            aggregate: "min" | "max" | "count" | "sum" | "avg";
+            label?: string | undefined;
+            format?: string | undefined;
+        }[] | undefined;
+        options?: unknown;
+        responsive?: {
+            breakpoint?: "md" | "xs" | "sm" | "lg" | "xl" | "2xl" | undefined;
+            hiddenOn?: ("md" | "xs" | "sm" | "lg" | "xl" | "2xl")[] | undefined;
+            columns?: {
+                xs?: number | undefined;
+                sm?: number | undefined;
+                md?: number | undefined;
+                lg?: number | undefined;
+                xl?: number | undefined;
+                '2xl'?: number | undefined;
+            } | undefined;
+            order?: {
+                xs?: number | undefined;
+                sm?: number | undefined;
+                md?: number | undefined;
+                lg?: number | undefined;
+                xl?: number | undefined;
+                '2xl'?: number | undefined;
+            } | undefined;
+        } | undefined;
+        aria?: {
+            ariaLabel?: string | undefined;
+            ariaDescribedBy?: string | undefined;
+            role?: string | undefined;
+        } | undefined;
+    }[];
+    description?: string | undefined;
+    header?: {
+        showTitle: boolean;
+        showDescription: boolean;
+        actions?: {
+            label: string;
+            actionUrl: string;
+            actionType?: "url" | "flow" | "api" | "script" | "modal" | undefined;
+            icon?: string | undefined;
+        }[] | undefined;
+    } | undefined;
+    columns?: number | undefined;
+    gap?: number | undefined;
+    refreshInterval?: number | undefined;
+    dateRange?: {
+        defaultRange: "custom" | "today" | "yesterday" | "this_week" | "last_week" | "this_month" | "last_month" | "this_quarter" | "last_quarter" | "this_year" | "last_year" | "last_7_days" | "last_30_days" | "last_90_days";
+        allowCustomRange: boolean;
+        field?: string | undefined;
+    } | undefined;
+    globalFilters?: {
+        field: string;
+        scope: "dashboard" | "widget";
+        label?: string | undefined;
+        type?: "number" | "date" | "text" | "select" | "lookup" | undefined;
+        options?: {
+            value: string | number | boolean;
+            label: string;
+        }[] | undefined;
+        optionsFrom?: {
+            object: string;
+            valueField: string;
+            labelField: string;
+            filter?: _objectstack_spec_data.FilterCondition | undefined;
+        } | undefined;
+        defaultValue?: string | number | boolean | undefined;
+        targetWidgets?: string[] | undefined;
+    }[] | undefined;
+    aria?: {
+        ariaLabel?: string | undefined;
+        ariaDescribedBy?: string | undefined;
+        role?: string | undefined;
+    } | undefined;
+    performance?: {
+        lazyLoad?: boolean | undefined;
+        virtualScroll?: {
+            enabled: boolean;
+            itemHeight?: number | undefined;
+            overscan?: number | undefined;
+        } | undefined;
+        cacheStrategy?: "none" | "cache-first" | "network-first" | "stale-while-revalidate" | undefined;
+        prefetch?: boolean | undefined;
+        pageSize?: number | undefined;
+        debounceMs?: number | undefined;
+    } | undefined;
+};
+
+/**
+ * Security Overview Dashboard
+ *
+ * Provides security and compliance monitoring:
+ * - User authentication events
+ * - Permission changes
+ * - System configuration audits
+ * - Active user sessions
+ */
+declare const SecurityOverviewDashboard: {
+    name: string;
+    label: string;
+    widgets: {
+        id: string;
+        type: "table" | "bar" | "horizontal-bar" | "column" | "grouped-bar" | "stacked-bar" | "bi-polar-bar" | "line" | "area" | "stacked-area" | "step-line" | "spline" | "pie" | "donut" | "funnel" | "pyramid" | "scatter" | "bubble" | "treemap" | "sunburst" | "sankey" | "word-cloud" | "gauge" | "solid-gauge" | "metric" | "kpi" | "bullet" | "choropleth" | "bubble-map" | "gl-map" | "heatmap" | "radar" | "waterfall" | "box-plot" | "violin" | "candlestick" | "stock" | "pivot";
+        aggregate: "min" | "max" | "count" | "sum" | "avg";
+        layout: {
+            x: number;
+            y: number;
+            w: number;
+            h: number;
+        };
+        title?: string | undefined;
+        description?: string | undefined;
+        chartConfig?: {
+            type: "table" | "bar" | "horizontal-bar" | "column" | "grouped-bar" | "stacked-bar" | "bi-polar-bar" | "line" | "area" | "stacked-area" | "step-line" | "spline" | "pie" | "donut" | "funnel" | "pyramid" | "scatter" | "bubble" | "treemap" | "sunburst" | "sankey" | "word-cloud" | "gauge" | "solid-gauge" | "metric" | "kpi" | "bullet" | "choropleth" | "bubble-map" | "gl-map" | "heatmap" | "radar" | "waterfall" | "box-plot" | "violin" | "candlestick" | "stock" | "pivot";
+            showLegend: boolean;
+            showDataLabels: boolean;
+            title?: string | undefined;
+            subtitle?: string | undefined;
+            description?: string | undefined;
+            xAxis?: {
+                field: string;
+                showGridLines: boolean;
+                logarithmic: boolean;
+                title?: string | undefined;
+                format?: string | undefined;
+                min?: number | undefined;
+                max?: number | undefined;
+                stepSize?: number | undefined;
+                position?: "top" | "bottom" | "left" | "right" | undefined;
+            } | undefined;
+            yAxis?: {
+                field: string;
+                showGridLines: boolean;
+                logarithmic: boolean;
+                title?: string | undefined;
+                format?: string | undefined;
+                min?: number | undefined;
+                max?: number | undefined;
+                stepSize?: number | undefined;
+                position?: "top" | "bottom" | "left" | "right" | undefined;
+            }[] | undefined;
+            series?: {
+                name: string;
+                yAxis: "left" | "right";
+                label?: string | undefined;
+                type?: "table" | "bar" | "horizontal-bar" | "column" | "grouped-bar" | "stacked-bar" | "bi-polar-bar" | "line" | "area" | "stacked-area" | "step-line" | "spline" | "pie" | "donut" | "funnel" | "pyramid" | "scatter" | "bubble" | "treemap" | "sunburst" | "sankey" | "word-cloud" | "gauge" | "solid-gauge" | "metric" | "kpi" | "bullet" | "choropleth" | "bubble-map" | "gl-map" | "heatmap" | "radar" | "waterfall" | "box-plot" | "violin" | "candlestick" | "stock" | "pivot" | undefined;
+                color?: string | undefined;
+                stack?: string | undefined;
+            }[] | undefined;
+            colors?: string[] | undefined;
+            height?: number | undefined;
+            annotations?: {
+                type: "line" | "region";
+                axis: "x" | "y";
+                value: string | number;
+                style: "solid" | "dashed" | "dotted";
+                endValue?: string | number | undefined;
+                color?: string | undefined;
+                label?: string | undefined;
+            }[] | undefined;
+            interaction?: {
+                tooltips: boolean;
+                zoom: boolean;
+                brush: boolean;
+                clickAction?: string | undefined;
+            } | undefined;
+            aria?: {
+                ariaLabel?: string | undefined;
+                ariaDescribedBy?: string | undefined;
+                role?: string | undefined;
+            } | undefined;
+        } | undefined;
+        colorVariant?: "default" | "danger" | "success" | "warning" | "blue" | "teal" | "orange" | "purple" | undefined;
+        actionUrl?: string | undefined;
+        actionType?: "url" | "flow" | "api" | "script" | "modal" | undefined;
+        actionIcon?: string | undefined;
+        object?: string | undefined;
+        filter?: _objectstack_spec_data.FilterCondition | undefined;
+        categoryField?: string | undefined;
+        valueField?: string | undefined;
+        measures?: {
+            valueField: string;
+            aggregate: "min" | "max" | "count" | "sum" | "avg";
+            label?: string | undefined;
+            format?: string | undefined;
+        }[] | undefined;
+        options?: unknown;
+        responsive?: {
+            breakpoint?: "md" | "xs" | "sm" | "lg" | "xl" | "2xl" | undefined;
+            hiddenOn?: ("md" | "xs" | "sm" | "lg" | "xl" | "2xl")[] | undefined;
+            columns?: {
+                xs?: number | undefined;
+                sm?: number | undefined;
+                md?: number | undefined;
+                lg?: number | undefined;
+                xl?: number | undefined;
+                '2xl'?: number | undefined;
+            } | undefined;
+            order?: {
+                xs?: number | undefined;
+                sm?: number | undefined;
+                md?: number | undefined;
+                lg?: number | undefined;
+                xl?: number | undefined;
+                '2xl'?: number | undefined;
+            } | undefined;
+        } | undefined;
+        aria?: {
+            ariaLabel?: string | undefined;
+            ariaDescribedBy?: string | undefined;
+            role?: string | undefined;
+        } | undefined;
+    }[];
+    description?: string | undefined;
+    header?: {
+        showTitle: boolean;
+        showDescription: boolean;
+        actions?: {
+            label: string;
+            actionUrl: string;
+            actionType?: "url" | "flow" | "api" | "script" | "modal" | undefined;
+            icon?: string | undefined;
+        }[] | undefined;
+    } | undefined;
+    columns?: number | undefined;
+    gap?: number | undefined;
+    refreshInterval?: number | undefined;
+    dateRange?: {
+        defaultRange: "custom" | "today" | "yesterday" | "this_week" | "last_week" | "this_month" | "last_month" | "this_quarter" | "last_quarter" | "this_year" | "last_year" | "last_7_days" | "last_30_days" | "last_90_days";
+        allowCustomRange: boolean;
+        field?: string | undefined;
+    } | undefined;
+    globalFilters?: {
+        field: string;
+        scope: "dashboard" | "widget";
+        label?: string | undefined;
+        type?: "number" | "date" | "text" | "select" | "lookup" | undefined;
+        options?: {
+            value: string | number | boolean;
+            label: string;
+        }[] | undefined;
+        optionsFrom?: {
+            object: string;
+            valueField: string;
+            labelField: string;
+            filter?: _objectstack_spec_data.FilterCondition | undefined;
+        } | undefined;
+        defaultValue?: string | number | boolean | undefined;
+        targetWidgets?: string[] | undefined;
+    }[] | undefined;
+    aria?: {
+        ariaLabel?: string | undefined;
+        ariaDescribedBy?: string | undefined;
+        role?: string | undefined;
+    } | undefined;
+    performance?: {
+        lazyLoad?: boolean | undefined;
+        virtualScroll?: {
+            enabled: boolean;
+            itemHeight?: number | undefined;
+            overscan?: number | undefined;
+        } | undefined;
+        cacheStrategy?: "none" | "cache-first" | "network-first" | "stale-while-revalidate" | undefined;
+        prefetch?: boolean | undefined;
+        pageSize?: number | undefined;
+        debounceMs?: number | undefined;
+    } | undefined;
+};
+
+export { AuditLogsView, OrganizationsView, PackageInstallationsView, RolesView, SETUP_APP, SecurityOverviewDashboard, SessionsView, SystemOverviewDashboard, UsersView };