akeyless-server-commons 1.0.76 → 1.0.77

package/dist/middlewares/auth_mw.js

@@ -1,49 +0,0 @@
-import { verify_token, json_failed, query_document_optional, get_user_by_identifier } from "../helpers";
-import { logger } from "../managers";
-export const verify_user_auth = async (req, res, next) => {
-    try {
-        const user = await verify_token(req.headers.authorization);
-        req.body.firebase_user = user;
-        next();
-    }
-    catch (error) {
-        logger.error("error from verify user auth", error);
-        res.status(403).send(json_failed(error));
-    }
-};
-export const nx_user_login = async (req, res, next) => {
-    try {
-        const authorization = req.headers.authorization;
-        const user_data = await verify_token(authorization);
-        const { phone_number, email } = user_data;
-        if (!phone_number && !email) {
-            throw "Invalid authorization token";
-        }
-        const nx_user = await get_user_by_identifier(phone_number || email);
-        if (!nx_user) {
-            throw `No user found with phone number: ${phone_number} or email: ${email}.`;
-        }
-        req.body.user = nx_user;
-        next();
-    }
-    catch (error) {
-        res.status(403).send(json_failed(error));
-    }
-};
-export const client_login = async (req, res, next) => {
-    try {
-        const token = req.headers.authorization;
-        if (!token) {
-            throw new Error("Authorization token not found.");
-        }
-        const client_data = (await query_document_optional("nx-clients", "api_token", "==", token));
-        if (!client_data) {
-            throw new Error(`No client found with token: ${token} .`);
-        }
-        req.body.client = client_data;
-        next();
-    }
-    catch (error) {
-        res.status(403).send(json_failed(error.message || error));
-    }
-};

package/dist/middlewares/error_handling.js

@@ -1,19 +0,0 @@
-/**
- * Utility to handle async errors
- */
-const async_error_handler = (service) => {
-    return (req, res, next) => {
-        Promise.resolve(service(req, res)).catch(next);
-    };
-};
-/**
- * Global error-handling middleware.
- */
-const error_handler = (err, req, res, next) => {
-    console.error("Global Error Handler:", err.stack);
-    res.status(500).json({
-        status: "error",
-        message: err.message || "Internal Server Error",
-    });
-};
-export { error_handler, async_error_handler };

package/dist/middlewares/global_mw.js

@@ -1,50 +0,0 @@
-import { json_failed } from "../helpers";
-const validateParameter = (data, parameter) => {
-    if (data[parameter.key] === undefined) {
-        throw `missing mandatory parameter: ${parameter.key}`;
-    }
-    if (parameter.type === "array" && !Array.isArray(data[parameter.key])) {
-        throw `parameter ${parameter.key} must be of type: Array`;
-    }
-    if (typeof data[parameter.key] !== parameter.type && parameter.type !== "array") {
-        throw `parameter ${parameter.key} must be of type: ${parameter.type}`;
-    }
-    if ((Array.isArray(data[parameter.key]) && parameter.length && data[parameter.key].length < parameter.length) ||
-        (parameter.type === "string" && parameter.length && data[parameter.key].length < parameter.length)) {
-        throw `parameter ${parameter.key} must have minimum length: ${parameter.length}`;
-    }
-    if (parameter.type === "object" && parameter.required_keys) {
-        const missingKeys = parameter.required_keys.filter((key) => data[parameter.key][key] === undefined);
-        if (missingKeys.length > 0) {
-            throw `parameter ${parameter.key} is missing required keys: ${missingKeys.join(", ")}`;
-        }
-        parameter.required_keys.forEach((key) => {
-            const value = data[parameter.key][key];
-            if ((typeof value === "string" || Array.isArray(value)) && value.length === 0) {
-                throw `parameter ${key} in ${parameter.key} must have some length `;
-            }
-        });
-    }
-};
-export const mandatory = ({ body, headers }) => {
-    return (req, res, next) => {
-        try {
-            const body_data = req.body;
-            const headers_data = req.headers;
-            if (body) {
-                body.forEach((parameter) => {
-                    validateParameter(body_data, parameter);
-                });
-            }
-            if (headers) {
-                headers.forEach((parameter) => {
-                    validateParameter(headers_data, parameter);
-                });
-            }
-            next();
-        }
-        catch (error) {
-            return res.status(500).send(json_failed(error));
-        }
-    };
-};

