@squiz/job-runner-lib 1.66.1

package/lib/domains/job/core/pagination/services/PaginationService.spec.js

@@ -0,0 +1,179 @@
+"use strict";
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const en_1 = require("@faker-js/faker/locale/en");
+const Job_mock_1 = require("../../../model/Job/mocks/Job.mock");
+const JobContext_mock_1 = require("../../../model/JobContext/mocks/JobContext.mock");
+const JobExecution_mock_1 = require("../../../model/JobExecution/mocks/JobExecution.mock");
+const InternalServerError_1 = require("../../../errors/InternalServerError");
+const Repository_constants_1 = require("../../../constants/Repository.constants");
+const PaginationTypes_1 = require("../model/PaginationTypes");
+const PaginationUtils_1 = require("../utils/PaginationUtils");
+const PaginationService_1 = require("./PaginationService");
+describe('PaginationService', () => {
+    let jobRepository;
+    let jobContextRepository;
+    let jobExecutionRepository;
+    let paginationService;
+    const mockConvertToDynamoDbItemJob = jest.fn();
+    const mockConvertToDynamoDbItemContext = jest.fn();
+    const mockConvertToDynamoDbItemExecution = jest.fn();
+    beforeAll(() => {
+        jobRepository = {
+            create: jest.fn(),
+            findOne: jest.fn(),
+            list: jest.fn(),
+            update: jest.fn(),
+            delete: jest.fn(),
+            getJobs: jest.fn(),
+            convertToDynamoDbItem: mockConvertToDynamoDbItemJob,
+        };
+        jobContextRepository = {
+            create: jest.fn(),
+            findOne: jest.fn(),
+            list: jest.fn(),
+            update: jest.fn(),
+            delete: jest.fn(),
+            getContexts: jest.fn(),
+            getJobs: jest.fn(),
+            convertToDynamoDbItem: mockConvertToDynamoDbItemContext,
+        };
+        jobExecutionRepository = {
+            create: jest.fn(),
+            findOne: jest.fn(),
+            list: jest.fn(),
+            update: jest.fn(),
+            delete: jest.fn(),
+            getJobs: jest.fn(),
+            convertToDynamoDbItem: mockConvertToDynamoDbItemExecution,
+        };
+        paginationService = new PaginationService_1.PaginationService(jobRepository, jobContextRepository, jobExecutionRepository);
+    });
+    describe('addPaginationLinksToResponse', () => {
+        let mockType;
+        let mockData;
+        let mockPaginationInfo;
+        let mockExclusiveStartKey;
+        let mockLastEvaluatedKey;
+        beforeEach(() => {
+            jest.resetAllMocks();
+            mockType = Repository_constants_1.PARTITION_KEYS.job;
+            mockPaginationInfo = {
+                direction: PaginationTypes_1.PAGINATION_DIRECTION_TYPE_AFTER,
+                limit: 20,
+                requestUrl: 'mockUrl',
+                token: 'mockToken',
+            };
+            mockExclusiveStartKey = {
+                pk: { S: 'mockPk' },
+                sk: { S: 'mockSk' },
+            };
+        });
+        it('should return a full page of items including links', () => {
+            mockData = Array.from({ length: en_1.faker.number.int({ min: 1, max: mockPaginationInfo.limit - 1 }) }).map((_, i) => ({
+                type: mockType,
+                pk: `mockPk${i}`,
+                sk: `mockSk${i}`,
+            }));
+            mockConvertToDynamoDbItemJob
+                .mockImplementationOnce(() => {
+                return mockExclusiveStartKey;
+            })
+                .mockImplementationOnce(() => {
+                return mockExclusiveStartKey;
+            });
+            const response = paginationService.addPaginationLinksToResponse(mockData, mockPaginationInfo, mockPaginationInfo.token);
+            expect(mockConvertToDynamoDbItemJob).toBeCalledTimes(1);
+            expect(response.data).toStrictEqual(mockData);
+            expect(response.links).toBeTruthy();
+            expect(response.links.prev).toContain(encodeURIComponent((0, PaginationUtils_1.encodeTokenString)(mockExclusiveStartKey)));
+            expect(response.links.next).toContain(mockPaginationInfo.token);
+        });
+        it('should return a page of items with `null` links when the data is less than the limit', () => {
+            mockData = Array.from({
+                length: en_1.faker.number.int({
+                    min: 1,
+                    max: mockPaginationInfo.limit - 1,
+                }),
+            }).map((_, i) => ({ type: mockType, i }));
+            mockConvertToDynamoDbItemJob.mockImplementationOnce(() => mockExclusiveStartKey);
+            const response = paginationService.addPaginationLinksToResponse(mockData, { ...mockPaginationInfo, token: null }, null);
+            expect(mockConvertToDynamoDbItemJob).not.toBeCalled();
+            expect(response.data).toStrictEqual(mockData);
+            expect(response.links).toBeTruthy();
+            expect(response.links.prev).toBeNull();
+            expect(response.links.next).toBeNull();
+        });
+        it('should return a page of items with non-null previous links when the data is less than the limit but request included a token', () => {
+            mockData = Array.from({
+                length: en_1.faker.number.int({
+                    min: 1,
+                    max: mockPaginationInfo.limit - 1,
+                }),
+            }).map((_, i) => ({ type: mockType, i }));
+            mockConvertToDynamoDbItemJob.mockImplementationOnce(() => mockExclusiveStartKey);
+            const response = paginationService.addPaginationLinksToResponse(mockData, mockPaginationInfo, mockLastEvaluatedKey);
+            expect(mockConvertToDynamoDbItemJob).toBeCalledTimes(1);
+            expect(response.data).toStrictEqual(mockData);
+            expect(response.links).toBeTruthy();
+            expect(response.links.prev).toBeTruthy();
+            expect(response.links.next).toBeNull();
+        });
+        it('should reverse the data appropriately when paginating in reverse', () => {
+            mockData = Array.from({
+                length: en_1.faker.number.int({
+                    min: 1,
+                    max: mockPaginationInfo.limit - 1,
+                }),
+            }).map((_, i) => ({ type: mockType, i }));
+            mockConvertToDynamoDbItemJob.mockImplementationOnce(() => mockExclusiveStartKey);
+            const response = paginationService.addPaginationLinksToResponse(mockData, { ...mockPaginationInfo, direction: PaginationTypes_1.PAGINATION_DIRECTION_TYPE_BEFORE }, mockLastEvaluatedKey);
+            expect(mockConvertToDynamoDbItemJob).toBeCalledTimes(1);
+            expect(response.data).toStrictEqual(mockData.reverse());
+            expect(response.links).toBeTruthy();
+        });
+        it('should only return the limited number of items even if DB contains more', () => {
+            mockData = Array.from({
+                length: en_1.faker.number.int({
+                    min: mockPaginationInfo.limit + 1,
+                    max: mockPaginationInfo.limit * 2,
+                }),
+            }).map((_, i) => ({ type: mockType, i }));
+            mockConvertToDynamoDbItemJob
+                .mockImplementationOnce(() => mockExclusiveStartKey)
+                .mockImplementationOnce(() => mockExclusiveStartKey);
+            const response = paginationService.addPaginationLinksToResponse(mockData, mockPaginationInfo, mockLastEvaluatedKey);
+            expect(mockConvertToDynamoDbItemJob).toBeCalledTimes(2);
+            expect(response.data).toHaveLength(mockPaginationInfo.limit);
+            expect(response.links).toBeTruthy();
+        });
+    });
+    describe('convertToDynamoDbItem', () => {
+        beforeEach(() => {
+            jest.resetAllMocks();
+        });
+        it('should call the jobRepository method for converting to a DynamoDB object', () => {
+            const mockJob = (0, Job_mock_1.createMockJob)();
+            paginationService.convertToDynamoDbItem(mockJob);
+            expect(mockConvertToDynamoDbItemJob).toBeCalled();
+        });
+        it('should call the jobContextRepository method for converting to a DynamoDB object', () => {
+            const mockJobContext = (0, JobContext_mock_1.createMockJobContext)();
+            paginationService.convertToDynamoDbItem(mockJobContext);
+            expect(mockConvertToDynamoDbItemContext).toBeCalled();
+        });
+        it('should call the jobExecutionRepository method for converting to a DynamoDB object', () => {
+            const mockJobExecution = (0, JobExecution_mock_1.createMockJobExecution)();
+            paginationService.convertToDynamoDbItem(mockJobExecution);
+            expect(mockConvertToDynamoDbItemExecution).toBeCalled();
+        });
+        it('should should throw an error if the partition key is invalid', () => {
+            const mockItem = { type: 'invalid' };
+            expect(() => paginationService.convertToDynamoDbItem(mockItem)).toThrowError(InternalServerError_1.InternalServerError);
+        });
+    });
+});
+//# sourceMappingURL=PaginationService.spec.js.map

