@webiny/api-page-builder-import-export 0.0.0-mt-1

package/exportPages/zipper.js

@@ -0,0 +1,137 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.ZipOfZip = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _archiver = _interopRequireDefault(require("archiver"));
+
+var _stream = require("stream");
+
+var path = _interopRequireWildcard(require("path"));
+
+var _kebabCase = _interopRequireDefault(require("lodash/kebabCase"));
+
+var _uniqid = _interopRequireDefault(require("uniqid"));
+
+var _s3Stream = require("./s3Stream");
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+// TODO: Move "archive" in layer
+class Zipper {
+  constructor(config) {
+    (0, _defineProperty2.default)(this, "archiveFormat", "zip");
+    (0, _defineProperty2.default)(this, "filesDirName", "assets");
+    (0, _defineProperty2.default)(this, "archiveFileName", void 0);
+    (0, _defineProperty2.default)(this, "config", void 0);
+    this.config = config;
+    this.archiveFileName = (0, _uniqid.default)(`${this.config.archiveFileKey}/`, `-${(0, _kebabCase.default)(this.config.exportInfo.pageTitle)}.zip`);
+  }
+
+  s3DownloadStreams() {
+    const exportInfo = this.config.exportInfo;
+    const prefix = (0, _uniqid.default)("", `-${(0, _kebabCase.default)(exportInfo.pageTitle)}`);
+    const files = exportInfo.files.map(({
+      key
+    }) => {
+      return {
+        stream: _s3Stream.s3Stream.readStream(key),
+        filename: `${prefix}\\${this.filesDirName}\\${path.basename(key)}`
+      };
+    });
+    return [...files, {
+      stream: _stream.Readable.from(exportInfo.pageDataBuffer),
+      filename: `${prefix}\\${exportInfo.pageTitle}.json`
+    }];
+  }
+
+  process() {
+    const {
+      streamPassThrough,
+      streamPassThroughUploadPromise
+    } = _s3Stream.s3Stream.writeStream(this.archiveFileName); // 1. Read all files from S3 using stream.
+
+
+    const s3FilesStreams = this.s3DownloadStreams(); // 2. Prepare zip from the file stream.
+
+    const archive = _archiver.default.create(this.archiveFormat); // Handle archive events.
+
+
+    archive.on("error", error => {
+      throw new Error(`${error.name} ${error.code} ${error.message} ${error.path} ${error.stack}`);
+    }); // Append all file streams to archive.
+
+    s3FilesStreams.forEach(streamDetails => archive.append(streamDetails.stream, {
+      name: streamDetails.filename
+    })); // Pipe archive output to streamPassThrough (Transform Stream) which will be uploaded to S3.
+
+    archive.pipe(streamPassThrough); // Finalize the archive (ie we are done appending files but streams have to finish yet)
+    // 'close', 'end' or 'finish' may be fired right after calling this method so register to them beforehand
+
+    archive.finalize(); // 3. Return upload stream promise.
+
+    return streamPassThroughUploadPromise;
+  }
+
+}
+
+exports.default = Zipper;
+const PAGE_EXPORT_BASENAME = `WEBINY_PAGE_EXPORT.zip`;
+
+class ZipOfZip {
+  constructor(keys) {
+    (0, _defineProperty2.default)(this, "archiveFormat", "zip");
+    (0, _defineProperty2.default)(this, "archiveFileName", void 0);
+    (0, _defineProperty2.default)(this, "keys", void 0);
+    this.keys = keys;
+    this.archiveFileName = (0, _uniqid.default)("", `-${PAGE_EXPORT_BASENAME}`);
+  }
+
+  getFileStreams() {
+    return this.keys.map(key => {
+      return {
+        stream: _s3Stream.s3Stream.readStream(key),
+        filename: `${path.basename(key)}`
+      };
+    });
+  }
+
+  process() {
+    const {
+      streamPassThrough,
+      streamPassThroughUploadPromise
+    } = _s3Stream.s3Stream.writeStream(this.archiveFileName); // 1. Read all files from S3 using stream.
+
+
+    const fileStreamDetails = this.getFileStreams(); // 2. Prepare zip from the file stream.
+
+    const archive = _archiver.default.create(this.archiveFormat); // Handle archive events.
+
+
+    archive.on("error", error => {
+      throw new Error(`${error.name} ${error.code} ${error.message} ${error.path} ${error.stack}`);
+    }); // Append all file streams to archive.
+
+    fileStreamDetails.forEach(streamDetails => archive.append(streamDetails.stream, {
+      name: streamDetails.filename
+    })); // Pipe archive output to streamPassThrough (Transform Stream) which will be uploaded to S3.
+
+    archive.pipe(streamPassThrough); // Finalize the archive (ie we are done appending files but streams have to finish yet)
+    // 'close', 'end' or 'finish' may be fired right after calling this method so register to them beforehand
+
+    archive.finalize(); // 3. Return upload stream promise.
+
+    return streamPassThroughUploadPromise;
+  }
+
+}
+
+exports.ZipOfZip = ZipOfZip;

