@autofleet/sadot 0.0.1-beta.9 → 0.1.0

package/src/repository/definition.ts

@@ -10,10 +10,10 @@ export const findAll = (
   options: any = { withDisabled: false },
 ): Promise<CustomFieldDefinition[]> => {
   if (options.withDisabled) {
-    return CustomFieldDefinition.unscoped().findAll({ where });
+    return CustomFieldDefinition.unscoped().scope('userScope').findAll({ where });
   }
 
-  return CustomFieldDefinition.findAll({ where });
+  return CustomFieldDefinition.scope('userScope').findAll({ where });
 };
 
 export const findByIds = (
@@ -27,13 +27,9 @@ export const findById = (
 ): Promise<CustomFieldDefinition | null> => {
   const { withDisabled } = options;
   if (withDisabled) {
-    return CustomFieldDefinition.unscoped().findByPk(id, {
-      include: [CustomFieldValue],
-    });
+    return CustomFieldDefinition.unscoped().scope('userScope').findByPk(id);
   }
-  return CustomFieldDefinition.findByPk(id, {
-    include: [CustomFieldValue],
-  });
+  return CustomFieldDefinition.scope('userScope').findByPk(id);
 };
 
 export const findByEntityId = async (
@@ -45,7 +41,7 @@ export const findByEntityId = async (
 });
 
 export const findByWhere = (where): Promise<CustomFieldDefinition | null> =>
-  CustomFieldDefinition.findOne({
+  CustomFieldDefinition.scope('userScope').findOne({
     where,
     include: [CustomFieldValue],
   });
@@ -66,7 +62,7 @@ export const update = async (
   id: string,
   data: UpdateCustomFieldDefinition,
 ): Promise<CustomFieldDefinition> => {
-  const updatedDefinition = (await CustomFieldDefinition.update(data, {
+  const updatedDefinition = (await CustomFieldDefinition.scope('userScope').update(data, {
     where: { id },
     returning: true,
     individualHooks: true,

package/src/repository/value.ts

@@ -3,6 +3,7 @@ import { CustomFieldValue, CustomFieldDefinition } from '../models';
 import * as DefinitionRepo from './definition';
 import { CreateCustomFieldValue, ValuesToUpdate } from '../types/value';
 import logger from '../utils/logger';
+import { MissingDefinitionError } from '../errors';
 
 export const findByModelIdAndDefinition = async (modelId: string, customFieldDefinitionId: string) =>
   CustomFieldValue.findAll({ where: { modelId, customFieldDefinitionId }, include: [CustomFieldDefinition] });
@@ -61,7 +62,7 @@ export const updateValues = async (
   const disabledDefinitions = fieldDefinitions.filter((def) => def.disabled);
   if (fieldDefinitions.length !== names.length) {
     const missingDefinitions = names.filter((name) => !fieldDefinitions.some((def) => def.name === name));
-    throw new Error(`custom-fields: missing definitions for ${missingDefinitions.join(', ')}`);
+    throw new MissingDefinitionError(missingDefinitions);
   }
 
   const disabledNames = disabledDefinitions?.map((def) => def.name) || [];

package/src/tests/mocks/{index.ts → definition.mock.ts}

@@ -30,10 +30,8 @@ export const booleanField = (modelType: string): CreateCustomFieldDefinition =>
 export const enumField = (modelType: string, options): CreateCustomFieldDefinition => ({
   name: 'choices',
   modelType,
-  fieldType: 'enum',
-  validation: {
-    enum: options,
-  },
+  fieldType: 'select',
+  validation: options,
   entityId: uuidv4(),
   entityType: 'fleetId',
 });

package/src/types/index.ts

@@ -1,5 +1,3 @@
-import type { Sequelize as InnerSequelize } from 'sequelize-typescript';
-
 export type ModelFetcher = (name: string) => any;
 
 export type ModelOptions = {
@@ -12,6 +10,6 @@ export type ModelOptions = {
 
 export type CustomFieldOptions= {
     models: ModelOptions[];
-    innerSequelize?: InnerSequelize;
     databaseConfig: any;
+    getUser: () => any;
   };

package/src/utils/validations/custom.ts

@@ -1,57 +1,39 @@
 /* eslint-disable no-shadow */
-import { CustomFieldDefinitionType } from '../../models/CustomFieldDefinition';
 import logger from '../logger';
+import { CustomFieldDefinitionType } from './type';
+import validators from './validators';
 
-enum CustomValidations {
-    ENUM = 'enum',
-    RANGE = 'between'
-  }
-const mustHaveCustomValidation = {
-  [CustomFieldDefinitionType.ENUM]: true,
-};
-  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 customValidators: { [key: string]: Validator } = {
-  [CustomValidations.ENUM]: validateEnum,
-  [CustomValidations.RANGE]: validateRange,
+export const mustHaveCustomValidation = {
+  [CustomFieldDefinitionType.SELECT]: true,
 };
 
-const customValidation = (value, valueType, validations) => {
-  const validator = customValidators[valueType];
-  const validation = validations[valueType];
-  if (mustHaveCustomValidation[valueType]) {
-    if (!validation) {
+/**
+ * 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; // TODO: Return better error message
+      return false;
     }
-  }
-  if (!validation) {
     return true;
   }
-  if (!validator) {
-    logger.error(`No validator for custom field type ${valueType} found`);
-    return false;
+  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);
   }
-  return validator(value, validation);
+  // Always allow null values
+  return value === null || validator(value, validation);
 };
 
 export default customValidation;

package/src/utils/validations/type.ts

@@ -1,11 +1,27 @@
 import Joi from '@hapi/joi';
-import { CustomFieldDefinitionType } from '../../models/CustomFieldDefinition';
-
+/**
+ * Supported custom field types
+ */
+// eslint-disable-next-line no-shadow
+export enum CustomFieldDefinitionType {
+  NUMBER = 'number',
+  BOOLEAN = 'boolean',
+  DATE = 'date',
+  DATETIME = 'datetime',
+  TEXT = 'text',
+  IMAGE = 'image',
+  SELECT = 'select',
+}
 /**
  * Validate that the given value is really of type "valueType"
  * TODO: verify that required field not set to null
  */
-const validateValueType = (value, valueType: CustomFieldDefinitionType) => {
+const validateValueType = (value: unknown, valueType: CustomFieldDefinitionType): boolean => {
+  if (value === null) {
+    // Null is always allowed
+    return true;
+  }
+
   switch (valueType) {
     case CustomFieldDefinitionType.TEXT:
       return typeof value === 'string';
@@ -16,8 +32,8 @@ const validateValueType = (value, valueType: CustomFieldDefinitionType) => {
     case CustomFieldDefinitionType.DATE:
     case CustomFieldDefinitionType.DATETIME:
       return !Joi.date().validate(value).error;
-    case CustomFieldDefinitionType.ENUM:
-      return true;
+    case CustomFieldDefinitionType.SELECT:
+      return true; // custom validation
     case CustomFieldDefinitionType.IMAGE:
       return !Joi.string().uri().validate(value).error;
     default:

package/src/utils/validations/validators.ts

@@ -0,0 +1,34 @@
+// 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;

package/dist/tests/mocks/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/tests/mocks/index.ts"],"names":[],"mappings":";;;AAAA,+BAAoC;AAGvB,QAAA,mBAAmB,GAAgC;IAC9D,IAAI,EAAE,YAAY;IAClB,SAAS,EAAE,WAAW;IACtB,SAAS,EAAE,QAAQ;IACnB,QAAQ,EAAE,IAAA,SAAM,GAAE;IAClB,UAAU,EAAE,SAAS;CACtB,CAAC;AAEW,QAAA,oBAAoB,mCAC5B,2BAAmB,KACtB,IAAI,EAAE,aAAa,IACnB;AAEW,QAAA,oBAAoB,mCAC5B,2BAAmB,KACtB,IAAI,EAAE,aAAa,IACnB;AAEK,MAAM,YAAY,GAAG,CAAC,SAAiB,EAA+B,EAAE,CAAC,CAAC;IAC/E,IAAI,EAAE,WAAW;IACjB,SAAS;IACT,SAAS,EAAE,SAAS;IACpB,QAAQ,EAAE,IAAA,SAAM,GAAE;IAClB,UAAU,EAAE,SAAS;CACtB,CAAC,CAAC;AANU,QAAA,YAAY,gBAMtB;AAEI,MAAM,SAAS,GAAG,CAAC,SAAiB,EAAE,OAAO,EAA+B,EAAE,CAAC,CAAC;IACrF,IAAI,EAAE,SAAS;IACf,SAAS;IACT,SAAS,EAAE,MAAM;IACjB,UAAU,EAAE;QACV,IAAI,EAAE,OAAO;KACd;IACD,QAAQ,EAAE,IAAA,SAAM,GAAE;IAClB,UAAU,EAAE,SAAS;CACtB,CAAC,CAAC;AATU,QAAA,SAAS,aASnB;AAEI,MAAM,UAAU,GAAG,CAAC,SAAiB,EAA+B,EAAE,CAAC,CAAC;IAC7E,IAAI,EAAE,QAAQ;IACd,SAAS;IACT,SAAS,EAAE,QAAQ;IACnB,UAAU,EAAE;QACV,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC;KAClB;IACD,QAAQ,EAAE,IAAA,SAAM,GAAE;IAClB,UAAU,EAAE,SAAS;CACtB,CAAC,CAAC;AATU,QAAA,UAAU,cASpB;AAEH,mCAAmC;AAC5B,MAAM,gBAAgB,GAAG,CAAC,QAA2C,EAA+B,EAAE,CAAC,CAAC;IAC7G,IAAI,EAAE,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,KAAI,OAAO,IAAA,SAAM,GAAE,EAAE;IACzC,SAAS,EAAE,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,SAAS,KAAI,WAAW;IAC7C,SAAS,EAAE,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,SAAS,KAAI,SAAS;IAC3C,QAAQ,EAAE,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,QAAQ,KAAI,IAAA,SAAM,GAAE;IACxC,UAAU,EAAE,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,UAAU,KAAI,SAAS;CAC9C,CAAC,CAAC;AANU,QAAA,gBAAgB,oBAM1B;AAEI,MAAM,iBAAiB,GAAG,CAC/B,QAA2C,EAC3C,MAAM,GAAG,CAAC,EAEqB,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACtE,IAAI,EAAE,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,KAAI,OAAO,IAAA,SAAM,GAAE,EAAE;IACzC,SAAS,EAAE,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,SAAS,KAAI,WAAW;IAC7C,SAAS,EAAE,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,SAAS,KAAI,SAAS;IAC3C,QAAQ,EAAE,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,QAAQ,KAAI,IAAA,SAAM,GAAE;IACxC,UAAU,EAAE,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,UAAU,KAAI,SAAS;CAC9C,CAAC,CAAC,CAAC,CAAC;AAVQ,QAAA,iBAAiB,qBAUzB"}