e621-client 1.0.3 → 1.0.5

package/README.md

@@ -34,7 +34,7 @@ const postsWithTags = await client.getPosts({
   tags: "male score:>100",
 });
 
-// search users by names (_ for wildcards)
+// search users by names (* for wildcards)
 const toms = await client.getUsers({
   nameMatches: "tom*",
 });

package/package.json

@@ -1,18 +1,19 @@
-{
-  "name": "e621-client",
-  "version": "1.0.3",
-  "main": "dist/index.js",
-  "scripts": {
-    "build": "tsc"
-  },
-  "keywords": [],
-  "author": "Tommus",
-  "license": "ISC",
-  "description": "A simple client for the e621 API",
-  "devDependencies": {
-    "@types/node": "^20.14.2",
-    "prettier": "^3.3.1",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.4.5"
-  }
-}
+{
+  "name": "e621-client",
+  "version": "1.0.5",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc"
+  },
+  "keywords": [],
+  "author": "Tommus",
+  "license": "ISC",
+  "description": "A simple client for the e621 API",
+  "devDependencies": {
+    "@types/node": "^20.14.2",
+    "prettier": "^3.3.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.5"
+  }
+}

package/dist/client/E621ApiClient.d.ts

@@ -1,49 +0,0 @@
-import { E621Post } from "../types/e621/E621Post";
-import { E621User } from "../types/e621/E621User";
-import { E621ApiHeaders } from "./E621ApiHeaders";
-export interface E621ApiOptions {
-    client: string;
-    isBrowser: boolean;
-    credentials?: Credentials;
-}
-export type GetOptions = {
-    route: Route;
-    params?: Params;
-    headers?: E621ApiHeaders;
-};
-export interface Credentials {
-    username: string;
-    apiKey: string;
-}
-export type EntityId = string | number;
-export type Route = string | number | (string | number)[];
-export type Params = Record<string, string>;
-export type Pagination = {
-    limit?: string;
-    page?: string;
-};
-export type GetUsersOptions = {
-    nameMatches?: string;
-} & Params & Pagination;
-export type GetPostsOptions = {
-    tags?: string;
-} & Pagination;
-export type GetFavoritesOptions = {
-    userId?: string;
-} & Pagination;
-export declare class E621ApiClient {
-    protected static readonly BASE_URL = "https://e621.net/";
-    private readonly client;
-    private readonly isBrowser;
-    private credentials;
-    constructor(options: E621ApiOptions);
-    getUsers(options?: GetUsersOptions): Promise<E621User[]>;
-    getUserById(id: EntityId): Promise<E621User | null>;
-    getPosts(options?: GetPostsOptions): Promise<E621Post[]>;
-    getPostById(id: EntityId): Promise<E621Post | null>;
-    getFavorites(options?: GetFavoritesOptions): Promise<E621Post[]>;
-    setCredentials(credentials: Credentials | null): E621ApiClient;
-    checkCredentials(credentials?: Credentials): Promise<boolean>;
-    get<E>({ route, params, headers, }: GetOptions): Promise<E | null>;
-    private buildUrl;
-}

package/dist/client/E621ApiClient.js

