contentful-management 11.60.3 → 12.0.0-beta.10

package/dist/types/create-ui-config-api.d.ts

@@ -0,0 +1,34 @@
+import type { MakeRequest } from './common-types.js';
+/**
+ * @private
+ */
+export type ContentfulUIConfigApi = ReturnType<typeof createUIConfigApi>;
+/**
+ * @private
+ */
+export default function createUIConfigApi(makeRequest: MakeRequest): {
+    /**
+     * Sends an update to the server with any changes made to the object's properties
+     * @return Object returned from the server with updated changes.
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getUIConfig())
+     * .then((uiConfig) => {
+     *   uiConfig.entryListViews = [...]
+     *   return uiConfig.update()
+     * })
+     * .then((uiConfig) => console.log(`UIConfig updated.`))
+     * .catch(console.error)
+     * ```
+     */
+    update: () => Promise</*elided*/ any & import("./entities/ui-config.js").UIConfigProps & {
+        toPlainObject(): import("./entities/ui-config.js").UIConfigProps;
+    }>;
+};

package/dist/types/create-ui-config-api.js

@@ -0,0 +1,52 @@
+import { wrapUIConfig } from './entities/ui-config.js';
+
+/**
+ * @private
+ */
+function createUIConfigApi(makeRequest) {
+    const getParams = (self) => {
+        const uiConfig = self.toPlainObject();
+        return {
+            params: {
+                spaceId: uiConfig.sys.space.sys.id,
+                environmentId: uiConfig.sys.environment.sys.id,
+            },
+            raw: uiConfig,
+        };
+    };
+    return {
+        /**
+         * Sends an update to the server with any changes made to the object's properties
+         * @return Object returned from the server with updated changes.
+         * @example ```javascript
+         * const contentful = require('contentful-management')
+         *
+         * const client = contentful.createClient({
+         *   accessToken: '<content_management_api_key>'
+         * })
+         *
+         * client.getSpace('<space_id>')
+         * .then((space) => space.getEnvironment('<environment_id>'))
+         * .then((environment) => environment.getUIConfig())
+         * .then((uiConfig) => {
+         *   uiConfig.entryListViews = [...]
+         *   return uiConfig.update()
+         * })
+         * .then((uiConfig) => console.log(`UIConfig updated.`))
+         * .catch(console.error)
+         * ```
+         */
+        update: async function update() {
+            const { raw, params } = getParams(this);
+            const data = await makeRequest({
+                entityType: 'UIConfig',
+                action: 'update',
+                params,
+                payload: raw,
+            });
+            return wrapUIConfig(makeRequest, data);
+        },
+    };
+}
+
+export { createUIConfigApi as default };

package/dist/types/create-user-ui-config-api.d.ts

@@ -0,0 +1,34 @@
+import type { MakeRequest } from './common-types.js';
+/**
+ * @private
+ */
+export type ContentfulUIConfigApi = ReturnType<typeof createUserUIConfigApi>;
+/**
+ * @private
+ */
+export default function createUserUIConfigApi(makeRequest: MakeRequest): {
+    /**
+     * Sends an update to the server with any changes made to the object's properties
+     * @return Object returned from the server with updated changes.
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getUserUIConfig())
+     * .then((uiConfig) => {
+     *   uiConfig.entryListViews = [...]
+     *   return uiConfig.update()
+     * })
+     * .then((uiConfig) => console.log(`UserUIConfig updated.`))
+     * .catch(console.error)
+     * ```
+     */
+    update: () => Promise</*elided*/ any & import("./entities/user-ui-config.js").UserUIConfigProps & {
+        toPlainObject(): import("./entities/user-ui-config.js").UserUIConfigProps;
+    }>;
+};

package/dist/types/create-user-ui-config-api.js

