@defra/forms-model 3.0.386 → 3.0.388

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

@@ -0,0 +1,10 @@
+import Joi from 'joi';
+/**
+ * Joi schema for `PaginationOptions` interface
+ * @see {@link PaginationOptions}
+ */
+export const paginationOptionsSchema = Joi.object({
+  page: Joi.number().positive().integer().default(1).min(1),
+  perPage: Joi.number().positive().integer().default(24).min(1).max(200)
+}).optional();
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["Joi","paginationOptionsSchema","object","page","number","positive","integer","default","min","perPage","max","optional"],"sources":["../../../../src/common/pagination/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport { type PaginationOptions } from '~/src/common/pagination/types.js'\n\n/**\n * Joi schema for `PaginationOptions` interface\n * @see {@link PaginationOptions}\n */\nexport const paginationOptionsSchema = Joi.object<PaginationOptions>({\n  page: Joi.number().positive().integer().default(1).min(1),\n  perPage: Joi.number().positive().integer().default(24).min(1).max(200)\n}).optional()\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAIrB;AACA;AACA;AACA;AACA,OAAO,MAAMC,uBAAuB,GAAGD,GAAG,CAACE,MAAM,CAAoB;EACnEC,IAAI,EAAEH,GAAG,CAACI,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC,CAACC,OAAO,CAAC,CAAC,CAACC,OAAO,CAAC,CAAC,CAAC,CAACC,GAAG,CAAC,CAAC,CAAC;EACzDC,OAAO,EAAET,GAAG,CAACI,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC,CAACC,OAAO,CAAC,CAAC,CAACC,OAAO,CAAC,EAAE,CAAC,CAACC,GAAG,CAAC,CAAC,CAAC,CAACE,GAAG,CAAC,GAAG;AACvE,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC","ignoreList":[]}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

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

@@ -0,0 +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\n/**\n * Metadata containing optional pagination information\n */\nexport interface Meta {\n  /**\n   * The pagination details\n   */\n  pagination?: PaginationResult\n}\n\n/**\n * Standard response wrapper for query results with metadata\n */\nexport interface QueryResult<Model> {\n  /**\n   * The array of data items\n   */\n  data: Model[]\n\n  /**\n   * The metadata about the result\n   */\n  meta: Meta\n}\n"],"mappings":"","ignoreList":[]}

package/dist/module/index.js

@@ -1,9 +1,10 @@
+export * from "./common/pagination/index.js";
+export * from "./components/index.js";
+export * from "./conditions/index.js";
 export * from "./form/form-definition/index.js";
 export * from "./form/form-metadata/index.js";
 export * from "./form/form-submission/index.js";
 export * from "./form/utils/index.js";
-export * from "./components/index.js";
-export * from "./conditions/index.js";
 export * from "./pages/index.js";
 export * from "./utils/helpers.js";
 export * from "./utils/markdown.js";

package/dist/module/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export * from '~/src/form/form-definition/index.js'\nexport * from '~/src/form/form-metadata/index.js'\nexport * from '~/src/form/form-submission/index.js'\nexport * from '~/src/form/utils/index.js'\nexport * from '~/src/components/index.js'\nexport * from '~/src/conditions/index.js'\nexport * from '~/src/pages/index.js'\nexport * from '~/src/utils/helpers.js'\nexport * from '~/src/utils/markdown.js'\nexport type * from '~/src/components/types.js'\nexport type * from '~/src/conditions/types.js'\nexport type * from '~/src/form/form-definition/types.js'\nexport type * from '~/src/form/form-metadata/types.js'\nexport type * from '~/src/form/form-submission/types.js'\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export * from '~/src/common/pagination/index.js'\nexport * from '~/src/components/index.js'\nexport * from '~/src/conditions/index.js'\nexport * from '~/src/form/form-definition/index.js'\nexport * from '~/src/form/form-metadata/index.js'\nexport * from '~/src/form/form-submission/index.js'\nexport * from '~/src/form/utils/index.js'\nexport * from '~/src/pages/index.js'\nexport * from '~/src/utils/helpers.js'\nexport * from '~/src/utils/markdown.js'\n\nexport type * from '~/src/common/pagination/types.js'\nexport type * from '~/src/components/types.js'\nexport type * from '~/src/conditions/types.js'\nexport type * from '~/src/form/form-definition/types.js'\nexport type * from '~/src/form/form-metadata/types.js'\nexport type * from '~/src/form/form-submission/types.js'\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}

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

@@ -0,0 +1,7 @@
+import Joi from 'joi';
+/**
+ * Joi schema for `PaginationOptions` interface
+ * @see {@link PaginationOptions}
+ */
+export declare const paginationOptionsSchema: Joi.ObjectSchema<Required<Pick<import("../../common/pagination/types.js").PaginationResult, "page" | "perPage">>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/common/pagination/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAIrB;;;GAGG;AACH,eAAO,MAAM,uBAAuB,mHAGvB,CAAA"}

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

