@cedx/ui 0.11.0 → 0.13.0

package/Distributable/Pagination.d.ts

@@ -43,6 +43,13 @@ export declare class Pagination {
      */
     get totalItemCount(): number;
     set totalItemCount(value: number);
+    /**
+     * Creates a new pagination from the specified query.
+     * @param query The search parameters providing the query.
+     * @param maxItemsPerPage The maximum number of items allowed per page.
+     * @returns The pagination corresponding to the specified query.
+     */
+    static fromQuery(query: URLSearchParams, maxItemsPerPage?: number): Pagination;
 }
 /**
  * Defines the options of a {@link Pagination} instance.
@@ -61,4 +68,37 @@ export type PaginationOptions = Partial<{
      */
     totalItemCount: number;
 }>;
+/**
+ * A list with information relevant to the pagination of its items.
+ */
+export declare class PaginatedList<T> extends Array<T> {
+    /**
+     * The information relevant to the pagination of list items.
+     */
+    pagination: Pagination;
+    /**
+     * Creates a new paginated list.
+     * @param options An object providing values to initialize this instance.
+     */
+    constructor(options?: PaginatedListOptions<T>);
+    /**
+     * Creates an empty paginated list.
+     * @param itemsPerPage The number of items per page.
+     * @returns An empty paginated list with the specified number of items per page.
+     */
+    static empty<T>(itemsPerPage: number): PaginatedList<T>;
+}
+/**
+ * Defines the options of a {@link PaginatedList} instance.
+ */
+export type PaginatedListOptions<T> = Partial<{
+    /**
+     * The list items.
+     */
+    items: T[];
+    /**
+     * The information relevant to the pagination of list items.
+     */
+    pagination: Pagination;
+}>;
 //# sourceMappingURL=Pagination.d.ts.map

package/Distributable/Pagination.d.ts.map

@@ -1 +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"}
+{"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;IAED;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,eAAe,EAAE,eAAe,SAAO,GAAG,UAAU;CAQ5E;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;AAEH;;GAEG;AACH,qBAAa,aAAa,CAAC,CAAC,CAAE,SAAQ,KAAK,CAAC,CAAC,CAAC;IAE7C;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IAEvB;;;OAGG;gBACS,OAAO,GAAE,oBAAoB,CAAC,CAAC,CAAM;IAMjD;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,GAAG,aAAa,CAAC,CAAC,CAAC;CAGvD;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,IAAI,OAAO,CAAC;IAE7C;;OAEG;IACH,KAAK,EAAE,CAAC,EAAE,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;CACvB,CAAC,CAAC"}

package/Distributable/Pagination.js

@@ -80,4 +80,45 @@ export class Pagination {
     set totalItemCount(value) {
         this.#totalItemCount = Math.max(0, value);
     }
+    /**
+     * Creates a new pagination from the specified query.
+     * @param query The search parameters providing the query.
+     * @param maxItemsPerPage The maximum number of items allowed per page.
+     * @returns The pagination corresponding to the specified query.
+     */
+    static fromQuery(query, maxItemsPerPage = 1000) {
+        const currentPage = Number(query.get("Page") ?? "1");
+        const itemsPerPage = Number(query.get("PerPage") ?? "25");
+        return new this({
+            currentPageIndex: (Number.isNaN(currentPage) ? 1 : currentPage) - 1,
+            itemsPerPage: Math.min(maxItemsPerPage, Number.isNaN(itemsPerPage) ? 25 : itemsPerPage)
+        });
+    }
+}
+/**
+ * A list with information relevant to the pagination of its items.
+ */
+export class PaginatedList extends Array {
+    /**
+     * The information relevant to the pagination of list items.
+     */
+    pagination;
+    /**
+     * Creates a new paginated list.
+     * @param options An object providing values to initialize this instance.
+     */
+    constructor(options = {}) {
+        super();
+        for (const item of options.items ?? [])
+            this.push(item);
+        this.pagination = options.pagination ?? new Pagination;
+    }
+    /**
+     * Creates an empty paginated list.
+     * @param itemsPerPage The number of items per page.
+     * @returns An empty paginated list with the specified number of items per page.
+     */
+    static empty(itemsPerPage) {
+        return new this({ pagination: new Pagination({ itemsPerPage }) });
+    }
 }

package/Sources/Client/Pagination.ts

@@ -92,6 +92,21 @@ export class Pagination {
 	set totalItemCount(value: number) {
 		this.#totalItemCount = Math.max(0, value);
 	}
+
+	/**
+	 * Creates a new pagination from the specified query.
+	 * @param query The search parameters providing the query.
+	 * @param maxItemsPerPage The maximum number of items allowed per page.
+	 * @returns The pagination corresponding to the specified query.
+	 */
+	static fromQuery(query: URLSearchParams, maxItemsPerPage = 1000): Pagination {
+		const currentPage = Number(query.get("Page") ?? "1");
+		const itemsPerPage = Number(query.get("PerPage") ?? "25");
+		return new this({
+			currentPageIndex: (Number.isNaN(currentPage) ? 1 : currentPage) - 1,
+			itemsPerPage: Math.min(maxItemsPerPage, Number.isNaN(itemsPerPage) ? 25 : itemsPerPage)
+		});
+	}
 }
 
 /**
@@ -114,3 +129,49 @@ export type PaginationOptions = Partial<{
 	 */
 	totalItemCount: number;
 }>;
+
+/**
+ * A list with information relevant to the pagination of its items.
+ */
+export class PaginatedList<T> extends Array<T> {
+
+	/**
+	 * The information relevant to the pagination of list items.
+	 */
+	pagination: Pagination;
+
+	/**
+	 * Creates a new paginated list.
+	 * @param options An object providing values to initialize this instance.
+	 */
+	constructor(options: PaginatedListOptions<T> = {}) {
+		super();
+		for (const item of options.items ?? []) this.push(item);
+		this.pagination = options.pagination ?? new Pagination;
+	}
+
+	/**
+	 * Creates an empty paginated list.
+	 * @param itemsPerPage The number of items per page.
+	 * @returns An empty paginated list with the specified number of items per page.
+	 */
+	static empty<T>(itemsPerPage: number): PaginatedList<T> {
+		return new this({pagination: new Pagination({itemsPerPage})});
+	}
+}
+
+/**
+ * Defines the options of a {@link PaginatedList} instance.
+ */
+export type PaginatedListOptions<T> = Partial<{
+
+	/**
+	 * The list items.
+	 */
+	items: T[];
+
+	/**
+	 * The information relevant to the pagination of list items.
+	 */
+	pagination: Pagination;
+}>;

package/package.json

@@ -7,7 +7,7 @@
 	"name": "@cedx/ui",
 	"repository": "CedX/UI",
 	"type": "module",
-	"version": "0.11.0",
+	"version": "0.13.0",
 	"allowScripts": {
 		"esbuild": true,
 		"playwright-firefox": true