@amirjalili1374/ui-kit 1.10.9 → 1.10.10

package/dist/index.d.ts

@@ -32,6 +32,16 @@ export { default as AppNotificationCenter } from './components/shared/AppNotific
 export type { AppNotification } from './components/shared/AppNotificationCenter.vue';
 export { default as AppStepper } from './components/common/AppStepper.vue';
 export { default as Loading } from './components/Loading.vue';
+export { default as UiLoadingState } from './components/state/UiLoadingState.vue';
+export { default as UiEmptyState } from './components/state/UiEmptyState.vue';
+export { default as UiErrorState } from './components/state/UiErrorState.vue';
+export { default as UiPermissionDenied } from './components/state/UiPermissionDenied.vue';
+export { default as UiAsyncState } from './components/state/UiAsyncState.vue';
+export { default as PermissionGuard } from './components/permissions/PermissionGuard.vue';
+export { default as UiField } from './components/form/UiField.vue';
+export { default as UiFieldMessage } from './components/form/UiFieldMessage.vue';
+export { default as UiFormActions } from './components/form/UiFormActions.vue';
+export type { UiFieldMessageVariant, UiFormActionsAlign } from './components/form/types';
 export { default as AppSidebar } from './components/layout/AppSidebar.vue';
 export { default as AppHeader } from './components/layout/AppHeader.vue';
 export { default as AppHeaderMenu } from './components/layout/AppHeaderMenu.vue';
@@ -71,12 +81,23 @@ export { useCustomizerStore } from './stores/customizer';
 export * from './types/componentTypes/DataTableType';
 export * from './types/componentTypes/DataTableTypes';
 export * from './constants/enums/booleanEnum';
+export { createUiKit, useUiKit, useUiKitConfig, useUiKitLocale, useUiKitMessages, useUiKitIcons, usePermission } from './platform/uiKit';
+export { defaultThemes, mergeThemes, createUiKitThemes } from './platform/themes';
+export type { UiKitThemeName } from './platform/themes';
+export type * from './platform/types';
+export type { UiAsyncState as UiAsyncStateModel } from './platform/types';
+export { isUiAsyncLoading, isUiAsyncError, hasUiAsyncData } from './platform/types';
+export type { UiKitContext } from './platform/uiKit';
 import type { App } from 'vue';
+import type { UiKitConfig } from './platform/types';
 /**
  * Install the UI Kit library in a Vue application
  * @param app - Vue application instance
  */
-export declare function install(app: App): void;
+export declare function install(app: App, options?: UiKitConfig): void;
+export declare const UiKitPlugin: {
+    install: typeof install;
+};
 declare const _default: {
     install: typeof install;
 };

package/dist/platform/defaults.d.ts

@@ -0,0 +1,7 @@
+import type { UiMessages, UiSemanticIcons } from './types';
+export declare const defaultMessages: Record<'fa-IR' | 'en-US', UiMessages>;
+export declare const defaultIcons: UiSemanticIcons;
+export declare const defaultThemes: {
+    modern: import("../types/themeTypes/ThemeType").ThemeTypes;
+    'modern-dark': import("../types/themeTypes/ThemeType").ThemeTypes;
+};

package/dist/platform/themes.d.ts

@@ -0,0 +1,8 @@
+import type { UiThemeRegistry } from './types';
+import { defaultThemes } from './defaults';
+export { defaultThemes };
+export type UiKitThemeName = keyof typeof defaultThemes;
+export declare function mergeThemes<T extends Record<string, unknown>>(base: T, overrides: Partial<T>): T;
+export declare function createUiKitThemes(options?: {
+    overrides?: UiThemeRegistry;
+}): UiThemeRegistry;

package/dist/platform/types/actions.d.ts

