@quatrain/messaging 1.0.1 → 1.0.3

package/lib/AbstractMessagingAdapter.d.ts

@@ -1,12 +1,5 @@
-import { MessagingInterface } from './types/MessagingInterface';
-import { NotificationMessage } from './types/NotificationMessage';
-import { MessagingRecipient } from './types/MessagingRecipient';
 import { MessagingParameters } from './Messaging';
-export declare abstract class AbstractMessagingAdapter implements MessagingInterface {
-    protected _alias: string;
+export declare abstract class AbstractMessagingAdapter {
     protected _params: MessagingParameters;
     constructor(params?: MessagingParameters);
-    set alias(alias: string);
-    get alias(): string;
-    abstract sendNotification(recipient: MessagingRecipient, message: NotificationMessage): Promise<any>;
 }

package/lib/AbstractMessagingAdapter.js

@@ -3,15 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AbstractMessagingAdapter = void 0;
 class AbstractMessagingAdapter {
     constructor(params = {}) {
-        this._alias = '';
         this._params = {};
         this._params = params;
     }
-    set alias(alias) {
-        this._alias = alias;
-    }
-    get alias() {
-        return this._alias;
-    }
 }
 exports.AbstractMessagingAdapter = AbstractMessagingAdapter;

package/lib/MessageFormatter.d.ts

@@ -0,0 +1,4 @@
+export declare class MessageFormatter {
+    static formatTitle(title: string): string;
+    static formatBody(body: string, data?: {}): string;
+}

package/lib/MessageFormatter.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageFormatter = void 0;
+const mustache_1 = __importDefault(require("mustache"));
+class MessageFormatter {
+    static formatTitle(title) {
+        return title.replace(/(<([^>]+)>)/gi, '');
+    }
+    static formatBody(body, data) {
+        return mustache_1.default.render(body, data);
+    }
+}
+exports.MessageFormatter = MessageFormatter;

package/lib/Messaging.d.ts

@@ -1,8 +1,8 @@
 import { Core } from '@quatrain/core';
-import { AbstractMessagingAdapter } from './AbstractMessagingAdapter';
-export interface MessagingAdapter extends AbstractMessagingAdapter {
-}
-export type MessagingRegistry<T extends AbstractMessagingAdapter> = {
+import { NotificationCapableAdapter } from './types/NotificationCapableAdapter';
+import { EmailCapableAdapter } from './types/EmailCapableAdapter';
+import { TextCapableAdapter } from './types/TextCapableAdapter';
+export type MessagingRegistry<T extends NotificationCapableAdapter | EmailCapableAdapter | TextCapableAdapter> = {
     [x: string]: T;
 };
 export interface MessagingParameters {
@@ -10,9 +10,9 @@ export interface MessagingParameters {
     debug?: boolean;
 }
 export declare class Messaging extends Core {
-    static defaultProvider: string;
+    static defaultMessager: string;
     static logger: any;
-    protected static _providers: MessagingRegistry<any>;
-    static addProvider(provider: AbstractMessagingAdapter, alias: string, setDefault?: boolean): void;
-    static getProvider<T extends AbstractMessagingAdapter>(alias?: string): T;
+    protected static _messagers: MessagingRegistry<any>;
+    static addMessager(messager: NotificationCapableAdapter | EmailCapableAdapter | TextCapableAdapter, alias: string, setDefault?: boolean): void;
+    static getMessager(alias?: string): any;
 }

package/lib/Messaging.js

@@ -4,23 +4,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Messaging = void 0;
 const core_1 = require("@quatrain/core");
 class Messaging extends core_1.Core {
-    static addProvider(provider, alias, setDefault = false) {
-        this._providers[alias] = provider;
+    static addMessager(messager, alias, setDefault = false) {
+        this._messagers[alias] = messager;
         if (setDefault) {
-            this.defaultProvider = alias;
+            this.defaultMessager = alias;
         }
     }
-    static getProvider(alias = this.defaultProvider) {
-        if (this._providers[alias]) {
-            return this._providers[alias];
+    static getMessager(alias = this.defaultMessager) {
+        if (this._messagers[alias]) {
+            return this._messagers[alias];
         }
         else {
-            throw new Error(`Unknown provider alias: '${alias}'`);
+            throw new Error(`Unknown messager alias: '${alias}'`);
         }
     }
 }
 exports.Messaging = Messaging;
 _a = Messaging;
-Messaging.defaultProvider = 'default';
+Messaging.defaultMessager = 'default';
 Messaging.logger = _a.addLogger('Messaging');
-Messaging._providers = {};
+Messaging._messagers = {};

package/lib/index.d.ts

@@ -1,4 +1,9 @@
 import { Messaging, MessagingParameters } from './Messaging';
 import { AbstractMessagingAdapter } from './AbstractMessagingAdapter';
-import { MessagingInterface } from './types/MessagingInterface';
-export { Messaging, MessagingParameters, AbstractMessagingAdapter, MessagingInterface, };
+import { MessagingRecipient } from './types/MessagingRecipient';
+import { NotificationMessage } from './types/NotificationMessage';
+import { MessageType } from './types/MessageType';
+import { EmailCapableAdapter } from './types/EmailCapableAdapter';
+import { NotificationCapableAdapter } from './types/NotificationCapableAdapter';
+import { MessageFormatter } from './MessageFormatter';
+export { Messaging, MessagingParameters, AbstractMessagingAdapter, MessagingRecipient, NotificationMessage, MessageType, EmailCapableAdapter, NotificationCapableAdapter, MessageFormatter, };

package/lib/index.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AbstractMessagingAdapter = exports.Messaging = void 0;
+exports.MessageFormatter = exports.AbstractMessagingAdapter = exports.Messaging = void 0;
 const Messaging_1 = require("./Messaging");
 Object.defineProperty(exports, "Messaging", { enumerable: true, get: function () { return Messaging_1.Messaging; } });
 const AbstractMessagingAdapter_1 = require("./AbstractMessagingAdapter");
 Object.defineProperty(exports, "AbstractMessagingAdapter", { enumerable: true, get: function () { return AbstractMessagingAdapter_1.AbstractMessagingAdapter; } });
+const MessageFormatter_1 = require("./MessageFormatter");
+Object.defineProperty(exports, "MessageFormatter", { enumerable: true, get: function () { return MessageFormatter_1.MessageFormatter; } });

package/lib/types/AbstractMessage.d.ts

@@ -1,6 +1,6 @@
 export interface AbstractMessage {
     token?: string;
     title: string;
-    body?: string;
+    body: string;
     data?: any;
 }

package/lib/types/EmailCapableAdapter copy.d.ts

@@ -0,0 +1,6 @@
+import { MessagingRecipient } from './MessagingRecipient';
+import { NotificationMessage } from './NotificationMessage';
+export interface EmailCapableAdapter {
+    sendEmail(recipient: MessagingRecipient, message: NotificationMessage): Promise<any>;
+    sendEmails(recipients: MessagingRecipient[], message: NotificationMessage): Promise<any>;
+}

package/lib/types/EmailCapableAdapter.d.ts

@@ -0,0 +1,6 @@
+import { MessagingRecipient } from './MessagingRecipient';
+import { NotificationMessage } from './NotificationMessage';
+export interface EmailCapableAdapter {
+    sendEmail(recipient: MessagingRecipient, message: NotificationMessage): Promise<any>;
+    sendEmails(recipients: MessagingRecipient[], message: NotificationMessage): Promise<any>;
+}

package/lib/types/MessageType.d.ts

@@ -0,0 +1,6 @@
+export interface MessageType {
+    token?: string;
+    title: string;
+    body: string;
+    data?: any;
+}

package/lib/types/MessageType.js

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

package/lib/types/MessagingInterface.d.ts

@@ -2,4 +2,5 @@ import { AbstractMessage } from './AbstractMessage';
 import { MessagingRecipient } from './MessagingRecipient';
 export interface MessagingInterface {
     sendNotification(recipient: MessagingRecipient, message: AbstractMessage): Promise<any>;
+    sendNotifications(recipients: MessagingRecipient[], message: AbstractMessage): Promise<any>;
 }

package/lib/types/MessagingRecipient.d.ts

@@ -1,2 +1,6 @@
-import { UserType } from "@quatrain/core";
-export type MessagingRecipient = Pick<UserType, 'firstname' | 'lastname' | 'email' | 'messageToken'>;
+import { UserType } from '@quatrain/core';
+export type MessagingRecipient = Pick<UserType, 'firstname' | 'lastname' | 'email' | 'messageToken'> & {
+    data?: {
+        [x: string]: any;
+    };
+};

package/lib/types/MessagingTemplate.d.ts

@@ -0,0 +1 @@
+export type MessagingTemplate = {};

package/lib/types/MessagingTemplate.js

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

package/lib/types/NotificationCapableAdapter.d.ts

@@ -0,0 +1,6 @@
+import { MessagingRecipient } from './MessagingRecipient';
+import { NotificationMessage } from './NotificationMessage';
+export interface NotificationCapableAdapter {
+    sendNotification(recipient: MessagingRecipient, message: NotificationMessage): Promise<any>;
+    sendNotifications(recipients: MessagingRecipient[], message: NotificationMessage): Promise<any>;
+}

package/lib/types/NotificationCapableAdapter.js

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

package/lib/types/NotificationMessage.d.ts

@@ -1,3 +1,3 @@
-import { AbstractMessage } from './AbstractMessage';
-export interface NotificationMessage extends AbstractMessage {
+import { MessageType } from './MessageType';
+export interface NotificationMessage extends MessageType {
 }

package/lib/types/TextCapableAdapter.d.ts

@@ -0,0 +1,6 @@
+import { MessagingRecipient } from './MessagingRecipient';
+import { NotificationMessage } from './NotificationMessage';
+export interface TextCapableAdapter {
+    sendTextMessage(recipient: MessagingRecipient, message: NotificationMessage): Promise<any>;
+    sendTextMessages(recipients: MessagingRecipient[], message: NotificationMessage): Promise<any>;
+}

package/lib/types/TextCapableAdapter.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quatrain/messaging",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "license": "MIT",
   "description": "Messaging adapters commons",
   "main": "lib/index.js",
@@ -11,11 +11,13 @@
   ],
   "author": "Quatrain Développement SAS <developers@quatrain.com>",
   "dependencies": {
-    "@quatrain/core": "^1.1.19"
+    "@quatrain/core": "^1.1.19",
+    "mustache": "^4.2.0"
   },
   "devDependencies": {
     "@tsconfig/recommended": "^1.0.1",
     "@types/jest": "^27.0.3",
+    "@types/mustache": "^4",
     "@types/node": "^22.10.1",
     "jest": "^27.4.7",
     "jest-node-exports-resolver": "^1.1.6",

package/lib/AbstractAuthAdapter.d.ts

@@ -1,22 +0,0 @@
-import { AuthParameters, AuthParametersKeys } from './Auth';
-import { User } from '@quatrain/backend';
-import { AuthInterface } from './types/AuthInterface';
-export declare abstract class AbstractAuthAdapter implements AuthInterface {
-    static UserClass: typeof User;
-    protected _alias: string;
-    protected _params: AuthParameters;
-    constructor(params?: AuthParameters);
-    setParam(key: AuthParametersKeys, value: any): void;
-    getParam(key: AuthParametersKeys): any;
-    set alias(alias: string);
-    get alias(): string;
-    abstract register(user: User, clearPassword?: string): Promise<any>;
-    abstract signup(login: string, password: string): Promise<any>;
-    abstract signout(user: User): Promise<any>;
-    abstract update(user: User, updatable: any): Promise<any>;
-    abstract delete(user: User): Promise<any>;
-    abstract getAuthToken(token: string): any;
-    abstract refreshToken(refreshToken: string): Promise<any>;
-    abstract revokeAuthToken(token: string): any;
-    abstract setCustomUserClaims(id: string, claims: any): any;
-}

package/lib/AbstractAuthAdapter.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AbstractAuthAdapter = void 0;
-const backend_1 = require("@quatrain/backend");
-class AbstractAuthAdapter {
-    constructor(params = {}) {
-        this._alias = '';
-        this._params = {};
-        this._params = params;
-    }
-    setParam(key, value) {
-        this._params[key] = value;
-    }
-    getParam(key) {
-        return this._params[key];
-    }
-    set alias(alias) {
-        this._alias = alias;
-    }
-    get alias() {
-        return this._alias;
-    }
-}
-exports.AbstractAuthAdapter = AbstractAuthAdapter;
-AbstractAuthAdapter.UserClass = backend_1.User;

package/lib/Auth.d.ts

@@ -1,36 +0,0 @@
-import { Core } from '@quatrain/core';
-import { AbstractAuthAdapter } from './AbstractAuthAdapter';
-import Middleware from './middlewares/AuthMiddleware';
-export declare enum AuthAction {
-    SIGNIN = "signin",
-    SIGNUP = "signup",
-    SIGNOUT = "signout"
-}
-/**
- * Authentication Parameters acceptable keys
- */
-export type AuthParametersKeys = 'host' | 'alias' | 'middlewares' | 'config' | 'fixtures' | 'debug';
-/**
- * Backend parameters interface
- */
-export interface AuthParameters {
-    host?: string;
-    alias?: string;
-    middlewares?: Middleware[];
-    config?: any;
-    fixtures?: any;
-    debug?: boolean;
-}
-export interface AuthAdapter extends AbstractAuthAdapter {
-}
-export type AuthRegistry<T extends AbstractAuthAdapter> = {
-    [x: string]: T;
-};
-export declare class Auth extends Core {
-    static defaultProvider: string;
-    static logger: any;
-    static ERROR_EMAIL_EXISTS: string;
-    protected static _providers: AuthRegistry<any>;
-    static addProvider(provider: AbstractAuthAdapter, alias: string, setDefault?: boolean): void;
-    static getProvider<T extends AbstractAuthAdapter>(alias?: string): T;
-}

package/lib/Auth.js

@@ -1,33 +0,0 @@
-"use strict";
-var _a;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Auth = exports.AuthAction = void 0;
-const core_1 = require("@quatrain/core");
-var AuthAction;
-(function (AuthAction) {
-    AuthAction["SIGNIN"] = "signin";
-    AuthAction["SIGNUP"] = "signup";
-    AuthAction["SIGNOUT"] = "signout";
-})(AuthAction || (exports.AuthAction = AuthAction = {}));
-class Auth extends core_1.Core {
-    static addProvider(provider, alias, setDefault = false) {
-        this._providers[alias] = provider;
-        if (setDefault) {
-            this.defaultProvider = alias;
-        }
-    }
-    static getProvider(alias = this.defaultProvider) {
-        if (this._providers[alias]) {
-            return this._providers[alias];
-        }
-        else {
-            throw new Error(`Unknown provider alias: '${alias}'`);
-        }
-    }
-}
-exports.Auth = Auth;
-_a = Auth;
-Auth.defaultProvider = 'default';
-Auth.logger = _a.addLogger('Auth');
-Auth.ERROR_EMAIL_EXISTS = `User email already exists`;
-Auth._providers = {};

package/lib/AuthenticationError.d.ts

@@ -1,2 +0,0 @@
-export declare class AuthenticationError extends Error {
-}

package/lib/AuthenticationError.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AuthenticationError = void 0;
-class AuthenticationError extends Error {
-}
-exports.AuthenticationError = AuthenticationError;

package/lib/middlewares/AbstractAuthMiddleware.js

@@ -1 +0,0 @@
-"use strict";

package/lib/middlewares/AuthMiddleware.d.ts

@@ -1,5 +0,0 @@
-import { AuthAction } from '../Auth';
-import { User } from '@quatrain/backend';
-export default interface AuthMiddleware {
-    execute: (user: User, action: AuthAction) => void;
-}

package/lib/types/AuthInterface.d.ts

@@ -1,10 +0,0 @@
-import { User } from '@quatrain/core';
-export interface AuthInterface {
-    register(user: User): Promise<any>;
-    signup(login: string, password: string): Promise<any>;
-    signout(user: User): Promise<any>;
-    update(user: User, updatable: any): Promise<any>;
-    delete(user: User): Promise<any>;
-    getAuthToken(token: string): any;
-    refreshToken(refreshToken: string): Promise<any>;
-}