@autofleet/sadot 0.0.1-beta → 0.0.1-beta.1

package/tsconfig.json

@@ -1,13 +1,30 @@
 {
   "compilerOptions": {
-    "target": "es2020",
-    "module": "commonjs",
-    "declaration": true,
-    "outDir": "./dist",
-    "esModuleInterop": true,
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "allowJs": true
+      "lib": [
+        "es2019"
+      ],
+      "incremental": true,
+      "module": "commonjs",
+      "esModuleInterop": true,
+      "target": "es6",
+      "moduleResolution": "node",
+      "sourceMap": true,
+      "outDir": "./dist",
+      "baseUrl": ".",
+      "experimentalDecorators": true,
+      "emitDecoratorMetadata": true,
+      "allowJs": true,
+      "paths": {
+          "*": [
+              "node_modules/*"
+          ]
+      }
   },
-  "exclude": ["node_modules", "**/*.test.ts"]
+  "include": [
+    "src/**/*", "test"
+  ],
+  "exclude": [
+    "**/*.test.*",
+    "**/*.mock.*"
+  ]
 }

package/dist/jest.config.d.ts

@@ -1,12 +0,0 @@
-export const testEnvironment: string;
-export const roots: string[];
-export const transform: {
-    '^.+\\.tsx?$': string;
-};
-export const testRegex: string;
-export const moduleFileExtensions: string[];
-export namespace coverageThreshold {
-    namespace global {
-        const lines: number;
-    }
-}

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

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

package/dist/src/api/v1/definition/index.d.ts

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

package/dist/src/api/v1/definition/validations.d.ts

@@ -1,2 +0,0 @@
-export declare const validateCustomFieldDefinitionCreation: (payload: any) => any;
-export declare const validateCustomFieldDefinitionUpdate: (payload: any) => any;

package/dist/src/api/v1/definition/validations.js

@@ -1,36 +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.validateCustomFieldDefinitionUpdate = exports.validateCustomFieldDefinitionCreation = void 0;
-const joi_1 = __importDefault(require("@hapi/joi"));
-const type_1 = require("../../../utils/validations/type");
-const ValidationSchema = joi_1.default.when('fieldType', {
-    is: type_1.CustomFieldDefinitionType.SELECT,
-    then: joi_1.default.array().items(joi_1.default.string()).min(1).unique(),
-    otherwise: joi_1.default.any(),
-});
-const CustomFieldDefinitionCreationSchema = joi_1.default.object({
-    name: joi_1.default.string().required(),
-    displayName: joi_1.default.string().required(),
-    validation: ValidationSchema,
-    fieldType: joi_1.default.string().valid(...Object.values(type_1.CustomFieldDefinitionType)).required(),
-    entityId: joi_1.default.string().guid().required(),
-    entityType: joi_1.default.string().required(),
-    description: joi_1.default.string(),
-    required: joi_1.default.boolean(),
-    disabled: joi_1.default.boolean(),
-});
-const CustomFieldDefinitionUpdateSchema = joi_1.default.object({
-    displayName: joi_1.default.string(),
-    validation: ValidationSchema,
-    fieldType: joi_1.default.string().valid(...Object.values(type_1.CustomFieldDefinitionType)),
-    description: joi_1.default.string(),
-    required: joi_1.default.boolean(),
-    disabled: joi_1.default.boolean(),
-});
-const validateCustomFieldDefinitionCreation = (payload) => CustomFieldDefinitionCreationSchema.validateAsync(payload, { abortEarly: false });
-exports.validateCustomFieldDefinitionCreation = validateCustomFieldDefinitionCreation;
-const validateCustomFieldDefinitionUpdate = (payload) => CustomFieldDefinitionUpdateSchema.validateAsync(payload, { abortEarly: false });
-exports.validateCustomFieldDefinitionUpdate = validateCustomFieldDefinitionUpdate;

package/dist/src/api/v1/errors.d.ts

@@ -1,2 +0,0 @@
-declare const _default: (err: any, res: any, additionalData?: {}) => any;
-export default _default;

package/dist/src/api/v1/index.d.ts

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

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

