FDK 8.6.7: In the local testing of apps that use the Request Method to make third-party HTTP requests, the default request timeout has been 5 seconds. In production, two configurable timeouts - five and ten seconds are available. This FDK version introduces a configurable environment variable - REQUEST_TIMEOUT that enables developers to simulate the production configuration during local testing. For more information see, Request Method Testing.
The FDK has been enhanced to ensure that apps are built on a supported version of the app development platform. When developers validate, pack, or run apps that are built using an unsupported platform version, an appropriate error message is displayed. For more information, see platform version updates.
FDK 8.6.6: An issue in generating appropriate code coverage reports has been fixed. When generating a code coverage report for a serverless app, if the app code has been modified since the last time the report was generated, the old report is deleted and a new report is generated for the modified app code.
FDK 8.6.5: An issue in generating appropriate code coverage reports has been fixed.
FDK 8.6.4: Minor engineering enhancements have been made.
FDK 8.6.3: Support has been added to store and retrieve installation parameters, configured through the Custom Installation page, by using the postConfigs() and getConfigs() methods in iparams.js. Previously, these methods could only be used in iparams.html.
FDK 8.6.2: Minor engineering enhancements have been made.
FDK 8.6.1: Minor engineering enhancements have been made.
FDK 8.6.0: The developer platform has been upgraded to support a new app setup event - afterAppUpdate. The event is triggered after an app user updates the app and thereby installs its latest available version. This enables you to perform appropriate app actions based on the event or revert to the earlier installed app version, in case of any errors. For more information, see afterAppUpdate.
FDK 8.5.0 - General Availability release of the Custom Objects feature and entity storage capability: For a long time now, the developer platform has supported only key-value storage. The developer platform has been enhanced to offer entity storage. Entity storage helps provide capabilities such as reporting and aggregation of stored data, look up, retrieval, and usage of relational information, querying on stored data, and so on. Leveraging the entity storage capability, app developers can meet real-world data modelling requirements, all of which cannot be met by a product’s native objects. The products do offer custom fields to extend the existing native objects. At times, developers need entities that are related to native objects but do not exist within the product. Custom objects help with this requirement.
In this FDK version, support has been added to enable building apps that use custom objects and the developer platform’s entity storage capability. You can build apps that use custom objects and submit the apps as a Freshworks app or Custom app. You can also build omni apps that are compatible with both Freshsales Classic and Freshsales Suite (Formerly Freshworks CRM). For information on how to build an omni app, see Create your first app. For information on how to build an app that uses custom objects, see Entity storage - Custom Objects.
Additional engineering changelog: For oAuth authorization, the redirect/callback URL for app testing is provided in the third-party domain. If the callback URL contained white spaces, the handshakes were failing. This has been fixed.
In end-to-end testing, the app setup event listeners in manifest.json were not triggered appropriately due to a minor bug. This has been fixed.
FDK 8.4.0: Previously, due to a minor bug, when iparams were used to construct the manifest.json > whitelisted-domains values, the values were not being constructed appropriately. This has been fixed and URL type iparams, which are used in whitelisted-domains, are successfully substituted with appropriate values. For the valid format of specifying whitelisted-domains, when using iparams, see App Manifest.
Previously, the comparison mechanism to verify if a request URL is whitelisted in the manifest was such that even if the hostnames matched there were errors displayed due to a strict string comparison. This has been fixed.
Previously, if whitelisted-domains had a local host listed, the domains listed after the local host were not verified for errors. This has been fixed and appropriate error messages are displayed if any of the whitelisted-domains values are not valid.
FDK 8.3.3 : Minor engineering enhancements have been made.
FDK 8.3.2 : The FDK has been enhanced to ensure that the sensitive iparams retrieved through request methods are secure. If secure iparams are used in the request body or URL, the values for these iparams are not substituted and an error is thrown. For more information, see Request method.
FDK 8.3.1: Minor engineering enhancements were made.
FDK 8.3.0: Known issues and minor bugs have been fixed.
FDK 8.2.0: Known issues and minor bugs have been fixed.
FDK 8.1.1: Known issues and minor bugs have been fixed.
FDK 8.1.0: The FDK has been updated to manage app dependencies efficiently. During the Freshworks CLI installation, ensure to use an appropriate npm version (the version shipped with the Node.js that you are using) instead of other npm versions or other package managers such as yarn. For information on supported Node versions, see FDK and compatible Node.js versions.
FDK 8.0.1: Support has been added to enable the use of ES2020 features when building back-end/serverless apps.
FDK 8.0.0: The developer platform has been upgraded to run published apps on Node.js version 14. FDK 8.0.0 contains the corresponding changes to support app creation, testing, validation, and packing in a local developer environment that is based on Node.js 14. Support for Node.js 12.xx will be deprecated shortly. Ensure to migrate to FDK 8.0.0 before the deprecation. For any migration related information, see Migration overview.
Support has been added to enable the use of ES2020 features when building front-end apps.
FDK 7.5.0 andFDK 7.5.1: Known issues and minor bugs have been fixed.
FDK 7.4.2: Known issues and minor bugs have been fixed.
FDK 7.4.1: Known issues and minor bugs have been fixed.
FDK 7.4.0: In the near term, after you update your FDK to the latest version, a link to the changelog that details the modifications in the current version over the previous version will be displayed. In this FDK release, a placeholder for the changelog link has been added.
--skip-update-check: This root command option has been added to prevent the FDK from checking for version updates, when the Freshworks CLI commands are run. For more information, see the version update lifecycle.
The App Management Portal (AMP) / Apps gallery that can be accessed through Admin Settings > Marketplace and Integrations > Marketplace Apps has been enhanced to provide a better user experience. For information on the different types of apps and how to submit an app through the new AMP, see Marketplace Listing.
FDK 7.3.0 : Known issues and minor bugs have been fixed.
FDK 7.1.0, FDK 7.1.1, and FDK 7.1.2: Known issues and minor bugs have been fixed.
FDK 7.0.1: Support has been added to enable the use of ES6+ (ES2018) features when building front-end apps. This enables using ES6+ constructs such as async/await.
FDK 7.0.0: The developer platform has been upgraded to run published apps on Node.js version 12.22.xx. FDK 7.0.0 contains the corresponding changes to support app creation, testing, validation, and packing in a local developer environment that is based on Node.js 12.22.xx. Support for Node.js 10.xx has been deprecated.
To enable the FDK to validate that the appropriate node and FDK versions are used, an attribute - engines - has been provided in manifest.json. When developers use FDK 7.0.0 to create an app, the engines value is auto-populated. When developers validate existing apps that were built by using the earlier versions of the FDK, the FDK prompts developers to update manifest.json. For information on the steps involved in app validation, see Validate. For more information on the engines attribute, see App Manifest.
Support has been added to enable the use of ES6+ (ES2018) features when building back-end/ serverless apps. This enables using ES6+ constructs such as async/await.
FDK 6.13.1 and FDK 6.13.2: Known issues and minor bugs have been fixed.
FDK 6.13.0: As part of our ongoing initiatives that enable developers to build secure apps, the app development platform has been upgraded. The latest platform version is 2.2. When building apps on the latest platform version,
- Ensure that all SMI functions/methods, defined in the serverless component of an SMI app, are registered (allow listed) in the app manifest. To enable this, a new attribute (functions) has been introduced in manifest.json. The functions attribute also contains a provision to specify function-based app execution timeouts for an SMI app.
- Ensure that all events defined in the server.js file of a serverless app and the corresponding callback methods are registered in manifest.json. To enable this, an attribute (events) has been introduced in manifest.json.
FDK 6.12.0: Known issues and minor bugs have been fixed.
FDK 6.11.1: Known issues and minor bugs have been fixed.
FDK 6.11.0: The FDK has been enhanced to ensure that all Request method calls to third-party domains are secure. This is achieved through domain whitelisting. For more information, see App Manifest.
FDK 6.9.8, FDK 6.9.9, and 6.10.0: Known issues and minor bugs have been fixed.
End-to-end testing: A mechanism to test the lifecycle events of locally running apps, without having to use a custom UI, has been introduced. For more information, see End-to-End Testing.
FDK 6.9.5, 6.9.6, and 6.9.7: Known issues and minor bugs have been fixed.
FDK 6.9.0, 6.9.1, 6.9.2, 6.9.3, and 6.9.4: Known issues and minor bugs have been fixed.
FDK 6.8.0: Known issues and minor bugs have been fixed.
FDK 6.7.0, 6.7.1, and 6.7.2: Known issues and minor bugs have been fixed.