contentful-management 11.63.0 → 11.63.1

package/dist/es-modules/common-utils.js

@@ -12,18 +12,6 @@ export const wrapCollection = fn => (makeRequest, data, ...rest) => {
   // @ts-expect-error
   return collectionData;
 };
-
-/**
- * @private
- * Function for endpoints allowing `?cursor=true` wrapping the call
- * to ensure the correct return type for cursor based pagination
- * when `cursor: true`.
- */
-export const withOptionalCursorApi = fn => {
-  return function (args) {
-    return fn.call(this, args);
-  };
-};
 export const wrapCursorPaginatedCollection = fn => (makeRequest, data, ...rest) => {
   const collectionData = toPlainObject(copy(data));
   // @ts-expect-error

package/dist/es-modules/contentful-management.js

@@ -14,6 +14,7 @@ import { createAdapter } from './create-adapter';
 import createContentfulApi from './create-contentful-api';
 import { createPlainClient } from './plain/plain-client';
 import * as editorInterfaceDefaults from './constants/editor-interface-defaults';
+import { ScheduledActionStatus } from './entities/scheduled-action';
 export { asIterator } from './plain/as-iterator';
 export { fetchAll } from './plain/pagination-helper';
 export { isDraft, isPublished, isUpdated } from './plain/checks';
@@ -22,6 +23,7 @@ export { RestAdapter } from './adapters/REST/rest-adapter';
 export { makeRequest } from './adapters/REST/make-request';
 export { editorInterfaceDefaults };
 export * from './export-types';
+export { ScheduledActionStatus };
 
 /**
  * @deprecated
@@ -47,7 +49,7 @@ function createClient(params, opts = {}) {
   const sdkMain = opts.type === 'plain' ? 'contentful-management-plain.js' : 'contentful-management.js';
   const userAgent = getUserAgentHeader(
   // @ts-expect-error
-  `${sdkMain}/${"11.63.0"}`, params.application, params.integration, params.feature);
+  `${sdkMain}/${"11.63.1"}`, params.application, params.integration, params.feature);
   const adapter = createAdapter(_objectSpread(_objectSpread({}, params), {}, {
     userAgent
   }));

package/dist/es-modules/create-environment-api.js

@@ -17,7 +17,6 @@ import { wrapEnvironmentTemplateInstallationCollection } from './entities/enviro
 import { wrapFunctionCollection } from './entities/function';
 import { wrapFunctionLog, wrapFunctionLogCollection } from './entities/function-log';
 import { wrapAiActionInvocation } from './entities/ai-action-invocation';
-import { withOptionalCursorApi } from './common-utils';
 
 /**
  * @private
@@ -469,7 +468,7 @@ export default function createEnvironmentApi(makeRequest) {
      * .catch(console.error)
      * ```
      */
-    getContentTypes: withOptionalCursorApi(function (query = {}) {
+    getContentTypes(query = {}) {
       const raw = this.toPlainObject();
       return makeRequest({
         entityType: 'ContentType',
@@ -482,7 +481,7 @@ export default function createEnvironmentApi(makeRequest) {
           }).params
         }
       }).then(data => wrapContentTypeCollection(makeRequest, data));
-    }),
+    },
     /**
      * Creates a Content Type
      * @param data - Object representation of the Content Type to be created
@@ -713,7 +712,7 @@ export default function createEnvironmentApi(makeRequest) {
      * .catch(console.error)
      * ```
      */
-    getEntries: withOptionalCursorApi(function (query = {}) {
+    getEntries(query = {}) {
       const raw = this.toPlainObject();
       return makeRequest({
         entityType: 'Entry',
@@ -726,7 +725,7 @@ export default function createEnvironmentApi(makeRequest) {
           }).params
         }
       }).then(data => wrapEntryCollection(makeRequest, data));
-    }),
+    },
     /**
      * Gets a collection of published Entries
      * @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
@@ -745,7 +744,7 @@ export default function createEnvironmentApi(makeRequest) {
      * .catch(console.error)
      * ```
      */
