skyflow-node/lib/utils/index.d.ts

Skyflow SDK for Node.js

import Credentials from "../vault/config/credentials";
import { StringKeyValueMapType } from "../vault/types";
export declare const SDK_METRICS_HEADER_KEY = "sky-metadata";
export declare const SKYFLOW_ID = "skyflowId";
export declare const BAD_REQUEST = "Bad Request";
export declare const SKYFLOW_AUTH_HEADER_KEY = "x-skyflow-authorization";
export declare const REQUEST_ID_KEY = "x-request-id";
export declare const LOGLEVEL = "loglevel";
export declare const CREDENTIALS = "credentials";
export declare const VAULT_ID = "vaultId";
export declare const CONNECTION_ID = "connectionId";
export declare const VAULT = "vault";
export declare const CONNECTION = "connection";
export declare enum TokenMode {
    DISABLE = "DISABLE",
    ENABLE = "ENABLE",
    ENABLE_STRICT = "ENABLE_STRICT"
}
export declare enum LogLevel {
    WARN = "WARN",
    INFO = "INFO",
    DEBUG = "DEBUG",
    ERROR = "ERROR",
    OFF = "OFF"
}
export declare enum AuthType {
    TOKEN = "TOKEN",
    API_KEY = "API_KEY"
}
export declare enum MessageType {
    LOG = "LOG",
    WARN = "WARN",
    ERROR = "ERROR"
}
export declare enum RequestMethod {
    POST = "POST",
    GET = "GET",
    PUT = "PUT",
    PATCH = "PATCH"
}
export declare enum Env {
    DEV = "DEV",
    STAGE = "STAGE",
    SANDBOX = "SANDBOX",
    PROD = "PROD"
}
export declare enum RedactionType {
    DEFAULT = "DEFAULT",
    PLAIN_TEXT = "PLAIN_TEXT",
    MASKED = "MASKED",
    REDACTED = "REDACTED"
}
export declare enum OrderByEnum {
    ASCENDING = "ASCENDING",
    DESCENDING = "DESCENDING",
    NONE = "NONE"
}
export declare const TYPES: {
    INSERT: string;
    INSERT_BATCH: string;
    DETOKENIZE: string;
    TOKENIZE: string;
    DELETE: string;
    UPDATE: string;
    GET: string;
    FILE_UPLOAD: string;
    QUERY: string;
    DETECT: string;
    INVOKE_CONNECTION: string;
    DEIDENTIFY_TEXT: string;
    REIDENTIFY_TEXT: string;
    DEIDENTIFY_FILE: string;
    DETECT_RUN: string;
};
export declare enum DeidenitfyFileRequestTypes {
    IMAGE = "IMAGE",
    FILE = "FILE",
    AUDIO = "AUDIO",
    PPT = "PPT",
    DOCUMENT = "DOCUMENT",
    PDF = "PDF",
    SPREADSHEET = "SPREADSHEET",
    STRUCTURED_TEXT = "STRUCTURED_TEXT",
    TEXT = "TEXT"
}
export declare const CONTROLLER_TYPES: {
    DETECT: string;
    VAULT: string;
    CONNECTION: string;
};
export declare enum DetectOutputTranscription {
    DIARIZED_TRANSCRIPTION = "diarized_transcription",
    MEDICAL_DIARIZED_TRANSCRIPTION = "medical_diarized_transcription",
    MEDICAL_TRANSCRIPTION = "medical_transcription",
    PLAINTEXT_TRANSCRIPTION = "plaintext_transcription",
    TRANSCRIPTION = "transcription"
}
export declare enum MaskingMethod {
    Blackbox = "blackbox",
    Blur = "blur"
}
export declare enum DetectEntities {
    ACCOUNT_NUMBER = "account_number",
    AGE = "age",
    ALL = "all",
    BANK_ACCOUNT = "bank_account",
    BLOOD_TYPE = "blood_type",
    CONDITION = "condition",
    CORPORATE_ACTION = "corporate_action",
    CREDIT_CARD = "credit_card",
    CREDIT_CARD_EXPIRATION = "credit_card_expiration",
    CVV = "cvv",
    DAY = "day",
    DATE = "date",
    DATE_INTERVAL = "date_interval",
    DOB = "dob",
    DOSE = "dose",
    DRIVER_LICENSE = "driver_license",
    DRUG = "drug",
    DURATION = "duration",
    EFFECT = "effect",
    EMAIL_ADDRESS = "email_address",
    EVENT = "event",
    FILENAME = "filename",
    FINANCIAL_METRIC = "financial_metric",
    GENDER = "gender",
    HEALTHCARE_NUMBER = "healthcare_number",
    INJURY = "injury",
    IP_ADDRESS = "ip_address",
    LANGUAGE = "language",
    LOCATION = "location",
    LOCATION_ADDRESS = "location_address",
    LOCATION_ADDRESS_STREET = "location_address_street",
    LOCATION_CITY = "location_city",
    LOCATION_COORDINATE = "location_coordinate",
    LOCATION_COUNTRY = "location_country",
    LOCATION_STATE = "location_state",
    LOCATION_ZIP = "location_zip",
    MARITAL_STATUS = "marital_status",
    MEDICAL_CODE = "medical_code",
    MEDICAL_PROCESS = "medical_process",
    MONEY = "money",
    MONTH = "month",
    NAME = "name",
    NAME_FAMILY = "name_family",
    NAME_GIVEN = "name_given",
    NAME_MEDICAL_PROFESSIONAL = "name_medical_professional",
    NUMERICAL_PII = "numerical_pii",
    OCCUPATION = "occupation",
    ORGANIZATION = "organization",
    ORGANIZATION_ID = "organization_id",
    ORGANIZATION_MEDICAL_FACILITY = "organization_medical_facility",
    ORIGIN = "origin",
    PASSPORT_NUMBER = "passport_number",
    PASSWORD = "password",
    PHONE_NUMBER = "phone_number",
    PROJECT = "project",
    PHYSICAL_ATTRIBUTE = "physical_attribute",
    POLITICAL_AFFILIATION = "political_affiliation",
    PRODUCT = "product",
    RELIGION = "religion",
    ROUTING_NUMBER = "routing_number",
    SEXUALITY = "sexuality",
    SSN = "ssn",
    STATISTICS = "statistics",
    TIME = "time",
    TREND = "trend",
    URL = "url",
    USERNAME = "username",
    VEHICLE_ID = "vehicle_id",
    ZODIAC_SIGN = "zodiac_sign"
}
export declare enum TokenType {
    ENTITY_UNIQUE_COUNTER = "entity_unq_counter",
    ENTITY_ONLY = "entity_only",
    VAULT_TOKEN = "vault_token"
}
export interface ISkyflowError {
    http_status?: string | number | null;
    grpc_code?: string | number | null;
    http_code: string | number | null | undefined;
    message: string;
    request_ID?: string | null;
    details?: Array<string> | null;
}
export interface SkyflowRecordError {
    error: string;
    requestId: string | null;
    httpCode?: string | number | null;
    requestIndex?: number | null;
    token?: string | null;
}
export interface AuthInfo {
    key: string;
    type: AuthType;
}
export declare function getVaultURL(clusterID: string, env: Env): string;
export declare function getConnectionBaseURL(clusterID: string, env: Env): string;
export declare function validateToken(token: string): string;
export declare function removeSDKVersion(message: string): string;
export declare function getToken(credentials: Credentials, logLevel?: LogLevel): Promise<{
    accessToken: string;
}>;
export declare function getBearerToken(credentials?: Credentials, logLevel?: LogLevel): Promise<AuthInfo>;
export declare function getBaseUrl(url: string): string;
export declare function fillUrlWithPathAndQueryParams(url: string, pathParams?: StringKeyValueMapType, queryParams?: StringKeyValueMapType): string;
export declare const LogLevelOptions: {
    DEBUG: {
        showDebugLogs: boolean;
        showInfoLogs: boolean;
        showWarnLogs: boolean;
        showErrorLogs: boolean;
    };
    INFO: {
        showDebugLogs: boolean;
        showInfoLogs: boolean;
        showWarnLogs: boolean;
        showErrorLogs: boolean;
    };
    WARN: {
        showDebugLogs: boolean;
        showInfoLogs: boolean;
        showWarnLogs: boolean;
        showErrorLogs: boolean;
    };
    ERROR: {
        showDebugLogs: boolean;
        showInfoLogs: boolean;
        showWarnLogs: boolean;
        showErrorLogs: boolean;
    };
    OFF: {
        showDebugLogs: boolean;
        showInfoLogs: boolean;
        showWarnLogs: boolean;
        showErrorLogs: boolean;
    };
};
export declare const printLog: (message: string, messageType: MessageType, logLevel?: LogLevel) => void;
export declare const parameterizedString: (message: string, ...args: Array<string | number | number[] | LogLevel | LogLevel[] | string[]>) => string;
export declare const generateSDKMetrics: (logLevel?: LogLevel) => {
    sdk_name_version: string;
    sdk_client_device_model: string;
    sdk_client_os_details: string;
    sdk_runtime_details: string;
};
export declare const isValidURL: (url: string) => boolean | undefined;