inviton-backduck 1.0.0

package/dist/apidoc/parameterGeneratorRegistry.js

@@ -0,0 +1,6 @@
+/**
+ * Registry mapping parameter generator names to functions.
+ * Functions take args as (string | number)[] and return SwaggerParameter[].
+ */
+export const parameterGeneratorRegistry = {};
+//# sourceMappingURL=parameterGeneratorRegistry.js.map

package/dist/apidoc/parameterGeneratorRegistry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameterGeneratorRegistry.js","sourceRoot":"","sources":["../../src/apidoc/parameterGeneratorRegistry.ts"],"names":[],"mappings":"AAeA;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAyE,EAE/G,CAAC"}

package/dist/apidoc/test-type-resolver.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=test-type-resolver.d.ts.map

package/dist/apidoc/test-type-resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-type-resolver.d.ts","sourceRoot":"","sources":["../../src/apidoc/test-type-resolver.ts"],"names":[],"mappings":""}

package/dist/apidoc/test-type-resolver.js

@@ -0,0 +1,6 @@
+import path from 'node:path';
+import { TypeResolver } from './type-resolver';
+const serverDir = path.join(__dirname, '..', '..', '..');
+const r = new TypeResolver(serverDir);
+console.log(typeof r.resolveType === 'function' ? 'OK' : 'FAIL');
+//# sourceMappingURL=test-type-resolver.js.map

package/dist/apidoc/test-type-resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-type-resolver.js","sourceRoot":"","sources":["../../src/apidoc/test-type-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAC1B,SAAS,EACT,IAAI,EACJ,IAAI,EACJ,IAAI,CACJ,CAAC;AACF,MAAM,CAAC,GAAG,IAAI,YAAY,CAAC,SAAS,CAAC,CAAC;AACtC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,WAAW,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC"}

package/dist/apidoc/type-resolver.d.ts

