Merge branch 'master' into refactor/docs

Author: axe312ger

.github/CODEOWNERS

@@ -1,4 +1,4 @@
-* @contentful/team-tundra
+* @contentful/team-tundra @contentful/team-developer-experience
 
 package.json
 package-lock.json

catalog-info.yaml

@@ -7,8 +7,11 @@ metadata:
   annotations:
     circleci.com/project-slug: github/contentful/contentful-management.js
     github.com/project-slug: contentful/contentful-management.js
-    contentful.com/ci-alert-slack: prd-extensibility-bots
+    contentful.com/ci-alert-slack: prd-ecosystem-dx-bots
+    contentful.com/service-tier: "4"
+  tags:
+    - tier-4
 spec:
   type: library
   lifecycle: production
-  owner: group:team-tundra
+  owner: group:team-developer-experience

lib/adapters/REST/endpoints/ai-action-invocation.ts

@@ -0,0 +1,17 @@
+import type { RawAxiosRequestHeaders } from 'axios'
+import type { AxiosInstance } from 'contentful-sdk-core'
+import type { GetSpaceEnvironmentParams } from '../../../common-types'
+import type { RestEndpoint } from '../types'
+import * as raw from './raw'
+
+export const get: RestEndpoint<'AiActionInvocation', 'get'> = (
+  http: AxiosInstance,
+  params: GetSpaceEnvironmentParams & { aiActionId: string; invocationId: string },
+  headers?: RawAxiosRequestHeaders
+) => {
+  return raw.get(
+    http,
+    `/spaces/${params.spaceId}/environments/${params.environmentId}/ai/actions/${params.aiActionId}/invocations/${params.invocationId}`,
+    { headers }
+  )
+}

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

@@ -0,0 +1,115 @@
+import type { RawAxiosRequestHeaders } from 'axios'
+import type { AxiosInstance } from 'contentful-sdk-core'
+import copy from 'fast-copy'
+import type {
+  CollectionProp,
+  GetSpaceEnvironmentParams,
+  GetSpaceParams,
+  QueryParams,
+} from '../../../common-types'
+import type { RestEndpoint } from '../types'
+import * as raw from './raw'
+import type { AiActionProps, CreateAiActionProps } from '../../../entities/ai-action'
+import type { AiActionInvocationType } from '../../../entities/ai-action-invocation'
+
+export const get: RestEndpoint<'AiAction', 'get'> = (
+  http: AxiosInstance,
+  params: GetSpaceParams & { aiActionId: string },
+  headers?: RawAxiosRequestHeaders
+) => {
+  return raw.get<AiActionProps>(http, `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}`, {
+    headers,
+  })
+}
+
+export const getMany: RestEndpoint<'AiAction', 'getMany'> = (
+  http: AxiosInstance,
+  params: GetSpaceParams & QueryParams,
+  headers?: RawAxiosRequestHeaders
+) => {
+  return raw.get<CollectionProp<AiActionProps>>(http, `/spaces/${params.spaceId}/ai/actions`, {
+    params: params.query,
+    headers,
+  })
+}
+
+export const create: RestEndpoint<'AiAction', 'create'> = (
+  http: AxiosInstance,
+  params: GetSpaceParams,
+  data: CreateAiActionProps,
+  headers?: RawAxiosRequestHeaders
+) => {
+  return raw.post<AiActionProps>(http, `/spaces/${params.spaceId}/ai/actions`, data, { headers })
+}
+
+export const update: RestEndpoint<'AiAction', 'update'> = (
+  http: AxiosInstance,
+  params: GetSpaceParams & { aiActionId: string },
+  rawData: AiActionProps,
+  headers?: RawAxiosRequestHeaders
+) => {
+  const data = copy(rawData)
+  const { sys, ...payload } = data
+  return raw.put<AiActionProps>(
+    http,
+    `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}`,
+    payload,
+    {
+      headers: {
+        'X-Contentful-Version': rawData.sys.version ?? 0,
+        ...headers,
+      },
+    }
+  )
+}
+
+export const del: RestEndpoint<'AiAction', 'delete'> = (
+  http: AxiosInstance,
+  params: GetSpaceParams & { aiActionId: string },
+  headers?: RawAxiosRequestHeaders
+) => {
+  return raw.del(http, `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}`, { headers })
+}
+
+export const publish: RestEndpoint<'AiAction', 'publish'> = (
+  http: AxiosInstance,
+  params: GetSpaceParams & { aiActionId: string; version: number },
+  rawData?: unknown,
+  headers?: RawAxiosRequestHeaders
+) => {
+  return raw.put<AiActionProps>(
+    http,
+    `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}/published`,
+    null,
+    {
+      headers: {
+        'X-Contentful-Version': params.version,
+        ...headers,
+      },
+    }
+  )
+}
+
+export const unpublish: RestEndpoint<'AiAction', 'unpublish'> = (
+  http: AxiosInstance,
+  params: GetSpaceParams & { aiActionId: string },
+  headers?: RawAxiosRequestHeaders
+) => {
+  return raw.del(http, `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}/published`, {
+    headers,
+  })
+}
+
+export const invoke: RestEndpoint<'AiAction', 'invoke'> = (
+  http: AxiosInstance,
+  params: GetSpaceEnvironmentParams & { aiActionId: string },
+  data: AiActionInvocationType,
+  headers?: RawAxiosRequestHeaders
+) => {
+  return raw.post(
+    http,
+    `/spaces/${params.spaceId}/environments/${params.environmentId}/ai/actions/${params.aiActionId}/invoke`,
+    data,
+    { headers }
+  )
+}

