@microsoft/m365-spec-parser 0.1.1-alpha.18377bc6e.0 → 0.1.1-alpha.194555abc.0

package/dist/index.esm2017.js

@@ -17,6 +17,7 @@ var ErrorType;
     ErrorType["SwaggerNotSupported"] = "swagger-not-supported";
     ErrorType["MultipleAuthNotSupported"] = "multiple-auth-not-supported";
     ErrorType["SpecVersionNotSupported"] = "spec-version-not-supported";
+    ErrorType["CircularReferenceNotSupported"] = "circular-reference-not-supported";
     ErrorType["ListFailed"] = "list-failed";
     ErrorType["listSupportedAPIInfoFailed"] = "list-supported-api-info-failed";
     ErrorType["FilterSpecFailed"] = "filter-spec-failed";
@@ -87,7 +88,7 @@ ConstantString.RemoteRefNotSupported = "Remote reference is not supported: %s.";
 ConstantString.MissingOperationId = "Missing operationIds: %s.";
 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.";
 ConstantString.AdditionalPropertiesNotSupported = "'additionalProperties' is not supported, and will be ignored.";
-ConstantString.SchemaNotSupported = "'oneOf', 'anyOf', and 'not' schema are not supported: %s.";
+ConstantString.SchemaNotSupported = "'oneOf', 'allOf', 'anyOf', and 'not' schema are not supported: %s.";
 ConstantString.UnknownSchema = "Unknown schema: %s.";
 ConstantString.UrlProtocolNotSupported = "Server url is not correct: protocol %s is not supported, you should use https protocol instead.";
 ConstantString.RelativeServerUrlNotSupported = "Server url is not correct: relative server url is not supported.";
@@ -107,9 +108,14 @@ ConstantString.AdaptiveCardVersion = "1.5";
 ConstantString.AdaptiveCardSchema = "http://adaptivecards.io/schemas/adaptive-card.json";
 ConstantString.AdaptiveCardType = "AdaptiveCard";
 ConstantString.TextBlockType = "TextBlock";
+ConstantString.ImageType = "Image";
 ConstantString.ContainerType = "Container";
