@ckbox/core 1.1.1-dev.0 → 1.2.0-dev.0

package/dist/providers/api/ApiContext.d.ts

@@ -0,0 +1,12 @@
+import * as React from 'react';
+import { createApi } from '../../services';
+export interface ApiContext {
+    /**
+     * API endpoints.
+     */
+    api?: ReturnType<typeof createApi>;
+}
+/**
+ * Defines React context for API.
+ */
+export declare const ApiContext: React.Context<ApiContext>;

package/dist/providers/api/ApiProvider.d.ts

@@ -0,0 +1,17 @@
+import * as React from 'react';
+declare const ApiProvider: React.FC<Props>;
+export interface Props {
+    /**
+     * Main content.
+     */
+    children: React.ReactNode;
+    /**
+     * Configures origin for public assets.
+     */
+    assetsOrigin: string;
+    /**
+     * Origin of the backend API service.
+     */
+    serviceOrigin: string;
+}
+export default ApiProvider;

package/dist/providers/api/index.d.ts

@@ -0,0 +1,3 @@
+export * from './useApi';
+export * from './ApiContext';
+export { default as ApiProvider } from './ApiProvider';

package/dist/providers/api/useApi.d.ts

@@ -0,0 +1,42 @@
+export declare const useApi: () => {
+    api: {
+        assets: {
+            deleteAssets: (assetIds: string[]) => Promise<import("../../services").ApiDeletedAssetsResponse | undefined>;
+            getCategoryAssets: (params: import("../../services").ApiCategoryAssetsParams) => Promise<import("../../services").ApiAssets | undefined>;
+            getRecentAssets: (params: import("../../services").ApiRecentAssetsParams) => Promise<import("../../services").ApiAssets | undefined>;
+            updateAsset: (assetId: string, payload: import("../../services").ApiUpdateAssetPayload) => Promise<import("../../services").ApiAsset | undefined>;
+            uploadAsset: () => {
+                start: <JSONResponse>(payload: Record<string, string | Blob>, progressCallback?: ((loaded: number, total: number) => void) | undefined) => Promise<JSONResponse>;
+                abort: () => void;
+            };
+            getAssetUrl: (assetId: string, forceDownload?: boolean) => string;
+            getAsset: (assetId: string) => Promise<import("../../services").ApiAsset | undefined>;
+            updateAssetLastUse: (assetIds: string[]) => Promise<void | undefined>;
+            getAssetThumbUrl: (assetId: string, width: number, heightOrFormat?: string | number | undefined, format?: string | undefined) => string;
+            getAssetResponsiveImageUrl: (assetId: string, width: number, heightOrFormat?: string | number | undefined, format?: string | undefined) => string;
+        };
+        categories: {
+            createCategory: (payload: import("../../services").ApiCreateCategoryPayload) => Promise<import("../../services").ApiCreatedCategoryResponse | undefined>;
+            deleteCategory: (categoryId: string) => Promise<unknown>;
+            getAdminCategories: (params?: import("../../services").ApiCategoriesParams) => Promise<import("../../services").ApiAdminCategories | undefined>;
+            getCategories: (params?: import("../../services").ApiCategoriesParams) => Promise<import("../../services").ApiCategories | undefined>;
+            getCategory: (id: string) => Promise<import("../../services").ApiCategory | undefined>;
+            updateCategory: (categoryId: string, payload: import("../../services").ApiUpdateCategoryPayload) => Promise<undefined>;
+            updateCategoriesOrder: (payload: import("../../services").ApiUpdateCategoriesOrderPayload) => Promise<undefined>;
+        };
+        images: {
+            getImagesConfig: () => Promise<import("../../services").ApiImagesConfig>;
+            updateImageFormatConfig: (format: string, payload: import("../../services").ApiImageFormatConfig) => Promise<import("../../services").ApiImagesConfig>;
+        };
+        planLimits: {
+            getPlanLimits: () => Promise<import("../../services").ApiPlanLimits | undefined>;
+        };
+        search: {
+            search: (payload: import("../../services").ApiSearchPayload) => Promise<import("../../services").ApiSearchResponse | undefined>;
+        };
+        config: {
+            serviceOrigin: string;
+            assetsOrigin: string;
+        };
+    };
+};

