contentful-management 12.0.0-new-beta.3 → 12.0.0-new-beta.4

package/dist/types/entities/release.js

@@ -0,0 +1,107 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import '../common-types.js';
+import { wrapCursorPaginatedCollection } from '../common-utils.js';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import { wrapReleaseAction } from './release-action.js';
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * @private
+ */
+function createReleaseApi(makeRequest) {
+    const getParams = (self) => {
+        const release = self.toPlainObject();
+        return {
+            spaceId: release.sys.space.sys.id,
+            environmentId: release.sys.environment.sys.id,
+            releaseId: release.sys.id,
+            version: release.sys.version,
+        };
+    };
+    return {
+        async archive() {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'Release',
+                action: 'archive',
+                params,
+            }).then((release) => wrapRelease(makeRequest, release));
+        },
+        async unarchive() {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'Release',
+                action: 'unarchive',
+                params,
+            }).then((release) => wrapRelease(makeRequest, release));
+        },
+        async update(payload) {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'Release',
+                action: 'update',
+                params,
+                payload,
+            }).then((release) => wrapRelease(makeRequest, release));
+        },
+        async delete() {
+            const params = getParams(this);
+            await makeRequest({
+                entityType: 'Release',
+                action: 'delete',
+                params,
+            });
+        },
+        async publish(options) {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'Release',
+                action: 'publish',
+                params,
+            })
+                .then((data) => wrapReleaseAction(makeRequest, data))
+                .then((action) => action.waitProcessing(options));
+        },
+        async unpublish(options) {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'Release',
+                action: 'unpublish',
+                params,
+            })
+                .then((data) => wrapReleaseAction(makeRequest, data))
+                .then((action) => action.waitProcessing(options));
+        },
+        async validate(options) {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'Release',
+                action: 'validate',
+                params,
+                payload: options?.payload,
+            })
+                .then((data) => wrapReleaseAction(makeRequest, data))
+                .then((action) => action.waitProcessing(options?.processingOptions));
+        },
+    };
+}
+/**
+ * Return a Release object enhanced with its own API helper functions.
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw Release data
+ * @return Wrapped Release data
+ */
+function wrapRelease(makeRequest, data) {
+    const release = toPlainObject(copy(data));
+    const releaseWithApiMethods = enhanceWithMethods(release, createReleaseApi(makeRequest));
+    return freezeSys(releaseWithApiMethods);
+}
+/**
+ * @private
+ */
+const wrapReleaseCollection = wrapCursorPaginatedCollection(wrapRelease);
+
+export { wrapRelease, wrapReleaseCollection };
+//# sourceMappingURL=release.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"release.js","sources":["../../../lib/entities/release.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;AAAA;AAoKA;;AAEG;AACH,SAAS,gBAAgB,CAAC,WAAwB,EAAA;AAChD,IAAA,MAAM,SAAS,GAAG,CAAC,IAAa,KAAI;AAClC,QAAA,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,EAAE;QAEpC,OAAO;YACL,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;YACjC,aAAa,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE;AAC7C,YAAA,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE;AACzB,YAAA,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,OAAO;SAC7B;AACH,IAAA,CAAC;IAED,OAAO;AACL,QAAA,MAAM,OAAO,GAAA;AACX,YAAA,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC;AAE9B,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,MAAM,EAAE,SAAS;gBACjB,MAAM;AACP,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,KAAK,WAAW,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QACzD,CAAC;AACD,QAAA,MAAM,SAAS,GAAA;AACb,YAAA,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC;AAE9B,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,MAAM,EAAE,WAAW;gBACnB,MAAM;AACP,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,KAAK,WAAW,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QACzD,CAAC;QACD,MAAM,MAAM,CAAC,OAAuB,EAAA;AAClC,YAAA,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC;AAE9B,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,MAAM,EAAE,QAAQ;gBAChB,MAAM;gBACN,OAAO;AACR,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,KAAK,WAAW,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QACzD,CAAC;AACD,QAAA,MAAM,MAAM,GAAA;AACV,YAAA,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC;AAE9B,YAAA,MAAM,WAAW,CAAC;AAChB,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,MAAM,EAAE,QAAQ;gBAChB,MAAM;AACP,aAAA,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,CAAC,OAAsC,EAAA;AAClD,YAAA,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC;AAE9B,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,MAAM,EAAE,SAAS;gBACjB,MAAM;aACP;AACE,iBAAA,IAAI,CAAC,CAAC,IAAI,KAAK,iBAAiB,CAAC,WAAW,EAAE,IAAI,CAAC;AACnD,iBAAA,IAAI,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACrD,CAAC;QAED,MAAM,SAAS,CAAC,OAAsC,EAAA;AACpD,YAAA,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC;AAE9B,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,MAAM,EAAE,WAAW;gBACnB,MAAM;aACP;AACE,iBAAA,IAAI,CAAC,CAAC,IAAI,KAAK,iBAAiB,CAAC,WAAW,EAAE,IAAI,CAAC;AACnD,iBAAA,IAAI,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACrD,CAAC;QAED,MAAM,QAAQ,CAAC,OAAgC,EAAA;AAC7C,YAAA,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC;AAE9B,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,MAAM,EAAE,UAAU;gBAClB,MAAM;gBACN,OAAO,EAAE,OAAO,EAAE,OAAO;aAC1B;AACE,iBAAA,IAAI,CAAC,CAAC,IAAI,KAAK,iBAAiB,CAAC,WAAW,EAAE,IAAI,CAAC;AACnD,iBAAA,IAAI,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;QACxE,CAAC;KACF;AACH;AAIA;;;;;;AAMG;AACG,SAAU,WAAW,CAAC,WAAwB,EAAE,IAAkB,EAAA;IACtE,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,qBAAqB,GAAG,kBAAkB,CAC9C,OAAc,EACd,gBAAgB,CAAC,WAAW,CAAQ,CACrC;AACD,IAAA,OAAO,SAAS,CAAC,qBAAqB,CAAC;AACzC;AAEA;;AAEG;MACU,qBAAqB,GAGsB,6BAA6B,CAAC,WAAW;;;;"}

