contentful-management 11.42.0 → 11.43.0-beta.2

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/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,8 @@ 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 functionLog from './function-log';
 import * as locale from './locale';
 import * as organization from './organization';
 import * as organizationInvitation from './organization-invitation';
@@ -84,6 +86,8 @@ declare const _default: {
     environmentTemplate: typeof environmentTemplate;
     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

@@ -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';
@@ -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;
@@ -82,9 +83,8 @@ export type PlainClientAPI = {
     appSignedRequest: AppSignedRequestPlainClientAPI;
     appSigningSecret: AppSigningSecretPlainClientAPI;
     appAccessToken: AppAccessTokenPlainClientAPI;
-    function: {
-        getMany(params: OptionalDefaults<GetAppDefinitionParams & QueryParams>): Promise<CollectionProp<FunctionProps>>;
-    };
+    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

@@ -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.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",