birdclaw 0.1.0 → 0.2.0

package/src/lib/bird.ts

@@ -8,18 +8,19 @@ import type {
 } from "./types";
 
 const execFileAsync = promisify(execFile);
+const BIRD_JSON_MAX_BUFFER_BYTES = 512 * 1024 * 1024;
 
-interface BirdMentionMedia {
+interface BirdTweetMedia {
 	type?: string;
 	url?: string;
 }
 
-interface BirdMentionAuthor {
+interface BirdTweetAuthor {
 	username?: string;
 	name?: string;
 }
 
-interface BirdMentionItem {
+interface BirdTweetItem {
 	id: string;
 	text: string;
 	createdAt: string;
@@ -28,9 +29,9 @@ interface BirdMentionItem {
 	likeCount?: number;
 	conversationId?: string;
 	inReplyToStatusId?: string;
-	author?: BirdMentionAuthor;
+	author?: BirdTweetAuthor;
 	authorId?: string;
-	media?: BirdMentionMedia[];
+	media?: BirdTweetMedia[];
 }
 
 export interface BirdDmUser {
@@ -73,7 +74,89 @@ function toIsoTimestamp(value: string) {
 	return parsed.toISOString();
 }
 
-function toMediaEntities(media: BirdMentionMedia[] | undefined) {
+function escapeJsonStringControlChars(value: string) {
+	let output = "";
+	let inString = false;
+	let escaped = false;
+
+	for (const character of value) {
+		if (!inString) {
+			output += character;
+			if (character === '"') {
+				inString = true;
+			}
+			continue;
+		}
+
+		if (escaped) {
+			output += character;
+			escaped = false;
+			continue;
+		}
+
+		if (character === "\\") {
+			output += character;
+			escaped = true;
+			continue;
+		}
+
+		if (character === '"') {
+			output += character;
+			inString = false;
+			continue;
+		}
+
+		if (character === "\n") {
+			output += "\\n";
+			continue;
+		}
+		if (character === "\r") {
+			output += "\\r";
+			continue;
+		}
+		if (character === "\t") {
+			output += "\\t";
+			continue;
+		}
+		if (character.charCodeAt(0) < 0x20) {
+			output += `\\u${character.charCodeAt(0).toString(16).padStart(4, "0")}`;
+			continue;
+		}
+
+		output += character;
+	}
+
+	return output;
+}
+
+function parseBirdJson(stdout: string) {
+	try {
+		return JSON.parse(stdout) as unknown;
+	} catch (error) {
+		if (!(error instanceof SyntaxError)) {
+			throw error;
+		}
+		return JSON.parse(escapeJsonStringControlChars(stdout)) as unknown;
+	}
+}
+
+function getBirdTweetItems(payload: unknown, command: string) {
+	if (Array.isArray(payload)) {
+		return payload as BirdTweetItem[];
+	}
+
+	if (
+		payload &&
+		typeof payload === "object" &&
+		Array.isArray((payload as { tweets?: unknown }).tweets)
+	) {
+		return (payload as { tweets: BirdTweetItem[] }).tweets;
+	}
+
+	throw new Error(`bird ${command} returned unexpected JSON`);
+}
+
+function toMediaEntities(media: BirdTweetMedia[] | undefined) {
 	if (!Array.isArray(media) || media.length === 0) {
 		return undefined;
 	}
@@ -92,7 +175,7 @@ function toMediaEntities(media: BirdMentionMedia[] | undefined) {
 	};
 }
 
-function normalizeBirdMentions(items: BirdMentionItem[]): XurlMentionsResponse {
+function normalizeBirdTweets(items: BirdTweetItem[]): XurlMentionsResponse {
 	const users = new Map<string, XurlMentionUser>();
 	const data = items.map((item): XurlMentionData => {
 		const authorId = String(
@@ -142,18 +225,75 @@ export async function listMentionsViaBird({
 	maxResults: number;
 }): Promise<XurlMentionsResponse> {
 	const birdCommand = getBirdCommand();
-	const { stdout } = await execFileAsync(birdCommand, [
-		"mentions",
-		"-n",
-		String(maxResults),
-		"--json",
-	]);
-	const payload = JSON.parse(stdout) as unknown;
-	if (!Array.isArray(payload)) {
-		throw new Error("bird mentions returned unexpected JSON");
+	const { stdout } = await execFileAsync(
+		birdCommand,
+		["mentions", "-n", String(maxResults), "--json"],
+		{ maxBuffer: BIRD_JSON_MAX_BUFFER_BYTES },
+	);
+	const payload = parseBirdJson(stdout);
+
+	return normalizeBirdTweets(getBirdTweetItems(payload, "mentions"));
+}
+
+async function listTweetsViaBirdCommand({
+	command,
+	maxResults,
+	all,
+	maxPages,
+}: {
+	command: "likes" | "bookmarks";
+	maxResults: number;
+	all?: boolean;
+	maxPages?: number;
+}): Promise<XurlMentionsResponse> {
+	const birdCommand = getBirdCommand();
+	const args = [command, "-n", String(maxResults), "--json"];
+	if (all) {
+		args.push("--all");
 	}
+	if (maxPages !== undefined) {
+		args.push("--max-pages", String(maxPages));
+	}
+	const { stdout } = await execFileAsync(birdCommand, args, {
+		maxBuffer: BIRD_JSON_MAX_BUFFER_BYTES,
+	});
+	const payload = parseBirdJson(stdout);
 
-	return normalizeBirdMentions(payload as BirdMentionItem[]);
+	return normalizeBirdTweets(getBirdTweetItems(payload, command));
+}
+
+export async function listLikedTweetsViaBird({
+	maxResults,
+	all,
+	maxPages,
+}: {
+	maxResults: number;
+	all?: boolean;
+	maxPages?: number;
+}): Promise<XurlMentionsResponse> {
+	return listTweetsViaBirdCommand({
+		command: "likes",
+		maxResults,
+		all,
+		maxPages,
+	});
+}
+
+export async function listBookmarkedTweetsViaBird({
+	maxResults,
+	all,
+	maxPages,
+}: {
+	maxResults: number;
+	all?: boolean;
+	maxPages?: number;
+}): Promise<XurlMentionsResponse> {
+	return listTweetsViaBirdCommand({
+		command: "bookmarks",
+		maxResults,
+		all,
+		maxPages,
+	});
 }
 
 export async function listDirectMessagesViaBird({
@@ -162,13 +302,12 @@ export async function listDirectMessagesViaBird({
 	maxResults: number;
 }): Promise<BirdDmsResponse> {
 	const birdCommand = getBirdCommand();
-	const { stdout } = await execFileAsync(birdCommand, [
-		"dms",
-		"-n",
-		String(maxResults),
-		"--json",
-	]);
-	const payload = JSON.parse(stdout) as unknown;
+	const { stdout } = await execFileAsync(
+		birdCommand,
+		["dms", "-n", String(maxResults), "--json"],
+		{ maxBuffer: BIRD_JSON_MAX_BUFFER_BYTES },
+	);
+	const payload = parseBirdJson(stdout);
 	if (
 		!payload ||
 		typeof payload !== "object" ||

package/src/lib/blocks-write.ts

@@ -20,7 +20,7 @@ export async function addBlock(
 	const transport = await runModerationAction({
 		action: "block",
 		query: actionQuery,
-		targetUserId: resolved.externalUserId,
+		targetUserId: resolved.externalUserId ?? undefined,
 		transport: options.transport,
 	});
 
@@ -92,7 +92,7 @@ export async function removeBlock(
 	const transport = await runModerationAction({
 		action: "unblock",
 		query: actionQuery,
-		targetUserId: resolved.externalUserId,
+		targetUserId: resolved.externalUserId ?? undefined,
 		transport: options.transport,
 	});
 

package/src/lib/blocks.ts

@@ -5,12 +5,7 @@ import {
 	getDefaultAccountId,
 	toProfile,
 } from "./moderation-target";
-import type {
-	BlockItem,
-	BlockListResponse,
-	BlockSearchItem,
-	XurlMentionUser,
-} from "./types";
+import type { BlockItem, BlockListResponse, BlockSearchItem } from "./types";
 import { upsertProfileFromXUser } from "./x-profile";
 import { listBlockedUsers, lookupAuthenticatedUser } from "./xurl";
 
@@ -272,7 +267,7 @@ export async function syncBlocks(accountId: string) {
 			const page = await listBlockedUsers(sourceUserId, nextToken ?? undefined);
 			const mergeRemotePage = db.transaction(() => {
 				for (const user of page.items) {
-					const resolved = upsertProfileFromXUser(db, user as XurlMentionUser);
+					const resolved = upsertProfileFromXUser(db, user);
 					remoteProfileIds.push(resolved.profile.id);
 					upsertRemoteBlock(
 						db,