@autofleet/sadot 0.5.4-beta.0 → 0.5.4-beta.11

package/.env

@@ -0,0 +1,3 @@
+DB_USERNAME=emiltayeb
+DB_PASSWORD=123456
+NODE_ENV=test

package/dist/api/v1/definition/index.js

@@ -41,6 +41,7 @@ const toPascalCase = (str) => str.replace(/(^\w|-\w)/g, (subStr) => subStr.repla
 router.post('/', async (req, res) => {
     const { modelName } = req.params;
     const modelType = toPascalCase(modelName);
+    logger_1.default.info('sadot Creating custom field definition', { modelName });
     try {
         const validatedPayload = await (0, validations_1.validateCustomFieldDefinitionCreation)(req.body);
         const customFieldDefinition = await DefinitionRepo.create({
@@ -83,7 +84,9 @@ router.get('/', async (req, res) => {
         if (entityIds?.length > 0) {
             where.entityId = entityIds;
         }
-        const customFieldDefinitions = await DefinitionRepo.findAll({ ...where }, { withDisabled: true });
+        logger_1.default.info('sadot Fetching custom field definitions', { modelType, entityIds, where });
+        const customFieldDefinitions = await DefinitionRepo.findAll(where, { withDisabled: true });
+        logger_1.default.info('sadot Fetched custom field definitions customFieldDefinitions', { customFieldDefinitions });
         return res.json(customFieldDefinitions);
     }
     catch (err) {

package/dist/index.d.ts

@@ -10,4 +10,3 @@ export * from './utils/constants';
 declare const useCustomFields: (app: Application | null, getModel: ModelFetcher, options: CustomFieldOptions) => Promise<Sequelize>;
 export default useCustomFields;
 export declare const disableCustomFields: (models: any, getModel: any) => void;
-export declare const getCustomFieldsSearchLiteral: (modelName: string, searchTerm: string) => string;

package/dist/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCustomFieldsSearchLiteral = exports.disableCustomFields = void 0;
+exports.disableCustomFields = void 0;
 const models_1 = require("./models");
 const api_1 = __importDefault(require("./api"));
 const db_1 = __importDefault(require("./utils/db"));
@@ -32,7 +32,7 @@ __exportStar(require("./utils/constants"), exports);
 const useCustomFields = async (app, getModel, options) => {
     const { models } = options;
     if (app) {
-        app.use('/api', api_1.default);
+        app.use('/api', options.middleware, api_1.default);
     }
     const sequelize = (0, db_1.default)(options.databaseConfig);
     if (process.env.NODE_ENV === 'test') {
@@ -40,7 +40,7 @@ const useCustomFields = async (app, getModel, options) => {
     }
     // The order is important
     (0, init_1.addHooks)(models, getModel);
-    await (0, models_1.initTables)(sequelize, options.getUser);
+    await (0, models_1.initTables)(sequelize, options.getUser, options.enrichUserPermissions);
     (0, init_1.addScopes)(models, getModel);
     logger_1.default.debug('sadot - custom fields finished initializing with models', models);
     return sequelize;
@@ -50,5 +50,3 @@ const disableCustomFields = (models, getModel) => {
     (0, init_1.removeHooks)(models, getModel);
 };
 exports.disableCustomFields = disableCustomFields;
-const getCustomFieldsSearchLiteral = (modelName, searchTerm) => `EXISTS (SELECT 1 FROM "custom_field_values" AS "cv" WHERE "cv"."deleted_at" IS NULL AND "cv"."model_id" = "${modelName}"."id" AND CAST("cv"."value" AS TEXT) ILIKE '%${searchTerm}%')`;
-exports.getCustomFieldsSearchLiteral = getCustomFieldsSearchLiteral;

package/dist/models/index.d.ts

@@ -3,6 +3,6 @@ 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 initTables: (sequelize: Sequelize, getUser: any, enrichUserPermissions: any) => Promise<void>;
 declare const initTestModels: (sequelize: Sequelize) => Promise<void>;
 export { CustomFieldValue, CustomFieldDefinition, TestModel, AssociatedTestModel, initTables, initTestModels, };

package/dist/models/index.js

@@ -20,7 +20,7 @@ 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) => {
+const initTables = async (sequelize, getUser, enrichUserPermissions) => {
     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
@@ -28,16 +28,20 @@ const initTables = async (sequelize, getUser) => {
         throw new Error('sequelize instance must have addModels function');
     }
     sequelize.addModels(productionModels);
-    CustomFieldDefinition_1.default.addScope('userScope', () => {
+    CustomFieldDefinition_1.default.addScope('userScope', (entityIds) => {
         const user = getUser();
+        logger_1.default.info('custom fields scope added', { entityIds });
         if (user?.permissions) {
+            const entityId = [
+                ...Object.keys(user.permissions.fleets),
+                ...Object.keys(user.permissions.businessModels),
+                ...Object.keys(user.permissions.demandSources),
+                ...enrichUserPermissions(entityIds),
+            ];
+            logger_1.default.info('custom fields scope added updated entity:', { entityId });
             return {
                 where: {
-                    entityId: [
-                        ...Object.keys(user.permissions.fleets),
-                        ...Object.keys(user.permissions.businessModels),
-                        ...Object.keys(user.permissions.demandSources),
-                    ],
+                    entityId,
                 },
             };
         }

package/dist/repository/definition.js

@@ -9,10 +9,11 @@ const findAll = (where, options = { withDisabled: false }) => {
     const queryModel = options.withDisabled
         ? models_1.CustomFieldDefinition.unscoped()
         : models_1.CustomFieldDefinition;
-    return queryModel.scope('userScope').findAll({
+    return queryModel.scope({ method: ['userScope', where] }).findAll({
         where,
         transaction: options.transaction,
         raw: true,
+        logging: console.log,
     });
 };
 exports.findAll = findAll;

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
+import { RequestHandler } from 'express';
 export type ModelFetcher = (name: string) => any;
 export type ModelOptions = {
     name: string;
@@ -10,4 +11,6 @@ export type CustomFieldOptions = {
     models: ModelOptions[];
     databaseConfig: any;
     getUser: () => any;
+    enrichUserPermissions?: (entityIds: string[]) => any;
+    middleware?: RequestHandler;
 };

package/dist/utils/init.js

@@ -10,7 +10,6 @@ const models_1 = require("../models");
 const hooks_1 = require("../hooks");
 const scopes_1 = require("../scopes");
 const logger_1 = __importDefault(require("./logger"));
-const include_1 = require("../scopes/include");
 const { CUSTOM_FIELDS_FILTER_SCOPE } = common_types_1.customFields;
 const addHooks = (models, getModel) => {
     models.forEach(async ({ name, scopeAttributes }) => {
@@ -88,11 +87,11 @@ const addScopes = (models, getModel) => {
                 });
                 return;
             }
+            logger_1.default.info(`addScopes ${name}`, { name, scopeAttributes });
             // Necessary associations for the filtering scope
             addAssociations(model, name);
             // Add filter scope
             model.addScope(CUSTOM_FIELDS_FILTER_SCOPE, (0, scopes_1.customFieldsFilterScope)(name));
-            model.addScope('searchByCustomFields', (0, include_1.customFieldsSearchScope)(name));
         }
         catch (e) {
             logger_1.default.error(`Could not add custom fields scopes to model ${name}. `, e);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/sadot",
-  "version": "0.5.4-beta.0",
+  "version": "0.5.4-beta.11",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -9,7 +9,24 @@
     "linter": "./node_modules/.bin/eslint .",
     "test": "jest --forceExit --runInBand",
     "coverage": "jest --coverage --forceExit --runInBand && rm -rf ./coverage",
-    "dev": "nodemon"
+    "build-to-local-repo": "npm run build && cp -r dist/* ../$REPO/node_modules/$npm_package_name/dist",
+    "dev": "nodemon",
+    "watch": "npm-watch build-to-local-repo"
+  },
+  "watch": {
+    "build-to-local-repo": {
+      "extensions": [
+        "js",
+        "jsx",
+        "ts",
+        "tsx",
+        "css"
+      ],
+      "patterns": [
+        "src"
+      ],
+      "quiet": false
+    }
   },
   "dependencies": {
     "@autofleet/common-types": "^1.7.29",
@@ -18,6 +35,7 @@
     "@autofleet/logger": "^2.0.5",
     "express": "^4.18.2",
     "joi": "^17.7.0",
+    "npm-watch": "^0.11.0",
     "pg": "^8.10.0",
     "reflect-metadata": "^0.1.13",
     "sequelize": "^6.31.1",

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

@@ -18,6 +18,7 @@ const toPascalCase = (str: string): string => str.replace(/(^\w|-\w)/g, (subStr)
 router.post('/', async (req: Request, res: Response) => {
   const { modelName } = req.params as any;
   const modelType = toPascalCase(modelName);
+  logger.info('sadot Creating custom field definition', { modelName });
   try {
     const validatedPayload: CreateCustomFieldDefinition = await
     validateCustomFieldDefinitionCreation(req.body);
@@ -58,17 +59,17 @@ router.get('/:customFieldDefinitionId', async (req, res) => {
 router.get('/', async (req, res) => {
   const { modelName } = req.params as any;
   const { entityIds } = req.query as any;
-
   const modelType = toPascalCase(modelName);
   try {
     const where: any = { modelType };
     if (entityIds?.length > 0) {
       where.entityId = entityIds;
     }
-    const customFieldDefinitions = await DefinitionRepo.findAll(
-      { ...where },
-      { withDisabled: true },
-    );
+
+    logger.info('sadot Fetching custom field definitions', { modelType, entityIds, where });
+    const customFieldDefinitions = await DefinitionRepo.findAll(where,
+      { withDisabled: true });
+    logger.info('sadot Fetched custom field definitions customFieldDefinitions', { customFieldDefinitions });
     return res.json(customFieldDefinitions);
   } catch (err) {
     logger.error('Failed to fetch custom field definitions', err);

package/src/index.ts

@@ -24,7 +24,7 @@ const useCustomFields = async (
 ): Promise<Sequelize> => {
   const { models } = options;
   if (app) {
-    app.use('/api', api);
+    app.use('/api', options.middleware, api);
   }
   const sequelize = initDB(options.databaseConfig);
   if (process.env.NODE_ENV === 'test') {
@@ -32,7 +32,7 @@ const useCustomFields = async (
   }
   // The order is important
   addHooks(models, getModel);
-  await initTables(sequelize, options.getUser);
+  await initTables(sequelize, options.getUser, options.enrichUserPermissions);
   addScopes(models, getModel);
   logger.debug('sadot - custom fields finished initializing with models', models);
   return sequelize;
@@ -43,8 +43,3 @@ export default useCustomFields;
 export const disableCustomFields = (models, getModel): void => {
   removeHooks(models, getModel);
 };
-
-export const getCustomFieldsSearchLiteral = (
-  modelName: string,
-  searchTerm: string,
-) : string => `EXISTS (SELECT 1 FROM "custom_field_values" AS "cv" WHERE "cv"."deleted_at" IS NULL AND "cv"."model_id" = "${modelName}"."id" AND CAST("cv"."value" AS TEXT) ILIKE '%${searchTerm}%')`;

package/src/models/index.ts

@@ -14,7 +14,7 @@ const SADOT_MIGRATION_PREFIX = 'sadot-migration';
 const SCHEMA_VERSION = 1;
 const CUSTOM_FIELDS_SCHEMA_VERSION = `${SADOT_MIGRATION_PREFIX}_${SCHEMA_VERSION}`;
 
-const initTables = async (sequelize: Sequelize, getUser): Promise<void> => {
+const initTables = async (sequelize: Sequelize, getUser, enrichUserPermissions): Promise<void> => {
   logger.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
@@ -23,16 +23,20 @@ const initTables = async (sequelize: Sequelize, getUser): Promise<void> => {
   }
   sequelize.addModels(productionModels);
 
-  CustomFieldDefinition.addScope('userScope', () => {
+  CustomFieldDefinition.addScope('userScope', (entityIds) => {
     const user = getUser();
+    logger.info('custom fields scope added', { entityIds });
     if (user?.permissions) {
+      const entityId = [
+        ...Object.keys(user.permissions.fleets),
+        ...Object.keys(user.permissions.businessModels),
+        ...Object.keys(user.permissions.demandSources),
+        ...enrichUserPermissions(entityIds),
+      ];
+      logger.info('custom fields scope added updated entity:', { entityId });
       return {
         where: {
-          entityId: [
-            ...Object.keys(user.permissions.fleets),
-            ...Object.keys(user.permissions.businessModels),
-            ...Object.keys(user.permissions.demandSources),
-          ],
+          entityId,
         },
       };
     }

package/src/repository/definition.ts

@@ -12,10 +12,11 @@ export const findAll = (
   const queryModel = options.withDisabled
     ? CustomFieldDefinition.unscoped()
     : CustomFieldDefinition;
-  return queryModel.scope('userScope').findAll({
+  return queryModel.scope({ method: ['userScope', where] }).findAll({
     where,
     transaction: options.transaction,
     raw: true,
+    logging: console.log,
   });
 };
 

package/src/types/index.ts

@@ -1,3 +1,5 @@
+import { RequestHandler } from 'express';
+
 export type ModelFetcher = (name: string) => any;
 
 export type ModelOptions = {
@@ -8,8 +10,10 @@ export type ModelOptions = {
   deletionWebhookHandler?: (instance: any) => any;
 }
 
-export type CustomFieldOptions= {
+export type CustomFieldOptions = {
   models: ModelOptions[];
   databaseConfig: any;
   getUser: () => any;
+  enrichUserPermissions?: (entityIds: string[]) => any;
+  middleware?: RequestHandler;
 };

package/src/utils/init.ts

@@ -15,7 +15,6 @@ import {
 import { customFieldsFilterScope } from '../scopes';
 import logger from './logger';
 import type { ModelFetcher, ModelOptions } from '../types';
-import { customFieldsSearchScope } from '../scopes/include';
 
 const { CUSTOM_FIELDS_FILTER_SCOPE } = customFields;
 
@@ -93,11 +92,11 @@ export const addScopes = (models: ModelOptions[], getModel: ModelFetcher): void
         });
         return;
       }
+      logger.info(`addScopes ${name}`, { name, scopeAttributes });
       // Necessary associations for the filtering scope
       addAssociations(model, name);
       // Add filter scope
       model.addScope(CUSTOM_FIELDS_FILTER_SCOPE, customFieldsFilterScope(name));
-      model.addScope('searchByCustomFields', customFieldsSearchScope(name));
     } catch (e) {
       logger.error(`Could not add custom fields scopes to model ${name}. `, e);
     }

package/dist/scopes/include.d.ts

@@ -1,9 +0,0 @@
-import { WhereOptions } from 'sequelize';
-export type CustomFieldSearchOptions = {
-    where?: WhereOptions;
-};
-export declare const customFieldsSearchScope: (name: string) => ({ searchTerm, queryWithSearchTerm }: {
-    searchTerm: any;
-    queryWithSearchTerm: any;
-}) => CustomFieldSearchOptions;
-export declare const scopeName = "searchByCustomFields";

package/dist/scopes/include.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.scopeName = exports.customFieldsSearchScope = void 0;
-const sequelize_typescript_1 = require("sequelize-typescript");
-const customFieldsSearchScope = (name) => ({ searchTerm, queryWithSearchTerm }) => {
-    const subQuery = `${'EXISTS (SELECT 1 '
-        + 'FROM "custom_field_values" AS "cv" '
-        + 'WHERE '
-        + '"cv"."deleted_at" IS NULL AND '
-        + `"cv"."model_id" = "${name}"."id" AND `
-        + `CAST("cv"."value" AS TEXT) ILIKE '%${searchTerm}%')`}`;
-    return {
-        where: {
-            $or: [
-                sequelize_typescript_1.Sequelize.literal(`(${subQuery})`),
-                ...queryWithSearchTerm.$and[0].$or,
-            ],
-        },
-    };
-};
-exports.customFieldsSearchScope = customFieldsSearchScope;
-exports.scopeName = 'searchByCustomFields';

package/src/scopes/include.ts

@@ -1,30 +0,0 @@
-/* eslint-disable import/prefer-default-export */
-import { WhereOptions } from 'sequelize';
-import { Sequelize } from 'sequelize-typescript';
-
-export type CustomFieldSearchOptions = {
-  where?: WhereOptions;
-}
-
-export const customFieldsSearchScope = (
-  name: string,
-) => ({ searchTerm, queryWithSearchTerm }) : CustomFieldSearchOptions => {
-  const subQuery = `${
-    'EXISTS (SELECT 1 '
-    + 'FROM "custom_field_values" AS "cv" '
-    + 'WHERE '
-    + '"cv"."deleted_at" IS NULL AND '
-    + `"cv"."model_id" = "${name}"."id" AND `
-    + `CAST("cv"."value" AS TEXT) ILIKE '%${searchTerm}%')`}`;
-
-  return {
-    where: {
-      $or: [
-        Sequelize.literal(`(${subQuery})`),
-        ...queryWithSearchTerm.$and[0].$or,
-      ],
-    },
-  };
-};
-
-export const scopeName = 'searchByCustomFields';