@microsoft/m365-spec-parser 0.2.11 → 0.2.12-alpha.0a63a75aae.0

package/dist/src/interfaces.d.ts

@@ -1,300 +1,300 @@
-import { IParameter } from "@microsoft/app-manifest";
-import { OpenAPIV3 } from "openapi-types";
-/**
- * An interface that represents the result of validating an OpenAPI specification file.
- */
-export interface ValidateResult {
-    /**
-     * The validation status of the OpenAPI specification file.
-     */
-    status: ValidationStatus;
-    /**
-     * An array of warning results generated during validation.
-     */
-    warnings: WarningResult[];
-    /**
-     * An array of error results generated during validation.
-     */
-    errors: ErrorResult[];
-    specHash?: string;
-}
-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.
- */
-export interface WarningResult {
-    /**
-     * The type of warning.
-     */
-    type: WarningType;
-    /**
-     * The content of the warning.
-     */
-    content: string;
-    /**
-     * data of the warning.
-     */
-    data?: any;
-}
-/**
- * An interface that represents an error result generated during validation.
- */
-export interface ErrorResult {
-    /**
-     * The type of error.
-     */
-    type: ErrorType;
-    /**
-     * The content of the error.
-     */
-    content: string;
-    /**
-     * data of the error.
-     */
-    data?: any;
-}
-export interface GenerateResult {
-    allSuccess: boolean;
-    warnings: WarningResult[];
-}
-/**
- * An enum that represents the types of errors that can occur during validation.
- */
-export declare enum ErrorType {
-    SpecNotValid = "spec-not-valid",
-    RemoteRefNotSupported = "remote-ref-not-supported",
-    NoServerInformation = "no-server-information",
-    UrlProtocolNotSupported = "url-protocol-not-supported",
-    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",
-    UpdateManifestFailed = "update-manifest-failed",
-    GenerateAdaptiveCardFailed = "generate-adaptive-card-failed",
-    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",
-    PostBodyContainsRequiredUnsupportedSchema = "post-body-contains-required-unsupported-schema",
-    ParamsContainRequiredUnsupportedSchema = "params-contain-required-unsupported-schema",
-    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",
-    AddAuthFailed = "add-auth-failed"
-}
-/**
- * An enum that represents the types of warnings that can occur during validation.
- */
-export declare enum WarningType {
-    OperationIdMissing = "operationid-missing",
-    GenerateCardFailed = "generate-card-failed",
-    OperationOnlyContainsOptionalParam = "operation-only-contains-optional-param",
-    ConvertSwaggerToOpenAPI = "convert-swagger-to-openapi",
-    OpenAPI31ConvertTo30 = "openapi31-convert-to-30",
-    OperationIdContainsSpecialCharacters = "operationid-contains-special-characters",
-    UnsupportedAuthType = "unsupported-auth-type",
-    GenerateJsonDataFailed = "generate-json-data-failed",
-    Unknown = "unknown"
-}
-/**
- * An enum that represents the validation status of an OpenAPI specification file.
- */
-export declare enum ValidationStatus {
-    Valid = 0,
-    Warning = 1,
-    Error = 2
-}
-export interface TextBlockElement {
-    type: string;
-    text: string;
-    wrap: boolean;
-}
-export interface ImageElement {
-    type: string;
-    url: string;
-    $when: string;
-}
-export declare type AdaptiveCardBody = Array<TextBlockElement | ImageElement | ArrayElement>;
-export interface ArrayElement {
-    type: string;
-    $data: string;
-    items: AdaptiveCardBody;
-}
-export interface AdaptiveCard {
-    type: string;
-    $schema: string;
-    version: string;
-    body: AdaptiveCardBody;
-}
-export interface PreviewCardTemplate {
-    title: string;
-    subtitle?: string;
-    image?: {
-        url: string;
-        alt?: string;
-        $when?: string;
-    };
-}
-export interface WrappedAdaptiveCard {
-    version: string;
-    $schema?: string;
-    jsonPath?: string;
-    responseLayout: string;
-    responseCardTemplate: AdaptiveCard;
-    previewCardTemplate: PreviewCardTemplate;
-}
-export interface CheckParamResult {
-    requiredNum: number;
-    optionalNum: number;
-    isValid: boolean;
-    reason: ErrorType[];
-}
-export interface ParseOptions {
-    /**
-     * If true, the parser will not throw an error if an ID is missing the spec file.
-     */
-    allowMissingId?: boolean;
-    /**
-     * If true, the parser will allow parsing of Swagger specifications.
-     */
-    allowSwagger?: boolean;
-    /**
-     * If true, the parser will allow API Key authentication in the spec file.
-     */
-    allowAPIKeyAuth?: boolean;
-    /**
-     * 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. 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,
-    SME = 1,
-    TeamsAi = 2
-}
-export declare enum AdaptiveCardUpdateStrategy {
-    CreateNew = 0,
-    KeepExisting = 1
-}
-export interface APIInfo {
-    method: string;
-    path: string;
-    title: string;
-    id: string;
-    parameters: IParameter[];
-    description: string;
-    warning?: WarningResult;
-}
-export interface ListAPIInfo {
-    api: string;
-    server: string;
-    operationId: string;
-    isValid: boolean;
-    reason: ErrorType[];
-    auth?: AuthInfo;
-    summary?: string;
-    description?: string;
-}
-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 declare type AuthType = OpenAPIV3.SecuritySchemeObject | {
-    type: "multipleAuth";
-};
-export interface AuthInfo {
-    authScheme: AuthType;
-    name: string;
-}
-export interface InvalidAPIInfo {
-    api: string;
-    reason: ErrorType[];
-}
-export interface InferredProperties {
-    title?: string;
-    subtitle?: string;
-    imageUrl?: string;
-}
-export interface ExistingPluginManifestInfo {
-    manifestPath: string;
-    specPath: string;
-}
-export interface OperationAuthInfoMap {
-    [operationId: string]: AuthInfo;
-}
-export interface FunctionClassificationMap {
-    [authType: string]: {
-        functionNames: string[];
-        authName: string;
-    };
-}
+import { IParameter } from "@microsoft/app-manifest";
+import { OpenAPIV3 } from "openapi-types";
+/**
+ * An interface that represents the result of validating an OpenAPI specification file.
+ */
+export interface ValidateResult {
+    /**
+     * The validation status of the OpenAPI specification file.
+     */
+    status: ValidationStatus;
+    /**
+     * An array of warning results generated during validation.
+     */
+    warnings: WarningResult[];
+    /**
+     * An array of error results generated during validation.
+     */
+    errors: ErrorResult[];
+    specHash?: string;
+}
+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.
+ */
+export interface WarningResult {
+    /**
+     * The type of warning.
+     */
+    type: WarningType;
+    /**
+     * The content of the warning.
+     */
+    content: string;
+    /**
+     * data of the warning.
+     */
+    data?: any;
+}
+/**
+ * An interface that represents an error result generated during validation.
+ */
+export interface ErrorResult {
+    /**
+     * The type of error.
+     */
+    type: ErrorType;
+    /**
+     * The content of the error.
+     */
+    content: string;
+    /**
+     * data of the error.
+     */
+    data?: any;
+}
+export interface GenerateResult {
+    allSuccess: boolean;
+    warnings: WarningResult[];
+}
+/**
+ * An enum that represents the types of errors that can occur during validation.
+ */
+export declare enum ErrorType {
+    SpecNotValid = "spec-not-valid",
+    RemoteRefNotSupported = "remote-ref-not-supported",
+    NoServerInformation = "no-server-information",
+    UrlProtocolNotSupported = "url-protocol-not-supported",
+    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",
+    UpdateManifestFailed = "update-manifest-failed",
+    GenerateAdaptiveCardFailed = "generate-adaptive-card-failed",
+    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",
+    PostBodyContainsRequiredUnsupportedSchema = "post-body-contains-required-unsupported-schema",
+    ParamsContainRequiredUnsupportedSchema = "params-contain-required-unsupported-schema",
+    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",
+    AddAuthFailed = "add-auth-failed"
+}
+/**
+ * An enum that represents the types of warnings that can occur during validation.
+ */
+export declare enum WarningType {
+    OperationIdMissing = "operationid-missing",
+    GenerateCardFailed = "generate-card-failed",
+    OperationOnlyContainsOptionalParam = "operation-only-contains-optional-param",
+    ConvertSwaggerToOpenAPI = "convert-swagger-to-openapi",
+    OpenAPI31ConvertTo30 = "openapi31-convert-to-30",
+    OperationIdContainsSpecialCharacters = "operationid-contains-special-characters",
+    UnsupportedAuthType = "unsupported-auth-type",
+    GenerateJsonDataFailed = "generate-json-data-failed",
+    Unknown = "unknown"
+}
+/**
+ * An enum that represents the validation status of an OpenAPI specification file.
+ */
+export declare enum ValidationStatus {
+    Valid = 0,
+    Warning = 1,// If there are any warnings, the file is still valid
+    Error = 2
+}
+export interface TextBlockElement {
+    type: string;
+    text: string;
+    wrap: boolean;
+}
+export interface ImageElement {
+    type: string;
+    url: string;
+    $when: string;
+}
+export type AdaptiveCardBody = Array<TextBlockElement | ImageElement | ArrayElement>;
+export interface ArrayElement {
+    type: string;
+    $data: string;
+    items: AdaptiveCardBody;
+}
+export interface AdaptiveCard {
+    type: string;
+    $schema: string;
+    version: string;
+    body: AdaptiveCardBody;
+}
+export interface PreviewCardTemplate {
+    title: string;
+    subtitle?: string;
+    image?: {
+        url: string;
+        alt?: string;
+        $when?: string;
+    };
+}
+export interface WrappedAdaptiveCard {
+    version: string;
+    $schema?: string;
+    jsonPath?: string;
+    responseLayout: string;
+    responseCardTemplate: AdaptiveCard;
+    previewCardTemplate: PreviewCardTemplate;
+}
+export interface CheckParamResult {
+    requiredNum: number;
+    optionalNum: number;
+    isValid: boolean;
+    reason: ErrorType[];
+}
+export interface ParseOptions {
+    /**
+     * If true, the parser will not throw an error if an ID is missing the spec file.
+     */
+    allowMissingId?: boolean;
+    /**
+     * If true, the parser will allow parsing of Swagger specifications.
+     */
+    allowSwagger?: boolean;
+    /**
+     * If true, the parser will allow API Key authentication in the spec file.
+     */
+    allowAPIKeyAuth?: boolean;
+    /**
+     * 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. 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,
+    SME = 1,
+    TeamsAi = 2
+}
+export declare enum AdaptiveCardUpdateStrategy {
+    CreateNew = 0,// Add a new adaptive card with a new name
+    KeepExisting = 1
+}
+export interface APIInfo {
+    method: string;
+    path: string;
+    title: string;
+    id: string;
+    parameters: IParameter[];
+    description: string;
+    warning?: WarningResult;
+}
+export interface ListAPIInfo {
+    api: string;
+    server: string;
+    operationId: string;
+    isValid: boolean;
+    reason: ErrorType[];
+    auth?: AuthInfo;
+    summary?: string;
+    description?: string;
+}
+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 type AuthType = OpenAPIV3.SecuritySchemeObject | {
+    type: "multipleAuth";
+};
+export interface AuthInfo {
+    authScheme: AuthType;
+    name: string;
+}
+export interface InvalidAPIInfo {
+    api: string;
+    reason: ErrorType[];
+}
+export interface InferredProperties {
+    title?: string;
+    subtitle?: string;
+    imageUrl?: string;
+}
+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

@@ -1,6 +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;
-}
+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,16 +1,16 @@
-import { OpenAPIV3 } from "openapi-types";
-import { AuthInfo, ExistingPluginManifestInfo, OperationAuthInfoMap, ParseOptions, WarningResult } from "./interfaces";
-import { IMessagingExtensionCommand, TeamsAppManifest, PluginManifestSchema } from "@microsoft/app-manifest";
-export declare class ManifestUpdater {
-    static useCopilotExtensionsInSchema(manifest: TeamsAppManifest): Promise<boolean>;
-    static updateManifestWithAiPlugin(manifestPath: string, outputSpecPath: string, apiPluginFilePath: string, spec: OpenAPIV3.Document, options: ParseOptions, authMap: OperationAuthInfoMap, existingPluginManifestInfo?: ExistingPluginManifestInfo): Promise<[TeamsAppManifest, PluginManifestSchema, WarningResult[], Record<string, any>]>;
-    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, authMap: OperationAuthInfoMap, options: ParseOptions, existingPluginManifestInfo?: ExistingPluginManifestInfo): Promise<[PluginManifestSchema, WarningResult[], Record<string, any>]>;
-    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;
-}
+import { OpenAPIV3 } from "openapi-types";
+import { AuthInfo, ExistingPluginManifestInfo, OperationAuthInfoMap, ParseOptions, WarningResult } from "./interfaces";
+import { IMessagingExtensionCommand, TeamsAppManifest, PluginManifestSchema } from "@microsoft/app-manifest";
+export declare class ManifestUpdater {
+    static useCopilotExtensionsInSchema(manifest: TeamsAppManifest): Promise<boolean>;
+    static updateManifestWithAiPlugin(manifestPath: string, outputSpecPath: string, apiPluginFilePath: string, spec: OpenAPIV3.Document, options: ParseOptions, authMap: OperationAuthInfoMap, existingPluginManifestInfo?: ExistingPluginManifestInfo): Promise<[TeamsAppManifest, PluginManifestSchema, WarningResult[], Record<string, any>]>;
+    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, authMap: OperationAuthInfoMap, options: ParseOptions, existingPluginManifestInfo?: ExistingPluginManifestInfo): Promise<[PluginManifestSchema, WarningResult[], Record<string, any>]>;
+    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/specFilter.d.ts

@@ -1,5 +1,5 @@
-import { OpenAPIV3 } from "openapi-types";
-import { ParseOptions } from "./interfaces";
-export declare class SpecFilter {
-    static specFilter(filter: string[], unResolveSpec: OpenAPIV3.Document, resolvedSpec: OpenAPIV3.Document, options: ParseOptions): OpenAPIV3.Document;
-}
+import { OpenAPIV3 } from "openapi-types";
+import { ParseOptions } from "./interfaces";
+export declare class SpecFilter {
+    static specFilter(filter: string[], unResolveSpec: OpenAPIV3.Document, resolvedSpec: OpenAPIV3.Document, options: ParseOptions): OpenAPIV3.Document;
+}