@powerlines/plugin-asyncapi 0.1.127 → 0.1.128

package/dist/powerlines/src/types/tsconfig.d.cts

@@ -0,0 +1,69 @@
+import { CompilerOptions, TsConfigJson } from "@stryke/types/tsconfig";
+import ts from "typescript";
+
+//#region ../powerlines/src/types/tsconfig.d.ts
+type ReflectionMode = "default" | "explicit" | "never";
+type RawReflectionMode = ReflectionMode | "" | boolean | string | string[] | undefined;
+/**
+ * Defines the level of reflection to be used during the transpilation process.
+ *
+ * @remarks
+ * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+ * - `minimal` - Only the essential type information is captured.
+ * - `normal` - Additional type information is captured, including some contextual data.
+ * - `verbose` - All available type information is captured, including detailed contextual data.
+ */
+type ReflectionLevel = "minimal" | "normal" | "verbose";
+interface DeepkitOptions {
+  /**
+   * Either true to activate reflection for all files compiled using this tsconfig,
+   * or a list of globs/file paths relative to this tsconfig.json.
+   * Globs/file paths can be prefixed with a ! to exclude them.
+   */
+  reflection?: RawReflectionMode;
+  /**
+   * Defines the level of reflection to be used during the transpilation process.
+   *
+   * @remarks
+   * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+   * - `minimal` - Only the essential type information is captured.
+   * - `normal` - Additional type information is captured, including some contextual data.
+   * - `verbose` - All available type information is captured, including detailed contextual data.
+   */
+  reflectionLevel?: ReflectionLevel;
+}
+type TSCompilerOptions = CompilerOptions & DeepkitOptions;
+/**
+ * The TypeScript compiler configuration.
+ *
+ * @see https://www.typescriptlang.org/docs/handbook/tsconfig-json.html
+ */
+interface TSConfig extends Omit<TsConfigJson, "reflection"> {
+  /**
+   * Either true to activate reflection for all files compiled using this tsconfig,
+   * or a list of globs/file paths relative to this tsconfig.json.
+   * Globs/file paths can be prefixed with a ! to exclude them.
+   */
+  reflection?: RawReflectionMode;
+  /**
+   * Defines the level of reflection to be used during the transpilation process.
+   *
+   * @remarks
+   * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+   * - `minimal` - Only the essential type information is captured.
+   * - `normal` - Additional type information is captured, including some contextual data.
+   * - `verbose` - All available type information is captured, including detailed contextual data.
+   */
+  reflectionLevel?: ReflectionLevel;
+  /**
+   * Instructs the TypeScript compiler how to compile `.ts` files.
+   */
+  compilerOptions?: TSCompilerOptions;
+}
+type ParsedTypeScriptConfig = ts.ParsedCommandLine & {
+  originalTsconfigJson: TsConfigJson;
+  tsconfigJson: TSConfig;
+  tsconfigFilePath: string;
+};
+//#endregion
+export { ParsedTypeScriptConfig, TSConfig };

package/dist/powerlines/src/types/tsconfig.d.mts