package/dist/middlewares/index.js

@@ -1,3 +0,0 @@
-export * from "./global_mw";
-export * from "./auth_mw";
-export * from "./error_handling";

package/dist/test.js

@@ -1 +0,0 @@
-"use strict";

package/dist/types/enums/global.js

@@ -1,18 +0,0 @@
-export var SimProvider;
-(function (SimProvider) {
-    SimProvider["partner"] = "partner";
-    SimProvider["pelephone"] = "pelephone";
-    SimProvider["celcom"] = "celcom";
-    SimProvider["monogoto"] = "monogoto";
-    SimProvider["unknown"] = "unknown";
-})(SimProvider || (SimProvider = {}));
-export var NxServiceName;
-(function (NxServiceName) {
-    NxServiceName["bi"] = "bi";
-    NxServiceName["call_center"] = "call_center";
-    NxServiceName["dashboard"] = "dashboard";
-    NxServiceName["devices"] = "devices";
-    NxServiceName["installer"] = "installer";
-    NxServiceName["ox_server"] = "ox_server";
-    NxServiceName["toolbox"] = "toolbox";
-})(NxServiceName || (NxServiceName = {}));

package/dist/types/enums/index.js

@@ -1 +0,0 @@
-export * from "./global";

package/dist/types/helpers/boards_helpers.d.ts

@@ -1,7 +0,0 @@
-import { TObject } from "akeyless-types-commons";
-interface BoardProviderWithBoardTypes {
-    board_provider: "erm" | "jimi" | "ruptela" | "servision" | "jimi_iothub";
-    board_types: string[];
-}
-export declare const extract_board_types_from_settings: (settings: TObject<any>) => BoardProviderWithBoardTypes[];
-export {};

package/dist/types/helpers/email_helpers.d.ts

@@ -1,2 +0,0 @@
-import { EmailData } from "../types";
-export declare const send_email: (email_data: EmailData) => Promise<void>;

package/dist/types/helpers/firebase_helpers.d.ts

@@ -1,37 +0,0 @@
-import firebase_admin from "firebase-admin";
-import { QueryDocument, QueryDocumentByConditions, QueryDocumentOptional, QueryDocuments, QueryDocumentsByConditions, Snapshot, SnapshotBulk, SnapshotBulkByNames } from "../types";
-import { DecodedIdToken } from "firebase-admin/auth";
-import { TObject } from "akeyless-types-commons";
-export declare const service_account_firebase: {
-    type: string;
-    project_id: string;
-    private_key_id: string;
-    private_key: string;
-    client_email: string;
-    client_id: string;
-    auth_uri: string;
-    token_uri: string;
-    auth_provider_x509_cert_url: string;
-    client_x509_cert_url: string;
-    universe_domain: string;
-};
-export declare const db: firebase_admin.firestore.Firestore;
-export declare const messaging: import("firebase-admin/messaging").Messaging;
-export declare const auth: import("firebase-admin/auth").Auth;
-export declare const simple_extract_data: (doc: FirebaseFirestore.DocumentSnapshot) => TObject<any>;
-export declare const get_all_documents: (collection_path: string) => Promise<any[]>;
-export declare const query_documents: QueryDocuments;
-export declare const query_documents_by_conditions: QueryDocumentsByConditions;
-export declare const query_document_by_conditions: QueryDocumentByConditions;
-export declare const query_document: QueryDocument;
-export declare const query_document_optional: QueryDocumentOptional;
-export declare const get_document_by_id: (collection_path: string, doc_id: string) => Promise<TObject<any>>;
-export declare const get_document_by_id_optional: (collection_path: string, doc_id: string) => Promise<TObject<any> | null>;
-export declare const set_document: (collection_path: string, doc_id: string, data: {}, merge?: boolean) => Promise<void>;
-export declare const add_document: (collection_path: string, data: {}, include_id?: boolean, custom_id?: string) => Promise<void>;
-export declare const delete_document: (collection_path: string, doc_id: string) => Promise<void>;
-export declare const verify_token: (authorization: string | undefined) => Promise<DecodedIdToken>;
-export declare const snapshot: Snapshot;
-export declare const init_snapshots: () => Promise<void>;
-export declare const snapshot_bulk: SnapshotBulk;
-export declare const snapshot_bulk_by_names: SnapshotBulkByNames;

