podcast-dl 11.4.0 → 11.5.0

package/bin/meta.js

@@ -1,66 +1,66 @@
-import fs from "fs";
-import { getIsInArchive, writeToArchive } from "./archive.js";
-import { logMessage } from "./logger.js";
-import { getPublicObject } from "./util.js";
-
-export 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()}`
-    );
-  }
-};
-
-export 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);
-  }
-};
+import fs from "fs";
+import { getIsInArchive, writeToArchive } from "./archive.js";
+import { logMessage } from "./logger.js";
+import { getPublicObject } from "./util.js";
+
+export 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()}`
+    );
+  }
+};
+
+export 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);
+  }
+};

package/bin/naming.js

@@ -1,136 +1,136 @@
-import dayjs from "dayjs";
-import filenamify from "filenamify";
-import path from "path";
-
-const INVALID_CHAR_REPLACE = "_";
-
-const FILTER_FUNCTIONS = {
-  strip: (val) => val.replace(/\s+/g, ""),
-  strip_special: (val) => val.replace(/[^a-zA-Z0-9\s]/g, ""),
-  underscore: (val) => val.replace(/\s+/g, "_"),
-  dash: (val) => val.replace(/\s+/g, "-"),
-  camelcase: (val) =>
-    val
-      .split(/\s+/)
-      .map((w) =>
-        w ? w.charAt(0).toUpperCase() + w.slice(1).toLowerCase() : ""
-      )
-      .join(""),
-  lowercase: (val) => val.toLowerCase(),
-  uppercase: (val) => val.toUpperCase(),
-  trim: (val) => val.trim(),
-};
-
-const applyFilters = (value, filterStr) => {
-  if (!filterStr) {
-    return value;
-  }
-
-  const filters = filterStr.slice(1).split("|");
-  return filters.reduce((val, filter) => {
-    const filterFn = FILTER_FUNCTIONS[filter];
-    return filterFn ? filterFn(val) : val;
-  }, value);
-};
-
-const MAX_LENGTH_FILENAME = process.env.MAX_LENGTH_FILENAME
-  ? parseInt(process.env.MAX_LENGTH_FILENAME)
-  : 255;
-
-export const getSafeName = (name, maxLength = MAX_LENGTH_FILENAME) => {
-  return filenamify(name, {
-    replacement: INVALID_CHAR_REPLACE,
-    maxLength,
-  });
-};
-
-export const getSimpleFilename = (name, ext = "") => {
-  return `${getSafeName(name, MAX_LENGTH_FILENAME - (ext?.length ?? 0))}${ext}`;
-};
-
-export const getItemFilename = ({
-  item,
-  ext,
-  url,
-  feed,
-  template,
-  width,
-  customTemplateOptions = [],
-  offset = 0,
-}) => {
-  const episodeNum = feed.items.length - item._originalIndex + offset;
-  const title = item.title || "";
-
-  const releaseYear = item.pubDate
-    ? dayjs(new Date(item.pubDate)).format("YYYY")
-    : null;
-
-  const releaseMonth = item.pubDate
-    ? dayjs(new Date(item.pubDate)).format("MM")
-    : null;
-
-  const releaseDay = item.pubDate
-    ? dayjs(new Date(item.pubDate)).format("DD")
-    : null;
-
-  const releaseDate = item.pubDate
-    ? dayjs(new Date(item.pubDate)).format("YYYYMMDD")
-    : null;
-
-  const customReplacementTuples = customTemplateOptions.map((option, i) => {
-    const matchRegex = new RegExp(option);
-    const match = title.match(matchRegex);
-
-    return match && match[0] ? [`custom_${i}`, match[0]] : [`custom_${i}`, ""];
-  });
-
-  const templateReplacementsTuples = [
-    ["title", title],
-    ["release_date", releaseDate || ""],
-    ["release_year", releaseYear || ""],
-    ["release_month", releaseMonth || ""],
-    ["release_day", releaseDay || ""],
-    ["episode_num", `${episodeNum}`.padStart(width, "0")],
-    ["url", url],
-    ["podcast_title", feed.title || ""],
-    ["podcast_link", feed.link || ""],
-    ["duration", item.itunes?.duration || ""],
-    ["guid", item.guid],
-    ...customReplacementTuples,
-  ];
-
-  const replacementsMap = Object.fromEntries(templateReplacementsTuples);
-  const templateSegments = template.trim().split(path.sep);
-  const nameSegments = templateSegments.map((segment) => {
-    const replaceRegex = /{{(\w+)(\|[^}]+)?}}/g;
-    const name = segment.replace(replaceRegex, (match, varName, filterStr) => {
-      const replacement = replacementsMap[varName] || "";
-      return applyFilters(replacement, filterStr);
-    });
-
-    return getSimpleFilename(name);
-  });
-
-  nameSegments[nameSegments.length - 1] = getSimpleFilename(
-    nameSegments[nameSegments.length - 1],
-    ext
-  );
-
-  return nameSegments.join(path.sep);
-};
-
-export const getFolderName = ({ feed, template }) => {
-  const replacementsMap = {
-    podcast_title: feed.title || "",
-    podcast_link: feed.link || "",
-  };
-
-  const replaceRegex = /{{(\w+)(\|[^}]+)?}}/g;
-  const name = template.replace(replaceRegex, (_, varName, filterStr) => {
-    const replacement = replacementsMap[varName] || "";
-    const filtered = applyFilters(replacement, filterStr);
-    return getSafeName(filtered);
-  });
-
-  return name;
-};
+import dayjs from "dayjs";
+import filenamify from "filenamify";
+import path from "path";
+
+const INVALID_CHAR_REPLACE = "_";
+
+const FILTER_FUNCTIONS = {
+  strip: (val) => val.replace(/\s+/g, ""),
+  strip_special: (val) => val.replace(/[^a-zA-Z0-9\s]/g, ""),
+  underscore: (val) => val.replace(/\s+/g, "_"),
+  dash: (val) => val.replace(/\s+/g, "-"),
+  camelcase: (val) =>
+    val
+      .split(/\s+/)
+      .map((w) =>
+        w ? w.charAt(0).toUpperCase() + w.slice(1).toLowerCase() : ""
+      )
+      .join(""),
+  lowercase: (val) => val.toLowerCase(),
+  uppercase: (val) => val.toUpperCase(),
+  trim: (val) => val.trim(),
+};
+
+const applyFilters = (value, filterStr) => {
+  if (!filterStr) {
+    return value;
+  }
+
+  const filters = filterStr.slice(1).split("|");
+  return filters.reduce((val, filter) => {
+    const filterFn = FILTER_FUNCTIONS[filter];
+    return filterFn ? filterFn(val) : val;
+  }, value);
+};
+
+const MAX_LENGTH_FILENAME = process.env.MAX_LENGTH_FILENAME
+  ? parseInt(process.env.MAX_LENGTH_FILENAME)
+  : 255;
+
+export const getSafeName = (name, maxLength = MAX_LENGTH_FILENAME) => {
+  return filenamify(name, {
+    replacement: INVALID_CHAR_REPLACE,
+    maxLength,
+  });
+};
+
+export const getSimpleFilename = (name, ext = "") => {
+  return `${getSafeName(name, MAX_LENGTH_FILENAME - (ext?.length ?? 0))}${ext}`;
+};
+
+export const getItemFilename = ({
+  item,
+  ext,
+  url,
+  feed,
+  template,
+  width,
+  customTemplateOptions = [],
+  offset = 0,
+}) => {
+  const episodeNum = feed.items.length - item._originalIndex + offset;
+  const title = item.title || "";
+
+  const releaseYear = item.pubDate
+    ? dayjs(new Date(item.pubDate)).format("YYYY")
+    : null;
+
+  const releaseMonth = item.pubDate
+    ? dayjs(new Date(item.pubDate)).format("MM")
+    : null;
+
+  const releaseDay = item.pubDate
+    ? dayjs(new Date(item.pubDate)).format("DD")
+    : null;
+
+  const releaseDate = item.pubDate
+    ? dayjs(new Date(item.pubDate)).format("YYYYMMDD")
+    : null;
+
+  const customReplacementTuples = customTemplateOptions.map((option, i) => {
+    const matchRegex = new RegExp(option);
+    const match = title.match(matchRegex);
+
+    return match && match[0] ? [`custom_${i}`, match[0]] : [`custom_${i}`, ""];
+  });
+
+  const templateReplacementsTuples = [
+    ["title", title],
+    ["release_date", releaseDate || ""],
+    ["release_year", releaseYear || ""],
+    ["release_month", releaseMonth || ""],
+    ["release_day", releaseDay || ""],
+    ["episode_num", `${episodeNum}`.padStart(width, "0")],
+    ["url", url],
+    ["podcast_title", feed.title || ""],
+    ["podcast_link", feed.link || ""],
+    ["duration", item.itunes?.duration || ""],
+    ["guid", item.guid],
+    ...customReplacementTuples,
+  ];
+
+  const replacementsMap = Object.fromEntries(templateReplacementsTuples);
+  const templateSegments = template.trim().split(path.sep);
+  const nameSegments = templateSegments.map((segment) => {
+    const replaceRegex = /{{(\w+)(\|[^}]+)?}}/g;
+    const name = segment.replace(replaceRegex, (match, varName, filterStr) => {
+      const replacement = replacementsMap[varName] || "";
+      return applyFilters(replacement, filterStr);
+    });
+
+    return getSimpleFilename(name);
+  });
+
+  nameSegments[nameSegments.length - 1] = getSimpleFilename(
+    nameSegments[nameSegments.length - 1],
+    ext
+  );
+
+  return nameSegments.join(path.sep);
+};
+
+export const getFolderName = ({ feed, template }) => {
+  const replacementsMap = {
+    podcast_title: feed.title || "",
+    podcast_link: feed.link || "",
+  };
+
+  const replaceRegex = /{{(\w+)(\|[^}]+)?}}/g;
+  const name = template.replace(replaceRegex, (_, varName, filterStr) => {
+    const replacement = replacementsMap[varName] || "";
+    const filtered = applyFilters(replacement, filterStr);
+    return getSafeName(filtered);
+  });
+
+  return name;
+};

