n8n-nodes-datatable-variables 1.0.0

package/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright 2022 n8n
+
+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,123 @@
+# n8n-nodes-datatable-variables
+
+This is an n8n community node package that enables users to create local tables and store variables within them. It runs entirely locally on your host or container, without requiring any external database servers or cloud service setups. 
+
+With this node, you can easily cache, share, and persist variables between workflow runs, execution iterations, or different paths in a workflow.
+
+---
+
+## Key Features
+
+- **Local Storage**: Persists data inside `~/.n8n/n8n-nodes-datatable-variables.json`.
+- **Concurrency & Thread Safety**: Uses a self-healing `.lock` file (with PID tracking and a 5-second automatic expiration timeout) and atomic file writes (via temporary file swap) to ensure data safety when multiple executions modify tables simultaneously.
+- **Rich Data Types Support**: Supports Text, Numbers, Booleans, Dates, parsed JSON objects, and Binary files.
+- **Change Log Polling Trigger**: A trigger node that watches for table updates and fires workflows based on changes (for all variables, a specific key, or multiple keys).
+- **Import/Export**: Easily backup or restore tables as binary JSON files or raw JSON objects.
+
+---
+
+## Directory Structure
+
+```text
+n8n-nodes-datatable-variables/
+├── icons/
+│   ├── datatable.svg                  # Icon for the main node
+│   ├── datatable-trigger.svg          # Icon for the trigger node
+│   └── datatable-import-export.svg    # Icon for the import/export node
+├── nodes/
+│   └── DatatableVariables/
+│       ├── db.ts                      # Local database driver (locks, writes, changes)
+│       ├── DatatableVariables.node.ts # Main node logic (CRUD operations)
+│       ├── DatatableVariablesTrigger.node.ts # Polling trigger node
+│       └── DatatableVariablesImportExport.node.ts # Data backup and restore node
+├── package.json                       # Package configurations and scripts
+└── tsconfig.json                      # TypeScript configuration
+```
+
+---
+
+## Available Nodes & Operations
+
+### 1. Datatable Variables (Main Node)
+
+Acts as a local key-value datatable store.
+
+#### Resource: Variable
+- **Set**: Save or update a variable.
+  - Supports inline table creation if the table doesn't exist yet via `[+ Create New Table...]`.
+  - Type-safe inputs: Text, Number, Boolean, JSON, Date, and Binary files (binary files are read from the incoming item and stored inside the database as Base64 strings along with filename and mimeType).
+- **Get**: Load a variable from a table.
+  - If it is a binary file, it will reconstruct the file buffer and output it as a binary property on the n8n execution item.
+- **Delete**: Delete a variable key from a table.
+- **Get All**: Retrieve all variables in a table as a key-value object (binary files return file metadata).
+
+#### Resource: Table
+- **List**: List all tables in your local database along with their variable count.
+- **Delete**: Delete a table and all variables within it.
+
+---
+
+### 2. Datatable Variables Trigger
+
+Polls the local database change-log and triggers workflows when updates occur.
+
+- **Table Name**: Choose which table to watch.
+- **Trigger On**:
+  - `All Changes in the Table`: Fires on any variable insert, update, or deletion.
+  - `Specific Variable`: Fires only when a specific key is updated.
+  - `Multiple Variables`: Fires when any key in a defined list is updated.
+- **State Tracking**: Uses n8n workflow static data (`node` scope) to track the processed change IDs. It automatically initializes to the latest change ID when activated, ensuring that workflows only fire on new changes.
+
+---
+
+### 3. Datatable Variables Import/Export
+
+Lets you download or restore your datatable variables easily.
+
+- **Export**: Export a single table or all tables. Output format can be:
+  - `JSON File (Binary)`: Generates a downloadable `.json` file.
+  - `JSON Output`: Outputs the raw JSON structure directly on the execution node.
+- **Import**: Reads a backup file or a raw JSON string.
+  - **Modes**: Choose `Merge` (insert/overwrite keys) or `Replace` (wipes the database first and loads the new content).
+
+---
+
+## Installation
+
+### Community Node Install (Standard)
+
+Refer to the official [n8n Community Nodes Installation Guide](https://docs.n8n.io/integrations/community-nodes/installation/) to install this package in your n8n instance using:
+
+```text
+n8n-nodes-datatable-variables
+```
+
+### Local Development Setup
+
+To link and run this node locally for testing:
+
+1. **Build & Link the Node**:
+   ```bash
+   cd /path/to/n8n-nodes-datatable-variables
+   npm install
+   npm run build
+   npm link
+   ```
+
+2. **Mount in your local n8n installation**:
+   Navigate to your local n8n folder (usually `~/.n8n/`):
+   ```bash
+   cd ~/.n8n
+   mkdir nodes
+   cd nodes
+   npm link n8n-nodes-datatable-variables
+   ```
+
+3. **Restart n8n**:
+   Restart your n8n server, and the new nodes will appear in your workflow editor.
+
+---
+
+## License
+
+[MIT](LICENSE.md)

package/dist/credentials/GithubIssuesApi.credentials.d.ts

@@ -0,0 +1,10 @@
+import type { IAuthenticateGeneric, Icon, ICredentialTestRequest, ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class GithubIssuesApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    icon: Icon;
+    documentationUrl: string;
+    properties: INodeProperties[];
+    authenticate: IAuthenticateGeneric;
+    test: ICredentialTestRequest;
+}

package/dist/credentials/GithubIssuesApi.credentials.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GithubIssuesApi = void 0;
+class GithubIssuesApi {
+    constructor() {
+        this.name = 'githubIssuesApi';
+        this.displayName = 'GitHub Issues API';
+        this.icon = { light: 'file:../icons/github.svg', dark: 'file:../icons/github.dark.svg' };
+        this.documentationUrl = 'https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#deleting-a-personal-access-token';
+        this.properties = [
+            {
+                displayName: 'Access Token',
+                name: 'accessToken',
+                type: 'string',
+                typeOptions: { password: true },
+                default: '',
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    Authorization: '=token {{$credentials?.accessToken}}',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: 'https://api.github.com',
+                url: '/user',
+                method: 'GET',
+            },
+        };
+    }
+}
+exports.GithubIssuesApi = GithubIssuesApi;
+//# sourceMappingURL=GithubIssuesApi.credentials.js.map

package/dist/credentials/GithubIssuesApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GithubIssuesApi.credentials.js","sourceRoot":"","sources":["../../credentials/GithubIssuesApi.credentials.ts"],"names":[],"mappings":";;;AAQA,MAAa,eAAe;IAA5B;QACC,SAAI,GAAG,iBAAiB,CAAC;QAEzB,gBAAW,GAAG,mBAAmB,CAAC;QAElC,SAAI,GAAS,EAAE,KAAK,EAAE,0BAA0B,EAAE,IAAI,EAAE,+BAA+B,EAAE,CAAC;QAE1F,qBAAgB,GACf,sJAAsJ,CAAC;QAExJ,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,cAAc;gBAC3B,IAAI,EAAE,aAAa;gBACnB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;gBAC/B,OAAO,EAAE,EAAE;aACX;SACD,CAAC;QAEF,iBAAY,GAAyB;YACpC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACX,OAAO,EAAE;oBACR,aAAa,EAAE,sCAAsC;iBACrD;aACD;SACD,CAAC;QAEF,SAAI,GAA2B;YAC9B,OAAO,EAAE;gBACR,OAAO,EAAE,wBAAwB;gBACjC,GAAG,EAAE,OAAO;gBACZ,MAAM,EAAE,KAAK;aACb;SACD,CAAC;IACH,CAAC;CAAA;AApCD,0CAoCC"}

package/dist/credentials/GithubIssuesOAuth2Api.credentials.d.ts

@@ -0,0 +1,9 @@
+import type { Icon, ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class GithubIssuesOAuth2Api implements ICredentialType {
+    name: string;
+    extends: string[];
+    displayName: string;
+    icon: Icon;
+    documentationUrl: string;
+    properties: INodeProperties[];
+}

package/dist/credentials/GithubIssuesOAuth2Api.credentials.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GithubIssuesOAuth2Api = void 0;
+class GithubIssuesOAuth2Api {
+    constructor() {
+        this.name = 'githubIssuesOAuth2Api';
+        this.extends = ['oAuth2Api'];
+        this.displayName = 'GitHub Issues OAuth2 API';
+        this.icon = { light: 'file:../icons/github.svg', dark: 'file:../icons/github.dark.svg' };
+        this.documentationUrl = 'https://docs.github.com/en/apps/oauth-apps';
+        this.properties = [
+            {
+                displayName: 'Grant Type',
+                name: 'grantType',
+                type: 'hidden',
+                default: 'authorizationCode',
+            },
+            {
+                displayName: 'Authorization URL',
+                name: 'authUrl',
+                type: 'hidden',
+                default: 'https://github.com/login/oauth/authorize',
+                required: true,
+            },
+            {
+                displayName: 'Access Token URL',
+                name: 'accessTokenUrl',
+                type: 'hidden',
+                default: 'https://github.com/login/oauth/access_token',
+                required: true,
+            },
+            {
+                displayName: 'Scope',
+                name: 'scope',
+                type: 'hidden',
+                default: 'repo',
+            },
+            {
+                displayName: 'Auth URI Query Parameters',
+                name: 'authQueryParameters',
+                type: 'hidden',
+                default: '',
+            },
+            {
+                displayName: 'Authentication',
+                name: 'authentication',
+                type: 'hidden',
+                default: 'header',
+            },
+        ];
+    }
+}
+exports.GithubIssuesOAuth2Api = GithubIssuesOAuth2Api;
+//# sourceMappingURL=GithubIssuesOAuth2Api.credentials.js.map

package/dist/credentials/GithubIssuesOAuth2Api.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GithubIssuesOAuth2Api.credentials.js","sourceRoot":"","sources":["../../credentials/GithubIssuesOAuth2Api.credentials.ts"],"names":[],"mappings":";;;AAEA,MAAa,qBAAqB;IAAlC;QACC,SAAI,GAAG,uBAAuB,CAAC;QAE/B,YAAO,GAAG,CAAC,WAAW,CAAC,CAAC;QAExB,gBAAW,GAAG,0BAA0B,CAAC;QAEzC,SAAI,GAAS,EAAE,KAAK,EAAE,0BAA0B,EAAE,IAAI,EAAE,+BAA+B,EAAE,CAAC;QAE1F,qBAAgB,GAAG,4CAA4C,CAAC;QAEhE,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,YAAY;gBACzB,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,mBAAmB;aAC5B;YACD;gBACC,WAAW,EAAE,mBAAmB;gBAChC,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,0CAA0C;gBACnD,QAAQ,EAAE,IAAI;aACd;YACD;gBACC,WAAW,EAAE,kBAAkB;gBAC/B,IAAI,EAAE,gBAAgB;gBACtB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,6CAA6C;gBACtD,QAAQ,EAAE,IAAI;aACd;YACD;gBACC,WAAW,EAAE,OAAO;gBACpB,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,MAAM;aACf;YACD;gBACC,WAAW,EAAE,2BAA2B;gBACxC,IAAI,EAAE,qBAAqB;gBAC3B,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;aACX;YACD;gBACC,WAAW,EAAE,gBAAgB;gBAC7B,IAAI,EAAE,gBAAgB;gBACtB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,QAAQ;aACjB;SACD,CAAC;IACH,CAAC;CAAA;AAnDD,sDAmDC"}

package/dist/dist/icons/datatable-import-export.svg

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="100%" height="100%">
+  <rect width="24" height="24" rx="4" fill="#4B0082" opacity="0.1"/>
+  <path d="M4 6c0-1.1.9-2 2-2h12a2 2 0 0 1 2 2v12a2 2 0 0 1-2 2H6a2 2 0 0 1-2-2V6zm2 0v2h12V6H6zm0 4v2h3v-2H6zm5 0v2h7v-2h-7zm-5 4v2h3v-2H6zm5 0v2h7v-2h-7zm-5 4v2h3v-2H6zm5 0v2h7v-2h-7z" fill="#4B0082" opacity="0.5"/>
+  <path d="M15 10l-3-3v2H8v2h4v2zm-6 4l3 3v-2h4v-2h-4v-2z" fill="#4B0082"/>
+</svg>

package/dist/dist/icons/datatable-trigger.svg

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="100%" height="100%">
+  <rect width="24" height="24" rx="4" fill="#FF3366" opacity="0.1"/>
+  <path d="M4 6c0-1.1.9-2 2-2h12a2 2 0 0 1 2 2v12a2 2 0 0 1-2 2H6a2 2 0 0 1-2-2V6zm2 0v2h12V6H6zm0 4v2h3v-2H6zm5 0v2h7v-2h-7zm-5 4v2h3v-2H6zm5 0v2h7v-2h-7zm-5 4v2h3v-2H6zm5 0v2h7v-2h-7z" fill="#FF3366" opacity="0.5"/>
+  <path d="M12.5 7l-4 6h3v4l4-6h-3z" fill="#FF3366"/>
+</svg>

package/dist/dist/icons/datatable.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="100%" height="100%">
+  <rect width="24" height="24" rx="4" fill="#FF9900" opacity="0.1"/>
+  <path d="M4 6c0-1.1.9-2 2-2h12a2 2 0 0 1 2 2v12a2 2 0 0 1-2 2H6a2 2 0 0 1-2-2V6zm2 0v2h12V6H6zm0 4v2h3v-2H6zm5 0v2h7v-2h-7zm-5 4v2h3v-2H6zm5 0v2h7v-2h-7zm-5 4v2h3v-2H6zm5 0v2h7v-2h-7z" fill="#FF9900"/>
+</svg>

package/dist/icons/datatable-import-export.svg

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="100%" height="100%">
+  <rect width="24" height="24" rx="4" fill="#4B0082" opacity="0.1"/>
+  <path d="M4 6c0-1.1.9-2 2-2h12a2 2 0 0 1 2 2v12a2 2 0 0 1-2 2H6a2 2 0 0 1-2-2V6zm2 0v2h12V6H6zm0 4v2h3v-2H6zm5 0v2h7v-2h-7zm-5 4v2h3v-2H6zm5 0v2h7v-2h-7zm-5 4v2h3v-2H6zm5 0v2h7v-2h-7z" fill="#4B0082" opacity="0.5"/>
+  <path d="M15 10l-3-3v2H8v2h4v2zm-6 4l3 3v-2h4v-2h-4v-2z" fill="#4B0082"/>
+</svg>

package/dist/icons/datatable-trigger.svg

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="100%" height="100%">
+  <rect width="24" height="24" rx="4" fill="#FF3366" opacity="0.1"/>
+  <path d="M4 6c0-1.1.9-2 2-2h12a2 2 0 0 1 2 2v12a2 2 0 0 1-2 2H6a2 2 0 0 1-2-2V6zm2 0v2h12V6H6zm0 4v2h3v-2H6zm5 0v2h7v-2h-7zm-5 4v2h3v-2H6zm5 0v2h7v-2h-7zm-5 4v2h3v-2H6zm5 0v2h7v-2h-7z" fill="#FF3366" opacity="0.5"/>
+  <path d="M12.5 7l-4 6h3v4l4-6h-3z" fill="#FF3366"/>
+</svg>

package/dist/icons/datatable.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="100%" height="100%">
+  <rect width="24" height="24" rx="4" fill="#FF9900" opacity="0.1"/>
+  <path d="M4 6c0-1.1.9-2 2-2h12a2 2 0 0 1 2 2v12a2 2 0 0 1-2 2H6a2 2 0 0 1-2-2V6zm2 0v2h12V6H6zm0 4v2h3v-2H6zm5 0v2h7v-2h-7zm-5 4v2h3v-2H6zm5 0v2h7v-2h-7zm-5 4v2h3v-2H6zm5 0v2h7v-2h-7z" fill="#FF9900"/>
+</svg>

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

@@ -0,0 +1,10 @@
+import { IExecuteFunctions, ILoadOptionsFunctions, INodeExecutionData, INodePropertyOptions, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class DatatableVariables implements INodeType {
+    description: INodeTypeDescription;
+    methods: {
+        loadOptions: {
+            getTables(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+        };
+    };
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}