@studyportals/sp-lurch-interface 3.3.2-1 → 3.3.2-2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +4 -1
- package/index.js +3 -1
- package/index.js.map +1 -1
- package/package.json +1 -1
- package/src/lurch-client.d.ts +3 -1
- package/src/lurch-client.js +1 -2
- package/src/lurch-client.js.map +1 -1
- package/src/results/submit-survey-result.class.d.ts +6 -0
- package/src/results/submit-survey-result.class.js +17 -0
- package/src/results/submit-survey-result.class.js.map +1 -0
- package/src/survey/interfaces/i-survey-submission-answer.interface.d.ts +5 -0
- package/src/survey/interfaces/i-survey-submission-answer.interface.js +3 -0
- package/src/survey/interfaces/i-survey-submission-answer.interface.js.map +1 -0
- package/src/survey/interfaces/i-survey-submission.interface.d.ts +5 -0
- package/src/survey/interfaces/i-survey-submission.interface.js +3 -0
- package/src/survey/interfaces/i-survey-submission.interface.js.map +1 -0
package/index.d.ts
CHANGED
|
@@ -29,4 +29,7 @@ import { ISubmitMatches } from './src/input-batches/interfaces/i-submit-matches.
|
|
|
29
29
|
import { IRetrievedSurveyAnswer } from './src/survey/interfaces/i-retrieved-survey-answer.interface';
|
|
30
30
|
import { IRetrievedSurveyAnsweredQuestion } from './src/survey/interfaces/i-retrieved-survey-answered-question.interface';
|
|
31
31
|
import { RetrieveSurveyResult } from './src/results/retrieve-survey-result.class';
|
|
32
|
-
|
|
32
|
+
import { SubmitSurveyResult } from './src/results/submit-survey-result.class';
|
|
33
|
+
import { ISurveySubmission } from './src/survey/interfaces/i-survey-submission.interface';
|
|
34
|
+
import { ISurveySubmissionAnswer } from './src/survey/interfaces/i-survey-submission-answer.interface';
|
|
35
|
+
export { IIntake, IMatch, IInputBatch, IntakeDto, MatchDto, OrganisationDto, IOrganisation, InputBatchDto, SubmitMatchesResult, DiscardInputBatchresult, RetrieveIntakesResult, RetrieveIntakeResult, RetrieveInputBatchResult, RetrieveInputBatchesResult, InputBatchStatus, IntakeStageType, LurchClient, IMicrositeStudentProfile, MicrositeStudentProfileResult, RetrieveOrganisationsResult, RetrieveSurveyQuestionsResult, ISurveyQuestion, ISurveyQuestionOption, RetrieveSurveyResult, IRetrievedSurveyAnsweredQuestion, IRetrievedSurveyAnswer, SurveyAnswerType, RetrieveInputBatchDomainOverviewResult, IDomainCategoryOverview, DomainCategory, ISubmitMatches, SubmitSurveyResult, ISurveySubmission, ISurveySubmissionAnswer };
|
package/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.DomainCategory = exports.RetrieveInputBatchDomainOverviewResult = exports.SurveyAnswerType = exports.RetrieveSurveyResult = exports.RetrieveSurveyQuestionsResult = exports.RetrieveOrganisationsResult = exports.MicrositeStudentProfileResult = exports.LurchClient = exports.IntakeStageType = exports.InputBatchStatus = exports.RetrieveInputBatchesResult = exports.RetrieveInputBatchResult = exports.RetrieveIntakeResult = exports.RetrieveIntakesResult = exports.DiscardInputBatchresult = exports.SubmitMatchesResult = exports.InputBatchDto = exports.OrganisationDto = exports.MatchDto = exports.IntakeDto = void 0;
|
|
3
|
+
exports.SubmitSurveyResult = exports.DomainCategory = exports.RetrieveInputBatchDomainOverviewResult = exports.SurveyAnswerType = exports.RetrieveSurveyResult = exports.RetrieveSurveyQuestionsResult = exports.RetrieveOrganisationsResult = exports.MicrositeStudentProfileResult = exports.LurchClient = exports.IntakeStageType = exports.InputBatchStatus = exports.RetrieveInputBatchesResult = exports.RetrieveInputBatchResult = exports.RetrieveIntakeResult = exports.RetrieveIntakesResult = exports.DiscardInputBatchresult = exports.SubmitMatchesResult = exports.InputBatchDto = exports.OrganisationDto = exports.MatchDto = exports.IntakeDto = void 0;
|
|
4
4
|
const input_batch_dto_class_1 = require("./src/input-batches/input-batch-dto.class");
|
|
5
5
|
Object.defineProperty(exports, "InputBatchDto", { enumerable: true, get: function () { return input_batch_dto_class_1.InputBatchDto; } });
|
|
6
6
|
const input_batch_status_1 = require("./src/input-batches/input-batch-status");
|
|
@@ -41,4 +41,6 @@ const domain_category_1 = require("./src/input-batches/domain-category");
|
|
|
41
41
|
Object.defineProperty(exports, "DomainCategory", { enumerable: true, get: function () { return domain_category_1.DomainCategory; } });
|
|
42
42
|
const retrieve_survey_result_class_1 = require("./src/results/retrieve-survey-result.class");
|
|
43
43
|
Object.defineProperty(exports, "RetrieveSurveyResult", { enumerable: true, get: function () { return retrieve_survey_result_class_1.RetrieveSurveyResult; } });
|
|
44
|
+
const submit_survey_result_class_1 = require("./src/results/submit-survey-result.class");
|
|
45
|
+
Object.defineProperty(exports, "SubmitSurveyResult", { enumerable: true, get: function () { return submit_survey_result_class_1.SubmitSurveyResult; } });
|
|
44
46
|
//# sourceMappingURL=index.js.map
|
package/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,qFAA0E;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,qFAA0E;AA2CzE,8FA3CQ,qCAAa,OA2CR;AA1Cd,+EAA0E;AAiDzE,iGAjDQ,qCAAgB,OAiDR;AA/CjB,qEAA2D;AAoC1D,0FApCQ,4BAAS,OAoCR;AAnCV,uEAAkE;AA+CjE,gGA/CQ,mCAAe,OA+CR;AA5ChB,mEAAyD;AAiCxD,yFAjCQ,0BAAQ,OAiCR;AAhCT,uGAA2F;AAwC1F,yGAxCQ,4DAAwB,OAwCR;AAvCzB,2GAA+F;AAwC9F,2GAxCQ,gEAA0B,OAwCR;AAvC3B,6FAAkF;AAqCjF,qGArCQ,mDAAoB,OAqCR;AApCrB,+FAAoF;AAmCnF,sGAnCQ,qDAAqB,OAmCR;AAlCtB,2FAAgF;AAgC/E,oGAhCQ,iDAAmB,OAgCR;AA/BpB,qGAAyF;AAgCxF,wGAhCQ,0DAAuB,OAgCR;AA/BxB,qDAAgD;AAsC/C,4FAtCQ,0BAAW,OAsCR;AApCZ,iHAAqG;AAsCpG,8GAtCQ,sEAA6B,OAsCR;AArC9B,2GAAgG;AAsC/F,4GAtCQ,iEAA2B,OAsCR;AArC5B,uIAAyH;AA6CxH,uHA7CQ,0FAAsC,OA6CR;AA3CvC,+FAAqF;AAqBpF,gGArBQ,wCAAe,OAqBR;AAlBhB,wFAA8E;AAuC7E,iGAvCQ,0CAAgB,OAuCR;AAtCjB,iHAAqG;AAgCpG,8GAhCQ,sEAA6B,OAgCR;AA9B9B,yEAAqE;AAuCpE,+FAvCQ,gCAAc,OAuCR;AAnCf,6FAAkF;AA6BjF,qGA7BQ,mDAAoB,OA6BR;AA5BrB,yFAA8E;AAoC7E,mGApCQ,+CAAkB,OAoCR"}
|
package/package.json
CHANGED
package/src/lurch-client.d.ts
CHANGED
|
@@ -6,6 +6,8 @@ import { OrganisationsDto } from "./entities/organisation/organisations-dto";
|
|
|
6
6
|
import { ISurveyQuestion } from "./survey/interfaces/i-survey-question.interface";
|
|
7
7
|
import { ISubmitMatches } from "./input-batches/interfaces/i-submit-matches.interface";
|
|
8
8
|
import { IRetrievedSurveyAnsweredQuestion } from "./survey/interfaces/i-retrieved-survey-answered-question.interface";
|
|
9
|
+
import { ISurveySubmission } from "./survey/interfaces/i-survey-submission.interface";
|
|
10
|
+
import { SubmitSurveyResult } from "./results/submit-survey-result.class";
|
|
9
11
|
export declare class LurchClient {
|
|
10
12
|
private superAgentRequestFactory;
|
|
11
13
|
private requestSender;
|
|
@@ -20,7 +22,7 @@ export declare class LurchClient {
|
|
|
20
22
|
retrieveOrganisationsFromUser(): Promise<OrganisationsDto>;
|
|
21
23
|
retrieveSurvey(): Promise<ISurveyQuestion[]>;
|
|
22
24
|
retrieveSurveyResult(inputBatchIdentity: string): Promise<IRetrievedSurveyAnsweredQuestion[]>;
|
|
23
|
-
submitSurvey
|
|
25
|
+
submitSurvey(payload: ISurveySubmission): Promise<SubmitSurveyResult>;
|
|
24
26
|
private createGetRequest;
|
|
25
27
|
private createPostRequest;
|
|
26
28
|
private buildUrl;
|
package/src/lurch-client.js
CHANGED
|
@@ -63,11 +63,10 @@ class LurchClient {
|
|
|
63
63
|
const result = await this.requestSender.sendAndExtractBody(request);
|
|
64
64
|
return result.answeredQuestions;
|
|
65
65
|
}
|
|
66
|
-
// TODO: TSubmitSurveyRequest is a placeholder type. Once we have the actual survey submission payload structure defined, we should replace this with a more specific type.
|
|
67
66
|
async submitSurvey(payload) {
|
|
68
67
|
const request = this.createPostRequest("/survey");
|
|
69
68
|
request.send(payload);
|
|
70
|
-
await this.requestSender.
|
|
69
|
+
return await this.requestSender.sendAndExtractBody(request);
|
|
71
70
|
}
|
|
72
71
|
createGetRequest(relative = '') {
|
|
73
72
|
return this.superAgentRequestFactory.get(this.buildUrl(relative));
|
package/src/lurch-client.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"lurch-client.js","sourceRoot":"","sources":["../../src/lurch-client.ts"],"names":[],"mappings":";;;AASA,iFAA6E;
|
|
1
|
+
{"version":3,"file":"lurch-client.js","sourceRoot":"","sources":["../../src/lurch-client.ts"],"names":[],"mappings":";;;AASA,iFAA6E;AAS7E,MAAa,WAAW;IAGvB,IAAc,OAAO;QACpB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IAED,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;IAEM,KAAK,CAAC,uBAAuB;QACnC,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;QACxD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAA6B,OAAO,CAAC,CAAC;QAEhG,OAAO,MAAM,CAAC,YAAY,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,kBAA0B;QACxD,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,sBAAsB,CAAC,CAAC;QAC/D,OAAO,CAAC,IAAI,CAAC,EAAE,kBAAkB,EAAE,CAAC,CAAC;QAErC,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,kBAA0B;QACxD,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,sBAAsB,CAAC,CAAC;QAC/D,OAAO,CAAC,IAAI,CAAC,EAAE,kBAAkB,EAAE,CAAC,CAAC;QAErC,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,cAAsB,EAAE,gBAAwB,EAAE,WAA4B,EAAE,WAAmB,EAAE,UAAkB,EAAE,MAAc;QACrK,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;QAE9D,OAAO,CAAC,IAAI,CAAC;YACZ,cAAc;YACd,gBAAgB;YAChB,WAAW;YACX,WAAW;YACX,UAAU;YACV,MAAM;SACN,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAsB,OAAO,CAAC,CAAC;QAEzF,OAAO;YACN,qBAAqB,EAAE,MAAM,CAAC,qBAAqB;YACnD,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;SAC7C,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,gCAAgC,CAAC,kBAA0B,EAAE,cAAsB;QAC/F,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,kBAAkB,kBAAkB,CAAC;aAC3F,GAAG,CAAC,wBAAwB,EAAE,cAAc,CAAC,CAAC;QAChD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAyC,OAAO,CAAC,CAAC;QAE5G,OAAO,MAAM,CAAC,gBAAgB,CAAC;IAChC,CAAC;IAEM,KAAK,CAAC,6BAA6B;QACzC,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,yBAAyB,CAAC,CAAC;QACjE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAA8B,OAAO,CAAC,CAAC;QAEjG,OAAO,IAAI,oCAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC;IAClE,CAAC;IAEM,KAAK,CAAC,cAAc;QAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QACjD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAgC,OAAO,CAAC,CAAC;QAEnG,OAAO,MAAM,CAAC,SAAS,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,kBAA0B;QAC3D,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,kBAAkB,EAAE,CAAC,CAAC;QACvE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAuB,OAAO,CAAC,CAAC;QAE1F,OAAO,MAAM,CAAC,iBAAiB,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,OAA0B;QACnD,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAClD,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEtB,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAqB,OAAO,CAAC,CAAC;IACjF,CAAC;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;AAxGD,kCAwGC"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.SubmitSurveyResult = void 0;
|
|
4
|
+
const sp_r2d2_interface_1 = require("@studyportals/sp-r2d2-interface");
|
|
5
|
+
class SubmitSurveyResult extends sp_r2d2_interface_1.SuccessResult {
|
|
6
|
+
constructor() {
|
|
7
|
+
super();
|
|
8
|
+
this.__submit_survey_result__ = true;
|
|
9
|
+
}
|
|
10
|
+
toJSON() {
|
|
11
|
+
const obj = super.toJSON();
|
|
12
|
+
obj["__submit_survey_result__"] = this.__submit_survey_result__;
|
|
13
|
+
return obj;
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
exports.SubmitSurveyResult = SubmitSurveyResult;
|
|
17
|
+
//# sourceMappingURL=submit-survey-result.class.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"submit-survey-result.class.js","sourceRoot":"","sources":["../../../src/results/submit-survey-result.class.ts"],"names":[],"mappings":";;;AAAA,uEAAgE;AAEhE,MAAa,kBAAmB,SAAQ,iCAAa;IAGjD;QACI,KAAK,EAAE,CAAC;QAHI,6BAAwB,GAAS,IAAI,CAAC;IAItD,CAAC;IAES,MAAM;QACZ,MAAM,GAAG,GAAQ,KAAK,CAAC,MAAM,EAAE,CAAC;QAEhC,GAAG,CAAC,0BAA0B,CAAC,GAAG,IAAI,CAAC,wBAAwB,CAAC;QAEhE,OAAO,GAAG,CAAC;IACf,CAAC;CACJ;AAdD,gDAcC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"i-survey-submission-answer.interface.js","sourceRoot":"","sources":["../../../../src/survey/interfaces/i-survey-submission-answer.interface.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"i-survey-submission.interface.js","sourceRoot":"","sources":["../../../../src/survey/interfaces/i-survey-submission.interface.ts"],"names":[],"mappings":""}
|