contentful-management 11.57.1 → 11.58.0-canary.1

package/dist/typings/entities/release.d.ts

@@ -18,6 +18,8 @@ export interface ReleaseQueryOptions {
     'sys.createdBy.sys.id[in]'?: string;
     /** Comma-separated filter (inclusion) by Release status (active, archived) */
     'sys.status[in]'?: ReleaseStatus;
+    /** Determines the Release API version to use. 'Release.v1' refers to Launch, 'Release.v2' refers to Releases. */
+    'sys.schemaVersion'?: 'Release.v1' | 'Release.v2';
     /** Comma-separated filter (exclusion) by Release status (active, archived) */
     'sys.status[nin]'?: ReleaseStatus;
     /** Find releases using full text phrase and term matching */
@@ -55,6 +57,7 @@ export type ReleaseSysProps = {
     createdAt: ISO8601Timestamp;
     updatedAt: ISO8601Timestamp;
     lastAction?: Link<'ReleaseAction'>;
+    schemaVersion?: 'Release.v2';
 };
 export type ReleaseReferenceFilters = ScheduledActionReferenceFilters;
 export declare const ReleaseReferenceFilters: typeof ScheduledActionReferenceFilters;
@@ -72,9 +75,23 @@ export interface ReleaseProps {
     metadata?: ReleaseMetadata;
 }
 export interface ReleasePayload extends MakeRequestPayload {
+    sys?: {
+        type: 'Release';
+        schemaVersion?: 'Release.v1' | undefined;
+    };
     title: string;
     entities: BaseCollection<Link<Entity>>;
 }
+export interface ReleasePayloadV2 extends MakeRequestPayload {
+    sys?: {
+        type: 'Release';
+        schemaVersion: 'Release.v2';
+    };
+    title: string;
+    entities: BaseCollection<{
+        entity: Link<Entity>;
+    } & ReleaseValidatePayload>;
+}
 export interface ReleaseValidatePayload {
     action?: 'publish';
 }
@@ -95,7 +112,7 @@ export interface ReleaseApiMethods {
      * */
     unarchive(): Promise<Release>;
     /** Updates a Release and returns the updated Release object */
-    update(payload: ReleasePayload): Promise<Release>;
+    update(payload: ReleasePayload | ReleasePayloadV2): Promise<Release>;
     /** Deletes a Release and all ReleaseActions linked to it (non-reversible) */
     delete(): Promise<void>;
     /** Publishes a Release and waits until the asynchronous action is completed */

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

@@ -1,6 +1,6 @@
 import type { RawAxiosRequestConfig, RawAxiosRequestHeaders } from 'axios';
 import type { OpPatch } from 'json-patch';
-import type { BasicCursorPaginationOptions, CollectionProp, CursorPaginatedCollectionProp, EnvironmentTemplateParams, GetBulkActionParams, GetContentTypeParams, GetEnvironmentTemplateParams, GetOrganizationMembershipParams, GetOrganizationParams, GetReleaseParams, GetSnapshotForContentTypeParams, GetSnapshotForEntryParams, GetSpaceEnvironmentParams, GetSpaceParams, KeyValueMap, QueryParams } from '../common-types';
+import type { BasicCursorPaginationOptions, CollectionProp, CreateReleaseEntryParams, CreateWithIdReleaseEntryParams, CursorPaginatedCollectionProp, EnvironmentTemplateParams, GetBulkActionParams, GetContentTypeParams, GetEntryParams, GetEnvironmentTemplateParams, GetManyEntryParams, GetManyReleaseEntryParams, GetOrganizationMembershipParams, GetOrganizationParams, GetReleaseEntryParams, GetReleaseParams, GetSnapshotForContentTypeParams, GetSnapshotForEntryParams, GetSpaceEnvironmentParams, GetSpaceParams, KeyValueMap, PatchEntryParams, PatchReleaseEntryParams, QueryParams, ReleaseEnvironmentParams, UpdateEntryParams, UpdateReleaseEntryParams } from '../common-types';
 import type { AccessTokenProps, CreatePersonalAccessTokenProps as CreatePATProps } from '../entities/access-token';
 import type { ApiKeyProps, CreateApiKeyProps } from '../entities/api-key';
 import type { AssetFileProp, AssetProcessingForLocale, AssetProps, CreateAssetProps } from '../entities/asset';
@@ -14,7 +14,7 @@ import type { CreateOrganizationInvitationProps, OrganizationInvitationProps } f
 import type { OrganizationMembershipProps } from '../entities/organization-membership';
 import type { CreatePersonalAccessTokenProps, PersonalAccessTokenProps } from '../entities/personal-access-token';
 import type { PreviewApiKeyProps } from '../entities/preview-api-key';
-import type { ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseValidatePayload } from '../entities/release';
+import type { ReleasePayload, ReleasePayloadV2, ReleaseProps, ReleaseQueryOptions, ReleaseValidatePayload } from '../entities/release';
 import type { ReleaseActionProps, ReleaseActionQueryOptions } from '../entities/release-action';
 import type { CreateUpdateScheduledActionProps, ScheduledActionProps } from '../entities/scheduled-action';
 import type { SnapshotProps } from '../entities/snapshot';
@@ -162,17 +162,26 @@ export type PlainClientAPI = {
     user: UserPlainClientAPI;
     entry: {
         getPublished<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T>>>;
-        getMany<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T>>>;
-        get<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
-            entryId: string;
-        }>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
-        update<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
-            entryId: string;
-        }>, rawData: EntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
-        patch<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
-            entryId: string;
-            version?: number;
-        }>, rawData: OpPatch[], headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
+        getMany<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetManyEntryParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T, {
+            release: {
+                sys: {
+                    type: 'Link';
+                    linkType: 'Entry' | 'Asset';
+                    id: string;
+                };
+            };
+        }>>>;
+        get<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetEntryParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
+            release: {
+                sys: {
+                    type: 'Link';
+                    linkType: 'Entry' | 'Asset';
+                    id: string;
+                };
+            };
+        }>>;
+        update<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<UpdateEntryParams & QueryParams>, rawData: EntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
+        patch<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<PatchEntryParams & QueryParams>, rawData: OpPatch[], headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
         delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
             entryId: string;
         }>): Promise<any>;
