@open-xamu-co/ui-common-types 4.0.0-next.1 → 4.0.0-next.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xamu-co/ui-common-types",
-  "version": "4.0.0-next.1",
+  "version": "4.0.0-next.3",
   "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": "^3.1.0-next.1",
+    "@open-xamu-co/ui-common-enums": "^4.0.0-next.1",
     "@fortawesome/fontawesome-common-types": "^6.4.0",
     "sweetalert2": "^11.11.1"
   },

package/src/fetch.ts

@@ -3,28 +3,44 @@ export type tOrder = "desc" | "asc";
 /**
  * Order using column or property
  *
- * @example [["id", "asc" ]], order ascendente de id
- * @example [["id", "desc" ]] or [["id"]], order descendente de id
+ * @example ["id", "asc" ], order ascendente de id
+ * @example ["id", "desc" ] or ["id"], order descendente de id
  */
 export type tOrderBy = [string, tOrder?];
 
 export interface iPageEdge<T, C extends string | number = string> {
 	cursor: C;
+	/** Node data */
 	node: T;
 }
 
 export interface iPageInfo<C extends string | number = string> {
 	nextCursor?: C;
 	previousCursor?: C;
+	/**
+	 * Current page number
+	 * According to the "at" and "first" parameters
+	 */
 	pageNumber?: number;
+	/** There is a next page */
 	hasNextPage: boolean;
+	/** There is a previous page */
 	hasPreviousPage: boolean;
+	/** Current page path */
 	path?: string;
 }
 
 export interface iPage<T, C extends string | number = string> {
+	/**
+	 * List of nodes with cursor data for the current page
+	 * Amount of nodes is limited by the "first" parameter
+	 */
 	edges: iPageEdge<T, C>[];
 	pageInfo: iPageInfo<C>;
+	/**
+	 * Count of nodes matching the path
+	 * Independent of pagination
+	 */
 	totalCount: number;
 }
 
@@ -39,6 +55,12 @@ export interface iPagination {
 	 * Cantidad de elementos por pagina (limite)
 	 */
 	first?: number;
+	/**
+	 * Order using column or property
+	 *
+	 * @example [["id", "asc" ]], order ascendente de id
+	 * @example [["id", "desc" ]] or [["id"]], order descendente de id
+	 */
 	orderBy?: tOrderBy[];
 }
 

package/src/files.ts

@@ -1,5 +1,8 @@
+import type { eMimeType } from "@open-xamu-co/ui-common-enums";
+
 export interface iMime {
 	mime: string;
 	pattern: number[];
 	mask: number[];
+	type: eMimeType;
 }

package/src/locale.ts

@@ -109,10 +109,14 @@ export type tLocaleInput = {
 		file_limit: string;
 		/** @example "This field only allows {amount} file | This field only allows {amount} files" */
 		file_limit_text: string;
+		/** @example "Unsupported format" */
+		file_unsupported_format: string;
+		/** @example "This field only does not allow that file type" */
+		file_unsupported_format_text: string;
 		/** @example "Wrong format" */
-		file_wrong_format_image: string;
-		/** @example "This field only allows image files" */
-		file_wrong_format_image_text: string;
+		file_wrong_format: string;
+		/** @example "This field only allows "{types}" files" */
+		file_wrong_format_text: string;
 		/** @example "File too big" */
 		file_too_big: string;
 		/** @example "The file exceeds the allowed size" */

package/src/values.ts

@@ -17,6 +17,18 @@ export type iNodeFnResponse<T extends Record<string, any> = never> = [
 	(() => void)?,
 ];
 
+/**
+ * Stream like response from node functions
+ *
+ * Action result, event and callback
+ * Can accept an stream like array for multiple updates (hydration)
+ */
+export type iNodeFnResponseStream<T extends Record<string, any> = never> = [
+	(boolean | T | [boolean | T, ...Promise<boolean | T>[]])?,
+	Event?,
+	(() => void)?,
+];
+
 /**
  * Funtions that uses a node and perform some action
  *
@@ -30,6 +42,23 @@ export type iNodeFn<T extends Record<string, any>, Ta extends [T?, ...any[]] = [
 	...args: Ta
 ) => boolean | undefined | iNodeFnResponse<T> | Promise<boolean | undefined | iNodeFnResponse<T>>;
 
+/**
+ * Funtions that uses a node and perform some action
+ *
+ * Useful for table actions like creating, updating and deleting nodes
+ *
+ * Undefined would mean no action was performed
+ * True or an T type object would mean action was performed successfully
+ * False would mean action failed
+ */
+export type iNodeStreamFn<T extends Record<string, any>, Ta extends [T?, ...any[]] = [T]> = (
+	...args: Ta
+) =>
+	| boolean
+	| undefined
+	| iNodeFnResponseStream<T>
+	| Promise<boolean | undefined | iNodeFnResponseStream<T>>;
+
 /**
  * Used on Table and related components
  *
@@ -88,4 +117,7 @@ export interface iProperty<
 	onImageError?: (data?: any) => void;
 }
 
+/**
+ * Function to order properties
+ */
 export type tPropertyOrderFn = (a: [string, any], b: [string, any]) => -1 | 0 | 1;