contentful-import 10.2.0 → 10.2.1

package/README.md

@@ -235,7 +235,7 @@ contentfulImport({
 
 ### Embargoed Assets
 
-If a space is configured to use the [embargoed assets feature](https://www.contentful.com/help/media/embargoed-assets/), certain options will need to be set to use the export/import tooling. When exporting content ([using `contentful-export`](https://github.com/contentful/contentful-export)), the `downloadAssets` option must be set to `true`. This will download the asset files to your local machine. Then, when importing content, the `uploadAssets` option must be set to `true` and the `assetsDirectory` must be set to the directory that contains all of the exported asset folders.
+If a space is configured to use the [embargoed assets feature](https://www.contentful.com/help/media/embargoed-assets/), export with `downloadAssets: true` and import with `uploadAssets: true` and `assetsDirectory` pointing to the directory generated by the export. Embargoed asset URLs cannot be processed directly during import; the importer now fails before making API calls and prints the required options when the local upload options are missing.
 
 ```javascript
 const contentfulImport = require('contentful-import')
@@ -245,7 +245,7 @@ const options = {
   spaceId: '<space_id>',
   managementToken: '<content_management_api_key>',
   uploadAssets: true,
-  assetsDirectory: '/path/to/exported/assets.json'
+  assetsDirectory: '/path/to/exported-assets'
 }
 
 contentfulImport(options)

package/dist/index.js

@@ -2261,6 +2261,34 @@ function getHeadersConfig(value) {
 var import_proxy = require("contentful-batch-libs/dist/proxy");
 var import_add_sequence_header = __toESM(require("contentful-batch-libs/dist/add-sequence-header"));
 var import_json_ext = require("@discoveryjs/json-ext");
+
+// lib/utils/embargoed-assets.ts
+var EMBARGOED_ASSET_HOST_PATTERN = /^[^.]+\.secure\.ctfassets\.net$/i;
+function getHostname(url) {
+  try {
+    const normalizedUrl = url.startsWith("//") ? `https:${url}` : url;
+    return new URL(normalizedUrl).hostname;
+  } catch {
+    return void 0;
+  }
+}
+function isEmbargoedAssetUrl(url) {
+  if (typeof url !== "string") {
+    return false;
+  }
+  const hostname = getHostname(url);
+  return hostname ? EMBARGOED_ASSET_HOST_PATTERN.test(hostname) : false;
+}
+function getEmbargoedAssetCount(content) {
+  return (content.assets || []).reduce((count, asset) => {
+    const embargoedAssetFiles = Object.values(asset.fields?.file || {}).filter((file) => {
+      return isEmbargoedAssetUrl(file?.url) || isEmbargoedAssetUrl(file?.upload);
+    });
+    return count + embargoedAssetFiles.length;
+  }, 0);
+}
+
+// lib/parseOptions.ts
 var SUPPORTED_ENTITY_TYPES = [
   "contentTypes",
   "tags",
@@ -2313,6 +2341,12 @@ async function parseOptions(params) {
   if (options.skipLocales && !options.contentModelOnly) {
     throw new Error("`skipLocales` can only be used together with `contentModelOnly`");
   }
+  if (options.uploadAssets && !options.assetsDirectory) {
+    throw new Error("`uploadAssets` requires `assetsDirectory`");
+  }
+  if (options.assetsDirectory && !options.uploadAssets) {
+    throw new Error("`assetsDirectory` requires `uploadAssets`");
+  }
   const proxySimpleExp = /.+:\d+/;
   const proxyAuthExp = /.+:.+@.+:\d+/;
   if (typeof options.proxy === "string" && options.proxy && !(proxySimpleExp.test(options.proxy) || proxyAuthExp.test(options.proxy))) {
@@ -2337,6 +2371,14 @@ async function parseOptions(params) {
   SUPPORTED_ENTITY_TYPES.forEach((type) => {
     options.content[type] = options.content[type] || [];
   });
+  if (!options.uploadAssets && !options.contentModelOnly) {
+    const embargoedAssetCount = getEmbargoedAssetCount(options.content);
+    if (embargoedAssetCount) {
+      throw new Error(
+        `Found ${embargoedAssetCount} embargoed asset file${embargoedAssetCount === 1 ? "" : "s"} in the import data. Embargoed asset URLs cannot be processed directly during import. Re-export with \`contentful space export --download-assets\`, then import with \`--upload-assets --assets-directory <export-directory>\`. For library usage, set \`uploadAssets: true\` and \`assetsDirectory\`.`
+      );
+    }
+  }
   if (typeof options.proxy === "string") {
     options.proxy = (0, import_proxy.proxyStringToObject)(options.proxy);
   }

package/dist/index.mjs

@@ -2231,6 +2231,34 @@ function getHeadersConfig(value) {
 import { proxyStringToObject, agentFromProxy } from "contentful-batch-libs/dist/proxy";
 import addSequenceHeader from "contentful-batch-libs/dist/add-sequence-header";
 import { parseChunked } from "@discoveryjs/json-ext";
+
+// lib/utils/embargoed-assets.ts
+var EMBARGOED_ASSET_HOST_PATTERN = /^[^.]+\.secure\.ctfassets\.net$/i;
+function getHostname(url) {
+  try {
+    const normalizedUrl = url.startsWith("//") ? `https:${url}` : url;
+    return new URL(normalizedUrl).hostname;
+  } catch {
+    return void 0;
+  }
+}
+function isEmbargoedAssetUrl(url) {
+  if (typeof url !== "string") {
+    return false;
+  }
+  const hostname = getHostname(url);
+  return hostname ? EMBARGOED_ASSET_HOST_PATTERN.test(hostname) : false;
+}
+function getEmbargoedAssetCount(content) {
+  return (content.assets || []).reduce((count, asset) => {
+    const embargoedAssetFiles = Object.values(asset.fields?.file || {}).filter((file) => {
+      return isEmbargoedAssetUrl(file?.url) || isEmbargoedAssetUrl(file?.upload);
+    });
+    return count + embargoedAssetFiles.length;
+  }, 0);
+}
+
+// lib/parseOptions.ts
 var SUPPORTED_ENTITY_TYPES = [
   "contentTypes",
   "tags",
@@ -2283,6 +2311,12 @@ async function parseOptions(params) {
   if (options.skipLocales && !options.contentModelOnly) {
     throw new Error("`skipLocales` can only be used together with `contentModelOnly`");
   }
+  if (options.uploadAssets && !options.assetsDirectory) {
+    throw new Error("`uploadAssets` requires `assetsDirectory`");
+  }
+  if (options.assetsDirectory && !options.uploadAssets) {
+    throw new Error("`assetsDirectory` requires `uploadAssets`");
+  }
   const proxySimpleExp = /.+:\d+/;
   const proxyAuthExp = /.+:.+@.+:\d+/;
   if (typeof options.proxy === "string" && options.proxy && !(proxySimpleExp.test(options.proxy) || proxyAuthExp.test(options.proxy))) {
@@ -2307,6 +2341,14 @@ async function parseOptions(params) {
   SUPPORTED_ENTITY_TYPES.forEach((type) => {
     options.content[type] = options.content[type] || [];
   });
+  if (!options.uploadAssets && !options.contentModelOnly) {
+    const embargoedAssetCount = getEmbargoedAssetCount(options.content);
+    if (embargoedAssetCount) {
+      throw new Error(
+        `Found ${embargoedAssetCount} embargoed asset file${embargoedAssetCount === 1 ? "" : "s"} in the import data. Embargoed asset URLs cannot be processed directly during import. Re-export with \`contentful space export --download-assets\`, then import with \`--upload-assets --assets-directory <export-directory>\`. For library usage, set \`uploadAssets: true\` and \`assetsDirectory\`.`
+      );
+    }
+  }
   if (typeof options.proxy === "string") {
     options.proxy = proxyStringToObject(options.proxy);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentful-import",
-  "version": "10.2.0",
+  "version": "10.2.1",
   "description": "this tool allows you to import JSON dump exported by contentful-export",
   "main": "dist/index.mjs",
   "typings": "dist/index.d.ts",