fanfou 0.1.0

package/dist/client.js

@@ -0,0 +1,490 @@
+import { authorizationHeader, fanfouSignatureURL, percentEncode } from "./oauth1.js";
+export class FanfouHttpError extends Error {
+    status;
+    body;
+    constructor(status, body) {
+        super(`HTTP ${status}: ${body.slice(0, 500)}`);
+        this.name = "FanfouHttpError";
+        this.status = status;
+        this.body = body;
+    }
+}
+function compact(pairs) {
+    if (!pairs)
+        return [];
+    const out = [];
+    for (const [k, v] of pairs) {
+        if (v !== undefined && v !== null && v !== "")
+            out.push([k, v]);
+    }
+    return out;
+}
+export class FanfouClient {
+    apiBaseURL;
+    oauthBaseURL;
+    consumerKey;
+    consumerSecret;
+    token;
+    tokenSecret;
+    dryRun;
+    userAgent;
+    source;
+    timeoutMs;
+    constructor(config) {
+        this.apiBaseURL = config.apiBaseURL ?? "https://api.fanfou.com/";
+        this.oauthBaseURL = config.oauthBaseURL ?? "https://fanfou.com/";
+        this.consumerKey = config.consumerKey;
+        this.consumerSecret = config.consumerSecret;
+        this.token = config.token;
+        this.tokenSecret = config.tokenSecret;
+        this.dryRun = config.dryRun ?? false;
+        this.userAgent = config.userAgent ?? "fanfou-cli/0.1";
+        this.source = config.source ?? "fanfou-cli";
+        this.timeoutMs = config.timeoutMs ?? 30000;
+    }
+    get isAuthenticated() {
+        return Boolean(this.token && this.tokenSecret);
+    }
+    buildURL(base, path, query) {
+        const url = new URL(path.replace(/^\//, ""), base);
+        for (const [k, v] of query)
+            url.searchParams.append(k, v);
+        return url;
+    }
+    /** Builds the signed request description without performing it (used by --dry-run). */
+    plan(opts) {
+        const base = opts.base === "oauth" ? this.oauthBaseURL : this.apiBaseURL;
+        const query = compact(opts.query);
+        const form = compact(opts.form);
+        const url = this.buildURL(base, opts.path, query);
+        const bodyForSignature = opts.file ? [] : form;
+        const authorization = authorizationHeader({
+            method: opts.method,
+            url,
+            consumerKey: this.consumerKey,
+            consumerSecret: this.consumerSecret,
+            token: this.token,
+            tokenSecret: this.tokenSecret ?? "",
+            extraParameters: opts.oauthExtra ?? [],
+            bodyParameters: bodyForSignature,
+            signatureURL: fanfouSignatureURL(url),
+        });
+        const plan = {
+            method: opts.method,
+            url: url.toString(),
+            query: Object.fromEntries(query),
+            authorization,
+        };
+        if (opts.file) {
+            plan.multipartFields = Object.fromEntries(compact(opts.multipart));
+            plan.file = {
+                fieldName: opts.file.fieldName,
+                fileName: opts.file.fileName,
+                mimeType: opts.file.mimeType,
+                bytes: opts.file.data.length,
+            };
+        }
+        else if (form.length > 0) {
+            plan.form = Object.fromEntries(form);
+        }
+        return plan;
+    }
+    async request(opts) {
+        const plan = this.plan(opts);
+        if (this.dryRun) {
+            return { status: 0, text: "", plan };
+        }
+        const headers = {
+            "User-Agent": this.userAgent,
+            Accept: "application/json",
+            Authorization: plan.authorization,
+        };
+        let body;
+        if (opts.file) {
+            const fd = new FormData();
+            for (const [k, v] of compact(opts.multipart))
+                fd.append(k, v);
+            fd.append(opts.file.fieldName, new Blob([new Uint8Array(opts.file.data)], { type: opts.file.mimeType }), opts.file.fileName);
+            body = fd;
+        }
+        else {
+            const form = compact(opts.form);
+            if (form.length > 0) {
+                headers["Content-Type"] = "application/x-www-form-urlencoded; charset=utf-8";
+                body = form.map(([k, v]) => `${percentEncode(k)}=${percentEncode(v)}`).join("&");
+            }
+        }
+        const controller = new AbortController();
+        const timer = setTimeout(() => controller.abort(), this.timeoutMs);
+        let response;
+        try {
+            response = await fetch(plan.url, {
+                method: opts.method,
+                headers,
+                body,
+                signal: controller.signal,
+            });
+        }
+        finally {
+            clearTimeout(timer);
+        }
+        const text = await response.text();
+        if (response.status < 200 || response.status >= 300) {
+            throw new FanfouHttpError(response.status, text);
+        }
+        return { status: response.status, text, plan };
+    }
+    async requestJSON(opts) {
+        const { text, plan } = await this.request(opts);
+        if (this.dryRun)
+            return { dryRun: true, request: plan };
+        if (!text)
+            throw new Error("饭否没有返回内容 (empty response)");
+        try {
+            return JSON.parse(text);
+        }
+        catch {
+            throw new Error(`JSON 解析失败 (could not parse response):\n${text.slice(0, 300)}`);
+        }
+    }
+    async requestText(opts) {
+        const { text } = await this.request(opts);
+        return text;
+    }
+    // ---- OAuth / auth -----------------------------------------------------
+    static parseTokenResponse(raw) {
+        const values = {};
+        for (const component of raw.trim().split("&")) {
+            const idx = component.indexOf("=");
+            if (idx < 0)
+                continue;
+            const key = decodeURIComponent(component.slice(0, idx));
+            const value = decodeURIComponent(component.slice(idx + 1));
+            values[key] = value;
+        }
+        const token = values["oauth_token"] ?? "";
+        const secret = values["oauth_token_secret"] ?? "";
+        if (!token || !secret)
+            throw new Error(`无效的 token 响应 (invalid token response): ${raw.slice(0, 200)}`);
+        const extra = { ...values };
+        delete extra["oauth_token"];
+        delete extra["oauth_token_secret"];
+        return { token, secret, extra };
+    }
+    /** XAuth: exchange username + password directly for an access token. */
+    async xauthLogin(username, password) {
+        const text = await this.requestText({
+            base: "oauth",
+            path: "oauth/access_token",
+            method: "GET",
+            oauthExtra: [
+                ["x_auth_username", username],
+                ["x_auth_password", password],
+                ["x_auth_mode", "client_auth"],
+            ],
+        });
+        const parsed = FanfouClient.parseTokenResponse(text);
+        return { token: parsed.token, secret: parsed.secret };
+    }
+    /** OAuth step 1: obtain a temporary request token. */
+    async requestToken(callback = "oob") {
+        const text = await this.requestText({
+            base: "oauth",
+            path: "oauth/request_token",
+            method: "GET",
+            oauthExtra: callback ? [["oauth_callback", callback]] : [],
+        });
+        const parsed = FanfouClient.parseTokenResponse(text);
+        return { token: parsed.token, secret: parsed.secret };
+    }
+    authorizeURL(requestToken, callback) {
+        const url = new URL("oauth/authorize", this.oauthBaseURL);
+        url.searchParams.set("oauth_token", requestToken);
+        if (callback)
+            url.searchParams.set("oauth_callback", callback);
+        return url.toString();
+    }
+    /** OAuth step 2: exchange an authorized request token for an access token. */
+    async accessToken(requestToken, requestTokenSecret, verifier) {
+        const tmp = new FanfouClient({
+            apiBaseURL: this.apiBaseURL,
+            oauthBaseURL: this.oauthBaseURL,
+            consumerKey: this.consumerKey,
+            consumerSecret: this.consumerSecret,
+            token: requestToken,
+            tokenSecret: requestTokenSecret,
+            dryRun: this.dryRun,
+        });
+        const text = await tmp.requestText({
+            base: "oauth",
+            path: "oauth/access_token",
+            method: "GET",
+            oauthExtra: verifier ? [["oauth_verifier", verifier]] : [],
+        });
+        const parsed = FanfouClient.parseTokenResponse(text);
+        return { token: parsed.token, secret: parsed.secret };
+    }
+    // ---- Account ----------------------------------------------------------
+    verifyCredentials() {
+        return this.requestJSON({ path: "account/verify_credentials.json", method: "GET" });
+    }
+    notification() {
+        return this.requestJSON({ path: "account/notification.json", method: "GET" });
+    }
+    updateProfile(fields) {
+        return this.requestJSON({
+            path: "account/update_profile.json",
+            method: "POST",
+            form: [
+                ["name", fields.name],
+                ["location", fields.location],
+                ["url", fields.url],
+                ["description", fields.description],
+            ],
+        });
+    }
+    updateProfileImage(file) {
+        return this.requestJSON({
+            path: "account/update_profile_image.json",
+            method: "POST",
+            file: { ...file, fieldName: "image" },
+        });
+    }
+    // ---- Timelines --------------------------------------------------------
+    timeline(path, opts) {
+        return this.requestJSON({
+            path,
+            method: "GET",
+            query: [
+                ["id", opts.id],
+                ["since_id", opts.sinceId],
+                ["max_id", opts.maxId],
+                ["count", opts.count != null ? String(opts.count) : undefined],
+                ["page", opts.page != null ? String(opts.page) : undefined],
+            ],
+        });
+    }
+    homeTimeline(opts = {}) {
+        return this.timeline("statuses/home_timeline.json", opts);
+    }
+    publicTimeline(opts = {}) {
+        return this.timeline("statuses/public_timeline.json", opts);
+    }
+    userTimeline(opts = {}) {
+        return this.timeline("statuses/user_timeline.json", opts);
+    }
+    mentions(opts = {}) {
+        return this.timeline("statuses/mentions.json", opts);
+    }
+    contextTimeline(id) {
+        return this.requestJSON({ path: "statuses/context_timeline.json", method: "GET", query: [["id", id]] });
+    }
+    photoUserTimeline(opts = {}) {
+        return this.timeline("photos/user_timeline.json", opts);
+    }
+    // ---- Search -----------------------------------------------------------
+    searchPublicTimeline(q, opts = {}) {
+        return this.requestJSON({
+            path: "search/public_timeline.json",
+            method: "GET",
+            query: [
+                ["q", q],
+                ["since_id", opts.sinceId],
+                ["max_id", opts.maxId],
+                ["count", opts.count != null ? String(opts.count) : undefined],
+            ],
+        });
+    }
+    searchUsers(q, opts = {}) {
+        return this.requestJSON({
+            path: "search/users.json",
+            method: "GET",
+            query: [
+                ["q", q],
+                ["count", opts.count != null ? String(opts.count) : undefined],
+                ["page", opts.page != null ? String(opts.page) : undefined],
+            ],
+        });
+    }
+    // ---- Statuses ---------------------------------------------------------
+    showStatus(id) {
+        return this.requestJSON({ path: "statuses/show.json", method: "GET", query: [["id", id]] });
+    }
+    updateStatus(opts) {
+        return this.requestJSON({
+            path: "statuses/update.json",
+            method: "POST",
+            form: [
+                ["status", opts.status],
+                ["in_reply_to_status_id", opts.inReplyToStatusId],
+                ["in_reply_to_user_id", opts.inReplyToUserId],
+                ["repost_status_id", opts.repostStatusId],
+                ["location", opts.location],
+                ["source", this.source],
+            ],
+        });
+    }
+    uploadPhoto(file, status, location) {
+        return this.requestJSON({
+            path: "photos/upload.json",
+            method: "POST",
+            multipart: [
+                ["status", status],
+                ["location", location ?? ""],
+                ["source", this.source],
+            ],
+            file: { ...file, fieldName: "photo" },
+        });
+    }
+    destroyStatus(id) {
+        return this.requestJSON({ path: "statuses/destroy.json", method: "POST", form: [["id", id]] });
+    }
+    // ---- Users & relationships -------------------------------------------
+    showUser(id) {
+        return this.requestJSON({ path: "users/show.json", method: "GET", query: [["id", id]] });
+    }
+    friends(opts = {}) {
+        return this.requestJSON({
+            path: "users/friends.json",
+            method: "GET",
+            query: [
+                ["id", opts.id],
+                ["count", opts.count != null ? String(opts.count) : undefined],
+                ["page", opts.page != null ? String(opts.page) : undefined],
+            ],
+        });
+    }
+    followers(opts = {}) {
+        return this.requestJSON({
+            path: "users/followers.json",
+            method: "GET",
+            query: [
+                ["id", opts.id],
+                ["count", opts.count != null ? String(opts.count) : undefined],
+                ["page", opts.page != null ? String(opts.page) : undefined],
+            ],
+        });
+    }
+    followUser(id) {
+        return this.requestJSON({ path: "friendships/create.json", method: "POST", form: [["id", id]] });
+    }
+    unfollowUser(id) {
+        return this.requestJSON({ path: "friendships/destroy.json", method: "POST", form: [["id", id]] });
+    }
+    async friendshipExists(userA, userB) {
+        const text = await this.requestText({
+            path: "friendships/exists.json",
+            method: "GET",
+            query: [
+                ["user_a", userA],
+                ["user_b", userB],
+            ],
+        });
+        return text.trim().toLowerCase() === "true";
+    }
+    friendshipRequests(opts = {}) {
+        return this.requestJSON({
+            path: "friendships/requests.json",
+            method: "GET",
+            query: [
+                ["count", opts.count != null ? String(opts.count) : undefined],
+                ["page", opts.page != null ? String(opts.page) : undefined],
+            ],
+        });
+    }
+    acceptFriendship(id) {
+        return this.requestJSON({ path: "friendships/accept.json", method: "POST", form: [["id", id]] });
+    }
+    denyFriendship(id) {
+        return this.requestJSON({ path: "friendships/deny.json", method: "POST", form: [["id", id]] });
+    }
+    // ---- Blocks -----------------------------------------------------------
+    blockedUsers(opts = {}) {
+        return this.requestJSON({
+            path: "blocks/blocking.json",
+            method: "GET",
+            query: [
+                ["count", opts.count != null ? String(opts.count) : undefined],
+                ["page", opts.page != null ? String(opts.page) : undefined],
+            ],
+        });
+    }
+    blockUser(id) {
+        return this.requestJSON({ path: "blocks/create.json", method: "POST", form: [["id", id]] });
+    }
+    unblockUser(id) {
+        return this.requestJSON({ path: "blocks/destroy.json", method: "POST", form: [["id", id]] });
+    }
+    async isBlocked(id) {
+        try {
+            await this.requestJSON({ path: "blocks/exists.json", method: "GET", query: [["id", id]] });
+            return true;
+        }
+        catch (err) {
+            if (err instanceof FanfouHttpError && (err.status === 403 || err.status === 404))
+                return false;
+            throw err;
+        }
+    }
+    // ---- Favorites --------------------------------------------------------
+    favorites(opts = {}) {
+        return this.requestJSON({
+            path: "favorites.json",
+            method: "GET",
+            query: [
+                ["id", opts.id],
+                ["count", opts.count != null ? String(opts.count) : undefined],
+                ["page", opts.page != null ? String(opts.page) : undefined],
+            ],
+        });
+    }
+    createFavorite(statusId) {
+        return this.requestJSON({ path: `favorites/create/${statusId}.json`, method: "POST" });
+    }
+    destroyFavorite(statusId) {
+        return this.requestJSON({ path: `favorites/destroy/${statusId}.json`, method: "POST" });
+    }
+    // ---- Direct messages --------------------------------------------------
+    conversationList(opts = {}) {
+        return this.requestJSON({
+            path: "direct_messages/conversation_list.json",
+            method: "GET",
+            query: [
+                ["count", opts.count != null ? String(opts.count) : undefined],
+                ["page", opts.page != null ? String(opts.page) : undefined],
+            ],
+        });
+    }
+    conversation(id, opts = {}) {
+        return this.requestJSON({
+            path: "direct_messages/conversation.json",
+            method: "GET",
+            query: [
+                ["id", id],
+                ["since_id", opts.sinceId],
+                ["max_id", opts.maxId],
+                ["count", opts.count != null ? String(opts.count) : undefined],
+            ],
+        });
+    }
+    inbox(opts = {}) {
+        return this.timeline("direct_messages/inbox.json", opts);
+    }
+    sent(opts = {}) {
+        return this.timeline("direct_messages/sent.json", opts);
+    }
+    sendDirectMessage(opts) {
+        return this.requestJSON({
+            path: "direct_messages/new.json",
+            method: "POST",
+            form: [
+                ["user", opts.user],
+                ["text", opts.text],
+                ["in_reply_to_id", opts.inReplyToId],
+            ],
+        });
+    }
+    deleteDirectMessage(id) {
+        return this.requestJSON({ path: "direct_messages/destroy.json", method: "POST", form: [["id", id]] });
+    }
+}