@e-mc/types/constant.d.ts

Type definitions for E-mc.

export const enum INTERNAL {
    VERSION = '0.13.5',
    TEMP_DIR = 'tmp',
    CJS = '__cjs__'
}

export const enum VAL_MESSAGE {
    SUCCESS = 'Success',
    COMPLETED = 'Completed',
    CHECKSUM = 'Checksum matched',
    MODIFIED_FILE = 'File modified',
    MODIFIED_DIRECTORY = 'Directory was modified',
    COMMIT_TRANSACTION = 'Transactions were committed'
}

export const enum VAL_DB {
    EXEC_QUERYUNASSIGNED = 'Execute unassigned queries'
}

export const enum VAL_CLOUD {
    UPLOAD_FILE = 'Upload success',
    DOWNLOAD_FILE = 'Download success',
    COPY_FILE = 'Copy success',
    DELETE_FILE = 'Delete success',
    RENAME_FILE = 'File renamed',
    CREATE_TAG = 'Tags created',
    DELETE_TAG = 'Tags deleted',
    PUBLIC_READ = 'Grant public-read',
    CREATE_BUCKET = 'Bucket created',
    DELETE_BUCKET = 'Bucket deleted',
    EMPTY_BUCKET = 'Bucket emptied',
    CONFIGURE_BUCKET = 'Bucket configured',
    POLICY_BUCKET = 'Bucket policy configured',
    WEBSITE_BUCKET = 'Bucket website configured',
    ACL_BUCKET = 'Bucket ACL configured'
}

export const enum ERR_MESSAGE {
    UNKNOWN = 'Unknown',
    FAIL = 'FAIL!',
    WARN = 'WARN!',
    ABORTED = 'Aborted',
    EXPIRED = 'Expired',
    ABORTED_HOST = 'Aborted by host',
    ABORTED_CLIENT = 'Aborted by client',
    ABORTED_PROCESS = 'Aborted by process',
    ABORTED_OPERATION = 'This operation was aborted',
    FAILED = 'Failed',
    FAILED_CHECKSUM = 'Checksum did not match',
    PARAMETERS = 'Invalid parameters',
    FORMAT = 'Invalid format',
    COMMAND = 'Invalid command',
    CHECKSUM = 'Invalid checksum',
    CONFIG = 'Invalid config',
    RESPONSE = 'Invalid response',
    FUNCTION = 'Invalid function',
    SIZE = 'Size limit was exceeded',
    ERROR_CODE = 'Error code',
    BUSY_RESOURCE = 'Resource already in use',
    PERMISSION = 'Operation not permitted',
    EXEC_PERMISSION = 'Exec command not permitted',
    NOT_CACHEABLE = 'Not able to cache',
    NOT_COPYABLE = 'Not able to copy file',
    NOT_DIRECTORY = 'Path is not a directory',
    NOT_ABSOLUTE = 'Path is not absolute',
    NOT_READABLE = 'Not able to read buffer',
    CANCELLED = 'Transaction was cancelled',
    INCOMPLETE = 'Transaction was not completed',
    THREAD = 'Thread limit exceeded',
    THREAD_KILLED = 'Thread was killed',
    WORKER = 'Worker did not finish',
    WORKER_TIMEOUT = 'Worker timeout was exceeded',
    WORKER_FULL = 'Worker queue is full',
    TIMEOUT = 'Timeout was exceeded',
    HANDLED_REJECTION = 'Handled rejection',
    UNSUPPORTED_ACCESS = 'Unsupported access',
    UNSUPPORTED_PROTOCOL = 'Unsupported protocol',
    UNSUPPORTED_MIME = 'Unsupported MIME',
    UNSUPPORTED_READ = 'Not permitted to read file',
    UNSUPPORTED_WRITE = 'Not permitted to write file',
    UNSUPPORTED_OVERWRITE = 'Not permitted to overwrite file',
    UNSUPPORTED_PATH = 'Not permitted to set absolute path',
    NOTFOUND_PATH = 'Path not found',
    NOTFOUND_FILE = 'File not found',
    NOTFOUND_BINARY = 'Binary not found',
    NOTFOUND_PACKAGE = 'Package not found',
    NOTFOUND_MIME = 'MIME not found',
    NOTFOUND_TLS = 'TLS/SSL key and cert not found',
    INSTALL = 'Install required?',
    INLINE_METHOD = 'Unable to parse inline method',
    INLINE_OBJECT = 'Unable to parse inline object',
    PROCESS_FILE = 'Unable to process file',
    READ_FILE = 'Unable to read file',
    WRITE_FILE = 'Unable to write file',
    COPY_FILE = 'Unable to copy file',
    DELETE_FILE = 'Unable to delete file',
    RENAME_FILE = 'Unable to rename file',
    MOVE_FILE = 'Unable to move file',
    CONVERT_FILE = 'Unable to convert file',
    DOWNLOAD_FILE = 'Unable to download file',
    RESOLVE_FILE = 'Unable to resolve file',
    RESOLVE_HOSTNAME = 'Unable to resolve hostname',
    REPLACE_FILE = 'Unable to replace file',
    COMPRESS_FILE = 'Unable to compress file',
    COMPRESS_BUFFER = 'Unable to compress buffer',
    DECOMPRESS_FILE = 'Unable to decompress file',
    WATCH_FILE = 'Unable to watch file',
    EXECUTE_FILE = 'Unable to execute file',
    OVERWRITE_FILE = 'Unable to overwrite file',
    CREATE_DIRECTORY = 'Unable to create directory',
    TEMP_DIRECTORY = 'Unable to create temp directory',
    READ_DIRECTORY = 'Unable to read directory',
    WRITE_DIRECTORY = 'Unable to write directory',
    MOVE_DIRECTORY = 'Unable to move directory',
    REMOVE_DIRECTORY = 'Unable to remove directory',
    LOAD_CONFIG = 'Unable to load configuration',
    LOAD_HANDLER = 'Unable to load handler',
    READ_BUFFER = 'Unable to read buffer',
    WRITE_BUFFER = 'Unable to write buffer',
    TRANSFORM_DOCUMENT = 'Unable to transform document',
    PERFORM_TASK = 'Unable to perform task'
}

