@open-xamu-co/ui-common-types 3.0.2-next.1 → 3.1.0-next.10

package/package.json

@@ -1,45 +1,45 @@
 {
-  "author": "@xamu-co",
-  "browserslist": [
-    "defaults"
-  ],
-  "bugs": {
-    "url": "https://github.com/xamu-co/ui/issues"
-  },
-  "dependencies": {
-    "@fortawesome/fontawesome-common-types": "^6.4.0",
-    "@open-xamu-co/ui-common-enums": "^3.0.0",
-    "sweetalert2": "^11.11.1"
-  },
+  "name": "@open-xamu-co/ui-common-types",
+  "version": "3.1.0-next.10",
   "description": "Xamu shared types",
-  "engines": {
-    "node": ">=18",
-    "yarn": ">=1.22.4"
-  },
+  "author": "@xamu-co",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "type": "module",
   "files": [
     "src/*"
   ],
-  "homepage": "https://github.com/xamu-co/ui#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/xamu-co/ui.git"
+  },
   "keywords": [
     "ts",
     "js",
     "types"
   ],
   "license": "MIT",
-  "main": "src/index.ts",
-  "name": "@open-xamu-co/ui-common-types",
+  "bugs": {
+    "url": "https://github.com/xamu-co/ui/issues"
+  },
+  "homepage": "https://github.com/xamu-co/ui#readme",
   "publishConfig": {
     "access": "public"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/xamu-co/ui.git"
-  },
   "scripts": {
     "build": "node -e \"console.log('Build step not required')\"",
     "build:legacy": "rimraf dist && tsc --outDir dist --declaration --emitDeclarationOnly"
   },
-  "type": "module",
-  "types": "src/index.ts",
-  "version": "3.0.2-next.1"
+  "dependencies": {
+    "@open-xamu-co/ui-common-enums": "^3.1.0-next.1",
+    "@fortawesome/fontawesome-common-types": "^6.4.0",
+    "sweetalert2": "^11.11.1"
+  },
+  "engines": {
+    "node": ">=20.19.3",
+    "yarn": ">=1.22.4"
+  },
+  "browserslist": [
+    "defaults"
+  ]
 }

package/src/fetch.ts

