@microsoft/m365-spec-parser 0.2.2-rc.0 → 0.2.2

package/dist/index.esm2017.mjs

@@ -3,6 +3,7 @@ import converter from 'swagger2openapi';
 import jsyaml from 'js-yaml';
 import fs from 'fs-extra';
 import path from 'path';
+import { ManifestUtil } from '@microsoft/teams-manifest';
 import { createHash } from 'crypto';
 
 // Copyright (c) Microsoft Corporation.
@@ -193,19 +194,16 @@ class SpecParserError extends Error {
 // Copyright (c) Microsoft Corporation.
 class Utils {
     static hasNestedObjectInSchema(schema) {
-        if (this.isObjectSchema(schema)) {
+        if (schema.type === "object") {
             for (const property in schema.properties) {
                 const nestedSchema = schema.properties[property];
-                if (this.isObjectSchema(nestedSchema)) {
+                if (nestedSchema.type === "object") {
                     return true;
                 }
             }
         }
         return false;
     }
-    static isObjectSchema(schema) {
-        return schema.type === "object" || (!schema.type && !!schema.properties);
-    }
     static containMultipleMediaTypes(bodyObject) {
         return Object.keys((bodyObject === null || bodyObject === void 0 ? void 0 : bodyObject.content) || {}).length > 1;
     }
@@ -434,7 +432,7 @@ class Utils {
                 optionalParams.push(parameter);
             }
         }
-        else if (Utils.isObjectSchema(schema)) {
+        else if (schema.type === "object") {
             const { properties } = schema;
             for (const property in properties) {
                 let isRequired = false;
@@ -772,7 +770,7 @@ class Validator {
         }
         const isRequiredWithoutDefault = isRequired && schema.default === undefined;
         const isCopilot = this.projectType === ProjectType.Copilot;
-        if (isCopilot && Utils.hasNestedObjectInSchema(schema)) {
+        if (isCopilot && this.hasNestedObjectInSchema(schema)) {
             paramResult.isValid = false;
             paramResult.reason = [ErrorType.RequestBodyContainsNestedObject];
             return paramResult;
@@ -788,7 +786,7 @@ class Validator {
                 paramResult.optionalNum = paramResult.optionalNum + 1;
             }
         }
-        else if (Utils.isObjectSchema(schema)) {
+        else if (schema.type === "object") {
             const { properties } = schema;
             for (const property in properties) {
                 let isRequired = false;
@@ -824,7 +822,7 @@ class Validator {
         for (let i = 0; i < paramObject.length; i++) {
             const param = paramObject[i];
             const schema = param.schema;
-            if (isCopilot && Utils.hasNestedObjectInSchema(schema)) {
+            if (isCopilot && this.hasNestedObjectInSchema(schema)) {
                 paramResult.isValid = false;
                 paramResult.reason.push(ErrorType.ParamsContainsNestedObject);
                 continue;
@@ -867,6 +865,17 @@ class Validator {
         }
         return paramResult;
     }
+    hasNestedObjectInSchema(schema) {
+        if (schema.type === "object") {
+            for (const property in schema.properties) {
+                const nestedSchema = schema.properties[property];
+                if (nestedSchema.type === "object") {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
 }
 
 // Copyright (c) Microsoft Corporation.
@@ -925,7 +934,7 @@ class CopilotValidator extends Validator {
         const requestJsonBody = requestBody === null || requestBody === void 0 ? void 0 : requestBody.content["application/json"];
         if (requestJsonBody) {
             const requestBodySchema = requestJsonBody.schema;
-            if (!Utils.isObjectSchema(requestBodySchema)) {
+            if (requestBodySchema.type !== "object") {
                 result.reason.push(ErrorType.PostBodySchemaIsNotJson);
             }
             const requestBodyParamResult = this.checkPostBodySchema(requestBodySchema, requestBody.required);
@@ -1372,7 +1381,7 @@ class AdaptiveCardGenerator {
             return [template];
         }
         // some schema may not contain type but contain properties
-        if (Utils.isObjectSchema(schema)) {
+        if (schema.type === "object" || (!schema.type && schema.properties)) {
             const { properties } = schema;
             const result = [];
             for (const property in properties) {
@@ -1440,7 +1449,7 @@ class AdaptiveCardGenerator {
     }
     // Find the first array property in the response schema object with the well-known name
     static getResponseJsonPathFromSchema(schema) {
-        if (Utils.isObjectSchema(schema)) {
+        if (schema.type === "object" || (!schema.type && schema.properties)) {
             const { properties } = schema;
             for (const property in properties) {
                 const schema = properties[property];
@@ -1595,16 +1604,30 @@ class ManifestUpdater {
     static async updateManifestWithAiPlugin(manifestPath, outputSpecPath, apiPluginFilePath, spec, options, authInfo, existingPluginManifestInfo) {
         const manifest = await fs.readJSON(manifestPath);
         const apiPluginRelativePath = ManifestUpdater.getRelativePath(manifestPath, apiPluginFilePath);
-        manifest.copilotExtensions = manifest.copilotExtensions || {};
-        // Insert plugins in manifest.json if it is plugin for Copilot.
-        if (!options.isGptPlugin) {
-            manifest.copilotExtensions.plugins = [
-                {
-                    file: apiPluginRelativePath,
-                    id: ConstantString.DefaultPluginId,
-                },
-            ];
-            ManifestUpdater.updateManifestDescription(manifest, spec);
+        const useCopilotExtensionsInSchema = await ManifestUtil.useCopilotExtensionsInSchema(manifest);
+        if (manifest.copilotExtensions || useCopilotExtensionsInSchema) {
+            manifest.copilotExtensions = manifest.copilotExtensions || {};
+            if (!options.isGptPlugin) {
+                manifest.copilotExtensions.plugins = [
+                    {
+                        file: apiPluginRelativePath,
+                        id: ConstantString.DefaultPluginId,
+                    },
+                ];
+                ManifestUpdater.updateManifestDescription(manifest, spec);
+            }
+        }
+        else {
+            manifest.copilotAgents = manifest.copilotAgents || {};
+            if (!options.isGptPlugin) {
+                manifest.copilotAgents.plugins = [
+                    {
+                        file: apiPluginRelativePath,
+                        id: ConstantString.DefaultPluginId,
+                    },
+                ];
+                ManifestUpdater.updateManifestDescription(manifest, spec);
+            }
         }
         const appName = this.removeEnvs(manifest.name.short);
         const specRelativePath = ManifestUpdater.getRelativePath(manifestPath, outputSpecPath);
@@ -1678,7 +1701,7 @@ class ManifestUpdater {
                             if (requestBody) {
                                 const requestJsonBody = requestBody.content["application/json"];
                                 const requestBodySchema = requestJsonBody.schema;
-                                if (Utils.isObjectSchema(requestBodySchema)) {
+                                if (requestBodySchema.type === "object") {
                                     for (const property in requestBodySchema.properties) {
                                         const schema = requestBodySchema.properties[property];
                                         ManifestUpdater.checkSchema(schema, method, pathUrl);