@autofleet/sadot 1.0.9 → 1.0.11

package/dist/index.d.cts

@@ -1,260 +1,13 @@
+import { CUSTOM_FIELDS_FILTER_SCOPE, CustomFieldDefinitionType, supportedEntities } from "./utils/constants/index.cjs";
+import { CustomFieldOptions, ModelFetcher, Models } from "./types/index.cjs";
+import { CustomFieldsSchema } from "./utils/validations/schema/custom-fields.cjs";
+import { generateCustomFieldSearchQueryPayload, generateRandomString } from "./utils/helpers/index.cjs";
+import { customFieldsSortScope } from "./scopes/filter.cjs";
 import { Application } from "express";
-import { Model, ModelCtor, ModelStatic, Sequelize } from "sequelize-typescript";
-import { BindOrReplacements, CreateOptions, IncludeOptions, WhereOptions } from "sequelize";
-import { getUser } from "@autofleet/zehut";
-import { customFields } from "@autofleet/common-types";
-import Joi from "joi";
-import { Literal } from "sequelize/types/utils";
+import { Sequelize } from "sequelize-typescript";
 
-//#region src/utils/constants/index.d.ts
-declare const supportedEntities: readonly ["businessModelId", "fleetId", "demandSourceId"];
-/**
-* Supported custom field types
-*/
-declare enum CustomFieldDefinitionType {
-  NUMBER = "number",
-  BOOLEAN = "boolean",
-  DATE = "date",
-  DATETIME = "datetime",
-  TEXT = "text",
-  IMAGE = "image",
-  SELECT = "select",
-  STATUS = "status",
-  FILE = "file",
-}
-declare const CUSTOM_FIELDS_FILTER_SCOPE: typeof customFields.CUSTOM_FIELDS_FILTER_SCOPE;
-//#endregion
-//#region src/models/CustomFieldValue.d.ts
-declare class CustomFieldValue extends Model {
-  modelId: string;
-  customFieldDefinitionId: string;
-  value: any;
-  createdAt?: Date;
-  updatedAt?: Date;
-  deletedAt?: Date;
-  customFieldDefinition: CustomFieldDefinition;
-  private static validateValueAgainstDefinition;
-  static validateCustomFieldValues(instances: CustomFieldValue[]): Promise<void>;
-  static validateCustomFieldValue(instance: CustomFieldValue): Promise<void>;
-  static afterSaveHandler(instance: CustomFieldValue, options: CreateOptions): void;
-}
-//#endregion
-//#region src/models/tests/AssociatedTestModel.d.ts
-declare class AssociatedTestModel extends Model {
-  id: string;
-  testModelId: string;
-  fleetId: string;
-  businessModelId: string;
-  demandSourceId: string;
-  anotherAttribute?: boolean;
-  testModel: TestModel;
-}
-//#endregion
-//#region src/models/tests/TestModel.d.ts
-declare class TestModel extends Model {
-  id: string;
-  fleetId: string;
-  businessModelId: string;
-  demandSourceId: string;
-  coolAttribute?: boolean;
-  associatedModels: AssociatedTestModel[];
-  customFields?: any;
-}
-//#endregion
-//#region src/models/tests/contextAwareModels/ContextTestModel.d.ts
-declare enum EEntityTypes {
-  BUSINESS_MODEL = "businessModel",
-  CONTEXT = "context",
-  DEMAND_SOURCE = "demandSource",
-  FLEET = "fleet",
-}
-declare class ContextTestModel extends Model {
-  id: string;
-  entityId: string;
-  entityType: EEntityTypes;
-}
-//#endregion
-//#region src/models/tests/contextAwareModels/ContextAwareTestModel.d.ts
-declare class ContextAwareTestModel extends Model {
-  id: string;
-  contextId: string;
-  coolAttribute?: boolean;
-  customFields?: any;
-  context: ContextTestModel;
-}
-//#endregion
-//#region src/models/CustomFieldEntries.d.ts
-declare class CustomFieldEntries extends Model {
-  modelId: string;
-  entityId: string;
-  customFields: Record<string, any>;
-  modelType: string;
-  createdAt?: Date;
-  updatedAt?: Date;
-  static afterSaveHandler(instance: CustomFieldEntries, options: CreateOptions): void;
-}
-//#endregion
-//#region src/api/v1/validator/validations.d.ts
-interface SchemaObject {
-  type: "object";
-  properties?: {
-    before?: object;
-    after?: object;
-  };
-  required?: string[];
-  allOf?: object[];
-  anyOf?: object[];
-  oneOf?: object[];
-  additionalProperties?: boolean | object;
-  $id?: string;
-  $schema?: string;
-  if?: object;
-  then?: object;
-  else?: object;
-}
-//#endregion
-//#region src/models/CustomValidator.d.ts
-declare class CustomValidator extends Model {
-  id: string;
-  entityId: string;
-  entityType: string;
-  modelType: string;
-  schema: SchemaObject;
-  disabled: boolean;
-  createdAt?: Date;
-  updatedAt?: Date;
-  static afterSaveHandler(instance: CustomValidator, options: CreateOptions): void;
-}
-//#endregion
-//#region src/models/index.d.ts
-interface InitTablesOptions {
-  schemaPrefix?: string;
-  schemaVersion?: string;
-  useCustomFieldsEntries?: boolean;
-}
-declare const initTables: (sequelize: Sequelize, getUser: CustomFieldOptions["getUser"], {
-  schemaPrefix,
-  schemaVersion,
-  useCustomFieldsEntries
-}?: InitTablesOptions) => Promise<void>;
-declare const initTestModels: (sequelize: Sequelize) => Promise<void>;
-//#endregion
-//#region src/models/CustomFieldDefinition.d.ts
-declare class CustomFieldDefinition extends Model {
-  id: string;
-  name: string;
-  displayName?: string;
-  fieldType: CustomFieldDefinitionType;
-  validation?: any;
-  entityId: string;
-  entityType: string;
-  modelType: string;
-  description?: string;
-  required?: boolean;
-  disabled?: boolean;
-  defaultValue?: any;
-  createdAt?: Date;
-  updatedAt?: Date;
-  deletedAt?: Date;
-  blockEditingFromUI: boolean;
-  values: CustomFieldValue[];
-  static displayNameDefaultValue(instance: CustomFieldDefinition): void;
-  static afterSaveHandler(instance: CustomFieldDefinition, options: CreateOptions): void;
-}
-//#endregion
-//#region src/types/index.d.ts
-type ModelFetcher = (name: string) => any;
-type ModelOptions = {
-  /**
-  * Include options for the model
-  */
-  include?: (entityIds: string | string[]) => IncludeOptions[];
-  /**
-  * Custom association for the model
-  * @param model - The model to associate with
-  */
-  customAssociation?: (model: ModelCtor) => void;
-  /**
-  * Whether to use the entity id  from the instance per scope attribute
-  */
-  useEntityIdFromInclude?: boolean;
-  /**
-  * Which attributes to include in the model
-  */
-  attributes?: string[];
-};
-type Models = {
-  name: string;
-  scopeAttributes: any[];
-  modelOptions?: ModelOptions;
-  creationWebhookHandler?: (instance: any) => any;
-  updateWebhookHandler?: (instance: any) => any;
-  deletionWebhookHandler?: (instance: any) => any;
-};
-type CustomFieldOptions = {
-  models: Models[];
-  databaseConfig: any;
-  getUser: typeof getUser;
-  sequelize?: Sequelize;
-  useCustomFieldsEntries?: boolean;
-  useValidators?: boolean;
-};
-//#endregion
-//#region src/utils/validations/schema/custom-fields.d.ts
-declare const CustomFieldsSchema: Joi.ObjectSchema<Record<string, any>>;
-//#endregion
-//#region src/utils/helpers/index.d.ts
-/**
-* Builds a WHERE clause and replacements for free-text search by custom fields.
-*
-* This function constructs a WHERE clause and replacement bindings that allow searching
-* for a given term within custom fields associated with a specific model type and entity ID.
-* The WHERE clause and replacements are designed to be added to the main query.
-*
-* @param {string} searchTerm - The term to search for within custom fields.
-* @param {ModelStatic} model - The Sequelize model representing the entity type to search for.
-* @param {string} entityId - The entity ID to filter the custom fields by.
-* @param {CustomFieldDefinitionType[]} excludedCustomFieldsTypes - An array of custom field types
-* to exclude from the search
-*
-* @returns {CustomFieldsSearchPayload} - An object containing the WHERE clause and replacements
-* for Sequelize.
-*/
-interface CustomFieldsSearchPayload {
-  where: WhereOptions;
-  replacements: BindOrReplacements;
-}
-declare const generateRandomString: (length?: number) => string;
-declare const generateCustomFieldSearchQueryPayload: (searchTerm: string, model: ModelStatic, entityId: string, customFieldsTypesToExclude?: CustomFieldDefinitionType[]) => CustomFieldsSearchPayload;
-//#endregion
-//#region src/scopes/helpers/filter.helpers.d.ts
-/**
-* Type representing possible condition values.
-* Currently supporting strings and arrays of strings.
-* More types to be added (TBA).
-*/
-type ConditionWithOperator = {
-  operator: string;
-  value: string;
-};
-type ConditionValue = ConditionWithOperator | ConditionWithOperator[] | string | string[];
-//#endregion
-//#region src/scopes/filter.d.ts
-declare const customFieldsSortScope: (name: string, options?: Pick<CustomFieldOptions, "useCustomFieldsEntries">) => ({
-  replacementsMap,
-  scopeValue: sort
-}: {
-  replacementsMap: Record<string, string>;
-  scopeValue: Record<string, ConditionValue>;
-}) => {
-  attributes: {
-    include: (string | Literal)[][];
-  };
-  order: Literal[];
-  replacements: Record<string, string>;
-} | Record<string, never>;
-//#endregion
 //#region src/index.d.ts