package/dist/providers/assetsConfig/AssetsConfigContext.d.ts

@@ -0,0 +1,41 @@
+import * as React from 'react';
+import { ParsedAsset } from '../data';
+export interface AssetExtraProps {
+    /**
+     * API origin.
+     */
+    origin: string;
+    /**
+     * Callback that returns URL to the resource.
+     */
+    getUrl: (forceDownload?: boolean) => string;
+    /**
+     * Callback that returns URL to image of specified dimensions. Resource at URL is cached on CDN.
+     * Returns `false` if there is no image available for the asset.
+     */
+    getResponsiveImageUrl: (width: number, heightOrFormat?: number | string, format?: string) => string | false;
+}
+export interface Asset extends AssetExtraProps {
+    data: ParsedAsset;
+}
+export declare type AssetsConfigOnChoose = (assets: ParsedAsset[]) => void;
+export declare type AssetsConfigOnChooseEnhanced = (assets: Asset[]) => void;
+export interface AssetsConfig {
+    /**
+     * Callback invoked upon clicking on `Choose` button.
+     * List of currently selected assets is passed as an argument.
+     */
+    onChoose?: AssetsConfigOnChooseEnhanced;
+}
+export interface AssetsConfigContext {
+    /**
+     * Callback invoked upon clicking on `Choose` button.
+     * List of currently selected assets is passed as an argument.
+     */
+    onChoose?: AssetsConfigOnChoose;
+}
+/**
+ * Defines React context for assets config.
+ */
+export declare const AssetsConfigContext: React.Context<AssetsConfigContext>;
+export declare const useAssetsConfig: () => AssetsConfigContext;

package/dist/providers/assetsConfig/AssetsConfigProvider.d.ts

@@ -0,0 +1,16 @@
+import * as React from 'react';
+import { AssetsConfigOnChooseEnhanced } from './AssetsConfigContext';
+declare const AssetsConfigProvider: React.FC<Props>;
+export interface Props {
+    /**
+     * Main content.
+     */
+    children: React.ReactNode;
+    /**
+     * Callback invoked upon clicking on `Choose` button.
+     * List of currently selected assets is passed as an argument.
+     * Each asset is enhanced with extra props.
+     */
+    onChoose?: AssetsConfigOnChooseEnhanced;
+}
+export default AssetsConfigProvider;

package/dist/providers/assetsConfig/index.d.ts

@@ -0,0 +1,3 @@
+export * from './utils';
+export * from './AssetsConfigContext';
+export { default as AssetsConfigProvider } from './AssetsConfigProvider';

package/dist/providers/assetsConfig/utils.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Only for the following extensions an asset image preview will be shown.
+ */
+export declare const ASSET_PREVIEW_EXTENSIONS: string[];
+/**
+ * Checks if asset can be previewed.
+ *
+ * @param extension asset extension
+ * @returns flag indicating if asset can be previewed
+ */
+export declare const canAssetBePreviewed: (extension: string) => boolean;

package/dist/providers/auth/AuthContext.d.ts

@@ -0,0 +1,16 @@
+import * as React from 'react';
+import { AuthClient, Token } from '../../services';
+export interface AuthContext {
+    /**
+     * Instance of authentication client class.
+     */
+    authClient?: AuthClient;
+    /**
+     * Token object.
+     */
+    token?: Token;
+}
+/**
+ * Defines React context for authentication.
+ */
+export declare const AuthContext: React.Context<AuthContext>;

package/dist/providers/auth/AuthProvider.d.ts

@@ -0,0 +1,14 @@
+import * as React from 'react';
+import { AuthConfig } from '../../services';
+declare const AuthProvider: React.FC<Props>;
+export interface Props {
+    /**
+     * Main content.
+     */
+    children: React.ReactNode;
+    /**
+     * Authentication config.
+     */
+    auth: AuthConfig;
+}
+export default AuthProvider;

