contentful-management 11.44.0 → 11.45.0-beta.1

package/dist/typings/entities/function-log.d.ts

@@ -0,0 +1,46 @@
+import type { Link, DefaultElements } from '../common-types';
+import type { MakeRequest } from '../common-types';
+export type FunctionLogProps = {
+    sys: {
+        id: string;
+        type: 'FunctionLog';
+        createdBy: Link<'User'>;
+        createdAt: string;
+        space: Link<'Space'>;
+        environment: Link<'Environment'>;
+        appDefinition: Link<'AppDefinition'>;
+    };
+    severity: {
+        info: number;
+        warn: number;
+        error: number;
+    };
+    requestId: string;
+    event: {
+        type: string;
+        query: string;
+        isIntrospectionQuery: boolean;
+        variables: Record<string, any>;
+    };
+    messages: Array<{
+        timestamp: number;
+        type: 'INFO' | 'ERROR' | 'WARN';
+        message: string;
+    }>;
+};
+export interface FunctionLog extends FunctionLogProps, DefaultElements<FunctionLogProps> {
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - raw contentful-Function data
+ * @return Wrapped Function data
+ */
+export declare function wrapFunctionLog(makeRequest: MakeRequest, data: FunctionLogProps): FunctionLogProps;
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - raw contentful-function data
+ * @return Wrapped App Function collection data
+ */
+export declare const wrapFunctionLogCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<FunctionLogProps>) => import("../common-types").Collection<FunctionLogProps, FunctionLogProps>;

package/dist/typings/entities/function.d.ts

@@ -1,6 +1,5 @@
 import type { Link, DefaultElements } from '../common-types';
 import type { MakeRequest } from '../common-types';
-import createFunctionApi from '../create-function-api';
 export type FunctionProps = {
     sys: {
         id: string;
@@ -26,15 +25,8 @@ export interface Function extends FunctionProps, DefaultElements<FunctionProps>
  * @param data - raw contentful-Function data
  * @return Wrapped Function data
  */
-export declare function wrapFunction(makeRequest: MakeRequest, data: FunctionProps): FunctionProps & ReturnType<typeof createFunctionApi>;
+export declare function wrapFunction(makeRequest: MakeRequest, data: FunctionProps): FunctionProps;
 /**
  * @private
- * @param makeRequest - real) function to make requests via an adapter
- * @param data - raw contentful-function data
- * @return Wrapped App Function collection data
  */
-export declare const wrapFunctionCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<FunctionProps>) => import("../common-types").Collection<FunctionProps & {
-    getManyFunctions(): Promise<import("../common-types").Collection<FunctionProps & any, FunctionProps>>;
-    getFunction(functionId: string): Promise<FunctionProps & any>;
-    getManyFunctionsForEnvironment(spaceId: string, environmentId: string, appInstallationId: string): Promise<import("../common-types").Collection<FunctionProps & any, FunctionProps>>;
-}, FunctionProps>;
+export declare const wrapFunctionCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<FunctionProps>) => import("../common-types").Collection<FunctionProps, FunctionProps>;

package/dist/typings/entities/index.d.ts

@@ -24,6 +24,7 @@ import * as environmentTemplate from './environment-template';
 import * as environmentTemplateInstallation from './environment-template-installation';
 import * as extension from './extension';
 import * as func from './function';
+import * as functionLog from './function-log';
 import * as locale from './locale';
 import * as organization from './organization';
 import * as organizationInvitation from './organization-invitation';
