@goast/typescript 0.2.19 → 0.3.0

package/README.md

@@ -1,11 +1,41 @@
-# typescript
-
-This library was generated with [Nx](https://nx.dev).
-
-## Building
-
-Run `nx build typescript` to build the library.
-
-## Running unit tests
-
-Run `nx test typescript` to execute the unit tests via [Jest](https://jestjs.io).
+# gOAst (@goast/typescript)
+
+[![@goast/typescript NPM Version](https://img.shields.io/npm/v/%40goast%2Ftypescript?logo=npm&label=%40goast%2Ftypescript)](https://www.npmjs.com/package/@goast/typescript)
+
+**gOAst** stands for **g**enerative **O**pen **A**PI **s**pecification **t**ransformer, a tool designed to transform OpenAPI specifications into various forms with flexibility and extensibility at its core.
+
+For more Information, please visit the [gOAst GitHub Repository](https://github.com/MaSch0212/goast/blob/main).
+
+## Purpose 👍
+
+The `@goast/typescript` package provides generators for [TypeScript](https://www.typescriptlang.org/) code generation from OpenAPI specifications.
+
+## Usage Example 🚀
+
+```typescript
+import { OpenApiGenerator } from '@goast/core';
+import { TypeScriptModelsGenerator, TypeScriptFetchClientsGenerator } from '@goast/typescript';
+
+async function main() {
+  await new OpenApiGenerator({ outputDir: '.api' })
+    .useType(TypeScriptModelsGenerator)
+    .useType(TypeScriptFetchClientsGenerator)
+    .parseAndGenerateFromDir('.openapi');
+}
+
+main();
+```
+
+## Available Generators 📚
+
+- [`TypeScriptModelsGenerator`](https://github.com/MaSch0212/goast/wiki/TypeScript%20Models%20Generator): Generates TypeScript interfaces or types from schemas in the OpenAPI specification(s).
+- [`TypeScriptFetchClientsGenerator`](https://github.com/MaSch0212/goast/wiki/TypeScript%20Fetch%20Clients%20Generator): Generates Fetch clients for TypeScript from paths in the OpenAPI specification(s).
+  - Depends on the output of the `TypeScriptModelsGenerator` generator.
+- [`TypeScriptAngularServicesGenerator`](https://github.com/MaSch0212/goast/wiki/TypeScript%20Angular%20Services%20Generator): Generates [Angular](https://angular.dev/) services from paths in the OpenAPI specification(s).
+  - Depends on the output of the `TypeScriptModelsGenerator` generator.
+- [`TypeScriptEasyNetworkStubsGenerator`](https://github.com/MaSch0212/goast/wiki/TypeScript%20Easy%20Network%20Stubs%20Generator): Generates [easy-network-stub](https://github.com/LoaderB0T/easy-network-stub) classes from paths in the OpenAPI specification(s).
+  - Depends on the output of the `TypeScriptModelsGenerator` generator.
+
+## API Documentation 📖
+
+The API documentation can be found [here](https://github.com/MaSch0212/goast/wiki/TypeScript%20Generators).

package/assets/client/angular/angular-service.utils.ts

@@ -1,80 +1,80 @@
-import { HttpErrorResponse, HttpEvent, HttpResponse } from '@angular/common/http';
-import { Observable, Subscription, filter, take, map, catchError, EMPTY } from 'rxjs';
-
-export type AbortablePromise<T> = Omit<Promise<T>, 'then' | 'catch' | 'finally'> & {
-  abort(): void;
-  then<TResult1 = T, TResult2 = never>(
-    onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null,
-    onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null,
-  ): AbortablePromise<TResult1 | TResult2>;
-  catch<TResult = never>(
-    onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null,
-  ): AbortablePromise<T | TResult>;
-  finally(onfinally?: (() => void) | undefined | null): AbortablePromise<T>;
-};
-
-export function waitForResponse<T extends HttpResponse<any> | HttpErrorResponse>(
-  httpEvents: Observable<HttpEvent<any>>,
-  options: { errorResponseTypes: Record<number, 'text' | 'json'> },
-): AbortablePromise<T> {
-  return firstValueFromAbortable<T>(
-    httpEvents.pipe(
-      filter((event) => event instanceof HttpResponse),
-      map((response) => response as T),
-    ),
-  ).catch((error) => {
-    if (error instanceof HttpErrorResponse) {
-      if (options.errorResponseTypes[error.status] === 'json' && typeof error.error === 'string') {
-        return new HttpErrorResponse({
-          error: JSON.parse(error.error),
-          headers: error.headers,
-          status: error.status,
-          statusText: error.statusText,
-          url: error.url ?? undefined,
-        }) as T;
-      }
-      return error as T;
-    }
-    throw error;
-  });
-}
-
-function firstValueFromAbortable<T>(observable: Observable<T>): AbortablePromise<T> {
-  let subscription: Subscription | undefined = undefined;
-  let _reject: ((reason?: any) => void) | undefined = undefined;
-  const abortFn = () => {
-    if (!subscription) {
-      throw new Error('Not subscribed yet.');
-    }
-    subscription.unsubscribe();
-    _reject?.(new DOMException('The request has been aborted.', 'AbortError'));
-  };
-
-  return createAbortablePromise(
-    new Promise<T>((resolve, reject) => {
-      _reject = reject;
-      subscription = observable
-        .pipe(
-          take(1),
-          catchError((e: unknown) => {
-            reject(e);
-            return EMPTY;
-          }),
-        )
-        .subscribe((x: T) => resolve(x));
-    }),
-    abortFn,
-  );
-}
-
-function createAbortablePromise<T>(promise: Promise<T>, abortFn: () => void) {
-  const thenFn = promise.then.bind(promise);
-  const catchFn = promise.catch.bind(promise);
-  const finallyFn = promise.finally?.bind(promise);
-  return Object.assign(promise, {
-    then: (...args: any[]) => createAbortablePromise(thenFn(...args), abortFn),
-    catch: (...args: any[]) => createAbortablePromise(catchFn(...args), abortFn),
-    finally: finallyFn ? (...args: any[]) => createAbortablePromise(finallyFn(...args), abortFn) : undefined,
-    abort: abortFn,
-  });
-}
+import { HttpErrorResponse, HttpEvent, HttpResponse } from '@angular/common/http';
+import { Observable, Subscription, filter, take, map, catchError, EMPTY } from 'rxjs';
+
+export type AbortablePromise<T> = Omit<Promise<T>, 'then' | 'catch' | 'finally'> & {
+  abort(): void;
+  then<TResult1 = T, TResult2 = never>(
+    onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null,
+    onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null,
+  ): AbortablePromise<TResult1 | TResult2>;
+  catch<TResult = never>(
+    onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null,
+  ): AbortablePromise<T | TResult>;
+  finally(onfinally?: (() => void) | undefined | null): AbortablePromise<T>;
+};
+
+export function waitForResponse<T extends HttpResponse<any> | HttpErrorResponse>(
+  httpEvents: Observable<HttpEvent<any>>,
+  options: { errorResponseTypes: Record<number, 'text' | 'json'> },
+): AbortablePromise<T> {
+  return firstValueFromAbortable<T>(
+    httpEvents.pipe(
+      filter((event) => event instanceof HttpResponse),
+      map((response) => response as T),
+    ),
+  ).catch((error) => {
+    if (error instanceof HttpErrorResponse) {
+      if (options.errorResponseTypes[error.status] === 'json' && typeof error.error === 'string') {
+        return new HttpErrorResponse({
+          error: JSON.parse(error.error),
+          headers: error.headers,
+          status: error.status,
+          statusText: error.statusText,
+          url: error.url ?? undefined,
+        }) as T;
+      }
+      return error as T;
+    }
+    throw error;
+  });
+}
+
+function firstValueFromAbortable<T>(observable: Observable<T>): AbortablePromise<T> {
+  let subscription: Subscription | undefined = undefined;
+  let _reject: ((reason?: any) => void) | undefined = undefined;
+  const abortFn = () => {
+    if (!subscription) {
+      throw new Error('Not subscribed yet.');
+    }
+    subscription.unsubscribe();
+    _reject?.(new DOMException('The request has been aborted.', 'AbortError'));
+  };
+
+  return createAbortablePromise(
+    new Promise<T>((resolve, reject) => {
+      _reject = reject;
+      subscription = observable
+        .pipe(
+          take(1),
+          catchError((e: unknown) => {
+            reject(e);
+            return EMPTY;
+          }),
+        )
+        .subscribe((x: T) => resolve(x));
+    }),
+    abortFn,
+  );
+}
+
+function createAbortablePromise<T>(promise: Promise<T>, abortFn: () => void) {
+  const thenFn = promise.then.bind(promise);
+  const catchFn = promise.catch.bind(promise);
+  const finallyFn = promise.finally?.bind(promise);
+  return Object.assign(promise, {
+    then: (...args: any[]) => createAbortablePromise(thenFn(...args), abortFn),
+    catch: (...args: any[]) => createAbortablePromise(catchFn(...args), abortFn),
+    finally: finallyFn ? (...args: any[]) => createAbortablePromise(finallyFn(...args), abortFn) : undefined,
+    abort: abortFn,
+  });
+}