@autofleet/sadot 0.0.2-beta → 0.1.1

package/dist/src/models/index.d.ts

@@ -1,8 +0,0 @@
-import type { Sequelize } from 'sequelize-typescript';
-import CustomFieldDefinition from './CustomFieldDefinition';
-import CustomFieldValue from './CustomFieldValue';
-import TestModel from './tests/TestModel';
-import AssociatedTestModel from './tests/AssociatedTestModel';
-declare const initTables: (sequelize: Sequelize, getUser: any) => Promise<void>;
-declare const initTestModels: (sequelize: Sequelize) => Promise<void>;
-export { CustomFieldValue, CustomFieldDefinition, TestModel, AssociatedTestModel, initTables, initTestModels, };

package/dist/src/models/index.js

@@ -1,87 +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.initTestModels = exports.initTables = exports.AssociatedTestModel = exports.TestModel = exports.CustomFieldDefinition = exports.CustomFieldValue = void 0;
-/* eslint-disable no-param-reassign */
-const sequelize_1 = require("sequelize");
-const logger_1 = __importDefault(require("../utils/logger"));
-const CustomFieldDefinition_1 = __importDefault(require("./CustomFieldDefinition"));
-exports.CustomFieldDefinition = CustomFieldDefinition_1.default;
-const CustomFieldValue_1 = __importDefault(require("./CustomFieldValue"));
-exports.CustomFieldValue = CustomFieldValue_1.default;
-const TestModel_1 = __importDefault(require("./tests/TestModel"));
-exports.TestModel = TestModel_1.default;
-const AssociatedTestModel_1 = __importDefault(require("./tests/AssociatedTestModel"));
-exports.AssociatedTestModel = AssociatedTestModel_1.default;
-const productionModels = [CustomFieldDefinition_1.default, CustomFieldValue_1.default];
-const testModels = [TestModel_1.default, AssociatedTestModel_1.default];
-const SADOT_MIGRATION_PREFIX = 'sadot-migration';
-const SCHEMA_VERSION = 1;
-const CUSTOM_FIELDS_SCHEMA_VERSION = `${SADOT_MIGRATION_PREFIX}_${SCHEMA_VERSION}`;
-const initTables = async (sequelize, getUser) => {
-    logger_1.default.info('custom-fields: initialize custom-fields tables');
-    // Detect models and import them to the orm
-    // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-    if (!sequelize.addModels) {
-        throw new Error('sequelize instance must have addModels function');
-    }
-    sequelize.addModels(productionModels);
-    CustomFieldDefinition_1.default.addScope('userScope', () => {
-        const user = getUser();
-        if (user?.permissions) {
-            return {
-                where: {
-                    entityId: [
-                        ...Object.keys(user.permissions.fleets),
-                        ...Object.keys(user.permissions.businessModels),
-                        ...Object.keys(user.permissions.demandSources),
-                    ],
-                },
-            };
-        }
-        return {};
-    });
-    logger_1.default.info('custom-fields: models added');
-    const SequelizeMeta = sequelize.define('SequelizeMeta', {
-        name: {
-            type: sequelize_1.DataTypes.STRING,
-            allowNull: false,
-            unique: true,
-            primaryKey: true,
-            autoIncrement: false,
-        },
-    }, {
-        tableName: 'SequelizeMeta',
-        timestamps: false,
-        schema: 'public',
-    });
-    const migrations = await SequelizeMeta.findAll({ raw: true });
-    const currentSadotSchemaVersion = migrations
-        .reverse().find((m) => m.name.includes(SADOT_MIGRATION_PREFIX));
-    if (!currentSadotSchemaVersion
-        || currentSadotSchemaVersion.name !== CUSTOM_FIELDS_SCHEMA_VERSION) {
-        await CustomFieldDefinition_1.default.sync({ alter: true });
-        await CustomFieldValue_1.default.sync({ alter: true });
-        await SequelizeMeta.create({ name: CUSTOM_FIELDS_SCHEMA_VERSION });
-        logger_1.default.info('custom-fields: models synced');
-    }
-};
-exports.initTables = initTables;
-const initTestModels = async (sequelize) => {
-    logger_1.default.info('custom-fields: initialize custom-fields test models');
-    // Detect models and import them to the orm
-    // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-    if (!sequelize.addModels) {
-        throw new Error('sequelize instance must have addModels function');
-    }
-    sequelize.addModels(testModels);
-    await sequelize.dropSchema('custom-fields', { logging: false });
-    await sequelize.createSchema('custom-fields', { logging: false });
-    logger_1.default.info('custom-fields: test models added');
-    await TestModel_1.default.sync({ alter: true });
-    await AssociatedTestModel_1.default.sync({ alter: true });
-    logger_1.default.info('custom-fields: test models synced');
-};
-exports.initTestModels = initTestModels;

