contentful-management 11.43.0-beta.1 → 11.43.0-beta.2

package/dist/es-modules/adapters/REST/endpoints/function-log.js

@@ -0,0 +1,21 @@
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+import * as raw from './raw';
+const FunctionLogAlphaHeaders = {
+  'x-contentful-enable-alpha-feature': 'function-logs'
+};
+const baseURL = params => `/spaces/${params.spaceId}/environments/${params.environmentId}/app_installations/${params.appInstallationId}/functions/${params.functionId}/logs`;
+const getURL = params => `/spaces/${params.spaceId}/environments/${params.environmentId}/app_installations/${params.appInstallationId}/functions/${params.functionId}/logs/${params.logId}`;
+export const get = (http, params) => {
+  return raw.get(http, getURL(params), {
+    headers: _objectSpread({}, FunctionLogAlphaHeaders)
+  });
+};
+export const getAll = (http, params) => {
+  return raw.get(http, baseURL(params), {
+    headers: _objectSpread({}, FunctionLogAlphaHeaders)
+  });
+};

package/dist/es-modules/adapters/REST/endpoints/index.js

@@ -27,6 +27,7 @@ import * as EnvironmentTemplate from './environment-template';
 import * as EnvironmentTemplateInstallation from './environment-template-installation';
 import * as Extension from './extension';
 import * as Function from './function';
+import * as FunctionLog from './function-log';
 import * as Http from './http';
 import * as Locale from './locale';
 import * as Organization from './organization';
@@ -89,6 +90,7 @@ export default {
   EnvironmentTemplateInstallation,
   Extension,
   Function,
+  FunctionLog,
   Http,
   Locale,
   Organization,

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

@@ -46,7 +46,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.43.0-beta.1"}`, params.application, params.integration, params.feature);
+  `${sdkMain}/${"11.43.0-beta.2"}`, params.application, params.integration, params.feature);
   const adapter = createAdapter(_objectSpread(_objectSpread({}, params), {}, {
     userAgent
   }));

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

@@ -0,0 +1,94 @@
+import entities from './entities';
+import { wrapFunctionLogCollection } from './entities/function-log';
+
+/**
+ * @private
+ */
+
+/**
+ * @private
+ */
+export default function createFunctionLogApi(makeRequest) {
+  const {
+    wrapFunctionLog
+  } = entities.functionLog;
+  return {
+    /**
+     * Get a FunctionLog by it's log ID
+     * @Param spaceId - Space ID
+     * @Param environmentId - Environment ID
+     * @Param appInstallationId - App Installation ID
+     * @Param functionId - Function ID
+     * @Param logId - Log ID
+     * @returns a function log
+     * ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *    accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.functionLog.get({
+     *    spaceId: '<space_id>',
+     *    environmentId: '<environment_id>',
+     *    appInstallationId: '<app_installation_id>',
+     *    functionId: '<function_id>',
+     *    logId: '<log_id>'
+     * })
+     * .then((response) => console.log(response.items))
+     * .catch(console.error)
+     * ```
+     */
+    get(logId) {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'FunctionLog',
+        action: 'get',
+        params: {
+          spaceId: raw.sys.space.sys.id,
+          environmentId: raw.sys.environment.sys.id,
+          appInstallationId: raw.sys.appDefinition.sys.id,
+          functionId: raw.sys.id,
+          logId: logId
+        }
+      }).then(data => wrapFunctionLog(makeRequest, data));
+    },
+    /**
+     * Get all FunctionLogs
+     * @Param spaceId - Space ID
+     * @Param environmentId - Environment ID
+     * @Param appInstallationId - App Installation ID
+     * @Param functionId - Function ID
+     * @returns a collection of FunctionLogs
+     * ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *    accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.functionLog.getAll({
+     *    spaceId: '<space_id>',
+     *    environmentId: '<environment_id>',
+     *    appInstallationId: '<app_installation_id>',
+     *    functionId: '<function_id>'
+     * })
+     * .then((response) => console.log(response.items))
+     * .catch(console.error)
+     * ```
+     */
+    getAll() {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'FunctionLog',
+        action: 'getAll',
+        params: {
+          spaceId: raw.sys.space.sys.id,
+          environmentId: raw.sys.environment.sys.id,
+          appInstallationId: raw.sys.appDefinition.sys.id,
+          functionId: raw.sys.id
+        }
+      }).then(data => wrapFunctionLogCollection(makeRequest, data));
+    }
+  };
+}

package/dist/es-modules/entities/function-log.js

@@ -0,0 +1,24 @@
+import { freezeSys, toPlainObject } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils';
+import enhanceWithMethods from '../enhance-with-methods';
+import createFunctionLogApi from '../create-function-log-api';
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - raw contentful-Function data
+ * @return Wrapped Function data
+ */
+export function wrapFunctionLog(makeRequest, data) {
+  const appAction = toPlainObject(copy(data));
+  const appActionWithMethods = enhanceWithMethods(appAction, createFunctionLogApi(makeRequest));
+  return freezeSys(appActionWithMethods);
+}
+
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - raw contentful-function data
+ * @return Wrapped App Function collection data
+ */
+export const wrapFunctionLogCollection = wrapCollection(wrapFunctionLog);

