@grouparoo/core/src/modules/configLoaders/property.ts

The Grouparoo Core

import {
  PropertyConfigurationObject,
  extractNonNullParts,
  logModel,
  getParentByName,
  getCodeConfigLockKey,
  validateConfigObjectKeys,
  IdsByClass,
} from "../../classes/codeConfig";
import { Source, Property } from "../.."; // configLoader imports need to be from root
import { FilterHelper } from "../filterHelper";
import { Op } from "sequelize";
import { Deprecation } from "../deprecation";

import { ConfigWriter } from "../configWriter";

export async function loadProperty(
  configObject: PropertyConfigurationObject,
  externallyValidate: boolean,
  validate = false
): Promise<IdsByClass> {
  let isNew = false;
  const source: Source = await getParentByName(Source, configObject.sourceId);

  validateConfigObjectKeys(Property, configObject, [
    "options",
    "filters",
    "name",
    "identifying", // deprecated
  ]);

  let property = await Property.scope(null).findOne({
    where: {
      id: configObject.id,
    },
  });

  // don't process bootstrapped properties again
  if (property && property.isPrimaryKey) return {};

  if (!property) {
    isNew = true;
    property = await Property.create({
      id: configObject.id,
      //@ts-ignore
      key: configObject.key || configObject["name"],
      type: configObject.type,
      sourceId: source.id,
    });
  }

  await property.setOptions(
    extractNonNullParts(configObject, "options"),
    null,
    externallyValidate
  );

  await property.update({
    type: configObject.type,
    //@ts-ignore
    key: configObject.key || configObject["name"],
    unique: configObject.unique,
    isArray: configObject.isArray,
    locked: ConfigWriter.getLockKey(configObject),
  });

  if (configObject.filters) {
    for (const filter of configObject.filters) {
      if (Object.keys(FilterHelper.deprecatedFilters).includes(filter.op)) {
        throw new Error(
          `Property filter \`${
            filter.op
          }\` has been deprecated and replaced with \`${
            //@ts-ignore
            FilterHelper.deprecatedFilters[filter.op]
          }\`. Read more at https://www.grouparoo.com/docs/support/config-files#properties`
        );
      }
    }

    await property.setFilters(configObject.filters, externallyValidate);
  }

  //@ts-ignore
  if (!!configObject["identifying"]) {
    Deprecation.warnRemoved("config", "Property", "identifying");
  }

  await property.update({ state: "ready" });

  logModel<Property>(
    property,
    validate ? "validated" : isNew ? "created" : "updated"
  );

  return { property: [property.id] };
}

export async function deleteProperties(ids: string[]) {
  const properties = await Property.scope(null).findAll({
    where: { locked: getCodeConfigLockKey(), id: { [Op.notIn]: ids } },
  });

  for (const i in properties) {
    const property = properties[i];
    await property.update({ state: "deleted", locked: null });
    logModel<Property>(property, "deleted");
  }

  return properties.map((instance) => instance.id);
}