e621-client 1.2.3 → 1.4.0

package/dist/client/E621ApiClient.d.ts

@@ -1,7 +1,7 @@
 import { E621Post } from "../types/e621/E621Post";
 import { E621User } from "../types/e621/E621User";
 import { E621ApiHeaders } from "./E621ApiHeaders";
-import { GetAllFavoritesOptions, GetFavoritesOptions, GetPostsOptions, GetUsersOptions, Params } from "./options";
+import { GetAllFavoritesOptions, GetFavoritesOptions, GetPostsOptions, GetUsersOptions, Params, PostFavoriteOptions } from "./options";
 /**
  * The option object used to initialize the API client.
  */
@@ -36,6 +36,12 @@ export type GetOptions = {
     params?: Params;
     headers?: E621ApiHeaders;
 };
+export type PostOptions = {
+    route: Route;
+    params?: Params;
+    body?: string;
+    headers?: E621ApiHeaders;
+};
 export interface Credentials {
     username: string;
     apiKey: string;
@@ -56,8 +62,10 @@ export declare class E621ApiClient {
     getPostById(id: EntityId): Promise<E621Post | null>;
     getFavorites(options?: GetFavoritesOptions): Promise<E621Post[]>;
     getAllFavorites(options?: GetAllFavoritesOptions): Promise<E621Post[]>;
+    makeFavorite(options: PostFavoriteOptions): Promise<boolean>;
     setCredentials(credentials: Credentials | null): E621ApiClient;
     checkCredentials(credentials?: Credentials): Promise<boolean>;
     get<E>({ route, params, headers, }: GetOptions): Promise<E | null>;
+    post<E>({ route, params, body, headers, }: PostOptions): Promise<E | null>;
     private buildUrl;
 }

package/dist/client/E621ApiClient.js

@@ -89,6 +89,16 @@ class E621ApiClient {
             return favorites;
         });
     }
+    makeFavorite(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.post({
+                route: "favorites",
+                headers: new E621ApiHeaders_1.E621ApiHeaders().addFormContentType(),
+                body: new URLSearchParams({ post_id: options.postId }).toString(),
+            });
+            return Boolean(response);
+        });
+    }
     // Account
     setCredentials(credentials) {
         this.credentials = credentials;
@@ -125,6 +135,28 @@ class E621ApiClient {
             }
         });
     }
