@studyportals/search-api-interface 3.4.2-1 → 3.4.2-27

package/package.json

@@ -1,39 +1,32 @@
 {
-  "name": "@studyportals/search-api-interface",
-  "version": "3.4.2-1",
-  "description": "Typescript library containing resources that facilitate integration with SearchApi",
-  "main": "index.js",
-  "exports": {
-    "import": "./bin/index.js",
-    "require": "./bin/index.cjs"
-  },
-  "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 && npm run convert-to-cjs && cp package.json bin/package.json && npm run remove-aliases",
-    "remove-aliases": "npx tsc-alias -p tsconfig.json",
-    "convert-to-cjs": "npx rollup ./bin/index.js --file ./bin/index.cjs --format cjs",
-    "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",
-    "rollup": "^4.50.1",
-    "typescript": "^5.5.4",
-    "typescript-transform-paths": "^3.4.6"
-  },
-  "dependencies": {
-    "@studyportals/domain-client": "^7.4.0",
-    "@studyportals/search-filters": "^6.3.1"
-  }
+	"name": "@studyportals/search-api-interface",
+	"version": "3.4.2-27",
+	"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/domain-client": "^7.4.0",
+		"@studyportals/search-filters": "^6.3.1"
+	}
 }

package/src/suggestions/ISuggestionResult.d.ts

@@ -1,4 +1,8 @@
 export interface ISuggestionResult {
     suggestion: string;
-    amount_of_programmes: number;
+    amount_of_programmes_master: number;
+    amount_of_programmes_phd: number;
+    amount_of_programmes_bachelor: number;
+    amount_of_programmes_short: number;
+    amount_of_programmes_distance_learning: number;
 }

package/index.cjs

