n8n-nodes-commercetools 0.1.6 → 0.1.7

package/README.md

@@ -22,16 +22,17 @@ This will start n8n with the Commercetools node loaded and hot reload enabled.
 
 
 
+
 ## Configuration Options
 
-Below are the main configuration options and parameters available for the Commercetools node (resource: product):
+Below are the main configuration options and parameters available for the Commercetools node (resource: product or category):
 
 ### Common Parameters
-- **resource**: Select 'product' to access product operations.
-- **operation**: Choose the desired product operation (e.g., create, query, get, update, delete, etc.).
+- **resource**: Select 'product' or 'category' to access respective operations.
+- **operation**: Choose the desired operation (e.g., create, query, get, update, delete, etc.).
 - **Credentials**: Select your configured Commercetools OAuth2 credentials.
 
-### Operation-Specific Parameters
+### Product Operation-Specific Parameters
 
 #### Create Product
 - **productDraft**: JSON object with product details (name, slug, productType, masterVariant, etc.).
@@ -72,6 +73,34 @@ Below are the main configuration options and parameters available for the Commer
 - **binaryPropertyName**: Name of the binary property containing the image.
 - **additionalFieldsUpload**: Optional fields (variantId, sku, staged, filename, externalUrl, label, customParameters).
 
+### Category Operation-Specific Parameters
+
+#### Create Category
+- **categoryDraft**: JSON object with category details (name, slug, parent, orderHint, etc.).
+- **additionalFieldsCreate**: Optional fields for additional category properties.
+
+#### Query Categories
+- **returnAll**: Boolean to return all categories (up to 500 per request).
+- **limit**: Number of categories to return per request.
+- **offset**: Pagination offset.
+- **additionalFields**: Optional filters, sorting, and predicate variables.
+
+#### Get Category / Get By Key
+- **categoryId** or **categoryKey**: ID or key of the category to retrieve.
+- **additionalFieldsGet**: Optional fields for expanded data.
+
+#### Update Category / Update By Key
+- **categoryId** or **categoryKey**: ID or key of the category to update.
+- **version**: Category version (required for updates).
+- **actions**: Array of update actions (JSON).
+- **actionsUi**: UI-based update actions.
+- **additionalFieldsUpdate**: Optional fields (dataErasure, dryRun, etc.).
+
+#### Delete Category / Delete By Key
+- **categoryId** or **categoryKey**: ID or key of the category to delete.
+- **version**: Category version (required for deletion).
+- **additionalFieldsDelete**: Optional fields (dataErasure, etc.).
+
 Refer to the node UI in n8n for detailed descriptions and validation for each parameter.
 
 Below is a sample workflow using the Commercetools node in n8n to create and query a product.
@@ -97,6 +126,7 @@ Below is a sample workflow using the Commercetools node in n8n to create and que
 }
 ```
 
+
 ### Example: Query Products
 
 1. Add the **Commercetools** node to your workflow.
@@ -111,50 +141,90 @@ Below is a sample workflow using the Commercetools node in n8n to create and que
   {
     "id": "product-id-1",
     "name": { "en": "Sample Product" },
-    "slug": { "en": "sample-product" },
+    "slug": { "en": "sample-product" }
     // ...other product fields
-  },
+  }
   // ...more products
 ]
 ```
 
