@exado/n8n-nodes-exado 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Exado
+
+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,132 @@
+# @exado/n8n-nodes-exado
+
+n8n community node for the Exado AI API — RAG chat, OpenAI-compatible completions/embeddings, document ingestion, conversations, FAQ.
+
+## Installation
+
+### From the n8n UI (recommended)
+
+Self-hosted n8n only — n8n Cloud does not yet support community nodes installed at runtime.
+
+1. Make sure `N8N_COMMUNITY_PACKAGES_ENABLED=true` is set on the n8n container (it is by default in recent n8n versions).
+2. Open n8n → **Settings → Community Nodes → Install**.
+3. Enter the package name:
+
+   ```
+   @exado/n8n-nodes-exado
+   ```
+
+4. Tick "I understand the risks" → Install. The `Exado` and `Exado Trigger` nodes appear in the palette after ~30s.
+
+### Manually (CLI)
+
+```bash
+cd ~/.n8n/custom        # or wherever your n8n custom dir is
+npm install @exado/n8n-nodes-exado
+# then restart n8n
+```
+
+### Local development (npm link)
+
+```bash
+git clone https://github.com/vado-innovation-tech/n8n-nodes-exado.git
+cd n8n-nodes-exado
+npm install && npm run build
+npm link
+
+cd ~/.n8n/custom
+npm link @exado/n8n-nodes-exado
+```
+
+## Credentials
+
+Two pieces of information are needed:
+
+1. **Base URL** — the root of your Exado API, e.g. `https://api.exado.example.com`. No trailing slash.
+2. **API Key** — a long-lived key with the `exado_` prefix.
+
+To issue a key:
+
+1. Log into the Exado web UI as any user that owns the workflows you want to drive.
+2. Open **Settings → API Keys** (or call `POST /api/admin/api-keys` once with a Keycloak JWT).
+3. Copy the generated key the moment it is shown — it cannot be retrieved later.
+
+> The server's `UnifiedAuth` dependency accepts the same `exado_` key on both the public OpenAI-compat surface and the internal endpoints. One credential covers every operation this node exposes.
+
+After saving the credential, click **Test** — the node hits `GET /api/users/me` and returns the key owner.
+
+## Supported resources & operations
+
+| Resource | Operations |
+| --- | --- |
+| **Chat** | Send Message (streaming or non-streaming) |
+| **Chat Completion** | Create Chat Completion, Create Completion (both streaming) |
+| **Embedding** | Create |
+| **Model** | List Available, List OpenAI-Compatible |
+| **Document** | Upload (Async), Upload (Sync), Get, Get Content, Get Status, Get Many, Update, Delete, Bulk Delete, Translate, Get Translation Status, Get Translation Result |
+| **Conversation** | Get Many, Get, Ask (streaming), Get Status, Cancel Generation |
+| **Conversation Config** | Create, Get Many |
+| **Conversation Template** | Create, Create Conversation From Template |
+| **Metadata** | Create, Get, Get Many, Update, Delete, Pending Status, Generate |
+| **Folder** | Create, List Children, Rename |
+| **Group** | Get Many, Get |
+| **FAQ Topic** | Create, Get, Get Many, Update, Delete |
+| **Quick** | Quick Ask |
+
+## Trigger node
+
+`Exado Trigger` is a polling trigger with four modes:
+
+- **Document Ingestion Complete** — emits when a previously unseen document reaches `status: "success"`.
+- **Translation Complete** — emits when a translation transitions to `completed`.
+- **New Conversation** — emits for each new conversation visible to the API key.
+- **New FAQ Topic** — emits for each new FAQ topic.
+
+The first poll silently primes dedupe state, so the workflow does not flood-fire on existing items. Subsequent polls emit only what is new. In *Test Step* (manual) mode the trigger ignores dedupe state and emits the latest items so you can wire downstream nodes.
+
+## Streaming usage
+
+For Chat, Chat Completion, and Conversation → Ask, set **Stream Response** to true. By default the node consumes the full SSE stream and returns a single item:
+
+```json
+{
+  "content": "Hello, world!",
+  "chunks": 12,
+  "model": "gpt-4o-mini",
+  "finishReason": "stop"
+}
+```
+
+Toggle **Emit Each Chunk** to produce one output item per parsed frame. This is useful for live-streaming downstream consumers but breaks single-item nodes like Set / Merge.
+
+Mid-stream `[ERROR]` frames are surfaced as `NodeApiError`, with the partial buffered content attached on the error context.
+
+## Document upload example
+
+1. Add a **Read Binary File** (or any node that produces a binary item with `binary.data`).
+2. Wire it into an **Exado** node configured as Resource = Document, Operation = Upload (Async).
+3. In the node's Options, set Folder Path and Parsing Mode as desired.
+4. Downstream, poll **Get Status** until `status === "success"` (or use the **Exado Trigger** with mode = Document Ingestion Complete).
+
+## Known limitations
+
+- Exado does not emit `Retry-After` or `X-RateLimit-*` headers — failed requests surface as `NodeApiError` with the raw HTTP status.
+- `Upload (Sync)` may exceed n8n's request timeout on large PDFs. Prefer `Upload (Async)` + status polling.
+- The buffered streaming mode loads the full response into memory before returning. For very long completions use `Emit Each Chunk`.
+- `loadOptions` dropdowns for models / groups / folders cache the first page (up to 100 items). For larger libraries enter the ID manually.
+
+## Development
+
+```bash
+npm install
+npm run dev        # tsc --watch
+npm test           # jest
+npm run lint
+npm run build      # tsc + gulp icons
+```
+
+Tests use Jest with `ts-jest`. The HTTP layer is mocked at `this.helpers.httpRequestWithAuthentication` — see `tests/resources/chat.test.ts` for the standard stub.
+
+## License
+
+MIT — see [LICENSE](./LICENSE).

