@quatrain/auth 1.0.0

package/lib/AbstractAuthAdapter.d.ts

@@ -0,0 +1,18 @@
+import { AuthParameters, AuthParametersKeys } from './Auth';
+import { User } from '@quatrain/core';
+import { AuthInterface } from './types/AuthInterface';
+export declare abstract class AbstractAuthAdapter implements AuthInterface {
+    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): 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;
+}

package/lib/AbstractAuthAdapter.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractAuthAdapter = void 0;
+class AbstractAuthAdapter {
+    constructor(params = {}) {
+        this._alias = '';
+        this._params = {};
+        this._alias = params.alias || '';
+    }
+    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;

package/lib/Auth.d.ts

@@ -0,0 +1,35 @@
+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;
+    protected static _providers: AuthRegistry<any>;
+    static addProvider(provider: AbstractAuthAdapter, alias: string, setDefault?: boolean): void;
+    static getProvider<T extends AbstractAuthAdapter>(alias?: string): T;
+    static log(message: any, src?: string): void;
+}

package/lib/Auth.js

@@ -0,0 +1,32 @@
+"use strict";
+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}'`);
+        }
+    }
+    static log(message, src = 'Auth') {
+        super.log(message, src);
+    }
+}
+exports.Auth = Auth;
+Auth.defaultProvider = '@default';
+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/index.d.ts

@@ -0,0 +1,4 @@
+import { AbstractAuthAdapter } from './AbstractAuthAdapter';
+import { AuthInterface } from './types/AuthInterface';
+import { AuthenticationError } from './AuthenticationError';
+export { AuthInterface, AbstractAuthAdapter, AuthenticationError };

package/lib/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthenticationError = exports.AbstractAuthAdapter = void 0;
+const AbstractAuthAdapter_1 = require("./AbstractAuthAdapter");
+Object.defineProperty(exports, "AbstractAuthAdapter", { enumerable: true, get: function () { return AbstractAuthAdapter_1.AbstractAuthAdapter; } });
+const AuthenticationError_1 = require("./AuthenticationError");
+Object.defineProperty(exports, "AuthenticationError", { enumerable: true, get: function () { return AuthenticationError_1.AuthenticationError; } });

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/core';
+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/AuthInterface.d.ts

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

package/lib/types/AuthInterface.js

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

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@quatrain/auth",
+  "version": "1.0.0",
+  "license": "MIT",
+  "description": "Auth adapters commons",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib/",
+    "README.md"
+  ],
+  "author": "Quatrain Développement SAS <developers@quatrain.com>",
+  "peerDependencies": {
+    "@quatrain/core": "^1.0.0-beta2"
+  },
+  "devDependencies": {
+    "@faker-js/faker": "^7.6.0",
+    "@firebase/rules-unit-testing": "^2.0.7",
+    "@tsconfig/recommended": "^1.0.1",
+    "@types/jest": "^27.0.3",
+    "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": {
+    "pretest": "tsc",
+    "test": "clear && firebase emulators:exec 'jest -i --verbose --silent=false'",
+    "test-ci": "jest --runInBand",
+    "build": "tsc --watch",
+    "prepush": "tsc",
+    "push": "yarn publish --access public"
+  }
+}