@webreflection/utils 0.0.0 → 0.1.1

package/.github/dependabot.yml

@@ -0,0 +1,13 @@
+# Keep GitHub Actions up to date with GitHub's Dependabot...
+# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#package-ecosystem
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    groups:
+      github-actions:
+        patterns:
+          - "*"  # Group all Actions updates into a single larger pull request
+    schedule:
+      interval: weekly

package/.github/workflows/node.js.yml

@@ -0,0 +1,31 @@
+# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [22]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run build --if-present
+    - run: npm run test
+    - run: npm run coverage --if-present
+    - name: Coveralls
+      uses: coverallsapp/github-action@master
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}

package/README.md

@@ -0,0 +1,18 @@
+# @webreflection/utils
+
+[![Coverage Status](https://coveralls.io/repos/github/WebReflection/utils/badge.svg?branch=main)](https://coveralls.io/github/WebReflection/utils?branch=main)
+
+<sup>**Social Media Photo by [benjamin lehman](https://unsplash.com/@abject) on [Unsplash](https://unsplash.com/)**</sup>
+
+
+A [collection](./src/) of utility functions.
+
+```js
+// example: a shim based on ArrayBuffer if native is `false`
+import { SharedArrayBuffer, native } from 'https://esm.run/@webreflection/utils/shared-array-buffer';
+
+// example: self bound Promise.withResolvers()
+import withResolvers from 'https://esm.run/@webreflection/utils/with-resolvers';
+
+const { promise, resolve, reject } = withResolvers();
+```

package/package.json

@@ -1,13 +1,37 @@
 {
   "name": "@webreflection/utils",
-  "version": "0.0.0",
+  "version": "0.1.1",
   "type": "module",
   "exports": {
+    "./shared-array-buffer": "./src/shared-array-buffer.js",
     "./with-resolvers": "./src/with-resolvers.js",
     "./package.json": "./package.json"
   },
-  "keywords": ["shared", "utility", "utils"],
+  "tests": [
+    "shared-array-buffer",
+    "with-resolvers"
+  ],
+  "scripts": {
+    "coverage": "mkdir -p ./coverage; c8 report --reporter=text-lcov > ./coverage/lcov.info",
+    "test": "c8 node -e 'let q=Promise.resolve();for(const t of require(`./package.json`).tests)q=q.then(()=>import(`./test/${t}.js`));'"
+  },
+  "keywords": [
+    "shared",
+    "utility",
+    "utils"
+  ],
   "author": "Andrea Giammarchi",
   "license": "MIT",
-  "description": "A collection of utility functions"
+  "description": "A collection of utility functions",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/WebReflection/utils.git"
+  },
+  "bugs": {
+    "url": "https://github.com/WebReflection/utils/issues"
+  },
+  "homepage": "https://github.com/WebReflection/utils#readme",
+  "devDependencies": {
+    "c8": "^10.1.3"
+  }
 }

package/src/shared-array-buffer.js

@@ -0,0 +1,28 @@
+//@ts-check
+
+let { SharedArrayBuffer: SAB } = globalThis, native = true;
+
+try {
+  //@ts-ignore due valid options not recognized
+  new SAB(4, { maxByteLength: 8 });
+}
+catch (_) {
+  native = false;
+  SAB = /** @type {SharedArrayBufferConstructor} */(
+    /** @type {unknown} */(
+      class SharedArrayBuffer extends ArrayBuffer {
+        get growable() {
+          //@ts-ignore due valid property not recognized
+          return super.resizable;
+        }
+        /** @param {number} newLength */
+        grow(newLength) {
+          //@ts-ignore due valid method not recognized
+          super.resize(newLength);
+        }
+      }
+    )
+  );
+}
+
+export { SAB as SharedArrayBuffer, native };

package/test/shared-array-buffer.js

@@ -0,0 +1,22 @@
+const { SharedArrayBuffer: SAB } = globalThis;
+
+globalThis.SharedArrayBuffer = null;
+
+const { SharedArrayBuffer, native } = await import("../src/shared-array-buffer.js");
+
+globalThis.SharedArrayBuffer = SAB;
+
+console.assert(!native);
+
+const gsab = new SharedArrayBuffer(4, { maxByteLength: 8 });
+
+console.assert(gsab.byteLength === 4);
+console.assert(gsab.growable);
+
+gsab.grow(8);
+
+console.assert(gsab.byteLength === 8);
+
+const fsab = new SharedArrayBuffer(6);
+console.assert(fsab.byteLength === 6);
+console.assert(!fsab.growable);

package/test/with-resolvers.js

@@ -0,0 +1,11 @@
+import withResolvers from '../src/with-resolvers.js';
+
+const { promise, resolve, reject } = withResolvers();
+
+console.assert(typeof reject === 'function');
+console.assert(typeof resolve === 'function');
+console.assert(promise instanceof Promise);
+
+resolve('OK');
+
+console.log(await promise);