@webiny/api-apw 5.23.0-beta.0

package/createApw/createWorkflowMethods.js

@@ -0,0 +1,96 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createWorkflowMethods = createWorkflowMethods;
+
+var _pubsub = require("@webiny/pubsub");
+
+function createWorkflowMethods({
+  storageOperations
+}) {
+  const onBeforeWorkflowCreate = (0, _pubsub.createTopic)();
+  const onAfterWorkflowCreate = (0, _pubsub.createTopic)();
+  const onBeforeWorkflowUpdate = (0, _pubsub.createTopic)();
+  const onAfterWorkflowUpdate = (0, _pubsub.createTopic)();
+  const onBeforeWorkflowDelete = (0, _pubsub.createTopic)();
+  const onAfterWorkflowDelete = (0, _pubsub.createTopic)();
+  return {
+    /**
+     * Lifecycle events
+     */
+    onBeforeWorkflowCreate,
+    onAfterWorkflowCreate,
+    onBeforeWorkflowUpdate,
+    onAfterWorkflowUpdate,
+    onBeforeWorkflowDelete,
+    onAfterWorkflowDelete,
+
+    async get(id) {
+      return storageOperations.getWorkflow({
+        id
+      });
+    },
+
+    async list(params) {
+      return storageOperations.listWorkflows(params);
+    },
+
+    async create(data) {
+      await onBeforeWorkflowCreate.publish({
+        input: data
+      });
+      const workflow = await storageOperations.createWorkflow({
+        data
+      });
+      await onAfterWorkflowCreate.publish({
+        workflow
+      });
+      return workflow;
+    },
+
+    async update(id, data) {
+      const original = await storageOperations.getWorkflow({
+        id
+      });
+      await onBeforeWorkflowUpdate.publish({
+        original,
+        input: {
+          id,
+          data
+        }
+      });
+      const workflow = await storageOperations.updateWorkflow({
+        id,
+        data
+      });
+      await onAfterWorkflowUpdate.publish({
+        original,
+        input: {
+          id,
+          data
+        },
+        workflow
+      });
+      return workflow;
+    },
+
+    async delete(id) {
+      const workflow = await storageOperations.getWorkflow({
+        id
+      });
+      await onBeforeWorkflowDelete.publish({
+        workflow
+      });
+      await storageOperations.deleteWorkflow({
+        id
+      });
+      await onAfterWorkflowDelete.publish({
+        workflow
+      });
+      return true;
+    }
+
+  };
+}

package/createApw/index.d.ts

@@ -0,0 +1,2 @@
+import { AdvancedPublishingWorkflow, CreateApwParams } from "../types";
+export declare const createApw: (params: CreateApwParams) => AdvancedPublishingWorkflow;

package/createApw/index.js

@@ -0,0 +1,54 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createApw = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _createWorkflowMethods = require("./createWorkflowMethods");
+
+var _createReviewerMethods = require("./createReviewerMethods");
+
+var _createCommentMethods = require("./createCommentMethods");
+
+var _createChangeRequestMethods = require("./createChangeRequestMethods");
+
+var _createContentReviewMethods = require("./createContentReviewMethods");
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+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 createApw = params => {
+  const workflowGetters = new Map();
+  const workflowMethods = (0, _createWorkflowMethods.createWorkflowMethods)(params);
+  const reviewerMethods = (0, _createReviewerMethods.createReviewerMethods)(params);
+  const changeRequestMethods = (0, _createChangeRequestMethods.createChangeRequestMethods)(params);
+  return {
+    addWorkflowGetter(type, func) {
+      workflowGetters.set(type, func);
+    },
+
+    getWorkflowGetter(type) {
+      if (!workflowGetters.has(type)) {
+        throw new Error(`No loader found for type: "${type}". You must define a loader.`);
+      }
+
+      return workflowGetters.get(type);
+    },
+
+    workflow: workflowMethods,
+    reviewer: reviewerMethods,
+    changeRequest: changeRequestMethods,
+    comment: (0, _createCommentMethods.createCommentMethods)(params),
+    contentReview: (0, _createContentReviewMethods.createContentReviewMethods)(_objectSpread(_objectSpread({}, params), {}, {
+      getReviewer: reviewerMethods.get.bind(reviewerMethods)
+    }))
+  };
+};
+
+exports.createApw = createApw;

