@microsoft/m365-spec-parser 0.1.1-alpha.78701ec6a.0 → 0.1.1-alpha.a277dba4e.0

package/dist/src/interfaces.d.ts

@@ -1,3 +1,4 @@
+import { IParameter } from "@microsoft/teams-manifest";
 import { OpenAPIV3 } from "openapi-types";
 /**
  * An interface that represents the result of validating an OpenAPI specification file.
@@ -67,7 +68,8 @@ export declare enum ErrorType {
     NoExtraAPICanBeAdded = "no-extra-api-can-be-added",
     ResolveServerUrlFailed = "resolve-server-url-failed",
     SwaggerNotSupported = "swagger-not-supported",
-    MultipleAPIKeyNotSupported = "multiple-api-key-not-supported",
+    MultipleAuthNotSupported = "multiple-auth-not-supported",
+    SpecVersionNotSupported = "spec-version-not-supported",
     ListFailed = "list-failed",
     listSupportedAPIInfoFailed = "list-supported-api-info-failed",
     FilterSpecFailed = "filter-spec-failed",
@@ -75,6 +77,7 @@ export declare enum ErrorType {
     GenerateAdaptiveCardFailed = "generate-adaptive-card-failed",
     GenerateFailed = "generate-failed",
     ValidateFailed = "validate-failed",
+    GetSpecFailed = "get-spec-failed",
     Cancelled = "cancelled",
     Unknown = "unknown"
 }
@@ -134,46 +137,72 @@ export interface WrappedAdaptiveCard {
     responseCardTemplate: AdaptiveCard;
     previewCardTemplate: PreviewCardTemplate;
 }
-export interface ChoicesItem {
-    title: string;
-    value: string;
-}
-export interface Parameter {
-    name: string;
-    title: string;
-    description: string;
-    inputType?: "text" | "textarea" | "number" | "date" | "time" | "toggle" | "choiceset";
-    value?: string;
-    choices?: ChoicesItem[];
-}
 export interface CheckParamResult {
     requiredNum: number;
     optionalNum: number;
     isValid: boolean;
 }
 export interface ParseOptions {
+    /**
+     * If true, the parser will not throw an error if an ID is missing the spec file.
+     */
     allowMissingId?: boolean;
+    /**
+     * If true, the parser will allow parsing of Swagger specifications.
+     */
     allowSwagger?: boolean;
+    /**
+     * If true, the parser will allow API Key authentication in the spec file.
+     */
     allowAPIKeyAuth?: boolean;
+    /**
+     * If true, the parser will allow Bearer Token authentication in the spec file.
+     */
+    allowBearerTokenAuth?: boolean;
+    /**
+     * If true, the parser will allow multiple parameters in the spec file. Teams AI project would ignore this parameters and always true
+     */
     allowMultipleParameters?: boolean;
+    /**
+     * If true, the parser will allow OAuth2 authentication in the spec file. Currently only support OAuth2 with auth code flow.
+     */
     allowOauth2?: boolean;
+    /**
+     * An array of HTTP methods that the parser will allow in the spec file.
+     */
+    allowMethods?: string[];
+    /**
+     * The type of project that the parser is being used for.
+     * Project can be SME/Copilot/TeamsAi
+     */
+    projectType?: ProjectType;
+}
+export declare enum ProjectType {
+    Copilot = 0,
+    SME = 1,
+    TeamsAi = 2
 }
 export interface APIInfo {
     method: string;
     path: string;
     title: string;
     id: string;
-    parameters: Parameter[];
+    parameters: IParameter[];
     description: string;
     warning?: WarningResult;
 }
