@kiwiproject/kiwi-js 0.5.0 → 0.7.0

package/README.md

@@ -1,2 +1,9 @@
-# kiwi-js
+### KiwiJS
+[![Build](https://github.com/kiwiproject/kiwi-js/workflows/build/badge.svg)](https://github.com/kiwiproject/kiwi-js/actions?query=workflow%3Abuild)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=kiwiproject_kiwi-js&metric=alert_status)](https://sonarcloud.io/dashboard?id=kiwiproject_kiwi-js)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=kiwiproject_kiwi-js&metric=coverage)](https://sonarcloud.io/dashboard?id=kiwiproject_kiwi-js)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![NPM](https://img.shields.io/npm/v/@kiwiproject/kiwi-js)](https://www.npmjs.com/package/@kiwiproject/kiwi-js)
+
+
 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 (https://github.com/kiwiproject/kiwi).

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

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

package/dist/base/kiwi-preconditions.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KiwiPreconditions = void 0;
+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}`;
+        throw new Error(fullErrorMessage);
+    }
+};
+const checkPositive = (value, errorMessage = 'value must be a positive number') => {
+    checkState(value > 0, errorMessage);
+};
+const checkArgumentDefined = (reference, errorMessage = undefined) => {
+    checkArgument(reference !== undefined && reference !== null, errorMessage);
+};
+const checkArgument = (expression, errorMessage = undefined) => {
+    if (!expression) {
+        const fullErrorMessage = errorMessage === undefined ? 'IllegalArgumentException' : `IllegalArgumentException: ${errorMessage}`;
+        throw new Error(fullErrorMessage);
+    }
+};
+const checkArgumentNotBlank = (str, errorMessage = undefined) => {
+    checkArgumentDefined(str, errorMessage);
+    checkArgument(str !== '', errorMessage);
+};
+exports.KiwiPreconditions = {
+    checkArgument,
+    checkArgumentDefined,
+    checkArgumentNotBlank,
+    checkState,
+    checkPositive,
+    checkPositiveOrZero,
+};

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

@@ -1,13 +1,13 @@
 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;
+    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;
+    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;
 };

package/dist/index.d.ts

@@ -1,2 +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';

package/dist/index.js

@@ -1,7 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KiwiStandardResponsesExpress = exports.ErrorMessage = void 0;
+exports.KiwiSort = exports.KiwiPage = exports.KiwiPreconditions = exports.KiwiStandardResponsesExpress = 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 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");
+Object.defineProperty(exports, "KiwiPreconditions", { enumerable: true, get: function () { return kiwi_preconditions_1.KiwiPreconditions; } });
+var kiwi_page_1 = require("./search/kiwi-page");
+Object.defineProperty(exports, "KiwiPage", { enumerable: true, get: function () { return kiwi_page_1.KiwiPage; } });
+var kiwi_sort_1 = require("./search/kiwi-sort");
+Object.defineProperty(exports, "KiwiSort", { enumerable: true, get: function () { return kiwi_sort_1.KiwiSort; } });

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

@@ -10,11 +10,11 @@ export declare class ErrorMessage {
     private readonly itemId;
     private readonly code;
     private readonly message;
-    constructor(code: Number, message: String, fieldName?: String, itemId?: String);
+    constructor(code: number, message: string, fieldName?: string, itemId?: string);
     toMap(): {
-        message: String;
-        code: Number;
-        fieldName: String;
-        itemId: String;
+        message: string;
+        code: number;
+        fieldName: string;
+        itemId: string;
     };
 }

package/dist/search/kiwi-page.d.ts

@@ -0,0 +1,60 @@
+import { KiwiSort } from "./kiwi-sort";
+/**
+ * Represents one page of an overall list of results.
+ * <p>
+ * By default, pagination assumes a start page index of 0 (i.e. the page offset). You can change this
+ * by calling setPagingStartsWith(int) or usingOneAsFirstPage().
+ * <p>
+ * You can also indicate whether a sort has been applied to the data by setting the KiwiSort via
+ * the setter method or via addKiwiSort(KiwiSort).
+ */
+export declare class KiwiPage {
+    /**
+     * The content on this specific page.
+     */
+    readonly content: object[];
+    /**
+     * The size limit of the pagination, for example each page can have up to 25 items. The last page will often
+     * contain fewer items than this limit unless the total number of items is such that there is no remainder
+     * when dividing the total by the page size. e.g. if the total number of items is 100 and the page size is 20,
+     * then each of the 5 pages has exactly 20 items (the page size).
+     */
+    readonly size: number;
+    /**
+     * The number of this page, e.g. page X of Y.
+     */
+    readonly number: number;
+    /**
+     * The number of items/elements on this page. Only on the last page can this be different.
+     */
+    readonly numberOfElements: number;
+    /**
+     * The total number of pages, calculated from the page size and total number of elements.
+     */
+    readonly totalPages: number;
+    /**
+     * The total number of items/elements in the overall result list.
+     */
+    readonly totalElements: number;
+    /**
+     * Describes any sort that is active for the pagination. Default value is null.
+     */
+    sort: KiwiSort;
+    /**
+     * Allows adjustment for instance where pagination starts with one instead of zero.
+     */
+    pagingStartsWith: number;
+    /**
+     * Optional extra supplementary data related to the page
+     */
+    supplementaryData: object;
+    constructor(content: object[], size: number, number: number, numberOfElements: number, totalPages: number, totalElements: number, sort: KiwiSort);
+    static of(pageNum: number, limit: number, total: number, contentList: object[]): KiwiPage;
+    addKiwiSort(sort: KiwiSort): this;
+    usingZeroAsFirstPage(): this;
+    usingOneAsFirstPage(): this;
+    isFirst(): boolean;
+    isLast(): boolean;
+    isSorted(): boolean;
+    addSupplementaryData(supplementaryData: object): this;
+}

package/dist/search/kiwi-page.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KiwiPage = void 0;
+const kiwi_preconditions_1 = require("../base/kiwi-preconditions");
+/**
+ * Represents one page of an overall list of results.
+ * <p>
+ * By default, pagination assumes a start page index of 0 (i.e. the page offset). You can change this
+ * by calling setPagingStartsWith(int) or usingOneAsFirstPage().
+ * <p>
+ * You can also indicate whether a sort has been applied to the data by setting the KiwiSort via
+ * the setter method or via addKiwiSort(KiwiSort).
+ */
+class KiwiPage {
+    constructor(content, size, number, numberOfElements, totalPages, totalElements, sort) {
+        /**
+         * Allows adjustment for instance where pagination starts with one instead of zero.
+         */
+        this.pagingStartsWith = 0;
+        /**
+         * Optional extra supplementary data related to the page
+         */
+        this.supplementaryData = {};
+        this.content = content;
+        this.size = size;
+        this.number = number;
+        this.numberOfElements = numberOfElements;
+        this.totalPages = totalPages;
+        this.totalElements = totalElements;
+        this.sort = sort;
+    }
+    static of(pageNum, limit, total, contentList) {
+        kiwi_preconditions_1.KiwiPreconditions.checkPositiveOrZero(pageNum);
+        kiwi_preconditions_1.KiwiPreconditions.checkPositive(limit);
+        kiwi_preconditions_1.KiwiPreconditions.checkPositiveOrZero(total);
+        kiwi_preconditions_1.KiwiPreconditions.checkArgumentDefined(contentList);
+        return new KiwiPage(contentList, limit, pageNum, contentList.length, Math.ceil(total / limit), total, undefined);
+    }
+    addKiwiSort(sort) {
+        this.sort = sort;
+        return this;
+    }
+    usingZeroAsFirstPage() {
+        this.pagingStartsWith = 0;
+        return this;
+    }
+    usingOneAsFirstPage() {
+        this.pagingStartsWith = 1;
+        return this;
+    }
+    isFirst() {
+        return this.number === this.pagingStartsWith;
+    }
+    isLast() {
+        const offset = 1 - this.pagingStartsWith;
+        return this.number === (this.totalPages - offset);
+    }
+    isSorted() {
+        return this.sort !== undefined && this.sort !== null;
+    }
+    addSupplementaryData(supplementaryData) {
+        this.supplementaryData = supplementaryData;
+        return this;
+    }
+}
+exports.KiwiPage = KiwiPage;

package/dist/search/kiwi-sort.d.ts

@@ -0,0 +1,11 @@
+export declare class KiwiSort {
+    readonly direction: string;
+    readonly property: string;
+    readonly ignoreCase: boolean;
+    readonly ascending: boolean;
+    constructor(property: string, direction: string, ignoreCase: boolean, ascending: boolean);
+    static ofAscending(property: string): KiwiSort;
+    static ofDescending(property: string): KiwiSort;
+    static of(property: string, direction: string): KiwiSort;
+    isDescending(): boolean;
+}

package/dist/search/kiwi-sort.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KiwiSort = void 0;
+const kiwi_preconditions_1 = require("../base/kiwi-preconditions");
+class KiwiSort {
+    constructor(property, direction, ignoreCase, ascending) {
+        this.property = property;
+        this.direction = direction;
+        this.ignoreCase = ignoreCase;
+        this.ascending = ascending;
+    }
+    static ofAscending(property) {
+        return KiwiSort.of(property, 'ASC');
+    }
+    static ofDescending(property) {
+        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);
+    }
+    isDescending() {
+        return !this.ascending;
+    }
+}
+exports.KiwiSort = KiwiSort;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kiwiproject/kiwi-js",
-  "version": "0.5.0",
+  "version": "0.7.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",
@@ -14,14 +14,14 @@
     "testPathIgnorePatterns": ["<rootDir>/__tests__/__utils__", "<rootDir>/node_modules/"]
   },
   "dependencies": {
-    "express": "^4.18.2"
+    "express": "4.18.2"
   },
   "devDependencies": {
-    "@babel/core": "^7.21.8",
-    "@babel/preset-env": "^7.21.5",
-    "@babel/preset-typescript": "^7.21.5",
-    "@jest/globals": "^29.5.0",
-    "babel-jest": "^29.5.0",
-    "jest": "^29.5.0"
+    "@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"
   }
 }