npm - koffi - Versions diffs - 2.5.8 → 2.5.10 - Mend

koffi 2.5.8 → 2.5.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (59) hide show

package/CHANGELOG.md +15 -99
package/build/{2.5.8 → koffi}/darwin_arm64/koffi.node +0 -0
package/build/{2.5.8 → koffi}/darwin_x64/koffi.node +0 -0
package/build/{2.5.8 → koffi}/freebsd_arm64/koffi.node +0 -0
package/build/{2.5.8 → koffi}/freebsd_ia32/koffi.node +0 -0
package/build/{2.5.8 → koffi}/freebsd_x64/koffi.node +0 -0
package/build/koffi/linux_arm32hf/koffi.node +0 -0
package/build/{2.5.8 → koffi}/linux_arm64/koffi.node +0 -0
package/build/{2.5.8 → koffi}/linux_ia32/koffi.node +0 -0
package/build/{2.5.8 → koffi}/linux_riscv64hf64/koffi.node +0 -0
package/build/{2.5.8 → koffi}/linux_x64/koffi.node +0 -0
package/build/koffi/openbsd_ia32/koffi.node +0 -0
package/build/{2.5.8 → koffi}/openbsd_x64/koffi.node +0 -0
package/build/{2.5.8 → koffi}/win32_arm64/koffi.node +0 -0
package/build/{2.5.8 → koffi}/win32_ia32/koffi.node +0 -0
package/build/{2.5.8 → koffi}/win32_x64/koffi.node +0 -0
package/doc/conf.py +2 -1
package/doc/index.rst +1 -0
package/doc/packaging.md +71 -0
package/doc/start.md +1 -36
package/package.json +2 -2
package/src/cnoke/assets/FindCNoke.cmake +16 -0
package/src/core/libcc/libcc.cc +13 -9
package/src/core/libcc/libcc.hh +2 -1
package/src/index.d.ts +4 -0
package/src/index.js +53 -24
package/src/koffi/CMakeLists.txt +10 -0
package/src/koffi/examples/electron-builder/README.md +11 -0
package/src/koffi/examples/electron-builder/package.json +21 -0
package/src/koffi/examples/electron-builder/src/app.js +20 -0
package/src/koffi/examples/electron-builder/src/index.html +143 -0
package/src/koffi/examples/electron-builder/src/preload.js +5 -0
package/src/koffi/examples/electron-forge/README.md +25 -0
package/src/koffi/examples/electron-forge/forge.config.js +43 -0
package/src/koffi/examples/electron-forge/package.json +37 -0
package/src/koffi/examples/electron-forge/src/index.css +7 -0
package/src/koffi/examples/electron-forge/src/index.html +143 -0
package/src/koffi/examples/electron-forge/src/main.js +52 -0
package/src/koffi/examples/electron-forge/src/preload.js +5 -0
package/src/koffi/examples/electron-forge/src/renderer.js +31 -0
package/src/koffi/examples/electron-forge/webpack.main.config.js +11 -0
package/src/koffi/examples/electron-forge/webpack.renderer.config.js +13 -0
package/src/koffi/examples/electron-forge/webpack.rules.js +35 -0
package/src/koffi/examples/node-esbuild/README.md +19 -0
package/src/koffi/examples/node-esbuild/index.js +2 -0
package/src/koffi/examples/node-esbuild/package.json +16 -0
package/src/koffi/examples/nwjs/README.md +20 -0
package/src/koffi/examples/nwjs/package.json +11 -0
package/src/koffi/examples/nwjs/src/index.html +145 -0
package/src/koffi/examples/nwjs/src/package.json +10 -0
package/src/koffi/src/ffi.cc +1 -0
package/build/2.5.8/linux_arm32hf/koffi.node +0 -0
package/build/2.5.8/openbsd_ia32/koffi.node +0 -0
/package/build/{2.5.8 → koffi}/win32_arm64/koffi.exp +0 -0
/package/build/{2.5.8 → koffi}/win32_arm64/koffi.lib +0 -0
/package/build/{2.5.8 → koffi}/win32_ia32/koffi.exp +0 -0
/package/build/{2.5.8 → koffi}/win32_ia32/koffi.lib +0 -0
/package/build/{2.5.8 → koffi}/win32_x64/koffi.exp +0 -0
/package/build/{2.5.8 → koffi}/win32_x64/koffi.lib +0 -0

