contentful-export 8.0.3 → 8.1.0-exo.1

package/dist/index.js

@@ -80,6 +80,7 @@ function runContentfulExport(params) {
         skipRoles: options.skipRoles,
         skipTags: options.skipTags,
         stripTags: options.stripTags,
+        includeExperienceOrchestration: options.includeExperienceOrchestration,
         listrOptions,
         queryEntries: options.queryEntries,
         queryAssets: options.queryAssets

package/dist/parseOptions.js

@@ -30,6 +30,7 @@ function parseOptions(params) {
     skipTags: false,
     stripTags: false,
     maxAllowedLimit: 1000,
+    includeExperienceOrchestration: false,
     saveFile: true,
     useVerboseRenderer: false,
     rawProxy: false

package/dist/tasks/get-space-data.js

@@ -31,6 +31,7 @@ function getFullSourceSpace({
   includeDrafts,
   includeArchived,
   maxAllowedLimit,
+  includeExperienceOrchestration,
   listrOptions,
   queryEntries,
   queryAssets
@@ -148,6 +149,102 @@ function getFullSourceSpace({
       });
     }),
     skip: () => skipRoles || environmentId !== 'master' && 'Roles can only be exported from master environment'
+  }, {
+    title: 'Fetching Design Tokens data',
+    task: (0, _contentfulBatchLibs.wrapTask)(async ctx => {
+      try {
+        ctx.data.designTokens = await cursorPagedGet({
+          client,
+          spaceId,
+          environmentId,
+          method: 'designToken.getMany'
+        });
+      } catch (err) {
+        _contentfulBatchLibs.logEmitter.emit('warning', `Skipping Design Tokens export: ${err.message}`);
+        ctx.data.designTokens = [];
+      }
+    }),
+    skip: () => !includeExperienceOrchestration
+  }, {
+    title: 'Fetching Component Types data',
+    task: (0, _contentfulBatchLibs.wrapTask)(async ctx => {
+      try {
+        ctx.data.componentTypes = await cursorPagedGet({
+          client,
+          spaceId,
+          environmentId,
+          method: 'componentType.getMany'
+        });
+      } catch (err) {
+        _contentfulBatchLibs.logEmitter.emit('warning', `Skipping Component Types export: ${err.message}`);
+        ctx.data.componentTypes = [];
+      }
+    }),
+    skip: () => !includeExperienceOrchestration
+  }, {
+    title: 'Fetching Templates data',
+    task: (0, _contentfulBatchLibs.wrapTask)(async ctx => {
+      try {
+        ctx.data.templates = await cursorPagedGet({
+          client,
+          spaceId,
+          environmentId,
+          method: 'template.getMany'
+        });
+      } catch (err) {
+        _contentfulBatchLibs.logEmitter.emit('warning', `Skipping Templates export: ${err.message}`);
+        ctx.data.templates = [];
+      }
+    }),
+    skip: () => !includeExperienceOrchestration
+  }, {
+    title: 'Fetching Data Assemblies data',
+    task: (0, _contentfulBatchLibs.wrapTask)(async ctx => {
+      try {
+        ctx.data.dataAssemblies = await cursorPagedGet({
+          client,
+          spaceId,
+          environmentId,
+          method: 'dataAssembly.getMany'
+        });
+      } catch (err) {
+        _contentfulBatchLibs.logEmitter.emit('warning', `Skipping Data Assemblies export: ${err.message}`);
+        ctx.data.dataAssemblies = [];
+      }
+    }),
+    skip: () => !includeExperienceOrchestration
+  }, {
+    title: 'Fetching Fragments data',
+    task: (0, _contentfulBatchLibs.wrapTask)(async ctx => {
+      try {
+        ctx.data.fragments = await cursorPagedGet({
+          client,
+          spaceId,
+          environmentId,
+          method: 'fragment.getMany'
+        });
+      } catch (err) {
+        _contentfulBatchLibs.logEmitter.emit('warning', `Skipping Fragments export: ${err.message}`);
+        ctx.data.fragments = [];
+      }
+    }),
+    skip: () => !includeExperienceOrchestration
+  }, {
+    title: 'Fetching Experiences data',
+    task: (0, _contentfulBatchLibs.wrapTask)(async ctx => {
+      try {
+        ctx.data.experiences = await cursorPagedGet({
+          client,
+          spaceId,
+          environmentId,
+          method: 'experience.getMany'
+        });
+      } catch (err) {
+        _contentfulBatchLibs.logEmitter.emit('warning', `Skipping Experiences export: ${err.message}`);
+        ctx.data.experiences = [];
+      }
+    }),
+    skip: () => !includeExperienceOrchestration
   }], listrOptions);
 }
 function getEditorInterfaces(contentTypes) {
@@ -166,6 +263,37 @@ function getEditorInterfaces(contentTypes) {
   });
 }
 