package/dist/types/helpers/global_helpers.d.ts

@@ -1,14 +0,0 @@
-import { AddAuditRecord, JsonFailed, JsonOK } from "../types";
-import { Geo, LanguageOptions, TObject } from "akeyless-types-commons";
-export declare const init_env_variables: (required_vars?: string[]) => TObject<string>;
-export declare const json_ok: JsonOK<TObject<any> | TObject<any>[]>;
-export declare const json_failed: JsonFailed;
-export declare const parse_error: (error: any) => any;
-export declare const get_version: (packageJsonPath: string) => string;
-export declare const sleep: (ms?: number) => Promise<unknown>;
-export declare const add_audit_record: AddAuditRecord;
-export declare const get_nx_service_urls: (env_name?: string) => TObject<string>;
-export declare const get_address_by_geo: ({ lat, lng }: Geo, currentLanguage: LanguageOptions) => Promise<string>;
-export declare const validate_and_cast: <T extends unknown>(variable: any, condition: Boolean) => variable is T;
-export declare const get_or_default: <T>(value: T | undefined, default_value: T | (() => T)) => T;
-export declare const remove_nulls_and_undefined: (obj: Record<string, any>) => Record<string, any>;

package/dist/types/helpers/index.d.ts

@@ -1,10 +0,0 @@
-export * from "./global_helpers";
-export * from "./firebase_helpers";
-export * from "./start";
-export * from "./time_helpers";
-export * from "./login_helpers";
-export * from "./notification_helpers";
-export * from "./email_helpers";
-export * from "./phone_number_helpers";
-export * from "./tasks_helpers";
-export * from "./boards_helpers";

package/dist/types/helpers/login_helpers.d.ts

@@ -1,4 +0,0 @@
-import { NxUser, MobileAppUser } from "akeyless-types-commons";
-export declare const convert_to_short_phone_number: (phone_number: string) => string;
-export declare const get_user_by_identifier: (identifier: string, ignore_log?: boolean) => Promise<NxUser | null>;
-export declare const get_mobile_app_user_by_uid: (uid: string, ignore_log?: boolean) => Promise<MobileAppUser | null>;

package/dist/types/helpers/notification_helpers.d.ts

@@ -1,11 +0,0 @@
-import { EventFromDevice, TObject } from "akeyless-types-commons";
-export declare const send_sms: (recepient: string, text: string, entity_for_audit: string, details?: TObject<any>) => Promise<void>;
-export declare const push_event_to_mobile_users: (event: EventFromDevice) => Promise<void>;
-type FuncSendFcmMessage = (title: string, body: string, fcm_tokens: string[], custom_sound?: string) => Promise<{
-    success: boolean;
-    response: string;
-    success_count?: number;
-    failure_count?: number;
-}>;
-export declare const send_fcm_message: FuncSendFcmMessage;
-export {};

package/dist/types/helpers/phone_number_helpers.d.ts

@@ -1,13 +0,0 @@
-import { TObject } from "akeyless-types-commons";
-import { SimProvider } from "../types/enums";
-export declare const is_long_phone_number: (phone_number: string) => boolean;
-export declare const is_israel_long_phone_number: (phone_number: string) => boolean;
-export declare const is_international_phone_number: (phone_number: string) => boolean;
-export declare const is_iccid: (number: string) => boolean;
-export declare const convert_to_short_israel_phone: (international_number: string) => string;
-export declare const is_sim_provider_partner: (phone_number: string) => any;
-export declare const is_sim_provider_pelephone: (phone_number: string) => any;
-export declare const is_sim_provider_celcom: (phone_number: string) => any;
-export declare const is_sim_provider_monogoto: (phone_number: string) => boolean;
-export declare const get_sim_provider: (phone_number: string) => SimProvider;
-export declare const long_short_phone_numbers: (phone_number: string) => TObject<any>;

