swipl-wasm 3.2.2 → 3.3.1

package/README.md

@@ -4,6 +4,38 @@ SWI-Prolog WebAssembly build as a NPM package. Please see this page
 for ongoing progress and information:
 <https://swi-prolog.discourse.group/t/swi-prolog-in-the-browser-using-wasm/5650>
 
+## Quickly Getting Started
+
+The easiest way to get started is my importing swipl-wasm into your npm project.
+It imported for both node and browser builds as follows:
+
+script.js
+```js
+import SWIPL from "swipl-wasm";
+
+async function main() {
+  const swipl = await SWIPL({ arguments: ["-q"] });
+  console.log(swipl.prolog.query("member(X, [a, b, c]).").once().X);
+}
+
+main();
+```
+
+For those who have not done this before you will first need to [install node and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
+After doing this you can make a new project as follows:
+
+```bash
+# Make the project directory
+mkdir my-swipl-project && cd ./my-swipl-project
+# Initialise the project
+npm init
+# Install swipl-wasm
+npm i swipl-wasm
+```
+
+After this place the above code in `script.js` in the root of your directory and run `node script.js`
+to run the script.
+
 ## Usage
 
 In browser:
@@ -38,7 +70,7 @@ visiting <http://localhost:8080/examples/browser.html>.
 In Nodejs:
 
 ```js
-const SWIPL = require("swipl-wasm/dist/swipl");
+const SWIPL = require("swipl-wasm");
 
 const swipl = await SWIPL({ arguments: ["-q"] });
 console.log(swipl.prolog.query("member(X, [a, b, c]).").once().X);
@@ -123,10 +155,58 @@ npm run server
 and visit <http://127.0.0.1:8080>. You should see the message "Hello world from
 Prolog".
 
+
+## Browser Builds
+
+For convenience we provide deploy bundled versions of the SWI-Prolog on github pages which can be directly used in an HTML document.
+
+There is a bundled version for each release - which can be found at the url:
+<p align=center>
+https://SWI-Prolog.github.io/npm-swipl-wasm/vMajor/vMinor/vPatch/index.js
+
+for instance v3.3.0 has the url https://SWI-Prolog.github.io/npm-swipl-wasm/3/3/0/index.js. We also have shortcuts for:
+ - the latest version https://SWI-Prolog.github.io/npm-swipl-wasm/latest/index.js,
+ - the latest of each major version https://SWI-Prolog.github.io/npm-swipl-wasm/vMajor/latest/index.js, and
+ - the latest of each minor version https://SWI-Prolog.github.io/npm-swipl-wasm/vMajor/vMinor/latest/index.js
+
+Available versions can be browsed at https://github.com/SWI-Prolog/npm-swipl-wasm/tree/pages.
+
+With this approach the following script will work
+
+```html
+<div id="solution"></div>
+<script src="https://SWI-Prolog.github.io/npm-swipl-wasm/3/3/0/index.js"></script>
+<script>
+  (async () => {
+    const swipl = await SWIPL({ arguments: ["-q"] });
+    const query = "member(X, [a, b, c]).";
+    const solutionElement = document.getElementById("solution");
+    const firstSolution = swipl.prolog.query(query).once().X;
+    solutionElement.textContent = firstSolution;
+  })();
+</script>
+```
+
+Dynamic imports are also available with the `dynamic-import.js` import name and can be used as follows:
+
+```html
+<div id="solution"></div>
+<script>
+  (async () => {
+    const { SWIPL } = await import("https://SWI-Prolog.github.io/npm-swipl-wasm/3/3/0/dynamic-import.js");
+    const swipl = await SWIPL({ arguments: ["-q"] });
+    const query = "member(X, [a, b, c]).";
+    const solutionElement = document.getElementById("solution");
+    const firstSolution = swipl.prolog.query(query).once().X;
+    solutionElement.textContent = firstSolution;
+  })();
+</script>
+```
+
 ## Build
 
-The package can be built using npm or yarn. Please use yarn to
-add new dependencies and update yarn.lock file. SWI-Prolog WebAssembly
+The package can be built using npm. Please use npm to
+add new dependencies and update package-lock.json file. SWI-Prolog WebAssembly
 version is currently built inside Docker with Emscripten.
 
 ## Versioning

package/dist/generateImage.js

@@ -16,7 +16,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateLoadedImageFile = exports.generateImageFile = exports.generateLoadedImageFileString = exports.generateImageFileString = exports.generateImageString = exports.generateImageBuffer = void 0;
 const swipl_bundle_1 = __importDefault(require("./swipl/swipl-bundle"));
 const fs_1 = __importDefault(require("fs"));
-const cross_fetch_1 = require("cross-fetch");
+const universal_fetch_1 = require("@inrupt/universal-fetch");
 function Uint8ToString(u8a) {
     const CHUNK_SZ = 0x8000;
     const c = [];
@@ -61,7 +61,7 @@ function generateLoadedImageFileString(prolog) {
 exports.generateLoadedImageFileString = generateLoadedImageFileString;
 function dereference(prologPath) {
     return (prologPath.startsWith('http://') || prologPath.startsWith('https://'))
-        ? (0, cross_fetch_1.fetch)(prologPath).then((res) => res.text())
+        ? (0, universal_fetch_1.fetch)(prologPath).then((res) => res.text())
         : fs_1.default.readFileSync(prologPath);
 }
 function generateImageFile(prologPath, jsPath) {