@microsoft/m365-spec-parser 0.1.1-alpha.fb5afedc0.0 → 0.1.1-alpha.fbb412c19.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/index.esm2017.js +617 -319
- package/dist/index.esm2017.js.map +1 -1
- package/dist/index.esm2017.mjs +1058 -621
- package/dist/index.esm2017.mjs.map +1 -1
- package/dist/index.esm5.js +617 -319
- package/dist/index.esm5.js.map +1 -1
- package/dist/index.node.cjs.js +1070 -629
- package/dist/index.node.cjs.js.map +1 -1
- package/dist/src/adaptiveCardWrapper.d.ts +2 -0
- package/dist/src/constants.d.ts +8 -3
- package/dist/src/index.d.ts +1 -1
- package/dist/src/interfaces.d.ts +72 -2
- package/dist/src/manifestUpdater.d.ts +7 -4
- package/dist/src/specParser.browser.d.ts +3 -2
- package/dist/src/specParser.d.ts +5 -3
- package/dist/src/utils.d.ts +9 -27
- package/package.json +3 -4
package/dist/index.esm2017.mjs
CHANGED
|
@@ -20,6 +20,7 @@ var ErrorType;
|
|
|
20
20
|
ErrorType["ResolveServerUrlFailed"] = "resolve-server-url-failed";
|
|
21
21
|
ErrorType["SwaggerNotSupported"] = "swagger-not-supported";
|
|
22
22
|
ErrorType["MultipleAuthNotSupported"] = "multiple-auth-not-supported";
|
|
23
|
+
ErrorType["SpecVersionNotSupported"] = "spec-version-not-supported";
|
|
23
24
|
ErrorType["ListFailed"] = "list-failed";
|
|
24
25
|
ErrorType["listSupportedAPIInfoFailed"] = "list-supported-api-info-failed";
|
|
25
26
|
ErrorType["FilterSpecFailed"] = "filter-spec-failed";
|
|
@@ -28,6 +29,21 @@ var ErrorType;
|
|
|
28
29
|
ErrorType["GenerateFailed"] = "generate-failed";
|
|
29
30
|
ErrorType["ValidateFailed"] = "validate-failed";
|
|
30
31
|
ErrorType["GetSpecFailed"] = "get-spec-failed";
|
|
32
|
+
ErrorType["AuthTypeIsNotSupported"] = "auth-type-is-not-supported";
|
|
33
|
+
ErrorType["MissingOperationId"] = "missing-operation-id";
|
|
34
|
+
ErrorType["PostBodyContainMultipleMediaTypes"] = "post-body-contain-multiple-media-types";
|
|
35
|
+
ErrorType["ResponseContainMultipleMediaTypes"] = "response-contain-multiple-media-types";
|
|
36
|
+
ErrorType["ResponseJsonIsEmpty"] = "response-json-is-empty";
|
|
37
|
+
ErrorType["PostBodySchemaIsNotJson"] = "post-body-schema-is-not-json";
|
|
38
|
+
ErrorType["PostBodyContainsRequiredUnsupportedSchema"] = "post-body-contains-required-unsupported-schema";
|
|
39
|
+
ErrorType["ParamsContainRequiredUnsupportedSchema"] = "params-contain-required-unsupported-schema";
|
|
40
|
+
ErrorType["ParamsContainsNestedObject"] = "params-contains-nested-object";
|
|
41
|
+
ErrorType["RequestBodyContainsNestedObject"] = "request-body-contains-nested-object";
|
|
42
|
+
ErrorType["ExceededRequiredParamsLimit"] = "exceeded-required-params-limit";
|
|
43
|
+
ErrorType["NoParameter"] = "no-parameter";
|
|
44
|
+
ErrorType["NoAPIInfo"] = "no-api-info";
|
|
45
|
+
ErrorType["MethodNotAllowed"] = "method-not-allowed";
|
|
46
|
+
ErrorType["UrlPathNotExist"] = "url-path-not-exist";
|
|
31
47
|
ErrorType["Cancelled"] = "cancelled";
|
|
32
48
|
ErrorType["Unknown"] = "unknown";
|
|
33
49
|
})(ErrorType || (ErrorType = {}));
|
|
@@ -67,7 +83,7 @@ ConstantString.RemoteRefNotSupported = "Remote reference is not supported: %s.";
|
|
|
67
83
|
ConstantString.MissingOperationId = "Missing operationIds: %s.";
|
|
68
84
|
ConstantString.NoSupportedApi = "No supported API is found in the OpenAPI description document: only GET and POST methods are supported, additionally, there can be at most one required parameter, and no auth is allowed.";
|
|
69
85
|
ConstantString.AdditionalPropertiesNotSupported = "'additionalProperties' is not supported, and will be ignored.";
|
|
70
|
-
ConstantString.SchemaNotSupported = "'oneOf', 'anyOf', and 'not' schema are not supported: %s.";
|
|
86
|
+
ConstantString.SchemaNotSupported = "'oneOf', 'allOf', 'anyOf', and 'not' schema are not supported: %s.";
|
|
71
87
|
ConstantString.UnknownSchema = "Unknown schema: %s.";
|
|
72
88
|
ConstantString.UrlProtocolNotSupported = "Server url is not correct: protocol %s is not supported, you should use https protocol instead.";
|
|
73
89
|
ConstantString.RelativeServerUrlNotSupported = "Server url is not correct: relative server url is not supported.";
|
|
@@ -75,6 +91,7 @@ ConstantString.ResolveServerUrlFailed = "Unable to resolve the server URL: pleas
|
|
|
75
91
|
ConstantString.OperationOnlyContainsOptionalParam = "Operation %s contains multiple optional parameters. The first optional parameter is used for this command.";
|
|
76
92
|
ConstantString.ConvertSwaggerToOpenAPI = "The Swagger 2.0 file has been converted to OpenAPI 3.0.";
|
|
77
93
|
ConstantString.SwaggerNotSupported = "Swagger 2.0 is not supported. Please convert to OpenAPI 3.0 manually before proceeding.";
|
|
94
|
+
ConstantString.SpecVersionNotSupported = "Unsupported OpenAPI version %s. Please use version 3.0.x.";
|
|
78
95
|
ConstantString.MultipleAuthNotSupported = "Multiple authentication methods are unsupported. Ensure all selected APIs use identical authentication.";
|
|
79
96
|
ConstantString.UnsupportedSchema = "Unsupported schema in %s %s: %s";
|
|
80
97
|
ConstantString.WrappedCardVersion = "devPreview";
|
|
@@ -86,9 +103,14 @@ ConstantString.AdaptiveCardVersion = "1.5";
|
|
|
86
103
|
ConstantString.AdaptiveCardSchema = "http://adaptivecards.io/schemas/adaptive-card.json";
|
|
87
104
|
ConstantString.AdaptiveCardType = "AdaptiveCard";
|
|
88
105
|
ConstantString.TextBlockType = "TextBlock";
|
|
106
|
+
ConstantString.ImageType = "Image";
|
|
89
107
|
ConstantString.ContainerType = "Container";
|
|
90
|
-
ConstantString.RegistrationIdPostfix =
|
|
91
|
-
|
|
108
|
+
ConstantString.RegistrationIdPostfix = {
|
|
109
|
+
apiKey: "REGISTRATION_ID",
|
|
110
|
+
oauth2: "CONFIGURATION_ID",
|
|
111
|
+
http: "REGISTRATION_ID",
|
|
112
|
+
openIdConnect: "REGISTRATION_ID",
|
|
113
|
+
};
|
|
92
114
|
ConstantString.ResponseCodeFor20X = [
|
|
93
115
|
"200",
|
|
94
116
|
"201",
|
|
@@ -147,9 +169,11 @@ ConstantString.ShortDescriptionMaxLens = 80;
|
|
|
147
169
|
ConstantString.FullDescriptionMaxLens = 4000;
|
|
148
170
|
ConstantString.CommandDescriptionMaxLens = 128;
|
|
149
171
|
ConstantString.ParameterDescriptionMaxLens = 128;
|
|
172
|
+
ConstantString.ConversationStarterMaxLens = 50;
|
|
150
173
|
ConstantString.CommandTitleMaxLens = 32;
|
|
151
174
|
ConstantString.ParameterTitleMaxLens = 32;
|
|
152
|
-
ConstantString.SMERequiredParamsMaxNum = 5;
|
|
175
|
+
ConstantString.SMERequiredParamsMaxNum = 5;
|
|
176
|
+
ConstantString.DefaultPluginId = "plugin_1";
|
|
153
177
|
|
|
154
178
|
// Copyright (c) Microsoft Corporation.
|
|
155
179
|
class SpecParserError extends Error {
|
|
@@ -172,221 +196,9 @@ class Utils {
|
|
|
172
196
|
}
|
|
173
197
|
return false;
|
|
174
198
|
}
|
|
175
|
-
static checkParameters(paramObject, isCopilot) {
|
|
176
|
-
const paramResult = {
|
|
177
|
-
requiredNum: 0,
|
|
178
|
-
optionalNum: 0,
|
|
179
|
-
isValid: true,
|
|
180
|
-
};
|
|
181
|
-
if (!paramObject) {
|
|
182
|
-
return paramResult;
|
|
183
|
-
}
|
|
184
|
-
for (let i = 0; i < paramObject.length; i++) {
|
|
185
|
-
const param = paramObject[i];
|
|
186
|
-
const schema = param.schema;
|
|
187
|
-
if (isCopilot && this.hasNestedObjectInSchema(schema)) {
|
|
188
|
-
paramResult.isValid = false;
|
|
189
|
-
continue;
|
|
190
|
-
}
|
|
191
|
-
const isRequiredWithoutDefault = param.required && schema.default === undefined;
|
|
192
|
-
if (isCopilot) {
|
|
193
|
-
if (isRequiredWithoutDefault) {
|
|
194
|
-
paramResult.requiredNum = paramResult.requiredNum + 1;
|
|
195
|
-
}
|
|
196
|
-
else {
|
|
197
|
-
paramResult.optionalNum = paramResult.optionalNum + 1;
|
|
198
|
-
}
|
|
199
|
-
continue;
|
|
200
|
-
}
|
|
201
|
-
if (param.in === "header" || param.in === "cookie") {
|
|
202
|
-
if (isRequiredWithoutDefault) {
|
|
203
|
-
paramResult.isValid = false;
|
|
204
|
-
}
|
|
205
|
-
continue;
|
|
206
|
-
}
|
|
207
|
-
if (schema.type !== "boolean" &&
|
|
208
|
-
schema.type !== "string" &&
|
|
209
|
-
schema.type !== "number" &&
|
|
210
|
-
schema.type !== "integer") {
|
|
211
|
-
if (isRequiredWithoutDefault) {
|
|
212
|
-
paramResult.isValid = false;
|
|
213
|
-
}
|
|
214
|
-
continue;
|
|
215
|
-
}
|
|
216
|
-
if (param.in === "query" || param.in === "path") {
|
|
217
|
-
if (isRequiredWithoutDefault) {
|
|
218
|
-
paramResult.requiredNum = paramResult.requiredNum + 1;
|
|
219
|
-
}
|
|
220
|
-
else {
|
|
221
|
-
paramResult.optionalNum = paramResult.optionalNum + 1;
|
|
222
|
-
}
|
|
223
|
-
}
|
|
224
|
-
}
|
|
225
|
-
return paramResult;
|
|
226
|
-
}
|
|
227
|
-
static checkPostBody(schema, isRequired = false, isCopilot = false) {
|
|
228
|
-
var _a;
|
|
229
|
-
const paramResult = {
|
|
230
|
-
requiredNum: 0,
|
|
231
|
-
optionalNum: 0,
|
|
232
|
-
isValid: true,
|
|
233
|
-
};
|
|
234
|
-
if (Object.keys(schema).length === 0) {
|
|
235
|
-
return paramResult;
|
|
236
|
-
}
|
|
237
|
-
const isRequiredWithoutDefault = isRequired && schema.default === undefined;
|
|
238
|
-
if (isCopilot && this.hasNestedObjectInSchema(schema)) {
|
|
239
|
-
paramResult.isValid = false;
|
|
240
|
-
return paramResult;
|
|
241
|
-
}
|
|
242
|
-
if (schema.type === "string" ||
|
|
243
|
-
schema.type === "integer" ||
|
|
244
|
-
schema.type === "boolean" ||
|
|
245
|
-
schema.type === "number") {
|
|
246
|
-
if (isRequiredWithoutDefault) {
|
|
247
|
-
paramResult.requiredNum = paramResult.requiredNum + 1;
|
|
248
|
-
}
|
|
249
|
-
else {
|
|
250
|
-
paramResult.optionalNum = paramResult.optionalNum + 1;
|
|
251
|
-
}
|
|
252
|
-
}
|
|
253
|
-
else if (schema.type === "object") {
|
|
254
|
-
const { properties } = schema;
|
|
255
|
-
for (const property in properties) {
|
|
256
|
-
let isRequired = false;
|
|
257
|
-
if (schema.required && ((_a = schema.required) === null || _a === void 0 ? void 0 : _a.indexOf(property)) >= 0) {
|
|
258
|
-
isRequired = true;
|
|
259
|
-
}
|
|
260
|
-
const result = Utils.checkPostBody(properties[property], isRequired, isCopilot);
|
|
261
|
-
paramResult.requiredNum += result.requiredNum;
|
|
262
|
-
paramResult.optionalNum += result.optionalNum;
|
|
263
|
-
paramResult.isValid = paramResult.isValid && result.isValid;
|
|
264
|
-
}
|
|
265
|
-
}
|
|
266
|
-
else {
|
|
267
|
-
if (isRequiredWithoutDefault && !isCopilot) {
|
|
268
|
-
paramResult.isValid = false;
|
|
269
|
-
}
|
|
270
|
-
}
|
|
271
|
-
return paramResult;
|
|
272
|
-
}
|
|
273
199
|
static containMultipleMediaTypes(bodyObject) {
|
|
274
200
|
return Object.keys((bodyObject === null || bodyObject === void 0 ? void 0 : bodyObject.content) || {}).length > 1;
|
|
275
201
|
}
|
|
276
|
-
/**
|
|
277
|
-
* Checks if the given API is supported.
|
|
278
|
-
* @param {string} method - The HTTP method of the API.
|
|
279
|
-
* @param {string} path - The path of the API.
|
|
280
|
-
* @param {OpenAPIV3.Document} spec - The OpenAPI specification document.
|
|
281
|
-
* @returns {boolean} - Returns true if the API is supported, false otherwise.
|
|
282
|
-
* @description The following APIs are supported:
|
|
283
|
-
* 1. only support Get/Post operation without auth property
|
|
284
|
-
* 2. parameter inside query or path only support string, number, boolean and integer
|
|
285
|
-
* 3. parameter inside post body only support string, number, boolean, integer and object
|
|
286
|
-
* 4. request body + required parameters <= 1
|
|
287
|
-
* 5. response body should be “application/json” and not empty, and response code should be 20X
|
|
288
|
-
* 6. only support request body with “application/json” content type
|
|
289
|
-
*/
|
|
290
|
-
static isSupportedApi(method, path, spec, options) {
|
|
291
|
-
var _a;
|
|
292
|
-
const pathObj = spec.paths[path];
|
|
293
|
-
method = method.toLocaleLowerCase();
|
|
294
|
-
if (pathObj) {
|
|
295
|
-
if (((_a = options.allowMethods) === null || _a === void 0 ? void 0 : _a.includes(method)) && pathObj[method]) {
|
|
296
|
-
const securities = pathObj[method].security;
|
|
297
|
-
const isTeamsAi = options.projectType === ProjectType.TeamsAi;
|
|
298
|
-
const isCopilot = options.projectType === ProjectType.Copilot;
|
|
299
|
-
// Teams AI project doesn't care about auth, it will use authProvider for user to implement
|
|
300
|
-
if (!isTeamsAi) {
|
|
301
|
-
const authArray = Utils.getAuthArray(securities, spec);
|
|
302
|
-
if (!Utils.isSupportedAuth(authArray, options)) {
|
|
303
|
-
return false;
|
|
304
|
-
}
|
|
305
|
-
}
|
|
306
|
-
const operationObject = pathObj[method];
|
|
307
|
-
if (!options.allowMissingId && !operationObject.operationId) {
|
|
308
|
-
return false;
|
|
309
|
-
}
|
|
310
|
-
const paramObject = operationObject.parameters;
|
|
311
|
-
const requestBody = operationObject.requestBody;
|
|
312
|
-
const requestJsonBody = requestBody === null || requestBody === void 0 ? void 0 : requestBody.content["application/json"];
|
|
313
|
-
if (!isTeamsAi && Utils.containMultipleMediaTypes(requestBody)) {
|
|
314
|
-
return false;
|
|
315
|
-
}
|
|
316
|
-
const responseJson = Utils.getResponseJson(operationObject, isTeamsAi);
|
|
317
|
-
if (Object.keys(responseJson).length === 0) {
|
|
318
|
-
return false;
|
|
319
|
-
}
|
|
320
|
-
// Teams AI project doesn't care about request parameters/body
|
|
321
|
-
if (isTeamsAi) {
|
|
322
|
-
return true;
|
|
323
|
-
}
|
|
324
|
-
let requestBodyParamResult = {
|
|
325
|
-
requiredNum: 0,
|
|
326
|
-
optionalNum: 0,
|
|
327
|
-
isValid: true,
|
|
328
|
-
};
|
|
329
|
-
if (requestJsonBody) {
|
|
330
|
-
const requestBodySchema = requestJsonBody.schema;
|
|
331
|
-
if (isCopilot && requestBodySchema.type !== "object") {
|
|
332
|
-
return false;
|
|
333
|
-
}
|
|
334
|
-
requestBodyParamResult = Utils.checkPostBody(requestBodySchema, requestBody.required, isCopilot);
|
|
335
|
-
}
|
|
336
|
-
if (!requestBodyParamResult.isValid) {
|
|
337
|
-
return false;
|
|
338
|
-
}
|
|
339
|
-
const paramResult = Utils.checkParameters(paramObject, isCopilot);
|
|
340
|
-
if (!paramResult.isValid) {
|
|
341
|
-
return false;
|
|
342
|
-
}
|
|
343
|
-
// Copilot support arbitrary parameters
|
|
344
|
-
if (isCopilot) {
|
|
345
|
-
return true;
|
|
346
|
-
}
|
|
347
|
-
if (requestBodyParamResult.requiredNum + paramResult.requiredNum > 1) {
|
|
348
|
-
if (options.allowMultipleParameters &&
|
|
349
|
-
requestBodyParamResult.requiredNum + paramResult.requiredNum <=
|
|
350
|
-
ConstantString.SMERequiredParamsMaxNum) {
|
|
351
|
-
return true;
|
|
352
|
-
}
|
|
353
|
-
return false;
|
|
354
|
-
}
|
|
355
|
-
else if (requestBodyParamResult.requiredNum +
|
|
356
|
-
requestBodyParamResult.optionalNum +
|
|
357
|
-
paramResult.requiredNum +
|
|
358
|
-
paramResult.optionalNum ===
|
|
359
|
-
0) {
|
|
360
|
-
return false;
|
|
361
|
-
}
|
|
362
|
-
else {
|
|
363
|
-
return true;
|
|
364
|
-
}
|
|
365
|
-
}
|
|
366
|
-
}
|
|
367
|
-
return false;
|
|
368
|
-
}
|
|
369
|
-
static isSupportedAuth(authSchemeArray, options) {
|
|
370
|
-
if (authSchemeArray.length === 0) {
|
|
371
|
-
return true;
|
|
372
|
-
}
|
|
373
|
-
if (options.allowAPIKeyAuth || options.allowOauth2 || options.allowBearerTokenAuth) {
|
|
374
|
-
// Currently we don't support multiple auth in one operation
|
|
375
|
-
if (authSchemeArray.length > 0 && authSchemeArray.every((auths) => auths.length > 1)) {
|
|
376
|
-
return false;
|
|
377
|
-
}
|
|
378
|
-
for (const auths of authSchemeArray) {
|
|
379
|
-
if (auths.length === 1) {
|
|
380
|
-
if ((options.allowAPIKeyAuth && Utils.isAPIKeyAuth(auths[0].authScheme)) ||
|
|
381
|
-
(options.allowOauth2 && Utils.isOAuthWithAuthCodeFlow(auths[0].authScheme)) ||
|
|
382
|
-
(options.allowBearerTokenAuth && Utils.isBearerTokenAuth(auths[0].authScheme))) {
|
|
383
|
-
return true;
|
|
384
|
-
}
|
|
385
|
-
}
|
|
386
|
-
}
|
|
387
|
-
}
|
|
388
|
-
return false;
|
|
389
|
-
}
|
|
390
202
|
static isBearerTokenAuth(authScheme) {
|
|
391
203
|
return authScheme.type === "http" && authScheme.scheme === "bearer";
|
|
392
204
|
}
|
|
@@ -394,18 +206,18 @@ class Utils {
|
|
|
394
206
|
return authScheme.type === "apiKey";
|
|
395
207
|
}
|
|
396
208
|
static isOAuthWithAuthCodeFlow(authScheme) {
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
return false;
|
|
209
|
+
return !!(authScheme.type === "oauth2" &&
|
|
210
|
+
authScheme.flows &&
|
|
211
|
+
authScheme.flows.authorizationCode);
|
|
401
212
|
}
|
|
402
213
|
static getAuthArray(securities, spec) {
|
|
403
214
|
var _a;
|
|
404
215
|
const result = [];
|
|
405
216
|
const securitySchemas = (_a = spec.components) === null || _a === void 0 ? void 0 : _a.securitySchemes;
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
217
|
+
const securitiesArr = securities !== null && securities !== void 0 ? securities : spec.security;
|
|
218
|
+
if (securitiesArr && securitySchemas) {
|
|
219
|
+
for (let i = 0; i < securitiesArr.length; i++) {
|
|
220
|
+
const security = securitiesArr[i];
|
|
409
221
|
const authArray = [];
|
|
410
222
|
for (const name in security) {
|
|
411
223
|
const auth = securitySchemas[name];
|
|
@@ -422,17 +234,39 @@ class Utils {
|
|
|
422
234
|
result.sort((a, b) => a[0].name.localeCompare(b[0].name));
|
|
423
235
|
return result;
|
|
424
236
|
}
|
|
237
|
+
static getAuthInfo(spec) {
|
|
238
|
+
let authInfo = undefined;
|
|
239
|
+
for (const url in spec.paths) {
|
|
240
|
+
for (const method in spec.paths[url]) {
|
|
241
|
+
const operation = spec.paths[url][method];
|
|
242
|
+
const authArray = Utils.getAuthArray(operation.security, spec);
|
|
243
|
+
if (authArray && authArray.length > 0) {
|
|
244
|
+
const currentAuth = authArray[0][0];
|
|
245
|
+
if (!authInfo) {
|
|
246
|
+
authInfo = authArray[0][0];
|
|
247
|
+
}
|
|
248
|
+
else if (authInfo.name !== currentAuth.name) {
|
|
249
|
+
throw new SpecParserError(ConstantString.MultipleAuthNotSupported, ErrorType.MultipleAuthNotSupported);
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
}
|
|
253
|
+
}
|
|
254
|
+
return authInfo;
|
|
255
|
+
}
|
|
425
256
|
static updateFirstLetter(str) {
|
|
426
257
|
return str.charAt(0).toUpperCase() + str.slice(1);
|
|
427
258
|
}
|
|
428
|
-
static getResponseJson(operationObject
|
|
259
|
+
static getResponseJson(operationObject) {
|
|
429
260
|
var _a, _b;
|
|
430
261
|
let json = {};
|
|
262
|
+
let multipleMediaType = false;
|
|
431
263
|
for (const code of ConstantString.ResponseCodeFor20X) {
|
|
432
264
|
const responseObject = (_a = operationObject === null || operationObject === void 0 ? void 0 : operationObject.responses) === null || _a === void 0 ? void 0 : _a[code];
|
|
433
265
|
if ((_b = responseObject === null || responseObject === void 0 ? void 0 : responseObject.content) === null || _b === void 0 ? void 0 : _b["application/json"]) {
|
|
266
|
+
multipleMediaType = false;
|
|
434
267
|
json = responseObject.content["application/json"];
|
|
435
|
-
if (
|
|
268
|
+
if (Utils.containMultipleMediaTypes(responseObject)) {
|
|
269
|
+
multipleMediaType = true;
|
|
436
270
|
json = {};
|
|
437
271
|
}
|
|
438
272
|
else {
|
|
@@ -440,7 +274,7 @@ class Utils {
|
|
|
440
274
|
}
|
|
441
275
|
}
|
|
442
276
|
}
|
|
443
|
-
return json;
|
|
277
|
+
return { json, multipleMediaType };
|
|
444
278
|
}
|
|
445
279
|
static convertPathToCamelCase(path) {
|
|
446
280
|
const pathSegments = path.split(/[./{]/);
|
|
@@ -460,10 +294,10 @@ class Utils {
|
|
|
460
294
|
return undefined;
|
|
461
295
|
}
|
|
462
296
|
}
|
|
463
|
-
static
|
|
297
|
+
static resolveEnv(str) {
|
|
464
298
|
const placeHolderReg = /\${{\s*([a-zA-Z_][a-zA-Z0-9_]*)\s*}}/g;
|
|
465
|
-
let matches = placeHolderReg.exec(
|
|
466
|
-
let
|
|
299
|
+
let matches = placeHolderReg.exec(str);
|
|
300
|
+
let newStr = str;
|
|
467
301
|
while (matches != null) {
|
|
468
302
|
const envVar = matches[1];
|
|
469
303
|
const envVal = process.env[envVar];
|
|
@@ -471,17 +305,17 @@ class Utils {
|
|
|
471
305
|
throw new Error(Utils.format(ConstantString.ResolveServerUrlFailed, envVar));
|
|
472
306
|
}
|
|
473
307
|
else {
|
|
474
|
-
|
|
308
|
+
newStr = newStr.replace(matches[0], envVal);
|
|
475
309
|
}
|
|
476
|
-
matches = placeHolderReg.exec(
|
|
310
|
+
matches = placeHolderReg.exec(str);
|
|
477
311
|
}
|
|
478
|
-
return
|
|
312
|
+
return newStr;
|
|
479
313
|
}
|
|
480
314
|
static checkServerUrl(servers) {
|
|
481
315
|
const errors = [];
|
|
482
316
|
let serverUrl;
|
|
483
317
|
try {
|
|
484
|
-
serverUrl = Utils.
|
|
318
|
+
serverUrl = Utils.resolveEnv(servers[0].url);
|
|
485
319
|
}
|
|
486
320
|
catch (err) {
|
|
487
321
|
errors.push({
|
|
@@ -512,6 +346,7 @@ class Utils {
|
|
|
512
346
|
return errors;
|
|
513
347
|
}
|
|
514
348
|
static validateServer(spec, options) {
|
|
349
|
+
var _a;
|
|
515
350
|
const errors = [];
|
|
516
351
|
let hasTopLevelServers = false;
|
|
517
352
|
let hasPathLevelServers = false;
|
|
@@ -532,7 +367,7 @@ class Utils {
|
|
|
532
367
|
}
|
|
533
368
|
for (const method in methods) {
|
|
534
369
|
const operationObject = methods[method];
|
|
535
|
-
if (
|
|
370
|
+
if (((_a = options.allowMethods) === null || _a === void 0 ? void 0 : _a.includes(method)) && operationObject) {
|
|
536
371
|
if ((operationObject === null || operationObject === void 0 ? void 0 : operationObject.servers) && operationObject.servers.length >= 1) {
|
|
537
372
|
hasOperationLevelServers = true;
|
|
538
373
|
const serverErrors = Utils.checkServerUrl(operationObject.servers);
|
|
@@ -659,13 +494,7 @@ class Utils {
|
|
|
659
494
|
}
|
|
660
495
|
}
|
|
661
496
|
const operationId = operationItem.operationId;
|
|
662
|
-
const parameters = [];
|
|
663
|
-
if (requiredParams.length !== 0) {
|
|
664
|
-
parameters.push(...requiredParams);
|
|
665
|
-
}
|
|
666
|
-
else {
|
|
667
|
-
parameters.push(optionalParams[0]);
|
|
668
|
-
}
|
|
497
|
+
const parameters = [...requiredParams, ...optionalParams];
|
|
669
498
|
const command = {
|
|
670
499
|
context: ["compose"],
|
|
671
500
|
type: "query",
|
|
@@ -674,347 +503,575 @@ class Utils {
|
|
|
674
503
|
parameters: parameters,
|
|
675
504
|
description: ((_b = operationItem.description) !== null && _b !== void 0 ? _b : "").slice(0, ConstantString.CommandDescriptionMaxLens),
|
|
676
505
|
};
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
506
|
+
return command;
|
|
507
|
+
}
|
|
508
|
+
static format(str, ...args) {
|
|
509
|
+
let index = 0;
|
|
510
|
+
return str.replace(/%s/g, () => {
|
|
511
|
+
const arg = args[index++];
|
|
512
|
+
return arg !== undefined ? arg : "";
|
|
513
|
+
});
|
|
514
|
+
}
|
|
515
|
+
static getSafeRegistrationIdEnvName(authName) {
|
|
516
|
+
if (!authName) {
|
|
517
|
+
return "";
|
|
518
|
+
}
|
|
519
|
+
let safeRegistrationIdEnvName = authName.toUpperCase().replace(/[^A-Z0-9_]/g, "_");
|
|
520
|
+
if (!safeRegistrationIdEnvName.match(/^[A-Z]/)) {
|
|
521
|
+
safeRegistrationIdEnvName = "PREFIX_" + safeRegistrationIdEnvName;
|
|
684
522
|
}
|
|
685
|
-
return
|
|
523
|
+
return safeRegistrationIdEnvName;
|
|
686
524
|
}
|
|
687
|
-
static
|
|
688
|
-
const
|
|
525
|
+
static getServerObject(spec, method, path) {
|
|
526
|
+
const pathObj = spec.paths[path];
|
|
527
|
+
const operationObject = pathObj[method];
|
|
528
|
+
const rootServer = spec.servers && spec.servers[0];
|
|
529
|
+
const methodServer = spec.paths[path].servers && spec.paths[path].servers[0];
|
|
530
|
+
const operationServer = operationObject.servers && operationObject.servers[0];
|
|
531
|
+
const serverUrl = operationServer || methodServer || rootServer;
|
|
532
|
+
return serverUrl;
|
|
533
|
+
}
|
|
534
|
+
}
|
|
535
|
+
|
|
536
|
+
// Copyright (c) Microsoft Corporation.
|
|
537
|
+
class Validator {
|
|
538
|
+
listAPIs() {
|
|
539
|
+
var _a;
|
|
540
|
+
if (this.apiMap) {
|
|
541
|
+
return this.apiMap;
|
|
542
|
+
}
|
|
543
|
+
const paths = this.spec.paths;
|
|
689
544
|
const result = {};
|
|
690
545
|
for (const path in paths) {
|
|
691
546
|
const methods = paths[path];
|
|
692
547
|
for (const method in methods) {
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
548
|
+
const operationObject = methods[method];
|
|
549
|
+
if (((_a = this.options.allowMethods) === null || _a === void 0 ? void 0 : _a.includes(method)) && operationObject) {
|
|
550
|
+
const validateResult = this.validateAPI(method, path);
|
|
551
|
+
result[`${method.toUpperCase()} ${path}`] = {
|
|
552
|
+
operation: operationObject,
|
|
553
|
+
isValid: validateResult.isValid,
|
|
554
|
+
reason: validateResult.reason,
|
|
555
|
+
};
|
|
696
556
|
}
|
|
697
557
|
}
|
|
698
558
|
}
|
|
559
|
+
this.apiMap = result;
|
|
699
560
|
return result;
|
|
700
561
|
}
|
|
701
|
-
|
|
702
|
-
const
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
562
|
+
validateSpecVersion() {
|
|
563
|
+
const result = { errors: [], warnings: [] };
|
|
564
|
+
if (this.spec.openapi >= "3.1.0") {
|
|
565
|
+
result.errors.push({
|
|
566
|
+
type: ErrorType.SpecVersionNotSupported,
|
|
567
|
+
content: Utils.format(ConstantString.SpecVersionNotSupported, this.spec.openapi),
|
|
568
|
+
data: this.spec.openapi,
|
|
708
569
|
});
|
|
709
570
|
}
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
const
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
571
|
+
return result;
|
|
572
|
+
}
|
|
573
|
+
validateSpecServer() {
|
|
574
|
+
const result = { errors: [], warnings: [] };
|
|
575
|
+
const serverErrors = Utils.validateServer(this.spec, this.options);
|
|
576
|
+
result.errors.push(...serverErrors);
|
|
577
|
+
return result;
|
|
578
|
+
}
|
|
579
|
+
validateSpecNoSupportAPI() {
|
|
580
|
+
const result = { errors: [], warnings: [] };
|
|
581
|
+
const apiMap = this.listAPIs();
|
|
582
|
+
const validAPIs = Object.entries(apiMap).filter(([, value]) => value.isValid);
|
|
583
|
+
if (validAPIs.length === 0) {
|
|
584
|
+
const data = [];
|
|
585
|
+
for (const key in apiMap) {
|
|
586
|
+
const { reason } = apiMap[key];
|
|
587
|
+
const apiInvalidReason = { api: key, reason: reason };
|
|
588
|
+
data.push(apiInvalidReason);
|
|
589
|
+
}
|
|
590
|
+
result.errors.push({
|
|
727
591
|
type: ErrorType.NoSupportedApi,
|
|
728
592
|
content: ConstantString.NoSupportedApi,
|
|
593
|
+
data,
|
|
729
594
|
});
|
|
730
595
|
}
|
|
596
|
+
return result;
|
|
597
|
+
}
|
|
598
|
+
validateSpecOperationId() {
|
|
599
|
+
const result = { errors: [], warnings: [] };
|
|
600
|
+
const apiMap = this.listAPIs();
|
|
731
601
|
// OperationId missing
|
|
732
602
|
const apisMissingOperationId = [];
|
|
733
603
|
for (const key in apiMap) {
|
|
734
|
-
const
|
|
735
|
-
if (!
|
|
604
|
+
const { operation } = apiMap[key];
|
|
605
|
+
if (!operation.operationId) {
|
|
736
606
|
apisMissingOperationId.push(key);
|
|
737
607
|
}
|
|
738
608
|
}
|
|
739
609
|
if (apisMissingOperationId.length > 0) {
|
|
740
|
-
warnings.push({
|
|
610
|
+
result.warnings.push({
|
|
741
611
|
type: WarningType.OperationIdMissing,
|
|
742
612
|
content: Utils.format(ConstantString.MissingOperationId, apisMissingOperationId.join(", ")),
|
|
743
613
|
data: apisMissingOperationId,
|
|
744
614
|
});
|
|
745
615
|
}
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
616
|
+
return result;
|
|
617
|
+
}
|
|
618
|
+
validateMethodAndPath(method, path) {
|
|
619
|
+
const result = { isValid: true, reason: [] };
|
|
620
|
+
if (this.options.allowMethods && !this.options.allowMethods.includes(method)) {
|
|
621
|
+
result.isValid = false;
|
|
622
|
+
result.reason.push(ErrorType.MethodNotAllowed);
|
|
623
|
+
return result;
|
|
749
624
|
}
|
|
750
|
-
|
|
751
|
-
|
|
625
|
+
const pathObj = this.spec.paths[path];
|
|
626
|
+
if (!pathObj || !pathObj[method]) {
|
|
627
|
+
result.isValid = false;
|
|
628
|
+
result.reason.push(ErrorType.UrlPathNotExist);
|
|
629
|
+
return result;
|
|
752
630
|
}
|
|
753
|
-
return
|
|
754
|
-
status,
|
|
755
|
-
warnings,
|
|
756
|
-
errors,
|
|
757
|
-
};
|
|
631
|
+
return result;
|
|
758
632
|
}
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
|
|
633
|
+
validateResponse(method, path) {
|
|
634
|
+
const result = { isValid: true, reason: [] };
|
|
635
|
+
const operationObject = this.spec.paths[path][method];
|
|
636
|
+
const { json, multipleMediaType } = Utils.getResponseJson(operationObject);
|
|
637
|
+
if (this.options.projectType === ProjectType.SME) {
|
|
638
|
+
// only support response body only contains “application/json” content type
|
|
639
|
+
if (multipleMediaType) {
|
|
640
|
+
result.reason.push(ErrorType.ResponseContainMultipleMediaTypes);
|
|
641
|
+
}
|
|
642
|
+
else if (Object.keys(json).length === 0) {
|
|
643
|
+
// response body should not be empty
|
|
644
|
+
result.reason.push(ErrorType.ResponseJsonIsEmpty);
|
|
645
|
+
}
|
|
646
|
+
}
|
|
647
|
+
return result;
|
|
765
648
|
}
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
649
|
+
validateServer(method, path) {
|
|
650
|
+
const result = { isValid: true, reason: [] };
|
|
651
|
+
const serverObj = Utils.getServerObject(this.spec, method, path);
|
|
652
|
+
if (!serverObj) {
|
|
653
|
+
// should contain server URL
|
|
654
|
+
result.reason.push(ErrorType.NoServerInformation);
|
|
769
655
|
}
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
656
|
+
else {
|
|
657
|
+
// server url should be absolute url with https protocol
|
|
658
|
+
const serverValidateResult = Utils.checkServerUrl([serverObj]);
|
|
659
|
+
result.reason.push(...serverValidateResult.map((item) => item.type));
|
|
773
660
|
}
|
|
774
|
-
return
|
|
661
|
+
return result;
|
|
775
662
|
}
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
663
|
+
validateAuth(method, path) {
|
|
664
|
+
const pathObj = this.spec.paths[path];
|
|
665
|
+
const operationObject = pathObj[method];
|
|
666
|
+
const securities = operationObject.security;
|
|
667
|
+
const authSchemeArray = Utils.getAuthArray(securities, this.spec);
|
|
668
|
+
if (authSchemeArray.length === 0) {
|
|
669
|
+
return { isValid: true, reason: [] };
|
|
670
|
+
}
|
|
671
|
+
if (this.options.allowAPIKeyAuth ||
|
|
672
|
+
this.options.allowOauth2 ||
|
|
673
|
+
this.options.allowBearerTokenAuth) {
|
|
674
|
+
// Currently we don't support multiple auth in one operation
|
|
675
|
+
if (authSchemeArray.length > 0 && authSchemeArray.every((auths) => auths.length > 1)) {
|
|
676
|
+
return {
|
|
677
|
+
isValid: false,
|
|
678
|
+
reason: [ErrorType.MultipleAuthNotSupported],
|
|
679
|
+
};
|
|
680
|
+
}
|
|
681
|
+
for (const auths of authSchemeArray) {
|
|
682
|
+
if (auths.length === 1) {
|
|
683
|
+
if ((this.options.allowAPIKeyAuth && Utils.isAPIKeyAuth(auths[0].authScheme)) ||
|
|
684
|
+
(this.options.allowOauth2 && Utils.isOAuthWithAuthCodeFlow(auths[0].authScheme)) ||
|
|
685
|
+
(this.options.allowBearerTokenAuth && Utils.isBearerTokenAuth(auths[0].authScheme))) {
|
|
686
|
+
return { isValid: true, reason: [] };
|
|
794
687
|
}
|
|
795
688
|
}
|
|
796
|
-
newPaths[path][methodName] = unResolveSpec.paths[path][methodName];
|
|
797
|
-
// Add the operationId if missing
|
|
798
|
-
if (!newPaths[path][methodName].operationId) {
|
|
799
|
-
newPaths[path][methodName].operationId = `${methodName}${Utils.convertPathToCamelCase(path)}`;
|
|
800
|
-
}
|
|
801
689
|
}
|
|
802
|
-
newSpec.paths = newPaths;
|
|
803
|
-
return newSpec;
|
|
804
|
-
}
|
|
805
|
-
catch (err) {
|
|
806
|
-
throw new SpecParserError(err.toString(), ErrorType.FilterSpecFailed);
|
|
807
690
|
}
|
|
691
|
+
return { isValid: false, reason: [ErrorType.AuthTypeIsNotSupported] };
|
|
808
692
|
}
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
manifest.plugins = [
|
|
817
|
-
{
|
|
818
|
-
pluginFile: apiPluginRelativePath,
|
|
819
|
-
},
|
|
820
|
-
];
|
|
821
|
-
ManifestUpdater.updateManifestDescription(manifest, spec);
|
|
822
|
-
const specRelativePath = ManifestUpdater.getRelativePath(manifestPath, outputSpecPath);
|
|
823
|
-
const apiPlugin = ManifestUpdater.generatePluginManifestSchema(spec, specRelativePath, options);
|
|
824
|
-
return [manifest, apiPlugin];
|
|
825
|
-
}
|
|
826
|
-
static updateManifestDescription(manifest, spec) {
|
|
827
|
-
var _a, _b;
|
|
828
|
-
manifest.description = {
|
|
829
|
-
short: spec.info.title.slice(0, ConstantString.ShortDescriptionMaxLens),
|
|
830
|
-
full: (_b = ((_a = spec.info.description) !== null && _a !== void 0 ? _a : manifest.description.full)) === null || _b === void 0 ? void 0 : _b.slice(0, ConstantString.FullDescriptionMaxLens),
|
|
693
|
+
checkPostBodySchema(schema, isRequired = false) {
|
|
694
|
+
var _a;
|
|
695
|
+
const paramResult = {
|
|
696
|
+
requiredNum: 0,
|
|
697
|
+
optionalNum: 0,
|
|
698
|
+
isValid: true,
|
|
699
|
+
reason: [],
|
|
831
700
|
};
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
701
|
+
if (Object.keys(schema).length === 0) {
|
|
702
|
+
return paramResult;
|
|
703
|
+
}
|
|
704
|
+
const isRequiredWithoutDefault = isRequired && schema.default === undefined;
|
|
705
|
+
const isCopilot = this.projectType === ProjectType.Copilot;
|
|
706
|
+
if (isCopilot && this.hasNestedObjectInSchema(schema)) {
|
|
707
|
+
paramResult.isValid = false;
|
|
708
|
+
paramResult.reason = [ErrorType.RequestBodyContainsNestedObject];
|
|
709
|
+
return paramResult;
|
|
710
|
+
}
|
|
835
711
|
if (schema.type === "string" ||
|
|
836
|
-
schema.type === "boolean" ||
|
|
837
712
|
schema.type === "integer" ||
|
|
838
|
-
schema.type === "
|
|
839
|
-
schema.type === "
|
|
840
|
-
|
|
713
|
+
schema.type === "boolean" ||
|
|
714
|
+
schema.type === "number") {
|
|
715
|
+
if (isRequiredWithoutDefault) {
|
|
716
|
+
paramResult.requiredNum = paramResult.requiredNum + 1;
|
|
717
|
+
}
|
|
718
|
+
else {
|
|
719
|
+
paramResult.optionalNum = paramResult.optionalNum + 1;
|
|
720
|
+
}
|
|
721
|
+
}
|
|
722
|
+
else if (schema.type === "object") {
|
|
723
|
+
const { properties } = schema;
|
|
724
|
+
for (const property in properties) {
|
|
725
|
+
let isRequired = false;
|
|
726
|
+
if (schema.required && ((_a = schema.required) === null || _a === void 0 ? void 0 : _a.indexOf(property)) >= 0) {
|
|
727
|
+
isRequired = true;
|
|
728
|
+
}
|
|
729
|
+
const result = this.checkPostBodySchema(properties[property], isRequired);
|
|
730
|
+
paramResult.requiredNum += result.requiredNum;
|
|
731
|
+
paramResult.optionalNum += result.optionalNum;
|
|
732
|
+
paramResult.isValid = paramResult.isValid && result.isValid;
|
|
733
|
+
paramResult.reason.push(...result.reason);
|
|
734
|
+
}
|
|
841
735
|
}
|
|
842
736
|
else {
|
|
843
|
-
|
|
737
|
+
if (isRequiredWithoutDefault && !isCopilot) {
|
|
738
|
+
paramResult.isValid = false;
|
|
739
|
+
paramResult.reason.push(ErrorType.PostBodyContainsRequiredUnsupportedSchema);
|
|
740
|
+
}
|
|
844
741
|
}
|
|
845
|
-
return
|
|
742
|
+
return paramResult;
|
|
846
743
|
}
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
name: operationId,
|
|
900
|
-
description: description,
|
|
901
|
-
parameters: parameters,
|
|
902
|
-
};
|
|
903
|
-
functions.push(funcObj);
|
|
904
|
-
functionNames.push(operationId);
|
|
905
|
-
}
|
|
906
|
-
}
|
|
744
|
+
checkParamSchema(paramObject) {
|
|
745
|
+
const paramResult = {
|
|
746
|
+
requiredNum: 0,
|
|
747
|
+
optionalNum: 0,
|
|
748
|
+
isValid: true,
|
|
749
|
+
reason: [],
|
|
750
|
+
};
|
|
751
|
+
if (!paramObject) {
|
|
752
|
+
return paramResult;
|
|
753
|
+
}
|
|
754
|
+
const isCopilot = this.projectType === ProjectType.Copilot;
|
|
755
|
+
for (let i = 0; i < paramObject.length; i++) {
|
|
756
|
+
const param = paramObject[i];
|
|
757
|
+
const schema = param.schema;
|
|
758
|
+
if (isCopilot && this.hasNestedObjectInSchema(schema)) {
|
|
759
|
+
paramResult.isValid = false;
|
|
760
|
+
paramResult.reason.push(ErrorType.ParamsContainsNestedObject);
|
|
761
|
+
continue;
|
|
762
|
+
}
|
|
763
|
+
const isRequiredWithoutDefault = param.required && schema.default === undefined;
|
|
764
|
+
if (isCopilot) {
|
|
765
|
+
if (isRequiredWithoutDefault) {
|
|
766
|
+
paramResult.requiredNum = paramResult.requiredNum + 1;
|
|
767
|
+
}
|
|
768
|
+
else {
|
|
769
|
+
paramResult.optionalNum = paramResult.optionalNum + 1;
|
|
770
|
+
}
|
|
771
|
+
continue;
|
|
772
|
+
}
|
|
773
|
+
if (param.in === "header" || param.in === "cookie") {
|
|
774
|
+
if (isRequiredWithoutDefault) {
|
|
775
|
+
paramResult.isValid = false;
|
|
776
|
+
paramResult.reason.push(ErrorType.ParamsContainRequiredUnsupportedSchema);
|
|
777
|
+
}
|
|
778
|
+
continue;
|
|
779
|
+
}
|
|
780
|
+
if (schema.type !== "boolean" &&
|
|
781
|
+
schema.type !== "string" &&
|
|
782
|
+
schema.type !== "number" &&
|
|
783
|
+
schema.type !== "integer") {
|
|
784
|
+
if (isRequiredWithoutDefault) {
|
|
785
|
+
paramResult.isValid = false;
|
|
786
|
+
paramResult.reason.push(ErrorType.ParamsContainRequiredUnsupportedSchema);
|
|
787
|
+
}
|
|
788
|
+
continue;
|
|
789
|
+
}
|
|
790
|
+
if (param.in === "query" || param.in === "path") {
|
|
791
|
+
if (isRequiredWithoutDefault) {
|
|
792
|
+
paramResult.requiredNum = paramResult.requiredNum + 1;
|
|
793
|
+
}
|
|
794
|
+
else {
|
|
795
|
+
paramResult.optionalNum = paramResult.optionalNum + 1;
|
|
907
796
|
}
|
|
908
797
|
}
|
|
909
798
|
}
|
|
910
|
-
|
|
911
|
-
schema_version: "v2",
|
|
912
|
-
name_for_human: spec.info.title,
|
|
913
|
-
description_for_human: (_c = spec.info.description) !== null && _c !== void 0 ? _c : "<Please add description of the plugin>",
|
|
914
|
-
functions: functions,
|
|
915
|
-
runtimes: [
|
|
916
|
-
{
|
|
917
|
-
type: "OpenApi",
|
|
918
|
-
auth: {
|
|
919
|
-
type: "none", // TODO, support auth in the future
|
|
920
|
-
},
|
|
921
|
-
spec: {
|
|
922
|
-
url: specRelativePath,
|
|
923
|
-
},
|
|
924
|
-
run_for_functions: functionNames,
|
|
925
|
-
},
|
|
926
|
-
],
|
|
927
|
-
};
|
|
928
|
-
return apiPlugin;
|
|
799
|
+
return paramResult;
|
|
929
800
|
}
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
const
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
if (options.projectType === ProjectType.SME) {
|
|
937
|
-
const updateResult = await ManifestUpdater.generateCommands(spec, manifestPath, options, adaptiveCardFolder);
|
|
938
|
-
const commands = updateResult[0];
|
|
939
|
-
warnings = updateResult[1];
|
|
940
|
-
const composeExtension = {
|
|
941
|
-
composeExtensionType: "apiBased",
|
|
942
|
-
apiSpecificationFile: ManifestUpdater.getRelativePath(manifestPath, outputSpecPath),
|
|
943
|
-
commands: commands,
|
|
944
|
-
};
|
|
945
|
-
if (authInfo) {
|
|
946
|
-
const auth = authInfo.authScheme;
|
|
947
|
-
if (Utils.isAPIKeyAuth(auth) || Utils.isBearerTokenAuth(auth)) {
|
|
948
|
-
const safeApiSecretRegistrationId = Utils.getSafeRegistrationIdEnvName(`${authInfo.name}_${ConstantString.RegistrationIdPostfix}`);
|
|
949
|
-
composeExtension.authorization = {
|
|
950
|
-
authType: "apiSecretServiceAuth",
|
|
951
|
-
apiSecretServiceAuthConfiguration: {
|
|
952
|
-
apiSecretRegistrationId: `\${{${safeApiSecretRegistrationId}}}`,
|
|
953
|
-
},
|
|
954
|
-
};
|
|
955
|
-
}
|
|
956
|
-
else if (Utils.isOAuthWithAuthCodeFlow(auth)) {
|
|
957
|
-
const safeOAuth2RegistrationId = Utils.getSafeRegistrationIdEnvName(`${authInfo.name}_${ConstantString.OAuthRegistrationIdPostFix}`);
|
|
958
|
-
composeExtension.authorization = {
|
|
959
|
-
authType: "oAuth2.0",
|
|
960
|
-
oAuthConfiguration: {
|
|
961
|
-
oauthConfigurationId: `\${{${safeOAuth2RegistrationId}}}`,
|
|
962
|
-
},
|
|
963
|
-
};
|
|
964
|
-
updatedPart.webApplicationInfo = {
|
|
965
|
-
id: "${{AAD_APP_CLIENT_ID}}",
|
|
966
|
-
resource: "api://${{DOMAIN}}/${{AAD_APP_CLIENT_ID}}",
|
|
967
|
-
};
|
|
968
|
-
}
|
|
801
|
+
hasNestedObjectInSchema(schema) {
|
|
802
|
+
if (schema.type === "object") {
|
|
803
|
+
for (const property in schema.properties) {
|
|
804
|
+
const nestedSchema = schema.properties[property];
|
|
805
|
+
if (nestedSchema.type === "object") {
|
|
806
|
+
return true;
|
|
969
807
|
}
|
|
970
|
-
updatedPart.composeExtensions = [composeExtension];
|
|
971
808
|
}
|
|
972
|
-
updatedPart.description = originalManifest.description;
|
|
973
|
-
ManifestUpdater.updateManifestDescription(updatedPart, spec);
|
|
974
|
-
const updatedManifest = Object.assign(Object.assign({}, originalManifest), updatedPart);
|
|
975
|
-
return [updatedManifest, warnings];
|
|
976
809
|
}
|
|
977
|
-
|
|
978
|
-
|
|
810
|
+
return false;
|
|
811
|
+
}
|
|
812
|
+
}
|
|
813
|
+
|
|
814
|
+
// Copyright (c) Microsoft Corporation.
|
|
815
|
+
class CopilotValidator extends Validator {
|
|
816
|
+
constructor(spec, options) {
|
|
817
|
+
super();
|
|
818
|
+
this.projectType = ProjectType.Copilot;
|
|
819
|
+
this.options = options;
|
|
820
|
+
this.spec = spec;
|
|
821
|
+
}
|
|
822
|
+
validateSpec() {
|
|
823
|
+
const result = { errors: [], warnings: [] };
|
|
824
|
+
// validate spec version
|
|
825
|
+
let validationResult = this.validateSpecVersion();
|
|
826
|
+
result.errors.push(...validationResult.errors);
|
|
827
|
+
// validate spec server
|
|
828
|
+
validationResult = this.validateSpecServer();
|
|
829
|
+
result.errors.push(...validationResult.errors);
|
|
830
|
+
// validate no supported API
|
|
831
|
+
validationResult = this.validateSpecNoSupportAPI();
|
|
832
|
+
result.errors.push(...validationResult.errors);
|
|
833
|
+
// validate operationId missing
|
|
834
|
+
validationResult = this.validateSpecOperationId();
|
|
835
|
+
result.warnings.push(...validationResult.warnings);
|
|
836
|
+
return result;
|
|
837
|
+
}
|
|
838
|
+
validateAPI(method, path) {
|
|
839
|
+
const result = { isValid: true, reason: [] };
|
|
840
|
+
method = method.toLocaleLowerCase();
|
|
841
|
+
// validate method and path
|
|
842
|
+
const methodAndPathResult = this.validateMethodAndPath(method, path);
|
|
843
|
+
if (!methodAndPathResult.isValid) {
|
|
844
|
+
return methodAndPathResult;
|
|
845
|
+
}
|
|
846
|
+
const operationObject = this.spec.paths[path][method];
|
|
847
|
+
// validate auth
|
|
848
|
+
const authCheckResult = this.validateAuth(method, path);
|
|
849
|
+
result.reason.push(...authCheckResult.reason);
|
|
850
|
+
// validate operationId
|
|
851
|
+
if (!this.options.allowMissingId && !operationObject.operationId) {
|
|
852
|
+
result.reason.push(ErrorType.MissingOperationId);
|
|
853
|
+
}
|
|
854
|
+
// validate server
|
|
855
|
+
const validateServerResult = this.validateServer(method, path);
|
|
856
|
+
result.reason.push(...validateServerResult.reason);
|
|
857
|
+
// validate response
|
|
858
|
+
const validateResponseResult = this.validateResponse(method, path);
|
|
859
|
+
result.reason.push(...validateResponseResult.reason);
|
|
860
|
+
// validate requestBody
|
|
861
|
+
const requestBody = operationObject.requestBody;
|
|
862
|
+
const requestJsonBody = requestBody === null || requestBody === void 0 ? void 0 : requestBody.content["application/json"];
|
|
863
|
+
if (requestJsonBody) {
|
|
864
|
+
const requestBodySchema = requestJsonBody.schema;
|
|
865
|
+
if (requestBodySchema.type !== "object") {
|
|
866
|
+
result.reason.push(ErrorType.PostBodySchemaIsNotJson);
|
|
867
|
+
}
|
|
868
|
+
const requestBodyParamResult = this.checkPostBodySchema(requestBodySchema, requestBody.required);
|
|
869
|
+
result.reason.push(...requestBodyParamResult.reason);
|
|
870
|
+
}
|
|
871
|
+
// validate parameters
|
|
872
|
+
const paramObject = operationObject.parameters;
|
|
873
|
+
const paramResult = this.checkParamSchema(paramObject);
|
|
874
|
+
result.reason.push(...paramResult.reason);
|
|
875
|
+
if (result.reason.length > 0) {
|
|
876
|
+
result.isValid = false;
|
|
979
877
|
}
|
|
878
|
+
return result;
|
|
980
879
|
}
|
|
981
|
-
|
|
880
|
+
}
|
|
881
|
+
|
|
882
|
+
// Copyright (c) Microsoft Corporation.
|
|
883
|
+
class SMEValidator extends Validator {
|
|
884
|
+
constructor(spec, options) {
|
|
885
|
+
super();
|
|
886
|
+
this.projectType = ProjectType.SME;
|
|
887
|
+
this.options = options;
|
|
888
|
+
this.spec = spec;
|
|
889
|
+
}
|
|
890
|
+
validateSpec() {
|
|
891
|
+
const result = { errors: [], warnings: [] };
|
|
892
|
+
// validate spec version
|
|
893
|
+
let validationResult = this.validateSpecVersion();
|
|
894
|
+
result.errors.push(...validationResult.errors);
|
|
895
|
+
// validate spec server
|
|
896
|
+
validationResult = this.validateSpecServer();
|
|
897
|
+
result.errors.push(...validationResult.errors);
|
|
898
|
+
// validate no supported API
|
|
899
|
+
validationResult = this.validateSpecNoSupportAPI();
|
|
900
|
+
result.errors.push(...validationResult.errors);
|
|
901
|
+
// validate operationId missing
|
|
902
|
+
if (this.options.allowMissingId) {
|
|
903
|
+
validationResult = this.validateSpecOperationId();
|
|
904
|
+
result.warnings.push(...validationResult.warnings);
|
|
905
|
+
}
|
|
906
|
+
return result;
|
|
907
|
+
}
|
|
908
|
+
validateAPI(method, path) {
|
|
909
|
+
const result = { isValid: true, reason: [] };
|
|
910
|
+
method = method.toLocaleLowerCase();
|
|
911
|
+
// validate method and path
|
|
912
|
+
const methodAndPathResult = this.validateMethodAndPath(method, path);
|
|
913
|
+
if (!methodAndPathResult.isValid) {
|
|
914
|
+
return methodAndPathResult;
|
|
915
|
+
}
|
|
916
|
+
const operationObject = this.spec.paths[path][method];
|
|
917
|
+
// validate auth
|
|
918
|
+
const authCheckResult = this.validateAuth(method, path);
|
|
919
|
+
result.reason.push(...authCheckResult.reason);
|
|
920
|
+
// validate operationId
|
|
921
|
+
if (!this.options.allowMissingId && !operationObject.operationId) {
|
|
922
|
+
result.reason.push(ErrorType.MissingOperationId);
|
|
923
|
+
}
|
|
924
|
+
// validate server
|
|
925
|
+
const validateServerResult = this.validateServer(method, path);
|
|
926
|
+
result.reason.push(...validateServerResult.reason);
|
|
927
|
+
// validate response
|
|
928
|
+
const validateResponseResult = this.validateResponse(method, path);
|
|
929
|
+
result.reason.push(...validateResponseResult.reason);
|
|
930
|
+
let postBodyResult = {
|
|
931
|
+
requiredNum: 0,
|
|
932
|
+
optionalNum: 0,
|
|
933
|
+
isValid: true,
|
|
934
|
+
reason: [],
|
|
935
|
+
};
|
|
936
|
+
// validate requestBody
|
|
937
|
+
const requestBody = operationObject.requestBody;
|
|
938
|
+
const requestJsonBody = requestBody === null || requestBody === void 0 ? void 0 : requestBody.content["application/json"];
|
|
939
|
+
if (Utils.containMultipleMediaTypes(requestBody)) {
|
|
940
|
+
result.reason.push(ErrorType.PostBodyContainMultipleMediaTypes);
|
|
941
|
+
}
|
|
942
|
+
if (requestJsonBody) {
|
|
943
|
+
const requestBodySchema = requestJsonBody.schema;
|
|
944
|
+
postBodyResult = this.checkPostBodySchema(requestBodySchema, requestBody.required);
|
|
945
|
+
result.reason.push(...postBodyResult.reason);
|
|
946
|
+
}
|
|
947
|
+
// validate parameters
|
|
948
|
+
const paramObject = operationObject.parameters;
|
|
949
|
+
const paramResult = this.checkParamSchema(paramObject);
|
|
950
|
+
result.reason.push(...paramResult.reason);
|
|
951
|
+
// validate total parameters count
|
|
952
|
+
if (paramResult.isValid && postBodyResult.isValid) {
|
|
953
|
+
const paramCountResult = this.validateParamCount(postBodyResult, paramResult);
|
|
954
|
+
result.reason.push(...paramCountResult.reason);
|
|
955
|
+
}
|
|
956
|
+
if (result.reason.length > 0) {
|
|
957
|
+
result.isValid = false;
|
|
958
|
+
}
|
|
959
|
+
return result;
|
|
960
|
+
}
|
|
961
|
+
validateParamCount(postBodyResult, paramResult) {
|
|
962
|
+
const result = { isValid: true, reason: [] };
|
|
963
|
+
const totalRequiredParams = postBodyResult.requiredNum + paramResult.requiredNum;
|
|
964
|
+
const totalParams = totalRequiredParams + postBodyResult.optionalNum + paramResult.optionalNum;
|
|
965
|
+
if (totalRequiredParams > 1) {
|
|
966
|
+
if (!this.options.allowMultipleParameters ||
|
|
967
|
+
totalRequiredParams > SMEValidator.SMERequiredParamsMaxNum) {
|
|
968
|
+
result.reason.push(ErrorType.ExceededRequiredParamsLimit);
|
|
969
|
+
}
|
|
970
|
+
}
|
|
971
|
+
else if (totalParams === 0) {
|
|
972
|
+
result.reason.push(ErrorType.NoParameter);
|
|
973
|
+
}
|
|
974
|
+
return result;
|
|
975
|
+
}
|
|
976
|
+
}
|
|
977
|
+
SMEValidator.SMERequiredParamsMaxNum = 5;
|
|
978
|
+
|
|
979
|
+
// Copyright (c) Microsoft Corporation.
|
|
980
|
+
class TeamsAIValidator extends Validator {
|
|
981
|
+
constructor(spec, options) {
|
|
982
|
+
super();
|
|
983
|
+
this.projectType = ProjectType.TeamsAi;
|
|
984
|
+
this.options = options;
|
|
985
|
+
this.spec = spec;
|
|
986
|
+
}
|
|
987
|
+
validateSpec() {
|
|
988
|
+
const result = { errors: [], warnings: [] };
|
|
989
|
+
// validate spec server
|
|
990
|
+
let validationResult = this.validateSpecServer();
|
|
991
|
+
result.errors.push(...validationResult.errors);
|
|
992
|
+
// validate no supported API
|
|
993
|
+
validationResult = this.validateSpecNoSupportAPI();
|
|
994
|
+
result.errors.push(...validationResult.errors);
|
|
995
|
+
return result;
|
|
996
|
+
}
|
|
997
|
+
validateAPI(method, path) {
|
|
998
|
+
const result = { isValid: true, reason: [] };
|
|
999
|
+
method = method.toLocaleLowerCase();
|
|
1000
|
+
// validate method and path
|
|
1001
|
+
const methodAndPathResult = this.validateMethodAndPath(method, path);
|
|
1002
|
+
if (!methodAndPathResult.isValid) {
|
|
1003
|
+
return methodAndPathResult;
|
|
1004
|
+
}
|
|
1005
|
+
const operationObject = this.spec.paths[path][method];
|
|
1006
|
+
// validate operationId
|
|
1007
|
+
if (!this.options.allowMissingId && !operationObject.operationId) {
|
|
1008
|
+
result.reason.push(ErrorType.MissingOperationId);
|
|
1009
|
+
}
|
|
1010
|
+
// validate server
|
|
1011
|
+
const validateServerResult = this.validateServer(method, path);
|
|
1012
|
+
result.reason.push(...validateServerResult.reason);
|
|
1013
|
+
if (result.reason.length > 0) {
|
|
1014
|
+
result.isValid = false;
|
|
1015
|
+
}
|
|
1016
|
+
return result;
|
|
1017
|
+
}
|
|
1018
|
+
}
|
|
1019
|
+
|
|
1020
|
+
class ValidatorFactory {
|
|
1021
|
+
static create(spec, options) {
|
|
982
1022
|
var _a;
|
|
983
|
-
const
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1023
|
+
const type = (_a = options.projectType) !== null && _a !== void 0 ? _a : ProjectType.SME;
|
|
1024
|
+
switch (type) {
|
|
1025
|
+
case ProjectType.SME:
|
|
1026
|
+
return new SMEValidator(spec, options);
|
|
1027
|
+
case ProjectType.Copilot:
|
|
1028
|
+
return new CopilotValidator(spec, options);
|
|
1029
|
+
case ProjectType.TeamsAi:
|
|
1030
|
+
return new TeamsAIValidator(spec, options);
|
|
1031
|
+
default:
|
|
1032
|
+
throw new Error(`Invalid project type: ${type}`);
|
|
1033
|
+
}
|
|
1034
|
+
}
|
|
1035
|
+
}
|
|
1036
|
+
|
|
1037
|
+
// Copyright (c) Microsoft Corporation.
|
|
1038
|
+
class SpecFilter {
|
|
1039
|
+
static specFilter(filter, unResolveSpec, resolvedSpec, options) {
|
|
1040
|
+
var _a;
|
|
1041
|
+
try {
|
|
1042
|
+
const newSpec = Object.assign({}, unResolveSpec);
|
|
1043
|
+
const newPaths = {};
|
|
1044
|
+
for (const filterItem of filter) {
|
|
1045
|
+
const [method, path] = filterItem.split(" ");
|
|
1046
|
+
const methodName = method.toLowerCase();
|
|
1047
|
+
const pathObj = (_a = resolvedSpec.paths) === null || _a === void 0 ? void 0 : _a[path];
|
|
1048
|
+
if (ConstantString.AllOperationMethods.includes(methodName) &&
|
|
1049
|
+
pathObj &&
|
|
1050
|
+
pathObj[methodName]) {
|
|
1051
|
+
const validator = ValidatorFactory.create(resolvedSpec, options);
|
|
1052
|
+
const validateResult = validator.validateAPI(methodName, path);
|
|
1053
|
+
if (!validateResult.isValid) {
|
|
1054
|
+
continue;
|
|
1055
|
+
}
|
|
1056
|
+
if (!newPaths[path]) {
|
|
1057
|
+
newPaths[path] = Object.assign({}, unResolveSpec.paths[path]);
|
|
1058
|
+
for (const m of ConstantString.AllOperationMethods) {
|
|
1059
|
+
delete newPaths[path][m];
|
|
1008
1060
|
}
|
|
1009
1061
|
}
|
|
1062
|
+
newPaths[path][methodName] = unResolveSpec.paths[path][methodName];
|
|
1063
|
+
// Add the operationId if missing
|
|
1064
|
+
if (!newPaths[path][methodName].operationId) {
|
|
1065
|
+
newPaths[path][methodName].operationId = `${methodName}${Utils.convertPathToCamelCase(path)}`;
|
|
1066
|
+
}
|
|
1010
1067
|
}
|
|
1011
1068
|
}
|
|
1069
|
+
newSpec.paths = newPaths;
|
|
1070
|
+
return newSpec;
|
|
1071
|
+
}
|
|
1072
|
+
catch (err) {
|
|
1073
|
+
throw new SpecParserError(err.toString(), ErrorType.FilterSpecFailed);
|
|
1012
1074
|
}
|
|
1013
|
-
return [commands, warnings];
|
|
1014
|
-
}
|
|
1015
|
-
static getRelativePath(from, to) {
|
|
1016
|
-
const relativePath = path.relative(path.dirname(from), to);
|
|
1017
|
-
return path.normalize(relativePath).replace(/\\/g, "/");
|
|
1018
1075
|
}
|
|
1019
1076
|
}
|
|
1020
1077
|
|
|
@@ -1022,7 +1079,7 @@ class ManifestUpdater {
|
|
|
1022
1079
|
class AdaptiveCardGenerator {
|
|
1023
1080
|
static generateAdaptiveCard(operationItem) {
|
|
1024
1081
|
try {
|
|
1025
|
-
const json = Utils.getResponseJson(operationItem);
|
|
1082
|
+
const { json } = Utils.getResponseJson(operationItem);
|
|
1026
1083
|
let cardBody = [];
|
|
1027
1084
|
let schema = json.schema;
|
|
1028
1085
|
let jsonPath = "$";
|
|
@@ -1188,6 +1245,27 @@ function wrapAdaptiveCard(card, jsonPath) {
|
|
|
1188
1245
|
};
|
|
1189
1246
|
return result;
|
|
1190
1247
|
}
|
|
1248
|
+
function wrapResponseSemantics(card, jsonPath) {
|
|
1249
|
+
const props = inferProperties(card);
|
|
1250
|
+
const dataPath = jsonPath === "$" ? "$" : "$." + jsonPath;
|
|
1251
|
+
const result = {
|
|
1252
|
+
data_path: dataPath,
|
|
1253
|
+
};
|
|
1254
|
+
if (props.title || props.subtitle || props.imageUrl) {
|
|
1255
|
+
result.properties = {};
|
|
1256
|
+
if (props.title) {
|
|
1257
|
+
result.properties.title = "$." + props.title;
|
|
1258
|
+
}
|
|
1259
|
+
if (props.subtitle) {
|
|
1260
|
+
result.properties.subtitle = "$." + props.subtitle;
|
|
1261
|
+
}
|
|
1262
|
+
if (props.imageUrl) {
|
|
1263
|
+
result.properties.url = "$." + props.imageUrl;
|
|
1264
|
+
}
|
|
1265
|
+
}
|
|
1266
|
+
result.static_template = card;
|
|
1267
|
+
return result;
|
|
1268
|
+
}
|
|
1191
1269
|
/**
|
|
1192
1270
|
* Infers the preview card template from an Adaptive Card and a JSON path.
|
|
1193
1271
|
* The preview card template includes a title and an optional subtitle and image.
|
|
@@ -1200,11 +1278,29 @@ function wrapAdaptiveCard(card, jsonPath) {
|
|
|
1200
1278
|
* @returns The inferred preview card template.
|
|
1201
1279
|
*/
|
|
1202
1280
|
function inferPreviewCardTemplate(card) {
|
|
1203
|
-
var _a;
|
|
1204
1281
|
const result = {
|
|
1205
|
-
title: "",
|
|
1282
|
+
title: "result",
|
|
1206
1283
|
};
|
|
1207
|
-
const
|
|
1284
|
+
const inferredProperties = inferProperties(card);
|
|
1285
|
+
if (inferredProperties.title) {
|
|
1286
|
+
result.title = `\${if(${inferredProperties.title}, ${inferredProperties.title}, 'N/A')}`;
|
|
1287
|
+
}
|
|
1288
|
+
if (inferredProperties.subtitle) {
|
|
1289
|
+
result.subtitle = `\${if(${inferredProperties.subtitle}, ${inferredProperties.subtitle}, 'N/A')}`;
|
|
1290
|
+
}
|
|
1291
|
+
if (inferredProperties.imageUrl) {
|
|
1292
|
+
result.image = {
|
|
1293
|
+
url: `\${${inferredProperties.imageUrl}}`,
|
|
1294
|
+
alt: `\${if(${inferredProperties.imageUrl}, ${inferredProperties.imageUrl}, 'N/A')}`,
|
|
1295
|
+
$when: `\${${inferredProperties.imageUrl} != null}`,
|
|
1296
|
+
};
|
|
1297
|
+
}
|
|
1298
|
+
return result;
|
|
1299
|
+
}
|
|
1300
|
+
function inferProperties(card) {
|
|
1301
|
+
var _a;
|
|
1302
|
+
const result = {};
|
|
1303
|
+
const nameSet = new Set();
|
|
1208
1304
|
let rootObject;
|
|
1209
1305
|
if (((_a = card.body[0]) === null || _a === void 0 ? void 0 : _a.type) === ConstantString.ContainerType) {
|
|
1210
1306
|
rootObject = card.body[0].items;
|
|
@@ -1217,56 +1313,372 @@ function inferPreviewCardTemplate(card) {
|
|
|
1217
1313
|
const textElement = element;
|
|
1218
1314
|
const index = textElement.text.indexOf("${if(");
|
|
1219
1315
|
if (index > 0) {
|
|
1220
|
-
|
|
1221
|
-
|
|
1316
|
+
const text = textElement.text.substring(index);
|
|
1317
|
+
const match = text.match(/\${if\(([^,]+),/);
|
|
1318
|
+
const property = match ? match[1] : "";
|
|
1319
|
+
if (property) {
|
|
1320
|
+
nameSet.add(property);
|
|
1321
|
+
}
|
|
1322
|
+
}
|
|
1323
|
+
}
|
|
1324
|
+
else if (element.type === ConstantString.ImageType) {
|
|
1325
|
+
const imageElement = element;
|
|
1326
|
+
const match = imageElement.url.match(/\${([^,]+)}/);
|
|
1327
|
+
const property = match ? match[1] : "";
|
|
1328
|
+
if (property) {
|
|
1329
|
+
nameSet.add(property);
|
|
1222
1330
|
}
|
|
1223
1331
|
}
|
|
1224
1332
|
}
|
|
1225
|
-
for (const
|
|
1226
|
-
|
|
1227
|
-
|
|
1228
|
-
|
|
1229
|
-
textBlockElements.delete(element);
|
|
1333
|
+
for (const name of nameSet) {
|
|
1334
|
+
if (!result.title && Utils.isWellKnownName(name, ConstantString.WellknownTitleName)) {
|
|
1335
|
+
result.title = name;
|
|
1336
|
+
nameSet.delete(name);
|
|
1230
1337
|
}
|
|
1231
1338
|
else if (!result.subtitle &&
|
|
1232
|
-
Utils.isWellKnownName(
|
|
1233
|
-
result.subtitle =
|
|
1234
|
-
|
|
1339
|
+
Utils.isWellKnownName(name, ConstantString.WellknownSubtitleName)) {
|
|
1340
|
+
result.subtitle = name;
|
|
1341
|
+
nameSet.delete(name);
|
|
1235
1342
|
}
|
|
1236
|
-
else if (!result.
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
|
-
if (property) {
|
|
1240
|
-
result.image = {
|
|
1241
|
-
url: `\${${property}}`,
|
|
1242
|
-
alt: text,
|
|
1243
|
-
$when: `\${${property} != null}`,
|
|
1244
|
-
};
|
|
1245
|
-
}
|
|
1246
|
-
textBlockElements.delete(element);
|
|
1343
|
+
else if (!result.imageUrl && Utils.isWellKnownName(name, ConstantString.WellknownImageName)) {
|
|
1344
|
+
result.imageUrl = name;
|
|
1345
|
+
nameSet.delete(name);
|
|
1247
1346
|
}
|
|
1248
1347
|
}
|
|
1249
|
-
for (const
|
|
1250
|
-
const text = element.text;
|
|
1348
|
+
for (const name of nameSet) {
|
|
1251
1349
|
if (!result.title) {
|
|
1252
|
-
result.title =
|
|
1253
|
-
|
|
1350
|
+
result.title = name;
|
|
1351
|
+
nameSet.delete(name);
|
|
1254
1352
|
}
|
|
1255
1353
|
else if (!result.subtitle) {
|
|
1256
|
-
result.subtitle =
|
|
1257
|
-
|
|
1354
|
+
result.subtitle = name;
|
|
1355
|
+
nameSet.delete(name);
|
|
1258
1356
|
}
|
|
1259
1357
|
}
|
|
1260
1358
|
if (!result.title && result.subtitle) {
|
|
1261
1359
|
result.title = result.subtitle;
|
|
1262
1360
|
delete result.subtitle;
|
|
1263
1361
|
}
|
|
1264
|
-
if (!result.title) {
|
|
1265
|
-
result.title = "result";
|
|
1266
|
-
}
|
|
1267
1362
|
return result;
|
|
1268
1363
|
}
|
|
1269
1364
|
|
|
1365
|
+
// Copyright (c) Microsoft Corporation.
|
|
1366
|
+
class ManifestUpdater {
|
|
1367
|
+
static async updateManifestWithAiPlugin(manifestPath, outputSpecPath, apiPluginFilePath, spec, options, authInfo) {
|
|
1368
|
+
const manifest = await fs.readJSON(manifestPath);
|
|
1369
|
+
const apiPluginRelativePath = ManifestUpdater.getRelativePath(manifestPath, apiPluginFilePath);
|
|
1370
|
+
// Insert plugins in manifest.json if it is plugin for Copilot.
|
|
1371
|
+
if (!options.isGptPlugin) {
|
|
1372
|
+
manifest.plugins = [
|
|
1373
|
+
{
|
|
1374
|
+
file: apiPluginRelativePath,
|
|
1375
|
+
id: ConstantString.DefaultPluginId,
|
|
1376
|
+
},
|
|
1377
|
+
];
|
|
1378
|
+
ManifestUpdater.updateManifestDescription(manifest, spec);
|
|
1379
|
+
}
|
|
1380
|
+
const appName = this.removeEnvs(manifest.name.short);
|
|
1381
|
+
const specRelativePath = ManifestUpdater.getRelativePath(manifestPath, outputSpecPath);
|
|
1382
|
+
const apiPlugin = await ManifestUpdater.generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, authInfo, options);
|
|
1383
|
+
return [manifest, apiPlugin];
|
|
1384
|
+
}
|
|
1385
|
+
static updateManifestDescription(manifest, spec) {
|
|
1386
|
+
var _a, _b;
|
|
1387
|
+
manifest.description = {
|
|
1388
|
+
short: spec.info.title.slice(0, ConstantString.ShortDescriptionMaxLens),
|
|
1389
|
+
full: (_b = ((_a = spec.info.description) !== null && _a !== void 0 ? _a : manifest.description.full)) === null || _b === void 0 ? void 0 : _b.slice(0, ConstantString.FullDescriptionMaxLens),
|
|
1390
|
+
};
|
|
1391
|
+
}
|
|
1392
|
+
static checkSchema(schema, method, pathUrl) {
|
|
1393
|
+
if (schema.type === "array") {
|
|
1394
|
+
const items = schema.items;
|
|
1395
|
+
ManifestUpdater.checkSchema(items, method, pathUrl);
|
|
1396
|
+
}
|
|
1397
|
+
else if (schema.type !== "string" &&
|
|
1398
|
+
schema.type !== "boolean" &&
|
|
1399
|
+
schema.type !== "integer" &&
|
|
1400
|
+
schema.type !== "number") {
|
|
1401
|
+
throw new SpecParserError(Utils.format(ConstantString.UnsupportedSchema, method, pathUrl, JSON.stringify(schema)), ErrorType.UpdateManifestFailed);
|
|
1402
|
+
}
|
|
1403
|
+
}
|
|
1404
|
+
static async generatePluginManifestSchema(spec, specRelativePath, apiPluginFilePath, appName, authInfo, options) {
|
|
1405
|
+
var _a, _b, _c, _d;
|
|
1406
|
+
const functions = [];
|
|
1407
|
+
const functionNames = [];
|
|
1408
|
+
const conversationStarters = [];
|
|
1409
|
+
const paths = spec.paths;
|
|
1410
|
+
const pluginAuthObj = {
|
|
1411
|
+
type: "None",
|
|
1412
|
+
};
|
|
1413
|
+
if (authInfo) {
|
|
1414
|
+
if (Utils.isOAuthWithAuthCodeFlow(authInfo.authScheme)) {
|
|
1415
|
+
pluginAuthObj.type = "OAuthPluginVault";
|
|
1416
|
+
}
|
|
1417
|
+
else if (Utils.isBearerTokenAuth(authInfo.authScheme)) {
|
|
1418
|
+
pluginAuthObj.type = "ApiKeyPluginVault";
|
|
1419
|
+
}
|
|
1420
|
+
if (pluginAuthObj.type !== "None") {
|
|
1421
|
+
const safeRegistrationIdName = Utils.getSafeRegistrationIdEnvName(`${authInfo.name}_${ConstantString.RegistrationIdPostfix[authInfo.authScheme.type]}`);
|
|
1422
|
+
pluginAuthObj.reference_id = `\${{${safeRegistrationIdName}}}`;
|
|
1423
|
+
}
|
|
1424
|
+
}
|
|
1425
|
+
for (const pathUrl in paths) {
|
|
1426
|
+
const pathItem = paths[pathUrl];
|
|
1427
|
+
if (pathItem) {
|
|
1428
|
+
const operations = pathItem;
|
|
1429
|
+
for (const method in operations) {
|
|
1430
|
+
if (options.allowMethods.includes(method)) {
|
|
1431
|
+
const operationItem = operations[method];
|
|
1432
|
+
const confirmationBodies = [];
|
|
1433
|
+
if (operationItem) {
|
|
1434
|
+
const operationId = operationItem.operationId;
|
|
1435
|
+
const description = (_a = operationItem.description) !== null && _a !== void 0 ? _a : "";
|
|
1436
|
+
const summary = operationItem.summary;
|
|
1437
|
+
const paramObject = operationItem.parameters;
|
|
1438
|
+
const requestBody = operationItem.requestBody;
|
|
1439
|
+
if (paramObject) {
|
|
1440
|
+
for (let i = 0; i < paramObject.length; i++) {
|
|
1441
|
+
const param = paramObject[i];
|
|
1442
|
+
const schema = param.schema;
|
|
1443
|
+
ManifestUpdater.checkSchema(schema, method, pathUrl);
|
|
1444
|
+
confirmationBodies.push(ManifestUpdater.getConfirmationBodyItem(param.name));
|
|
1445
|
+
}
|
|
1446
|
+
}
|
|
1447
|
+
if (requestBody) {
|
|
1448
|
+
const requestJsonBody = requestBody.content["application/json"];
|
|
1449
|
+
const requestBodySchema = requestJsonBody.schema;
|
|
1450
|
+
if (requestBodySchema.type === "object") {
|
|
1451
|
+
for (const property in requestBodySchema.properties) {
|
|
1452
|
+
const schema = requestBodySchema.properties[property];
|
|
1453
|
+
ManifestUpdater.checkSchema(schema, method, pathUrl);
|
|
1454
|
+
confirmationBodies.push(ManifestUpdater.getConfirmationBodyItem(property));
|
|
1455
|
+
}
|
|
1456
|
+
}
|
|
1457
|
+
else {
|
|
1458
|
+
throw new SpecParserError(Utils.format(ConstantString.UnsupportedSchema, method, pathUrl, JSON.stringify(requestBodySchema)), ErrorType.UpdateManifestFailed);
|
|
1459
|
+
}
|
|
1460
|
+
}
|
|
1461
|
+
const funcObj = {
|
|
1462
|
+
name: operationId,
|
|
1463
|
+
description: description,
|
|
1464
|
+
};
|
|
1465
|
+
if (options.allowResponseSemantics) {
|
|
1466
|
+
const { json } = Utils.getResponseJson(operationItem);
|
|
1467
|
+
if (json.schema) {
|
|
1468
|
+
const [card, jsonPath] = AdaptiveCardGenerator.generateAdaptiveCard(operationItem);
|
|
1469
|
+
const responseSemantic = wrapResponseSemantics(card, jsonPath);
|
|
1470
|
+
funcObj.capabilities = {
|
|
1471
|
+
response_semantics: responseSemantic,
|
|
1472
|
+
};
|
|
1473
|
+
}
|
|
1474
|
+
}
|
|
1475
|
+
if (options.allowConfirmation && method !== ConstantString.GetMethod) {
|
|
1476
|
+
if (!funcObj.capabilities) {
|
|
1477
|
+
funcObj.capabilities = {};
|
|
1478
|
+
}
|
|
1479
|
+
funcObj.capabilities.confirmation = {
|
|
1480
|
+
type: "AdaptiveCard",
|
|
1481
|
+
title: (_b = operationItem.summary) !== null && _b !== void 0 ? _b : description,
|
|
1482
|
+
};
|
|
1483
|
+
if (confirmationBodies.length > 0) {
|
|
1484
|
+
funcObj.capabilities.confirmation.body = confirmationBodies.join("\n");
|
|
1485
|
+
}
|
|
1486
|
+
}
|
|
1487
|
+
functions.push(funcObj);
|
|
1488
|
+
functionNames.push(operationId);
|
|
1489
|
+
const conversationStarterStr = (summary !== null && summary !== void 0 ? summary : description).slice(0, ConstantString.ConversationStarterMaxLens);
|
|
1490
|
+
if (conversationStarterStr) {
|
|
1491
|
+
conversationStarters.push(conversationStarterStr);
|
|
1492
|
+
}
|
|
1493
|
+
}
|
|
1494
|
+
}
|
|
1495
|
+
}
|
|
1496
|
+
}
|
|
1497
|
+
}
|
|
1498
|
+
let apiPlugin;
|
|
1499
|
+
if (await fs.pathExists(apiPluginFilePath)) {
|
|
1500
|
+
apiPlugin = await fs.readJSON(apiPluginFilePath);
|
|
1501
|
+
}
|
|
1502
|
+
else {
|
|
1503
|
+
apiPlugin = {
|
|
1504
|
+
schema_version: "v2.1",
|
|
1505
|
+
name_for_human: "",
|
|
1506
|
+
description_for_human: "",
|
|
1507
|
+
namespace: "",
|
|
1508
|
+
functions: [],
|
|
1509
|
+
runtimes: [],
|
|
1510
|
+
};
|
|
1511
|
+
}
|
|
1512
|
+
apiPlugin.functions = apiPlugin.functions || [];
|
|
1513
|
+
for (const func of functions) {
|
|
1514
|
+
const index = (_c = apiPlugin.functions) === null || _c === void 0 ? void 0 : _c.findIndex((f) => f.name === func.name);
|
|
1515
|
+
if (index === -1) {
|
|
1516
|
+
apiPlugin.functions.push(func);
|
|
1517
|
+
}
|
|
1518
|
+
else {
|
|
1519
|
+
apiPlugin.functions[index] = func;
|
|
1520
|
+
}
|
|
1521
|
+
}
|
|
1522
|
+
apiPlugin.runtimes = apiPlugin.runtimes || [];
|
|
1523
|
+
const index = apiPlugin.runtimes.findIndex((runtime) => {
|
|
1524
|
+
var _a, _b;
|
|
1525
|
+
return runtime.spec.url === specRelativePath &&
|
|
1526
|
+
runtime.type === "OpenApi" &&
|
|
1527
|
+
((_b = (_a = runtime.auth) === null || _a === void 0 ? void 0 : _a.type) !== null && _b !== void 0 ? _b : "None") === pluginAuthObj.type;
|
|
1528
|
+
});
|
|
1529
|
+
if (index === -1) {
|
|
1530
|
+
apiPlugin.runtimes.push({
|
|
1531
|
+
type: "OpenApi",
|
|
1532
|
+
auth: pluginAuthObj,
|
|
1533
|
+
spec: {
|
|
1534
|
+
url: specRelativePath,
|
|
1535
|
+
},
|
|
1536
|
+
run_for_functions: functionNames,
|
|
1537
|
+
});
|
|
1538
|
+
}
|
|
1539
|
+
else {
|
|
1540
|
+
apiPlugin.runtimes[index].run_for_functions = functionNames;
|
|
1541
|
+
}
|
|
1542
|
+
if (!apiPlugin.name_for_human) {
|
|
1543
|
+
apiPlugin.name_for_human = appName;
|
|
1544
|
+
}
|
|
1545
|
+
if (!apiPlugin.namespace) {
|
|
1546
|
+
apiPlugin.namespace = ManifestUpdater.removeAllSpecialCharacters(appName);
|
|
1547
|
+
}
|
|
1548
|
+
if (!apiPlugin.description_for_human) {
|
|
1549
|
+
apiPlugin.description_for_human =
|
|
1550
|
+
(_d = spec.info.description) !== null && _d !== void 0 ? _d : "<Please add description of the plugin>";
|
|
1551
|
+
}
|
|
1552
|
+
if (options.allowConversationStarters && conversationStarters.length > 0) {
|
|
1553
|
+
if (!apiPlugin.capabilities) {
|
|
1554
|
+
apiPlugin.capabilities = {
|
|
1555
|
+
localization: {},
|
|
1556
|
+
};
|
|
1557
|
+
}
|
|
1558
|
+
if (!apiPlugin.capabilities.conversation_starters) {
|
|
1559
|
+
apiPlugin.capabilities.conversation_starters = conversationStarters
|
|
1560
|
+
.slice(0, 5)
|
|
1561
|
+
.map((text) => ({ text }));
|
|
1562
|
+
}
|
|
1563
|
+
}
|
|
1564
|
+
return apiPlugin;
|
|
1565
|
+
}
|
|
1566
|
+
static async updateManifest(manifestPath, outputSpecPath, spec, options, adaptiveCardFolder, authInfo) {
|
|
1567
|
+
try {
|
|
1568
|
+
const originalManifest = await fs.readJSON(manifestPath);
|
|
1569
|
+
const updatedPart = {};
|
|
1570
|
+
updatedPart.composeExtensions = [];
|
|
1571
|
+
let warnings = [];
|
|
1572
|
+
if (options.projectType === ProjectType.SME) {
|
|
1573
|
+
const updateResult = await ManifestUpdater.generateCommands(spec, manifestPath, options, adaptiveCardFolder);
|
|
1574
|
+
const commands = updateResult[0];
|
|
1575
|
+
warnings = updateResult[1];
|
|
1576
|
+
const composeExtension = {
|
|
1577
|
+
composeExtensionType: "apiBased",
|
|
1578
|
+
apiSpecificationFile: ManifestUpdater.getRelativePath(manifestPath, outputSpecPath),
|
|
1579
|
+
commands: commands,
|
|
1580
|
+
};
|
|
1581
|
+
if (authInfo) {
|
|
1582
|
+
const auth = authInfo.authScheme;
|
|
1583
|
+
const safeRegistrationIdName = Utils.getSafeRegistrationIdEnvName(`${authInfo.name}_${ConstantString.RegistrationIdPostfix[authInfo.authScheme.type]}`);
|
|
1584
|
+
if (Utils.isAPIKeyAuth(auth) || Utils.isBearerTokenAuth(auth)) {
|
|
1585
|
+
const safeApiSecretRegistrationId = Utils.getSafeRegistrationIdEnvName(`${authInfo.name}_${ConstantString.RegistrationIdPostfix[authInfo.authScheme.type]}`);
|
|
1586
|
+
composeExtension.authorization = {
|
|
1587
|
+
authType: "apiSecretServiceAuth",
|
|
1588
|
+
apiSecretServiceAuthConfiguration: {
|
|
1589
|
+
apiSecretRegistrationId: `\${{${safeRegistrationIdName}}}`,
|
|
1590
|
+
},
|
|
1591
|
+
};
|
|
1592
|
+
}
|
|
1593
|
+
else if (Utils.isOAuthWithAuthCodeFlow(auth)) {
|
|
1594
|
+
composeExtension.authorization = {
|
|
1595
|
+
authType: "oAuth2.0",
|
|
1596
|
+
oAuthConfiguration: {
|
|
1597
|
+
oauthConfigurationId: `\${{${safeRegistrationIdName}}}`,
|
|
1598
|
+
},
|
|
1599
|
+
};
|
|
1600
|
+
updatedPart.webApplicationInfo = {
|
|
1601
|
+
id: "${{AAD_APP_CLIENT_ID}}",
|
|
1602
|
+
resource: "api://${{DOMAIN}}/${{AAD_APP_CLIENT_ID}}",
|
|
1603
|
+
};
|
|
1604
|
+
}
|
|
1605
|
+
}
|
|
1606
|
+
updatedPart.composeExtensions = [composeExtension];
|
|
1607
|
+
}
|
|
1608
|
+
updatedPart.description = originalManifest.description;
|
|
1609
|
+
ManifestUpdater.updateManifestDescription(updatedPart, spec);
|
|
1610
|
+
const updatedManifest = Object.assign(Object.assign({}, originalManifest), updatedPart);
|
|
1611
|
+
return [updatedManifest, warnings];
|
|
1612
|
+
}
|
|
1613
|
+
catch (err) {
|
|
1614
|
+
throw new SpecParserError(err.toString(), ErrorType.UpdateManifestFailed);
|
|
1615
|
+
}
|
|
1616
|
+
}
|
|
1617
|
+
static async generateCommands(spec, manifestPath, options, adaptiveCardFolder) {
|
|
1618
|
+
var _a;
|
|
1619
|
+
const paths = spec.paths;
|
|
1620
|
+
const commands = [];
|
|
1621
|
+
const warnings = [];
|
|
1622
|
+
if (paths) {
|
|
1623
|
+
for (const pathUrl in paths) {
|
|
1624
|
+
const pathItem = paths[pathUrl];
|
|
1625
|
+
if (pathItem) {
|
|
1626
|
+
const operations = pathItem;
|
|
1627
|
+
// Currently only support GET and POST method
|
|
1628
|
+
for (const method in operations) {
|
|
1629
|
+
if ((_a = options.allowMethods) === null || _a === void 0 ? void 0 : _a.includes(method)) {
|
|
1630
|
+
const operationItem = operations[method];
|
|
1631
|
+
if (operationItem) {
|
|
1632
|
+
const command = Utils.parseApiInfo(operationItem, options);
|
|
1633
|
+
if (command.parameters &&
|
|
1634
|
+
command.parameters.length >= 1 &&
|
|
1635
|
+
command.parameters.some((param) => param.isRequired)) {
|
|
1636
|
+
command.parameters = command.parameters.filter((param) => param.isRequired);
|
|
1637
|
+
}
|
|
1638
|
+
else if (command.parameters && command.parameters.length > 0) {
|
|
1639
|
+
command.parameters = [command.parameters[0]];
|
|
1640
|
+
warnings.push({
|
|
1641
|
+
type: WarningType.OperationOnlyContainsOptionalParam,
|
|
1642
|
+
content: Utils.format(ConstantString.OperationOnlyContainsOptionalParam, command.id),
|
|
1643
|
+
data: command.id,
|
|
1644
|
+
});
|
|
1645
|
+
}
|
|
1646
|
+
if (adaptiveCardFolder) {
|
|
1647
|
+
const adaptiveCardPath = path.join(adaptiveCardFolder, command.id + ".json");
|
|
1648
|
+
command.apiResponseRenderingTemplateFile = (await fs.pathExists(adaptiveCardPath))
|
|
1649
|
+
? ManifestUpdater.getRelativePath(manifestPath, adaptiveCardPath)
|
|
1650
|
+
: "";
|
|
1651
|
+
}
|
|
1652
|
+
commands.push(command);
|
|
1653
|
+
}
|
|
1654
|
+
}
|
|
1655
|
+
}
|
|
1656
|
+
}
|
|
1657
|
+
}
|
|
1658
|
+
}
|
|
1659
|
+
return [commands, warnings];
|
|
1660
|
+
}
|
|
1661
|
+
static getRelativePath(from, to) {
|
|
1662
|
+
const relativePath = path.relative(path.dirname(from), to);
|
|
1663
|
+
return path.normalize(relativePath).replace(/\\/g, "/");
|
|
1664
|
+
}
|
|
1665
|
+
static removeEnvs(str) {
|
|
1666
|
+
const placeHolderReg = /\${{\s*([a-zA-Z_][a-zA-Z0-9_]*)\s*}}/g;
|
|
1667
|
+
const matches = placeHolderReg.exec(str);
|
|
1668
|
+
let newStr = str;
|
|
1669
|
+
if (matches != null) {
|
|
1670
|
+
newStr = newStr.replace(matches[0], "");
|
|
1671
|
+
}
|
|
1672
|
+
return newStr;
|
|
1673
|
+
}
|
|
1674
|
+
static removeAllSpecialCharacters(str) {
|
|
1675
|
+
return str.toLowerCase().replace(/[^a-z0-9]/g, "");
|
|
1676
|
+
}
|
|
1677
|
+
static getConfirmationBodyItem(paramName) {
|
|
1678
|
+
return `* **${Utils.updateFirstLetter(paramName)}**: {{function.parameters.${paramName}}}`;
|
|
1679
|
+
}
|
|
1680
|
+
}
|
|
1681
|
+
|
|
1270
1682
|
// Copyright (c) Microsoft Corporation.
|
|
1271
1683
|
/**
|
|
1272
1684
|
* A class that parses an OpenAPI specification file and provides methods to validate, list, and generate artifacts.
|
|
@@ -1286,7 +1698,11 @@ class SpecParser {
|
|
|
1286
1698
|
allowMultipleParameters: false,
|
|
1287
1699
|
allowOauth2: false,
|
|
1288
1700
|
allowMethods: ["get", "post"],
|
|
1701
|
+
allowConversationStarters: false,
|
|
1702
|
+
allowResponseSemantics: false,
|
|
1703
|
+
allowConfirmation: false,
|
|
1289
1704
|
projectType: ProjectType.SME,
|
|
1705
|
+
isGptPlugin: false,
|
|
1290
1706
|
};
|
|
1291
1707
|
this.pathOrSpec = pathOrDoc;
|
|
1292
1708
|
this.parser = new SwaggerParser();
|
|
@@ -1310,6 +1726,8 @@ class SpecParser {
|
|
|
1310
1726
|
errors: [{ type: ErrorType.SpecNotValid, content: e.toString() }],
|
|
1311
1727
|
};
|
|
1312
1728
|
}
|
|
1729
|
+
const errors = [];
|
|
1730
|
+
const warnings = [];
|
|
1313
1731
|
if (!this.options.allowSwagger && this.isSwaggerFile) {
|
|
1314
1732
|
return {
|
|
1315
1733
|
status: ValidationStatus.Error,
|
|
@@ -1319,7 +1737,38 @@ class SpecParser {
|
|
|
1319
1737
|
],
|
|
1320
1738
|
};
|
|
1321
1739
|
}
|
|
1322
|
-
|
|
1740
|
+
// Remote reference not supported
|
|
1741
|
+
const refPaths = this.parser.$refs.paths();
|
|
1742
|
+
// refPaths [0] is the current spec file path
|
|
1743
|
+
if (refPaths.length > 1) {
|
|
1744
|
+
errors.push({
|
|
1745
|
+
type: ErrorType.RemoteRefNotSupported,
|
|
1746
|
+
content: Utils.format(ConstantString.RemoteRefNotSupported, refPaths.join(", ")),
|
|
1747
|
+
data: refPaths,
|
|
1748
|
+
});
|
|
1749
|
+
}
|
|
1750
|
+
if (!!this.isSwaggerFile && this.options.allowSwagger) {
|
|
1751
|
+
warnings.push({
|
|
1752
|
+
type: WarningType.ConvertSwaggerToOpenAPI,
|
|
1753
|
+
content: ConstantString.ConvertSwaggerToOpenAPI,
|
|
1754
|
+
});
|
|
1755
|
+
}
|
|
1756
|
+
const validator = this.getValidator(this.spec);
|
|
1757
|
+
const validationResult = validator.validateSpec();
|
|
1758
|
+
warnings.push(...validationResult.warnings);
|
|
1759
|
+
errors.push(...validationResult.errors);
|
|
1760
|
+
let status = ValidationStatus.Valid;
|
|
1761
|
+
if (warnings.length > 0 && errors.length === 0) {
|
|
1762
|
+
status = ValidationStatus.Warning;
|
|
1763
|
+
}
|
|
1764
|
+
else if (errors.length > 0) {
|
|
1765
|
+
status = ValidationStatus.Error;
|
|
1766
|
+
}
|
|
1767
|
+
return {
|
|
1768
|
+
status: status,
|
|
1769
|
+
warnings: warnings,
|
|
1770
|
+
errors: errors,
|
|
1771
|
+
};
|
|
1323
1772
|
}
|
|
1324
1773
|
catch (err) {
|
|
1325
1774
|
throw new SpecParserError(err.toString(), ErrorType.ValidateFailed);
|
|
@@ -1339,39 +1788,40 @@ class SpecParser {
|
|
|
1339
1788
|
try {
|
|
1340
1789
|
await this.loadSpec();
|
|
1341
1790
|
const spec = this.spec;
|
|
1342
|
-
const apiMap = this.
|
|
1343
|
-
const result =
|
|
1791
|
+
const apiMap = this.getAPIs(spec);
|
|
1792
|
+
const result = {
|
|
1793
|
+
APIs: [],
|
|
1794
|
+
allAPICount: 0,
|
|
1795
|
+
validAPICount: 0,
|
|
1796
|
+
};
|
|
1344
1797
|
for (const apiKey in apiMap) {
|
|
1798
|
+
const { operation, isValid, reason } = apiMap[apiKey];
|
|
1799
|
+
const [method, path] = apiKey.split(" ");
|
|
1800
|
+
const operationId = (_a = operation.operationId) !== null && _a !== void 0 ? _a : `${method.toLowerCase()}${Utils.convertPathToCamelCase(path)}`;
|
|
1345
1801
|
const apiResult = {
|
|
1346
|
-
api:
|
|
1802
|
+
api: apiKey,
|
|
1347
1803
|
server: "",
|
|
1348
|
-
operationId:
|
|
1804
|
+
operationId: operationId,
|
|
1805
|
+
isValid: isValid,
|
|
1806
|
+
reason: reason,
|
|
1349
1807
|
};
|
|
1350
|
-
|
|
1351
|
-
|
|
1352
|
-
|
|
1353
|
-
|
|
1354
|
-
|
|
1355
|
-
|
|
1356
|
-
|
|
1357
|
-
|
|
1358
|
-
|
|
1359
|
-
|
|
1360
|
-
|
|
1361
|
-
if (!operationId) {
|
|
1362
|
-
operationId = `${method.toLowerCase()}${Utils.convertPathToCamelCase(path)}`;
|
|
1363
|
-
}
|
|
1364
|
-
apiResult.operationId = operationId;
|
|
1365
|
-
const authArray = Utils.getAuthArray(operation.security, spec);
|
|
1366
|
-
for (const auths of authArray) {
|
|
1367
|
-
if (auths.length === 1) {
|
|
1368
|
-
apiResult.auth = auths[0].authScheme;
|
|
1369
|
-
break;
|
|
1808
|
+
if (isValid) {
|
|
1809
|
+
const serverObj = Utils.getServerObject(spec, method.toLocaleLowerCase(), path);
|
|
1810
|
+
if (serverObj) {
|
|
1811
|
+
apiResult.server = Utils.resolveEnv(serverObj.url);
|
|
1812
|
+
}
|
|
1813
|
+
const authArray = Utils.getAuthArray(operation.security, spec);
|
|
1814
|
+
for (const auths of authArray) {
|
|
1815
|
+
if (auths.length === 1) {
|
|
1816
|
+
apiResult.auth = auths[0];
|
|
1817
|
+
break;
|
|
1818
|
+
}
|
|
1370
1819
|
}
|
|
1371
1820
|
}
|
|
1372
|
-
apiResult
|
|
1373
|
-
result.push(apiResult);
|
|
1821
|
+
result.APIs.push(apiResult);
|
|
1374
1822
|
}
|
|
1823
|
+
result.allAPICount = result.APIs.length;
|
|
1824
|
+
result.validAPICount = result.APIs.filter((api) => api.isValid).length;
|
|
1375
1825
|
return result;
|
|
1376
1826
|
}
|
|
1377
1827
|
catch (err) {
|
|
@@ -1424,18 +1874,12 @@ class SpecParser {
|
|
|
1424
1874
|
const newSpecs = await this.getFilteredSpecs(filter, signal);
|
|
1425
1875
|
const newUnResolvedSpec = newSpecs[0];
|
|
1426
1876
|
const newSpec = newSpecs[1];
|
|
1427
|
-
|
|
1428
|
-
|
|
1429
|
-
resultStr = jsyaml.dump(newUnResolvedSpec);
|
|
1430
|
-
}
|
|
1431
|
-
else {
|
|
1432
|
-
resultStr = JSON.stringify(newUnResolvedSpec, null, 2);
|
|
1433
|
-
}
|
|
1434
|
-
await fs.outputFile(outputSpecPath, resultStr);
|
|
1877
|
+
const authInfo = Utils.getAuthInfo(newSpec);
|
|
1878
|
+
await this.saveFilterSpec(outputSpecPath, newUnResolvedSpec);
|
|
1435
1879
|
if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
|
|
1436
1880
|
throw new SpecParserError(ConstantString.CancelledMessage, ErrorType.Cancelled);
|
|
1437
1881
|
}
|
|
1438
|
-
const [updatedManifest, apiPlugin] = await ManifestUpdater.updateManifestWithAiPlugin(manifestPath, outputSpecPath, pluginFilePath, newSpec, this.options);
|
|
1882
|
+
const [updatedManifest, apiPlugin] = await ManifestUpdater.updateManifestWithAiPlugin(manifestPath, outputSpecPath, pluginFilePath, newSpec, this.options, authInfo);
|
|
1439
1883
|
await fs.outputJSON(manifestPath, updatedManifest, { spaces: 2 });
|
|
1440
1884
|
await fs.outputJSON(pluginFilePath, apiPlugin, { spaces: 2 });
|
|
1441
1885
|
}
|
|
@@ -1463,32 +1907,11 @@ class SpecParser {
|
|
|
1463
1907
|
const newSpecs = await this.getFilteredSpecs(filter, signal);
|
|
1464
1908
|
const newUnResolvedSpec = newSpecs[0];
|
|
1465
1909
|
const newSpec = newSpecs[1];
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
|
-
|
|
1469
|
-
for (const method in newSpec.paths[url]) {
|
|
1470
|
-
const operation = newSpec.paths[url][method];
|
|
1471
|
-
const authArray = Utils.getAuthArray(operation.security, newSpec);
|
|
1472
|
-
if (authArray && authArray.length > 0) {
|
|
1473
|
-
authSet.add(authArray[0][0]);
|
|
1474
|
-
if (authSet.size > 1) {
|
|
1475
|
-
hasMultipleAuth = true;
|
|
1476
|
-
break;
|
|
1477
|
-
}
|
|
1478
|
-
}
|
|
1479
|
-
}
|
|
1480
|
-
}
|
|
1481
|
-
if (hasMultipleAuth && this.options.projectType !== ProjectType.TeamsAi) {
|
|
1482
|
-
throw new SpecParserError(ConstantString.MultipleAuthNotSupported, ErrorType.MultipleAuthNotSupported);
|
|
1483
|
-
}
|
|
1484
|
-
let resultStr;
|
|
1485
|
-
if (outputSpecPath.endsWith(".yaml") || outputSpecPath.endsWith(".yml")) {
|
|
1486
|
-
resultStr = jsyaml.dump(newUnResolvedSpec);
|
|
1487
|
-
}
|
|
1488
|
-
else {
|
|
1489
|
-
resultStr = JSON.stringify(newUnResolvedSpec, null, 2);
|
|
1910
|
+
let authInfo = undefined;
|
|
1911
|
+
if (this.options.projectType === ProjectType.SME) {
|
|
1912
|
+
authInfo = Utils.getAuthInfo(newSpec);
|
|
1490
1913
|
}
|
|
1491
|
-
await
|
|
1914
|
+
await this.saveFilterSpec(outputSpecPath, newUnResolvedSpec);
|
|
1492
1915
|
if (adaptiveCardFolder) {
|
|
1493
1916
|
for (const url in newSpec.paths) {
|
|
1494
1917
|
for (const method in newSpec.paths[url]) {
|
|
@@ -1518,7 +1941,6 @@ class SpecParser {
|
|
|
1518
1941
|
if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
|
|
1519
1942
|
throw new SpecParserError(ConstantString.CancelledMessage, ErrorType.Cancelled);
|
|
1520
1943
|
}
|
|
1521
|
-
const authInfo = Array.from(authSet)[0];
|
|
1522
1944
|
const [updatedManifest, warnings] = await ManifestUpdater.updateManifest(manifestPath, outputSpecPath, newSpec, this.options, adaptiveCardFolder, authInfo);
|
|
1523
1945
|
await fs.outputJSON(manifestPath, updatedManifest, { spaces: 2 });
|
|
1524
1946
|
result.warnings.push(...warnings);
|
|
@@ -1544,13 +1966,28 @@ class SpecParser {
|
|
|
1544
1966
|
this.spec = (await this.parser.dereference(clonedUnResolveSpec));
|
|
1545
1967
|
}
|
|
1546
1968
|
}
|
|
1547
|
-
|
|
1548
|
-
|
|
1549
|
-
|
|
1969
|
+
getAPIs(spec) {
|
|
1970
|
+
const validator = this.getValidator(spec);
|
|
1971
|
+
const apiMap = validator.listAPIs();
|
|
1972
|
+
return apiMap;
|
|
1973
|
+
}
|
|
1974
|
+
getValidator(spec) {
|
|
1975
|
+
if (this.validator) {
|
|
1976
|
+
return this.validator;
|
|
1550
1977
|
}
|
|
1551
|
-
const
|
|
1552
|
-
this.
|
|
1553
|
-
return
|
|
1978
|
+
const validator = ValidatorFactory.create(spec, this.options);
|
|
1979
|
+
this.validator = validator;
|
|
1980
|
+
return validator;
|
|
1981
|
+
}
|
|
1982
|
+
async saveFilterSpec(outputSpecPath, unResolvedSpec) {
|
|
1983
|
+
let resultStr;
|
|
1984
|
+
if (outputSpecPath.endsWith(".yaml") || outputSpecPath.endsWith(".yml")) {
|
|
1985
|
+
resultStr = jsyaml.dump(unResolvedSpec);
|
|
1986
|
+
}
|
|
1987
|
+
else {
|
|
1988
|
+
resultStr = JSON.stringify(unResolvedSpec, null, 2);
|
|
1989
|
+
}
|
|
1990
|
+
await fs.outputFile(outputSpecPath, resultStr);
|
|
1554
1991
|
}
|
|
1555
1992
|
}
|
|
1556
1993
|
|