package/dist/credentials/ExadoApi.credentials.d.ts

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

package/dist/credentials/ExadoApi.credentials.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExadoApi = void 0;
+class ExadoApi {
+    constructor() {
+        this.name = 'exadoApi';
+        this.displayName = 'Exado API';
+        this.documentationUrl = 'https://github.com/vado-innovation-tech/n8n-nodes-exado';
+        this.properties = [
+            {
+                displayName: 'Base URL',
+                name: 'baseUrl',
+                type: 'string',
+                default: 'http://localhost:8000',
+                placeholder: 'https://api.exado.example.com',
+                description: 'Root URL of the Exado API. Do not include a trailing slash; the node prepends "/api" internally.',
+                required: true,
+            },
+            {
+                displayName: 'API Key',
+                name: 'apiKey',
+                type: 'string',
+                typeOptions: { password: true },
+                default: '',
+                placeholder: 'exado_…',
+                description: 'Issue keys from the Exado admin UI or via POST /api/admin/api-keys. Keys are long-lived; rotate them by deactivating in the admin UI.',
+                required: true,
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    'X-API-Key': '={{ $credentials.apiKey }}',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: '={{ $credentials.baseUrl.replace(/\\/$/, "") }}',
+                url: '/api/users/me',
+                method: 'GET',
+            },
+        };
+    }
+}
+exports.ExadoApi = ExadoApi;
+//# sourceMappingURL=ExadoApi.credentials.js.map

package/dist/credentials/ExadoApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExadoApi.credentials.js","sourceRoot":"","sources":["../../credentials/ExadoApi.credentials.ts"],"names":[],"mappings":";;;AAeA,MAAa,QAAQ;IAArB;QACC,SAAI,GAAG,UAAU,CAAC;QAElB,gBAAW,GAAG,WAAW,CAAC;QAG1B,qBAAgB,GAAG,yDAAyD,CAAC;QAE7E,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,uBAAuB;gBAChC,WAAW,EAAE,+BAA+B;gBAC5C,WAAW,EACV,kGAAkG;gBACnG,QAAQ,EAAE,IAAI;aACd;YACD;gBACC,WAAW,EAAE,SAAS;gBACtB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;gBAC/B,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,SAAS;gBACtB,WAAW,EACV,uIAAuI;gBACxI,QAAQ,EAAE,IAAI;aACd;SACD,CAAC;QAEF,iBAAY,GAAyB;YACpC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACX,OAAO,EAAE;oBACR,WAAW,EAAE,4BAA4B;iBACzC;aACD;SACD,CAAC;QAEF,SAAI,GAA2B;YAC9B,OAAO,EAAE;gBACR,OAAO,EAAE,iDAAiD;gBAC1D,GAAG,EAAE,eAAe;gBACpB,MAAM,EAAE,KAAK;aACb;SACD,CAAC;IACH,CAAC;CAAA;AAhDD,4BAgDC"}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,17 @@
+import type { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+import { getConversationConfigs, getDocuments, getFolders, getGroups, getMetadatas, getModels, getOpenAiModels } from './methods/loadOptions';
+export declare class Exado implements INodeType {
+    description: INodeTypeDescription;
+    methods: {
+        loadOptions: {
+            getModels: typeof getModels;
+            getOpenAiModels: typeof getOpenAiModels;
+            getGroups: typeof getGroups;
+            getConversationConfigs: typeof getConversationConfigs;
+            getMetadatas: typeof getMetadatas;
+            getDocuments: typeof getDocuments;
+            getFolders: typeof getFolders;
+        };
+    };
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}