@@ -0,0 +1,266 @@
+import type { PropertySignature, SourceFile, Type } from 'ts-morph';
+/**
+ * Represents a resolved property from a TypeScript interface
+ */
+export interface ResolvedProperty {
+    /** Property name */
+    name: string;
+    /** OpenAPI-compatible type descriptor */
+    type: OpenApiType;
+    /** Whether the property is optional */
+    optional: boolean;
+    /** JSDoc description */
+    description: string | null;
+}
+/**
+ * OpenAPI type descriptor
+ */
+export interface OpenApiType {
+    /** OpenAPI type (string, number, integer, boolean, array, object) - optional when using $ref or oneOf */
+    'type'?: string;
+    /** Format for string types (date, date-time, etc.) */
+    'format'?: string;
+    /** Description from JSDoc or type definition */
+    'description'?: string;
+    /** For array types, describes the item type */
+    'items'?: OpenApiType;
+    /** For object types, describes the properties */
+    'properties'?: Record<string, OpenApiType>;
+    /** Required property names for object types */
+    'required'?: string[];
+    /** Reference to another schema (for $ref) */
+    '$ref'?: string;
+    /** Enum values */
+    'enum'?: (string | number)[];
+    /** Enum members with names and descriptions (OpenAPI extension) */
+    'x-enum-members'?: EnumMember[];
+    /** For union types (oneOf) */
+    'oneOf'?: OpenApiType[];
+    /** For nullable types */
+    'nullable'?: boolean;
+    /** Additional properties for object types */
+    'additionalProperties'?: boolean | OpenApiType;
+    /** Example value for the type */
+    'example'?: unknown;
+    /** Marks this field as only available in enterprise mode (OpenAPI extension) */
+    'x-enterprise-only'?: boolean;
+}
+/**
+ * Resolved type information including all properties
+ */
+/**
+ * Enum member with name, value, and description
+ */
+export interface EnumMember {
+    /** Member name (e.g., "SHOP") */
+    name: string;
+    /** Member value (e.g., 0 or "active") */
+    value: string | number;
+    /** JSDoc description if available */
+    description: string | null;
+}
+export interface ResolvedType {
+    /** Type name */
+    name: string;
+    /** Full type description */
+    description: string | null;
+    /** Resolved properties (flattened from inheritance) */
+    properties: ResolvedProperty[];
+    /** Whether this is an enum type */
+    isEnum: boolean;
+    /** Enum values if applicable (deprecated, use enumMembers instead) */
+    enumValues?: (string | number)[];
+    /** Enum members with full info (name, value, description) */
+    enumMembers?: EnumMember[];
+    /** Original file path where type is defined */
+    sourcePath: string | null;
+}
+/**
+ * TypeScript type resolver for OpenAPI schema generation
+ * Handles inheritance, utility types (Pick, Omit), Temporal types, and JSDoc extraction
+ */
+export declare class TypeResolver {
+    private project;
+    private serverDir;
+    private resolvedTypes;
+    private resolvingStack;
+    private serviceInterfaceCache;
+    private conversionDepth;
+    private readonly MAX_CONVERSION_DEPTH;
+    /** Cache for OpenAPI type conversions keyed by type text */
+    private openApiTypeCache;
+    /** Cache for loaded source files */
+    private sourceFileCache;
+    /** Cache for directory file listings */
+    private directoryFilesCache;
+    constructor(serverDir: string);
+    /**
+     * Resolve a type by name and return its OpenAPI schema
+     */
+    resolveType(typeName: string, sourceFile?: SourceFile): ResolvedType | null;
+    /**
+     * Convert a resolved type to OpenAPI schema
+     */
+    typeToOpenApiSchema(resolvedType: ResolvedType): OpenApiType;
+    /**
+     * Convert a TypeScript type directly to OpenAPI type
+     */
+    tsTypeToOpenApi(type: Type, propertyName?: string): OpenApiType;
+    /**
+     * Internal implementation of tsTypeToOpenApi
+     */
+    private tsTypeToOpenApiInternal;
+    /**
+     * Extract JSDoc description from a property
+     */
+    extractPropertyJsDoc(property: PropertySignature): string | null;
+    /**
+     * Check if JSDoc contains @privateField tag (case insensitive)
+     * Fields with this tag should be omitted from API documentation
+     */
+    private hasPrivateFieldTag;
+    /**
+     * Check if JSDoc contains @enterpriseOnly tag (case insensitive)
+     * Fields with this tag are only available in enterprise mode
+     */
+    private hasEnterpriseOnlyTag;
+    /**
+     * Clean JSDoc description by removing other JSDoc tags but preserving {@link} tags
+     * The {@link} tags will be converted to HTML links later by the HTML generator
+     * @param description The raw JSDoc description
+     * @param preserveNewlines Whether to preserve newlines (default: false for backward compatibility)
+     */
+    private cleanJsDocDescription;
+    /**
+     * Get all resolved types (for component schemas)
+     */
+    getAllResolvedTypes(): Map<string, ResolvedType>;
+    /**
+     * Clear the resolved types cache
+     */
+    clearCache(): void;
+    /**
+     * Add a source file to the project for type resolution (with caching)
+     */
+    addSourceFile(filePath: string): SourceFile | undefined;
+    /**
+     * Extract extra parameters generator info from @extraParameters JSDoc tag in service interface method.
+     * @param interfaceName The name of the service interface (e.g., "IOfferService")
+     * @param methodName The name of the method to extract extra parameters from
+     * @returns Extra parameter generator info or null if not found
+     */
+    extractServiceMethodExtraParameters(interfaceName: string, methodName: string): {
+        name: string;
+        args: (string | number)[];
+    } | null;
+    /**
+     * Extract extra parameters generator info from JSDoc
+     */
+    private extractExtraParametersFromJsDoc;
+    /**
+     * Extract extra parameters generator info from property JSDoc
+     */
+    private extractExtraParametersFromPropertyJsDoc;
+    /**
+     * Extract JSDoc description from a service interface method
+     * @param interfaceName The name of the service interface (e.g., "ICartService")
+     * @param methodName The name of the method to extract JSDoc from (e.g., "validateCart")
+     * @returns The JSDoc description or null if not found
+     */
+    extractServiceMethodJsDoc(interfaceName: string, methodName: string): string | null;
+    /**
+     * Internal type resolution logic
+     */
+    private resolveTypeInternal;
+    /**
+     * Resolve an interface declaration including inherited properties
+     */
+    private resolveInterface;
+    /**
+     * Resolve a class declaration including inherited properties
+     */
+    private resolveClass;
+    /**
+     * Resolve a class property declaration to ResolvedProperty
+     * Returns null if the property has @privateField tag
+     */
+    private resolveClassProperty;
+    /**
+     * Extract JSDoc description from a class property
+     */
+    private extractClassPropertyJsDoc;
+    /**
+     * Resolve a type alias declaration (handles Pick, Omit, etc.)
+     */
+    private resolveTypeAlias;
+    /**
+     * Resolve Pick<T, K> utility type
+     */
+    private resolvePickType;
+    /**
+     * Resolve Omit<T, K> utility type
+     */
+    private resolveOmitType;
+    /**
+     * Resolve Partial<T> utility type
+     */
+    private resolvePartialType;
+    /**
+     * Resolve Required<T> utility type
+     */
+    private resolveRequiredType;
+    /**
+     * Resolve intersection type alias (Type1 & Type2 & { extra })
+     */
+    private resolveIntersectionTypeAlias;
+    /**
+     * Resolve properties from a Type object
+     */
+    private resolveTypeProperties;
+    /**
+     * Resolve a property signature to ResolvedProperty
+     * Returns null if the property has @privateField tag
+     */
+    private resolveProperty;
+    /**
+     * Resolve type from a Symbol
+     */
+    private resolveTypeFromSymbol;
+    /**
+     * Find type declaration by name
+     */
+    private findTypeDeclaration;
+    /**
+     * Find type in a specific source file
+     */
+    private findTypeInSourceFile;
+    /**
+     * Extract JSDoc description from a node
+     */
+    private extractNodeJsDoc;
+    /**
+     * Parse union keys from a string like "'id' | 'name' | 'email'"
+     */
+    private parseUnionKeys;
+    /**
+     * Clean type name by removing import() paths and namespaces
+     */
+    private cleanTypeName;
+    /**
+     * Create an empty resolved type for error cases
+     */
+    private createEmptyResolvedType;
+    /**
+     * Find files recursively matching a pattern
+     */
+    private findFilesRecursive;
+    /**
+     * Walk directory recursively
+     */
+    private walkDirectory;
+    /**
+     * Convert glob pattern to regex
+     */
+    private globToRegex;
+}
+//# sourceMappingURL=type-resolver.d.ts.map

