@webiny/tasks 0.0.0-unstable.2696f9d9e8

package/runner/utils/getObjectProperties.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Unfortunately we need some casting as we do not know which properties are available on the object.
+ */
+export declare const getObjectProperties: <T = Record<string, any>>(input: unknown) => T;

package/runner/utils/getObjectProperties.js

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getObjectProperties = void 0;
+/**
+ * Unfortunately we need some casting as we do not know which properties are available on the object.
+ */
+const getObjectProperties = input => {
+  if (!input || typeof input !== "object") {
+    return {};
+  }
+  return Object.getOwnPropertyNames(input).reduce((acc, key) => {
+    acc[key] = input[key];
+    return acc;
+  }, {});
+};
+exports.getObjectProperties = getObjectProperties;
+
+//# sourceMappingURL=getObjectProperties.js.map

package/runner/utils/getObjectProperties.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["getObjectProperties","input","Object","getOwnPropertyNames","reduce","acc","key","exports"],"sources":["getObjectProperties.ts"],"sourcesContent":["/**\n * Unfortunately we need some casting as we do not know which properties are available on the object.\n */\nexport const getObjectProperties = <T = Record<string, any>>(input: unknown): T => {\n    if (!input || typeof input !== \"object\") {\n        return {} as unknown as T;\n    }\n    return Object.getOwnPropertyNames(input).reduce<Record<string, any>>((acc, key) => {\n        acc[key] = (input as Record<string, any>)[key];\n        return acc;\n    }, {}) as unknown as T;\n};\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACO,MAAMA,mBAAmB,GAA6BC,KAAc,IAAQ;EAC/E,IAAI,CAACA,KAAK,IAAI,OAAOA,KAAK,KAAK,QAAQ,EAAE;IACrC,OAAO,CAAC,CAAC;EACb;EACA,OAAOC,MAAM,CAACC,mBAAmB,CAACF,KAAK,CAAC,CAACG,MAAM,CAAsB,CAACC,GAAG,EAAEC,GAAG,KAAK;IAC/ED,GAAG,CAACC,GAAG,CAAC,GAAIL,KAAK,CAAyBK,GAAG,CAAC;IAC9C,OAAOD,GAAG;EACd,CAAC,EAAE,CAAC,CAAC,CAAC;AACV,CAAC;AAACE,OAAA,CAAAP,mBAAA,GAAAA,mBAAA"}

package/task/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./input";
+export * from "./plugin";

package/task/index.js

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

package/task/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_input","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get","_plugin"],"sources":["index.ts"],"sourcesContent":["export * from \"./input\";\nexport * from \"./plugin\";\n"],"mappings":";;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,MAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,MAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,MAAA,CAAAK,GAAA;IAAA;EAAA;AAAA;AACA,IAAAK,OAAA,GAAAT,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAO,OAAA,EAAAN,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAK,OAAA,CAAAL,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAC,OAAA,CAAAL,GAAA;IAAA;EAAA;AAAA"}

package/task/input.d.ts

@@ -0,0 +1,15 @@
+export interface ITaskInputParams<T> {
+    id: string;
+    input: T;
+}
+declare class TaskInput<T> {
+    id: string;
+    input: T;
+    constructor(params: ITaskInputParams<T>);
+}
+export type { TaskInput };
+interface ICreateTaskInputParams<T> {
+    id: string;
+    input: T;
+}
+export declare const createTaskInput: <T>(params: ICreateTaskInputParams<T>) => TaskInput<T>;

package/task/input.js

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createTaskInput = void 0;
+class TaskInput {
+  constructor(params) {
+    this.id = params.id;
+    this.input = params.input;
+  }
+}
+const createTaskInput = params => {
+  return new TaskInput({
+    id: params.id,
+    input: params.input
+  });
+};
+exports.createTaskInput = createTaskInput;
+
+//# sourceMappingURL=input.js.map

package/task/input.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["TaskInput","constructor","params","id","input","createTaskInput","exports"],"sources":["input.ts"],"sourcesContent":["export interface ITaskInputParams<T> {\n    id: string;\n    input: T;\n}\nclass TaskInput<T> {\n    public id: string;\n    public input: T;\n\n    constructor(params: ITaskInputParams<T>) {\n        this.id = params.id;\n        this.input = params.input;\n    }\n}\n\nexport type { TaskInput };\n\ninterface ICreateTaskInputParams<T> {\n    id: string;\n    input: T;\n}\n\nexport const createTaskInput = <T>(params: ICreateTaskInputParams<T>) => {\n    return new TaskInput({\n        id: params.id,\n        input: params.input\n    });\n};\n"],"mappings":";;;;;;AAIA,MAAMA,SAAS,CAAI;EAIfC,WAAWA,CAACC,MAA2B,EAAE;IACrC,IAAI,CAACC,EAAE,GAAGD,MAAM,CAACC,EAAE;IACnB,IAAI,CAACC,KAAK,GAAGF,MAAM,CAACE,KAAK;EAC7B;AACJ;AASO,MAAMC,eAAe,GAAOH,MAAiC,IAAK;EACrE,OAAO,IAAIF,SAAS,CAAC;IACjBG,EAAE,EAAED,MAAM,CAACC,EAAE;IACbC,KAAK,EAAEF,MAAM,CAACE;EAClB,CAAC,CAAC;AACN,CAAC;AAACE,OAAA,CAAAD,eAAA,GAAAA,eAAA"}

