@caipira/tamandua 0.0.2 → 0.0.3

package/enums/form.ts

@@ -1,25 +0,0 @@
-export enum FormStates {
-    ADD = 1,
-    EDIT = 2,
-}
-
-export const enum FormDataTypes {
-    Address,
-    Boolean,
-    Country,
-    Date,
-    DateRange,
-    Document,
-    Documents,
-    Number,
-    Password,
-    Price,
-    String,
-    StringArray,
-    Website,
-}
-
-export const enum FormSubmissionFormat {
-    FormData,
-    JSON,
-}

package/env.d.ts

@@ -1,8 +0,0 @@
-/// <reference types="vite/client" />
-
-declare module '*.vue' {
-  import { DefineComponent } from 'vue'
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/ban-types
-  const component: DefineComponent<{}, {}, any>
-  export default component
-}

package/form/convertors.ts

@@ -1,31 +0,0 @@
-const jsonToFormData = (json: any) => {
-    const formData = new FormData();
-
-    if (json) {
-        for (const key in json) {
-            if (json[key] !== null && json[key] !== undefined) {
-                if (Array.isArray(json[key])) {
-                    json[key].forEach((item: any) => {
-                        formData.append(`${key}[]`, item);
-                    });
-                } else {
-                    formData.append(key, json[key]);
-                }
-            }
-        }
-    }
-
-    return formData;
-};
-
-const formDataToJson = (formData: FormData) => {
-    const json: any = {};
-
-    formData.forEach((value, key) => {
-        json[key] = value;
-    });
-
-    return json;
-};
-
-export { jsonToFormData, formDataToJson };

package/form/crud.ts

@@ -1,109 +0,0 @@
-import { FormStates } from "@/enums/form";
-
-import Form from "@/components/Form/Form.vue";
-
-export default class CrudService {
-    id: string = "";
-    visible = false;
-    state = FormStates.ADD;
-    title = "";
-    titles = {
-        ADD: `Add `,
-        EDIT: `Edit `,
-    };
-
-    isLoading: boolean = false;
-    formReference: InstanceType<typeof Form> | null = null;
-
-    constructor(entity: string, formReference: any) {
-        this.titles.ADD = this.titles.ADD + entity;
-        this.titles.EDIT = this.titles.EDIT + entity;
-
-        this.formReference = formReference;
-    }
-
-    get isEditing(): boolean {
-        return this.state === FormStates.EDIT;
-    }
-
-    get isCreating(): boolean {
-        return this.state === FormStates.ADD;
-    }
-
-    show(state: FormStates = FormStates.ADD) {
-        switch (state) {
-            case FormStates.ADD:
-                this.id = "";
-                this.title = this.titles.ADD;
-                this.state = FormStates.ADD;
-                break;
-            case FormStates.EDIT:
-                this.title = this.titles.EDIT;
-                this.state = FormStates.EDIT;
-                break;
-        }
-
-        this.visible = true;
-    }
-
-    setLoading(value: boolean = true) {
-        this.isLoading = value;
-    }
-
-    edit(id: string) {
-        this.id = id;
-
-        this.show(FormStates.EDIT);
-    }
-
-    close() {
-        this.reset();
-        this.visible = false;
-    }
-
-    reset() {
-        this.id = "";
-
-        if (this.formReference && this.formReference.reset) {
-            this.formReference?.reset();
-        }
-
-        if (this.isLoading) {
-            this.isLoading = false;
-        }
-    }
-
-    save() {
-        if (!this.formReference) {
-            return;
-        }
-
-        this.isLoading = true;
-        this.formReference.submit();
-    }
-
-    onSave(close: boolean = true) {
-        if (close) {
-            this.close();
-        }
-
-        this.reset();
-    }
-
-    delete() {
-        if (!this.formReference) {
-            return;
-        }
-
-        this.isLoading = true;
-        this.formReference.deleteItem();
-    }
-
-    onDelete(close: boolean = true) {
-        if (close) {
-            this.close();
-        }
-
-        this.reset();
-    }
-}

package/form/form-data-transformers.ts