@@ -0,0 +1,49 @@
+/**
+ * Result of pagination containing page information
+ */
+export interface PaginationResult {
+    /**
+     * The current page number.
+     */
+    page: number;
+    /**
+     * The number of items per page.
+     */
+    perPage: number;
+    /**
+     * The total number of items available.
+     */
+    totalItems: number;
+    /**
+     * The total number of pages available.
+     */
+    totalPages: number;
+}
+/**
+ * Options for paginating results
+ * Allows partial specification of page and perPage from PaginationResult
+ */
+export type PaginationOptions = Required<Pick<PaginationResult, 'page' | 'perPage'>>;
+/**
+ * Metadata containing optional pagination information
+ */
+export interface Meta {
+    /**
+     * The pagination details
+     */
+    pagination?: PaginationResult;
+}
+/**
+ * Standard response wrapper for query results with metadata
+ */
+export interface QueryResult<Model> {
+    /**
+     * The array of data items
+     */
+    data: Model[];
+    /**
+     * The metadata about the result
+     */
+    meta: Meta;
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +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;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAA;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,KAAK;IAChC;;OAEG;IACH,IAAI,EAAE,KAAK,EAAE,CAAA;IAEb;;OAEG;IACH,IAAI,EAAE,IAAI,CAAA;CACX"}

package/dist/types/index.d.ts

@@ -1,12 +1,14 @@
+export * from './common/pagination/index.js';
+export * from './components/index.js';
+export * from './conditions/index.js';
 export * from './form/form-definition/index.js';
 export * from './form/form-metadata/index.js';
 export * from './form/form-submission/index.js';
 export * from './form/utils/index.js';
-export * from './components/index.js';
-export * from './conditions/index.js';
 export * from './pages/index.js';
 export * from './utils/helpers.js';
 export * from './utils/markdown.js';
+export type * from './common/pagination/types.js';
 export type * from './components/types.js';
 export type * from './conditions/types.js';
 export type * from './form/form-definition/types.js';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qCAAqC,CAAA;AACnD,cAAc,mCAAmC,CAAA;AACjD,cAAc,qCAAqC,CAAA;AACnD,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,mCAAmC,CAAA;AACtD,mBAAmB,qCAAqC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAA;AAChD,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,qCAAqC,CAAA;AACnD,cAAc,mCAAmC,CAAA;AACjD,cAAc,qCAAqC,CAAA;AACnD,cAAc,2BAA2B,CAAA;AACzC,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AAEvC,mBAAmB,kCAAkC,CAAA;AACrD,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,mCAAmC,CAAA;AACtD,mBAAmB,qCAAqC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-model",
-  "version": "3.0.386",
+  "version": "3.0.388",
   "description": "A hapi plugin providing the model for Defra forms",
   "homepage": "https://github.com/DEFRA/forms-designer/tree/main/model#readme",
   "repository": {
@@ -21,7 +21,7 @@
     "test:watch": "jest --color --watch"
   },
   "dependencies": {
-    "marked": "^15.0.1",
+    "marked": "^15.0.3",
     "slug": "^10.0.0"
   },
   "devDependencies": {

package/src/common/pagination/index.ts

@@ -0,0 +1,12 @@
+import Joi from 'joi'
+
+import { type PaginationOptions } from '~/src/common/pagination/types.js'
+
+/**
+ * Joi schema for `PaginationOptions` interface
+ * @see {@link PaginationOptions}
+ */
+export const paginationOptionsSchema = Joi.object<PaginationOptions>({
+  page: Joi.number().positive().integer().default(1).min(1),
+  perPage: Joi.number().positive().integer().default(24).min(1).max(200)
+}).optional()

package/src/common/pagination/types.ts

@@ -0,0 +1,57 @@
+/**
+ * Result of pagination containing page information
+ */
+export interface PaginationResult {
+  /**
+   * The current page number.
+   */
+  page: number
+
+  /**
+   * The number of items per page.
+   */
+  perPage: number
+
+  /**
+   * The total number of items available.
+   */
+  totalItems: number
+
+  /**
+   * The total number of pages available.
+   */
+  totalPages: number
+}
+
+/**
+ * Options for paginating results
+ * Allows partial specification of page and perPage from PaginationResult
+ */
+export type PaginationOptions = Required<
+  Pick<PaginationResult, 'page' | 'perPage'>
+>
+
+/**
+ * Metadata containing optional pagination information
+ */
+export interface Meta {
+  /**
+   * The pagination details
+   */
+  pagination?: PaginationResult
+}
+
+/**
+ * Standard response wrapper for query results with metadata
+ */
+export interface QueryResult<Model> {
+  /**
+   * The array of data items
+   */
+  data: Model[]
+
+  /**
+   * The metadata about the result
+   */
+  meta: Meta
+}

package/src/index.ts

@@ -1,12 +1,15 @@
+export * from '~/src/common/pagination/index.js'
+export * from '~/src/components/index.js'
+export * from '~/src/conditions/index.js'
 export * from '~/src/form/form-definition/index.js'
 export * from '~/src/form/form-metadata/index.js'
 export * from '~/src/form/form-submission/index.js'
 export * from '~/src/form/utils/index.js'
-export * from '~/src/components/index.js'
-export * from '~/src/conditions/index.js'
 export * from '~/src/pages/index.js'
 export * from '~/src/utils/helpers.js'
 export * from '~/src/utils/markdown.js'
+
+export type * from '~/src/common/pagination/types.js'
 export type * from '~/src/components/types.js'
 export type * from '~/src/conditions/types.js'
 export type * from '~/src/form/form-definition/types.js'