@webiny/api-apw 0.0.0-unstable.8c4d9f045a → 0.0.0-unstable.8feaff8c32

package/types.d.ts

@@ -1,5 +1,5 @@
-import { CmsContext, CmsEntry as BaseCmsEntry, CmsModel, BeforeEntryPublishTopicParams, AfterEntryPublishTopicParams, AfterEntryUnpublishTopicParams } from "@webiny/api-headless-cms/types";
-import { Page, OnBeforePageCreateTopicParams, OnBeforePageCreateFromTopicParams, OnBeforePageUpdateTopicParams, OnBeforePagePublishTopicParams, OnBeforePageRequestReviewTopicParams, PageSettings } from "@webiny/api-page-builder/types";
+import { CmsEntry as BaseCmsEntry, 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";
@@ -10,6 +10,9 @@ 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 { MailerContext } from "@webiny/api-mailer/types";
+import { AdminSettingsContext } from "@webiny/api-admin-settings/types";
+import { CmsPrivateModelFull } from "@webiny/api-headless-cms";
 export interface ApwCmsEntry extends BaseCmsEntry {
     title: string;
     meta: {
@@ -75,11 +78,10 @@ export interface PageSettingsWithWorkflow extends PageSettings {
 export interface PageWithWorkflow extends Page {
     settings: PageSettingsWithWorkflow;
 }
-export declare type ApwOnBeforePageCreateTopicParams = OnBeforePageCreateTopicParams<PageWithWorkflow>;
-export declare type ApwOnBeforePageCreateFromTopicParams = OnBeforePageCreateFromTopicParams<PageWithWorkflow>;
-export declare type ApwOnBeforePageUpdateTopicParams = OnBeforePageUpdateTopicParams<PageWithWorkflow>;
-export declare type ApwOnBeforePagePublishTopicParams = OnBeforePagePublishTopicParams<PageWithWorkflow>;
-export declare type ApwOnBeforePageRequestReviewTopicParams = OnBeforePageRequestReviewTopicParams<PageWithWorkflow>;
+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"
@@ -98,7 +100,7 @@ export declare enum ApwWorkflowApplications {
  *
  * @category General
  */
-export interface CreatedBy {
+export interface ApwIdentity {
     /**
      * ID if the user.
      */
@@ -114,14 +116,19 @@ export interface CreatedBy {
 }
 export interface ApwBaseFields {
     id: string;
+    entryId: string;
     createdOn: string;
     savedOn: string;
-    createdBy: CreatedBy;
+    createdBy: 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,14 +152,15 @@ export interface ApwContentReviewStep {
     pendingChangeRequests: number;
     totalComments: number;
     signOffProvidedOn: string | null;
-    signOffProvidedBy: CreatedBy | null;
+    signOffProvidedBy: ApwIdentity | null;
 }
 export interface ApwContentReview extends ApwBaseFields {
     title: string;
-    status: ApwContentReviewStatus;
+    reviewStatus: ApwContentReviewStatus;
     content: ApwContentReviewContent;
     steps: Array<ApwContentReviewStep>;
     latestCommentId: string | null;
+    workflowId: string;
 }
 export interface ApwWorkflow extends ApwBaseFields {
     title: string;
@@ -206,15 +214,10 @@ export interface UpdateApwWorkflowParams<TReviewer = string> {
     steps?: ApwWorkflowStep<TReviewer>[];
 }
 export interface ListWorkflowsParams extends ListParams {
-    where: ListWhere & {
+    where?: ListWhere & {
         app?: ApwWorkflowApplications;
     };
 }
-interface CreateReviewerParams {
-    identityId: string;
-    displayName: string | null;
-    type: string;
-}
 interface CreateApwCommentParams {
     body: Record<string, any>;
     changeRequest: string;
@@ -265,11 +268,13 @@ export interface ApwContentReviewContent {
 }
 export interface CreateApwContentReviewParams {
     content: ApwContentReviewContent;
+    reviewStatus: ApwContentReviewStatus;
+    workflowId?: string;
 }
-interface UpdateApwContentReviewParams {
+export interface UpdateApwContentReviewParams {
     title?: string;
     steps?: ApwContentReviewStep[];
-    status?: ApwContentReviewStatus;
+    reviewStatus?: ApwContentReviewStatus;
     content?: ApwContentReviewContent;
 }
 interface BaseApwCrud<TEntry, TCreateEntryParams, TUpdateEntryParams> {
@@ -279,33 +284,33 @@ interface BaseApwCrud<TEntry, TCreateEntryParams, TUpdateEntryParams> {
     delete(id: string): Promise<Boolean>;
 }
 export interface ApwWorkflowCrud extends BaseApwCrud<ApwWorkflow, CreateApwWorkflowParams, UpdateApwWorkflowParams> {
-    list(params: ListWorkflowsParams): Promise<[ApwWorkflow[], ListMeta]>;
+    list(params?: ListWorkflowsParams): Promise<[ApwWorkflow[], ListMeta]>;
     /**
      * Lifecycle events
      */
-    onBeforeWorkflowCreate: Topic<OnBeforeWorkflowCreateTopicParams>;
-    onAfterWorkflowCreate: Topic<OnAfterWorkflowCreateTopicParams>;
-    onBeforeWorkflowUpdate: Topic<OnBeforeWorkflowUpdateTopicParams>;
-    onAfterWorkflowUpdate: Topic<OnAfterWorkflowUpdateTopicParams>;
-    onBeforeWorkflowDelete: Topic<OnBeforeWorkflowDeleteTopicParams>;
-    onAfterWorkflowDelete: Topic<OnAfterWorkflowDeleteTopicParams>;
+    onWorkflowBeforeCreate: Topic<OnWorkflowBeforeCreateTopicParams>;
+    onWorkflowAfterCreate: Topic<OnWorkflowAfterCreateTopicParams>;
+    onWorkflowBeforeUpdate: Topic<OnWorkflowBeforeUpdateTopicParams>;
+    onWorkflowAfterUpdate: Topic<OnWorkflowAfterUpdateTopicParams>;
+    onWorkflowBeforeDelete: Topic<OnWorkflowBeforeDeleteTopicParams>;
+    onWorkflowAfterDelete: Topic<OnWorkflowAfterDeleteTopicParams>;
 }
 export interface ApwReviewerListParams extends ListParams {
     where: ListParams["where"] & {
         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
      */
-    onBeforeReviewerCreate: Topic<OnBeforeReviewerCreateTopicParams>;
-    onAfterReviewerCreate: Topic<OnAfterReviewerCreateTopicParams>;
-    onBeforeReviewerUpdate: Topic<OnBeforeReviewerUpdateTopicParams>;
-    onAfterReviewerUpdate: Topic<OnAfterReviewerUpdateTopicParams>;
-    onBeforeReviewerDelete: Topic<OnBeforeReviewerDeleteTopicParams>;
-    onAfterReviewerDelete: Topic<OnAfterReviewerDeleteTopicParams>;
+    onReviewerBeforeCreate: Topic<OnReviewerBeforeCreateTopicParams>;
+    onReviewerAfterCreate: Topic<OnReviewerAfterCreateTopicParams>;
+    onReviewerBeforeUpdate: Topic<OnReviewerBeforeUpdateTopicParams>;
+    onReviewerAfterUpdate: Topic<OnReviewerAfterUpdateTopicParams>;
+    onReviewerBeforeDelete: Topic<OnReviewerBeforeDeleteTopicParams>;
+    onReviewerAfterDelete: Topic<OnReviewerAfterDeleteTopicParams>;
 }
 export interface ApwCommentListParams extends ListParams {
     where: ListParams["where"] & {
@@ -319,12 +324,12 @@ export interface ApwCommentCrud extends BaseApwCrud<ApwComment, CreateApwComment
     /**
      * Lifecycle events
      */
-    onBeforeCommentCreate: Topic<OnBeforeCommentCreateTopicParams>;
-    onAfterCommentCreate: Topic<OnAfterCommentCreateTopicParams>;
-    onBeforeCommentUpdate: Topic<OnBeforeCommentUpdateTopicParams>;
-    onAfterCommentUpdate: Topic<OnAfterCommentUpdateTopicParams>;
-    onBeforeCommentDelete: Topic<OnBeforeCommentDeleteTopicParams>;
-    onAfterCommentDelete: Topic<OnAfterCommentDeleteTopicParams>;
+    onCommentBeforeCreate: Topic<OnCommentBeforeCreateTopicParams>;
+    onCommentAfterCreate: Topic<OnCommentAfterCreateTopicParams>;
+    onCommentBeforeUpdate: Topic<OnCommentBeforeUpdateTopicParams>;
+    onCommentAfterUpdate: Topic<OnCommentAfterUpdateTopicParams>;
+    onCommentBeforeDelete: Topic<OnCommentBeforeDeleteTopicParams>;
+    onCommentAfterDelete: Topic<OnCommentAfterDeleteTopicParams>;
 }
 export interface ApwChangeRequestListParams extends ListParams {
     where: ListParams["where"] & {
@@ -336,12 +341,12 @@ export interface ApwChangeRequestCrud extends BaseApwCrud<ApwChangeRequest, Crea
     /**
      * Lifecycle events
      */
-    onBeforeChangeRequestCreate: Topic<OnBeforeChangeRequestCreateTopicParams>;
-    onAfterChangeRequestCreate: Topic<OnAfterChangeRequestCreateTopicParams>;
-    onBeforeChangeRequestUpdate: Topic<OnBeforeChangeRequestUpdateTopicParams>;
-    onAfterChangeRequestUpdate: Topic<OnAfterChangeRequestUpdateTopicParams>;
-    onBeforeChangeRequestDelete: Topic<OnBeforeChangeRequestDeleteTopicParams>;
-    onAfterChangeRequestDelete: Topic<OnAfterChangeRequestDeleteTopicParams>;
+    onChangeRequestBeforeCreate: Topic<OnChangeRequestBeforeCreateTopicParams>;
+    onChangeRequestAfterCreate: Topic<OnChangeRequestAfterCreateTopicParams>;
+    onChangeRequestBeforeUpdate: Topic<OnChangeRequestBeforeUpdateTopicParams>;
+    onChangeRequestAfterUpdate: Topic<OnChangeRequestAfterUpdateTopicParams>;
+    onChangeRequestBeforeDelete: Topic<OnChangeRequestBeforeDeleteTopicParams>;
+    onChangeRequestAfterDelete: Topic<OnChangeRequestAfterDeleteTopicParams>;
 }
 export interface ApwContentReviewCrud extends BaseApwCrud<ApwContentReview, CreateApwContentReviewParams, UpdateApwContentReviewParams> {
     list(params: ApwContentReviewListParams): Promise<[ApwContentReview[], ListMeta]>;
@@ -358,12 +363,13 @@ export interface ApwContentReviewCrud extends BaseApwCrud<ApwContentReview, Crea
     /**
      * Lifecycle events
      */
-    onBeforeContentReviewCreate: Topic<OnBeforeContentReviewCreateTopicParams>;
-    onAfterContentReviewCreate: Topic<OnAfterContentReviewCreateTopicParams>;
-    onBeforeContentReviewUpdate: Topic<OnBeforeContentReviewUpdateTopicParams>;
-    onAfterContentReviewUpdate: Topic<OnAfterContentReviewUpdateTopicParams>;
-    onBeforeContentReviewDelete: Topic<OnBeforeContentReviewDeleteTopicParams>;
-    onAfterContentReviewDelete: Topic<OnAfterContentReviewDeleteTopicParams>;
+    onContentReviewBeforeCreate: Topic<OnContentReviewBeforeCreateTopicParams>;
+    onContentReviewAfterCreate: Topic<OnContentReviewAfterCreateTopicParams>;
+    onContentReviewBeforeUpdate: Topic<OnContentReviewBeforeUpdateTopicParams>;
+    onContentReviewAfterUpdate: Topic<OnContentReviewAfterUpdateTopicParams>;
+    onContentReviewBeforeDelete: Topic<OnContentReviewBeforeDeleteTopicParams>;
+    onContentReviewAfterDelete: Topic<OnContentReviewAfterDeleteTopicParams>;
+    onContentReviewBeforeList: Topic<OnContentReviewBeforeListTopicParams>;
 }
 export declare type ContentGetter = (id: string, settings: {
     modelId?: string;
@@ -388,7 +394,7 @@ export interface AdvancedPublishingWorkflow {
     contentReview: ApwContentReviewCrud;
     scheduleAction: ApwScheduleActionCrud;
 }
-export interface ApwContext extends Context, CmsContext {
+export interface ApwContext extends Context, MailerContext, AdminSettingsContext {
     apw: AdvancedPublishingWorkflow;
     pageBuilder: PageBuilderContextObject;
     wcp: WcpContextObject;
@@ -417,11 +423,13 @@ 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;
@@ -451,10 +459,12 @@ interface StorageOperationsUpdateWorkflowParams {
 declare type StorageOperationsDeleteWorkflowParams = StorageOperationsDeleteParams;
 declare type StorageOperationsGetContentReviewParams = StorageOperationsGetParams;
 export interface ApwContentReviewListParams extends ListParams {
-    where?: ListWhere & {
-        status?: ApwContentReviewListFilter;
+    where: ListWhere & {
+        reviewStatus?: ApwContentReviewListFilter;
         title?: string;
         title_contains?: string;
+        workflowId?: string;
+        workflowId_in?: string[];
     };
 }
 declare type StorageOperationsListContentReviewsParams = ApwContentReviewListParams;
@@ -526,26 +536,26 @@ export interface ApwStorageOperations extends ApwReviewerStorageOperations, ApwW
 /**
  * @category Lifecycle events
  */
-export interface OnBeforeCommentCreateTopicParams {
+export interface OnCommentBeforeCreateTopicParams {
     input: CreateApwCommentParams;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnAfterCommentCreateTopicParams {
+export interface OnCommentAfterCreateTopicParams {
     comment: ApwComment;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnBeforeCommentUpdateTopicParams {
+export interface OnCommentBeforeUpdateTopicParams {
     original: ApwComment;
     input: Record<string, any>;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnAfterCommentUpdateTopicParams {
+export interface OnCommentAfterUpdateTopicParams {
     original: ApwComment;
     comment: ApwComment;
     input: Record<string, any>;
@@ -553,38 +563,38 @@ export interface OnAfterCommentUpdateTopicParams {
 /**
  * @category Lifecycle events
  */
-export interface OnBeforeCommentDeleteTopicParams {
+export interface OnCommentBeforeDeleteTopicParams {
     comment: ApwComment;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnAfterCommentDeleteTopicParams {
+export interface OnCommentAfterDeleteTopicParams {
     comment: ApwComment;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnBeforeChangeRequestCreateTopicParams {
+export interface OnChangeRequestBeforeCreateTopicParams {
     input: CreateApwChangeRequestParams;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnAfterChangeRequestCreateTopicParams {
+export interface OnChangeRequestAfterCreateTopicParams {
     changeRequest: ApwChangeRequest;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnBeforeChangeRequestUpdateTopicParams {
+export interface OnChangeRequestBeforeUpdateTopicParams {
     original: ApwChangeRequest;
     input: Record<string, any>;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnAfterChangeRequestUpdateTopicParams {
+export interface OnChangeRequestAfterUpdateTopicParams {
     original: ApwChangeRequest;
     changeRequest: ApwChangeRequest;
     input: Record<string, any>;
@@ -592,38 +602,38 @@ export interface OnAfterChangeRequestUpdateTopicParams {
 /**
  * @category Lifecycle events
  */
-export interface OnBeforeChangeRequestDeleteTopicParams {
+export interface OnChangeRequestBeforeDeleteTopicParams {
     changeRequest: ApwChangeRequest;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnAfterChangeRequestDeleteTopicParams {
+export interface OnChangeRequestAfterDeleteTopicParams {
     changeRequest: ApwChangeRequest;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnBeforeContentReviewCreateTopicParams {
+export interface OnContentReviewBeforeCreateTopicParams {
     input: CreateApwContentReviewParams;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnAfterContentReviewCreateTopicParams {
+export interface OnContentReviewAfterCreateTopicParams {
     contentReview: ApwContentReview;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnBeforeContentReviewUpdateTopicParams {
+export interface OnContentReviewBeforeUpdateTopicParams {
     original: ApwContentReview;
     input: Record<string, any>;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnAfterContentReviewUpdateTopicParams {
+export interface OnContentReviewAfterUpdateTopicParams {
     original: ApwContentReview;
     contentReview: ApwContentReview;
     input: Record<string, any>;
@@ -631,41 +641,47 @@ export interface OnAfterContentReviewUpdateTopicParams {
 /**
  * @category Lifecycle events
  */
-export interface OnBeforeContentReviewDeleteTopicParams {
+export interface OnContentReviewBeforeDeleteTopicParams {
     contentReview: ApwContentReview;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnAfterContentReviewDeleteTopicParams {
+export interface OnContentReviewAfterDeleteTopicParams {
     contentReview: ApwContentReview;
 }
+/**
+ * @category Lifecycle events
+ */
+export interface OnContentReviewBeforeListTopicParams {
+    where: ApwContentReviewListParams["where"];
+}
 export interface CreateApwReviewerParams {
     type: string;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnBeforeReviewerCreateTopicParams {
+export interface OnReviewerBeforeCreateTopicParams {
     input: CreateApwReviewerParams;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnAfterReviewerCreateTopicParams {
+export interface OnReviewerAfterCreateTopicParams {
     reviewer: ApwReviewer;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnBeforeReviewerUpdateTopicParams {
+export interface OnReviewerBeforeUpdateTopicParams {
     original: ApwReviewer;
     input: Record<string, any>;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnAfterReviewerUpdateTopicParams {
+export interface OnReviewerAfterUpdateTopicParams {
     original: ApwReviewer;
     reviewer: ApwReviewer;
     input: Record<string, any>;
@@ -673,38 +689,38 @@ export interface OnAfterReviewerUpdateTopicParams {
 /**
  * @category Lifecycle events
  */
-export interface OnBeforeReviewerDeleteTopicParams {
+export interface OnReviewerBeforeDeleteTopicParams {
     reviewer: ApwReviewer;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnAfterReviewerDeleteTopicParams {
+export interface OnReviewerAfterDeleteTopicParams {
     reviewer: ApwReviewer;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnBeforeWorkflowCreateTopicParams {
+export interface OnWorkflowBeforeCreateTopicParams {
     input: CreateApwWorkflowParams;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnAfterWorkflowCreateTopicParams {
+export interface OnWorkflowAfterCreateTopicParams {
     workflow: ApwWorkflow;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnBeforeWorkflowUpdateTopicParams {
+export interface OnWorkflowBeforeUpdateTopicParams {
     original: ApwWorkflow;
     input: Record<string, any>;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnAfterWorkflowUpdateTopicParams {
+export interface OnWorkflowAfterUpdateTopicParams {
     original: ApwWorkflow;
     workflow: ApwWorkflow;
     input: Record<string, any>;
@@ -712,26 +728,26 @@ export interface OnAfterWorkflowUpdateTopicParams {
 /**
  * @category Lifecycle events
  */
-export interface OnBeforeWorkflowDeleteTopicParams {
+export interface OnWorkflowBeforeDeleteTopicParams {
     workflow: ApwWorkflow;
 }
 /**
  * @category Lifecycle events
  */
-export interface OnAfterWorkflowDeleteTopicParams {
+export interface OnWorkflowAfterDeleteTopicParams {
     workflow: ApwWorkflow;
 }
-export declare type WorkflowModelDefinition = Pick<CmsModel, "name" | "modelId" | "layout" | "titleFieldId" | "description" | "fields" | "isPrivate">;
+export declare type WorkflowModelDefinition = Omit<CmsPrivateModelFull, "noValidate" | "group">;
 /**
  * Headless CMS
  */
-export interface OnBeforeCmsEntryPublishTopicParams extends Omit<BeforeEntryPublishTopicParams, "entry"> {
+export interface OnCmsEntryBeforePublishTopicParams extends Omit<OnEntryBeforePublishTopicParams, "entry"> {
     entry: ApwCmsEntry;
 }
-export interface OnAfterCmsEntryPublishTopicParams extends Omit<AfterEntryPublishTopicParams, "entry"> {
+export interface OnCmsEntryAfterPublishTopicParams extends Omit<OnEntryAfterPublishTopicParams, "entry"> {
     entry: ApwCmsEntry;
 }
-export interface OnAfterCmsEntryUnpublishTopicParams extends Omit<AfterEntryUnpublishTopicParams, "entry"> {
+export interface OnCmsEntryAfterUnpublishTopicParams extends Omit<OnEntryAfterUnpublishTopicParams, "entry"> {
     entry: ApwCmsEntry;
 }
 export {};