export const enum ERR_DB {
    CONSTRUCTOR = 'Not a Db constructor',
    PROVIDER_NOTFOUND = 'Database provider not found',
    MODULE_NOTFOUND = 'Db module not installed',
    UPGRADE = 'Upgrade client to latest version',
    NAME = 'Missing database name',
    INSTANCE = 'Missing instance name',
    PRODUCT = 'Missing database product',
    TABLE = 'Missing database table',
    QUERY = 'Missing database query',
    CONNECTION = 'Missing connection string',
    TLS = 'Missing TLS/SSL credentials',
    CLIENT = 'Unable to configure client',
    EXEC_QUERY = 'Unable to execute query',
    FILTER_QUERY = 'Unable to filter results',
    CONNECTION_OPEN = 'Unable to open connnection',
    CONNECTION_CLOSE = 'Unable to close connnection',
    KEY = 'Invalid key',
    VALUE = 'Invalid value',
    CREDENTIALS = 'Invalid credentials'
}

export const enum ERR_CLOUD {
    CONSTRUCTOR = 'Not a Cloud constructor',
    CREATE_BUCKET = 'Unable to create bucket',
    POLICY_BUCKET = 'Unable to update bucket policy',
    TAGGING_BUCKET = 'Unable to update bucket tagging',
    WEBSITE_BUCKET = 'Unable to set bucket website',
    DELETE_BUCKET = 'Unable to empty bucket',
    CONFIGURE_BUCKET = 'Unable to configure bucket',
    CREATE_TAG = 'Unable to create tags',
    EXISTS_BUCKET = 'Bucket does not exist',
    POLICY_INVALID = 'Invalid bucket policy',
    LIST_BUCKET = 'Unable to list bucket',
    PUBLIC_READ = 'Unable to grant public-read',
    TEMP_DIR = 'Unable to create temp directory',
    PROVIDER_NOTFOUND = 'Cloud provider not found',
    ACCOUNT_NOTFOUND = 'Cloud account not found',
    MODULE_NOTFOUND = 'Cloud module not installed',
    CREATE_BUCKET_SUPPORT = 'Create bucket not supported',
    BUCKET_POLICY_SUPPORT = 'Bucket policy not supported',
    BUCKET_TAGGING_SUPPORT = 'Bucket tagging not supported',
    DELETE_OBJECTS_SUPPORT = 'Delete objects not supported',
    COPY_OBJECT_SUPPORT = 'Copy object not supported',
    BUCKET_WEBSITE_SUPPORT = 'Set bucket website not supported',
    EXECUTE_QUERY_SUPPORT = 'Execute query not supported',
    UPLOAD_SUPPORT = 'Upload function not supported',
    DOWNLOAD_SUPPORT = 'Download function not supported',
    UPLOAD_FAIL = 'Upload failed',
    DOWNLOAD_FAIL = 'Download failed',
    DELETE_FAIL = 'Delete failed',
    COPY_FAIL = 'Copy failed',
    METADATA_FAIL = 'Metadata failed'
}