package/dist/types/entities/resource-provider.d.ts

@@ -0,0 +1,38 @@
+import type { BasicMetaSysProps, CollectionProp, DefaultElements, MakeRequest, SysLink } from '../common-types';
+import type { ResourceType, UpsertResourceTypeProps } from './resource-type';
+export type ResourceProviderProps = {
+    /**
+     * System metadata
+     */
+    sys: Omit<BasicMetaSysProps, 'version'> & {
+        organization: SysLink;
+        appDefinition: SysLink;
+    };
+    /**
+     * Resource Provider type, value is 'function'
+     */
+    type: 'function';
+    /**
+     * Link to a Contentful function
+     */
+    function: SysLink;
+};
+export type UpsertResourceProviderProps = Omit<ResourceProviderProps, 'sys'> & {
+    sys: {
+        id: string;
+    };
+};
+export interface ResourceProvider extends ResourceProviderProps, DefaultElements<ResourceProviderProps> {
+    upsert(): Promise<ResourceProvider>;
+    delete(): Promise<void>;
+    upsertResourceType(id: string, data: UpsertResourceTypeProps): Promise<ResourceType>;
+    getResourceType(id: string): Promise<ResourceType>;
+    getResourceTypes(): Promise<CollectionProp<ResourceType>>;
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw Resource Provider data
+ * @return Wrapped Resource Provider data
+ */
+export declare function wrapResourceProvider(makeRequest: MakeRequest, data: ResourceProviderProps): ResourceProvider;

package/dist/types/entities/resource-provider.js

@@ -0,0 +1,138 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import entities from './index.js';
+
+/**
+ * @private
+ */
+function createResourceProviderApi(makeRequest) {
+    const { wrapResourceType } = entities.resourceType;
+    return {
+        /**
+         * Sends an update to the server with any changes made to the object's properties
+         * @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.getOrganization('<org_id>')
+         * .then((org) => org.getAppDefinition('<app_def_id>'))
+         * .then((appDefinition) => appDefinition.getResourceProvider())
+         * .then((resourceProvider) => {
+         *    resourceProvider.function.sys.id = '<new_contentful_function_id>'
+         *    return resourceProvider.upsert()
+         * })
+         * .catch(console.error)
+         * ```
+         */
+        upsert: function upsert() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'ResourceProvider',
+                action: 'upsert',
+                params: getParams(data),
+                headers: {},
+                payload: getUpsertParams(data),
+            }).then((data) => wrapResourceProvider(makeRequest, data));
+        },
+        /**
+         * 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.getOrganization('<org_id>')
+         * .then((org) => org.getAppDefinition('<app_def_id>'))
+         * .then((appDefinition) => appDefinition.getResourceProvider())
+         * .then((resourceProvider) => resourceProvider.delete())
+         * .catch(console.error)
+         * ```
+         */
+        delete: function del() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'ResourceProvider',
+                action: 'delete',
+                params: getParams(data),
+            });
+        },
+        getResourceType: function getResourceType(id) {
+            return makeRequest({
+                entityType: 'ResourceType',
+                action: 'get',
+                params: {
+                    organizationId: this.sys.organization.sys.id,
+                    appDefinitionId: this.sys.appDefinition.sys.id,
+                    resourceTypeId: id,
+                },
+            }).then((data) => wrapResourceType(makeRequest, data));
+        },
+        upsertResourceType: function upsertResourceType(id, data) {
+            return makeRequest({
+                entityType: 'ResourceType',
+                action: 'upsert',
+                params: {
+                    organizationId: this.sys.organization.sys.id,
+                    appDefinitionId: this.sys.appDefinition.sys.id,
+                    resourceTypeId: id,
+                },
+                headers: {},
+                payload: data,
+            }).then((data) => wrapResourceType(makeRequest, data));
+        },
+        getResourceTypes: function getResourceTypes() {
+            return makeRequest({
+                entityType: 'ResourceType',
+                action: 'getMany',
+                params: {
+                    organizationId: this.sys.organization.sys.id,
+                    appDefinitionId: this.sys.appDefinition.sys.id,
+                },
+            }).then((data) => {
+                data.items = data.items.map((item) => wrapResourceType(makeRequest, item));
+                return data;
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param data - raw ResourceProvider Object
+ * @return Object containing the http params for the ResourceProvider request: organizationId and appDefinitionId
+ */
+const getParams = (data) => ({
+    organizationId: data.sys.organization.sys.id,
+    appDefinitionId: data.sys.appDefinition.sys.id,
+});
+/**
+ * @private
+ * @param data - raw ResourceProvider Object
+ * @return UpsertResourceProviderProps
+ */
+const getUpsertParams = (data) => ({
+    sys: { id: data.sys.id },
+    type: data.type,
+    function: data.function,
+});
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw Resource Provider data
+ * @return Wrapped Resource Provider data
+ */
+function wrapResourceProvider(makeRequest, data) {
+    const resourceProvider = toPlainObject(copy(data));
+    const ResourceProviderWithMethods = enhanceWithMethods(resourceProvider, createResourceProviderApi(makeRequest));
+    return freezeSys(ResourceProviderWithMethods);
+}
+
+export { wrapResourceProvider };
+//# sourceMappingURL=resource-provider.js.map

package/dist/types/entities/resource-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource-provider.js","sources":["../../../lib/entities/resource-provider.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AA6CA;;AAEG;AACH,SAAS,yBAAyB,CAAC,WAAwB,EAAA;AACzD,IAAA,MAAM,EAAE,gBAAgB,EAAE,GAAG,QAAQ,CAAC,YAAY;IAElD,OAAO;AACL;;;;;;;;;;;;;;;;;;;AAmBG;QACH,MAAM,EAAE,SAAS,MAAM,GAAA;AACrB,YAAA,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAA2B;AAC1D,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,kBAAkB;AAC9B,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC;AACvB,gBAAA,OAAO,EAAE,EAAE;AACX,gBAAA,OAAO,EAAE,eAAe,CAAC,IAAI,CAAC;AAC/B,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,oBAAoB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC5D,CAAC;AACD;;;;;;;;;;;;;;;;AAgBG;QACH,MAAM,EAAE,SAAS,GAAG,GAAA;AAClB,YAAA,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAA2B;AAC1D,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,kBAAkB;AAC9B,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC;AACxB,aAAA,CAAC;QACJ,CAAC;AAED,QAAA,eAAe,EAAE,SAAS,eAAe,CAAC,EAAU,EAAA;AAClD,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,cAAc;AAC1B,gBAAA,MAAM,EAAE,KAAK;AACb,gBAAA,MAAM,EAAE;oBACN,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE;oBAC5C,eAAe,EAAE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;AAC9C,oBAAA,cAAc,EAAE,EAAE;AACnB,iBAAA;AACF,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACxD,CAAC;AACD,QAAA,kBAAkB,EAAE,SAAS,kBAAkB,CAAC,EAAU,EAAE,IAA6B,EAAA;AACvF,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,cAAc;AAC1B,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE;oBACN,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE;oBAC5C,eAAe,EAAE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;AAC9C,oBAAA,cAAc,EAAE,EAAE;AACnB,iBAAA;AACD,gBAAA,OAAO,EAAE,EAAE;AACX,gBAAA,OAAO,EAAE,IAAI;AACd,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACxD,CAAC;QACD,gBAAgB,EAAE,SAAS,gBAAgB,GAAA;AACzC,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,cAAc;AAC1B,gBAAA,MAAM,EAAE,SAAS;AACjB,gBAAA,MAAM,EAAE;oBACN,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE;oBAC5C,eAAe,EAAE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;AAC/C,iBAAA;AACF,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAI;gBACf,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;AAC1E,gBAAA,OAAO,IAAoC;AAC7C,YAAA,CAAC,CAAC;QACJ,CAAC;KACF;AACH;AACA;;;;AAIG;AACH,MAAM,SAAS,GAAG,CAAC,IAA2B,MAAM;IAClD,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE;IAC5C,eAAe,EAAE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;AAC/C,CAAA,CAAC;AACF;;;;AAIG;AACH,MAAM,eAAe,GAAG,CAAC,IAA2B,MAAmC;IACrF,GAAG,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE;IACxB,IAAI,EAAE,IAAI,CAAC,IAAI;IACf,QAAQ,EAAE,IAAI,CAAC,QAAQ;AACxB,CAAA,CAAC;AAEF;;;;;AAKG;AACG,SAAU,oBAAoB,CAClC,WAAwB,EACxB,IAA2B,EAAA;IAE3B,MAAM,gBAAgB,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClD,MAAM,2BAA2B,GAAG,kBAAkB,CACpD,gBAAgB,EAChB,yBAAyB,CAAC,WAAW,CAAC,CACvC;AACD,IAAA,OAAO,SAAS,CAAC,2BAA2B,CAAC;AAC/C;;;;"}

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

@@ -0,0 +1,52 @@
+import type { BasicMetaSysProps, CursorPaginatedCollectionProp, DefaultElements, MakeRequest, SysLink } from '../common-types';
+export type ResourceTypeProps = {
+    /**
+     * System metadata
+     */
+    sys: Omit<BasicMetaSysProps, 'version'> & {
+        appDefinition: SysLink;
+        resourceProvider: SysLink;
+        organization: SysLink;
+    };
+    /**
+     * Resource Type name
+     */
+    name: string;
+    /**
+     * Resource Type defaultFieldMapping
+     */
+    defaultFieldMapping: {
+        title: string;
+        subtitle?: string;
+        description?: string;
+        externalUrl?: string;
+        image?: {
+            url: string;
+            altText?: string;
+        };
+        badge?: {
+            label: string;
+            variant: string;
+        };
+    };
+};
+declare const publicResourceTypeFields: readonly ["name"];
+type OptionalSysFields = 'createdAt' | 'createdBy' | 'updatedAt' | 'updatedBy' | 'appDefinition' | 'organization';
+export type SpaceEnvResourceTypeProps = Pick<ResourceTypeProps, (typeof publicResourceTypeFields)[number]> & {
+    sys: Partial<Pick<ResourceTypeProps['sys'], OptionalSysFields>> & Omit<ResourceTypeProps['sys'], OptionalSysFields>;
+};
+export type UpsertResourceTypeProps = Omit<ResourceTypeProps, 'sys'>;
+export interface ResourceType extends ResourceTypeProps, DefaultElements<ResourceTypeProps> {
+    upsert(): Promise<ResourceType>;
+    delete(): Promise<void>;
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw Resource Type data
+ * @return Wrapped Resource Type data
+ */
+export declare function wrapResourceType(makeRequest: MakeRequest, data: ResourceTypeProps): ResourceType;
+export declare function wrapResourceTypeforEnvironment(makeRequest: MakeRequest, data: SpaceEnvResourceTypeProps): SpaceEnvResourceTypeProps;
+export declare const wrapResourceTypesForEnvironmentCollection: (makeRequest: MakeRequest, data: CursorPaginatedCollectionProp<SpaceEnvResourceTypeProps>) => CursorPaginatedCollectionProp<SpaceEnvResourceTypeProps>;
+export {};

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

@@ -0,0 +1,95 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import { wrapCursorPaginatedCollection } from '../common-utils.js';
+
+/**
+ * @private
+ */
+function createResourceTypeApi(makeRequest) {
+    return {
+        /**
+         * Sends an update to the server with any changes made to the object's properties
+         * @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.getOrganization('<org_id>')
+         * .then((org) => org.getAppDefinition('<app_def_id>'))
+         * .then((appDefinition) => appDefinition.getResourceType())
+         * .then((resourceType) => {
+         *    resourceType.name = '<new_name>'
+         *    return resourceType.upsert()
+         * })
+         * .catch(console.error)
+         * ```
+         */
+        upsert: function upsert() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'ResourceType',
+                action: 'upsert',
+                params: getParams(data),
+                headers: {},
+                payload: getUpsertParams(data),
+            }).then((data) => wrapResourceType(makeRequest, data));
+        },
+        /**
+         * 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.getOrganization('<org_id>')
+         * .then((org) => org.getAppDefinition('<app_def_id>'))
+         * .then((appDefinition) => appDefinition.getResourceType())
+         * .then((resourceType) => resourceType.delete())
+         * .catch(console.error)
+         * ```
+         */
+        delete: function del() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'ResourceType',
+                action: 'delete',
+                params: getParams(data),
+            });
+        },
+    };
+}
+const getParams = (data) => ({
+    organizationId: data.sys.organization.sys.id,
+    appDefinitionId: data.sys.appDefinition.sys.id,
+    resourceTypeId: data.sys.id,
+});
+const getUpsertParams = (data) => ({
+    name: data.name,
+    defaultFieldMapping: data.defaultFieldMapping,
+});
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw Resource Type data
+ * @return Wrapped Resource Type data
+ */
+function wrapResourceType(makeRequest, data) {
+    const resourceType = toPlainObject(copy(data));
+    const ResourceTypeWithMethods = enhanceWithMethods(resourceType, createResourceTypeApi(makeRequest));
+    return freezeSys(ResourceTypeWithMethods);
+}
+function wrapResourceTypeforEnvironment(makeRequest, data) {
+    const resourceType = toPlainObject(data);
+    return freezeSys(resourceType);
+}
+const wrapResourceTypesForEnvironmentCollection = wrapCursorPaginatedCollection(wrapResourceTypeforEnvironment);
+
+export { wrapResourceType, wrapResourceTypeforEnvironment, wrapResourceTypesForEnvironmentCollection };
+//# sourceMappingURL=resource-type.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"resource-type.js","sources":["../../../lib/entities/resource-type.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAsEA;;AAEG;AACH,SAAS,qBAAqB,CAAC,WAAwB,EAAA;IACrD,OAAO;AACL;;;;;;;;;;;;;;;;;;;AAmBG;QACH,MAAM,EAAE,SAAS,MAAM,GAAA;AACrB,YAAA,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAuB;AAEtD,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,cAAc;AAC1B,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC;AACvB,gBAAA,OAAO,EAAE,EAAE;AACX,gBAAA,OAAO,EAAE,eAAe,CAAC,IAAI,CAAC;AAC/B,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACxD,CAAC;AACD;;;;;;;;;;;;;;;;AAgBG;QACH,MAAM,EAAE,SAAS,GAAG,GAAA;AAClB,YAAA,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAuB;AAEtD,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,cAAc;AAC1B,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC;AACxB,aAAA,CAAC;QACJ,CAAC;KACF;AACH;AAEA,MAAM,SAAS,GAAG,CAAC,IAAuB,MAA6B;IACrE,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE;IAC5C,eAAe,EAAE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;AAC9C,IAAA,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE;AAC5B,CAAA,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,IAAuB,MAA+B;IAC7E,IAAI,EAAE,IAAI,CAAC,IAAI;IACf,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;AAC9C,CAAA,CAAC;AAEF;;;;;AAKG;AACG,SAAU,gBAAgB,CAAC,WAAwB,EAAE,IAAuB,EAAA;IAChF,MAAM,YAAY,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9C,MAAM,uBAAuB,GAAG,kBAAkB,CAChD,YAAY,EACZ,qBAAqB,CAAC,WAAW,CAAC,CACnC;AACD,IAAA,OAAO,SAAS,CAAC,uBAAuB,CAAC;AAC3C;AAEM,SAAU,8BAA8B,CAC5C,WAAwB,EACxB,IAA+B,EAAA;AAE/B,IAAA,MAAM,YAAY,GAAG,aAAa,CAAC,IAAI,CAAC;AACxC,IAAA,OAAO,SAAS,CAAC,YAAY,CAAC;AAChC;MAEa,yCAAyC,GAGU,6BAA6B,CAC3F,8BAA8B;;;;"}

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

