Release notes

1.13.1

  • Minor dependency updates.
  • Updates the initial repository to account for CI usage during GitHub workflows.

❗️

Manual updates necessary

To ensure that GitHub workflows will work nicely, you'll need to modify these files to add IS_CI=true to the commands:

  • .github/workflows/deploy.yml
  • .github/workflows/test.yml

Inside these files, be sure to add the IS_CI environment just before the commands. Example:

IS_CI=true npm run deploy ${{ github.event.inputs.environment }}

1.13.0

  • Automatically skips the connection selection during npm run execute when applicable to make the process a bit faster.

1.12.5

  • Dependency & security updates.

1.12.4

  • Improves Windows path support.
  • Fixes error with deeply nested template files, e.g. templates/staging/item/item.jsonata.

1.12.3

  • Minor dependency updates.
  • Automatically updates the .env file to turn on the refresh connections feature released in 1.12.0. If you haven't been prompted to automatically update your connections before, this should fix it.

1.12.2

  • Confirms whether git is installed during init, and gracefully fails if not.

1.12.1

  • Security and minor dependency updates.
  • Improved the generate-fixture command to hide invalid options depending on the context. For example, the mapping template option won't be shown on partner connectors as it's not needed.

1.12.0

  • Minor dependency updates.
  • Added a prompt to automatically refresh connections inside the configuration file when they're outdated.
    • This prompt will show up whenever executing any commands locally, outside of CI.
    • If confirmed, it'll update only the connections piece in your configuration file to ensure your connections are up to date.

❗️

Pay attention when updating your connections

This feature will add your new connections to the configuration file, but please make sure that they are properly mapped.

Whenever updating the configuration file, it's a good idea to go through your environments and connections to ensure each connection is using the correct set of templates.

1.11.0

  • Changed the init command to require Index Key and API Token instead of Connect Auth Token, to simplify the authentication process.
  • Refer to Get started with Connect CLI for more details.

1.10.0

  • Renders warnings on template executions if any invalid use case is detected.
    • Warnings can be either critical or not, and those will be rendered differently.
    • There are multiple validations that can trigger a warning. For example, returning an invalid field from the template will notify you that this field should not be there.
    • Refer to Connect CLI Development Flow: Warnings for more details.
  • Minor dependency updates.

1.9.2

  • Fixed a data structure mismatch where executing mapping templates via API would sometimes wrap the resulting data in an array, when it should not.
  • Minor dependency updates.

1.9.1

  • Improved message and error rendering in terminal.
  • Updates initial repository dependency versions, fix security alerts.
  • Updates the ESLint version and configuration to handle code styling with Stylistic.

🚧

Update required to package.json

Due to the new eslint configuration change, you'll need to update the scripts section of your package.json file:

{
  "name": "my-repo",
  "scripts": {
    // everything else
    "lint": "eslint .",
    "lint:fix": "eslint . --fix",
  }
}

Finally, to ensure compatibility, you'll likely want to update your devDependencies as well:

{
  "name": "my-repo",
  "devDependencies": {
    "@babel/preset-env": "^7.26.7",
    "@stylistic/eslint-plugin-js": "^2.13.0",
    "@types/jest": "^29.5.14",
    "eslint": "^9.19.0",
    "jest": "^29.7.0"
  }
}

1.9.0

  • Adds a new command to manually trigger connectors: npm run trigger-catalog-sync.
  • Minor dependency updates.

🚧

Update required to package.json

Since this version adds a new command, you'll need to add it to the scripts section of your package.json file after updating:

{
  "name": "my-repo",
  "scripts": {
    // everything else
    "trigger-catalog-sync": "constructorio-connect-cli trigger-catalog-sync"
  }
}

1.8.0

  • Improved the API payload when deploying templates to better collect statistical data.
  • Minor dependency updates.

1.7.1

  • Improved the initial repository generated with the init command.
    • Removed example templates, tests and fixtures as they don't match the use case.
    • Instead, add documentation links with examples on each file.
  • Documentation improvements on the initial repository.
  • Minor dependency updates.

1.6.0

  • Improved the init command to optionally initialized templates.
  • The mapping template will only be generated if there are any connections that require it (e.g. Omni Connector).

1.5.3

  • Improved Windows support across all CLI commands.
  • Added a new test suite for Windows to ensure commands aren't broken.
  • Minor dependency updates.

1.5.2

  • Semantic fixes & improvements on the initial repository.

1.5.1

  • Fixes a security alert on cross-spawn.
  • Dependency updates.

1.5.0

  • Improves support for deeply nested templates under the /src/templates folder.
  • Fixes broken links in documentation.

1.4.5

  • Fixes the boilerplate GitHub Actions workflow breaking due to not providing the CONNECT_AUTH_TOKEN secret.
  • Dependency updates.

1.4.4

  • Fixes npm install warnings shown during init.

1.4.3

  • Security & dependency updates.

1.4.2

  • Security & dependency updates.

1.4.1

  • Documentation improvements.

1.4.0

  • Adds a full test suite powered by Jest, with the possibility of writing tests for your templates.
  • Adds the npm run test command.
  • Adds support for running tests in CI, with a prebuilt GitHub Actions workflow.

1.3.1

  • Fixes the init command failing on Windows.

1.3.0

  • Adds a new command to generate fixtures: npm run generate-fixture.
    • After running it, it'll create a new fixture file depending on your connection and chosen fixture type.

1.2.0

  • Introduces support for templates in deeply nested folders inside /src/templates.

1.1.2

  • Fixes a manifest warning message after running init.
  • Always guarantees that the latest version of the CLI is installed during init.

1.1.0

  • Improvements on build & publish process.

1.0.4

  • Remove dotenv as a dependency on the initialized repositories.

1.0.3

  • Documentation improvements.

1.0.2

  • Documentation improvements.

1.0.1

  • Documentation improvements.

1.0.0

  • Initial release.