bknd/app/src/data/entities/mutation/Mutator.ts

import type { DB as DefaultDB, PrimaryFieldType } from "bknd";
import { type EmitsEvents, EventManager } from "core/events";
import type { DeleteQueryBuilder, InsertQueryBuilder, UpdateQueryBuilder } from "kysely";
import type { TActionContext } from "data/fields";
import { WhereBuilder } from "../query/WhereBuilder";
import type { Entity, EntityData, EntityManager } from "../../entities";
import { InvalidSearchParamsException } from "../../errors";
import { MutatorEvents } from "../../events";
import { RelationMutator } from "../../relations";
import type { RepoQuery } from "../../server/query";
import { MutatorResult, type MutatorResultOptions } from "./MutatorResult";

type MutatorQB =
   | InsertQueryBuilder<any, any, any>
   | UpdateQueryBuilder<any, any, any, any>
   | DeleteQueryBuilder<any, any, any>;

type MutatorUpdateOrDelete =
   | UpdateQueryBuilder<any, any, any, any>
   | DeleteQueryBuilder<any, any, any>;

export class Mutator<
   TBD extends object = DefaultDB,
   TB extends keyof TBD = any,
   Output = TBD[TB],
   Input = Omit<Output, "id">,
> implements EmitsEvents
{
   static readonly Events = MutatorEvents;
   emgr: EventManager<typeof MutatorEvents>;

   // @todo: current hacky workaround to disable creation of system entities
   __unstable_disable_system_entity_creation = true;
   __unstable_toggleSystemEntityCreation(value: boolean) {
      this.__unstable_disable_system_entity_creation = value;
   }

   constructor(
      public em: EntityManager<TBD>,
      public entity: Entity,
      protected options?: { emgr?: EventManager<any> },
   ) {
      this.emgr = options?.emgr ?? new EventManager(MutatorEvents);
   }

   private get conn() {
      return this.em.connection.kysely;
   }

   async getValidatedData<Given = any>(data: Given, context: TActionContext): Promise<Given> {
      const entity = this.entity;
      if (!context) {
         throw new Error("Context must be provided for validation");
      }

      const keys = Object.keys(data as any);
      const validatedData: EntityData = {};

      // get relational references/keys
      const relationMutator = new RelationMutator(entity, this.em);
      const relational_keys = relationMutator.getRelationalKeys();

      for (const key of keys) {
         if (relational_keys.includes(key)) {
            const result = await relationMutator.persistRelation(key, data[key]);

            // if relation field (include key and value in validatedData)
            if (Array.isArray(result)) {
               const [relation_key, relation_value] = result;
               validatedData[relation_key] = relation_value;
            }
            continue;
         }

         const field = entity.getField(key);
         if (!field) {
            throw new Error(
               `Field "${key}" not found on entity "${entity.name}". Fields: ${entity
                  .getFillableFields()
                  .map((f) => f.name)
                  .join(", ")}`,
            );
         }

         // we should never get here, but just to be sure (why?)
         if (!field.isFillable(context)) {
            throw new Error(`Field "${key}" is not fillable on entity "${entity.name}"`);
         }

         // transform from field
         validatedData[key] = await field.transformPersist(data[key], this.em, context);

         // transform to driver
         validatedData[key] = this.em.connection.toDriver(validatedData[key], field);
      }

      if (Object.keys(validatedData).length === 0) {
         throw new Error(`No data left to update "${entity.name}"`);
      }

      return validatedData as Given;
   }

   protected async performQuery<T = EntityData[]>(
      qb: MutatorQB,
      opts?: MutatorResultOptions,
   ): Promise<MutatorResult<T>> {
      const result = new MutatorResult(this.em, this.entity, {
         silent: false,
         ...opts,
      });
      return (await result.execute(qb)) as any;
   }

   async insertOne(data: Input): Promise<MutatorResult<Output>> {
      const entity = this.entity;
      if (entity.type === "system" && this.__unstable_disable_system_entity_creation) {
         throw new Error(`Creation of system entity "${entity.name}" is disabled`);
      }

      const result = await this.emgr.emit(
         new Mutator.Events.MutatorInsertBefore({ entity, data: data as any }),
      );

      // if listener returned, take what's returned
      const _data = result.returned ? result.params.data : data;
      let validatedData = await this.getValidatedData(
         {
            ...entity.getDefaultObject(),
            ..._data,
         },
         "create",
      );

      // check if required fields are present
      const required = entity.getRequiredFields();
      for (const field of required) {
         if (
            typeof validatedData[field.name] === "undefined" ||
            validatedData[field.name] === null
         ) {
            throw new Error(`Field "${field.name}" is required`);
         }
      }

      // primary
      const primary = entity.getPrimaryField();
      const primary_value = primary.getNewValue();
      if (primary_value) {
         validatedData = {
            [primary.name]: primary_value,
            ...validatedData,
         };
      }

      const query = this.conn
         .insertInto(entity.name)
         .values(validatedData)
         .returning(entity.getSelect());

      const res = await this.performQuery(query, { single: true });

      await this.emgr.emit(
         new Mutator.Events.MutatorInsertAfter({ entity, data: res.data, changed: validatedData }),
      );

      return res as any;
   }

   async updateOne(id: PrimaryFieldType, data: Partial<Input>): Promise<MutatorResult<Output>> {
      const entity = this.entity;
      if (!id) {
         throw new Error("ID must be provided for update");
      }

      const result = await this.emgr.emit(
         new Mutator.Events.MutatorUpdateBefore({
            entity,
            entityId: id,
            data,
         }),
      );

      const _data = result.returned ? result.params.data : data;
      const validatedData = await this.getValidatedData(_data, "update");

      const query = this.conn
         .updateTable(entity.name)
         .set(validatedData as any)
         .where(entity.id().name, "=", id)
         .returning(entity.getSelect());

      const res = await this.performQuery(query, { single: true });

      await this.emgr.emit(
         new Mutator.Events.MutatorUpdateAfter({
            entity,
            entityId: id,
            data: res.data,
            changed: validatedData,
         }),
      );

      return res as any;
   }

   async deleteOne(id: PrimaryFieldType): Promise<MutatorResult<Output>> {
      const entity = this.entity;
      if (!id) {
         throw new Error("ID must be provided for deletion");
      }

      await this.emgr.emit(new Mutator.Events.MutatorDeleteBefore({ entity, entityId: id }));

      const query = this.conn
         .deleteFrom(entity.name)
         .where(entity.id().name, "=", id)
         .returning(entity.getSelect());

      const res = await this.performQuery(query, { single: true });

      await this.emgr.emit(
         new Mutator.Events.MutatorDeleteAfter({ entity, entityId: id, data: res.data }),
      );

      return res as any;
   }

   private getValidOptions(options?: Partial<RepoQuery>): Partial<RepoQuery> {
      const entity = this.entity;
      const validated: Partial<RepoQuery> = {};

      if (options?.where) {
         // @todo: add tests for aliased fields in where
         const invalid = WhereBuilder.getPropertyNames(options.where).filter((field) => {
            return typeof entity.getField(field) === "undefined";
         });

         if (invalid.length > 0) {
            throw new InvalidSearchParamsException(`Invalid where field(s): ${invalid.join(", ")}`);
         }

         validated.where = options.where;
      }

      return validated;
   }

   private appendWhere<QB extends MutatorUpdateOrDelete>(qb: QB, _where?: RepoQuery["where"]): QB {
      const entity = this.entity;

      const alias = entity.name;
      const aliased = (field: string) => `${alias}.${field}`;

      // add where if present
      if (_where) {
         // @todo: add tests for aliased fields in where
         const invalid = WhereBuilder.getPropertyNames(_where).filter((field) => {
            return typeof entity.getField(field) === "undefined";
         });

         if (invalid.length > 0) {
            throw new InvalidSearchParamsException(`Invalid where field(s): ${invalid.join(", ")}`);
         }

         return WhereBuilder.addClause(qb, _where);
      }

      return qb;
   }

   // @todo: decide whether entries should be deleted all at once or one by one (for events)
   async deleteWhere(where: RepoQuery["where"]): Promise<MutatorResult<Output[]>> {
      const entity = this.entity;

      // @todo: add a way to delete all by adding force?
      if (!where || typeof where !== "object" || Object.keys(where).length === 0) {
         throw new Error("Where clause must be provided for mass deletion");
      }

      const qb = this.appendWhere(this.conn.deleteFrom(entity.name), where).returning(
         entity.getSelect(),
      );

      return await this.performQuery(qb);
   }

   async updateWhere(
      data: Partial<Input>,
      where: RepoQuery["where"],
   ): Promise<MutatorResult<Output[]>> {
      const entity = this.entity;
      const validatedData = await this.getValidatedData(data, "update");

      // @todo: add a way to delete all by adding force?
      if (!where || typeof where !== "object" || Object.keys(where).length === 0) {
         throw new Error("Where clause must be provided for mass update");
      }

      const query = this.appendWhere(this.conn.updateTable(entity.name), where)
         .set(validatedData as any)
         .returning(entity.getSelect());

      return await this.performQuery(query);
   }

   async insertMany(data: Input[]): Promise<MutatorResult<Output[]>> {
      const entity = this.entity;
      if (entity.type === "system" && this.__unstable_disable_system_entity_creation) {
         throw new Error(`Creation of system entity "${entity.name}" is disabled`);
      }

      const validated: any[] = [];
      for (const row of data) {
         const validatedData = {
            ...entity.getDefaultObject(),
            ...(await this.getValidatedData(row, "create")),
         };

         // check if required fields are present
         const required = entity.getRequiredFields();
         for (const field of required) {
            if (
               typeof validatedData[field.name] === "undefined" ||
               validatedData[field.name] === null
            ) {
               throw new Error(`Field "${field.name}" is required`);
            }
         }

         validated.push(validatedData);
      }

      const query = this.conn
         .insertInto(entity.name)
         .values(validated)
         .returning(entity.getSelect());

      return await this.performQuery(query);
   }
}