e621 1.0.9 → 2.0.0-dev.11

package/build/src/structures/PostSet.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class PostSet {
+    main;
+    id;
+    name;
+    shortname;
+    description;
+    is_public;
+    transfer_on_delete;
+    creator_id;
+    post_ids;
+    post_count;
+    created_at;
+    updated_at;
+    constructor(main, info) {
+        Object.assign(this, info);
+        Object.defineProperty(this, "main", {
+            value: main,
+            configurable: false,
+            enumerable: false,
+            writable: false
+        });
+    }
+    /**
+     * Get the post objects for the posts in this set
+     *
+     * @returns {Promise<Array<Post>>}
+     */
+    async getPosts() { return this.main.posts.search({ tags: this.post_ids.map(p => `id:${p}`) }); }
+    /**
+     * Get the user object of the creator of this set
+     *
+     * @returns {Promise<User | null>}
+     */
+    async getCreator() { return this.main.users.get(this.creator_id); }
+    /**
+     * Add a post to this set
+     *
+     * * Requires Authentication
+     *
+     * @param {number} id - the id of the post to add
+     * @returns {Promise<PostSet>}
+     */
+    async addPost(id) {
+        this.main.request.authCheck("PostSet#addPost");
+        return this.main.postSets.addPost(this.id, id);
+    }
+    /**
+     * Remove a post from this set
+     *
+     * * Requires Authentication
+     *
+     * @param {number} id - the id of the post to remove
+     * @returns {Promise<PostSet>}
+     */
+    async removePost(id) {
+        this.main.request.authCheck("PostSet#removePost");
+        return this.main.postSets.removePost(this.id, id);
+    }
+    /**
+     * modify this set
+     *
+     * * Requires Authentication
+     *
+     * @param {object} options
+     * @param {string} [options.name] - the name of the set
+     * @param {string} [options.shortname] - the short name of the set
+     * @param {string} [options.escription] - the description of the set
+     * @param {boolean} [options.active] - if the set is public
+     * @param {boolean} [options.transferOnDeletion] - if deleted posts should be replaced with parents
+     * @returns {Promise<PostSet>}
+     */
+    async modify(options) {
+        this.main.request.authCheck("PostSet#modify");
+        return this.main.postSets.modify(this.id, options);
+    }
+    /**
+     * Delete this set
+     *
+     * * Requires Authentication
+     *
+     * @returns {Promise<null>}
+     */
+    async delete() {
+        this.main.request.authCheck("PostSet#delete");
+        return this.main.postSets.delete(this.id);
+    }
+}
+exports.default = PostSet;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUG9zdFNldC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9zdHJ1Y3R1cmVzL1Bvc3RTZXQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFLQSxNQUFxQixPQUFPO0lBQ25CLElBQUksQ0FBTztJQUNuQixFQUFFLENBQVM7SUFDWCxJQUFJLENBQVM7SUFDYixTQUFTLENBQVM7SUFDbEIsV0FBVyxDQUFTO0lBQ3BCLFNBQVMsQ0FBVTtJQUNuQixrQkFBa0IsQ0FBVTtJQUM1QixVQUFVLENBQVM7SUFDbkIsUUFBUSxDQUFnQjtJQUN4QixVQUFVLENBQVM7SUFDbkIsVUFBVSxDQUFTO0lBQ25CLFVBQVUsQ0FBUztJQUNuQixZQUFZLElBQVUsRUFBRSxJQUF1QjtRQUM5QyxNQUFNLENBQUMsTUFBTSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQztRQUMxQixNQUFNLENBQUMsY0FBYyxDQUFDLElBQUksRUFBRSxNQUFNLEVBQUU7WUFDbkMsS0FBSyxFQUFFLElBQUk7WUFDWCxZQUFZLEVBQUUsS0FBSztZQUNuQixVQUFVLEVBQUUsS0FBSztZQUNqQixRQUFRLEVBQUUsS0FBSztTQUNmLENBQUMsQ0FBQztJQUNKLENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsS0FBSyxDQUFDLFFBQVEsS0FBSyxPQUFPLElBQUksQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQyxFQUFFLElBQUksRUFBRSxJQUFJLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBRWhHOzs7O09BSUc7SUFDSCxLQUFLLENBQUMsVUFBVSxLQUFLLE9BQU8sSUFBSSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFFbkU7Ozs7Ozs7T0FPRztJQUNILEtBQUssQ0FBQyxPQUFPLENBQUMsRUFBVTtRQUN2QixJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxTQUFTLENBQUMsaUJBQWlCLENBQUMsQ0FBQztRQUMvQyxPQUFPLElBQUksQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsRUFBRSxFQUFFLEVBQUUsQ0FBQyxDQUFDO0lBQ2hELENBQUM7SUFFRDs7Ozs7OztPQU9HO0lBQ0gsS0FBSyxDQUFDLFVBQVUsQ0FBQyxFQUFVO1FBQzFCLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxvQkFBb0IsQ0FBQyxDQUFDO1FBQ2xELE9BQU8sSUFBSSxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxFQUFFLEVBQUUsRUFBRSxDQUFDLENBQUM7SUFDbkQsQ0FBQztJQUVEOzs7Ozs7Ozs7Ozs7T0FZRztJQUNILEtBQUssQ0FBQyxNQUFNLENBQUMsT0FBNkI7UUFDekMsSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsU0FBUyxDQUFDLGdCQUFnQixDQUFDLENBQUM7UUFDOUMsT0FBTyxJQUFJLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLEVBQUUsRUFBRSxPQUFPLENBQUMsQ0FBQztJQUNwRCxDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0gsS0FBSyxDQUFDLE1BQU07UUFDWCxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxTQUFTLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztRQUM5QyxPQUFPLElBQUksQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUM7SUFDM0MsQ0FBQztDQUNEO0FBNUZELDBCQTRGQyJ9

