@oino-ts/db-postgresql 0.0.11 → 0.0.12

package/README.md

@@ -22,7 +22,7 @@
  ```
  
  ### Register database and logger
- Register your database implementation and logger (see [`OINOConsoleLog`](https://pragmatta.github.io/oino-ts/classes/core_src.OINOConsoleLog.html) how to implement your own)
+ Register your database implementation and logger (see [`OINOConsoleLog`](https://pragmatta.github.io/oino-ts/classes/types_src.OINOConsoleLog.html) how to implement your own)
 
  ```
  OINOLog.setLogger(new OINOConsoleLog())
@@ -30,13 +30,13 @@
  ```
 
  ### Create a database
- Creating a database connection [`OINODb`](https://pragmatta.github.io/oino-ts/classes/core_src_OINODb.OINODb.html) is done by passing [`OINODbParams`](https://pragmatta.github.io/oino-ts/types/core_src.OINODbParams.html) to the factory method. For [`OINODbBunSqlite`](https://pragmatta.github.io/oino-ts/classes/bunsqlite_OINODbBunSqlite.OINODbBunSqlite.html) that means a file url for the database file, for others network host, port, credentials etc.
+ Creating a database connection [`OINODb`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODb.html) is done by passing [`OINODbParams`](https://pragmatta.github.io/oino-ts/types/db_src.OINODbParams.html) to the factory method. For [`OINODbBunSqlite`](https://pragmatta.github.io/oino-ts/classes/db_bunsqlite_src.OINODbBunSqlite.html) that means a file url for the database file, for others network host, port, credentials etc.
  ```
  const db:OINODb = await OINOFactory.createDb( { type: "OINODbBunSqlite", url: "file://../localDb/northwind.sqlite" } )
  ```
 
  ### Create an API
- From a database you can create an [`OINOApi`](https://pragmatta.github.io/oino-ts/classes/core_src_OINOApi.OINOApi.html) by passing [`OINOApiParams`](https://pragmatta.github.io/oino-ts/types/core_src.OINOApiParams.html) with table name and preferences to the factory method.
+ From a database you can create an [`OINOApi`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbApi.html) by passing [`OINOApiParams`](https://pragmatta.github.io/oino-ts/types/db_src.OINODbApiParams.html) with table name and preferences to the factory method.
  ```
  const api_employees:OINOApi = await OINOFactory.createApi(db, { tableName: "Employees", excludeFields:["BirthDate"] })
  ```
@@ -49,7 +49,7 @@
  ```
 
  ### Write results back to HTTP Response
