[HELP WANTED] ICU support

packages/pglite-initdb/.gitignore

@@ -0,0 +1 @@
+release/

packages/pglite-initdb/CHANGELOG.md

@@ -0,0 +1,157 @@
+# @electric-sql/pglite-tools
+
+## 0.2.19
+
+### Patch Changes
+
+- Updated dependencies [8785034]
+- Updated dependencies [90cfee8]
+  - @electric-sql/pglite@0.3.14
+
+## 0.2.18
+
+### Patch Changes
+
+- ad3d0d8: Updated pg_dump to use callback data exchange; built pg_dump with emscripten
+- Updated dependencies [ad3d0d8]
+  - @electric-sql/pglite@0.3.13
+
+## 0.2.17
+
+### Patch Changes
+
+- Updated dependencies [ce0e74e]
+  - @electric-sql/pglite@0.3.12
+
+## 0.2.16
+
+### Patch Changes
+
+- Updated dependencies [9a104b9]
+  - @electric-sql/pglite@0.3.11
+
+## 0.2.15
+
+### Patch Changes
+
+- Updated dependencies [ad765ed]
+  - @electric-sql/pglite@0.3.10
+
+## 0.2.14
+
+### Patch Changes
+
+- e40ccad: Upgrade emsdk
+- Updated dependencies [e40ccad]
+  - @electric-sql/pglite@0.3.9
+
+## 0.2.13
+
+### Patch Changes
+
+- be677b4: fix pg_dump on Windows systems
+
+  When calling **pg_dump** on Windows system the function fails with an error as the one bellow.
+  ❗ Notice the double drive letter
+  `Error: ENOENT: no such file or directory, open 'E:\C:\Users\<USERNAME>\AppData\Local\npm-cache\_npx\ba4f1959e38407b5\node_modules\@electric-sql\pglite-tools\dist\pg_dump.wasm'`
+
+  The problem is in execPgDump function at line
+  `const blob = await fs.readFile(bin.toString().slice(7))`
+  I think the intention here was to remove `file://` from the begging of the path. However this is not necesarry readFile can handle URL objects.
+  Moreover this will fail on Windows becase the slice creates a path like '/C:/<USERNAME>...' and the readFile function will add the extra drive letter
+
+- Updated dependencies [f12a582]
+- Updated dependencies [bd263aa]
+  - @electric-sql/pglite@0.3.8
+
+## 0.2.12
+
+### Patch Changes
+
+- Updated dependencies [0936962]
+  - @electric-sql/pglite@0.3.7
+
+## 0.2.11
+
+### Patch Changes
+
+- Updated dependencies [6898469]
+- Updated dependencies [469be18]
+- Updated dependencies [64e33c7]
+  - @electric-sql/pglite@0.3.6
+
+## 0.2.10
+
+### Patch Changes
+
+- 8172b72: new pg_dump wasm blob
+- Updated dependencies [6653899]
+- Updated dependencies [5f007fc]
+  - @electric-sql/pglite@0.3.5
+
+## 0.2.9
+
+### Patch Changes
+
+- 38a55d0: fix cjs/esm misconfigurations
+- Updated dependencies [1fcaa3e]
+- Updated dependencies [38a55d0]
+- Updated dependencies [aac7003]
+- Updated dependencies [8ca254d]
+  - @electric-sql/pglite@0.3.4
+
+## 0.2.8
+
+### Patch Changes
+
+- Updated dependencies [ea2c7c7]
+  - @electric-sql/pglite@0.3.3
+
+## 0.2.7
+
+### Patch Changes
+
+- Updated dependencies [e2c654b]
+  - @electric-sql/pglite@0.3.2
+
+## 0.2.6
+
+### Patch Changes
+
+- Updated dependencies [713364e]
+  - @electric-sql/pglite@0.3.1
+
+## 0.2.5
+
+### Patch Changes
+
+- 317fd36: Specify a peer dependency range on @electric-sql/pglite
+- Updated dependencies [97e52f7]
+- Updated dependencies [4356024]
+- Updated dependencies [0033bc7]
+  - @electric-sql/pglite@0.3.0
+
+## 0.2.4
+
+### Patch Changes
+
+- bbfa9f1: Restore SEARCH_PATH after pg_dump
+
+## 0.2.3
+
+### Patch Changes
+
+- 8545760: pg_dump error messages set on the thrown Error
+- d26e658: Run a DEALLOCATE ALL after each pg_dump to cleanup the prepared statements.
+
+## 0.2.2
+
+### Patch Changes
+
+- 17c9875: add node imports to the package.json browser excludes
+
+## 0.2.1
+
+### Patch Changes
+
+- 6547374: Alpha version of pg_dump support in the browser and Node using a WASM build of pg_dump

packages/pglite-initdb/README.md

