@azure/swagger-validation-common - npm Package Compare versions

Comparing version 0.0.5 to 0.0.6

.rush/temp/package-deps_build.json

@@ -5,9 +5,10 @@ {
     "libraries/swagger-validation-common/jest.config.js": "2afdd8c9ba0010245b1c2d1cadd68639d1cf00f3",
-    "libraries/swagger-validation-common/package.json": "e6a14be069da651c0c036c8ecce39893b93ec85e",
-    "libraries/swagger-validation-common/src/index.ts": "1acf121309a36b1929fa6669c1a5666ce5482560",
-    "libraries/swagger-validation-common/src/types/event.ts": "604478cca73fb4a48aae6f78db1f647b294c2e95",
-    "libraries/swagger-validation-common/src/types/message.ts": "4cf42529053363b5c3af9023d6584913ddcf4568",
+    "libraries/swagger-validation-common/package.json": "c61ecc7f742487d3a626eb319439fd681e2e6548",
+    "libraries/swagger-validation-common/src/index.ts": "22f46199eee5a9a7b2b3d8dc8500bb9f2fb7679b",
+    "libraries/swagger-validation-common/src/types/event.ts": "39074c8499226cbbd3669c14772140d57ff61fdf",
+    "libraries/swagger-validation-common/src/types/message.ts": "358cb8ca5a733db84c23388a47dd42d6c5e322d5",
     "libraries/swagger-validation-common/src/utils.ts": "7403c7e9b355b5e4fde057d7691da55708459d16",
-    "libraries/swagger-validation-common/tests/types/__snapshots__/message.test.ts.snap": "b04bf0beccb7a9cf971f2178e6e0d2aa01fae30d",
-    "libraries/swagger-validation-common/tests/types/message.test.ts": "f0ea8229c198685df8d54e3da691bb89b953562a",
+    "libraries/swagger-validation-common/tests/types/__snapshots__/message.test.ts.snap": "cbc21cc94ef042c9070ddf18ec01b473279a41f4",
+    "libraries/swagger-validation-common/tests/types/markdownMessage.json": "6d2ca21d67021f60b29cf6eed727d9e1a364fb87",
+    "libraries/swagger-validation-common/tests/types/message.test.ts": "88c0fc9e62f75be754a30ab29f3cc81dc5ce7823",
     "libraries/swagger-validation-common/tests/types/messages.json": "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391",
@@ -14,0 +15,0 @@ "libraries/swagger-validation-common/tests/types/rawMessage.json": "4376ff3e40db4585ce81f6a5da51f4631e1ddd31",

lib/index.d.ts

@@ -1,4 +0,4 @@
-export { PipelineTriggerSource, PipelineResult, PipelineRun, PipelineStatus, InProgressEvent, CompletedEvent, PipelineEvent, } from "./types/event";
-export { MessageLevel, JsonPath, Extra, BaseMessageRecord, ResultMessageRecord, RawMessageRecord, MessageLine, MessageRecord, } from "./types/message";
+export { PipelineTriggerSource, PipelineResult, PipelineRun, PipelineStatus, InProgressEvent, CompletedEvent, CompletedWithResultEvent, PipelineEvent, } from "./types/event";
+export { MessageLevel, JsonPath, Extra, BaseMessageRecord, ResultMessageRecord, RawMessageRecord, MarkdownMessageRecord, MessageLine, MessageRecord, } from "./types/message";
 export { targetHref, blobHref, getRelativeSwaggerPathToRepo, getGithubStyleFilePath, getTargetBranch, } from "./utils";
 //# sourceMappingURL=index.d.ts.map

lib/types/event.d.ts

@@ -0,1 +1,2 @@
+import { MessageLine } from "./message";
 export declare type PipelineResult = "success" | "failure" | "timed_out";
@@ -12,3 +13,3 @@ export declare type PipelineTriggerSource = "github" | "openapi_hub";
 };
-export declare type PipelineStatus = "queued" | "in_progress" | "completed";
+export declare type PipelineStatus = "queued" | "in_progress" | "completed" | "completed_with_result" | "cancelled";
 export declare type InProgressEvent = PipelineRun & {
@@ -22,3 +23,8 @@ status: "in_progress";
 };
