@studyportals/sp-lurch-interface 2.14.0 → 2.14.2-1

package/tests-u/input-batches/input-batch-dto.test.ts

@@ -1,102 +0,0 @@
-import { assert } from "chai";
-import { suite, test } from "mocha-typescript";
-
-import { InputBatchDto } from "../../src/input-batches/input-batch-dto.class";
-
-
-@suite
-class InputBatchDtoTest {
-	@test
-	public constructor__TypeGuardSet() {
-		const testInstance = new InputBatchDto("", "", 0, "", 0, 0, 0, 0, 0, "");
-
-		assert.isTrue(testInstance.__i_input_batch__);
-	}
-
-	@test
-	public serialization__TypeGuardSerialized() {
-		const deserialized = JSON.parse(JSON.stringify(new InputBatchDto("", "", 0, "", 0, 0, 0, 0, 0, "")));
-
-		assert.isTrue(deserialized.__i_input_batch__);
-	}
-
-	@test
-	public serialization__IdentitySerialized() {
-		const value = "SomeValue";
-		const deserialized = JSON.parse(JSON.stringify(new InputBatchDto(value, "", 0, "", 0, 0, 0, 0, 0, "")));
-
-		assert.equal(deserialized.identity, value);
-	}
-
-	@test
-	public serialization__CreationTimeSerialized() {
-		const value = "SomeValue";
-		const deserialized = JSON.parse(JSON.stringify(new InputBatchDto("", value, 0, "", 0, 0, 0, 0, 0, "")));
-
-		assert.equal(deserialized.creationTimeIso, value);
-	}
-
-	@test
-	public serialization__StatusSerialized() {
-		const value = 0;
-		const deserialized = JSON.parse(JSON.stringify(new InputBatchDto("", "", value, "", 0, 0, 0, 0, 0, "")));
-
-		assert.equal(deserialized.status, value);
-	}
-
-	@test
-	public serialization__OrganisationIdSerialized() {
-		const value = "SomeValue";
-		const deserialized = JSON.parse(JSON.stringify(new InputBatchDto("", "", 0, value, 0, 0, 0, 0, 0, "")));
-
-		assert.equal(deserialized.organisationIdentity, value);
-	}
-
-	@test
-	public serialization__IntakeMonthSerialized() {
-		const value = 1;
-		const deserialized = JSON.parse(JSON.stringify(new InputBatchDto("", "", 0, "", value, 0, 0, 0, 0, "")));
-
-		assert.equal(deserialized.intakeMonth, value);
-	}
-
-	@test
-	public serialization__IntakeYearSerialized() {
-		const value = 1;
-		const deserialized = JSON.parse(JSON.stringify(new InputBatchDto("", "", 0, "", 0, value, 0, 0, 0, "")));
-
-		assert.equal(deserialized.intakeYear, value);
-	}
-
-	@test
-	public serialization__TargetIntakeStageTypeSerialized() {
-		const value = "SomeValue" as any;
-		const deserialized = JSON.parse(JSON.stringify(new InputBatchDto("", "", 0, "", 0, 0, value, 0, 0, "")));
-
-		assert.equal(deserialized.targetIntakeStageType, value);
-	}
-
-	@test
-	public serialization__InputSizeSerialized() {
-		const value = "SomeValue" as any;
-		const deserialized = JSON.parse(JSON.stringify(new InputBatchDto("", "", 0, "", 0, 0, 0, value, 0, "")));
-
-		assert.equal(deserialized.inputSize, value);
-	}
-
-	@test
-	public serialization__MatchesCountSerialized() {
-		const value = "SomeValue" as any;
-		const deserialized = JSON.parse(JSON.stringify(new InputBatchDto("", "", 0, "", 0, 0, 0, 0, value, "")));
-
-		assert.equal(deserialized.matchesCount, value);
-	}
-
-	@test
-	public serialization__RepresentativeIdentitySerialized() {
-		const value = "SomeValue" as any;
-		const deserialized = JSON.parse(JSON.stringify(new InputBatchDto("", "", 0, "", 0, 0, 0, 0, 0, value)));
-
-		assert.equal(deserialized.representativeIdentity, value);
-	}
-}

package/tests-u/input-batches/input-batch-status.test.ts

