Merge pull request #2072 from umbraco/dependabot/npm_and_yarn/hey-api/openapi-ts-0.48.1

Bump @hey-api/openapi-ts from 0.37.3 to 0.48.1

Author: iOvergaard

devops/openapi-ts/openapi-ts.config.js

@@ -0,0 +1,18 @@
+import { defineConfig } from '@hey-api/openapi-ts';
+
+export default defineConfig({
+	client: 'fetch',
+	input: 'https://raw.githubusercontent.com/umbraco/Umbraco-CMS/v14/dev/src/Umbraco.Cms.Api.Management/OpenApi.json',
+	output: {
+		path: 'src/external/backend-api/src',
+		format: 'prettier',
+		lint: 'eslint',
+	},
+	schemas: false,
+	services: {
+		asClass: true,
+	},
+	types: {
+		enums: 'typescript',
+	},
+});

devops/openapi-ts/openapi-ts.dev.config.js

@@ -0,0 +1,19 @@
+import { defineConfig } from '@hey-api/openapi-ts';
+
+export default defineConfig({
+	client: 'fetch',
+	debug: true,
+	input: 'http://localhost:11000/umbraco/swagger/management/swagger.json',
+	output: {
+		path: 'src/external/backend-api/src',
+		format: 'prettier',
+		lint: 'eslint',
+	},
+	schemas: false,
+	services: {
+		asClass: true,
+	},
+	types: {
+		enums: 'typescript',
+	},
+});

devops/openapi-ts/openapi-ts.local.config.js

@@ -0,0 +1,19 @@
+import { defineConfig } from '@hey-api/openapi-ts';
+
+export default defineConfig({
+	client: 'fetch',
+	debug: true,
+	input: '../Umbraco.Cms.Api.Management/OpenApi.json',
+	output: {
+		path: 'src/external/backend-api/src',
+		format: 'prettier',
+		lint: 'eslint',
+	},
+	schemas: false,
+	services: {
+		asClass: true,
+	},
+	types: {
+		enums: 'typescript',
+	},
+});

package-lock.json

@@ -159,9 +159,9 @@
 		"example": "node ./devops/example-runner/index.js",
 		"format:fix": "npm run format -- --write",
 		"format": "prettier 'src/**/*.ts' --check",
-		"generate:server-api-local": "openapi-ts --input ../Umbraco.Cms.Api.Management/OpenApi.json --output src/external/backend-api/src --debug true --enums typescript --lint true --schemas false",
-		"generate:server-api-dev": "openapi-ts --input http://localhost:11000/umbraco/swagger/management/swagger.json --output src/external/backend-api/src --debug true --enums typescript --lint true --schemas false",
-		"generate:server-api": "openapi-ts --input https://raw.githubusercontent.com/umbraco/Umbraco-CMS/v14/dev/src/Umbraco.Cms.Api.Management/OpenApi.json --output src/external/backend-api/src --debug true --enums typescript --lint true --schemas false",
+		"generate:server-api-local": "openapi-ts --file devops/openapi-ts/openapi-ts.local.config.js",
+		"generate:server-api-dev": "openapi-ts --file devops/openapi-ts/openapi-ts.dev.config.js",
+		"generate:server-api": "openapi-ts --file devops/openapi-ts/openapi-ts.config.js",
 		"generate:icons": "node ./devops/icons/index.js",
 		"generate:overrides": "node ./devops/tsc/index.js",
 		"generate:jsonschema:dist": "typescript-json-schema --required --include \"./src/packages/core/extension-registry/umbraco-package.ts\" --out dist-cms/umbraco-package-schema.json tsconfig.json UmbracoPackage",