package/task/plugin.d.ts

@@ -0,0 +1,28 @@
+import { Plugin } from "@webiny/plugins";
+import { Context, ITaskDefinition, ITaskDefinitionField } from "../types";
+export interface ITaskPluginSetFieldsCallback {
+    (fields: ITaskDefinitionField[]): ITaskDefinitionField[] | undefined;
+}
+export interface ITaskDefinitionParams<C extends Context = Context, I = any> extends Omit<ITaskDefinition<C, I>, "fields"> {
+    config?: (task: Pick<TaskDefinitionPlugin<C, I>, "addField" | "setFields">) => void;
+}
+export declare class TaskDefinitionPlugin<C extends Context = Context, I = any> extends Plugin implements ITaskDefinition<C, I> {
+    static readonly type: string;
+    private readonly task;
+    get id(): string;
+    get title(): string;
+    get fields(): ITaskDefinitionField[] | undefined;
+    get run(): (params: import("../types").ITaskRunParams<C, I>) => Promise<import("../types").ITaskResponseResult>;
+    get onDone(): ((params: import("../types").ITaskSuccessParams<C, I>) => Promise<void>) | undefined;
+    get onError(): ((params: import("../types").ITaskErrorParams<C, I>) => Promise<void>) | undefined;
+    constructor(task: ITaskDefinitionParams<C, I>);
+    getTask(): ITaskDefinition<C, I>;
+    setFields(cb: ITaskPluginSetFieldsCallback): void;
+    addField(field: ITaskDefinitionField): void;
+    /**
+     * TODO implement zod validation if validation becomes too complex
+     */
+    private validate;
+}
+export declare const createTaskDefinition: <C extends Context = Context, I = any>(params: ITaskDefinitionParams<C, I>) => TaskDefinitionPlugin<C, I>;
+export declare const createTaskDefinitionField: (params: ITaskDefinitionField) => ITaskDefinitionField;

package/task/plugin.js

@@ -0,0 +1,76 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createTaskDefinitionField = exports.createTaskDefinition = exports.TaskDefinitionPlugin = void 0;
+var _camelCase = _interopRequireDefault(require("lodash/camelCase"));
+var _error = _interopRequireDefault(require("@webiny/error"));
+var _plugins = require("@webiny/plugins");
+class TaskDefinitionPlugin extends _plugins.Plugin {
+  static type = "webiny.backgroundTask";
+  get id() {
+    return this.task.id;
+  }
+  get title() {
+    return this.task.title;
+  }
+  get fields() {
+    return this.task.fields;
+  }
+  get run() {
+    return this.task.run;
+  }
+  get onDone() {
+    return this.task.onDone;
+  }
+  get onError() {
+    return this.task.onError;
+  }
+  constructor(task) {
+    super();
+    this.task = {
+      ...task,
+      fields: []
+    };
+    if (typeof task.config === "function") {
+      task.config(this);
+    }
+    this.validate();
+  }
+  getTask() {
+    return this.task;
+  }
+  setFields(cb) {
+    const fields = Array.from(this.task.fields || []);
+    this.task.fields = cb(fields);
+  }
+  addField(field) {
+    this.task.fields = (this.task.fields || []).concat([field]);
+  }
+  /**
+   * TODO implement zod validation if validation becomes too complex
+   */
+  validate() {
+    if ((0, _camelCase.default)(this.task.id) !== this.task.id) {
+      /**
+       * We want to log and throw the message so it can be seen in the CloudWatch logs.
+       */
+      const message = `Task ID "${this.task.id}" is invalid. It must be in camelCase format, for example: "myCustomTask".`;
+      console.log(message);
+      throw new _error.default(message);
+    }
+  }
+}
+exports.TaskDefinitionPlugin = TaskDefinitionPlugin;
+const createTaskDefinition = params => {
+  return new TaskDefinitionPlugin(params);
+};
+exports.createTaskDefinition = createTaskDefinition;
+const createTaskDefinitionField = params => {
+  return params;
+};
+exports.createTaskDefinitionField = createTaskDefinitionField;
+
+//# sourceMappingURL=plugin.js.map