package/dist/src/models/tests/AssociatedTestModel.d.ts

@@ -1,12 +0,0 @@
-import { Model } from 'sequelize-typescript';
-import TestModel from './TestModel';
-declare class AssociatedTestModel extends Model {
-    id: string;
-    testModelId: string;
-    fleetId: string;
-    businessModelId: string;
-    demandSourceId: string;
-    anotherAttribute?: boolean;
-    testModel: TestModel;
-}
-export default AssociatedTestModel;

package/dist/src/models/tests/TestModel.d.ts

@@ -1,11 +0,0 @@
-import { Model } from 'sequelize-typescript';
-import AssociatedTestModel from './AssociatedTestModel';
-declare class TestModel extends Model {
-    id: string;
-    fleetId: string;
-    businessModelId: string;
-    demandSourceId: string;
-    coolAttribute?: boolean;
-    associatedModels: AssociatedTestModel[];
-}
-export default TestModel;

package/dist/src/repository/definition.d.ts

@@ -1,17 +0,0 @@
-import { CustomFieldDefinition } from '../models';
-import type { CreateCustomFieldDefinition, UpdateCustomFieldDefinition } from '../types/definition';
-export declare const create: (data: CreateCustomFieldDefinition) => Promise<CustomFieldDefinition>;
-export declare const findAll: (where: any, options?: any) => Promise<CustomFieldDefinition[]>;
-export declare const findByIds: (ids: string[], options?: any) => Promise<CustomFieldDefinition[]>;
-export declare const findById: (id: string, options?: any) => Promise<CustomFieldDefinition | null>;
-export declare const findByEntityId: (entityId: string, options?: any) => Promise<CustomFieldDefinition[]>;
-export declare const findByEntityIds: (modelType: string, entityIds: string[], options?: any) => Promise<CustomFieldDefinition[]>;
-export declare const findByWhere: (where: any) => Promise<CustomFieldDefinition | null>;
-export declare const findDefinitionsByModels: (modelTypes: string[], options?: any) => Promise<CustomFieldDefinition[]>;
-export declare const update: (id: string, data: UpdateCustomFieldDefinition) => Promise<CustomFieldDefinition>;
-export declare const disable: (id: string) => Promise<any>;
-export declare const destroy: (id: string) => Promise<any>;
-/**
- * Return the names of the required fields for a given model
- */
-export declare const getRequiredFields: (modelType: string, modelId: string | string[], entityId: string | string[]) => Promise<string[]>;

package/dist/src/repository/definition.js

