@sanity/export 3.42.2 → 3.44.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/export",
-  "version": "3.42.2",
+  "version": "3.44.0",
   "description": "Export Sanity documents and assets",
   "keywords": [
     "sanity",

package/src/export.js

@@ -9,9 +9,7 @@ const JsonStreamStringify = require('json-stream-stringify')
 const AssetHandler = require('./AssetHandler')
 const debug = require('./debug')
 const pipeAsync = require('./util/pipeAsync')
-const filterDocumentTypes = require('./filterDocumentTypes')
-const filterDrafts = require('./filterDrafts')
-const filterSystemDocuments = require('./filterSystemDocuments')
+const filterDocuments = require('./filterDocuments')
 const getDocumentsStream = require('./getDocumentsStream')
 const getDocumentCursorStream = require('./getDocumentCursorStream')
 const logFirstChunk = require('./logFirstChunk')
@@ -47,7 +45,7 @@ async function exportDataset(opts) {
     .replace(/[^a-z0-9]/gi, '-')
     .toLowerCase()
 
-  const prefix = `${opts.dataset}-export-${slugDate}`
+  const prefix = `${opts.dataset ?? opts.mediaLibraryId}-export-${slugDate}`
   const tmpDir = path.join(os.tmpdir(), prefix)
   fs.mkdirSync(tmpDir, {recursive: true})
   const dataPath = path.join(tmpDir, 'data.ndjson')
@@ -156,10 +154,17 @@ async function exportDataset(opts) {
     logFirstChunk(),
     split(tryParseJson),
     rejectOnApiError(),
-    filterSystemDocuments(),
+    filterDocuments(options.drafts),
     assetStreamHandler,
-    filterDocumentTypes(options.types),
-    options.drafts ? miss.through.obj() : filterDrafts(),
+    miss.through.obj((doc, _enc, callback) => {
+      if (options.filterDocument(doc)) {
+        return callback(null, doc)
+      }
+      return callback()
+    }),
+    miss.through.obj((doc, _enc, callback) => {
+      callback(null, options.transformDocument(doc))
+    }),
     miss.through.obj(reportDocumentCount),
     stringifyStream(),
   )
@@ -220,7 +225,11 @@ async function exportDataset(opts) {
 
       const assetsStream = fs.createWriteStream(assetsPath)
       await pipeAsync(new JsonStreamStringify(assetMap), assetsStream)
-      archive.file(assetsPath, {name: 'assets.json', prefix})
+
+      if (options.assetsMap) {
+        archive.file(assetsPath, {name: 'assets.json', prefix})
+      }
+
       clearInterval(progressInterval)
     } catch (assetErr) {
       clearInterval(progressInterval)

package/src/{filterSystemDocuments.js → filterDocuments.js}

@@ -1,19 +1,34 @@
 const miss = require('mississippi')
 const debug = require('./debug')
 
+const isDraftOrVersion = (doc) => doc && doc._id && (
+  doc._id.indexOf('drafts.') === 0 ||
+  doc._id.indexOf('versions.') === 0
+)
+
 const isSystemDocument = (doc) => doc && doc._id && doc._id.indexOf('_.') === 0
+const isRelease = (doc) => doc && doc._id && doc._id.indexOf('_.releases.') === 0
 const isCursor = (doc) => doc && !doc._id && doc.nextCursor !== undefined
 
-module.exports = () =>
+module.exports = (drafts) =>
   miss.through.obj((doc, enc, callback) => {
-    if (isSystemDocument(doc)) {
-      debug('%s is a system document, skipping', doc && doc._id)
-      return callback()
-    }
     if (isCursor(doc)) {
       debug('%o is a cursor, skipping', doc)
       return callback()
     }
 
+    if (!drafts && isDraftOrVersion(doc)) {
+      debug('%s is a draft or version, skipping', doc && doc._id)
+      return callback()
+    }
+
+    if (isSystemDocument(doc)) {
+      if (!drafts && isRelease(doc)) {
+        return callback(null, doc)
+      }
+      debug('%s is a system document, skipping', doc && doc._id)
+      return callback()
+    }
+
     return callback(null, doc)
-  })
+  }) 

package/src/getDocumentCursorStream.js

@@ -66,9 +66,13 @@ module.exports = async (options) => {
 }
 
 function startStream(options, nextCursor) {
-  const url = options.client.getUrl(
-    `/data/export/${options.dataset}?nextCursor=${encodeURIComponent(nextCursor)}`,
+  const baseUrl = options.client.getUrl(
+    options.dataset
+      ? `/data/export/${options.dataset}`
+      : `/media-libraries/${options.mediaLibraryId}/export`,
   )
+
+  const url = `${baseUrl}?nextCursor=${encodeURIComponent(nextCursor)}`
   const token = options.client.config().token
   const headers = {
     'User-Agent': `${pkg.name}@${pkg.version}`,

package/src/getDocumentsStream.js

@@ -4,7 +4,12 @@ const requestStream = require('./requestStream')
 module.exports = (options) => {
   // Sanity client doesn't handle streams natively since we want to support node/browser
   // with same API. We're just using it here to get hold of URLs and tokens.
-  const url = options.client.getUrl(`/data/export/${options.dataset}`)
+  const url = options.client.getUrl(
+    options.dataset
+      ? `/data/export/${options.dataset}`
+      : `/media-libraries/${options.mediaLibraryId}/export`,
+  )
+
   const token = options.client.config().token
   const headers = {
     'User-Agent': `${pkg.name}@${pkg.version}`,

package/src/validateOptions.js

@@ -14,18 +14,33 @@ const exportDefaults = {
   compress: true,
   drafts: true,
   assets: true,
+  assetsMap: true,
   raw: false,
   mode: MODE_STREAM,
   maxRetries: DOCUMENT_STREAM_MAX_RETRIES,
   maxAssetRetries: ASSET_DOWNLOAD_MAX_RETRIES,
   readTimeout: REQUEST_READ_TIMEOUT,
+  filterDocument: () => true,
+  transformDocument: (doc) => doc,
 }
 
 function validateOptions(opts) {
   const options = defaults({}, opts, exportDefaults)
 
-  if (typeof options.dataset !== 'string' || options.dataset.length < 1) {
-    throw new Error(`options.dataset must be a valid dataset name`)
+  const resources = [options.dataset, options.mediaLibraryId].filter(
+    (resource) => typeof resource === 'string' && resource.length !== 0,
+  )
+
+  if (resources.length === 0) {
+    throw new Error(
+      'either `options.dataset` or `options.mediaLibraryId` must be specified, got neither',
+    )
+  }
+
+  if (resources.length === 2) {
+    throw new Error(
+      'either `options.dataset` or `options.mediaLibraryId` must be specified, got both',
+    )
   }
 
   if (
@@ -77,6 +92,24 @@ function validateOptions(opts) {
     throw new Error('`assetConcurrency` must be between 1 and 24')
   }
 
+  if (
+    typeof options.filterDocument !== 'undefined' &&
+    typeof options.filterDocument !== 'function'
+  ) {
+    throw new Error('`filterDocument` must be a function')
+  }
+
+  if (
+    typeof options.transformDocument !== 'undefined' &&
+    typeof options.transformDocument !== 'function'
+  ) {
+    throw new Error('`transformDocument` must be a function')
+  }
+
+  if (typeof assetsMap !== 'undefined' && typeof assetsMap !== 'boolean') {
+    throw new Error('`assetsMap` must be a boolean')
+  }
+
   return options
 }
 

package/src/filterDrafts.js

@@ -1,12 +0,0 @@
-const miss = require('mississippi')
-
-const isDraft = (doc) => doc && doc._id && doc._id.indexOf('drafts.') === 0
-
-module.exports = () =>
-  miss.through.obj((doc, enc, callback) => {
-    if (isDraft(doc)) {
-      return callback()
-    }
-
-    return callback(null, doc)
-  })