npm - koffi - Versions diffs - 2.5.7 → 2.5.9 - Mend

koffi 2.5.7 → 2.5.9

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 (78) hide show

package/src/koffi/examples/electron-builder/README.md ADDED Viewed

@@ -0,0 +1,23 @@
+This is a simple example shows:
+- How to communicate with Koffi from a renderer window
+- How to use electron-builder with an application that uses Koffi
+One of the important piece for the packaging is in `package.json`, specifically this part:
+```json
+  "build": {
+    "extraResources": [
+      { "from": "node_modules/koffi/build", "to": "koffi" }
+    ]
+  }
+```
+This instructs electron-builder to copy the native koffi modules to a place where your application will find them.
+Use the following commands to package the app for your system:
+```sh
+npm install
+npm run dist
+```

package/src/koffi/examples/electron-builder/package.json ADDED Viewed

@@ -0,0 +1,21 @@
+{
+  "name": "Koffi Config",
+  "version": "1.0.0",
+  "description": "Koffi Electron Example",
+  "main": "src/app.js",
+  "scripts": {
+    "start": "electron .",
+    "pack": "electron-builder --dir",
+    "dist": "electron-builder"
+  },
+  "author": "Niels Martignène <niels.martignene@protonmail.com>",
+  "license": "MIT",
+  "devDependencies": {
+    "electron": "^25.3.2",
+    "electron-builder": "^24.6.3",
+    "esbuild": "^0.18.17"
+  },
+  "dependencies": {
+    "koffi": "^2.5.8"
+  }
+}

package/src/koffi/examples/electron-builder/src/app.js ADDED Viewed

@@ -0,0 +1,20 @@
+const { app, BrowserWindow, ipcMain } = require('electron');
+const koffi = require('koffi');
+app.whenReady().then(() => {
+    ipcMain.handle('koffi:config', (e, ...args) => koffi.config(...args));
+    createWindow();
+});
+function createWindow() {
+    const win = new BrowserWindow({
+        width: 800,
+        height: 600,
+        webPreferences: {
+            preload: __dirname + '/preload.js'
+        }
+    });
+    win.loadFile(__dirname + '/index.html');
+};

package/src/koffi/examples/electron-builder/src/index.html ADDED Viewed

