Siirry sisältöön
Tarkistettu

Mikä lisäosa on

Lisäosa on npm-paketti, joka asennetaan yhteen Xuda-projektiin ja laajentaa sitä koodilla, joka toimii selaimessa, Studiossa tai palvelimella.

Xuda-lisäosa on rajattu npm-paketti (@xuda.io/<name> ensimmäisen osapuolen lisäosille, mikä tahansa laajuus kolmannelle osapuolelle), jonka projekti asentaa lisätäkseen ominaisuuden: käyttöliittymäkomponentin, Studiosta kutsuttavan koodikirjaston, tietokantaliittimen, käyttöliittymäkehyksen tai kuvakesarjan. Jokainen tämän repon plugins/@xuda.io/-kansion lisäosa on sellainen, ja sama muoto toimii monorepon ulkopuolelta julkaistulle lisäosalle.

Liikkuvat osat

Paketti levyllä

Lisäosa on tavallinen npm-paketti: package.json sekä ne kuudesta manifestitiedostosta (katso manifesti), jotka se toimittaa. plugins/@xuda.io/<name> tässä repossa on ensimmäisen osapuolen lisäosien työkopio; kolmas osapuoli kirjoittaa ja julkaisee saman muodon omasta repostaan.

Katalogidokumentti

Lisäosan lataaminen (upload_plugin) kirjoittaa yhden dokumentin xuda_plugins-tietokantaan, avaimena paketin nimi. Tuo dokumentti on sekä asennuslähde (sen manifest, version ja package_source kertovat, mitä noudetaan ja mitä paketti oikeasti toimittaa) että markkinapaikan listaus (label, plugin_description, tags, icon, visibility, stat) täsmälleen samalle lisäosalle. Erillistä listaustietuetta, jota pitäisi pitää synkronoituna, ei ole.

Projektin asennus

Lisäosan asentaminen projektiin (install_plugin) tekee kolme asiaa: se npm-asentaa paketin projektin omaan node_modules-kansioon (plugins_drive_path:n alle, yksi puu projektia kohti, ei jaettua globaalia asennusta), kirjaa lisäosan projektin app_plugins_purchased-karttaan (asennettu, versio, manifesti, plugin_type) ja merkitsee projektin tarvitsevan uudelleenrakennuksen (set_update_required_to_app).

Missä lisäosan koodi oikeasti toimii

Lisäosa voi toimittaa koodia enintään kolmeen eri paikkaan, ja se toimii vain siellä, missä tiedosto on:

  • Selaimessa, jokaisessa julkaistussa sovelluksessa, johon lisäosa on asennettu, tiedoston runtime.mjs kautta. Tämä on UI-lisäosan fn(plugin_name, element, properties), jota kutsutaan kerran jokaiselle elementille, johon lisäosa on liitetty.
  • Palvelimella, projektin sisällä, tiedoston server.mjs kautta. Täällä kirjastolisäosan methods oikeasti toteutetaan, ja täällä data-lisäosa (dbs) puhuu taustalla olevan tallennuksensa kanssa.
  • Studion sisällä projektia rakennettaessa, tiedoston studio.mjs kautta. dbs-lisäosa käyttää tätä ajaakseen omia live-kyselyjään Studion taulukkonäkymää vasten.

Asennuksen suostumusnäkymä, jonka käyttäjä näkee ennen lisäosan asentamista, rakennetaan suoraan siitä, mitkä näistä tiedostoista lisäosan manifesti sanoo sen toimittavan. Siksi manifesti on lisäosan sopimus sen asentavan henkilön kanssa, ei vain rakennuksen sivutuote.

Seuraavaksi