e621 2.2.6 → 3.0.0

package/build/src/structures/WikiPage.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class WikiPage {
-    main;
-    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 = WikiPage;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiV2lraVBhZ2UuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvc3RydWN0dXJlcy9XaWtpUGFnZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUdBLE1BQXFCLFFBQVE7SUFDcEIsSUFBSSxDQUFPO0lBQ25CLEVBQUUsQ0FBUztJQUNYLFVBQVUsQ0FBUztJQUNuQixZQUFZLENBQVM7SUFDckIsYUFBYSxDQUFTO0lBQ3RCLElBQUksQ0FBUztJQUNiLFNBQVMsQ0FBVTtJQUNuQixVQUFVLENBQVM7SUFDbkIsVUFBVSxDQUFTO0lBQ25CLFVBQVUsQ0FBUztJQUNuQixXQUFXLENBQWdCO0lBQzNCLFVBQVUsQ0FBVTtJQUNwQixZQUFZLElBQVUsRUFBRSxJQUF3QjtRQUMvQyxNQUFNLENBQUMsTUFBTSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQztRQUMxQixNQUFNLENBQUMsY0FBYyxDQUFDLElBQUksRUFBRSxNQUFNLEVBQUU7WUFDbkMsS0FBSyxFQUFTLElBQUk7WUFDbEIsWUFBWSxFQUFFLEtBQUs7WUFDbkIsVUFBVSxFQUFJLEtBQUs7WUFDbkIsUUFBUSxFQUFNLEtBQUs7U0FDbkIsQ0FBQyxDQUFDO0lBQ0osQ0FBQztDQUNEO0FBdEJELDJCQXNCQyJ9

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

@@ -1,38 +0,0 @@
-import type WikiPage from "./WikiPage";
-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<WikiPage | null>;
-    /**
-     * Revert the wiki page to this version
-     *
-     * * Requires Authentication
-     *
-     */
-    revertTo(): Promise<null>;
-}

package/build/src/structures/WikiPageHistory.js

@@ -1,49 +0,0 @@
-"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.call(this.main.users, this.updater_id); }
-    /**
-     * Get the wiki page object for this history
-     *
-     * @returns {Promise<WikiPage | null>}
-     */
-    async getWikiPage() { return this.main.wikiPages.get.call(this.main.pools, this.wiki_page_id); }
-    /**
-     * Revert the wiki page to this version
-     *
-     * * Requires Authentication
-     *
-     */
-    async revertTo() {
-        this.main.request.authCheck("WikiPageHistory#revertTo");
-        return this.main.wikiPages.revert.call(this.main.pools, this.wiki_page_id, this.id);
-    }
-}
-exports.default = WikiPageHistory;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiV2lraVBhZ2VIaXN0b3J5LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3N0cnVjdHVyZXMvV2lraVBhZ2VIaXN0b3J5LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBS0EsTUFBcUIsZUFBZTtJQUMzQixJQUFJLENBQU87SUFDbkIsRUFBRSxDQUFTO0lBQ1gsWUFBWSxDQUFTO0lBQ3JCLFVBQVUsQ0FBUztJQUNuQixLQUFLLENBQVM7SUFDZCxJQUFJLENBQVM7SUFDYixTQUFTLENBQVU7SUFDbkIsVUFBVSxDQUFTO0lBQ25CLFVBQVUsQ0FBUztJQUNuQixXQUFXLENBQWdCO0lBQzNCLFVBQVUsQ0FBVTtJQUNwQixNQUFNLENBQVM7SUFDZixZQUFZLElBQVUsRUFBRSxJQUErQjtRQUN0RCxNQUFNLENBQUMsTUFBTSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQztRQUMxQixNQUFNLENBQUMsY0FBYyxDQUFDLElBQUksRUFBRSxNQUFNLEVBQUU7WUFDbkMsS0FBSyxFQUFTLElBQUk7WUFDbEIsWUFBWSxFQUFFLEtBQUs7WUFDbkIsVUFBVSxFQUFJLEtBQUs7WUFDbkIsUUFBUSxFQUFNLEtBQUs7U0FDbkIsQ0FBQyxDQUFDO0lBQ0osQ0FBQztJQUVEOzs7O09BSUc7SUFDSCxLQUFLLENBQUMsVUFBVSxLQUFLLE9BQU8sSUFBSSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBRXpGOzs7O09BSUc7SUFDSCxLQUFLLENBQUMsV0FBVyxLQUFLLE9BQU8sSUFBSSxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSxJQUFJLENBQUMsWUFBWSxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBR2hHOzs7OztPQUtHO0lBQ0gsS0FBSyxDQUFDLFFBQVE7UUFDYixJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxTQUFTLENBQUMsMEJBQTBCLENBQUMsQ0FBQztRQUN4RCxPQUFPLElBQUksQ0FBQyxJQUFJLENBQUMsU0FBUyxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxLQUFLLEVBQUUsSUFBSSxDQUFDLFlBQVksRUFBRSxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUM7SUFDckYsQ0FBQztDQUNEO0FBaERELGtDQWdEQyJ9

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

