@tridion-sites/extensions 2.0.2 → 3.1.0

package/dist/dts/api/general/queries/item/useItemDefaultDataQuery.d.ts

@@ -1,26 +0,0 @@
-import type { ApiError, IdentifiableObject, ItemType, ItemUri } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * Model type for which default data can be retrieved.
- *
- * @public
- */
-export type DefaultModelType = Extract<ItemType, 'bundle' | 'searchFolder' | 'schema' | 'page' | 'pageTemplate' | 'component' | 'componentTemplate' | 'folder' | 'keyword' | 'structureGroup' | 'templateBuildingBlock' | 'publication' | 'keywordCategory' | 'userGroup' | 'processDefinition' | 'businessProcessType' | 'multimediaType' | 'user' | 'targetGroup'>;
-/**
- * @public
- */
-export interface ItemDefaultDataQueryProps {
-    /**
-     * Type of the model to get default data for.
-     */
-    modelType: DefaultModelType;
-    /**
-     * A container ID is required for all types except the following: `Batch`, `Publication`, `PublicationTarget`, `PublishTransaction`, `TargetType`, `MultimediaType`, `WorkflowType`, `User`, `Group`, and `ApprovalStatus`.
-     */
-    containerId?: ItemUri;
-}
-/**
- * @public
- */
-export type ItemDefaultDataQueryHook = <TItem extends IdentifiableObject>(props: ItemDefaultDataQueryProps | undefined, options?: QueryOptions<TItem | undefined, ApiError>) => QueryResult<TItem | undefined, ApiError>;

package/dist/dts/api/general/queries/item/useItemHistoryQuery.d.ts

@@ -1,16 +0,0 @@
-import type { ApiError, ItemUri, VersionedItem } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export interface ItemHistoryQueryProps {
-    /**
-     * Identifies the item for which History is being retrieved.
-     */
-    itemId: ItemUri;
-}
-/**
- * @public
- */
-export type ItemHistoryQueryHook = (props: ItemHistoryQueryProps | undefined, options?: QueryOptions<ReadonlyArray<VersionedItem> | undefined, ApiError>) => QueryResult<ReadonlyArray<VersionedItem> | undefined, ApiError>;

package/dist/dts/api/general/queries/item/useItemPublishUrlsQuery.d.ts

@@ -1,16 +0,0 @@
-import type { ApiError, ItemUri, PublishUrlInfo } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export interface ItemPublishUrlsQueryProps {
-    /**
-     * Identifies the item for which Publish URLs are being retrieved.
-     */
-    itemId: ItemUri;
-}
-/**
- * @public
- */
-export type ItemPublishUrlsQueryHook = (props: ItemPublishUrlsQueryProps | undefined, options?: QueryOptions<ReadonlyArray<PublishUrlInfo> | undefined, ApiError>) => QueryResult<ReadonlyArray<PublishUrlInfo> | undefined, ApiError>;

package/dist/dts/api/general/queries/item/useItemPublishedPagesQuery.d.ts

@@ -1,16 +0,0 @@
-import type { ApiError, ItemUri, Page } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export interface ItemPublishedPagesQueryProps {
-    /**
-     * Identifies the item for which published pages will be requested.
-     */
-    itemId: ItemUri;
-}
-/**
- * @public
- */
-export type ItemPublishedPagesQueryHook = (props: ItemPublishedPagesQueryProps | undefined, options?: QueryOptions<ReadonlyArray<Page> | undefined, ApiError>) => QueryResult<ReadonlyArray<Page> | undefined, ApiError>;

package/dist/dts/api/general/queries/item/useItemPublishedToQuery.d.ts

@@ -1,16 +0,0 @@
-import type { ApiError, ItemUri, PublishInfo } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export interface ItemPublishedToQueryProps {
-    /**
-     * ID of the published item.
-     */
-    itemId: ItemUri;
-}
-/**
- * @public
- */
-export type ItemPublishedToQueryHook = (props: ItemPublishedToQueryProps | undefined, options?: QueryOptions<ReadonlyArray<PublishInfo> | undefined, ApiError>) => QueryResult<ReadonlyArray<PublishInfo> | undefined, ApiError>;

