contentful-management 12.0.0-beta.1 → 12.0.0-beta.11

package/dist/cjs/entities/asset-key.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"asset-key.cjs","sources":["../../../lib/entities/asset-key.ts"],"sourcesContent":["import copy from 'fast-copy'\nimport { toPlainObject } from 'contentful-sdk-core'\nimport type { DefaultElements, MakeRequest } from '../common-types.js'\n\nexport type AssetKeyProps = {\n  /** A JWT describing a policy; needs to be attached to signed URLs */\n  policy: string\n  /** A secret key to be used for signing URLs */\n  secret: string\n}\n\nexport type CreateAssetKeyProps = {\n  /** (required) UNIX timestamp in the future (but not more than 48 hours from now) */\n  expiresAt: number\n}\n\nexport interface AssetKey extends AssetKeyProps, DefaultElements<AssetKeyProps> {}\n\n/**\n * @private\n * @param http - HTTP client instance\n * @param data - Raw asset key data\n * @return Wrapped asset key data\n */\nexport function wrapAssetKey(_makeRequest: MakeRequest, data: AssetKeyProps): AssetKey {\n  const assetKey = toPlainObject(copy(data))\n  return assetKey\n}\n"],"names":["toPlainObject"],"mappings":";;;;;AAkBA;;;;;AAKG;AACG,SAAU,YAAY,CAAC,YAAyB,EAAE,IAAmB,EAAA;IACzE,MAAM,QAAQ,GAAGA,+BAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1C,IAAA,OAAO,QAAQ;AACjB;;;;"}

package/dist/cjs/entities/asset.cjs