+/**
+ * Gets all ExO entities using cursor-based pagination (pageNext/pagePrev tokens).
+ * ExO list endpoints do not support skip-based pagination or the order param.
+ */
+async function cursorPagedGet({
+  client,
+  spaceId,
+  environmentId,
+  method
+}) {
+  const [entity, operation] = method.split('.');
+  const allItems = [];
+  let pageNext = null;
+  do {
+    var _response$pages$next, _response$pages;
+    const query = {
+      spaceId,
+      environmentId,
+      limit: pageLimit
+    };
+    if (pageNext) {
+      query.pageNext = pageNext;
+    }
+    const response = await client[entity][operation](query);
+    allItems.push(...response.items);
+    _contentfulBatchLibs.logEmitter.emit('info', `Fetched ${allItems.length} ${entity} items`);
+    pageNext = (_response$pages$next = (_response$pages = response.pages) === null || _response$pages === void 0 ? void 0 : _response$pages.next) !== null && _response$pages$next !== void 0 ? _response$pages$next : null;
+  } while (pageNext);
+  return allItems;
+}
+
 /**
  * Gets all the existing entities based on pagination parameters.
  * The first call will have no aggregated response. Subsequent calls will

package/dist/usageParams.js

@@ -103,6 +103,10 @@ var _default = exports.default = _yargs.default.version(_package.default.version
   describe: 'Display progress in new lines instead of displaying a busy spinner and the status in the same line. Useful for CI.',
   type: 'boolean',
   default: false
+}).option('include-experience-orchestration', {
+  describe: 'Include Experience Orchestration entities (Component Types, Templates, Data Assemblies, Fragments, Experiences, Design Tokens). Requires exo_m1 entitlement on the source space.',
+  type: 'boolean',
+  default: false
 }).option('header', {
   alias: 'H',
   type: 'string',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentful-export",
-  "version": "8.0.3",
+  "version": "8.1.0-exo.1",
   "description": "this tool allows you to export a space to a JSON dump",
   "main": "dist/index.js",
   "types": "types.d.ts",
@@ -111,7 +111,7 @@
         "prerelease": true
       },
       {
-        "name": "exo",
+        "name": "feat/exo",
         "channel": "exo",
         "prerelease": "exo"
       }

package/types.d.ts

@@ -28,9 +28,10 @@ export interface Options {
   skipWebhooks?: boolean;
   skipTags?: boolean;
   useVerboseRenderer?: boolean;
+  includeExperienceOrchestration?: boolean;
 }
 
-type ContentfulExportField = 'contentTypes' | 'entries' | 'assets' | 'locales' | 'tags' | 'webhooks' | 'roles' | 'editorInterfaces';
+type ContentfulExportField = 'contentTypes' | 'entries' | 'assets' | 'locales' | 'tags' | 'webhooks' | 'roles' | 'editorInterfaces' | 'designTokens' | 'componentTypes' | 'templates' | 'dataAssemblies' | 'fragments' | 'experiences';
 
 declare const runContentfulExport: (params: Options) => Promise<Record<ContentfulExportField, unknown[]>>
 export default runContentfulExport