@microsoft/m365-spec-parser 0.1.1-alpha.f04ac4ba4.0 → 0.1.1-alpha.f2bd7316b.0

package/dist/src/adaptiveCardWrapper.d.ts

@@ -1,5 +1,7 @@
+import { ResponseSemanticsObject } from "@microsoft/teams-manifest";
 import { AdaptiveCard, PreviewCardTemplate, WrappedAdaptiveCard } from "./interfaces";
 export declare function wrapAdaptiveCard(card: AdaptiveCard, jsonPath: string): WrappedAdaptiveCard;
+export declare function wrapResponseSemantics(card: AdaptiveCard, jsonPath: string): ResponseSemanticsObject;
 /**
  * Infers the preview card template from an Adaptive Card and a JSON path.
  * The preview card template includes a title and an optional subtitle and image.

package/dist/src/constants.d.ts

@@ -5,7 +5,7 @@ export declare class ConstantString {
     static readonly MissingOperationId = "Missing operationIds: %s.";
     static readonly NoSupportedApi = "No supported API is found in the OpenAPI description document: only GET and POST methods are supported, additionally, there can be at most one required parameter, and no auth is allowed.";
     static readonly AdditionalPropertiesNotSupported = "'additionalProperties' is not supported, and will be ignored.";
-    static readonly SchemaNotSupported = "'oneOf', 'anyOf', and 'not' schema are not supported: %s.";
+    static readonly SchemaNotSupported = "'oneOf', 'allOf', 'anyOf', and 'not' schema are not supported: %s.";
     static readonly UnknownSchema = "Unknown schema: %s.";
     static readonly UrlProtocolNotSupported = "Server url is not correct: protocol %s is not supported, you should use https protocol instead.";
     static readonly RelativeServerUrlNotSupported = "Server url is not correct: relative server url is not supported.";
@@ -13,7 +13,8 @@ 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 MultipleAPIKeyNotSupported = "Multiple API keys are not supported. Please make sure that all selected APIs use the same API key.";
+    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";
     static readonly WrappedCardSchema = "https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.ResponseRenderingTemplate.schema.json";
@@ -24,8 +25,11 @@ export declare class ConstantString {
     static readonly AdaptiveCardSchema = "http://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 = "REGISTRATION_ID";
+    static readonly RegistrationIdPostfix: {
+        [key: string]: string;
+    };
     static readonly ResponseCodeFor20X: string[];
     static readonly AllOperationMethods: string[];
     static readonly WellknownResultNames: string[];
@@ -36,7 +40,9 @@ export declare class ConstantString {
     static readonly FullDescriptionMaxLens = 4000;
     static readonly CommandDescriptionMaxLens = 128;
     static readonly ParameterDescriptionMaxLens = 128;
+    static readonly ConversationStarterMaxLens = 50;
     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

@@ -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.
@@ -16,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.
  */
@@ -67,7 +78,8 @@ 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",
+    SpecVersionNotSupported = "spec-version-not-supported",
     ListFailed = "list-failed",
     listSupportedAPIInfoFailed = "list-supported-api-info-failed",
     FilterSpecFailed = "filter-spec-failed",
@@ -76,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"
 }
@@ -135,22 +162,11 @@ 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;
     isValid: boolean;
+    reason: ErrorType[];
 }
 export interface ParseOptions {
     /**
@@ -166,22 +182,42 @@ 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;
     /**
      * An array of HTTP methods that the parser will allow in the spec file.
      */
     allowMethods?: string[];
+    /**
+     * If true, the parser will allow conversation starters in plugin file. Only take effect in Copilot project
+     */
+    allowConversationStarters?: boolean;
+    /**
+     * If true, the parser will allow response semantics in plugin file. Only take effect in Copilot project
+     */
+    allowResponseSemantics?: boolean;
+    /**
+     * If true, the paser will allow confirmation in plugin file. Only take effect in Copilot project
+     */
+    allowConfirmation?: boolean;
     /**
      * The type of project that the parser is being used for.
      * Project can be SME/Copilot/TeamsAi
      */
     projectType?: ProjectType;
+    /**
+     * If true, we will generate files of plugin for GPT (Declarative Extensions in a Copilot Extension). Otherwise, we will generate files of plugin for Copilot.
+     */
+    isGptPlugin?: boolean;
 }
 export declare enum ProjectType {
     Copilot = 0,
@@ -193,17 +229,44 @@ 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;
+    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;
+    APIs: ListAPIInfo[];
 }
-export interface AuthSchema {
-    authSchema: OpenAPIV3.SecuritySchemeObject;
+export interface AuthInfo {
+    authScheme: OpenAPIV3.SecuritySchemeObject;
     name: string;
 }
+export interface InvalidAPIInfo {
+    api: string;
+    reason: ErrorType[];
+}
+export interface InferredProperties {
+    title?: string;
+    subtitle?: string;
+    imageUrl?: string;
+}

package/dist/src/manifestUpdater.d.ts

@@ -1,12 +1,15 @@
 import { OpenAPIV3 } from "openapi-types";
-import { ParseOptions, WarningResult } from "./interfaces";
-import { IMessagingExtensionCommand, TeamsAppManifest, PluginManifestSchema, FunctionParameter } from "@microsoft/teams-manifest";
+import { AuthInfo, 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): Promise<[TeamsAppManifest, PluginManifestSchema]>;
+    static updateManifestWithAiPlugin(manifestPath: string, outputSpecPath: string, apiPluginFilePath: string, spec: OpenAPIV3.Document, options: ParseOptions, authInfo?: AuthInfo): 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 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): 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;
+    static removeEnvs(str: string): string;
+    static removeAllSpecialCharacters(str: string): string;
+    static getConfirmationBodyItem(paramName: string): string;
 }

package/dist/src/specParser.browser.d.ts

@@ -8,8 +8,8 @@ export declare class SpecParser {
     readonly pathOrSpec: string | OpenAPIV3.Document;
     readonly parser: SwaggerParser;
     readonly options: Required<ParseOptions>;
-    private apiMap;
     private spec;
+    private validator;
     private unResolveSpec;
     private isSwaggerFile;
     private defaultOptions;
@@ -55,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/specParser.d.ts

@@ -8,7 +8,7 @@ export declare class SpecParser {
     readonly pathOrSpec: string | OpenAPIV3.Document;
     readonly parser: SwaggerParser;
     readonly options: Required<ParseOptions>;
-    private apiMap;
+    private validator;
     private spec;
     private unResolveSpec;
     private isSwaggerFile;
@@ -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.
@@ -54,5 +54,7 @@ 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;
+    private saveFilterSpec;
 }

package/dist/src/utils.d.ts

@@ -1,45 +1,29 @@
 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, 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;
-    /**
-     * 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(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 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 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): 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): [Parameter[], Parameter[]];
-    static updateParameterWithInputType(schema: OpenAPIV3.SchemaObject, param: Parameter): 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 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;
     static format(str: string, ...args: string[]): string;
     static getSafeRegistrationIdEnvName(authName: string): string;
+    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.f04ac4ba4.0",
+  "version": "0.1.1-alpha.f2bd7316b.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.f04ac4ba4.0",
+    "@microsoft/teams-manifest": "0.1.4-alpha.f2bd7316b.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": "e5bb491b7ffc6f29e7128cc9f9a29f2f9ff6e503"
+  "gitHead": "4e341b4530d7ea49a908523a85f4935033264850"
 }