@defra/forms-model 3.0.600 → 3.0.601

package/dist/module/common/pagination/index.js

@@ -12,4 +12,59 @@ export const paginationOptionFields = {
  * @see {@link PaginationOptions}
  */
 export const paginationOptionsSchema = Joi.object(paginationOptionFields);
+
+/**
+ * Builds the pages array for the GOV.UK Design System pagination component.
+ * Shows first page, last page, current page, and adjacent pages with ellipsis for gaps.
+ * @param currentPage - The current page number
+ * @param totalPages - The total number of pages
+ * @param createHref - Function to generate href for each page number
+ * @returns Array of pagination page items
+ */
+export function buildPaginationPages(currentPage, totalPages, createHref) {
+  const pages = [];
+
+  /**
+   * Creates a pagination page item
+   */
+  function createPageItem(pageNumber, isCurrent = false) {
+    return {
+      number: String(pageNumber),
+      href: createHref(pageNumber),
+      current: isCurrent
+    };
+  }
+
+  // Always show the first page
+  pages.push(createPageItem(1, currentPage === 1));
+
+  // Calculate adjacent page range (one before and one after current)
+  const adjacentStartPage = Math.max(currentPage - 1, 2);
+  const adjacentEndPage = Math.min(currentPage + 1, totalPages - 1);
+
+  // Add ellipsis after first page if needed
+  if (adjacentStartPage > 2) {
+    pages.push({
+      ellipsis: true
+    });
+  }
+
+  // Add pages between adjacentStartPage and adjacentEndPage
+  for (let i = adjacentStartPage; i <= adjacentEndPage; i++) {
+    pages.push(createPageItem(i, i === currentPage));
+  }
+
+  // Add ellipsis before last page if needed
+  if (adjacentEndPage < totalPages - 1) {
+    pages.push({
+      ellipsis: true
+    });
+  }
+
+  // Always show the last page if totalPages > 1
+  if (totalPages > 1) {
+    pages.push(createPageItem(totalPages, currentPage === totalPages));
+  }
+  return pages;
+}
 //# sourceMappingURL=index.js.map

package/dist/module/common/pagination/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Joi","paginationOptionFields","page","number","positive","integer","default","min","optional","description","perPage","max","paginationOptionsSchema","object"],"sources":["../../../../src/common/pagination/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport { type PaginationOptions } from '~/src/common/pagination/types.js'\n\n/**\n * Field definitions for pagination options.\n */\nexport const paginationOptionFields = {\n  page: Joi.number()\n    .positive()\n    .integer()\n    .default(1)\n    .min(1)\n    .optional()\n    .description('Current page number, starting from 1'),\n  perPage: Joi.number()\n    .positive()\n    .integer()\n    .default(24)\n    .min(1)\n    .max(200)\n    .optional()\n    .description('Number of items to display per page, between 1 and 200')\n}\n\n/**\n * Joi schema for `PaginationOptions` interface\n * @see {@link PaginationOptions}\n */\nexport const paginationOptionsSchema: Joi.ObjectSchema<PaginationOptions> =\n  Joi.object(paginationOptionFields)\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAIrB;AACA;AACA;AACA,OAAO,MAAMC,sBAAsB,GAAG;EACpCC,IAAI,EAAEF,GAAG,CAACG,MAAM,CAAC,CAAC,CACfC,QAAQ,CAAC,CAAC,CACVC,OAAO,CAAC,CAAC,CACTC,OAAO,CAAC,CAAC,CAAC,CACVC,GAAG,CAAC,CAAC,CAAC,CACNC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,sCAAsC,CAAC;EACtDC,OAAO,EAAEV,GAAG,CAACG,MAAM,CAAC,CAAC,CAClBC,QAAQ,CAAC,CAAC,CACVC,OAAO,CAAC,CAAC,CACTC,OAAO,CAAC,EAAE,CAAC,CACXC,GAAG,CAAC,CAAC,CAAC,CACNI,GAAG,CAAC,GAAG,CAAC,CACRH,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,wDAAwD;AACzE,CAAC;;AAED;AACA;AACA;AACA;AACA,OAAO,MAAMG,uBAA4D,GACvEZ,GAAG,CAACa,MAAM,CAACZ,sBAAsB,CAAC","ignoreList":[]}
+{"version":3,"file":"index.js","names":["Joi","paginationOptionFields","page","number","positive","integer","default","min","optional","description","perPage","max","paginationOptionsSchema","object","buildPaginationPages","currentPage","totalPages","createHref","pages","createPageItem","pageNumber","isCurrent","String","href","current","push","adjacentStartPage","Math","adjacentEndPage","ellipsis","i"],"sources":["../../../../src/common/pagination/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport {\n  type CreatePageHrefFn,\n  type PaginationOptions,\n  type PaginationPage\n} from '~/src/common/pagination/types.js'\n\n/**\n * Field definitions for pagination options.\n */\nexport const paginationOptionFields = {\n  page: Joi.number()\n    .positive()\n    .integer()\n    .default(1)\n    .min(1)\n    .optional()\n    .description('Current page number, starting from 1'),\n  perPage: Joi.number()\n    .positive()\n    .integer()\n    .default(24)\n    .min(1)\n    .max(200)\n    .optional()\n    .description('Number of items to display per page, between 1 and 200')\n}\n\n/**\n * Joi schema for `PaginationOptions` interface\n * @see {@link PaginationOptions}\n */\nexport const paginationOptionsSchema: Joi.ObjectSchema<PaginationOptions> =\n  Joi.object(paginationOptionFields)\n\n/**\n * Builds the pages array for the GOV.UK Design System pagination component.\n * Shows first page, last page, current page, and adjacent pages with ellipsis for gaps.\n * @param currentPage - The current page number\n * @param totalPages - The total number of pages\n * @param createHref - Function to generate href for each page number\n * @returns Array of pagination page items\n */\nexport function buildPaginationPages(\n  currentPage: number,\n  totalPages: number,\n  createHref: CreatePageHrefFn\n): PaginationPage[] {\n  const pages: PaginationPage[] = []\n\n  /**\n   * Creates a pagination page item\n   */\n  function createPageItem(\n    pageNumber: number,\n    isCurrent = false\n  ): PaginationPage {\n    return {\n      number: String(pageNumber),\n      href: createHref(pageNumber),\n      current: isCurrent\n    }\n  }\n\n  // Always show the first page\n  pages.push(createPageItem(1, currentPage === 1))\n\n  // Calculate adjacent page range (one before and one after current)\n  const adjacentStartPage = Math.max(currentPage - 1, 2)\n  const adjacentEndPage = Math.min(currentPage + 1, totalPages - 1)\n\n  // Add ellipsis after first page if needed\n  if (adjacentStartPage > 2) {\n    pages.push({ ellipsis: true })\n  }\n\n  // Add pages between adjacentStartPage and adjacentEndPage\n  for (let i = adjacentStartPage; i <= adjacentEndPage; i++) {\n    pages.push(createPageItem(i, i === currentPage))\n  }\n\n  // Add ellipsis before last page if needed\n  if (adjacentEndPage < totalPages - 1) {\n    pages.push({ ellipsis: true })\n  }\n\n  // Always show the last page if totalPages > 1\n  if (totalPages > 1) {\n    pages.push(createPageItem(totalPages, currentPage === totalPages))\n  }\n\n  return pages\n}\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAQrB;AACA;AACA;AACA,OAAO,MAAMC,sBAAsB,GAAG;EACpCC,IAAI,EAAEF,GAAG,CAACG,MAAM,CAAC,CAAC,CACfC,QAAQ,CAAC,CAAC,CACVC,OAAO,CAAC,CAAC,CACTC,OAAO,CAAC,CAAC,CAAC,CACVC,GAAG,CAAC,CAAC,CAAC,CACNC,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,sCAAsC,CAAC;EACtDC,OAAO,EAAEV,GAAG,CAACG,MAAM,CAAC,CAAC,CAClBC,QAAQ,CAAC,CAAC,CACVC,OAAO,CAAC,CAAC,CACTC,OAAO,CAAC,EAAE,CAAC,CACXC,GAAG,CAAC,CAAC,CAAC,CACNI,GAAG,CAAC,GAAG,CAAC,CACRH,QAAQ,CAAC,CAAC,CACVC,WAAW,CAAC,wDAAwD;AACzE,CAAC;;AAED;AACA;AACA;AACA;AACA,OAAO,MAAMG,uBAA4D,GACvEZ,GAAG,CAACa,MAAM,CAACZ,sBAAsB,CAAC;;AAEpC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASa,oBAAoBA,CAClCC,WAAmB,EACnBC,UAAkB,EAClBC,UAA4B,EACV;EAClB,MAAMC,KAAuB,GAAG,EAAE;;EAElC;AACF;AACA;EACE,SAASC,cAAcA,CACrBC,UAAkB,EAClBC,SAAS,GAAG,KAAK,EACD;IAChB,OAAO;MACLlB,MAAM,EAAEmB,MAAM,CAACF,UAAU,CAAC;MAC1BG,IAAI,EAAEN,UAAU,CAACG,UAAU,CAAC;MAC5BI,OAAO,EAAEH;IACX,CAAC;EACH;;EAEA;EACAH,KAAK,CAACO,IAAI,CAACN,cAAc,CAAC,CAAC,EAAEJ,WAAW,KAAK,CAAC,CAAC,CAAC;;EAEhD;EACA,MAAMW,iBAAiB,GAAGC,IAAI,CAAChB,GAAG,CAACI,WAAW,GAAG,CAAC,EAAE,CAAC,CAAC;EACtD,MAAMa,eAAe,GAAGD,IAAI,CAACpB,GAAG,CAACQ,WAAW,GAAG,CAAC,EAAEC,UAAU,GAAG,CAAC,CAAC;;EAEjE;EACA,IAAIU,iBAAiB,GAAG,CAAC,EAAE;IACzBR,KAAK,CAACO,IAAI,CAAC;MAAEI,QAAQ,EAAE;IAAK,CAAC,CAAC;EAChC;;EAEA;EACA,KAAK,IAAIC,CAAC,GAAGJ,iBAAiB,EAAEI,CAAC,IAAIF,eAAe,EAAEE,CAAC,EAAE,EAAE;IACzDZ,KAAK,CAACO,IAAI,CAACN,cAAc,CAACW,CAAC,EAAEA,CAAC,KAAKf,WAAW,CAAC,CAAC;EAClD;;EAEA;EACA,IAAIa,eAAe,GAAGZ,UAAU,GAAG,CAAC,EAAE;IACpCE,KAAK,CAACO,IAAI,CAAC;MAAEI,QAAQ,EAAE;IAAK,CAAC,CAAC;EAChC;;EAEA;EACA,IAAIb,UAAU,GAAG,CAAC,EAAE;IAClBE,KAAK,CAACO,IAAI,CAACN,cAAc,CAACH,UAAU,EAAED,WAAW,KAAKC,UAAU,CAAC,CAAC;EACpE;EAEA,OAAOE,KAAK;AACd","ignoreList":[]}

package/dist/module/common/pagination/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../../../src/common/pagination/types.ts"],"sourcesContent":["/**\n * Result of pagination containing page information\n */\nexport interface PaginationResult {\n  /**\n   * The current page number.\n   */\n  page: number\n\n  /**\n   * The number of items per page.\n   */\n  perPage: number\n\n  /**\n   * The total number of items available.\n   */\n  totalItems: number\n\n  /**\n   * The total number of pages available.\n   */\n  totalPages: number\n}\n\n/**\n * Options for paginating results\n * Allows partial specification of page and perPage from PaginationResult\n */\nexport type PaginationOptions = Required<\n  Pick<PaginationResult, 'page' | 'perPage'>\n>\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../../../src/common/pagination/types.ts"],"sourcesContent":["/**\n * Result of pagination containing page information\n */\nexport interface PaginationResult {\n  /**\n   * The current page number.\n   */\n  page: number\n\n  /**\n   * The number of items per page.\n   */\n  perPage: number\n\n  /**\n   * The total number of items available.\n   */\n  totalItems: number\n\n  /**\n   * The total number of pages available.\n   */\n  totalPages: number\n}\n\n/**\n * Options for paginating results\n * Allows partial specification of page and perPage from PaginationResult\n */\nexport type PaginationOptions = Required<\n  Pick<PaginationResult, 'page' | 'perPage'>\n>\n\n/**\n * A single page item for the pagination component\n */\nexport interface PaginationPage {\n  /**\n   * The page number (if it's a page, not an ellipsis)\n   */\n  number?: string\n\n  /**\n   * The URL for the page\n   */\n  href?: string\n\n  /**\n   * Whether this page is the current page\n   */\n  current?: boolean\n\n  /**\n   * Whether this entry is an ellipsis (gap indicator)\n   */\n  ellipsis?: boolean\n}\n\n/**\n * Callback function to generate href for a given page number\n */\nexport type CreatePageHrefFn = (pageNumber: number) => string\n\n/**\n * Pagination result with page items for the pagination component\n * Extends PaginationResult with the pages array needed for rendering\n */\nexport interface PaginationResultWithPages extends PaginationResult {\n  /**\n   * Page items for the pagination component\n   */\n  pages: PaginationPage[]\n}\n"],"mappings":"","ignoreList":[]}

package/dist/types/common/pagination/index.d.ts

@@ -1,5 +1,5 @@
 import Joi from 'joi';
-import { type PaginationOptions } from '../../common/pagination/types.js';
+import { type CreatePageHrefFn, type PaginationOptions, type PaginationPage } from '../../common/pagination/types.js';
 /**
  * Field definitions for pagination options.
  */
@@ -12,4 +12,13 @@ export declare const paginationOptionFields: {
  * @see {@link PaginationOptions}
  */
 export declare const paginationOptionsSchema: Joi.ObjectSchema<PaginationOptions>;
+/**
+ * Builds the pages array for the GOV.UK Design System pagination component.
+ * Shows first page, last page, current page, and adjacent pages with ellipsis for gaps.
+ * @param currentPage - The current page number
+ * @param totalPages - The total number of pages
+ * @param createHref - Function to generate href for each page number
+ * @returns Array of pagination page items
+ */
+export declare function buildPaginationPages(currentPage: number, totalPages: number, createHref: CreatePageHrefFn): PaginationPage[];
 //# sourceMappingURL=index.d.ts.map

package/dist/types/common/pagination/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/common/pagination/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAErB,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,kCAAkC,CAAA;AAEzE;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;CAgBlC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,uBAAuB,EAAE,GAAG,CAAC,YAAY,CAAC,iBAAiB,CACpC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/common/pagination/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAErB,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACpB,MAAM,kCAAkC,CAAA;AAEzC;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;CAgBlC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,uBAAuB,EAAE,GAAG,CAAC,YAAY,CAAC,iBAAiB,CACpC,CAAA;AAEpC;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,gBAAgB,GAC3B,cAAc,EAAE,CA6ClB"}

package/dist/types/common/pagination/types.d.ts

@@ -24,4 +24,39 @@ export interface PaginationResult {
  * Allows partial specification of page and perPage from PaginationResult
  */
 export type PaginationOptions = Required<Pick<PaginationResult, 'page' | 'perPage'>>;
+/**
+ * A single page item for the pagination component
+ */
+export interface PaginationPage {
+    /**
+     * The page number (if it's a page, not an ellipsis)
+     */
+    number?: string;
+    /**
+     * The URL for the page
+     */
+    href?: string;
+    /**
+     * Whether this page is the current page
+     */
+    current?: boolean;
+    /**
+     * Whether this entry is an ellipsis (gap indicator)
+     */
+    ellipsis?: boolean;
+}
+/**
+ * Callback function to generate href for a given page number
+ */
+export type CreatePageHrefFn = (pageNumber: number) => string;
+/**
+ * Pagination result with page items for the pagination component
+ * Extends PaginationResult with the pages array needed for rendering
+ */
+export interface PaginationResultWithPages extends PaginationResult {
+    /**
+     * Page items for the pagination component
+     */
+    pages: PaginationPage[];
+}
 //# sourceMappingURL=types.d.ts.map

package/dist/types/common/pagination/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/common/pagination/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CACtC,IAAI,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC,CAC3C,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/common/pagination/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CACtC,IAAI,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC,CAC3C,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,UAAU,EAAE,MAAM,KAAK,MAAM,CAAA;AAE7D;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IACjE;;OAEG;IACH,KAAK,EAAE,cAAc,EAAE,CAAA;CACxB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-model",
-  "version": "3.0.600",
+  "version": "3.0.601",
   "description": "A hapi plugin providing the model for Defra forms",
   "homepage": "https://github.com/DEFRA/forms-designer/tree/main/model#readme",
   "types": "dist/types/index.d.ts",

package/src/common/pagination/index.ts

@@ -1,6 +1,10 @@
 import Joi from 'joi'
 
-import { type PaginationOptions } from '~/src/common/pagination/types.js'
+import {
+  type CreatePageHrefFn,
+  type PaginationOptions,
+  type PaginationPage
+} from '~/src/common/pagination/types.js'
 
 /**
  * Field definitions for pagination options.
@@ -29,3 +33,62 @@ export const paginationOptionFields = {
  */
 export const paginationOptionsSchema: Joi.ObjectSchema<PaginationOptions> =
   Joi.object(paginationOptionFields)
+
+/**
+ * Builds the pages array for the GOV.UK Design System pagination component.
+ * Shows first page, last page, current page, and adjacent pages with ellipsis for gaps.
+ * @param currentPage - The current page number
+ * @param totalPages - The total number of pages
+ * @param createHref - Function to generate href for each page number
+ * @returns Array of pagination page items
+ */
+export function buildPaginationPages(
+  currentPage: number,
+  totalPages: number,
+  createHref: CreatePageHrefFn
+): PaginationPage[] {
+  const pages: PaginationPage[] = []
+
+  /**
+   * Creates a pagination page item
+   */
+  function createPageItem(
+    pageNumber: number,
+    isCurrent = false
+  ): PaginationPage {
+    return {
+      number: String(pageNumber),
+      href: createHref(pageNumber),
+      current: isCurrent
+    }
+  }
+
+  // Always show the first page
+  pages.push(createPageItem(1, currentPage === 1))
+
+  // Calculate adjacent page range (one before and one after current)
+  const adjacentStartPage = Math.max(currentPage - 1, 2)
+  const adjacentEndPage = Math.min(currentPage + 1, totalPages - 1)
+
+  // Add ellipsis after first page if needed
+  if (adjacentStartPage > 2) {
+    pages.push({ ellipsis: true })
+  }
+
+  // Add pages between adjacentStartPage and adjacentEndPage
+  for (let i = adjacentStartPage; i <= adjacentEndPage; i++) {
+    pages.push(createPageItem(i, i === currentPage))
+  }
+
+  // Add ellipsis before last page if needed
+  if (adjacentEndPage < totalPages - 1) {
+    pages.push({ ellipsis: true })
+  }
+
+  // Always show the last page if totalPages > 1
+  if (totalPages > 1) {
+    pages.push(createPageItem(totalPages, currentPage === totalPages))
+  }
+
+  return pages
+}

package/src/common/pagination/types.ts

@@ -30,3 +30,44 @@ export interface PaginationResult {
 export type PaginationOptions = Required<
   Pick<PaginationResult, 'page' | 'perPage'>
 >
+
+/**
+ * A single page item for the pagination component
+ */
+export interface PaginationPage {
+  /**
+   * The page number (if it's a page, not an ellipsis)
+   */
+  number?: string
+
+  /**
+   * The URL for the page
+   */
+  href?: string
+
+  /**
+   * Whether this page is the current page
+   */
+  current?: boolean
+
+  /**
+   * Whether this entry is an ellipsis (gap indicator)
+   */
+  ellipsis?: boolean
+}
+
+/**
+ * Callback function to generate href for a given page number
+ */
+export type CreatePageHrefFn = (pageNumber: number) => string
+
+/**
+ * Pagination result with page items for the pagination component
+ * Extends PaginationResult with the pages array needed for rendering
+ */
+export interface PaginationResultWithPages extends PaginationResult {
+  /**
+   * Page items for the pagination component
+   */
+  pages: PaginationPage[]
+}