contentful-management 11.63.1 → 11.64.0-new-beta.1

package/dist/types/entities/content-type.d.ts

@@ -0,0 +1,213 @@
+import type { Except, RequireAtLeastOne, SetOptional } from 'type-fest';
+import type { BasicMetaSysProps, Collection, DefaultElements, Link, MakeRequest, SysLink } from '../common-types';
+import type { ContentFields } from './content-type-fields';
+import type { EditorInterface } from './editor-interface';
+import type { Snapshot, SnapshotProps } from './snapshot';
+type TaxonomyConceptValidationLink = Link<'TaxonomyConcept'> & {
+    required?: boolean;
+};
+type TaxonomyConceptSchemeValidationLink = Link<'TaxonomyConceptScheme'> & {
+    required?: boolean;
+};
+export type ContentTypeMetadata = {
+    annotations?: RequireAtLeastOne<{
+        ContentType?: AnnotationAssignment[];
+        ContentTypeField?: Record<string, AnnotationAssignment[]>;
+    }, 'ContentType' | 'ContentTypeField'>;
+    taxonomy?: Array<TaxonomyConceptValidationLink | TaxonomyConceptSchemeValidationLink>;
+};
+export type AnnotationAssignment = Link<'Annotation'> & {
+    parameters?: Record<string, string | number | boolean>;
+};
+export type ContentTypeProps = {
+    sys: BasicMetaSysProps & {
+        space: SysLink;
+        environment: SysLink;
+        firstPublishedAt?: string;
+        publishedCounter?: number;
+        publishedVersion?: number;
+    };
+    name: string;
+    description: string;
+    /** Field used as the main display field for Entries */
+    displayField: string;
+    /** All the fields contained in this Content Type */
+    fields: ContentFields[];
+    metadata?: ContentTypeMetadata;
+};
+export type CreateContentTypeProps = SetOptional<Except<ContentTypeProps, 'sys'>, 'description' | 'displayField'>;
+type ContentTypeApi = {
+    /**
+     * Sends an update to the server with any changes made to the object's properties. <br />
+     * <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
+     * delete it by setting the attribute "deleted" to true. See the "Deleting fields" section in the
+     * <a href="https://www.contentful.com/developers/docs/references/content-management-api/#/reference/content-types/content-type">API reference</a> for more reasoning. Alternatively,
+     * you may use the convenience method omitAndDeleteField to do both steps at once.
+     * @return Object returned from the server with updated changes.
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getContentType('<contentType_id>'))
+     * .then((contentType) => {
+     *  contentType.name = 'New name'
+     *  return contentType.update()
+     * })
+     * .then(contentType => console.log(contentType))
+     * .catch(console.error)
+     * ```
+     */
+    update(): Promise<ContentType>;
+    /**
+     * Deletes this object on the server.
+     * @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getContentType('<contentType_id>'))
+     * .then((contentType) => contentType.delete())
+     * .then(() => console.log('contentType deleted'))
+     * .catch(console.error)
+     * ```
+     */
+    delete(): Promise<void>;
+    /**
+     * Publishes the object
+     * @return Object returned from the server with updated metadata.
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getContentType('<contentType_id>'))
+     * .then((contentType) => contentType.publish())
+     * .then((contentType) => console.log(`${contentType.sys.id} is published`))
+     * .catch(console.error)
+     * ```
+     */
+    publish(): Promise<ContentType>;
+    /**
+     * Unpublishes the object
+     * @return Object returned from the server with updated metadata.
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getContentType('<contentType_id>'))
+     * .then((contentType) => contentType.unpublish())
+     * .then((contentType) => console.log(`${contentType.sys.id} is unpublished`))
+     * .catch(console.error)
+     * ```
+     */
+    unpublish(): Promise<ContentType>;
+    /**
+     * Gets the editor interface for the object <br />
+     * <strong>Important note</strong>: The editor interface only represent a published contentType.<br />
+     * To get the most recent representation of the contentType make sure to publish it first
+     * @return Object returned from the server with the current editor interface.
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getContentType('<contentType_id>'))
+     * .then((contentType) => contentType.getEditorInterface())
+     * .then((editorInterface) => console.log(editorInterface.contorls))
+     * .catch(console.error)
+     * ```
+     */
+    getEditorInterface(): Promise<EditorInterface>;
+    /**
+     * Checks if the contentType is in draft mode. This means it is not published.
+     */
+    isDraft(): boolean;
+    /**
+     * Checks if the contentType is published. A published contentType might have unpublished changes (@see {ContentType.isUpdated})
+     */
+    isPublished(): boolean;
+    /**
+     * Checks if the contentType is updated. This means the contentType was previously published but has unpublished changes.
+     */
+    isUpdated(): boolean;
+    /**
+     * 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
+     * safe than the standard way. See note about deleting fields on the Update method.
+     * @return Object returned from the server with updated metadata.
+     */
+    omitAndDeleteField(id: string): Promise<ContentType>;
+    /**
+     * Gets a snapshot of a contentType
+     * @param snapshotId - Id of the snapshot
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getContentType('<contentType_id>'))
+     * .then((entry) => entry.getSnapshot('<snapshot-id>'))
+     * .then((snapshot) => console.log(snapshot))
+     * .catch(console.error)
+     * ```
+     */
+    getSnapshot(snapshotId: string): Promise<SnapshotProps<ContentTypeProps>>;
+    /**
+     * Gets all snapshots of a contentType
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getContentType('<contentType_id>'))
+     * .then((entry) => entry.getSnapshots())
+     * .then((snapshots) => console.log(snapshots.items))
+     * .catch(console.error)
+     * ```
+     */
+    getSnapshots(): Promise<Collection<Snapshot<ContentTypeProps>, SnapshotProps<ContentTypeProps>>>;
+};
+export interface ContentType extends ContentTypeProps, DefaultElements<ContentTypeProps>, ContentTypeApi {
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw content type data
+ * @return Wrapped content type data
+ */
+export declare function wrapContentType(makeRequest: MakeRequest, data: ContentTypeProps): ContentType;
+/**
+ * @private
+ */
+export declare const wrapContentTypeCollection: (makeRequest: MakeRequest, data: import("..").CollectionProp<ContentTypeProps>) => Collection<ContentType, ContentTypeProps>;
+export {};

package/dist/types/entities/content-type.js

@@ -0,0 +1,118 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils.js';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import { isDraft, isUpdated, isPublished } from '../plain/checks.js';
+import { wrapEditorInterface } from './editor-interface.js';
+import { wrapSnapshot, wrapSnapshotCollection } from './snapshot.js';
+import { omitAndDeleteField } from '../methods/content-type.js';
+
+/**
+ * @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) => wrapEditorInterface(makeRequest, data));
+        },
+        getSnapshots: function (query = {}) {
+            const { params } = getParams(this);
+            return makeRequest({
+                entityType: 'Snapshot',
+                action: 'getManyForContentType',
+                params: { ...params, query },
+            }).then((data) => wrapSnapshotCollection(makeRequest, data));
+        },
+        getSnapshot: function (snapshotId) {
+            const { params } = getParams(this);
+            return makeRequest({
+                entityType: 'Snapshot',
+                action: 'getForContentType',
+                params: { ...params, snapshotId },
+            }).then((data) => wrapSnapshot(makeRequest, data));
+        },
+        isPublished: function () {
+            return isPublished(this);
+        },
+        isUpdated: function () {
+            return isUpdated(this);
+        },
+        isDraft: function () {
+            return isDraft(this);
+        },
+        omitAndDeleteField: function (fieldId) {
+            const { raw, params } = getParams(this);
+            return 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 = toPlainObject(copy(data));
+    const contentTypeWithMethods = enhanceWithMethods(contentType, createContentTypeApi(makeRequest));
+    return freezeSys(contentTypeWithMethods);
+}
+/**
+ * @private
+ */
+const wrapContentTypeCollection = wrapCollection(wrapContentType);
+
+export { wrapContentType, wrapContentTypeCollection };
+//# sourceMappingURL=content-type.js.map

package/dist/types/entities/content-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-type.js","sources":["../../../lib/entities/content-type.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;;;AAwOA;;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,KAAK,mBAAmB,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,KAAK,sBAAsB,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,KAAK,YAAY,CAAmB,WAAW,EAAE,IAAI,CAAC,CAAC;QACtE,CAAC;AAED,QAAA,WAAW,EAAE,YAAA;AACX,YAAA,OAAO,WAAW,CAAC,IAAI,CAAC;QAC1B,CAAC;AAED,QAAA,SAAS,EAAE,YAAA;AACT,YAAA,OAAO,SAAS,CAAC,IAAI,CAAC;QACxB,CAAC;AAED,QAAA,OAAO,EAAE,YAAA;AACP,YAAA,OAAO,OAAO,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,OAAO,kBAAkB,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,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,sBAAsB,GAAG,kBAAkB,CAAC,WAAW,EAAE,oBAAoB,CAAC,WAAW,CAAC,CAAC;AACjG,IAAA,OAAO,SAAS,CAAC,sBAAsB,CAAC;AAC1C;AAEA;;AAEG;MACU,yBAAyB,GAAG,cAAc,CAAC,eAAe;;;;"}

package/dist/types/entities/editor-interface.d.ts

@@ -0,0 +1,168 @@
+import type { MetaSysProps, MetaLinkProps, DefaultElements, MakeRequest } from '../common-types';
+import type { DefinedParameters } from './widget-parameters';
+interface WidgetConfig {
+    /**
+     * Type of the widget used
+     */
+    widgetNamespace?: string;
+    /**
+     * ID of the widget used
+     */
+    widgetId?: string;
+    /**
+     * Instance parameter values
+     */
+    settings?: DefinedParameters;
+}
+export interface Control extends WidgetConfig {
+    /**
+     * ID of the customized field
+     */
+    fieldId: string;
+}
+export interface GroupControl extends WidgetConfig {
+    /**
+     * ID of the customized field group
+     */
+    groupId: string;
+}
+export interface FieldGroupItem {
+    groupId: string;
+    name: string;
+    items: EditorLayoutItem[];
+}
+export interface FieldItem {
+    fieldId: string;
+}
+export type EditorLayoutItem = FieldItem | FieldGroupItem;
+export interface Editor {
+    /**
+     * Type of the widget used
+     */
+    widgetNamespace: string;
+    /**
+     * ID of the widget used
+     */
+    widgetId: string;
+    /**
+     * Widget will be enabled if disabled property is missing
+     */
+    disabled?: boolean;
+    /**
+     * Instance parameter values
+     */
+    settings?: DefinedParameters;
+}
+export interface SidebarItem {
+    /**
+     * Type of the widget used
+     */
+    widgetNamespace: string;
+    /**
+     * ID of the widget used
+     */
+    widgetId: string;
+    /**
+     * Widget will be enabled if disabled property is missing
+     */
+    disabled?: boolean;
+    /**
+     * Instance parameter values
+     */
+    settings?: DefinedParameters;
+}
+export type EditorInterfaceProps = {
+    sys: MetaSysProps & {
+        space: {
+            sys: MetaLinkProps;
+        };
+        environment: {
+            sys: MetaLinkProps;
+        };
+        contentType: {
+            sys: MetaLinkProps;
+        };
+    };
+    /**
+     * Array of fields and their associated widgetId
+     */
+    controls?: Control[];
+    /**
+     * Array of field groups and their associated widgetId
+     */
+    groupControls?: GroupControl[];
+    /**
+     * Array of editors. Defaults will be used if property is missing.
+     */
+    editors?: Editor[];
+    /**
+     * Legacy singular editor override
+     */
+    editor?: Editor;
+    /**
+     * Array of editor layout field groups
+     */
+    editorLayout?: FieldGroupItem[];
+    /**
+     * Array of sidebar widgets. Defaults will be used if property is missing.
+     */
+    sidebar?: SidebarItem[];
+};
+export interface EditorInterface extends EditorInterfaceProps, DefaultElements<EditorInterfaceProps> {
+    /**
+     * Gets a control for a specific field
+     * @return control object for specific field
+     * ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getContentType('<contentType_id>'))
+     * .then((contentType) => contentType.getEditorInterface())
+     * .then((editorInterface) => {
+     *  control = editorInterface.getControlForField('<field-id>')
+     *  console.log(control)
+     * })
+     * .catch(console.error)
+     * ```
+     */
+    getControlForField(id: string): null | Control;
+    /**
+     * Sends an update to the server with any changes made to the object's properties
+     * @return Object returned from the server with updated changes.
+     * ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getContentType('<contentType_id>'))
+     * .then((contentType) => contentType.getEditorInterface())
+     * .then((editorInterface) => {
+     *  editorInterface.controls[0] = { "fieldId": "title", "widgetId": "singleLine"}
+     *  editorInterface.editors = [
+     *    { "widgetId": "custom-widget", "widgetNamespace": "app" }
+     *  ]
+     *  return editorInterface.update()
+     * })
+     * .catch(console.error)
+     * ```
+     */
+    update(): Promise<EditorInterface>;
+}
+/**
+ * @private
+ */
+export declare function wrapEditorInterface(makeRequest: MakeRequest, data: EditorInterfaceProps): EditorInterface;
+/**
+ * @private
+ */
+export declare const wrapEditorInterfaceCollection: (makeRequest: MakeRequest, data: import("..").CollectionProp<EditorInterfaceProps>) => import("..").Collection<EditorInterface, EditorInterfaceProps>;
+export {};

package/dist/types/entities/editor-interface.js

@@ -0,0 +1,48 @@
+import copy from 'fast-copy';
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import { wrapCollection } from '../common-utils.js';
+
+/**
+ * @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 = toPlainObject(copy(data));
+    const editorInterfaceWithMethods = enhanceWithMethods(editorInterface, createEditorInterfaceApi(makeRequest));
+    return freezeSys(editorInterfaceWithMethods);
+}
+/**
+ * @private
+ */
+const wrapEditorInterfaceCollection = wrapCollection(wrapEditorInterface);
+
+export { wrapEditorInterface, wrapEditorInterfaceCollection };
+//# sourceMappingURL=editor-interface.js.map

package/dist/types/entities/editor-interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"editor-interface.js","sources":["../../../lib/entities/editor-interface.ts"],"sourcesContent":[null],"names":[],"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,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjD,MAAM,0BAA0B,GAAG,kBAAkB,CACnD,eAAe,EACf,wBAAwB,CAAC,WAAW,CAAC,CACtC;AACD,IAAA,OAAO,SAAS,CAAC,0BAA0B,CAAC;AAC9C;AAEA;;AAEG;MACU,6BAA6B,GAAG,cAAc,CAAC,mBAAmB;;;;"}

