@open-xamu-co/ui-common-types 3.1.0-next.3 → 3.1.0-next.5

package/package.json

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

package/src/locale.ts

@@ -246,30 +246,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;
 	};
 };
 

package/src/plugin.ts

@@ -146,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,18 +55,28 @@ 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;
 	/**