@openapi-qraft/react 2.0.0-next.7 → 2.0.0-next.9

package/src/lib/PartialParameters.type.ts

@@ -1,12 +0,0 @@
-/**
- * Shallow partial 'parameters'.
- * @example
- * ```ts
- * {query?: {page: number, nested: {still: 'not_partial'}}}
- * // =>
- * {query?: {page?: number, nested?: {still: 'not_partial'}}}
- * ```
- */
-export type PartialParameters<T> = T extends object
-  ? { [K in keyof T]?: T[K] extends object ? Partial<T[K]> : T[K] }
-  : T;

package/src/service-operation/OperationInfiniteData.ts

@@ -1,7 +0,0 @@
-import type { InfiniteData } from '@tanstack/query-core';
-import type { PartialParameters } from '../lib/PartialParameters.type.js';
-
-export type OperationInfiniteData<TData, TParams> = InfiniteData<
-  TData,
-  PartialParameters<TParams>
->;

package/src/service-operation/QueryFilters.ts

@@ -1,226 +0,0 @@
-import type { DefaultError, FetchStatus, Query } from '@tanstack/query-core';
-import type { PartialParameters } from '../lib/PartialParameters.type.js';
-import type { OperationInfiniteData } from './OperationInfiniteData.js';
-import type {
-  ServiceOperationBaseQueryKey,
-  ServiceOperationInfiniteQueryKey,
-  ServiceOperationQueryKey,
-} from './ServiceOperationKey.js';
-
-export type QueryTypeFilter = 'all' | 'active' | 'inactive';
-
-interface QueryFiltersBase<
-  TSchema extends { url: string; method: string },
-  TData,
-  TInfinite extends boolean,
-  TParams = {},
-  TError = DefaultError,
-> {
-  /**
-   * Include queries matching this predicate function
-   */
-  predicate?: TInfinite extends true
-    ? QueryFilterInfinitePredicate<TSchema, TData, TParams, TError>
-    : TInfinite extends false
-      ? QueryFilterRegularPredicate<TSchema, TData, TParams, TError>
-      : (query: string) => boolean;
-
-  /**
-   * Filter to active queries, inactive queries or all queries
-   */
-  type?: QueryTypeFilter;
-
-  /**
-   * Include or exclude stale queries
-   */
-  stale?: boolean;
-
-  /**
-   * Include queries matching their fetchStatus
-   */
-  fetchStatus?: FetchStatus;
-}
-
-interface QueryFiltersByQueryKeyBase<
-  TSchema extends { url: string; method: string },
-  TData,
-  TInfinite extends boolean,
-  TParams = {},
-  TError = DefaultError,
-> extends QueryFiltersBase<TSchema, TData, TInfinite, TParams, TError> {
-  infinite?: never;
-  parameters?: never;
-}
-
-interface QueryFiltersByExactQueryKey<
-  TSchema extends { url: string; method: string },
-  TData,
-  TInfinite extends boolean,
-  TParams = {},
-  TError = DefaultError,
-> extends QueryFiltersByQueryKeyBase<
-    TSchema,
-    TData,
-    TInfinite,
-    TParams,
-    TError
-  > {
-  /**
-   * Include queries matching this query key
-   */
-  queryKey: ServiceOperationBaseQueryKey<TSchema, TInfinite, TParams>;
-
-  /**
-   * Match query key exactly
-   */
-  exact: true;
-}
-
-interface QueryFiltersWeakExactQueryKey<
-  TSchema extends { url: string; method: string },
-  TData,
-  TInfinite extends boolean,
-  TParams = {},
-  TError = DefaultError,
-> extends QueryFiltersByQueryKeyBase<
-    TSchema,
-    TData,
-    TInfinite,
-    TParams,
-    TError
-  > {
-  /**
-   * Include queries matching this query key
-   */
-  queryKey?: ServiceOperationBaseQueryKey<
-    TSchema,
-    TInfinite,
-    PartialParameters<TParams>
-  >;
-
-  /**
-   * Match query key exactly
-   */
-  exact?: false;
-}
-
-export type QueryFiltersByQueryKey<
-  TSchema extends { url: string; method: string },
-  TData,
-  TInfinite extends boolean,
-  TParams = {},
-  TError = DefaultError,
-> =
-  | QueryFiltersByExactQueryKey<TSchema, TData, TInfinite, TParams, TError>
-  | QueryFiltersWeakExactQueryKey<TSchema, TData, TInfinite, TParams, TError>;
-
-interface QueryFiltersByParametersBase<
-  TSchema extends { url: string; method: string },
-  TData,
-  TInfinite extends boolean,
-  TParams = {},
-  TError = DefaultError,
-> extends QueryFiltersBase<TSchema, TData, TInfinite, TParams, TError> {
-  /**
-   * Is the query infinite
-   */
-  infinite?: TInfinite;
-
-  queryKey?: never;
-}
-
-interface QueryFiltersByExactParameters<
-  TSchema extends { url: string; method: string },
-  TData,
-  TInfinite extends boolean,
-  TParams = {},
-  TError = DefaultError,
-> extends QueryFiltersByParametersBase<
-    TSchema,
-    TData,
-    TInfinite,
-    TParams,
-    TError
-  > {
-  /**
-   * Match query key exactly
-   */
-  exact: true;
-
-  /**
-   * Include queries matching parameters
-   */
-  parameters: TParams;
-}
-
-interface QueryFiltersByWeakParameters<
-  TSchema extends { url: string; method: string },
-  TData,
-  TInfinite extends boolean,
-  TParams = {},
-  TError = DefaultError,
-> extends QueryFiltersByParametersBase<
-    TSchema,
-    TData,
-    TInfinite,
-    TParams,
-    TError
-  > {
-  /**
-   * Match query key exactly
-   */
-  exact?: false;
-
-  /**
-   * Include queries matching parameters
-   */
-  parameters?: PartialParameters<TParams>;
-}
-
-export type QueryFiltersByParameters<
-  TSchema extends { url: string; method: string },
-  TData,
-  TInfinite extends boolean,
-  TParams = {},
-  TError = DefaultError,
-> =
-  | QueryFiltersByExactParameters<TSchema, TData, TInfinite, TParams, TError>
-  | QueryFiltersByWeakParameters<TSchema, TData, TInfinite, TParams, TError>;
-
-interface QueryFilterInfinitePredicate<
-  TSchema extends { url: string; method: string },
-  TData,
-  TParams = {},
-  TError = DefaultError,
-> {
-  /**
-   * Include queries matching this predicate function
-   */
-  (
-    query: Query<
-      OperationInfiniteData<TData, TParams>,
-      TError,
-      OperationInfiniteData<TData, TParams>,
-      ServiceOperationInfiniteQueryKey<TSchema, TParams>
-    >
-  ): boolean;
-}
-
-interface QueryFilterRegularPredicate<
-  TSchema extends { url: string; method: string },
-  TData,
-  TParams = {},
-  TError = DefaultError,
-> {
-  /**
-   * Include queries matching this predicate function
-   */
-  (
-    query: Query<
-      TData,
-      TError,
-      TData,
-      ServiceOperationQueryKey<TSchema, TParams>
-    >
-  ): boolean;
-}