package/dist/dts/api/general/queries/item/useItemQuery.d.ts

@@ -1,20 +0,0 @@
-import type { ApiError, IdentifiableObject, ItemUri } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export interface ItemQueryProps {
-    /**
-     * ID of an item to get.
-     */
-    itemId: ItemUri;
-    /**
-     * Option to request dynamic item (v0) if it's available.
-     */
-    useDynamicVersion?: boolean;
-}
-/**
- * @public
- */
-export type ItemQueryHook = <TItem extends IdentifiableObject>(props: ItemQueryProps | undefined, options?: QueryOptions<TItem | undefined, ApiError>) => QueryResult<TItem | undefined, ApiError>;

package/dist/dts/api/general/queries/item/useItemTranslationInfoQuery.d.ts

@@ -1,16 +0,0 @@
-import type { ApiError, ItemUri, TranslationInfo } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export interface ItemTranslationInfoQueryProps {
-    /**
-     * Identifies the item for which Translation Info is being retrieved.
-     */
-    itemId: ItemUri;
-}
-/**
- * @public
- */
-export type ItemTranslationInfoQueryHook = (props: ItemTranslationInfoQueryProps | undefined, options?: QueryOptions<TranslationInfo | undefined, ApiError>) => QueryResult<TranslationInfo | undefined, ApiError>;

package/dist/dts/api/general/queries/item/useItemUsedByQuery.d.ts

@@ -1,25 +0,0 @@
-import type { ApiError, IdentifiableObject, ItemUri } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export interface ItemUsedByQueryProps {
-    /**
-     * Identifies the item for which 'Used By' dependencies are being retrieved.
-     */
-    itemId: ItemUri;
-    /**
-     * Set to true to include local copies of the specified item in the response.
-     */
-    includeLocalCopies?: boolean;
-    /**
-     * To limit the response to items that currently use the specified item,
-     * set this option to `true`.
-     */
-    onlyLatestVersion?: boolean;
-}
-/**
- * @public
- */
-export type ItemUsedByQueryHook = <TItem extends IdentifiableObject>(props: ItemUsedByQueryProps | undefined, options?: QueryOptions<ReadonlyArray<TItem> | undefined, ApiError>) => QueryResult<ReadonlyArray<TItem> | undefined, ApiError>;

package/dist/dts/api/general/queries/item/useItemUsesQuery.d.ts

@@ -1,21 +0,0 @@
-import type { ApiError, IdentifiableObject, ItemUri } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export interface ItemUsesQueryProps {
-    /**
-     * Identifies the item for which 'Uses' dependencies are being retrieved.
-     */
-    itemId: ItemUri;
-    /**
-     * To include the BluePrint parent of a local copy in the response,
-     * set this option to `true`.
-     */
-    includeBlueprintParentItem?: boolean;
-}
-/**
- * @public
- */
-export type ItemUsesQueryHook = <TItem extends IdentifiableObject>(props: ItemUsesQueryProps | undefined, options?: QueryOptions<ReadonlyArray<TItem> | undefined, ApiError>) => QueryResult<ReadonlyArray<TItem> | undefined, ApiError>;

package/dist/dts/api/general/queries/item/useItemsQuery.d.ts

@@ -1,28 +0,0 @@
-import type { ApiError, IdentifiableObject, ItemUri } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export interface ItemsQueryProps {
-    /**
-     * IDs of items to request.
-     */
-    itemIds: ReadonlyArray<ItemUri>;
-    /**
-     * Option to request dynamic item (v0) if it's available.
-     */
-    useDynamicVersion?: boolean;
-    /**
-     * By default list includes contentless items. Some of the properties might be missed.
-     * This option allows to include all available fields.
-     *
-     * @example
-     * When `false` - Component item will be returned without `content` property.
-     */
-    loadFullItems?: boolean;
-}
-/**
- * @public
- */
-export type ItemsQueryHook = <TItem extends IdentifiableObject>(props: ItemsQueryProps | undefined, options?: QueryOptions<ReadonlyArray<TItem> | undefined, ApiError>) => QueryResult<ReadonlyArray<TItem> | undefined, ApiError>;