@@ -0,0 +1,69 @@
+import { CompilerOptions, TsConfigJson } from "@stryke/types/tsconfig";
+import ts from "typescript";
+
+//#region ../powerlines/src/types/tsconfig.d.ts
+type ReflectionMode = "default" | "explicit" | "never";
+type RawReflectionMode = ReflectionMode | "" | boolean | string | string[] | undefined;
+/**
+ * Defines the level of reflection to be used during the transpilation process.
+ *
+ * @remarks
+ * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+ * - `minimal` - Only the essential type information is captured.
+ * - `normal` - Additional type information is captured, including some contextual data.
+ * - `verbose` - All available type information is captured, including detailed contextual data.
+ */
+type ReflectionLevel = "minimal" | "normal" | "verbose";
+interface DeepkitOptions {
+  /**
+   * Either true to activate reflection for all files compiled using this tsconfig,
+   * or a list of globs/file paths relative to this tsconfig.json.
+   * Globs/file paths can be prefixed with a ! to exclude them.
+   */
+  reflection?: RawReflectionMode;
+  /**
+   * Defines the level of reflection to be used during the transpilation process.
+   *
+   * @remarks
+   * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+   * - `minimal` - Only the essential type information is captured.
+   * - `normal` - Additional type information is captured, including some contextual data.
+   * - `verbose` - All available type information is captured, including detailed contextual data.
+   */
+  reflectionLevel?: ReflectionLevel;
+}
+type TSCompilerOptions = CompilerOptions & DeepkitOptions;
+/**
+ * The TypeScript compiler configuration.
+ *
+ * @see https://www.typescriptlang.org/docs/handbook/tsconfig-json.html
+ */
+interface TSConfig extends Omit<TsConfigJson, "reflection"> {
+  /**
+   * Either true to activate reflection for all files compiled using this tsconfig,
+   * or a list of globs/file paths relative to this tsconfig.json.
+   * Globs/file paths can be prefixed with a ! to exclude them.
+   */
+  reflection?: RawReflectionMode;
+  /**
+   * Defines the level of reflection to be used during the transpilation process.
+   *
+   * @remarks
+   * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+   * - `minimal` - Only the essential type information is captured.
+   * - `normal` - Additional type information is captured, including some contextual data.
+   * - `verbose` - All available type information is captured, including detailed contextual data.
+   */
+  reflectionLevel?: ReflectionLevel;
+  /**
+   * Instructs the TypeScript compiler how to compile `.ts` files.
+   */
+  compilerOptions?: TSCompilerOptions;
+}
+type ParsedTypeScriptConfig = ts.ParsedCommandLine & {
+  originalTsconfigJson: TsConfigJson;
+  tsconfigJson: TSConfig;
+  tsconfigFilePath: string;
+};
+//#endregion
+export { ParsedTypeScriptConfig, TSConfig };

package/dist/types/index.cjs

@@ -1,2 +0,0 @@
-require('../plugin-DHXHjv16.cjs');
-require('../types-DHkg7xmX.cjs');

package/dist/types/index.d.cts

@@ -1,3 +1,2 @@
-import { a as __ΩAsyncAPIPluginContext, c as __ΩAsyncAPIPluginUserConfig, i as AsyncAPIPluginUserConfig, n as AsyncAPIPluginOptions, o as __ΩAsyncAPIPluginOptions, r as AsyncAPIPluginResolvedConfig, s as __ΩAsyncAPIPluginResolvedConfig, t as AsyncAPIPluginContext } from "../plugin-C5ISt14v.cjs";
-import "../index-CEgs-Dz2.cjs";
+import { AsyncAPIPluginContext, AsyncAPIPluginOptions, AsyncAPIPluginResolvedConfig, AsyncAPIPluginUserConfig, __ΩAsyncAPIPluginContext, __ΩAsyncAPIPluginOptions, __ΩAsyncAPIPluginResolvedConfig, __ΩAsyncAPIPluginUserConfig } from "./plugin.cjs";
 export { AsyncAPIPluginContext, AsyncAPIPluginOptions, AsyncAPIPluginResolvedConfig, AsyncAPIPluginUserConfig, __ΩAsyncAPIPluginContext, __ΩAsyncAPIPluginOptions, __ΩAsyncAPIPluginResolvedConfig, __ΩAsyncAPIPluginUserConfig };

package/dist/types/index.d.mts

@@ -1,3 +1,2 @@
-import { a as __ΩAsyncAPIPluginContext, c as __ΩAsyncAPIPluginUserConfig, i as AsyncAPIPluginUserConfig, n as AsyncAPIPluginOptions, o as __ΩAsyncAPIPluginOptions, r as AsyncAPIPluginResolvedConfig, s as __ΩAsyncAPIPluginResolvedConfig, t as AsyncAPIPluginContext } from "../plugin-BWqYPTAH.mjs";
-import "../index-BgAdqTbb.mjs";
+import { AsyncAPIPluginContext, AsyncAPIPluginOptions, AsyncAPIPluginResolvedConfig, AsyncAPIPluginUserConfig, __ΩAsyncAPIPluginContext, __ΩAsyncAPIPluginOptions, __ΩAsyncAPIPluginResolvedConfig, __ΩAsyncAPIPluginUserConfig } from "./plugin.mjs";
 export { AsyncAPIPluginContext, AsyncAPIPluginOptions, AsyncAPIPluginResolvedConfig, AsyncAPIPluginUserConfig, __ΩAsyncAPIPluginContext, __ΩAsyncAPIPluginOptions, __ΩAsyncAPIPluginResolvedConfig, __ΩAsyncAPIPluginUserConfig };

