feat: add support for releases [DX-374]

.circleci/config.yml

@@ -148,3 +148,4 @@ workflows:
               only:
                 - master
                 - beta
+                - canary

README.md

@@ -417,6 +417,20 @@ This means that new versions are released automatically as fixes, features or br
 
 You can check the changelog on the [releases](https://github.com/contentful/contentful-management.js/releases) page.
 
+## Experimental features
+
+To download a build that has features that are not yet released, you can use the `canary` channel. This is a pre-release version of the library that contains features that are still in development and may not be stable. To install a canary version, you can use the following command:
+
+```bash
+npm install contentful-management@canary
+```
+
+### Current experimental features
+
+#### Timeline Preview / Releases v2
+
+This feature allows you to schedule content changes in the future and preview them before they go live. 
+
 ## Reach out to us
 
 ### You have questions about how to use this library?

lib/adapters/REST/endpoints/asset.ts

@@ -3,7 +3,17 @@ import type { AxiosInstance } from 'contentful-sdk-core'
 import { errorHandler } from 'contentful-sdk-core'
 import copy from 'fast-copy'
 import type { SetOptional } from 'type-fest'
-import type { CollectionProp, GetSpaceEnvironmentParams, QueryParams } from '../../../common-types'
+import type {
+  CollectionProp,
+  CreateReleaseAssetParams,
+  CreateWithFilesReleaseAssetParams,
+  CreateWithIdReleaseAssetParams,
+  GetReleaseAssetParams,
+  GetSpaceEnvironmentParams,
+  Link,
+  QueryParams,
+  UpdateReleaseAssetParams,
+} from '../../../common-types'
 import type {
   AssetFileProp,
   AssetProcessingForLocale,
@@ -15,13 +25,18 @@ import type { RestEndpoint } from '../types'
 import * as raw from './raw'
 import { create as createUpload } from './upload'
 import { normalizeSelect } from './utils'
+import * as releaseAsset from './release-asset'
 
 export const get: RestEndpoint<'Asset', 'get'> = (
   http: AxiosInstance,
-  params: GetSpaceEnvironmentParams & { assetId: string } & QueryParams,
+  params: GetSpaceEnvironmentParams & { assetId: string; releaseId?: string } & QueryParams,
   rawData?: unknown,
   headers?: RawAxiosRequestHeaders,
 ) => {
+  if (params.releaseId) {
+    return releaseAsset.get(http, params as GetReleaseAssetParams)
+  }
+
   return raw.get<AssetProps>(
     http,
     `/spaces/${params.spaceId}/environments/${params.environmentId}/assets/${params.assetId}`,
@@ -50,10 +65,14 @@ export const getPublished: RestEndpoint<'Asset', 'getPublished'> = (
 
 export const getMany: RestEndpoint<'Asset', 'getMany'> = (
   http: AxiosInstance,
-  params: GetSpaceEnvironmentParams & QueryParams,
+  params: GetSpaceEnvironmentParams & QueryParams & { releaseId?: string },
   rawData?: unknown,
   headers?: RawAxiosRequestHeaders,
 ) => {
+  if (params.releaseId) {
+    return releaseAsset.getMany(http, params as GetReleaseAssetParams)
+  }
+
   return raw.get<CollectionProp<AssetProps>>(
     http,
     `/spaces/${params.spaceId}/environments/${params.environmentId}/assets`,
@@ -66,10 +85,14 @@ export const getMany: RestEndpoint<'Asset', 'getMany'> = (
 
 export const update: RestEndpoint<'Asset', 'update'> = (
   http: AxiosInstance,
-  params: GetSpaceEnvironmentParams & { assetId: string },
+  params: GetSpaceEnvironmentParams & { assetId: string; releaseId?: string },
   rawData: AssetProps,
   headers?: RawAxiosRequestHeaders,
 ) => {
+  if (params.releaseId) {
+    return releaseAsset.update(http, params as UpdateReleaseAssetParams, rawData, headers ?? {})
+  }
+
   const data: SetOptional<typeof rawData, 'sys'> = copy(rawData)
   delete data.sys
   return raw.put<AssetProps>(
@@ -161,9 +184,13 @@ export const unarchive: RestEndpoint<'Asset', 'unarchive'> = (
 
 export const create: RestEndpoint<'Asset', 'create'> = (
   http: AxiosInstance,
-  params: GetSpaceEnvironmentParams,
+  params: GetSpaceEnvironmentParams & { releaseId?: string },
   rawData: CreateAssetProps,
 ) => {
+  if (params.releaseId) {
+    return releaseAsset.create(http, params as CreateReleaseAssetParams, rawData, {})
+  }
+
   const data = copy(rawData)
 
   return raw.post<AssetProps>(
@@ -175,9 +202,13 @@ export const create: RestEndpoint<'Asset', 'create'> = (
 
 export const createWithId: RestEndpoint<'Asset', 'createWithId'> = (
   http: AxiosInstance,
-  params: GetSpaceEnvironmentParams & { assetId: string },
+  params: GetSpaceEnvironmentParams & { assetId: string; releaseId?: string },
   rawData: CreateAssetProps,
 ) => {
+  if (params.releaseId) {
+    return releaseAsset.createWithId(http, params as CreateWithIdReleaseAssetParams, rawData, {})
+  }
+
   const data = copy(rawData)
 
   return raw.put<AssetProps>(
@@ -189,9 +220,13 @@ export const createWithId: RestEndpoint<'Asset', 'createWithId'> = (
 
 export const createFromFiles: RestEndpoint<'Asset', 'createFromFiles'> = async (
   http: AxiosInstance,
-  params: GetSpaceEnvironmentParams & { uploadTimeout?: number },
+  params: GetSpaceEnvironmentParams & { uploadTimeout?: number; releaseId?: string },
   data: Omit<AssetFileProp, 'sys'>,
 ) => {
+  if (params.releaseId) {
+    return releaseAsset.createFromFiles(http, params as CreateWithFilesReleaseAssetParams, data, {})
+  }
+
   const httpUpload = getUploadHttpClient(http, { uploadTimeout: params.uploadTimeout })
 
   const { file } = data.fields
@@ -293,6 +328,15 @@ export const processForLocale: RestEndpoint<'Asset', 'processForLocale'> = async
     options?: AssetProcessingForLocale
   },
 ) => {
+  if (asset.sys.release) {
+    return releaseAsset.processForLocale(http, {
+      asset: asset as AssetProps<{ release: Link<'Release'> }>,
+      locale,
+      options: { processingCheckRetries, processingCheckWait },
+      ...params,
+    })
+  }
+
   return raw
     .put<AssetProps>(
       http,
@@ -333,6 +377,14 @@ export const processForAllLocales: RestEndpoint<'Asset', 'processForAllLocales'>
     ...params
   }: GetSpaceEnvironmentParams & { asset: AssetProps; options?: AssetProcessingForLocale },
 ) => {
+  if (asset.sys.release) {
+    return releaseAsset.processForAllLocales(http, {
+      asset: asset as AssetProps<{ release: Link<'Release'> }>,
+      options,
+      ...params,
+    })
+  }
+
   const locales = Object.keys(asset.fields.file || {})
 
   let mostUpToDateAssetVersion: AssetProps = asset

lib/adapters/REST/endpoints/entry.ts

@@ -5,21 +5,32 @@ import type { OpPatch } from 'json-patch'
 import type { SetOptional } from 'type-fest'
 import type {
   CollectionProp,
+  CreateReleaseEntryParams,
+  CreateWithIdReleaseEntryParams,
+  GetManyReleaseEntryParams,
+  GetReleaseEntryParams,
   GetSpaceEnvironmentParams,
   KeyValueMap,
+  PatchReleaseEntryParams,
   QueryParams,
+  UpdateReleaseEntryParams,
 } from '../../../common-types'
 import type { CreateEntryProps, EntryProps, EntryReferenceProps } from '../../../entities/entry'
 import type { RestEndpoint } from '../types'
 import * as raw from './raw'
+import * as releaseEntry from './release-entry'
 import { normalizeSelect } from './utils'
 
 export const get: RestEndpoint<'Entry', 'get'> = <T extends KeyValueMap = KeyValueMap>(
   http: AxiosInstance,
-  params: GetSpaceEnvironmentParams & { entryId: string } & QueryParams,
+  params: GetSpaceEnvironmentParams & { entryId: string; releaseId?: string } & QueryParams,
   rawData?: unknown,
   headers?: RawAxiosRequestHeaders,
 ) => {
+  if (params.releaseId) {
+    return releaseEntry.get(http, params as GetReleaseEntryParams)
+  }
+
   return raw.get<EntryProps<T>>(
     http,
     `/spaces/${params.spaceId}/environments/${params.environmentId}/entries/${params.entryId}`,
@@ -50,10 +61,14 @@ export const getPublished: RestEndpoint<'Entry', 'getPublished'> = <
 
 export const getMany: RestEndpoint<'Entry', 'getMany'> = <T extends KeyValueMap = KeyValueMap>(
   http: AxiosInstance,
-  params: GetSpaceEnvironmentParams & QueryParams,
+  params: GetSpaceEnvironmentParams & QueryParams & { releaseId?: string },
   rawData?: unknown,
   headers?: RawAxiosRequestHeaders,
 ) => {
+  if (params.releaseId) {
+    return releaseEntry.getMany(http, params as GetManyReleaseEntryParams)
+  }
+
   return raw.get<CollectionProp<EntryProps<T>>>(
     http,
     `/spaces/${params.spaceId}/environments/${params.environmentId}/entries`,
@@ -66,10 +81,14 @@ export const getMany: RestEndpoint<'Entry', 'getMany'> = <T extends KeyValueMap
 
 export const patch: RestEndpoint<'Entry', 'patch'> = <T extends KeyValueMap = KeyValueMap>(
   http: AxiosInstance,
-  params: GetSpaceEnvironmentParams & { entryId: string; version: number },
+  params: GetSpaceEnvironmentParams & { entryId: string; version: number; releaseId?: string },
   data: OpPatch[],
   headers?: RawAxiosRequestHeaders,
 ) => {
+  if (params.releaseId) {
+    return releaseEntry.patch(http, params as PatchReleaseEntryParams, data, headers ?? {})
+  }
+
   return raw.patch<EntryProps<T>>(
     http,
     `/spaces/${params.spaceId}/environments/${params.environmentId}/entries/${params.entryId}`,
@@ -86,10 +105,14 @@ export const patch: RestEndpoint<'Entry', 'patch'> = <T extends KeyValueMap = Ke
 
 export const update: RestEndpoint<'Entry', 'update'> = <T extends KeyValueMap = KeyValueMap>(
   http: AxiosInstance,
-  params: GetSpaceEnvironmentParams & { entryId: string },
+  params: GetSpaceEnvironmentParams & { entryId: string; releaseId?: string },
   rawData: EntryProps<T>,
   headers?: RawAxiosRequestHeaders,
 ) => {
+  if (params.releaseId) {
+    return releaseEntry.update(http, params as UpdateReleaseEntryParams, rawData, headers ?? {})
+  }
+
   const data: SetOptional<typeof rawData, 'sys'> = copy(rawData)
   delete data.sys
   return raw.put<EntryProps<T>>(
@@ -181,9 +204,13 @@ export const unarchive: RestEndpoint<'Entry', 'unarchive'> = <T extends KeyValue
 
 export const create: RestEndpoint<'Entry', 'create'> = <T extends KeyValueMap = KeyValueMap>(
   http: AxiosInstance,
-  params: GetSpaceEnvironmentParams & { contentTypeId: string },
+  params: GetSpaceEnvironmentParams & { contentTypeId: string; releaseId?: string },
   rawData: CreateEntryProps<T>,
 ) => {
+  if (params.releaseId) {
+    return releaseEntry.create(http, params as CreateReleaseEntryParams, rawData, {})
+  }
+
   const data = copy(rawData)
 
   return raw.post<EntryProps<T>>(
@@ -202,9 +229,16 @@ export const createWithId: RestEndpoint<'Entry', 'createWithId'> = <
   T extends KeyValueMap = KeyValueMap,
 >(
   http: AxiosInstance,
-  params: GetSpaceEnvironmentParams & { entryId: string; contentTypeId: string },
+  params: GetSpaceEnvironmentParams & {
+    entryId: string
+    contentTypeId: string
+    releaseId?: string
+  },
   rawData: CreateEntryProps<T>,
 ) => {
+  if (params.releaseId) {
+    return releaseEntry.createWithId(http, params as CreateWithIdReleaseEntryParams, rawData, {})
+  }
   const data = copy(rawData)
 
   return raw.put<EntryProps<T>>(

lib/adapters/REST/endpoints/index.ts

@@ -39,6 +39,8 @@ import * as OAuthApplication from './oauth-application'
 import * as PersonalAccessToken from './personal-access-token'
 import * as PreviewApiKey from './preview-api-key'
 import * as Release from './release'
+import * as ReleaseAsset from './release-asset'
+import * as ReleaseEntry from './release-entry'
 import * as ReleaseAction from './release-action'
 import * as Resource from './resource'
 import * as ResourceProvider from './resource-provider'
@@ -107,6 +109,8 @@ export default {
   AccessToken,
   PreviewApiKey,
   Release,
+  ReleaseAsset,
+  ReleaseEntry,
   ReleaseAction,
   Resource,
   ResourceProvider,