orange-auth 1.1.0 → 1.2.0

package/LICENSE

@@ -1,21 +1,21 @@
-    MIT License
-
-    Copyright (c) Mathieu Dery.
-
-    Permission is hereby granted, free of charge, to any person obtaining a copy
-    of this software and associated documentation files (the "Software"), to deal
-    in the Software without restriction, including without limitation the rights
-    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-    copies of the Software, and to permit persons to whom the Software is
-    furnished to do so, subject to the following conditions:
-
-    The above copyright notice and this permission notice shall be included in all
-    copies or substantial portions of the Software.
-
-    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    MIT License
+
+    Copyright (c) Mathieu Dery.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
     SOFTWARE

package/dist/lib.js

@@ -130,7 +130,7 @@ export const CreateAuth = ((config) => {
                             session: params.session,
                         });
                     }
-                    // Use the strategy  to logout
+                    // Use the strategy to logout
                     await globalCfg.strategy.logOut(req, globalCfg);
                     // Clears the header.
                     const headers = new Headers();

package/dist/providers/Credentials.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Credentials.d.ts","sourceRoot":"","sources":["../../src/providers/Credentials.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,YAAY,SAAS,MAAM,IAAI,QAAQ,CAAC;IAClE;;;OAGG;IACH,IAAI,CAAC,EAAE,aAAa,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IACrC;;OAEG;IACH,WAAW,EAAE,YAAY,EAAE,CAAC;IAC5B;;;;;OAKG;IACH,SAAS,EAAE,CAAC,WAAW,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,KAAK,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;CAC1F,CAAC,CAAC;AAEH;;GAEG;AACH,qBAAa,WAAW,CAAC,YAAY,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,SAAS;IAC5E,OAAO,CAAC,MAAM,CAAkC;gBAEpC,MAAM,EAAE,iBAAiB,CAAC,YAAY,CAAC;IAK7B,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;CA6B9F"}
+{"version":3,"file":"Credentials.d.ts","sourceRoot":"","sources":["../../src/providers/Credentials.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,YAAY,SAAS,MAAM,IAAI,QAAQ,CAAC;IAClE;;;OAGG;IACH,IAAI,CAAC,EAAE,aAAa,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IACrC;;OAEG;IACH,WAAW,EAAE,YAAY,EAAE,CAAC;IAC5B;;;;;OAKG;IACH,SAAS,EAAE,CAAC,WAAW,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,KAAK,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;CAC1F,CAAC,CAAC;AAEH;;GAEG;AACH,qBAAa,WAAW,CAAC,YAAY,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,SAAS;IAC5E,OAAO,CAAC,MAAM,CAAkC;gBAEpC,MAAM,EAAE,iBAAiB,CAAC,YAAY,CAAC;IAK7B,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;CAgC9F"}

package/dist/providers/Credentials.js

@@ -34,6 +34,9 @@ export class Credentials extends IProvider {
         if (isNil(session))
             return null;
         // Create a token
-        return globalCfg.strategy.serialize(session, globalCfg);
+        return globalCfg.strategy.serialize(session, globalCfg).catch((err) => {
+            console.log(err);
+            return null;
+        });
     }
 }

package/dist/strategies/IStrategy.d.ts

@@ -1,9 +1,28 @@
-import { type Session } from "../@types/globals";
+import { type MaybePromise, type Session } from "../@types/globals";
 import type { ConfigOptions } from "../@types/internals";
