e621 1.0.9 → 2.0.0-dev.11

package/build/src/index.d.ts

@@ -1,296 +1,29 @@
-export declare class APIError extends Error {
-    code: number;
-    errmessage: string;
-    method: string;
-    endpoint: string;
-    constructor(code: number, message: string, method: string, endpoint: string);
+import type { Options, InstanceOptions } from "./types";
+import RequestHandler from "./util/RequestHandler";
+import Posts from "./modules/Posts";
+import UserFeedback from "./modules/UserFeedback";
+import Users from "./modules/Users";
+import PostSets from "./modules/PostSets";
+import Pools from "./modules/Pools";
+import AuthenticatedUser from "./structures/AuthenticatedUser";
+import Pool from "./structures/Pool";
+import PoolHistory from "./structures/PoolHistory";
+import Post from "./structures/Post";
+import PostSet from "./structures/PostSet";
+import User from "./structures/User";
+import WikiPages from "./modules/WikiPages";
+export default class E621 {
+    request: RequestHandler;
+    postSets: PostSets;
+    pools: Pools;
+    posts: Posts;
+    userFeedback: UserFeedback;
+    users: Users;
+    wikiPages: WikiPages;
+    private readonly auth;
+    readonly options: InstanceOptions;
+    constructor(options?: Options);
 }
-export interface Post {
-    id: number;
-    created_at: string;
-    updated_at: string;
-    file: {
-        width: number;
-        height: number;
-        ext: string;
-        md5: string;
-        url: string;
-    };
-    preview: {
-        width: number;
-        height: number;
-        url: string;
-    };
-    sample: {
-        has: boolean;
-        height: number;
-        width: number;
-        url: string;
-        alternates: Record<string, unknown>;
-    };
-    score: {
-        up: number;
-        down: number;
-        total: number;
-    };
-    tags: Record<"general" | "species" | "character" | "copyright" | "artist" | "invalid" | "lore" | "meta", Array<string>>;
-    locked_tags: Array<string>;
-    change_seq: number;
-    flags: Record<"pending" | "flagged" | "note_locked" | "status_locked" | "rating_locked" | "deleted", boolean>;
-    rating: "s" | "q" | "e";
-    fav_count: number;
-    sources: Array<string>;
-    pools: Array<number>;
-    relationships: {
-        parent_id: number | null;
-        has_children: boolean;
-        has_active_children: boolean;
-        children: Array<number>;
-    };
-    approver_id: number | null;
-    uploader_id: number | null;
-    description: string;
-    comment_count: number;
-    is_favorited: boolean;
-    has_notes: boolean;
-    duration: number | null;
-}
-export interface NullableURLPost {
-    id: number;
-    created_at: string;
-    updated_at: string;
-    file: {
-        width: number;
-        height: number;
-        ext: string;
-        md5: string;
-        url: string | null;
-    };
-    preview: {
-        width: number;
-        height: number;
-        url: string | null;
-    };
-    sample: {
-        has: boolean;
-        height: number;
-        width: number;
-        url: string | null;
-        alternates: Record<string, unknown>;
-    };
-    score: {
-        up: number;
-        down: number;
-        total: number;
-    };
-    tags: Record<"general" | "species" | "character" | "copyright" | "artist" | "invalid" | "lore" | "meta", Array<string>>;
-    locked_tags: Array<string>;
-    change_seq: number;
-    flags: Record<"pending" | "flagged" | "note_locked" | "status_locked" | "rating_locked" | "deleted", boolean>;
-    rating: "s" | "q" | "e";
-    fav_count: number;
-    sources: Array<string>;
-    pools: Array<number>;
-    relationships: {
-        parent_id: number | null;
-        has_children: boolean;
-        has_active_children: boolean;
-        children: Array<number>;
-    };
-    approver_id: number | null;
-    uploader_id: number | null;
-    description: string;
-    comment_count: number;
-    is_favorited: boolean;
-    has_notes: boolean;
-    duration: number | null;
-}
-export interface UploadLimit {
-    id: number;
-    created_at: number;
-    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;
-    show_avatars: boolean;
-    blacklist_avatars: boolean;
-    blacklist_users: boolean;
-    description_collapsed_initially: boolean;
-    hide_comments: boolean;
-    show_hidden_comments: boolean;
-    show_post_statistics: boolean;
-    has_mail: boolean;
-    receive_email_notifications: boolean;
-    enable_keyboard_navigation: boolean;
-    enable_privacy_mode: boolean;
-    style_usernames: boolean;
-    enable_auto_complete: boolean;
-    has_saved_searches: boolean;
-    disable_cropped_thumbnails: boolean;
-    disable_mobile_gestures: boolean;
-    enable_safe_mode: boolean;
-    disable_responsive_mode: boolean;
-    disable_post_tooltips: boolean;
-    no_flagging: boolean;
-    no_feedback: boolean;
-    disable_user_dmails: boolean;
-    enable_compact_uploader: boolean;
-    updated_at: string;
-    email: string;
-    last_logged_in_at: string;
-    last_forum_read_at: string;
-    recent_tags: string;
-    comment_threshold: number;
-    default_image_size: string;
-    favorite_tags: string;
-    blacklisted_tags: string;
-    time_zone: string;
-    per_page: number;
-    custom_style: string;
-    favorite_count: number;
-    api_regen_multiplier: number;
-    api_burst_limit: number;
-    remaining_api_limit: number;
-    statement_timeout: number;
-    favorite_limit: number;
-    tag_query_limit: number;
-}
-declare class E621<N extends boolean = true> {
-    apiKey: string | null;
-    username: string | null;
-    blacklist: Array<string>;
-    userAgent: string;
-    fixNullURLs: boolean;
-    baseDomain: string;
-    setHost: boolean;
-    /**
-     * Construct an instance of E621
-     *
-     * @param {string} [username] - your e621 username to use for requests
-     * @param {string} [apiKey] - an api key to use for requests
-     * @param {string[]} [blacklist=[]] - a list of tags to use to filter out posts
-     * @param {string }[userAgent] - A user agent to use for requests
-     * @param {boolean} [fixNullURLs=true] - If null urls should be converted to proper urls
-     * @param {string} [baseDomain=this.baseDomain] - The domain to use for api requests
-     * @param {boolean} [setHost=false] - If we should set the Host header on requests to e621.net (useful for proxies).
-     * @example new E621();
-     * @example new E621("YourUsername", "YourAPIKey");
-     * @example new E621("YourUsername", "YourAPIKey", ["male/male"]);
-     * @example new E621("YourUsername", "YourAPIKey", ["male/male"], "MyAwesomeProject/1.0.0");
-     * @example new E621("YourUsername", "YourAPIKey", ["male/male"], "MyAwesomeProject/1.0.0", false);
-     * @example new E621("YourUsername", "YourAPIKey", ["male/male"], "MyAwesomeProject/1.0.0", false, "mye621.local");
-     * @example new E621("YourUsername", "YourAPIKey", ["male/male"], "MyAwesomeProject/1.0.0", false, "mye621.local", false);
-     */
-    constructor(username?: string, apiKey?: string, blacklist?: Array<string>, userAgent?: string, fixNullURLs?: N, baseDomain?: string, setHost?: boolean);
-    private get auth();
-    /**
-     * Get posts from e621
-     *
-     * @param {string[]} [tags=[]] - The tags to fetch posts for, 40 max
-     * @param {number} [limit=25] - The, maximum amount of posts to get, 320 max
-     * @param {number} [page=1] - The page of posts to get, see {@link https://e621.net/help/api#posts_list|E621 API Posts#List}
-     * @returns {Promise<(Post | NullableURLPost)[]>}
-     * @example getPosts()
-     * @example getPosts("male bulge");
-     * @example getPosts(["male", "bulge"]);
-     * @example getPosts(["male", "bulge"], 5);
-     * @example getPosts(["male", "bulge"], 5, 1);
-     */
-    getPosts(tags?: Array<string> | string, limit?: number, page?: number | string): Promise<Array<N extends true ? Post : NullableURLPost>>;
-    /**
-     * Get a specifc post from e621, by id
-     *
-     * @param {number} id - The id of the post to get
-     * @returns {Promise<(Post | NullableURLPost)>}
-     * @example getPostById(1022094)
-     */
-    getPostById(id: number): Promise<(N extends true ? Post : NullableURLPost)>;
-    /**
-     * Get a specifc post from e621, by md5
-     *
-     * @param {string} md5 - the md5 of the post to get
-     * @returns {Promise<(Post | NullableURLPost)>}
-     * @example getPostByMD5("6fd0b0f2237543bfeee5ca9318a97b46")
-     */
-    getPostByMD5(md5: string): Promise<(N extends true ? Post : NullableURLPost)>;
-    /**
-     * Get a specifc post from e621, by md5
-     *
-     * @param {number} id - the id of the post to edit
-     * @param {string} [reason="Edit via https://npm.im/e621"] - The edit reason
-     * @param {string} [tagChanges] - the tags to change, see {@link https://e621.net/help/api#posts_update|Posts Update Documentation} (list tag to add, list tag with a minus to remove)
-     * @param {string} [sourceChanges] - the sources to change, see {@link https://e621.net/help/api#posts_update|Posts Update Documentation} (same as above, with sources)
-     * @param {number} [parentId] - the id of the parent of this image
-     * @param {string} [description] - the description of this image
-     * @param {("s"|"q"|"e")} [rating] - the rating of this image
-     * @param {boolean} [ratingLocked] - if the rating of this image should be locked
-     * @param {boolean} [noteLocked] - if this image should be note locked
-     * @param {boolean} [hasEmbeddedNotes] - if this image has embedded notes
-     * @returns {Promise<(Post | NullableURLPost)>}
-     * @example editPost(1022094, "I dunno", "dog -cat")
-     * @example editPost(1022094, "I dunno", undefined, "-https://furaffinity.net/(...) https://inkbunny.net/(...)")
-     * @example editPost(1022094, "I dunno", undefined, undefined, 1097929)
-     * @example editPost(1022094, "I dunno", undefined, undefined, undefined, "Some stuff here")
-     * @example editPost(1022094, "I dunno", undefined, undefined, undefined, undefined, "e")
-     * @example editPost(1022094, "I dunno", undefined, undefined, undefined, undefined, undefined, true)
-     * @example editPost(1022094, "I dunno", undefined, undefined, undefined, undefined, undefined, undefined, false)
-     * @example editPost(1022094, "I dunno", undefined, undefined, undefined, undefined, undefined, undefined, undefined, true)
-     */
-    editPost(id: number, reason?: string, tagChanges?: string, sourceChanges?: string, parentId?: number, description?: string, rating?: "s" | "q" | "e", ratingLocked?: boolean, noteLocked?: boolean, hasEmbeddedNotes?: boolean): Promise<(N extends true ? Post : NullableURLPost)>;
-    /**
-     *
-     * @param {string} fileURL - the url of the file to send to Discord
-     * @param {(string[]|string)} tags - the tags to put on the post -- if you upload a post with less than 4 tags, e621 mods will not like you
-     * @param {("s"|"q"|"e")} rating - the rating for the image
-     * @param {(string[]|string)} [sources] - The sources of the image
-     * @param {string} [description] - A description for the post
-     * @param {number} [parent] - id of the parent post of this image
-     * @param {string} [referer] - I dunno
-     * @param {string} [md5Confirmation] - the md5 of the provided fileURL, to confirm it matches
-     * @example createPost("https://pbs.twimg.com/media/EbOwnXpXkAIC5ZX.jpg:orig", ["gaokun", "bulge", "penis_outline" (...)], "e")
-     * @example createPost("https://pbs.twimg.com/media/EbOwnXpXkAIC5ZX.jpg:orig", ["gaokun", "bulge", "penis_outline" (...)], "e", ["https://twitter.com/Gaokunx3", "https://twitter.com/Gaokunx3/status/1275559030522556417"])
-     * @example createPost("https://pbs.twimg.com/media/EbOwnXpXkAIC5ZX.jpg:orig", ["gaokun", "bulge", "penis_outline" (...)], "e", ["https://twitter.com/Gaokunx3", "https://twitter.com/Gaokunx3/status/1275559030522556417"], "Some Description Stuff Here")
-     * @example createPost("https://pbs.twimg.com/media/EbOwnXpXkAIC5ZX.jpg:orig", ["gaokun", "bulge", "penis_outline" (...)], "e", ["https://twitter.com/Gaokunx3", "https://twitter.com/Gaokunx3/status/1275559030522556417"], "Some Description Stuff Here", 1234)
-     * @example createPost("https://pbs.twimg.com/media/EbOwnXpXkAIC5ZX.jpg:orig", ["gaokun", "bulge", "penis_outline" (...)], "e", ["https://twitter.com/Gaokunx3", "https://twitter.com/Gaokunx3/status/1275559030522556417"], "Some Description Stuff Here", 1234, "https://npm.im/e621")
-     * @example createPost("https://pbs.twimg.com/media/EbOwnXpXkAIC5ZX.jpg:orig", ["gaokun", "bulge", "penis_outline" (...)], "e", ["https://twitter.com/Gaokunx3", "https://twitter.com/Gaokunx3/status/1275559030522556417"], "Some Description Stuff Here", 1234, "https://npm.im/e621", "abcdefghijklmnopqrstuvwxyz123456")
-     * @returns
-     */
-    createPost(fileURL: string, tags: string | Array<string>, rating: "s" | "q" | "e", sources?: Array<string> | string, description?: string, parent?: number, referer?: string, md5Confirmation?: string): Promise<{
-        success: boolean;
-        location: string;
-        post_id: number;
-    }>;
-    private filterPosts;
-    /**
-     * Convert null urls on a post into proper urls.
-     *
-     * @param {NullableURLPost} p - The post to fix
-     * @returns {Post}
-     */
-    fixURL(p: NullableURLPost): Post;
-    /**
-     * Construct a url from its md5 counterpart
-     *
-     * @param {string} md5 - the md5
-     * @param {string} [ext="png"] - The extension, assumed png if not provided
-     * @param {boolean} [preview=false]
-     */
-    constructURLFromMD5(md5: string, ext?: string, preview?: boolean): string;
-    /**
-     * Fetch your "upload limit" info (this seems to just be general account info, along with upload limit)
-     *
-     * authentication is REQUIRED
-     *
-     * @returns {Promise<UploadLimit>}
-     */
-    getUploadLimit(): Promise<UploadLimit>;
-}
-export default E621;
-export { E621 };
+export * from "./types";
+export { APIError } from "./util/RequestHandler";
+export { AuthenticatedUser, Pool, PoolHistory, Post, PostSet, User };