package/index.d.ts

@@ -0,0 +1,2 @@
+export declare const createApwContext: () => (import("@webiny/handler").ContextPlugin<import("./types").ApwContext> | (import("@webiny/handler-graphql/plugins").GraphQLSchemaPlugin<import("./types").ApwContext> | import("@webiny/handler").ContextPlugin<import("./types").ApwContext>)[])[];
+export declare const createApwGraphQL: () => import("@webiny/handler-graphql/plugins").GraphQLSchemaPlugin<import("./types").ApwContext>[];

package/index.js

@@ -0,0 +1,28 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createApwGraphQL = exports.createApwContext = void 0;
+
+var _graphql = _interopRequireDefault(require("./plugins/graphql"));
+
+var _context = _interopRequireDefault(require("./plugins/context"));
+
+/**
+ * We have separated context and GraphQL creation so user can initialize only context if required.
+ * GraphQL will not work without context, but context will without GraphQL.
+ */
+const createApwContext = () => {
+  return (0, _context.default)();
+};
+
+exports.createApwContext = createApwContext;
+
+const createApwGraphQL = () => {
+  return (0, _graphql.default)();
+};
+
+exports.createApwGraphQL = createApwGraphQL;

package/package.json

@@ -0,0 +1,67 @@
+{
+	"name": "@webiny/api-apw",
+	"version": "5.23.0-beta.0",
+	"keywords": [
+		"apw:base"
+	],
+	"main": "index.js",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/webiny/webiny-js.git",
+		"directory": "packages/api-apw"
+	},
+	"description": "GraphQL API for Webiny Advanced Publishing Workflow.",
+	"contributors": [
+		"Pavel Denisjuk <pavel@webiny.com>",
+		"Sven Al Hamad <sven@webiny.com>",
+		"Adrian Smijulj <adrian@webiny.com>"
+	],
+	"license": "MIT",
+	"dependencies": {
+		"@babel/runtime": "7.16.7",
+		"@webiny/api-headless-cms": "5.23.0-beta.0",
+		"@webiny/api-i18n": "5.23.0-beta.0",
+		"@webiny/api-i18n-content": "5.23.0-beta.0",
+		"@webiny/api-i18n-ddb": "5.23.0-beta.0",
+		"@webiny/api-page-builder": "5.23.0-beta.0",
+		"@webiny/api-page-builder-so-ddb": "5.23.0-beta.0",
+		"@webiny/api-security": "5.23.0-beta.0",
+		"@webiny/api-tenancy": "5.23.0-beta.0",
+		"@webiny/error": "5.23.0-beta.0",
+		"@webiny/handler": "5.23.0-beta.0",
+		"@webiny/handler-aws": "5.23.0-beta.0",
+		"@webiny/handler-graphql": "5.23.0-beta.0",
+		"@webiny/plugins": "5.23.0-beta.0",
+		"@webiny/pubsub": "5.23.0-beta.0",
+		"lodash": "4.17.21"
+	},
+	"devDependencies": {
+		"@babel/cli": "^7.5.5",
+		"@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-beta.0",
+		"@webiny/api-tenancy-so-ddb": "^5.23.0-beta.0",
+		"@webiny/cli": "^5.23.0-beta.0",
+		"@webiny/project-utils": "^5.23.0-beta.0",
+		"apollo-graphql": "^0.4.1",
+		"get-yarn-workspaces": "^1.0.2",
+		"graphql": "^14.6.0",
+		"jest": "^26.6.3",
+		"mdbid": "^1.0.0",
+		"prettier": "^2.3.2",
+		"rimraf": "^3.0.2",
+		"sinon": "^9.0.2",
+		"ttypescript": "^1.5.12",
+		"typescript": "^4.1.3"
+	},
+	"publishConfig": {
+		"access": "public",
+		"directory": "dist"
+	},
+	"scripts": {
+		"build": "yarn webiny run build",
+		"watch": "yarn webiny run watch"
+	},
+	"gitHead": "deb16c58954f7396c848f04806a2028aa53cc97b"
+}

package/plugins/context.d.ts

@@ -0,0 +1,4 @@
+import { ContextPlugin } from "@webiny/handler/plugins/ContextPlugin";
+import { ApwContext } from "../types";
+declare const _default: () => (ContextPlugin<ApwContext> | (import("@webiny/handler-graphql/plugins").GraphQLSchemaPlugin<ApwContext> | ContextPlugin<ApwContext>)[])[];
+export default _default;

