contentful-management 12.0.0-new-beta.3 → 12.0.0-new-beta.4

package/dist/types/entities/webhook.js

@@ -0,0 +1,75 @@
+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 createWebhookApi(makeRequest) {
+    const getParams = (data) => ({
+        spaceId: data.sys.space.sys.id,
+        webhookDefinitionId: data.sys.id,
+    });
+    return {
+        update: function update() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Webhook',
+                action: 'update',
+                params: getParams(data),
+                payload: data,
+            }).then((data) => wrapWebhook(makeRequest, data));
+        },
+        delete: function del() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Webhook',
+                action: 'delete',
+                params: getParams(data),
+            });
+        },
+        getCalls: function getCalls() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Webhook',
+                action: 'getManyCallDetails',
+                params: getParams(data),
+            });
+        },
+        getCall: function getCall(id) {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Webhook',
+                action: 'getCallDetails',
+                params: { ...getParams(data), callId: id },
+            });
+        },
+        getHealth: function getHealth() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Webhook',
+                action: 'getHealthStatus',
+                params: getParams(data),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw webhook data
+ * @return Wrapped webhook data
+ */
+function wrapWebhook(makeRequest, data) {
+    const webhook = toPlainObject(copy(data));
+    const webhookWithMethods = enhanceWithMethods(webhook, createWebhookApi(makeRequest));
+    return freezeSys(webhookWithMethods);
+}
+/**
+ * @private
+ */
+const wrapWebhookCollection = wrapCollection(wrapWebhook);
+
+export { wrapWebhook, wrapWebhookCollection };
+//# sourceMappingURL=webhook.js.map

package/dist/types/entities/webhook.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook.js","sources":["../../../lib/entities/webhook.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAyTA;;AAEG;AACH,SAAS,gBAAgB,CAAC,WAAwB,EAAA;AAChD,IAAA,MAAM,SAAS,GAAG,CAAC,IAAkB,MAAM;QACzC,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;AAC9B,QAAA,mBAAmB,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE;AACjC,KAAA,CAAC;IAEF,OAAO;QACL,MAAM,EAAE,SAAS,MAAM,GAAA;AACrB,YAAA,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAkB;AACjD,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC;AACvB,gBAAA,OAAO,EAAE,IAAI;AACd,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,WAAW,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACnD,CAAC;QACD,MAAM,EAAE,SAAS,GAAG,GAAA;AAClB,YAAA,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAkB;AACjD,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC;AACxB,aAAA,CAAC;QACJ,CAAC;QACD,QAAQ,EAAE,SAAS,QAAQ,GAAA;AACzB,YAAA,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAkB;AACjD,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,MAAM,EAAE,oBAAoB;AAC5B,gBAAA,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC;AACxB,aAAA,CAAC;QACJ,CAAC;AACD,QAAA,OAAO,EAAE,SAAS,OAAO,CAAC,EAAU,EAAA;AAClC,YAAA,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAkB;AACjD,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,MAAM,EAAE,gBAAgB;gBACxB,MAAM,EAAE,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;AAC3C,aAAA,CAAC;QACJ,CAAC;QACD,SAAS,EAAE,SAAS,SAAS,GAAA;AAC3B,YAAA,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAkB;AACjD,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,MAAM,EAAE,iBAAiB;AACzB,gBAAA,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC;AACxB,aAAA,CAAC;QACJ,CAAC;KACF;AACH;AAEA;;;;;AAKG;AACG,SAAU,WAAW,CAAC,WAAwB,EAAE,IAAkB,EAAA;IACtE,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,OAAO,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;AACrF,IAAA,OAAO,SAAS,CAAC,kBAAkB,CAAC;AACtC;AAEA;;AAEG;MACU,qBAAqB,GAAG,cAAc,CAAC,WAAW;;;;"}

package/dist/types/entities/widget-parameters.d.ts