package/lib/domains/job/core/pagination/services/PaginationService.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PaginationService.spec.js","sourceRoot":"","sources":["../../../../../../src/domains/job/core/pagination/services/PaginationService.spec.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AAGH,kDAAkD;AAClD,gEAAkE;AAClE,qFAAuF;AACvF,2FAA6F;AAC7F,6EAA0E;AAC1E,kFAAuF;AAEvF,8DAA6G;AAC7G,8DAA6D;AAC7D,2DAAwD;AAGxD,QAAQ,CAAC,mBAAmB,EAAE,GAAS,EAAE;IACvC,IAAI,aAAqC,CAAC;IAC1C,IAAI,oBAA4C,CAAC;IACjD,IAAI,sBAA8C,CAAC;IACnD,IAAI,iBAAyC,CAAC;IAE9C,MAAM,4BAA4B,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAC/C,MAAM,gCAAgC,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IACnD,MAAM,kCAAkC,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAErD,SAAS,CAAC,GAAS,EAAE;QACnB,aAAa,GAAG;YACd,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE;YACjB,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE;YAClB,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;YACf,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE;YACjB,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE;YAEjB,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE;YAClB,qBAAqB,EAAE,4BAA4B;SACpD,CAAC;QAEF,oBAAoB,GAAG;YACrB,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE;YACjB,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE;YAClB,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;YACf,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE;YACjB,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE;YACjB,WAAW,EAAE,IAAI,CAAC,EAAE,EAAE;YAEtB,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE;YAClB,qBAAqB,EAAE,gCAAgC;SACxD,CAAC;QAEF,sBAAsB,GAAG;YACvB,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE;YACjB,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE;YAClB,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;YACf,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE;YACjB,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE;YAEjB,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE;YAClB,qBAAqB,EAAE,kCAAkC;SAC1D,CAAC;QAEF,iBAAiB,GAAG,IAAI,qCAAiB,CACvC,aAAyC,EACzC,oBAAuD,EACvD,sBAA2D,CAC5D,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,8BAA8B,EAAE,GAAS,EAAE;QAClD,IAAI,QAAsB,CAAC;QAC3B,IAAI,QAAQ,CAAC;QACb,IAAI,kBAAkC,CAAC;QACvC,IAAI,qBAAqD,CAAC;QAC1D,IAAI,oBAAmC,CAAC;QAExC,UAAU,CAAC,GAAG,EAAE;YACd,IAAI,CAAC,aAAa,EAAE,CAAC;YAErB,QAAQ,GAAG,qCAAc,CAAC,GAAG,CAAC;YAE9B,kBAAkB,GAAG;gBACnB,SAAS,EAAE,iDAA+B;gBAC1C,KAAK,EAAE,EAAE;gBACT,UAAU,EAAE,SAAS;gBACrB,KAAK,EAAE,WAAW;aACnB,CAAC;YAEF,qBAAqB,GAAG;gBACtB,EAAE,EAAE,EAAE,CAAC,EAAE,QAAQ,EAAE;gBACnB,EAAE,EAAE,EAAE,CAAC,EAAE,QAAQ,EAAE;aACpB,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oDAAoD,EAAE,GAAS,EAAE;YAClE,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,UAAK,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,CACpG,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;gBACT,IAAI,EAAE,QAAQ;gBACd,EAAE,EAAE,SAAS,CAAC,EAAE;gBAChB,EAAE,EAAE,SAAS,CAAC,EAAE;aACjB,CAAC,CACH,CAAC;YAEF,4BAA4B;iBACzB,sBAAsB,CAAC,GAAG,EAAE;gBAC3B,OAAO,qBAAqB,CAAC;YAC/B,CAAC,CAAC;iBACD,sBAAsB,CAAC,GAAG,EAAE;gBAC3B,OAAO,qBAAqB,CAAC;YAC/B,CAAC,CAAC,CAAC;YAEL,MAAM,QAAQ,GAAG,iBAAiB,CAAC,4BAA4B,CAC7D,QAAQ,EACR,kBAAkB,EAClB,kBAAkB,CAAC,KAAK,CACzB,CAAC;YAEF,MAAM,CAAC,4BAA4B,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;YACxD,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YAE9C,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,CAAC;YACpC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAA,mCAAiB,EAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YACpG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAClE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sFAAsF,EAAE,GAAS,EAAE;YACpG,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC;gBACpB,MAAM,EAAE,UAAK,CAAC,MAAM,CAAC,GAAG,CAAC;oBACvB,GAAG,EAAE,CAAC;oBACN,GAAG,EAAE,kBAAkB,CAAC,KAAK,GAAG,CAAC;iBAClC,CAAC;aACH,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YAE1C,4BAA4B,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC,CAAC;YAEjF,MAAM,QAAQ,GAAG,iBAAiB,CAAC,4BAA4B,CAC7D,QAAQ,EACR,EAAE,GAAG,kBAAkB,EAAE,KAAK,EAAE,IAAI,EAAE,EACtC,IAAI,CACL,CAAC;YAEF,MAAM,CAAC,4BAA4B,CAAC,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC;YACtD,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YAC9C,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,CAAC;YACpC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;YACvC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8HAA8H,EAAE,GAAS,EAAE;YAC5I,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC;gBACpB,MAAM,EAAE,UAAK,CAAC,MAAM,CAAC,GAAG,CAAC;oBACvB,GAAG,EAAE,CAAC;oBACN,GAAG,EAAE,kBAAkB,CAAC,KAAK,GAAG,CAAC;iBAClC,CAAC;aACH,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YAE1C,4BAA4B,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC,CAAC;YAEjF,MAAM,QAAQ,GAAG,iBAAiB,CAAC,4BAA4B,CAC7D,QAAQ,EACR,kBAAkB,EAClB,oBAAoB,CACrB,CAAC;YAEF,MAAM,CAAC,4BAA4B,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;YACxD,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YAC9C,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,CAAC;YACpC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;YACzC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kEAAkE,EAAE,GAAS,EAAE;YAChF,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC;gBACpB,MAAM,EAAE,UAAK,CAAC,MAAM,CAAC,GAAG,CAAC;oBACvB,GAAG,EAAE,CAAC;oBACN,GAAG,EAAE,kBAAkB,CAAC,KAAK,GAAG,CAAC;iBAClC,CAAC;aACH,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YAE1C,4BAA4B,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC,CAAC;YAEjF,MAAM,QAAQ,GAAG,iBAAiB,CAAC,4BAA4B,CAC7D,QAAQ,EACR,EAAE,GAAG,kBAAkB,EAAE,SAAS,EAAE,kDAAgC,EAAE,EACtE,oBAAoB,CACrB,CAAC;YAEF,MAAM,CAAC,4BAA4B,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;YACxD,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;YACxD,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,CAAC;QACtC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yEAAyE,EAAE,GAAS,EAAE;YACvF,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC;gBACpB,MAAM,EAAE,UAAK,CAAC,MAAM,CAAC,GAAG,CAAC;oBACvB,GAAG,EAAE,kBAAkB,CAAC,KAAK,GAAG,CAAC;oBACjC,GAAG,EAAE,kBAAkB,CAAC,KAAK,GAAG,CAAC;iBAClC,CAAC;aACH,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YAE1C,4BAA4B;iBACzB,sBAAsB,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC;iBACnD,sBAAsB,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC,CAAC;YAEvD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,4BAA4B,CAC7D,QAAQ,EACR,kBAAkB,EAClB,oBAAoB,CACrB,CAAC;YAEF,MAAM,CAAC,4BAA4B,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;YACxD,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC7D,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,CAAC;QACtC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,uBAAuB,EAAE,GAAS,EAAE;QAC3C,UAAU,CAAC,GAAG,EAAE;YACd,IAAI,CAAC,aAAa,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,0EAA0E,EAAE,GAAS,EAAE;YACxF,MAAM,OAAO,GAAG,IAAA,wBAAa,GAAE,CAAC;YAE/B,iBAAyB,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;YAC1D,MAAM,CAAC,4BAA4B,CAAC,CAAC,UAAU,EAAE,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iFAAiF,EAAE,GAAS,EAAE;YAC/F,MAAM,cAAc,GAAG,IAAA,sCAAoB,GAAE,CAAC;YAE7C,iBAAyB,CAAC,qBAAqB,CAAC,cAAc,CAAC,CAAC;YACjE,MAAM,CAAC,gCAAgC,CAAC,CAAC,UAAU,EAAE,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mFAAmF,EAAE,GAAS,EAAE;YACjG,MAAM,gBAAgB,GAAG,IAAA,0CAAsB,GAAE,CAAC;YAEjD,iBAAyB,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;YACnE,MAAM,CAAC,kCAAkC,CAAC,CAAC,UAAU,EAAE,CAAC;QAC1D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8DAA8D,EAAE,GAAS,EAAE;YAC5E,MAAM,QAAQ,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;YACrC,MAAM,CAAC,GAAG,EAAE,CAAE,iBAAyB,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,yCAAmB,CAAC,CAAC;QAC7G,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/domains/job/core/pagination/services/index.d.ts

