@sanity/export 3.43.0 → 3.45.0

package/README.md

@@ -18,6 +18,7 @@ exportDataset({
   client: someInstantiatedSanityClientInstance,
 
   // Name of dataset to export
+  // Cannot be combined with `mediaLibraryId`.
   dataset: 'myDataset',
 
   // Path to write tar.gz-archive file to, or `-` for stdout
@@ -47,6 +48,28 @@ exportDataset({
   // Cursor mode might help when dealing with large datasets, but might yield inconsistent results if the dataset is mutated during export.
   // Default: 'stream'
   mode: 'stream',
+
+  // Export data from a media library, instead of a dataset.
+  // Cannot be combined with `dataset`.
+  mediaLibraryId: 'myMediaLibrary',
+
+  // Whether to include the `assets.json` assets map. This file is not necessary when creating a
+  // media library archive.
+  // Caution: customising this option may result in an archive being produced that is impossible to import.
+  // Optional, default: `true`
+  assetsMap: true,
+
+  // A custom filter function for controlling which documents are exported.
+  // Optional, default: `() => true`
+  filterDocument: document => (document.title ?? '').includes('capybara'),
+
+  // A custom transformation function for controlling how each document is exported.
+  // Caution: customising this option may result in an archive being produced that is impossible to import.
+  // Optional, default: `document => document`
+  transformDocument: document => ({
+    ...document,
+    title: document.title ?? 'capybara',
+  }),
 })
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/export",
-  "version": "3.43.0",
+  "version": "3.45.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')
@@ -156,10 +154,8 @@ 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)

package/src/filterDocumentTypes.js

@@ -1,7 +1,7 @@
 const miss = require('mississippi')
 
 module.exports = (allowedTypes) =>
-  allowedTypes
+  allowedTypes && allowedTypes.length > 0
     ? miss.through.obj((doc, enc, callback) => {
         const type = doc && doc._type
         if (allowedTypes.includes(type)) {

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

@@ -72,7 +72,13 @@ function startStream(options, nextCursor) {
       : `/media-libraries/${options.mediaLibraryId}/export`,
   )
 
-  const url = `${baseUrl}?nextCursor=${encodeURIComponent(nextCursor)}`
+  const url = new URL(baseUrl)
+  url.searchParams.set('nextCursor', nextCursor)
+
+  // Type filtering is only supported for datasets.
+  if (options.types && options.types.length > 0 && options.dataset) {
+    url.searchParams.set('types', options.types.join())
+  }
   const token = options.client.config().token
   const headers = {
     'User-Agent': `${pkg.name}@${pkg.version}`,
@@ -81,7 +87,7 @@ function startStream(options, nextCursor) {
 
   debug('Starting stream with cursor "%s"', nextCursor)
 
-  return requestStream({url, headers, maxRetries: options.maxRetries}).then((res) => {
+  return requestStream({url: url.toString(), headers, maxRetries: options.maxRetries}).then((res) => {
     debug('Got stream with HTTP %d', res.statusCode)
 
     return res

package/src/getDocumentsStream.js

@@ -4,11 +4,17 @@ 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(
+  const baseUrl = options.client.getUrl(
     options.dataset
       ? `/data/export/${options.dataset}`
       : `/media-libraries/${options.mediaLibraryId}/export`,
   )
+  
+  // Type filtering is only supported for datasets.
+  const url = new URL(baseUrl)
+  if (options.types && options.types.length > 0 && options.dataset) {
+    url.searchParams.set('types', options.types.join())
+  }
 
   const token = options.client.config().token
   const headers = {
@@ -17,7 +23,7 @@ module.exports = (options) => {
   }
 
   return requestStream({
-    url,
+    url: url.toString(),
     headers,
     maxRetries: options.maxRetries,
     readTimeout: options.readTimeout,

package/src/validateOptions.js

@@ -43,6 +43,10 @@ function validateOptions(opts) {
     )
   }
 
+  if (options.types && !options.dataset) {
+    throw new Error('`options.types` is only supported when exporting from a dataset')
+  }
+
   if (
     typeof options.mode !== 'string' ||
     (options.mode !== MODE_STREAM && options.mode !== MODE_CURSOR)

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)
-  })