fiber-firebase-functions 1.0.2 → 1.0.4

package/src/auth/user.ts

@@ -30,7 +30,7 @@
  */
 
 import * as admin from "firebase-admin";
-import { isUserExistsByEmail, isUserExistsById } from "./is_user_exists";
+import { IsUserExists, UserExistsByEmailStatus, UserExistsByIdStatus } from "./is_user_exists";
 
 if (admin.apps.length === 0) {
     admin.initializeApp();
@@ -38,46 +38,56 @@ if (admin.apps.length === 0) {
 
 export enum UserByIdStatus {
     MISSING_USER_ID = "MISSING_USER_ID",
-    NOT_FOUND = "NOT_FOUND",
-    FOUND = "FOUND",
+    USER_NOT_FOUND = "USER_NOT_FOUND",
+    USER_FOUND = "USER_FOUND",
     INTERNAL_ERROR = "INTERNAL_ERROR",
 }
 
 export enum UserByEmailStatus {
     MISSING_EMAIL = "MISSING_EMAIL",
-    NOT_FOUND = "NOT_FOUND",
-    FOUND = "FOUND",
+    USER_NOT_FOUND = "USER_NOT_FOUND",
+    USER_FOUND = "USER_FOUND",
     INTERNAL_ERROR = "INTERNAL_ERROR",
 }
 
-export async function getUserById(userId: string): Promise<{ status: UserByIdStatus; user?: admin.auth.UserRecord; }> {
-    userId = userId.trim();
+export class User {
+    static async withId(userId: string): Promise<{ status: UserByIdStatus; user?: admin.auth.UserRecord; }> {
+        userId = userId.trim();
 
-    if (!userId) return { status: UserByIdStatus.MISSING_USER_ID };
+        if (!userId || userId === "") return { status: UserByIdStatus.MISSING_USER_ID };
 
-    if (!await isUserExistsById(userId)) return { status: UserByIdStatus.NOT_FOUND };
+        const userExists = await IsUserExists.withId(userId);
+        if (userExists === UserExistsByIdStatus.MISSING_USER_ID) return { status: UserByIdStatus.MISSING_USER_ID };
+        if (userExists === UserExistsByIdStatus.INTERNAL_ERROR) return { status: UserByIdStatus.INTERNAL_ERROR };
+        if (userExists === UserExistsByIdStatus.USER_NOT_FOUND) return { status: UserByIdStatus.USER_NOT_FOUND };
 
-    try {
-        const user = await admin.auth().getUser(userId);
+        try {
+            const user = await admin.auth().getUser(userId);
 
-        return { status: UserByIdStatus.FOUND, user: user };
-    } catch (error: any) {
-        return { status: UserByIdStatus.INTERNAL_ERROR };
+            return { status: UserByIdStatus.USER_FOUND, user: user };
+        } catch (error: any) {
+            return { status: UserByIdStatus.INTERNAL_ERROR };
+        }
     }
-}
 
-export async function getUserByEmail(email: string): Promise<{ status: UserByEmailStatus; user?: admin.auth.UserRecord; }> {
-    email = email.trim();
+    static async withEmail(email: string): Promise<{ status: UserByEmailStatus; user?: admin.auth.UserRecord; }> {
+        email = email.trim();
 
-    if (!email) return { status: UserByEmailStatus.MISSING_EMAIL };
+        if (!email || email === "") return { status: UserByEmailStatus.MISSING_EMAIL };
 
-    if (!await isUserExistsByEmail(email)) return { status: UserByEmailStatus.NOT_FOUND };
+        const userExists = await IsUserExists.withEmail(email);
+        if (userExists === UserExistsByEmailStatus.MISSING_USER_EMAIL) {
+            return { status: UserByEmailStatus.MISSING_EMAIL };
+        }
+        if (userExists === UserExistsByEmailStatus.INTERNAL_ERROR) return { status: UserByEmailStatus.INTERNAL_ERROR };
+        if (userExists === UserExistsByEmailStatus.USER_NOT_FOUND) return { status: UserByEmailStatus.USER_NOT_FOUND };
 
-    try {
-        const user = await admin.auth().getUserByEmail(email);
+        try {
+            const user = await admin.auth().getUserByEmail(email);
 
-        return { status: UserByEmailStatus.FOUND, user: user };
-    } catch (error: any) {
-        return { status: UserByEmailStatus.INTERNAL_ERROR };
+            return { status: UserByEmailStatus.USER_FOUND, user: user };
+        } catch (error: any) {
+            return { status: UserByEmailStatus.INTERNAL_ERROR };
+        }
     }
 }

package/src/common/config.ts

@@ -0,0 +1,84 @@
+/*
+ * Copyright (C) 2025 Fiber
+ *
+ * All rights reserved. This script, including its code and logic, is the
+ * exclusive property of Fiber. Redistribution, reproduction,
+ * or modification of any part of this script is strictly prohibited
+ * without prior written permission from Fiber.
+ *
+ * Conditions of use:
+ * - The code may not be copied, duplicated, or used, in whole or in part,
+ *   for any purpose without explicit authorization.
+ * - Redistribution of this code, with or without modification, is not
+ *   permitted unless expressly agreed upon by Fiber.
+ * - The name "Fiber" and any associated branding, logos, or
+ *   trademarks may not be used to endorse or promote derived products
+ *   or services without prior written approval.
+ *
+ * Disclaimer:
+ * THIS SCRIPT AND ITS CODE ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL
+ * FIBER BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING BUT NOT LIMITED TO LOSS OF USE,
+ * DATA, PROFITS, OR BUSINESS INTERRUPTION) ARISING OUT OF OR RELATED TO THE USE
+ * OR INABILITY TO USE THIS SCRIPT, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Unauthorized copying or reproduction of this script, in whole or in part,
+ * is a violation of applicable intellectual property laws and will result
+ * in legal action.
+ */
+
+import fs from "fs";
+import path from "path";
+
+export interface AppConfig {
+    rateLimiter: DatabaseConfig;
+    otp: OtpConfig;
+    email: EmailConfig;
+}
+
+export interface DatabaseConfig {
+    appName: string;
+    url: string;
+}
+
+export interface OtpConfig {
+    collection: string;
+}
+
+export interface EmailConfig {
+    applicationName: string;
+    collection: string;
+}
+
+let cachedConfig: AppConfig | null = null;
+
+export function appInitialize(): AppConfig {
+    if (cachedConfig) return cachedConfig;
+
+    const configPath = path.resolve(process.cwd(), "config", "app.json");
+
+    if (!fs.existsSync(configPath)) {
+        throw new Error(`Missing configuration file at: ${configPath}`);
+    }
+
+    const raw = fs.readFileSync(configPath, "utf-8");
+    const parsed = JSON.parse(raw);
+
+    cachedConfig = {
+        rateLimiter: {
+            appName: parsed.rate_limiter.app_name ?? undefined,
+            url: parsed.rate_limiter.url ?? undefined,
+        },
+        otp: {
+            collection: parsed.otp.collection ?? undefined
+        },
+        email: {
+            applicationName: parsed.email.application_name ?? undefined,
+            collection: parsed.email.collection ?? undefined,
+        }
+    };
+
+    return cachedConfig;
+}

package/src/common/locale.ts

@@ -0,0 +1,121 @@
+/*
+ * Copyright (C) 2025 Fiber
+ *
+ * All rights reserved. This script, including its code and logic, is the
+ * exclusive property of Fiber. Redistribution, reproduction,
+ * or modification of any part of this script is strictly prohibited
+ * without prior written permission from Fiber.
+ *
+ * Conditions of use:
+ * - The code may not be copied, duplicated, or used, in whole or in part,
+ *   for any purpose without explicit authorization.
+ * - Redistribution of this code, with or without modification, is not
+ *   permitted unless expressly agreed upon by Fiber.
+ * - The name "Fiber" and any associated branding, logos, or
+ *   trademarks may not be used to endorse or promote derived products
+ *   or services without prior written approval.
+ *
+ * Disclaimer:
+ * THIS SCRIPT AND ITS CODE ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL
+ * FIBER BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING BUT NOT LIMITED TO LOSS OF USE,
+ * DATA, PROFITS, OR BUSINESS INTERRUPTION) ARISING OUT OF OR RELATED TO THE USE
+ * OR INABILITY TO USE THIS SCRIPT, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Unauthorized copying or reproduction of this script, in whole or in part,
+ * is a violation of applicable intellectual property laws and will result
+ * in legal action.
+ */
+
+export interface LanguageCode {
+    short: string;
+    full: string;
+}
+
+export enum Language {
+    ARABIC = "arabic",
+    BULGARIAN = "bulgarian",
+    CATALAN = "catalan",
+    CHINESE = "chinese",
+    CROATIAN = "croatian",
+    CZECH = "czech",
+    DANISH = "danish",
+    DUTCH = "dutch",
+    ENGLISH = "english",
+    FINNISH = "finnish",
+    FRENCH = "french",
+    GERMAN = "german",
+    GREEK = "greek",
+    HEBREW = "hebrew",
+    HINDI = "hindi",
+    HUNGARIAN = "hungarian",
+    INDONESIAN = "indonesian",
+    ITALIAN = "italian",
+    JAPANESE = "japanese",
+    KOREAN = "korean",
+    LITHUANIAN = "lithuanian",
+    MALAY = "malay",
+    NORWEGIAN = "norwegian",
+    POLISH = "polish",
+    PORTUGUESE = "portuguese",
+    ROMANIAN = "romanian",
+    RUSSIAN = "russian",
+    SLOVAK = "slovak",
+    SLOVENIAN = "slovenian",
+    SPANISH = "spanish",
+    SWEDISH = "swedish",
+    THAI = "thai",
+    TURKISH = "turkish",
+    UKRAINIAN = "ukrainian",
+    VIETNAMESE = "vietnamese"
+}
+
+export const countryCode: Record<Language, LanguageCode> = {
+    [Language.ARABIC]: { short: 'ar', full: 'ar-SA' },
+    [Language.BULGARIAN]: { short: 'bg', full: 'bg-BG' },
+    [Language.CATALAN]: { short: 'ca', full: 'ca-ES' },
+    [Language.CHINESE]: { short: 'zh', full: 'zh-CN' },
+    [Language.CROATIAN]: { short: 'hr', full: 'hr-HR' },
+    [Language.CZECH]: { short: 'cs', full: 'cs-CZ' },
+    [Language.DANISH]: { short: 'da', full: 'da-DK' },
+    [Language.DUTCH]: { short: 'nl', full: 'nl-NL' },
+    [Language.ENGLISH]: { short: 'en', full: 'en-US' },
+    [Language.FINNISH]: { short: 'fi', full: 'fi-FI' },
+    [Language.FRENCH]: { short: 'fr', full: 'fr-FR' },
+    [Language.GERMAN]: { short: 'de', full: 'de-DE' },
+    [Language.GREEK]: { short: 'el', full: 'el-GR' },
+    [Language.HEBREW]: { short: 'he', full: 'he-IL' },
+    [Language.HINDI]: { short: 'hi', full: 'hi-IN' },
+    [Language.HUNGARIAN]: { short: 'hu', full: 'hu-HU' },
+    [Language.INDONESIAN]: { short: 'id', full: 'id-ID' },
+    [Language.ITALIAN]: { short: 'it', full: 'it-IT' },
+    [Language.JAPANESE]: { short: 'ja', full: 'ja-JP' },
+    [Language.KOREAN]: { short: 'ko', full: 'ko-KR' },
+    [Language.LITHUANIAN]: { short: 'lt', full: 'lt-LT' },
+    [Language.MALAY]: { short: 'ms', full: 'ms-MY' },
+    [Language.NORWEGIAN]: { short: 'no', full: 'no-NO' },
+    [Language.POLISH]: { short: 'pl', full: 'pl-PL' },
+    [Language.PORTUGUESE]: { short: 'pt', full: 'pt-PT' },
+    [Language.ROMANIAN]: { short: 'ro', full: 'ro-RO' },
+    [Language.RUSSIAN]: { short: 'ru', full: 'ru-RU' },
+    [Language.SLOVAK]: { short: 'sk', full: 'sk-SK' },
+    [Language.SLOVENIAN]: { short: 'sl', full: 'sl-SI' },
+    [Language.SPANISH]: { short: 'es', full: 'es-ES' },
+    [Language.SWEDISH]: { short: 'sv', full: 'sv-SE' },
+    [Language.THAI]: { short: 'th', full: 'th-TH' },
+    [Language.TURKISH]: { short: 'tr', full: 'tr-TR' },
+    [Language.UKRAINIAN]: { short: 'uk', full: 'uk-UA' },
+    [Language.VIETNAMESE]: { short: 'vi', full: 'vi-VN' },
+};
+
+export namespace Language {
+    export function fullCountryCode(lang: Language): string {
+        return countryCode[lang].full;
+    }
+
+    export function shortCountryCode(lang: Language): string {
+        return countryCode[lang].short;
+    }
+}

package/src/email/email.ts

@@ -0,0 +1,70 @@
+/*
+ * Copyright (C) 2025 Fiber
+ *
+ * All rights reserved. This script, including its code and logic, is the
+ * exclusive property of Fiber. Redistribution, reproduction,
+ * or modification of any part of this script is strictly prohibited
+ * without prior written permission from Fiber.
+ *
+ * Conditions of use:
+ * - The code may not be copied, duplicated, or used, in whole or in part,
+ *   for any purpose without explicit authorization.
+ * - Redistribution of this code, with or without modification, is not
+ *   permitted unless expressly agreed upon by Fiber.
+ * - The name "Fiber" and any associated branding, logos, or
+ *   trademarks may not be used to endorse or promote derived products
+ *   or services without prior written approval.
+ *
+ * Disclaimer:
+ * THIS SCRIPT AND ITS CODE ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL
+ * FIBER BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING BUT NOT LIMITED TO LOSS OF USE,
+ * DATA, PROFITS, OR BUSINESS INTERRUPTION) ARISING OUT OF OR RELATED TO THE USE
+ * OR INABILITY TO USE THIS SCRIPT, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Unauthorized copying or reproduction of this script, in whole or in part,
+ * is a violation of applicable intellectual property laws and will result
+ * in legal action.
+ */
+
+import * as admin from "firebase-admin";
+import { appInitialize } from "../common/config";
+
+if (admin.apps.length === 0) {
+    admin.initializeApp();
+}
+
+export enum SendEmailStatus {
+    MISSING_EMAIL_CONFIG = "MISSING_EMAIL_CONFIG",
+    SUCCESS = "SUCCESS",
+}
+
+export interface EmailTemplate {
+    subject: string;
+    text: string;
+}
+
+export class Email {
+    static async send(to: string, email: EmailTemplate): Promise<SendEmailStatus> {
+        const config = appInitialize();
+        const emailConfig = config.email;
+
+        if (emailConfig.applicationName === undefined || emailConfig.collection === undefined) {
+            return SendEmailStatus.MISSING_EMAIL_CONFIG;
+        }
+
+        const firestore = admin.firestore();
+
+        await firestore.collection(emailConfig.collection).add({
+            to: [to],
+            message: {
+                subject: email.subject,
+                text: email.text,
+            },
+        });
+
+        return SendEmailStatus.SUCCESS;
+    }
+}