vss-web-extension-sdk - npm Package Compare versions

Comparing version 5.127.0 to 5.127.1

package.json

 {
   "name": "vss-web-extension-sdk",
-  "version": "5.127.0",
+  "version": "5.127.1",
   "description": "Visual Studio Team Services web extension JavaScript library and types.",
@@ -31,6 +31,6 @@ "repository": {
     "@types/jqueryui": ">=1.11.34",
-    "@types/knockout": ">=3.4.46",
+    "@types/knockout": "^3.4.49",
     "@types/mousetrap": "~1.5.34",
     "@types/q": "0.0.32",
-    "@types/react": ">=15.3.1",
+    "@types/react": "^15.6.12",
     "@types/requirejs": ">=2.1.28"
@@ -37,0 +37,0 @@ },

typings/charts.d.ts

@@ -1,2 +0,2 @@
-// Type definitions for Microsoft Visual Studio Services v127.20171208.1646
+// Type definitions for Microsoft Visual Studio Services v131.20180313.2116
 // Project: https://www.visualstudio.com/integrate/extensions/overview
@@ -3,0 +3,0 @@ // Definitions by: Microsoft <[e-mail]>

typings/index.d.ts

 /// <reference path="vss.d.ts" />
+/// <reference path="VSS.SDK.d.ts" />
 /// <reference path="tfs.d.ts" />
@@ -3,0 +4,0 @@ /// <reference path="rmo.d.ts" />

typings/notifications.d.ts

@@ -1,2 +0,2 @@
-// Type definitions for Microsoft Visual Studio Services v127.20171208.1643
+// Type definitions for Microsoft Visual Studio Services v131.20180312.1912
 // Project: https://www.visualstudio.com/integrate/extensions/overview
@@ -40,2 +40,22 @@ // Definitions by: Microsoft <[e-mail]>
 }
+export interface DiagnosticIdentity {
+    displayName: string;
+    emailAddress: string;
+    id: string;
+}
+export interface DiagnosticNotification {
+    eventId: number;
+    eventType: string;
+    id: number;
+    messages: NotificationDiagnosticLogMessage[];
+    recipients: {
+        [key: string]: DiagnosticRecipient;
+    };
+    result: string;
+    subscriptionId: string;
+}
+export interface DiagnosticRecipient {
+    recipient: DiagnosticIdentity;
+    status: string;
+}
 export interface EmailHtmlSubscriptionChannel extends SubscriptionChannelWithAddress {
@@ -90,2 +110,20 @@ type: string;
 }
+export interface EventBatch {
+    endTime: any;
+    eventCounts: {
+        [key: string]: number;
+    };
+    firstEventId: number;
+    notificationCounts: {
+        [key: string]: number;
+    };
+    startTime: any;
+    subscriptionCounts: {
+        [key: string]: number;
+    };
+}
+export interface EventProcessingLog extends NotificationJobDiagnosticLog {
+    batches: EventBatch[];
+    matcherResults: MatcherResult[];
+}
 /**
@@ -182,5 +220,24 @@ * Set of flags used to determine which set of information is retrieved when querying for event publishers
 }
+export interface GeneratedNotification {
+    recipients: DiagnosticIdentity[];
+}
 export interface GroupSubscriptionChannel extends SubscriptionChannelWithAddress {
     type: string;
 }
+/**
+ * Abstraction interface for the diagnostic log.  Primarily for deserialization.
+ */
+export interface INotificationDiagnosticLog {
+    activityId: string;
+    description: string;
+    endTime: Date;
+    id: string;
+    logType: string;
+    messages: NotificationDiagnosticLogMessage[];
+    properties: {
+        [key: string]: string;
+    };
+    source: string;
+    startTime: Date;
+}
 export interface ISubscriptionChannel {
@@ -193,2 +250,10 @@ type: string;
 }
+export interface MatcherResult {
+    matcher: string;
+    stats: {
+        [key: string]: {
+            [key: string]: number;
+        };
+    };
+}
 export interface MessageQueueSubscriptionChannel {
@@ -210,2 +275,9 @@ type: string;
 }
