@fewangsit/wangsvue-gsts 1.0.0-alpha.1

package/utils/mergePropsWithDefaults.util.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Merges the provided props with default props.
+ * If a value in `props` is `undefined` or `null`
+ * it will be replaced by the corresponding value from `defaultProps`.
+ *
+ * This ensures that props always have a fallback value from `defaultProps`
+ *
+ * @param defaultProps - The default values for the props, used as fallbacks.
+ * @param props - The props passed to the component, which may have missing or falsy values.
+ *
+ * @returns A new object that combines the `defaultProps` and `props`, with `props` values
+ *          overriding `defaultProps` where they are provided (unless `undefined` or `null`).
+ *
+ * @example
+ * const defaultProps = { showOptionalText: true, tooltipPos: 'top' };
+ * const props = { tooltipPos: 'bottom' };
+ * const mergedProps = mergePropsWithDefaults(defaultProps, props);
+ * console.log(mergedProps); // Output: { showOptionalText: true, tooltipPos: 'bottom' }
+ */
+export default function mergePropsWithDefaults<T extends Record<string, any>>(props: Record<string, any>, defaultProps: T): T;

package/utils/object.util.d.ts

@@ -0,0 +1,9 @@
+export declare const getNestedProperyValue: (object: object, property: string) => string | boolean | number | object;
+export declare const isEmptyObject: (obj: object) => boolean;
+export declare const deepEquals: (a: object, b: object) => boolean;
+export declare const equals: (obj1: object, obj2: object, field?: string) => boolean;
+export declare const resolveFieldData: (data: object, field?: string) => object;
+export declare const contains: (value: object, list: object[]) => boolean;
+export declare const isNotEmpty: (value: object) => boolean;
+export declare const isEmpty: (value: object | string) => boolean;
+export declare const deepMerge: <T>(target: T, source: Partial<T>) => T;

package/utils/role.util.d.ts

@@ -0,0 +1,2 @@
+import { NavigationGuardNext, RouteLocationNormalized } from 'vue-router';
+export declare const checkRouteAccess: (to: RouteLocationNormalized, from: RouteLocationNormalized, next: NavigationGuardNext) => void;

package/utils/textFormatter.util.d.ts

@@ -0,0 +1,17 @@
+export declare const formatUserName: (name?: string) => string;
+export declare const getInititalName: (existing: string[], fullName?: string, maxLength?: number) => string;
+export declare const getInitialsByConsonant: (existingInitials: string[], fullName: string, maxLength: number) => string;
+export declare const getInitialsBy3FirstLetter: (existingInitials: string[], fullName: string, maxLength: number) => string;
+/**
+ * Formats the label with the appropriate article ("a" or "an") based on its vowel sound.
+ * This function checks if the label starts with a vowel or has a special case for silent "h" words.
+ * It ensures that the correct article ("a" or "an") is used according to English pronunciation rules.
+ *
+ * For example:
+ * - "hour" will be prefixed with "an" (due to the silent "h").
+ * - "unicorn" will be prefixed with "a" (due to the "u" sound).
+ *
+ * @param {string} [label] - The label to be formatted. If no label is provided, returns an empty string.
+ * @returns {string} The label prefixed with the appropriate article ("a" or "an").
+ */
+export declare const formatVowelSoundLabel: (label?: string) => string;

package/utils/toast.util.d.ts

@@ -0,0 +1,114 @@
+import { WangsIcons } from '../components/icon/Icon.vue.d';
+export type ToastSeverity = 'success' | 'error' | 'info';
+export interface ToastParams {
+    /**
+     * The main message to display in the toast. Will be formatted based on template message.
+     */
+    message: string;
+    /**
+     * Indicates whether the message is customized and does not follow the default message template.
+     * If true, custom formatting will be applied.
+     */
+    customMessage?: boolean;
+    /**
+     * The severity level of the toast message.
+     * Can be 'success', 'error', or 'info'.
+     */
+    severity?: ToastSeverity;
+    /**
+     * The icon to display in the toast.
+     */
+    icon?: WangsIcons;
+    /**
+     * The custom CSS class to apply to the icon.
+     */
+    iconClass?: any;
+    /**
+     * The error object from a catch statement, used to provide additional details for error toasts.
+     * Accepts any type of error object.
+     */
+    error?: unknown;
+    /**
+     * The duration for which the toast will be displayed, in milliseconds.
+     * Set to 0 to show the message infinitely.
+     *
+     * @default 3000 - 3 seconds
+     */
+    life?: number;
+    /**
+     * The name of the message group to which this toast belongs.
+     */
+    group?: string;
+    /**
+     * Unique identifier of the toast message.
+     */
+    messageId?: string;
+}
+export interface ToastMethod {
+    add(params: ToastParams): void;
+    /**
+     * Clears the messages that belongs to the group.
+     * @param {string} group - Name of the message group.
+     */
+    removeGroup(group: string): void;
+    removeAllGroups(): void;
+}
+/**
+ * Configuration options for the `useToast` hook.
+ */
+export interface UseToastConfig {
+    /**
+     * Default message templates for each severity level.
+     * Keys represent the severity, and values are the template strings.
+     *
+     * @example
+     * {
+     *   success: 'Success, {message}',
+     *   error: 'Error, {message} {additionalMessage}',
+     *   info: 'Info, {message} {additionalMessage}',
+     * }
+     */
+    template?: Record<string, string>;
+    /**
+     * Icons for each severity level.
+     * Keys represent the severity, and values are the corresponding icon identifiers.
+     *
+     * @example
+     * {
+     *   success: 'emotion-happy-fill',
+     *   error: 'emotion-unhappy-fill',
+     * }
+     */
+    icons?: Record<string, WangsIcons>;
+}
+/**
+ * Hook to create and manage toast notifications.
+ *
+ * @param {UseToastConfig} config - Configuration object for the toast notifications.
+ * Refer to {@link UseToastConfig} for the structure and details of this object.
+ *
+ * @returns {ToastMethod} A method to trigger toast notifications.
+ * The method accepts {@link ToastParams} to customize individual notifications.
+ *
+ * @example
+ * const toast = useToast({
+ *   template: {
+ *     success: 'Success, {message}',
+ *     error: 'Error, {message} {additionalMessage}',
+ *     info: 'Info, {message} {additionalMessage}',
+ *   },
+ *   icons: {
+ *     success: 'emotion-happy-fill',
+ *     error: 'emotion-unhappy-fill',
+ *   }
+ * });
+ *
+ * // Overiding the default config with ToastParams
+ * toast.add({
+ *   message: 'Operation completed successfully!',
+ *   customMessage: true,
+ *   icon: 'custom-success-icon',
+ * });
+ */
+declare const useToast: ({ icons, template }?: UseToastConfig) => ToastMethod;
+export default useToast;