@autofleet/sadot 1.6.18-beta.2 → 1.6.18-beta.21

package/dist/index.d.cts

@@ -1,401 +1,18 @@
+import { CUSTOM_FIELDS_FILTER_SCOPE, CustomFieldDefinitionType, supportedEntities } from "./utils/constants/index.cjs";
+import { CustomFieldValue } from "./models/CustomFieldValue.cjs";
+import { CustomFieldDefinition } from "./models/CustomFieldDefinition.cjs";
+import { CustomValidator } from "./models/CustomValidator.cjs";
+import { CustomFieldOptions, ModelFetcher, Models } from "./types/index.cjs";
+import { SadotInitializationState } from "./init-state.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 { CustomFieldEntries } from "./models/CustomFieldEntries.cjs";
+import { FieldPolicy, ModelInclusion, ModelMode } from "./models/FieldPolicy.cjs";
+import { field_policy_d_exports } from "./repository/field-policy.cjs";
 import { Application } from "express";
-import { Model, ModelCtor, ModelStatic, Sequelize } from "sequelize-typescript";
-import { BindOrReplacements, CreateOptions, IncludeOptions, WhereOptions } from "sequelize";
-import { customFields } from "@autofleet/common-types";
-import Joi from "joi";
-import { Literal } from "sequelize/types/utils";
+import { Sequelize } from "sequelize-typescript";
 
