GFI : Script to add a new connector #3539
Description
Summary
A script to add a new connector in the Control Centre .
Type
Enhancement
Context
A script to add a new connector in the Control Centre by automating the repetitive steps required when a connector is introduced via WASM. Instead of manually performing the same setup each time, the script will take the necessary inputs and handle all the mandatory changes, ensuring the connector is properly rendered and integrated into the Control Centre.
Current steps to add a connector :
- Add a variant for the connector in ConnectorTypes.res based on its type.
- Include the connector in the list within ConnectorUtils.res according to its type.
- Provide a description for the connector in ConnectorUtils.res.
- Map the description in the getProcessorInfo function within ConnectorUtils.res.
- Add a lowercase mapping of the connector in the getConnectorNameString function in ConnectorUtils.res, based on the connector type.
- Map the connector’s lowercase name to its variant in the getConnectorNameTypeFromString function.
- Add the connector’s display name in the getDisplayNameForProcessor function.
- Place the connector’s icon.svg (named in uppercase) under the path: public/hyperswitch/Gateway/.
Types of connectors currently :
- Processors
- PayoutProcessor
- ThreeDsAuthenticator
- PMAuthenticationProcessor
- TaxProcessor
Connector type to list mapping currently :
- Processors : connectorList
- PayoutProcessor : payoutConnectorList
- ThreeDsAuthenticator : threedsAuthenticatorList
- PMAuthenticationProcessor : pmAuthenticationConnectorList
- TaxProcessor : taxProcessorList
Starter tasks
- Review ConnectorUtils.res and ConnectorTypes.res to understand the code structure.
- Add a dummy connector to explore and learn the integration flow.
- Check different connector types in the dashboard to identify and handle edge cases.
Expected:
A script should be created to automate all the mandatory steps required for adding a new connector. When executed, it should take the necessary inputs and apply the required changes to add the connector.
Acceptance criteria
- Script to add the connector
- Script should ask for inputs such as ConnectorName , DisplayName , ConnectorType , Description and logo
- After running the command there should be file changes in ConnectorUtils.res , ConnectorTypes.res and new icon inside public/hyperswitch/Gateway/${connectorName}.svg
- Code formatted using
npx prettier --write .
Relavant Files
Resources
PRs that show how currently connectors are currently added:
Mentor contact
Helpful Docs
Pre-flight
- I read the Contributing Guide and setup
- I searched existing issues and PRs