@oino-ts/db 0.10.1 → 0.10.2

package/dist/cjs/OINODbSqlParams.js

@@ -68,6 +68,11 @@ class OINODbSqlFilter {
     /**
      * Constructor for `OINODbSqlFilter` as parser of http parameter.
      *
+     * Supports three types of statements:
+     * - comparison: (field)-lt|le|eq|ge|gt|like(value)
+     * - negation: -not(filter)
+     * - conjunction/disjunction: (filter)-and|or(filter)
+     *
      * @param filterString string representation of filter from HTTP-request
      *
      */
@@ -214,7 +219,12 @@ class OINODbSqlOrder {
     /**
      * Constructor for `OINODbSqlOrder` as parser of http parameter.
      *
-     * @param orderString string representation of ordering from HTTP-request
+     * Supports comma separated list of column orders formatted as :
+     * - `column` - order by column in ascending order
+     * - `column ASC|DESC` - order by single either ascending or descending order
+     * - `column+|-` - order by single either ascending or descending order
+     *
+     * @param orderString string representation of order from HTTP-request
      *
      */
     static parse(orderString) {
@@ -276,7 +286,7 @@ exports.OINODbSqlOrder = OINODbSqlOrder;
  *
  */
 class OINODbSqlLimit {
-    static _limitRegex = /^(\d+)(\spage\s)?(\d+)?$/i;
+    static _limitRegex = /^(\d+)(\spage\s|\.)?(\d+)?$/i;
     _limit;
     _page;
     /**
@@ -293,6 +303,11 @@ class OINODbSqlLimit {
     /**
      * Constructor for `OINODbSqlLimit` as parser of http parameter.
      *
+     * Supports limit and page formatted as:
+     * - `limit` - limit number of items to return
+     * - `limit page n` - limit number of items to return and return page n (starting from 1)
+     * - `limit.n` - limit number of items to return and return page n (starting from 1)
+     *
      * @param limitString string representation of limit from HTTP-request
      *
      */
@@ -368,6 +383,11 @@ class OINODbSqlAggregate {
     /**
      * Constructor for `OINODbSqlAggregate` as parser of http parameter.
      *
+     * Supports comma separated list of aggregates formatted as:
+     * - `function(field)`
+     *
+     * Supported functions are count, sum, avg, min, max.
+     *
      * @param aggregatorString string representation of limit from HTTP-request
      *
      */
@@ -468,7 +488,7 @@ class OINODbSqlSelect {
     /**
      * Constructor for `OINODbSqlSelect` as parser of http parameter.
      *
-     * @param columns comma separatef string selected columns from HTTP-request
+     * @param columns comma separated string selected columns from HTTP-request
      *
      */
     static parse(columns) {

package/dist/esm/OINODbSqlParams.js

@@ -65,6 +65,11 @@ export class OINODbSqlFilter {
     /**
      * Constructor for `OINODbSqlFilter` as parser of http parameter.
      *
+     * Supports three types of statements:
+     * - comparison: (field)-lt|le|eq|ge|gt|like(value)
+     * - negation: -not(filter)
+     * - conjunction/disjunction: (filter)-and|or(filter)
+     *
      * @param filterString string representation of filter from HTTP-request
      *
      */
@@ -210,7 +215,12 @@ export class OINODbSqlOrder {
     /**
      * Constructor for `OINODbSqlOrder` as parser of http parameter.
      *
-     * @param orderString string representation of ordering from HTTP-request
+     * Supports comma separated list of column orders formatted as :
+     * - `column` - order by column in ascending order
+     * - `column ASC|DESC` - order by single either ascending or descending order
+     * - `column+|-` - order by single either ascending or descending order
+     *
+     * @param orderString string representation of order from HTTP-request
      *
      */
     static parse(orderString) {
@@ -271,7 +281,7 @@ export class OINODbSqlOrder {
  *
  */
 export class OINODbSqlLimit {
-    static _limitRegex = /^(\d+)(\spage\s)?(\d+)?$/i;
+    static _limitRegex = /^(\d+)(\spage\s|\.)?(\d+)?$/i;
     _limit;
     _page;
     /**
@@ -288,6 +298,11 @@ export class OINODbSqlLimit {
     /**
      * Constructor for `OINODbSqlLimit` as parser of http parameter.
      *
+     * Supports limit and page formatted as:
+     * - `limit` - limit number of items to return
+     * - `limit page n` - limit number of items to return and return page n (starting from 1)
+     * - `limit.n` - limit number of items to return and return page n (starting from 1)
+     *
      * @param limitString string representation of limit from HTTP-request
      *
      */
@@ -362,6 +377,11 @@ export class OINODbSqlAggregate {
     /**
      * Constructor for `OINODbSqlAggregate` as parser of http parameter.
      *
+     * Supports comma separated list of aggregates formatted as:
+     * - `function(field)`
+     *
+     * Supported functions are count, sum, avg, min, max.
+     *
      * @param aggregatorString string representation of limit from HTTP-request
      *
      */
@@ -461,7 +481,7 @@ export class OINODbSqlSelect {
     /**
      * Constructor for `OINODbSqlSelect` as parser of http parameter.
      *
-     * @param columns comma separatef string selected columns from HTTP-request
+     * @param columns comma separated string selected columns from HTTP-request
      *
      */
     static parse(columns) {

package/dist/types/OINODbSqlParams.d.ts

@@ -46,6 +46,11 @@ export declare class OINODbSqlFilter {
     /**
      * Constructor for `OINODbSqlFilter` as parser of http parameter.
      *
+     * Supports three types of statements:
+     * - comparison: (field)-lt|le|eq|ge|gt|like(value)
+     * - negation: -not(filter)
+     * - conjunction/disjunction: (filter)-and|or(filter)
+     *
      * @param filterString string representation of filter from HTTP-request
      *
      */
@@ -92,7 +97,12 @@ export declare class OINODbSqlOrder {
     /**
      * Constructor for `OINODbSqlOrder` as parser of http parameter.
      *
-     * @param orderString string representation of ordering from HTTP-request
+     * Supports comma separated list of column orders formatted as :
+     * - `column` - order by column in ascending order
+     * - `column ASC|DESC` - order by single either ascending or descending order
+     * - `column+|-` - order by single either ascending or descending order
+     *
+     * @param orderString string representation of order from HTTP-request
      *
      */
     static parse(orderString: string): OINODbSqlOrder;
@@ -128,6 +138,11 @@ export declare class OINODbSqlLimit {
     /**
      * Constructor for `OINODbSqlLimit` as parser of http parameter.
      *
+     * Supports limit and page formatted as:
+     * - `limit` - limit number of items to return
+     * - `limit page n` - limit number of items to return and return page n (starting from 1)
+     * - `limit.n` - limit number of items to return and return page n (starting from 1)
+     *
      * @param limitString string representation of limit from HTTP-request
      *
      */
@@ -175,6 +190,11 @@ export declare class OINODbSqlAggregate {
     /**
      * Constructor for `OINODbSqlAggregate` as parser of http parameter.
      *
+     * Supports comma separated list of aggregates formatted as:
+     * - `function(field)`
+     *
+     * Supported functions are count, sum, avg, min, max.
+     *
      * @param aggregatorString string representation of limit from HTTP-request
      *
      */
@@ -223,7 +243,7 @@ export declare class OINODbSqlSelect {
     /**
      * Constructor for `OINODbSqlSelect` as parser of http parameter.
      *
-     * @param columns comma separatef string selected columns from HTTP-request
+     * @param columns comma separated string selected columns from HTTP-request
      *
      */
     static parse(columns: string): OINODbSqlSelect;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/db",
-  "version": "0.10.1",
+  "version": "0.10.2",
   "description": "OINO TS library package for publishing an SQL database tables as a REST API.",
   "author": "Matias Kiviniemi (pragmatta)",
   "license": "MPL-2.0",
@@ -19,12 +19,12 @@
   "module": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
   "dependencies": {
-    "@oino-ts/common": "0.10.1"
+    "@oino-ts/common": "0.10.2"
   },
   "devDependencies": {
     "@types/node": "^20.14.10",
     "@types/bun": "^1.1.14",
-    "@oino-ts/types": "0.10.1",
+    "@oino-ts/types": "0.10.2",
     "typedoc": "^0.25.13"
   },
   "files": [

package/src/OINODbSqlParams.ts

@@ -62,6 +62,11 @@ export class OINODbSqlFilter {
     /**
      * Constructor for `OINODbSqlFilter` as parser of http parameter.
      * 
+     * Supports three types of statements:
+     * - comparison: (field)-lt|le|eq|ge|gt|like(value)
+     * - negation: -not(filter)
+     * - conjunction/disjunction: (filter)-and|or(filter)
+     * 
      * @param filterString string representation of filter from HTTP-request
      *
      */
@@ -210,7 +215,12 @@ export class OINODbSqlOrder {
     /**
      * Constructor for `OINODbSqlOrder` as parser of http parameter.
      * 
-     * @param orderString string representation of ordering from HTTP-request
+     * Supports comma separated list of column orders formatted as :
+     * - `column` - order by column in ascending order
+     * - `column ASC|DESC` - order by single either ascending or descending order
+     * - `column+|-` - order by single either ascending or descending order
+     * 
+     * @param orderString string representation of order from HTTP-request
      *
      */
     static parse(orderString: string):OINODbSqlOrder {
@@ -275,7 +285,7 @@ export class OINODbSqlOrder {
  *
  */
 export class OINODbSqlLimit {
-    private static _limitRegex = /^(\d+)(\spage\s)?(\d+)?$/i
+    private static _limitRegex = /^(\d+)(\spage\s|\.)?(\d+)?$/i
     
     private _limit: number
     private _page: number
@@ -294,6 +304,11 @@ export class OINODbSqlLimit {
     /**
      * Constructor for `OINODbSqlLimit` as parser of http parameter.
      * 
+     * Supports limit and page formatted as:
+     * - `limit` - limit number of items to return
+     * - `limit page n` - limit number of items to return and return page n (starting from 1)
+     * - `limit.n` - limit number of items to return and return page n (starting from 1)
+     * 
      * @param limitString string representation of limit from HTTP-request
      *
      */
@@ -365,6 +380,11 @@ export class OINODbSqlAggregate {
     /**
      * Constructor for `OINODbSqlAggregate` as parser of http parameter.
      * 
+     * Supports comma separated list of aggregates formatted as:
+     * - `function(field)` 
+     * 
+     * Supported functions are count, sum, avg, min, max.
+     * 
      * @param aggregatorString string representation of limit from HTTP-request
      *
      */
@@ -471,7 +491,7 @@ export class OINODbSqlSelect {
     /**
      * Constructor for `OINODbSqlSelect` as parser of http parameter.
      * 
-     * @param columns comma separatef string selected columns from HTTP-request
+     * @param columns comma separated string selected columns from HTTP-request
      *
      */
     static parse(columns: string):OINODbSqlSelect {