@@ -1,148 +0,0 @@
-import { FormDataTypes, FormSubmissionFormat } from "@/enums/form";
-import {
-    formValueDateTransformer,
-    formValuePriceTransformer,
-    formValueCountryTransformer,
-    formValuePasswordTransformer,
-} from "@/form/form-value-transformers";
-import {
-    FormDataForm,
-    TransformedForm,
-    FormSchemaValueMap,
-    AcceptedFormDataValues,
-} from "@/types/form";
-
-const sanitizeValue = (value: string | number): AcceptedFormDataValues => {
-    if (value === null || value === undefined) {
-        value = "";
-    } else if (typeof value === "object") {
-        value = JSON.stringify(value);
-    } else if (typeof value === "number") {
-        value = value.toString();
-    } else if (typeof value === "boolean") {
-        value = value ? "1" : "0";
-    }
-
-    return value;
-};
-
-const transformers = {
-    default: (
-        value:
-            | FormSchemaValueMap[FormDataTypes.String]
-            | FormSchemaValueMap[FormDataTypes.Number],
-        form: FormDataForm,
-        key: string,
-    ) => {
-        value = sanitizeValue(value);
-
-        if (value) {
-            form.append(key, value);
-        }
-
-        return form;
-    },
-    price: (
-        price: FormSchemaValueMap[FormDataTypes.Price],
-        form: FormDataForm,
-        key: string,
-        suffixes: string[] = ["Currency", "Value"],
-    ): FormDataForm => {
-        const [iso, value] = formValuePriceTransformer(price);
-
-        form.append(`${key}${suffixes[0]}`, sanitizeValue(iso));
-        form.append(`${key}${suffixes[1]}`, sanitizeValue(value));
-
-        return form;
-    },
-    address: (
-        address: FormSchemaValueMap[FormDataTypes.Address],
-        form: FormDataForm,
-        key: string,
-    ): FormDataForm => {
-        form.append(
-            key,
-            JSON.stringify({
-                ...address,
-                country: formValueCountryTransformer(address?.country),
-            }),
-        );
-
-        return form;
-    },
-    documents: (
-        files: FormSchemaValueMap[FormDataTypes.Documents],
-        form: FormDataForm,
-        key: string,
-    ): FormDataForm => {
-        if (!key.endsWith("[]")) {
-            key = `${key}[]`;
-        }
-
-        Array.from(files).forEach((file: File) => form.append(key, file));
-
-        return form;
-    },
-    document: (
-        file: FormSchemaValueMap[FormDataTypes.Document],
-        form: FormDataForm,
-        key: string,
-    ): FormDataForm => {
-        form.append(key, file);
-
-        return form;
-    },
-    stringArray: (
-        value: FormSchemaValueMap[FormDataTypes.StringArray],
-        form: FormDataForm,
-        key: string,
-    ) => {
-        if (!key.endsWith("[]")) {
-            key = `${key}[]`;
-        }
-
-        value.forEach((item: string) => form.append(key, sanitizeValue(item)));
-
-        return form;
-    },
-};
-
-export const formValueToFormDataValue = async (
-    schema: FormDataTypes,
-    form: TransformedForm<FormSubmissionFormat.FormData>,
-    value: any,
-    key: string,
-): Promise<FormDataForm> => {
-    switch (schema) {
-        case FormDataTypes.Country:
-            return transformers.default(
-                formValueCountryTransformer(value),
-                form,
-                key,
-            );
-        case FormDataTypes.Document:
-            return transformers.document(value, form, key);
-        case FormDataTypes.Documents:
-            return transformers.documents(value, form, key);
-        case FormDataTypes.Date:
-            return transformers.default(
-                formValueDateTransformer(value),
-                form,
-                key,
-            );
-        case FormDataTypes.Address:
-            return transformers.address(value, form, key);
-        case FormDataTypes.Price:
-            return transformers.price(value, form, key);
-        case FormDataTypes.Password:
-            return transformers.default(
-                await formValuePasswordTransformer(value),
-                form,
-                key,
-            );
-        case FormDataTypes.StringArray:
-            return transformers.stringArray(value, form, key);
-        default:
-            return transformers.default(value, form, key);
-    }
-};

package/form/form-transformer.ts

