SCM-Manager/scm-ui/ui-api/src/links.ts

/*
 * MIT License
 *
 * Copyright (c) 2020-present Cloudogu GmbH and Contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
import { HalRepresentation, Link } from "@scm-manager/ui-types";
import { MissingLinkError } from "./errors";

export const requiredLink = (object: HalRepresentation, name: string, subName?: string): string => {
  const link = object._links[name];
  if (!link) {
    throw new MissingLinkError(`could not find link with name ${name}`);
  }
  if (Array.isArray(link)) {
    if (subName) {
      const subLink = link.find((l: Link) => l.name === subName);
      if (subLink) {
        return subLink.href;
      }
      throw new Error(`could not return href, sub-link ${subName} in ${name} does not exist`);
    }
    throw new Error(`could not return href, link ${name} is a multi link`);
  }
  return link.href;
};

export const objectLink = (object: HalRepresentation, name: string) => {
  const link = object._links[name];
  if (!link) {
    return null;
  }
  if (Array.isArray(link)) {
    throw new Error(`could not return href, link ${name} is a multi link`);
  }
  return link.href;
};