fiber-firebase-functions 1.0.2 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/README.md +74 -0
  2. package/lib/auth/is_user_disabled.js +37 -36
  3. package/lib/auth/is_user_disabled.js.map +1 -1
  4. package/lib/auth/is_user_exists.js +31 -30
  5. package/lib/auth/is_user_exists.js.map +1 -1
  6. package/lib/auth/otp.js +162 -0
  7. package/lib/auth/otp.js.map +1 -0
  8. package/lib/auth/reset_password.js +327 -0
  9. package/lib/auth/reset_password.js.map +1 -0
  10. package/lib/auth/update_password.js +18 -7
  11. package/lib/auth/update_password.js.map +1 -1
  12. package/lib/auth/user.js +44 -32
  13. package/lib/auth/user.js.map +1 -1
  14. package/lib/common/config.js +64 -0
  15. package/lib/common/config.js.map +1 -0
  16. package/lib/common/locale.js +119 -0
  17. package/lib/common/locale.js.map +1 -0
  18. package/lib/email/email.js +96 -0
  19. package/lib/email/email.js.map +1 -0
  20. package/lib/email/send_email.js +81 -0
  21. package/lib/email/send_email.js.map +1 -0
  22. package/lib/email/templates/new_user.js +491 -0
  23. package/lib/email/templates/new_user.js.map +1 -0
  24. package/lib/email/templates.js +38 -0
  25. package/lib/email/templates.js.map +1 -0
  26. package/lib/index.js +6 -0
  27. package/lib/index.js.map +1 -1
  28. package/lib/middleware/rate_limiter.js +19 -6
  29. package/lib/middleware/rate_limiter.js.map +1 -1
  30. package/package.json +6 -4
  31. package/src/auth/is_user_disabled.ts +31 -29
  32. package/src/auth/is_user_exists.ts +25 -23
  33. package/src/auth/otp.ts +135 -0
  34. package/src/auth/reset_password.ts +317 -0
  35. package/src/auth/user.ts +34 -24
  36. package/src/common/config.ts +84 -0
  37. package/src/common/locale.ts +121 -0
  38. package/src/email/email.ts +70 -0
  39. package/src/email/templates/new_user.ts +493 -0
  40. package/src/email/templates.ts +34 -0
  41. package/src/index.ts +6 -0
  42. package/src/middleware/rate_limiter.ts +25 -6
  43. package/src/auth/update_password.ts +0 -211