package/plugins/context.js

@@ -0,0 +1,89 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _ContextPlugin = require("@webiny/handler/plugins/ContextPlugin");
+
+var _types = require("../types");
+
+var _createApw = require("../createApw");
+
+var _hooks = _interopRequireDefault(require("./hooks"));
+
+var _storageOperations = require("../storageOperations");
+
+var _createManageCMSPlugin = require("./createManageCMSPlugin");
+
+var _apiHeadlessCms = require("@webiny/api-headless-cms");
+
+var _default = () => [new _ContextPlugin.ContextPlugin(async context => {
+  const {
+    tenancy,
+    security,
+    i18nContent
+  } = context;
+  const contentHeadlessCmsContextPlugins = (0, _apiHeadlessCms.createContentHeadlessCmsContext)({
+    storageOperations: context.cms.storageOperations
+  });
+  /**
+   * Register cms plugins required by `api-apw` package.
+   */
+
+  context.plugins.register([(0, _createManageCMSPlugin.createManageCMSPlugin)(), ...contentHeadlessCmsContextPlugins]);
+
+  const getLocale = () => {
+    // TODO: Check which locale do we need here?
+    return i18nContent.locale;
+  };
+
+  const getTenant = () => {
+    return tenancy.getCurrentTenant();
+  };
+
+  const getPermission = name => security.getPermission(name);
+
+  const getIdentity = () => security.getIdentity();
+
+  context.apw = (0, _createApw.createApw)({
+    getLocale,
+    getIdentity,
+    getTenant,
+    getPermission,
+    storageOperations: (0, _storageOperations.createStorageOperations)({
+      /**
+       * TODO: We need to figure out a way to pass "cms" from outside (e.g. api/code/graphql)
+       */
+      cms: context.cms,
+
+      /**
+       * TODO: This is required for "entryFieldFromStorageTransform" which access plugins from context.
+       */
+      getCmsContext: () => context
+    })
+  });
+  /**
+   * TODO: @ashutosh
+   * Move these call into a separate package let say "ap-apw-page-builder"
+   */
+
+  context.apw.addWorkflowGetter(_types.ApwContentTypes.PAGE, async id => {
+    const page = await context.pageBuilder.getPage(id);
+    return page.settings.apw.workflowId;
+  });
+  context.apw.addWorkflowGetter(_types.ApwContentTypes.CMS_ENTRY, async (id, settings) => {
+    const model = await context.cms.getModel(settings.modelId);
+    const entry = await context.cms.getEntry(model, {
+      where: {
+        id: id
+      }
+    });
+    return entry.values.workflow;
+  });
+}), (0, _hooks.default)()];
+
+exports.default = _default;

package/plugins/createManageCMSPlugin.d.ts

@@ -0,0 +1,2 @@
+import { CmsParametersPlugin } from "@webiny/api-headless-cms";
+export declare const createManageCMSPlugin: () => CmsParametersPlugin;

package/plugins/createManageCMSPlugin.js

@@ -0,0 +1,31 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createManageCMSPlugin = void 0;
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+var _apiHeadlessCms = require("@webiny/api-headless-cms");
+
+const createManageCMSPlugin = () => {
+  return new _apiHeadlessCms.CmsParametersPlugin(async context => {
+    const locale = context.i18n.getCurrentLocale("content");
+
+    if (!locale) {
+      throw new _error.default(`Could not able to load "locale".`, "MALFORMED_LOCALE", {
+        locale
+      });
+    }
+
+    return {
+      type: "manage",
+      locale: locale.code
+    };
+  });
+};
+
+exports.createManageCMSPlugin = createManageCMSPlugin;

package/plugins/graphql/changeRequest.gql.d.ts

@@ -0,0 +1,4 @@
+import { GraphQLSchemaPlugin } from "@webiny/handler-graphql/plugins";
+import { ApwContext } from "../../types";
+declare const workflowSchema: GraphQLSchemaPlugin<ApwContext>;
+export default workflowSchema;

package/plugins/graphql/changeRequest.gql.js

