@wix/patterns-fields 1.0.0

package/src/validations/time.ts

@@ -0,0 +1,109 @@
+export type Time = string; // hh:mm:ss.SSS
+
+/**
+ * The COMMON_TIME_STRUCTURE_REGEXP represents time in the format hh:mm:ss.SSS
+ * where hh and mm parts are required, but ss and SSS are optional
+ */
+const COMMON_TIME_STRUCTURE_REGEXP = /(\d+):(\d+)(?::(\d+))?(?:\.(\d+))?/;
+
+// For parsing strings as time
+const ANY_TIME_FORMAT_REGEXP = new RegExp(
+  [
+    // case of full time string 00:00:00.000
+    '(^(([0-1]?\\d)|(2[0-3]))(:|\\.)?([0-5][0-9])((:|\\.)?([0-5][0-9]))?((:|\\.)([0-9]{1,3}))?$)',
+    // case of short time 00:00 AM
+    '(^((0?[1-9])|(1[0-2]))(:|\\.)?([0-5][0-9])( |,)?(([aA]|[pP])[mM])$)',
+    // case of short time AM 00:00
+    '(^(([aA]|[pP])[mM])( |,)?((0?[1-9])|(1[0-2]))(:|\\.)?([0-5][0-9])$)',
+  ].join('|'),
+);
+
+// NOTE: The `matchTimeString` function is tightly coupled to `ANY_TIME_FORMAT_REGEXP`
+const matchTimeString = (timeString: string) => {
+  const match = timeString.match(ANY_TIME_FORMAT_REGEXP);
+
+  if (!match) {
+    return;
+  }
+
+  return {
+    fullHour: match[2],
+    fullMin: match[6],
+    fullSec: match[9],
+    fullMsec: match[12],
+
+    postHour: match[14],
+    postMin: match[18],
+    postPeriod: match[20],
+
+    prePeriod: match[23],
+    preHour: match[26],
+    preMin: match[30],
+  };
+};
+
+const numberToTimePart = (number: number, partLength = 2) => {
+  return ('00' + number).slice(-partLength);
+};
+
+const dateToTime = (date: Date): Time => {
+  if (!Number.isFinite(date.getTime())) {
+    return '00:00:00.000';
+  }
+
+  const hh = numberToTimePart(date.getHours());
+  const mm = numberToTimePart(date.getMinutes());
+  const ss = numberToTimePart(date.getSeconds());
+  const SSS = numberToTimePart(date.getMilliseconds(), 3);
+
+  return `${hh}:${mm}:${ss}.${SSS}`;
+};
+
+export const isValid = (data: unknown): data is Time => {
+  return (
+    typeof data === 'string' &&
+    COMMON_TIME_STRUCTURE_REGEXP.test(data) &&
+    ANY_TIME_FORMAT_REGEXP.test(data)
+  );
+};
+
+export const hardConvert = (data: unknown): Time => {
+  let date: Date | undefined;
+
+  if (typeof data === 'string') {
+    const matches = matchTimeString(data);
+
+    if (matches) {
+      const {
+        fullHour,
+        fullMin,
+        fullSec,
+        fullMsec,
+        postHour,
+        postMin,
+        postPeriod,
+        preHour,
+        preMin,
+        prePeriod,
+      } = matches;
+
+      let hours = parseInt(fullHour ?? postHour ?? preHour ?? '00', 10);
+      const mins = parseInt(fullMin ?? postMin ?? preMin ?? '00', 10);
+      const secs = parseInt(fullSec ?? '00', 10);
+      const msecs = parseInt(fullMsec?.padEnd(3, '0') ?? '000', 10);
+      const period = (postPeriod ?? prePeriod ?? 'am').toLowerCase();
+
+      hours += period === 'pm' ? 12 : 0;
+
+      date = new Date();
+
+      date.setHours(hours, mins, secs, msecs);
+    }
+  }
+
+  if (!date || !date.getTime()) {
+    throw new Error(`Can not convert "${data}" to time`);
+  }
+
+  return dateToTime(date);
+};

package/src/validations/validations.ts

@@ -0,0 +1,45 @@
+export interface FieldTypeValidationModule {
+  isValid?: (data: any) => boolean;
+  isStrictValid?: (data: any) => boolean;
+}
+
+export const isDataValid = (
+  data: any,
+  module: FieldTypeValidationModule,
+  { strict }: { strict?: boolean } = {},
+): boolean => {
+  if (strict && module?.isStrictValid) {
+    return module.isStrictValid(data);
+  }
+
+  return module?.isValid ? module.isValid(data) : true;
+};
+
+export const isDataNotSet = (data: any) => {
+  return data === undefined || data === null;
+};
+
+export const isDataValidOrNotSet = (
+  data: any,
+  module: FieldTypeValidationModule,
+  { strict }: { strict?: boolean } = {},
+): boolean => {
+  return isDataNotSet(data) || isDataValid(data, module, { strict });
+};
+
+// Validation modules as namespaces
+import * as arrayValidation from './array';
+import * as emailValidation from './email';
+import * as objectValidation from './object';
+import * as richContentValidation from './rich-content';
+import * as richTextValidation from './rich-text';
+import * as timeValidation from './time';
+
+export {
+  arrayValidation,
+  emailValidation,
+  objectValidation,
+  richContentValidation,
+  richTextValidation,
+  timeValidation,
+};

package/src/validations/video.ts

@@ -0,0 +1,18 @@
+import { isMediaVideoURI } from '../auto-field-types';
+
+export const isValid = (data: unknown): data is string => {
+  if (data === null || data === undefined || data === '') {
+    return true;
+  }
+  if (typeof data !== 'string') {
+    return false;
+  }
+  return isMediaVideoURI(data);
+};
+
+export const hardConvert = (data: unknown): string | null => {
+  if (isValid(data)) {
+    return data as string;
+  }
+  throw new Error(`Cannot convert "${data}" into a video URI`);
+};

package/types/package.json

@@ -0,0 +1,5 @@
+{
+  "main": "../dist/cjs/exports/types.js",
+  "module": "../dist/esm/exports/types.js",
+  "types": "../dist/types/exports/types.d.ts"
+}

package/unidriver/package.json

@@ -0,0 +1,5 @@
+{
+  "main": "../dist/cjs/exports/unidriver.js",
+  "module": "../dist/esm/exports/unidriver.js",
+  "types": "../dist/types/exports/unidriver.d.ts"
+}

package/validations/package.json

@@ -0,0 +1,5 @@
+{
+  "main": "../dist/cjs/exports/validations.js",
+  "module": "../dist/esm/exports/validations.js",
+  "types": "../dist/types/exports/validations.d.ts"
+}