@webiny/api-headless-cms-tasks 5.40.0-beta.3

package/tasks/entries/useCases/EmptyTrashBins/EmptyTrashBins.js

@@ -0,0 +1,60 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.EmptyTrashBins = void 0;
+var _types = require("../../../../types");
+class EmptyTrashBins {
+  async execute(params) {
+    const {
+      response,
+      isAborted,
+      context
+    } = params;
+    try {
+      if (isAborted()) {
+        return response.aborted();
+      }
+      const locales = context.i18n.getLocales();
+      await context.i18n.withEachLocale(locales, async () => {
+        const models = await context.security.withoutAuthorization(async () => {
+          return (await context.cms.listModels()).filter(model => !model.isPrivate);
+        });
+        for (const model of models) {
+          await context.tasks.trigger({
+            name: `Headless CMS - Empty trash bin for "${model.name}" model.`,
+            definition: _types.EntriesTask.EmptyTrashBinByModel,
+            parent: params.store.getTask(),
+            input: {
+              modelId: model.modelId,
+              where: {
+                deletedOn_lt: this.calculateDateTimeString()
+              }
+            }
+          });
+        }
+        return;
+      });
+      return response.done(`Task done: emptying the trash bin for all registered models.`);
+    } catch (ex) {
+      return response.error(ex.message ?? "Error while executing EmptyTrashBins");
+    }
+  }
+  calculateDateTimeString() {
+    // Retrieve the retention period from the environment variable WEBINY_TRASH_BIN_RETENTION_PERIOD_DAYS,
+    // or default to 90 days if not set or set to 0.
+    const retentionPeriodFromEnv = process.env["WEBINY_TRASH_BIN_RETENTION_PERIOD_DAYS"];
+    const retentionPeriod = retentionPeriodFromEnv && Number(retentionPeriodFromEnv) !== 0 ? Number(retentionPeriodFromEnv) : 90;
+
+    // Calculate the date-time by subtracting the retention period (in days) from the current date.
+    const currentDate = new Date();
+    currentDate.setDate(currentDate.getDate() - retentionPeriod);
+
+    // Return the calculated date-time string in ISO 8601 format.
+    return currentDate.toISOString();
+  }
+}
+exports.EmptyTrashBins = EmptyTrashBins;
+
+//# sourceMappingURL=EmptyTrashBins.js.map