@@ -211,7 +211,7 @@
 	"devDependencies": {
 		"@babel/core": "^7.24.3",
 		"@eslint/js": "^9.6.0",
-		"@hey-api/openapi-ts": "^0.37.3",
+		"@hey-api/openapi-ts": "^0.48.1",
 		"@mdx-js/react": "^3.0.0",
 		"@open-wc/testing": "^4.0.0",
 		"@playwright/test": "^1.41.1",

package.json

@@ -1,4 +1,4 @@
-export type ApiRequestOptions = {
+export type ApiRequestOptions<T = unknown> = {
 	readonly method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH';
 	readonly url: string;
 	readonly path?: Record<string, unknown>;
@@ -9,5 +9,6 @@ export type ApiRequestOptions = {
 	readonly body?: any;
 	readonly mediaType?: string;
 	readonly responseHeader?: string;
-	readonly errors?: Record<number, string>;
+	readonly responseTransformer?: (data: unknown) => Promise<T>;
+	readonly errors?: Record<number | string, string>;
 };

src/external/backend-api/src/core/ApiRequestOptions.ts

@@ -2,7 +2,7 @@ import type { ApiRequestOptions } from './ApiRequestOptions';
 
 type Headers = Record<string, string>;
 type Middleware<T> = (value: T) => T | Promise<T>;
-type Resolver<T> = (options: ApiRequestOptions) => Promise<T>;
+type Resolver<T> = (options: ApiRequestOptions<T>) => Promise<T>;
 
 export class Interceptors<T> {
   _fns: Middleware<T>[];
@@ -11,17 +11,14 @@ export class Interceptors<T> {
     this._fns = [];
   }
 
-  eject(fn: Middleware<T>) {
+  eject(fn: Middleware<T>): void {
     const index = this._fns.indexOf(fn);
     if (index !== -1) {
-      this._fns = [
-        ...this._fns.slice(0, index),
-        ...this._fns.slice(index + 1),
-      ];
+      this._fns = [...this._fns.slice(0, index), ...this._fns.slice(index + 1)];
     }
   }
 
-  use(fn: Middleware<T>) {
+  use(fn: Middleware<T>): void {
     this._fns = [...this._fns, fn];
   }
 }
@@ -36,8 +33,10 @@ export type OpenAPIConfig = {
 	USERNAME?: string | Resolver<string> | undefined;
 	VERSION: string;
 	WITH_CREDENTIALS: boolean;
-	interceptors: {request: Interceptors<RequestInit>;
-		response: Interceptors<Response>;};
+	interceptors: {
+		request: Interceptors<RequestInit>;
+		response: Interceptors<Response>;
+	};
 };
 
 export const OpenAPI: OpenAPIConfig = {
@@ -50,6 +49,8 @@ export const OpenAPI: OpenAPIConfig = {
 	USERNAME: undefined,
 	VERSION: 'Latest',
 	WITH_CREDENTIALS: false,
-	interceptors: {request: new Interceptors(),response: new Interceptors(),
+	interceptors: {
+		request: new Interceptors(),
+		response: new Interceptors(),
 	},
 };

src/external/backend-api/src/core/OpenAPI.ts

@@ -42,7 +42,9 @@ export const getQueryString = (params: Record<string, unknown>): string => {
 			return;
 		}
 
-		if (Array.isArray(value)) {
+		if (value instanceof Date) {
+			append(key, value.toISOString());
+		} else if (Array.isArray(value)) {
 			value.forEach(v => encodePair(key, v));
 		} else if (typeof value === 'object') {
 			Object.entries(value).forEach(([k, v]) => encodePair(`${key}[${k}]`, v));
@@ -99,20 +101,24 @@ export const getFormData = (options: ApiRequestOptions): FormData | undefined =>
 	return undefined;
 };
 
-type Resolver<T> = (options: ApiRequestOptions) => Promise<T>;
+type Resolver<T> = (options: ApiRequestOptions<T>) => Promise<T>;
 
-export const resolve = async <T>(options: ApiRequestOptions, resolver?: T | Resolver<T>): Promise<T | undefined> => {
+export const resolve = async <T>(options: ApiRequestOptions<T>, resolver?: T | Resolver<T>): Promise<T | undefined> => {
 	if (typeof resolver === 'function') {
 		return (resolver as Resolver<T>)(options);
 	}
 	return resolver;
 };
 
-export const getHeaders = async (config: OpenAPIConfig, options: ApiRequestOptions): Promise<Headers> => {
+export const getHeaders = async <T>(config: OpenAPIConfig, options: ApiRequestOptions<T>): Promise<Headers> => {
 	const [token, username, password, additionalHeaders] = await Promise.all([
+		// @ts-ignore
 		resolve(options, config.TOKEN),
+		// @ts-ignore
 		resolve(options, config.USERNAME),
+		// @ts-ignore
 		resolve(options, config.PASSWORD),
+		// @ts-ignore
 		resolve(options, config.HEADERS),
 	]);
 
@@ -154,7 +160,7 @@ export const getHeaders = async (config: OpenAPIConfig, options: ApiRequestOptio
 export const getRequestBody = (options: ApiRequestOptions): unknown => {
 	if (options.body !== undefined) {
 		if (options.mediaType?.includes('application/json') || options.mediaType?.includes('+json')) {
-			return JSON.stringify(options.body)
+			return JSON.stringify(options.body);
 		} else if (isString(options.body) || isBlob(options.body) || isFormData(options.body)) {
 			return options.body;
 		} else {
@@ -187,7 +193,7 @@ export const sendRequest = async (
 	}
 
 	for (const fn of config.interceptors.request._fns) {
-		request = await fn(request)
+		request = await fn(request);
 	}
 
 	onCancel(() => controller.abort());
@@ -302,7 +308,7 @@ export const catchErrorCodes = (options: ApiRequestOptions, result: ApiResult):
  * @returns CancelablePromise<T>
  * @throws ApiError
  */
-export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): CancelablePromise<T> => {
+export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions<T>): CancelablePromise<T> => {
 	return new CancelablePromise(async (resolve, reject, onCancel) => {
 		try {
 			const url = getUrl(config, options);
@@ -314,18 +320,23 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): C
 				let response = await sendRequest(config, options, url, body, formData, headers, onCancel);
 
 				for (const fn of config.interceptors.response._fns) {
-					response = await fn(response)
+					response = await fn(response);
 				}
 
 				const responseBody = await getResponseBody(response);
 				const responseHeader = getResponseHeader(response, options.responseHeader);
 
+				let transformedBody = responseBody;
+				if (options.responseTransformer && response.ok) {
+					transformedBody = await options.responseTransformer(responseBody)
+				}
+
 				const result: ApiResult = {
 					url,
 					ok: response.ok,
 					status: response.status,
 					statusText: response.statusText,
-					body: responseHeader ?? responseBody,
+					body: responseHeader ?? transformedBody,
 				};
 
 				catchErrorCodes(options, result);

src/external/backend-api/src/core/request.ts

@@ -1,6 +1,6 @@
-
+// This file is auto-generated by @hey-api/openapi-ts
 export { ApiError } from './core/ApiError';
 export { CancelablePromise, CancelError } from './core/CancelablePromise';
 export { OpenAPI, type OpenAPIConfig } from './core/OpenAPI';
-export * from './models';
-export * from './services';
+export * from './services.gen';
+export * from './types.gen';