n8n-nodes-okrunit 0.1.0

package/README.md

@@ -0,0 +1,71 @@
+# n8n-nodes-okrunit
+
+n8n community node for [OKRunit](https://github.com/your-org/okrunit) — a human-in-the-loop approval gateway for AI agents and automation platforms.
+
+## Installation
+
+### Community Node (recommended)
+
+1. In n8n, go to **Settings > Community Nodes**
+2. Enter `n8n-nodes-okrunit`
+3. Click **Install**
+
+### Manual Installation
+
+```bash
+cd ~/.n8n
+npm install n8n-nodes-okrunit
+```
+
+## Credentials
+
+1. In OKRunit, go to **Connections** and create a new API connection
+2. Copy the API key (shown only once)
+3. In n8n, create a new **OKRunit API** credential with:
+   - **API Key**: Your `gk_...` key
+   - **Base URL**: Your OKRunit instance URL
+
+## Operations
+
+### Approval
+
+| Operation | Description |
+|-----------|-------------|
+| **Create** | Submit a new approval request for human review |
+| **Get** | Fetch an approval request by ID |
+| **List** | List/search approval requests with filters |
+
+### Comment
+
+| Operation | Description |
+|-----------|-------------|
+| **Add** | Add a comment to an approval request |
+| **List** | List all comments on an approval request |
+
+### Trigger
+
+| Trigger | Description |
+|---------|-------------|
+| **Approval Decided** | Fires when an approval is approved or rejected (polling) |
+
+## Development
+
+```bash
+cd integrations/n8n
+npm install
+npm run build
+
+# Link to local n8n for testing
+npm link
+cd ~/.n8n
+npm link n8n-nodes-okrunit
+# Restart n8n
+```
+
+## Publishing
+
+```bash
+npm publish
+```
+
+Then submit for verification at the [n8n Creator Portal](https://creators.n8n.io).

package/credentials/GatekeeperApi.credentials.ts

@@ -0,0 +1,44 @@
+import type { ICredentialType, INodeProperties } from "n8n-workflow";
+
+export class GatekeeperApi implements ICredentialType {
+  name = "gatekeeperApi";
+  displayName = "OKRunit API";
+  documentationUrl = "https://github.com/your-org/okrunit/tree/main/integrations/n8n";
+
+  properties: INodeProperties[] = [
+    {
+      displayName: "API Key",
+      name: "apiKey",
+      type: "string",
+      typeOptions: { password: true },
+      default: "",
+      placeholder: "gk_...",
+      description: "Your OKRunit API key (starts with gk_)",
+    },
+    {
+      displayName: "Base URL",
+      name: "baseUrl",
+      type: "string",
+      default: "https://okrunit.example.com",
+      placeholder: "https://okrunit.example.com",
+      description: "The base URL of your OKRunit instance",
+    },
+  ];
+
+  authenticate = {
+    type: "generic" as const,
+    properties: {
+      headers: {
+        Authorization: "=Bearer {{$credentials.apiKey}}",
+      },
+    },
+  };
+
+  test = {
+    request: {
+      baseURL: "={{$credentials.baseUrl}}",
+      url: "/api/v1/approvals",
+      qs: { page_size: "1" },
+    },
+  };
+}

package/credentials/GatekeeperOAuth2Api.credentials.ts

@@ -0,0 +1,56 @@
+import type { ICredentialType, INodeProperties } from "n8n-workflow";
+
+export class GatekeeperOAuth2Api implements ICredentialType {
+  name = "gatekeeperOAuth2Api";
+  displayName = "OKRunit OAuth2 API";
+  extends = ["oAuth2Api"];
+  documentationUrl =
+    "https://github.com/your-org/okrunit/tree/main/integrations/n8n";
+
+  properties: INodeProperties[] = [
+    {
+      displayName: "Base URL",
+      name: "baseUrl",
+      type: "string",
+      default: "https://okrunit.example.com",
+      placeholder: "https://okrunit.example.com",
+      description: "The base URL of your OKRunit instance",
+    },
+    {
+      displayName: "Grant Type",
+      name: "grantType",
+      type: "hidden",
+      default: "authorizationCode",
+    },
+    {
+      displayName: "Authorization URL",
+      name: "authUrl",
+      type: "hidden",
+      default: "={{$self.baseUrl}}/oauth/authorize",
+    },
+    {
+      displayName: "Access Token URL",
+      name: "accessTokenUrl",
+      type: "hidden",
+      default: "={{$self.baseUrl}}/api/v1/oauth/token",
+    },
+    {
+      displayName: "Scope",
+      name: "scope",
+      type: "hidden",
+      default: "approvals:read approvals:write comments:write",
+    },
+    {
+      displayName: "Auth URI Query Parameters",
+      name: "authQueryParameters",
+      type: "hidden",
+      default: "",
+    },
+    {
+      displayName: "Authentication",
+      name: "authentication",
+      type: "hidden",
+      default: "body",
+    },
+  ];
+}

package/dist/credentials/GatekeeperApi.credentials.d.ts

@@ -0,0 +1,25 @@
+import type { ICredentialType, INodeProperties } from "n8n-workflow";
+export declare class GatekeeperApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    properties: INodeProperties[];
+    authenticate: {
+        type: "generic";
+        properties: {
+            headers: {
+                Authorization: string;
+            };
+        };
+    };
+    test: {
+        request: {
+            baseURL: string;
+            url: string;
+            qs: {
+                page_size: string;
+            };
+        };
+    };
+}
+//# sourceMappingURL=GatekeeperApi.credentials.d.ts.map

package/dist/credentials/GatekeeperApi.credentials.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GatekeeperApi.credentials.d.ts","sourceRoot":"","sources":["../../credentials/GatekeeperApi.credentials.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAErE,qBAAa,aAAc,YAAW,eAAe;IACnD,IAAI,SAAmB;IACvB,WAAW,SAAiB;IAC5B,gBAAgB,SAAoE;IAEpF,UAAU,EAAE,eAAe,EAAE,CAkB3B;IAEF,YAAY;;;;;;;MAOV;IAEF,IAAI;;;;;;;;MAMF;CACH"}

package/dist/credentials/GatekeeperApi.credentials.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GatekeeperApi = void 0;
+class GatekeeperApi {
+    constructor() {
+        this.name = "gatekeeperApi";
+        this.displayName = "OKRunit API";
+        this.documentationUrl = "https://github.com/your-org/okrunit/tree/main/integrations/n8n";
+        this.properties = [
+            {
+                displayName: "API Key",
+                name: "apiKey",
+                type: "string",
+                typeOptions: { password: true },
+                default: "",
+                placeholder: "gk_...",
+                description: "Your OKRunit API key (starts with gk_)",
+            },
+            {
+                displayName: "Base URL",
+                name: "baseUrl",
+                type: "string",
+                default: "https://okrunit.example.com",
+                placeholder: "https://okrunit.example.com",
+                description: "The base URL of your OKRunit instance",
+            },
+        ];
+        this.authenticate = {
+            type: "generic",
+            properties: {
+                headers: {
+                    Authorization: "=Bearer {{$credentials.apiKey}}",
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: "={{$credentials.baseUrl}}",
+                url: "/api/v1/approvals",
+                qs: { page_size: "1" },
+            },
+        };
+    }
+}
+exports.GatekeeperApi = GatekeeperApi;
+//# sourceMappingURL=GatekeeperApi.credentials.js.map

package/dist/credentials/GatekeeperApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GatekeeperApi.credentials.js","sourceRoot":"","sources":["../../credentials/GatekeeperApi.credentials.ts"],"names":[],"mappings":";;;AAEA,MAAa,aAAa;IAA1B;QACE,SAAI,GAAG,eAAe,CAAC;QACvB,gBAAW,GAAG,aAAa,CAAC;QAC5B,qBAAgB,GAAG,gEAAgE,CAAC;QAEpF,eAAU,GAAsB;YAC9B;gBACE,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,QAAQ;gBACrB,WAAW,EAAE,wCAAwC;aACtD;YACD;gBACE,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,6BAA6B;gBACtC,WAAW,EAAE,6BAA6B;gBAC1C,WAAW,EAAE,uCAAuC;aACrD;SACF,CAAC;QAEF,iBAAY,GAAG;YACb,IAAI,EAAE,SAAkB;YACxB,UAAU,EAAE;gBACV,OAAO,EAAE;oBACP,aAAa,EAAE,iCAAiC;iBACjD;aACF;SACF,CAAC;QAEF,SAAI,GAAG;YACL,OAAO,EAAE;gBACP,OAAO,EAAE,2BAA2B;gBACpC,GAAG,EAAE,mBAAmB;gBACxB,EAAE,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE;aACvB;SACF,CAAC;IACJ,CAAC;CAAA;AAzCD,sCAyCC"}

package/dist/credentials/GatekeeperOAuth2Api.credentials.d.ts

@@ -0,0 +1,9 @@
+import type { ICredentialType, INodeProperties } from "n8n-workflow";
+export declare class GatekeeperOAuth2Api implements ICredentialType {
+    name: string;
+    displayName: string;
+    extends: string[];
+    documentationUrl: string;
+    properties: INodeProperties[];
+}
+//# sourceMappingURL=GatekeeperOAuth2Api.credentials.d.ts.map

package/dist/credentials/GatekeeperOAuth2Api.credentials.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GatekeeperOAuth2Api.credentials.d.ts","sourceRoot":"","sources":["../../credentials/GatekeeperOAuth2Api.credentials.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAErE,qBAAa,mBAAoB,YAAW,eAAe;IACzD,IAAI,SAAyB;IAC7B,WAAW,SAAwB;IACnC,OAAO,WAAiB;IACxB,gBAAgB,SACmD;IAEnE,UAAU,EAAE,eAAe,EAAE,CA6C3B;CACH"}

package/dist/credentials/GatekeeperOAuth2Api.credentials.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GatekeeperOAuth2Api = void 0;
+class GatekeeperOAuth2Api {
+    constructor() {
+        this.name = "gatekeeperOAuth2Api";
+        this.displayName = "OKRunit OAuth2 API";
+        this.extends = ["oAuth2Api"];
+        this.documentationUrl = "https://github.com/your-org/okrunit/tree/main/integrations/n8n";
+        this.properties = [
+            {
+                displayName: "Base URL",
+                name: "baseUrl",
+                type: "string",
+                default: "https://okrunit.example.com",
+                placeholder: "https://okrunit.example.com",
+                description: "The base URL of your OKRunit instance",
+            },
+            {
+                displayName: "Grant Type",
+                name: "grantType",
+                type: "hidden",
+                default: "authorizationCode",
+            },
+            {
+                displayName: "Authorization URL",
+                name: "authUrl",
+                type: "hidden",
+                default: "={{$self.baseUrl}}/oauth/authorize",
+            },
+            {
+                displayName: "Access Token URL",
+                name: "accessTokenUrl",
+                type: "hidden",
+                default: "={{$self.baseUrl}}/api/v1/oauth/token",
+            },
+            {
+                displayName: "Scope",
+                name: "scope",
+                type: "hidden",
+                default: "approvals:read approvals:write comments:write",
+            },
+            {
+                displayName: "Auth URI Query Parameters",
+                name: "authQueryParameters",
+                type: "hidden",
+                default: "",
+            },
+            {
+                displayName: "Authentication",
+                name: "authentication",
+                type: "hidden",
+                default: "body",
+            },
+        ];
+    }
+}
+exports.GatekeeperOAuth2Api = GatekeeperOAuth2Api;
+//# sourceMappingURL=GatekeeperOAuth2Api.credentials.js.map

package/dist/credentials/GatekeeperOAuth2Api.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GatekeeperOAuth2Api.credentials.js","sourceRoot":"","sources":["../../credentials/GatekeeperOAuth2Api.credentials.ts"],"names":[],"mappings":";;;AAEA,MAAa,mBAAmB;IAAhC;QACE,SAAI,GAAG,qBAAqB,CAAC;QAC7B,gBAAW,GAAG,oBAAoB,CAAC;QACnC,YAAO,GAAG,CAAC,WAAW,CAAC,CAAC;QACxB,qBAAgB,GACd,gEAAgE,CAAC;QAEnE,eAAU,GAAsB;YAC9B;gBACE,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,6BAA6B;gBACtC,WAAW,EAAE,6BAA6B;gBAC1C,WAAW,EAAE,uCAAuC;aACrD;YACD;gBACE,WAAW,EAAE,YAAY;gBACzB,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,mBAAmB;aAC7B;YACD;gBACE,WAAW,EAAE,mBAAmB;gBAChC,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,oCAAoC;aAC9C;YACD;gBACE,WAAW,EAAE,kBAAkB;gBAC/B,IAAI,EAAE,gBAAgB;gBACtB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,uCAAuC;aACjD;YACD;gBACE,WAAW,EAAE,OAAO;gBACpB,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,+CAA+C;aACzD;YACD;gBACE,WAAW,EAAE,2BAA2B;gBACxC,IAAI,EAAE,qBAAqB;gBAC3B,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;aACZ;YACD;gBACE,WAAW,EAAE,gBAAgB;gBAC7B,IAAI,EAAE,gBAAgB;gBACtB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,MAAM;aAChB;SACF,CAAC;IACJ,CAAC;CAAA;AArDD,kDAqDC"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { GatekeeperApi } from "./credentials/GatekeeperApi.credentials";
+export { GatekeeperOAuth2Api } from "./credentials/GatekeeperOAuth2Api.credentials";
+export { Gatekeeper } from "./nodes/Gatekeeper/Gatekeeper.node";
+export { GatekeeperTrigger } from "./nodes/Gatekeeper/GatekeeperTrigger.node";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,+CAA+C,CAAC;AACpF,OAAO,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,2CAA2C,CAAC"}

package/dist/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GatekeeperTrigger = exports.Gatekeeper = exports.GatekeeperOAuth2Api = exports.GatekeeperApi = void 0;
+var GatekeeperApi_credentials_1 = require("./credentials/GatekeeperApi.credentials");
+Object.defineProperty(exports, "GatekeeperApi", { enumerable: true, get: function () { return GatekeeperApi_credentials_1.GatekeeperApi; } });
+var GatekeeperOAuth2Api_credentials_1 = require("./credentials/GatekeeperOAuth2Api.credentials");
+Object.defineProperty(exports, "GatekeeperOAuth2Api", { enumerable: true, get: function () { return GatekeeperOAuth2Api_credentials_1.GatekeeperOAuth2Api; } });
+var Gatekeeper_node_1 = require("./nodes/Gatekeeper/Gatekeeper.node");
+Object.defineProperty(exports, "Gatekeeper", { enumerable: true, get: function () { return Gatekeeper_node_1.Gatekeeper; } });
+var GatekeeperTrigger_node_1 = require("./nodes/Gatekeeper/GatekeeperTrigger.node");
+Object.defineProperty(exports, "GatekeeperTrigger", { enumerable: true, get: function () { return GatekeeperTrigger_node_1.GatekeeperTrigger; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,qFAAwE;AAA/D,0HAAA,aAAa,OAAA;AACtB,iGAAoF;AAA3E,sIAAA,mBAAmB,OAAA;AAC5B,sEAAgE;AAAvD,6GAAA,UAAU,OAAA;AACnB,oFAA8E;AAArE,2HAAA,iBAAiB,OAAA"}

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

@@ -0,0 +1,6 @@
+import type { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from "n8n-workflow";
+export declare class Gatekeeper implements INodeType {
+    description: INodeTypeDescription;
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}
+//# sourceMappingURL=Gatekeeper.node.d.ts.map

package/dist/nodes/Gatekeeper/Gatekeeper.node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Gatekeeper.node.d.ts","sourceRoot":"","sources":["../../../nodes/Gatekeeper/Gatekeeper.node.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,iBAAiB,EACjB,kBAAkB,EAClB,SAAS,EACT,oBAAoB,EACrB,MAAM,cAAc,CAAC;AAEtB,qBAAa,UAAW,YAAW,SAAS;IAC1C,WAAW,EAAE,oBAAoB,CA0Q/B;IAEI,OAAO,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;CAyIxE"}