@studyportals/search-api-interface 2.3.0 → 2.3.1-0

package/index.d.ts

@@ -17,4 +17,11 @@ import { ProgrammeSortType } from "./src/programmes/ProgrammeSortType";
 import { TextSearchAlgorithmType } from "./src/TextSearchAlgorithmType";
 import { ProgrammeFilterType } from "./src/programmes/ProgrammeFilterType";
 import { ISuggestionResult } from "./src/suggestions/ISuggestionResult";
-export { SearchApiOrganisationClient, IOrganisationSearchResponse, IOrganisationSearchFilters, OrganisationSearchFilters, SearchApiProgrammeClient, IProgrammeSearchResponse, IProgrammeSearchFilters, ProgrammeSearchFilters, OrganisationSearchInput, ProgrammeSearchInput, IProgrammeResult, DegreeTypeEnum, DeliveryMethodEnum, HitsTotalRelation, ProgrammeSortType, FacetResponseType, FacetValues, TextSearchAlgorithmType, ProgrammeFilterType, ISuggestionResult };
+import { IScholarshipSearchResponse } from "./src/scholarships/IScholarshipSearchResponse";
+import { IScholarshipSearchFilters } from "./src/scholarships/IScholarshipSearchFilters";
+import { ScholarshipSearchFilters } from "./src/scholarships/ScholarshipSearchFilters";
+import { ScholarshipSearchInput } from "./src/scholarships/ScholarshipSearchInput";
+import { IScholarshipSearchCountResponse } from "./src/scholarships/IScholarshipSearchCountResponse";
+import { ScholarshipFormat } from "./src/scholarships/ScholarshipFormatEnum";
+import { ScholarshipType } from "./src/scholarships/ScholarshipTypeEnum";
+export { SearchApiOrganisationClient, IOrganisationSearchResponse, IOrganisationSearchFilters, OrganisationSearchFilters, SearchApiProgrammeClient, IProgrammeSearchResponse, IProgrammeSearchFilters, ProgrammeSearchFilters, OrganisationSearchInput, ProgrammeSearchInput, IProgrammeResult, DegreeTypeEnum, DeliveryMethodEnum, HitsTotalRelation, ProgrammeSortType, FacetResponseType, FacetValues, TextSearchAlgorithmType, ProgrammeFilterType, ISuggestionResult, IScholarshipSearchResponse, IScholarshipSearchFilters, ScholarshipSearchFilters, ScholarshipSearchInput, IScholarshipSearchCountResponse, ScholarshipFormat, ScholarshipType };

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProgrammeFilterType = exports.TextSearchAlgorithmType = exports.ProgrammeSortType = exports.HitsTotalRelation = exports.DeliveryMethodEnum = exports.DegreeTypeEnum = exports.IProgrammeResult = exports.ProgrammeSearchFilters = exports.IProgrammeSearchFilters = exports.SearchApiProgrammeClient = exports.OrganisationSearchFilters = exports.IOrganisationSearchFilters = exports.SearchApiOrganisationClient = void 0;
+exports.ScholarshipType = exports.ScholarshipFormat = exports.ScholarshipSearchFilters = exports.ProgrammeFilterType = exports.TextSearchAlgorithmType = exports.ProgrammeSortType = exports.HitsTotalRelation = exports.DeliveryMethodEnum = exports.DegreeTypeEnum = exports.IProgrammeResult = exports.ProgrammeSearchFilters = exports.IProgrammeSearchFilters = exports.SearchApiProgrammeClient = exports.OrganisationSearchFilters = exports.IOrganisationSearchFilters = exports.SearchApiOrganisationClient = void 0;
 const HitsTotalRelation_1 = require("./src/HitsTotalRelation");
 Object.defineProperty(exports, "HitsTotalRelation", { enumerable: true, get: function () { return HitsTotalRelation_1.HitsTotalRelation; } });
 const DegreeTypeEnum_1 = require("./src/organisations/DegreeTypeEnum");
