Gathering detailed insights and metrics for @biowasm/aioli
Gathering detailed insights and metrics for @biowasm/aioli
Framework for building fast genomics web tools with WebAssembly and WebWorkers
Installations
npm install @biowasm/aioliDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
21.7.3
NPM Version
10.5.0
Score
72.9
Supply Chain
85.5
Quality
78.4
Maintenance
100
Vulnerability
100
License
Releases
21
Languages
2
JavaScript
HTML
JavaScript (96.45%)
HTML (3.55%)
Developer
biowasm
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
113 Stars
264 Commits
11 Forks
3 Watchers
2 Branches
4 Contributors
Updated on Jul 09, 2025
Maintainers
1
Package Meta Information
Latest Version
3.2.1
Package Id
@biowasm/aioli@3.2.1
Unpacked Size
40.80 kB
Size
12.92 kB
File Count
5
NPM Version
10.5.0
Node Version
21.7.3
Published on
Oct 14, 2024
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
2
Aioli
Aioli is a library for running genomics command-line tools in the browser using WebAssembly. See Who uses biowasm for example use cases.
Getting started
Development
Setup
Run npm install to install dependencies.
Then run npm run dev to launch the web server and use src/example.js as a sample web app that uses the dev version of Aioli.
Tests
Run npm run test.
Deploy a new release candidate
- Update version in
package.json(append-rc1for release candidates) - Build:
npm run build - Create npm package:
npm pack - Publish package:
npm publish [tgzfile] --tag next - To use pre-release version:
npm install @biowasm/aioli@next
Deploy a new version
- Update version in
package.json - Build:
npm run build - Publish package:
npm publish --access public - Create release in the GitHub repo
- Add to
biowasm.json - Deploy biowasm CDN with env=stg, tool=aioli and run biowasm tests to validate that stg tests still pass
- Repeat with env=prd
Architecture
- Aioli creates a single WebWorker, in which all WebAssembly tools run.
- We use a PROXYFS virtual filesystem so we can share a filesystem across all WebAssembly modules, i.e. the output of one tool can be used as the input of another tool.
- We use a WORKERFS virtual filesystem to mount local files efficiently (i.e. without having to load all their contents into memory). To support use cases where tools need to create files in the same folder as those ready-only files (e.g.
samtools index), we automatically create a symlink from each local file's WORKERFS path to a path in PROXYFS. - Once the WebWorker initializes, it loads the WebAssembly modules one at a time. To support this, we need to encapsulate each module using Emscripten's
-s MODULARIZE=1, i.e. the.jsfile will contain aModulefunction that initializes the module and returns aPromisethat resolves when the module is loaded. - We do WebAssembly feature detection at initialization using
wasm-feature-detect. If a tool needs WebAssembly SIMD and the user has a browser that does not support it, we will load the non-SIMD version of that tool. - We communicate with the WebWorker using the Comlink library.
Background info
What is WebAssembly?
WebAssembly is a fast, low-level, compiled binary instruction format that runs in all major browsers at near native speeds. One key feature of WebAssembly is code reuse: you can port existing C/C++/Rust/etc tools to WebAssembly so those tools can run in the browser.
What is a WebWorker?
WebWorkers allow you to run JavaScript in the browser in a background thread, which keeps the browser responsive.
Compiling into WebAssembly
See the biowasm project.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
binaries present in source code
Details
- Warn: binary detected: tests/data/bedtools/bedtools.wasm:1
- Warn: binary detected: tests/data/cat/cat.wasm:1
- Warn: binary detected: tests/data/samtools/samtools.wasm:1
- Warn: binary detected: tests/data/seqtk/seqtk.wasm:1
Reason
Found 5/9 approved changesets -- score normalized to 5
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/tests.yml:1
- Info: no jobLevel write permissions found
Reason
0 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/biowasm/aioli/tests.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/tests.yml:22
- Info: 0 out of 1 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 npmCommand dependencies pinned
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 26 are checked with a SAST tool
Reason
13 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-vg6x-rcgg-rjx6
- Warn: Project is vulnerable to: GHSA-x574-m823-4x7w
- Warn: Project is vulnerable to: GHSA-4r4m-qw57-chr8
- Warn: Project is vulnerable to: GHSA-xcj6-pq6g-qj4x
- Warn: Project is vulnerable to: GHSA-356w-63v5-8wf4
- Warn: Project is vulnerable to: GHSA-859w-5945-r5v3
Score
2.6
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More