terriajs/lib/Models/Catalog/addUserCatalogMember.ts

Geospatial data visualization platform.

import i18next from "i18next";
import getDereferencedIfExists from "../../Core/getDereferencedIfExists";
import isDefined from "../../Core/isDefined";
import GroupMixin from "../../ModelMixins/GroupMixin";
import GroupTraits from "../../Traits/TraitsClasses/GroupTraits";
import CommonStrata from "../Definition/CommonStrata";
import hasTraits from "../Definition/hasTraits";
import { BaseModel } from "../Definition/Model";
import Terria from "../Terria";

interface AddUserCatalogMemberOptions {
  enable?: boolean;
  open?: boolean;
}

/**
 * Adds a user's catalog item or group to the catalog.
 *
 */
export default async function addUserCatalogMember(
  terria: Terria,
  newCatalogMemberOrPromise: BaseModel | Promise<BaseModel | undefined>,
  options: AddUserCatalogMemberOptions = {}
): Promise<BaseModel | undefined> {
  const promise =
    newCatalogMemberOrPromise instanceof Promise
      ? newCatalogMemberOrPromise
      : Promise.resolve(newCatalogMemberOrPromise);

  try {
    const newCatalogItem = await promise;
    if (!isDefined(newCatalogItem)) {
      return;
    }

    terria.catalog.userAddedDataGroup.setTrait(
      CommonStrata.user,
      "isOpen",
      true
    );
    terria.catalog.userAddedDataGroup.add(CommonStrata.user, newCatalogItem);

    const dereferenced = getDereferencedIfExists(newCatalogItem);

    if (
      isDefined(options.open) &&
      hasTraits(dereferenced, GroupTraits, "isOpen")
    ) {
      dereferenced.setTrait(CommonStrata.user, "isOpen", true);
    }

    if ((options.enable ?? true) && !GroupMixin.isMixedInto(dereferenced)) {
      (await terria.workbench.add(dereferenced)).throwIfError();
    }
    return newCatalogItem;
  } catch (e: any) {
    terria.raiseErrorToUser(e, {
      title: i18next.t("models.userData.addingDataErrorTitle"),
      message: i18next.t("models.userData.addingDataErrorTitle")
    });
    return e;
  }
}