cross-seed 5.9.1 → 6.0.0-0

package/dist/config.template.cjs

@@ -1,231 +1,315 @@
 "use strict";
-// If you find yourself always using the same command-line flag, you can set
-// it here as a default.
+// If you find yourself always using the same command-line flag, you can set it
+// here as a default.
 Object.defineProperty(exports, "__esModule", { value: true });
 module.exports = {
     /**
-     * Pause at least this much in between each search. Higher is safer.
-     * It is not recommended to set this to less than 2 seconds.
-     */
-    delay: 10,
+     * WARNING! WARNING! WARNING! WARNING! WARNING! WARNING! WARNING!
+     *
+     * THE NEXT 8 OPTIONS CONTAIN POTENTIALLY SENSITIVE INFORMATION
+     * THERE IS A NOTE WHERE YOU WILL WANT TO START COPYING FROM
+     * IF YOU ARE TRYING TO SHARE YOUR CONFIGURATION SETTINGS!
+     *
+     * WARNING! WARNING! WARNING! WARNING! WARNING! WARNING! WARNING!
+     **/
     /**
      * List of Torznab URLs.
-     * For Jackett, click "Copy RSS feed"
-     * For Prowlarr, click on the indexer name and copy the Torznab Url, then append "?apikey=YOUR_PROWLARR_API_KEY"
-     * Wrap each URL in quotation marks, and separate them with commas, and surround the entire set in brackets.
+     * For Jackett, click "Copy RSS feed".
+     * For Prowlarr, click on the indexer name and copy the Torznab Url, then
+     * append "?apikey=YOUR_PROWLARR_API_KEY". Wrap each URL in quotation marks
+     * and separate them with commas, and surround the entire set in brackets.
      */
     torznab: [],
     /**
-     * To search with downloaded data, you can pass in directories to your downloaded torrent
-     * data to find matches rather using the torrent files themselves for matching.
+     * Bind to a specific host address.
+     * Example: "127.0.0.1"
+     * Default is "0.0.0.0"
+     */
+    host: undefined,
+    /**
+     * The port you wish to listen on for daemon mode.
+     */
+    port: 2468,
+    /**
+     * cross-seed will send POST requests to this url with a JSON payload of
+     * { title, body }. Conforms to the caronc/apprise REST API.
+     */
+    notificationWebhookUrl: undefined,
+    /**
+     * The url of your rtorrent XMLRPC interface.
+     * Only relevant with action: "inject".
+     * Could be something like "http://username:password@localhost:1234/RPC2
+     */
+    rtorrentRpcUrl: undefined,
+    /**
+     * The url of your qBittorrent webui.
+     * Only relevant with action: "inject".
+     * Supply your username and password inside the url like so:
+     * "http://username:password@localhost:8080"
+     */
+    qbittorrentUrl: undefined,
+    /**
+     * The url of your Transmission RPC interface.
+     * Usually ends with "/transmission/rpc".
+     * Only relevant with action: "inject".
+     * Supply your username and password inside the url like so:
+     * "http://username:password@localhost:9091/transmission/rpc"
+     */
+    transmissionRpcUrl: undefined,
+    /**
+     * The url of your Deluge JSON-RPC interface.
+     * Usually ends with "/json".
+     * Only relevant with action: "inject".
+     * Supply your WebUI password as well like so:
+     * "http://:password@localhost:8112/json"
+     */
+    delugeRpcUrl: undefined,
+    /**
+     * END OF POTENTIALLY SENSITIVE CONFIGURATION OPTIONS
+     */
+    /**
+     * Pause at least this many seconds in between each search. Higher is safer
+     * for you and friendlier for trackers.
+     * Minimum value of 10.
+     */
+    delay: 30,
+    /**
+     * To search with already downloaded data, you can enter in the directories
+     * to your downloaded torrent data to find matches, rather than relying
+     * entirely on the .torrent files themselves for matching.
+     *
+     * If directories are entered, they must all be on the one line and they
+     * need to be surrounded by brackets.
+     * Windows users will need to use double backslash in all paths in this
+     * config.
      *
-     * If enabled, this needs to be surrounded by brackets. Windows users will need to use
-     * double backslash in all paths in this config.
-     * e.g.
-     * 		dataDirs: ["/path/here"],
-     * 		dataDirs: ["/path/here", "/other/path/here"],
-     * 		dataDirs: ["C:\\My Data\\Downloads"]
+     * example:
+     *     dataDirs: ["/downloads/movies", "/downloads/packs"],
+     * or for windows users
+     *     dataDirs: ["C:\\My Data\\Downloads\\Movies"],
      */
-    dataDirs: undefined,
+    dataDirs: [],
     /**
-     * Determines flexibility of naming during matching. "safe" will allow only perfect name matches
-     * using the standard matching algorithm. "risky" uses filesize as its only comparison point.
-     * Options: "safe", "risky"
+     * Determines flexibility of naming during matching.
+     * "safe" will allow only perfect name/size matches using the standard
+     * matching algorithm.
+     * "risky" uses filesize as its only comparison point.
+     * "partial" is like risky but allows matches if they are missing small
+     * files like .nfo/.srt.
+     * Options: "safe", "risky", "partial".
      */
     matchMode: "safe",
     /**
-     * Defines what category torrents injected by data-based matching should use.
-     * Default is "cross-seed-data"
+     * Defines what category torrents injected by data-based matching should
+     * use.
+     * Default is "cross-seed-data".
      */
     dataCategory: undefined,
     /**
-     * If this is specified, cross-seed will create links to scanned files in the specified directory.
-     * It will create a different link for every changed file name or directory structure.
+     * If this is specified, cross-seed will create links to matched files in
+     * the specified directory.
+     * It will create a different link for every changed file name or directory
+     * structure.
+     *
+     * Unlike dataDirs, this is just a quoted string WITHOUT []'s around it.
+     *
+     * IF YOU ARE USING HARDLINKS, THIS MUST BE UNDER THE SAME VOLUME AS YOUR
+     * DATADIRS. THIS PATH MUST ALSO BE ACCESSIBLE VIA YOUR TORRENT CLIENT
+     * USING THE SAME PATH.
      */
     linkDir: undefined,
     /**
-     * cross-seed will use links of this type to inject data-based matches into your client.
-     * Only relevant if dataDirs is specified.
-     * Options: "symlink", "hardlink"
+     * cross-seed will use links of this type to inject data-based matches into
+     * your client.
+     * https://www.cross-seed.org/docs/basics/faq-troubleshooting#what-linktype-should-i-use
+     * Options: "symlink", "hardlink".
+     */
+    linkType: "hardlink",
+    /**
+     * Enabling this will link files using v5's flat folder style. This option
+     * is necessary if you prefer flat folders of files or use qBittorrent and
+     * Automatic Torrent Management.
+     *
+     * Otherwise each individual Torznab tracker's cross-seeds will have it's
+     * own folder with the tracker's name and it's links within it.
+     *
+     * Default: false.
      */
-    linkType: "symlink",
+    legacyLinking: false,
     /**
-     * Whether to skip recheck in Qbittorrent. If using "risky" matchMode it is HIGHLY
-     * recommended to set this to false.
-     * Only applies to data based matches.
+     * Whether to skip recheck in qBittorrent or Deluge. Not supported in rTorrent/Transmission.
      */
-    skipRecheck: false,
+    skipRecheck: true,
     /**
-     * Determines how deep into the specified dataDirs to go to generate new searchees.
-     * Setting this to higher values will result in more searchees and more API hits to
-     * your indexers.
+     * Determines how deep into the specified dataDirs to go to generate new
+     * searchees. Setting this to higher values will result in more searchees
+     * and more API hits to your indexers.
      */
-    maxDataDepth: 2,
+    maxDataDepth: 1,
     /**
      * Directory containing .torrent files.
-     * For qBittorrent, this is BT_Backup
-     * For rtorrent, this is your session directory
-     * 		as configured in your .rtorrent.rc file.
+     * For qBittorrent, this is BT_Backup.
+     * For rtorrent, this is your session directory as configured in your
+     * .rtorrent.rc file.
      * For Deluge, this is ~/.config/deluge/state.
-     * For Transmission, this would be ~/.config/transmission/torrents
+     * For Transmission, this would be ~/.config/transmission/torrents.
      */
     torrentDir: "/path/to/torrent/file/dir",
     /**
-     * Where to put the torrent files that cross-seed finds for you.
+     * Where to save the torrent files that cross-seed finds for you.
      */
     outputDir: ".",
     /**
-     * Whether to search for all episode torrents, including those from season packs. This option overrides includeSingleEpisodes.
+     * Whether to search for all episode torrents, including those from season
+     * packs.
+     * This option overrides includeSingleEpisodes.
      */
     includeEpisodes: false,
     /**
-     * Whether to include single episode torrents in the search (not from season packs).
+     * Whether to include single episode torrents in the search (not those from
+     * season packs).
      * Like `includeEpisodes` but slightly more restrictive.
      */
     includeSingleEpisodes: false,
     /**
-     * Include torrents which contain non-video files
+     * Include torrents which contain non-video files.
      * This option does not override includeEpisodes or includeSingleEpisodes.
      *
-     * To search for everything except episodes, use (includeEpisodes: false, includeSingleEpisodes: false, includeNonVideos: true)
-     * To search for everything including episodes, use (includeEpisodes: true, includeNonVideos: true)
-     * To search for everything except season pack episodes (data-based)
-     *    use (includeEpisodes: false, includeSingleEpisodes: true, includeNonVideos: true)
+     * If this option is set to false, any folders or torrents containing ANY
+     * non-video files will automatically be excluded from cross-seed searches.
+     *
+     * For example, if you have .srt or .nfo files inside your folders/torrents
+     * you would set this as true.
+     * For full disc based folders (not .ISO) you may wish to set this as true.
+     * You may also want to set this as false to exclude things like music,
+     * games, or books.
+     *
+     * To search for everything except episodes, use:
+     *
+     *		includeEpisodes: false
+     *		includeSingleEpisodes: false
+     *		includeNonVideos: true
+     *
+     * To search for everything including episodes, use:
+     *
+     *		includeEpisodes: true
+     *		includeNonVideos: true
+     *
+     * To search for everything except season pack episodes (data-based) use:
+     *
+     *		includeEpisodes: false
+     *		includeSingleEpisodes: true
+     *		includeNonVideos: true
+     *
      */
     includeNonVideos: false,
     /**
-     * fuzzy size match threshold
+     * You should NOT modify this unless you have good reason.
+     * The following option is the preliminary value to compare sizes of
+     * releases for further comparison.
+     *
      * decimal value (0.02 = 2%)
      */
     fuzzySizeThreshold: 0.02,
     /**
-     * Exclude torrents first seen more than this long ago.
-     * Format: https://github.com/vercel/ms
-     * Examples:
-     * "10min"
-     * "2w"
-     * "3 days"
+     * Time based options below use the following format:
+     * https://github.com/vercel/ms
      */
-    excludeOlder: undefined,
     /**
-     * Exclude torrents which have been searched
-     * more recently than this long ago.
+     * Exclude torrents first seen by cross-seed more than this long ago.
      * Examples:
-     * "10min"
-     * "2w"
-     * "3 days"
+     * "10 minutes"
+     * "1 day"
+     * "0" - this will search everything exactly once, never more.
      */
-    excludeRecentSearch: undefined,
+    excludeOlder: "2 weeks",
     /**
-     * With "inject" you need to set up one of the below clients.
-     * Options: "save", "inject"
-     */
-    action: "save",
-    /**
-     * The url of your rtorrent XMLRPC interface.
-     * Only relevant with action: "inject".
-     * Could be something like "http://username:password@localhost:1234/RPC2
-     */
-    rtorrentRpcUrl: undefined,
-    /**
-     * The url of your qBittorrent webui.
-     * Only relevant with action: "inject".
-     * Supply your username and password inside the url like so:
-     * "http://username:password@localhost:8080"
-     */
-    qbittorrentUrl: undefined,
-    /**
-     * The url of your Transmission RPC interface.
-     * Usually ends with "/transmission/rpc".
-     * Only relevant with action: "inject".
-     * Supply your username and password inside the url like so:
-     * "http://username:password@localhost:9091/transmission/rpc"
+     * Exclude torrents which have been searched more recently than this long
+     * ago.
+     * Doesn't exclude previously failed searches.
+     * Examples:
+     * "2 days"
+     * "1 year"
      */
-    transmissionRpcUrl: undefined,
+    excludeRecentSearch: "3 days",
     /**
-     * The url of your Deluge JSON-RPC interface.
-     * Usually ends with "/json".
-     * Only relevant with action: "inject".
-     * Supply your WebUI password as well
-     * "http://:password@localhost:8112/json"
+     * What action to take upon a match being found.
+     * Options: "save", "inject".
      */
-    delugeRpcUrl: undefined,
+    action: "inject",
     /**
-     * qBittorrent and Deluge specific
-     * Whether to inject using the same labels/categories as the original torrent.
-     * qBittorrent: This will apply the category's save path
-     * Example: if you have a label/category called "Movies",
-     * this will automatically inject cross-seeds to "Movies.cross-seed"
+     * qBittorrent and Deluge specific.
+     * Whether to inject using the same labels/categories as the original
+     * torrent.
+     * qBittorrent: This will apply the category's save path.
+     * Example: if you have a label/category called "Movies", this will
+     * automatically inject cross-seeds to "Movies.cross-seed".
      */
     duplicateCategories: false,
     /**
-     * cross-seed will send POST requests to this url
-     * with a JSON payload of { title, body }.
-     * Conforms to the caronc/apprise REST API.
-     */
-    notificationWebhookUrl: undefined,
-    /**
-     * Listen on a custom port.
-     */
-    port: 2468,
-    /**
-     * Bind to a specific host address.
-     * Example: "127.0.0.1"
-     * Default is "0.0.0.0"
-     */
-    host: undefined,
-    /**
-     * Whether to require authentication for API.
-     * Run the command `cross-seed api-key` to find your api key.
-     * Keys can be provided in an X-Api-Key HTTP header or a query param.
-     */
-    apiAuth: true,
-    /**
-     * Run rss scans on a schedule. Format: https://github.com/vercel/ms
+     * Run rss scans on a schedule.
      * Set to undefined or null to disable. Minimum of 10 minutes.
      * Examples:
-     * "10min"
-     * "2w"
-     * "3 days"
+     * "10 minutes"
+     * "1 hour"
      */
-    rssCadence: undefined,
+    rssCadence: "30 minutes",
     /**
-     * Run searches on a schedule. Format: https://github.com/vercel/ms
+     * Run searches on a schedule.
      * Set to undefined or null to disable. Minimum of 1 day.
-     * If you have RSS enabled, you won't need this to run often (2+ weeks recommended)
      * Examples:
-     * "10min"
-     * "2w"
+     * "2 weeks"
      * "3 days"
      */
-    searchCadence: undefined,
+    searchCadence: "1 day",
     /**
      * Fail snatch requests that haven't responded after this long.
      * Set to null for an infinite timeout.
-     * Format: https://github.com/vercel/ms
      * Examples:
-     * "30sec"
-     * "10s"
-     * "1min"
+     * "30 seconds"
      * null
      */
     snatchTimeout: undefined,
     /**
      * Fail search requests that haven't responded after this long.
      * Set to null for an infinite timeout.
-     * Format: https://github.com/vercel/ms
      * Examples:
-     * "30sec"
-     * "10s"
-     * "1min"
+     * "30 seconds"
      * null
      */
     searchTimeout: undefined,
     /**
-     * The number of searches to be done before it stops.
-     * Combine this with "excludeRecentSearch" and "searchCadence" to smooth long-term API usage patterns.
-     * Default is no limit.
+     * The number of searches to make in one run/batch.
+     * If more than this many searches are queued,
+     * "searchCadence" will determine how long until the next batch.
+     *
+     * Combine this with "excludeRecentSearch" and "searchCadence" to smooth
+     * long-term API usage patterns.
+     *
+     * Set to null for no limit.
+     */
+    searchLimit: 100,
+    /**
+     * The list of infohashes or strings which are contained in torrents that
+     * you want to be excluded from cross-seed. This is the same format as
+     * torznab, surround the entire set of quoted strings in square brackets
+     * You can use any combination which must be entered on the one line.
+     * Leave as undefined to disable.
+     *
+     * examples:
+     *
+     *		blockList: ["-excludedGroup", "-excludedGroup2"],
+     *		blocklist: ["x265"],
+     *		blocklist: ["Release.Name"],
+     *		blocklist: ["3317e6485454354751555555366a8308c1e92093"],
+     */
+    blockList: undefined,
+    /**
+     * Provide your own API key here to override the autogenerated one.
+     * Not recommended - prefer using the autogenerated API key via
+     * `cross-seed api-key`.
+     * Must be 24+ characters.
      */
-    searchLimit: undefined,
+    apiKey: undefined,
 };
 //# sourceMappingURL=config.template.cjs.map