package/build/src/structures/User.d.ts

@@ -0,0 +1,62 @@
+import type Post from "./Post";
+import type E621 from "..";
+import type { UserProperties, SearchUserFeedbackOptions, CreateUserFeedbackOptions, UserFeedbackProperties } from "../types";
+export default class User implements UserProperties {
+    protected readonly main: E621;
+    wiki_page_version_count: number;
+    artist_version_count: number;
+    pool_version_count: number;
+    forum_post_count: number;
+    comment_count: number;
+    appeal_count: number;
+    flag_count: number;
+    positive_feedback_count: number;
+    neutral_feedback_count: number;
+    negative_feedback_count: number;
+    upload_limit: number;
+    id: number;
+    created_at: string;
+    name: string;
+    level: number;
+    base_upload_limit: number;
+    post_upload_count: number;
+    post_update_count: number;
+    note_update_count: number;
+    is_banned: boolean;
+    can_approve_posts: boolean;
+    can_upload_free: boolean;
+    level_string: string;
+    avatar_id: number | null;
+    constructor(main: E621, info: UserProperties);
+    /**
+     * Get the feedback associated with this user
+     *
+     * @param {object} [options] - Options for narrowing the search
+     * @param {string} [options.creator] - the creator of the feedback
+     * @param {string} [options.body] - the body of the feedback
+     * @param {FeedbackCategories} [options.category] - the type of feedback
+     * @param {number} [options.limit] - the maximum amount of feedback to fetch
+     * @returns {Array<UserFeedbackProperties>}
+     */
+    getFeedback(options: Omit<SearchUserFeedbackOptions, "username">): Promise<UserFeedbackProperties[]>;
+    /**
+     * Create a feedback for this user
+     *
+     * * Requires Authentication
+     *
+     * * Requires Moderator
+     *
+     * @param {object} options
+     * @param {FeedbackCategories} options.category - the type of feedback
+     * @param {string} options.body - the body of the feedback
+     * @returns
+     */
+    createFeedback(options: Omit<CreateUserFeedbackOptions, "username">): Promise<UserFeedbackProperties>;
+    /**
+     * Get this users favorites
+     *
+     * @returns {Promise<Array<Post>>}
+     */
+    getFavorites(): Promise<Post[]>;
+    asAuthenticatedUser(): Promise<import("./AuthenticatedUser").default>;
+}

