@open-xamu-co/ui-common-types 3.0.0-next.23 → 3.0.0-next.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xamu-co/ui-common-types",
-  "version": "3.0.0-next.23",
+  "version": "3.0.0-next.24",
   "description": "Xamu shared types",
   "author": "@xamu-co",
   "main": "src/index.ts",

package/src/form/class.ts

@@ -0,0 +1,93 @@
+import type {
+	eFormTypeBase,
+	eFormTypeSimple,
+	eFormTypeComplex,
+} from "@open-xamu-co/ui-common-enums";
+
+import type {
+	iFormInput,
+	iFormInputDefault,
+	iFormValue,
+	tFormAutocomplete,
+	tFormIcon,
+} from "./types";
+import type { iSelectOption } from "../values.js";
+
+export declare abstract class tFormInputDefault<
+	T extends eFormTypeBase | eFormTypeSimple | eFormTypeComplex = eFormTypeSimple.TEXT,
+> implements iFormInputDefault<T>
+{
+	// public
+	public type: T;
+	// public readonly
+	public readonly required: boolean;
+	public readonly placeholder: string;
+	public readonly icon?: tFormIcon;
+	public readonly autocomplete?: tFormAutocomplete;
+
+	/** Rerender component */
+	public rerender(): void;
+
+	/** Set rerender function */
+	public setRerender(rerender: (fi?: Partial<iFormInputDefault<T>>) => void): this;
+}
+
+export declare class tFormInput<V extends iFormValue = iFormValue, Vk extends V | V[] = V | V[]>
+	extends tFormInputDefault<eFormTypeBase | eFormTypeSimple | eFormTypeComplex>
+	implements iFormInput<V, Vk>
+{
+	// public readonly
+	public readonly name: string;
+	public readonly title?: string;
+	public readonly multiple: boolean;
+	public readonly min: number;
+	public readonly max: number;
+	// public
+	public options: iSelectOption[];
+	public values: Vk[];
+	public defaults?: [iFormInputDefault, iFormInputDefault, ...iFormInputDefault[]];
+	/**
+	 * set rerender function
+	 *
+	 * @override
+	 */
+	public setRerender(rerender: (fi?: Partial<iFormInput<V>>) => void): this;
+	/**
+	 * add new model to the models
+	 */
+	public addValue(newValue?: Vk): this;
+	/**
+	 * remove the given value from the values
+	 */
+	public removeValue(index: number): this;
+
+	/**
+	 * Clone this object
+	 */
+	public clone(
+		overrides?: Omit<iFormInput<V, Vk>, "name"> & { name?: string },
+		onUpdatedValues?: (updatedValues: Vk[]) => Vk[] | undefined | void
+	): tFormInput<V, Vk>;
+	/**
+	 * Get simple object
+	 */
+	public getObject<Vi extends iFormValue = iFormValue, Vik extends Vi | Vi[] = Vi>(
+		input: iFormInput<Vi, Vik>
+	): iFormInput<Vi, Vik>;
+
+	public isEqual(other: tFormInput): boolean;
+}
+
+export interface iForm {
+	/**
+	 * Optional form key
+	 */
+	key?: string;
+	title?: string;
+	inputs: tFormInput[];
+	listen?: boolean;
+	/** Make all inputs read only by disabling them */
+	readonly?: boolean;
+	/** Message when no valid inputs are rendered */
+	emptyMessage?: string;
+}

package/src/form/index.ts

@@ -0,0 +1,2 @@
+export * from "./class";
+export * from "./types";

package/src/{form.ts → form/types.ts}

@@ -2,7 +2,7 @@ import type { IconName } from "@fortawesome/fontawesome-common-types";
 
 import { eFormTypeBase, eFormTypeComplex, eFormTypeSimple } from "@open-xamu-co/ui-common-enums";
 
-import type { iSelectOption } from "./values.js";
+import type { iSelectOption } from "../values.js";
 
 export interface iFormOption extends iSelectOption {
 	/**
@@ -101,10 +101,10 @@ export type iFormValue = string | number | boolean | File | Date;
  * Simple input
  */
 export interface iFormInputDefault<
-	T extends eFormTypeBase | eFormTypeSimple | eFormTypeComplex = eFormTypeSimple,
+	T extends eFormTypeBase | eFormTypeSimple | eFormTypeComplex = eFormTypeSimple.TEXT,
 > {
-	required?: boolean;
 	type?: T;
+	required?: boolean;
 	/**
 	 * String without the dots
 	 */

package/src/index.ts

@@ -1,5 +1,5 @@
 export * from "./files.js";
-export * from "./form.js";
+export * from "./form/index.js";
 export * from "./transform.js";
 export * from "./styles.js";
 export * from "./props.js";