package/dist/config.template.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"config.template.cjs","sourceRoot":"","sources":["../src/config.template.cjs"],"names":[],"mappings":";AAAA,4EAA4E;AAC5E,wBAAwB;;AAExB,MAAM,CAAC,OAAO,GAAG;IAChB;;;OAGG;IACH,KAAK,EAAE,EAAE;IAET;;;;;OAKG;IACH,OAAO,EAAE,EAAE;IAEX;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,SAAS;IAEnB;;;;OAIG;IACH,SAAS,EAAE,MAAM;IAEjB;;;OAGG;IACH,YAAY,EAAE,SAAS;IAEvB;;;OAGG;IACH,OAAO,EAAE,SAAS;IAElB;;;;OAIG;IACH,QAAQ,EAAE,SAAS;IAEnB;;;;OAIG;IACH,WAAW,EAAE,KAAK;IAElB;;;;OAIG;IACH,YAAY,EAAE,CAAC;IAEf;;;;;;;OAOG;IACH,UAAU,EAAE,2BAA2B;IAEvC;;OAEG;IACH,SAAS,EAAE,GAAG;IAEd;;OAEG;IACH,eAAe,EAAE,KAAK;IAEtB;;;OAGG;IACH,qBAAqB,EAAE,KAAK;IAE5B;;;;;;;;OAQG;IACH,gBAAgB,EAAE,KAAK;IAEvB;;;OAGG;IACH,kBAAkB,EAAE,IAAI;IAExB;;;;;;;OAOG;IACH,YAAY,EAAE,SAAS;IAEvB;;;;;;;OAOG;IACH,mBAAmB,EAAE,SAAS;IAE9B;;;OAGG;IACH,MAAM,EAAE,MAAM;IAEd;;;;OAIG;IACH,cAAc,EAAE,SAAS;IAEzB;;;;;OAKG;IACH,cAAc,EAAE,SAAS;IAEzB;;;;;;OAMG;IACH,kBAAkB,EAAE,SAAS;IAE7B;;;;;;OAMG;IACH,YAAY,EAAE,SAAS;IAEvB;;;;;;OAMG;IACH,mBAAmB,EAAE,KAAK;IAE1B;;;;OAIG;IACH,sBAAsB,EAAE,SAAS;IAEjC;;OAEG;IACH,IAAI,EAAE,IAAI;IAEV;;;;OAIG;IACH,IAAI,EAAE,SAAS;IAEf;;;;OAIG;IACH,OAAO,EAAE,IAAI;IAEb;;;;;;;OAOG;IACH,UAAU,EAAE,SAAS;IAErB;;;;;;;;OAQG;IACH,aAAa,EAAE,SAAS;IAExB;;;;;;;;;OASG;IACH,aAAa,EAAE,SAAS;IAExB;;;;;;;;;OASG;IACH,aAAa,EAAE,SAAS;IAExB;;;;OAIG;IACH,WAAW,EAAE,SAAS;CACtB,CAAC"}
+{"version":3,"file":"config.template.cjs","sourceRoot":"","sources":["../src/config.template.cjs"],"names":[],"mappings":";AAAA,+EAA+E;AAC/E,qBAAqB;;AAErB,MAAM,CAAC,OAAO,GAAG;IAChB;;;;;;;;QAQI;IAEJ;;;;;;OAMG;IACH,OAAO,EAAE,EAAE;IAEX;;;;OAIG;IACH,IAAI,EAAE,SAAS;IAEf;;OAEG;IACH,IAAI,EAAE,IAAI;IAEV;;;OAGG;IACH,sBAAsB,EAAE,SAAS;IAEjC;;;;OAIG;IACH,cAAc,EAAE,SAAS;IAEzB;;;;;OAKG;IACH,cAAc,EAAE,SAAS;IAEzB;;;;;;OAMG;IACH,kBAAkB,EAAE,SAAS;IAE7B;;;;;;OAMG;IACH,YAAY,EAAE,SAAS;IAEvB;;OAEG;IAEH;;;;OAIG;IACH,KAAK,EAAE,EAAE;IAET;;;;;;;;;;;;;;OAcG;IACH,QAAQ,EAAE,EAAE;IAEZ;;;;;;;;OAQG;IACH,SAAS,EAAE,MAAM;IAEjB;;;;OAIG;IACH,YAAY,EAAE,SAAS;IAEvB;;;;;;;;;;;OAWG;IACH,OAAO,EAAE,SAAS;IAElB;;;;;OAKG;IACH,QAAQ,EAAE,UAAU;IAEpB;;;;;;;;;OASG;IACH,aAAa,EAAE,KAAK;IAEpB;;OAEG;IACH,WAAW,EAAE,IAAI;IAEjB;;;;OAIG;IACH,YAAY,EAAE,CAAC;IAEf;;;;;;;OAOG;IACH,UAAU,EAAE,2BAA2B;IAEvC;;OAEG;IACH,SAAS,EAAE,GAAG;IAEd;;;;OAIG;IACH,eAAe,EAAE,KAAK;IAEtB;;;;OAIG;IACH,qBAAqB,EAAE,KAAK;IAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,gBAAgB,EAAE,KAAK;IAEvB;;;;;;OAMG;IACH,kBAAkB,EAAE,IAAI;IAExB;;;OAGG;IAEH;;;;;;OAMG;IACH,YAAY,EAAE,SAAS;IAEvB;;;;;;;OAOG;IACH,mBAAmB,EAAE,QAAQ;IAE7B;;;OAGG;IACH,MAAM,EAAE,QAAQ;IAEhB;;;;;;;OAOG;IACH,mBAAmB,EAAE,KAAK;IAE1B;;;;;;OAMG;IACH,UAAU,EAAE,YAAY;IAExB;;;;;;OAMG;IACH,aAAa,EAAE,OAAO;IAEtB;;;;;;OAMG;IACH,aAAa,EAAE,SAAS;IAExB;;;;;;OAMG;IACH,aAAa,EAAE,SAAS;IAExB;;;;;;;;;OASG;IACH,WAAW,EAAE,GAAG;IAEhB;;;;;;;;;;;;;OAaG;IACH,SAAS,EAAE,SAAS;IAEpB;;;;;OAKG;IACH,MAAM,EAAE,SAAS;CACjB,CAAC"}

