@webiny/api-apw 0.0.0-ee-vpcs.549378cf03

package/scheduler/handlers/scheduleAction/scheduleAction.utils.js

@@ -0,0 +1,172 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.restoreDateTime = exports.executeTask = void 0;
+exports.scheduleLambdaExecution = scheduleLambdaExecution;
+exports.shouldScheduleTask = void 0;
+
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
+
+var _utils = require("../utils");
+
+var _index = require("./index");
+
+var _clientCloudwatchEvents = require("@aws-sdk/client-cloudwatch-events");
+
+const log = console.log;
+
+/**
+ * Current API limit/quota for Cloudwatch events is sufficient for now. But, we should watch for it;
+ * in case of scheduling becoming the most frequently used feature.
+ * https://aws.amazon.com/about-aws/whats-new/2017/07/cloudwatch-events-increases-rules-and-api-requests-limits/
+ */
+async function scheduleLambdaExecution({
+  cloudWatchEventClient,
+  invokedFunctionArn,
+  datetime,
+  futureDatetime,
+  tenant,
+  locale
+}) {
+  const {
+    eventTargetId,
+    eventRuleName
+  } = await (0, _utils.getApwSettings)();
+  /**
+   * Remove the target
+   */
+
+  const removeTargetsCommand = new _clientCloudwatchEvents.RemoveTargetsCommand({
+    Rule: eventRuleName,
+    Ids: [eventTargetId]
+  });
+  const removeTargetsResponse = await cloudWatchEventClient.send(removeTargetsCommand);
+  /**
+   * Log error.
+   */
+
+  if (typeof removeTargetsResponse.FailedEntryCount === "number" && removeTargetsResponse.FailedEntryCount !== 0) {
+    console.info("Failed in removing the targets!");
+    console.info(removeTargetsResponse.FailedEntries);
+  }
+  /**
+   * Delete the Rule
+   */
+
+
+  const deleteRuleCommand = new _clientCloudwatchEvents.DeleteRuleCommand({
+    Name: eventRuleName
+  });
+  await cloudWatchEventClient.send(deleteRuleCommand);
+  /**
+   * Create a new one.
+   * Min  H   D   M   DW  Y
+   * 20   10  10  03  *   2022
+   */
+
+  const cronExpression = (0, _utils.dateTimeToCronExpression)(datetime);
+  const ruleParams = {
+    Name: eventRuleName,
+    ScheduleExpression: `cron(${cronExpression})`,
+    State: "ENABLED",
+    Description: `Enable us to schedule an action in publishing workflow at a particular datetime`
+  };
+  await cloudWatchEventClient.send(new _clientCloudwatchEvents.PutRuleCommand(ruleParams));
+  /**
+   * Add lambda as target for the rule.
+   */
+
+  await cloudWatchEventClient.send(new _clientCloudwatchEvents.PutTargetsCommand({
+    Rule: eventRuleName,
+    Targets: [{
+      Arn: invokedFunctionArn,
+      Id: eventTargetId,
+      Input: JSON.stringify({
+        datetime: datetime,
+        tenant: tenant,
+        locale: locale,
+        invocationType: _index.InvocationTypes.SCHEDULED,
+        futureDatetime: futureDatetime
+      })
+    }]
+  }));
+}
+
+const shouldScheduleTask = (nextTaskDatetime, currentTaskDatetime) => {
+  return !currentTaskDatetime || nextTaskDatetime < currentTaskDatetime;
+};
+
+exports.shouldScheduleTask = shouldScheduleTask;
+
+const restoreDateTime = async ({
+  locale,
+  tenant,
+  task: currentTask,
+  storageOperations
+}) => {
+  log(`Mark task "${currentTask.id}" as undone by restoring original "datetime".`);
+  const item = await storageOperations.get({
+    where: {
+      tenant,
+      locale,
+      id: currentTask.id
+    }
+  });
+
+  if (item) {
+    const newDateTime = (0, _utils.moveDateTimeToCurrentCentury)(item.data.datetime);
+    await storageOperations.update({
+      item: (0, _objectSpread2.default)((0, _objectSpread2.default)({}, item), {}, {
+        data: (0, _objectSpread2.default)((0, _objectSpread2.default)({}, item.data), {}, {
+          datetime: newDateTime
+        })
+      }),
+      input: (0, _objectSpread2.default)((0, _objectSpread2.default)({}, item.data), {}, {
+        datetime: newDateTime
+      })
+    });
+  }
+};
+
+exports.restoreDateTime = restoreDateTime;
+
+const executeTask = async ({
+  args,
+  lambdaName,
+  handlerClient,
+  storageOperations
+}) => {
+  log(`Executing task at: `, new Date().toISOString());
+
+  if (typeof handlerClient.invoke === "function") {
+    await handlerClient.invoke({
+      name: lambdaName,
+      payload: {
+        futureDatetime: args.futureDatetime,
+        datetime: args.datetime,
+        tenant: args.tenant,
+        locale: args.locale
+      },
+      await: false
+    });
+  }
+  /**
+   * Delete current schedule Task. So that, we can schedule a new one later.
+   */
+
+
+  try {
+    await storageOperations.deleteCurrentTask({
+      tenant: args.tenant,
+      locale: args.locale
+    });
+  } catch (e) {
+    console.error(e);
+  }
+};
+
+exports.executeTask = executeTask;