@@ -1,490 +0,0 @@
-'use strict';
-
-var domainClient = require('@studyportals/domain-client');
-
-exports.HitsTotalRelation = void 0;
-(function (HitsTotalRelation) {
-    HitsTotalRelation["EXACTLY"] = "exactly";
-    HitsTotalRelation["MORE_THAN"] = "more than";
-})(exports.HitsTotalRelation || (exports.HitsTotalRelation = {}));
-
-exports.DegreeTypeEnum = void 0;
-(function (DegreeTypeEnum) {
-    DegreeTypeEnum[DegreeTypeEnum["MASTER"] = 0] = "MASTER";
-    DegreeTypeEnum[DegreeTypeEnum["BACHELOR"] = 1] = "BACHELOR";
-    DegreeTypeEnum[DegreeTypeEnum["PHD"] = 2] = "PHD";
-    DegreeTypeEnum[DegreeTypeEnum["DISTANCE_LEARNING"] = 3] = "DISTANCE_LEARNING";
-    DegreeTypeEnum[DegreeTypeEnum["SHORT_COURSES"] = 4] = "SHORT_COURSES";
-})(exports.DegreeTypeEnum || (exports.DegreeTypeEnum = {}));
-
-exports.DeliveryMethodEnum = void 0;
-(function (DeliveryMethodEnum) {
-    DeliveryMethodEnum["ONLINE"] = "online";
-    DeliveryMethodEnum["ON_CAMPUS"] = "oncampus";
-    DeliveryMethodEnum["BLENDED"] = "blended";
-})(exports.DeliveryMethodEnum || (exports.DeliveryMethodEnum = {}));
-
-class IOrganisationSearchFilters {
-    organisationId;
-    degree;
-    disciplines;
-    deliveryMethods;
-    countryIsoCodes;
-    countryIsoCodesOfMainLocations;
-    regionIds;
-    areaIds;
-    cityIds;
-    virtualPath;
-}
-
-class OrganisationSearchFilters {
-    organisationId;
-    degree;
-    disciplines;
-    deliveryMethods;
-    countryIsoCodes;
-    countryIsoCodesOfMainLocations;
-    regionIds;
-    areaIds;
-    cityIds;
-    virtualPath;
-    from(input) {
-        this.organisationId = input.organisationId ? input.organisationId.toString() : undefined;
-        this.degree = input.degree;
-        this.deliveryMethods = input.deliveryMethods;
-        this.disciplines = this.numbersToStringsOrUndefined(input.disciplines);
-        this.countryIsoCodes = input.countryIsoCodes;
-        this.countryIsoCodesOfMainLocations = input.countryIsoCodesOfMainLocations;
-        this.regionIds = this.numbersToStringsOrUndefined(input.regionIds);
-        this.areaIds = this.numbersToStringsOrUndefined(input.areaIds);
-        this.cityIds = this.numbersToStringsOrUndefined(input.cityIds);
-        this.virtualPath = input.virtualPath;
-        return this;
-    }
-    consideringId(id) {
-        this.organisationId = id;
-        return this;
-    }
-    consideringDegree(degree) {
-        this.degree = degree;
-        return this;
-    }
-    consideringDisciplines(disciplines) {
-        this.disciplines = disciplines;
-        return this;
-    }
-    consideringDeliveryMethods(deliveryMethods) {
-        this.deliveryMethods = deliveryMethods;
-        return this;
-    }
-    consideringCountryIsoCodes(countryIsoCodes) {
-        this.countryIsoCodes = countryIsoCodes;
-        return this;
-    }
-    consideringCountryIsoCodesOfMainLocations(countryIsoCodes) {
-        this.countryIsoCodesOfMainLocations = countryIsoCodes;
-        return this;
-    }
-    consideringRegionIds(regionIds) {
-        this.regionIds = regionIds;
-        return this;
-    }
-    consideringAreaIds(areaIds) {
-        this.areaIds = areaIds;
-        return this;
-    }
-    consideringCityIds(cityIds) {
-        this.cityIds = cityIds;
-        return this;
-    }
-    consideringVirtualPath(virtualPath) {
-        this.virtualPath = virtualPath;
-        return this;
-    }
-    numbersToStringsOrUndefined(values) {
-        if (values === undefined)
-            return;
-        return values.map(value => value.toString());
-    }
-}
-
-class SearchApiClientBase {
-    domain;
-    apiUriBase;
-    constructor(domain, apiUriBase) {
-        this.domain = domain;
-        this.apiUriBase = apiUriBase;
-    }
-    constructUri(relativeUri) {
-        return `${this.apiUriBase}/${this.domain}/${relativeUri}`;
-    }
-}
-
-class SearchApiOrganisationClient extends SearchApiClientBase {
-    requestFactory;
-    requestSender;
-    organisationCardFactory = new domainClient.OrganisationCardClient();
-    constructor(apiUriBase, requestFactory, requestSender) {
-        super("organisations", apiUriBase);
-        this.requestFactory = requestFactory;
-        this.requestSender = requestSender;
-        this.organisationCardFactory = new domainClient.OrganisationCardClient("N/A", "N/A", 1);
-    }
-    async searchCards(filters, resultSize, resultOffset) {
-        const request = this.requestFactory.get(this.constructUri("search"))
-            .query({ ...filters, resultSize, resultOffset });
-        const result = await this.requestSender.sendAndExtractBody(request);
-        return {
-            ...result,
-            organisations: this.organisationCardFactory.fromDescriptions([...result.organisations])
-        };
-    }
-    async searchIds(filters, resultSize, resultOffset) {
-        const request = this.requestFactory.get(this.constructUri("search/ids"))
-            .query({ ...filters, resultSize, resultOffset });
-        return await this.requestSender.sendAndExtractBody(request);
-    }
-}
-
-class IProgrammeResult {
-    is_premium;
-    card;
-}
-
-class IProgrammeSearchFilters {
-    attendances;
-    degreeTypes;
-    disciplines;
-    durations;
-    educationalLevels;
-    educationalForms;
-    densities;
-    text;
-    areaIds;
-    regionIds;
-    countryIsoCodes;
-    organisationIds;
-    specialProgrammes;
-    tuitionFeeMin;
-    tuitionFeeMax;
-    nationalityCountryIso;
-    sortBy;
-    suggestionSize;
-    facets;
-    facetsDurations;
-    campaignTypes;
-    textSearchAlgorithm;
-    showHidden;
-}
-
-exports.ProgrammeSortType = void 0;
-(function (ProgrammeSortType) {
-    ProgrammeSortType["DEFAULT"] = "default";
-    ProgrammeSortType["TUITION"] = "tuition";
-})(exports.ProgrammeSortType || (exports.ProgrammeSortType = {}));
-
-class ProgrammeSearchFilters {
-    attendances;
-    degreeTypes;
-    disciplines;
-    durations;
-    educationalLevels;
-    educationalForms;
-    densities;
-    text;
-    areaIds;
-    regionIds;
-    countryIsoCodes;
-    organisationIds;
-    specialProgrammes;
-    tuitionFeeMin;
-    tuitionFeeMax;
-    nationalityCountryIso;
-    sortBy;
-    suggestionSize;
-    facets;
-    facetsDurations;
-    textSearchAlgorithm;
-    showHidden;
-    campaignTypes;
-    from(input) {
-        this.attendances = input.attendances;
-        this.degreeTypes = input.degreeTypes;
-        this.durations = input.durations;
-        this.disciplines = this.numbersToStringsOrUndefined(input.disciplines);
-        this.educationalLevels = input.educationalLevels;
-        this.educationalForms = input.educationalForms;
-        this.densities = input.densities;
-        this.text = input.text;
-        this.areaIds = this.numbersToStringsOrUndefined(input.areaIds);
-        this.regionIds = this.numbersToStringsOrUndefined(input.regionIds);
-        this.countryIsoCodes = input.countryIsoCodes;
-        this.organisationIds = input.organisationIds ? input.organisationIds.map(id => id.toString()) : undefined;
-        this.specialProgrammes = input.specialProgrammes;
-        this.nationalityCountryIso = input.nationalityCountryIso;
-        this.tuitionFeeMin = input.tuitionFeeMin;
-        this.tuitionFeeMax = input.tuitionFeeMax;
-        this.sortBy = input.sortBy || exports.ProgrammeSortType.DEFAULT;
-        this.suggestionSize = input.suggestionSize;
-        this.facets = input.facets;
-        this.facetsDurations = input.facetsDurations;
-        this.textSearchAlgorithm = input.textSearchAlgorithm;
-        this.showHidden = input.showHidden;
-        this.campaignTypes = input.campaignTypes;
-        return this;
-    }
-    numbersToStringsOrUndefined(values) {
-        if (values === undefined)
-            return;
-        return values.map(value => value.toString());
-    }
-}
-
-class SearchApiProgrammeClient extends SearchApiClientBase {
-    requestFactory;
-    requestSender;
-    programmeCardFactory = new domainClient.ProgrammeCardClient();
-    constructor(apiUriBase, requestFactory, requestSender, portalMap) {
-        super("programmes", apiUriBase);
-        this.requestFactory = requestFactory;
-        this.requestSender = requestSender;
-        this.programmeCardFactory = new domainClient.ProgrammeCardClient("N/A", "N/A", 1, portalMap);
-    }
-    async searchCards(filters, resultSize, resultOffset) {
-        const request = this.requestFactory.get(this.constructUri("search"))
-            .query({ ...filters, resultSize, resultOffset });
-        const result = await this.requestSender.sendAndExtractBody(request);
-        const programmeResults = result.programmes.map(result => ({
-            card: this.programmeCardFactory.fromDescription(result.card),
-            is_premium: result.is_premium
-        }));
-        return {
-            ...result,
-            programmes: programmeResults,
-            facets: result.facets ?? []
-        };
-    }
-    async searchIds(filters, resultSize, resultOffset) {
-        const request = this.requestFactory.get(this.constructUri("search/ids"))
-            .query({ ...filters, resultSize, resultOffset });
-        return await this.requestSender.sendAndExtractBody(request);
-    }
-}
-
-exports.TextSearchAlgorithmType = void 0;
-(function (TextSearchAlgorithmType) {
-    TextSearchAlgorithmType["KEYWORD"] = "keyword";
-    TextSearchAlgorithmType["HYBRID"] = "hybrid";
-    TextSearchAlgorithmType["SIMILARITY_SEARCH"] = "similarity";
-})(exports.TextSearchAlgorithmType || (exports.TextSearchAlgorithmType = {}));
-
-exports.ProgrammeFilterType = void 0;
-(function (ProgrammeFilterType) {
-    ProgrammeFilterType["ATTENDANCES"] = "attendances";
-    ProgrammeFilterType["DEGREE_TYPES"] = "degreeTypes";
-    ProgrammeFilterType["DISCIPLINES"] = "disciplines";
-    ProgrammeFilterType["DURATIONS"] = "durations";
-    ProgrammeFilterType["EDUCATIONAL_LEVELS"] = "educationalLevels";
-    ProgrammeFilterType["EDUCATIONAL_FORMS"] = "educationalForms";
-    ProgrammeFilterType["DENSITIES"] = "densities";
-    ProgrammeFilterType["TEXT"] = "text";
-    ProgrammeFilterType["AREA_IDS"] = "areaIds";
-    ProgrammeFilterType["REGION_IDS"] = "regionIds";
-    ProgrammeFilterType["COUNTRY_ISO_CODES"] = "countryIsoCodes";
-    ProgrammeFilterType["ORGANISATION_IDS"] = "organisationIds";
-    ProgrammeFilterType["SPECIAL_PROGRAMMES"] = "specialProgrammes";
-    ProgrammeFilterType["TUITION_FEE_MIN"] = "tuitionFeeMin";
-    ProgrammeFilterType["TUITION_FEE_MAX"] = "tuitionFeeMax";
-    ProgrammeFilterType["NATIONALITY_COUNTRY_ISO"] = "nationalityCountryIso";
-})(exports.ProgrammeFilterType || (exports.ProgrammeFilterType = {}));
-
-class ScholarshipSearchFilters {
-    title;
-    disciplineIds;
-    destinationCountryIsoCodes;
-    destinationRegionIds;
-    originCountryIsoCodes;
-    universityProviderIds;
-    degree;
-    formats;
-    types;
-    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.ScholarshipFormat = void 0;
-(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";
-})(exports.ScholarshipFormat || (exports.ScholarshipFormat = {}));
-
-exports.ScholarshipType = void 0;
-(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";
-})(exports.ScholarshipType || (exports.ScholarshipType = {}));
-
-class SearchApiScholarshipClient extends SearchApiClientBase {
-    requestFactory;
-    requestSender;
-    scholarshipCardFactory;
-    constructor(apiUriBase, requestFactory, requestSender, portalMap) {
-        super("scholarships", apiUriBase);
-        this.requestFactory = requestFactory;
-        this.requestSender = requestSender;
-        this.scholarshipCardFactory = new domainClient.ScholarshipCardV2Client("N/A", "N/A", 1, portalMap);
-    }
-    async searchCards(filters, resultSize, resultOffset) {
-        const request = this.requestFactory.get(this.constructUri("search"))
-            .query({ ...filters, resultSize, resultOffset });
-        const result = await this.requestSender.sendAndExtractBody(request);
-        return {
-            ...result,
-            scholarships: this.scholarshipCardFactory.fromDescriptions([...result.scholarships])
-        };
-    }
-    async count(filters) {
-        const request = this.requestFactory.get(this.constructUri("count"))
-            .query({ ...filters });
-        return await this.requestSender.sendAndExtractBody(request);
-    }
-}
-
-class SearchApiCityClient extends SearchApiClientBase {
-    requestFactory;
-    requestSender;
-    constructor(apiUriBase, requestFactory, requestSender) {
-        super("cities", apiUriBase);
-        this.requestFactory = requestFactory;
-        this.requestSender = requestSender;
-    }
-    async search(filters, resultSize, resultOffset) {
-        const request = this.requestFactory.get(this.constructUri("search"))
-            .query({ ...filters, resultSize, resultOffset });
-        const result = await this.requestSender.sendAndExtractBody(request);
-        return result;
-    }
-}
-
-class CitySearchFilters {
-    id;
-    nameSearchTerm;
-    virtualPath;
-    areaIds;
-    countryIsoCodes;
-    from(input) {
-        this.id = input.id?.toString();
-        this.nameSearchTerm = input.nameSearchTerm;
-        this.virtualPath = input.virtualPath;
-        this.areaIds = this.numbersToStringsOrUndefined(input.areaIds);
-        this.countryIsoCodes = input.countryIsoCodes;
-        return this;
-    }
-    consideringId(id) {
-        this.id = id;
-        return this;
-    }
-    consideringNameSearchTerm(searchTerm) {
-        this.nameSearchTerm = searchTerm;
-        return this;
-    }
-    consideringVirtualPath(virtualPath) {
-        this.virtualPath = virtualPath;
-        return this;
-    }
-    consideringAreaIds(areaIds) {
-        this.areaIds = areaIds;
-        return this;
-    }
-    consideringCountryIsoCodes(countryIsoCodes) {
-        this.countryIsoCodes = countryIsoCodes;
-        return this;
-    }
-    numbersToStringsOrUndefined(values) {
-        if (!values)
-            return;
-        return values.map(value => value.toString());
-    }
-}
-
-exports.CitySearchFilters = CitySearchFilters;
-exports.IOrganisationSearchFilters = IOrganisationSearchFilters;
-exports.IProgrammeResult = IProgrammeResult;
-exports.IProgrammeSearchFilters = IProgrammeSearchFilters;
-exports.OrganisationSearchFilters = OrganisationSearchFilters;
-exports.ProgrammeSearchFilters = ProgrammeSearchFilters;
-exports.ScholarshipSearchFilters = ScholarshipSearchFilters;
-exports.SearchApiCityClient = SearchApiCityClient;
-exports.SearchApiOrganisationClient = SearchApiOrganisationClient;
-exports.SearchApiProgrammeClient = SearchApiProgrammeClient;
-exports.SearchApiScholarshipClient = SearchApiScholarshipClient;