@seqera/docusaurus-theme-seqera 1.0.0 → 1.0.1-next.9

package/lib/theme/Admonition/Type/Warning.js

@@ -0,0 +1,26 @@
+import React from 'react';
+import clsx from 'clsx';
+import Translate from '@docusaurus/Translate';
+import AdmonitionLayout from '@theme/Admonition/Layout';
+import IconWarning from '@theme/Admonition/Icon/Warning';
+const infimaClassName = 'alert alert--warning';
+const defaultProps = {
+  icon: <IconWarning />,
+  title: (
+    <Translate
+      id="theme.admonition.warning"
+      description="The default label used for the Warning admonition (:::warning)">
+      warning
+    </Translate>
+  ),
+};
+export default function AdmonitionTypeWarning(props) {
+  return (
+    <AdmonitionLayout
+      {...defaultProps}
+      {...props}
+      className={clsx(infimaClassName, props.className)}>
+      {props.children}
+    </AdmonitionLayout>
+  );
+}

package/lib/theme/Admonition/Types.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+declare const _default: {
+    [x: string]: React.ComponentType<import("@theme/Admonition").Props>;
+};
+export default _default;

package/lib/theme/Admonition/Types.js

@@ -0,0 +1,27 @@
+import React from 'react';
+import AdmonitionTypeNote from '@theme/Admonition/Type/Note';
+import AdmonitionTypeTip from '@theme/Admonition/Type/Tip';
+import AdmonitionTypeInfo from '@theme/Admonition/Type/Info';
+import AdmonitionTypeWarning from '@theme/Admonition/Type/Warning';
+import AdmonitionTypeDanger from '@theme/Admonition/Type/Danger';
+import AdmonitionTypeCaution from '@theme/Admonition/Type/Caution';
+const admonitionTypes = {
+  note: AdmonitionTypeNote,
+  tip: AdmonitionTypeTip,
+  info: AdmonitionTypeInfo,
+  warning: AdmonitionTypeWarning,
+  danger: AdmonitionTypeDanger,
+};
+// Undocumented legacy admonition type aliases
+// Provide hardcoded/untranslated retrocompatible label
+// See also https://github.com/facebook/docusaurus/issues/7767
+const admonitionAliases = {
+  secondary: (props) => <AdmonitionTypeNote title="secondary" {...props} />,
+  important: (props) => <AdmonitionTypeInfo title="important" {...props} />,
+  success: (props) => <AdmonitionTypeTip title="success" {...props} />,
+  caution: AdmonitionTypeCaution,
+};
+export default {
+  ...admonitionTypes,
+  ...admonitionAliases,
+};

package/lib/theme/Admonition/index.d.ts

@@ -0,0 +1,3 @@
+import { type ReactNode } from 'react';
+import type { Props } from '@theme/Admonition';
+export default function Admonition(unprocessedProps: Props): ReactNode;

package/lib/theme/Admonition/index.js

@@ -0,0 +1,18 @@
+import React from 'react';
+import {processAdmonitionProps} from '@docusaurus/theme-common';
+import AdmonitionTypes from '@theme/Admonition/Types';
+function getAdmonitionTypeComponent(type) {
+  const component = AdmonitionTypes[type];
+  if (component) {
+    return component;
+  }
+  console.warn(
+    `No admonition component found for admonition type "${type}". Using Info as fallback.`,
+  );
+  return AdmonitionTypes.info;
+}
+export default function Admonition(unprocessedProps) {
+  const props = processAdmonitionProps(unprocessedProps);
+  const AdmonitionTypeComponent = getAdmonitionTypeComponent(props.type);
+  return <AdmonitionTypeComponent {...props} />;
+}

package/lib/theme/AdmonitionVersioned/AddedInVersion.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+interface Props {
+    tool?: "nextflow";
+    version?: string;
+    children: React.ReactNode;
+}
+declare const AddedInVersion: React.FC<Props>;
+export default AddedInVersion;

package/lib/theme/AdmonitionVersioned/AddedInVersion.js

