@squiz/job-runner-lib 1.66.1

package/lib/domains/job/model/JobExecution/JobExecution.d.ts

@@ -0,0 +1,189 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+import { JobExecutionStatus } from '../../constants/JobExecutionStatus.constants';
+import { JobExecutionPk } from '../../constants/Repository.constants';
+import { AttributeValue } from '@aws-sdk/client-dynamodb';
+/**
+ * JobExecution interface.
+ * @export
+ * @interface JobExecution
+ */
+export interface JobExecution {
+    /**
+     * The id of the job execution.
+     * @type {string}
+     * @memberof JobExecution
+     */
+    id: string;
+    /**
+     * The name of the job.
+     * @type {string}
+     * @memberof JobExecution
+     */
+    jobName: string;
+    /**
+     * The id of the context to run the job against.
+     * @type {string}
+     * @memberof JobExecution
+     */
+    context: string;
+    /**
+     * The status of the job run.
+     * @type {string}
+     * @memberof JobExecution
+     */
+    status: JobExecutionStatus;
+    /**
+     * The time the job execution was added to the queue.
+     * @type {string}
+     * @memberof JobExecution
+     */
+    timeQueued: string;
+    /**
+     * The version of the job script to execute.
+     * @type {(string)}
+     * @memberof JobExecution
+     */
+    version: string;
+    /**
+     * The ECS task ID of the job run.
+     * @type {(string | null)}
+     * @memberof JobExecution
+     */
+    ecsTaskId: string | null;
+    /**
+     * The time the job run was started.
+     * @type {(string | null)}
+     * @memberof JobExecution
+     */
+    timeStarted: string | null;
+    /**
+     * The time the job run was finished.
+     * @type {(string | null)}
+     * @memberof JobExecution
+     */
+    timeFinished: string | null;
+    /**
+     * The input to the job.
+     * @type {any}
+     * @memberof JobExecution
+     */
+    input: any;
+    /**
+     * The DynamoDB record type (dynamic, 'jobExecution-<jobName>').
+     * @type {JobExecutionPk}
+     * @memberof JobExecution
+     */
+    type: JobExecutionPk;
+}
+/**
+ * The JobExecution record attributes stored in DynamoDB.
+ * @export
+ * @interface JobExecutionRecord
+ */
+export interface JobExecutionRecord {
+    /**
+     * The partition key (dynamic, 'jobExecution-<jobName>').
+     * @type {JobExecutionPk}
+     * @memberof JobExecutionRecord
+     */
+    pk: JobExecutionPk;
+    /**
+     * The sort key ('timeQueued-id').
+     * @type {string}
+     * @memberof JobExecutionRecord
+     */
+    sk: string;
+    /**
+     * The name of the job to execute.
+     * @type {string}
+     * @memberof JobExecutionRecord
+     */
+    jobName: string;
+    /**
+     * The id of the job execution.
+     * @type {string}
+     * @memberof JobExecutionRecord
+     */
+    id: string;
+    /**
+     * The time the job execution was added to the queue.
+     * @type {string}
+     * @memberof JobExecutionRecord
+     */
+    timeQueued: string;
+    /**
+     * The id of the context to run the job against.
+     * @type {string}
+     * @memberof JobExecutionRecord
+     */
+    context: string;
+    /**
+     * The status of the job run.
+     * @type {JobExecutionStatus}
+     * @memberof JobExecutionRecord
+     */
+    status: JobExecutionStatus;
+    /**
+     * The version of the job script to execute.
+     * @type @type {(string)}
+     * @memberof JobExecutionRecord
+     */
+    version: string;
+    /**
+     * The ECS task ID of the job run.
+     * @type @type {(string | null)}
+     * @memberof JobExecutionRecord
+     */
+    ecsTaskId: string | null;
+    /**
+     * The time the job run was started.
+     * @type @type {(string | null)}
+     * @memberof JobExecutionRecord
+     */
+    timeStarted: string | null;
+    /**
+     * The time the job run was finished.
+     * @type {(string | null)}
+     * @memberof JobExecutionRecord
+     */
+    timeFinished: string | null;
+    /**
+     * The input to the job.
+     * @type {any}
+     * @memberof JobExecutionRecord
+     */
+    input: any;
+}
+export type JobExecutionDto = Record<keyof JobExecutionRecord, AttributeValue>;
+/**
+ * The request body for adding an item to the job queue (POST /job/begin).
+ * @export
+ */
+export type BeginJobExecutionRequest = Pick<JobExecution, 'jobName' | 'context'> & Partial<Pick<JobExecution, 'input'>>;
+/**
+ * The parameters for creating a job execution entity in the DB.
+ * @export
+ */
+export type CreateJobExecutionRequest = Pick<JobExecution, 'jobName' | 'version' | 'context'> & Partial<Pick<JobExecution, 'input'>>;
+/**
+ * The request body for terminating a job in the job queue (POST /job/terminate).
+ * @export
+ */
+export interface TerminateJobExecutionRequest {
+    jobName: string;
+    executionId: string;
+    reason: string;
+}
+/**
+ * The parameters for listing job executions.
+ * @export
+ */
+export type ListJobExecutionParameters = Partial<Pick<JobExecution, 'jobName' | 'status'>>;
+/**
+ * The parameters for updating job executions.
+ * @export
+ */
+export type UpdateJobExecutionParameters = Partial<Omit<JobExecution, 'id' | 'jobName' | 'timeQueued' | 'type'>>;