package/dist/providers/auth/index.d.ts

@@ -0,0 +1,3 @@
+export * from './useAuth';
+export * from './AuthContext';
+export { default as AuthProvider } from './AuthProvider';

package/dist/providers/auth/useAuth.d.ts

@@ -0,0 +1,4 @@
+export declare const useAuth: () => {
+    authClient: import("../../services").AuthClient;
+    token?: import("../../services").Token | undefined;
+};

package/dist/providers/categoriesConfig/CategoriesConfigContext.d.ts

@@ -0,0 +1,24 @@
+import * as React from 'react';
+import { IconName, IconRenderProp } from '@ckbox/components';
+import { GetCategoryIconProps } from './utils';
+export interface CategoryIconProps {
+    name?: IconName;
+    render?: IconRenderProp;
+}
+export interface CategoriesConfigContext {
+    /**
+     * Gets icon renderer for a given category.
+     */
+    getCategoryIconProps: (params: GetCategoryIconProps) => CategoryIconProps;
+}
+export declare type CategoriesConfig = {
+    /**
+     * Maps category names to custom icons.
+     */
+    icons?: Record<string, IconRenderProp>;
+};
+/**
+ * Defines React context for assets config.
+ */
+export declare const CategoriesConfigContext: React.Context<CategoriesConfigContext>;
+export declare const useCategoriesConfig: () => CategoriesConfigContext;

package/dist/providers/categoriesConfig/CategoriesConfigProvider.d.ts

@@ -0,0 +1,10 @@
+import * as React from 'react';
+import { CategoriesConfig } from './CategoriesConfigContext';
+declare const CategoriesConfigProvider: React.FC<Props>;
+export interface Props extends CategoriesConfig {
+    /**
+     * Pass-through content.
+     */
+    children: React.ReactNode;
+}
+export default CategoriesConfigProvider;

package/dist/providers/categoriesConfig/index.d.ts

@@ -0,0 +1,2 @@
+export * from './CategoriesConfigContext';
+export { default as CategoriesConfigProvider } from './CategoriesConfigProvider';

package/dist/providers/categoriesConfig/utils.d.ts

@@ -0,0 +1,16 @@
+import { IconRenderProp } from '@ckbox/components';
+import { CategoryIconProps } from './CategoriesConfigContext';
+export declare type GetCategoryIconProps = Pick<GetCategoryIconPropsOptions, 'categoryName' | 'categoryId'>;
+export declare type GetCategoryIconPropsOptions = {
+    categoryName?: string;
+    categoryId?: string;
+    icons: Record<string, IconRenderProp>;
+};
+/**
+ * Gets icon name or renderer function for a given category name.
+ *
+ * @param categoryName category name
+ * @param icons maps category name to icon renderer or name
+ * @returns icon name or renderer
+ */
+export declare const getCategoryIconProps: (params: GetCategoryIconPropsOptions) => CategoryIconProps;

package/dist/providers/data/hooks/assets/index.d.ts

@@ -0,0 +1,7 @@
+export * from './useGetCategoryAssets';
+export * from './useDeleteAssets';
+export * from './useGetRecentAssets';
+export * from './useUpdateAsset';
+export * from './useUpdateAssetLastUse';
+export * from './useLazyGetAsset';
+export * from './useGetAsset';

package/dist/providers/data/hooks/assets/useDeleteAssets.d.ts

