zkit-ui 1.0.0

package/dist/services/LoadingService/index.d.ts

@@ -0,0 +1,146 @@
+/**
+ * @file LoadingService
+ *
+ * A global, service-driven loading HUD. The service owns scheduling and
+ * collision rules; the Provider only renders the current snapshot.
+ */
+import * as React from 'react';
+import { type StyleProp, type ViewStyle } from 'react-native';
+export type LoadingStatus = 'loading' | 'success' | 'error';
+export type LoadingLiveRegion = 'none' | 'polite' | 'assertive';
+export type LoadingDismissReason = 'api' | 'timeout' | 'replace' | 'provider-unmount';
+export type LoadingOpenChangeReason = 'show' | 'update' | LoadingDismissReason;
+export type LoadingLabels = {
+    loading: string;
+    success: string;
+    error: string;
+};
+export type LoadingColors = {
+    backdrop?: string;
+    card?: string;
+    foreground?: string;
+    shadow?: string;
+};
+export type LoadingOpenChangeMeta = {
+    id: string;
+    open: boolean;
+    reason: LoadingOpenChangeReason;
+    status: LoadingStatus;
+};
+export type LoadingIconRenderContext = {
+    item: LoadingItem;
+    status: LoadingStatus;
+    color: string;
+    size: number;
+};
+export type LoadingRenderContext = {
+    item: LoadingItem;
+    id: string;
+    status: LoadingStatus;
+    title?: React.ReactNode;
+    description?: React.ReactNode;
+    open: boolean;
+    hide: (reason?: LoadingDismissReason) => void;
+    update: (patch: LoadingUpdateOptions) => void;
+    defaultIcon: React.ReactNode;
+};
+export type LoadingShowOptions = {
+    id?: string;
+    status?: LoadingStatus;
+    title?: React.ReactNode;
+    description?: React.ReactNode;
+    blocking?: boolean;
+    duration?: number;
+    timeout?: number;
+    icon?: React.ReactNode | false | ((context: LoadingIconRenderContext) => React.ReactNode);
+    render?: (context: LoadingRenderContext) => React.ReactNode;
+    colors?: LoadingColors;
+    accessibilityLabel?: string;
+    accessibilityLiveRegion?: LoadingLiveRegion;
+    testID?: string;
+    style?: StyleProp<ViewStyle>;
+    onDismiss?: (reason: LoadingDismissReason, id: string) => void;
+    onOpenChange?: (open: boolean, meta: LoadingOpenChangeMeta) => void;
+};
+export type LoadingResultOptions = Omit<LoadingShowOptions, 'status' | 'timeout'>;
+export type LoadingUpdateOptions = Partial<Omit<LoadingShowOptions, 'id'>>;
+export type LoadingInput = React.ReactNode | LoadingShowOptions;
+export type LoadingResultInput = React.ReactNode | LoadingResultOptions;
+export type LoadingPromiseResultInput<T> = LoadingResultInput | false | ((result: T) => LoadingResultInput | false | undefined);
+export type LoadingPromiseErrorInput<T> = LoadingResultInput | false | ((error: unknown, result?: T) => LoadingResultInput | false | undefined);
+export type LoadingPromiseOptions<T = unknown> = {
+    loading?: LoadingInput | false;
+    success?: LoadingPromiseResultInput<T>;
+    error?: LoadingPromiseErrorInput<T>;
+    isSuccess?: (result: T) => boolean;
+};
+export type LoadingDefaults = {
+    blocking?: boolean;
+    loadingTimeout?: number;
+    successDuration?: number;
+    errorDuration?: number;
+    accessibilityLiveRegion?: LoadingLiveRegion;
+    labels?: Partial<LoadingLabels>;
+    colors?: LoadingColors;
+};
+export type LoadingProviderProps = {
+    children: React.ReactNode;
+    defaults?: LoadingDefaults;
+};
+export type LoadingItem = {
+    id: string;
+    status: LoadingStatus;
+    title?: React.ReactNode;
+    description?: React.ReactNode;
+    blocking: boolean;
+    duration: number;
+    timeout: number;
+    icon?: LoadingShowOptions['icon'];
+    render?: LoadingShowOptions['render'];
+    colors?: LoadingColors;
+    accessibilityLabel: string;
+    accessibilityLiveRegion: LoadingLiveRegion;
+    testID?: string;
+    style?: StyleProp<ViewStyle>;
+    open: boolean;
+    createdAt: number;
+    updatedAt: number;
+    onDismiss?: LoadingShowOptions['onDismiss'];
+    onOpenChange?: LoadingShowOptions['onOpenChange'];
+};
+export type LoadingSnapshot = {
+    item: LoadingItem | null;
+};
+export type LoadingHandle = {
+    readonly id: string;
+    hide: (reason?: LoadingDismissReason) => void;
+    update: (patch: LoadingUpdateOptions) => void;
+    success: (options?: LoadingResultInput) => void;
+    error: (options?: LoadingResultInput) => void;
+    isActive: () => boolean;
+};
+export type LoadingResolvedDefaults = {
+    blocking: boolean;
+    loadingTimeout: number;
+    successDuration: number;
+    errorDuration: number;
+    accessibilityLiveRegion: LoadingLiveRegion;
+    labels: LoadingLabels;
+    colors?: LoadingColors;
+};
+export type LoadingService = {
+    configure: (defaults?: LoadingDefaults) => void;
+    getDefaults: () => LoadingResolvedDefaults;
+    getSnapshot: () => LoadingSnapshot;
+    show: (options?: LoadingInput) => LoadingHandle;
+    success: (options?: LoadingResultInput) => LoadingHandle;
+    error: (options?: LoadingResultInput) => LoadingHandle;
+    promise: <T>(promise: Promise<T>, options?: LoadingPromiseOptions<T>) => Promise<T>;
+    update: (idOrHandle: string | LoadingHandle, patch: LoadingUpdateOptions) => boolean;
+    hide: (idOrHandle?: string | LoadingHandle, reason?: LoadingDismissReason) => void;
+    hideAll: (reason?: LoadingDismissReason) => void;
+    isActive: (idOrHandle: string | LoadingHandle) => boolean;
+};
+export declare const loading: LoadingService;
+export declare function LoadingProvider({ children, defaults }: LoadingProviderProps): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=index.d.ts.map