@@ -0,0 +1 @@
+export * from './PaginationService';

package/lib/domains/job/core/pagination/services/index.js

@@ -0,0 +1,18 @@
+"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("./PaginationService"), exports);
+//# sourceMappingURL=index.js.map

package/lib/domains/job/core/pagination/services/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../src/domains/job/core/pagination/services/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC"}

package/lib/domains/job/core/pagination/utils/PaginationUtils.d.ts

@@ -0,0 +1,48 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+import { AttributeValue } from '@aws-sdk/client-dynamodb';
+import { PageQuery } from '../model/PageQuery';
+import { PaginationInfo } from '../model/PaginationInfo';
+import { PaginationLinks, PaginationTokens } from '../model/PaginationLinks';
+import { PaginationFormattedResponse, PaginationResponse } from '../model/PaginationResponse';
+/**
+ * Decode the token string included in a pagination query parameter.
+ * @param {string} token A base64 encoded token string.
+ * @returns {Record<string, AttributeValue>} The decoded token item.
+ */
+export declare const decodeTokenString: (token: string) => Record<string, AttributeValue>;
+/**
+ * Convert a DynamoDB LastEvaluatedKey into a base64 encoded token string.
+ * @param {SettingsPrimaryKey} lastEvaluatedKey The LastEvaluatedKey returned from a dynamo query.
+ * @returns {string} The encoded string.
+ */
+export declare const encodeTokenString: <T>(lastEvaluatedKey: T) => string;
+/**
+ * Get the pagination info from the page query param.
+ * @param {string} requestUrl The URL for the request.
+ * @param {PageQuery} page The page query param object.
+ * @returns {PaginationInfo} The pagination info.
+ */
+export declare const getPaginationInfo: (requestUrl: string, page: PageQuery) => PaginationInfo;
+/**
+ * Generate the pagination links for a response.
+ * @param {string} requestUrl The URL of the request.
+ * @param {PaginationTokens} tokens The next/prev tokens.
+ * @returns {PaginationLinks} The pagination links.
+ */
+export declare const getPaginationLinks: (requestUrl: string, tokens: PaginationTokens) => PaginationLinks;
+/**
+ * Remove specified query params from a URL string.
+ * @param {Array<string>} keys The keys for each param to remove.
+ * @param {string} requestUrl The URL of the request.
+ * @returns {string} The updated URL.
+ */
+export declare const removeParamsByName: (keys: Array<string>, requestUrl: string) => string;
+/**
+ * Validate token corresponds to a valid DynamoDB primary key.
+ * @param {string | null} token The token to validate.
+ */
+export declare const validateTokenHasCorrectFormat: (token: string | null) => void;
+export declare const getFormattedResponse: <T>(results: PaginationResponse<T>) => PaginationFormattedResponse<T>;

