akeyless-server-commons 1.0.13 → 1.0.15

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/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,24 +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 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) => 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,11 +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>;

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

@@ -1,8 +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";

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

@@ -1,3 +0,0 @@
-import { NxUser } 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) => Promise<NxUser>;

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) => Promise<Express>;
-export declare const basic_init: (main_router: MainRouter, project_name: string, version: string) => Promise<Express>;
-export declare const nextjs_init: (project_name: string, version: string) => Promise<void>;

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

@@ -1,17 +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;

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/test.d.ts

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

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) => 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";