-ConstantString.RegistrationIdPostfix = "REGISTRATION_ID";
-ConstantString.OAuthRegistrationIdPostFix = "OAUTH_REGISTRATION_ID";
+ConstantString.RegistrationIdPostfix = {
+    apiKey: "REGISTRATION_ID",
+    oauth2: "CONFIGURATION_ID",
+    http: "REGISTRATION_ID",
+    openIdConnect: "REGISTRATION_ID",
+};
 ConstantString.ResponseCodeFor20X = [
     "200",
     "201",
@@ -168,9 +174,11 @@ ConstantString.ShortDescriptionMaxLens = 80;
 ConstantString.FullDescriptionMaxLens = 4000;
 ConstantString.CommandDescriptionMaxLens = 128;
 ConstantString.ParameterDescriptionMaxLens = 128;
+ConstantString.ConversationStarterMaxLens = 50;
 ConstantString.CommandTitleMaxLens = 32;
 ConstantString.ParameterTitleMaxLens = 32;
-ConstantString.SMERequiredParamsMaxNum = 5;
+ConstantString.SMERequiredParamsMaxNum = 5;
+ConstantString.DefaultPluginId = "plugin_1";
 
 // Copyright (c) Microsoft Corporation.
 class Utils {
@@ -203,9 +211,10 @@ class Utils {
         var _a;
         const result = [];
         const securitySchemas = (_a = spec.components) === null || _a === void 0 ? void 0 : _a.securitySchemes;
-        if (securities && securitySchemas) {
-            for (let i = 0; i < securities.length; i++) {
-                const security = securities[i];
+        const securitiesArr = securities !== null && securities !== void 0 ? securities : spec.security;
+        if (securitiesArr && securitySchemas) {
+            for (let i = 0; i < securitiesArr.length; i++) {
+                const security = securitiesArr[i];
                 const authArray = [];
                 for (const name in security) {
                     const auth = securitySchemas[name];
@@ -222,6 +231,25 @@ class Utils {
         result.sort((a, b) => a[0].name.localeCompare(b[0].name));
         return result;
     }
+    static getAuthInfo(spec) {
+        let authInfo = undefined;
+        for (const url in spec.paths) {
+            for (const method in spec.paths[url]) {
+                const operation = spec.paths[url][method];
+                const authArray = Utils.getAuthArray(operation.security, spec);
+                if (authArray && authArray.length > 0) {
+                    const currentAuth = authArray[0][0];
+                    if (!authInfo) {
+                        authInfo = authArray[0][0];
+                    }
+                    else if (authInfo.name !== currentAuth.name) {
+                        throw new SpecParserError(ConstantString.MultipleAuthNotSupported, ErrorType.MultipleAuthNotSupported);
+                    }
+                }
+            }
+        }
+        return authInfo;
+    }
     static updateFirstLetter(str) {
         return str.charAt(0).toUpperCase() + str.slice(1);
     }
@@ -504,6 +532,19 @@ class Utils {
 
 // Copyright (c) Microsoft Corporation.
 class Validator {
+    constructor() {
+        this.hasCircularReference = false;
+    }
+    checkCircularReference() {
+        try {
+            JSON.stringify(this.spec);
+        }
+        catch (e) {
+            if (e.message.includes("Converting circular structure to JSON")) {
+                this.hasCircularReference = true;
+            }
+        }
+    }
     listAPIs() {
         var _a;
         if (this.apiMap) {
@@ -550,9 +591,16 @@ class Validator {
         const apiMap = this.listAPIs();
         const validAPIs = Object.entries(apiMap).filter(([, value]) => value.isValid);
         if (validAPIs.length === 0) {
+            const data = [];
+            for (const key in apiMap) {
+                const { reason } = apiMap[key];
+                const apiInvalidReason = { api: key, reason: reason };
+                data.push(apiInvalidReason);
+            }
             result.errors.push({
                 type: ErrorType.NoSupportedApi,
                 content: ConstantString.NoSupportedApi,
+                data,
             });
         }
         return result;
@@ -592,17 +640,35 @@ class Validator {
         }
         return result;
     }
+    validateCircularReference(method, path) {
+        const result = { isValid: true, reason: [] };
+        if (this.hasCircularReference) {
+            const operationObject = this.spec.paths[path][method];
+            try {
+                JSON.stringify(operationObject);
+            }
+            catch (e) {
+                if (e.message.includes("Converting circular structure to JSON")) {
+                    result.isValid = false;
+                    result.reason.push(ErrorType.CircularReferenceNotSupported);
+                }
+            }
+        }
+        return result;
+    }
     validateResponse(method, path) {
         const result = { isValid: true, reason: [] };
         const operationObject = this.spec.paths[path][method];
         const { json, multipleMediaType } = Utils.getResponseJson(operationObject);
-        // only support response body only contains “application/json” content type
-        if (multipleMediaType) {
-            result.reason.push(ErrorType.ResponseContainMultipleMediaTypes);
-        }
-        else if (Object.keys(json).length === 0) {
-            // response body should not be empty
-            result.reason.push(ErrorType.ResponseJsonIsEmpty);
+        if (this.options.projectType === ProjectType.SME) {
+            // only support response body only contains “application/json” content type
+            if (multipleMediaType) {
+                result.reason.push(ErrorType.ResponseContainMultipleMediaTypes);
+            }
+            else if (Object.keys(json).length === 0) {
+                // response body should not be empty
+                result.reason.push(ErrorType.ResponseJsonIsEmpty);
+            }
         }
         return result;
     }
@@ -778,6 +844,7 @@ class CopilotValidator extends Validator {
         this.projectType = ProjectType.Copilot;
         this.options = options;
         this.spec = spec;
+        this.checkCircularReference();
     }
     validateSpec() {
         const result = { errors: [], warnings: [] };
@@ -803,6 +870,10 @@ class CopilotValidator extends Validator {
         if (!methodAndPathResult.isValid) {
             return methodAndPathResult;
         }
+        const circularReferenceResult = this.validateCircularReference(method, path);
+        if (!circularReferenceResult.isValid) {
+            return circularReferenceResult;
+        }
         const operationObject = this.spec.paths[path][method];
         // validate auth
         const authCheckResult = this.validateAuth(method, path);
@@ -820,9 +891,6 @@ class CopilotValidator extends Validator {
         // validate requestBody
         const requestBody = operationObject.requestBody;
         const requestJsonBody = requestBody === null || requestBody === void 0 ? void 0 : requestBody.content["application/json"];
-        if (Utils.containMultipleMediaTypes(requestBody)) {
-            result.reason.push(ErrorType.PostBodyContainMultipleMediaTypes);
-        }
         if (requestJsonBody) {
             const requestBodySchema = requestJsonBody.schema;
             if (requestBodySchema.type !== "object") {
@@ -849,6 +917,7 @@ class SMEValidator extends Validator {
         this.projectType = ProjectType.SME;
         this.options = options;
         this.spec = spec;
+        this.checkCircularReference();
     }
     validateSpec() {
         const result = { errors: [], warnings: [] };
@@ -862,8 +931,10 @@ class SMEValidator extends Validator {
         validationResult = this.validateSpecNoSupportAPI();
         result.errors.push(...validationResult.errors);
         // validate operationId missing
-        validationResult = this.validateSpecOperationId();
-        result.warnings.push(...validationResult.warnings);
+        if (this.options.allowMissingId) {
+            validationResult = this.validateSpecOperationId();
+            result.warnings.push(...validationResult.warnings);
+        }
         return result;
     }
     validateAPI(method, path) {
@@ -874,6 +945,10 @@ class SMEValidator extends Validator {
         if (!methodAndPathResult.isValid) {
             return methodAndPathResult;
         }
+        const circularReferenceResult = this.validateCircularReference(method, path);
+        if (!circularReferenceResult.isValid) {
+            return circularReferenceResult;
+        }
         const operationObject = this.spec.paths[path][method];
         // validate auth
         const authCheckResult = this.validateAuth(method, path);
@@ -944,6 +1019,7 @@ class TeamsAIValidator extends Validator {
         this.projectType = ProjectType.TeamsAi;
         this.options = options;
         this.spec = spec;
+        this.checkCircularReference();
     }
     validateSpec() {
         const result = { errors: [], warnings: [] };
@@ -963,6 +1039,10 @@ class TeamsAIValidator extends Validator {
         if (!methodAndPathResult.isValid) {
             return methodAndPathResult;
         }
+        const circularReferenceResult = this.validateCircularReference(method, path);
+        if (!circularReferenceResult.isValid) {
+            return circularReferenceResult;
+        }
         const operationObject = this.spec.paths[path][method];
         // validate operationId
         if (!this.options.allowMissingId && !operationObject.operationId) {
@@ -1014,7 +1094,11 @@ class SpecParser {
             allowBearerTokenAuth: false,
             allowOauth2: false,
             allowMethods: ["get", "post"],
+            allowConversationStarters: false,
+            allowResponseSemantics: false,
+            allowConfirmation: false,
             projectType: ProjectType.SME,
+            isGptPlugin: false,
         };
         this.pathOrSpec = pathOrDoc;
         this.parser = new SwaggerParser();
@@ -1029,7 +1113,11 @@ class SpecParser {
         try {
             try {
                 await this.loadSpec();
-                await this.parser.validate(this.spec);
+                await this.parser.validate(this.spec, {
+                    validate: {
+                        schema: false,
+                    },
+                });
             }
             catch (e) {
                 return {
@@ -1167,12 +1255,8 @@ class SpecParser {
         }
     }
     getAPIs(spec) {
-        if (this.apiMap !== undefined) {
-            return this.apiMap;
-        }
         const validator = this.getValidator(spec);
         const apiMap = validator.listAPIs();
-        this.apiMap = apiMap;
         return apiMap;
     }
     getValidator(spec) {