@microsoft/m365-spec-parser 0.2.12-alpha.d89dca114.0 → 0.2.12-alpha.eaecfe55f.0

package/dist/src/adaptiveCardGenerator.d.ts

@@ -1,10 +1,10 @@
-import { OpenAPIV3 } from "openapi-types";
-import { AdaptiveCard, ArrayElement, ImageElement, TextBlockElement, WarningResult } from "./interfaces";
-export declare class AdaptiveCardGenerator {
-    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;
-}
+import { OpenAPIV3 } from "openapi-types";
+import { AdaptiveCard, ArrayElement, ImageElement, TextBlockElement, WarningResult } from "./interfaces";
+export declare class AdaptiveCardGenerator {
+    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/adaptiveCardWrapper.d.ts

@@ -1,16 +1,16 @@
-import { ResponseSemanticsObject } from "@microsoft/app-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.
- * It populates the preview card template with the first text block that matches
- * each well-known name, in the order of title, subtitle, and image.
- * If no text block matches the title or subtitle, it uses the first two text block as the title and subtitle.
- * If the title is still empty and the subtitle is not empty, it uses subtitle as the title.
- * @param card The Adaptive Card to infer the preview card template from.
- * @param jsonPath The JSON path to the root object in the card body.
- * @returns The inferred preview card template.
- */
-export declare function inferPreviewCardTemplate(card: AdaptiveCard): PreviewCardTemplate;
+import { ResponseSemanticsObject } from "@microsoft/app-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.
+ * It populates the preview card template with the first text block that matches
+ * each well-known name, in the order of title, subtitle, and image.
+ * If no text block matches the title or subtitle, it uses the first two text block as the title and subtitle.
+ * If the title is still empty and the subtitle is not empty, it uses subtitle as the title.
+ * @param card The Adaptive Card to infer the preview card template from.
+ * @param jsonPath The JSON path to the root object in the card body.
+ * @returns The inferred preview card template.
+ */
+export declare function inferPreviewCardTemplate(card: AdaptiveCard): PreviewCardTemplate;

package/dist/src/constants.d.ts

@@ -1,53 +1,53 @@
-export declare class ConstantString {
-    static readonly CancelledMessage = "Operation is cancelled.";
-    static readonly NoServerInformation = "No server information is found in the OpenAPI description document.";
-    static readonly RemoteRefNotSupported = "Remote reference is not supported: %s.";
-    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', '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.";
-    static readonly ResolveServerUrlFailed = "Unable to resolve the server URL: please make sure that the environment variable %s is defined.";
-    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 OpenAPI31ConvertTo30 = "OpenAPI 3.1 document 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 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 = "1.0";
-    static readonly WrappedCardSchema = "https://developer.microsoft.com/json-schemas/teams/v1.19/MicrosoftTeams.ResponseRenderingTemplate.schema.json";
-    static readonly WrappedCardResponseLayout = "list";
-    static readonly GetMethod = "get";
-    static readonly PostMethod = "post";
-    static readonly AdaptiveCardVersion = "1.5";
-    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 = "REGISTRATION_ID";
-    static readonly ResponseCodeFor20X: string[];
-    static readonly AllOperationMethods: string[];
-    static readonly WellknownResultNames: string[];
-    static readonly WellknownTitleName: string[];
-    static readonly WellknownSubtitleName: string[];
-    static readonly WellknownImageName: string[];
-    static readonly ShortDescriptionMaxLens = 80;
-    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 FunctionDescriptionMaxLens = 100;
-    static readonly DefaultPluginId = "plugin_1";
-    static readonly PluginManifestSchema = "https://developer.microsoft.com/json-schemas/copilot/plugin/v2.2/schema.json";
-}
+export declare class ConstantString {
+    static readonly CancelledMessage = "Operation is cancelled.";
+    static readonly NoServerInformation = "No server information is found in the OpenAPI description document.";
+    static readonly RemoteRefNotSupported = "Remote reference is not supported: %s.";
+    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', '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.";
+    static readonly ResolveServerUrlFailed = "Unable to resolve the server URL: please make sure that the environment variable %s is defined.";
+    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 OpenAPI31ConvertTo30 = "OpenAPI 3.1 document 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 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 = "1.0";
+    static readonly WrappedCardSchema = "https://developer.microsoft.com/json-schemas/teams/v1.19/MicrosoftTeams.ResponseRenderingTemplate.schema.json";
+    static readonly WrappedCardResponseLayout = "list";
+    static readonly GetMethod = "get";
+    static readonly PostMethod = "post";
+    static readonly AdaptiveCardVersion = "1.5";
+    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 = "REGISTRATION_ID";
+    static readonly ResponseCodeFor20X: string[];
+    static readonly AllOperationMethods: string[];
+    static readonly WellknownResultNames: string[];
+    static readonly WellknownTitleName: string[];
+    static readonly WellknownSubtitleName: string[];
+    static readonly WellknownImageName: string[];
+    static readonly ShortDescriptionMaxLens = 80;
+    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 FunctionDescriptionMaxLens = 100;
+    static readonly DefaultPluginId = "plugin_1";
+    static readonly PluginManifestSchema = "https://developer.microsoft.com/json-schemas/copilot/plugin/v2.2/schema.json";
+}

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

@@ -1,7 +1,7 @@
-export { SpecParser } from "./specParser.browser";
-export { SpecParserError } from "./specParserError";
-export { ValidationStatus, WarningType, ErrorType, ListAPIResult } from "./interfaces";
-export type { ErrorResult, APIInfo, ValidateResult, WarningResult, ParseOptions, AdaptiveCard, ProjectType, } from "./interfaces";
-export { ConstantString } from "./constants";
-export { Utils } from "./utils";
-export { AdaptiveCardGenerator } from "./adaptiveCardGenerator";
+export { SpecParser } from "./specParser.browser";
+export { SpecParserError } from "./specParserError";
+export { ValidationStatus, WarningType, ErrorType, ListAPIResult } from "./interfaces";
+export type { ErrorResult, APIInfo, ValidateResult, WarningResult, ParseOptions, AdaptiveCard, ProjectType, } from "./interfaces";
+export { ConstantString } from "./constants";
+export { Utils } from "./utils";
+export { AdaptiveCardGenerator } from "./adaptiveCardGenerator";

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