package/lib/domains/job/model/JobExecution/JobExecution.js

@@ -0,0 +1,7 @@
+"use strict";
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=JobExecution.js.map

package/lib/domains/job/model/JobExecution/JobExecution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JobExecution.js","sourceRoot":"","sources":["../../../../../src/domains/job/model/JobExecution/JobExecution.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/lib/domains/job/model/JobExecution/index.d.ts

@@ -0,0 +1,5 @@
+export * from './JobExecution';
+export * from './mocks/JobExecution.mock';
+export * from './mocks/JobExecutionDto.mock';
+export * from './mocks/JobExecutionRecord.mock';
+export * from './mocks/JobExecutionRequest.mock';

package/lib/domains/job/model/JobExecution/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./JobExecution"), exports);
+__exportStar(require("./mocks/JobExecution.mock"), exports);
+__exportStar(require("./mocks/JobExecutionDto.mock"), exports);
+__exportStar(require("./mocks/JobExecutionRecord.mock"), exports);
+__exportStar(require("./mocks/JobExecutionRequest.mock"), exports);
+//# sourceMappingURL=index.js.map

package/lib/domains/job/model/JobExecution/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/domains/job/model/JobExecution/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B;AAC/B,4DAA0C;AAC1C,+DAA6C;AAC7C,kEAAgD;AAChD,mEAAiD"}

package/lib/domains/job/model/JobExecution/mocks/JobExecution.mock.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+import { JobExecution } from '../JobExecution';
+export declare const createMockJobExecution: (partialRecord?: Partial<JobExecution>) => JobExecution;
+export declare const createMockJobExecutions: (size?: number) => Array<JobExecution>;

package/lib/domains/job/model/JobExecution/mocks/JobExecution.mock.js

@@ -0,0 +1,45 @@
+"use strict";
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMockJobExecutions = exports.createMockJobExecution = void 0;
+const JobExecutionStatus_constants_1 = require("../../../constants/JobExecutionStatus.constants");
+const Repository_constants_1 = require("../../../constants/Repository.constants");
+const en_1 = require("@faker-js/faker/locale/en");
+const createMockJobExecution = (partialRecord = {}) => {
+    const version = Array.from({ length: 3 })
+        .map(() => en_1.faker.number.int())
+        .join('.');
+    const input = en_1.faker.helpers.arrayElement([
+        en_1.faker.datatype.boolean(),
+        en_1.faker.lorem.word(),
+        en_1.faker.number.int(),
+        { [en_1.faker.lorem.word()]: en_1.faker.lorem.words() },
+        null,
+    ]);
+    const jobName = en_1.faker.lorem.word();
+    const timeQueued = new Date().toISOString();
+    return {
+        context: en_1.faker.string.uuid(),
+        ecsTaskId: null,
+        id: `${timeQueued}-${en_1.faker.string.uuid()}`,
+        jobName,
+        status: JobExecutionStatus_constants_1.JOB_EXECUTION_STATUS.queued,
+        timeFinished: null,
+        timeQueued,
+        timeStarted: null,
+        type: `${Repository_constants_1.PARTITION_KEYS.jobExecution}-${jobName}`,
+        version,
+        input,
+        ...partialRecord,
+    };
+};
+exports.createMockJobExecution = createMockJobExecution;
+const createMockJobExecutions = (size) => {
+    const randomSize = size !== null && size !== void 0 ? size : en_1.faker.number.int({ max: 3, min: 1 });
+    return Array.from({ length: randomSize }).map(() => (0, exports.createMockJobExecution)());
+};
+exports.createMockJobExecutions = createMockJobExecutions;
+//# sourceMappingURL=JobExecution.mock.js.map

