@studyportals/sp-lurch-interface 2.14.0 → 2.15.0

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);
-	}
-}

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

@@ -1,32 +0,0 @@
-import { assert } from "chai";
-import { suite, test } from "mocha-typescript";
-
-import { RetrieveOrganisationsResult } from "../../src/results/retrieve-organisations-result.class";
-
-
-@suite
-class RetrieveOrganisationsResultTest {
-	@test
-	public constructor__TypeGuardInitialized() {
-		const testInstance = new RetrieveOrganisationsResult([], 0);
-
-		assert.isTrue(testInstance.__retrieve_organisation_result__);
-	}
-
-	@test
-	public serialization__TypeGuardSerialized() {
-		const deserialization = JSON.parse(JSON.stringify(new RetrieveOrganisationsResult([], 0)));
-
-		assert.isTrue(deserialization.__retrieve_organisation_result__);
-	}
-
-	@test
-	public serialization__OrganisationsSerialized() {
-		const value = "SomeValue" as any;
-		const userId = 1;
-		const deserialization = JSON.parse(JSON.stringify(new RetrieveOrganisationsResult(value, userId)));
-
-		assert.equal(deserialization.organisations, value);
-		assert.equal(deserialization.userId, userId);
-	}
-}

package/tests-u/results/submit-matches-result.test.ts

@@ -1,16 +0,0 @@
-import { assert } from "chai";
-import { suite, test } from "mocha-typescript";
-
-import { SubmitMatchesResult } from "../../src/results/submit-matches-result.class";
-
-
-@suite
-class SubmitMatchesResultTest {
-	@test
-	public serialization__ConfirmedMatchesCountSerialized() {
-		const value = "SomeValue" as any;
-		const deserialization = JSON.parse(JSON.stringify(new SubmitMatchesResult(value)));
-
-		assert.equal(deserialization.confirmedMatchesCount, value);
-	}
-}

package/tsconfig.json

@@ -1,38 +0,0 @@
-{
-	"compilerOptions": {
-		"outDir": "bin",
-		"rootDir": ".",
-		"declaration": true,
-		"moduleResolution": "node",
-
-		"alwaysStrict": true,
-		"strictNullChecks": true,
-
-		"allowJs": false,
-		"allowUnreachableCode": false,
-		"allowUnusedLabels": false,
-
-		"noUnusedLocals": false,
-		"noUnusedParameters": false,
-
-		"noFallthroughCasesInSwitch": true,
-		"noImplicitAny": true,
-		"noImplicitReturns": true,
-		"noImplicitThis": true,
-
-		"sourceMap": true,
-
-		"target": "es6",
-		"lib": ["es6", "dom"],
-		"module": "commonjs",
-
-		"experimentalDecorators": true,
-		"emitDecoratorMetadata": true,
-
-		"types": []
-	},
-
-	"typeRoots": [ "node_modules/@types/" ],
-
-	"exclude": [ "node_modules", "bin" ]
-}