@xy-planning-network/trees 0.9.8 → 0.9.9-rc1

package/types/lib-components/indicators/InlineAlert.vue.d.ts

@@ -1,74 +1,40 @@
-declare const _default: import("vue").DefineComponent<{
-    title: {
-        type: import("vue").PropType<string>;
-        default: string;
-    };
-    btnLink: {
-        type: import("vue").PropType<string>;
-        default: string;
-    };
-    btnText: {
-        type: import("vue").PropType<string>;
-        default: string;
-    };
-    content: {
-        type: import("vue").PropType<string | string[]>;
-        required: true;
-    };
-    dismissable: {
-        type: import("vue").PropType<boolean>;
-        default: boolean;
-    };
-    secondaryBtnLink: {
-        type: import("vue").PropType<string>;
-        default: string;
-    };
-    secondaryBtnText: {
-        type: import("vue").PropType<string>;
-        default: string;
-    };
-    kind: {
-        type: import("vue").PropType<"alert" | "warn" | "info" | "success">;
-        required: true;
-    };
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToOption<{
+    btnLink?: string | undefined;
+    btnText?: string | undefined;
+    content: string | string[];
+    dismissable?: boolean | undefined;
+    secondaryBtnLink?: string | undefined;
+    secondaryBtnText?: string | undefined;
+    title?: string | undefined;
+    kind: "warn" | "info" | "success" | "alert";
+}>, {
+    btnLink: string;
+    btnText: string;
+    dismissable: boolean;
+    secondaryBtnLink: string;
+    secondaryBtnText: string;
+    title: string;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     close: (closed: true) => void;
     click: (e: Event) => void;
     "click:secondary": (e: Event) => void;
-}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    title: {
-        type: import("vue").PropType<string>;
-        default: string;
-    };
-    btnLink: {
-        type: import("vue").PropType<string>;
-        default: string;
-    };
-    btnText: {
-        type: import("vue").PropType<string>;
-        default: string;
-    };
-    content: {
-        type: import("vue").PropType<string | string[]>;
-        required: true;
-    };
-    dismissable: {
-        type: import("vue").PropType<boolean>;
-        default: boolean;
-    };
-    secondaryBtnLink: {
-        type: import("vue").PropType<string>;
-        default: string;
-    };
-    secondaryBtnText: {
-        type: import("vue").PropType<string>;
-        default: string;
-    };
-    kind: {
-        type: import("vue").PropType<"alert" | "warn" | "info" | "success">;
-        required: true;
-    };
-}>> & {
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<{
+    btnLink?: string | undefined;
+    btnText?: string | undefined;
+    content: string | string[];
+    dismissable?: boolean | undefined;
+    secondaryBtnLink?: string | undefined;
+    secondaryBtnText?: string | undefined;
+    title?: string | undefined;
+    kind: "warn" | "info" | "success" | "alert";
+}>, {
+    btnLink: string;
+    btnText: string;
+    dismissable: boolean;
+    secondaryBtnLink: string;
+    secondaryBtnText: string;
+    title: string;
+}>>> & {
     onClick?: ((e: Event) => any) | undefined;
     onClose?: ((closed: true) => any) | undefined;
     "onClick:secondary"?: ((e: Event) => any) | undefined;
@@ -81,3 +47,20 @@ declare const _default: import("vue").DefineComponent<{
     secondaryBtnText: string;
 }, {}>;
 export default _default;
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/types/lib-components/layout/DateFilter.vue.d.ts

@@ -1,28 +1,25 @@
 import { DateRange } from "../../composables/date";
 import { SortDir } from "../../composables/list";
-declare const _default: import("vue").DefineComponent<{
-    dateRange: {
-        type: import("vue").PropType<DateRange>;
-        required: true;
-    };
-    sortDir: {
-        type: import("vue").PropType<SortDir>;
-        required: true;
-    };
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+declare const _default: import("vue").DefineComponent<__VLS_TypePropsToOption<{
+    dateRange: DateRange;
+    sortDir: SortDir;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "sort-dir-changed": (val: SortDir) => void;
     "date-range-changed": (val: DateRange) => void;
-}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    dateRange: {
-        type: import("vue").PropType<DateRange>;
-        required: true;
-    };
-    sortDir: {
-        type: import("vue").PropType<SortDir>;
-        required: true;
-    };
-}>> & {
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToOption<{
+    dateRange: DateRange;
+    sortDir: SortDir;
+}>>> & {
     "onSort-dir-changed"?: ((val: SortDir) => any) | undefined;
     "onDate-range-changed"?: ((val: DateRange) => any) | undefined;
 }, {}, {}>;
 export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/types/lib-components/layout/SidebarLayout.vue.d.ts

@@ -1,48 +1,46 @@
 import * as NavTypes from "../../composables/nav";
-declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
-    activeUrl: {
-        type: import("vue").PropType<string>;
-        default: string;
-    };
-    iconUrl: {
-        type: import("vue").PropType<string>;
-        required: true;
-    };
-    navigation: {
-        type: import("vue").PropType<NavTypes.Item[]>;
-        required: true;
-    };
-    userNavigation: {
-        type: import("vue").PropType<NavTypes.Item[]>;
-        required: true;
-    };
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    activeUrl: {
-        type: import("vue").PropType<string>;
-        default: string;
-    };
-    iconUrl: {
-        type: import("vue").PropType<string>;
-        required: true;
-    };
-    navigation: {
-        type: import("vue").PropType<NavTypes.Item[]>;
-        required: true;
-    };
-    userNavigation: {
-        type: import("vue").PropType<NavTypes.Item[]>;
-        required: true;
-    };
-}>>, {
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToOption<{
+    activeUrl?: string | undefined;
+    iconUrl: string;
+    navigation: NavTypes.Item[];
+    userNavigation: NavTypes.Item[];
+}>, {
+    activeUrl: string;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<{
+    activeUrl?: string | undefined;
+    iconUrl: string;
+    navigation: NavTypes.Item[];
+    userNavigation: NavTypes.Item[];
+}>, {
+    activeUrl: string;
+}>>>, {
     activeUrl: string;
 }, {}>, {
+    "sidebar-bottom"?(_: {}): any;
     "sidebar-bottom"?(_: {}): any;
     header?(_: {}): any;
     default?(_: {}): any;
 }>;
 export default _default;
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
 type __VLS_WithTemplateSlots<T, S> = T & {
     new (): {
         $slots: S;
     };
 };
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/types/lib-components/layout/StackedLayout.vue.d.ts

@@ -1,56 +1,47 @@
 import * as NavTypes from "../../composables/nav";
 import User from "../../composables/user";
-declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
-    activeUrl: {
-        type: import("vue").PropType<string>;
-        default: string;
-    };
-    iconUrl: {
-        type: import("vue").PropType<string>;
-        required: true;
-    };
-    navigation: {
-        type: import("vue").PropType<NavTypes.Item[]>;
-        required: true;
-    };
-    userNavigation: {
-        type: import("vue").PropType<NavTypes.Item[]>;
-        required: true;
-    };
-    currentUser: {
-        type: import("vue").PropType<User>;
-        required: true;
-    };
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    activeUrl: {
-        type: import("vue").PropType<string>;
-        default: string;
-    };
-    iconUrl: {
-        type: import("vue").PropType<string>;
-        required: true;
-    };
-    navigation: {
-        type: import("vue").PropType<NavTypes.Item[]>;
-        required: true;
-    };
-    userNavigation: {
-        type: import("vue").PropType<NavTypes.Item[]>;
-        required: true;
-    };
-    currentUser: {
-        type: import("vue").PropType<User>;
-        required: true;
-    };
-}>>, {
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToOption<{
+    activeUrl?: string | undefined;
+    currentUser: User;
+    iconUrl: string;
+    navigation: NavTypes.Item[];
+    userNavigation: NavTypes.Item[];
+}>, {
+    activeUrl: string;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<{
+    activeUrl?: string | undefined;
+    currentUser: User;
+    iconUrl: string;
+    navigation: NavTypes.Item[];
+    userNavigation: NavTypes.Item[];
+}>, {
+    activeUrl: string;
+}>>>, {
     activeUrl: string;
 }, {}>, {
     header?(_: {}): any;
     default?(_: {}): any;
 }>;
 export default _default;
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
 type __VLS_WithTemplateSlots<T, S> = T & {
     new (): {
         $slots: S;
     };
 };
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

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

@@ -1,18 +1,21 @@
-declare const _default: import("vue").DefineComponent<{
+declare const _default: import("vue").DefineComponent<__VLS_TypePropsToOption<{
     cards: {
-        type: import("vue").PropType<{
-            primary: string;
-            secondary: string;
-        }[]>;
-        required: true;
-    };
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+        primary: string;
+        secondary: string;
+    }[];
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToOption<{
     cards: {
-        type: import("vue").PropType<{
-            primary: string;
-            secondary: string;
-        }[]>;
+        primary: string;
+        secondary: string;
+    }[];
+}>>>, {}, {}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
         required: true;
     };
-}>>, {}, {}>;
-export default _default;
+};

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

@@ -1,37 +1,40 @@
 import type { TableActions, TableColumns, TableRowsData } from "../../composables/table";
-declare const _default: import("vue").DefineComponent<{
-    tableActions: {
-        type: import("vue").PropType<TableActions<any>>;
-        default: () => {
-            type: string;
-            actions: never[];
-        };
+declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToOption<{
+    tableActions?: TableActions<any> | undefined;
+    tableColumns: TableColumns<any>;
+    tableData: TableRowsData;
+}>, {
+    tableActions: () => {
+        type: string;
+        actions: never[];
     };
-    tableColumns: {
-        type: import("vue").PropType<TableColumns<any>>;
-        required: true;
-    };
-    tableData: {
-        type: import("vue").PropType<TableRowsData>;
-        required: true;
-    };
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    tableActions: {
-        type: import("vue").PropType<TableActions<any>>;
-        default: () => {
-            type: string;
-            actions: never[];
-        };
-    };
-    tableColumns: {
-        type: import("vue").PropType<TableColumns<any>>;
-        required: true;
-    };
-    tableData: {
-        type: import("vue").PropType<TableRowsData>;
-        required: true;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<{
+    tableActions?: TableActions<any> | undefined;
+    tableColumns: TableColumns<any>;
+    tableData: TableRowsData;
+}>, {
+    tableActions: () => {
+        type: string;
+        actions: never[];
     };
-}>>, {
+}>>>, {
     tableActions: TableActions<any>;
 }, {}>;
 export default _default;
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

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

@@ -1,66 +1,86 @@
 import { SortDir } from "../../composables/list";
-declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
-    url: {
-        type: import("vue").PropType<string>;
-        required: true;
-    };
-    borderless: {
-        type: import("vue").PropType<boolean>;
-        default: boolean;
-    };
-    defaultSort: {
-        type: import("vue").PropType<string>;
-        default: string;
-    };
-    defaultSortDir: {
-        type: import("vue").PropType<SortDir>;
-        default: string;
-    };
-    disableDate: {
-        type: import("vue").PropType<boolean>;
-        default: boolean;
-    };
-    disableNavigation: {
-        type: import("vue").PropType<boolean>;
-        default: boolean;
-    };
-    perPage: {
-        type: import("vue").PropType<number>;
-        default: number;
-    };
-}, {
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToOption<{
+    /**
+     * borderless removes the default border styling applied around list items.
+     * This is useful when filters or pagination navigation components show,
+     * but less helpful when this component is dialed back in functionality.
+     */
+    borderless?: boolean | undefined;
+    /**
+     * defaultSort overrides the default field to sort items on.
+     */
+    defaultSort?: string | undefined;
+    /**
+     * defaultSortDir overrides the default order to sort items with.
+     */
+    defaultSortDir?: SortDir | undefined;
+    /**
+     * disableDate turns off the date-range filter input.
+     */
+    disableDate?: boolean | undefined;
+    /**
+     * disableNavigation hides navigation components from displaying.
+     * This makes the List as a "single-page" limiting the number of results via perPage.
+     */
+    disableNavigation?: boolean | undefined;
+    /**
+     * perPage overrides the default number of items per page to retrieve.
+     */
+    perPage?: number | undefined;
+    /**
+     * url is the endpoint to retrieve list data from
+     */
+    url: string;
+}>, {
+    borderless: boolean;
+    disableNavigation: boolean;
+    disableDate: boolean;
+    defaultSort: string;
+    defaultSortDir: string;
+    perPage: number;
+}>, {
     refresh: () => void;
     reset: () => void;
-}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    url: {
-        type: import("vue").PropType<string>;
-        required: true;
-    };
-    borderless: {
-        type: import("vue").PropType<boolean>;
-        default: boolean;
-    };
-    defaultSort: {
-        type: import("vue").PropType<string>;
-        default: string;
-    };
-    defaultSortDir: {
-        type: import("vue").PropType<SortDir>;
-        default: string;
-    };
-    disableDate: {
-        type: import("vue").PropType<boolean>;
-        default: boolean;
-    };
-    disableNavigation: {
-        type: import("vue").PropType<boolean>;
-        default: boolean;
-    };
-    perPage: {
-        type: import("vue").PropType<number>;
-        default: number;
-    };
-}>>, {
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<{
+    /**
+     * borderless removes the default border styling applied around list items.
+     * This is useful when filters or pagination navigation components show,
+     * but less helpful when this component is dialed back in functionality.
+     */
+    borderless?: boolean | undefined;
+    /**
+     * defaultSort overrides the default field to sort items on.
+     */
+    defaultSort?: string | undefined;
+    /**
+     * defaultSortDir overrides the default order to sort items with.
+     */
+    defaultSortDir?: SortDir | undefined;
+    /**
+     * disableDate turns off the date-range filter input.
+     */
+    disableDate?: boolean | undefined;
+    /**
+     * disableNavigation hides navigation components from displaying.
+     * This makes the List as a "single-page" limiting the number of results via perPage.
+     */
+    disableNavigation?: boolean | undefined;
+    /**
+     * perPage overrides the default number of items per page to retrieve.
+     */
+    perPage?: number | undefined;
+    /**
+     * url is the endpoint to retrieve list data from
+     */
+    url: string;
+}>, {
+    borderless: boolean;
+    disableNavigation: boolean;
+    disableDate: boolean;
+    defaultSort: string;
+    defaultSortDir: string;
+    perPage: number;
+}>>>, {
     borderless: boolean;
     defaultSort: string;
     defaultSortDir: SortDir;
@@ -74,8 +94,25 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     empty?(_: {}): any;
 }>;
 export default _default;
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
 type __VLS_WithTemplateSlots<T, S> = T & {
     new (): {
         $slots: S;
     };
 };
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};