package/dist/dts/api/general/queries/item/usePublicationBlueprintHierarchyQuery.d.ts

@@ -1,20 +0,0 @@
-import type { ApiError, ItemUri, ListDetailsLevel, PublicationBlueprintHierarchy } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export interface PublicationBlueprintHierarchyQueryProps {
-    /**
-     * Identifies the item for which Blueprint hierarchy is being retrieved.
-     */
-    publicationId: ItemUri;
-    /**
-     * Option to control how much data is returned per item.
-     */
-    detailsLevel?: ListDetailsLevel;
-}
-/**
- * @public
- */
-export type PublicationBlueprintHierarchyQueryHook = (props: PublicationBlueprintHierarchyQueryProps | undefined, options?: QueryOptions<PublicationBlueprintHierarchy | undefined, ApiError>) => QueryResult<PublicationBlueprintHierarchy | undefined, ApiError>;

package/dist/dts/api/general/queries/lists/index.d.ts

@@ -1,6 +0,0 @@
-export * from './useContainerItems';
-export * from './useFavoritesQuery';
-export * from './useItemsInProgressQuery';
-export * from './usePublicationsQuery';
-export * from './useUserGroupsQuery';
-export * from './useUsersQuery';

package/dist/dts/api/general/queries/lists/useContainerItems.d.ts

@@ -1,32 +0,0 @@
-import type { ApiError, ItemUri, ListDetailsLevel, RepositoryLocalObject, RloItemType } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export interface ContainerItemsQueryProps {
-    /**
-     * The Item URI of an organizational item, such as a Bundle, Category, Folder, Virtual folder, or Structure Group.
-     */
-    itemId: ItemUri;
-    /**
-     * Loads a dynamic version (if available for the current user)
-     */
-    useDynamicVersion?: boolean;
-    /**
-     * The item types of all repository-local objects that you want to include in the response.
-     */
-    rloItemTypes?: ReadonlyArray<RloItemType>;
-    /**
-     * Option to control how much data is returned per item.
-     */
-    detailsLevel?: ListDetailsLevel;
-    /**
-     * Determines if nested Organizational Items (recursively) should also be returned.
-     */
-    isRecursive?: boolean;
-}
-/**
- * @public
- */
-export type ContainerItemsQueryHook = (props?: ContainerItemsQueryProps, options?: QueryOptions<ReadonlyArray<RepositoryLocalObject> | undefined, ApiError>) => QueryResult<ReadonlyArray<RepositoryLocalObject> | undefined, ApiError>;

package/dist/dts/api/general/queries/lists/useFavoritesQuery.d.ts

@@ -1,7 +0,0 @@
-import type { ApiError, IdentifiableObject } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export type FavoritesQueryHook = (options?: QueryOptions<ReadonlyArray<IdentifiableObject> | undefined, ApiError>) => QueryResult<ReadonlyArray<IdentifiableObject> | undefined, ApiError>;

package/dist/dts/api/general/queries/lists/useItemsInProgressQuery.d.ts

@@ -1,25 +0,0 @@
-import type { ApiError, ItemUri, VersionedItem } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export interface ItemsInProgressQueryProps {
-    /**
-     * Option to include items that are in progress by any user, but only in Publications where the user has Publication Administration or Lock Management Rights (unless the user has System Administration privileges).
-     * By default, only items locked by the current user are returned.
-     */
-    forAllUsers?: boolean;
-    /**
-     * Specifies the maximum number of results to return.
-     */
-    maxResults?: number;
-    /**
-     * Option to filter results by specified user id.
-     */
-    lockUserId?: ItemUri;
-}
-/**
- * @public
- */
-export type ItemsInProgressQueryHook = (props?: ItemsInProgressQueryProps, options?: QueryOptions<ReadonlyArray<VersionedItem> | undefined, ApiError>) => QueryResult<ReadonlyArray<VersionedItem> | undefined, ApiError>;

package/dist/dts/api/general/queries/lists/usePublicationsQuery.d.ts

@@ -1,7 +0,0 @@
-import type { ApiError, Publication } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export type PublicationsQueryHook = (options?: QueryOptions<ReadonlyArray<Publication> | undefined, ApiError>) => QueryResult<ReadonlyArray<Publication> | undefined, ApiError>;