package/dist/types/entities/entry.d.ts

@@ -0,0 +1,53 @@
+import type { CollectionProp, DefaultElements, EntryMetaSysProps, KeyValueMap, MakeRequest, MetadataProps } from '../common-types';
+import type { ContentfulEntryApi } from '../create-entry-api';
+import type { AssetProps } from './asset';
+export type EntryProps<T = KeyValueMap, S = unknown> = {
+    sys: EntryMetaSysProps & S;
+    metadata?: MetadataProps;
+    fields: T;
+};
+export type CreateEntryProps<TFields = KeyValueMap> = Omit<EntryProps<TFields>, 'sys'>;
+export type EntryReferenceError = {
+    sys: {
+        type: 'error';
+        id: 'notResolvable';
+    };
+    details: {
+        type: 'Link';
+        linkType: 'Entry' | 'Asset';
+        id: string;
+    };
+};
+export interface EntryReferenceProps extends CollectionProp<EntryProps> {
+    includes?: {
+        Entry?: EntryProps[];
+        Asset?: AssetProps[];
+    };
+    errors?: EntryReferenceError[];
+}
+export type EntryReferenceOptionsProps = {
+    include?: number;
+};
+export interface Entry extends EntryProps, DefaultElements<EntryProps>, ContentfulEntryApi {
+}
+export type WithResourceName<T extends {
+    sys: unknown;
+}> = T extends {
+    sys: infer Sys;
+} ? Omit<T, 'sys'> & {
+    sys: Sys & {
+        urn: string;
+    };
+} : never;
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw entry data
+ * @return Wrapped entry data
+ */
+export declare function wrapEntry(makeRequest: MakeRequest, data: EntryProps): Entry;
+/**
+ * Data is also mixed in with link getters if links exist and includes were requested
+ * @private
+ */
+export declare const wrapEntryCollection: (makeRequest: MakeRequest, data: CollectionProp<EntryProps<KeyValueMap, unknown>>) => import("..").Collection<Entry, EntryProps<KeyValueMap, unknown>>;

package/dist/types/entities/entry.js

@@ -0,0 +1,25 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils.js';
+import createEntryApi from '../create-entry-api.js';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+/**
+ * @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 = toPlainObject(copy(data));
+    const entryWithMethods = enhanceWithMethods(entry, createEntryApi(makeRequest));
+    return freezeSys(entryWithMethods);
+}
+/**
+ * Data is also mixed in with link getters if links exist and includes were requested
+ * @private
+ */
+const wrapEntryCollection = wrapCollection(wrapEntry);
+
+export { wrapEntry, wrapEntryCollection };
+//# sourceMappingURL=entry.js.map

package/dist/types/entities/entry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entry.js","sources":["../../../lib/entities/entry.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;AAwDA;;;;;AAKG;AACG,SAAU,SAAS,CAAC,WAAwB,EAAE,IAAgB,EAAA;IAClE,MAAM,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,KAAK,EAAE,cAAc,CAAC,WAAW,CAAC,CAAC;AAC/E,IAAA,OAAO,SAAS,CAAC,gBAAgB,CAAC;AACpC;AAEA;;;AAGG;MACU,mBAAmB,GAAG,cAAc,CAAC,SAAS;;;;"}