+export interface NotificationBatch {
+    endTime: any;
+    firstNotificationId: number;
+    notificationCount: number;
+    problematicNotifications: DiagnosticNotification[];
+    startTime: any;
+}
 export interface NotificationCommonViewData {
@@ -252,2 +324,40 @@ /**
 }
+export interface NotificationDeliveryLog extends NotificationJobDiagnosticLog {
+    batches: NotificationBatch[];
+}
+/**
+ * Abstract base class for all of the diagnostic logs.
+ */
+export interface NotificationDiagnosticLog {
+    /**
+     * Identifier used for correlating to other diagnostics that may have been recorded elsewhere.
+     */
+    activityId: string;
+    description: string;
+    endTime: Date;
+    errors: number;
+    /**
+     * Unique instance identifier.
+     */
+    id: string;
+    logType: string;
+    messages: NotificationDiagnosticLogMessage[];
+    properties: {
+        [key: string]: string;
+    };
+    /**
+     * This identifier depends on the logType.  For notification jobs, this will be the job Id. For subscription tracing, this will be a special root Guid with the subscription Id encoded.
+     */
+    source: string;
+    startTime: Date;
+    warnings: number;
+}
+export interface NotificationDiagnosticLogMessage {
+    /**
+     * Corresponds to .Net TraceLevel enumeration
+     */
+    level: number;
+    message: string;
+    time: any;
+}
 export interface NotificationEventBacklogStatus {
@@ -389,2 +499,10 @@ eventBacklogStatus: EventBacklogStatus[];
 }
+export interface NotificationJobDiagnosticLog extends NotificationDiagnosticLog {
+    result: string;
+    stats: {
+        [key: string]: {
+            [key: string]: number;
+        };
+    };
+}
 export enum NotificationOperation {
@@ -541,2 +659,6 @@ None = 0,
     /**
+     * Diagnostics for this subscription.
+     */
+    diagnostics: SubscriptionDiagnostics;
+    /**
      * Any extra properties like detailed description for different contexts, user/group contexts
@@ -703,2 +825,26 @@ */
 }
+export interface ProcessedEvent {
+    /**
+     * All of the users that were associtated with this event and their role.
+     */
+    actors: VSS_Common_Contracts.EventActor[];
+    allowedChannels: string;
+    artifactUri: string;
+    /**
+     * Evaluations for each user
+     */
+    evaluations: {
+        [key: string]: SubscriptionEvaluation;
+    };
+    eventId: number;
+    /**
+     * Which members were excluded from evaluation (only applies to ActorMatcher subscriptions)
+     */
+    exclusions: VSS_Common_Contracts.EventActor[];
+    /**
+     * Which members were included for evaluation (only applies to ActorMatcher subscriptions)
+     */
+    inclusions: VSS_Common_Contracts.EventActor[];
+    notifications: GeneratedNotification[];
+}
 export interface RoleBasedFilter extends ExpressionFilter {
@@ -762,2 +908,16 @@ exclusions: string[];
 }
+export interface SubscriptionDiagnostics {
+    deliveryResults: SubscriptionTracing;
+    deliveryTracing: SubscriptionTracing;
+    evaluationTracing: SubscriptionTracing;
+}
+export interface SubscriptionEvaluation {
+    clauses: SubscriptionEvaluationClause[];
+    user: DiagnosticIdentity;
+}
+export interface SubscriptionEvaluationClause {
+    clause: string;
+    order: number;
+    result: boolean;
+}
 /**
@@ -1054,2 +1214,45 @@ * Encapsulates the properties of a SubscriptionEvaluationRequest. It defines the subscription to be evaluated and time interval for events used in evaluation.
 }
+export interface SubscriptionTraceDiagnosticLog extends NotificationDiagnosticLog {
+    /**
+     * Indicates the job Id that processed or delivered this subscription
+     */
+    jobId: string;
+    /**
+     * Indicates unique instance identifier for the job that processed or delivered this subscription
+     */
+    jobInstanceId: string;
+    subscriptionId: string;
+}
+export interface SubscriptionTraceEventProcessingLog extends SubscriptionTraceDiagnosticLog {
+    channel: string;
+    /**
+     * Which members opted out from receiving notifications from this subscription
+     */
+    optedOut: DiagnosticIdentity[];
+    processedEvents: {
+        [key: number]: ProcessedEvent;
+    };
+}
+export interface SubscriptionTraceNotificationDeliveryLog extends SubscriptionTraceDiagnosticLog {
+    notifications: DiagnosticNotification[];
+}
+export interface SubscriptionTracing {
+    enabled: boolean;
+    /**
+     * Trace until the specified end date.
+     */
+    endDate: Date;
+    /**
+     * The maximum number of result details to trace.
+     */
+    maxTracedEntries: number;
+    /**
+     * The date and time tracing started.
+     */
+    startDate: Date;
+    /**
+     * Trace until remaining count reaches 0.
+     */
+    tracedEntries: number;
+}
 /**
@@ -1070,2 +1273,10 @@ * User-managed settings for a group subscription.
 }
+export interface UpdateSubscripitonDiagnosticsParameters {
+    deliveryResults: UpdateSubscripitonTracingParameters;
+    deliveryTracing: UpdateSubscripitonTracingParameters;
+    evaluationTracing: UpdateSubscripitonTracingParameters;
+}
+export interface UpdateSubscripitonTracingParameters {
+    enabled: boolean;
+}
 export interface UserSubscriptionChannel extends SubscriptionChannelWithAddress {
@@ -1109,2 +1320,3 @@ type: string;
     };
+    EventProcessingLog: any;
     EventPublisherQueryFlags: {
@@ -1122,7 +1334,11 @@ enumValues: {
     };
+    INotificationDiagnosticLog: any;
     NotificationAdminSettings: any;
     NotificationCommonViewData: any;
+    NotificationDeliveryLog: any;
+    NotificationDiagnosticLog: any;
     NotificationEventField: any;
     NotificationEventFieldType: any;
     NotificationEventType: any;
+    NotificationJobDiagnosticLog: any;
     NotificationOperation: {
@@ -1214,2 +1430,3 @@ enumValues: {
     };
+    SubscriptionDiagnostics: any;
     SubscriptionEvaluationRequest: any;
@@ -1299,2 +1516,6 @@ SubscriptionEvaluationResult: any;
     };
+    SubscriptionTraceDiagnosticLog: any;
+    SubscriptionTraceEventProcessingLog: any;
+    SubscriptionTraceNotificationDeliveryLog: any;
+    SubscriptionTracing: any;
 };
@@ -1471,3 +1692,2 @@ }
 export class CommonMethods3_2To4_1 extends CommonMethods3_1To4_1 {
-    protected subscriptionEvaluationRequestsApiVersion: string;
     protected userSettingsApiVersion: string;
@@ -1484,16 +1704,2 @@ constructor(rootRequestPath: string, options?: VSS_WebApi.IVssHttpClientOptions);
     updateSubscriptionUserSettings(userSettings: Contracts.SubscriptionUserSettings, subscriptionId: string, userId: string): IPromise<Contracts.SubscriptionUserSettings>;
-    /**
-     * [Preview API]
-     *
-     * @param {string} requestId
-     * @return IPromise<Contracts.SubscriptionEvaluationResult>
-     */
-    getSubscriptionEvaluationResults(requestId: string): IPromise<Contracts.SubscriptionEvaluationResult>;
-    /**
-     * [Preview API]
-     *
-     * @param {Contracts.SubscriptionEvaluationRequest} subscriptionEvaluationRequest
-     * @return IPromise<Contracts.SubscriptionEvaluationResult>
-     */
-    evaluateSubscription(subscriptionEvaluationRequest: Contracts.SubscriptionEvaluationRequest): IPromise<Contracts.SubscriptionEvaluationResult>;
 }
