@microsoft/m365-spec-parser 0.1.1-alpha.2f5decfcc.0 → 0.1.1-alpha.42af26ca6.0

package/dist/src/constants.d.ts

@@ -13,6 +13,7 @@ export declare class ConstantString {
     static readonly OperationOnlyContainsOptionalParam = "Operation %s contains multiple optional parameters. The first optional parameter is used for this command.";
     static readonly ConvertSwaggerToOpenAPI = "The Swagger 2.0 file has been converted to OpenAPI 3.0.";
     static readonly SwaggerNotSupported = "Swagger 2.0 is not supported. Please convert to OpenAPI 3.0 manually before proceeding.";
+    static readonly SpecVersionNotSupported = "Unsupported OpenAPI version %s. Please use version 3.0.x.";
     static readonly MultipleAuthNotSupported = "Multiple authentication methods are unsupported. Ensure all selected APIs use identical authentication.";
     static readonly UnsupportedSchema = "Unsupported schema in %s %s: %s";
     static readonly WrappedCardVersion = "devPreview";

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.
  */
@@ -69,6 +79,7 @@ export declare enum ErrorType {
     ResolveServerUrlFailed = "resolve-server-url-failed",
     SwaggerNotSupported = "swagger-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",
@@ -77,6 +88,21 @@ export declare enum ErrorType {
     GenerateFailed = "generate-failed",
     ValidateFailed = "validate-failed",
     GetSpecFailed = "get-spec-failed",
+    AuthTypeIsNotSupported = "auth-type-is-not-supported",
+    MissingOperationId = "missing-operation-id",
+    PostBodyContainMultipleMediaTypes = "post-body-contain-multiple-media-types",
+    ResponseContainMultipleMediaTypes = "response-contain-multiple-media-types",
+    ResponseJsonIsEmpty = "response-json-is-empty",
+    PostBodySchemaIsNotJson = "post-body-schema-is-not-json",
+    PostBodyContainsRequiredUnsupportedSchema = "post-body-contains-required-unsupported-schema",
+    ParamsContainRequiredUnsupportedSchema = "params-contain-required-unsupported-schema",
+    ParamsContainsNestedObject = "params-contains-nested-object",
+    RequestBodyContainsNestedObject = "request-body-contains-nested-object",
+    ExceededRequiredParamsLimit = "exceeded-required-params-limit",
+    NoParameter = "no-parameter",
+    NoAPIInfo = "no-api-info",
+    MethodNotAllowed = "method-not-allowed",
+    UrlPathNotExist = "url-path-not-exist",
     Cancelled = "cancelled",
     Unknown = "unknown"
 }
@@ -140,6 +166,7 @@ export interface CheckParamResult {
     requiredNum: number;
     optionalNum: number;
     isValid: boolean;
+    reason: ErrorType[];
 }
 export interface ParseOptions {
     /**
@@ -194,12 +221,25 @@ export interface ListAPIInfo {
     api: string;
     server: string;
     operationId: string;
+    isValid: boolean;
+    reason: ErrorType[];
     auth?: AuthInfo;
 }
+export interface APIMap {
+    [key: string]: {
+        operation: OpenAPIV3.OperationObject;
+        isValid: boolean;
+        reason: ErrorType[];
+    };
+}
+export interface APIValidationResult {
+    isValid: boolean;
+    reason: ErrorType[];
+}
 export interface ListAPIResult {
     allAPICount: number;
     validAPICount: number;
-    validAPIs: ListAPIInfo[];
+    APIs: ListAPIInfo[];
 }
 export interface AuthInfo {
     authScheme: OpenAPIV3.SecuritySchemeObject;

package/dist/src/manifestUpdater.d.ts

@@ -5,8 +5,9 @@ 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 generatePluginManifestSchema(spec: OpenAPIV3.Document, specRelativePath: string, appName: 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;
+    static removeEnvs(str: 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,5 +56,6 @@ export declare class SpecParser {
      */
     generate(manifestPath: string, filter: string[], outputSpecPath: string, adaptiveCardFolder?: string, signal?: AbortSignal): Promise<GenerateResult>;
     private loadSpec;
-    private getAllSupportedAPIs;
+    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;
@@ -54,5 +55,6 @@ export declare class SpecParser {
      */
     generate(manifestPath: string, filter: string[], outputSpecPath: string, adaptiveCardFolder?: string, signal?: AbortSignal): Promise<GenerateResult>;
     private loadSpec;
-    private getAllSupportedAPIs;
+    private getAPIs;
+    private getValidator;
 }

package/dist/src/utils.d.ts

@@ -1,48 +1,28 @@
 import { OpenAPIV3 } from "openapi-types";
-import SwaggerParser from "@apidevtools/swagger-parser";
-import { 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): 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, isTeamsAiProject?: boolean): OpenAPIV3.MediaTypeObject;
+    static getResponseJson(operationObject: OpenAPIV3.OperationObject | undefined): {
+        json: OpenAPIV3.MediaTypeObject;
+        multipleMediaType: boolean;
+    };
     static convertPathToCamelCase(path: string): string;
     static getUrlProtocol(urlString: string): string | undefined;
-    static resolveServerUrl(url: string): string;
+    static resolveEnv(str: 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): [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, 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.2f5decfcc.0",
+  "version": "0.1.1-alpha.42af26ca6.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.2f5decfcc.0",
+    "@microsoft/teams-manifest": "0.1.4-alpha.42af26ca6.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": "f45c01f9a70836de49671dc1e5a2ca6ac22eac8e"
+  "gitHead": "839b8377496cd0a5198eab523aea386f2e67d1c4"
 }