package/dist/dts/api/general/queries/lists/useUserGroupsQuery.d.ts

@@ -1,33 +0,0 @@
-import type { ApiError, ItemUri, StringSearchMode, UserGroup } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export type UserGroupsQuerySearchMode = StringSearchMode;
-/**
- * @public
- */
-export interface UserGroupsQueryProps {
-    /**
-     * If specified, return only groups which are scoped to the Publication ID.
-     */
-    inPublicationId?: ItemUri;
-    /**
-     * Specifies whether the special "Everyone" Group (representing all CM users) should be returned.
-     */
-    includeEveryone?: boolean;
-    /**
-     * If specified, return only groups with titles matching this value.
-     */
-    search?: string;
-    /**
-     * Specifies how to match on the group title.
-     * @defaultValue Contains
-     */
-    searchMode?: UserGroupsQuerySearchMode;
-}
-/**
- * @public
- */
-export type UserGroupsQueryHook = (props?: UserGroupsQueryProps, options?: QueryOptions<ReadonlyArray<UserGroup> | undefined, ApiError>) => QueryResult<ReadonlyArray<UserGroup> | undefined, ApiError>;

package/dist/dts/api/general/queries/lists/useUsersQuery.d.ts

@@ -1,38 +0,0 @@
-import type { ApiError, StringSearchMode, User } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export type UsersQuerySearchMode = StringSearchMode;
-/**
- * @public
- */
-export interface UsersQueryProps {
-    /**
-     * If specified, return only non-predefined users or predefined users.
-     *
-     * @example
-     * - `undefined` - all of the users returned
-     * - `true` - predefined only users returned
-     * - `false` - non-predefined only users returned
-     */
-    predefined?: boolean;
-    /**
-     * Specifies whether to include disabled user accounts. These are excluded by default.
-     */
-    includeDisabled?: boolean;
-    /**
-     * If specified, return only users whose account name (Title) matches this value.
-     */
-    search?: string;
-    /**
-     * Specifies how to match on the account name.
-     * @defaultValue Contains
-     */
-    searchMode?: UsersQuerySearchMode;
-}
-/**
- * @public
- */
-export type UsersQueryHook = (props?: UsersQueryProps, options?: QueryOptions<ReadonlyArray<User> | undefined, ApiError>) => QueryResult<ReadonlyArray<User> | undefined, ApiError>;

package/dist/dts/api/general/queries/loadingState.d.ts

@@ -1,10 +0,0 @@
-/**
- * @public
- */
-export interface LoadingState {
-    isFirstTimeLoading: boolean;
-    isLoading: boolean;
-    isReloading: boolean;
-    isLoaded: boolean;
-    isError: boolean;
-}

package/dist/dts/api/general/queries/publishing/index.d.ts

@@ -1,5 +0,0 @@
-export * from './useItemsToPublishQuery';
-export * from './useItemsToUnpublishQuery';
-export * from './usePublishableTargetTypesQuery';
-export * from './usePublishTransactionsQuery';
-export * from './useTargetTypesQuery';

package/dist/dts/api/general/queries/publishing/useItemsToPublishQuery.d.ts

@@ -1,8 +0,0 @@
-import type { ApiError, ResolvedItem } from '@tridion-sites/models';
-import type { PublishItemsRequest } from '../../mutations/item/usePublishItemsMutation';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export type ItemsToPublishQueryHook = (props: PublishItemsRequest | undefined, options?: QueryOptions<ResolvedItem[] | undefined, ApiError>) => QueryResult<ResolvedItem[] | undefined, ApiError>;

package/dist/dts/api/general/queries/publishing/useItemsToUnpublishQuery.d.ts

@@ -1,8 +0,0 @@
-import type { ApiError, ResolvedItem } from '@tridion-sites/models';
-import type { UnpublishItemsRequest } from '../../mutations/item/useUnpublishItemsMutation';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export type ItemsToUnpublishQueryHook = (props: UnpublishItemsRequest | undefined, options?: QueryOptions<ResolvedItem[] | undefined, ApiError>) => QueryResult<ResolvedItem[] | undefined, ApiError>;

