@rjsf/utils 5.18.6 → 5.19.0

package/src/dateRangeOptions.ts

@@ -0,0 +1,31 @@
+import pad from './pad';
+import { EnumOptionsType, RJSFSchema, StrictRJSFSchema } from './types';
+
+/** Returns a list of options for a date range between `start` and `stop`. If the start date is greater than the end
+ * date, then the date range is reversed. If `start` and `stop` are negative numbers (or zero), then they will be
+ * treated as relative to the current year.
+ *
+ * @param start - The starting point of the date range
+ * @param stop - The ending point of the date range
+ * @returns - The list of EnumOptionsType for the date range between `start` and `stop`
+ * @throws - Error when `start` and `stop` aren't both <= 0 or > 0
+ */
+export default function dateRangeOptions<S extends StrictRJSFSchema = RJSFSchema>(
+  start: number,
+  stop: number
+): EnumOptionsType<S>[] {
+  if (start <= 0 && stop <= 0) {
+    start = new Date().getFullYear() + start;
+    stop = new Date().getFullYear() + stop;
+  } else if (start < 0 || stop < 0) {
+    throw new Error(`Both start (${start}) and stop (${stop}) must both be <= 0 or > 0, got one of each`);
+  }
+  if (start > stop) {
+    return dateRangeOptions<S>(stop, start).reverse();
+  }
+  const options: EnumOptionsType<S>[] = [];
+  for (let i = start; i <= stop; i++) {
+    options.push({ value: i, label: pad(i, 2) });
+  }
+  return options;
+}

package/src/index.ts

@@ -4,6 +4,7 @@ import canExpand from './canExpand';
 import createErrorHandler from './createErrorHandler';
 import createSchemaUtils from './createSchemaUtils';
 import dataURItoBlob from './dataURItoBlob';
+import dateRangeOptions from './dateRangeOptions';
 import deepEquals from './deepEquals';
 import englishStringTranslator from './englishStringTranslator';
 import enumOptionsDeselectValue from './enumOptionsDeselectValue';
@@ -68,6 +69,7 @@ export {
   createSchemaUtils,
   DateElementFormat,
   dataURItoBlob,
+  dateRangeOptions,
   deepEquals,
   descriptionId,
   englishStringTranslator,