@@ -0,0 +1,52 @@
+import { wrapUserUIConfig } from './entities/user-ui-config.js';
+
+/**
+ * @private
+ */
+function createUserUIConfigApi(makeRequest) {
+    const getParams = (self) => {
+        const userUIConfig = self.toPlainObject();
+        return {
+            params: {
+                spaceId: userUIConfig.sys.space.sys.id,
+                environmentId: userUIConfig.sys.environment.sys.id,
+            },
+            raw: userUIConfig,
+        };
+    };
+    return {
+        /**
+         * Sends an update to the server with any changes made to the object's properties
+         * @return Object returned from the server with updated changes.
+         * @example ```javascript
+         * const contentful = require('contentful-management')
+         *
+         * const client = contentful.createClient({
+         *   accessToken: '<content_management_api_key>'
+         * })
+         *
+         * client.getSpace('<space_id>')
+         * .then((space) => space.getEnvironment('<environment_id>'))
+         * .then((environment) => environment.getUserUIConfig())
+         * .then((uiConfig) => {
+         *   uiConfig.entryListViews = [...]
+         *   return uiConfig.update()
+         * })
+         * .then((uiConfig) => console.log(`UserUIConfig updated.`))
+         * .catch(console.error)
+         * ```
+         */
+        update: async function update() {
+            const { raw, params } = getParams(this);
+            const data = await makeRequest({
+                entityType: 'UserUIConfig',
+                action: 'update',
+                params,
+                payload: raw,
+            });
+            return wrapUserUIConfig(makeRequest, data);
+        },
+    };
+}
+
+export { createUserUIConfigApi as default };

package/dist/types/enhance-with-methods.js

@@ -0,0 +1,24 @@
+/**
+ * This method enhances a base object which would normally contain data, with
+ * methods from another object that might work on manipulating that data.
+ * All the added methods are set as non enumerable, non configurable, and non
+ * writable properties. This ensures that if we try to clone or stringify the
+ * base object, we don't have to worry about these additional methods.
+ * @private
+ * @param {object} baseObject - Base object with data
+ * @param {object} methodsObject - Object with methods as properties. The key
+ * values used here will be the same that will be defined on the baseObject.
+ */
+function enhanceWithMethods(baseObject, methodsObject) {
+    return Object.keys(methodsObject).reduce((enhancedObject, methodName) => {
+        Object.defineProperty(enhancedObject, methodName, {
+            enumerable: false,
+            configurable: true,
+            writable: false,
+            value: methodsObject[methodName],
+        });
+        return enhancedObject;
+    }, baseObject);
+}
+
+export { enhanceWithMethods as default };

package/dist/types/entities/access-token.d.ts

