fiber-firebase-functions 1.0.3 → 1.0.4

package/README.md

@@ -0,0 +1,74 @@
+<p align="center">
+  <img src="https://fiberstudio.app/assets/images/fiber.png" alt="Fiber Logo" width="160" />
+</p>
+
+![npm version](https://img.shields.io/npm/v/fiber-firebase-functions)
+![license](https://img.shields.io/github/license/<user>/fiber-firebase-functions)
+
+# fiber-firebase-functions
+
+A collection of ready-to-use Firebase Cloud Functions utilities and wrappers designed for any application built by Fiber. Provides reusable helpers, common patterns, and production-grade modules to streamline backend development across all Fiber projects.
+
+## Installation
+
+Install the package using one of the following commands:
+
+```bash
+  npm i fiber-firebase-functions
+```
+
+## Configuration
+
+After installing the package, the first required step is to create an `app.json` file at the root of your Cloud Functions project.
+This file contains all configuration values needed by the package and is automatically loaded at runtime.
+
+Your project structure should look like:
+
+```bash
+  functions/
+  ├─ src/
+  ├─ package.json
+  ├─ app.json ← required configuration file
+```
+
+You can then define your configuration keys inside `app.json`.
+Examples are provided below.
+
+If you plan to use the functions:
+
+- isRateLimited
+- recordRateLimitHit
+- ResetPassword.withEmail
+- ResetPassword.withId
+
+You must provide a middleware configuration inside your `app.json`.
+This middleware is used internally by the package to apply rate-limiting logic and return the appropriate response when a user performs too many requests.
+
+Here is the minimal required configuration:
+
+```json
+{
+  "rate_limiter": {
+    "app_name": "rateLimiter",
+    "url": "https://database.com"
+  }
+}
+```
+
+Make sure the `url` points to your Realtime Database instance and that the `app_name` matches your internal configuration.
+
+If you want to enable email sending through this package, you must first install and configure the **Trigger Email From Firestore** extension.
+Once the extension is set up, you need to define an `email` section in your `app.json`.
+
+Here is the required configuration:
+
+```json
+{
+  "email": {
+    "application_name": "MyFiber",
+    "collection": "__fbs__email"
+  }
+}
+```
+
+The `application_name` corresponds to the name of your application, and the `collection` must match the Firestore collection monitored by the extension.

package/lib/auth/is_user_disabled.js

@@ -63,9 +63,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserDisabledByEmailStatus = exports.UserDisabledByIdStatus = void 0;
-exports.isUserDisabledById = isUserDisabledById;
-exports.isUserDisabledByEmail = isUserDisabledByEmail;
+exports.IsUserDisabled = exports.UserDisabledByEmailStatus = exports.UserDisabledByIdStatus = void 0;
 const admin = __importStar(require("firebase-admin"));
 if (admin.apps.length === 0) {
     admin.initializeApp();
@@ -75,7 +73,7 @@ var UserDisabledByIdStatus;
     UserDisabledByIdStatus["MISSING_USER_ID"] = "MISSING_USER_ID";
     UserDisabledByIdStatus["ENABLED"] = "ENABLED";
     UserDisabledByIdStatus["DISABLED"] = "DISABLED";
-    UserDisabledByIdStatus["NOT_FOUND"] = "NOT_FOUND";
+    UserDisabledByIdStatus["USER_NOT_FOUND"] = "USER_NOT_FOUND";
     UserDisabledByIdStatus["INTERNAL_ERROR"] = "INTERNAL_ERROR";
 })(UserDisabledByIdStatus || (exports.UserDisabledByIdStatus = UserDisabledByIdStatus = {}));
 var UserDisabledByEmailStatus;
@@ -83,43 +81,46 @@ var UserDisabledByEmailStatus;
     UserDisabledByEmailStatus["MISSING_USER_ID"] = "MISSING_USER_ID";
     UserDisabledByEmailStatus["ENABLED"] = "ENABLED";
     UserDisabledByEmailStatus["DISABLED"] = "DISABLED";
-    UserDisabledByEmailStatus["NOT_FOUND"] = "NOT_FOUND";
+    UserDisabledByEmailStatus["USER_NOT_FOUND"] = "USER_NOT_FOUND";
     UserDisabledByEmailStatus["INTERNAL_ERROR"] = "INTERNAL_ERROR";
 })(UserDisabledByEmailStatus || (exports.UserDisabledByEmailStatus = UserDisabledByEmailStatus = {}));
