@cedx/ui 0.8.0 → 0.10.0

package/Distributable/Pagination.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Represents information relevant to the pagination of data items.
+ */
+export declare class Pagination {
+    #private;
+    /**
+     * Creates a new pagination.
+     * @param options An object providing values to initialize this instance.
+     */
+    constructor(options?: PaginationOptions);
+    /**
+     * The current page index.
+     */
+    get currentPageIndex(): number;
+    set currentPageIndex(value: number);
+    /**
+     * Value indicating whether a next page exists.
+     */
+    get hasNextPage(): boolean;
+    /**
+     * Value indicating whether a previous page exists.
+     */
+    get hasPreviousPage(): boolean;
+    /**
+     * The number of items per page.
+     */
+    get itemsPerPage(): number;
+    set itemsPerPage(value: number);
+    /**
+     * The last page index.
+     */
+    get lastPageIndex(): number;
+    /**
+     * The data limit.
+     */
+    get limit(): number;
+    /**
+     * The data offset.
+     */
+    get offset(): number;
+    /**
+     * The total number of items.
+     */
+    get totalItemCount(): number;
+    set totalItemCount(value: number);
+}
+/**
+ * Defines the options of a {@link Pagination} instance.
+ */
+export type PaginationOptions = Partial<{
+    /**
+     * The current page index.
+     */
+    currentPageIndex: number;
+    /**
+     * The number of items per page.
+     */
+    itemsPerPage: number;
+    /**
+     * The total number of items.
+     */
+    totalItemCount: number;
+}>;
+//# sourceMappingURL=Pagination.d.ts.map

package/Distributable/Pagination.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Pagination.d.ts","sourceRoot":"","sources":["../Sources/Client/Pagination.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,UAAU;;IAiBtB;;;OAGG;gBACS,OAAO,GAAE,iBAAsB;IAM3C;;OAEG;IACH,IAAI,gBAAgB,IAAI,MAAM,CAE7B;IACD,IAAI,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAEjC;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;OAEG;IACH,IAAI,eAAe,IAAI,OAAO,CAE7B;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,MAAM,CAEzB;IACD,IAAI,YAAY,CAAC,KAAK,EAAE,MAAM,EAE7B;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,MAAM,CAE1B;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;OAEG;IACH,IAAI,cAAc,IAAI,MAAM,CAE3B;IACD,IAAI,cAAc,CAAC,KAAK,EAAE,MAAM,EAE/B;CACD;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC;IAEvC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACvB,CAAC,CAAC"}

package/Distributable/Pagination.js

@@ -0,0 +1,83 @@
+/**
+ * Represents information relevant to the pagination of data items.
+ */
+export class Pagination {
+    /**
+     * The current page index.
+     */
+    #currentPageIndex;
+    /**
+     * The number of items per page.
+     */
+    #itemsPerPage;
+    /**
+     * The total number of items.
+     */
+    #totalItemCount;
+    /**
+     * Creates a new pagination.
+     * @param options An object providing values to initialize this instance.
+     */
+    constructor(options = {}) {
+        this.currentPageIndex = options.currentPageIndex ?? 0;
+        this.itemsPerPage = options.itemsPerPage ?? 25;
+        this.totalItemCount = options.totalItemCount ?? 0;
+    }
+    /**
+     * The current page index.
+     */
+    get currentPageIndex() {
+        return this.#currentPageIndex;
+    }
+    set currentPageIndex(value) {
+        this.#currentPageIndex = Math.max(0, value);
+    }
+    /**
+     * Value indicating whether a next page exists.
+     */
+    get hasNextPage() {
+        return this.#currentPageIndex < this.lastPageIndex;
+    }
+    /**
+     * Value indicating whether a previous page exists.
+     */
+    get hasPreviousPage() {
+        return this.#currentPageIndex > 0;
+    }
+    /**
+     * The number of items per page.
+     */
+    get itemsPerPage() {
+        return this.#itemsPerPage;
+    }
+    set itemsPerPage(value) {
+        this.#itemsPerPage = Math.max(1, Math.min(1000, value));
+    }
+    /**
+     * The last page index.
+     */
+    get lastPageIndex() {
+        return this.#totalItemCount > 0 ? Math.ceil(this.#totalItemCount / this.#itemsPerPage) - 1 : 0;
+    }
+    /**
+     * The data limit.
+     */
+    get limit() {
+        return this.#itemsPerPage;
+    }
+    /**
+     * The data offset.
+     */
+    get offset() {
+        return this.#currentPageIndex * this.#itemsPerPage;
+    }
+    /**
+     * The total number of items.
+     */
+    get totalItemCount() {
+        return this.#totalItemCount;
+    }
+    set totalItemCount(value) {
+        this.#totalItemCount = Math.max(0, value);
+    }
+}

