contentful-management 11.47.2 → 11.47.3

package/dist/es-modules/contentful-management.js

@@ -47,7 +47,7 @@ function createClient(params, opts = {}) {
   const sdkMain = opts.type === 'plain' ? 'contentful-management-plain.js' : 'contentful-management.js';
   const userAgent = getUserAgentHeader(
   // @ts-expect-error
-  `${sdkMain}/${"11.47.2"}`, params.application, params.integration, params.feature);
+  `${sdkMain}/${"11.47.3"}`, params.application, params.integration, params.feature);
   const adapter = createAdapter(_objectSpread(_objectSpread({}, params), {}, {
     userAgent
   }));

package/dist/es-modules/entities/app-action.js

@@ -2,6 +2,15 @@ import { freezeSys, toPlainObject } from 'contentful-sdk-core';
 import copy from 'fast-copy';
 import { wrapCollection } from '../common-utils';
 import enhanceWithMethods from '../enhance-with-methods';
+
+/**
+ * 'function' is deprecated, use 'function-invocation' instead
+ */
+
+/**
+ * @deprecated Use FunctionAppActionProps instead
+ */
+
 /**
  * @private
  */

package/dist/typings/create-organization-api.d.ts

@@ -677,10 +677,52 @@ export default function createOrganizationApi(makeRequest: MakeRequest): {
             appDefinition: import("./common-types").SysLink;
             organization: import("./common-types").SysLink;
         };
+        name: string;
+        description?: string;
+    } & Record<string, unknown> & {
+        type: "function";
+    } & import("./common-types").DefaultElements<import("./entities/app-action").AppActionProps> & {
+        delete(): Promise<void>;
+    }) | ({
+        category: "Entries.v1.0" | "Notification.v1.0";
+    } & {
+        sys: {
+            type: string;
+            id: string;
+            createdBy?: import("./common-types").SysLink | undefined;
+            createdAt: string;
+            updatedBy?: import("./common-types").SysLink | undefined;
+            updatedAt: string;
+        } & {
+            appDefinition: import("./common-types").SysLink;
+            organization: import("./common-types").SysLink;
+        };
+        name: string;
+        description?: string;
+    } & {
+        type: "endpoint";
         url: string;
+    } & import("./common-types").DefaultElements<import("./entities/app-action").AppActionProps> & {
+        delete(): Promise<void>;
+    }) | ({
+        category: "Entries.v1.0" | "Notification.v1.0";
+    } & {
+        sys: {
+            type: string;
+            id: string;
+            createdBy?: import("./common-types").SysLink | undefined;
+            createdAt: string;
+            updatedBy?: import("./common-types").SysLink | undefined;
+            updatedAt: string;
+        } & {
+            appDefinition: import("./common-types").SysLink;
+            organization: import("./common-types").SysLink;
+        };
         name: string;
         description?: string;
-        type?: import("./entities/app-action").AppActionType;
+    } & {
+        type: "function-invocation";
+        function: import("./common-types").Link<"Function">;
     } & import("./common-types").DefaultElements<import("./entities/app-action").AppActionProps> & {
         delete(): Promise<void>;
     }) | ({
@@ -698,10 +740,54 @@ export default function createOrganizationApi(makeRequest: MakeRequest): {
             appDefinition: import("./common-types").SysLink;
             organization: import("./common-types").SysLink;
         };
+        name: string;
+        description?: string;
+    } & Record<string, unknown> & {
+        type: "function";
+    } & import("./common-types").DefaultElements<import("./entities/app-action").AppActionProps> & {
+        delete(): Promise<void>;
+    }) | ({
+        category: "Custom";
+        parameters: import("./entities/app-action").AppActionParameterDefinition[];
+    } & {
+        sys: {
+            type: string;
+            id: string;
+            createdBy?: import("./common-types").SysLink | undefined;
+            createdAt: string;
+            updatedBy?: import("./common-types").SysLink | undefined;
+            updatedAt: string;
+        } & {
+            appDefinition: import("./common-types").SysLink;
+            organization: import("./common-types").SysLink;
+        };
+        name: string;
+        description?: string;
+    } & {
+        type: "endpoint";
         url: string;
+    } & import("./common-types").DefaultElements<import("./entities/app-action").AppActionProps> & {
+        delete(): Promise<void>;
+    }) | ({
+        category: "Custom";
+        parameters: import("./entities/app-action").AppActionParameterDefinition[];
+    } & {
+        sys: {
+            type: string;
+            id: string;
+            createdBy?: import("./common-types").SysLink | undefined;
+            createdAt: string;
+            updatedBy?: import("./common-types").SysLink | undefined;
+            updatedAt: string;
+        } & {
+            appDefinition: import("./common-types").SysLink;
+            organization: import("./common-types").SysLink;
+        };
         name: string;
         description?: string;
-        type?: import("./entities/app-action").AppActionType;
+    } & {
+        type: "function-invocation";
+        function: import("./common-types").Link<"Function">;
     } & import("./common-types").DefaultElements<import("./entities/app-action").AppActionProps> & {
         delete(): Promise<void>;
     })>;
