@kiwiproject/kiwi-js 0.7.0 → 0.8.0

package/dist/base/kiwi-preconditions.d.ts

@@ -1,6 +1,6 @@
 export declare const KiwiPreconditions: {
     checkArgument: (expression: boolean, errorMessage?: string) => void;
-    checkArgumentDefined: (reference: any, errorMessage?: string) => void;
+    checkArgumentDefined: (reference: unknown, errorMessage?: string) => void;
     checkArgumentNotBlank: (str: string, errorMessage?: string) => void;
     checkState: (expression: boolean, errorMessage?: string) => void;
     checkPositive: (value: number, errorMessage?: string) => void;

package/dist/base/kiwi-preconditions.js

@@ -1,16 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KiwiPreconditions = void 0;
-const checkPositiveOrZero = (value, errorMessage = 'value must be positive or zero') => {
+const checkPositiveOrZero = (value, errorMessage = "value must be positive or zero") => {
     checkState(value >= 0, errorMessage);
 };
 const checkState = (expression, errorMessage = undefined) => {
     if (!expression) {
-        const fullErrorMessage = errorMessage === undefined ? 'IllegalStateException' : `IllegalStateException: ${errorMessage}`;
+        const fullErrorMessage = errorMessage === undefined
+            ? "IllegalStateException"
+            : `IllegalStateException: ${errorMessage}`;
         throw new Error(fullErrorMessage);
     }
 };
-const checkPositive = (value, errorMessage = 'value must be a positive number') => {
+const checkPositive = (value, errorMessage = "value must be a positive number") => {
     checkState(value > 0, errorMessage);
 };
 const checkArgumentDefined = (reference, errorMessage = undefined) => {
@@ -18,13 +20,15 @@ const checkArgumentDefined = (reference, errorMessage = undefined) => {
 };
 const checkArgument = (expression, errorMessage = undefined) => {
     if (!expression) {
-        const fullErrorMessage = errorMessage === undefined ? 'IllegalArgumentException' : `IllegalArgumentException: ${errorMessage}`;
+        const fullErrorMessage = errorMessage === undefined
+            ? "IllegalArgumentException"
+            : `IllegalArgumentException: ${errorMessage}`;
         throw new Error(fullErrorMessage);
     }
 };
 const checkArgumentNotBlank = (str, errorMessage = undefined) => {
     checkArgumentDefined(str, errorMessage);
-    checkArgument(str !== '', errorMessage);
+    checkArgument(str !== "", errorMessage);
 };
 exports.KiwiPreconditions = {
     checkArgument,

package/dist/express/kiwi-standard-responses-express.d.ts

@@ -1,13 +1,14 @@
+import { Response } from "express";
 export declare const KiwiStandardResponsesExpress: {
-    standardGetResponseWithIdentifier: (identifierField: string, identifier: Object, entity: any, res: Express.Response) => void;
-    standardGetResponseWithMessage: (entity: any, notFoundMessage: string, res: Express.Response) => void;
-    standardPostResponse: (location: string, entity: any, res: Express.Response) => void;
-    standardPutResponse: (entity: any, res: Express.Response) => void;
-    standardDeleteResponse: (res: Express.Response) => void;
-    standardDeleteResponseWithEntity: (deletedEntity: any, res: Express.Response) => void;
-    standardAcceptedResponse: (entity: any, res: Express.Response) => void;
-    standardErrorResponse: (status: number, errorDetails: string, res: Express.Response) => void;
-    standardUnauthorizedResponse: (errorDetails: string, res: Express.Response) => void;
-    standardNotFoundResponse: (errorDetails: string, res: Express.Response) => void;
-    standardBadRequestResponse: (errorDetails: string, res: Express.Response) => void;
+    standardGetResponseWithIdentifier: (identifierField: string, identifier: unknown, entity: unknown, res: Response) => void;
+    standardGetResponseWithMessage: (entity: unknown, notFoundMessage: string, res: Response) => void;
+    standardPostResponse: (location: string, entity: unknown, res: Response) => void;
+    standardPutResponse: (entity: unknown, res: Response) => void;
+    standardDeleteResponse: (res: Response) => void;
+    standardDeleteResponseWithEntity: (deletedEntity: unknown, res: Response) => void;
+    standardAcceptedResponse: (entity: unknown, res: Response) => void;
+    standardErrorResponse: (status: number, errorDetails: string, res: Response) => void;
+    standardUnauthorizedResponse: (errorDetails: string, res: Response) => void;
+    standardNotFoundResponse: (errorDetails: string, res: Response) => void;
+    standardBadRequestResponse: (errorDetails: string, res: Response) => void;
 };

package/dist/express/kiwi-standard-responses-express.js

@@ -51,7 +51,7 @@ const standardNotFoundResponse = (errorDetails, res) => {
  * @param res      the Express Response
  */
 const standardPostResponse = (location, entity, res) => {
-    res.status(201).set('Location', location).json(entity);
+    res.status(201).set("Location", location).json(entity);
 };
 /**
  * Returns a 200 OK response having the specified response entity.

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-export { ErrorMessage } from './model/error-message';
-export { KiwiStandardResponsesExpress } from './express/kiwi-standard-responses-express';
-export { KiwiPreconditions } from './base/kiwi-preconditions';
-export { KiwiPage } from './search/kiwi-page';
-export { KiwiSort } from './search/kiwi-sort';
+export { ErrorMessage } from "./model/error-message";
+export { KiwiStandardResponsesExpress } from "./express/kiwi-standard-responses-express";
+export { KiwiPreconditions } from "./base/kiwi-preconditions";
+export { KiwiPage } from "./search/kiwi-page";
+export { KiwiSort } from "./search/kiwi-sort";

package/dist/model/error-message.js

@@ -9,7 +9,7 @@ exports.ErrorMessage = void 0;
  * field causes the error.
  */
 class ErrorMessage {
-    constructor(code, message, fieldName = '', itemId = '') {
+    constructor(code, message, fieldName = "", itemId = "") {
         this.itemId = itemId;
         this.code = code;
         this.message = message;
@@ -20,7 +20,7 @@ class ErrorMessage {
             message: this.message,
             code: this.code,
             fieldName: this.fieldName,
-            itemId: this.itemId
+            itemId: this.itemId,
         };
     }
 }

package/dist/search/kiwi-page.js

@@ -53,7 +53,7 @@ class KiwiPage {
     }
     isLast() {
         const offset = 1 - this.pagingStartsWith;
-        return this.number === (this.totalPages - offset);
+        return this.number === this.totalPages - offset;
     }
     isSorted() {
         return this.sort !== undefined && this.sort !== null;

package/dist/search/kiwi-sort.js

@@ -10,15 +10,15 @@ class KiwiSort {
         this.ascending = ascending;
     }
     static ofAscending(property) {
-        return KiwiSort.of(property, 'ASC');
+        return KiwiSort.of(property, "ASC");
     }
     static ofDescending(property) {
-        return KiwiSort.of(property, 'DESC');
+        return KiwiSort.of(property, "DESC");
     }
     static of(property, direction) {
         kiwi_preconditions_1.KiwiPreconditions.checkArgumentNotBlank(property);
         kiwi_preconditions_1.KiwiPreconditions.checkArgumentNotBlank(direction);
-        return new KiwiSort(property, direction, false, 'ASC' === direction);
+        return new KiwiSort(property, direction, false, "ASC" === direction);
     }
     isDescending() {
         return !this.ascending;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kiwiproject/kiwi-js",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "KiwiJS is a utility library. It contains a variety of utilities that we have built over time and find useful. Most of these utilities are ports from the Java Kiwi library.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -8,20 +8,35 @@
     "/dist"
   ],
   "scripts": {
+    "format": "node node_modules/.bin/prettier --ignore-path .gitignore --write \"**/*.+(js|ts|json)\"",
+    "lint": "node node_modules/.bin/eslint --ext .js,.ts .",
     "test": "node --experimental-vm-modules node_modules/.bin/jest --coverage --collectCoverageFrom=src/**/*.ts"
   },
   "jest": {
-    "testPathIgnorePatterns": ["<rootDir>/__tests__/__utils__", "<rootDir>/node_modules/"]
+    "testPathIgnorePatterns": [
+      "<rootDir>/__tests__/__utils__",
+      "<rootDir>/node_modules/"
+    ],
+    "coveragePathIgnorePatterns": [
+      "src/index.ts"
+    ]
   },
   "dependencies": {
     "express": "4.18.2"
   },
   "devDependencies": {
-    "@babel/core": "7.22.6",
-    "@babel/preset-env": "7.22.6",
+    "@babel/core": "7.22.10",
+    "@babel/preset-env": "7.22.10",
     "@babel/preset-typescript": "7.22.5",
-    "@jest/globals": "29.6.0",
-    "babel-jest": "29.6.0",
-    "jest": "29.6.0"
+    "@jest/globals": "29.6.2",
+    "@types/express": "4.17.17",
+    "@types/node": "20.5.0",
+    "@typescript-eslint/eslint-plugin": "6.4.0",
+    "@typescript-eslint/parser": "6.4.0",
+    "babel-jest": "29.6.2",
+    "eslint": "8.47.0",
+    "jest": "29.6.2",
+    "prettier": "3.0.1",
+    "typescript": "5.1.6"
   }
 }