+    post(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ route, params, body, headers = new E621ApiHeaders_1.E621ApiHeaders(), }) {
+            if (!this.isBrowser) {
+                headers.addUserAgent(this.client);
+            }
+            const url = this.buildUrl(route, params);
+            const response = yield fetch(url, {
+                method: "POST",
+                headers: headers.addAuthorization(this.credentials).build(),
+                body,
+            });
+            if (response.ok) {
+                return response.json();
+            }
+            else if (response.status === 404) {
+                return null;
+            }
+            else {
+                throw new Error(`Request to ${route} failed with status code ${response.status}: "${response.statusText}"`);
+            }
+        });
+    }
     buildUrl(route, params = {}) {
         const queryParams = new URLSearchParams(params);
         const url = E621ApiClient.BASE_URL + (0, utils_1.ensureArray)(route).join("/") + ".json";

package/dist/client/options.d.ts

@@ -21,5 +21,12 @@ export type GetFavoritesApiOptions = {
 export type GetAllFavoritesOptions = {
     userId?: string;
 };
+export type PostFavoriteOptions = {
+    postId: string;
+};
+export type PostFavoriteApiOptions = {
+    post_id: string;
+};
 export declare function translateGetUserOptions(options: GetUsersOptions): GetUserApiOptions;
 export declare function translateGetFavoritesOptions(options: GetFavoritesOptions): GetFavoritesApiOptions;
+export declare function translatePostFavoriteOptions(options: PostFavoriteOptions): PostFavoriteApiOptions;

package/dist/client/options.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.translateGetFavoritesOptions = exports.translateGetUserOptions = void 0;
+exports.translatePostFavoriteOptions = exports.translateGetFavoritesOptions = exports.translateGetUserOptions = void 0;
 const utils_1 = require("../utils");
 function translateGetUserOptions(options) {
     return (0, utils_1.translateOptions)(options, {
@@ -14,3 +14,9 @@ function translateGetFavoritesOptions(options) {
     });
 }
 exports.translateGetFavoritesOptions = translateGetFavoritesOptions;
+function translatePostFavoriteOptions(options) {
+    return (0, utils_1.translateOptions)(options, {
+        postId: "post_id",
+    });
+}
+exports.translatePostFavoriteOptions = translatePostFavoriteOptions;

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

@@ -25,6 +25,7 @@ export interface UserResponse {
     can_upload_free: boolean;
     level_string: string;
     avatar_id: number | null;
+    blacklisted_tags: string | null;
 }
 export interface E621User {
     id: number;
@@ -36,6 +37,7 @@ export interface E621User {
         artInfo: string;
         avatarId: number | null;
         levelString: string;
+        blacklistedTags: string;
     };
     counts: {
         wikiPageVersion: number;

package/dist/types/e621/E621User.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseUser = void 0;
 function parseUser(user) {
+    var _a;
     return {
         id: user.id,
         name: user.name,
@@ -12,6 +13,7 @@ function parseUser(user) {
             artInfo: user.profile_artinfo,
             avatarId: user.avatar_id,
             levelString: user.level_string,
+            blacklistedTags: (_a = user.blacklisted_tags) !== null && _a !== void 0 ? _a : "",
         },
         counts: {
             wikiPageVersion: user.wiki_page_version_count,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "e621-client",
-  "version": "1.2.3",
+  "version": "1.4.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {

package/src/client/E621ApiClient.ts

@@ -13,6 +13,7 @@ import {
   GetPostsOptions,
   GetUsersOptions,
   Params,
+  PostFavoriteOptions,
   translateGetFavoritesOptions,
   translateGetUserOptions,
 } from "./options";
@@ -57,6 +58,13 @@ export type GetOptions = {
   headers?: E621ApiHeaders;
 };
 
+export type PostOptions = {
+  route: Route;
+  params?: Params;
+  body?: string;
+  headers?: E621ApiHeaders;
+};
+
 export interface Credentials {
   username: string;
   apiKey: string;
@@ -150,6 +158,15 @@ export class E621ApiClient {
     return favorites;
   }
 
+  public async makeFavorite(options: PostFavoriteOptions): Promise<boolean> {
+    const response = await this.post({
+      route: "favorites",
+      headers: new E621ApiHeaders().addFormContentType(),
+      body: new URLSearchParams({ post_id: options.postId }).toString(),
+    });
+    return Boolean(response);
+  }
+
   // Account
   public setCredentials(credentials: Credentials | null): E621ApiClient {
     this.credentials = credentials;
@@ -192,6 +209,34 @@ export class E621ApiClient {
     }
   }
 
+  public async post<E>({
+    route,
+    params,
+    body,
+    headers = new E621ApiHeaders(),
+  }: PostOptions): Promise<E | null> {
+    if (!this.isBrowser) {
+      headers.addUserAgent(this.client);
+    }
+
+    const url = this.buildUrl(route, params);
+    const response = await fetch(url, {
+      method: "POST",
+      headers: headers.addAuthorization(this.credentials).build(),
+      body,
+    });
+
+    if (response.ok) {
+      return response.json();
+    } else if (response.status === 404) {
+      return null;
+    } else {
+      throw new Error(
+        `Request to ${route} failed with status code ${response.status}: "${response.statusText}"`
+      );
+    }
+  }
+
   private buildUrl(route: Route, params: Params = {}): string {
     const queryParams = new URLSearchParams(params);
     const url = E621ApiClient.BASE_URL + ensureArray(route).join("/") + ".json";

package/src/client/options.ts

@@ -16,8 +16,12 @@ export type GetFavoritesOptions = { userId?: string } & Pagination;
 export type GetFavoritesApiOptions = { user_id?: string } & Pagination;
 export type GetAllFavoritesOptions = { userId?: string };
 
+// POST /favorites
+export type PostFavoriteOptions = { postId: string };
+export type PostFavoriteApiOptions = { post_id: string };
+
 export function translateGetUserOptions(
-  options: GetUsersOptions,
+  options: GetUsersOptions
 ): GetUserApiOptions {
   return translateOptions(options, {
     nameMatches: "search[name_matches]",
@@ -25,9 +29,17 @@ export function translateGetUserOptions(
 }
 
 export function translateGetFavoritesOptions(
-  options: GetFavoritesOptions,
+  options: GetFavoritesOptions
 ): GetFavoritesApiOptions {
   return translateOptions(options, {
     userId: "user_id",
   });
 }
+
+export function translatePostFavoriteOptions(
+  options: PostFavoriteOptions
+): PostFavoriteApiOptions {
+  return translateOptions(options, {
+    postId: "post_id",
+  }) as PostFavoriteApiOptions;
+}

package/src/types/e621/E621User.ts

@@ -25,6 +25,7 @@ export interface UserResponse {
   can_upload_free: boolean;
   level_string: string;
   avatar_id: number | null;
+  blacklisted_tags: string | null;
 }
 
 export interface E621User {
@@ -38,6 +39,7 @@ export interface E621User {
     artInfo: string;
     avatarId: number | null;
     levelString: string;
+    blacklistedTags: string;
   };
 
   counts: {
@@ -78,6 +80,7 @@ export function parseUser(user: UserResponse): E621User {
       artInfo: user.profile_artinfo,
       avatarId: user.avatar_id,
       levelString: user.level_string,
+      blacklistedTags: user.blacklisted_tags ?? "",
     },
 
     counts: {