package/dist/types/helpers/start.d.ts

@@ -1,5 +0,0 @@
-import { Express } from "express";
-import { MainRouter } from "../types";
-export declare const start_server: (main_router: MainRouter, project_name: string, version: string, port?: number) => Promise<Express>;
-export declare const basic_init: (main_router: MainRouter, project_name: string, version: string, port?: number) => Promise<Express>;
-export declare const nextjs_init: (project_name: string, version: string) => Promise<void>;

package/dist/types/helpers/tasks_helpers.d.ts

@@ -1,20 +0,0 @@
-import { TObject } from "akeyless-types-commons";
-export declare enum TaskName {
-    collect_gprs_balances = "collect_gprs_balances",
-    send_reset_sms = "send_reset_sms",
-    collect_devices_health = "collect_devices_health",
-    collect_billing_balance = "collect_billing_balance"
-}
-export declare enum TaskStatus {
-    running = "running",
-    completed = "completed",
-    failed = "failed",
-    suspeneded = "suspeneded"
-}
-export type TaskSaveOptions = "storage" | "db";
-export declare const execute_task: <T = any>(source: string, task_name: TaskName, task: () => Promise<T>, options?: {
-    save_in?: TaskSaveOptions;
-}) => Promise<void>;
-export declare const get_task_data: <T = any>(task_name: TaskName) => Promise<T>;
-export declare const get_task_data_from_storage: <T = any>(task_name: TaskName) => Promise<T | null>;
-export declare const keep_task_data_in_storage: (task_name: TaskName, data: any[] | TObject<any>) => Promise<string>;

package/dist/types/helpers/time_helpers.d.ts

@@ -1,26 +0,0 @@
-import { firebase_timestamp } from "akeyless-types-commons";
-/**
- * Converts a Firebase Timestamp object into a formatted string.
- *
- * @param {firebase_timestamp} firebaseTimestamp - The Firebase timestamp object containing _seconds and _nanoseconds.
- * @param {string} [format="DD-MM-YYYY HH:mm:ss"] - Optional the format string used to format the date. Default is "DD-MM-YYYY HH:mm:ss".
- * @returns {string} - A formatted date string according to the specified format or the default format.
- */
-export declare function timestamp_to_string(firebaseTimestamp: firebase_timestamp, format?: string): string;
-/**
- * Converts a Firebase Timestamp object into milliseconds since the Unix epoch.
- *
- * @param {firebase_timestamp} firebaseTimestamp - The Firebase timestamp object containing _seconds and _nanoseconds.
- * @returns {number} - Time in milliseconds
- */
-export declare function timestamp_to_millis(firebaseTimestamp: firebase_timestamp): number;
-export declare function sort_by_timestamp(a: firebase_timestamp, b: firebase_timestamp, reverse?: boolean): number;
-export interface TimePassedByDate {
-    seconds_passed: number;
-    minutes_passed: number;
-    hours_passed: number;
-    days_passed: number;
-    time_passed_formatted_short: string;
-    time_passed_formatted_long: string;
-}
-export declare const calculate_time_passed: (datetime: Date) => TimePassedByDate;

package/dist/types/index.d.ts

@@ -1,5 +0,0 @@
-import * as helpers from "./helpers";
-import * as managers from "./managers";
-import * as middlewares from "./middlewares";
-import * as types from "./types";
-export { helpers, managers, middlewares, types };

package/dist/types/index.js

@@ -1,3 +0,0 @@
-export * from './types';
-export * from './interfaces';
-export * from './enums';

package/dist/types/interfaces/email.js

@@ -1 +0,0 @@
-export {};

package/dist/types/interfaces/global.js

@@ -1 +0,0 @@
-export {};

package/dist/types/interfaces/index.js

@@ -1,2 +0,0 @@
-export * from './global';
-export * from './email';

package/dist/types/managers/cache_manager.d.ts