- The results for a GET request will contain [`OINOModelSet`](https://pragmatta.github.io/oino-ts/classes/core_src_OINOModelSet.OINOModelSet.html) data that can be written out as JSON or CSV as needed. For other requests result is just success or error with messages.
+ The results for a GET request will contain [`OINOModelSet`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbModelSet.html) data that can be written out as JSON or CSV as needed. For other requests result is just success or error with messages.
  ```
  return new Response(result.modelset.writeString(OINOContentType.json))
  ```
@@ -134,7 +134,7 @@
  To support tables with multipart primary keys OINO generates a composite key `_OINOID_` that is included in the result and can be used as the REST ID. For example in the example above table `OrderDetails` has two primary keys `OrderID` and `ProductID` making the `_OINOID_` of form `11077:99`. 
 
  ## Power Of SQL
- Since OINO controls the SQL, WHERE-conditions can be defined with [`OINOSqlFilter`](https://pragmatta.github.io/oino-ts/classes/core_src.OINOSqlFilter.html) and order with [`OINOSqlOrder`](https://pragmatta.github.io/oino-ts/classes/core_src.OINOSqlOrder.html) that are passed as HTTP request parameters. No more API development where you make unique API endpoints for each filter that fetch all data with original API and filter in backend code. Every API can be filtered when and as needed without unnessecary data tranfer and utilizing SQL indexing when available.
+ Since OINO controls the SQL, WHERE-conditions can be defined with [`OINOSqlFilter`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbSqlFilter.html) and order with [`OINOSqlOrder`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbSqlOrder.html) that are passed as HTTP request parameters. No more API development where you make unique API endpoints for each filter that fetch all data with original API and filter in backend code. Every API can be filtered when and as needed without unnessecary data tranfer and utilizing SQL indexing when available.
 
  ## Swagger Support
  Swagger is great as long as the definitions are updated and with OINO you can automatically get a Swagger definition including a data model schema.
@@ -149,7 +149,7 @@
  OINO is developped Typescript first but compiles to standard CommonJS and the NPM packages should work on either ESM / CommonJS. Checkout sample apps `readmeApp` (ESM) and `nodeApp` (CommonJS).
 
  ## HTMX support
- OINO is [htmx.org](https://htmx.org) friendly, allowing easy translation of [`OINODataRow`](https://pragmatta.github.io/oino-ts/types/core_src.OINODataRow.html) to HTML output using templates (cf. the [htmx sample app](https://github.com/pragmatta/oino-ts/tree/main/samples/htmxApp)).
+ OINO is [htmx.org](https://htmx.org) friendly, allowing easy translation of [`OINODataRow`](https://pragmatta.github.io/oino-ts/types/db_src.OINODataRow.html) to HTML output using templates (cf. the [htmx sample app](https://github.com/pragmatta/oino-ts/tree/main/samples/htmxApp)).
 
  ### Hashids
  Autoinc numeric id's are very pragmatic and fit well with OINO (e.g. using a form without primary key fields to insert new rows with database assigned ids). However it's not always sensible to share information about the sequence. Hashids solve this by masking the original values by encrypting the ids using AES-128 and some randomness. Length of the hashid can be chosen from 12-32 characters where longer ids provide more security. However this should not be considereded a cryptographic solution for keeping ids secret but rather making it infeasible to iterate all ids.

package/dist/cjs/OINODbPostgresql.js

@@ -171,7 +171,15 @@ WHERE table_name = `;
             return cellValue.toString();
         }
         else if (sqlType == "bytea") {
-            return "\'" + cellValue + "\'";
+            if (cellValue instanceof Buffer) {
+                return "'\\x" + cellValue.toString("hex") + "'";
+            }
+            else if (cellValue instanceof Uint8Array) {
+                return "'\\x" + Buffer.from(cellValue).toString("hex") + "'";
+            }
+            else {
+                return "\'" + cellValue?.toString() + "\'";
+            }
         }
         else if (sqlType == "boolean") {
             if (cellValue == null || cellValue == "" || cellValue.toString().toLowerCase() == "false" || cellValue == "0") {

package/dist/esm/OINODbPostgresql.js

@@ -168,7 +168,15 @@ WHERE table_name = `;
             return cellValue.toString();
         }
         else if (sqlType == "bytea") {
-            return "\'" + cellValue + "\'";
+            if (cellValue instanceof Buffer) {
+                return "'\\x" + cellValue.toString("hex") + "'";
+            }
+            else if (cellValue instanceof Uint8Array) {
+                return "'\\x" + Buffer.from(cellValue).toString("hex") + "'";
+            }
+            else {
+                return "\'" + cellValue?.toString() + "\'";
+            }
         }
         else if (sqlType == "boolean") {
             if (cellValue == null || cellValue == "" || cellValue.toString().toLowerCase() == "false" || cellValue == "0") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/db-postgresql",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "description": "OINO TS package for using Postgresql databases.",
   "author": "Matias Kiviniemi (pragmatta)",
   "license": "MPL-2.0",
@@ -20,7 +20,7 @@
   "module": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
   "dependencies": {
-    "@oino-ts/db": "^0.0.11",
+    "@oino-ts/db": "^0.0.12",
     "pg": "^8.11.3"
   },
   "devDependencies": {

package/src/OINODbPostgresql.ts

@@ -186,7 +186,13 @@ WHERE table_name = `
             return cellValue.toString()
 
         } else if (sqlType == "bytea") {
-            return "\'" + cellValue + "\'"
+            if (cellValue instanceof Buffer) {
+                return "'\\x" + (cellValue as Buffer).toString("hex") + "'"
+            } else if (cellValue instanceof Uint8Array) {
+                return "'\\x" + Buffer.from(cellValue as Uint8Array).toString("hex") + "'"
+            } else {
+                return "\'" + cellValue?.toString() + "\'"
+            }
 
         } else if (sqlType == "boolean") {
             if (cellValue == null || cellValue == "" || cellValue.toString().toLowerCase() == "false" || cellValue == "0") {