@@ -1,16 +0,0 @@
-import { BadRequest } from '@autofleet/errors';
-export declare class MissingRequiredCustomFieldError extends BadRequest {
-    constructor(missingFields: string[]);
-}
-export declare class UnsupportedCustomFieldTypeError extends BadRequest {
-    constructor(fieldType: string);
-}
-export declare class UnsupportedCustomValidationError extends BadRequest {
-    constructor(fieldType: string);
-}
-export declare class InvalidValueError extends BadRequest {
-    constructor(value: any, fieldType: string);
-}
-export declare class MissingDefinitionError extends BadRequest {
-    constructor(fieldNames: string[]);
-}

package/dist/src/errors/index.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MissingDefinitionError = exports.InvalidValueError = exports.UnsupportedCustomValidationError = exports.UnsupportedCustomFieldTypeError = exports.MissingRequiredCustomFieldError = void 0;
-/* eslint-disable max-classes-per-file */
-const errors_1 = require("@autofleet/errors");
-class MissingRequiredCustomFieldError extends errors_1.BadRequest {
-    constructor(missingFields) {
-        const err = new Error(`The following custom fields are required: ${missingFields.join(',')}`);
-        super([err], null, missingFields);
-        this.message = 'MISSING_REQUIRED_CUSTOM_FIELDS';
-    }
-}
-exports.MissingRequiredCustomFieldError = MissingRequiredCustomFieldError;
-class UnsupportedCustomFieldTypeError extends errors_1.BadRequest {
-    constructor(fieldType) {
-        const err = new Error(`Type "${fieldType}" is not supported`);
-        super([err], null, null);
-        this.message = 'UNSUPPORTED_CUSTOM_FIELD_TYPE';
-    }
-}
-exports.UnsupportedCustomFieldTypeError = UnsupportedCustomFieldTypeError;
-class UnsupportedCustomValidationError extends errors_1.BadRequest {
-    constructor(fieldType) {
-        const err = new Error(`Validation for "${fieldType}" is not supported`);
-        super([err], null, null);
-        this.message = 'UNSUPPORTED_CUSTOM_VALIDATION_TYPE';
-    }
-}
-exports.UnsupportedCustomValidationError = UnsupportedCustomValidationError;
-class InvalidValueError extends errors_1.BadRequest {
-    constructor(value, fieldType) {
-        const err = new Error(`Invalid "${fieldType}" value ${JSON.stringify(value)}`);
-        super([err], null, null);
-        this.message = 'INVALID_VALUE';
-    }
-}
-exports.InvalidValueError = InvalidValueError;
-class MissingDefinitionError extends errors_1.BadRequest {
-    constructor(fieldNames) {
-        const err = new Error(`Missing custom field definition for field ${fieldNames.join(',')}`);
-        super([err], null, null);
-        this.message = 'MISSING_DEFINITION';
-    }
-}
-exports.MissingDefinitionError = MissingDefinitionError;

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

@@ -1,4 +0,0 @@
-import Events from '@autofleet/events';
-declare const events: Events;
-export declare const sendDimEvent: (instance: any) => void;
-export default events;

package/dist/src/hooks/create.d.ts

@@ -1,9 +0,0 @@
-/**
- * A hook to create the custom fields when updating a model (more then one instance).
- */
-export declare const beforeBulkCreate: (options: any) => void;
-/**
- * A hook to create the custom fields when updating a model instance.
- * TODO - cleanup if update fail
- */
-export declare const beforeCreate: (scopeAttributes: string[]) => (instance: any, options: any) => Promise<void>;

package/dist/src/hooks/enrich.d.ts

@@ -1,5 +0,0 @@
-/**
- * A hook to attach the custom fields when fetching a model instances.
- */
-declare const enrichResults: (modelType: string, scopeAttributes: string[]) => (instancesOrInstance: any | any[], options: any) => Promise<void>;
-export default enrichResults;

package/dist/src/hooks/find.d.ts

@@ -1 +0,0 @@
-export declare const beforeFind: (scopeAttributes: string[]) => (options: any) => void;

package/dist/src/hooks/find.js

