@studyportals/sp-lurch-interface 2.14.1 → 3.0.0

package/package.json

@@ -1,13 +1,13 @@
 {
     "name": "@studyportals/sp-lurch-interface",
-    "version": "2.14.1",
+    "version": "3.0.0",
     "description": "Contains Data Transfer Objects required or provided by Lurch through its interface.",
     "scripts": {
         "test": "tsc && npm run test-u-o && nyc report --reporter=text",
         "test-u": "tsc && npm run test-u-o",
         "test-u-o": "npx --all --silent mocha \"bin/tests-u/**/*.test.js\"",
         "prepare-deployment": "cp package.json bin/package.json",
-        "deploy": "npm test && npm run prepare-deployment && npm publish bin",
+        "deploy": "npm test && npm run prepare-deployment && npm publish bin --otp=946866",
         "lint": "tslint 'src/**/*.ts'",
         "lint-fix": "tslint --fix 'src/**/*.ts'",
         "coverage": "nyc report --reporter=lcov",
@@ -32,7 +32,7 @@
     "dependencies": {
         "@studyportals/mb-platform-http-requests": "^1.0.4",
         "@studyportals/sp-r2d2-interface": "^2.0.0",
-        "@studyportals/sp-thing-interface": "^1.1.1",
+        "@studyportals/sp-thing-interface": "^1.4.0",
         "superagent": "^3.8.3"
     }
 }

package/src/entities/organisation/main-organisations-dto.d.ts

@@ -0,0 +1,6 @@
+import { IOrganisation } from "./i-organisation.interface";
+export declare class MainOrganisationsDto {
+    readonly userId: number;
+    readonly organisations: IOrganisation[];
+    constructor(userId: number, organisations: IOrganisation[]);
+}

package/src/entities/organisation/main-organisations-dto.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MainOrganisationsDto = void 0;
+class MainOrganisationsDto {
+    constructor(userId, organisations) {
+        this.userId = userId;
+        this.organisations = organisations;
+    }
+}
+exports.MainOrganisationsDto = MainOrganisationsDto;
+//# sourceMappingURL=main-organisations-dto.js.map

package/src/entities/organisation/main-organisations-dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main-organisations-dto.js","sourceRoot":"","sources":["../../../../src/entities/organisation/main-organisations-dto.ts"],"names":[],"mappings":";;;AAGA,MAAa,oBAAoB;IAChC,YACiB,MAAc,EACd,aAA8B;QAD9B,WAAM,GAAN,MAAM,CAAQ;QACd,kBAAa,GAAb,aAAa,CAAiB;IAC3C,CAAC;CACL;AALD,oDAKC"}

package/src/lurch-client.js

@@ -43,7 +43,7 @@ class LurchClient {
     }
     submitEnrollments(organisationId, representativeId, intakeStage, intakeMonth, intakeYear, inputs) {
         return __awaiter(this, void 0, void 0, function* () {
-            const request = this.createPostRequest('submit-enrollments');
+            const request = this.createPostRequest('/submit-enrollments');
             request.send({
                 organisationId,
                 representativeId,

package/src/lurch-client.js.map

@@ -1 +1 @@
-{"version":3,"file":"lurch-client.js","sourceRoot":"","sources":["../../src/lurch-client.ts"],"names":[],"mappings":";;;;;;;;;;;;AASA,iFAA6E;AAG7E,MAAa,WAAW;IAOvB,YACS,wBAAmD,EACnD,aAA6B,EACrC,UAAkB,EAAE;QAFZ,6BAAwB,GAAxB,wBAAwB,CAA2B;QACnD,kBAAa,GAAb,aAAa,CAAgB;QAGrC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IACzB,CAAC;IAVD,IAAc,OAAO;QACpB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IAUY,uBAAuB;;YACnC,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;YACxD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAA6B,OAAO,CAAC,CAAC;YAEhG,OAAO,MAAM,CAAC,YAAY,CAAC;QAC5B,CAAC;KAAA;IAEY,iBAAiB,CAAC,kBAA0B;;YACxD,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,sBAAsB,CAAC,CAAC;YAC/D,OAAO,CAAC,IAAI,CAAC,EAAE,kBAAkB,EAAE,CAAC,CAAC;YAErC,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxC,CAAC;KAAA;IAEY,iBAAiB,CAAC,kBAA0B;;YACxD,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,sBAAsB,CAAC,CAAC;YAC/D,OAAO,CAAC,IAAI,CAAC,EAAE,kBAAkB,EAAE,CAAC,CAAC;YAErC,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxC,CAAC;KAAA;IAEY,iBAAiB,CAAC,cAAsB,EAAE,gBAAwB,EAAE,WAA4B,EAAE,WAAmB,EAAE,UAAkB,EAAE,MAAc;;YACrK,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;YAE7D,OAAO,CAAC,IAAI,CAAC;gBACZ,cAAc;gBACd,gBAAgB;gBAChB,WAAW;gBACX,WAAW;gBACX,UAAU;gBACV,MAAM;aACN,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAsB,OAAO,CAAC,CAAC;YAEzF,OAAO,MAAM,CAAC,qBAAqB,CAAC;QACrC,CAAC;KAAA;IAEY,6BAA6B;;YACzC,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,yBAAyB,CAAC,CAAC;YACjE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAA8B,OAAO,CAAC,CAAC;YAEjG,OAAO,IAAI,oCAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC;QAClE,CAAC;KAAA;IAGO,gBAAgB,CAAC,WAAmB,EAAE;QAC7C,OAAO,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;IACnE,CAAC;IAEO,iBAAiB,CAAC,WAAmB,EAAE;QAC9C,OAAO,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;IACpE,CAAC;IAEO,QAAQ,CAAC,QAAgB;QAChC,OAAO,GAAG,IAAI,CAAC,OAAO,GAAG,QAAQ,EAAE,CAAC;IACrC,CAAC;CACD;AAxED,kCAwEC"}
+{"version":3,"file":"lurch-client.js","sourceRoot":"","sources":["../../src/lurch-client.ts"],"names":[],"mappings":";;;;;;;;;;;;AASA,iFAA6E;AAG7E,MAAa,WAAW;IAOvB,YACS,wBAAmD,EACnD,aAA6B,EACrC,UAAkB,EAAE;QAFZ,6BAAwB,GAAxB,wBAAwB,CAA2B;QACnD,kBAAa,GAAb,aAAa,CAAgB;QAGrC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IACzB,CAAC;IAVD,IAAc,OAAO;QACpB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IAUY,uBAAuB;;YACnC,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;YACxD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAA6B,OAAO,CAAC,CAAC;YAEhG,OAAO,MAAM,CAAC,YAAY,CAAC;QAC5B,CAAC;KAAA;IAEY,iBAAiB,CAAC,kBAA0B;;YACxD,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,sBAAsB,CAAC,CAAC;YAC/D,OAAO,CAAC,IAAI,CAAC,EAAE,kBAAkB,EAAE,CAAC,CAAC;YAErC,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxC,CAAC;KAAA;IAEY,iBAAiB,CAAC,kBAA0B;;YACxD,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,sBAAsB,CAAC,CAAC;YAC/D,OAAO,CAAC,IAAI,CAAC,EAAE,kBAAkB,EAAE,CAAC,CAAC;YAErC,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxC,CAAC;KAAA;IAEY,iBAAiB,CAAC,cAAsB,EAAE,gBAAwB,EAAE,WAA4B,EAAE,WAAmB,EAAE,UAAkB,EAAE,MAAc;;YACrK,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;YAE9D,OAAO,CAAC,IAAI,CAAC;gBACZ,cAAc;gBACd,gBAAgB;gBAChB,WAAW;gBACX,WAAW;gBACX,UAAU;gBACV,MAAM;aACN,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAsB,OAAO,CAAC,CAAC;YAEzF,OAAO,MAAM,CAAC,qBAAqB,CAAC;QACrC,CAAC;KAAA;IAEY,6BAA6B;;YACzC,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,yBAAyB,CAAC,CAAC;YACjE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAA8B,OAAO,CAAC,CAAC;YAEjG,OAAO,IAAI,oCAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC;QAClE,CAAC;KAAA;IAGO,gBAAgB,CAAC,WAAmB,EAAE;QAC7C,OAAO,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;IACnE,CAAC;IAEO,iBAAiB,CAAC,WAAmB,EAAE;QAC9C,OAAO,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;IACpE,CAAC;IAEO,QAAQ,CAAC,QAAgB;QAChC,OAAO,GAAG,IAAI,CAAC,OAAO,GAAG,QAAQ,EAAE,CAAC;IACrC,CAAC;CACD;AAxED,kCAwEC"}

package/src/results/retrieve-main-organisations-result.class.d.ts

@@ -0,0 +1,9 @@
+import { SuccessResult } from "@studyportals/sp-r2d2-interface";
+import { IOrganisation } from "../entities/organisation/i-organisation.interface";
+export declare class RetrieveMainOrganisationsResult extends SuccessResult {
+    readonly organisations: IOrganisation[];
+    readonly userId: number;
+    readonly __retrieve_main_organisation_result__: true;
+    constructor(organisations: IOrganisation[], userId: number);
+    protected toJSON(): object;
+}

package/src/results/retrieve-main-organisations-result.class.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RetrieveMainOrganisationsResult = void 0;
+const sp_r2d2_interface_1 = require("@studyportals/sp-r2d2-interface");
+class RetrieveMainOrganisationsResult extends sp_r2d2_interface_1.SuccessResult {
+    constructor(organisations, userId) {
+        super();
+        this.organisations = organisations;
+        this.userId = userId;
+        this.__retrieve_main_organisation_result__ = true;
+    }
+    toJSON() {
+        const obj = super.toJSON();
+        obj["__retrieve_main_organisation_result__"] = this.__retrieve_main_organisation_result__;
+        obj["organisations"] = this.organisations;
+        obj["userId"] = this.userId;
+        return obj;
+    }
+}
+exports.RetrieveMainOrganisationsResult = RetrieveMainOrganisationsResult;
+//# sourceMappingURL=retrieve-main-organisations-result.class.js.map

package/src/results/retrieve-main-organisations-result.class.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retrieve-main-organisations-result.class.js","sourceRoot":"","sources":["../../../src/results/retrieve-main-organisations-result.class.ts"],"names":[],"mappings":";;;AAAA,uEAAgE;AAIhE,MAAa,+BAAgC,SAAQ,iCAAa;IAIjE,YACiB,aAA8B,EAC9B,MAAc;QAE9B,KAAK,EAAE,CAAC;QAHQ,kBAAa,GAAb,aAAa,CAAiB;QAC9B,WAAM,GAAN,MAAM,CAAQ;QALf,0CAAqC,GAAS,IAAI,CAAC;IAQnE,CAAC;IAGS,MAAM;QACf,MAAM,GAAG,GAAQ,KAAK,CAAC,MAAM,EAAE,CAAC;QAEhC,GAAG,CAAC,uCAAuC,CAAC,GAAG,IAAI,CAAC,qCAAqC,CAAC;QAC1F,GAAG,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAC1C,GAAG,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QAE5B,OAAO,GAAG,CAAC;IACZ,CAAC;CACD;AArBD,0EAqBC"}

package/src/student-profile/interfaces/I-student-profile.interface.d.ts

@@ -0,0 +1,9 @@
+export interface IStudentProfile {
+    readonly identity: string;
+    readonly email: string;
+    readonly dateCreated: string;
+    readonly firstName: string;
+    readonly lastName: string;
+    readonly nationality: string;
+    readonly organisationId: string;
+}

package/src/student-profile/interfaces/I-student-profile.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=I-student-profile.interface.js.map

package/src/student-profile/interfaces/I-student-profile.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"I-student-profile.interface.js","sourceRoot":"","sources":["../../../../src/student-profile/interfaces/I-student-profile.interface.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1 @@
+export {};

package/tests-u/results/retrieve-main-organisation-result.test.js

@@ -0,0 +1,53 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const mocha_typescript_1 = require("mocha-typescript");
+const retrieve_main_organisations_result_class_1 = require("../../src/results/retrieve-main-organisations-result.class");
+let RetrieveMainOrganisationsResultTest = class RetrieveMainOrganisationsResultTest {
+    constructor__TypeGuardInitialized() {
+        const testInstance = new retrieve_main_organisations_result_class_1.RetrieveMainOrganisationsResult([], 0);
+        chai_1.assert.isTrue(testInstance.__retrieve_main_organisation_result__);
+    }
+    serialization__TypeGuardSerialized() {
+        const deserialization = JSON.parse(JSON.stringify(new retrieve_main_organisations_result_class_1.RetrieveMainOrganisationsResult([], 0)));
+        chai_1.assert.isTrue(deserialization.__retrieve_main_organisation_result__);
+    }
+    serialization__OrganisationsSerialized() {
+        const value = "SomeValue";
+        const userId = 1;
+        const deserialization = JSON.parse(JSON.stringify(new retrieve_main_organisations_result_class_1.RetrieveMainOrganisationsResult(value, userId)));
+        chai_1.assert.equal(deserialization.organisations, value);
+        chai_1.assert.equal(deserialization.userId, userId);
+    }
+};
+__decorate([
+    mocha_typescript_1.test,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], RetrieveMainOrganisationsResultTest.prototype, "constructor__TypeGuardInitialized", null);
+__decorate([
+    mocha_typescript_1.test,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], RetrieveMainOrganisationsResultTest.prototype, "serialization__TypeGuardSerialized", null);
+__decorate([
+    mocha_typescript_1.test,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], RetrieveMainOrganisationsResultTest.prototype, "serialization__OrganisationsSerialized", null);
+RetrieveMainOrganisationsResultTest = __decorate([
+    mocha_typescript_1.suite
+], RetrieveMainOrganisationsResultTest);
+//# sourceMappingURL=retrieve-main-organisation-result.test.js.map

package/tests-u/results/retrieve-main-organisation-result.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retrieve-main-organisation-result.test.js","sourceRoot":"","sources":["../../../tests-u/results/retrieve-main-organisation-result.test.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,+BAA8B;AAC9B,uDAA+C;AAE/C,yHAA6G;AAI7G,IAAM,mCAAmC,GAAzC,MAAM,mCAAmC;IAEjC,iCAAiC;QACvC,MAAM,YAAY,GAAG,IAAI,0EAA+B,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QAEhE,aAAM,CAAC,MAAM,CAAC,YAAY,CAAC,qCAAqC,CAAC,CAAC;IACnE,CAAC;IAGM,kCAAkC;QACxC,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,0EAA+B,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAE/F,aAAM,CAAC,MAAM,CAAC,eAAe,CAAC,qCAAqC,CAAC,CAAC;IACtE,CAAC;IAGM,sCAAsC;QAC5C,MAAM,KAAK,GAAG,WAAkB,CAAC;QACjC,MAAM,MAAM,GAAG,CAAC,CAAC;QACjB,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,0EAA+B,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;QAEvG,aAAM,CAAC,KAAK,CAAC,eAAe,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;QACnD,aAAM,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9C,CAAC;CACD,CAAA;AAtBA;IADC,uBAAI;;;;4FAKJ;AAGD;IADC,uBAAI;;;;6FAKJ;AAGD;IADC,uBAAI;;;;iGAQJ;AAvBI,mCAAmC;IADxC,wBAAK;GACA,mCAAmC,CAwBxC"}