@@ -0,0 +1,23 @@
+import type { UiIconSource } from './icons';
+export type UiComponentSize = 'x-small' | 'small' | 'default' | 'large' | 'x-large';
+export type UiDensity = 'default' | 'comfortable' | 'compact';
+export interface UiActionDefinition<T = unknown> {
+    id: string;
+    label: string;
+    icon?: UiIconSource;
+    disabled?: boolean;
+    handler?: (item: T) => void;
+}
+/** @deprecated Prefer the table-specific pagination contract for DataTable features. */
+export interface UiPaginationState {
+    page: number;
+    itemsPerPage: number;
+    total?: number;
+}
+export interface UiSortState {
+    key: string;
+    order: 'asc' | 'desc';
+}
+export interface UiFilterState {
+    [key: string]: unknown;
+}

package/dist/platform/types/async.d.ts

@@ -0,0 +1,12 @@
+export type UiAsyncStatus = 'idle' | 'loading' | 'empty' | 'error' | 'success' | 'permission-denied';
+export interface UiAsyncState<T = unknown, E = unknown> {
+    status: UiAsyncStatus;
+    data?: T;
+    error?: E;
+    message?: string;
+}
+export declare const isUiAsyncLoading: (state: UiAsyncState) => boolean;
+export declare const isUiAsyncError: (state: UiAsyncState) => boolean;
+export declare const hasUiAsyncData: <T>(state: UiAsyncState<T>) => state is UiAsyncState<T> & {
+    data: T;
+};

package/dist/platform/types/core.d.ts

@@ -0,0 +1,19 @@
+import type { UiDirection, UiLocale } from './locale';
+import type { UiMessageCatalog } from './messages';
+import type { UiSemanticIcons } from './icons';
+import type { UiPermissionEvaluator, UiPermissionOptions } from './permissions';
+import type { UiThemeOptions } from './themes';
+export interface UiKitOptions {
+    locale: UiLocale;
+    direction: UiDirection;
+    theme: UiThemeOptions;
+    messages: UiMessageCatalog;
+    icons: Partial<UiSemanticIcons>;
+    permissions: UiPermissionOptions;
+}
+export type UiKitConfig = Partial<Omit<UiKitOptions, 'theme' | 'messages' | 'icons' | 'permissions'>> & {
+    theme?: UiThemeOptions;
+    messages?: UiMessageCatalog;
+    icons?: Partial<UiSemanticIcons>;
+    permissions?: UiPermissionOptions | UiPermissionEvaluator;
+};

package/dist/platform/types/icons.d.ts

@@ -0,0 +1,32 @@
+import type { Component } from 'vue';
+export type UiIconSource = string | Component;
+export interface UiSemanticIcons {
+    close: UiIconSource;
+    confirm: UiIconSource;
+    cancel: UiIconSource;
+    loading: UiIconSource;
+    empty: UiIconSource;
+    error: UiIconSource;
+    permissionDenied: UiIconSource;
+    retry: UiIconSource;
+    menu: UiIconSource;
+    theme: UiIconSource;
+    notifications: UiIconSource;
+    profile: UiIconSource;
+    chevronDown: UiIconSource;
+    search: UiIconSource;
+    clear: UiIconSource;
+    delete: UiIconSource;
+    edit: UiIconSource;
+    create: UiIconSource;
+    download: UiIconSource;
+    upload: UiIconSource;
+    print: UiIconSource;
+    previous: UiIconSource;
+    next: UiIconSource;
+    warning: UiIconSource;
+    success: UiIconSource;
+    expand: UiIconSource;
+    collapse: UiIconSource;
+}
+export type UiSemanticIconName = keyof UiSemanticIcons;

package/dist/platform/types/index.d.ts

@@ -0,0 +1,8 @@
+export type * from './core';
+export type * from './locale';
+export type * from './messages';
+export type * from './icons';
+export type * from './permissions';
+export * from './async';
+export type * from './themes';
+export type * from './actions';

package/dist/platform/types/locale.d.ts

@@ -0,0 +1,4 @@
+export type UiLocale = 'fa-IR' | 'en-US' | (string & {});
+export type UiDirection = 'rtl' | 'ltr' | 'auto';
+export type ResolvedUiDirection = Exclude<UiDirection, 'auto'>;
+export type UiLocalizedText = string | Partial<Record<UiLocale, string>>;

package/dist/platform/types/messages.d.ts