package/lib/domains/job/model/JobExecution/mocks/JobExecution.mock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JobExecution.mock.js","sourceRoot":"","sources":["../../../../../../src/domains/job/model/JobExecution/mocks/JobExecution.mock.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kGAAuF;AACvF,kFAAyE;AACzE,kDAAkD;AAG3C,MAAM,sBAAsB,GAAG,CAAC,gBAAuC,EAAE,EAAgB,EAAE;IAChG,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;SACtC,GAAG,CAAC,GAAG,EAAE,CAAC,UAAK,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;SAC7B,IAAI,CAAC,GAAG,CAAC,CAAC;IACb,MAAM,KAAK,GAAG,UAAK,CAAC,OAAO,CAAC,YAAY,CAAC;QACvC,UAAK,CAAC,QAAQ,CAAC,OAAO,EAAE;QACxB,UAAK,CAAC,KAAK,CAAC,IAAI,EAAE;QAClB,UAAK,CAAC,MAAM,CAAC,GAAG,EAAE;QAClB,EAAE,CAAC,UAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,UAAK,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE;QAC7C,IAAI;KACL,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,UAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IACnC,MAAM,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAC5C,OAAO;QACL,OAAO,EAAE,UAAK,CAAC,MAAM,CAAC,IAAI,EAAE;QAC5B,SAAS,EAAE,IAAI;QACf,EAAE,EAAE,GAAG,UAAU,IAAI,UAAK,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE;QAC1C,OAAO;QACP,MAAM,EAAE,mDAAoB,CAAC,MAAM;QACnC,YAAY,EAAE,IAAI;QAClB,UAAU;QACV,WAAW,EAAE,IAAI;QACjB,IAAI,EAAE,GAAG,qCAAc,CAAC,YAAY,IAAI,OAAO,EAAE;QACjD,OAAO;QACP,KAAK;QACL,GAAG,aAAa;KACjB,CAAC;AACJ,CAAC,CAAC;AA3BW,QAAA,sBAAsB,0BA2BjC;AAEK,MAAM,uBAAuB,GAAG,CAAC,IAAa,EAAuB,EAAE;IAC5E,MAAM,UAAU,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,UAAK,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;IAChE,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAA,8BAAsB,GAAE,CAAC,CAAC;AAChF,CAAC,CAAC;AAHW,QAAA,uBAAuB,2BAGlC"}

package/lib/domains/job/model/JobExecution/mocks/JobExecutionDto.mock.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+import { JobExecutionDto, JobExecutionRecord } from '../JobExecution';
+export declare const createMockJobExecutionDto: (partialRecord?: Partial<JobExecutionRecord>) => JobExecutionDto;
+export declare const createMockJobExecutionDtos: (size?: number) => Array<JobExecutionDto>;

package/lib/domains/job/model/JobExecution/mocks/JobExecutionDto.mock.js