package/Sources/Client/Pagination.ts

@@ -0,0 +1,116 @@
+/**
+ * Represents information relevant to the pagination of data items.
+ */
+export class Pagination {
+
+	/**
+	 * The current page index.
+	 */
+	#currentPageIndex!: number;
+
+	/**
+	 * The number of items per page.
+	 */
+	#itemsPerPage!: number;
+
+	/**
+	 * The total number of items.
+	 */
+	#totalItemCount!: number;
+
+	/**
+	 * Creates a new pagination.
+	 * @param options An object providing values to initialize this instance.
+	 */
+	constructor(options: PaginationOptions = {}) {
+		this.currentPageIndex = options.currentPageIndex ?? 0;
+		this.itemsPerPage = options.itemsPerPage ?? 25;
+		this.totalItemCount = options.totalItemCount ?? 0;
+	}
+
+	/**
+	 * The current page index.
+	 */
+	get currentPageIndex(): number {
+		return this.#currentPageIndex;
+	}
+	set currentPageIndex(value: number) {
+		this.#currentPageIndex = Math.max(0, value);
+	}
+
+	/**
+	 * Value indicating whether a next page exists.
+	 */
+	get hasNextPage(): boolean {
+		return this.#currentPageIndex < this.lastPageIndex;
+	}
+
+	/**
+	 * Value indicating whether a previous page exists.
+	 */
+	get hasPreviousPage(): boolean {
+		return this.#currentPageIndex > 0;
+	}
+
+	/**
+	 * The number of items per page.
+	 */
+	get itemsPerPage(): number {
+		return this.#itemsPerPage;
+	}
+	set itemsPerPage(value: number) {
+		this.#itemsPerPage = Math.max(1, Math.min(1000, value));
+	}
+
+	/**
+	 * The last page index.
+	 */
+	get lastPageIndex(): number {
+		return this.#totalItemCount > 0 ? Math.ceil(this.#totalItemCount / this.#itemsPerPage) - 1 : 0;
+	}
+
+	/**
+	 * The data limit.
+	 */
+	get limit(): number {
+		return this.#itemsPerPage;
+	}
+
+	/**
+	 * The data offset.
+	 */
+	get offset(): number {
+		return this.#currentPageIndex * this.#itemsPerPage;
+	}
+
+	/**
+	 * The total number of items.
+	 */
+	get totalItemCount(): number {
+		return this.#totalItemCount;
+	}
+	set totalItemCount(value: number) {
+		this.#totalItemCount = Math.max(0, value);
+	}
+}
+
+/**
+ * Defines the options of a {@link Pagination} instance.
+ */
+export type PaginationOptions = Partial<{
+
+	/**
+	 * The current page index.
+	 */
+	currentPageIndex: number;
+
+	/**
+	 * The number of items per page.
+	 */
+	itemsPerPage: number;
+
+	/**
+	 * The total number of items.
+	 */
+	totalItemCount: number;
+}>;

package/package.json

@@ -7,7 +7,7 @@
 	"name": "@cedx/ui",
 	"repository": "CedX/UI",
 	"type": "module",
-	"version": "0.8.0",
+	"version": "0.10.0",
 	"allowScripts": {
 		"esbuild": true,
 		"playwright-firefox": true
@@ -17,7 +17,7 @@
 		"@types/bootstrap": "^5.2.11",
 		"@types/chai": "^5.2.3",
 		"@types/mocha": "^10.0.10",
-		"@types/node": "^25.9.3",
+		"@types/node": "^26.0.0",
 		"@types/serve-handler": "^6.1.4",
 		"bootstrap": "^5.3.8",
 		"chai": "^6.2.2",