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

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

@@ -0,0 +1,74 @@
+declare type DeleteCategoryData = {
+    categoryId: string;
+};
+/**
+ * Creates 'delete category' mutation.
+ *
+ * @returns mutation for deleting category
+ */
+export declare const useDeleteCategory: () => {
+    mutateAsync: import("../types").ErrorSuppressedMutateFunction<unknown, Error, DeleteCategoryData, unknown>;
+    data: undefined;
+    error: null;
+    isError: false;
+    isIdle: true;
+    isLoading: false;
+    isSuccess: false;
+    status: "idle";
+    mutate: import("@tanstack/react-query").UseMutateFunction<unknown, Error, DeleteCategoryData, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    variables: DeleteCategoryData | undefined;
+} | {
+    mutateAsync: import("../types").ErrorSuppressedMutateFunction<unknown, Error, DeleteCategoryData, unknown>;
+    data: undefined;
+    error: null;
+    isError: false;
+    isIdle: false;
+    isLoading: true;
+    isSuccess: false;
+    status: "loading";
+    mutate: import("@tanstack/react-query").UseMutateFunction<unknown, Error, DeleteCategoryData, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    variables: DeleteCategoryData | undefined;
+} | {
+    mutateAsync: import("../types").ErrorSuppressedMutateFunction<unknown, Error, DeleteCategoryData, unknown>;
+    data: undefined;
+    error: Error;
+    isError: true;
+    isIdle: false;
+    isLoading: false;
+    isSuccess: false;
+    status: "error";
+    mutate: import("@tanstack/react-query").UseMutateFunction<unknown, Error, DeleteCategoryData, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    variables: DeleteCategoryData | undefined;
+} | {
+    mutateAsync: import("../types").ErrorSuppressedMutateFunction<unknown, Error, DeleteCategoryData, unknown>;
+    data: unknown;
+    error: null;
+    isError: false;
+    isIdle: false;
+    isLoading: false;
+    isSuccess: true;
+    status: "success";
+    mutate: import("@tanstack/react-query").UseMutateFunction<unknown, Error, DeleteCategoryData, unknown>;
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    variables: DeleteCategoryData | undefined;
+};
+export {};

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

@@ -0,0 +1,7 @@
+import { ParsedAdminCategory } from '../../parsers';
+/**
+ * Gets list of admin categories.
+ *
+ * @returns current list of categories
+ */
+export declare const useGetAdminCategories: () => import("@tanstack/react-query").UseQueryResult<ParsedAdminCategory[], Error>;

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

@@ -0,0 +1,6 @@
+/**
+ * Gets list of categories.
+ *
+ * @returns current list of categories
+ */
+export declare const useGetCategories: () => import("@tanstack/react-query").UseQueryResult<import("../../parsers").ParsedCategory[], Error>;

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

@@ -0,0 +1,6 @@
+/**
+ * Gets single category by id.
+ *
+ * @returns category data
+ */
+export declare const useGetCategory: (categoryId: string) => import("@tanstack/react-query").UseQueryResult<import("../../parsers").ParsedCategory, Error>;

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

@@ -0,0 +1,14 @@
+import { ParsedAdminCategory } from '../../parsers';
+/**
+ * Manages cache for categories that are in staging phase.
+ *
+ * This is a set of synchronous methods.
+ *
+ * @returns cache mutation
+ */
+export declare const useStageCategory: () => {
+    stageCategory: (category: Omit<ParsedAdminCategory, 'id'>) => void;
+    deleteCategory: (id: string) => void;
+    editCategory: (id: string) => void;
+    unstageCategory: (id: string) => void;
+};

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

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

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

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

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

@@ -0,0 +1,3 @@
+export * from './useApiErrors';
+export * from './useAssetErrors';
+export * from './useCategoryErrors';

package/dist/providers/data/hooks/errors/useApiErrors.d.ts

@@ -0,0 +1,4 @@
+import { ApiErrorHandlers } from '../../../../services';
+export declare const useApiErrors: () => {
+    handleApiError: (error: Error, errorHandlers?: ApiErrorHandlers | undefined) => void;
+};

package/dist/providers/data/hooks/errors/useAssetErrors.d.ts

@@ -0,0 +1,3 @@
+export declare const useAssetErrors: () => {
+    pushMissingAssetErrorNotification: () => void;
+};

package/dist/providers/data/hooks/errors/useCategoryErrors.d.ts

@@ -0,0 +1,3 @@
+export declare const useCategoryErrors: () => {
+    pushMissingCategoryErrorNotification: () => void;
+};

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

@@ -0,0 +1,2 @@
+export * from './useGetImagesConfig';
+export * from './useUpdateImageFormatConfig';

