booru 2.6.2 → 2.6.3

package/dist/index.js

@@ -1 +1,122 @@
-"use strict";var __importDefault=this&&this.__importDefault||function(r){return r&&r.__esModule?r:{default:r}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.BooruError=exports.resolveSite=exports.sites=exports.BooruClass=exports.commonfy=exports.search=exports.forSite=void 0;const Constants_1=require("./Constants"),util_1=require("util"),Booru_1=__importDefault(require("./boorus/Booru")),Derpibooru_1=__importDefault(require("./boorus/Derpibooru")),XmlBooru_1=__importDefault(require("./boorus/XmlBooru")),Site_1=__importDefault(require("./structures/Site")),Utils_1=require("./Utils"),BooruTypes={derpi:Derpibooru_1.default,xml:XmlBooru_1.default},booruCache={};function booruFrom(r,e){return new(void 0!==r.type&&BooruTypes[r.type]?BooruTypes[r.type]:Booru_1.default)(r,e)}function booruForSite(r,e){const o=(0,Utils_1.resolveSite)(r);if(!o)throw new Constants_1.BooruError("Site not supported");return booruFrom(new Site_1.default(Constants_1.sites[o]),e)}function search(r,e=[],{limit:o=1,random:t=!1,page:s=0,credentials:u={}}={}){const n=(0,Utils_1.resolveSite)(r);if("string"==typeof o&&(o=parseInt(o,10)),null===n)throw new Constants_1.BooruError("Site not supported");if(!Array.isArray(e)&&"string"!=typeof e)throw new Constants_1.BooruError("`tags` should be an array or string");if("number"!=typeof o||Number.isNaN(o))throw new Constants_1.BooruError("`limit` should be an int");const i=new Site_1.default(Constants_1.sites[n]);return booruCache[n]||(booruCache[n]=booruFrom(i,u)),booruCache[n].credentials=u,booruCache[n].search(e,{limit:o,random:t,page:s})}exports.forSite=booruForSite,exports.default=booruForSite,exports.search=search;const deprecatedCommonfy=(0,util_1.deprecate)((()=>{}),"Common is now deprecated, just access the properties directly");function commonfy(r){return deprecatedCommonfy(),Promise.resolve(r)}exports.commonfy=commonfy;var Booru_2=require("./boorus/Booru");Object.defineProperty(exports,"BooruClass",{enumerable:!0,get:function(){return Booru_2.Booru}});var Constants_2=require("./Constants");Object.defineProperty(exports,"sites",{enumerable:!0,get:function(){return Constants_2.sites}});var Utils_2=require("./Utils");Object.defineProperty(exports,"resolveSite",{enumerable:!0,get:function(){return Utils_2.resolveSite}});var Constants_3=require("./Constants");Object.defineProperty(exports,"BooruError",{enumerable:!0,get:function(){return Constants_3.BooruError}});
+"use strict";
+/**
+ * @packageDocumentation
+ * @module Index
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Site = exports.SearchResults = exports.Post = exports.XmlBooru = exports.Derpibooru = exports.BooruError = exports.resolveSite = exports.sites = exports.BooruClass = exports.commonfy = exports.search = exports.forSite = void 0;
+const Constants_1 = require("./Constants");
+const util_1 = require("util");
+const Booru_1 = __importDefault(require("./boorus/Booru"));
+const Derpibooru_1 = __importDefault(require("./boorus/Derpibooru"));
+exports.Derpibooru = Derpibooru_1.default;
+const XmlBooru_1 = __importDefault(require("./boorus/XmlBooru"));
+exports.XmlBooru = XmlBooru_1.default;
+const Post_1 = __importDefault(require("./structures/Post"));
+exports.Post = Post_1.default;
+const SearchResults_1 = __importDefault(require("./structures/SearchResults"));
+exports.SearchResults = SearchResults_1.default;
+const Site_1 = __importDefault(require("./structures/Site"));
+exports.Site = Site_1.default;
+const Utils_1 = require("./Utils");
+const BooruTypes = {
+    derpi: Derpibooru_1.default,
+    xml: XmlBooru_1.default,
+};
+const booruCache = {};
+/**
+ * Create a new booru, if special type, use that booru, else use default Booru
+ *
+ * @param booruSite The site to use
+ * @param credentials The credentials to use, if any
+ * @return A new booru
+ */
+function booruFrom(booruSite, credentials) {
+    return new (booruSite.type !== undefined && BooruTypes[booruSite.type]
+        ? BooruTypes[booruSite.type]
+        : Booru_1.default)(booruSite, credentials);
+}
+/**
+ * Create a new booru to search with
+ *
+ * @constructor
+ * @param {String} site The {@link Site} domain (or alias of it) to create a booru from
+ * @param {BooruCredentials} credentials The credentials to use on this booru
+ * @return {Booru} A booru to use
+ */
+function booruForSite(site, credentials) {
+    const rSite = (0, Utils_1.resolveSite)(site);
+    if (!rSite)
+        throw new Constants_1.BooruError('Site not supported');
+    const booruSite = new Site_1.default(Constants_1.sites[rSite]);
+    // If special type, use that booru, else use default Booru
+    return booruFrom(booruSite, credentials);
+}
+exports.forSite = booruForSite;
+exports.default = booruForSite;
+/**
+ * Searches a site for images with tags and returns the results
+ * @param {String} site The site to search
+ * @param {String[]|String} [tags=[]] Tags to search with
+ * @param {SearchParameters} [searchOptions={}] The options for searching
+ *  if provided (Unused)
+ * @return {Promise<SearchResults>} A promise with the images as an array of objects
+ *
+ * @example
+ * ```
+ * const Booru = require('booru')
+ * // Returns a promise with the latest cute glace pic from e926
+ * Booru.search('e926', ['glaceon', 'cute'])
+ * ```
+ */
+function search(site, tags = [], { limit = 1, random = false, page = 0, credentials = {} } = {}) {
+    const rSite = (0, Utils_1.resolveSite)(site);
+    if (typeof limit === 'string') {
+        limit = parseInt(limit, 10);
+    }
+    if (rSite === null) {
+        throw new Constants_1.BooruError('Site not supported');
+    }
+    if (!Array.isArray(tags) && typeof tags !== 'string') {
+        throw new Constants_1.BooruError('`tags` should be an array or string');
+    }
+    if (typeof limit !== 'number' || Number.isNaN(limit)) {
+        throw new Constants_1.BooruError('`limit` should be an int');
+    }
+    const booruSite = new Site_1.default(Constants_1.sites[rSite]);
+    if (!booruCache[rSite]) {
+        booruCache[rSite] = booruFrom(booruSite, credentials);
+    }
+    // This is ugly and a hack, I know this
+    booruCache[rSite].credentials = credentials;
+    return booruCache[rSite].search(tags, { limit, random, page });
+}
+exports.search = search;
+// eslint-disable-next-line no-empty,@typescript-eslint/no-empty-function
+const deprecatedCommonfy = (0, util_1.deprecate)(() => { }, 'Common is now deprecated, just access the properties directly');
+/**
+ * Deprecated, now a noop
+ * <p>This will be removed *soon* please stop using it</p>
+ * <p>Just access <code>&lt;{@link Post}&gt;.prop</code>, no need to commonfy anymore
+ *
+ * @deprecated Just use <code>&lt;{@link Post}&gt;.prop</code> instead
+ * @param  {Post[]} images   Array of {@link Post} objects
+ * @return {Promise<Post[]>} Array of {@link Post} objects
+ */
+function commonfy(images) {
+    deprecatedCommonfy();
+    return Promise.resolve(images);
+}
+exports.commonfy = commonfy;
+var Booru_2 = require("./boorus/Booru");
+Object.defineProperty(exports, "BooruClass", { enumerable: true, get: function () { return Booru_2.Booru; } });
+var Constants_2 = require("./Constants");
+Object.defineProperty(exports, "sites", { enumerable: true, get: function () { return Constants_2.sites; } });
+var Utils_2 = require("./Utils");
+Object.defineProperty(exports, "resolveSite", { enumerable: true, get: function () { return Utils_2.resolveSite; } });
+var Constants_3 = require("./Constants");
+Object.defineProperty(exports, "BooruError", { enumerable: true, get: function () { return Constants_3.BooruError; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,2CAAwD;AAExD,+BAAgC;AAChC,2DAAwD;AACxD,qEAA4C;AAC5C,iEAAwC;AAIxC,6DAAoC;AACpC,mCAAqC;AAErC,MAAM,UAAU,GAAiC;IAC/C,KAAK,EAAE,oBAAU;IACjB,GAAG,EAAE,kBAAQ;CACd,CAAA;AAED,MAAM,UAAU,GAAoC,EAAE,CAAA;AAEtD;;;;;;GAMG;AACH,SAAS,SAAS,CAAC,SAAe,EAAE,WAA8B;IAChE,OAAO,IAAI,CACT,SAAS,CAAC,IAAI,KAAK,SAAS,IAAI,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC;QACxD,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC;QAC5B,CAAC,CAAC,eAAK,CACV,CAAC,SAAS,EAAE,WAAW,CAAC,CAAA;AAC3B,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,YAAY,CAAC,IAAY,EAAE,WAA8B;IAChE,MAAM,KAAK,GAAG,IAAA,mBAAW,EAAC,IAAI,CAAC,CAAA;IAE/B,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,sBAAU,CAAC,oBAAoB,CAAC,CAAA;IAEtD,MAAM,SAAS,GAAG,IAAI,cAAI,CAAC,iBAAK,CAAC,KAAK,CAAC,CAAC,CAAA;IAExC,0DAA0D;IAC1D,OAAO,SAAS,CAAC,SAAS,EAAE,WAAW,CAAC,CAAA;AAC1C,CAAC;AAEwB,+BAAO;AAChC,kBAAe,YAAY,CAAA;AAM3B;;;;;;;;;;;;;;GAcG;AACH,SAAgB,MAAM,CACpB,IAAY,EACZ,OAA0B,EAAE,EAC5B,EAAE,KAAK,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,EAAE,IAAI,GAAG,CAAC,EAAE,WAAW,GAAG,EAAE,KAAkB,EAAE;IAE3E,MAAM,KAAK,GAAG,IAAA,mBAAW,EAAC,IAAI,CAAC,CAAA;IAE/B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;KAC5B;IAED,IAAI,KAAK,KAAK,IAAI,EAAE;QAClB,MAAM,IAAI,sBAAU,CAAC,oBAAoB,CAAC,CAAA;KAC3C;IAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QACpD,MAAM,IAAI,sBAAU,CAAC,qCAAqC,CAAC,CAAA;KAC5D;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;QACpD,MAAM,IAAI,sBAAU,CAAC,0BAA0B,CAAC,CAAA;KACjD;IAED,MAAM,SAAS,GAAG,IAAI,cAAI,CAAC,iBAAK,CAAC,KAAK,CAAC,CAAC,CAAA;IAExC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;QACtB,UAAU,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,SAAS,EAAE,WAAW,CAAC,CAAA;KACtD;IAED,uCAAuC;IACvC,UAAU,CAAC,KAAK,CAAE,CAAC,WAAW,GAAG,WAAW,CAAA;IAC5C,OAAO,UAAU,CAAC,KAAK,CAAE,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;AACjE,CAAC;AAhCD,wBAgCC;AAED,yEAAyE;AACzE,MAAM,kBAAkB,GAAG,IAAA,gBAAS,EAAC,GAAG,EAAE,GAAE,CAAC,EAC7C,+DAA+D,CAAC,CAAA;AAEhE;;;;;;;;GAQG;AACH,SAAgB,QAAQ,CAAC,MAAc;IACrC,kBAAkB,EAAE,CAAA;IACpB,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;AAChC,CAAC;AAHD,4BAGC;AAED,wCAAoD;AAA3C,mGAAA,KAAK,OAAc;AAC5B,yCAAmC;AAA1B,kGAAA,KAAK,OAAA;AACd,iCAAqC;AAA5B,oGAAA,WAAW,OAAA;AACpB,yCAAwC;AAA/B,uGAAA,UAAU,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,2CAAwD;AAExD,+BAAgC;AAChC,2DAAwD;AACxD,qEAA4C;AA+HnC,qBA/HF,oBAAU,CA+HE;AA9HnB,iEAAwC;AA8HnB,mBA9Hd,kBAAQ,CA8Hc;AA7H7B,6DAAoC;AA6HL,eA7HxB,cAAI,CA6HwB;AA3HnC,+EAAsD;AA2HjB,wBA3H9B,uBAAa,CA2H8B;AA1HlD,6DAAoC;AA0HgB,eA1H7C,cAAI,CA0H6C;AAzHxD,mCAAqC;AAErC,MAAM,UAAU,GAAiC;IAC/C,KAAK,EAAE,oBAAU;IACjB,GAAG,EAAE,kBAAQ;CACd,CAAA;AAED,MAAM,UAAU,GAAoC,EAAE,CAAA;AAEtD;;;;;;GAMG;AACH,SAAS,SAAS,CAAC,SAAe,EAAE,WAA8B;IAChE,OAAO,IAAI,CACT,SAAS,CAAC,IAAI,KAAK,SAAS,IAAI,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC;QACxD,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC;QAC5B,CAAC,CAAC,eAAK,CACV,CAAC,SAAS,EAAE,WAAW,CAAC,CAAA;AAC3B,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,YAAY,CAAC,IAAY,EAAE,WAA8B;IAChE,MAAM,KAAK,GAAG,IAAA,mBAAW,EAAC,IAAI,CAAC,CAAA;IAE/B,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,sBAAU,CAAC,oBAAoB,CAAC,CAAA;IAEtD,MAAM,SAAS,GAAG,IAAI,cAAI,CAAC,iBAAK,CAAC,KAAK,CAAC,CAAC,CAAA;IAExC,0DAA0D;IAC1D,OAAO,SAAS,CAAC,SAAS,EAAE,WAAW,CAAC,CAAA;AAC1C,CAAC;AAEwB,+BAAO;AAChC,kBAAe,YAAY,CAAA;AAM3B;;;;;;;;;;;;;;GAcG;AACH,SAAgB,MAAM,CACpB,IAAY,EACZ,OAA0B,EAAE,EAC5B,EAAE,KAAK,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,EAAE,IAAI,GAAG,CAAC,EAAE,WAAW,GAAG,EAAE,KAAkB,EAAE;IAE3E,MAAM,KAAK,GAAG,IAAA,mBAAW,EAAC,IAAI,CAAC,CAAA;IAE/B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;KAC5B;IAED,IAAI,KAAK,KAAK,IAAI,EAAE;QAClB,MAAM,IAAI,sBAAU,CAAC,oBAAoB,CAAC,CAAA;KAC3C;IAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QACpD,MAAM,IAAI,sBAAU,CAAC,qCAAqC,CAAC,CAAA;KAC5D;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;QACpD,MAAM,IAAI,sBAAU,CAAC,0BAA0B,CAAC,CAAA;KACjD;IAED,MAAM,SAAS,GAAG,IAAI,cAAI,CAAC,iBAAK,CAAC,KAAK,CAAC,CAAC,CAAA;IAExC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;QACtB,UAAU,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,SAAS,EAAE,WAAW,CAAC,CAAA;KACtD;IAED,uCAAuC;IACvC,UAAU,CAAC,KAAK,CAAE,CAAC,WAAW,GAAG,WAAW,CAAA;IAC5C,OAAO,UAAU,CAAC,KAAK,CAAE,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;AACjE,CAAC;AAhCD,wBAgCC;AAED,yEAAyE;AACzE,MAAM,kBAAkB,GAAG,IAAA,gBAAS,EAAC,GAAG,EAAE,GAAE,CAAC,EAC7C,+DAA+D,CAAC,CAAA;AAEhE;;;;;;;;GAQG;AACH,SAAgB,QAAQ,CAAC,MAAc;IACrC,kBAAkB,EAAE,CAAA;IACpB,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;AAChC,CAAC;AAHD,4BAGC;AAED,wCAAoD;AAA3C,mGAAA,KAAK,OAAc;AAC5B,yCAAmC;AAA1B,kGAAA,KAAK,OAAA;AACd,iCAAqC;AAA5B,oGAAA,WAAW,OAAA;AACpB,yCAAwC;AAA/B,uGAAA,UAAU,OAAA"}

package/dist/sites.json

@@ -1 +1 @@
-{"e621.net":{"domain":"e621.net","aliases":["e6","e621"],"nsfw":true,"api":{"search":"/posts.json?","postView":"/post/show/"},"random":true},"e926.net":{"domain":"e926.net","aliases":["e9","e926"],"nsfw":false,"api":{"search":"/posts.json?","postView":"/post/show/"},"random":true,"defaultTags":["rating:safe"]},"hypnohub.net":{"domain":"hypnohub.net","aliases":["hh","hypno","hypnohub"],"nsfw":true,"api":{"search":"/index.php?page=dapi&s=post&q=index&json=1&","postView":"/post/show/"},"paginate":"pid","random":true},"danbooru.donmai.us":{"domain":"danbooru.donmai.us","aliases":["db","dan","danbooru"],"nsfw":true,"api":{"search":"/posts.json?","postView":"/posts/"},"random":true},"konachan.com":{"domain":"konachan.com","aliases":["kc","konac","kcom"],"nsfw":true,"api":{"search":"/post.json?","postView":"/post/show/"},"random":true},"konachan.net":{"domain":"konachan.net","aliases":["kn","konan","knet"],"nsfw":false,"api":{"search":"/post.json?","postView":"/post/show/"},"random":true},"yande.re":{"domain":"yande.re","aliases":["yd","yand","yandere"],"nsfw":true,"api":{"search":"/post.json?","postView":"/post/show/"},"random":true},"gelbooru.com":{"domain":"gelbooru.com","aliases":["gb","gel","gelbooru"],"nsfw":true,"api":{"search":"/index.php?page=dapi&s=post&q=index&json=1&","postView":"/index.php?page=post&s=view&json=1&id="},"paginate":"pid","random":false},"rule34.xxx":{"domain":"api.rule34.xxx","aliases":["r34","rule34"],"nsfw":true,"api":{"search":"/index.php?page=dapi&s=post&q=index&json=1&","postView":"/index.php?page=post&s=view&json=1&id="},"paginate":"pid","random":false},"safebooru.org":{"domain":"safebooru.org","aliases":["sb","safe","safebooru"],"nsfw":false,"api":{"search":"/index.php?page=dapi&s=post&q=index&json=1&","postView":"/index.php?page=post&s=view&json=1&id="},"paginate":"pid","random":false},"tbib.org":{"domain":"tbib.org","aliases":["tb","tbib","big"],"nsfw":false,"api":{"search":"/index.php?page=dapi&s=post&q=index&json=1&","postView":"/index.php?page=post&s=view&json=1&id="},"paginate":"pid","random":false},"xbooru.com":{"domain":"xbooru.com","aliases":["xb","xbooru"],"nsfw":true,"api":{"search":"/index.php?page=dapi&s=post&q=index&json=1&","postView":"/index.php?page=post&s=view&json=1&id="},"paginate":"pid","random":false},"rule34.paheal.net":{"domain":"rule34.paheal.net","type":"xml","aliases":["pa","paheal"],"nsfw":true,"api":{"search":"/api/danbooru/find_posts/index.xml?","postView":"/post/view/"},"random":false},"derpibooru.org":{"domain":"derpibooru.org","type":"derpi","aliases":["dp","derp","derpi","derpibooru"],"nsfw":true,"api":{"search":"/api/v1/json/search/images?","postView":"/images/"},"tagQuery":"q","tagJoin":",","random":"sf=random"},"realbooru.com":{"domain":"realbooru.com","aliases":["rb","realbooru"],"nsfw":true,"api":{"search":"/index.php?page=dapi&s=post&q=index&json=1&","postView":"/index.php?page=post&s=view&id="},"paginate":"pid","random":false}}
+{"e621.net":{"domain":"e621.net","aliases":["e6","e621"],"nsfw":true,"api":{"search":"/posts.json?","postView":"/post/show/"},"random":true},"e926.net":{"domain":"e926.net","aliases":["e9","e926"],"nsfw":false,"api":{"search":"/posts.json?","postView":"/post/show/"},"random":true,"defaultTags":["rating:safe"]},"hypnohub.net":{"domain":"hypnohub.net","aliases":["hh","hypno","hypnohub"],"nsfw":true,"api":{"search":"/index.php?page=dapi&s=post&q=index&json=1&","postView":"/post/show/"},"paginate":"pid","random":false},"danbooru.donmai.us":{"domain":"danbooru.donmai.us","aliases":["db","dan","danbooru"],"nsfw":true,"api":{"search":"/posts.json?","postView":"/posts/"},"random":true},"konachan.com":{"domain":"konachan.com","aliases":["kc","konac","kcom"],"nsfw":true,"api":{"search":"/post.json?","postView":"/post/show/"},"random":true},"konachan.net":{"domain":"konachan.net","aliases":["kn","konan","knet"],"nsfw":false,"api":{"search":"/post.json?","postView":"/post/show/"},"random":true},"yande.re":{"domain":"yande.re","aliases":["yd","yand","yandere"],"nsfw":true,"api":{"search":"/post.json?","postView":"/post/show/"},"random":true},"gelbooru.com":{"domain":"gelbooru.com","aliases":["gb","gel","gelbooru"],"nsfw":true,"api":{"search":"/index.php?page=dapi&s=post&q=index&json=1&","postView":"/index.php?page=post&s=view&json=1&id="},"paginate":"pid","random":false},"rule34.xxx":{"domain":"api.rule34.xxx","aliases":["r34","rule34"],"nsfw":true,"api":{"search":"/index.php?page=dapi&s=post&q=index&json=1&","postView":"/index.php?page=post&s=view&json=1&id="},"paginate":"pid","random":false},"safebooru.org":{"domain":"safebooru.org","aliases":["sb","safe","safebooru"],"nsfw":false,"api":{"search":"/index.php?page=dapi&s=post&q=index&json=1&","postView":"/index.php?page=post&s=view&json=1&id="},"paginate":"pid","random":false},"tbib.org":{"domain":"tbib.org","aliases":["tb","tbib","big"],"nsfw":false,"api":{"search":"/index.php?page=dapi&s=post&q=index&json=1&","postView":"/index.php?page=post&s=view&json=1&id="},"paginate":"pid","random":false},"xbooru.com":{"domain":"xbooru.com","aliases":["xb","xbooru"],"nsfw":true,"api":{"search":"/index.php?page=dapi&s=post&q=index&json=1&","postView":"/index.php?page=post&s=view&json=1&id="},"paginate":"pid","random":false},"rule34.paheal.net":{"domain":"rule34.paheal.net","type":"xml","aliases":["pa","paheal"],"nsfw":true,"api":{"search":"/api/danbooru/find_posts/index.xml?","postView":"/post/view/"},"random":false},"derpibooru.org":{"domain":"derpibooru.org","type":"derpi","aliases":["dp","derp","derpi","derpibooru"],"nsfw":true,"api":{"search":"/api/v1/json/search/images?","postView":"/images/"},"tagQuery":"q","tagJoin":",","random":"sf=random"},"realbooru.com":{"domain":"realbooru.com","aliases":["rb","realbooru"],"nsfw":true,"api":{"search":"/index.php?page=dapi&s=post&q=index&json=1&","postView":"/index.php?page=post&s=view&id="},"paginate":"pid","random":false}}

package/dist/structures/InternalSearchParameters.js

@@ -1 +1,7 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});
+"use strict";
+/**
+ * @packageDocumentation
+ * @module Structures
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=InternalSearchParameters.js.map

package/dist/structures/Post.js

@@ -1 +1,299 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});const util_1=require("util"),common=(0,util_1.deprecate)((()=>{}),"Common is now deprecated, just access the properties directly");function parseImageUrl(e,t,r){if(!e||""===e.trim()||t.is_deleted)return null;if(e.startsWith("/data")&&(e=`https://danbooru.donmai.us${e}`),e.startsWith("/cached")&&(e=`https://danbooru.donmai.us${e}`),e.startsWith("/_images")&&(e=`https://dollbooru.org${e}`),e.startsWith("//derpicdn.net")&&(e=`https:${t.image}`),!t.file_url&&void 0!==t.directory){const i=t.directory??`${t.hash.substr(0,2)}/${t.hash.substr(2,2)}`;e=`//${r.domain}/images/${i}/${t.image}`}return e.startsWith("http")||(e=`https:${e}`),encodeURI(e)}function getTags(e){let t=[];return Array.isArray(e.tags)?t=e.tags:e.tags&&e.tags.general?t=Object.values(e.tags).flat():"string"==typeof e.tags?t=fromTagString(e.tags):"string"==typeof e.tag_string&&(t=fromTagString(e.tag_string)),t.filter((e=>""!==e))}function fromTagString(e){return e.split(" ").map((e=>e.replace(/,/g,"")))}class Post{booru;fileUrl;height;width;sampleUrl;sampleHeight;sampleWidth;previewUrl;previewHeight;previewWidth;id;available;tags;score;source;rating;createdAt;data;constructor(e,t){this.data=e,this.booru=t;const r=e.is_deleted||e.is_banned;this.fileUrl=parseImageUrl(e.file_url||e.image||(r?e.source:void 0)||e.file&&e.file.url||e.representations&&e.representations.full,e,t),this.available=!r&&null!==this.fileUrl,this.height=parseInt(e.height||e.image_height||e.file&&e.file.height,10),this.width=parseInt(e.width||e.image_width||e.file&&e.file.width,10),this.sampleUrl=parseImageUrl(e.sample_url||e.large_file_url||e.representations&&e.representations.large||e.sample&&e.sample.url,e,t),this.sampleHeight=parseInt(e.sample_height||e.sample&&e.sample.height,10),this.sampleWidth=parseInt(e.sample_width||e.sample&&e.sample.width,10),this.previewUrl=parseImageUrl(e.preview_url||e.preview_file_url||e.representations&&e.representations.small||e.preview&&e.preview.url,e,t),this.previewHeight=parseInt(e.preview_height||e.preview&&e.preview.height,10),this.previewWidth=parseInt(e.preview_width||e.preview&&e.preview.width,10),this.id=e.id?e.id.toString():"No ID available",this.tags=getTags(e),e.score&&void 0!==e.score.total?this.score=e.score.total:this.score=e.score?parseInt(e.score,10):e.score,this.source=e.source||e.sources||e.source_url,this.rating=e.rating||/(safe|suggestive|questionable|explicit)/i.exec(e.tags)||"u",Array.isArray(this.rating)&&(this.rating=this.rating[0]),"suggestive"===this.rating&&(this.rating="q"),this.rating=this.rating.charAt(0),this.createdAt=null,"object"==typeof e.created_at?this.createdAt=new Date(1e3*e.created_at.s+e.created_at.n/1e9):"number"==typeof e.created_at?this.createdAt=new Date(1e3*e.created_at):"string"==typeof e.created_at?this.createdAt=new Date(e.created_at):"number"==typeof e.change?this.createdAt=new Date(1e3*e.change):this.createdAt=new Date(e.created_at||e.date)}get file_url(){return this.fileUrl}get sample_url(){return this.sampleUrl}get sample_height(){return this.sampleHeight}get sample_width(){return this.sampleWidth}get preview_url(){return this.previewUrl}get preview_height(){return this.previewHeight}get preview_width(){return this.previewWidth}get postView(){return this.booru.postView(this.id)}get common(){return common(),this}}exports.default=Post;
+"use strict";
+/**
+ * @packageDocumentation
+ * @module Structures
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("util");
+// eslint-disable-next-line no-empty,@typescript-eslint/no-empty-function
+const common = (0, util_1.deprecate)(() => { }, 'Common is now deprecated, just access the properties directly');
+/**
+ * Tries to figure out what the image url should be
+ *
+ * @param {string} url   why
+ * @param {*}      data  boorus
+ * @param {Booru}  booru so hard
+ */
+function parseImageUrl(url, data, booru) {
+    // If the image's file_url is *still* undefined or the source is empty or it's deleted
+    // Thanks danbooru *grumble grumble*
+    if (!url || url.trim() === '' || data.is_deleted) {
+        return null;
+    }
+    if (url.startsWith('/data')) {
+        url = `https://danbooru.donmai.us${url}`;
+    }
+    if (url.startsWith('/cached')) {
+        url = `https://danbooru.donmai.us${url}`;
+    }
+    if (url.startsWith('/_images')) {
+        url = `https://dollbooru.org${url}`;
+    }
+    if (url.startsWith('//derpicdn.net')) {
+        url = `https:${data.image}`;
+    }
+    // Why???
+    if (!data.file_url && data.directory !== undefined) {
+        // Danbooru-based boorus sometimes sort their files into directories
+        // There's 2 directories, one named after the first 2 characters of the hash
+        // and one named after the next 2 characters of the hash
+        // Sometimes we get it in the API response as `data.directory`, sometimes it's null
+        // for some ungodly reason
+        // I despise the danbooru api honestly
+        const directory = data.directory ?? `${data.hash.substr(0, 2)}/${data.hash.substr(2, 2)}`;
+        url = `//${booru.domain}/images/${directory}/${data.image}`;
+    }
+    if (!url.startsWith('http')) {
+        url = `https:${url}`;
+    }
+    return encodeURI(url);
+}
+/**
+ * Takes and transforms tags from the booru's api into a common format
+ * (which is an array of strings)
+ * @param {any} data The data from the booru
+ * @returns {string[]} The tags as a string array, and not just a string or an object
+ */
+function getTags(data) {
+    let tags = [];
+    if (Array.isArray(data.tags)) {
+        tags = data.tags;
+    }
+    else if (data.tags && data.tags.general) {
+        tags = Object.values(data.tags).flat();
+    }
+    else if (typeof data.tags === 'string') {
+        tags = fromTagString(data.tags);
+    }
+    else if (typeof data.tag_string === 'string') {
+        tags = fromTagString(data.tag_string);
+    }
+    return tags.filter((v) => v !== '');
+}
+/**
+ * Parses a string of tags into an array of tags, doing some sanitization
+ *
+ * @example
+ * fromTagString('tag1 tag2 tag3') => ['tag1', 'tag2', 'tag3']
+ * fromTagString('tag1 tag,2 tag3 ') => ['tag1', 'tag2', 'tag3']
+ * @param tags The tags as a string
+ * @returns The string, parsed into an array of tags
+ */
+function fromTagString(tags) {
+    return tags.split(' ').map((v) => v.replace(/,/g, ''));
+}
+/**
+ * An image from a booru with a few common props
+ *
+ * @example
+ * ```
+ * Post {
+ *  fileUrl: 'https://aaaa.com/image.jpg',
+ *  id: '124125',
+ *  tags: ['cat', 'cute'],
+ *  score: 5,
+ *  source: 'https://giraffeduck.com/aaaa.png',
+ *  rating: 's'
+ * }
+ * ```
+ */
+class Post {
+    /** The {@link Booru} it came from */
+    booru;
+    /** The direct link to the file */
+    fileUrl;
+    /** The height of the file */
+    height;
+    /** The width of the file */
+    width;
+    /** The url to the medium-sized image (if available) */
+    sampleUrl;
+    /** The height of the medium-sized image (if available) */
+    sampleHeight;
+    /** The width of the medium-sized image (if available) */
+    sampleWidth;
+    /** The url to the smallest image (if available) */
+    previewUrl;
+    /** The height of the smallest image (if available) */
+    previewHeight;
+    /** The width of the smallest image (if available) */
+    previewWidth;
+    /** The id of this post */
+    id;
+    /** If this post is available (ie. not deleted, not banned, has file url) */
+    available;
+    /** The tags of this post */
+    tags;
+    /** The score of this post */
+    score;
+    /** The source of this post, if available */
+    source;
+    /**
+     * The rating of the image, as just the first letter
+     * (s/q/e/u) => safe/questionable/explicit/unrated
+     */
+    rating;
+    /** The Date this post was created at */
+    createdAt;
+    /** All the data given by the booru @private */
+    data;
+    /**
+     * Create an image from a booru
+     *
+     * @param {Object} data The raw data from the Booru
+     * @param {Booru} booru The booru that created the image
+     */
+    constructor(data, booru) {
+        // eslint-disable-next-line complexity
+        // Damn wild mix of boorus
+        this.data = data;
+        this.booru = booru;
+        // Again, thanks danbooru
+        const deletedOrBanned = data.is_deleted || data.is_banned;
+        this.fileUrl = parseImageUrl(data.file_url ||
+            data.image ||
+            (deletedOrBanned ? data.source : undefined) ||
+            (data.file && data.file.url) ||
+            (data.representations && data.representations.full), data, booru);
+        this.available = !deletedOrBanned && this.fileUrl !== null;
+        this.height = parseInt(data.height || data.image_height || (data.file && data.file.height), 10);
+        this.width = parseInt(data.width || data.image_width || (data.file && data.file.width), 10);
+        this.sampleUrl = parseImageUrl(data.sample_url ||
+            data.large_file_url ||
+            (data.representations && data.representations.large) ||
+            (data.sample && data.sample.url), data, booru);
+        this.sampleHeight = parseInt(data.sample_height || (data.sample && data.sample.height), 10);
+        this.sampleWidth = parseInt(data.sample_width || (data.sample && data.sample.width), 10);
+        this.previewUrl = parseImageUrl(data.preview_url ||
+            data.preview_file_url ||
+            (data.representations && data.representations.small) ||
+            (data.preview && data.preview.url), data, booru);
+        this.previewHeight = parseInt(data.preview_height || (data.preview && data.preview.height), 10);
+        this.previewWidth = parseInt(data.preview_width || (data.preview && data.preview.width), 10);
+        this.id = data.id ? data.id.toString() : 'No ID available';
+        this.tags = getTags(data);
+        if (data.score && data.score.total !== undefined) {
+            this.score = data.score.total;
+        }
+        else {
+            this.score = data.score ? parseInt(data.score, 10) : data.score;
+        }
+        this.source = data.source || data.sources || data.source_url;
+        this.rating =
+            data.rating ||
+                /(safe|suggestive|questionable|explicit)/i.exec(data.tags) ||
+                'u';
+        if (Array.isArray(this.rating)) {
+            this.rating = this.rating[0];
+        }
+        // Thanks derpibooru
+        if (this.rating === 'suggestive') {
+            this.rating = 'q';
+        }
+        this.rating = this.rating.charAt(0);
+        this.createdAt = null;
+        // eslint-disable-next-line
+        if (typeof data.created_at === 'object') {
+            this.createdAt = new Date(data.created_at.s * 1000 + data.created_at.n / 1000000000);
+        }
+        else if (typeof data.created_at === 'number') {
+            this.createdAt = new Date(data.created_at * 1000);
+        }
+        else if (typeof data.created_at === 'string') {
+            this.createdAt = new Date(data.created_at);
+        }
+        else if (typeof data.change === 'number') {
+            this.createdAt = new Date(data.change * 1000);
+        }
+        else {
+            this.createdAt = new Date(data.created_at || data.date);
+        }
+    }
+    /**
+     * The direct link to the file
+     * <p>It's prefered to use `.fileUrl` instead because camelCase
+     */
+    get file_url() {
+        return this.fileUrl;
+    }
+    /**
+     * The url to the medium-sized image (if available)
+     * <p>It's prefered to use `.sampleUrl` instead because camelCase
+     */
+    get sample_url() {
+        return this.sampleUrl;
+    }
+    /**
+     * The height of the medium-sized image (if available)
+     * <p>It's prefered to use `.sampleHeight` instead because camelCase
+     */
+    get sample_height() {
+        return this.sampleHeight;
+    }
+    /**
+     * The width of the medium-sized image (if available)
+     * <p>It's prefered to use `.sampleWidth` instead because camelCase
+     */
+    get sample_width() {
+        return this.sampleWidth;
+    }
+    /**
+     * The url to the smallest image (if available)
+     * <p>It's prefered to use `.previewUrl` instead because camelCase
+     */
+    get preview_url() {
+        return this.previewUrl;
+    }
+    /**
+     * The height of the smallest image (if available)
+     * <p>It's prefered to use `.previewHeight` instead because camelCase
+     */
+    get preview_height() {
+        return this.previewHeight;
+    }
+    /**
+     * The width of the smallest image (if available)
+     * <p>It's prefered to use `.previewWidth` instead because camelCase
+     */
+    get preview_width() {
+        return this.previewWidth;
+    }
+    /**
+     * Get the post view (url to the post) of this image
+     *
+     * @type {String}
+     * @example
+     * ```
+     * const e9 = Booru('e9')
+     * const imgs = e9.search(['cat', 'dog'])
+     *
+     * // Log the post url of the first image
+     * console.log(imgs[0].postView)
+     * ```
+     */
+    get postView() {
+        return this.booru.postView(this.id);
+    }
+    /**
+     * Get some common props on the image
+     *
+     * @deprecated All common props are now attached directly to the image
+     * @type {Object}
+     *
+     * @example
+     * ```
+     * image.id
+     * // deprecated, use this instead
+     * image.id
+     *
+     * // To access the post's raw data from the booru, do
+     * image._data.id
+     * ```
+     */
+    get common() {
+        common();
+        return this;
+    }
+}
+exports.default = Post;
+//# sourceMappingURL=Post.js.map

package/dist/structures/SearchParameters.js

@@ -1 +1,7 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});
+"use strict";
+/**
+ * @packageDocumentation
+ * @module Structures
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=SearchParameters.js.map

package/dist/structures/SearchResults.js

@@ -1 +1,128 @@
-"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(t,e,r,s){void 0===s&&(s=r);var i=Object.getOwnPropertyDescriptor(e,r);i&&!("get"in i?!e.__esModule:i.writable||i.configurable)||(i={enumerable:!0,get:function(){return e[r]}}),Object.defineProperty(t,s,i)}:function(t,e,r,s){void 0===s&&(s=r),t[s]=e[r]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(t,e){Object.defineProperty(t,"default",{enumerable:!0,value:e})}:function(t,e){t.default=e}),__importStar=this&&this.__importStar||function(t){if(t&&t.__esModule)return t;var e={};if(null!=t)for(var r in t)"default"!==r&&Object.prototype.hasOwnProperty.call(t,r)&&__createBinding(e,t,r);return __setModuleDefault(e,t),e};Object.defineProperty(exports,"__esModule",{value:!0});const Utils=__importStar(require("../Utils"));class SearchResults extends Array{booru;page;tags;options;posts;constructor(t,e,r,s){super(t.length);for(let e=0;e<t.length;e++)this[e]=t[e];this.posts=t,this.tags=e,this.options=r,this.booru=s,this.page=r&&r.page||0}get first(){return this[0]}get last(){return this[this.length-1]}nextPage(){const t=this.options;return t.page=this.page+1,this.booru.search(this.tags,t)}tagged(t,{invert:e=!1}={}){Array.isArray(t)||(t=[t]);const r=[];for(const s of this){const i=Utils.compareArrays(t,s.tags).length;(!e&&i>0||e&&0===i)&&r.push(s)}return new SearchResults(r,this.tags,this.options,this.booru)}blacklist(t){return this.tagged(t,{invert:!0})}}exports.default=SearchResults;
+"use strict";
+/**
+ * @packageDocumentation
+ * @module Structures
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Utils = __importStar(require("../Utils"));
+/**
+ * Represents a page of search results, works like an array of {@link Post}
+ * <p> Usable like an array and allows to easily get the next page
+ *
+ * @example
+ * ```
+ * const Booru = require('booru')
+ * // Safebooru
+ * const sb = new Booru('sb')
+ *
+ * const imgs = await sb.search('cat')
+ *
+ * // Log the images from the first page, then from the second
+ * imgs.forEach(i => console.log(i.postView))
+ * const imgs2 = await imgs.nextPage()
+ * imgs2.forEach(i => console.log(i.postView))
+ * ```
+ */
+class SearchResults extends Array {
+    /** The booru used for this search */
+    booru;
+    /** The page of this search */
+    page;
+    /** The tags used for this search */
+    tags;
+    /** The options used for this search */
+    options;
+    /** The posts from this search result */
+    posts;
+    /** @private */
+    constructor(posts, tags, options, booru) {
+        super(posts.length);
+        for (let i = 0; i < posts.length; i++) {
+            this[i] = posts[i];
+        }
+        this.posts = posts;
+        this.tags = tags;
+        this.options = options;
+        this.booru = booru;
+        this.page = options ? options.page || 0 : 0;
+    }
+    /**
+     * Get the first post in this result set
+     * @return {Post}
+     */
+    get first() {
+        return this[0];
+    }
+    /**
+     * Get the last post in this result set
+     * @return {Post}
+     */
+    get last() {
+        return this[this.length - 1];
+    }
+    /**
+     * Get the next page
+     * <p>Works like <code>sb.search('cat', {page: 1}); sb.search('cat', {page: 2})</code>
+     * @return {Promise<SearchResults>}
+     */
+    nextPage() {
+        const opts = this.options;
+        opts.page = this.page + 1;
+        return this.booru.search(this.tags, opts);
+    }
+    /**
+     * Create a new SearchResults with just images with the matching tags
+     *
+     * @param {String[]|String} tags The tags (or tag) to search for
+     * @param {Object} options The extra options for the search
+     * @param {Boolean} [options.invert=false] If the results should be inverted and
+     *                                         return images *not* tagged
+     * @return {SearchResults}
+     */
+    tagged(tags, { invert = false } = {}) {
+        if (!Array.isArray(tags)) {
+            tags = [tags];
+        }
+        const posts = [];
+        for (const p of this) {
+            const m = Utils.compareArrays(tags, p.tags).length;
+            if ((!invert && m > 0) || (invert && m === 0)) {
+                posts.push(p);
+            }
+        }
+        return new SearchResults(posts, this.tags, this.options, this.booru);
+    }
+    /**
+     * Returns a SearchResults with images *not* tagged with any of the specified tags (or tag)
+     * @param {String[]|String} tags The tags (or tag) to blacklist
+     * @return {SearchResults} The results without any images with the specified tags
+     */
+    blacklist(tags) {
+        return this.tagged(tags, { invert: true });
+    }
+}
+exports.default = SearchResults;
+//# sourceMappingURL=SearchResults.js.map