@kiwiproject/kiwi-js 0.7.0 → 0.9.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,15 @@
+import { Response } from "express";
+import { ErrorMessage } from "../model/error-message";
 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: (res: Response, identifierField: string, identifier: unknown, entity: unknown) => void;
+    standardGetResponseWithMessage: (res: Response, entity: unknown, notFoundMessage: string) => void;
+    standardPostResponse: (res: Response, location: string, entity: unknown) => void;
+    standardPutResponse: (res: Response, entity: unknown) => void;
+    standardDeleteResponse: (res: Response) => void;
+    standardDeleteResponseWithEntity: (res: Response, deletedEntity: unknown) => void;
+    standardAcceptedResponse: (res: Response, entity: unknown) => void;
+    standardErrorResponse: (res: Response, status: number, errorMessage: string, errors?: Array<ErrorMessage>, identifierField?: string, identifier?: unknown) => void;
+    standardUnauthorizedResponse: (res: Response, errorMessage: string) => void;
+    standardNotFoundResponse: (res: Response, notFoundMessage: string, identifierField?: string, identifier?: unknown) => void;
+    standardBadRequestResponse: (res: Response, errorMessage: string, errors?: Array<ErrorMessage>, identifierField?: string, identifier?: unknown) => void;
 };

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

@@ -1,65 +1,69 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KiwiStandardResponsesExpress = void 0;
-const error_message_1 = require("../model/error-message");
+const error_response_1 = require("../model/error-response");
 /**
  * Returns a 200 OK response if the entity contains a value. Otherwise, returns a 404 Not Found response with
  * a message stating that the entity was not found using the given identifier field and value.
  *
+ * @param res             the Express Response
  * @param identifierField the field which identifies the entity being looked up, e.g. "id"
  * @param identifier      the value of the identifier field, e.g. 42
  * @param entity          the entity or undefined
- * @param res             the Express Response
  */