package/build/src/structures/User.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class User {
+    main;
+    wiki_page_version_count;
+    artist_version_count;
+    pool_version_count;
+    forum_post_count;
+    comment_count;
+    appeal_count;
+    flag_count;
+    positive_feedback_count;
+    neutral_feedback_count;
+    negative_feedback_count;
+    upload_limit;
+    id;
+    created_at;
+    name;
+    level;
+    base_upload_limit;
+    post_upload_count;
+    post_update_count;
+    note_update_count;
+    is_banned;
+    can_approve_posts;
+    can_upload_free;
+    level_string;
+    avatar_id;
+    constructor(main, info) {
+        Object.assign(this, info);
+        Object.defineProperty(this, "main", {
+            value: main,
+            configurable: false,
+            enumerable: false,
+            writable: false
+        });
+    }
+    /**
+     * Get the feedback associated with this user
+     *
+     * @param {object} [options] - Options for narrowing the search
+     * @param {string} [options.creator] - the creator of the feedback
+     * @param {string} [options.body] - the body of the feedback
+     * @param {FeedbackCategories} [options.category] - the type of feedback
+     * @param {number} [options.limit] - the maximum amount of feedback to fetch
+     * @returns {Array<UserFeedbackProperties>}
+     */
+    async getFeedback(options) { return this.main.userFeedback.search({ username: this.name, ...options }); }
+    /**
+     * Create a feedback for this user
+     *
+     * * Requires Authentication
+     *
+     * * Requires Moderator
+     *
+     * @param {object} options
+     * @param {FeedbackCategories} options.category - the type of feedback
+     * @param {string} options.body - the body of the feedback
+     * @returns
+     */
+    async createFeedback(options) {
+        this.main.request.authCheck.call(this, "User#createFeedback");
+        return this.main.userFeedback.create({ username: this.name, ...options });
+    }
+    /**
+     * Get this users favorites
+     *
+     * @returns {Promise<Array<Post>>}
+     */
+    async getFavorites() { return this.main.users.getFavorites(this.id); }
+    async asAuthenticatedUser() {
+        this.main.request.authCheck.call(this, "User#asAuthenticatedUser");
+        const info = await this.main.users.getSelf();
+        if (info.id !== this.id)
+            throw new Error("User#asAuthenticatedUser called on a different user");
+        return info;
+    }
+}
+exports.default = User;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVXNlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9zdHJ1Y3R1cmVzL1VzZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFVQSxNQUFxQixJQUFJO0lBQ0wsSUFBSSxDQUFPO0lBQzlCLHVCQUF1QixDQUFTO0lBQ2hDLG9CQUFvQixDQUFTO0lBQzdCLGtCQUFrQixDQUFTO0lBQzNCLGdCQUFnQixDQUFTO0lBQ3pCLGFBQWEsQ0FBUztJQUN0QixZQUFZLENBQVM7SUFDckIsVUFBVSxDQUFTO0lBQ25CLHVCQUF1QixDQUFTO0lBQ2hDLHNCQUFzQixDQUFTO0lBQy9CLHVCQUF1QixDQUFTO0lBQ2hDLFlBQVksQ0FBUztJQUNyQixFQUFFLENBQVM7SUFDWCxVQUFVLENBQVM7SUFDbkIsSUFBSSxDQUFTO0lBQ2IsS0FBSyxDQUFTO0lBQ2QsaUJBQWlCLENBQVM7SUFDMUIsaUJBQWlCLENBQVM7SUFDMUIsaUJBQWlCLENBQVM7SUFDMUIsaUJBQWlCLENBQVM7SUFDMUIsU0FBUyxDQUFVO0lBQ25CLGlCQUFpQixDQUFVO0lBQzNCLGVBQWUsQ0FBVTtJQUN6QixZQUFZLENBQVM7SUFDckIsU0FBUyxDQUFnQjtJQUN6QixZQUFZLElBQVUsRUFBRSxJQUFvQjtRQUMzQyxNQUFNLENBQUMsTUFBTSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQztRQUMxQixNQUFNLENBQUMsY0FBYyxDQUFDLElBQUksRUFBRSxNQUFNLEVBQUU7WUFDbkMsS0FBSyxFQUFFLElBQUk7WUFDWCxZQUFZLEVBQUUsS0FBSztZQUNuQixVQUFVLEVBQUUsS0FBSztZQUNqQixRQUFRLEVBQUUsS0FBSztTQUNmLENBQUMsQ0FBQztJQUNKLENBQUM7SUFFRDs7Ozs7Ozs7O09BU0c7SUFDSCxLQUFLLENBQUMsV0FBVyxDQUFDLE9BQW9ELElBQUksT0FBTyxJQUFJLENBQUMsSUFBSSxDQUFDLFlBQVksQ0FBQyxNQUFNLENBQUMsRUFBRSxRQUFRLEVBQUUsSUFBSSxDQUFDLElBQUksRUFBRSxHQUFHLE9BQU8sRUFBRSxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ3RKOzs7Ozs7Ozs7OztPQVdHO0lBQ0gsS0FBSyxDQUFDLGNBQWMsQ0FBQyxPQUFvRDtRQUN4RSxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLElBQUksRUFBRSxxQkFBcUIsQ0FBQyxDQUFDO1FBQzlELE9BQU8sSUFBSSxDQUFDLElBQUksQ0FBQyxZQUFZLENBQUMsTUFBTSxDQUFDLEVBQUUsUUFBUSxFQUFFLElBQUksQ0FBQyxJQUFJLEVBQUUsR0FBRyxPQUFPLEVBQUUsQ0FBQyxDQUFDO0lBQzNFLENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsS0FBSyxDQUFDLFlBQVksS0FBSyxPQUFPLElBQUksQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLFlBQVksQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBRXRFLEtBQUssQ0FBQyxtQkFBbUI7UUFDeEIsSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxJQUFJLEVBQUUsMEJBQTBCLENBQUMsQ0FBQztRQUNuRSxNQUFNLElBQUksR0FBRyxNQUFNLElBQUksQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLE9BQU8sRUFBRSxDQUFDO1FBQzdDLElBQUksSUFBSSxDQUFDLEVBQUUsS0FBSyxJQUFJLENBQUMsRUFBRTtZQUFFLE1BQU0sSUFBSSxLQUFLLENBQUMscURBQXFELENBQUMsQ0FBQztRQUNoRyxPQUFPLElBQUksQ0FBQztJQUNiLENBQUM7Q0FDRDtBQTdFRCx1QkE2RUMifQ==