@@ -0,0 +1,71 @@
+import { ApiAssetsToDelete, ApiDeletedAssetsResponse } from '../../../../services';
+/**
+ * Deletes multiple assets by id.
+ *
+ * @returns deleted assets data
+ */
+export declare const useDeleteAssets: () => {
+    mutateAsync: import("../types").ErrorSuppressedMutateFunction<ApiDeletedAssetsResponse | undefined, Error, ApiAssetsToDelete, unknown>;
+    data: undefined;
+    error: null;
+    isError: false;
+    isIdle: true;
+    isLoading: false;
+    isSuccess: false;
+    status: "idle";
+    mutate: import("@tanstack/react-query").UseMutateFunction<ApiDeletedAssetsResponse | undefined, Error, ApiAssetsToDelete, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    variables: ApiAssetsToDelete | undefined;
+} | {
+    mutateAsync: import("../types").ErrorSuppressedMutateFunction<ApiDeletedAssetsResponse | undefined, Error, ApiAssetsToDelete, unknown>;
+    data: undefined;
+    error: null;
+    isError: false;
+    isIdle: false;
+    isLoading: true;
+    isSuccess: false;
+    status: "loading";
+    mutate: import("@tanstack/react-query").UseMutateFunction<ApiDeletedAssetsResponse | undefined, Error, ApiAssetsToDelete, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    variables: ApiAssetsToDelete | undefined;
+} | {
+    mutateAsync: import("../types").ErrorSuppressedMutateFunction<ApiDeletedAssetsResponse | undefined, Error, ApiAssetsToDelete, unknown>;
+    data: undefined;
+    error: Error;
+    isError: true;
+    isIdle: false;
+    isLoading: false;
+    isSuccess: false;
+    status: "error";
+    mutate: import("@tanstack/react-query").UseMutateFunction<ApiDeletedAssetsResponse | undefined, Error, ApiAssetsToDelete, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    variables: ApiAssetsToDelete | undefined;
+} | {
+    mutateAsync: import("../types").ErrorSuppressedMutateFunction<ApiDeletedAssetsResponse | undefined, Error, ApiAssetsToDelete, unknown>;
+    data: ApiDeletedAssetsResponse | undefined;
+    error: null;
+    isError: false;
+    isIdle: false;
+    isLoading: false;
+    isSuccess: true;
+    status: "success";
+    mutate: import("@tanstack/react-query").UseMutateFunction<ApiDeletedAssetsResponse | undefined, Error, ApiAssetsToDelete, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    variables: ApiAssetsToDelete | undefined;
+};

package/dist/providers/data/hooks/assets/useGetAsset.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Manages a single asset.
+ *
+ * @returns details of queried asset.
+ */
+export declare const useGetAsset: (assetId: string) => import("@tanstack/react-query").UseQueryResult<import("../../parsers").ParsedAsset, Error>;

package/dist/providers/data/hooks/assets/useGetCategoryAssets.d.ts

@@ -0,0 +1,11 @@
+import { ApiCategoryAssetsParams } from '../../../../services';
+/**
+ * Manages list of category assets.
+ *
+ * @param params parameters for API call
+ * @returns list of queried category assets
+ */
+export declare const useGetCategoryAssets: (params: ApiCategoryAssetsParams, enabled?: boolean) => import("@tanstack/react-query").UseQueryResult<{
+    totalCount: number | undefined;
+    items: import("../../parsers").ParsedAsset[];
+}, Error>;

package/dist/providers/data/hooks/assets/useGetRecentAssets.d.ts

@@ -0,0 +1,10 @@
+import { ApiRecentAssetsParams } from '../../../../services';
+/**
+ * Manages list of category assets.
+ *
+ * @returns list of queried category assets
+ */
+export declare const useGetRecentAssets: (params: ApiRecentAssetsParams, enabled?: boolean) => import("@tanstack/react-query").UseQueryResult<{
+    totalCount: number | undefined;
+    items: import("../../parsers").ParsedAsset[];
+}, Error>;

package/dist/providers/data/hooks/assets/useLazyGetAsset.d.ts

@@ -0,0 +1,10 @@
+import { ParsedAsset } from '../../parsers';
+/**
+ * Fetches the details of a single asset.
+ *
+ * @returns fetch callback
+ */
+export declare const useLazyGetAsset: () => {
+    fetchAsset: (asset?: ParsedAsset) => Promise<ParsedAsset | undefined>;
+    isLoading: boolean;
+};