+/**
+ * Strategies callbacks
+ */
+export type Callbacks = Partial<{
+    /**
+     * Pre-serialization callback. This can be used to add some steps to this process.
+     * @param session The session to be serialized.
+     * @returns A boolean representing if the serialization should occur.
+     */
+    serialize: (session: Session) => MaybePromise<boolean>;
+    /**
+     * Post-deserialization callback. This can be used to add some validation to this process.
+     * @param session The token that was deserialized.
+     * @returns A boolean representing if the deserialization is valid.
+     */
+    deserialize: (token: string, session: Session) => MaybePromise<boolean>;
+}>;
 /**
  * A strategy is used to handle the creation, validation and accessing a user's session.
  */
 declare abstract class IStrategy {
+    protected callbacks: Callbacks;
+    constructor(callbacks: Callbacks);
     /**
      * Handles how a session token is generated.
      * @param session The validated session object.

package/dist/strategies/IStrategy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IStrategy.d.ts","sourceRoot":"","sources":["../../src/strategies/IStrategy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD;;GAEG;AACH,uBAAe,SAAS;IACpB;;;;;OAKG;aACa,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;IAEtF;;;;;OAKG;aACa,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IAE7F;;;;OAIG;aACa,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;CAChF;AAED,OAAO,EAAE,SAAS,EAAE,CAAC"}
+{"version":3,"file":"IStrategy.d.ts","sourceRoot":"","sources":["../../src/strategies/IStrategy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACpE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,CAAC;IAC5B;;;;OAIG;IACH,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC;IACvD;;;;OAIG;IACH,WAAW,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,KAAK,YAAY,CAAC,OAAO,CAAC,CAAC;CAC3E,CAAC,CAAC;AAEH;;GAEG;AACH,uBAAe,SAAS;IACpB,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC;gBAEnB,SAAS,EAAE,SAAS;IAIhC;;;;;OAKG;aACa,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;IAEtF;;;;;OAKG;aACa,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IAE7F;;;;OAIG;aACa,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;CAChF;AAED,OAAO,EAAE,SAAS,EAAE,CAAC"}

package/dist/strategies/IStrategy.js

@@ -3,5 +3,9 @@ import {} from "../@types/globals";
  * A strategy is used to handle the creation, validation and accessing a user's session.
  */
 class IStrategy {
+    callbacks;
+    constructor(callbacks) {
+        this.callbacks = callbacks;
+    }
 }
 export { IStrategy };

package/dist/strategies/jwt.d.ts

@@ -1,6 +1,6 @@
-import { IStrategy } from "./IStrategy";
 import type { SignOptions } from "jsonwebtoken";
 import type { Session } from "../@types/globals";
+import { IStrategy, type Callbacks } from "./IStrategy";
 import type { ConfigOptions } from "../@types/internals";
 /**
  * Basic JWT strategy
@@ -10,7 +10,7 @@ declare class JWT extends IStrategy {
      * Forwarded standard JWT options
      */
     private signOptions;
-    constructor(options?: SignOptions);
+    constructor(options?: SignOptions, callbacks?: Callbacks);
     serialize(session: Session, globalCfg: ConfigOptions): Promise<string>;
     deserialize(token: string, globalCfg: ConfigOptions): Promise<Session | null>;
     logOut(): Promise<void>;

package/dist/strategies/jwt.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"jwt.d.ts","sourceRoot":"","sources":["../../src/strategies/jwt.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAgBzD;;GAEG;AACH,cAAM,GAAI,SAAQ,SAAS;IACvB;;OAEG;IACH,OAAO,CAAC,WAAW,CAAc;gBAErB,OAAO,GAAE,WAAiC;IAMtC,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;IAKtE,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IAK7E,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAI1C;AAED,OAAO,EAAE,GAAG,EAAE,CAAC"}
+{"version":3,"file":"jwt.d.ts","sourceRoot":"","sources":["../../src/strategies/jwt.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAgBzD;;GAEG;AACH,cAAM,GAAI,SAAQ,SAAS;IACvB;;OAEG;IACH,OAAO,CAAC,WAAW,CAAc;gBAErB,OAAO,GAAE,WAAiC,EAAE,SAAS,GAAE,SAAc;IAM3D,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;IAY5E,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IAS7E,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAI1C;AAED,OAAO,EAAE,GAAG,EAAE,CAAC"}

package/dist/strategies/jwt.js

@@ -1,18 +1,18 @@
-import { isString } from "lodash-es";
-import { IStrategy } from "./IStrategy";
+import { isNil, isString } from "lodash-es";
 import { verify, sign } from "../functions/jwt";
+import { IStrategy } from "./IStrategy";
 /**
  * Retrieves either the secret or a private key, depending on the used JWT algorithm
  * @param secret Secret key, or key pair
  * @returns The secret or private key
  */
-const secretOrPrivateKey = (secret) => isString(secret) ? secret : secret.privateKey;
+const secretOrPrivateKey = (secret) => (isString(secret) ? secret : secret.privateKey);
 /**
  * Retrieves either the secret or a public key, depending on the used JWT algorithm
  * @param secret Secret key, or key pair
  * @returns The secret or public key
  */
-const secretOrPublicKey = (secret) => isString(secret) ? secret : secret.publicKey;
+const secretOrPublicKey = (secret) => (isString(secret) ? secret : secret.publicKey);
 /**
  * Basic JWT strategy
  */
@@ -21,17 +21,27 @@ class JWT extends IStrategy {
      * Forwarded standard JWT options
      */
     signOptions;
-    constructor(options = { expiresIn: "1h" }) {
-        super();
+    constructor(options = { expiresIn: "1h" }, callbacks = {}) {
+        super(callbacks);
         this.signOptions = options;
     }
-    serialize(session, globalCfg) {
+    async serialize(session, globalCfg) {
+        // If there is no callback set, we can just run normally, so fallback to true.
+        const shouldRun = await Promise.resolve(this.callbacks.serialize?.(session) ?? true);
+        if (!shouldRun) {
+            return Promise.reject("Serialize callback rejection");
+        }
         // Directly call the sign function, but make it async.
         return Promise.resolve(sign(session, secretOrPrivateKey(globalCfg.secret), this.signOptions));
     }
     deserialize(token, globalCfg) {
         // The verify function does everything for us, in this case.
-        return verify(token, secretOrPublicKey(globalCfg.secret));
+        return verify(token, secretOrPublicKey(globalCfg.secret)).then(async (session) => {
+            if (isNil(session))
+                return null;
+            const isValid = await Promise.resolve(this.callbacks.deserialize?.(token, session) ?? true);
+            return isValid ? session : null;
+        });
     }
     logOut() {
         // Since a JWT does not have any data in a DB, there is nothing to do here.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "orange-auth",
-    "version": "1.1.0",
+    "version": "1.2.0",
     "type": "module",
     "description": "Simple modular auth library",
     "main": "dist/index.js",