@xy-planning-network/trees 0.7.4 → 0.7.5-rc1

package/types/composables/forms.d.ts

@@ -0,0 +1,118 @@
+import { Ref } from "vue";
+export interface Input {
+    modelValue?: any;
+    error?: string;
+    label?: string;
+    help?: string;
+    placeholder?: string;
+}
+export interface InputOption {
+    disabled?: boolean;
+    help?: string;
+    label: string;
+    sublabel?: string;
+    value: string | number;
+}
+export interface BooleanInput extends Input {
+    modelValue?: boolean | null;
+}
+export interface DateRangeInput extends Input {
+    modelValue?: {
+        minDate: number;
+        maxDate: number;
+    };
+    maxRange?: number;
+    startDate?: number;
+}
+export interface TextLikeInput extends Input {
+    modelValue?: string | number | null;
+    type: TextInputType;
+}
+export interface TextareaInput extends Input {
+    modelValue?: string | number | null;
+}
+export interface OptionsInput extends Input {
+    modelValue?: string | number | null;
+    options: InputOption[];
+}
+export interface MultiChoiceInput extends Input {
+    max?: number;
+    min?: number;
+    modelValue?: (string | number)[] | null;
+    options: InputOption[];
+}
+export interface ColumnedInput {
+    columns?: 2 | 3;
+}
+export declare const defaultInputProps: {
+    error: string;
+    help: string;
+    label: string;
+    modelValue: undefined;
+    placeholder: string;
+};
+export type TextInputType = "date" | "datetime-local" | "email" | "month" | "number" | "password" | "search" | "tel" | "text" | "time" | "url" | "week";
+interface UseInputFieldConfig<T extends Input> {
+    props: T;
+    targetInput: Ref<HTMLInputElement | null>;
+}
+/**
+ * useInputField provides a number of computed values, refs, and methods to support
+ * wiring up reactive inputs.
+ *
+ * @param config UseInputFieldConfig
+ */
+export declare const useInputField: <T extends Input>(config: UseInputFieldConfig<T>) => {
+    attrs: {
+        [x: string]: unknown;
+    };
+    inputID: import("vue").ComputedRef<string>;
+    isDisabled: import("vue").ComputedRef<boolean>;
+    isRequired: import("vue").ComputedRef<boolean>;
+    nameAttr: import("vue").ComputedRef<string>;
+    modelState: Ref<T["modelValue"]>;
+    errorState: Ref<T["error"]>;
+    onInvalid: (e: Event) => void;
+    validate: (e: Event) => void;
+    inputValidation: (...args: any[]) => void;
+};
+/**
+ * hasAttribute determines if an HTML attribute value exists.  The conditions are based on
+ * whether or not the attribute will be set on the HTML element.
+ * @param attrs
+ * @param name
+ */
+export declare const hasAttribute: (attrs: Record<string, unknown>, name: string) => boolean;
+/**
+ * email validation regex pattern
+ * used with input type="email" in the pattern attribute for html5 validation
+ * exported as a raw string to support the escape backslash characters
+ */
+export declare const emailPattern: string;
+/**
+ * password validation regex pattern
+ * used with input type="password" in the pattern attribute for html5 validation
+ * exported as a raw string to support the escape backslash characters
+ */
+export declare const passwordPattern: string;
+/**
+ * phone number validation regex pattern
+ * used with input type="tel" in the pattern attribute for html5 validation
+ */
+export declare const phonePattern: string;
+/**
+ * This is used for the .number modifier in v-model
+ */
+export declare const looseToNumber: (val: any) => any;
+/**
+ * useLocalModel supports a two-way binding between a reactive prop and
+ * a local ref.  It effectively allows you to do prop mutations in a way that
+ * vue considers safe.
+ *
+ * vue/core has a version of this in it's experimental mode called useModel
+ *
+ * @param props component props
+ * @param name component prop name to sync
+ */
+export declare const useLocalModel: <T extends Record<string, any>, K extends keyof T>(props: T, name: K) => Ref<T[K]>;
+export {};

package/types/helpers/Debounce.d.ts

@@ -1,2 +1,2 @@
-export declare function debounce(func: () => void, timeout?: number): () => void;
+export declare function debounce(fn: (...args: any[]) => void, wait?: number): (...args: any[]) => void;
 export declare function debounceLeading(func: () => void, timeout?: number): (...args: any[]) => void;