package/build/src/structures/WikiPage.d.ts

@@ -0,0 +1,16 @@
+import type { WikiPageProperties } from "../types";
+import type E621 from "..";
+export default class Pool implements WikiPageProperties {
+    id: number;
+    creator_id: number;
+    creator_name: string;
+    category_name: number;
+    body: string;
+    is_locked: boolean;
+    created_at: string;
+    updated_at: string;
+    updater_id: number;
+    other_names: Array<string>;
+    is_deleted: boolean;
+    constructor(main: E621, info: WikiPageProperties);
+}

package/build/src/structures/WikiPage.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Pool {
+    id;
+    creator_id;
+    creator_name;
+    category_name;
+    body;
+    is_locked;
+    created_at;
+    updated_at;
+    updater_id;
+    other_names;
+    is_deleted;
+    constructor(main, info) {
+        Object.assign(this, info);
+        Object.defineProperty(this, "main", {
+            value: main,
+            configurable: false,
+            enumerable: false,
+            writable: false
+        });
+    }
+}
+exports.default = Pool;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiV2lraVBhZ2UuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvc3RydWN0dXJlcy9XaWtpUGFnZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUdBLE1BQXFCLElBQUk7SUFDeEIsRUFBRSxDQUFTO0lBQ1gsVUFBVSxDQUFTO0lBQ25CLFlBQVksQ0FBUztJQUNyQixhQUFhLENBQVM7SUFDdEIsSUFBSSxDQUFTO0lBQ2IsU0FBUyxDQUFVO0lBQ25CLFVBQVUsQ0FBUztJQUNuQixVQUFVLENBQVM7SUFDbkIsVUFBVSxDQUFTO0lBQ25CLFdBQVcsQ0FBZ0I7SUFDM0IsVUFBVSxDQUFVO0lBQ3BCLFlBQVksSUFBVSxFQUFFLElBQXdCO1FBQy9DLE1BQU0sQ0FBQyxNQUFNLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFDO1FBQzFCLE1BQU0sQ0FBQyxjQUFjLENBQUMsSUFBSSxFQUFFLE1BQU0sRUFBRTtZQUNuQyxLQUFLLEVBQUUsSUFBSTtZQUNYLFlBQVksRUFBRSxLQUFLO1lBQ25CLFVBQVUsRUFBRSxLQUFLO1lBQ2pCLFFBQVEsRUFBRSxLQUFLO1NBQ2YsQ0FBQyxDQUFDO0lBQ0osQ0FBQztDQUNEO0FBckJELHVCQXFCQyJ9