package/src/service-operation/ServiceOperation.ts

@@ -1,85 +0,0 @@
-import type { DefaultError } from '@tanstack/query-core';
-import type { ServiceOperationCancelQueries } from './ServiceOperationCancelQueries.js';
-import type { ServiceOperationFetchInfiniteQuery } from './ServiceOperationFetchInfiniteQuery.js';
-import type { ServiceOperationFetchQuery } from './ServiceOperationFetchQuery.js';
-import type { ServiceOperationGetInfiniteQueryData } from './ServiceOperationGetInfiniteQueryData.js';
-import type { ServiceOperationGetQueriesData } from './ServiceOperationGetQueriesData.js';
-import type { ServiceOperationGetQueryData } from './ServiceOperationGetQueryData.js';
-import type { ServiceOperationGetQueryState } from './ServiceOperationGetQueryState.js';
-import type { ServiceOperationInvalidateQueries } from './ServiceOperationInvalidateQueries.js';
-import type { ServiceOperationIsFetchingQueries } from './ServiceOperationIsFetchingQueries.js';
-import type { ServiceOperationIsMutatingQueries } from './ServiceOperationIsMutatingQueries.js';
-import type { ServiceOperationMutationFn } from './ServiceOperationMutationFn.js';
-import type { ServiceOperationQueryFn } from './ServiceOperationQueryFn.js';
-import type { ServiceOperationRefetchQueries } from './ServiceOperationRefetchQueries.js';
-import type { ServiceOperationRemoveQueries } from './ServiceOperationRemoveQueries.js';
-import type { ServiceOperationResetQueries } from './ServiceOperationResetQueries.js';
-import type { ServiceOperationSetInfiniteQueryData } from './ServiceOperationSetInfiniteQueryData.js';
-import type { ServiceOperationSetQueriesData } from './ServiceOperationSetQueriesData.js';
-import type { ServiceOperationSetQueryData } from './ServiceOperationSetQueryData.js';
-import type { ServiceOperationUseInfiniteQuery } from './ServiceOperationUseInfiniteQuery.js';
-import type { ServiceOperationUseIsFetchingQueries } from './ServiceOperationUseIsFetchingQueries.js';
-import type { ServiceOperationUseIsMutating } from './ServiceOperationUseIsMutating.js';
-import type { ServiceOperationUseMutation } from './ServiceOperationUseMutation.js';
-import type { ServiceOperationUseMutationState } from './ServiceOperationUseMutationState.js';
-import type { ServiceOperationUseQueries } from './ServiceOperationUseQueries.js';
-import type { ServiceOperationUseQuery } from './ServiceOperationUseQuery.js';
-import type { ServiceOperationUseSuspenseInfiniteQuery } from './ServiceOperationUseSuspenseInfiniteQuery.js';
-import type { ServiceOperationUseSuspenseQueries } from './ServiceOperationUseSuspenseQueries.js';
-import type { ServiceOperationUseSuspenseQuery } from './ServiceOperationUseSuspenseQuery.js';
-
-export interface ServiceOperationQuery<
-  TSchema extends { url: string; method: string },
-  TData,
-  TParams,
-  TError = DefaultError,
-> extends ServiceOperationUseQuery<TSchema, TData, TParams, TError>,
-    ServiceOperationUseQueries<TSchema, TData, TParams, TError>,
-    ServiceOperationUseSuspenseQueries<TSchema, TData, TParams, TError>,
-    ServiceOperationUseInfiniteQuery<TSchema, TData, TParams, TError>,
-    ServiceOperationUseSuspenseQuery<TSchema, TData, TParams, TError>,
-    ServiceOperationUseSuspenseInfiniteQuery<TSchema, TData, TParams, TError>,
-    ServiceOperationUseIsFetchingQueries<TSchema, TData, TParams, TError>,
-    ServiceOperationQueryFn<TSchema, TData, TParams, TError>,
-    ServiceOperationFetchQuery<TSchema, TData, TParams, TError>,
-    ServiceOperationFetchInfiniteQuery<TSchema, TData, TParams, TError>,
-    ServiceOperationGetQueryData<TSchema, TData, TParams>,
-    ServiceOperationGetQueryState<TSchema, TData, TParams, TError>,
-    ServiceOperationGetQueriesData<TSchema, TData, TParams, TError>,
-    ServiceOperationGetInfiniteQueryData<TSchema, TData, TParams>,
-    ServiceOperationSetQueryData<TSchema, TData, TParams>,
-    ServiceOperationSetQueriesData<TSchema, TData, TParams, TError>,
-    ServiceOperationSetInfiniteQueryData<TSchema, TData, TParams>,
-    ServiceOperationInvalidateQueries<TSchema, TData, TParams, TError>,
-    ServiceOperationCancelQueries<TSchema, TData, TParams, TError>,
-    ServiceOperationRemoveQueries<TSchema, TData, TParams, TError>,
-    ServiceOperationResetQueries<TSchema, TData, TParams, TError>,
-    ServiceOperationRefetchQueries<TSchema, TData, TParams, TError>,
-    ServiceOperationIsFetchingQueries<TSchema, TData, TParams, TError> {
-  schema: TSchema;
-  types: {
-    parameters: TParams;
-    data: TData;
-    error: TError;
-  };
-}
-
-export interface ServiceOperationMutation<
-  TSchema extends { url: string; method: string },
-  TBody,
-  TData,
-  TParams,
-  TError = DefaultError,
-> extends ServiceOperationUseMutation<TSchema, TBody, TData, TParams, TError>,
-    ServiceOperationUseIsMutating<TSchema, TBody, TData, TParams, TError>,
-    ServiceOperationUseMutationState<TSchema, TBody, TData, TParams, TError>,
-    ServiceOperationIsMutatingQueries<TSchema, TBody, TData, TParams, TError>,
-    ServiceOperationMutationFn<TSchema, TBody, TData, TParams, TError> {
-  schema: TSchema;
-  types: {
-    parameters: TParams;
-    data: TData;
-    error: TError;
-    body: TBody;
-  };
-}