@@ -1,80 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRequiredFields = exports.destroy = exports.disable = exports.update = exports.findDefinitionsByModels = exports.findByWhere = exports.findByEntityIds = exports.findByEntityId = exports.findById = exports.findByIds = exports.findAll = exports.create = void 0;
-const sequelize_1 = require("sequelize");
-const models_1 = require("../models");
-const create = (data) => models_1.CustomFieldDefinition.create(data);
-exports.create = create;
-const findAll = (where, options = { withDisabled: false }) => {
-    const queryModel = options.withDisabled
-        ? models_1.CustomFieldDefinition.unscoped()
-        : models_1.CustomFieldDefinition;
-    return queryModel.scope('userScope').findAll({
-        where,
-        transaction: options.transaction,
-        raw: true,
-    });
-};
-exports.findAll = findAll;
-const findByIds = (ids, options = { withDisabled: false }) => (0, exports.findAll)({ id: { [sequelize_1.Op.in]: ids } }, options);
-exports.findByIds = findByIds;
-const findById = (id, options = { withDisabled: false }) => {
-    const { withDisabled } = options;
-    if (withDisabled) {
-        return models_1.CustomFieldDefinition.unscoped().scope('userScope').findByPk(id);
-    }
-    return models_1.CustomFieldDefinition.scope('userScope').findByPk(id);
-};
-exports.findById = findById;
-const findByEntityId = async (entityId, options = {}) => models_1.CustomFieldDefinition.findAll({
-    where: { entityId },
-    transaction: options.transaction,
-});
-exports.findByEntityId = findByEntityId;
-const findByEntityIds = async (modelType, entityIds, options = {}) => models_1.CustomFieldDefinition.findAll({
-    where: {
-        modelType,
-        entityId: entityIds,
-    },
-    transaction: options.transaction,
-    raw: true,
-});
-exports.findByEntityIds = findByEntityIds;
-const findByWhere = (where) => models_1.CustomFieldDefinition.scope('userScope').findOne({
-    where,
-});
-exports.findByWhere = findByWhere;
-const findDefinitionsByModels = async (modelTypes, options) => {
-    const query = { modelType: { [sequelize_1.Op.in]: modelTypes } };
-    return models_1.CustomFieldDefinition.findAll({
-        where: query,
-        transaction: options?.transaction,
-    });
-};
-exports.findDefinitionsByModels = findDefinitionsByModels;
-const update = async (id, data) => {
-    const updatedDefinition = (await models_1.CustomFieldDefinition.scope('userScope').update(data, {
-        where: { id },
-        returning: true,
-        individualHooks: true,
-    }))[1][0];
-    return updatedDefinition;
-};
-exports.update = update;
-const disable = (id) => models_1.CustomFieldDefinition.update({ disabled: true }, { where: { id } });
-exports.disable = disable;
-const destroy = (id) => models_1.CustomFieldDefinition.destroy({ where: { id } });
-exports.destroy = destroy;
-/**
- * Return the names of the required fields for a given model
- */
-const getRequiredFields = async (modelType, modelId, entityId) => {
-    const entityIds = Array.isArray(entityId) ? entityId : [entityId];
-    const requiredFields = await models_1.CustomFieldDefinition.findAll({
-        where: { required: true, modelType, entityId: { [sequelize_1.Op.in]: entityIds } },
-        logging: true,
-    });
-    const requiredFieldsNames = requiredFields.map((definition) => definition.name);
-    return [...new Set(requiredFieldsNames)];
-};
-exports.getRequiredFields = getRequiredFields;

package/dist/src/repository/value.d.ts

@@ -1,24 +0,0 @@
-import { CustomFieldValue } from '../models';
-import { CreateCustomFieldValue, ValuesToUpdate } from '../types/value';
-export declare const findByModelIdAndDefinition: (modelId: string, customFieldDefinitionId: string) => Promise<CustomFieldValue[]>;
-export declare const create: (data: CreateCustomFieldValue, withAssociations?: boolean) => Promise<CustomFieldValue>;
-export declare const findAllValues: () => Promise<CustomFieldValue[]>;
-/**
- * Get all values for model instance id (with their definitions)
- * @param modelId
- * @returns CustomFieldValue[]
- */
-export declare const findValuesByModelId: (modelId: string) => Promise<CustomFieldValue[]>;
-/**
-* Retrieves custom field values for given model IDs
-* @param modelIds - An array of model IDs to query custom field values for.
-* @param options - Optional configuration object.
-*/
-export declare const findValuesByModelIds: (modelIds: string[], options?: any) => Promise<CustomFieldValue[]>;
-/**
- * Try to update custom field values for a model instance.
- * Create new value record if not exists, but fails if value's definition not exist.
- * Return the updated values
- */
-export declare const updateValues: (modelType: string, modelId: string, identifiers: string[], valuesToUpdate: ValuesToUpdate, options?: any) => Promise<CustomFieldValue[]>;
-export declare const deleteValue: (id: string, options?: any) => Promise<any>;