@@ -0,0 +1,6 @@
+import React from 'react';
+import AdmonitionVersioned from './AdmonitionVersioned';
+const AddedInVersion = (props) => (
+  <AdmonitionVersioned type="added" {...props} />
+);
+export default AddedInVersion;

package/lib/theme/AdmonitionVersioned/AdmonitionVersioned.d.ts

@@ -0,0 +1,18 @@
+import React, { ReactNode } from "react";
+type AdmonitionVersionedType = "added" | "changed" | "deprecated";
+interface AdmonitionVersionedProps {
+    type: AdmonitionVersionedType;
+    tool?: "nextflow";
+    version?: string;
+    children: ReactNode;
+}
+declare const AdmonitionVersioned: React.FC<AdmonitionVersionedProps>;
+interface Props {
+    tool?: "nextflow";
+    version?: string;
+    children: React.ReactNode;
+}
+export declare const AddedInVersion: React.FC<Props>;
+export declare const ChangedInVersion: React.FC<Props>;
+export declare const DeprecatedInVersion: React.FC<Props>;
+export default AdmonitionVersioned;

package/lib/theme/AdmonitionVersioned/AdmonitionVersioned.js

@@ -0,0 +1,43 @@
+import React from 'react';
+import Admonition from '@theme/Admonition';
+import {getDisplayVersion} from './getStableVersion';
+const typeConfig = {
+  added: {
+    admonitionType: 'info',
+    prefix: 'Added in version',
+  },
+  changed: {
+    admonitionType: 'warning',
+    prefix: 'Changed in version',
+  },
+  deprecated: {
+    admonitionType: 'danger',
+    prefix: 'Deprecated in version',
+  },
+};
+const AdmonitionVersioned = ({
+  type,
+  tool = 'nextflow',
+  version,
+  children,
+  ...props
+}) => {
+  const config = typeConfig[type];
+  const displayVersion = getDisplayVersion(tool, version);
+  const displayTitle = `${config.prefix} ${displayVersion}`;
+  return (
+    <Admonition type={config.admonitionType} title={displayTitle} {...props}>
+      {children}
+    </Admonition>
+  );
+};
+export const AddedInVersion = (props) => (
+  <AdmonitionVersioned type="added" {...props} />
+);
+export const ChangedInVersion = (props) => (
+  <AdmonitionVersioned type="changed" {...props} />
+);
+export const DeprecatedInVersion = (props) => (
+  <AdmonitionVersioned type="deprecated" {...props} />
+);
+export default AdmonitionVersioned;

package/lib/theme/AdmonitionVersioned/ChangedInVersion.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+interface Props {
+    tool?: "nextflow";
+    version?: string;
+    children: React.ReactNode;
+}
+declare const ChangedInVersion: React.FC<Props>;
+export default ChangedInVersion;

package/lib/theme/AdmonitionVersioned/ChangedInVersion.js

@@ -0,0 +1,6 @@
+import React from 'react';
+import AdmonitionVersioned from './AdmonitionVersioned';
+const ChangedInVersion = (props) => (
+  <AdmonitionVersioned type="changed" {...props} />
+);
+export default ChangedInVersion;

package/lib/theme/AdmonitionVersioned/DeprecatedInVersion.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+interface Props {
+    tool?: "nextflow";
+    version?: string;
+    children: React.ReactNode;
+}
+declare const DeprecatedInVersion: React.FC<Props>;
+export default DeprecatedInVersion;

package/lib/theme/AdmonitionVersioned/DeprecatedInVersion.js

@@ -0,0 +1,6 @@
+import React from 'react';
+import AdmonitionVersioned from './AdmonitionVersioned';
+const DeprecatedInVersion = (props) => (
+  <AdmonitionVersioned type="deprecated" {...props} />
+);
+export default DeprecatedInVersion;

package/lib/theme/AdmonitionVersioned/getStableVersion.d.ts

