المكتبات

@zrzur/sdk هي مكتبة زرزور الرسمية للتطبيقات والبوتات: TypeScript وESM وNode 22.3 أو أحدث (أو Deno 2.2 أو أحدث، أو المتصفح). حزمة واحدة بثلاث نقاط دخول:

الاستيراد	ما هو
`@zrzur/sdk/bot`	البوتات: الأوامر والأزرار والقوائم والنماذج والإكمال التلقائي والردود الخاصة والمؤجلة والتضمينات والجامعات والرفع
`@zrzur/sdk`	الأساس: عميل HTTP (كل مسار مكتوب من OpenAPI)، والبوابة، وأنواع الواجهة، والأحداث
`@zrzur/sdk/solid`	العميل الحي لتطبيق زرزور (SolidJS): مخازن للسيرفرات والقنوات والرسائل

لا تحتاج إلى SolidJS إلا مع @zrzur/sdk/solid، ولا ينزله البوت أبدًا.

توجد أيضًا @zrzur/bot، مكتبة أقدم وأصغر بالواجهة نفسها للبوتات، وهي غير منشورة أيضًا. ينبغي للبوتات الجديدة انتظار @zrzur/sdk/bot.

@zrzur/sdk/bot (للبوتات)

import { Client } from "@zrzur/sdk/bot";

// Zrzur's own servers by default; a self-hosted server passes { apiUrl, wsUrl }
const client = new Client();
await client.login(process.env.ZRZUR_TOKEN);

المجال	الدوال
الأوامر	`client.command` و`client.component` و`client.modal` و`client.autocomplete` و`client.syncCommands` و`client.fetchCommands`
الردود	`i.reply` و`i.defer` و`i.update` و`i.deferUpdate` و`i.showModal` و`i.respond` و`i.editReply` و`i.followUp` و`i.deleteReply`
الأحداث	`client.on(type)` و`client.onMessage` و`client.onMemberJoin` و`client.onMemberLeave` و`client.onReaction`
الرسائل	`client.messages.send` و`reply` و`fetch` و`fetchMany` و`edit` و`delete` و`bulkDelete` و`react` و`unreact` و`clearReactions` و`pin` و`unpin`
الأعضاء	`client.members.fetch` و`fetchAll` و`edit` و`addRole` و`removeRole` و`timeout` و`kick` و`ban` و`unban`
الأدوار والقنوات	`client.roles.` و`client.channels.`
المستخدمون	`client.users.fetch` و`openDM` و`sendDM`
الويب هوك	`client.webhooks.create` و`list` و`listForServer` و`fetch` و`fetchWithToken` و`edit` و`regenerateToken` و`delete` و`send` و`sendSlack` و`fetchMessage` و`editMessage` و`deleteMessage`
الجامعات	`message.createMessageComponentCollector` و`message.awaitMessageComponent` و`interaction.awaitModalSubmit`
الرموز التعبيرية	`client.emojis.list` و`fetch` و`find` و`create` و`delete`
الصوت	`client.voice.nodes` و`client.voice.join`
أي شيء آخر	`client.rest.get(path)` و`post` و`put` و`patch` و`delete` (مكتوبة لكل مسار)، و`client.rest.uploadFile(tag, data, name, type)`

تُرمى أخطاء الواجهة بصيغة ApiError مع status وtype وdetail، وretryAfter بعد 429. تُنتظر الحدود القصيرة، وبعد الحد العام ينتظر كل طلب حتى يعود. تفتح البوابة حزم Bulk وتعيد الاتصال بانتظار متزايد.

تذكر كل نقطة نهاية في هذا المرجع دالة المكتبة التي تستدعيها، إن وُجدت.

@zrzur/sdk (الأساس)

import { Api, Gateway, Intents } from "@zrzur/sdk";

const api = new Api({ baseURL: "https://api.zrzur.com", authentication: { bot: process.env.ZRZUR_TOKEN } });
const me = await api.get("/users/@me");

استخدمها لأدوات لا تحتاج إلا إلى واجهة HTTP أو البوابة، في أي إطار عمل.

@zrzur/sdk/solid (للتطبيقات)

العميل الذي بُني عليه تطبيق زرزور: عميل مستخدم بمخازن حية للسيرفرات والقنوات والرسائل. يستطيع الدخول برمز بوت، لكن ليس فيه واجهة تفاعلات (أوامر ومكوّنات ونماذج). استخدمه لأدوات تتصرف كتطبيق، واستخدم @zrzur/sdk/bot للبوتات.

دون مكتبة

كل ميزة هي HTTP وWebSocket عاديان. انظر بلا مكتبة.