@@ -0,0 +1,64 @@
+"use strict";
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMockJobExecutionDtos = exports.createMockJobExecutionDto = void 0;
+const JobExecutionStatus_constants_1 = require("../../../constants/JobExecutionStatus.constants");
+const Repository_constants_1 = require("../../../constants/Repository.constants");
+const en_1 = require("@faker-js/faker/locale/en");
+const createMockJobExecutionDto = (partialRecord = {}) => {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+    const jobName = en_1.faker.lorem.word();
+    const timeQueued = en_1.faker.date.recent().toISOString();
+    const id = `${timeQueued}-${en_1.faker.string.uuid()}`;
+    const version = Array.from({ length: 3 })
+        .map(() => en_1.faker.number.int())
+        .join('.');
+    const input = en_1.faker.helpers.arrayElement([
+        en_1.faker.datatype.boolean(),
+        en_1.faker.lorem.word(),
+        en_1.faker.number.int(),
+        { [en_1.faker.lorem.word()]: en_1.faker.lorem.words },
+        null,
+        undefined,
+    ]);
+    return {
+        context: {
+            S: (_a = partialRecord.context) !== null && _a !== void 0 ? _a : en_1.faker.string.uuid(),
+        },
+        ecsTaskId: partialRecord.ecsTaskId ? { S: partialRecord.ecsTaskId } : { NULL: true },
+        id: {
+            S: (_b = partialRecord.id) !== null && _b !== void 0 ? _b : id,
+        },
+        jobName: {
+            S: (_c = partialRecord.jobName) !== null && _c !== void 0 ? _c : jobName,
+        },
+        pk: {
+            S: (_d = partialRecord.pk) !== null && _d !== void 0 ? _d : `${Repository_constants_1.PARTITION_KEYS.jobExecution}-${(_e = partialRecord.jobName) !== null && _e !== void 0 ? _e : jobName}`,
+        },
+        sk: {
+            S: (_f = partialRecord.sk) !== null && _f !== void 0 ? _f : `${timeQueued}-${id}`,
+        },
+        status: {
+            S: (_g = partialRecord.status) !== null && _g !== void 0 ? _g : en_1.faker.helpers.arrayElement(Object.values(JobExecutionStatus_constants_1.JOB_EXECUTION_STATUS)),
+        },
+        timeFinished: partialRecord.timeFinished ? { S: partialRecord.timeFinished } : { NULL: true },
+        timeQueued: {
+            S: (_h = partialRecord.timeQueued) !== null && _h !== void 0 ? _h : timeQueued,
+        },
+        timeStarted: partialRecord.timeStarted ? { S: partialRecord.timeStarted } : { NULL: true },
+        version: {
+            S: (_j = partialRecord.version) !== null && _j !== void 0 ? _j : version,
+        },
+        input: input ? { S: JSON.stringify(input) } : { NULL: true },
+    };
+};
+exports.createMockJobExecutionDto = createMockJobExecutionDto;
+const createMockJobExecutionDtos = (size) => {
+    const randomSize = size !== null && size !== void 0 ? size : en_1.faker.number.int({ max: 3, min: 1 });
+    return Array.from({ length: randomSize }).map(() => (0, exports.createMockJobExecutionDto)());
+};
+exports.createMockJobExecutionDtos = createMockJobExecutionDtos;
+//# sourceMappingURL=JobExecutionDto.mock.js.map