package/dist/providers/data/hooks/images/useGetImagesConfig.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Returns images configuration.
+ *
+ * @returns images configuration
+ */
+export declare const useGetImagesConfig: () => import("@tanstack/react-query").UseQueryResult<Record<string, import("../../../../services").Maybe<import("../../../../services").ApiImageFormatConfig>>, Error>;

package/dist/providers/data/hooks/images/useUpdateImageFormatConfig.d.ts

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

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

@@ -0,0 +1,5 @@
+export * from './assets';
+export * from './categories';
+export * from './images';
+export * from './limits';
+export * from './search';

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

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

package/dist/providers/data/hooks/limits/useGetPlanLimits.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Manages an environment plan limits.
+ *
+ * @returns details of plan limits.
+ */
+export declare const useGetPlanLimits: () => import("@tanstack/react-query").UseQueryResult<import("../../../../services").ApiPlanLimits | undefined, Error>;

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

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

package/dist/providers/data/hooks/search/useSearch.d.ts

@@ -0,0 +1,12 @@
+import { ApiSearchParams } from '../../../../services';
+/**
+ * Creates a search query.
+ *
+ * @returns search results
+ */
+export declare const useSearch: (searchQuery: ApiSearchParams) => import("@tanstack/react-query").UseQueryResult<{
+    totalCount: number | undefined;
+    limit: number | undefined;
+    offset: number | undefined;
+    items: import("../../parsers").ParsedAsset[];
+}, Error>;

package/dist/providers/data/hooks/useMutation.d.ts

@@ -0,0 +1,67 @@
+import { MutationFunction } from '@tanstack/react-query';
+import { UseExtendedMutationOptions, ErrorSuppressedMutateFunction } from './types';
+export declare const useMutation: <TData = unknown, TError extends Error = Error, TVariables = void, TContext = unknown>(mutationFn: MutationFunction<TData, TVariables>, options?: UseExtendedMutationOptions<TData, TError, TVariables, TContext> | undefined) => {
+    mutateAsync: ErrorSuppressedMutateFunction<TData, TError, TVariables, TContext>;
+    data: undefined;
+    error: null;
+    isError: false;
+    isIdle: true;
+    isLoading: false;
+    isSuccess: false;
+    status: "idle";
+    mutate: import("@tanstack/react-query").UseMutateFunction<TData, TError, TVariables, TContext>;
+    reset: () => void;
+    context: TContext | undefined;
+    failureCount: number;
+    failureReason: TError | null;
+    isPaused: boolean;
+    variables: TVariables | undefined;
+} | {
+    mutateAsync: ErrorSuppressedMutateFunction<TData, TError, TVariables, TContext>;
+    data: undefined;
+    error: null;
+    isError: false;
+    isIdle: false;
+    isLoading: true;
+    isSuccess: false;
+    status: "loading";
+    mutate: import("@tanstack/react-query").UseMutateFunction<TData, TError, TVariables, TContext>;
+    reset: () => void;
+    context: TContext | undefined;
+    failureCount: number;
+    failureReason: TError | null;
+    isPaused: boolean;
+    variables: TVariables | undefined;
+} | {
+    mutateAsync: ErrorSuppressedMutateFunction<TData, TError, TVariables, TContext>;
+    data: undefined;
+    error: TError;
+    isError: true;
+    isIdle: false;
+    isLoading: false;
+    isSuccess: false;
+    status: "error";
+    mutate: import("@tanstack/react-query").UseMutateFunction<TData, TError, TVariables, TContext>;
+    reset: () => void;
+    context: TContext | undefined;
+    failureCount: number;
+    failureReason: TError | null;
+    isPaused: boolean;
+    variables: TVariables | undefined;
+} | {
+    mutateAsync: ErrorSuppressedMutateFunction<TData, TError, TVariables, TContext>;
+    data: TData;
+    error: null;
+    isError: false;
+    isIdle: false;
+    isLoading: false;
+    isSuccess: true;
+    status: "success";
+    mutate: import("@tanstack/react-query").UseMutateFunction<TData, TError, TVariables, TContext>;
+    reset: () => void;
+    context: TContext | undefined;
+    failureCount: number;
+    failureReason: TError | null;
+    isPaused: boolean;
+    variables: TVariables | undefined;
+};

package/dist/providers/data/hooks/useQuery.d.ts

@@ -0,0 +1,3 @@
+import { QueryFunction, QueryKey } from '@tanstack/react-query';
+import { UseExtendedQueryOptions } from './types';
+export declare const useQuery: <TQueryFnData = unknown, TError extends Error = Error, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: UseExtendedQueryOptions<TQueryFnData, TError, TData, TQueryKey> | undefined) => import("@tanstack/react-query").UseQueryResult<TData, TError>;

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

@@ -0,0 +1,2 @@
+export * from './hooks';
+export * from './parsers';

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

@@ -0,0 +1,3 @@
+export * from './parseAsset';
+export * from './parseAssets';
+export * from './types';