package/scheduler/handlers/scheduleAction/scheduleAction.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["log","console","scheduleLambdaExecution","cloudWatchEventClient","invokedFunctionArn","datetime","futureDatetime","tenant","locale","eventTargetId","eventRuleName","getApwSettings","removeTargetsCommand","RemoveTargetsCommand","Rule","Ids","removeTargetsResponse","send","FailedEntryCount","info","FailedEntries","deleteRuleCommand","DeleteRuleCommand","Name","cronExpression","dateTimeToCronExpression","ruleParams","ScheduleExpression","State","Description","PutRuleCommand","PutTargetsCommand","Targets","Arn","Id","Input","JSON","stringify","invocationType","InvocationTypes","SCHEDULED","shouldScheduleTask","nextTaskDatetime","currentTaskDatetime","restoreDateTime","task","currentTask","storageOperations","id","item","get","where","newDateTime","moveDateTimeToCurrentCentury","data","update","input","executeTask","args","lambdaName","handlerClient","Date","toISOString","invoke","name","payload","await","deleteCurrentTask","e","error"],"sources":["scheduleAction.utils.ts"],"sourcesContent":["import { dateTimeToCronExpression, moveDateTimeToCurrentCentury } from \"~/scheduler/handlers/utils\";\nimport { ApwScheduleAction } from \"~/scheduler/types\";\nimport {\n    HandlerArgs,\n    InvocationTypes,\n    Configuration\n} from \"~/scheduler/handlers/scheduleAction/index\";\nimport {\n    DeleteRuleCommand,\n    RemoveTargetsCommand,\n    PutTargetsCommand,\n    PutRuleCommand\n} from \"@aws-sdk/client-cloudwatch-events\";\nimport { ClientContext } from \"@webiny/handler-client/types\";\nimport { getApwSettings } from \"~/scheduler/handlers/utils\";\n\nconst log = console.log;\n\ninterface ScheduleLambdaExecutionParams extends Omit<HandlerArgs, \"invocationType\"> {\n    cloudWatchEventClient: any;\n    invokedFunctionArn: string;\n}\n\n/**\n * Current API limit/quota for Cloudwatch events is sufficient for now. But, we should watch for it;\n * in case of scheduling becoming the most frequently used feature.\n * https://aws.amazon.com/about-aws/whats-new/2017/07/cloudwatch-events-increases-rules-and-api-requests-limits/\n */\nexport async function scheduleLambdaExecution({\n    cloudWatchEventClient,\n    invokedFunctionArn,\n    datetime,\n    futureDatetime,\n    tenant,\n    locale\n}: ScheduleLambdaExecutionParams) {\n    const { eventTargetId, eventRuleName } = await getApwSettings();\n    /**\n     * Remove the target\n     */\n    const removeTargetsCommand = new RemoveTargetsCommand({\n        Rule: eventRuleName,\n        Ids: [eventTargetId]\n    });\n    const removeTargetsResponse = await cloudWatchEventClient.send(removeTargetsCommand);\n    /**\n     * Log error.\n     */\n    if (\n        typeof removeTargetsResponse.FailedEntryCount === \"number\" &&\n        removeTargetsResponse.FailedEntryCount !== 0\n    ) {\n        console.info(\"Failed in removing the targets!\");\n        console.info(removeTargetsResponse.FailedEntries);\n    }\n    /**\n     * Delete the Rule\n     */\n    const deleteRuleCommand = new DeleteRuleCommand({\n        Name: eventRuleName\n    });\n    await cloudWatchEventClient.send(deleteRuleCommand);\n\n    /**\n     * Create a new one.\n     * Min  H   D   M   DW  Y\n     * 20   10  10  03  *   2022\n     */\n    const cronExpression = dateTimeToCronExpression(datetime);\n\n    const ruleParams = {\n        Name: eventRuleName,\n        ScheduleExpression: `cron(${cronExpression})`,\n        State: \"ENABLED\",\n        Description: `Enable us to schedule an action in publishing workflow at a particular datetime`\n    };\n\n    await cloudWatchEventClient.send(new PutRuleCommand(ruleParams));\n    /**\n     * Add lambda as target for the rule.\n     */\n    await cloudWatchEventClient.send(\n        new PutTargetsCommand({\n            Rule: eventRuleName,\n            Targets: [\n                {\n                    Arn: invokedFunctionArn,\n                    Id: eventTargetId,\n                    Input: JSON.stringify({\n                        datetime: datetime,\n                        tenant: tenant,\n                        locale: locale,\n                        invocationType: InvocationTypes.SCHEDULED,\n                        futureDatetime: futureDatetime\n                    } as HandlerArgs)\n                }\n            ]\n        })\n    );\n}\n\nexport const shouldScheduleTask = (\n    nextTaskDatetime: string,\n    currentTaskDatetime: string | null\n): boolean => {\n    return !currentTaskDatetime || nextTaskDatetime < currentTaskDatetime;\n};\n\ninterface RestoreDateTimeParams\n    extends Pick<Configuration, \"storageOperations\">,\n        Pick<HandlerArgs, \"tenant\" | \"locale\"> {\n    task: ApwScheduleAction;\n}\n\nexport const restoreDateTime = async ({\n    locale,\n    tenant,\n    task: currentTask,\n    storageOperations\n}: RestoreDateTimeParams): Promise<void> => {\n    log(`Mark task \"${currentTask.id}\" as undone by restoring original \"datetime\".`);\n    const item = await storageOperations.get({\n        where: {\n            tenant,\n            locale,\n            id: currentTask.id\n        }\n    });\n    if (item) {\n        const newDateTime = moveDateTimeToCurrentCentury(item.data.datetime);\n        await storageOperations.update({\n            item: {\n                ...item,\n                data: { ...item.data, datetime: newDateTime }\n            },\n            input: { ...item.data, datetime: newDateTime }\n        });\n    }\n};\n\ninterface ExecuteTaskParams\n    extends Pick<ClientContext, \"handlerClient\">,\n        Pick<Configuration, \"storageOperations\"> {\n    args: HandlerArgs;\n    lambdaName: string;\n}\n\nexport const executeTask = async ({\n    args,\n    lambdaName,\n    handlerClient,\n    storageOperations\n}: ExecuteTaskParams): Promise<void> => {\n    log(`Executing task at: `, new Date().toISOString());\n\n    if (typeof handlerClient.invoke === \"function\") {\n        await handlerClient.invoke({\n            name: lambdaName,\n            payload: {\n                futureDatetime: args.futureDatetime,\n                datetime: args.datetime,\n                tenant: args.tenant,\n                locale: args.locale\n            },\n            await: false\n        });\n    }\n\n    /**\n     * Delete current schedule Task. So that, we can schedule a new one later.\n     */\n    try {\n        await storageOperations.deleteCurrentTask({\n            tenant: args.tenant,\n            locale: args.locale\n        });\n    } catch (e) {\n        console.error(e);\n    }\n};\n"],"mappings":";;;;;;;;;;;;;AAAA;;AAEA;;AAKA;;AASA,MAAMA,GAAG,GAAGC,OAAO,CAACD,GAApB;;AAOA;AACA;AACA;AACA;AACA;AACO,eAAeE,uBAAf,CAAuC;EAC1CC,qBAD0C;EAE1CC,kBAF0C;EAG1CC,QAH0C;EAI1CC,cAJ0C;EAK1CC,MAL0C;EAM1CC;AAN0C,CAAvC,EAO2B;EAC9B,MAAM;IAAEC,aAAF;IAAiBC;EAAjB,IAAmC,MAAM,IAAAC,qBAAA,GAA/C;EACA;AACJ;AACA;;EACI,MAAMC,oBAAoB,GAAG,IAAIC,4CAAJ,CAAyB;IAClDC,IAAI,EAAEJ,aAD4C;IAElDK,GAAG,EAAE,CAACN,aAAD;EAF6C,CAAzB,CAA7B;EAIA,MAAMO,qBAAqB,GAAG,MAAMb,qBAAqB,CAACc,IAAtB,CAA2BL,oBAA3B,CAApC;EACA;AACJ;AACA;;EACI,IACI,OAAOI,qBAAqB,CAACE,gBAA7B,KAAkD,QAAlD,IACAF,qBAAqB,CAACE,gBAAtB,KAA2C,CAF/C,EAGE;IACEjB,OAAO,CAACkB,IAAR,CAAa,iCAAb;IACAlB,OAAO,CAACkB,IAAR,CAAaH,qBAAqB,CAACI,aAAnC;EACH;EACD;AACJ;AACA;;;EACI,MAAMC,iBAAiB,GAAG,IAAIC,yCAAJ,CAAsB;IAC5CC,IAAI,EAAEb;EADsC,CAAtB,CAA1B;EAGA,MAAMP,qBAAqB,CAACc,IAAtB,CAA2BI,iBAA3B,CAAN;EAEA;AACJ;AACA;AACA;AACA;;EACI,MAAMG,cAAc,GAAG,IAAAC,+BAAA,EAAyBpB,QAAzB,CAAvB;EAEA,MAAMqB,UAAU,GAAG;IACfH,IAAI,EAAEb,aADS;IAEfiB,kBAAkB,EAAG,QAAOH,cAAe,GAF5B;IAGfI,KAAK,EAAE,SAHQ;IAIfC,WAAW,EAAG;EAJC,CAAnB;EAOA,MAAM1B,qBAAqB,CAACc,IAAtB,CAA2B,IAAIa,sCAAJ,CAAmBJ,UAAnB,CAA3B,CAAN;EACA;AACJ;AACA;;EACI,MAAMvB,qBAAqB,CAACc,IAAtB,CACF,IAAIc,yCAAJ,CAAsB;IAClBjB,IAAI,EAAEJ,aADY;IAElBsB,OAAO,EAAE,CACL;MACIC,GAAG,EAAE7B,kBADT;MAEI8B,EAAE,EAAEzB,aAFR;MAGI0B,KAAK,EAAEC,IAAI,CAACC,SAAL,CAAe;QAClBhC,QAAQ,EAAEA,QADQ;QAElBE,MAAM,EAAEA,MAFU;QAGlBC,MAAM,EAAEA,MAHU;QAIlB8B,cAAc,EAAEC,sBAAA,CAAgBC,SAJd;QAKlBlC,cAAc,EAAEA;MALE,CAAf;IAHX,CADK;EAFS,CAAtB,CADE,CAAN;AAkBH;;AAEM,MAAMmC,kBAAkB,GAAG,CAC9BC,gBAD8B,EAE9BC,mBAF8B,KAGpB;EACV,OAAO,CAACA,mBAAD,IAAwBD,gBAAgB,GAAGC,mBAAlD;AACH,CALM;;;;AAaA,MAAMC,eAAe,GAAG,OAAO;EAClCpC,MADkC;EAElCD,MAFkC;EAGlCsC,IAAI,EAAEC,WAH4B;EAIlCC;AAJkC,CAAP,KAKa;EACxC/C,GAAG,CAAE,cAAa8C,WAAW,CAACE,EAAG,+CAA9B,CAAH;EACA,MAAMC,IAAI,GAAG,MAAMF,iBAAiB,CAACG,GAAlB,CAAsB;IACrCC,KAAK,EAAE;MACH5C,MADG;MAEHC,MAFG;MAGHwC,EAAE,EAAEF,WAAW,CAACE;IAHb;EAD8B,CAAtB,CAAnB;;EAOA,IAAIC,IAAJ,EAAU;IACN,MAAMG,WAAW,GAAG,IAAAC,mCAAA,EAA6BJ,IAAI,CAACK,IAAL,CAAUjD,QAAvC,CAApB;IACA,MAAM0C,iBAAiB,CAACQ,MAAlB,CAAyB;MAC3BN,IAAI,8DACGA,IADH;QAEAK,IAAI,8DAAOL,IAAI,CAACK,IAAZ;UAAkBjD,QAAQ,EAAE+C;QAA5B;MAFJ,EADuB;MAK3BI,KAAK,8DAAOP,IAAI,CAACK,IAAZ;QAAkBjD,QAAQ,EAAE+C;MAA5B;IALsB,CAAzB,CAAN;EAOH;AACJ,CAxBM;;;;AAiCA,MAAMK,WAAW,GAAG,OAAO;EAC9BC,IAD8B;EAE9BC,UAF8B;EAG9BC,aAH8B;EAI9Bb;AAJ8B,CAAP,KAKa;EACpC/C,GAAG,CAAE,qBAAF,EAAwB,IAAI6D,IAAJ,GAAWC,WAAX,EAAxB,CAAH;;EAEA,IAAI,OAAOF,aAAa,CAACG,MAArB,KAAgC,UAApC,EAAgD;IAC5C,MAAMH,aAAa,CAACG,MAAd,CAAqB;MACvBC,IAAI,EAAEL,UADiB;MAEvBM,OAAO,EAAE;QACL3D,cAAc,EAAEoD,IAAI,CAACpD,cADhB;QAELD,QAAQ,EAAEqD,IAAI,CAACrD,QAFV;QAGLE,MAAM,EAAEmD,IAAI,CAACnD,MAHR;QAILC,MAAM,EAAEkD,IAAI,CAAClD;MAJR,CAFc;MAQvB0D,KAAK,EAAE;IARgB,CAArB,CAAN;EAUH;EAED;AACJ;AACA;;;EACI,IAAI;IACA,MAAMnB,iBAAiB,CAACoB,iBAAlB,CAAoC;MACtC5D,MAAM,EAAEmD,IAAI,CAACnD,MADyB;MAEtCC,MAAM,EAAEkD,IAAI,CAAClD;IAFyB,CAApC,CAAN;EAIH,CALD,CAKE,OAAO4D,CAAP,EAAU;IACRnE,OAAO,CAACoE,KAAR,CAAcD,CAAd;EACH;AACJ,CAhCM"}