@@ -0,0 +1,152 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _plugins = require("@webiny/handler-graphql/plugins");
+
+var _handlerGraphql = require("@webiny/handler-graphql");
+
+var _resolve = _interopRequireDefault(require("../../utils/resolve"));
+
+const workflowSchema = new _plugins.GraphQLSchemaPlugin({
+  typeDefs:
+  /* GraphQL */
+  `
+        type ApwChangeRequestListItem {
+            # System generated fields
+            id: ID
+            savedOn: DateTime
+            createdOn: DateTime
+            createdBy: ApwCreatedBy
+            # ChangeRequest specific fields
+            step: String!
+            title: String!
+            body: JSON!
+            resolved: Boolean
+            media: JSON
+        }
+
+        type ApwListChangeRequestsResponse {
+            data: [ApwChangeRequestListItem]
+            error: ApwError
+            meta: ApwMeta
+        }
+
+        type ApwChangeRequest {
+            # System generated fields
+            id: ID
+            savedOn: DateTime
+            createdOn: DateTime
+            createdBy: ApwCreatedBy
+            # ChangeRequest specific fields
+            step: String!
+            title: String!
+            body: JSON!
+            resolved: Boolean
+            media: JSON
+        }
+
+        type ApwChangeRequestResponse {
+            data: ApwChangeRequest
+            error: ApwError
+        }
+
+        type ApwDeleteChangeRequestResponse {
+            data: Boolean
+            error: ApwError
+        }
+
+        enum ApwListChangeRequestSort {
+            id_ASC
+            id_DESC
+            savedOn_ASC
+            savedOn_DESC
+            createdOn_ASC
+            createdOn_DESC
+            publishedOn_ASC
+            publishedOn_DESC
+            title_ASC
+            title_DESC
+        }
+
+        input ApwCreateChangeRequestInput {
+            step: String!
+            title: String!
+            body: JSON!
+            resolved: Boolean
+            media: JSON
+        }
+
+        input ApwUpdateChangeRequestInput {
+            title: String
+            body: JSON
+            resolved: Boolean
+            media: JSON
+        }
+
+        input ApwListChangeRequestWhereInput {
+            id: ID
+            step: String
+        }
+
+        input ApwListChangeRequestSearchInput {
+            query: String
+        }
+
+        extend type ApwQuery {
+            getChangeRequest(id: ID!): ApwChangeRequestResponse
+
+            listChangeRequests(
+                where: ApwListChangeRequestWhereInput
+                limit: Int
+                after: String
+                sort: [ApwListChangeRequestSort!]
+                search: ApwListChangeRequestSearchInput
+            ): ApwListChangeRequestsResponse
+        }
+
+        extend type ApwMutation {
+            createChangeRequest(data: ApwCreateChangeRequestInput!): ApwChangeRequestResponse
+
+            updateChangeRequest(
+                id: ID!
+                data: ApwUpdateChangeRequestInput!
+            ): ApwChangeRequestResponse
+
+            deleteChangeRequest(id: ID!): ApwDeleteChangeRequestResponse
+        }
+    `,
+  resolvers: {
+    ApwQuery: {
+      getChangeRequest: async (_, args, context) => {
+        return (0, _resolve.default)(() => context.apw.changeRequest.get(args.id));
+      },
+      listChangeRequests: async (_, args, context) => {
+        try {
+          const [entries, meta] = await context.apw.changeRequest.list(args);
+          return new _handlerGraphql.ListResponse(entries, meta);
+        } catch (e) {
+          return new _handlerGraphql.ErrorResponse(e);
+        }
+      }
+    },
+    ApwMutation: {
+      createChangeRequest: async (_, args, context) => {
+        return (0, _resolve.default)(() => context.apw.changeRequest.create(args.data));
+      },
+      updateChangeRequest: async (_, args, context) => {
+        return (0, _resolve.default)(() => context.apw.changeRequest.update(args.id, args.data));
+      },
+      deleteChangeRequest: async (_, args, context) => {
+        return (0, _resolve.default)(() => context.apw.changeRequest.delete(args.id));
+      }
+    }
+  }
+});
+var _default = workflowSchema;
+exports.default = _default;

package/plugins/graphql/comment.gql.d.ts

@@ -0,0 +1,4 @@
+import { GraphQLSchemaPlugin } from "@webiny/handler-graphql/plugins";
+import { ApwContext } from "../../types";
+declare const workflowSchema: GraphQLSchemaPlugin<ApwContext>;
+export default workflowSchema;