@studyportals/sp-lurch-interface - npm Package Compare versions

Comparing version 2.10.0 to 2.11.0

index.d.ts

@@ -14,5 +14,6 @@ import { InputBatchDto } from './src/input-batches/input-batch-dto.class';
 import { SubmitMatchesResult } from './src/results/submit-matches-result.class';
+import { DiscardInputBatchresult } from './src/results/discard-input-batch-result.class';
 import { LurchClient } from './src/lurch-client';
 import { IMicrositeStudentProfile } from './src/student-profile/interfaces/I-microsite-student-profile.interface';
 import { MicrositeStudentProfileResult } from './src/results/microsite-student-profile-result.class';
-export { IIntake, IMatch, IInputBatch, IntakeDto, MatchDto, InputBatchDto, SubmitMatchesResult, RetrieveIntakesResult, RetrieveIntakeResult, RetrieveInputBatchResult, RetrieveInputBatchesResult, InputBatchStatus, IntakeStageType, LurchClient, IMicrositeStudentProfile, MicrositeStudentProfileResult };
+export { IIntake, IMatch, IInputBatch, IntakeDto, MatchDto, InputBatchDto, SubmitMatchesResult, DiscardInputBatchresult, RetrieveIntakesResult, RetrieveIntakeResult, RetrieveInputBatchResult, RetrieveInputBatchesResult, InputBatchStatus, IntakeStageType, LurchClient, IMicrositeStudentProfile, MicrositeStudentProfileResult };

index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MicrositeStudentProfileResult = exports.LurchClient = exports.IntakeStageType = exports.InputBatchStatus = exports.RetrieveInputBatchesResult = exports.RetrieveInputBatchResult = exports.RetrieveIntakeResult = exports.RetrieveIntakesResult = exports.SubmitMatchesResult = exports.InputBatchDto = exports.MatchDto = exports.IntakeDto = void 0;
+exports.MicrositeStudentProfileResult = exports.LurchClient = exports.IntakeStageType = exports.InputBatchStatus = exports.RetrieveInputBatchesResult = exports.RetrieveInputBatchResult = exports.RetrieveIntakeResult = exports.RetrieveIntakesResult = exports.DiscardInputBatchresult = exports.SubmitMatchesResult = exports.InputBatchDto = exports.MatchDto = exports.IntakeDto = void 0;
 const input_batch_dto_class_1 = require("./src/input-batches/input-batch-dto.class");
@@ -24,2 +24,4 @@ Object.defineProperty(exports, "InputBatchDto", { enumerable: true, get: function () { return input_batch_dto_class_1.InputBatchDto; } });
 Object.defineProperty(exports, "SubmitMatchesResult", { enumerable: true, get: function () { return submit_matches_result_class_1.SubmitMatchesResult; } });
+const discard_input_batch_result_class_1 = require("./src/results/discard-input-batch-result.class");
+Object.defineProperty(exports, "DiscardInputBatchresult", { enumerable: true, get: function () { return discard_input_batch_result_class_1.DiscardInputBatchresult; } });
 const lurch_client_1 = require("./src/lurch-client");
@@ -26,0 +28,0 @@ Object.defineProperty(exports, "LurchClient", { enumerable: true, get: function () { return lurch_client_1.LurchClient; } });

package.json

 {
     "name": "@studyportals/sp-lurch-interface",
-    "version": "2.10.0",
+    "version": "2.11.0",
     "description": "Contains Data Transfer Objects required or provided by Lurch through its interface.",
@@ -14,5 +14,5 @@ "scripts": {
         "coverage": "nyc report --reporter=lcov",
-        "deploy-patch": "npm version patch && npm run deploy",
-        "deploy-minor": "npm version minor && npm run deploy",
-        "deploy-major": "npm version major && npm run deploy"
+        "deploy-patch": "npm run prepare-deployment && npm version patch && npm run deploy",
+        "deploy-minor": "npm run prepare-deployment && npm version minor && npm run deploy",
+        "deploy-major": "npm run prepare-deployment && npm version major && npm run deploy"
     },
@@ -19,0 +19,0 @@ "author": "SPAF",

src/lurch-client.d.ts

@@ -11,2 +11,3 @@ import { IRequestSender, ISuperAgentRequestFactory } from "@studyportals/mb-platform-http-requests";
     approveInputBatch(inputBatchIdentity: string): Promise<void>;
+    discardInputBatch(inputBatchIdentity: string): Promise<void>;
     private createGetRequest;
@@ -13,0 +14,0 @@ private createPostRequest;

src/lurch-client.js

@@ -36,2 +36,9 @@ "use strict";
     }
+    discardInputBatch(inputBatchIdentity) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const request = this.createPostRequest('/input-batch/discard');
+            request.send({ inputBatchIdentity });
+            yield this.requestSender.send(request);
+        });
+    }
     createGetRequest(relative = '') {
@@ -38,0 +45,0 @@ return this.superAgentRequestFactory.get(this.buildUrl(relative));

tests-u/lurch-client.test.js

@@ -89,3 +89,2 @@ "use strict";
             const inputBatchIdentity = "InputBatchIdentity";
-            const representativeIdentity = "RepresentativeIdentity";
             yield this.testInstance.approveInputBatch(inputBatchIdentity);
@@ -106,2 +105,26 @@ this.mockedRequest.verify(_ => _.send(typemoq_1.It.isObjectWith({ inputBatchIdentity: inputBatchIdentity })), typemoq_1.Times.once());
     }
+    discardInputBatch__PostRequestCreatedForCorrectPath() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.testInstance.discardInputBatch(typemoq_1.It.isAny());
+            this.mockedTestInstance.verify(_ => _["createPostRequest"]("/input-batch/discard"), typemoq_1.Times.once());
+        });
+    }
+    discardInputBatch__InputBatchIdentitySpecified() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const inputBatchIdentity = "InputBatchIdentity";
+            yield this.testInstance.discardInputBatch(inputBatchIdentity);
+            this.mockedRequest.verify(_ => _.send(typemoq_1.It.isObjectWith({ inputBatchIdentity: inputBatchIdentity })), typemoq_1.Times.once());
+        });
+    }
+    discardInputBatch__RequestSent() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let awaited = false;
+            this.mockedRequestSender.setup(_ => _.send(typemoq_1.It.isAny()))
+                .returns(() => new Promise(_ => setImmediate(() => { awaited = true; _(); })));
+            ;
+            yield this.testInstance.discardInputBatch(typemoq_1.It.isAny());
+            this.mockedRequestSender.verify(_ => _.send(this.request), typemoq_1.Times.once());
+            chai_1.assert.isTrue(awaited);
+        });
+    }
     createGetRequest__UrlCorrectlyBuilt() {
@@ -198,2 +221,20 @@ const { mockedTestInstance, testInstance } = this.createTestInstance();
     __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], LurchClientTest.prototype, "discardInputBatch__PostRequestCreatedForCorrectPath", null);
+__decorate([
+    mocha_typescript_1.test,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], LurchClientTest.prototype, "discardInputBatch__InputBatchIdentitySpecified", null);
+__decorate([
+    mocha_typescript_1.test,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], LurchClientTest.prototype, "discardInputBatch__RequestSent", null);
+__decorate([
+    mocha_typescript_1.test,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
     __metadata("design:returntype", void 0)
@@ -200,0 +241,0 @@ ], LurchClientTest.prototype, "createGetRequest__UrlCorrectlyBuilt", null);

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

105611

increased by8.72%

Number of package files

94

increased by6.82%

Lines of code

1426

increased by8.69%

No dependency changes