@sqlite.org/sqlite-wasm - npm Package Compare versions

Comparing version 0.0.4 to 3.41.2-build10

bin/index.js

@@ -27,3 +27,5 @@ import fs from 'fs';
     filter: (file) =>
-      /jswasm/.test(file.path) && /(?:\.mjs|\.wasm|proxy\.js)$/.test(file.path),
+      !file.path.endsWith('sqlite3.mjs') &&
+      /jswasm/.test(file.path) &&
+      /(?:\.mjs|\.wasm|proxy\.js)$/.test(file.path),
   });
@@ -30,0 +32,0 @@ console.log(

package.json

 {
   "name": "@sqlite.org/sqlite-wasm",
-  "version": "0.0.4",
+  "version": "3.41.2-build10",
   "description": "SQLite Wasm conveniently wrapped as an ES Module.",
+  "keywords": [
+    "sqlite",
+    "sqlite3",
+    "sqlite-wasm",
+    "sqlite3-wasm",
+    "webassembly",
+    "wasm",
+    "esm",
+    "opfs",
+    "origin-private-file-system"
+  ],
   "main": "index.mjs",
@@ -28,3 +39,4 @@ "type": "module",
     "start": "npx http-server --coop",
-    "fix": "npx prettier . --write"
+    "fix": "npx prettier . --write",
+    "deploy": "npm run prepare && git commit -am 'New release' && git push && npm publish --access public"
   },
@@ -31,0 +43,0 @@ "repository": {

README.md

@@ -1,1 +0,135 @@
-# sqlite-wasm
+# SQLite Wasm
+
+SQLite Wasm conveniently wrapped as an ES Module.
+
+## Installation
+
+```bash
+npm install @sqlite.org/sqlite-wasm
+```
+
+## Usage
+
+There are two ways to use SQLite Wasm:
+[in the main thread](#in-the-main-thread-without-opfs) and
+[in a worker](#in-a-worker-with-opfs-if-available). Only the worker version
+allows you to use the origin private file system (OPFS) storage back-end.
+
+### In the main thread (without OPFS):
+
+```js
+import sqlite3InitModule from '@sqlite.org/sqlite-wasm';
+
+const log = (...args) => console.log(...args);
+const error = (...args) => console.error(...args);
+
+const start = function (sqlite3) {
+  log('Running SQLite3 version', sqlite3.version.libVersion);
+  const db = new sqlite3.oo1.DB('/mydb.sqlite3', 'ct');
+  // Your SQLite code here.
+};
+
+log('Loading and initializing SQLite3 module...');
+sqlite3InitModule({
+  print: log,
+  printErr: error,
+}).then((sqlite3) => {
+  try {
+    log('Done initializing. Running demo...');
+    start(sqlite3);
+  } catch (err) {
+    error(err.name, err.message);
+  }
+});
+```
+
+### In a worker (with OPFS if available):
+
+> **Warning** For this to work, you need to set the following headers on your
+> server:
+>
+> `Cross-Origin-Opener-Policy: same-origin`
+>
+> `Cross-Origin-Embedder-Policy: require-corp`
+
+```js
+// In `main.js`.
+const worker = new Worker('worker.js', { type: 'module' });
+```
+
+```js
+// In `worker.js`.
+import sqlite3InitModule from '@sqlite.org/sqlite-wasm';
+
+const log = (...args) => console.log(...args);
+const error = (...args) => console.error(...args);
+
+const start = function (sqlite3) {
+  log('Running SQLite3 version', sqlite3.version.libVersion);
+  let db;
+  if ('opfs' in sqlite3) {
+    db = new sqlite3.oo1.OpfsDb('/mydb.sqlite3');
+    log('OPFS is available, created persisted database at', db.filename);
+  } else {
+    db = new sqlite3.oo1.DB('/mydb.sqlite3', 'ct');
+    log('OPFS is not available, created transient database', db.filename);
+  }
+  // Your SQLite code here.
+};
+
+log('Loading and initializing SQLite3 module...');
+sqlite3InitModule({
+  print: log,
+  printErr: error,
+}).then((sqlite3) => {
+  log('Done initializing. Running demo...');
+  try {
+    start(sqlite3);
+  } catch (err) {
+    error(err.name, err.message);
+  }
+});
+```
+
+## Usage with vite
+
+If you are using [vite](https://vitejs.dev/), you need to add the following
+config option:
+
+```js
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+  optimizeDeps: {
+    exclude: ['@sqlite.org/sqlite-wasm'],
+  },
+});
+```
+
+Check out a
+[sample project](https://stackblitz.com/edit/vitejs-vite-3rk63d?file=main.js)
+that shows this in action.
+
+## Deploying a new version
+
+(These steps can only be executed by maintainers.)
+
+1. Update the version number in `package.json` reflecting the current
+   [SQLite version number](https://sqlite.org/download.html) and add a build
+   identifier suffix like `-build1`. The complete version number should read
+   something like `3.41.2-build1`.
+1. Run `npm run build` to build the ES Module. This downloads the latest SQLite
+   Wasm binary and builds the ES Module.
+1. Run `git commit -am "Release v<version>"` to commit the changes.
+1. Run `git push` to push the changes to GitHub.
+1. Run `npm publish --access-public` to publish the new version to npm.
+
+## License
+
+Apache 2.0.
+
+## Acknowledgements
+
+This project is based on [SQLite Wasm](https://sqlite.org/wasm), which it
+conveniently wraps as an ES Module and publishes to npm as
+[`@sqlite.org/sqlite-wasm`](https://www.npmjs.com/package/@sqlite.org/sqlite-wasm).

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

136

increased by6700%

Number of low supply chain risk alerts

2

decreased by-33.33%

Number of medium supply chain risk alerts

9

decreased by-40%

Worsened metrics

Total package byte prevSize

1346132

decreased by-24.44%

Number of downloads

5962

decreased by-8.91%

Number of package files

7

decreased by-12.5%

Lines of code

13189

decreased by-48%

No dependency changes