feat: [TOL-2513][SPA-2443] Bulk actions v2 support

lib/adapters/REST/endpoints/bulk-action.ts

@@ -5,6 +5,9 @@ import type {
   BulkActionPublishPayload,
   BulkActionUnpublishPayload,
   BulkActionValidatePayload,
+  PublishBulkActionV2Payload,
+  UnpublishBulkActionV2Payload,
+  ValidateBulkActionV2Payload,
 } from '../../../entities/bulk-action'
 import type { RestEndpoint } from '../types'
 import * as raw from './raw'
@@ -54,3 +57,53 @@ export const validate: RestEndpoint<'BulkAction', 'validate'> = (
     payload,
   )
 }
+
+export const getV2: RestEndpoint<'BulkAction', 'getV2'> = (
+  http: AxiosInstance,
+  params: GetBulkActionParams,
+) => {
+  return raw.get(
+    http,
+    `/spaces/${params.spaceId}/environments/${params.environmentId}/bulk_actions/${params.bulkActionId}`,
+  )
+}
+
+export const publishV2: RestEndpoint<'BulkAction', 'publishV2'> = (
+  http: AxiosInstance,
+  params: GetSpaceEnvironmentParams,
+  payload: PublishBulkActionV2Payload<'add'>,
+): Promise<BulkActionProps<PublishBulkActionV2Payload<'add'>>> => {
+  return raw.post(
+    http,
+    `/spaces/${params.spaceId}/environments/${params.environmentId}/bulk_actions`,
+    payload,
+  )
+}
+
+export const unpublishV2: RestEndpoint<'BulkAction', 'unpublishV2'> = (
+  http: AxiosInstance,
+  params: GetSpaceEnvironmentParams,
+  payload: PublishBulkActionV2Payload<'remove'> | UnpublishBulkActionV2Payload,
+): Promise<
+  BulkActionProps<PublishBulkActionV2Payload<'remove'> | UnpublishBulkActionV2Payload>
+> => {
+  return raw.post(
+    http,
+    `/spaces/${params.spaceId}/environments/${params.environmentId}/bulk_actions`,
+    payload,
+  )
+}
+
+export const validateV2: RestEndpoint<'BulkAction', 'validateV2'> = (
+  http: AxiosInstance,
+  params: GetSpaceEnvironmentParams,
+  payload: ValidateBulkActionV2Payload<'add'> | ValidateBulkActionV2Payload<'remove'>,
+): Promise<
+  BulkActionProps<ValidateBulkActionV2Payload<'add'> | ValidateBulkActionV2Payload<'remove'>>
+> => {
+  return raw.post(
+    http,
+    `/spaces/${params.spaceId}/environments/${params.environmentId}/bulk_actions`,
+    payload,
+  )
+}

lib/common-types.ts