@@ -27,4 +27,10 @@ const TextSearchAlgorithmType_1 = require("./src/TextSearchAlgorithmType");
 Object.defineProperty(exports, "TextSearchAlgorithmType", { enumerable: true, get: function () { return TextSearchAlgorithmType_1.TextSearchAlgorithmType; } });
 const ProgrammeFilterType_1 = require("./src/programmes/ProgrammeFilterType");
 Object.defineProperty(exports, "ProgrammeFilterType", { enumerable: true, get: function () { return ProgrammeFilterType_1.ProgrammeFilterType; } });
+const ScholarshipSearchFilters_1 = require("./src/scholarships/ScholarshipSearchFilters");
+Object.defineProperty(exports, "ScholarshipSearchFilters", { enumerable: true, get: function () { return ScholarshipSearchFilters_1.ScholarshipSearchFilters; } });
+const ScholarshipFormatEnum_1 = require("./src/scholarships/ScholarshipFormatEnum");
+Object.defineProperty(exports, "ScholarshipFormat", { enumerable: true, get: function () { return ScholarshipFormatEnum_1.ScholarshipFormat; } });
+const ScholarshipTypeEnum_1 = require("./src/scholarships/ScholarshipTypeEnum");
+Object.defineProperty(exports, "ScholarshipType", { enumerable: true, get: function () { return ScholarshipTypeEnum_1.ScholarshipType; } });
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,+DAA4D;AAqC3D,kGArCQ,qCAAiB,OAqCR;AApClB,uEAAoE;AAkCnE,+FAlCQ,+BAAc,OAkCR;AAjCf,+EAA4E;AAkC3E,mGAlCQ,uCAAkB,OAkCR;AAjCnB,+FAA4F;AAoB3F,2GApBQ,uDAA0B,OAoBR;AAlB3B,6FAA0F;AAmBzF,0GAnBQ,qDAAyB,OAmBR;AAjB1B,iGAA8F;AAc7F,4GAdQ,yDAA2B,OAcR;AAb5B,wEAAqE;AAyBpE,iGAzBQ,mCAAgB,OAyBR;AAxBjB,sFAAmF;AAmBlF,wGAnBQ,iDAAuB,OAmBR;AAjBxB,oFAAiF;AAkBhF,uGAlBQ,+CAAsB,OAkBR;AAhBvB,wFAAqF;AAapF,yGAbQ,mDAAwB,OAaR;AAXzB,0EAAuE;AAwBtE,kGAxBQ,qCAAiB,OAwBR;AAvBlB,2EAAwE;AA4BvE,wGA5BQ,iDAAuB,OA4BR;AA3BxB,8EAA2E;AA4B1E,oGA5BQ,yCAAmB,OA4BR"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,+DAA4D;AA4C3D,kGA5CQ,qCAAiB,OA4CR;AA3ClB,uEAAoE;AAyCnE,+FAzCQ,+BAAc,OAyCR;AAxCf,+EAA4E;AAyC3E,mGAzCQ,uCAAkB,OAyCR;AAxCnB,+FAA4F;AA2B3F,2GA3BQ,uDAA0B,OA2BR;AAzB3B,6FAA0F;AA0BzF,0GA1BQ,qDAAyB,OA0BR;AAxB1B,iGAA8F;AAqB7F,4GArBQ,yDAA2B,OAqBR;AApB5B,wEAAqE;AAgCpE,iGAhCQ,mCAAgB,OAgCR;AA/BjB,sFAAmF;AA0BlF,wGA1BQ,iDAAuB,OA0BR;AAxBxB,oFAAiF;AAyBhF,uGAzBQ,+CAAsB,OAyBR;AAvBvB,wFAAqF;AAoBpF,yGApBQ,mDAAwB,OAoBR;AAlBzB,0EAAuE;AA+BtE,kGA/BQ,qCAAiB,OA+BR;AA9BlB,2EAAwE;AAmCvE,wGAnCQ,iDAAuB,OAmCR;AAlCxB,8EAA2E;AAmC1E,oGAnCQ,yCAAmB,OAmCR;AA/BpB,0FAAuF;AAqCtF,yGArCQ,mDAAwB,OAqCR;AAlCzB,oFAA6E;AAqC5E,kGArCQ,yCAAiB,OAqCR;AApClB,gFAAyE;AAqCxE,gGArCQ,qCAAe,OAqCR"}

