author.ts

/*
 * author.ts
 *
 * Copyright (C) 2020-2022 Posit Software, PBC
 */

import { CSLName } from "./csl.ts";

export interface Author {
  name: string | CSLName;
  affilliation?: Affiliation;
  url?: string;
  orcid?: string;
}

export interface Affiliation {
  name: string;
  url?: string;
}

const kName = "name";
const kGiven = "given";
const kFamily = "family";
const kDropping = "dropping-particle";
const kNonDropping = "non-dropping-particle";
const kAffiliation = "affiliation";
const kAfilliationUrl = "affiliation-url";
const kOrcid = "orcid";
const kUrl = "url";

export function cslNameToString(cslName: string | CSLName) {
  if (typeof cslName === "string") return cslName;
  if (cslName.literal) return cslName.literal;
  const parts: string[] = [];

  if (cslName.given) {
    parts.push(cslName.given);
  }

  if (cslName["dropping-particle"]) {
    parts.push(cslName["dropping-particle"]);
  }
  if (cslName["non-dropping-particle"]) {
    parts.push(cslName["non-dropping-particle"]);
  }
  if (cslName.family) {
    parts.push(cslName.family);
  }

  return parts.join(" ");
}

export function parseAuthor(authorRaw: unknown, strict?: boolean) {
  if (!authorRaw) {
    return undefined;
  }
  const parsed: Author[] = [];
  const authors = Array.isArray(authorRaw) ? authorRaw : [authorRaw];
  let unrecognized = false;
  authors.forEach((author) => {
    if (typeof author === "string") {
      // Its a string, so make it a name
      parsed.push({
        name: author,
      });
    } else if (typeof author === "object") {
      // Parse the author object
      // Currently this only supports simple 'Distill Style'
      // authors and affiliations
      const name = author[kName];
      if (name) {
        const auth: Author = {
          name,
        };
        const affilation = author[kAffiliation];
        if (affilation) {
          auth.affilliation = { name: affilation };
          if (author[kAfilliationUrl]) {
            auth.affilliation.url = author[kAfilliationUrl];
          }
        }

        const orcid = author[kOrcid];
        if (orcid) {
          auth.orcid = orcid;
        }

        const url = author[kUrl];
        if (url) {
          auth.url = url;
        }

        parsed.push(auth);
      } else if (author[kFamily]) {
        const given = author[kGiven];
        const family = author[kFamily];
        const dropping = author[kDropping];
        const nonDropping = author[kNonDropping];
        parsed.push({
          name: {
            [kGiven]: given,
            [kFamily]: family,
            [kDropping]: dropping,
            [kNonDropping]: nonDropping,
          },
        });
      } else {
        unrecognized = true;
      }
    }
  });

  // If we didn't know how to parse this author
  // just stand down - we just don't recognize this.
  if (strict && unrecognized) {
    return undefined;
  } else {
    return parsed;
  }
}