@taifoon/n8n-nodes-typesafe 0.1.0 → 1.0.0

package/docs/KEY_POLICY.md

@@ -1,58 +1,21 @@
 # Key policy and rotation
 
-**Direct connection (the default): one secret.** Your TypeSafe key lives in n8n's encrypted credential store and is sent as a bearer token to `api.typesafe.ai` over TLS. Nobody else is in the path. Rotate it in TypeSafe's console and paste the new value into the credential; that is the whole procedure. Everything below concerns the OPTIONAL Taifoon gateway connection.
+This node uses **one secret: your TypeSafe API key.**
 
-Three secrets exist in the gateway system. This page says where each one lives, who can see it, how it is
-rotated, and what happens when one leaks. The node itself holds none of them outside n8n's
-encrypted credential store.
+| | |
+|---|---|
+| Where it lives | n8n's credential store, encrypted at rest with your instance's `N8N_ENCRYPTION_KEY` |
+| Where it travels | from your n8n to `api.typesafe.ai`, as a bearer token over TLS. Nobody else is in the path |
+| Where it never goes | workflow JSON, expressions, logs, execution records (HTTP errors are reduced to a status and the service's message, with key-shaped strings redacted, before n8n stores them), or to Taifoon |
 
-| Secret | Owner | Lives | Never |
-|---|---|---|---|
-| **Taifoon principal key** (`tfn_live_…`) | you | n8n credential store (encrypted at rest with your instance's `N8N_ENCRYPTION_KEY`) | in a workflow JSON, an expression, a log, or git |
-| **Your TypeSafe key** | you | n8n credential store; sent per request over TLS in `x-typesafe-key` | stored, logged or echoed by Taifoon. It exists on the deck for the duration of one call |
-| **The house TypeSafe key** | Taifoon | the deck's 0600 env file on the production host | sent to any browser, node or client. It funds each principal's three trial calls and nothing else |
+**Rotate** it in TypeSafe's console and paste the new value into the credential. Do it on a schedule
+(90 days is a reasonable default) and at once if a teammate leaves, a screenshot or log may have shown
+it, or a credential test ran on a machine you do not control.
 
-## What crosses the wire
+**The Free Trial connection uses no secret of yours.** It sends the item and your questions to
+`typesafe.taifoon.dev`, which asks TypeSafe with Taifoon's key: three calls per client, up to 4
+questions and 4,000 characters each. Taifoon logs the outcome, the country and the client type, and a
+salted hash that lets it count clients. It does not log your address, your item or your questions.
+Do not send personal data through the trial; use your own key for real work.
 
-`POST /api/login {key}` exchanges the principal key for an httpOnly, Secure, SameSite=Lax session
-cookie valid for 12 hours. n8n caches that session as an expirable token and logs in again when it is
-refused. Every later request carries the cookie and, only for `model: "jev"` after the trial, your
-TypeSafe key in one header. Responses never contain a key; the deck's log lines (call and billing)
-carry latency, tokens, USD and outcome, and never a key or your state.
-
-## Rotation
-
-**Your TypeSafe key.** Rotate it in TypeSafe's console, paste the new value into the n8n credential,
-save. Nothing on Taifoon's side needs updating, because Taifoon never stored the old one. Rotate on a
-schedule you would use for any vendor key (90 days is a reasonable default) and immediately on any of:
-a teammate leaving, a workflow export shared outside your team, a credential test run on a machine
-you do not control.
-
-**Your Taifoon principal key.** Ask the operator to rotate it (`POST /agents/<id>/rotate-key` at the
-identity door). The old key stops working at once; existing 12-hour sessions made with it expire on
-their own and can be cut short by the operator. Update the n8n credential. Your licence, trial count
-and spend ledger are attached to your principal, not to the key string, so they survive rotation.
-
-**The house key.** Taifoon's to rotate: replace it in the deck's env file and restart the deck. Trial
-calls pause for the length of the restart. No user action is needed.
-
-## If a key leaks
-
-| Leaked | Blast radius | Do this |
-|---|---|---|
-| your TypeSafe key | spend on YOUR TypeSafe quota, by anyone, until rotated | rotate in TypeSafe's console now; review their usage page |
-| your Taifoon key | calls billed to your Taifoon key up to its DAILY token ceiling; your three trial calls; read access to the deck as you | ask the operator to rotate; the ceiling bounds the damage per day |
-| the house key | Taifoon's TypeSafe quota | Taifoon rotates; trial calls resume after |
-
-A Taifoon key cannot be used to read anyone's TypeSafe key: the deck has none to read.
-
-## Policy the deck enforces, so you do not have to trust the node
-
-- The first **three** `jev` calls a principal ever makes are funded by Taifoon. The count is per
-  principal, persisted, and a call that fails upstream is handed back.
-- After that, a `jev` call needs **both** the `jev` licence on your principal's grant and your own
-  TypeSafe key. A missing piece is a `402` that names it. There is no silent fallback to the house key.
-- Every call is metered per key **and** per model, persisted across restarts, against a daily ceiling.
-- Login throttles: ten refused keys in five minutes from one address rests the door for that window.
-- An answer that does not validate is never repaired or defaulted; with **Fail Closed** on (the
-  default) the node stops the item instead of passing a null downstream.
+Provisioning a key for a team without anyone seeing it: [Supplying keys securely](SECURE_KEYS.md).

package/docs/SECURE_KEYS.md

@@ -39,8 +39,6 @@ The `_FILE` suffix works on any n8n setting and exists precisely so secrets stay
 variables, which leak into `docker inspect`, process listings, crash dumps and CI logs. On Kubernetes,
 mount a `Secret` at the same paths.
 
-For the optional Taifoon gateway the type name is `taifoonGatewayApi`
-(`{"taifoonGatewayApi":{"deckUrl":"https://deck.taifoon.dev","principalKey":"…","typesafeKey":"…"}}`).
 
 ## 3 · A vault (n8n Enterprise)
 
@@ -58,9 +56,8 @@ and gain nothing.
 
 ## Never send us a key
 
-You do not need to give Taifoon a TypeSafe key, ever. On the direct connection we are not in the path.
-On the optional gateway connection your key travels per request over TLS in one header, is used for
-that call, and is never stored, logged or echoed. There is deliberately no form, email address or chat
+You do not need to give Taifoon a TypeSafe key, ever. On the direct connection we are not in the path,
+and the free trial uses our key, not yours. There is deliberately no form, email address or chat
 where we accept keys. If anyone asks you for one in our name, it is not us.
 
 If two organisations ever must hand a secret to each other, do it with public-key encryption to the

package/docs/TRANSLATION.md

@@ -49,5 +49,4 @@ threshold on your own labelled items, and leave a question unrouted until you ha
 
 With `jev`, state is any JSON up to 96,000 characters: `{{ JSON.stringify($json) }}` sends the whole
 incoming item. Compute first, judge second: do arithmetic in a Code node and send the result; ask the
-model for judgment, never for a sum. House models (`algotrada`, `auditor`) need a flat object of
-numbers and short symbols, answer noul and choice only, and return an uncalibrated boolean.
+model for judgment, never for a sum.

package/docs/WORKFLOWS.md

@@ -19,12 +19,9 @@ The importable example is `examples/typed-gate.workflow.json`.
 
 ## Operating notes
 
-- **Latency.** Jev answers a 4 to 8 question battery in 0.3 to 0.8 s. `auditor` takes about a minute.
-  The edge cuts any request at 100 s.
+- **Latency.** Jev answers a 4 to 8 question battery in 0.3 to 0.8 s. 
 - **Cost.** About 450 to 550 input tokens per battery, 0.00002 USD on Jev. Output is free.
 - **Retries.** A `503` means the lane is unavailable and nothing was charged; n8n's *Retry On Fail*
   with backoff is the right response. A `402` is not retryable: it names what is missing.
-- **Observability.** Use **List Lanes** on a schedule to alert on trial exhaustion, spend against the
-  daily ceiling, and lane health. The deck logs every call and every charge on its own side.
 - **Batching.** One item is one request. For many items, keep n8n's batching on and the deck's daily
   ceiling in mind; TypeSafe allows 1,200 requests a minute.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taifoon/n8n-nodes-typesafe",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "TypeSafe for n8n: ask Jev (a System One model) yes/no, pick-one and rate-it questions about any workflow item and route on calibrated answers. Works directly with your own TypeSafe key; includes a task-to-questions translator and Pass / Fail / Review outputs.",
   "keywords": [
     "n8n-community-node-package",
@@ -17,6 +17,7 @@
   "homepage": "https://github.com/taifoon-io/n8n-nodes-typesafe#readme",
   "author": {
     "name": "Taifoon",
+    "email": "226868200+yawningmonsoon@users.noreply.github.com",
     "url": "https://github.com/taifoon-io"
   },
   "repository": {
@@ -45,15 +46,14 @@
     "n8nNodesApiVersion": 1,
     "strict": true,
     "credentials": [
-      "dist/credentials/TypeSafeApi.credentials.js",
-      "dist/credentials/TaifoonGatewayApi.credentials.js"
+      "dist/credentials/TypeSafeApi.credentials.js"
     ],
     "nodes": [
       "dist/nodes/TaifoonTypeSafe/TaifoonTypeSafe.node.js"
     ]
   },
   "devDependencies": {
-    "@n8n/node-cli": "^0.23.0",
+    "@n8n/node-cli": "^0.48.6",
     "eslint": "^9.39.5",
     "typescript": "5.9.2"
   },

package/dist/credentials/TaifoonGatewayApi.credentials.d.ts

@@ -1,13 +0,0 @@
-import type { IAuthenticateGeneric, ICredentialDataDecryptedObject, ICredentialTestRequest, ICredentialType, IHttpRequestHelper, INodeProperties } from 'n8n-workflow';
-export declare class TaifoonGatewayApi implements ICredentialType {
-    name: string;
-    displayName: string;
-    icon: "file:taifoon.svg";
-    documentationUrl: string;
-    properties: INodeProperties[];
-    preAuthentication(this: IHttpRequestHelper, credentials: ICredentialDataDecryptedObject): Promise<{
-        sessionToken: string;
-    }>;
-    authenticate: IAuthenticateGeneric;
-    test: ICredentialTestRequest;
-}

package/dist/credentials/TaifoonGatewayApi.credentials.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TaifoonGatewayApi = void 0;
-class TaifoonGatewayApi {
-    constructor() {
-        this.name = 'taifoonGatewayApi';
-        this.displayName = 'Taifoon Gateway API';
-        this.icon = 'file:taifoon.svg';
-        this.documentationUrl = 'https://deck.taifoon.dev';
-        this.properties = [
-            { displayName: 'Session', name: 'sessionToken', type: 'hidden', typeOptions: { expirable: true, password: true }, default: '' },
-            { displayName: 'Deck URL', name: 'deckUrl', type: 'string', default: 'https://deck.taifoon.dev', description: 'The Taifoon deck that fronts the typed-decision lanes' },
-            { displayName: 'Taifoon Principal Key', name: 'principalKey', type: 'string', typeOptions: { password: true }, default: '', required: true, description: 'Your tfn_live_ key. It identifies you, carries your licence and is what usage is billed to.' },
-            { displayName: 'TypeSafe API Key (Optional)', name: 'typesafeKey', type: 'string', typeOptions: { password: true }, default: '', description: 'Your own key from console.typesafe.ai. Leave empty to use the free trial pings. Needs the jev licence on your Taifoon key.' },
-        ];
-        this.authenticate = {
-            type: 'generic',
-            properties: { headers: { Cookie: '={{$credentials.sessionToken}}', 'x-typesafe-key': '={{$credentials.typesafeKey || undefined}}' } },
-        };
-        this.test = { request: { baseURL: '={{$credentials.deckUrl}}', url: '/api/typed', method: 'GET' } };
-    }
-    async preAuthentication(credentials) {
-        const base = String(credentials.deckUrl || 'https://deck.taifoon.dev').replace(/\/$/, '');
-        const res = (await this.helpers.httpRequest({ method: 'POST', url: `${base}/api/login`, body: { key: credentials.principalKey }, json: true, returnFullResponse: true }));
-        const raw = res.headers['set-cookie'];
-        const cookie = (Array.isArray(raw) ? raw : [String(raw !== null && raw !== void 0 ? raw : '')]).map((c) => String(c).split(';')[0]).filter(Boolean).join('; ');
-        return { sessionToken: cookie };
-    }
-}
-exports.TaifoonGatewayApi = TaifoonGatewayApi;
-//# sourceMappingURL=TaifoonGatewayApi.credentials.js.map

package/dist/credentials/TaifoonGatewayApi.credentials.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"TaifoonGatewayApi.credentials.js","sourceRoot":"","sources":["../../credentials/TaifoonGatewayApi.credentials.ts"],"names":[],"mappings":";;;AAgBA,MAAa,iBAAiB;IAA9B;QACC,SAAI,GAAG,mBAAmB,CAAC;QAE3B,gBAAW,GAAG,qBAAqB,CAAC;QAEpC,SAAI,GAAG,kBAA2B,CAAC;QAEnC,qBAAgB,GAAG,0BAA0B,CAAC;QAE9C,eAAU,GAAsB;YAC/B,EAAE,WAAW,EAAE,SAAS,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;YAC/H,EAAE,WAAW,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,0BAA0B,EAAE,WAAW,EAAE,uDAAuD,EAAE;YACvK,EAAE,WAAW,EAAE,uBAAuB,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,6FAA6F,EAAE;YACxP,EAAE,WAAW,EAAE,6BAA6B,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,WAAW,EAAE,4HAA4H,EAAE;SAC5Q,CAAC;QAUF,iBAAY,GAAyB;YACpC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,gCAAgC,EAAE,gBAAgB,EAAE,4CAA4C,EAAE,EAAE;SACrI,CAAC;QAEF,SAAI,GAA2B,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,2BAA2B,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;IACxH,CAAC;IAdA,KAAK,CAAC,iBAAiB,CAA2B,WAA2C;QAC5F,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,OAAO,IAAI,0BAA0B,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC1F,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,YAAY,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,WAAW,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,CAAC,CAA+D,CAAC;QACxO,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACtC,MAAM,MAAM,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/H,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC;IACjC,CAAC;CAQD;AA9BD,8CA8BC"}