package/package.json

@@ -1,31 +1,31 @@
-{
-	"name": "@studyportals/search-api-interface",
-	"version": "2.3.0",
-	"description": "Typescript library containing resources that facilitate integration with SearchApi",
-	"main": "index.js",
-	"scripts": {
-		"compile": "rm -fR bin && npx tsc",
-		"deploy-patch": "npm version patch && npm run deploy",
-		"deploy-minor": "npm version minor && npm run deploy --otp=123456",
-		"deploy-major": "npm version major && npm run deploy",
-		"deploy-beta": "npm version prerelease && npm run prepare-deployment && npm publish ./bin --tag beta",
-		"deploy": "npm run prepare-deployment && npm publish ./bin",
-		"prepare-deployment": "npm run compile && cp package.json bin/package.json",
-		"lint": "eslint . --ext .ts",
-		"lint:fix": "eslint . --ext .ts --fix"
-	},
-	"author": "Seal Team Six",
-	"license": "BSD-3-Clause",
-	"devDependencies": {
-		"@studyportals/code-style": "^1.7.0",
-		"@types/superagent": "^4.1.15",
-		"@typescript-eslint/eslint-plugin": "^5.27.0",
-		"@typescript-eslint/parser": "^5.27.0",
-		"eslint": "^8.17.0",
-		"typescript": "^5.5.4",
-		"typescript-transform-paths": "^3.4.6"
-	},
-	"dependencies": {
-		"@studyportals/search-filters": "^4.11.2"
-	}
-}
+{
+	"name": "@studyportals/search-api-interface",
+	"version": "2.3.1-0",
+	"description": "Typescript library containing resources that facilitate integration with SearchApi",
+	"main": "index.js",
+	"scripts": {
+		"compile": "rm -fR bin && npx tsc",
+		"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-beta": "npm version prerelease && npm run prepare-deployment && npm publish ./bin --tag beta",
+		"deploy": "npm run prepare-deployment && npm publish ./bin",
+		"prepare-deployment": "npm run compile && cp package.json bin/package.json",
+		"lint": "eslint . --ext .ts",
+		"lint:fix": "eslint . --ext .ts --fix"
+	},
+	"author": "Seal Team Six",
+	"license": "BSD-3-Clause",
+	"devDependencies": {
+		"@studyportals/code-style": "^1.7.0",
+		"@types/superagent": "^4.1.15",
+		"@typescript-eslint/eslint-plugin": "^5.27.0",
+		"@typescript-eslint/parser": "^5.27.0",
+		"eslint": "^8.17.0",
+		"typescript": "^5.5.4",
+		"typescript-transform-paths": "^3.4.6"
+	},
+	"dependencies": {
+		"@studyportals/search-filters": "^4.11.2"
+	}
+}

package/src/scholarships/IScholarshipSearchCountResponse.d.ts

@@ -0,0 +1,3 @@
+export interface IScholarshipSearchCountResponse {
+    readonly count: number;
+}

package/src/scholarships/IScholarshipSearchCountResponse.js

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

package/src/scholarships/IScholarshipSearchCountResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IScholarshipSearchCountResponse.js","sourceRoot":"","sources":["../../../src/scholarships/IScholarshipSearchCountResponse.ts"],"names":[],"mappings":""}

package/src/scholarships/IScholarshipSearchFilters.d.ts

