@caipira/tamandua 0.0.33 → 0.0.34

package/dist/types/components/InputPrice/InputPrice.vue.d.ts

@@ -1,4 +1,20 @@
-declare const _default: import('vue').DefineComponent<any, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<any>, {} | {
-    [x: string]: any;
-}, {}>;
+import { InputPriceModel } from './types.js';
+
+declare const _default: import('vue').DefineComponent<{
+    modelValue: import("vue").PropType<InputPriceModel>;
+    resource: {
+        type: import("vue").PropType<() => any>;
+    };
+    disabled: {
+        type: import("vue").PropType<boolean>;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    modelValue: import("vue").PropType<InputPriceModel>;
+    resource: {
+        type: import("vue").PropType<() => any>;
+    };
+    disabled: {
+        type: import("vue").PropType<boolean>;
+    };
+}>>, {}, {}>;
 export default _default;

package/dist/types/components/InputPrice/types.d.ts

@@ -1,3 +1,7 @@
+export type InputPriceModel = {
+    iso: string;
+    value?: number;
+};
 export type InputPriceProps = {
     resource?: () => any;
     disabled?: boolean;

package/dist/types/components/InputSelect/InputSelect.story.d.ts

@@ -1,5 +1,5 @@
 import { APISearchFilters } from '../../types/api.js';
-import { SelectOption } from '../../types/form.js';
+import { SelectOption } from './types.js';
 import { Pagination } from '../../types/ui.js';
 
 declare const _default: {

package/dist/types/components/InputSelect/InputSelect.vue.d.ts

@@ -1,10 +1,77 @@
-declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<any, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<any>, {} | {
-    [x: string]: any;
+import { ElementSize, ElementPosition } from '../../enums/ui.js';
+import { SelectOption, InputSelectProps } from './types.js';
+
+declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<InputSelectProps>, {
+    size: ElementSize;
+    options: () => never[];
+    mapper: (i: any) => SelectOption;
+    filter: (input: string, option: SelectOption) => boolean;
+    tooltip: string;
+    multiple: boolean;
+    placeholder: string;
+    isSearchable: boolean;
+    dropdownPlacement: ElementPosition;
+    /**
+     * CSS Classes
+     */
+    widthClass: string;
+    borderClass: string;
+    roundnessClass: string;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:model-value": (val: any) => void;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<InputSelectProps>, {
+    size: ElementSize;
+    options: () => never[];
+    mapper: (i: any) => SelectOption;
+    filter: (input: string, option: SelectOption) => boolean;
+    tooltip: string;
+    multiple: boolean;
+    placeholder: string;
+    isSearchable: boolean;
+    dropdownPlacement: ElementPosition;
+    /**
+     * CSS Classes
+     */
+    widthClass: string;
+    borderClass: string;
+    roundnessClass: string;
+}>>> & {
+    "onUpdate:model-value"?: ((val: any) => any) | undefined;
+}, {
+    filter: (input: string, option: SelectOption) => boolean;
+    size: ElementSize;
+    multiple: boolean;
+    options: SelectOption[];
+    placeholder: string;
+    mapper: (i: any) => SelectOption;
+    tooltip: string;
+    isSearchable: boolean;
+    dropdownPlacement: "top-start" | "top" | "top-end" | "right-start" | "right" | "right-end" | "bottom-end" | "bottom" | "bottom-start" | "left-end" | "left" | "left-start";
+    widthClass: string;
+    borderClass: string;
+    roundnessClass: string;
 }, {}>, {
     selection?(_: {}): any;
     default?(_: any): 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;
+    };
+};
+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;

package/dist/types/components/InputSelect/types.d.ts

@@ -1,8 +1,39 @@
-import { ElementSize, ElementPosition } from '../../enums/ui.js';
-import { SelectValue, SelectOption } from '../../types/form.js';
+import { Icon, ElementSize, ElementPosition } from '../../enums/ui.js';
 import { APISearchFilters } from '../../types/api.js';
 import { Pagination } from '../../types/ui.js';
 
+export type SelectValuePrimitives = string | number;
+export type SelectValue = SelectValuePrimitives | Array<SelectValuePrimitives>;
+export type SelectOption = {
+    /** Optional icon, to be appended to the label */
+    icon?: `${Icon}`;
+    /** Option label, either a string or an object containing the props necessary to render the option */
+    label: string | object;
+    /** Optional type, used to diferentiate options from one another */
+    type?: string;
+    /** Optional renderer, containing the fully resolved path to the component that will be used
+     * to render the option
+     */
+    renderer?: string;
+} & ({
+    /** If true, the option is a group label and can't be selected */
+    isGroupLabel: boolean;
+    value?: never;
+    action?: never;
+} | {
+    /** Option value */
+    value: SelectValue;
+    action?: never;
+    isGroupLabel?: never;
+} | {
+    /** Action to be executed once the option is selected */
+    action: (filters?: APISearchFilters) => Promise<{
+        items: unknown[];
+        pagination: Pagination;
+    }> | Promise<void> | void;
+    value?: never;
+    isGroupLabel?: never;
+});
 export type InputSelectProps = {
     size?: ElementSize;
     options?: SelectOption[];

package/dist/types/components/ModalForm/ModalForm.vue.d.ts

@@ -6,6 +6,11 @@ declare const _default: import('vue').DefineComponent<__VLS_WithDefaults<__VLS_T
 }>, {
     open: (key: string, id?: string | undefined) => void;
     delete: () => void;
+    submit: () => Promise<{
+        isValid: boolean;
+        form: FormData | import("../../index.js").JSONForm;
+    } | undefined>;
+    reset: () => void;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     saved: () => void;
     closed: () => void;
@@ -16,7 +21,7 @@ declare const _default: import('vue').DefineComponent<__VLS_WithDefaults<__VLS_T
     onClosed?: (() => any) | undefined;
     onSaved?: (() => any) | undefined;
 }, {
-    options: import("../../index.js").SelectOption[];
+    options: import("../InputSelect/types.js").SelectOption[];
     formClass: string;
 }, {}>;
 export default _default;

package/dist/types/components/ModalForm/types.d.ts

@@ -1,13 +1,15 @@
-import { SelectOption } from '../../types/form.js';
+import { ComponentExposed } from 'vue-component-type-helpers';
+import { SelectOption } from '../InputSelect/types.js';
+import { default as Form } from '../Form/Form.vue';
 
-export type Form = {
+export type FormItem = {
     key: string;
     title: string;
-    component: any;
+    component: ComponentExposed<typeof Form>;
     pinnable?: boolean;
 };
 export type ModalFormProps = {
-    forms: Form[];
+    forms: FormItem[];
     options?: SelectOption[];
     formClass?: string;
 };

package/dist/types/composables/useForm.d.ts

@@ -0,0 +1,20 @@
+import { FormSubmissionFormat } from '../enums/form.js';
+import { FormSchema, FormInstance } from '../types/form.js';
+import { Ref, UnwrapNestedRefs } from 'vue';
+
+export default function useForm<TSchema extends FormSchema = FormSchema>(options: {
+    id?: Ref<string | number>;
+    idKey?: string;
+    schema: TSchema;
+    format?: FormSubmissionFormat;
+}): {
+    form: UnwrapNestedRefs<FormInstance<TSchema>>;
+    setValue: <K extends keyof UnwrapNestedRefs<FormInstance<TSchema>>>(key: K, value: UnwrapNestedRefs<FormInstance<TSchema>>[K]) => void;
+    setValues: (values: Partial<FormInstance<TSchema>>) => void;
+    getValue: (key: keyof UnwrapNestedRefs<FormInstance<TSchema>>) => UnwrapNestedRefs<FormInstance<TSchema>>[keyof UnwrapNestedRefs<FormInstance<TSchema>>];
+    reset: () => void;
+    submit: () => Promise<{
+        isValid: boolean;
+        form: FormData | import('../types/form.js').JSONForm;
+    }>;
+};

package/dist/types/form/crud.d.ts

@@ -1,5 +1,6 @@
 import { FormStates } from '../enums/form.js';
-import { default as Form } from '../components/Form/Form.vue';
+import { ComponentExposed } from 'vue-component-type-helpers';
+import { default as ModalForm } from '../components/ModalForm/ModalForm.vue';
 
 export default class CrudService {
     id: string;
@@ -11,8 +12,8 @@ export default class CrudService {
         EDIT: string;
     };
     isLoading: boolean;
-    formReference: InstanceType<typeof Form> | null;
-    constructor(entity: string, formReference: any);
+    formReference: ComponentExposed<typeof ModalForm> | undefined;
+    constructor(entity: string, formReference: ComponentExposed<typeof ModalForm>);
     get isEditing(): boolean;
     get isCreating(): boolean;
     show(state?: FormStates): void;
@@ -20,7 +21,7 @@ export default class CrudService {
     edit(id: string): void;
     close(): void;
     reset(): void;
-    save(): void;
+    save(): Promise<void>;
     onSave(close?: boolean): void;
     delete(): void;
     onDelete(close?: boolean): void;

package/dist/types/form/form-transformer.d.ts

@@ -1,7 +1,7 @@
-import { FormSchema, FormInstance, FormSubmissionFormatMap } from '../types/form.js';
+import { JSONForm, FormSchema, FormInstance, FormDataForm } from '../types/form.js';
 import { FormSubmissionFormat } from '../enums/form.js';
 
 /**
  * Transforms the form values to a format that conforms to the submission format
  */
-export declare const transformForm: <F extends FormSubmissionFormat, S extends FormSchema>(form: FormInstance<S>, schema: FormSchema, submissionFormat: F) => Promise<FormSubmissionFormatMap[F]>;
+export declare const transformForm: <F extends FormSubmissionFormat, S extends FormSchema>(form: FormInstance<S>, schema: S, format: F) => Promise<F extends FormSubmissionFormat.FormData ? FormDataForm : JSONForm>;

package/dist/types/form/form-transformer.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/form/form-value-transformers.d.ts

@@ -1,4 +1,5 @@
-import { InputPriceModel, InputPasswordModel } from '../types/form.js';
+import { InputPasswordModel } from '../components/InputPassword/types.js';
+import { InputPriceModel } from '../components/InputPrice/types.js';
 import { Country } from '../types/address.js';
 
 declare const formValueDateTransformer: (date: Date) => string;

package/dist/types/types/address.d.ts

@@ -1,15 +1,15 @@
-export interface Country {
+export type Country = {
     name: string;
     dialCode: string;
     flag: string;
     iso2: string;
     order: string;
-}
-export interface CountryStateOption {
+};
+export type CountryStateOption = {
     uuid: string;
     name: string;
-}
-export interface AddressResource {
+};
+export type AddressResource = {
     city?: string;
     complement?: string;
     country?: string;
@@ -22,8 +22,8 @@ export interface AddressResource {
     street?: string;
     town?: string;
     zipCode?: string;
-}
-export interface AddressModel {
+};
+export type AddressModel = {
     city?: string;
     complement?: string;
     country?: Country;
@@ -36,4 +36,4 @@ export interface AddressModel {
     street?: string;
     town?: string;
     zipCode?: string;
-}
+};

package/dist/types/types/common.d.ts

@@ -2,3 +2,4 @@ export type KeysMatching<T, V> = {
     [K in keyof T]-?: T[K] extends V ? K : never;
 }[keyof T];
 export type Maybe<T> = NonNullable<T> | undefined;
+export type Default<T, D> = T extends undefined ? D : T;

package/dist/types/types/form.d.ts

@@ -1,59 +1,13 @@
 import { FormDataTypes, FormSubmissionFormat } from '../enums/form.js';
-import { Icon } from '../enums/ui.js';
 import { AddressModel, Country } from './address.js';
-import { APISearchFilters } from './api.js';
-import { Pagination } from './ui.js';
+import { InputPasswordModel } from '../components/InputPassword/types.js';
+import { InputPriceModel } from '../components/InputPrice/types.js';
 import { Website } from './website.js';
+import { Maybe } from './common.js';
 
-export type SelectValuePrimitives = string | number;
-export type SelectValue = SelectValuePrimitives | Array<SelectValuePrimitives>;
-export type SelectOption = {
-    /** Optional icon, to be appended to the label */
-    icon?: `${Icon}`;
-    /** Option label, either a string or an object containing the props necessary to render the option */
-    label: string | object;
-    /** Optional type, used to diferentiate options from one another */
-    type?: string;
-    /** Optional renderer, containing the fully resolved path to the component that will be used
-     * to render the option
-     */
-    renderer?: string;
-} & ({
-    /** If true, the option is a group label and can't be selected */
-    isGroupLabel: boolean;
-    value?: never;
-    action?: never;
-} | {
-    /** Option value */
-    value: SelectValue;
-    action?: never;
-    isGroupLabel?: never;
-} | {
-    /** Action to be executed once the option is selected */
-    action: (filters?: APISearchFilters) => Promise<{
-        items: unknown[];
-        pagination: Pagination;
-    }> | Promise<void> | void;
-    value?: never;
-    isGroupLabel?: never;
-});
-export interface InputPriceModel {
-    iso: string;
-    value?: number;
-}
-export interface InputPasswordModel {
-    /** Unencrypted password */
-    raw: string;
-    /** If an encryptor was passed, this prop will hold the encrypted value */
-    hash?: string;
-    /** Strength of the password */
-    strength?: number;
-    /** Date of creation or last update */
-    updatedAt?: Date;
-}
-export type FormStyle = {
-    [key in "label" | "input"]?: string;
-};
+/**
+ * Map of the form data types and their corresponding value types
+ */
 export type FormSchemaValueMap = {
     [FormDataTypes.Address]: AddressModel;
     [FormDataTypes.Boolean]: boolean;
@@ -69,6 +23,10 @@ export type FormSchemaValueMap = {
     [FormDataTypes.StringArray]: string[];
     [FormDataTypes.Website]: Website;
 };
+/**
+ * Form in the FormData format
+ */
+export type FormDataForm = InstanceType<typeof FormData>;
 /**
  * Form in the JSON format
  */
@@ -76,9 +34,8 @@ export type JSONForm = {
     [prop: string]: string | number | boolean | string[];
 };
 /**
- * Form in the FormData format
+ * Form submission format map
  */
-export type FormDataForm = InstanceType<typeof FormData>;
 export type FormSubmissionFormatMap = {
     [FormSubmissionFormat.FormData]: FormDataForm;
     [FormSubmissionFormat.JSON]: JSONForm;
@@ -98,17 +55,15 @@ export type ValidationResult<T = FormSubmissionFormat.FormData> = {
 /**
  * Form schema, defining the form fields and their corresponding FormDataTypes
  */
-export type FormSchema = {
-    [key: string]: FormDataTypes;
-};
+export type FormSchema = Record<string, FormDataTypes>;
 /**
  * Object containing the form values, each value being of one of the types from
  * FormDataTypes, defined by each corresponding input component
  */
 export type FormInstance<T extends Record<string, FormDataTypes>> = {
-    [K in keyof T]: FormSchemaValueMap[T[K]];
+    [K in keyof T]: T[K] extends FormDataTypes ? Maybe<FormSchemaValueMap[T[K]]> : never;
 };
 /**
- * Type union of the accepted values by the FormData
+ * Union type of the accepted values by FormData
  */
 export type AcceptedFormDataValues = string | Blob;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@caipira/tamandua",
-    "version": "0.0.33",
+    "version": "0.0.34",
     "private": false,
     "description": "UI library for the Caipira ecosystem",
     "license": "GPL-3.0-only",
@@ -62,11 +62,12 @@
         "build:dev": "vite build --mode development",
         "build:prod": "vite build --mode production",
         "preview": "vite preview",
-        "start:test": "vitest",
+        "test:start": "vitest",
         "test": "vitest --run",
         "typecheck": "vue-tsc --noEmit -p tsconfig.json --composite false",
         "start:sb": "storybook dev",
-        "build:sb": "storybook build"
+        "build:sb": "storybook build",
+        "prepublishOnly": "npm run build:prod"
     },
     "dependencies": {
         "@floating-ui/vue": "^1.0.6",
@@ -77,9 +78,11 @@
     "peerDependencies": {
         "tailwindcss": "^3.4.3",
         "vue": "^3.0.0",
-        "vue-i18n": "9"
+        "vue-i18n": "9",
+        "vue-router": "4.3.0"
     },
     "devDependencies": {
+        "vue-component-type-helpers": "^2.0.19",
         "@faker-js/faker": "^8.4.1",
         "@storybook/addon-actions": "^8.0.8",
         "@storybook/addon-essentials": "^8.0.8",

package/dist/Form.vue_vue_type_script_setup_true_lang-CbuLc6sr.js

@@ -1,186 +0,0 @@
-import { defineComponent as A, reactive as P, ref as _, watch as T, provide as N, resolveComponent as O, openBlock as B, createElementBlock as j, renderSlot as E, createElementVNode as J, normalizeClass as R, withDirectives as W, createVNode as M, mergeProps as z, vShow as K } from "vue";
-import { B as L } from "./ui-BC6H9E93.js";
-import { F as a, a as p } from "./form-BkXpIJ0e.js";
-import { f as I } from "./index-CjvqeRf7.js";
-const V = (t) => t ? I(t, "yyyy-MM-dd") : "", h = (t) => [`${t?.iso}`, `${t?.value}`], b = (t) => t?.iso2 ?? "", w = async (t) => t?.hash ? t.hash : t?.raw ?? "", i = {
-  default: (t, r, e) => (r[e] = t, r),
-  price: (t, r, e, n = ["Currency", "Value"]) => {
-    const [c, s] = h(t);
-    return r[`${e}${n[0]}`] = c, r[`${e}${n[1]}`] = s, r;
-  },
-  password: async (t, r, e) => (r[e] = await w(t), r),
-  stringArray: (t, r, e) => (r[e] = t, r)
-}, Y = async (t, r, e, n) => {
-  switch (t) {
-    case a.Country:
-      return i.default(
-        b(e),
-        r,
-        n
-      );
-    case a.Documents:
-      return i.default(e, r, n);
-    case a.Date:
-      return i.default(
-        V(e),
-        r,
-        n
-      );
-    case a.Address:
-      return i.default(e, r, n);
-    case a.Price:
-      return i.price(e, r, n);
-    case a.Password:
-      return await i.password(e, r, n);
-    case a.StringArray:
-      return i.stringArray(e, r, n);
-    default:
-      return i.default(e, r, n);
-  }
-}, m = (t) => (t == null ? t = "" : typeof t == "object" ? t = JSON.stringify(t) : typeof t == "number" ? t = t.toString() : typeof t == "boolean" && (t = t ? "1" : "0"), t), u = {
-  default: (t, r, e) => (t = m(t), t && r.append(e, t), r),
-  price: (t, r, e, n = ["Currency", "Value"]) => {
-    const [c, s] = h(t);
-    return r.append(`${e}${n[0]}`, m(c)), r.append(`${e}${n[1]}`, m(s)), r;
-  },
-  address: (t, r, e) => (r.append(
-    e,
-    JSON.stringify({
-      ...t,
-      country: b(t?.country)
-    })
-  ), r),
-  documents: (t, r, e) => (e.endsWith("[]") || (e = `${e}[]`), Array.from(t).forEach((n) => r.append(e, n)), r),
-  document: (t, r, e) => (r.append(e, t), r),
-  stringArray: (t, r, e) => (e.endsWith("[]") || (e = `${e}[]`), t.forEach((n) => r.append(e, m(n))), r)
-}, q = async (t, r, e, n) => {
-  switch (t) {
-    case a.Country:
-      return u.default(
-        b(e),
-        r,
-        n
-      );
-    case a.Document:
-      return u.document(e, r, n);
-    case a.Documents:
-      return u.documents(e, r, n);
-    case a.Date:
-      return u.default(
-        V(e),
-        r,
-        n
-      );
-    case a.Address:
-      return u.address(e, r, n);
-    case a.Price:
-      return u.price(e, r, n);
-    case a.Password:
-      return u.default(
-        await w(e),
-        r,
-        n
-      );
-    case a.StringArray:
-      return u.stringArray(e, r, n);
-    default:
-      return u.default(e, r, n);
-  }
-}, x = async (t, r, e) => {
-  switch (e) {
-    case p.JSON:
-      let n = {};
-      for (const s in t)
-        n = await Y(
-          r[s],
-          n,
-          t[s],
-          s
-        );
-      return n;
-    case p.FormData:
-    default:
-      let c = new FormData();
-      for (const s in t)
-        c = await q(
-          r[s],
-          c,
-          t[s],
-          s
-        );
-      return c;
-  }
-}, X = /* @__PURE__ */ A({
-  name: "TForm",
-  __name: "Form",
-  props: {
-    id: { default: "" },
-    idKey: { default: "id" },
-    schema: { default: () => ({}) },
-    formStyle: { default: () => ({}) },
-    showSubmit: { type: Boolean, default: !1 },
-    submitLabel: { default: "Submit" },
-    buttonProps: {},
-    buttonVariant: { default: L.PRIMARY },
-    submissionFormat: { default: p.FormData },
-    buttonWrapperClasses: { default: "" }
-  },
-  emits: ["submit", "change"],
-  setup(t, { expose: r, emit: e }) {
-    const n = t, c = e, s = P({}), y = _(null), l = async () => {
-      c("submit", await F());
-    }, F = async () => {
-      const o = { ...s };
-      return n.id && (o[n.idKey] = n.id), {
-        isValid: !0,
-        form: await x(
-          o,
-          n.schema,
-          n.submissionFormat
-        )
-      };
-    }, S = () => {
-      Object.assign(s, {});
-    }, g = (o) => {
-      for (const [d, f] of Object.entries(o))
-        s[d] = f;
-    }, $ = () => s, D = (o, d) => {
-      s[o] = d;
-    }, C = (o) => s[o];
-    return T(s, (o) => {
-      c("change", o);
-    }), N("formStyle", n.formStyle), r({
-      submit: l,
-      reset: S,
-      setValues: g,
-      getValues: $,
-      setValue: D,
-      getValue: C
-    }), (o, d) => {
-      const f = O("t-button");
-      return B(), j("form", {
-        onSubmit: l,
-        ref_key: "formReference",
-        ref: y
-      }, [
-        E(o.$slots, "default", { form: s }),
-        J("div", {
-          class: R([n.buttonWrapperClasses])
-        }, [
-          W(M(f, z(n.buttonProps, {
-            type: "submit",
-            class: "mt-4",
-            variant: n.buttonVariant,
-            label: n.submitLabel,
-            onClick: l
-          }), null, 16, ["variant", "label"]), [
-            [K, n.showSubmit]
-          ])
-        ], 2)
-      ], 544);
-    };
-  }
-});
-export {
-  X as _
-};