@microsoft/m365-spec-parser 0.2.3 → 0.2.4-alpha.a2c09e877.0

package/dist/src/adaptiveCardGenerator.d.ts

@@ -1,8 +1,10 @@
 import { OpenAPIV3 } from "openapi-types";
-import { AdaptiveCard, ArrayElement, ImageElement, TextBlockElement } from "./interfaces";
+import { AdaptiveCard, ArrayElement, ImageElement, TextBlockElement, WarningResult } from "./interfaces";
 export declare class AdaptiveCardGenerator {
-    static generateAdaptiveCard(operationItem: OpenAPIV3.OperationObject, allowMultipleMediaType?: boolean): [AdaptiveCard, string];
-    static generateCardFromResponse(schema: OpenAPIV3.SchemaObject, name: string, parentArrayName?: string): Array<TextBlockElement | ImageElement | ArrayElement>;
+    static generateAdaptiveCard(operationItem: OpenAPIV3.OperationObject, allowMultipleMediaType?: boolean, maxElementCount?: number): [AdaptiveCard, string, any, WarningResult[]];
+    static generateCardFromResponse(schema: OpenAPIV3.SchemaObject, name: string, parentArrayName?: string, maxElementCount?: number, counter?: {
+        count: number;
+    }): Array<TextBlockElement | ImageElement | ArrayElement>;
     static getResponseJsonPathFromSchema(schema: OpenAPIV3.SchemaObject): string;
     static isImageUrlProperty(schema: OpenAPIV3.NonArraySchemaObject, name: string, parentArrayName: string): boolean;
 }

package/dist/src/constants.d.ts

