@webiny/api-page-builder-import-export 0.0.0-unstable.990c3ab1b6 → 0.0.0-unstable.bca7b3e350

package/{exportPages → export}/process/index.d.ts

@@ -1,6 +1,6 @@
-import { PbPageImportExportContext } from "../../types";
+import { PbImportExportContext } from "../../types";
 import { SecurityIdentity } from "@webiny/api-security/types";
-interface Configuration {
+export interface Configuration {
     handlers: {
         process: string;
         combine: string;
@@ -9,14 +9,12 @@ interface Configuration {
 export interface Payload {
     taskId: string;
     subTaskIndex: number;
+    type: string;
     identity?: SecurityIdentity;
 }
 export interface Response {
     data: string | null;
     error: Partial<Error> | null;
 }
-/**
- * Handles the export pages process workflow.
- */
-declare const _default: (configuration: Configuration) => import("@webiny/handler-aws").RawEventHandler<Payload, PbPageImportExportContext, Response>;
+declare const _default: (configuration: Configuration) => import("@webiny/handler-aws").RawEventHandler<Payload, PbImportExportContext, Response>;
 export default _default;

package/export/process/index.js

@@ -0,0 +1,32 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _handlerAws = require("@webiny/handler-aws");
+var _blocksHandler = require("./blocksHandler");
+var _pagesHandler = require("./pagesHandler");
+var _templatesHandler = require("./templatesHandler");
+var _default = configuration => {
+  return (0, _handlerAws.createRawEventHandler)(async ({
+    payload,
+    context
+  }) => {
+    switch (payload.type) {
+      case "block":
+        {
+          return await (0, _blocksHandler.blocksHandler)(configuration, payload, context);
+        }
+      case "template":
+        {
+          return await (0, _templatesHandler.templatesHandler)(configuration, payload, context);
+        }
+      default:
+        {
+          return await (0, _pagesHandler.pagesHandler)(configuration, payload, context);
+        }
+    }
+  });
+};
+exports.default = _default;

package/export/process/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["configuration","createRawEventHandler","payload","context","type","blocksHandler","templatesHandler","pagesHandler"],"sources":["index.ts"],"sourcesContent":["import { PbImportExportContext } from \"~/types\";\nimport { SecurityIdentity } from \"@webiny/api-security/types\";\nimport { createRawEventHandler } from \"@webiny/handler-aws\";\nimport { blocksHandler } from \"~/export/process/blocksHandler\";\nimport { pagesHandler } from \"~/export/process/pagesHandler\";\nimport { templatesHandler } from \"~/export/process/templatesHandler\";\n\nexport interface Configuration {\n    handlers: {\n        process: string;\n        combine: string;\n    };\n}\n\nexport interface Payload {\n    taskId: string;\n    subTaskIndex: number;\n    type: string;\n    identity?: SecurityIdentity;\n}\n\nexport interface Response {\n    data: string | null;\n    error: Partial<Error> | null;\n}\n\nexport default (configuration: Configuration) => {\n    return createRawEventHandler<Payload, PbImportExportContext, Response>(\n        async ({ payload, context }) => {\n            switch (payload.type) {\n                case \"block\": {\n                    return await blocksHandler(configuration, payload, context);\n                }\n                case \"template\": {\n                    return await templatesHandler(configuration, payload, context);\n                }\n                default: {\n                    return await pagesHandler(configuration, payload, context);\n                }\n            }\n        }\n    );\n};\n"],"mappings":";;;;;;AAEA;AACA;AACA;AACA;AAAqE,eAqBrDA,aAA4B,IAAK;EAC7C,OAAO,IAAAC,iCAAqB,EACxB,OAAO;IAAEC,OAAO;IAAEC;EAAQ,CAAC,KAAK;IAC5B,QAAQD,OAAO,CAACE,IAAI;MAChB,KAAK,OAAO;QAAE;UACV,OAAO,MAAM,IAAAC,4BAAa,EAACL,aAAa,EAAEE,OAAO,EAAEC,OAAO,CAAC;QAC/D;MACA,KAAK,UAAU;QAAE;UACb,OAAO,MAAM,IAAAG,kCAAgB,EAACN,aAAa,EAAEE,OAAO,EAAEC,OAAO,CAAC;QAClE;MACA;QAAS;UACL,OAAO,MAAM,IAAAI,0BAAY,EAACP,aAAa,EAAEE,OAAO,EAAEC,OAAO,CAAC;QAC9D;IAAC;EAET,CAAC,CACJ;AACL,CAAC;AAAA"}

package/export/process/pagesHandler.d.ts

@@ -0,0 +1,6 @@
+import { PbImportExportContext } from "../../types";
+import { Configuration, Payload, Response } from ".";
+/**
+ * Handles the export pages process workflow.
+ */
+export declare const pagesHandler: (configuration: Configuration, payload: Payload, context: PbImportExportContext) => Promise<Response>;

package/export/process/pagesHandler.js

@@ -0,0 +1,189 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.pagesHandler = void 0;
+var _types = require("../../types");
+var _client = require("../../client");
+var _handlerGraphql = require("@webiny/handler-graphql");
+var _utils = require("../utils");
+var _mockSecurity = require("../../mockSecurity");
+var _utils2 = require("@webiny/utils");
+/**
+ * Handles the export pages process workflow.
+ */
+const pagesHandler = async (configuration, payload, context) => {
+  const log = console.log;
+  let subTask;
+  let noPendingTask = true;
+  let prevStatusOfSubTask = _types.ImportExportTaskStatus.PENDING;
+  log("RUNNING Export Pages Process Handler");
+  const {
+    pageBuilder,
+    fileManager
+  } = context;
+  const {
+    taskId,
+    subTaskIndex,
+    type,
+    identity
+  } = payload;
+  // Disable authorization; this is necessary because we call Page Builder CRUD methods which include authorization checks
+  // and this Lambda is invoked internally, without credentials.
+  (0, _mockSecurity.mockSecurity)(identity, context);
+  try {
+    /*
+     * Note: We're not going to DB for finding the next sub-task to process,
+     * because the data might be out of sync due to GSI eventual consistency.
+     */
+    subTask = await pageBuilder.importExportTask.getSubTask(taskId, (0, _utils2.zeroPad)(subTaskIndex, 5));
+    /**
+     * Base condition!!
+     * Bail out early, if task not found or task's status is not "pending".
+     */
+    if (!subTask || subTask.status !== _types.ImportExportTaskStatus.PENDING) {
+      noPendingTask = true;
+      return {
+        data: "",
+        error: null
+      };
+    } else {
+      noPendingTask = false;
+    }
+    log(`Fetched sub task => ${subTask.id}`);
+    const {
+      input
+    } = subTask;
+    const {
+      pageId,
+      exportPagesDataKey,
+      revisionType
+    } = input;
+
+    /**
+     * At the moment, we only export a single revision of the page.
+     * It could be "published" or "latest" depending upon user input.
+     *
+     * Note: In case of no "published" revision available, we use the latest revision.
+     */
+    let page;
+    try {
+      if (revisionType === _types.ExportRevisionType.PUBLISHED) {
+        // Get "published" page.
+        page = await pageBuilder.getPublishedPageById({
+          id: pageId
+        });
+      } else {
+        // Get "latest" page.
+        page = await pageBuilder.getPage(pageId);
+      }
+    } catch (e) {
+      // If we're looking for "published" page and doesn't found it, get latest page.
+      if (revisionType === _types.ExportRevisionType.PUBLISHED && e instanceof _handlerGraphql.NotFoundError) {
+        page = await pageBuilder.getPage(pageId);
+      } else {
+        throw e;
+      }
+    }
+    if (!page) {
+      log(`Unable to load page "${pageId}"`);
+      throw new _handlerGraphql.NotFoundError(`Unable to load page "${pageId}"`);
+    }
+    log(`Processing page key "${pageId}" | version ${page.version} | ${page.status}`);
+
+    // Mark task status as PROCESSING
+    subTask = await pageBuilder.importExportTask.updateSubTask(taskId, subTask.id, {
+      status: _types.ImportExportTaskStatus.PROCESSING
+    });
+    // Update stats in main task
+    await pageBuilder.importExportTask.updateStats(taskId, {
+      prevStatus: prevStatusOfSubTask,
+      nextStatus: _types.ImportExportTaskStatus.PROCESSING
+    });
+    prevStatusOfSubTask = subTask.status;
+    log(`Extracting page data and uploading to storage...`);
+    // Extract Page
+    const pageDataZip = await (0, _utils.exportPage)(page, exportPagesDataKey, fileManager);
+    log(`Finish uploading zip...`);
+    // Update task record in DB
+    subTask = await pageBuilder.importExportTask.updateSubTask(taskId, subTask.id, {
+      status: _types.ImportExportTaskStatus.COMPLETED,
+      data: {
+        message: `Finish uploading data for page "${page.id}" v${page.version} (${page.status}).`,
+        key: pageDataZip.Key
+      }
+    });
+    // Update stats in main task
+    await pageBuilder.importExportTask.updateStats(taskId, {
+      prevStatus: prevStatusOfSubTask,
+      nextStatus: _types.ImportExportTaskStatus.COMPLETED
+    });
+    prevStatusOfSubTask = subTask.status;
+  } catch (e) {
+    log("[EXPORT_PAGES_PROCESS] Error => ", e);
+    if (subTask && subTask.id) {
+      /**
+       * In case of error, we'll update the task status to "failed",
+       * so that, client can show notify the user appropriately.
+       */
+      subTask = await pageBuilder.importExportTask.updateSubTask(taskId, subTask.id, {
+        status: _types.ImportExportTaskStatus.FAILED,
+        error: {
+          name: e.name,
+          message: e.message,
+          stack: e.stack,
+          code: "EXPORT_FAILED"
+        }
+      });
+
+      // Update stats in main task
+      await pageBuilder.importExportTask.updateStats(taskId, {
+        prevStatus: prevStatusOfSubTask,
+        nextStatus: _types.ImportExportTaskStatus.FAILED
+      });
+      prevStatusOfSubTask = subTask.status;
+    }
+    return {
+      data: null,
+      error: {
+        message: e.message
+      }
+    };
+  } finally {
+    // Base condition!
+    if (noPendingTask) {
+      log(`No pending sub-task for task ${taskId}`);
+      // Combine individual page zip files.
+      await (0, _client.invokeHandlerClient)({
+        context,
+        name: configuration.handlers.combine,
+        payload: {
+          taskId,
+          type,
+          identity: context.security.getIdentity()
+        },
+        description: "Export pages - combine"
+      });
+    } else {
+      console.log(`Invoking PROCESS for task "${subTaskIndex + 1}"`);
+      // We want to continue with Self invocation no matter if current page error out.
+      await (0, _client.invokeHandlerClient)({
+        context,
+        name: configuration.handlers.process,
+        payload: {
+          taskId,
+          type,
+          subTaskIndex: subTaskIndex + 1,
+          identity: context.security.getIdentity()
+        },
+        description: "Export pages - process - subtask"
+      });
+    }
+  }
+  return {
+    data: "",
+    error: null
+  };
+};
+exports.pagesHandler = pagesHandler;

package/export/process/pagesHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["pagesHandler","configuration","payload","context","log","console","subTask","noPendingTask","prevStatusOfSubTask","ImportExportTaskStatus","PENDING","pageBuilder","fileManager","taskId","subTaskIndex","type","identity","mockSecurity","importExportTask","getSubTask","zeroPad","status","data","error","id","input","pageId","exportPagesDataKey","revisionType","page","ExportRevisionType","PUBLISHED","getPublishedPageById","getPage","e","NotFoundError","version","updateSubTask","PROCESSING","updateStats","prevStatus","nextStatus","pageDataZip","exportPage","COMPLETED","message","key","Key","FAILED","name","stack","code","invokeHandlerClient","handlers","combine","security","getIdentity","description","process"],"sources":["pagesHandler.ts"],"sourcesContent":["import { ExportRevisionType, ImportExportTaskStatus, PbImportExportContext } from \"~/types\";\nimport { invokeHandlerClient } from \"~/client\";\nimport { NotFoundError } from \"@webiny/handler-graphql\";\nimport { exportPage } from \"~/export/utils\";\nimport { Payload as ExtractPayload } from \"../combine\";\nimport { mockSecurity } from \"~/mockSecurity\";\nimport { SecurityIdentity } from \"@webiny/api-security/types\";\nimport { zeroPad } from \"@webiny/utils\";\nimport { Configuration, Payload, Response } from \"~/export/process\";\n\n/**\n * Handles the export pages process workflow.\n */\nexport const pagesHandler = async (\n    configuration: Configuration,\n    payload: Payload,\n    context: PbImportExportContext\n): Promise<Response> => {\n    const log = console.log;\n    let subTask;\n    let noPendingTask = true;\n    let prevStatusOfSubTask = ImportExportTaskStatus.PENDING;\n\n    log(\"RUNNING Export Pages Process Handler\");\n    const { pageBuilder, fileManager } = context;\n    const { taskId, subTaskIndex, type, identity } = payload;\n    // Disable authorization; this is necessary because we call Page Builder CRUD methods which include authorization checks\n    // and this Lambda is invoked internally, without credentials.\n    mockSecurity(identity as SecurityIdentity, context);\n\n    try {\n        /*\n         * Note: We're not going to DB for finding the next sub-task to process,\n         * because the data might be out of sync due to GSI eventual consistency.\n         */\n        subTask = await pageBuilder.importExportTask.getSubTask(taskId, zeroPad(subTaskIndex, 5));\n        /**\n         * Base condition!!\n         * Bail out early, if task not found or task's status is not \"pending\".\n         */\n        if (!subTask || subTask.status !== ImportExportTaskStatus.PENDING) {\n            noPendingTask = true;\n            return {\n                data: \"\",\n                error: null\n            };\n        } else {\n            noPendingTask = false;\n        }\n\n        log(`Fetched sub task => ${subTask.id}`);\n\n        const { input } = subTask;\n        const { pageId, exportPagesDataKey, revisionType } = input;\n\n        /**\n         * At the moment, we only export a single revision of the page.\n         * It could be \"published\" or \"latest\" depending upon user input.\n         *\n         * Note: In case of no \"published\" revision available, we use the latest revision.\n         */\n        let page;\n        try {\n            if (revisionType === ExportRevisionType.PUBLISHED) {\n                // Get \"published\" page.\n                page = await pageBuilder.getPublishedPageById({ id: pageId });\n            } else {\n                // Get \"latest\" page.\n                page = await pageBuilder.getPage(pageId);\n            }\n        } catch (e) {\n            // If we're looking for \"published\" page and doesn't found it, get latest page.\n            if (revisionType === ExportRevisionType.PUBLISHED && e instanceof NotFoundError) {\n                page = await pageBuilder.getPage(pageId);\n            } else {\n                throw e;\n            }\n        }\n\n        if (!page) {\n            log(`Unable to load page \"${pageId}\"`);\n            throw new NotFoundError(`Unable to load page \"${pageId}\"`);\n        }\n\n        log(`Processing page key \"${pageId}\" | version ${page.version} | ${page.status}`);\n\n        // Mark task status as PROCESSING\n        subTask = await pageBuilder.importExportTask.updateSubTask(taskId, subTask.id, {\n            status: ImportExportTaskStatus.PROCESSING\n        });\n        // Update stats in main task\n        await pageBuilder.importExportTask.updateStats(taskId, {\n            prevStatus: prevStatusOfSubTask,\n            nextStatus: ImportExportTaskStatus.PROCESSING\n        });\n        prevStatusOfSubTask = subTask.status;\n\n        log(`Extracting page data and uploading to storage...`);\n        // Extract Page\n        const pageDataZip = await exportPage(page, exportPagesDataKey, fileManager);\n        log(`Finish uploading zip...`);\n        // Update task record in DB\n        subTask = await pageBuilder.importExportTask.updateSubTask(taskId, subTask.id, {\n            status: ImportExportTaskStatus.COMPLETED,\n            data: {\n                message: `Finish uploading data for page \"${page.id}\" v${page.version} (${page.status}).`,\n                key: pageDataZip.Key\n            }\n        });\n        // Update stats in main task\n        await pageBuilder.importExportTask.updateStats(taskId, {\n            prevStatus: prevStatusOfSubTask,\n            nextStatus: ImportExportTaskStatus.COMPLETED\n        });\n        prevStatusOfSubTask = subTask.status;\n    } catch (e) {\n        log(\"[EXPORT_PAGES_PROCESS] Error => \", e);\n\n        if (subTask && subTask.id) {\n            /**\n             * In case of error, we'll update the task status to \"failed\",\n             * so that, client can show notify the user appropriately.\n             */\n            subTask = await pageBuilder.importExportTask.updateSubTask(taskId, subTask.id, {\n                status: ImportExportTaskStatus.FAILED,\n                error: {\n                    name: e.name,\n                    message: e.message,\n                    stack: e.stack,\n                    code: \"EXPORT_FAILED\"\n                }\n            });\n\n            // Update stats in main task\n            await pageBuilder.importExportTask.updateStats(taskId, {\n                prevStatus: prevStatusOfSubTask,\n                nextStatus: ImportExportTaskStatus.FAILED\n            });\n            prevStatusOfSubTask = subTask.status;\n        }\n\n        return {\n            data: null,\n            error: {\n                message: e.message\n            }\n        };\n    } finally {\n        // Base condition!\n        if (noPendingTask) {\n            log(`No pending sub-task for task ${taskId}`);\n            // Combine individual page zip files.\n            await invokeHandlerClient<ExtractPayload>({\n                context,\n                name: configuration.handlers.combine,\n                payload: {\n                    taskId,\n                    type,\n                    identity: context.security.getIdentity()\n                },\n                description: \"Export pages - combine\"\n            });\n        } else {\n            console.log(`Invoking PROCESS for task \"${subTaskIndex + 1}\"`);\n            // We want to continue with Self invocation no matter if current page error out.\n            await invokeHandlerClient<Payload>({\n                context,\n                name: configuration.handlers.process,\n                payload: {\n                    taskId,\n                    type,\n                    subTaskIndex: subTaskIndex + 1,\n                    identity: context.security.getIdentity()\n                },\n                description: \"Export pages - process - subtask\"\n            });\n        }\n    }\n    return {\n        data: \"\",\n        error: null\n    };\n};\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AAEA;AAEA;AAGA;AACA;AACA;AACO,MAAMA,YAAY,GAAG,OACxBC,aAA4B,EAC5BC,OAAgB,EAChBC,OAA8B,KACV;EACpB,MAAMC,GAAG,GAAGC,OAAO,CAACD,GAAG;EACvB,IAAIE,OAAO;EACX,IAAIC,aAAa,GAAG,IAAI;EACxB,IAAIC,mBAAmB,GAAGC,6BAAsB,CAACC,OAAO;EAExDN,GAAG,CAAC,sCAAsC,CAAC;EAC3C,MAAM;IAAEO,WAAW;IAAEC;EAAY,CAAC,GAAGT,OAAO;EAC5C,MAAM;IAAEU,MAAM;IAAEC,YAAY;IAAEC,IAAI;IAAEC;EAAS,CAAC,GAAGd,OAAO;EACxD;EACA;EACA,IAAAe,0BAAY,EAACD,QAAQ,EAAsBb,OAAO,CAAC;EAEnD,IAAI;IACA;AACR;AACA;AACA;IACQG,OAAO,GAAG,MAAMK,WAAW,CAACO,gBAAgB,CAACC,UAAU,CAACN,MAAM,EAAE,IAAAO,eAAO,EAACN,YAAY,EAAE,CAAC,CAAC,CAAC;IACzF;AACR;AACA;AACA;IACQ,IAAI,CAACR,OAAO,IAAIA,OAAO,CAACe,MAAM,KAAKZ,6BAAsB,CAACC,OAAO,EAAE;MAC/DH,aAAa,GAAG,IAAI;MACpB,OAAO;QACHe,IAAI,EAAE,EAAE;QACRC,KAAK,EAAE;MACX,CAAC;IACL,CAAC,MAAM;MACHhB,aAAa,GAAG,KAAK;IACzB;IAEAH,GAAG,CAAE,uBAAsBE,OAAO,CAACkB,EAAG,EAAC,CAAC;IAExC,MAAM;MAAEC;IAAM,CAAC,GAAGnB,OAAO;IACzB,MAAM;MAAEoB,MAAM;MAAEC,kBAAkB;MAAEC;IAAa,CAAC,GAAGH,KAAK;;IAE1D;AACR;AACA;AACA;AACA;AACA;IACQ,IAAII,IAAI;IACR,IAAI;MACA,IAAID,YAAY,KAAKE,yBAAkB,CAACC,SAAS,EAAE;QAC/C;QACAF,IAAI,GAAG,MAAMlB,WAAW,CAACqB,oBAAoB,CAAC;UAAER,EAAE,EAAEE;QAAO,CAAC,CAAC;MACjE,CAAC,MAAM;QACH;QACAG,IAAI,GAAG,MAAMlB,WAAW,CAACsB,OAAO,CAACP,MAAM,CAAC;MAC5C;IACJ,CAAC,CAAC,OAAOQ,CAAC,EAAE;MACR;MACA,IAAIN,YAAY,KAAKE,yBAAkB,CAACC,SAAS,IAAIG,CAAC,YAAYC,6BAAa,EAAE;QAC7EN,IAAI,GAAG,MAAMlB,WAAW,CAACsB,OAAO,CAACP,MAAM,CAAC;MAC5C,CAAC,MAAM;QACH,MAAMQ,CAAC;MACX;IACJ;IAEA,IAAI,CAACL,IAAI,EAAE;MACPzB,GAAG,CAAE,wBAAuBsB,MAAO,GAAE,CAAC;MACtC,MAAM,IAAIS,6BAAa,CAAE,wBAAuBT,MAAO,GAAE,CAAC;IAC9D;IAEAtB,GAAG,CAAE,wBAAuBsB,MAAO,eAAcG,IAAI,CAACO,OAAQ,MAAKP,IAAI,CAACR,MAAO,EAAC,CAAC;;IAEjF;IACAf,OAAO,GAAG,MAAMK,WAAW,CAACO,gBAAgB,CAACmB,aAAa,CAACxB,MAAM,EAAEP,OAAO,CAACkB,EAAE,EAAE;MAC3EH,MAAM,EAAEZ,6BAAsB,CAAC6B;IACnC,CAAC,CAAC;IACF;IACA,MAAM3B,WAAW,CAACO,gBAAgB,CAACqB,WAAW,CAAC1B,MAAM,EAAE;MACnD2B,UAAU,EAAEhC,mBAAmB;MAC/BiC,UAAU,EAAEhC,6BAAsB,CAAC6B;IACvC,CAAC,CAAC;IACF9B,mBAAmB,GAAGF,OAAO,CAACe,MAAM;IAEpCjB,GAAG,CAAE,kDAAiD,CAAC;IACvD;IACA,MAAMsC,WAAW,GAAG,MAAM,IAAAC,iBAAU,EAACd,IAAI,EAAEF,kBAAkB,EAAEf,WAAW,CAAC;IAC3ER,GAAG,CAAE,yBAAwB,CAAC;IAC9B;IACAE,OAAO,GAAG,MAAMK,WAAW,CAACO,gBAAgB,CAACmB,aAAa,CAACxB,MAAM,EAAEP,OAAO,CAACkB,EAAE,EAAE;MAC3EH,MAAM,EAAEZ,6BAAsB,CAACmC,SAAS;MACxCtB,IAAI,EAAE;QACFuB,OAAO,EAAG,mCAAkChB,IAAI,CAACL,EAAG,MAAKK,IAAI,CAACO,OAAQ,KAAIP,IAAI,CAACR,MAAO,IAAG;QACzFyB,GAAG,EAAEJ,WAAW,CAACK;MACrB;IACJ,CAAC,CAAC;IACF;IACA,MAAMpC,WAAW,CAACO,gBAAgB,CAACqB,WAAW,CAAC1B,MAAM,EAAE;MACnD2B,UAAU,EAAEhC,mBAAmB;MAC/BiC,UAAU,EAAEhC,6BAAsB,CAACmC;IACvC,CAAC,CAAC;IACFpC,mBAAmB,GAAGF,OAAO,CAACe,MAAM;EACxC,CAAC,CAAC,OAAOa,CAAC,EAAE;IACR9B,GAAG,CAAC,kCAAkC,EAAE8B,CAAC,CAAC;IAE1C,IAAI5B,OAAO,IAAIA,OAAO,CAACkB,EAAE,EAAE;MACvB;AACZ;AACA;AACA;MACYlB,OAAO,GAAG,MAAMK,WAAW,CAACO,gBAAgB,CAACmB,aAAa,CAACxB,MAAM,EAAEP,OAAO,CAACkB,EAAE,EAAE;QAC3EH,MAAM,EAAEZ,6BAAsB,CAACuC,MAAM;QACrCzB,KAAK,EAAE;UACH0B,IAAI,EAAEf,CAAC,CAACe,IAAI;UACZJ,OAAO,EAAEX,CAAC,CAACW,OAAO;UAClBK,KAAK,EAAEhB,CAAC,CAACgB,KAAK;UACdC,IAAI,EAAE;QACV;MACJ,CAAC,CAAC;;MAEF;MACA,MAAMxC,WAAW,CAACO,gBAAgB,CAACqB,WAAW,CAAC1B,MAAM,EAAE;QACnD2B,UAAU,EAAEhC,mBAAmB;QAC/BiC,UAAU,EAAEhC,6BAAsB,CAACuC;MACvC,CAAC,CAAC;MACFxC,mBAAmB,GAAGF,OAAO,CAACe,MAAM;IACxC;IAEA,OAAO;MACHC,IAAI,EAAE,IAAI;MACVC,KAAK,EAAE;QACHsB,OAAO,EAAEX,CAAC,CAACW;MACf;IACJ,CAAC;EACL,CAAC,SAAS;IACN;IACA,IAAItC,aAAa,EAAE;MACfH,GAAG,CAAE,gCAA+BS,MAAO,EAAC,CAAC;MAC7C;MACA,MAAM,IAAAuC,2BAAmB,EAAiB;QACtCjD,OAAO;QACP8C,IAAI,EAAEhD,aAAa,CAACoD,QAAQ,CAACC,OAAO;QACpCpD,OAAO,EAAE;UACLW,MAAM;UACNE,IAAI;UACJC,QAAQ,EAAEb,OAAO,CAACoD,QAAQ,CAACC,WAAW;QAC1C,CAAC;QACDC,WAAW,EAAE;MACjB,CAAC,CAAC;IACN,CAAC,MAAM;MACHpD,OAAO,CAACD,GAAG,CAAE,8BAA6BU,YAAY,GAAG,CAAE,GAAE,CAAC;MAC9D;MACA,MAAM,IAAAsC,2BAAmB,EAAU;QAC/BjD,OAAO;QACP8C,IAAI,EAAEhD,aAAa,CAACoD,QAAQ,CAACK,OAAO;QACpCxD,OAAO,EAAE;UACLW,MAAM;UACNE,IAAI;UACJD,YAAY,EAAEA,YAAY,GAAG,CAAC;UAC9BE,QAAQ,EAAEb,OAAO,CAACoD,QAAQ,CAACC,WAAW;QAC1C,CAAC;QACDC,WAAW,EAAE;MACjB,CAAC,CAAC;IACN;EACJ;EACA,OAAO;IACHnC,IAAI,EAAE,EAAE;IACRC,KAAK,EAAE;EACX,CAAC;AACL,CAAC;AAAC"}

package/export/process/templatesHandler.d.ts

@@ -0,0 +1,6 @@
+import { PbImportExportContext } from "../../types";
+import { Configuration, Payload, Response } from ".";
+/**
+ * Handles the export templates process workflow.
+ */
+export declare const templatesHandler: (configuration: Configuration, payload: Payload, context: PbImportExportContext) => Promise<Response>;

package/export/process/templatesHandler.js

@@ -0,0 +1,166 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.templatesHandler = void 0;
+var _types = require("../../types");
+var _client = require("../../client");
+var _handlerGraphql = require("@webiny/handler-graphql");
+var _utils = require("../utils");
+var _mockSecurity = require("../../mockSecurity");
+var _utils2 = require("@webiny/utils");
+/**
+ * Handles the export templates process workflow.
+ */
+const templatesHandler = async (configuration, payload, context) => {
+  const log = console.log;
+  let subTask;
+  let noPendingTask = true;
+  let prevStatusOfSubTask = _types.ImportExportTaskStatus.PENDING;
+  log("RUNNING Export Templates Process Handler");
+  const {
+    pageBuilder,
+    fileManager
+  } = context;
+  const {
+    taskId,
+    subTaskIndex,
+    type,
+    identity
+  } = payload;
+  // Disable authorization; this is necessary because we call Page Builder CRUD methods which include authorization checks
+  // and this Lambda is invoked internally, without credentials.
+  (0, _mockSecurity.mockSecurity)(identity, context);
+  try {
+    /*
+     * Note: We're not going to DB for finding the next sub-task to process,
+     * because the data might be out of sync due to GSI eventual consistency.
+     */
+    subTask = await pageBuilder.importExportTask.getSubTask(taskId, (0, _utils2.zeroPad)(subTaskIndex, 5));
+    /**
+     * Base condition!!
+     * Bail out early, if task not found or task's status is not "pending".
+     */
+    if (!subTask || subTask.status !== _types.ImportExportTaskStatus.PENDING) {
+      noPendingTask = true;
+      return {
+        data: "",
+        error: null
+      };
+    } else {
+      noPendingTask = false;
+    }
+    log(`Fetched sub task => ${subTask.id}`);
+    const {
+      input
+    } = subTask;
+    const {
+      templateId,
+      exportTemplatesDataKey
+    } = input;
+    const template = await pageBuilder.getPageTemplate({
+      where: {
+        id: templateId
+      }
+    });
+    if (!template) {
+      log(`Unable to load template "${templateId}"`);
+      throw new _handlerGraphql.NotFoundError(`Unable to load template "${templateId}"`);
+    }
+    log(`Processing template key "${templateId}"`);
+
+    // Mark task status as PROCESSING
+    subTask = await pageBuilder.importExportTask.updateSubTask(taskId, subTask.id, {
+      status: _types.ImportExportTaskStatus.PROCESSING
+    });
+    // Update stats in main task
+    await pageBuilder.importExportTask.updateStats(taskId, {
+      prevStatus: prevStatusOfSubTask,
+      nextStatus: _types.ImportExportTaskStatus.PROCESSING
+    });
+    prevStatusOfSubTask = subTask.status;
+    log(`Extracting template data and uploading to storage...`);
+    // Extract Template
+    const templateDataZip = await (0, _utils.exportTemplate)(template, exportTemplatesDataKey, fileManager);
+    log(`Finish uploading zip...`);
+    // Update task record in DB
+    subTask = await pageBuilder.importExportTask.updateSubTask(taskId, subTask.id, {
+      status: _types.ImportExportTaskStatus.COMPLETED,
+      data: {
+        message: `Finish uploading data for template "${template.id}"`,
+        key: templateDataZip.Key
+      }
+    });
+    // Update stats in main task
+    await pageBuilder.importExportTask.updateStats(taskId, {
+      prevStatus: prevStatusOfSubTask,
+      nextStatus: _types.ImportExportTaskStatus.COMPLETED
+    });
+    prevStatusOfSubTask = subTask.status;
+  } catch (e) {
+    log("[EXPORT_TEMPLATES_PROCESS] Error => ", e.message);
+    if (subTask && subTask.id) {
+      /**
+       * In case of error, we'll update the task status to "failed",
+       * so that, client can show notify the user appropriately.
+       */
+      subTask = await pageBuilder.importExportTask.updateSubTask(taskId, subTask.id, {
+        status: _types.ImportExportTaskStatus.FAILED,
+        error: {
+          name: e.name,
+          message: e.message,
+          code: "EXPORT_FAILED"
+        }
+      });
+
+      // Update stats in main task
+      await pageBuilder.importExportTask.updateStats(taskId, {
+        prevStatus: prevStatusOfSubTask,
+        nextStatus: _types.ImportExportTaskStatus.FAILED
+      });
+      prevStatusOfSubTask = subTask.status;
+    }
+    return {
+      data: null,
+      error: {
+        message: e.message
+      }
+    };
+  } finally {
+    // Base condition!
+    if (noPendingTask) {
+      log(`No pending sub-task for task ${taskId}`);
+      // Combine individual template zip files.
+      await (0, _client.invokeHandlerClient)({
+        context,
+        name: configuration.handlers.combine,
+        payload: {
+          taskId,
+          type,
+          identity: context.security.getIdentity()
+        },
+        description: "Export templates - combine"
+      });
+    } else {
+      console.log(`Invoking PROCESS for task "${subTaskIndex + 1}"`);
+      // We want to continue with Self invocation no matter if current template error out.
+      await (0, _client.invokeHandlerClient)({
+        context,
+        name: configuration.handlers.process,
+        payload: {
+          taskId,
+          subTaskIndex: subTaskIndex + 1,
+          type,
+          identity: context.security.getIdentity()
+        },
+        description: "Export templates - process - subtask"
+      });
+    }
+  }
+  return {
+    data: "",
+    error: null
+  };
+};
+exports.templatesHandler = templatesHandler;

package/export/process/templatesHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["templatesHandler","configuration","payload","context","log","console","subTask","noPendingTask","prevStatusOfSubTask","ImportExportTaskStatus","PENDING","pageBuilder","fileManager","taskId","subTaskIndex","type","identity","mockSecurity","importExportTask","getSubTask","zeroPad","status","data","error","id","input","templateId","exportTemplatesDataKey","template","getPageTemplate","where","NotFoundError","updateSubTask","PROCESSING","updateStats","prevStatus","nextStatus","templateDataZip","exportTemplate","COMPLETED","message","key","Key","e","FAILED","name","code","invokeHandlerClient","handlers","combine","security","getIdentity","description","process"],"sources":["templatesHandler.ts"],"sourcesContent":["import { ImportExportTaskStatus, PbImportExportContext } from \"~/types\";\nimport { invokeHandlerClient } from \"~/client\";\nimport { NotFoundError } from \"@webiny/handler-graphql\";\nimport { exportTemplate } from \"~/export/utils\";\nimport { Payload as ExtractPayload } from \"../combine\";\nimport { mockSecurity } from \"~/mockSecurity\";\nimport { SecurityIdentity } from \"@webiny/api-security/types\";\nimport { zeroPad } from \"@webiny/utils\";\nimport { Configuration, Payload, Response } from \"~/export/process\";\n\n/**\n * Handles the export templates process workflow.\n */\nexport const templatesHandler = async (\n    configuration: Configuration,\n    payload: Payload,\n    context: PbImportExportContext\n): Promise<Response> => {\n    const log = console.log;\n    let subTask;\n    let noPendingTask = true;\n    let prevStatusOfSubTask = ImportExportTaskStatus.PENDING;\n\n    log(\"RUNNING Export Templates Process Handler\");\n    const { pageBuilder, fileManager } = context;\n    const { taskId, subTaskIndex, type, identity } = payload;\n    // Disable authorization; this is necessary because we call Page Builder CRUD methods which include authorization checks\n    // and this Lambda is invoked internally, without credentials.\n    mockSecurity(identity as SecurityIdentity, context);\n    try {\n        /*\n         * Note: We're not going to DB for finding the next sub-task to process,\n         * because the data might be out of sync due to GSI eventual consistency.\n         */\n        subTask = await pageBuilder.importExportTask.getSubTask(taskId, zeroPad(subTaskIndex, 5));\n        /**\n         * Base condition!!\n         * Bail out early, if task not found or task's status is not \"pending\".\n         */\n        if (!subTask || subTask.status !== ImportExportTaskStatus.PENDING) {\n            noPendingTask = true;\n            return {\n                data: \"\",\n                error: null\n            };\n        } else {\n            noPendingTask = false;\n        }\n\n        log(`Fetched sub task => ${subTask.id}`);\n\n        const { input } = subTask;\n        const { templateId, exportTemplatesDataKey } = input;\n\n        const template = await pageBuilder.getPageTemplate({ where: { id: templateId } });\n\n        if (!template) {\n            log(`Unable to load template \"${templateId}\"`);\n            throw new NotFoundError(`Unable to load template \"${templateId}\"`);\n        }\n\n        log(`Processing template key \"${templateId}\"`);\n\n        // Mark task status as PROCESSING\n        subTask = await pageBuilder.importExportTask.updateSubTask(taskId, subTask.id, {\n            status: ImportExportTaskStatus.PROCESSING\n        });\n        // Update stats in main task\n        await pageBuilder.importExportTask.updateStats(taskId, {\n            prevStatus: prevStatusOfSubTask,\n            nextStatus: ImportExportTaskStatus.PROCESSING\n        });\n        prevStatusOfSubTask = subTask.status;\n\n        log(`Extracting template data and uploading to storage...`);\n        // Extract Template\n        const templateDataZip = await exportTemplate(template, exportTemplatesDataKey, fileManager);\n        log(`Finish uploading zip...`);\n        // Update task record in DB\n        subTask = await pageBuilder.importExportTask.updateSubTask(taskId, subTask.id, {\n            status: ImportExportTaskStatus.COMPLETED,\n            data: {\n                message: `Finish uploading data for template \"${template.id}\"`,\n                key: templateDataZip.Key\n            }\n        });\n        // Update stats in main task\n        await pageBuilder.importExportTask.updateStats(taskId, {\n            prevStatus: prevStatusOfSubTask,\n            nextStatus: ImportExportTaskStatus.COMPLETED\n        });\n        prevStatusOfSubTask = subTask.status;\n    } catch (e) {\n        log(\"[EXPORT_TEMPLATES_PROCESS] Error => \", e.message);\n\n        if (subTask && subTask.id) {\n            /**\n             * In case of error, we'll update the task status to \"failed\",\n             * so that, client can show notify the user appropriately.\n             */\n            subTask = await pageBuilder.importExportTask.updateSubTask(taskId, subTask.id, {\n                status: ImportExportTaskStatus.FAILED,\n                error: {\n                    name: e.name,\n                    message: e.message,\n                    code: \"EXPORT_FAILED\"\n                }\n            });\n\n            // Update stats in main task\n            await pageBuilder.importExportTask.updateStats(taskId, {\n                prevStatus: prevStatusOfSubTask,\n                nextStatus: ImportExportTaskStatus.FAILED\n            });\n            prevStatusOfSubTask = subTask.status;\n        }\n\n        return {\n            data: null,\n            error: {\n                message: e.message\n            }\n        };\n    } finally {\n        // Base condition!\n        if (noPendingTask) {\n            log(`No pending sub-task for task ${taskId}`);\n            // Combine individual template zip files.\n            await invokeHandlerClient<ExtractPayload>({\n                context,\n                name: configuration.handlers.combine,\n                payload: {\n                    taskId,\n                    type,\n                    identity: context.security.getIdentity()\n                },\n                description: \"Export templates - combine\"\n            });\n        } else {\n            console.log(`Invoking PROCESS for task \"${subTaskIndex + 1}\"`);\n            // We want to continue with Self invocation no matter if current template error out.\n            await invokeHandlerClient<Payload>({\n                context,\n                name: configuration.handlers.process,\n                payload: {\n                    taskId,\n                    subTaskIndex: subTaskIndex + 1,\n                    type,\n                    identity: context.security.getIdentity()\n                },\n                description: \"Export templates - process - subtask\"\n            });\n        }\n    }\n    return {\n        data: \"\",\n        error: null\n    };\n};\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AAEA;AAEA;AAGA;AACA;AACA;AACO,MAAMA,gBAAgB,GAAG,OAC5BC,aAA4B,EAC5BC,OAAgB,EAChBC,OAA8B,KACV;EACpB,MAAMC,GAAG,GAAGC,OAAO,CAACD,GAAG;EACvB,IAAIE,OAAO;EACX,IAAIC,aAAa,GAAG,IAAI;EACxB,IAAIC,mBAAmB,GAAGC,6BAAsB,CAACC,OAAO;EAExDN,GAAG,CAAC,0CAA0C,CAAC;EAC/C,MAAM;IAAEO,WAAW;IAAEC;EAAY,CAAC,GAAGT,OAAO;EAC5C,MAAM;IAAEU,MAAM;IAAEC,YAAY;IAAEC,IAAI;IAAEC;EAAS,CAAC,GAAGd,OAAO;EACxD;EACA;EACA,IAAAe,0BAAY,EAACD,QAAQ,EAAsBb,OAAO,CAAC;EACnD,IAAI;IACA;AACR;AACA;AACA;IACQG,OAAO,GAAG,MAAMK,WAAW,CAACO,gBAAgB,CAACC,UAAU,CAACN,MAAM,EAAE,IAAAO,eAAO,EAACN,YAAY,EAAE,CAAC,CAAC,CAAC;IACzF;AACR;AACA;AACA;IACQ,IAAI,CAACR,OAAO,IAAIA,OAAO,CAACe,MAAM,KAAKZ,6BAAsB,CAACC,OAAO,EAAE;MAC/DH,aAAa,GAAG,IAAI;MACpB,OAAO;QACHe,IAAI,EAAE,EAAE;QACRC,KAAK,EAAE;MACX,CAAC;IACL,CAAC,MAAM;MACHhB,aAAa,GAAG,KAAK;IACzB;IAEAH,GAAG,CAAE,uBAAsBE,OAAO,CAACkB,EAAG,EAAC,CAAC;IAExC,MAAM;MAAEC;IAAM,CAAC,GAAGnB,OAAO;IACzB,MAAM;MAAEoB,UAAU;MAAEC;IAAuB,CAAC,GAAGF,KAAK;IAEpD,MAAMG,QAAQ,GAAG,MAAMjB,WAAW,CAACkB,eAAe,CAAC;MAAEC,KAAK,EAAE;QAAEN,EAAE,EAAEE;MAAW;IAAE,CAAC,CAAC;IAEjF,IAAI,CAACE,QAAQ,EAAE;MACXxB,GAAG,CAAE,4BAA2BsB,UAAW,GAAE,CAAC;MAC9C,MAAM,IAAIK,6BAAa,CAAE,4BAA2BL,UAAW,GAAE,CAAC;IACtE;IAEAtB,GAAG,CAAE,4BAA2BsB,UAAW,GAAE,CAAC;;IAE9C;IACApB,OAAO,GAAG,MAAMK,WAAW,CAACO,gBAAgB,CAACc,aAAa,CAACnB,MAAM,EAAEP,OAAO,CAACkB,EAAE,EAAE;MAC3EH,MAAM,EAAEZ,6BAAsB,CAACwB;IACnC,CAAC,CAAC;IACF;IACA,MAAMtB,WAAW,CAACO,gBAAgB,CAACgB,WAAW,CAACrB,MAAM,EAAE;MACnDsB,UAAU,EAAE3B,mBAAmB;MAC/B4B,UAAU,EAAE3B,6BAAsB,CAACwB;IACvC,CAAC,CAAC;IACFzB,mBAAmB,GAAGF,OAAO,CAACe,MAAM;IAEpCjB,GAAG,CAAE,sDAAqD,CAAC;IAC3D;IACA,MAAMiC,eAAe,GAAG,MAAM,IAAAC,qBAAc,EAACV,QAAQ,EAAED,sBAAsB,EAAEf,WAAW,CAAC;IAC3FR,GAAG,CAAE,yBAAwB,CAAC;IAC9B;IACAE,OAAO,GAAG,MAAMK,WAAW,CAACO,gBAAgB,CAACc,aAAa,CAACnB,MAAM,EAAEP,OAAO,CAACkB,EAAE,EAAE;MAC3EH,MAAM,EAAEZ,6BAAsB,CAAC8B,SAAS;MACxCjB,IAAI,EAAE;QACFkB,OAAO,EAAG,uCAAsCZ,QAAQ,CAACJ,EAAG,GAAE;QAC9DiB,GAAG,EAAEJ,eAAe,CAACK;MACzB;IACJ,CAAC,CAAC;IACF;IACA,MAAM/B,WAAW,CAACO,gBAAgB,CAACgB,WAAW,CAACrB,MAAM,EAAE;MACnDsB,UAAU,EAAE3B,mBAAmB;MAC/B4B,UAAU,EAAE3B,6BAAsB,CAAC8B;IACvC,CAAC,CAAC;IACF/B,mBAAmB,GAAGF,OAAO,CAACe,MAAM;EACxC,CAAC,CAAC,OAAOsB,CAAC,EAAE;IACRvC,GAAG,CAAC,sCAAsC,EAAEuC,CAAC,CAACH,OAAO,CAAC;IAEtD,IAAIlC,OAAO,IAAIA,OAAO,CAACkB,EAAE,EAAE;MACvB;AACZ;AACA;AACA;MACYlB,OAAO,GAAG,MAAMK,WAAW,CAACO,gBAAgB,CAACc,aAAa,CAACnB,MAAM,EAAEP,OAAO,CAACkB,EAAE,EAAE;QAC3EH,MAAM,EAAEZ,6BAAsB,CAACmC,MAAM;QACrCrB,KAAK,EAAE;UACHsB,IAAI,EAAEF,CAAC,CAACE,IAAI;UACZL,OAAO,EAAEG,CAAC,CAACH,OAAO;UAClBM,IAAI,EAAE;QACV;MACJ,CAAC,CAAC;;MAEF;MACA,MAAMnC,WAAW,CAACO,gBAAgB,CAACgB,WAAW,CAACrB,MAAM,EAAE;QACnDsB,UAAU,EAAE3B,mBAAmB;QAC/B4B,UAAU,EAAE3B,6BAAsB,CAACmC;MACvC,CAAC,CAAC;MACFpC,mBAAmB,GAAGF,OAAO,CAACe,MAAM;IACxC;IAEA,OAAO;MACHC,IAAI,EAAE,IAAI;MACVC,KAAK,EAAE;QACHiB,OAAO,EAAEG,CAAC,CAACH;MACf;IACJ,CAAC;EACL,CAAC,SAAS;IACN;IACA,IAAIjC,aAAa,EAAE;MACfH,GAAG,CAAE,gCAA+BS,MAAO,EAAC,CAAC;MAC7C;MACA,MAAM,IAAAkC,2BAAmB,EAAiB;QACtC5C,OAAO;QACP0C,IAAI,EAAE5C,aAAa,CAAC+C,QAAQ,CAACC,OAAO;QACpC/C,OAAO,EAAE;UACLW,MAAM;UACNE,IAAI;UACJC,QAAQ,EAAEb,OAAO,CAAC+C,QAAQ,CAACC,WAAW;QAC1C,CAAC;QACDC,WAAW,EAAE;MACjB,CAAC,CAAC;IACN,CAAC,MAAM;MACH/C,OAAO,CAACD,GAAG,CAAE,8BAA6BU,YAAY,GAAG,CAAE,GAAE,CAAC;MAC9D;MACA,MAAM,IAAAiC,2BAAmB,EAAU;QAC/B5C,OAAO;QACP0C,IAAI,EAAE5C,aAAa,CAAC+C,QAAQ,CAACK,OAAO;QACpCnD,OAAO,EAAE;UACLW,MAAM;UACNC,YAAY,EAAEA,YAAY,GAAG,CAAC;UAC9BC,IAAI;UACJC,QAAQ,EAAEb,OAAO,CAAC+C,QAAQ,CAACC,WAAW;QAC1C,CAAC;QACDC,WAAW,EAAE;MACjB,CAAC,CAAC;IACN;EACJ;EACA,OAAO;IACH9B,IAAI,EAAE,EAAE;IACRC,KAAK,EAAE;EACX,CAAC;AACL,CAAC;AAAC"}

package/export/utils.d.ts

@@ -0,0 +1,22 @@
+import S3 from "aws-sdk/clients/s3";
+import { Page, PageBlock, PageTemplate } from "@webiny/api-page-builder/types";
+import { FileManagerContext, File } from "@webiny/api-file-manager/types";
+export declare const EXPORT_PAGES_FOLDER_KEY = "WEBINY_PB_EXPORT_PAGES";
+export declare const EXPORT_BLOCKS_FOLDER_KEY = "WEBINY_PB_EXPORT_BLOCK";
+export declare const EXPORT_TEMPLATES_FOLDER_KEY = "WEBINY_PB_EXPORT_TEMPLATE";
+export interface ExportedPageData {
+    page: Pick<Page, "content" | "title" | "version" | "status" | "settings" | "path">;
+    files: File[];
+}
+export declare function exportPage(page: Page, exportPagesDataKey: string, fileManager: FileManagerContext["fileManager"]): Promise<S3.ManagedUpload.SendData>;
+export interface ExportedBlockData {
+    block: Pick<PageBlock, "name" | "content" | "preview">;
+    files: File[];
+}
+export declare function exportBlock(block: PageBlock, exportBlocksDataKey: string, fileManager: FileManagerContext["fileManager"]): Promise<S3.ManagedUpload.SendData>;
+export interface ExportedTemplateData {
+    template: Pick<PageTemplate, "title" | "slug" | "tags" | "description" | "content" | "layout">;
+    files: File[];
+}
+export declare function exportTemplate(template: PageTemplate, exportTemplatesDataKey: string, fileManager: FileManagerContext["fileManager"]): Promise<S3.ManagedUpload.SendData>;
+export declare function extractFilesFromData(data: Record<string, any>, files?: any[]): File[];

package/export/utils.js

@@ -0,0 +1,160 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.EXPORT_TEMPLATES_FOLDER_KEY = exports.EXPORT_PAGES_FOLDER_KEY = exports.EXPORT_BLOCKS_FOLDER_KEY = void 0;
+exports.exportBlock = exportBlock;
+exports.exportPage = exportPage;
+exports.exportTemplate = exportTemplate;
+exports.extractFilesFromData = extractFilesFromData;
+var _get = _interopRequireDefault(require("lodash/get"));
+var _zipper = _interopRequireDefault(require("./zipper"));
+const EXPORT_PAGES_FOLDER_KEY = "WEBINY_PB_EXPORT_PAGES";
+exports.EXPORT_PAGES_FOLDER_KEY = EXPORT_PAGES_FOLDER_KEY;
+const EXPORT_BLOCKS_FOLDER_KEY = "WEBINY_PB_EXPORT_BLOCK";
+exports.EXPORT_BLOCKS_FOLDER_KEY = EXPORT_BLOCKS_FOLDER_KEY;
+const EXPORT_TEMPLATES_FOLDER_KEY = "WEBINY_PB_EXPORT_TEMPLATE";
+exports.EXPORT_TEMPLATES_FOLDER_KEY = EXPORT_TEMPLATES_FOLDER_KEY;
+async function exportPage(page, exportPagesDataKey, fileManager) {
+  // Extract all files
+  const files = extractFilesFromData(page.content || {});
+  // Extract images from page settings
+  const pageSettingsImages = [(0, _get.default)(page, "settings.general.image"), (0, _get.default)(page, "settings.social.image")].filter(image => image && image.src);
+  const fileIds = [...files, ...pageSettingsImages].map(imageFile => imageFile.id);
+  // Get file data for all images
+  const imageFilesData = [];
+  if (fileIds.length > 0) {
+    const [filesData] = await fileManager.files.listFiles({
+      ids: fileIds
+    });
+    imageFilesData.push(...filesData);
+  }
+
+  // Extract the page data in a json file and upload it to S3
+  const pageData = {
+    page: {
+      content: page.content,
+      title: page.title,
+      path: page.path,
+      version: page.version,
+      status: page.status,
+      settings: page.settings
+    },
+    files: imageFilesData
+  };
+  const pageDataBuffer = Buffer.from(JSON.stringify(pageData));
+  const zipper = new _zipper.default({
+    exportInfo: {
+      files: imageFilesData,
+      name: page.title,
+      dataBuffer: pageDataBuffer
+    },
+    archiveFileKey: exportPagesDataKey
+  });
+  return zipper.process();
+}
+async function exportBlock(block, exportBlocksDataKey, fileManager) {
+  // Extract all files
+  const files = extractFilesFromData(block.content || {});
+  const fileIds = files.map(imageFile => imageFile.id);
+  // Get file data for all images
+  const imageFilesData = [];
+  if (fileIds.length > 0) {
+    const [filesData] = await fileManager.files.listFiles({
+      ids: fileIds
+    });
+    imageFilesData.push(...filesData);
+  }
+  // Add block preview image file data
+  if (block.preview.id) {
+    imageFilesData.push(await fileManager.files.getFile(block.preview.id));
+  }
+
+  // Extract the block data in a json file and upload it to S3
+  const blockData = {
+    block: {
+      name: block.name,
+      content: block.content,
+      preview: block.preview
+    },
+    files: imageFilesData
+  };
+  const blockDataBuffer = Buffer.from(JSON.stringify(blockData));
+  const zipper = new _zipper.default({
+    exportInfo: {
+      files: imageFilesData,
+      name: block.name,
+      dataBuffer: blockDataBuffer
+    },
+    archiveFileKey: exportBlocksDataKey
+  });
+  return zipper.process();
+}
+async function exportTemplate(template, exportTemplatesDataKey, fileManager) {
+  // Extract all files
+  const files = extractFilesFromData(template.content || {});
+  const fileIds = files.map(imageFile => imageFile.id);
+  // Get file data for all images
+  const imageFilesData = [];
+  if (fileIds.length > 0) {
+    const [filesData] = await fileManager.files.listFiles({
+      ids: fileIds
+    });
+    imageFilesData.push(...filesData);
+  }
+
+  // Extract the template data in a json file and upload it to S3
+  const templateData = {
+    template: {
+      title: template.title,
+      slug: template.slug,
+      tags: template.tags,
+      description: template.description,
+      content: template.content,
+      layout: template.layout
+    },
+    files: imageFilesData
+  };
+  const templateDataBuffer = Buffer.from(JSON.stringify(templateData));
+  const zipper = new _zipper.default({
+    exportInfo: {
+      files: imageFilesData,
+      name: template.title,
+      dataBuffer: templateDataBuffer
+    },
+    archiveFileKey: exportTemplatesDataKey
+  });
+  return zipper.process();
+}
+function extractFilesFromData(data, files = []) {
+  // Base case: termination
+  if (!data || typeof data !== "object") {
+    return files;
+  }
+  // Recursively call function for each element
+  if (Array.isArray(data)) {
+    for (let i = 0; i < data.length; i++) {
+      const element = data[i];
+      extractFilesFromData(element, files);
+    }
+    return files;
+  }
+
+  // Main
+  const tuple = Object.entries(data);
+  for (let i = 0; i < tuple.length; i++) {
+    const [key, value] = tuple[i];
+    // TODO: @ashutosh extract it to plugins, so that, we can handle cases for other components too.
+    if (key === "file" && value) {
+      files.push(value);
+    } else if (key === "images" && Array.isArray(value)) {
+      // Handle case for "images-list" component
+      files.push(...value);
+    } else {
+      extractFilesFromData(value, files);
+    }
+  }
+  return files;
+}