@stonecrop/aform 0.4.33 → 0.4.35

package/dist/aform.d.ts

@@ -65,6 +65,30 @@ export declare type BaseSchema = {
     value?: any;
 };
 
+/**
+ * Base table configuration properties shared across all view types.
+ * @public
+ */
+export declare interface BaseTableConfig {
+    /**
+     * Control whether the table should be allowed to use the full width of its container.
+     *
+     * @defaultValue false
+     */
+    fullWidth?: boolean;
+}
+
+/**
+ * Table configuration for basic view types (uncounted, list, list-expansion).
+ * @public
+ */
+export declare interface BasicTableConfig extends BaseTableConfig {
+    /**
+     * The type of view to display the table in.
+     */
+    view?: 'uncounted' | 'list' | 'list-expansion';
+}
+
 /**
  * Table cell context definition.
  * @public
@@ -271,13 +295,37 @@ colspan?: number | undefined;
 originalIndex?: number | undefined;
 }[]>;
 config: Ref<    {
-view?: "uncounted" | "list" | "list-expansion" | "tree" | "gantt" | "tree-gantt" | undefined;
+view?: "uncounted" | "list" | "list-expansion" | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
 fullWidth?: boolean | undefined;
+} | {
+view: "gantt";
 dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree-gantt";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
+dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
 }, TableConfig | {
-view?: "uncounted" | "list" | "list-expansion" | "tree" | "gantt" | "tree-gantt" | undefined;
+view?: "uncounted" | "list" | "list-expansion" | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
 fullWidth?: boolean | undefined;
+} | {
+view: "gantt";
 dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree-gantt";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
+dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
 }>;
 connectionHandles: Ref<    {
 id: string;
@@ -506,13 +554,37 @@ colspan?: number | undefined;
 originalIndex?: number | undefined;
 }[]>;
 config: Ref<    {
-view?: "uncounted" | "list" | "list-expansion" | "tree" | "gantt" | "tree-gantt" | undefined;
+view?: "uncounted" | "list" | "list-expansion" | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
 fullWidth?: boolean | undefined;
+} | {
+view: "gantt";
+dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree-gantt";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
 dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
 }, TableConfig | {
-view?: "uncounted" | "list" | "list-expansion" | "tree" | "gantt" | "tree-gantt" | undefined;
+view?: "uncounted" | "list" | "list-expansion" | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
 fullWidth?: boolean | undefined;
+} | {
+view: "gantt";
+dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree-gantt";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
 dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
 }>;
 connectionHandles: Ref<    {
 id: string;
@@ -741,13 +813,37 @@ colspan?: number | undefined;
 originalIndex?: number | undefined;
 }[]>;
 config: Ref<    {
-view?: "uncounted" | "list" | "list-expansion" | "tree" | "gantt" | "tree-gantt" | undefined;
+view?: "uncounted" | "list" | "list-expansion" | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
 fullWidth?: boolean | undefined;
+} | {
+view: "gantt";
+dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree-gantt";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
 dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
 }, TableConfig | {
-view?: "uncounted" | "list" | "list-expansion" | "tree" | "gantt" | "tree-gantt" | undefined;
+view?: "uncounted" | "list" | "list-expansion" | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
 fullWidth?: boolean | undefined;
+} | {
+view: "gantt";
+dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
+} | {
+view: "tree-gantt";
+defaultTreeExpansion?: "root" | "branch" | "leaf" | undefined;
 dependencyGraph?: boolean | undefined;
+fullWidth?: boolean | undefined;
 }>;
 connectionHandles: Ref<    {
 id: string;
@@ -1116,6 +1212,24 @@ export declare interface GanttOptions {
     colspan?: number;
 }
 
+/**
+ * Table configuration for gantt view types.
+ * @public
+ */
+export declare interface GanttTableConfig extends BaseTableConfig {
+    /**
+     * The type of view to display the table in.
+     */
+    view: 'gantt';
+    /**
+     * Control whether dependency graph connections should be enabled for Gantt views.
+     * When false, connection handles and dependency lines will be hidden.
+     *
+     * @defaultValue true
+     */
+    dependencyGraph?: boolean;
+}
+
 /**
  * Install all AForm components
  * @param app - Vue app instance
@@ -1266,34 +1380,10 @@ export declare interface TableColumn {
 }
 
 /**
- * Table configuration definition.
+ * Table configuration definition using discriminated unions for type safety.
  * @public
  */
