swipl-wasm 1.0.1 → 1.1.0

package/package.json

@@ -1,17 +1,42 @@
 {
   "name": "swipl-wasm",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "exports": {
     "./swipl": "./dist/swipl/swipl.js",
-    "./swipl-web": "./dist/swipl/swipl-web.js"
+    "./swipl-web": "./dist/swipl/swipl-web.js",
+    ".": "./dist/index.js"
   },
-  "author": "Raivo Laanemets",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "contributors": [
+    "Raivo Laanemets",
+    "Jesse Wright"
+  ],
   "license": "BSD-2-Clause",
   "type": "commonjs",
   "devDependencies": {
+    "@types/emscripten": "^1.39.6",
+    "@types/jest": "^29.0.0",
+    "@types/node": "^18.7.14",
+    "@typescript-eslint/eslint-plugin": "^5.36.1",
+    "@typescript-eslint/parser": "^5.36.1",
+    "copyfiles": "^2.4.1",
+    "eslint": "^8.23.0",
+    "http-server": "^14.1.1",
+    "jest": "28",
+    "jest-environment-jsdom": "^29.0.1",
     "npm-run-all": "^4.1.5",
-    "http-server": "^14.1.1"
+    "pre-commit": "^1.2.2",
+    "ts-jest": "^28.0.8",
+    "typescript": "^4.8.2"
   },
+  "browser": {
+    "./dist/locateFile.js": "./dist/locateFile-browser.js",
+    "./dist/swipl/swipl.js": "./dist/swipl/swipl-web.js"
+  },
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build:wasm-docker:build": "docker build -t swipl-wasm-image docker",
     "build:wasm-docker:create": "docker create --name swipl-wasm swipl-wasm-image",
@@ -22,7 +47,34 @@
     "build:wasm-docker:extract:node": "docker cp swipl-wasm:/swipl-devel/swipl.wasm/src/swipl-web.js dist/swipl/swipl.js",
     "build:wasm-docker:extract": "run-s build:wasm-docker:extract:*",
     "build:wasm-docker": "run-s build:wasm-docker:build build:wasm-docker:create build:wasm-docker:extract build:wasm-docker:remove",
-    "build": "run-s build:wasm-docker",
-    "test:serve-http": "http-server . -c-1"
-  }
+    "build:tsc:compile": "tsc",
+    "build:tsc:copy": "copyfiles -u 1 \"src/**/*.d.ts\" dist",
+    "build:tsc": "run-s build:tsc:*",
+    "build": "run-s build:*",
+    "prepare": "yarn run build",
+    "test:serve-http": "http-server . -c-1",
+    "test": "yarn run build && jest",
+    "lint": "eslint . --ext .ts"
+  },
+  "jest": {
+    "preset": "ts-jest",
+    "collectCoverage": true,
+    "coverageReporters": [
+      "json-summary",
+      "text",
+      "lcov"
+    ],
+    "coverageThreshold": {
+      "global": {
+        "branches": 10,
+        "functions": 10,
+        "lines": 10,
+        "statements": 10
+      }
+    }
+  },
+  "pre-commit": [
+    "lint",
+    "test"
+  ]
 }

package/docker/Dockerfile

@@ -1,53 +0,0 @@
-# Builds SWI-Prolog WebAssembly version.
-# https://swi-prolog.discourse.group/t/swi-prolog-in-the-browser-using-wasm/5650
-
-FROM debian:bullseye
-
-# Installs build dependencies.
-
-ENV DEBIAN_FRONTEND noninteractive
-
-RUN apt-get update && apt-get install -y \
-  bzip2 \
-  cmake \
-  git \
-  ninja-build \
-  python3 \
-  wget \
-  xz-utils
-
-RUN git config --global pull.ff only
-
-# Installs Emscripten.
-# See https://emscripten.org/docs/getting_started/downloads.html
-
-ENV EMSDK_VERSION 3.1.20
-
-RUN git clone https://github.com/emscripten-core/emsdk.git /emsdk
-WORKDIR /emsdk
-RUN git pull
-RUN ./emsdk install $EMSDK_VERSION
-RUN ./emsdk activate $EMSDK_VERSION
-
-# Downloads ZLIB.
-
-RUN wget --no-verbose https://zlib.net/zlib-1.2.12.tar.gz -O /zlib-1.2.12.tar.gz
-RUN tar -xf /zlib-1.2.12.tar.gz --directory /
-
-# Clones SWI-Prolog.
-
-RUN git clone https://github.com/SWI-Prolog/swipl-devel.git /swipl-devel
-WORKDIR /swipl-devel
-
-# Uncomment the following to build a specific commit.
-# ENV SWIPL_COMMIT 5c7d1f8352b27d45cb8066eac5af95cf925a05b7
-# RUN git checkout $SWIPL_COMMIT -b local-wasm
-
-RUN git fetch
-RUN git submodule update --init
-
-# Compiles everything.
-
-COPY build-all.sh /build-all.sh
-RUN chmod +x /build-all.sh
-RUN /build-all.sh

