@hcl-software/dxclient 221.0.0

package/dist/src/utils/constants.d.ts

@@ -0,0 +1,389 @@
+export interface IConstantsType {
+    [key: string]: string;
+}
+export declare const LOGGER_CONSTANTS: IConstantsType;
+export declare const COMMANDS: {
+    DXCLIENT: string;
+    DEPLOY_PORTLET: string;
+    UNDEPLOY_PORTLET: string;
+    SCRIPT_APPLICATION: string;
+    XMLACCESS: string;
+    SCRIPT_APPLICATION_PUSH: string;
+    SCRIPT_APPLICATION_PULL: string;
+    UNDEPLOY_SCRIPTAPPLICATION: string;
+    DEPLOY_THEME: string;
+    UNDEPLOY_THEME: string;
+    LIVESYNC: string;
+    RESTORE_SCRIPTAPPLICATION: string;
+    RESTART_DXCORE: string;
+    RESTART_CORE_PODS: string;
+    MLS_EXPORT: string;
+    MLS_IMPORT: string;
+    DEPLOY_APPLICATION: string;
+    UNDEPLOY_APPLICATION: string;
+    MANAGE_SYNDICATOR: string;
+    MANAGE_SUBSCRIBER: string;
+    HELP: string;
+    H: string;
+    GET_SYNDICATION_REPORT: string;
+    SHARED_LIBRARY: string;
+    PZN_EXPORT: string;
+    PZN_IMPORT: string;
+    DELETE_DAM_SCHEMA: string;
+    MANAGE_DAM_STAGING: string;
+    DAM_TRIGGER_REINDEXING: string;
+    RESOURCE_ENVIRONMENT_PROVIDER: string;
+    LIST_DAM_SCHEMA: string;
+    MANAGE_VIRTUAL_PORTAL: string;
+    CREATE_CREDENTIAL_VAULT: string;
+    CREATE_SYNDICATION_RELATION: string;
+    WCM_LIBRARY_EXPORT: string;
+    DIFFERENTIAL_REPORT: string;
+    WCM_LIBRARY_IMPORT: string;
+    MANAGE_DAM_ASSETS: string;
+    VERSION_COMPAT: string;
+    ACCEPT_LICENSE: string;
+};
+export declare const SUB_COMMANDS: {
+    SCRIPT_APPLICATION_PUSH: string;
+    SCRIPT_APPLICATION_PULL: string;
+    LIVESYNC_PUSH_THEME: string;
+    LIVESYNC_PULL_THEME: string;
+    LIVESYNC_PULL_WCM_DESIGN_LIBRARY: string;
+    LIVESYNC_PUSH_WCM_DESIGN_LIBRARY: string;
+    FORCE: string;
+    F: string;
+    GET_SYNDICATION_REPORT: string;
+    SHARED_LIBRARY_UPLOAD: string;
+    SHARED_LIBRARY_DELETE: string;
+    DAM_REGISTER_SUBSCRIBER: string;
+    DAM_DEREGISTER_SUBSCRIBER: string;
+    DAM_TRIGGER_STAGING: string;
+    DAM_GET_ALL_SUBSCRIBERS: string;
+    UPDATE_SECRETS: string;
+    CREATE_PROPERTY: string;
+    UPDATE_PROPERTY: string;
+    DELETE_PROPERTY: string;
+    EXPORT_PROPERTIES: string;
+    IMPORT_PROPERTIES: string;
+    LIST_VIRTUAL_PORTALS: string;
+    CREATE_VIRTUAL_PORTAL: string;
+    EXPORT_VIRTUAL_PORTAL: string;
+    IMPORT_VIRTUAL_PORTAL: string;
+    SUMMARY_REPORT: string;
+    RESOURCE_REPORT: string;
+    RETRIEVE_PROPERTY: string;
+    DAM_ASSETS_EXPORT: string;
+    DAM_ASSETS_IMPORT: string;
+    DAM_EXPORT_VALIDATE: string;
+    DAM_GET_STAGING_MISMATCH_REPORT: string;
+    DAM_FIND_STAGING_MISMATCH: string;
+    DAM_START_STAGING_RESYNC: string;
+    DAM_DELETE_STAGING_MISMATCH: string;
+};
+export declare const LIVESYNC_SUB_CMDS: string[];
+export declare const LIVESYNC_THEME_SUB_CMDS: string[];
+export declare const LIVESYNC_WCM_DESIGN_LIBRARY_SUB_CMDS: string[];
+export declare const COMMAND_ARGUMENTS: {
+    DX_PROTOCOL: string;
+    HOSTNAME: string;
+    DX_PORT: string;
+    DX_SOAP_PORT: string;
+    XML_CONFIG_PATH: string;
+    DX_USER_NAME: string;
+    DX_PASSWORD: string;
+    DX_CONNECT_USERNAME: string;
+    DX_CONNECT_PASSWORD: string;
+    DX_CONNECT_PORT: string;
+    XML_FILE: string;
+    WAR_FILE: string;
+    APPLICATION_FILE: string;
+    APPLICATION_NAME: string;
+    DX_CORE_PROFILE_NAME: string;
+    DX_CORE_PROFILE_PATH: string;
+    WCM_SITE_AREA: string;
+    WCM_CONTENT_PATH: string;
+    WCM_CONTENT_NAME: string;
+    PREBUILT_ZIP: string;
+    CONTENT_HANDLER_PATH: string;
+    MAIN_HTML_FILE: string;
+    WCM_CONTENT_TITLE: string;
+    CONTENT_ROOT: string;
+    WCM_CONTENT_ID: string;
+    VIRTUAL_PORTAL_CONTEXT: string;
+    VERSION_NAME: string;
+    THEME_NAME: string;
+    THEME_PATH: string;
+    UUID: string;
+    ENABLE: string;
+    STATE: string;
+    RINGAPI_PORT: string;
+    RINGAPI_VERSION: string;
+    EXPORT_PATH: string;
+    LTPA_TOKEN_REFRESH_TIME: string;
+    WCM_LIBRARY_ID: string;
+    ENABLE_BACKUP: string;
+    IMPORT_PATH: string;
+    LIB_FILE_PATH: string;
+    LIB_FILE_NAMES: string;
+    HELP: string;
+    DX_WAS_USER_NAME: string;
+    DX_WAS_PASSWORD: string;
+    VP_TITLE: string;
+    VP_REALM: string;
+    VP_ADMIN_GROUP: string;
+    VP_HOSTNAME: string;
+    VP_CONTEXT: string;
+    PROVIDER_NAME: string;
+    PROPERTY_NAME: string;
+    PROPERTY_VALUE: string;
+    PROPERTY_DESC: string;
+    RULES_FILE_PATH: string;
+    FILEPATH: string;
+    DX_CONTEXT_ROOT: string;
+    LIBRARIES_NAME: string;
+};
+export declare const COMMANDS_MESSAGES_PATHS: {
+    DEPLOY_PORTLET: string;
+    UNDEPLOY_PORTLET: string;
+    SCRIPT_APPLICATION_PUSH: string;
+    SCRIPT_APPLICATION_PULL: string;
+    UNDEPLOY_SCRIPT_APPLICATION: string;
+    DEPLOY_THEME: string;
+    LIVESYNC: string;
+    RESTART_DXCORE: string;
+    RESTORE_SCRIPT_APPLICATION: string;
+    XMLACCESS: string;
+    MLS_EXPORT_IMPORT: string;
+    UNDEPLOY_THEME: string;
+    DEPLOY_APPLICATION: string;
+    UNDEPLOY_APPLICATION: string;
+    MANAGE_SYNDICATOR: string;
+    MANAGE_SUBSCRIBER: string;
+    GET_SYNDICATION_REPORT: string;
+    SHARED_LIBRARY: string;
+    PZN_EXPORT: string;
+    PZN_IMPORT: string;
+    DAM_SCHEMA: string;
+    EXPORT_VIRTUAL_PORTAL: string;
+    RESOURCE_ENVIRONMENT_PROVIDER: string;
+    LIST_VIRTUAL_PORTALS: string;
+    CREATE_VIRTUAL_PORTAL: string;
+    IMPORT_VIRTUAL_PORTAL: string;
+    CREATE_CREDENTIAL_VAULT: string;
+    CREATE_SYNDICATION_RELATION: string;
+    WCM_LIBRARY_EXPORT: string;
+    DIFFERENTIAL_REPORT: string;
+    WCM_LIBRARY_IMPORT: string;
+    SUMMARY_REPORT: string;
+    RESOURCE_REPORT: string;
+    GENERIC: string;
+};
+export declare const CONSTANTS_FILE_NAMES: {
+    MESSAGES_FILE_NAME: string;
+    ERROR_MESSAGES_FILE_NAME: string;
+    LICENSE_FILE_NAME: string;
+    CONFIG_FILE_NAME: string;
+};
+export declare const CONSTANTS_FOLDER_NAME: {
+    MESSAGES_FOLDER_NAME: string;
+    ERROR_MESSAGES_FOLDER_NAME: string;
+};
+export declare const ResponseStatus: {
+    SUCCESS: string;
+};
+export declare const ENCODE_TYPE = "base64";
+export declare const URL_PATH: {
+    defaultContentHandler: string;
+    fsType1: string;
+    liveSyncTempFolderName: string;
+    webDavTheme: string;
+    dxConnectBaseUrl: string;
+    runtimeControllerBaseURL: string;
+    syndicator: string;
+    syndication: string;
+    subscriber: string;
+    status: string;
+    failedItemes: string;
+    publishServletUrl: string;
+    ringAPIURL: string;
+    damAPIURL: string;
+    publishPznImportURL: string;
+    wcmContext: string;
+    wcmV2Libraries: string;
+    wcmV2Search: string;
+    wcmV2Folders: string;
+    syndicationcreatorUrl: string;
+    wcmV2LibrariesHTMLComponent: string;
+};
+export declare const URL_PARAMS: {
+    version: string;
+    upload: string;
+    delete: string;
+    restartDXCore: string;
+    deployApplication: string;
+    undeployApplication: string;
+    exportApplication: string;
+    uploadToSharedLibraries: string;
+    deleteFromSharedLibraries: string;
+    soapPort: string;
+    applicationName: string;
+    pznContent: string;
+    pznContentWorkSpace: string;
+    listVirtualPortals: string;
+    wcmV2Limit: string;
+    dxProfileName: string;
+    dxProfilePath: string;
+    createProperty: string;
+    updateProperty: string;
+    deleteProperty: string;
+    exportProperty: string;
+    importProperty: string;
+    pznImport: string;
+    createVirtualPortal: string;
+    startApplication: string;
+    assignVPToAdminGroup: string;
+    exportWCMLibrary: string;
+    downloadPath: string;
+    sourcePath: string;
+    getFullConfigExport: string;
+    importWCMLibrary: string;
+    retrieveProperties: string;
+    libraryid: string;
+};
+export declare enum HttpStatus {
+    SUCCESS = 200,
+    CREATED = 201,
+    ACCEPTED = 202,
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    FORBIDDEN = 403,
+    NOT_FOUND = 404,
+    INTERNAL_SERVER_ERROR = 500,
+    CONFLICT = 409,
+    NO_CONTENT = 204,
+    MULTI_STATUS = 207,
+    UPDATE = 205,
+    SERVICE_UNAVAILABLE = 503,
+    IM_A_TEAPOT = 418
+}
+export declare const CONTENT_TYPE: {
+    applicationZip: string;
+    applicationUrl: string;
+    applicationJson: string;
+    textXml: string;
+    userAgent: string;
+    contentType: string;
+    accept: string;
+    multipart_formdata: string;
+};
+export declare const ACCEPT_TYPE: {
+    textOrXml: string;
+    applicationJson: string;
+};
+export declare enum FileType {
+    ZIP = "zip",
+    EAR = "ear",
+    WAR = "war",
+    JAR = "jar",
+    XML = "xml",
+    CSV = "csv",
+    JSON = "json",
+    DS_STORE = ".DS_Store",
+    HTML = "html",
+    NODES = "nodes",
+    CFG = "cfg",
+    TARGZ = "tar.gz",
+    GZ = "gz"
+}
+export declare const CONSTANT_VALUES: IConstantsType;
+export declare const RESPONSE_TYPE = "stream";
+export declare const ENABLE_BACKUP_TRUE = "true";
+export declare const HTTPS = "https";
+export declare const HTTP = "http";
+export declare const RING_API_LOGIN_PATH = "/auth/login";
+export declare const RING_API_WEB_CONTENTS_SEARCH = "/dxmyrest/webcontent/search";
+export declare const RING_API_MLS_TRANSLATION = "/dxmyrest/multilingual-config/translation";
+export declare const POST = "POST";
+export declare const GET = "GET";
+export declare const PUT = "PUT";
+export declare const DELETE = "DELETE";
+export declare const PATCH = "PATCH";
+export declare const SEARCH_PAGESIZE = 150;
+export declare const WCMElementTypes: {
+    SHORT_TEXT_COMPONENT: string;
+    TEXT_COMPONENT: string;
+    HTML_COMPONENT: string;
+    RICH_TEXT_COMPONENT: string;
+};
+export declare const CONTENT_ELEMENT_TYPE = "Element";
+export declare const WCM_TYPE = "Content";
+export declare const CONTENT_INFORMATION_TYPE = "Information";
+export declare const CONTENT_TITLE_TYPE = "Title";
+export declare const CONTENT_DESCRIPTION_TYPE = "Description";
+export interface ICreateZipType {
+    zipFilePaths: string[];
+    zipContents: string[];
+}
+export declare const zipContent: ICreateZipType;
+export declare const RESULT_TEXT: {
+    OK: string;
+    FAILED: string;
+    WARNING: string;
+};
+export declare const DX_LOGIN_PATH = "/!ut/p/um/currentuser/profile";
+export declare const DX_GET_QUERY_URI_PATH = "/!ut/p/wcmrest/query";
+export declare const DX_GET_TRANSLATIONS_URI_PATH = "/!ut/p/wcmrest/translations";
+export declare enum WCMDataType {
+    TEXT = "text/plain",
+    HTML = "text/html"
+}
+export declare const defaultExportPath: string;
+export declare const MAX_DATA_LENGTH_CONTENT = 250;
+export declare const LAST_MODIFIED_AFTER_FORMAT = "YYYY-MM-DDTHH:mm";
+export declare const WHITELIST_LOCALE: string[];
+export declare const DEFAULT_LOCALE = "en";
+export declare const SCHEMA_TYPE: {
+    ACTIVE: string;
+    INACTIVE: string;
+};
+export declare const TARGETWORKSPACE = "ROOTWORKSPACE";
+export declare const DEFAULT_TARGETPATH = "/";
+export declare const EXCLUDES: {
+    excludes: string[];
+};
+export declare const TYPES: {
+    FALSE: boolean;
+    TRUE: boolean;
+};
+export declare const REQUEST_BUFFER: number;
+export declare const REQUEST_MAXFILE_SIZE: number;
+export declare const MAX_CONTENT_LENGTH = "256 MB";
+export declare const CLIENT_SECRET = "gVkYp3s6v9y$B&E)H@MbQeThWmZq4t7w";
+declare type IListType<TValue> = {
+    [id in FeaturesEnum]: TValue;
+};
+export declare enum FeaturesEnum {
+    LIVESYNC = "LIVESYNC",
+    DAM_GET_STAGING_MISMATCH_REPORT = "DAM_GET_STAGING_MISMATCH_REPORT",
+    DAM_REINDEXING = "DAM_REINDEXING",
+    LIVESYNC_WCM = "LIVESYNC_WCM"
+}
+export declare const featureListConfig: IListType<boolean>;
+export declare const ERROR_MAX_BODY_LENGTH = "ERR_FR_MAX_BODY_LENGTH_EXCEEDED";
+export declare const ERROR_BAD_REQUEST = "ERR_BAD_REQUEST";
+export declare enum ChokidarEvent {
+    ADD = "add",
+    ADD_DIR = "addDir",
+    CHANGE = "change",
+    UNLINK = "unlink",
+    UNLINK_DIR = "unlinkDir",
+    ERROR = "error",
+    READY = "ready",
+    RAW = "raw"
+}
+export declare const LIVESYNC_WCM_LIBRARY_META_FOLDER = ".library";
+export declare const LIVESYNC_WCM_LIBRARY_META_FILENAME = "index.json";
+export declare const mandatoryDAMArguments: string[];
+export declare const COMPONENTS = "components";
+export {};