package/scheduler/handlers/utils.d.ts

@@ -0,0 +1,33 @@
+import { DocumentClient } from "aws-sdk/clients/dynamodb";
+import { InvocationTypes } from "../types";
+export declare const getIsoStringTillMinutes: (datetime: string) => string;
+export declare const dateTimeToCronExpression: (datetime: string) => string;
+export declare const moveDateTimeToNextCentury: (datetime: string) => string;
+export declare const moveDateTimeToCurrentCentury: (datetime: string) => string;
+export declare const isDateTimeInNextCentury: (datetime: string) => boolean;
+interface ShouldRestoreDatetimeParams {
+    invocationType?: InvocationTypes;
+    datetime: string;
+}
+export declare const shouldRestoreDatetime: ({ invocationType, datetime }: ShouldRestoreDatetimeParams) => boolean;
+interface EncodeTokenParams {
+    id: string;
+    tenant: string;
+    locale: string;
+}
+export declare const encodeToken: ({ id, tenant, locale }: EncodeTokenParams) => string;
+export declare const TOKEN_PREFIX = "apw-";
+export declare const decodeToken: (token: string) => Partial<EncodeTokenParams>;
+export declare const documentClient: DocumentClient;
+export declare const basePlugins: () => (import("@webiny/handler").HandlerResultPlugin<import("@webiny/handler/types").Context> | import("@webiny/db-dynamodb/plugins/definitions/ValueFilterPlugin").ValueFilterPlugin[][] | import("@webiny/api").ContextPlugin<import("@webiny/handler-db/types").DbContext>[])[];
+/**
+ * Get APW settings record from DDB.
+ */
+export interface ApwSettings {
+    mainGraphqlFunctionArn: string;
+    cmsGraphqlFunctionArn: string;
+    eventRuleName: string;
+    eventTargetId: string;
+}
+export declare const getApwSettings: () => Promise<ApwSettings>;
+export {};

package/scheduler/handlers/utils.js

