vitral 0.11.4 → 0.11.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +133 -91
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -86,67 +86,94 @@ Os 10 frameworks têm testes de ponta a ponta no CI, com host e remote de framew
86
86
 
87
87
  ## Começo rápido
88
88
 
89
- Exemplo: uma loja em React que mostra o carrinho, feito por outra equipe.
89
+ Exemplo: uma loja em React mostra o carrinho, feito por outra equipe. Os dois lados abaixo têm os mesmos arquivos, na mesma ordem.
90
90
 
91
91
  ### Hoje, com Module Federation
92
92
 
93
- Loja e carrinho combinam a configuração no build dos dois: o que cada um expõe, o que pega do outro e quais versões dividem.
93
+ ```jsx
94
+ // carrinho/src/Carrinho.jsx
95
+ export default function Carrinho({ userId }) {
96
+ return <p>Carrinho do usuário {userId}</p>
97
+ }
98
+ ```
94
99
 
95
100
  ```js
96
101
  // carrinho/webpack.config.js
97
- new ModuleFederationPlugin({
98
- name: 'carrinho',
99
- filename: 'remoteEntry.js',
100
- exposes: { './Carrinho': './src/Carrinho' },
101
- shared: { react: { singleton: true }, 'react-dom': { singleton: true } },
102
- })
102
+ const { ModuleFederationPlugin } = require('webpack').container
103
+
104
+ module.exports = {
105
+ plugins: [
106
+ new ModuleFederationPlugin({
107
+ name: 'carrinho',
108
+ filename: 'remoteEntry.js',
109
+ exposes: { './Carrinho': './src/Carrinho.jsx' },
110
+ shared: { react: { singleton: true }, 'react-dom': { singleton: true } },
111
+ }),
112
+ ],
113
+ }
103
114
  ```
104
115
 
105
116
  ```js
106
117
  // loja/webpack.config.js
107
- new ModuleFederationPlugin({
108
- name: 'loja',
109
- remotes: { carrinho: 'carrinho@https://cdn.empresa.com/carrinho/remoteEntry.js' },
110
- shared: { react: { singleton: true }, 'react-dom': { singleton: true } },
111
- })
118
+ const { ModuleFederationPlugin } = require('webpack').container
119
+
120
+ module.exports = {
121
+ plugins: [
122
+ new ModuleFederationPlugin({
123
+ name: 'loja',
124
+ remotes: { carrinho: 'carrinho@https://cdn.empresa.com/carrinho/remoteEntry.js' },
125
+ shared: { react: { singleton: true }, 'react-dom': { singleton: true } },
126
+ }),
127
+ ],
128
+ }
112
129
  ```
113
130
 
114
131
  ```jsx
115
132
  // loja/src/App.jsx
116
- const Carrinho = React.lazy(() => import('carrinho/Carrinho'))
133
+ import { lazy, Suspense } from 'react'
134
+
135
+ const Carrinho = lazy(() => import('carrinho/Carrinho'))
117
136
 
118
137
  export function App() {
119
138
  return (
120
- <ErrorBoundary fallback={<p>Erro</p>}>
121
- <Suspense fallback={<p>Carregando…</p>}>
122
- <Carrinho userId={42} />
123
- </Suspense>
124
- </ErrorBoundary>
139
+ <Suspense fallback={<p>Carregando…</p>}>
140
+ <Carrinho userId={42} />
141
+ </Suspense>
125
142
  )
126
143
  }
127
144
  ```
128
145
 
129
146
  ### O mesmo app com vitral
130
147
 
131
- Só o carrinho tem plugin. O build da loja não muda.
132
-
133
148
  ```jsx
134
- // carrinho/src/App.jsx (o mesmo componente)
135
- export default function Carrinho({ userId }) { … }
149
+ // carrinho/src/Carrinho.jsx (igual)
150
+ export default function Carrinho({ userId }) {
151
+ return <p>Carrinho do usuário {userId}</p>
152
+ }
136
153
  ```
137
154
 