@@ -41,7 +41,11 @@ import type {
   BulkActionProps,
   BulkActionPublishPayload,
   BulkActionUnpublishPayload,
+  BulkActionV2Payload,
   BulkActionValidatePayload,
+  PublishBulkActionV2Payload,
+  UnpublishBulkActionV2Payload,
+  ValidateBulkActionV2Payload,
 } from './entities/bulk-action'
 import type {
   CommentProps,
@@ -528,6 +532,10 @@ type MRInternal<UA extends boolean> = {
   (opts: MROpts<'BulkAction', 'publish', UA>): MRReturn<'BulkAction', 'publish'>
   (opts: MROpts<'BulkAction', 'unpublish', UA>): MRReturn<'BulkAction', 'unpublish'>
   (opts: MROpts<'BulkAction', 'validate', UA>): MRReturn<'BulkAction', 'validate'>
+  (opts: MROpts<'BulkAction', 'getV2', UA>): MRReturn<'BulkAction', 'getV2'>
+  (opts: MROpts<'BulkAction', 'publishV2', UA>): MRReturn<'BulkAction', 'publishV2'>
+  (opts: MROpts<'BulkAction', 'unpublishV2', UA>): MRReturn<'BulkAction', 'unpublishV2'>
+  (opts: MROpts<'BulkAction', 'validateV2', UA>): MRReturn<'BulkAction', 'validateV2'>
 
   (opts: MROpts<'Comment', 'get', UA>): MRReturn<'Comment', 'get'>
   (opts: MROpts<'Comment', 'getMany', UA>): MRReturn<'Comment', 'getMany'>
@@ -1304,6 +1312,27 @@ export type MRActions = {
       payload: BulkActionValidatePayload
       return: BulkActionProps<BulkActionValidatePayload>
     }
+    getV2: {
+      params: GetBulkActionParams
+      return: BulkActionProps<BulkActionV2Payload>
+    }
+    publishV2: {
+      params: GetSpaceEnvironmentParams
+      payload: PublishBulkActionV2Payload<'add'>
+      return: BulkActionProps<PublishBulkActionV2Payload<'add'>>
+    }
+    unpublishV2: {
+      params: GetSpaceEnvironmentParams
+      payload: PublishBulkActionV2Payload<'remove'> | UnpublishBulkActionV2Payload
+      return: BulkActionProps<PublishBulkActionV2Payload<'remove'> | UnpublishBulkActionV2Payload>
+    }
+    validateV2: {
+      params: GetSpaceEnvironmentParams
+      payload: ValidateBulkActionV2Payload<'add'> | ValidateBulkActionV2Payload<'remove'>
+      return: BulkActionProps<
+        ValidateBulkActionV2Payload<'add'> | ValidateBulkActionV2Payload<'remove'>
+      >
+    }
   }
   Comment: {
     get:

lib/entities/bulk-action.ts

@@ -69,6 +69,49 @@ export interface BulkActionPublishPayload extends MakeRequestPayload {
   }
 }
 
+interface AddFieldsEntity<L extends Link<Entity> | VersionedLink<Entity>> {
+  entity: L
+  add?: {
+    fields: Record<'*', string[]>
+  }
+}
+
+interface RemoveFieldsEntity<L extends Link<Entity> | VersionedLink<Entity>> {
+  entity: L
+  remove?: {
+    fields: Record<'*', string[]>
+  }
+}
+type BulkActionEntity<L extends Link<Entity> | VersionedLink<Entity>> = {
+  entity: L
+}
+
+export interface PublishBulkActionV2Payload<PublishActionType extends 'add' | 'remove' = 'add'> {
+  action: 'publish'
+  entities: PublishActionType extends 'remove'
+    ? RemoveFieldsEntity<VersionedLink<Entity>>[]
+    : AddFieldsEntity<VersionedLink<Entity>>[]
+}
+
+export interface ValidateBulkActionV2Payload<PublishActionType extends 'add' | 'remove' = 'add'> {
+  action: 'validate'
+  entities: PublishActionType extends 'remove'
+    ? RemoveFieldsEntity<Link<Entity>>[]
+    : AddFieldsEntity<Link<Entity>>[]
+}
+
+export interface UnpublishBulkActionV2Payload {
+  action: 'unpublish'
+  entities: BulkActionEntity<Link<Entity>>[]
+}
+
+export type BulkActionV2Payload =
+  | PublishBulkActionV2Payload<'add'>
+  | PublishBulkActionV2Payload<'remove'>
+  | UnpublishBulkActionV2Payload
+  | ValidateBulkActionV2Payload<'add'>
+  | ValidateBulkActionV2Payload<'remove'>
+
 export type BulkActionSysProps = {
   id: string
   type: 'BulkAction'
@@ -81,7 +124,7 @@ export type BulkActionSysProps = {
 }
 
 /** The object returned by the BulkActions API */
-export interface BulkActionProps<TPayload extends BulkActionPayload = any> {
+export interface BulkActionProps<TPayload extends BulkActionPayload | BulkActionV2Payload = any> {
   sys: BulkActionSysProps
   action: BulkActionType
   /** original payload when BulkAction was created */
@@ -120,15 +163,15 @@ function createBulkActionApi(makeRequest: MakeRequest) {
         params,
       }).then((bulkAction) => wrapBulkAction(makeRequest, bulkAction))
     },
-    async waitProcessing<TPayload extends BulkActionPayload = any>(
+    async waitProcessing<TPayload extends BulkActionPayload | BulkActionV2Payload = any>(
       options?: AsyncActionProcessingOptions,
     ): Promise<BulkActionProps<TPayload>> {
       return pollAsyncActionStatus<BulkActionProps<TPayload>>(async () => this.get(), options)
     },
   }
 }
 
-export interface BulkAction<T extends BulkActionPayload = any>
+export interface BulkAction<T extends BulkActionPayload | BulkActionV2Payload = any>
   extends BulkActionProps<T>,
     BulkActionApiMethods,
     DefaultElements<BulkActionProps<T>> {}
@@ -139,9 +182,9 @@ export interface BulkAction<T extends BulkActionPayload = any>
  * @param data - Raw BulkAction data
  * @return Wrapped BulkAction data
  */
-export function wrapBulkAction<TPayload extends BulkActionPayload = any>(
+export function wrapBulkAction<TPayload extends BulkActionPayload | BulkActionV2Payload = any>(
   makeRequest: MakeRequest,
-  data: BulkActionProps<BulkActionPayload>,
+  data: BulkActionProps<BulkActionPayload | BulkActionV2Payload>,
 ): BulkAction<TPayload> {
   const bulkAction = toPlainObject(copy(data))
   const bulkActionWithApiMethods = enhanceWithMethods(

lib/export-types.ts

@@ -85,6 +85,10 @@ export type {
   BulkActionType,
   BulkActionUnpublishPayload,
   BulkActionValidatePayload,
+  BulkActionV2Payload,
+  PublishBulkActionV2Payload,
+  UnpublishBulkActionV2Payload,
+  ValidateBulkActionV2Payload,
 } from './entities/bulk-action'
 export type {
   Comment,

lib/plain/common-types.ts

@@ -49,7 +49,11 @@ import type {
   BulkActionProps,
   BulkActionPublishPayload,
   BulkActionUnpublishPayload,
+  BulkActionV2Payload,
   BulkActionValidatePayload,
+  PublishBulkActionV2Payload,
+  UnpublishBulkActionV2Payload,
+  ValidateBulkActionV2Payload,
 } from '../entities/bulk-action'
 import type { ContentTypeProps, CreateContentTypeProps } from '../entities/content-type'
 import type { CreateEntryProps, EntryProps, EntryReferenceProps } from '../entities/entry'
@@ -246,6 +250,21 @@ export type PlainClientAPI = {
       params: GetSpaceEnvironmentParams,
       payload: BulkActionValidatePayload,
     ): Promise<BulkActionProps<BulkActionValidatePayload>>
+    getV2(params: GetBulkActionParams): Promise<BulkActionProps<BulkActionV2Payload>>
+    publishV2(
+      params: GetSpaceEnvironmentParams,
+      payload: PublishBulkActionV2Payload<'add'>,
+    ): Promise<BulkActionProps<PublishBulkActionV2Payload<'add'>>>
+    unpublishV2(
+      params: GetSpaceEnvironmentParams,
+      payload: PublishBulkActionV2Payload<'remove'> | UnpublishBulkActionV2Payload,
+    ): Promise<BulkActionProps<PublishBulkActionV2Payload<'remove'> | UnpublishBulkActionV2Payload>>
+    validateV2(
+      params: GetSpaceEnvironmentParams,
+      payload: ValidateBulkActionV2Payload<'add'> | ValidateBulkActionV2Payload<'remove'>,
+    ): Promise<
+      BulkActionProps<ValidateBulkActionV2Payload<'add'> | ValidateBulkActionV2Payload<'remove'>>
+    >
   }
   comment: CommentPlainClientAPI
   concept: ConceptPlainClientAPI

lib/plain/plain-client.ts

@@ -202,6 +202,10 @@ export const createPlainClient = (
       publish: wrap(wrapParams, 'BulkAction', 'publish'),
       unpublish: wrap(wrapParams, 'BulkAction', 'unpublish'),
       validate: wrap(wrapParams, 'BulkAction', 'validate'),
+      getV2: wrap(wrapParams, 'BulkAction', 'getV2'),
+      publishV2: wrap(wrapParams, 'BulkAction', 'publishV2'),
+      unpublishV2: wrap(wrapParams, 'BulkAction', 'unpublishV2'),
+      validateV2: wrap(wrapParams, 'BulkAction', 'validateV2'),
     },
     comment: {
       get: wrap(wrapParams, 'Comment', 'get') as PlainClientAPI['comment']['get'],

test/helpers.ts

@@ -1,9 +1,25 @@
 import type { CreateHttpClientParams } from 'contentful-sdk-core'
+import * as testUtils from '@contentful/integration-test-utils'
 import { createClient } from '../lib/contentful-management'
-import type { Environment, Organization, Space } from '../lib/contentful-management'
+import type {
+  BulkActionPayload,
+  BulkActionProps,
+  BulkActionV2Payload,
+  Environment,
+  Organization,
+  PlainClientAPI,
+  Space,
+} from '../lib/contentful-management'
 import { TestDefaults } from './defaults'
+import { AsyncActionProcessingOptions, pollAsyncActionStatus } from '../lib/methods/action'
 
-import * as testUtils from '@contentful/integration-test-utils'
+type PlainOptions = {
+  /** Used by the PlainClient to perform a poll for the BulkAction status */
+  plainClient: PlainClientAPI
+  spaceId: string
+  environmentId: string
+  bulkActionId: string
+}
 
 const accessToken = process.env.CONTENTFUL_INTEGRATION_TEST_CMA_TOKEN
 const orgId = process.env.CONTENTFUL_ORGANIZATION_ID
@@ -200,3 +216,37 @@ export const cleanupTaxonomy = async (olderThan = 1000 * 60 * 60) => {
 }
 
 export const timeoutToCalmRateLimiting = () => new Promise((resolve) => setTimeout(resolve, 1000))
+
+/** Waits for a BulkAction status to be either succeeded or failed.
+ * Used by the Plain client */
+export async function waitForBulkActionProcessing<T extends BulkActionPayload = any>(
+  { plainClient, spaceId, environmentId, bulkActionId }: PlainOptions,
+  options?: AsyncActionProcessingOptions,
+): Promise<BulkActionProps<T>> {
+  return pollAsyncActionStatus<BulkActionProps>(
+    async () =>
+      plainClient.bulkAction.get<T>({
+        bulkActionId,
+        spaceId,
+        environmentId,
+      }),
+    options,
+  )
+}
+
+/** Waits for a BulkAction V2 status to be either succeeded or failed.
+ * Used by the Plain client */
+export async function waitForBulkActionV2Processing<T extends BulkActionV2Payload = any>(
+  { plainClient, spaceId, environmentId, bulkActionId }: PlainOptions,
+  options?: AsyncActionProcessingOptions,
+): Promise<BulkActionProps<T>> {
+  return pollAsyncActionStatus<BulkActionProps>(
+    async () =>
+      plainClient.bulkAction.getV2({
+        bulkActionId,
+        spaceId,
+        environmentId,
+      }),
+    options,
+  )
+}