package/lib/domains/job/core/pagination/utils/PaginationUtils.js

@@ -0,0 +1,139 @@
+"use strict";
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFormattedResponse = exports.validateTokenHasCorrectFormat = exports.removeParamsByName = exports.getPaginationLinks = exports.getPaginationInfo = exports.encodeTokenString = exports.decodeTokenString = void 0;
+const QueryParams_1 = require("../../../constants/QueryParams");
+const errors_1 = require("../../../errors");
+const PaginationTypes_1 = require("../model/PaginationTypes");
+/**
+ * Decode the token string included in a pagination query parameter.
+ * @param {string} token A base64 encoded token string.
+ * @returns {Record<string, AttributeValue>} The decoded token item.
+ */
+const decodeTokenString = (token) => {
+    try {
+        return JSON.parse(Buffer.from(token, 'base64').toString());
+    }
+    catch (e) {
+        throw new errors_1.BadRequestError(errors_1.ERROR_MESSAGES.paginationInvalidToken);
+    }
+};
+exports.decodeTokenString = decodeTokenString;
+/**
+ * Convert a DynamoDB LastEvaluatedKey into a base64 encoded token string.
+ * @param {SettingsPrimaryKey} lastEvaluatedKey The LastEvaluatedKey returned from a dynamo query.
+ * @returns {string} The encoded string.
+ */
+const encodeTokenString = (lastEvaluatedKey) => {
+    try {
+        return Buffer.from(JSON.stringify(lastEvaluatedKey)).toString('base64');
+    }
+    catch (e) {
+        throw new errors_1.InternalServerError(errors_1.ERROR_MESSAGES.paginationEncodeFailed);
+    }
+};
+exports.encodeTokenString = encodeTokenString;
+/**
+ * Get the pagination info from the page query param.
+ * @param {string} requestUrl The URL for the request.
+ * @param {PageQuery} page The page query param object.
+ * @returns {PaginationInfo} The pagination info.
+ */
+const getPaginationInfo = (requestUrl, page) => {
+    const { after, before, size } = page;
+    if (after && before) {
+        throw new errors_1.BadRequestError(errors_1.ERROR_MESSAGES.paginationOnlyOneDirection);
+    }
+    let token = null;
+    if (after) {
+        token = decodeURIComponent(after);
+    }
+    else if (before) {
+        token = decodeURIComponent(before);
+    }
+    (0, exports.validateTokenHasCorrectFormat)(token);
+    return {
+        direction: before ? PaginationTypes_1.PAGINATION_DIRECTION_TYPE_BEFORE : PaginationTypes_1.PAGINATION_DIRECTION_TYPE_AFTER,
+        limit: size !== null && size !== void 0 ? size : PaginationTypes_1.PaginationPageLimit.large,
+        requestUrl: decodeURIComponent(requestUrl),
+        token,
+    };
+};
+exports.getPaginationInfo = getPaginationInfo;
+/**
+ * Generate the pagination links for a response.
+ * @param {string} requestUrl The URL of the request.
+ * @param {PaginationTokens} tokens The next/prev tokens.
+ * @returns {PaginationLinks} The pagination links.
+ */
+const getPaginationLinks = (requestUrl, tokens) => {
+    let { next, prev } = tokens;
+    let basePaginationUrl = requestUrl.replace(/\/api/g, '');
+    basePaginationUrl = (0, exports.removeParamsByName)([QueryParams_1.QUERY.PAGE.AFTER, QueryParams_1.QUERY.PAGE.BEFORE], basePaginationUrl);
+    if (basePaginationUrl.indexOf('?') !== -1) {
+        next = next ? `${basePaginationUrl}&${QueryParams_1.QUERY.PAGE.AFTER}=${next}` : null;
+        prev = prev ? `${basePaginationUrl}&${QueryParams_1.QUERY.PAGE.BEFORE}=${prev}` : null;
+    }
+    else {
+        next = next ? `${basePaginationUrl}?${QueryParams_1.QUERY.PAGE.AFTER}=${next}` : null;
+        prev = prev ? `${basePaginationUrl}?${QueryParams_1.QUERY.PAGE.BEFORE}=${prev}` : null;
+    }
+    return {
+        next,
+        prev,
+    };
+};
+exports.getPaginationLinks = getPaginationLinks;
+/**
+ * Remove specified query params from a URL string.
+ * @param {Array<string>} keys The keys for each param to remove.
+ * @param {string} requestUrl The URL of the request.
+ * @returns {string} The updated URL.
+ */
+const removeParamsByName = (keys, requestUrl) => {
+    let result = requestUrl.split('?')[0];
+    const queryString = requestUrl.indexOf('?') !== -1 ? requestUrl.split('?')[1] : '';
+    if (queryString !== '') {
+        const params = queryString.split('&');
+        for (let i = params.length - 1; i >= 0; i -= 1) {
+            const param = params[i].split('=')[0];
+            if (keys.indexOf(param) !== -1) {
+                params.splice(i, 1);
+            }
+        }
+        if (params.length) {
+            result = result + '?' + params.join('&');
+        }
+    }
+    return result;
+};
+exports.removeParamsByName = removeParamsByName;
+/**
+ * Validate token corresponds to a valid DynamoDB primary key.
+ * @param {string | null} token The token to validate.
+ */
+const validateTokenHasCorrectFormat = (token) => {
+    if (token === null) {
+        return;
+    }
+    const decodedToken = (0, exports.decodeTokenString)(token);
+    if (!decodedToken.pk || !decodedToken.sk) {
+        throw new errors_1.BadRequestError(errors_1.ERROR_MESSAGES.paginationInvalidToken);
+    }
+};
+exports.validateTokenHasCorrectFormat = validateTokenHasCorrectFormat;
+const getFormattedResponse = (results) => {
+    const { links, data } = results;
+    const response = { data };
+    if (links) {
+        if (links.next || links.prev) {
+            response.links = links;
+        }
+    }
+    return response;
+};
+exports.getFormattedResponse = getFormattedResponse;
+//# sourceMappingURL=PaginationUtils.js.map

