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

package/package.json

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

package/src/fetch.ts

@@ -1,3 +1,5 @@
+import type { eOrders } from "@open-xamu-co/ui-common-enums";
+
 export type tOrderBy = [string, ("desc" | "asc")?];
 
 export interface iPageEdge<T, C extends string | number = string> {
@@ -5,19 +7,21 @@ export interface iPageEdge<T, C extends string | number = string> {
 	node: T;
 }
 
+export interface iPageInfo<C extends string | number = string> {
+	nextCursor?: C;
+	previousCursor?: C;
+	hasNextPage: boolean;
+	hasPreviousPage: boolean;
+	path?: string;
+}
+
 export interface iPage<T, C extends string | number = string> {
 	edges: iPageEdge<T, C>[];
-	pageInfo: {
-		nextCursor?: C;
-		previousCursor?: C;
-		hasNextPage: boolean;
-		hasPreviousPage: boolean;
-		path?: string;
-	};
+	pageInfo: iPageInfo<C>;
 	totalCount: number;
 }
 
-export interface iPagination {
+export interface iPagination<O extends tOrderBy | Record<string, eOrders> = tOrderBy> {
 	/**
 	 * Identificador del elemento donde empieza la paginacion
 	 *
@@ -34,7 +38,7 @@ export interface iPagination {
 	 * ej: ["id", "asc" ], order ascendente de id
 	 * ej: ["id", "desc" ], order descendente de id
 	 */
-	orderBy?: tOrderBy;
+	orderBy?: O;
 }
 
 /**

package/src/form.ts

@@ -2,10 +2,9 @@ import type { IconName } from "@fortawesome/fontawesome-common-types";
 
 import { eFormTypeComplex, eFormTypeSimple } from "@open-xamu-co/ui-common-enums";
 
-export interface iSelectOption {
-	value: string | number;
-	alias?: string;
-	selected?: boolean;
+import type { iSelectOption } from "./values.js";
+
+export interface iFormOption extends iSelectOption {
 	/**
 	 * Font awesome icon
 	 */
@@ -17,7 +16,7 @@ export interface iSelectOption {
 	placeholder?: string;
 }
 
-export interface iIndicative extends iSelectOption {
+export interface iIndicative extends iFormOption {
 	code: string;
 	number: number;
 }
@@ -104,7 +103,7 @@ export type iFormValue = string | number | boolean | File;
 export interface iFormInputDefault<T extends eFormTypeSimple | eFormTypeComplex = eFormTypeSimple> {
 	required?: boolean;
 	type?: T;
-	options?: (string | number | iSelectOption)[];
+	options?: (string | number | iFormOption)[];
 	/**
 	 * String without the dots
 	 */
@@ -146,3 +145,42 @@ export interface iFormInput<V extends iFormValue = iFormValue>
 	 */
 	multiple?: boolean;
 }
+
+/**
+ * Sended form values
+ */
+export interface iFormResponse<R = any, T = any> {
+	response?: R;
+	invalidInputs: iInvalidInput[];
+	/**
+	 * If the request had any error (validation/request itself).
+	 */
+	withErrors: boolean;
+	/**
+	 * If the request had any error.
+	 */
+	requestHadErrors: boolean;
+	/**
+	 * If the validation had any error.
+	 */
+	validationHadErrors: boolean;
+	/**
+	 * Errors payload,
+	 * 401 will be reported but not failed
+	 */
+	errors?: any;
+	/**
+	 * Swal target
+	 */
+	modalTarget?: T;
+}
+
+export interface iFetchResponse<R = any> {
+	data?: R;
+	errors?: any;
+	[x: string]: any;
+}
+
+export type tResponseFn<T, V extends Record<string, any> = Record<string, any>> = (
+	values: V
+) => Promise<iFetchResponse<T>>;

package/src/index.ts

@@ -6,3 +6,5 @@ export * from "./props.js";
 export * from "./locale.js";
 export * from "./plugin.js";
 export * from "./fetch.js";
+export * from "./swal.js";
+export * from "./values.js";

package/src/locale.ts

@@ -238,6 +238,10 @@ export interface iLocaleTable {
 		table_updated: string;
 		/** @example "The item may not have been updated | The items may not have been updated" */
 		table_possibly_not_updated: string;
+		/** @example "Successfull update" */
+		table_created: string;
+		/** @example "The item may not have been created | The items may not have been created" */
+		table_possibly_not_created: string;
 		/** @example "Successfull cloning" */
 		table_cloned: string;
 		/** @example "The item may not have been cloned | The items may not have been cloned" */

package/src/plugin.ts

@@ -23,6 +23,8 @@ export type tSupportedLangs =
 export interface iPluginOptions<ComponentType = unknown> {
 	/**
 	 * Use web components
+	 *
+	 * @default false
 	 */
 	webComponents?: boolean;
 	/**
@@ -105,14 +107,20 @@ export interface iPluginOptions<ComponentType = unknown> {
 	country?: string;
 	/**
 	 * Disable automatic animations
+	 *
+	 * @default false
 	 */
 	disableAutoAnimate?: boolean;
 	/**
 	 * Use pro Font Awesome icons (regular, light)
+	 *
+	 * @default false
 	 */
 	fontAwesomePro?: boolean;
 	/**
 	 * Default pagination limit
+	 *
+	 * @default 10
 	 */
 	first?: number;
 }

package/src/props.ts

@@ -1,3 +1,5 @@
 export type tProp<T extends string = string> = T | Record<T, boolean>;
 export type tProps<T extends string = string> = tProp<T> | tProp<T>[];
 export type tPropsModifier<T extends string = string> = boolean | tProps<T>;
+
+export type tIndicative = `${string}+${number}`;

package/src/swal.ts

@@ -0,0 +1,18 @@
+import DefaultSwal, {
+	type SweetAlertOptions,
+	type SweetAlertResult,
+} from "sweetalert2/dist/sweetalert2.js";
+
+/**
+ * Extended SweetAlert2 class
+ *
+ * Do not deestructure this
+ */
+export type tSwal = typeof DefaultSwal & {
+	firePrevent: <T = unknown>(
+		options?: SweetAlertOptions
+	) => Promise<SweetAlertResult<Awaited<T>>>;
+	firePreventDefaults: SweetAlertOptions;
+	fireLoader: <T = unknown>(options?: SweetAlertOptions) => Promise<SweetAlertResult<Awaited<T>>>;
+	fireLoaderDefaults: SweetAlertOptions;
+};

package/src/values.ts

@@ -0,0 +1,24 @@
+export interface iSelectOption {
+	value: string | number;
+	alias?: string;
+	selected?: boolean;
+}
+
+/**
+ * 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>;
+
+/**
+ * used on FactoryTable and related components
+ */
+export interface iProperty<T extends Record<string, any>> extends iSelectOption {
+	/**
+	 * Function to create a node within the relation
+	 */
+	createNode?: (n?: T) => boolean | undefined | Promise<boolean | undefined>;
+}