package/src/service-operation/ServiceOperationCancelQueries.ts

@@ -1,19 +0,0 @@
-import type { CancelOptions, DefaultError } from '@tanstack/query-core';
-import type {
-  QueryFiltersByParameters,
-  QueryFiltersByQueryKey,
-} from './QueryFilters.js';
-
-export interface ServiceOperationCancelQueries<
-  TSchema extends { url: string; method: string },
-  TData,
-  TParams = {},
-  TError = DefaultError,
-> {
-  cancelQueries<TInfinite extends boolean = false>(
-    filters?:
-      | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
-      | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>,
-    options?: CancelOptions
-  ): Promise<void>;
-}

package/src/service-operation/ServiceOperationFetchInfiniteQuery.ts

@@ -1,156 +0,0 @@
-import type {
-  DefaultError,
-  FetchQueryOptions,
-  GetNextPageParamFunction,
-  InitialPageParam,
-  QueryFunction,
-} from '@tanstack/query-core';
-import type { PartialParameters } from '../lib/PartialParameters.type.js';
-import type { RequestFn } from '../lib/requestFn.js';
-import type { OperationInfiniteData } from './OperationInfiniteData.js';
-import type {
-  ServiceOperationInfiniteQueryKey,
-  ServiceOperationQueryKey,
-} from './ServiceOperationKey.js';
-
-export interface ServiceOperationFetchInfiniteQuery<
-  TSchema extends { url: string; method: string },
-  TData,
-  TParams = {},
-  TError = DefaultError,
-> {
-  fetchInfiniteQuery<TPageParam extends TParams>(
-    options:
-      | (FetchInfiniteQueryOptionsByQueryKey<
-          TSchema,
-          TData,
-          TParams,
-          TPageParam,
-          TError
-        > &
-          FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams, TError>)
-      | (FetchInfiniteQueryOptionsByParameters<
-          TSchema,
-          TData,
-          TParams,
-          TPageParam,
-          TError
-        > &
-          FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams, TError>)
-  ): Promise<OperationInfiniteData<TData, TParams>>;
-
-  prefetchInfiniteQuery<TPageParam extends TParams>(
-    options:
-      | (FetchInfiniteQueryOptionsByQueryKey<
-          TSchema,
-          TData,
-          TParams,
-          TPageParam,
-          TError
-        > &
-          FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams, TError>)
-      | (FetchInfiniteQueryOptionsByParameters<
-          TSchema,
-          TData,
-          TParams,
-          TPageParam,
-          TError
-        > &
-          FetchInfiniteQueryOptionsQueryFn<TSchema, TData, TParams, TError>)
-  ): Promise<void>;
-}
-
-type FetchInfiniteQueryPages<TData = unknown, TPageParam = unknown> =
-  | {
-      pages?: never;
-    }
-  | {
-      pages: number;
-      getNextPageParam: GetNextPageParamFunction<
-        PartialParameters<TPageParam>,
-        TData
-      >;
-    };
-
-type FetchInfiniteQueryOptionsBase<
-  TSchema extends { url: string; method: string },
-  TData,
-  TParams = {},
-  TPageParam = unknown,
-  TError = DefaultError,
-> = Omit<
-  FetchQueryOptions<
-    TData,
-    TError,
-    OperationInfiniteData<TData, TParams>,
-    ServiceOperationQueryKey<TSchema, TParams>,
-    TPageParam
-  >,
-  'queryKey'
-> &
-  InitialPageParam<PartialParameters<TPageParam>> &
-  FetchInfiniteQueryPages<TData, TPageParam>;
-
-type FetchInfiniteQueryOptionsByQueryKey<
-  TSchema extends { url: string; method: string },
-  TData,
-  TParams = {},
-  TPageParam = {},
-  TError = DefaultError,
-> = FetchInfiniteQueryOptionsBase<
-  TSchema,
-  TData,
-  TParams,
-  TPageParam,
-  TError
-> & {
-  /**
-   * Fetch Queries by query key
-   */
-  queryKey?: ServiceOperationInfiniteQueryKey<TSchema, TParams>;
-  parameters?: never;
-};
-type FetchInfiniteQueryOptionsByParameters<
-  TSchema extends { url: string; method: string },
-  TData,
-  TParams = {},
-  TPageParam = {},
-  TError = DefaultError,
-> = FetchInfiniteQueryOptionsBase<
-  TSchema,
-  TData,
-  TParams,
-  TPageParam,
-  TError
-> & {
-  /**
-   * Fetch Queries by parameters
-   */
-  parameters?: TParams;
-  queryKey?: never;
-};
-
-type FetchInfiniteQueryOptionsQueryFn<
-  TSchema extends { url: string; method: string },
-  TData,
-  TParams,
-  TError,
-> =
-  | {
-      queryFn: QueryFunction<
-        TData,
-        ServiceOperationInfiniteQueryKey<TSchema, TParams>
-      >;
-    }
-  | {
-      /**
-       * Custom request function to use for the query
-       */
-      requestFn?: RequestFn<TData, TError>;
-      /**
-       * Base URL to use for the request (used in the `queryFn`)
-       * @example 'https://api.example.com'
-       */
-      baseUrl?: string | undefined;
-      queryFn?: never; // Workaround to fix union type error
-    };

