contentful-management 11.47.2 → 11.48.0

package/dist/es-modules/common-types.js

@@ -14,6 +14,13 @@
 
 // Interfaces for each “exclusive” shape
 
+// Helper type for creating property paths with comparison operators
+// For example "sys.createdAt[gte]", P = sys.createdAt, O = gte
+
+// Helper types to ensure only one start operator can be used and only one end operator can be used
+
+// Type for valid date range combinations - only start, only end, or both
+
 /**
  * @private
  */

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.48.0"}`, params.application, params.integration, params.feature);
   const adapter = createAdapter(_objectSpread(_objectSpread({}, params), {}, {
     userAgent
   }));

package/dist/es-modules/create-environment-api.js

@@ -1713,7 +1713,17 @@ export default function createEnvironmentApi(makeRequest) {
      *       environment.getFunctionLogs(
      *          '<app-installation-id>',
      *          '<function-id>',
-     *          { limit: 10 },
+     *          {
+     *            query: {
+     *              // optional limit
+     *              limit: 10,
+     *              // optional interval query
+     *              'sys.createdAt[gte]': start,
+     *              'sys.createdAt[lt]': end,
+     *              // optional cursor based pagination parameters
+     *              pagePrev: '<page_prev>',
+     *            },
+     *          },
      *       )
      *     )
      *     .then((functionLogs) => console.log(functionLog.items))

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/common-types.d.ts

@@ -222,6 +222,19 @@ interface CursorPaginationNone extends CursorPaginationBase {
     pageNext?: never;
     pagePrev?: never;
 }
+type StartOperator = 'gt' | 'gte';
+type EndOperator = 'lt' | 'lte';
+type ComparisonOperator = StartOperator | EndOperator;
+type WithComparisonOperator<P extends string, O extends ComparisonOperator> = `${P}[${O}]`;
+type WithOneOperator<P extends string, C extends ComparisonOperator, O extends C> = {
+    [K in WithComparisonOperator<P, O>]: string | Date;
+} & {
+    [K in WithComparisonOperator<P, Exclude<C, O>>]?: never;
+};
+type WithStartOperator<P extends string> = WithOneOperator<P, StartOperator, 'gt'> | WithOneOperator<P, StartOperator, 'gte'>;
+type WithEndOperator<P extends string> = WithOneOperator<P, EndOperator, 'lt'> | WithOneOperator<P, EndOperator, 'lte'>;
+type IntervalQuery<P extends string> = Partial<WithStartOperator<P>> | Partial<WithEndOperator<P>> | (Partial<WithStartOperator<P>> & Partial<WithEndOperator<P>>);
+export type CreatedAtIntervalQueryOptions = IntervalQuery<'sys.createdAt'>;
 export interface AcceptsQueryOptions {
     'accepts[all]'?: string;
 }
@@ -2450,7 +2463,7 @@ export type GetManyFunctionParams = AcceptsQueryParams & GetAppDefinitionParams;
 export type GetFunctionForEnvParams = AcceptsQueryParams & GetSpaceEnvironmentParams & {
     appInstallationId: string;
 };
-export type GetManyFunctionLogParams = CursorBasedParams & GetFunctionForEnvParams & {
+export type GetManyFunctionLogParams = CursorBasedParams & CreatedAtIntervalParams & GetFunctionForEnvParams & {
     functionId: string;
 };
 export type GetFunctionLogParams = GetManyFunctionLogParams & {
@@ -2592,6 +2605,9 @@ export type CursorPaginationXORParams = {
     };
 };
 export type CursorBasedParams = CursorPaginationXORParams;
+export type CreatedAtIntervalParams = {
+    query?: CreatedAtIntervalQueryOptions;
+};
 export type AcceptsQueryParams = {
     query?: AcceptsQueryOptions;
 };

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

@@ -1,5 +1,5 @@
 import type { Stream } from 'stream';
-import type { AcceptsQueryOptions, BasicCursorPaginationOptions, CursorBasedParams, QueryOptions } from './common-types';
+import type { AcceptsQueryOptions, BasicCursorPaginationOptions, CreatedAtIntervalParams, CursorBasedParams, QueryOptions } from './common-types';
 import type { BasicQueryOptions, MakeRequest } from './common-types';
 import type { CreateAppInstallationProps } from './entities/app-installation';
 import type { CreateAppSignedRequestProps } from './entities/app-signed-request';
@@ -1164,14 +1164,24 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
      *       environment.getFunctionLogs(
      *          '<app-installation-id>',
      *          '<function-id>',
-     *          { limit: 10 },
+     *          {
+     *            query: {
+     *              // optional limit
+     *              limit: 10,
+     *              // optional interval query
+     *              'sys.createdAt[gte]': start,
+     *              'sys.createdAt[lt]': end,
+     *              // optional cursor based pagination parameters
+     *              pagePrev: '<page_prev>',
+     *            },
+     *          },
      *       )
      *     )
      *     .then((functionLogs) => console.log(functionLog.items))
      *     .catch(console.error)
      * ```
      */
-    getFunctionLogs(appInstallationId: string, functionId: string, query?: CursorBasedParams): Promise<import("./common-types").Collection<import("./entities/function-log").FunctionLogProps, import("./entities/function-log").FunctionLogProps>>;
+    getFunctionLogs(appInstallationId: string, functionId: string, query?: CursorBasedParams & CreatedAtIntervalParams): Promise<import("./common-types").Collection<import("./entities/function-log").FunctionLogProps, import("./entities/function-log").FunctionLogProps>>;
     /**
      * Gets a FunctionLog by appInstallationId, functionId and logId
      * @param appInstallationId

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/dist/typings/plain/entities/function-log.d.ts

@@ -26,12 +26,24 @@ export type FunctionLogPlainClientAPI = {
      * @throws if the request fails, or the FunctionLogs are not found
      * @example
      * ```javascript
-     * const functionLogs = await client.functionLog.getAll({
+     * const start = new Date()
+     * const end = new Date()
+     * start.setHours(start.getHours() - 1)
+     *
+     * const functionLogs = await client.functionLog.getMany({
      *    spaceId: '<space_id>',
      *    environmentId: '<environment_id>',
      *    appInstallationId: '<app_installation_id>',
      *    functionId: '<function_id>',
-     *    query: { limit: 100 }
+     *    query: {
+     *      // optional limit
+     *      limit: 10,
+     *      // optional interval query
+     *      'sys.createdAt[gte]': start,
+     *      'sys.createdAt[lt]': end,
+     *      // optional cursor based pagination parameters
+     *      pageNext: '<page_next>',
+     *    }
      * });
      * ```
      */