@open-xamu-co/ui-common-types 3.0.0-next.8 → 3.0.0

package/package.json

@@ -1,45 +1,45 @@
 {
-  "name": "@open-xamu-co/ui-common-types",
-  "version": "3.0.0-next.8",
-  "description": "Xamu shared types",
   "author": "@xamu-co",
-  "main": "src/index.ts",
-  "types": "src/index.ts",
-  "type": "module",
+  "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"
+  },
+  "description": "Xamu shared types",
+  "engines": {
+    "node": ">=18",
+    "yarn": ">=1.22.4"
+  },
   "files": [
     "src/*"
   ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/xamu-co/ui.git"
-  },
+  "homepage": "https://github.com/xamu-co/ui#readme",
   "keywords": [
     "ts",
     "js",
     "types"
   ],
   "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/xamu-co/ui/issues"
-  },
-  "homepage": "https://github.com/xamu-co/ui#readme",
+  "main": "src/index.ts",
+  "name": "@open-xamu-co/ui-common-types",
   "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"
   },
-  "dependencies": {
-    "@fortawesome/fontawesome-common-types": "^6.4.0",
-    "@open-xamu-co/ui-common-enums": "^3.0.0-next.1",
-    "sweetalert2": "^11.7.5"
-  },
-  "engines": {
-    "node": ">=18",
-    "yarn": ">=1.22.4"
-  },
-  "browserslist": [
-    "defaults"
-  ]
+  "type": "module",
+  "types": "src/index.ts",
+  "version": "3.0.0"
 }

package/src/fetch.ts