package/lib/domains/job/core/pagination/utils/PaginationUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PaginationUtils.js","sourceRoot":"","sources":["../../../../../../src/domains/job/core/pagination/utils/PaginationUtils.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,gEAAuD;AACvD,4CAAuF;AAKvF,8DAIkC;AAElC;;;;GAIG;AACI,MAAM,iBAAiB,GAAG,CAAC,KAAa,EAAkC,EAAE;IACjF,IAAI;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;KAC5D;IAAC,OAAO,CAAC,EAAE;QACV,MAAM,IAAI,wBAAe,CAAC,uBAAc,CAAC,sBAAsB,CAAC,CAAC;KAClE;AACH,CAAC,CAAC;AANW,QAAA,iBAAiB,qBAM5B;AAEF;;;;GAIG;AACI,MAAM,iBAAiB,GAAG,CAAI,gBAAmB,EAAU,EAAE;IAClE,IAAI;QACF,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;KACzE;IAAC,OAAO,CAAC,EAAE;QACV,MAAM,IAAI,4BAAmB,CAAC,uBAAc,CAAC,sBAAsB,CAAC,CAAC;KACtE;AACH,CAAC,CAAC;AANW,QAAA,iBAAiB,qBAM5B;AAEF;;;;;GAKG;AACI,MAAM,iBAAiB,GAAG,CAAC,UAAkB,EAAE,IAAe,EAAkB,EAAE;IACvF,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IAErC,IAAI,KAAK,IAAI,MAAM,EAAE;QACnB,MAAM,IAAI,wBAAe,CAAC,uBAAc,CAAC,0BAA0B,CAAC,CAAC;KACtE;IAED,IAAI,KAAK,GAAkB,IAAI,CAAC;IAChC,IAAI,KAAK,EAAE;QACT,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;KACnC;SAAM,IAAI,MAAM,EAAE;QACjB,KAAK,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;KACpC;IAED,IAAA,qCAA6B,EAAC,KAAK,CAAC,CAAC;IAErC,OAAO;QACL,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,kDAAgC,CAAC,CAAC,CAAC,iDAA+B;QACtF,KAAK,EAAE,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,qCAAmB,CAAC,KAAK;QACxC,UAAU,EAAE,kBAAkB,CAAC,UAAU,CAAC;QAC1C,KAAK;KACN,CAAC;AACJ,CAAC,CAAC;AAtBW,QAAA,iBAAiB,qBAsB5B;AAEF;;;;;GAKG;AACI,MAAM,kBAAkB,GAAG,CAAC,UAAkB,EAAE,MAAwB,EAAmB,EAAE;IAClG,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;IAE5B,IAAI,iBAAiB,GAAG,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACzD,iBAAiB,GAAG,IAAA,0BAAkB,EAAC,CAAC,mBAAK,CAAC,IAAI,CAAC,KAAK,EAAE,mBAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,iBAAiB,CAAC,CAAC;IAEjG,IAAI,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE;QACzC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,iBAAiB,IAAI,mBAAK,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QACxE,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,iBAAiB,IAAI,mBAAK,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;KAC1E;SAAM;QACL,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,iBAAiB,IAAI,mBAAK,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QACxE,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,iBAAiB,IAAI,mBAAK,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;KAC1E;IAED,OAAO;QACL,IAAI;QACJ,IAAI;KACL,CAAC;AACJ,CAAC,CAAC;AAlBW,QAAA,kBAAkB,sBAkB7B;AAEF;;;;;GAKG;AACI,MAAM,kBAAkB,GAAG,CAAC,IAAmB,EAAE,UAAkB,EAAU,EAAE;IACpF,IAAI,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACtC,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAEnF,IAAI,WAAW,KAAK,EAAE,EAAE;QACtB,MAAM,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEtC,KAAK,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE;YAC9C,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YACtC,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE;gBAC9B,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;aACrB;SACF;QAED,IAAI,MAAM,CAAC,MAAM,EAAE;YACjB,MAAM,GAAG,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAC1C;KACF;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AApBW,QAAA,kBAAkB,sBAoB7B;AAEF;;;GAGG;AACI,MAAM,6BAA6B,GAAG,CAAC,KAAoB,EAAQ,EAAE;IAC1E,IAAI,KAAK,KAAK,IAAI,EAAE;QAClB,OAAO;KACR;IAED,MAAM,YAAY,GAAG,IAAA,yBAAiB,EAAC,KAAK,CAAC,CAAC;IAC9C,IAAI,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE;QACxC,MAAM,IAAI,wBAAe,CAAC,uBAAc,CAAC,sBAAsB,CAAC,CAAC;KAClE;AACH,CAAC,CAAC;AATW,QAAA,6BAA6B,iCASxC;AAEK,MAAM,oBAAoB,GAAG,CAAI,OAA8B,EAAkC,EAAE;IACxG,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAEhC,MAAM,QAAQ,GAAmC,EAAE,IAAI,EAAE,CAAC;IAE1D,IAAI,KAAK,EAAE;QACT,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE;YAC5B,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC;SACxB;KACF;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAZW,QAAA,oBAAoB,wBAY/B"}

package/lib/domains/job/core/pagination/utils/PaginationUtils.spec.d.ts

@@ -0,0 +1,5 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+export {};

package/lib/domains/job/core/pagination/utils/PaginationUtils.spec.js