package/dist/types/index.mjs

@@ -1,4 +1 @@
-import "../plugin-C3MaN5jp.mjs";
-import "../types-CTUnla4x.mjs";
-
 export {  };

package/dist/types/plugin.cjs

@@ -1 +0,0 @@
-require('../plugin-DHXHjv16.cjs');

package/dist/types/plugin.d.cts

@@ -1,2 +1,101 @@
-import { a as __ΩAsyncAPIPluginContext, c as __ΩAsyncAPIPluginUserConfig, i as AsyncAPIPluginUserConfig, n as AsyncAPIPluginOptions, o as __ΩAsyncAPIPluginOptions, r as AsyncAPIPluginResolvedConfig, s as __ΩAsyncAPIPluginResolvedConfig, t as AsyncAPIPluginContext } from "../plugin-C5ISt14v.cjs";
+import { UserConfig } from "../powerlines/src/types/config.cjs";
+import { ResolvedConfig } from "../powerlines/src/types/resolved.cjs";
+import { PluginContext } from "../powerlines/src/types/context.cjs";
+import { GeneratorOptions } from "@asyncapi/generator";
+import { AsyncAPIDocument } from "@asyncapi/parser/esm/models/v3/asyncapi";
+
+//#region src/types/plugin.d.ts
+interface AsyncAPIPluginOptions {
+  /**
+   * The path to the AsyncAPI schema file.
+   *
+   * @remarks
+   * This can be a string file path/remote URL string or a {@link URL} object.
+   *
+   * @defaultValue "\{projectRoot\}/schema.yaml"
+   */
+  schema?: string | URL | AsyncAPIDocument;
+  /**
+   * The name of the AsyncAPI template to use.
+   *
+   * @remarks
+   * This can be a local path or a template package that will be installed by AsyncAPI.
+   */
+  templateName: string;
+  /**
+   * The target directory where the generated files will be written.
+   *
+   * @remarks
+   * If using the default value, the files can be imported from "powerlines:asyncapi/fileName". This field allows the use of the "\{builtinPath\}" token to refer to the built-in Powerlines plugins directory - the value will be replaced with the correct file path by the plugin.
+   *
+   * @defaultValue "\{builtinPath\}/asyncapi"
+   */
+  outputPath?: string;
+  /**
+   * Name of the file to use as the entry point for the rendering process. Use in case you want to use only a specific template file. Note: this potentially avoids rendering every file in the template.
+   */
+  entrypoint?: string;
+  /**
+   * Template parameters to pass to the AsyncAPI generator.
+   */
+  templateParams?: Record<string, any>;
+  /**
+   * Glob patterns to prevent overwriting specific files.
+   */
+  noOverwriteGlobs?: string[];
+  /**
+   * Object with hooks to disable. The key is a hook type. If key has "true" value, then the generator skips all hooks from the given type. If the value associated with a key is a string with the name of a single hook, then the generator skips only this single hook name. If the value associated with a key is an array of strings, then the generator skips only hooks from the array.
+   */
+  disabledHooks?: Record<string, boolean | string | string[]>;
+  /**
+   * The registry to use for installing templates/dependencies.
+   *
+   * @remarks
+   * If no value is provided, the default registry configured for the repository will be used.
+   */
+  registry?: string | {
+    url: string;
+    auth?: string;
+    token?: string;
+  };
+  /**
+   * Whether to force write files even if they exist.
+   *
+   * @defaultValue true
+   */
+  forceWrite?: boolean;
+  /**
+   * Whether to enable debug mode.
+   *
+   * @remarks
+   * When no value is provided, if `mode` is "development" or `logLevel` is "debug" or "trace", debug mode will be enabled by default.
+   *
+   * @defaultValue false
+   */
+  debug?: boolean;
+  /**
+   * Whether to compile the template before generating files.
+   *
+   * @defaultValue false
+   */
+  compile?: boolean;
+  /**
+   * Optional parameter to map schema references from a base url to a local base folder e.g. url=https://schema.example.com/crm/  folder=./test/docs/ .
+   */
+  mapBaseUrlToFolder?: Record<string, string>;
+}
+type AsyncAPIPluginUserConfig = UserConfig & {
+  asyncapi?: GeneratorOptions & Required<Pick<AsyncAPIPluginOptions, "schema" | "templateName" | "outputPath">>;
+};
+type AsyncAPIPluginResolvedConfig = ResolvedConfig & {
+  asyncapi: GeneratorOptions & Required<Pick<AsyncAPIPluginOptions, "schema" | "templateName" | "outputPath">> & {
+    document: string | AsyncAPIDocument;
+  };
+};
+type AsyncAPIPluginContext<TResolvedConfig extends AsyncAPIPluginResolvedConfig = AsyncAPIPluginResolvedConfig> = PluginContext<TResolvedConfig>;
+declare type __ΩAsyncAPIPluginOptions = any[];
+declare type __ΩAsyncAPIPluginUserConfig = any[];
+declare type __ΩAsyncAPIPluginResolvedConfig = any[];
+declare type __ΩAsyncAPIPluginContext = any[];
+//#endregion
 export { AsyncAPIPluginContext, AsyncAPIPluginOptions, AsyncAPIPluginResolvedConfig, AsyncAPIPluginUserConfig, __ΩAsyncAPIPluginContext, __ΩAsyncAPIPluginOptions, __ΩAsyncAPIPluginResolvedConfig, __ΩAsyncAPIPluginUserConfig };

