@microsoft/m365-spec-parser 0.2.1 → 0.2.2-alpha.070ff93c3.0

package/dist/src/adaptiveCardGenerator.d.ts

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

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, InvalidAPIInfo, } from "./interfaces";
+export { ValidationStatus, WarningType, ErrorType, WarningResult, ErrorResult, ListAPIResult, APIInfo, ValidateResult, ParseOptions, AdaptiveCard, ProjectType, InvalidAPIInfo, AuthType, } from "./interfaces";
 export { ConstantString } from "./constants";
 export { Utils } from "./utils";
 export { AdaptiveCardGenerator } from "./adaptiveCardGenerator";

package/dist/src/interfaces.d.ts

@@ -76,10 +76,12 @@ export declare enum ErrorType {
     RelativeServerUrlNotSupported = "relative-server-url-not-supported",
     NoSupportedApi = "no-supported-api",
     NoExtraAPICanBeAdded = "no-extra-api-can-be-added",
+    AddedAPINotInOriginalSpec = "added-api-not-in-original-spec",
     ResolveServerUrlFailed = "resolve-server-url-failed",
     SwaggerNotSupported = "swagger-not-supported",
     MultipleAuthNotSupported = "multiple-auth-not-supported",
     SpecVersionNotSupported = "spec-version-not-supported",
+    CircularReferenceNotSupported = "circular-reference-not-supported",
     ListFailed = "list-failed",
     listSupportedAPIInfoFailed = "list-supported-api-info-failed",
     FilterSpecFailed = "filter-spec-failed",
@@ -134,16 +136,17 @@ export interface ImageElement {
     url: string;
     $when: string;
 }
+export declare type AdaptiveCardBody = Array<TextBlockElement | ImageElement | ArrayElement>;
 export interface ArrayElement {
     type: string;
     $data: string;
-    items: Array<TextBlockElement | ImageElement | ArrayElement>;
+    items: AdaptiveCardBody;
 }
 export interface AdaptiveCard {
     type: string;
     $schema: string;
     version: string;
-    body: Array<TextBlockElement | ImageElement | ArrayElement>;
+    body: AdaptiveCardBody;
 }
 export interface PreviewCardTemplate {
     title: string;
@@ -257,8 +260,11 @@ export interface ListAPIResult {
     validAPICount: number;
     APIs: ListAPIInfo[];
 }
+export declare type AuthType = OpenAPIV3.SecuritySchemeObject | {
+    type: "multipleAuth";
+};
 export interface AuthInfo {
-    authScheme: OpenAPIV3.SecuritySchemeObject;
+    authScheme: AuthType;
     name: string;
 }
 export interface InvalidAPIInfo {

package/dist/src/specOptimizer.d.ts

@@ -0,0 +1,18 @@
+import { OpenAPIV3 } from "openapi-types";
+export interface OptimizerOptions {
+    removeUnusedComponents: boolean;
+    removeUnusedTags: boolean;
+    removeUserDefinedRootProperty: boolean;
+    removeUnusedSecuritySchemas: boolean;
+}
+export declare class SpecOptimizer {
+    private static defaultOptions;
+    static optimize(spec: OpenAPIV3.Document, options?: OptimizerOptions): OpenAPIV3.Document;
+    private static removeUnusedSecuritySchemas;
+    private static removeUnusedTags;
+    private static removeUserDefinedRootProperty;
+    private static removeUnusedComponents;
+    private static getComponentReferences;
+    private static getComponent;
+    private static addComponent;
+}

package/dist/src/specParser.d.ts

@@ -57,4 +57,5 @@ export declare class SpecParser {
     private getAPIs;
     private getValidator;
     private saveFilterSpec;
+    private resolveEnvForSpec;
 }

package/dist/src/utils.d.ts

@@ -1,16 +1,16 @@
 import { OpenAPIV3 } from "openapi-types";
-import { AuthInfo, ErrorResult, ParseOptions } from "./interfaces";
+import { AdaptiveCardBody, AuthInfo, AuthType, ErrorResult, ParseOptions } from "./interfaces";
 import { IMessagingExtensionCommand, IParameter } from "@microsoft/teams-manifest";
 export declare class Utils {
     static hasNestedObjectInSchema(schema: OpenAPIV3.SchemaObject): boolean;
     static containMultipleMediaTypes(bodyObject: OpenAPIV3.RequestBodyObject | OpenAPIV3.ResponseObject): boolean;
-    static isBearerTokenAuth(authScheme: OpenAPIV3.SecuritySchemeObject): boolean;
-    static isAPIKeyAuth(authScheme: OpenAPIV3.SecuritySchemeObject): boolean;
-    static isOAuthWithAuthCodeFlow(authScheme: OpenAPIV3.SecuritySchemeObject): boolean;
+    static isBearerTokenAuth(authScheme: AuthType): boolean;
+    static isAPIKeyAuth(authScheme: AuthType): boolean;
+    static isOAuthWithAuthCodeFlow(authScheme: AuthType): boolean;
     static getAuthArray(securities: OpenAPIV3.SecurityRequirementObject[] | undefined, spec: OpenAPIV3.Document): AuthInfo[][];
     static getAuthInfo(spec: OpenAPIV3.Document): AuthInfo | undefined;
     static updateFirstLetter(str: string): string;
-    static getResponseJson(operationObject: OpenAPIV3.OperationObject | undefined): {
+    static getResponseJson(operationObject: OpenAPIV3.OperationObject | undefined, allowMultipleMediaType?: boolean): {
         json: OpenAPIV3.MediaTypeObject;
         multipleMediaType: boolean;
     };
@@ -26,4 +26,5 @@ 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.1",
+  "version": "0.2.2-alpha.070ff93c3.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.5",
+    "@microsoft/teams-manifest": "0.1.6-alpha.070ff93c3.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": "400fc6af9abee5c7484fd9ed406790c39889b1bc"
+  "gitHead": "ad7952c369f15bba09ffc2fa12b0e7bd5bbfd545"
 }