Release Notes

Connector Development Kit (CDK) v4.22.0 - Token Request Operation

10th June 2024

What's New

Introducing the token-request operation for enhanced authentication flexibility.

User-Facing Changes

The new token-request operation allows for customised authentication and token refresh logic, surpassing standard configurations. This feature is crucial for bespoke authorisation workflows, supporting non-standard token exchanges and complex multi-step authentication processes. It enables continuous, secure API access and broadens integration capabilities with various services.

For detailed implementation guides and more information, please visit the Tray Developer Portal.

Connector Development Kit (CDK) v4.14.0 - Deployment API

7th May 2024

What’s New

Deploy your CDK connectors seamlessly with our new Deployment API, designed to align with your CI/CD pipelines for enhanced efficiency and flexibility.

User-Facing Changes

CDK users can now utilise the Deployment API to automate the deployment of connectors directly through your CI/CD pipelines. This update allows for streamlined management and deployment across multiple regions (US, EU, APAC) using region-specific URLs and API tokens.

For detailed implementation guides and more information, please visit the Tray Developer Portal.

Connector Development Kit (CDK) - Version 4.0.0

9th April 2024

What’s New

We have made an update to our Connector Development Kit (CDK) DSL Library and CLI, now available in version 4.0.0.

This new version introduces essential upgrades including a global configuration object, Raw HTTP operations, and deployment options via RBAC token.

Please note, this upgrade is strongly recommended in order to ensure seamless use of the CDK.

User-Facing Changes:

CDK v4.0.0 enhances the development experience by integrating a global configuration object that is accessible across all connector operations, providing streamlined management of authentication types, base URLs, and headers. This release also introduces the Raw HTTP operation, enabling developers to utilise API endpoints directly without the need for predefined connector operations. This feature is vital for rapid testing and integration of new API endpoints into your workflows.

Furthermore, the new RBAC token deployment method offers a more secure and permanent way to deploy connectors compared to the traditional session tokens. This update is designed to simplify the deployment process and enhance security for continuous integration and continuous deployment (CI/CD) practices.

For implementation guidance, refer to Upgrading to CDK v4 in the Tray Developer Portal.

Connector Development Kit (CDK) v3.1.0 - OpenAPI Spec Importer Tool & Connector Sharing

14th February 2024

What’s New

This update introduces two new exciting features for CDK users:

  • Enhanced support for generating connectors from OpenAPI specifications , making it easier to integrate APIs into the Tray Platform
  • The ability for users to share deployed connectors within their organisation.

User-Facing Changes:

  • OpenAPI Spec Import: CDK users can now import OpenAPI 3.0 specifications to generate connectors even faster. This streamlines the creation of connectors for APIs with an OpenAPI spec file.
    • Supported Features & Limitations: The release supports schema internal component references, JSON OpenAPI spec version 3, and primitive types for inputs/outputs. YAML spec files, Swagger API version 2, and some authentication features remain unsupported.
    • Error Handling Enhancements: An errors.json file will be generated for any import process errors, offering clear feedback on issues to address.
  • Sharing Connectors:

    Users can now share deployed connectors with team members within the same organisation by specifying their emails directly in the CLI. This is a big first step towards enhancing collaboration and management of integrations.

For detailed implementation guides and more information, please visit the Tray Developer Portal.

Connector Development Kit (CDK) - DSL Library Update (Version 2.12.0)

17th January 2024

What’s New

We are thrilled to announce the introduction of file handling capabilities in the latest CDK version 2.12.0. This upgrade empowers connectors with robust file management, making it more convenient and efficient to handle various file types and operations in your workflows.

User-Facing Changes:

  • File Uploads and Downloads: The new file handling functionality allows connectors to seamlessly upload and download files. This includes support for various file types and sizes, enhancing the flexibility and capability of your connectors in managing file uploads and downloads.
  • Multipart Uploads: The update also introduces multipart upload implementation, enabling connectors to handle multiple file uploads efficiently.

For developers, these changes mean a more powerful and versatile platform for creating connectors that can handle complex file operations with ease.

For detailed implementation guides and more information, please visit the Tray Developer Portal.

Connector Development Kit (CDK) - DSL Library Update (Version 2.1.0)

28th November 2023

What’s New

We have made an update to our Connector Development Kit (CDK) Domain Specific Language (DSL) library, now available in version 2.1.0.

If you’re an active user of the CDK, we strongly recommend you carefully read this update in its entirety as it contains important information on breaking changes.

This update introduces some key enhancements that streamline the handling of HTTP operations and improve overall functionality.

  • Mandatory Body Specification : You now need to explicitly specify request bodies in the DSL, even if they are empty.
  • Content-Type Specification : When specifying the body, the content type for both requests and responses is set, allowing the runtime to serialise or deserialise the body accordingly.