package/dist/dts/api/general/queries/publishing/usePublishTransactionsQuery.d.ts

@@ -1,40 +0,0 @@
-import type { ApiError, ListInfoDictionary, PublishPriority, PublishTransaction, PublishTransactionState, TcmUri } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export interface PublishTransactionsQueryProps {
-    /**
-     * Option to filter transactions for specific publication.
-     */
-    publicationId?: TcmUri;
-    /**
-     * Option to filter transactions for specific Target Type.
-     */
-    targetTypeId?: TcmUri;
-    /**
-     * Option to filter transaction created by specific User.
-     */
-    userId?: TcmUri;
-    /**
-     * Option to filter transactions prior to specified date.
-     */
-    endDate?: Date;
-    /**
-     * Option to filter transactions following specified date.
-     */
-    startDate?: Date;
-    /**
-     * Option to filter transactions based ot it's state.
-     */
-    state?: PublishTransactionState;
-    /**
-     * Option to filter transactions with specific priority.
-     */
-    priority?: PublishPriority;
-}
-/**
- * @public
- */
-export type PublishTransactionsQueryHook = <TListInfo extends ListInfoDictionary>(props: PublishTransactionsQueryProps | undefined, options?: QueryOptions<ReadonlyArray<PublishTransaction<TListInfo>> | undefined, ApiError>) => QueryResult<ReadonlyArray<PublishTransaction<TListInfo>> | undefined, ApiError>;

package/dist/dts/api/general/queries/publishing/usePublishableTargetTypesQuery.d.ts

@@ -1,16 +0,0 @@
-import type { ApiError, ItemUri, TargetType } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export interface PublishableTargetTypesQueryProps {
-    /**
-     * Identifies the Business Process Type for which Target Types are being retrieved.
-     */
-    businessProcessTypeId: ItemUri;
-}
-/**
- * @public
- */
-export type PublishableTargetTypesQueryHook = (props: PublishableTargetTypesQueryProps | undefined, options?: QueryOptions<ReadonlyArray<TargetType> | undefined, ApiError>) => QueryResult<ReadonlyArray<TargetType> | undefined, ApiError>;

package/dist/dts/api/general/queries/publishing/useTargetTypesQuery.d.ts

@@ -1,7 +0,0 @@
-import type { ApiError, TargetType } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export type TargetTypesQueryHook = (options?: QueryOptions<ReadonlyArray<TargetType> | undefined, ApiError>) => QueryResult<ReadonlyArray<TargetType> | undefined, ApiError>;

package/dist/dts/api/general/queries/queryOptions.d.ts

@@ -1,67 +0,0 @@
-/**
- * @public
- */
-export type NonFunctionGuard<T> = T extends Function ? never : T;
-/**
- * @public
- */
-export interface QueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData> {
-    retry?: boolean | number | ((failureCount: number, error: TError) => boolean);
-    retryDelay?: number | ((failureCount: number, error: TError) => number);
-    initialData?: TData | (() => TData | undefined);
-    initialDataUpdatedAt?: number | (() => number | undefined);
-    meta?: Record<string, unknown>;
-    /**
-     * Set this to `false` to disable automatic refetching when the query mounts or changes query keys.
-     * To refetch the query, use the `refetch` method returned from the `useQuery` instance.
-     * Defaults to `true`.
-     */
-    enabled?: boolean;
-    /**
-     * The time in milliseconds after data is considered stale.
-     * If set to `Infinity`, the data will never be considered stale.
-     */
-    staleTime?: number;
-    /**
-     * If set to a number, the query will continuously refetch at this frequency in milliseconds.
-     * If set to a function, the function will be executed with the latest data and query to compute a frequency.
-     * Defaults to `false`.
-     */
-    refetchInterval?: number | false;
-    /**
-     * If set to `true`, the query will continue to refetch while their tab/window is in the background.
-     * Defaults to `false`.
-     */
-    refetchIntervalInBackground?: boolean;
-    /**
-     * If set to `true`, the query will refetch on window focus if the data is stale.
-     * If set to `false`, the query will not refetch on window focus.
-     * If set to `'always'`, the query will always refetch on window focus.
-     * Defaults to `true`.
-     */
-    refetchOnWindowFocus?: boolean | 'always';
-    /**
-     * If set to `true`, the query will refetch on reconnect if the data is stale.
-     * If set to `false`, the query will not refetch on reconnect.
-     * If set to `'always'`, the query will always refetch on reconnect.
-     * If set to a function, the function will be executed with the latest data and query to compute the value.
-     * Defaults to the value of `networkOnline` (`true`)
-     */
-    refetchOnReconnect?: boolean | 'always';
-    /**
-     * If set to `true`, the query will refetch on mount if the data is stale.
-     * If set to `false`, will disable additional instances of a query to trigger background refetches.
-     * If set to `'always'`, the query will always refetch on mount.
-     * Defaults to `true`.
-     */
-    refetchOnMount?: boolean | 'always';
-    /**
-     * If set to `false`, the query will not be retried on mount if it contains an error.
-     * Defaults to `true`.
-     */
-    retryOnMount?: boolean;
-    /**
-     * If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `loading` data and no initialData has been provided.
-     */
-    placeholderData?: NonFunctionGuard<TQueryFnData> | ((previousData: TData | undefined) => NonFunctionGuard<TQueryFnData> | undefined);
-}

