n8n-nodes-8kit 1.0.0

package/README.md

@@ -0,0 +1,146 @@
+## 8kit n8n Nodes
+
+Community nodes for integrating n8n with the 8kit Open Source API. Use these to build reliable, idempotent workflows: prevent duplicates with Sets, map cross-system IDs with Lookups, read app info/health, and coordinate concurrency with Locks.
+
+For detailed, per-operation docs, see the local docs folder: `./docs`.
+
+### Highlights
+- Set tracking to avoid re-processing
+- Lookup mapping for cross-system IDs
+- Lightweight locks for safe concurrency
+- App info and health endpoints
+
+---
+
+## Operations
+
+All operations live under `nodes/EightKit/operations` and are available from the EightKit node in the n8n UI.
+
+- App
+  - `getAppInfo`
+  - `getAppHealth`
+- Locks
+  - `acquireLock`
+  - `checkLock`
+  - `releaseLock`
+- Sets
+  - `createSet`
+  - `listSets`
+  - `getSetInfo`
+  - `getSetValues`
+  - `addToSet`
+  - `removeFromSet`
+  - `checkSetValues`
+- Lookups
+  - `createLookup`
+  - `listLookups`
+  - `getLookupValues`
+  - `addToLookup`
+  - `removeFromLookup`
+
+Each operation’s usage, parameters, and examples are documented in `./docs` (for example: `./docs/add-to-set.md`, `./docs/check-set-values.md`).
+
+---
+
+## Credentials
+
+Use `EightKitApi` credentials:
+- Host: Base URL of your 8kit API (e.g., `http://localhost:3000`)
+- API Key: From your 8kit app (`X-API-Key` header)
+
+---
+
+## Installation
+
+Option A: Docker (recommended)
+1) Build the nodes
+```bash
+pnpm i && pnpm build
+```
+2) Start n8n with the included compose file
+```bash
+./start-n8n.sh
+```
+
+Option B: Local n8n custom nodes
+1) Build
+```bash
+pnpm i && pnpm build
+```
+2) Copy the dist to your n8n custom nodes directory
+```bash
+cp -r dist ~/.n8n/custom/
+```
+3) Restart n8n
+
+---
+
+## Project Structure
+```
+n8n-node/
+├─ nodes/
+│  └─ EightKit/
+│     ├─ EightKit.node.ts
+│     ├─ operations/
+│     │  ├─ acquireLock.ts
+│     │  ├─ releaseLock.ts
+│     │  ├─ checkLock.ts
+│     │  ├─ getAppInfo.ts
+│     │  ├─ getAppHealth.ts
+│     │  ├─ createSet.ts
+│     │  ├─ listSets.ts
+│     │  ├─ getSetInfo.ts
+│     │  ├─ getSetValues.ts
+│     │  ├─ addToSet.ts
+│     │  ├─ removeFromSet.ts
+│     │  ├─ checkSetValues.ts
+│     │  ├─ createLookup.ts
+│     │  ├─ listLookups.ts
+│     │  ├─ getLookupValues.ts
+│     │  ├─ addToLookup.ts
+│     │  └─ removeFromLookup.ts
+│     └─ utils/
+│        ├─ httpClient.ts
+│        └─ common.ts
+├─ credentials/
+│  └─ EightKitApi.credentials.ts
+├─ docs/
+├─ __tests__/
+└─ package.json
+```
+
+---
+
+## Development
+
+Scripts (use bun or pnpm):
+- `pnpm build` – build the nodes
+- `pnpm dev` – watch mode
+- `pnpm test` – run unit tests
+- `pnpm lint` – lint
+
+Testing focuses on operation executors under `__tests__/operations/*`. See the examples there for mocking `IExecuteFunctions` and HTTP calls.
+
+---
+
+## Examples
+
+Common use cases:
+- Prevent duplicate order processing
+- Maintain ERP ↔ Shopify ID mappings
+- Serialize concurrent jobs with locks
+
+See `./docs` for step-by-step guides and input/output examples for each operation.
+
+---
+
+## License
+
+MIT. See `LICENSE`.
+
+---
+
+## Support
+
+- Issues: open an issue in this repo
+- Docs: local `./docs` directory contains per-operation guides

package/dist/credentials/EightKitApi.credentials.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EightKitApi = void 0;
+class EightKitApi {
+    constructor() {
+        this.name = 'eightKitApi';
+        this.displayName = '8kit API';
+        this.documentationUrl = 'https://github.com/stratagems-com/stratagems-tools-open-source';
+        this.iconUrl = 'file:8kit.svg';
+        this.properties = [
+            {
+                displayName: 'Host URL',
+                name: 'hostUrl',
+                type: 'string',
+                default: 'https://api.yourdomain.com',
+                placeholder: 'https://api.yourdomain.com',
+                description: 'Base URL of your 8kit API instance',
+                required: true,
+            },
+            {
+                displayName: 'API Key',
+                name: 'apiKey',
+                type: 'string',
+                typeOptions: {
+                    password: true,
+                },
+                default: '',
+                placeholder: 'st_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+                description: 'Your application API key (starts with st_)',
+                required: true,
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    'X-Api-Key': '={{$credentials.apiKey}}',
+                    'Content-Type': 'application/json',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: '={{$credentials.hostUrl}}',
+                url: '/api/v1/apps/health',
+                method: 'GET',
+            },
+        };
+    }
+}
+exports.EightKitApi = EightKitApi;
+//# sourceMappingURL=EightKitApi.credentials.js.map

