Pular para o conteúdo

Hospedagem de um registro

Um registro é um arquivo registry.json e um conjunto de pastas de blocos servidos por HTTP. Não é necessário um servidor especial. Qualquer serviço capaz de servir arquivos estáticos funciona.

O que você precisa

  1. Um arquivo registry.json que liste seus blocos
  2. Pastas de blocos com os arquivos mencionados no manifesto
  3. Um servidor Web ou serviço de hospedagem que sirva ambos

Estrutura de diretórios

Um repositório de registro típico é assim:

Código
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

O registry.json aponta para o diretório blocks/ como seu baseUrl:

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

Requisitos

A hospedagem precisa permitir acesso direto aos arquivos via URL. O CLI busca arquivos construindo URLs a partir de {baseUrl}/{block.name}/{file}.

O CLI não tem um fluxo de login próprio. Para registros privados, gerencie o controle de acesso na camada de hospedagem (repositórios e.g privados GitHub com tokens ou um servidor que verifique as credenciais) e faça com que os consumidores enviem as credenciais como cabeçalhos personalizados pelo formato de objeto em blocks.json.

Testar seu registro

Antes de publicar, teste localmente iniciando um servidor HTTP simples:

Shell
cd my-registry
npx serve .

Em seguida, aponte seu blocks.json para http://localhost:3000/registry.json e execute npx blockstudio list para verificar se tudo é resolvido corretamente. list só busca registry.json. Para testar add, defina baseUrl como http://localhost:3000/blocks durante o teste, pois o CLI baixa arquivos de bloco de baseUrl.