@@ -738,10 +824,73 @@ export default function createOrganizationApi(makeRequest: MakeRequest): {
             appDefinition: import("./common-types").SysLink;
             organization: import("./common-types").SysLink;
         };
+        name: string;
+        description?: string;
+    } & Record<string, unknown> & {
+        type: "function";
+    } & import("./common-types").DefaultElements<import("./entities/app-action").AppActionProps> & {
+        delete(): Promise<void>;
+    }) | ({
+        category: "Entries.v1.0" | "Notification.v1.0";
+    } & {
+        sys: {
+            type: string;
+            id: string;
+            createdBy?: import("./common-types").SysLink | undefined;
+            createdAt: string;
+            updatedBy?: import("./common-types").SysLink | undefined;
+            updatedAt: string;
+        } & {
+            appDefinition: import("./common-types").SysLink;
+            organization: import("./common-types").SysLink;
+        };
+        name: string;
+        description?: string;
+    } & {
+        type: "endpoint";
         url: string;
+    } & import("./common-types").DefaultElements<import("./entities/app-action").AppActionProps> & {
+        delete(): Promise<void>;
+    }) | ({
+        category: "Entries.v1.0" | "Notification.v1.0";
+    } & {
+        sys: {
+            type: string;
+            id: string;
+            createdBy?: import("./common-types").SysLink | undefined;
+            createdAt: string;
+            updatedBy?: import("./common-types").SysLink | undefined;
+            updatedAt: string;
+        } & {
+            appDefinition: import("./common-types").SysLink;
+            organization: import("./common-types").SysLink;
+        };
+        name: string;
+        description?: string;
+    } & {
+        type: "function-invocation";
+        function: import("./common-types").Link<"Function">;
+    } & import("./common-types").DefaultElements<import("./entities/app-action").AppActionProps> & {
+        delete(): Promise<void>;
+    }) | ({
+        category: "Custom";
+        parameters: import("./entities/app-action").AppActionParameterDefinition[];
+    } & {
+        sys: {
+            type: string;
+            id: string;
+            createdBy?: import("./common-types").SysLink | undefined;
+            createdAt: string;
+            updatedBy?: import("./common-types").SysLink | undefined;
+            updatedAt: string;
+        } & {
+            appDefinition: import("./common-types").SysLink;
+            organization: import("./common-types").SysLink;
+        };
         name: string;
         description?: string;
-        type?: import("./entities/app-action").AppActionType;
+    } & Record<string, unknown> & {
+        type: "function";
     } & import("./common-types").DefaultElements<import("./entities/app-action").AppActionProps> & {
         delete(): Promise<void>;
     }) | ({
@@ -759,10 +908,33 @@ export default function createOrganizationApi(makeRequest: MakeRequest): {
             appDefinition: import("./common-types").SysLink;
             organization: import("./common-types").SysLink;
         };
+        name: string;
+        description?: string;
+    } & {
+        type: "endpoint";
         url: string;
+    } & import("./common-types").DefaultElements<import("./entities/app-action").AppActionProps> & {
+        delete(): Promise<void>;
+    }) | ({
+        category: "Custom";
+        parameters: import("./entities/app-action").AppActionParameterDefinition[];
+    } & {
+        sys: {
+            type: string;
+            id: string;
+            createdBy?: import("./common-types").SysLink | undefined;
+            createdAt: string;
+            updatedBy?: import("./common-types").SysLink | undefined;
+            updatedAt: string;
+        } & {
+            appDefinition: import("./common-types").SysLink;
+            organization: import("./common-types").SysLink;
+        };
         name: string;
         description?: string;
-        type?: import("./entities/app-action").AppActionType;
+    } & {
+        type: "function-invocation";
+        function: import("./common-types").Link<"Function">;
     } & import("./common-types").DefaultElements<import("./entities/app-action").AppActionProps> & {
         delete(): Promise<void>;
     })>;
