@disruptive-learning/n8n-nodes-gigstack 1.1.1 → 1.1.3

package/README.md

@@ -1,81 +1,173 @@
-# @disruptive-learning/n8n-nodes-gigstack
+# n8n-nodes-gigstack
 
-This is a community node for [n8n](https://n8n.io/) that integrates with the [Gigstack API](https://gigstack.com). It allows you to create and manage payments and invoices directly from your n8n workflows.
+![npm](https://img.shields.io/npm/v/@disruptive-learning/n8n-nodes-gigstack)
+![license](https://img.shields.io/npm/l/@disruptive-learning/n8n-nodes-gigstack)
+![n8n](https://img.shields.io/badge/n8n-community--node-orange)
 
-[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
+**n8n community node for [Gigstack](https://gigstack.io)** - Mexican tax compliance, invoicing (CFDI 4.0), and payment processing.
 
-[Installation](#installation)  
-[Operations](#operations)  
-[Credentials](#credentials)  
-[Compatibility](#compatibility)  
-[Resources](#resources)  
-[Version history](#version-history)  
-[Security](#security)
+Automate your Mexican billing workflows with SAT-compliant invoices, receipts, payments, and more.
+
+---
 
 ## Installation
 
-Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
+### In n8n (Recommended)
+
+1. Go to **Settings** > **Community Nodes**
+2. Enter `@disruptive-learning/n8n-nodes-gigstack`
+3. Click **Install**
+
+### Manual Installation
 
-### Community Node Installation
+```bash
+cd ~/.n8n/custom
+npm install @disruptive-learning/n8n-nodes-gigstack
+```
 
-1. Open your n8n instance
-2. Go to **Settings** > **Community Nodes**
-3. Select **Install**
-4. Enter `@disruptive-learning/n8n-nodes-gigstack` in **Enter npm package name**
-5. Agree to the risks of using community nodes: select **I understand the risks of installing unverified code from a third party**
-6. Select **Install**
+### Docker
 
-After installing the node, you can use it like any other node. If you're using Docker, you need to restart your n8n container for the node to show up.
+```dockerfile
+RUN cd /home/node/.n8n/custom && npm install @disruptive-learning/n8n-nodes-gigstack
+```
 
-## Operations
+---
 
-### Payment Operations
+## Features
 
-- **Create**: Create a new payment
-- **Get**: Get payment details
-- **Register**: Register a new payment
+| Resource | Operations |
+|----------|------------|
+| **Clients** | Create, Get, Get All, Update, Delete, Validate (SAT), Customer Portal, Stamp Pending Receipts |
+| **Invoices** | Create Income (CFDI I), Create Egress (CFDI E), Get, Get All, Cancel, Get Files (PDF/XML) |
+| **Payments** | Request, Register, Get, Get All, Cancel, Mark as Paid, Refund |
+| **Receipts** | Create, Get, Get All, Cancel, Stamp (convert to CFDI) |
+| **Services** | Create, Get, Get All, Update, Delete |
+| **Teams** | Create, Get, Get All, Update, Add/Remove Members, Series Management, Settings |
+| **Users** | Create, Get, Get All, Update, Reset Password, Login Link |
+| **Webhooks** | Create, Get, Get All, Update, Delete |
 
-### Invoice Operations
+### Trigger Node
 
-- **Create**: Create a new invoice with detailed information
+Listen for real-time events:
+- `invoice.created`, `invoice.cancelled`
+- `payment.completed`, `payment.failed`
+- `receipt.stamped`
+- And more...
+
+---
 
 ## Credentials
 
-To use this node, you need to configure your Gigstack API credentials in n8n:
+1. Get your API key from [Gigstack Dashboard](https://app.gigstack.io/settings/api)
+2. In n8n, go to **Credentials** > **New Credential**
+3. Search for **Gigstack API**
+4. Enter your API key
+5. Select environment: **Production** or **Sandbox**
 
-1. Go to **Settings** > **Credentials**
-2. Click on **New Credential**
-3. Select **Gigstack API**
-4. Enter your API Key
-5. Select the environment (Production or Sandbox)
-6. Save the credential
+---
 
-## Compatibility
+## Usage Examples
 
-This node has been tested with n8n version 0.214.0 and Gigstack API v1.
+### Create a Client
 
-## Resources
+```json
+{
+  "email": "cliente@empresa.mx",
+  "name": "Juan Perez",
+  "legal_name": "Juan Perez Garcia",
+  "tax_id": "PEGJ850101ABC",
+  "tax_system": "612",
+  "zip": "06600"
+}
+```
+
+### Create an Invoice (CFDI)
+
+```json
+{
+  "clientId": "client_abc123",
+  "items": [
+    {
+      "description": "Servicio de consultoría",
+      "quantity": 1,
+      "unit_price": 5000,
+      "product_key": "80141503",
+      "unit_key": "E48"
+    }
+  ],
+  "payment_method": "PUE",
+  "payment_form": "03",
+  "use": "G03"
+}
+```
+
+### Request Payment
+
+```json
+{
+  "clientId": "client_abc123",
+  "amount": 5800,
+  "currency": "MXN",
+  "description": "Payment for consulting services"
+}
+```
+
+---
+
+## SAT Compliance
 
-- [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
-- [Gigstack API documentation](https://docs.gigstack.com)
+This node supports **CFDI 4.0** Mexican tax requirements:
 
-## Security
+- **Tax Regimes** (Regimen Fiscal): 601, 603, 605, 606, 612, 616, 621, 625, 626
+- **CFDI Uses** (Uso de CFDI): G01, G02, G03, P01, S01, and more
+- **Payment Methods**: PUE (single payment), PPD (partial/deferred)
+- **Payment Forms**: Cash, Transfer, Credit Card, etc. (01-99)
+- **Cancellation Motives**: 01, 02, 03, 04
 
-> **Note**: This package has some vulnerabilities in its development dependencies. These vulnerabilities are only present during development and do not affect the published package that users install. The production dependencies are kept up-to-date and secure.
+---
 
-## Version history
+## Multi-Team Support (Gigstack Connect)
 
-### 1.1.1
+For Gigstack Connect users managing multiple teams:
 
-- [Add description of changes in this version]
+1. Add the **Team ID** field in any operation
+2. Leave empty to use your default team
+3. Specify a team ID to operate on behalf of that team
+
+---
+
+## Development
+
+```bash
+# Clone the repository
+git clone https://github.com/disruptive-learning/n8n_v2.git
+cd n8n_v2
+
+# Install dependencies
+npm install
+
+# Build
+npm run build
+
+# Sync with Gigstack API (check for updates)
+npm run sync-swagger
+
+# Link for local testing
+npm link
+cd ~/.n8n/custom && npm link @disruptive-learning/n8n-nodes-gigstack
+```
+
+---
+
+## Resources
 
-### 1.1.0
+- [Gigstack Website](https://gigstack.io)
+- [Gigstack API Documentation](https://docs.gigstack.io)
+- [n8n Community Nodes](https://docs.n8n.io/integrations/community-nodes/)
+- [Report Issues](https://github.com/disruptive-learning/n8n_v2/issues)
 
-- Added Invoice resource with Create operation
-- Fixed Get Payment operation to use correct API endpoint
-- Updated node version to 2
+---
 
-### 1.0.0
+## License
 
-- Initial release
-- Added Payment resource with Create, Get, and Register operations
+[MIT](LICENSE) - Built with love by [Gigstack](https://gigstack.io) and [Disruptive Learning](https://github.com/disruptive-learning)

package/dist/credentials/GigstackApi.credentials.d.ts

@@ -1,8 +1,9 @@
-import { IAuthenticateGeneric, ICredentialType, INodeProperties } from "n8n-workflow";
+import type { IAuthenticateGeneric, ICredentialTestRequest, ICredentialType, INodeProperties } from 'n8n-workflow';
 export declare class GigstackApi implements ICredentialType {
     name: string;
     displayName: string;
     documentationUrl: string;
     properties: INodeProperties[];
     authenticate: IAuthenticateGeneric;
+    test: ICredentialTestRequest;
 }

package/dist/credentials/GigstackApi.credentials.js

@@ -3,41 +3,54 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GigstackApi = void 0;
 class GigstackApi {
     constructor() {
-        this.name = "gigstackApi";
-        this.displayName = "Gigstack API";
-        this.documentationUrl = "https://github.com/disruptive-learning/gigstack_n8n/blob/main/README.md#credentials";
+        this.name = 'gigstackApi';
+        this.displayName = 'Gigstack API';
+        this.documentationUrl = 'https://docs.gigstack.io';
         this.properties = [
             {
-                displayName: "API Key",
-                name: "apiKey",
-                type: "string",
+                displayName: 'API Token',
+                name: 'apiToken',
+                type: 'string',
                 typeOptions: {
                     password: true,
                 },
-                default: "",
+                default: '',
+                required: true,
+                description: 'Your Gigstack API token. Get it from <a href="https://app.gigstack.pro/settings?tab=api" target="_blank">app.gigstack.pro/settings</a>',
             },
             {
-                displayName: "Environment",
-                name: "environment",
-                type: "options",
+                displayName: 'Environment',
+                name: 'environment',
+                type: 'options',
                 options: [
                     {
-                        name: "Production",
-                        value: "production",
+                        name: 'Production',
+                        value: 'production',
                     },
                     {
-                        name: "Sandbox",
-                        value: "sandbox",
+                        name: 'Test',
+                        value: 'test',
                     },
                 ],
-                default: "production",
+                default: 'production',
+                description: 'The environment to use. Test mode uses test data and does not create real invoices.',
             },
         ];
         this.authenticate = {
-            type: "generic",
+            type: 'generic',
             properties: {
                 headers: {
-                    Authorization: "=Bearer {{$credentials.apiKey}}",
+                    Authorization: '=Bearer {{$credentials.apiToken}}',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: 'https://api.gigstack.io/v2',
+                url: '/teams',
+                method: 'GET',
+                qs: {
+                    limit: 1,
                 },
             },
         };

package/dist/nodes/Gigstack/GenericFunctions.d.ts

@@ -0,0 +1,5 @@
+import type { IDataObject, IExecuteFunctions, IHookFunctions, IHttpRequestMethods, ILoadOptionsFunctions } from 'n8n-workflow';
+export declare function gigstackApiRequest(this: IExecuteFunctions | ILoadOptionsFunctions | IHookFunctions, method: IHttpRequestMethods, endpoint: string, body?: IDataObject, qs?: IDataObject): Promise<IDataObject>;
+export declare function gigstackApiRequestAllItems(this: IExecuteFunctions | ILoadOptionsFunctions, method: IHttpRequestMethods, endpoint: string, body?: IDataObject, qs?: IDataObject, limit?: number): Promise<IDataObject[]>;
+export declare function simplifyResponse(response: IDataObject): IDataObject;
+export declare function buildFilterQuery(filters: IDataObject): IDataObject;

package/dist/nodes/Gigstack/GenericFunctions.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gigstackApiRequest = gigstackApiRequest;
+exports.gigstackApiRequestAllItems = gigstackApiRequestAllItems;
+exports.simplifyResponse = simplifyResponse;
+exports.buildFilterQuery = buildFilterQuery;
+const n8n_workflow_1 = require("n8n-workflow");
+async function gigstackApiRequest(method, endpoint, body = {}, qs = {}) {
+    const options = {
+        method,
+        body,
+        qs,
+        url: `https://api.gigstack.io/v2${endpoint}`,
+        json: true,
+    };
+    if (Object.keys(body).length === 0) {
+        delete options.body;
+    }
+    if (Object.keys(qs).length === 0) {
+        delete options.qs;
+    }
+    try {
+        const response = await this.helpers.httpRequestWithAuthentication.call(this, 'gigstackApi', options);
+        return response;
+    }
+    catch (error) {
+        throw new n8n_workflow_1.NodeApiError(this.getNode(), error);
+    }
+}
+async function gigstackApiRequestAllItems(method, endpoint, body = {}, qs = {}, limit) {
+    const returnData = [];
+    let responseData;
+    let nextCursor;
+    qs.limit = qs.limit || 100;
+    do {
+        if (nextCursor) {
+            qs.next = nextCursor;
+        }
+        responseData = await gigstackApiRequest.call(this, method, endpoint, body, qs);
+        const data = responseData.data;
+        if (data) {
+            returnData.push(...data);
+        }
+        nextCursor = responseData.next;
+        if (limit && returnData.length >= limit) {
+            return returnData.slice(0, limit);
+        }
+    } while (responseData.has_more === true && nextCursor);
+    return returnData;
+}
+function simplifyResponse(response) {
+    if (response.data !== undefined) {
+        return response.data;
+    }
+    return response;
+}
+function buildFilterQuery(filters) {
+    const qs = {};
+    if (filters.limit) {
+        qs.limit = filters.limit;
+    }
+    if (filters.orderBy) {
+        qs.order_by = filters.orderBy;
+    }
+    if (filters.sort) {
+        qs.sort = filters.sort;
+    }
+    if (filters.team) {
+        qs.team = filters.team;
+    }
+    if (filters.createdAfter) {
+        qs['created[gte]'] = Math.floor(new Date(filters.createdAfter).getTime() / 1000);
+    }
+    if (filters.createdBefore) {
+        qs['created[lte]'] = Math.floor(new Date(filters.createdBefore).getTime() / 1000);
+    }
+    return qs;
+}

package/dist/nodes/{Gigstack.node.d.ts → Gigstack/Gigstack.node.d.ts}

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