@@ -0,0 +1,21 @@
+export type ParameterType = 'Boolean' | 'Symbol' | 'Number' | 'Enum';
+export type InstallationParameterType = ParameterType | 'Secret';
+export type ParameterOption = string | {
+    [key: string]: string;
+};
+export interface ParameterDefinition<T = ParameterType> {
+    name: string;
+    id: string;
+    description?: string;
+    type: T;
+    required?: boolean;
+    default?: boolean | string | number;
+    options?: ParameterOption[];
+    labels?: {
+        empty?: string;
+        true?: string;
+        false?: string;
+    };
+}
+export type DefinedParameters = Record<string, string | number | boolean>;
+export type FreeFormParameters = Record<string, any> | Array<any> | number | string | boolean;

package/dist/types/entities/workflow-definition.d.ts

@@ -0,0 +1,118 @@
+import type { BasicMetaSysProps, DefaultElements, GetSpaceEnvironmentParams, GetWorkflowDefinitionParams, Link, MakeRequest, PaginationQueryOptions, SysLink } from '../common-types';
+type NonEmptyArray<T> = [T, ...T[]];
+export type WorkflowStepPermissionActors = 'all' | NonEmptyArray<Link<'User'> | Link<'Team'>>;
+export declare enum WorkflowStepPermissionType {
+    EntityPermission = "entity_permission",
+    WorkflowPermission = "workflow_permission"
+}
+export declare enum WorkflowStepPermissionAction {
+    Edit = "edit",
+    Publish = "publish",
+    Delete = "delete"
+}
+export declare enum WorkflowStepPermissionEffect {
+    Allow = "allow",
+    Deny = "deny"
+}
+export interface WorkflowStepPermission {
+    type: WorkflowStepPermissionType;
+    configuration: {
+        actors: WorkflowStepPermissionActors;
+        action: WorkflowStepPermissionAction;
+        effect: WorkflowStepPermissionEffect;
+    };
+}
+export declare enum WorkflowStepActionType {
+    App = "app",
+    Email = "email",
+    Task = "task"
+}
+export type WorkflowStepAction = WorkflowStepEmailAction | WorkflowStepTaskAction | WorkflowStepAppAction;
+export type WorkflowStepEmailActionRecipient = string | Link<'User'> | Link<'Team'>;
+export type WorkflowStepEmailAction = {
+    type: 'email';
+    configuration: {
+        recipients: WorkflowStepEmailActionRecipient[];
+    };
+};
+export type WorkflowStepTaskAction = {
+    type: 'task';
+    configuration: {
+        assignee: Link<'User'> | Link<'Team'>;
+        body: string;
+        dueDate?: number;
+    };
+};
+export type WorkflowStepAppAction = {
+    type: 'app';
+    appId: string;
+    appActionId: string;
+    configuration?: {
+        body?: Record<string, any>;
+        headers?: Record<string, string>;
+    };
+};
+export type WorkflowStepProps = {
+    id: string;
+    name: string;
+    description?: string;
+    actions?: WorkflowStepAction[];
+    annotations?: string[];
+    permissions?: WorkflowStepPermission[];
+};
+export type UpdateWorkflowStepProps = WorkflowStepProps;
+export type CreateWorkflowStepProps = Omit<WorkflowStepProps, 'id'>;
+export type WorkflowDefinitionSysProps = Pick<BasicMetaSysProps, 'id' | 'version' | 'createdAt' | 'createdBy' | 'updatedAt' | 'updatedBy'> & {
+    type: 'WorkflowDefinition';
+    space: SysLink;
+    environment: SysLink;
+    isLocked: boolean;
+};
+export type WorkflowDefinitionValidationLink = {
+    type: 'Link';
+    validations: Array<{
+        linkContentType: string[];
+    }>;
+    linkType: 'Entry';
+};
+export type WorkflowDefinitionProps = {
+    sys: WorkflowDefinitionSysProps;
+    name: string;
+    description?: string;
+    appliesTo?: WorkflowDefinitionValidationLink[];
+    steps: WorkflowStepProps[];
+    startOnEntityCreation?: boolean;
+    flowType?: 'no_restriction' | 'strict_neighbor';
+};
+export type CreateWorkflowDefinitionProps = Omit<WorkflowDefinitionProps, 'sys' | 'steps'> & {
+    steps: CreateWorkflowStepProps[];
+};
+export type UpdateWorkflowDefinitionProps = Omit<WorkflowDefinitionProps, 'sys' | 'steps'> & {
+    sys: Pick<WorkflowDefinitionSysProps, 'version'>;
+    steps: Array<CreateWorkflowStepProps | UpdateWorkflowStepProps>;
+};
+export type CreateWorkflowDefinitionParams = GetSpaceEnvironmentParams;
+export type UpdateWorkflowDefinitionParams = GetWorkflowDefinitionParams;
+export type DeleteWorkflowDefinitionParams = GetWorkflowDefinitionParams & {
+    version: number;
+};
+type WorkflowDefinitionApi = {
+    update(): Promise<WorkflowDefinition>;
+    delete(): Promise<void>;
+};
+export interface WorkflowDefinition extends WorkflowDefinitionProps, DefaultElements<WorkflowDefinitionProps>, WorkflowDefinitionApi {
+}
+export type WorkflowDefinitionQueryOptions = Omit<PaginationQueryOptions, 'order'>;
+/**
+ * @private
+ */
+export default function createWorkflowDefinitionApi(makeRequest: MakeRequest): WorkflowDefinitionApi;
+/**
+ * @private
+ */
+export declare function wrapWorkflowDefinition(makeRequest: MakeRequest, data: WorkflowDefinitionProps): WorkflowDefinition;
+/**
+ * @private
+ */
+export declare const wrapWorkflowDefinitionCollection: (makeRequest: MakeRequest, data: import("..").CollectionProp<WorkflowDefinitionProps>) => import("..").Collection<WorkflowDefinition, WorkflowDefinitionProps>;
+export {};