package/tasks/entries/useCases/EmptyTrashBins/EmptyTrashBins.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_types","require","EmptyTrashBins","execute","params","response","isAborted","context","aborted","locales","i18n","getLocales","withEachLocale","models","security","withoutAuthorization","cms","listModels","filter","model","isPrivate","tasks","trigger","name","definition","EntriesTask","EmptyTrashBinByModel","parent","store","getTask","input","modelId","where","deletedOn_lt","calculateDateTimeString","done","ex","error","message","retentionPeriodFromEnv","process","env","retentionPeriod","Number","currentDate","Date","setDate","getDate","toISOString","exports"],"sources":["EmptyTrashBins.ts"],"sourcesContent":["import { ITaskResponseResult } from \"@webiny/tasks\";\nimport { EntriesTask, IEmptyTrashBinByModelInput, IEmptyTrashBins } from \"~/types\";\nimport { IUseCase } from \"~/tasks/IUseCase\";\n\nexport class EmptyTrashBins implements IUseCase<IEmptyTrashBins, ITaskResponseResult> {\n    public async execute(params: IEmptyTrashBins) {\n        const { response, isAborted, context } = params;\n\n        try {\n            if (isAborted()) {\n                return response.aborted();\n            }\n\n            const locales = context.i18n.getLocales();\n\n            await context.i18n.withEachLocale(locales, async () => {\n                const models = await context.security.withoutAuthorization(async () => {\n                    return (await context.cms.listModels()).filter(model => !model.isPrivate);\n                });\n\n                for (const model of models) {\n                    await context.tasks.trigger<IEmptyTrashBinByModelInput>({\n                        name: `Headless CMS - Empty trash bin for \"${model.name}\" model.`,\n                        definition: EntriesTask.EmptyTrashBinByModel,\n                        parent: params.store.getTask(),\n                        input: {\n                            modelId: model.modelId,\n                            where: {\n                                deletedOn_lt: this.calculateDateTimeString()\n                            }\n                        }\n                    });\n                }\n                return;\n            });\n\n            return response.done(`Task done: emptying the trash bin for all registered models.`);\n        } catch (ex) {\n            return response.error(ex.message ?? \"Error while executing EmptyTrashBins\");\n        }\n    }\n\n    private calculateDateTimeString() {\n        // Retrieve the retention period from the environment variable WEBINY_TRASH_BIN_RETENTION_PERIOD_DAYS,\n        // or default to 90 days if not set or set to 0.\n        const retentionPeriodFromEnv = process.env[\"WEBINY_TRASH_BIN_RETENTION_PERIOD_DAYS\"];\n        const retentionPeriod =\n            retentionPeriodFromEnv && Number(retentionPeriodFromEnv) !== 0\n                ? Number(retentionPeriodFromEnv)\n                : 90;\n\n        // Calculate the date-time by subtracting the retention period (in days) from the current date.\n        const currentDate = new Date();\n        currentDate.setDate(currentDate.getDate() - retentionPeriod);\n\n        // Return the calculated date-time string in ISO 8601 format.\n        return currentDate.toISOString();\n    }\n}\n"],"mappings":";;;;;;AACA,IAAAA,MAAA,GAAAC,OAAA;AAGO,MAAMC,cAAc,CAA2D;EAClF,MAAaC,OAAOA,CAACC,MAAuB,EAAE;IAC1C,MAAM;MAAEC,QAAQ;MAAEC,SAAS;MAAEC;IAAQ,CAAC,GAAGH,MAAM;IAE/C,IAAI;MACA,IAAIE,SAAS,CAAC,CAAC,EAAE;QACb,OAAOD,QAAQ,CAACG,OAAO,CAAC,CAAC;MAC7B;MAEA,MAAMC,OAAO,GAAGF,OAAO,CAACG,IAAI,CAACC,UAAU,CAAC,CAAC;MAEzC,MAAMJ,OAAO,CAACG,IAAI,CAACE,cAAc,CAACH,OAAO,EAAE,YAAY;QACnD,MAAMI,MAAM,GAAG,MAAMN,OAAO,CAACO,QAAQ,CAACC,oBAAoB,CAAC,YAAY;UACnE,OAAO,CAAC,MAAMR,OAAO,CAACS,GAAG,CAACC,UAAU,CAAC,CAAC,EAAEC,MAAM,CAACC,KAAK,IAAI,CAACA,KAAK,CAACC,SAAS,CAAC;QAC7E,CAAC,CAAC;QAEF,KAAK,MAAMD,KAAK,IAAIN,MAAM,EAAE;UACxB,MAAMN,OAAO,CAACc,KAAK,CAACC,OAAO,CAA6B;YACpDC,IAAI,EAAG,uCAAsCJ,KAAK,CAACI,IAAK,UAAS;YACjEC,UAAU,EAAEC,kBAAW,CAACC,oBAAoB;YAC5CC,MAAM,EAAEvB,MAAM,CAACwB,KAAK,CAACC,OAAO,CAAC,CAAC;YAC9BC,KAAK,EAAE;cACHC,OAAO,EAAEZ,KAAK,CAACY,OAAO;cACtBC,KAAK,EAAE;gBACHC,YAAY,EAAE,IAAI,CAACC,uBAAuB,CAAC;cAC/C;YACJ;UACJ,CAAC,CAAC;QACN;QACA;MACJ,CAAC,CAAC;MAEF,OAAO7B,QAAQ,CAAC8B,IAAI,CAAE,8DAA6D,CAAC;IACxF,CAAC,CAAC,OAAOC,EAAE,EAAE;MACT,OAAO/B,QAAQ,CAACgC,KAAK,CAACD,EAAE,CAACE,OAAO,IAAI,sCAAsC,CAAC;IAC/E;EACJ;EAEQJ,uBAAuBA,CAAA,EAAG;IAC9B;IACA;IACA,MAAMK,sBAAsB,GAAGC,OAAO,CAACC,GAAG,CAAC,wCAAwC,CAAC;IACpF,MAAMC,eAAe,GACjBH,sBAAsB,IAAII,MAAM,CAACJ,sBAAsB,CAAC,KAAK,CAAC,GACxDI,MAAM,CAACJ,sBAAsB,CAAC,GAC9B,EAAE;;IAEZ;IACA,MAAMK,WAAW,GAAG,IAAIC,IAAI,CAAC,CAAC;IAC9BD,WAAW,CAACE,OAAO,CAACF,WAAW,CAACG,OAAO,CAAC,CAAC,GAAGL,eAAe,CAAC;;IAE5D;IACA,OAAOE,WAAW,CAACI,WAAW,CAAC,CAAC;EACpC;AACJ;AAACC,OAAA,CAAA/C,cAAA,GAAAA,cAAA","ignoreList":[]}

package/tasks/entries/useCases/EmptyTrashBins/index.d.ts

@@ -0,0 +1 @@
+export * from "./EmptyTrashBins";

package/tasks/entries/useCases/EmptyTrashBins/index.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _EmptyTrashBins = require("./EmptyTrashBins");
+Object.keys(_EmptyTrashBins).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _EmptyTrashBins[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _EmptyTrashBins[key];
+    }
+  });
+});
+
+//# sourceMappingURL=index.js.map

