typedapi-client-helpers 0.1.12 → 0.1.14

package/dist/index.d.cts

@@ -189,6 +189,17 @@ type ApiMethodCallbacks<TResponse> = {
     params?: RequestParams;
 };
 
+type ApiMethodOptions<TResponse, TError = unknown, TRequestParams = RuntimeRequestParams> = {
+    onSuccess?: ApiSuccessHandler<TResponse>;
+    onError?: ApiErrorHandler<TError>;
+    params?: TRequestParams;
+};
+
+type ApiMethodArguments<TMethod extends (...args: any[]) => unknown, TRequestParams = RuntimeRequestParams> = Parameters<TMethod> extends [
+    ...infer Arguments,
+    TRequestParams?
+] ? Arguments : Parameters<TMethod>;
+
 /**
  * Sort direction value accepted by generated query objects.
  *
@@ -287,4 +298,4 @@ declare function getSortDirectionFromSortType(sortType: SortType | null | undefi
  */
 declare function toFormData<T extends object>(payload: T): FormData;
 
-export { type ApiErrorHandler, type ApiErrorResult, type ApiMethodCallbacks, type ApiResult, type ApiSortDirection, type ApiSuccessHandler, type ApiSuccessResult, type ExtractDataIfPaginated, type ExtractError, type ExtractResponse, type FilterFormValues, type FilterType, type HandleApiResponseOptions, type HttpResponse, type OptionValue, type RuntimeRequestParams, type SortDirection, type SortType, type SortableKeys, type UnwrapArray, type WithoutRequestParams, buildQuery, extractArgsCallbacksAndParams, extractArgsToastsAndParams, getSortDirectionFromSortType, getSortTypeFromSortDirection, handleApiResponse, sortTypes, toFormData };
+export { type ApiErrorHandler, type ApiErrorResult, type ApiMethodArguments, type ApiMethodCallbacks, type ApiMethodOptions, type ApiResult, type ApiSortDirection, type ApiSuccessHandler, type ApiSuccessResult, type ExtractDataIfPaginated, type ExtractError, type ExtractResponse, type FilterFormValues, type FilterType, type HandleApiResponseOptions, type HttpResponse, type OptionValue, type RuntimeRequestParams, type SortDirection, type SortType, type SortableKeys, type UnwrapArray, type WithoutRequestParams, buildQuery, extractArgsCallbacksAndParams, extractArgsToastsAndParams, getSortDirectionFromSortType, getSortTypeFromSortDirection, handleApiResponse, sortTypes, toFormData };

package/dist/index.d.ts

@@ -189,6 +189,17 @@ type ApiMethodCallbacks<TResponse> = {
     params?: RequestParams;
 };
 
+type ApiMethodOptions<TResponse, TError = unknown, TRequestParams = RuntimeRequestParams> = {
+    onSuccess?: ApiSuccessHandler<TResponse>;
+    onError?: ApiErrorHandler<TError>;
+    params?: TRequestParams;
+};
+
+type ApiMethodArguments<TMethod extends (...args: any[]) => unknown, TRequestParams = RuntimeRequestParams> = Parameters<TMethod> extends [
+    ...infer Arguments,
+    TRequestParams?
+] ? Arguments : Parameters<TMethod>;
+
 /**
  * Sort direction value accepted by generated query objects.
  *
@@ -287,4 +298,4 @@ declare function getSortDirectionFromSortType(sortType: SortType | null | undefi
  */
 declare function toFormData<T extends object>(payload: T): FormData;
 