package/dist/types/entities/workflow-definition.js

@@ -0,0 +1,29 @@
+import 'contentful-sdk-core';
+import 'fast-copy';
+
+var WorkflowStepPermissionType;
+(function (WorkflowStepPermissionType) {
+    WorkflowStepPermissionType["EntityPermission"] = "entity_permission";
+    WorkflowStepPermissionType["WorkflowPermission"] = "workflow_permission";
+})(WorkflowStepPermissionType || (WorkflowStepPermissionType = {}));
+var WorkflowStepPermissionAction;
+(function (WorkflowStepPermissionAction) {
+    WorkflowStepPermissionAction["Edit"] = "edit";
+    WorkflowStepPermissionAction["Publish"] = "publish";
+    WorkflowStepPermissionAction["Delete"] = "delete";
+})(WorkflowStepPermissionAction || (WorkflowStepPermissionAction = {}));
+var WorkflowStepPermissionEffect;
+(function (WorkflowStepPermissionEffect) {
+    WorkflowStepPermissionEffect["Allow"] = "allow";
+    WorkflowStepPermissionEffect["Deny"] = "deny";
+})(WorkflowStepPermissionEffect || (WorkflowStepPermissionEffect = {}));
+/* Workflow Step Action */
+var WorkflowStepActionType;
+(function (WorkflowStepActionType) {
+    WorkflowStepActionType["App"] = "app";
+    WorkflowStepActionType["Email"] = "email";
+    WorkflowStepActionType["Task"] = "task";
+})(WorkflowStepActionType || (WorkflowStepActionType = {}));
+
+export { WorkflowStepActionType, WorkflowStepPermissionAction, WorkflowStepPermissionEffect, WorkflowStepPermissionType };
+//# sourceMappingURL=workflow-definition.js.map