@@ -0,0 +1,133 @@
+'use strict';
+
+var copy = require('fast-copy');
+var contentfulSdkCore = require('contentful-sdk-core');
+var enhanceWithMethods = require('../enhance-with-methods.cjs');
+var commonUtils = require('../common-utils.cjs');
+var checks = require('../plain/checks.cjs');
+
+/**
+ * @private
+ */
+function createAssetApi(makeRequest) {
+    const getParams = (raw) => {
+        return {
+            spaceId: raw.sys.space.sys.id,
+            environmentId: raw.sys.environment.sys.id,
+            assetId: raw.sys.id,
+        };
+    };
+    return {
+        processForLocale: function processForLocale(locale, options) {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Asset',
+                action: 'processForLocale',
+                params: {
+                    ...getParams(raw),
+                    locale,
+                    options,
+                    asset: raw,
+                },
+            }).then((data) => wrapAsset(makeRequest, data));
+        },
+        processForAllLocales: function processForAllLocales(options) {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Asset',
+                action: 'processForAllLocales',
+                params: {
+                    ...getParams(raw),
+                    asset: raw,
+                    options,
+                },
+            }).then((data) => wrapAsset(makeRequest, data));
+        },
+        update: function update() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Asset',
+                action: 'update',
+                params: getParams(raw),
+                payload: raw,
+                headers: {},
+            }).then((data) => wrapAsset(makeRequest, data));
+        },
+        delete: function del() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Asset',
+                action: 'delete',
+                params: getParams(raw),
+            });
+        },
+        publish: function publish() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Asset',
+                action: 'publish',
+                params: getParams(raw),
+                payload: raw,
+            }).then((data) => wrapAsset(makeRequest, data));
+        },
+        unpublish: function unpublish() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Asset',
+                action: 'unpublish',
+                params: getParams(raw),
+            }).then((data) => wrapAsset(makeRequest, data));
+        },
+        archive: function archive() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Asset',
+                action: 'archive',
+                params: getParams(raw),
+            }).then((data) => wrapAsset(makeRequest, data));
+        },
+        unarchive: function unarchive() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Asset',
+                action: 'unarchive',
+                params: getParams(raw),
+            }).then((data) => wrapAsset(makeRequest, data));
+        },
+        isPublished: function isPublished() {
+            const raw = this.toPlainObject();
+            return checks.isPublished(raw);
+        },
+        isUpdated: function isUpdated() {
+            const raw = this.toPlainObject();
+            return checks.isUpdated(raw);
+        },
+        isDraft: function isDraft() {
+            const raw = this.toPlainObject();
+            return checks.isDraft(raw);
+        },
+        isArchived: function isArchived() {
+            const raw = this.toPlainObject();
+            return checks.isArchived(raw);
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw asset data
+ * @return Wrapped asset data
+ */
+function wrapAsset(makeRequest, data) {
+    const asset = contentfulSdkCore.toPlainObject(copy(data));
+    const assetWithMethods = enhanceWithMethods(asset, createAssetApi(makeRequest));
+    return contentfulSdkCore.freezeSys(assetWithMethods);
+}
+/**
+ * @private
+ */
+const wrapAssetCollection = commonUtils.wrapCollection(wrapAsset);
+
+exports.wrapAsset = wrapAsset;
+exports.wrapAssetCollection = wrapAssetCollection;
+//# sourceMappingURL=asset.cjs.map

package/dist/cjs/entities/asset.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"asset.cjs","sources":["../../../lib/entities/asset.ts"],"sourcesContent":["import copy from 'fast-copy'\nimport { freezeSys, toPlainObject } from 'contentful-sdk-core'\nimport type { Stream } from 'stream'\nimport enhanceWithMethods from '../enhance-with-methods.js'\nimport type {\n  MetaSysProps,\n  DefaultElements,\n  EntityMetaSysProps,\n  MetadataProps,\n  MakeRequest,\n} from '../common-types.js'\nimport { wrapCollection } from '../common-utils.js'\nimport * as checks from '../plain/checks.js'\n\nexport type AssetProps<S = {}> = {\n  sys: EntityMetaSysProps & S\n  fields: {\n    /** Title for this asset */\n    title: { [key: string]: string }\n    /** Description for this asset */\n    description?: { [key: string]: string }\n    /** File object for this asset */\n    file: {\n      [key: string]: {\n        fileName: string\n        contentType: string\n        /** Url where the file is available to be downloaded from, into the Contentful asset system. After the asset is processed this field is gone. */\n        upload?: string\n        /** Url where the file is available at the Contentful media asset system. This field won't be available until the asset is processed. */\n        url?: string\n        /** Details for the file, depending on file type (example: image size in bytes, etc) */\n        details?: Record<string, any>\n        uploadFrom?: Record<string, any>\n      }\n    }\n  }\n  metadata?: MetadataProps\n}\n\nexport type CreateAssetProps = Omit<AssetProps, 'sys'>\n\nexport type CreateAssetFromFilesOptions = { uploadTimeout?: number }\n\nexport interface AssetFileProp {\n  fields: {\n    title: { [key: string]: string }\n    description: { [key: string]: string }\n    file: {\n      [key: string]: {\n        file: string | ArrayBuffer | Stream\n        contentType: string\n        fileName: string\n      }\n    }\n  }\n}\n\nexport interface AssetProcessingForLocale {\n  processingCheckWait?: number\n  processingCheckRetries?: number\n}\n\ntype AssetApi = {\n  /**\n   * Triggers asset processing after an upload, for the files uploaded to all locales of an asset.\n   * @param options - Additional options for processing\n   * @prop options.processingCheckWait - Time in milliseconds to wait before checking again if the asset has been processed (default: 500ms)\n   * @prop options.processingCheckRetries - Maximum amount of times to check if the asset has been processed (default: 5)\n   * @return Object returned from the server with updated metadata.\n   * @throws {AssetProcessingTimeout} If the asset takes too long to process. If this happens, retrieve the asset again, and if the url property is available, then processing has succeeded. If not, your file might be damaged.\n   * @example ```javascript\n   * const contentful = require('contentful-management')\n   *\n   * const client = contentful.createClient({\n   *   accessToken: '<content_management_api_key>'\n   * })\n   * client.getSpace('<space_id>')\n   * .then((space) => space.getEnvironment('<environment_id>'))\n   * .then((environment) => environment.createAssetWithId('<asset_id>', {\n   *   title: {\n   *     'en-US': 'Playsam Streamliner',\n   *     'de-DE': 'Playsam Streamliner'\n   *   },\n   *   file: {\n   *     'en-US': {\n   *       contentType: 'image/jpeg',\n   *       fileName: 'example.jpeg',\n   *       upload: 'https://example.com/example.jpg'\n   *     },\n   *     'de-DE': {\n   *       contentType: 'image/jpeg',\n   *       fileName: 'example.jpeg',\n   *       upload: 'https://example.com/example-de.jpg'\n   *     }\n   *   }\n   * }))\n   * .then((asset) => asset.processForAllLocales())\n   * .then((asset) => console.log(asset))\n   * .catch(console.error)\n   * ```\n   */\n  processForAllLocales(options?: AssetProcessingForLocale): Promise<Asset>\n  /**\n   * Triggers asset processing after an upload, for the file uploaded to a specific locale.\n   * @param locale - Locale which processing should be triggered for\n   * @param options - Additional options for processing\n   * @prop options.processingCheckWait - Time in milliseconds to wait before checking again if the asset has been processed (default: 500ms)\n   * @prop options.processingCheckRetries - Maximum amount of times to check if the asset has been processed (default: 5)\n   * @return Object returned from the server with updated metadata.\n   * @throws {AssetProcessingTimeout} If the asset takes too long to process. If this happens, retrieve the asset again, and if the url property is available, then processing has succeeded. If not, your file might be damaged.\n   * @example ```javascript\n   * const contentful = require('contentful-management')\n   *\n   * const client = contentful.createClient({\n   *   accessToken: '<content_management_api_key>'\n   * })\n   * client.getSpace('<space_id>')\n   * .then((space) => space.getEnvironment('<environment_id>'))\n   * .then((environment) => environment.createAssetWithId('<asset_id>', {\n   *   title: {\n   *     'en-US': 'Playsam Streamliner',\n   *   },\n   *   file: {\n   *     'en-US': {\n   *       contentType: 'image/jpeg',\n   *       fileName: 'example.jpeg',\n   *       upload: 'https://example.com/example.jpg'\n   *     }\n   *   }\n   * }))\n   * .then((asset) => asset.processForLocale('en-US'))\n   * .then((asset) => console.log(asset))\n   * .catch(console.error)\n   * ```\n   */\n  processForLocale(locale: string, Options?: AssetProcessingForLocale): Promise<Asset>\n  /**\n   * Publishes the object\n   * @return Object returned from the server with updated metadata.\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.getSpace('<space_id>')\n   * .then((space) => space.getEnvironment('<environment_id>'))\n   * .then((environment) => environment.getAsset('<asset_id>'))\n   * .then((asset) => asset.publish())\n   * .then((asset) => console.log(`Asset ${asset.sys.id} published.`)\n   * .catch(console.error)\n   * ```\n   */\n  publish(): Promise<Asset>\n  /**\n   * Archives the object\n   * @return Object returned from the server with updated metadata.\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.getSpace('<space_id>')\n   * .then((space) => space.getEnvironment('<environment_id>'))\n   * .then((environment) => environment.getAsset('<asset_id>'))\n   * .then((asset) => asset.archive())\n   * .then((asset) => console.log(`Asset ${asset.sys.id} archived.`)\n   * .catch(console.error)\n   * ```\n   */\n  archive(): Promise<Asset>\n  /**\n   * Deletes this object on the server.\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.getSpace('<space_id>')\n   * .then((space) => space.getEnvironment('<environment_id>'))\n   * .then((environment) => environment.getAsset('<asset_id>'))\n   * .then((asset) => asset.delete())\n   * .then((asset) => console.log(`Asset deleted.`)\n   * .catch(console.error)\n   * ```\n   */\n  delete(): Promise<void>\n  /**\n   * Unarchives the object\n   * @return Object returned from the server with updated metadata.\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.getSpace('<space_id>')\n   * .then((space) => space.getEnvironment('<environment_id>'))\n   * .then((environment) => environment.getAsset('<asset_id>'))\n   * .then((asset) => asset.unarchive())\n   * .then((asset) => console.log(`Asset ${asset.sys.id} unarchived.`)\n   * .catch(console.error)\n   * ```\n   */\n  unarchive(): Promise<Asset>\n  /**\n   * Unpublishes the object\n   * @return Object returned from the server with updated metadata.\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.getSpace('<space_id>')\n   * .then((space) => space.getEnvironment('<environment_id>'))\n   * .then((environment) => environment.getAsset('<asset_id>'))\n   * .then((asset) => asset.unpublish())\n   * .then((asset) => console.log(`Asset ${asset.sys.id} unpublished.`)\n   * .catch(console.error)\n   * ```\n   */\n  unpublish(): Promise<Asset>\n  /**\n   * Sends an update to the server with any changes made to the object's properties\n   * @return Object returned from the server with updated changes.\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.getSpace('<space_id>')\n   * .then((space) => space.getEnvironment('<environment_id>'))\n   * .then((environment) => environment.getAsset('<asset_id>'))\n   * .then((asset) => {\n   *   asset.fields.title['en-US'] = 'New asset title'\n   *   return asset.update()\n   * })\n   * .then((asset) => console.log(`Asset ${asset.sys.id} updated.`)\n   * .catch(console.error)\n   * ```\n   */\n  update(): Promise<Asset>\n  /**\n   * Checks if the asset is published. A published asset might have unpublished changes\n   */\n  isPublished(): boolean\n  /**\n   * Checks if the asset is updated. This means the asset was previously published but has unpublished changes.\n   */\n  isUpdated(): boolean\n  /**\n   * Checks if the asset is in draft mode. This means it is not published.\n   */\n  isDraft(): boolean\n  /**\n   * Checks if asset is archived. This means it's not exposed to the Delivery/Preview APIs.\n   */\n  isArchived(): boolean\n}\n\nexport interface Asset extends AssetProps, DefaultElements<AssetProps>, AssetApi {}\n\n/**\n * @private\n */\nfunction createAssetApi(makeRequest: MakeRequest): AssetApi {\n  const getParams = (raw: AssetProps) => {\n    return {\n      spaceId: raw.sys.space.sys.id,\n      environmentId: raw.sys.environment.sys.id,\n      assetId: raw.sys.id,\n    }\n  }\n\n  return {\n    processForLocale: function processForLocale(\n      locale: string,\n      options?: AssetProcessingForLocale,\n    ) {\n      const raw = this.toPlainObject() as AssetProps\n      return makeRequest({\n        entityType: 'Asset',\n        action: 'processForLocale',\n        params: {\n          ...getParams(raw),\n          locale,\n          options,\n          asset: raw,\n        },\n      }).then((data) => wrapAsset(makeRequest, data))\n    },\n\n    processForAllLocales: function processForAllLocales(options?: AssetProcessingForLocale) {\n      const raw = this.toPlainObject() as AssetProps\n      return makeRequest({\n        entityType: 'Asset',\n        action: 'processForAllLocales',\n        params: {\n          ...getParams(raw),\n          asset: raw,\n          options,\n        },\n      }).then((data) => wrapAsset(makeRequest, data))\n    },\n\n    update: function update() {\n      const raw = this.toPlainObject() as AssetProps\n      return makeRequest({\n        entityType: 'Asset',\n        action: 'update',\n        params: getParams(raw),\n        payload: raw,\n        headers: {},\n      }).then((data) => wrapAsset(makeRequest, data))\n    },\n\n    delete: function del() {\n      const raw = this.toPlainObject() as AssetProps\n      return makeRequest({\n        entityType: 'Asset',\n        action: 'delete',\n        params: getParams(raw),\n      })\n    },\n\n    publish: function publish() {\n      const raw = this.toPlainObject() as AssetProps\n      return makeRequest({\n        entityType: 'Asset',\n        action: 'publish',\n        params: getParams(raw),\n        payload: raw,\n      }).then((data) => wrapAsset(makeRequest, data))\n    },\n\n    unpublish: function unpublish() {\n      const raw = this.toPlainObject() as AssetProps\n      return makeRequest({\n        entityType: 'Asset',\n        action: 'unpublish',\n        params: getParams(raw),\n      }).then((data) => wrapAsset(makeRequest, data))\n    },\n\n    archive: function archive() {\n      const raw = this.toPlainObject() as AssetProps\n      return makeRequest({\n        entityType: 'Asset',\n        action: 'archive',\n        params: getParams(raw),\n      }).then((data) => wrapAsset(makeRequest, data))\n    },\n\n    unarchive: function unarchive() {\n      const raw = this.toPlainObject() as AssetProps\n      return makeRequest({\n        entityType: 'Asset',\n        action: 'unarchive',\n        params: getParams(raw),\n      }).then((data) => wrapAsset(makeRequest, data))\n    },\n\n    isPublished: function isPublished() {\n      const raw = this.toPlainObject() as AssetProps\n      return checks.isPublished(raw)\n    },\n\n    isUpdated: function isUpdated() {\n      const raw = this.toPlainObject() as AssetProps\n      return checks.isUpdated(raw)\n    },\n\n    isDraft: function isDraft() {\n      const raw = this.toPlainObject() as AssetProps\n      return checks.isDraft(raw)\n    },\n\n    isArchived: function isArchived() {\n      const raw = this.toPlainObject() as AssetProps\n      return checks.isArchived(raw)\n    },\n  }\n}\n\n/**\n * @private\n * @param makeRequest - function to make requests via an adapter\n * @param data - Raw asset data\n * @return Wrapped asset data\n */\nexport function wrapAsset(makeRequest: MakeRequest, data: AssetProps): Asset {\n  const asset = toPlainObject(copy(data))\n  const assetWithMethods = enhanceWithMethods(asset, createAssetApi(makeRequest))\n  return freezeSys(assetWithMethods)\n}\n\n/**\n * @private\n */\nexport const wrapAssetCollection = wrapCollection(wrapAsset)\n"],"names":["checks.isPublished","checks.isUpdated","checks.isDraft","checks.isArchived","toPlainObject","freezeSys","wrapCollection"],"mappings":";;;;;;;;AAiRA;;AAEG;AACH,SAAS,cAAc,CAAC,WAAwB,EAAA;AAC9C,IAAA,MAAM,SAAS,GAAG,CAAC,GAAe,KAAI;QACpC,OAAO;YACL,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;YAC7B,aAAa,EAAE,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE;AACzC,YAAA,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE;SACpB;AACH,IAAA,CAAC;IAED,OAAO;AACL,QAAA,gBAAgB,EAAE,SAAS,gBAAgB,CACzC,MAAc,EACd,OAAkC,EAAA;AAElC,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAgB;AAC9C,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,OAAO;AACnB,gBAAA,MAAM,EAAE,kBAAkB;AAC1B,gBAAA,MAAM,EAAE;oBACN,GAAG,SAAS,CAAC,GAAG,CAAC;oBACjB,MAAM;oBACN,OAAO;AACP,oBAAA,KAAK,EAAE,GAAG;AACX,iBAAA;AACF,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACjD,CAAC;AAED,QAAA,oBAAoB,EAAE,SAAS,oBAAoB,CAAC,OAAkC,EAAA;AACpF,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAgB;AAC9C,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,OAAO;AACnB,gBAAA,MAAM,EAAE,sBAAsB;AAC9B,gBAAA,MAAM,EAAE;oBACN,GAAG,SAAS,CAAC,GAAG,CAAC;AACjB,oBAAA,KAAK,EAAE,GAAG;oBACV,OAAO;AACR,iBAAA;AACF,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACjD,CAAC;QAED,MAAM,EAAE,SAAS,MAAM,GAAA;AACrB,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAgB;AAC9C,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,OAAO;AACnB,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC;AACtB,gBAAA,OAAO,EAAE,GAAG;AACZ,gBAAA,OAAO,EAAE,EAAE;AACZ,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACjD,CAAC;QAED,MAAM,EAAE,SAAS,GAAG,GAAA;AAClB,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAgB;AAC9C,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,OAAO;AACnB,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC;AACvB,aAAA,CAAC;QACJ,CAAC;QAED,OAAO,EAAE,SAAS,OAAO,GAAA;AACvB,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAgB;AAC9C,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,OAAO;AACnB,gBAAA,MAAM,EAAE,SAAS;AACjB,gBAAA,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC;AACtB,gBAAA,OAAO,EAAE,GAAG;AACb,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACjD,CAAC;QAED,SAAS,EAAE,SAAS,SAAS,GAAA;AAC3B,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAgB;AAC9C,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,OAAO;AACnB,gBAAA,MAAM,EAAE,WAAW;AACnB,gBAAA,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC;AACvB,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACjD,CAAC;QAED,OAAO,EAAE,SAAS,OAAO,GAAA;AACvB,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAgB;AAC9C,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,OAAO;AACnB,gBAAA,MAAM,EAAE,SAAS;AACjB,gBAAA,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC;AACvB,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACjD,CAAC;QAED,SAAS,EAAE,SAAS,SAAS,GAAA;AAC3B,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAgB;AAC9C,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,OAAO;AACnB,gBAAA,MAAM,EAAE,WAAW;AACnB,gBAAA,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC;AACvB,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACjD,CAAC;QAED,WAAW,EAAE,SAAS,WAAW,GAAA;AAC/B,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAgB;AAC9C,YAAA,OAAOA,kBAAkB,CAAC,GAAG,CAAC;QAChC,CAAC;QAED,SAAS,EAAE,SAAS,SAAS,GAAA;AAC3B,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAgB;AAC9C,YAAA,OAAOC,gBAAgB,CAAC,GAAG,CAAC;QAC9B,CAAC;QAED,OAAO,EAAE,SAAS,OAAO,GAAA;AACvB,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAgB;AAC9C,YAAA,OAAOC,cAAc,CAAC,GAAG,CAAC;QAC5B,CAAC;QAED,UAAU,EAAE,SAAS,UAAU,GAAA;AAC7B,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAgB;AAC9C,YAAA,OAAOC,iBAAiB,CAAC,GAAG,CAAC;QAC/B,CAAC;KACF;AACH;AAEA;;;;;AAKG;AACG,SAAU,SAAS,CAAC,WAAwB,EAAE,IAAgB,EAAA;IAClE,MAAM,KAAK,GAAGC,+BAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,KAAK,EAAE,cAAc,CAAC,WAAW,CAAC,CAAC;AAC/E,IAAA,OAAOC,2BAAS,CAAC,gBAAgB,CAAC;AACpC;AAEA;;AAEG;MACU,mBAAmB,GAAGC,0BAAc,CAAC,SAAS;;;;;"}

