react-cheminfo 0.71.0 → 0.73.0

package/src/citation/core/reference.ts

@@ -1,13 +1,18 @@
 /** One author of a reference, as the citation styles need them. */
 export interface ReferenceAuthor {
-  /** Initials or first name, e.g. `J. R.`. */
+  /** Initials or first name, e.g. `J. R.`; empty for an organisation. */
   given: string;
-  /** Family name, e.g. `Vanderveen`. */
+  /** Family name, e.g. `Vanderveen`, or the organisation's name. */
   family: string;
 }
 
 /** A journal article, with everything the citation formats need. */
-export interface Reference {
+export interface ArticleReference {
+  /**
+   * What the work is.
+   * @default 'article'
+   */
+  kind?: 'article';
   authors: readonly ReferenceAuthor[];
   title: string;
   /** Full journal name, e.g. `Green Chemistry`. */
@@ -23,6 +28,29 @@ export interface Reference {
   publisher: string;
 }
 
+/**
+ * A dataset deposited in a repository, with everything the citation formats
+ * need: it has no journal, no volume and no pages, and a repository instead.
+ */
+export interface DatasetReference {
+  /** What the work is. */
+  kind: 'dataset';
+  authors: readonly ReferenceAuthor[];
+  title: string;
+  /** The repository holding it, e.g. `Zenodo`. */
+  repository: string;
+  year: number;
+  /**
+   * The version deposited, when the repository records one.
+   * @default undefined
+   */
+  version?: string;
+  doi: string;
+}
+
+/** A work the citation formats write: a journal article, or a dataset. */
+export type Reference = ArticleReference | DatasetReference;
+
 /**
  * Resolvable address of a reference.
  * @param reference - Reference to link to.
@@ -31,3 +59,15 @@ export interface Reference {
 export function doiUrl(reference: Reference): string {
   return `https://doi.org/${reference.doi}`;
 }
+
+/**
+ * Where a work was published, as a menu names it beside its year: the
+ * abbreviated journal of an article, the repository of a dataset.
+ * @param reference - The work.
+ * @returns The journal or the repository.
+ */
+export function referenceVenue(reference: Reference): string {
+  return reference.kind === 'dataset'
+    ? reference.repository
+    : reference.journalAbbreviation;
+}

package/src/citation/core/segments.ts

@@ -1,4 +1,9 @@
-import type { Reference } from './reference.ts';
+import type {
+  ArticleReference,
+  DatasetReference,
+  Reference,
+  ReferenceAuthor,
+} from './reference.ts';
 import { doiUrl } from './reference.ts';
 
 /** One piece of a written reference, with the emphasis its style asks for. */
@@ -37,6 +42,7 @@ export function citationSegments(
   reference: Reference,
   style: CitationStyleId,
 ): CitationSegment[] {
+  if (reference.kind === 'dataset') return datasetSegments(reference, style);
   switch (style) {
     case 'acs':
       return acs(reference);
@@ -51,10 +57,62 @@ export function citationSegments(
   }
 }
 
-function acs(reference: Reference): CitationSegment[] {
+/**
+ * A dataset as each style writes one: the repository stands where the journal
+ * would, and there is neither a volume nor pages. The title is kept by every
+ * style, the RSC one included, since it is what tells two datasets of the same
+ * authors and year apart.
+ * @param reference - Dataset to write.
+ * @param style - Style to write it in.
+ * @returns The segments of the citation, in reading order.
+ */
+function datasetSegments(
+  reference: DatasetReference,
+  style: CitationStyleId,
+): CitationSegment[] {
+  const { repository, year, version } = reference;
+  const title =
+    version === undefined
+      ? reference.title
+      : `${reference.title}, version ${version}`;
+  switch (style) {
+    case 'acs':
+      return [
+        text(`${withPeriod(familyFirst(reference, '; '))} ${title}; `),
+        italic(repository),
+        text(`, ${year}. `),
+        doiLink(reference),
+      ];
+    case 'nature':
+      return [
+        text(`${withPeriod(familyFirstAmpersand(reference))} ${title}. `),
+        italic(repository),
+        text(` (${year}). `),
+        doiLink(reference),
+      ];
+    case 'rsc':
+      return [
+        text(`${initialsFirst(reference, ' and ')}, ${title}, `),
+        italic(repository),
+        text(`, ${year}. `),
+        doiLink(reference),
+      ];
+    case 'wiley':
+      return [
+        text(`${initialsFirst(reference, ', ')}, ${title}, `),
+        italic(repository),
+        text(`, ${year}. `),
+        doiLink(reference),
+      ];
+    default:
+      throw new Error(`unknown citation style: ${String(style)}`);
+  }
+}
+
+function acs(reference: ArticleReference): CitationSegment[] {
   const { title, journalAbbreviation, year, volume } = reference;
   return [
-    text(`${familyFirst(reference, '; ')} ${title}. `),
+    text(`${withPeriod(familyFirst(reference, '; '))} ${title}. `),
     italic(journalAbbreviation),
     text(' '),
     bold(String(year)),
@@ -65,10 +123,10 @@ function acs(reference: Reference): CitationSegment[] {
   ];
 }
 
-function nature(reference: Reference): CitationSegment[] {
+function nature(reference: ArticleReference): CitationSegment[] {
   const { title, journalAbbreviation, year, volume } = reference;
   return [
-    text(`${familyFirstAmpersand(reference)} ${title}. `),
+    text(`${withPeriod(familyFirstAmpersand(reference))} ${title}. `),
     italic(journalAbbreviation),
     text(' '),
     bold(volume),
@@ -77,7 +135,7 @@ function nature(reference: Reference): CitationSegment[] {
   ];
 }
 
-function rsc(reference: Reference): CitationSegment[] {
+function rsc(reference: ArticleReference): CitationSegment[] {
   const { journalAbbreviation, year, volume } = reference;
   return [
     text(`${initialsFirst(reference, ' and ')}, `),
@@ -89,7 +147,7 @@ function rsc(reference: Reference): CitationSegment[] {
   ];
 }
 
-function wiley(reference: Reference): CitationSegment[] {
+function wiley(reference: ArticleReference): CitationSegment[] {
   const { journalAbbreviation, year, volume } = reference;
   return [
     text(`${initialsFirst(reference, ', ')}, `),
@@ -123,6 +181,16 @@ function doiLink(reference: Reference): CitationSegment {
   };
 }
 
+/**
+ * The author list closed by a full stop. A person's name already ends on the
+ * one of their last initial; an organisation's name needs its own.
+ * @param authors - The author list.
+ * @returns It, ending with a full stop.
+ */
+function withPeriod(authors: string): string {
+  return authors.endsWith('.') ? authors : `${authors}.`;
+}
+
 /**
  * `Vanderveen, J. R.; Patiny, L.` — the family name leads.
  * @param reference - The work being written.
@@ -130,9 +198,7 @@ function doiLink(reference: Reference): CitationSegment {
  * @returns The authors, as one string.
  */
 function familyFirst(reference: Reference, separator: string): string {
-  return reference.authors
-    .map((author) => `${author.family}, ${author.given}`)
-    .join(separator);
+  return reference.authors.map(nameFamilyFirst).join(separator);
 }
 
 /**
@@ -141,9 +207,7 @@ function familyFirst(reference: Reference, separator: string): string {
  * @returns The authors, as one string.
  */
 function familyFirstAmpersand(reference: Reference): string {
-  const names = reference.authors.map(
-    (author) => `${author.family}, ${author.given}`,
-  );
+  const names = reference.authors.map(nameFamilyFirst);
   const last = names.at(-1);
   if (names.length < 2 || last === undefined) return names.join(', ');
   return `${names.slice(0, -1).join(', ')} & ${last}`;
@@ -156,8 +220,8 @@ function familyFirstAmpersand(reference: Reference): string {
  * @returns The authors, as one string.
  */
 function initialsFirst(reference: Reference, lastSeparator: string): string {
-  const names = reference.authors.map(
-    (author) => `${author.given} ${author.family}`,
+  const names = reference.authors.map((author) =>
+    author.given === '' ? author.family : `${author.given} ${author.family}`,
   );
   const last = names.at(-1);
   if (names.length < 2 || last === undefined) return names.join(', ');
@@ -171,8 +235,20 @@ function initialsFirst(reference: Reference, lastSeparator: string): string {
  * @returns One number for a journal that paginates by article number, the
  * range otherwise.
  */
-export function pageRange(reference: Reference, dash = '–'): string {
+export function pageRange(reference: ArticleReference, dash = '–'): string {
   const { firstPage, lastPage } = reference;
   if (firstPage === lastPage) return firstPage;
   return `${firstPage}${dash}${lastPage}`;
 }
+
+/**
+ * An author with the family name first, `Vanderveen, J. R.`, or the name of an
+ * organisation alone.
+ * @param author - The author.
+ * @returns The name, as a reference list writes it.
+ */
+export function nameFamilyFirst(author: ReferenceAuthor): string {
+  return author.given === ''
+    ? author.family
+    : `${author.family}, ${author.given}`;
+}

package/src/citation/ui/CitationMenu.tsx

@@ -5,7 +5,7 @@ import type { CSSProperties, ReactElement } from 'react';
 import { useChromeT } from '../../i18n/ui/useT.ts';
 import { CITATION_DOWNLOADS } from '../core/formats.ts';
 import type { Reference } from '../core/reference.ts';
-import { doiUrl } from '../core/reference.ts';
+import { doiUrl, referenceVenue } from '../core/reference.ts';
 import type { CitedWork } from '../core/works.ts';
 import { citedReferences } from '../core/works.ts';
 
@@ -78,7 +78,7 @@ function OneWorkMenu(props: CitedReferenceProps): ReactElement {
     <Menu className="citation-menu" style={MENU_STYLE}>
       <MenuItem
         icon={<SvgLogoDoi style={DOI_ICON_STYLE} />}
-        text={`${reference.journalAbbreviation} ${reference.year}`}
+        text={`${referenceVenue(reference)} ${reference.year}`}
         label={reference.doi}
         href={doiUrl(reference)}
         target="_blank"

package/src/citation/ui/WorkEntry.tsx

@@ -4,7 +4,7 @@ import type { CSSProperties, ReactElement } from 'react';
 
 import { useChromeT } from '../../i18n/ui/useT.ts';
 import { CITATION_DOWNLOADS } from '../core/formats.ts';
-import { doiUrl } from '../core/reference.ts';
+import { doiUrl, referenceVenue } from '../core/reference.ts';
 import type { CitedWork } from '../core/works.ts';
 
 import { CopyFormatEntries } from './CopyFormatEntries.tsx';
@@ -52,11 +52,15 @@ export function WorkEntry(props: WorkEntryProps): ReactElement {
           {note === undefined ? null : <div style={NOTE_STYLE}>{note}</div>}
         </span>
       }
-      label={`${reference.journalAbbreviation} ${reference.year}`}
+      label={`${referenceVenue(reference)} ${reference.year}`}
     >
       <MenuItem
         icon={<SvgLogoDoi style={DOI_ICON_STYLE} />}
-        text={t('cite.openArticle')}
+        text={
+          reference.kind === 'dataset'
+            ? t('cite.openDataset')
+            : t('cite.openArticle')
+        }
         label={reference.doi}
         href={doiUrl(reference)}
         target="_blank"

package/src/credits/core/credits.ts

@@ -280,6 +280,15 @@ export const CREDITS = [
       'displays and processes the NMR spectra, read from their original files.',
     license: 'MIT AND CC-BY-NC-SA-4.0',
   },
+  {
+    // 22.x publishes no repository URL, so its npm page stands for it.
+    id: 'nmr-processing',
+    name: 'nmr-processing',
+    href: 'https://www.npmjs.com/package/nmr-processing',
+    description:
+      'simulates NMR spectra from chemical shifts and coupling constants.',
+    license: 'CC-BY-NC-SA-4.0',
+  },
   {
     id: 'blueprint',
     name: 'Blueprint',

package/src/locales/de.json

@@ -155,6 +155,7 @@
   "cite.copyEveryAs": "Alle Literaturangaben kopieren als",
   "cite.importIntoManager": "In ein Literaturverwaltungsprogramm importieren",
   "cite.openArticle": "Den Artikel öffnen",
+  "cite.openDataset": "Den Datensatz öffnen",
   "cite.copyThisAs": "Diese Literaturangabe kopieren als",
   "cite.importThis": "Diese Literaturangabe importieren",
   "cite.copied": "kopiert",

package/src/locales/en.json

@@ -155,6 +155,7 @@
   "cite.copyEveryAs": "Copy every reference as",
   "cite.importIntoManager": "Import into a reference manager",
   "cite.openArticle": "Open the article",
+  "cite.openDataset": "Open the dataset",
   "cite.copyThisAs": "Copy this reference as",
   "cite.importThis": "Import this reference",
   "cite.copied": "copied",

package/src/locales/es.json

@@ -155,6 +155,7 @@
   "cite.copyEveryAs": "Copiar todas las referencias como",
   "cite.importIntoManager": "Importar a un gestor de referencias",
   "cite.openArticle": "Abrir el artículo",
+  "cite.openDataset": "Abrir el conjunto de datos",
   "cite.copyThisAs": "Copiar esta referencia como",
   "cite.importThis": "Importar esta referencia",
   "cite.copied": "copiado",

package/src/locales/fr.json

@@ -155,6 +155,7 @@
   "cite.copyEveryAs": "Copier toutes les références en",
   "cite.importIntoManager": "Importer dans un gestionnaire de références",
   "cite.openArticle": "Ouvrir l'article",
+  "cite.openDataset": "Ouvrir le jeu de données",
   "cite.copyThisAs": "Copier cette référence en",
   "cite.importThis": "Importer cette référence",
   "cite.copied": "copié",

package/src/locales/it.json

@@ -155,6 +155,7 @@
   "cite.copyEveryAs": "Copia tutti i riferimenti come",
   "cite.importIntoManager": "Importa in un gestore di riferimenti",
   "cite.openArticle": "Apri l'articolo",
+  "cite.openDataset": "Apri il set di dati",
   "cite.copyThisAs": "Copia questo riferimento come",
   "cite.importThis": "Importa questo riferimento",
   "cite.copied": "copiato",