@xy-planning-network/trees 0.13.7-dev-4 → 0.13.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xy-planning-network/trees",
-  "version": "0.13.7-dev-4",
+  "version": "0.13.7",
   "description": "",
   "license": "MIT",
   "repository": "github:xy-planning-network/trees",

package/types/composables/index.d.ts

@@ -1,15 +1,15 @@
 import { default as useBaseAPI, useBaseAPIGet, useBaseAPIPatch, useBaseAPIPut, useBaseAPIPost, useBaseAPIDelete } from "./useBaseAPI";
 import type { UseBaseAPIOptions, UseBaseAPI } from "./useBaseAPI";
-import type { DynamicTableOptions, DynamicTableAPI, TableActionButton, TableActionItem, TableActionLink, TableActions, TableBulkActionItem, TableColumn, TableColumns, TableCellAlignment, TableRowData, TableRowsData } from "./table";
+import type { DynamicTableOptions, DynamicTableAPI, TableActionButton, TableActionItem, TableActionLink, TableActions, TableBulkActions, TableBulkActionItem, TableColumn, TableColumns, TableCellAlignment, TableRowData, TableRowsData } from "./table";
 import type { DetailListAPI, SortDir } from "./list";
-export type { UseBaseAPIOptions, UseBaseAPI, DetailListAPI, DynamicTableOptions, DynamicTableAPI, SortDir, TableActionButton, TableActionItem, TableActionLink, TableActions, TableBulkActionItem, TableColumn, TableColumns, TableCellAlignment, TableRowData, TableRowsData, };
+export type { UseBaseAPIOptions, UseBaseAPI, DetailListAPI, DynamicTableOptions, DynamicTableAPI, SortDir, TableActionButton, TableActionItem, TableActionLink, TableActions, TableBulkActions, TableBulkActionItem, TableColumn, TableColumns, TableCellAlignment, TableRowData, TableRowsData, };
 export { useBaseAPI, useBaseAPIGet, useBaseAPIPatch, useBaseAPIPut, useBaseAPIPost, useBaseAPIDelete, };
 import { useFlashes, useAppFlashes, useAppFlasher } from "./useFlashes";
 import type { FlashMessage, FlashType, FlashStore, Flasher } from "./useFlashes";
 export type { FlashMessage, FlashType, FlashStore, Flasher };
 export { useFlashes, useAppFlashes, useAppFlasher };
-import type { ActionItem, ActionItemButton, ActionItemLink, NavItem, Pagination, URLParams, URLParamValue, UseTabHistoryOpts } from "./nav";
-export type { ActionItem, ActionItemButton, ActionItemLink, NavItem, Pagination, URLParams, URLParamValue, UseTabHistoryOpts, };
+import type { ActionItem, ActionItems, ActionItemButton, ActionItemLink, NavItem, Pagination, URLParams, URLParamValue, UseTabHistoryOpts } from "./nav";
+export type { ActionItem, ActionItems, ActionItemButton, ActionItemLink, NavItem, Pagination, URLParams, URLParamValue, UseTabHistoryOpts, };
 import { isActionItemButton, isActionItemLink, useUrlSearchParams, useTabHistory } from "./nav";
 export { isActionItemButton, isActionItemLink, useUrlSearchParams, useTabHistory, };
 import { useSpinnerDisplay, useAppSpinner } from "./useSpinner";

package/types/composables/nav.d.ts

@@ -13,6 +13,13 @@ export interface Pagination {
 }
 export type ActionItem = ActionItemButton | ActionItemLink;
 export type ActionItems = ActionItem[];
+/**
+ * ActionItemButton determines the configuration for a button action in a component.
+ * Visibility (`show`) and interactivity (`disabled`) can be toggled via static booleans.
+ *
+ * The use of (`never`) on properties that exist in ActionItemLink ensures the compiler
+ * can infer between the to interfaces when used in the type union ActionItem.
+ */
 export interface ActionItemButton {
     label: string;
     attrs?: never;
@@ -24,6 +31,13 @@ export interface ActionItemButton {
     onClick: (e: Event) => void;
 }
 export declare const isActionItemButton: (item: ActionItem) => item is ActionItemButton;
+/**
+ * ActionItemLink determines the configuration for a link action in a component.
+ * Visibility (`show`) and interactivity (`disabled`) can be toggled via static booleans.
+ *
+ * HTML Attributes can be defined on (`attrs`) for additional HTML anchor tag attributes
+ * that are not explicitly defined in the interface.
+ */
 export interface ActionItemLink {
     label: string;
     url: string;

package/types/composables/table.d.ts

@@ -42,6 +42,9 @@ export type TableActionItem<T = TableRowData> = TableActionButton<T> | TableActi
  * Visibility (`show`) and interactivity (`disabled`) can be toggled via static booleans
  * or dynamic methods based on the specific row's state and index.
  *
+ * The use of (`never`) on properties that exist in TableActionLink ensures the compiler
+ * can infer between the to interfaces when used in the type union TableActionItem.
+ *
  * @template T The shape of the underlying row data.
  */
 export interface TableActionButton<T = TableRowData> {

package/types/composables/useActionItems.d.ts

@@ -1,12 +0,0 @@
-import { Ref } from "vue";
-import { ActionItem } from "./nav";
-export declare const useActionItems: (items: ActionItem[] | Ref<ActionItem[]>) => {
-    actions: import("vue").ComputedRef<{
-        disabled: boolean;
-        show: boolean;
-        onClick: (...args: any[]) => void;
-        icon?: import("vue").RenderFunction | import("vue").FunctionalComponent<{}, {}, any, {}> | undefined;
-        label: string;
-    }[]>;
-    hasActions: import("vue").ComputedRef<boolean>;
-};

package/types/lib-components/lists/TableActionButtons.vue.d.ts

@@ -1,8 +0,0 @@
-import { TableActionItem } from "../../composables";
-type __VLS_Props = {
-    actions?: TableActionItem[];
-};
-declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
-    actions: TableActionItem<import("../../composables").TableRowData>[];
-}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
-export default _default;