@quatrain/messaging 1.0.1

package/lib/AbstractAuthAdapter.d.ts

@@ -0,0 +1,22 @@
+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

@@ -0,0 +1,25 @@
+"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/AbstractMessagingAdapter.d.ts

@@ -0,0 +1,12 @@
+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;
+    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

@@ -0,0 +1,17 @@
+"use strict";
+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/Auth.d.ts

@@ -0,0 +1,36 @@
+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

@@ -0,0 +1,33 @@
+"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

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

package/lib/AuthenticationError.js

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

package/lib/Messaging.d.ts

@@ -0,0 +1,18 @@
+import { Core } from '@quatrain/core';
+import { AbstractMessagingAdapter } from './AbstractMessagingAdapter';
+export interface MessagingAdapter extends AbstractMessagingAdapter {
+}
+export type MessagingRegistry<T extends AbstractMessagingAdapter> = {
+    [x: string]: T;
+};
+export interface MessagingParameters {
+    config?: any;
+    debug?: boolean;
+}
+export declare class Messaging extends Core {
+    static defaultProvider: 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;
+}

package/lib/Messaging.js

@@ -0,0 +1,26 @@
+"use strict";
+var _a;
+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;
+        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.Messaging = Messaging;
+_a = Messaging;
+Messaging.defaultProvider = 'default';
+Messaging.logger = _a.addLogger('Messaging');
+Messaging._providers = {};

package/lib/index.d.ts

@@ -0,0 +1,4 @@
+import { Messaging, MessagingParameters } from './Messaging';
+import { AbstractMessagingAdapter } from './AbstractMessagingAdapter';
+import { MessagingInterface } from './types/MessagingInterface';
+export { Messaging, MessagingParameters, AbstractMessagingAdapter, MessagingInterface, };

package/lib/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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; } });

package/lib/middlewares/AbstractAuthMiddleware.js

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

package/lib/middlewares/AuthMiddleware.d.ts

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

package/lib/middlewares/AuthMiddleware.js

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

package/lib/types/AbstractMessage.d.ts

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

package/lib/types/AbstractMessage.js

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

package/lib/types/AuthInterface.d.ts

@@ -0,0 +1,10 @@
+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>;
+}

package/lib/types/AuthInterface.js

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

package/lib/types/MessagingInterface.d.ts

@@ -0,0 +1,5 @@
+import { AbstractMessage } from './AbstractMessage';
+import { MessagingRecipient } from './MessagingRecipient';
+export interface MessagingInterface {
+    sendNotification(recipient: MessagingRecipient, message: AbstractMessage): Promise<any>;
+}

package/lib/types/MessagingInterface.js

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

package/lib/types/MessagingRecipient.d.ts

@@ -0,0 +1,2 @@
+import { UserType } from "@quatrain/core";
+export type MessagingRecipient = Pick<UserType, 'firstname' | 'lastname' | 'email' | 'messageToken'>;

package/lib/types/MessagingRecipient.js

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

package/lib/types/NotificationMessage.d.ts

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

package/lib/types/NotificationMessage.js

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

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@quatrain/messaging",
+  "version": "1.0.1",
+  "license": "MIT",
+  "description": "Messaging adapters commons",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib/",
+    "README.md"
+  ],
+  "author": "Quatrain Développement SAS <developers@quatrain.com>",
+  "dependencies": {
+    "@quatrain/core": "^1.1.19"
+  },
+  "devDependencies": {
+    "@tsconfig/recommended": "^1.0.1",
+    "@types/jest": "^27.0.3",
+    "@types/node": "^22.10.1",
+    "jest": "^27.4.7",
+    "jest-node-exports-resolver": "^1.1.6",
+    "jest-serial-runner": "^1.2.1",
+    "trace-unhandled": "^2.0.1",
+    "ts-jest": "^27.1.2",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.1.5"
+  },
+  "scripts": {
+    "test-ci": "jest --runInBand",
+    "build": "tsc",
+    "wbuild": "tsc --watch",
+    "bump-to": "yarn version",
+    "hash": "node ../../bin/hashFolder.js",
+    "hash:persist": "yarn hash  > .hash_latest.txt",
+    "hash:compare": "yarn hash > .hash_newest.txt && cmp -s .hash_latest.txt .hash_newest.txt",
+    "publish": "yarn hash:compare || yarn publish:process",
+    "publish:process": "yarn version patch && yarn build && yarn npm publish --access public && yarn hash:persist"
+  }
+}