@@ -0,0 +1,212 @@
+"use strict";
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const en_1 = require("@faker-js/faker/locale/en");
+const QueryParams_1 = require("../../../constants/QueryParams");
+const BadRequestError_1 = require("../../../errors/BadRequestError");
+const InternalServerError_1 = require("../../../errors/InternalServerError");
+const PaginationTypes_1 = require("../model/PaginationTypes");
+const PaginationUtils_1 = require("./PaginationUtils");
+const mockToken = 'eyJwayI6eyJTIjoiZm9vIn0sInNrIjp7IlMiOiJiYXIifX0=';
+const mockPrimaryKey = {
+    pk: { S: 'foo' },
+    sk: { S: 'bar' },
+};
+describe('PaginationUtils', () => {
+    describe('decodeTokenString', () => {
+        it('should decode a valid token string', () => {
+            const result = (0, PaginationUtils_1.decodeTokenString)(mockToken);
+            expect(result).toStrictEqual(mockPrimaryKey);
+        });
+        it('should throw a BadRequestError if decode fails', () => {
+            const mockBadToken = '';
+            expect(() => {
+                (0, PaginationUtils_1.decodeTokenString)(mockBadToken);
+            }).toThrow(BadRequestError_1.BadRequestError);
+        });
+    });
+    describe('encodeTokenString', () => {
+        it('should encode a valid key', () => {
+            const result = (0, PaginationUtils_1.encodeTokenString)(mockPrimaryKey);
+            expect(result).toStrictEqual(mockToken);
+        });
+        it('should throw a InternalServerError if encode fails', () => {
+            const mockBadKey = undefined;
+            expect(() => {
+                (0, PaginationUtils_1.encodeTokenString)(mockBadKey);
+            }).toThrow(InternalServerError_1.InternalServerError);
+        });
+    });
+    describe('getPaginationInfo', () => {
+        let mockPageQuery;
+        let mockPageSize;
+        let mockRequestUrl;
+        beforeEach(() => {
+            mockPageSize = en_1.faker.helpers.arrayElement([20, 50, 100]);
+            mockRequestUrl = en_1.faker.internet.url();
+            mockPageQuery = {
+                after: mockToken,
+                size: mockPageSize,
+            };
+        });
+        it('should handle page[after] and page[size] params', () => {
+            const result = (0, PaginationUtils_1.getPaginationInfo)(mockRequestUrl, mockPageQuery);
+            expect(result).toStrictEqual({
+                direction: PaginationTypes_1.PAGINATION_DIRECTION_TYPE_AFTER,
+                limit: mockPageSize,
+                requestUrl: mockRequestUrl,
+                token: mockToken,
+            });
+        });
+        it('should handle page[before] and page[size] params', () => {
+            mockPageQuery.after = undefined;
+            mockPageQuery.before = mockToken;
+            const result = (0, PaginationUtils_1.getPaginationInfo)(mockRequestUrl, mockPageQuery);
+            expect(result).toStrictEqual({
+                direction: PaginationTypes_1.PAGINATION_DIRECTION_TYPE_BEFORE,
+                limit: mockPageSize,
+                requestUrl: mockRequestUrl,
+                token: mockToken,
+            });
+        });
+        it('should fallback to default limit if page[size] not defined', () => {
+            mockPageQuery.size = undefined;
+            const result = (0, PaginationUtils_1.getPaginationInfo)(mockRequestUrl, mockPageQuery);
+            expect(result.limit).toBe(100);
+        });
+        describe('Error handling', () => {
+            it('should throw a BadRequestError if both page[before] and page[after] are present in the request', () => {
+                mockPageQuery.before = mockToken;
+                expect(() => {
+                    (0, PaginationUtils_1.getPaginationInfo)(mockRequestUrl, mockPageQuery);
+                }).toThrow(BadRequestError_1.BadRequestError);
+            });
+        });
+    });
+    describe('getPaginationLinks', () => {
+        let mockRequestUrl;
+        let mockNextToken;
+        let mockPrevToken;
+        let mockTokens;
+        let mockPageAfterParam;
+        let mockPageBeforeParam;
+        beforeEach(() => {
+            mockRequestUrl = en_1.faker.internet.url();
+            mockNextToken = 'mockNextToken';
+            mockPrevToken = 'mockPrevToken';
+            mockTokens = {
+                next: mockNextToken,
+                prev: mockPrevToken,
+            };
+            mockPageAfterParam = `${QueryParams_1.QUERY.PAGE.AFTER}=${mockNextToken}`;
+            mockPageBeforeParam = `${QueryParams_1.QUERY.PAGE.BEFORE}=${mockPrevToken}`;
+        });
+        it('should handle a request URL with no other parameters', () => {
+            const result = (0, PaginationUtils_1.getPaginationLinks)(`${mockRequestUrl}/api`, mockTokens);
+            expect(result).toStrictEqual({
+                next: `${mockRequestUrl}?${mockPageAfterParam}`,
+                prev: `${mockRequestUrl}?${mockPageBeforeParam}`,
+            });
+        });
+        it('should handle a request URL with other query parameters', () => {
+            const mockSizeParam = `${QueryParams_1.QUERY.PAGE.SIZE}=50`;
+            const result = (0, PaginationUtils_1.getPaginationLinks)(`${mockRequestUrl}/api?${mockSizeParam}`, mockTokens);
+            expect(result).toStrictEqual({
+                next: `${mockRequestUrl}?${mockSizeParam}&${mockPageAfterParam}`,
+                prev: `${mockRequestUrl}?${mockSizeParam}&${mockPageBeforeParam}`,
+            });
+        });
+        it('should replace page[before] and/or page[after] request params with new tokens', () => {
+            const mockRequestAfterBeforeParams = `${QueryParams_1.QUERY.PAGE.AFTER}=mockRequestAfter&${QueryParams_1.QUERY.PAGE.BEFORE}=mockRequestBefore`;
+            const result = (0, PaginationUtils_1.getPaginationLinks)(`${mockRequestUrl}/api?${mockRequestAfterBeforeParams}`, mockTokens);
+            expect(result).toStrictEqual({
+                next: `${mockRequestUrl}?${mockPageAfterParam}`,
+                prev: `${mockRequestUrl}?${mockPageBeforeParam}`,
+            });
+        });
+        it('should handle null tokens', () => {
+            mockTokens = {
+                next: null,
+                prev: null,
+            };
+            const mockQueryParam = `${QueryParams_1.QUERY.PAGE.SIZE}=50`;
+            const result1 = (0, PaginationUtils_1.getPaginationLinks)(`${mockRequestUrl}/api?${mockQueryParam}`, mockTokens);
+            expect(result1).toStrictEqual({
+                next: null,
+                prev: null,
+            });
+            const result2 = (0, PaginationUtils_1.getPaginationLinks)(`${mockRequestUrl}/api`, mockTokens);
+            expect(result2).toStrictEqual({
+                next: null,
+                prev: null,
+            });
+        });
+    });
+    describe('validateTokenHasCorrectFormat', () => {
+        it('should not throw error for a valid token', () => {
+            expect(() => {
+                (0, PaginationUtils_1.validateTokenHasCorrectFormat)(mockToken);
+            }).not.toThrow();
+        });
+        it('should not throw error for a `null` token', () => {
+            expect(() => {
+                (0, PaginationUtils_1.validateTokenHasCorrectFormat)(null);
+            }).not.toThrow(BadRequestError_1.BadRequestError);
+        });
+        it('should throw a BadRequestError for an invalid token', () => {
+            const badToken1 = 'eyJzayI6InNrIn0='; // missing pk
+            const badToken2 = 'eyJwayI6InBrIn0='; // missing sk
+            expect(() => {
+                (0, PaginationUtils_1.validateTokenHasCorrectFormat)(badToken1);
+            }).toThrow(BadRequestError_1.BadRequestError);
+            expect(() => {
+                (0, PaginationUtils_1.validateTokenHasCorrectFormat)(badToken2);
+            }).toThrow(BadRequestError_1.BadRequestError);
+        });
+    });
+    describe('getFormattedResponse', () => {
+        let mockNextToken;
+        let mockPrevToken;
+        let mockTokens;
+        let mockLength;
+        let mockData;
+        beforeEach(() => {
+            mockNextToken = 'mockNextToken';
+            mockPrevToken = 'mockPrevToken';
+            mockTokens = {
+                next: mockNextToken,
+                prev: mockPrevToken,
+            };
+            mockLength = en_1.faker.number.int({ min: 1, max: 5 });
+            mockData = Array.from({ length: mockLength }).reduce((acc, _curr) => {
+                return {
+                    ...acc,
+                    [en_1.faker.lorem.word()]: en_1.faker.lorem.words(),
+                };
+            }, {});
+        });
+        it('should add links to the final formatted response', () => {
+            const response = (0, PaginationUtils_1.getFormattedResponse)({
+                links: mockTokens,
+                data: [mockData],
+            });
+            expect(response.data[0]).toBe(mockData);
+            expect(response.links).toBe(mockTokens);
+        });
+        it('should not add links to the final formatted response if not present', () => {
+            const response = (0, PaginationUtils_1.getFormattedResponse)({
+                links: {
+                    next: null,
+                    prev: null,
+                },
+                data: [mockData],
+            });
+            expect(response.data[0]).toBe(mockData);
+            expect(response).not.toHaveProperty('links');
+        });
+    });
+});
+//# sourceMappingURL=PaginationUtils.spec.js.map

