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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webiny/api-apw",
-	"version": "5.23.0",
+	"version": "5.24.0-beta.0",
 	"keywords": [
 		"apw:base"
 	],
@@ -19,20 +19,20 @@
 	"license": "MIT",
 	"dependencies": {
 		"@babel/runtime": "7.16.7",
-		"@webiny/api-headless-cms": "5.23.0",
-		"@webiny/api-i18n": "5.23.0",
-		"@webiny/api-i18n-content": "5.23.0",
-		"@webiny/api-i18n-ddb": "5.23.0",
-		"@webiny/api-page-builder": "5.23.0",
-		"@webiny/api-page-builder-so-ddb": "5.23.0",
-		"@webiny/api-security": "5.23.0",
-		"@webiny/api-tenancy": "5.23.0",
-		"@webiny/error": "5.23.0",
-		"@webiny/handler": "5.23.0",
-		"@webiny/handler-aws": "5.23.0",
-		"@webiny/handler-graphql": "5.23.0",
-		"@webiny/plugins": "5.23.0",
-		"@webiny/pubsub": "5.23.0",
+		"@webiny/api-headless-cms": "5.24.0-beta.0",
+		"@webiny/api-i18n": "5.24.0-beta.0",
+		"@webiny/api-i18n-content": "5.24.0-beta.0",
+		"@webiny/api-i18n-ddb": "5.24.0-beta.0",
+		"@webiny/api-page-builder": "5.24.0-beta.0",
+		"@webiny/api-page-builder-so-ddb": "5.24.0-beta.0",
+		"@webiny/api-security": "5.24.0-beta.0",
+		"@webiny/api-tenancy": "5.24.0-beta.0",
+		"@webiny/error": "5.24.0-beta.0",
+		"@webiny/handler": "5.24.0-beta.0",
+		"@webiny/handler-aws": "5.24.0-beta.0",
+		"@webiny/handler-graphql": "5.24.0-beta.0",
+		"@webiny/plugins": "5.24.0-beta.0",
+		"@webiny/pubsub": "5.24.0-beta.0",
 		"lodash": "4.17.21"
 	},
 	"devDependencies": {
@@ -40,13 +40,13 @@
 		"@babel/core": "^7.5.5",
 		"@babel/preset-env": "^7.5.5",
 		"@babel/preset-flow": "^7.0.0",
-		"@webiny/api-security-so-ddb": "^5.23.0",
-		"@webiny/api-tenancy-so-ddb": "^5.23.0",
-		"@webiny/cli": "^5.23.0",
-		"@webiny/project-utils": "^5.23.0",
+		"@webiny/api-security-so-ddb": "^5.24.0-beta.0",
+		"@webiny/api-tenancy-so-ddb": "^5.24.0-beta.0",
+		"@webiny/cli": "^5.24.0-beta.0",
+		"@webiny/project-utils": "^5.24.0-beta.0",
 		"apollo-graphql": "^0.4.1",
 		"get-yarn-workspaces": "^1.0.2",
-		"graphql": "^14.6.0",
+		"graphql": "^15.7.2",
 		"jest": "^26.6.3",
 		"mdbid": "^1.0.0",
 		"prettier": "^2.3.2",
@@ -63,5 +63,5 @@
 		"build": "yarn webiny run build",
 		"watch": "yarn webiny run watch"
 	},
-	"gitHead": "eaa0003e39194d687ab5397c08eeccdb3557fb28"
+	"gitHead": "05b90b92bbaf2ef3adf275d008c4641580cf5f42"
 }

package/plugins/hooks/deleteChangeRequestsAfterContentReview.js

