contentful-management 11.47.3 → 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.3"}`, 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/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/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>',
+     *    }
      * });
      * ```
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentful-management",
-  "version": "11.47.3",
+  "version": "11.48.0",
   "description": "Client for Contentful's Content Management API",
   "homepage": "https://www.contentful.com/developers/documentation/content-management-api/",
   "main": "./dist/contentful-management.node.js",