@janiscommerce/api-list - npm Package Compare versions

Comparing version 5.1.0 to 5.1.1

CHANGELOG.md

@@ -10,2 +10,6 @@ # Changelog
 
+## [5.1.1] - 2021-11-17
+### Changed
+- `startOfTheDayMapper` and `endOfTheDayMapper` filter mappers are now deprecated. [Migration guide](docs/deprecations/001-start-and-end-of-day-filter-mapper.md)
+
 ## [5.1.0] - 2021-04-28
@@ -12,0 +16,0 @@ ### Changed

lib/api-list-data.js

 'use strict';
 
 const { API } = require('@janiscommerce/api');
-const { struct } = require('superstruct');
+const { struct } = require('@janiscommerce/superstruct');
 const path = require('path');
@@ -6,0 +6,0 @@

lib/data-helpers/filter.js

 'use strict';
 
-const { struct } = require('superstruct');
+const { struct } = require('@janiscommerce/superstruct');
 const ApiListError = require('../api-list-error');
@@ -5,0 +5,0 @@

lib/data-helpers/paging.js

 'use strict';
 
-const { struct } = require('superstruct');
+const { struct } = require('@janiscommerce/superstruct');
 
@@ -5,0 +5,0 @@ const PAGE_HEADER = 'x-janis-page';

lib/data-helpers/sort.js

 'use strict';
 
-const { struct } = require('superstruct');
+const { struct } = require('@janiscommerce/superstruct');
 
@@ -5,0 +5,0 @@ const SORT_PARAMETER = 'sortBy';

lib/filter-mappers.js

 'use strict';
 
+const startAndEndOfDayFilterMapperDeprecation = require('./deprecations/start-and-end-of-day-filter-mapper');
+
 /**
@@ -22,2 +24,3 @@ * Maps a filter value to a boolean
  *
+ * @deprecated
  * @param {string} date The date as string
@@ -31,2 +34,3 @@ * @return {Date} The date object
  *
+ * @deprecated
  * @param {string} date The date as string
@@ -65,6 +69,6 @@ * @return {Date} The date object
 	dateMapper,
-	startOfTheDayMapper,
-	endOfTheDayMapper,
+	startOfTheDayMapper: startAndEndOfDayFilterMapperDeprecation(startOfTheDayMapper),
+	endOfTheDayMapper: startAndEndOfDayFilterMapperDeprecation(endOfTheDayMapper),
 	customTypeMapper,
 	searchMapper
 };

package.json

 {
   "name": "@janiscommerce/api-list",
-  "version": "5.1.0",
+  "version": "5.1.1",
   "description": "A package to handle Janis List APIs",
   "main": "lib/index.js",
   "scripts": {
-    "test": "mocha --exit -R nyan --require tests/bootstrap.js --recursive tests/",
-    "watch-test": "export TEST_ENV=true; mocha --exit -R nyan -w --recursive tests/",
-    "test-ci": "nyc --reporter=lcov --reporter=text-summary mocha --exit --recursive tests/",
+    "test": "mocha --exit -R nyan --require tests/bootstrap.js --recursive tests/ --no-deprecation",
+    "watch-test": "export TEST_ENV=true; mocha --exit -R nyan -w --recursive tests/ --no-deprecation",
+    "test-ci": "nyc --reporter=lcov --reporter=text-summary mocha --exit --recursive tests/ --no-deprecation",
     "coverage": "nyc npm test",
@@ -22,10 +22,10 @@ "lint": "eslint lib/ tests/",
   "devDependencies": {
-    "eslint": "^7.25.0",
+    "eslint": "^8.2.0",
     "eslint-config-airbnb-base": "^13.2.0",
     "eslint-plugin-import": "^2.22.1",
-    "husky": "^6.0.0",
-    "mocha": "^8.2.2",
+    "husky": "^7.0.4",
+    "mocha": "^9.1.3",
     "mock-require": "^3.0.3",
     "nyc": "^15.1.0",
-    "sinon": "^9.2.4"
+    "sinon": "^12.0.1"
   },
@@ -40,4 +40,4 @@ "files": [
     "@janiscommerce/api": "^6.2.1",
-    "superstruct": "0.6.2"
+    "@janiscommerce/superstruct": "^1.2.0"
   }
 }

README.md

@@ -108,2 +108,4 @@ # API List
 
+> :warning: `startOfTheDayMapper` and `endOfTheDayMapper` are now deprecated. See [migration guide](docs/deprecations/001-start-and-end-of-day-filter-mapper.md).
+
 They are explained here with examples:
@@ -110,0 +112,0 @@

No alert changes

Improved metrics

Total package byte prevSize

24890

increased by5.41%

Number of package files

14

increased by7.69%

Lines of code

422

increased by2.43%

Number of lines in readme file

261

increased by0.77%

Dependency changes

• + Added@janiscommerce/superstruct@^1.2.0

• - Removedsuperstruct@0.6.2