@@ -0,0 +1,4 @@
+import { stableVersions } from './stableVersions';
+type Tool = keyof typeof stableVersions;
+export declare function getDisplayVersion(tool: Tool, version?: string): string;
+export {};

package/lib/theme/AdmonitionVersioned/getStableVersion.js

@@ -0,0 +1,20 @@
+import {stableVersions} from './stableVersions';
+export function getDisplayVersion(tool, version) {
+  const toolRules = stableVersions[tool];
+  if (!toolRules || toolRules.length === 0) {
+    return version || 'unknown';
+  }
+  // If version provided, find the first rule that matches the version in replaces
+  if (version) {
+    for (const rule of toolRules) {
+      if (rule.replaces.includes(version)) {
+        return rule.stable;
+      }
+    }
+    // If no match found, return the original version
+    return version;
+  }
+  // If no version provided, return the latest stable (first in the array)
+  // Assuming the array is ordered with newest first
+  return toolRules[0].stable;
+}

package/lib/theme/AdmonitionVersioned/index.d.ts

@@ -0,0 +1 @@
+export { AddedInVersion, ChangedInVersion, DeprecatedInVersion } from './AdmonitionVersioned';

package/lib/theme/AdmonitionVersioned/index.js

@@ -0,0 +1,5 @@
+export {
+  AddedInVersion,
+  ChangedInVersion,
+  DeprecatedInVersion,
+} from './AdmonitionVersioned';

package/lib/theme/AdmonitionVersioned/stableVersions.d.ts

@@ -0,0 +1,20 @@
+export interface VersionMapping {
+    stable: string;
+    replaces: string[];
+}
+export interface StableVersions {
+    nextflow: VersionMapping[];
+}
+export declare const stableVersions: StableVersions;
+/**
+ * Get the display version, mapping edge versions to their stable equivalents
+ */
+export declare function getDisplayVersion(tool: keyof StableVersions, version?: string): string;
+/**
+ * Check if a version is an edge version
+ */
+export declare function isEdgeVersion(tool: keyof StableVersions, version?: string): boolean;
+/**
+ * Get the stable version for an edge version
+ */
+export declare function getStableVersion(tool: keyof StableVersions, version?: string): string | null;

package/lib/theme/AdmonitionVersioned/stableVersions.js

@@ -0,0 +1,91 @@
+export const stableVersions = {
+  nextflow: [
+    {
+      stable: '24.10.0',
+      replaces: [
+        '24.05.0-edge',
+        '24.06.0-edge',
+        '24.07.0-edge',
+        '24.08.0-edge',
+        '24.09.0-edge',
+      ],
+    },
+    {
+      stable: '24.04.0',
+      replaces: [
+        '23.11.0-edge',
+        '23.12.0-edge',
+        '24.01.0-edge',
+        '24.02.0-edge',
+        '24.03.0-edge',
+      ],
+    },
+    {
+      stable: '23.10.0',
+      replaces: [
+        '23.05.0-edge',
+        '23.06.0-edge',
+        '23.07.0-edge',
+        '23.08.0-edge',
+        '23.09.0-edge',
+      ],
+    },
+    {
+      stable: '23.04.0',
+      replaces: [
+        '22.11.0-edge',
+        '22.12.0-edge',
+        '23.01.0-edge',
+        '23.02.0-edge',
+        '23.03.0-edge',
+      ],
+    },
+  ],
+};
+/**
+ * Get the display version, mapping edge versions to their stable equivalents
+ */
+export function getDisplayVersion(tool, version) {
+  if (!version) {
+    return 'latest';
+  }
+  // Check if this is an edge version that should be replaced
+  const toolMappings = stableVersions[tool];
+  for (const mapping of toolMappings) {
+    if (mapping.replaces.includes(version)) {
+      return `${mapping.stable} (stable)`;
+    }
+  }
+  // If version ends with -edge, show it as edge
+  if (version.endsWith('-edge')) {
+    return `${version} (edge)`;
+  }
+  // Otherwise, return as stable
+  return `${version} (stable)`;
+}
+/**
+ * Check if a version is an edge version
+ */
+export function isEdgeVersion(tool, version) {
+  if (!version) return false;
+  const toolMappings = stableVersions[tool];
+  for (const mapping of toolMappings) {
+    if (mapping.replaces.includes(version)) {
+      return true;
+    }
+  }
+  return version.endsWith('-edge');
+}
+/**
+ * Get the stable version for an edge version
+ */
+export function getStableVersion(tool, version) {
+  if (!version) return null;
+  const toolMappings = stableVersions[tool];
+  for (const mapping of toolMappings) {
+    if (mapping.replaces.includes(version)) {
+      return mapping.stable;
+    }
+  }
+  return null;
+}