package/build/src/structures/WikiPageHistory.d.ts

@@ -0,0 +1,37 @@
+import type User from "./User";
+import type { WikiPageHistoryProperties } from "../types";
+import type E621 from "..";
+export default class WikiPageHistory implements WikiPageHistoryProperties {
+    private main;
+    id: number;
+    wiki_page_id: number;
+    updater_id: number;
+    title: string;
+    body: string;
+    is_locked: boolean;
+    created_at: string;
+    updated_at: string;
+    other_names: Array<string>;
+    is_deleted: boolean;
+    reason: string;
+    constructor(main: E621, info: WikiPageHistoryProperties);
+    /**
+     * Get the updater for this history
+     *
+     * @returns {Promise<User | null>}
+     */
+    getUpdater(): Promise<User | null>;
+    /**
+     * Get the wiki page object for this history
+     *
+     * @returns {Promise<WikiPage | null>}
+     */
+    getWikiPage(): Promise<import("./Pool").default | null>;
+    /**
+     * Revert the wiki page to this version
+     *
+     * * Requires Authentication
+     *
+     */
+    revertTo(): Promise<null>;
+}

package/build/src/structures/WikiPageHistory.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class WikiPageHistory {
+    main;
+    id;
+    wiki_page_id;
+    updater_id;
+    title;
+    body;
+    is_locked;
+    created_at;
+    updated_at;
+    other_names;
+    is_deleted;
+    reason;
+    constructor(main, info) {
+        Object.assign(this, info);
+        Object.defineProperty(this, "main", {
+            value: main,
+            configurable: false,
+            enumerable: false,
+            writable: false
+        });
+    }
+    /**
+     * Get the updater for this history
+     *
+     * @returns {Promise<User | null>}
+     */
+    async getUpdater() { return this.main.users.get(this.updater_id); }
+    /**
+     * Get the wiki page object for this history
+     *
+     * @returns {Promise<WikiPage | null>}
+     */
+    async getWikiPage() { return this.main.pools.get(this.wiki_page_id); }
+    /**
+     * Revert the wiki page to this version
+     *
+     * * Requires Authentication
+     *
+     */
+    async revertTo() {
+        this.main.request.authCheck("WikiPageHistory#revertTo");
+        return this.main.pools.revert(this.wiki_page_id, this.id);
+    }
+}
+exports.default = WikiPageHistory;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiV2lraVBhZ2VIaXN0b3J5LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3N0cnVjdHVyZXMvV2lraVBhZ2VIaXN0b3J5LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBS0EsTUFBcUIsZUFBZTtJQUMzQixJQUFJLENBQU87SUFDbkIsRUFBRSxDQUFTO0lBQ1gsWUFBWSxDQUFTO0lBQ3JCLFVBQVUsQ0FBUztJQUNuQixLQUFLLENBQVM7SUFDZCxJQUFJLENBQVM7SUFDYixTQUFTLENBQVU7SUFDbkIsVUFBVSxDQUFTO0lBQ25CLFVBQVUsQ0FBUztJQUNuQixXQUFXLENBQWdCO0lBQzNCLFVBQVUsQ0FBVTtJQUNwQixNQUFNLENBQVM7SUFDZixZQUFZLElBQVUsRUFBRSxJQUErQjtRQUN0RCxNQUFNLENBQUMsTUFBTSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQztRQUMxQixNQUFNLENBQUMsY0FBYyxDQUFDLElBQUksRUFBRSxNQUFNLEVBQUU7WUFDbkMsS0FBSyxFQUFFLElBQUk7WUFDWCxZQUFZLEVBQUUsS0FBSztZQUNuQixVQUFVLEVBQUUsS0FBSztZQUNqQixRQUFRLEVBQUUsS0FBSztTQUNmLENBQUMsQ0FBQztJQUNKLENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsS0FBSyxDQUFDLFVBQVUsS0FBSyxPQUFPLElBQUksQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBRW5FOzs7O09BSUc7SUFDSCxLQUFLLENBQUMsV0FBVyxLQUFLLE9BQU8sSUFBSSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxZQUFZLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFHdEU7Ozs7O09BS0c7SUFDSCxLQUFLLENBQUMsUUFBUTtRQUNiLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLFNBQVMsQ0FBQywwQkFBMEIsQ0FBQyxDQUFDO1FBQ3hELE9BQU8sSUFBSSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxZQUFZLEVBQUUsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDO0lBQzNELENBQUM7Q0FDRDtBQWhERCxrQ0FnREMifQ==