@@ -27,15 +27,16 @@ const deleteChangeRequestsWithContentReview = ({
         hasMoreItems: true,
         cursor: null
       };
-      let changeRequests = [];
       /**
        * Paginate through change requests.
        */
 
       while (meta.hasMoreItems) {
+        let changeRequests = [];
         /**
          * Get all change requests.
          */
+
         try {
           [changeRequests, meta] = await apw.changeRequest.list({
             where: {

package/plugins/hooks/deleteCommentsAfterChangeRequest.js

@@ -18,15 +18,16 @@ const deleteCommentsAfterChangeRequest = ({
       hasMoreItems: true,
       cursor: null
     };
-    let comments = [];
     /**
      * Paginate through comments.
      */
 
     while (meta.hasMoreItems) {
+      let comments = [];
       /**
        * Get all comments.
        */
+
       try {
         [comments, meta] = await apw.comment.list({
           where: {

package/plugins/hooks/linkWorkflowToPage.d.ts

@@ -1,9 +1,9 @@
 import { LifeCycleHookCallbackParams } from "../../types";
 import { PageBuilderContextObject } from "@webiny/api-page-builder/graphql/types";
-interface PageMethods {
+interface PageMethods extends LifeCycleHookCallbackParams {
     getPage: PageBuilderContextObject["getPage"];
     updatePage: PageBuilderContextObject["updatePage"];
     onBeforePageCreate: PageBuilderContextObject["onBeforePageCreate"];
 }
-export declare const linkWorkflowToPage: ({ apw, getPage, updatePage, onBeforePageCreate }: LifeCycleHookCallbackParams & PageMethods) => void;
+export declare const linkWorkflowToPage: ({ apw, getPage, updatePage, onBeforePageCreate }: PageMethods) => void;
 export {};

package/storageOperations/index.d.ts

@@ -1,9 +1,13 @@
-import { CmsContext, HeadlessCms } from "@webiny/api-headless-cms/types";
+import { CmsContext, CmsEntry, HeadlessCms } from "@webiny/api-headless-cms/types";
 import { ApwStorageOperations } from "../types";
 export interface CreateApwStorageOperationsParams {
     cms: HeadlessCms;
     getCmsContext: () => CmsContext;
 }
-export declare function getFieldValues(object: any, fields: any): any;
+/**
+ * Using any because value can be a lot of types.
+ * TODO @ts-refactor figure out correct types.
+ */
+export declare function getFieldValues(entry: CmsEntry, fields: string[]): any;
 export declare const baseFields: string[];
 export declare const createStorageOperations: ({ cms, getCmsContext }: CreateApwStorageOperationsParams) => ApwStorageOperations;

package/storageOperations/index.js

@@ -28,8 +28,12 @@ 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; }
 
-function getFieldValues(object, fields) {
-  return _objectSpread(_objectSpread({}, (0, _pick.default)(object, fields)), object.values);
+/**
+ * Using any because value can be a lot of types.
+ * TODO @ts-refactor figure out correct types.
+ */
+function getFieldValues(entry, fields) {
+  return _objectSpread(_objectSpread({}, (0, _pick.default)(entry, fields)), entry.values);
 }
 
 const baseFields = ["id", "createdBy", "createdOn", "savedOn"];

package/storageOperations/models/changeRequest.model.d.ts

@@ -1,7 +1,2 @@
-export declare const createChangeRequestModelDefinition: () => {
-    name: string;
-    modelId: string;
-    titleFieldId: string;
-    layout: string[][];
-    fields: import("@webiny/api-headless-cms/types").CmsModelField[];
-};
+import { WorkflowModelDefinition } from "../../types";
+export declare const createChangeRequestModelDefinition: () => WorkflowModelDefinition;

package/storageOperations/models/changeRequest.model.js

@@ -41,12 +41,14 @@ const stepField = () => (0, _utils.createModelField)({
   }]
 });
 
-const createChangeRequestModelDefinition = () => ({
-  name: "APW - Change Request",
-  modelId: "apwChangeRequestModelDefinition",
-  titleFieldId: "changeRequest_title",
-  layout: [["changeRequest_body"], ["changeRequest_title"]],
-  fields: [bodyField(), titleField(), resolvedField(), mediaField(), stepField()]
-});
+const createChangeRequestModelDefinition = () => {
+  return {
+    name: "APW - Change Request",
+    modelId: "apwChangeRequestModelDefinition",
+    titleFieldId: "changeRequest_title",
+    layout: [["changeRequest_body"], ["changeRequest_title"]],
+    fields: [bodyField(), titleField(), resolvedField(), mediaField(), stepField()]
+  };
+};
 
 exports.createChangeRequestModelDefinition = createChangeRequestModelDefinition;

package/storageOperations/models/comment.model.d.ts

@@ -1,9 +1,6 @@
-export declare const createCommentModelDefinition: ({ modelId }: {
-    modelId: any;
-}) => {
-    name: string;
+import { WorkflowModelDefinition } from "../../types";
+interface CreateCommentModelDefinitionParams {
     modelId: string;
-    titleFieldId: string;
-    layout: string[][];
-    fields: import("@webiny/api-headless-cms/types").CmsModelField[];
-};
+}
+export declare const createCommentModelDefinition: ({ modelId }: CreateCommentModelDefinitionParams) => WorkflowModelDefinition;
+export {};

package/storageOperations/models/comment.model.js

@@ -26,12 +26,14 @@ const changeRequestRef = modelId => (0, _utils.createModelField)({
 
 const createCommentModelDefinition = ({
   modelId
-}) => ({
-  name: "APW - Comment",
-  modelId: "apwCommentModelDefinition",
-  titleFieldId: "displayName",
-  layout: [["comment_body"], ["comment_displayName"]],
-  fields: [commentBody(), changeRequestRef(modelId)]
-});
+}) => {
+  return {
+    name: "APW - Comment",
+    modelId: "apwCommentModelDefinition",
+    titleFieldId: "displayName",
+    layout: [["comment_body"], ["comment_displayName"]],
+    fields: [commentBody(), changeRequestRef(modelId)]
+  };
+};
 
 exports.createCommentModelDefinition = createCommentModelDefinition;

package/storageOperations/models/contentReview.model.d.ts

@@ -1,25 +1,6 @@
-export declare const createContentReviewModelDefinition: ({ reviewerModelId }: {
-    reviewerModelId: any;
-}) => {
-    name: string;
-    modelId: string;
-    titleFieldId: string;
-    layout: string[][];
-    fields: (import("@webiny/api-headless-cms/types").CmsModelField | {
-        id: string;
-        label: string;
-        type: string;
-        settings: {
-            fields: any;
-            layout: any;
-        };
-        listValidation: any[];
-        validation: any[];
-        fieldId: string;
-        multipleValues: boolean;
-        predefinedValues: {
-            values: any[];
-            enabled: boolean;
-        };
-    })[];
-};
+import { WorkflowModelDefinition } from "../../types";
+interface CreateContentReviewModelDefinitionParams {
+    reviewerModelId: string;
+}
+export declare const createContentReviewModelDefinition: ({ reviewerModelId }: CreateContentReviewModelDefinitionParams) => WorkflowModelDefinition;
+export {};

package/storageOperations/models/contentReview.model.js

@@ -170,12 +170,14 @@ const stepsField = fields => ({
 
 const createContentReviewModelDefinition = ({
   reviewerModelId
-}) => ({
-  name: "APW - Content Review",
-  modelId: "apwContentReviewModelDefinition",
-  titleFieldId: "content",
-  layout: [["contentReview_content"], ["contentReview_reviewRequestedBy"], ["contentReview_steps"], ["contentReview_changeRequested"]],
-  fields: [contentField([contentIdField(), contentTypeField(), contentSettingsField()]), contentStatus(), stepsField([(0, _workflow.stepTitleField)(), (0, _workflow.stepTypeField)(), (0, _workflow.stepSlugField)(), (0, _workflow.stepReviewersField)(reviewerModelId), stepStatusField(), stepPendingChangeRequests(), stepSignOffProvidedOn(), stepSignOffProvidedBy([stepSignOffProvidedById(), stepSignOffProvidedByDisplayName()])])]
-});
+}) => {
+  return {
+    name: "APW - Content Review",
+    modelId: "apwContentReviewModelDefinition",
+    titleFieldId: "content",
+    layout: [["contentReview_content"], ["contentReview_reviewRequestedBy"], ["contentReview_steps"], ["contentReview_changeRequested"]],
+    fields: [contentField([contentIdField(), contentTypeField(), contentSettingsField()]), contentStatus(), stepsField([(0, _workflow.stepTitleField)(), (0, _workflow.stepTypeField)(), (0, _workflow.stepSlugField)(), (0, _workflow.stepReviewersField)(reviewerModelId), stepStatusField(), stepPendingChangeRequests(), stepSignOffProvidedOn(), stepSignOffProvidedBy([stepSignOffProvidedById(), stepSignOffProvidedByDisplayName()])])]
+  };
+};
 
 exports.createContentReviewModelDefinition = createContentReviewModelDefinition;

package/storageOperations/models/index.d.ts

@@ -1 +1,2 @@
-export declare const createApwModels: (context: any) => void;
+import { CmsContext } from "@webiny/api-headless-cms/types";
+export declare const createApwModels: (context: CmsContext) => void;

package/storageOperations/models/reviewer.model.d.ts

@@ -1,7 +1,2 @@
-export declare const createReviewerModelDefinition: () => {
-    name: string;
-    modelId: string;
-    titleFieldId: string;
-    layout: string[][];
-    fields: import("@webiny/api-headless-cms/types").CmsModelField[];
-};
+import { WorkflowModelDefinition } from "../../types";
+export declare const createReviewerModelDefinition: () => WorkflowModelDefinition;

package/storageOperations/models/reviewer.model.js

@@ -37,12 +37,14 @@ const typeField = () => (0, _utils.createModelField)({
   }]
 });
 
-const createReviewerModelDefinition = () => ({
-  name: "APW - Reviewer",
-  modelId: "apwReviewerModelDefinition",
-  titleFieldId: "displayName",
-  layout: [["reviewer_id"], ["reviewer_displayName"]],
-  fields: [idField(), displayNameField(), typeField()]
-});
+const createReviewerModelDefinition = () => {
+  return {
+    name: "APW - Reviewer",
+    modelId: "apwReviewerModelDefinition",
+    titleFieldId: "displayName",
+    layout: [["reviewer_id"], ["reviewer_displayName"]],
+    fields: [idField(), displayNameField(), typeField()]
+  };
+};
 
 exports.createReviewerModelDefinition = createReviewerModelDefinition;

package/storageOperations/models/workflow.model.d.ts

@@ -1,17 +1,11 @@
-export declare const stepTitleField: () => import("@webiny/api-headless-cms/types").CmsModelField;
-export declare const stepTypeField: () => import("@webiny/api-headless-cms/types").CmsModelField;
-export declare const stepSlugField: () => import("@webiny/api-headless-cms/types").CmsModelField;
-export declare const stepReviewersField: (reviewerModelId: any) => import("@webiny/api-headless-cms/types").CmsModelField;
-export declare const createWorkflowModelDefinition: ({ reviewerModelId }: {
-    reviewerModelId: any;
-}) => {
-    name: string;
-    /**
-     * Id of the model cannot be appWorkflow because it clashes with the GraphQL types for APW.
-     */
-    modelId: string;
-    layout: string[][];
-    titleFieldId: string;
-    description: any;
-    fields: import("@webiny/api-headless-cms/types").CmsModelField[];
-};
+import { CmsModelField } from "@webiny/api-headless-cms/types";
+import { WorkflowModelDefinition } from "../../types";
+export declare const stepTitleField: () => CmsModelField;
+export declare const stepTypeField: () => CmsModelField;
+export declare const stepSlugField: () => CmsModelField;
+export declare const stepReviewersField: (reviewerModelId: string) => CmsModelField;
+interface CreateWorkflowModelDefinitionParams {
+    reviewerModelId: string;
+}
+export declare const createWorkflowModelDefinition: ({ reviewerModelId }: CreateWorkflowModelDefinitionParams) => WorkflowModelDefinition;
+export {};

package/storageOperations/models/workflow.model.js

@@ -188,17 +188,19 @@ const applicationField = () => (0, _utils.createModelField)({
 
 const createWorkflowModelDefinition = ({
   reviewerModelId
-}) => ({
-  name: "APW - Workflow",
-
-  /**
-   * Id of the model cannot be appWorkflow because it clashes with the GraphQL types for APW.
-   */
-  modelId: "apwWorkflowModelDefinition",
-  layout: [["workflow_title"], ["workflow_steps"], ["workflow_scope"], ["workflow_app"]],
-  titleFieldId: "title",
-  description: null,
-  fields: [titleField(), stepsField([stepTitleField(), stepTypeField(), stepSlugField(), stepReviewersField(reviewerModelId)]), scopeField([scopeTypeField(), scopeDataField([scopeDataPbCategories(), scopeDataPbPages(), scopeDataCmsModels(), scopeDataCmsEntries()])]), applicationField()]
-});
+}) => {
+  return {
+    name: "APW - Workflow",
+
+    /**
+     * Id of the model cannot be appWorkflow because it clashes with the GraphQL types for APW.
+     */
+    modelId: "apwWorkflowModelDefinition",
+    layout: [["workflow_title"], ["workflow_steps"], ["workflow_scope"], ["workflow_app"]],
+    titleFieldId: "title",
+    description: null,
+    fields: [titleField(), stepsField([stepTitleField(), stepTypeField(), stepSlugField(), stepReviewersField(reviewerModelId)]), scopeField([scopeTypeField(), scopeDataField([scopeDataPbCategories(), scopeDataPbPages(), scopeDataCmsModels(), scopeDataCmsEntries()])]), applicationField()]
+  };
+};
 
 exports.createWorkflowModelDefinition = createWorkflowModelDefinition;

package/types.d.ts

@@ -1,5 +1,5 @@
 import { Page, OnBeforePageCreateFromTopicParams } from "@webiny/api-page-builder/types";
-import { CmsContext } from "@webiny/api-headless-cms/types";
+import { CmsContext, CmsModel } from "@webiny/api-headless-cms/types";
 import { Context } from "@webiny/handler/types";
 import { PageBuilderContextObject } from "@webiny/api-page-builder/graphql/types";
 import { SecurityIdentity, SecurityPermission } from "@webiny/api-security/types";
@@ -643,4 +643,5 @@ export interface OnBeforeWorkflowDeleteTopicParams {
 export interface OnAfterWorkflowDeleteTopicParams {
     workflow: ApwWorkflow;
 }
+export declare type WorkflowModelDefinition = Pick<CmsModel, "name" | "modelId" | "layout" | "titleFieldId" | "description" | "fields">;
 export {};

package/utils/resolve.d.ts

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