-export interface ListAPIResult {
+export interface ListAPIInfo {
     api: string;
     server: string;
     operationId: string;
-    auth?: OpenAPIV3.SecuritySchemeObject;
+    auth?: AuthInfo;
+}
+export interface ListAPIResult {
+    allAPICount: number;
+    validAPICount: number;
+    validAPIs: ListAPIInfo[];
 }
-export interface AuthSchema {
-    authSchema: OpenAPIV3.SecuritySchemeObject;
+export interface AuthInfo {
+    authScheme: OpenAPIV3.SecuritySchemeObject;
     name: string;
 }

package/dist/src/manifestUpdater.d.ts

@@ -1,8 +1,12 @@
 import { OpenAPIV3 } from "openapi-types";
-import { WarningResult } from "./interfaces";
-import { IMessagingExtensionCommand, TeamsAppManifest } from "@microsoft/teams-manifest";
+import { AuthInfo, ParseOptions, WarningResult } from "./interfaces";
+import { IMessagingExtensionCommand, TeamsAppManifest, PluginManifestSchema, FunctionParameter } from "@microsoft/teams-manifest";
 export declare class ManifestUpdater {
-    static updateManifest(manifestPath: string, outputSpecPath: string, adaptiveCardFolder: string, spec: OpenAPIV3.Document, allowMultipleParameters: boolean, auth?: OpenAPIV3.SecuritySchemeObject): Promise<[TeamsAppManifest, WarningResult[]]>;
-    static generateCommands(spec: OpenAPIV3.Document, adaptiveCardFolder: string, manifestPath: string, allowMultipleParameters: boolean): Promise<[IMessagingExtensionCommand[], WarningResult[]]>;
+    static updateManifestWithAiPlugin(manifestPath: string, outputSpecPath: string, apiPluginFilePath: string, spec: OpenAPIV3.Document, options: ParseOptions): Promise<[TeamsAppManifest, PluginManifestSchema]>;
+    static updateManifestDescription(manifest: TeamsAppManifest, spec: OpenAPIV3.Document): void;
+    static mapOpenAPISchemaToFuncParam(schema: OpenAPIV3.SchemaObject, method: string, pathUrl: string): FunctionParameter;
+    static generatePluginManifestSchema(spec: OpenAPIV3.Document, specRelativePath: string, options: ParseOptions): PluginManifestSchema;
+    static updateManifest(manifestPath: string, outputSpecPath: string, spec: OpenAPIV3.Document, options: ParseOptions, adaptiveCardFolder?: string, authInfo?: AuthInfo): Promise<[TeamsAppManifest, WarningResult[]]>;
+    static generateCommands(spec: OpenAPIV3.Document, manifestPath: string, options: ParseOptions, adaptiveCardFolder?: string): Promise<[IMessagingExtensionCommand[], WarningResult[]]>;
     static getRelativePath(from: string, to: string): string;
 }

package/dist/src/specFilter.d.ts

@@ -1,4 +1,5 @@
 import { OpenAPIV3 } from "openapi-types";
+import { ParseOptions } from "./interfaces";
 export declare class SpecFilter {
-    static specFilter(filter: string[], unResolveSpec: OpenAPIV3.Document, resolvedSpec: OpenAPIV3.Document, allowMissingId: boolean, allowAPIKeyAuth: boolean, allowMultipleParameters: boolean, allowOauth2: boolean): OpenAPIV3.Document;
+    static specFilter(filter: string[], unResolveSpec: OpenAPIV3.Document, resolvedSpec: OpenAPIV3.Document, options: ParseOptions): OpenAPIV3.Document;
 }

package/dist/src/specParser.browser.d.ts

@@ -32,14 +32,28 @@ export declare class SpecParser {
      * according to copilot plugin spec, only list get and post method without auth
      */
     list(): Promise<ListAPIResult[]>;
+    /**
+     * Generate specs according to the filters.
+     * @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.
      * @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 adaptiveCardFolder Folder path where the Adaptive Card files will be generated. If not specified or empty, Adaptive Card files will not be generated.
+     * @param isMe Boolean that indicates whether the project is an Messaging Extension. For Messaging Extension, composeExtensions will be added in Teams app manifest.
      */
-    generate(manifestPath: string, filter: string[], outputSpecPath: string, adaptiveCardFolder: string, signal?: AbortSignal): Promise<GenerateResult>;
+    generate(manifestPath: string, filter: string[], outputSpecPath: string, adaptiveCardFolder?: string, signal?: AbortSignal): Promise<GenerateResult>;
     private loadSpec;
     private getAllSupportedAPIs;
 }

package/dist/src/specParser.d.ts

@@ -31,7 +31,20 @@ export declare class SpecParser {
      * @returns A string array that represents the HTTP method and path of each operation, such as ['GET /pets/{petId}', 'GET /user/{userId}']
      * according to copilot plugin spec, only list get and post method without auth
      */
-    list(): Promise<ListAPIResult[]>;
+    list(): Promise<ListAPIResult>;
+    /**
+     * Generate specs according to the filters.
+     * @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.
@@ -39,7 +52,7 @@ export declare class SpecParser {
      * @param outputSpecPath File path of the new OpenAPI specification file to generate. If not specified or empty, no spec file will be generated.
      * @param adaptiveCardFolder Folder path where the Adaptive Card files will be generated. If not specified or empty, Adaptive Card files will not be generated.
      */
-    generate(manifestPath: string, filter: string[], outputSpecPath: string, adaptiveCardFolder: string, signal?: AbortSignal): Promise<GenerateResult>;
+    generate(manifestPath: string, filter: string[], outputSpecPath: string, adaptiveCardFolder?: string, signal?: AbortSignal): Promise<GenerateResult>;
     private loadSpec;
     private getAllSupportedAPIs;
 }

package/dist/src/utils.d.ts

@@ -1,10 +1,12 @@
 import { OpenAPIV3 } from "openapi-types";
 import SwaggerParser from "@apidevtools/swagger-parser";
-import { AuthSchema, CheckParamResult, ErrorResult, Parameter, ValidateResult, WarningResult } from "./interfaces";
-import { IMessagingExtensionCommand } from "@microsoft/teams-manifest";
+import { AuthInfo, CheckParamResult, ErrorResult, ParseOptions, ValidateResult, WarningResult } from "./interfaces";
+import { IMessagingExtensionCommand, IParameter } 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;
+    static containMultipleMediaTypes(bodyObject: OpenAPIV3.RequestBodyObject | OpenAPIV3.ResponseObject): boolean;
     /**
      * Checks if the given API is supported.
      * @param {string} method - The HTTP method of the API.
@@ -19,26 +21,28 @@ 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 isSupportedAuth(authSchemaArray: AuthSchema[][], allowAPIKeyAuth: boolean, allowOauth2: boolean): boolean;
-    static isAPIKeyAuth(authSchema: OpenAPIV3.SecuritySchemeObject): boolean;
-    static isBearerTokenAuth(authSchema: OpenAPIV3.SecuritySchemeObject): boolean;
-    static getAuthArray(securities: OpenAPIV3.SecurityRequirementObject[] | undefined, spec: OpenAPIV3.Document): AuthSchema[][];
+    static isSupportedApi(method: string, path: string, spec: OpenAPIV3.Document, options: ParseOptions): boolean;
+    static isSupportedAuth(authSchemeArray: AuthInfo[][], options: ParseOptions): boolean;
+    static isBearerTokenAuth(authScheme: OpenAPIV3.SecuritySchemeObject): boolean;
+    static isAPIKeyAuth(authScheme: OpenAPIV3.SecuritySchemeObject): boolean;
+    static isOAuthWithAuthCodeFlow(authScheme: OpenAPIV3.SecuritySchemeObject): boolean;
+    static getAuthArray(securities: OpenAPIV3.SecurityRequirementObject[] | undefined, spec: OpenAPIV3.Document): AuthInfo[][];
     static updateFirstLetter(str: string): string;
-    static getResponseJson(operationObject: OpenAPIV3.OperationObject | undefined): OpenAPIV3.MediaTypeObject;
+    static getResponseJson(operationObject: OpenAPIV3.OperationObject | undefined, isTeamsAiProject?: boolean): OpenAPIV3.MediaTypeObject;
     static convertPathToCamelCase(path: string): string;
     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, options: ParseOptions): 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 generateParametersFromSchema(schema: OpenAPIV3.SchemaObject, name: string, allowMultipleParameters: boolean, isRequired?: boolean): [IParameter[], IParameter[]];
+    static updateParameterWithInputType(schema: OpenAPIV3.SchemaObject, param: IParameter): void;
+    static parseApiInfo(operationItem: OpenAPIV3.OperationObject, options: ParseOptions): [IMessagingExtensionCommand, WarningResult | undefined];
+    static listSupportedAPIs(spec: OpenAPIV3.Document, options: ParseOptions): {
         [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, options: ParseOptions): ValidateResult;
     static format(str: string, ...args: string[]): string;
     static getSafeRegistrationIdEnvName(authName: string): string;
+    static getAllAPICount(spec: OpenAPIV3.Document): number;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/m365-spec-parser",
-  "version": "0.1.1-alpha.78701ec6a.0",
+  "version": "0.1.1-alpha.a277dba4e.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.78701ec6a.0",
+    "@microsoft/teams-manifest": "0.1.4-alpha.a277dba4e.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": "98b6606ad0870ecd16aafcdb74b20f71ec6d49ec"
+  "gitHead": "fc43da6bdf04948555fc8c425324b475cc05bb95"
 }