.gitignore

@@ -152,7 +152,6 @@ $RECYCLE.BIN/
 
 # End of https://www.gitignore.io/api/node,windows,osx,linux,vim
 yarn.lock
-package-lock.json
 
 # Editors
 .vscode

lib/common-types.ts

@@ -4,6 +4,20 @@ export interface DefaultElements<TPlainObject extends object = object> {
   toPlainObject(): TPlainObject
 }
 
+/**
+ * Link is a reference object to another entity that can be resolved using tools such as contentful-resolve
+ */
+export interface Link<T extends string> {
+  sys: {
+    type: 'Link'
+    linkType: T
+    id: string
+  }
+}
+
+/** String will be in ISO8601 datetime format e.g. 2013-06-26T13:57:24Z */
+export type ISO8601Timestamp = string
+
 export interface MetaSysProps {
   type: string
   id: string
@@ -43,12 +57,20 @@ export interface Collection<T, TPlain>
     DefaultElements<CollectionProp<TPlain>> {}
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
-export interface QueryOptions {
+export interface QueryOptions extends BasicQueryOptions {
+  content_type?: string
+  include?: number
+}
+
+export interface BasicQueryOptions {
   skip?: number
   limit?: number
   order?: string
-  content_type?: string
-  include?: number
 
   [key: string]: any
 }
+
+export interface BasicCursorPaginationOptions {
+  prev?: string
+  next?: string
+}

lib/create-environment-api.ts

@@ -2,7 +2,7 @@ import { AxiosInstance } from 'axios'
 import { createRequestConfig } from 'contentful-sdk-core'
 import cloneDeep from 'lodash/cloneDeep'
 import { Stream } from 'stream'
-import { QueryOptions } from './common-types'
+import { BasicQueryOptions, QueryOptions } from './common-types'
 import entities from './entities'
 import { AppInstallationProps } from './entities/app-installation'
 import { AssetFileProp, AssetProps } from './entities/asset'
@@ -1023,9 +1023,9 @@ export default function createEnvironmentApi({
         })
         .then((response) => wrapTag(http, response.data), errorHandler)
     },
-    getTags(skip?: number, limit?: number) {
+    getTags(query: BasicQueryOptions = {}) {
       return http
-        .get('tags', { params: { skip, limit } })
+        .get('tags', createRequestConfig({ query }))
         .then((response) => wrapTagCollection(http, response.data), errorHandler)
     },
     getTag(id: string) {

lib/create-space-api.ts

@@ -21,14 +21,16 @@ import { WebhookProps } from './entities/webhook'
 import { QueryOptions } from './common-types'
 import { UIExtensionProps } from './entities/ui-extension'
 import { CreateApiKeyProps } from './entities/api-key'
+import { ScheduledActionQueryOptions, ScheduledActionProps } from './entities/scheduled-action'
+import { EnvironmentAliasProps } from './entities/environment-alias'
 
 function raiseDeprecationWarning(method: string) {
   console.warn(
     [
       `Deprecated: Space.${method}() will be removed in future major versions.`,
       null,
       `Please migrate your code to use Environment.${method}():`,
-      `https://contentful.github.io/contentful-management.js/contentful-management/latest/ContentfulEnvironmentAPI.html#.${method}`,
+      'https://contentful.github.io/contentful-management.js/contentful-management/latest/globals.html#createenvironmentapi',
       null,
     ].join('\n')
   )
@@ -72,12 +74,13 @@ export default function createSpaceApi({
     wrapTeamSpaceMembershipCollection,
   } = entities.teamSpaceMembership
   const { wrapApiKey, wrapApiKeyCollection } = entities.apiKey
+  const { wrapEditorInterface } = entities.editorInterface
+  const { wrapEnvironmentAlias, wrapEnvironmentAliasCollection } = entities.environmentAlias
   const { wrapPreviewApiKey, wrapPreviewApiKeyCollection } = entities.previewApiKey
+  const { wrapScheduledAction, wrapScheduledActionCollection } = entities.scheduledAction
   const { wrapSnapshotCollection } = entities.snapshot
-  const { wrapEditorInterface } = entities.editorInterface
-  const { wrapUpload } = entities.upload
   const { wrapUiExtension, wrapUiExtensionCollection } = entities.uiExtension
-  const { wrapEnvironmentAlias, wrapEnvironmentAliasCollection } = entities.environmentAlias
+  const { wrapUpload } = entities.upload
 
   function createAsset(data: Omit<AssetProps, 'sys'>) {
     return http
@@ -992,9 +995,10 @@ export default function createSpaceApi({
      * .catch(console.error)
      * ```
      */
-    getRoles() {
+    getRoles(query: QueryOptions = {}) {
+      normalizeSelect(query)
       return http
-        .get('roles')
+        .get('roles', createRequestConfig({ query }))
         .then((response) => wrapRoleCollection(http, response.data), errorHandler)
     },
 
@@ -1101,6 +1105,26 @@ export default function createSpaceApi({
         .put('roles/' + id, data)
         .then((response) => wrapRole(http, response.data), errorHandler)
     },
+    /**
+     * Query for scheduled actions in space.
+     * @param query - Object with search parameters. The enviroment id field is mandatory. Check the <a href="https://www.contentful.com/developers/docs/references/content-management-api/#/reference/scheduled-actions/scheduled-actions-collection">REST API reference</a> for more details.
+     * @return Promise for the scheduled actions query
+     */
+    getScheduledActions(query: ScheduledActionQueryOptions) {
+      return http
+        .get('scheduled_actions', createRequestConfig({ query: query }))
+        .then((response) => wrapScheduledActionCollection(http, response.data), errorHandler)
+    },
+    /**
+     * Creates a scheduled action
+     * @param data - Object representation of the scheduled action to be created
+     * @return Promise for the newly created scheduled actions
+     */
+    createScheduledAction(data: Omit<ScheduledActionProps, 'sys'>) {
+      return http
+        .post('scheduled_actions', data)
+        .then((response) => wrapScheduledAction(http, response.data), errorHandler)
+    },
     /**
      * Gets a User
      * @param id - User ID
@@ -1687,6 +1711,33 @@ export default function createSpaceApi({
         .get(`content_types/${contentTypeId}/snapshots`, createRequestConfig({ query: query }))
         .then((response) => wrapSnapshotCollection(http, response.data), errorHandler)
     },
+    /**
+     * Creates an EnvironmentAlias with a custom ID
+     * @param id - EnvironmentAlias ID
+     * @param data - Object representation of the EnvironmentAlias to be created
+     * @return Promise for the newly created EnvironmentAlias
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.createEnvironmentAliasWithId('<environment-alias-id>', {
+     *   environment: {
+     *     sys: { type: 'Link', linkType: 'Environment', id: 'targetEnvironment' }
+     *   }
+     * }))
+     * .then((environmentAlias) => console.log(environmentAlias))
+     * .catch(console.error)
+     * ```
+     */
+    createEnvironmentAliasWithId(id: string, data: Omit<EnvironmentAliasProps, 'sys'>) {
+      return http
+        .put('environment_aliases/' + id, data)
+        .then((response) => wrapEnvironmentAlias(http, response.data), errorHandler)
+    },
     /**
      * Gets an Environment Alias
      * @param Environment Alias ID

lib/entities/app-installation.ts

@@ -75,10 +75,12 @@ function createAppInstallationApi(http: AxiosInstance) {
         .then((response) => wrapAppInstallation(http, response.data), errorHandler)
     },
 
-    delete: createDeleteEntity({
-      http: http,
-      entityPath: 'app_installations',
-    }),
+    delete: function () {
+      const raw = this.toPlainObject() as AppInstallation
+      return http.delete(`app_installations/${raw.sys.appDefinition.sys.id}`).then(() => {
+        // do nothing
+      }, errorHandler)
+    },
   }
 }
 

lib/entities/asset.ts

@@ -28,7 +28,7 @@ export type AssetProps = {
     /** Title for this asset */
     title: { [key: string]: string }
     /** Description for this asset */
-    description: { [key: string]: string }
+    description?: { [key: string]: string }
     /** File object for this asset */
     file: {
       [key: string]: {

lib/entities/editor-interface.ts

@@ -15,6 +15,17 @@ export interface Control {
    */
   widgetId: string
   widgetNamespace: string
+  settings?: Record<string, any>
+}
+
+export interface Editor {
+  widgetId: string
+  widgetNamespace: string
+  /**
+   * Widget will be enabled if disabled property is missing
+   */
+  disabled?: boolean
+  settings?: Record<string, any>
 }
 
 export type EditorInterfaceProps = {
@@ -27,6 +38,14 @@ export type EditorInterfaceProps = {
    * Array of fields and it's associated widgetId
    */
   controls: Control[]
+  /**
+   * Array of editors. Defaults will be used if property is missing.
+   */
+  editors?: Editor[]
+  /**
+   * Array of sidebar widgerts. Defaults will be used if property is missing.
+   */
+  sidebar?: Editor[]
 }
 
 export interface EditorInterface
@@ -68,6 +87,9 @@ export interface EditorInterface
    * .then((contentType) => contentType.getEditorInterface())
    * .then((editorInterface) => {
    *  editorInterface.controls[0] = { "fieldId": "title", "widgetId": "singleLine"}
+   *  editorInterface.editors = [
+   *    { "widgetId": "custom-widget", "widgetNamespace": "app" }
+   *  ]
    *  return editorInterface.update()
    * })
    * .catch(console.error)

lib/entities/environment-alias.ts

@@ -1,7 +1,7 @@
 import cloneDeep from 'lodash/cloneDeep'
 import { freezeSys, toPlainObject } from 'contentful-sdk-core'
 import enhanceWithMethods from '../enhance-with-methods'
-import { createUpdateEntity } from '../instance-actions'
+import { createUpdateEntity, createDeleteEntity } from '../instance-actions'
 import { wrapCollection } from '../common-utils'
 import { DefaultElements, MetaLinkProps, MetaSysProps } from '../common-types'
 import { AxiosInstance } from 'axios'
@@ -11,7 +11,7 @@ export type EnvironmentAliasProps = {
    * System meta data
    */
   sys: MetaSysProps
-  environment: MetaLinkProps
+  environment: { sys: MetaLinkProps }
 }
 
 export interface EnvironmentAlias
@@ -39,7 +39,30 @@ export interface EnvironmentAlias
    * .catch(console.error)
    * ```
    */
-  update(data: Omit<EnvironmentAliasProps, 'sys'>): Promise<EnvironmentAlias>
+  update(): Promise<EnvironmentAlias>
+
+  /**
+   * Deletes this object on the server.
+   * @memberof EnvironmentAlias
+   * @func delete
+   * @return {Promise<void>} Promise for the deletion. It contains no data, but the Promise error case should be handled.
+   * ```javascript
+   * const contentful = require('contentful-management')
+   *
+   * const client = contentful.createClient({
+   *   accessToken: '<content_management_api_key>'
+   * })
+   *
+   * client.getSpace('<space_id>')
+   * .then((space) => space.getEnvironmentAlias('<environment_alias_id>'))
+   * .then((alias) => {
+   *   return alias.delete()
+   * })
+   * .then(() => console.log(`Alias deleted.`))
+   * .catch(console.error)
+   * ```
+   */
+  delete(): Promise<void>
 }
 
 function createEnvironmentAliasApi(http: AxiosInstance) {
@@ -49,6 +72,10 @@ function createEnvironmentAliasApi(http: AxiosInstance) {
       entityPath: 'environment_aliases',
       wrapperMethod: wrapEnvironmentAlias,
     }),
+    delete: createDeleteEntity({
+      http: http,
+      entityPath: 'environment_aliases',
+    }),
   }
 }