package/dist/credentials/EightKitApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EightKitApi.credentials.js","sourceRoot":"","sources":["../../credentials/EightKitApi.credentials.ts"],"names":[],"mappings":";;;AAOA,MAAa,WAAW;IAAxB;QACE,SAAI,GAAG,aAAa,CAAC;QACrB,gBAAW,GAAG,UAAU,CAAC;QACzB,qBAAgB,GAAG,gEAAgE,CAAC;QACpF,YAAO,GAAG,eAAe,CAAC;QAC1B,eAAU,GAAsB;YAC9B;gBACE,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,4BAA4B;gBACrC,WAAW,EAAE,4BAA4B;gBACzC,WAAW,EAAE,oCAAoC;gBACjD,QAAQ,EAAE,IAAI;aACf;YACD;gBACE,WAAW,EAAE,SAAS;gBACtB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACX,QAAQ,EAAE,IAAI;iBACf;gBACD,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,qCAAqC;gBAClD,WAAW,EAAE,4CAA4C;gBACzD,QAAQ,EAAE,IAAI;aACf;SACF,CAAC;QAEF,iBAAY,GAAyB;YACnC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACV,OAAO,EAAE;oBACP,WAAW,EAAE,0BAA0B;oBACvC,cAAc,EAAE,kBAAkB;iBACnC;aACF;SACF,CAAC;QAEF,SAAI,GAA2B;YAC7B,OAAO,EAAE;gBACP,OAAO,EAAE,2BAA2B;gBACpC,GAAG,EAAE,qBAAqB;gBAC1B,MAAM,EAAE,KAAK;aACd;SACF,CAAC;IACJ,CAAC;CAAA;AA9CD,kCA8CC"}

package/dist/nodes/EightKit/8kit.svg

@@ -0,0 +1 @@
+<svg data-name="Layer 2" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 408.07 192.41"><defs><linearGradient id="a" x1="55.79" y1="103.24" x2="56.33" y2="103.24" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#da3c47"/><stop offset="1" stop-color="#f28336"/></linearGradient><linearGradient id="c" x1="0" y1="96.2" x2="116.77" y2="96.2" xlink:href="#a"/><linearGradient id="b" x1="195.43" y1="189.44" x2="195.43" y2="13.42" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#f09b9e"/><stop offset="1" stop-color="#f5ebe4"/></linearGradient><linearGradient id="d" x1="290.57" x2="290.57" y2="2.74" xlink:href="#b"/><linearGradient id="e" x1="368.71" y1="190.06" x2="368.71" y2="25.08" xlink:href="#b"/><linearGradient id="f" x1="55.79" xlink:href="#a"/></defs><g data-name="Layer 1"><path d="M55.85 103.25c-.17.14.01.1.48-.09-.21-.03-.37 0-.48.09Z" style="fill:url(#a)"/><path d="M72.95.64C19.82-7.42-10.1 62.22 36.14 92.53c-51.55 13.96-46.36 89.62 5.44 98.83 53.42 10.32 85.2-58.53 40.51-91.13C132.92 80.92 126.18 9.31 72.95.64Zm-3.5 117.24c32.58 27.15-6.09 70.55-37.55 46.02-17.73-14.13-13.01-44.09 9.33-50.39 1.15-.48 14.4-5.78 15.15-5.94m-5.45-2.67c.11-.09.28-.12.49-.09-.48.2-.67.24-.49.09Zm44.61-49.16c-1.9 18.04-19.94 23.75-34.73 28.28-12.87-8.2-27.9-17.89-26.12-35.33 5.29-39.83 64.79-32.94 60.85 7.05Z" style="fill:url(#c)"/><path d="m212.79 189.44-44.72-56.13v56.13h-33.3V13.42h33.3v100.14l44.24-55.9h43.29l-58.04 66.12 58.51 65.65h-43.29Z" style="fill:url(#b)"/><path d="M275.94 36.37C257.12 16.79 286.37-8.94 305.2 8.54c18.82 19.59-10.44 45.31-29.26 27.83Zm31.04 21.29v131.77h-33.3V57.66h33.3Z" style="fill:url(#d)"/><path d="M378.58 85.02c1.34 6.98-3.38 69.5 3.21 73.38 4.13 4.58 20.09 2.55 26.29 2.97v28.07c-84.38 7.04-59.04-46.76-63.03-104.42h-15.7V57.67h15.7V25.08h33.54v32.59h29.49v27.35h-29.49Z" style="fill:url(#e)"/><path d="M56.33 103.16c-.47.19-.65.23-.48.09.11-.09.27-.12.48-.09Z" style="fill:url(#f)"/></g></svg>