@signiant/media-shuttle-sdk-base
Version:
The base parent sdk behind other media shuttle sdks (e.g. media-shuttle-sdk)
276 lines (275 loc) • 21.1 kB
JavaScript
/* eslint-disable */
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var defaultMessageMap = {
'signiant.error.mst.script.apikey.invalid': 'API key does not exist.',
'signiant.error.mst.script.apikey.missing': 'A valid api-key must be specified in the api-key attribute of the \u003cscript\u003e tag',
'signiant.error.mst.script.apikey.unknown': 'Could not validate the API key due to an unexpected error',
'signiant.error.validateKeyUnknown': 'An unknown error occurred while validating API key.',
'signiant.transfer.error.auth': 'Transfer authentication error.',
'signiant.transfer.error.auth.config': 'Transfer authentication error due to an incomplete configuration.',
'signiant.transfer.error.auth.credentials.incomplete': 'Transfer authentication error due to missing credentials.',
'signiant.transfer.error.auth.credentials.invalid': 'Transfer authentication error due to invalid credentials.',
'signiant.transfer.error.auth.ssl.ca': 'Transfer authentication error due to an SSL communication error with the server.',
'signiant.transfer.error.auth.ssl.ca.config': 'Transfer authentication error due to an SSL configuration error.',
'signiant.transfer.error.auth.ssl.ca.insufficientMemory': 'Transfer authentication error due to an SSL communication error with the server.',
'signiant.transfer.error.auth.ssl.ca.missing': 'Transfer authentication error due to an SSL configuration error.',
'signiant.transfer.error.auth.ssl.certificateRejected': "Transfer authentication error because the server's SSL certificate was rejected.",
'signiant.transfer.error.auth.ssl.context': 'Transfer authentication error due to an SSL communication error with the server.',
'signiant.transfer.error.autoRetry': 'The connection to your server was lost. Automatically reconnecting in 1 minute.',
'signiant.transfer.error.connection.dataChannel': 'Unable to establish a connection to the server.',
'signiant.transfer.error.connection.hostNotFound': 'Unable to establish a connection to the server.',
'signiant.transfer.error.connection.insufficientMemory': 'The connection to the server was lost.',
'signiant.transfer.error.connection.lostHeartBeat': 'The connection to the server was lost.',
'signiant.transfer.error.connection.readChannel': 'Unable to read any data from the server.',
'signiant.transfer.error.connection.writeChannel': 'Unable to write any data to the server.',
'signiant.transfer.error.failedToCancelTransfer': 'Failed to cancel transfer.',
'signiant.transfer.error.failedToProcessUploadFiles': 'Failed to process upload files.',
'signiant.transfer.error.failedToChooseDownloadFolder': 'Failed to choose download folder.',
'signiant.transfer.error.failedToChooseFolder': 'Failed to choose folder.',
'signiant.transfer.error.failedToChooseUploadFiles': 'Failed to choose upload files.',
'signiant.transfer.error.failedToRemoveUploadFiles': 'Failed to choose remove files.',
'signiant.transfer.error.failedToClearFiles': 'Failed to clear specified files.',
'signiant.transfer.error.failedToRemoveFilesFromProperty': 'Failed to remove file from Files property.',
'signiant.transfer.error.failedToClearAllFiles': 'Failed to clear all files.',
'signiant.transfer.error.failedToClearServerList': 'Failed to clear server list.',
'signiant.transfer.error.failedToDownload': 'Failed to start the download.',
'signiant.transfer.error.failedToDownloadAtPlugin': 'Failed to download files.',
'signiant.transfer.error.failedToHandleCallback': 'Failed to handle callback.',
'signiant.transfer.error.failedToHandleException': 'Failed to handle transfer exception event.',
'signiant.transfer.error.failedToHandleUploadFilesProcessed': 'Failed to handle upload files processed event',
'signiant.transfer.error.failedToCalcSelectedFileSize': 'Failed to perform processing of the selected files to calculate sizes',
'signiant.transfer.error.failedToHandleXferProgress': 'Failed to handle transfer-progress event.',
'signiant.transfer.error.failedToSetDownloadFolder': 'Failed to set chosen download folder.',
'signiant.transfer.error.failedToSetLogLevel': 'Failed to set plug-in log-level.',
'signiant.transfer.error.failedToSetUploadFiles': 'Failed to set chosen upload files.',
'signiant.transfer.error.fallbackToOneStar': 'Unable to connect to your server using 2 Star service. Connecting using 1 Star service instead.',
'signiant.transfer.error.fallbackToTwoStar': 'Unable to connect to your server using 3 Star service. Connecting using 2 Star service instead.',
'signiant.transfer.error.invalidLogLevel': 'Supplied plug-in log-level is invalid: ',
'signiant.transfer.error.invalidServer': 'Please specify a valid server.',
'signiant.transfer.error.invalidAgentForTrialKey': 'With unlicensed API keys, you can only perform transfers to/from our cloud-hosted servers.',
'signiant.transfer.error.invalidCallback': 'Please supply a callback method.',
'signiant.transfer.error.invalidDestinationDir': 'Please supply a valid Destination Directory.',
'signiant.transfer.error.invalidListOfFiles': 'Please supply a list of files as an Array.',
'signiant.transfer.error.invalidPropertyDelete': 'Please provide a String value for name of the property you wish to delete.',
'signiant.transfer.error.invalidPropertyName': 'Please provide a String value for the name of the property you wish to modify.',
'signiant.transfer.error.invalidPropertyRetrieval': 'Please provide a String value for the name of the property you wish to retrieve.',
'signiant.transfer.error.invalidTransferProperties': 'Please provide transfer properties in the form of a JSON object.',
'signiant.transfer.error.invalidTrustedCA': 'Please supply a valid certificate for the Certificate Authority',
'signiant.transfer.error.invalidFilePathHandlingMode': 'Please supply a valid File Path Handling Mode. The Mode can be either PATH or FULL or FLAT',
'signiant.transfer.error.invalidFileCollisionHandling': 'Please supply a valid File Collision Handling Mode. The Mode can be either overwrite or version ',
'signiant.transfer.error.noTransferToCancel': 'No transfer in progress to cancel.',
'signiant.transfer.error.property.agent.nameTooLong': 'The agent name property is too long.',
'signiant.transfer.error.property.bandwidthThrottle.invalid': 'The bandwidth throttle property setting is invalid.',
'signiant.transfer.error.property.destinationDir.invalid': 'The destination dir property setting is invalid.',
'signiant.transfer.error.property.destinationDir.notFound': 'The destination dir property setting is missing.',
'signiant.transfer.error.property.destinationDir.invalid.relativePath': 'The destination dir property setting is invalid: destination dir cannot be a relative path.',
'signiant.transfer.error.property.encryption.unsupported': 'The encryption property setting specifies an unsupported encryption type.',
'signiant.transfer.error.property.file.invalid': 'The file specification property is invalid.',
'signiant.transfer.error.property.file.invalidRetryCount': 'Invalid file retry property value.',
'signiant.transfer.error.property.file.notFound': 'The file property specifies a file which does not exist on the agent.',
'signiant.transfer.error.property.file.nameTooLong': 'The file property specifies a file with a name which is too long.',
'signiant.transfer.error.property.file.open': 'The file property specifies a file which can not be opened by the agent.',
'signiant.transfer.error.property.file.unsupported': 'The file property specifies a file which can not be transferred because its file type is unsupported.',
'signiant.transfer.error.property.fileCollision.invalid': 'The file collision handling property is invalid.',
'signiant.transfer.error.property.fileList.notFound': 'Unable to find any of the files requested from the server.',
'signiant.transfer.error.property.mode.invalid': 'The mode property must be set to send or receive.',
'signiant.transfer.error.property.sandbox.notFound': 'The sandbox directory property setting is invalid.',
'signiant.transfer.error.property.transport.unsupported': 'The transport property setting specifies an unsupported transport type.',
'signiant.transfer.error.property.url.invalid': 'Encountered a URL with an invalid format.',
'signiant.transfer.error.property.targetFileName.multifiles.invalid': 'Can not specify target file name mapping with multiple files to transfer.',
'signiant.transfer.error.property.targetFileName.invalid': 'Target file name mapping can not include slashes.',
'signiant.transfer.error.specifyConfigForDownload': 'Please specify configuration properties to perform an download.',
'signiant.transfer.error.specifyConfigForUpload': 'Please specify configuration properties to perform an upload.',
'signiant.transfer.error.specifyFileToDownload': 'Please specify at least one file to download.',
'signiant.transfer.error.specifyFileToUpload': 'Please specify at least one file to add to the list of files to be uploaded.',
'signiant.transfer.error.stream.fileDisposition.unsupported': 'Encountered an unsupported file disposition request.',
'signiant.transfer.error.stream.fileType.unsupported': 'Encountered an unsupported file type.',
'signiant.transfer.error.tooManyFiles': 'The number of files chosen exceeds the maximum number of allowable files.',
'signiant.transfer.error.undefinedFileSelectCallback': 'Callback is not defined for file selector.',
'signiant.transfer.error.undefinedFolderSelectCallback': 'Callback is not defined for folder selector.',
'signiant.transfer.error.undefinedListOfFiles': 'Please supply a valid list of files for the transfer.',
'signiant.transfer.error.undefinedListOfFilesToClear': 'Please supply a valid list of files to clear.',
'signiant.transfer.error.undefinedPropertyDelete': 'Please specify a valid name for the property you wish to delete.',
'signiant.transfer.error.undefinedPropertyName': 'Please specify a valid name for the property you wish to set.',
'signiant.transfer.error.undefinedPropertyRetrieval': 'Please specify a valid name for the property you wish to retrieve.',
'signiant.transfer.error.undefinedPropertyValue': 'Please specify a valid value for property ',
'signiant.transfer.error.undefinedTransferProperties': 'Please specify some properties for the transfer.',
'signiant.transfer.error.unexpectedError': 'Unable to perform transfer. Please verify the supplied transfer properties and selected files.',
'signiant.transfer.error.unexpectedProperties': 'Unable to perform transfer. Please verify the supplied transfer properties.',
'signiant.transfer.error.unexpectedResponse': 'The server returned an unexpected response during file transfer. Your transfer has been canceled.',
'signiant.transfer.error.unexpectedResponse.fileSequenceNum.notFound': 'The server returned an unexpected response during file transfer. Your transfer has been canceled.',
'signiant.transfer.error.unexpectedResponse.server.dataType': 'The server returned an unexpected response during file transfer. Your transfer has been canceled.',
'signiant.transfer.error.injected.file.entries.found': 'Injected file entries detected.',
'signiant.transfer.error.injected.dest.dir.found': 'Injected destination directory detected.',
'signiant.transfer.error.unexpectedResponse.server.malformedData': 'The server returned an unexpected response during file transfer. Your transfer has been canceled.',
'signiant.transfer.error.jobNamePrefix.invalidJobNamePrefix': 'The specified Job Name Prefix is invalid. Value must be alpha numeric and limited to 32 characters. ',
'signiant.transfer.error.jobNamePrefix.failure': 'Please provide a value for Job Name Prefix.',
'signiant.transfer.error.serviceData.failure': 'Please provide a value for Service Data.',
'signiant.transfer.error.invalidBandwidth': 'Please provide a number greater than 256000 for bandwidth throttle.',
'signiant.transfer.error.transferAlreadyStarted': 'Cannot start this transfer because it is already in progress',
'signiant.transfer.status.transferStarted': 'Transfer started',
'signiant.transfer.status.connectionStatusComponentQueued': 'Connection Queued',
'signiant.transfer.transferException': 'Exception in transfer',
'signiant.transfer.uploadFilesProcessed': 'Upload Files Processed',
'signiant.transfer.status.connected': 'Connected to server',
'signiant.transfer.status.connecting': 'Connecting to server..',
'signiant.transfer.status.disconnected': 'Disconnected from server',
'signiant.transfer.status.disconnecting': 'Disconnecting from server..',
'signiant.transfer.status.transferFailed': 'Transfer Failed.',
'signiant.transfer.status.transferring': 'Started transferring files..',
'signiant.transfer.status.transferCanceled': 'Transfer Canceled.',
'signiant.transfer.status.transferSuccessful': 'Transfer Successful.',
'signiant.transfer.event.transferRetry': 'Transfer Retries ',
'signiant.transfer.event.filesDeleted': 'Files deleted.',
'signiant.transfer.error.invalidStorageConfig': 'Invalid Storage Configuration',
//things are newly added
'signiant.transfer.error.invalidFileEncryption': 'Invalid File Encryption Configuration',
'signiant.transfer.error.invalidServerSideEncryption': 'Invalid Server Side Encryption Value',
'signiant.transfer.error.invalidManifestEndpoint': ' Invalid manifest URL. The URL must be https://.',
'signiant.transfer.error.invalidTransferRestartValue': 'Failed to set transfer restart value. Number must be an integer greater than or equal to 0',
'signiant.error.app.networkConnectivityError': "We're having problems reaching the Internet. Please check your connection then reload the page.",
'signiant.error.app.appConnectivityError': "We're having problems connecting to the Signiant App. Please ensure it is installed and running, then reload the page.",
'signiant.sigappinstall.error.no.provider': 'Failure, unknown Message Provider Information, provider: ',
};
var transportErrorCodeMap = {
//INCOMPLETE_USER_CREDENTIALS
'1': 'signiant.transfer.error.auth.credentials.incomplete',
// INVALID_CREDENTIALS
'2': 'signiant.transfer.error.auth.credentials.invalid',
//SPECIFIED_FILE_DOES_NOT_EXIST
'3': 'signiant.transfer.error.property.file.notFound',
//DOWNLOAD_FILES_DO_NOT_EXIST
'4': 'signiant.transfer.error.property.fileList.notFound',
// NO_FOLDER_CHOSEN_FOR_DOWNLOAD
'5': 'signiant.transfer.error.property.destinationDir.notFound',
// INVALID_DESTINATION_DIRECTORY
'6': 'signiant.transfer.error.property.destinationDir.invalid',
//CONNECTION_FAILURE
'7': 'signiant.transfer.error.connection.hostNotFound',
//HOST_NOT_FOUND_ERROR
'8': 'signiant.transfer.error.connection.hostNotFound',
//INSUFFICIENT_MEMORY
'9': 'signiant.transfer.error.connection.insufficientMemory',
//READ_CHANNEL_ERROR
'10': 'signiant.transfer.error.connection.readChannel',
//WRITE_CHANNEL_ERROR
'11': 'signiant.transfer.error.connection.writeChannel',
//DATA_CHANNEL_TO_SERVER_FAILURE
'12': 'signiant.transfer.error.connection.dataChannel',
//LOST_HEART_BEAT
'13': 'signiant.transfer.error.connection.lostHeartBeat',
//CERTIFICATE_REJECTED
'14': 'signiant.transfer.error.auth.ssl.certificateRejected',
//FILESEQ_NOT_FOUND
'15': 'signiant.transfer.error.unexpectedResponse.fileSequenceNum.notFound',
//SERVER_MALFORMED_DATA
'16': 'signiant.transfer.error.unexpectedResponse.server.malformedData',
// UNEXPECTED_DATA
'17': 'signiant.transfer.error.unexpectedResponse.server.dataType',
//UNSUPPORTED_TRANSPORT
'18': 'signiant.transfer.error.property.transport.unsupported',
// AGENT_NAME_TOO_LONG
'19': 'signiant.transfer.error.property.agent.nameTooLong',
// INVALID_URL_IN_LIST
'20': 'signiant.transfer.error.property.url.invalid',
// INVALID_DESTINATION_DIR
'21': 'signiant.transfer.error.property.destinationDir.invalid',
// UNSUPPORTED_ENCRYPTION_TYPE
'22': 'signiant.transfer.error.property.encryption.unsupported',
// INVALID_FILE_RETRY_COUNT
'23': 'signiant.transfer.error.property.file.invalidRetryCount',
//INVALID_BANDWIDTH_THROTTLE
'24': 'signiant.transfer.error.property.bandwidthThrottle.invalid',
//NO_DESTINATION_DIR_DEFINED
'25': 'signiant.transfer.error.property.destinationDir.notFound',
//NO_SANDBOX_DEFINED
'26': 'signiant.transfer.error.property.sandbox.notFound',
//EXCEPTION_FILES_PROPERTY_NOTFOUND
'27': 'signiant.transfer.error.property.file.notFound',
//NO_FILES_TO_DOWNLOAD
'28': 'signiant.transfer.error.property.file.notFound',
//FILE_ENTRY_NOT_REG_FILE_OR_DIR
'29': 'signiant.transfer.error.property.file.unsupported',
//FILE_ENTRY_CANNOT_BE_OPENED
'30': 'signiant.transfer.error.property.file.open',
//UNSUPPORTED_FILE_TYPE
'31': 'signiant.transfer.error.stream.fileType.unsupported',
//UNSUPPORTED_FILE_DISPOSITION_REQUEST
'32': 'signiant.transfer.error.stream.fileDisposition.unsupported',
//NO_TRUSTED_CA_CERT_CONFIGURED
'33': 'signiant.transfer.error.auth.ssl.ca.missing',
//INCOMPLETE_AGENT_OR_PROTOCOL_INFO
'34': 'signiant.transfer.error.auth.config',
//ERROR_LOADING_CONFIGURED_CA_CERT
'35': 'signiant.transfer.error.auth.ssl.ca.config',
//INSUFFICIENT_MEMORY_TO_LOAD_CA_CERT
'36': 'signiant.transfer.error.auth.ssl.ca.insufficientMemory',
//ERROR_CREATING_SSL_CONTEXT
'37': 'signiant.transfer.error.auth.ssl.context',
//ERROR_BINDING_CA_CERT_TO_SSL_CONTEXT
'38': 'signiant.transfer.error.auth.ssl.ca',
//INVALID_API_KEY
'39': 'signiant.error.mst.script.apikey.invalid',
//ERROR_VERIFYING_API_KEY
'40': 'signiant.error.mst.script.apikey.unknown',
//INVALID_SERVER_FOR_API_KEY
'41': 'signiant.transfer.error.invalidServer',
//UNEXPECTED_ERROR
'42': 'signiant.transfer.error.unexpectedError',
AutomaticReconnectionWarningText: 'signiant.transfer.error.autoRetry',
'PropertyException-EMPTY_OR_INVALID_FILE_SPECIFICATION': 'signiant.transfer.error.property.file.invalid',
'PropertyException-INVALID_FILE_COLLISION_HANDLING_SPECIFICATION': 'signiant.transfer.error.property.fileCollision.invalid',
'PropertyException-INVALID_MODE_SPECIFICATION': 'signiant.transfer.error.property.mode.invalid',
'PropertyException-INVALID_URL_IN_LIST': 'signiant.transfer.error.property.url.invalid',
'StreamException-UNSUPPORTED_FILE_DISPOSITION_REQUEST': 'signiant.transfer.error.stream.fileDisposition.unsupported',
'TransferFallbackWarningText{threeStarService}{twoStarService}': 'signiant.transfer.error.fallbackToTwoStar',
'TransferFallbackWarningText{twoStarService}{oneStarService}': 'signiant.transfer.error.fallbackToOneStar',
'PropertyException-INJECTED_FILE_ENTRIES_FOUND': 'signiant.transfer.error.injected.file.entries.found',
'PropertyException-INJECTED_DEST_DIR_FOUND': 'signiant.transfer.error.injected.dest.dir.found',
'PropertyException-INVALID_FILE_ENCRYPTION_PROPERTY': 'signiant.transfer.error.invalidFileEncryption',
};
var AppErrorCodeMapper = /** @class */ (function () {
function AppErrorCodeMapper() {
this.messageMap = __assign({}, defaultMessageMap);
}
AppErrorCodeMapper.prototype.getMessage = function (messageKey) {
return this.messageMap[messageKey];
};
/**
* This function maps the Signiant app transport layer cryptic error codes to something humans can understand.
* @param transportErrorCode
* @returns { code: string; message: string }
*/
AppErrorCodeMapper.prototype.getMessageForTransport = function (transportErrorCode) {
if (transportErrorCode in this.messageMap) {
return {
code: transportErrorCode,
message: this.getMessage(transportErrorCode),
};
}
var code = transportErrorCodeMap[transportErrorCode];
if (code) {
return {
code: code,
message: this.getMessage(code),
};
}
return null;
};
return AppErrorCodeMapper;
}());
/**
* Exporting the instance over the class is intentional. If we observe the original implementation we see that
* all message callers are sharing the same message map; so we should do the same.
*/
export default new AppErrorCodeMapper();