@@ -0,0 +1,72 @@
+# pglite-tools
+
+A selection of tools for working with [PGlite](https://github.com/electric-sql/pglite) databases, including pg_dump.
+
+Install with:
+
+```bash
+npm install @electric-sql/pglite-tools
+```
+
+## `pgDump`
+
+pg_dump is a tool for dumping a PGlite database to a SQL file, this is a WASM build of pg_dump that can be used in a browser or other JavaScript environments. You can read more about pg_dump [in the Postgres docs](https://www.postgresql.org/docs/current/app-pgdump.html).
+
+Note: pg_dump will execute `DEALLOCATE ALL;` after each dump. Since this is running on the same (single) connection, any prepared statements that you have made before running pg_dump will be affected.
+
+### Options
+
+- `pg`: A PGlite instance.
+- `args`: An array of arguments to pass to pg_dump - see [pg_dump docs](https://www.postgresql.org/docs/current/app-pgdump.html) for more details.
+- `fileName`: The name of the file to write the dump to, defaults to `dump.sql`.
+
+There are a number of arguments that are automatically added to the end of the command, these are:
+
+- `--inserts` - use inserts format for the output, this ensures that the dump can be restored by simply passing the output to `pg.exec()`.
+- `-j 1` - concurrency level, set to 1 as multithreading isn't supported.
+- `-f /tmp/out.sql` - the output file is always written to `/tmp/out.sql` in the virtual file system.
+- `-U postgres` - use the postgres user is hard coded.
+
+### Returns
+
+- A `File` object containing the dump.
+
+### Caveats
+
+- After restoring a dump, you might want to set the same search path as the initial db.
+
+### Example
+
+```typescript
+import { PGlite } from '@electric-sql/pglite'
+import { pgDump } from '@electric-sql/pglite-tools/pg_dump'
+
+const pg = await PGlite.create()
+
+// Create a table and insert some data
+await pg.exec(`
+  CREATE TABLE test (
+    id SERIAL PRIMARY KEY,
+    name TEXT
+  );
+`)
+await pg.exec(`
+  INSERT INTO test (name) VALUES ('test');
+`)
+
+// store the current search path so it can be used in the restored db
+const initialSearchPath = (await pg1.query<{ search_path: string }>('SHOW SEARCH_PATH;')).rows[0].search_path
+
+// Dump the database to a file
+const dump = await pgDump({ pg })
+// Get the dump text - used for restore
+const dumpContent = await dump.text()
+
+// Create a new database 
+const restoredPG = await PGlite.create()
+// ... and restore it using the dump
+await restoredPG.exec(dumpContent)
+
+// optional - after importing, set search path back to the initial one
+await restoredPG.exec(`SET search_path TO ${initialSearchPath};`);
+```

packages/pglite-initdb/eslint.config.js

@@ -0,0 +1,29 @@
+import globals from 'globals'
+import rootConfig from '../../eslint.config.js'
+
+export default [
+  ...rootConfig,
+  {
+    ignores: ['release/**/*', 'examples/**/*', 'dist/**/*'],
+  },
+  {
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+        ...globals.node,
+      },
+    },
+    rules: {
+      ...rootConfig.rules,
+      '@typescript-eslint/no-explicit-any': 'off',
+    },
+  },
+  {
+    files: ['tests/targets/deno/**/*.js'],
+    languageOptions: {
+      globals: {
+        Deno: false,
+      },
+    },
+  },
+]

packages/pglite-initdb/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@electric-sql/pglite-initdb",
+  "version": "0.0.1",
+  "description": "initdb as wasm",
+  "author": "Electric DB Limited",
+  "homepage": "https://pglite.dev",
+  "license": "Apache-2.0",
+  "keywords": [
+    "postgres",
+    "sql",
+    "database",
+    "wasm",
+    "pglite",
+    "initdb"
+  ],
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./initdb": {
+      "import": {
+        "types": "./dist/initdb.d.ts",
+        "default": "./dist/initdb.js"
+      },
+      "require": {
+        "types": "./dist/initdb.d.cts",
+        "default": "./dist/initdb.cjs"
+      }
+    }
+  },
+  "scripts": {
+    "build": "tsup",
+    "check:exports": "attw . --pack --profile node16",
+    "lint": "eslint ./src ./tests --report-unused-disable-directives --max-warnings 0",
+    "format": "prettier --write ./src ./tests",
+    "typecheck": "tsc",
+    "stylecheck": "pnpm lint && prettier --check ./src ./tests",
+    "test": "vitest",
+    "prepublishOnly": "pnpm check:exports"
+  },
+  "browser": {
+    "fs": false,
+    "fs/promises": false
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.1",
+    "@types/emscripten": "^1.41.1",
+    "@types/node": "^20.16.11",
+    "tsx": "^4.19.2",
+    "vitest": "^1.3.1"
+  }
+}