package/dist/cjs/entities/bulk-action.cjs

@@ -0,0 +1,61 @@
+'use strict';
+
+var contentfulSdkCore = require('contentful-sdk-core');
+var copy = require('fast-copy');
+var enhanceWithMethods = require('../enhance-with-methods.cjs');
+var action = require('../methods/action.cjs');
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/** Represents the state of the BulkAction */
+exports.BulkActionStatus = void 0;
+(function (BulkActionStatus) {
+    /** BulkAction is pending execution */
+    BulkActionStatus["created"] = "created";
+    /** BulkAction has been started and pending completion */
+    BulkActionStatus["inProgress"] = "inProgress";
+    /** BulkAction was completed successfully (terminal state) */
+    BulkActionStatus["succeeded"] = "succeeded";
+    /** BulkAction failed to complete (terminal state) */
+    BulkActionStatus["failed"] = "failed";
+})(exports.BulkActionStatus || (exports.BulkActionStatus = {}));
+Object.values(exports.BulkActionStatus);
+/**
+ * @private
+ */
+function createBulkActionApi(makeRequest) {
+    const getParams = (self) => {
+        const bulkAction = self.toPlainObject();
+        return {
+            spaceId: bulkAction.sys.space.sys.id,
+            environmentId: bulkAction.sys.environment.sys.id,
+            bulkActionId: bulkAction.sys.id,
+        };
+    };
+    return {
+        async get() {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'BulkAction',
+                action: 'get',
+                params,
+            }).then((bulkAction) => wrapBulkAction(makeRequest, bulkAction));
+        },
+        async waitProcessing(options) {
+            return action.pollAsyncActionStatus(async () => this.get(), options);
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw BulkAction data
+ * @return Wrapped BulkAction data
+ */
+function wrapBulkAction(makeRequest, data) {
+    const bulkAction = contentfulSdkCore.toPlainObject(copy(data));
+    const bulkActionWithApiMethods = enhanceWithMethods(bulkAction, createBulkActionApi(makeRequest));
+    return contentfulSdkCore.freezeSys(bulkActionWithApiMethods);
+}
+
+exports.wrapBulkAction = wrapBulkAction;
+//# sourceMappingURL=bulk-action.cjs.map

package/dist/cjs/entities/bulk-action.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulk-action.cjs","sources":["../../../lib/entities/bulk-action.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { freezeSys, toPlainObject } from 'contentful-sdk-core'\nimport copy from 'fast-copy'\nimport type {\n  DefaultElements,\n  ISO8601Timestamp,\n  Link,\n  MakeRequest,\n  MakeRequestPayload,\n  VersionedLink,\n} from '../common-types.js'\nimport enhanceWithMethods from '../enhance-with-methods.js'\nimport type { AsyncActionProcessingOptions } from '../methods/action.js'\nimport { pollAsyncActionStatus } from '../methods/action.js'\n\n/** Entity types supported by the BulkAction API */\ntype Entity = 'Entry' | 'Asset'\ntype Collection<T> = Array<T>\ntype EntityError = { entity: VersionedLink<Entity> | Link<Entity>; error: any }\n\nexport type BulkActionType = 'publish' | 'unpublish' | 'validate'\n\n/** Represents the state of the BulkAction */\nexport enum BulkActionStatus {\n  /** BulkAction is pending execution */\n  created = 'created',\n  /** BulkAction has been started and pending completion */\n  inProgress = 'inProgress',\n  /** BulkAction was completed successfully (terminal state) */\n  succeeded = 'succeeded',\n  /** BulkAction failed to complete (terminal state) */\n  failed = 'failed',\n}\n\nconst STATUSES = Object.values(BulkActionStatus)\ntype BulkActionStatuses = (typeof STATUSES)[number]\n\ninterface BulkActionFailedError {\n  sys: { type: 'Error'; id: 'BulkActionFailed' }\n  message?: string\n  details?: {\n    errors: Collection<EntityError>\n  }\n}\n\nexport type BulkActionPayload =\n  | BulkActionPublishPayload\n  | BulkActionUnpublishPayload\n  | BulkActionValidatePayload\n\nexport interface BulkActionValidatePayload extends MakeRequestPayload {\n  action?: 'publish'\n  entities: {\n    sys?: { type: 'Array' }\n    items: Collection<Link<Entity>>\n  }\n}\nexport interface BulkActionUnpublishPayload extends MakeRequestPayload {\n  entities: {\n    sys?: { type: 'Array' }\n    items: Collection<Link<Entity>>\n  }\n}\n\nexport interface BulkActionPublishPayload extends MakeRequestPayload {\n  entities: {\n    sys?: { type: 'Array' }\n    items: Collection<VersionedLink<Entity>>\n  }\n}\n\nexport type BulkActionSysProps = {\n  id: string\n  type: 'BulkAction'\n  status: BulkActionStatuses\n  space: Link<'Space'>\n  environment: Link<'Environment'>\n  createdBy: Link<'User'>\n  createdAt: ISO8601Timestamp\n  updatedAt: ISO8601Timestamp\n}\n\n/** The object returned by the BulkActions API */\nexport interface BulkActionProps<TPayload extends BulkActionPayload = any> {\n  sys: BulkActionSysProps\n  action: BulkActionType\n  /** original payload when BulkAction was created */\n  payload: TPayload\n  /** error information, if present */\n  error?: BulkActionFailedError\n}\n\nexport interface BulkActionApiMethods {\n  /** Performs a new GET request and returns the wrapper BulkAction */\n  get(): BulkAction\n  /** Waits until the BulkAction is in one of the final states (`succeeded` or `failed`) and returns it. */\n  waitProcessing(options?: AsyncActionProcessingOptions): Promise<BulkAction>\n}\n\n/**\n * @private\n */\nfunction createBulkActionApi(makeRequest: MakeRequest) {\n  const getParams = (self: BulkAction) => {\n    const bulkAction = self.toPlainObject()\n\n    return {\n      spaceId: bulkAction.sys.space.sys.id,\n      environmentId: bulkAction.sys.environment.sys.id,\n      bulkActionId: bulkAction.sys.id,\n    }\n  }\n\n  return {\n    async get() {\n      const params = getParams(this)\n      return makeRequest({\n        entityType: 'BulkAction',\n        action: 'get',\n        params,\n      }).then((bulkAction) => wrapBulkAction(makeRequest, bulkAction))\n    },\n    async waitProcessing<TPayload extends BulkActionPayload = any>(\n      options?: AsyncActionProcessingOptions,\n    ): Promise<BulkActionProps<TPayload>> {\n      return pollAsyncActionStatus<BulkActionProps<TPayload>>(async () => this.get(), options)\n    },\n  }\n}\n\nexport interface BulkAction<T extends BulkActionPayload = any>\n  extends BulkActionProps<T>,\n    BulkActionApiMethods,\n    DefaultElements<BulkActionProps<T>> {}\n\n/**\n * @private\n * @param makeRequest - function to make requests via an adapter\n * @param data - Raw BulkAction data\n * @return Wrapped BulkAction data\n */\nexport function wrapBulkAction<TPayload extends BulkActionPayload = any>(\n  makeRequest: MakeRequest,\n  data: BulkActionProps<BulkActionPayload>,\n): BulkAction<TPayload> {\n  const bulkAction = toPlainObject(copy(data))\n  const bulkActionWithApiMethods = enhanceWithMethods(\n    bulkAction as any,\n    createBulkActionApi(makeRequest),\n  )\n  return freezeSys(bulkActionWithApiMethods) as BulkAction<TPayload>\n}\n"],"names":["BulkActionStatus","pollAsyncActionStatus","toPlainObject","freezeSys"],"mappings":";;;;;;;AAAA;AAsBA;AACYA;AAAZ,CAAA,UAAY,gBAAgB,EAAA;;AAE1B,IAAA,gBAAA,CAAA,SAAA,CAAA,GAAA,SAAmB;;AAEnB,IAAA,gBAAA,CAAA,YAAA,CAAA,GAAA,YAAyB;;AAEzB,IAAA,gBAAA,CAAA,WAAA,CAAA,GAAA,WAAuB;;AAEvB,IAAA,gBAAA,CAAA,QAAA,CAAA,GAAA,QAAiB;AACnB,CAAC,EATWA,wBAAgB,KAAhBA,wBAAgB,GAAA,EAAA,CAAA,CAAA;AAWX,MAAM,CAAC,MAAM,CAACA,wBAAgB;AAiE/C;;AAEG;AACH,SAAS,mBAAmB,CAAC,WAAwB,EAAA;AACnD,IAAA,MAAM,SAAS,GAAG,CAAC,IAAgB,KAAI;AACrC,QAAA,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE;QAEvC,OAAO;YACL,OAAO,EAAE,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;YACpC,aAAa,EAAE,UAAU,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE;AAChD,YAAA,YAAY,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE;SAChC;AACH,IAAA,CAAC;IAED,OAAO;AACL,QAAA,MAAM,GAAG,GAAA;AACP,YAAA,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC;AAC9B,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,YAAY;AACxB,gBAAA,MAAM,EAAE,KAAK;gBACb,MAAM;AACP,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,KAAK,cAAc,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAClE,CAAC;QACD,MAAM,cAAc,CAClB,OAAsC,EAAA;AAEtC,YAAA,OAAOC,4BAAqB,CAA4B,YAAY,IAAI,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC;QAC1F,CAAC;KACF;AACH;AAOA;;;;;AAKG;AACG,SAAU,cAAc,CAC5B,WAAwB,EACxB,IAAwC,EAAA;IAExC,MAAM,UAAU,GAAGC,+BAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,MAAM,wBAAwB,GAAG,kBAAkB,CACjD,UAAiB,EACjB,mBAAmB,CAAC,WAAW,CAAC,CACjC;AACD,IAAA,OAAOC,2BAAS,CAAC,wBAAwB,CAAyB;AACpE;;;;"}

package/dist/cjs/entities/comment.cjs

@@ -0,0 +1,64 @@
+'use strict';
+
+var contentfulSdkCore = require('contentful-sdk-core');
+var copy = require('fast-copy');
+var commonUtils = require('../common-utils.cjs');
+var enhanceWithMethods = require('../enhance-with-methods.cjs');
+
+// Remove and replace with BLOCKS as soon as rich-text-types supports mentions
+exports.CommentNode = void 0;
+(function (CommentNode) {
+    CommentNode["Document"] = "document";
+    CommentNode["Paragraph"] = "paragraph";
+    CommentNode["Mention"] = "mention";
+})(exports.CommentNode || (exports.CommentNode = {}));
+/**
+ * @private
+ */
+function createCommentApi(makeRequest) {
+    const getParams = (comment) => ({
+        spaceId: comment.sys.space.sys.id,
+        environmentId: comment.sys.environment.sys.id,
+        entryId: comment.sys.parentEntity.sys.id,
+        commentId: comment.sys.id,
+    });
+    return {
+        update: async function () {
+            const raw = this.toPlainObject();
+            const data = await makeRequest({
+                entityType: 'Comment',
+                action: 'update',
+                params: getParams(raw),
+                payload: raw,
+            });
+            return wrapComment(makeRequest, data);
+        },
+        delete: async function () {
+            const raw = this.toPlainObject();
+            await makeRequest({
+                entityType: 'Comment',
+                action: 'delete',
+                params: {
+                    ...getParams(raw),
+                    version: raw.sys.version,
+                },
+            });
+        },
+    };
+}
+/**
+ * @private
+ */
+function wrapComment(makeRequest, data) {
+    const comment = contentfulSdkCore.toPlainObject(copy(data));
+    const commentWithMethods = enhanceWithMethods(comment, createCommentApi(makeRequest));
+    return contentfulSdkCore.freezeSys(commentWithMethods);
+}
+/**
+ * @private
+ */
+const wrapCommentCollection = commonUtils.wrapCollection(wrapComment);
+
+exports.wrapComment = wrapComment;
+exports.wrapCommentCollection = wrapCommentCollection;
+//# sourceMappingURL=comment.cjs.map

package/dist/cjs/entities/comment.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"comment.cjs","sources":["../../../lib/entities/comment.ts"],"sourcesContent":["import { freezeSys, toPlainObject } from 'contentful-sdk-core'\nimport type { Node, Text } from '@contentful/rich-text-types'\nimport copy from 'fast-copy'\nimport type {\n  BasicMetaSysProps,\n  DefaultElements,\n  GetCommentParams,\n  GetEntryParams,\n  GetSpaceEnvironmentParams,\n  Link,\n  MakeRequest,\n  VersionedLink,\n} from '../common-types.js'\nimport { wrapCollection } from '../common-utils.js'\nimport enhanceWithMethods from '../enhance-with-methods.js'\n\n// PROPS //\n\ninterface LinkWithReference<T extends string> extends Link<T> {\n  sys: Link<T>['sys'] & {\n    ref: string\n  }\n}\n\nexport type CommentSysProps = Pick<\n  BasicMetaSysProps,\n  'id' | 'version' | 'createdAt' | 'createdBy' | 'updatedAt' | 'updatedBy'\n> & {\n  type: 'Comment'\n  space: Link<'Space'>\n  environment: Link<'Environment'>\n  parentEntity:\n    | Link<'ContentType'>\n    | LinkWithReference<'ContentType'>\n    | Link<'Entry'>\n    | LinkWithReference<'Entry'>\n    | VersionedLink<'Workflow'>\n  parent: Link<'Comment'> | null\n}\n\nexport type PlainTextBodyProperty = 'plain-text'\nexport type RichTextBodyProperty = 'rich-text'\n\nexport type RichTextBodyFormat = { bodyFormat: RichTextBodyProperty }\nexport type PlainTextBodyFormat = { bodyFormat?: PlainTextBodyProperty }\n\nexport type CommentStatus = 'active' | 'resolved'\n\nexport type CommentProps = {\n  sys: CommentSysProps\n  body: string\n  status: CommentStatus\n}\n\nexport type CreateCommentProps = Omit<CommentProps, 'sys' | 'status'> & { status?: CommentStatus }\nexport type UpdateCommentProps = Omit<CommentProps, 'sys'> & {\n  sys: Pick<CommentSysProps, 'version'>\n}\n\n// Remove and replace with BLOCKS as soon as rich-text-types supports mentions\nexport enum CommentNode {\n  Document = 'document',\n  Paragraph = 'paragraph',\n  Mention = 'mention',\n}\n\n// Add \"extends Block\" as soon as rich-text-types supports mentions\nexport interface Mention {\n  nodeType: CommentNode.Mention\n  data: { target: Link<'User'> | Link<'Team'> }\n  content: Text[]\n}\n\nexport interface RootParagraph extends Node {\n  nodeType: CommentNode.Paragraph\n  content: (Text | Mention)[]\n}\n\n// Add \"extends Document\" as soon as rich-text-types supports mentions.\nexport interface RichTextCommentDocument extends Node {\n  nodeType: CommentNode.Document\n  content: RootParagraph[]\n}\n\nexport type RichTextCommentBodyPayload = { body: RichTextCommentDocument }\n\nexport type RichTextCommentProps = Omit<CommentProps, 'body'> & RichTextCommentBodyPayload\n\n// PARAMS //\n\n// We keep this type as explicit as possible until we open up the comments entity further\nexport type GetCommentParentEntityParams = GetSpaceEnvironmentParams &\n  (\n    | {\n        parentEntityType: 'ContentType'\n        parentEntityId: string\n        parentEntityReference?: string\n      }\n    | {\n        parentEntityType: 'Entry'\n        parentEntityId: string\n        parentEntityReference?: string\n      }\n    | {\n        parentEntityType: 'Workflow'\n        parentEntityId: string\n        parentEntityVersion?: number\n      }\n  )\n\nexport type GetManyCommentsParams = (GetEntryParams | GetCommentParentEntityParams) & {\n  status?: CommentStatus\n}\nexport type CreateCommentParams = (GetEntryParams | GetCommentParentEntityParams) & {\n  parentCommentId?: string\n}\nexport type UpdateCommentParams = GetCommentParams\nexport type DeleteCommentParams = GetCommentParams & {\n  version: number\n}\n\n// NESTED CLIENT //\n\ntype CommentApi = {\n  update(): Promise<Comment | RichTextComment>\n  delete(): Promise<void>\n}\n\nexport interface Comment extends CommentProps, DefaultElements<CommentProps>, CommentApi {}\n\nexport interface RichTextComment\n  extends Omit<CommentProps, 'body'>,\n    RichTextCommentProps,\n    DefaultElements<CommentProps>,\n    CommentApi {}\n\n/**\n * @private\n */\nfunction createCommentApi(makeRequest: MakeRequest): CommentApi {\n  const getParams = (comment: CommentProps): GetCommentParams => ({\n    spaceId: comment.sys.space.sys.id,\n    environmentId: comment.sys.environment.sys.id,\n    entryId: comment.sys.parentEntity.sys.id,\n    commentId: comment.sys.id,\n  })\n\n  return {\n    update: async function () {\n      const raw = this.toPlainObject() as CommentProps\n\n      const data = await makeRequest({\n        entityType: 'Comment',\n        action: 'update',\n        params: getParams(raw),\n        payload: raw,\n      })\n      return wrapComment(makeRequest, data)\n    },\n\n    delete: async function () {\n      const raw = this.toPlainObject() as CommentProps\n\n      await makeRequest({\n        entityType: 'Comment',\n        action: 'delete',\n        params: {\n          ...getParams(raw),\n          version: raw.sys.version,\n        },\n      })\n    },\n  }\n}\n\n/**\n * @private\n */\nexport function wrapComment(\n  makeRequest: MakeRequest,\n  data: CommentProps | RichTextCommentProps,\n): Comment | RichTextComment {\n  const comment = toPlainObject(copy(data))\n  const commentWithMethods = enhanceWithMethods(comment, createCommentApi(makeRequest))\n  return freezeSys(commentWithMethods) as Comment | RichTextComment\n}\n\n/**\n * @private\n */\nexport const wrapCommentCollection = wrapCollection(wrapComment)\n"],"names":["CommentNode","toPlainObject","freezeSys","wrapCollection"],"mappings":";;;;;;;AA2DA;AACYA;AAAZ,CAAA,UAAY,WAAW,EAAA;AACrB,IAAA,WAAA,CAAA,UAAA,CAAA,GAAA,UAAqB;AACrB,IAAA,WAAA,CAAA,WAAA,CAAA,GAAA,WAAuB;AACvB,IAAA,WAAA,CAAA,SAAA,CAAA,GAAA,SAAmB;AACrB,CAAC,EAJWA,mBAAW,KAAXA,mBAAW,GAAA,EAAA,CAAA,CAAA;AA4EvB;;AAEG;AACH,SAAS,gBAAgB,CAAC,WAAwB,EAAA;AAChD,IAAA,MAAM,SAAS,GAAG,CAAC,OAAqB,MAAwB;QAC9D,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;QACjC,aAAa,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE;QAC7C,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE;AACxC,QAAA,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE;AAC1B,KAAA,CAAC;IAEF,OAAO;AACL,QAAA,MAAM,EAAE,kBAAK;AACX,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAkB;AAEhD,YAAA,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC;AAC7B,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC;AACtB,gBAAA,OAAO,EAAE,GAAG;AACb,aAAA,CAAC;AACF,YAAA,OAAO,WAAW,CAAC,WAAW,EAAE,IAAI,CAAC;QACvC,CAAC;AAED,QAAA,MAAM,EAAE,kBAAK;AACX,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAkB;AAEhD,YAAA,MAAM,WAAW,CAAC;AAChB,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE;oBACN,GAAG,SAAS,CAAC,GAAG,CAAC;AACjB,oBAAA,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,OAAO;AACzB,iBAAA;AACF,aAAA,CAAC;QACJ,CAAC;KACF;AACH;AAEA;;AAEG;AACG,SAAU,WAAW,CACzB,WAAwB,EACxB,IAAyC,EAAA;IAEzC,MAAM,OAAO,GAAGC,+BAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,OAAO,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;AACrF,IAAA,OAAOC,2BAAS,CAAC,kBAAkB,CAA8B;AACnE;AAEA;;AAEG;MACU,qBAAqB,GAAGC,0BAAc,CAAC,WAAW;;;;;"}

