@microsoft/m365-spec-parser 0.1.1-alpha.169a2b37a.0 → 0.1.1-alpha.2f5decfcc.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,7 @@ 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",
     ListFailed = "list-failed",
     listSupportedAPIInfoFailed = "list-supported-api-info-failed",
     FilterSpecFailed = "filter-spec-failed",
@@ -135,18 +136,6 @@ 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;
@@ -166,11 +155,15 @@ export interface ParseOptions {
      */
     allowAPIKeyAuth?: boolean;
     /**
-     * If true, the parser will allow multiple parameters in the spec file.
+     * 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.
+     * If true, the parser will allow OAuth2 authentication in the spec file. Currently only support OAuth2 with auth code flow.
      */
     allowOauth2?: boolean;
     /**
@@ -193,17 +186,22 @@ export interface APIInfo {
     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,12 +1,12 @@
 import { OpenAPIV3 } from "openapi-types";
-import { ParseOptions, WarningResult } from "./interfaces";
+import { AuthInfo, ParseOptions, WarningResult } from "./interfaces";
 import { IMessagingExtensionCommand, TeamsAppManifest, PluginManifestSchema, FunctionParameter } from "@microsoft/teams-manifest";
 export declare class ManifestUpdater {
     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, auth?: OpenAPIV3.SecuritySchemeObject): Promise<[TeamsAppManifest, WarningResult[]]>;
+    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/specParser.d.ts

@@ -31,7 +31,7 @@ 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.

package/dist/src/utils.d.ts

@@ -1,11 +1,12 @@
 import { OpenAPIV3 } from "openapi-types";
 import SwaggerParser from "@apidevtools/swagger-parser";
-import { AuthSchema, CheckParamResult, ErrorResult, Parameter, ParseOptions, 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 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.
@@ -21,20 +22,21 @@ export declare class Utils {
      * 6. only support request body with “application/json” content type
      */
     static isSupportedApi(method: string, path: string, spec: OpenAPIV3.Document, options: ParseOptions): boolean;
-    static isSupportedAuth(authSchemaArray: AuthSchema[][], options: ParseOptions): boolean;
-    static isAPIKeyAuth(authSchema: OpenAPIV3.SecuritySchemeObject): boolean;
-    static isBearerTokenAuth(authSchema: OpenAPIV3.SecuritySchemeObject): boolean;
-    static getAuthArray(securities: OpenAPIV3.SecurityRequirementObject[] | undefined, spec: OpenAPIV3.Document): AuthSchema[][];
+    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, 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 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;
@@ -42,4 +44,5 @@ export declare class Utils {
     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.169a2b37a.0",
+  "version": "0.1.1-alpha.2f5decfcc.0",
   "description": "OpenAPI specification files Parser for M365 Apps",
   "main": "dist/index.node.cjs.js",
   "browser": "dist/index.esm2017.js",
@@ -39,7 +39,7 @@
   "sideEffects": false,
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
-    "@microsoft/teams-manifest": "0.1.4-alpha.169a2b37a.0",
+    "@microsoft/teams-manifest": "0.1.4-alpha.2f5decfcc.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": "9e21a14cbb5f6def91abf56725a2ba0c60cec375"
+  "gitHead": "f45c01f9a70836de49671dc1e5a2ca6ac22eac8e"
 }