eyereasoner 1.0.0

package/dist/transformers.d.ts

@@ -0,0 +1,48 @@
+import type { SWIPLModule } from 'swipl-wasm/dist/swipl/swipl';
+import type SWIPL from 'swipl-wasm/dist/swipl/swipl';
+import { Quad } from '@rdfjs/types';
+/**
+ * Executes a query
+ * @param Module The module to execute the query on
+ * @param name The name of the query function
+ * @param args The arguments of the query function
+ * @returns The result of the query
+ */
+export declare function query(Module: SWIPLModule, name: string, args: string[] | string): SWIPL.Query;
+export declare function queryOnce(Module: SWIPLModule, name: string, args: string[] | string): unknown;
+/**
+ * A SWIPL transformer that loads and consults eye.pl in the
+ * given SWIPL module
+ * @param Module A SWIPL Module
+ * @returns The same SWIPL module with EYE loaded and consulted
+ */
+export declare function loadEye(Module: SWIPLModule): SWIPLModule;
+/**
+ * Execute a query over a given data file
+ * @param Module A SWIPL Module
+ * @param data The data for the query (in Notation3)
+ * @param queryString The query (in Notation3)
+ * @returns The same SWIPL module
+ */
+export declare function runQuery(Module: SWIPLModule, data: string, queryString: string): SWIPLModule;
+/**
+ * @param Module A SWIPL Module
+ * @param data The data as N3
+ * @param queryString The query as N3
+ * @returns
+ */
+export declare function loadAndRunQuery(Module: SWIPLModule, data: string, queryString: string): SWIPLModule;
+/**
+ * @param swipl The base SWIPL module to use
+ * @param data The data for the query (in N3 format)
+ * @param queryString The query (in N3 format)
+ * @returns The result of the query
+ */
+export declare function executeBasicEyeQuery(swipl: typeof SWIPL, data: string, queryString: string): Promise<string>;
+/**
+ * @param swipl The base SWIPL module to use
+ * @param data The data for the query (in N3 format)
+ * @param queryString The query (in N3 format)
+ * @returns The result of the query
+ */
+export declare function executeBasicEyeQueryQuads(swipl: typeof SWIPL, data: Quad[], queryString: Quad[]): Promise<Quad[]>;

package/dist/transformers.js

@@ -0,0 +1,100 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.executeBasicEyeQueryQuads = exports.executeBasicEyeQuery = exports.loadAndRunQuery = exports.runQuery = exports.loadEye = exports.queryOnce = exports.query = void 0;
+const n3_1 = require("n3");
+const eye_pl_1 = __importDefault(require("./eye.pl"));
+/**
+ * Executes a query
+ * @param Module The module to execute the query on
+ * @param name The name of the query function
+ * @param args The arguments of the query function
+ * @returns The result of the query
+ */
+function query(Module, name, args) {
+    const queryString = `${name}(${typeof args === 'string'
+        ? `"${args}"`
+        : `[${args.map((arg) => `'${arg}'`).join(', ')}]`}).`;
+    return Module.prolog.query(queryString);
+}
+exports.query = query;
+function queryOnce(Module, name, args) {
+    return query(Module, name, args).once();
+}
+exports.queryOnce = queryOnce;
+/**
+ * A SWIPL transformer that loads and consults eye.pl in the
+ * given SWIPL module
+ * @param Module A SWIPL Module
+ * @returns The same SWIPL module with EYE loaded and consulted
+ */
+function loadEye(Module) {
+    Module.FS.writeFile('eye.pl', eye_pl_1.default);
+    queryOnce(Module, 'consult', 'eye.pl');
+    return Module;
+}
+exports.loadEye = loadEye;
+/**
+ * Execute a query over a given data file
+ * @param Module A SWIPL Module
+ * @param data The data for the query (in Notation3)
+ * @param queryString The query (in Notation3)
+ * @returns The same SWIPL module
+ */
+function runQuery(Module, data, queryString) {
+    Module.FS.writeFile('data.n3', data);
+    Module.FS.writeFile('query.n3', queryString);
+    queryOnce(Module, 'main', ['--quiet', './data.n3', '--query', './query.n3']);
+    return Module;
+}
+exports.runQuery = runQuery;
+/**
+ * @param Module A SWIPL Module
+ * @param data The data as N3
+ * @param queryString The query as N3
+ * @returns
+ */
+function loadAndRunQuery(Module, data, queryString) {
+    return runQuery(loadEye(Module), data, queryString);
+}
+exports.loadAndRunQuery = loadAndRunQuery;
+/**
+ * @param swipl The base SWIPL module to use
+ * @param data The data for the query (in N3 format)
+ * @param queryString The query (in N3 format)
+ * @returns The result of the query
+ */
+function executeBasicEyeQuery(swipl, data, queryString) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let res = '';
+        const Module = yield swipl({ print: (str) => { res += str; }, arguments: ['-q'] });
+        loadAndRunQuery(Module, data, queryString);
+        return res;
+    });
+}
+exports.executeBasicEyeQuery = executeBasicEyeQuery;
+/**
+ * @param swipl The base SWIPL module to use
+ * @param data The data for the query (in N3 format)
+ * @param queryString The query (in N3 format)
+ * @returns The result of the query
+ */
+function executeBasicEyeQueryQuads(swipl, data, queryString) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const parser = new n3_1.Parser();
+        const writer = new n3_1.Writer();
+        return parser.parse(yield executeBasicEyeQuery(swipl, writer.quadsToString(data), writer.quadsToString(queryString)));
+    });
+}
+exports.executeBasicEyeQueryQuads = executeBasicEyeQueryQuads;