package/src/koffi/examples/electron-forge/webpack.main.config.js ADDED Viewed

@@ -0,0 +1,11 @@
+module.exports = {
+  /**
+   * This is the main entry point for your application, it's the first file
+   * that runs in the main process.
+   */
+  entry: './src/main.js',
+  // Put your normal webpack config below here
+  module: {
+    rules: require('./webpack.rules'),
+  },
+};

package/src/koffi/examples/electron-forge/webpack.renderer.config.js ADDED Viewed

@@ -0,0 +1,13 @@
+const rules = require('./webpack.rules');
+rules.push({
+  test: /\.css$/,
+  use: [{ loader: 'style-loader' }, { loader: 'css-loader' }],
+});
+module.exports = {
+  // Put your normal webpack config below here
+  module: {
+    rules,
+  },
+};

package/src/koffi/examples/electron-forge/webpack.rules.js ADDED Viewed

@@ -0,0 +1,35 @@
+module.exports = [
+  // Add support for native node modules
+  {
+    // We're specifying native_modules in the test because the asset relocator loader generates a
+    // "fake" .node file which is really a cjs file.
+    test: /native_modules[/\\].+\.node$/,
+    use: 'node-loader',
+  },
+  {
+    test: /[/\\]node_modules[/\\].+\.(m?js|node)$/,
+    parser: { amd: false },
+    use: {
+      loader: '@vercel/webpack-asset-relocator-loader',
+      options: {
+        outputAssetBase: 'native_modules',
+      },
+    },
+  },
+  // Put your webpack loader rules in this array.  This is where you would put
+  // your ts-loader configuration for instance:
+  /**
+   * Typescript Example:
+   *
+   * {
+   *   test: /\.tsx?$/,
+   *   exclude: /(node_modules|.webpack)/,
+   *   loaders: [{
+   *     loader: 'ts-loader',
+   *     options: {
+   *       transpileOnly: true
+   *     }
+   *   }]
+   * }
+   */
+];

package/src/koffi/examples/node-esbuild/README.md ADDED Viewed

@@ -0,0 +1,19 @@
+This is a simple example to bundle a CLI node.js app that uses Koffi, using esbuild.
+To run the app, execute the following:
+```sh
+cd examples/node-esbuild
+npm install
+npm start
+```
+You can bundle the script and the native modules with the following command
+```sh
+cd examples/node-esbuild
+npm install
+npm run bundle
+```
+Internally, this uses the esbuild copy loader to handle the native `.node` modules.

package/src/koffi/examples/node-esbuild/index.js ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ const koffi = require('koffi');
2	+ console.log(koffi.config());

package/src/koffi/examples/node-esbuild/package.json ADDED Viewed

@@ -0,0 +1,16 @@
+{
+  "name": "KoffiConfig",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "start": "node index.js",
+    "bundle": "esbuild index.js --platform=node --bundle --loader:.node=copy --outdir=dist/"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "esbuild": "^0.18.17",
+    "koffi": "^2.5.9"
+  }
+}

package/src/koffi/examples/nwjs/README.md ADDED Viewed