@@ -1,4 +1,12 @@
-export type tOrderBy = [string, ("desc" | "asc")?];
+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
+ */
+export type tOrderBy = [string, tOrder?];
 
 export interface iPageEdge<T, C extends string | number = string> {
 	cursor: C;
@@ -19,7 +27,7 @@ export interface iPage<T, C extends string | number = string> {
 	totalCount: number;
 }
 
-export interface iPagination<O = tOrderBy> {
+export interface iPagination {
 	/**
 	 * Identificador del elemento donde empieza la paginacion
 	 *
@@ -30,19 +38,9 @@ export interface iPagination<O = tOrderBy> {
 	 * Cantidad de elementos (limite)
 	 */
 	first?: number;
-	/**
-	 * Ordenar segun columna o propiedad
-	 * ej: ["id", "asc" ], order ascendente de id
-	 * ej: ["id", "desc" ], order descendente de id
-	 */
-	orderBy?: O;
+	orderBy?: tOrderBy[];
 }
 
-/**
- * Hydrate fetch ref (no refresh)
- */
-export type tHydrate<T> = (c: T, e?: unknown) => void;
-
 export type iGetPage<T, C extends string | number = string> = (
 	params?: iPagination
-) => Promise<iPage<T, C>>;
+) => Promise<iPage<T, C> | undefined>;

package/src/form/class.ts

@@ -0,0 +1,93 @@
+import type {
+	eFormTypeBase,
+	eFormTypeSimple,
+	eFormTypeComplex,
+} from "@open-xamu-co/ui-common-enums";
+
+import type {
+	iFormInput,
+	iFormInputDefault,
+	iFormValue,
+	tFormAutocomplete,
+	tFormIcon,
+} from "./types";
+import type { iSelectOption } from "../values.js";
+
+export declare abstract class tFormInputDefault<
+	T extends eFormTypeBase | eFormTypeSimple | eFormTypeComplex = eFormTypeSimple.TEXT,
+> implements iFormInputDefault<T>
+{
+	// public
+	public type: T;
+	// public readonly
+	public readonly required: boolean;
+	public readonly placeholder: string;
+	public readonly icon?: tFormIcon;
+	public readonly autocomplete?: tFormAutocomplete;
+
+	/** Rerender component */
+	public rerender(): void;
+
+	/** Set rerender function */
+	public setRerender(rerender: (fi?: Partial<iFormInputDefault<T>>) => void): this;
+}
+
+export declare class tFormInput<V extends iFormValue = iFormValue, Vk extends V | V[] = V | V[]>
+	extends tFormInputDefault<eFormTypeBase | eFormTypeSimple | eFormTypeComplex>
+	implements iFormInput<V, Vk>
+{
+	// public readonly
+	public readonly name: string;
+	public readonly title?: string;
+	public readonly multiple: boolean;
+	public readonly min: number;
+	public readonly max: number;
+	// public
+	public options: iSelectOption[];
+	public values: Vk[];
+	public defaults?: [iFormInputDefault, iFormInputDefault, ...iFormInputDefault[]];
+	/**
+	 * set rerender function
+	 *
+	 * @override
+	 */
+	public setRerender(rerender: (fi?: Partial<iFormInput<V>>) => void): this;
+	/**
+	 * add new model to the models
+	 */
+	public addValue(newValue?: Vk): this;
+	/**
+	 * remove the given value from the values
+	 */
+	public removeValue(index: number): this;
+
+	/**
+	 * Clone this object
+	 */
+	public clone(
+		overrides?: Omit<iFormInput<V, Vk>, "name"> & { name?: string },
+		onUpdatedValues?: (updatedValues: Vk[]) => Vk[] | undefined | void
+	): tFormInput<V, Vk>;
+	/**
+	 * Get simple object
+	 */
+	public getObject<Vi extends iFormValue = iFormValue, Vik extends Vi | Vi[] = Vi>(
+		input: iFormInput<Vi, Vik>
+	): iFormInput<Vi, Vik>;
+
+	public isEqual(other: tFormInput): boolean;
+}
+
+export interface iForm {
+	/**
+	 * Optional form key
+	 */
+	key?: string;
+	title?: string;
+	inputs: tFormInput[];
+	listen?: boolean;
+	/** Make all inputs read only by disabling them */
+	readonly?: boolean;
+	/** Message when no valid inputs are rendered */
+	emptyMessage?: string;
+}

package/src/form/index.ts

@@ -0,0 +1,2 @@
+export * from "./class";
+export * from "./types";

package/src/{form.ts → form/types.ts}

@@ -1,8 +1,8 @@
 import type { IconName } from "@fortawesome/fontawesome-common-types";
 
-import { eFormTypeComplex, eFormTypeSimple } from "@open-xamu-co/ui-common-enums";
+import { eFormTypeBase, eFormTypeComplex, eFormTypeSimple } from "@open-xamu-co/ui-common-enums";
 
-import type { iSelectOption } from "./values.js";
+import type { iSelectOption } from "../values.js";
 
 export interface iFormOption extends iSelectOption {
 	/**
@@ -95,43 +95,37 @@ export type iFormIconProps = { brand?: boolean; regular?: boolean };
 
 export type tFormIcon = [IconName | undefined, iFormIconProps];
 
-export type iFormValue = string | number | boolean | File;
+export type iFormValue = string | number | boolean | File | Date;
 
 /**
  * Simple input
  */
-export interface iFormInputDefault<T extends eFormTypeSimple | eFormTypeComplex = eFormTypeSimple> {
-	required?: boolean;
+export interface iFormInputDefault<
+	T extends eFormTypeBase | eFormTypeSimple | eFormTypeComplex = eFormTypeSimple.TEXT,
+> {
 	type?: T;
-	options?: (string | number | iFormOption)[];
+	required?: boolean;
 	/**
 	 * String without the dots
 	 */
 	placeholder?: string;
 	icon?: IconName | tFormIcon;
 	autocomplete?: tFormAutocomplete;
-	/**
-	 * if muliple is set to true this optional value would be the required minimun amount of values
-	 */
-	min?: number;
-	/**
-	 * if multiple is set to true this optional value would be the mandatory maximun amount of values
-	 */
-	max?: number;
 }
 
 /**
  * Complex input, sub input support
  */
-export interface iFormInput<V extends iFormValue = iFormValue>
-	extends iFormInputDefault<eFormTypeSimple | eFormTypeComplex> {
+export interface iFormInput<V extends iFormValue = iFormValue, Vk extends V | V[] = V | V[]>
+	extends iFormInputDefault<eFormTypeBase | eFormTypeSimple | eFormTypeComplex> {
 	name: string;
+	options?: (string | number | iFormOption)[];
 	/**
 	 * An array of values to simplify validation
 	 *
 	 * @old value
 	 */
-	values?: (V | V[])[];
+	values?: Vk[];
 	defaults?: [iFormInputDefault, iFormInputDefault, ...iFormInputDefault[]];
 	/**
 	 * Visible over the field, should describe it
@@ -144,12 +138,20 @@ export interface iFormInput<V extends iFormValue = iFormValue>
 	 * Ex: { multiple: true, min:3, max:3 } would make 3 values a requirement
 	 */
 	multiple?: boolean;
+	/**
+	 * if muliple is set to true this optional value would be the required minimun amount of values
+	 */
+	min?: number;
+	/**
+	 * if multiple is set to true this optional value would be the mandatory maximun amount of values
+	 */
+	max?: number;
 }
 
 /**
  * Sended form values
  */
-export interface iFormResponse<R = any, T = any> {
+export interface iFormResponse<R = any> {
 	response?: R;
 	invalidInputs: iInvalidInput[];
 	/**
@@ -169,12 +171,6 @@ export interface iFormResponse<R = any, T = any> {
 	 * 401 will be reported but not failed
 	 */
 	errors?: any;
-	/**
-	 * Swal target
-	 *
-	 * If the swal was triggered from a modal, then use it as render target
-	 */
-	modalTarget?: T;
 }
 
 export interface iFetchResponse<R = any> {

package/src/index.ts

@@ -1,5 +1,5 @@
 export * from "./files.js";
-export * from "./form.js";
+export * from "./form/index.js";
 export * from "./transform.js";
 export * from "./styles.js";
 export * from "./props.js";

package/src/locale.ts

@@ -53,7 +53,11 @@ export type tLocaleBase = {
 		cancel: string;
 		/** @example "Continue" */
 		continue: string;
-		/** @example "¡Connection error!" */
+		/** @example "Error!" */
+		error: string;
+		/** @example "Something went wrong!" */
+		error_message: string;
+		/** @example "Connection error!" */
 		connection_error: string;
 		/** @example "The server is not responding. Please check your network or try again later" */
 		connection_error_message: string;
@@ -188,6 +192,10 @@ export type tLocaleForm = {
 	form_unmatching_passwords: string;
 	/** @example "Invalid data" */
 	form_invalid_data: string;
+	/** @example "No values" */
+	form_no_values: string;
+	/** @example "New value" */
+	form_new_value: string;
 	// swal: {};
 };
 
@@ -201,8 +209,12 @@ export type tLocaleTable = {
 	table_see_values: string;
 	/** @example "See: \"{name}\"" */
 	table_see_name: string;
+	/** @example "Hide: \"{name}\"" */
+	table_hide_name: string;
 	/** @example "Create new" */
 	table_create_new: string;
+	/** @example "Crear nuevo" */
+	table_create_new_name: string;
 	/** @example "Quantity: {count} */
 	table_quantity: string;
 	/** @example "Modify" */
@@ -271,22 +283,6 @@ export type tLocalePagination = {
 	pagination_items: string;
 	/** @example "No pages | Single page | {count} pages" */
 	pagination_pages: string;
-	/** @example "Order: relevance" */
-	pagination_order_relevance: string;
-	/** @example "Order: more recent" */
-	pagination_order_recent: string;
-	/** @example "Order: more older" */
-	pagination_order_older: string;
-	/** @example "Order: lower price" */
-	pagination_order_expensive: string;
-	/** @example "Order: high price" */
-	pagination_order_cheaper: string;
-	/** @example "Order: alphabetically (Asc.)" */
-	pagination_order_az: string;
-	/** @example "Order: alphabetically (Desc.)" */
-	pagination_order_za: string;
-	/** @example "Filter by:" */
-	pagination_filter_by: string;
 	// swal: {};
 };
 

package/src/plugin.ts

@@ -4,6 +4,7 @@ import type { tPluginLocale } from "./locale.js";
 import type { SweetAlertOptions } from "sweetalert2";
 
 export type tComponent = (typeof componentNames)[number];
+export type tLogger = (at: string, ...logs: unknown[]) => any;
 
 export type tSupportedLangs =
 	| "kr"
@@ -98,6 +99,7 @@ export interface iPluginOptions<ComponentType = unknown> {
 		overrides?: SweetAlertOptions;
 		preventOverrides?: SweetAlertOptions;
 		loaderOverrides?: SweetAlertOptions;
+		toastOverrides?: SweetAlertOptions;
 	};
 	/**
 	 * Iso2 code for the default country
@@ -106,13 +108,11 @@ export interface iPluginOptions<ComponentType = unknown> {
 	 */
 	country?: string;
 	/**
-	 * Countries API base endpoint
+	 * Countries API base endpoint (full URL)
 	 *
 	 * If using nuxt, get better performance with the module
 	 * @see https://www.npmjs.com/package/nuxt-countries-api
 	 *
-	 * Using an absolute path will enable the module
-	 *
 	 * @default "https://countries.xamu.com.co/api/v1"
 	 */
 	countriesUrl?: string;
@@ -134,4 +134,10 @@ export interface iPluginOptions<ComponentType = unknown> {
 	 * @default 10
 	 */
 	first?: number;
+	/**
+	 * Logger function for debugging purposes
+	 *
+	 * @default console.log
+	 */
+	logger?: tLogger;
 }

package/src/swal.ts

@@ -1,15 +1,22 @@
 import DefaultSwal, { type SweetAlertOptions, type SweetAlertResult } from "sweetalert2";
 
+export type tSwalOptions = Omit<SweetAlertOptions, "target"> & {
+	target?: SweetAlertOptions["target"] | Event;
+};
+
 /**
  * Extended SweetAlert2 class
  *
+ * Defaults should use Event as target
+ *
  * Do not deestructure this
  */
-export type tSwal = typeof DefaultSwal & {
-	firePrevent: <T = unknown>(
-		options?: SweetAlertOptions
-	) => Promise<SweetAlertResult<Awaited<T>>>;
+export type tSwal = Omit<typeof DefaultSwal, "fire"> & {
+	fire: <T = any>(options?: tSwalOptions) => Promise<SweetAlertResult<Awaited<T>>>;
+	firePrevent: <T = any>(options?: tSwalOptions) => Promise<SweetAlertResult<Awaited<T>>>;
+	fireLoader: <T = any>(options?: tSwalOptions) => Promise<SweetAlertResult<Awaited<T>>>;
+	fireToast: <T = any>(options?: tSwalOptions) => Promise<SweetAlertResult<Awaited<T>>>;
 	firePreventDefaults: SweetAlertOptions;
-	fireLoader: <T = unknown>(options?: SweetAlertOptions) => Promise<SweetAlertResult<Awaited<T>>>;
 	fireLoaderDefaults: SweetAlertOptions;
+	fireToastDefaults: SweetAlertOptions;
 };

package/src/values.ts

@@ -2,24 +2,54 @@ export interface iSelectOption {
 	value: string | number;
 	alias?: string;
 	selected?: boolean;
+	disabled?: boolean;
+	hidden?: boolean;
 }
 
+export type iNodeFnResponse = [boolean?, Event?, (() => void)?];
+
 /**
  * Funtions that uses a node and perform some action
  *
  * Useful for table actions like creating, updating and deleting nodes
  */
-export type iNodeFn<T extends Record<string, any>> = (
-	n: T
-) => boolean | undefined | Promise<boolean | undefined>;
+export type iNodeFn<T extends Record<string, any>, Ta extends [T?, ...any[]] = [T]> = (
+	...args: Ta
+) => boolean | undefined | iNodeFnResponse | Promise<boolean | undefined | iNodeFnResponse>;
 
 /**
  * used on FactoryTable and related components
  */
-export interface iProperty<T extends Record<string, any> = Record<string, any>>
-	extends iSelectOption {
+export interface iProperty<
+	T extends Record<string, any> = Record<string, any>,
+	P extends Record<string, any> = Record<string, any>,
+	ComponentType = unknown,
+> extends iSelectOption {
 	/**
 	 * Function to create a node within the relation
+	 * The parent is given since the node doesn't exist yet
+	 */
+	createNode?: iNodeFn<P, [P?]>;
+	/**
+	 * Conditionally disable creating children for this particular property
+	 */
+	disableCreateNode?: (p: P) => boolean;
+	/**
+	 * Function to clone a node within the relation
+	 */
+	cloneNode?: iNodeFn<T, [T?]>;
+	/**
+	 * Function to update a node within the relation
+	 */
+	updateNode?: iNodeFn<T, [T?, P?]>;
+	/**
+	 * Function to delete a node within the relation
 	 */
-	createNode?: (n?: T) => boolean | undefined | Promise<boolean | undefined>;
+	deleteNode?: iNodeFn<T, [T?]>;
+	/**
+	 * Render using this component instead
+	 */
+	component?: ComponentType;
 }
+
+export type tPropertyOrderFn = (a: [string, any], b: [string, any]) => -1 | 0 | 1;