-    getPublishedEntries: withOptionalCursorApi(function (query = {}) {
+    getPublishedEntries(query = {}) {
       const raw = this.toPlainObject();
       return makeRequest({
         entityType: 'Entry',
@@ -758,7 +757,7 @@ export default function createEnvironmentApi(makeRequest) {
           }).params
         }
       }).then(data => wrapEntryCollection(makeRequest, data));
-    }),
+    },
     /**
      * Creates a Entry
      * @param contentTypeId - The Content Type ID of the newly created Entry
@@ -929,7 +928,7 @@ export default function createEnvironmentApi(makeRequest) {
      * .catch(console.error)
      * ```
      */
-    getAssets: withOptionalCursorApi(function (query = {}) {
+    getAssets(query = {}) {
       const raw = this.toPlainObject();
       return makeRequest({
         entityType: 'Asset',
@@ -942,7 +941,7 @@ export default function createEnvironmentApi(makeRequest) {
           }).params
         }
       }).then(data => wrapAssetCollection(makeRequest, data));
-    }),
+    },
     /**
      * Gets a collection of published Assets
      * @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
@@ -961,7 +960,7 @@ export default function createEnvironmentApi(makeRequest) {
      * .catch(console.error)
      * ```
      */
-    getPublishedAssets: withOptionalCursorApi(function (query = {}) {
+    getPublishedAssets(query = {}) {
       const raw = this.toPlainObject();
       return makeRequest({
         entityType: 'Asset',
@@ -974,7 +973,7 @@ export default function createEnvironmentApi(makeRequest) {
           }).params
         }
       }).then(data => wrapAssetCollection(makeRequest, data));
-    }),
+    },
     /**
      * Creates a Asset. After creation, call asset.processForLocale or asset.processForAllLocales to start asset processing.
      * @param data - Object representation of the Asset to be created. Note that the field object should have an upload property on asset creation, which will be removed and replaced with an url property when processing is finished.

package/dist/typings/common-types.d.ts

@@ -213,23 +213,6 @@ export interface BasicCursorPaginationOptions extends Omit<BasicQueryOptions, 's
 interface CursorPaginationBase {
     limit?: number;
 }
-export type OptionalCursorApi<P, T, TPlain> = {
-    (query: P & CursorBasedParams['query'] & {
-        cursor: true;
-        skip?: never;
-    }): Promise<CursorPaginatedCollection<T, TPlain>>;
-    (query?: P & {
-        cursor?: false | undefined | never;
-    }): Promise<Collection<T, TPlain>>;
-    (query?: P): Promise<Collection<T, TPlain>>;
-};
-type WithCursorPagination<O> = O & {
-    params: {
-        query: {
-            cursor: true;
-        };
-    };
-};
 interface CursorPaginationPageNext extends CursorPaginationBase {
     pageNext: string;
     pagePrev?: never;
@@ -310,9 +293,7 @@ type MRInternal<UA extends boolean> = {
     (opts: MROpts<'AppInstallation', 'upsert', UA>): MRReturn<'AppInstallation', 'upsert'>;
     (opts: MROpts<'AppInstallation', 'delete', UA>): MRReturn<'AppInstallation', 'delete'>;
     (opts: MROpts<'AppInstallation', 'getForOrganization', UA>): MRReturn<'AppInstallation', 'getForOrganization'>;
-    (opts: WithCursorPagination<MROpts<'Asset', 'getMany', UA>>): Promise<CursorPaginatedCollectionProp<AssetProps>>;
     (opts: MROpts<'Asset', 'getMany', UA>): MRReturn<'Asset', 'getMany'>;
-    (opts: WithCursorPagination<MROpts<'Asset', 'getPublished', UA>>): Promise<CursorPaginatedCollectionProp<AssetProps>>;
     (opts: MROpts<'Asset', 'getPublished', UA>): MRReturn<'Asset', 'getPublished'>;
     (opts: MROpts<'Asset', 'get', UA>): MRReturn<'Asset', 'get'>;
     (opts: MROpts<'Asset', 'update', UA>): MRReturn<'Asset', 'update'>;
@@ -379,7 +360,6 @@ type MRInternal<UA extends boolean> = {
     (opts: MROpts<'ConceptScheme', 'updatePut', UA>): MRReturn<'ConceptScheme', 'updatePut'>;
     (opts: MROpts<'ConceptScheme', 'delete', UA>): MRReturn<'ConceptScheme', 'delete'>;
     (opts: MROpts<'ContentType', 'get', UA>): MRReturn<'ContentType', 'get'>;
-    (opts: WithCursorPagination<MROpts<'ContentType', 'getMany', UA>>): Promise<CursorPaginatedCollectionProp<ConceptProps>>;
     (opts: MROpts<'ContentType', 'getMany', UA>): MRReturn<'ContentType', 'getMany'>;
     (opts: MROpts<'ContentType', 'update', UA>): MRReturn<'ContentType', 'update'>;
     (opts: MROpts<'ContentType', 'create', UA>): MRReturn<'ContentType', 'create'>;
@@ -388,7 +368,6 @@ type MRInternal<UA extends boolean> = {
     (opts: MROpts<'ContentType', 'publish', UA>): MRReturn<'ContentType', 'publish'>;
     (opts: MROpts<'ContentType', 'unpublish', UA>): MRReturn<'ContentType', 'unpublish'>;
     (opts: MROpts<'EditorInterface', 'get', UA>): MRReturn<'EditorInterface', 'get'>;
-    (opts: WithCursorPagination<MROpts<'EditorInterface', 'getMany', UA>>): Promise<CursorPaginatedCollectionProp<EditorInterfaceProps>>;
     (opts: MROpts<'EditorInterface', 'getMany', UA>): MRReturn<'EditorInterface', 'getMany'>;
     (opts: MROpts<'EditorInterface', 'update', UA>): MRReturn<'EditorInterface', 'update'>;
     (opts: MROpts<'Environment', 'get', UA>): MRReturn<'Environment', 'get'>;
@@ -414,9 +393,7 @@ type MRInternal<UA extends boolean> = {
     (opts: MROpts<'EnvironmentTemplate', 'disconnect', UA>): MRReturn<'EnvironmentTemplate', 'disconnect'>;
     (opts: MROpts<'EnvironmentTemplateInstallation', 'getMany', UA>): MRReturn<'EnvironmentTemplateInstallation', 'getMany'>;
     (opts: MROpts<'EnvironmentTemplateInstallation', 'getForEnvironment', UA>): MRReturn<'EnvironmentTemplateInstallation', 'getForEnvironment'>;
-    (opts: WithCursorPagination<MROpts<'Entry', 'getMany', UA>>): Promise<CursorPaginatedCollectionProp<EntryProps>>;
     (opts: MROpts<'Entry', 'getMany', UA>): MRReturn<'Entry', 'getMany'>;
-    (opts: WithCursorPagination<MROpts<'Entry', 'getPublished', UA>>): Promise<CursorPaginatedCollectionProp<EntryProps>>;
     (opts: MROpts<'Entry', 'getPublished', UA>): MRReturn<'Entry', 'getPublished'>;
     (opts: MROpts<'Entry', 'get', UA>): MRReturn<'Entry', 'get'>;
     (opts: MROpts<'Entry', 'patch', UA>): MRReturn<'Entry', 'patch'>;

package/dist/typings/common-utils.d.ts

@@ -1,15 +1,8 @@
-import type { Collection, CollectionProp, CursorPaginatedCollection, CursorPaginatedCollectionProp, MakeRequest, OptionalCursorApi } from './common-types';
+import type { Collection, CollectionProp, CursorPaginatedCollection, CursorPaginatedCollectionProp, MakeRequest } from './common-types';
 /**
  * @private
  */
 export declare const wrapCollection: <R, T, Rest extends any[]>(fn: (makeRequest: MakeRequest, entity: T, ...rest: Rest) => R) => (makeRequest: MakeRequest, data: CollectionProp<T>, ...rest: Rest) => Collection<R, T>;