138
155
  ```js
139
- // carrinho/vite.config.js (no lugar do ModuleFederationPlugin)
156
+ // carrinho/vite.config.js (no lugar do webpack.config.js)
140
157
  import react from '@vitejs/plugin-react'
141
158
  import vitral from 'vitral/vite'
142
159
 
143
- export default { plugins: [react(), vitral()] }
160
+ export default {
161
+ plugins: [
162
+ react(),
163
+ vitral({ name: 'carrinho', entry: 'src/Carrinho.jsx', dedupe: ['react'] }),
164
+ ],
165
+ }
144
166
  ```
145
167
 
146
- `vite build` gera o JS, o CSS e um `vitral.json`. Publique a pasta `dist` em qualquer CDN.
168
+ ```js
169
+ // loja/webpack.config.js (sem o ModuleFederationPlugin)
170
+ module.exports = {
171
+ plugins: [],
172
+ }
173
+ ```
147
174
 
148
175
  ```jsx
149
- // loja/src/App.jsx (sem plugin no build da loja)
176
+ // loja/src/App.jsx
150
177
  import { configure } from 'vitral'
151
178
  import { Remote } from 'vitral/react'
152
179
 
@@ -157,22 +184,21 @@ export function App() {
157
184
  }
158
185
  ```
159
186
 
160
- Pronto. Mudar `props` atualiza o remote sem remontar. Para gerar loja e carrinho prontos: `npm create vitral@latest`.
187
+ `vite build` no carrinho gera o JS, o CSS e o `vitral.json`. Publique a pasta `dist` em qualquer CDN. Para gerar loja e carrinho prontos: `npm create vitral@latest`.
161
188
 
162
189
  ### O que muda
163
190
 
164
191
  | | Module Federation | vitral |
165
192
  |---|---|---|