package/dist/types/plugin.d.mts

@@ -1,2 +1,101 @@
-import { a as __ΩAsyncAPIPluginContext, c as __ΩAsyncAPIPluginUserConfig, i as AsyncAPIPluginUserConfig, n as AsyncAPIPluginOptions, o as __ΩAsyncAPIPluginOptions, r as AsyncAPIPluginResolvedConfig, s as __ΩAsyncAPIPluginResolvedConfig, t as AsyncAPIPluginContext } from "../plugin-BWqYPTAH.mjs";
+import { UserConfig } from "../powerlines/src/types/config.mjs";
+import { ResolvedConfig } from "../powerlines/src/types/resolved.mjs";
+import { PluginContext } from "../powerlines/src/types/context.mjs";
+import { GeneratorOptions } from "@asyncapi/generator";
+import { AsyncAPIDocument } from "@asyncapi/parser/esm/models/v3/asyncapi";
+
+//#region src/types/plugin.d.ts
+interface AsyncAPIPluginOptions {
+  /**
+   * The path to the AsyncAPI schema file.
+   *
+   * @remarks
+   * This can be a string file path/remote URL string or a {@link URL} object.
+   *
+   * @defaultValue "\{projectRoot\}/schema.yaml"
+   */
+  schema?: string | URL | AsyncAPIDocument;
+  /**
+   * The name of the AsyncAPI template to use.
+   *
+   * @remarks
+   * This can be a local path or a template package that will be installed by AsyncAPI.
+   */
+  templateName: string;
+  /**
+   * The target directory where the generated files will be written.
+   *
+   * @remarks
+   * If using the default value, the files can be imported from "powerlines:asyncapi/fileName". This field allows the use of the "\{builtinPath\}" token to refer to the built-in Powerlines plugins directory - the value will be replaced with the correct file path by the plugin.
+   *
+   * @defaultValue "\{builtinPath\}/asyncapi"
+   */
+  outputPath?: string;
+  /**
+   * Name of the file to use as the entry point for the rendering process. Use in case you want to use only a specific template file. Note: this potentially avoids rendering every file in the template.
+   */
+  entrypoint?: string;
+  /**
+   * Template parameters to pass to the AsyncAPI generator.
+   */
+  templateParams?: Record<string, any>;
+  /**
+   * Glob patterns to prevent overwriting specific files.
+   */
+  noOverwriteGlobs?: string[];
+  /**
+   * Object with hooks to disable. The key is a hook type. If key has "true" value, then the generator skips all hooks from the given type. If the value associated with a key is a string with the name of a single hook, then the generator skips only this single hook name. If the value associated with a key is an array of strings, then the generator skips only hooks from the array.
+   */
+  disabledHooks?: Record<string, boolean | string | string[]>;
+  /**
+   * The registry to use for installing templates/dependencies.
+   *
+   * @remarks
+   * If no value is provided, the default registry configured for the repository will be used.
+   */
+  registry?: string | {
+    url: string;
+    auth?: string;
+    token?: string;
+  };
+  /**
+   * Whether to force write files even if they exist.
+   *
+   * @defaultValue true
+   */
+  forceWrite?: boolean;
+  /**
+   * Whether to enable debug mode.
+   *
+   * @remarks
+   * When no value is provided, if `mode` is "development" or `logLevel` is "debug" or "trace", debug mode will be enabled by default.
+   *
+   * @defaultValue false
+   */
+  debug?: boolean;
+  /**
+   * Whether to compile the template before generating files.
+   *
+   * @defaultValue false
+   */
+  compile?: boolean;
+  /**
+   * Optional parameter to map schema references from a base url to a local base folder e.g. url=https://schema.example.com/crm/  folder=./test/docs/ .
+   */
+  mapBaseUrlToFolder?: Record<string, string>;
+}
+type AsyncAPIPluginUserConfig = UserConfig & {
+  asyncapi?: GeneratorOptions & Required<Pick<AsyncAPIPluginOptions, "schema" | "templateName" | "outputPath">>;
+};
+type AsyncAPIPluginResolvedConfig = ResolvedConfig & {
+  asyncapi: GeneratorOptions & Required<Pick<AsyncAPIPluginOptions, "schema" | "templateName" | "outputPath">> & {
+    document: string | AsyncAPIDocument;
+  };
+};
+type AsyncAPIPluginContext<TResolvedConfig extends AsyncAPIPluginResolvedConfig = AsyncAPIPluginResolvedConfig> = PluginContext<TResolvedConfig>;
+declare type __ΩAsyncAPIPluginOptions = any[];
+declare type __ΩAsyncAPIPluginUserConfig = any[];
+declare type __ΩAsyncAPIPluginResolvedConfig = any[];
+declare type __ΩAsyncAPIPluginContext = any[];
+//#endregion
 export { AsyncAPIPluginContext, AsyncAPIPluginOptions, AsyncAPIPluginResolvedConfig, AsyncAPIPluginUserConfig, __ΩAsyncAPIPluginContext, __ΩAsyncAPIPluginOptions, __ΩAsyncAPIPluginResolvedConfig, __ΩAsyncAPIPluginUserConfig };