@@ -0,0 +1,38 @@
+import type { BasicCursorPaginationOptions, CursorPaginatedCollectionProp, MakeRequest, SysLink } from '../common-types';
+export type ResourceQueryOptions = LookupQueryOptions | SearchQueryOptions;
+type LookupQueryOptions = {
+    'sys.urn[in]': string;
+    locale?: string;
+} & BasicCursorPaginationOptions;
+type SearchQueryOptions = {
+    query: string;
+    locale?: string;
+} & BasicCursorPaginationOptions;
+export type ResourceProps = {
+    sys: {
+        type: 'Resource';
+        urn: string;
+        resourceType: SysLink;
+        resourceProvider: SysLink;
+        appDefinition: SysLink;
+    };
+    fields: {
+        title: string;
+        subtitle?: string;
+        description?: string;
+        externalUrl?: string;
+        image?: {
+            url: string;
+            altText?: string;
+        };
+        badge?: {
+            label: string;
+            variant: 'primary' | 'negative' | 'positive' | 'warning' | 'secondary';
+        };
+    };
+};
+export declare function wrapResource(makeRequest: MakeRequest, data: ResourceProps): ResourceProps & {
+    toPlainObject(): ResourceProps;
+};
+export declare const wrapResourceCollection: (makeRequest: MakeRequest, data: CursorPaginatedCollectionProp<ResourceProps>) => CursorPaginatedCollectionProp<ResourceProps>;
+export {};