package/task/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_camelCase","_interopRequireDefault","require","_error","_plugins","TaskDefinitionPlugin","Plugin","type","id","task","title","fields","run","onDone","onError","constructor","config","validate","getTask","setFields","cb","Array","from","addField","field","concat","camelCase","message","console","log","WebinyError","exports","createTaskDefinition","params","createTaskDefinitionField"],"sources":["plugin.ts"],"sourcesContent":["import camelCase from \"lodash/camelCase\";\nimport WebinyError from \"@webiny/error\";\nimport { Plugin } from \"@webiny/plugins\";\nimport { Context, ITaskDefinition, ITaskDefinitionField } from \"~/types\";\n\nexport interface ITaskPluginSetFieldsCallback {\n    (fields: ITaskDefinitionField[]): ITaskDefinitionField[] | undefined;\n}\n\nexport interface ITaskDefinitionParams<C extends Context = Context, I = any>\n    extends Omit<ITaskDefinition<C, I>, \"fields\"> {\n    config?: (task: Pick<TaskDefinitionPlugin<C, I>, \"addField\" | \"setFields\">) => void;\n}\n\nexport class TaskDefinitionPlugin<C extends Context = Context, I = any>\n    extends Plugin\n    implements ITaskDefinition<C, I>\n{\n    public static override readonly type: string = \"webiny.backgroundTask\";\n\n    private readonly task: ITaskDefinition<C, I>;\n\n    public get id() {\n        return this.task.id;\n    }\n\n    public get title() {\n        return this.task.title;\n    }\n\n    public get fields() {\n        return this.task.fields;\n    }\n\n    public get run() {\n        return this.task.run;\n    }\n\n    public get onDone() {\n        return this.task.onDone;\n    }\n\n    public get onError() {\n        return this.task.onError;\n    }\n\n    public constructor(task: ITaskDefinitionParams<C, I>) {\n        super();\n        this.task = {\n            ...task,\n            fields: []\n        };\n        if (typeof task.config === \"function\") {\n            task.config(this);\n        }\n        this.validate();\n    }\n\n    public getTask() {\n        return this.task;\n    }\n\n    public setFields(cb: ITaskPluginSetFieldsCallback) {\n        const fields = Array.from(this.task.fields || []);\n        this.task.fields = cb(fields);\n    }\n\n    public addField(field: ITaskDefinitionField) {\n        this.task.fields = (this.task.fields || []).concat([field]);\n    }\n    /**\n     * TODO implement zod validation if validation becomes too complex\n     */\n    private validate(): void {\n        if (camelCase(this.task.id) !== this.task.id) {\n            /**\n             * We want to log and throw the message so it can be seen in the CloudWatch logs.\n             */\n            const message = `Task ID \"${this.task.id}\" is invalid. It must be in camelCase format, for example: \"myCustomTask\".`;\n            console.log(message);\n            throw new WebinyError(message);\n        }\n    }\n}\n\nexport const createTaskDefinition = <C extends Context = Context, I = any>(\n    params: ITaskDefinitionParams<C, I>\n) => {\n    return new TaskDefinitionPlugin(params);\n};\n\nexport const createTaskDefinitionField = (params: ITaskDefinitionField) => {\n    return params;\n};\n"],"mappings":";;;;;;;AAAA,IAAAA,UAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,MAAA,GAAAF,sBAAA,CAAAC,OAAA;AACA,IAAAE,QAAA,GAAAF,OAAA;AAYO,MAAMG,oBAAoB,SACrBC,eAAM,CAElB;EACI,OAAgCC,IAAI,GAAW,uBAAuB;EAItE,IAAWC,EAAEA,CAAA,EAAG;IACZ,OAAO,IAAI,CAACC,IAAI,CAACD,EAAE;EACvB;EAEA,IAAWE,KAAKA,CAAA,EAAG;IACf,OAAO,IAAI,CAACD,IAAI,CAACC,KAAK;EAC1B;EAEA,IAAWC,MAAMA,CAAA,EAAG;IAChB,OAAO,IAAI,CAACF,IAAI,CAACE,MAAM;EAC3B;EAEA,IAAWC,GAAGA,CAAA,EAAG;IACb,OAAO,IAAI,CAACH,IAAI,CAACG,GAAG;EACxB;EAEA,IAAWC,MAAMA,CAAA,EAAG;IAChB,OAAO,IAAI,CAACJ,IAAI,CAACI,MAAM;EAC3B;EAEA,IAAWC,OAAOA,CAAA,EAAG;IACjB,OAAO,IAAI,CAACL,IAAI,CAACK,OAAO;EAC5B;EAEOC,WAAWA,CAACN,IAAiC,EAAE;IAClD,KAAK,CAAC,CAAC;IACP,IAAI,CAACA,IAAI,GAAG;MACR,GAAGA,IAAI;MACPE,MAAM,EAAE;IACZ,CAAC;IACD,IAAI,OAAOF,IAAI,CAACO,MAAM,KAAK,UAAU,EAAE;MACnCP,IAAI,CAACO,MAAM,CAAC,IAAI,CAAC;IACrB;IACA,IAAI,CAACC,QAAQ,CAAC,CAAC;EACnB;EAEOC,OAAOA,CAAA,EAAG;IACb,OAAO,IAAI,CAACT,IAAI;EACpB;EAEOU,SAASA,CAACC,EAAgC,EAAE;IAC/C,MAAMT,MAAM,GAAGU,KAAK,CAACC,IAAI,CAAC,IAAI,CAACb,IAAI,CAACE,MAAM,IAAI,EAAE,CAAC;IACjD,IAAI,CAACF,IAAI,CAACE,MAAM,GAAGS,EAAE,CAACT,MAAM,CAAC;EACjC;EAEOY,QAAQA,CAACC,KAA2B,EAAE;IACzC,IAAI,CAACf,IAAI,CAACE,MAAM,GAAG,CAAC,IAAI,CAACF,IAAI,CAACE,MAAM,IAAI,EAAE,EAAEc,MAAM,CAAC,CAACD,KAAK,CAAC,CAAC;EAC/D;EACA;AACJ;AACA;EACYP,QAAQA,CAAA,EAAS;IACrB,IAAI,IAAAS,kBAAS,EAAC,IAAI,CAACjB,IAAI,CAACD,EAAE,CAAC,KAAK,IAAI,CAACC,IAAI,CAACD,EAAE,EAAE;MAC1C;AACZ;AACA;MACY,MAAMmB,OAAO,GAAI,YAAW,IAAI,CAAClB,IAAI,CAACD,EAAG,4EAA2E;MACpHoB,OAAO,CAACC,GAAG,CAACF,OAAO,CAAC;MACpB,MAAM,IAAIG,cAAW,CAACH,OAAO,CAAC;IAClC;EACJ;AACJ;AAACI,OAAA,CAAA1B,oBAAA,GAAAA,oBAAA;AAEM,MAAM2B,oBAAoB,GAC7BC,MAAmC,IAClC;EACD,OAAO,IAAI5B,oBAAoB,CAAC4B,MAAM,CAAC;AAC3C,CAAC;AAACF,OAAA,CAAAC,oBAAA,GAAAA,oBAAA;AAEK,MAAME,yBAAyB,GAAID,MAA4B,IAAK;EACvE,OAAOA,MAAM;AACjB,CAAC;AAACF,OAAA,CAAAG,yBAAA,GAAAA,yBAAA"}