package/dist/types/plugin.mjs

@@ -1,3 +1 @@
-import "../plugin-C3MaN5jp.mjs";
-
 export {  };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powerlines/plugin-asyncapi",
-  "version": "0.1.127",
+  "version": "0.1.128",
   "type": "module",
   "description": "A Powerlines plugin to generate project code from AsyncAPI specifications.",
   "repository": {
@@ -124,13 +124,13 @@
     "@stryke/http": "^0.12.21",
     "@stryke/path": "^0.24.1",
     "defu": "^6.1.4",
-    "powerlines": "^0.36.27"
+    "powerlines": "^0.36.28"
   },
   "devDependencies": {
-    "@powerlines/nx": "^0.11.53",
-    "@powerlines/plugin-plugin": "^0.12.75",
+    "@powerlines/nx": "^0.11.54",
+    "@powerlines/plugin-plugin": "^0.12.76",
     "@types/node": "^24.10.4"
   },
   "publishConfig": { "access": "public" },
-  "gitHead": "fbc59ce584fd0f78d90d2dbaa18f9c9267bd3b61"
+  "gitHead": "6891ff1330798e807c4caef6134df09d9f57686d"
 }

package/dist/index-BgAdqTbb.d.mts

@@ -1 +0,0 @@
-export { };

package/dist/index-CEgs-Dz2.d.cts

@@ -1 +0,0 @@
-export { };