@@ -0,0 +1,168 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.shouldRestoreDatetime = exports.moveDateTimeToNextCentury = exports.moveDateTimeToCurrentCentury = exports.isDateTimeInNextCentury = exports.getIsoStringTillMinutes = exports.getApwSettings = exports.encodeToken = exports.documentClient = exports.decodeToken = exports.dateTimeToCronExpression = exports.basePlugins = exports.TOKEN_PREFIX = void 0;
+
+var _dayjs = _interopRequireDefault(require("dayjs"));
+
+var _utc = _interopRequireDefault(require("dayjs/plugin/utc"));
+
+var _dynamodb = require("aws-sdk/clients/dynamodb");
+
+var _handlerDb = _interopRequireDefault(require("@webiny/handler-db"));
+
+var _dbDynamodb = require("@webiny/db-dynamodb");
+
+var _plugins = _interopRequireDefault(require("@webiny/db-dynamodb/plugins"));
+
+var _handlerLogs = _interopRequireDefault(require("@webiny/handler-logs"));
+
+var _types = require("../types");
+
+/**
+ * https://day.js.org/docs/en/plugin/utc
+ */
+_dayjs.default.extend(_utc.default);
+
+const TIME_SEPARATOR = ":";
+const ELAPSED_CRON_EXPRESSION = "* * * * ? 2000";
+
+const getIsoStringTillMinutes = datetime => {
+  /**
+   * Validate datetime.
+   */
+  if (isNaN(Date.parse(datetime))) {
+    return datetime;
+  } // input = "2022-03-08T05:41:13.230Z"
+  // output = "2022-03-08T05:41"
+
+
+  return datetime.slice(0, datetime.lastIndexOf(TIME_SEPARATOR));
+};
+
+exports.getIsoStringTillMinutes = getIsoStringTillMinutes;
+
+const dateTimeToCronExpression = datetime => {
+  if (!datetime) {
+    return ELAPSED_CRON_EXPRESSION;
+  }
+  /**
+   * You can't specify the Day-of-month and Day-of-week fields in the same cron expression.
+   * If you specify a value (or a *) in one of the fields, you must use a ? (question mark) in the other.
+   *
+   *  https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html
+   */
+
+
+  const dayOfWeek = "?";
+  return _dayjs.default.utc(datetime).format(`mm H D M [${dayOfWeek}] YYYY`);
+};
+
+exports.dateTimeToCronExpression = dateTimeToCronExpression;
+
+const moveDateTimeToNextCentury = datetime => {
+  return _dayjs.default.utc(datetime).add(100, "year").toISOString();
+};
+
+exports.moveDateTimeToNextCentury = moveDateTimeToNextCentury;
+
+const moveDateTimeToCurrentCentury = datetime => {
+  return _dayjs.default.utc(datetime).subtract(100, "year").toISOString();
+};
+
+exports.moveDateTimeToCurrentCentury = moveDateTimeToCurrentCentury;
+
+const isDateTimeInNextCentury = datetime => {
+  return _dayjs.default.utc(datetime).isAfter("2100-01-01", "year");
+};
+
+exports.isDateTimeInNextCentury = isDateTimeInNextCentury;
+
+const shouldRestoreDatetime = ({
+  invocationType,
+  datetime
+}) => {
+  /**
+   * "invocationType" will not be SCHEDULED when the lambda is called from Main GQL handler.
+   *
+   * Which means a new content is scheduled for "publish"/"unpublish" therefore, we need to restore the previously
+   * scheduled action if it has not been executed already.
+   */
+  const selfInvoked = invocationType === _types.InvocationTypes.SCHEDULED;
+
+  const today = _dayjs.default.utc();
+
+  const isExecutionPending = _dayjs.default.utc(datetime).isAfter(today);
+
+  return !selfInvoked && isExecutionPending;
+};
+
+exports.shouldRestoreDatetime = shouldRestoreDatetime;
+
+const encodeToken = ({
+  id,
+  tenant,
+  locale
+}) => {
+  return `${TOKEN_PREFIX}${id}__${tenant}__${locale}`;
+};
+
+exports.encodeToken = encodeToken;
+const TOKEN_PREFIX = "apw-";
+exports.TOKEN_PREFIX = TOKEN_PREFIX;
+
+const decodeToken = token => {
+  const auth = token.slice(TOKEN_PREFIX.length);
+  const [id, tenant, locale] = auth.split("__");
+  return {
+    id,
+    tenant,
+    locale
+  };
+};
+
+exports.decodeToken = decodeToken;
+const documentClient = new _dynamodb.DocumentClient({
+  convertEmptyValues: true,
+  region: process.env.AWS_REGION
+});
+exports.documentClient = documentClient;
+
+const basePlugins = () => [(0, _plugins.default)(), (0, _handlerLogs.default)(), (0, _handlerDb.default)({
+  table: process.env.DB_TABLE,
+  driver: new _dbDynamodb.DynamoDbDriver({
+    documentClient
+  })
+})];
+/**
+ * Get APW settings record from DDB.
+ */
+
+
+exports.basePlugins = basePlugins;
+
+const getApwSettings = async () => {
+  const variant = process.env.STAGED_ROLLOUTS_VARIANT;
+  const params = {
+    TableName: process.env.DB_TABLE,
+    Key: {
+      PK: `APW#SETTINGS`,
+      SK: variant || "default"
+    }
+  };
+  const {
+    Item
+  } = await documentClient.get(params).promise();
+  return {
+    mainGraphqlFunctionArn: Item ? Item["mainGraphqlFunctionArn"] : "mainGraphqlFunctionArn",
+    cmsGraphqlFunctionArn: Item ? Item["cmsGraphqlFunctionArn"] : "cmsGraphqlFunctionArn",
+    eventRuleName: Item ? Item["eventRuleName"] : "eventRuleName",
+    eventTargetId: Item ? Item["eventTargetId"] : "eventTargetId"
+  };
+};
+
+exports.getApwSettings = getApwSettings;