@@ -1,29 +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.beforeFind = void 0;
-/* eslint-disable no-param-reassign */
-const logger_1 = __importDefault(require("../utils/logger"));
-const doScopeAttributesMissing = (scopeAttributes, queryAttributes) => {
-    const attributes = scopeAttributes
-        .filter((attribute) => !queryAttributes.includes(attribute));
-    if (!queryAttributes.includes?.('id')) {
-        attributes.push('id');
-    }
-    return attributes;
-};
-// eslint-disable-next-line import/prefer-default-export
-const beforeFind = (scopeAttributes) => (options) => {
-    const { attributes: queryAttributes } = options;
-    if (queryAttributes?.includes('customFields')) {
-        const missingScopeAttributes = doScopeAttributesMissing(scopeAttributes, queryAttributes);
-        logger_1.default.debug('sadot - before find hook');
-        if (missingScopeAttributes?.length > 0) {
-            queryAttributes.push(...missingScopeAttributes);
-            options.attributesToRemove = missingScopeAttributes;
-        }
-    }
-};
-exports.beforeFind = beforeFind;

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

@@ -1,6 +0,0 @@
-import enrichResults from './enrich';
-import { beforeFind } from './find';
-import { beforeBulkUpdate, beforeUpdate } from './update';
-import { beforeBulkCreate, beforeCreate } from './create';
-import workaround from './workaround';
-export { enrichResults, beforeFind, beforeBulkUpdate, beforeUpdate, beforeBulkCreate, beforeCreate, workaround, };

package/dist/src/hooks/update.d.ts

@@ -1,9 +0,0 @@
-/**
- * A hook to update the custom fields when updating a model (more then one instance).
- */
-export declare const beforeBulkUpdate: (options: any) => void;
-/**
- * A hook to update the custom fields when updating a model instance.
- * TODO - cleanup if update fail
- */
-export declare const beforeUpdate: (scopeAttributes: string[]) => (instance: any, options: any) => Promise<void>;

package/dist/src/hooks/workaround.d.ts

@@ -1,10 +0,0 @@
-/**
- * Workaround to a bug in sequelize.🐛
- *
- * **afterFind hook** isn't working on nested (included) models.
- * The solution here is to add a global afterFind hook,
- * which manually calls the afterFind hook of each model, recursively
- * https://github.com/sequelize/sequelize/issues/4627
- */
-declare const handleChildrenAfterFindHook: (instances: any, options: any, level?: number) => any;
-export default handleChildrenAfterFindHook;

package/dist/src/index.d.ts

@@ -1,11 +0,0 @@
-import type { Application } from 'express';
-import { Sequelize } from 'sequelize-typescript';
-import { CustomFieldOptions, ModelFetcher } from './types';
-export * from './utils/validations/custom-fields';
-/**
- * Adding custom fields enrichment to the models inside the MODELS_FILE_NAME json file
- * @see {@link 'custom-fields/config'} for configurations
- */
-declare const useCustomFields: (app: Application | null, getModel: ModelFetcher, options: CustomFieldOptions) => Promise<Sequelize>;
-export default useCustomFields;
-export declare const disableCustomFields: (models: any, getModel: any) => void;

package/dist/src/index.js

