contentful-management 11.42.0 → 11.43.0-beta.1

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

@@ -0,0 +1,16 @@
+import * as raw from './raw';
+// Base URL
+const getManyUrl = params => `/organizations/${params.organizationId}/app_definitions/${params.appDefinitionId}/functions`;
+const getFunctionUrl = params => `${getManyUrl(params)}/${params.functionId}`;
+const getFunctionsEnvURL = params => {
+  return `/spaces/${params.spaceId}/environments/${params.environmentId}/app_installations/${params.appInstallationId}/functions`;
+};
+export const get = (http, params) => {
+  return raw.get(http, getFunctionUrl(params));
+};
+export const getMany = (http, params) => {
+  return raw.get(http, getManyUrl(params));
+};
+export const getManyForEnvironment = (http, params) => {
+  return raw.get(http, getFunctionsEnvURL(params));
+};

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

@@ -26,6 +26,7 @@ import * as EnvironmentAlias from './environment-alias';
 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 Http from './http';
 import * as Locale from './locale';
 import * as Organization from './organization';
@@ -87,6 +88,7 @@ export default {
   EnvironmentTemplate,
   EnvironmentTemplateInstallation,
   Extension,
+  Function,
   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.42.0"}`, params.application, params.integration, params.feature);
+  `${sdkMain}/${"11.43.0-beta.1"}`, params.application, params.integration, params.feature);
   const adapter = createAdapter(_objectSpread(_objectSpread({}, params), {}, {
     userAgent
   }));

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

@@ -0,0 +1,115 @@
+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/es-modules/entities/function.js

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

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

@@ -23,6 +23,7 @@ import * as environmentAlias from './environment-alias';
 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 locale from './locale';
 import * as organization from './organization';
 import * as organizationInvitation from './organization-invitation';