@@ -1,112 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.E621ApiClient = void 0;
-const E621Post_1 = require("../types/e621/E621Post");
-const E621User_1 = require("../types/e621/E621User");
-const utils_1 = require("../utils");
-const E621ApiHeaders_1 = require("./E621ApiHeaders");
-class E621ApiClient {
-    constructor(options) {
-        this.credentials = null;
-        this.client = options.client;
-        this.isBrowser = options.isBrowser;
-        this.credentials = options.credentials || null;
-    }
-    // Users
-    getUsers() {
-        return __awaiter(this, arguments, void 0, function* (options = {}) {
-            const users = yield this.get({
-                route: "users",
-                params: (0, utils_1.translateOptions)(options, {
-                    nameMatches: "search[name_matches]",
-                }),
-            });
-            return (users === null || users === void 0 ? void 0 : users.map(E621User_1.parseUser)) || [];
-        });
-    }
-    getUserById(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const user = yield this.get({ route: ["users", id] });
-            return user ? (0, E621User_1.parseUser)(user) : null;
-        });
-    }
-    // Posts
-    getPosts() {
-        return __awaiter(this, arguments, void 0, function* (options = {}) {
-            const response = yield this.get({
-                route: "posts",
-                params: options,
-            });
-            return (response === null || response === void 0 ? void 0 : response.posts.map(E621Post_1.parsePost)) || [];
-        });
-    }
-    getPostById(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.get({ route: ["posts", id] });
-            return (response === null || response === void 0 ? void 0 : response.post) ? (0, E621Post_1.parsePost)(response.post) : null;
-        });
-    }
-    // Favorites
-    getFavorites() {
-        return __awaiter(this, arguments, void 0, function* (options = {}) {
-            var _a;
-            const response = yield this.get({
-                route: "favorites",
-                params: (0, utils_1.translateOptions)(options, { userId: "user_id" }),
-            });
-            return ((_a = response === null || response === void 0 ? void 0 : response.posts) === null || _a === void 0 ? void 0 : _a.map(E621Post_1.parsePost)) || [];
-        });
-    }
-    // Account
-    setCredentials(credentials) {
-        this.credentials = credentials;
-        return this;
-    }
-    checkCredentials(credentials) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (credentials) {
-                this.setCredentials(credentials);
-            }
-            const headers = new E621ApiHeaders_1.E621ApiHeaders();
-            if (!this.isBrowser) {
-                headers.addUserAgent(this.client);
-            }
-            return yield fetch(this.buildUrl("favorites"), {
-                headers: headers.addAuthorization(this.credentials).build(),
-            })
-                .then((res) => res.ok)
-                .catch(() => false);
-        });
-    }
-    get(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ route, params, headers = new E621ApiHeaders_1.E621ApiHeaders(), }) {
-            if (!this.isBrowser) {
-                headers.addUserAgent(this.client);
-            }
-            const response = yield fetch(this.buildUrl(route, params), {
-                method: "GET",
-                headers: headers.addAuthorization(this.credentials).build(),
-            });
-            return response.json().catch(() => null);
-        });
-    }
-    buildUrl(route, params = {}) {
-        const queryParams = new URLSearchParams(params);
-        const url = E621ApiClient.BASE_URL + (0, utils_1.ensureArray)(route).join("/") + ".json";
-        if (this.isBrowser) {
-            queryParams.set("_client", this.client);
-        }
-        return queryParams.size > 0 ? `${url}?${queryParams}` : url;
-    }
-}
-exports.E621ApiClient = E621ApiClient;
-E621ApiClient.BASE_URL = "https://e621.net/";

package/dist/client/E621ApiHeaders.d.ts

@@ -1,10 +0,0 @@
-import { Credentials } from "./E621ApiClient";
-export declare class E621ApiHeaders {
-    private readonly value;
-    constructor(value?: Record<string, string>);
-    addAuthorization(credentials: Credentials | null): E621ApiHeaders;
-    addFormContentType(): E621ApiHeaders;
-    addUserAgent(userAgent: string): E621ApiHeaders;
-    build(): Record<string, string>;
-    protected static buildAuthorization({ username, apiKey }: Credentials): string;
-}

package/dist/client/E621ApiHeaders.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.E621ApiHeaders = void 0;
-class E621ApiHeaders {
-    constructor(value = {}) {
-        this.value = value;
-    }
-    addAuthorization(credentials) {
-        if (credentials) {
-            this.value.Authorization = E621ApiHeaders.buildAuthorization(credentials);
-        }
-        return this;
-    }
-    addFormContentType() {
-        this.value["Content-Type"] =
-            "application/x-www-form-urlencoded; charset=UTF-8";
-        return this;
-    }
-    addUserAgent(userAgent) {
-        this.value["User-Agent"] = userAgent;
-        return this;
-    }
-    build() {
-        return this.value;
-    }
-    static buildAuthorization({ username, apiKey }) {
-        const creds = `${username}:${apiKey}`;
-        if (canUseWindow()) {
-            return `Basic ${window.btoa(creds)}`;
-        }
-        else if (canUseBuffer()) {
-            return `Basic ${Buffer.from(creds).toString("base64")}`;
-        }
-        else {
-            throw new Error("Environment does not support base64 encoding");
-        }
-    }
-}
-exports.E621ApiHeaders = E621ApiHeaders;
-function canUseWindow() {
-    return typeof window !== "undefined";
-}
-function canUseBuffer() {
-    return typeof Buffer !== "undefined" && typeof Buffer.from === "function";
-}