package/dist/types/entities/workflow-definition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-definition.js","sources":["../../../lib/entities/workflow-definition.ts"],"sourcesContent":[null],"names":[],"mappings":";;;IAmBY;AAAZ,CAAA,UAAY,0BAA0B,EAAA;AACpC,IAAA,0BAAA,CAAA,kBAAA,CAAA,GAAA,mBAAsC;AACtC,IAAA,0BAAA,CAAA,oBAAA,CAAA,GAAA,qBAA0C;AAC5C,CAAC,EAHW,0BAA0B,KAA1B,0BAA0B,GAAA,EAAA,CAAA,CAAA;IAK1B;AAAZ,CAAA,UAAY,4BAA4B,EAAA;AACtC,IAAA,4BAAA,CAAA,MAAA,CAAA,GAAA,MAAa;AACb,IAAA,4BAAA,CAAA,SAAA,CAAA,GAAA,SAAmB;AACnB,IAAA,4BAAA,CAAA,QAAA,CAAA,GAAA,QAAiB;AACnB,CAAC,EAJW,4BAA4B,KAA5B,4BAA4B,GAAA,EAAA,CAAA,CAAA;IAM5B;AAAZ,CAAA,UAAY,4BAA4B,EAAA;AACtC,IAAA,4BAAA,CAAA,OAAA,CAAA,GAAA,OAAe;AACf,IAAA,4BAAA,CAAA,MAAA,CAAA,GAAA,MAAa;AACf,CAAC,EAHW,4BAA4B,KAA5B,4BAA4B,GAAA,EAAA,CAAA,CAAA;AAcxC;IACY;AAAZ,CAAA,UAAY,sBAAsB,EAAA;AAChC,IAAA,sBAAA,CAAA,KAAA,CAAA,GAAA,KAAW;AACX,IAAA,sBAAA,CAAA,OAAA,CAAA,GAAA,OAAe;AACf,IAAA,sBAAA,CAAA,MAAA,CAAA,GAAA,MAAa;AACf,CAAC,EAJW,sBAAsB,KAAtB,sBAAsB,GAAA,EAAA,CAAA,CAAA;;;;"}

package/dist/types/entities/workflow.d.ts

@@ -0,0 +1,64 @@
+import type { BasicMetaSysProps, DefaultElements, GetSpaceEnvironmentParams, GetWorkflowParams, Link, MakeRequest, PaginationQueryOptions, SysLink } from '../common-types';
+export type WorkflowSysProps = Pick<BasicMetaSysProps, 'id' | 'version' | 'createdAt' | 'createdBy' | 'updatedAt' | 'updatedBy'> & {
+    type: 'Workflow';
+    space: SysLink;
+    environment: SysLink;
+    completedBy?: SysLink;
+    completedAt?: string;
+    deletedBy?: SysLink;
+    deletedAt?: string;
+    entity: Link<'Entry'>;
+    workflowDefinition: Link<'WorkflowDefinition'>;
+};
+export type WorkflowProps = {
+    sys: WorkflowSysProps;
+    stepId?: string;
+};
+export type CreateWorkflowProps = Omit<WorkflowProps, 'sys'> & {
+    entity: Link<'Entry'>;
+    workflowDefinition: Link<'WorkflowDefinition'>;
+};
+export type UpdateWorkflowProps = Omit<WorkflowProps, 'sys'> & {
+    sys: Pick<WorkflowSysProps, 'version'>;
+};
+export type CreateWorkflowParams = GetSpaceEnvironmentParams;
+export type UpdateWorkflowParams = GetWorkflowParams;
+export type DeleteWorkflowParams = GetWorkflowParams & {
+    version: number;
+};
+export type CompleteWorkflowParams = DeleteWorkflowParams;
+type WorkflowApi = {
+    update(): Promise<Workflow>;
+    get(): Promise<Workflow>;
+    delete(): Promise<void>;
+    complete(): Promise<void>;
+};
+type OrderQueryParam = 'sys.updatedAt' | '-sys.updatedAt' | 'sys.createdAt' | '-sys.createdAt';
+export interface Workflow extends WorkflowProps, DefaultElements<WorkflowProps>, WorkflowApi {
+}
+export type WorkflowQueryOptions = Omit<PaginationQueryOptions, 'order'> & {
+    'stepId[in]'?: string;
+    /** Find workflows filtered by the Entity type (Entry) */
+    'sys.entity.sys.linkType'?: string;
+    /** Find workflows containing the specified, comma-separated entities. Requires `sys.entity.sys.linkType` */
+    'sys.entity.sys.id[in]'?: string;
+    'sys.workflowDefinition.sys.id'?: string;
+    /**
+     * Order workflows by
+     * @default -sys.createdAt
+     * */
+    order?: OrderQueryParam;
+};
+/**
+ * @private
+ */
+export default function createWorkflowApi(makeRequest: MakeRequest): WorkflowApi;
+/**
+ * @private
+ */
+export declare function wrapWorkflow(makeRequest: MakeRequest, data: WorkflowProps): Workflow;
+/**
+ * @private
+ */
+export declare const wrapWorkflowCollection: (makeRequest: MakeRequest, data: import("..").CollectionProp<WorkflowProps>) => import("..").Collection<Workflow, WorkflowProps>;
+export {};

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