@@ -1,11 +0,0 @@
-export declare class CacheManager {
-    private static instance;
-    private data;
-    private constructor();
-    static getInstance(): CacheManager;
-    setArrayData(key: string, data: any[]): void;
-    getArrayData(key: string): any[];
-    setObjectData(key: string, data: any): void;
-    getObjectData(key: string, default_value?: any): any;
-}
-export declare const cache_manager: CacheManager;

package/dist/types/managers/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./cache_manager";
-export * from "./translation_manager";
-export * from "./logger_manager";

package/dist/types/managers/logger_manager.d.ts

@@ -1,12 +0,0 @@
-import { TObject } from "akeyless-types-commons";
-declare class LoggerManager {
-    private static instance;
-    private constructor();
-    static getInstance(): LoggerManager;
-    private get_date;
-    log(msg: string, data?: TObject<any> | any[]): void;
-    error(msg: string, data?: any): void;
-    warn(msg: string, data?: any): void;
-}
-export declare const logger: LoggerManager;
-export {};

package/dist/types/managers/translation_manager.d.ts

@@ -1,14 +0,0 @@
-import { TObject } from "akeyless-types-commons";
-import { EntityOptions, LangOptions } from "../types";
-export declare class TranslationManager {
-    private static instance;
-    private data;
-    private constructor();
-    static getInstance(): TranslationManager;
-    setTranslationData(data: TObject<any>): void;
-    getTranslationData(): TObject<any>;
-    get_translation(scope: string, lang: string, entity: string, key: string): string;
-    get_sms(lang: LangOptions, entity: EntityOptions, key: string): string;
-    get_email(lang: LangOptions, entity: EntityOptions, key: string): string;
-}
-export declare const translation_manager: TranslationManager;

package/dist/types/middlewares/auth_mw.d.ts

@@ -1,4 +0,0 @@
-import { MW } from "../types";
-export declare const verify_user_auth: MW;
-export declare const nx_user_login: MW;
-export declare const client_login: MW;

package/dist/types/middlewares/error_handling.d.ts

@@ -1,11 +0,0 @@
-import { Request, Response, NextFunction } from "express";
-import { Service } from "../types";
-/**
- * Utility to handle async errors
- */
-declare const async_error_handler: (service: Service) => (req: Request, res: Response, next: NextFunction) => void;
-/**
- * Global error-handling middleware.
- */
-declare const error_handler: (err: Error, req: Request, res: Response, next: NextFunction) => void;
-export { error_handler, async_error_handler };

package/dist/types/middlewares/global_mw.d.ts

@@ -1,2 +0,0 @@
-import { MandatoryParams, MW } from "../types";
-export declare const mandatory: ({ body, headers }: MandatoryParams) => MW;

package/dist/types/middlewares/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./global_mw";
-export * from "./auth_mw";
-export * from "./error_handling";

package/dist/types/types/enums/global.d.ts

@@ -1,16 +0,0 @@
-export declare enum SimProvider {
-    partner = "partner",
-    pelephone = "pelephone",
-    celcom = "celcom",
-    monogoto = "monogoto",
-    unknown = "unknown"
-}
-export declare enum NxServiceName {
-    bi = "bi",
-    call_center = "call_center",
-    dashboard = "dashboard",
-    devices = "devices",
-    installer = "installer",
-    ox_server = "ox_server",
-    toolbox = "toolbox"
-}

package/dist/types/types/enums/index.d.ts

@@ -1 +0,0 @@
-export * from "./global";

package/dist/types/types/firebase_types.js

@@ -1 +0,0 @@
-export {};

package/dist/types/types/global.js

@@ -1 +0,0 @@
-export {};

package/dist/types/types/index.d.ts

@@ -1,3 +0,0 @@
-export * from './types';
-export * from './interfaces';
-export * from './enums';

package/dist/types/types/index.js

@@ -1,2 +0,0 @@
-export * from "./global";
-export * from "./firebase_types";

package/dist/types/types/interfaces/email.d.ts