-You can chain Commercetools node operations with other n8n nodes to build advanced workflows for product management, automation, and integration.
+### Example: Create a Category
+
+1. Add the **Commercetools** node to your workflow.
+2. Select the **Create Category** operation.
+3. Fill in the required category draft fields (e.g., name, slug, parent, orderHint, etc.).
+4. Select your configured Commercetools credentials.
+5. Run the workflow to create a new category in your Commercetools project.
+
+**Sample Input (Category Draft):**
+```json
+{
+  "name": { "en": "Sample Category" },
+  "slug": { "en": "sample-category" },
+  "orderHint": "0.1"
+}
+```
+
+### Example: Query Categories
+
+1. Add the **Commercetools** node to your workflow.
+2. Select the **Query Categories** operation.
+3. Optionally set filters, sorting, and pagination parameters.
+4. Select your configured Commercetools credentials.
+5. Run the workflow to retrieve categories from your Commercetools project.
+
+**Sample Output:**
+```json
+[
+  {
+    "id": "category-id-1",
+    "name": { "en": "Sample Category" },
+    "slug": { "en": "sample-category" }
+    // ...other category fields
+  }
+  // ...more categories
+]
+```
+
+You can chain Commercetools node operations with other n8n nodes to build advanced workflows for product and category management, automation, and integration.
+
 
 ## Credential Setup
 
-To use the Commercetools node, you must configure OAuth2 credentials for your Commercetools project in n8n. Follow these steps:
+To use the Commercetools node for both product and category operations, you must configure OAuth2 credentials for your Commercetools project in n8n. Follow these steps:
 
 1. **Obtain Commercetools API credentials:**
-  - Log in to your Commercetools Merchant Center.
-  - Go to the API Clients section and create a new API client.
-  - Note the following values:
-    - `Client ID`
-    - `Client Secret`
-    - `Project Key`
-    - `Scopes` (ensure you have the required scopes for product operations)
-    - `Region` (e.g., `australia-southeast1.gcp`)
+   - Log in to your Commercetools Merchant Center.
+   - Go to the API Clients section and create a new API client.
+   - Note the following values:
+     - `Client ID`
+     - `Client Secret`
+     - `Project Key`
+     - `Scopes` (ensure you have the required scopes for product and category operations)
+     - `Region` (e.g., `australia-southeast1.gcp`)
 
 2. **Add credentials in n8n:**
-  - In n8n, go to **Credentials** > **Create New**.
-  - Search for and select **Commercetools OAuth2 API**.
-  - Fill in the required fields:
-    - **Client ID**
-    - **Client Secret**
-    - **Project Key**
-    - **Region**
-    - **Scopes**
-  - Save the credentials.
+   - In n8n, go to **Credentials** > **Create New**.
+   - Search for and select **Commercetools OAuth2 API**.
+   - Fill in the required fields:
+     - **Client ID**
+     - **Client Secret**
+     - **Project Key**
+     - **Region**
+     - **Scopes**
+   - Save the credentials.
 
 3. **Use credentials in your workflow:**
-  - When adding the Commercetools node to your workflow, select the credentials you just created from the credentials dropdown.
+   - When adding the Commercetools node to your workflow, select the credentials you just created from the credentials dropdown.
 
-Your Commercetools node is now authenticated and ready to use in n8n workflows.
+Your Commercetools node is now authenticated and ready to use for both product and category operations in n8n workflows.
 
 
 ## Features & Supported Operations
 
-The Commercetools node for n8n enables you to interact with the Commercetools API for product management. The following operations are supported:
+The Commercetools node for n8n enables you to interact with the Commercetools API for product and category management. The following operations are supported:
 
+### Product Operations
 - **Create Product**  
   Create a new product in your Commercetools project.
 
@@ -179,11 +249,26 @@ The Commercetools node for n8n enables you to interact with the Commercetools AP
 - **Upload Product Image**  
   Upload an image to a product, either from binary data or an external URL.
 
-### Check Product Existence
+### Category Operations
+- **Create Category**  
+  Create a new category in your Commercetools project.
+
+- **Query Categories**  
+  Retrieve a list of categories with support for pagination, sorting, and filtering.
 