package/types.d.ts

@@ -0,0 +1,258 @@
+import { CmsContext as BaseContext, CmsEntryListParams, CmsEntryMeta, CmsModel, CmsModelField } from "@webiny/api-headless-cms/types";
+import { Topic } from "@webiny/pubsub/types";
+import { IResponseError, ITaskResponse, ITaskResponseResult } from "./response/abstractions";
+import { ITaskManagerStore } from "./runner/abstractions";
+import { EventBridgeClientSendResponse } from "@webiny/aws-sdk/client-eventbridge";
+import { SecurityPermission } from "@webiny/api-security/types";
+export * from "./response/abstractions";
+export * from "./runner/abstractions";
+export interface ITaskConfig {
+    readonly eventBusName: string;
+}
+export interface ITaskDataInput {
+    [key: string]: any;
+}
+export declare enum ITaskLogItemType {
+    INFO = "info",
+    ERROR = "error"
+}
+export interface ITaskLogItemData {
+    [key: string]: any;
+}
+export interface ITaskLogItemBase {
+    message: string;
+    createdOn: string;
+    type: ITaskLogItemType;
+    data?: ITaskLogItemData;
+}
+export interface ITaskLogItemInfo extends ITaskLogItemBase {
+    type: ITaskLogItemType.INFO;
+}
+export interface ITaskLogItemError extends ITaskLogItemBase {
+    type: ITaskLogItemType.ERROR;
+    error?: IResponseError;
+}
+export declare type ITaskLogItem = ITaskLogItemInfo | ITaskLogItemError;
+export interface ITaskLog {
+    /**
+     * ID without the revision number (for example: #0001).
+     */
+    id: string;
+    createdOn: string;
+    createdBy: ITaskIdentity;
+    executionName: string;
+    task: string;
+    iteration: number;
+    items: ITaskLogItem[];
+}
+export declare enum TaskDataStatus {
+    PENDING = "pending",
+    RUNNING = "running",
+    FAILED = "failed",
+    SUCCESS = "success",
+    ABORTED = "aborted"
+}
+export interface ITaskIdentity {
+    id: string;
+    displayName: string | null;
+    type: string;
+}
+export interface ITaskData<T = any> {
+    /**
+     * ID without the revision number (for example: #0001).
+     */
+    id: string;
+    name: string;
+    taskStatus: TaskDataStatus;
+    definitionId: string;
+    executionName: string;
+    input: T;
+    createdOn: string;
+    savedOn: string;
+    createdBy: ITaskIdentity;
+    startedOn?: string;
+    finishedOn?: string;
+    eventResponse: EventBridgeClientSendResponse | undefined;
+    iterations: number;
+}
+export declare type IGetTaskResponse<T = any> = ITaskData<T> | null;
+export interface IListTasksResponse<T = any> {
+    items: ITaskData<T>[];
+    meta: CmsEntryMeta;
+}
+export interface IListTaskLogsResponse {
+    items: ITaskLog[];
+    meta: CmsEntryMeta;
+}
+export declare type ICreateTaskResponse<T = any> = ITaskData<T>;
+export declare type IUpdateTaskResponse<T = any> = ITaskData<T>;
+export declare type IDeleteTaskResponse = boolean;
+export declare type IListTaskParams = Omit<CmsEntryListParams, "fields">;
+export declare type IListTaskLogParams = Omit<CmsEntryListParams, "fields">;
+export interface ITaskCreateData<T = ITaskDataInput> {
+    definitionId: string;
+    name: string;
+    input: T;
+}
+export interface ITaskUpdateData<T = ITaskDataInput> {
+    name?: string;
+    input?: T;
+    taskStatus?: TaskDataStatus;
+    executionName?: string;
+    startedOn?: string;
+    finishedOn?: string;
+    eventResponse?: Record<string, any>;
+    iterations?: number;
+}
+export interface OnTaskBeforeCreateTopicParams {
+    input: ITaskCreateData;
+}
+export interface OnTaskAfterCreateTopicParams {
+    input: ITaskCreateData;
+    task: ITaskData;
+}
+export interface OnTaskBeforeUpdateTopicParams {
+    input: ITaskUpdateData;
+    original: ITaskData;
+}
+export interface OnTaskAfterUpdateTopicParams {
+    input: ITaskUpdateData;
+    task: ITaskData;
+}
+export interface OnTaskBeforeDeleteTopicParams {
+    task: ITaskData;
+}
+export interface OnTaskAfterDeleteTopicParams {
+    task: ITaskData;
+}
+export interface ITaskLogCreateInput {
+    executionName: string;
+    iteration: number;
+}
+export interface ITaskLogUpdateInput {
+    items: ITaskLogItem[];
+}
+export interface ITasksContextCrudObject {
+    /**
+     * Models
+     */
+    getTaskModel: () => Promise<CmsModel>;
+    getLogModel: () => Promise<CmsModel>;
+    /**
+     * Tasks
+     */
+    getTask: <T = any>(id: string) => Promise<IGetTaskResponse<T> | null>;
+    listTasks: <T = any>(params?: IListTaskParams) => Promise<IListTasksResponse<T>>;
+    createTask: <T = any>(task: ITaskCreateData<T>) => Promise<ICreateTaskResponse<T>>;
+    updateTask: <T = any>(id: string, data: Partial<ITaskUpdateData<T>>) => Promise<IUpdateTaskResponse<T>>;
+    deleteTask: (id: string) => Promise<IDeleteTaskResponse>;
+    /**
+     * Logs
+     */
+    createLog: (task: Pick<ITaskData, "id">, data: ITaskLogCreateInput) => Promise<ITaskLog>;
+    updateLog: (id: string, data: ITaskLogUpdateInput) => Promise<ITaskLog>;
+    getLog: (id: string) => Promise<ITaskLog | null>;
+    getLatestLog: (taskId: string) => Promise<ITaskLog>;
+    listLogs: (params: IListTaskLogParams) => Promise<IListTaskLogsResponse>;
+    /**
+     * Lifecycle events.
+     */
+    onTaskBeforeCreate: Topic<OnTaskBeforeCreateTopicParams>;
+    onTaskAfterCreate: Topic<OnTaskAfterCreateTopicParams>;
+    onTaskBeforeUpdate: Topic<OnTaskBeforeUpdateTopicParams>;
+    onTaskAfterUpdate: Topic<OnTaskAfterUpdateTopicParams>;
+    onTaskBeforeDelete: Topic<OnTaskBeforeDeleteTopicParams>;
+    onTaskAfterDelete: Topic<OnTaskAfterDeleteTopicParams>;
+}
+export interface ITasksContextConfigObject {
+    config: ITaskConfig;
+}
+export interface ITasksContextDefinitionObject {
+    getDefinition: <T = ITaskDataInput>(id: string) => ITaskDefinition<Context, T> | null;
+    listDefinitions: () => ITaskDefinition[];
+}
+export interface ITaskTriggerParams<T = ITaskDataInput> {
+    definition: string;
+    name?: string;
+    input?: T;
+}
+export interface ITaskAbortParams {
+    id: string;
+    message?: string;
+}
+export interface ITasksContextTriggerObject {
+    trigger: <T = ITaskDataInput>(params: ITaskTriggerParams<T>) => Promise<ITaskData<T>>;
+    abort: <T = ITaskDataInput>(params: ITaskAbortParams) => Promise<ITaskData<T>>;
+}
+export interface ITasksContextObject extends ITasksContextCrudObject, ITasksContextDefinitionObject, ITasksContextTriggerObject, ITasksContextConfigObject {
+}
+export interface Context extends BaseContext {
+    tasks: ITasksContextObject;
+}
+export interface ITaskRunParams<C extends Context, I = any> {
+    context: C;
+    response: ITaskResponse;
+    isCloseToTimeout: () => boolean;
+    isAborted: () => boolean;
+    input: I;
+    store: ITaskManagerStore;
+}
+export interface ITaskSuccessParams<C extends Context, I = any> {
+    context: C;
+    input: I;
+}
+export interface ITaskErrorParams<C extends Context, I = any> {
+    context: C;
+    input: I;
+}
+export declare enum TaskResponseStatus {
+    DONE = "done",
+    ERROR = "error",
+    CONTINUE = "continue",
+    ABORTED = "aborted"
+}
+export declare type ITaskDefinitionField = Pick<CmsModelField, "fieldId" | "type" | "label" | "renderer" | "helpText" | "placeholderText" | "predefinedValues" | "validation" | "listValidation" | "multipleValues" | "settings">;
+export interface ITaskBeforeTriggerParams<C extends Context = Context, I = ITaskDataInput> {
+    context: C;
+    input: I;
+}
+export interface ITaskDefinition<C extends Context = Context, I = ITaskDataInput> {
+    /**
+     * ID of the task must be unique in the system.
+     * It should be in camelCase format, for example: "myCustomTask".
+     */
+    id: string;
+    /**
+     * Name should be unique, as it will get used to identify the task in the UI.
+     */
+    title: string;
+    /**
+     * A description of the task, for the UI.
+     */
+    description?: string;
+    /**
+     * Task run method.
+     */
+    run: (params: ITaskRunParams<C, I>) => Promise<ITaskResponseResult>;
+    /**
+     * When a new task is about to be triggered, we will run this method.
+     * For example, you can use this method to check if there is a task of the same type already running.
+     */
+    onBeforeTrigger?: <T = ITaskDataInput>(params: ITaskBeforeTriggerParams<C, T>) => Promise<void>;
+    /**
+     * When task successfully finishes, this method will be called.
+     */
+    onDone?: (params: ITaskSuccessParams<C, I>) => Promise<void>;
+    /**
+     * When task fails, this method will be called.
+     */
+    onError?: (params: ITaskErrorParams<C, I>) => Promise<void>;
+    /**
+     * Custom input fields and layout for the task input.
+     */
+    fields?: ITaskDefinitionField[];
+}
+export interface TaskPermission extends SecurityPermission {
+    name: "task";
+    rwd?: string;
+}

