contentful-management 11.60.3 → 12.0.0-beta.10

package/dist/cjs/create-environment-template-api.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-environment-template-api.cjs","sources":["../../lib/create-environment-template-api.ts"],"sourcesContent":["import { createRequestConfig } from 'contentful-sdk-core'\nimport type { BasicCursorPaginationOptions, MakeRequest } from './common-types.js'\nimport {\n  wrapEnvironmentTemplate,\n  wrapEnvironmentTemplateCollection,\n  type EnvironmentTemplateProps,\n} from './entities/environment-template.js'\nimport {\n  wrapEnvironmentTemplateInstallationCollection,\n  type CreateEnvironmentTemplateInstallationProps,\n  type ValidateEnvironmentTemplateInstallationProps,\n} from './entities/environment-template-installation.js'\n\nexport type ContentfulEnvironmentTemplateApi = ReturnType<typeof createEnvironmentTemplateApi>\n\nexport function createEnvironmentTemplateApi(makeRequest: MakeRequest, organizationId: string) {\n  return {\n    /**\n     * Updates a environment template\n     * @return Promise for new version of the template\n     * ```javascript\n     * const contentful = require('contentful-management')\n     *\n     * const client = contentful.createClient({\n     *   accessToken: '<content_management_api_key>'\n     * })\n     *\n     * client.getEnvironmentTemplate('<organization_id>', '<environment_template_id>')\n     * .then((environmentTemplate) => {\n     *   environmentTemplate.name = 'New name'\n     *   return environmentTemplate.update()\n     * })\n     * .then((environmentTemplate) =>\n     *   console.log(`Environment template ${environmentTemplate.sys.id} renamed.`)\n     * ).catch(console.error)\n     * ```\n     */\n    update: function updateEnvironmentTemplate() {\n      const raw = this.toPlainObject() as EnvironmentTemplateProps\n      return makeRequest({\n        entityType: 'EnvironmentTemplate',\n        action: 'update',\n        params: { organizationId, environmentTemplateId: raw.sys.id },\n        payload: raw,\n      }).then((data) => wrapEnvironmentTemplate(makeRequest, data, organizationId))\n    },\n    /**\n     * Updates environment template version data\n     * @param version.versionName - Name of the environment template version\n     * @param version.versionDescription - Description of the environment template version\n     * @return Promise for an updated EnvironmentTemplate\n     * ```javascript\n     * const contentful = require('contentful-management')\n     *\n     * const client = contentful.createClient({\n     *   accessToken: '<content_management_api_key>'\n     * })\n     *\n     * client.getEnvironmentTemplate('<organization_id>', '<environment_template_id>')\n     * .then((environmentTemplate) => {\n     *   return environmentTemplate.updateVersion({\n     *     versionName: 'New Name',\n     *     versionDescription: 'New Description',\n     *   })\n     * })\n     * .then((environmentTemplate) =>\n     *   console.log(`Environment template version ${environmentTemplate.sys.id} renamed.`)\n     * ).catch(console.error)\n     * ```\n     */\n    updateVersion: function updateEnvironmentTemplateVersion({\n      versionName,\n      versionDescription,\n    }: {\n      versionName: string\n      versionDescription: string\n    }) {\n      const raw = this.toPlainObject() as EnvironmentTemplateProps\n      return makeRequest({\n        entityType: 'EnvironmentTemplate',\n        action: 'versionUpdate',\n        params: { organizationId, environmentTemplateId: raw.sys.id, version: raw.sys.version },\n        payload: { versionName, versionDescription },\n      }).then((data) => wrapEnvironmentTemplate(makeRequest, data, organizationId))\n    },\n    /**\n     * Deletes the environment template\n     * @return Promise for the deletion. It contains no data, but the Promise error case should be handled.\n     * @example ```javascript\n     * const contentful = require('contentful-management')\n     *\n     * const client = contentful.createClient({\n     *   accessToken: '<content_management_api_key>'\n     * })\n     *\n     * client.getEnvironmentTemplate('<organization_id>', '<environment_template_id>')\n     *   .then((environmentTemplate) => environmentTemplate.delete())\n     *   .then(() => console.log('Environment template deleted.'))\n     *   .catch(console.error)\n     * ```\n     */\n    delete: function deleteEnvironmentTemplate() {\n      const raw = this.toPlainObject() as EnvironmentTemplateProps\n      return makeRequest({\n        entityType: 'EnvironmentTemplate',\n        action: 'delete',\n        params: { organizationId, environmentTemplateId: raw.sys.id },\n      })\n    },\n    /**\n     * Gets a collection of all versions for the environment template\n     * @return Promise for a EnvironmentTemplate\n     * ```javascript\n     * const contentful = require('contentful-management')\n     *\n     * const client = contentful.createClient({\n     *   accessToken: '<content_management_api_key>'\n     * })\n     * client.getEnvironmentTemplate('<organization_id>', '<environment_template_id>')\n     * .then((environmentTemplate) => environmentTemplate.getVersions())\n     * .then((environmentTemplateVersions) => console.log(environmentTemplateVersions.items))\n     * .catch(console.error)\n     * ```\n     */\n    getVersions: function getEnvironmentTemplateVersions() {\n      const raw = this.toPlainObject() as EnvironmentTemplateProps\n      return makeRequest({\n        entityType: 'EnvironmentTemplate',\n        action: 'versions',\n        params: {\n          organizationId,\n          environmentTemplateId: raw.sys.id,\n        },\n      }).then((data) => wrapEnvironmentTemplateCollection(makeRequest, data, organizationId))\n    },\n    /**\n     * Gets a collection of all installations for the environment template\n     * @param [installationParams.spaceId] - Space ID to filter installations by space and environment\n     * @param [installationParams.environmentId] - Environment ID to filter installations by space and environment\n     * @return Promise for a collection of EnvironmentTemplateInstallations\n     * ```javascript\n     * const contentful = require('contentful-management')\n     *\n     * const client = contentful.createClient({\n     *   accessToken: '<content_management_api_key>'\n     * })\n     *\n     * client.getEnvironmentTemplate('<organization_id>', '<environment_template_id>')\n     * .then((environmentTemplate) => environmentTemplate.getInstallations())\n     * .then((environmentTemplateInstallations) =>\n     *   console.log(environmentTemplateInstallations.items)\n     * )\n     * .catch(console.error)\n     * ```\n     */\n    getInstallations: function getEnvironmentTemplateInstallations({\n      spaceId,\n      environmentId,\n      ...query\n    }: {\n      spaceId?: string\n      environmentId?: string\n    } & BasicCursorPaginationOptions = {}) {\n      const raw = this.toPlainObject() as EnvironmentTemplateProps\n      return makeRequest({\n        entityType: 'EnvironmentTemplateInstallation',\n        action: 'getMany',\n        params: {\n          organizationId,\n          environmentTemplateId: raw.sys.id,\n          query: { ...createRequestConfig({ query }).params },\n          spaceId,\n          environmentId,\n        },\n      }).then((data) => wrapEnvironmentTemplateInstallationCollection(makeRequest, data))\n    },\n    /**\n     * Validates an environment template against a given space and environment\n     * @param params.spaceId - Space ID where the template should be installed into\n     * @param params.environmentId - Environment ID where the template should be installed into\n     * @param [params.version] - Version of the template\n     * @param [params.installation.takeover] - Already existing Content types to takeover in the target environment\n     * @param [params.changeSet] - Change set which should be applied\n     * @return Promise for a EnvironmentTemplateValidation\n     * ```javascript\n     * const contentful = require('contentful-management')\n     *\n     * const client = contentful.createClient({\n     *   accessToken: '<content_management_api_key>'\n     * })\n     *\n     * client.getEnvironmentTemplate('<organization_id>', '<environment_template_id>')\n     * .then((environmentTemplate) => environmentTemplate.validate({\n     *   spaceId: '<space_id>',\n     *   environmentId: '<environment_id>',\n     *   version: <version>,\n     * }))\n     * .then((validationResult) => console.log(validationResult))\n     * .catch(console.error)\n     * ```\n     */\n    validate: function validateEnvironmentTemplate({\n      spaceId,\n      environmentId,\n      version,\n      takeover,\n      changeSet,\n    }: {\n      spaceId: string\n      environmentId: string\n      version?: number\n    } & ValidateEnvironmentTemplateInstallationProps) {\n      const raw: EnvironmentTemplateProps = this.toPlainObject()\n      return makeRequest({\n        entityType: 'EnvironmentTemplate',\n        action: 'validate',\n        params: {\n          spaceId,\n          version,\n          environmentId,\n          environmentTemplateId: raw.sys.id,\n        },\n        payload: {\n          ...(takeover && { takeover }),\n          ...(changeSet && { changeSet }),\n        },\n      })\n    },\n    /**\n     * Installs a template against a given space and environment\n     * @param params.spaceId - Space ID where the template should be installed into\n     * @param params.environmentId - Environment ID where the template should be installed into\n     * @param params.installation.version- Template version which should be installed\n     * @param [params.installation.takeover] - Already existing Content types tp takeover in the target environment\n     * @param [params.changeSet] - Change set which should be applied\n     * @return Promise for a EnvironmentTemplateInstallation\n     * ```javascript\n     * const contentful = require('contentful-management')\n     *\n     * const client = contentful.createClient({\n     *   accessToken: '<content_management_api_key>'\n     * })\n     *\n     * client.getEnvironmentTemplate('<organization_id>', '<environment_template_id>')\n     * .then((environmentTemplate) => environmentTemplate.validate({\n     *   spaceId: '<space_id>',\n     *   environmentId: '<environment_id>',\n     *   installation: {\n     *     version: <version>,\n     *   }\n     * }))\n     * .then((installation) => console.log(installation))\n     * .catch(console.error)\n     * ```\n     */\n    install: function installEnvironmentTemplate({\n      spaceId,\n      environmentId,\n      installation,\n    }: {\n      spaceId: string\n      environmentId: string\n      installation: CreateEnvironmentTemplateInstallationProps\n    }) {\n      const raw: EnvironmentTemplateProps = this.toPlainObject()\n      return makeRequest({\n        entityType: 'EnvironmentTemplate',\n        action: 'install',\n        params: {\n          spaceId,\n          environmentId,\n          environmentTemplateId: raw.sys.id,\n        },\n        payload: installation,\n      })\n    },\n    /**\n     * Disconnects the template from a given environment\n     * @param params.spaceId - Space ID where the template should be installed into\n     * @param params.environmentId - Environment ID where the template should be installed into\n     * @return Promise for the disconnection with no data\n     * ```javascript\n     * const contentful = require('contentful-management')\n     *\n     * const client = contentful.createClient({\n     *   accessToken: '<content_management_api_key>'\n     * })\n     *\n     * client.getEnvironmentTemplate('<organization_id>', '<environment_template_id>')\n     * .then(environmentTemplate) => environmentTemplate.disconnected())\n     * .then(() => console.log('Template disconnected'))\n     * .catch(console.error)\n     * ```\n     */\n    disconnect: function disconnectEnvironmentTemplate({\n      spaceId,\n      environmentId,\n    }: {\n      spaceId: string\n      environmentId: string\n    }) {\n      const raw: EnvironmentTemplateProps = this.toPlainObject()\n      return makeRequest({\n        entityType: 'EnvironmentTemplate',\n        action: 'disconnect',\n        params: {\n          spaceId,\n          environmentId,\n          environmentTemplateId: raw.sys.id,\n        },\n      })\n    },\n  }\n}\n"],"names":["wrapEnvironmentTemplate","wrapEnvironmentTemplateCollection","createRequestConfig","wrapEnvironmentTemplateInstallationCollection"],"mappings":";;;;;;AAegB,SAAA,4BAA4B,CAAC,WAAwB,EAAE,cAAsB,EAAA;IAC3F,OAAO;AACL;;;;;;;;;;;;;;;;;;;AAmBG;QACH,MAAM,EAAE,SAAS,yBAAyB,GAAA;AACxC,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAA8B;AAC5D,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,qBAAqB;AACjC,gBAAA,MAAM,EAAE,QAAQ;gBAChB,MAAM,EAAE,EAAE,cAAc,EAAE,qBAAqB,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE;AAC7D,gBAAA,OAAO,EAAE,GAAG;AACb,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAKA,2CAAuB,CAAC,WAAW,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;SAC9E;AACD;;;;;;;;;;;;;;;;;;;;;;;AAuBG;QACH,aAAa,EAAE,SAAS,gCAAgC,CAAC,EACvD,WAAW,EACX,kBAAkB,GAInB,EAAA;AACC,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAA8B;AAC5D,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,qBAAqB;AACjC,gBAAA,MAAM,EAAE,eAAe;AACvB,gBAAA,MAAM,EAAE,EAAE,cAAc,EAAE,qBAAqB,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE;AACvF,gBAAA,OAAO,EAAE,EAAE,WAAW,EAAE,kBAAkB,EAAE;AAC7C,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAKA,2CAAuB,CAAC,WAAW,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;SAC9E;AACD;;;;;;;;;;;;;;;AAeG;QACH,MAAM,EAAE,SAAS,yBAAyB,GAAA;AACxC,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAA8B;AAC5D,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,qBAAqB;AACjC,gBAAA,MAAM,EAAE,QAAQ;gBAChB,MAAM,EAAE,EAAE,cAAc,EAAE,qBAAqB,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE;AAC9D,aAAA,CAAC;SACH;AACD;;;;;;;;;;;;;;AAcG;QACH,WAAW,EAAE,SAAS,8BAA8B,GAAA;AAClD,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAA8B;AAC5D,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,qBAAqB;AACjC,gBAAA,MAAM,EAAE,UAAU;AAClB,gBAAA,MAAM,EAAE;oBACN,cAAc;AACd,oBAAA,qBAAqB,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE;AAClC,iBAAA;AACF,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAKC,qDAAiC,CAAC,WAAW,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;SACxF;AACD;;;;;;;;;;;;;;;;;;;AAmBG;AACH,QAAA,gBAAgB,EAAE,SAAS,mCAAmC,CAAC,EAC7D,OAAO,EACP,aAAa,EACb,GAAG,KAAK,EAAA,GAIyB,EAAE,EAAA;AACnC,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAA8B;AAC5D,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,iCAAiC;AAC7C,gBAAA,MAAM,EAAE,SAAS;AACjB,gBAAA,MAAM,EAAE;oBACN,cAAc;AACd,oBAAA,qBAAqB,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE;oBACjC,KAAK,EAAE,EAAE,GAAGC,qCAAmB,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;oBACnD,OAAO;oBACP,aAAa;AACd,iBAAA;AACF,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAKC,6EAA6C,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;SACpF;AACD;;;;;;;;;;;;;;;;;;;;;;;;AAwBG;AACH,QAAA,QAAQ,EAAE,SAAS,2BAA2B,CAAC,EAC7C,OAAO,EACP,aAAa,EACb,OAAO,EACP,QAAQ,EACR,SAAS,GAKqC,EAAA;AAC9C,YAAA,MAAM,GAAG,GAA6B,IAAI,CAAC,aAAa,EAAE;AAC1D,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,qBAAqB;AACjC,gBAAA,MAAM,EAAE,UAAU;AAClB,gBAAA,MAAM,EAAE;oBACN,OAAO;oBACP,OAAO;oBACP,aAAa;AACb,oBAAA,qBAAqB,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE;AAClC,iBAAA;AACD,gBAAA,OAAO,EAAE;AACP,oBAAA,IAAI,QAAQ,IAAI,EAAE,QAAQ,EAAE,CAAC;AAC7B,oBAAA,IAAI,SAAS,IAAI,EAAE,SAAS,EAAE,CAAC;AAChC,iBAAA;AACF,aAAA,CAAC;SACH;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BG;QACH,OAAO,EAAE,SAAS,0BAA0B,CAAC,EAC3C,OAAO,EACP,aAAa,EACb,YAAY,GAKb,EAAA;AACC,YAAA,MAAM,GAAG,GAA6B,IAAI,CAAC,aAAa,EAAE;AAC1D,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,qBAAqB;AACjC,gBAAA,MAAM,EAAE,SAAS;AACjB,gBAAA,MAAM,EAAE;oBACN,OAAO;oBACP,aAAa;AACb,oBAAA,qBAAqB,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE;AAClC,iBAAA;AACD,gBAAA,OAAO,EAAE,YAAY;AACtB,aAAA,CAAC;SACH;AACD;;;;;;;;;;;;;;;;;AAiBG;QACH,UAAU,EAAE,SAAS,6BAA6B,CAAC,EACjD,OAAO,EACP,aAAa,GAId,EAAA;AACC,YAAA,MAAM,GAAG,GAA6B,IAAI,CAAC,aAAa,EAAE;AAC1D,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,qBAAqB;AACjC,gBAAA,MAAM,EAAE,YAAY;AACpB,gBAAA,MAAM,EAAE;oBACN,OAAO;oBACP,aAAa;AACb,oBAAA,qBAAqB,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE;AAClC,iBAAA;AACF,aAAA,CAAC;SACH;KACF;AACH;;;;"}