akeyless-server-commons 1.0.203 → 1.0.204

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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,5 @@
+import { RequestHandler } from "express";
+import { LogRequests, MandatoryParams, MW } from "../types";
+export declare const mandatory: ({ body, headers }: MandatoryParams) => MW;
+export declare const optional: ({ body, headers }: MandatoryParams) => MW;
+export declare const request_logger: (log_requests: LogRequests) => RequestHandler;

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

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

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

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

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

@@ -0,0 +1,9 @@
+export declare enum SimProvider {
+    partner = "partner",
+    pelephone = "pelephone",
+    celcom = "celcom",
+    monogoto = "monogoto",
+    unknown = "unknown"
+}
+export type NxServiceName = "bi" | "call_center" | "dashboard" | "devices" | "installer" | "ox_server" | "toolbox" | "end_users" | "notifications";
+export type NxServiceNameMap = Record<NxServiceName, string>;

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

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

package/dist/types/types/firebase_types.js

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

package/dist/types/types/global.js

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

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

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

package/dist/types/types/index.js

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

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

@@ -0,0 +1,33 @@
+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;
+    attachments?: EmailAttachment[];
+}
+export interface EmailAttachment {
+    content: string;
+    filename: string;
+    type?: string;
+    disposition?: "attachment" | "inline";
+    content_id?: string;
+}
+export interface EmailSettings {
+    default_from: {
+        email: string;
+        name?: string;
+    };
+    default_cc: string[];
+    groups: Record<string, {
+        cc?: string[];
+        to: string[];
+    }>;
+    sendgrid_api_key: string;
+}

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

@@ -0,0 +1,27 @@
+import { InitSnapshotsOptions } from "../types";
+export interface MandatoryObject {
+    key: string;
+    type: "string" | "number" | "boolean" | "object" | "array";
+    length?: number;
+    required_keys?: string[];
+    array_types?: ("string" | "number" | "boolean" | "object")[];
+}
+export interface MandatoryParams {
+    body?: MandatoryObject[];
+    headers?: MandatoryObject[];
+}
+export interface LogRequests {
+    url?: boolean;
+    headers?: boolean;
+    query?: boolean;
+    body?: boolean;
+    gcp?: boolean;
+}
+export interface AppOptions {
+    port?: number;
+    log_requests?: LogRequests;
+    init_snapshot_options?: InitSnapshotsOptions;
+    initialize_redis?: boolean;
+    enable_axios_keep_alive?: boolean;
+    on_shutdown?: () => void | Promise<void> | undefined;
+}

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

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

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

@@ -0,0 +1,50 @@
+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 ExtraSnapshotConfig {
+    collection_name: string;
+    extra_parsers?: OnSnapshotParsers[];
+    conditions?: WhereCondition[];
+    cache_name?: string;
+    parse_as?: "object" | "array";
+    doc_key_property?: string;
+    subscription_type?: "redis" | "firebase";
+    debug?: Debug & {
+        extra_parsers?: Debug;
+    };
+}
+interface Debug {
+    on_first_time?: "documents" | "length";
+    on_add?: boolean;
+    on_modify?: boolean;
+    on_remove?: boolean;
+}
+export type OnSnapshotConfig = OnSnapshotParsers & ExtraSnapshotConfig;
+export type Snapshot = (config: OnSnapshotConfig) => Promise<void>;
+export type SnapshotBulk = (snapshots: ReturnType<Snapshot>[], label?: string) => Promise<void>;
+export type SnapshotBulkByNamesParamObject = Omit<ExtraSnapshotConfig, "extra_parsers"> & {
+    extra_parsers: OnSnapshotParsers[];
+};
+export type SnapshotBulkByNamesParam = string | SnapshotBulkByNamesParamObject;
+export type SnapshotBulkByNamesOptions = Pick<ExtraSnapshotConfig, "debug" | "subscription_type" | "parse_as" | "doc_key_property"> & {
+    label?: string;
+};
+export type SnapshotBulkByNames = (params: SnapshotBulkByNamesParam[], options?: SnapshotBulkByNamesOptions) => Promise<void>;
+export interface InitSnapshotsOptions extends Pick<ExtraSnapshotConfig, "subscription_type" | "debug"> {
+}
+export {};

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

@@ -0,0 +1,17 @@
+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>;
+export type LangOptions = "he" | "en" | "ru" | (string & {});
+export type EntityOptions = "nx_devices" | (string & {});

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "akeyless-server-commons",
-    "version": "1.0.203",
+    "version": "1.0.204",
     "scripts": {
         "build:cjs": "tsc --project tsconfig.cjs.json",
         "build:esm": "tsc --project tsconfig.esm.json",