@emilgroup/notification-sdk-node 1.2.0 → 1.3.0

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/notification-sdk-node@1.2.0 --save
+npm install @emilgroup/notification-sdk-node@1.3.0 --save
 ```
 or 
 ```
-yarn add @emilgroup/notification-sdk-node@1.2.0
+yarn add @emilgroup/notification-sdk-node@1.3.0
 ```
 
 And then you can import `LayoutApi`.
@@ -47,6 +47,22 @@ export EMIL_USERNAME=XXXXX@XXXX.XXX
 export EMIL_PASSWORD=XXXXXXXXXXXXXX
 ```
 
+## Base path
+
+To select the basic path for using the API, we can use two approaches. The first is to use one of the predefined environments, and the second is to specify the domain as a string.
+
+```ts
+import { LayoutApi, Environment } from '@emilgroup/notification-sdk-node'
+
+const LayoutsApi = new LayoutApi();
+
+// Allows you to simply choose environment. It will usually be Environment.Production.
+LayoutsApi.selectEnvironment(Environment.Production);
+
+// For advanced users, use the custom baseUrl of the website you need to connect to.
+LayoutsApi.selectBasePath('https://my-custom-domain.com');
+```
+
 ## Example
 
 Here is a basic functionning example:

package/base.ts

@@ -41,7 +41,7 @@ export const COLLECTION_FORMATS = {
 
 export interface LoginClass {
     accessToken: string;
-    permissions: Array<string>;
+    permissions: string;
 }
 
 export enum Environment {
@@ -79,6 +79,7 @@ export class BaseAPI {
     protected configuration: Configuration;
     private username?: string;
     private password?: string;
+    private permissions?: string;
 
     constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
         if (configuration) {
@@ -149,6 +150,10 @@ export class BaseAPI {
         this.configuration.basePath = env;
     }
 
+    getPermissions(): Array<string> {
+        return this.permissions.split(',');
+    }
+
     async authorize(username: string, password: string): Promise<void> {
         const options: AxiosRequestConfig = {
             method: 'POST',
@@ -163,20 +168,21 @@ export class BaseAPI {
 
         const response = await globalAxios.request<LoginClass>(options);
 
-        const { data: { accessToken } } = response;
+        const { data: { accessToken, permissions } } = response;
         this.configuration.username = username;
         this.configuration.accessToken = `Bearer ${accessToken}`;
+        this.permissions = permissions;
 
         const refreshToken = this.extractRefreshToken(response)
         this.configuration.refreshToken = refreshToken;
     }
 
-    async refreshTokenInternal(): Promise<string> {
+    async refreshTokenInternal(): Promise<LoginClass> {
         const { username, refreshToken } = this.configuration;
         
 
         if (!username || !refreshToken) {
-            return '';
+            throw new Error('Failed to refresh token.');
         }
 
         const options: AxiosRequestConfig = {
@@ -190,9 +196,9 @@ export class BaseAPI {
             withCredentials: true,
         };
 
-        const { data: { accessToken } } = await globalAxios.request<LoginClass>(options);
+        const response = await globalAxios.request<LoginClass>(options);
 
-        return accessToken;
+        return response.data;
     }
 
     private extractRefreshToken(response: AxiosResponse): string {
@@ -221,8 +227,9 @@ export class BaseAPI {
                     if (err.response.status === 401 && !originalConfig._retry) {
                         originalConfig._retry = true;
                         try {
-                            const tokenString = await this.refreshTokenInternal();
+                            const { accessToken: tokenString, permissions } = await this.refreshTokenInternal();
                             const accessToken = `Bearer ${tokenString}`;
+                            this.permissions = permissions;
 
                             originalConfig.headers['Authorization'] = `Bearer ${accessToken}`
 
@@ -246,8 +253,9 @@ export class BaseAPI {
                 ){ 
                     _retry_count++;
                     try {
-                        const tokenString = await this.refreshTokenInternal();
+                        const { accessToken: tokenString, permissions } = await this.refreshTokenInternal();
                         const accessToken = `Bearer ${tokenString}`;
+                        this.permissions = permissions;
 
                         _retry = true;
                         originalConfig.headers['Authorization'] = accessToken; 

package/dist/base.d.ts

@@ -24,7 +24,7 @@ export declare const COLLECTION_FORMATS: {
 };
 export interface LoginClass {
     accessToken: string;
-    permissions: Array<string>;
+    permissions: string;
 }
 export declare enum Environment {
     Production = "https://apiv2.emil.de",
@@ -53,14 +53,16 @@ export declare class BaseAPI {
     protected configuration: Configuration;
     private username?;
     private password?;
+    private permissions?;
     constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
     initialize(env?: Environment): Promise<void>;
     private loadCredentials;
     private readConfigFile;
     private readEnvVariables;
     selectEnvironment(env: Environment): void;
+    getPermissions(): Array<string>;
     authorize(username: string, password: string): Promise<void>;
-    refreshTokenInternal(): Promise<string>;
+    refreshTokenInternal(): Promise<LoginClass>;
     private extractRefreshToken;
     getConfiguration(): Configuration;
     private attachInterceptor;

package/dist/base.js

@@ -242,11 +242,14 @@ var BaseAPI = /** @class */ (function () {
     BaseAPI.prototype.selectEnvironment = function (env) {
         this.configuration.basePath = env;
     };
+    BaseAPI.prototype.getPermissions = function () {
+        return this.permissions.split(',');
+    };
     BaseAPI.prototype.authorize = function (username, password) {
         return __awaiter(this, void 0, void 0, function () {
-            var options, response, accessToken, refreshToken;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var options, response, _a, accessToken, permissions, refreshToken;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
                         options = {
                             method: 'POST',
@@ -260,10 +263,11 @@ var BaseAPI = /** @class */ (function () {
                         };
                         return [4 /*yield*/, axios_1.default.request(options)];
                     case 1:
-                        response = _a.sent();
-                        accessToken = response.data.accessToken;
+                        response = _b.sent();
+                        _a = response.data, accessToken = _a.accessToken, permissions = _a.permissions;
                         this.configuration.username = username;
                         this.configuration.accessToken = "Bearer ".concat(accessToken);
+                        this.permissions = permissions;
                         refreshToken = this.extractRefreshToken(response);
                         this.configuration.refreshToken = refreshToken;
                         return [2 /*return*/];
@@ -273,13 +277,13 @@ var BaseAPI = /** @class */ (function () {
     };
     BaseAPI.prototype.refreshTokenInternal = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var _a, username, refreshToken, options, accessToken;
+            var _a, username, refreshToken, options, response;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
                         _a = this.configuration, username = _a.username, refreshToken = _a.refreshToken;
                         if (!username || !refreshToken) {
-                            return [2 /*return*/, ''];
+                            throw new Error('Failed to refresh token.');
                         }
                         options = {
                             method: 'POST',
@@ -293,8 +297,8 @@ var BaseAPI = /** @class */ (function () {
                         };
                         return [4 /*yield*/, axios_1.default.request(options)];
                     case 1:
-                        accessToken = (_b.sent()).data.accessToken;
-                        return [2 /*return*/, accessToken];
+                        response = _b.sent();
+                        return [2 /*return*/, response.data];
                 }
             });
         });
@@ -314,26 +318,27 @@ var BaseAPI = /** @class */ (function () {
         axios.interceptors.response.use(function (res) {
             return res;
         }, function (err) { return __awaiter(_this, void 0, void 0, function () {
-            var originalConfig, tokenString, accessToken, _error_1, tokenString, accessToken, _error_2;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var originalConfig, _a, tokenString, permissions, accessToken, _error_1, _b, tokenString, permissions, accessToken, _error_2;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
                         originalConfig = err.config;
                         if (!err.response) return [3 /*break*/, 5];
                         if (!(err.response.status === 401 && !originalConfig._retry)) return [3 /*break*/, 4];
                         originalConfig._retry = true;
-                        _a.label = 1;
+                        _c.label = 1;
                     case 1:
-                        _a.trys.push([1, 3, , 4]);
+                        _c.trys.push([1, 3, , 4]);
                         return [4 /*yield*/, this.refreshTokenInternal()];
                     case 2:
-                        tokenString = _a.sent();
+                        _a = _c.sent(), tokenString = _a.accessToken, permissions = _a.permissions;
                         accessToken = "Bearer ".concat(tokenString);
+                        this.permissions = permissions;
                         originalConfig.headers['Authorization'] = "Bearer ".concat(accessToken);
                         this.configuration.accessToken = accessToken;
                         return [2 /*return*/, axios.request(originalConfig)];
                     case 3:
-                        _error_1 = _a.sent();
+                        _error_1 = _c.sent();
                         if (_error_1.response && _error_1.response.data) {
                             return [2 /*return*/, Promise.reject(_error_1.response.data)];
                         }
@@ -349,19 +354,20 @@ var BaseAPI = /** @class */ (function () {
                             && originalConfig.headers.hasOwnProperty('Authorization')
                             && _retry_count < 4)) return [3 /*break*/, 9];
                         _retry_count++;
-                        _a.label = 6;
+                        _c.label = 6;
                     case 6:
-                        _a.trys.push([6, 8, , 9]);
+                        _c.trys.push([6, 8, , 9]);
                         return [4 /*yield*/, this.refreshTokenInternal()];
                     case 7:
-                        tokenString = _a.sent();
+                        _b = _c.sent(), tokenString = _b.accessToken, permissions = _b.permissions;
                         accessToken = "Bearer ".concat(tokenString);
+                        this.permissions = permissions;
                         _retry = true;
                         originalConfig.headers['Authorization'] = accessToken;
                         this.configuration.accessToken = accessToken;
                         return [2 /*return*/, axios.request(__assign({}, originalConfig))];
                     case 8:
-                        _error_2 = _a.sent();
+                        _error_2 = _c.sent();
                         if (_error_2.response && _error_2.response.data) {
                             return [2 /*return*/, Promise.reject(_error_2.response.data)];
                         }

package/dist/models/send-notification-request-dto.d.ts

@@ -57,6 +57,12 @@ export interface SendNotificationRequestDto {
      * @memberof SendNotificationRequestDto
      */
     'attachments': Array<string>;
+    /**
+     * It is possible to use the product slug to fetch a different senderEmail from the tenant settings.      It should be in the form of productSlug_sender-email
+     * @type {string}
+     * @memberof SendNotificationRequestDto
+     */
+    'productSlug'?: string;
     /**
      * Payload is used by the template engine to replace all template variables with proper data.      For more information, please go to https://github.com/flosch/pongo2.
      * @type {object}

package/models/send-notification-request-dto.ts

@@ -62,6 +62,12 @@ export interface SendNotificationRequestDto {
      * @memberof SendNotificationRequestDto
      */
     'attachments': Array<string>;
+    /**
+     * It is possible to use the product slug to fetch a different senderEmail from the tenant settings.      It should be in the form of productSlug_sender-email
+     * @type {string}
+     * @memberof SendNotificationRequestDto
+     */
+    'productSlug'?: string;
     /**
      * Payload is used by the template engine to replace all template variables with proper data.      For more information, please go to https://github.com/flosch/pongo2.
      * @type {object}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emilgroup/notification-sdk-node",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "OpenAPI client for @emilgroup/notification-sdk-node",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [