@constructor-io/constructorio-connect-cli 1.15.7 → 1.16.0

package/README.md

@@ -3,18 +3,25 @@
 [![npm](https://img.shields.io/npm/v/@constructor-io/constructorio-connect-cli)](https://www.npmjs.com/package/@constructor-io/constructorio-connect-cli)
 [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Constructor-io/constructorio-connect-cli/blob/master/LICENSE)
 
-Constructor.io is an e-commerce first product discovery service that optimizes results using artificial intelligence (including natural language processing, re-ranking to optimize for business metrics, and end user personalization).
+Constructor.io is an e-commerce first product discovery service that optimizes results using artificial intelligence
+(including natural language processing, re-ranking to optimize for business metrics, and end user personalization).
 
-This package is a CLI tool that helps you **build, test and deploy your connector templates**. By using templates, you can customize your catalog integration to shape your data the way you want it.
+This package is a CLI tool that helps you **build, test and deploy your connector templates**.
+By using templates, you can customize your catalog integration to shape your data the way you want it.
 
-> If you're looking for a package to consume our API, please use [@constructor-io/constructorio-node](https://github.com/Constructor-io/constructorio-node) instead. Alternatively, if you want a JavaScript client for client side (i.e. front end) integrations please use [@constructor-io/constructorio-client-javascript](https://github.com/Constructor-io/constructorio-client-javascript).
+> If you're looking for a package to consume our API, please use
+> [@constructor-io/constructorio-node](https://github.com/Constructor-io/constructorio-node) instead.
+> Alternatively, if you want a JavaScript client for client side (i.e. front end) integrations please use [@constructor-io/constructorio-client-javascript](https://github.com/Constructor-io/constructorio-client-javascript).
 
 ## 1. Review the Requirements
 
-Before you begin, note that this package is intended for use with partner connections. If you don't have a connector
-running yet, please take a look at [our documentation](https://docs.constructor.com/docs/integrating-with-constructor-platform-connectors) to see how you can get started.
+Before you begin, note that this package is intended for use with partner connections.
+If you don't have a connector running yet, please take a look at
+[our documentation](https://docs.constructor.com/docs/integrating-with-constructor-platform-connectors)
+to see how you can get started.
 
-Finally, make sure you have your **Index Key** and **API token** available. If you don't have this yet, please get in touch with our team and we'll set this up.
+Finally, make sure you have your **Index Key** and **API token** available.
+If you don't have this yet, please get in touch with our team and we'll set this up.
 
 ## 2. Install
 
@@ -26,7 +33,9 @@ npx @constructor-io/constructorio-connect-cli init my-repo
 
 Where `my-repo` is the name of the folder and repository you want to create.
 
-With the new repository initialized, you can start developing your catalog integration. Please refer to our [documentation](https://docs.constructor.com/docs/integrating-with-constructor-platform-connectors) for more information on how to build your templates.
+With the new repository initialized, you can start developing your catalog integration.
+Please refer to our [documentation](https://docs.constructor.com/docs/integrating-with-constructor-platform-connectors)
+for more information on how to build your templates.
 
 ## 3. Commands
 
@@ -79,7 +88,7 @@ Execute a template against a connection and fixture to see the resulting transfo
 ```
 USAGE
   $ constructorio-connect-cli execute [--template-path <value>] [--fixture-path <value>]
-    [--external-data-path <value>] [--connection-id <value>]
+    [--external-data-path <value>] [--connection-id <value>] [--override-date <value>]
 
 FLAGS
   --connection-id=<value>       The ID of the connection to execute the template against.
@@ -87,6 +96,7 @@ FLAGS
                                 'src/fixtures/external_data' directory.
   --fixture-path=<value>        The path to the fixture to execute the template against. Must be in the 'src/fixtures'
                                 directory.
+  --override-date=<value>       Date with which to override $now and $millis in the template.
   --template-path=<value>       The path to the template to execute. Must be in the 'src/templates' directory.
 
 DESCRIPTION

package/boilerplate-repo/README.md

@@ -1,6 +1,8 @@
 # Constructor.io Connect CLI Repository
 
-This repository was created using the [constructorio-connect-cli CLI](https://www.npmjs.com/package/@constructor-io/constructorio-connect-cli). It is intended to be used as a workspace for developing custom templates for the Constructor Connect platform.
+This repository was created using the
+[constructorio-connect-cli CLI](https://www.npmjs.com/package/@constructor-io/constructorio-connect-cli).
+It is intended to be used as a workspace for developing custom templates for the Constructor Connect platform.
 
 ## Table of Contents
 
@@ -40,33 +42,46 @@ This repository was created using the [constructorio-connect-cli CLI](https://ww
       - [Result](#result)
     - [5️⃣ Sharing code across templates](#5️⃣-sharing-code-across-templates)
 
-# Getting Started
+## Getting Started
 
-## Configuring Authentication with the Connect API
+### Configuring Authentication with the Connect API
 
-Before you can deploy and test templates on the Constructor Connect platform, you'll need to setup your local environment. Primarily, you will need
-to create a .env file with the contents of .env.example and fill in the `CONNECT_AUTH_TOKEN` variable with your Constructor Connect Auth token. This will be necessary to test templates against the Connect API and deploy them to the platform.
+Before you can deploy and test templates on the Constructor Connect platform, you'll need to setup your local environment.
+Primarily, you will need to create a `.env` file with the contents of `.env.example` and fill in the
+`CONNECT_AUTH_TOKEN` variable with your Constructor Connect Auth token.
+This will be necessary to test templates against the Connect API and deploy them to the platform.
 
-## Associating Templates with Connections
+### Associating Templates with Connections
 
-With that configured, visit the `connectrc.js` file. This is where you can describe the relationships between your templates and the connections you want to use them with. Any arbitrary list of connections (identified by their ID) can be connected with any of your template files. You can create as many of these relationships as you need, with the following restrictions:
+With that configured, visit the `connectrc.js` file.
+This is where you can describe the relationships between your templates and the connections you want to use them with.
+Any arbitrary list of connections (identified by their ID) can be connected with any of your template files.
+You can create as many of these relationships as you need, with the following restrictions:
 
 - A connection can only be associated with one set of templates.
-- The environment declared for each relationship must match the environment for all connections that belong to it (e.g. only development connections may be listed in a relationship configured with `environment: "development"`)
+- The environment declared for each relationship must match the environment for all connections that belong to it
+  (e.g. only development connections may be listed in a relationship configured with `environment: "development"`)
 
-An example with a single placeholder connection ID is provided in the `connectrc.js` by default. Replacing the example with your connection ID(s) and adjusting the example template source code according to your needs is the quickest way to get a set of working templates.
+An example with a single placeholder connection ID is provided in the `connectrc.js` by default.
+Replacing the example with your connection ID(s) and adjusting the example template source code according to your needs
+is the quickest way to get a set of working templates.
 
-# Generate Fixture
+## Generate Fixture
 
-Once you have written some templates and you would like to quickly test their output, you can use the `generate-fixture` command. This command will create a new fixture file based in your connection and the type.
+Once you have written some templates and you would like to quickly test their output,
+you can use the `generate-fixture` command.
+This command will create a new fixture file based in your connection and the type.
 
-This file serves as an example of how the data would be passed to the connector when executing the templates. You're expected to customize this file to match the data you expect to cover in a template execution. If the file already exists, you'll be prompted to overwrite it.
+This file serves as an example of how the data would be passed to the connector when executing the templates.
+You're expected to customize this file to match the data you expect to cover in a template execution.
+If the file already exists, you'll be prompted to overwrite it.
 
-In summary, this command is a crucial part of testing your templates on the Constructor Connect platform. It allows you to generate test data, customize it to your needs, and see how your templates will handle it.
+In summary, this command is a crucial part of testing your templates on the Constructor Connect platform.
+It allows you to generate test data, customize it to your needs, and see how your templates will handle it.
 
-## `npm run generate-fixture`
+### `npm run generate-fixture`
 
-```
+```console
 USAGE
   $ constructorio-connect-cli generate-fixture
 
@@ -84,9 +99,9 @@ EXAMPLES
   $ constructorio-connect-cli generate-fixture
 ```
 
-## `npm run trigger-catalog-sync`
+### `npm run trigger-catalog-sync`
 
-```
+```console
 USAGE
   $ constructorio-connect-cli trigger-catalog-sync
 
@@ -101,17 +116,23 @@ EXAMPLES
   $ constructorio-connect-cli trigger-catalog-sync
 ```
 
-# Executing Templates
+## Executing Templates
 
-Once you have written some templates and you would like to quickly test their output, you can use the `execute` command. This command will allow you to see the result of executing your template against a specific fixture of JSON catalog data.
+Once you have written some templates and you would like to quickly test their output, you can use the `execute` command.
+This command will allow you to see the result of executing your template against a specific fixture of JSON catalog data.
 
-Based on the template you provide, the connections existing on your account, and the configuration in your `connectrc.js` file, you will be prompted with choices of fixture files and connections to execute against. Alternatively, you can provide all of these upfront as flags to the command (see below). This is especially useful if you want to repeat execution on the same set of templates and fixtures as you iterate without having to step through the prompts each time.
+Based on the template you provide, the connections existing on your account, and the configuration in your
+`connectrc.js` file, you will be prompted with choices of fixture files and connections to execute against.
+Alternatively, you can provide all of these upfront as flags to the command (see below).
+This is especially useful if you want to repeat execution on the same set of templates
+and fixtures as you iterate without having to step through the prompts each time.
 
-**💡 Tip:** this repo also provides a built in VSCode integration. If you have any template file open, just hit `F5` or launch it from the debugger menu to execute the template and see the results immediately.
+**💡 Tip:** this repo also provides a built in VSCode integration. If you have any template file open, just hit `F5`
+or launch it from the debugger menu to execute the template and see the results immediately.
 
-## `npm run execute [FLAGS]`
+### `npm run execute [FLAGS]`
 
-```
+```console
 USAGE
   $ npm run execute -- [--template-path <value>] [--fixture-path <value>] [--external-data-path <value>] [--connection-id <value>]
 
@@ -134,19 +155,24 @@ EXAMPLES
   $ npm run execute -- --template-path=grouping/grouping.jsonata --connection-id=example-connection-id
 ```
 
-# Testing templates
+## Testing templates
 
-This project also includes a test suite that leverages Jest to run tests. To test your templates, you can use the `npm run test` command.
+This project also includes a test suite that leverages Jest to run tests.
+To test your templates, you can use the `npm run test` command.
 
-By running `npm run test`, Jest will search for all files with the `.test.js` or `.spec.js` extension in the project and execute the corresponding tests.
+By running `npm run test`, Jest will search for all files with the `.test.js` or `.spec.js` extension
+in the project and execute the corresponding tests.
 
-As a best practice, you should have at least one snapshot test to ensure the result of your template. You cna also add any logical tests to cover any rules you add to your templates, such as "calculating the average price of your variations". If you need to, you can update your snapshots with the `--updateSnapshot` flag.
+As a best practice, you should have at least one snapshot test to ensure the result of your template.
+You cna also add any logical tests to cover any rules you add to your templates,
+such as "calculating the average price of your variations".
+If you need to, you can update your snapshots with the `--updateSnapshot` flag.
 
 Finally, note that console logs are disabled during tests. To see all logs, you can use the `--verbose` flag.
 
-## `npm run test [FLAGS]`
+### `npm run test [FLAGS]`
 
-```
+```console
 USAGE
   $ npm run test -- [FLAGS]
 
@@ -166,21 +192,23 @@ EXAMPLES
   $ npm run test -- --updateSnapshot
 ```
 
-# Deploying Templates
+## Deploying Templates
 
-Once you have developed and tested your templates, you can deploy them to the Constructor Connect platform. To do this, you can use the `deploy` command.
+Once you have developed and tested your templates, you can deploy them to the Constructor Connect platform.
+To do this, you can use the `deploy` command.
 
-## Deploying via GitHub Actions
+### Deploying via GitHub Actions
 
-This repository is pre-configured to deploy templates to Constructor Connect using GitHub Actions. To do this, you will need to set up the following secrets in your GitHub repository:
+This repository is pre-configured to deploy templates to Constructor Connect using GitHub Actions.
+To do this, you will need to set up the following secrets in your GitHub repository:
 
 - `CONNECT_AUTH_TOKEN`: Your Constructor Connect Auth token. It's the same used to initialize this repo.
 
 After setting up the secrets, you can run the `Deploy` workflow from the Actions tab in your repository.
 
-## `npm run deploy ENV`
+### `npm run deploy ENV`
 
-```
+```console
 USAGE
   $ npm run deploy ENV
 
@@ -201,25 +229,30 @@ EXAMPLES
   $ npm run deploy production
 ```
 
-# Developing Templates
+## Developing Templates
 
-## ➡️ Expected Transformer Implementation
+### ➡️ Expected Transformer Implementation
 
 To implement your very own transformers, you just need to edit the `.jsonata` files inside the `templates` folder.
 
-Keep in mind that the template will have access to `external` and `data`. You can use the `data` to access the data that is being ingested, and `external` to access the data available in the connector.
+Keep in mind that the template will have access to `external` and `data`.
+You can use the `data` to access the data that is being ingested, and `external` to access the data available in the connector.
 
-Note that all template files must return the expected data types. To know which properties you can override inside `item`, `variation` or `item_group`, take a look into the type definitions:
+Note that all template files must return the expected data types.
+To know which properties you can override inside `item`, `variation` or `item_group`, take a look into the type definitions:
 
 - [Item](https://docs.constructor.com/docs/integrating-with-constructor-product-catalog-csv-csv-feed-format-items-products)
 - [Variation](https://docs.constructor.com/docs/integrating-with-constructor-product-catalog-csv-csv-feed-format-variations)
 - [Item Group](https://docs.constructor.com/docs/integrating-with-constructor-product-catalog-csv-csv-feed-format-item-groups-categories)
 
-You can also refer to the [Constructor API docs](https://docs.constructor.com/reference/v1-catalog-create-or-replace-catalog) for more details.
+You can also refer to the [Constructor API docs](https://docs.constructor.com/reference/v1-catalog-create-or-replace-catalog)
+for more details.
 
-## 🗑️ Removing Entities
+### 🗑️ Removing Entities
 
-You can also remove any item, variation, or item group through our templates. Suppose each product on your catalog has a `visible` boolean field. It could make sense to not even ingest them into [Constructor.io](https://constructor.io/).
+You can also remove any item, variation, or item group through our templates.
+Suppose each product on your catalog has a `visible` boolean field.
+It could make sense to not even ingest them into [Constructor.io](https://constructor.io/).
 
 We can make this happen returning `{ "remove": true }` whenever we find an item we want to drop from the ingestion:
 
@@ -233,26 +266,39 @@ We can make this happen returning `{ "remove": true }` whenever we find an item
 )
 ```
 
-## 🍙 Grouping logic
+### 🍙 Grouping logic
 
-You can use the `grouping.jsonata` template to group variations into the item level. This can be helpful, for example, if you want to ingest data while grouping your items with a specific criteria (e.g. color).
+You can use the `grouping.jsonata` template to group variations into the item level.
+This can be helpful, for example, if you want to ingest data while grouping your items with a specific criteria (e.g. color).
 
 To do this, you need to define a grouping template with the `grouping` key.
 
 Refer to the examples below for more information.
 
-## 🗺️ Mapping logic
+### 🗺️ Mapping logic
 
 You can use the `mapping.jsonata` template to map your data before transforming it. This has a few use cases:
 
-- **Ingesting data of any shape**: Say you're simply ingesting data from a JSON file. Since you don't have the base transformation layer that a partner connector would usually provide, you need to map your data first.
-- **Customizing the connector mappings**: Say you're using a partner connector and you want to customize how the data is mapped. For example, you want to ingest content, or you want to grab the categories that would normally be ingested as `item_groups` and ingest those into a custom index section.
-- **Filtering out data**: While you can filter out data during the transformations, it might be computationally expensive. You can simply drop any data during the mapping phase.
-- **Creating data**: Say you want to have a default variation in every item, or a new item group as parent of all others. You can create data out of thin air during the mapping phase.
-- **Grouping data**: When dealing with variation ingestions we may want to ingest partial data, maybe some pricing or inventory delta updates. Sometimes this data is not in the variation level yet, we can solve this by using the `__group_by` custom fields to group all records into a specific variation identifier. That way when transforming the data you'll have access to an array of all data points that should be ingested as variations.
+- **Ingesting data of any shape**: Say you're simply ingesting data from a JSON file.
+ Since you don't have the base transformation layer that a partner connector would usually provide,
+you need to map your data first.
+- **Customizing the connector mappings**:
+ Say you're using a partner connector and you want to customize how the data is mapped.
+ For example, you want to ingest content, or you want to grab the categories that would normally be ingested
+ as `item_groups` and ingest those into a custom index section.
+- **Filtering out data**: While you can filter out data during the transformations, it might be computationally expensive.
+ You can simply drop any data during the mapping phase.
+- **Creating data**: Say you want to have a default variation in every item, or a new item group as parent of all others.
+ You can create data out of thin air during the mapping phase.
+- **Grouping data**: When dealing with variation ingestions we may want to ingest partial data,
+ maybe some pricing or inventory delta updates.
+ Sometimes this data is not in the variation level yet,
+ we can solve this by using the `__group_by` custom fields to group all records into a specific variation identifier.
+ That way when transforming the data you'll have access to an array of all data points that should be ingested as variations.
 - ⚠️ This is currently only supported when performing variation-only ingestions.
 
-Essentially, mapping templates empower you to fully customize how the connector works. It's up to you to map and transform the data.
+Essentially, mapping templates empower you to fully customize how the connector works.
+It's up to you to map and transform the data.
 
 The mapping template can return three arrays:
 
@@ -260,27 +306,34 @@ The mapping template can return three arrays:
 - `variations`: Variations to be ingested.
 - `item_groups`: Item groups to be ingested.
 
-All objects inside these arrays can have **any data structure**. In the transformation templates, you'll receive the same structure you defined here.
+All objects inside these arrays can have **any data structure**. In the transformation templates,
+you'll receive the same structure you defined here.
 
 It's important to note that there are a few requirements and optional fields for each of these, as described below.
 
-### Mapping items
+#### Mapping items
 
-When you map items, you can append a field named `__variations` in case you can easily map the variations from the input data. This will automatically group the variations into the item level, and will heavily speed up the ingestion performance.
+When you map items,
+you can append a field named `__variations` in case you can easily map the variations from the input data.
+This will automatically group the variations into the item level, and will heavily speed up the ingestion performance.
 
-### Mapping variations
+#### Mapping variations
 
-When you map variations, you can optionally provide a `__parent_id` field to each variation. If you do that and the item is also present in the ingestion, you'll be able to access the variations under the `__variations` field during the item template transformations.
+When you map variations, you can optionally provide a `__parent_id` field to each variation.
+If you do that and the item is also present in the ingestion,
+you'll be able to access the variations under the `__variations` field during the item template transformations.
 
-When no item is present you may also add a `__group_by` field to group all related data into a single variation. This is useful when you're ingesting partial data, like pricing or inventory updates.
+When no item is present you may also add a `__group_by` field to group all related data into a single variation.
+This is useful when you're ingesting partial data, like pricing or inventory updates.
 
-### Mapping item groups
+#### Mapping item groups
 
-Mapping item groups is simpler. Since they can be ingested separately, you can define any shape you want and transform them later.
+Mapping item groups is simpler. Since they can be ingested separately,
+you can define any shape you want and transform them later.
 
-## 💡 Valid transformer examples
+### 💡 Valid transformer examples
 
-### Item transformer
+#### Item transformer
 
 In the `templates/item.jsonata` file, you can customize how items are transformed:
 
@@ -306,7 +359,7 @@ In the `templates/item.jsonata` file, you can customize how items are transforme
 )
 ```
 
-### Variation transformer
+#### Variation transformer
 
 In the `templates/variation.jsonata` file, you can customize how variations are transformed:
 
@@ -328,7 +381,7 @@ In the `templates/variation.jsonata` file, you can customize how variations are
 }
 ```
 
-### Item Group transformer
+#### Item Group transformer
 
 In the `templates/item_group.jsonata` file, you can customize how item groups are transformed:
 
@@ -338,13 +391,17 @@ In the `templates/item_group.jsonata` file, you can customize how item groups ar
 }
 ```
 
-### Grouping transformer
+#### Grouping transformer
 
-The `grouping` template is expected to override the same keys as the item transformer, and ideally it should override the `id` property.
+The `grouping` template is expected to override the same keys as the item transformer,
+and ideally it should override the `id` property.
 
-In this example, we're assuming that the connector data has properties such as `color`, `id`, and `parent` (in case of variations). With the code below, if a product has the ID `foo` with the color `blue`, the new ID would become `foo-blue`.
+In this example, we're assuming that the connector data has properties such as `color`, `id`,
+and `parent` (in case of variations).
+With the code below, if a product has the ID `foo` with the color `blue`, the new ID would become `foo-blue`.
 
-Also note that in this scenario, you'll also need to update the `item_id` property in the variant level to make sure it'll match the overridden item ids.
+Also note that in this scenario, you'll also need to update the `item_id` property in the variant level
+to make sure it'll match the overridden item ids.
 
 In the `templates/grouping.jsonata` file, you can customize how item groups are transformed:
 
@@ -383,19 +440,27 @@ Finally, we likely want to remove excess items so that only new, grouped items a
 }
 ```
 
-## ⚙️ Template Language
+### ⚙️ Template Language
 
 To power the catalog customizations, we use a template language that allows for mapping data.
 
-To do this, we use [JSONata](https://jsonata.org/) templates to support customizing your catalog data. JSONata provides a powerful template language with many built-in functions, but we also provide additional helper functions to deal with the external data for each connector.
+To do this, we use [JSONata](https://jsonata.org/) templates to support customizing your catalog data.
+JSONata provides a powerful template language with many built-in functions,
+but we also provide additional helper functions to deal with the external data for each connector.
 
-> JSONata is a lightweight query and transformation language for JSON data. Inspired by the 'location path' semantics of XPath 3.1, it allows sophisticated queries to be expressed in a compact and intuitive notation. A rich complement of built in operators and functions is provided for manipulating and combining extracted data, and the results of queries can be formatted into any JSON output structure using familiar JSON object and array syntax. Coupled with the facility to create user defined functions, advanced expressions can be built to tackle any JSON query and transformation task.
+> JSONata is a lightweight query and transformation language for JSON data.
+Inspired by the 'location path' semantics of XPath 3.1,
+it allows sophisticated queries to be expressed in a compact and intuitive notation.
+A rich complement of built in operators and functions is provided for manipulating and combining extracted data,
+and the results of queries can be formatted into any JSON output structure using familiar JSON object and array syntax.
+Coupled with the facility to create user defined functions,
+advanced expressions can be built to tackle any JSON query and transformation task.
 
 For more details, check out the [documentation 🔍](https://docs.jsonata.org/overview.html)
 
 Here are some good examples of basic to complex scenarios:
 
-### 1️⃣ Adding a single facet
+#### 1️⃣ Adding a single facet
 
 We want to map the variant sku to a specific metadata
 
@@ -458,7 +523,7 @@ We want to map the variant sku to a specific metadata
 </tr>
 </table>
 
-### 2️⃣ Using built in helper functions
+#### 2️⃣ Using built in helper functions
 
 JSONata already provides a powerful set of helper functions that can be used in the templates.
 
@@ -470,11 +535,14 @@ using just one field called `prices`.
 [👉 Try it for yourself!](https://try.jsonata.org/b-ddoNC3p)
 
 <table>
+<thead>
 <tr>
-  <td>Connector data</td>
-  <td>Template</td>
-  <td>Result</td>
+  <th>Connector data</th>
+  <th>Template</th>
+  <th>Result</th>
 </tr>
+</thead>
+<tbody>
 <tr>
 <td>
 
@@ -545,9 +613,10 @@ using just one field called `prices`.
 
 </td>
 </tr>
+</tbody>
 </table>
 
-### 3️⃣ Using helper functions provided by connectors
+#### 3️⃣ Using helper functions provided by connectors
 
 To make things even easier, our connectors provide helper functions that allow you to easily access
 and parse the external data that comes from the partner.
@@ -560,7 +629,7 @@ translation, with a fallback to English if not found.
 
 [👉 Try it for yourself!](https://try.jsonata.org/yfsTJnbkF)
 
-#### Helper Function
+##### Helper Function
 
 As described before, each connector provides helper functions to make it easier to map your data.
 
@@ -578,11 +647,14 @@ function getProductDescriptionWithFallback(locale) {
 ```
 
 <table>
+<thead>
 <tr>
-  <td>Connector data</td>
-  <td>Template</td>
-  <td>Result</td>
+  <th>Connector data</th>
+  <th>Template</th>
+  <th>Result</th>
 </tr>
+</thead>
+<tbody>
 <tr>
 <td>
 
@@ -653,9 +725,10 @@ function getProductDescriptionWithFallback(locale) {
 
 </td>
 </tr>
+</tbody>
 </table>
 
-### 4️⃣ Defining new functions and/or variables inside templates
+#### 4️⃣ Defining new functions and/or variables inside templates
 
 Sometimes you want to do something really complex and the connector might not have a helper
 function ready for this.
@@ -672,7 +745,7 @@ that will then be called to override the product id (resulting in `foobar`).
 
 [👉 Try it for yourself!](https://try.jsonata.org/fYov5XxnY)
 
-#### Connector data
+##### Connector data
 
 ```ts
 {
@@ -682,7 +755,7 @@ that will then be called to override the product id (resulting in `foobar`).
 }
 ```
 
-#### Template
+##### Template
 
 ```js
 (
@@ -700,7 +773,7 @@ that will then be called to override the product id (resulting in `foobar`).
 )
 ```
 
-#### Result
+##### Result
 
 ```ts
 {
@@ -710,9 +783,11 @@ that will then be called to override the product id (resulting in `foobar`).
 }
 ```
 
-### 5️⃣ Sharing code across templates
+#### 5️⃣ Sharing code across templates
 
-Sometimes is handy to move some duplicated code into a separate file and import it whenever needed. You can do this through our `helpers.jsonata` file. And then, reuse it anywhere by simply importing it using the `{{helpers}}` syntax.
+Sometimes is handy to move some duplicated code into a separate file and import it whenever needed.
+You can do this through our `helpers.jsonata` file.
+And then, reuse it anywhere by simply importing it using the `{{helpers}}` syntax.
 
 Note: This feature is implemented under our custom build process, so the JSONata exerciser will not parse this syntax correctly.
 

package/boilerplate-repo/gitignore

@@ -0,0 +1,35 @@
+# compiled output
+/dist
+/node_modules
+# Logs
+logs
+*.log
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+# OS
+.DS_Store
+# Tests
+/coverage
+/.nyc_output
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+# IDE - VSCode
+.vscode/*
+*.code-workspace
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+# dotenv
+.env
+# npmrc should be ignored to avoid leaking credentials (e.g. AWS CodeArtifact)
+.npmrc

package/dist/commands/execute.d.ts

@@ -14,6 +14,7 @@ interface ExecuteInputFlags {
     "connection-id"?: string;
     "fixture-path"?: string;
     "external-data-path"?: string;
+    "override-date"?: Date;
 }
 export declare class Execute extends RefreshConnectionsCommand {
     static flags: {
@@ -21,6 +22,7 @@ export declare class Execute extends RefreshConnectionsCommand {
         "fixture-path": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         "external-data-path": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         "connection-id": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        "override-date": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
     static description: string;
     static examples: string[];

package/dist/commands/execute.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"execute.d.ts","sourceRoot":"","sources":["../../src/commands/execute.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAElE,eAAO,MAAM,qBAAqB;;;;;CAKxB,CAAC;AAEX;;;GAGG;AACH,UAAU,iBAAiB;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAYD,qBAAa,OAAQ,SAAQ,yBAAyB;IACpD,MAAM,CAAC,KAAK;;;;;MAgBV;IAEF,MAAM,CAAC,WAAW,SACkK;IAEpL,MAAM,CAAC,QAAQ,WAOb;IAEF,KAAK,EAAE,iBAAiB,CAAM;IAExB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;YAkCnB,UAAU;YAsBV,oBAAoB;YAoDpB,wBAAwB;YA2BxB,wBAAwB;CAevC"}
+{"version":3,"file":"execute.d.ts","sourceRoot":"","sources":["../../src/commands/execute.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAElE,eAAO,MAAM,qBAAqB;;;;;CAKxB,CAAC;AAEX;;;GAGG;AACH,UAAU,iBAAiB;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,eAAe,CAAC,EAAE,IAAI,CAAC;CACxB;AAaD,qBAAa,OAAQ,SAAQ,yBAAyB;IACpD,MAAM,CAAC,KAAK;;;;;;MAoBV;IAEF,MAAM,CAAC,WAAW,SACkK;IAEpL,MAAM,CAAC,QAAQ,WAOb;IAEF,KAAK,EAAE,iBAAiB,CAAM;IAExB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;YAmCnB,UAAU;YA0BV,oBAAoB;YAqDpB,wBAAwB;YA2BxB,wBAAwB;CAevC"}

package/dist/commands/execute.js

@@ -40,6 +40,9 @@ class Execute extends refresh_connections_1.RefreshConnectionsCommand {
         "connection-id": core_1.Flags.string({
             description: "The ID of the connection to execute the template against.",
         }),
+        "override-date": core_1.Flags.string({
+            description: "Date with which to override $now and $millis in the template.",
+        }),
     };
     static description = "Execute a template against a connection and fixture to see the resulting transformed data. Each value not provided as a flag will be prompted for when the command is executed.";
     static examples = [
@@ -66,6 +69,7 @@ class Execute extends refresh_connections_1.RefreshConnectionsCommand {
                     : {},
                 connectionId: templateInput.connectionId,
                 templateType: (0, extract_template_type_1.extractTemplateType)(templateInput.templatePath),
+                overrideDate: templateInput.overrideDate,
             });
             (0, render_template_result_1.renderTemplateResult)(result);
             if (result.warnings.length > 0) {
@@ -95,6 +99,9 @@ class Execute extends refresh_connections_1.RefreshConnectionsCommand {
         if (flags["connection-id"]) {
             this.input["connection-id"] = flags["connection-id"];
         }
+        if (flags["override-date"]) {
+            this.input["override-date"] = new Date(flags["override-date"]);
+        }
     }
     async getTemplateExecInput() {
         const allConnections = await (0, get_connections_request_1.getConnections)({
@@ -134,6 +141,7 @@ class Execute extends refresh_connections_1.RefreshConnectionsCommand {
             fixturePath: this.input["fixture-path"],
             externalPath: this.input["external-data-path"] ?? "",
             connectionId,
+            overrideDate: this.input["override-date"],
         };
     }
     async validateAndGetConnection(allConnections, templatePath) {

package/dist/commands/init.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAMA,OAAO,EAAQ,OAAO,EAAE,MAAM,aAAa,CAAC;AA0B5C,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,OAAO;IACvC,MAAM,CAAC,WAAW,SAA4D;IAE9E,MAAM,CAAC,QAAQ,WAGb;IAEF,MAAM,CAAC,IAAI;;MAKT;IAEW,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;YAyCnB,UAAU;IAmBxB,OAAO,CAAC,oBAAoB;YAUd,UAAU;YAsBV,uBAAuB;WA6BvB,mBAAmB,CAC/B,MAAM,EAAE,MAAM,EACd,4BAA4B,EAAE,OAAO,GACpC,IAAI;IAcP,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAWjC,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAuBlC,OAAO,CAAC,0BAA0B;CA4BnC"}
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAMA,OAAO,EAAQ,OAAO,EAAE,MAAM,aAAa,CAAC;AA0B5C,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,OAAO;IACvC,MAAM,CAAC,WAAW,SAA4D;IAE9E,MAAM,CAAC,QAAQ,WAGb;IAEF,MAAM,CAAC,IAAI;;MAKT;IAEW,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;YAyCnB,UAAU;IAmBxB,OAAO,CAAC,oBAAoB;YAUd,UAAU;YAsBV,uBAAuB;WA6BvB,mBAAmB,CAC/B,MAAM,EAAE,MAAM,EACd,4BAA4B,EAAE,OAAO,GACpC,IAAI;IAsBP,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAWjC,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAuBlC,OAAO,CAAC,0BAA0B;CA4BnC"}

package/dist/commands/init.js

@@ -155,6 +155,12 @@ class Init extends core_1.Command {
                 return !file.includes("mapping");
             },
         });
+        // Handle .gitignore file - npm renames it during publish, so we copy from 'gitignore' to '.gitignore'
+        const gitignoreSource = path.join(repoDir, "gitignore");
+        const gitignoreDest = path.join(newDir, ".gitignore");
+        if (fs_extra_1.default.existsSync(gitignoreSource)) {
+            fs_extra_1.default.copyFileSync(gitignoreSource, gitignoreDest);
+        }
     }
     static replacePackageName(name, repoPath) {
         const packageJsonPath = path.join(repoPath, "package.json");

package/dist/functions/execute-template.d.ts

@@ -5,6 +5,7 @@ export interface ExecuteTemplateArgs {
     fixture?: Record<string, unknown>;
     external?: Record<string, unknown>;
     connectionId?: string;
+    overrideDate?: Date;
 }
 /**
  * This will execute a template with the given type, name, fixture, and external.

package/dist/functions/execute-template.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"execute-template.d.ts","sourceRoot":"","sources":["../../src/functions/execute-template.ts"],"names":[],"mappings":"AAWA,eAAO,MAAM,YAAY,qEAMf,CAAC;AAEX,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,eAAe,CAAC,OAAO,EAAE,mBAAmB,gCAuBjE"}
+{"version":3,"file":"execute-template.d.ts","sourceRoot":"","sources":["../../src/functions/execute-template.ts"],"names":[],"mappings":"AAWA,eAAO,MAAM,YAAY,qEAMf,CAAC;AAEX,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,IAAI,CAAC;CACrB;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,eAAe,CAAC,OAAO,EAAE,mBAAmB,gCAwBjE"}

package/dist/functions/execute-template.js

@@ -33,7 +33,7 @@ exports.TYPE_OPTIONS = [
  * @returns Promise<Record<string, any>>
  */
 async function executeTemplate(options) {
-    const { name, fixture, external } = initializeOptions(options);
+    const { name, fixture, external, overrideDate } = initializeOptions(options);
     const connection = await getConnection(options);
     const config = await (0, config_1.getRepositoryConfigFile)();
     const result = await (0, send_template_execute_request_1.sendTemplateExecuteRequest)({
@@ -44,6 +44,7 @@ async function executeTemplate(options) {
         data: fixture,
         showLogs: false,
         external,
+        overrideDate,
     });
     if (!result.success) {
         throw new Error(`Error executing template: ${result.error.message}`);

package/dist/http/send-template-execute-request.d.ts

@@ -1,5 +1,5 @@
 import { type TemplateExecutionSuccessResponse, type TemplateExecutionErrorResponse } from "../types";
-export declare function sendTemplateExecuteRequest({ template, helpers, data, external, connectionId, templateType, showLogs, }: Args): Promise<TemplateExecutionSuccessResponse | TemplateExecutionErrorResponse>;
+export declare function sendTemplateExecuteRequest({ template, helpers, data, external, connectionId, templateType, showLogs, overrideDate, }: Args): Promise<TemplateExecutionSuccessResponse | TemplateExecutionErrorResponse>;
 interface Args {
     template: string;
     helpers: string;
@@ -8,6 +8,7 @@ interface Args {
     connectionId: string;
     templateType: string;
     showLogs?: boolean;
+    overrideDate?: Date;
 }
 export {};
 //# sourceMappingURL=send-template-execute-request.d.ts.map

package/dist/http/send-template-execute-request.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"send-template-execute-request.d.ts","sourceRoot":"","sources":["../../src/http/send-template-execute-request.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,KAAK,gCAAgC,EACrC,KAAK,8BAA8B,EACpC,MAAM,UAAU,CAAC;AAIlB,wBAAsB,0BAA0B,CAAC,EAC/C,QAAQ,EACR,OAAO,EACP,IAAI,EACJ,QAAQ,EACR,YAAY,EACZ,YAAY,EACZ,QAAe,GAChB,EAAE,IAAI,GAAG,OAAO,CACf,gCAAgC,GAAG,8BAA8B,CAClE,CA8BA;AAED,UAAU,IAAI;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,GAAG,CAAC;IACV,QAAQ,EAAE,GAAG,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB"}
+{"version":3,"file":"send-template-execute-request.d.ts","sourceRoot":"","sources":["../../src/http/send-template-execute-request.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,KAAK,gCAAgC,EACrC,KAAK,8BAA8B,EACpC,MAAM,UAAU,CAAC;AAIlB,wBAAsB,0BAA0B,CAAC,EAC/C,QAAQ,EACR,OAAO,EACP,IAAI,EACJ,QAAQ,EACR,YAAY,EACZ,YAAY,EACZ,QAAe,EACf,YAAY,GACb,EAAE,IAAI,GAAG,OAAO,CACf,gCAAgC,GAAG,8BAA8B,CAClE,CA+BA;AAED,UAAU,IAAI;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,GAAG,CAAC;IACV,QAAQ,EAAE,GAAG,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,IAAI,CAAC;CACrB"}

package/dist/http/send-template-execute-request.js

@@ -5,7 +5,7 @@ const axios_1 = require("axios");
 const errors_1 = require("@oclif/core/errors");
 const ux_action_1 = require("../helpers/ux-action");
 const http_client_1 = require("./http-client");
-async function sendTemplateExecuteRequest({ template, helpers, data, external, connectionId, templateType, showLogs = true, }) {
+async function sendTemplateExecuteRequest({ template, helpers, data, external, connectionId, templateType, showLogs = true, overrideDate, }) {
     const client = await (0, http_client_1.getHttpClient)();
     const httpRequest = async () => {
         return (await client.patch("templates/standalone/execute", {
@@ -15,6 +15,7 @@ async function sendTemplateExecuteRequest({ template, helpers, data, external, c
             external,
             connection_id: connectionId,
             template_type: templateType,
+            ...(overrideDate ? { override_date: overrideDate.toISOString() } : {}),
         })).data;
     };
     try {

package/dist/version.d.ts

@@ -1,3 +1,3 @@
-declare const _default: "1.15.7";
+declare const _default: "1.16.0";
 export default _default;
 //# sourceMappingURL=version.d.ts.map

package/dist/version.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '1.15.7';
+exports.default = '1.16.0';

package/oclif.manifest.json

@@ -86,6 +86,13 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "override-date": {
+          "description": "Date with which to override $now and $millis in the template.",
+          "name": "override-date",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -200,5 +207,5 @@
       ]
     }
   },
-  "version": "1.15.7"
+  "version": "1.16.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-connect-cli",
-  "version": "1.15.7",
+  "version": "1.16.0",
   "description": "CLI tool to enable users to interface with the Constructor Connect Ecosystem",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -30,6 +30,8 @@
     "test:cov": "cross-env TZ=UTC jest --coverage",
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\"",
     "lint:fix": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "mdlint": "markdownlint-cli2 \"**/*.md\"",
+    "mdlint:fix": "markdownlint-cli2 \"**/*.md\" --fix",
     "license-check": "license-checker --production --onlyAllow 'Apache-2.0;BSD-3-Clause;BSD-2-Clause;ISC;MIT;0BSD'",
     "postpack": "shx rm -f oclif.manifest.json",
     "compile": "npm run build && npm run generate-readme && oclif manifest"
@@ -84,11 +86,13 @@
     "@types/mock-fs": "^4.13.4",
     "cross-env": "^10.0.0",
     "eslint": "^9.25.0",
+    "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-prettier": "^5.2.6",
     "eslint-plugin-promise": "^6.6.0",
     "globals": "^16.0.0",
     "jest": "^29.7.0",
     "license-checker": "^25.0.1",
+    "markdownlint-cli2": "^0.20.0",
     "mock-fs": "^5.2.0",
     "nock": "14.0.10",
     "oclif": "^4.17.42",