@rjsf/utils 5.15.0 → 5.16.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rjsf/utils",
-  "version": "5.15.0",
+  "version": "5.16.0",
   "main": "dist/index.js",
   "module": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -43,29 +43,29 @@
     "react-is": "^18.2.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.22.17",
+    "@babel/core": "^7.23.7",
     "@babel/plugin-proposal-class-properties": "^7.18.6",
     "@babel/plugin-proposal-optional-chaining": "^7.21.0",
-    "@babel/preset-env": "^7.22.15",
-    "@babel/preset-react": "^7.22.15",
-    "@babel/preset-typescript": "^7.22.15",
-    "@types/jest": "^29.5.5",
-    "@types/json-schema": "^7.0.12",
-    "@types/json-schema-merge-allof": "^0.6.1",
-    "@types/lodash": "^4.14.198",
-    "@types/react": "^17.0.65",
-    "@types/react-is": "^17.0.4",
-    "@types/react-test-renderer": "^17.0.3",
-    "babel-jest": "^29.6.4",
+    "@babel/preset-env": "^7.23.7",
+    "@babel/preset-react": "^7.23.3",
+    "@babel/preset-typescript": "^7.23.3",
+    "@types/jest": "^29.5.11",
+    "@types/json-schema": "^7.0.15",
+    "@types/json-schema-merge-allof": "^0.6.5",
+    "@types/lodash": "^4.14.202",
+    "@types/react": "^17.0.74",
+    "@types/react-is": "^17.0.7",
+    "@types/react-test-renderer": "^17.0.9",
+    "babel-jest": "^29.7.0",
     "deep-freeze-es6": "^1.4.1",
     "esbuild": "^0.18.20",
-    "eslint": "^8.48.0",
-    "jest": "^29.6.4",
-    "jest-environment-jsdom": "^29.6.4",
+    "eslint": "^8.56.0",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
     "react": "^17.0.2",
     "react-test-renderer": "^17.0.2",
-    "rimraf": "^5.0.1",
-    "rollup": "^3.29.0",
+    "rimraf": "^5.0.5",
+    "rollup": "^3.29.4",
     "typescript": "^4.9.5"
   },
   "publishConfig": {
@@ -86,5 +86,5 @@
     "url": "git+https://github.com/rjsf-team/react-jsonschema-form.git"
   },
   "license": "Apache-2.0",
-  "gitHead": "12781f3527ff494668913637e5aabcf27db952b1"
+  "gitHead": "c7ed12043fdd91bc1344ffd7c9404deac31374a7"
 }

package/src/getDateElementProps.ts

@@ -0,0 +1,56 @@
+import { type DateObject } from './types';
+
+/** Available options for re-ordering date input element */
+export type DateElementFormat = 'DMY' | 'MDY' | 'YMD';
+
+/** Type describing format of DateElement prop */
+type DateElementProp = {
+  type: string;
+  range: [number, number];
+  value: number | undefined;
+};
+
+/** Given date & time information with optional yearRange & format, returns props for DateElement
+ *
+ * @param date - Object containing date with optional time information
+ * @param time - Determines whether to include time or not
+ * @param [yearRange=[1900, new Date().getFullYear() + 2]] - Controls the list of years to be displayed
+ * @param [format='YMD'] - Controls the order in which day, month and year input element will be displayed
+ * @returns Array of props for DateElement
+ */
+
+export default function getDateElementProps(
+  date: DateObject,
+  time: boolean,
+  yearRange: [number, number] = [1900, new Date().getFullYear() + 2],
+  format: DateElementFormat = 'YMD'
+) {
+  const { day, month, year, hour, minute, second } = date;
+
+  const dayObj: DateElementProp = { type: 'day', range: [1, 31], value: day };
+  const monthObj: DateElementProp = { type: 'month', range: [1, 12], value: month };
+  const yearObj: DateElementProp = { type: 'year', range: yearRange, value: year };
+
+  const dateElementProp: DateElementProp[] = [];
+  switch (format) {
+    case 'MDY':
+      dateElementProp.push(monthObj, dayObj, yearObj);
+      break;
+    case 'DMY':
+      dateElementProp.push(dayObj, monthObj, yearObj);
+      break;
+    case 'YMD':
+    default:
+      dateElementProp.push(yearObj, monthObj, dayObj);
+  }
+
+  if (time) {
+    dateElementProp.push(
+      { type: 'hour', range: [0, 23], value: hour },
+      { type: 'minute', range: [0, 59], value: minute },
+      { type: 'second', range: [0, 59], value: second }
+    );
+  }
+
+  return dateElementProp;
+}

package/src/index.ts

@@ -13,6 +13,7 @@ import enumOptionsSelectValue from './enumOptionsSelectValue';
 import enumOptionsValueForIndex from './enumOptionsValueForIndex';
 import ErrorSchemaBuilder from './ErrorSchemaBuilder';
 import findSchemaDefinition from './findSchemaDefinition';
+import getDateElementProps, { type DateElementFormat } from './getDateElementProps';
 import getDiscriminatorFieldFromSchema from './getDiscriminatorFieldFromSchema';
 import getInputProps from './getInputProps';
 import getSchemaType from './getSchemaType';
@@ -65,6 +66,7 @@ export {
   canExpand,
   createErrorHandler,
   createSchemaUtils,
+  DateElementFormat,
   dataURItoBlob,
   deepEquals,
   descriptionId,
@@ -78,6 +80,7 @@ export {
   examplesId,
   ErrorSchemaBuilder,
   findSchemaDefinition,
+  getDateElementProps,
   getDiscriminatorFieldFromSchema,
   getInputProps,
   getOptionMatchingSimpleDiscriminator,