package/dist/apidoc/type-resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-resolver.d.ts","sourceRoot":"","sources":["../../src/apidoc/type-resolver.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAIX,iBAAiB,EACjB,UAAU,EAEV,IAAI,EAEJ,MAAM,UAAU,CAAC;AASlB;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,IAAI,EAAE,WAAW,CAAC;IAClB,uCAAuC;IACvC,QAAQ,EAAE,OAAO,CAAC;IAClB,wBAAwB;IACxB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B,yGAAyG;IACzG,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,sDAAsD;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gDAAgD;IAChD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,+CAA+C;IAC/C,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,iDAAiD;IACjD,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC3C,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kBAAkB;IAClB,MAAM,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAC7B,mEAAmE;IACnE,gBAAgB,CAAC,EAAE,UAAU,EAAE,CAAC;IAChC,8BAA8B;IAC9B,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;IACxB,yBAAyB;IACzB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,6CAA6C;IAC7C,sBAAsB,CAAC,EAAE,OAAO,GAAG,WAAW,CAAC;IAC/C,iCAAiC;IACjC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,gFAAgF;IAChF,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH;;GAEG;AACH,MAAM,WAAW,UAAU;IAC1B,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,qCAAqC;IACrC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,YAAY;IAC5B,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,4BAA4B;IAC5B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,uDAAuD;IACvD,UAAU,EAAE,gBAAgB,EAAE,CAAC;IAC/B,mCAAmC;IACnC,MAAM,EAAE,OAAO,CAAC;IAChB,sEAAsE;IACtE,UAAU,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IACjC,6DAA6D;IAC7D,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC;IAC3B,+CAA+C;IAC/C,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;;GAGG;AACH,qBAAa,YAAY;IACxB,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,aAAa,CAAwC;IAC7D,OAAO,CAAC,cAAc,CAA0B;IAChD,OAAO,CAAC,qBAAqB,CAAuD;IACpF,OAAO,CAAC,eAAe,CAAK;IAC5B,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAM;IAC3C,4DAA4D;IAC5D,OAAO,CAAC,gBAAgB,CAAuC;IAC/D,oCAAoC;IACpC,OAAO,CAAC,eAAe,CAAsC;IAC7D,wCAAwC;IACxC,OAAO,CAAC,mBAAmB,CAAoC;gBAEnD,SAAS,EAAE,MAAM;IAQ7B;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI;IAmC3E;;OAEG;IACH,mBAAmB,CAAC,YAAY,EAAE,YAAY,GAAG,WAAW;IA+B5D;;OAEG;IACH,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,WAAW;IA8B/D;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAwP/B;;OAEG;IACH,oBAAoB,CAAC,QAAQ,EAAE,iBAAiB,GAAG,MAAM,GAAG,IAAI;IAYhE;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAQ1B;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAQ5B;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;IAqB7B;;OAEG;IACH,mBAAmB,IAAI,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC;IAIhD;;OAEG;IACH,UAAU,IAAI,IAAI;IAMlB;;OAEG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAiBvD;;;;;OAKG;IACH,mCAAmC,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;KAAE,GAAG,IAAI;IA2ClI;;OAEG;IACH,OAAO,CAAC,+BAA+B;IAsCvC;;OAEG;IACH,OAAO,CAAC,uCAAuC;IAU/C;;;;;OAKG;IACH,yBAAyB,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IA6CnF;;OAEG;IACH,OAAO,CAAC,mBAAmB;IA+D3B;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAiDxB;;OAEG;IACH,OAAO,CAAC,YAAY;IAiDpB;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAqD5B;;OAEG;IACH,OAAO,CAAC,yBAAyB;IAgCjC;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAoFxB;;OAEG;IACH,OAAO,CAAC,eAAe;IA2BvB;;OAEG;IACH,OAAO,CAAC,eAAe;IA2BvB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA6B1B;;OAEG;IACH,OAAO,CAAC,mBAAmB;IA6B3B;;OAEG;IACH,OAAO,CAAC,4BAA4B;IAapC;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAsC7B;;;OAGG;IACH,OAAO,CAAC,eAAe;IAqDvB;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAc7B;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAgE3B;;OAEG;IACH,OAAO,CAAC,oBAAoB;IA2C5B;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAcxB;;OAEG;IACH,OAAO,CAAC,cAAc;IAgBtB;;OAEG;IACH,OAAO,CAAC,aAAa;IAuBrB;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAU/B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA8B1B;;OAEG;IACH,OAAO,CAAC,aAAa;IAoCrB;;OAEG;IACH,OAAO,CAAC,WAAW;CAgBnB"}