package/graphql/crud/pageImportExportTasks.crud.d.ts

@@ -0,0 +1,5 @@
+import { ContextPlugin } from "@webiny/handler/plugins/ContextPlugin";
+import { PageImportExportPluginsParams } from "../../types";
+import { PbPageImportExportContext } from "../types";
+declare const _default: ({ storageOperations }: PageImportExportPluginsParams) => ContextPlugin<PbPageImportExportContext>;
+export default _default;

package/graphql/crud/pageImportExportTasks.crud.js

@@ -0,0 +1,394 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _mdbid = _interopRequireDefault(require("mdbid"));
+
+var _fields = require("@commodo/fields");
+
+var _commodoFieldsObject = require("commodo-fields-object");
+
+var _validation = require("@webiny/validation");
+
+var _ContextPlugin = require("@webiny/handler/plugins/ContextPlugin");
+
+var _checkBasePermissions = _interopRequireDefault(require("@webiny/api-page-builder/graphql/crud/utils/checkBasePermissions"));
+
+var _checkOwnPermissions = _interopRequireDefault(require("@webiny/api-page-builder/graphql/crud/utils/checkOwnPermissions"));
+
+var _handlerGraphql = require("@webiny/handler-graphql");
+
+var _types = require("../../types");
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+const validStatus = `${_types.PageImportExportTaskStatus.PENDING}:${_types.PageImportExportTaskStatus.PROCESSING}:${_types.PageImportExportTaskStatus.COMPLETED}:${_types.PageImportExportTaskStatus.FAILED}`;
+const CreateDataModel = (0, _fields.withFields)({
+  status: (0, _fields.string)({
+    validation: _validation.validation.create(`required,in:${validStatus}`)
+  }),
+  data: (0, _commodoFieldsObject.object)(),
+  input: (0, _commodoFieldsObject.object)(),
+  stats: (0, _commodoFieldsObject.object)(),
+  error: (0, _commodoFieldsObject.object)()
+})();
+const UpdateDataModel = (0, _fields.withFields)({
+  status: (0, _fields.string)({
+    validation: _validation.validation.create(`in:${validStatus}`)
+  }),
+  data: (0, _commodoFieldsObject.object)(),
+  input: (0, _commodoFieldsObject.object)(),
+  stats: (0, _commodoFieldsObject.object)(),
+  error: (0, _commodoFieldsObject.object)()
+})();
+const PERMISSION_NAME = "pb.page";
+
+var _default = ({
+  storageOperations
+}) => new _ContextPlugin.ContextPlugin(async context => {
+  /**
+   * If pageBuilder is not defined on the context, do not continue, but log it.
+   */
+  if (!context.pageBuilder) {
+    console.log("Missing pageBuilder on context. Skipping Page ImportExportTasks crud.");
+    return;
+  } // Modify context
+
+
+  context.pageBuilder.pageImportExportTask = {
+    storageOperations,
+
+    async getTask(id) {
+      const permission = await (0, _checkBasePermissions.default)(context, PERMISSION_NAME, {
+        rwd: "r"
+      });
+      const tenant = context.tenancy.getCurrentTenant();
+      const locale = context.i18nContent.getLocale();
+      const params = {
+        where: {
+          tenant: tenant.id,
+          locale: locale.code,
+          id
+        }
+      };
+      let pageImportExportTask;
+
+      try {
+        pageImportExportTask = await storageOperations.getTask(params);
+
+        if (!pageImportExportTask) {
+          return null;
+        }
+      } catch (ex) {
+        throw new _error.default(ex.message || "Could not get pageImportExportTask by id.", ex.code || "GET_PAGE_IMPORT_EXPORT_TASK_ERROR", _objectSpread(_objectSpread({}, ex.data || {}), {}, {
+          params
+        }));
+      }
+
+      const identity = context.security.getIdentity();
+      (0, _checkOwnPermissions.default)(identity, permission, pageImportExportTask);
+      return pageImportExportTask;
+    },
+
+    async listTasks(params) {
+      const permission = await (0, _checkBasePermissions.default)(context, PERMISSION_NAME, {
+        rwd: "r"
+      });
+      const tenant = context.tenancy.getCurrentTenant();
+      const locale = context.i18nContent.getLocale();
+      const {
+        sort,
+        limit
+      } = params || {};
+      const listParams = {
+        where: {
+          tenant: tenant.id,
+          locale: locale.code
+        },
+        sort: Array.isArray(sort) && sort.length > 0 ? sort : ["createdOn_ASC"],
+        limit: limit
+      }; // If user can only manage own records, let's add that to the listing.
+
+      if (permission.own) {
+        const identity = context.security.getIdentity();
+        listParams.where.createdBy = identity.id;
+      }
+
+      try {
+        const [items] = await storageOperations.listTasks(listParams);
+        return items;
+      } catch (ex) {
+        throw new _error.default(ex.message || "Could not list all page elements.", ex.code || "LIST_PAGE_ELEMENTS_ERROR", {
+          params
+        });
+      }
+    },
+
+    async createTask(input) {
+      await (0, _checkBasePermissions.default)(context, PERMISSION_NAME, {
+        rwd: "w"
+      });
+      const createDataModel = new CreateDataModel().populate(input);
+      await createDataModel.validate();
+      const id = (0, _mdbid.default)();
+      const identity = context.security.getIdentity();
+      const data = await createDataModel.toJSON();
+
+      const pageImportExportTask = _objectSpread(_objectSpread({}, data), {}, {
+        tenant: context.tenancy.getCurrentTenant().id,
+        locale: context.i18nContent.getLocale().code,
+        id,
+        createdOn: new Date().toISOString(),
+        createdBy: {
+          id: identity.id,
+          type: identity.type,
+          displayName: identity.displayName
+        }
+      });
+
+      try {
+        return await storageOperations.createTask({
+          input: data,
+          task: pageImportExportTask
+        });
+      } catch (ex) {
+        throw new _error.default(ex.message || "Could not create pageImportExportTask.", ex.code || "CREATE_PAGE_IMPORT_EXPORT_TASK_ERROR", _objectSpread(_objectSpread({}, ex.data || {}), {}, {
+          pageImportExportTask
+        }));
+      }
+    },
+
+    async updateTask(id, input) {
+      const permission = await (0, _checkBasePermissions.default)(context, PERMISSION_NAME, {
+        rwd: "w"
+      });
+      const original = await context.pageBuilder.pageImportExportTask.getTask(id);
+
+      if (!original) {
+        throw new _handlerGraphql.NotFoundError(`PageImportExportTask "${id}" not found.`);
+      }
+
+      const identity = context.security.getIdentity();
+      (0, _checkOwnPermissions.default)(identity, permission, original);
+      const updateDataModel = new UpdateDataModel().populate(input);
+      await updateDataModel.validate();
+      const data = await updateDataModel.toJSON({
+        onlyDirty: true
+      });
+
+      const pageImportExportTask = _objectSpread(_objectSpread({}, original), data);
+
+      try {
+        return await storageOperations.updateTask({
+          input: data,
+          original,
+          task: pageImportExportTask
+        });
+      } catch (ex) {
+        throw new _error.default(ex.message || "Could not update pageImportExportTask.", ex.code || "UPDATE_PAGE_IMPORT_EXPORT_TASK_ERROR", _objectSpread(_objectSpread({}, ex.data || {}), {}, {
+          original,
+          pageImportExportTask
+        }));
+      }
+    },
+
+    async deleteTask(id) {
+      const permission = await (0, _checkBasePermissions.default)(context, PERMISSION_NAME, {
+        rwd: "d"
+      });
+      const pageImportExportTask = await context.pageBuilder.pageImportExportTask.getTask(id);
+
+      if (!pageImportExportTask) {
+        throw new _handlerGraphql.NotFoundError(`PageImportExportTask "${id}" not found.`);
+      }
+
+      const identity = context.security.getIdentity();
+      (0, _checkOwnPermissions.default)(identity, permission, pageImportExportTask);
+
+      try {
+        return await storageOperations.deleteTask({
+          task: pageImportExportTask
+        });
+      } catch (ex) {
+        throw new _error.default(ex.message || "Could not delete pageImportExportTask.", ex.code || "DELETE_PAGE_IMPORT_EXPORT_TASK_ERROR", _objectSpread(_objectSpread({}, ex.data || {}), {}, {
+          pageImportExportTask
+        }));
+      }
+    },
+
+    async updateStats(id, input) {
+      const permission = await (0, _checkBasePermissions.default)(context, PERMISSION_NAME, {
+        rwd: "w"
+      });
+      const original = await context.pageBuilder.pageImportExportTask.getTask(id);
+
+      if (!original) {
+        throw new _handlerGraphql.NotFoundError(`PageImportExportTask "${id}" not found.`);
+      }
+
+      const identity = context.security.getIdentity();
+      (0, _checkOwnPermissions.default)(identity, permission, original);
+
+      try {
+        return await storageOperations.updateTaskStats({
+          input,
+          original
+        });
+      } catch (ex) {
+        throw new _error.default(ex.message || "Could not update pageImportExportTask.", ex.code || "UPDATE_PAGE_IMPORT_EXPORT_TASK_ERROR", _objectSpread(_objectSpread({}, ex.data || {}), {}, {
+          original
+        }));
+      }
+    },
+
+    async createSubTask(parent, id, input) {
+      await (0, _checkBasePermissions.default)(context, PERMISSION_NAME, {
+        rwd: "w"
+      });
+      const createDataModel = new CreateDataModel().populate(input);
+      await createDataModel.validate();
+      const identity = context.security.getIdentity();
+      const data = await createDataModel.toJSON();
+
+      const pageImportExportSubTask = _objectSpread(_objectSpread({}, data), {}, {
+        tenant: context.tenancy.getCurrentTenant().id,
+        locale: context.i18nContent.getLocale().code,
+        id: id,
+        parent: parent,
+        createdOn: new Date().toISOString(),
+        createdBy: {
+          id: identity.id,
+          type: identity.type,
+          displayName: identity.displayName
+        }
+      });
+
+      try {
+        return await storageOperations.createSubTask({
+          input: data,
+          subTask: pageImportExportSubTask
+        });
+      } catch (ex) {
+        throw new _error.default(ex.message || "Could not create pageImportExportSubTask.", ex.code || "CREATE_PAGE_IMPORT_EXPORT_TASK_ERROR", _objectSpread(_objectSpread({}, ex.data || {}), {}, {
+          pageImportExportSubTask
+        }));
+      }
+    },
+
+    async updateSubTask(parent, subTaskId, input) {
+      const permission = await (0, _checkBasePermissions.default)(context, PERMISSION_NAME, {
+        rwd: "w"
+      });
+      const original = await context.pageBuilder.pageImportExportTask.getSubTask(parent, subTaskId);
+
+      if (!original) {
+        throw new _handlerGraphql.NotFoundError(`PageImportExportTask parent: "${parent}" and id: "${subTaskId}" not found.`);
+      }
+
+      const identity = context.security.getIdentity();
+      (0, _checkOwnPermissions.default)(identity, permission, original);
+      const updateDataModel = new UpdateDataModel().populate(input);
+      await updateDataModel.validate();
+      const data = await updateDataModel.toJSON({
+        onlyDirty: true
+      }); // TODO: Merge recursively
+
+      const pageImportExportSubTask = _objectSpread(_objectSpread({}, original), data);
+
+      try {
+        return await storageOperations.updateSubTask({
+          input: data,
+          original,
+          subTask: pageImportExportSubTask
+        });
+      } catch (ex) {
+        throw new _error.default(ex.message || "Could not update pageImportExportSubTask.", ex.code || "UPDATE_PAGE_IMPORT_EXPORT_TASK_ERROR", _objectSpread(_objectSpread({}, ex.data || {}), {}, {
+          pageImportExportSubTask,
+          original
+        }));
+      }
+    },
+
+    async getSubTask(parent, subTaskId) {
+      const permission = await (0, _checkBasePermissions.default)(context, PERMISSION_NAME, {
+        rwd: "r"
+      });
+      const tenant = context.tenancy.getCurrentTenant();
+      const locale = context.i18nContent.getLocale();
+      const params = {
+        where: {
+          tenant: tenant.id,
+          locale: locale.code,
+          id: subTaskId,
+          parent: parent
+        }
+      };
+      let pageImportExportSubTask;
+
+      try {
+        pageImportExportSubTask = await storageOperations.getSubTask(params);
+
+        if (!pageImportExportSubTask) {
+          return null;
+        }
+      } catch (ex) {
+        throw new _error.default(ex.message || "Could not get pageImportExportSubTask by id.", ex.code || "GET_PAGE_IMPORT_EXPORT_TASK_ERROR", _objectSpread(_objectSpread({}, ex.data || {}), {}, {
+          params
+        }));
+      }
+
+      const identity = context.security.getIdentity();
+      (0, _checkOwnPermissions.default)(identity, permission, pageImportExportSubTask);
+      return pageImportExportSubTask;
+    },
+
+    async listSubTasks(parent, status, limit) {
+      const permission = await (0, _checkBasePermissions.default)(context, PERMISSION_NAME, {
+        rwd: "r"
+      });
+      const tenant = context.tenancy.getCurrentTenant();
+      const locale = context.i18nContent.getLocale();
+      const listParams = {
+        where: {
+          tenant: tenant.id,
+          locale: locale.code,
+          parent: parent,
+          status
+        },
+        limit
+      }; // If user can only manage own records, let's add that to the listing.
+
+      if (permission.own) {
+        const identity = context.security.getIdentity();
+        listParams.where.createdBy = identity.id;
+      }
+
+      try {
+        const [items] = await storageOperations.listSubTasks(listParams);
+        return items;
+      } catch (ex) {
+        throw new _error.default(ex.message || "Could not list all pageImportExportSubTask.", ex.code || "LIST_PAGE_IMPORT_EXPORT_TASK_ERROR", {
+          params: {
+            parent,
+            status,
+            limit
+          }
+        });
+      }
+    }
+
+  };
+});
+
+exports.default = _default;

package/graphql/crud/pages.crud.d.ts

@@ -0,0 +1,4 @@
+import { ContextPlugin } from "@webiny/handler/plugins/ContextPlugin";
+import { PbPageImportExportContext } from "../../types";
+declare const _default: ContextPlugin<PbPageImportExportContext>;
+export default _default;