package/package.json

@@ -0,0 +1,99 @@
+{
+  "name": "eyereasoner",
+  "version": "1.0.0",
+  "description": "Distributing the [EYE](https://github.com/josd/eye) reasoner for browser and node using WebAssembly.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.js",
+  "directories": {
+    "lib": "lib"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "test:coverage": "npm test -- --coverage",
+    "test:badges": "npm run test:coverage  && jest-coverage-badges",
+    "test": "jest",
+    "lint": "eslint lib/**/*.ts __tests__/* scripts/* --ext .ts",
+    "lint:fix": "eslint lib/**/*.ts __tests__/* scripts/* --ext .ts --fix",
+    "build": "tsc",
+    "prepare": "npm run eye:prepare && npm run build",
+    "semantic-release": "semantic-release",
+    "eye:fetch": "ts-node scripts/fetch-eye",
+    "eye:build": "rollup --config rollup.config.mjs",
+    "eye:prepare": "npm run eye:fetch && npm run eye:build",
+    "eye:update": "ts-node scripts/update",
+    "postinstall": "npm run eye:prepare"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/eyereasoner/eye-js.git"
+  },
+  "keywords": [],
+  "author": "Jesse Wright <https://github.com/jeswr/>",
+  "contributors": [
+    "Jesse Wright <https://github.com/jeswr/>",
+    "Jos De Roo <https://github.com/josd/>"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/eyereasoner/eye-js/issues"
+  },
+  "homepage": "",
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^24.0.0",
+    "@types/jest": "^29.2.4",
+    "@types/n3": "^1.10.4",
+    "@typescript-eslint/eslint-plugin": "^5.47.0",
+    "@typescript-eslint/parser": "^5.47.0",
+    "cross-fetch": "^3.1.5",
+    "eslint": "^8.30.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.26.0",
+    "jest": "^29.3.1",
+    "pre-commit": "^1.2.2",
+    "rollup": "^3.8.1",
+    "rollup-plugin-string": "^3.0.0",
+    "rollup-plugin-typescript2": "^0.34.1",
+    "semantic-release": "^19.0.5",
+    "ts-jest": "^29.0.3",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.4"
+  },
+  "pre-commit": [
+    "lint",
+    "build",
+    "test"
+  ],
+  "release": {
+    "branches": [
+      "main",
+      "+([0-9])?(.{+([0-9]),x}).x",
+      "next",
+      {
+        "name": "alpha",
+        "prerelease": true
+      },
+      {
+        "name": "beta",
+        "prerelease": true
+      }
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "config": {
+    "eye": {
+      "name": "v22.1224.0044",
+      "sha": "eb0b3f9723e54972be049a841771db1a56f0acce"
+    }
+  },
+  "dependencies": {
+    "n3": "^1.16.3",
+    "swipl-wasm": "^3.0.0"
+  },
+  "peerDependencies": {
+    "@rdfjs/types": "^1.1.0"
+  }
+}