-const standardGetResponseWithIdentifier = (identifierField, identifier, entity, res) => {
+const standardGetResponseWithIdentifier = (res, identifierField, identifier, entity) => {
     if (entity !== undefined) {
         res.status(200).json(entity);
         return;
     }
-    standardNotFoundResponse(`Object with ${identifierField} ${identifier} not found`, res);
+    standardNotFoundResponse(res, `Object with ${identifierField} ${identifier} not found`, identifierField, identifier);
 };
 /**
  * Returns a 200 OK response if the entity is non-null. Otherwise, returns a 404 Not Found response with
  * the given detail message.
  *
+ * @param res             the Express Response
  * @param entity          the entity or undefined
  * @param notFoundMessage the specific message to use in the 404 response (if entity is undefined)
- * @param res             the Express Response
  */
-const standardGetResponseWithMessage = (entity, notFoundMessage, res) => {
+const standardGetResponseWithMessage = (res, entity, notFoundMessage) => {
     if (entity !== undefined) {
         res.status(200).json(entity);
         return;
     }
-    standardNotFoundResponse(notFoundMessage, res);
+    standardNotFoundResponse(res, notFoundMessage);
 };
 /**
- * Returns a 404 Not Found response containing an {@link ErrorMessage} entity which uses {@code errorDetails}
+ * Returns a 404 Not Found response containing an {@link ErrorResponse} entity which uses {@code notFoundMessage}
  * as the detailed error message.
  *
- * @param errorDetails the error message to use
  * @param res          the Express Response
+ * @param notFoundMessage the error message to use
+ * @param identifierField the field which identifies the entity being looked up, e.g. "id"
+ * @param identifier the value of the identifier field, e.g. 42
  */
-const standardNotFoundResponse = (errorDetails, res) => {
-    res.status(404).json(new error_message_1.ErrorMessage(404, errorDetails).toMap());
+const standardNotFoundResponse = (res, notFoundMessage, identifierField = undefined, identifier = undefined) => {
+    res
+        .status(404)
+        .json(new error_response_1.ErrorResponse(notFoundMessage, identifierField, identifier).toMap());
 };
 /**
  * Returns a 201 Created response having the specified Location header and response entity.
  *
+ * @param res      the Express Response
  * @param location the value for the location header
  * @param entity   the new entity
- * @param res      the Express Response
  */
-const standardPostResponse = (location, entity, res) => {
-    res.status(201).set('Location', location).json(entity);
+const standardPostResponse = (res, location, entity) => {
+    res.status(201).set("Location", location).json(entity);
 };
 /**
  * Returns a 200 OK response having the specified response entity.
  *
- * @param entity the updated entity
  * @param res    the Express Response
+ * @param entity the updated entity
  */
-const standardPutResponse = (entity, res) => {
+const standardPutResponse = (res, entity) => {
     res.status(200).json(entity);
 };
 /**
@@ -68,49 +72,59 @@ const standardPutResponse = (entity, res) => {
  * @param res the Express Response
  */
 const standardDeleteResponse = (res) => {
-    res.status(204);
+    res.sendStatus(204);
 };
 /**
  * Returns a 204 No Content response for DELETE requests and return an entity.
  *
- * @param deletedEntity the entity that was deleted
  * @param res           the Express Response
+ * @param deletedEntity the entity that was deleted
  */
-const standardDeleteResponseWithEntity = (deletedEntity, res) => {
+const standardDeleteResponseWithEntity = (res, deletedEntity) => {
     res.status(204).json(deletedEntity);
 };
 /**
- * Returns a 400 Bad Request response containing an {@link ErrorMessage} entity which uses {@code errorDetails}
+ * Returns a 400 Bad Request response containing an {@link ErrorResponse} entity which uses {@code errorDetails}
  * as the detailed error message.
  *
- * @param errorDetails the error message to use
  * @param res          the Express Response
+ * @param errorMessage the error message to use
+ * @param errors a list of errors (e.g. validation errors) to return
+ * @param identifierField an optional identifier field for the object
+ * @param identifier an optional identifier value for the object
  */
-const standardBadRequestResponse = (errorDetails, res) => {
-    res.status(400).json(new error_message_1.ErrorMessage(400, errorDetails).toMap());
+const standardBadRequestResponse = (res, errorMessage, errors = [], identifierField = undefined, identifier = undefined) => {
+    res
+        .status(400)
+        .json(new error_response_1.ErrorResponse(errorMessage, identifierField, identifier, errors).toMap());
 };
 /**
- * Returns a 401 Unauthorized response containing an {@link ErrorMessage} entity which uses {@code errorDetails}
+ * Returns a 401 Unauthorized response containing an {@link ErrorResponse} entity which uses {@code errorMessage}
  * as the detailed error message.
  *
- * @param errorDetails the error message to use
  * @param res          the Express Response
+ * @param errorMessage the error message to use
  */
-const standardUnauthorizedResponse = (errorDetails, res) => {
-    res.status(401).json(new error_message_1.ErrorMessage(401, errorDetails).toMap());
+const standardUnauthorizedResponse = (res, errorMessage) => {
+    res.status(401).json(new error_response_1.ErrorResponse(errorMessage).toMap());
 };
 /**
- * Returns a response having the given status and an {@link ErrorMessage} entity which uses {@code errorDetails}
+ * Returns a response having the given status and an {@link ErrorResponse} entity which uses {@code errorMessage}
  * as the detailed error message.
  * <p>
  * Does not verify that the given status is actually an error status.
  *
  * @param status       the status code
- * @param errorDetails the error message to use
+ * @param errorMessage the error message to use
  * @param res          the Express Response
+ * @param errors  an optional list of extra error details to return
+ * @param identifierField an
+ * @param identifier
  */
-const standardErrorResponse = (status, errorDetails, res) => {
-    res.status(status).json(new error_message_1.ErrorMessage(status, errorDetails).toMap());
+const standardErrorResponse = (res, status, errorMessage, errors = [], identifierField = undefined, identifier = undefined) => {
+    res
+        .status(status)
+        .json(new error_response_1.ErrorResponse(errorMessage, identifierField, identifier, errors).toMap());
 };
 /**
  * Returns a 202 Accepted response having the specified response entity.
@@ -120,7 +134,7 @@ const standardErrorResponse = (status, errorDetails, res) => {
  * @param entity the accepted entity
  * @param res    the Express Response
  */
-const standardAcceptedResponse = (entity, res) => {
+const standardAcceptedResponse = (res, entity) => {
     res.status(202).json(entity);
 };
 exports.KiwiStandardResponsesExpress = {

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-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 { ErrorResponse } from "./model/error-response";
+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/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KiwiSort = exports.KiwiPage = exports.KiwiPreconditions = exports.KiwiStandardResponsesExpress = exports.ErrorMessage = void 0;
+exports.KiwiSort = exports.KiwiPage = exports.KiwiPreconditions = exports.KiwiStandardResponsesExpress = exports.ErrorResponse = exports.ErrorMessage = void 0;
 var error_message_1 = require("./model/error-message");
 Object.defineProperty(exports, "ErrorMessage", { enumerable: true, get: function () { return error_message_1.ErrorMessage; } });
+var error_response_1 = require("./model/error-response");
+Object.defineProperty(exports, "ErrorResponse", { enumerable: true, get: function () { return error_response_1.ErrorResponse; } });
 var kiwi_standard_responses_express_1 = require("./express/kiwi-standard-responses-express");
 Object.defineProperty(exports, "KiwiStandardResponsesExpress", { enumerable: true, get: function () { return kiwi_standard_responses_express_1.KiwiStandardResponsesExpress; } });
 var kiwi_preconditions_1 = require("./base/kiwi-preconditions");

package/dist/model/error-message.d.ts

@@ -1,20 +1,10 @@
 /**
- * An error message that Kiwi uses to standardize HTTP error responses.
+ * An error message that Kiwi uses to hold information about a single error.
  * <p>
- * Each instance contains the HTTP status (error) code; the error message; an optional identifier to identify the
- * specific item causing the error (e.g. a primary key); and an optional field/property name for cases when a specific
- * field causes the error.
+ * Each instance contains the error message; and an optional fieldName that relates to the error.
  */
 export declare class ErrorMessage {
-    private readonly fieldName;
-    private readonly itemId;
-    private readonly code;
-    private readonly message;
-    constructor(code: number, message: string, fieldName?: string, itemId?: string);
-    toMap(): {
-        message: string;
-        code: number;
-        fieldName: string;
-        itemId: string;
-    };
+    readonly fieldName: string;
+    readonly message: string;
+    constructor(message: string, fieldName: string);
 }

package/dist/model/error-message.js

@@ -2,26 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ErrorMessage = void 0;
 /**
- * An error message that Kiwi uses to standardize HTTP error responses.
+ * An error message that Kiwi uses to hold information about a single error.
  * <p>
- * Each instance contains the HTTP status (error) code; the error message; an optional identifier to identify the
- * specific item causing the error (e.g. a primary key); and an optional field/property name for cases when a specific
- * field causes the error.
+ * Each instance contains the error message; and an optional fieldName that relates to the error.
  */
 class ErrorMessage {
-    constructor(code, message, fieldName = '', itemId = '') {
-        this.itemId = itemId;
-        this.code = code;
+    constructor(message, fieldName) {
         this.message = message;
         this.fieldName = fieldName;
     }
-    toMap() {
-        return {
-            message: this.message,
-            code: this.code,
-            fieldName: this.fieldName,
-            itemId: this.itemId
-        };
-    }
 }
 exports.ErrorMessage = ErrorMessage;

package/dist/model/error-response.d.ts

@@ -0,0 +1,24 @@
+import { ErrorMessage } from "./error-message";
+/**
+ * An error response that Kiwi uses to standardize HTTP error responses.
+ * <p>
+ * Each instance contains the error message; an optional identifier to identify the
+ * specific item causing the error (e.g. a primary key); an optional field/property name for cases when a specific
+ * field causes the error; and an optional list of ErrorMessages for additional details (e.g. validation errors).
+ */
+export declare class ErrorResponse {
+    private readonly fieldName;
+    private readonly itemId;
+    private readonly message;
+    private readonly errors;
+    constructor(message: string, fieldName?: string, itemId?: unknown, errors?: Array<ErrorMessage>);
+    toMap(): {
+        message: string;
+        fieldName: string;
+        itemId: unknown;
+        errors: {
+            message: string;
+            fieldName: string;
+        }[];
+    };
+}

package/dist/model/error-response.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrorResponse = void 0;
+/**
+ * An error response that Kiwi uses to standardize HTTP error responses.
+ * <p>
+ * Each instance contains the error message; an optional identifier to identify the
+ * specific item causing the error (e.g. a primary key); an optional field/property name for cases when a specific
+ * field causes the error; and an optional list of ErrorMessages for additional details (e.g. validation errors).
+ */
+class ErrorResponse {
+    constructor(message, fieldName = "", itemId = "", errors = []) {
+        this.itemId = itemId;
+        this.message = message;
+        this.fieldName = fieldName;
+        this.errors = errors;
+    }
+    toMap() {
+        return {
+            message: this.message,
+            fieldName: this.fieldName,
+            itemId: this.itemId,
+            errors: this.errors.map((error) => {
+                return { message: error.message, fieldName: error.fieldName };
+            }),
+        };
+    }
+}
+exports.ErrorResponse = ErrorResponse;

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.9.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/preset-typescript": "7.22.5",
-    "@jest/globals": "29.6.0",
-    "babel-jest": "29.6.0",
-    "jest": "29.6.0"
+    "@babel/core": "7.23.7",
+    "@babel/preset-env": "7.23.7",
+    "@babel/preset-typescript": "7.23.3",
+    "@jest/globals": "29.7.0",
+    "@types/express": "4.17.21",
+    "@types/node": "20.10.6",
+    "@typescript-eslint/eslint-plugin": "6.16.0",
+    "@typescript-eslint/parser": "6.16.0",
+    "babel-jest": "29.7.0",
+    "eslint": "8.56.0",
+    "jest": "29.7.0",
+    "prettier": "3.1.1",
+    "typescript": "5.3.3"
   }
 }