@@ -0,0 +1,41 @@
+import type { UiLocale } from './locale';
+export interface UiMessages {
+    close: string;
+    loading: string;
+    emptyTitle: string;
+    emptyDescription: string;
+    errorTitle: string;
+    errorDescription: string;
+    retry: string;
+    permissionDeniedTitle: string;
+    permissionDeniedDescription: string;
+    confirm: string;
+    cancel: string;
+    noData: string;
+    empty: string;
+    error: string;
+    permissionDenied: string;
+    search: string;
+    clear: string;
+    select: string;
+    delete: string;
+    deleteConfirmation: string;
+    download: string;
+    upload: string;
+    print: string;
+    previous: string;
+    next: string;
+    create: string;
+    edit: string;
+    save: string;
+    actions: string;
+    navigationMenu: string;
+    compactSidebar: string;
+    themeCustomizer: string;
+    notifications: string;
+    profileSettings: string;
+}
+export type UiMessageKey = keyof UiMessages;
+export type UiMessageOverrides = Partial<UiMessages>;
+export type UiMessageCatalog = Partial<Record<UiLocale, UiMessageOverrides>>;
+export type UiMessageParams = Record<string, string | number | boolean>;

package/dist/platform/types/permissions.d.ts

@@ -0,0 +1,12 @@
+export type UiPermissionEvaluator = (permission: string) => boolean;
+export type UiMissingPermissionEvaluatorPolicy = 'allow' | 'deny';
+export interface UiPermissionOptions {
+    evaluator?: UiPermissionEvaluator;
+    missingEvaluator?: UiMissingPermissionEvaluatorPolicy;
+}
+export interface UiPermissionRequirement {
+    permission?: string;
+    any?: string[];
+    all?: string[];
+}
+export type UiPermissionInput = string | string[] | UiPermissionRequirement;

package/dist/platform/types/themes.d.ts

@@ -0,0 +1,8 @@
+import type { ThemeDefinition } from 'vuetify';
+export interface UiThemeRegistry {
+    [name: string]: ThemeDefinition;
+}
+export interface UiThemeOptions {
+    defaultTheme?: string;
+    themes?: UiThemeRegistry;
+}

package/dist/platform/types.d.ts

@@ -0,0 +1 @@
+export * from './types/index';

package/dist/platform/uiKit.d.ts

@@ -0,0 +1,33 @@
+import { type App, type ComputedRef, type Plugin } from 'vue';
+import type { ResolvedUiDirection, UiKitConfig, UiKitOptions, UiMessageKey, UiMessageParams, UiPermissionInput, UiSemanticIconName } from './types';
+export interface UiKitContext {
+    config: Readonly<UiKitOptions>;
+    locale: ComputedRef<string>;
+    direction: ComputedRef<ResolvedUiDirection>;
+    t: (key: UiMessageKey, params?: UiMessageParams) => string;
+    icon: (name: UiSemanticIconName) => UiKitOptions['icons'][UiSemanticIconName];
+    can: (requirement?: UiPermissionInput) => boolean;
+    update: (options: UiKitConfig) => void;
+    reset: () => void;
+}
+export declare function createUiKit(options?: UiKitConfig): UiKitContext;
+export declare function provideUiKit(app: App, options?: UiKitConfig): UiKitContext;
+export declare function useUiKit(): UiKitContext;
+export declare function useUiKitConfig(): Readonly<UiKitOptions>;
+export declare function useUiKitLocale(): {
+    locale: ComputedRef<string>;
+    direction: ComputedRef<ResolvedUiDirection>;
+};
+export declare function useUiKitMessages(): {
+    t: (key: UiMessageKey, params?: UiMessageParams) => string;
+    locale: ComputedRef<string>;
+};
+export declare function useUiKitIcons(): {
+    resolveIcon: (name: UiSemanticIconName) => UiKitOptions["icons"][UiSemanticIconName];
+};
+export declare function usePermission(): {
+    can: (requirement?: UiPermissionInput) => boolean;
+    any: (permissions: string[]) => boolean;
+    all: (permissions: string[]) => boolean;
+};
+export declare const UiKitPlugin: Plugin<[UiKitConfig?]>;