podcast-dl 11.1.1 → 11.2.0

package/bin/items.js

@@ -1,237 +1,247 @@
-import dayjs from "dayjs";
-import path from "path";
-import { getArchive, getArchiveFilename, getArchiveKey } from "./archive.js";
-import { logErrorAndExit } from "./logger.js";
-import { getItemFilename } from "./naming.js";
-import {
-  getEpisodeAudioUrlAndExt,
-  getImageUrl,
-  getLoopControls,
-  getTranscriptUrl,
-  getUrlExt,
-} from "./util.js";
-
-export const ITEM_LIST_FORMATS = ["table", "json"];
-
-export const getItemsToDownload = ({
-  archive,
-  archivePrefix,
-  addMp3MetadataFlag,
-  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;
-
-      if (includeEpisodeImages || addMp3MetadataFlag) {
-        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._episodeImage = {
-            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._episodeTranscript = {
-            url: episodeTranscriptUrl,
-            outputPath: outputTranscriptPath,
-            key: episodeTranscriptArchiveKey,
-          };
-        }
-      }
-
-      items.push(item);
-    }
-
-    i = next(i);
-  }
-
-  return limit ? items.slice(0, limit) : items;
-};
-
-export 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);
-};
+import dayjs from "dayjs";
+import path from "path";
+import { getArchive, getArchiveFilename, getArchiveKey } from "./archive.js";
+import { logErrorAndExit } from "./logger.js";
+import { getItemFilename } from "./naming.js";
+import {
+  getEpisodeAudioUrlAndExt,
+  getImageUrl,
+  getLoopControls,
+  getTranscriptUrl,
+  getUrlExt,
+} from "./util.js";
+
+export const ITEM_LIST_FORMATS = ["table", "json"];
+
+export const getItemsToDownload = ({
+  archive,
+  archivePrefix,
+  addMp3MetadataFlag,
+  basePath,
+  feed,
+  limit,
+  offset,
+  reverse,
+  before,
+  after,
+  episodeDigits,
+  episodeNumOffset,
+  episodeRegex,
+  episodeRegexExclude,
+  episodeSourceOrder,
+  episodeTemplate,
+  episodeCustomTemplateOptions,
+  includeEpisodeImages,
+  includeEpisodeTranscripts,
+  episodeTranscriptTypes,
+  season,
+}) => {
+  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, itunes } = feed.items[i];
+    const actualSeasonNum = itunes?.season ? parseInt(itunes.season) : null;
+    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;
+      }
+    }
+
+    if (season && season != actualSeasonNum) {
+      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.seasonNum = actualSeasonNum;
+
+      if (includeEpisodeImages || addMp3MetadataFlag) {
+        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._episodeImage = {
+            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._episodeTranscript = {
+            url: episodeTranscriptUrl,
+            outputPath: outputTranscriptPath,
+            key: episodeTranscriptArchiveKey,
+          };
+        }
+      }
+
+      items.push(item);
+    }
+
+    i = next(i);
+  }
+
+  return limit ? items.slice(0, limit) : items;
+};
+
+export const logItemsList = ({
+  type,
+  feed,
+  limit,
+  offset,
+  reverse,
+  before,
+  after,
+  episodeRegex,
+  episodeRegexExclude,
+  season,
+}) => {
+  const items = getItemsToDownload({
+    feed,
+    limit,
+    offset,
+    reverse,
+    before,
+    after,
+    episodeRegex,
+    episodeRegexExclude,
+    season,
+  });
+
+  if (!items.length) {
+    logErrorAndExit("No episodes found with provided criteria to list");
+  }
+
+  const isJson = type === "json";
+
+  const output = items.map((item) => {
+    const data = {
+      seasonNum: item.seasonNum,
+      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);
+};

package/bin/logger.js

@@ -1,84 +1,84 @@
-/* eslint-disable no-console */
-
-export const ERROR_STATUSES = {
-  general: 1,
-  nothingDownloaded: 2,
-  completedWithErrors: 3,
-};
-
-export const LOG_LEVEL_TYPES = {
-  debug: "debug",
-  quiet: "quiet",
-  silent: "silent",
-  static: "static",
-};
-
-export const LOG_LEVELS = {
-  debug: 0,
-  info: 1,
-  important: 2,
-};
-
-export const getShouldOutputProgressIndicator = () => {
-  return (
-    process.stdout.isTTY &&
-    process.env.LOG_LEVEL !== LOG_LEVEL_TYPES.static &&
-    process.env.LOG_LEVEL !== LOG_LEVEL_TYPES.quiet &&
-    process.env.LOG_LEVEL !== LOG_LEVEL_TYPES.silent
-  );
-};
-
-export const logMessage = (message = "", logLevel = 1) => {
-  if (
-    !process.env.LOG_LEVEL ||
-    process.env.LOG_LEVEL === LOG_LEVEL_TYPES.debug ||
-    process.env.LOG_LEVEL === LOG_LEVEL_TYPES.static
-  ) {
-    console.log(message);
-    return;
-  }
-
-  if (process.env.LOG_LEVEL === LOG_LEVEL_TYPES.silent) {
-    return;
-  }
-
-  if (
-    process.env.LOG_LEVEL === LOG_LEVEL_TYPES.quiet &&
-    logLevel > LOG_LEVELS.info
-  ) {
-    console.log(message);
-    return;
-  }
-};
-
-export const getLogMessageWithMarker = (marker) => {
-  return (message, logLevel) => {
-    if (marker) {
-      logMessage(`${marker} | ${message}`, logLevel);
-    } else {
-      logMessage(message, logLevel);
-    }
-  };
-};
-
-export const logError = (msg, error) => {
-  if (process.env.LOG_LEVEL === LOG_LEVEL_TYPES.silent) {
-    return;
-  }
-
-  console.error(msg);
-
-  if (error) {
-    console.error(error.message);
-  }
-};
-
-export const logErrorAndExit = (msg, error) => {
-  console.error(msg);
-
-  if (error) {
-    console.error(error.message);
-  }
-
-  process.exit(ERROR_STATUSES.general);
-};
+/* eslint-disable no-console */
+
+export const ERROR_STATUSES = {
+  general: 1,
+  nothingDownloaded: 2,
+  completedWithErrors: 3,
+};
+
+export const LOG_LEVEL_TYPES = {
+  debug: "debug",
+  quiet: "quiet",
+  silent: "silent",
+  static: "static",
+};
+
+export const LOG_LEVELS = {
+  debug: 0,
+  info: 1,
+  important: 2,
+};
+
+export const getShouldOutputProgressIndicator = () => {
+  return (
+    process.stdout.isTTY &&
+    process.env.LOG_LEVEL !== LOG_LEVEL_TYPES.static &&
+    process.env.LOG_LEVEL !== LOG_LEVEL_TYPES.quiet &&
+    process.env.LOG_LEVEL !== LOG_LEVEL_TYPES.silent
+  );
+};
+
+export const logMessage = (message = "", logLevel = 1) => {
+  if (
+    !process.env.LOG_LEVEL ||
+    process.env.LOG_LEVEL === LOG_LEVEL_TYPES.debug ||
+    process.env.LOG_LEVEL === LOG_LEVEL_TYPES.static
+  ) {
+    console.log(message);
+    return;
+  }
+
+  if (process.env.LOG_LEVEL === LOG_LEVEL_TYPES.silent) {
+    return;
+  }
+
+  if (
+    process.env.LOG_LEVEL === LOG_LEVEL_TYPES.quiet &&
+    logLevel > LOG_LEVELS.info
+  ) {
+    console.log(message);
+    return;
+  }
+};
+
+export const getLogMessageWithMarker = (marker) => {
+  return (message, logLevel) => {
+    if (marker) {
+      logMessage(`${marker} | ${message}`, logLevel);
+    } else {
+      logMessage(message, logLevel);
+    }
+  };
+};
+
+export const logError = (msg, error) => {
+  if (process.env.LOG_LEVEL === LOG_LEVEL_TYPES.silent) {
+    return;
+  }
+
+  console.error(msg);
+
+  if (error) {
+    console.error(error.message);
+  }
+};
+
+export const logErrorAndExit = (msg, error) => {
+  console.error(msg);
+
+  if (error) {
+    console.error(error.message);
+  }
+
+  process.exit(ERROR_STATUSES.general);
+};