@@ -1,54 +0,0 @@
-import { FormSubmissionFormat } from "@/enums/form";
-import {
-    FormSchema,
-    FormInstance,
-    FormSubmissionFormatMap,
-    TransformedForm,
-} from "@/types/form";
-
-import { formValueToJSONFormValue } from "@/form/json-transformers";
-import { formValueToFormDataValue } from "@/form/form-data-transformers";
-
-/**
- * Transforms the form values to a format that conforms to the submission format
- */
-export const transformForm = async <
-    F extends FormSubmissionFormat,
-    S extends FormSchema,
->(
-    form: FormInstance<S>,
-    schema: FormSchema,
-    submissionFormat: F,
-): Promise<FormSubmissionFormatMap[F]> => {
-    switch (submissionFormat) {
-        case FormSubmissionFormat.JSON:
-            let json: TransformedForm<FormSubmissionFormat.JSON> = {};
-
-            for (const key in form) {
-                json = await formValueToJSONFormValue(
-                    schema[key],
-                    json,
-                    form[key],
-                    key,
-                );
-            }
-
-            return json as FormSubmissionFormatMap[F];
-
-        case FormSubmissionFormat.FormData:
-        default:
-            let formData: TransformedForm<FormSubmissionFormat.FormData> =
-                new FormData();
-
-            for (const key in form) {
-                formData = await formValueToFormDataValue(
-                    schema[key],
-                    formData,
-                    form[key],
-                    key,
-                );
-            }
-
-            return formData as FormSubmissionFormatMap[F];
-    }
-};

package/form/form-value-transformers.ts

@@ -1,32 +0,0 @@
-import { Country } from "@/types/address";
-import { InputPriceModel, InputPasswordModel } from "@/types/form";
-
-// import useVault from "@/composables/useVault";
-import dateService from "@/services/date";
-
-// const vault = useVault();
-
-const formValueDateTransformer = (date: Date): string => {
-    return date ? dateService.format(date, "yyyy-MM-dd") : "";
-};
-
-const formValuePriceTransformer = (price: InputPriceModel): string[] => {
-    return [`${price?.iso}`, `${price?.value}`];
-};
-
-const formValueCountryTransformer = (country?: Country): string => {
-    return country?.iso2 ?? "";
-};
-
-const formValuePasswordTransformer = async (
-    password?: InputPasswordModel,
-): Promise<string> => {
-    return password?.encrypted ?? password?.value ?? "";
-};
-
-export {
-    formValueDateTransformer,
-    formValuePriceTransformer,
-    formValueCountryTransformer,
-    formValuePasswordTransformer,
-};

package/form/form.test.ts

@@ -1,96 +0,0 @@
-import { FormInstance } from "@/types/form";
-import { FormDataTypes, FormSubmissionFormat } from "@/enums/form";
-
-import { expect, test } from "vitest";
-import { transformForm } from "@/form/form-transformer";
-
-test("Form is transformed into FormData", async () => {
-    const schema = {
-        name: FormDataTypes.String as const,
-        age: FormDataTypes.Number as const,
-        hobbies: FormDataTypes.StringArray as const,
-        birthDate: FormDataTypes.Date as const,
-        password: FormDataTypes.Password as const,
-        price: FormDataTypes.Price as const,
-    };
-
-    const form: FormInstance<typeof schema> = {
-        name: "Theone",
-        age: 27,
-        hobbies: ["Reading", "Coding"],
-        birthDate: new Date("1996-10-06"),
-        password: {
-            value: "123",
-            strength: 100,
-            updatedAt: new Date(),
-        },
-        price: {
-            iso: "USD",
-            value: 100,
-        },
-    };
-
-    const transformedForm = await transformForm(
-        form,
-        schema,
-        FormSubmissionFormat.FormData,
-    );
-
-    expect(transformedForm instanceof FormData).toBeTruthy();
-
-    // Only the password is extracted from the object
-    expect(transformedForm.get("password")).toBe("123");
-
-    // The price is split into the currency and value
-    expect(transformedForm.get("priceCurrency")).toBe("USD");
-    expect(transformedForm.get("priceValue")).toBe("100");
-
-    expect(transformedForm.get("name")).toBe("Theone");
-    expect(transformedForm.get("age")).toBe("27");
-    expect(transformedForm.getAll("hobbies[]")).toEqual(["Reading", "Coding"]);
-    expect(transformedForm.get("birthDate")).toBe("1996-10-06");
-});
-
-test("Form is transformed into JSON", async () => {
-    const schema = {
-        name: FormDataTypes.String as const,
-        age: FormDataTypes.Number as const,
-        hobbies: FormDataTypes.StringArray as const,
-        birthDate: FormDataTypes.Date as const,
-        password: FormDataTypes.Password as const,
-        price: FormDataTypes.Price as const,
-    };
-
-    const form: FormInstance<typeof schema> = {
-        name: "Theone",
-        age: 27,
-        hobbies: ["Reading", "Coding"],
-        birthDate: new Date("1996-10-06"),
-        password: {
-            value: "123",
-            strength: 100,
-            updatedAt: new Date(),
-        },
-        price: {
-            iso: "USD",
-            value: 100,
-        },
-    };
-
-    const transformedForm = await transformForm(
-        form,
-        schema,
-        FormSubmissionFormat.JSON,
-    );
-
-    expect(transformedForm instanceof Object).toBeTruthy();
-    expect(transformedForm).toEqual({
-        name: "Theone",
-        age: 27,
-        hobbies: ["Reading", "Coding"],
-        birthDate: "1996-10-06",
-        password: "123",
-        priceCurrency: "USD",
-        priceValue: "100",
-    });
-});