-- **By ID:** Use the "HEAD" operation with a product ID to check if a product exists.
-- **By Key:** Use the "HEAD by Key" operation with a product key.
-- **By Query:** Use the "HEAD by Query" operation to check if any product matches a specific query.
+- **Get Category (by ID or Key)**  
+  Retrieve detailed information for a specific category by its ID or key.
+
+- **Update Category (by ID or Key)**  
+  Update an existing category using one or more update actions.
+
+- **Delete Category (by ID or Key)**  
+  Delete a category from your project.
+
+### Check Product & Category Existence
+- **By ID:** Use the "HEAD" operation with a product or category ID to check if it exists.
+- **By Key:** Use the "HEAD by Key" operation with a product or category key.
+- **By Query:** Use the "HEAD by Query" operation to check if any product or category matches a specific query.
 
 Each operation supports additional parameters for fine-tuned control, such as staged changes, data erasure, dry run, and more.
 
@@ -240,30 +325,33 @@ Each operation supports additional parameters for fine-tuned control, such as st
 
 
 
+
 ## Error Handling & Troubleshooting
 
-Here are common errors and troubleshooting tips for the Commercetools node:
+Here are common errors and troubleshooting tips for the Commercetools node (products and categories):
 
 - **Authentication Errors:**
   - Ensure your OAuth2 credentials (Client ID, Client Secret, Project Key, Region, Scopes) are correct and have the required permissions.
   - If you see an authentication error, re-authorize or recreate your credentials in n8n.
 
 - **Missing or Invalid Parameters:**
-  - Double-check required fields for each operation (e.g., productDraft for create, productId/productKey for get/update/delete, version for update/delete).
+  - Double-check required fields for each operation:
+    - For products: productDraft, productId/productKey, version, etc.
+    - For categories: categoryDraft, categoryId/categoryKey, version, etc.
   - The node will display a clear error if a required parameter is missing or invalid.
 
 - **API Errors:**
   - Errors from the Commercetools API (e.g., 404 Not Found, 400 Bad Request) will be shown in the node output or n8n error panel.
   - Review the error message for details and check your input data.
 
-- **Product Not Found:**
-  - For get, update, delete, or existence checks, ensure the productId or productKey is correct and the product exists in your project.
+- **Not Found (Product/Category):**
+  - For get, update, delete, or existence checks, ensure the productId/productKey or categoryId/categoryKey is correct and the item exists in your project.
 
 - **Version Mismatch:**
-  - For update and delete operations, the product version must match the current version in Commercetools. Retrieve the latest version before updating or deleting.
+  - For update and delete operations, the version must match the current version in Commercetools. Retrieve the latest version before updating or deleting (applies to both products and categories).
 
 - **Binary Data Issues (Image Upload):**
-  - Ensure the binary property name matches the uploaded file and the file is present in the workflow.
+  - Ensure the binary property name matches the uploaded file and the file is present in the workflow (product image upload only).
 
 - **General Node Issues:**
   - If the node does not appear in n8n, ensure dependencies are installed, the node is registered in `package.json`, and the dev server is running.
@@ -289,7 +377,10 @@ Contributions and suggestions for improving the Commercetools node are welcome.
 
 All notable changes to this project will be documented in the `CHANGELOG.md` file. Below is a summary of recent updates:
 
+
 ### [Unreleased]
+- Added category-related APIs to Commercetools node (create, query, get, update, delete, existence checks)
+- Updated documentation to include category operations in features, configuration, usage examples, credential setup, and troubleshooting
 - Documentation improvements and structure updates
 - Added detailed usage examples and troubleshooting section
 - Enhanced configuration options and parameter documentation

package/dist/nodes/Commercetools/Commercetools.node.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Commercetools = void 0;
 const n8n_workflow_1 = require("n8n-workflow");
 const Commercetools_description_1 = require("./descriptions/Commercetools.description");
