orange-orm 4.6.0 → 4.7.0-beta.0

package/README.md

@@ -2,7 +2,7 @@
 <img src="./docs/orange.svg" alt="Orange ORM Logo" width="250"/>
 </div>
 
-The ultimate Object Relational Mapper for Node.js and Typescript, offering seamless integration with a variety of popular databases. Orange ORM supports both TypeScript and JavaScript, including both CommonJS and ECMAScript.  
+The ultimate Object Relational Mapper for Node.js, Bun and Deno, offering seamless integration with a variety of popular databases. Orange ORM supports both TypeScript and JavaScript, including both CommonJS and ECMAScript.  
 
 [![npm version](https://img.shields.io/npm/v/orange-orm.svg?style=flat-square)](https://www.npmjs.org/package/orange-orm)
 [![Build status](https://github.com/alfateam/orange-orm/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/alfateam/orange-orm/actions)
@@ -23,15 +23,16 @@ The ultimate Object Relational Mapper for Node.js and Typescript, offering seaml
 - **Works in the Browser**: You can securely use Orange in the browser by utilizing the Express.js plugin, which serves to safeguard sensitive database credentials from exposure at the client level and protect against SQL injection. This method mirrors a traditional REST API, augmented with advanced TypeScript tooling for enhanced functionality.
 
 ## Supported Databases and Runtimes
-|               | Node | Deno | Bun |Cloudflare |
-| ------------- | :-----: | :-----: | :-----: | :-----: | 
-| Postgres      | ✅ | ✅ | ✅ | ✅
-| MS SQL        | ✅ |  | ✅ | 
-| MySQL         | ✅ | ✅ | ✅ | 
-| Oracle        | ✅ | ✅ | ✅ | 
-| SAP ASE       | ✅ |  |  | 
-| SQLite        | ✅ | ✅ | ✅ | 
-| Cloudflare D1 |  |  |  | ✅
+|               | Node | Deno | Bun |Cloudflare | Web |
+| ------------- | :-----: | :-----: | :-----: | :-----: | :-----: | 
+| Postgres      | ✅ | ✅ | ✅ | ✅|
+| PGlite      | ✅ | ✅ | ✅ | ✅ | ✅
+| MS SQL        | ✅ |  | ✅ | |
+| MySQL         | ✅ | ✅ | ✅ || 
+| Oracle        | ✅ | ✅ | ✅ | |
+| SAP ASE       | ✅ |  |  | |
+| SQLite        | ✅ | ✅ | ✅ | |
+| Cloudflare D1 |  |  |  | ✅|
 
 This is the _Modern Typescript Documentation_. Are you looking for the [_Classic Documentation_](https://github.com/alfateam/orange-orm/blob/master/docs/docs.md) ?
 
@@ -276,13 +277,11 @@ In SQLite, columns with the INTEGER PRIMARY KEY attribute are designed to autoin
 <details><summary><strong>Connecting</strong></summary>
 
 __SQLite__  
-
-**Node.js 21 and earlier**
+When running **Node.js 21 and earlier**, you need to install the `sqlite3` dependency.  
+When running Node.js 22 and later, Bun, or Deno,  you don't need it as it is built-in.  
 ```bash
 npm install sqlite3
 ```  
-__Node.js 22+, Bun, or Deno__  
-When running Node.js 22 and later, Bun, or Deno, you can use the builtin SQLite dependency and don't need to install sqlite3.
 
 ```javascript
 import map from './map';
@@ -355,7 +354,7 @@ const db = map.mssql({
 ```
 
 __PostgreSQL__  
-With Bun, you don't need to install the 'pg' package as PostgreSQL support is built-in.
+With Bun, you don't need to install the `pg` package as PostgreSQL support is built-in.
 ```bash
 npm install pg
 ```  
@@ -368,6 +367,16 @@ With schema
 import map from './map';
 const db = map.postgres('postgres://postgres:postgres@postgres/postgres?search_path=custom');
 ```
+__PGlite__  
+```bash
+npm install @electric-sql/pglite
+```  
+In this example we use the in-memory Postgres.  
+Read more about [PGLite connection configs](https://pglite.dev/docs/).  
+```javascript
+import map from './map';
+const db = map.pglite( /* config? : PGliteOptions */);
+```
 __Cloudflare D1__  
 <sub>📄 wrangler.toml</sub>  
 ```toml

package/dist/index.browser.mjs

@@ -2537,6 +2537,7 @@ function requireClientMap () {
 
 		dbMap.http = (url) => url;
 		dbMap.pg = throwDb;
+		dbMap.pglite = throwDb;
 		dbMap.postgres = throwDb;
 		dbMap.mssql = throwDb;
 		dbMap.mssqlNative = throwDb;
@@ -2564,6 +2565,7 @@ function requireClientMap () {
 
 		onFinal.http = (url) => index({ db: url, providers: dbMap });
 		onFinal.pg = () => index({ db: throwDb, providers: dbMap });
+		onFinal.pglite = () => index({ db: throwDb, providers: dbMap });
 		onFinal.postgres = () => index({ db: throwDb, providers: dbMap });
 		onFinal.mssql = () => index({ db: throwDb, providers: dbMap });
 		onFinal.mssqlNative = () => index({ db: throwDb, providers: dbMap });
@@ -2716,6 +2718,7 @@ function requireClient () {
 		client.mssql = onProvider.bind(null, 'mssql');
 		client.mssqlNative = onProvider.bind(null, 'mssqlNative');
 		client.pg = onProvider.bind(null, 'pg');
+		client.pglite = onProvider.bind(null, 'pglite');
 		client.postgres = onProvider.bind(null, 'postgres');
 		client.d1 = onProvider.bind(null, 'd1');
 		client.sqlite = onProvider.bind(null, 'sqlite');
@@ -4593,7 +4596,7 @@ function requireNewEncode$6 () {
 					return newPara('null');
 				return newPara('\'' + column.dbNull + '\'');
 			}
-			var encodeCore = getSessionSingleton(context, 'encodeJSON');
+			var encodeCore = getSessionSingleton(context, 'encodeJSON') || ((v) => v);
 
 			if (encodeCore) {
 				value = encodeCore(value);
@@ -4609,7 +4612,7 @@ function requireNewEncode$6 () {
 					return 'null';
 				return '\'' + column.dbNull + '\'';
 			}
-			var encodeCore = getSessionSingleton(context, 'encodeJSON');
+			var encodeCore = getSessionSingleton(context, 'encodeJSON') || ((v) => v);
 
 			if (encodeCore) {
 				value = encodeCore(value);
@@ -4618,7 +4621,7 @@ function requireNewEncode$6 () {
 		};
 
 		encode.direct = function(context, value) {
-			var encodeCore = getSessionSingleton(context, 'encodeJSON');
+			var encodeCore = getSessionSingleton(context, 'encodeJSON') || ((v) => v);
 
 			if (encodeCore) {
 				value = encodeCore(value);
@@ -5217,7 +5220,7 @@ function requireNewEncode$1 () {
 					return newParam('null');
 				return newParam('\'' + column.dbNull + '\'');
 			}
-			var encodeCore = getSessionSingleton(context, 'encodeBoolean');
+			var encodeCore = getSessionSingleton(context, 'encodeBoolean') || encodeDefault;
 
 
 			return newParam('?', [encodeCore(value)]);
@@ -5230,14 +5233,14 @@ function requireNewEncode$1 () {
 					return 'null';
 				return '\'' + column.dbNull + '\'';
 			}
-			var encodeCore = getSessionSingleton(context, 'encodeBoolean');
+			var encodeCore = getSessionSingleton(context, 'encodeBoolean') || encodeDefault;
 
 
 			return encodeCore(value);
 		};
 
 		encode.direct = function(context, value) {
-			var encodeCore = getSessionSingleton(context, 'encodeBoolean');
+			var encodeCore = getSessionSingleton(context, 'encodeBoolean') || encodeDefault;
 
 			return encodeCore(value);
 		};
@@ -5245,6 +5248,10 @@ function requireNewEncode$1 () {
 		return encode;
 	}
 
+	function encodeDefault(value) {
+		return value;
+	}
+
 	newEncode$1 = _new;
 	return newEncode$1;
 }
@@ -11863,6 +11870,11 @@ function requireCreateProviders () {
 				return createPool.bind(null, 'pg');
 			}
 		});
+		Object.defineProperty(dbMap, 'pglite', {
+			get:  function() {
+				return createPool.bind(null, 'pglite');
+			}
+		});
 		Object.defineProperty(dbMap, 'postgres', {
 			get:  function() {
 				return createPool.bind(null, 'pg');
@@ -11931,6 +11943,9 @@ function requireCreateProviders () {
 			get pg() {
 				return createPool.bind(null, 'pg');
 			},
+			get pglite() {
+				return createPool.bind(null, 'pglite');
+			},
 			get postgres() {
 				return createPool.bind(null, 'pg');
 			},
@@ -12033,6 +12048,7 @@ function requireMap () {
 		}
 		context.map = map.bind(null, index, context, providers);
 		context.pg = connect.bind(null, 'pg');
+		context.pglite = connect.bind(null, 'pglite');
 		context.postgres = connect.bind(null, 'pg');
 		context.mssql = connect.bind(null, 'mssql');
 		context.mssqlNative = connect.bind(null, 'mssqlNative');