package/form/json-transformers.ts

@@ -1,91 +0,0 @@
-import { FormDataTypes, FormSubmissionFormat } from "@/enums/form";
-import {
-    JSONForm,
-    FormSchema,
-    TransformedForm,
-    FormSchemaValueMap,
-} from "@/types/form";
-
-import {
-    formValueDateTransformer,
-    formValuePriceTransformer,
-    formValueCountryTransformer,
-    formValuePasswordTransformer,
-} from "@/form/form-value-transformers";
-
-const transformers = {
-    default: (
-        value: FormSchemaValueMap[FormDataTypes.String],
-        form: JSONForm,
-        key: string,
-    ) => {
-        form[key] = value;
-
-        return form;
-    },
-    price: (
-        date: FormSchemaValueMap[FormDataTypes.Price],
-        form: JSONForm,
-        key: string,
-        suffixes: string[] = ["Currency", "Value"],
-    ): JSONForm => {
-        const [currency, value] = formValuePriceTransformer(date);
-
-        form[`${key}${suffixes[0]}`] = currency;
-        form[`${key}${suffixes[1]}`] = value;
-
-        return form;
-    },
-    password: async (
-        value: FormSchemaValueMap[FormDataTypes.Password],
-        form: JSONForm,
-        key: string,
-    ): Promise<JSONForm> => {
-        form[key] = await formValuePasswordTransformer(value);
-
-        return form;
-    },
-    stringArray: (
-        value: FormSchemaValueMap[FormDataTypes.StringArray],
-        form: JSONForm,
-        key: string,
-    ) => {
-        form[key] = value;
-
-        return form;
-    },
-};
-
-export const formValueToJSONFormValue = async <T extends FormDataTypes>(
-    schema: FormSchema[T],
-    form: TransformedForm<FormSubmissionFormat.JSON>,
-    value: any,
-    key: string,
-): Promise<JSONForm> => {
-    switch (schema) {
-        case FormDataTypes.Country:
-            return transformers.default(
-                formValueCountryTransformer(value),
-                form,
-                key,
-            );
-        case FormDataTypes.Documents:
-            return transformers.default(value, form, key);
-        case FormDataTypes.Date:
-            return transformers.default(
-                formValueDateTransformer(value),
-                form,
-                key,
-            );
-        case FormDataTypes.Address:
-            return transformers.default(value, form, key);
-        case FormDataTypes.Price:
-            return transformers.price(value, form, key);
-        case FormDataTypes.Password:
-            return await transformers.password(value, form, key);
-        case FormDataTypes.StringArray:
-            return transformers.stringArray(value, form, key);
-        default:
-            return transformers.default(value, form, key);
-    }
-};

package/i18n.ts

@@ -1,20 +0,0 @@
-import { createI18n } from "vue-i18n";
-
-export default createI18n({
-    locale: "en",
-    legacy: false,
-    numberFormats: {
-        EUR: {
-            currency: {
-                style: "currency",
-                currency: "EUR",
-            },
-        },
-        BRL: {
-            currency: {
-                style: "currency",
-                currency: "BRL",
-            },
-        },
-    },
-});