@@ -0,0 +1,33 @@
+import type { DefaultElements, Link, MakeRequest, PaginationQueryOptions, SysLink, VersionedLink } from '../common-types';
+export type WorkflowsChangelogQueryOptions = Omit<PaginationQueryOptions, 'order'> & {
+    /** Find workflows changelog entries filtered by the Entity type (Entry) */
+    'entity.sys.linkType': string;
+    /** Find workflows changelog entries containing the specified, comma-separated entities. Requires `sys.entity.sys.linkType` */
+    'entity.sys.id': string;
+    /** workflow.sys.id is optional so all past workflows can be found */
+    'workflow.sys.id'?: string;
+    'eventAt[lte]'?: string;
+    'eventAt[gte]'?: string;
+    'workflowDefinition.sys.id[in]'?: string;
+};
+export type WorkflowsChangelogEntryProps = {
+    event: string;
+    eventBy: SysLink;
+    eventAt: string;
+    workflow: VersionedLink<'Workflow'>;
+    workflowDefinition: Link<'WorkflowDefinition'>;
+    entity: Link<'Entry'>;
+    stepId: string;
+    stepAnnotations: string[];
+    stepName: string;
+};
+export interface WorkflowsChangelogEntry extends WorkflowsChangelogEntryProps, DefaultElements<WorkflowsChangelogEntryProps> {
+}
+/**
+ * @private
+ */
+export declare function wrapWorkflowsChangelogEntry(_makeRequest: MakeRequest, data: WorkflowsChangelogEntryProps): WorkflowsChangelogEntry;
+/**
+ * @private
+ */
+export declare const wrapWorkflowsChangelogEntryCollection: (makeRequest: MakeRequest, data: import("..").CollectionProp<WorkflowsChangelogEntryProps>) => import("..").Collection<WorkflowsChangelogEntry, WorkflowsChangelogEntryProps>;

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

@@ -0,0 +1,78 @@
+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, AppActionCallErrorProps, AppActionCallResponse, // was previously deep imported in user_interface
+AppActionCallRawResponseProps, AppActionCallStatus, 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, BulkActionV2Payload, PublishBulkActionV2Payload, UnpublishBulkActionV2Payload, ValidateBulkActionV2Payload, } from './entities/bulk-action';
+export type { Comment, CommentProps, CommentStatus, // was previously deep imported in user_interface
+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, EntryReferenceProps, // was previously deep imported in user_interface
+WithResourceName, } 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, ReleasePayloadV2, ReleaseProps, ReleaseQueryOptions, ReleaseReferenceFilters, ReleaseSysProps, ReleaseValidateOptions, } from './entities/release';
+export type { ReleaseAction, ReleaseActionProps, ReleaseActionQueryOptions, ReleaseActionSysProps, ReleaseActionTypes, } from './entities/release-action';
+export type { ActionType, // was previously deep imported in user_interface
+ConstraintType, // was previously deep imported in user_interface
+CreateRoleProps, Role, RoleProps, } 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 } 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, WebhookCallDetailsProps, // was previously deep imported in user_interface
+WebhookCallRequest, WebhookCallOverviewProps, // was previously deep imported in user_interface
+WebhookFilter, WebhookHealthProps, // was previously deep imported in user_interface
+WebhookProps, WebhookSigningSecretProps, WebhookTransformation, } 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';