-export declare type PipelineEvent = InProgressEvent | CompletedEvent;
+export declare type CompletedWithResultEvent = PipelineRun & {
+    status: "completed_with_result";
+    result: PipelineResult;
+    messages: MessageLine[];
+};
+export declare type PipelineEvent = InProgressEvent | CompletedEvent | CompletedWithResultEvent;
 //# sourceMappingURL=event.d.ts.map

lib/types/message.d.ts

@@ -29,4 +29,8 @@ export declare type MessageLevel = "Info" | "Warning" | "Error";
 };
-export declare type MessageRecord = ResultMessageRecord | RawMessageRecord;
+export declare type MarkdownMessageRecord = BaseMessageRecord & {
+    type: "Markdown";
+    mode: "replace" | "append";
+};
+export declare type MessageRecord = ResultMessageRecord | RawMessageRecord | MarkdownMessageRecord;
 export declare type MessageLine = MessageRecord | MessageRecord[];
 //# sourceMappingURL=message.d.ts.map

package.json

 {
   "name": "@azure/swagger-validation-common",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Common lib for swagger validation",
@@ -28,2 +28,2 @@ "license": "MIT",
   }
-}
+}

src/index.ts

@@ -8,2 +8,3 @@ export {
   CompletedEvent,
+  CompletedWithResultEvent,
   PipelineEvent,
@@ -18,2 +19,3 @@ } from "./types/event";
   RawMessageRecord,
+  MarkdownMessageRecord,
   MessageLine,
@@ -20,0 +22,0 @@ MessageRecord,

src/types/event.ts

@@ -0,1 +1,3 @@
+import { MessageLine } from "./message";
+
 export type PipelineResult = "success" | "failure" | "timed_out";
@@ -15,3 +17,3 @@
 
-export type PipelineStatus = "queued" | "in_progress" | "completed";
+export type PipelineStatus = "queued" | "in_progress" | "completed" | "completed_with_result" | "cancelled";
 
@@ -28,2 +30,8 @@ export type InProgressEvent = PipelineRun & {
 
-export type PipelineEvent = InProgressEvent | CompletedEvent;
+export type CompletedWithResultEvent = PipelineRun & {
+  status: "completed_with_result";
+  result: PipelineResult;
+  messages: MessageLine[]; 
+};
+
+export type PipelineEvent = InProgressEvent | CompletedEvent | CompletedWithResultEvent;

src/types/message.ts

@@ -9,4 +9,4 @@ export type MessageLevel = "Info" | "Warning" | "Error";
 export type MesssageContext = {
-  toolVersion: string; 
-}
+  toolVersion: string;
+};
 
@@ -37,4 +37,9 @@ export type Extra = {
 
-export type MessageRecord = ResultMessageRecord | RawMessageRecord 
+export type MarkdownMessageRecord = BaseMessageRecord & {
+  type: "Markdown";
+  mode: "replace" | "append";
+};
 
-export type MessageLine = MessageRecord | MessageRecord[]
+export type MessageRecord = ResultMessageRecord | RawMessageRecord | MarkdownMessageRecord;
+
+export type MessageLine = MessageRecord | MessageRecord[];

tests/types/message.test.ts

 import { MessageRecord } from "../../src/types/message";
 import rawMessage from "./rawMessage.json";
+import markdownMessage from "./markdownMessage.json";
 import resultMessage from "./resultMessage.json";
@@ -19,2 +20,9 @@
   });
+
+  test("should parse markdown message", () => {
+    const markdownMsg = JSON.stringify(markdownMessage);
+    const msg: MessageRecord = JSON.parse(markdownMsg);
+    expect(msg.type).toBe("Markdown");
+    expect(msg).toMatchSnapshot();
+  });
 });

No alert changes

Improved metrics

Total package byte prevSize

133399

increased by2.07%

Number of package files

34

increased by3.03%

Lines of code

1452

increased by2.76%

No dependency changes