package/dist/cjs/entities/content-type.cjs

@@ -0,0 +1,121 @@
+'use strict';
+
+var contentfulSdkCore = require('contentful-sdk-core');
+var copy = require('fast-copy');
+var commonUtils = require('../common-utils.cjs');
+var enhanceWithMethods = require('../enhance-with-methods.cjs');
+var checks = require('../plain/checks.cjs');
+var editorInterface = require('./editor-interface.cjs');
+var snapshot = require('./snapshot.cjs');
+var contentType = require('../methods/content-type.cjs');
+
+/**
+ * @private
+ */
+function createContentTypeApi(makeRequest) {
+    const getParams = (self) => {
+        const contentType = self.toPlainObject();
+        return {
+            raw: contentType,
+            params: {
+                spaceId: contentType.sys.space.sys.id,
+                environmentId: contentType.sys.environment.sys.id,
+                contentTypeId: contentType.sys.id,
+            },
+        };
+    };
+    return {
+        update: function () {
+            const { raw, params } = getParams(this);
+            return makeRequest({
+                entityType: 'ContentType',
+                action: 'update',
+                params,
+                payload: raw,
+            }).then((data) => wrapContentType(makeRequest, data));
+        },
+        delete: function () {
+            const { params } = getParams(this);
+            return makeRequest({
+                entityType: 'ContentType',
+                action: 'delete',
+                params,
+            }).then(() => {
+                // noop
+            });
+        },
+        publish: function () {
+            const { raw, params } = getParams(this);
+            return makeRequest({
+                entityType: 'ContentType',
+                action: 'publish',
+                params,
+                payload: raw,
+            }).then((data) => wrapContentType(makeRequest, data));
+        },
+        unpublish: function () {
+            const { params } = getParams(this);
+            return makeRequest({
+                entityType: 'ContentType',
+                action: 'unpublish',
+                params,
+            }).then((data) => wrapContentType(makeRequest, data));
+        },
+        getEditorInterface: function () {
+            const { params } = getParams(this);
+            return makeRequest({
+                entityType: 'EditorInterface',
+                action: 'get',
+                params,
+            }).then((data) => editorInterface.wrapEditorInterface(makeRequest, data));
+        },
+        getSnapshots: function (query = {}) {
+            const { params } = getParams(this);
+            return makeRequest({
+                entityType: 'Snapshot',
+                action: 'getManyForContentType',
+                params: { ...params, query },
+            }).then((data) => snapshot.wrapSnapshotCollection(makeRequest, data));
+        },
+        getSnapshot: function (snapshotId) {
+            const { params } = getParams(this);
+            return makeRequest({
+                entityType: 'Snapshot',
+                action: 'getForContentType',
+                params: { ...params, snapshotId },
+            }).then((data) => snapshot.wrapSnapshot(makeRequest, data));
+        },
+        isPublished: function () {
+            return checks.isPublished(this);
+        },
+        isUpdated: function () {
+            return checks.isUpdated(this);
+        },
+        isDraft: function () {
+            return checks.isDraft(this);
+        },
+        omitAndDeleteField: function (fieldId) {
+            const { raw, params } = getParams(this);
+            return contentType.omitAndDeleteField(makeRequest, { ...params, fieldId }, raw).then((data) => wrapContentType(makeRequest, data));
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw content type data
+ * @return Wrapped content type data
+ */
+function wrapContentType(makeRequest, data) {
+    const contentType = contentfulSdkCore.toPlainObject(copy(data));
+    const contentTypeWithMethods = enhanceWithMethods(contentType, createContentTypeApi(makeRequest));
+    return contentfulSdkCore.freezeSys(contentTypeWithMethods);
+}
+/**
+ * @private
+ */
+const wrapContentTypeCollection = commonUtils.wrapCollection(wrapContentType);
+
+exports.wrapContentType = wrapContentType;
+exports.wrapContentTypeCollection = wrapContentTypeCollection;
+//# sourceMappingURL=content-type.cjs.map

package/dist/cjs/entities/content-type.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-type.cjs","sources":["../../../lib/entities/content-type.ts"],"sourcesContent":["import { freezeSys, toPlainObject } from 'contentful-sdk-core'\nimport copy from 'fast-copy'\nimport type { Except, RequireAtLeastOne, SetOptional } from 'type-fest'\nimport type {\n  BasicMetaSysProps,\n  Collection,\n  DefaultElements,\n  Link,\n  MakeRequest,\n  QueryOptions,\n} from '../common-types.js'\nimport { wrapCollection } from '../common-utils.js'\nimport enhanceWithMethods from '../enhance-with-methods.js'\nimport { isDraft, isPublished, isUpdated } from '../plain/checks.js'\nimport type { ContentFields } from './content-type-fields.js'\nimport type { EditorInterface } from './editor-interface.js'\nimport { wrapEditorInterface } from './editor-interface.js'\nimport type { Snapshot, SnapshotProps } from './snapshot.js'\nimport { wrapSnapshot, wrapSnapshotCollection } from './snapshot.js'\nimport { omitAndDeleteField } from '../methods/content-type.js'\n\ntype TaxonomyConceptValidationLink = Link<'TaxonomyConcept'> & { required?: boolean }\ntype TaxonomyConceptSchemeValidationLink = Link<'TaxonomyConceptScheme'> & { required?: boolean }\n\nexport type ContentTypeMetadata = {\n  annotations?: RequireAtLeastOne<\n    {\n      ContentType?: AnnotationAssignment[]\n      ContentTypeField?: Record<string, AnnotationAssignment[]>\n    },\n    'ContentType' | 'ContentTypeField'\n  >\n  taxonomy?: Array<TaxonomyConceptValidationLink | TaxonomyConceptSchemeValidationLink>\n}\n\nexport type AnnotationAssignment = Link<'Annotation'> & {\n  parameters?: Record<string, string | number | boolean>\n}\n\nexport type ContentTypeProps = {\n  sys: BasicMetaSysProps & {\n    space: Link<'Space'>\n    environment: Link<'Environment'>\n    firstPublishedAt?: string\n    publishedCounter?: number\n    publishedVersion?: number\n  }\n  name: string\n  description: string\n  /** Field used as the main display field for Entries */\n  displayField: string\n  /** All the fields contained in this Content Type */\n  fields: ContentFields[]\n  metadata?: ContentTypeMetadata\n}\n\nexport type CreateContentTypeProps = SetOptional<\n  Except<ContentTypeProps, 'sys'>,\n  'description' | 'displayField'\n>\n\ntype ContentTypeApi = {\n  /**\n   * Sends an update to the server with any changes made to the object's properties. <br />\n   * <strong>Important note about deleting fields</strong>: The standard way to delete a field is with two updates: first omit the property from your responses (set the field attribute \"omitted\" to true), and then\n   * delete it by setting the attribute \"deleted\" to true. See the \"Deleting fields\" section in the\n   * <a href=\"https://www.contentful.com/developers/docs/references/content-management-api/#/reference/content-types/content-type\">API reference</a> for more reasoning. Alternatively,\n   * you may use the convenience method omitAndDeleteField to do both steps at once.\n   * @return Object returned from the server with updated changes.\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.getSpace('<space_id>')\n   * .then((space) => space.getEnvironment('<environment_id>'))\n   * .then((environment) => environment.getContentType('<contentType_id>'))\n   * .then((contentType) => {\n   *  contentType.name = 'New name'\n   *  return contentType.update()\n   * })\n   * .then(contentType => console.log(contentType))\n   * .catch(console.error)\n   * ```\n   */\n  update(): Promise<ContentType>\n\n  /**\n   * Deletes this object on the server.\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.getSpace('<space_id>')\n   * .then((space) => space.getEnvironment('<environment_id>'))\n   * .then((environment) => environment.getContentType('<contentType_id>'))\n   * .then((contentType) => contentType.delete())\n   * .then(() => console.log('contentType deleted'))\n   * .catch(console.error)\n   * ```\n   */\n  delete(): Promise<void>\n  /**\n   * Publishes the object\n   * @return Object returned from the server with updated metadata.\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.getSpace('<space_id>')\n   * .then((space) => space.getEnvironment('<environment_id>'))\n   * .then((environment) => environment.getContentType('<contentType_id>'))\n   * .then((contentType) => contentType.publish())\n   * .then((contentType) => console.log(`${contentType.sys.id} is published`))\n   * .catch(console.error)\n   * ```\n   */\n  publish(): Promise<ContentType>\n  /**\n   * Unpublishes the object\n   * @return Object returned from the server with updated metadata.\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.getSpace('<space_id>')\n   * .then((space) => space.getEnvironment('<environment_id>'))\n   * .then((environment) => environment.getContentType('<contentType_id>'))\n   * .then((contentType) => contentType.unpublish())\n   * .then((contentType) => console.log(`${contentType.sys.id} is unpublished`))\n   * .catch(console.error)\n   * ```\n   */\n  unpublish(): Promise<ContentType>\n  /**\n   * Gets the editor interface for the object <br />\n   * <strong>Important note</strong>: The editor interface only represent a published contentType.<br />\n   * To get the most recent representation of the contentType make sure to publish it first\n   * @return Object returned from the server with the current editor interface.\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.getSpace('<space_id>')\n   * .then((space) => space.getEnvironment('<environment_id>'))\n   * .then((environment) => environment.getContentType('<contentType_id>'))\n   * .then((contentType) => contentType.getEditorInterface())\n   * .then((editorInterface) => console.log(editorInterface.contorls))\n   * .catch(console.error)\n   * ```\n   */\n  getEditorInterface(): Promise<EditorInterface>\n  /**\n   * Checks if the contentType is in draft mode. This means it is not published.\n   */\n  isDraft(): boolean\n  /**\n   * Checks if the contentType is published. A published contentType might have unpublished changes (@see {ContentType.isUpdated})\n   */\n  isPublished(): boolean\n  /**\n   * Checks if the contentType is updated. This means the contentType was previously published but has unpublished changes.\n   */\n  isUpdated(): boolean\n\n  /**\n   * Omits and deletes a field if it exists on the contentType. This is a convenience method which does both operations at once and potentially less\n   * safe than the standard way. See note about deleting fields on the Update method.\n   * @return Object returned from the server with updated metadata.\n   */\n  omitAndDeleteField(id: string): Promise<ContentType>\n\n  /**\n   * Gets a snapshot of a contentType\n   * @param snapshotId - Id of the snapshot\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.getSpace('<space_id>')\n   * .then((space) => space.getEnvironment('<environment_id>'))\n   * .then((environment) => environment.getContentType('<contentType_id>'))\n   * .then((entry) => entry.getSnapshot('<snapshot-id>'))\n   * .then((snapshot) => console.log(snapshot))\n   * .catch(console.error)\n   * ```\n   */\n  getSnapshot(snapshotId: string): Promise<SnapshotProps<ContentTypeProps>>\n  /**\n   * Gets all snapshots of a contentType\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.getSpace('<space_id>')\n   * .then((space) => space.getEnvironment('<environment_id>'))\n   * .then((environment) => environment.getContentType('<contentType_id>'))\n   * .then((entry) => entry.getSnapshots())\n   * .then((snapshots) => console.log(snapshots.items))\n   * .catch(console.error)\n   * ```\n   */\n  getSnapshots(): Promise<Collection<Snapshot<ContentTypeProps>, SnapshotProps<ContentTypeProps>>>\n}\n\nexport interface ContentType\n  extends ContentTypeProps,\n    DefaultElements<ContentTypeProps>,\n    ContentTypeApi {}\n\n/**\n * @private\n */\nfunction createContentTypeApi(makeRequest: MakeRequest): ContentTypeApi {\n  const getParams = (self: ContentType) => {\n    const contentType = self.toPlainObject() as ContentTypeProps\n\n    return {\n      raw: contentType,\n      params: {\n        spaceId: contentType.sys.space.sys.id,\n        environmentId: contentType.sys.environment.sys.id,\n        contentTypeId: contentType.sys.id,\n      },\n    }\n  }\n\n  return {\n    update: function () {\n      const { raw, params } = getParams(this)\n\n      return makeRequest({\n        entityType: 'ContentType',\n        action: 'update',\n        params,\n        payload: raw,\n      }).then((data) => wrapContentType(makeRequest, data))\n    },\n\n    delete: function () {\n      const { params } = getParams(this)\n\n      return makeRequest({\n        entityType: 'ContentType',\n        action: 'delete',\n        params,\n      }).then(() => {\n        // noop\n      })\n    },\n\n    publish: function () {\n      const { raw, params } = getParams(this)\n\n      return makeRequest({\n        entityType: 'ContentType',\n        action: 'publish',\n        params,\n        payload: raw,\n      }).then((data) => wrapContentType(makeRequest, data))\n    },\n\n    unpublish: function () {\n      const { params } = getParams(this)\n\n      return makeRequest({\n        entityType: 'ContentType',\n        action: 'unpublish',\n        params,\n      }).then((data) => wrapContentType(makeRequest, data))\n    },\n\n    getEditorInterface: function () {\n      const { params } = getParams(this)\n\n      return makeRequest({\n        entityType: 'EditorInterface',\n        action: 'get',\n        params,\n      }).then((data) => wrapEditorInterface(makeRequest, data))\n    },\n\n    getSnapshots: function (query: QueryOptions = {}) {\n      const { params } = getParams(this)\n\n      return makeRequest({\n        entityType: 'Snapshot',\n        action: 'getManyForContentType',\n        params: { ...params, query },\n      }).then((data) => wrapSnapshotCollection<ContentTypeProps>(makeRequest, data))\n    },\n\n    getSnapshot: function (snapshotId: string) {\n      const { params } = getParams(this)\n\n      return makeRequest({\n        entityType: 'Snapshot',\n        action: 'getForContentType',\n        params: { ...params, snapshotId },\n      }).then((data) => wrapSnapshot<ContentTypeProps>(makeRequest, data))\n    },\n\n    isPublished: function () {\n      return isPublished(this)\n    },\n\n    isUpdated: function () {\n      return isUpdated(this)\n    },\n\n    isDraft: function () {\n      return isDraft(this)\n    },\n\n    omitAndDeleteField: function (fieldId: string) {\n      const { raw, params } = getParams(this)\n      return omitAndDeleteField(makeRequest, { ...params, fieldId }, raw).then((data) =>\n        wrapContentType(makeRequest, data),\n      )\n    },\n  }\n}\n\n/**\n * @private\n * @param makeRequest - function to make requests via an adapter\n * @param data - Raw content type data\n * @return Wrapped content type data\n */\nexport function wrapContentType(makeRequest: MakeRequest, data: ContentTypeProps): ContentType {\n  const contentType = toPlainObject(copy(data))\n  const contentTypeWithMethods = enhanceWithMethods(contentType, createContentTypeApi(makeRequest))\n  return freezeSys(contentTypeWithMethods)\n}\n\n/**\n * @private\n */\nexport const wrapContentTypeCollection = wrapCollection(wrapContentType)\n"],"names":["wrapEditorInterface","wrapSnapshotCollection","wrapSnapshot","isPublished","isUpdated","isDraft","omitAndDeleteField","toPlainObject","freezeSys","wrapCollection"],"mappings":";;;;;;;;;;;AAuOA;;AAEG;AACH,SAAS,oBAAoB,CAAC,WAAwB,EAAA;AACpD,IAAA,MAAM,SAAS,GAAG,CAAC,IAAiB,KAAI;AACtC,QAAA,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,EAAsB;QAE5D,OAAO;AACL,YAAA,GAAG,EAAE,WAAW;AAChB,YAAA,MAAM,EAAE;gBACN,OAAO,EAAE,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;gBACrC,aAAa,EAAE,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE;AACjD,gBAAA,aAAa,EAAE,WAAW,CAAC,GAAG,CAAC,EAAE;AAClC,aAAA;SACF;AACH,IAAA,CAAC;IAED,OAAO;AACL,QAAA,MAAM,EAAE,YAAA;YACN,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC;AAEvC,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,aAAa;AACzB,gBAAA,MAAM,EAAE,QAAQ;gBAChB,MAAM;AACN,gBAAA,OAAO,EAAE,GAAG;AACb,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,eAAe,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACvD,CAAC;AAED,QAAA,MAAM,EAAE,YAAA;YACN,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC;AAElC,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,aAAa;AACzB,gBAAA,MAAM,EAAE,QAAQ;gBAChB,MAAM;AACP,aAAA,CAAC,CAAC,IAAI,CAAC,MAAK;;AAEb,YAAA,CAAC,CAAC;QACJ,CAAC;AAED,QAAA,OAAO,EAAE,YAAA;YACP,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC;AAEvC,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,aAAa;AACzB,gBAAA,MAAM,EAAE,SAAS;gBACjB,MAAM;AACN,gBAAA,OAAO,EAAE,GAAG;AACb,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,eAAe,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACvD,CAAC;AAED,QAAA,SAAS,EAAE,YAAA;YACT,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC;AAElC,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,aAAa;AACzB,gBAAA,MAAM,EAAE,WAAW;gBACnB,MAAM;AACP,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,eAAe,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACvD,CAAC;AAED,QAAA,kBAAkB,EAAE,YAAA;YAClB,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC;AAElC,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,iBAAiB;AAC7B,gBAAA,MAAM,EAAE,KAAK;gBACb,MAAM;AACP,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAKA,mCAAmB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC3D,CAAC;QAED,YAAY,EAAE,UAAU,KAAA,GAAsB,EAAE,EAAA;YAC9C,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC;AAElC,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,UAAU;AACtB,gBAAA,MAAM,EAAE,uBAAuB;AAC/B,gBAAA,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE;AAC7B,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAKC,+BAAsB,CAAmB,WAAW,EAAE,IAAI,CAAC,CAAC;QAChF,CAAC;QAED,WAAW,EAAE,UAAU,UAAkB,EAAA;YACvC,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC;AAElC,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,UAAU;AACtB,gBAAA,MAAM,EAAE,mBAAmB;AAC3B,gBAAA,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE;AAClC,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAKC,qBAAY,CAAmB,WAAW,EAAE,IAAI,CAAC,CAAC;QACtE,CAAC;AAED,QAAA,WAAW,EAAE,YAAA;AACX,YAAA,OAAOC,kBAAW,CAAC,IAAI,CAAC;QAC1B,CAAC;AAED,QAAA,SAAS,EAAE,YAAA;AACT,YAAA,OAAOC,gBAAS,CAAC,IAAI,CAAC;QACxB,CAAC;AAED,QAAA,OAAO,EAAE,YAAA;AACP,YAAA,OAAOC,cAAO,CAAC,IAAI,CAAC;QACtB,CAAC;QAED,kBAAkB,EAAE,UAAU,OAAe,EAAA;YAC3C,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC;AACvC,YAAA,OAAOC,8BAAkB,CAAC,WAAW,EAAE,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAC5E,eAAe,CAAC,WAAW,EAAE,IAAI,CAAC,CACnC;QACH,CAAC;KACF;AACH;AAEA;;;;;AAKG;AACG,SAAU,eAAe,CAAC,WAAwB,EAAE,IAAsB,EAAA;IAC9E,MAAM,WAAW,GAAGC,+BAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,sBAAsB,GAAG,kBAAkB,CAAC,WAAW,EAAE,oBAAoB,CAAC,WAAW,CAAC,CAAC;AACjG,IAAA,OAAOC,2BAAS,CAAC,sBAAsB,CAAC;AAC1C;AAEA;;AAEG;MACU,yBAAyB,GAAGC,0BAAc,CAAC,eAAe;;;;;"}

package/dist/cjs/entities/editor-interface.cjs

@@ -0,0 +1,51 @@
+'use strict';
+
+var copy = require('fast-copy');
+var contentfulSdkCore = require('contentful-sdk-core');
+var enhanceWithMethods = require('../enhance-with-methods.cjs');
+var commonUtils = require('../common-utils.cjs');
+
+/**
+ * @private
+ */
+function createEditorInterfaceApi(makeRequest) {
+    return {
+        update: function () {
+            const self = this;
+            const raw = self.toPlainObject();
+            return makeRequest({
+                entityType: 'EditorInterface',
+                action: 'update',
+                params: {
+                    spaceId: self.sys.space.sys.id,
+                    environmentId: self.sys.environment.sys.id,
+                    contentTypeId: self.sys.contentType.sys.id,
+                },
+                payload: raw,
+            }).then((response) => wrapEditorInterface(makeRequest, response));
+        },
+        getControlForField: function (fieldId) {
+            const self = this;
+            const result = (self.controls || []).filter((control) => {
+                return control.fieldId === fieldId;
+            });
+            return result && result.length > 0 ? result[0] : null;
+        },
+    };
+}
+/**
+ * @private
+ */
+function wrapEditorInterface(makeRequest, data) {
+    const editorInterface = contentfulSdkCore.toPlainObject(copy(data));
+    const editorInterfaceWithMethods = enhanceWithMethods(editorInterface, createEditorInterfaceApi(makeRequest));
+    return contentfulSdkCore.freezeSys(editorInterfaceWithMethods);
+}
+/**
+ * @private
+ */
+const wrapEditorInterfaceCollection = commonUtils.wrapCollection(wrapEditorInterface);
+
+exports.wrapEditorInterface = wrapEditorInterface;
+exports.wrapEditorInterfaceCollection = wrapEditorInterfaceCollection;
+//# sourceMappingURL=editor-interface.cjs.map

package/dist/cjs/entities/editor-interface.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"editor-interface.cjs","sources":["../../../lib/entities/editor-interface.ts"],"sourcesContent":["import copy from 'fast-copy'\nimport { freezeSys, toPlainObject } from 'contentful-sdk-core'\nimport enhanceWithMethods from '../enhance-with-methods.js'\nimport type { MetaSysProps, DefaultElements, MakeRequest, Link } from '../common-types.js'\nimport { wrapCollection } from '../common-utils.js'\nimport type { DefinedParameters } from './widget-parameters.js'\n\ninterface WidgetConfig {\n  /**\n   * Type of the widget used\n   */\n  widgetNamespace?: string\n  /**\n   * ID of the widget used\n   */\n  widgetId?: string\n  /**\n   * Instance parameter values\n   */\n  settings?: DefinedParameters\n}\n\nexport interface Control extends WidgetConfig {\n  /**\n   * ID of the customized field\n   */\n  fieldId: string\n}\n\nexport interface GroupControl extends WidgetConfig {\n  /**\n   * ID of the customized field group\n   */\n  groupId: string\n}\n\nexport interface FieldGroupItem {\n  groupId: string\n  name: string\n  items: EditorLayoutItem[]\n}\n\nexport interface FieldItem {\n  fieldId: string\n}\n\nexport type EditorLayoutItem = FieldItem | FieldGroupItem\n\nexport interface Editor {\n  /**\n   * Type of the widget used\n   */\n  widgetNamespace: string\n  /**\n   * ID of the widget used\n   */\n  widgetId: string\n  /**\n   * Widget will be enabled if disabled property is missing\n   */\n  disabled?: boolean\n  /**\n   * Instance parameter values\n   */\n  settings?: DefinedParameters\n}\n\nexport interface SidebarItem {\n  /**\n   * Type of the widget used\n   */\n  widgetNamespace: string\n  /**\n   * ID of the widget used\n   */\n  widgetId: string\n  /**\n   * Widget will be enabled if disabled property is missing\n   */\n  disabled?: boolean\n  /**\n   * Instance parameter values\n   */\n  settings?: DefinedParameters\n}\n\nexport type EditorInterfaceProps = {\n  sys: MetaSysProps & {\n    space: Link<'Space'>\n    environment: Link<'Environment'>\n    contentType: Link<'ContentType'>\n  }\n  /**\n   * Array of fields and their associated widgetId\n   */\n  controls?: Control[]\n  /**\n   * Array of field groups and their associated widgetId\n   */\n  groupControls?: GroupControl[]\n  /**\n   * Array of editors. Defaults will be used if property is missing.\n   */\n  editors?: Editor[]\n  /**\n   * Legacy singular editor override\n   */\n  editor?: Editor\n  /**\n   * Array of editor layout field groups\n   */\n  editorLayout?: FieldGroupItem[]\n  /**\n   * Array of sidebar widgets. Defaults will be used if property is missing.\n   */\n  sidebar?: SidebarItem[]\n}\n\nexport interface EditorInterface\n  extends EditorInterfaceProps,\n    DefaultElements<EditorInterfaceProps> {\n  /**\n   * Gets a control for a specific field\n   * @return control object for specific field\n   * ```javascript\n   * const contentful = require('contentful-management')\n   *\n   * const client = contentful.createClient({\n   *   accessToken: '<content_management_api_key>'\n   * })\n   *\n   * client.getSpace('<space_id>')\n   * .then((space) => space.getEnvironment('<environment_id>'))\n   * .then((environment) => environment.getContentType('<contentType_id>'))\n   * .then((contentType) => contentType.getEditorInterface())\n   * .then((editorInterface) => {\n   *  control = editorInterface.getControlForField('<field-id>')\n   *  console.log(control)\n   * })\n   * .catch(console.error)\n   * ```\n   */\n  getControlForField(id: string): null | Control\n  /**\n   * Sends an update to the server with any changes made to the object's properties\n   * @return Object returned from the server with updated changes.\n   * ```javascript\n   * const contentful = require('contentful-management')\n   *\n   * const client = contentful.createClient({\n   *   accessToken: '<content_management_api_key>'\n   * })\n   *\n   * client.getSpace('<space_id>')\n   * .then((space) => space.getEnvironment('<environment_id>'))\n   * .then((environment) => environment.getContentType('<contentType_id>'))\n   * .then((contentType) => contentType.getEditorInterface())\n   * .then((editorInterface) => {\n   *  editorInterface.controls[0] = { \"fieldId\": \"title\", \"widgetId\": \"singleLine\"}\n   *  editorInterface.editors = [\n   *    { \"widgetId\": \"custom-widget\", \"widgetNamespace\": \"app\" }\n   *  ]\n   *  return editorInterface.update()\n   * })\n   * .catch(console.error)\n   * ```\n   */\n  update(): Promise<EditorInterface>\n}\n\n/**\n * @private\n */\nfunction createEditorInterfaceApi(makeRequest: MakeRequest) {\n  return {\n    update: function () {\n      const self = this as EditorInterface\n      const raw = self.toPlainObject()\n      return makeRequest({\n        entityType: 'EditorInterface',\n        action: 'update',\n        params: {\n          spaceId: self.sys.space.sys.id,\n          environmentId: self.sys.environment.sys.id,\n          contentTypeId: self.sys.contentType.sys.id,\n        },\n        payload: raw,\n      }).then((response) => wrapEditorInterface(makeRequest, response))\n    },\n\n    getControlForField: function (fieldId: string) {\n      const self = this as EditorInterface\n      const result = (self.controls || []).filter((control) => {\n        return control.fieldId === fieldId\n      })\n      return result && result.length > 0 ? result[0] : null\n    },\n  }\n}\n\n/**\n * @private\n */\nexport function wrapEditorInterface(\n  makeRequest: MakeRequest,\n  data: EditorInterfaceProps,\n): EditorInterface {\n  const editorInterface = toPlainObject(copy(data))\n  const editorInterfaceWithMethods = enhanceWithMethods(\n    editorInterface,\n    createEditorInterfaceApi(makeRequest),\n  )\n  return freezeSys(editorInterfaceWithMethods)\n}\n\n/**\n * @private\n */\nexport const wrapEditorInterfaceCollection = wrapCollection(wrapEditorInterface)\n"],"names":["toPlainObject","freezeSys","wrapCollection"],"mappings":";;;;;;;AA0KA;;AAEG;AACH,SAAS,wBAAwB,CAAC,WAAwB,EAAA;IACxD,OAAO;AACL,QAAA,MAAM,EAAE,YAAA;YACN,MAAM,IAAI,GAAG,IAAuB;AACpC,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAE;AAChC,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,iBAAiB;AAC7B,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE;oBACN,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;oBAC9B,aAAa,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE;oBAC1C,aAAa,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE;AAC3C,iBAAA;AACD,gBAAA,OAAO,EAAE,GAAG;AACb,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,KAAK,mBAAmB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QACnE,CAAC;QAED,kBAAkB,EAAE,UAAU,OAAe,EAAA;YAC3C,MAAM,IAAI,GAAG,IAAuB;AACpC,YAAA,MAAM,MAAM,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,EAAE,MAAM,CAAC,CAAC,OAAO,KAAI;AACtD,gBAAA,OAAO,OAAO,CAAC,OAAO,KAAK,OAAO;AACpC,YAAA,CAAC,CAAC;AACF,YAAA,OAAO,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI;QACvD,CAAC;KACF;AACH;AAEA;;AAEG;AACG,SAAU,mBAAmB,CACjC,WAAwB,EACxB,IAA0B,EAAA;IAE1B,MAAM,eAAe,GAAGA,+BAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjD,MAAM,0BAA0B,GAAG,kBAAkB,CACnD,eAAe,EACf,wBAAwB,CAAC,WAAW,CAAC,CACtC;AACD,IAAA,OAAOC,2BAAS,CAAC,0BAA0B,CAAC;AAC9C;AAEA;;AAEG;MACU,6BAA6B,GAAGC,0BAAc,CAAC,mBAAmB;;;;;"}

package/dist/cjs/entities/entry.cjs

@@ -0,0 +1,28 @@
+'use strict';
+
+var contentfulSdkCore = require('contentful-sdk-core');
+var copy = require('fast-copy');
+var commonUtils = require('../common-utils.cjs');
+var createEntryApi = require('../create-entry-api.cjs');
+var enhanceWithMethods = require('../enhance-with-methods.cjs');
+
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw entry data
+ * @return Wrapped entry data
+ */
+function wrapEntry(makeRequest, data) {
+    const entry = contentfulSdkCore.toPlainObject(copy(data));
+    const entryWithMethods = enhanceWithMethods(entry, createEntryApi(makeRequest));
+    return contentfulSdkCore.freezeSys(entryWithMethods);
+}
+/**
+ * Data is also mixed in with link getters if links exist and includes were requested
+ * @private
+ */
+const wrapEntryCollection = commonUtils.wrapCollection(wrapEntry);
+
+exports.wrapEntry = wrapEntry;
+exports.wrapEntryCollection = wrapEntryCollection;
+//# sourceMappingURL=entry.cjs.map

package/dist/cjs/entities/entry.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"entry.cjs","sources":["../../../lib/entities/entry.ts"],"sourcesContent":["import { freezeSys, toPlainObject } from 'contentful-sdk-core'\nimport copy from 'fast-copy'\nimport type {\n  CollectionProp,\n  DefaultElements,\n  EntityMetaSysProps,\n  KeyValueMap,\n  Link,\n  MakeRequest,\n  MetadataProps,\n} from '../common-types.js'\nimport { wrapCollection } from '../common-utils.js'\nimport type { ContentfulEntryApi } from '../create-entry-api.js'\nimport createEntryApi from '../create-entry-api.js'\nimport enhanceWithMethods from '../enhance-with-methods.js'\nimport type { AssetProps } from './asset.js'\n\nexport interface EntryMetaSysProps extends EntityMetaSysProps {\n  contentType: Link<'ContentType'>\n  automationTags: Link<'Tag'>[]\n}\n\nexport type EntryProps<T = KeyValueMap, S = unknown> = {\n  sys: EntryMetaSysProps & S\n  metadata?: MetadataProps\n  fields: T\n}\n\nexport type CreateEntryProps<TFields = KeyValueMap> = Omit<EntryProps<TFields>, 'sys'>\n\nexport type EntryReferenceError = {\n  sys: {\n    type: 'error'\n    id: 'notResolvable'\n  }\n  details: {\n    type: 'Link'\n    linkType: 'Entry' | 'Asset'\n    id: string\n  }\n}\n\nexport interface EntryReferenceProps extends CollectionProp<EntryProps> {\n  includes?: {\n    Entry?: EntryProps[]\n    Asset?: AssetProps[]\n  }\n  errors?: EntryReferenceError[]\n}\n\nexport type EntryReferenceOptionsProps = {\n  include?: number\n}\n\nexport interface Entry extends EntryProps, DefaultElements<EntryProps>, ContentfulEntryApi {}\n\nexport type WithResourceName<T extends { sys: unknown }> = T extends { sys: infer Sys }\n  ? Omit<T, 'sys'> & {\n      sys: Sys & { urn: string }\n    }\n  : never\n\n/**\n * @private\n * @param makeRequest - function to make requests via an adapter\n * @param data - Raw entry data\n * @return Wrapped entry data\n */\nexport function wrapEntry(makeRequest: MakeRequest, data: EntryProps): Entry {\n  const entry = toPlainObject(copy(data))\n  const entryWithMethods = enhanceWithMethods(entry, createEntryApi(makeRequest))\n  return freezeSys(entryWithMethods)\n}\n\n/**\n * Data is also mixed in with link getters if links exist and includes were requested\n * @private\n */\nexport const wrapEntryCollection = wrapCollection(wrapEntry)\n"],"names":["toPlainObject","freezeSys","wrapCollection"],"mappings":";;;;;;;;AA8DA;;;;;AAKG;AACG,SAAU,SAAS,CAAC,WAAwB,EAAE,IAAgB,EAAA;IAClE,MAAM,KAAK,GAAGA,+BAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,KAAK,EAAE,cAAc,CAAC,WAAW,CAAC,CAAC;AAC/E,IAAA,OAAOC,2BAAS,CAAC,gBAAgB,CAAC;AACpC;AAEA;;;AAGG;MACU,mBAAmB,GAAGC,0BAAc,CAAC,SAAS;;;;;"}