package/lib/domains/job/model/JobExecution/mocks/JobExecutionDto.mock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JobExecutionDto.mock.js","sourceRoot":"","sources":["../../../../../../src/domains/job/model/JobExecution/mocks/JobExecutionDto.mock.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kGAAuF;AACvF,kFAAyE;AACzE,kDAAkD;AAG3C,MAAM,yBAAyB,GAAG,CAAC,gBAA6C,EAAE,EAAmB,EAAE;;IAC5G,MAAM,OAAO,GAAG,UAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IACnC,MAAM,UAAU,GAAG,UAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC;IACrD,MAAM,EAAE,GAAG,GAAG,UAAU,IAAI,UAAK,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;IAClD,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;SACtC,GAAG,CAAC,GAAG,EAAE,CAAC,UAAK,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;SAC7B,IAAI,CAAC,GAAG,CAAC,CAAC;IACb,MAAM,KAAK,GAAG,UAAK,CAAC,OAAO,CAAC,YAAY,CAAC;QACvC,UAAK,CAAC,QAAQ,CAAC,OAAO,EAAE;QACxB,UAAK,CAAC,KAAK,CAAC,IAAI,EAAE;QAClB,UAAK,CAAC,MAAM,CAAC,GAAG,EAAE;QAClB,EAAE,CAAC,UAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,UAAK,CAAC,KAAK,CAAC,KAAK,EAAE;QAC3C,IAAI;QACJ,SAAS;KACV,CAAC,CAAC;IAEH,OAAO;QACL,OAAO,EAAE;YACP,CAAC,EAAE,MAAA,aAAa,CAAC,OAAO,mCAAI,UAAK,CAAC,MAAM,CAAC,IAAI,EAAE;SAChD;QACD,SAAS,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,aAAa,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE;QACpF,EAAE,EAAE;YACF,CAAC,EAAE,MAAA,aAAa,CAAC,EAAE,mCAAI,EAAE;SAC1B;QACD,OAAO,EAAE;YACP,CAAC,EAAE,MAAA,aAAa,CAAC,OAAO,mCAAI,OAAO;SACpC;QACD,EAAE,EAAE;YACF,CAAC,EAAE,MAAA,aAAa,CAAC,EAAE,mCAAI,GAAG,qCAAc,CAAC,YAAY,IAAI,MAAA,aAAa,CAAC,OAAO,mCAAI,OAAO,EAAE;SAC5F;QACD,EAAE,EAAE;YACF,CAAC,EAAE,MAAA,aAAa,CAAC,EAAE,mCAAI,GAAG,UAAU,IAAI,EAAE,EAAE;SAC7C;QACD,MAAM,EAAE;YACN,CAAC,EAAE,MAAA,aAAa,CAAC,MAAM,mCAAI,UAAK,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,mDAAoB,CAAC,CAAC;SAC3F;QACD,YAAY,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE;QAC7F,UAAU,EAAE;YACV,CAAC,EAAE,MAAA,aAAa,CAAC,UAAU,mCAAI,UAAU;SAC1C;QACD,WAAW,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE;QAC1F,OAAO,EAAE;YACP,CAAC,EAAE,MAAA,aAAa,CAAC,OAAO,mCAAI,OAAO;SACpC;QACD,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE;KAC7D,CAAC;AACJ,CAAC,CAAC;AA9CW,QAAA,yBAAyB,6BA8CpC;AAEK,MAAM,0BAA0B,GAAG,CAAC,IAAa,EAA0B,EAAE;IAClF,MAAM,UAAU,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,UAAK,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;IAChE,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAA,iCAAyB,GAAE,CAAC,CAAC;AACnF,CAAC,CAAC;AAHW,QAAA,0BAA0B,8BAGrC"}

package/lib/domains/job/model/JobExecution/mocks/JobExecutionRecord.mock.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+import { JobExecutionRecord } from '../JobExecution';
+export declare const createMockJobExecutionRecord: (partialRecord?: Partial<JobExecutionRecord>) => JobExecutionRecord;
+export declare const createMockJobExecutionRecords: (size?: number) => Array<JobExecutionRecord>;

package/lib/domains/job/model/JobExecution/mocks/JobExecutionRecord.mock.js

@@ -0,0 +1,48 @@
+"use strict";
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMockJobExecutionRecords = exports.createMockJobExecutionRecord = void 0;
+const JobExecutionStatus_constants_1 = require("../../../constants/JobExecutionStatus.constants");
+const Repository_constants_1 = require("../../../constants/Repository.constants");
+const en_1 = require("@faker-js/faker/locale/en");
+const createMockJobExecutionRecord = (partialRecord = {}) => {
+    const jobName = en_1.faker.lorem.word();
+    const id = en_1.faker.string.uuid();
+    const timeQueued = en_1.faker.date.recent().toISOString();
+    const version = Array.from({ length: 3 })
+        .map(() => en_1.faker.number.int())
+        .join('.');
+    const input = en_1.faker.helpers.arrayElement([
+        en_1.faker.datatype.boolean(),
+        en_1.faker.lorem.word(),
+        en_1.faker.number.int(),
+        { [en_1.faker.lorem.word()]: en_1.faker.lorem.words },
+        null,
+        undefined,
+    ]);
+    return {
+        context: en_1.faker.string.uuid(),
+        ecsTaskId: null,
+        id: id,
+        jobName: jobName,
+        pk: `${Repository_constants_1.PARTITION_KEYS.jobExecution}-${jobName}`,
+        sk: `${timeQueued}-${id}`,
+        status: en_1.faker.helpers.objectValue(JobExecutionStatus_constants_1.JOB_EXECUTION_STATUS),
+        timeFinished: null,
+        timeQueued: timeQueued,
+        timeStarted: null,
+        version,
+        input,
+        ...partialRecord,
+    };
+};
+exports.createMockJobExecutionRecord = createMockJobExecutionRecord;
+const createMockJobExecutionRecords = (size) => {
+    const randomSize = size !== null && size !== void 0 ? size : en_1.faker.number.int({ max: 3, min: 1 });
+    return Array.from({ length: randomSize }).map(() => (0, exports.createMockJobExecutionRecord)());
+};
+exports.createMockJobExecutionRecords = createMockJobExecutionRecords;
+//# sourceMappingURL=JobExecutionRecord.mock.js.map