@@ -0,0 +1,61 @@
+import type { DefaultElements, MakeRequest, BasicMetaSysProps, Link } from '../common-types.js';
+type Application = {
+    id?: string;
+    name?: string;
+    sys: Link<'Application'>;
+};
+type AccessTokenSysProps = BasicMetaSysProps & {
+    application: Application | null;
+    expiresAt: string | null;
+    lastUsedAt: string | null;
+    redactedValue: string;
+};
+export type AccessTokenProps = {
+    sys: AccessTokenSysProps;
+    name: string;
+    scopes: 'content_management_manage'[];
+    revokedAt: null | string;
+    token?: string;
+};
+/**
+ * @deprecated Use `AccessTokenProps` instead.
+ */
+export type AccessTokenProp = AccessTokenProps;
+export type CreatePersonalAccessTokenProps = Pick<AccessToken, 'name' | 'scopes'> & {
+    expiresIn: number;
+};
+export interface AccessToken extends AccessTokenProps, DefaultElements<AccessTokenProps> {
+    /**
+     * Revokes access token
+     * @return Object the revoked access token
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *  accessToken: <content_management_api_key>
+     * })
+     *
+     * client.getAccessToken('<token-id>')
+     *  .then((AccessToken) => {
+     *    return accessToken.revoke()
+     *  })
+     *  .catch(console.error)
+     * ```
+     */
+    revoke(): Promise<AccessToken>;
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw  access token data
+ * @return Wrapped access token
+ */
+export declare function wrapAccessToken(makeRequest: MakeRequest, data: AccessTokenProps): AccessToken;
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw access collection data
+ * @return Wrapped access token collection data
+ */
+export declare const wrapAccessTokenCollection: (makeRequest: MakeRequest, data: import("../common-types.js").CollectionProp<AccessTokenProps>) => import("../common-types.js").Collection<AccessToken, AccessTokenProps>;
+export {};

package/dist/types/entities/access-token.js

@@ -0,0 +1,33 @@
+import copy from 'fast-copy';
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import { wrapCollection } from '../common-utils.js';
+
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw  access token data
+ * @return Wrapped access token
+ */
+function wrapAccessToken(makeRequest, data) {
+    const AccessToken = toPlainObject(copy(data));
+    const accessTokenWithMethods = enhanceWithMethods(AccessToken, {
+        revoke: function () {
+            return makeRequest({
+                entityType: 'AccessToken',
+                action: 'revoke',
+                params: { tokenId: data.sys.id },
+            }).then((data) => wrapAccessToken(makeRequest, data));
+        },
+    });
+    return freezeSys(accessTokenWithMethods);
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw access collection data
+ * @return Wrapped access token collection data
+ */
+const wrapAccessTokenCollection = wrapCollection(wrapAccessToken);
+
+export { wrapAccessToken, wrapAccessTokenCollection };

package/dist/types/entities/ai-action-invocation.d.ts

@@ -0,0 +1,82 @@
+import type { DefaultElements, Link, MakeRequest } from '../common-types.js';
+import type { Document as RichTextDocument } from '@contentful/rich-text-types';
+export type InvocationStatus = 'SCHEDULED' | 'IN_PROGRESS' | 'FAILED' | 'COMPLETED' | 'CANCELLED';
+export type InvocationResultType = 'text';
+export declare const AiActionOutputFormat: {
+    readonly RichText: "RichText";
+    readonly Markdown: "Markdown";
+    readonly PlainText: "PlainText";
+};
+export type AiActionOutputFormatType = (typeof AiActionOutputFormat)[keyof typeof AiActionOutputFormat];
+export type AiActionInvocationMetadata = {
+    invocationResult?: {
+        modelProvider?: string;
+        modelId?: string;
+        wordCount?: number;
+        outputFormat?: AiActionOutputFormatType;
+    };
+    statusChangedDates?: {
+        status: InvocationStatus;
+        date: string;
+    }[];
+};
+export interface InvocationResult {
+    content: string | RichTextDocument;
+    type: InvocationResultType;
+    metadata: AiActionInvocationMetadata;
+}
+export type AiActionInvocationProps = {
+    sys: {
+        id: string;
+        type: 'AiActionInvocation';
+        space: Link<'Space'>;
+        environment: Link<'Environment'>;
+        aiAction: Link<'AiAction'>;
+        status: InvocationStatus;
+        errorCode?: string;
+    };
+    result?: InvocationResult;
+};
+export type AiActionInvocationType = {
+    outputFormat: 'RichText' | 'Markdown' | 'PlainText';
+    variables?: Array<{
+        value: string;
+        id: string;
+    } | {
+        value: {
+            entityPath: string;
+            entityType: 'Entry' | 'Asset' | 'ResourceLink';
+            entityId: string;
+        };
+        id: string;
+    } | {
+        value: {
+            entityPaths: Array<string>;
+            entityType: 'Entry';
+            entityId: string;
+        };
+        id: string;
+    }>;
+};
+/**
+ * The AI Action Invocation entity.
+ * This entity is read-only and primarily used to inspect the result of an AI action invocation.
+ */
+export interface AiActionInvocation extends AiActionInvocationProps, DefaultElements<AiActionInvocationProps> {
+}
+/**
+ * Wraps raw AI Action Invocation data with SDK helper methods.
+ *
+ * @param makeRequest - Function to make API requests.
+ * @param data - Raw AI Action Invocation data.
+ * @returns The AI Action Invocation entity.
+ */
+export declare function wrapAiActionInvocation(makeRequest: MakeRequest, data: AiActionInvocationProps): AiActionInvocation;
+/**
+ * Wraps a collection of raw AI Action Invocation data.
+ *
+ * @param makeRequest - Function to make API requests.
+ * @param data - Raw collection data.
+ * @returns A collection of AI Action Invocation entities.
+ */
+export declare const wrapAiActionInvocationCollection: (makeRequest: MakeRequest, data: import("../common-types.js").CollectionProp<AiActionInvocationProps>) => import("../common-types.js").Collection<AiActionInvocation, AiActionInvocationProps>;

package/dist/types/entities/ai-action-invocation.js

@@ -0,0 +1,16 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+
+/**
+ * Wraps raw AI Action Invocation data with SDK helper methods.
+ *
+ * @param makeRequest - Function to make API requests.
+ * @param data - Raw AI Action Invocation data.
+ * @returns The AI Action Invocation entity.
+ */
+function wrapAiActionInvocation(makeRequest, data) {
+    const invocation = toPlainObject(copy(data));
+    return freezeSys(invocation);
+}
+
+export { wrapAiActionInvocation };

package/dist/types/entities/ai-action.d.ts

@@ -0,0 +1,72 @@
+import type { DefaultElements, Link, MakeRequest, MetaSysProps } from '../common-types.js';
+import { type AiActionInvocationType, type AiActionInvocation } from './ai-action-invocation.js';
+export type VariableType = 'ResourceLink' | 'Text' | 'StandardInput' | 'Locale' | 'MediaReference' | 'Reference' | 'SmartContext';
+export type ReferenceVariableConfiguration = {
+    allowedEntities: Array<'Entry'>;
+};
+export type VariableConfiguration = {
+    strict: boolean;
+    in: Array<string>;
+} | ReferenceVariableConfiguration;
+export type Variable = {
+    configuration?: VariableConfiguration;
+    description?: string;
+    name?: string;
+    type: VariableType;
+    id: string;
+};
+export type Instruction = {
+    variables: Array<Variable>;
+    template: string;
+};
+export type Configuration = {
+    modelType: string;
+    modelTemperature: number;
+};
+export type AiActionTestCase = {
+    type?: 'Text';
+    value?: string;
+} | {
+    type?: 'Reference';
+    value?: {
+        entityPath?: string;
+        entityType?: 'Entry';
+        entityId?: string;
+    };
+};
+export interface AiActionQueryOptions {
+    limit?: number;
+    skip?: number;
+    status?: 'all' | 'published';
+}
+export type AiActionProps = {
+    sys: MetaSysProps & {
+        type: 'AiAction';
+        space: {
+            sys: {
+                id: string;
+            };
+        };
+        publishedBy?: Link<'User'> | Link<'AppDefinition'>;
+        updatedBy: Link<'User'> | Link<'AppDefinition'>;
+        createdBy: Link<'User'> | Link<'AppDefinition'>;
+        publishedVersion?: number;
+        version: number;
+        publishedAt?: string;
+    };
+    name: string;
+    description: string;
+    configuration: Configuration;
+    instruction: Instruction;
+    testCases?: Array<AiActionTestCase>;
+};
+export type CreateAiActionProps = Pick<Omit<AiActionProps, 'sys'>, 'name' | 'description' | 'configuration' | 'instruction' | 'testCases'>;
+export interface AiAction extends AiActionProps, DefaultElements<AiActionProps> {
+    update(): Promise<AiAction>;
+    delete(): Promise<void>;
+    publish(): Promise<AiAction>;
+    unpublish(): Promise<AiAction>;
+    invoke(environmentId: string, payload: AiActionInvocationType): Promise<AiActionInvocation>;
+}
+export declare function wrapAiAction(makeRequest: MakeRequest, data: AiActionProps): AiAction;
+export declare const wrapAiActionCollection: (makeRequest: MakeRequest, data: import("../common-types.js").CollectionProp<AiActionProps>) => import("../common-types.js").Collection<AiAction, AiActionProps>;

package/dist/types/entities/ai-action.js

@@ -0,0 +1,72 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils.js';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import { wrapAiActionInvocation } from './ai-action-invocation.js';
+
+function createAiActionApi(makeRequest) {
+    const getParams = (data) => ({
+        spaceId: data.sys.space.sys.id,
+        aiActionId: data.sys.id,
+    });
+    return {
+        update: function update() {
+            const self = this;
+            return makeRequest({
+                entityType: 'AiAction',
+                action: 'update',
+                params: getParams(self),
+                payload: self,
+            }).then((data) => wrapAiAction(makeRequest, data));
+        },
+        delete: function del() {
+            const self = this;
+            return makeRequest({
+                entityType: 'AiAction',
+                action: 'delete',
+                params: getParams(self),
+            });
+        },
+        publish: function publish() {
+            const self = this;
+            return makeRequest({
+                entityType: 'AiAction',
+                action: 'publish',
+                params: {
+                    aiActionId: self.sys.id,
+                    spaceId: self.sys.space.sys.id,
+                    version: self.sys.version,
+                },
+            }).then((data) => wrapAiAction(makeRequest, data));
+        },
+        unpublish: function unpublish() {
+            const self = this;
+            return makeRequest({
+                entityType: 'AiAction',
+                action: 'unpublish',
+                params: getParams(self),
+            }).then((data) => wrapAiAction(makeRequest, data));
+        },
+        invoke: function invoke(environmentId, payload) {
+            const self = this;
+            return makeRequest({
+                entityType: 'AiAction',
+                action: 'invoke',
+                params: {
+                    spaceId: self.sys.space.sys.id,
+                    environmentId,
+                    aiActionId: self.sys.id,
+                },
+                payload,
+            }).then((data) => wrapAiActionInvocation(makeRequest, data));
+        },
+    };
+}
+function wrapAiAction(makeRequest, data) {
+    const aiAction = toPlainObject(copy(data));
+    const aiActionWithMethods = enhanceWithMethods(aiAction, createAiActionApi(makeRequest));
+    return freezeSys(aiActionWithMethods);
+}
+const wrapAiActionCollection = wrapCollection(wrapAiAction);
+
+export { wrapAiAction, wrapAiActionCollection };

package/dist/types/entities/api-key.d.ts

@@ -0,0 +1,66 @@
+import type { DefaultElements, Link, MakeRequest, MetaSysProps } from '../common-types.js';
+export type ApiKeyProps = {
+    sys: MetaSysProps;
+    name: string;
+    accessToken: string;
+    environments: Link<'Environment'>[];
+    preview_api_key: Link<'PreviewApiKey'>;
+    description?: string;
+    policies?: {
+        effect: string;
+        action: string;
+    }[];
+};
+export type CreateApiKeyProps = Pick<ApiKeyProps, 'name' | 'environments' | 'description'>;
+export interface ApiKey extends ApiKeyProps, DefaultElements<ApiKeyProps> {
+    /**
+     * Deletes this object on the server.
+     * @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getApiKey(<api-key-id>))
+     * .then((apiKey) => apiKey.delete())
+     * .then(() => console.log('apikey deleted'))
+     * .catch(console.error)
+     * ```
+     */
+    delete(): Promise<void>;
+    /**
+     * Sends an update to the server with any changes made to the object's properties
+     * @return Object returned from the server with updated changes.
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getApiKey(<api-key-id>))
+     * .then((apiKey) => {
+     *  apiKey.name = 'New name'
+     *  return apiKey.update()
+     * })
+     * .then(apiKey => console.log(apiKey.name))
+     * .catch(console.error)
+     * ```
+     */
+    update(): Promise<ApiKey>;
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw api key data
+ */
+export declare function wrapApiKey(makeRequest: MakeRequest, data: ApiKeyProps): ApiKey;
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw api key collection data
+ * @return Wrapped api key collection data
+ */
+export declare const wrapApiKeyCollection: (makeRequest: MakeRequest, data: import("../common-types.js").CollectionProp<ApiKeyProps>) => import("../common-types.js").Collection<ApiKey, ApiKeyProps>;

package/dist/types/entities/api-key.js

@@ -0,0 +1,53 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils.js';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+/**
+ * @private
+ */
+function createApiKeyApi(makeRequest) {
+    const getParams = (data) => ({
+        spaceId: data.sys.space?.sys.id ?? '',
+        apiKeyId: data.sys.id,
+    });
+    return {
+        update: function update() {
+            const self = this;
+            return makeRequest({
+                entityType: 'ApiKey',
+                action: 'update',
+                params: getParams(self),
+                payload: self,
+                headers: {},
+            }).then((data) => wrapApiKey(makeRequest, data));
+        },
+        delete: function del() {
+            const self = this;
+            return makeRequest({
+                entityType: 'ApiKey',
+                action: 'delete',
+                params: getParams(self),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw api key data
+ */
+function wrapApiKey(makeRequest, data) {
+    const apiKey = toPlainObject(copy(data));
+    const apiKeyWithMethods = enhanceWithMethods(apiKey, createApiKeyApi(makeRequest));
+    return freezeSys(apiKeyWithMethods);
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw api key collection data
+ * @return Wrapped api key collection data
+ */
+const wrapApiKeyCollection = wrapCollection(wrapApiKey);
+
+export { wrapApiKey, wrapApiKeyCollection };