contentful-management 12.0.0-beta.7 → 12.0.0-beta.9

package/dist/types/entities/workflows-changelog-entry.d.ts

@@ -1,4 +1,4 @@
-import type { DefaultElements, Link, MakeRequest, PaginationQueryOptions, VersionedLink } from '../common-types';
+import type { DefaultElements, Link, MakeRequest, PaginationQueryOptions, VersionedLink } from '../common-types.js';
 export type WorkflowsChangelogQueryOptions = Omit<PaginationQueryOptions, 'order'> & {
     /** Find workflows changelog entries filtered by the Entity type (Entry) */
     'entity.sys.linkType': string;
@@ -30,4 +30,4 @@ export declare function wrapWorkflowsChangelogEntry(_makeRequest: MakeRequest, d
 /**
  * @private
  */
-export declare const wrapWorkflowsChangelogEntryCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<WorkflowsChangelogEntryProps>) => import("../common-types").Collection<WorkflowsChangelogEntry, WorkflowsChangelogEntryProps>;
+export declare const wrapWorkflowsChangelogEntryCollection: (makeRequest: MakeRequest, data: import("../common-types.js").CollectionProp<WorkflowsChangelogEntryProps>) => import("../common-types.js").Collection<WorkflowsChangelogEntry, WorkflowsChangelogEntryProps>;

package/dist/types/export-types.d.ts

@@ -1,70 +1,70 @@
-export * from './common-types';
-export type { AccessToken, AccessTokenProps as AccessTokenProp, CreatePersonalAccessTokenProps as CreatePATProps, } from './entities/access-token';
-export type { ApiKey, ApiKeyProps, CreateApiKeyProps } from './entities/api-key';
-export type { AppAccessToken, AppAccessTokenProps, CreateAppAccessTokenProps, } from './entities/app-access-token';
-export type { AiAction, AiActionProps, CreateAiActionProps } from './entities/ai-action';
-export type { AiActionInvocation, AiActionInvocationProps } from './entities/ai-action-invocation';
-export type { AppAction, AppActionCategoryProps, AppActionCategoryType, AppActionParameterDefinition, AppActionProps, AppActionType, CreateAppActionProps, } from './entities/app-action';
-export type { AppActionCall, AppActionCallProps, AppActionCallResponse, CreateAppActionCallProps, } from './entities/app-action-call';
-export type { AppBundle, AppBundleFile, AppBundleProps, CreateAppBundleProps, } from './entities/app-bundle';
-export type { AppDefinition, AppDefinitionProps, AppLocation, CreateAppDefinitionProps, EntryFieldLocation, NavigationItem, PageLocation, SimpleLocation, } from './entities/app-definition';
-export type { AppDetails, AppDetailsProps, AppIcon, CreateAppDetailsProps, IconType, } from './entities/app-details';
-export type { AppEventSubscription, AppEventSubscriptionProps, CreateAppEventSubscriptionProps, } from './entities/app-event-subscription';
-export type { AppInstallation, AppInstallationProps, CreateAppInstallationProps, } from './entities/app-installation';
-export type { AppKey, AppKeyProps, CreateAppKeyProps } from './entities/app-key';
-export type { AppSignedRequest, AppSignedRequestProps, CreateAppSignedRequestProps, } from './entities/app-signed-request';
-export type { AppSigningSecret, AppSigningSecretProps, CreateAppSigningSecretProps, } from './entities/app-signing-secret';
-export type { AppUpload, AppUploadProps } from './entities/app-upload';
-export type { Asset, AssetFileProp, AssetProps, CreateAssetProps } from './entities/asset';
-export type { AssetKey, AssetKeyProps, CreateAssetKeyProps } from './entities/asset-key';
-export type { BulkAction, BulkActionPayload, BulkActionProps, BulkActionPublishPayload, BulkActionStatus, BulkActionType, BulkActionUnpublishPayload, BulkActionValidatePayload, } from './entities/bulk-action';
-export type { Comment, CommentProps, CommentStatus, CreateCommentProps, DeleteCommentParams, GetCommentParentEntityParams, GetManyCommentsParams, RichTextCommentDocument, RichTextCommentProps, UpdateCommentProps, } from './entities/comment';
-export type { AnnotationAssignment, ContentType, ContentTypeMetadata, ContentTypeProps, CreateContentTypeProps, } from './entities/content-type';
-export type { ContentFields, ContentTypeFieldValidation, ContentfulEntryResource, ExternalResource, } from './entities/content-type-fields';
-export type { Control, Editor, EditorInterface, EditorInterfaceProps, EditorLayoutItem, FieldGroupItem, FieldItem, GroupControl, SidebarItem, } from './entities/editor-interface';
-export type { CreateEntryProps, Entry, EntryProps, WithResourceName, EntryMetaSysProps, EntryReferenceProps, } from './entities/entry';
-export type { CreateEnvironmentProps, Environment, EnvironmentProps } from './entities/environment';
-export type { CreateEnvironmentAliasProps, EnvironmentAlias, EnvironmentAliasProps, } from './entities/environment-alias';
-export type { ContentTypeTemplateProps, CreateEnvironmentTemplateProps, EditorInterfaceTemplateProps, EnvironmentTemplate, EnvironmentTemplateProps, Hint, } from './entities/environment-template';
-export type { CreateEnvironmentTemplateInstallationProps, EnvironmentTemplateInstallation, EnvironmentTemplateInstallationProps, EnvironmentTemplateInstallationStatus, EnvironmentTemplateValidationProps, ValidateEnvironmentTemplateInstallationProps, ValidationFinding, } from './entities/environment-template-installation';
-export type { CreateExtensionProps as CreateUIExtensionProps, Extension as UIExtension, ExtensionProps as UIExtensionProps, } from './entities/extension';
-export type { FieldType } from './entities/field-type';
-export type { FunctionProps } from './entities/function';
-export type { CreateLocaleProps, Locale, LocaleProps } from './entities/locale';
-export type { Organization, OrganizationProp, OrganizationProps } from './entities/organization';
-export type { OAuthApplication, OAuthApplicationProps, CreateOAuthApplicationProps, } from './entities/oauth-application';
-export type { CreateOrganizationInvitationProps, OrganizationInvitation, OrganizationInvitationProps, } from './entities/organization-invitation';
-export type { OrganizationMembership, OrganizationMembershipProps, } from './entities/organization-membership';
-export type { CreatePersonalAccessTokenProps, PersonalAccessToken, PersonalAccessTokenProp, PersonalAccessTokenProps, } from './entities/personal-access-token';
-export type { PreviewApiKey, PreviewApiKeyProps } from './entities/preview-api-key';
-export type { Release, ReleaseMetadata, ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseReferenceFilters, ReleaseSysProps, ReleaseValidateOptions, } from './entities/release';
-export type { ReleaseAction, ReleaseActionProps, ReleaseActionQueryOptions, ReleaseActionSysProps, ReleaseActionTypes, } from './entities/release-action';
-export type { CreateRoleProps, Role, RoleProps, ActionType, ConstraintType } from './entities/role';
-export type { ScheduledAction, ScheduledActionProps, ScheduledActionSysProps, } from './entities/scheduled-action';
-export type { Snapshot, SnapshotProps } from './entities/snapshot';
-export type { Space, SpaceProps } from './entities/space';
-export type { SpaceMember, SpaceMemberProps } from './entities/space-member';
-export type { CreateSpaceMembershipProps, SpaceMembership, SpaceMembershipProps, } from './entities/space-membership';
-export type { CreateTagProps, Tag, TagProps, TagVisibility, TagSysProps } from './entities/tag';
-export type { CreateTaskProps, Task, TaskProps, UpdateTaskProps } from './entities/task';
-export type { CreateTeamProps, Team, TeamProps } from './entities/team';
-export type { CreateTeamMembershipProps, TeamMembership, TeamMembershipProps, } from './entities/team-membership';
-export type { CreateTeamSpaceMembershipProps, TeamSpaceMembership, TeamSpaceMembershipProps, } from './entities/team-space-membership';
-export type { UIConfig, UIConfigProps } from './entities/ui-config';
-export type { Upload, UploadProps } from './entities/upload';
-export type { UploadCredential, UploadCredentialProps } from './entities/upload-credential';
-export type { Usage, UsageProps } from './entities/usage';
-export type { User, UserProps } from './entities/user';
-export type { UserUIConfig, UserUIConfigProps } from './entities/user-ui-config';
-export type { CreateWebhooksProps, UpdateWebhookProps, UpsertWebhookSigningSecretPayload, WebHooks, WebhookCallRequest, WebhookFilter, WebhookProps, WebhookSigningSecretProps, WebhookTransformation, WebhookCallDetailsProps, WebhookCallOverviewProps, WebhookHealthProps, } from './entities/webhook';
-export type { CreateWorkflowDefinitionParams, CreateWorkflowDefinitionProps, CreateWorkflowStepProps, DeleteWorkflowDefinitionParams, UpdateWorkflowDefinitionParams, UpdateWorkflowDefinitionProps, UpdateWorkflowStepProps, WorkflowDefinition, WorkflowDefinitionProps, WorkflowDefinitionQueryOptions, WorkflowDefinitionSysProps, WorkflowDefinitionValidationLink, WorkflowStepAction, WorkflowStepActionType, WorkflowStepAppAction, WorkflowStepEmailAction, WorkflowStepEmailActionRecipient, WorkflowStepPermission, WorkflowStepPermissionActors, WorkflowStepProps, WorkflowStepTaskAction, } from './entities/workflow-definition';
-export * from './plain/common-types';
-export { WorkflowStepPermissionAction, WorkflowStepPermissionEffect, WorkflowStepPermissionType, } from './entities/workflow-definition';
-export type { ConceptProps, CreateConceptProps } from './entities/concept';
-export type { ConceptSchemeProps, CreateConceptSchemeProps } from './entities/concept-scheme';
-export type { ResourceProps, ResourceQueryOptions } from './entities/resource';
-export type { ResourceProvider, ResourceProviderProps, UpsertResourceProviderProps, } from './entities/resource-provider';
-export type { ResourceType, ResourceTypeProps, SpaceEnvResourceTypeProps, UpsertResourceTypeProps, } from './entities/resource-type';
-export type { DefinedParameters, FreeFormParameters, InstallationParameterType, ParameterDefinition, ParameterOption, ParameterType, } from './entities/widget-parameters';
-export type { CreateWorkflowProps, DeleteWorkflowParams, UpdateWorkflowProps, Workflow, WorkflowProps, WorkflowQueryOptions, } from './entities/workflow';
-export type { WorkflowsChangelogEntry, WorkflowsChangelogEntryProps, WorkflowsChangelogQueryOptions, } from './entities/workflows-changelog-entry';
+export * from './common-types.js';
+export type { AccessToken, AccessTokenProps as AccessTokenProp, CreatePersonalAccessTokenProps as CreatePATProps, } from './entities/access-token.js';
+export type { ApiKey, ApiKeyProps, CreateApiKeyProps } from './entities/api-key.js';
+export type { AppAccessToken, AppAccessTokenProps, CreateAppAccessTokenProps, } from './entities/app-access-token.js';
+export type { AiAction, AiActionProps, CreateAiActionProps } from './entities/ai-action.js';
+export type { AiActionInvocation, AiActionInvocationProps, } from './entities/ai-action-invocation.js';
+export type { AppAction, AppActionCategoryProps, AppActionCategoryType, AppActionParameterDefinition, AppActionProps, AppActionType, CreateAppActionProps, } from './entities/app-action.js';
+export type { AppActionCall, AppActionCallProps, AppActionCallResponse, CreateAppActionCallProps, } from './entities/app-action-call.js';
+export type { AppBundle, AppBundleFile, AppBundleProps, CreateAppBundleProps, } from './entities/app-bundle.js';
+export type { AppDefinition, AppDefinitionProps, AppLocation, CreateAppDefinitionProps, EntryFieldLocation, NavigationItem, PageLocation, SimpleLocation, } from './entities/app-definition.js';
+export type { AppDetails, AppDetailsProps, AppIcon, CreateAppDetailsProps, IconType, } from './entities/app-details.js';
+export type { AppEventSubscription, AppEventSubscriptionProps, CreateAppEventSubscriptionProps, } from './entities/app-event-subscription.js';
+export type { AppInstallation, AppInstallationProps, CreateAppInstallationProps, } from './entities/app-installation.js';
+export type { AppKey, AppKeyProps, CreateAppKeyProps } from './entities/app-key.js';
+export type { AppSignedRequest, AppSignedRequestProps, CreateAppSignedRequestProps, } from './entities/app-signed-request.js';
+export type { AppSigningSecret, AppSigningSecretProps, CreateAppSigningSecretProps, } from './entities/app-signing-secret.js';
+export type { AppUpload, AppUploadProps } from './entities/app-upload.js';
+export type { Asset, AssetFileProp, AssetProps, CreateAssetProps } from './entities/asset.js';
+export type { AssetKey, AssetKeyProps, CreateAssetKeyProps } from './entities/asset-key.js';
+export type { BulkAction, BulkActionPayload, BulkActionProps, BulkActionPublishPayload, BulkActionStatus, BulkActionType, BulkActionUnpublishPayload, BulkActionValidatePayload, } from './entities/bulk-action.js';
+export type { Comment, CommentProps, CommentStatus, CreateCommentProps, DeleteCommentParams, GetCommentParentEntityParams, GetManyCommentsParams, RichTextCommentDocument, RichTextCommentProps, UpdateCommentProps, } from './entities/comment.js';
+export type { AnnotationAssignment, ContentType, ContentTypeMetadata, ContentTypeProps, CreateContentTypeProps, } from './entities/content-type.js';
+export type { ContentFields, ContentTypeFieldValidation, ContentfulEntryResource, ExternalResource, } from './entities/content-type-fields.js';
+export type { Control, Editor, EditorInterface, EditorInterfaceProps, EditorLayoutItem, FieldGroupItem, FieldItem, GroupControl, SidebarItem, } from './entities/editor-interface.js';
+export type { CreateEntryProps, Entry, EntryProps, WithResourceName, EntryMetaSysProps, EntryReferenceProps, } from './entities/entry.js';
+export type { CreateEnvironmentProps, Environment, EnvironmentProps, } from './entities/environment.js';
+export type { CreateEnvironmentAliasProps, EnvironmentAlias, EnvironmentAliasProps, } from './entities/environment-alias.js';
+export type { ContentTypeTemplateProps, CreateEnvironmentTemplateProps, EditorInterfaceTemplateProps, EnvironmentTemplate, EnvironmentTemplateProps, Hint, } from './entities/environment-template.js';
+export type { CreateEnvironmentTemplateInstallationProps, EnvironmentTemplateInstallation, EnvironmentTemplateInstallationProps, EnvironmentTemplateInstallationStatus, EnvironmentTemplateValidationProps, ValidateEnvironmentTemplateInstallationProps, ValidationFinding, } from './entities/environment-template-installation.js';
+export type { CreateExtensionProps as CreateUIExtensionProps, Extension as UIExtension, ExtensionProps as UIExtensionProps, } from './entities/extension.js';
+export type { FieldType } from './entities/field-type.js';
+export type { FunctionProps } from './entities/function.js';
+export type { CreateLocaleProps, Locale, LocaleProps } from './entities/locale.js';
+export type { Organization, OrganizationProp, OrganizationProps } from './entities/organization.js';
+export type { OAuthApplication, OAuthApplicationProps, CreateOAuthApplicationProps, } from './entities/oauth-application.js';
+export type { CreateOrganizationInvitationProps, OrganizationInvitation, OrganizationInvitationProps, } from './entities/organization-invitation.js';
+export type { OrganizationMembership, OrganizationMembershipProps, } from './entities/organization-membership.js';
+export type { CreatePersonalAccessTokenProps, PersonalAccessToken, PersonalAccessTokenProp, PersonalAccessTokenProps, } from './entities/personal-access-token.js';
+export type { PreviewApiKey, PreviewApiKeyProps } from './entities/preview-api-key.js';
+export type { Release, ReleaseMetadata, ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseReferenceFilters, ReleaseSysProps, ReleaseValidateOptions, } from './entities/release.js';
+export type { ReleaseAction, ReleaseActionProps, ReleaseActionQueryOptions, ReleaseActionSysProps, ReleaseActionTypes, } from './entities/release-action.js';
+export type { CreateRoleProps, Role, RoleProps, ActionType, ConstraintType, } from './entities/role.js';
+export type { ScheduledAction, ScheduledActionProps, ScheduledActionSysProps, } from './entities/scheduled-action.js';
+export type { Snapshot, SnapshotProps } from './entities/snapshot.js';
+export type { Space, SpaceProps } from './entities/space.js';
+export type { SpaceMember, SpaceMemberProps } from './entities/space-member.js';
+export type { CreateSpaceMembershipProps, SpaceMembership, SpaceMembershipProps, } from './entities/space-membership.js';
+export type { CreateTagProps, Tag, TagProps, TagVisibility, TagSysProps } from './entities/tag.js';
+export type { CreateTaskProps, Task, TaskProps, UpdateTaskProps } from './entities/task.js';
+export type { CreateTeamProps, Team, TeamProps } from './entities/team.js';
+export type { CreateTeamMembershipProps, TeamMembership, TeamMembershipProps, } from './entities/team-membership.js';
+export type { CreateTeamSpaceMembershipProps, TeamSpaceMembership, TeamSpaceMembershipProps, } from './entities/team-space-membership.js';
+export type { UIConfig, UIConfigProps } from './entities/ui-config.js';
+export type { Upload, UploadProps } from './entities/upload.js';
+export type { UploadCredential, UploadCredentialProps } from './entities/upload-credential.js';
+export type { Usage, UsageProps } from './entities/usage.js';
+export type { User, UserProps } from './entities/user.js';
+export type { UserUIConfig, UserUIConfigProps } from './entities/user-ui-config.js';
+export type { CreateWebhooksProps, UpdateWebhookProps, UpsertWebhookSigningSecretPayload, WebHooks, WebhookCallRequest, WebhookFilter, WebhookProps, WebhookSigningSecretProps, WebhookTransformation, WebhookCallDetailsProps, WebhookCallOverviewProps, WebhookHealthProps, } from './entities/webhook.js';
+export type { CreateWorkflowDefinitionParams, CreateWorkflowDefinitionProps, CreateWorkflowStepProps, DeleteWorkflowDefinitionParams, UpdateWorkflowDefinitionParams, UpdateWorkflowDefinitionProps, UpdateWorkflowStepProps, WorkflowDefinition, WorkflowDefinitionProps, WorkflowDefinitionQueryOptions, WorkflowDefinitionSysProps, WorkflowDefinitionValidationLink, WorkflowStepAction, WorkflowStepActionType, WorkflowStepAppAction, WorkflowStepEmailAction, WorkflowStepEmailActionRecipient, WorkflowStepPermission, WorkflowStepPermissionActors, WorkflowStepProps, WorkflowStepTaskAction, } from './entities/workflow-definition.js';
+export * from './plain/common-types.js';
+export { WorkflowStepPermissionAction, WorkflowStepPermissionEffect, WorkflowStepPermissionType, } from './entities/workflow-definition.js';
+export type { ConceptProps, CreateConceptProps } from './entities/concept.js';
+export type { ConceptSchemeProps, CreateConceptSchemeProps } from './entities/concept-scheme.js';
+export type { ResourceProps, ResourceQueryOptions } from './entities/resource.js';
+export type { ResourceProvider, ResourceProviderProps, UpsertResourceProviderProps, } from './entities/resource-provider.js';
+export type { ResourceType, ResourceTypeProps, SpaceEnvResourceTypeProps, UpsertResourceTypeProps, } from './entities/resource-type.js';
+export type { DefinedParameters, FreeFormParameters, InstallationParameterType, ParameterDefinition, ParameterOption, ParameterType, } from './entities/widget-parameters.js';
+export type { CreateWorkflowProps, DeleteWorkflowParams, UpdateWorkflowProps, Workflow, WorkflowProps, WorkflowQueryOptions, } from './entities/workflow.js';
+export type { WorkflowsChangelogEntry, WorkflowsChangelogEntryProps, WorkflowsChangelogQueryOptions, } from './entities/workflows-changelog-entry.js';

package/dist/types/index.d.ts

@@ -3,25 +3,25 @@
  * with access to the Contentful Content Management API.
  * @packageDocumentation
  */
-import type { RestAdapterParams } from './adapters/REST/rest-adapter';
-import type { XOR } from './common-types';
-import type { AdapterParams } from './create-adapter';
-import type { ClientAPI } from './create-contentful-api';
-import type { PlainClientAPI } from './plain/common-types';
-import type { DefaultParams } from './plain/plain-client';
-import * as editorInterfaceDefaults from './constants/editor-interface-defaults/index';
-export type { ClientAPI } from './create-contentful-api';
-export { asIterator } from './plain/as-iterator';
-export { fetchAll } from './plain/pagination-helper';
-export { isDraft, isPublished, isUpdated } from './plain/checks';
-export type { PlainClientAPI } from './plain/common-types';
+import type { RestAdapterParams } from './adapters/REST/rest-adapter.js';
+import type { XOR } from './common-types.js';
+import type { AdapterParams } from './create-adapter.js';
+import type { ClientAPI } from './create-contentful-api.js';
+import type { PlainClientAPI } from './plain/common-types.js';
+import type { DefaultParams } from './plain/plain-client.js';
+import * as editorInterfaceDefaults from './constants/editor-interface-defaults/index.js';
+export type { ClientAPI } from './create-contentful-api.js';
+export { asIterator } from './plain/as-iterator.js';
+export { fetchAll } from './plain/pagination-helper.js';
+export { isDraft, isPublished, isUpdated } from './plain/checks.js';
+export type { PlainClientAPI } from './plain/common-types.js';
 export { createClient };
-export { RestAdapter } from './adapters/REST/rest-adapter';
-export type { RestAdapterParams } from './adapters/REST/rest-adapter';
-export { makeRequest } from './adapters/REST/make-request';
+export { RestAdapter } from './adapters/REST/rest-adapter.js';
+export type { RestAdapterParams } from './adapters/REST/rest-adapter.js';
+export { makeRequest } from './adapters/REST/make-request.js';
 export { editorInterfaceDefaults };
 export type PlainClientDefaultParams = DefaultParams;
-export * from './export-types';
+export * from './export-types.js';
 interface UserAgentParams {
     /**
      * Application name and version e.g myApp/version

package/dist/types/index.js

@@ -0,0 +1,36 @@
+import { getUserAgentHeader } from 'contentful-sdk-core';
+import { createAdapter } from './create-adapter.js';
+import createClientApi from './create-contentful-api.js';
+import { createPlainClient } from './plain/plain-client.js';
+import * as index from './constants/editor-interface-defaults/index.js';
+export { index as editorInterfaceDefaults };
+export { asIterator } from './plain/as-iterator.js';
+export { fetchAll } from './plain/pagination-helper.js';
+export { isDraft, isPublished, isUpdated } from './plain/checks.js';
+export { RestAdapter } from './adapters/REST/rest-adapter.js';
+export { makeRequest } from './adapters/REST/make-request.js';
+export { ScheduledActionReferenceFilters } from './common-types.js';
+export { WorkflowStepPermissionAction, WorkflowStepPermissionEffect, WorkflowStepPermissionType } from './entities/workflow-definition.js';
+
+/**
+ * Contentful Management API SDK. Allows you to create instances of a client
+ * with access to the Contentful Content Management API.
+ * @packageDocumentation
+ */
+function createClient(params, opts = {}) {
+    const sdkMain = opts.type === 'plain' ? 'contentful-management-plain.js' : 'contentful-management.js';
+    const userAgent = getUserAgentHeader(`${sdkMain}/${__VERSION__}`, params.application, params.integration, params.feature);
+    const adapter = createAdapter({ ...params, userAgent });
+    // Parameters<?> and ReturnType<?> only return the types of the last overload
+    // https://github.com/microsoft/TypeScript/issues/26591
+    // @ts-expect-error
+    const makeRequest = (options) => adapter.makeRequest({ ...options, userAgent });
+    if (opts.type === 'plain') {
+        return createPlainClient(makeRequest, opts.defaults);
+    }
+    else {
+        return createClientApi(makeRequest);
+    }
+}
+
+export { createClient };

package/dist/types/methods/action.js

@@ -0,0 +1,48 @@
+import { sleep } from './utils.js';
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const DEFAULT_MAX_RETRIES = 30;
+const DEFAULT_INITIAL_DELAY_MS = 1000;
+const DEFAULT_RETRY_INTERVAL_MS = 2000;
+class AsyncActionProcessingError extends Error {
+    constructor(message, action) {
+        super(message);
+        this.action = action;
+        this.name = this.constructor.name;
+    }
+}
+class AsyncActionFailedError extends AsyncActionProcessingError {
+}
+/**
+ * @description Waits for an Action to be completed and to be in one of the final states (failed or succeeded)
+ * @param {Function} actionFunction - GET function that will be called every interval to fetch an Action status
+ * @throws {ActionFailedError} throws an error if `throwOnFailedExecution = true` with the Action that failed.
+ * @throws {AsyncActionProcessingError} throws an error with a Action when processing takes too long.
+ */
+async function pollAsyncActionStatus(actionFunction, options) {
+    let retryCount = 0;
+    let done = false;
+    let action;
+    const maxRetries = options?.retryCount ?? DEFAULT_MAX_RETRIES;
+    const retryIntervalMs = options?.retryIntervalMs ?? DEFAULT_RETRY_INTERVAL_MS;
+    const initialDelayMs = options?.initialDelayMs ?? DEFAULT_INITIAL_DELAY_MS;
+    const throwOnFailedExecution = options?.throwOnFailedExecution ?? true;
+    // Initial delay for short-running Actions
+    await sleep(initialDelayMs);
+    while (retryCount < maxRetries && !done) {
+        action = await actionFunction();
+        // Terminal states
+        if (action && ['succeeded', 'failed'].includes(action.sys.status)) {
+            done = true;
+            if (action.sys.status === 'failed' && throwOnFailedExecution) {
+                throw new AsyncActionFailedError(`${action.sys.type} failed to execute.`, action);
+            }
+            return action;
+        }
+        await sleep(retryIntervalMs);
+        retryCount += 1;
+    }
+    throw new AsyncActionProcessingError(`${action?.sys.type} didn't finish processing within the expected timeframe.`, action);
+}
+
+export { AsyncActionFailedError, AsyncActionProcessingError, pollAsyncActionStatus };

package/dist/types/methods/bulk-action.d.ts

@@ -1,6 +1,6 @@
-import type { BulkActionPayload, BulkActionProps } from '../entities/bulk-action';
-import type { PlainClientAPI } from '../plain/common-types';
-import type { AsyncActionProcessingOptions } from './action';
+import type { BulkActionPayload, BulkActionProps } from '../entities/bulk-action.js';
+import type { PlainClientAPI } from '../plain/common-types.js';
+import type { AsyncActionProcessingOptions } from './action.js';
 type PlainOptions = {
     /** Used by the PlainClient to perform a poll for the BulkAction status */
     plainClient: PlainClientAPI;

package/dist/types/methods/content-type.d.ts

@@ -1,5 +1,5 @@
-import type { GetContentTypeParams, MakeRequest } from '../common-types';
-import type { ContentTypeProps } from '../entities/content-type';
+import type { GetContentTypeParams, MakeRequest } from '../common-types.js';
+import type { ContentTypeProps } from '../entities/content-type.js';
 export declare const omitAndDeleteField: (makeRequest: MakeRequest, { fieldId, ...params }: {
     fieldId: string;
 } & GetContentTypeParams, contentType: ContentTypeProps) => Promise<ContentTypeProps>;

package/dist/types/methods/content-type.js

@@ -0,0 +1,46 @@
+/**
+ * @private
+ * @param id - unique ID of the field
+ * @param key - the attribute on the field to change
+ * @param value - the value to set the attribute to
+ */
+const findAndUpdateField = function (contentType, fieldId, omitOrDelete) {
+    const field = contentType.fields.find((field) => field.id === fieldId);
+    if (!field) {
+        return Promise.reject(new Error(`Tried to omitAndDeleteField on a nonexistent field, ${fieldId}, on the content type ${contentType.name}.`));
+    }
+    field[omitOrDelete] = true;
+    return Promise.resolve(contentType);
+};
+const omitAndDeleteField = (makeRequest, { fieldId, ...params }, contentType) => {
+    return findAndUpdateField(contentType, fieldId, 'omitted')
+        .then((newContentType) => {
+        return makeRequest({
+            entityType: 'ContentType',
+            action: 'update',
+            params,
+            payload: newContentType,
+        });
+    })
+        .then((newContentType) => {
+        return makeRequest({
+            entityType: 'ContentType',
+            action: 'publish',
+            params,
+            payload: newContentType,
+        });
+    })
+        .then((newContentType) => {
+        return findAndUpdateField(newContentType, fieldId, 'deleted');
+    })
+        .then((newContentType) => {
+        return makeRequest({
+            entityType: 'ContentType',
+            action: 'update',
+            params,
+            payload: newContentType,
+        });
+    });
+};
+
+export { omitAndDeleteField };

package/dist/types/methods/release-action.d.ts

@@ -1,6 +1,6 @@
-import type { ReleaseActionProps, ReleaseActionTypes } from '../entities/release-action';
-import type { PlainClientAPI } from '../plain/common-types';
-import type { AsyncActionProcessingOptions } from './action';
+import type { ReleaseActionProps, ReleaseActionTypes } from '../entities/release-action.js';
+import type { PlainClientAPI } from '../plain/common-types.js';
+import type { AsyncActionProcessingOptions } from './action.js';
 type PlainOptions = {
     /** Used by the PlainClient to perform a poll for the BulkAction status */
     plainClient: PlainClientAPI;

package/dist/types/methods/utils.js

@@ -0,0 +1,9 @@
+/**
+ * Helper function that resolves a Promise after the specified duration (in milliseconds)
+ * @private
+ */
+function sleep(durationMs) {
+    return new Promise((resolve) => setTimeout(resolve, durationMs));
+}
+
+export { sleep };

package/dist/types/plain/as-iterator.d.ts

@@ -1,4 +1,4 @@
-import type { CollectionProp, QueryParams } from '../common-types';
+import type { CollectionProp, QueryParams } from '../common-types.js';
 type IterableFn<P = any, T = any> = (params: P) => Promise<CollectionProp<T>>;
 type ParamsType<T extends IterableFn> = T extends (params: infer P) => any ? P : never;
 export declare const asIterator: <P extends QueryParams, T, F extends IterableFn<P, T>>(fn: F, params: ParamsType<F>) => AsyncIterable<T>;

package/dist/types/plain/as-iterator.js

@@ -0,0 +1,36 @@
+import copy from 'fast-copy';
+
+const asIterator = (fn, params) => {
+    return {
+        [Symbol.asyncIterator]() {
+            let options = copy(params);
+            const get = () => fn(copy(options));
+            let currentResult = get();
+            return {
+                current: 0,
+                async next() {
+                    const { total = 0, items = [], skip = 0, limit = 100 } = await currentResult;
+                    if (total === this.current) {
+                        return { done: true, value: null };
+                    }
+                    const value = items[this.current++ - skip];
+                    const endOfPage = this.current % limit === 0;
+                    const endOfList = this.current === total;
+                    if (endOfPage && !endOfList) {
+                        options = {
+                            ...options,
+                            query: {
+                                ...options.query,
+                                skip: skip + limit,
+                            },
+                        };
+                        currentResult = get();
+                    }
+                    return { done: false, value };
+                },
+            };
+        },
+    };
+};
+
+export { asIterator };

package/dist/types/plain/checks.d.ts

@@ -1,4 +1,4 @@
-import type { MetaSysProps } from '../common-types';
+import type { MetaSysProps } from '../common-types.js';
 export declare const isPublished: <T extends string>(data: {
     sys: MetaSysProps<T>;
 }) => boolean;

package/dist/types/plain/checks.js

@@ -0,0 +1,10 @@
+const isPublished = (data) => !!data.sys.publishedVersion;
+const isUpdated = (data) => {
+    // The act of publishing an entity increases its version by 1, so any entry which has
+    // 2 versions higher or more than the publishedVersion has unpublished changes.
+    return !!(data.sys.publishedVersion && data.sys.version > data.sys.publishedVersion + 1);
+};
+const isDraft = (data) => !data.sys.publishedVersion;
+const isArchived = (data) => !!data.sys.archivedVersion;
+
+export { isArchived, isDraft, isPublished, isUpdated };

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

@@ -1,72 +1,72 @@
 import type { RawAxiosRequestConfig, RawAxiosRequestHeaders } from 'axios';
 import type { OpPatch } from 'json-patch';
-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';
-import type { AssetKeyProps, CreateAssetKeyProps } from '../entities/asset-key';
-import type { BulkActionPayload, BulkActionProps, BulkActionPublishPayload, BulkActionUnpublishPayload, BulkActionValidatePayload } from '../entities/bulk-action';
-import type { ContentTypeProps, CreateContentTypeProps } from '../entities/content-type';
-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 { CreateOrganizationInvitationProps, OrganizationInvitationProps } from '../entities/organization-invitation';
-import type { OrganizationMembershipProps } from '../entities/organization-membership';
-import type { CreatePersonalAccessTokenProps, PersonalAccessTokenProps } from '../entities/personal-access-token';
-import type { PreviewApiKeyProps } from '../entities/preview-api-key';
-import type { ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseValidatePayload } from '../entities/release';
-import type { ReleaseActionProps, ReleaseActionQueryOptions } from '../entities/release-action';
-import type { CreateUpdateScheduledActionProps, ScheduledActionProps } from '../entities/scheduled-action';
-import type { SnapshotProps } from '../entities/snapshot';
-import type { AppAccessTokenPlainClientAPI } from './entities/app-access-token';
-import type { AppActionPlainClientAPI } from './entities/app-action';
-import type { AppActionCallPlainClientAPI } from './entities/app-action-call';
-import type { AppBundlePlainClientAPI } from './entities/app-bundle';
-import type { AppDefinitionPlainClientAPI } from './entities/app-definition';
-import type { AppDetailsPlainClientAPI } from './entities/app-details';
-import type { AppEventSubscriptionPlainClientAPI } from './entities/app-event-subscription';
-import type { AppInstallationPlainClientAPI } from './entities/app-installation';
-import type { AppKeyPlainClientAPI } from './entities/app-key';
-import type { AppSignedRequestPlainClientAPI } from './entities/app-signed-request';
-import type { AppSigningSecretPlainClientAPI } from './entities/app-signing-secret';
-import type { AppUploadPlainClientAPI } from './entities/app-upload';
-import type { CommentPlainClientAPI } from './entities/comment';
-import type { ConceptPlainClientAPI } from './entities/concept';
-import type { ConceptSchemePlainClientAPI } from './entities/concept-scheme';
-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';
-import type { ResourceProviderPlainClientAPI } from './entities/resource-provider';
-import type { ResourceTypePlainClientAPI } from './entities/resource-type';
-import type { RolePlainClientAPI } from './entities/role';
-import type { SpacePlainClientAPI } from './entities/space';
-import type { SpaceMemberPlainClientAPI } from './entities/space-member';
-import type { SpaceMembershipPlainClientAPI } from './entities/space-membership';
-import type { TagPlainClientAPI } from './entities/tag';
-import type { TaskPlainClientAPI } from './entities/task';
-import type { TeamPlainClientAPI } from './entities/team';
-import type { TeamMembershipPlainClientAPI } from './entities/team-membership';
-import type { TeamSpaceMembershipPlainClientAPI } from './entities/team-space-membership';
-import type { UIConfigPlainClientAPI } from './entities/ui-config';
-import type { UploadPlainClientAPI } from './entities/upload';
-import type { UploadCredentialAPI } from './entities/upload-credential';
-import type { UsagePlainClientAPI } from './entities/usage';
-import type { UserPlainClientAPI } from './entities/user';
-import type { UserUIConfigPlainClientAPI } from './entities/user-ui-config';
-import type { WebhookPlainClientAPI } from './entities/webhook';
-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 { OAuthApplicationPlainClientAPI } from './entities/oauth-application';
-import type { FunctionLogPlainClientAPI } from './entities/function-log';
-import type { AiActionPlainClientAPI } from './entities/ai-action';
-import type { AiActionInvocationPlainClientAPI } from './entities/ai-action-invocation';
+import type { BasicCursorPaginationOptions, CollectionProp, CursorPaginatedCollectionProp, EnvironmentTemplateParams, GetBulkActionParams, GetContentTypeParams, GetEnvironmentTemplateParams, GetOrganizationMembershipParams, GetOrganizationParams, GetReleaseParams, GetSnapshotForContentTypeParams, GetSnapshotForEntryParams, GetSpaceEnvironmentParams, GetSpaceParams, KeyValueMap, QueryParams } from '../common-types.js';
+import type { AccessTokenProps, CreatePersonalAccessTokenProps as CreatePATProps } from '../entities/access-token.js';
+import type { ApiKeyProps, CreateApiKeyProps } from '../entities/api-key.js';
+import type { AssetFileProp, AssetProcessingForLocale, AssetProps, CreateAssetProps } from '../entities/asset.js';
+import type { AssetKeyProps, CreateAssetKeyProps } from '../entities/asset-key.js';
+import type { BulkActionPayload, BulkActionProps, BulkActionPublishPayload, BulkActionUnpublishPayload, BulkActionValidatePayload } from '../entities/bulk-action.js';
+import type { ContentTypeProps, CreateContentTypeProps } from '../entities/content-type.js';
+import type { CreateEntryProps, EntryProps, EntryReferenceProps } from '../entities/entry.js';
+import type { CreateEnvironmentTemplateProps, EnvironmentTemplateProps } from '../entities/environment-template.js';
+import type { CreateEnvironmentTemplateInstallationProps, EnvironmentTemplateInstallationProps, EnvironmentTemplateValidationProps, ValidateEnvironmentTemplateInstallationProps } from '../entities/environment-template-installation.js';
+import type { CreateOrganizationInvitationProps, OrganizationInvitationProps } from '../entities/organization-invitation.js';
+import type { OrganizationMembershipProps } from '../entities/organization-membership.js';
+import type { CreatePersonalAccessTokenProps, PersonalAccessTokenProps } from '../entities/personal-access-token.js';
+import type { PreviewApiKeyProps } from '../entities/preview-api-key.js';
+import type { ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseValidatePayload } from '../entities/release.js';
+import type { ReleaseActionProps, ReleaseActionQueryOptions } from '../entities/release-action.js';
+import type { CreateUpdateScheduledActionProps, ScheduledActionProps } from '../entities/scheduled-action.js';
+import type { SnapshotProps } from '../entities/snapshot.js';
+import type { AppAccessTokenPlainClientAPI } from './entities/app-access-token.js';
+import type { AppActionPlainClientAPI } from './entities/app-action.js';
+import type { AppActionCallPlainClientAPI } from './entities/app-action-call.js';
+import type { AppBundlePlainClientAPI } from './entities/app-bundle.js';
+import type { AppDefinitionPlainClientAPI } from './entities/app-definition.js';
+import type { AppDetailsPlainClientAPI } from './entities/app-details.js';
+import type { AppEventSubscriptionPlainClientAPI } from './entities/app-event-subscription.js';
+import type { AppInstallationPlainClientAPI } from './entities/app-installation.js';
+import type { AppKeyPlainClientAPI } from './entities/app-key.js';
+import type { AppSignedRequestPlainClientAPI } from './entities/app-signed-request.js';
+import type { AppSigningSecretPlainClientAPI } from './entities/app-signing-secret.js';
+import type { AppUploadPlainClientAPI } from './entities/app-upload.js';
+import type { CommentPlainClientAPI } from './entities/comment.js';
+import type { ConceptPlainClientAPI } from './entities/concept.js';
+import type { ConceptSchemePlainClientAPI } from './entities/concept-scheme.js';
+import type { EditorInterfacePlainClientAPI } from './entities/editor-interface.js';
+import type { EnvironmentPlainClientAPI } from './entities/environment.js';
+import type { EnvironmentAliasPlainClientAPI } from './entities/environment-alias.js';
+import type { ExtensionPlainClientAPI } from './entities/extension.js';
+import type { FunctionPlainClientAPI } from './entities/function.js';
+import type { LocalePlainClientAPI } from './entities/locale.js';
+import type { OrganizationPlainClientAPI } from './entities/organization.js';
+import type { ResourcePlainAPI } from './entities/resource.js';
+import type { ResourceProviderPlainClientAPI } from './entities/resource-provider.js';
+import type { ResourceTypePlainClientAPI } from './entities/resource-type.js';
+import type { RolePlainClientAPI } from './entities/role.js';
+import type { SpacePlainClientAPI } from './entities/space.js';
+import type { SpaceMemberPlainClientAPI } from './entities/space-member.js';
+import type { SpaceMembershipPlainClientAPI } from './entities/space-membership.js';
+import type { TagPlainClientAPI } from './entities/tag.js';
+import type { TaskPlainClientAPI } from './entities/task.js';
+import type { TeamPlainClientAPI } from './entities/team.js';
+import type { TeamMembershipPlainClientAPI } from './entities/team-membership.js';
+import type { TeamSpaceMembershipPlainClientAPI } from './entities/team-space-membership.js';
+import type { UIConfigPlainClientAPI } from './entities/ui-config.js';
+import type { UploadPlainClientAPI } from './entities/upload.js';
+import type { UploadCredentialAPI } from './entities/upload-credential.js';
+import type { UsagePlainClientAPI } from './entities/usage.js';
+import type { UserPlainClientAPI } from './entities/user.js';
+import type { UserUIConfigPlainClientAPI } from './entities/user-ui-config.js';
+import type { WebhookPlainClientAPI } from './entities/webhook.js';
+import type { WorkflowPlainClientAPI } from './entities/workflow.js';
+import type { WorkflowDefinitionPlainClientAPI } from './entities/workflow-definition.js';
+import type { WorkflowsChangelogPlainClientAPI } from './entities/workflows-changelog.js';
+import type { DefaultParams, OptionalDefaults } from './wrappers/wrap.js';
+import type { OAuthApplicationPlainClientAPI } from './entities/oauth-application.js';
+import type { FunctionLogPlainClientAPI } from './entities/function-log.js';
+import type { AiActionPlainClientAPI } from './entities/ai-action.js';
+import type { AiActionInvocationPlainClientAPI } from './entities/ai-action-invocation.js';
 export type PlainClientAPI = {
     version: string;
     raw: {

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

@@ -1,6 +1,6 @@
-import type { GetSpaceEnvironmentParams } from '../../common-types';
-import type { AiActionInvocationProps } from '../../entities/ai-action-invocation';
-import type { OptionalDefaults } from '../wrappers/wrap';
+import type { GetSpaceEnvironmentParams } from '../../common-types.js';
+import type { AiActionInvocationProps } from '../../entities/ai-action-invocation.js';
+import type { OptionalDefaults } from '../wrappers/wrap.js';
 import type { RawAxiosRequestHeaders } from 'axios';
 export type AiActionInvocationPlainClientAPI = {
     /**