podcast-dl 10.4.0 → 11.0.0

package/bin/util.js

@@ -1,17 +1,11 @@
-import rssParser from "rss-parser";
-import path from "path";
 import fs from "fs";
-import dayjs from "dayjs";
-import util from "util";
-import { exec } from "child_process";
-
-import { logErrorAndExit, logMessage, LOG_LEVELS } from "./logger.js";
-import { getArchiveFilename, getItemFilename } from "./naming.js";
+import path from "path";
+import rssParser from "rss-parser";
+import { logErrorAndExit, logMessage } from "./logger.js";
 
-const execWithPromise = util.promisify(exec);
 const isWin = process.platform === "win32";
 
-const defaultRssParserConfig = {
+export const defaultRssParserConfig = {
   defaultRSS: 2.0,
   headers: {
     Accept: "*/*",
@@ -27,12 +21,12 @@ const defaultRssParserConfig = {
   Additionally, @see https://www.robvanderwoude.com/escapechars.php for why
     we avoid trying to escape complex sequences in Windows.
 */
-const escapeArgForShell = (arg) => {
+export const escapeArgForShell = (arg) => {
   let result = arg;
 
   if (/[^A-Za-z0-9_/:=-]/.test(result)) {
     if (isWin) {
-      return null;
+      return `"${result}"`;
     } else {
       result = "'" + result.replace(/'/g, "'\\''") + "'";
       result = result
@@ -44,11 +38,11 @@ const escapeArgForShell = (arg) => {
   return result;
 };
 
-const getTempPath = (path) => {
+export const getTempPath = (path) => {
   return `${path}.tmp`;
 };
 
-const prepareOutputPath = (outputPath) => {
+export const prepareOutputPath = (outputPath) => {
   const outputPathSegments = outputPath.split(path.sep);
   outputPathSegments.pop();
 
@@ -59,11 +53,7 @@ const prepareOutputPath = (outputPath) => {
   }
 };
 
-const getArchiveKey = ({ prefix, name }) => {
-  return `${prefix}-${name}`;
-};
-
-const getPublicObject = (object, exclude = []) => {
+export const getPublicObject = (object, exclude = []) => {
   const output = {};
   Object.keys(object).forEach((key) => {
     if (!key.startsWith("_") && !exclude.includes(key) && object[key]) {
@@ -74,7 +64,7 @@ const getPublicObject = (object, exclude = []) => {
   return output;
 };
 
-const getFileString = (filePath) => {
+export const getFileString = (filePath) => {
   const fullPath = path.resolve(process.cwd(), filePath);
 
   if (!fs.existsSync(fullPath)) {
@@ -90,7 +80,7 @@ const getFileString = (filePath) => {
   return data;
 };
 
-const getJsonFile = (filePath) => {
+export const getJsonFile = (filePath) => {
   const fullPath = path.resolve(process.cwd(), filePath);
 
   if (!fs.existsSync(fullPath)) {
@@ -106,28 +96,7 @@ const getJsonFile = (filePath) => {
   return JSON.parse(data);
 };
 
-const getArchive = (archive) => {
-  const archiveContent = getJsonFile(archive);
-  return archiveContent === null ? [] : archiveContent;
-};
-
-const writeToArchive = ({ key, archive }) => {
-  const archivePath = path.resolve(process.cwd(), archive);
-  const archiveResult = getArchive(archive);
-
-  if (!archiveResult.includes(key)) {
-    archiveResult.push(key);
-  }
-
-  fs.writeFileSync(archivePath, JSON.stringify(archiveResult, null, 4));
-};
-
-const getIsInArchive = ({ key, archive }) => {
-  const archiveResult = getArchive(archive);
-  return archiveResult.includes(key);
-};
-
-const getLoopControls = ({ offset, length, reverse }) => {
+export const getLoopControls = ({ offset, length, reverse }) => {
   if (reverse) {
     const startIndex = length - 1 - offset;
     const min = -1;
@@ -153,299 +122,13 @@ const getLoopControls = ({ offset, length, reverse }) => {
   };
 };
 
-const getItemsToDownload = ({
-  archive,
-  archivePrefix,
-  basePath,
-  feed,
-  limit,
-  offset,
-  reverse,
-  before,
-  after,
-  episodeDigits,
-  episodeNumOffset,
-  episodeRegex,
-  episodeRegexExclude,
-  episodeSourceOrder,
-  episodeTemplate,
-  episodeCustomTemplateOptions,
-  includeEpisodeImages,
-  includeEpisodeTranscripts,
-  episodeTranscriptTypes,
-}) => {
-  const { startIndex, shouldGo, next } = getLoopControls({
-    offset,
-    reverse,
-    length: feed.items.length,
-  });
-
-  let i = startIndex;
-  const items = [];
-
-  const savedArchive = archive ? getArchive(archive) : [];
-
-  while (shouldGo(i)) {
-    const { title, pubDate } = feed.items[i];
-    const pubDateDay = dayjs(new Date(pubDate));
-    let isValid = true;
-
-    if (episodeRegex) {
-      const generatedEpisodeRegex = new RegExp(episodeRegex);
-      if (title && !generatedEpisodeRegex.test(title)) {
-        isValid = false;
-      }
-    }
-
-    if (episodeRegexExclude) {
-      const generatedEpisodeRegexExclude = new RegExp(episodeRegexExclude);
-      if (title && generatedEpisodeRegexExclude.test(title)) {
-        isValid = false;
-      }
-    }
-
-    if (before) {
-      const beforeDateDay = dayjs(new Date(before));
-      if (
-        !pubDateDay.isSame(beforeDateDay, "day") &&
-        !pubDateDay.isBefore(beforeDateDay, "day")
-      ) {
-        isValid = false;
-      }
-    }
-
-    if (after) {
-      const afterDateDay = dayjs(new Date(after));
-      if (
-        !pubDateDay.isSame(afterDateDay, "day") &&
-        !pubDateDay.isAfter(afterDateDay, "day")
-      ) {
-        isValid = false;
-      }
-    }
-
-    const { url: episodeAudioUrl, ext: audioFileExt } =
-      getEpisodeAudioUrlAndExt(feed.items[i], episodeSourceOrder);
-    const key = getArchiveKey({
-      prefix: archivePrefix,
-      name: getArchiveFilename({
-        pubDate,
-        name: title,
-        ext: audioFileExt,
-      }),
-    });
-
-    if (key && savedArchive.includes(key)) {
-      isValid = false;
-    }
-
-    if (isValid) {
-      const item = feed.items[i];
-      item._originalIndex = i;
-      item._extra_downloads = [];
-
-      if (includeEpisodeImages) {
-        const episodeImageUrl = getImageUrl(item);
-
-        if (episodeImageUrl) {
-          const episodeImageFileExt = getUrlExt(episodeImageUrl);
-          const episodeImageArchiveKey = getArchiveKey({
-            prefix: archivePrefix,
-            name: getArchiveFilename({
-              pubDate,
-              name: title,
-              ext: episodeImageFileExt,
-            }),
-          });
-
-          const episodeImageName = getItemFilename({
-            item,
-            feed,
-            url: episodeAudioUrl,
-            ext: episodeImageFileExt,
-            template: episodeTemplate,
-            customTemplateOptions: episodeCustomTemplateOptions,
-            width: episodeDigits,
-            offset: episodeNumOffset,
-          });
-
-          const outputImagePath = path.resolve(basePath, episodeImageName);
-          item._extra_downloads.push({
-            url: episodeImageUrl,
-            outputPath: outputImagePath,
-            key: episodeImageArchiveKey,
-          });
-        }
-      }
-
-      if (includeEpisodeTranscripts) {
-        const episodeTranscriptUrl = getTranscriptUrl(
-          item,
-          episodeTranscriptTypes
-        );
-
-        if (episodeTranscriptUrl) {
-          const episodeTranscriptFileExt = getUrlExt(episodeTranscriptUrl);
-          const episodeTranscriptArchiveKey = getArchiveKey({
-            prefix: archivePrefix,
-            name: getArchiveFilename({
-              pubDate,
-              name: title,
-              ext: episodeTranscriptFileExt,
-            }),
-          });
-
-          const episodeTranscriptName = getItemFilename({
-            item,
-            feed,
-            url: episodeAudioUrl,
-            ext: episodeTranscriptFileExt,
-            template: episodeTemplate,
-            width: episodeDigits,
-            offset: episodeNumOffset,
-          });
-
-          const outputTranscriptPath = path.resolve(
-            basePath,
-            episodeTranscriptName
-          );
-
-          item._extra_downloads.push({
-            url: episodeTranscriptUrl,
-            outputPath: outputTranscriptPath,
-            key: episodeTranscriptArchiveKey,
-          });
-        }
-      }
-
-      items.push(item);
-    }
-
-    i = next(i);
-  }
-
-  return limit ? items.slice(0, limit) : items;
-};
-
-const logFeedInfo = (feed) => {
+export const logFeedInfo = (feed) => {
   logMessage(feed.title);
   logMessage(feed.description);
   logMessage();
 };
 
-const ITEM_LIST_FORMATS = ["table", "json"];
-
-const logItemsList = ({
-  type,
-  feed,
-  limit,
-  offset,
-  reverse,
-  before,
-  after,
-  episodeRegex,
-  episodeRegexExclude,
-}) => {
-  const items = getItemsToDownload({
-    feed,
-    limit,
-    offset,
-    reverse,
-    before,
-    after,
-    episodeRegex,
-    episodeRegexExclude,
-  });
-
-  if (!items.length) {
-    logErrorAndExit("No episodes found with provided criteria to list");
-  }
-
-  const isJson = type === "json";
-
-  const output = items.map((item) => {
-    const data = {
-      episodeNum: feed.items.length - item._originalIndex,
-      title: item.title,
-      pubDate: item.pubDate,
-    };
-
-    return data;
-  });
-
-  if (isJson) {
-    // eslint-disable-next-line no-console
-    console.log(JSON.stringify(output));
-    return;
-  }
-
-  // eslint-disable-next-line no-console
-  console.table(output);
-};
-
-const writeFeedMeta = ({ outputPath, feed, key, archive, override }) => {
-  if (key && archive && getIsInArchive({ key, archive })) {
-    logMessage("Feed metadata exists in archive. Skipping...");
-    return;
-  }
-  const output = getPublicObject(feed, ["items"]);
-
-  try {
-    if (override || !fs.existsSync(outputPath)) {
-      fs.writeFileSync(outputPath, JSON.stringify(output, null, 4));
-    } else {
-      logMessage("Feed metadata exists locally. Skipping...");
-    }
-
-    if (key && archive && !getIsInArchive({ key, archive })) {
-      try {
-        writeToArchive({ key, archive });
-      } catch (error) {
-        throw new Error(`Error writing to archive: ${error.toString()}`);
-      }
-    }
-  } catch (error) {
-    throw new Error(
-      `Unable to save metadata file for feed: ${error.toString()}`
-    );
-  }
-};
-
-const writeItemMeta = ({
-  marker,
-  outputPath,
-  item,
-  key,
-  archive,
-  override,
-}) => {
-  if (key && archive && getIsInArchive({ key, archive })) {
-    logMessage(`${marker} | Episode metadata exists in archive. Skipping...`);
-    return;
-  }
-
-  const output = getPublicObject(item);
-
-  try {
-    if (override || !fs.existsSync(outputPath)) {
-      fs.writeFileSync(outputPath, JSON.stringify(output, null, 4));
-    } else {
-      logMessage(`${marker} | Episode metadata exists locally. Skipping...`);
-    }
-
-    if (key && archive && !getIsInArchive({ key, archive })) {
-      try {
-        writeToArchive({ key, archive });
-      } catch (error) {
-        throw new Error("Error writing to archive", error);
-      }
-    }
-  } catch (error) {
-    throw new Error("Unable to save meta file for episode", error);
-  }
-};
-
-const getUrlExt = (url) => {
+export const getUrlExt = (url) => {
   if (!url) {
     return "";
   }
@@ -460,7 +143,7 @@ const getUrlExt = (url) => {
   return ext;
 };
 
-const AUDIO_TYPES_TO_EXTS = {
+export const AUDIO_TYPES_TO_EXTS = {
   "audio/aac": ".aac",
   "audio/flac": ".flac",
   "audio/mp3": ".mp3",
@@ -477,9 +160,11 @@ const AUDIO_TYPES_TO_EXTS = {
   "video/x-m4v": ".m4v",
 };
 
-const VALID_AUDIO_EXTS = [...new Set(Object.values(AUDIO_TYPES_TO_EXTS))];
+export const VALID_AUDIO_EXTS = [
+  ...new Set(Object.values(AUDIO_TYPES_TO_EXTS)),
+];
 
-const getIsAudioUrl = (url) => {
+export const getIsAudioUrl = (url) => {
   let ext;
   try {
     ext = getUrlExt(url);
@@ -494,12 +179,12 @@ const getIsAudioUrl = (url) => {
   return VALID_AUDIO_EXTS.includes(ext);
 };
 
-const AUDIO_ORDER_TYPES = {
+export const AUDIO_ORDER_TYPES = {
   enclosure: "enclosure",
   link: "link",
 };
 
-const getEpisodeAudioUrlAndExt = (
+export const getEpisodeAudioUrlAndExt = (
   { enclosure, link },
   order = [AUDIO_ORDER_TYPES.enclosure, AUDIO_ORDER_TYPES.link]
 ) => {
@@ -522,7 +207,7 @@ const getEpisodeAudioUrlAndExt = (
   return { url: null, ext: null };
 };
 
-const getImageUrl = ({ image, itunes }) => {
+export const getImageUrl = ({ image, itunes }) => {
   if (image?.url) {
     return image.url;
   }
@@ -549,7 +234,7 @@ export const TRANSCRIPT_TYPES = {
 };
 
 // @see https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#transcript
-const getTranscriptUrl = (item, transcriptTypes = []) => {
+export const getTranscriptUrl = (item, transcriptTypes = []) => {
   if (!item.podcastTranscripts?.length) {
     return null;
   }
@@ -568,7 +253,7 @@ const getTranscriptUrl = (item, transcriptTypes = []) => {
   return null;
 };
 
-const getFileFeed = async (filePath, parserConfig) => {
+export const getFileFeed = async (filePath, parserConfig) => {
   const config = parserConfig
     ? getJsonFile(parserConfig)
     : defaultRssParserConfig;
@@ -590,7 +275,7 @@ const getFileFeed = async (filePath, parserConfig) => {
   return feed;
 };
 
-const getUrlFeed = async (url, parserConfig) => {
+export const getUrlFeed = async (url, parserConfig) => {
   const config = parserConfig
     ? getJsonFile(parserConfig)
     : defaultRssParserConfig;
@@ -612,132 +297,3 @@ const getUrlFeed = async (url, parserConfig) => {
 
   return feed;
 };
-
-const runFfmpeg = async ({
-  feed,
-  item,
-  itemIndex,
-  outputPath,
-  bitrate,
-  mono,
-  addMp3Metadata,
-  ext,
-}) => {
-  if (!fs.existsSync(outputPath)) {
-    return;
-  }
-
-  let command = `ffmpeg -loglevel quiet -i "${outputPath}"`;
-
-  if (bitrate) {
-    command += ` -b:a ${bitrate}`;
-  }
-
-  if (mono) {
-    command += " -ac 1";
-  }
-
-  if (addMp3Metadata) {
-    const album = feed.title || "";
-    const artist = item.itunes?.author || item.author || "";
-    const title = item.title || "";
-    const subtitle = item.itunes?.subtitle || "";
-    const comment = item.content || "";
-    const disc = item.itunes?.season || "";
-    const track = item.itunes?.episode || `${feed.items.length - itemIndex}`;
-    const episodeType = item.itunes?.episodeType || "";
-    const date = item.pubDate
-      ? dayjs(new Date(item.pubDate)).format("YYYY-MM-DD")
-      : "";
-
-    const metaKeysToValues = {
-      album,
-      artist,
-      album_artist: artist,
-      title,
-      subtitle,
-      comment,
-      disc,
-      track,
-      "episode-type": episodeType,
-      date,
-    };
-
-    const metadataString = Object.keys(metaKeysToValues)
-      .map((key) => {
-        if (!metaKeysToValues[key]) {
-          return null;
-        }
-
-        const argValue = escapeArgForShell(metaKeysToValues[key]);
-
-        return argValue ? `-metadata ${key}=${argValue}` : null;
-      })
-      .filter((segment) => !!segment)
-      .join(" ");
-
-    command += ` -map_metadata 0 ${metadataString} -codec copy`;
-  }
-
-  const tmpMp3Path = `${outputPath}.tmp${ext}`;
-  command += ` "${tmpMp3Path}"`;
-  logMessage("Running command: " + command, LOG_LEVELS.debug);
-
-  try {
-    await execWithPromise(command, { stdio: "ignore" });
-  } catch (error) {
-    if (fs.existsSync(tmpMp3Path)) {
-      fs.unlinkSync(tmpMp3Path);
-    }
-
-    throw error;
-  }
-
-  fs.unlinkSync(outputPath);
-  fs.renameSync(tmpMp3Path, outputPath);
-};
-
-const runExec = async ({
-  exec,
-  basePath,
-  outputPodcastPath,
-  episodeFilename,
-  episodeAudioUrl,
-}) => {
-  const episodeFilenameBase = episodeFilename.substring(
-    0,
-    episodeFilename.lastIndexOf(".")
-  );
-
-  const execCmd = exec
-    .replace(/{{episode_path}}/g, `"${outputPodcastPath}"`)
-    .replace(/{{episode_path_base}}/g, `"${basePath}"`)
-    .replace(/{{episode_filename}}/g, `"${episodeFilename}"`)
-    .replace(/{{episode_filename_base}}/g, `"${episodeFilenameBase}"`)
-    .replace(/{{url}}/g, `"${episodeAudioUrl}"`);
-
-  await execWithPromise(execCmd, { stdio: "ignore" });
-};
-
-export {
-  AUDIO_ORDER_TYPES,
-  getArchive,
-  getIsInArchive,
-  getArchiveKey,
-  writeToArchive,
-  getEpisodeAudioUrlAndExt,
-  getFileFeed,
-  getImageUrl,
-  getItemsToDownload,
-  getTempPath,
-  getUrlExt,
-  getUrlFeed,
-  logFeedInfo,
-  ITEM_LIST_FORMATS,
-  logItemsList,
-  prepareOutputPath,
-  writeFeedMeta,
-  writeItemMeta,
-  runFfmpeg,
-  runExec,
-};

package/bin/validate.js

@@ -1,8 +1,7 @@
 import { sync as commandExistsSync } from "command-exists";
-
 import { logErrorAndExit } from "./logger.js";
 
-const createParseNumber = ({ min, max, name, required = true }) => {
+export const createParseNumber = ({ min, max, name, required = true }) => {
   return (value) => {
     if (!value && !required) {
       return undefined;
@@ -33,10 +32,8 @@ const createParseNumber = ({ min, max, name, required = true }) => {
   };
 };
 
-const hasFfmpeg = () => {
+export const hasFfmpeg = () => {
   if (!commandExistsSync("ffmpeg")) {
     logErrorAndExit('option specified requires "ffmpeg" be available');
   }
 };
-
-export { createParseNumber, hasFfmpeg };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "podcast-dl",
-  "version": "10.4.0",
+  "version": "11.0.0",
   "description": "A CLI for downloading podcasts.",
   "type": "module",
   "bin": "./bin/bin.js",
@@ -26,7 +26,7 @@
     "cli"
   ],
   "engines": {
-    "node": ">=18.17.0"
+    "node": ">=22.16.0"
   },
   "repository": {
     "type": "git",
@@ -38,11 +38,11 @@
   "author": "Joshua Pohl",
   "license": "MIT",
   "devDependencies": {
+    "@yao-pkg/pkg": "^5.8.0",
     "eslint": "^6.8.0",
     "eslint-config-prettier": "^6.11.0",
     "husky": "^4.2.5",
     "lint-staged": "^10.1.7",
-    "pkg": "^5.8.0",
     "prettier": "2.3.2",
     "rimraf": "^3.0.2",
     "webpack": "^5.75.0"