@sanity/migrate/src/actions/migration/templates/__tests__/minimalSimple.test.ts

Tooling for running data migrations on Sanity.io projects

import {describe, expect, test} from 'vitest'

import {minimalSimple} from '../minimalSimple.js'

describe('#minimalSimple', () => {
  test('creates template with no doc types', () => {
    const minimalSimpleTemplate = minimalSimple({
      documentTypes: [],
      migrationName: 'My Migration',
    })

    expect(minimalSimpleTemplate).toMatchInlineSnapshot(`
      "import {at, defineMigration, setIfMissing, unset} from 'sanity/migrate'

      export default defineMigration({
        title: "My Migration",

        migrate: {
          document(doc, context) {
            // this will be called for every document of the matching type
            // any patch returned will be applied to the document
            // you can also return mutations that touches other documents

            return at('title', setIfMissing('Default title'))
          },
          node(node, path, context) {
            // this will be called for every node in every document of the matching type
            // any patch returned will be applied to the document
            // you can also return mutations that touches other documents

            if (typeof node === 'string' && node === 'deleteme') {
              return unset()
            }
          },
          object(node, path, context) {
            // this will be called for every object node in every document of the matching type
            // any patch returned will be applied to the document
            // you can also return mutations that touches other documents
            if (node._type === 'author') {
              // make sure all authors objects have a books array
              return at('books', setIfMissing([]))
            }
          },
          array(node, path, context) {
            // this will be called for every array node in every document of the matching type
            // any patch returned will be applied to the document
            // you can also return mutations that touches other documents
          },
          string(node, path, context) {
            // this will be called for every string node in every document of the matching type
            // any patch returned will be applied to the document
            // you can also return mutations that touches other documents
          },
          number(node, path, context) {
            // this will be called for every number node in every document of the matching type
            // any patch returned will be applied to the document
            // you can also return mutations that touches other documents
          },
          boolean(node, path, context) {
            // this will be called for every boolean node in every document of the matching type
            // any patch returned will be applied to the document
            // you can also return mutations that touches other documents
          },
          null(node, path, context) {
            // this will be called for every null node in every document of the matching type
            // any patch returned will be applied to the document
            // you can also return mutations that touches other documents
          },
        },
      })
      "
    `)
  })

  test('creates template with doc types', () => {
    const minimalSimpleTemplate = minimalSimple({
      documentTypes: ['document-1', 'document-2', 'document-3'],
      migrationName: 'My Migration',
    })

    expect(minimalSimpleTemplate).toMatchInlineSnapshot(`
      "import {at, defineMigration, setIfMissing, unset} from 'sanity/migrate'

      export default defineMigration({
        title: "My Migration",
        documentTypes: ["document-1", "document-2", "document-3"],

        migrate: {
          document(doc, context) {
            // this will be called for every document of the matching type
            // any patch returned will be applied to the document
            // you can also return mutations that touches other documents

            return at('title', setIfMissing('Default title'))
          },
          node(node, path, context) {
            // this will be called for every node in every document of the matching type
            // any patch returned will be applied to the document
            // you can also return mutations that touches other documents

            if (typeof node === 'string' && node === 'deleteme') {
              return unset()
            }
          },
          object(node, path, context) {
            // this will be called for every object node in every document of the matching type
            // any patch returned will be applied to the document
            // you can also return mutations that touches other documents
            if (node._type === 'author') {
              // make sure all authors objects have a books array
              return at('books', setIfMissing([]))
            }
          },
          array(node, path, context) {
            // this will be called for every array node in every document of the matching type
            // any patch returned will be applied to the document
            // you can also return mutations that touches other documents
          },
          string(node, path, context) {
            // this will be called for every string node in every document of the matching type
            // any patch returned will be applied to the document
            // you can also return mutations that touches other documents
          },
          number(node, path, context) {
            // this will be called for every number node in every document of the matching type
            // any patch returned will be applied to the document
            // you can also return mutations that touches other documents
          },
          boolean(node, path, context) {
            // this will be called for every boolean node in every document of the matching type
            // any patch returned will be applied to the document
            // you can also return mutations that touches other documents
          },
          null(node, path, context) {
            // this will be called for every null node in every document of the matching type
            // any patch returned will be applied to the document
            // you can also return mutations that touches other documents
          },
        },
      })
      "
    `)
  })
})