@open-xamu-co/ui-common-types 4.0.0-next.5 → 4.0.0-next.7

package/package.json

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

package/src/fetch.ts

@@ -65,5 +65,6 @@ export interface iPagination {
 }
 
 export type iGetPage<T, C extends string | number = string> = (
-	params?: iPagination
+	params?: iPagination,
+	signal?: AbortSignal
 ) => Promise<iPage<T, C> | undefined>;

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

@@ -113,15 +113,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 +203,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/values.ts

@@ -11,11 +11,10 @@ export interface iSelectOption {
  *
  * Action result, event and callback
  */
-export type iNodeFnResponse<T extends Record<string, any> = never> = [
-	(boolean | T)?,
-	Event?,
-	(() => void)?,
-];
+export type iNodeFnResponse<
+	T extends Record<string, any> = never,
+	E extends Record<string, any> = Record<string, any>,
+> = [(boolean | T)?, (Event & Partial<CustomEvent<E>>)?, (() => void)?];
 
 /**
  * Stream like response from node functions
@@ -23,9 +22,12 @@ export type iNodeFnResponse<T extends Record<string, any> = never> = [
  * Action result, event and callback
  * Can accept an stream like array for multiple updates (hydration)
  */
-export type iNodeFnResponseStream<T extends Record<string, any> = never> = [
+export type iNodeFnResponseStream<
+	T extends Record<string, any> = never,
+	E extends Record<string, any> = Record<string, any>,
+> = [
 	(boolean | T | [boolean | T, ...Promise<boolean | T>[]])?,
-	Event?,
+	(Event & Partial<CustomEvent<E>>)?,
 	(() => void)?,
 ];