@@ -0,0 +1,14 @@
+import { DegreeTypeEnum } from "../organisations/DegreeTypeEnum";
+import { ScholarshipFormat } from "./ScholarshipFormatEnum";
+import { ScholarshipType } from "./ScholarshipTypeEnum";
+export interface IScholarshipSearchFilters {
+    readonly title?: string | undefined;
+    readonly disciplineIds?: string[] | undefined;
+    readonly destinationCountryIsoCodes?: string[] | undefined;
+    readonly destinationRegionIds?: string[] | undefined;
+    readonly universityProviderIds?: string[] | undefined;
+    readonly degree?: DegreeTypeEnum | undefined;
+    readonly originCountryIsoCodes?: string[] | undefined;
+    readonly formats?: ScholarshipFormat[] | undefined;
+    readonly types?: ScholarshipType[] | undefined;
+}

package/src/scholarships/IScholarshipSearchFilters.js

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

package/src/scholarships/IScholarshipSearchFilters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IScholarshipSearchFilters.js","sourceRoot":"","sources":["../../../src/scholarships/IScholarshipSearchFilters.ts"],"names":[],"mappings":""}

package/src/scholarships/IScholarshipSearchResponse.d.ts

@@ -0,0 +1,6 @@
+import { HitsTotalRelation } from "../HitsTotalRelation";
+export interface IScholarshipSearchResponse<T> {
+    readonly scholarships: readonly T[];
+    readonly hitsTotal: number;
+    readonly hitsTotalRelation: HitsTotalRelation;
+}

package/src/scholarships/IScholarshipSearchResponse.js

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

package/src/scholarships/IScholarshipSearchResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IScholarshipSearchResponse.js","sourceRoot":"","sources":["../../../src/scholarships/IScholarshipSearchResponse.ts"],"names":[],"mappings":""}

package/src/scholarships/ScholarshipFormatEnum.d.ts

@@ -0,0 +1,10 @@
+export declare enum ScholarshipFormat {
+    TUITION_FEE_REDUCTION = 0,
+    LIVING_EXPENSES = 1,
+    ACCOMODATION = 2,
+    TRAVEL_EXPENSES = 3,
+    SPOUSE_CHILD_CARE = 4,
+    HEALTH = 5,
+    APPLICATION = 6,
+    OTHER = 7
+}

package/src/scholarships/ScholarshipFormatEnum.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScholarshipFormat = void 0;
+var ScholarshipFormat;
+(function (ScholarshipFormat) {
+    ScholarshipFormat[ScholarshipFormat["TUITION_FEE_REDUCTION"] = 0] = "TUITION_FEE_REDUCTION";
+    ScholarshipFormat[ScholarshipFormat["LIVING_EXPENSES"] = 1] = "LIVING_EXPENSES";
+    ScholarshipFormat[ScholarshipFormat["ACCOMODATION"] = 2] = "ACCOMODATION";
+    ScholarshipFormat[ScholarshipFormat["TRAVEL_EXPENSES"] = 3] = "TRAVEL_EXPENSES";
+    ScholarshipFormat[ScholarshipFormat["SPOUSE_CHILD_CARE"] = 4] = "SPOUSE_CHILD_CARE";
+    ScholarshipFormat[ScholarshipFormat["HEALTH"] = 5] = "HEALTH";
+    ScholarshipFormat[ScholarshipFormat["APPLICATION"] = 6] = "APPLICATION";
+    ScholarshipFormat[ScholarshipFormat["OTHER"] = 7] = "OTHER";
+})(ScholarshipFormat || (exports.ScholarshipFormat = ScholarshipFormat = {}));
+//# sourceMappingURL=ScholarshipFormatEnum.js.map