package/dist/providers/data/parsers/assets/parseAsset.d.ts

@@ -0,0 +1,9 @@
+import { ApiAsset } from '../../../../services';
+import { ParsedAsset } from './types';
+/**
+ * Parses asset from API. Provides fallback value if needed.
+ *
+ * @param asset asset to parse
+ * @returns parsed asset
+ */
+export declare const parseAsset: (asset?: ApiAsset) => ParsedAsset;

package/dist/providers/data/parsers/assets/parseAssets.d.ts

@@ -0,0 +1,9 @@
+import { ApiAsset } from '../../../../services';
+import { ParsedAsset } from './types';
+/**
+ * Parses a list of assets. Provides fallback if needed.
+ *
+ * @param assets list of assets to parse
+ * @returns list of parsed assets
+ */
+export declare const parseAssets: (assets?: ApiAsset[]) => ParsedAsset[];

package/dist/providers/data/parsers/assets/types.d.ts

@@ -0,0 +1,39 @@
+import { ParsedAssetMetadata } from '../assetsMetadata';
+export interface ParsedAsset {
+    /**
+     * Asset id.
+     */
+    id: string;
+    /**
+     * Asset name.
+     */
+    name: string;
+    /**
+     * Asset file extension.
+     */
+    extension: string;
+    /**
+     * Converted asset size.
+     */
+    size?: number;
+    /**
+     * Asset last modification time.
+     */
+    lastModifiedAt?: string;
+    /**
+     * Asset upload date.
+     */
+    uploadedAt?: string;
+    /**
+     * Asset metadata.
+     */
+    metadata: ParsedAssetMetadata;
+    /**
+     * Asset category id.
+     */
+    categoryId: string;
+    /**
+     * Asset tags.
+     */
+    tags: string[];
+}

package/dist/providers/data/parsers/assetsMetadata/index.d.ts

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

package/dist/providers/data/parsers/assetsMetadata/parseAssetMetadata.d.ts

@@ -0,0 +1,9 @@
+import { ApiAssetMetadata } from '../../../../services';
+import { ParsedAssetMetadata } from './types';
+/**
+ * Parses asset's metadata. Provides fallback values if necessary.
+ *
+ * @param metadata asset's metadata to parse
+ * @returns parsed metadata
+ */
+export declare const parseAssetMetadata: (metadata?: ApiAssetMetadata) => ParsedAssetMetadata;

package/dist/providers/data/parsers/assetsMetadata/types.d.ts

@@ -0,0 +1,22 @@
+export interface ParsedAssetMetadata {
+    /**
+     * Asset blurhash.
+     */
+    blurHash?: string;
+    /**
+     * Asset description.
+     */
+    description: string;
+    /**
+     * Asset width in px.
+     */
+    width?: number;
+    /**
+     * Asset height in px.
+     */
+    height?: number;
+    /**
+     * Set of custom attributes.
+     */
+    customAttributes?: Record<string, unknown>;
+}

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

@@ -0,0 +1,4 @@
+export * from './parseAdminCategories';
+export * from './parseCategories';
+export * from './parseCategory';
+export * from './types';

package/dist/providers/data/parsers/categories/parseAdminCategories.d.ts

@@ -0,0 +1,13 @@
+import { ApiAdminCategories } from '../../../../services';
+import { ParsedAdminCategory } from './types';
+/**
+ * Parses admin categories from API. Merges them with existing ones. Provides fallbacks if needed.
+ *
+ * Categories fetched from the backend must be merged manully with existing ones.
+ * This is due to the fact that new categories might be in staging phase, e.g. newly added or updated categories (but not saved yet).
+ *
+ * @param categories categories from API
+ * @param cachedCategories cached categories
+ * @returns parsed categories
+ */
+export declare const parseAdminCategories: (categories?: ApiAdminCategories, cachedCategories?: ParsedAdminCategory[]) => ParsedAdminCategory[];

package/dist/providers/data/parsers/categories/parseCategories.d.ts

@@ -0,0 +1,9 @@
+import { ApiCategory, Maybe } from '../../../../services';
+import { ParsedCategory } from './types';
+/**
+ * Parses a list of categories. Provides fallback if needed.
+ *
+ * @param categories categories from API
+ * @returns parsed category
+ */
+export declare const parseCategories: (categories: Maybe<ApiCategory[]>) => ParsedCategory[];

package/dist/providers/data/parsers/categories/parseCategory.d.ts

@@ -0,0 +1,9 @@
+import { ApiCategory, Maybe } from '../../../../services';
+import { ParsedCategory } from './types';
+/**
+ * Parses API category.
+ *
+ * @param category category from API
+ * @returns parsed category
+ */
+export declare const parseCategory: (category: Maybe<ApiCategory>) => ParsedCategory;