adorn-api 1.0.21 → 1.0.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cli.cjs +114 -25
- package/dist/cli.cjs.map +1 -1
- package/dist/cli.js +114 -25
- package/dist/cli.js.map +1 -1
- package/dist/compiler/schema/openapi.d.ts +29 -0
- package/dist/compiler/schema/openapi.d.ts.map +1 -1
- package/dist/compiler/schema/queryBuilderAnalyzer.d.ts +33 -0
- package/dist/compiler/schema/queryBuilderAnalyzer.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -25,6 +25,33 @@ export interface OpenAPI31 {
|
|
|
25
25
|
export interface OpenAPIProgressCallback {
|
|
26
26
|
(message: string, current: number, total: number): void;
|
|
27
27
|
}
|
|
28
|
+
/**
|
|
29
|
+
* Detailed progress callback with query builder analysis info
|
|
30
|
+
*/
|
|
31
|
+
export interface OpenAPIDetailedProgressCallback {
|
|
32
|
+
(info: {
|
|
33
|
+
/** Controller being processed */
|
|
34
|
+
controller: string;
|
|
35
|
+
/** Operation being processed */
|
|
36
|
+
operation: string;
|
|
37
|
+
/** HTTP method */
|
|
38
|
+
method: string;
|
|
39
|
+
/** Operation path */
|
|
40
|
+
path: string;
|
|
41
|
+
/** Whether query builder pattern was detected */
|
|
42
|
+
queryBuilderDetected: boolean;
|
|
43
|
+
/** Entity name if detected */
|
|
44
|
+
entityName?: string;
|
|
45
|
+
/** Selected fields if detected */
|
|
46
|
+
selectedFields?: string[];
|
|
47
|
+
/** Whether using paged results */
|
|
48
|
+
isPaged?: boolean;
|
|
49
|
+
/** Current progress */
|
|
50
|
+
current: number;
|
|
51
|
+
/** Total operations */
|
|
52
|
+
total: number;
|
|
53
|
+
}): void;
|
|
54
|
+
}
|
|
28
55
|
/**
|
|
29
56
|
* Generates an OpenAPI 3.1 specification from scanned controllers.
|
|
30
57
|
*
|
|
@@ -32,11 +59,13 @@ export interface OpenAPIProgressCallback {
|
|
|
32
59
|
* @param checker - TypeScript type checker for type analysis
|
|
33
60
|
* @param options - Optional title and version for the OpenAPI info object
|
|
34
61
|
* @param onProgress - Optional callback to report progress during generation
|
|
62
|
+
* @param onQueryBuilderProgress - Optional callback to report query builder detection details
|
|
35
63
|
* @returns Complete OpenAPI 3.1 specification object
|
|
36
64
|
*/
|
|
37
65
|
export declare function generateOpenAPI(controllers: ScannedController[], checker: ts.TypeChecker, options?: {
|
|
38
66
|
title?: string;
|
|
39
67
|
version?: string;
|
|
40
68
|
onProgress?: OpenAPIProgressCallback;
|
|
69
|
+
onQueryBuilderProgress?: OpenAPIDetailedProgressCallback;
|
|
41
70
|
}): OpenAPI31;
|
|
42
71
|
//# sourceMappingURL=openapi.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"openapi.d.ts","sourceRoot":"","sources":["../../../src/compiler/schema/openapi.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,KAAK,EAAE,iBAAiB,EAAsC,MAAM,+BAA+B,CAAC;AAG3G,OAAO,KAAK,EAAiB,UAAU,EAAE,MAAM,YAAY,CAAC;AAY5D;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,UAAU,EAAE;QACV,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;KACrC,CAAC;IACF,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACzD;AAED
|
|
1
|
+
{"version":3,"file":"openapi.d.ts","sourceRoot":"","sources":["../../../src/compiler/schema/openapi.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,KAAK,EAAE,iBAAiB,EAAsC,MAAM,+BAA+B,CAAC;AAG3G,OAAO,KAAK,EAAiB,UAAU,EAAE,MAAM,YAAY,CAAC;AAY5D;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,UAAU,EAAE;QACV,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;KACrC,CAAC;IACF,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACzD;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,CAAC,IAAI,EAAE;QACL,iCAAiC;QACjC,UAAU,EAAE,MAAM,CAAC;QACnB,gCAAgC;QAChC,SAAS,EAAE,MAAM,CAAC;QAClB,kBAAkB;QAClB,MAAM,EAAE,MAAM,CAAC;QACf,qBAAqB;QACrB,IAAI,EAAE,MAAM,CAAC;QACb,iDAAiD;QACjD,oBAAoB,EAAE,OAAO,CAAC;QAC9B,8BAA8B;QAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,kCAAkC;QAClC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;QAC1B,kCAAkC;QAClC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,uBAAuB;QACvB,OAAO,EAAE,MAAM,CAAC;QAChB,uBAAuB;QACvB,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,IAAI,CAAC;CACV;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,WAAW,EAAE,iBAAiB,EAAE,EAChC,OAAO,EAAE,EAAE,CAAC,WAAW,EACvB,OAAO,GAAE;IACP,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,uBAAuB,CAAC;IACrC,sBAAsB,CAAC,EAAE,+BAA+B,CAAC;CACrD,GACL,SAAS,CAwFX"}
|
|
@@ -23,6 +23,23 @@ export interface QueryBuilderSchema {
|
|
|
23
23
|
/** Whether query ends with .executePaged() instead of .execute() */
|
|
24
24
|
isPaged: boolean;
|
|
25
25
|
}
|
|
26
|
+
/**
|
|
27
|
+
* Result of query builder analysis including operation details for logging
|
|
28
|
+
*/
|
|
29
|
+
export interface QueryBuilderAnalysisResult {
|
|
30
|
+
/** Whether a query builder pattern was detected */
|
|
31
|
+
detected: boolean;
|
|
32
|
+
/** Schema information if detected */
|
|
33
|
+
schema: QueryBuilderSchema | null;
|
|
34
|
+
/** Operation method name (for logging) */
|
|
35
|
+
methodName?: string;
|
|
36
|
+
/** Operation HTTP method (for logging) */
|
|
37
|
+
httpMethod?: string;
|
|
38
|
+
/** Operation path (for logging) */
|
|
39
|
+
path?: string;
|
|
40
|
+
/** Operation ID (for logging) */
|
|
41
|
+
operationId?: string;
|
|
42
|
+
}
|
|
26
43
|
/**
|
|
27
44
|
* Analysis options for query builder detection
|
|
28
45
|
*/
|
|
@@ -40,4 +57,20 @@ export interface QueryBuilderAnalyzerOptions {
|
|
|
40
57
|
* @returns Query builder schema if pattern detected, null otherwise
|
|
41
58
|
*/
|
|
42
59
|
export declare function analyzeQueryBuilderForSchema(methodDeclaration: ts.MethodDeclaration, checker: ts.TypeChecker, options?: QueryBuilderAnalyzerOptions): QueryBuilderSchema | null;
|
|
60
|
+
/**
|
|
61
|
+
* Analyzes a method declaration and returns detailed result with operation info
|
|
62
|
+
* Useful for logging and statistics
|
|
63
|
+
*
|
|
64
|
+
* @param methodDeclaration - The method declaration to analyze
|
|
65
|
+
* @param checker - TypeScript type checker
|
|
66
|
+
* @param options - Analyzer options
|
|
67
|
+
* @param operationInfo - Optional operation metadata for logging
|
|
68
|
+
* @returns Detailed analysis result with operation info
|
|
69
|
+
*/
|
|
70
|
+
export declare function analyzeQueryBuilderWithDetails(methodDeclaration: ts.MethodDeclaration, checker: ts.TypeChecker, options?: QueryBuilderAnalyzerOptions, operationInfo?: {
|
|
71
|
+
methodName?: string;
|
|
72
|
+
httpMethod?: string;
|
|
73
|
+
path?: string;
|
|
74
|
+
operationId?: string;
|
|
75
|
+
}): QueryBuilderAnalysisResult;
|
|
43
76
|
//# sourceMappingURL=queryBuilderAnalyzer.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"queryBuilderAnalyzer.d.ts","sourceRoot":"","sources":["../../../src/compiler/schema/queryBuilderAnalyzer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,2CAA2C;IAC3C,UAAU,EAAE,MAAM,CAAC;IACnB,0CAA0C;IAC1C,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,8CAA8C;IAC9C,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,CAAC;IACvD,oEAAoE;IACpE,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;GAQG;AACH,wBAAgB,4BAA4B,CAC1C,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,EACvC,OAAO,EAAE,EAAE,CAAC,WAAW,EACvB,OAAO,GAAE,2BAAgC,GACxC,kBAAkB,GAAG,IAAI,CAyB3B"}
|
|
1
|
+
{"version":3,"file":"queryBuilderAnalyzer.d.ts","sourceRoot":"","sources":["../../../src/compiler/schema/queryBuilderAnalyzer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,2CAA2C;IAC3C,UAAU,EAAE,MAAM,CAAC;IACnB,0CAA0C;IAC1C,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,8CAA8C;IAC9C,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,CAAC;IACvD,oEAAoE;IACpE,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,mDAAmD;IACnD,QAAQ,EAAE,OAAO,CAAC;IAClB,qCAAqC;IACrC,MAAM,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAClC,0CAA0C;IAC1C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,0CAA0C;IAC1C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mCAAmC;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;GAQG;AACH,wBAAgB,4BAA4B,CAC1C,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,EACvC,OAAO,EAAE,EAAE,CAAC,WAAW,EACvB,OAAO,GAAE,2BAAgC,GACxC,kBAAkB,GAAG,IAAI,CAyB3B;AAED;;;;;;;;;GASG;AACH,wBAAgB,8BAA8B,CAC5C,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,EACvC,OAAO,EAAE,EAAE,CAAC,WAAW,EACvB,OAAO,GAAE,2BAAgC,EACzC,aAAa,CAAC,EAAE;IAAE,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GAChG,0BAA0B,CAQ5B"}
|