@@ -16,6 +16,7 @@ export interface iPageEdge<T, C extends string | number = string> {
 export interface iPageInfo<C extends string | number = string> {
 	nextCursor?: C;
 	previousCursor?: C;
+	pageNumber?: number;
 	hasNextPage: boolean;
 	hasPreviousPage: boolean;
 	path?: string;
@@ -35,7 +36,7 @@ export interface iPagination {
 	 */
 	at?: string | number;
 	/**
-	 * Cantidad de elementos (limite)
+	 * Cantidad de elementos por pagina (limite)
 	 */
 	first?: number;
 	orderBy?: tOrderBy[];

package/src/form/class.ts

@@ -75,7 +75,9 @@ export declare class tFormInput<
 	 */
 	public clone(
 		overrides?: Omit<iFormInput<V, T>, "name"> & { name?: string },
-		onUpdatedValues?: (updatedValues: V[]) => V[] | undefined | void
+		onUpdatedValues?: (
+			updatedValues: V[]
+		) => V[] | undefined | void | Promise<V[] | undefined | void>
 	): tFormInput<V, T>;
 	/**
 	 * Check if this object is equal to another

package/src/locale.ts

@@ -152,6 +152,8 @@ export type tLocaleForm = {
 	form_requires_n_values: string;
 	/** @example "Loading countries..." */
 	form_loading_countries: string;
+	/** @example "Awaiting countries data..." */
+	form_awaiting_countries: string;
 	/** @example "Look for country" */
 	form_country: string;
 	/** @example "Look for state" */
@@ -246,30 +248,46 @@ export type tLocaleTable = {
 	/** @example "Show all" */
 	table_show_all: string;
 	swal: {
-		/** @example "Are you sure you want to delete this element?" */
+		/** @example "Are you sure you want to delete this item?" */
 		table_delete_node_title: string;
-		/** @example "Remember that you wont be able to recover this element data and you will lost all of your work" */
+		/** @example "Remember that you wont be able to recover this item data and you will lost all of your work" */
 		table_delete_node_disclaimer: string;
 		/** @example "Successfull deletion" */
 		table_deleted: string;
-		/** @example "Are you sure you want to delete this element? | Are you sure you want to delete these {count} elements?" */
+		/** @example "The item was deleted, the list will refresh automatically" */
+		table_deleted_text: string;
+		/** @example "Are you sure you want to delete this item? | Are you sure you want to delete these {count} items?" */
 		table_delete_nodes_title: string;
-		/** @example "Remember that you wont be able to recover these elements data and you will lost all of your work" */
+		/** @example "Remember that you wont be able to recover these items data and you will lost all of your work" */
 		table_delete_nodes_disclaimer: string;
-		/** @example "The item may not have been deleted | The items may not have been deleted" */
+		/** @example "Deletion went wrong" */
 		table_possibly_not_deleted: string;
+		/** @example "The item may not have been deleted | The items may not have been deleted" */
+		table_possibly_not_deleted_text: string;
 		/** @example "Successfull update" */
 		table_updated: string;
-		/** @example "The item may not have been updated | The items may not have been updated" */
+		/** @example "The item was updated, the list will refresh automatically" */
+		table_updated_text: string;
+		/** @example "Update went wrong" */
 		table_possibly_not_updated: string;
-		/** @example "Successfull update" */
+		/** @example "The item may not have been updated | The items may not have been updated" */
+		table_possibly_not_updated_text: string;
+		/** @example "Successfull creation" */
 		table_created: string;
-		/** @example "The item may not have been created | The items may not have been created" */
+		/** @example "The item was created, you can already find it in the list" */
+		table_created_text: string;
+		/** @example "Creation went wrong" */
 		table_possibly_not_created: string;
-		/** @example "Successfull cloning" */
+		/** @example "The item may not have been created | The items may not have been created" */
+		table_possibly_not_created_text: string;
+		/** @example "Successfull clonation" */
 		table_cloned: string;
-		/** @example "The item may not have been cloned | The items may not have been cloned" */
+		/** @example "The item was cloned, you can already find it in the list" */
+		table_cloned_text: string;
+		/** @example "Clonation went wrong" */
 		table_possibly_not_cloned: string;
+		/** @example "The item may not have been cloned | The items may not have been cloned" */
+		table_possibly_not_cloned_text: string;
 	};
 };
 
@@ -283,6 +301,8 @@ export type tLocalePagination = {
 	pagination_items: string;
 	/** @example "No pages | Single page | {count} pages" */
 	pagination_pages: string;
+	/** @example "Page {count} of" */
+	pagination_page: string;
 	// swal: {};
 };
 

package/src/plugin.ts

@@ -51,6 +51,10 @@ export interface iPluginOptions<ComponentType = unknown> {
 	 * Optional image optimization component
 	 */
 	imageComponent?: ComponentType | string;
+	/**
+	 * Url to an image to be used as placeholder for images that failed to load
+	 */
+	imagePlaceholder?: string;
 	/**
 	 * Host that contain images
 	 * Treat the url within them as images
@@ -142,4 +146,11 @@ export interface iPluginOptions<ComponentType = unknown> {
 	 * @default console.log
 	 */
 	logger?: tLogger;
+	/**
+	 * Function used to encode the pagination cursor
+	 *
+	 * @default node.id
+	 */
+	cursorEncoder?: (<T>(node: T) => string) | (<T>(node: T) => number);
+	internals?: Record<string, any>;
 }

package/src/values.ts

@@ -6,19 +6,35 @@ export interface iSelectOption {
 	hidden?: boolean;
 }
 
-export type iNodeFnResponse = [boolean?, Event?, (() => void)?];
+/**
+ * Response from node functions
+ *
+ * Action result, event and callback
+ */
+export type iNodeFnResponse<T extends Record<string, any> = never> = [
+	(boolean | T)?,
+	Event?,
+	(() => void)?,
+];
 
 /**
  * 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 iNodeFn<T extends Record<string, any>, Ta extends [T?, ...any[]] = [T]> = (
 	...args: Ta
-) => boolean | undefined | iNodeFnResponse | Promise<boolean | undefined | iNodeFnResponse>;
+) => boolean | undefined | iNodeFnResponse<T> | Promise<boolean | undefined | iNodeFnResponse<T>>;
 
 /**
- * used on FactoryTable and related components
+ * Used on Table and related components
+ *
+ * @action Any task performed at each row cell (property)
+ * @nested Any task performed at a relation table within a modal
  */
 export interface iProperty<
 	T extends Record<string, any> = Record<string, any>,
@@ -28,6 +44,9 @@ export interface iProperty<
 	/**
 	 * Function to create a node within the relation
 	 * The parent is given since the node doesn't exist yet
+	 *
+	 * @action Showcases an button to create a new node/value within this property/relation
+	 * @nested Passed down to the related table if any
 	 */
 	createNode?: iNodeFn<P, [P?]>;
 	/**
@@ -36,20 +55,37 @@ export interface iProperty<
 	disableCreateNode?: (p: P) => boolean;
 	/**
 	 * Function to clone a node within the relation
+	 * Set to false to omit cloning this property/relation
+	 *
+	 * @action No inline action
+	 * @nested Passed down to the related table if any
 	 */
-	cloneNode?: iNodeFn<T, [T?]>;
+	cloneNode?: iNodeFn<T, [T?]> | false;
 	/**
 	 * Function to update a node within the relation
+	 *
+	 * @action Showcases an button to update this node/value within this property/relation
+	 * @nested Passed down to the related table if any
 	 */
 	updateNode?: iNodeFn<T, [T?, P?]>;
 	/**
 	 * Function to delete a node within the relation
+	 *
+	 * @action No inline action
+	 * @nested Passed down to the related table if any
 	 */
 	deleteNode?: iNodeFn<T, [T?]>;
 	/**
-	 * Render using this component instead
+	 * Render row cell (property) using this component instead
 	 */
 	component?: ComponentType;
+	/**
+	 * Url to an image to be used as placeholder for images that failed to load
+	 * Overrides the plugin's imagePlaceholder
+	 */
+	imagePlaceholder?: string;
+	/** Event to handle image load errors */
+	onImageError?: (data?: any) => void;
 }
 
 export type tPropertyOrderFn = (a: [string, any], b: [string, any]) => -1 | 0 | 1;