@@ -1,105 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.disableCustomFields = void 0;
-const sequelize_1 = require("sequelize");
-const models_1 = require("./models");
-const api_1 = __importDefault(require("./api"));
-const hooks_1 = require("./hooks");
-const db_1 = __importDefault(require("./utils/db"));
-const logger_1 = __importDefault(require("./utils/logger"));
-__exportStar(require("./utils/validations/custom-fields"), exports);
-const addHooks = (models, getModel) => {
-    models.forEach(async ({ name, scopeAttributes }) => {
-        try {
-            const model = getModel(name);
-            if (!model) {
-                logger_1.default.warn('sadot - tried to addHooks to a model that does not exist yet', {
-                    name,
-                    scopeAttributes,
-                });
-                return;
-            }
-            model.rawAttributes.customFields = {
-                type: sequelize_1.DataTypes.VIRTUAL,
-            };
-            model.refreshAttributes();
-            // TODO: Uncomment after tests are passed
-            // model.addHook('afterFind', workaround);
-            model.addHook('beforeFind', 'sadot-beforeFind', (0, hooks_1.beforeFind)(scopeAttributes));
-            model.addHook('beforeBulkCreate', 'sadot-beforeBulkCreate', hooks_1.beforeBulkCreate);
-            model.addHook('beforeBulkUpdate', 'sadot-beforeBulkUpdate', hooks_1.beforeBulkUpdate);
-            model.addHook('beforeCreate', 'sadot-beforeCreate', (0, hooks_1.beforeCreate)(scopeAttributes));
-            model.addHook('beforeUpdate', 'sadot-beforeUpdate', (0, hooks_1.beforeUpdate)(scopeAttributes));
-            model.addHook('afterFind', 'sadot-afterFind', (0, hooks_1.enrichResults)(name, scopeAttributes));
-            model.addHook('afterUpdate', 'sadot-afterUpdate', (0, hooks_1.enrichResults)(name, scopeAttributes));
-            model.addHook('afterCreate', 'sadot-afterCreate', (0, hooks_1.enrichResults)(name, scopeAttributes));
-        }
-        catch (e) {
-            logger_1.default.error(`Could not add custom fields hook to model ${name}. `, e);
-        }
-    });
-};
-/**
- * Adding custom fields enrichment to the models inside the MODELS_FILE_NAME json file
- * @see {@link 'custom-fields/config'} for configurations
- */
-const useCustomFields = async (app, getModel, options) => {
-    const { models } = options;
-    if (app) {
-        app.use('/api', api_1.default);
-    }
-    const sequelize = (0, db_1.default)(options.databaseConfig);
-    if (process.env.NODE_ENV === 'test') {
-        await (0, models_1.initTestModels)(sequelize);
-    }
-    addHooks(models, getModel);
-    await (0, models_1.initTables)(sequelize, options.getUser);
-    logger_1.default.debug('sadot - custom fields finished initializing with models', models);
-    return sequelize;
-};
-exports.default = useCustomFields;
-const removeHooks = (models, getModel) => {
-    models.forEach(async ({ name }) => {
-        try {
-            const model = getModel(name);
-            if (!model)
-                return;
-            if (model.rawAttributes.customFields) {
-                delete model.rawAttributes.customFields;
-                model.refreshAttributes();
-            }
-            // model.removeHook('afterFind', 'sadot-workaround');
-            model.removeHook('beforeFind', 'sadot-beforeFind');
-            model.removeHook('beforeBulkCreate', 'sadot-beforeBulkCreate');
-            model.removeHook('beforeBulkUpdate', 'sadot-beforeBulkUpdate');
-            model.removeHook('beforeCreate', 'sadot-beforeCreate');
-            model.removeHook('beforeUpdate', 'sadot-beforeUpdate');
-            model.removeHook('afterFind', 'sadot-afterFind');
-            model.removeHook('afterUpdate', 'sadot-afterUpdate');
-        }
-        catch (e) {
-            logger_1.default.error(`Could not add custom fields hook to model ${name}. `, e);
-        }
-    });
-};
-const disableCustomFields = (models, getModel) => {
-    removeHooks(models, getModel);
-};
-exports.disableCustomFields = disableCustomFields;

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

@@ -1,23 +0,0 @@
-import { Model } from 'sequelize-typescript';
-import { CustomFieldDefinitionType } from '../utils/validations/type';
-import { CustomFieldValue } from '.';
-declare class CustomFieldDefinition extends Model {
-    id: string;
-    name: string;
-    displayName?: string;
-    fieldType: CustomFieldDefinitionType;
-    validation?: any;
-    entityId: string; /** Client association entity id */
-    entityType: string; /** Client association entity type (demand source / fleet / etc.) */
-    modelType: string; /** Model type. e.g. Vehicle / StopPoint / etc. */
-    description?: string;
-    required?: boolean;
-    disabled?: boolean;
-    createdAt?: Date;
-    updatedAt?: Date;
-    deletedAt?: Date;
-    values: CustomFieldValue[];
-    static displayNameDefaultValue(instance: CustomFieldDefinition): void;
-    static afterSaveHandler(instance: CustomFieldDefinition, options: any): void;
-}
-export default CustomFieldDefinition;

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

@@ -1,15 +0,0 @@
-import { Model } from 'sequelize-typescript';
-import { CustomFieldDefinition } from '.';
-declare class CustomFieldValue extends Model {
-    modelId: string;
-    customFieldDefinitionId: string;
-    value: any;
-    createdAt?: Date;
-    updatedAt?: Date;
-    deletedAt?: Date;
-    customFieldDefinition: CustomFieldDefinition;
-    static validateValues(instances: CustomFieldValue[]): Promise<void>;
-    static validateValue(instance: CustomFieldValue): Promise<void>;
-    static afterSaveHandler(instance: CustomFieldValue, options: any): void;
-}
-export default CustomFieldValue;

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;