package/src/scholarships/ScholarshipFormatEnum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ScholarshipFormatEnum.js","sourceRoot":"","sources":["../../../src/scholarships/ScholarshipFormatEnum.ts"],"names":[],"mappings":";;;AAAA,IAAY,iBASX;AATD,WAAY,iBAAiB;IAC5B,2FAAyB,CAAA;IACzB,+EAAmB,CAAA;IACnB,yEAAgB,CAAA;IAChB,+EAAmB,CAAA;IACnB,mFAAqB,CAAA;IACrB,6DAAU,CAAA;IACV,uEAAe,CAAA;IACf,2DAAS,CAAA;AACV,CAAC,EATW,iBAAiB,iCAAjB,iBAAiB,QAS5B"}

package/src/scholarships/ScholarshipSearchFilters.d.ts

@@ -0,0 +1,27 @@
+import { ScholarshipFormat } from "./ScholarshipFormatEnum";
+import { ScholarshipType } from "./ScholarshipTypeEnum";
+import { IScholarshipSearchFilters } from "./IScholarshipSearchFilters";
+import { ScholarshipSearchInput } from "./ScholarshipSearchInput";
+import { DegreeTypeEnum } from "../organisations/DegreeTypeEnum";
+export declare class ScholarshipSearchFilters implements IScholarshipSearchFilters {
+    title: string | undefined;
+    disciplineIds: string[] | undefined;
+    destinationCountryIsoCodes: string[] | undefined;
+    destinationRegionIds: string[] | undefined;
+    originCountryIsoCodes: string[] | undefined;
+    universityProviderIds: string[] | undefined;
+    degree: DegreeTypeEnum | undefined;
+    formats: ScholarshipFormat[] | undefined;
+    types: ScholarshipType[] | undefined;
+    from(input: ScholarshipSearchInput): ScholarshipSearchFilters;
+    consideringTitle(title: string): ScholarshipSearchFilters;
+    consideringDisciplineIds(disciplines: string[]): ScholarshipSearchFilters;
+    consideringDestinationCountryIsoCodes(destinationCountries: string[]): ScholarshipSearchFilters;
+    consideringDestinationRegionIds(destinationStates: string[]): ScholarshipSearchFilters;
+    consideringOriginCountryIsoCodes(originCountries: string[]): ScholarshipSearchFilters;
+    consideringUniversityProviderIds(providerOrganisationIds: string[]): ScholarshipSearchFilters;
+    consideringDegree(degree: DegreeTypeEnum): ScholarshipSearchFilters;
+    consideringFormats(formats: ScholarshipFormat[]): ScholarshipSearchFilters;
+    consideringTypes(types: ScholarshipType[]): ScholarshipSearchFilters;
+    private numbersToStringsOrUndefined;
+}

package/src/scholarships/ScholarshipSearchFilters.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScholarshipSearchFilters = void 0;
+class ScholarshipSearchFilters {
+    from(input) {
+        this.title = input.title;
+        this.disciplineIds = this.numbersToStringsOrUndefined(input.disciplineIds);
+        this.destinationCountryIsoCodes = input.destinationCountryIsoCodes;
+        this.destinationRegionIds = this.numbersToStringsOrUndefined(input.destinationRegionIds);
+        this.originCountryIsoCodes = input.originCountryIsoCodes;
+        this.universityProviderIds = this.numbersToStringsOrUndefined(input.universityProviderIds);
+        this.degree = input.degree;
+        this.formats = input.formats;
+        this.types = input.types;
+        return this;
+    }
+    consideringTitle(title) {
+        this.title = title;
+        return this;
+    }
+    consideringDisciplineIds(disciplines) {
+        this.disciplineIds = disciplines;
+        return this;
+    }
+    consideringDestinationCountryIsoCodes(destinationCountries) {
+        this.destinationCountryIsoCodes = destinationCountries;
+        return this;
+    }
+    consideringDestinationRegionIds(destinationStates) {
+        this.destinationRegionIds = destinationStates;
+        return this;
+    }
+    consideringOriginCountryIsoCodes(originCountries) {
+        this.originCountryIsoCodes = originCountries;
+        return this;
+    }
+    consideringUniversityProviderIds(providerOrganisationIds) {
+        this.universityProviderIds = providerOrganisationIds;
+        return this;
+    }
+    consideringDegree(degree) {
+        this.degree = degree;
+        return this;
+    }
+    consideringFormats(formats) {
+        this.formats = formats;
+        return this;
+    }
+    consideringTypes(types) {
+        this.types = types;
+        return this;
+    }
+    numbersToStringsOrUndefined(values) {
+        if (values === undefined)
+            return;
+        return values.map(value => value.toString());
+    }
+}
+exports.ScholarshipSearchFilters = ScholarshipSearchFilters;
+//# sourceMappingURL=ScholarshipSearchFilters.js.map

