@defra/forms-model 3.0.429 → 3.0.431

package/scripts/schema-modules/utils.js

@@ -0,0 +1,41 @@
+import fs from 'fs'
+
+/**
+ * Ensures a directory exists
+ * @param {string} dir Directory path
+ */
+export function ensureDirectoryExists(dir) {
+  if (!fs.existsSync(dir)) {
+    fs.mkdirSync(dir, { recursive: true })
+  }
+}
+
+/**
+ * Formats a kebab-case string to Title Case
+ * @param {string} str String to format
+ * @returns {string} Formatted string
+ */
+export function toTitleCase(str) {
+  return str
+    .split('-')
+    .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+    .join(' ')
+}
+
+/**
+ * Format camelCase or snake_case to Title Case
+ * @param {string} str String to format
+ * @returns {string} Formatted string
+ */
+export function formatPropertyName(str) {
+  return (
+    str
+      // camelCase to space-separated
+      .replace(/([A-Z])/g, ' $1')
+      // snake_case to space-separated
+      .replace(/_/g, ' ')
+      // Capitalize first letter
+      .replace(/^./, (first) => first.toUpperCase())
+      .trim()
+  )
+}

package/src/common/pagination/index.ts

@@ -6,7 +6,13 @@ import { type PaginationOptions } from '~/src/common/pagination/types.js'
  * Field definitions for pagination options.
  */
 export const paginationOptionFields = {
-  page: Joi.number().positive().integer().default(1).min(1).optional(),
+  page: Joi.number()
+    .positive()
+    .integer()
+    .default(1)
+    .min(1)
+    .optional()
+    .description('Current page number, starting from 1'),
   perPage: Joi.number()
     .positive()
     .integer()
@@ -14,6 +20,7 @@ export const paginationOptionFields = {
     .min(1)
     .max(200)
     .optional()
+    .description('Number of items to display per page, between 1 and 200')
 }
 
 /**

package/src/common/search/index.ts

@@ -7,18 +7,32 @@ import { organisations } from '~/src/form/form-metadata/index.js'
  * Field definitions for search options.
  */
 export const searchOptionFields = {
-  title: Joi.string().trim().allow('').max(255).optional().default(''),
-  author: Joi.string().trim().allow('').max(100).optional().default(''),
+  title: Joi.string()
+    .trim()
+    .allow('')
+    .max(255)
+    .optional()
+    .default('')
+    .description('Search by form title, empty string matches all'),
+  author: Joi.string()
+    .trim()
+    .allow('')
+    .max(100)
+    .optional()
+    .default('')
+    .description('Search by form author, empty string matches all'),
   organisations: Joi.array()
     .items(Joi.string().valid(...organisations))
     .single()
     .optional()
-    .default([]),
+    .default([])
+    .description('Filter by organisation(s), empty array matches all'),
   status: Joi.array()
     .items(Joi.string().valid('draft', 'live'))
     .single()
     .optional()
     .default([])
+    .description('Filter by form status(es), empty array matches all')
 }
 
 /**

package/src/common/sorting/index.ts

@@ -6,8 +6,14 @@ import { type SortingOptions } from '~/src/common/sorting/types.js'
  * Field definitions for sorting options.
  */
 export const sortingOptionFields = {
-  sortBy: Joi.string().valid('updatedAt', 'title').optional(),
-  order: Joi.string().valid('asc', 'desc').optional()
+  sortBy: Joi.string()
+    .valid('updatedAt', 'title')
+    .optional()
+    .description('Field to sort results by'),
+  order: Joi.string()
+    .valid('asc', 'desc')
+    .optional()
+    .description('Sort order (ascending or descending)')
 }
 
 /**