package/scheduler/handlers/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["dayjs","extend","utc","TIME_SEPARATOR","ELAPSED_CRON_EXPRESSION","getIsoStringTillMinutes","datetime","isNaN","Date","parse","slice","lastIndexOf","dateTimeToCronExpression","dayOfWeek","format","moveDateTimeToNextCentury","add","toISOString","moveDateTimeToCurrentCentury","subtract","isDateTimeInNextCentury","isAfter","shouldRestoreDatetime","invocationType","selfInvoked","InvocationTypes","SCHEDULED","today","isExecutionPending","encodeToken","id","tenant","locale","TOKEN_PREFIX","decodeToken","token","auth","length","split","documentClient","DocumentClient","convertEmptyValues","region","process","env","AWS_REGION","basePlugins","dynamoDbPlugins","logsPlugins","dbPlugins","table","DB_TABLE","driver","DynamoDbDriver","getApwSettings","variant","STAGED_ROLLOUTS_VARIANT","params","TableName","Key","PK","SK","Item","get","promise","mainGraphqlFunctionArn","cmsGraphqlFunctionArn","eventRuleName","eventTargetId"],"sources":["utils.ts"],"sourcesContent":["import dayjs from \"dayjs\";\nimport utc from \"dayjs/plugin/utc\";\nimport { DocumentClient } from \"aws-sdk/clients/dynamodb\";\nimport dbPlugins from \"@webiny/handler-db\";\nimport { DynamoDbDriver } from \"@webiny/db-dynamodb\";\nimport dynamoDbPlugins from \"@webiny/db-dynamodb/plugins\";\nimport logsPlugins from \"@webiny/handler-logs\";\nimport { InvocationTypes } from \"~/scheduler/types\";\n\n/**\n * https://day.js.org/docs/en/plugin/utc\n */\ndayjs.extend(utc);\n\nconst TIME_SEPARATOR = \":\";\nconst ELAPSED_CRON_EXPRESSION = \"* * * * ? 2000\";\n\nexport const getIsoStringTillMinutes = (datetime: string): string => {\n    /**\n     * Validate datetime.\n     */\n    if (isNaN(Date.parse(datetime))) {\n        return datetime;\n    }\n    // input = \"2022-03-08T05:41:13.230Z\"\n    // output = \"2022-03-08T05:41\"\n    return datetime.slice(0, datetime.lastIndexOf(TIME_SEPARATOR));\n};\n\nexport const dateTimeToCronExpression = (datetime: string): string => {\n    if (!datetime) {\n        return ELAPSED_CRON_EXPRESSION;\n    }\n    /**\n     * You can't specify the Day-of-month and Day-of-week fields in the same cron expression.\n     * If you specify a value (or a *) in one of the fields, you must use a ? (question mark) in the other.\n     *\n     *  https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html\n     */\n    const dayOfWeek = \"?\";\n\n    return dayjs.utc(datetime).format(`mm H D M [${dayOfWeek}] YYYY`);\n};\n\nexport const moveDateTimeToNextCentury = (datetime: string): string => {\n    return dayjs.utc(datetime).add(100, \"year\").toISOString();\n};\n\nexport const moveDateTimeToCurrentCentury = (datetime: string): string => {\n    return dayjs.utc(datetime).subtract(100, \"year\").toISOString();\n};\n\nexport const isDateTimeInNextCentury = (datetime: string): boolean => {\n    return dayjs.utc(datetime).isAfter(\"2100-01-01\", \"year\");\n};\n\ninterface ShouldRestoreDatetimeParams {\n    invocationType?: InvocationTypes;\n    datetime: string;\n}\n\nexport const shouldRestoreDatetime = ({\n    invocationType,\n    datetime\n}: ShouldRestoreDatetimeParams): boolean => {\n    /**\n     * \"invocationType\" will not be SCHEDULED when the lambda is called from Main GQL handler.\n     *\n     * Which means a new content is scheduled for \"publish\"/\"unpublish\" therefore, we need to restore the previously\n     * scheduled action if it has not been executed already.\n     */\n    const selfInvoked = invocationType === InvocationTypes.SCHEDULED;\n\n    const today = dayjs.utc();\n    const isExecutionPending = dayjs.utc(datetime).isAfter(today);\n\n    return !selfInvoked && isExecutionPending;\n};\n\ninterface EncodeTokenParams {\n    id: string;\n    tenant: string;\n    locale: string;\n}\n\nexport const encodeToken = ({ id, tenant, locale }: EncodeTokenParams) => {\n    return `${TOKEN_PREFIX}${id}__${tenant}__${locale}`;\n};\n\nexport const TOKEN_PREFIX = \"apw-\";\n\nexport const decodeToken = (token: string): Partial<EncodeTokenParams> => {\n    const auth = token.slice(TOKEN_PREFIX.length);\n    const [id, tenant, locale] = auth.split(\"__\");\n\n    return {\n        id,\n        tenant,\n        locale\n    };\n};\n\nexport const documentClient = new DocumentClient({\n    convertEmptyValues: true,\n    region: process.env.AWS_REGION\n});\n\nexport const basePlugins = () => [\n    dynamoDbPlugins(),\n    logsPlugins(),\n    dbPlugins({\n        table: process.env.DB_TABLE,\n        driver: new DynamoDbDriver({\n            documentClient\n        })\n    })\n];\n\n/**\n * Get APW settings record from DDB.\n */\nexport interface ApwSettings {\n    mainGraphqlFunctionArn: string;\n    cmsGraphqlFunctionArn: string;\n    eventRuleName: string;\n    eventTargetId: string;\n}\n\nexport const getApwSettings = async (): Promise<ApwSettings> => {\n    const variant = process.env.STAGED_ROLLOUTS_VARIANT;\n\n    const params = {\n        TableName: process.env.DB_TABLE as string,\n        Key: {\n            PK: `APW#SETTINGS`,\n            SK: variant || \"default\"\n        }\n    };\n\n    const { Item } = await documentClient.get(params).promise();\n\n    return {\n        mainGraphqlFunctionArn: Item ? Item[\"mainGraphqlFunctionArn\"] : \"mainGraphqlFunctionArn\",\n        cmsGraphqlFunctionArn: Item ? Item[\"cmsGraphqlFunctionArn\"] : \"cmsGraphqlFunctionArn\",\n        eventRuleName: Item ? Item[\"eventRuleName\"] : \"eventRuleName\",\n        eventTargetId: Item ? Item[\"eventTargetId\"] : \"eventTargetId\"\n    };\n};\n"],"mappings":";;;;;;;;;AAAA;;AACA;;AACA;;AACA;;AACA;;AACA;;AACA;;AACA;;AAEA;AACA;AACA;AACAA,cAAA,CAAMC,MAAN,CAAaC,YAAb;;AAEA,MAAMC,cAAc,GAAG,GAAvB;AACA,MAAMC,uBAAuB,GAAG,gBAAhC;;AAEO,MAAMC,uBAAuB,GAAIC,QAAD,IAA8B;EACjE;AACJ;AACA;EACI,IAAIC,KAAK,CAACC,IAAI,CAACC,KAAL,CAAWH,QAAX,CAAD,CAAT,EAAiC;IAC7B,OAAOA,QAAP;EACH,CANgE,CAOjE;EACA;;;EACA,OAAOA,QAAQ,CAACI,KAAT,CAAe,CAAf,EAAkBJ,QAAQ,CAACK,WAAT,CAAqBR,cAArB,CAAlB,CAAP;AACH,CAVM;;;;AAYA,MAAMS,wBAAwB,GAAIN,QAAD,IAA8B;EAClE,IAAI,CAACA,QAAL,EAAe;IACX,OAAOF,uBAAP;EACH;EACD;AACJ;AACA;AACA;AACA;AACA;;;EACI,MAAMS,SAAS,GAAG,GAAlB;EAEA,OAAOb,cAAA,CAAME,GAAN,CAAUI,QAAV,EAAoBQ,MAApB,CAA4B,aAAYD,SAAU,QAAlD,CAAP;AACH,CAbM;;;;AAeA,MAAME,yBAAyB,GAAIT,QAAD,IAA8B;EACnE,OAAON,cAAA,CAAME,GAAN,CAAUI,QAAV,EAAoBU,GAApB,CAAwB,GAAxB,EAA6B,MAA7B,EAAqCC,WAArC,EAAP;AACH,CAFM;;;;AAIA,MAAMC,4BAA4B,GAAIZ,QAAD,IAA8B;EACtE,OAAON,cAAA,CAAME,GAAN,CAAUI,QAAV,EAAoBa,QAApB,CAA6B,GAA7B,EAAkC,MAAlC,EAA0CF,WAA1C,EAAP;AACH,CAFM;;;;AAIA,MAAMG,uBAAuB,GAAId,QAAD,IAA+B;EAClE,OAAON,cAAA,CAAME,GAAN,CAAUI,QAAV,EAAoBe,OAApB,CAA4B,YAA5B,EAA0C,MAA1C,CAAP;AACH,CAFM;;;;AASA,MAAMC,qBAAqB,GAAG,CAAC;EAClCC,cADkC;EAElCjB;AAFkC,CAAD,KAGO;EACxC;AACJ;AACA;AACA;AACA;AACA;EACI,MAAMkB,WAAW,GAAGD,cAAc,KAAKE,sBAAA,CAAgBC,SAAvD;;EAEA,MAAMC,KAAK,GAAG3B,cAAA,CAAME,GAAN,EAAd;;EACA,MAAM0B,kBAAkB,GAAG5B,cAAA,CAAME,GAAN,CAAUI,QAAV,EAAoBe,OAApB,CAA4BM,KAA5B,CAA3B;;EAEA,OAAO,CAACH,WAAD,IAAgBI,kBAAvB;AACH,CAhBM;;;;AAwBA,MAAMC,WAAW,GAAG,CAAC;EAAEC,EAAF;EAAMC,MAAN;EAAcC;AAAd,CAAD,KAA+C;EACtE,OAAQ,GAAEC,YAAa,GAAEH,EAAG,KAAIC,MAAO,KAAIC,MAAO,EAAlD;AACH,CAFM;;;AAIA,MAAMC,YAAY,GAAG,MAArB;;;AAEA,MAAMC,WAAW,GAAIC,KAAD,IAA+C;EACtE,MAAMC,IAAI,GAAGD,KAAK,CAACzB,KAAN,CAAYuB,YAAY,CAACI,MAAzB,CAAb;EACA,MAAM,CAACP,EAAD,EAAKC,MAAL,EAAaC,MAAb,IAAuBI,IAAI,CAACE,KAAL,CAAW,IAAX,CAA7B;EAEA,OAAO;IACHR,EADG;IAEHC,MAFG;IAGHC;EAHG,CAAP;AAKH,CATM;;;AAWA,MAAMO,cAAc,GAAG,IAAIC,wBAAJ,CAAmB;EAC7CC,kBAAkB,EAAE,IADyB;EAE7CC,MAAM,EAAEC,OAAO,CAACC,GAAR,CAAYC;AAFyB,CAAnB,CAAvB;;;AAKA,MAAMC,WAAW,GAAG,MAAM,CAC7B,IAAAC,gBAAA,GAD6B,EAE7B,IAAAC,oBAAA,GAF6B,EAG7B,IAAAC,kBAAA,EAAU;EACNC,KAAK,EAAEP,OAAO,CAACC,GAAR,CAAYO,QADb;EAENC,MAAM,EAAE,IAAIC,0BAAJ,CAAmB;IACvBd;EADuB,CAAnB;AAFF,CAAV,CAH6B,CAA1B;AAWP;AACA;AACA;;;;;AAQO,MAAMe,cAAc,GAAG,YAAkC;EAC5D,MAAMC,OAAO,GAAGZ,OAAO,CAACC,GAAR,CAAYY,uBAA5B;EAEA,MAAMC,MAAM,GAAG;IACXC,SAAS,EAAEf,OAAO,CAACC,GAAR,CAAYO,QADZ;IAEXQ,GAAG,EAAE;MACDC,EAAE,EAAG,cADJ;MAEDC,EAAE,EAAEN,OAAO,IAAI;IAFd;EAFM,CAAf;EAQA,MAAM;IAAEO;EAAF,IAAW,MAAMvB,cAAc,CAACwB,GAAf,CAAmBN,MAAnB,EAA2BO,OAA3B,EAAvB;EAEA,OAAO;IACHC,sBAAsB,EAAEH,IAAI,GAAGA,IAAI,CAAC,wBAAD,CAAP,GAAoC,wBAD7D;IAEHI,qBAAqB,EAAEJ,IAAI,GAAGA,IAAI,CAAC,uBAAD,CAAP,GAAmC,uBAF3D;IAGHK,aAAa,EAAEL,IAAI,GAAGA,IAAI,CAAC,eAAD,CAAP,GAA2B,eAH3C;IAIHM,aAAa,EAAEN,IAAI,GAAGA,IAAI,CAAC,eAAD,CAAP,GAA2B;EAJ3C,CAAP;AAMH,CAnBM"}