package/dist/services/LoadingService/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/services/LoadingService/index.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAA8B,KAAK,SAAS,EAAE,KAAK,SAAS,EAAE,MAAM,cAAc,CAAC;AAsB1F,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;AAC5D,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,QAAQ,GAAG,WAAW,CAAC;AAChE,MAAM,MAAM,oBAAoB,GAAG,KAAK,GAAG,SAAS,GAAG,SAAS,GAAG,kBAAkB,CAAC;AACtF,MAAM,MAAM,uBAAuB,GAAG,MAAM,GAAG,QAAQ,GAAG,oBAAoB,CAAC;AAE/E,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,uBAAuB,CAAC;IAChC,MAAM,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,EAAE,aAAa,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,WAAW,CAAC;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,aAAa,CAAC;IACtB,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACxB,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC9B,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,oBAAoB,KAAK,IAAI,CAAC;IAC9C,MAAM,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,IAAI,CAAC;IAC9C,WAAW,EAAE,KAAK,CAAC,SAAS,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACxB,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC9B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC,OAAO,EAAE,wBAAwB,KAAK,KAAK,CAAC,SAAS,CAAC,CAAC;IAC1F,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,KAAK,CAAC,SAAS,CAAC;IAC5D,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,uBAAuB,CAAC,EAAE,iBAAiB,CAAC;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;IAC7B,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,oBAAoB,EAAE,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/D,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,qBAAqB,KAAK,IAAI,CAAC;CACrE,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,kBAAkB,EAAE,QAAQ,GAAG,SAAS,CAAC,CAAC;AAClF,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC,CAAC;AAC3E,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,SAAS,GAAG,kBAAkB,CAAC;AAChE,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,SAAS,GAAG,oBAAoB,CAAC;AACxE,MAAM,MAAM,yBAAyB,CAAC,CAAC,IACnC,kBAAkB,GAClB,KAAK,GACL,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,kBAAkB,GAAG,KAAK,GAAG,SAAS,CAAC,CAAC;AAC5D,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAClC,kBAAkB,GAClB,KAAK,GACL,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC,KAAK,kBAAkB,GAAG,KAAK,GAAG,SAAS,CAAC,CAAC;AAE7E,MAAM,MAAM,qBAAqB,CAAC,CAAC,GAAG,OAAO,IAAI;IAC/C,OAAO,CAAC,EAAE,YAAY,GAAG,KAAK,CAAC;IAC/B,OAAO,CAAC,EAAE,yBAAyB,CAAC,CAAC,CAAC,CAAC;IACvC,KAAK,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC;IACpC,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,OAAO,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,uBAAuB,CAAC,EAAE,iBAAiB,CAAC;IAC5C,MAAM,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IAChC,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,aAAa,CAAC;IACtB,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACxB,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC9B,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAClC,MAAM,CAAC,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACtC,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,uBAAuB,EAAE,iBAAiB,CAAC;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;IAC7B,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAC5C,YAAY,CAAC,EAAE,kBAAkB,CAAC,cAAc,CAAC,CAAC;CACnD,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,WAAW,GAAG,IAAI,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,oBAAoB,KAAK,IAAI,CAAC;IAC9C,MAAM,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,IAAI,CAAC;IAC9C,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,kBAAkB,KAAK,IAAI,CAAC;IAChD,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,kBAAkB,KAAK,IAAI,CAAC;IAC9C,QAAQ,EAAE,MAAM,OAAO,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,QAAQ,EAAE,OAAO,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,uBAAuB,EAAE,iBAAiB,CAAC;IAC3C,MAAM,EAAE,aAAa,CAAC;IACtB,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,EAAE,CAAC,QAAQ,CAAC,EAAE,eAAe,KAAK,IAAI,CAAC;IAChD,WAAW,EAAE,MAAM,uBAAuB,CAAC;IAC3C,WAAW,EAAE,MAAM,eAAe,CAAC;IACnC,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,YAAY,KAAK,aAAa,CAAC;IAChD,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,kBAAkB,KAAK,aAAa,CAAC;IACzD,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,kBAAkB,KAAK,aAAa,CAAC;IACvD,OAAO,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IACpF,MAAM,EAAE,CAAC,UAAU,EAAE,MAAM,GAAG,aAAa,EAAE,KAAK,EAAE,oBAAoB,KAAK,OAAO,CAAC;IACrF,IAAI,EAAE,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,aAAa,EAAE,MAAM,CAAC,EAAE,oBAAoB,KAAK,IAAI,CAAC;IACnF,OAAO,EAAE,CAAC,MAAM,CAAC,EAAE,oBAAoB,KAAK,IAAI,CAAC;IACjD,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,GAAG,aAAa,KAAK,OAAO,CAAC;CAC3D,CAAC;AA+jBF,eAAO,MAAM,OAAO,EAAE,cAA6B,CAAC;AAUpD,wBAAgB,eAAe,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,oBAAoB,2CA+B3E"}