index.ts

import { DefaultConfig } from '../types';

const config: DefaultConfig = {
  versioning: false,
  // use below hosts for eu region
  // host:'https://eu-api.contentstack.com/v3',
  // use below hosts for azure-na region
  // host:'https://azure-na-api.contentstack.com/v3',
  // use below hosts for azure-eu region
  // host:'https://azure-eu-api.contentstack.com/v3',
  // use below hosts for gcp-na region
  // host:'https://gcp-na-api.contentstack.com',
  // pass locale, only to migrate entries from that locale
  // not passing `locale` will migrate all the locales present
  // locales: ['fr-fr'],
  host: 'https://api.contentstack.io/v3',
  extensionHost: 'https://app.contentstack.com',
  developerHubUrls: {
    'https://api.contentstack.io': 'https://developerhub-api.contentstack.com',
    'https://eu-api.contentstack.com': 'https://eu-developerhub-api.contentstack.com',
    'https://azure-na-api.contentstack.com': 'https://azure-na-developerhub-api.contentstack.com',
    'https://azure-eu-api.contentstack.com': 'https://azure-eu-developerhub-api.contentstack.com',
    'https://gcp-na-api.contentstack.com': 'https://gcp-na-developerhub-api.contentstack.com',
  },
  modules: {
    apiConcurrency: 5,
    types: [
      'locales',
      'environments',
      'assets',
      'taxonomies',
      'extensions',
      'marketplace-apps',
      'global-fields',
      'content-types',
      'personalize',
      'custom-roles',
      'workflows',
      'entries',
      'variant-entries',
      'labels',
      'webhooks',
    ],
    locales: {
      dirName: 'locales',
      fileName: 'locales.json',
      requiredKeys: ['code', 'uid', 'name', 'fallback_locale'],
    },
    masterLocale: {
      dirName: 'locales',
      fileName: 'master-locale.json',
      requiredKeys: ['code', 'uid', 'name'],
    },
    customRoles: {
      dirName: 'custom-roles',
      fileName: 'custom-roles.json',
      customRolesLocalesFileName: 'custom-roles-locales.json',
    },
    environments: {
      dirName: 'environments',
      fileName: 'environments.json',
    },
    labels: {
      dirName: 'labels',
      fileName: 'labels.json',
    },
    extensions: {
      dirName: 'extensions',
      fileName: 'extensions.json',
      validKeys: ['data_type', 'srcdoc', 'title', 'type', 'mutiple', 'config'],
    },
    webhooks: {
      dirName: 'webhooks',
      fileName: 'webhooks.json',
    },
    releases: {
      dirName: 'releases',
      fileName: 'releases.json',
      invalidKeys: ['stackHeaders', 'urlPath', 'created_at', 'updated_at', 'created_by', 'updated_by'],
    },
    workflows: {
      dirName: 'workflows',
      fileName: 'workflows.json',
      invalidKeys: ['stackHeaders', 'urlPath', 'created_at', 'updated_at', 'created_by', 'updated_by'],
    },
    assets: {
      dirName: 'assets',
      assetBatchLimit: 1,
      publishAssets: true,
      fileName: 'assets.json',
      importSameStructure: true,
      uploadAssetsConcurrency: 2,
      displayExecutionTime: false,
      importFoldersConcurrency: 1,
      includeVersionedAssets: false,
      host: 'https://api.contentstack.io',
      folderValidKeys: ['name', 'parent_uid'],
      validKeys: ['title', 'parent_uid', 'description', 'tags'],
    },
    'assets-old': {
      dirName: 'assets',
      fileName: 'assets.json',
      // This is the total no. of asset objects fetched in each 'get assets' call
      limit: 100,
      host: 'https://api.contentstack.io',
      validKeys: ['uid', 'filename', 'url', 'status'],
      assetBatchLimit: 1,
      uploadAssetsConcurrency: 1,
      importFoldersConcurrency: 1,
    },
    content_types: {
      dirName: 'content_types',
      fileName: 'content_types.json',
      validKeys: ['title', 'uid', 'schema', 'options', 'singleton', 'description'],
      limit: 100,
    },
    'content-types': {
      dirName: 'content_types',
      fileName: 'content_types.json',
      validKeys: ['title', 'uid', 'schema', 'options', 'singleton', 'description'],
      limit: 100,
    },
    entries: {
      dirName: 'entries',
      fileName: 'entries.json',
      invalidKeys: ['created_at', 'updated_at', 'created_by', 'updated_by', '_metadata', 'published'],
      limit: 50,
      assetBatchLimit: 5,
    },
    globalfields: {
      dirName: 'global_fields',
      fileName: 'globalfields.json',
      validKeys: ['title', 'uid', 'schema', 'options', 'singleton', 'description'],
      limit: 100,
    },
    'global-fields': {
      dirName: 'global_fields',
      fileName: 'globalfields.json',
      validKeys: ['title', 'uid', 'schema', 'options', 'singleton', 'description'],
      limit: 100,
    },
    stack: {
      dirName: 'stack',
      fileName: 'stack.json',
    },
    marketplace_apps: {
      dirName: 'marketplace_apps',
      fileName: 'marketplace_apps.json',
    },
    taxonomies: {
      dirName: 'taxonomies',
      fileName: 'taxonomies.json',
    },
    personalize: {
      baseURL: {
        NA: 'https://personalize-api.contentstack.com',
      },
      importData: true,
      dirName: 'personalize',
      importOrder: ['attributes', 'audiences', 'events', 'experiences'],
      project_id: '',
      projects: {
        dirName: 'projects',
        fileName: 'projects.json',
      },
      attributes: {
        dirName: 'attributes',
        fileName: 'attributes.json',
      },
      audiences: {
        dirName: 'audiences',
        fileName: 'audiences.json',
      },
      events: {
        dirName: 'events',
        fileName: 'events.json',
      },
      experiences: {
        dirName: 'experiences',
        fileName: 'experiences.json',
        thresholdTimer: 60000,
        checkIntervalDuration: 10000,
      },
    },
    variantEntry: {
      dirName: 'variants',
      fileName: 'index.json',
      apiConcurrency: 5,
      query: {
        locale: 'en-us',
      },
    },
  },
  languagesCode: [
    'af-za',
    'sq-al',
    'ar',
    'ar-dz',
    'ar-bh',
    'ar-eg',
    'ar-iq',
    'ar-jo',
    'ar-kw',
    'ar-lb',
    'ar-ly',
    'ar-ma',
    'ar-om',
    'ar-qa',
    'ar-sa',
    'ar-sy',
    'ar-tn',
    'ar-ae',
    'ar-ye',
    'hy-am',
    'az',
    'cy-az-az',
    'lt-az-az',
    'eu-es',
    'be-by',
    'bs',
    'bg-bg',
    'ca-es',
    'zh',
    'zh-au',
    'zh-cn',
    'zh-hk',
    'zh-mo',
    'zh-my',
    'zh-sg',
    'zh-tw',
    'zh-chs',
    'zh-cht',
    'hr-hr',
    'cs',
    'cs-cz',
    'da-dk',
    'div-mv',
    'nl',
    'nl-be',
    'nl-nl',
    'en',
    'en-au',
    'en-at',
    'en-be',
    'en-bz',
    'en-ca',
    'en-cb',
    'en-cn',
    'en-cz',
    'en-dk',
    'en-do',
    'en-ee',
    'en-fi',
    'en-fr',
    'en-de',
    'en-gr',
    'en-hk',
    'en-hu',
    'en-in',
    'en-id',
    'en-ie',
    'en-it',
    'en-jm',
    'en-jp',
    'en-kr',
    'en-lv',
    'en-lt',
    'en-lu',
    'en-my',
    'en-mx',
    'en-nz',
    'en-no',
    'en-ph',
    'en-pl',
    'en-pt',
    'en-pr',
    'en-ru',
    'en-sg',
    'en-sk',
    'en-si',
    'en-za',
    'en-es',
    'en-se',
    'en-ch',
    'en-th',
    'en-nl',
    'en-tt',
    'en-gb',
    'en-us',
    'en-zw',
    'et-ee',
    'fo-fo',
    'fa-ir',
    'fi',
    'fi-fi',
    'fr',
    'fr-be',
    'fr-ca',
    'fr-fr',
    'fr-lu',
    'fr-mc',
    'fr-ch',
    'fr-us',
    'gd',
    'gl-es',
    'ka-ge',
    'de',
    'de-at',
    'de-de',
    'de-li',
    'de-lu',
    'de-ch',
    'el-gr',
    'gu-in',
    'he-il',
    'hi-in',
    'hu-hu',
    'is-is',
    'id-id',
    'it',
    'it-it',
    'it-ch',
    'ja',
    'ja-jp',
    'kn-in',
    'kk-kz',
    'km-kh',
    'kok-in',
    'ko',
    'ko-kr',
    'ky-kz',
    'lv-lv',
    'lt-lt',
    'mk-mk',
    'ms',
    'ms-bn',
    'ms-my',
    'ms-sg',
    'mt',
    'mr-in',
    'mn-mn',
    'no',
    'no-no',
    'nb-no',
    'nn-no',
    'pl-pl',
    'pt',
    'pt-br',
    'pt-pt',
    'pa-in',
    'ro-ro',
    'ru',
    'ru-kz',
    'ru-ru',
    'ru-ua',
    'sa-in',
    'cy-sr-sp',
    'lt-sr-sp',
    'sr-me',
    'sk-sk',
    'sl-si',
    'es',
    'es-ar',
    'es-bo',
    'es-cl',
    'es-co',
    'es-cr',
    'es-do',
    'es-ec',
    'es-sv',
    'es-gt',
    'es-hn',
    'es-419',
    'es-mx',
    'es-ni',
    'es-pa',
    'es-py',
    'es-pe',
    'es-pr',
    'es-es',
    'es-us',
    'es-uy',
    'es-ve',
    'sw-ke',
    'sv',
    'sv-fi',
    'sv-se',
    'syr-sy',
    'tl',
    'ta-in',
    'tt-ru',
    'te-in',
    'th-th',
    'tr-tr',
    'uk-ua',
    'ur-pk',
    'uz',
    'cy-uz-uz',
    'lt-uz-uz',
    'vi-vn',
    'xh',
    'zu',
  ],
  apis: {
    userSession: '/user-session/',
    locales: '/locales/',
    environments: '/environments/',
    assets: '/assets/',
    content_types: '/content_types/',
    entries: '/entries/',
    extensions: '/extensions/',
    webhooks: '/webhooks/',
    globalfields: '/global_fields/',
    folders: '/folders/',
    stacks: '/stacks/',
    labels: '/labels/',
  },
  overwriteSupportedModules: ['extensions', 'global-fields', 'content-types'],
  rateLimit: 5,
  preserveStackVersion: false,
  entriesPublish: true,
  concurrency: 1,
  importConcurrency: 5,
  fetchConcurrency: 5,
  writeConcurrency: 5,
  developerHubBaseUrl: '',
  marketplaceAppEncryptionKey: 'nF2ejRQcTv',
  getEncryptionKeyMaxRetry: 3,
  // useBackedupDir: '',
  // backupConcurrency: 10,
  onlyTSModules: ['taxonomies', 'personalize'],
  auditConfig: {
    noLog: false, // Skip logs printing on terminal
    skipConfirm: true, // Skip confirmation if any
    returnResponse: true, // On process completion should return config used in the command
    noTerminalOutput: false, // Skip final audit table output on terminal
    config: { basePath: '' }, // To overwrite any build-in config. And this config is equal to --config flag.
  },
  //'taxonomies', 'environments', 'marketplace_apps', workflows, custom-roles --> Add this incase need to extend to the other global modules
  globalModules: ['webhooks'],
};

export default config;