+const category_operations_1 = require("./operations/category.operations");
 const product_operations_1 = require("./operations/product.operations");
 class Commercetools {
     constructor() {
@@ -19,11 +20,6 @@ class Commercetools {
             try {
                 const resource = this.getNodeParameter('resource', itemIndex);
                 const operation = this.getNodeParameter('operation', itemIndex);
-                if (resource !== 'product') {
-                    throw new n8n_workflow_1.NodeOperationError(this.getNode(), `Unsupported resource: ${resource}`, {
-                        itemIndex,
-                    });
-                }
                 const credentials = (await this.getCredentials('commerceToolsOAuth2Api'));
                 const projectKey = credentials.projectKey;
                 const region = credentials.region || 'australia-southeast1.gcp';
@@ -33,12 +29,27 @@ class Commercetools {
                     });
                 }
                 const baseUrl = `https://api.${region}.commercetools.com/${projectKey}`;
-                const results = await product_operations_1.executeProductOperation.call(this, {
-                    operation,
-                    itemIndex,
-                    baseUrl,
-                    items,
-                });
+                let results = [];
+                if (resource === 'product') {
+                    results = await product_operations_1.executeProductOperation.call(this, {
+                        operation,
+                        itemIndex,
+                        baseUrl,
+                        items,
+                    });
+                }
+                else if (resource === 'category') {
+                    results = await category_operations_1.executeCategoryOperation.call(this, {
+                        operation,
+                        itemIndex,
+                        baseUrl,
+                    });
+                }
+                else {
+                    throw new n8n_workflow_1.NodeOperationError(this.getNode(), `Unsupported resource: ${resource}`, {
+                        itemIndex,
+                    });
+                }
                 returnData.push(...results);
             }
             catch (error) {

package/dist/nodes/Commercetools/Commercetools.node.js.map

@@ -1 +1 @@
-{"version":3,"file":"Commercetools.node.js","sourceRoot":"","sources":["../../../nodes/Commercetools/Commercetools.node.ts"],"names":[],"mappings":";;;AAOA,+CAAkD;AAElD,wFAAoF;AACpF,wEAA0E;AAE1E,MAAa,aAAa;IAA1B;QACC,gBAAW,GAAyB;YACnC,GAAG,oDAAwB;YAC3B,IAAI,EAAE,wBAAwB;YAC9B,YAAY,EAAE,IAAI;SAClB,CAAC;IA2DH,CAAC;IAxDA,KAAK,CAAC,OAAO;QACZ,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAClC,MAAM,UAAU,GAAyB,EAAE,CAAC;QAE5C,KAAK,IAAI,SAAS,GAAG,CAAC,EAAE,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,CAAC;YAC/D,IAAI,CAAC;gBACJ,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,SAAS,CAAW,CAAC;gBACxE,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,SAAS,CAAW,CAAC;gBAE1E,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;oBAC5B,MAAM,IAAI,iCAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,yBAAyB,QAAQ,EAAE,EAAE;wBACjF,SAAS;qBACT,CAAC,CAAC;gBACJ,CAAC;gBAED,MAAM,WAAW,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,wBAAwB,CAAC,CAAgB,CAAC;gBACzF,MAAM,UAAU,GAAG,WAAW,CAAC,UAAoB,CAAC;gBACpD,MAAM,MAAM,GAAI,WAAW,CAAC,MAAiB,IAAI,0BAA0B,CAAC;gBAE5E,IAAI,CAAC,UAAU,EAAE,CAAC;oBACjB,MAAM,IAAI,iCAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,2CAA2C,EAAE;wBACzF,SAAS;qBACT,CAAC,CAAC;gBACJ,CAAC;gBAED,MAAM,OAAO,GAAG,eAAe,MAAM,sBAAsB,UAAU,EAAE,CAAC;gBAExE,MAAM,OAAO,GAAG,MAAM,4CAAuB,CAAC,IAAI,CAAC,IAAI,EAAE;oBACxD,SAAS;oBACT,SAAS;oBACT,OAAO;oBACP,KAAK;iBACL,CAAC,CAAC;gBAEH,UAAU,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;YAC7B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBAChB,IAAI,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;oBAC3B,UAAU,CAAC,IAAI,CAAC;wBACf,IAAI,EAAE;4BACL,KAAK,EAAG,KAAe,CAAC,OAAO;4BAC/B,SAAS;yBACT;qBACD,CAAC,CAAC;oBACH,SAAS;gBACV,CAAC;gBAED,IAAI,KAAK,YAAY,iCAAkB,EAAE,CAAC;oBACzC,MAAM,KAAK,CAAC;gBACb,CAAC;gBAED,MAAM,IAAI,iCAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,KAAc,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;YAC7E,CAAC;QACF,CAAC;QAED,OAAO,CAAC,UAAU,CAAC,CAAC;IACrB,CAAC;CACD;AAhED,sCAgEC"}
+{"version":3,"file":"Commercetools.node.js","sourceRoot":"","sources":["../../../nodes/Commercetools/Commercetools.node.ts"],"names":[],"mappings":";;;AAOA,+CAAkD;AAElD,wFAAoF;AACpF,0EAA4E;AAC5E,wEAA0E;AAE1E,MAAa,aAAa;IAA1B;QACC,gBAAW,GAAyB;YACnC,GAAG,oDAAwB;YAC3B,IAAI,EAAE,wBAAwB;YAC9B,YAAY,EAAE,IAAI;SAClB,CAAC;IAmEH,CAAC;IAhEA,KAAK,CAAC,OAAO;QACZ,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAClC,MAAM,UAAU,GAAyB,EAAE,CAAC;QAE5C,KAAK,IAAI,SAAS,GAAG,CAAC,EAAE,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,CAAC;YAC/D,IAAI,CAAC;gBACJ,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,SAAS,CAAW,CAAC;gBACxE,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,SAAS,CAAW,CAAC;gBAE1E,MAAM,WAAW,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,wBAAwB,CAAC,CAAgB,CAAC;gBACzF,MAAM,UAAU,GAAG,WAAW,CAAC,UAAoB,CAAC;gBACpD,MAAM,MAAM,GAAI,WAAW,CAAC,MAAiB,IAAI,0BAA0B,CAAC;gBAE5E,IAAI,CAAC,UAAU,EAAE,CAAC;oBACjB,MAAM,IAAI,iCAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,2CAA2C,EAAE;wBACzF,SAAS;qBACT,CAAC,CAAC;gBACJ,CAAC;gBAED,MAAM,OAAO,GAAG,eAAe,MAAM,sBAAsB,UAAU,EAAE,CAAC;gBAExE,IAAI,OAAO,GAAyB,EAAE,CAAC;gBAEvC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;oBAC5B,OAAO,GAAG,MAAM,4CAAuB,CAAC,IAAI,CAAC,IAAI,EAAE;wBAClD,SAAS;wBACT,SAAS;wBACT,OAAO;wBACP,KAAK;qBACL,CAAC,CAAC;gBACJ,CAAC;qBAAM,IAAI,QAAQ,KAAK,UAAU,EAAE,CAAC;oBACpC,OAAO,GAAG,MAAM,8CAAwB,CAAC,IAAI,CAAC,IAAI,EAAE;wBACnD,SAAS;wBACT,SAAS;wBACT,OAAO;qBACP,CAAC,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACP,MAAM,IAAI,iCAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,yBAAyB,QAAQ,EAAE,EAAE;wBACjF,SAAS;qBACT,CAAC,CAAC;gBACJ,CAAC;gBAED,UAAU,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;YAC7B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBAChB,IAAI,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;oBAC3B,UAAU,CAAC,IAAI,CAAC;wBACf,IAAI,EAAE;4BACL,KAAK,EAAG,KAAe,CAAC,OAAO;4BAC/B,SAAS;yBACT;qBACD,CAAC,CAAC;oBACH,SAAS;gBACV,CAAC;gBAED,IAAI,KAAK,YAAY,iCAAkB,EAAE,CAAC;oBACzC,MAAM,KAAK,CAAC;gBACb,CAAC;gBAED,MAAM,IAAI,iCAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,KAAc,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;YAC7E,CAAC;QACF,CAAC;QAED,OAAO,CAAC,UAAU,CAAC,CAAC;IACrB,CAAC;CACD;AAxED,sCAwEC"}