@open-xamu-co/ui-common-types 4.0.0-next.6 → 4.0.0-next.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xamu-co/ui-common-types",
-  "version": "4.0.0-next.6",
+  "version": "4.0.0-next.8",
   "description": "Xamu shared types",
   "author": "@xamu-co",
   "main": "src/index.ts",
@@ -31,7 +31,7 @@
     "build:legacy": "rimraf dist && tsc --outDir dist --declaration --emitDeclarationOnly"
   },
   "dependencies": {
-    "@open-xamu-co/ui-common-enums": "^4.0.0-next.2",
+    "@open-xamu-co/ui-common-enums": "^4.0.0-next.3",
     "@fortawesome/fontawesome-common-types": "^6.4.0",
     "sweetalert2": "^11.11.1"
   },

package/src/form/class.ts

@@ -7,11 +7,12 @@ import type {
 import type {
 	iFormInput,
 	iFormInputDefault,
+	iFormOption,
 	iFormValue,
 	tFormAutocomplete,
 	tFormIcon,
+	tOptionsLoaderFn,
 } from "./types";
-import type { iSelectOption } from "../values.js";
 
 export declare abstract class tFormInputDefault<
 	T extends eFormTypeBase | eFormTypeSimple | eFormTypeComplex = eFormTypeSimple,
@@ -44,12 +45,13 @@ export declare abstract class tFormInput<
 	// public readonly
 	public readonly name: string;
 	public readonly title?: string;
-	public readonly multiple: boolean;
-	public readonly min: number;
-	public readonly max: number;
-	public readonly meta?: Record<string, any>;
+	public readonly optionsFilter?: tOptionsLoaderFn;
 	// public
-	public options: iSelectOption[];
+	public multiple: boolean;
+	public min: number;
+	public max: number;
+	public meta?: Record<string, any>;
+	public options: iFormOption[];
 	public values: V[];
 	public defaults?: [
 		iFormInputDefault<eFormTypeBase | eFormTypeSimple | eFormTypeComplex>,

package/src/form/types.ts

@@ -34,7 +34,17 @@ export interface iFormResults<T = Record<string, unknown>> {
 	invalidInputs: iInvalidInput[];
 }
 
-export type tTextInputType = "text" | "email" | "password" | "search" | "url" | "number" | "tel";
+export type tTextInputType =
+	| "text"
+	| "email"
+	| "password"
+	| "search"
+	| "url"
+	| "number"
+	| "tel"
+	| "date"
+	| "datetime-local"
+	| "time";
 
 export type tFormAutocomplete =
 	| "off"
@@ -113,15 +123,29 @@ export interface iFormInputDefault<
 	autocomplete?: tFormAutocomplete;
 }
 
+export type tOptionsLoaderFn =
+	| ((v?: string | number, signal?: AbortSignal) => iFormOption[])
+	| ((v?: string | number, signal?: AbortSignal) => Promise<iFormOption[]>);
+
+/** If a function is given, it should be responsible of determining if v is a value or an alias (search) */
+export type iFormInputOptions = (string | number | iFormOption)[] | tOptionsLoaderFn;
+
 /**
  * Complex input, sub input support
+ * Used as input for the classes
  */
 export interface iFormInput<
 	V extends iFormValue | iFormValue[],
 	T extends eFormTypeBase | eFormTypeSimple | eFormTypeComplex,
 > extends iFormInputDefault<T> {
 	name: string;
-	options?: (string | number | iFormOption)[];
+	/**
+	 * Options for select, checkbox, radio inputs
+	 * The usage of a function requires a compatible component (SelectFilter)
+	 *
+	 * @values array of options or function that returns options
+	 */
+	options?: iFormInputOptions;
 	/**
 	 * An array of values to simplify validation
 	 *
@@ -189,6 +213,13 @@ export interface iFetchResponse<R = any> {
 	[x: string]: any;
 }
 
+/**
+ * Takes the parsed inputs values and perform a request (content creation, update, etc).
+ *
+ * @param values Values of the input
+ * @param fetcher Request function
+ * @returns Response with data and errors if any
+ */
 export type tResponseFn<T, V extends Record<string, any> = Record<string, any>> = (
 	values: V
 ) => Promise<iFetchResponse<T>>;

package/src/locale.ts

@@ -180,6 +180,12 @@ export type tLocaleForm = {
 	form_cellphone: string;
 	/** @example "ID number" */
 	form_id_number: string;
+	/** @example "Date" */
+	form_date: string;
+	/** @example "Date & time" */
+	form_datetime: string;
+	/** @example "Time" */
+	form_time: string;
 	/** @example "Complete the field" */
 	form_complete_the_field: string;
 	/** @example "Location" */