@@ -1,21 +0,0 @@
-import { assert } from 'chai';
-import { suite, test } from 'mocha-typescript';
-import { InputBatchStatus } from '../..';
-
-@suite
-class InputBatchStatusTest {
-	@test
-	public submitted_0() {
-		assert.equal(InputBatchStatus.SUBMITTED, 0);
-	}
-
-	@test
-	public approved_1() {
-		assert.equal(InputBatchStatus.APPROVED, 1);
-	}
-
-	@test
-	public discarded_2() {
-		assert.equal(InputBatchStatus.DISCARDED, 2);
-	}
-}

package/tests-u/intakes/intake-dto.test.ts

@@ -1,86 +0,0 @@
-import { assert } from "chai";
-import { suite, test } from "mocha-typescript";
-
-import { IntakeDto } from "../../src/intakes/intake-dto.class";
-
-
-@suite
-class IntakeDtoTest {
-	@test
-	public constructor__TypeGuardSet() {
-		const testInstance = new IntakeDto("", "", 0, 0, [], [], [], []);
-
-		assert.isTrue(testInstance.__i_intake__);
-	}
-
-	@test
-	public serialization__TypeGuardSerialized() {
-		const deserialized = JSON.parse(JSON.stringify(new IntakeDto("", "", 0, 0, [], [], [], [])));
-
-		assert.isTrue(deserialized.__i_intake__);
-	}
-
-	@test
-	public serialization__IdentitySerialized() {
-		const value = "SomeValue";
-		const deserialized = JSON.parse(JSON.stringify(new IntakeDto(value, "", 0, 0, [], [], [], [])));
-
-		assert.equal(deserialized.identity, value);
-	}
-
-	@test
-	public serialization__OrganisationIdSerialized() {
-		const value = "SomeValue";
-		const deserialized = JSON.parse(JSON.stringify(new IntakeDto("", value, 0, 0, [], [], [], [])));
-
-		assert.equal(deserialized.organisationId, value);
-	}
-
-	@test
-	public serialization__IntakeMonthSerialized() {
-		const value = 1;
-		const deserialized = JSON.parse(JSON.stringify(new IntakeDto("", "", value, 0, [], [], [], [])));
-
-		assert.equal(deserialized.intakeMonth, value);
-	}
-
-	@test
-	public serialization__IntakeYearSerialized() {
-		const value = 1;
-		const deserialized = JSON.parse(JSON.stringify(new IntakeDto("", "", 0, value, [], [], [], [])));
-
-		assert.equal(deserialized.intakeYear, value);
-	}
-
-	@test
-	public serialization__ApplicationsSerialized() {
-		const value = "SomeValue" as any;
-		const deserialized = JSON.parse(JSON.stringify(new IntakeDto("", "", 0, 0, value, [], [], [])));
-
-		assert.equal(deserialized.applications, value);
-	}
-
-	@test
-	public serialization__AcceptedSerialized() {
-		const value = "SomeValue" as any;
-		const deserialized = JSON.parse(JSON.stringify(new IntakeDto("", "", 0, 0, [], value, [], [])));
-
-		assert.equal(deserialized.accepted, value);
-	}
-
-	@test
-	public serialization__EnrolmentsSerialized() {
-		const value = "SomeValue" as any;
-		const deserialized = JSON.parse(JSON.stringify(new IntakeDto("", "", 0, 0, [], [], value, [])));
-
-		assert.equal(deserialized.enrolments, value);
-	}
-
-	@test
-	public serialization__LeadsSerialized() {
-		const value = "SomeValue" as any;
-		const deserialized = JSON.parse(JSON.stringify(new IntakeDto("", "", 0, 0, [], [], [], value)));
-
-		assert.equal(deserialized.leads, value);
-	}
-}

package/tests-u/intakes/intake-stage-type.test.ts

@@ -1,26 +0,0 @@
-import { assert } from 'chai';
-import { suite, test } from 'mocha-typescript';
-import { IntakeStageType } from '../../src/intakes/intake-stage-type';
-
-@suite
-class IntakeStageTypeTest {
-	@test
-	public application_0() {
-		assert.equal(IntakeStageType.APPLICATION, 0);
-	}
-
-	@test
-	public accepted_1() {
-		assert.equal(IntakeStageType.ACCEPTED, 1);
-	}
-
-	@test
-	public enrolment_2() {
-		assert.equal(IntakeStageType.ENROLMENT, 2);
-	}
-
-	@test
-	public lead_3() {
-		assert.equal(IntakeStageType.LEAD, 3);
-	}
-}