export const enum ERR_COMPRESS {
    API_KEY = 'Missing API key'
}

export const enum ERR_IMAGE {
    ROTATE = 'Unable to rotate image',
    FINALIZE = 'Unable to finalize image',
    METHOD_NAME = 'Invalid method name',
    METHOD_ARGS = 'Invalid method arguments'
}

export const enum ERR_HTTP {
    HEADERS = 'Unable to process headers',
    FORMAT = 'Unable to parse URI response',
    SERVER_WEBSOCKET = 'Unable to create WebSocket server',
    ETAG = 'ETag not supported',
    REQUEST = 'Invalid HTTP request',
    TIMEOUT = 'HTTP request timeout',
    TIMEOUT_CONNECTION = 'HTTP connection timeout',
    DATA_RECEIVED = 'No data received',
    REDIRECT_LIMIT = 'Exceeded redirect limit',
    REDIRECT_FOLLOW = 'Follow redirect was disabled',
    REDIRECT_MISSING = 'Missing redirect location',
    EXPECT_CONTINUE = 'Did not receive continue acknowledgment',
    DOWNLOAD_SUCCESS = 'No files were successfully downloaded',
    MULTIPART_ATTACH = 'No files were attached'
}

export const enum DB_TRANSACTION {
    ACTIVE = 1,
    PARTIAL = 2,
    COMMIT = 4,
    TERMINATE = 8,
    ABORT = 16,
    FAIL = 32,
    AUTH = 64,
    CACHE = 128
}

export const enum TRANSFER_TYPE {
    DISK = 1,
    STREAM = 2,
    CHUNK = 4
}

export const enum TIME {
    Y = 1000 * 60 * 60 * 24 * 7 * 52,
    M = 1000 * 60 * 60 * 24 * 30,
    W = 1000 * 60 * 60 * 24 * 7,
    D = 1000 * 60 * 60 * 24,
    H = 1000 * 60 * 60,
    m = 1000 * 60,
    S = 1000
}

export const enum PACKAGE_NAME {
    CLOUD = '@e-mc/cloud',
    CLOUD_UTIL = '@e-mc/cloud/util',
    COMPRESS = '@e-mc/compress',
    CORE = '@e-mc/core',
    DB = '@e-mc/db',
    DB_POOL = '@e-mc/db/pool',
    DB_UTIL = '@e-mc/db/util',
    DOCUMENT = '@e-mc/document',
    DOCUMENT_ANDROID = '@pi-r/android',
    DOCUMENT_CHROME = '@pi-r/chrome',
    DOCUMENT_TRANSFORM = '@e-mc/document/transform',
    DOCUMENT_UTIL = '@e-mc/document/util',
    FILE_MANAGER = '@e-mc/file-manager',
    IMAGE = '@e-mc/image',
    IMAGE_JIMP = '@pi-r/jimp',
    MODULE = '@e-mc/module',
    REQUEST = '@e-mc/request',
    REQUEST_HTTP_HOST = '@e-mc/request/http/host',
    REQUEST_UTIL = '@e-mc/request/util',
    TASK = '@e-mc/task',
    TASK_GULP = '@pi-r/gulp',
    TYPES = '@e-mc/types',
    WATCH = '@e-mc/watch',
    WATCH_FILEGROUP = '@e-mc/watch/filegroup'
}