package/types.js

@@ -0,0 +1,60 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  ITaskLogItemType: true,
+  TaskDataStatus: true,
+  TaskResponseStatus: true
+};
+exports.TaskResponseStatus = exports.TaskDataStatus = exports.ITaskLogItemType = void 0;
+var _abstractions = require("./response/abstractions");
+Object.keys(_abstractions).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _abstractions[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _abstractions[key];
+    }
+  });
+});
+var _abstractions2 = require("./runner/abstractions");
+Object.keys(_abstractions2).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _abstractions2[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _abstractions2[key];
+    }
+  });
+});
+let ITaskLogItemType = /*#__PURE__*/function (ITaskLogItemType) {
+  ITaskLogItemType["INFO"] = "info";
+  ITaskLogItemType["ERROR"] = "error";
+  return ITaskLogItemType;
+}({});
+exports.ITaskLogItemType = ITaskLogItemType;
+let TaskDataStatus = /*#__PURE__*/function (TaskDataStatus) {
+  TaskDataStatus["PENDING"] = "pending";
+  TaskDataStatus["RUNNING"] = "running";
+  TaskDataStatus["FAILED"] = "failed";
+  TaskDataStatus["SUCCESS"] = "success";
+  TaskDataStatus["ABORTED"] = "aborted";
+  return TaskDataStatus;
+}({});
+exports.TaskDataStatus = TaskDataStatus;
+let TaskResponseStatus = /*#__PURE__*/function (TaskResponseStatus) {
+  TaskResponseStatus["DONE"] = "done";
+  TaskResponseStatus["ERROR"] = "error";
+  TaskResponseStatus["CONTINUE"] = "continue";
+  TaskResponseStatus["ABORTED"] = "aborted";
+  return TaskResponseStatus;
+}({});
+exports.TaskResponseStatus = TaskResponseStatus;
+
+//# sourceMappingURL=types.js.map

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_abstractions","require","Object","keys","forEach","key","prototype","hasOwnProperty","call","_exportNames","exports","defineProperty","enumerable","get","_abstractions2","ITaskLogItemType","TaskDataStatus","TaskResponseStatus"],"sources":["types.ts"],"sourcesContent":["import {\n    CmsContext as BaseContext,\n    CmsEntryListParams,\n    CmsEntryMeta,\n    CmsModel,\n    CmsModelField\n} from \"@webiny/api-headless-cms/types\";\nimport { Topic } from \"@webiny/pubsub/types\";\nimport { IResponseError, ITaskResponse, ITaskResponseResult } from \"~/response/abstractions\";\nimport { ITaskManagerStore } from \"./runner/abstractions\";\nimport { EventBridgeClientSendResponse } from \"@webiny/aws-sdk/client-eventbridge\";\nimport { SecurityPermission } from \"@webiny/api-security/types\";\n\nexport * from \"./response/abstractions\";\nexport * from \"./runner/abstractions\";\n\nexport interface ITaskConfig {\n    readonly eventBusName: string;\n}\n\nexport interface ITaskDataInput {\n    [key: string]: any;\n}\n\nexport enum ITaskLogItemType {\n    INFO = \"info\",\n    ERROR = \"error\"\n}\n\nexport interface ITaskLogItemData {\n    [key: string]: any;\n}\n\nexport interface ITaskLogItemBase {\n    message: string;\n    createdOn: string;\n    type: ITaskLogItemType;\n    data?: ITaskLogItemData;\n}\n\nexport interface ITaskLogItemInfo extends ITaskLogItemBase {\n    type: ITaskLogItemType.INFO;\n}\n\nexport interface ITaskLogItemError extends ITaskLogItemBase {\n    type: ITaskLogItemType.ERROR;\n    error?: IResponseError;\n}\n\nexport type ITaskLogItem = ITaskLogItemInfo | ITaskLogItemError;\n\nexport interface ITaskLog {\n    /**\n     * ID without the revision number (for example: #0001).\n     */\n    id: string;\n    createdOn: string;\n    createdBy: ITaskIdentity;\n    executionName: string;\n    task: string;\n    iteration: number;\n    items: ITaskLogItem[];\n}\n\nexport enum TaskDataStatus {\n    PENDING = \"pending\",\n    RUNNING = \"running\",\n    FAILED = \"failed\",\n    SUCCESS = \"success\",\n    ABORTED = \"aborted\"\n}\n\nexport interface ITaskIdentity {\n    id: string;\n    displayName: string | null;\n    type: string;\n}\n\nexport interface ITaskData<T = any> {\n    /**\n     * ID without the revision number (for example: #0001).\n     */\n    id: string;\n    name: string;\n    taskStatus: TaskDataStatus;\n    definitionId: string;\n    executionName: string;\n    input: T;\n    createdOn: string;\n    savedOn: string;\n    createdBy: ITaskIdentity;\n    startedOn?: string;\n    finishedOn?: string;\n    eventResponse: EventBridgeClientSendResponse | undefined;\n    iterations: number;\n}\n\nexport type IGetTaskResponse<T = any> = ITaskData<T> | null;\n\nexport interface IListTasksResponse<T = any> {\n    items: ITaskData<T>[];\n    meta: CmsEntryMeta;\n}\n\nexport interface IListTaskLogsResponse {\n    items: ITaskLog[];\n    meta: CmsEntryMeta;\n}\n\nexport type ICreateTaskResponse<T = any> = ITaskData<T>;\nexport type IUpdateTaskResponse<T = any> = ITaskData<T>;\nexport type IDeleteTaskResponse = boolean;\n\nexport type IListTaskParams = Omit<CmsEntryListParams, \"fields\">;\nexport type IListTaskLogParams = Omit<CmsEntryListParams, \"fields\">;\n\nexport interface ITaskCreateData<T = ITaskDataInput> {\n    definitionId: string;\n    name: string;\n    input: T;\n}\n\nexport interface ITaskUpdateData<T = ITaskDataInput> {\n    name?: string;\n    input?: T;\n    taskStatus?: TaskDataStatus;\n    executionName?: string;\n    startedOn?: string;\n    finishedOn?: string;\n    eventResponse?: Record<string, any>;\n    iterations?: number;\n}\n\nexport interface OnTaskBeforeCreateTopicParams {\n    input: ITaskCreateData;\n}\n\nexport interface OnTaskAfterCreateTopicParams {\n    input: ITaskCreateData;\n    task: ITaskData;\n}\n\nexport interface OnTaskBeforeUpdateTopicParams {\n    input: ITaskUpdateData;\n    original: ITaskData;\n}\n\nexport interface OnTaskAfterUpdateTopicParams {\n    input: ITaskUpdateData;\n    task: ITaskData;\n}\n\nexport interface OnTaskBeforeDeleteTopicParams {\n    task: ITaskData;\n}\n\nexport interface OnTaskAfterDeleteTopicParams {\n    task: ITaskData;\n}\n\nexport interface ITaskLogCreateInput {\n    executionName: string;\n    iteration: number;\n}\n\nexport interface ITaskLogUpdateInput {\n    items: ITaskLogItem[];\n}\n\nexport interface ITasksContextCrudObject {\n    /**\n     * Models\n     */\n    getTaskModel: () => Promise<CmsModel>;\n    getLogModel: () => Promise<CmsModel>;\n    /**\n     * Tasks\n     */\n    getTask: <T = any>(id: string) => Promise<IGetTaskResponse<T> | null>;\n    listTasks: <T = any>(params?: IListTaskParams) => Promise<IListTasksResponse<T>>;\n    createTask: <T = any>(task: ITaskCreateData<T>) => Promise<ICreateTaskResponse<T>>;\n    updateTask: <T = any>(\n        id: string,\n        data: Partial<ITaskUpdateData<T>>\n    ) => Promise<IUpdateTaskResponse<T>>;\n    deleteTask: (id: string) => Promise<IDeleteTaskResponse>;\n    /**\n     * Logs\n     */\n    createLog: (task: Pick<ITaskData, \"id\">, data: ITaskLogCreateInput) => Promise<ITaskLog>;\n    updateLog: (id: string, data: ITaskLogUpdateInput) => Promise<ITaskLog>;\n    getLog: (id: string) => Promise<ITaskLog | null>;\n    getLatestLog: (taskId: string) => Promise<ITaskLog>;\n    listLogs: (params: IListTaskLogParams) => Promise<IListTaskLogsResponse>;\n    /**\n     * Lifecycle events.\n     */\n    onTaskBeforeCreate: Topic<OnTaskBeforeCreateTopicParams>;\n    onTaskAfterCreate: Topic<OnTaskAfterCreateTopicParams>;\n    onTaskBeforeUpdate: Topic<OnTaskBeforeUpdateTopicParams>;\n    onTaskAfterUpdate: Topic<OnTaskAfterUpdateTopicParams>;\n    onTaskBeforeDelete: Topic<OnTaskBeforeDeleteTopicParams>;\n    onTaskAfterDelete: Topic<OnTaskAfterDeleteTopicParams>;\n}\n\nexport interface ITasksContextConfigObject {\n    config: ITaskConfig;\n}\n\nexport interface ITasksContextDefinitionObject {\n    getDefinition: <T = ITaskDataInput>(id: string) => ITaskDefinition<Context, T> | null;\n    listDefinitions: () => ITaskDefinition[];\n}\n\nexport interface ITaskTriggerParams<T = ITaskDataInput> {\n    definition: string;\n    name?: string;\n    input?: T;\n}\n\nexport interface ITaskAbortParams {\n    id: string;\n    message?: string;\n}\n\nexport interface ITasksContextTriggerObject {\n    trigger: <T = ITaskDataInput>(params: ITaskTriggerParams<T>) => Promise<ITaskData<T>>;\n    abort: <T = ITaskDataInput>(params: ITaskAbortParams) => Promise<ITaskData<T>>;\n}\n\nexport interface ITasksContextObject\n    extends ITasksContextCrudObject,\n        ITasksContextDefinitionObject,\n        ITasksContextTriggerObject,\n        ITasksContextConfigObject {}\n\nexport interface Context extends BaseContext {\n    tasks: ITasksContextObject;\n}\n\nexport interface ITaskRunParams<C extends Context, I = any> {\n    context: C;\n    response: ITaskResponse;\n    isCloseToTimeout: () => boolean;\n    isAborted: () => boolean;\n    input: I;\n    store: ITaskManagerStore;\n}\n\nexport interface ITaskSuccessParams<C extends Context, I = any> {\n    context: C;\n    input: I;\n}\n\nexport interface ITaskErrorParams<C extends Context, I = any> {\n    context: C;\n    input: I;\n}\n\nexport enum TaskResponseStatus {\n    DONE = \"done\",\n    ERROR = \"error\",\n    CONTINUE = \"continue\",\n    ABORTED = \"aborted\"\n}\n\nexport type ITaskDefinitionField = Pick<\n    CmsModelField,\n    | \"fieldId\"\n    | \"type\"\n    | \"label\"\n    | \"renderer\"\n    | \"helpText\"\n    | \"placeholderText\"\n    | \"predefinedValues\"\n    | \"validation\"\n    | \"listValidation\"\n    | \"multipleValues\"\n    | \"settings\"\n>;\n\nexport interface ITaskBeforeTriggerParams<C extends Context = Context, I = ITaskDataInput> {\n    context: C;\n    input: I;\n}\n\nexport interface ITaskDefinition<C extends Context = Context, I = ITaskDataInput> {\n    /**\n     * ID of the task must be unique in the system.\n     * It should be in camelCase format, for example: \"myCustomTask\".\n     */\n    id: string;\n    /**\n     * Name should be unique, as it will get used to identify the task in the UI.\n     */\n    title: string;\n    /**\n     * A description of the task, for the UI.\n     */\n    description?: string;\n    /**\n     * Task run method.\n     */\n    run: (params: ITaskRunParams<C, I>) => Promise<ITaskResponseResult>;\n    /**\n     * When a new task is about to be triggered, we will run this method.\n     * For example, you can use this method to check if there is a task of the same type already running.\n     */\n    onBeforeTrigger?: <T = ITaskDataInput>(params: ITaskBeforeTriggerParams<C, T>) => Promise<void>;\n    /**\n     * When task successfully finishes, this method will be called.\n     */\n    onDone?: (params: ITaskSuccessParams<C, I>) => Promise<void>;\n    /**\n     * When task fails, this method will be called.\n     */\n    onError?: (params: ITaskErrorParams<C, I>) => Promise<void>;\n    /**\n     * Custom input fields and layout for the task input.\n     */\n    fields?: ITaskDefinitionField[];\n}\n\nexport interface TaskPermission extends SecurityPermission {\n    name: \"task\";\n    rwd?: string;\n}\n"],"mappings":";;;;;;;;;;;AAaA,IAAAA,aAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,aAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAH,MAAA,CAAAI,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAC,YAAA,EAAAJ,GAAA;EAAA,IAAAA,GAAA,IAAAK,OAAA,IAAAA,OAAA,CAAAL,GAAA,MAAAL,aAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAS,cAAA,CAAAD,OAAA,EAAAL,GAAA;IAAAO,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAb,aAAA,CAAAK,GAAA;IAAA;EAAA;AAAA;AACA,IAAAS,cAAA,GAAAb,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAW,cAAA,EAAAV,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAH,MAAA,CAAAI,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAC,YAAA,EAAAJ,GAAA;EAAA,IAAAA,GAAA,IAAAK,OAAA,IAAAA,OAAA,CAAAL,GAAA,MAAAS,cAAA,CAAAT,GAAA;EAAAH,MAAA,CAAAS,cAAA,CAAAD,OAAA,EAAAL,GAAA;IAAAO,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAC,cAAA,CAAAT,GAAA;IAAA;EAAA;AAAA;AAAsC,IAU1BU,gBAAgB,0BAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAA,OAAhBA,gBAAgB;AAAA;AAAAL,OAAA,CAAAK,gBAAA,GAAAA,gBAAA;AAAA,IAwChBC,cAAc,0BAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAA,OAAdA,cAAc;AAAA;AAAAN,OAAA,CAAAM,cAAA,GAAAA,cAAA;AAAA,IAmMdC,kBAAkB,0BAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAA,OAAlBA,kBAAkB;AAAA;AAAAP,OAAA,CAAAO,kBAAA,GAAAA,kBAAA"}