@@ -1525,2 +1731,27 @@ export class CommonMethods4To4_1 extends CommonMethods3_2To4_1 {
     constructor(rootRequestPath: string, options?: VSS_WebApi.IVssHttpClientOptions);
+    /**
+     * [Preview API] List diagnostic logs this service.
+     *
+     * @param {string} source
+     * @param {string} entryId
+     * @param {Date} startTime
+     * @param {Date} endTime
+     * @return IPromise<Contracts.INotificationDiagnosticLog[]>
+     */
+    listLogs(source: string, entryId?: string, startTime?: Date, endTime?: Date): IPromise<Contracts.INotificationDiagnosticLog[]>;
+    /**
+     * [Preview API]
+     *
+     * @param {string} subscriptionId
+     * @return IPromise<Contracts.SubscriptionDiagnostics>
+     */
+    getSubscriptionDiagnostics(subscriptionId: string): IPromise<Contracts.SubscriptionDiagnostics>;
+    /**
+     * [Preview API]
+     *
+     * @param {Contracts.UpdateSubscripitonDiagnosticsParameters} updateParameters
+     * @param {string} subscriptionId
+     * @return IPromise<Contracts.SubscriptionDiagnostics>
+     */
+    updateSubscriptionDiagnostics(updateParameters: Contracts.UpdateSubscripitonDiagnosticsParameters, subscriptionId: string): IPromise<Contracts.SubscriptionDiagnostics>;
 }
@@ -1557,5 +1788,5 @@ /**
  *
- * @return NotificationHttpClient4
+ * @return NotificationHttpClient4_1
  */
-export function getClient(options?: VSS_WebApi.IVssHttpClientOptions): NotificationHttpClient4;
+export function getClient(options?: VSS_WebApi.IVssHttpClientOptions): NotificationHttpClient4_1;
 }
@@ -1562,0 +1793,0 @@ declare module "Notifications/Services" {

No alert changes

Improved metrics

Total package byte prevSize

2697161

increased by5.99%

Number of package files

15

increased by7.14%

Lines of code

74848

increased by5.22%

Dependency changes

• + Added@types/react@15.7.30(transitive)

• - Removed@types/react@19.0.10(transitive)

• - Removedcsstype@3.1.3(transitive)

• Updated@types/knockout@^3.4.49

• Updated@types/react@^15.6.12