e621 3.1.0 → 3.2.1

package/dist/lib/Debug.browser.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Browser build of {@link Debug}. `debug`/`persistent-debug` are Node-only optional dependencies whose
+ * dynamic imports break browser bundlers (see #15), so this no-op variant is swapped in via
+ * package.json's `browser` field.
+ */
+export default function Debug(_namespace: string, _formatter: unknown, ..._args: Array<unknown>): void;

package/dist/lib/Debug.browser.js

@@ -0,0 +1,8 @@
+/**
+ * Browser build of {@link Debug}. `debug`/`persistent-debug` are Node-only optional dependencies whose
+ * dynamic imports break browser bundlers (see #15), so this no-op variant is swapped in via
+ * package.json's `browser` field.
+ */
+// eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-empty-function
+export default function Debug(_namespace, _formatter, ..._args) { }
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRGVidWcuYnJvd3Nlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL2xpYi9EZWJ1Zy5icm93c2VyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOzs7O0dBSUc7QUFDSCxtR0FBbUc7QUFDbkcsTUFBTSxDQUFDLE9BQU8sVUFBVSxLQUFLLENBQUMsVUFBa0IsRUFBRSxVQUFtQixFQUFFLEdBQUcsS0FBcUIsSUFBUyxDQUFDIn0=

package/dist/lib/client.d.ts

@@ -0,0 +1,68 @@
+import type { Client } from "./generated/client/types.js";
+import type { NoV2Options, PostFormatOptions } from "./modules/posts/Format.js";
+/** @category Main */
+export interface Options<PF extends PostFormatOptions = NoV2Options> {
+    /**
+     * The api key you want to authenticate with (Account -> Manage API Access)
+     * @default none
+     */
+    authKey?: string;
+    /**
+     * The uername of the user you want to authenticate with
+     * @default none
+     */
+    authUser?: string;
+    /**
+     * The base URL for the API.
+     * @default https://e621.net
+     */
+    baseURL?: string;
+    /**
+     * The v2/mode format every post-returning method across the lib falls back to when called without
+     * explicit `v2`/`mode` options (e.g. `posts.get()`, `posts.search()`, `favorites.search()`,
+     * `popular.get()`, `iqdbQueries.get()`/`.post()`, and convenience methods on returned post models like
+     * `post.update()`). Per-call options still take priority over this.
+     * @default legacy (v2: false)
+     */
+    defaultPostFormat?: PF;
+    /**
+     * The number of seconds before a request times out
+     * @default 30
+     */
+    requestTimeout?: number;
+    /**
+     * The url to use for status checks.
+     * @default https://status.e621.church/json
+     */
+    statusCheckURL?: string;
+    /**
+     * The user agent to use for requests
+     * @defaultWithoutAuthentication E621/\{version\} (+https://github.com/DonovanDMC/E621)
+     * @defaultWithAuthentication E621/\{version\} (+https://github.com/DonovanDMC/E621; \{authUser\})
+     */
+    userAgent?: string;
+}
+/** @category Main */
+export interface InstanceOptions {
+    authKey: string | null;
+    authUser: string | null;
+    baseURL: string;
+    requestTimeout: number;
+    statusCheckURL: string;
+    userAgent: string;
+}
+/** @category Main */
+export interface E621ClientResult {
+    client: Client;
+    options: InstanceOptions;
+}
+/**
+ * Builds the generated API {@link Client} and resolved {@link InstanceOptions} used by the main {@link E621}
+ * class, handling auth header injection, the default user agent, and request/response {@link Debug} logging.
+ *
+ * Exposed standalone (see `e621/standalone`) so modules can be constructed directly, without the full
+ * {@link E621} client, when bundle size matters more than convenience.
+ *
+ * @category Main
+ */
+export declare function createE621Client<const PF extends PostFormatOptions = NoV2Options>(options?: Options<PF>): E621ClientResult;

package/dist/lib/client.js

@@ -0,0 +1,72 @@
+import Debug from "./Debug.js";
+import { createClient } from "./generated/client/client.js";
+import { createConfig } from "./generated/client/utils.js";
+import { VERSION } from "./version.js";
+/**
+ * Builds the generated API {@link Client} and resolved {@link InstanceOptions} used by the main {@link E621}
+ * class, handling auth header injection, the default user agent, and request/response {@link Debug} logging.
+ *
+ * Exposed standalone (see `e621/standalone`) so modules can be constructed directly, without the full
+ * {@link E621} client, when bundle size matters more than convenience.
+ *
+ * @category Main
+ */
+export function createE621Client(options) {
+    const resolved = {
+        authKey: options?.authKey ?? null,
+        authUser: options?.authUser ?? null,
+        baseURL: options?.baseURL ?? "https://e621.net",
+        requestTimeout: options?.requestTimeout ?? 30,
+        statusCheckURL: options?.statusCheckURL ?? "https://status.e621.church/json",
+        userAgent: options?.userAgent ?? `E621/${VERSION} (https://github.com/DonovanDMC/E621${options?.authUser ? `; "${options.authUser}"` : ""})`,
+    };
+    let config;
+    const commonConfig = {
+        baseUrl: resolved.baseURL,
+        headers: {
+            "User-Agent": resolved.userAgent,
+        },
+        fetch: async (input, init) => {
+            let url = "unknown", method = "unknown";
+            // for some reason it doesn't seem to be inserting the Authorization header
+            if (input instanceof Request) {
+                url = input.url;
+                method = input.method.toLowerCase();
+                if (!input.headers.has("Auithorization") && resolved.authKey && resolved.authUser) {
+                    input.headers.set("Authorization", `Basic ${btoa(`${resolved.authUser}:${resolved.authKey}`)}`);
+                }
+            }
+            else if (init) {
+                url = input.toString();
+                method = init.method?.toLowerCase() ?? "get";
+                if (resolved.authKey && resolved.authUser) {
+                    const headers = new Headers(init.headers);
+                    if (!headers.has("Authorization")) {
+                        headers.set("Authorization", `Basic ${btoa(`${resolved.authUser}:${resolved.authKey}`)}`);
+                    }
+                    init.headers = headers;
+                }
+            }
+            Debug(`request:${method}`, `-> ${url}`);
+            const res = await fetch(input, init);
+            Debug(`response:${method}`, `<- ${url} ${res.status} ${res.statusText}`);
+            return res;
+        },
+    };
+    if (resolved.authKey && resolved.authUser) {
+        config = createConfig({
+            ...commonConfig,
+            auth: (auth) => {
+                if (auth.scheme === "basic") {
+                    return `${resolved.authUser}:${resolved.authKey}`;
+                }
+                return;
+            },
+        });
+    }
+    else {
+        config = createConfig(commonConfig);
+    }
+    return { client: createClient(config), options: resolved };
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpZW50LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vbGliL2NsaWVudC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssTUFBTSxZQUFZLENBQUM7QUFDL0IsT0FBTyxFQUFFLFlBQVksRUFBRSxNQUFNLDhCQUE4QixDQUFDO0FBQzVELE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSw2QkFBNkIsQ0FBQztBQUMzRCxPQUFPLEVBQUUsT0FBTyxFQUFFLE1BQU0sY0FBYyxDQUFDO0FBZ0V2Qzs7Ozs7Ozs7R0FRRztBQUNILE1BQU0sVUFBVSxnQkFBZ0IsQ0FBbUQsT0FBcUI7SUFDcEcsTUFBTSxRQUFRLEdBQW9CO1FBQzlCLE9BQU8sRUFBRSxPQUFPLEVBQUUsT0FBTyxJQUFJLElBQUk7UUFDakMsUUFBUSxFQUFFLE9BQU8sRUFBRSxRQUFRLElBQUksSUFBSTtRQUNuQyxPQUFPLEVBQUUsT0FBTyxFQUFFLE9BQU8sSUFBSSxrQkFBa0I7UUFDL0MsY0FBYyxFQUFFLE9BQU8sRUFBRSxjQUFjLElBQUksRUFBRTtRQUM3QyxjQUFjLEVBQUUsT0FBTyxFQUFFLGNBQWMsSUFBSSxpQ0FBaUM7UUFDNUUsU0FBUyxFQUFFLE9BQU8sRUFBRSxTQUFTLElBQUksUUFBUSxPQUFPLHVDQUF1QyxPQUFPLEVBQUUsUUFBUSxDQUFDLENBQUMsQ0FBQyxNQUFNLE9BQU8sQ0FBQyxRQUFRLEdBQUcsQ0FBQyxDQUFDLENBQUMsRUFBRSxHQUFHO0tBQy9JLENBQUM7SUFDRixJQUFJLE1BQWMsQ0FBQztJQUNuQixNQUFNLFlBQVksR0FBZ0Q7UUFDOUQsT0FBTyxFQUFFLFFBQVEsQ0FBQyxPQUFPO1FBQ3pCLE9BQU8sRUFBRTtZQUNMLFlBQVksRUFBRSxRQUFRLENBQUMsU0FBUztTQUNuQztRQUNELEtBQUssRUFBRSxLQUFLLEVBQUUsS0FBSyxFQUFFLElBQUksRUFBcUIsRUFBRTtZQUM1QyxJQUFJLEdBQUcsR0FBRyxTQUFTLEVBQUUsTUFBTSxHQUFHLFNBQVMsQ0FBQztZQUN4QywyRUFBMkU7WUFDM0UsSUFBSSxLQUFLLFlBQVksT0FBTyxFQUFFLENBQUM7Z0JBQzNCLEdBQUcsR0FBRyxLQUFLLENBQUMsR0FBRyxDQUFDO2dCQUNoQixNQUFNLEdBQUcsS0FBSyxDQUFDLE1BQU0sQ0FBQyxXQUFXLEVBQUUsQ0FBQztnQkFDcEMsSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLGdCQUFnQixDQUFDLElBQUksUUFBUSxDQUFDLE9BQU8sSUFBSSxRQUFRLENBQUMsUUFBUSxFQUFFLENBQUM7b0JBQ2hGLEtBQUssQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLGVBQWUsRUFBRSxTQUFTLElBQUksQ0FBQyxHQUFHLFFBQVEsQ0FBQyxRQUFRLElBQUksUUFBUSxDQUFDLE9BQU8sRUFBRSxDQUFDLEVBQUUsQ0FBQyxDQUFDO2dCQUNwRyxDQUFDO1lBQ0wsQ0FBQztpQkFBTSxJQUFJLElBQUksRUFBRSxDQUFDO2dCQUNkLEdBQUcsR0FBRyxLQUFLLENBQUMsUUFBUSxFQUFFLENBQUM7Z0JBQ3ZCLE1BQU0sR0FBRyxJQUFJLENBQUMsTUFBTSxFQUFFLFdBQVcsRUFBRSxJQUFJLEtBQUssQ0FBQztnQkFDN0MsSUFBSSxRQUFRLENBQUMsT0FBTyxJQUFJLFFBQVEsQ0FBQyxRQUFRLEVBQUUsQ0FBQztvQkFDeEMsTUFBTSxPQUFPLEdBQUcsSUFBSSxPQUFPLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDO29CQUMxQyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxlQUFlLENBQUMsRUFBRSxDQUFDO3dCQUNoQyxPQUFPLENBQUMsR0FBRyxDQUFDLGVBQWUsRUFBRSxTQUFTLElBQUksQ0FBQyxHQUFHLFFBQVEsQ0FBQyxRQUFRLElBQUksUUFBUSxDQUFDLE9BQU8sRUFBRSxDQUFDLEVBQUUsQ0FBQyxDQUFDO29CQUM5RixDQUFDO29CQUNELElBQUksQ0FBQyxPQUFPLEdBQUcsT0FBTyxDQUFDO2dCQUMzQixDQUFDO1lBQ0wsQ0FBQztZQUNELEtBQUssQ0FBQyxXQUFXLE1BQU0sRUFBRSxFQUFFLE1BQU0sR0FBRyxFQUFFLENBQUMsQ0FBQztZQUN4QyxNQUFNLEdBQUcsR0FBRyxNQUFNLEtBQUssQ0FBQyxLQUFLLEVBQUUsSUFBSSxDQUFDLENBQUM7WUFDckMsS0FBSyxDQUFDLFlBQVksTUFBTSxFQUFFLEVBQUUsTUFBTSxHQUFHLElBQUksR0FBRyxDQUFDLE1BQU0sSUFBSSxHQUFHLENBQUMsVUFBVSxFQUFFLENBQUMsQ0FBQztZQUN6RSxPQUFPLEdBQUcsQ0FBQztRQUNmLENBQUM7S0FDSixDQUFDO0lBQ0YsSUFBSSxRQUFRLENBQUMsT0FBTyxJQUFJLFFBQVEsQ0FBQyxRQUFRLEVBQUUsQ0FBQztRQUN4QyxNQUFNLEdBQUcsWUFBWSxDQUFDO1lBQ2xCLEdBQUcsWUFBWTtZQUNmLElBQUksRUFBRSxDQUFDLElBQUksRUFBRSxFQUFFO2dCQUNYLElBQUksSUFBSSxDQUFDLE1BQU0sS0FBSyxPQUFPLEVBQUUsQ0FBQztvQkFDMUIsT0FBTyxHQUFHLFFBQVEsQ0FBQyxRQUFRLElBQUksUUFBUSxDQUFDLE9BQU8sRUFBRSxDQUFDO2dCQUN0RCxDQUFDO2dCQUVELE9BQU87WUFDWCxDQUFDO1NBQ0osQ0FBQyxDQUFDO0lBQ1AsQ0FBQztTQUFNLENBQUM7UUFDSixNQUFNLEdBQUcsWUFBWSxDQUFDLFlBQVksQ0FBQyxDQUFDO0lBQ3hDLENBQUM7SUFFRCxPQUFPLEVBQUUsTUFBTSxFQUFFLFlBQVksQ0FBQyxNQUFNLENBQUMsRUFBRSxPQUFPLEVBQUUsUUFBUSxFQUFFLENBQUM7QUFDL0QsQ0FBQyJ9

package/dist/lib/generated/schemas.d.ts

@@ -55,8 +55,13 @@ export declare const FeedbackCategoriesSchema: {
     readonly enum: readonly ["negative", "neutral", "positive"];
 };
 export declare const TagRequestStatusesSchema: {
-    readonly type: "string";
-    readonly enum: readonly ["active", "deleted", "processing", "queued", "retired", "error", "pending"];
+    readonly oneOf: readonly [{
+        readonly type: "string";
+        readonly enum: readonly ["active", "deleted", "processing", "queued", "retired", "pending"];
+    }, {
+        readonly type: "string";
+        readonly pattern: "^error: .*$";
+    }];
 };
 export declare const WarningTypesSchema: {
     readonly type: "string";