vitral 0.11.3 → 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.
- package/README.md +246 -102
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -86,28 +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
|
-
|
|
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
93
|
```jsx
|
|
94
|
-
// src/
|
|
95
|
-
export default function Carrinho({ userId }) {
|
|
94
|
+
// carrinho/src/Carrinho.jsx
|
|
95
|
+
export default function Carrinho({ userId }) {
|
|
96
|
+
return <p>Carrinho do usuário {userId}</p>
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
```js
|
|
101
|
+
// carrinho/webpack.config.js
|
|
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
|
+
}
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
```js
|
|
117
|
+
// loja/webpack.config.js
|
|
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
|
+
}
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
```jsx
|
|
132
|
+
// loja/src/App.jsx
|
|
133
|
+
import { lazy, Suspense } from 'react'
|
|
134
|
+
|
|
135
|
+
const Carrinho = lazy(() => import('carrinho/Carrinho'))
|
|
136
|
+
|
|
137
|
+
export function App() {
|
|
138
|
+
return (
|
|
139
|
+
<Suspense fallback={<p>Carregando…</p>}>
|
|
140
|
+
<Carrinho userId={42} />
|
|
141
|
+
</Suspense>
|
|
142
|
+
)
|
|
143
|
+
}
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### O mesmo app com vitral
|
|
147
|
+
|
|
148
|
+
```jsx
|
|
149
|
+
// carrinho/src/Carrinho.jsx (igual)
|
|
150
|
+
export default function Carrinho({ userId }) {
|
|
151
|
+
return <p>Carrinho do usuário {userId}</p>
|
|
152
|
+
}
|
|
96
153
|
```
|
|
97
154
|
|
|
98
155
|
```js
|
|
99
|
-
// vite.config.js
|
|
156
|
+
// carrinho/vite.config.js (no lugar do webpack.config.js)
|
|
100
157
|
import react from '@vitejs/plugin-react'
|
|
101
158
|
import vitral from 'vitral/vite'
|
|
102
159
|
|
|
103
|
-
export default {
|
|
160
|
+
export default {
|
|
161
|
+
plugins: [
|
|
162
|
+
react(),
|
|
163
|
+
vitral({ name: 'carrinho', entry: 'src/Carrinho.jsx', dedupe: ['react'] }),
|
|
164
|
+
],
|
|
165
|
+
}
|
|
104
166
|
```
|
|
105
167
|
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
168
|
+
```js
|
|
169
|
+
// loja/webpack.config.js (sem o ModuleFederationPlugin)
|
|
170
|
+
module.exports = {
|
|
171
|
+
plugins: [],
|
|
172
|
+
}
|
|
173
|
+
```
|
|
109
174
|
|
|
110
175
|
```jsx
|
|
176
|
+
// loja/src/App.jsx
|
|
111
177
|
import { configure } from 'vitral'
|
|
112
178
|
import { Remote } from 'vitral/react'
|
|
113
179
|
|
|
@@ -118,15 +184,25 @@ export function App() {
|
|
|
118
184
|
}
|
|
119
185
|
```
|
|
120
186
|
|
|
121
|
-
|
|
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`.
|
|
188
|
+
|
|
189
|
+
### O que muda
|
|
190
|
+
|
|
191
|
+
| | Module Federation | vitral |
|
|
192
|
+
|---|---|---|
|
|
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 |
|
|
195
|
+
| Framework | O mesmo nos dois lados | Qualquer um. A loja em React pode mostrar um carrinho em Vue |
|
|
122
196
|
|
|
123
197
|
Numa página HTML qualquer, sem build:
|
|
124
198
|
|
|
125
199
|
```html
|
|
126
200
|
<script type="module" src="https://cdn.jsdelivr.net/npm/vitral/dist/auto.js"></script>
|
|
127
|
-
<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>
|
|
128
202
|
```
|
|
129
203
|
|
|
204
|
+
Guia completo: [Migrar do Module Federation](https://joaogabriel15.github.io/vitral/migracao/module-federation).
|
|
205
|
+
|
|
130
206
|
## Frameworks
|
|
131
207
|
|
|
132
208
|
| Framework | Remote | Host | Import |
|
|
@@ -144,65 +220,9 @@ Numa página HTML qualquer, sem build:
|
|
|
144
220
|
|
|
145
221
|
Host e remote não precisam ser do mesmo framework. Cada um tem uma página com exemplo completo em [Frameworks](https://joaogabriel15.github.io/vitral/frameworks/react).
|
|
146
222
|
|
|
147
|
-
## Next.js
|
|
148
|
-
|
|
149
|
-
O remote é sempre um projeto Vite (React, Vue ou outro), como no Começo rápido acima. O host pode ser um app Next ou Nuxt.
|
|
150
|
-
|
|
151
|
-
**Next.js (App Router):**
|
|
152
|
-
|
|
153
|
-
```tsx
|
|
154
|
-
// app/carrinho.tsx
|
|
155
|
-
'use client'
|
|
156
|
-
import { configure } from 'vitral'
|
|
157
|
-
import { Remote } from 'vitral/react'
|
|
158
|
-
|
|
159
|
-
if (typeof window !== 'undefined') {
|
|
160
|
-
configure({ remotes: { carrinho: 'https://cdn.empresa.com/carrinho/vitral.json' } })
|
|
161
|
-
}
|
|
162
|
-
|
|
163
|
-
export function Carrinho({ userId }: { userId: number }) {
|
|
164
|
-
return <Remote name="carrinho" props={{ userId }} fallback={<p>Carregando…</p>} />
|
|
165
|
-
}
|
|
166
|
-
```
|
|
167
|
-
|
|
168
|
-
```tsx
|
|
169
|
-
// app/page.tsx
|
|
170
|
-
import { Carrinho } from './carrinho'
|
|
171
|
-
|
|
172
|
-
export default function Page() {
|
|
173
|
-
return <main><Carrinho userId={42} /></main>
|
|
174
|
-
}
|
|
175
|
-
```
|
|
176
|
-
|
|
177
|
-
**Nuxt 3 e 4:**
|
|
178
|
-
|
|
179
|
-
```ts
|
|
180
|
-
// app/plugins/vitral.client.ts
|
|
181
|
-
import { configure } from 'vitral'
|
|
182
|
-
|
|
183
|
-
export default defineNuxtPlugin(() => {
|
|
184
|
-
configure({ remotes: { catalogo: 'https://cdn.empresa.com/catalogo/vitral.json' } })
|
|
185
|
-
})
|
|
186
|
-
```
|
|
187
|
-
|
|
188
|
-
```vue
|
|
189
|
-
<!-- app/pages/index.vue -->
|
|
190
|
-
<script setup lang="ts">
|
|
191
|
-
import { VitralRemote } from 'vitral/vue'
|
|
192
|
-
</script>
|
|
193
|
-
|
|
194
|
-
<template>
|
|
195
|
-
<VitralRemote name="catalogo" :props="{ userId: 42 }">
|
|
196
|
-
<template #fallback><p>Carregando…</p></template>
|
|
197
|
-
</VitralRemote>
|
|
198
|
-
</template>
|
|
199
|
-
```
|
|
223
|
+
## Next.js como host
|
|
200
224
|
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
## Multi-Zones ou vitral
|
|
204
|
-
|
|
205
|
-
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.
|
|
206
226
|
|
|
207
227
|
<p align="center">
|
|
208
228
|
<picture>
|
|
@@ -213,13 +233,18 @@ Exemplo: uma loja em Next.js com a área "Minha conta", feita por outra equipe.
|
|
|
213
233
|
|
|
214
234
|
### Hoje, com Multi-Zones
|
|
215
235
|
|
|
216
|
-
São dois apps Next. A loja repassa as URLs de `/conta` para o app da conta.
|
|
217
|
-
|
|
218
236
|
```
|
|
219
237
|
loja/ app Next principal
|
|
220
238
|
conta/ segundo app Next (a zona)
|
|
221
239
|
```
|
|
222
240
|
|
|
241
|
+
```tsx
|
|
242
|
+
// conta/pages/index.tsx
|
|
243
|
+
export default function Conta() {
|
|
244
|
+
return <h1>Minha conta</h1>
|
|
245
|
+
}
|
|
246
|
+
```
|
|
247
|
+
|
|
223
248
|
```js
|
|
224
249
|
// conta/next.config.js
|
|
225
250
|
module.exports = {
|
|
@@ -228,13 +253,6 @@ module.exports = {
|
|
|
228
253
|
}
|
|
229
254
|
```
|
|
230
255
|
|
|
231
|
-
```tsx
|
|
232
|
-
// conta/pages/index.tsx
|
|
233
|
-
export default function Conta() {
|
|
234
|
-
return <h1>Minha conta</h1>
|
|
235
|
-
}
|
|
236
|
-
```
|
|
237
|
-
|
|
238
256
|
```js
|
|
239
257
|
// loja/next.config.js
|
|
240
258
|
module.exports = {
|
|
@@ -248,6 +266,13 @@ module.exports = {
|
|
|
248
266
|
}
|
|
249
267
|
```
|
|
250
268
|
|
|
269
|
+
```tsx
|
|
270
|
+
// loja/pages/_app.tsx
|
|
271
|
+
export default function App({ Component, pageProps }) {
|
|
272
|
+
return <Component {...pageProps} />
|
|
273
|
+
}
|
|
274
|
+
```
|
|
275
|
+
|
|
251
276
|
```tsx
|
|
252
277
|
// loja/components/Menu.tsx
|
|
253
278
|
// <a>, não <Link>: a página recarrega e baixa Next e React de novo.
|
|
@@ -256,30 +281,33 @@ module.exports = {
|
|
|
256
281
|
|
|
257
282
|
### O mesmo app com vitral
|
|
258
283
|
|
|
259
|
-
A loja continua sendo o único app Next. A conta vira um remote: um projeto Vite com o mesmo componente.
|
|
260
|
-
|
|
261
284
|
```
|
|
262
285
|
loja/ app Next (o host)
|
|
263
|
-
conta/
|
|
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
|
+
}
|
|
264
294
|
```
|
|
265
295
|
|
|
266
296
|
```js
|
|
267
|
-
// conta/vite.config.js (no lugar do next.config.js
|
|
297
|
+
// conta/vite.config.js (no lugar do next.config.js)
|
|
268
298
|
import react from '@vitejs/plugin-react'
|
|
269
299
|
import vitral from 'vitral/vite'
|
|
270
300
|
|
|
271
|
-
export default {
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
export default function Conta() {
|
|
277
|
-
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
|
+
],
|
|
278
306
|
}
|
|
279
307
|
```
|
|
280
308
|
|
|
281
309
|
```js
|
|
282
|
-
// loja/next.config.js (no lugar das rewrites)
|
|
310
|
+
// loja/next.config.js (withVitral no lugar das rewrites)
|
|
283
311
|
const { withVitral } = require('vitral/next-config')
|
|
284
312
|
|
|
285
313
|
module.exports = withVitral({}, {
|
|
@@ -290,7 +318,7 @@ module.exports = withVitral({}, {
|
|
|
290
318
|
```
|
|
291
319
|
|
|
292
320
|
```tsx
|
|
293
|
-
// loja/pages/_app.tsx (
|
|
321
|
+
// loja/pages/_app.tsx (mais o <VitralNext />)
|
|
294
322
|
import { VitralNext } from 'vitral/next-host'
|
|
295
323
|
|
|
296
324
|
export default function App({ Component, pageProps }) {
|
|
@@ -299,33 +327,149 @@ export default function App({ Component, pageProps }) {
|
|
|
299
327
|
```
|
|
300
328
|
|
|
301
329
|
```tsx
|
|
302
|
-
// loja/
|
|
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)
|
|
303
337
|
import { NextRemote } from 'vitral/next-host'
|
|
304
338
|
|
|
305
339
|
export default function Conta() {
|
|
306
|
-
return <
|
|
340
|
+
return <NextRemote name="conta" fallback={<p>Carregando…</p>} />
|
|
307
341
|
}
|
|
308
342
|
```
|
|
309
343
|
|
|
310
|
-
|
|
311
|
-
// loja/components/Menu.tsx
|
|
312
|
-
// <Link> normal: a troca é sem recarregar, e o React não baixa de novo.
|
|
313
|
-
<Link href="/conta">Minha conta</Link>
|
|
314
|
-
```
|
|
315
|
-
|
|
316
|
-
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`.
|
|
317
345
|
|
|
318
346
|
### O que muda
|
|
319
347
|
|
|
320
348
|
| | Multi-Zones | vitral |
|
|
321
349
|
|---|---|---|
|
|
322
350
|
| Apps Next | Um por área | Só a loja |
|
|
323
|
-
| Configuração | `basePath` e `assetPrefix` na zona, `rewrites` na loja |
|
|
351
|
+
| Configuração | `basePath` e `assetPrefix` na zona, `rewrites` na loja | Plugin na conta, `withVitral` na loja |
|
|
324
352
|
| Trocar de área | Recarrega a página (0,8 s no benchmark) | Sem recarregar (0,2 s) |
|
|
325
353
|
| React e Next | Baixados de novo em cada área | Uma cópia para a página toda |
|
|
326
354
|
| Layout da loja | Cada zona repete o seu | A conta fica dentro do layout da loja |
|
|
327
355
|
|
|
328
|
-
Guia completo, com SSR por rota e prefetch: [Migrar do Next.js Multi-Zones](https://joaogabriel15.github.io/vitral/migracao/multi-zones).
|
|
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).
|
|
357
|
+
|
|
358
|
+
## Nuxt como host
|
|
359
|
+
|
|
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.
|
|
361
|
+
|
|
362
|
+
### Hoje, com dois apps Nuxt
|
|
363
|
+
|
|
364
|
+
```
|
|
365
|
+
loja/ app Nuxt principal
|
|
366
|
+
catalogo/ segundo app Nuxt
|
|
367
|
+
```
|
|
368
|
+
|
|
369
|
+
```vue
|
|
370
|
+
<!-- catalogo/app/pages/index.vue -->
|
|
371
|
+
<template>
|
|
372
|
+
<h1>Catálogo</h1>
|
|
373
|
+
</template>
|
|
374
|
+
```
|
|
375
|
+
|
|
376
|
+
```ts
|
|
377
|
+
// catalogo/nuxt.config.ts
|
|
378
|
+
export default defineNuxtConfig({
|
|
379
|
+
app: { baseURL: '/catalogo/' },
|
|
380
|
+
})
|
|
381
|
+
```
|
|
382
|
+
|
|
383
|
+
```ts
|
|
384
|
+
// loja/nuxt.config.ts
|
|
385
|
+
export default defineNuxtConfig({
|
|
386
|
+
routeRules: {
|
|
387
|
+
'/catalogo/**': { proxy: `${process.env.CATALOGO_URL}/catalogo/**` },
|
|
388
|
+
},
|
|
389
|
+
})
|
|
390
|
+
```
|
|
391
|
+
|
|
392
|
+
```vue
|
|
393
|
+
<!-- loja/app/components/Menu.vue -->
|
|
394
|
+
<!-- <a>, não <NuxtLink>: a página recarrega e baixa Nuxt e Vue de novo. -->
|
|
395
|
+
<a href="/catalogo">Catálogo</a>
|
|
396
|
+
```
|
|
397
|
+
|
|
398
|
+
### O mesmo app com vitral
|
|
399
|
+
|
|
400
|
+
```
|
|
401
|
+
loja/ app Nuxt (o host)
|
|
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>
|
|
410
|
+
```
|
|
411
|
+
|
|
412
|
+
```js
|
|
413
|
+
// catalogo/vite.config.js (no lugar do nuxt.config.ts)
|
|
414
|
+
import vue from '@vitejs/plugin-vue'
|
|
415
|
+
import vitral from 'vitral/vite'
|
|
416
|
+
|
|
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({})
|
|
428
|
+
```
|
|
429
|
+
|
|
430
|
+
```vue
|
|
431
|
+
<!-- loja/app/components/Menu.vue -->
|
|
432
|
+
<!-- <NuxtLink>: a troca é sem recarregar. -->
|
|
433
|
+
<NuxtLink to="/catalogo">Catálogo</NuxtLink>
|
|
434
|
+
```
|
|
435
|
+
|
|
436
|
+
```ts
|
|
437
|
+
// loja/app/plugins/vitral.client.ts (arquivo novo: registra o catálogo)
|
|
438
|
+
import * as Vue from 'vue'
|
|
439
|
+
import { configure } from 'vitral'
|
|
440
|
+
|
|
441
|
+
export default defineNuxtPlugin(() => {
|
|
442
|
+
configure({
|
|
443
|
+
remotes: { catalogo: 'https://cdn.empresa.com/catalogo/vitral.json' },
|
|
444
|
+
dedupe: { vue: { version: Vue.version, modules: { vue: Vue } } }, // o catálogo usa este Vue
|
|
445
|
+
})
|
|
446
|
+
})
|
|
447
|
+
```
|
|
448
|
+
|
|
449
|
+
```vue
|
|
450
|
+
<!-- loja/app/pages/catalogo/[...slug].vue (arquivo novo: a página da loja que mostra o catálogo) -->
|
|
451
|
+
<script setup lang="ts">
|
|
452
|
+
import { VitralRemote } from 'vitral/vue'
|
|
453
|
+
</script>
|
|
454
|
+
|
|
455
|
+
<template>
|
|
456
|
+
<VitralRemote name="catalogo">
|
|
457
|
+
<template #fallback><p>Carregando…</p></template>
|
|
458
|
+
</VitralRemote>
|
|
459
|
+
</template>
|
|
460
|
+
```
|
|
461
|
+
|
|
462
|
+
O servidor renderiza o `fallback` e o catálogo monta no navegador. Não precisa de `<ClientOnly>`.
|
|
463
|
+
|
|
464
|
+
### O que muda
|
|
465
|
+
|
|
466
|
+
| | Dois apps Nuxt | vitral |
|
|
467
|
+
|---|---|---|
|
|
468
|
+
| Apps Nuxt | Um por área | Só a loja |
|
|
469
|
+
| Configuração | `baseURL` no catálogo, `proxy` na loja | Plugin no catálogo, `configure()` na loja |
|
|
470
|
+
| Trocar de área | Recarrega a página | Sem recarregar |
|
|
471
|
+
| Vue e Nuxt | Baixados de novo em cada área | Uma cópia do Vue para a página toda |
|
|
472
|
+
| Layout da loja | Cada app repete o seu | O catálogo fica dentro do layout da loja |
|
|
329
473
|
|
|
330
474
|
## O que mais vem junto
|
|
331
475
|
|
package/package.json
CHANGED