مرجع حزمة التطبيقات
كل رمز عام في @dukkan.one/app-sdk، صفحة لكل نقطة دخول، مولَّد من أنواع الحزمة نفسها.
في هذه الصفحة
يسرد هذا المرجع كل دالة وصنف وواجهة ونوع وثابت مصدَّر من @dukkan.one/app-sdk، مجمّعةً حسب نقطة الدخول. يُولَّد من تصريحات TypeScript وTSDoc في الحزمة عبر المترجم، فالتوقيع هنا هو التوقيع الذي تشحنه الحزمة. تعيش الأدلة تحت حزمة التطبيقات؛ وسطح وحدة Nuxt في وحدة Nuxt.
التثبيت#
npm install @dukkan.one/app-sdkNode.js 18.17 أو أحدث، وCloudflare Workers، وBun، وDeno. بصيغتي ESM وCommonJS، مع الأنواع.
نقاط الدخول#
| الاستيراد من | المحتوى |
|---|---|
@dukkan.one/app-sdk |
العميل، ومدير الرموز، والأخطاء، ومساعدات إعادة المحاولة والتصفّح، مع إعادة تصدير كل الرموز أدناه. |
@dukkan.one/app-sdk/oauth |
PKCE، ورابط الموافقة، وتبديل الكود، ومنحة التحديث. |
@dukkan.one/app-sdk/webhooks |
التحقق من التوقيع، ومخطط الغلاف، والأحداث المنمّطة، والمستقبِل. |
@dukkan.one/app-sdk/tokens |
عقد TokenStore، والمحوّلان في الذاكرة والمفتاحي، وختّام AES-GCM. |
@dukkan.one/app-sdk/tokens/postgres |
محوّل Postgres لعملاء postgres.js. |
@dukkan.one/app-sdk/idempotency |
مساعدات Idempotency-Key، وJSON القانوني، وعقد الصندوق الوارد. |
@dukkan.one/app-sdk/commerce |
المبالغ، وانتقالات الطلب، ومطابقة المجاميع، والأسطر غير المجهّزة، والاستردادات، والمزامنة بـ updated_at. |
@dukkan.one/app-sdk/config |
مخطط dukkan.app.toml وسطح الإصدار. |
@dukkan.one/app-sdk/testing |
أغلفة عيّنة، وتوقيع التسليمات، وبدائل fetch لاختباراتك. |
@dukkan.one/app-sdk/contract |
ثوابت وقت التشغيل المولَّدة من مستند OpenAPI. |
الإصدارات#
تتبع الحزمة الإصدارات الدلالية. داخل الإصدار الرئيسي لا يزيد السطح إلا نمواً، انعكاساً لسياسة v1 الإضافية في المنصّة (مرجع الواجهة). مراجعة المنصّة المؤرّخة التي وُلّد البناء منها هي PLATFORM_API_VERSION في نقطة الدخول contract؛ ويجيب الخادم الأحدث بتاريخه في X-Dukkan-Api-Version ويبلّغ العميل الانحراف عبر onApiVersionDrift من دون فشل.
حتى 1.0.0 تُنشر الحزم تحت وسم التوزيع next: npm install @dukkan.one/app-sdk@next.