eyeling 1.5.8 → 1.5.11

package/README.md

@@ -34,6 +34,53 @@ This link preloads a small “Socrates is Mortal” ruleset:
 
 - A reasonably recent Node.js (anything modern with `BigInt` support is fine).
 
+```md
+## Install (npm)
+
+```bash
+npm i eyeling
+```
+
+## CLI (npm)
+
+Run on a file:
+
+```bash
+npx eyeling examples/socrates.n3
+```
+
+(Or install globally: `npm i -g eyeling` and run `eyeling ...`.)
+
+## JavaScript API (Node)
+
+```js
+const { reason } = require('eyeling');
+
+const input = `
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>.
+@prefix : <http://example.org/socrates#>.
+
+:Socrates a :Human.
+:Human rdfs:subClassOf :Mortal.
+
+{ ?S a ?A. ?A rdfs:subClassOf ?B } => { ?S a ?B }.
+`;
+
+const output = reason({ proofComments: false }, input);
+console.log(output);
+```
+
+ESM:
+
+```js
+import eyeling from 'eyeling';
+
+const output = eyeling.reason({ proofComments: false }, input);
+console.log(output);
+```
+
+Note: the API currently shells out to the bundled `eyeling.js` CLI under the hood (simple + robust).
+
 ### Run a single file
 
 From the repo root:
@@ -186,3 +233,4 @@ As soon as the premise is provable, `eyeling` exits with status code `2`.
 ## License
 
 MIT (see [LICENSE](https://github.com/eyereasoner/eyeling/blob/main/LICENSE.md)).
+

package/index.js

@@ -0,0 +1,61 @@
+'use strict';
+
+const fs = require('node:fs');
+const os = require('node:os');
+const path = require('node:path');
+const cp = require('node:child_process');
+
+function reason(opt = {}, n3_input = '') {
+  if (n3_input == null) n3_input = '';
+  if (typeof n3_input !== 'string') {
+    throw new TypeError('reason(opt, n3_input): n3_input must be a string');
+  }
+
+  // allow passing an args array directly
+  if (Array.isArray(opt)) opt = { args: opt };
+
+  const args = [];
+
+  // default: proof comments OFF for API output (machine-friendly)
+  // set { proofComments: true } to keep them
+  const proofComments =
+    (typeof opt.proofComments === 'boolean') ? opt.proofComments :
+    (typeof opt.noProofComments === 'boolean') ? !opt.noProofComments :
+    false;
+
+  if (!proofComments) args.push('--no-proof-comments'); // CLI already supports this :contentReference[oaicite:1]{index=1}
+
+  if (Array.isArray(opt.args)) args.push(...opt.args);
+
+  const maxBuffer = Number.isFinite(opt.maxBuffer) ? opt.maxBuffer : 50 * 1024 * 1024;
+
+  const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'eyeling-'));
+  const inputFile = path.join(dir, 'input.n3');
+
+  try {
+    fs.writeFileSync(inputFile, n3_input, 'utf8');
+
+    const eyelingPath = path.join(__dirname, 'eyeling.js');
+    const res = cp.spawnSync(process.execPath, [eyelingPath, ...args, inputFile], {
+      encoding: 'utf8',
+      maxBuffer,
+    });
+
+    if (res.error) throw res.error;
+    if (res.status !== 0) {
+      const err = new Error(res.stderr || `eyeling exited with code ${res.status}`);
+      err.code = res.status;
+      err.stdout = res.stdout;
+      err.stderr = res.stderr;
+      throw err;
+    }
+    return res.stdout;
+  } finally {
+    fs.rmSync(dir, { recursive: true, force: true });
+  }
+}
+
+module.exports = { reason };
+// small interop nicety for ESM default import
+module.exports.default = module.exports;
+

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "eyeling",
-  "version": "1.5.8",
+  "version": "1.5.11",
   "description": "A minimal Notation3 (N3) reasoner in JavaScript.",
+  "main": "./index.js",
   "keywords": [
     "N3",
     "reasoner"
@@ -17,11 +18,18 @@
     "eyeling": "./eyeling.js"
   },
   "files": [
+    "index.js",
     "eyeling.js",
     "README.md",
     "LICENSE.md"
   ],
   "engines": {
     "node": ">=18"
+  },
+  "dependencies": {
+    "eyeling": "^1.5.10"
+  },
+  "scripts": {
+    "test": "node test/api.test.js"
   }
 }