package/dist/types/index.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Contentful Management API SDK. Allows you to create instances of a client
+ * 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';
+import { ScheduledActionStatus } from './entities/scheduled-action';
+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';
+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 { editorInterfaceDefaults };
+export type PlainClientDefaultParams = DefaultParams;
+export * from './export-types';
+export { ScheduledActionStatus };
+export { OptionalDefaults } from './plain/wrappers/wrap';
+interface UserAgentParams {
+    /**
+     * Application name and version e.g myApp/version
+     */
+    application?: string;
+    /**
+     * Integration name and version e.g react/version
+     */
+    integration?: string;
+    feature?: string;
+}
+/**
+ * @deprecated
+ */
+export type ClientParams = RestAdapterParams & UserAgentParams;
+export type ClientOptions = UserAgentParams & XOR<RestAdapterParams, AdapterParams>;
+/**
+ * Create a client instance
+ * @param params - Client initialization parameters
+ *
+ * ```javascript
+ * const client = contentfulManagement.createClient({
+ *  accessToken: 'myAccessToken'
+ * })
+ * ```
+ */
+declare function createClient(params: ClientOptions): ClientAPI;
+declare function createClient(params: ClientOptions, opts: {
+    type: 'plain';
+    defaults?: DefaultParams;
+}): PlainClientAPI;
+/**
+ * @deprecated The `alphaFeatures` option is no longer supported. Please use the function without this option.
+ */
+declare function createClient(params: ClientOptions, opts: {
+    type?: 'plain';
+    alphaFeatures: string[];
+    defaults?: DefaultParams;
+}): ClientAPI | PlainClientAPI;

package/dist/types/index.js

@@ -0,0 +1,40 @@
+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 { ScheduledActionStatus } from './entities/scheduled-action.js';
+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(
+    // @ts-expect-error
+    `${sdkMain}/${"0.0.0-determined-by-semantic-release"}`, 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 };
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../lib/index.ts"],"sourcesContent":[null],"names":["createContentfulApi"],"mappings":";;;;;;;;;;;;;;;AAAA;;;;AAIG;AAgFH,SAAS,YAAY,CACnB,MAAqB,EACrB,OAGI,EAAE,EAAA;AAEN,IAAA,MAAM,OAAO,GACX,IAAI,CAAC,IAAI,KAAK,OAAO,GAAG,gCAAgC,GAAG,0BAA0B;IACvF,MAAM,SAAS,GAAG,kBAAkB;;AAElC,IAAA,CAAA,EAAG,OAAO,CAAA,CAAA,EAAI,sCAAW,CAAA,CAAE,EAC3B,MAAM,CAAC,WAAW,EAClB,MAAM,CAAC,WAAW,EAClB,MAAM,CAAC,OAAO,CACf;IAED,MAAM,OAAO,GAAG,aAAa,CAAC,EAAE,GAAG,MAAM,EAAE,SAAS,EAAE,CAAC;;;;AAKvD,IAAA,MAAM,WAAW,GAAgB,CAAC,OAAmC,KACnE,OAAO,CAAC,WAAW,CAAC,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,CAAC;AAEhD,IAAA,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE;QACzB,OAAO,iBAAiB,CAAC,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC;IACtD;SAAO;AACL,QAAA,OAAOA,eAAmB,CAAC,WAAW,CAAc;IACtD;AACF;;;;"}

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