package/types/lib-components/forms/BaseInput.vue.d.ts

@@ -1,40 +1,64 @@
-declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
-    type: string;
-    help?: string | undefined;
-    label?: string | undefined;
-    modelValue?: string | number | undefined;
-}>, {
-    help: string;
-    label: string;
-    modelValue: string;
-}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "update:modelValue"[], "update:modelValue", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
-    type: string;
-    help?: string | undefined;
-    label?: string | undefined;
-    modelValue?: string | number | undefined;
-}>, {
-    help: string;
-    label: string;
-    modelValue: string;
-}>>> & {
+declare const _default: import("vue").DefineComponent<{
+    label: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    type: {
+        type: import("vue").PropType<import("../../composables/forms").TextInputType>;
+        required: true;
+    };
+    modelValue: {
+        type: import("vue").PropType<string | number | null>;
+        default: undefined;
+    };
+    error: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    help: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    placeholder: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (...args: any[]) => void;
+    "update:error": (...args: any[]) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    label: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    type: {
+        type: import("vue").PropType<import("../../composables/forms").TextInputType>;
+        required: true;
+    };
+    modelValue: {
+        type: import("vue").PropType<string | number | null>;
+        default: undefined;
+    };
+    error: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    help: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    placeholder: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+}>> & {
     "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:error"?: ((...args: any[]) => any) | undefined;
 }, {
     label: string;
+    modelValue: string | number | null;
+    error: string;
     help: string;
-    modelValue: string | number;
+    placeholder: string;
 }, {}>;
 export default _default;
-type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
-type __VLS_TypePropsToRuntimeProps<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;
-    };
-};
-type __VLS_WithDefaults<P, D> = {
-    [K in keyof Pick<P, keyof P>]: K extends keyof D ? P[K] & {
-        default: D[K];
-    } : P[K];
-};

package/types/lib-components/forms/Checkbox.vue.d.ts

@@ -1,35 +1,56 @@
-declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
-    label?: string | undefined;
-    help?: string | undefined;
-    modelValue: boolean;
-}>, {
-    label: string;
-    help: string;
-}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "update:modelValue"[], "update:modelValue", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
-    label?: string | undefined;
-    help?: string | undefined;
-    modelValue: boolean;
-}>, {
-    label: string;
-    help: string;
-}>>> & {
+declare const _default: import("vue").DefineComponent<{
+    label: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    modelValue: {
+        type: import("vue").PropType<boolean | null>;
+        default: undefined;
+    };
+    error: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    help: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    placeholder: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (...args: any[]) => void;
+    "update:error": (...args: any[]) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    label: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    modelValue: {
+        type: import("vue").PropType<boolean | null>;
+        default: undefined;
+    };
+    error: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    help: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    placeholder: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+}>> & {
     "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:error"?: ((...args: any[]) => any) | undefined;
 }, {
     label: string;
+    modelValue: boolean | null;
+    error: string;
     help: string;
+    placeholder: string;
 }, {}>;
 export default _default;
-type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
-type __VLS_TypePropsToRuntimeProps<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;
-    };
-};
-type __VLS_WithDefaults<P, D> = {
-    [K in keyof Pick<P, keyof P>]: K extends keyof D ? P[K] & {
-        default: D[K];
-    } : P[K];
-};

package/types/lib-components/forms/DateRangePicker.vue.d.ts

@@ -1,52 +1,84 @@
 import "flatpickr/dist/flatpickr.min.css";
-declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
+declare const _default: import("vue").DefineComponent<{
+    label: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
     modelValue: {
-        minDate: number;
-        maxDate: number;
+        type: import("vue").PropType<{
+            minDate: number;
+            maxDate: number;
+        }>;
+        default: () => {
+            maxDate: number;
+            minDate: number;
+        };
     };
-    maxRange?: number | undefined;
-    startDate?: number | undefined;
-    label?: string | undefined;
-    help?: string | undefined;
-}>, {
-    maxRange: number;
-    startDate: number;
+    error: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    help: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    placeholder: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    maxRange: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    startDate: {
+        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<{
+    label: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    modelValue: {
+        type: import("vue").PropType<{
+            minDate: number;
+            maxDate: number;
+        }>;
+        default: () => {
+            maxDate: number;
+            minDate: number;
+        };
+    };
+    error: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    help: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    placeholder: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    maxRange: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    startDate: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+}>>, {
     label: string;
-    help: string;
-}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "update:modelValue"[], "update:modelValue", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
     modelValue: {
         minDate: number;
         maxDate: number;
     };
-    maxRange?: number | undefined;
-    startDate?: number | undefined;
-    label?: string | undefined;
-    help?: string | undefined;
-}>, {
-    maxRange: number;
-    startDate: number;
-    label: string;
-    help: string;
-}>>> & {
-    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
-}, {
-    label: string;
+    error: string;
     help: string;
+    placeholder: string;
     maxRange: number;
     startDate: number;
 }, {}>;
 export default _default;
-type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
-type __VLS_TypePropsToRuntimeProps<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;
-    };
-};
-type __VLS_WithDefaults<P, D> = {
-    [K in keyof Pick<P, keyof P>]: K extends keyof D ? P[K] & {
-        default: D[K];
-    } : P[K];
-};

package/types/lib-components/forms/FieldsetLegend.vue.d.ts

@@ -1,33 +1,32 @@
-declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
-    tag?: string | undefined;
-}>, {
-    tag: 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_TypePropsToRuntimeProps<{
-    tag?: string | undefined;
-}>, {
-    tag: string;
-}>>>, {
-    tag: string;
-}, {}>, {
-    default: (_: {}) => any;
-}>;
-export default _default;
-type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
-type __VLS_TypePropsToRuntimeProps<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;
+declare const _default: import("vue").DefineComponent<{
+    label: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    required: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
     };
-};
-type __VLS_WithDefaults<P, D> = {
-    [K in keyof Pick<P, keyof P>]: K extends keyof D ? P[K] & {
-        default: D[K];
-    } : P[K];
-};
-type __VLS_WithTemplateSlots<T, S> = T & {
-    new (): {
-        $slots: S;
+    tag: {
+        type: import("vue").PropType<string>;
+        default: string;
     };
-};
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    label: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    required: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    tag: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+}>>, {
+    label: string;
+    required: boolean;
+    tag: string;
+}, {}>;
+export default _default;

package/types/lib-components/forms/InputHelp.vue.d.ts

@@ -1,31 +1,23 @@
-declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
-    tag?: string | undefined;
-    text?: string | undefined;
-}>, {
-    tag: string;
-    text: 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_TypePropsToRuntimeProps<{
-    tag?: string | undefined;
-    text?: string | undefined;
-}>, {
-    tag: string;
-    text: string;
-}>>>, {
+declare const _default: import("vue").DefineComponent<{
+    tag: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    text: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    tag: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    text: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+}>>, {
     tag: string;
     text: string;
 }, {}>;
 export default _default;
-type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
-type __VLS_TypePropsToRuntimeProps<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;
-    };
-};
-type __VLS_WithDefaults<P, D> = {
-    [K in keyof Pick<P, keyof P>]: K extends keyof D ? P[K] & {
-        default: D[K];
-    } : P[K];
-};

package/types/lib-components/forms/InputLabel.vue.d.ts

@@ -1,36 +1,32 @@
-declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
-    disabled?: boolean | undefined;
-    label?: string | undefined;
-    tag?: string | undefined;
-}>, {
-    disabled: boolean;
-    label: string;
-    tag: 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_TypePropsToRuntimeProps<{
-    disabled?: boolean | undefined;
-    label?: string | undefined;
-    tag?: string | undefined;
-}>, {
-    disabled: boolean;
-    label: string;
-    tag: string;
-}>>>, {
+declare const _default: import("vue").DefineComponent<{
+    label: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    required: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    tag: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    label: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    required: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    tag: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+}>>, {
     label: string;
-    disabled: boolean;
+    required: boolean;
     tag: string;
 }, {}>;
 export default _default;
-type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
-type __VLS_TypePropsToRuntimeProps<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;
-    };
-};
-type __VLS_WithDefaults<P, D> = {
-    [K in keyof Pick<P, keyof P>]: K extends keyof D ? P[K] & {
-        default: D[K];
-    } : P[K];
-};