-export { type ApiErrorHandler, type ApiErrorResult, type ApiMethodCallbacks, type ApiResult, type ApiSortDirection, type ApiSuccessHandler, type ApiSuccessResult, type ExtractDataIfPaginated, type ExtractError, type ExtractResponse, type FilterFormValues, type FilterType, type HandleApiResponseOptions, type HttpResponse, type OptionValue, type RuntimeRequestParams, type SortDirection, type SortType, type SortableKeys, type UnwrapArray, type WithoutRequestParams, buildQuery, extractArgsCallbacksAndParams, extractArgsToastsAndParams, getSortDirectionFromSortType, getSortTypeFromSortDirection, handleApiResponse, sortTypes, toFormData };
+export { type ApiErrorHandler, type ApiErrorResult, type ApiMethodArguments, type ApiMethodCallbacks, type ApiMethodOptions, type ApiResult, type ApiSortDirection, type ApiSuccessHandler, type ApiSuccessResult, type ExtractDataIfPaginated, type ExtractError, type ExtractResponse, type FilterFormValues, type FilterType, type HandleApiResponseOptions, type HttpResponse, type OptionValue, type RuntimeRequestParams, type SortDirection, type SortType, type SortableKeys, type UnwrapArray, type WithoutRequestParams, buildQuery, extractArgsCallbacksAndParams, extractArgsToastsAndParams, getSortDirectionFromSortType, getSortTypeFromSortDirection, handleApiResponse, sortTypes, toFormData };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typedapi-client-helpers",
-  "version": "0.1.12",
+  "version": "0.1.14",
   "description": "Reusable typed OpenAPI client helpers.",
   "type": "module",
   "main": "./dist/index.js",

package/scripts/generate-api-minimal.mjs