package/tests-u/intakes/match-dto.test.ts

@@ -1,30 +0,0 @@
-import { assert } from "chai";
-import { suite, test } from "mocha-typescript";
-
-import { MatchDto } from "../../src/intakes/match-dto.class";
-
-
-@suite
-class MatchDtoTest {
-	@test
-	public constructor__TypeGuardSet() {
-		const testInstance = new MatchDto("");
-
-		assert.isTrue(testInstance.__i_match__);
-	}
-
-	@test
-	public serialization__TypeGuardSerialized() {
-		const deserialization = JSON.parse(JSON.stringify(new MatchDto("")));
-
-		assert.isTrue(deserialization.__i_match__);
-	}
-
-	@test
-	public serialization__StudentIdSerialized() {
-		const value = "SomeValue";
-		const deserialization = JSON.parse(JSON.stringify(new MatchDto(value)));
-
-		assert.equal(deserialization.studentId, value);
-	}
-}

package/tests-u/lurch-client.test.ts

@@ -1,257 +0,0 @@
-import { assert } from "chai";
-import { suite, test } from "mocha-typescript";
-import { SuperAgentRequest } from "superagent";
-import {
-	IMock, It,
-	Mock, Times,
-} from "typemoq";
-
-import { IRequestSender, ISuperAgentRequestFactory } from "@studyportals/mb-platform-http-requests";
-
-import { LurchClient, RetrieveInputBatchesResult } from "../";
-import { OrganisationsDto } from "../src/entities/organisation/organisations-dto";
-
-
-@suite
-class LurchClientTest {
-	private mockedSuperAgentRequestFactory: IMock<ISuperAgentRequestFactory>;
-	private mockedRequest: IMock<SuperAgentRequest>;
-	private mockedRequestSender: IMock<IRequestSender>;
-	private mockedTestInstance: IMock<LurchClient>;
-
-	private get superAgentRequestFactory(): ISuperAgentRequestFactory {
-		return this.mockedSuperAgentRequestFactory.object;
-	}
-	private get request(): SuperAgentRequest {
-		return this.mockedRequest.object;
-	}
-	private get requestSender(): IRequestSender {
-		return this.mockedRequestSender.object;
-	}
-	private get testInstance(): LurchClient {
-		return this.mockedTestInstance.object;
-	}
-
-
-	public before() {
-		this.mockedSuperAgentRequestFactory = Mock.ofType<ISuperAgentRequestFactory>();
-		this.mockedRequest = Mock.ofType<SuperAgentRequest>();
-		this.mockedRequestSender = Mock.ofType<IRequestSender>();
-
-		const { mockedTestInstance } = this.createTestInstance();
-		this.mockedTestInstance = mockedTestInstance;
-
-		this.mockedTestInstance.setup(_ => _["createGetRequest"](It.isAny()))
-			.returns(() => this.request);
-		this.mockedTestInstance.setup(_ => _["createPostRequest"](It.isAny()))
-			.returns(() => this.request);
-	}
-
-
-
-	@test
-	public buildUrl__RelativePathConcatenatedToBaseUrl() {
-		const baseUrl = "SomeBaseUrl";
-		const relativePath = "SomeRelativePath";
-		const expectedResult = `${baseUrl}${relativePath}`;
-
-		this.mockedTestInstance.setup(_ => _["baseUrl"]).returns(() => baseUrl);
-
-		const result = this.testInstance["buildUrl"](relativePath);
-
-		assert.equal(result, expectedResult);
-	}
-
-
-
-
-
-	@test
-	public async retrieveAllInputBatches__GetRequestCreatedForCorrectPath() {
-		this.mockedRequestSender.setup(_ => _.sendAndExtractBody(It.isAny())).returns(() => ({} as any));
-
-		await this.testInstance.retrieveAllInputBatches();
-
-		this.mockedTestInstance.verify(_ => _["createGetRequest"]("/input-batches"), Times.once());
-	}
-
-	@test
-	public async retrieveAllInputBatches__RequestSent() {
-		this.mockedRequestSender.setup(_ => _.sendAndExtractBody(It.isAny())).returns(() => ({} as any));
-
-		await this.testInstance.retrieveAllInputBatches();
-
-		this.mockedRequestSender.verify(_ => _.sendAndExtractBody(this.request), Times.once());
-	}
-
-	@test
-	public async retrieveAllInputBatches__InputBatchesProvided() {
-		const inputBatches = "SomeInputBatches" as any;
-		const retrieveInputBatchesResult = new RetrieveInputBatchesResult(inputBatches);
-
-		this.mockedRequestSender.setup(_ => _.sendAndExtractBody(It.isAny())).returns(async () => retrieveInputBatchesResult);
-
-		const result = await this.testInstance.retrieveAllInputBatches();
-
-		assert.equal(result, inputBatches);
-	}
-
-	@test
-	public async approveInputBatch__PostRequestCreatedForCorrectPath() {
-		await this.testInstance.approveInputBatch(It.isAny());
-
-		this.mockedTestInstance.verify(_ => _["createPostRequest"]("/input-batch/approve"), Times.once());
-	}
-
-	@test
-	public async approveInputBatch__InputBatchIdentitySpecified() {
-		const inputBatchIdentity = "InputBatchIdentity" as any;
-
-		await this.testInstance.approveInputBatch(inputBatchIdentity);
-
-		this.mockedRequest.verify(_ => _.send(It.isObjectWith({ inputBatchIdentity: inputBatchIdentity })), Times.once());
-	}
-
-	@test
-	public async approveInputBatch__RequestSent() {
-		let awaited = false;
-
-		this.mockedRequestSender.setup(_ => _.send(It.isAny()))
-			.returns(() => new Promise(_ => setImmediate(() => { awaited=true; _(); })));;
-
-		await this.testInstance.approveInputBatch(It.isAny());
-
-		this.mockedRequestSender.verify(_ => _.send(this.request), Times.once());
-		assert.isTrue(awaited);
-	}
-
-	@test
-	public async discardInputBatch__PostRequestCreatedForCorrectPath() {
-		await this.testInstance.discardInputBatch(It.isAny());
-
-		this.mockedTestInstance.verify(_ => _["createPostRequest"]("/input-batch/discard"), Times.once());
-	}
-
-	@test
-	public async discardInputBatch__InputBatchIdentitySpecified() {
-		const inputBatchIdentity = "InputBatchIdentity" as any;
-
-		await this.testInstance.discardInputBatch(inputBatchIdentity);
-
-		this.mockedRequest.verify(_ => _.send(It.isObjectWith({ inputBatchIdentity: inputBatchIdentity })), Times.once());
-	}
-
-	@test
-	public async discardInputBatch__RequestSent() {
-		let awaited = false;
-
-		this.mockedRequestSender.setup(_ => _.send(It.isAny()))
-			.returns(() => new Promise(_ => setImmediate(() => { awaited = true; _(); })));;
-
-		await this.testInstance.discardInputBatch(It.isAny());
-
-		this.mockedRequestSender.verify(_ => _.send(this.request), Times.once());
-		assert.isTrue(awaited);
-	}
-
-	@test
-	public createGetRequest__UrlCorrectlyBuilt() {
-		const {mockedTestInstance, testInstance} = this.createTestInstance();
-
-		const relativePath = "SomeRelativePath";
-		const url = "SomeUrl";
-
-		mockedTestInstance.setup(_ => _["buildUrl"](It.isAny())).returns(() => url);
-
-		testInstance["createGetRequest"](relativePath);
-
-		mockedTestInstance.verify(_ => _["buildUrl"](relativePath), Times.once());
-	}
-
-	@test
-	public createGetRequest__GetRequestCreatedAndProvided() {
-		const {mockedTestInstance, testInstance} = this.createTestInstance();
-		const url = "SomeUrl";
-		const request = "SomeRequest" as any;
-
-		this.mockedSuperAgentRequestFactory.setup(_ => _.get(It.isAny())).returns(() => request);
-		mockedTestInstance.setup(_ => _["buildUrl"](It.isAny())).returns(() => url);
-
-		const result = testInstance["createGetRequest"]("");
-
-		assert.equal(result, request);
-		this.mockedSuperAgentRequestFactory.verify(_ => _.get(url), Times.once());
-	}
-
-	@test
-	public createPostRequest__UrlCorrectlyBuilt() {
-		const {mockedTestInstance, testInstance} = this.createTestInstance();
-
-		const relativePath = "SomeRelativePath";
-		const url = "SomeUrl";
-
-		mockedTestInstance.setup(_ => _["buildUrl"](It.isAny())).returns(() => url);
-
-		testInstance["createPostRequest"](relativePath);
-
-		mockedTestInstance.verify(_ => _["buildUrl"](relativePath), Times.once());
-	}
-
-	@test
-	public createPostRequest__PostRequestCreatedAndProvided() {
-		const {mockedTestInstance, testInstance} = this.createTestInstance();
-		const url = "SomeUrl";
-		const request = "SomeRequest" as any;
-
-		this.mockedSuperAgentRequestFactory.setup(_ => _.post(It.isAny())).returns(() => request);
-		mockedTestInstance.setup(_ => _["buildUrl"](It.isAny())).returns(() => url);
-
-		const result = testInstance["createPostRequest"]("");
-
-		assert.equal(result, request);
-		this.mockedSuperAgentRequestFactory.verify(_ => _.post(url), Times.once());
-	}
-
-	@test
-	public async retrieveOrganisationsFromUser__GetRequestCreatedForCorrectPath() {
-		this.mockedRequestSender.setup(_ => _.sendAndExtractBody(It.isAny())).returns(() => ({} as any));
-
-		await this.testInstance.retrieveOrganisationsFromUser();
-
-		this.mockedTestInstance.verify(_ => _["createGetRequest"]("/organisations-for-user"), Times.once());
-	}
-
-	@test
-	public async retrieveOrganisationsFromUser__RequestSent() {
-		this.mockedRequestSender.setup(_ => _.sendAndExtractBody(It.isAny())).returns(() => ({} as any));
-
-		await this.testInstance.retrieveOrganisationsFromUser();
-
-		this.mockedRequestSender.verify(_ => _.sendAndExtractBody(this.request), Times.once());
-	}
-
-	@test
-	public async retrieveOrganisationsFromUser__InputBatchesProvided() {
-		const userId = "someUserId" as any;
-		const organisations = "SomeOrganisations" as any;
-		const organisationDto = new OrganisationsDto(userId, organisations);
-
-		this.mockedRequestSender.setup(_ => _.sendAndExtractBody(It.isAny())).returns(async () => organisationDto);
-
-		const result = await this.testInstance.retrieveOrganisationsFromUser();
-
-		assert.deepEqual(result, organisationDto);
-	}
-
-
-	private createTestInstance() {
-		const mockedTestInstance = Mock.ofType(LurchClient);
-		const testInstance = mockedTestInstance.object;
-
-		mockedTestInstance.callBase = true;
-		mockedTestInstance.setup(_ => _["superAgentRequestFactory"]).returns(() => this.superAgentRequestFactory);
-		mockedTestInstance.setup(_ => _["requestSender"]).returns(() => this.requestSender);
-
-		return { mockedTestInstance, testInstance };
-	}
-}