package/scheduler/index.d.ts

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

package/scheduler/index.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createScheduler = void 0;
+
+var _createScheduleActionMethods = require("./createScheduleActionMethods");
+
+const createScheduler = params => {
+  const {
+    getLocale,
+    getIdentity,
+    getTenant,
+    getPermission,
+    storageOperations
+  } = params;
+  return (0, _createScheduleActionMethods.createScheduleActionMethods)({
+    getLocale,
+    getIdentity,
+    getTenant,
+    getPermission,
+    storageOperations
+  });
+};
+
+exports.createScheduler = createScheduler;

package/scheduler/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["createScheduler","params","getLocale","getIdentity","getTenant","getPermission","storageOperations","createScheduleActionMethods"],"sources":["index.ts"],"sourcesContent":["import { createScheduleActionMethods } from \"./createScheduleActionMethods\";\nimport { ApwScheduleActionCrud, CreateScheduleActionParams } from \"./types\";\n\nexport const createScheduler = (params: CreateScheduleActionParams): ApwScheduleActionCrud => {\n    const { getLocale, getIdentity, getTenant, getPermission, storageOperations } = params;\n\n    return createScheduleActionMethods({\n        getLocale,\n        getIdentity,\n        getTenant,\n        getPermission,\n        storageOperations\n    });\n};\n"],"mappings":";;;;;;;AAAA;;AAGO,MAAMA,eAAe,GAAIC,MAAD,IAA+D;EAC1F,MAAM;IAAEC,SAAF;IAAaC,WAAb;IAA0BC,SAA1B;IAAqCC,aAArC;IAAoDC;EAApD,IAA0EL,MAAhF;EAEA,OAAO,IAAAM,wDAAA,EAA4B;IAC/BL,SAD+B;IAE/BC,WAF+B;IAG/BC,SAH+B;IAI/BC,aAJ+B;IAK/BC;EAL+B,CAA5B,CAAP;AAOH,CAVM"}

package/scheduler/types.d.ts

