@pallasoft/ps-mail 1.1.0 → 1.2.0

package/README.md

@@ -13,6 +13,9 @@ permissions `Mail.ReadWrite` and `Mail.Send`).
 - `GraphMailService.sendMail`, `createAndSend` and `reply` send mail from the mailbox; `reply` stays
   in the conversation.
 - `GraphMailService.setCategories` tags a message for people working in Outlook.
+- `GraphMailService.subscribe` / `renewSubscription` / `deleteSubscription` manage Graph change
+  notification subscriptions for a folder (`GraphMailLifecycleEvent` names the lifecycle events;
+  `GraphMailNotificationPayloadData` is the webhook body).
 - `GraphMailErrorService.isSyncStateExpired(error)` tells the caller to drop its delta link and
   resync. Throttling (429/503 with `Retry-After`) and an expired token (401) are retried inside.
 

package/dist/microsoft/constants/graph-mail-config.d.ts

@@ -15,6 +15,7 @@ export declare const GraphMailConfig: {
         readonly messages: "messages";
         readonly send: "send";
         readonly sendMail: "sendMail";
+        readonly subscriptions: "subscriptions";
         readonly users: "users";
         readonly value: "$value";
     };
@@ -48,4 +49,7 @@ export declare const GraphMailConfig: {
         readonly rangeUnit: "bytes ";
     };
     readonly saveToSentItems: true;
+    readonly subscription: {
+        readonly changeType: "created,updated";
+    };
 };

package/dist/microsoft/constants/graph-mail-config.js

@@ -18,6 +18,7 @@ exports.GraphMailConfig = {
         messages: 'messages',
         send: 'send',
         sendMail: 'sendMail',
+        subscriptions: 'subscriptions',
         users: 'users',
         value: '$value',
     },
@@ -86,4 +87,7 @@ exports.GraphMailConfig = {
         rangeUnit: 'bytes ',
     },
     saveToSentItems: true,
+    subscription: {
+        changeType: 'created,updated',
+    },
 };

package/dist/microsoft/constants/graph-mail-lifecycle-event.d.ts

@@ -0,0 +1,5 @@
+export declare enum GraphMailLifecycleEvent {
+    Missed = "missed",
+    ReauthorizationRequired = "reauthorizationRequired",
+    SubscriptionRemoved = "subscriptionRemoved"
+}

package/dist/microsoft/constants/graph-mail-lifecycle-event.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GraphMailLifecycleEvent = void 0;
+var GraphMailLifecycleEvent;
+(function (GraphMailLifecycleEvent) {
+    GraphMailLifecycleEvent["Missed"] = "missed";
+    GraphMailLifecycleEvent["ReauthorizationRequired"] = "reauthorizationRequired";
+    GraphMailLifecycleEvent["SubscriptionRemoved"] = "subscriptionRemoved";
+})(GraphMailLifecycleEvent || (exports.GraphMailLifecycleEvent = GraphMailLifecycleEvent = {}));

package/dist/microsoft/constants/index.d.ts

@@ -3,3 +3,4 @@ export * from './graph-mail-config';
 export * from './graph-mail-error-messages';
 export * from './graph-mail-error-reason';
 export * from './graph-mail-folder';
+export * from './graph-mail-lifecycle-event';

package/dist/microsoft/constants/index.js

@@ -19,3 +19,4 @@ __exportStar(require("./graph-mail-config"), exports);
 __exportStar(require("./graph-mail-error-messages"), exports);
 __exportStar(require("./graph-mail-error-reason"), exports);
 __exportStar(require("./graph-mail-folder"), exports);
+__exportStar(require("./graph-mail-lifecycle-event"), exports);

package/dist/microsoft/index.d.ts

@@ -1,3 +1,3 @@
-export { GraphMailBodyType, GraphMailErrorReason, GraphMailFolder } from './constants';
+export { GraphMailBodyType, GraphMailErrorReason, GraphMailFolder, GraphMailLifecycleEvent, } from './constants';
 export { GraphMailErrorService, GraphMailService } from './services';
-export type { GraphCredentials, GraphMailBodyData, GraphMailConnection, GraphMailDeltaData, GraphMailDeltaOptions, GraphMailDeltaPageData, GraphMailDraftData, GraphMailErrorData, GraphMailFileData, GraphMailHeaderData, GraphMailMessageData, GraphMailRecipientData, GraphMailRemovedData, GraphMailReplyData, GraphMailUploadSessionData, } from './models';
+export type { GraphCredentials, GraphMailBodyData, GraphMailConnection, GraphMailDeltaData, GraphMailDeltaOptions, GraphMailDeltaPageData, GraphMailDraftData, GraphMailErrorData, GraphMailFileData, GraphMailHeaderData, GraphMailMessageData, GraphMailNotificationData, GraphMailNotificationPayloadData, GraphMailRecipientData, GraphMailRemovedData, GraphMailReplyData, GraphMailSubscriptionData, GraphMailSubscriptionOptions, GraphMailUploadSessionData, } from './models';

