Μετάβαση στο περιεχόμενο
Επαληθεύτηκε

Τι είναι ένα πρόσθετο

Ένα πρόσθετο είναι ένα πακέτο npm που εγκαθίσταται σε ένα έργο Xuda και το επεκτείνει με κώδικα που εκτελείται στον browser, στο Studio ή στον διακομιστή.

Ένα πρόσθετο Xuda είναι ένα πακέτο npm με scope (@xuda.io/<name> για πρόσθετα πρώτου μέρους, οποιοδήποτε scope για τρίτους) που ένα έργο εγκαθιστά για να προσθέσει δυνατότητα: ένα στοιχείο UI, μια βιβλιοθήκη κώδικα που καλείται από το Studio, ένα socket βάσης δεδομένων, ένα framework UI ή ένα σετ εικονιδίων. Κάθε πρόσθετο κάτω από το plugins/@xuda.io/ σε αυτό το repo είναι ένα τέτοιο, και η ίδια μορφή λειτουργεί για ένα πρόσθετο που δημοσιεύεται από έξω από το monorepo.

Τα κινούμενα μέρη

Το πακέτο στον δίσκο

Ένα πρόσθετο είναι ένα κανονικό πακέτο npm: το package.json συν όποια από τα έξι αρχεία manifest (δείτε το manifest) περιλαμβάνει. Το plugins/@xuda.io/<name> σε αυτό το repo είναι το αντίγραφο εργασίας για τα πρόσθετα πρώτου μέρους: ένας τρίτος γράφει και δημοσιεύει την ίδια μορφή από το δικό του repo.

Το έγγραφο καταλόγου

Η μεταφόρτωση ενός πρόσθετου (upload_plugin) γράφει ένα έγγραφο στη βάση xuda_plugins, με κλειδί το όνομα του πακέτου. Αυτό το έγγραφο είναι και η πηγή εγκατάστασης (τα manifest, version και package_source λένε τι να ληφθεί και τι περιλαμβάνει πραγματικά το πακέτο) και η καταχώριση στο marketplace (label, plugin_description, tags, icon, visibility, stat) για το ίδιο ακριβώς πρόσθετο. Δεν υπάρχει ξεχωριστή εγγραφή καταχώρισης που πρέπει να διατηρείτε συγχρονισμένη.

Η εγκατάσταση στο έργο

Η εγκατάσταση ενός πρόσθετου σε ένα έργο (install_plugin) κάνει τρία πράγματα: εγκαθιστά το πακέτο με npm στο δικό του node_modules του έργου (κάτω από το plugins_drive_path, ένα δέντρο ανά έργο, όχι κοινή καθολική εγκατάσταση), καταγράφει το πρόσθετο στον χάρτη app_plugins_purchased του έργου (installed, version, manifest, plugin_type), και σημαίνει το έργο ως χρήζον νέου build (set_update_required_to_app).

Πού εκτελείται πραγματικά ο κώδικας ενός πρόσθετου

Ένα πρόσθετο μπορεί να περιλαμβάνει κώδικα για έως τρία διαφορετικά μέρη, και εκτελείται μόνο εκεί όπου υπάρχει το αρχείο:

  • Στον browser, μέσα σε κάθε δημοσιευμένη εφαρμογή που έχει εγκατεστημένο το πρόσθετο, μέσω του runtime.mjs. Αυτό είναι το fn(plugin_name, element, properties) ενός πρόσθετου UI, που καλείται μία φορά για κάθε στοιχείο στο οποίο είναι συνδεδεμένο το πρόσθετο.
  • Στον διακομιστή, μέσα στο έργο, μέσω του server.mjs. Εδώ υλοποιούνται πραγματικά τα methods ενός πρόσθετου βιβλιοθήκης, και εδώ ένα πρόσθετο δεδομένων (dbs) μιλά με την αποθήκη του.
  • Μέσα στο ίδιο το Studio όσο χτίζεται το έργο, μέσω του studio.mjs. Ένα πρόσθετο dbs το χρησιμοποιεί για να εκτελεί τα δικά του ζωντανά ερωτήματα στην προβολή πίνακα του Studio.

Η οθόνη συναίνεσης εγκατάστασης που βλέπει ένας χρήστης πριν εγκαταστήσει ένα πρόσθετο χτίζεται απευθείας από το ποια από αυτά τα αρχεία λέει το manifest του πρόσθετου ότι περιλαμβάνει, γι' αυτό το manifest είναι η σύμβαση του πρόσθετου με το άτομο που το εγκαθιστά και όχι απλώς ένα τεχνούργημα build.

Επόμενο