package/src/service-operation/ServiceOperationFetchQuery.ts

@@ -1,111 +0,0 @@
-import type {
-  DefaultError,
-  FetchQueryOptions,
-  QueryFunction,
-} from '@tanstack/query-core';
-import type { RequestFn } from '../lib/requestFn.js';
-import type { ServiceOperationQueryKey } from './ServiceOperationKey.js';
-import { AreAllOptional } from '../lib/AreAllOptional.js';
-
-export interface ServiceOperationFetchQuery<
-  TSchema extends { url: string; method: string },
-  TData,
-  TParams,
-  TError = DefaultError,
-> {
-  fetchQuery(
-    options: AreAllOptional<TParams> extends true
-      ? ServiceOperationFetchQueryOptions<
-          TSchema,
-          TData,
-          TParams,
-          TError
-        > | void
-      : ServiceOperationFetchQueryOptions<TSchema, TData, TParams, TError>
-  ): Promise<TData>;
-
-  prefetchQuery(
-    options: AreAllOptional<TParams> extends true
-      ? ServiceOperationFetchQueryOptions<
-          TSchema,
-          TData,
-          TParams,
-          TError
-        > | void
-      : ServiceOperationFetchQueryOptions<TSchema, TData, TParams, TError>
-  ): Promise<void>;
-}
-
-type ServiceOperationFetchQueryOptions<
-  TSchema extends { url: string; method: string },
-  TData,
-  TParams,
-  TError,
-> =
-  | (FetchQueryOptionsByQueryKey<TSchema, TData, TParams, TError> &
-      FetchQueryOptionsQueryFn<TSchema, TData, TParams, TError>)
-  | (FetchQueryOptionsByParameters<TSchema, TData, TParams, TError> &
-      FetchQueryOptionsQueryFn<TSchema, TData, TParams, TError>);
-
-type FetchQueryOptionsBase<
-  TSchema extends { url: string; method: string },
-  TData,
-  TParams = {},
-  TError = DefaultError,
-> = Omit<
-  FetchQueryOptions<
-    TData,
-    TError,
-    TData,
-    ServiceOperationQueryKey<TSchema, TParams>
-  >,
-  'queryKey' | 'queryFn'
->;
-
-interface FetchQueryOptionsByQueryKey<
-  TSchema extends { url: string; method: string },
-  TData,
-  TParams = {},
-  TError = DefaultError,
-> extends FetchQueryOptionsBase<TSchema, TData, TParams, TError> {
-  /**
-   * Fetch Queries by query key
-   */
-  queryKey: ServiceOperationQueryKey<TSchema, TParams>;
-  parameters?: never;
-}
-
-interface FetchQueryOptionsByParameters<
-  TSchema extends { url: string; method: string },
-  TData,
-  TParams = {},
-  TError = DefaultError,
-> extends FetchQueryOptionsBase<TSchema, TData, TParams, TError> {
-  /**
-   * Fetch Queries by parameters
-   */
-  parameters: TParams;
-  queryKey?: never;
-}
-
-type FetchQueryOptionsQueryFn<
-  TSchema extends { url: string; method: string },
-  TData,
-  TParams,
-  TError,
-> =
-  | {
-      queryFn: QueryFunction<TData, ServiceOperationQueryKey<TSchema, TParams>>;
-    }
-  | {
-      /**
-       * Custom request function to use for the query
-       */
-      requestFn?: RequestFn<TData, TError>;
-      /**
-       * Base URL to use for the request (used in the `queryFn`)
-       * @example 'https://api.example.com'
-       */
-      baseUrl?: string | undefined;
-      queryFn?: never; // Workaround to fix union type error
-    };