package/dist/es-modules/entities/index.js

@@ -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 @@ export default {
   environmentTemplateInstallation,
   extension,
   func,
+  functionLog,
   locale,
   organization,
   organizationInvitation,

package/dist/es-modules/plain/entities/function-log.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/plain-client.js

@@ -143,6 +143,10 @@ export const createPlainClient = (makeRequest, defaults) => {
       getMany: wrap(wrapParams, 'Function', 'getMany'),
       getManyForEnvironment: wrap(wrapParams, 'Function', 'getManyForEnvironment')
     },
+    functionLog: {
+      get: wrap(wrapParams, 'FunctionLog', 'get'),
+      getAll: wrap(wrapParams, 'FunctionLog', 'getAll')
+    },
     editorInterface: {
       get: wrap(wrapParams, 'EditorInterface', 'get'),
       getMany: wrap(wrapParams, 'EditorInterface', 'getMany'),

package/dist/typings/adapters/REST/endpoints/function-log.d.ts

@@ -0,0 +1,3 @@
+import type { RestEndpoint } from '../types';
+export declare const get: RestEndpoint<'FunctionLog', 'get'>;
+export declare const getAll: RestEndpoint<'FunctionLog', 'getAll'>;

package/dist/typings/adapters/REST/endpoints/index.d.ts

@@ -27,6 +27,7 @@ import * as EnvironmentTemplate from './environment-template';
 import * as EnvironmentTemplateInstallation from './environment-template-installation';
 import * as Extension from './extension';
 import * as Function from './function';
+import * as FunctionLog from './function-log';
 import * as Http from './http';
 import * as Locale from './locale';
 import * as Organization from './organization';
@@ -89,6 +90,7 @@ declare const _default: {
     EnvironmentTemplateInstallation: typeof EnvironmentTemplateInstallation;
     Extension: typeof Extension;
     Function: typeof Function;
+    FunctionLog: typeof FunctionLog;
     Http: typeof Http;
     Locale: typeof Locale;
     Organization: typeof Organization;

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

@@ -60,6 +60,7 @@ import type { UserUIConfigProps } from './entities/user-ui-config';
 import type { CompleteWorkflowParams, CreateWorkflowParams, CreateWorkflowProps, DeleteWorkflowParams, WorkflowProps, WorkflowQueryOptions } from './entities/workflow';
 import type { CreateWorkflowDefinitionParams, CreateWorkflowDefinitionProps, DeleteWorkflowDefinitionParams, WorkflowDefinitionProps, WorkflowDefinitionQueryOptions } from './entities/workflow-definition';
 import type { WorkflowsChangelogEntryProps, WorkflowsChangelogQueryOptions } from './entities/workflows-changelog-entry';
+import type { FunctionLogProps } from './entities/function-log';
 export interface DefaultElements<TPlainObject extends object = object> {
     toPlainObject(): TPlainObject;
 }
@@ -363,6 +364,8 @@ type MRInternal<UA extends boolean> = {
     (opts: MROpts<'Function', 'get', UA>): MRReturn<'Function', 'get'>;
     (opts: MROpts<'Function', 'getMany', UA>): MRReturn<'Function', 'getMany'>;
     (opts: MROpts<'Function', 'getManyForEnvironment', UA>): MRReturn<'Function', 'getManyForEnvironment'>;
+    (opts: MROpts<'FunctionLog', 'get', UA>): MRReturn<'FunctionLog', 'get'>;
+    (opts: MROpts<'FunctionLog', 'getAll', UA>): MRReturn<'FunctionLog', 'getAll'>;
     (opts: MROpts<'Locale', 'get', UA>): MRReturn<'Locale', 'get'>;
     (opts: MROpts<'Locale', 'getMany', UA>): MRReturn<'Locale', 'getMany'>;
     (opts: MROpts<'Locale', 'delete', UA>): MRReturn<'Locale', 'delete'>;
@@ -1497,6 +1500,18 @@ export type MRActions = {
             return: CollectionProp<FunctionProps>;
         };
     };
+    FunctionLog: {
+        get: {
+            params: GetFunctionLogParams;
+            return: FunctionLogProps;
+            headers?: RawAxiosRequestHeaders;
+        };
+        getAll: {
+            params: GetAllFunctionLogParams;
+            return: CollectionProp<FunctionLogProps>;
+            headers?: RawAxiosRequestHeaders;
+        };
+    };
     Locale: {
         get: {
             params: GetSpaceEnvironmentParams & {
@@ -2385,6 +2400,12 @@ export type GetManyFunctionParams = GetAppDefinitionParams;
 export type GetFunctionForEnvParams = GetSpaceEnvironmentParams & {
     appInstallationId: string;
 };
+export type GetAllFunctionLogParams = GetFunctionForEnvParams & {
+    functionId: string;
+};
+export type GetFunctionLogParams = GetAllFunctionLogParams & {
+    logId: string;
+};
 export type GetOrganizationParams = {
     organizationId: string;
 };

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

@@ -0,0 +1,63 @@
+import type { MakeRequest } from './common-types';
+import type { FunctionLogProps } from './entities/function-log';
+/**
+ * @private
+ */
+export type ContentfulFunctionLogApi = ReturnType<typeof createFunctionLogApi>;
+/**
+ * @private
+ */
+export default function createFunctionLogApi(makeRequest: MakeRequest): {
+    /**
+     * Get a FunctionLog by it's log ID
+     * @Param spaceId - Space ID
+     * @Param environmentId - Environment ID
+     * @Param appInstallationId - App Installation ID
+     * @Param functionId - Function ID
+     * @Param logId - Log ID
+     * @returns a function log
+     * ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *    accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.functionLog.get({
+     *    spaceId: '<space_id>',
+     *    environmentId: '<environment_id>',
+     *    appInstallationId: '<app_installation_id>',
+     *    functionId: '<function_id>',
+     *    logId: '<log_id>'
+     * })
+     * .then((response) => console.log(response.items))
+     * .catch(console.error)
+     * ```
+     */
+    get(logId: string): Promise<FunctionLogProps & any>;
+    /**
+     * Get all FunctionLogs
+     * @Param spaceId - Space ID
+     * @Param environmentId - Environment ID
+     * @Param appInstallationId - App Installation ID
+     * @Param functionId - Function ID
+     * @returns a collection of FunctionLogs
+     * ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *    accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.functionLog.getAll({
+     *    spaceId: '<space_id>',
+     *    environmentId: '<environment_id>',
+     *    appInstallationId: '<app_installation_id>',
+     *    functionId: '<function_id>'
+     * })
+     * .then((response) => console.log(response.items))
+     * .catch(console.error)
+     * ```
+     */
+    getAll(): Promise<import("./common-types").Collection<FunctionLogProps & any, FunctionLogProps>>;
+};

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

@@ -0,0 +1,50 @@
+import type { Link, DefaultElements } from '../common-types';
+import type { MakeRequest } from '../common-types';
+import createFunctionLogApi from '../create-function-log-api';
+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 & ReturnType<typeof createFunctionLogApi>;
+/**
+ * @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 & {
+    get(logId: string): Promise<FunctionLogProps & any>;
+    getAll(): Promise<import("../common-types").Collection<FunctionLogProps & any, FunctionLogProps>>;
+}, FunctionLogProps>;

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,38 @@
+import type { CollectionProp, GetFunctionLogParams, GetAllFunctionLogParams } from '../../common-types';
+import type { FunctionLogProps } from '../../entities/function-log';
+import type { OptionalDefaults } from '../wrappers/wrap';
+export type FunctionLogPlainClientAPI = {
+    /**
+     * Fetches the specified FunctionLog
+     * @param 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
+     * @param params - spaceId, environmentId, appInstallationId, functionId
+     * @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>'
+     * });
+     * ```
+     */
+    getAll(params: OptionalDefaults<GetAllFunctionLogParams>): Promise<CollectionProp<FunctionLogProps>>;
+};

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

@@ -3,9 +3,9 @@ import type { FunctionProps } from '../../entities/function';
 import type { OptionalDefaults } from '../wrappers/wrap';
 export type FunctionPlainClientAPI = {
     /**
-     * Fetches the specified function
+     * Fetches the specified Function
      * @param params organization ID, app definition ID, entity ID to identify the function
-     * @returns the function
+     * @returns the Function
      * @throws if the request fails, or the Function is not found
      * @example
      * ```javascript
@@ -18,7 +18,7 @@ export type FunctionPlainClientAPI = {
      */
     get(params: OptionalDefaults<GetFunctionParams>): Promise<FunctionProps>;
     /**
-     * Fetches all functions for the given app
+     * Fetches all Functions for the given app
      * @param params organization ID, app definition ID to identify the functions
      * @returns an object containing an array of Functions
      * @throws if the request fails, or the App is not found
@@ -32,7 +32,7 @@ export type FunctionPlainClientAPI = {
      */
     getMany(params: OptionalDefaults<GetManyFunctionParams>): Promise<CollectionProp<FunctionProps>>;
     /**
-     * Fetches all functions for the given environment
+     * Fetches all Functions for the given environment
      * @param params space ID, environment ID, app installation ID to identify the functions
      * @returns an object containing an array of Functions
      * @throws if the request fails, or the Environment is not found

package/package.json

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