Added explicit package for Mongo shims and configured TS7

Author: oskardudycz

.github/workflows/build_and_test.yml

@@ -44,10 +44,6 @@ jobs:
       - name: Ensure specific npm version
         run: npm install -g npm@11.9.0
 
-      # - name: Install Playwright chromium browser
-      #   working-directory: ./src/e2e/browser
-      #   run: npx playwright install chromium
-
       - name: Verify generated Cloudflare types
         run: npm run types:cloudflare:check
 
@@ -63,5 +59,8 @@ jobs:
       - name: Verify bundle boundaries
         run: npm run test:bundles
 
+      - name: Verify browser and ESM/CommonJS package compatibility
+        run: npm run test:compat
+
       - name: Test
         run: npm run test

.github/workflows/publish.yml

@@ -41,7 +41,7 @@ jobs:
 
       - name: Publish packages on NPM 📦
         run: |
-          for pkg_dir in packages/*/; do
+          for pkg_dir in packages/pongo-shims/ packages/dumbo/ packages/pongo/ packages/testing/; do
             [ -f "${pkg_dir}package.json" ] || { echo "⏭  ${pkg_dir} has no package.json — skipping"; continue; }
 
             read -r pkg_name pkg_version pkg_private < <(node -p "

.gitignore

@@ -119,6 +119,7 @@ dist
 # vitepress
 src/docs/.vitepress/dist
 src/docs/.vitepress/cache
+src/docs/.vitepress/.temp
 lib
 
 .DS_Store

.vscode/extensions.json

@@ -2,6 +2,7 @@
   "recommendations": [
     "dbaeumer.vscode-eslint",
     "esbenp.prettier-vscode",
+    "TypeScriptTeam.native-preview",
     "vitest.explorer"
   ]
 }

.vscode/settings.json

@@ -26,7 +26,7 @@
   "typescript.preferences.importModuleSpecifier": "relative",
   "eslint.workingDirectories": [{ "mode": "auto" }],
   "debug.javascript.terminalOptions": {
-    "nodeVersionHint": 20
+    "nodeVersionHint": 24
   },
   "nodejs-testing.include": ["./**/**"],
   "nodejs-testing.extensions": [

AGENTS.md

@@ -4,10 +4,11 @@ Pongo provides a MongoDB-style document API backed by PostgreSQL and SQLite.
 
 ## Repository structure
 
-Repository is using npm workspaces and have three packages;
+Repository is using npm workspaces and has four packages;
 
 - `src/packages/dumbo`: relational database foundations (connection pooling, management, SQL querying, etc.).
 - `src/packages/pongo`: MongoDB-compatible document database API.
+- `src/packages/pongo-shims`: bundled third-party type declarations used by Pongo's compatibility shims.
 - `src/packages/testing`: private helpers sharing one database container per test run. Prepared to move to its own repository.
 
 Besides that:

README.md

@@ -4,7 +4,7 @@
 
 # Pongo
 
-Pongo - Mongo but on PostgreSQL and with strong consistency benefits.
+Pongo - like Mongo but on Postgres or SQLite, with strong consistency benefits
 
 ## Getting Started
 

src/.prettierignore

@@ -1,4 +1,5 @@
 **/dist/
 **/lib/
 **/cache/
-!packages/pongo/src/core/cache
+!packages/pongo/src/core/cache
+packages/pongo-shims/licenses/

src/docs/.vitepress/config.mts

@@ -1,13 +1,14 @@
 import { defineConfig } from 'vitepress';
 
-const env = process.env.NODE_ENV;
+const description =
+  'Pongo - like Mongo but on Postgres or SQLite, with strong consistency benefits';
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
-  base: env === 'production' ? '/Pongo/' : '/',
+  base: './',
   lang: 'en-GB',
   title: 'Pongo',
-  description: 'Event Sourcing made simple',
+  description,
   themeConfig: {
     logo: '/logo.png',
     // https://vitepress.dev/reference/default-theme-config
@@ -40,30 +41,26 @@ export default defineConfig({
 
     editLink: {
       pattern:
-        'https://github.com/event-driven-io/Pongo/edit/master/docs/:path',
+        'https://github.com/event-driven-io/Pongo/edit/main/src/docs/:path',
       text: 'Suggest changes to this page',
     },
 
     socialLinks: [
-      { icon: 'github', link: 'https://github.com/event-driven-io/pongo' },
+      { icon: 'github', link: 'https://github.com/event-driven-io/Pongo' },
       { icon: 'discord', link: 'https://discord.gg/VzvxR5Rb38' },
     ],
     footer: {
       copyright: 'Copyright © Oskar Dudycz and contributors.',
     },
   },
   head: [
-    // ['link', { rel: 'apple-touch-icon', type: 'image/png', size: "180x180", href: '/apple-touch-icon.png' }],
-    // ['link', { rel: 'icon', type: 'image/png', size: "32x32", href: '/favicon-32x32.png' }],
-    // ['link', { rel: 'icon', type: 'image/png', size: "16x16", href: '/favicon-16x16.png' }],
-    // ['link', { rel: 'manifest', manifest: '/manifest.json' }],
     ['meta', { property: 'og:title', content: 'Pongo' }],
     ['meta', { property: 'og:type', content: 'website' }],
     [
       'meta',
       {
         property: 'og:description',
-        content: 'Event Sourcing development made simple',
+        content: description,
       },
     ],
     [
@@ -77,16 +74,14 @@ export default defineConfig({
       'meta',
       {
         property: 'og:url',
-        content: 'https://event-driven-io.github.io/pongo',
+        content: 'https://event-driven-io.github.io/Pongo/',
       },
     ],
-    ['meta', { property: 'twitter:card', content: 'summary_large_image' }],
-    ['meta', { property: 'twitter:site', content: 'marten_lib' }],
-    ['meta', { property: 'twitter:creator', content: 'marten_lib' }],
+    ['meta', { name: 'twitter:card', content: 'summary_large_image' }],
     [
       'meta',
       {
-        property: 'twitter:image',
+        name: 'twitter:image',
         content: 'https://event-driven-io.github.io/Pongo/social.png',
       },
     ],

src/e2e/browser/browser.mjs

@@ -0,0 +1,26 @@
+import { pongoCache, pongoClient, pongoSchema } from '@event-driven-io/pongo';
+import { pongoDriver } from '@event-driven-io/pongo/cloudflare';
+import { MongoClient } from '@event-driven-io/pongo/shim';
+
+const users = pongoSchema.collection('users');
+const schema = pongoSchema.client({
+  browser: pongoSchema.db('browser', { collections: { users } }),
+});
+const options = {
+  driver: pongoDriver,
+  database: {},
+  schema: { definition: schema, autoMigration: 'None' },
+};
+const client = pongoClient(options);
+const shim = new MongoClient(options);
+const cache = pongoCache({ type: 'in-memory', max: 2 });
+cache.set('users:1', { _id: '1', name: 'Ada' });
+
+window.pongoBrowser = {
+  collectionName: client.db('browser').collection('users').collectionName,
+  shimCollectionName: shim.db('browser').collection('users').collectionName,
+  cachedDocument: await cache.get('users:1'),
+  processType: typeof process,
+  bufferType: typeof Buffer,
+  requireType: typeof require,
+};