package/dist/configSchema.js

@@ -0,0 +1,184 @@
+import ms from "ms";
+import { sep } from "path";
+import { z } from "zod";
+import { Action, LinkType, MatchMode } from "./constants.js";
+import { logger } from "./logger.js";
+/**
+ * error messages and map returned upon Zod validation failure
+ */
+const ZodErrorMessages = {
+    vercel: "format does not follow vercel's `ms` style ( https://github.com/vercel/ms#examples )",
+    emptyString: "cannot have an empty string. If you want to unset it, use null or undefined.",
+    delay: "delay is in seconds, you can't travel back in time.",
+    fuzzySizeThreshold: "fuzzySizeThreshold must be between 0 and 1.",
+    injectUrl: "You need to specify rtorrentRpcUrl, transmissionRpcUrl, qbittorrentUrl, or delugeRpcUrl when using 'inject'",
+    recheckWarn: "It is strongly recommended to not skip rechecking for risky or partial matching mode.",
+    windowsPath: `Your path is not formatted properly for Windows. Please use "\\\\" or "/" for directory separators.`,
+    qBitLegacyLinking: "Using Automatic Torrent Management in qBittorrent without legacyLinking enabled can result in injection path failures.",
+    needsLinkDir: "You need to set a linkDir for risky or partial matching to work.",
+};
+/**
+ * custom zod error map for logging
+ * @param error ZodIssue messaging object
+ * @param ctx ZodError map
+ * @returns (the custom error for config display)
+ */
+export function customizeErrorMessage(error, ctx) {
+    switch (error.code) {
+        case z.ZodIssueCode.invalid_union:
+            return {
+                message: error.unionErrors
+                    .reduce((acc, error) => {
+                    error.errors.forEach((x) => acc.push(x.message));
+                    return acc;
+                }, [])
+                    .join("; "),
+            };
+    }
+    return { message: ctx.defaultError };
+}
+/**
+ * adds an issue in Zod's error mapped formatting
+ * @param setting the value of the setting
+ * @param errorMessage the error message to append on a newline
+ * @param ctx ZodError map
+ */
+function addZodIssue(setting, errorMessage, ctx) {
+    ctx.addIssue({
+        code: "custom",
+        message: `Setting: "${setting}"\n\t${errorMessage}`,
+    });
+}
+/**
+ * helper function for ms time validation
+ * @return transformed duration (string -> milliseconds)
+ */
+function transformDurationString(durationStr, ctx) {
+    const duration = ms(durationStr);
+    if (isNaN(duration)) {
+        // adds the error to the Zod Issues
+        addZodIssue(durationStr, ZodErrorMessages.vercel, ctx);
+    }
+    return duration;
+}
+/**
+ * helper function for directory validation
+ * @return path if valid formatting
+ */
+function checkValidPathFormat(path, ctx) {
+    if (sep === "\\" && !path.includes("\\") && !path.includes("/")) {
+        addZodIssue(path, ZodErrorMessages.windowsPath, ctx);
+    }
+    return path;
+}
+/**
+ * an object of the zod schema
+ * each are named after what they are intended to validate
+ */
+export const VALIDATION_SCHEMA = z
+    .object({
+    delay: z.number().nonnegative({
+        message: ZodErrorMessages.delay,
+    }),
+    torznab: z.array(z.string().url()),
+    dataDirs: z
+        .array(z
+        .string()
+        .transform((value, ctx) => value && value.length > 0
+        ? checkValidPathFormat(value, ctx)
+        : null))
+        .nullish(),
+    matchMode: z.nativeEnum(MatchMode),
+    dataCategory: z.string().nullish(),
+    linkDir: z.string().transform(checkValidPathFormat).nullish(),
+    linkType: z.nativeEnum(LinkType),
+    legacyLinking: z
+        .boolean()
+        .nullish()
+        .transform((value) => (typeof value === "boolean" ? value : false)),
+    skipRecheck: z.boolean(),
+    maxDataDepth: z.number().gte(1),
+    torrentDir: z.string().nullish(),
+    outputDir: z.string(),
+    includeEpisodes: z.boolean(),
+    includeSingleEpisodes: z.boolean(),
+    includeNonVideos: z.boolean(),
+    fuzzySizeThreshold: z.number().positive().lte(1, {
+        message: ZodErrorMessages.fuzzySizeThreshold,
+    }),
+    excludeOlder: z
+        .string()
+        .min(1, { message: ZodErrorMessages.emptyString })
+        .transform(transformDurationString)
+        .nullish(),
+    excludeRecentSearch: z
+        .string()
+        .min(1, { message: ZodErrorMessages.emptyString })
+        .transform(transformDurationString)
+        .nullish(),
+    action: z.nativeEnum(Action),
+    qbittorrentUrl: z.string().url().nullish(),
+    rtorrentRpcUrl: z.string().url().nullish(),
+    transmissionRpcUrl: z.string().url().nullish(),
+    delugeRpcUrl: z.string().url().nullish(),
+    duplicateCategories: z.boolean(),
+    notificationWebhookUrl: z.string().url().nullish(),
+    port: z
+        .number()
+        .positive()
+        .lte(65535)
+        .or(z.literal(false).transform(() => null))
+        .nullish(),
+    host: z.string().ip().nullish(),
+    rssCadence: z
+        .string()
+        .min(1, { message: ZodErrorMessages.emptyString })
+        .transform(transformDurationString)
+        .nullish(),
+    searchCadence: z
+        .string()
+        .min(1, { message: ZodErrorMessages.emptyString })
+        .transform(transformDurationString)
+        .nullish(),
+    snatchTimeout: z
+        .string()
+        .min(1, { message: ZodErrorMessages.emptyString })
+        .transform(transformDurationString)
+        .nullish(),
+    searchTimeout: z
+        .string()
+        .min(1, { message: ZodErrorMessages.emptyString })
+        .transform(transformDurationString)
+        .nullish(),
+    searchLimit: z.number().nonnegative().nullish(),
+    verbose: z.boolean(),
+    torrents: z.array(z.string()).optional(),
+    blockList: z
+        .array(z.string())
+        .nullish()
+        .transform((value) => (Array.isArray(value) ? value : [])),
+    apiKey: z.string().min(24).nullish(),
+})
+    .strict()
+    .refine((config) => {
+    if (config.action === Action.INJECT &&
+        config.qbittorrentUrl &&
+        !config.legacyLinking &&
+        config.linkDir) {
+        logger.warn(ZodErrorMessages.qBitLegacyLinking);
+    }
+    return true;
+})
+    .refine((config) => !(config.action === Action.INJECT &&
+    !config.rtorrentRpcUrl &&
+    !config.qbittorrentUrl &&
+    !config.transmissionRpcUrl &&
+    !config.delugeRpcUrl), ZodErrorMessages.injectUrl)
+    .refine((config) => {
+    if (config.skipRecheck && config.matchMode !== MatchMode.SAFE) {
+        logger.warn(ZodErrorMessages.recheckWarn);
+    }
+    return true;
+})
+    .refine((config) => config.matchMode === MatchMode.SAFE || config.linkDir, ZodErrorMessages.needsLinkDir);
+//# sourceMappingURL=configSchema.js.map

