@compas/code-gen/src/generator/sql/add-fields.js

Generate various boring parts of your server

// @ts-nocheck

import { DateType } from "../../builders/DateType.js";
import { buildOrInfer } from "../../builders/utils.js";
import { UuidType } from "../../builders/UuidType.js";
import { getPrimaryKeyWithType, getQueryEnabledObjects } from "./utils.js";

/**
 * Adds the fields that are added by relations
 *
 * @param {import("../../generated/common/types").CodeGenContext} context
 */
export function addFieldsOfRelations(context) {
  for (const type of getQueryEnabledObjects(context)) {
    if (type.queryOptions?.withPrimaryKey) {
      try {
        getPrimaryKeyWithType(type);
      } catch {
        // Only add an 'id' field if none was found
        type.keys["id"] = new UuidType().primary().build();
      }
    }
  }

  // We can only add relation keys if all types have an id.
  // So we loop again over all query enabled objects
  for (const type of getQueryEnabledObjects(context)) {
    for (const relation of type.relations) {
      addFieldsForRelation(context, type, relation);
    }

    // Add date fields if necessary
    if (type.queryOptions?.withDates || type.queryOptions?.withSoftDeletes) {
      type.keys["createdAt"] = getSystemDate();
      type.keys["updatedAt"] = getSystemDate();
    }
    if (type.queryOptions?.withSoftDeletes) {
      type.keys["deletedAt"] = {
        ...getSystemDate(),
        defaultValue: undefined,
      };
    }
  }
}

/**
 * @param {import("../../generated/common/types").CodeGenContext} context
 * @param {CodeGenObjectType} type
 * @param {CodeGenRelationType} relation
 */
export function addFieldsForRelation(context, type, relation) {
  if (["manyToOne", "oneToOne"].indexOf(relation.subType) === -1) {
    return;
  }

  try {
    const { field } = getPrimaryKeyWithType(
      /** @type {CodeGenObjectType} */
      relation.reference.reference,
    );
    type.keys[relation.ownKey] = {
      ...field,
      sql: {
        primary: false,
        searchable: true,
      },
      isOptional: relation.isOptional,
    };
  } catch {
    context.errors.push({
      errorString: `Type '${relation.reference.reference.name}' is missing a primary key.
  Either remove 'withPrimaryKey' from the options passed to 'enableQueries()' or add 'T.uuid().primary()' / 'T.number().primary()' to your type.`,
    });
  }
}

/**
 * Get the default Date type.
 *
 * @returns {CodeGenDateType}
 */
function getSystemDate() {
  return buildOrInfer(
    new DateType()
      .defaultToNow()
      .searchable()
      .docs("Automatically generated field"),
  );
}