דילוג לתוכן
אומת

מניפסט התוסף

שישה קבצים שתוסף יכול לכלול, כל אחד נקודת כניסה אחרת, והמניפסט שרושם אילו מהם קיימים.

המניפסט של תוסף אינו קובץ שכותבים. הפלטפורמה מחשבת אותו ברגע שתוסף מועלה: validate_plugin() מחפשת בדיסק שישה שמות קבצים בדיוק, רושמת אילו מהם קיימים (והאם כל אחד נמצא בשורש החבילה או תחת dist/), ושומרת את התוצאה כ- doc.manifest במסמך הקטלוג של התוסף. כל מה שבא אחר כך, המטעין של סביבת ההרצה, מסך ההסכמה להתקנה, כפתור ההגדרה בדשבורד, קורא את המניפסט הזה ולא בודק את החבילה בעצמו.

ששת הקבצים

תוסף כולל כל אחד מאלה שהסוג שלו צריך. ל-plugins/@xuda.io/xuda-ui-plugin-moment/src יש רק index.mjs ו-runtime.mjs; ל-plugins/@xuda.io/xuda-library-plugin-xlsx יש index.mjs ו- server.mjs; ל-plugins/@xuda.io/xuda-dbs-plugin-couchdb יש index.mjs ו-server.mjs.

שורש או dist/

validate_plugin() מחפשת כל קובץ קודם בשורש החבילה, ואז ב-dist/<file>. כל אחד מהמיקומים מספק את המניפסט, ולכן תוסף שנבנה עם Vite (רובם תחת plugins/@xuda.io/) כולל מקור תחת src/ ומאפשר לבנייה שלו לכתוב את קבצי המניפסט אל dist/.

CSS נטען רק מתוך dist

runtime.css (וכל CSS אחר של המניפסט) נקלט רק כשה-.mjs התואם לו נמצא תחת dist/, אף פעם לא משורש החבילה. סביבת ההרצה בודקת manifest[resource].dist && manifest[resource].css לפני שתמשוך את גיליון הסגנונות, ולכן תוסף עם runtime.mjs בשורש ו-style.css בשורש עובר אימות (exist: true בשניהם) אבל סביבת ההרצה אף פעם לא טוענת את ה-CSS. יש לפרסם דרך dist/ אם התוסף צריך שגיליון הסגנונות שלו באמת ייטען.

למה משמש המניפסט

  • טעינת תוסף ממשק. סביבת ההרצה מסרבת להריץ תוסף ממשק בכלל אלא אם המניפסט מראה גם runtime.mjs וגם index.mjs; אז היא מייבאת את index.mjs בשביל properties, פותרת את הערך של כל מאפיין (כולל קישורי ביטוי xu-exp:) מול המאפיינים של האלמנט, מייבאת את runtime.mjs, וקוראת ל-fn.
  • מסך ההסכמה להתקנה. נוכחות במניפסט הופכת ישירות למשפטים ש משתמש קורא לפני ההתקנה: הכללה של server.mjs אומרת "מריץ קוד משלו על שרתי Xuda, בתוך הפרויקט שלך"; הכללה של runtime.mjs אומרת "מריץ קוד משלו בתוך האפליקציה המפורסמת שלך, בדפדפן של כל מי שמשתמש בה"; גם ל-studio.mjs ול-setup.mjs יש שורות משלהם.
  • כפתור ההגדרה בדשבורד. מסך ההגדרה של תוסף מוצג רק כש- manifest['index.mjs'].exist הוא אמת והמודול הזה אינו ריק, או שלתוסף יש תלות עם הגדרה משלה.