@@ -0,0 +1,143 @@
+<!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>
+            update();
+            async function update() {
+                let config = await window.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 = await 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 {
+                    await 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/electron-builder/src/preload.js ADDED Viewed

@@ -0,0 +1,5 @@
+const { contextBridge, ipcRenderer } = require('electron');
+contextBridge.exposeInMainWorld('koffi', {
+    config: (...args) => ipcRenderer.invoke('koffi:config', ...args)
+})

package/src/koffi/examples/electron-forge/README.md ADDED Viewed

@@ -0,0 +1,25 @@
+This is a simple example based on electron-forge coupled with webpack, and using Koffi.
+The initial structure was generated with the following command:
+```sh
+npm init electron-app@latest my-app -- --template=webpack
+```
+To run the app, execute the following:
+```sh
+cd examples/electron-forge
+npm install
+npm start
+```
+You can also use electron-forge to package the app directly:
+```sh
+cd examples/electron-forge
+npm install
+npm run make
+```
+Things should just work :)

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

@@ -0,0 +1,43 @@
+module.exports = {
+  packagerConfig: {
+    asar: true,
+  },
+  rebuildConfig: {},
+  makers: [
+    {
+      name: '@electron-forge/maker-squirrel',
+      config: {},
+    },
+    {
+      name: '@electron-forge/maker-zip',
+      config: {},
+    }
+  ],
+  plugins: [
+    {
+      name: '@electron-forge/plugin-auto-unpack-natives',
+      config: {},
+    },
+    {
+      name: '@electron-forge/plugin-webpack',
+      config: {
+        mainConfig: './webpack.main.config.js',
+        renderer: {
+          config: './webpack.renderer.config.js',
+          entryPoints: [
+            {
+              html: './src/index.html',
+              js: './src/renderer.js',
+              name: 'main_window',
+              preload: {
+                js: './src/preload.js',
+              },
+            },
+          ],
+        },
+        "port": 3001,
+        "loggerPort": 9001
+      },
+    },
+  ],
+};

package/src/koffi/examples/electron-forge/package.json ADDED Viewed

@@ -0,0 +1,37 @@
+{
+  "name": "Koffi Config",
+  "version": "1.0.0",
+  "description": "Koffi Electron Example",
+  "main": ".webpack/main",
+  "scripts": {
+    "start": "electron-forge start",
+    "package": "electron-forge package",
+    "make": "electron-forge make",
+    "publish": "electron-forge publish",
+    "lint": "echo \"No linting configured\""
+  },
+  "keywords": [],
+  "author": {
+    "name": "Niels Martignène",
+    "email": "niels.martignene@protonmail.com"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@electron-forge/cli": "^6.2.1",
+    "@electron-forge/maker-deb": "^6.2.1",
+    "@electron-forge/maker-rpm": "^6.2.1",
+    "@electron-forge/maker-squirrel": "^6.2.1",
+    "@electron-forge/maker-zip": "^6.2.1",
+    "@electron-forge/plugin-auto-unpack-natives": "^6.2.1",
+    "@electron-forge/plugin-webpack": "^6.2.1",
+    "@vercel/webpack-asset-relocator-loader": "^1.7.3",
+    "css-loader": "^6.8.1",
+    "electron": "25.3.2",
+    "node-loader": "^2.0.0",
+    "style-loader": "^3.3.3"
+  },
+  "dependencies": {
+    "electron-squirrel-startup": "^1.0.0",
+    "koffi": "^2.5.8"
+  }
+}

package/src/koffi/examples/electron-forge/src/index.css ADDED Viewed

@@ -0,0 +1,7 @@
+body {
+  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica,
+    Arial, sans-serif;
+  margin: auto;
+  max-width: 38rem;
+  padding: 2rem;
+}

package/src/koffi/examples/electron-forge/src/index.html ADDED Viewed

@@ -0,0 +1,143 @@
+<!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>
+            update();
+            async function update() {
+                let config = await window.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 = await 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 {
+                    await 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/electron-forge/src/main.js ADDED Viewed

@@ -0,0 +1,52 @@
+const { app, BrowserWindow, ipcMain } = require('electron');
+const path = require('path');
+const koffi = require('koffi');
+// Handle creating/removing shortcuts on Windows when installing/uninstalling.
+if (require('electron-squirrel-startup')) {
+  app.quit();
+}
+const createWindow = () => {
+  // Create the browser window.
+  const mainWindow = new BrowserWindow({
+    width: 800,
+    height: 600,
+    webPreferences: {
+      preload: MAIN_WINDOW_PRELOAD_WEBPACK_ENTRY,
+    },
+  });
+  // and load the index.html of the app.
+  mainWindow.loadURL(MAIN_WINDOW_WEBPACK_ENTRY);
+  // Open the DevTools.
+  mainWindow.webContents.openDevTools();
+};
+// This method will be called when Electron has finished
+// initialization and is ready to create browser windows.
+// Some APIs can only be used after this event occurs.
+app.on('ready', createWindow);
+// Quit when all windows are closed, except on macOS. There, it's common
+// for applications and their menu bar to stay active until the user quits
+// explicitly with Cmd + Q.
+app.on('window-all-closed', () => {
+  if (process.platform !== 'darwin') {
+    app.quit();
+  }
+});
+app.on('activate', () => {
+  // On OS X it's common to re-create a window in the app when the
+  // dock icon is clicked and there are no other windows open.
+  if (BrowserWindow.getAllWindows().length === 0) {
+    createWindow();
+  }
+});
+// In this file you can include the rest of your app's specific main process
+// code. You can also put them in separate files and import them here.
+ipcMain.handle('koffi:config', (e, ...args) => koffi.config(...args));

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

@@ -0,0 +1,5 @@
+const { contextBridge, ipcRenderer } = require('electron');
+contextBridge.exposeInMainWorld('koffi', {
+    config: (...args) => ipcRenderer.invoke('koffi:config', ...args)
+})

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

@@ -0,0 +1,31 @@
+/**
+ * This file will automatically be loaded by webpack and run in the "renderer" context.
+ * To learn more about the differences between the "main" and the "renderer" context in
+ * Electron, visit:
+ *
+ * https://electronjs.org/docs/tutorial/application-architecture#main-and-renderer-processes
+ *
+ * By default, Node.js integration in this file is disabled. When enabling Node.js integration
+ * in a renderer process, please be aware of potential security implications. You can read
+ * more about security risks here:
+ *
+ * https://electronjs.org/docs/tutorial/security
+ *
+ * To enable Node.js integration in this file, open up `main.js` and enable the `nodeIntegration`
+ * flag:
+ *
+ * ```
+ *  // Create the browser window.
+ *  mainWindow = new BrowserWindow({
+ *    width: 800,
+ *    height: 600,
+ *    webPreferences: {
+ *      nodeIntegration: true
+ *    }
+ *  });
+ * ```
+ */
+import './index.css';
+console.log('👋 This message is being logged by "renderer.js", included via webpack');

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/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"
+  }
+}