e621-client 1.2.2 → 1.3.0

package/README.md

@@ -1,47 +1,47 @@
-# e621 Client
-
-This is a small client to do some stuff with the e621 API. It is created to fit my needs, but you can use it too, if it works for you.
-
-I can't guarantee it will work in the future, so I recommend you just use another package instead or build a client yourself.
-
-### Supported Endpoints
-
-- `/favorites`
-- `/users`
-- `/users/:id`
-- `/posts`
-- `/posts/:id`
-
-### Getting Started
-
-Just create an instance of the client like so:
-
-```ts
-const client = new E621ApiClient({
-  client: "Your client name",
-  isBrowser: false,
-});
-```
-
-Now you can use it to do some stuff:
-
-```ts
-// not useful but still here (like me)
-const posts = await client.getPosts();
-
-// search posts by tags
-const postsWithTags = await client.getPosts({
-  tags: "male score:>100",
-});
-
-// search users by names (* for wildcards)
-const toms = await client.getUsers({
-  nameMatches: "tom*",
-});
-
-// if you have credentials set, they will be sent with your requests as well:
-client.setCredentials({
-  username: "HornyFurry",
-  apiKey: "wouldntyouliketoknowweatherboy",
-});
-```
+# e621 Client
+
+This is a small client to do some stuff with the e621 API. It is created to fit my needs, but you can use it too, if it works for you.
+
+I can't guarantee it will work in the future, so I recommend you just use another package instead or build a client yourself.
+
+### Supported Endpoints
+
+- `/favorites`
+- `/users`
+- `/users/:id`
+- `/posts`
+- `/posts/:id`
+
+### Getting Started
+
+Just create an instance of the client like so:
+
+```ts
+const client = new E621ApiClient({
+  client: "Your client name",
+  isBrowser: false,
+});
+```
+
+Now you can use it to do some stuff:
+
+```ts
+// not useful but still here (like me)
+const posts = await client.getPosts();
+
+// search posts by tags
+const postsWithTags = await client.getPosts({
+  tags: "male score:>100",
+});
+
+// search users by names (* for wildcards)
+const toms = await client.getUsers({
+  nameMatches: "tom*",
+});
+
+// if you have credentials set, they will be sent with your requests as well:
+client.setCredentials({
+  username: "HornyFurry",
+  apiKey: "wouldntyouliketoknowweatherboy",
+});
+```

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

@@ -73,15 +73,15 @@ class E621ApiClient {
             var _a, _b;
             // max page size on e621 api
             const favorites = [];
-            const limit = 300;
+            const limit = 320;
             let page = 1;
             while (true) {
                 if (this.debugLogs) {
                     const user = (_a = options.userId) !== null && _a !== void 0 ? _a : (_b = this.credentials) === null || _b === void 0 ? void 0 : _b.username;
-                    console.info(`page ${page} for user ${user}`);
+                    console.info("User", user, "page", page);
                 }
                 const posts = yield this.getFavorites(Object.assign(Object.assign({}, options), { page: String(page++), limit: String(limit) }));
-                if (posts.length === 0)
+                if (posts.length === 0 || posts.length < limit)
                     break;
                 favorites.push(...posts);
                 yield (0, utils_1.delay)(this.batchRateLimit);
@@ -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/package.json

@@ -1,24 +1,24 @@
-{
-  "name": "e621-client",
-  "version": "1.2.2",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "test": "jest",
-    "build": "tsc",
-    "prepublishOnly": "tsc"
-  },
-  "keywords": [],
-  "author": "Tommus",
-  "license": "ISC",
-  "description": "A simple client for the e621 API",
-  "devDependencies": {
-    "@types/jest": "^29.5.12",
-    "@types/node": "^20.14.2",
-    "jest": "^29.7.0",
-    "prettier": "^3.3.1",
-    "ts-jest": "^29.2.3",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.4.5"
-  }
-}
+{
+  "name": "e621-client",
+  "version": "1.3.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "test": "jest",
+    "build": "tsc",
+    "prepublishOnly": "tsc"
+  },
+  "keywords": [],
+  "author": "Tommus",
+  "license": "ISC",
+  "description": "A simple client for the e621 API",
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.14.2",
+    "jest": "^29.7.0",
+    "prettier": "^3.3.1",
+    "ts-jest": "^29.2.3",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.5"
+  }
+}

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;
@@ -113,7 +121,7 @@ export class E621ApiClient {
 
   // Favorites
   public async getFavorites(
-    options: GetFavoritesOptions = {},
+    options: GetFavoritesOptions = {}
   ): Promise<E621Post[]> {
     const response = await this.get<GetFavoritesResponse>({
       route: "favorites",
@@ -123,17 +131,17 @@ export class E621ApiClient {
   }
 
   public async getAllFavorites(
-    options: GetAllFavoritesOptions = {},
+    options: GetAllFavoritesOptions = {}
   ): Promise<E621Post[]> {
     // max page size on e621 api
     const favorites: E621Post[] = [];
-    const limit = 300;
+    const limit = 320;
     let page = 1;
 
     while (true) {
       if (this.debugLogs) {
         const user = options.userId ?? this.credentials?.username;
-        console.info(`page ${page} for user ${user}`);
+        console.info("User", user, "page", page);
       }
 
       const posts = await this.getFavorites({
@@ -142,7 +150,7 @@ export class E621ApiClient {
         limit: String(limit),
       });
 
-      if (posts.length === 0) break;
+      if (posts.length === 0 || posts.length < limit) break;
       favorites.push(...posts);
       await delay(this.batchRateLimit);
     }
@@ -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;
@@ -187,7 +204,35 @@ export class E621ApiClient {
       return null;
     } else {
       throw new Error(
-        `Request to ${route} failed with status code ${response.status}: "${response.statusText}"`,
+        `Request to ${route} failed with status code ${response.status}: "${response.statusText}"`
+      );
+    }
+  }
+
+  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}"`
       );
     }
   }

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/demo.ts

@@ -1,12 +0,0 @@
-import { E621ApiClient } from "./src/client/E621ApiClient";
-
-async function demo() {
-  const client = new E621ApiClient({
-    isBrowser: false,
-    client: "EstoBox (by Tommus621 on e621)",
-  });
-  const favs = await client.getFavorites({ userId: "964986", page: "2" });
-  console.log(favs.length);
-}
-
-demo().finally();