package/tasks/entries/useCases/EmptyTrashBins/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_EmptyTrashBins","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get"],"sources":["index.ts"],"sourcesContent":["export * from \"./EmptyTrashBins\";\n"],"mappings":";;;;;AAAA,IAAAA,eAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,eAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,eAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,eAAA,CAAAK,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}

package/tasks/entries/useCases/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./DeleteTrashBinEntries";
+export * from "./EmptyTrashBinByModel";
+export * from "./EmptyTrashBins";

package/tasks/entries/useCases/index.js

@@ -0,0 +1,40 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _DeleteTrashBinEntries = require("./DeleteTrashBinEntries");
+Object.keys(_DeleteTrashBinEntries).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _DeleteTrashBinEntries[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _DeleteTrashBinEntries[key];
+    }
+  });
+});
+var _EmptyTrashBinByModel = require("./EmptyTrashBinByModel");
+Object.keys(_EmptyTrashBinByModel).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _EmptyTrashBinByModel[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _EmptyTrashBinByModel[key];
+    }
+  });
+});
+var _EmptyTrashBins = require("./EmptyTrashBins");
+Object.keys(_EmptyTrashBins).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _EmptyTrashBins[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _EmptyTrashBins[key];
+    }
+  });
+});
+
+//# sourceMappingURL=index.js.map

package/tasks/entries/useCases/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_DeleteTrashBinEntries","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get","_EmptyTrashBinByModel","_EmptyTrashBins"],"sources":["index.ts"],"sourcesContent":["export * from \"./DeleteTrashBinEntries\";\nexport * from \"./EmptyTrashBinByModel\";\nexport * from \"./EmptyTrashBins\";\n"],"mappings":";;;;;AAAA,IAAAA,sBAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,sBAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,sBAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,sBAAA,CAAAK,GAAA;IAAA;EAAA;AAAA;AACA,IAAAK,qBAAA,GAAAT,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAO,qBAAA,EAAAN,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAK,qBAAA,CAAAL,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAC,qBAAA,CAAAL,GAAA;IAAA;EAAA;AAAA;AACA,IAAAM,eAAA,GAAAV,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAQ,eAAA,EAAAP,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAM,eAAA,CAAAN,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAE,eAAA,CAAAN,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}

package/tasks/index.d.ts

@@ -0,0 +1 @@
+export declare const createTasks: () => (import("@webiny/tasks").TaskDefinitionPlugin<import("../types").HcmsTasksContext, import("../types").IDeleteTrashBinEntriesInput, import("../types").IDeleteTrashBinEntriesOutput> | import("@webiny/tasks").TaskDefinitionPlugin<import("../types").HcmsTasksContext, import("../types").IEmptyTrashBinByModelInput, import("../types").IEmptyTrashBinByModelOutput> | import("@webiny/tasks").TaskDefinitionPlugin<import("../types").HcmsTasksContext, any, import("@webiny/tasks").ITaskResponseDoneResultOutput>)[][];

package/tasks/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createTasks = void 0;
+var _entries = require("./entries");
+const createTasks = () => {
+  return [(0, _entries.createEntriesTasks)()];
+};
+exports.createTasks = createTasks;
+
+//# sourceMappingURL=index.js.map

package/tasks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_entries","require","createTasks","createEntriesTasks","exports"],"sources":["index.ts"],"sourcesContent":["import { createEntriesTasks } from \"./entries\";\n\nexport const createTasks = () => {\n    return [createEntriesTasks()];\n};\n"],"mappings":";;;;;;AAAA,IAAAA,QAAA,GAAAC,OAAA;AAEO,MAAMC,WAAW,GAAGA,CAAA,KAAM;EAC7B,OAAO,CAAC,IAAAC,2BAAkB,EAAC,CAAC,CAAC;AACjC,CAAC;AAACC,OAAA,CAAAF,WAAA,GAAAA,WAAA","ignoreList":[]}

package/types.d.ts