package/tests-u/results/discard-input-batch-result.test.ts

@@ -1,22 +0,0 @@
-import { assert } from "chai";
-import { suite, test } from "mocha-typescript";
-
-import { DiscardInputBatchresult } from "../..";
-
-
-@suite
-class DiscardInputBatchResultTest {
-	@test
-	public constructor__TypeGuardInitialized() {
-		const testInstance = new DiscardInputBatchresult();
-
-		assert.isTrue(testInstance.__discard_input_batch_result__);
-	}
-
-	@test
-	public serialization__TypeGuardSerialized() {
-		const deserialization = JSON.parse(JSON.stringify(new DiscardInputBatchresult()));
-
-		assert.isTrue(deserialization.__discard_input_batch_result__);
-	}
-}

package/tests-u/results/retrieve-input-batch-result.test.ts

@@ -1,31 +0,0 @@
-import { assert } from "chai";
-import { suite, test } from "mocha-typescript";
-
-import { RetrieveInputBatchResult } from "../../src/results/retrieve-input-batch-result.class";
-import { RetrieveIntakeResult } from "../../src/results/retrieve-intake-result.class";
-
-
-@suite
-class RetrieveInputBatchResultTest {
-	@test
-	public constructor__TypeGuardInitialized() {
-		const testInstance = new RetrieveInputBatchResult(null as any);
-
-		assert.isTrue(testInstance.__retrieve_input_batch_result__);
-	}
-
-	@test
-	public serialization__TypeGuardSerialized() {
-		const deserialization = JSON.parse(JSON.stringify(new RetrieveInputBatchResult(null as any)));
-
-		assert.isTrue(deserialization.__retrieve_input_batch_result__);
-	}
-
-	@test
-	public serialization__InputBatchSerialized() {
-		const value = "SomeValue" as any;
-		const deserialization = JSON.parse(JSON.stringify(new RetrieveInputBatchResult(value)));
-
-		assert.equal(deserialization.inputBatch, value);
-	}
-}