@@ -33,16 +33,16 @@ const config = {
 const swaggerFile =
   process.env.SWAGGER_FILE ??
   process.env.npm_config_swagger_file ??
-  config.swaggerFile ?? 
-  "swagger/swagger.json";
+  config.swaggerFile;
 
 const swaggerUrl =
   process.env.SWAGGER_URL ??
   process.env.npm_config_swagger_url ??
-  config.swaggerUrl ??
-  "https://localhost:7000/swagger/v1/swagger.json";
+  config.swaggerUrl;
 
-const swaggerInput = swaggerFile ? path.resolve(cwd, swaggerFile) : swaggerUrl;
+const swaggerInput = swaggerFile
+  ? path.resolve(cwd, swaggerFile)
+  : (swaggerUrl ?? path.resolve(cwd, "swagger/swagger.json"));
 
 const apiRoot = path.resolve(
   cwd,
@@ -112,10 +112,6 @@ function toQueryName(methodName) {
   return `${pascalCase(methodName)}Query`;
 }
 
-function toOptionsName(methodName) {
-  return `${pascalCase(methodName)}Options`;
-}
-
 function cleanDirectory(directory) {
   if (fs.existsSync(directory)) {
     fs.rmSync(directory, { recursive: true, force: true });
@@ -552,22 +548,6 @@ export type ${toQueryName(methodName)} =
   NonNullable<
     Parameters<${className}["${methodName}"]>[0]
   >;
-`.trim(),
-      )
-      .join("\n\n");
-
-    const methodOptionTypes = generatedMethods
-      .map(({ methodName }) =>
-        `
-export type ${toOptionsName(methodName)} = {
-  onSuccess?: ApiSuccessHandler<
-    ExtractResponse<ReturnType<${className}["${methodName}"]>>
-  >;
-  onError?: ApiErrorHandler<
-    ExtractError<ReturnType<${className}["${methodName}"]>>
-  >;
-  params?: RequestParams;
-};
 `.trim(),
       )
       .join("\n\n");
@@ -594,7 +574,11 @@ export async function ${methodName}(
     ExtractResponse<ReturnType<${className}["${methodName}"]>>
   > | null = null,
   sortDirection?: SortDirection,
-  options: ${toOptionsName(methodName)} = {}
+  options: ApiMethodOptions<
+    ExtractResponse<ReturnType<${className}["${methodName}"]>>,
+    ExtractError<ReturnType<${className}["${methodName}"]>>,
+    RequestParams
+  > = {}
 ): Promise<ApiResult<ExtractResponse<ReturnType<${className}["${methodName}"]>>>> {
   const { onSuccess, onError, params } = options;
 
@@ -620,7 +604,11 @@ export async function ${methodName}(
         return `
 export async function ${methodName}(
   query?: ${toQueryName(methodName)},
-  options: ${toOptionsName(methodName)} = {}
+  options: ApiMethodOptions<
+    ExtractResponse<ReturnType<${className}["${methodName}"]>>,
+    ExtractError<ReturnType<${className}["${methodName}"]>>,
+    RequestParams
+  > = {}
 ): Promise<ApiResult<ExtractResponse<ReturnType<${className}["${methodName}"]>>>> {
   const { onSuccess, onError, params } = options;
 
@@ -642,7 +630,11 @@ export async function ${methodName}(
         `
 export async function ${methodName}(
   query?: ${toQueryName(methodName)},
-  options: ${toOptionsName(methodName)} = {}
+  options: ApiMethodOptions<
+    ExtractResponse<ReturnType<${className}["${methodName}"]>>,
+    ExtractError<ReturnType<${className}["${methodName}"]>>,
+    RequestParams
+  > = {}
 ): Promise<
   ApiResult<
     ExtractResponse<
@@ -675,7 +667,11 @@ export async function ${methodName}(
   data: Parameters<
     ${className}["${methodName}"]
   >[0],
-  options: ${toOptionsName(methodName)} = {}
+  options: ApiMethodOptions<
+    ExtractResponse<ReturnType<${className}["${methodName}"]>>,
+    ExtractError<ReturnType<${className}["${methodName}"]>>,
+    RequestParams
+  > = {}
 ): Promise<
   ApiResult<
     ExtractResponse<
@@ -706,9 +702,14 @@ export async function ${methodName}(
 export async function ${methodName}(
   ...argsWithOptions: [
     ...ApiMethodArguments<
-      ${className}["${methodName}"]
+      ${className}["${methodName}"],
+      RequestParams
     >,
-    ${toOptionsName(methodName)}?
+    ApiMethodOptions<
+      ExtractResponse<ReturnType<${className}["${methodName}"]>>,
+      ExtractError<ReturnType<${className}["${methodName}"]>>,
+      RequestParams
+    >?
   ]
 ): Promise<
   ApiResult<
@@ -723,7 +724,11 @@ export async function ${methodName}(
 
   const options =
     args.length > ${methodArgumentCount}
-      ? (args.pop() as ${toOptionsName(methodName)})
+      ? (args.pop() as ApiMethodOptions<
+            ExtractResponse<ReturnType<${className}["${methodName}"]>>,
+            ExtractError<ReturnType<${className}["${methodName}"]>>,
+            RequestParams
+          >)
       : {};
 
   const { onSuccess, onError, params } = options ?? {};
@@ -755,8 +760,8 @@ export async function ${methodName}(
 
     const runtimeTypeImportNames = [
       "ApiResult",
-      "ApiSuccessHandler",
-      "ApiErrorHandler",
+      "ApiMethodOptions",
+      ...(hasRegularNonQueryMethods ? ["ApiMethodArguments"] : []),
       "ExtractResponse",
       "ExtractError",
 
@@ -812,20 +817,6 @@ export async function ${methodName}(
           })
         : "";
 
-    const apiMethodArgumentsType = hasRegularNonQueryMethods
-      ? `
-type ApiMethodArguments<
-  TMethod extends (...args: any[]) => unknown
-> =
-  Parameters<TMethod> extends [
-    ...infer Arguments,
-    RequestParams?
-  ]
-    ? Arguments
-    : Parameters<TMethod>;
-`.trim()
-      : "";
-
     const content = `
 ${runtimeValueImports}
 
@@ -837,18 +828,11 @@ ${generatedValueImports}
 
 ${generatedTypeImports}
 
-${apiMethodArgumentsType}
-
 /* =======================
    Query Types
    ======================= */
 ${queryTypes}
 
-/* =======================
-   Method Option Types
-   ======================= */
-${methodOptionTypes}
-
 /* =======================
    API Instance
    ======================= */