package/lib/domains/job/core/pagination/utils/PaginationUtils.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PaginationUtils.spec.js","sourceRoot":"","sources":["../../../../../../src/domains/job/core/pagination/utils/PaginationUtils.spec.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AAEH,kDAAkD;AAClD,gEAAuD;AACvD,qEAAkE;AAClE,6EAA0E;AAC1E,8DAA6G;AAC7G,uDAO2B;AAG3B,MAAM,SAAS,GAAG,kDAAkD,CAAC;AACrE,MAAM,cAAc,GAAG;IACrB,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE;IAChB,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE;CACjB,CAAC;AAEF,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC5C,MAAM,MAAM,GAAG,IAAA,mCAAiB,EAAC,SAAS,CAAC,CAAC;YAC5C,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YACxD,MAAM,YAAY,GAAG,EAAE,CAAC;YAExB,MAAM,CAAC,GAAG,EAAE;gBACV,IAAA,mCAAiB,EAAC,YAAY,CAAC,CAAC;YAClC,CAAC,CAAC,CAAC,OAAO,CAAC,iCAAe,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;YACnC,MAAM,MAAM,GAAG,IAAA,mCAAiB,EAAC,cAAc,CAAC,CAAC;YACjD,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC5D,MAAM,UAAU,GAAG,SAAS,CAAC;YAE7B,MAAM,CAAC,GAAG,EAAE;gBACV,IAAA,mCAAiB,EAAC,UAAU,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC,OAAO,CAAC,yCAAmB,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,IAAI,aAA0D,CAAC;QAC/D,IAAI,YAAoB,CAAC;QACzB,IAAI,cAAsB,CAAC;QAE3B,UAAU,CAAC,GAAG,EAAE;YACd,YAAY,GAAG,UAAK,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;YACzD,cAAc,GAAG,UAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;YAEtC,aAAa,GAAG;gBACd,KAAK,EAAE,SAAS;gBAChB,IAAI,EAAE,YAAY;aACnB,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YACzD,MAAM,MAAM,GAAG,IAAA,mCAAiB,EAAC,cAAc,EAAE,aAAa,CAAC,CAAC;YAChE,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;gBAC3B,SAAS,EAAE,iDAA+B;gBAC1C,KAAK,EAAE,YAAY;gBACnB,UAAU,EAAE,cAAc;gBAC1B,KAAK,EAAE,SAAS;aACjB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,aAAa,CAAC,KAAK,GAAG,SAAS,CAAC;YAChC,aAAa,CAAC,MAAM,GAAG,SAAS,CAAC;YAEjC,MAAM,MAAM,GAAG,IAAA,mCAAiB,EAAC,cAAc,EAAE,aAAa,CAAC,CAAC;YAChE,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;gBAC3B,SAAS,EAAE,kDAAgC;gBAC3C,KAAK,EAAE,YAAY;gBACnB,UAAU,EAAE,cAAc;gBAC1B,KAAK,EAAE,SAAS;aACjB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;YACpE,aAAa,CAAC,IAAI,GAAG,SAAS,CAAC;YAE/B,MAAM,MAAM,GAAG,IAAA,mCAAiB,EAAC,cAAc,EAAE,aAAa,CAAC,CAAC;YAChE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;YAC9B,EAAE,CAAC,gGAAgG,EAAE,GAAG,EAAE;gBACxG,aAAa,CAAC,MAAM,GAAG,SAAS,CAAC;gBAEjC,MAAM,CAAC,GAAG,EAAE;oBACV,IAAA,mCAAiB,EAAC,cAAc,EAAE,aAAa,CAAC,CAAC;gBACnD,CAAC,CAAC,CAAC,OAAO,CAAC,iCAAe,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,IAAI,cAAsB,CAAC;QAC3B,IAAI,aAAa,CAAC;QAClB,IAAI,aAAa,CAAC;QAElB,IAAI,UAA2B,CAAC;QAEhC,IAAI,kBAA0B,CAAC;QAC/B,IAAI,mBAA2B,CAAC;QAEhC,UAAU,CAAC,GAAG,EAAE;YACd,cAAc,GAAG,UAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;YACtC,aAAa,GAAG,eAAe,CAAC;YAChC,aAAa,GAAG,eAAe,CAAC;YAEhC,UAAU,GAAG;gBACX,IAAI,EAAE,aAAa;gBACnB,IAAI,EAAE,aAAa;aACpB,CAAC;YAEF,kBAAkB,GAAG,GAAG,mBAAK,CAAC,IAAI,CAAC,KAAK,IAAI,aAAa,EAAE,CAAC;YAC5D,mBAAmB,GAAG,GAAG,mBAAK,CAAC,IAAI,CAAC,MAAM,IAAI,aAAa,EAAE,CAAC;QAChE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;YAC9D,MAAM,MAAM,GAAG,IAAA,oCAAkB,EAAC,GAAG,cAAc,MAAM,EAAE,UAAU,CAAC,CAAC;YACvE,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;gBAC3B,IAAI,EAAE,GAAG,cAAc,IAAI,kBAAkB,EAAE;gBAC/C,IAAI,EAAE,GAAG,cAAc,IAAI,mBAAmB,EAAE;aACjD,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;YACjE,MAAM,aAAa,GAAG,GAAG,mBAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC;YAE9C,MAAM,MAAM,GAAG,IAAA,oCAAkB,EAAC,GAAG,cAAc,QAAQ,aAAa,EAAE,EAAE,UAAU,CAAC,CAAC;YACxF,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;gBAC3B,IAAI,EAAE,GAAG,cAAc,IAAI,aAAa,IAAI,kBAAkB,EAAE;gBAChE,IAAI,EAAE,GAAG,cAAc,IAAI,aAAa,IAAI,mBAAmB,EAAE;aAClE,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+EAA+E,EAAE,GAAG,EAAE;YACvF,MAAM,4BAA4B,GAAG,GAAG,mBAAK,CAAC,IAAI,CAAC,KAAK,qBAAqB,mBAAK,CAAC,IAAI,CAAC,MAAM,oBAAoB,CAAC;YAEnH,MAAM,MAAM,GAAG,IAAA,oCAAkB,EAAC,GAAG,cAAc,QAAQ,4BAA4B,EAAE,EAAE,UAAU,CAAC,CAAC;YACvG,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;gBAC3B,IAAI,EAAE,GAAG,cAAc,IAAI,kBAAkB,EAAE;gBAC/C,IAAI,EAAE,GAAG,cAAc,IAAI,mBAAmB,EAAE;aACjD,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;YACnC,UAAU,GAAG;gBACX,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE,IAAI;aACX,CAAC;YAEF,MAAM,cAAc,GAAG,GAAG,mBAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC;YAE/C,MAAM,OAAO,GAAG,IAAA,oCAAkB,EAAC,GAAG,cAAc,QAAQ,cAAc,EAAE,EAAE,UAAU,CAAC,CAAC;YAC1F,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;gBAC5B,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE,IAAI;aACX,CAAC,CAAC;YAEH,MAAM,OAAO,GAAG,IAAA,oCAAkB,EAAC,GAAG,cAAc,MAAM,EAAE,UAAU,CAAC,CAAC;YACxE,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;gBAC5B,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE,IAAI;aACX,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;QAC7C,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;YAClD,MAAM,CAAC,GAAG,EAAE;gBACV,IAAA,+CAA6B,EAAC,SAAS,CAAC,CAAC;YAC3C,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACnD,MAAM,CAAC,GAAG,EAAE;gBACV,IAAA,+CAA6B,EAAC,IAAI,CAAC,CAAC;YACtC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,iCAAe,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;YAC7D,MAAM,SAAS,GAAG,kBAAkB,CAAC,CAAC,aAAa;YACnD,MAAM,SAAS,GAAG,kBAAkB,CAAC,CAAC,aAAa;YAEnD,MAAM,CAAC,GAAG,EAAE;gBACV,IAAA,+CAA6B,EAAC,SAAS,CAAC,CAAC;YAC3C,CAAC,CAAC,CAAC,OAAO,CAAC,iCAAe,CAAC,CAAC;YAE5B,MAAM,CAAC,GAAG,EAAE;gBACV,IAAA,+CAA6B,EAAC,SAAS,CAAC,CAAC;YAC3C,CAAC,CAAC,CAAC,OAAO,CAAC,iCAAe,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QACpC,IAAI,aAAa,CAAC;QAClB,IAAI,aAAa,CAAC;QAElB,IAAI,UAA2B,CAAC;QAEhC,IAAI,UAAU,CAAC;QACf,IAAI,QAAgB,CAAC;QAErB,UAAU,CAAC,GAAG,EAAE;YACd,aAAa,GAAG,eAAe,CAAC;YAChC,aAAa,GAAG,eAAe,CAAC;YAEhC,UAAU,GAAG;gBACX,IAAI,EAAE,aAAa;gBACnB,IAAI,EAAE,aAAa;aACpB,CAAC;YAEF,UAAU,GAAG,UAAK,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;YAClD,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAA2B,EAAE,KAAK,EAAE,EAAE;gBAC1F,OAAO;oBACL,GAAG,GAAG;oBACN,CAAC,UAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,UAAK,CAAC,KAAK,CAAC,KAAK,EAAE;iBAC1C,CAAC;YACJ,CAAC,EAAE,EAAE,CAAC,CAAC;QACT,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kDAAkD,EAAE,GAAS,EAAE;YAChE,MAAM,QAAQ,GAAG,IAAA,sCAAoB,EAAM;gBACzC,KAAK,EAAE,UAAU;gBACjB,IAAI,EAAE,CAAC,QAAQ,CAAC;aACjB,CAAC,CAAC;YACH,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qEAAqE,EAAE,GAAS,EAAE;YACnF,MAAM,QAAQ,GAAG,IAAA,sCAAoB,EAAM;gBACzC,KAAK,EAAE;oBACL,IAAI,EAAE,IAAI;oBACV,IAAI,EAAE,IAAI;iBACX;gBACD,IAAI,EAAE,CAAC,QAAQ,CAAC;aACjB,CAAC,CAAC;YACH,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/domains/job/core/pagination/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './PaginationUtils';