package/dist/src/tests/api/test-api.d.ts

@@ -1,2 +0,0 @@
-declare const app: import("express-serve-static-core").Express;
-export default app;

package/dist/src/tests/helpers/database-config.d.ts

@@ -1,15 +0,0 @@
-declare const _default: {
-    test: {
-        username: string;
-        password: string;
-        database: string;
-        host: string;
-        dialect: string;
-        define: {
-            underscored: boolean;
-            underscoredAll: boolean;
-        };
-        logging: boolean;
-    };
-};
-export default _default;

package/dist/src/tests/helpers/index.d.ts

@@ -1,2 +0,0 @@
-export declare const cleanup: () => Promise<void>;
-export declare const getModel: (name: string) => any;

package/dist/src/tests/helpers/index.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getModel = exports.cleanup = void 0;
-const models_1 = require("../../models");
-// eslint-disable-next-line import/prefer-default-export
-const cleanup = async () => {
-    if (process.env.NODE_ENV === 'test' || process.env.NODE_ENV === 'development') {
-        await models_1.CustomFieldDefinition.unscoped().destroy({ where: {} });
-        await models_1.TestModel.destroy({ where: {} });
-    }
-};
-exports.cleanup = cleanup;
-const getModel = (name) => {
-    // eslint-disable-next-line global-require, @typescript-eslint/no-var-requires
-    const models = require('../../models');
-    return models[name];
-};
-exports.getModel = getModel;

package/dist/src/tests/mocks/definition.mock.d.ts

@@ -1,37 +0,0 @@
-import { CreateCustomFieldDefinition, CustomFieldDefinitionDTO } from '../../types/definition';
-export declare const coolFieldDefinition: CreateCustomFieldDefinition;
-export declare const coolFieldDefinition2: {
-    name: string;
-    required?: boolean;
-    disabled?: boolean;
-    description?: string;
-    createdAt?: Date;
-    updatedAt?: Date;
-    deletedAt?: Date;
-    displayName?: string;
-    validation?: any;
-    fieldType: string;
-    entityId: string;
-    entityType: string;
-    modelType: string;
-};
-export declare const coolFieldDefinition3: {
-    name: string;
-    required?: boolean;
-    disabled?: boolean;
-    description?: string;
-    createdAt?: Date;
-    updatedAt?: Date;
-    deletedAt?: Date;
-    displayName?: string;
-    validation?: any;
-    fieldType: string;
-    entityId: string;
-    entityType: string;
-    modelType: string;
-};
-export declare const booleanField: (modelType: string) => CreateCustomFieldDefinition;
-export declare const enumField: (modelType: string, options: any) => CreateCustomFieldDefinition;
-export declare const rangeField: (modelType: string) => CreateCustomFieldDefinition;
-export declare const createDefinition: (defaults: Partial<CustomFieldDefinitionDTO>) => CreateCustomFieldDefinition;
-export declare const createDefinitions: (defaults: Partial<CustomFieldDefinitionDTO>, length?: number) => CreateCustomFieldDefinition[];

package/dist/src/tests/mocks/events.mock.d.ts

@@ -1,3 +0,0 @@
-export declare const mockEvent: (events: any, eventName: any, numberOfEvents: any) => any[];
-export declare const mockDimCustomFieldDefinitionEvent: (events: any, numberOfEvents: any) => any[];
-export declare const mockDimCustomFieldValueEvent: (events: any, numberOfEvents: any) => any[];

package/dist/src/tests/mocks/testModel.d.ts

@@ -1,12 +0,0 @@
-import { TestModel } from '../../models';
-export declare const createTestModel: (payload?: {}) => Promise<TestModel>;
-export declare const createTestModels: (fleetId: any, total: number) => Promise<TestModel[]>;
-export declare const upsertTestModel: (payload: any) => Promise<[TestModel, boolean]>;
-export declare const destroyTestModels: () => Promise<number>;
-export declare const getTestModel: (id: string, options?: {}) => Promise<TestModel>;
-export declare const getSomeTestModels: (options?: {
-    limit: number;
-}) => Promise<TestModel[]>;
-export declare const updateTestModel: (payload: any, query: any) => Promise<[affectedCount: number, affectedRows: TestModel[]]>;
-export declare const createTestModelWithAssociation: () => Promise<TestModel>;
-export declare const getTestModelWithAssociation: (limit?: number) => Promise<TestModel[]>;