package/dist/microsoft/index.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GraphMailService = exports.GraphMailErrorService = exports.GraphMailFolder = exports.GraphMailErrorReason = exports.GraphMailBodyType = void 0;
+exports.GraphMailService = exports.GraphMailErrorService = exports.GraphMailLifecycleEvent = exports.GraphMailFolder = exports.GraphMailErrorReason = exports.GraphMailBodyType = void 0;
 var constants_1 = require("./constants");
 Object.defineProperty(exports, "GraphMailBodyType", { enumerable: true, get: function () { return constants_1.GraphMailBodyType; } });
 Object.defineProperty(exports, "GraphMailErrorReason", { enumerable: true, get: function () { return constants_1.GraphMailErrorReason; } });
 Object.defineProperty(exports, "GraphMailFolder", { enumerable: true, get: function () { return constants_1.GraphMailFolder; } });
+Object.defineProperty(exports, "GraphMailLifecycleEvent", { enumerable: true, get: function () { return constants_1.GraphMailLifecycleEvent; } });
 var services_1 = require("./services");
 Object.defineProperty(exports, "GraphMailErrorService", { enumerable: true, get: function () { return services_1.GraphMailErrorService; } });
 Object.defineProperty(exports, "GraphMailService", { enumerable: true, get: function () { return services_1.GraphMailService; } });

package/dist/microsoft/models/graph-mail-notification-data.d.ts

@@ -0,0 +1,7 @@
+export interface GraphMailNotificationData {
+    subscriptionId: string;
+    clientState?: string;
+    changeType?: string;
+    lifecycleEvent?: string;
+    resource?: string;
+}

package/dist/microsoft/models/graph-mail-notification-data.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/microsoft/models/graph-mail-notification-payload-data.d.ts

@@ -0,0 +1,4 @@
+import type { GraphMailNotificationData } from './graph-mail-notification-data';
+export interface GraphMailNotificationPayloadData {
+    value: GraphMailNotificationData[];
+}

package/dist/microsoft/models/graph-mail-notification-payload-data.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/microsoft/models/graph-mail-subscription-data.d.ts

@@ -0,0 +1,5 @@
+export interface GraphMailSubscriptionData {
+    id: string;
+    resource: string;
+    expirationDateTime: string;
+}

package/dist/microsoft/models/graph-mail-subscription-data.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/microsoft/models/graph-mail-subscription-options.d.ts

@@ -0,0 +1,6 @@
+export interface GraphMailSubscriptionOptions {
+    notificationUrl: string;
+    lifecycleNotificationUrl: string;
+    clientState: string;
+    expiresAt: Date;
+}

package/dist/microsoft/models/graph-mail-subscription-options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/microsoft/models/graph-mail-subscription-renew-request.d.ts

@@ -0,0 +1,3 @@
+export interface GraphMailSubscriptionRenewRequest {
+    expirationDateTime: string;
+}

package/dist/microsoft/models/graph-mail-subscription-renew-request.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/microsoft/models/graph-mail-subscription-request.d.ts

@@ -0,0 +1,8 @@
+export interface GraphMailSubscriptionRequest {
+    changeType: string;
+    notificationUrl: string;
+    lifecycleNotificationUrl: string;
+    resource: string;
+    expirationDateTime: string;
+    clientState: string;
+}

package/dist/microsoft/models/graph-mail-subscription-request.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/microsoft/models/index.d.ts

@@ -16,12 +16,18 @@ export type { GraphMailFileAttachmentRequest } from './graph-mail-file-attachmen
 export type { GraphMailFileData } from './graph-mail-file-data';
 export type { GraphMailHeaderData } from './graph-mail-header-data';
 export type { GraphMailMessageData } from './graph-mail-message-data';
+export type { GraphMailNotificationData } from './graph-mail-notification-data';
+export type { GraphMailNotificationPayloadData } from './graph-mail-notification-payload-data';
 export type { GraphMailOutgoingMessageData } from './graph-mail-outgoing-message-data';
 export type { GraphMailRecipientData } from './graph-mail-recipient-data';
 export type { GraphMailRemovedData } from './graph-mail-removed-data';
 export type { GraphMailReplyData } from './graph-mail-reply-data';
 export type { GraphMailReplyRequest } from './graph-mail-reply-request';
 export type { GraphMailSendRequest } from './graph-mail-send-request';