@@ -0,0 +1,42 @@
+/** Action is an interface that has a sys.status to be checked against */
+interface Action extends Record<string, any> {
+    sys: {
+        status: string;
+        type: string;
+    };
+}
+export declare class AsyncActionProcessingError extends Error {
+    action?: Action;
+    constructor(message: string, action?: Action);
+}
+export declare class AsyncActionFailedError extends AsyncActionProcessingError {
+}
+export type AsyncActionProcessingOptions = {
+    /** The amount of times to retry.
+     * @default 30
+     * */
+    retryCount?: number;
+    /** The interval between retries, in milliseconds (ms).
+     * @default 2000 (2s)
+     * */
+    retryIntervalMs?: number;
+    /**
+     * Initial delay in milliseconds when performing the first check.
+     * This is used to prevent short running bulkActions of waiting too long for a result.
+     * @default 1000 (1s)
+     * */
+    initialDelayMs?: number;
+    /**
+     * Throws an error if the Action does not complete with a successful (succeeded) status.
+     * @default true
+     */
+    throwOnFailedExecution?: boolean;
+};
+/**
+ * @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.
+ */
+export declare function pollAsyncActionStatus<T extends Action = any>(actionFunction: () => Promise<T>, options?: AsyncActionProcessingOptions): Promise<T>;
+export {};

package/dist/types/methods/action.js

@@ -0,0 +1,49 @@
+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 };
+//# sourceMappingURL=action.js.map

package/dist/types/methods/action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"action.js","sources":["../../../lib/methods/action.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAAA;AAGA,MAAM,mBAAmB,GAAG,EAAE;AAC9B,MAAM,wBAAwB,GAAG,IAAI;AACrC,MAAM,yBAAyB,GAAG,IAAI;AAUhC,MAAO,0BAA2B,SAAQ,KAAK,CAAA;IAGnD,WAAA,CAAY,OAAe,EAAE,MAAe,EAAA;QAC1C,KAAK,CAAC,OAAO,CAAC;AACd,QAAA,IAAI,CAAC,MAAM,GAAG,MAAM;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI;IACnC;AACD;AAEK,MAAO,sBAAuB,SAAQ,0BAA0B,CAAA;AAAG;AAwBzE;;;;;AAKG;AACI,eAAe,qBAAqB,CACzC,cAAgC,EAChC,OAAsC,EAAA;IAEtC,IAAI,UAAU,GAAG,CAAC;IAClB,IAAI,IAAI,GAAG,KAAK;AAChB,IAAA,IAAI,MAAqB;AAEzB,IAAA,MAAM,UAAU,GAAG,OAAO,EAAE,UAAU,IAAI,mBAAmB;AAC7D,IAAA,MAAM,eAAe,GAAG,OAAO,EAAE,eAAe,IAAI,yBAAyB;AAC7E,IAAA,MAAM,cAAc,GAAG,OAAO,EAAE,cAAc,IAAI,wBAAwB;AAC1E,IAAA,MAAM,sBAAsB,GAAG,OAAO,EAAE,sBAAsB,IAAI,IAAI;;AAGtE,IAAA,MAAM,KAAK,CAAC,cAAc,CAAC;AAE3B,IAAA,OAAO,UAAU,GAAG,UAAU,IAAI,CAAC,IAAI,EAAE;AACvC,QAAA,MAAM,GAAG,MAAM,cAAc,EAAE;;AAG/B,QAAA,IAAI,MAAM,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YACjE,IAAI,GAAG,IAAI;YAEX,IAAI,MAAM,CAAC,GAAG,CAAC,MAAM,KAAK,QAAQ,IAAI,sBAAsB,EAAE;AAC5D,gBAAA,MAAM,IAAI,sBAAsB,CAAC,CAAA,EAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAA,CAAqB,EAAE,MAAM,CAAC;YACnF;AAEA,YAAA,OAAO,MAAM;QACf;AAEA,QAAA,MAAM,KAAK,CAAC,eAAe,CAAC;QAC5B,UAAU,IAAI,CAAC;IACjB;AAEA,IAAA,MAAM,IAAI,0BAA0B,CAClC,CAAA,EAAG,MAAM,EAAE,GAAG,CAAC,IAAI,CAAA,wDAAA,CAA0D,EAC7E,MAAM,CACP;AACH;;;;"}