@webiny/api-apw 0.0.0-unstable.1e66d121db → 0.0.0-unstable.2aaa1916d9

package/types.d.ts

@@ -1,15 +1,14 @@
-import { CmsContext, CmsEntry as BaseCmsEntry, CmsModel, OnEntryBeforePublishTopicParams, OnEntryAfterPublishTopicParams, OnEntryAfterUnpublishTopicParams } from "@webiny/api-headless-cms/types";
-import { Page, OnPageBeforeCreateTopicParams, OnPageBeforeCreateFromTopicParams, OnPageBeforeUpdateTopicParams, OnPageBeforePublishTopicParams, PageSettings } from "@webiny/api-page-builder/types";
-import { Context } from "@webiny/api/types";
-import { PageBuilderContextObject } from "@webiny/api-page-builder/graphql/types";
-import { SecurityIdentity, SecurityPermission } from "@webiny/api-security/types";
-import { I18NLocale } from "@webiny/api-i18n/types";
-import { Tenant } from "@webiny/api-tenancy/types";
-import { Topic } from "@webiny/pubsub/types";
-import { ApwScheduleActionCrud, ScheduleActionContext } from "./scheduler/types";
-import HandlerClient from "@webiny/handler-client/HandlerClient";
-import { PluginsContainer } from "@webiny/plugins";
-import { WcpContextObject } from "@webiny/api-wcp/types";
+import type { CmsEntry as BaseCmsEntry, OnEntryBeforePublishTopicParams, OnEntryAfterPublishTopicParams, OnEntryAfterUnpublishTopicParams, CmsEntryListSort } from "@webiny/api-headless-cms/types";
+import type { Context } from "@webiny/api/types";
+import type { SecurityIdentity, SecurityPermission } from "@webiny/api-security/types";
+import type { I18NLocale } from "@webiny/api-i18n/types";
+import type { Tenant } from "@webiny/api-tenancy/types";
+import type { Topic } from "@webiny/pubsub/types";
+import type { ApwScheduleActionCrud, ScheduleActionContext } from "./scheduler/types";
+import type HandlerClient from "@webiny/handler-client/HandlerClient";
+import type { PluginsContainer } from "@webiny/plugins";
+import type { WcpContextObject } from "@webiny/api-wcp/types";
+import type { MailerContext } from "@webiny/api-mailer/types";
 export interface ApwCmsEntry extends BaseCmsEntry {
     title: string;
     meta: {
@@ -44,7 +43,7 @@ export interface ListWhere {
 }
 export interface ListParams {
     where?: ListWhere;
-    sort?: string[];
+    sort?: CmsEntryListSort;
     limit?: number;
     after?: string | null;
 }
@@ -66,19 +65,6 @@ export declare enum ApwContentTypes {
     PAGE = "page",
     CMS_ENTRY = "cms_entry"
 }
-export interface PageSettingsWithWorkflow extends PageSettings {
-    apw: {
-        workflowId: string;
-        contentReviewId: string | null;
-    };
-}
-export interface PageWithWorkflow extends Page {
-    settings: PageSettingsWithWorkflow;
-}
-export declare type ApwOnPageBeforeCreateTopicParams = OnPageBeforeCreateTopicParams<PageWithWorkflow>;
-export declare type ApwOnPageBeforeCreateFromTopicParams = OnPageBeforeCreateFromTopicParams<PageWithWorkflow>;
-export declare type ApwOnPageBeforeUpdateTopicParams = OnPageBeforeUpdateTopicParams<PageWithWorkflow>;
-export declare type ApwOnPageBeforePublishTopicParams = OnPageBeforePublishTopicParams<PageWithWorkflow>;
 export declare enum WorkflowScopeTypes {
     DEFAULT = "default",
     CUSTOM = "custom"
@@ -97,7 +83,7 @@ export declare enum ApwWorkflowApplications {
  *
  * @category General
  */
-export interface CreatedBy {
+export interface ApwIdentity {
     /**
      * ID if the user.
      */
@@ -115,13 +101,20 @@ export interface ApwBaseFields {
     id: string;
     entryId: string;
     createdOn: string;
+    modifiedOn: string | null;
     savedOn: string;
-    createdBy: CreatedBy;
+    createdBy: ApwIdentity;
+    modifiedBy: ApwIdentity;
+    savedBy: ApwIdentity;
 }
 export interface ApwReviewer extends ApwBaseFields {
     identityId: string;
     displayName: string | null;
     type: string;
+    email?: string;
+}
+export interface ApwReviewerWithEmail extends Omit<ApwReviewer, "email"> {
+    email: string;
 }
 export interface ApwComment extends ApwBaseFields {
     body: Record<string, any>;
@@ -145,7 +138,7 @@ export interface ApwContentReviewStep {
     pendingChangeRequests: number;
     totalComments: number;
     signOffProvidedOn: string | null;
-    signOffProvidedBy: CreatedBy | null;
+    signOffProvidedBy: ApwIdentity | null;
 }
 export interface ApwContentReview extends ApwBaseFields {
     title: string;
@@ -184,7 +177,7 @@ export declare enum ApwContentReviewStatus {
     READY_TO_BE_PUBLISHED = "readyToBePublished",
     PUBLISHED = "published"
 }
-export declare type ApwContentReviewListFilter = ApwContentReviewStatus | "requiresMyAttention";
+export type ApwContentReviewListFilter = ApwContentReviewStatus | "requiresMyAttention";
 export interface ApwWorkflowStep<TReviewer = ApwReviewer> {
     title: string;
     type: ApwWorkflowStepTypes;
@@ -211,11 +204,6 @@ export interface ListWorkflowsParams extends ListParams {
         app?: ApwWorkflowApplications;
     };
 }
-interface CreateReviewerParams {
-    identityId: string;
-    displayName: string | null;
-    type: string;
-}
 interface CreateApwCommentParams {
     body: Record<string, any>;
     changeRequest: string;
@@ -279,7 +267,7 @@ interface BaseApwCrud<TEntry, TCreateEntryParams, TUpdateEntryParams> {
     get(id: string): Promise<TEntry>;
     create(data: TCreateEntryParams): Promise<TEntry>;
     update(id: string, data: TUpdateEntryParams): Promise<TEntry>;
-    delete(id: string): Promise<Boolean>;
+    delete(id: string): Promise<boolean>;
 }
 export interface ApwWorkflowCrud extends BaseApwCrud<ApwWorkflow, CreateApwWorkflowParams, UpdateApwWorkflowParams> {
     list(params?: ListWorkflowsParams): Promise<[ApwWorkflow[], ListMeta]>;
@@ -298,7 +286,7 @@ export interface ApwReviewerListParams extends ListParams {
         identityId?: string;
     };
 }
-export interface ApwReviewerCrud extends BaseApwCrud<ApwReviewer, CreateReviewerParams, UpdateApwReviewerData> {
+export interface ApwReviewerCrud extends BaseApwCrud<ApwReviewer, CreateApwReviewerData, UpdateApwReviewerData> {
     list(params: ApwReviewerListParams): Promise<[ApwReviewer[], ListMeta]>;
     /**
      * Lifecycle events
@@ -348,14 +336,14 @@ export interface ApwChangeRequestCrud extends BaseApwCrud<ApwChangeRequest, Crea
 }
 export interface ApwContentReviewCrud extends BaseApwCrud<ApwContentReview, CreateApwContentReviewParams, UpdateApwContentReviewParams> {
     list(params: ApwContentReviewListParams): Promise<[ApwContentReview[], ListMeta]>;
-    provideSignOff(id: string, step: string): Promise<Boolean>;
-    retractSignOff(id: string, step: string): Promise<Boolean>;
+    provideSignOff(id: string, step: string): Promise<boolean>;
+    retractSignOff(id: string, step: string): Promise<boolean>;
     isReviewRequired(data: ApwContentReviewContent): Promise<{
         isReviewRequired: boolean;
         contentReviewId?: string | null;
     }>;
-    publishContent(id: string, datetime?: string): Promise<Boolean>;
-    unpublishContent(id: string, datetime?: string): Promise<Boolean>;
+    publishContent(id: string, datetime?: string): Promise<boolean>;
+    unpublishContent(id: string, datetime?: string): Promise<boolean>;
     scheduleAction(data: ApwScheduleActionData): Promise<string>;
     deleteScheduledAction(id: string): Promise<boolean>;
     /**
@@ -367,16 +355,17 @@ export interface ApwContentReviewCrud extends BaseApwCrud<ApwContentReview, Crea
     onContentReviewAfterUpdate: Topic<OnContentReviewAfterUpdateTopicParams>;
     onContentReviewBeforeDelete: Topic<OnContentReviewBeforeDeleteTopicParams>;
     onContentReviewAfterDelete: Topic<OnContentReviewAfterDeleteTopicParams>;
+    onContentReviewBeforeList: Topic<OnContentReviewBeforeListTopicParams>;
 }
-export declare type ContentGetter = (id: string, settings: {
+export type ContentGetter = (id: string, settings: {
     modelId?: string;
-}) => Promise<PageWithWorkflow | ApwCmsEntry | null>;
-export declare type ContentPublisher = (id: string, settings: {
+}) => Promise<ApwCmsEntry | null>;
+export type ContentPublisher = (id: string, settings: {
     modelId?: string;
-}) => Promise<Boolean | null>;
-export declare type ContentUnPublisher = (id: string, settings: {
+}) => Promise<boolean | null>;
+export type ContentUnPublisher = (id: string, settings: {
     modelId?: string;
-}) => Promise<Boolean | null>;
+}) => Promise<boolean | null>;
 export interface AdvancedPublishingWorkflow {
     addContentGetter: (type: ApwContentTypes, func: ContentGetter) => void;
     getContentGetter: (type: ApwContentTypes) => ContentGetter;
@@ -391,9 +380,8 @@ export interface AdvancedPublishingWorkflow {
     contentReview: ApwContentReviewCrud;
     scheduleAction: ApwScheduleActionCrud;
 }
-export interface ApwContext extends Context, CmsContext {
+export interface ApwContext extends Context, MailerContext {
     apw: AdvancedPublishingWorkflow;
-    pageBuilder: PageBuilderContextObject;
     wcp: WcpContextObject;
     scheduleAction: ScheduleActionContext["scheduleAction"];
 }
@@ -415,16 +403,18 @@ export interface CreateApwParams {
 interface StorageOperationsGetReviewerParams {
     id: string;
 }
-declare type StorageOperationsListReviewersParams = ApwReviewerListParams;
+type StorageOperationsListReviewersParams = ApwReviewerListParams;
 interface CreateApwReviewerData {
     identityId: string;
     displayName: string | null;
     type: string;
+    email?: string | null;
 }
 interface UpdateApwReviewerData {
     identityId: string;
     displayName: string | null;
     type: string;
+    email?: string | null;
 }
 interface StorageOperationsCreateReviewerParams {
     data: CreateApwReviewerData;
@@ -442,8 +432,8 @@ interface StorageOperationsGetParams {
 interface StorageOperationsDeleteParams {
     id: string;
 }
-declare type StorageOperationsGetWorkflowParams = StorageOperationsGetParams;
-declare type StorageOperationsListWorkflowsParams = ListParams;
+type StorageOperationsGetWorkflowParams = StorageOperationsGetParams;
+type StorageOperationsListWorkflowsParams = ListParams;
 interface StorageOperationsCreateWorkflowParams {
     data: CreateApwWorkflowParams;
 }
@@ -451,16 +441,18 @@ interface StorageOperationsUpdateWorkflowParams {
     id: string;
     data: UpdateApwWorkflowParams;
 }
-declare type StorageOperationsDeleteWorkflowParams = StorageOperationsDeleteParams;
-declare type StorageOperationsGetContentReviewParams = StorageOperationsGetParams;
+type StorageOperationsDeleteWorkflowParams = StorageOperationsDeleteParams;
+type StorageOperationsGetContentReviewParams = StorageOperationsGetParams;
 export interface ApwContentReviewListParams extends ListParams {
-    where?: ListWhere & {
+    where: ListWhere & {
         reviewStatus?: ApwContentReviewListFilter;
         title?: string;
         title_contains?: string;
+        workflowId?: string;
+        workflowId_in?: string[];
     };
 }
-declare type StorageOperationsListContentReviewsParams = ApwContentReviewListParams;
+type StorageOperationsListContentReviewsParams = ApwContentReviewListParams;
 interface StorageOperationsCreateContentReviewParams {
     data: CreateApwContentReviewParams;
 }
@@ -468,9 +460,9 @@ interface StorageOperationsUpdateContentReviewParams {
     id: string;
     data: UpdateApwContentReviewParams;
 }
-declare type StorageOperationsDeleteContentReviewParams = StorageOperationsDeleteParams;
-declare type StorageOperationsGetChangeRequestParams = StorageOperationsGetParams;
-declare type StorageOperationsListChangeRequestsParams = ApwChangeRequestListParams;
+type StorageOperationsDeleteContentReviewParams = StorageOperationsDeleteParams;
+type StorageOperationsGetChangeRequestParams = StorageOperationsGetParams;
+type StorageOperationsListChangeRequestsParams = ApwChangeRequestListParams;
 interface StorageOperationsCreateChangeRequestParams {
     data: CreateApwChangeRequestParams;
 }
@@ -478,10 +470,10 @@ interface StorageOperationsUpdateChangeRequestParams {
     id: string;
     data: UpdateApwChangeRequestParams;
 }
-declare type StorageOperationsDeleteChangeRequestParams = StorageOperationsDeleteParams;
-declare type StorageOperationsGetCommentParams = StorageOperationsGetParams;
-declare type StorageOperationsDeleteCommentParams = StorageOperationsDeleteParams;
-declare type StorageOperationsListCommentsParams = ApwCommentListParams;
+type StorageOperationsDeleteChangeRequestParams = StorageOperationsDeleteParams;
+type StorageOperationsGetCommentParams = StorageOperationsGetParams;
+type StorageOperationsDeleteCommentParams = StorageOperationsDeleteParams;
+type StorageOperationsListCommentsParams = ApwCommentListParams;
 interface StorageOperationsCreateCommentParams {
     data: CreateApwCommentParams;
 }
@@ -494,35 +486,35 @@ export interface ApwReviewerStorageOperations {
     listReviewers(params: StorageOperationsListReviewersParams): Promise<[ApwReviewer[], ListMeta]>;
     createReviewer(params: StorageOperationsCreateReviewerParams): Promise<ApwReviewer>;
     updateReviewer(params: StorageOperationsUpdateReviewerParams): Promise<ApwReviewer>;
-    deleteReviewer(params: StorageOperationsDeleteReviewerParams): Promise<Boolean>;
+    deleteReviewer(params: StorageOperationsDeleteReviewerParams): Promise<boolean>;
 }
 export interface ApwWorkflowStorageOperations {
     getWorkflow(params: StorageOperationsGetWorkflowParams): Promise<ApwWorkflow>;
     listWorkflows(params: StorageOperationsListWorkflowsParams): Promise<[ApwWorkflow[], ListMeta]>;
     createWorkflow(params: StorageOperationsCreateWorkflowParams): Promise<ApwWorkflow>;
     updateWorkflow(params: StorageOperationsUpdateWorkflowParams): Promise<ApwWorkflow>;
-    deleteWorkflow(params: StorageOperationsDeleteWorkflowParams): Promise<Boolean>;
+    deleteWorkflow(params: StorageOperationsDeleteWorkflowParams): Promise<boolean>;
 }
 export interface ApwContentReviewStorageOperations {
     getContentReview(params: StorageOperationsGetContentReviewParams): Promise<ApwContentReview>;
     listContentReviews(params: StorageOperationsListContentReviewsParams): Promise<[ApwContentReview[], ListMeta]>;
     createContentReview(params: StorageOperationsCreateContentReviewParams): Promise<ApwContentReview>;
     updateContentReview(params: StorageOperationsUpdateContentReviewParams): Promise<ApwContentReview>;
-    deleteContentReview(params: StorageOperationsDeleteContentReviewParams): Promise<Boolean>;
+    deleteContentReview(params: StorageOperationsDeleteContentReviewParams): Promise<boolean>;
 }
 export interface ApwChangeRequestStorageOperations {
     getChangeRequest(params: StorageOperationsGetChangeRequestParams): Promise<ApwChangeRequest>;
     listChangeRequests(params: StorageOperationsListChangeRequestsParams): Promise<[ApwChangeRequest[], ListMeta]>;
     createChangeRequest(params: StorageOperationsCreateChangeRequestParams): Promise<ApwChangeRequest>;
     updateChangeRequest(params: StorageOperationsUpdateChangeRequestParams): Promise<ApwChangeRequest>;
-    deleteChangeRequest(params: StorageOperationsDeleteChangeRequestParams): Promise<Boolean>;
+    deleteChangeRequest(params: StorageOperationsDeleteChangeRequestParams): Promise<boolean>;
 }
 export interface ApwCommentStorageOperations {
     getComment(params: StorageOperationsGetCommentParams): Promise<ApwComment>;
     listComments(params: StorageOperationsListCommentsParams): Promise<[ApwComment[], ListMeta]>;
     createComment(params: StorageOperationsCreateCommentParams): Promise<ApwComment>;
     updateComment(params: StorageOperationsUpdateCommentParams): Promise<ApwComment>;
-    deleteComment(params: StorageOperationsDeleteCommentParams): Promise<Boolean>;
+    deleteComment(params: StorageOperationsDeleteCommentParams): Promise<boolean>;
 }
 export interface ApwStorageOperations extends ApwReviewerStorageOperations, ApwWorkflowStorageOperations, ApwContentReviewStorageOperations, ApwChangeRequestStorageOperations, ApwCommentStorageOperations {
 }
@@ -643,6 +635,12 @@ export interface OnContentReviewBeforeDeleteTopicParams {
 export interface OnContentReviewAfterDeleteTopicParams {
     contentReview: ApwContentReview;
 }
+/**
+ * @category Lifecycle events
+ */
+export interface OnContentReviewBeforeListTopicParams {
+    where: ApwContentReviewListParams["where"];
+}
 export interface CreateApwReviewerParams {
     type: string;
 }
@@ -724,7 +722,6 @@ export interface OnWorkflowBeforeDeleteTopicParams {
 export interface OnWorkflowAfterDeleteTopicParams {
     workflow: ApwWorkflow;
 }
-export declare type WorkflowModelDefinition = Pick<CmsModel, "name" | "modelId" | "layout" | "titleFieldId" | "description" | "fields" | "isPrivate">;
 /**
  * Headless CMS
  */

package/types.js

@@ -4,66 +4,144 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.WorkflowScopeTypes = exports.ApwWorkflowStepTypes = exports.ApwWorkflowApplications = exports.ApwContentTypes = exports.ApwContentReviewStepStatus = exports.ApwContentReviewStatus = void 0;
-let ApwContentTypes;
-exports.ApwContentTypes = ApwContentTypes;
-
-(function (ApwContentTypes) {
+let ApwContentTypes = exports.ApwContentTypes = /*#__PURE__*/function (ApwContentTypes) {
   ApwContentTypes["PAGE"] = "page";
   ApwContentTypes["CMS_ENTRY"] = "cms_entry";
-})(ApwContentTypes || (exports.ApwContentTypes = ApwContentTypes = {}));
-
-let WorkflowScopeTypes;
-exports.WorkflowScopeTypes = WorkflowScopeTypes;
-
-(function (WorkflowScopeTypes) {
+  return ApwContentTypes;
+}({});
+let WorkflowScopeTypes = exports.WorkflowScopeTypes = /*#__PURE__*/function (WorkflowScopeTypes) {
   WorkflowScopeTypes["DEFAULT"] = "default";
   WorkflowScopeTypes["CUSTOM"] = "custom";
-})(WorkflowScopeTypes || (exports.WorkflowScopeTypes = WorkflowScopeTypes = {}));
-
-let ApwContentReviewStepStatus;
-exports.ApwContentReviewStepStatus = ApwContentReviewStepStatus;
-
-(function (ApwContentReviewStepStatus) {
+  return WorkflowScopeTypes;
+}({});
+let ApwContentReviewStepStatus = exports.ApwContentReviewStepStatus = /*#__PURE__*/function (ApwContentReviewStepStatus) {
   ApwContentReviewStepStatus["DONE"] = "done";
   ApwContentReviewStepStatus["ACTIVE"] = "active";
   ApwContentReviewStepStatus["INACTIVE"] = "inactive";
-})(ApwContentReviewStepStatus || (exports.ApwContentReviewStepStatus = ApwContentReviewStepStatus = {}));
-
-let ApwWorkflowApplications;
+  return ApwContentReviewStepStatus;
+}({});
+let ApwWorkflowApplications = exports.ApwWorkflowApplications = /*#__PURE__*/function (ApwWorkflowApplications) {
+  ApwWorkflowApplications["PB"] = "pageBuilder";
+  ApwWorkflowApplications["CMS"] = "cms";
+  return ApwWorkflowApplications;
+}({});
 /**
  * A interface describing the reference to a user that created some data in the database.
  *
  * @category General
  */
-
-exports.ApwWorkflowApplications = ApwWorkflowApplications;
-
-(function (ApwWorkflowApplications) {
-  ApwWorkflowApplications["PB"] = "pageBuilder";
-  ApwWorkflowApplications["CMS"] = "cms";
-})(ApwWorkflowApplications || (exports.ApwWorkflowApplications = ApwWorkflowApplications = {}));
-
-let ApwWorkflowStepTypes;
-exports.ApwWorkflowStepTypes = ApwWorkflowStepTypes;
-
-(function (ApwWorkflowStepTypes) {
+let ApwWorkflowStepTypes = exports.ApwWorkflowStepTypes = /*#__PURE__*/function (ApwWorkflowStepTypes) {
   ApwWorkflowStepTypes["MANDATORY_BLOCKING"] = "mandatoryBlocking";
   ApwWorkflowStepTypes["MANDATORY_NON_BLOCKING"] = "mandatoryNonBlocking";
   ApwWorkflowStepTypes["NON_MANDATORY"] = "notMandatory";
-})(ApwWorkflowStepTypes || (exports.ApwWorkflowStepTypes = ApwWorkflowStepTypes = {}));
-
-let ApwContentReviewStatus;
-exports.ApwContentReviewStatus = ApwContentReviewStatus;
-
-(function (ApwContentReviewStatus) {
+  return ApwWorkflowStepTypes;
+}({});
+let ApwContentReviewStatus = exports.ApwContentReviewStatus = /*#__PURE__*/function (ApwContentReviewStatus) {
   ApwContentReviewStatus["UNDER_REVIEW"] = "underReview";
   ApwContentReviewStatus["READY_TO_BE_PUBLISHED"] = "readyToBePublished";
   ApwContentReviewStatus["PUBLISHED"] = "published";
-})(ApwContentReviewStatus || (exports.ApwContentReviewStatus = ApwContentReviewStatus = {}));
-
-var ApwScheduleActionTypes;
-
-(function (ApwScheduleActionTypes) {
+  return ApwContentReviewStatus;
+}({});
+var ApwScheduleActionTypes = /*#__PURE__*/function (ApwScheduleActionTypes) {
   ApwScheduleActionTypes["PUBLISH"] = "publish";
   ApwScheduleActionTypes["UNPUBLISH"] = "unpublish";
-})(ApwScheduleActionTypes || (ApwScheduleActionTypes = {}));
+  return ApwScheduleActionTypes;
+}(ApwScheduleActionTypes || {});
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * @category Lifecycle events
+ */
+/**
+ * Headless CMS
+ */
+
+//# sourceMappingURL=types.js.map

package/types.js.map

@@ -1 +1 @@
-{"version":3,"names":["ApwContentTypes","WorkflowScopeTypes","ApwContentReviewStepStatus","ApwWorkflowApplications","ApwWorkflowStepTypes","ApwContentReviewStatus","ApwScheduleActionTypes"],"sources":["types.ts"],"sourcesContent":["import {\n    CmsContext,\n    CmsEntry as BaseCmsEntry,\n    CmsModel,\n    OnEntryBeforePublishTopicParams,\n    OnEntryAfterPublishTopicParams,\n    OnEntryAfterUnpublishTopicParams\n} from \"@webiny/api-headless-cms/types\";\nimport {\n    Page,\n    OnPageBeforeCreateTopicParams,\n    OnPageBeforeCreateFromTopicParams,\n    OnPageBeforeUpdateTopicParams,\n    OnPageBeforePublishTopicParams,\n    PageSettings\n} from \"@webiny/api-page-builder/types\";\nimport { Context } from \"@webiny/api/types\";\nimport { PageBuilderContextObject } from \"@webiny/api-page-builder/graphql/types\";\nimport { SecurityIdentity, SecurityPermission } from \"@webiny/api-security/types\";\nimport { I18NLocale } from \"@webiny/api-i18n/types\";\nimport { Tenant } from \"@webiny/api-tenancy/types\";\nimport { Topic } from \"@webiny/pubsub/types\";\nimport { ApwScheduleActionCrud, ScheduleActionContext } from \"~/scheduler/types\";\nimport HandlerClient from \"@webiny/handler-client/HandlerClient\";\nimport { PluginsContainer } from \"@webiny/plugins\";\nimport { WcpContextObject } from \"@webiny/api-wcp/types\";\n\nexport interface ApwCmsEntry extends BaseCmsEntry {\n    title: string;\n    meta: {\n        apw?: {\n            contentReviewId?: string | null;\n            workflowId?: string | null;\n        };\n    };\n}\n\nexport interface ApwFile {\n    id: string;\n    key: string;\n    size: number;\n    type: string;\n    name: string;\n}\n\nexport interface ListWhere {\n    /**\n     * Fields.\n     */\n    id?: string;\n    id_in?: string[];\n    id_not?: string;\n    id_not_in?: string[];\n    /**\n     * Who created the entry?\n     */\n    createdBy?: string;\n    createdBy_not?: string;\n    createdBy_in?: string[];\n    createdBy_not_in?: string[];\n}\n\nexport interface ListParams {\n    where?: ListWhere;\n    sort?: string[];\n    limit?: number;\n    after?: string | null;\n}\n\nexport interface ListMeta {\n    /**\n     * A cursor for pagination.\n     */\n    cursor: string | null;\n    /**\n     * Is there more items to load?\n     */\n    hasMoreItems: boolean;\n    /**\n     * Total count of the items in the storage.\n     */\n    totalCount: number;\n}\n\nexport enum ApwContentTypes {\n    PAGE = \"page\",\n    CMS_ENTRY = \"cms_entry\"\n}\n\nexport interface PageSettingsWithWorkflow extends PageSettings {\n    apw: {\n        workflowId: string;\n        contentReviewId: string | null;\n    };\n}\nexport interface PageWithWorkflow extends Page {\n    settings: PageSettingsWithWorkflow;\n}\n\nexport type ApwOnPageBeforeCreateTopicParams = OnPageBeforeCreateTopicParams<PageWithWorkflow>;\n\nexport type ApwOnPageBeforeCreateFromTopicParams =\n    OnPageBeforeCreateFromTopicParams<PageWithWorkflow>;\n\nexport type ApwOnPageBeforeUpdateTopicParams = OnPageBeforeUpdateTopicParams<PageWithWorkflow>;\n\nexport type ApwOnPageBeforePublishTopicParams = OnPageBeforePublishTopicParams<PageWithWorkflow>;\n\nexport enum WorkflowScopeTypes {\n    DEFAULT = \"default\",\n    CUSTOM = \"custom\"\n}\n\nexport enum ApwContentReviewStepStatus {\n    DONE = \"done\",\n    ACTIVE = \"active\",\n    INACTIVE = \"inactive\"\n}\n\nexport enum ApwWorkflowApplications {\n    PB = \"pageBuilder\",\n    CMS = \"cms\"\n}\n\n/**\n * A interface describing the reference to a user that created some data in the database.\n *\n * @category General\n */\nexport interface CreatedBy {\n    /**\n     * ID if the user.\n     */\n    id: string;\n    /**\n     * Full name of the user.\n     */\n    displayName: string | null;\n    /**\n     * Type of the user (admin, user)\n     */\n    type: string;\n}\n\nexport interface ApwBaseFields {\n    id: string;\n    entryId: string;\n    createdOn: string;\n    savedOn: string;\n    createdBy: CreatedBy;\n}\n\nexport interface ApwReviewer extends ApwBaseFields {\n    identityId: string;\n    displayName: string | null;\n    type: string;\n}\n\nexport interface ApwComment extends ApwBaseFields {\n    body: Record<string, any>;\n    changeRequest: string;\n    step: string;\n    media: ApwFile;\n}\n\nexport interface ApwChangeRequest extends ApwBaseFields {\n    body: Record<string, any>;\n    title: string;\n    resolved: boolean;\n    step: string;\n    media: ApwFile;\n}\n\nexport interface ApwContentReviewStep {\n    type: ApwWorkflowStepTypes;\n    title: string;\n    slug: string;\n    reviewers: ApwReviewer[];\n    status: ApwContentReviewStepStatus;\n    pendingChangeRequests: number;\n    totalComments: number;\n    signOffProvidedOn: string | null;\n    signOffProvidedBy: CreatedBy | null;\n}\n\nexport interface ApwContentReview extends ApwBaseFields {\n    title: string;\n    reviewStatus: ApwContentReviewStatus;\n    content: ApwContentReviewContent;\n    steps: Array<ApwContentReviewStep>;\n    latestCommentId: string | null;\n    workflowId: string;\n}\n\nexport interface ApwWorkflow extends ApwBaseFields {\n    title: string;\n    steps: ApwWorkflowStep[];\n    scope: ApwWorkflowScope;\n    app: ApwWorkflowApplications;\n}\n\ninterface ApwWorkflowScopeCmsEntry {\n    id: string;\n    modelId: string;\n}\nexport interface ApwWorkflowScope {\n    type: WorkflowScopeTypes;\n    data: {\n        categories?: string[];\n        pages?: string[];\n        models?: string[];\n        entries?: ApwWorkflowScopeCmsEntry[];\n    };\n}\n\nexport enum ApwWorkflowStepTypes {\n    MANDATORY_BLOCKING = \"mandatoryBlocking\",\n    MANDATORY_NON_BLOCKING = \"mandatoryNonBlocking\",\n    NON_MANDATORY = \"notMandatory\"\n}\n\nexport enum ApwContentReviewStatus {\n    UNDER_REVIEW = \"underReview\",\n    READY_TO_BE_PUBLISHED = \"readyToBePublished\",\n    PUBLISHED = \"published\"\n}\n\nexport type ApwContentReviewListFilter = ApwContentReviewStatus | \"requiresMyAttention\";\n\nexport interface ApwWorkflowStep<TReviewer = ApwReviewer> {\n    title: string;\n    type: ApwWorkflowStepTypes;\n    reviewers: TReviewer[];\n    id: string;\n}\n\nexport interface ApwContentReviewStep extends ApwWorkflowStep {\n    status: ApwContentReviewStepStatus;\n    pendingChangeRequests: number;\n}\n\nexport interface CreateApwWorkflowParams<TReviewer = string> {\n    app: ApwWorkflowApplications;\n    title: string;\n    scope: ApwWorkflowScope;\n    steps: ApwWorkflowStep<TReviewer>[];\n}\n\nexport interface UpdateApwWorkflowParams<TReviewer = string> {\n    title?: string;\n    scope?: ApwWorkflowScope;\n    steps?: ApwWorkflowStep<TReviewer>[];\n}\n\nexport interface ListWorkflowsParams extends ListParams {\n    where?: ListWhere & {\n        app?: ApwWorkflowApplications;\n    };\n}\n\ninterface CreateReviewerParams {\n    identityId: string;\n    displayName: string | null;\n    type: string;\n}\n\ninterface CreateApwCommentParams {\n    body: Record<string, any>;\n    changeRequest: string;\n    step: string;\n    media: ApwFile;\n}\n\ninterface UpdateApwCommentParams {\n    body: Record<string, any>;\n}\n\ninterface CreateApwChangeRequestParams {\n    title: string;\n    step: string;\n    body: Record<string, any>;\n    resolved: boolean;\n    media: Record<string, any>;\n}\n\ninterface UpdateApwChangeRequestParams {\n    title: string;\n    body: Record<string, any>;\n    resolved: boolean;\n    media: Record<string, any>;\n}\n\nenum ApwScheduleActionTypes {\n    PUBLISH = \"publish\",\n    UNPUBLISH = \"unpublish\"\n}\n\nexport interface ApwScheduleActionData {\n    action: ApwScheduleActionTypes;\n    type: ApwContentTypes;\n    datetime: string;\n    entryId: string;\n    /**\n     * We will add modelId to the data for now.\n     * TODO extract in separate package?\n     */\n    modelId?: string;\n}\n\nexport interface ApwContentReviewContent {\n    id: string;\n    type: ApwContentTypes;\n    settings: {\n        modelId?: string;\n    };\n    scheduledOn?: string | null;\n    scheduledBy?: string | null;\n    scheduledActionId?: string | null;\n    publishedBy?: string | null;\n}\n\nexport interface CreateApwContentReviewParams {\n    content: ApwContentReviewContent;\n    reviewStatus: ApwContentReviewStatus;\n    workflowId?: string;\n}\n\nexport interface UpdateApwContentReviewParams {\n    title?: string;\n    steps?: ApwContentReviewStep[];\n    reviewStatus?: ApwContentReviewStatus;\n    content?: ApwContentReviewContent;\n}\n\ninterface BaseApwCrud<TEntry, TCreateEntryParams, TUpdateEntryParams> {\n    get(id: string): Promise<TEntry>;\n\n    create(data: TCreateEntryParams): Promise<TEntry>;\n\n    update(id: string, data: TUpdateEntryParams): Promise<TEntry>;\n\n    delete(id: string): Promise<Boolean>;\n}\n\nexport interface ApwWorkflowCrud\n    extends BaseApwCrud<ApwWorkflow, CreateApwWorkflowParams, UpdateApwWorkflowParams> {\n    list(params?: ListWorkflowsParams): Promise<[ApwWorkflow[], ListMeta]>;\n\n    /**\n     * Lifecycle events\n     */\n    onWorkflowBeforeCreate: Topic<OnWorkflowBeforeCreateTopicParams>;\n    onWorkflowAfterCreate: Topic<OnWorkflowAfterCreateTopicParams>;\n    onWorkflowBeforeUpdate: Topic<OnWorkflowBeforeUpdateTopicParams>;\n    onWorkflowAfterUpdate: Topic<OnWorkflowAfterUpdateTopicParams>;\n    onWorkflowBeforeDelete: Topic<OnWorkflowBeforeDeleteTopicParams>;\n    onWorkflowAfterDelete: Topic<OnWorkflowAfterDeleteTopicParams>;\n}\n\nexport interface ApwReviewerListParams extends ListParams {\n    where: ListParams[\"where\"] & {\n        identityId?: string;\n    };\n}\n\nexport interface ApwReviewerCrud\n    extends BaseApwCrud<ApwReviewer, CreateReviewerParams, UpdateApwReviewerData> {\n    list(params: ApwReviewerListParams): Promise<[ApwReviewer[], ListMeta]>;\n\n    /**\n     * Lifecycle events\n     */\n    onReviewerBeforeCreate: Topic<OnReviewerBeforeCreateTopicParams>;\n    onReviewerAfterCreate: Topic<OnReviewerAfterCreateTopicParams>;\n    onReviewerBeforeUpdate: Topic<OnReviewerBeforeUpdateTopicParams>;\n    onReviewerAfterUpdate: Topic<OnReviewerAfterUpdateTopicParams>;\n    onReviewerBeforeDelete: Topic<OnReviewerBeforeDeleteTopicParams>;\n    onReviewerAfterDelete: Topic<OnReviewerAfterDeleteTopicParams>;\n}\n\nexport interface ApwCommentListParams extends ListParams {\n    where: ListParams[\"where\"] & {\n        changeRequest?: {\n            id?: string;\n        };\n    };\n}\n\nexport interface ApwCommentCrud\n    extends BaseApwCrud<ApwComment, CreateApwCommentParams, UpdateApwCommentParams> {\n    list(params: ApwCommentListParams): Promise<[ApwComment[], ListMeta]>;\n\n    /**\n     * Lifecycle events\n     */\n    onCommentBeforeCreate: Topic<OnCommentBeforeCreateTopicParams>;\n    onCommentAfterCreate: Topic<OnCommentAfterCreateTopicParams>;\n    onCommentBeforeUpdate: Topic<OnCommentBeforeUpdateTopicParams>;\n    onCommentAfterUpdate: Topic<OnCommentAfterUpdateTopicParams>;\n    onCommentBeforeDelete: Topic<OnCommentBeforeDeleteTopicParams>;\n    onCommentAfterDelete: Topic<OnCommentAfterDeleteTopicParams>;\n}\n\nexport interface ApwChangeRequestListParams extends ListParams {\n    where: ListParams[\"where\"] & {\n        step?: string;\n    };\n}\n\nexport interface ApwChangeRequestCrud\n    extends BaseApwCrud<\n        ApwChangeRequest,\n        CreateApwChangeRequestParams,\n        UpdateApwChangeRequestParams\n    > {\n    list(params: ApwChangeRequestListParams): Promise<[ApwChangeRequest[], ListMeta]>;\n\n    /**\n     * Lifecycle events\n     */\n    onChangeRequestBeforeCreate: Topic<OnChangeRequestBeforeCreateTopicParams>;\n    onChangeRequestAfterCreate: Topic<OnChangeRequestAfterCreateTopicParams>;\n    onChangeRequestBeforeUpdate: Topic<OnChangeRequestBeforeUpdateTopicParams>;\n    onChangeRequestAfterUpdate: Topic<OnChangeRequestAfterUpdateTopicParams>;\n    onChangeRequestBeforeDelete: Topic<OnChangeRequestBeforeDeleteTopicParams>;\n    onChangeRequestAfterDelete: Topic<OnChangeRequestAfterDeleteTopicParams>;\n}\n\nexport interface ApwContentReviewCrud\n    extends BaseApwCrud<\n        ApwContentReview,\n        CreateApwContentReviewParams,\n        UpdateApwContentReviewParams\n    > {\n    list(params: ApwContentReviewListParams): Promise<[ApwContentReview[], ListMeta]>;\n\n    provideSignOff(id: string, step: string): Promise<Boolean>;\n\n    retractSignOff(id: string, step: string): Promise<Boolean>;\n\n    isReviewRequired(data: ApwContentReviewContent): Promise<{\n        isReviewRequired: boolean;\n        contentReviewId?: string | null;\n    }>;\n\n    publishContent(id: string, datetime?: string): Promise<Boolean>;\n\n    unpublishContent(id: string, datetime?: string): Promise<Boolean>;\n\n    scheduleAction(data: ApwScheduleActionData): Promise<string>;\n\n    deleteScheduledAction(id: string): Promise<boolean>;\n\n    /**\n     * Lifecycle events\n     */\n    onContentReviewBeforeCreate: Topic<OnContentReviewBeforeCreateTopicParams>;\n    onContentReviewAfterCreate: Topic<OnContentReviewAfterCreateTopicParams>;\n    onContentReviewBeforeUpdate: Topic<OnContentReviewBeforeUpdateTopicParams>;\n    onContentReviewAfterUpdate: Topic<OnContentReviewAfterUpdateTopicParams>;\n    onContentReviewBeforeDelete: Topic<OnContentReviewBeforeDeleteTopicParams>;\n    onContentReviewAfterDelete: Topic<OnContentReviewAfterDeleteTopicParams>;\n}\n\nexport type ContentGetter = (\n    id: string,\n    settings: { modelId?: string }\n) => Promise<PageWithWorkflow | ApwCmsEntry | null>;\n\nexport type ContentPublisher = (\n    id: string,\n    settings: { modelId?: string }\n) => Promise<Boolean | null>;\n\nexport type ContentUnPublisher = (\n    id: string,\n    settings: { modelId?: string }\n) => Promise<Boolean | null>;\n\nexport interface AdvancedPublishingWorkflow {\n    addContentGetter: (type: ApwContentTypes, func: ContentGetter) => void;\n    getContentGetter: (type: ApwContentTypes) => ContentGetter;\n    addContentPublisher: (type: ApwContentTypes, func: ContentPublisher) => void;\n    getContentPublisher: (type: ApwContentTypes) => ContentPublisher;\n    addContentUnPublisher: (type: ApwContentTypes, func: ContentUnPublisher) => void;\n    getContentUnPublisher: (type: ApwContentTypes) => ContentUnPublisher;\n    workflow: ApwWorkflowCrud;\n    reviewer: ApwReviewerCrud;\n    comment: ApwCommentCrud;\n    changeRequest: ApwChangeRequestCrud;\n    contentReview: ApwContentReviewCrud;\n    scheduleAction: ApwScheduleActionCrud;\n}\n\nexport interface ApwContext extends Context, CmsContext {\n    apw: AdvancedPublishingWorkflow;\n    pageBuilder: PageBuilderContextObject;\n    wcp: WcpContextObject;\n    scheduleAction: ScheduleActionContext[\"scheduleAction\"];\n}\n\nexport interface LifeCycleHookCallbackParams {\n    apw: ApwContext[\"apw\"];\n    security: ApwContext[\"security\"];\n    cms?: ApwContext[\"cms\"];\n}\n\nexport interface CreateApwParams {\n    getLocale: () => I18NLocale;\n    getIdentity: () => SecurityIdentity;\n    getTenant: () => Tenant;\n    getPermission: (name: string) => Promise<SecurityPermission | null>;\n    storageOperations: ApwStorageOperations;\n    scheduler: ApwScheduleActionCrud;\n    handlerClient: HandlerClient;\n    plugins: PluginsContainer;\n}\n\ninterface StorageOperationsGetReviewerParams {\n    id: string;\n}\n\ntype StorageOperationsListReviewersParams = ApwReviewerListParams;\n\ninterface CreateApwReviewerData {\n    identityId: string;\n    displayName: string | null;\n    type: string;\n}\n\ninterface UpdateApwReviewerData {\n    identityId: string;\n    displayName: string | null;\n    type: string;\n}\n\ninterface StorageOperationsCreateReviewerParams {\n    data: CreateApwReviewerData;\n}\n\ninterface StorageOperationsUpdateReviewerParams {\n    id: string;\n    data: UpdateApwReviewerData;\n}\n\ninterface StorageOperationsDeleteReviewerParams {\n    id: string;\n}\n\ninterface StorageOperationsGetParams {\n    id: string;\n}\n\ninterface StorageOperationsDeleteParams {\n    id: string;\n}\n\ntype StorageOperationsGetWorkflowParams = StorageOperationsGetParams;\n\ntype StorageOperationsListWorkflowsParams = ListParams;\n\ninterface StorageOperationsCreateWorkflowParams {\n    data: CreateApwWorkflowParams;\n}\n\ninterface StorageOperationsUpdateWorkflowParams {\n    id: string;\n    data: UpdateApwWorkflowParams;\n}\n\ntype StorageOperationsDeleteWorkflowParams = StorageOperationsDeleteParams;\ntype StorageOperationsGetContentReviewParams = StorageOperationsGetParams;\n\nexport interface ApwContentReviewListParams extends ListParams {\n    where?: ListWhere & {\n        reviewStatus?: ApwContentReviewListFilter;\n        title?: string;\n        title_contains?: string;\n    };\n}\n\ntype StorageOperationsListContentReviewsParams = ApwContentReviewListParams;\n\ninterface StorageOperationsCreateContentReviewParams {\n    data: CreateApwContentReviewParams;\n}\n\ninterface StorageOperationsUpdateContentReviewParams {\n    id: string;\n    data: UpdateApwContentReviewParams;\n}\n\ntype StorageOperationsDeleteContentReviewParams = StorageOperationsDeleteParams;\n\ntype StorageOperationsGetChangeRequestParams = StorageOperationsGetParams;\ntype StorageOperationsListChangeRequestsParams = ApwChangeRequestListParams;\n\ninterface StorageOperationsCreateChangeRequestParams {\n    data: CreateApwChangeRequestParams;\n}\n\ninterface StorageOperationsUpdateChangeRequestParams {\n    id: string;\n    data: UpdateApwChangeRequestParams;\n}\n\ntype StorageOperationsDeleteChangeRequestParams = StorageOperationsDeleteParams;\n\ntype StorageOperationsGetCommentParams = StorageOperationsGetParams;\n\ntype StorageOperationsDeleteCommentParams = StorageOperationsDeleteParams;\ntype StorageOperationsListCommentsParams = ApwCommentListParams;\n\ninterface StorageOperationsCreateCommentParams {\n    data: CreateApwCommentParams;\n}\n\ninterface StorageOperationsUpdateCommentParams {\n    id: string;\n    data: UpdateApwCommentParams;\n}\n\nexport interface ApwReviewerStorageOperations {\n    /*\n     * Reviewer methods\n     */\n    getReviewer(params: StorageOperationsGetReviewerParams): Promise<ApwReviewer>;\n\n    listReviewers(params: StorageOperationsListReviewersParams): Promise<[ApwReviewer[], ListMeta]>;\n\n    createReviewer(params: StorageOperationsCreateReviewerParams): Promise<ApwReviewer>;\n\n    updateReviewer(params: StorageOperationsUpdateReviewerParams): Promise<ApwReviewer>;\n\n    deleteReviewer(params: StorageOperationsDeleteReviewerParams): Promise<Boolean>;\n}\n\nexport interface ApwWorkflowStorageOperations {\n    /*\n     * Workflow methods\n     */\n    getWorkflow(params: StorageOperationsGetWorkflowParams): Promise<ApwWorkflow>;\n\n    listWorkflows(params: StorageOperationsListWorkflowsParams): Promise<[ApwWorkflow[], ListMeta]>;\n\n    createWorkflow(params: StorageOperationsCreateWorkflowParams): Promise<ApwWorkflow>;\n\n    updateWorkflow(params: StorageOperationsUpdateWorkflowParams): Promise<ApwWorkflow>;\n\n    deleteWorkflow(params: StorageOperationsDeleteWorkflowParams): Promise<Boolean>;\n}\n\nexport interface ApwContentReviewStorageOperations {\n    /*\n     * ContentReview methods\n     */\n    getContentReview(params: StorageOperationsGetContentReviewParams): Promise<ApwContentReview>;\n\n    listContentReviews(\n        params: StorageOperationsListContentReviewsParams\n    ): Promise<[ApwContentReview[], ListMeta]>;\n\n    createContentReview(\n        params: StorageOperationsCreateContentReviewParams\n    ): Promise<ApwContentReview>;\n\n    updateContentReview(\n        params: StorageOperationsUpdateContentReviewParams\n    ): Promise<ApwContentReview>;\n\n    deleteContentReview(params: StorageOperationsDeleteContentReviewParams): Promise<Boolean>;\n}\n\nexport interface ApwChangeRequestStorageOperations {\n    /*\n     * ChangeRequest methods\n     */\n    getChangeRequest(params: StorageOperationsGetChangeRequestParams): Promise<ApwChangeRequest>;\n\n    listChangeRequests(\n        params: StorageOperationsListChangeRequestsParams\n    ): Promise<[ApwChangeRequest[], ListMeta]>;\n\n    createChangeRequest(\n        params: StorageOperationsCreateChangeRequestParams\n    ): Promise<ApwChangeRequest>;\n\n    updateChangeRequest(\n        params: StorageOperationsUpdateChangeRequestParams\n    ): Promise<ApwChangeRequest>;\n\n    deleteChangeRequest(params: StorageOperationsDeleteChangeRequestParams): Promise<Boolean>;\n}\n\nexport interface ApwCommentStorageOperations {\n    /*\n     * Comment methods\n     */\n    getComment(params: StorageOperationsGetCommentParams): Promise<ApwComment>;\n\n    listComments(params: StorageOperationsListCommentsParams): Promise<[ApwComment[], ListMeta]>;\n\n    createComment(params: StorageOperationsCreateCommentParams): Promise<ApwComment>;\n\n    updateComment(params: StorageOperationsUpdateCommentParams): Promise<ApwComment>;\n\n    deleteComment(params: StorageOperationsDeleteCommentParams): Promise<Boolean>;\n}\n\nexport interface ApwStorageOperations\n    extends ApwReviewerStorageOperations,\n        ApwWorkflowStorageOperations,\n        ApwContentReviewStorageOperations,\n        ApwChangeRequestStorageOperations,\n        ApwCommentStorageOperations {}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnCommentBeforeCreateTopicParams {\n    input: CreateApwCommentParams;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnCommentAfterCreateTopicParams {\n    comment: ApwComment;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnCommentBeforeUpdateTopicParams {\n    original: ApwComment;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnCommentAfterUpdateTopicParams {\n    original: ApwComment;\n    comment: ApwComment;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnCommentBeforeDeleteTopicParams {\n    comment: ApwComment;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnCommentAfterDeleteTopicParams {\n    comment: ApwComment;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnChangeRequestBeforeCreateTopicParams {\n    input: CreateApwChangeRequestParams;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnChangeRequestAfterCreateTopicParams {\n    changeRequest: ApwChangeRequest;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnChangeRequestBeforeUpdateTopicParams {\n    original: ApwChangeRequest;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnChangeRequestAfterUpdateTopicParams {\n    original: ApwChangeRequest;\n    changeRequest: ApwChangeRequest;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnChangeRequestBeforeDeleteTopicParams {\n    changeRequest: ApwChangeRequest;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnChangeRequestAfterDeleteTopicParams {\n    changeRequest: ApwChangeRequest;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnContentReviewBeforeCreateTopicParams {\n    input: CreateApwContentReviewParams;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnContentReviewAfterCreateTopicParams {\n    contentReview: ApwContentReview;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnContentReviewBeforeUpdateTopicParams {\n    original: ApwContentReview;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnContentReviewAfterUpdateTopicParams {\n    original: ApwContentReview;\n    contentReview: ApwContentReview;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnContentReviewBeforeDeleteTopicParams {\n    contentReview: ApwContentReview;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnContentReviewAfterDeleteTopicParams {\n    contentReview: ApwContentReview;\n}\n\nexport interface CreateApwReviewerParams {\n    type: string;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnReviewerBeforeCreateTopicParams {\n    input: CreateApwReviewerParams;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnReviewerAfterCreateTopicParams {\n    reviewer: ApwReviewer;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnReviewerBeforeUpdateTopicParams {\n    original: ApwReviewer;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnReviewerAfterUpdateTopicParams {\n    original: ApwReviewer;\n    reviewer: ApwReviewer;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnReviewerBeforeDeleteTopicParams {\n    reviewer: ApwReviewer;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnReviewerAfterDeleteTopicParams {\n    reviewer: ApwReviewer;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnWorkflowBeforeCreateTopicParams {\n    input: CreateApwWorkflowParams;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnWorkflowAfterCreateTopicParams {\n    workflow: ApwWorkflow;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnWorkflowBeforeUpdateTopicParams {\n    original: ApwWorkflow;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnWorkflowAfterUpdateTopicParams {\n    original: ApwWorkflow;\n    workflow: ApwWorkflow;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnWorkflowBeforeDeleteTopicParams {\n    workflow: ApwWorkflow;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnWorkflowAfterDeleteTopicParams {\n    workflow: ApwWorkflow;\n}\n\nexport type WorkflowModelDefinition = Pick<\n    CmsModel,\n    \"name\" | \"modelId\" | \"layout\" | \"titleFieldId\" | \"description\" | \"fields\" | \"isPrivate\"\n>;\n\n/**\n * Headless CMS\n */\nexport interface OnCmsEntryBeforePublishTopicParams\n    extends Omit<OnEntryBeforePublishTopicParams, \"entry\"> {\n    entry: ApwCmsEntry;\n}\nexport interface OnCmsEntryAfterPublishTopicParams\n    extends Omit<OnEntryAfterPublishTopicParams, \"entry\"> {\n    entry: ApwCmsEntry;\n}\nexport interface OnCmsEntryAfterUnpublishTopicParams\n    extends Omit<OnEntryAfterUnpublishTopicParams, \"entry\"> {\n    entry: ApwCmsEntry;\n}\n"],"mappings":";;;;;;IAoFYA,e;;;WAAAA,e;EAAAA,e;EAAAA,e;GAAAA,e,+BAAAA,e;;IAwBAC,kB;;;WAAAA,kB;EAAAA,kB;EAAAA,kB;GAAAA,kB,kCAAAA,kB;;IAKAC,0B;;;WAAAA,0B;EAAAA,0B;EAAAA,0B;EAAAA,0B;GAAAA,0B,0CAAAA,0B;;IAMAC,uB;AAKZ;AACA;AACA;AACA;AACA;;;;WATYA,uB;EAAAA,uB;EAAAA,uB;GAAAA,uB,uCAAAA,uB;;IAgGAC,oB;;;WAAAA,oB;EAAAA,oB;EAAAA,oB;EAAAA,oB;GAAAA,oB,oCAAAA,oB;;IAMAC,sB;;;WAAAA,sB;EAAAA,sB;EAAAA,sB;EAAAA,sB;GAAAA,sB,sCAAAA,sB;;IAuEPC,sB;;WAAAA,sB;EAAAA,sB;EAAAA,sB;GAAAA,sB,KAAAA,sB"}
+{"version":3,"names":["ApwContentTypes","exports","WorkflowScopeTypes","ApwContentReviewStepStatus","ApwWorkflowApplications","ApwWorkflowStepTypes","ApwContentReviewStatus","ApwScheduleActionTypes"],"sources":["types.ts"],"sourcesContent":["import type {\n    CmsEntry as BaseCmsEntry,\n    OnEntryBeforePublishTopicParams,\n    OnEntryAfterPublishTopicParams,\n    OnEntryAfterUnpublishTopicParams,\n    CmsEntryListSort\n} from \"@webiny/api-headless-cms/types\";\nimport type { Context } from \"@webiny/api/types\";\nimport type { SecurityIdentity, SecurityPermission } from \"@webiny/api-security/types\";\nimport type { I18NLocale } from \"@webiny/api-i18n/types\";\nimport type { Tenant } from \"@webiny/api-tenancy/types\";\nimport type { Topic } from \"@webiny/pubsub/types\";\nimport type { ApwScheduleActionCrud, ScheduleActionContext } from \"~/scheduler/types\";\nimport type HandlerClient from \"@webiny/handler-client/HandlerClient\";\nimport type { PluginsContainer } from \"@webiny/plugins\";\nimport type { WcpContextObject } from \"@webiny/api-wcp/types\";\nimport type { MailerContext } from \"@webiny/api-mailer/types\";\n\nexport interface ApwCmsEntry extends BaseCmsEntry {\n    title: string;\n    meta: {\n        apw?: {\n            contentReviewId?: string | null;\n            workflowId?: string | null;\n        };\n    };\n}\n\nexport interface ApwFile {\n    id: string;\n    key: string;\n    size: number;\n    type: string;\n    name: string;\n}\n\nexport interface ListWhere {\n    /**\n     * Fields.\n     */\n    id?: string;\n    id_in?: string[];\n    id_not?: string;\n    id_not_in?: string[];\n    /**\n     * Who created the entry?\n     */\n    createdBy?: string;\n    createdBy_not?: string;\n    createdBy_in?: string[];\n    createdBy_not_in?: string[];\n}\n\nexport interface ListParams {\n    where?: ListWhere;\n    sort?: CmsEntryListSort;\n    limit?: number;\n    after?: string | null;\n}\n\nexport interface ListMeta {\n    /**\n     * A cursor for pagination.\n     */\n    cursor: string | null;\n    /**\n     * Is there more items to load?\n     */\n    hasMoreItems: boolean;\n    /**\n     * Total count of the items in the storage.\n     */\n    totalCount: number;\n}\n\nexport enum ApwContentTypes {\n    PAGE = \"page\",\n    CMS_ENTRY = \"cms_entry\"\n}\n\nexport enum WorkflowScopeTypes {\n    DEFAULT = \"default\",\n    CUSTOM = \"custom\"\n}\n\nexport enum ApwContentReviewStepStatus {\n    DONE = \"done\",\n    ACTIVE = \"active\",\n    INACTIVE = \"inactive\"\n}\n\nexport enum ApwWorkflowApplications {\n    PB = \"pageBuilder\",\n    CMS = \"cms\"\n}\n\n/**\n * A interface describing the reference to a user that created some data in the database.\n *\n * @category General\n */\nexport interface ApwIdentity {\n    /**\n     * ID if the user.\n     */\n    id: string;\n    /**\n     * Full name of the user.\n     */\n    displayName: string | null;\n    /**\n     * Type of the user (admin, user)\n     */\n    type: string;\n}\n\nexport interface ApwBaseFields {\n    id: string;\n    entryId: string;\n\n    createdOn: string;\n    modifiedOn: string | null;\n    savedOn: string;\n    createdBy: ApwIdentity;\n    modifiedBy: ApwIdentity;\n    savedBy: ApwIdentity;\n}\n\nexport interface ApwReviewer extends ApwBaseFields {\n    identityId: string;\n    displayName: string | null;\n    type: string;\n    email?: string;\n}\n\nexport interface ApwReviewerWithEmail extends Omit<ApwReviewer, \"email\"> {\n    email: string;\n}\n\nexport interface ApwComment extends ApwBaseFields {\n    body: Record<string, any>;\n    changeRequest: string;\n    step: string;\n    media: ApwFile;\n}\n\nexport interface ApwChangeRequest extends ApwBaseFields {\n    body: Record<string, any>;\n    title: string;\n    resolved: boolean;\n    step: string;\n    media: ApwFile;\n}\n\nexport interface ApwContentReviewStep {\n    type: ApwWorkflowStepTypes;\n    title: string;\n    slug: string;\n    reviewers: ApwReviewer[];\n    status: ApwContentReviewStepStatus;\n    pendingChangeRequests: number;\n    totalComments: number;\n    signOffProvidedOn: string | null;\n    signOffProvidedBy: ApwIdentity | null;\n}\n\nexport interface ApwContentReview extends ApwBaseFields {\n    title: string;\n    reviewStatus: ApwContentReviewStatus;\n    content: ApwContentReviewContent;\n    steps: Array<ApwContentReviewStep>;\n    latestCommentId: string | null;\n    workflowId: string;\n}\n\nexport interface ApwWorkflow extends ApwBaseFields {\n    title: string;\n    steps: ApwWorkflowStep[];\n    scope: ApwWorkflowScope;\n    app: ApwWorkflowApplications;\n}\n\ninterface ApwWorkflowScopeCmsEntry {\n    id: string;\n    modelId: string;\n}\n\nexport interface ApwWorkflowScope {\n    type: WorkflowScopeTypes;\n    data: {\n        categories?: string[];\n        pages?: string[];\n        models?: string[];\n        entries?: ApwWorkflowScopeCmsEntry[];\n    };\n}\n\nexport enum ApwWorkflowStepTypes {\n    MANDATORY_BLOCKING = \"mandatoryBlocking\",\n    MANDATORY_NON_BLOCKING = \"mandatoryNonBlocking\",\n    NON_MANDATORY = \"notMandatory\"\n}\n\nexport enum ApwContentReviewStatus {\n    UNDER_REVIEW = \"underReview\",\n    READY_TO_BE_PUBLISHED = \"readyToBePublished\",\n    PUBLISHED = \"published\"\n}\n\nexport type ApwContentReviewListFilter = ApwContentReviewStatus | \"requiresMyAttention\";\n\nexport interface ApwWorkflowStep<TReviewer = ApwReviewer> {\n    title: string;\n    type: ApwWorkflowStepTypes;\n    reviewers: TReviewer[];\n    id: string;\n}\n\nexport interface ApwContentReviewStep extends ApwWorkflowStep {\n    status: ApwContentReviewStepStatus;\n    pendingChangeRequests: number;\n}\n\nexport interface CreateApwWorkflowParams<TReviewer = string> {\n    app: ApwWorkflowApplications;\n    title: string;\n    scope: ApwWorkflowScope;\n    steps: ApwWorkflowStep<TReviewer>[];\n}\n\nexport interface UpdateApwWorkflowParams<TReviewer = string> {\n    title?: string;\n    scope?: ApwWorkflowScope;\n    steps?: ApwWorkflowStep<TReviewer>[];\n}\n\nexport interface ListWorkflowsParams extends ListParams {\n    where?: ListWhere & {\n        app?: ApwWorkflowApplications;\n    };\n}\n\ninterface CreateApwCommentParams {\n    body: Record<string, any>;\n    changeRequest: string;\n    step: string;\n    media: ApwFile;\n}\n\ninterface UpdateApwCommentParams {\n    body: Record<string, any>;\n}\n\ninterface CreateApwChangeRequestParams {\n    title: string;\n    step: string;\n    body: Record<string, any>;\n    resolved: boolean;\n    media: Record<string, any>;\n}\n\ninterface UpdateApwChangeRequestParams {\n    title: string;\n    body: Record<string, any>;\n    resolved: boolean;\n    media: Record<string, any>;\n}\n\nenum ApwScheduleActionTypes {\n    PUBLISH = \"publish\",\n    UNPUBLISH = \"unpublish\"\n}\n\nexport interface ApwScheduleActionData {\n    action: ApwScheduleActionTypes;\n    type: ApwContentTypes;\n    datetime: string;\n    entryId: string;\n    /**\n     * We will add modelId to the data for now.\n     * TODO extract in separate package?\n     */\n    modelId?: string;\n}\n\nexport interface ApwContentReviewContent {\n    id: string;\n    type: ApwContentTypes;\n    settings: {\n        modelId?: string;\n    };\n    scheduledOn?: string | null;\n    scheduledBy?: string | null;\n    scheduledActionId?: string | null;\n    publishedBy?: string | null;\n}\n\nexport interface CreateApwContentReviewParams {\n    content: ApwContentReviewContent;\n    reviewStatus: ApwContentReviewStatus;\n    workflowId?: string;\n}\n\nexport interface UpdateApwContentReviewParams {\n    title?: string;\n    steps?: ApwContentReviewStep[];\n    reviewStatus?: ApwContentReviewStatus;\n    content?: ApwContentReviewContent;\n}\n\ninterface BaseApwCrud<TEntry, TCreateEntryParams, TUpdateEntryParams> {\n    get(id: string): Promise<TEntry>;\n\n    create(data: TCreateEntryParams): Promise<TEntry>;\n\n    update(id: string, data: TUpdateEntryParams): Promise<TEntry>;\n\n    delete(id: string): Promise<boolean>;\n}\n\nexport interface ApwWorkflowCrud\n    extends BaseApwCrud<ApwWorkflow, CreateApwWorkflowParams, UpdateApwWorkflowParams> {\n    list(params?: ListWorkflowsParams): Promise<[ApwWorkflow[], ListMeta]>;\n\n    /**\n     * Lifecycle events\n     */\n    onWorkflowBeforeCreate: Topic<OnWorkflowBeforeCreateTopicParams>;\n    onWorkflowAfterCreate: Topic<OnWorkflowAfterCreateTopicParams>;\n    onWorkflowBeforeUpdate: Topic<OnWorkflowBeforeUpdateTopicParams>;\n    onWorkflowAfterUpdate: Topic<OnWorkflowAfterUpdateTopicParams>;\n    onWorkflowBeforeDelete: Topic<OnWorkflowBeforeDeleteTopicParams>;\n    onWorkflowAfterDelete: Topic<OnWorkflowAfterDeleteTopicParams>;\n}\n\nexport interface ApwReviewerListParams extends ListParams {\n    where: ListParams[\"where\"] & {\n        identityId?: string;\n    };\n}\n\nexport interface ApwReviewerCrud\n    extends BaseApwCrud<ApwReviewer, CreateApwReviewerData, UpdateApwReviewerData> {\n    list(params: ApwReviewerListParams): Promise<[ApwReviewer[], ListMeta]>;\n\n    /**\n     * Lifecycle events\n     */\n    onReviewerBeforeCreate: Topic<OnReviewerBeforeCreateTopicParams>;\n    onReviewerAfterCreate: Topic<OnReviewerAfterCreateTopicParams>;\n    onReviewerBeforeUpdate: Topic<OnReviewerBeforeUpdateTopicParams>;\n    onReviewerAfterUpdate: Topic<OnReviewerAfterUpdateTopicParams>;\n    onReviewerBeforeDelete: Topic<OnReviewerBeforeDeleteTopicParams>;\n    onReviewerAfterDelete: Topic<OnReviewerAfterDeleteTopicParams>;\n}\n\nexport interface ApwCommentListParams extends ListParams {\n    where: ListParams[\"where\"] & {\n        changeRequest?: {\n            id?: string;\n        };\n    };\n}\n\nexport interface ApwCommentCrud\n    extends BaseApwCrud<ApwComment, CreateApwCommentParams, UpdateApwCommentParams> {\n    list(params: ApwCommentListParams): Promise<[ApwComment[], ListMeta]>;\n\n    /**\n     * Lifecycle events\n     */\n    onCommentBeforeCreate: Topic<OnCommentBeforeCreateTopicParams>;\n    onCommentAfterCreate: Topic<OnCommentAfterCreateTopicParams>;\n    onCommentBeforeUpdate: Topic<OnCommentBeforeUpdateTopicParams>;\n    onCommentAfterUpdate: Topic<OnCommentAfterUpdateTopicParams>;\n    onCommentBeforeDelete: Topic<OnCommentBeforeDeleteTopicParams>;\n    onCommentAfterDelete: Topic<OnCommentAfterDeleteTopicParams>;\n}\n\nexport interface ApwChangeRequestListParams extends ListParams {\n    where: ListParams[\"where\"] & {\n        step?: string;\n    };\n}\n\nexport interface ApwChangeRequestCrud\n    extends BaseApwCrud<\n        ApwChangeRequest,\n        CreateApwChangeRequestParams,\n        UpdateApwChangeRequestParams\n    > {\n    list(params: ApwChangeRequestListParams): Promise<[ApwChangeRequest[], ListMeta]>;\n\n    /**\n     * Lifecycle events\n     */\n    onChangeRequestBeforeCreate: Topic<OnChangeRequestBeforeCreateTopicParams>;\n    onChangeRequestAfterCreate: Topic<OnChangeRequestAfterCreateTopicParams>;\n    onChangeRequestBeforeUpdate: Topic<OnChangeRequestBeforeUpdateTopicParams>;\n    onChangeRequestAfterUpdate: Topic<OnChangeRequestAfterUpdateTopicParams>;\n    onChangeRequestBeforeDelete: Topic<OnChangeRequestBeforeDeleteTopicParams>;\n    onChangeRequestAfterDelete: Topic<OnChangeRequestAfterDeleteTopicParams>;\n}\n\nexport interface ApwContentReviewCrud\n    extends BaseApwCrud<\n        ApwContentReview,\n        CreateApwContentReviewParams,\n        UpdateApwContentReviewParams\n    > {\n    list(params: ApwContentReviewListParams): Promise<[ApwContentReview[], ListMeta]>;\n\n    provideSignOff(id: string, step: string): Promise<boolean>;\n\n    retractSignOff(id: string, step: string): Promise<boolean>;\n\n    isReviewRequired(data: ApwContentReviewContent): Promise<{\n        isReviewRequired: boolean;\n        contentReviewId?: string | null;\n    }>;\n\n    publishContent(id: string, datetime?: string): Promise<boolean>;\n\n    unpublishContent(id: string, datetime?: string): Promise<boolean>;\n\n    scheduleAction(data: ApwScheduleActionData): Promise<string>;\n\n    deleteScheduledAction(id: string): Promise<boolean>;\n\n    /**\n     * Lifecycle events\n     */\n    onContentReviewBeforeCreate: Topic<OnContentReviewBeforeCreateTopicParams>;\n    onContentReviewAfterCreate: Topic<OnContentReviewAfterCreateTopicParams>;\n    onContentReviewBeforeUpdate: Topic<OnContentReviewBeforeUpdateTopicParams>;\n    onContentReviewAfterUpdate: Topic<OnContentReviewAfterUpdateTopicParams>;\n    onContentReviewBeforeDelete: Topic<OnContentReviewBeforeDeleteTopicParams>;\n    onContentReviewAfterDelete: Topic<OnContentReviewAfterDeleteTopicParams>;\n    onContentReviewBeforeList: Topic<OnContentReviewBeforeListTopicParams>;\n}\n\nexport type ContentGetter = (\n    id: string,\n    settings: { modelId?: string }\n) => Promise<ApwCmsEntry | null>;\n\nexport type ContentPublisher = (\n    id: string,\n    settings: { modelId?: string }\n) => Promise<boolean | null>;\n\nexport type ContentUnPublisher = (\n    id: string,\n    settings: { modelId?: string }\n) => Promise<boolean | null>;\n\nexport interface AdvancedPublishingWorkflow {\n    addContentGetter: (type: ApwContentTypes, func: ContentGetter) => void;\n    getContentGetter: (type: ApwContentTypes) => ContentGetter;\n    addContentPublisher: (type: ApwContentTypes, func: ContentPublisher) => void;\n    getContentPublisher: (type: ApwContentTypes) => ContentPublisher;\n    addContentUnPublisher: (type: ApwContentTypes, func: ContentUnPublisher) => void;\n    getContentUnPublisher: (type: ApwContentTypes) => ContentUnPublisher;\n    workflow: ApwWorkflowCrud;\n    reviewer: ApwReviewerCrud;\n    comment: ApwCommentCrud;\n    changeRequest: ApwChangeRequestCrud;\n    contentReview: ApwContentReviewCrud;\n    scheduleAction: ApwScheduleActionCrud;\n}\n\nexport interface ApwContext extends Context, MailerContext {\n    apw: AdvancedPublishingWorkflow;\n    wcp: WcpContextObject;\n    scheduleAction: ScheduleActionContext[\"scheduleAction\"];\n}\n\nexport interface LifeCycleHookCallbackParams {\n    apw: ApwContext[\"apw\"];\n    security: ApwContext[\"security\"];\n    cms?: ApwContext[\"cms\"];\n}\n\nexport interface CreateApwParams {\n    getLocale: () => I18NLocale;\n    getIdentity: () => SecurityIdentity;\n    getTenant: () => Tenant;\n    getPermission: (name: string) => Promise<SecurityPermission | null>;\n    storageOperations: ApwStorageOperations;\n    scheduler: ApwScheduleActionCrud;\n    handlerClient: HandlerClient;\n    plugins: PluginsContainer;\n}\n\ninterface StorageOperationsGetReviewerParams {\n    id: string;\n}\n\ntype StorageOperationsListReviewersParams = ApwReviewerListParams;\n\ninterface CreateApwReviewerData {\n    identityId: string;\n    displayName: string | null;\n    type: string;\n    email?: string | null;\n}\n\ninterface UpdateApwReviewerData {\n    identityId: string;\n    displayName: string | null;\n    type: string;\n    email?: string | null;\n}\n\ninterface StorageOperationsCreateReviewerParams {\n    data: CreateApwReviewerData;\n}\n\ninterface StorageOperationsUpdateReviewerParams {\n    id: string;\n    data: UpdateApwReviewerData;\n}\n\ninterface StorageOperationsDeleteReviewerParams {\n    id: string;\n}\n\ninterface StorageOperationsGetParams {\n    id: string;\n}\n\ninterface StorageOperationsDeleteParams {\n    id: string;\n}\n\ntype StorageOperationsGetWorkflowParams = StorageOperationsGetParams;\n\ntype StorageOperationsListWorkflowsParams = ListParams;\n\ninterface StorageOperationsCreateWorkflowParams {\n    data: CreateApwWorkflowParams;\n}\n\ninterface StorageOperationsUpdateWorkflowParams {\n    id: string;\n    data: UpdateApwWorkflowParams;\n}\n\ntype StorageOperationsDeleteWorkflowParams = StorageOperationsDeleteParams;\ntype StorageOperationsGetContentReviewParams = StorageOperationsGetParams;\n\nexport interface ApwContentReviewListParams extends ListParams {\n    where: ListWhere & {\n        reviewStatus?: ApwContentReviewListFilter;\n        title?: string;\n        title_contains?: string;\n        workflowId?: string;\n        workflowId_in?: string[];\n    };\n}\n\ntype StorageOperationsListContentReviewsParams = ApwContentReviewListParams;\n\ninterface StorageOperationsCreateContentReviewParams {\n    data: CreateApwContentReviewParams;\n}\n\ninterface StorageOperationsUpdateContentReviewParams {\n    id: string;\n    data: UpdateApwContentReviewParams;\n}\n\ntype StorageOperationsDeleteContentReviewParams = StorageOperationsDeleteParams;\n\ntype StorageOperationsGetChangeRequestParams = StorageOperationsGetParams;\ntype StorageOperationsListChangeRequestsParams = ApwChangeRequestListParams;\n\ninterface StorageOperationsCreateChangeRequestParams {\n    data: CreateApwChangeRequestParams;\n}\n\ninterface StorageOperationsUpdateChangeRequestParams {\n    id: string;\n    data: UpdateApwChangeRequestParams;\n}\n\ntype StorageOperationsDeleteChangeRequestParams = StorageOperationsDeleteParams;\n\ntype StorageOperationsGetCommentParams = StorageOperationsGetParams;\n\ntype StorageOperationsDeleteCommentParams = StorageOperationsDeleteParams;\ntype StorageOperationsListCommentsParams = ApwCommentListParams;\n\ninterface StorageOperationsCreateCommentParams {\n    data: CreateApwCommentParams;\n}\n\ninterface StorageOperationsUpdateCommentParams {\n    id: string;\n    data: UpdateApwCommentParams;\n}\n\nexport interface ApwReviewerStorageOperations {\n    /*\n     * Reviewer methods\n     */\n    getReviewer(params: StorageOperationsGetReviewerParams): Promise<ApwReviewer>;\n\n    listReviewers(params: StorageOperationsListReviewersParams): Promise<[ApwReviewer[], ListMeta]>;\n\n    createReviewer(params: StorageOperationsCreateReviewerParams): Promise<ApwReviewer>;\n\n    updateReviewer(params: StorageOperationsUpdateReviewerParams): Promise<ApwReviewer>;\n\n    deleteReviewer(params: StorageOperationsDeleteReviewerParams): Promise<boolean>;\n}\n\nexport interface ApwWorkflowStorageOperations {\n    /*\n     * Workflow methods\n     */\n    getWorkflow(params: StorageOperationsGetWorkflowParams): Promise<ApwWorkflow>;\n\n    listWorkflows(params: StorageOperationsListWorkflowsParams): Promise<[ApwWorkflow[], ListMeta]>;\n\n    createWorkflow(params: StorageOperationsCreateWorkflowParams): Promise<ApwWorkflow>;\n\n    updateWorkflow(params: StorageOperationsUpdateWorkflowParams): Promise<ApwWorkflow>;\n\n    deleteWorkflow(params: StorageOperationsDeleteWorkflowParams): Promise<boolean>;\n}\n\nexport interface ApwContentReviewStorageOperations {\n    /*\n     * ContentReview methods\n     */\n    getContentReview(params: StorageOperationsGetContentReviewParams): Promise<ApwContentReview>;\n\n    listContentReviews(\n        params: StorageOperationsListContentReviewsParams\n    ): Promise<[ApwContentReview[], ListMeta]>;\n\n    createContentReview(\n        params: StorageOperationsCreateContentReviewParams\n    ): Promise<ApwContentReview>;\n\n    updateContentReview(\n        params: StorageOperationsUpdateContentReviewParams\n    ): Promise<ApwContentReview>;\n\n    deleteContentReview(params: StorageOperationsDeleteContentReviewParams): Promise<boolean>;\n}\n\nexport interface ApwChangeRequestStorageOperations {\n    /*\n     * ChangeRequest methods\n     */\n    getChangeRequest(params: StorageOperationsGetChangeRequestParams): Promise<ApwChangeRequest>;\n\n    listChangeRequests(\n        params: StorageOperationsListChangeRequestsParams\n    ): Promise<[ApwChangeRequest[], ListMeta]>;\n\n    createChangeRequest(\n        params: StorageOperationsCreateChangeRequestParams\n    ): Promise<ApwChangeRequest>;\n\n    updateChangeRequest(\n        params: StorageOperationsUpdateChangeRequestParams\n    ): Promise<ApwChangeRequest>;\n\n    deleteChangeRequest(params: StorageOperationsDeleteChangeRequestParams): Promise<boolean>;\n}\n\nexport interface ApwCommentStorageOperations {\n    /*\n     * Comment methods\n     */\n    getComment(params: StorageOperationsGetCommentParams): Promise<ApwComment>;\n\n    listComments(params: StorageOperationsListCommentsParams): Promise<[ApwComment[], ListMeta]>;\n\n    createComment(params: StorageOperationsCreateCommentParams): Promise<ApwComment>;\n\n    updateComment(params: StorageOperationsUpdateCommentParams): Promise<ApwComment>;\n\n    deleteComment(params: StorageOperationsDeleteCommentParams): Promise<boolean>;\n}\n\nexport interface ApwStorageOperations\n    extends ApwReviewerStorageOperations,\n        ApwWorkflowStorageOperations,\n        ApwContentReviewStorageOperations,\n        ApwChangeRequestStorageOperations,\n        ApwCommentStorageOperations {}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnCommentBeforeCreateTopicParams {\n    input: CreateApwCommentParams;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnCommentAfterCreateTopicParams {\n    comment: ApwComment;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnCommentBeforeUpdateTopicParams {\n    original: ApwComment;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnCommentAfterUpdateTopicParams {\n    original: ApwComment;\n    comment: ApwComment;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnCommentBeforeDeleteTopicParams {\n    comment: ApwComment;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnCommentAfterDeleteTopicParams {\n    comment: ApwComment;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnChangeRequestBeforeCreateTopicParams {\n    input: CreateApwChangeRequestParams;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnChangeRequestAfterCreateTopicParams {\n    changeRequest: ApwChangeRequest;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnChangeRequestBeforeUpdateTopicParams {\n    original: ApwChangeRequest;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnChangeRequestAfterUpdateTopicParams {\n    original: ApwChangeRequest;\n    changeRequest: ApwChangeRequest;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnChangeRequestBeforeDeleteTopicParams {\n    changeRequest: ApwChangeRequest;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnChangeRequestAfterDeleteTopicParams {\n    changeRequest: ApwChangeRequest;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnContentReviewBeforeCreateTopicParams {\n    input: CreateApwContentReviewParams;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnContentReviewAfterCreateTopicParams {\n    contentReview: ApwContentReview;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnContentReviewBeforeUpdateTopicParams {\n    original: ApwContentReview;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnContentReviewAfterUpdateTopicParams {\n    original: ApwContentReview;\n    contentReview: ApwContentReview;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnContentReviewBeforeDeleteTopicParams {\n    contentReview: ApwContentReview;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnContentReviewAfterDeleteTopicParams {\n    contentReview: ApwContentReview;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnContentReviewBeforeListTopicParams {\n    where: ApwContentReviewListParams[\"where\"];\n}\n\nexport interface CreateApwReviewerParams {\n    type: string;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnReviewerBeforeCreateTopicParams {\n    input: CreateApwReviewerParams;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnReviewerAfterCreateTopicParams {\n    reviewer: ApwReviewer;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnReviewerBeforeUpdateTopicParams {\n    original: ApwReviewer;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnReviewerAfterUpdateTopicParams {\n    original: ApwReviewer;\n    reviewer: ApwReviewer;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnReviewerBeforeDeleteTopicParams {\n    reviewer: ApwReviewer;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnReviewerAfterDeleteTopicParams {\n    reviewer: ApwReviewer;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnWorkflowBeforeCreateTopicParams {\n    input: CreateApwWorkflowParams;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnWorkflowAfterCreateTopicParams {\n    workflow: ApwWorkflow;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnWorkflowBeforeUpdateTopicParams {\n    original: ApwWorkflow;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnWorkflowAfterUpdateTopicParams {\n    original: ApwWorkflow;\n    workflow: ApwWorkflow;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnWorkflowBeforeDeleteTopicParams {\n    workflow: ApwWorkflow;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnWorkflowAfterDeleteTopicParams {\n    workflow: ApwWorkflow;\n}\n\n/**\n * Headless CMS\n */\nexport interface OnCmsEntryBeforePublishTopicParams\n    extends Omit<OnEntryBeforePublishTopicParams, \"entry\"> {\n    entry: ApwCmsEntry;\n}\n\nexport interface OnCmsEntryAfterPublishTopicParams\n    extends Omit<OnEntryAfterPublishTopicParams, \"entry\"> {\n    entry: ApwCmsEntry;\n}\n\nexport interface OnCmsEntryAfterUnpublishTopicParams\n    extends Omit<OnEntryAfterUnpublishTopicParams, \"entry\"> {\n    entry: ApwCmsEntry;\n}\n"],"mappings":";;;;;;IA2EYA,eAAe,GAAAC,OAAA,CAAAD,eAAA,0BAAfA,eAAe;EAAfA,eAAe;EAAfA,eAAe;EAAA,OAAfA,eAAe;AAAA;AAAA,IAKfE,kBAAkB,GAAAD,OAAA,CAAAC,kBAAA,0BAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAA,OAAlBA,kBAAkB;AAAA;AAAA,IAKlBC,0BAA0B,GAAAF,OAAA,CAAAE,0BAAA,0BAA1BA,0BAA0B;EAA1BA,0BAA0B;EAA1BA,0BAA0B;EAA1BA,0BAA0B;EAAA,OAA1BA,0BAA0B;AAAA;AAAA,IAM1BC,uBAAuB,GAAAH,OAAA,CAAAG,uBAAA,0BAAvBA,uBAAuB;EAAvBA,uBAAuB;EAAvBA,uBAAuB;EAAA,OAAvBA,uBAAuB;AAAA;AAKnC;AACA;AACA;AACA;AACA;AAJA,IAqGYC,oBAAoB,GAAAJ,OAAA,CAAAI,oBAAA,0BAApBA,oBAAoB;EAApBA,oBAAoB;EAApBA,oBAAoB;EAApBA,oBAAoB;EAAA,OAApBA,oBAAoB;AAAA;AAAA,IAMpBC,sBAAsB,GAAAL,OAAA,CAAAK,sBAAA,0BAAtBA,sBAAsB;EAAtBA,sBAAsB;EAAtBA,sBAAsB;EAAtBA,sBAAsB;EAAA,OAAtBA,sBAAsB;AAAA;AAAA,IAiE7BC,sBAAsB,0BAAtBA,sBAAsB;EAAtBA,sBAAsB;EAAtBA,sBAAsB;EAAA,OAAtBA,sBAAsB;AAAA,EAAtBA,sBAAsB;AA4a3B;AACA;AACA;AAKA;AACA;AACA;AAKA;AACA;AACA;AAMA;AACA;AACA;AAOA;AACA;AACA;AAKA;AACA;AACA;AAKA;AACA;AACA;AAKA;AACA;AACA;AAKA;AACA;AACA;AAMA;AACA;AACA;AAOA;AACA;AACA;AAKA;AACA;AACA;AAKA;AACA;AACA;AAKA;AACA;AACA;AAKA;AACA;AACA;AAMA;AACA;AACA;AAOA;AACA;AACA;AAKA;AACA;AACA;AAKA;AACA;AACA;AASA;AACA;AACA;AAKA;AACA;AACA;AAKA;AACA;AACA;AAMA;AACA;AACA;AAOA;AACA;AACA;AAKA;AACA;AACA;AAKA;AACA;AACA;AAKA;AACA;AACA;AAKA;AACA;AACA;AAMA;AACA;AACA;AAOA;AACA;AACA;AAKA;AACA;AACA;AAKA;AACA;AACA","ignoreList":[]}

package/utils/contentApwSettingsPlugin.d.ts

@@ -1,5 +1,5 @@
-import { ApwContentTypes } from "../types";
-import { PluginsContainer } from "@webiny/plugins";
+import type { ApwContentTypes } from "../types";
+import type { PluginsContainer } from "@webiny/plugins";
 import { ContentApwSettingsPlugin } from "../ContentApwSettingsPlugin";
 interface GetContentApwSettingsPluginParams {
     type: ApwContentTypes;