package/src/scholarships/ScholarshipSearchFilters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ScholarshipSearchFilters.js","sourceRoot":"","sources":["../../../src/scholarships/ScholarshipSearchFilters.ts"],"names":[],"mappings":";;;AAMA,MAAa,wBAAwB;IAW7B,IAAI,CAAC,KAA6B;QACxC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QACzB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAC3E,IAAI,CAAC,0BAA0B,GAAG,KAAK,CAAC,0BAA0B,CAAC;QACnE,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACzF,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,CAAC;QACzD,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAC3F,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,gBAAgB,CAAC,KAAa;QACpC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,wBAAwB,CAAC,WAAqB;QACpD,IAAI,CAAC,aAAa,GAAG,WAAW,CAAC;QACjC,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,qCAAqC,CAAC,oBAA8B;QAC1E,IAAI,CAAC,0BAA0B,GAAG,oBAAoB,CAAC;QACvD,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,+BAA+B,CAAC,iBAA2B;QACjE,IAAI,CAAC,oBAAoB,GAAG,iBAAiB,CAAC;QAC9C,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,gCAAgC,CAAC,eAAyB;QAChE,IAAI,CAAC,qBAAqB,GAAG,eAAe,CAAC;QAC7C,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,gCAAgC,CAAC,uBAAiC;QACxE,IAAI,CAAC,qBAAqB,GAAG,uBAAuB,CAAC;QACrD,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,iBAAiB,CAAC,MAAsB;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,kBAAkB,CAAC,OAA4B;QACrD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,gBAAgB,CAAC,KAAwB;QAC/C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEO,2BAA2B,CAAC,MAA4B;QAC/D,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO;QACjC,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC9C,CAAC;CACD;AAzED,4DAyEC"}

package/src/scholarships/ScholarshipSearchInput.d.ts

@@ -0,0 +1,15 @@
+import { DegreeTypeEnum } from "../organisations/DegreeTypeEnum";
+import { ScholarshipFormat } from "./ScholarshipFormatEnum";
+import { ScholarshipType } from "./ScholarshipTypeEnum";
+export type ScholarshipSearchInput = {
+    scholarshipId?: number;
+    title?: string;
+    disciplineIds?: number[];
+    originCountryIsoCodes?: string[] | undefined;
+    destinationCountryIsoCodes?: string[] | undefined;
+    destinationRegionIds?: number[] | undefined;
+    universityProviderIds?: number[] | undefined;
+    degree?: DegreeTypeEnum;
+    formats?: ScholarshipFormat[];
+    types?: ScholarshipType[];
+};

package/src/scholarships/ScholarshipSearchInput.js

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

package/src/scholarships/ScholarshipSearchInput.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ScholarshipSearchInput.js","sourceRoot":"","sources":["../../../src/scholarships/ScholarshipSearchInput.ts"],"names":[],"mappings":""}

package/src/scholarships/ScholarshipTypeEnum.d.ts

