מהו תוסף
תוסף הוא חבילת npm שמותקנת בפרויקט אחד של Xuda ומרחיבה אותו בקוד שרץ בדפדפן, ב-Studio או בשרת.
תוסף של Xuda הוא חבילת npm עם scope (@xuda.io/<name> לתוספים של Xuda עצמה, כל scope
לצד שלישי) שפרויקט מתקין כדי להוסיף יכולת: רכיב ממשק, ספרייה של קוד שאפשר לקרוא לה
מ-Studio, שקע למסד נתונים, מסגרת ממשק, או ערכת אייקונים. כל תוסף תחת
plugins/@xuda.io/ במאגר הזה הוא כזה, ואותו מבנה עובד גם לתוסף שמתפרסם
מחוץ ל-monorepo.
החלקים הנעים
החבילה בדיסק
תוסף הוא חבילת npm רגילה: package.json ובנוסף כל אחד משישה קבצי המניפסט (ראו
המניפסט) שהוא כולל. plugins/@xuda.io/<name> במאגר הזה הוא
עותק העבודה של התוספים של Xuda עצמה; צד שלישי כותב ומפרסם את אותו מבנה
מהמאגר שלו.
מסמך הקטלוג
העלאת תוסף (upload_plugin) כותבת מסמך אחד למסד הנתונים xuda_plugins, ממופתח לפי שם
החבילה. המסמך הזה הוא גם מקור ההתקנה (ה-manifest, ה-version וה-package_source שלו אומרים מה למשוך ומה
החבילה כוללת בפועל) וגם הרישום בזירת המסחר (label, plugin_description, tags, icon, visibility, stat) של אותו
תוסף בדיוק. אין רשומת רישום נפרדת שצריך לשמור מסונכרנת.
ההתקנה בפרויקט
התקנת תוסף בפרויקט (install_plugin) עושה שלושה דברים: היא מתקינה את
החבילה ב-npm אל node_modules של אותו פרויקט (תחת plugins_drive_path, עץ אחד לכל פרויקט,
לא התקנה גלובלית משותפת), היא רושמת את התוסף במפה app_plugins_purchased של הפרויקט
(הותקן, גרסה, מניפסט, plugin_type), והיא מסמנת שהפרויקט צריך בנייה מחדש
(set_update_required_to_app).
איפה הקוד של תוסף רץ בפועל
תוסף יכול לכלול קוד לשלושה מקומות שונים, והוא רץ רק במקום שבו הקובץ קיים:
- בדפדפן, בתוך כל אפליקציה שפורסמה ושהתוסף מותקן בה, דרך
runtime.mjs. זו ה-fn(plugin_name, element, properties)של תוסף ממשק, שנקראת פעם אחת לכל אלמנט שהתוסף מחובר אליו. - בשרת, בתוך הפרויקט, דרך
server.mjs. כאן ה-methodsשל תוסף ספרייה ממומשות בפועל, וכאן תוסף נתונים (dbs) מדבר עם מאגר הגיבוי שלו. - בתוך Studio עצמו בזמן שהפרויקט נבנה, דרך
studio.mjs. תוסףdbsמשתמש בזה כדי להריץ שאילתות חיות משלו מול תצוגת הטבלה ב-Studio.
מסך ההסכמה להתקנה שמשתמש רואה לפני התקנת תוסף נבנה ישירות לפי אילו מהקבצים האלה המניפסט של התוסף אומר שהוא כולל, ולכן המניפסט הוא החוזה של התוסף מול מי שמתקין אותו, ולא רק תוצר של בנייה.