@com75271-assist/build-api 1.0.0
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/api.json +2366 -0
- package/dist/api.md +184 -0
- package/dist/index.d.ts +1354 -0
- package/dist/index.js +100 -0
- package/dist/templates/ts.enumModel.njk +21 -0
- package/dist/templates/ts.model.njk +12 -0
- package/dist/templates/ts.service.njk +43 -0
- package/package.json +36 -0
package/dist/api.md
ADDED
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
## API Report File for "@lhy-assist/build-api"
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
|
|
7
|
+
// Warning: (ae-forgotten-export) The symbol "NjkJsSwagger2BuilderConfig" needs to be exported by the entry point index.d.ts
|
|
8
|
+
//
|
|
9
|
+
// @public
|
|
10
|
+
export function buildSwagger2Js(config: NjkJsSwagger2BuilderConfig): void;
|
|
11
|
+
|
|
12
|
+
// @public (undocumented)
|
|
13
|
+
export const buildSwagger2Ts: typeof buildSwaggerTs;
|
|
14
|
+
|
|
15
|
+
// Warning: (ae-forgotten-export) The symbol "NjkTsSwagger3BuilderConfig" needs to be exported by the entry point index.d.ts
|
|
16
|
+
//
|
|
17
|
+
// @public
|
|
18
|
+
export function buildSwagger3Ts(config: NjkTsSwagger3BuilderConfig): void;
|
|
19
|
+
|
|
20
|
+
// Warning: (ae-forgotten-export) The symbol "NjkTsSwagger2BuilderConfig" needs to be exported by the entry point index.d.ts
|
|
21
|
+
//
|
|
22
|
+
// @public
|
|
23
|
+
export function buildSwaggerTs(config: NjkTsSwagger2BuilderConfig): void;
|
|
24
|
+
|
|
25
|
+
// @public (undocumented)
|
|
26
|
+
export enum NameStyle {
|
|
27
|
+
CAMEL_CASE = 0,
|
|
28
|
+
KEBAB_CASE = 4,
|
|
29
|
+
PASCAL = 2,
|
|
30
|
+
UNDER_SCORE_CASE = 3,
|
|
31
|
+
UPPER_CAMEL_CASE = 1
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
// @public (undocumented)
|
|
35
|
+
export class NjkJsSwagger2Builder extends NjkTsSwagger2Builder {
|
|
36
|
+
constructor(config: NjkJsSwagger2BuilderConfig);
|
|
37
|
+
// (undocumented)
|
|
38
|
+
protected config: NjkJsSwagger2BuilderConfig;
|
|
39
|
+
// (undocumented)
|
|
40
|
+
protected resolveFileNameExt(name: string): string;
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
// Warning: (ae-forgotten-export) The symbol "NjkTsBuilder" needs to be exported by the entry point index.d.ts
|
|
44
|
+
//
|
|
45
|
+
// @public (undocumented)
|
|
46
|
+
export class NjkTsSwagger2Builder extends NjkTsBuilder {
|
|
47
|
+
constructor(config: NjkTsSwagger2BuilderConfig);
|
|
48
|
+
// Warning: (ae-forgotten-export) The symbol "Swagger2ApiOperationTranslator" needs to be exported by the entry point index.d.ts
|
|
49
|
+
//
|
|
50
|
+
// (undocumented)
|
|
51
|
+
protected apiOperationTranslator: Swagger2ApiOperationTranslator;
|
|
52
|
+
// (undocumented)
|
|
53
|
+
build(): void;
|
|
54
|
+
// Warning: (ae-forgotten-export) The symbol "SwaggerResource" needs to be exported by the entry point index.d.ts
|
|
55
|
+
// Warning: (ae-forgotten-export) The symbol "ApiDoc" needs to be exported by the entry point index.d.ts
|
|
56
|
+
protected buildSwagger2(resource: SwaggerResource, doc: ApiDoc): Promise<void>;
|
|
57
|
+
protected buildSwagger2Models(doc: ApiDoc): {
|
|
58
|
+
models: TsModel[];
|
|
59
|
+
modelPoolMap: Map<string, TsModel>;
|
|
60
|
+
enumModels: TsEnumModel[];
|
|
61
|
+
};
|
|
62
|
+
protected buildSwagger2ParameterModels(doc: ApiDoc, modelPoolMap: Map<string, TsModel>): {
|
|
63
|
+
parameterModels: TsModel[];
|
|
64
|
+
enumModels: TsEnumModel[];
|
|
65
|
+
};
|
|
66
|
+
// Warning: (ae-forgotten-export) The symbol "TsService" needs to be exported by the entry point index.d.ts
|
|
67
|
+
protected buildSwagger2Services(resource: SwaggerResource, doc: ApiDoc, modelPoolMap: Map<string, TsModel>): TsService[];
|
|
68
|
+
// (undocumented)
|
|
69
|
+
protected config: NjkTsSwagger2BuilderConfig;
|
|
70
|
+
// (undocumented)
|
|
71
|
+
protected defaultSwaggerDocumentPath: string;
|
|
72
|
+
// (undocumented)
|
|
73
|
+
protected defaultSwaggerResourcePath: string;
|
|
74
|
+
// Warning: (ae-forgotten-export) The symbol "Swagger2EnumModelTranslator" needs to be exported by the entry point index.d.ts
|
|
75
|
+
//
|
|
76
|
+
// (undocumented)
|
|
77
|
+
protected enumModelTranslator: Swagger2EnumModelTranslator;
|
|
78
|
+
// Warning: (ae-forgotten-export) The symbol "TsGenericityDependenciesTranslator" needs to be exported by the entry point index.d.ts
|
|
79
|
+
//
|
|
80
|
+
// (undocumented)
|
|
81
|
+
protected genericityDependenciesTranslator: TsGenericityDependenciesTranslator;
|
|
82
|
+
// Warning: (ae-forgotten-export) The symbol "Swagger2ModelPropertyTranslator" needs to be exported by the entry point index.d.ts
|
|
83
|
+
//
|
|
84
|
+
// (undocumented)
|
|
85
|
+
protected modelPropertyTranslator: Swagger2ModelPropertyTranslator;
|
|
86
|
+
// Warning: (ae-forgotten-export) The symbol "Swagger2ModelTranslator" needs to be exported by the entry point index.d.ts
|
|
87
|
+
//
|
|
88
|
+
// (undocumented)
|
|
89
|
+
protected modelTranslator: Swagger2ModelTranslator;
|
|
90
|
+
// (undocumented)
|
|
91
|
+
protected packageDepth: number;
|
|
92
|
+
// Warning: (ae-forgotten-export) The symbol "Swagger2ParameterTranslator" needs to be exported by the entry point index.d.ts
|
|
93
|
+
//
|
|
94
|
+
// (undocumented)
|
|
95
|
+
protected parameterTranslator: Swagger2ParameterTranslator;
|
|
96
|
+
protected resolveBasePath(doc: ApiDoc): void;
|
|
97
|
+
// Warning: (ae-forgotten-export) The symbol "Swagger2ResponseTranslator" needs to be exported by the entry point index.d.ts
|
|
98
|
+
//
|
|
99
|
+
// (undocumented)
|
|
100
|
+
protected responseTranslator: Swagger2ResponseTranslator;
|
|
101
|
+
// Warning: (ae-forgotten-export) The symbol "SwaggerService" needs to be exported by the entry point index.d.ts
|
|
102
|
+
//
|
|
103
|
+
// (undocumented)
|
|
104
|
+
protected swaggerService: SwaggerService;
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
// @public (undocumented)
|
|
108
|
+
export class NjkTsSwagger3Builder extends NjkTsBuilder {
|
|
109
|
+
constructor(config: NjkTsSwagger3BuilderConfig);
|
|
110
|
+
// Warning: (ae-forgotten-export) The symbol "Swagger3ApiOperationTranslator" needs to be exported by the entry point index.d.ts
|
|
111
|
+
//
|
|
112
|
+
// (undocumented)
|
|
113
|
+
protected apiOperationTranslator: Swagger3ApiOperationTranslator;
|
|
114
|
+
// (undocumented)
|
|
115
|
+
build(): void;
|
|
116
|
+
// Warning: (ae-forgotten-export) The symbol "Swagger3Resource" needs to be exported by the entry point index.d.ts
|
|
117
|
+
// Warning: (ae-forgotten-export) The symbol "Swagger3ApiDoc" needs to be exported by the entry point index.d.ts
|
|
118
|
+
//
|
|
119
|
+
// (undocumented)
|
|
120
|
+
buildSwagger3(resource: Swagger3Resource, doc: Swagger3ApiDoc): Promise<void>;
|
|
121
|
+
// (undocumented)
|
|
122
|
+
buildSwagger3Models(doc: Swagger3ApiDoc, data: {
|
|
123
|
+
rootPackage: string;
|
|
124
|
+
}): {
|
|
125
|
+
models: TsModel[];
|
|
126
|
+
modelPoolMap: Map<string, TsModel>;
|
|
127
|
+
enumModels: TsEnumModel[];
|
|
128
|
+
};
|
|
129
|
+
buildSwagger3ParameterModels(doc: Swagger3ApiDoc, data: {
|
|
130
|
+
rootPackage: string;
|
|
131
|
+
modelPoolMap: Map<string, TsModel>;
|
|
132
|
+
}): {
|
|
133
|
+
parameterModels: TsModel[];
|
|
134
|
+
enumModels: TsEnumModel[];
|
|
135
|
+
};
|
|
136
|
+
// (undocumented)
|
|
137
|
+
buildSwagger3Services(resource: Swagger3Resource, doc: Swagger3ApiDoc, modelPoolMap: Map<string, TsModel>): TsService[];
|
|
138
|
+
// (undocumented)
|
|
139
|
+
protected config: NjkTsSwagger3BuilderConfig;
|
|
140
|
+
// (undocumented)
|
|
141
|
+
protected defaultSwaggerDocumentPath: string;
|
|
142
|
+
// (undocumented)
|
|
143
|
+
protected defaultSwaggerResourcePath: string;
|
|
144
|
+
// Warning: (ae-forgotten-export) The symbol "Swagger3TsGenericityDependenciesTranslator" needs to be exported by the entry point index.d.ts
|
|
145
|
+
//
|
|
146
|
+
// (undocumented)
|
|
147
|
+
protected genericityDependenciesTranslator: Swagger3TsGenericityDependenciesTranslator;
|
|
148
|
+
// Warning: (ae-forgotten-export) The symbol "Swagger3ModelPropertyTranslator" needs to be exported by the entry point index.d.ts
|
|
149
|
+
//
|
|
150
|
+
// (undocumented)
|
|
151
|
+
protected modelPropertyTranslator: Swagger3ModelPropertyTranslator;
|
|
152
|
+
// Warning: (ae-forgotten-export) The symbol "Swagger3ModelTranslator" needs to be exported by the entry point index.d.ts
|
|
153
|
+
//
|
|
154
|
+
// (undocumented)
|
|
155
|
+
protected modelTranslator: Swagger3ModelTranslator;
|
|
156
|
+
// (undocumented)
|
|
157
|
+
protected packageDepth: number;
|
|
158
|
+
// Warning: (ae-forgotten-export) The symbol "Swagger3ParameterTranslator" needs to be exported by the entry point index.d.ts
|
|
159
|
+
//
|
|
160
|
+
// (undocumented)
|
|
161
|
+
protected parameterTranslator: Swagger3ParameterTranslator;
|
|
162
|
+
// Warning: (ae-forgotten-export) The symbol "Swagger3RequestBodyTranslator" needs to be exported by the entry point index.d.ts
|
|
163
|
+
//
|
|
164
|
+
// (undocumented)
|
|
165
|
+
protected requestBodyTranslator: Swagger3RequestBodyTranslator;
|
|
166
|
+
resolveBasePath(doc: Swagger3ApiDoc): string;
|
|
167
|
+
// Warning: (ae-forgotten-export) The symbol "Swagger3ResponseTranslator" needs to be exported by the entry point index.d.ts
|
|
168
|
+
//
|
|
169
|
+
// (undocumented)
|
|
170
|
+
protected responseTranslator: Swagger3ResponseTranslator;
|
|
171
|
+
// Warning: (ae-forgotten-export) The symbol "Swagger3Service" needs to be exported by the entry point index.d.ts
|
|
172
|
+
//
|
|
173
|
+
// (undocumented)
|
|
174
|
+
swaggerService: Swagger3Service;
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
// Warnings were encountered during analysis:
|
|
178
|
+
//
|
|
179
|
+
// types/njk/ts/swagger2/ts-swagger2.builder.d.ts:99:9 - (ae-forgotten-export) The symbol "TsModel" needs to be exported by the entry point index.d.ts
|
|
180
|
+
// types/njk/ts/swagger2/ts-swagger2.builder.d.ts:101:9 - (ae-forgotten-export) The symbol "TsEnumModel" needs to be exported by the entry point index.d.ts
|
|
181
|
+
|
|
182
|
+
// (No @packageDocumentation comment for this package)
|
|
183
|
+
|
|
184
|
+
```
|