@@ -1,24 +0,0 @@
-export interface EmailData {
-    subject: string;
-    entity_for_audit: string;
-    to?: string | string[];
-    from?: string | {
-        email: string;
-        name?: string;
-    };
-    group_name?: string;
-    cc?: string | string[];
-    body_plain_text?: string;
-    body_html?: string;
-}
-export interface EmailSettings {
-    default_from: {
-        email: string;
-        name?: string;
-    };
-    groups: Record<string, {
-        cc?: string[];
-        to: string[];
-    }>;
-    sendgrid_api_key: string;
-}

package/dist/types/types/interfaces/global.d.ts

@@ -1,12 +0,0 @@
-export interface MandatoryObject {
-    key: string;
-    type: "string" | "number" | "boolean" | "object" | "array";
-    length?: number;
-    required_keys?: string[];
-}
-export interface MandatoryParams {
-    body?: MandatoryObject[];
-    headers?: MandatoryObject[];
-}
-export type LangOptions = "he" | "en" | "ru" | (string & {});
-export type EntityOptions = "nx_devices" | (string & {});

package/dist/types/types/interfaces/index.d.ts

@@ -1,2 +0,0 @@
-export * from './global';
-export * from './email';

package/dist/types/types/types/firebase_types.d.ts

@@ -1,30 +0,0 @@
-import { TObject } from "akeyless-types-commons";
-export type QueryDocuments = (collection_path: string, field_name: string, operator: FirebaseFirestore.WhereFilterOp, value: any) => Promise<TObject<any>[]>;
-export type WhereCondition = {
-    field_name: string;
-    operator: FirebaseFirestore.WhereFilterOp;
-    value: any;
-};
-export type QueryDocumentsByConditions = (collection_path: string, where_conditions: WhereCondition[]) => Promise<TObject<any>[]>;
-export type QueryDocumentByConditions = (collection_path: string, where_conditions: WhereCondition[], log?: boolean) => Promise<TObject<any>>;
-export type QueryDocument = (collection_path: string, field_name: string, operator: FirebaseFirestore.WhereFilterOp, value: any, ignore_log?: boolean) => Promise<TObject<any>>;
-export type QueryDocumentOptional = (collection_path: string, field_name: string, operator: FirebaseFirestore.WhereFilterOp, value: any, ignore_log?: boolean) => Promise<TObject<any> | null>;
-export type OnSnapshotCallback = (documents: any[], config: OnSnapshotConfig) => void;
-export interface OnSnapshotParsers {
-    on_first_time?: OnSnapshotCallback;
-    on_add?: OnSnapshotCallback;
-    on_modify?: OnSnapshotCallback;
-    on_remove?: OnSnapshotCallback;
-}
-export interface OnSnapshotConfig extends OnSnapshotParsers {
-    collection_name: string;
-    extra_parsers?: OnSnapshotParsers[];
-}
-export type Snapshot = (config: OnSnapshotConfig) => Promise<void>;
-export type SnapshotBulk = (snapshots: ReturnType<Snapshot>[], label?: string) => Promise<void>;
-export type SnapshotBulkByNamesParamObject = {
-    collection_name: string;
-    extra_parsers: OnSnapshotParsers[];
-};
-export type SnapshotBulkByNamesParam = string | SnapshotBulkByNamesParamObject;
-export type SnapshotBulkByNames = (params: SnapshotBulkByNamesParam[]) => Promise<void>;

package/dist/types/types/types/global.d.ts

@@ -1,15 +0,0 @@
-import { Request, Response, Express, NextFunction } from "express";
-import { NxUser, TObject } from "akeyless-types-commons";
-export type JsonOK<T> = (data?: T) => {
-    success: true;
-    data: T | undefined;
-};
-export type JsonFailed = (error?: any, msg?: string) => {
-    success: false;
-    error: any;
-};
-export type MainRouter = (app: Express) => void;
-export type MW = (req: Request, res: Response, next: NextFunction) => void;
-export type Service = (req: Request, res: Response) => void;
-export type Route = (req: Request, res: Response, next?: NextFunction) => Response;
-export type AddAuditRecord = (action: string, entity: string, details: TObject<any>, user?: NxUser) => Promise<void>;

package/dist/types/types/types/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./global";
-export * from "./firebase_types";