@microsoft/m365-spec-parser 0.1.1-alpha.7fe3da414.0 → 0.1.1-alpha.87f45d762.0

package/dist/src/constants.d.ts

@@ -41,4 +41,5 @@ export declare class ConstantString {
     static readonly CommandTitleMaxLens = 32;
     static readonly ParameterTitleMaxLens = 32;
     static readonly SMERequiredParamsMaxNum = 5;
+    static readonly DefaultPluginId = "plugin_1";
 }

package/dist/src/index.d.ts

@@ -1,6 +1,6 @@
 export { SpecParser } from "./specParser";
 export { SpecParserError } from "./specParserError";
-export { ValidationStatus, WarningType, ErrorType, WarningResult, ErrorResult, ListAPIResult, APIInfo, ValidateResult, ParseOptions, AdaptiveCard, ProjectType, } from "./interfaces";
+export { ValidationStatus, WarningType, ErrorType, WarningResult, ErrorResult, ListAPIResult, APIInfo, ValidateResult, ParseOptions, AdaptiveCard, ProjectType, InvalidAPIInfo, } from "./interfaces";
 export { ConstantString } from "./constants";
 export { Utils } from "./utils";
 export { AdaptiveCardGenerator } from "./adaptiveCardGenerator";

package/dist/src/interfaces.d.ts

@@ -17,6 +17,16 @@ export interface ValidateResult {
      */
     errors: ErrorResult[];
 }
+export interface SpecValidationResult {
+    /**
+     * An array of warning results generated during validation.
+     */
+    warnings: WarningResult[];
+    /**
+     * An array of error results generated during validation.
+     */
+    errors: ErrorResult[];
+}
 /**
  * An interface that represents a warning result generated during validation.
  */
@@ -235,3 +245,7 @@ export interface AuthInfo {
     authScheme: OpenAPIV3.SecuritySchemeObject;
     name: string;
 }
+export interface InvalidAPIInfo {
+    api: string;
+    reason: ErrorType[];
+}

package/dist/src/manifestUpdater.d.ts

@@ -5,7 +5,7 @@ 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, appName: string, options: ParseOptions): PluginManifestSchema;
+    static generatePluginManifestSchema(spec: OpenAPIV3.Document, specRelativePath: string, apiPluginFilePath: string, appName: string, options: ParseOptions): Promise<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/specParser.browser.d.ts

@@ -10,6 +10,7 @@ export declare class SpecParser {
     readonly options: Required<ParseOptions>;
     private apiMap;
     private spec;
+    private validator;
     private unResolveSpec;
     private isSwaggerFile;
     private defaultOptions;
@@ -55,6 +56,6 @@ export declare class SpecParser {
      */
     generate(manifestPath: string, filter: string[], outputSpecPath: string, adaptiveCardFolder?: string, signal?: AbortSignal): Promise<GenerateResult>;
     private loadSpec;
-    private getAllSupportedAPIs;
-    private listSupportedAPIs;
+    private getAPIs;
+    private getValidator;
 }

package/dist/src/specParser.d.ts

@@ -9,6 +9,7 @@ export declare class SpecParser {
     readonly parser: SwaggerParser;
     readonly options: Required<ParseOptions>;
     private apiMap;
+    private validator;
     private spec;
     private unResolveSpec;
     private isSwaggerFile;
@@ -55,4 +56,5 @@ export declare class SpecParser {
     generate(manifestPath: string, filter: string[], outputSpecPath: string, adaptiveCardFolder?: string, signal?: AbortSignal): Promise<GenerateResult>;
     private loadSpec;
     private getAPIs;
+    private getValidator;
 }

package/dist/src/utils.d.ts

@@ -1,34 +1,15 @@
 import { OpenAPIV3 } from "openapi-types";
-import SwaggerParser from "@apidevtools/swagger-parser";
-import { APIMap, APIValidationResult, AuthInfo, CheckParamResult, ErrorResult, ParseOptions, ValidateResult, WarningResult } from "./interfaces";
+import { AuthInfo, ErrorResult, ParseOptions } 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.
-     * @param {string} path - The path of the API.
-     * @param {OpenAPIV3.Document} spec - The OpenAPI specification document.
-     * @returns {boolean} - Returns true if the API is supported, false otherwise.
-     * @description The following APIs are supported:
-     * 1. only support Get/Post operation without auth property
-     * 2. parameter inside query or path only support string, number, boolean and integer
-     * 3. parameter inside post body only support string, number, boolean, integer and object
-     * 4. request body + required parameters <= 1
-     * 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, options: ParseOptions): APIValidationResult;
-    static isSupportedAuth(authSchemeArray: AuthInfo[][], options: ParseOptions): APIValidationResult;
     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, isTeamsAiProject?: boolean): {
+    static getResponseJson(operationObject: OpenAPIV3.OperationObject | undefined): {
         json: OpenAPIV3.MediaTypeObject;
         multipleMediaType: boolean;
     };
@@ -40,10 +21,8 @@ export declare class Utils {
     static isWellKnownName(name: string, wellknownNameList: string[]): 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 listAPIs(spec: OpenAPIV3.Document, options: ParseOptions): APIMap;
-    static validateSpec(spec: OpenAPIV3.Document, parser: SwaggerParser, isSwaggerFile: boolean, options: ParseOptions): ValidateResult;
+    static parseApiInfo(operationItem: OpenAPIV3.OperationObject, options: ParseOptions): IMessagingExtensionCommand;
     static format(str: string, ...args: string[]): string;
     static getSafeRegistrationIdEnvName(authName: string): string;
-    static getAllAPICount(spec: OpenAPIV3.Document): number;
+    static getServerObject(spec: OpenAPIV3.Document, method: string, path: string): OpenAPIV3.ServerObject | undefined;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/m365-spec-parser",
-  "version": "0.1.1-alpha.7fe3da414.0",
+  "version": "0.1.1-alpha.87f45d762.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.7fe3da414.0",
+    "@microsoft/teams-manifest": "0.1.4-alpha.87f45d762.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": "f134f5933e9d3b3793bc9b5344ec97e16c63e324"
+  "gitHead": "b33ed9f3cebaa48a501c531cb269403d16b67f7e"
 }