-async function isUserDisabledById(userId) {
-    userId = userId.trim();
-    if (!userId)
-        return UserDisabledByIdStatus.MISSING_USER_ID;
-    try {
-        const user = await admin.auth().getUser(userId);
-        const isUserDisabled = user.disabled;
-        return isUserDisabled
-            ? UserDisabledByIdStatus.DISABLED
-            : UserDisabledByIdStatus.ENABLED;
-    }
-    catch (error) {
-        if (error.code === "auth/user-not-found") {
-            return UserDisabledByIdStatus.NOT_FOUND;
+class IsUserDisabled {
+    static async withId(userId) {
+        userId = userId.trim();
+        if (!userId || userId === "")
+            return UserDisabledByIdStatus.MISSING_USER_ID;
+        try {
+            const user = await admin.auth().getUser(userId);
+            const isUserDisabled = user.disabled;
+            return isUserDisabled
+                ? UserDisabledByIdStatus.DISABLED
+                : UserDisabledByIdStatus.ENABLED;
+        }
+        catch (error) {
+            if (error.code === "auth/user-not-found") {
+                return UserDisabledByIdStatus.USER_NOT_FOUND;
+            }
+            return UserDisabledByIdStatus.INTERNAL_ERROR;
         }
-        return UserDisabledByIdStatus.INTERNAL_ERROR;
-    }
-}
-async function isUserDisabledByEmail(email) {
-    email = email.trim();
-    if (!email)
-        return UserDisabledByEmailStatus.MISSING_USER_ID;
-    try {
-        const user = await admin.auth().getUserByEmail(email);
-        const isUserDisabled = user.disabled;
-        return isUserDisabled
-            ? UserDisabledByEmailStatus.DISABLED
-            : UserDisabledByEmailStatus.ENABLED;
     }
-    catch (error) {
-        if (error.code === "auth/user-not-found") {
-            return UserDisabledByEmailStatus.NOT_FOUND;
+    static async withEmail(email) {
+        email = email.trim();
+        if (!email || email === "")
+            return UserDisabledByEmailStatus.MISSING_USER_ID;
+        try {
+            const user = await admin.auth().getUserByEmail(email);
+            const isUserDisabled = user.disabled;
+            return isUserDisabled
+                ? UserDisabledByEmailStatus.DISABLED
+                : UserDisabledByEmailStatus.ENABLED;
+        }
+        catch (error) {
+            if (error.code === "auth/user-not-found") {
+                return UserDisabledByEmailStatus.USER_NOT_FOUND;
+            }
+            return UserDisabledByEmailStatus.INTERNAL_ERROR;
         }
-        return UserDisabledByEmailStatus.INTERNAL_ERROR;
     }
 }
+exports.IsUserDisabled = IsUserDisabled;
 //# sourceMappingURL=is_user_disabled.js.map

package/lib/auth/is_user_disabled.js.map

@@ -1 +1 @@
-{"version":3,"file":"is_user_disabled.js","sourceRoot":"","sources":["../../src/auth/is_user_disabled.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwBH,gDAkBC;AAED,sDAkBC;AA5DD,sDAAwC;AAExC,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;IAC1B,KAAK,CAAC,aAAa,EAAE,CAAC;AAC1B,CAAC;AAED,IAAY,sBAMX;AAND,WAAY,sBAAsB;IAC9B,6DAAmC,CAAA;IACnC,6CAAmB,CAAA;IACnB,+CAAqB,CAAA;IACrB,iDAAuB,CAAA;IACvB,2DAAiC,CAAA;AACrC,CAAC,EANW,sBAAsB,sCAAtB,sBAAsB,QAMjC;AAED,IAAY,yBAMX;AAND,WAAY,yBAAyB;IACjC,gEAAmC,CAAA;IACnC,gDAAmB,CAAA;IACnB,kDAAqB,CAAA;IACrB,oDAAuB,CAAA;IACvB,8DAAiC,CAAA;AACrC,CAAC,EANW,yBAAyB,yCAAzB,yBAAyB,QAMpC;AAEM,KAAK,UAAU,kBAAkB,CAAC,MAAc;IACnD,MAAM,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;IAEvB,IAAI,CAAC,MAAM;QAAE,OAAO,sBAAsB,CAAC,eAAe,CAAC;IAE3D,IAAI,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC;QAErC,OAAO,cAAc;YACjB,CAAC,CAAC,sBAAsB,CAAC,QAAQ;YACjC,CAAC,CAAC,sBAAsB,CAAC,OAAO,CAAC;IACzC,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QAClB,IAAI,KAAK,CAAC,IAAI,KAAK,qBAAqB,EAAE,CAAC;YACvC,OAAO,sBAAsB,CAAC,SAAS,CAAC;QAC5C,CAAC;QACD,OAAO,sBAAsB,CAAC,cAAc,CAAC;IACjD,CAAC;AACL,CAAC;AAEM,KAAK,UAAU,qBAAqB,CAAC,KAAa;IACrD,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAErB,IAAI,CAAC,KAAK;QAAE,OAAO,yBAAyB,CAAC,eAAe,CAAC;IAE7D,IAAI,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QACtD,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC;QAErC,OAAO,cAAc;YACjB,CAAC,CAAC,yBAAyB,CAAC,QAAQ;YACpC,CAAC,CAAC,yBAAyB,CAAC,OAAO,CAAC;IAC5C,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QAClB,IAAI,KAAK,CAAC,IAAI,KAAK,qBAAqB,EAAE,CAAC;YACvC,OAAO,yBAAyB,CAAC,SAAS,CAAC;QAC/C,CAAC;QACD,OAAO,yBAAyB,CAAC,cAAc,CAAC;IACpD,CAAC;AACL,CAAC"}
+{"version":3,"file":"is_user_disabled.js","sourceRoot":"","sources":["../../src/auth/is_user_disabled.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,sDAAwC;AAExC,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;IAC1B,KAAK,CAAC,aAAa,EAAE,CAAC;AAC1B,CAAC;AAED,IAAY,sBAMX;AAND,WAAY,sBAAsB;IAC9B,6DAAmC,CAAA;IACnC,6CAAmB,CAAA;IACnB,+CAAqB,CAAA;IACrB,2DAAiC,CAAA;IACjC,2DAAiC,CAAA;AACrC,CAAC,EANW,sBAAsB,sCAAtB,sBAAsB,QAMjC;AAED,IAAY,yBAMX;AAND,WAAY,yBAAyB;IACjC,gEAAmC,CAAA;IACnC,gDAAmB,CAAA;IACnB,kDAAqB,CAAA;IACrB,8DAAiC,CAAA;IACjC,8DAAiC,CAAA;AACrC,CAAC,EANW,yBAAyB,yCAAzB,yBAAyB,QAMpC;AAED,MAAa,cAAc;IACvB,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAc;QAC9B,MAAM,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;QAEvB,IAAI,CAAC,MAAM,IAAI,MAAM,KAAK,EAAE;YAAE,OAAO,sBAAsB,CAAC,eAAe,CAAC;QAE5E,IAAI,CAAC;YACD,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAChD,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC;YAErC,OAAO,cAAc;gBACjB,CAAC,CAAC,sBAAsB,CAAC,QAAQ;gBACjC,CAAC,CAAC,sBAAsB,CAAC,OAAO,CAAC;QACzC,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YAClB,IAAI,KAAK,CAAC,IAAI,KAAK,qBAAqB,EAAE,CAAC;gBACvC,OAAO,sBAAsB,CAAC,cAAc,CAAC;YACjD,CAAC;YACD,OAAO,sBAAsB,CAAC,cAAc,CAAC;QACjD,CAAC;IACL,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,KAAa;QAChC,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAErB,IAAI,CAAC,KAAK,IAAI,KAAK,KAAK,EAAE;YAAE,OAAO,yBAAyB,CAAC,eAAe,CAAC;QAE7E,IAAI,CAAC;YACD,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YACtD,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC;YAErC,OAAO,cAAc;gBACjB,CAAC,CAAC,yBAAyB,CAAC,QAAQ;gBACpC,CAAC,CAAC,yBAAyB,CAAC,OAAO,CAAC;QAC5C,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YAClB,IAAI,KAAK,CAAC,IAAI,KAAK,qBAAqB,EAAE,CAAC;gBACvC,OAAO,yBAAyB,CAAC,cAAc,CAAC;YACpD,CAAC;YACD,OAAO,yBAAyB,CAAC,cAAc,CAAC;QACpD,CAAC;IACL,CAAC;CACJ;AAxCD,wCAwCC"}

package/lib/auth/is_user_exists.js

@@ -63,9 +63,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserExistsByEmailStatus = exports.UserExistsByIdStatus = void 0;
-exports.isUserExistsById = isUserExistsById;
-exports.isUserExistsByEmail = isUserExistsByEmail;
+exports.IsUserExists = exports.UserExistsByEmailStatus = exports.UserExistsByIdStatus = void 0;
 const admin = __importStar(require("firebase-admin"));
 if (admin.apps.length === 0) {
     admin.initializeApp();
@@ -74,44 +72,47 @@ var UserExistsByIdStatus;
 (function (UserExistsByIdStatus) {
     UserExistsByIdStatus["MISSING_USER_ID"] = "MISSING_USER_ID";
     UserExistsByIdStatus["EXISTS"] = "EXISTS";
-    UserExistsByIdStatus["NOT_FOUND"] = "NOT_FOUND";
+    UserExistsByIdStatus["USER_NOT_FOUND"] = "USER_NOT_FOUND";
     UserExistsByIdStatus["INTERNAL_ERROR"] = "INTERNAL_ERROR";
 })(UserExistsByIdStatus || (exports.UserExistsByIdStatus = UserExistsByIdStatus = {}));
 var UserExistsByEmailStatus;
 (function (UserExistsByEmailStatus) {
     UserExistsByEmailStatus["MISSING_USER_EMAIL"] = "MISSING_USER_EMAIL";
     UserExistsByEmailStatus["EXISTS"] = "EXISTS";
-    UserExistsByEmailStatus["NOT_FOUND"] = "NOT_FOUND";
+    UserExistsByEmailStatus["USER_NOT_FOUND"] = "USER_NOT_FOUND";
     UserExistsByEmailStatus["INTERNAL_ERROR"] = "INTERNAL_ERROR";
 })(UserExistsByEmailStatus || (exports.UserExistsByEmailStatus = UserExistsByEmailStatus = {}));
-async function isUserExistsById(userId) {
-    userId = userId.trim();
-    if (!userId || userId === "")
-        return UserExistsByIdStatus.MISSING_USER_ID;
-    try {
-        await admin.auth().getUser(userId);
-        return UserExistsByIdStatus.EXISTS;
-    }
-    catch (error) {
-        if (error.code === "auth/user-not-found") {
-            return UserExistsByIdStatus.NOT_FOUND;
+class IsUserExists {
+    static async withId(userId) {
+        userId = userId.trim();
+        if (!userId || userId === "")
+            return UserExistsByIdStatus.MISSING_USER_ID;
+        try {
+            await admin.auth().getUser(userId);
+            return UserExistsByIdStatus.EXISTS;
+        }
+        catch (error) {
+            if (error.code === "auth/user-not-found") {
+                return UserExistsByIdStatus.USER_NOT_FOUND;
+            }
+            return UserExistsByIdStatus.INTERNAL_ERROR;
         }
-        return UserExistsByIdStatus.INTERNAL_ERROR;
-    }
-}
-async function isUserExistsByEmail(email) {
-    email = email.trim();
-    if (!email || email === "")
-        return UserExistsByEmailStatus.MISSING_USER_EMAIL;
-    try {
-        await admin.auth().getUserByEmail(email);
-        return UserExistsByEmailStatus.EXISTS;
     }
-    catch (error) {
-        if (error.code === "auth/user-not-found") {
-            return UserExistsByEmailStatus.NOT_FOUND;
+    static async withEmail(email) {
+        email = email.trim();
+        if (!email || email === "")
+            return UserExistsByEmailStatus.MISSING_USER_EMAIL;
+        try {
+            await admin.auth().getUserByEmail(email);
+            return UserExistsByEmailStatus.EXISTS;
+        }
+        catch (error) {
+            if (error.code === "auth/user-not-found") {
+                return UserExistsByEmailStatus.USER_NOT_FOUND;
+            }
+            return UserExistsByEmailStatus.INTERNAL_ERROR;
         }
-        return UserExistsByEmailStatus.INTERNAL_ERROR;
     }
 }
+exports.IsUserExists = IsUserExists;
 //# sourceMappingURL=is_user_exists.js.map

package/lib/auth/is_user_exists.js.map

@@ -1 +1 @@
-{"version":3,"file":"is_user_exists.js","sourceRoot":"","sources":["../../src/auth/is_user_exists.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsBH,4CAeC;AAED,kDAeC;AApDD,sDAAwC;AAExC,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;IAC1B,KAAK,CAAC,aAAa,EAAE,CAAC;AAC1B,CAAC;AAED,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC5B,2DAAmC,CAAA;IACnC,yCAAiB,CAAA;IACjB,+CAAuB,CAAA;IACvB,yDAAiC,CAAA;AACrC,CAAC,EALW,oBAAoB,oCAApB,oBAAoB,QAK/B;AAED,IAAY,uBAKX;AALD,WAAY,uBAAuB;IAC/B,oEAAyC,CAAA;IACzC,4CAAiB,CAAA;IACjB,kDAAuB,CAAA;IACvB,4DAAiC,CAAA;AACrC,CAAC,EALW,uBAAuB,uCAAvB,uBAAuB,QAKlC;AAEM,KAAK,UAAU,gBAAgB,CAAC,MAAc;IACjD,MAAM,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;IAEvB,IAAI,CAAC,MAAM,IAAI,MAAM,KAAK,EAAE;QAAE,OAAO,oBAAoB,CAAC,eAAe,CAAC;IAE1E,IAAI,CAAC;QACD,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAEnC,OAAO,oBAAoB,CAAC,MAAM,CAAC;IACvC,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QAClB,IAAI,KAAK,CAAC,IAAI,KAAK,qBAAqB,EAAE,CAAC;YACvC,OAAO,oBAAoB,CAAC,SAAS,CAAC;QAC1C,CAAC;QACD,OAAO,oBAAoB,CAAC,cAAc,CAAC;IAC/C,CAAC;AACL,CAAC;AAEM,KAAK,UAAU,mBAAmB,CAAC,KAAa;IACnD,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAErB,IAAI,CAAC,KAAK,IAAI,KAAK,KAAK,EAAE;QAAE,OAAO,uBAAuB,CAAC,kBAAkB,CAAC;IAE9E,IAAI,CAAC;QACD,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAEzC,OAAO,uBAAuB,CAAC,MAAM,CAAC;IAC1C,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QAClB,IAAI,KAAK,CAAC,IAAI,KAAK,qBAAqB,EAAE,CAAC;YACvC,OAAO,uBAAuB,CAAC,SAAS,CAAC;QAC7C,CAAC;QACD,OAAO,uBAAuB,CAAC,cAAc,CAAC;IAClD,CAAC;AACL,CAAC"}
+{"version":3,"file":"is_user_exists.js","sourceRoot":"","sources":["../../src/auth/is_user_exists.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,sDAAwC;AAExC,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;IAC1B,KAAK,CAAC,aAAa,EAAE,CAAC;AAC1B,CAAC;AAED,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC5B,2DAAmC,CAAA;IACnC,yCAAiB,CAAA;IACjB,yDAAiC,CAAA;IACjC,yDAAiC,CAAA;AACrC,CAAC,EALW,oBAAoB,oCAApB,oBAAoB,QAK/B;AAED,IAAY,uBAKX;AALD,WAAY,uBAAuB;IAC/B,oEAAyC,CAAA;IACzC,4CAAiB,CAAA;IACjB,4DAAiC,CAAA;IACjC,4DAAiC,CAAA;AACrC,CAAC,EALW,uBAAuB,uCAAvB,uBAAuB,QAKlC;AAED,MAAa,YAAY;IACrB,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAc;QAC9B,MAAM,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;QAEvB,IAAI,CAAC,MAAM,IAAI,MAAM,KAAK,EAAE;YAAE,OAAO,oBAAoB,CAAC,eAAe,CAAC;QAE1E,IAAI,CAAC;YACD,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAEnC,OAAO,oBAAoB,CAAC,MAAM,CAAC;QACvC,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YAClB,IAAI,KAAK,CAAC,IAAI,KAAK,qBAAqB,EAAE,CAAC;gBACvC,OAAO,oBAAoB,CAAC,cAAc,CAAC;YAC/C,CAAC;YACD,OAAO,oBAAoB,CAAC,cAAc,CAAC;QAC/C,CAAC;IACL,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,KAAa;QAChC,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAErB,IAAI,CAAC,KAAK,IAAI,KAAK,KAAK,EAAE;YAAE,OAAO,uBAAuB,CAAC,kBAAkB,CAAC;QAE9E,IAAI,CAAC;YACD,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAEzC,OAAO,uBAAuB,CAAC,MAAM,CAAC;QAC1C,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YAClB,IAAI,KAAK,CAAC,IAAI,KAAK,qBAAqB,EAAE,CAAC;gBACvC,OAAO,uBAAuB,CAAC,cAAc,CAAC;YAClD,CAAC;YACD,OAAO,uBAAuB,CAAC,cAAc,CAAC;QAClD,CAAC;IACL,CAAC;CACJ;AAlCD,oCAkCC"}

package/lib/auth/otp.js

@@ -62,34 +62,101 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GenerateOTPStatus = void 0;
+exports.Otp = exports.GetOTPStatus = exports.GenerateStatus = void 0;
+const crypto_1 = __importDefault(require("crypto"));
 const admin = __importStar(require("firebase-admin"));
+const config_1 = require("../common/config");
 if (admin.apps.length === 0) {
     admin.initializeApp();
 }
-var GenerateOTPStatus;
-(function (GenerateOTPStatus) {
-    GenerateOTPStatus["MISSING_DATABASE_CONFIG"] = "MISSING_DATABASE_CONFIG";
-    GenerateOTPStatus["TOO_MANY_REQUEST"] = "TOO_MANY_REQUEST";
-    GenerateOTPStatus["SUCCESS"] = "SUCCESS";
-    GenerateOTPStatus["INTERNAL_ERROR"] = "INTERNAL_ERROR";
-})(GenerateOTPStatus || (exports.GenerateOTPStatus = GenerateOTPStatus = {}));
-// export async function generateOTP(identifier: GenerateOTPIdentifier): Promise<GenerateOTPStatus> {
-//     const config = appInitialize();
-//     const security = config.security;
-//     if (!security) return GenerateOTPStatus.MISSING_DATABASE_CONFIG;
-//     if (await isRateLimited(identifier, rule, databaseConfig) !== RateLimitCheckStatus.LIMIT_NOT_FOUND) {
-//         return GenerateOTPStatus.TOO_MANY_REQUEST;
-//     }
-//     await recordRateLimitHit(identifier, rule, databaseConfig);
-//     try {
-//         const database = realtimeDatabase(databaseConfig);
-//         const reference = database.ref("__fbs__otp").child("feature");
-//         const query = await reference.get();
-//         return GenerateOTPStatus.SUCCESS;
-//     } catch (e) {
-//         return GenerateOTPStatus.INTERNAL_ERROR;
-//     }
-// }
+var GenerateStatus;
+(function (GenerateStatus) {
+    GenerateStatus["MISSING_OTP_CONFIG"] = "MISSING_OTP_CONFIG";
+    GenerateStatus["SUCCESS"] = "SUCCESS";
+})(GenerateStatus || (exports.GenerateStatus = GenerateStatus = {}));
+var GetOTPStatus;
+(function (GetOTPStatus) {
+    GetOTPStatus["MISSING_OTP_CONFIG"] = "MISSING_OTP_CONFIG";
+    GetOTPStatus["OTP_NOT_FOUND"] = "OTP_NOT_FOUND";
+    GetOTPStatus["OTP_FOUND"] = "OTP_FOUND";
+})(GetOTPStatus || (exports.GetOTPStatus = GetOTPStatus = {}));
+class Otp {
+    static async generate(userId, type) {
+        const config = (0, config_1.appInitialize)();
+        const otp = config.otp;
+        if (otp.collection === undefined)
+            return GenerateStatus.MISSING_OTP_CONFIG;
+        const now = Date.now();
+        const otpCode = OTPUtils.generate();
+        const hashOtp = OTPUtils.hash(otpCode);
+        await admin.firestore().collection(otp.collection).add({
+            __fbs__user_id: userId,
+            __fbs__created_at: now,
+            __fbs__otp_type: type,
+            __fbs__otp: hashOtp,
+        });
+        return GenerateStatus.SUCCESS;
+    }
+    static async get(userId, type) {
+        const config = (0, config_1.appInitialize)();
+        const otp = config.otp;
+        if (otp.collection === undefined)
+            return { status: GetOTPStatus.MISSING_OTP_CONFIG };
+        const snapshot = await admin.firestore()
+            .collection(otp.collection)
+            .where("__fbs__user_id", "==", userId)
+            .where("__fbs__otp_type", "==", type)
+            .orderBy("__fbs__created_at", "desc")
+            .limit(1)
+            .get();
+        if (snapshot.docs.length === 0)
+            return { status: GetOTPStatus.OTP_NOT_FOUND };
+        const doc = snapshot.docs[0];
+        const data = doc?.data();
+        const otpCode = data?.__fbs__otp;
+        return { status: GetOTPStatus.MISSING_OTP_CONFIG, otp: otpCode };
+    }
+}
+exports.Otp = Otp;
+class OTPUtils {
+    static generate() {
+        while (true) {
+            const buffer = crypto_1.default.randomBytes(4);
+            const number = buffer.readUInt32BE();
+            const otp = (number % 1000000).toString().padStart(6, '0');
+            if (this.hasAllIdenticalDigits(otp))
+                continue;
+            if (this.hasRepeatingPattern(otp))
+                continue;
+            if (this.hasMoreThanThreeConsecutiveIdenticalDigits(otp))
+                continue;
+            return otp;
+        }
+    }
+    static hash(otp) {
+        return crypto_1.default.createHash('sha256').update(otp).digest('hex');
+    }
+    static hasAllIdenticalDigits(str) {
+        return /^(\d)\1{5}$/.test(str);
+    }
+    static hasMoreThanThreeConsecutiveIdenticalDigits(str) {
+        return /(\d)\1{3,}/.test(str);
+    }
+    static hasRepeatingPattern(str) {
+        const half = str.slice(0, 3);
+        if (half.repeat(2) === str)
+            return true;
+        const pairs = str.match(/(..)/g);
+        if (pairs && pairs.length === 3 && new Set(pairs).size === 1)
+            return true;
+        const mirror = half + half.split('').reverse().join('');
+        if (str === mirror)
+            return true;
+        return false;
+    }
+}
 //# sourceMappingURL=otp.js.map

package/lib/auth/otp.js.map

@@ -1 +1 @@
-{"version":3,"file":"otp.js","sourceRoot":"","sources":["../../src/auth/otp.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,sDAAwC;AAExC,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;IAC1B,KAAK,CAAC,aAAa,EAAE,CAAC;AAC1B,CAAC;AAED,IAAY,iBAKX;AALD,WAAY,iBAAiB;IACzB,wEAAmD,CAAA;IACnD,0DAAqC,CAAA;IACrC,wCAAmB,CAAA;IACnB,sDAAiC,CAAA;AACrC,CAAC,EALW,iBAAiB,iCAAjB,iBAAiB,QAK5B;AAOD,qGAAqG;AACrG,sCAAsC;AACtC,wCAAwC;AAExC,uEAAuE;AAEvE,4GAA4G;AAC5G,qDAAqD;AACrD,QAAQ;AACR,kEAAkE;AAElE,YAAY;AACZ,6DAA6D;AAC7D,yEAAyE;AACzE,+CAA+C;AAE/C,4CAA4C;AAC5C,oBAAoB;AACpB,mDAAmD;AACnD,QAAQ;AACR,IAAI"}
+{"version":3,"file":"otp.js","sourceRoot":"","sources":["../../src/auth/otp.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,oDAA4B;AAC5B,sDAAwC;AACxC,6CAAiD;AAEjD,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;IAC1B,KAAK,CAAC,aAAa,EAAE,CAAC;AAC1B,CAAC;AAED,IAAY,cAGX;AAHD,WAAY,cAAc;IACtB,2DAAyC,CAAA;IACzC,qCAAmB,CAAA;AACvB,CAAC,EAHW,cAAc,8BAAd,cAAc,QAGzB;AAED,IAAY,YAIX;AAJD,WAAY,YAAY;IACpB,yDAAyC,CAAA;IACzC,+CAA+B,CAAA;IAC/B,uCAAuB,CAAA;AAC3B,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB;AAED,MAAa,GAAG;IACZ,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAc,EAAE,IAAY;QAC9C,MAAM,MAAM,GAAG,IAAA,sBAAa,GAAE,CAAC;QAC/B,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;QAEvB,IAAI,GAAG,CAAC,UAAU,KAAK,SAAS;YAAE,OAAO,cAAc,CAAC,kBAAkB,CAAC;QAE3E,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEvC,MAAM,KAAK,CAAC,SAAS,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC;YACnD,cAAc,EAAE,MAAM;YACtB,iBAAiB,EAAE,GAAG;YACtB,eAAe,EAAE,IAAI;YACrB,UAAU,EAAE,OAAO;SACtB,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC,OAAO,CAAC;IAClC,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,MAAc,EAAE,IAAY;QACzC,MAAM,MAAM,GAAG,IAAA,sBAAa,GAAE,CAAC;QAC/B,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;QAEvB,IAAI,GAAG,CAAC,UAAU,KAAK,SAAS;YAAE,OAAO,EAAE,MAAM,EAAE,YAAY,CAAC,kBAAkB,EAAE,CAAC;QAErF,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,SAAS,EAAE;aACnC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC;aAC1B,KAAK,CAAC,gBAAgB,EAAE,IAAI,EAAE,MAAM,CAAC;aACrC,KAAK,CAAC,iBAAiB,EAAE,IAAI,EAAE,IAAI,CAAC;aACpC,OAAO,CAAC,mBAAmB,EAAE,MAAM,CAAC;aACpC,KAAK,CAAC,CAAC,CAAC;aACR,GAAG,EAAE,CAAC;QAEX,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,MAAM,EAAE,YAAY,CAAC,aAAa,EAAE,CAAC;QAE9E,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,IAAI,GAAG,GAAG,EAAE,IAAI,EAAE,CAAC;QACzB,MAAM,OAAO,GAAG,IAAI,EAAE,UAAoB,CAAC;QAE3C,OAAO,EAAE,MAAM,EAAE,YAAY,CAAC,kBAAkB,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC;IACrE,CAAC;CACJ;AA3CD,kBA2CC;AAED,MAAM,QAAQ;IACV,MAAM,CAAC,QAAQ;QACX,OAAO,IAAI,EAAE,CAAC;YACV,MAAM,MAAM,GAAG,gBAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;YACrC,MAAM,MAAM,GAAG,MAAM,CAAC,YAAY,EAAE,CAAC;YACrC,MAAM,GAAG,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YAE3D,IAAI,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC;gBAAE,SAAS;YAC9C,IAAI,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC;gBAAE,SAAS;YAC5C,IAAI,IAAI,CAAC,0CAA0C,CAAC,GAAG,CAAC;gBAAE,SAAS;YAEnE,OAAO,GAAG,CAAC;QACf,CAAC;IACL,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,GAAW;QACnB,OAAO,gBAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACjE,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,GAAW;QAC5C,OAAO,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC;IAEO,MAAM,CAAC,0CAA0C,CAAC,GAAW;QACjE,OAAO,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClC,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,GAAW;QAC1C,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7B,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG;YAAE,OAAO,IAAI,CAAC;QAExC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACjC,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAE1E,MAAM,MAAM,GAAG,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACxD,IAAI,GAAG,KAAK,MAAM;YAAE,OAAO,IAAI,CAAC;QAEhC,OAAO,KAAK,CAAC;IACjB,CAAC;CACJ"}