package/build/src/types/index.d.ts

@@ -0,0 +1,92 @@
+export interface Options {
+	/**
+	 * If the instance you are targeting supports ssl
+	 *
+	 * Default: true if `instanceHost` is "e621.net", false otherwise
+	 */
+	instanceSSL?: boolean;
+	/**
+	 * The port of the instance you are targeting
+	 *
+	 * Default: 443 if `instanceSSL` is true, 80 otherwise
+	 */
+	instancePort?: number;
+	/**
+	 * The host of the instance you are targeting
+	 *
+	 * Default: e621.net
+	 */
+	instanceHost?: string;
+	/**
+	 * Override our default url reconstruction when we see a null file url
+	 *
+	 * Default (e621.net): https://static1.e621.net/data/(preview/|sample/)MD5[0,2]/MD5[2,4]/MD5.EXT
+	 *
+	 * Default (yiff.rest): https://v3.yiff.media/(preview/|sample/)MD5[0,2]/MD5[2,4]/MD5.EXT
+	 *
+	 * Default (e621.local): http://e621.local/data/(preview/|sample/)MD5.EXT
+	 *
+	 * If you use a host that is not supported, and do not implement this, or set a construction type, an error will be thrown.
+	 *
+	 * @param {string} md5 - the md5 of the image
+	 * @param {("original" | "preview" | "sample")} type - the type of url being constructed
+	 * @param {string} ext - the extension of the file
+	 */
+	reconstructStaticURL?(this: void, md5: string, type: "original" | "preview" | "sample", ext: string): string;
+	/**
+	 * The method to use for image reconstructon (if you are not using E621, YiffyAPI, or e621ng, you MUST override the reconstructStaticURL function, as the static urls are hardcoded for these)
+	 *
+	 * Default: based on `instanceHost` - e621.net = e621 | yiff.rest = yiffy | e621.local = dev | other = null
+	 */
+	imageReconstructionType?: "e621" | "yiffy" | "dev" | null;
+	/**
+	 * The uername of the user you want to authenticate with
+	 *
+	 * Default: none
+	 */
+	authUser?: string;
+	/**
+	 * The api key you want to authenticate with (Account -> Manage API Access)
+	 *
+	 * Default: none
+	 */
+	authKey?: string;
+	/**
+	 * The user agent to use for requests
+	 *
+	 * Default (Without Auth): E621/VERSION (https://github.com/DonovanDMC/E621)
+	 *
+	 * Default (With Auth): E621/VERSION (https://github.com/DonovanDMC/E621; "{authUser}")
+	 */
+	userAgent?: string;
+	/**
+	 * The number of seconds before a request times out
+	 *
+	 * Default: 30
+	 */
+	requestTimeout?: number;
+}
+
+export interface InstanceOptions {
+	instanceSSL: boolean;
+	instancePort: number;
+	instanceHost: string;
+	authUser: string | null;
+	authKey: string | null;
+	reconstructStaticURL: ((this: void, md5: string, type: "original" | "preview" | "sample", ext: string) => string) | null;
+	imageReconstructionType: "e621" | "yiffy" | "dev" | null;
+	userAgent: string;
+	requestTimeout: number;
+}
+
+export interface GenericSearchOptions {
+	limit?: number;
+	page?: number | `${"a" | "b" | ""}${number}`;
+}
+
+export * from "./pools";
+export * from "./post_sets";
+export * from "./posts";
+export * from "./user_feedback";
+export * from "./users";
+export * from "./wiki_pages";

