@chariow/n8n-nodes-chariow 0.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Axa Zara
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,236 @@
+# n8n-nodes-chariow
+
+This is an n8n community node that lets you use [Chariow](https://chariow.com) in your n8n workflows.
+
+Chariow is a digital products platform that helps creators and entrepreneurs sell their content, products, and services across borders without hassle.
+
+[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
+
+[Installation](#installation)
+[Operations](#operations)
+[Credentials](#credentials)
+[Compatibility](#compatibility)
+[Usage](#usage)
+[Resources](#resources)
+
+## Installation
+
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
+
+### npm
+
+```bash
+npm install n8n-nodes-chariow
+```
+
+### Docker
+
+If you're using Docker, add the package to your n8n instance:
+
+```bash
+docker exec -it n8n npm install n8n-nodes-chariow
+```
+
+Then restart your n8n instance.
+
+## Operations
+
+### Chariow Node (Actions)
+
+This node supports the following resources and operations:
+
+#### Customer
+- **Get**: Retrieve a customer by ID
+- **Get Many**: List customers with optional search filter
+
+#### Product
+- **Get**: Retrieve a product by ID
+- **Get Many**: List products with optional filters (search, status)
+
+#### Sale
+- **Get**: Retrieve a sale by ID
+- **Get Many**: List sales with optional filters (customer_id, product_id, status)
+
+#### Discount
+- **Get**: Retrieve a discount by ID or code
+- **Get Many**: List discounts with optional filters (search, status)
+
+#### Licence
+- **Get**: Retrieve a licence by ID or key
+- **Get Many**: List licences with optional filters (customer_id, product_id, search, status)
+- **Activate**: Activate a licence with optional device information
+- **Revoke**: Revoke a licence
+- **Get Activations**: List activations for a licence
+
+#### Checkout
+- **Create**: Create a new checkout session with optional customer info, discount code, and custom fields
+
+#### Store
+- **Get Info**: Retrieve your store information
+
+### Chariow Trigger Node (Webhooks)
+
+Automatically start workflows when events occur in Chariow:
+
+#### Sale Events
+- `successful.sale` - When a sale is completed successfully
+- `abandoned.sale` - When a sale is abandoned
+- `failed.sale` - When a sale fails
+- `refunded.sale` - When a sale is refunded
+
+#### Licence Events
+- `activated.licence` - When a licence is activated
+- `expired.licence` - When a licence expires
+- `issued.licence` - When a new licence is issued
+- `revoked.licence` - When a licence is revoked
+
+## Credentials
+
+To use this node, you'll need a Chariow API key:
+
+1. Log in to your [Chariow dashboard](https://app.chariow.com)
+2. Go to **Settings** > **API Keys**
+3. Create a new API key or copy an existing one
+4. The API key should start with `sk_live_` (production) or `sk_test_` (testing)
+
+## Compatibility
+
+- Tested with n8n version 1.0.0 and above
+- Requires Node.js 18.10 or higher
+
+## Usage
+
+### Basic Example: Get Customer Data
+
+1. Add the **Chariow** node to your workflow
+2. Select **Customer** as the resource
+3. Select **Get** as the operation
+4. Enter the Customer ID (e.g., `cus_abc123xyz`)
+5. Execute the node
+
+### Webhook Example: Process New Sales
+
+1. Add the **Chariow Trigger** node to your workflow
+2. Select **Sale** as the event category
+3. Select **Successful** as the event type
+4. Activate the workflow
+5. The workflow will trigger whenever a new successful sale occurs
+
+### Create Checkout Example
+
+1. Add the **Chariow** node to your workflow
+2. Select **Checkout** as the resource
+3. Select **Create** as the operation
+4. Enter the Product ID
+5. Optionally add customer email, discount code, or custom fields
+6. Execute to get a checkout URL
+
+## Development
+
+### Prerequisites
+
+- Node.js 18.10+
+- pnpm 9.1+
+- n8n installed globally (for local testing)
+
+### Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/Chariow/n8n-nodes.git
+cd n8n-nodes
+
+# Install dependencies
+pnpm install
+
+# Build the node
+pnpm build
+```
+
+### Local Testing
+
+There are two ways to test the node locally:
+
+#### Option 1: Using n8n-node dev (Recommended)
+
+```bash
+# Build and start n8n with the custom node
+pnpm test:local
+```
+
+This will start n8n with your custom node loaded. Access n8n at `http://localhost:5678`.
+
+#### Option 2: Link to existing n8n installation
+
+```bash
+# Build the node
+pnpm build
+
+# Link to your global n8n
+pnpm link --global
+
+# In your n8n custom nodes directory (~/.n8n/custom)
+mkdir -p ~/.n8n/custom
+cd ~/.n8n/custom
+pnpm link --global n8n-nodes-chariow
+
+# Restart n8n
+n8n start
+```
+
+### Available Scripts
+
+| Command | Description |
+|---------|-------------|
+| `pnpm build` | Build the node |
+| `pnpm build:watch` | Build and watch for changes |
+| `pnpm dev` | Start n8n with the custom node |
+| `pnpm lint` | Run ESLint |
+| `pnpm lint:fix` | Fix ESLint errors |
+| `pnpm format` | Format code with Prettier |
+| `pnpm format:check` | Check code formatting |
+| `pnpm typecheck` | Run TypeScript type checking |
+| `pnpm test:local` | Build and start n8n for testing |
+
+### Project Structure
+
+```
+chariow-n8n/
+├── credentials/
+│   └── ChariowApi.credentials.ts
+├── nodes/
+│   └── Chariow/
+│       ├── Chariow.node.ts
+│       ├── ChariowTrigger.node.ts
+│       ├── shared/
+│       │   ├── transport.ts
+│       │   ├── utils.ts
+│       │   └── descriptions.ts
+│       └── resources/
+│           ├── customer/
+│           ├── product/
+│           ├── sale/
+│           ├── discount/
+│           ├── licence/
+│           ├── checkout/
+│           └── store/
+├── icons/
+│   └── chariow.svg
+└── dist/                    # Built output
+```
+
+## Resources
+
+* [Chariow Documentation](https://docs.chariow.com/)
+* [Chariow API Reference](https://docs.chariow.com/api)
+* [n8n Community Nodes Documentation](https://docs.n8n.io/integrations/community-nodes/)
+
+## Support
+
+For issues with this node, please [open an issue](https://github.com/Chariow/n8n-nodes/issues) on GitHub.
+
+For questions about Chariow, contact [support@chariow.com](mailto:support@chariow.com).
+
+## License
+
+[MIT](LICENSE.md)

package/dist/credentials/ChariowApi.credentials.d.ts

@@ -0,0 +1,13 @@
+import type { IAuthenticateGeneric, ICredentialTestRequest, ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class ChariowApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    icon: {
+        readonly light: "file:../icons/chariow.svg";
+        readonly dark: "file:../icons/chariow.svg";
+    };
+    properties: INodeProperties[];
+    authenticate: IAuthenticateGeneric;
+    test: ICredentialTestRequest;
+}

package/dist/credentials/ChariowApi.credentials.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChariowApi = void 0;
+const constants_1 = require("../nodes/Chariow/shared/constants");
+class ChariowApi {
+    constructor() {
+        this.name = 'chariowApi';
+        this.displayName = 'Chariow API';
+        this.documentationUrl = 'https://docs.chariow.com/en/introduction/overview';
+        this.icon = {
+            light: 'file:../icons/chariow.svg',
+            dark: 'file:../icons/chariow.svg',
+        };
+        this.properties = [
+            {
+                displayName: 'API Key',
+                name: 'apiKey',
+                type: 'string',
+                typeOptions: { password: true },
+                default: '',
+                required: true,
+                description: 'Your Chariow API Key. Find it in your store settings under API Keys. It should start with sk_.',
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    Authorization: '=Bearer {{$credentials.apiKey}}',
+                    Accept: 'application/json',
+                    'Content-Type': 'application/json',
+                    'X-Platform-Source': 'n8n',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: constants_1.API_BASE_URL,
+                url: '/store',
+            },
+        };
+    }
+}
+exports.ChariowApi = ChariowApi;

package/dist/icons/chariow.svg

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg id="Calque_2" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1189.84 1190.66">
+  <defs>
+    <style>
+      .cls-1 {
+        fill: #fc0;
+      }
+
+      .cls-2 {
+        fill: #1c1e21;
+      }
+    </style>
+  </defs>
+  <g id="Calque_1-2" data-name="Calque_1">
+    <g>
+      <path class="cls-1" d="M1189.84,372.38c0,328.57-266.36,594.93-594.93,594.93S0,700.95,0,372.38h148.13c0,246.76,200.03,446.8,446.78,446.8s446.8-200.04,446.8-446.8h148.13Z"/>
+      <g>
+        <path class="cls-2" d="M892.11,1080c0,61.11-49.53,110.66-110.66,110.66s-110.66-49.55-110.66-110.66,49.55-110.66,110.66-110.66,110.66,49.55,110.66,110.66Z"/>
+        <path class="cls-2" d="M519.03,1080c0,61.11-49.53,110.66-110.66,110.66s-110.66-49.55-110.66-110.66,49.55-110.66,110.66-110.66,110.66,49.55,110.66,110.66Z"/>
+      </g>
+      <g>
+        <rect class="cls-1" x="742.88" width="297.76" height="297.76"/>
+        <polygon class="cls-2" points="804.55 534.22 594 744.75 149.2 299.95 154.94 294.2 359.73 89.4 642.71 372.38 804.55 534.22"/>
+      </g>
+    </g>
+  </g>
+</svg>

package/dist/nodes/Chariow/Chariow.node.d.ts

@@ -0,0 +1,5 @@
+import type { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class Chariow implements INodeType {
+    description: INodeTypeDescription;
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}

package/dist/nodes/Chariow/Chariow.node.js

@@ -0,0 +1,168 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Chariow = void 0;
+const n8n_workflow_1 = require("n8n-workflow");
+const resources_1 = require("./resources");
+class Chariow {
+    constructor() {
+        this.description = {
+            displayName: 'Chariow',
+            name: 'chariow',
+            icon: 'file:../../icons/chariow.svg',
+            group: ['transform'],
+            version: 1,
+            subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
+            description: 'Interact with Chariow - the digital products platform for creators and entrepreneurs',
+            defaults: {
+                name: 'Chariow',
+            },
+            inputs: [n8n_workflow_1.NodeConnectionTypes.Main],
+            outputs: [n8n_workflow_1.NodeConnectionTypes.Main],
+            usableAsTool: true,
+            credentials: [
+                {
+                    name: 'chariowApi',
+                    required: true,
+                },
+            ],
+            properties: [
+                {
+                    displayName: 'Resource',
+                    name: 'resource',
+                    type: 'options',
+                    noDataExpression: true,
+                    options: [
+                        { name: 'Affiliate', value: 'affiliate' },
+                        { name: 'Checkout', value: 'checkout' },
+                        { name: 'Customer', value: 'customer' },
+                        { name: 'Discount', value: 'discount' },
+                        { name: 'Licence', value: 'licence' },
+                        { name: 'Product', value: 'product' },
+                        { name: 'Pulse', value: 'pulse' },
+                        { name: 'Sale', value: 'sale' },
+                        { name: 'Store', value: 'store' },
+                    ],
+                    default: 'customer',
+                },
+                ...resources_1.affiliate.operations,
+                ...resources_1.affiliate.fields,
+                ...resources_1.customer.operations,
+                ...resources_1.customer.fields,
+                ...resources_1.product.operations,
+                ...resources_1.product.fields,
+                ...resources_1.sale.operations,
+                ...resources_1.sale.fields,
+                ...resources_1.discount.operations,
+                ...resources_1.discount.fields,
+                ...resources_1.licence.operations,
+                ...resources_1.licence.fields,
+                ...resources_1.checkout.operations,
+                ...resources_1.checkout.fields,
+                ...resources_1.store.operations,
+                ...resources_1.store.fields,
+                ...resources_1.pulse.operations,
+                ...resources_1.pulse.fields,
+            ],
+        };
+    }
+    async execute() {
+        const items = this.getInputData();
+        const returnData = [];
+        const resource = this.getNodeParameter('resource', 0);
+        const operation = this.getNodeParameter('operation', 0);
+        for (let i = 0; i < items.length; i++) {
+            try {
+                let responseData = {};
+                if (resource === 'affiliate') {
+                    if (operation === 'get') {
+                        responseData = await resources_1.affiliate.get.execute.call(this, i);
+                    }
+                    else if (operation === 'sendInvitations') {
+                        responseData = await resources_1.affiliate.sendInvitations.execute.call(this, i);
+                    }
+                }
+                if (resource === 'customer') {
+                    if (operation === 'get') {
+                        responseData = await resources_1.customer.get.execute.call(this, i);
+                    }
+                    else if (operation === 'getAll') {
+                        responseData = await resources_1.customer.getAll.execute.call(this, i);
+                    }
+                }
+                if (resource === 'product') {
+                    if (operation === 'get') {
+                        responseData = await resources_1.product.get.execute.call(this, i);
+                    }
+                    else if (operation === 'getAll') {
+                        responseData = await resources_1.product.getAll.execute.call(this, i);
+                    }
+                }
+                if (resource === 'sale') {
+                    if (operation === 'get') {
+                        responseData = await resources_1.sale.get.execute.call(this, i);
+                    }
+                    else if (operation === 'getAll') {
+                        responseData = await resources_1.sale.getAll.execute.call(this, i);
+                    }
+                }
+                if (resource === 'discount') {
+                    if (operation === 'get') {
+                        responseData = await resources_1.discount.get.execute.call(this, i);
+                    }
+                    else if (operation === 'getAll') {
+                        responseData = await resources_1.discount.getAll.execute.call(this, i);
+                    }
+                }
+                if (resource === 'licence') {
+                    if (operation === 'get') {
+                        responseData = await resources_1.licence.get.execute.call(this, i);
+                    }
+                    else if (operation === 'getAll') {
+                        responseData = await resources_1.licence.getAll.execute.call(this, i);
+                    }
+                    else if (operation === 'activate') {
+                        responseData = await resources_1.licence.activate.execute.call(this, i);
+                    }
+                    else if (operation === 'revoke') {
+                        responseData = await resources_1.licence.revoke.execute.call(this, i);
+                    }
+                    else if (operation === 'getActivations') {
+                        responseData = await resources_1.licence.getActivations.execute.call(this, i);
+                    }
+                }
+                if (resource === 'checkout') {
+                    if (operation === 'create') {
+                        responseData = await resources_1.checkout.create.execute.call(this, i);
+                    }
+                }
+                if (resource === 'store') {
+                    if (operation === 'getInfo') {
+                        responseData = await resources_1.store.getInfo.execute.call(this);
+                    }
+                }
+                if (resource === 'pulse') {
+                    if (operation === 'get') {
+                        responseData = await resources_1.pulse.get.execute.call(this, i);
+                    }
+                    else if (operation === 'getAll') {
+                        responseData = await resources_1.pulse.getAll.execute.call(this, i);
+                    }
+                }
+                const executionData = this.helpers.constructExecutionMetaData(this.helpers.returnJsonArray(responseData), { itemData: { item: i } });
+                returnData.push(...executionData);
+            }
+            catch (error) {
+                if (this.continueOnFail()) {
+                    returnData.push({
+                        json: { error: error.message },
+                        pairedItem: { item: i },
+                    });
+                    continue;
+                }
+                throw error;
+            }
+        }
+        return [returnData];
+    }
+}
+exports.Chariow = Chariow;

package/dist/nodes/Chariow/Chariow.node.json

@@ -0,0 +1,18 @@
+{
+    "node": "n8n-nodes-base.chariow",
+    "nodeVersion": "1.0",
+    "codexVersion": "1.0",
+    "categories": ["Sales"],
+    "resources": {
+        "credentialDocumentation": [
+            {
+                "url": "https://docs.chariow.com/en/introduction/overview"
+            }
+        ],
+        "primaryDocumentation": [
+            {
+                "url": "https://docs.chariow.com/"
+            }
+        ]
+    }
+}

package/dist/nodes/Chariow/ChariowTrigger.node.d.ts

@@ -0,0 +1,12 @@
+import type { IHookFunctions, INodeType, INodeTypeDescription, IWebhookFunctions, IWebhookResponseData } from 'n8n-workflow';
+export declare class ChariowTrigger implements INodeType {
+    description: INodeTypeDescription;
+    webhookMethods: {
+        default: {
+            checkExists(this: IHookFunctions): Promise<boolean>;
+            create(this: IHookFunctions): Promise<boolean>;
+            delete(this: IHookFunctions): Promise<boolean>;
+        };
+    };
+    webhook(this: IWebhookFunctions): Promise<IWebhookResponseData>;
+}