166
- | Build da loja | Plugin com `remotes` e `shared` | Não muda |
167
- | Versão do React | Combinada entre as equipes (`singleton`) | Cada um usa a sua. Uma cópia só com [`dedupe`](https://joaogabriel15.github.io/vitral/aprender/dedupe) |
168
- | Carregando e erro | `Suspense` e `ErrorBoundary` | `fallback` e `error` do `<Remote>` |
193
+ | Build da loja | Plugin com `remotes` e `shared` | Sem plugin |
194
+ | Versão do React | Combinada entre as equipes (`singleton`) | O carrinho usa o React da loja quando a versão serve (`dedupe`), senão o próprio |
169
195
  | Framework | O mesmo nos dois lados | Qualquer um. A loja em React pode mostrar um carrinho em Vue |
170
196
 
171
197
  Numa página HTML qualquer, sem build:
172
198
 
173
199
  ```html
174
200
  <script type="module" src="https://cdn.jsdelivr.net/npm/vitral/dist/auto.js"></script>
175
- <vitral-remote src="https://cdn.empresa.com/carrinho/vitral.json"></vitral-remote>
201
+ <vitral-remote src="https://cdn.empresa.com/carrinho/vitral.json" props='{"userId": 42}'></vitral-remote>
176
202
  ```
177
203
 
178
204
  Guia completo: [Migrar do Module Federation](https://joaogabriel15.github.io/vitral/migracao/module-federation).
@@ -196,7 +222,7 @@ Host e remote não precisam ser do mesmo framework. Cada um tem uma página com
196
222
 
197
223
  ## Next.js como host
198
224
 
199
- Exemplo: uma loja em Next.js com a área "Minha conta", feita por outra equipe.
225
+ Exemplo: uma loja em Next.js com a área "Minha conta", feita por outra equipe. Os dois lados abaixo têm os mesmos arquivos, na mesma ordem. Com vitral, a loja ganha um arquivo novo no fim.
200
226
 
201
227
  <p align="center">
202
228
  <picture>
@@ -207,13 +233,18 @@ Exemplo: uma loja em Next.js com a área "Minha conta", feita por outra equipe.
207
233
 
208
234
  ### Hoje, com Multi-Zones
209
235
 
210
- São dois apps Next. A loja repassa as URLs de `/conta` para o app da conta.
211
-
212
236
  ```
213
237
  loja/ app Next principal
214
238
  conta/ segundo app Next (a zona)
215
239
  ```
216
240
 
241
+ ```tsx
242
+ // conta/pages/index.tsx
243
+ export default function Conta() {
244
+ return <h1>Minha conta</h1>
245
+ }
246
+ ```
247
+
217
248
  ```js
218
249
  // conta/next.config.js
219
250
  module.exports = {
@@ -222,13 +253,6 @@ module.exports = {
222
253
  }
223
254
  ```
224
255
 
225
- ```tsx
226
- // conta/pages/index.tsx
227
- export default function Conta() {
228
- return <h1>Minha conta</h1>
229
- }
230
- ```
231
-
232
256
  ```js
233
257
  // loja/next.config.js
234
258
  module.exports = {
@@ -242,6 +266,13 @@ module.exports = {
242
266
  }
243
267
  ```
244
268
 
269
+ ```tsx
270
+ // loja/pages/_app.tsx
271
+ export default function App({ Component, pageProps }) {
272
+ return <Component {...pageProps} />
273
+ }
274
+ ```
275
+
245
276
  ```tsx
246
277
  // loja/components/Menu.tsx
247
278
  // <a>, não <Link>: a página recarrega e baixa Next e React de novo.
@@ -250,30 +281,33 @@ module.exports = {
250
281
 
251
282
  ### O mesmo app com vitral
252
283
 
253
- A loja continua sendo o único app Next. A conta vira um remote: um projeto Vite com o mesmo componente.
254
-
255
284
  ```
256
285
  loja/ app Next (o host)
257
- conta/ projeto Vite (o remote)
286
+ conta/ o mesmo código, buildado com Vite (o remote)
287
+ ```
288
+
289
+ ```tsx
290
+ // conta/pages/index.tsx (igual)
291
+ export default function Conta() {
292
+ return <h1>Minha conta</h1>
293
+ }
258
294
  ```
259
295
 
260
296
  ```js
261
- // conta/vite.config.js (no lugar do next.config.js da zona)
297
+ // conta/vite.config.js (no lugar do next.config.js)
262
298
  import react from '@vitejs/plugin-react'
263
299
  import vitral from 'vitral/vite'
264
300
 
265
- export default { plugins: [react(), vitral({ name: 'conta', dedupe: ['react'] })] }
266
- ```
267
-
268
- ```tsx
269
- // conta/src/App.tsx (o mesmo componente da página)
270
- export default function Conta() {
271
- return <h1>Minha conta</h1>
301
+ export default {
302
+ plugins: [
303
+ react(),
304
+ vitral({ name: 'conta', entry: 'pages/index.tsx', next: { basePath: '/conta' }, dedupe: ['react'] }),
305
+ ],
272
306
  }
273
307
  ```
274
308
 
275
309
  ```js
276
- // loja/next.config.js (no lugar das rewrites)
310
+ // loja/next.config.js (withVitral no lugar das rewrites)
277
311
  const { withVitral } = require('vitral/next-config')
278
312
 
279
313
  module.exports = withVitral({}, {
@@ -284,7 +318,7 @@ module.exports = withVitral({}, {
284
318
  ```
285
319
 
286
320
  ```tsx
287
- // loja/pages/_app.tsx (só acrescenta <VitralNext />)
321
+ // loja/pages/_app.tsx (mais o <VitralNext />)
288
322
  import { VitralNext } from 'vitral/next-host'
289
323
 
290
324
  export default function App({ Component, pageProps }) {
@@ -293,49 +327,52 @@ export default function App({ Component, pageProps }) {
293
327
  ```
294
328
 
295
329
  ```tsx
296
- // loja/pages/conta/[[...slug]].tsx (arquivo novo: a página que mostra a conta)
330
+ // loja/components/Menu.tsx
331
+ // <Link>: a troca é sem recarregar, e o React não baixa de novo.
332
+ <Link href="/conta">Minha conta</Link>
333
+ ```
334
+
335
+ ```tsx
336
+ // loja/pages/conta/[[...slug]].tsx (arquivo novo: a página da loja que mostra a conta)
297
337
  import { NextRemote } from 'vitral/next-host'
298
338
 
299
339
  export default function Conta() {
300
- return <Layout><NextRemote name="conta" fallback={<p>Carregando…</p>} /></Layout>
340
+ return <NextRemote name="conta" fallback={<p>Carregando…</p>} />
301
341
  }
302
342
  ```
303
343
 
304
- ```tsx
305
- // loja/components/Menu.tsx
306
- // <Link> normal: a troca é sem recarregar, e o React não baixa de novo.
307
- <Link href="/conta">Minha conta</Link>
308
- ```
309
-
310
- Se o código da conta já usa `next/link` ou `useRouter`, não precisa reescrever: `vitral({ name: 'conta', next: { basePath: '/conta' } })` builda esse código com o Vite.
344
+ Com `next: { basePath }`, o código da conta pode continuar usando `next/link` e `useRouter`.
311
345
 
312
346
  ### O que muda
313
347
 
314
348
  | | Multi-Zones | vitral |
315
349
  |---|---|---|
316
350
  | Apps Next | Um por área | Só a loja |
317
- | Configuração | `basePath` e `assetPrefix` na zona, `rewrites` na loja | `withVitral` na loja, plugin na conta |
351
+ | Configuração | `basePath` e `assetPrefix` na zona, `rewrites` na loja | Plugin na conta, `withVitral` na loja |
318
352
  | Trocar de área | Recarrega a página (0,8 s no benchmark) | Sem recarregar (0,2 s) |
319
353
  | React e Next | Baixados de novo em cada área | Uma cópia para a página toda |
320
354
  | Layout da loja | Cada zona repete o seu | A conta fica dentro do layout da loja |
321
355
 
322
- Guia completo, com SSR por rota e prefetch: [Migrar do Next.js Multi-Zones](https://joaogabriel15.github.io/vitral/migracao/multi-zones).
323
-
324
- No App Router, o host usa `<Remote>` de `vitral/react` num componente `'use client'`. Exemplo em [Next.js](https://joaogabriel15.github.io/vitral/frameworks/next#host-com-app-router).
356
+ Guia completo, com SSR por rota e prefetch: [Migrar do Next.js Multi-Zones](https://joaogabriel15.github.io/vitral/migracao/multi-zones). No App Router, o host usa `<Remote>` de `vitral/react` num componente `'use client'`: veja [Next.js](https://joaogabriel15.github.io/vitral/frameworks/next#host-com-app-router).
325
357
 
326
358
  ## Nuxt como host
327
359
 
328
- Exemplo: uma loja em Nuxt com a área "Catálogo", feita por outra equipe.
360
+ Exemplo: uma loja em Nuxt com a área "Catálogo", feita por outra equipe. Os dois lados abaixo têm os mesmos arquivos, na mesma ordem. Com vitral, a loja ganha dois arquivos novos no fim.
329
361
 
330
362
  ### Hoje, com dois apps Nuxt
331
363
 
332
- A loja repassa as URLs de `/catalogo` para o app do catálogo.
333
-
334
364
  ```
335
365
  loja/ app Nuxt principal
336
366
  catalogo/ segundo app Nuxt
337
367
  ```
338
368
 
369
+ ```vue
370
+ <!-- catalogo/app/pages/index.vue -->
371
+ <template>
372
+ <h1>Catálogo</h1>
373
+ </template>
374
+ ```
375
+
339
376
  ```ts
340
377
  // catalogo/nuxt.config.ts
341
378
  export default defineNuxtConfig({
@@ -343,11 +380,6 @@ export default defineNuxtConfig({
343
380
  })
344
381
  ```
345
382
 
346
- ```vue
347
- <!-- catalogo/app/pages/index.vue -->
348
- <template><h1>Catálogo</h1></template>
349
- ```
350
-
351
383
  ```ts
352
384
  // loja/nuxt.config.ts
353
385
  export default defineNuxtConfig({
@@ -365,28 +397,44 @@ export default defineNuxtConfig({
365
397
 
366
398
  ### O mesmo app com vitral
367
399
 
368
- A loja continua sendo o único app Nuxt. O catálogo vira um remote: um projeto Vite com o mesmo componente.
369
-
370
400
  ```
371
401
  loja/ app Nuxt (o host)
372
- catalogo/ projeto Vite (o remote)
402
+ catalogo/ o mesmo componente, buildado com Vite (o remote)
403
+ ```
404
+
405
+ ```vue
406
+ <!-- catalogo/app/pages/index.vue (igual) -->
407
+ <template>
408
+ <h1>Catálogo</h1>
409
+ </template>
373
410
  ```
374
411
 
375
412
  ```js
376
- // catalogo/vite.config.js (no lugar do app Nuxt do catálogo)
413
+ // catalogo/vite.config.js (no lugar do nuxt.config.ts)
377
414
  import vue from '@vitejs/plugin-vue'
378
415
  import vitral from 'vitral/vite'
379
416
 
380
- export default { plugins: [vue(), vitral({ name: 'catalogo', dedupe: ['vue'] })] }
417
+ export default {
418
+ plugins: [
419
+ vue(),
420
+ vitral({ name: 'catalogo', entry: 'app/pages/index.vue', dedupe: ['vue'] }),
421
+ ],
422
+ }
423
+ ```
424
+
425
+ ```ts
426
+ // loja/nuxt.config.ts (sem o proxy)
427
+ export default defineNuxtConfig({})
381
428
  ```
382
429
 
383
430
  ```vue
384
- <!-- catalogo/src/App.vue (o mesmo componente da página) -->
385
- <template><h1>Catálogo</h1></template>
431
+ <!-- loja/app/components/Menu.vue -->
432
+ <!-- <NuxtLink>: a troca é sem recarregar. -->
433
+ <NuxtLink to="/catalogo">Catálogo</NuxtLink>
386
434
  ```
387
435
 
388
436
  ```ts
389
- // loja/app/plugins/vitral.client.ts (no lugar do proxy)
437
+ // loja/app/plugins/vitral.client.ts (arquivo novo: registra o catálogo)
390
438
  import * as Vue from 'vue'
391
439
  import { configure } from 'vitral'
392
440
 
@@ -399,7 +447,7 @@ export default defineNuxtPlugin(() => {
399
447
  ```
400
448
 
401
449
  ```vue
402
- <!-- loja/app/pages/catalogo.vue (arquivo novo: a página que mostra o catálogo) -->
450
+ <!-- loja/app/pages/catalogo/[...slug].vue (arquivo novo: a página da loja que mostra o catálogo) -->
403
451
  <script setup lang="ts">
404
452
  import { VitralRemote } from 'vitral/vue'
405
453
  </script>
@@ -411,12 +459,6 @@ import { VitralRemote } from 'vitral/vue'
411
459
  </template>
412
460
  ```
413
461
 
414
- ```vue
415
- <!-- loja/app/components/Menu.vue -->
416
- <!-- <NuxtLink> normal: a troca é sem recarregar. -->
417
- <NuxtLink to="/catalogo">Catálogo</NuxtLink>
418
- ```
419
-
420
462
  O servidor renderiza o `fallback` e o catálogo monta no navegador. Não precisa de `<ClientOnly>`.
421
463
 
422
464
  ### O que muda
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vitral",
3
- "version": "0.11.4",
3
+ "version": "0.11.5",
4
4
  "description": "Micro-frontends com qualquer framework, sem configurar build no host. React, Next.js, Vue, Nuxt, Angular, Svelte e outros na mesma página.",
5
5
  "keywords": [
6
6
  "micro-frontend",