package/dist/providers/data/hooks/assets/useUpdateAsset.d.ts

@@ -0,0 +1,77 @@
+import { ApiUpdateAssetPayload } from '../../../../services';
+declare type UpdateAssetData = {
+    assetId: string;
+    categoryId: string;
+    payload: ApiUpdateAssetPayload;
+};
+/**
+ * Creates update asset mutation.
+ *
+ * @returns mutation for updating asset
+ */
+export declare const useUpdateAsset: () => {
+    mutateAsync: import("../types").ErrorSuppressedMutateFunction<import("../../../../services").ApiAsset | undefined, Error, UpdateAssetData, unknown>;
+    data: undefined;
+    error: null;
+    isError: false;
+    isIdle: true;
+    isLoading: false;
+    isSuccess: false;
+    status: "idle";
+    mutate: import("@tanstack/react-query").UseMutateFunction<import("../../../../services").ApiAsset | undefined, Error, UpdateAssetData, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    variables: UpdateAssetData | undefined;
+} | {
+    mutateAsync: import("../types").ErrorSuppressedMutateFunction<import("../../../../services").ApiAsset | undefined, Error, UpdateAssetData, unknown>;
+    data: undefined;
+    error: null;
+    isError: false;
+    isIdle: false;
+    isLoading: true;
+    isSuccess: false;
+    status: "loading";
+    mutate: import("@tanstack/react-query").UseMutateFunction<import("../../../../services").ApiAsset | undefined, Error, UpdateAssetData, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    variables: UpdateAssetData | undefined;
+} | {
+    mutateAsync: import("../types").ErrorSuppressedMutateFunction<import("../../../../services").ApiAsset | undefined, Error, UpdateAssetData, unknown>;
+    data: undefined;
+    error: Error;
+    isError: true;
+    isIdle: false;
+    isLoading: false;
+    isSuccess: false;
+    status: "error";
+    mutate: import("@tanstack/react-query").UseMutateFunction<import("../../../../services").ApiAsset | undefined, Error, UpdateAssetData, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    variables: UpdateAssetData | undefined;
+} | {
+    mutateAsync: import("../types").ErrorSuppressedMutateFunction<import("../../../../services").ApiAsset | undefined, Error, UpdateAssetData, unknown>;
+    data: import("../../../../services").ApiAsset | undefined;
+    error: null;
+    isError: false;
+    isIdle: false;
+    isLoading: false;
+    isSuccess: true;
+    status: "success";
+    mutate: import("@tanstack/react-query").UseMutateFunction<import("../../../../services").ApiAsset | undefined, Error, UpdateAssetData, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    variables: UpdateAssetData | undefined;
+};
+export {};

package/dist/providers/data/hooks/assets/useUpdateAssetLastUse.d.ts

@@ -0,0 +1,71 @@
+import { ApiUpdateLastUseAssetsPayload } from '../../../../services';
+/**
+ * Creates update asset's last use date mutation.
+ *
+ * @returns mutation for updating asset
+ */
+export declare const useUpdateAssetLastUse: () => {
+    mutateAsync: import("../types").ErrorSuppressedMutateFunction<void, Error, ApiUpdateLastUseAssetsPayload, unknown>;
+    data: undefined;
+    error: null;
+    isError: false;
+    isIdle: true;
+    isLoading: false;
+    isSuccess: false;
+    status: "idle";
+    mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, ApiUpdateLastUseAssetsPayload, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    variables: ApiUpdateLastUseAssetsPayload | undefined;
+} | {
+    mutateAsync: import("../types").ErrorSuppressedMutateFunction<void, Error, ApiUpdateLastUseAssetsPayload, unknown>;
+    data: undefined;
+    error: null;
+    isError: false;
+    isIdle: false;
+    isLoading: true;
+    isSuccess: false;
+    status: "loading";
+    mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, ApiUpdateLastUseAssetsPayload, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    variables: ApiUpdateLastUseAssetsPayload | undefined;
+} | {
+    mutateAsync: import("../types").ErrorSuppressedMutateFunction<void, Error, ApiUpdateLastUseAssetsPayload, unknown>;
+    data: undefined;
+    error: Error;
+    isError: true;
+    isIdle: false;
+    isLoading: false;
+    isSuccess: false;
+    status: "error";
+    mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, ApiUpdateLastUseAssetsPayload, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    variables: ApiUpdateLastUseAssetsPayload | undefined;
+} | {
+    mutateAsync: import("../types").ErrorSuppressedMutateFunction<void, Error, ApiUpdateLastUseAssetsPayload, unknown>;
+    data: void;
+    error: null;
+    isError: false;
+    isIdle: false;
+    isLoading: false;
+    isSuccess: true;
+    status: "success";
+    mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, ApiUpdateLastUseAssetsPayload, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    variables: ApiUpdateLastUseAssetsPayload | undefined;
+};

