@autofleet/sadot 0.6.4-beta.1 → 0.6.5

package/src/utils/validations/validators/index.ts

@@ -0,0 +1,31 @@
+import Joi from 'joi';
+import { CustomFieldDefinitionType } from '../../constants';
+import type { Validators } from '../type';
+import { validateSelect } from './select.validator';
+import { validateStatus } from './status.validator';
+
+type CustomValidationTypes = Extract<CustomFieldDefinitionType, 'select' | 'status'>;
+/**
+ * Custom field types that must have custom validation.
+ * TODO: remove this after moving to schema-based validation
+ */
+export const CustomValidationTypes = {
+  [CustomFieldDefinitionType.SELECT]: CustomFieldDefinitionType.SELECT,
+  [CustomFieldDefinitionType.STATUS]: CustomFieldDefinitionType.STATUS,
+} as const;
+
+/**
+ * Validators for custom fields
+ */
+export const validators: Validators = {
+  [CustomFieldDefinitionType.SELECT]: validateSelect,
+  [CustomFieldDefinitionType.STATUS]: validateStatus,
+  [CustomFieldDefinitionType.TEXT]: (value) => (typeof value === 'string'),
+  [CustomFieldDefinitionType.NUMBER]: (value) => (typeof value === 'number'),
+  [CustomFieldDefinitionType.BOOLEAN]: (value) => (typeof value === 'boolean'),
+  [CustomFieldDefinitionType.DATE]: (value) => (!Joi.date().validate(value).error),
+  [CustomFieldDefinitionType.DATETIME]: (value) => (!Joi.date().validate(value).error),
+  [CustomFieldDefinitionType.IMAGE]: (value) => (!Joi.array().min(1).unique()
+    .items(Joi.string().uri())
+    .validate(value).error),
+};

package/src/utils/validations/validators/select.validator.ts

@@ -0,0 +1,11 @@
+import type { Validator } from '../type';
+
+/**
+ * Validate that the value is one of the select values
+ */
+export const validateSelect: Validator<string, string[]> = (
+  value,
+  selectValues,
+) => (Array.isArray(selectValues)
+      && selectValues.includes(value)
+);

package/src/utils/validations/validators/status.validator.ts

@@ -0,0 +1,18 @@
+import type { Validator } from '../type';
+
+type StatusColor = string | null; // TODO: Takes from @autofleet/colors ?
+type StatusValue = string;
+type StatusOption = {
+  value: StatusValue;
+  color: StatusColor;
+}
+
+/**
+* Validate that the value is one of the status values
+*/
+export const validateStatus: Validator<StatusValue, StatusOption[]> = (
+  value,
+  statusValues,
+) => (Array.isArray(statusValues)
+   && statusValues.some((status) => status.value === value)
+);

package/dist/utils/validations/custom.d.ts

@@ -1,15 +0,0 @@
-export declare const mustHaveCustomValidation: {
-    select: boolean;
-};
-/**
- * Validates the given validations object against the supported field types and their validators.
- * @return true if the validation is valid, false otherwise.
- */
-export declare const validateValidation: (valueType: any, validation: any) => boolean;
-/**
- * Validates the given value against the custom validation rules for the specified field type.
- * If no custom validation rules are provided, it falls back to the default validation.
- * @returns true if the value is valid according to the validation rules, false otherwise.
- */
-declare const customValidation: (value: any, valueType: any, validation: any) => boolean;
-export default customValidation;

package/dist/utils/validations/custom.js

@@ -1,42 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateValidation = exports.mustHaveCustomValidation = void 0;
-/* eslint-disable no-shadow */
-const logger_1 = __importDefault(require("../logger"));
-const type_1 = require("./type");
-const validators_1 = __importDefault(require("./validators"));
-exports.mustHaveCustomValidation = {
-    [type_1.CustomFieldDefinitionType.SELECT]: true,
-};
-/**
- * Validates the given validations object against the supported field types and their validators.
- * @return true if the validation is valid, false otherwise.
- */
-const validateValidation = (valueType, validation) => {
-    if (!validation) {
-        if (exports.mustHaveCustomValidation[valueType]) {
-            logger_1.default.error(`No custom validation for custom field type ${valueType} found`);
-            return false;
-        }
-        return true;
-    }
-    return true;
-};
-exports.validateValidation = validateValidation;
-/**
- * Validates the given value against the custom validation rules for the specified field type.
- * If no custom validation rules are provided, it falls back to the default validation.
- * @returns true if the value is valid according to the validation rules, false otherwise.
- */
-const customValidation = (value, valueType, validation) => {
-    const validator = validators_1.default?.[valueType];
-    if (!validation || !validator) {
-        return (0, exports.validateValidation)(valueType, validation);
-    }
-    // Always allow null values
-    return value === null || validator(value, validation);
-};
-exports.default = customValidation;