package/docker/build-all.sh

@@ -1,29 +0,0 @@
-#!/bin/bash
-
-set -o errexit
-set -o xtrace
-
-source /emsdk/emsdk_env.sh
-
-# ZLIB
-
-cd /zlib-1.2.12
-emconfigure ./configure
-EMCC_CFLAGS=-Wno-deprecated-non-prototype emmake make
-
-# SWI-Prolog
-
-mkdir /swipl-devel/swipl.wasm
-cd /swipl-devel/swipl.wasm
-cmake -DCMAKE_TOOLCHAIN_FILE=/emsdk/upstream/emscripten/cmake/Modules/Platform/Emscripten.cmake \
-  -DCMAKE_BUILD_TYPE=Release \
-  -DZLIB_LIBRARY=/zlib-1.2.12/libz.a \
-  -DZLIB_INCLUDE_DIR=/zlib-1.2.12 \
-  -DINSTALL_DOCUMENTATION=OFF \
-  -DMULTI_THREADED=OFF \
-  -DUSE_SIGNALS=OFF \
-  -DUSE_GMP=OFF \
-  -DBUILD_SWIPL_LD=OFF \
-  -DSWIPL_PACKAGES=OFF \
-  -G Ninja ..
-ninja

package/examples/browser.html

@@ -1,32 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="UTF8">
-    <title>SWI-Prolog WebAssembly browser test</title>
-  </head>
-  <body>
-    <div id="solution"></div>
-    <script src="/dist/swipl/swipl-web.js"></script>
-    <script>
-      (async () => {
-        const swipl = await SWIPL({
-          noInitialRun: true,
-          arguments: ['-q'],
-          locateFile: (url) => {
-            if (url === 'swipl-web.data') {
-              return '/dist/swipl/swipl-web.data';
-            } else if (url === 'swipl-web.wasm') {
-              return '/dist/swipl/swipl-web.wasm';
-            }
-            return url;
-          }
-        });
-        const query = "member(X, [a, b, c]).";
-        const solutionElement = document.getElementById('solution');
-        // See https://swi-prolog.discourse.group/t/swi-prolog-in-the-browser-using-wasm/5650/1      
-        const firstSolution = swipl.prolog.query(query).once().X;
-        solutionElement.textContent = firstSolution;
-      })();
-    </script>
-  </body>
-</html>

package/examples/run-on-node.js

@@ -1,23 +0,0 @@
-const path = require('path');
-const SWIPL = require('swipl-wasm/swipl');
-
-(async () => {
-  // This helps to find the correct locations of the
-  // .data and .wasm files.
-  const swiplModuleLocation = require.resolve('swipl-wasm/swipl');
-  const swipl = await SWIPL({
-    noInitialRun: true,
-    arguments: ['-q'],
-    locateFile: (url) => {
-      // These are common with the web version.
-      if (url === 'swipl-web.data') {
-        return path.join(path.dirname(swiplModuleLocation), 'swipl-web.data');
-      } else if (url === 'swipl-web.wasm') {
-        return path.join(path.dirname(swiplModuleLocation), 'swipl-web.wasm');
-      }
-      return url;
-    }
-  });
-  // See https://swi-prolog.discourse.group/t/swi-prolog-in-the-browser-using-wasm/5650/1
-  console.log(swipl.prolog.query("member(X, [a, b, c]).").once().X);
-})();