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

Comparing version 0.0.6 to 0.0.7

.rush/temp/package-deps_build.json

@@ -5,5 +5,5 @@ {
     "libraries/swagger-validation-common/jest.config.js": "2afdd8c9ba0010245b1c2d1cadd68639d1cf00f3",
-    "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/package.json": "33d11a1c45e459beb81dd1a6cbe9995a819cf802",
+    "libraries/swagger-validation-common/src/index.ts": "0c05ba7d3219d5ae8df4206803a65c8341fed8c4",
+    "libraries/swagger-validation-common/src/types/event.ts": "e2a36a0201e80010924cf571e6cd57808b4512c5",
     "libraries/swagger-validation-common/src/types/message.ts": "358cb8ca5a733db84c23388a47dd42d6c5e322d5",
@@ -10,0 +10,0 @@ "libraries/swagger-validation-common/src/utils.ts": "7403c7e9b355b5e4fde057d7691da55708459d16",

lib/index.d.ts

@@ -1,4 +0,4 @@
-export { PipelineTriggerSource, PipelineResult, PipelineRun, PipelineStatus, InProgressEvent, CompletedEvent, CompletedWithResultEvent, PipelineEvent, } from "./types/event";
+export { PipelineTriggerSource, PipelineResult, PipelineRun, PipelineStatus, QueuedEvent, InProgressEvent, CompletedEvent, CompletedWithResultEvent, SkippedEvent, 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

 import { MessageLine } from "./message";
-export declare type PipelineResult = "success" | "failure" | "timed_out";
+export declare type PipelineResult = "success" | "failure" | "timed_out" | "skipped";
 export declare type PipelineTriggerSource = "github" | "openapi_hub";
@@ -7,2 +7,3 @@ export declare type PipelineRun = {
     unifiedPipelineTaskKey: string;
+    unifiedPipelineSubTaskKey?: string;
     unifiedPipelineBuildId: string;
@@ -14,3 +15,10 @@ pipelineBuildId: string;
 };
-export declare type PipelineStatus = "queued" | "in_progress" | "completed" | "completed_with_result" | "cancelled";
+export declare type PipelineStatus = "queued" | "in_progress" | "completed" | "skipped" | "completed_with_result";
+export declare type QueuedEvent = PipelineRun & {
+    status: "queued";
+};
+export declare type SkippedEvent = PipelineRun & {
+    status: "skipped";
+    subTitle?: string;
+};
 export declare type InProgressEvent = PipelineRun & {
@@ -23,2 +31,3 @@ status: "in_progress";
     logPath: string;
+    subTitle?: string;
 };
@@ -29,4 +38,5 @@ export declare type CompletedWithResultEvent = PipelineRun & {
     messages: MessageLine[];
+    subTitle?: string;
 };
-export declare type PipelineEvent = InProgressEvent | CompletedEvent | CompletedWithResultEvent;
+export declare type PipelineEvent = QueuedEvent | InProgressEvent | CompletedEvent | SkippedEvent | CompletedWithResultEvent;
 //# sourceMappingURL=event.d.ts.map

package.json

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

src/index.ts

@@ -6,5 +6,7 @@ export {
   PipelineStatus,
+  QueuedEvent,
   InProgressEvent,
   CompletedEvent,
   CompletedWithResultEvent,
+  SkippedEvent,
   PipelineEvent,
@@ -11,0 +13,0 @@ } from "./types/event";

src/types/event.ts

 import { MessageLine } from "./message";
 
-export type PipelineResult = "success" | "failure" | "timed_out";
+export type PipelineResult = "success" | "failure" | "timed_out" | "skipped";
 
@@ -10,2 +10,3 @@ export type PipelineTriggerSource = "github" | "openapi_hub";
   unifiedPipelineTaskKey: string; // a unified pipeline task key, e.g. LintDiff, Semantic
+  unifiedPipelineSubTaskKey?: string; // sub task key, for dynamic generated sub task message
   unifiedPipelineBuildId: string; // a unique build id unified pipeline assigned for each completed pipeline build id
@@ -18,4 +19,18 @@ pipelineBuildId: string; // the id of the record for the completed azure pipeline build.
 
-export type PipelineStatus = "queued" | "in_progress" | "completed" | "completed_with_result" | "cancelled";
+export type PipelineStatus =
+  | "queued"
+  | "in_progress"
+  | "completed"
+  | "skipped"
+  | "completed_with_result";
 
+export type QueuedEvent = PipelineRun & {
+  status: "queued";
+};
+
+export type SkippedEvent = PipelineRun & {
+  status: "skipped";
+  subTitle?: string;
+};
+
 export type InProgressEvent = PipelineRun & {
@@ -29,2 +44,3 @@ status: "in_progress";
   logPath: string;
+  subTitle?: string;
 };
@@ -35,5 +51,11 @@
   result: PipelineResult;
-  messages: MessageLine[]; 
+  messages: MessageLine[];
+  subTitle?: string;
 };
 
-export type PipelineEvent = InProgressEvent | CompletedEvent | CompletedWithResultEvent;
+export type PipelineEvent =
+  | QueuedEvent
+  | InProgressEvent
+  | CompletedEvent
+  | SkippedEvent
+  | CompletedWithResultEvent;

No alert changes

Improved metrics

Total package byte prevSize

134838

increased by1.08%

Lines of code

1484

increased by2.2%

No dependency changes