@@ -0,0 +1,17 @@
+export declare enum ScholarshipType {
+    FULL_TUITION_FEE_WAIVER = 0,
+    PARTIAL_FEE_WAIVER = 1,
+    FULL_RIDE = 2,
+    MILITARY = 3,
+    SPORTS = 4,
+    STEM = 5,
+    RELIGIOUS = 6,
+    HERITAGE = 7,
+    LEARNING_DISABILITIES = 8,
+    AUTOMATIC = 9,
+    MERIT_BASED = 10,
+    NEED_BASED = 11,
+    NO_ESSAY_REQUIRED = 12,
+    NO_GPA_REQUIREMENTS = 13,
+    NO_RECOMMENDATIONS_REQUIRED = 14
+}

package/src/scholarships/ScholarshipTypeEnum.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScholarshipType = void 0;
+var ScholarshipType;
+(function (ScholarshipType) {
+    ScholarshipType[ScholarshipType["FULL_TUITION_FEE_WAIVER"] = 0] = "FULL_TUITION_FEE_WAIVER";
+    ScholarshipType[ScholarshipType["PARTIAL_FEE_WAIVER"] = 1] = "PARTIAL_FEE_WAIVER";
+    ScholarshipType[ScholarshipType["FULL_RIDE"] = 2] = "FULL_RIDE";
+    ScholarshipType[ScholarshipType["MILITARY"] = 3] = "MILITARY";
+    ScholarshipType[ScholarshipType["SPORTS"] = 4] = "SPORTS";
+    ScholarshipType[ScholarshipType["STEM"] = 5] = "STEM";
+    ScholarshipType[ScholarshipType["RELIGIOUS"] = 6] = "RELIGIOUS";
+    ScholarshipType[ScholarshipType["HERITAGE"] = 7] = "HERITAGE";
+    ScholarshipType[ScholarshipType["LEARNING_DISABILITIES"] = 8] = "LEARNING_DISABILITIES";
+    ScholarshipType[ScholarshipType["AUTOMATIC"] = 9] = "AUTOMATIC";
+    ScholarshipType[ScholarshipType["MERIT_BASED"] = 10] = "MERIT_BASED";
+    ScholarshipType[ScholarshipType["NEED_BASED"] = 11] = "NEED_BASED";
+    ScholarshipType[ScholarshipType["NO_ESSAY_REQUIRED"] = 12] = "NO_ESSAY_REQUIRED";
+    ScholarshipType[ScholarshipType["NO_GPA_REQUIREMENTS"] = 13] = "NO_GPA_REQUIREMENTS";
+    ScholarshipType[ScholarshipType["NO_RECOMMENDATIONS_REQUIRED"] = 14] = "NO_RECOMMENDATIONS_REQUIRED";
+})(ScholarshipType || (exports.ScholarshipType = ScholarshipType = {}));
+//# sourceMappingURL=ScholarshipTypeEnum.js.map

package/src/scholarships/ScholarshipTypeEnum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ScholarshipTypeEnum.js","sourceRoot":"","sources":["../../../src/scholarships/ScholarshipTypeEnum.ts"],"names":[],"mappings":";;;AAAA,IAAY,eAgBX;AAhBD,WAAY,eAAe;IAC1B,2FAA2B,CAAA;IAC3B,iFAAsB,CAAA;IACtB,+DAAa,CAAA;IACb,6DAAY,CAAA;IACZ,yDAAU,CAAA;IACV,qDAAQ,CAAA;IACR,+DAAa,CAAA;IACb,6DAAY,CAAA;IACZ,uFAAyB,CAAA;IACzB,+DAAa,CAAA;IACb,oEAAgB,CAAA;IAChB,kEAAe,CAAA;IACf,gFAAsB,CAAA;IACtB,oFAAwB,CAAA;IACxB,oGAAgC,CAAA;AACjC,CAAC,EAhBW,eAAe,+BAAf,eAAe,QAgB1B"}

package/src/scholarships/SearchApiScholarshipsClient.d.ts