@@ -1,211 +0,0 @@
1
- /*
2
- * Copyright (C) 2025 Fiber
3
- *
4
- * All rights reserved. This script, including its code and logic, is the
5
- * exclusive property of Fiber. Redistribution, reproduction,
6
- * or modification of any part of this script is strictly prohibited
7
- * without prior written permission from Fiber.
8
- *
9
- * Conditions of use:
10
- * - The code may not be copied, duplicated, or used, in whole or in part,
11
- * for any purpose without explicit authorization.
12
- * - Redistribution of this code, with or without modification, is not
13
- * permitted unless expressly agreed upon by Fiber.
14
- * - The name "Fiber" and any associated branding, logos, or
15
- * trademarks may not be used to endorse or promote derived products
16
- * or services without prior written approval.
17
- *
18
- * Disclaimer:
19
- * THIS SCRIPT AND ITS CODE ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
20
- * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY,
21
- * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL
22
- * FIBER BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23
- * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING BUT NOT LIMITED TO LOSS OF USE,
24
- * DATA, PROFITS, OR BUSINESS INTERRUPTION) ARISING OUT OF OR RELATED TO THE USE
25
- * OR INABILITY TO USE THIS SCRIPT, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26
- *
27
- * Unauthorized copying or reproduction of this script, in whole or in part,
28
- * is a violation of applicable intellectual property laws and will result
29
- * in legal action.
30
- */
31
-
32
- import * as admin from "firebase-admin";
33
- import { RealtimeDatabase } from "../common/realtime_database";
34
- import { isRateLimited, RateLimitCheckStatus, RateLimitIdentifier, RateLimitRule, recordRateLimitHit } from "../middleware/rate_limiter";
35
- import { isUserDisabledById } from "./is_user_disabled";
36
- import { isUserExistsById } from "./is_user_exists";
37
- import { getUserByEmail, UserByEmailStatus } from "./user";
38
-
39
- if (admin.apps.length === 0) {
40
- admin.initializeApp();
41
- }
42
-
43
- export enum ResetPasswordByEmailStatus {
44
- MISSING_USER_EMAIL = "MISSING_USER_EMAIL",
45
- MISSING_NEW_PASSWORD = "MISSING_NEW_PASSWORD",
46
- MISSING_CONFIRM_NEW_PASSWORD = "MISSING_CONFIRM_NEW_PASSWORD",
47
- MISSING_PASSWORD_POLICY = "MISSING_PASSWORD_POLICY",
48
- NOT_IDENTICAL_CONFIRM_PASSWORD = "NOT_IDENTICAL_CONFIRM_PASSWORD",
49
- USER_NOT_FOUND = "USER_NOT_FOUND",
50
- USER_DISABLED = "USER_DISABLED",
51
- WEAK_NEW_PASSWORD = "WEAK_NEW_PASSWORD",
52
- MISSING_PASSWORD_UPPERCASE = "MISSING_PASSWORD_UPPERCASE",
53
- MISSING_PASSWORD_LOWERCASE = "MISSING_PASSWORD_LOWERCASE",
54
- MISSING_PASSWORD_DIGIT = "MISSING_PASSWORD_DIGIT",
55
- MISSING_PASSWORD_SPECIAL_CHAR = "MISSING_PASSWORD_SPECIAL_CHAR",
56
- TOO_MANY_REQUEST = "TOO_MANY_REQUEST",
57
- SUCCESS = "SUCCESS",
58
- INTERNAL_ERROR = "INTERNAL_ERROR",
59
- }
60
-
61
- export enum ResetPasswordByIdStatus {
62
- MISSING_USER_EMAIL = "MISSING_USER_EMAIL",
63
- MISSING_NEW_PASSWORD = "MISSING_NEW_PASSWORD",
64
- MISSING_CONFIRM_NEW_PASSWORD = "MISSING_CONFIRM_NEW_PASSWORD",
65
- MISSING_PASSWORD_POLICY = "MISSING_PASSWORD_POLICY",
66
- NOT_IDENTICAL_CONFIRM_PASSWORD = "NOT_IDENTICAL_CONFIRM_PASSWORD",
67
- USER_NOT_FOUND = "USER_NOT_FOUND",
68
- USER_DISABLED = "USER_DISABLED",
69
- WEAK_NEW_PASSWORD = "WEAK_NEW_PASSWORD",
70
- MISSING_PASSWORD_UPPERCASE = "MISSING_PASSWORD_UPPERCASE",
71
- MISSING_PASSWORD_LOWERCASE = "MISSING_PASSWORD_LOWERCASE",
72
- MISSING_PASSWORD_DIGIT = "MISSING_PASSWORD_DIGIT",
73
- MISSING_PASSWORD_SPECIAL_CHAR = "MISSING_PASSWORD_SPECIAL_CHAR",
74
- TOO_MANY_REQUEST = "TOO_MANY_REQUEST",
75
- SUCCESS = "SUCCESS",
76
- INTERNAL_ERROR = "INTERNAL_ERROR",
77
- }
78
-
79
- export interface PasswordPolicy {
80
- minLength: number;
81
- requireUppercase: boolean;
82
- requireLowercase: boolean;
83
- requireDigit: boolean;
84
- requireSpecial: boolean;
85
- }
86
-
87
- export interface ResetPassword {
88
- newPassword: string;
89
- confirmNewPassword: string;
90
- passwordPolicy: PasswordPolicy;
91
- }
92
-
93
- export async function resetPasswordByEmail(email: string, password: ResetPassword, databaseConfig: RealtimeDatabase): Promise<ResetPasswordByEmailStatus> {
94
- email = email.trim();
95
-
96
- if (!email) return ResetPasswordByEmailStatus.MISSING_USER_EMAIL;
97
-
98
- const newPassword = password.newPassword.trim();
99
- const confirmNewPassword = password.confirmNewPassword.trim();
100
-
101
- if (!newPassword || newPassword === "") return ResetPasswordByEmailStatus.MISSING_NEW_PASSWORD;
102
- if (!confirmNewPassword || confirmNewPassword === "") return ResetPasswordByEmailStatus.MISSING_CONFIRM_NEW_PASSWORD;
103
-
104
- const passwordPolicy = password.passwordPolicy;
105
-
106
- if (!passwordPolicy) return ResetPasswordByEmailStatus.MISSING_PASSWORD_POLICY;
107
-
108
- const userResult = await getUserByEmail(email);
109
- const user = userResult.user;
110
-
111
- if (userResult.status !== UserByEmailStatus.FOUND || user === undefined) return ResetPasswordByEmailStatus.USER_NOT_FOUND;
112
-
113
- const identifier: RateLimitIdentifier = {
114
- id: user.uid,
115
- target: "reset_password"
116
- };
117
-
118
- const rule: RateLimitRule = {
119
- ttl: 2 * 60 * 1000,
120
- windowMs: 3 * 60 * 1000,
121
- maxHits: 5,
122
- };
123
-
124
- if (await isRateLimited(identifier, rule, databaseConfig) !== RateLimitCheckStatus.LIMIT_NOT_FOUND) {
125
- return ResetPasswordByEmailStatus.TOO_MANY_REQUEST;
126
- }
127
- await recordRateLimitHit(identifier, rule, databaseConfig);
128
-
129
- if (await isUserDisabledById(user.uid)) return ResetPasswordByEmailStatus.USER_DISABLED;
130
-
131
- if (newPassword !== confirmNewPassword) return ResetPasswordByEmailStatus.NOT_IDENTICAL_CONFIRM_PASSWORD;
132
-
133
- const requiredMin = Math.max(6, passwordPolicy.minLength);
134
- if (newPassword.length < requiredMin) return ResetPasswordByEmailStatus.WEAK_NEW_PASSWORD;
135
-
136
- const rules = [
137
- { enabled: passwordPolicy.requireUppercase, regex: /[A-Z]/, error: ResetPasswordByEmailStatus.MISSING_PASSWORD_UPPERCASE },
138
- { enabled: passwordPolicy.requireLowercase, regex: /[a-z]/, error: ResetPasswordByEmailStatus.MISSING_PASSWORD_LOWERCASE },
139
- { enabled: passwordPolicy.requireDigit, regex: /[0-9]/, error: ResetPasswordByEmailStatus.MISSING_PASSWORD_DIGIT },
140
- { enabled: passwordPolicy.requireSpecial, regex: /[^A-Za-z0-9]/, error: ResetPasswordByEmailStatus.MISSING_PASSWORD_SPECIAL_CHAR },
141
- ];
142
-
143
- for (const rule of rules) {
144
- if (rule.enabled && !rule.regex.test(newPassword)) return rule.error;
145
- }
146
-
147
- try {
148
- await admin.auth().updateUser(user.uid, { password: newPassword });
149
- return ResetPasswordByEmailStatus.SUCCESS;
150
- } catch (error: any) {
151
- return ResetPasswordByEmailStatus.INTERNAL_ERROR;
152
- }
153
- }
154
-
155
- export async function resetPasswordById(userId: string, password: ResetPassword, databaseConfig: RealtimeDatabase): Promise<ResetPasswordByIdStatus> {
156
- userId = userId.trim();
157
-
158
- if (!userId) return ResetPasswordByIdStatus.MISSING_USER_EMAIL;
159
-
160
- const newPassword = password.newPassword.trim();
161
- const confirmNewPassword = password.confirmNewPassword.trim();
162
-
163
- if (!newPassword || newPassword === "") return ResetPasswordByIdStatus.MISSING_NEW_PASSWORD;
164
- if (!confirmNewPassword || confirmNewPassword === "") return ResetPasswordByIdStatus.MISSING_CONFIRM_NEW_PASSWORD;
165
-
166
- const passwordPolicy = password.passwordPolicy;
167
-
168
- if (!passwordPolicy) return ResetPasswordByIdStatus.MISSING_PASSWORD_POLICY;
169
-
170
- const identifier: RateLimitIdentifier = {
171
- id: userId,
172
- target: "reset_password"
173
- };
174
-
175
- const rule: RateLimitRule = {
176
- ttl: 2 * 60 * 1000,
177
- windowMs: 3 * 60 * 1000,
178
- maxHits: 5,
179
- };
180
-
181
- if (await isRateLimited(identifier, rule, databaseConfig) !== RateLimitCheckStatus.LIMIT_NOT_FOUND) {
182
- return ResetPasswordByIdStatus.TOO_MANY_REQUEST;
183
- }
184
- await recordRateLimitHit(identifier, rule, databaseConfig);
185
-
186
- if (await isUserExistsById(userId)) return ResetPasswordByIdStatus.USER_NOT_FOUND;
187
- if (await isUserDisabledById(userId)) return ResetPasswordByIdStatus.USER_DISABLED;
188
-
189
- if (newPassword !== confirmNewPassword) return ResetPasswordByIdStatus.NOT_IDENTICAL_CONFIRM_PASSWORD;
190
-
191
- const requiredMin = Math.max(6, passwordPolicy.minLength);
192
- if (newPassword.length < requiredMin) return ResetPasswordByIdStatus.WEAK_NEW_PASSWORD;
193
-
194
- const rules = [
195
- { enabled: passwordPolicy.requireUppercase, regex: /[A-Z]/, error: ResetPasswordByIdStatus.MISSING_PASSWORD_UPPERCASE },
196
- { enabled: passwordPolicy.requireLowercase, regex: /[a-z]/, error: ResetPasswordByIdStatus.MISSING_PASSWORD_LOWERCASE },
197
- { enabled: passwordPolicy.requireDigit, regex: /[0-9]/, error: ResetPasswordByIdStatus.MISSING_PASSWORD_DIGIT },
198
- { enabled: passwordPolicy.requireSpecial, regex: /[^A-Za-z0-9]/, error: ResetPasswordByIdStatus.MISSING_PASSWORD_SPECIAL_CHAR },
199
- ];
200
-
201
- for (const rule of rules) {
202
- if (rule.enabled && !rule.regex.test(newPassword)) return rule.error;
203
- }
204
-
205
- try {
206
- await admin.auth().updateUser(userId, { password: newPassword });
207
- return ResetPasswordByIdStatus.SUCCESS;
208
- } catch (error: any) {
209
- return ResetPasswordByIdStatus.INTERNAL_ERROR;
210
- }
211
- }