@@ -1,82 +0,0 @@
-import type { GenericSearchOptions } from ".";
-
-export interface ArtistProperties {
-	id: number;
-	name: string;
-	updated_at: string;
-	is_active: boolean;
-	other_names: Array<string>;
-	group_name: string;
-	linked_user_id: number | null;
-	created_at: string;
-	is_banned: boolean;
-	creator_id: number;
-	is_locked: boolean;
-	notes: string | null;
-	domains: Array<string>;
-	urls: Array<ArtistURL>;
-}
-
-export interface ArtistURL {
-	id: number;
-	artist_id:  number;
-	url: string;
-	normalized_url: string;
-	created_at: string;
-	updated_at: string;
-	is_active: boolean;
-}
-
-export type SearchArtistsOrder = "created_at" | "updated_at" | "name" | "post_count";
-export interface SearchArtistsOptions extends GenericSearchOptions {
-	name?: string;
-	url?: string;
-	creator?: string;
-	active?: boolean;
-	banned?: boolean;
-	has_tag?: boolean;
-	order?: SearchArtistsOrder;
-}
-
-export interface CreateArtistOptions {
-	name: string;
-	/** requires janitor */
-	linked_user_id?: number;
-	/** requires janitor */
-	locked?: boolean;
-	other_names?: Array<string> | string;
-	/** This is [planned to be removed](https://github.com/zwagoth/e621ng/pull/357) */
-	group_name?: string;
-	urls?: Array<string> | string;
-	notes?: string;
-}
-
-export type ModifyArtistOptions = CreateArtistOptions; // no differences
-
-export interface ArtistHistoryProperties {
-	id: number;
-	artist_id: number;
-	name: string;
-	updater_id: number;
-	is_active: boolean;
-	group_name: string;
-	is_banned: boolean;
-	notes_changed: boolean;
-	created_at: string;
-	updated_at: string;
-	other_names: Array<string>;
-	urls: Array<string>;
-}
-
-export interface SearchArtistHistoryOptions extends GenericSearchOptions {
-	id?: number;
-	artist?: string;
-	artist_id?: number;
-	updater?: string;
-	updater_id?: number;
-}
-
-interface DoNotPostList {
-	dnp: Array<string>;
-	conditional_dnp: Array<string>;
-}

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

@@ -1,37 +0,0 @@
-import type { GenericSearchOptions } from ".";
-
-export interface BlipProperties {
-	id: number;
-	creator_id: number;
-	creator_name: string;
-	body: string;
-	response_to: number | null;
-	created_at: string;
-	updated_at: string;
-	is_hidden: boolean;
-	/** the type of warning shown on this blip - 1 = warning - 2 = record - 3 = ban */
-	warning_type: 1 | 2 | 3;
-	/** the user that created the warning present on the blip  */
-	warning_user_id: number | null;
-}
-
-export type SearchBlipsOrder = "id_desc" | "updated_at_desc";
-export interface SearchBlipsOptions extends GenericSearchOptions {
-	creator?: string;
-	creator_id?: string;
-	body?: string;
-	response_to?: number;
-	/** requires moderator */
-	ip_address?: string;
-	order?: SearchBlipsOrder;
-}
-
-export interface CreateBlipOptions {
-	body: string;
-	/** the blip to respond to */
-	response_to?: number;
-}
-
-export type ModifyBlipOptions = Pick<CreateBlipOptions, "body">;
-
-export type BlipWarningType = "warning"| "record" | "ban";

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

