PostGIS on new PGlite

.github/workflows/build_and_test.yml

@@ -61,13 +61,6 @@ jobs:
         run: |
           pnpm build:all
 
-      - name: Typecheck pglite
-        working-directory: ${{ github.workspace }}/packages/pglite
-        run: pnpm typecheck
-      - name: Test pglite
-        working-directory: ${{ github.workspace }}/packages/pglite
-        run: pnpm test
-
       - name: Upload PGlite Interim to Github artifacts
         id: upload-pglite-interim-build-files
         uses: actions/upload-artifact@v4
@@ -84,6 +77,26 @@ jobs:
           path: ./packages/pglite-tools/release/**
           retention-days: 60
 
+      - name: Upload pglite-postgis build artifacts to Github artifacts
+        id: upload-pglite-postgis-release-files
+        uses: actions/upload-artifact@v4
+        with:
+          name: pglite-postgis-release-files-node-v20.x
+          path: ./packages/pglite-postgis/release/**
+          retention-days: 60
+
+      - name: Typecheck pglite
+        working-directory: ${{ github.workspace }}/packages/pglite
+        run: pnpm typecheck
+
+      - name: Test pglite
+        working-directory: ${{ github.workspace }}/packages/pglite
+        run: pnpm test
+
+      - name: Test pglite-postgis
+        working-directory: ${{ github.workspace }}/packages/pglite-postgis
+        run: pnpm test
+
   build-and-test-pglite:
     name: Build and Test packages/pglite
     runs-on: blacksmith-32vcpu-ubuntu-2204
@@ -119,6 +132,12 @@ jobs:
           name: pglite-tools-release-files-node-v20.x
           path: ./packages/pglite-tools/release
 
+      - name: Download pglite-postgis build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: pglite-postgis-release-files-node-v20.x
+          path: ./packages/pglite-postgis/release
+
       - name: Install dependencies
         run: |
           pnpm install --frozen-lockfile
@@ -165,7 +184,7 @@ jobs:
         with:
           issue-number: ${{ github.event.pull_request.number }}
           comment-author: 'github-actions[bot]'
-          body-includes: '- PGlite with node:'
+          body-includes: '- PGlite with node'
 
       - name: Create or update build outputs comment
         uses: peter-evans/create-or-update-comment@v4
@@ -205,6 +224,12 @@ jobs:
           name: pglite-tools-release-files-node-v20.x
           path: ./packages/pglite-tools/release/
 
+      - name: Download pglite-postgis build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: pglite-postgis-release-files-node-v20.x
+          path: ./packages/pglite-postgis/release/
+
       - name: Install dependencies
         run: pnpm install --frozen-lockfile
 
@@ -225,7 +250,14 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: pglite-tools-dist-node-v${{ matrix.node }}
-          path: ./packages/pglite-tools/dist/*        
+          path: ./packages/pglite-tools/dist/*
+
+      - name: Upload pglite-postgis distribution artifact
+        id: upload-pglite-postgis-dist
+        uses: actions/upload-artifact@v4
+        with:
+          name: pglite-postgis-dist-node-v${{ matrix.node }}
+          path: ./packages/pglite-postgis/dist/*                  
 
   publish-website-with-demos:
     name: Publish website with demos
@@ -252,14 +284,26 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           name: pglite-tools-release-files-node-v20.x
-          path: ./packages/pglite-tools/release       
+          path: ./packages/pglite-tools/release
+
+      - name: Download pglite-postgis build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: pglite-postgis-release-files-node-v20.x
+          path: ./packages/pglite-postgis/release/  
 
       - name: Download PGlite build artifacts
         uses: actions/download-artifact@v4
         with:
           name: pglite-dist-node-v20.x
           path: ./packages/pglite/dist/
 
+      - name: Download pglite-postgis dist artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: pglite-postgis-dist-node-v20.x
+          path: ./packages/pglite-postgis/dist/
+
       - name: Install dependencies
         run: pnpm install --frozen-lockfile
 
@@ -313,7 +357,7 @@ jobs:
         with:
           issue-number: ${{ github.event.pull_request.number }}
           comment-author: 'github-actions[bot]'
-          body-includes: Built bundles
+          body-includes: "- Demos:"
 
       - name: Create or update build outputs comment
         uses: peter-evans/create-or-update-comment@v4
@@ -368,6 +412,12 @@ jobs:
           name: pglite-tools-release-files-node-v20.x
           path: ./packages/pglite-tools/release/
 
+      - name: Download pglite-postgis build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: pglite-postgis-release-files-node-v20.x
+          path: ./packages/pglite-postgis/release/
+
       - run: pnpm install --frozen-lockfile
       - run: pnpm --filter "./packages/**" build
       - name: Create Release Pull Request or Publish

docs/extensions/extensions.data.ts

@@ -595,12 +595,31 @@ const baseExtensions: Extension[] = [
     importName: 'age',
     size: 141551,
   },
+  {
+    name: 'PostGIS',
+    description: `
+      *** EXPERIMENTAL ***
+      PostGIS extends the capabilities of the PostgreSQL relational database by adding 
+      support for storing, indexing, and querying geospatial data.
+
+      *Follow this issue for the status: TODOP
+
+      *No GDAL support atm.
+    `,
+    shortDescription: 'Storing, indexing, and querying geospatial data.',
+    docs: 'postgis.net',
+    tags: ['postgres extension', 'experimental'],
+    importPath: '@electric-sql/pglite-postgis',
+    importName: 'postgis',
+    size: 7901736,
+  },
 ]
 
 const tags = [
   'postgres extension',
   'pglite plugin',
   'postgres/contrib',
+  'experimental',
 ] as const
 
 export type Tag = (typeof tags)[number]

docs/package.json

@@ -20,6 +20,7 @@
   "dependencies": {
     "@electric-sql/pglite": "workspace:*",
     "@electric-sql/pglite-repl": "workspace:*",
+    "@electric-sql/pglite-postgis": "workspace:*",
     "@uiw/codemirror-theme-github": "^4.23.0",
     "dedent": "^1.5.3"
   }

docs/repl/allExtensions.ts

@@ -35,3 +35,4 @@ export { unaccent } from '@electric-sql/pglite/contrib/unaccent'
 export { uuid_ossp } from '@electric-sql/pglite/contrib/uuid_ossp'
 export { vector } from '@electric-sql/pglite/vector'
 export { age } from '@electric-sql/pglite/age'
+export { postgis } from '@electric-sql/pglite-postgis'

package.json

@@ -12,10 +12,11 @@
     "ci:publish": "pnpm changeset publish",
     "ts:build": "pnpm -r --filter \"./packages/**\" build",
     "ts:build:debug": "DEBUG=true pnpm ts:build",
+    "wasm:copy-postgis": "mkdir -p ./packages/pglite-postgis/release && cp ./postgres-pglite/dist/extensions/postgis/postgis.tar.gz ./packages/pglite-postgis/release",
     "wasm:copy-initdb": "mkdir -p ./packages/pglite/release && cp ./postgres-pglite/dist/bin/initdb.* ./packages/pglite/release",
     "wasm:copy-pgdump": "mkdir -p ./packages/pglite-tools/release && cp ./postgres-pglite/dist/bin/pg_dump.* ./packages/pglite-tools/release",
     "wasm:copy-pglite": "mkdir -p ./packages/pglite/release/ && cp ./postgres-pglite/dist/bin/pglite.* ./packages/pglite/release/ && cp ./postgres-pglite/dist/extensions/*.tar.gz ./packages/pglite/release/",
-    "wasm:build": "cd postgres-pglite && ./build-with-docker.sh && cd .. && pnpm wasm:copy-pglite && pnpm wasm:copy-pgdump && pnpm wasm:copy-initdb",
+    "wasm:build": "cd postgres-pglite && ./build-with-docker.sh && cd .. && pnpm wasm:copy-pglite && pnpm wasm:copy-pgdump && pnpm wasm:copy-initdb && pnpm wasm:copy-postgis",
     "wasm:build:debug": "DEBUG=true pnpm wasm:build",
     "build:all": "pnpm wasm:build && pnpm ts:build",
     "build:all:debug": "DEBUG=true pnpm build:all"

packages/pglite-postgis/.gitignore

@@ -0,0 +1,2 @@
+release/*
+dist

packages/pglite-postgis/README.md

@@ -0,0 +1,51 @@
+# @electric-sql/pglite-postgis
+
+*** EXPERIMENTAL ***
+
+PostGIS extension for [PGlite](https://pglite.dev). This is an experimental release, use at your own risk.
+
+## Installation
+
+```bash
+npm install @electric-sql/pglite-postgis
+```
+
+## Usage
+
+```typescript
+import { PGlite } from '@electric-sql/pglite'
+import { postgis } from '@electric-sql/pglite-postgis'
+
+const pg = new PGlite({
+  extensions: {
+    postgis,
+  },
+})
+
+await pg.exec('CREATE EXTENSION IF NOT EXISTS postgis;')
+
+// Create a table with geometry columns
+await pg.exec(`
+  CREATE TABLE cities (
+    id SERIAL PRIMARY KEY,
+    name TEXT NOT NULL,
+    location GEOMETRY(Point, 4326)
+  );
+`)
+
+// Insert data
+await pg.query(`
+  INSERT INTO cities (name, location)
+  VALUES ('New York', ST_GeomFromText('POINT(-74.0060 40.7128)', 4326))
+`)
+
+// Query with spatial functions
+const result = await pg.query(`
+  SELECT name, ST_AsText(location) as location
+  FROM cities
+`)
+```
+
+## License
+
+Apache-2.0

packages/pglite-postgis/eslint.config.js

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

packages/pglite-postgis/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@electric-sql/pglite-postgis",
+  "version": "0.0.1",
+  "description": "PostGIS extension for PGlite",
+  "author": "Electric DB Limited",
+  "homepage": "https://pglite.dev",
+  "license": "Apache-2.0",
+  "keywords": [
+    "postgres",
+    "sql",
+    "database",
+    "wasm",
+    "pglite",
+    "postgis",
+    "gis",
+    "geospatial"
+  ],
+  "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"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/electric-sql/pglite.git",
+    "directory": "packages/pglite-postgis"
+  },
+  "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"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.1",
+    "@electric-sql/pglite": "workspace:*",
+    "@types/node": "^20.16.11",
+    "vitest": "^2.1.2"
+  },
+  "peerDependencies": {
+    "@electric-sql/pglite": "workspace:*"
+  }
+}

packages/pglite-postgis/src/index.ts

@@ -0,0 +1,17 @@
+import type {
+  Extension,
+  ExtensionSetupResult,
+  PGliteInterface,
+} from '@electric-sql/pglite'
+
+const setup = async (_pg: PGliteInterface, emscriptenOpts: any) => {
+  return {
+    emscriptenOpts,
+    bundlePath: new URL('../release/postgis.tar.gz', import.meta.url),
+  } satisfies ExtensionSetupResult
+}
+
+export const postgis = {
+  name: 'postgis',
+  setup,
+} satisfies Extension