@oino-ts/db-postgresql 0.0.17 → 0.1.0

package/README.md

@@ -75,7 +75,7 @@
  OINO handles serialization of data to JSON/CSV/etc. and back based on the data model. It knows what columns exist, what is their data type and how to convert each to JSON/CSV and back. This allows also partial data to be sent, i.e. you can send only columns that need updating or even send extra columns and have them ignored.
 
  ### Features
- - Files can be sent to BLOB fields using BASE64 or MIME multipart encoding.
+ - Files can be sent to BLOB fields using BASE64 or MIME multipart encoding. Also supports standard HTML form file submission to blob fields and returning them data url images.
  - Datetimes are (optionally) normalized to ISO 8601 format.
  - Extended JSON-encoding
    - Unquoted literal `undefined` can be used to represent non-existent values (leaving property out works too but preserving structure might be easier e.g. when translating data).
@@ -100,11 +100,11 @@
  - Mariadb / Mysql-support through [mariadb](https://www.npmjs.com/package/mariadb)-package
  - Sql Server through [mssql](https://www.npmjs.com/package/mssql)-package
 
- ## Complex Keys
+ ## Composite Keys
  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 is just generating SQL, WHERE-conditions can be defined with [`OINOSqlFilter`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbSqlFilter.html), order with [`OINOSqlOrder`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbSqlOrder.html) and limits/paging with [`OINOSqlOrder`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbSqlLimit.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 is just generating SQL, WHERE-conditions can be defined with [`OINOSqlFilter`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbSqlFilter.html), order with [`OINOSqlOrder`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbSqlOrder.html) and limits/paging with [`OINOSqlLimit`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbSqlLimit.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.
@@ -121,7 +121,7 @@
  ## HTMX support
  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
+ ## 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.
 
 
@@ -133,9 +133,6 @@
 
  ### Realistic app
  There needs to be a realistic app built on top of OINO to get a better grasp of the edge cases.
-
- ### Security review
- Handling of SQL-injection attacks needs a thorough review, what are the relevant attack vectors are for OINO and what protections are still needed.
  
  ## Roadmap
  Things that need to happen in some order before beta-status are at least following:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/db-postgresql",
-  "version": "0.0.17",
+  "version": "0.1.0",
   "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.17",
+    "@oino-ts/db": "^0.1.0",
     "pg": "^8.11.3"
   },
   "devDependencies": {

package/dist/types/OINODbPostgresql.d.ts

@@ -1,76 +0,0 @@
-import { OINODb, OINODbParams, OINODbDataSet, OINODbApi, OINODataCell } from "@oino-ts/db";
-/**
- * Implementation of Postgresql-database.
- *
- */
-export declare class OINODbPostgresql extends OINODb {
-    private _pool;
-    /**
-     * Constructor of `OINODbPostgresql`
-     * @param params database paraneters
-     */
-    constructor(params: OINODbParams);
-    private _parseFieldLength;
-    private _query;
-    private _exec;
-    /**
-     * Print a table name using database specific SQL escaping.
-     *
-     * @param sqlTable name of the table
-     *
-     */
-    printSqlTablename(sqlTable: string): string;
-    /**
-     * Print a column name with correct SQL escaping.
-     *
-     * @param sqlColumn name of the column
-     *
-     */
-    printSqlColumnname(sqlColumn: string): string;
-    /**
-     * Print a single data value from serialization using the context of the native data
-     * type with the correct SQL escaping.
-     *
-     * @param cellValue data from sql results
-     * @param sqlType native type name for table column
-     *
-     */
-    printCellAsSqlValue(cellValue: OINODataCell, sqlType: string): string;
-    /**
-     * Parse a single SQL result value for serialization using the context of the native data
-     * type.
-     *
-     * @param sqlValue data from serialization
-     * @param sqlType native type name for table column
-     *
-     */
-    parseSqlValueAsCell(sqlValue: OINODataCell, sqlType: string): OINODataCell;
-    /**
-     * Connect to database.
-     *
-     */
-    connect(): Promise<boolean>;
-    /**
-     * Execute a select operation.
-     *
-     * @param sql SQL statement.
-     *
-     */
-    sqlSelect(sql: string): Promise<OINODbDataSet>;
-    /**
-     * Execute other sql operations.
-     *
-     * @param sql SQL statement.
-     *
-     */
-    sqlExec(sql: string): Promise<OINODbDataSet>;
-    private _getSchemaSql;
-    /**
-     * Initialize a data model by getting the SQL schema and populating OINODbDataFields of
-     * the model.
-     *
-     * @param api api which data model to initialize.
-     *
-     */
-    initializeApiDatamodel(api: OINODbApi): Promise<void>;
-}

package/dist/types/index.d.ts

@@ -1 +0,0 @@
-export { OINODbPostgresql } from "./OINODbPostgresql.js";