@trayio/connector-utils

Connector-utils

Common utility functions used in connectors.

Usage

TODO: add usage guide

Documentation

Classes

GenericError ⇐ Error

Class representing the base error for all connector errors

UserInputError ⇐ GenericError

Class representing a UserInputError

ConnectorError ⇐ GenericError

Class representing a ConnectorError

ApiError ⇐ GenericError

Class representing a ConnectorError

OAuthRefresh ⇐ GenericError

Class representing a ConnectorError

NoTriggerError ⇐ GenericError

Class representing a ConnectorError

Functions

mustachedDDL(object, text, value, isInteger)

Takes value paths as mustached values and returns correct DDL outputs. A custom flag is in place to allow for keeping integer types for the value key if required, as mustaching will convert an integer to string.

DDL(object, textPath, valuePath)

Takes value paths as explicit strings and returns correct DDL outputs.

deepMapKeys(collection, iteratee)

Maps object keys and formats according to specified casing.

userInputErrorRejection(message, body)

Return a User Input Error with option to pass a body argument. The use case for this over the custom Error class is to pass a body to provide error context.

connectorErrorRejection(message, body)

Return a Connector Error with option to pass a body argument. The use case for this over the custom Error class is to pass a body to provide error context.

apiErrorRejection(message, body)

Return a API Error with option to pass a body argument. The use case for this over the custom Error class is to pass a body to provide error context.

oauthErrorRejection(message, body)

Return a oAuth Error with option to pass a body argument. The use case for this over the custom Error class is to pass a body to provide error context.

noTriggerErrorRejection(message, body)

Return a No Trigger Error with option to pass a body argument. The use case for this over the custom Error class is to pass a body to provide error context.

lookup(message, [step_settings])

Generates a lookup object for DDL operations.

removeEmptyObjects(collection)

Recursively removes empty objects, arrays and strings from a collection. It's important to note that this method will remove objects if they become empty as a result of the nested key/value containing an empty object (the same goes for arrays).

GenericError ⇐ Error

Class representing the base error for all connector errors

Kind: global class
Extends: Error

UserInputError ⇐ GenericError

Class representing a UserInputError

Kind: global class
Extends: GenericError

new UserInputError(message, ...errorArgs)

Custom error to throw for issues concerning User Input.

Param	Type	Description
message	String	Custom error message to return.
...errorArgs	any	Error args allowing for extra parameters native to the normal Error class.

ConnectorError ⇐ GenericError

Class representing a ConnectorError

Kind: global class
Extends: GenericError

new ConnectorError(message, ...errorArgs)

Custom error to throw for issues concerning the Connector.

Param	Type	Description
message	String	Custom error message to return.
...errorArgs	any	Error args allowing for extra parameters native to the normal Error class.

ApiError ⇐ GenericError

Class representing a ConnectorError

Kind: global class
Extends: GenericError

new ApiError(message, ...errorArgs)

Custom error to throw for issues concerning the Api;;.

Param	Type	Description
message	String	Custom error message to return.
...errorArgs	any	Error args allowing for extra parameters native to the normal Error class.

OAuthRefresh ⇐ GenericError

Class representing a ConnectorError

Kind: global class
Extends: GenericError

new OAuthRefresh(message, ...errorArgs)

Custom error to throw when an oAuth token has expired.

Param	Type	Description
message	String	Custom error message to return.
...errorArgs	any	Error args allowing for extra parameters native to the normal Error class.

NoTriggerError ⇐ GenericError

Class representing a ConnectorError

Kind: global class
Extends: GenericError

new NoTriggerError(message, ...errorArgs)

Custom error to throw for issues when a trigger request is ignored.

Param	Type	Description
message	String	Custom error message to return.
...errorArgs	any	Error args allowing for extra parameters native to the normal Error class.

mustachedDDL(object, text, value, isInteger)

Takes value paths as mustached values and returns correct DDL outputs. A custom flag is in place to allow for keeping integer types for the value key if required, as mustaching will convert an integer to string.

Kind: global function

Param	Type	Default	Description
object	Object		The collection with keys to iterate over and format.
text	String		The path for the required text value.
value	String		The path for the required value, value.
isInteger	Boolean	false	Flag for whether or not the value field needs to an integer rather than a string.

DDL(object, textPath, valuePath)

Takes value paths as explicit strings and returns correct DDL outputs.

Kind: global function

Param	Type	Description
object	Object	The collection with keys to iterate over and format.
textPath	String	The path for the required text value.
valuePath	String	The path fot the required value, value.

deepMapKeys(collection, iteratee)

Maps object keys and formats according to specified casing.

Kind: global function

Param	Type	Description
collection	Object	The collection with keys to iterate over and format.
iteratee	function	The format function used to format keys IE Lodash _.camelCase('some_string').

userInputErrorRejection(message, body)

Return a User Input Error with option to pass a body argument. The use case for this over the custom Error class is to pass a body to provide error context.

Kind: global function

Param	Type	Description
message	String	The error message to be returned.
body	any	Custom body to be returned when providing more error context.

connectorErrorRejection(message, body)

Return a Connector Error with option to pass a body argument. The use case for this over the custom Error class is to pass a body to provide error context.

Kind: global function

Param	Type	Description
message	String	The error message to be returned.
body	any	Custom body to be returned when providing more error context.

apiErrorRejection(message, body)

Return a API Error with option to pass a body argument. The use case for this over the custom Error class is to pass a body to provide error context.

Kind: global function

Param	Type	Description
message	String	The error message to be returned.
body	any	Custom body to be returned when providing more error context.

oauthErrorRejection(message, body)

Return a oAuth Error with option to pass a body argument. The use case for this over the custom Error class is to pass a body to provide error context.

Kind: global function

Param	Type	Description
message	String	The error message to be returned.
body	any	Custom body to be returned when providing more error context.

noTriggerErrorRejection(message, body)

Return a No Trigger Error with option to pass a body argument. The use case for this over the custom Error class is to pass a body to provide error context.

Kind: global function

Param	Type	Description
message	String	The error message to be returned.
body	any	Custom body to be returned when providing more error context.

lookup(message, [step_settings])

Generates a lookup object for DDL operations.

Kind: global function

Param	Type	Default	Description
message	String		The DDL operation that is run when the lookup is executed.
[step_settings]	Object	{}	The custom step settings for the lookup.

removeEmptyObjects(collection)

Recursively removes empty objects, arrays and strings from a collection. It's important to note that this method will remove objects if they become empty as a result of the nested key/value containing an empty object (the same goes for arrays).

Kind: global function

Param	Type	Description
collection	Object	The collection from which to remove empty objects.