+
 /**
 * Adding custom fields enrichment to the models inside the MODELS_FILE_NAME json file
 * @see {@link 'custom-fields/config'} for configurations
@@ -262,5 +15,5 @@ declare const customFieldsSortScope: (name: string, options?: Pick<CustomFieldOp
 declare const useCustomFields: (app: Pick<Application, "use"> | null, getModel: ModelFetcher, options: CustomFieldOptions) => Promise<Sequelize>;
 declare const disableCustomFields: (models: Models[], getModel: ModelFetcher) => void;
 //#endregion
-export { AssociatedTestModel, CUSTOM_FIELDS_FILTER_SCOPE, ContextAwareTestModel, ContextTestModel, CustomFieldDefinition, CustomFieldDefinitionType, CustomFieldEntries, CustomFieldValue, CustomFieldsSchema, CustomValidator, TestModel, customFieldsSortScope, useCustomFields as default, disableCustomFields, generateCustomFieldSearchQueryPayload, generateRandomString, initTables, initTestModels, supportedEntities };
+export { CUSTOM_FIELDS_FILTER_SCOPE, CustomFieldDefinitionType, CustomFieldsSchema, customFieldsSortScope, useCustomFields as default, disableCustomFields, generateCustomFieldSearchQueryPayload, generateRandomString, supportedEntities };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -1,260 +1,13 @@
-import { BindOrReplacements, CreateOptions, IncludeOptions, WhereOptions } from "sequelize";
-import { Model, ModelCtor, ModelStatic, Sequelize } from "sequelize-typescript";
-import { customFields } from "@autofleet/common-types";
-import Joi from "joi";
-import { getUser } from "@autofleet/zehut";
+import { CUSTOM_FIELDS_FILTER_SCOPE, CustomFieldDefinitionType, supportedEntities } from "./utils/constants/index.js";
+import { CustomFieldOptions, ModelFetcher, Models } from "./types/index.js";
+import { CustomFieldsSchema } from "./utils/validations/schema/custom-fields.js";
+import { generateCustomFieldSearchQueryPayload, generateRandomString } from "./utils/helpers/index.js";
+import { customFieldsSortScope } from "./scopes/filter.js";
+import { Sequelize } from "sequelize-typescript";
 import { Application } from "express";
-import { Literal } from "sequelize/types/utils";
 
-//#region src/utils/constants/index.d.ts
-declare const supportedEntities: readonly ["businessModelId", "fleetId", "demandSourceId"];
-/**
-* Supported custom field types
-*/
-declare enum CustomFieldDefinitionType {
-  NUMBER = "number",
-  BOOLEAN = "boolean",
-  DATE = "date",
-  DATETIME = "datetime",
-  TEXT = "text",
-  IMAGE = "image",
-  SELECT = "select",
-  STATUS = "status",
-  FILE = "file",
-}
-declare const CUSTOM_FIELDS_FILTER_SCOPE: typeof customFields.CUSTOM_FIELDS_FILTER_SCOPE;
-//#endregion
-//#region src/models/CustomFieldValue.d.ts
-declare class CustomFieldValue extends Model {
-  modelId: string;
-  customFieldDefinitionId: string;
-  value: any;
-  createdAt?: Date;
-  updatedAt?: Date;
-  deletedAt?: Date;
-  customFieldDefinition: CustomFieldDefinition;
-  private static validateValueAgainstDefinition;
-  static validateCustomFieldValues(instances: CustomFieldValue[]): Promise<void>;
-  static validateCustomFieldValue(instance: CustomFieldValue): Promise<void>;
-  static afterSaveHandler(instance: CustomFieldValue, options: CreateOptions): void;
-}
-//#endregion
-//#region src/models/tests/AssociatedTestModel.d.ts
-declare class AssociatedTestModel extends Model {
-  id: string;
-  testModelId: string;
-  fleetId: string;
-  businessModelId: string;
-  demandSourceId: string;
-  anotherAttribute?: boolean;
-  testModel: TestModel;
-}
-//#endregion
-//#region src/models/tests/TestModel.d.ts
-declare class TestModel extends Model {
-  id: string;
-  fleetId: string;
-  businessModelId: string;
-  demandSourceId: string;
-  coolAttribute?: boolean;
-  associatedModels: AssociatedTestModel[];
-  customFields?: any;
-}
-//#endregion
-//#region src/models/tests/contextAwareModels/ContextTestModel.d.ts
-declare enum EEntityTypes {
-  BUSINESS_MODEL = "businessModel",
-  CONTEXT = "context",
-  DEMAND_SOURCE = "demandSource",
-  FLEET = "fleet",
-}
-declare class ContextTestModel extends Model {
-  id: string;
-  entityId: string;
-  entityType: EEntityTypes;
-}
-//#endregion
-//#region src/models/tests/contextAwareModels/ContextAwareTestModel.d.ts
-declare class ContextAwareTestModel extends Model {
-  id: string;
-  contextId: string;
-  coolAttribute?: boolean;
-  customFields?: any;
-  context: ContextTestModel;
-}
-//#endregion
-//#region src/models/CustomFieldEntries.d.ts
-declare class CustomFieldEntries extends Model {
-  modelId: string;
-  entityId: string;
-  customFields: Record<string, any>;
-  modelType: string;
-  createdAt?: Date;
-  updatedAt?: Date;
-  static afterSaveHandler(instance: CustomFieldEntries, options: CreateOptions): void;
-}
-//#endregion
-//#region src/api/v1/validator/validations.d.ts
-interface SchemaObject {
-  type: "object";
-  properties?: {
-    before?: object;
-    after?: object;
-  };
-  required?: string[];
-  allOf?: object[];
-  anyOf?: object[];
-  oneOf?: object[];
-  additionalProperties?: boolean | object;
-  $id?: string;
-  $schema?: string;
-  if?: object;
-  then?: object;
-  else?: object;
-}
-//#endregion
-//#region src/models/CustomValidator.d.ts
-declare class CustomValidator extends Model {
-  id: string;
-  entityId: string;
-  entityType: string;
-  modelType: string;
-  schema: SchemaObject;
-  disabled: boolean;
-  createdAt?: Date;
-  updatedAt?: Date;
-  static afterSaveHandler(instance: CustomValidator, options: CreateOptions): void;
-}
-//#endregion
-//#region src/models/index.d.ts
-interface InitTablesOptions {
-  schemaPrefix?: string;
-  schemaVersion?: string;
-  useCustomFieldsEntries?: boolean;
-}
-declare const initTables: (sequelize: Sequelize, getUser: CustomFieldOptions["getUser"], {
-  schemaPrefix,
-  schemaVersion,
-  useCustomFieldsEntries
-}?: InitTablesOptions) => Promise<void>;
-declare const initTestModels: (sequelize: Sequelize) => Promise<void>;
-//#endregion
-//#region src/models/CustomFieldDefinition.d.ts
-declare class CustomFieldDefinition extends Model {
-  id: string;
-  name: string;
-  displayName?: string;
-  fieldType: CustomFieldDefinitionType;
-  validation?: any;
-  entityId: string;
-  entityType: string;
-  modelType: string;
-  description?: string;
-  required?: boolean;
-  disabled?: boolean;
-  defaultValue?: any;
-  createdAt?: Date;
-  updatedAt?: Date;
-  deletedAt?: Date;
-  blockEditingFromUI: boolean;
-  values: CustomFieldValue[];
-  static displayNameDefaultValue(instance: CustomFieldDefinition): void;
-  static afterSaveHandler(instance: CustomFieldDefinition, options: CreateOptions): void;
-}
-//#endregion
-//#region src/types/index.d.ts
-type ModelFetcher = (name: string) => any;
-type ModelOptions = {
-  /**
-  * Include options for the model
-  */
-  include?: (entityIds: string | string[]) => IncludeOptions[];
-  /**
-  * Custom association for the model
-  * @param model - The model to associate with
-  */
-  customAssociation?: (model: ModelCtor) => void;
-  /**
-  * Whether to use the entity id  from the instance per scope attribute
-  */
-  useEntityIdFromInclude?: boolean;
-  /**
-  * Which attributes to include in the model
-  */
-  attributes?: string[];
-};
-type Models = {
-  name: string;
-  scopeAttributes: any[];
-  modelOptions?: ModelOptions;
-  creationWebhookHandler?: (instance: any) => any;
-  updateWebhookHandler?: (instance: any) => any;
-  deletionWebhookHandler?: (instance: any) => any;
-};
-type CustomFieldOptions = {
-  models: Models[];
-  databaseConfig: any;
-  getUser: typeof getUser;
-  sequelize?: Sequelize;
-  useCustomFieldsEntries?: boolean;
-  useValidators?: boolean;
-};
-//#endregion
-//#region src/utils/validations/schema/custom-fields.d.ts
-declare const CustomFieldsSchema: Joi.ObjectSchema<Record<string, any>>;
-//#endregion
-//#region src/utils/helpers/index.d.ts
-/**
-* Builds a WHERE clause and replacements for free-text search by custom fields.
-*
-* This function constructs a WHERE clause and replacement bindings that allow searching
-* for a given term within custom fields associated with a specific model type and entity ID.
-* The WHERE clause and replacements are designed to be added to the main query.
-*
-* @param {string} searchTerm - The term to search for within custom fields.
-* @param {ModelStatic} model - The Sequelize model representing the entity type to search for.
-* @param {string} entityId - The entity ID to filter the custom fields by.
-* @param {CustomFieldDefinitionType[]} excludedCustomFieldsTypes - An array of custom field types
-* to exclude from the search
-*
-* @returns {CustomFieldsSearchPayload} - An object containing the WHERE clause and replacements
-* for Sequelize.
-*/
-interface CustomFieldsSearchPayload {
-  where: WhereOptions;
-  replacements: BindOrReplacements;
-}
-declare const generateRandomString: (length?: number) => string;
-declare const generateCustomFieldSearchQueryPayload: (searchTerm: string, model: ModelStatic, entityId: string, customFieldsTypesToExclude?: CustomFieldDefinitionType[]) => CustomFieldsSearchPayload;
-//#endregion
-//#region src/scopes/helpers/filter.helpers.d.ts
-/**
-* Type representing possible condition values.
-* Currently supporting strings and arrays of strings.
-* More types to be added (TBA).
-*/
-type ConditionWithOperator = {
-  operator: string;
-  value: string;
-};
-type ConditionValue = ConditionWithOperator | ConditionWithOperator[] | string | string[];
-//#endregion
-//#region src/scopes/filter.d.ts
-declare const customFieldsSortScope: (name: string, options?: Pick<CustomFieldOptions, "useCustomFieldsEntries">) => ({
-  replacementsMap,
-  scopeValue: sort
-}: {
-  replacementsMap: Record<string, string>;
-  scopeValue: Record<string, ConditionValue>;
-}) => {
-  attributes: {
-    include: (string | Literal)[][];
-  };
-  order: Literal[];
-  replacements: Record<string, string>;
-} | Record<string, never>;
-//#endregion
 //#region src/index.d.ts