-//#region rolldown:runtime
-//#endregion
-//#region ../zehut/src/user/ApiUser.d.ts
-type AccountType = "client" | "user" | "service" | "driver";
-type EntityPermissions = Record<string, string[]>;
-interface UserExternalData {
-  element?: {
-    internalUser: boolean;
-  };
-  [key: string]: any;
-}
-interface UserPayload {
-  businessModels: EntityPermissions;
-  fleets: EntityPermissions;
-  demandSources: EntityPermissions;
-  businessAccounts?: EntityPermissions;
-  accountType?: AccountType;
-  contexts?: EntityPermissions;
-  createdAt?: string;
-  externalData?: UserExternalData | null;
-  authorizedContextPaths?: string[];
-}
-interface PartialUserPayload {
-  businessModels?: EntityPermissions;
-  fleets?: EntityPermissions;
-  demandSources?: EntityPermissions;
-  vehicles?: EntityPermissions;
-  drivers?: EntityPermissions;
-  businessAccounts?: EntityPermissions;
-}
-declare class ApiUser {
-  id?: string | undefined;
-  accountType?: AccountType | undefined;
-  contextIds?: string[] | undefined;
-  requestedContextPaths?: string[] | undefined;
-  private privatePermissions;
-  private readonly privateElevatedPermissionsHash;
-  private privatePermissionsLegacy;
-  private readonly appPermission;
-  readonly emptyUser: boolean;
-  private privateAuthorizedContextPaths;
-  constructor(id?: string | undefined, accountType?: AccountType | undefined, elevatedPermissions?: PartialUserPayload, contextIds?: string[] | undefined, requestedContextPaths?: string[] | undefined);
-  getUserPermissions(): Promise<UserPayload>;
-  useCustomPermissionLoader(customPermissionLoader: (userId: string) => UserPayload | PromiseLike<UserPayload>): Promise<UserPayload>;
-  get businessModels(): string[];
-  get fleets(): string[];
-  get demandSources(): string[];
-  private getUserProperty;
-  get elevatedPermissions(): UserPayload;
-  get permissions(): UserPayload | undefined;
-  get authorizedContextPaths(): string[];
-  elevatePermissions(addedPermissions: PartialUserPayload): (() => void) & {
-    [Symbol.dispose]: () => void;
-  };
-  getUserPermissionsLegacy(): Promise<unknown>;
-  get permissionsLegacy(): any;
-  getUserAppPermissions(appId: string, clientSecret: string): Promise<UserPayload | undefined>;
-  extendRequiredContexts(contextIdsToAdd?: string[]): void;
-}
-//#endregion
-//#region ../zehut/src/user/index.d.ts
-declare module "express-serve-static-core" {
-  interface Request {
-    user: ApiUser;
-  }
-}
-//#endregion
-//#region ../zehut/src/user/fastify.d.ts
-declare module "fastify" {
-  interface FastifyRequest {
-    user?: ApiUser;
-  }
-}
-//#endregion
-//#region ../zehut/src/check-permission.d.ts
-declare const getUser: () => ApiUser | undefined;
-//#endregion
-//#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",
-  MULTI_SELECT_STATUS = "multi-select-status",
-  MULTI_SELECT_DROPDOWN = "multi-select-dropdown",
-}
-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/CustomFieldModelTypeMap.d.ts
-declare class CustomFieldModelTypeMap extends Model {
-  id: string;
-  modelTypeId: string;
-  customFieldDefinitionId: string;
-  customFieldDefinition: CustomFieldDefinition;
-  createdAt?: Date;
-  updatedAt?: Date;
-}
-//#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[];
-  modelTypeMappings?: CustomFieldModelTypeMap[];
-  private _modelTypeIds?;
-  get modelTypeIds(): string[] | undefined;
-  set modelTypeIds(value: string[] | undefined);
-  static displayNameDefaultValue(instance: CustomFieldDefinition): void;
-  static afterSaveHandler(instance: CustomFieldDefinition, options: CreateOptions): void;
-  /**
-  * Override toJSON to exclude internal associations from API responses
-  * The modelTypeMappings association is used internally to optimize queries
-  * but should not be exposed in the API response (use modelTypeIds instead)
-  */
-  toJSON(): object;
-}
-//#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/types/index.d.ts
-type ModelFetcher = (name: string) => any;
-interface 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[];
-}
-interface Models {
-  name: string;
-  scopeAttributes: any[];
-  modelOptions?: ModelOptions;
-  hasTypeId?: boolean;
-  /**
-  * Optional async callback to determine which custom fields are required for an instance.
-  * Allows consumer applications to override CustomFieldDefinition.required based on custom logic.
-  * @param instance - The model instance being created/updated
-  * @param fieldDefinitions - Array of CustomFieldDefinition records
-  * @param options - Sequelize options including transaction
-  * @returns Array of field names that should be validated as required
-  */
-  getRequiredCustomFields?: (instance: any, fieldDefinitions: CustomFieldDefinition[], options: any) => Promise<string[]> | string[];
-  creationWebhookHandler?: (instance: any) => any;
-  updateWebhookHandler?: (instance: any) => any;
-  deletionWebhookHandler?: (instance: any) => any;
-}
-interface CustomFieldOptions {
-  models: Models[];
-  hasTypeId?: boolean;
-  databaseConfig: any;
-  getUser: typeof getUser;
-  sequelize?: Sequelize;
-  useCustomFieldsEntries?: boolean;
-  useValidators?: boolean;
-  useModelTypeMapping?: boolean;
-  /**
-  * When true, use the legacy `sync({ alter: true })` migration approach
-  * instead of umzug-managed migrations via the `sadot_migrations` table.
-  * Defaults to false (umzug is used by default).
-  */
-  runLegacyMigrations?: boolean;
-  getRequiredCustomFields?: (instance: any, fieldDefinitions: CustomFieldDefinition[], options: any) => Promise<string[]> | string[];
-  /**
-  * Optional predicate that returns true when materialized-path RLS is active for the current
-  * request. When it returns true, sadot's `userScope` on CFD/CV becomes a no-op so RLS is the
-  * sole filter (consumer typically decorates CFD/CV with their mat-path manager so RLS applies).
-  * Pass `matPathManager.isScopingRequest` if using `@autofleet/mat-path-mvp`.
-  */
-  isMatPathEnabled?: () => boolean;
-}
-//#endregion
-//#region src/init-state.d.ts
-/**
-* Tracks the initialization state of sadot's useCustomFields function
-* Allows HealthManager to wait for initialization before passing readiness checks
-*/
-declare class SadotInitializationState {
-  private initPromise;
-  private initError;
-  private isInitialized;
-  private sequelizeInstance;
-  private ownsSequelizeInstance;
-  /** Set the initialization promise */
-  setInitPromise(promise: Promise<Sequelize>, ownsSequelize: boolean): void;
-  /**
-  * Get the Sequelize instance
-  * Returns null if initialization hasn't completed yet, or in cases where it failed.
-  */
-  get sequelize(): Sequelize | null;
-  /**
-  * Wait for initialization to complete and return the Sequelize instance
-  * Returns the Sequelize instance only if Sadot created it (owns it)
-  * Returns undefined if the Sequelize instance was provided externally
-  * Rejects when initialization fails
-  */
-  waitForInitialization(): Promise<Sequelize | undefined>;
-  /** Check if initialization is complete and successful */
-  get isReady(): boolean;
-  /** Get the initialization error if one occurred */
-  get error(): Error | null;
-}
-//#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).
-*/
-interface 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/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/models/FieldPolicy.d.ts
-type ModelMode = "full" | "partial";
-type ModelInclusion = {
-  name: string;
-  mode: "full";
-} | {
-  name: string;
-  mode: "partial";
-  fields: string[];
-};
-declare class FieldPolicy extends Model {
-  id: string;
-  contextId: string;
-  name: string;
-  /** Base-level field names to include */
-  fields: string[];
-  /** Model inclusions; full = all fields, partial = only listed fields */
-  models: ModelInclusion[];
-}
-declare namespace field_policy_d_exports {
-  export { CreateFieldPolicyData, UpdateFieldPolicyData, create, findAllByContext, findByContextAndName, findById, remove, update };
-}
-interface CreateFieldPolicyData {
-  contextId: string;
-  name: string;
-  fields?: string[];
-  models?: ModelInclusion[];
-}
-interface UpdateFieldPolicyData {
-  fields?: string[];
-  models?: ModelInclusion[];
-}
-declare const findByContextAndName: (contextId: string, name: string) => Promise<FieldPolicy | null>;
-declare const findById: (id: string) => Promise<FieldPolicy | null>;
-declare const findAllByContext: (contextId: string) => Promise<FieldPolicy[]>;
-declare const create: ({
-  contextId,
-  name,
-  fields,
-  models
-}: CreateFieldPolicyData) => Promise<FieldPolicy>;
-declare const update: (id: string, data: UpdateFieldPolicyData) => Promise<FieldPolicy | null>;
-declare const remove: (id: string) => Promise<number>;
-//#endregion
 //#region src/index.d.ts
 declare const sadotInitState: SadotInitializationState;
 /**