[Share] Copy DOIs to clipboard (flexible output)

[jcblum]

Description

Copy DOIs from one or more selected library items to the clipboard, with configurable settings to provide flexibility. Inspired by #397 🙏 .

• Scans only regular library items (skips any selected notes, attachments, or annotations)
• Returns only unique DOIs from the selected items (case-insensitive)
• Returns a popup message showing how many unique DOIs were copied, how many items were scanned, and how many selected items were skipped because they don’t have a DOI field

The script includes configurable options for:

• DOI output format (bare contents of DOI field vs. prepending https://doi.org/)
• List formatting, with the option to have a different final-item separator
• Including a preview of the returned DOIs in the popup message (preview length also configurable)

Event

None

Operation

Script

Data

// @author jcblum 
// @link https://github.com/windingwind/zotero-actions-tags/discussions/624
// @usage Select item(s) in the library and press the assigned shortcut keys or select the configured menu item.

// Only execute once for all selected items
if (item) return;

// EDIT THESE SETTINGS

// How each DOI should be copied:
// - "bare": Whatever is in the DOI field. E.g., 10.1234/abcd 
// - "link": Prepends `https://doi.org/` to the DOI value. 
//           E.g., 10.1234/abcd becomes https://doi.org/10.1234/abcd
const DOI_OUTPUT_FORMAT = "bare";

// List formatting for copied output.
//
// Common formats:
// - One DOI per line: ITEM_SEPARATOR = "\n"; LAST_ITEM_SEPARATOR = "\n"
// - Comma-separated list: ITEM_SEPARATOR = ","; LAST_ITEM_SEPARATOR = ","
// - Natural language list: ITEM_SEPARATOR = ", "; LAST_ITEM_SEPARATOR = " and "
const ITEM_SEPARATOR = "\n";
const LAST_ITEM_SEPARATOR = "\n";

// If true, append a short inline DOI preview to the action popup message.
const SHOW_PREVIEW = false;

// Number of DOI values to show when SHOW_PREVIEW is enabled.
const PREVIEW_LIMIT = 3;

// ========================================================================== //
// Helpers
// ========================================================================== //

// Normalize DOI values before deduplication (DOIs are case-insensitive).
function normalizeDOI(value) {
    return (value || "").trim().toLowerCase();
}

// Collect unique DOI values from selected items and the count of scannable items.
// - Only pull DOIs from library items (not notes, attachments, or annotations).
// - Empty DOI fields are ignored.
// - Order is preserved by first appearance.
function collectDOIs(selectedItems) {
    const uniqueDois = new Set();
    let scannedCount = 0;

    for (const selectedItem of selectedItems || []) {
        if (!selectedItem?.isRegularItem?.()) continue;
        scannedCount++;

        const doi = normalizeDOI(selectedItem.getField("DOI"));
        if (!doi) continue;

        uniqueDois.add(doi);
    }

    return { dois: [...uniqueDois], scannedCount };
}

function copyTextToClipboard(text) {
    const clipboard = new Zotero.ActionsTags.api.utils.ClipboardHelper();
    clipboard.addText(text, "text/unicode");
    clipboard.copy();
}

function formatDOIForOutput(doi) {
    if (DOI_OUTPUT_FORMAT === "link") {
        return `https://doi.org/${doi}`;
    }
    return doi;
}

function formatOutputList(values) {
    if (!values.length) return "";
    if (values.length === 1) return values[0];

    return values
        .slice(0, -1)
        .join(ITEM_SEPARATOR) +
        LAST_ITEM_SEPARATOR +
        values[values.length - 1];
}

function formatResultMessage(outputDois, scannedCount, totalCount) {
    const doiPart = `${outputDois.length} unique DOI${outputDois.length === 1 ? "" : "s"}`;
    const itemPart = `${scannedCount} item${scannedCount === 1 ? "" : "s"}`;
    const skipped = totalCount - scannedCount;
    const mixedPart = skipped > 0
        ? ` (skipped ${skipped} item${skipped === 1 ? "" : "s"} without ${skipped === 1 ? "a DOI field" : "DOI fields"})`
        : "";
    const summary = `Copied ${doiPart} from ${itemPart}${mixedPart}`;

    if (!SHOW_PREVIEW) return summary;

    // The popup collapses newlines, so format preview list for inline display.
    const previewDois = outputDois.slice(0, PREVIEW_LIMIT);
    const remaining = outputDois.length - previewDois.length;
    const preview = remaining > 0
        ? `${previewDois.join(", ")}, and ${remaining} more`
        : previewDois.join(", ");
    return `${summary}: ${preview}`;
}

// ========================================================================== //
// Main invocation
// ========================================================================== //

// Build and copy DOI output for the current selection.
function copySelectedDois(selectedItems) {
    if (!selectedItems || !selectedItems.length) return "No selected items";

    const totalCount = selectedItems.length;
    const { dois, scannedCount } = collectDOIs(selectedItems);
    if (!dois.length) return "No DOI found in selected items";

    const outputDois = dois.map(formatDOIForOutput);
    const clipboardText = formatOutputList(outputDois);
    copyTextToClipboard(clipboardText);
    return formatResultMessage(outputDois, scannedCount, totalCount);
}

try {
    return copySelectedDois(items);
} catch (err) {
    return `[Copy DOIs] ${err}`;
}

Anything else

No response