package/dist/dts/api/general/queries/queryResult.d.ts

@@ -1,93 +0,0 @@
-/**
- * @public
- */
-export type QueryStatus = 'pending' | 'error' | 'success';
-/**
- * @public
- */
-export type QueryFetchStatus = 'fetching' | 'paused' | 'idle';
-/**
- * @public
- */
-export interface RefetchOptions {
-    cancelRefetch?: boolean;
-    throwOnError?: boolean;
-}
-/**
- * @public
- */
-export interface QueryResult<TData = unknown, TError = unknown> {
-    /**
-     * The last successfully resolved data for the query.
-     */
-    data: TData | undefined;
-    /**
-     * The timestamp for when the query most recently returned the `status` as `success`.
-     */
-    dataUpdatedAt: number;
-    /**
-     * The error object for the query, if an error was thrown.
-     */
-    error: TError | null;
-    /**
-     * The timestamp for when the query most recently returned the `status` as `error`.
-     */
-    errorUpdatedAt: number;
-    failureCount: number;
-    /**
-     * The failure reason for the query retry.
-     * Reset to null when the query succeeds.
-     */
-    failureReason: TError | null;
-    /**
-     * The sum of all errors.
-     */
-    errorUpdateCount: number;
-    isError: boolean;
-    /**
-     * Will be true if the query has been fetched.
-     */
-    isFetched: boolean;
-    /**
-     * Will be true if the query has been fetched after the component mounted.
-     * This property can be used to not show any previously cached data.
-     */
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isPending: boolean;
-    isLoading: boolean;
-    isLoadingError: boolean;
-    isPaused: boolean;
-    /**
-     * Will be `true` if the data shown is the placeholder data.
-     */
-    isPlaceholderData: boolean;
-    /**
-     * Will be `true` if the query failed while fetching for the first time.
-     */
-    isRefetchError: boolean;
-    /**
-     * Is `true` whenever a background refetch is in-flight, which does not include initial loading.
-     */
-    isRefetching: boolean;
-    /**
-     * Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.
-     */
-    isStale: boolean;
-    isSuccess: boolean;
-    refetch: (options?: RefetchOptions) => Promise<QueryResult<TData, TError>>;
-    /**
-     * - `loading` - if there's no cached data and no query attempt was finished yet.
-     * - `error` - if the query attempt resulted in an error. The corresponding error property has the error received from the attempted fetch.
-     * - `success` - if the query has received a response with no errors and is ready to display its data.
-     * The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false`
-     * and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.
-     */
-    status: QueryStatus;
-    /**
-     * - `fetching` - Is true whenever the queryFn is executing, which includes initial loading as well as background refetches.
-     * - `paused` - The query wanted to fetch, but has been paused.
-     * - `idle` - The query is not fetching.
-     */
-    fetchStatus: QueryFetchStatus;
-}