lib/adapters/REST/endpoints/index.ts

@@ -1,3 +1,5 @@
+import * as AiAction from './ai-action'
+import * as AiActionInvocation from './ai-action-invocation'
 import * as AccessToken from './access-token'
 import * as ApiKey from './api-key'
 import * as AppAccessToken from './app-access-token'
@@ -64,6 +66,8 @@ import * as WorkflowDefinition from './workflow-definition'
 import * as WorkflowsChangelog from './workflows-changelog'
 
 export default {
+  AiAction,
+  AiActionInvocation,
   ApiKey,
   AppAction,
   AppActionCall,

lib/common-types.ts

@@ -180,6 +180,11 @@ import type {
   UpdateOAuthApplicationProps,
 } from './entities/oauth-application'
 import type { FunctionLogProps } from './entities/function-log'
+import type { AiActionProps, CreateAiActionProps } from './entities/ai-action'
+import type {
+  AiActionInvocationProps,
+  AiActionInvocationType,
+} from './entities/ai-action-invocation'
 
 export interface DefaultElements<TPlainObject extends object = object> {
   toPlainObject(): TPlainObject
@@ -417,6 +422,17 @@ type MRInternal<UA extends boolean> = {
   (opts: MROpts<'Http', 'delete', UA>): MRReturn<'Http', 'delete'>
   (opts: MROpts<'Http', 'request', UA>): MRReturn<'Http', 'request'>
 
+  (opts: MROpts<'AiAction', 'get', UA>): MRReturn<'AiAction', 'get'>
+  (opts: MROpts<'AiAction', 'getMany', UA>): MRReturn<'AiAction', 'getMany'>
+  (opts: MROpts<'AiAction', 'create', UA>): MRReturn<'AiAction', 'create'>
+  (opts: MROpts<'AiAction', 'update', UA>): MRReturn<'AiAction', 'update'>
+  (opts: MROpts<'AiAction', 'delete', UA>): MRReturn<'AiAction', 'delete'>
+  (opts: MROpts<'AiAction', 'publish', UA>): MRReturn<'AiAction', 'publish'>
+  (opts: MROpts<'AiAction', 'unpublish', UA>): MRReturn<'AiAction', 'unpublish'>
+  (opts: MROpts<'AiAction', 'invoke', UA>): MRReturn<'AiAction', 'invoke'>
+
+  (opts: MROpts<'AiActionInvocation', 'get', UA>): MRReturn<'AiActionInvocation', 'get'>
+
   (opts: MROpts<'AppAction', 'get', UA>): MRReturn<'AppAction', 'get'>
   (opts: MROpts<'AppAction', 'getMany', UA>): MRReturn<'AppAction', 'getMany'>
   (opts: MROpts<'AppAction', 'delete', UA>): MRReturn<'AppAction', 'delete'>
@@ -929,6 +945,48 @@ export type MRActions = {
     delete: { params: { url: string; config?: RawAxiosRequestConfig }; return: any }
     request: { params: { url: string; config?: RawAxiosRequestConfig }; return: any }
   }
+  AiAction: {
+    get: { params: GetSpaceParams & { aiActionId: string }; return: AiActionProps }
+    getMany: {
+      params: GetSpaceParams & QueryParams
+      return: CollectionProp<AiActionProps>
+    }
+    create: {
+      params: GetSpaceParams
+      payload: CreateAiActionProps
+      headers?: RawAxiosRequestHeaders
+      return: AiActionProps
+    }
+    update: {
+      params: GetSpaceParams & { aiActionId: string }
+      payload: AiActionProps
+      headers?: RawAxiosRequestHeaders
+      return: AiActionProps
+    }
+    delete: { params: GetSpaceParams & { aiActionId: string }; return: any }
+    publish: {
+      params: GetSpaceParams & { aiActionId: string; version: number }
+      headers?: RawAxiosRequestHeaders
+      return: AiActionProps
+    }
+    unpublish: {
+      params: GetSpaceParams & { aiActionId: string }
+      headers?: RawAxiosRequestHeaders
+      return: AiActionProps
+    }
+    invoke: {
+      params: GetSpaceEnvironmentParams & { aiActionId: string }
+      payload: AiActionInvocationType
+      headers?: RawAxiosRequestHeaders
+      return: AiActionInvocationProps
+    }
+  }
+  AiActionInvocation: {
+    get: {
+      params: GetSpaceEnvironmentParams & { aiActionId: string; invocationId: string }
+      return: AiActionInvocationProps
+    }
+  }
   AppAction: {
     get: { params: GetAppActionParams; return: AppActionProps }
     getMany: {

lib/contentful-management.ts

@@ -46,7 +46,8 @@ interface UserAgentParams {
  * @deprecated
  */
 export type ClientParams = RestAdapterParams & UserAgentParams
-type ClientOptions = UserAgentParams & XOR<RestAdapterParams, AdapterParams>
+
+export type ClientOptions = UserAgentParams & XOR<RestAdapterParams, AdapterParams>
 
 /**
  * Create a client instance

lib/create-environment-api.ts

@@ -56,6 +56,8 @@ import { wrapFunctionCollection } from './entities/function'
 import { wrapFunctionLog, wrapFunctionLogCollection } from './entities/function-log'
 import type { CreateAppAccessTokenProps } from './entities/app-access-token'
 import type { ResourceQueryOptions } from './entities/resource'
+import type { AiActionInvocationType } from './entities/ai-action-invocation'
+import { wrapAiActionInvocation } from './entities/ai-action-invocation'
 
 /**
  * @private
@@ -2556,5 +2558,65 @@ export default function createEnvironmentApi(makeRequest: MakeRequest) {
         },
       }).then((data) => wrapResourceCollection(makeRequest, data))
     },
+    /**
+     * Invokes an AI Action.
+     * @param aiActionId - The ID of the AI Action to invoke.
+     * @param payload - The invocation payload.
+     * @returns Promise for an AI Action Invocation.
+     * @example ```javascript
+     * client.getSpace('<space_id>')
+     *   .then(space => space.getEnvironment('<environment_id>'))
+     *   .then(environment => environment.invokeAiAction('<ai_action_id>', {
+     *     variables: [  ...  ],
+     *     outputFormat: 'RichText'
+     *   }))
+     *   .then(invocation => console.log(invocation))
+     *   .catch(console.error)
+     * ```
+     */
+    invokeAiAction(aiActionId: string, payload: AiActionInvocationType) {
+      const raw = this.toPlainObject() as EnvironmentProps
+      return makeRequest({
+        entityType: 'AiAction',
+        action: 'invoke',
+        params: { spaceId: raw.sys.space.sys.id, environmentId: raw.sys.id, aiActionId },
+        payload,
+      }).then((data) => wrapAiActionInvocation(makeRequest, data))
+    },
+
+    /**
+     * Retrieves an AI Action Invocation.
+     * @param params - Object containing the AI Action ID and the Invocation ID.
+     * @returns Promise for an AI Action Invocation.
+     * @example ```javascript
+     * client.getSpace('<space_id>')
+     *   .then(space => space.getEnvironment('<environment_id>'))
+     *   .then(environment => environment.getAiActionInvocation({
+     *      aiActionId: '<ai_action_id>',
+     *      invocationId: '<invocation_id>'
+     *   }))
+     *   .then(invocation => console.log(invocation))
+     *   .catch(console.error)
+     * ```
+     */
+    getAiActionInvocation({
+      aiActionId,
+      invocationId,
+    }: {
+      aiActionId: string
+      invocationId: string
+    }) {
+      const raw = this.toPlainObject() as EnvironmentProps
+      return makeRequest({
+        entityType: 'AiActionInvocation',
+        action: 'get',
+        params: {
+          spaceId: raw.sys.space.sys.id,
+          environmentId: raw.sys.id,
+          aiActionId,
+          invocationId,
+        },
+      }).then((data) => wrapAiActionInvocation(makeRequest, data))
+    },
   }
 }