contentful-export 9.0.0-exo.1 → 9.0.0-exo.2
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 +43 -1
- package/dist/parseOptions.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -268,6 +268,12 @@ Full path to the error log file
|
|
|
268
268
|
|
|
269
269
|
Display progress in new lines instead of displaying a busy spinner and the status in the same line. Useful for CI.
|
|
270
270
|
|
|
271
|
+
### Experience Orchestration
|
|
272
|
+
|
|
273
|
+
#### `includeExperienceOrchestration` [boolean] [default: true]
|
|
274
|
+
|
|
275
|
+
Flag controlling whether Experience Orchestration (ExO) entities — Design Tokens, Components, Experience Templates, Data Assemblies, Experience Fragments, and Experiences — are exported when present in the source space. Requires the `exoM1` entitlement on the source space's organization. Set to `false` to opt out. See the "Experience Orchestration (ExO) entities" section below for what happens when the space isn't entitled.
|
|
276
|
+
|
|
271
277
|
## :rescue_worker_helmet: Troubleshooting
|
|
272
278
|
|
|
273
279
|
### Proxy
|
|
@@ -324,12 +330,48 @@ This is an overview of the exported data:
|
|
|
324
330
|
"tags": [],
|
|
325
331
|
"webhooks": [],
|
|
326
332
|
"roles": [],
|
|
327
|
-
"editorInterfaces": []
|
|
333
|
+
"editorInterfaces": [],
|
|
334
|
+
"designTokens": [],
|
|
335
|
+
"components": [],
|
|
336
|
+
"experienceTemplates": [],
|
|
337
|
+
"dataAssemblies": [],
|
|
338
|
+
"experienceFragments": [],
|
|
339
|
+
"experiences": []
|
|
328
340
|
}
|
|
329
341
|
```
|
|
330
342
|
|
|
331
343
|
_Note:_ Tags feature is not available for all users. If you do not have access to this feature, the tags array will always be empty.
|
|
332
344
|
|
|
345
|
+
_Note:_ `designTokens`, `components`, `experienceTemplates`, `dataAssemblies`, `experienceFragments`, and `experiences` are Experience Orchestration (ExO) entities — present by default; absent only if you explicitly set `includeExperienceOrchestration: false` — see the "Experience Orchestration (ExO) entities" section below.
|
|
346
|
+
|
|
347
|
+
## :test_tube: Experience Orchestration (ExO) entities
|
|
348
|
+
|
|
349
|
+
Experience Orchestration (ExO) is Contentful's system for composing and rendering structured page experiences. It sits above the traditional entry/content-type layer and provides six dedicated entity types — Design Tokens, Components, Experience Templates, Data Assemblies, Experience Fragments, and Experiences — that together describe how content is fetched, assembled, and laid out.
|
|
350
|
+
|
|
351
|
+
> **Experimental:** ExO entities (`designTokens`, `components`, `experienceTemplates`, `dataAssemblies`, `experienceFragments`, `experiences`) are `@internal` and considered experimental. Their shape and export behavior are subject to change without notice.
|
|
352
|
+
|
|
353
|
+
ExO export is on by default (`includeExperienceOrchestration: true`) — for the CLI and the module API alike. Pass `includeExperienceOrchestration: false` (`--include-experience-orchestration=false` on the CLI) to opt out.
|
|
354
|
+
|
|
355
|
+
```javascript
|
|
356
|
+
import contentfulExport from 'contentful-export'
|
|
357
|
+
|
|
358
|
+
const options = {
|
|
359
|
+
spaceId: '<space_id>',
|
|
360
|
+
managementToken: '<content_management_api_key>',
|
|
361
|
+
includeExperienceOrchestration: false // opt out; omit to export ExO entities when present (the default)
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
await contentfulExport(options)
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
If the source space has no ExO entities, or lacks the `exoM1` entitlement, each ExO entity type logs a `Skipping <Entity> export` warning and exports as an empty array — it does not fail the export. Pass `includeExperienceOrchestration: false` if you want to avoid it.
|
|
368
|
+
|
|
369
|
+
Requires the `exoM1` entitlement on the source space's organization. [contentful-cli](https://github.com/contentful/contentful-cli)'s `space export` command doesn't expose this option at all yet, so ExO export isn't reachable through that separate CLI regardless of default.
|
|
370
|
+
|
|
371
|
+
### Round-tripping into `contentful-import`
|
|
372
|
+
|
|
373
|
+
The ExO entities exported here are designed to be fed directly into [`contentful-import`](https://github.com/contentful/contentful-import), which preserves source IDs, applies dependency ordering (a topological sort for Components and Experience Fragments, since either can reference others of the same type), and upgrades entities from older, pre-rename export files automatically. See `contentful-import`'s README "Experience Orchestration (ExO) entities" section for the import-side details.
|
|
374
|
+
|
|
333
375
|
## :warning: Limitations
|
|
334
376
|
|
|
335
377
|
- This tool currently does **not** support the export of space memberships.
|
package/dist/parseOptions.js
CHANGED