package/bin/util.js

@@ -160,6 +160,117 @@ export const AUDIO_TYPES_TO_EXTS = {
   "video/x-m4v": ".m4v",
 };
 
+export const IMAGE_TYPES_TO_EXTS = {
+  "image/jpeg": ".jpg",
+  "image/jpg": ".jpg",
+  "image/png": ".png",
+  "image/gif": ".gif",
+  "image/webp": ".webp",
+  "image/bmp": ".bmp",
+  "image/tiff": ".tiff",
+  "image/avif": ".avif",
+};
+
+export const TRANSCRIPT_TYPES_TO_EXTS = {
+  "application/json": ".json",
+  "application/srt": ".srt",
+  "application/ttml+xml": ".ttml",
+  "application/x-subrip": ".srt",
+  "text/html": ".html",
+  "text/plain": ".txt",
+  "text/srt": ".srt",
+  "text/vtt": ".vtt",
+};
+
+export const MIME_TO_EXT = {
+  ...AUDIO_TYPES_TO_EXTS,
+  ...IMAGE_TYPES_TO_EXTS,
+  ...TRANSCRIPT_TYPES_TO_EXTS,
+};
+
+export const getExtFromMime = (mime) => MIME_TO_EXT[mime] || null;
+
+const MEDIA_CATEGORIES = {
+  audio: "audio",
+  image: "image",
+  transcript: "transcript",
+};
+
+const VALID_AUDIO_EXTS_SET = new Set(Object.values(AUDIO_TYPES_TO_EXTS));
+const VALID_IMAGE_EXTS_SET = new Set(Object.values(IMAGE_TYPES_TO_EXTS));
+const VALID_TRANSCRIPT_EXTS_SET = new Set(
+  Object.values(TRANSCRIPT_TYPES_TO_EXTS)
+);
+
+const getExtCategory = (ext) => {
+  if (VALID_AUDIO_EXTS_SET.has(ext)) {
+    return MEDIA_CATEGORIES.audio;
+  }
+
+  if (VALID_IMAGE_EXTS_SET.has(ext)) {
+    return MEDIA_CATEGORIES.image;
+  }
+
+  if (VALID_TRANSCRIPT_EXTS_SET.has(ext)) {
+    return MEDIA_CATEGORIES.transcript;
+  }
+  return null;
+};
+
+const getMimeCategory = (mime) => {
+  if (AUDIO_TYPES_TO_EXTS[mime]) {
+    return MEDIA_CATEGORIES.audio;
+  }
+
+  if (IMAGE_TYPES_TO_EXTS[mime]) {
+    return MEDIA_CATEGORIES.image;
+  }
+
+  if (TRANSCRIPT_TYPES_TO_EXTS[mime]) {
+    return MEDIA_CATEGORIES.transcript;
+  }
+
+  return null;
+};
+
+export const correctExtensionFromMime = ({
+  outputPath,
+  key,
+  contentType,
+  onCorrect,
+}) => {
+  const mimeType = contentType?.split(";")[0];
+  const mimeExt = mimeType ? getExtFromMime(mimeType) : null;
+
+  if (!mimeExt) {
+    return { outputPath, key };
+  }
+
+  const currentExt = path.extname(outputPath);
+  if (mimeExt === currentExt) {
+    return { outputPath, key };
+  }
+
+  const currentCategory = getExtCategory(currentExt);
+  const mimeCategory = getMimeCategory(mimeType);
+
+  if (currentCategory && mimeCategory && currentCategory !== mimeCategory) {
+    return { outputPath, key };
+  }
+
+  const basePath = currentExt
+    ? outputPath.slice(0, -currentExt.length)
+    : outputPath;
+  const baseKey = key && currentExt ? key.slice(0, -currentExt.length) : key;
+
+  onCorrect?.(currentExt || "(none)", mimeExt);
+
+  return {
+    outputPath: basePath + mimeExt,
+    key: baseKey ? baseKey + mimeExt : null,
+  };
+};
+
 export const VALID_AUDIO_EXTS = [
   ...new Set(Object.values(AUDIO_TYPES_TO_EXTS)),
 ];