@@ -86,6 +87,7 @@ declare const _default: {
     environmentTemplateInstallation: typeof environmentTemplateInstallation;
     extension: typeof extension;
     func: typeof func;
+    functionLog: typeof functionLog;
     locale: typeof locale;
     organization: typeof organization;
     organizationInvitation: typeof organizationInvitation;

package/dist/typings/plain/common-types.d.ts

@@ -63,6 +63,7 @@ import type { WorkflowPlainClientAPI } from './entities/workflow';
 import type { WorkflowDefinitionPlainClientAPI } from './entities/workflow-definition';
 import type { WorkflowsChangelogPlainClientAPI } from './entities/workflows-changelog';
 import type { DefaultParams, OptionalDefaults } from './wrappers/wrap';
+import type { FunctionLogPlainClientAPI } from './entities/function-log';
 export type PlainClientAPI = {
     raw: {
         getDefaultParams(): DefaultParams | undefined;
@@ -83,6 +84,7 @@ export type PlainClientAPI = {
     appSigningSecret: AppSigningSecretPlainClientAPI;
     appAccessToken: AppAccessTokenPlainClientAPI;
     function: FunctionPlainClientAPI;
+    functionLog: FunctionLogPlainClientAPI;
     editorInterface: EditorInterfacePlainClientAPI;
     space: SpacePlainClientAPI;
     environment: EnvironmentPlainClientAPI;

package/dist/typings/plain/entities/function-log.d.ts

@@ -0,0 +1,39 @@
+import type { CollectionProp, GetFunctionLogParams, GetManyFunctionLogParams } from '../../common-types';
+import type { FunctionLogProps } from '../../entities/function-log';
+import type { OptionalDefaults } from '../wrappers/wrap';
+export type FunctionLogPlainClientAPI = {
+    /**
+     * Fetches the specified FunctionLog
+     * @params spaceId, environmentId, appInstallationId, functionId, logId
+     * @returns the FunctionLog
+     * @throws if the request fails, or the FunctionLog is not found
+     * @example
+     * ```javascript
+     * const functionLog = await client.functionLog.get({
+     *    spaceId: '<space_id>',
+     *    environmentId: '<environment_id>',
+     *    appInstallationId: '<app_installation_id>',
+     *    functionId: '<function_id>',
+     *    logId: '<log_id>'
+     * });
+     * ```
+     */
+    get(params: OptionalDefaults<GetFunctionLogParams>): Promise<FunctionLogProps>;
+    /**
+     * Fetches all FunctionLogs for the given function
+     * @params spaceId, environmentId, appInstallationId, functionId, query
+     * @returns an object containing an array of FunctionLogs
+     * @throws if the request fails, or the FunctionLogs are not found
+     * @example
+     * ```javascript
+     * const functionLogs = await client.functionLog.getAll({
+     *    spaceId: '<space_id>',
+     *    environmentId: '<environment_id>',
+     *    appInstallationId: '<app_installation_id>',
+     *    functionId: '<function_id>',
+     *    query: { limit: 100 }
+     * });
+     * ```
+     */
+    getMany(params: OptionalDefaults<GetManyFunctionLogParams>): Promise<CollectionProp<FunctionLogProps>>;
+};

package/dist/typings/plain/entities/function.d.ts

@@ -4,7 +4,7 @@ import type { OptionalDefaults } from '../wrappers/wrap';
 export type FunctionPlainClientAPI = {
     /**
      * Fetches the specified Function
-     * @param params organization ID, app definition ID, entity ID to identify the function
+     * @params organizationId, appDefinitionId, functionId
      * @returns the Function
      * @throws if the request fails, or the Function is not found
      * @example
@@ -19,7 +19,7 @@ export type FunctionPlainClientAPI = {
     get(params: OptionalDefaults<GetFunctionParams>): Promise<FunctionProps>;
     /**
      * Fetches all Functions for the given app
-     * @param params organization ID, app definition ID to identify the functions
+     * @params organizationId, appDefinitionId, query
      * @returns an object containing an array of Functions
      * @throws if the request fails, or the App is not found
      * @example
@@ -27,13 +27,14 @@ export type FunctionPlainClientAPI = {
      * const functions = await client.function.getMany({
      *   organizationId: "<org_id>",
      *   appDefinitionId: "<app_definition_id>",
+     *   query: { 'accepts[all]': '<action>' },
      * });
      * ```
      */
     getMany(params: OptionalDefaults<GetManyFunctionParams>): Promise<CollectionProp<FunctionProps>>;
     /**
      * Fetches all Functions for the given environment
-     * @param params space ID, environment ID, app installation ID to identify the functions
+     * @params spaceId, environmentId, appInstallationId, query
      * @returns an object containing an array of Functions
      * @throws if the request fails, or the Environment is not found
      * @example
@@ -42,6 +43,7 @@ export type FunctionPlainClientAPI = {
      *   spaceId: "<space_id>",
      *   environmentId: "<environment_id>",
      *   appInstallationId: "<app_installation_id>",
+     *   query: { 'accepts[all]': '<action>' },
      * });
      * ```
      */

package/package.json

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

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

@@ -1,115 +0,0 @@
-import entities from './entities';
-
-/**
- * @private
- */
-
-/**
- * @private
- */
-export default function createFunctionApi(makeRequest) {
-  const {
-    wrapFunction,
-    wrapFunctionCollection
-  } = entities.func;
-  return {
-    /**
-     * Gets all Functions for an App Definition
-     * @Param organizationId - Organization ID
-     * @Param appDefinitionId - App Definition ID
-     * @returns a collection of Functions
-     * ```javascript
-     * const contentful = require('contentful-management')
-     *
-     * const client = contentful.createClient({
-     *   accessToken: '<content_management_api_key>'
-     * })
-     *
-     * client.function.getMany({
-     *   organizationId: <organizationId>,
-     *   appDefinitionId: <appDefinitionId>
-     * })
-     * .then((response) => console.log(response.items))
-     * .catch(console.error)
-     * ```
-     */
-    getManyFunctions() {
-      const raw = this.toPlainObject();
-      return makeRequest({
-        entityType: 'Function',
-        action: 'getMany',
-        params: {
-          appDefinitionId: raw.sys.appDefinition.sys.id,
-          organizationId: raw.sys.organization.sys.id
-        }
-      }).then(data => wrapFunctionCollection(makeRequest, data));
-    },
-    /**
-     * Gets a Function by ID
-     * @Param organizationId - Organization ID
-     * @Param appDefinitionId - App Definition ID
-     * @Param functionId - Function ID
-     * @returns a collection of Functions
-     * ```javascript
-     * const contentful = require('contentful-management')
-     *
-     * const client = contentful.createClient({
-     *   accessToken: '<content_management_api_key>'
-     * })
-     *
-     * client.function.get({
-     *   organizationId: <organizationId>,
-     *   appDefinitionId: <appDefinitionId>,
-     *   functionId: <functionId>
-     * })
-     * .then((response) => console.log(response.items))
-     * .catch(console.error)
-     * ```
-     */
-    getFunction(functionId) {
-      const raw = this.toPlainObject();
-      return makeRequest({
-        entityType: 'Function',
-        action: 'get',
-        params: {
-          appDefinitionId: raw.sys.appDefinition.sys.id,
-          organizationId: raw.sys.organization.sys.id,
-          functionId
-        }
-      }).then(data => wrapFunction(makeRequest, data));
-    },
-    /**
-     * Gets all Functions for an Environment
-     * @Param organizationId - Organization ID
-     * @Param appDefinitionId - App Definition ID
-     * @Param functionId - Function ID
-     * @returns a collection of Functions
-     * ```javascript
-     * const contentful = require('contentful-management')
-     *
-     * const client = contentful.createClient({
-     *   accessToken: '<content_management_api_key>'
-     * })
-     *
-     * client.function.get({
-     *   environmentId: <environmentId>,
-     *   spaceId: <spaceId>,
-     *   appInstallationId: <appInstallationId>
-     * })
-     * .then((response) => console.log(response.items))
-     * .catch(console.error)
-     * ```
-     */
-    getManyFunctionsForEnvironment(spaceId, environmentId, appInstallationId) {
-      return makeRequest({
-        entityType: 'Function',
-        action: 'getManyForEnvironment',
-        params: {
-          spaceId: spaceId,
-          environmentId: environmentId,
-          appInstallationId: appInstallationId
-        }
-      }).then(data => wrapFunctionCollection(makeRequest, data));
-    }
-  };
-}

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

@@ -1,78 +0,0 @@
-import type { MakeRequest } from './common-types';
-import type { FunctionProps } from './entities/function';
-/**
- * @private
- */
-export type ContentfulFunctionApi = ReturnType<typeof createFunctionApi>;
-/**
- * @private
- */
-export default function createFunctionApi(makeRequest: MakeRequest): {
-    /**
-     * Gets all Functions for an App Definition
-     * @Param organizationId - Organization ID
-     * @Param appDefinitionId - App Definition ID
-     * @returns a collection of Functions
-     * ```javascript
-     * const contentful = require('contentful-management')
-     *
-     * const client = contentful.createClient({
-     *   accessToken: '<content_management_api_key>'
-     * })
-     *
-     * client.function.getMany({
-     *   organizationId: <organizationId>,
-     *   appDefinitionId: <appDefinitionId>
-     * })
-     * .then((response) => console.log(response.items))
-     * .catch(console.error)
-     * ```
-     */
-    getManyFunctions(): Promise<import("./common-types").Collection<FunctionProps & any, FunctionProps>>;
-    /**
-     * Gets a Function by ID
-     * @Param organizationId - Organization ID
-     * @Param appDefinitionId - App Definition ID
-     * @Param functionId - Function ID
-     * @returns a collection of Functions
-     * ```javascript
-     * const contentful = require('contentful-management')
-     *
-     * const client = contentful.createClient({
-     *   accessToken: '<content_management_api_key>'
-     * })
-     *
-     * client.function.get({
-     *   organizationId: <organizationId>,
-     *   appDefinitionId: <appDefinitionId>,
-     *   functionId: <functionId>
-     * })
-     * .then((response) => console.log(response.items))
-     * .catch(console.error)
-     * ```
-     */
-    getFunction(functionId: string): Promise<FunctionProps & any>;
-    /**
-     * Gets all Functions for an Environment
-     * @Param organizationId - Organization ID
-     * @Param appDefinitionId - App Definition ID
-     * @Param functionId - Function ID
-     * @returns a collection of Functions
-     * ```javascript
-     * const contentful = require('contentful-management')
-     *
-     * const client = contentful.createClient({
-     *   accessToken: '<content_management_api_key>'
-     * })
-     *
-     * client.function.get({
-     *   environmentId: <environmentId>,
-     *   spaceId: <spaceId>,
-     *   appInstallationId: <appInstallationId>
-     * })
-     * .then((response) => console.log(response.items))
-     * .catch(console.error)
-     * ```
-     */
-    getManyFunctionsForEnvironment(spaceId: string, environmentId: string, appInstallationId: string): Promise<import("./common-types").Collection<FunctionProps & any, FunctionProps>>;
-};