@defra/forms-model 3.0.390 → 3.0.392

package/dist/module/common/schema.js

@@ -1,5 +1,6 @@
 import Joi from 'joi';
 import { paginationOptionFields } from "./pagination/index.js";
+import { searchOptionFields } from "./search/index.js";
 import { sortingOptionFields } from "./sorting/index.js";
 /**
  * Joi schema for `QueryOptions` interface
@@ -7,6 +8,7 @@ import { sortingOptionFields } from "./sorting/index.js";
  */
 export const queryOptionsSchema = Joi.object({
   ...paginationOptionFields,
-  ...sortingOptionFields
+  ...sortingOptionFields,
+  ...searchOptionFields
 });
 //# sourceMappingURL=schema.js.map

package/dist/module/common/schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"schema.js","names":["Joi","paginationOptionFields","sortingOptionFields","queryOptionsSchema","object"],"sources":["../../../src/common/schema.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport { paginationOptionFields } from '~/src/common/pagination/index.js'\nimport { sortingOptionFields } from '~/src/common/sorting/index.js'\nimport { type QueryOptions } from '~/src/common/types.js'\n\n/**\n * Joi schema for `QueryOptions` interface\n * @see {@link QueryOptions}\n */\nexport const queryOptionsSchema: Joi.ObjectSchema<QueryOptions> = Joi.object({\n  ...paginationOptionFields,\n  ...sortingOptionFields\n})\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAErB,SAASC,sBAAsB;AAC/B,SAASC,mBAAmB;AAG5B;AACA;AACA;AACA;AACA,OAAO,MAAMC,kBAAkD,GAAGH,GAAG,CAACI,MAAM,CAAC;EAC3E,GAAGH,sBAAsB;EACzB,GAAGC;AACL,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"schema.js","names":["Joi","paginationOptionFields","searchOptionFields","sortingOptionFields","queryOptionsSchema","object"],"sources":["../../../src/common/schema.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport { paginationOptionFields } from '~/src/common/pagination/index.js'\nimport { searchOptionFields } from '~/src/common/search/index.js'\nimport { sortingOptionFields } from '~/src/common/sorting/index.js'\nimport { type QueryOptions } from '~/src/common/types.js'\n\n/**\n * Joi schema for `QueryOptions` interface\n * @see {@link QueryOptions}\n */\nexport const queryOptionsSchema: Joi.ObjectSchema<QueryOptions> = Joi.object({\n  ...paginationOptionFields,\n  ...sortingOptionFields,\n  ...searchOptionFields\n})\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAErB,SAASC,sBAAsB;AAC/B,SAASC,kBAAkB;AAC3B,SAASC,mBAAmB;AAG5B;AACA;AACA;AACA;AACA,OAAO,MAAMC,kBAAkD,GAAGJ,GAAG,CAACK,MAAM,CAAC;EAC3E,GAAGJ,sBAAsB;EACzB,GAAGE,mBAAmB;EACtB,GAAGD;AACL,CAAC,CAAC","ignoreList":[]}

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

@@ -0,0 +1,13 @@
+import Joi from 'joi';
+/**
+ * Field definitions for search options.
+ */
+export const searchOptionFields = {
+  title: Joi.string().trim().allow('').max(255).optional()
+};
+
+/**
+ * Joi schema for {@link SearchOptions} interface
+ */
+export const searchOptionsSchema = Joi.object(searchOptionFields);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["Joi","searchOptionFields","title","string","trim","allow","max","optional","searchOptionsSchema","object"],"sources":["../../../../src/common/search/index.ts"],"sourcesContent":["import Joi from 'joi'\n\nimport { type SearchOptions } from '~/src/common/search/types.js'\n\n/**\n * Field definitions for search options.\n */\nexport const searchOptionFields = {\n  title: Joi.string().trim().allow('').max(255).optional()\n}\n\n/**\n * Joi schema for {@link SearchOptions} interface\n */\nexport const searchOptionsSchema: Joi.ObjectSchema<SearchOptions> =\n  Joi.object(searchOptionFields)\n"],"mappings":"AAAA,OAAOA,GAAG,MAAM,KAAK;AAIrB;AACA;AACA;AACA,OAAO,MAAMC,kBAAkB,GAAG;EAChCC,KAAK,EAAEF,GAAG,CAACG,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC,CAAC,CAACC,KAAK,CAAC,EAAE,CAAC,CAACC,GAAG,CAAC,GAAG,CAAC,CAACC,QAAQ,CAAC;AACzD,CAAC;;AAED;AACA;AACA;AACA,OAAO,MAAMC,mBAAoD,GAC/DR,GAAG,CAACS,MAAM,CAACR,kBAAkB,CAAC","ignoreList":[]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","names":[],"sources":["../../../../src/common/search/types.ts"],"sourcesContent":["/**\n * Search options for querying forms\n */\nexport interface SearchOptions {\n  /**\n   * Search term to filter the results by title\n   */\n  title?: string\n}\n"],"mappings":"","ignoreList":[]}

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../../src/common/types.ts"],"sourcesContent":["import {\n  type PaginationOptions,\n  type PaginationResult\n} from '~/src/common/pagination/types.js'\nimport { type SortingOptions } from '~/src/common/sorting/types.js'\n\n/**\n * Options for querying results, including pagination and sorting\n */\nexport type QueryOptions = PaginationOptions & SortingOptions\n\n/**\n * Metadata containing the optional pagination and sorting information\n */\nexport interface Meta {\n  /**\n   * The pagination details\n   */\n  pagination?: PaginationResult\n\n  /**\n   * The sorting details\n   */\n  sorting?: SortingOptions\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":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../../src/common/types.ts"],"sourcesContent":["import {\n  type PaginationOptions,\n  type PaginationResult\n} from '~/src/common/pagination/types.js'\nimport { type SearchOptions } from '~/src/common/search/types.js'\nimport { type SortingOptions } from '~/src/common/sorting/types.js'\n\n/**\n * Options for querying results, including pagination, sorting, and searching\n */\nexport type QueryOptions = PaginationOptions & SortingOptions & SearchOptions\n\n/**\n * Metadata containing the optional pagination, sorting, and searching information\n */\nexport interface Meta {\n  /**\n   * The pagination details\n   */\n  pagination?: PaginationResult\n\n  /**\n   * The sorting details\n   */\n  sorting?: SortingOptions\n\n  /**\n   * The search details\n   */\n  search?: SearchOptions\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,6 +1,6 @@
 export * from "./common/schema.js";
 export * from "./common/pagination/index.js";
-export * from "./common/schema.js";
+export * from "./common/search/index.js";
 export * from "./common/sorting/index.js";
 export * from "./components/index.js";
 export * from "./conditions/index.js";

package/dist/module/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export * from '~/src/common/schema.js'\nexport * from '~/src/common/pagination/index.js'\nexport * from '~/src/common/schema.js'\nexport * from '~/src/common/sorting/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/types.js'\nexport type * from '~/src/common/pagination/types.js'\nexport type * from '~/src/common/sorting/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;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export * from '~/src/common/schema.js'\nexport * from '~/src/common/pagination/index.js'\nexport * from '~/src/common/search/index.js'\nexport * from '~/src/common/sorting/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/types.js'\nexport type * from '~/src/common/pagination/types.js'\nexport type * from '~/src/common/search/types.js'\nexport type * from '~/src/common/sorting/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;AACA;AACA;AACA","ignoreList":[]}

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

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../src/common/schema.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAIrB,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAEzD;;;GAGG;AACH,eAAO,MAAM,kBAAkB,EAAE,GAAG,CAAC,YAAY,CAAC,YAAY,CAG5D,CAAA"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../src/common/schema.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAKrB,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAEzD;;;GAGG;AACH,eAAO,MAAM,kBAAkB,EAAE,GAAG,CAAC,YAAY,CAAC,YAAY,CAI5D,CAAA"}

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

@@ -0,0 +1,13 @@
+import Joi from 'joi';
+import { type SearchOptions } from '../../common/search/types.js';
+/**
+ * Field definitions for search options.
+ */
+export declare const searchOptionFields: {
+    title: Joi.StringSchema<string>;
+};
+/**
+ * Joi schema for {@link SearchOptions} interface
+ */
+export declare const searchOptionsSchema: Joi.ObjectSchema<SearchOptions>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/common/search/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAA;AAErB,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,8BAA8B,CAAA;AAEjE;;GAEG;AACH,eAAO,MAAM,kBAAkB;;CAE9B,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,GAAG,CAAC,YAAY,CAAC,aAAa,CAChC,CAAA"}

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

@@ -0,0 +1,10 @@
+/**
+ * Search options for querying forms
+ */
+export interface SearchOptions {
+    /**
+     * Search term to filter the results by title
+     */
+    title?: string;
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/common/search/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf"}

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

@@ -1,11 +1,12 @@
 import { type PaginationOptions, type PaginationResult } from '../common/pagination/types.js';
+import { type SearchOptions } from '../common/search/types.js';
 import { type SortingOptions } from '../common/sorting/types.js';
 /**
- * Options for querying results, including pagination and sorting
+ * Options for querying results, including pagination, sorting, and searching
  */
-export type QueryOptions = PaginationOptions & SortingOptions;
+export type QueryOptions = PaginationOptions & SortingOptions & SearchOptions;
 /**
- * Metadata containing the optional pagination and sorting information
+ * Metadata containing the optional pagination, sorting, and searching information
  */
 export interface Meta {
     /**
@@ -16,6 +17,10 @@ export interface Meta {
      * The sorting details
      */
     sorting?: SortingOptions;
+    /**
+     * The search details
+     */
+    search?: SearchOptions;
 }
 /**
  * Standard response wrapper for query results with metadata

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/common/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACtB,MAAM,kCAAkC,CAAA;AACzC,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAEnE;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,iBAAiB,GAAG,cAAc,CAAA;AAE7D;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAA;IAE7B;;OAEG;IACH,OAAO,CAAC,EAAE,cAAc,CAAA;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,KAAK;IAChC;;OAEG;IACH,IAAI,EAAE,KAAK,EAAE,CAAA;IAEb;;OAEG;IACH,IAAI,EAAE,IAAI,CAAA;CACX"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/common/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACtB,MAAM,kCAAkC,CAAA;AACzC,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,8BAA8B,CAAA;AACjE,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAEnE;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,iBAAiB,GAAG,cAAc,GAAG,aAAa,CAAA;AAE7E;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAA;IAE7B;;OAEG;IACH,OAAO,CAAC,EAAE,cAAc,CAAA;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,CAAA;CACvB;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,6 +1,6 @@
 export * from './common/schema.js';
 export * from './common/pagination/index.js';
-export * from './common/schema.js';
+export * from './common/search/index.js';
 export * from './common/sorting/index.js';
 export * from './components/index.js';
 export * from './conditions/index.js';
@@ -13,6 +13,7 @@ export * from './utils/helpers.js';
 export * from './utils/markdown.js';
 export type * from './common/types.js';
 export type * from './common/pagination/types.js';
+export type * from './common/search/types.js';
 export type * from './common/sorting/types.js';
 export type * from './components/types.js';
 export type * from './conditions/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,wBAAwB,CAAA;AACtC,cAAc,kCAAkC,CAAA;AAChD,cAAc,wBAAwB,CAAA;AACtC,cAAc,+BAA+B,CAAA;AAC7C,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,uBAAuB,CAAA;AAC1C,mBAAmB,kCAAkC,CAAA;AACrD,mBAAmB,+BAA+B,CAAA;AAClD,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,wBAAwB,CAAA;AACtC,cAAc,kCAAkC,CAAA;AAChD,cAAc,8BAA8B,CAAA;AAC5C,cAAc,+BAA+B,CAAA;AAC7C,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,uBAAuB,CAAA;AAC1C,mBAAmB,kCAAkC,CAAA;AACrD,mBAAmB,8BAA8B,CAAA;AACjD,mBAAmB,+BAA+B,CAAA;AAClD,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.390",
+  "version": "3.0.392",
   "description": "A hapi plugin providing the model for Defra forms",
   "homepage": "https://github.com/DEFRA/forms-designer/tree/main/model#readme",
   "repository": {

package/src/common/schema.ts

@@ -1,6 +1,7 @@
 import Joi from 'joi'
 
 import { paginationOptionFields } from '~/src/common/pagination/index.js'
+import { searchOptionFields } from '~/src/common/search/index.js'
 import { sortingOptionFields } from '~/src/common/sorting/index.js'
 import { type QueryOptions } from '~/src/common/types.js'
 
@@ -10,5 +11,6 @@ import { type QueryOptions } from '~/src/common/types.js'
  */
 export const queryOptionsSchema: Joi.ObjectSchema<QueryOptions> = Joi.object({
   ...paginationOptionFields,
-  ...sortingOptionFields
+  ...sortingOptionFields,
+  ...searchOptionFields
 })

package/src/common/search/index.ts

@@ -0,0 +1,16 @@
+import Joi from 'joi'
+
+import { type SearchOptions } from '~/src/common/search/types.js'
+
+/**
+ * Field definitions for search options.
+ */
+export const searchOptionFields = {
+  title: Joi.string().trim().allow('').max(255).optional()
+}
+
+/**
+ * Joi schema for {@link SearchOptions} interface
+ */
+export const searchOptionsSchema: Joi.ObjectSchema<SearchOptions> =
+  Joi.object(searchOptionFields)

package/src/common/search/types.ts

@@ -0,0 +1,9 @@
+/**
+ * Search options for querying forms
+ */
+export interface SearchOptions {
+  /**
+   * Search term to filter the results by title
+   */
+  title?: string
+}

package/src/common/types.ts

@@ -2,15 +2,16 @@ import {
   type PaginationOptions,
   type PaginationResult
 } from '~/src/common/pagination/types.js'
+import { type SearchOptions } from '~/src/common/search/types.js'
 import { type SortingOptions } from '~/src/common/sorting/types.js'
 
 /**
- * Options for querying results, including pagination and sorting
+ * Options for querying results, including pagination, sorting, and searching
  */
-export type QueryOptions = PaginationOptions & SortingOptions
+export type QueryOptions = PaginationOptions & SortingOptions & SearchOptions
 
 /**
- * Metadata containing the optional pagination and sorting information
+ * Metadata containing the optional pagination, sorting, and searching information
  */
 export interface Meta {
   /**
@@ -22,6 +23,11 @@ export interface Meta {
    * The sorting details
    */
   sorting?: SortingOptions
+
+  /**
+   * The search details
+   */
+  search?: SearchOptions
 }
 
 /**

package/src/index.ts

@@ -1,6 +1,6 @@
 export * from '~/src/common/schema.js'
 export * from '~/src/common/pagination/index.js'
-export * from '~/src/common/schema.js'
+export * from '~/src/common/search/index.js'
 export * from '~/src/common/sorting/index.js'
 export * from '~/src/components/index.js'
 export * from '~/src/conditions/index.js'
@@ -14,6 +14,7 @@ export * from '~/src/utils/markdown.js'
 
 export type * from '~/src/common/types.js'
 export type * from '~/src/common/pagination/types.js'
+export type * from '~/src/common/search/types.js'
 export type * from '~/src/common/sorting/types.js'
 export type * from '~/src/components/types.js'
 export type * from '~/src/conditions/types.js'