package/build/src/types/pools.d.ts

@@ -0,0 +1,60 @@
+import type { GenericSearchOptions } from ".";
+
+export type PoolCategory = "collection" | "series";
+export interface PoolProperties {
+	id: number;
+	name: string;
+	created_at: string;
+	updated_at: string;
+	creator_id: number;
+	creator_name: string;
+	is_active: boolean;
+	category: PoolCategory;
+	is_deleted: boolean;
+	post_ids: Array<number>;
+	post_count: number;
+}
+
+export type PoolOrder = "updated_at" | "name" | "created_at" | "post_count";
+export interface SearchPoolsOptions extends GenericSearchOptions {
+	name?: string;
+	description?: string;
+	creator?: string;
+	active?: boolean;
+	category?: PoolCategory;
+	order?: PoolOrder;
+}
+
+// the api docs list is_locked, but it isn't a permitted parameter, and I can't find any references in the source code
+// so it seems like it was removed and the docs are just out of date
+export interface CreatePoolOptions {
+	name: string;
+	description?: string;
+	posts?: Array<number>;
+	category: PoolCategory;
+	active?: boolean;
+}
+
+export type ModifyPoolOptions = Partial<CreatePoolOptions>;
+
+export interface PoolHistoryProperties {
+	id: number;
+	pool_id: number;
+	post_ids: Array<number>;
+	added_post_ids: Array<number>;
+	removed_post_ids: Array<number>;
+	updater_id: number;
+	description: string;
+	description_changed: boolean;
+	name: string;
+	created_at: string;
+	updated_at: string;
+	is_active: boolean;
+	is_deleted: boolean;
+	category: PoolCategory;
+	version: number;
+}
+
+export interface SearchPoolHistoryOptions extends GenericSearchOptions {
+	pool?: number;
+}

package/build/src/types/post_sets.d.ts

@@ -0,0 +1,33 @@
+import type { GenericSearchOptions } from ".";
+
+export interface PostSetProperties {
+	id: number;
+	name: string;
+	shortname: string;
+	description: string;
+	is_public: boolean;
+	transfer_on_delete: boolean;
+	creator_id: number;
+	post_ids: Array<number>;
+	post_count: number;
+	created_at: string;
+	updated_at: string;
+}
+
+export type PostSetOrder = "name" | "shortname" | "postcount" | "created_at" | "update";
+export interface SearchPostSetsOptions extends GenericSearchOptions {
+	name?: string;
+	shortname?: string;
+	username?: string;
+	order?: PostSetOrder;
+}
+
+export interface CreatePostSetOptions {
+	name: string;
+	shortname: string;
+	description?: string;
+	public?: boolean;
+	transferOnDeletion?: boolean;
+}
+
+export type ModifyPostSetOptions = Partial<CreatePostSetOptions>;