From 3e57aa65361116ca0ec7dc39e0f45bc0cf4c7c0a Mon Sep 17 00:00:00 2001
From: trevor-anderson <trevor@nerdware.cloud>
Date: Tue, 20 Feb 2024 10:10:09 -0500
Subject: [PATCH] feat: add dayjs type-safety utils

---
 src/utils/typeSafety/dayjs.ts | 63 +++++++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 src/utils/typeSafety/dayjs.ts

diff --git a/src/utils/typeSafety/dayjs.ts b/src/utils/typeSafety/dayjs.ts
new file mode 100644
index 00000000..80f69f13
--- /dev/null
+++ b/src/utils/typeSafety/dayjs.ts
@@ -0,0 +1,63 @@
+import dayjs, { type ConfigType as DayJsCtorParamType } from "dayjs";
+
+/**
+ * This type reflects values that can be converted to a valid DayJS timestamp.
+ *
+ * The `dayjs` constructor accepts {@link DayJsCtorParamType|multiple arg types};
+ * this type excludes `null` and `undefined` from the union of permitted values
+ * since they'll never result in a valid timestamp.
+ */
+export type ValidTimestamp = Exclude<DayJsCtorParamType, null | undefined>;
+
+/**
+ * `typeof` strings of value-types which should not be provided to the `dayjs`
+ * constructor in {@link isValidTimestamp}.
+ */
+const INVALID_TIMESTAMP_VALUE_TYPES = new Set([
+  "symbol", //  <-- causes `dayjs()` to throw
+  "bigint", //  <-- causes `dayjs()` to throw
+  "boolean", // <-- causes false positives in `dayjs.isValid`
+]);
+
+/**
+ * This `dayjs` helper checks if the provided `value` is a valid type which may be converted into
+ * a timestamp.
+ *
+ * @param value - The value to check.
+ * @param onlyAllow13DigitNumbers - If `true`, only 13-digit numbers are considered valid (see below).
+ *
+ * ### Numerical Timestamp Range
+ *
+ * If `onlyAllow13DigitNumbers` is `true` (default: `true`), the fn will only consider 13-digit
+ * numbers to be valid timestamps. This setting ensures unix timestamps — _in SECONDS_ — are not
+ * accidentally interpreted as milliseconds. If this fn is used to validate timestamps in seconds,
+ * or if the fn is being used to validate timestamps out of the lower/upper bounds of the 13-digit
+ * range, set `onlyAllow13DigitNumbers` to `false`.
+ *
+ * **13 Digit Timestamp Range:**
+ *
+ * - **Lower Bound:** `1000000000000` (Sun Sep 09 2001 01:46:40 GMT+0000)
+ * - **Upper Bound:** `9999999999999` (Tue Nov 20 2286 17:46:39 GMT+0000)
+ *
+ * ### `dayjs.isValid` Notes:
+ *
+ * - The fn will only throw when given a `Symbol` or `BigInt`.
+ * - The fn will return `false` for `null`, `""` (empty string), and invalid objects.
+ * - The fn will return `true` for `undefined` and `0`, which for this project's purposes are not
+ *   valid timestamps, so the conditional contains a truthy-check to weed out these false positives.
+ */
+export const isValidTimestamp = (
+  value?: unknown,
+  onlyAllow13DigitNumbers: boolean = true
+): value is ValidTimestamp => {
+  if (!value || INVALID_TIMESTAMP_VALUE_TYPES.has(typeof value)) {
+    return false;
+  }
+
+  if (typeof value === "number" && onlyAllow13DigitNumbers && `${value}`.length !== 13) {
+    return false;
+  }
+
+  // `value` is cast to any, bc the previous checks ensure it won't throw
+  return dayjs(value as any).isValid();
+};