package/lib/theme/AnnouncementBar/CloseButton/index.d.ts

@@ -0,0 +1,3 @@
+import { type ReactNode } from 'react';
+import type { Props } from '@theme/AnnouncementBar/CloseButton';
+export default function AnnouncementBarCloseButton(props: Props): ReactNode;

package/lib/theme/AnnouncementBar/CloseButton/index.js

@@ -0,0 +1,20 @@
+import React from 'react';
+import clsx from 'clsx';
+import {translate} from '@docusaurus/Translate';
+import IconClose from '@theme/Icon/Close';
+import styles from './styles.module.css';
+export default function AnnouncementBarCloseButton(props) {
+  return (
+    <button
+      type="button"
+      aria-label={translate({
+        id: 'theme.AnnouncementBar.closeButtonAriaLabel',
+        message: 'Close',
+        description: 'The ARIA label for close button of announcement bar',
+      })}
+      {...props}
+      className={clsx('clean-btn close', styles.closeButton, props.className)}>
+      <IconClose width={14} height={14} strokeWidth={3.1} />
+    </button>
+  );
+}

package/lib/theme/AnnouncementBar/CloseButton/styles.module.css

@@ -0,0 +1,6 @@
+
+
+.closeButton {
+  padding: 0;
+  line-height: 0;
+}

package/lib/theme/AnnouncementBar/Content/index.d.ts

@@ -0,0 +1,3 @@
+import { type ReactNode } from 'react';
+import type { Props } from '@theme/AnnouncementBar/Content';
+export default function AnnouncementBarContent(props: Props): ReactNode;

package/lib/theme/AnnouncementBar/Content/index.js

@@ -0,0 +1,17 @@
+import React from 'react';
+import clsx from 'clsx';
+import {useThemeConfig} from '@docusaurus/theme-common';
+import styles from './styles.module.css';
+export default function AnnouncementBarContent(props) {
+  const {announcementBar} = useThemeConfig();
+  const {content} = announcementBar;
+  return (
+    <div
+      {...props}
+      className={clsx(styles.content, props.className)}
+      // Developer provided the HTML, so assume it's safe.
+      // eslint-disable-next-line react/no-danger
+      dangerouslySetInnerHTML={{__html: content}}
+    />
+  );
+}

package/lib/theme/AnnouncementBar/Content/styles.module.css

@@ -0,0 +1,12 @@
+
+
+.content {
+  font-size: 85%;
+  text-align: center;
+  padding: 5px 0;
+}
+
+.content a {
+  color: inherit;
+  text-decoration: underline;
+}

package/lib/theme/AnnouncementBar/index.d.ts

@@ -0,0 +1,2 @@
+import { type ReactNode } from 'react';
+export default function AnnouncementBar(): ReactNode;

package/lib/theme/AnnouncementBar/index.js