package/lib/domains/job/model/JobExecution/mocks/JobExecutionRecord.mock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JobExecutionRecord.mock.js","sourceRoot":"","sources":["../../../../../../src/domains/job/model/JobExecution/mocks/JobExecutionRecord.mock.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kGAAuF;AACvF,kFAAyE;AACzE,kDAAkD;AAG3C,MAAM,4BAA4B,GAAG,CAAC,gBAA6C,EAAE,EAAsB,EAAE;IAClH,MAAM,OAAO,GAAG,UAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IACnC,MAAM,EAAE,GAAG,UAAK,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IAC/B,MAAM,UAAU,GAAG,UAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC;IACrD,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;SACtC,GAAG,CAAC,GAAG,EAAE,CAAC,UAAK,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;SAC7B,IAAI,CAAC,GAAG,CAAC,CAAC;IACb,MAAM,KAAK,GAAG,UAAK,CAAC,OAAO,CAAC,YAAY,CAAC;QACvC,UAAK,CAAC,QAAQ,CAAC,OAAO,EAAE;QACxB,UAAK,CAAC,KAAK,CAAC,IAAI,EAAE;QAClB,UAAK,CAAC,MAAM,CAAC,GAAG,EAAE;QAClB,EAAE,CAAC,UAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,UAAK,CAAC,KAAK,CAAC,KAAK,EAAE;QAC3C,IAAI;QACJ,SAAS;KACV,CAAC,CAAC;IAEH,OAAO;QACL,OAAO,EAAE,UAAK,CAAC,MAAM,CAAC,IAAI,EAAE;QAC5B,SAAS,EAAE,IAAI;QACf,EAAE,EAAE,EAAE;QACN,OAAO,EAAE,OAAO;QAChB,EAAE,EAAE,GAAG,qCAAc,CAAC,YAAY,IAAI,OAAO,EAAE;QAC/C,EAAE,EAAE,GAAG,UAAU,IAAI,EAAE,EAAE;QACzB,MAAM,EAAE,UAAK,CAAC,OAAO,CAAC,WAAW,CAAC,mDAAoB,CAAC;QACvD,YAAY,EAAE,IAAI;QAClB,UAAU,EAAE,UAAU;QACtB,WAAW,EAAE,IAAI;QACjB,OAAO;QACP,KAAK;QACL,GAAG,aAAa;KACjB,CAAC;AACJ,CAAC,CAAC;AA/BW,QAAA,4BAA4B,gCA+BvC;AAEK,MAAM,6BAA6B,GAAG,CAAC,IAAa,EAA6B,EAAE;IACxF,MAAM,UAAU,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,UAAK,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;IAChE,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAA,oCAA4B,GAAE,CAAC,CAAC;AACtF,CAAC,CAAC;AAHW,QAAA,6BAA6B,iCAGxC"}

package/lib/domains/job/model/JobExecution/mocks/JobExecutionRequest.mock.d.ts

@@ -0,0 +1,6 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+import { BeginJobExecutionRequest } from '../JobExecution';
+export declare const createMockBeginJobExecutionRequest: (partialRecord?: Partial<BeginJobExecutionRequest>) => BeginJobExecutionRequest;

package/lib/domains/job/model/JobExecution/mocks/JobExecutionRequest.mock.js

@@ -0,0 +1,25 @@
+"use strict";
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMockBeginJobExecutionRequest = void 0;
+const en_1 = require("@faker-js/faker/locale/en");
+const createMockBeginJobExecutionRequest = (partialRecord = {}) => {
+    const input = en_1.faker.helpers.arrayElement([
+        en_1.faker.datatype.boolean(),
+        en_1.faker.lorem.word(),
+        en_1.faker.number.int(),
+        { [en_1.faker.lorem.word()]: en_1.faker.lorem.words() },
+        null,
+    ]);
+    return {
+        context: en_1.faker.string.uuid(),
+        jobName: en_1.faker.lorem.word(),
+        input,
+        ...partialRecord,
+    };
+};
+exports.createMockBeginJobExecutionRequest = createMockBeginJobExecutionRequest;
+//# sourceMappingURL=JobExecutionRequest.mock.js.map

