@constructor-io/constructorio-connect-cli 1.6.0 → 1.7.0

package/boilerplate-repo/src/templates/helpers.jsonata

@@ -1,3 +1,4 @@
-$hello := function($name) {
-  $join(["These are my ", $name, "!"])
-};
+/*
+* This is a file where you can define additional helper functions.
+* @see https://docs.constructor.com/docs/integrating-with-constructor-connect-cli-helper-functions
+*/

package/boilerplate-repo/src/templates/item/item.jsonata

@@ -1,26 +1,4 @@
-(
-  /* Import all helper functions defined in helpers.jsonata */
-  {{helpers}}
-
-  /* You can define variables and custom logic */
-  $name := targetData.name;
-
-  {
-    /* Use the `hello` helper function */
-    "item_name": $hello($name),
-
-    "metadata": [
-      {
-        "key": "colors",
-        "value": targetData.variations.attributes[name = "color"].value
-      }
-    ],
-
-    "facets": [
-      {
-        "key": "price_average",
-        "value": $average(targetData.variations.price)
-      }
-    ]
-  }
-)
+/*
+* This template allows you to customize your item data.
+* @see https://docs.constructor.com/docs/integrating-with-constructor-connect-cli-template-types-transformation-templates#item-template
+*/

package/boilerplate-repo/src/templates/item_group/item_group.jsonata

@@ -1,3 +1,4 @@
-{
-  "name": $lowercase(targetData.name)
-}
+/*
+* This template allows you to customize your item group data.
+* @see https://docs.constructor.com/docs/integrating-with-constructor-connect-cli-template-types-transformation-templates#item-group-template
+*/

package/boilerplate-repo/src/templates/mapping/mapping.jsonata

@@ -1,34 +1,4 @@
 /*
-  The mapping template allows you to map the input data to any format you want before the
-  actual transformations happen, using the transformation templates for each entity.
-
-  In this template, you can return three arrays: `items`, `variations`, and `item_groups`.
-  Each array can have any structure as defined by you, and you'll be able to use the
-  very same structure defined here in the transformation templates.
-
-  In the example defined below, we only care about mapping the items and item groups,
-  since variations are already embedded into each item.
-
-  If we wanted to ingest only variations (e.g. a partial sync), you'd return the
-  `variations` array filled with data instead.
-
-  Refer to the README for extended documentation on how to use the mapping template.
+* Check out the documentation to see how to change and customize the connector data mapping:  
+* @see https://docs.constructor.com/docs/integrating-with-constructor-connect-cli-template-types-mapping-template
 */
-
-(
-  /* Import all helper functions defined in helpers.jsonata */
-  {{helpers}}
-
-  {
-    "items": [
-      $merge([
-        targetData,
-        { "__variations": targetData.colors.{ "color": $ } }
-      ])
-    ],
-    "variations": [],
-    "item_groups": [
-      { "id": targetData.category }
-    ]
-  }
-)

package/boilerplate-repo/src/templates/variation/variation.jsonata

@@ -1,26 +1,4 @@
-(
-  /* Import all helper functions defined in helpers.jsonata */
-  {{helpers}}
-
-  /* You can define variables and custom logic */
-  $name := targetData.name;
-
-  {
-    /* Use the `hello` helper function */
-    "item_name": $hello($name),
-
-    "metadata": [
-      {
-        "key": "color",
-        "value": targetData.attributes[name = "color"].value
-      }
-    ],
-
-    "facets": [
-      {
-        "key": "price",
-        "value": targetData.price
-      }
-    ]
-  }
-)
+/*
+* This template allows you to customize your variation data.
+* @see https://docs.constructor.com/docs/integrating-with-constructor-connect-cli-template-types-transformation-templates#variation-template
+*/

package/boilerplate-repo/test/templates/item/item.spec.mjs