package/dist/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./client/E621ApiClient";
-export * from "./types/e621/E621User";
-export * from "./types/e621/E621Post";

package/dist/index.js

@@ -1,19 +0,0 @@
-"use strict";
-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 __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./client/E621ApiClient"), exports);
-__exportStar(require("./types/e621/E621User"), exports);
-__exportStar(require("./types/e621/E621Post"), exports);

package/dist/types/e621/E621Post.d.ts

@@ -1,133 +0,0 @@
-export interface PostResponse {
-    id: number;
-    created_at: string;
-    updated_at: string;
-    file: {
-        width: number;
-        height: number;
-        ext: string;
-        size: number;
-        md5: string;
-        url: string;
-    };
-    preview: {
-        width: number;
-        height: number;
-        url: string | null;
-    };
-    sample: {
-        has: boolean;
-        width: number;
-        height: number;
-        url: string | null;
-    };
-    score: {
-        up: number;
-        down: number;
-        total: number;
-    };
-    tags: {
-        general: string[];
-        artist: string[];
-        copyright: string[];
-        character: string[];
-        species: string[];
-        invalid: string[];
-        meta: string[];
-        lore: string[];
-    };
-    locked_tags: string[];
-    change_seq: number;
-    flags: {
-        pending: boolean;
-        flagged: boolean;
-        note_locked: boolean;
-        status_locked: boolean;
-        rating_locked: boolean;
-        deleted: boolean;
-    };
-    rating: string;
-    fav_count: number;
-    sources: string[];
-    pools: number[];
-    relationships: {
-        parent_id: number | null;
-        has_children: boolean;
-        has_active_children: boolean;
-        children: number[];
-    };
-    approver_id: number | null;
-    uploader_id: number;
-    description: string;
-    comment_count: number;
-    is_favorited: boolean;
-    has_notes: boolean;
-    duration: number | null;
-}
-export interface E621Post {
-    id: number;
-    createdAt: Date;
-    updatedAt: Date;
-    file: {
-        width: number;
-        height: number;
-        ext: string;
-        size: number;
-        md5: string;
-        url: string;
-    };
-    preview: {
-        width: number;
-        height: number;
-        url: string | null;
-    };
-    sample: {
-        has: boolean;
-        width: number;
-        height: number;
-        url: string | null;
-    };
-    score: {
-        up: number;
-        down: number;
-        total: number;
-    };
-    tags: {
-        general: string[];
-        artist: string[];
-        copyright: string[];
-        character: string[];
-        species: string[];
-        invalid: string[];
-        meta: string[];
-        lore: string[];
-    };
-    lockedTags: string[];
-    changeSeq: number;
-    flags: {
-        pending: boolean;
-        flagged: boolean;
-        noteLocked: boolean;
-        statusLocked: boolean;
-        ratingLocked: boolean;
-        deleted: boolean;
-    };
-    rating: string;
-    favCount: number;
-    sources: string[];
-    pools: number[];
-    relationships: {
-        parentId: number | null;
-        hasChildren: boolean;
-        hasActiveChildren: boolean;
-        children: number[];
-    };
-    approverId: number | null;
-    uploaderId: number;
-    description: string;
-    commentCount: number;
-    isFavorited: boolean;
-    hasNotes: boolean;
-    duration: number | null;
-}
-export declare function parsePost(post: PostResponse): E621Post;

package/dist/types/e621/E621Post.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parsePost = void 0;
-function parsePost(post) {
-    return {
-        id: post.id,
-        createdAt: new Date(post.created_at),
-        updatedAt: new Date(post.updated_at),
-        file: post.file,
-        preview: post.preview,
-        sample: post.sample,
-        score: post.score,
-        tags: post.tags,
-        lockedTags: post.locked_tags,
-        changeSeq: post.change_seq,
-        flags: {
-            pending: post.flags.pending,
-            flagged: post.flags.flagged,
-            noteLocked: post.flags.note_locked,
-            statusLocked: post.flags.status_locked,
-            ratingLocked: post.flags.rating_locked,
-            deleted: post.flags.deleted,
-        },
-        rating: post.rating,
-        favCount: post.fav_count,
-        sources: post.sources,
-        pools: post.pools,
-        relationships: {
-            parentId: post.relationships.parent_id,
-            hasChildren: post.relationships.has_children,
-            hasActiveChildren: post.relationships.has_active_children,
-            children: post.relationships.children,
-        },
-        approverId: post.approver_id,
-        uploaderId: post.uploader_id,
-        description: post.description,
-        commentCount: post.comment_count,
-        isFavorited: post.is_favorited,
-        hasNotes: post.has_notes,
-        duration: post.duration,
-    };
-}
-exports.parsePost = parsePost;

