@webiny/api-apw 5.24.0 → 5.25.0-beta.0

package/types.d.ts

@@ -26,13 +26,13 @@ export interface ListParams {
     where: ListWhere;
     sort?: string[];
     limit?: number;
-    after?: string;
+    after?: string | null;
 }
 export interface ListMeta {
     /**
      * A cursor for pagination.
      */
-    cursor: string;
+    cursor: string | null;
     /**
      * Is there more items to load?
      */
@@ -83,33 +83,33 @@ export interface CreatedBy {
     /**
      * Full name of the user.
      */
-    displayName: string;
+    displayName: string | null;
     /**
      * Type of the user (admin, user)
      */
     type: string;
 }
-interface BaseFields {
+export interface ApwBaseFields {
     id: string;
     createdOn: string;
     savedOn: string;
     createdBy: CreatedBy;
 }
-export interface ApwReviewer extends BaseFields {
+export interface ApwReviewer extends ApwBaseFields {
     identityId: string;
-    displayName: string;
+    displayName: string | null;
     type: string;
 }
-export interface ApwComment extends BaseFields {
-    body: JSON;
+export interface ApwComment extends ApwBaseFields {
+    body: Record<string, any>;
     changeRequest: {
         id: string;
         entryId: string;
         modelId: string;
     };
 }
-export interface ApwChangeRequest extends BaseFields {
-    body: JSON;
+export interface ApwChangeRequest extends ApwBaseFields {
+    body: Record<string, any>;
     title: string;
     resolved: boolean;
     step: string;
@@ -122,19 +122,19 @@ export interface ApwContentReviewStep {
     reviewers: ApwReviewer[];
     status: ApwContentReviewStepStatus;
     pendingChangeRequests: number;
-    signOffProvidedOn: string;
-    signOffProvidedBy: CreatedBy;
+    signOffProvidedOn: string | null;
+    signOffProvidedBy: CreatedBy | null;
 }
-export interface ApwContentReview extends BaseFields {
+export interface ApwContentReview extends ApwBaseFields {
     status: ApwContentReviewStatus;
     content: {
         id: string;
         type: string;
-        settings: JSON;
+        settings: Record<string, any>;
     };
     steps: Array<ApwContentReviewStep>;
 }
-export interface ApwWorkflow extends BaseFields {
+export interface ApwWorkflow extends ApwBaseFields {
     title: string;
     steps: ApwWorkflowStep[];
     scope: ApwWorkflowScope;
@@ -187,7 +187,7 @@ export interface ListWorkflowsParams extends ListParams {
 }
 interface CreateReviewerParams {
     identityId: string;
-    displayName: string;
+    displayName: string | null;
     type: string;
 }
 interface CreateApwCommentParams {
@@ -201,15 +201,15 @@ interface UpdateApwCommentParams {
 }
 interface CreateApwChangeRequestParams {
     title: string;
-    body: JSON;
+    body: Record<string, any>;
     resolved: boolean;
-    media: JSON;
+    media: Record<string, any>;
 }
 interface UpdateApwChangeRequestParams {
     title: string;
-    body: JSON;
+    body: Record<string, any>;
     resolved: boolean;
-    media: JSON;
+    media: Record<string, any>;
 }
 export interface ApwContentReviewContent {
     id: string;
@@ -312,7 +312,7 @@ export interface ApwContentReviewCrud extends BaseApwCrud<ApwContentReview, Crea
 }
 export declare type WorkflowGetter = (id: string, settings: {
     modelId?: string;
-}) => Promise<string>;
+}) => Promise<string | null>;
 export interface AdvancedPublishingWorkflow {
     addWorkflowGetter: (type: ApwContentTypes, func: WorkflowGetter) => void;
     getWorkflowGetter: (type: ApwContentTypes) => WorkflowGetter;
@@ -328,14 +328,14 @@ export interface ApwContext extends Context, CmsContext {
 }
 export interface LifeCycleHookCallbackParams {
     apw: ApwContext["apw"];
-    security?: ApwContext["security"];
+    security: ApwContext["security"];
     cms?: ApwContext["cms"];
 }
 export interface CreateApwParams {
     getLocale: () => I18NLocale;
     getIdentity: () => SecurityIdentity;
     getTenant: () => Tenant;
-    getPermission: (name: string) => Promise<SecurityPermission>;
+    getPermission: (name: string) => Promise<SecurityPermission | null>;
     storageOperations: ApwStorageOperations;
 }
 interface StorageOperationsGetReviewerParams {
@@ -344,12 +344,12 @@ interface StorageOperationsGetReviewerParams {
 declare type StorageOperationsListReviewersParams = ApwReviewerListParams;
 interface CreateApwReviewerData {
     identityId: string;
-    displayName: string;
+    displayName: string | null;
     type: string;
 }
 interface UpdateApwReviewerData {
     identityId: string;
-    displayName: string;
+    displayName: string | null;
     type: string;
 }
 interface StorageOperationsCreateReviewerParams {

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["types.ts"],"names":["ApwContentTypes","WorkflowScopeTypes","ApwContentReviewStepStatus","ApwWorkflowApplications","ApwWorkflowStepTypes","ApwContentReviewStatus"],"mappings":";;;;;;IAgDYA,e;;;WAAAA,e;AAAAA,EAAAA,e;AAAAA,EAAAA,e;GAAAA,e,+BAAAA,e;;IAiBAC,kB;;;WAAAA,kB;AAAAA,EAAAA,kB;AAAAA,EAAAA,kB;AAAAA,EAAAA,kB;GAAAA,kB,kCAAAA,kB;;IAMAC,0B;;;WAAAA,0B;AAAAA,EAAAA,0B;AAAAA,EAAAA,0B;AAAAA,EAAAA,0B;GAAAA,0B,0CAAAA,0B;;IAMAC,uB;AAKZ;AACA;AACA;AACA;AACA;;;;WATYA,uB;AAAAA,EAAAA,uB;AAAAA,EAAAA,uB;GAAAA,uB,uCAAAA,uB;;IA6FAC,oB;;;WAAAA,oB;AAAAA,EAAAA,oB;AAAAA,EAAAA,oB;AAAAA,EAAAA,oB;GAAAA,oB,oCAAAA,oB;;IAMAC,sB;;;WAAAA,sB;AAAAA,EAAAA,sB;AAAAA,EAAAA,sB;AAAAA,EAAAA,sB;GAAAA,sB,sCAAAA,sB","sourcesContent":["import { Page, OnBeforePageCreateFromTopicParams } from \"@webiny/api-page-builder/types\";\nimport { CmsContext, CmsModel } from \"@webiny/api-headless-cms/types\";\nimport { Context } from \"@webiny/handler/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\";\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 PageWithWorkflow extends Page {\n    settings: Page[\"settings\"] & {\n        apw: {\n            workflowId: string;\n        };\n    };\n}\n\nexport interface CustomEventParams extends OnBeforePageCreateFromTopicParams {\n    page: PageWithWorkflow;\n}\n\nexport enum WorkflowScopeTypes {\n    DEFAULT = \"default\",\n    PB = \"pb\",\n    CMS = \"cms\"\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    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: {\n        id: string;\n        entryId: string;\n        modelId: string;\n    };\n}\n\nexport interface ApwChangeRequest extends ApwBaseFields {\n    body: Record<string, any>;\n    title: string;\n    resolved: boolean;\n    step: string;\n    media: File;\n}\n\nexport interface ApwContentReviewStep {\n    type: ApwWorkflowStepTypes;\n    title: string;\n    slug: string;\n    reviewers: ApwReviewer[];\n    status: ApwContentReviewStepStatus;\n    pendingChangeRequests: number;\n    signOffProvidedOn: string | null;\n    signOffProvidedBy: CreatedBy | null;\n}\n\nexport interface ApwContentReview extends ApwBaseFields {\n    status: ApwContentReviewStatus;\n    content: {\n        id: string;\n        type: string;\n        settings: Record<string, any>;\n    };\n    steps: Array<ApwContentReviewStep>;\n}\n\nexport interface ApwWorkflow extends ApwBaseFields {\n    title: string;\n    steps: ApwWorkflowStep[];\n    scope: ApwWorkflowScope;\n    app: string;\n}\n\ninterface ApwWorkflowScope {\n    type: WorkflowScopeTypes;\n    data: {\n        categories?: string[];\n        pages?: string[];\n        models?: string[];\n        entries?: string[];\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 interface ApwWorkflowStep {\n    title: string;\n    type: ApwWorkflowStepTypes;\n    reviewers: ApwReviewer[];\n    slug: string;\n}\n\nexport interface ApwContentReviewStep extends ApwWorkflowStep {\n    status: ApwContentReviewStepStatus;\n    pendingChangeRequests: number;\n}\n\ninterface CreateApwWorkflowParams {\n    app: ApwWorkflowApplications;\n    title: string;\n    scope: ApwWorkflowScope;\n    steps: ApwWorkflowStep[];\n}\n\ninterface UpdateApwWorkflowParams {\n    title?: string;\n    scope?: ApwWorkflowScope;\n    steps?: ApwWorkflowStep[];\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: {\n        id: string;\n    };\n}\n\ninterface UpdateApwCommentParams {\n    body: Record<string, any>;\n}\n\ninterface CreateApwChangeRequestParams {\n    title: 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\nexport interface ApwContentReviewContent {\n    id: string;\n    type: ApwContentTypes;\n    settings: Record<string, any>;\n}\n\nexport interface CreateApwContentReviewParams {\n    content: ApwContentReviewContent;\n    workflow: string;\n    steps: ApwContentReviewStep[];\n    status: ApwContentReviewStatus;\n}\n\ninterface UpdateApwContentReviewParams {\n    steps: ApwContentReviewStep[];\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    onBeforeWorkflowCreate: Topic<OnBeforeWorkflowCreateTopicParams>;\n    onAfterWorkflowCreate: Topic<OnAfterWorkflowCreateTopicParams>;\n    onBeforeWorkflowUpdate: Topic<OnBeforeWorkflowUpdateTopicParams>;\n    onAfterWorkflowUpdate: Topic<OnAfterWorkflowUpdateTopicParams>;\n    onBeforeWorkflowDelete: Topic<OnBeforeWorkflowDeleteTopicParams>;\n    onAfterWorkflowDelete: Topic<OnAfterWorkflowDeleteTopicParams>;\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    onBeforeReviewerCreate: Topic<OnBeforeReviewerCreateTopicParams>;\n    onAfterReviewerCreate: Topic<OnAfterReviewerCreateTopicParams>;\n    onBeforeReviewerUpdate: Topic<OnBeforeReviewerUpdateTopicParams>;\n    onAfterReviewerUpdate: Topic<OnAfterReviewerUpdateTopicParams>;\n    onBeforeReviewerDelete: Topic<OnBeforeReviewerDeleteTopicParams>;\n    onAfterReviewerDelete: Topic<OnAfterReviewerDeleteTopicParams>;\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    onBeforeCommentCreate: Topic<OnBeforeCommentCreateTopicParams>;\n    onAfterCommentCreate: Topic<OnAfterCommentCreateTopicParams>;\n    onBeforeCommentUpdate: Topic<OnBeforeCommentUpdateTopicParams>;\n    onAfterCommentUpdate: Topic<OnAfterCommentUpdateTopicParams>;\n    onBeforeCommentDelete: Topic<OnBeforeCommentDeleteTopicParams>;\n    onAfterCommentDelete: Topic<OnAfterCommentDeleteTopicParams>;\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    onBeforeChangeRequestCreate: Topic<OnBeforeChangeRequestCreateTopicParams>;\n    onAfterChangeRequestCreate: Topic<OnAfterChangeRequestCreateTopicParams>;\n    onBeforeChangeRequestUpdate: Topic<OnBeforeChangeRequestUpdateTopicParams>;\n    onAfterChangeRequestUpdate: Topic<OnAfterChangeRequestUpdateTopicParams>;\n    onBeforeChangeRequestDelete: Topic<OnBeforeChangeRequestDeleteTopicParams>;\n    onAfterChangeRequestDelete: Topic<OnAfterChangeRequestDeleteTopicParams>;\n}\n\nexport interface ApwContentReviewCrud\n    extends BaseApwCrud<\n        ApwContentReview,\n        CreateApwContentReviewParams,\n        UpdateApwContentReviewParams\n    > {\n    list(params: ListParams): Promise<[ApwContentReview[], ListMeta]>;\n\n    provideSignOff(id: string, step: string): Promise<Boolean>;\n\n    retractSignOff(id: string, step: string): Promise<Boolean>;\n\n    /**\n     * Lifecycle events\n     */\n    onBeforeContentReviewCreate: Topic<OnBeforeContentReviewCreateTopicParams>;\n    onAfterContentReviewCreate: Topic<OnAfterContentReviewCreateTopicParams>;\n    onBeforeContentReviewUpdate: Topic<OnBeforeContentReviewUpdateTopicParams>;\n    onAfterContentReviewUpdate: Topic<OnAfterContentReviewUpdateTopicParams>;\n    onBeforeContentReviewDelete: Topic<OnBeforeContentReviewDeleteTopicParams>;\n    onAfterContentReviewDelete: Topic<OnAfterContentReviewDeleteTopicParams>;\n}\n\nexport type WorkflowGetter = (id: string, settings: { modelId?: string }) => Promise<string | null>;\n\nexport interface AdvancedPublishingWorkflow {\n    addWorkflowGetter: (type: ApwContentTypes, func: WorkflowGetter) => void;\n    getWorkflowGetter: (type: ApwContentTypes) => WorkflowGetter;\n    workflow: ApwWorkflowCrud;\n    reviewer: ApwReviewerCrud;\n    comment: ApwCommentCrud;\n    changeRequest: ApwChangeRequestCrud;\n    contentReview: ApwContentReviewCrud;\n}\n\nexport interface ApwContext extends Context, CmsContext {\n    apw: AdvancedPublishingWorkflow;\n    pageBuilder: PageBuilderContextObject;\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}\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;\ntype StorageOperationsListContentReviewsParams = ListParams;\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 OnBeforeCommentCreateTopicParams {\n    input: CreateApwCommentParams;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnAfterCommentCreateTopicParams {\n    comment: ApwComment;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnBeforeCommentUpdateTopicParams {\n    original: ApwComment;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnAfterCommentUpdateTopicParams {\n    original: ApwComment;\n    comment: ApwComment;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnBeforeCommentDeleteTopicParams {\n    comment: ApwComment;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnAfterCommentDeleteTopicParams {\n    comment: ApwComment;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnBeforeChangeRequestCreateTopicParams {\n    input: CreateApwChangeRequestParams;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnAfterChangeRequestCreateTopicParams {\n    changeRequest: ApwChangeRequest;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnBeforeChangeRequestUpdateTopicParams {\n    original: ApwChangeRequest;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnAfterChangeRequestUpdateTopicParams {\n    original: ApwChangeRequest;\n    changeRequest: ApwChangeRequest;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnBeforeChangeRequestDeleteTopicParams {\n    changeRequest: ApwChangeRequest;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnAfterChangeRequestDeleteTopicParams {\n    changeRequest: ApwChangeRequest;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnBeforeContentReviewCreateTopicParams {\n    input: CreateApwContentReviewParams;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnAfterContentReviewCreateTopicParams {\n    contentReview: ApwContentReview;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnBeforeContentReviewUpdateTopicParams {\n    original: ApwContentReview;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnAfterContentReviewUpdateTopicParams {\n    original: ApwContentReview;\n    contentReview: ApwContentReview;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnBeforeContentReviewDeleteTopicParams {\n    contentReview: ApwContentReview;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnAfterContentReviewDeleteTopicParams {\n    contentReview: ApwContentReview;\n}\n\nexport interface CreateApwReviewerParams {\n    type: string;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnBeforeReviewerCreateTopicParams {\n    input: CreateApwReviewerParams;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnAfterReviewerCreateTopicParams {\n    reviewer: ApwReviewer;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnBeforeReviewerUpdateTopicParams {\n    original: ApwReviewer;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnAfterReviewerUpdateTopicParams {\n    original: ApwReviewer;\n    reviewer: ApwReviewer;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnBeforeReviewerDeleteTopicParams {\n    reviewer: ApwReviewer;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnAfterReviewerDeleteTopicParams {\n    reviewer: ApwReviewer;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnBeforeWorkflowCreateTopicParams {\n    input: CreateApwWorkflowParams;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnAfterWorkflowCreateTopicParams {\n    workflow: ApwWorkflow;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnBeforeWorkflowUpdateTopicParams {\n    original: ApwWorkflow;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnAfterWorkflowUpdateTopicParams {\n    original: ApwWorkflow;\n    workflow: ApwWorkflow;\n    input: Record<string, any>;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnBeforeWorkflowDeleteTopicParams {\n    workflow: ApwWorkflow;\n}\n\n/**\n * @category Lifecycle events\n */\nexport interface OnAfterWorkflowDeleteTopicParams {\n    workflow: ApwWorkflow;\n}\n\nexport type WorkflowModelDefinition = Pick<\n    CmsModel,\n    \"name\" | \"modelId\" | \"layout\" | \"titleFieldId\" | \"description\" | \"fields\"\n>;\n"]}

package/utils/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["errors.ts"],"names":["NotAuthorizedError","Error","constructor","data","code","message","StepMissingError","PendingChangeRequestsError","StepInActiveError","NoSignOffProvidedError"],"mappings":";;;;;;;;;AAAA;;AAEO,MAAMA,kBAAN,SAAiCC,cAAjC,CAAuC;AAC1CC,EAAAA,WAAW,CAACC,IAAD,EAA4B;AACnC,UAAM;AACFC,MAAAA,IAAI,EAAE,gBADJ;AAEFC,MAAAA,OAAO,EAAG,4CAFR;AAGFF,MAAAA,IAAI,EAAEA,IAAI,IAAI;AAHZ,KAAN;AAKH;;AAPyC;;;;AAUvC,MAAMG,gBAAN,SAA+BL,cAA/B,CAAqC;AACxCC,EAAAA,WAAW,CAACC,IAAD,EAA4B;AACnC,UAAM;AACFC,MAAAA,IAAI,EAAE,cADJ;AAEFC,MAAAA,OAAO,EAAG,uCAFR;AAGFF,MAAAA,IAAI,EAAEA,IAAI,IAAI;AAHZ,KAAN;AAKH;;AAPuC;;;;AAUrC,MAAMI,0BAAN,SAAyCN,cAAzC,CAA+C;AAClDC,EAAAA,WAAW,CAACC,IAAD,EAA4B;AACnC,UAAM;AACFC,MAAAA,IAAI,EAAE,yBADJ;AAEFC,MAAAA,OAAO,EAAG,wDAFR;AAGFF,MAAAA,IAAI,EAAEA,IAAI,IAAI;AAHZ,KAAN;AAKH;;AAPiD;;;;AAU/C,MAAMK,iBAAN,SAAgCP,cAAhC,CAAsC;AACzCC,EAAAA,WAAW,CAACC,IAAD,EAA4B;AACnC,UAAM;AACFC,MAAAA,IAAI,EAAE,iBADJ;AAEFC,MAAAA,OAAO,EAAG,6DAFR;AAGFF,MAAAA,IAAI,EAAEA,IAAI,IAAI;AAHZ,KAAN;AAKH;;AAPwC;;;;AAUtC,MAAMM,sBAAN,SAAqCR,cAArC,CAA2C;AAC9CC,EAAAA,WAAW,CAACC,IAAD,EAA4B;AACnC,UAAM;AACFC,MAAAA,IAAI,EAAE,sBADJ;AAEFC,MAAAA,OAAO,EAAG,4DAFR;AAGFF,MAAAA,IAAI,EAAEA,IAAI,IAAI;AAHZ,KAAN;AAKH;;AAP6C","sourcesContent":["import Error from \"@webiny/error\";\n\nexport class NotAuthorizedError extends Error {\n    constructor(data: Record<string, any>) {\n        super({\n            code: \"NOT_AUTHORISED\",\n            message: `Not a reviewer, couldn't provide sign-off.`,\n            data: data || null\n        });\n    }\n}\n\nexport class StepMissingError extends Error {\n    constructor(data: Record<string, any>) {\n        super({\n            code: \"MISSING_STEP\",\n            message: `Please complete previous steps first.`,\n            data: data || null\n        });\n    }\n}\n\nexport class PendingChangeRequestsError extends Error {\n    constructor(data: Record<string, any>) {\n        super({\n            code: \"PENDING_CHANGE_REQUESTS\",\n            message: `Change requests are pending couldn't provide sign-off.`,\n            data: data || null\n        });\n    }\n}\n\nexport class StepInActiveError extends Error {\n    constructor(data: Record<string, any>) {\n        super({\n            code: \"STEP_NOT_ACTIVE\",\n            message: `Step needs to be in active state before providing sign-off.`,\n            data: data || null\n        });\n    }\n}\n\nexport class NoSignOffProvidedError extends Error {\n    constructor(data: Record<string, any>) {\n        super({\n            code: \"NO_SIGN_OFF_PROVIDED\",\n            message: `Sign-off must be provided in order for it to be retracted.`,\n            data: data || null\n        });\n    }\n}\n"]}

package/utils/fieldResolver.d.ts

@@ -1,15 +1,16 @@
-import { CmsContext, CmsModel } from "@webiny/api-headless-cms/types";
+import { CmsContext, CmsEntry, CmsModel } from "@webiny/api-headless-cms/types";
+import { ApwBaseFields } from "../types";
 interface Transformer {
-    fieldId: string;
+    fieldId: keyof ApwBaseFields;
     model: any;
     field: any;
 }
 interface GetFieldValuesParams {
-    entry: Record<string, any>;
+    entry: CmsEntry;
     fields: string[];
-    transformers?: Array<Transformer>;
+    transformers?: Transformer[];
     context: CmsContext;
 }
-export declare const getFieldValues: ({ entry, context, transformers, fields }: GetFieldValuesParams) => Promise<any>;
+export declare const getFieldValues: <T extends ApwBaseFields>(params: GetFieldValuesParams) => Promise<T>;
 export declare const getTransformer: (model: CmsModel, fieldId: string) => Transformer;
 export {};

package/utils/fieldResolver.js

@@ -17,12 +17,14 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
-const getFieldValues = async ({
-  entry,
-  context,
-  transformers,
-  fields
-}) => {
+const getFieldValues = async params => {
+  const {
+    entry,
+    context,
+    transformers = [],
+    fields
+  } = params;
+
   const values = _objectSpread(_objectSpread({}, (0, _pick.default)(entry, fields)), entry.values);
   /**
    * Transform field value for each transformers.
@@ -50,7 +52,7 @@ const getFieldValues = async ({
 exports.getFieldValues = getFieldValues;
 
 const getTransformer = (model, fieldId) => ({
-  fieldId,
+  fieldId: fieldId,
   model: model,
   field: model.fields.find(field => field.fieldId === fieldId)
 });

package/utils/fieldResolver.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["fieldResolver.ts"],"names":["getFieldValues","params","entry","context","transformers","fields","values","i","length","fieldId","model","field","value","getTransformer","find"],"mappings":";;;;;;;;;;;AAAA;;AAEA;;;;;;AAgBO,MAAMA,cAAc,GAAG,MAC1BC,MAD0B,IAEb;AACb,QAAM;AAAEC,IAAAA,KAAF;AAASC,IAAAA,OAAT;AAAkBC,IAAAA,YAAY,GAAG,EAAjC;AAAqCC,IAAAA;AAArC,MAAgDJ,MAAtD;;AACA,QAAMK,MAAM,mCACL,mBAAKJ,KAAL,EAAYG,MAAZ,CADK,GAELH,KAAK,CAACI,MAFD,CAAZ;AAIA;AACJ;AACA;;;AACI,OAAK,IAAIC,CAAC,GAAG,CAAb,EAAgBA,CAAC,GAAGH,YAAY,CAACI,MAAjC,EAAyCD,CAAC,EAA1C,EAA8C;AAC1C,UAAM;AAAEE,MAAAA,OAAF;AAAWC,MAAAA,KAAX;AAAkBC,MAAAA;AAAlB,QAA4BP,YAAY,CAACG,CAAD,CAA9C,CAD0C,CAE1C;;AACAD,IAAAA,MAAM,CAACG,OAAD,CAAN,GAAkB,MAAM,kDAA+B;AACnDN,MAAAA,OADmD;AAEnDO,MAAAA,KAFmD;AAGnDC,MAAAA,KAHmD;AAInDC,MAAAA,KAAK,EAAEN,MAAM,CAACG,OAAD;AAJsC,KAA/B,CAAxB;AAMH;;AAED,SAAOH,MAAP;AACH,CAvBM;;;;AAyBA,MAAMO,cAAc,GAAG,CAACH,KAAD,EAAkBD,OAAlB,MAAoD;AAC9EA,EAAAA,OAAO,EAAEA,OADqE;AAE9EC,EAAAA,KAAK,EAAEA,KAFuE;AAG9EC,EAAAA,KAAK,EAAED,KAAK,CAACL,MAAN,CAAaS,IAAb,CAAkBH,KAAK,IAAIA,KAAK,CAACF,OAAN,KAAkBA,OAA7C;AAHuE,CAApD,CAAvB","sourcesContent":["import pick from \"lodash/pick\";\nimport { CmsContext, CmsEntry, CmsModel } from \"@webiny/api-headless-cms/types\";\nimport { entryFieldFromStorageTransform } from \"@webiny/api-headless-cms/content/plugins/utils/entryStorage\";\nimport { ApwBaseFields } from \"~/types\";\n\ninterface Transformer {\n    fieldId: keyof ApwBaseFields;\n    model: any;\n    field: any;\n}\n\ninterface GetFieldValuesParams {\n    entry: CmsEntry;\n    fields: string[];\n    transformers?: Transformer[];\n    context: CmsContext;\n}\n\nexport const getFieldValues = async <T extends ApwBaseFields>(\n    params: GetFieldValuesParams\n): Promise<T> => {\n    const { entry, context, transformers = [], fields } = params;\n    const values = {\n        ...pick(entry, fields),\n        ...entry.values\n    } as T;\n    /**\n     * Transform field value for each transformers.\n     */\n    for (let i = 0; i < transformers.length; i++) {\n        const { fieldId, model, field } = transformers[i];\n        // Get transformed value (eg. data decompression)\n        values[fieldId] = await entryFieldFromStorageTransform({\n            context,\n            model,\n            field,\n            value: values[fieldId]\n        });\n    }\n\n    return values;\n};\n\nexport const getTransformer = (model: CmsModel, fieldId: string): Transformer => ({\n    fieldId: fieldId as unknown as keyof ApwBaseFields,\n    model: model,\n    field: model.fields.find(field => field.fieldId === fieldId)\n});\n"]}

package/utils/resolve.d.ts

@@ -1,3 +1,3 @@
 import { Response, ErrorResponse } from "@webiny/handler-graphql";
-declare const _default: (fn: () => Promise<any>) => Promise<ErrorResponse | Response<any>>;
+declare const _default: (fn: () => Promise<any>) => Promise<Response<any> | ErrorResponse>;
 export default _default;

package/utils/resolve.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["resolve.ts"],"names":["fn","Response","e","ErrorResponse"],"mappings":";;;;;;;AAAA;;eAEe,MAAOA,EAAP,IAAkC;AAC7C,MAAI;AACA,WAAO,IAAIC,wBAAJ,CAAa,MAAMD,EAAE,EAArB,CAAP;AACH,GAFD,CAEE,OAAOE,CAAP,EAAU;AACR,WAAO,IAAIC,6BAAJ,CAAkBD,CAAlB,CAAP;AACH;AACJ,C","sourcesContent":["import { Response, ErrorResponse } from \"@webiny/handler-graphql\";\n\nexport default async (fn: () => Promise<any>) => {\n    try {\n        return new Response(await fn());\n    } catch (e) {\n        return new ErrorResponse(e);\n    }\n};\n"]}