@@ -0,0 +1,13 @@
+import { ISuperAgentRequestFactory, IRequestSender } from "@studyportals/mb-platform-http-requests";
+import { SearchApiClientBase } from "../SearchApiClientBase";
+import { IScholarshipSearchFilters } from "./IScholarshipSearchFilters";
+import { IScholarshipSearchResponse } from "./IScholarshipSearchResponse";
+import { IScholarshipCard, PortalMap } from "@studyportals/domain-client";
+export declare class SearchApiScholarshipClient extends SearchApiClientBase {
+    private readonly requestFactory;
+    private readonly requestSender;
+    private readonly scholarshipCardFactory;
+    constructor(apiUriBase: string, requestFactory: ISuperAgentRequestFactory, requestSender: IRequestSender, portalMap?: PortalMap);
+    searchCards(filters: IScholarshipSearchFilters, resultSize: number, resultOffset: number): Promise<IScholarshipSearchResponse<IScholarshipCard>>;
+    count(filters: any, resultSize: number, resultOffset: number): Promise<IScholarshipSearchResponse<string>>;
+}

package/src/scholarships/SearchApiScholarshipsClient.js

@@ -0,0 +1,39 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchApiScholarshipClient = void 0;
+const SearchApiClientBase_1 = require("../SearchApiClientBase");
+const domain_client_1 = require("@studyportals/domain-client");
+class SearchApiScholarshipClient extends SearchApiClientBase_1.SearchApiClientBase {
+    constructor(apiUriBase, requestFactory, requestSender, portalMap) {
+        super("scholarships", apiUriBase);
+        this.requestFactory = requestFactory;
+        this.requestSender = requestSender;
+        this.scholarshipCardFactory = new domain_client_1.ScholarshipCardV2Client("N/A", "N/A", 1, portalMap);
+    }
+    searchCards(filters, resultSize, resultOffset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const request = this.requestFactory.get(this.constructUri("search"))
+                .query(Object.assign(Object.assign({}, filters), { resultSize, resultOffset }));
+            const result = yield this.requestSender.sendAndExtractBody(request);
+            return Object.assign(Object.assign({}, result), { scholarships: this.scholarshipCardFactory.fromDescriptions([...result.scholarships]) });
+        });
+    }
+    count(filters, resultSize, resultOffset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const request = this.requestFactory.get(this.constructUri("count"))
+                .query(Object.assign(Object.assign({}, filters), { resultSize, resultOffset }));
+            return yield this.requestSender.sendAndExtractBody(request);
+        });
+    }
+}
+exports.SearchApiScholarshipClient = SearchApiScholarshipClient;
+//# sourceMappingURL=SearchApiScholarshipsClient.js.map

package/src/scholarships/SearchApiScholarshipsClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SearchApiScholarshipsClient.js","sourceRoot":"","sources":["../../../src/scholarships/SearchApiScholarshipsClient.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,gEAA6D;AAG7D,+DAAgH;AAGhH,MAAa,0BAA2B,SAAQ,yCAAmB;IAMlE,YAAmB,UAAkB,EAC9B,cAAyC,EACzC,aAA6B,EAC7B,SAAqB;QAE3B,KAAK,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;QAElC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,sBAAsB,GAAG,IAAI,uCAAuB,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,SAAS,CAAC,CAAC;IACvF,CAAC;IAEY,WAAW,CAAC,OAAkC,EAAE,UAAkB,EAAE,YAAoB;;YACpG,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;iBAClE,KAAK,iCAAK,OAAO,KAAE,UAAU,EAAE,YAAY,IAAE,CAAC;YAEhD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAgD,OAAO,CAAC,CAAC;YAEnH,uCACI,MAAM,KACT,YAAY,EAAE,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,IACnF;QACH,CAAC;KAAA;IAEY,KAAK,CAAC,OAAY,EAAE,UAAkB,EAAE,YAAoB;;YACxE,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;iBACjE,KAAK,iCAAM,OAAO,KAAE,UAAU,EAAE,YAAY,IAAG,CAAC;YAElD,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAqC,OAAO,CAAC,CAAC;QACjG,CAAC;KAAA;CACD;AApCD,gEAoCC"}