@@ -0,0 +1,44 @@
+import { CmsContext } from "@webiny/api-headless-cms/types";
+import { Context as BaseContext } from "@webiny/handler/types";
+import { Context as TasksContext, ITaskResponseDoneResultOutput, ITaskRunParams } from "@webiny/tasks/types";
+export interface HcmsTasksContext extends BaseContext, CmsContext, TasksContext {
+}
+export declare enum EntriesTask {
+    EmptyTrashBins = "hcmsEntriesEmptyTrashBins",
+    EmptyTrashBinByModel = "hcmsEntriesEmptyTrashBinByModel",
+    DeleteTrashBinEntries = "hcmsEntriesDeleteTrashBinEntries"
+}
+/**
+ * Empty Trash Bins
+ */
+export declare type IEmptyTrashBins = ITaskRunParams<HcmsTasksContext>;
+/**
+ * Empty Trash Bin by Model
+ */
+export interface IEmptyTrashBinByModelInput {
+    modelId: string;
+    where?: Record<string, any>;
+    after?: string | null;
+    currentBatch?: number;
+    processing?: boolean;
+    totalCount?: number;
+}
+export interface IEmptyTrashBinByModelOutput extends ITaskResponseDoneResultOutput {
+    done: string[];
+    failed: string[];
+}
+export declare type IEmptyTrashBinByModelTaskParams = ITaskRunParams<HcmsTasksContext, IEmptyTrashBinByModelInput, IEmptyTrashBinByModelOutput>;
+/**
+ * Delete Trash Bin Entries
+ */
+export interface IDeleteTrashBinEntriesInput {
+    modelId: string;
+    entryIds: string[];
+    done?: string[];
+    failed?: string[];
+}
+export interface IDeleteTrashBinEntriesOutput extends ITaskResponseDoneResultOutput {
+    done: string[];
+    failed: string[];
+}
+export declare type IDeleteTrashBinEntriesTaskParams = ITaskRunParams<HcmsTasksContext, IDeleteTrashBinEntriesInput, IDeleteTrashBinEntriesOutput>;

package/types.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.EntriesTask = void 0;
+let EntriesTask = exports.EntriesTask = /*#__PURE__*/function (EntriesTask) {
+  EntriesTask["EmptyTrashBins"] = "hcmsEntriesEmptyTrashBins";
+  EntriesTask["EmptyTrashBinByModel"] = "hcmsEntriesEmptyTrashBinByModel";
+  EntriesTask["DeleteTrashBinEntries"] = "hcmsEntriesDeleteTrashBinEntries";
+  return EntriesTask;
+}({});
+/**
+ * Empty Trash Bins
+ */
+/**
+ * Empty Trash Bin by Model
+ */
+/**
+ * Delete Trash Bin Entries
+ */
+
+//# sourceMappingURL=types.js.map

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["EntriesTask","exports"],"sources":["types.ts"],"sourcesContent":["import { CmsContext } from \"@webiny/api-headless-cms/types\";\nimport { Context as BaseContext } from \"@webiny/handler/types\";\nimport {\n    Context as TasksContext,\n    ITaskResponseDoneResultOutput,\n    ITaskRunParams\n} from \"@webiny/tasks/types\";\n\nexport interface HcmsTasksContext extends BaseContext, CmsContext, TasksContext {}\n\nexport enum EntriesTask {\n    EmptyTrashBins = \"hcmsEntriesEmptyTrashBins\",\n    EmptyTrashBinByModel = \"hcmsEntriesEmptyTrashBinByModel\",\n    DeleteTrashBinEntries = \"hcmsEntriesDeleteTrashBinEntries\"\n}\n\n/**\n * Empty Trash Bins\n */\n\nexport type IEmptyTrashBins = ITaskRunParams<HcmsTasksContext>;\n\n/**\n * Empty Trash Bin by Model\n */\n\nexport interface IEmptyTrashBinByModelInput {\n    modelId: string;\n    where?: Record<string, any>;\n    after?: string | null;\n    currentBatch?: number;\n    processing?: boolean;\n    totalCount?: number;\n}\n\nexport interface IEmptyTrashBinByModelOutput extends ITaskResponseDoneResultOutput {\n    done: string[];\n    failed: string[];\n}\n\nexport type IEmptyTrashBinByModelTaskParams = ITaskRunParams<\n    HcmsTasksContext,\n    IEmptyTrashBinByModelInput,\n    IEmptyTrashBinByModelOutput\n>;\n\n/**\n * Delete Trash Bin Entries\n */\n\nexport interface IDeleteTrashBinEntriesInput {\n    modelId: string;\n    entryIds: string[];\n    done?: string[];\n    failed?: string[];\n}\n\nexport interface IDeleteTrashBinEntriesOutput extends ITaskResponseDoneResultOutput {\n    done: string[];\n    failed: string[];\n}\n\nexport type IDeleteTrashBinEntriesTaskParams = ITaskRunParams<\n    HcmsTasksContext,\n    IDeleteTrashBinEntriesInput,\n    IDeleteTrashBinEntriesOutput\n>;\n"],"mappings":";;;;;;IAUYA,WAAW,GAAAC,OAAA,CAAAD,WAAA,0BAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAA,OAAXA,WAAW;AAAA;AAMvB;AACA;AACA;AAIA;AACA;AACA;AAsBA;AACA;AACA","ignoreList":[]}