@microsoft/m365-spec-parser 0.1.1-alpha.cf377d39f.0 → 0.1.1-alpha.fc0606a28.0

package/dist/src/specParser.d.ts

@@ -37,6 +37,14 @@ export declare class SpecParser {
      * @param filter An array of strings that represent the filters to apply when generating the artifacts. If filter is empty, it would process nothing.
      */
     getFilteredSpecs(filter: string[], signal?: AbortSignal): Promise<[OpenAPIV3.Document, OpenAPIV3.Document]>;
+    /**
+     * Generates and update artifacts from the OpenAPI specification file. Generate Adaptive Cards, update Teams app manifest, and generate a new OpenAPI specification file.
+     * @param manifestPath A file path of the Teams app manifest file to update.
+     * @param filter An array of strings that represent the filters to apply when generating the artifacts. If filter is empty, it would process nothing.
+     * @param outputSpecPath File path of the new OpenAPI specification file to generate. If not specified or empty, no spec file will be generated.
+     * @param pluginFilePath File path of the api plugin file to generate.
+     */
+    generateForCopilot(manifestPath: string, filter: string[], outputSpecPath: string, pluginFilePath: string, signal?: AbortSignal): Promise<GenerateResult>;
     /**
      * Generates and update artifacts from the OpenAPI specification file. Generate Adaptive Cards, update Teams app manifest, and generate a new OpenAPI specification file.
      * @param manifestPath A file path of the Teams app manifest file to update.

package/dist/src/utils.d.ts

@@ -3,8 +3,9 @@ import SwaggerParser from "@apidevtools/swagger-parser";
 import { AuthSchema, CheckParamResult, ErrorResult, Parameter, ValidateResult, WarningResult } from "./interfaces";
 import { IMessagingExtensionCommand } from "@microsoft/teams-manifest";
 export declare class Utils {
-    static checkParameters(paramObject: OpenAPIV3.ParameterObject[]): CheckParamResult;
-    static checkPostBody(schema: OpenAPIV3.SchemaObject, isRequired?: boolean): CheckParamResult;
+    static hasNestedObjectInSchema(schema: OpenAPIV3.SchemaObject): boolean;
+    static checkParameters(paramObject: OpenAPIV3.ParameterObject[], isCopilot: boolean): CheckParamResult;
+    static checkPostBody(schema: OpenAPIV3.SchemaObject, isRequired?: boolean, isCopilot?: boolean): CheckParamResult;
     /**
      * Checks if the given API is supported.
      * @param {string} method - The HTTP method of the API.
@@ -19,7 +20,7 @@ export declare class Utils {
      * 5. response body should be “application/json” and not empty, and response code should be 20X
      * 6. only support request body with “application/json” content type
      */
-    static isSupportedApi(method: string, path: string, spec: OpenAPIV3.Document, allowMissingId: boolean, allowAPIKeyAuth: boolean, allowMultipleParameters: boolean, allowOauth2: boolean): boolean;
+    static isSupportedApi(method: string, path: string, spec: OpenAPIV3.Document, allowMissingId: boolean, allowAPIKeyAuth: boolean, allowMultipleParameters: boolean, allowOauth2: boolean, isCopilot: boolean): boolean;
     static isSupportedAuth(authSchemaArray: AuthSchema[][], allowAPIKeyAuth: boolean, allowOauth2: boolean): boolean;
     static isAPIKeyAuth(authSchema: OpenAPIV3.SecuritySchemeObject): boolean;
     static isBearerTokenAuth(authSchema: OpenAPIV3.SecuritySchemeObject): boolean;
@@ -30,15 +31,15 @@ export declare class Utils {
     static getUrlProtocol(urlString: string): string | undefined;
     static resolveServerUrl(url: string): string;
     static checkServerUrl(servers: OpenAPIV3.ServerObject[]): ErrorResult[];
-    static validateServer(spec: OpenAPIV3.Document, allowMissingId: boolean, allowAPIKeyAuth: boolean, allowMultipleParameters: boolean, allowOauth2: boolean): ErrorResult[];
+    static validateServer(spec: OpenAPIV3.Document, allowMissingId: boolean, allowAPIKeyAuth: boolean, allowMultipleParameters: boolean, allowOauth2: boolean, isCopilot: boolean): ErrorResult[];
     static isWellKnownName(name: string, wellknownNameList: string[]): boolean;
     static generateParametersFromSchema(schema: OpenAPIV3.SchemaObject, name: string, allowMultipleParameters: boolean, isRequired?: boolean): [Parameter[], Parameter[]];
     static updateParameterWithInputType(schema: OpenAPIV3.SchemaObject, param: Parameter): void;
     static parseApiInfo(operationItem: OpenAPIV3.OperationObject, allowMultipleParameters: boolean): [IMessagingExtensionCommand, WarningResult | undefined];
-    static listSupportedAPIs(spec: OpenAPIV3.Document, allowMissingId: boolean, allowAPIKeyAuth: boolean, allowMultipleParameters: boolean, allowOauth2: boolean): {
+    static listSupportedAPIs(spec: OpenAPIV3.Document, allowMissingId: boolean, allowAPIKeyAuth: boolean, allowMultipleParameters: boolean, allowOauth2: boolean, isCopilot: boolean): {
         [key: string]: OpenAPIV3.OperationObject;
     };
-    static validateSpec(spec: OpenAPIV3.Document, parser: SwaggerParser, isSwaggerFile: boolean, allowMissingId: boolean, allowAPIKeyAuth: boolean, allowMultipleParameters: boolean, allowOauth2: boolean): ValidateResult;
+    static validateSpec(spec: OpenAPIV3.Document, parser: SwaggerParser, isSwaggerFile: boolean, allowMissingId: boolean, allowAPIKeyAuth: boolean, allowMultipleParameters: boolean, allowOauth2: boolean, isCopilot: boolean): ValidateResult;
     static format(str: string, ...args: string[]): string;
     static getSafeRegistrationIdEnvName(authName: string): string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/m365-spec-parser",
-  "version": "0.1.1-alpha.cf377d39f.0",
+  "version": "0.1.1-alpha.fc0606a28.0",
   "description": "OpenAPI specification files Parser for M365 Apps",
   "main": "dist/index.node.cjs.js",
   "browser": "dist/index.esm2017.js",
@@ -9,7 +9,7 @@
   "types": "dist/src/index.d.ts",
   "scripts": {
     "build": "rollup -c",
-    "test:unit:node": "nyc --no-clean -- mocha \"test/*.test.ts\" -r config/mocha.env.ts --config config/.mocharc.json",
+    "test:unit:node": "nyc --no-clean -- mocha -r config/mocha.env.ts --config config/.mocharc.json",
     "test:unit:browser": "karma start karma.conf.cjs --single-run --unit",
     "test:unit": "npm run test:unit:node && npm run test:unit:browser ",
     "lint:staged": "lint-staged",
@@ -39,7 +39,7 @@
   "sideEffects": false,
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
-    "@microsoft/teams-manifest": "0.1.4-alpha.cf377d39f.0",
+    "@microsoft/teams-manifest": "0.1.4-alpha.fc0606a28.0",
     "fs-extra": "^11.2.0",
     "js-yaml": "^4.1.0",
     "openapi-types": "^7.2.3",
@@ -148,5 +148,5 @@
       "npx eslint --cache --fix --quiet"
     ]
   },
-  "gitHead": "2a9ae0132af43d3809f8e60350d5fce5da39a435"
+  "gitHead": "0156cf2d4a44da2393425ffb29049ef8a2d2f41f"
 }