package/tests-u/results/retrieve-input-batches-result.test.ts

@@ -1,30 +0,0 @@
-import { assert } from "chai";
-import { suite, test } from "mocha-typescript";
-
-import { RetrieveInputBatchesResult } from "../../src/results/retrieve-input-batches-result.class";
-
-
-@suite
-class RetrieveInputBatchesResultTest {
-	@test
-	public constructor__TypeGuardInitialized() {
-		const testInstance = new RetrieveInputBatchesResult([]);
-
-		assert.isTrue(testInstance.__retrieve_input_batches_result__);
-	}
-
-	@test
-	public serialization__TypeGuardSerialized() {
-		const deserialization = JSON.parse(JSON.stringify(new RetrieveInputBatchesResult([])));
-
-		assert.isTrue(deserialization.__retrieve_input_batches_result__);
-	}
-
-	@test
-	public serialization__InputBatchesSerialized() {
-		const value = "SomeValue" as any;
-		const deserialization = JSON.parse(JSON.stringify(new RetrieveInputBatchesResult(value)));
-
-		assert.equal(deserialization.inputBatches, value);
-	}
-}

package/tests-u/results/retrieve-intake-result.test.ts

@@ -1,30 +0,0 @@
-import { assert } from "chai";
-import { suite, test } from "mocha-typescript";
-
-import { RetrieveIntakeResult } from "../../src/results/retrieve-intake-result.class";
-
-
-@suite
-class RetrieveIntakeResultTest {
-	@test
-	public constructor__TypeGuardInitialized() {
-		const testInstance = new RetrieveIntakeResult(null as any);
-
-		assert.isTrue(testInstance.__retrieve_intake_result__);
-	}
-
-	@test
-	public serialization__TypeGuardSerialized() {
-		const deserialization = JSON.parse(JSON.stringify(new RetrieveIntakeResult(null as any)));
-
-		assert.isTrue(deserialization.__retrieve_intake_result__);
-	}
-
-	@test
-	public serialization__IntakeSerialized() {
-		const value = "SomeValue" as any;
-		const deserialization = JSON.parse(JSON.stringify(new RetrieveIntakeResult(value)));
-
-		assert.equal(deserialization.intake, value);
-	}
-}

package/tests-u/results/retrieve-intakes-result.test.ts

@@ -1,30 +0,0 @@
-import { assert } from "chai";
-import { suite, test } from "mocha-typescript";
-
-import { RetrieveIntakesResult } from "../../src/results/retrieve-intakes-result.class";
-
-
-@suite
-class RetrieveIntakesResultTest {
-	@test
-	public constructor__TypeGuardInitialized() {
-		const testInstance = new RetrieveIntakesResult([]);
-
-		assert.isTrue(testInstance.__retrieve_intakes_result__);
-	}
-
-	@test
-	public serialization__TypeGuardSerialized() {
-		const deserialization = JSON.parse(JSON.stringify(new RetrieveIntakesResult([])));
-
-		assert.isTrue(deserialization.__retrieve_intakes_result__);
-	}
-
-	@test
-	public serialization__IntakesSerialized() {
-		const value = "SomeValue" as any;
-		const deserialization = JSON.parse(JSON.stringify(new RetrieveIntakesResult(value)));
-
-		assert.equal(deserialization.intakes, value);
-	}
-}