@@ -1,86 +1,10 @@
-import {
-  executeTemplate,
-  buildFixture,
-} from "@constructor-io/constructorio-connect-cli";
+/**
+ * Check out the documentation to see how to write and maintain tests:
+ * @see https://docs.constructor.com/docs/integrating-with-constructor-connect-cli-development-flow#step-3-test-your-templates
+*/
 
 describe("item", () => {
-  it("should match inline snapshot", async () => {
-    /**
-     * Add a function `executeTemplate` which abstracts all the complexity from
-     * running a template and gives you the result back.
-     *
-     * It will:
-     * - Load the template.
-     * - Receive the fixture + externalData (optional) as an object.
-     * - Automatically load the first `connectionId` to send to the backend.
-     * - Execute the template on the backend.
-     * - Return an object.
-     *
-     * In failure:
-     * - It will throw an error, not allowing the test to proceed.
-     */
-    const result = await executeTemplate({
-      // Define the template type: item | variation | item_group | mapping | grouping
-      type: "item",
-
-      // Define the template file name, which will be used to load the test
-      name: "item.jsonata",
-
-      /**
-       * Add a function `buildFixture` to load a fixture from a type and file name.
-       * It can also receive a second param being an object, which will deep merge into
-       * the fixture itself - similarly to how a factory pattern works. This way we can
-       * have only one fixture with many tests :)
-       */
-      fixture: buildFixture("item", "item.json", {
-        name: "other shoes!",
-        variations: [
-          {
-            name: "other shoes (red)",
-            price: 130,
-          },
-          {
-            name: "other shoes (blue)",
-            price: 200,
-          },
-        ],
-      }),
-    });
-
-    // Alternatively, you can also store the snapshot in a file to reduce clutter.
-    // expect(result).toMatchSnapshot();
-
-    expect(result).toMatchInlineSnapshot(`
-{
-  "facets": [
-    {
-      "key": "price_average",
-      "value": 165,
-    },
-  ],
-  "item_name": "These are my other shoes!!",
-  "metadata": [
-    {
-      "key": "colors",
-    },
-  ],
-}
-`);
-  });
-
-  it("should compute the average price", async () => {
-    const response = await executeTemplate({
-      type: "item",
-      name: "item.jsonata",
-      fixture: buildFixture("item", "item.json", {
-        variations: [{ price: 100 }, { price: 200 }],
-      }),
-    });
-
-    const priceFacet = response.facets.find(
-      (facet) => facet.key === "price_average",
-    );
-
-    expect(priceFacet.value).toBe(150);
+  it("should be defined", async () => {
+    expect(true).toBe(true);
   });
 });

package/boilerplate-repo/test/templates/item_group/item_group.spec.mjs

@@ -1,23 +1,10 @@
-import {
-  executeTemplate,
-  buildFixture,
-} from "@constructor-io/constructorio-connect-cli";
+/**
+ * Check out the documentation to see how to write and maintain tests:
+ * @see https://docs.constructor.com/docs/integrating-with-constructor-connect-cli-development-flow#step-3-test-your-templates
+*/
 
 describe("item_group", () => {
-  it("should match inline snapshot", async () => {
-    const result = await executeTemplate({
-      type: "item_group",
-      name: "item_group.jsonata",
-      fixture: buildFixture("item_group", "item_group.json", { other: "data" }),
-    });
-
-    // Alternatively, you can also store the snapshot in a file to reduce clutter.
-    // expect(result).toMatchSnapshot();
-
-    expect(result).toMatchInlineSnapshot(`
-{
-  "name": "root",
-}
-`);
+  it("should be defined", async () => {
+    expect(true).toBe(true);
   });
 });

package/boilerplate-repo/test/templates/mapping/mapping.spec.mjs

@@ -1,78 +1,10 @@
-import {
-  executeTemplate,
-  buildFixture,
-} from "@constructor-io/constructorio-connect-cli";
+/**
+ * Check out the documentation to see how to write and maintain tests:
+ * @see https://docs.constructor.com/docs/integrating-with-constructor-connect-cli-development-flow#step-3-test-your-templates
+*/
 
 describe("mapping", () => {
-  it("should match inline snapshot", async () => {
-    const result = await executeTemplate({
-      type: "mapping",
-      name: "mapping.jsonata",
-      fixture: buildFixture("mapping", "mapping.json", {
-        title: "New Title",
-      }),
-    });
-
-    // Alternatively, you can also store the snapshot in a file to reduce clutter.
-    // expect(result).toMatchSnapshot();
-
-    expect(result).toMatchInlineSnapshot(`
-{
-  "item_groups": [
-    {
-      "id": "smartphones",
-    },
-  ],
-  "items": [
-    {
-      "__variations": [
-        {
-          "color": "midnight-black",
-        },
-        {
-          "color": "fancy-silver",
-        },
-        {
-          "color": "rich-gold",
-        },
-        {
-          "color": "sky-blue",
-        },
-        {
-          "color": "crimson-red",
-        },
-        {
-          "color": "green-forest",
-        },
-      ],
-      "brand": "Apple",
-      "category": "smartphones",
-      "colors": [
-        "midnight-black",
-        "fancy-silver",
-        "rich-gold",
-        "sky-blue",
-        "crimson-red",
-        "green-forest",
-      ],
-      "description": "SIM-Free, Model A19211 6.5-inch Super Retina HD display with OLED technology A12 Bionic chip with ...",
-      "discountPercentage": 17.94,
-      "id": "iphone-x",
-      "images": [
-        "https://cdn.dummyjson.com/product-images/2/1.jpg",
-        "https://cdn.dummyjson.com/product-images/2/2.jpg",
-        "https://cdn.dummyjson.com/product-images/2/3.jpg",
-        "https://cdn.dummyjson.com/product-images/2/thumbnail.jpg",
-      ],
-      "price": 899,
-      "rating": 4.44,
-      "stock": 34,
-      "thumbnail": "https://cdn.dummyjson.com/product-images/2/thumbnail.jpg",
-      "title": "New Title",
-    },
-  ],
-  "variations": [],
-}
-`);
+  it("should be defined", async () => {
+    expect(true).toBe(true);
   });
 });

package/boilerplate-repo/test/templates/variation/variation.spec.mjs

@@ -1,37 +1,10 @@
-import {
-  executeTemplate,
-  buildFixture,
-} from "@constructor-io/constructorio-connect-cli";
+/**
+ * Check out the documentation to see how to write and maintain tests:
+ * @see https://docs.constructor.com/docs/integrating-with-constructor-connect-cli-development-flow#step-3-test-your-templates
+*/
 
 describe("variation", () => {
-  it("should match inline snapshot", async () => {
-    const result = await executeTemplate({
-      type: "variation",
-      name: "variation.jsonata",
-      fixture: buildFixture("variation", "variation.json", {
-        name: "stylish boots",
-      }),
-    });
-
-    // Alternatively, you can also store the snapshot in a file to reduce clutter.
-    // expect(result).toMatchSnapshot();
-
-    expect(result).toMatchInlineSnapshot(`
-{
-  "facets": [
-    {
-      "key": "price",
-      "value": 50,
-    },
-  ],
-  "item_name": "These are my stylish boots!",
-  "metadata": [
-    {
-      "key": "color",
-      "value": "red",
-    },
-  ],
-}
-`);
+  it("should be defined", async () => {
+    expect(true).toBe(true);
   });
 });

package/dist/version.d.ts

@@ -1,3 +1,3 @@
-declare const _default: "1.6.0";
+declare const _default: "1.7.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.6.0';
+exports.default = '1.7.0';

package/oclif.manifest.json

@@ -148,5 +148,5 @@
       ]
     }
   },
-  "version": "1.6.0"
+  "version": "1.7.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-connect-cli",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "CLI tool to enable users to interface with the Constructor Connect Ecosystem",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/boilerplate-repo/src/fixtures/item/item.json

@@ -1,39 +0,0 @@
-{
-  "id": 42,
-  "name": "Super Shoes",
-  "variations": [
-    {
-      "id": "42-red",
-      "name": "Super Shoes (Red)",
-      "price": 50,
-      "attributes": [
-        {
-          "name": "color",
-          "value": "red"
-        }
-      ]
-    },
-    {
-      "id": "42-blue",
-      "name": "Super Shoes (Blue)",
-      "price": 100,
-      "attributes": [
-        {
-          "name": "color",
-          "value": "blue"
-        }
-      ]
-    },
-    {
-      "id": "42-green",
-      "name": "Super Shoes (Green)",
-      "price": 75,
-      "attributes": [
-        {
-          "name": "color",
-          "value": "green"
-        }
-      ]
-    }
-  ]
-}

package/boilerplate-repo/src/fixtures/item_group/item_group.json

@@ -1,22 +0,0 @@
-{
-  "id": 1,
-  "name": "Root",
-  "children": [
-    {
-      "id": 2,
-      "name": "Clothing"
-    },
-    {
-      "id": 3,
-      "name": "Shoes"
-    },
-    {
-      "id": 4,
-      "name": "Accessories"
-    },
-    {
-      "id": 5,
-      "name": "Electronics"
-    }
-  ]
-}

package/boilerplate-repo/src/fixtures/mapping/mapping.json

@@ -1,26 +0,0 @@
-{
-  "id": "iphone-x",
-  "title": "iPhone X",
-  "description": "SIM-Free, Model A19211 6.5-inch Super Retina HD display with OLED technology A12 Bionic chip with ...",
-  "price": 899,
-  "discountPercentage": 17.94,
-  "rating": 4.44,
-  "stock": 34,
-  "brand": "Apple",
-  "category": "smartphones",
-  "thumbnail": "https://cdn.dummyjson.com/product-images/2/thumbnail.jpg",
-  "images": [
-    "https://cdn.dummyjson.com/product-images/2/1.jpg",
-    "https://cdn.dummyjson.com/product-images/2/2.jpg",
-    "https://cdn.dummyjson.com/product-images/2/3.jpg",
-    "https://cdn.dummyjson.com/product-images/2/thumbnail.jpg"
-  ],
-  "colors": [
-    "midnight-black",
-    "fancy-silver",
-    "rich-gold",
-    "sky-blue",
-    "crimson-red",
-    "green-forest"
-  ]
-}

package/boilerplate-repo/src/fixtures/variation/variation.json

@@ -1,11 +0,0 @@
-{
-  "id": "42-red",
-  "name": "Super Shoes (Red)",
-  "price": 50,
-  "attributes": [
-    {
-      "name": "color",
-      "value": "red"
-    }
-  ]
-}