@@ -0,0 +1,33 @@
+import React from 'react';
+import clsx from 'clsx';
+import {ThemeClassNames, useThemeConfig} from '@docusaurus/theme-common';
+import {useAnnouncementBar} from '@docusaurus/theme-common/internal';
+import AnnouncementBarCloseButton from '@theme/AnnouncementBar/CloseButton';
+import AnnouncementBarContent from '@theme/AnnouncementBar/Content';
+import styles from './styles.module.css';
+export default function AnnouncementBar() {
+  const {announcementBar} = useThemeConfig();
+  const {isActive, close} = useAnnouncementBar();
+  if (!isActive) {
+    return null;
+  }
+  const {backgroundColor, textColor, isCloseable} = announcementBar;
+  return (
+    <div
+      className={clsx(
+        ThemeClassNames.announcementBar.container,
+        styles.announcementBar,
+      )}
+      style={{backgroundColor, color: textColor}}
+      role="banner">
+      {isCloseable && <div className={styles.announcementBarPlaceholder} />}
+      <AnnouncementBarContent className={styles.announcementBarContent} />
+      {isCloseable && (
+        <AnnouncementBarCloseButton
+          onClick={close}
+          className={styles.announcementBarClose}
+        />
+      )}
+    </div>
+  );
+}

package/lib/theme/AnnouncementBar/styles.module.css

@@ -0,0 +1,57 @@
+
+
+:root {
+  --docusaurus-announcement-bar-height: auto;
+}
+
+.announcementBar {
+  display: flex;
+  align-items: center;
+  height: var(--docusaurus-announcement-bar-height);
+  background-color: var(--ifm-color-white);
+  color: var(--ifm-color-black);
+
+  /*
+  Unfortunately we can't make announcement bar render above the navbar
+  IE need to use border-bottom instead of shadow
+  See https://github.com/facebookincubator/infima/issues/275
+
+  box-shadow: var(--ifm-global-shadow-lw);
+  z-index: calc(var(--ifm-z-index-fixed) + 1);
+  */
+  border-bottom: 1px solid var(--ifm-color-emphasis-100);
+}
+
+html[data-announcement-bar-initially-dismissed='true'] .announcementBar {
+  display: none;
+}
+
+.announcementBarPlaceholder {
+  flex: 0 0 10px;
+}
+
+.announcementBarClose {
+  flex: 0 0 30px;
+  align-self: stretch;
+}
+
+.announcementBarContent {
+  flex: 1 1 auto;
+}
+
+@media print {
+  .announcementBar {
+    display: none;
+  }
+}
+
+@media (min-width: 997px) {
+  :root {
+    --docusaurus-announcement-bar-height: 30px;
+  }
+
+  .announcementBarPlaceholder,
+  .announcementBarClose {
+    flex-basis: 50px;
+  }
+}

package/lib/theme/BackToTopButton/index.d.ts

@@ -0,0 +1,2 @@
+import { type ReactNode } from 'react';
+export default function BackToTopButton(): ReactNode;

package/lib/theme/BackToTopButton/index.js

@@ -0,0 +1,26 @@
+import React from 'react';
+import clsx from 'clsx';
+import {translate} from '@docusaurus/Translate';
+import {ThemeClassNames} from '@docusaurus/theme-common';
+import {useBackToTopButton} from '@docusaurus/theme-common/internal';
+import styles from './styles.module.css';
+export default function BackToTopButton() {
+  const {shown, scrollToTop} = useBackToTopButton({threshold: 300});
+  return (
+    <button
+      aria-label={translate({
+        id: 'theme.BackToTopButton.buttonAriaLabel',
+        message: 'Scroll back to top',
+        description: 'The ARIA label for the back to top button',
+      })}
+      className={clsx(
+        'clean-btn',
+        ThemeClassNames.common.backToTopButton,
+        styles.backToTopButton,
+        shown && styles.backToTopButtonShow,
+      )}
+      type="button"
+      onClick={scrollToTop}
+    />
+  );
+}

package/lib/theme/BackToTopButton/styles.module.css