@@ -811,10 +983,73 @@ export default function createOrganizationApi(makeRequest: MakeRequest): {
             appDefinition: import("./common-types").SysLink;
             organization: import("./common-types").SysLink;
         };
+        name: string;
+        description?: string;
+    } & Record<string, unknown> & {
+        type: "function";
+    } & import("./common-types").DefaultElements<import("./entities/app-action").AppActionProps> & {
+        delete(): Promise<void>;
+    }) | ({
+        category: "Entries.v1.0" | "Notification.v1.0";
+    } & {
+        sys: {
+            type: string;
+            id: string;
+            createdBy?: import("./common-types").SysLink | undefined;
+            createdAt: string;
+            updatedBy?: import("./common-types").SysLink | undefined;
+            updatedAt: string;
+        } & {
+            appDefinition: import("./common-types").SysLink;
+            organization: import("./common-types").SysLink;
+        };
+        name: string;
+        description?: string;
+    } & {
+        type: "endpoint";
         url: string;
+    } & import("./common-types").DefaultElements<import("./entities/app-action").AppActionProps> & {
+        delete(): Promise<void>;
+    }) | ({
+        category: "Entries.v1.0" | "Notification.v1.0";
+    } & {
+        sys: {
+            type: string;
+            id: string;
+            createdBy?: import("./common-types").SysLink | undefined;
+            createdAt: string;
+            updatedBy?: import("./common-types").SysLink | undefined;
+            updatedAt: string;
+        } & {
+            appDefinition: import("./common-types").SysLink;
+            organization: import("./common-types").SysLink;
+        };
+        name: string;
+        description?: string;
+    } & {
+        type: "function-invocation";
+        function: import("./common-types").Link<"Function">;
+    } & import("./common-types").DefaultElements<import("./entities/app-action").AppActionProps> & {
+        delete(): Promise<void>;
+    }) | ({
+        category: "Custom";
+        parameters: import("./entities/app-action").AppActionParameterDefinition[];
+    } & {
+        sys: {
+            type: string;
+            id: string;
+            createdBy?: import("./common-types").SysLink | undefined;
+            createdAt: string;
+            updatedBy?: import("./common-types").SysLink | undefined;
+            updatedAt: string;
+        } & {
+            appDefinition: import("./common-types").SysLink;
+            organization: import("./common-types").SysLink;
+        };
         name: string;
         description?: string;
-        type?: import("./entities/app-action").AppActionType;
+    } & Record<string, unknown> & {
+        type: "function";
     } & import("./common-types").DefaultElements<import("./entities/app-action").AppActionProps> & {
         delete(): Promise<void>;
     }) | ({
@@ -832,10 +1067,33 @@ export default function createOrganizationApi(makeRequest: MakeRequest): {
             appDefinition: import("./common-types").SysLink;
             organization: import("./common-types").SysLink;
         };
+        name: string;
+        description?: string;
+    } & {
+        type: "endpoint";
         url: string;
+    } & import("./common-types").DefaultElements<import("./entities/app-action").AppActionProps> & {
+        delete(): Promise<void>;
+    }) | ({
+        category: "Custom";
+        parameters: import("./entities/app-action").AppActionParameterDefinition[];
+    } & {
+        sys: {
+            type: string;
+            id: string;
+            createdBy?: import("./common-types").SysLink | undefined;
+            createdAt: string;
+            updatedBy?: import("./common-types").SysLink | undefined;
+            updatedAt: string;
+        } & {
+            appDefinition: import("./common-types").SysLink;
+            organization: import("./common-types").SysLink;
+        };
         name: string;
         description?: string;
-        type?: import("./entities/app-action").AppActionType;
+    } & {
+        type: "function-invocation";
+        function: import("./common-types").Link<"Function">;
     } & import("./common-types").DefaultElements<import("./entities/app-action").AppActionProps> & {
         delete(): Promise<void>;
     })>;