package/dist/types/entities/resource.js

@@ -0,0 +1,11 @@
+import { wrapCursorPaginatedCollection } from '../common-utils.js';
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+
+function wrapResource(makeRequest, data) {
+    const resource = toPlainObject(data);
+    return freezeSys(resource);
+}
+const wrapResourceCollection = wrapCursorPaginatedCollection(wrapResource);
+
+export { wrapResource, wrapResourceCollection };
+//# sourceMappingURL=resource.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"resource.js","sources":["../../../lib/entities/resource.ts"],"sourcesContent":[null],"names":[],"mappings":";;;AA4CM,SAAU,YAAY,CAAC,WAAwB,EAAE,IAAmB,EAAA;AACxE,IAAA,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC;AACpC,IAAA,OAAO,SAAS,CAAC,QAAQ,CAAC;AAC5B;MACa,sBAAsB,GAGiB,6BAA6B,CAAC,YAAY;;;;"}

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

@@ -0,0 +1,85 @@
+import type { DefaultElements, BasicMetaSysProps, SysLink, MakeRequest } from '../common-types';
+export type ActionType = 'read' | 'create' | 'update' | 'delete' | 'publish' | 'unpublish' | 'archive' | 'unarchive';
+type ConditionType = 'and' | 'or' | 'not' | 'equals';
+export type ConstraintType = {
+    [key in ConditionType]?: ConstraintType[] | any;
+};
+export type RoleProps = {
+    sys: BasicMetaSysProps & {
+        space: SysLink;
+    };
+    name: string;
+    description?: string;
+    /**
+     * Permissions for application sections
+     */
+    permissions: {
+        ContentDelivery: string[] | string;
+        ContentModel: string[];
+        EnvironmentAliases: string[] | string;
+        Environments: string[] | string;
+        Settings: string[] | string;
+        Tags: string[] | string;
+    };
+    policies: {
+        effect: string;
+        actions: ActionType[] | 'all';
+        constraint: ConstraintType;
+    }[];
+};
+export type CreateRoleProps = Omit<RoleProps, 'sys'>;
+export interface Role extends RoleProps, DefaultElements<RoleProps> {
+    /**
+     * Deletes this object on the server.
+     * @memberof Role
+     * @func delete
+     * @return {Promise} 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.getRole('<role_id>'))
+     * .then((role) => role.delete())
+     * .then((role) => console.log(`role deleted.`))
+     * .catch(console.error)
+     * ```
+     */
+    delete(): Promise<void>;
+    /**
+     * Sends an update to the server with any changes made to the object's properties
+     * @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.getRole('<roles_id>'))
+     * .then((roles) => {
+     *   roles.name = 'New role name'
+     *   return roles.update()
+     * })
+     * .then((roles) => console.log(`roles ${roles.sys.id} updated.`))
+     * .catch(console.error)
+     * ```
+     */
+    update(): Promise<Role>;
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw role data
+ * @return Wrapped role data
+ */
+export declare function wrapRole(makeRequest: MakeRequest, data: RoleProps): Role;
+/**
+ * @private
+ */
+export declare const wrapRoleCollection: (makeRequest: MakeRequest, data: import("..").CollectionProp<RoleProps>) => import("..").Collection<Role, RoleProps>;
+export {};

package/dist/types/entities/role.js

@@ -0,0 +1,51 @@
+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 createRoleApi(makeRequest) {
+    const getParams = (data) => ({
+        spaceId: data.sys.space.sys.id,
+        roleId: data.sys.id,
+    });
+    return {
+        update: function update() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Role',
+                action: 'update',
+                params: getParams(data),
+                payload: data,
+            }).then((data) => wrapRole(makeRequest, data));
+        },
+        delete: function del() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Role',
+                action: 'delete',
+                params: getParams(data),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw role data
+ * @return Wrapped role data
+ */
+function wrapRole(makeRequest, data) {
+    const role = toPlainObject(copy(data));
+    const roleWithMethods = enhanceWithMethods(role, createRoleApi(makeRequest));
+    return freezeSys(roleWithMethods);
+}
+/**
+ * @private
+ */
+const wrapRoleCollection = wrapCollection(wrapRole);
+
+export { wrapRole, wrapRoleCollection };
+//# sourceMappingURL=role.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"role.js","sources":["../../../lib/entities/role.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAyFA;;AAEG;AACH,SAAS,aAAa,CAAC,WAAwB,EAAA;AAC7C,IAAA,MAAM,SAAS,GAAG,CAAC,IAAe,MAAM;QACtC,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;AAC9B,QAAA,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE;AACpB,KAAA,CAAC;IAEF,OAAO;QACL,MAAM,EAAE,SAAS,MAAM,GAAA;AACrB,YAAA,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAe;AAC9C,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,MAAM;AAClB,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC;AACvB,gBAAA,OAAO,EAAE,IAAI;AACd,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;QACD,MAAM,EAAE,SAAS,GAAG,GAAA;AAClB,YAAA,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAe;AAC9C,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,MAAM;AAClB,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC;AACxB,aAAA,CAAC;QACJ,CAAC;KACF;AACH;AAEA;;;;;AAKG;AACG,SAAU,QAAQ,CAAC,WAAwB,EAAE,IAAe,EAAA;IAChE,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtC,MAAM,eAAe,GAAG,kBAAkB,CAAC,IAAI,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;AAC5E,IAAA,OAAO,SAAS,CAAC,eAAe,CAAC;AACnC;AAEA;;AAEG;MACU,kBAAkB,GAAG,cAAc,CAAC,QAAQ;;;;"}