package/dist/utils/validations/validators.d.ts

@@ -1,12 +0,0 @@
-export declare enum CustomValidations {
-    SELECT = "select",
-    RANGE = "between"
-}
-type Validator = (value: any, validation: any) => boolean;
-/**
- * Validators for custom fields
- */
-declare const validators: {
-    [key: string]: Validator;
-};
-export default validators;

package/dist/utils/validations/validators.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomValidations = void 0;
-// eslint-disable-next-line no-shadow
-var CustomValidations;
-(function (CustomValidations) {
-    CustomValidations["SELECT"] = "select";
-    CustomValidations["RANGE"] = "between";
-})(CustomValidations = exports.CustomValidations || (exports.CustomValidations = {}));
-/**
- * Validate {@link CustomValidations.ENUM Enum}
- */
-const validateEnum = (value, enumValues) => (Array.isArray(enumValues)
-    && enumValues.length > 0
-    && enumValues.includes(value));
-/**
- * Validate {@link CustomValidations.RANGE Range}
- */
-const validateRange = (value, range) => {
-    const [min, max] = range;
-    if (min === undefined || max === undefined) {
-        return false;
-    }
-    return value >= range.min && value <= range.max;
-};
-/**
- * Validators for custom fields
- */
-const validators = {
-    [CustomValidations.SELECT]: validateEnum,
-    [CustomValidations.RANGE]: validateRange,
-};
-exports.default = validators;

package/src/utils/validations/custom.ts

@@ -1,39 +0,0 @@
-/* eslint-disable no-shadow */
-import logger from '../logger';
-import { CustomFieldDefinitionType } from './type';
-import validators from './validators';
-
-export const mustHaveCustomValidation = {
-  [CustomFieldDefinitionType.SELECT]: true,
-};
-
-/**
- * Validates the given validations object against the supported field types and their validators.
- * @return true if the validation is valid, false otherwise.
- */
-export const validateValidation = (valueType, validation) => {
-  if (!validation) {
-    if (mustHaveCustomValidation[valueType]) {
-      logger.error(`No custom validation for custom field type ${valueType} found`);
-      return false;
-    }
-    return true;
-  }
-  return true;
-};
-
-/**
- * Validates the given value against the custom validation rules for the specified field type.
- * If no custom validation rules are provided, it falls back to the default validation.
- * @returns true if the value is valid according to the validation rules, false otherwise.
- */
-const customValidation = (value, valueType, validation) => {
-  const validator = validators?.[valueType];
-  if (!validation || !validator) {
-    return validateValidation(valueType, validation);
-  }
-  // Always allow null values
-  return value === null || validator(value, validation);
-};
-
-export default customValidation;

package/src/utils/validations/validators.ts

@@ -1,34 +0,0 @@
-// eslint-disable-next-line no-shadow
-export enum CustomValidations {
-    SELECT = 'select',
-    RANGE = 'between'
-}
-
-type Validator = (value, validation) => boolean;
-/**
- * Validate {@link CustomValidations.ENUM Enum}
- */
-const validateEnum: Validator = (value, enumValues) => (Array.isArray(enumValues)
-    && enumValues.length > 0
-    && enumValues.includes(value)
-);
-/**
- * Validate {@link CustomValidations.RANGE Range}
- */
-const validateRange: Validator = (value, range) => {
-  const [min, max] = range;
-  if (min === undefined || max === undefined) {
-    return false;
-  }
-  return value >= range.min && value <= range.max;
-};
-
-/**
- * Validators for custom fields
- */
-const validators: { [key: string]: Validator } = {
-  [CustomValidations.SELECT]: validateEnum,
-  [CustomValidations.RANGE]: validateRange,
-};
-
-export default validators;