@@ -15,22 +15,23 @@ export declare class ConstantString {
     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 OperationIdContainsSpecialCharacters = "Operation id '%s' in OpenAPI description document contained special characters and was renamed to '%s'.";
+    static readonly AuthTypeIsNotSupported = "Unsupported authorization type in API '%s'. No authorization will be used.";
     static readonly UnsupportedSchema = "Unsupported schema in %s %s: %s";
     static readonly FuncDescriptionTooLong = "The description of the function '%s' is too long. The current length is %s characters, while the maximum allowed length is %s characters.";
+    static readonly GenerateJsonDataFailed = "Failed to generate JSON data for api: %s due to %s.";
     static readonly WrappedCardVersion = "devPreview";
     static readonly WrappedCardSchema = "https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.ResponseRenderingTemplate.schema.json";
     static readonly WrappedCardResponseLayout = "list";
     static readonly GetMethod = "get";
     static readonly PostMethod = "post";
     static readonly AdaptiveCardVersion = "1.5";
-    static readonly AdaptiveCardSchema = "http://adaptivecards.io/schemas/adaptive-card.json";
+    static readonly AdaptiveCardSchema = "https://adaptivecards.io/schemas/adaptive-card.json";
     static readonly AdaptiveCardType = "AdaptiveCard";
     static readonly TextBlockType = "TextBlock";
     static readonly ImageType = "Image";
     static readonly ContainerType = "Container";
-    static readonly RegistrationIdPostfix: {
-        [key: string]: string;
-    };
+    static readonly RegistrationIdPostfix = "REGISTRATION_ID";
     static readonly ResponseCodeFor20X: string[];
     static readonly AllOperationMethods: string[];
     static readonly WellknownResultNames: string[];

package/dist/src/interfaces.d.ts

@@ -96,11 +96,8 @@ export declare enum ErrorType {
     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",
@@ -118,6 +115,9 @@ export declare enum WarningType {
     OperationOnlyContainsOptionalParam = "operation-only-contains-optional-param",
     ConvertSwaggerToOpenAPI = "convert-swagger-to-openapi",
     FuncDescriptionTooLong = "function-description-too-long",
+    OperationIdContainsSpecialCharacters = "operationid-contains-special-characters",
+    UnsupportedAuthType = "unsupported-auth-type",
+    GenerateJsonDataFailed = "generate-json-data-failed",
     Unknown = "unknown"
 }
 /**
@@ -282,3 +282,12 @@ export interface ExistingPluginManifestInfo {
     manifestPath: string;
     specPath: string;
 }
+export interface OperationAuthInfoMap {
+    [operationId: string]: AuthInfo;
+}
+export interface FunctionClassificationMap {
+    [authType: string]: {
+        functionNames: string[];
+        authName: string;
+    };
+}

package/dist/src/jsonDataGenerator.d.ts

@@ -0,0 +1,6 @@
+import { OpenAPIV3 } from "openapi-types";
+export declare class JsonDataGenerator {
+    private static visitedSchemas;
+    static generate(schema: OpenAPIV3.SchemaObject): any;
+    static generateMockData(schema: OpenAPIV3.SchemaObject): any;
+}

package/dist/src/manifestUpdater.d.ts

@@ -1,11 +1,11 @@
 import { OpenAPIV3 } from "openapi-types";
-import { AuthInfo, ExistingPluginManifestInfo, ParseOptions, WarningResult } from "./interfaces";
+import { AuthInfo, ExistingPluginManifestInfo, OperationAuthInfoMap, ParseOptions, WarningResult } from "./interfaces";
 import { IMessagingExtensionCommand, TeamsAppManifest, PluginManifestSchema } from "@microsoft/teams-manifest";
 export declare class ManifestUpdater {
-    static updateManifestWithAiPlugin(manifestPath: string, outputSpecPath: string, apiPluginFilePath: string, spec: OpenAPIV3.Document, options: ParseOptions, authInfo?: AuthInfo, existingPluginManifestInfo?: ExistingPluginManifestInfo): Promise<[TeamsAppManifest, PluginManifestSchema, WarningResult[]]>;
+    static updateManifestWithAiPlugin(manifestPath: string, outputSpecPath: string, apiPluginFilePath: string, spec: OpenAPIV3.Document, options: ParseOptions, authMap: OperationAuthInfoMap, existingPluginManifestInfo?: ExistingPluginManifestInfo): Promise<[TeamsAppManifest, PluginManifestSchema, WarningResult[]]>;
     static updateManifestDescription(manifest: TeamsAppManifest, spec: OpenAPIV3.Document): void;
     static checkSchema(schema: OpenAPIV3.SchemaObject, method: string, pathUrl: string): void;
-    static generatePluginManifestSchema(spec: OpenAPIV3.Document, specRelativePath: string, apiPluginFilePath: string, appName: string, authInfo: AuthInfo | undefined, options: ParseOptions, existingPluginManifestInfo?: ExistingPluginManifestInfo): Promise<[PluginManifestSchema, WarningResult[]]>;
+    static generatePluginManifestSchema(spec: OpenAPIV3.Document, specRelativePath: string, apiPluginFilePath: string, appName: string, authMap: OperationAuthInfoMap, options: ParseOptions, existingPluginManifestInfo?: ExistingPluginManifestInfo): Promise<[PluginManifestSchema, 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/utils.d.ts

@@ -1,23 +1,26 @@
 import { OpenAPIV3 } from "openapi-types";
-import { AdaptiveCardBody, AuthInfo, AuthType, ErrorResult, ParseOptions } from "./interfaces";
+import { AuthInfo, AuthType, ErrorResult, OperationAuthInfoMap, ParseOptions } from "./interfaces";
 import { IMessagingExtensionCommand, IParameter } from "@microsoft/teams-manifest";
 export declare class Utils {
-    static hasNestedObjectInSchema(schema: OpenAPIV3.SchemaObject): boolean;
+    static isObjectSchema(schema: OpenAPIV3.SchemaObject): boolean;
     static containMultipleMediaTypes(bodyObject: OpenAPIV3.RequestBodyObject | OpenAPIV3.ResponseObject): boolean;
     static isBearerTokenAuth(authScheme: AuthType): boolean;
     static isAPIKeyAuth(authScheme: AuthType): boolean;
     static isOAuthWithAuthCodeFlow(authScheme: AuthType): boolean;
+    static isNotSupportedAuth(authSchemeArray: AuthInfo[][]): boolean;
     static getAuthArray(securities: OpenAPIV3.SecurityRequirementObject[] | undefined, spec: OpenAPIV3.Document): AuthInfo[][];
+    static getAuthMap(spec: OpenAPIV3.Document): OperationAuthInfoMap;
     static getAuthInfo(spec: OpenAPIV3.Document): AuthInfo | undefined;
     static updateFirstLetter(str: string): string;
     static getResponseJson(operationObject: OpenAPIV3.OperationObject | undefined, allowMultipleMediaType?: boolean): {
         json: OpenAPIV3.MediaTypeObject;
         multipleMediaType: boolean;
     };
+    static getJsonContentType(responseObject: OpenAPIV3.ResponseObject | OpenAPIV3.RequestBodyObject): OpenAPIV3.MediaTypeObject;
     static convertPathToCamelCase(path: string): string;
     static getUrlProtocol(urlString: string): string | undefined;
     static resolveEnv(str: string): string;
-    static checkServerUrl(servers: OpenAPIV3.ServerObject[]): ErrorResult[];
+    static checkServerUrl(servers: OpenAPIV3.ServerObject[], allowHttp?: 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): [IParameter[], IParameter[]];
@@ -26,5 +29,4 @@ export declare class Utils {
     static format(str: string, ...args: string[]): string;
     static getSafeRegistrationIdEnvName(authName: string): string;
     static getServerObject(spec: OpenAPIV3.Document, method: string, path: string): OpenAPIV3.ServerObject | undefined;
-    static limitACBodyProperties(body: AdaptiveCardBody, maxCount: number): AdaptiveCardBody;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/m365-spec-parser",
-  "version": "0.2.3",
+  "version": "0.2.4-alpha.a2c09e877.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.7",
+    "@microsoft/teams-manifest": "0.1.8-alpha.a2c09e877.0",
     "fs-extra": "^11.2.0",
     "js-yaml": "^4.1.0",
     "openapi-types": "^7.2.3",
@@ -147,5 +147,5 @@
       "npx eslint --cache --fix --quiet"
     ]
   },
-  "gitHead": "6a4668989944e24635fe03fe6c5a05b07c348e30"
+  "gitHead": "079d81eaeb33e9e3de17346d12b2894cb158b89a"
 }