export const enum MIME_TYPE {
    MULTIPART = 'multipart/form-data',
    URLENCODED = 'application/x-www-form-urlencoded',
    JSON = 'application/json',
    TEXT = 'text/plain',
    OCTET_STREAM = 'application/octet-stream'
}

export const enum ASSET_FLAG {
    NONE = 0,
    IGNORE = 1,
    CLONE = 2,
    USING = 4,
    WATCH = 8,
    MODIFIED = 16,
    PROCESS = 32,
    MAIN = 64,
    EXISTS = 128
}

export const enum LOG_TYPE {
    UNKNOWN = 0,
    SYSTEM = 1,
    NODE = 2,
    PROCESS = 4,
    COMPRESS = 8,
    WATCH = 16,
    FILE = 32,
    CLOUD = 64,
    TIME_ELAPSED = 128,
    TIME_PROCESS = 256,
    FAIL = 512,
    HTTP = 1024,
    IMAGE = 2048,
    EXEC = 4096,
    PERMISSION = 8192,
    TIMEOUT = 16384,
    STDOUT = 32768,
    DB = 65536
}

export const enum LOG_STATE {
    STDIN,
    STDOUT,
    STDERR
}

export const enum STATUS_TYPE {
    UNKNOWN,
    FATAL,
    ERROR,
    WARN,
    INFO,
    DEBUG,
    ASSERT,
    TRACE
}

export const enum READDIR_SORT {
    FILE,
    DIRECTORY,
    DESCENDING
}

export const enum SETTINGS_KEY_NAME {
    NODE_PROCESS_CPUUSAGE = "node.process.cpu_usage",
    NODE_PROCESS_MEMORYUSAGE = "node.process.memory_usage",
    NODE_PROCESS_INLINE = "node.process.inline",
    NODE_REQUIRE_EXT = "node.require.ext",
    NODE_REQUIRE_NPM = "node.require.npm",
    NODE_REQUIRE_INLINE = "node.require.inline",
    NODE_POSIX_STRICT = "node.posix.strict",
    NODE_PACKAGE_MANAGER = "node.settings.package_manager",
    TEMP_DIR = "temp.dir",
    TEMP_WRITE = "temp.write",
    PROCESS_PASSWORD = "process.password",
    PROCESS_ENV_APPLY = "process.env.apply",
    PROCESS_THREAD_WORKER_USERS = "process.thread.worker.users",
    PROCESS_CIPHER_ALGORITHM = "process.cipher.algorithm",
    PERMISSION_PROCESS_EXEC = "permission.process_exec",
    PERMISSION_HOMEREAD = "permission.home_read",
    PERMISSION_HOMEWRITE = "permission.home_write",
    MEMORY_SETTINGS_USERS = "memory.settings.users",
    MEMORY_SETTINGS_CACHE_DISK = "memory.settings.cache_disk",
    ERROR_OUT = "error.out",
    ERROR_FATAL = "error.fatal",
    BROADCAST_OUT = "broadcast.out",
    LOGGER_LEVEL = "logger.level"
}

export const enum CACHE_SIZE {
    CORE_CLIENTDB_PARTITION_SIZE = 16,
    CORE_CLIENTDB_PARTITION_MULT = 2,
    CLOUD_PARTITION_SIZE = 16,
    CLOUD_PARTITION_MULT = 2,
    DB_PARTITION_SIZE = 16,
    DB_PARTITION_MULT = 2,
    FILE_MANAGER_DISK_LIMIT = '1gb',
    FILE_MANAGER_MEMORY_LIMIT = '100mb',
    FILE_MANAGER_MEMORY_LIMIT_ALL = '512mb'
}