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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xamu-co/ui-common-types",
-  "version": "3.0.0-next.4",
+  "version": "3.0.0-next.6",
   "description": "Xamu shared types",
   "author": "@xamu-co",
   "main": "src/index.ts",
@@ -32,7 +32,7 @@
   },
   "dependencies": {
     "@fortawesome/fontawesome-common-types": "^6.4.0",
-    "@open-xamu-co/ui-common-enums": "^2.0.1-next.1",
+    "@open-xamu-co/ui-common-enums": "^3.0.0-next.1",
     "sweetalert2": "^11.7.5"
   },
   "engines": {

package/src/locale.ts

@@ -3,7 +3,7 @@
  *
  * @localeType
  */
-export interface iLocaleBase {
+export type tLocaleBase = {
 	/** @example "Yes" */
 	yes: string;
 	/** @example "No" */
@@ -46,6 +46,8 @@ export interface iLocaleBase {
 	pick: string;
 	/** @example "Refresh" */
 	refresh: string;
+	/** @example "Couldn't render the contents due to an unknown error" */
+	render_error: string;
 	swal: {
 		/** @example "Cancel" */
 		cancel: string;
@@ -64,14 +66,14 @@ export interface iLocaleBase {
 		/** @example "Don't close this window while we finish the task" */
 		dont_close_window: string;
 	};
-}
+};
 
 /**
  * Input locale
  *
  * @localeType
  */
-export interface iLocaleInput {
+export type tLocaleInput = {
 	/** @example "Selected" */
 	select_selected: string;
 	/** @example "--SELECT--" */
@@ -116,14 +118,14 @@ export interface iLocaleInput {
 		/** @example "There was an error uploding the files, try again later" */
 		file_unknown_error_text: string;
 	};
-}
+};
 
 /**
  * Modal locale
  *
  * @localeType
  */
-export interface iLocaleModal {
+export type tLocaleModal = {
 	/** @example "Taking too long?" */
 	modal_taking_too_long: string;
 	swal: {
@@ -132,18 +134,20 @@ export interface iLocaleModal {
 		/** @example "You are not allowed to perform this action" */
 		modal_unauthorized_text: string;
 	};
-}
+};
 
 /**
  * Form locale
  *
  * @localeType
  */
-export interface iLocaleForm {
+export type tLocaleForm = {
 	/** @example "Options are required" */
 	form_required_options: string;
 	/** @example "No values are required | A value is required | {count} values are required" */
 	form_requires_n_values: string;
+	/** @example "Loading countries..." */
+	form_loading_countries: string;
 	/** @example "Look for country" */
 	form_country: string;
 	/** @example "Look for state" */
@@ -170,7 +174,9 @@ export interface iLocaleForm {
 	form_complete_the_field: string;
 	/** @example "Location" */
 	form_location: string;
-	/** @example "This field is required" */
+	/** @example "This field is invalid, fill it properly" */
+	form_invalid_field: string;
+	/** @example "This field is required and can't be empty" */
 	form_required_field: string;
 	/** @example "You should use a valid E-mail address" */
 	form_use_valid_email: string;
@@ -183,14 +189,14 @@ export interface iLocaleForm {
 	/** @example "Invalid data" */
 	form_invalid_data: string;
 	// swal: {};
-}
+};
 
 /**
  * Table locale
  *
  * @localeType
  */
-export interface iLocaleTable {
+export type tLocaleTable = {
 	/** @example "See {name}" */
 	table_see_values: string;
 	/** @example "See: \"{name}\"" */
@@ -223,6 +229,10 @@ export interface iLocaleTable {
 	table_options: string;
 	/** @example "Open URL" */
 	table_open_url: string;
+	/** @example "Hide all" */
+	table_hide_all: string;
+	/** @example "Show all" */
+	table_show_all: string;
 	swal: {
 		/** @example "Are you sure you want to delete this element?" */
 		table_delete_node_title: string;
@@ -249,14 +259,14 @@ export interface iLocaleTable {
 		/** @example "The item may not have been cloned | The items may not have been cloned" */
 		table_possibly_not_cloned: string;
 	};
-}
+};
 
 /**
  * Pagination locale
  *
  * @localeType
  */
-export interface iLocalePagination {
+export type tLocalePagination = {
 	/** @example "No items | Single item | {count} items" */
 	pagination_items: string;
 	/** @example "No pages | Single page | {count} pages" */
@@ -278,25 +288,16 @@ export interface iLocalePagination {
 	/** @example "Filter by:" */
 	pagination_filter_by: string;
 	// swal: {};
-}
+};
 
 /**
  * Plugin locale
  *
  * @localeType
  */
-export type tPluginLocale = iLocaleBase &
-	iLocaleInput &
-	iLocaleModal &
-	iLocaleForm &
-	iLocaleTable &
-	iLocalePagination;
-
-/**
- * Plugin locale key union
- *
- * @localeType
- */
-export type tPluginLocaleKey =
-	| Exclude<keyof tPluginLocale, "swal">
-	| `swal.${keyof Required<tPluginLocale>["swal"]}`;
+export type tPluginLocale = tLocaleBase &
+	tLocaleInput &
+	tLocaleModal &
+	tLocaleForm &
+	tLocaleTable &
+	tLocalePagination;

package/src/plugin.ts

@@ -105,6 +105,15 @@ export interface iPluginOptions<ComponentType = unknown> {
 	 * When a country is provided forms will omit that field
 	 */
 	country?: string;
+	/**
+	 * Countries API base endpoint
+	 *
+	 * Get better performance with the nuxt module
+	 * @see https://www.npmjs.com/package/nuxt-countries-api
+	 *
+	 * @default "https://countries.xamu.com.co/api/v1"
+	 */
+	countriesUrl?: string;
 	/**
 	 * Disable automatic animations
 	 *

package/src/styles.ts

@@ -1,4 +1,4 @@
-import { eColors } from "@open-xamu-co/ui-common-enums";
+import { eSizes, eColors } from "@open-xamu-co/ui-common-enums";
 
 /**
  * Union of supported colors.
@@ -6,3 +6,8 @@ import { eColors } from "@open-xamu-co/ui-common-enums";
  */
 export type tThemeModifier = (typeof eColors)[keyof typeof eColors]; // to union
 export type tThemeTuple = [tThemeModifier, tThemeModifier?];
+
+/**
+ * Allowed sizes
+ */
+export type tSizeModifier = (typeof eSizes)[keyof typeof eSizes]; // to union

package/src/values.ts

@@ -16,7 +16,8 @@ export type iNodeFn<T extends Record<string, any>> = (
 /**
  * used on FactoryTable and related components
  */
-export interface iProperty<T extends Record<string, any>> extends iSelectOption {
+export interface iProperty<T extends Record<string, any> = Record<string, any>>
+	extends iSelectOption {
 	/**
 	 * Function to create a node within the relation
 	 */