package/dist/providers/data/hooks/categories/index.d.ts

@@ -0,0 +1,8 @@
+export * from './useCreateCategory';
+export * from './useDeleteCategory';
+export * from './useGetAdminCategories';
+export * from './useGetCategories';
+export * from './useGetCategory';
+export * from './useStageCategory';
+export * from './useUpdateCategory';
+export * from './useUpdateCategoriesOrder';

package/dist/providers/data/hooks/categories/useCreateCategory.d.ts

@@ -0,0 +1,71 @@
+import { ApiCreateCategoryPayload, ApiCreatedCategoryResponse } from '../../../../services';
+/**
+ * Creates 'create category' mutation.
+ *
+ * @returns mutation for creating category
+ */
+export declare const useCreateCategory: () => {
+    mutateAsync: import("../types").ErrorSuppressedMutateFunction<ApiCreatedCategoryResponse | undefined, Error, ApiCreateCategoryPayload, unknown>;
+    data: undefined;
+    error: null;
+    isError: false;
+    isIdle: true;
+    isLoading: false;
+    isSuccess: false;
+    status: "idle";
+    mutate: import("@tanstack/react-query").UseMutateFunction<ApiCreatedCategoryResponse | undefined, Error, ApiCreateCategoryPayload, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    variables: ApiCreateCategoryPayload | undefined;
+} | {
+    mutateAsync: import("../types").ErrorSuppressedMutateFunction<ApiCreatedCategoryResponse | undefined, Error, ApiCreateCategoryPayload, unknown>;
+    data: undefined;
+    error: null;
+    isError: false;
+    isIdle: false;
+    isLoading: true;
+    isSuccess: false;
+    status: "loading";
+    mutate: import("@tanstack/react-query").UseMutateFunction<ApiCreatedCategoryResponse | undefined, Error, ApiCreateCategoryPayload, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    variables: ApiCreateCategoryPayload | undefined;
+} | {
+    mutateAsync: import("../types").ErrorSuppressedMutateFunction<ApiCreatedCategoryResponse | undefined, Error, ApiCreateCategoryPayload, unknown>;
+    data: undefined;
+    error: Error;
+    isError: true;
+    isIdle: false;
+    isLoading: false;
+    isSuccess: false;
+    status: "error";
+    mutate: import("@tanstack/react-query").UseMutateFunction<ApiCreatedCategoryResponse | undefined, Error, ApiCreateCategoryPayload, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    variables: ApiCreateCategoryPayload | undefined;
+} | {
+    mutateAsync: import("../types").ErrorSuppressedMutateFunction<ApiCreatedCategoryResponse | undefined, Error, ApiCreateCategoryPayload, unknown>;
+    data: ApiCreatedCategoryResponse | undefined;
+    error: null;
+    isError: false;
+    isIdle: false;
+    isLoading: false;
+    isSuccess: true;
+    status: "success";
+    mutate: import("@tanstack/react-query").UseMutateFunction<ApiCreatedCategoryResponse | undefined, Error, ApiCreateCategoryPayload, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    variables: ApiCreateCategoryPayload | undefined;
+};