package/dist/configSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configSchema.js","sourceRoot":"","sources":["../src/configSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAC3B,OAAO,EAA8B,CAAC,EAA2B,MAAM,KAAK,CAAC;AAC7E,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC;;GAEG;AACH,MAAM,gBAAgB,GAAG;IACxB,MAAM,EAAE,sFAAsF;IAC9F,WAAW,EACV,8EAA8E;IAC/E,KAAK,EAAE,qDAAqD;IAC5D,kBAAkB,EAAE,6CAA6C;IACjE,SAAS,EACR,6GAA6G;IAC9G,WAAW,EACV,uFAAuF;IACxF,WAAW,EAAE,qGAAqG;IAClH,iBAAiB,EAChB,wHAAwH;IACzH,YAAY,EACX,kEAAkE;CACnE,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CACpC,KAA8B,EAC9B,GAAgB;IAEhB,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACpB,KAAK,CAAC,CAAC,YAAY,CAAC,aAAa;YAChC,OAAO;gBACN,OAAO,EAAE,KAAK,CAAC,WAAW;qBACxB,MAAM,CAAW,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;oBAChC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;oBACjD,OAAO,GAAG,CAAC;gBACZ,CAAC,EAAE,EAAE,CAAC;qBACL,IAAI,CAAC,IAAI,CAAC;aACZ,CAAC;IACJ,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,YAAY,EAAE,CAAC;AACtC,CAAC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CACnB,OAAe,EACf,YAAoB,EACpB,GAAkB;IAElB,GAAG,CAAC,QAAQ,CAAC;QACZ,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,aAAa,OAAO,QAAQ,YAAY,EAAE;KACnD,CAAC,CAAC;AACJ,CAAC;AAED;;;GAGG;AAEH,SAAS,uBAAuB,CAAC,WAAmB,EAAE,GAAkB;IACvE,MAAM,QAAQ,GAAG,EAAE,CAAC,WAAW,CAAC,CAAC;IACjC,IAAI,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QACrB,mCAAmC;QACnC,WAAW,CAAC,WAAW,EAAE,gBAAgB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACxD,CAAC;IACD,OAAO,QAAQ,CAAC;AACjB,CAAC;AAED;;;GAGG;AACH,SAAS,oBAAoB,CAAC,IAAY,EAAE,GAAkB;IAC7D,IAAI,GAAG,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACjE,WAAW,CAAC,IAAI,EAAE,gBAAgB,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;IACtD,CAAC;IACD,OAAO,IAAI,CAAC;AACb,CAAC;AAED;;;GAGG;AAEH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAChC,MAAM,CAAC;IACP,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,WAAW,CAAC;QAC7B,OAAO,EAAE,gBAAgB,CAAC,KAAK;KAC/B,CAAC;IACF,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC;IAClC,QAAQ,EAAE,CAAC;SACT,KAAK,CACL,CAAC;SACC,MAAM,EAAE;SACR,SAAS,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CACzB,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QACxB,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,GAAG,CAAC;QAClC,CAAC,CAAC,IAAI,CACP,CACF;SAEA,OAAO,EAAE;IACX,SAAS,EAAE,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC;IAClC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE;IAClC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC,OAAO,EAAE;IAC7D,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC;IAChC,aAAa,EAAE,CAAC;SACd,OAAO,EAAE;SACT,OAAO,EAAE;SACT,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACpE,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE;IACxB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE;IAC5B,qBAAqB,EAAE,CAAC,CAAC,OAAO,EAAE;IAClC,gBAAgB,EAAE,CAAC,CAAC,OAAO,EAAE;IAC7B,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE;QAChD,OAAO,EAAE,gBAAgB,CAAC,kBAAkB;KAC5C,CAAC;IACF,YAAY,EAAE,CAAC;SACb,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,gBAAgB,CAAC,WAAW,EAAE,CAAC;SACjD,SAAS,CAAC,uBAAuB,CAAC;SAClC,OAAO,EAAE;IACX,mBAAmB,EAAE,CAAC;SACpB,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,gBAAgB,CAAC,WAAW,EAAE,CAAC;SACjD,SAAS,CAAC,uBAAuB,CAAC;SAClC,OAAO,EAAE;IACX,MAAM,EAAE,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC;IAC5B,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE;IAC1C,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE;IAC1C,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE;IAC9C,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE;IACxC,mBAAmB,EAAE,CAAC,CAAC,OAAO,EAAE;IAChC,sBAAsB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE;IAClD,IAAI,EAAE,CAAC;SACL,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,GAAG,CAAC,KAAK,CAAC;SACV,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;SAC1C,OAAO,EAAE;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE;IAC/B,UAAU,EAAE,CAAC;SACX,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,gBAAgB,CAAC,WAAW,EAAE,CAAC;SACjD,SAAS,CAAC,uBAAuB,CAAC;SAClC,OAAO,EAAE;IACX,aAAa,EAAE,CAAC;SACd,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,gBAAgB,CAAC,WAAW,EAAE,CAAC;SACjD,SAAS,CAAC,uBAAuB,CAAC;SAClC,OAAO,EAAE;IACX,aAAa,EAAE,CAAC;SACd,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,gBAAgB,CAAC,WAAW,EAAE,CAAC;SACjD,SAAS,CAAC,uBAAuB,CAAC;SAClC,OAAO,EAAE;IACX,aAAa,EAAE,CAAC;SACd,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,gBAAgB,CAAC,WAAW,EAAE,CAAC;SACjD,SAAS,CAAC,uBAAuB,CAAC;SAClC,OAAO,EAAE;IACX,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE;IAC/C,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACxC,SAAS,EAAE,CAAC;SACV,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,OAAO,EAAE;SACT,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC3D,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE;CACpC,CAAC;KACD,MAAM,EAAE;KACR,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE;IAClB,IACC,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM;QAC/B,MAAM,CAAC,cAAc;QACrB,CAAC,MAAM,CAAC,aAAa;QACrB,MAAM,CAAC,OAAO,EACb,CAAC;QACF,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;IACjD,CAAC;IACD,OAAO,IAAI,CAAC;AACb,CAAC,CAAC;KACD,MAAM,CACN,CAAC,MAAM,EAAE,EAAE,CACV,CAAC,CACA,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM;IAC/B,CAAC,MAAM,CAAC,cAAc;IACtB,CAAC,MAAM,CAAC,cAAc;IACtB,CAAC,MAAM,CAAC,kBAAkB;IAC1B,CAAC,MAAM,CAAC,YAAY,CACpB,EACF,gBAAgB,CAAC,SAAS,CAC1B;KACA,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE;IAClB,IAAI,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;QAC/D,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,IAAI,CAAC;AACb,CAAC,CAAC;KACD,MAAM,CACN,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,KAAK,SAAS,CAAC,IAAI,IAAI,MAAM,CAAC,OAAO,EACjE,gBAAgB,CAAC,YAAY,CAC7B,CAAC"}