@@ -168,7 +279,7 @@ export const getIsAudioUrl = (url) => {
   let ext;
   try {
     ext = getUrlExt(url);
-  } catch (err) {
+  } catch {
     return false;
   }
 

package/bin/validate.js

@@ -13,11 +13,11 @@ export const createParseNumber = ({ min, max, name, required = true }) => {
         logErrorAndExit(`${name} must be a number`);
       }
 
-      if (typeof min !== undefined && number < min) {
+      if (min !== undefined && number < min) {
         logErrorAndExit(`${name} must be >= ${min}`);
       }
 
-      if (typeof max !== undefined && number > max) {
+      if (max !== undefined && number > max) {
         logErrorAndExit(
           `${name} must be <= ${
             max === Number.MAX_SAFE_INTEGER ? "Number.MAX_SAFE_INTEGER" : max
@@ -26,7 +26,7 @@ export const createParseNumber = ({ min, max, name, required = true }) => {
       }
 
       return number;
-    } catch (error) {
+    } catch {
       logErrorAndExit(`Unable to parse ${name}`);
     }
   };

package/package.json

@@ -1,62 +1,63 @@
-{
-  "name": "podcast-dl",
-  "version": "11.4.0",
-  "description": "A CLI for downloading podcasts.",
-  "type": "module",
-  "bin": "./bin/bin.js",
-  "scripts": {
-    "build": "rimraf ./binaries && rimraf ./dist && node build.cjs",
-    "lint": "eslint ./bin"
-  },
-  "lint-staged": {
-    "*.{js,json,md}": [
-      "prettier --write"
-    ]
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged",
-      "pre-push": "npm run lint"
-    }
-  },
-  "keywords": [
-    "podcast",
-    "podcasts",
-    "downloader",
-    "cli"
-  ],
-  "engines": {
-    "node": ">=18.17.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/lightpohl/podcast-dl.git"
-  },
-  "files": [
-    "bin"
-  ],
-  "author": "Joshua Pohl",
-  "license": "MIT",
-  "devDependencies": {
-    "@yao-pkg/pkg": "^6.6.0",
-    "eslint": "^6.8.0",
-    "eslint-config-prettier": "^6.11.0",
-    "husky": "^4.2.5",
-    "lint-staged": "^10.1.7",
-    "prettier": "2.3.2",
-    "rimraf": "^3.0.2",
-    "webpack": "^5.75.0"
-  },
-  "dependencies": {
-    "command-exists": "^1.2.9",
-    "commander": "^12.1.0",
-    "dayjs": "^1.8.25",
-    "filenamify": "^6.0.0",
-    "global-agent": "^3.0.0",
-    "got": "^11.0.2",
-    "p-limit": "^4.0.0",
-    "pluralize": "^8.0.0",
-    "rss-parser": "^3.12.0",
-    "throttle-debounce": "^3.0.1"
-  }
-}
+{
+  "name": "podcast-dl",
+  "version": "11.5.0",
+  "description": "A CLI for downloading podcasts.",
+  "type": "module",
+  "bin": "./bin/bin.js",
+  "scripts": {
+    "build": "rimraf ./binaries && rimraf ./dist && node build.cjs",
+    "lint": "eslint ./bin"
+  },
+  "lint-staged": {
+    "*.{js,json,md}": [
+      "prettier --write"
+    ]
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged",
+      "pre-push": "npm run lint"
+    }
+  },
+  "keywords": [
+    "podcast",
+    "podcasts",
+    "downloader",
+    "cli"
+  ],
+  "engines": {
+    "node": ">=18.17.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lightpohl/podcast-dl.git"
+  },
+  "files": [
+    "bin"
+  ],
+  "author": "Joshua Pohl",
+  "license": "MIT",
+  "devDependencies": {
+    "@eslint/js": "^9.18.0",
+    "@yao-pkg/pkg": "^6.6.0",
+    "eslint": "^9.18.0",
+    "globals": "^15.14.0",
+    "husky": "^4.2.5",
+    "lint-staged": "^10.1.7",
+    "prettier": "2.3.2",
+    "rimraf": "^3.0.2",
+    "webpack": "^5.75.0"
+  },
+  "dependencies": {
+    "command-exists": "^1.2.9",
+    "commander": "^12.1.0",
+    "dayjs": "^1.8.25",
+    "filenamify": "^6.0.0",
+    "global-agent": "^3.0.0",
+    "got": "^11.0.2",
+    "p-limit": "^4.0.0",
+    "pluralize": "^8.0.0",
+    "rss-parser": "^3.12.0",
+    "throttle-debounce": "^3.0.1"
+  }
+}