package/src/service-operation/ServiceOperationGetInfiniteQueryData.ts

@@ -1,15 +0,0 @@
-import type { AreAllOptional } from '../lib/AreAllOptional.js';
-import type { OperationInfiniteData } from './OperationInfiniteData.js';
-import type { ServiceOperationInfiniteQueryKey } from './ServiceOperationKey.js';
-
-export interface ServiceOperationGetInfiniteQueryData<
-  TSchema extends { url: string; method: string },
-  TData,
-  TParams,
-> {
-  getInfiniteQueryData(
-    parameters: AreAllOptional<TParams> extends true
-      ? TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams> | void
-      : TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>
-  ): OperationInfiniteData<TData, TParams> | undefined;
-}

package/src/service-operation/ServiceOperationGetQueriesData.ts

@@ -1,35 +0,0 @@
-import type { DefaultError, NoInfer } from '@tanstack/query-core';
-import type { OperationInfiniteData } from './OperationInfiniteData.js';
-import type {
-  QueryFiltersByParameters,
-  QueryFiltersByQueryKey,
-} from './QueryFilters.js';
-import type {
-  ServiceOperationInfiniteQueryKey,
-  ServiceOperationQueryKey,
-} from './ServiceOperationKey.js';
-
-export interface ServiceOperationGetQueriesData<
-  TSchema extends { url: string; method: string },
-  TData,
-  TParams,
-  TError = DefaultError,
-> {
-  getQueriesData<TInfinite extends boolean = false>(
-    filters?:
-      | QueryFiltersByParameters<TSchema, TData, TInfinite, TParams, TError>
-      | QueryFiltersByQueryKey<TSchema, TData, TInfinite, TParams, TError>
-  ): TInfinite extends true
-    ? Array<
-        [
-          queryKey: ServiceOperationInfiniteQueryKey<TSchema, TParams>,
-          data: NoInfer<OperationInfiniteData<TData, TParams>> | undefined,
-        ]
-      >
-    : Array<
-        [
-          queryKey: ServiceOperationQueryKey<TSchema, TParams>,
-          data: TData | undefined,
-        ]
-      >;
-}

package/src/service-operation/ServiceOperationGetQueryData.ts

@@ -1,14 +0,0 @@
-import type { AreAllOptional } from '../lib/AreAllOptional.js';
-import type { ServiceOperationQueryKey } from './ServiceOperationKey.js';
-
-export interface ServiceOperationGetQueryData<
-  TSchema extends { url: string; method: string },
-  TData,
-  TParams,
-> {
-  getQueryData(
-    parameters: AreAllOptional<TParams> extends true
-      ? TParams | ServiceOperationQueryKey<TSchema, TParams> | void
-      : TParams | ServiceOperationQueryKey<TSchema, TParams>
-  ): TData | undefined;
-}