package/dist/typings/entities/app-action.d.ts

@@ -1,5 +1,5 @@
 import type { Except } from 'type-fest';
-import type { BasicMetaSysProps, DefaultElements, MakeRequest, SysLink } from '../common-types';
+import type { BasicMetaSysProps, DefaultElements, Link, MakeRequest, SysLink } from '../common-types';
 import type { ParameterDefinition } from './widget-parameters';
 type AppActionSys = Except<BasicMetaSysProps, 'version'> & {
     appDefinition: SysLink;
@@ -31,22 +31,15 @@ type CustomAppActionProps = {
 };
 type AppActionCategory = BuiltInCategoriesProps | CustomAppActionProps;
 export type AppActionCategoryType = AppActionCategory['category'];
+/**
+ * 'function' is deprecated, use 'function-invocation' instead
+ */
 export type AppActionType = 'endpoint' | 'function' | 'function-invocation';
-export type CreateAppActionProps = AppActionCategory & {
-    url: string;
-    name: string;
-    description?: string;
-    type?: AppActionType;
-};
-export type AppActionProps = AppActionCategory & {
+type BaseAppActionProps = AppActionCategory & {
     /**
      * System metadata
      */
     sys: AppActionSys;
-    /**
-     * Url that will be called when the action is invoked
-     */
-    url: string;
     /**
      * Human readable name for the action
      */
@@ -55,14 +48,66 @@ export type AppActionProps = AppActionCategory & {
      * Human readable description of the action
      */
     description?: string;
+};
+type CreateEndpointAppActionProps = {
     /**
      * Type of the action, defaults to endpoint if not provided
      * endpoint: action is sent to specified URL
-     * function: deprecated, use function-invocation instead
+     */
+    type?: 'endpoint';
+    /**
+     * Url that will be called when the action is invoked
+     */
+    url: string;
+};
+type EndpointAppActionProps = {
+    /**
+     * Type of the action
+     * endpoint: action is sent to specified URL
+     */
+    type: 'endpoint';
+    /**
+     * Url that will be called when the action is invoked
+     */
+    url: string;
+};
+type CreateFunctionAppActionProps = {
+    /**
+     * Type of the action
      * function-invocation: action invokes a contentful function
      */
-    type?: AppActionType;
+    type: 'function-invocation';
+    /**
+     * Link to a Function
+     */
+    function: Link<'Function'>;
+    /**
+     * ID of the action
+     */
+    id?: string;
 };
+type FunctionAppActionProps = {
+    /**
+     * Type of the action
+     * function-invocation: action invokes a contentful function
+     */
+    type: 'function-invocation';
+    /**
+     * Link to a Function
+     */
+    function: Link<'Function'>;
+};
+/**
+ * @deprecated Use FunctionAppActionProps instead
+ */
+type LegacyFunctionAppActionProps = Record<string, unknown> & {
+    type: 'function';
+};
+export type CreateAppActionProps = AppActionCategory & {
+    name: string;
+    description?: string;
+} & (CreateEndpointAppActionProps | CreateFunctionAppActionProps | LegacyFunctionAppActionProps);
+export type AppActionProps = BaseAppActionProps & (EndpointAppActionProps | FunctionAppActionProps | LegacyFunctionAppActionProps);
 export type AppAction = AppActionProps & DefaultElements<AppActionProps> & {
     /**
      * Deletes this object on the server.

package/dist/typings/plain/entities/app-action.d.ts

@@ -68,6 +68,7 @@ export type AppActionPlainClientAPI = {
      * @throws if the request fails, an entity is not found, or the payload is malformed
      * @example
      * ```javascript
+     * // app action that targets an endpoint url
      * const appAction = await client.appAction.create(
      *   {
      *     organizationId: "<org_id>",
@@ -81,6 +82,28 @@ export type AppActionPlainClientAPI = {
      *     name: "My Notification",
      *   }
      * );
+     *
+     * // app action that invokes a Contentful Function
+     * const functionAppAction = await client.appAction.create(
+     *  {
+     *    organizationId: '<org_id>',
+     *    appDefinitionId: '<app_definition_id>',
+     *    appActionId: '<app_action_id>',
+     *  },
+     *  {
+     *   type: "function-invocation",
+     *   function: {
+     *     sys: {
+     *       type: "Link",
+     *       linkType: "Function",
+     *       id: '<function_id>'
+     *     }
+     *   },
+     *   category: "Notification.v1.0",
+     *   description: "sends a notification",
+     *   name: "Notification (Function Example)",
+     * }
+     *);
      * ```
      */
     create(params: OptionalDefaults<GetAppDefinitionParams>, payload: CreateAppActionProps): Promise<AppActionProps>;
@@ -92,6 +115,7 @@ export type AppActionPlainClientAPI = {
      * @throws if the request fails, the App Action is not found, or the payload is malformed
      * @example
      * ```javascript
+     * // app action that targets an endpoint url
      * const appAction = await client.appAction.update(
      *   {
      *     organizationId: "<org_id>",
@@ -105,6 +129,28 @@ export type AppActionPlainClientAPI = {
      *     name: "My Notification",
      *   }
      * );
+     *
+     * // app action that invokes a Contentful Function
+     * const functionAppAction = await client.appAction.update(
+     *  {
+     *    organizationId: '<org_id>',
+     *    appDefinitionId: '<app_definition_id>',
+     *    appActionId: '<app_action_id>',
+     *  },
+     *  {
+     *   type: "function-invocation",
+     *   function: {
+     *     sys: {
+     *       type: "Link",
+     *       linkType: "Function",
+     *       id: '<function_id>'
+     *     }
+     *   },
+     *   category: "Notification.v1.0",
+     *   description: "sends a notification",
+     *   name: "Notification (Function Example)",
+     * }
+     *);
      * ```
      */
     update(params: OptionalDefaults<GetAppActionParams>, payload: CreateAppActionProps): Promise<AppActionProps>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentful-management",
-  "version": "11.47.2",
+  "version": "11.47.3",
   "description": "Client for Contentful's Content Management API",
   "homepage": "https://www.contentful.com/developers/documentation/content-management-api/",
   "main": "./dist/contentful-management.node.js",
@@ -26,6 +26,7 @@
   "scripts": {
     "clean": "rimraf dist",
     "build": "npm run clean && npm run build:modules && npm run build:standalone && npm run build:types",
+    "postbuild": "npm run test:demo-projects",
     "build:modules": "BABEL_ENV=modules babel --extensions \".ts\" --extensions \".js\" lib -d dist/es-modules/",
     "build:standalone": "webpack && NODE_ENV=production webpack",
     "build:standalone:log": "NODE_ENV=production WEBPACK_MODE=log webpack --json --profile --progress > webpack-build-log.json && webpack-bundle-analyzer webpack-build-log.json",
@@ -48,6 +49,9 @@
     "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",
+    "test:demo-projects": "npm run test:demo-node && npm run test:demo-browser",
+    "test:demo-node": "rimraf ./test/output-integration/node/node-modules && npm --prefix ./test/output-integration/node ci && vitest --run ./test/output-integration/node",
+    "test:demo-browser": "rimraf ./test/output-integration/browser/node-modules && npm --prefix ./test/output-integration/browser ci && npm --prefix ./test/output-integration/browser run test",
     "test:prepush": "npm run build && npm run test:unit && npm run test:size",
     "prettier": "prettier --write '**/*.{jsx,js,ts,tsx}'",
     "prettier:check": "prettier --check '**/*.{jsx,js,ts,tsx}'",
@@ -65,7 +69,8 @@
     "@contentful/rich-text-types": "^16.6.1",
     "axios": "^1.7.9",
     "contentful-sdk-core": "^9.0.1",
-    "fast-copy": "^3.0.0"
+    "fast-copy": "^3.0.0",
+    "globals": "^15.15.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.24.6",