@uniquedj95/vform 1.2.0

package/dist/types/index.d.ts

@@ -0,0 +1,61 @@
+export type FormValue = string | number | boolean | Option | Array<Option>;
+export type FormValidator = (value: FormValue, schema?: FormSchema) => Promise<Array<string> | null> | Array<string> | null;
+export type ComputedValueHandler = (value: FormValue, schema: FormSchema) => Promise<any> | any;
+export type FormOptions = Array<Option> | (() => Promise<Array<Option>>);
+export type FormData = Record<string, FormValue | undefined>;
+export type ComputedData = Record<string, any>;
+export type FormSchema = Record<string, FormField>;
+export interface GridSize {
+    xs?: string;
+    sm?: string;
+    md?: string;
+    lg?: string;
+    xl?: string;
+}
+export interface FormField {
+    value?: FormValue;
+    type: InputType;
+    label?: string;
+    required?: boolean;
+    options?: FormOptions;
+    multiple?: boolean;
+    min?: number | string;
+    max?: number | string;
+    counter?: boolean;
+    minLength?: number;
+    maxLength?: number;
+    disabled?: boolean;
+    hidden?: boolean;
+    grid?: GridSize;
+    placeholder?: string;
+    icon?: string;
+    prefix?: string;
+    suffix?: string;
+    error?: string;
+    pattern?: string;
+    allowUnknown?: boolean;
+    allowCustom?: boolean;
+    autoFocus?: boolean;
+    fill?: "solid" | "outline";
+    labelPlacement?: "stacked" | "start" | "end" | "fixed" | "floating";
+    validation?: FormValidator;
+    onChange?: (value: FormValue) => FormValue;
+    computedValue?: ComputedValueHandler;
+    condition?: (data: FormData, computedData: ComputedData) => boolean;
+}
+export interface OptionDescription {
+    color: "primary" | "warning" | "danger" | "secondary" | "light";
+    show?: "onChecked" | "always";
+    text: string;
+}
+export interface Option {
+    label: string;
+    value: string | number;
+    other?: any;
+    isChecked?: boolean;
+    disabled?: boolean;
+    description?: OptionDescription;
+}
+export type InputType = "TextInput" | "DateInput" | "NumberInput" | "EmailInput" | "PasswordInput";
+export type BaseFieldTypes = "text" | "password" | "email" | "number" | "tel" | "url" | "search" | "time" | "month" | "week";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;AAC3E,MAAM,MAAM,aAAa,GAAG,CAC1B,KAAK,EAAE,SAAS,EAChB,MAAM,CAAC,EAAE,UAAU,KAChB,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;AAC1D,MAAM,MAAM,oBAAoB,GAAG,CACjC,KAAK,EAAE,SAAS,EAChB,MAAM,EAAE,UAAU,KACf,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;AACxB,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACzE,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC,CAAC;AAC7D,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAC/C,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAEnD,MAAM,WAAW,QAAQ;IACvB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B,cAAc,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,KAAK,GAAG,OAAO,GAAG,UAAU,CAAC;IACpE,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,SAAS,CAAC;IAC3C,aAAa,CAAC,EAAE,oBAAoB,CAAC;IACrC,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,KAAK,OAAO,CAAC;CACrE;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,WAAW,GAAG,OAAO,CAAC;IAChE,IAAI,CAAC,EAAE,WAAW,GAAG,QAAQ,CAAC;IAC9B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,iBAAiB,CAAC;CACjC;AAED,MAAM,MAAM,SAAS,GACjB,WAAW,GACX,WAAW,GACX,aAAa,GACb,YAAY,GACZ,eAAe,CAAA;AAEnB,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,UAAU,GACV,OAAO,GACP,QAAQ,GACR,KAAK,GACL,KAAK,GACL,QAAQ,GACR,MAAM,GACN,OAAO,GACP,MAAM,CAAA"}

package/dist/utils/index.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Form Builder Utility functions.
+ *
+ * @packageDocumentation
+ * @module utils
+ * @preferred
+ * @author Daniel Justin.
+ **/
+/**
+ * Full month names.
+ **/
+export declare const monthNames: string[];
+/**
+ * Checks if a value is "empty".
+ *
+ * @param value - The value to check for emptiness.
+ * @returns `true` if the value is `null` or `undefined`, an empty string, an empty array, or an empty object.
+ * Returns `false` otherwise.
+ */
+export declare function isEmpty(value: any): boolean;
+/**
+ * Format a date string according to a given pattern.
+ *
+ * @param date - The date string to format.
+ * @param pattern - The pattern to format the date string with. default is 'DD/MMM/2024'.
+ * @returns The formatted date string.
+ */
+export declare function formatDate(date: string, pattern?: string): string;
+/**
+ * Append a zero to a number if it is less than 10.
+ *
+ * @param num - The number to append a zero to.
+ * @returns The number as a string with a zero appended if it is less than 10.
+ */
+export declare function zeroPad(num: number): string;
+/**
+ * Get the month name or number.
+ *
+ * @param month - The month number or name.
+ * @param part - The part of the month to get. Either 'MMMM', 'MMM', or 'MM'.
+ * @returns The month name or number.
+ */
+export declare function getMonth(month: number | string, part: string): string;
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA;;;;;;;IAOI;AAEJ;;IAEI;AACJ,eAAO,MAAM,UAAU,UAatB,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAQ3C;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,MAAsB,GAAG,MAAM,CAuChF;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE3C;AAED;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,MAAM,UAO5D"}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@uniquedj95/vform",
+  "version": "1.2.0",
+  "description": "A simplified ionic vue desktop form builder",
+  "type": "module",
+  "main": "./dist/index.umd.js",
+  "module": "./dist/index.es.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.es.js",
+      "require": "./dist/index.umd.js"
+    }
+  },
+  "scripts": {
+    "build": "vite build",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "Vue",
+    "ionic",
+    "typescript",
+    "Form builder"
+  ],
+  "author": "Daniel Justin <danieljmuleke@gamil.com>",
+  "license": "MIT",
+  "devDependencies": {
+    "@ionic/vue": "^8.2.5",
+    "@vitejs/plugin-vue": "^5.0.5",
+    "ionicons": "^7.4.0",
+    "typescript": "^5.5.3",
+    "vite": "^5.3.3",
+    "vite-plugin-dts": "^3.9.1",
+    "vue": "^3.4.31"
+  },
+  "peerDependencies": {
+    "vue": "^3.4.31"
+  },
+  "dependencies": {
+    "@vuepic/vue-datepicker": "^9.0.1"
+  }
+}