Treci la conținut

Găzduirea unui registru

Un registru este un fișier registry.json și un set de dosare cu blocuri, servite prin HTTP. Nu este necesar un server special. Este suficient orice serviciu care poate servi fișiere statice.

De ce aveți nevoie

  1. Un fișier registry.json care listează blocurile
  2. Dosare de blocuri cu fișierele menționate în manifest
  3. Un server web sau un serviciu de găzduire care le servește pe ambele

Structura directoarelor

Un depozit tipic pentru un registru arată astfel:

Cod
my-registry/
  registry.json
  blocks/
    hero/
      block.json
      index.php
      style.scss
    tabs/
      block.json
      index.php
      style.scss
    tab-item/
      block.json
      index.php

registry.json indică directorul blocks/ ca baseUrl:

JSON
{
  "name": "my-registry",
  "baseUrl": "https://example.com/blocks",
  "blocks": [
    {
      "name": "hero",
      "title": "Hero",
      "files": ["block.json", "index.php", "style.scss"]
    }
  ]
}

Cerințe

Găzduirea trebuie să permită accesul direct la fișiere prin URL. CLI preia fișierele construind URL-uri din {baseUrl}/{block.name}/{file}.

CLI nu are propriul flux de autentificare. Pentru registrele private, gestionați controlul accesului la nivelul găzduirii (e.g. depozite private GitHub cu tokenuri sau un server care verifică datele de autentificare) și configurați consumatorii să trimită datele de autentificare ca antete personalizate prin formatul cu obiect din blocks.jsonformat.

Testarea registrului

Înainte de publicare, testați local pornind un server simplu HTTP:

Shell
cd my-registry
npx serve .

Apoi configurați blocks.json la http://localhost:3000/registry.json și rulați npx blockstudio list pentru a verifica dacă totul se rezolvă corect. list preia doar registry.json. Pentru a testa add, setați baseUrl la http://localhost:3000/blocks pe durata testării, deoarece CLI descarcă fișierele blocurilor din baseUrl.