package/lib/domains/job/model/JobExecution/mocks/JobExecutionRequest.mock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JobExecutionRequest.mock.js","sourceRoot":"","sources":["../../../../../../src/domains/job/model/JobExecution/mocks/JobExecutionRequest.mock.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kDAAkD;AAG3C,MAAM,kCAAkC,GAAG,CAChD,gBAAmD,EAAE,EAC3B,EAAE;IAC5B,MAAM,KAAK,GAAG,UAAK,CAAC,OAAO,CAAC,YAAY,CAAC;QACvC,UAAK,CAAC,QAAQ,CAAC,OAAO,EAAE;QACxB,UAAK,CAAC,KAAK,CAAC,IAAI,EAAE;QAClB,UAAK,CAAC,MAAM,CAAC,GAAG,EAAE;QAClB,EAAE,CAAC,UAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,UAAK,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE;QAC7C,IAAI;KACL,CAAC,CAAC;IAEH,OAAO;QACL,OAAO,EAAE,UAAK,CAAC,MAAM,CAAC,IAAI,EAAE;QAC5B,OAAO,EAAE,UAAK,CAAC,KAAK,CAAC,IAAI,EAAE;QAC3B,KAAK;QACL,GAAG,aAAa;KACjB,CAAC;AACJ,CAAC,CAAC;AAjBW,QAAA,kCAAkC,sCAiB7C"}

package/lib/domains/job/repository/AbstractRepository.d.ts

@@ -0,0 +1,73 @@
+import 'reflect-metadata';
+import { AttributeValue, DynamoDBClient } from '@aws-sdk/client-dynamodb';
+import { PartitionKey } from '../constants/Repository.constants';
+import { BaseDto, BaseItem } from '../../job/model/Base/Base';
+/**
+ * Generic abstract class for representing repositories interacting with DynamoDB.
+ * @export
+ * @abstract
+ * @class Repository
+ * @template T The entity definition.
+ * @template U The corresponding DB record attributes for the entity.
+ */
+export declare abstract class Repository<T extends BaseItem, U extends BaseDto> {
+    protected dynamoDbClient: DynamoDBClient;
+    protected pk: PartitionKey;
+    protected tableName: string;
+    constructor(dynamoDbClient: DynamoDBClient);
+    /**
+     * Save item into database.
+     * @abstract
+     * @param {*} input The item to store.
+     * @returns {Promise<T>} The item stored.
+     * @memberof Repository
+     */
+    create(input: T): Promise<T>;
+    /**
+     * Get one record from database.
+     * @abstract
+     * @param {string} sk The sort key used to identify the record.
+     * @returns {Promise<T | null>} The retrieved record.
+     * @memberof Repository
+     */
+    findOne(sk: string): Promise<T | null>;
+    /**
+     * Get list of records from database.
+     * @abstract
+     * @returns {Promise<Array<T>>} The retrieved records.
+     * @memberof Repository
+     */
+    list(): Promise<Array<T>>;
+    /**
+     * Update record in database.
+     * @param {string} sk The sort key used to identify the record.
+     * @param {Partial<T>} input The (partial) record to update.
+     * @returns {Promise<T | null>} The updated record.
+     * @memberof Repository
+     */
+    update(sk: string, input: Partial<T>): Promise<T | null>;
+    /**
+     * Delete record from database.
+     * @abstract
+     * @param {string} sk The sort key used to identify the record.
+     * @returns {void}
+     * @memberof Repository
+     */
+    delete(sk: string): Promise<void>;
+    /**
+     * Convert the DynanomDB attributes of the entity into a DynamoDB item.
+     * @abstract
+     * @param {U} attributes The DynamoDB item attributes to convert.
+     * @returns {Record<keyof U, AttributeValue>} The DynamoDB record.
+     * @memberof Repository
+     */
+    protected abstract convertToDynamoDbItem(item: T): Record<keyof U, AttributeValue>;
+    /**
+     * Convert DynamoDB item to entity.
+     * @abstract
+     * @param {Record<string, AttributeValue>} record The record to convert.
+     * @returns {T} The converted entity.
+     * @memberof Repository
+     */
+    protected abstract convertToItem(record: U): T;
+}