@@ -1,96 +0,0 @@
-export interface InstanceOptions {
-	/**
-	 * If the instance you are targeting supports ssl
-	 */
-	ssl?: boolean;
-	/**
-	 * The port of the instance you are targeting
-	 *
-	 * Default: 443 if `instanceSSL` is true, 80 otherwise
-	 */
-	port?: number;
-	/**
-	 * The host of the instance you are targeting
-	 */
-	host?: string;
-	/**
-	 * Override our default url reconstruction when we see a null file url
-	 *
-	 * Default (E621): https://static1.e621.net/data/(preview/|sample/)MD5[0,2]/MD5[2,4]/MD5.EXT
-	 *
-	 * Default (YiffyAPI): https://v3.yiff.media/(preview/|sample/)MD5[0,2]/MD5[2,4]/MD5.EXT
-	 *
-	 * Default (Dev): http://e621ng.local/data/(preview/|sample/)MD5.EXT
-	 *
-	 * If you use a host that is not supported, and do not implement this, 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 | e621ng.local = dev | other = null
-	 */
-	imageReconstructionType?: "e621" | "yiffy" | "dev" | null;
-}
-export interface Options {
-	/**
-	 * 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 ConstructedOptions {
-	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 "./artists";
-export * from "./blips";
-export * from "./notes";
-export * from "./pools";
-export * from "./post_flags";
-export * from "./post_sets";
-export * from "./posts";
-export * from "./tags";
-export * from "./takedowns";
-export * from "./user_feedback";
-export * from "./users";
-export * from "./wiki_pages";

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

@@ -1,64 +0,0 @@
-import type { GenericSearchOptions } from ".";
-
-export interface NoteProperties {
-	id: number;
-	post_id: number;
-	created_at: string;
-	updated_at: string;
-	creator_id: number | null;
-	creator_name: string;
-	x: number;
-	y: number;
-	width: number;
-	height: number;
-	version: number;
-	is_active: boolean;
-	body: string;
-}
-
-export interface SearchNotesOptions extends GenericSearchOptions {
-	body?: string;
-	author?: string;
-	tags?: string | Array<string>;
-}
-
-// POST /notes/:id.json
-export interface CreateNoteOptions {
-	post_id: number;
-	x: number;
-	y: number;
-	width: number;
-	height: number;
-	body: string;
-}
-
-export interface ModifyNoteOptions {
-	x?: number;
-	y?: number;
-	width?: number;
-	height?: number;
-	body?: string;
-}
-
-export interface NoteHistoryProperties {
-	id: number;
-	note_id: number;
-	post_id: number;
-	created_at: string;
-	updated_at: string;
-	updater_id: number | null;
-	x: number;
-	y: number;
-	width: number;
-	height: number;
-	body: string;
-	version: number;
-	is_active: boolean;
-}
-
-export interface SearchNoteHistoryOptions extends GenericSearchOptions {
-	id?: number;
-	note_id?: number;
-	post_id?: number;
-	body?: string;
-}

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

@@ -1,62 +0,0 @@
-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;
-	is_deleted: boolean;
-	category: PoolCategory;
-	post_ids: Array<number>;
-	post_count: number;
-}
-
-export type SearchPoolsOrder = "updated_at" | "name" | "created_at" | "post_count";
-export interface SearchPoolsOptions extends GenericSearchOptions {
-	name?: string;
-	description?: string;
-	creator?: string;
-	active?: boolean;
-	category?: PoolCategory;
-	order?: SearchPoolsOrder;
-}
-
-// 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 | null;
-	description_changed: boolean;
-	name: string | null;
-	created_at: string;
-	updated_at: string;
-	is_active: boolean;
-	is_deleted: boolean;
-	is_locked: boolean;
-	category: PoolCategory | null;
-	version: number;
-}
-
-export interface SearchPoolHistoryOptions extends GenericSearchOptions {
-	id?: number;
-	pool?: number;
-}

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

@@ -1,36 +0,0 @@
-import type { GenericSearchOptions } from ".";
-
-type PostFlagCategory = "normal" | "unapproved" | "deleted" | "banned" | "duplicate";
-export interface PostFlagProperties {
-	id: number;
-	created_at: string;
-	updated_at: string;
-	post_id: number;
-	reason: string;
-	creator_id: number;
-	is_resolved: boolean;
-	is_deletion: boolean;
-	category: PostFlagCategory;
-}
-
-export interface SearchPostFlagsOptions extends GenericSearchOptions {
-	reason?: string;
-	tags?: string | Array<string>;
-	post_id?: number;
-	/** requires janitor if not self */
-	creator?: string;
-	/** requires janitor if not self */
-	creator_id?: number;
-	/** requires moderator */
-	ip_address?: string;
-	resolved?: boolean;
-	category?: PostFlagCategory;
-}
-
-export type PostFlagReasons = "dnp_artist" | "pay_content" | "trace" | "previously_deleted" | "real_porn" | "corrupt" | "inferior" | "user";
-export interface CreatePostFlagOptions {
-	post_id: number;
-	reason_name: PostFlagReasons;
-	/** for previously_deleted & inferior */
-	parent_id?: number;
-}

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

@@ -1,33 +0,0 @@
-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 SearchPostSetsOrder = "name" | "shortname" | "postcount" | "created_at" | "update";
-export interface SearchPostSetsOptions extends GenericSearchOptions {
-	name?: string;
-	shortname?: string;
-	username?: string;
-	order?: SearchPostSetsOrder;
-}
-
-export interface CreatePostSetOptions {
-	name: string;
-	shortname: string;
-	description?: string;
-	public?: boolean;
-	transfer_on_deletion?: boolean;
-}
-
-export type ModifyPostSetOptions = Partial<CreatePostSetOptions>;