ts-class-to-openapi 1.3.2 → 1.3.4

package/dist/index.d.cts

@@ -0,0 +1,56 @@
+//#region src/types.d.ts
+type SchemaType = ({
+  [key: string]: any;
+} & {
+  properties: {
+    [key: string]: any;
+  } & {
+    additionalProperties?: boolean;
+  };
+} & {
+  required?: string[];
+} & {
+  type: string;
+}) | ({
+  [key: string]: any;
+} & {
+  $ref: string;
+}) | ({
+  [key: string]: any;
+} & {
+  type: 'array';
+} & {
+  items: SchemaType;
+});
+/**
+ * Information about a class-validator decorator found on a property.
+ * @interface DecoratorInfo
+ */
+/**
+ * Configuration options for SchemaTransformer memory management
+ * @interface TransformerOptions
+ */
+interface TransformerOptions {
+  /** Maximum number of schemas to cache before cleanup (default: 100) */
+  maxCacheSize?: number;
+  /** Whether to automatically clean up cache (default: true) */
+  autoCleanup?: boolean;
+  /** Options related to the source of the class being transformed */
+  sourceOptions?: {
+    /** Whether the class is from an external module */isExternal: true; /** The package name (required when isExternal is true) */
+    packageName: string; /** The file path of the class being transformed */
+    filePath?: string;
+  } | {
+    /** Whether the class is from an external module */isExternal: false; /** The package name (optional when isExternal is false) */
+    packageName: never; /** The file path of the class being transformed */
+    filePath?: string;
+  };
+}
+//#endregion
+//#region src/transformer.d.ts
+declare function transform<T>(cls: new (...args: any[]) => T, options?: TransformerOptions): {
+  name: string;
+  schema: SchemaType;
+};
+//#endregion
+export { type SchemaType, type TransformerOptions, transform };

package/dist/index.d.mts

@@ -0,0 +1,58 @@
+import ts from "typescript";
+
+//#region src/types.d.ts
+type SchemaType = ({
+  [key: string]: any;
+} & {
+  properties: {
+    [key: string]: any;
+  } & {
+    additionalProperties?: boolean;
+  };
+} & {
+  required?: string[];
+} & {
+  type: string;
+}) | ({
+  [key: string]: any;
+} & {
+  $ref: string;
+}) | ({
+  [key: string]: any;
+} & {
+  type: 'array';
+} & {
+  items: SchemaType;
+});
+/**
+ * Information about a class-validator decorator found on a property.
+ * @interface DecoratorInfo
+ */
+/**
+ * Configuration options for SchemaTransformer memory management
+ * @interface TransformerOptions
+ */
+interface TransformerOptions {
+  /** Maximum number of schemas to cache before cleanup (default: 100) */
+  maxCacheSize?: number;
+  /** Whether to automatically clean up cache (default: true) */
+  autoCleanup?: boolean;
+  /** Options related to the source of the class being transformed */
+  sourceOptions?: {
+    /** Whether the class is from an external module */isExternal: true; /** The package name (required when isExternal is true) */
+    packageName: string; /** The file path of the class being transformed */
+    filePath?: string;
+  } | {
+    /** Whether the class is from an external module */isExternal: false; /** The package name (optional when isExternal is false) */
+    packageName: never; /** The file path of the class being transformed */
+    filePath?: string;
+  };
+}
+//#endregion
+//#region src/transformer.d.ts
+declare function transform<T>(cls: new (...args: any[]) => T, options?: TransformerOptions): {
+  name: string;
+  schema: SchemaType;
+};
+//#endregion
+export { type SchemaType, type TransformerOptions, transform };