-/**
- * @private
- * Function for endpoints allowing `?cursor=true` wrapping the call
- * to ensure the correct return type for cursor based pagination
- * when `cursor: true`.
- */
-export declare const withOptionalCursorApi: <P, T, TPlain>(fn: OptionalCursorApi<P, T, TPlain>) => OptionalCursorApi<P, T, TPlain>;
 export declare const wrapCursorPaginatedCollection: <R, T, Rest extends any[]>(fn: (makeRequest: MakeRequest, entity: T, ...rest: Rest) => R) => (makeRequest: MakeRequest, data: CursorPaginatedCollectionProp<T>, ...rest: Rest) => CursorPaginatedCollection<R, T>;
 export declare function isSuccessful(statusCode: number): boolean;
 export declare function shouldRePoll(statusCode: number): boolean;

package/dist/typings/contentful-management.d.ts

@@ -10,6 +10,7 @@ import type { ClientAPI } from './create-contentful-api';
 import type { PlainClientAPI } from './plain/common-types';
 import type { DefaultParams } from './plain/plain-client';
 import * as editorInterfaceDefaults from './constants/editor-interface-defaults';
+import { ScheduledActionStatus } from './entities/scheduled-action';
 export type { ClientAPI } from './create-contentful-api';
 export { asIterator } from './plain/as-iterator';
 export { fetchAll } from './plain/pagination-helper';
