chore(release): Release

.circleci/config.yml

@@ -25,7 +25,7 @@ executors:
 # Orbs
 
 orbs:
-    node: circleci/node@7.0.0
+    node: circleci/node@7.1.0
 
 ################################
 # Jobs

.eslintrc.json

@@ -21,6 +21,12 @@
 		"max-params": [2, {"max": 4}],
 		"multiline-comment-style": [2, "starred-block"],
 		"linebreak-style": 0,
+		"jsdoc/check-tag-names": [
+			2,
+			{
+				"definedTags": ["import"]
+			}
+		],
 		"n/no-unsupported-features/es-syntax": [2, {"ignores": ["modules"]}],
 		"n/no-missing-import": [
 			"error",

CHANGELOG.md

@@ -1,3 +1,59 @@
+## [0.97.1](https://github.com/5app/dare/compare/v0.97.0...v0.97.1) (2025-07-03)
+
+
+### Bug Fixes
+
+* add type RequestOptions ignore boolean ([#410](https://github.com/5app/dare/issues/410)) ([c3ff946](https://github.com/5app/dare/commit/c3ff946ef27c9143acf28f923559e8ee11aed837))
+
+# [0.97.0](https://github.com/5app/dare/compare/v0.96.0...v0.97.0) (2025-05-21)
+
+
+### Features
+
+* **type:** format date filters, noissue ([#407](https://github.com/5app/dare/issues/407)) ([6a12832](https://github.com/5app/dare/commit/6a12832e5e0fb75493e45c99e743dd5bba5b5e18))
+
+# [0.96.0](https://github.com/5app/dare/compare/v0.95.0...v0.96.0) (2025-05-21)
+
+
+### Features
+
+* **type:** format date types ([#406](https://github.com/5app/dare/issues/406)) ([4256631](https://github.com/5app/dare/commit/4256631f0234d4c9ed2098382ae5b6169bf3862f))
+
+# [0.95.0](https://github.com/5app/dare/compare/v0.94.1...v0.95.0) (2025-05-15)
+
+
+### Features
+
+* **jsdoc:** use [@import](https://github.com/import) ([#405](https://github.com/5app/dare/issues/405)) ([64b0fd9](https://github.com/5app/dare/commit/64b0fd93f600fdebf700f0bd0dc052e1e799a217))
+
+## [0.94.1](https://github.com/5app/dare/compare/v0.94.0...v0.94.1) (2025-04-29)
+
+
+### Bug Fixes
+
+* **null-safe:** add null-safe negate equality conditions ([#404](https://github.com/5app/dare/issues/404)) ([3eb962f](https://github.com/5app/dare/commit/3eb962f7bcb93a7f0099bfa5053c3aca41969a59))
+
+# [0.94.0](https://github.com/5app/dare/compare/v0.93.2...v0.94.0) (2025-04-25)
+
+
+### Features
+
+* **type:** field attributes ([#403](https://github.com/5app/dare/issues/403)) ([dc92f17](https://github.com/5app/dare/commit/dc92f17cef0ab697b41c86a6dd3c9cc0aaa9b37e))
+
+## [0.93.2](https://github.com/5app/dare/compare/v0.93.1...v0.93.2) (2025-02-05)
+
+
+### Bug Fixes
+
+* **ts:** type model handler parameters ([#398](https://github.com/5app/dare/issues/398)) ([877c3e7](https://github.com/5app/dare/commit/877c3e7a7e14fa4f245ce28c54222e1ab50b966c))
+
+## [0.93.1](https://github.com/5app/dare/compare/v0.93.0...v0.93.1) (2025-02-04)
+
+
+### Bug Fixes
+
+* **ts:** type model handler parameters ([#397](https://github.com/5app/dare/issues/397)) ([d434f67](https://github.com/5app/dare/commit/d434f67fcfa6de3cfa2bd1e5490fd6b9c7def4dc))
+
 # [0.93.0](https://github.com/5app/dare/compare/v0.92.1...v0.93.0) (2025-01-23)
 
 

README.md

@@ -50,8 +50,8 @@ The setup needs to define a execution handler `dare.execute(SqlRequest) : Promis
 
 The integration tests illustrates how a [setup of a dare instance](`./test/integration/helpers/api.js`) connects to different clients...
 
--   **MySQL** (5.6, 5.7, 8.0,...) and **MariaDB** (11) See [connection with `mysql2`](./test/integration/helpers/MySQL.js)
--   **Postgres** (16+) See [connection with `pg`](./test/integration/helpers/Postgres.js)
+- **MySQL** (5.6, 5.7, 8.0,...) and **MariaDB** (11) See [connection with `mysql2`](./test/integration/helpers/MySQL.js)
+- **Postgres** (16+) See [connection with `pg`](./test/integration/helpers/Postgres.js)
 
 # Methods
 
@@ -146,11 +146,11 @@ _note_: It is currently limited to defining just one table field, we hope this w
 
 `FUNCTION_NAME([FIELD_PREFIX]? field_name [MATH_OPERATOR MATH_VALUE]?[, ADDITIONAL_PARAMETERS]*)`
 
--   _FUNCTION_NAME_: uppercase, no spaces
--   _FIELD_PREFIX_: optional, uppercase
--   _field_name_: db field reference
--   _MATH_OPERATOR_ _MATH_VALUE_: optional
--   _ADDITIONAL_PARAMETERS_: optional, prefixed with `,`, (uppercase, digit or quoted string)
+- _FUNCTION_NAME_: uppercase, no spaces
+- _FIELD_PREFIX_: optional, uppercase
+- _field_name_: db field reference
+- _MATH_OPERATOR_ _MATH_VALUE_: optional
+- _ADDITIONAL_PARAMETERS_: optional, prefixed with `,`, (uppercase, digit or quoted string)
 
 _e.g._
 
@@ -193,8 +193,8 @@ The SQL this creates renames the fields and then recreates the structured format
 	}
 ```
 
--   At the moment this only supports _n:1_ mapping.
--   The relationship between the tables must be defined in a model field reference.
+- At the moment this only supports _n:1_ mapping.
+- The relationship between the tables must be defined in a model field reference.
 
 ### Filter `filter`
 
@@ -245,9 +245,9 @@ The type of value affects the choice of SQL Condition syntax to use. For example
 
 Prefixing the prop with:
 
--   `%`: creates a `LIKE` comparison (or `ILIKE` in _postgres_)
--   `-`: hyhen negates the value
--   `~`: creates a range
+- `%`: creates a `LIKE` comparison (or `ILIKE` in _postgres_)
+- `-`: hyhen negates the value
+- `~`: creates a range
 
 | Key        | Value                    | Type          | = SQL Condition                                                                                                                             |
 | ---------- | ------------------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -589,7 +589,7 @@ await dare.get({
 | `models`        | `Object<ModelName, Model>`                | An object where the keys are the model names to which models can be referred.                                                                  |
 | `validateInput` | `Function(fieldAttributes, field, value)` | Validate input on _patch_ and _post_ operations                                                                                                |
 | `getFieldKey`   | `Function(field, schema)`                 | Override the default function for retrieving schema fields, this is useful if you want to support altenative case (camelCase and/or snakeCase) |
-| `state`		  | `any`                                     | Arbitary data which can be used within the Method handlers to set additional filters or formatting          |
+| `state`         | `any`                                     | Arbitary data which can be used within the Method handlers to set additional filters or formatting                                             |
 
 # Model
 
@@ -708,6 +708,27 @@ const dare = new Dare({
 });
 ```
 
+**`date`**
+
+With `type=date`; Instance of the `Date` objects are converted to `YYYY-MM-DD` format for insertion
+
+```js
+const dare = new Dare({
+	models: {
+		members: {
+			schema: {
+				start_date: {
+					type: 'date',
+				},
+			},
+		},
+	},
+});
+
+// Example POSt => SQL
+dare.post('members', {start_date: new Date()}); // 'INSERT INTO members (`start_date`) VALUES ('2025-01-02');`
+```
+
 **`json`**
 
 Serializes Objects and Deserializes JSON strings in `get`, `post` and `patch` operations. Setting this value also enables the ability to filter results by querying within the JSON values
@@ -1027,7 +1048,6 @@ Here's an example of setting a model to be invoked whenever we access `users` mo
 
 ```js
 function get(options) {
-
 	// In this example we're filtering access to the `users` model by the properties of the `state` data.
 	options.filter.id = options.state.userId;
 }
@@ -1048,7 +1068,7 @@ await dare.get({
 	limit: 100,
 	state: {
 		userId: 123,
-	}
+	},
 });
 
 // SELECT name FROM users WHERE id = 123 LIMIT 100;
@@ -1248,8 +1268,8 @@ Typically databases will buffer the resultset into memory and send over one larg
 
 Dare, has some functions to take advantage of Streaming
 
--   `this.addRow(record)`: process an individual record
--   `options.rowHandler`: See above
+- `this.addRow(record)`: process an individual record
+- `options.rowHandler`: See above
 
 When combined we can efficiently redirect the results immediatly without building up an internal memory.
 
@@ -1474,9 +1494,9 @@ await dare.get({
 
 By default `conditional_operators_in_value = '!%'`. Which is a selection of special characters within the value to be compared.
 
--   `%`: A string containing `%` within the value to be compared will indicate a wild character and the SQL `LIKE` conditional operator will be used.
--   `!`: A string starting with `!` will negate the value using a SQL `LIKE` comparison operator.
--   `..`: A string containing `..` will use a range `BETWEEN`, `<` or `>` comparison operator where a string value contains `..` or the value is an array with two values (dependending if the first or second value is empty it will use `<` or `>` respecfively). This denotes a range and is enabled using the `~` operator (because `.` within prop name has another meaning)
+- `%`: A string containing `%` within the value to be compared will indicate a wild character and the SQL `LIKE` conditional operator will be used.
+- `!`: A string starting with `!` will negate the value using a SQL `LIKE` comparison operator.
+- `..`: A string containing `..` will use a range `BETWEEN`, `<` or `>` comparison operator where a string value contains `..` or the value is an array with two values (dependending if the first or second value is empty it will use `<` or `>` respecfively). This denotes a range and is enabled using the `~` operator (because `.` within prop name has another meaning)
 
 ```js
 // Enabling support for one or more of the above special characters...
@@ -1553,9 +1573,9 @@ await dare.patch({
 
 This version of Dare is designed to work with:
 
--   MySQL (5.6, 5.7 and 8)
--   Postgres (16.3)
--   MariaDB (11)
+- MySQL (5.6, 5.7 and 8)
+- Postgres (16.3)
+- MariaDB (11)
 
 Set the property `engine` on the Dare instance
 e.g.

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "dare",
-	"version": "0.93.0",
+	"version": "0.97.1",
 	"description": "Database to REST, REST to Database",
 	"type": "module",
 	"main": "./src/index.js",
@@ -21,13 +21,13 @@
 	"scripts": {
 		"prepare": "is-ci || husky install",
 		"pretest": "npm run lint",
-		"types": "tsc -p ./tsconfig.json",
-		"prepublish": "npm run types",
+		"check-types": "tsc -p ./tsconfig.json",
+		"prepublish": "npm run check-types",
 		"test": "npm run spec && ((c8 report --reporter=text-lcov | coveralls) || exit 0)",
 		"test:ci": "eslint ./ && c8 mocha test/specs/**/*.spec.js --reporter mocha-circleci-reporter && (c8 report --reporter=text-lcov | coveralls)",
 		"test:integration": "bash ./test/integration/run.sh",
 		"spec": "c8 mocha test/specs/**/*.spec.js",
-		"lint": "eslint ./ && npx prettier --check . && npx tsc -p ./tsconfig.json",
+		"lint": "eslint ./ && npx prettier --check . && npm run check-types",
 		"prettier": "prettier --write --ignore-unknown .",
 		"lint-fix": "eslint --fix ./",
 		"lint-diff": "LIST=`git diff-index --cached --name-only --diff-filter=d HEAD | grep '.*\\.js$';`; if [ \"$LIST\" ]; then eslint $LIST; fi",
@@ -73,7 +73,7 @@
 		"is-ci": "^4.1.0",
 		"mocha": "^11.1.0",
 		"mocha-circleci-reporter": "0.0.3",
-		"mysql2": "3.12",
+		"mysql2": "3.14",
 		"pg": "^8.13.1",
 		"pg-query-stream": "^4.7.1",
 		"prettier": "^3.4.2",

src/format/limit_clause.js

@@ -11,8 +11,8 @@ import DareError from '../utils/error.js';
  * Limit Clause
  * Set/Check limit and start positions
  * @param {object} opts - Options object
- * @param {number} opts.limit - Limit defintion
- * @param {number} opts.start - Start defintion
+ * @param {number} [opts.limit] - Limit defintion
+ * @param {number} [opts.start] - Start defintion
  * @param {number} MAX_LIMIT - Max limit on instance
  * @returns {LimitClause} - Limit Clause
  */

src/format/reducer_conditions.js

@@ -5,17 +5,11 @@ import formatDateTime from '../utils/format_datetime.js';
 import getFieldAttributes from '../utils/field_attributes.js';
 import unwrap_field from '../utils/unwrap_field.js';
 
-/* eslint-disable jsdoc/valid-types */
 /**
- * @typedef {import('sql-template-tag').Sql} Sql
- * @typedef {import('../index.js').default} Dare
- * @typedef {import('../index.js').Engine} Engine
- */
-/* eslint-enable jsdoc/valid-types */
-
-/**
- * Reduce conditions, call extract
+ * @import {Sql} from 'sql-template-tag'
+ * @import Dare, {Engine} from '../index.js'
  *
+ * Reduce conditions, call extract
  * @param {object} filter - Filter conditions
  * @param {object} options - Options object
  * @param {Function} options.extract - Extract (key, value) related to nested model
@@ -57,6 +51,7 @@ export default function reduceConditions(
 		if (
 			value &&
 			typeof value === 'object' &&
+			!(value instanceof Date) && 
 			!Array.isArray(value) &&
 			key_definition?.type !== 'json' &&
 			!Buffer.isBuffer(value)
@@ -196,6 +191,10 @@ function prepCondition({
 	if (type === 'datetime') {
 		value = formatDateTime(value);
 	}
+	// @ts-ignore
+	else if (type === 'date' && value instanceof Date) {
+		value = value.toISOString().split('T').at(0);
+	}
 
 	// JSON
 	if (
@@ -383,7 +382,15 @@ function sqlCondition({
 			const items = engine.startsWith('mysql:5.7')
 				? filteredValue.map(quote)
 				: filteredValue;
-			conds.push(SQL`${sql_field} ${NOT}IN (${join(items)})`);
+
+			let condition = SQL`${sql_field} ${NOT}IN (${join(items)})`;
+
+			if (negate && !value.includes(null)) {
+				// If negated, and the value is not null, then add the null check
+				condition = SQL`(${condition} OR ${sql_field} IS NULL)`;
+			}
+
+			conds.push(condition);
 		}
 
 		// Other Values which can't be grouped ...
@@ -413,7 +420,17 @@ function sqlCondition({
 			value = String(value);
 		}
 
-		return SQL`${sql_field} ${raw(negate ? '!' : '')}= ${value}`;
+		let condition = SQL`${sql_field} ${raw(negate ? '!' : '')}= ${value}`;
+
+		if (negate) {
+			/*
+			 * NULL-safe equality operator
+			 * @see {@link https://vettabase.com/null-comparisons-in-mariadb-postgresql-and-sqlite/}
+			 * If negated, then add the null check
+			 */
+			condition = SQL`(${condition} OR ${sql_field} IS NULL)`;
+		}
+		return condition;
 	}
 }