package/dist/types/e621/E621User.d.ts

@@ -1,63 +0,0 @@
-export interface UserResponse {
-    wiki_page_version_count: number;
-    artist_version_count: number;
-    pool_version_count: number;
-    forum_post_count: number;
-    comment_count: number;
-    flag_count: number;
-    favorite_count: number;
-    positive_feedback_count: number;
-    neutral_feedback_count: number;
-    negative_feedback_count: number;
-    upload_limit: number;
-    profile_about: string;
-    profile_artinfo: string;
-    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;
-}
-export interface E621User {
-    id: number;
-    profile: {
-        name: string;
-        level: number;
-        about: string;
-        artInfo: string;
-        avatarId: number | null;
-        createdAt: Date;
-        levelString: string;
-    };
-    counts: {
-        wikiPageVersion: number;
-        artistVersion: number;
-        poolVersion: number;
-        forumPost: number;
-        comment: number;
-        flag: number;
-        favorite: number;
-        positiveFeedback: number;
-        neutralFeedback: number;
-        negativeFeedback: number;
-    };
-    limits: {
-        upload: number;
-        baseUpload: number;
-        postUpload: number;
-        postUpdate: number;
-        noteUpdate: number;
-    };
-    isBanned: boolean;
-    canApprovePosts: boolean;
-    canUploadFree: boolean;
-}
-export declare function parseUser(user: UserResponse): E621User;

package/dist/types/e621/E621User.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseUser = void 0;
-function parseUser(user) {
-    return {
-        id: user.id,
-        profile: {
-            name: user.name,
-            level: user.level,
-            about: user.profile_about,
-            artInfo: user.profile_artinfo,
-            avatarId: user.avatar_id,
-            createdAt: new Date(user.created_at),
-            levelString: user.level_string,
-        },
-        counts: {
-            wikiPageVersion: user.wiki_page_version_count,
-            artistVersion: user.artist_version_count,
-            poolVersion: user.pool_version_count,
-            forumPost: user.forum_post_count,
-            comment: user.comment_count,
-            flag: user.flag_count,
-            favorite: user.favorite_count,
-            positiveFeedback: user.positive_feedback_count,
-            neutralFeedback: user.neutral_feedback_count,
-            negativeFeedback: user.negative_feedback_count,
-        },
-        limits: {
-            upload: user.upload_limit,
-            baseUpload: user.base_upload_limit,
-            postUpload: user.post_upload_count,
-            postUpdate: user.post_update_count,
-            noteUpdate: user.note_update_count,
-        },
-        isBanned: user.is_banned,
-        canApprovePosts: user.can_approve_posts,
-        canUploadFree: user.can_upload_free,
-    };
-}
-exports.parseUser = parseUser;

package/dist/types/responses.d.ts

@@ -1,10 +0,0 @@
-import { PostResponse } from "./e621/E621Post";
-export type GetFavoritesResponse = {
-    posts: PostResponse[] | null;
-};
-export type GetPostResponse = {
-    post: PostResponse | null;
-};
-export type GetPostsResponse = {
-    posts: PostResponse[];
-};

package/dist/types/responses.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils.d.ts

@@ -1,2 +0,0 @@
-export declare function ensureArray<T>(value: T | T[]): T[];
-export declare function translateOptions<Options extends Record<string, string>>(options: Options, table: Partial<Options>): Record<string, string>;

package/dist/utils.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.translateOptions = exports.ensureArray = void 0;
-function ensureArray(value) {
-    if (Array.isArray(value)) {
-        return value;
-    }
-    return [value];
-}
-exports.ensureArray = ensureArray;
-function translateOptions(options, table) {
-    var _a;
-    const params = {};
-    for (const [key, value] of Object.entries(options)) {
-        params[(_a = table[key]) !== null && _a !== void 0 ? _a : key] = value;
-    }
-    return params;
-}
-exports.translateOptions = translateOptions;