User-Facing Changes

  • Request Body Specification : All request bodies must now be explicitly declared, even when empty. This is achieved using the withoutBody() function.
  • Enhanced Error Handling for Responses : The handleResponse method includes an additional withErrorHandling method, allowing for custom handling of non-2xx responses. This is optional, with the default behaviour being failure on any non-2xx response.
  • Callback in **parseBodyAs<Type>** Methods : This update mandates callbacks in these methods, except for JSON (and potentially files in the future), enhancing the DSL's type safety.
  • Context and Input Access in **handleResponse** : handleResponse methods now have access to the context and input, similar to the handleRequest methods. This allows for more comprehensive handling and processing of responses.

To ensure uninterrupted service and compatibility, you are required to:

  • Update to the CDK-DSL library version 2.1.0.
  • Make necessary changes in the handleRequest and handleResponse methods as outlined above.

Breaking Changes

With this release, previous versions of the CLI will no longer be supported for deployments. Please update to version 2.1.0 and review the below Before and After examples to better understand the changes you need to make in your code.

  • Changes in handleRequest and handleResponse Methods :
    • Before (handle Request ): .handleRequest((ctx, input, request) => request.addPathParameter('id', input.id.toString())
    • After (handle Request ): .handleRequest((ctx, input, request) => request.addPathParameter('id', input.id.toString()).withoutBody() --> notice the `withoutBody() function`
    • Before (handle Response ): .handleResponse((response) => response.parseWithBodyAsJson())
    • After (handle Response ): .handleResponse((ctx, input, response) => response.parseWithBodyAsJson() )) -> notice the extra arguments and the change in position

Connector Development Kit (CDK) - Enhancements to DDLs and Enums (Version 1.14.0)

24th November 2023

What’s New

We're thrilled to introduce new, dynamic features to the Connector Development Kit (CDK), making your development experience more intuitive and powerful.

  1. DDLs with Authentications : Dynamic Drop Down Lists (DDLs) are now more versatile. Seamlessly integrate lists from external APIs, ensuring that your dropdowns are always up-to-date and relevant. To work with authenticated endpoints, you can now pass along tokens effortlessly for secure and seamless operations.
  2. Enumerations with Custom Labels : Enhance the readability and user-friendliness of your enums. Customise display names in dropdowns with simple annotations, making your connector cleaner and more intuitive.

Detailed Feature Insights:

DDLs (Dynamic Drop Down Lists)

DDLs bridge the gap between your connector and external data sources. Imagine needing to display user names in a dropdown, sourced directly from another API. With DDLs, you can create a dynamic list where selections are linked to specific IDs or other data elements.

  • Enhanced with Authentication
    • Securely connect to authenticated endpoints by passing tokens directly within your operation.
  • Simplified Syntax
    • Utilise the @lookupOperation and @lookupInput annotations to define your DDL operations and inputs with ease.
Enumerations (Static Drop Down Lists)

Enums are now more customisable. By default, they generate user-friendly display names. You can now customise these names to suit your connector’s tone and style with our new annotation feature.

  • Custom Labeling
    • Use @enumLabels to provide distinct, custom labels for your enums, enhancing the user experience.

Connector Development Kit (CDK) 1.14.0

8th November 2023

We are pleased to announce the release of Connector Development Kit (CDK) version 1.14.0.

This update does not introduce new features, it underscores our commitment to quality, reliability, and the best possible user experience.

Enhancements and Bug Fixes

  • CLI schema generation updates We've fine-tuned our codebase to ensure a smoother and quicker startup. Users should now experience a 20% increase in speed when launching AcmeWidget.
  • User Interface Polish : Minor tweaks have been made to the user interface to streamline navigation and reduce the number of clicks needed to perform common tasks.
  • Enhanced Search Functionality : Search results within the application are now more accurate and return relevant results faster.
  • Fixed Syncing Issue : Resolved a synchronization problem that some users encountered when updating widgets simultaneously across multiple devices.
  • Corrected Text Formatting : Addressed an issue where text formatting was not being saved correctly in certain scenarios.
  • Updated Documentation : The user guide and online help resources have been revised for clarity and comprehensiveness, making it easier for new and existing users to find the information they need.

Acknowledgments

We want to thank our dedicated user community for your invaluable feedback, which has directly influenced many of the improvements.

Beta Launch of CDK (Connector Development Kit)

16th October 2023

Tray is excited to announce the Beta release of our Connector Development Kit (CDK).

What is CDK? The CDK is a brand new custom DSL powered by Typescript. It empowers any Tray user to seamlessly build, maintain, and share Tray connectors, enhancing integration capabilities and expanding possibilities.

Why CDK? CDK arises from our commitment to offer superior flexibility and autonomy to our users. With this tool, our vision is to supercharge all Tray users to tailor connectors to their unique needs, and also contribute to a richer, communal pool of resources.

Getting Started The CDK is available for exploration now. We've ensured ample resources are on hand to assist users in this journey, including comprehensive documentation and tutorials. As this is a Beta release, we highly value and encourage feedback to refine and enhance the CDK experience.

What's Next? Stay tuned for continuous updates and enhancements to CDK. As we move forward, we anticipate introducing a range of new features to further support and elevate the development experience.