-export declare interface TableConfig {
-    /**
-     * The type of view to display the table in. Possible values:
-     * - `uncounted` - row numbers are not displayed in the table
-     * - `list` - row numbers are displayed in the table
-     * - `list-expansion` - carets are displayed in the number column that expand/collapse the row inline
-     * - `tree` - carets are displayed in the number column that expand/collapse grouped rows
-     * - `gantt` - view that allows specific rows to be displayed with Gantt functionality
-     * - `tree-gantt` - similar to `gantt`, but allows for tree functionality as well
-     */
-    view?: 'uncounted' | 'list' | 'list-expansion' | 'tree' | 'gantt' | 'tree-gantt';
-    /**
-     * Control whether the table should be allowed to use the full width of its container.
-     *
-     * @defaultValue false
-     */
-    fullWidth?: boolean;
-    /**
-     * Control whether dependency graph connections should be enabled for Gantt views.
-     * When false, connection handles and dependency lines will be hidden.
-     *
-     * @defaultValue true
-     */
-    dependencyGraph?: boolean;
-}
+export declare type TableConfig = BasicTableConfig | TreeTableConfig | GanttTableConfig | TreeGanttTableConfig;
 
 /**
  * Table display definition.
@@ -1501,4 +1591,51 @@ export declare type TableSchema = BaseSchema & {
     rows?: TableRow[];
 };
 
+/**
+ * Table configuration for tree-gantt view types.
+ * @public
+ */
+export declare interface TreeGanttTableConfig extends BaseTableConfig {
+    /**
+     * The type of view to display the table in.
+     */
+    view: 'tree-gantt';
+    /**
+     * Default expansion state for tree views. Possible values:
+     * - `root` - Only top-level nodes are visible (fully collapsed)
+     * - `branch` - Shows minimal tree to display all gantt nodes. Expands only the necessary paths to gantt nodes, stops at gantt nodes with no gantt descendants
+     * - `leaf` - All nodes are visible (fully expanded)
+     *
+     * @defaultValue undefined (default behavior is 'leaf' mode)
+     */
+    defaultTreeExpansion?: 'root' | 'branch' | 'leaf';
+    /**
+     * Control whether dependency graph connections should be enabled for Gantt views.
+     * When false, connection handles and dependency lines will be hidden.
+     *
+     * @defaultValue true
+     */
+    dependencyGraph?: boolean;
+}
+
+/**
+ * Table configuration for tree view types.
+ * @public
+ */
+export declare interface TreeTableConfig extends BaseTableConfig {
+    /**
+     * The type of view to display the table in.
+     */
+    view: 'tree';
+    /**
+     * Default expansion state for tree views. Possible values:
+     * - `root` - Only top-level nodes are visible (fully collapsed)
+     * - `branch` - Shows minimal tree to display all gantt nodes. Expands only the necessary paths to gantt nodes, stops at gantt nodes with no gantt descendants
+     * - `leaf` - All nodes are visible (fully expanded)
+     *
+     * @defaultValue undefined (default behavior is 'leaf' mode)
+     */
+    defaultTreeExpansion?: 'root' | 'branch' | 'leaf';
+}
+
 export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stonecrop/aform",
-  "version": "0.4.33",
+  "version": "0.4.35",
   "license": "MIT",
   "type": "module",
   "author": {
@@ -38,8 +38,8 @@
     "@vueuse/core": "^13.6.0",
     "@vueuse/components": "^13.6.0",
     "vue": "^3.5.18",
-    "@stonecrop/themes": "0.4.33",
-    "@stonecrop/utilities": "0.4.33"
+    "@stonecrop/themes": "0.4.35",
+    "@stonecrop/utilities": "0.4.35"
   },
   "devDependencies": {
     "@microsoft/api-documenter": "^7.26.31",
@@ -60,11 +60,11 @@
     "vite": "^7.0.6",
     "vitest": "^3.2.4",
     "vue-router": "^4.5.1",
-    "@stonecrop/atable": "0.4.33",
+    "@stonecrop/atable": "0.4.35",
     "stonecrop-rig": "0.2.22"
   },
   "peerDependencies": {
-    "@stonecrop/atable": "0.4.33"
+    "@stonecrop/atable": "0.4.35"
   },
   "publishConfig": {
     "access": "public"