@tryretool/custom-component-support

Custom component support

Visit our documentation at retool.com for more information.

Changelog

v1.7.4

• Fixed bug in v1.7.3 where the deploy command still required interactive login. Also updated this README.

v1.7.3

• Updated build command to no longer require logging in.
• Added the ability to pass the instance URL, access token, and unix socket path for deploy and sync commands via CLI arguments. The sync command also accepts the sync target's URL, access token, and unix socket path.
• Added the ability for any command line argument to be passed as an environment variable prefixed by RETOOL_CCL. For example, the following command will deploy a new version without prompting for login: RETOOL_CCL_URL=https://yourco.example.com RETOOL_CCL_ACCESS_TOKEN=retool_secret321 npx retool-ccl deploy

v1.7.2

• Reintroduce change from 1.6.0 without regression to manifest handling.

v1.7.1

• No change from 1.7.0. This was published so that 1.6.1 was no longer marked as the latest version.

v1.7.0

• Reverted change from 1.6.0, as it broke the building of the manifest.json file required for deploying new revisions.

v1.6.1

• Reverted change from 1.6.0, as it broke the building of the manifest.json file required for deploying new revisions.

v1.6.0

• The esbuild configuration was using a "file" loader to load JSON files. This meant that any statements like require('file.json') would be replaced by the string file.json by esbuild, instead of the actual contents of file.json. This build setting has been removed, so now any user code that requires JSON files are brought in as a JSON object, not a string of the filename.

v1.5.0

• Improved error messaging around fetching of settings (eg, previously used credentials, and Retool instances). Errors that happen during fetch or loading of settings now return an error message explaining the use of the library @napi-rs/keyring.

v1.4.0

• Added the ability to provide custom headers to send with HTTP requests from npx retool-ccl. All commands now accept a --header option, which will take the subsequent string, and send it as a header in all HTTP requests sent by the CLI. --header can be repeated many times, to include multiple headers. For example, npx retool-ccl deploy --header 'header-1: value-1' --header 'header-2: value-2' will send those two headers with each HTTP request. While running npx retool-ccl sync, use the --target-header option for headers to use when sending HTTP requests to the target instance of the sync command, and --header for headers for the origin instance.

v1.3.0

• Only one user can update a dev revision at time. This update makes npx retool-ccl dev automatically retry up to 5 times if a conflict in updating the dev revision is detected.

v1.2.0

Retool.useStateNumber({
      name: "someNumber",
      initialValue: -5.2
})

• Fixes a bug where when an error would occur when giving negative numbers for a piece of custom component state (eg: the above example use of useStateNumber would fail during build, when it should succeed. It now succeeds)

v1.1.0

• Added support for --skip-updates-check option. Normally, running any commands from the custom-component-support library will trigger a check of npmjs.com to see if newer version of custom-component-support exist. Passing this option prevents these checks from happening.
• Correctly prints an error message if a cloud user reaches their storage limit for custom component code bundles, and is unable to deploy new revisions.

v0.0.18

• When using dev mode, avoids sending source maps for any dependencies in node_modules. Dev mode continues to send source maps for all other code.

v0.0.17

• Fix npx commands, so that they return non-zero exit codes on errors.

v0.0.16

• Adds a "build" command, which will build code without deploying it to a Retool instance. Can be run via either npx retool-ccl deploy --dry-run/-n or npx retool-ccl build.