@@ -192,11 +201,21 @@ export type PlainClientAPI = {
         }>): Promise<EntryProps<T>>;
         create<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
             contentTypeId: string;
-        }>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
+            releaseId?: string;
+        } & QueryParams>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
         createWithId<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
             entryId: string;
             contentTypeId: string;
-        }>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
+            releaseId?: string;
+        }>, rawData: CreateEntryProps<T>): Promise<EntryProps<T, {
+            release: {
+                sys: {
+                    type: 'Link';
+                    linkType: 'Entry' | 'Asset';
+                    id: string;
+                };
+            };
+        }>>;
         references(params: OptionalDefaults<GetSpaceEnvironmentParams & {
             entryId: string;
             include?: number;
@@ -266,6 +285,62 @@ export type PlainClientAPI = {
     };
     usage: UsagePlainClientAPI;
     release: {
+        entry: {
+            get<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetReleaseEntryParams & QueryParams>): Promise<EntryProps<T, {
+                release: {
+                    sys: {
+                        type: 'Link';
+                        linkType: 'Entry' | 'Asset';
+                        id: string;
+                    };
+                };
+            }>>;
+            getMany<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetManyReleaseEntryParams & QueryParams>): Promise<CollectionProp<EntryProps<T, {
+                release: {
+                    sys: {
+                        type: 'Link';
+                        linkType: 'Entry' | 'Asset';
+                        id: string;
+                    };
+                };
+            }>>>;
+            update<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<UpdateReleaseEntryParams & QueryParams>, rawData: EntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
+                release: {
+                    sys: {
+                        type: 'Link';
+                        linkType: 'Entry' | 'Asset';
+                        id: string;
+                    };
+                };
+            }>>;
+            patch<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<PatchReleaseEntryParams & QueryParams>, rawData: OpPatch[], headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
+                release: {
+                    sys: {
+                        type: 'Link';
+                        linkType: 'Entry' | 'Asset';
+                        id: string;
+                    };
+                };
+            }>>;
+            create<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<CreateReleaseEntryParams & QueryParams>, rawData: CreateEntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
+                release: {
+                    sys: {
+                        type: 'Link';
+                        linkType: 'Entry' | 'Asset';
+                        id: string;
+                    };
+                };
+            }>>;
+            createWithId<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<CreateWithIdReleaseEntryParams & QueryParams>, rawData: CreateEntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
+                release: {
+                    sys: {
+                        type: 'Link';
+                        linkType: 'Entry' | 'Asset';
+                        id: string;
+                    };
+                };
+            }>>;
+        };
         archive(params: OptionalDefaults<GetReleaseParams & {
             version: number;
         }>): Promise<ReleaseProps>;
@@ -273,10 +348,10 @@ export type PlainClientAPI = {
         query(params: OptionalDefaults<GetSpaceEnvironmentParams> & {
             query?: ReleaseQueryOptions;
         }): Promise<CursorPaginatedCollectionProp<ReleaseProps>>;
-        create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: ReleasePayload): Promise<ReleaseProps>;
+        create(params: OptionalDefaults<ReleaseEnvironmentParams>, data: ReleasePayload | ReleasePayloadV2): Promise<ReleaseProps>;
         update(params: OptionalDefaults<GetReleaseParams & {
             version: number;
-        }>, data: ReleasePayload): Promise<ReleaseProps>;
+        }>, data: ReleasePayload | ReleasePayloadV2): Promise<ReleaseProps>;
         delete(params: OptionalDefaults<GetReleaseParams>): Promise<void>;
         publish(params: OptionalDefaults<GetReleaseParams & {
             version: number;

package/dist/typings/plain/wrappers/wrap.d.ts

@@ -3,6 +3,8 @@ export type DefaultParams = {
     spaceId?: string;
     environmentId?: string;
     organizationId?: string;
+    releaseSchemaVersion?: 'Release.v1' | 'Release.v2';
+    releaseId?: string;
 };
 /**
  * @private

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentful-management",
-  "version": "11.57.1",
+  "version": "11.58.0-canary.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",
@@ -45,7 +45,7 @@
     "test:types": "npx vitest --project types --run",
     "test:unit-watch": "npx vitest --project unit",
     "test:integration": "npx vitest --project integration --run --no-file-parallelism",
-    "test:integration-watch": "npx vitest --project integration --no-file-parallelism",
+    "test:integration-watch": "npx vitest --project integration --no-file-parallelism entry-integration",
     "test:browser": "npx playwright install && npx vitest --project browser-unit --run && npx vitest --project browser-integration --run",
     "test:version": "grep -r \"0.0.0-determined-by-semantic-release\" ./dist > /dev/null && echo \"version 0.0.0-determined-by-semantic-release found in output\" && exit 1 || exit 0",
     "test:size": "size-limit",
@@ -142,6 +142,10 @@
         "name": "beta",
         "channel": "beta",
         "prerelease": true
+      },
+      {
+        "name": "canary",
+        "prerelease": true
       }
     ],
     "plugins": [