package/dist/src/types/definition/index.d.ts

@@ -1,23 +0,0 @@
-export interface CustomFieldDefinitionDTO {
-    id: string;
-    name: string;
-    displayName?: string;
-    validation?: any;
-    fieldType: string;
-    entityId: string;
-    entityType: string;
-    modelType: string;
-    required?: boolean;
-    description?: string;
-    disabled?: boolean;
-    createdAt?: Date;
-    updatedAt?: Date;
-    deletedAt?: Date;
-}
-export type CreateCustomFieldDefinition = Omit<CustomFieldDefinitionDTO, 'id'>;
-export type UpdateCustomFieldDefinition = Partial<CreateCustomFieldDefinition>;
-export type SerializedCustomFields = {
-    [name: string]: CustomFieldDefinitionDTO & {
-        value: any;
-    };
-};

package/dist/src/types/index.d.ts

@@ -1,13 +0,0 @@
-export type ModelFetcher = (name: string) => any;
-export type ModelOptions = {
-    name: string;
-    scopeAttributes: string[];
-    creationWebhookHandler?: (instance: any) => any;
-    updateWebhookHandler?: (instance: any) => any;
-    deletionWebhookHandler?: (instance: any) => any;
-};
-export type CustomFieldOptions = {
-    models: ModelOptions[];
-    databaseConfig: any;
-    getUser: () => any;
-};

package/dist/src/types/value/index.d.ts

@@ -1,15 +0,0 @@
-export interface CustomFieldValueDTO {
-    id?: string;
-    modelId: string;
-    customFieldDefinitionId: string;
-    value: any;
-    createdAt?: Date;
-    updatedAt?: Date;
-    deletedAt?: Date;
-}
-export type ValuesToUpdate = {
-    [name: string]: any;
-};
-export type CreateCustomFieldValue = Omit<CustomFieldValueDTO, 'id'>;
-export type UpdateCustomFieldValue = ValuesToUpdate;
-export type BulkUpdateCustomFieldValue = Partial<CustomFieldValueDTO>[];

package/dist/src/utils/constants/index.d.ts

@@ -1 +0,0 @@
-export declare const supportedEntities: string[];

package/dist/src/utils/constants/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.supportedEntities = void 0;
-// eslint-disable-next-line import/prefer-default-export
-exports.supportedEntities = ['businessModelId', 'fleetId', 'demandSourceId'];

package/dist/src/utils/db/index.d.ts

@@ -1,4 +0,0 @@
-import { Sequelize } from 'sequelize-typescript';
-declare const _default: (databaseConfig: any) => Sequelize;
-export default _default;
-export declare const createSequelizeMeta: (sequelize: Sequelize) => Promise<object[]>;

package/dist/src/utils/logger/index.d.ts

@@ -1,2 +0,0 @@
-declare const logger: any;
-export default logger;

package/dist/src/utils/validations/custom-fields.d.ts

@@ -1,2 +0,0 @@
-declare const CustomFieldsSchema: any;
-export { CustomFieldsSchema };

package/dist/src/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/src/utils/validations/index.d.ts

@@ -1,2 +0,0 @@
-declare const validateValue: (value: any, valueType: any, customValidations: any) => boolean;
-export default validateValue;

package/dist/src/utils/validations/type.d.ts

@@ -1,18 +0,0 @@
-/**
- * Supported custom field types
- */
-export declare 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
- */
-declare const validateValueType: (value: unknown, valueType: CustomFieldDefinitionType) => boolean;
-export default validateValueType;

package/dist/src/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/src/utils/constants/index.ts

@@ -1,2 +0,0 @@
-// eslint-disable-next-line import/prefer-default-export
-export const supportedEntities = ['businessModelId', 'fleetId', 'demandSourceId'];