@@ -0,0 +1,39 @@
+
+
+.backToTopButton {
+  position: fixed;
+  right: 1.3rem;
+  bottom: 1.3rem;
+  border-radius: 50%;
+  background-color: var(--ifm-color-emphasis-200);
+  width: 3rem;
+  height: 3rem;
+  z-index: calc(var(--ifm-z-index-fixed) - 1);
+  box-shadow: var(--ifm-global-shadow-lw);
+  transition: all var(--ifm-transition-fast)
+    var(--ifm-transition-timing-default);
+  opacity: 0;
+  transform: scale(0);
+  visibility: hidden;
+}
+
+.backToTopButton::after {
+  content: ' ';
+  display: inline-block;
+  mask: var(--ifm-menu-link-sublist-icon) 50% / 2rem 2rem no-repeat;
+  background-color: var(--ifm-color-emphasis-1000);
+  width: 100%;
+  height: 100%;
+}
+
+@media (hover: hover) {
+  .backToTopButton:hover {
+    background-color: var(--ifm-color-emphasis-300);
+  }
+}
+
+.backToTopButtonShow {
+  opacity: 1;
+  transform: scale(1);
+  visibility: visible;
+}

package/lib/theme/Blog/Components/Author/Socials/index.d.ts

@@ -0,0 +1,5 @@
+import type { ReactNode } from 'react';
+import type { Props } from '@theme/Blog/Components/Author/Socials';
+export default function BlogAuthorSocials({ author, }: {
+    author: Props['author'];
+}): ReactNode;

package/lib/theme/Blog/Components/Author/Socials/index.js

@@ -0,0 +1,57 @@
+import React from 'react';
+import clsx from 'clsx';
+import Link from '@docusaurus/Link';
+import Twitter from '@theme/Icon/Socials/Twitter';
+import GitHub from '@theme/Icon/Socials/GitHub';
+import X from '@theme/Icon/Socials/X';
+import StackOverflow from '@theme/Icon/Socials/StackOverflow';
+import LinkedIn from '@theme/Icon/Socials/LinkedIn';
+import DefaultSocialIcon from '@theme/Icon/Socials/Default';
+import Bluesky from '@theme/Icon/Socials/Bluesky';
+import Instagram from '@theme/Icon/Socials/Instagram';
+import Threads from '@theme/Icon/Socials/Threads';
+import Youtube from '@theme/Icon/Socials/YouTube';
+import Mastodon from '@theme/Icon/Socials/Mastodon';
+import Twitch from '@theme/Icon/Socials/Twitch';
+import Email from '@theme/Icon/Socials/Email';
+import styles from './styles.module.css';
+const SocialPlatformConfigs = {
+  twitter: {Icon: Twitter, label: 'Twitter'},
+  github: {Icon: GitHub, label: 'GitHub'},
+  stackoverflow: {Icon: StackOverflow, label: 'Stack Overflow'},
+  linkedin: {Icon: LinkedIn, label: 'LinkedIn'},
+  x: {Icon: X, label: 'X'},
+  bluesky: {Icon: Bluesky, label: 'Bluesky'},
+  instagram: {Icon: Instagram, label: 'Instagram'},
+  threads: {Icon: Threads, label: 'Threads'},
+  mastodon: {Icon: Mastodon, label: 'Mastodon'},
+  youtube: {Icon: Youtube, label: 'YouTube'},
+  twitch: {Icon: Twitch, label: 'Twitch'},
+  email: {Icon: Email, label: 'Email'},
+};
+function getSocialPlatformConfig(platformKey) {
+  return (
+    SocialPlatformConfigs[platformKey] ?? {
+      Icon: DefaultSocialIcon,
+      label: platformKey,
+    }
+  );
+}
+function SocialLink({platform, link}) {
+  const {Icon, label} = getSocialPlatformConfig(platform);
+  return (
+    <Link className={styles.authorSocialLink} href={link} title={label}>
+      <Icon className={clsx(styles.authorSocialIcon)} />
+    </Link>
+  );
+}
+export default function BlogAuthorSocials({author}) {
+  const entries = Object.entries(author.socials ?? {});
+  return (
+    <div className={styles.authorSocials}>
+      {entries.map(([platform, linkUrl]) => {
+        return <SocialLink key={platform} platform={platform} link={linkUrl} />;
+      })}
+    </div>
+  );
+}