@openapi-qraft/tanstack-query-react-types 2.0.0-next.10

package/src/shared/ServiceOperationMutation.ts

@@ -0,0 +1,32 @@
+import { AreAllOptional } from '@openapi-qraft/tanstack-query-react-types';
+
+interface QueryFnBaseUrlOptions {
+  /**
+   * Base URL to use for the request
+   * @example 'https://api.example.com'
+   */
+  baseUrl?: string;
+}
+
+export type ServiceOperationMutationFnOptions<TBody, TParams> =
+  AreAllOptional<TBody> extends true
+    ? AreAllOptional<TParams> extends true
+      ?
+          | void // todo::try to move void to arguments
+          | ({
+              parameters?: TParams;
+              body?: TBody;
+            } & QueryFnBaseUrlOptions)
+      : {
+          parameters: TParams;
+          body?: TBody;
+        } & QueryFnBaseUrlOptions
+    : AreAllOptional<TParams> extends true
+      ? {
+          parameters?: TParams;
+          body: TBody;
+        } & QueryFnBaseUrlOptions
+      : {
+          parameters: TParams;
+          body: TBody;
+        } & QueryFnBaseUrlOptions;

package/src/shared/ServiceOperationQuery.ts

@@ -0,0 +1,40 @@
+import { ServiceOperationQueryKey } from '@openapi-qraft/tanstack-query-react-types';
+
+interface QueryFnOptionsBase<
+  TMeta extends Record<string, any>,
+  TSignal extends AbortSignal = AbortSignal,
+> {
+  signal?: TSignal;
+  meta?: TMeta;
+}
+
+export interface QueryFnOptionsByParameters<
+  TParams,
+  TMeta extends Record<string, any>,
+  TSignal extends AbortSignal = AbortSignal,
+> extends QueryFnOptionsBase<TMeta, TSignal>,
+    QueryFnBaseUrlOptions {
+  parameters: TParams;
+
+  queryKey?: never;
+}
+
+export interface QueryFnOptionsByQueryKey<
+  TSchema extends { url: string; method: string },
+  TParams,
+  TMeta extends Record<string, any>,
+  TSignal extends AbortSignal = AbortSignal,
+> extends QueryFnOptionsBase<TMeta, TSignal>,
+    QueryFnBaseUrlOptions {
+  queryKey: ServiceOperationQueryKey<TSchema, TParams>;
+
+  parameters?: never;
+}
+
+interface QueryFnBaseUrlOptions {
+  /**
+   * Base URL to use for the request
+   * @example 'https://api.example.com'
+   */
+  baseUrl?: string;
+}

package/src/shared/UseQueryOptionsForUseQueries.ts

@@ -0,0 +1,35 @@
+import type { UseQueryOptions } from '@tanstack/react-query';
+import type { ServiceOperationQueryKey } from './ServiceOperationKey.js';
+import { QueriesPlaceholderDataFunction } from '@tanstack/query-core';
+
+export type UseQueryOptionsForUseQueries<
+  TSchema extends { url: string; method: string },
+  TParams,
+  TQueryFnData,
+  TError,
+  TData = TQueryFnData,
+> = Omit<
+  UseQueryOptions<
+    TQueryFnData,
+    TError,
+    TData,
+    ServiceOperationQueryKey<TSchema, TParams>
+  >,
+  'placeholderData' | 'suspense' | 'queryKey'
+> &
+  (
+    | {
+        parameters: TParams;
+        placeholderData?:
+          | TQueryFnData
+          | QueriesPlaceholderDataFunction<TQueryFnData>;
+        queryKey?: never;
+      }
+    | {
+        queryKey: ServiceOperationQueryKey<TSchema, TParams>;
+        placeholderData?:
+          | TQueryFnData
+          | QueriesPlaceholderDataFunction<TQueryFnData>;
+        parameters?: never;
+      }
+  );

package/src/shared/UseQueryOptionsForUseSuspenseQuery.ts

@@ -0,0 +1,28 @@
+import type { UseQueryOptions } from '@tanstack/react-query';
+import type { ServiceOperationQueryKey } from './ServiceOperationKey.js';
+
+export type UseQueryOptionsForUseSuspenseQuery<
+  TSchema extends { url: string; method: string },
+  TParams,
+  TQueryFnData,
+  TError,
+  TData = TQueryFnData,
+> = Omit<
+  UseQueryOptions<
+    TQueryFnData,
+    TError,
+    TData,
+    ServiceOperationQueryKey<TSchema, TParams>
+  >,
+  'enabled' | 'throwOnError' | 'placeholderData' | 'queryKey'
+> &
+  (
+    | {
+        parameters: TParams;
+        queryKey?: never;
+      }
+    | {
+        queryKey: ServiceOperationQueryKey<TSchema, TParams>;
+        parameters?: never;
+      }
+  );

package/src/shared/WithOptional.ts

@@ -0,0 +1,2 @@
+export type WithOptional<T, K extends keyof T> = Omit<T, K> &
+  Partial<Pick<T, K>>;

package/src/shared/index.ts

@@ -0,0 +1,15 @@
+export type * from './AreAllOptional.js';
+export type * from './FetchInfiniteQueryOptions.js';
+export type * from './InvalidateQueryFilters.js';
+export type * from './MutationFilters.js';
+export type * from './OperationInfiniteData.js';
+export type * from './PartialParameters.js';
+export type * from './QueryFilters.js';
+export type * from './RequestFn.js';
+export type * from './ServiceOperationFetchQueryOptions.js';
+export type * from './ServiceOperationKey.js';
+export type * from './ServiceOperationMutation.js';
+export type * from './ServiceOperationQuery.js';
+export type * from './UseQueryOptionsForUseQueries.js';
+export type * from './UseQueryOptionsForUseSuspenseQuery.js';
+export type * from './WithOptional.js';