+
 /**
 * Adding custom fields enrichment to the models inside the MODELS_FILE_NAME json file
 * @see {@link 'custom-fields/config'} for configurations
@@ -262,5 +15,5 @@ declare const customFieldsSortScope: (name: string, options?: Pick<CustomFieldOp
 declare const useCustomFields: (app: Pick<Application, "use"> | null, getModel: ModelFetcher, options: CustomFieldOptions) => Promise<Sequelize>;
 declare const disableCustomFields: (models: Models[], getModel: ModelFetcher) => void;
 //#endregion
-export { AssociatedTestModel, CUSTOM_FIELDS_FILTER_SCOPE, ContextAwareTestModel, ContextTestModel, CustomFieldDefinition, CustomFieldDefinitionType, CustomFieldEntries, CustomFieldValue, CustomFieldsSchema, CustomValidator, TestModel, customFieldsSortScope, useCustomFields as default, disableCustomFields, generateCustomFieldSearchQueryPayload, generateRandomString, initTables, initTestModels, supportedEntities };
+export { CUSTOM_FIELDS_FILTER_SCOPE, CustomFieldDefinitionType, CustomFieldsSchema, customFieldsSortScope, useCustomFields as default, disableCustomFields, generateCustomFieldSearchQueryPayload, generateRandomString, supportedEntities };
 //# sourceMappingURL=index.d.ts.map