@@ -84,6 +85,7 @@ export default {
   environmentTemplate,
   environmentTemplateInstallation,
   extension,
+  func,
   locale,
   organization,
   organizationInvitation,

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

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

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

@@ -139,7 +139,9 @@ export const createPlainClient = (makeRequest, defaults) => {
       updatePut: wrap(wrapParams, 'ConceptScheme', 'updatePut')
     },
     function: {
-      getMany: wrap(wrapParams, 'Function', 'getMany')
+      get: wrap(wrapParams, 'Function', 'get'),
+      getMany: wrap(wrapParams, 'Function', 'getMany'),
+      getManyForEnvironment: wrap(wrapParams, 'Function', 'getManyForEnvironment')
     },
     editorInterface: {
       get: wrap(wrapParams, 'EditorInterface', 'get'),

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

@@ -0,0 +1,4 @@
+import type { RestEndpoint } from '../types';
+export declare const get: RestEndpoint<'Function', 'get'>;
+export declare const getMany: RestEndpoint<'Function', 'getMany'>;
+export declare const getManyForEnvironment: RestEndpoint<'Function', 'getManyForEnvironment'>;

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

@@ -26,6 +26,7 @@ import * as EnvironmentAlias from './environment-alias';
 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 Http from './http';
 import * as Locale from './locale';
 import * as Organization from './organization';
@@ -87,6 +88,7 @@ declare const _default: {
     EnvironmentTemplate: typeof EnvironmentTemplate;
     EnvironmentTemplateInstallation: typeof EnvironmentTemplateInstallation;
     Extension: typeof Extension;
+    Function: typeof Function;
     Http: typeof Http;
     Locale: typeof Locale;
     Organization: typeof Organization;

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

@@ -360,6 +360,9 @@ type MRInternal<UA extends boolean> = {
     (opts: MROpts<'Extension', 'createWithId', UA>): MRReturn<'Extension', 'createWithId'>;
     (opts: MROpts<'Extension', 'update', UA>): MRReturn<'Extension', 'update'>;
     (opts: MROpts<'Extension', 'delete', UA>): MRReturn<'Extension', 'delete'>;
+    (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<'Locale', 'get', UA>): MRReturn<'Locale', 'get'>;
     (opts: MROpts<'Locale', 'getMany', UA>): MRReturn<'Locale', 'getMany'>;
     (opts: MROpts<'Locale', 'delete', UA>): MRReturn<'Locale', 'delete'>;
@@ -1218,12 +1221,6 @@ export type MRActions = {
             return: EditorInterfaceProps;
         };
     };
-    Function: {
-        getMany: {
-            params: GetAppDefinitionParams & QueryParams;
-            return: CollectionProp<FunctionProps>;
-        };
-    };
     Environment: {
         get: {
             params: GetSpaceEnvironmentParams;
@@ -1486,6 +1483,20 @@ export type MRActions = {
             return: any;
         };
     };
+    Function: {
+        get: {
+            params: GetFunctionParams;
+            return: FunctionProps;
+        };
+        getMany: {
+            params: GetManyFunctionParams;
+            return: CollectionProp<FunctionProps>;
+        };
+        getManyForEnvironment: {
+            params: GetFunctionForEnvParams;
+            return: CollectionProp<FunctionProps>;
+        };
+    };
     Locale: {
         get: {
             params: GetSpaceEnvironmentParams & {
@@ -2367,6 +2378,13 @@ export type GetExtensionParams = GetSpaceEnvironmentParams & {
 export type GetEnvironmentTemplateParams = GetOrganizationParams & {
     environmentTemplateId: string;
 };
+export type GetFunctionParams = GetAppDefinitionParams & {
+    functionId: string;
+};
+export type GetManyFunctionParams = GetAppDefinitionParams;
+export type GetFunctionForEnvParams = GetSpaceEnvironmentParams & {
+    appInstallationId: string;
+};
 export type GetOrganizationParams = {
     organizationId: string;
 };

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

@@ -0,0 +1,78 @@
+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>>;
+};

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

@@ -1,4 +1,6 @@
-import type { Link } from '../common-types';
+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;
@@ -16,3 +18,23 @@ export type FunctionProps = {
     accepts: string[];
     allowNetworks?: string[];
 };
+export interface Function extends FunctionProps, DefaultElements<FunctionProps> {
+}
+/**
+ * @private
+ * @param makeRequest - (real) function to make requests via an adapter
+ * @param data - raw contentful-Function data
+ * @return Wrapped Function data
+ */
+export declare function wrapFunction(makeRequest: MakeRequest, data: FunctionProps): FunctionProps & ReturnType<typeof createFunctionApi>;
+/**
+ * @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>;

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

@@ -23,6 +23,7 @@ import * as environmentAlias from './environment-alias';
 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 locale from './locale';
 import * as organization from './organization';
 import * as organizationInvitation from './organization-invitation';
@@ -84,6 +85,7 @@ declare const _default: {
     environmentTemplate: typeof environmentTemplate;
     environmentTemplateInstallation: typeof environmentTemplateInstallation;
     extension: typeof extension;
+    func: typeof func;
     locale: typeof locale;
     organization: typeof organization;
     organizationInvitation: typeof organizationInvitation;

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

@@ -1,6 +1,6 @@
 import type { RawAxiosRequestConfig, RawAxiosRequestHeaders } from 'axios';
 import type { OpPatch } from 'json-patch';
-import type { BasicCursorPaginationOptions, CollectionProp, CursorPaginatedCollectionProp, EnvironmentTemplateParams, GetAppDefinitionParams, GetBulkActionParams, GetContentTypeParams, GetEnvironmentTemplateParams, GetOrganizationMembershipParams, GetOrganizationParams, GetReleaseParams, GetSnapshotForContentTypeParams, GetSnapshotForEntryParams, GetSpaceEnvironmentParams, GetSpaceParams, KeyValueMap, QueryParams } from '../common-types';
+import type { BasicCursorPaginationOptions, CollectionProp, CursorPaginatedCollectionProp, EnvironmentTemplateParams, GetBulkActionParams, GetContentTypeParams, GetEnvironmentTemplateParams, GetOrganizationMembershipParams, GetOrganizationParams, GetReleaseParams, GetSnapshotForContentTypeParams, GetSnapshotForEntryParams, GetSpaceEnvironmentParams, GetSpaceParams, KeyValueMap, QueryParams } from '../common-types';
 import type { AccessTokenProps, CreatePersonalAccessTokenProps as CreatePATProps } from '../entities/access-token';
 import type { ApiKeyProps, CreateApiKeyProps } from '../entities/api-key';
 import type { AssetFileProp, AssetProcessingForLocale, AssetProps, CreateAssetProps } from '../entities/asset';
@@ -10,7 +10,6 @@ import type { ContentTypeProps, CreateContentTypeProps } from '../entities/conte
 import type { CreateEntryProps, EntryProps, EntryReferenceProps } from '../entities/entry';
 import type { CreateEnvironmentTemplateProps, EnvironmentTemplateProps } from '../entities/environment-template';
 import type { CreateEnvironmentTemplateInstallationProps, EnvironmentTemplateInstallationProps, EnvironmentTemplateValidationProps, ValidateEnvironmentTemplateInstallationProps } from '../entities/environment-template-installation';
-import type { FunctionProps } from '../entities/function';
 import type { CreateOrganizationInvitationProps, OrganizationInvitationProps } from '../entities/organization-invitation';
 import type { OrganizationMembershipProps } from '../entities/organization-membership';
 import type { CreatePersonalAccessTokenProps, PersonalAccessTokenProps } from '../entities/personal-access-token';
@@ -38,6 +37,7 @@ import type { EditorInterfacePlainClientAPI } from './entities/editor-interface'
 import type { EnvironmentPlainClientAPI } from './entities/environment';
 import type { EnvironmentAliasPlainClientAPI } from './entities/environment-alias';
 import type { ExtensionPlainClientAPI } from './entities/extension';
+import type { FunctionPlainClientAPI } from './entities/function';
 import type { LocalePlainClientAPI } from './entities/locale';
 import type { OrganizationPlainClientAPI } from './entities/organization';
 import type { ResourcePlainAPI } from './entities/resource';
@@ -82,9 +82,7 @@ export type PlainClientAPI = {
     appSignedRequest: AppSignedRequestPlainClientAPI;
     appSigningSecret: AppSigningSecretPlainClientAPI;
     appAccessToken: AppAccessTokenPlainClientAPI;
-    function: {
-        getMany(params: OptionalDefaults<GetAppDefinitionParams & QueryParams>): Promise<CollectionProp<FunctionProps>>;
-    };
+    function: FunctionPlainClientAPI;
     editorInterface: EditorInterfacePlainClientAPI;
     space: SpacePlainClientAPI;
     environment: EnvironmentPlainClientAPI;

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

@@ -0,0 +1,49 @@
+import type { CollectionProp, GetFunctionParams, GetFunctionForEnvParams, GetManyFunctionParams } from '../../common-types';
+import type { FunctionProps } from '../../entities/function';
+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
+     * @returns the function
+     * @throws if the request fails, or the Function is not found
+     * @example
+     * ```javascript
+     * const func = await client.function.get({
+     *   organizationId: "<org_id>",
+     *   appDefinitionId: "<app_definition_id>",
+     *   functionId: "<function_id>",
+     * });
+     * ```
+     */
+    get(params: OptionalDefaults<GetFunctionParams>): Promise<FunctionProps>;
+    /**
+     * 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
+     * @example
+     * ```javascript
+     * const functions = await client.function.getMany({
+     *   organizationId: "<org_id>",
+     *   appDefinitionId: "<app_definition_id>",
+     * });
+     * ```
+     */
+    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
+     * @returns an object containing an array of Functions
+     * @throws if the request fails, or the Environment is not found
+     * @example
+     * ```javascript
+     * const functions = await client.function.getManyForEnvironment({
+     *   spaceId: "<space_id>",
+     *   environmentId: "<environment_id>",
+     *   appInstallationId: "<app_installation_id>",
+     * });
+     * ```
+     */
+    getManyForEnvironment(params: OptionalDefaults<GetFunctionForEnvParams>): Promise<CollectionProp<FunctionProps>>;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentful-management",
-  "version": "11.42.0",
+  "version": "11.43.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",