+export type { GraphMailSubscriptionData } from './graph-mail-subscription-data';
+export type { GraphMailSubscriptionOptions } from './graph-mail-subscription-options';
+export type { GraphMailSubscriptionRenewRequest } from './graph-mail-subscription-renew-request';
+export type { GraphMailSubscriptionRequest } from './graph-mail-subscription-request';
 export type { GraphMailUploadItemData } from './graph-mail-upload-item-data';
 export type { GraphMailUploadSessionData } from './graph-mail-upload-session-data';
 export type { GraphMailUploadSessionRequest } from './graph-mail-upload-session-request';

package/dist/microsoft/services/graph-mail-service.d.ts

@@ -10,6 +10,8 @@ import type { GraphMailDraftData } from '../models/graph-mail-draft-data';
 import type { GraphMailFileData } from '../models/graph-mail-file-data';
 import type { GraphMailMessageData } from '../models/graph-mail-message-data';
 import type { GraphMailReplyData } from '../models/graph-mail-reply-data';
+import type { GraphMailSubscriptionData } from '../models/graph-mail-subscription-data';
+import type { GraphMailSubscriptionOptions } from '../models/graph-mail-subscription-options';
 import type { GraphMailUploadSessionData } from '../models/graph-mail-upload-session-data';
 export declare class GraphMailService {
     static deltaPage(connection: GraphMailConnection, folder: GraphMailFolder, link: string | null, options?: GraphMailDeltaOptions): Promise<GraphMailDeltaPageData>;
@@ -23,6 +25,9 @@ export declare class GraphMailService {
     static createUploadSession(connection: GraphMailConnection, messageId: string, file: GraphMailFileData): Promise<GraphMailUploadSessionData>;
     static reply(connection: GraphMailConnection, messageId: string, reply: GraphMailReplyData): Promise<MailSentData>;
     static setCategories(connection: GraphMailConnection, messageId: string, categories: string[]): Promise<void>;
+    static subscribe(connection: GraphMailConnection, folder: GraphMailFolder, options: GraphMailSubscriptionOptions): Promise<GraphMailSubscriptionData>;
+    static renewSubscription(connection: GraphMailConnection, subscriptionId: string, expiresAt: Date): Promise<GraphMailSubscriptionData>;
+    static deleteSubscription(connection: GraphMailConnection, subscriptionId: string): Promise<void>;
     private static _attach;
     private static _send;
     private static _deltaStart;

package/dist/microsoft/services/graph-mail-service.js

@@ -337,6 +337,46 @@ var GraphMailService = /** @class */ (function () {
             });
         });
     };
+    GraphMailService.subscribe = function (connection, folder, options) {
+        var request = {
+            changeType: graph_mail_config_1.GraphMailConfig.subscription.changeType,
+            clientState: options.clientState,
+            expirationDateTime: options.expiresAt.toISOString(),
+            lifecycleNotificationUrl: options.lifecycleNotificationUrl,
+            notificationUrl: options.notificationUrl,
+            resource: mail_url_service_1.MailUrlService.path(this._mailboxPath(connection), graph_mail_config_1.GraphMailConfig.paths.mailFolders, folder, graph_mail_config_1.GraphMailConfig.paths.messages).slice(mail_http_config_1.MailHttpConfig.pathSeparator.length),
+        };
+        return graph_request_service_1.GraphRequestService.json(connection, {
+            method: ps_utilities_1.HttpMethod.Post,
+            url: mail_url_service_1.MailUrlService.path('', graph_mail_config_1.GraphMailConfig.paths.subscriptions),
+            body: request,
+        });
+    };
+    GraphMailService.renewSubscription = function (connection, subscriptionId, expiresAt) {
+        var request = {
+            expirationDateTime: expiresAt.toISOString(),
+        };
+        return graph_request_service_1.GraphRequestService.json(connection, {
+            method: ps_utilities_1.HttpMethod.Patch,
+            url: mail_url_service_1.MailUrlService.path('', graph_mail_config_1.GraphMailConfig.paths.subscriptions, subscriptionId),
+            body: request,
+        });
+    };
+    GraphMailService.deleteSubscription = function (connection, subscriptionId) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, graph_request_service_1.GraphRequestService.send(connection, {
+                            method: ps_utilities_1.HttpMethod.Delete,
+                            url: mail_url_service_1.MailUrlService.path('', graph_mail_config_1.GraphMailConfig.paths.subscriptions, subscriptionId),
+                        })];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     GraphMailService._attach = function (connection, messageId, files) {
         return __awaiter(this, void 0, void 0, function () {
             var _i, files_1, file;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pallasoft/ps-mail",
-	"version": "1.1.0",
+	"version": "1.2.0",
 	"private": false,
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",