@@ -0,0 +1,171 @@
+import { Context } from "@webiny/api/types";
+import { SecurityIdentity, SecurityPermission } from "@webiny/api-security/types";
+import { I18NLocale, I18NContext } from "@webiny/api-i18n/types";
+import { Tenant } from "@webiny/api-tenancy/types";
+import { TenancyContext } from "@webiny/api-tenancy/types";
+export interface ListWhere {
+    /**
+     * Fields.
+     */
+    id?: string;
+    id_in?: string[];
+    id_not?: string;
+    id_not_in?: string[];
+    /**
+     * Who created the entry?
+     */
+    createdBy?: string;
+    createdBy_not?: string;
+    createdBy_in?: string[];
+    createdBy_not_in?: string[];
+    /**
+     * By datetime field.
+     */
+    datetime_startsWith?: string;
+}
+export interface ListParams {
+    where: ListWhere;
+    sort?: ("datetime_ASC" | "datetime_DESC")[];
+    limit?: number;
+    after?: string;
+}
+/**
+ * A interface describing the reference to a user that created some data in the database.
+ *
+ * @category General
+ */
+export interface CreatedBy {
+    /**
+     * ID if the user.
+     */
+    id: string;
+    /**
+     * Full name of the user.
+     */
+    displayName: string | null;
+    /**
+     * Type of the user (admin, user)
+     */
+    type: string;
+}
+export interface ListMeta {
+    /**
+     * A cursor for pagination.
+     */
+    cursor: string | null;
+    /**
+     * Is there more items to load?
+     */
+    hasMoreItems: boolean;
+    /**
+     * Total count of the items in the storage.
+     */
+    totalCount: number;
+}
+export declare enum ApwContentTypes {
+    PAGE = "page",
+    CMS_ENTRY = "cms_entry"
+}
+export interface BaseFields {
+    id: string;
+    createdOn: string;
+    savedOn?: string;
+    createdBy: CreatedBy;
+    tenant: string;
+    locale: string;
+}
+export interface ApwScheduleAction extends BaseFields {
+    data: ApwScheduleActionData;
+}
+export declare enum ApwScheduleActionTypes {
+    PUBLISH = "publish",
+    UNPUBLISH = "unpublish"
+}
+export interface ApwScheduleActionData {
+    action: ApwScheduleActionTypes;
+    type: ApwContentTypes;
+    datetime: string;
+    entryId: string;
+    /**
+     * We will add modelId to the data for now.
+     * TODO extract in separate package?
+     */
+    modelId?: string;
+}
+export declare enum InvocationTypes {
+    SCHEDULED = "scheduled"
+}
+interface BaseApwCrud<TEntry, TCreateEntryParams, TUpdateEntryParams> {
+    get(id: string): Promise<TEntry | null>;
+    create(data: TCreateEntryParams): Promise<TEntry>;
+    update(id: string, data: TUpdateEntryParams): Promise<TEntry>;
+    delete(id: string): Promise<Boolean>;
+}
+export interface ApwScheduleActionCrud extends BaseApwCrud<ApwScheduleAction, ApwScheduleActionData, ApwScheduleActionData> {
+    list(params: ListParams): Promise<[ApwScheduleAction[], ListMeta]>;
+    getCurrentTask(): Promise<ApwScheduleAction | null>;
+    updateCurrentTask(item: ApwScheduleAction): Promise<ApwScheduleAction>;
+    deleteCurrentTask(): Promise<Boolean>;
+}
+export interface ScheduleActionContext extends Context, I18NContext, TenancyContext {
+    scheduleAction: ApwScheduleActionCrud;
+}
+export interface CreateScheduleActionParams {
+    getLocale: () => I18NLocale;
+    getIdentity: () => SecurityIdentity;
+    getTenant: () => Tenant;
+    getPermission: (name: string) => Promise<SecurityPermission | null>;
+    storageOperations: ApwScheduleActionStorageOperations;
+}
+interface CreateApwScheduleActionParams {
+    item: ApwScheduleAction;
+    input: ApwScheduleActionData;
+}
+interface StorageOperationsGetParams {
+    where: {
+        id: string;
+        tenant: string;
+        locale: string;
+    };
+}
+interface StorageOperationsDeleteParams {
+    id: string;
+    tenant: string;
+    locale: string;
+}
+export interface ApwScheduleActionListParams extends ListParams {
+    where: ListWhere & {
+        tenant: string;
+        locale: string;
+    };
+}
+export declare type StorageOperationsGetScheduleActionParams = StorageOperationsGetParams;
+export declare type StorageOperationsDeleteScheduleActionParams = StorageOperationsDeleteParams;
+export declare type StorageOperationsListScheduleActionsParams = ApwScheduleActionListParams;
+export declare type StorageOperationsCreateScheduleActionParams = CreateApwScheduleActionParams;
+export interface StorageOperationsUpdateScheduleActionParams {
+    item: ApwScheduleAction;
+    input: ApwScheduleActionData;
+}
+export declare type StorageOperationsListScheduleActionsResponse = [ApwScheduleAction[], ListMeta];
+export interface StorageOperationsUpdateCurrentTaskParams {
+    item: ApwScheduleAction;
+}
+export interface StorageOperationsGetCurrentTaskParams {
+    where: Pick<StorageOperationsGetParams["where"], "tenant" | "locale">;
+}
+export declare type StorageOperationsDeleteCurrentTaskParams = Pick<StorageOperationsDeleteParams, "tenant" | "locale">;
+export interface ApwScheduleActionStorageOperations {
+    get(params: StorageOperationsGetScheduleActionParams): Promise<ApwScheduleAction | null>;
+    list(params: StorageOperationsListScheduleActionsParams): Promise<StorageOperationsListScheduleActionsResponse>;
+    create(params: StorageOperationsCreateScheduleActionParams): Promise<ApwScheduleAction>;
+    update(params: StorageOperationsUpdateScheduleActionParams): Promise<ApwScheduleAction>;
+    delete(params: StorageOperationsDeleteScheduleActionParams): Promise<Boolean>;
+    getCurrentTask(params: StorageOperationsGetCurrentTaskParams): Promise<ApwScheduleAction | null>;
+    updateCurrentTask(params: StorageOperationsUpdateCurrentTaskParams): Promise<ApwScheduleAction>;
+    deleteCurrentTask(params: StorageOperationsDeleteCurrentTaskParams): Promise<Boolean>;
+}
+export interface CreateApwContextParams {
+    storageOperations: ApwScheduleActionStorageOperations;
+}
+export {};

package/scheduler/types.js

@@ -0,0 +1,34 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.InvocationTypes = exports.ApwScheduleActionTypes = exports.ApwContentTypes = void 0;
+
+/**
+ * A interface describing the reference to a user that created some data in the database.
+ *
+ * @category General
+ */
+let ApwContentTypes;
+exports.ApwContentTypes = ApwContentTypes;
+
+(function (ApwContentTypes) {
+  ApwContentTypes["PAGE"] = "page";
+  ApwContentTypes["CMS_ENTRY"] = "cms_entry";
+})(ApwContentTypes || (exports.ApwContentTypes = ApwContentTypes = {}));
+
+let ApwScheduleActionTypes;
+exports.ApwScheduleActionTypes = ApwScheduleActionTypes;
+
+(function (ApwScheduleActionTypes) {
+  ApwScheduleActionTypes["PUBLISH"] = "publish";
+  ApwScheduleActionTypes["UNPUBLISH"] = "unpublish";
+})(ApwScheduleActionTypes || (exports.ApwScheduleActionTypes = ApwScheduleActionTypes = {}));
+
+let InvocationTypes;
+exports.InvocationTypes = InvocationTypes;
+
+(function (InvocationTypes) {
+  InvocationTypes["SCHEDULED"] = "scheduled";
+})(InvocationTypes || (exports.InvocationTypes = InvocationTypes = {}));

