@openapi-flow/core 0.1.0

package/dist/workflow/workflow-helpers.js

@@ -0,0 +1,81 @@
+import { checkPrimitive, isObject, looksLikeCredential, } from '../utils/validation.js';
+export function isSafeMethod(method) {
+    return ['GET', 'HEAD', 'OPTIONS', 'TRACE', 'QUERY'].includes(method);
+}
+export function makeUrl(operation, origin, inputs, missing) {
+    let path = operation.path;
+    for (const parameter of operation.parameters) {
+        const key = parameter.in + '.' + parameter.name;
+        const value = inputs[key];
+        if (value === undefined) {
+            if (parameter.required)
+                missing.push(key);
+            continue;
+        }
+        checkPrimitive(value, parameter.schema, 'plan.inputs.' + key);
+        if (parameter.in === 'path')
+            path = path.replace('{' + parameter.name + '}', encodeURIComponent(String(value)));
+    }
+    const url = new URL(path, origin);
+    for (const parameter of operation.parameters) {
+        if (parameter.in !== 'query')
+            continue;
+        const key = 'query.' + parameter.name;
+        if (inputs[key] !== undefined)
+            url.searchParams.set(parameter.name, String(inputs[key]));
+    }
+    return url.href;
+}
+export function makeBody(operation, inputs, missing) {
+    if (!operation.body)
+        return undefined;
+    const value = inputs.body;
+    if (value === undefined) {
+        if (operation.body.required)
+            missing.push('body');
+        return undefined;
+    }
+    if (!isObject(value))
+        throw new Error('plan.inputs.body must be an object');
+    for (const [name, field] of Object.entries(value)) {
+        const schema = operation.body.properties[name];
+        if (!schema)
+            throw new Error('plan.inputs.body.' + name + ' is not declared in the OAS schema');
+        if (looksLikeCredential(name)) {
+            throw new Error('plan.inputs.body.' +
+                name +
+                ' looks like a credential; v1 has no credential binding');
+        }
+        checkPrimitive(field, schema, 'plan.inputs.body.' + name);
+    }
+    for (const name of operation.body.requiredProperties) {
+        if (!Object.hasOwn(value, name))
+            missing.push('body.' + name);
+    }
+    return JSON.stringify(value);
+}
+export function assertionCode(status, expectedBody, requiredFields = {}) {
+    const expected = JSON.stringify(expectedBody);
+    const required = JSON.stringify(requiredFields);
+    return [
+        'const items = $input.all();',
+        "if (items.length !== 1) throw new Error('Expected one response item');",
+        'const response = items[0].json;',
+        'if (response.statusCode !== ' +
+            status +
+            ') throw new Error("Expected HTTP ' +
+            status +
+            ', got " + response.statusCode);',
+        'const expected = ' + expected + ';',
+        'const required = ' + required + ';',
+        'for (const [key, type] of Object.entries(required)) {',
+        '  const value = response.body?.[key];',
+        '  const valid = type === "integer" ? Number.isSafeInteger(value) : type === "number" ? typeof value === "number" && Number.isFinite(value) : typeof value === type;',
+        '  if (!valid) throw new Error("Missing or invalid response body field: " + key);',
+        '}',
+        'for (const [key, value] of Object.entries(expected)) {',
+        '  if (response.body?.[key] !== value) throw new Error("Unexpected response body field: " + key);',
+        '}',
+        'return items;',
+    ].join('\n');
+}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@openapi-flow/core",
+  "version": "0.1.0",
+  "license": "MIT",
+  "description": "Build reviewable n8n workflows from OpenAPI documents and natural-language scenarios",
+  "keywords": [
+    "openapi",
+    "n8n",
+    "workflow",
+    "langchain"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/carefreelife98/openapi-flow.git",
+    "directory": "packages/core"
+  },
+  "homepage": "https://github.com/carefreelife98/openapi-flow#readme",
+  "bugs": "https://github.com/carefreelife98/openapi-flow/issues",
+  "author": "carefreelife98",
+  "type": "module",
+  "engines": {
+    "node": ">=24"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/public-api.d.ts",
+      "default": "./dist/public-api.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "THIRD_PARTY_NOTICES.md"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepack": "npm run build",
+    "prepublishOnly": "npm run typecheck && npm run lint && npm run format:check && npm test",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "lint": "eslint src test integration",
+    "format:check": "prettier --check src test integration package.json tsconfig.json eslint.config.mjs",
+    "format": "prettier --write src test integration package.json tsconfig.json eslint.config.mjs",
+    "test": "npm run build && node --test",
+    "test:real-oas": "npm run build && node --test integration/real-oas.mjs"
+  },
+  "dependencies": {
+    "@n8n/workflow-sdk": "0.33.1",
+    "@scalar/openapi-parser": "0.29.7",
+    "@scalar/openapi-validator": "0.1.6"
+  },
+  "peerDependencies": {
+    "@langchain/core": "^1.0.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "10.0.1",
+    "@langchain/core": "1.2.12",
+    "@types/node": "^24.0.0",
+    "eslint": "10.11.0",
+    "prettier": "3.9.9",
+    "typescript": "5.9.3",
+    "typescript-eslint": "8.70.1"
+  }
+}