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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xamu-co/ui-common-types",
-  "version": "4.0.0-next.4",
+  "version": "4.0.0-next.6",
   "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/files.ts

@@ -1,8 +1,24 @@
 import type { eMimeType } from "@open-xamu-co/ui-common-enums";
 
 export interface iMime {
+	/**
+	 * Mime type
+	 * @example image/jpeg
+	 */
 	mime: string;
+	/**
+	 * Pattern to match
+	 * @example [0xff, 0xd8, 0xff]
+	 */
 	pattern: number[];
+	/**
+	 * Mask to match
+	 * @example [0xff, 0xff, 0xff]
+	 */
 	mask: number[];
+	/**
+	 * Mime type range
+	 * @example eMimeType.IMAGE
+	 */
 	type: eMimeType;
 }

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)?,
 ];
 
@@ -70,6 +72,11 @@ export interface iProperty<
 	P extends Record<string, any> = Record<string, any>,
 	ComponentType = unknown,
 > extends iSelectOption {
+	/**
+	 * Prefer to use the node's id instead of the value
+	 * Useful for object like properties
+	 */
+	preferId?: boolean;
 	/**
 	 * Function to create a node within the relation
 	 * The parent is given since the node doesn't exist yet