@@ -0,0 +1,20 @@
+This is a simple example shows:
+- How to communicate with Koffi from a simple window (NW.js takes care of the annonying parts)
+- How to use [nw-builder](https://nwutils.io/nw-builder/) to package it
+To run this example, you need to install NW.js (SDK flavor) from https://nwjs.io/
+```sh
+cd examples/nwjs/src
+npm install # Install Koffi
+/path/to/nw .
+```
+You can also use nw-builder to package the app directly:
+```sh
+cd examples/nwjs
+npm install
+npm run pack
+```

package/src/koffi/examples/nwjs/package.json ADDED Viewed

@@ -0,0 +1,11 @@
+{
+  "name": "Koffi Config",
+  "author": "Niels Martignène <niels.martignene@protonmail.com>",
+  "license": "MIT",
+  "scripts": {
+    "pack": "cd src && npm install && cd .. && nwbuild --glob=false src"
+  },
+  "devDependencies": {
+    "nw-builder": "^4.3.3"
+  }
+}

package/src/koffi/examples/nwjs/src/index.html ADDED Viewed

@@ -0,0 +1,145 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta charset="UTF-8">
+        <title>Koffi Configuration</title>
+        <style>
+            html {
+                height: 100%;
+            }
+            body {
+                font-family: 'Open Sans', sans-serif;
+                display: flex;
+                min-height: calc(100% - 17px);
+                align-items: center;
+                justify-content: center;
+                font-size: 14px;
+            }
+            #error {
+                position: fixed;
+                top: 50px;
+                left: calc(50% - 200px);
+                width: 400px;
+                padding: 8px;
+                background: #db0a0a;
+                color: white;
+                box-shadow: 1px 1px rgba(0, 0, 0, 0.5);
+                text-align: center;
+            }
+            #error:empty { display: none; }
+            #config {
+                background: #f8f8f8;
+                border-radius: 8px;
+                padding: 1em;
+                font-size: 1.2em;
+            }
+            form {
+                display: flex;
+                flex-direction: column;
+                gap: 0.5em;
+            }
+            label {
+                display: flex;
+                gap: 12px;
+            }
+            label > span { width: 200px; }
+            label > :not(span) { flex: 1; }
+            button {
+                margin-top: 1em;
+                background: white;
+                border: white;
+                border-radius: 6px;
+                padding: 6px;
+                cursor: pointer;
+            }
+            button:hover { background: #ededed; }
+        </style>
+    </head>
+    <body>
+        <div id="error"></div>
+        <div id="config"></div>
+        <script>
+            const koffi = require('koffi');
+            update();
+            function update() {
+                let config = koffi.config();
+                let container = document.querySelector('#config');
+                let form = document.createElement('form');
+                form.addEventListener('submit', e => { e.preventDefault(); apply(e.target.elements); });
+                for (let key in config) {
+                    let value = config[key];
+                    if (typeof value != 'number')
+                        continue;
+                    let label = document.createElement('label');
+                    let span = document.createElement('span');
+                    let input = document.createElement('input');
+                    span.textContent = key;
+                    input.name = key;
+                    input.type = 'number';
+                    input.value = config[key];
+                    label.appendChild(span);
+                    label.appendChild(input);
+                    form.appendChild(label);
+                }
+                let button = document.createElement('button');
+                button.textContent = 'Modifier';
+                button.type = 'submit';
+                form.appendChild(button);
+                window.requestAnimationFrame(() => {
+                    container.innerHTML = '';
+                    container.appendChild(form);
+                });
+            }
+            async function apply(elements) {
+                let config = koffi.config();
+                for (let key in elements) {
+                    if (!config.hasOwnProperty(key))
+                        continue;
+                    let value = elements[key].valueAsNumber;
+                    if (typeof value == 'number')
+                        config[key] = value;
+                }
+                try {
+                    koffi.config(config);
+                } catch (err) {
+                    console.error(err);
+                    flashError(err.message);
+                }
+                update();
+            }
+            function flashError(msg) {
+                let div = document.querySelector('#error');
+                if (flashError.timer != null)
+                    clearTimeout(flashError.timer);
+                flashError.timer = setTimeout(() => { div.textContent = '' }, 4000);
+                div.textContent = msg;
+            }
+        </script>
+    </body>
+</html>

package/src/koffi/examples/nwjs/src/package.json ADDED Viewed

@@ -0,0 +1,10 @@
+{
+  "name": "KoffiConfig",
+  "version": "1.0.0",
+  "main": "index.html",
+  "author": "Niels Martignène <niels.martignene@protonmail.com>",
+  "license": "MIT",
+  "dependencies": {
+    "koffi": "^2.5.9"
+  }
+}

package/src/koffi/src/ffi.cc CHANGED Viewed

@@ -2168,6 +2168,7 @@ static Napi::Object InitModule(Napi::Env env, Napi::Object exports)
     exports.Set("types", types);
     exports.Set("internal", Napi::Boolean::New(env, false));
+    exports.Set("version", Napi::String::New(env, RG_STRINGIFY(VERSION)));
     return exports;
 }