diff --git a/.prettierignore b/.prettierignore index 928bbaada59..0d948ff1e54 100644 --- a/.prettierignore +++ b/.prettierignore @@ -8,6 +8,3 @@ pnpm-lock.yaml packages/**/tsup.config.bundled*.mjs **/tsconfig.vitest-temp.json - -# API Extractor report -packages/angular-query-experimental/etc/*.md diff --git a/packages/angular-query-experimental/config/api-extractor.json b/packages/angular-query-experimental/config/api-extractor.json deleted file mode 100644 index dd9a7a854f8..00000000000 --- a/packages/angular-query-experimental/config/api-extractor.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", - - "mainEntryPointFilePath": "/build/index.d.ts", - - "newlineKind": "lf", - - "apiReport": { - "enabled": true - }, - - "docModel": { - "enabled": false - }, - - "dtsRollup": { - "enabled": true, - "untrimmedFilePath": "/build/rollup.d.ts" - }, - - "tsdocMetadata": { - "enabled": false - } -} diff --git a/packages/angular-query-experimental/etc/angular-query-experimental.api.md b/packages/angular-query-experimental/etc/angular-query-experimental.api.md deleted file mode 100644 index 77ad2763f21..00000000000 --- a/packages/angular-query-experimental/etc/angular-query-experimental.api.md +++ /dev/null @@ -1,297 +0,0 @@ -## API Report File for "@tanstack/angular-query-experimental" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import type { DataTag } from '@tanstack/query-core'; -import type { DefaultError } from '@tanstack/query-core'; -import type { DefinedInfiniteQueryObserverResult } from '@tanstack/query-core'; -import type { DefinedQueryObserverResult } from '@tanstack/query-core'; -import type { DevtoolsButtonPosition } from '@tanstack/query-devtools'; -import type { DevtoolsErrorType } from '@tanstack/query-devtools'; -import type { DevtoolsPosition } from '@tanstack/query-devtools'; -import type { EnvironmentProviders } from '@angular/core'; -import type { InfiniteData } from '@tanstack/query-core'; -import type { InfiniteQueryObserverOptions } from '@tanstack/query-core'; -import type { InfiniteQueryObserverResult } from '@tanstack/query-core'; -import type { InitialDataFunction } from '@tanstack/query-core'; -import { InjectionToken } from '@angular/core'; -import { InjectOptions } from '@angular/core'; -import { Injector } from '@angular/core'; -import type { MutateFunction } from '@tanstack/query-core'; -import type { Mutation } from '@tanstack/query-core'; -import type { MutationFilters } from '@tanstack/query-core'; -import type { MutationObserverOptions } from '@tanstack/query-core'; -import type { MutationObserverResult } from '@tanstack/query-core'; -import type { MutationState } from '@tanstack/query-core'; -import type { OmitKeyof } from '@tanstack/query-core'; -import type { Override } from '@tanstack/query-core'; -import { Provider } from '@angular/core'; -import type { QueriesPlaceholderDataFunction } from '@tanstack/query-core'; -import type { QueryClient } from '@tanstack/query-core'; -import type { QueryFilters } from '@tanstack/query-core'; -import type { QueryFunction } from '@tanstack/query-core'; -import type { QueryKey } from '@tanstack/query-core'; -import type { QueryObserverOptions } from '@tanstack/query-core'; -import type { QueryObserverResult } from '@tanstack/query-core'; -import type { Signal } from '@angular/core'; -import type { ThrowOnError } from '@tanstack/query-core'; - -// @public (undocumented) -export interface BaseMutationNarrowing { - // (undocumented) - isError: SignalFunction<(this: CreateMutationResult) => this is CreateMutationResult>>; - // (undocumented) - isIdle: SignalFunction<(this: CreateMutationResult) => this is CreateMutationResult>>; - // (undocumented) - isPending: SignalFunction<(this: CreateMutationResult) => this is CreateMutationResult>>; - // Warning: (ae-forgotten-export) The symbol "SignalFunction" needs to be exported by the entry point index.d.ts - // Warning: (ae-forgotten-export) The symbol "CreateStatusBasedMutationResult" needs to be exported by the entry point index.d.ts - // - // (undocumented) - isSuccess: SignalFunction<(this: CreateMutationResult) => this is CreateMutationResult>>; -} - -// @public (undocumented) -export interface BaseQueryNarrowing { - // (undocumented) - isError: (this: CreateBaseQueryResult) => this is CreateBaseQueryResult>; - // (undocumented) - isPending: (this: CreateBaseQueryResult) => this is CreateBaseQueryResult>; - // Warning: (ae-forgotten-export) The symbol "CreateStatusBasedQueryResult" needs to be exported by the entry point index.d.ts - // - // (undocumented) - isSuccess: (this: CreateBaseQueryResult) => this is CreateBaseQueryResult>; -} - -// @public (undocumented) -export type CreateBaseMutationResult = Override, { - mutate: CreateMutateFunction; -}> & { - mutateAsync: CreateMutateAsyncFunction; -}; - -// @public (undocumented) -export interface CreateBaseQueryOptions extends QueryObserverOptions { -} - -// Warning: (ae-forgotten-export) The symbol "MapToSignals" needs to be exported by the entry point index.d.ts -// -// @public (undocumented) -export type CreateBaseQueryResult> = BaseQueryNarrowing & MapToSignals>; - -// @public (undocumented) -export interface CreateInfiniteQueryOptions extends OmitKeyof, 'suspense'> { -} - -// @public (undocumented) -export type CreateInfiniteQueryResult = MapToSignals>; - -// @public (undocumented) -export type CreateMutateAsyncFunction = MutateFunction; - -// @public (undocumented) -export type CreateMutateFunction = (...args: Parameters>) => void; - -// @public (undocumented) -export interface CreateMutationOptions extends OmitKeyof, '_defaulted'> { -} - -// @public (undocumented) -export type CreateMutationResult> = BaseMutationNarrowing & MapToSignals>; - -// @public (undocumented) -export interface CreateQueryOptions extends OmitKeyof, 'suspense'> { -} - -// @public (undocumented) -export type CreateQueryResult = CreateBaseQueryResult; - -// @public (undocumented) -export type DefinedCreateInfiniteQueryResult> = MapToSignals; - -// @public (undocumented) -export type DefinedCreateQueryResult> = MapToSignals; - -// @public (undocumented) -export type DefinedInitialDataInfiniteOptions, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = CreateInfiniteQueryOptions & { - initialData: NonUndefinedGuard> | (() => NonUndefinedGuard>); -}; - -// @public (undocumented) -export type DefinedInitialDataOptions = CreateQueryOptions & { - initialData: NonUndefinedGuard | (() => NonUndefinedGuard); -}; - -// @public -export type DeveloperToolsFeature = QueryFeature<'DeveloperTools'>; - -// @public -export interface DevtoolsOptions { - buttonPosition?: DevtoolsButtonPosition; - client?: QueryClient; - errorTypes?: Array; - initialIsOpen?: boolean; - loadDevtools?: 'auto' | boolean; - position?: DevtoolsPosition; - shadowDOMTarget?: ShadowRoot; - styleNonce?: string; -} - -// @public -export function infiniteQueryOptions, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: DefinedInitialDataInfiniteOptions): DefinedInitialDataInfiniteOptions & { - queryKey: DataTag>; -}; - -// @public -export function infiniteQueryOptions, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: UndefinedInitialDataInfiniteOptions): UndefinedInitialDataInfiniteOptions & { - queryKey: DataTag>; -}; - -// @public -export function injectInfiniteQuery, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(optionsFn: (client: QueryClient) => DefinedInitialDataInfiniteOptions, injector?: Injector): DefinedCreateInfiniteQueryResult; - -// @public -export function injectInfiniteQuery, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(optionsFn: (client: QueryClient) => UndefinedInitialDataInfiniteOptions, injector?: Injector): CreateInfiniteQueryResult; - -// @public -export function injectInfiniteQuery, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(optionsFn: (client: QueryClient) => CreateInfiniteQueryOptions, injector?: Injector): CreateInfiniteQueryResult; - -// @public -export function injectIsFetching(filters?: QueryFilters, injector?: Injector): Signal; - -// @public -export function injectIsMutating(filters?: MutationFilters, injector?: Injector): Signal; - -// @public -export function injectMutation(optionsFn: (client: QueryClient) => CreateMutationOptions, injector?: Injector): CreateMutationResult; - -// Warning: (ae-forgotten-export) The symbol "MutationStateOptions" needs to be exported by the entry point index.d.ts -// -// @public -export function injectMutationState(mutationStateOptionsFn?: () => MutationStateOptions, options?: InjectMutationStateOptions): Signal>; - -// @public (undocumented) -export interface InjectMutationStateOptions { - // (undocumented) - injector?: Injector; -} - -// @public (undocumented) -export function injectQueries, TCombinedResult = QueriesResults>({ queries, ...options }: { - queries: Signal<[...QueriesOptions]>; - combine?: (result: QueriesResults) => TCombinedResult; -}, injector?: Injector): Signal; - -// @public -export function injectQuery(optionsFn: (client: QueryClient) => DefinedInitialDataOptions, injector?: Injector): DefinedCreateQueryResult; - -// @public -export function injectQuery(optionsFn: (client: QueryClient) => UndefinedInitialDataOptions, injector?: Injector): CreateQueryResult; - -// @public -export function injectQuery(optionsFn: (client: QueryClient) => CreateQueryOptions, injector?: Injector): CreateQueryResult; - -// @public -export const injectQueryClient: { - (): QueryClient; - (injectOptions: InjectOptions & { - optional?: false; - } & { - injector?: Injector; - }): QueryClient; - (injectOptions: InjectOptions & { - injector?: Injector; - }): QueryClient; -}; - -// @public (undocumented) -export type NonUndefinedGuard = T extends undefined ? never : T; - -// @public @deprecated -export function provideAngularQuery(queryClient: QueryClient): EnvironmentProviders; - -// @public -export const provideQueryClient: ((value: QueryClient | (() => QueryClient)) => Provider) & ((value: QueryClient | (() => QueryClient)) => Provider); - -// @public -export function provideTanStackQuery(queryClient: QueryClient, ...features: Array): EnvironmentProviders; - -// Warning: (ae-forgotten-export) The symbol "MAXIMUM_DEPTH" needs to be exported by the entry point index.d.ts -// Warning: (ae-forgotten-export) The symbol "QueryObserverOptionsForCreateQueries" needs to be exported by the entry point index.d.ts -// Warning: (ae-forgotten-export) The symbol "GetOptions" needs to be exported by the entry point index.d.ts -// -// @public -export type QueriesOptions, TResult extends Array = [], TDepth extends ReadonlyArray = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetOptions] : T extends [infer Head, ...infer Tail] ? QueriesOptions<[ -...Tail -], [ -...TResult, -GetOptions -], [ -...TDepth, -1 -]> : ReadonlyArray extends T ? T : T extends Array> ? Array> : Array; - -// Warning: (ae-forgotten-export) The symbol "GetResults" needs to be exported by the entry point index.d.ts -// -// @public -export type QueriesResults, TResult extends Array = [], TDepth extends ReadonlyArray = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetResults] : T extends [infer Head, ...infer Tail] ? QueriesResults<[ -...Tail -], [ -...TResult, -GetResults -], [ -...TDepth, -1 -]> : T extends Array> ? Array> : Array; - -// @public (undocumented) -export const QUERY_CLIENT: InjectionToken; - -// @public -export interface QueryFeature { - // (undocumented) - ɵkind: TFeatureKind; - // (undocumented) - ɵproviders: Array; -} - -// @public (undocumented) -export type QueryFeatureKind = (typeof queryFeatures)[number]; - -// @public -export type QueryFeatures = DeveloperToolsFeature; - -// @public (undocumented) -export const queryFeatures: readonly ["DeveloperTools"]; - -// @public -export function queryOptions(options: DefinedInitialDataOptions): DefinedInitialDataOptions & { - queryKey: DataTag; -}; - -// @public -export function queryOptions(options: UndefinedInitialDataOptions): UndefinedInitialDataOptions & { - queryKey: DataTag; -}; - -// @public (undocumented) -export type UndefinedInitialDataInfiniteOptions, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = CreateInfiniteQueryOptions & { - initialData?: undefined; -}; - -// @public (undocumented) -export type UndefinedInitialDataOptions = CreateQueryOptions & { - initialData?: undefined | InitialDataFunction>; -}; - -// @public -export function withDevtools(optionsFn?: () => DevtoolsOptions): DeveloperToolsFeature; - - -export * from "@tanstack/query-core"; - -// (No @packageDocumentation comment for this package) - -```