package/scheduler/types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["ApwContentTypes","ApwScheduleActionTypes","InvocationTypes"],"sources":["types.ts"],"sourcesContent":["import { Context } from \"@webiny/api/types\";\nimport { SecurityIdentity, SecurityPermission } from \"@webiny/api-security/types\";\nimport { I18NLocale, I18NContext } from \"@webiny/api-i18n/types\";\nimport { Tenant } from \"@webiny/api-tenancy/types\";\nimport { TenancyContext } from \"@webiny/api-tenancy/types\";\n\nexport interface ListWhere {\n    /**\n     * Fields.\n     */\n    id?: string;\n    id_in?: string[];\n    id_not?: string;\n    id_not_in?: string[];\n    /**\n     * Who created the entry?\n     */\n    createdBy?: string;\n    createdBy_not?: string;\n    createdBy_in?: string[];\n    createdBy_not_in?: string[];\n    /**\n     * By datetime field.\n     */\n    datetime_startsWith?: string;\n}\n\nexport interface ListParams {\n    where: ListWhere;\n    sort?: (\"datetime_ASC\" | \"datetime_DESC\")[];\n    limit?: number;\n    after?: string;\n}\n\n/**\n * A interface describing the reference to a user that created some data in the database.\n *\n * @category General\n */\nexport interface CreatedBy {\n    /**\n     * ID if the user.\n     */\n    id: string;\n    /**\n     * Full name of the user.\n     */\n    displayName: string | null;\n    /**\n     * Type of the user (admin, user)\n     */\n    type: string;\n}\n\nexport interface ListMeta {\n    /**\n     * A cursor for pagination.\n     */\n    cursor: string | null;\n    /**\n     * Is there more items to load?\n     */\n    hasMoreItems: boolean;\n    /**\n     * Total count of the items in the storage.\n     */\n    totalCount: number;\n}\n\nexport enum ApwContentTypes {\n    PAGE = \"page\",\n    CMS_ENTRY = \"cms_entry\"\n}\n\nexport interface BaseFields {\n    id: string;\n    createdOn: string;\n    savedOn?: string;\n    createdBy: CreatedBy;\n    tenant: string;\n    locale: string;\n}\n\nexport interface ApwScheduleAction extends BaseFields {\n    data: ApwScheduleActionData;\n}\n\nexport enum ApwScheduleActionTypes {\n    PUBLISH = \"publish\",\n    UNPUBLISH = \"unpublish\"\n}\n\nexport interface ApwScheduleActionData {\n    action: ApwScheduleActionTypes;\n    type: ApwContentTypes;\n    datetime: string;\n    entryId: string;\n    /**\n     * We will add modelId to the data for now.\n     * TODO extract in separate package?\n     */\n    modelId?: string;\n}\n\nexport enum InvocationTypes {\n    SCHEDULED = \"scheduled\"\n}\n\ninterface BaseApwCrud<TEntry, TCreateEntryParams, TUpdateEntryParams> {\n    get(id: string): Promise<TEntry | null>;\n\n    create(data: TCreateEntryParams): Promise<TEntry>;\n\n    update(id: string, data: TUpdateEntryParams): Promise<TEntry>;\n\n    delete(id: string): Promise<Boolean>;\n}\n\nexport interface ApwScheduleActionCrud\n    extends BaseApwCrud<ApwScheduleAction, ApwScheduleActionData, ApwScheduleActionData> {\n    list(params: ListParams): Promise<[ApwScheduleAction[], ListMeta]>;\n\n    getCurrentTask(): Promise<ApwScheduleAction | null>;\n\n    updateCurrentTask(item: ApwScheduleAction): Promise<ApwScheduleAction>;\n\n    deleteCurrentTask(): Promise<Boolean>;\n}\n\nexport interface ScheduleActionContext extends Context, I18NContext, TenancyContext {\n    scheduleAction: ApwScheduleActionCrud;\n}\n\nexport interface CreateScheduleActionParams {\n    getLocale: () => I18NLocale;\n    getIdentity: () => SecurityIdentity;\n    getTenant: () => Tenant;\n    getPermission: (name: string) => Promise<SecurityPermission | null>;\n    storageOperations: ApwScheduleActionStorageOperations;\n}\n\ninterface CreateApwScheduleActionParams {\n    item: ApwScheduleAction;\n    input: ApwScheduleActionData;\n}\n\ninterface StorageOperationsGetParams {\n    where: {\n        id: string;\n        tenant: string;\n        locale: string;\n    };\n}\n\ninterface StorageOperationsDeleteParams {\n    id: string;\n    tenant: string;\n    locale: string;\n}\n\nexport interface ApwScheduleActionListParams extends ListParams {\n    where: ListWhere & {\n        tenant: string;\n        locale: string;\n    };\n}\n\nexport type StorageOperationsGetScheduleActionParams = StorageOperationsGetParams;\n\nexport type StorageOperationsDeleteScheduleActionParams = StorageOperationsDeleteParams;\nexport type StorageOperationsListScheduleActionsParams = ApwScheduleActionListParams;\n\nexport type StorageOperationsCreateScheduleActionParams = CreateApwScheduleActionParams;\n\nexport interface StorageOperationsUpdateScheduleActionParams {\n    item: ApwScheduleAction;\n    input: ApwScheduleActionData;\n}\n\nexport type StorageOperationsListScheduleActionsResponse = [ApwScheduleAction[], ListMeta];\n\nexport interface StorageOperationsUpdateCurrentTaskParams {\n    item: ApwScheduleAction;\n}\n\nexport interface StorageOperationsGetCurrentTaskParams {\n    where: Pick<StorageOperationsGetParams[\"where\"], \"tenant\" | \"locale\">;\n}\n\nexport type StorageOperationsDeleteCurrentTaskParams = Pick<\n    StorageOperationsDeleteParams,\n    \"tenant\" | \"locale\"\n>;\n\nexport interface ApwScheduleActionStorageOperations {\n    get(params: StorageOperationsGetScheduleActionParams): Promise<ApwScheduleAction | null>;\n\n    list(\n        params: StorageOperationsListScheduleActionsParams\n    ): Promise<StorageOperationsListScheduleActionsResponse>;\n\n    create(params: StorageOperationsCreateScheduleActionParams): Promise<ApwScheduleAction>;\n\n    update(params: StorageOperationsUpdateScheduleActionParams): Promise<ApwScheduleAction>;\n\n    delete(params: StorageOperationsDeleteScheduleActionParams): Promise<Boolean>;\n\n    getCurrentTask(\n        params: StorageOperationsGetCurrentTaskParams\n    ): Promise<ApwScheduleAction | null>;\n\n    updateCurrentTask(params: StorageOperationsUpdateCurrentTaskParams): Promise<ApwScheduleAction>;\n\n    deleteCurrentTask(params: StorageOperationsDeleteCurrentTaskParams): Promise<Boolean>;\n}\n\nexport interface CreateApwContextParams {\n    storageOperations: ApwScheduleActionStorageOperations;\n}\n"],"mappings":";;;;;;;AAkCA;AACA;AACA;AACA;AACA;IA+BYA,e;;;WAAAA,e;EAAAA,e;EAAAA,e;GAAAA,e,+BAAAA,e;;IAkBAC,sB;;;WAAAA,sB;EAAAA,sB;EAAAA,sB;GAAAA,sB,sCAAAA,sB;;IAiBAC,e;;;WAAAA,e;EAAAA,e;GAAAA,e,+BAAAA,e"}