@goast/core 0.5.2 → 0.6.0-beta.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2021 Marc Schmidt
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2021 Marc Schmidt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,67 +1,67 @@
-# gOAst (@goast/core)
-
-[![@goast/core NPM Version](https://img.shields.io/npm/v/%40goast%2Fcore?logo=npm&label=%40goast%2Fcore)](https://www.npmjs.com/package/@goast/core)
-[![@goast/core JSR Version](https://img.shields.io/jsr/v/%40goast%2Fcore?logo=jsr&label=%40goast%2Fcore)](https://jsr.io/@goast/core)
-
-**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/core` package provides:
-
-- entry points for using the **gOAst** library
-- base classes for creating custom generators
-- utilities for parsing and transforming OpenAPI specifications
-
-## Usage Example 🚀
-
-```typescript
-import { OpenApiGenerator } from '@goast/core';
-
-class MyGenerator implements OpenApiGenerationProvider {
-  generate(
-    context: OpenApiGeneratorContext<OpenApiGeneratorInput>,
-    config?: Partial<Readonly<Record<string, unknown>>>,
-  ): Record<string, unknown> {
-    // Do something
-    return {};
-  }
-}
-
-async function main() {
-  const generator = new OpenApiGenerator()
-    // Add a generator using a class
-    .useType(MyGenerator)
-    // Add a generator using a function
-    .useFn((ctx, cfg) => {
-      // Do the generation
-      return {}; // Return information about the generated files so it can be used by other generators
-    })
-    // Add a generator using an object implementing `OpenApiGenerationProvider`
-    .useValue({ generate: (ctx, cfg) => ({}) });
-
-  // Generate for one of more OpenAPI specification files
-  await generator.parseAndGenerate('path/to/openapi.json', 'path/to/another/openapi.yaml');
-
-  // Alternatively, you can generate output for all specifications in a directory.
-  // By default, it will only consider files within the directory (non-recursively) with the extensions: .json, .yaml, .yml.
-  await generator.parseAndGenerateFromDir('path/to/openapi/specs');
-}
-
-main();
-```
-
-## Available Generator Packages 📚
-
-[![@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/kotlin NPM Version](https://img.shields.io/npm/v/%40goast%2Fkotlin?logo=npm&label=%40goast%2Fkotlin)](https://www.npmjs.com/package/@goast/kotlin)
-<br>
-[![@goast/typescript JSR Version](https://img.shields.io/jsr/v/%40goast%2Ftypescript?logo=jsr&label=%40goast%2Ftypescript)](https://jsr.io/@goast/typescript)
-[![@goast/kotlin JSR Version](https://img.shields.io/jsr/v/%40goast%2Fkotlin?logo=jsr&label=%40goast%2Fkotlin)](https://jsr.io/@goast/kotlin)
-
-## API Documentation 📖
-
-The API documentation can be found [here](https://github.com/MaSch0212/goast/wiki).
+# gOAst (@goast/core)
+
+[![@goast/core NPM Version](https://img.shields.io/npm/v/%40goast%2Fcore?logo=npm&label=%40goast%2Fcore)](https://www.npmjs.com/package/@goast/core)
+[![@goast/core JSR Version](https://img.shields.io/jsr/v/%40goast%2Fcore?logo=jsr&label=%40goast%2Fcore)](https://jsr.io/@goast/core)
+
+**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/core` package provides:
+
+- entry points for using the **gOAst** library
+- base classes for creating custom generators
+- utilities for parsing and transforming OpenAPI specifications
+
+## Usage Example 🚀
+
+```typescript
+import { OpenApiGenerator } from '@goast/core';
+
+class MyGenerator implements OpenApiGenerationProvider {
+  generate(
+    context: OpenApiGeneratorContext<OpenApiGeneratorInput>,
+    config?: Partial<Readonly<Record<string, unknown>>>,
+  ): Record<string, unknown> {
+    // Do something
+    return {};
+  }
+}
+
+async function main() {
+  const generator = new OpenApiGenerator()
+    // Add a generator using a class
+    .useType(MyGenerator)
+    // Add a generator using a function
+    .useFn((ctx, cfg) => {
+      // Do the generation
+      return {}; // Return information about the generated files so it can be used by other generators
+    })
+    // Add a generator using an object implementing `OpenApiGenerationProvider`
+    .useValue({ generate: (ctx, cfg) => ({}) });
+
+  // Generate for one of more OpenAPI specification files
+  await generator.parseAndGenerate('path/to/openapi.json', 'path/to/another/openapi.yaml');
+
+  // Alternatively, you can generate output for all specifications in a directory.
+  // By default, it will only consider files within the directory (non-recursively) with the extensions: .json, .yaml, .yml.
+  await generator.parseAndGenerateFromDir('path/to/openapi/specs');
+}
+
+main();
+```
+
+## Available Generator Packages 📚
+
+[![@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/kotlin NPM Version](https://img.shields.io/npm/v/%40goast%2Fkotlin?logo=npm&label=%40goast%2Fkotlin)](https://www.npmjs.com/package/@goast/kotlin)
+<br>
+[![@goast/typescript JSR Version](https://img.shields.io/jsr/v/%40goast%2Ftypescript?logo=jsr&label=%40goast%2Ftypescript)](https://jsr.io/@goast/typescript)
+[![@goast/kotlin JSR Version](https://img.shields.io/jsr/v/%40goast%2Fkotlin?logo=jsr&label=%40goast%2Fkotlin)](https://jsr.io/@goast/kotlin)
+
+## API Documentation 📖
+
+The API documentation can be found [here](https://github.com/MaSch0212/goast/wiki).

package/esm/src/parse/parser.js

@@ -92,6 +92,7 @@ export class OpenApiParser {
         return result;
     }
     async resolveReference(file, ref) {
+        var _a;
         const [refFile, refPath] = ref.$ref.split('#');
         let absoluteRefFile = refFile;
         if (!/\S/.test(refFile)) {
@@ -103,7 +104,7 @@ export class OpenApiParser {
         const doc = await this.loadDocument(absoluteRefFile);
         const value = refPath ? getDeepProperty(doc.document, refPath.replace(/[/]/g, '.')) : doc.document;
         if (value && typeof value === 'object') {
-            return this.dereference(absoluteRefFile, refPath.split('/').filter(Boolean), value);
+            return this.dereference(absoluteRefFile, (_a = refPath === null || refPath === void 0 ? void 0 : refPath.split('/').filter(Boolean)) !== null && _a !== void 0 ? _a : [], value);
         }
         return undefined;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@goast/core",
-  "version": "0.5.2",
+  "version": "0.6.0-beta.1",
   "description": "A tool designed to transform OpenAPI specifications into various forms with flexibility and extensibility at its core.",
   "author": {
     "name": "Marc Schmidt (MaSch0212)",

package/script/src/parse/parser.js

@@ -96,6 +96,7 @@ class OpenApiParser {
         return result;
     }
     async resolveReference(file, ref) {
+        var _a;
         const [refFile, refPath] = ref.$ref.split('#');
         let absoluteRefFile = refFile;
         if (!/\S/.test(refFile)) {
@@ -107,7 +108,7 @@ class OpenApiParser {
         const doc = await this.loadDocument(absoluteRefFile);
         const value = refPath ? getDeepProperty(doc.document, refPath.replace(/[/]/g, '.')) : doc.document;
         if (value && typeof value === 'object') {
-            return this.dereference(absoluteRefFile, refPath.split('/').filter(Boolean), value);
+            return this.dereference(absoluteRefFile, (_a = refPath === null || refPath === void 0 ? void 0 : refPath.split('/').filter(Boolean)) !== null && _a !== void 0 ? _a : [], value);
         }
         return undefined;
     }

package/src/_dnt.shims.ts

@@ -1,69 +0,0 @@
-import { fetch, File, FormData, Headers, Request, Response } from "undici";
-export { fetch, File, FormData, Headers, Request, Response, type BodyInit, type HeadersInit, type ReferrerPolicy, type RequestInit, type RequestCache, type RequestMode, type RequestRedirect, type ResponseInit } from "undici";
-
-const dntGlobals = {
-  fetch,
-  File,
-  FormData,
-  Headers,
-  Request,
-  Response,
-};
-export const dntGlobalThis = createMergeProxy(globalThis, dntGlobals);
-
-function createMergeProxy<T extends object, U extends object>(
-  baseObj: T,
-  extObj: U,
-): Omit<T, keyof U> & U {
-  return new Proxy(baseObj, {
-    get(_target, prop, _receiver) {
-      if (prop in extObj) {
-        return (extObj as any)[prop];
-      } else {
-        return (baseObj as any)[prop];
-      }
-    },
-    set(_target, prop, value) {
-      if (prop in extObj) {
-        delete (extObj as any)[prop];
-      }
-      (baseObj as any)[prop] = value;
-      return true;
-    },
-    deleteProperty(_target, prop) {
-      let success = false;
-      if (prop in extObj) {
-        delete (extObj as any)[prop];
-        success = true;
-      }
-      if (prop in baseObj) {
-        delete (baseObj as any)[prop];
-        success = true;
-      }
-      return success;
-    },
-    ownKeys(_target) {
-      const baseKeys = Reflect.ownKeys(baseObj);
-      const extKeys = Reflect.ownKeys(extObj);
-      const extKeysSet = new Set(extKeys);
-      return [...baseKeys.filter((k) => !extKeysSet.has(k)), ...extKeys];
-    },
-    defineProperty(_target, prop, desc) {
-      if (prop in extObj) {
-        delete (extObj as any)[prop];
-      }
-      Reflect.defineProperty(baseObj, prop, desc);
-      return true;
-    },
-    getOwnPropertyDescriptor(_target, prop) {
-      if (prop in extObj) {
-        return Reflect.getOwnPropertyDescriptor(extObj, prop);
-      } else {
-        return Reflect.getOwnPropertyDescriptor(baseObj, prop);
-      }
-    },
-    has(_target, prop) {
-      return prop in extObj || prop in baseObj;
-    },
-  }) as any;
-}

package/src/mod.ts

@@ -1,35 +0,0 @@
-export * from './src/ast/node.js';
-
-export * from './src/codegen/config.js';
-export * from './src/codegen/endpoints-generator.js';
-export * from './src/codegen/generator.js';
-export * from './src/codegen/schemas-generator.js';
-export * from './src/codegen/services-generator.js';
-export * from './src/codegen/types.js';
-
-export * from './src/parse/openapi-types.js';
-export * from './src/parse/parser.js';
-export * from './src/parse/types.js';
-
-export * from './src/transform/api-types.js';
-export * from './src/transform/transformer.js';
-
-export * from './src/utils/api-data.utils.js';
-export * from './src/utils/array.utils.js';
-export * from './src/utils/asset-manager.js';
-export * from './src/utils/class.utils.js';
-export * from './src/utils/common.utils.js';
-export * from './src/utils/endpoint.utils.js';
-export * from './src/utils/error.utils.js';
-export * from './src/utils/factory.js';
-export * from './src/utils/file-system.utils.js';
-export * from './src/utils/generator.utils.js';
-export * from './src/utils/object.utils.js';
-export * from './src/utils/schema.utils.js';
-export * from './src/utils/source-builder.js';
-export * from './src/utils/string-builder/options.js';
-export { type AppendParam, StringBuilder } from './src/utils/string-builder/string-builder.js';
-export * from './src/utils/string-builder/utils.js';
-export * from './src/utils/string.utils.js';
-export * from './src/utils/string.utils.types.js';
-export * from './src/utils/type.utils.js';

package/src/src/ast/node.ts

@@ -1,46 +0,0 @@
-import type { StringBuilder } from '../utils/string-builder/string-builder.js';
-import type { AppendValue } from '../utils/string-builder/utils.js';
-import type { Prettify } from '../utils/type.utils.js';
-
-const NODE_HISTORY_SYMBOL = Symbol('node-history');
-type BuilderWithHistory<T extends StringBuilder = StringBuilder> = T & { [NODE_HISTORY_SYMBOL]?: AstNode[] };
-
-export type AstNodeInject<TBuilder extends StringBuilder, TInjects extends string> = {
-  [K in `${'after' | 'before'}${Capitalize<TInjects>}`]?: AppendValue<TBuilder>;
-};
-
-export type AstNodeOptions<
-  // deno-lint-ignore no-explicit-any
-  TBase extends abstract new (...args: any) => any,
-  // deno-lint-ignore ban-types
-  TExtensions extends object = {},
-> = Prettify<TExtensions & ConstructorParameters<TBase>[0]>;
-
-export abstract class AstNode<TBuilder extends StringBuilder = StringBuilder, TInjects extends string = never> {
-  public inject: AstNodeInject<TBuilder, TInjects | ''>;
-
-  constructor(options: { inject?: AstNode<TBuilder, TInjects>['inject'] }) {
-    this.inject = options.inject ?? {};
-  }
-
-  public write(builder: TBuilder): void {
-    let history = (builder as BuilderWithHistory)[NODE_HISTORY_SYMBOL];
-    if (!history) {
-      history = [];
-      (builder as BuilderWithHistory)[NODE_HISTORY_SYMBOL] = history;
-    }
-
-    history.push(this);
-    builder.append(this.inject.before);
-    this.onWrite(builder);
-    builder.append(this.inject.after);
-    history.pop();
-  }
-
-  protected getParentNode(builder: TBuilder): AstNode | undefined {
-    const history = (builder as BuilderWithHistory)[NODE_HISTORY_SYMBOL];
-    return history?.at(-2);
-  }
-
-  protected abstract onWrite(builder: TBuilder): void;
-}

package/src/src/codegen/config.ts

@@ -1,41 +0,0 @@
-import type { OpenApiParserOptions } from '../parse/types.js';
-import { defaultOpenApiTransformerOptions } from '../transform/types.js';
-import { defaultSourceBuilderOptions, type SourceBuilderOptions } from '../utils/source-builder.js';
-
-export type OpenApiGeneratorConfig =
-  & SourceBuilderOptions
-  & OpenApiParserOptions
-  & {
-    /**
-     * The directory where the generated files should be saved.
-     * @default 'generated'
-     */
-    outputDir: string;
-
-    /**
-     * Whether to clear the output directory before generating the files.
-     * @default true
-     */
-    clearOutputDir: boolean;
-
-    /**
-     * How to handle existing files in the output directory.
-     * - 'override': overwrite existing files.
-     * - 'skip': skip generating files that already exist.
-     * - 'error': throw an error if a file already exists.
-     *
-     * Is is recommended to use `'error'` to prevent issues of two schemas generating the same file and overwriting each other.
-     * If `clearOutputDir` is set to `false`, it is recommended to use `'override'` to ensure that the generated files are up to date.
-     * @default 'error'
-     */
-    existingFileBehavior: 'override' | 'skip' | 'error';
-  };
-
-export const defaultOpenApiGeneratorConfig: OpenApiGeneratorConfig = {
-  ...defaultSourceBuilderOptions,
-  ...defaultOpenApiTransformerOptions,
-
-  outputDir: 'generated',
-  clearOutputDir: true,
-  existingFileBehavior: 'error',
-};

package/src/src/codegen/endpoints-generator.ts

@@ -1,72 +0,0 @@
-import type { ApiEndpoint } from '../transform/api-types.js';
-import type { MaybePromise } from '../utils/type.utils.js';
-import { type DefaultGenerationProviderConfig, OpenApiGenerationProviderBase } from './generator.js';
-import { addSourceIfTest } from './internal-utils.js';
-import type {
-  AnyConfig,
-  OpenApiGenerationProviderContext,
-  OpenApiGeneratorContext,
-  OpenApiGeneratorInput,
-  OpenApiGeneratorOutput,
-} from './types.js';
-
-export type OpenApiEndpointsGenerationProviderContext<
-  TInput extends OpenApiGeneratorInput,
-  TOutput extends OpenApiGeneratorOutput,
-  TConfig extends AnyConfig,
-  TEndpointOutput extends OpenApiGeneratorOutput,
-> = OpenApiGenerationProviderContext<TInput, TConfig> & {
-  existingEndpointResults: Map<string, TEndpointOutput>;
-  output: TOutput;
-};
-
-export abstract class OpenApiEndpointsGenerationProviderBase<
-  TInput extends OpenApiGeneratorInput,
-  TOutput extends OpenApiGeneratorOutput,
-  TConfig extends AnyConfig,
-  TEndpointOutput extends OpenApiGeneratorOutput,
-  TContext extends OpenApiEndpointsGenerationProviderContext<TInput, TOutput, TConfig, TEndpointOutput>,
-> extends OpenApiGenerationProviderBase<TInput, TOutput, TConfig, TContext> {
-  protected override getProviderContext(
-    context: OpenApiGeneratorContext<TInput>,
-    config: Partial<TConfig> | undefined,
-    defaultConfig: DefaultGenerationProviderConfig<TConfig>,
-  ): OpenApiEndpointsGenerationProviderContext<TInput, TOutput, TConfig, TEndpointOutput> {
-    const ctx = super.getProviderContext(context, config, defaultConfig);
-    return Object.assign(ctx, {
-      existingEndpointResults: new Map<string, TEndpointOutput>(),
-      output: this.initResult(ctx),
-    });
-  }
-
-  protected override async onGenerate(ctx: TContext): Promise<TOutput> {
-    for (const endpoint of ctx.data.endpoints) {
-      await this.getEndpointResult(ctx, endpoint);
-    }
-
-    await this.generateAdditionalFiles(ctx);
-
-    return ctx.output;
-  }
-
-  public async getEndpointResult(ctx: TContext, endpoint: ApiEndpoint): Promise<TEndpointOutput> {
-    const existingResult = ctx.existingEndpointResults.get(endpoint.id);
-    if (existingResult) return existingResult;
-
-    const result = await this.generateEndpoint(ctx, endpoint);
-    addSourceIfTest(ctx.config, result, () => `${endpoint.$src.file}#${endpoint.$src.path}`);
-    this.addEndpointResult(ctx, endpoint, result);
-    return result;
-  }
-
-  protected abstract initResult(ctx: OpenApiGenerationProviderContext<TInput, TConfig>): TOutput;
-
-  protected abstract generateEndpoint(ctx: TContext, endpoint: ApiEndpoint): Promise<TEndpointOutput>;
-
-  protected abstract addEndpointResult(ctx: TContext, endpoint: ApiEndpoint, result: TEndpointOutput): void;
-
-  // deno-lint-ignore no-unused-vars
-  protected generateAdditionalFiles(ctx: TContext): MaybePromise<void> {
-    // Override if needed
-  }
-}