@@ -22,6 +23,7 @@ export { makeRequest } from './adapters/REST/make-request';
 export { editorInterfaceDefaults };
 export type PlainClientDefaultParams = DefaultParams;
 export * from './export-types';
+export { ScheduledActionStatus };
 interface UserAgentParams {
     /**
      * Application name and version e.g myApp/version

package/dist/typings/create-environment-api.d.ts

@@ -326,7 +326,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getContentTypes: import("./common-types").OptionalCursorApi<QueryOptions, import("./entities/content-type").ContentType, ContentTypeProps>;
+    getContentTypes(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/content-type").ContentType, ContentTypeProps>>;
     /**
      * Creates a Content Type
      * @param data - Object representation of the Content Type to be created
@@ -486,7 +486,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getEntries: import("./common-types").OptionalCursorApi<QueryOptions, import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap, unknown>>;
+    getEntries(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap, unknown>>>;
     /**
      * Gets a collection of published Entries
      * @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
@@ -505,7 +505,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getPublishedEntries: import("./common-types").OptionalCursorApi<QueryOptions, import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap, unknown>>;
+    getPublishedEntries(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap, unknown>>>;
     /**
      * Creates a Entry
      * @param contentTypeId - The Content Type ID of the newly created Entry
@@ -625,7 +625,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getAssets: import("./common-types").OptionalCursorApi<QueryOptions, import("./entities/asset").Asset, AssetProps<{}>>;
+    getAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/asset").Asset, AssetProps<{}>>>;
     /**
      * Gets a collection of published Assets
      * @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
@@ -644,7 +644,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getPublishedAssets: import("./common-types").OptionalCursorApi<QueryOptions, import("./entities/asset").Asset, AssetProps<{}>>;
+    getPublishedAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/asset").Asset, AssetProps<{}>>>;
     /**
      * Creates a Asset. After creation, call asset.processForLocale or asset.processForAllLocales to start asset processing.
      * @param data - Object representation of the Asset to be created. Note that the field object should have an upload property on asset creation, which will be removed and replaced with an url property when processing is finished.

package/dist/typings/export-types.d.ts

@@ -40,7 +40,7 @@ export type { PreviewApiKey, PreviewApiKeyProps } from './entities/preview-api-k
 export type { Release, ReleaseMetadata, ReleasePayload, ReleasePayloadV2, ReleaseProps, ReleaseQueryOptions, ReleaseReferenceFilters, ReleaseSysProps, ReleaseValidateOptions, } from './entities/release';
 export type { ReleaseAction, ReleaseActionProps, ReleaseActionQueryOptions, ReleaseActionSysProps, ReleaseActionTypes, } from './entities/release-action';
 export type { CreateRoleProps, Role, RoleProps } from './entities/role';
-export type { ScheduledAction, ScheduledActionProps, ScheduledActionSysProps, ScheduledActionStatus, } from './entities/scheduled-action';
+export type { ScheduledAction, ScheduledActionProps, ScheduledActionSysProps, } from './entities/scheduled-action';
 export type { Snapshot, SnapshotProps } from './entities/snapshot';
 export type { Space, SpaceProps } from './entities/space';
 export type { SpaceMember, SpaceMemberProps } from './entities/space-member';

package/dist/typings/plain/common-types.d.ts

@@ -67,11 +67,6 @@ import type { OAuthApplicationPlainClientAPI } from './entities/oauth-applicatio
 import type { FunctionLogPlainClientAPI } from './entities/function-log';
 import type { AiActionPlainClientAPI } from './entities/ai-action';
 import type { AiActionInvocationPlainClientAPI } from './entities/ai-action-invocation';
-type WithCursorBasedPagination<T> = T & {
-    query: {
-        cursor: true;
-    };
-};
 export type PlainClientAPI = {
     raw: {
         getDefaultParams(): DefaultParams | undefined;
@@ -139,6 +134,7 @@ export type PlainClientAPI = {
             environmentTemplateId: string;
             organizationId: string;
             spaceId?: string;
+            latestOnly?: boolean;
         }, headers?: RawAxiosRequestHeaders): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>;
         getForEnvironment(params: BasicCursorPaginationOptions & EnvironmentTemplateParams & {
             installationId?: string;
@@ -159,7 +155,6 @@ export type PlainClientAPI = {
     conceptScheme: ConceptSchemePlainClientAPI;
     contentType: {
         get(params: OptionalDefaults<GetContentTypeParams & QueryParams>): Promise<ContentTypeProps>;
-        getMany(params: WithCursorBasedPagination<OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>>): Promise<CursorPaginatedCollectionProp<ContentTypeProps>>;
         getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>): Promise<CollectionProp<ContentTypeProps>>;
         update(params: OptionalDefaults<GetContentTypeParams>, rawData: ContentTypeProps, headers?: RawAxiosRequestHeaders): Promise<ContentTypeProps>;
         delete(params: OptionalDefaults<GetContentTypeParams>): Promise<any>;
@@ -173,11 +168,7 @@ export type PlainClientAPI = {
     };
     user: UserPlainClientAPI;
     entry: {
-        getPublished<T extends KeyValueMap = KeyValueMap>(params: WithCursorBasedPagination<OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CursorPaginatedCollectionProp<EntryProps<T>>>;
         getPublished<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T>>>;
-        getMany<T extends KeyValueMap = KeyValueMap>(params: WithCursorBasedPagination<OptionalDefaults<GetSpaceEnvironmentParams & QueryParams & {
-            releaseId?: string;
-        }>>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CursorPaginatedCollectionProp<EntryProps<T>>>;
         getMany<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams & {
             releaseId?: string;
         }>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T>>>;
@@ -226,11 +217,7 @@ export type PlainClientAPI = {
         }>): Promise<EntryReferenceProps>;
     };
     asset: {
-        getPublished(params: WithCursorBasedPagination<OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CursorPaginatedCollectionProp<AssetProps>>;
         getPublished(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<AssetProps>>;
-        getMany(params: WithCursorBasedPagination<OptionalDefaults<GetSpaceEnvironmentParams & QueryParams & {
-            releaseId?: string;
-        }>>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CursorPaginatedCollectionProp<AssetProps>>;
         getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams & {
             releaseId?: string;
         }>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<AssetProps>>;
@@ -475,4 +462,3 @@ export type PlainClientAPI = {
     workflowsChangelog: WorkflowsChangelogPlainClientAPI;
     oauthApplication: OAuthApplicationPlainClientAPI;
 };
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentful-management",
-  "version": "11.63.0",
+  "version": "11.63.1",
   "description": "Client for Contentful's Content Management API",
   "homepage": "https://www.contentful.com/developers/documentation/content-management-api/",
   "main": "./dist/contentful-management.node.js",