@studyportals/search-api-interface 1.2.2-0 → 1.2.2-1

package/.eslintignore

@@ -0,0 +1 @@
+**/bin/**

package/.eslintrc.yml

@@ -0,0 +1,4 @@
+extends: ./node_modules/@studyportals/code-style/.eslintrc.js
+
+rules:
+  eol-last: 2

package/bin/package.json

@@ -0,0 +1,31 @@
+{
+	"name": "@studyportals/search-api-interface",
+	"version": "1.2.2-1",
+	"description": "Typescript library containing resources that facilitate integration with SearchApi",
+	"main": "bin/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": "^4.7.3",
+		"typescript-transform-paths": "^3.4.6"
+	},
+	"dependencies": {
+		"@studyportals/search-filters": "^4.3.0"
+	}
+}

package/{src → bin/src}/organisations/DegreeTypeEnum.js

@@ -8,5 +8,5 @@ var DegreeTypeEnum;
     DegreeTypeEnum[DegreeTypeEnum["PHD"] = 2] = "PHD";
     DegreeTypeEnum[DegreeTypeEnum["DISTANCE_LEARNING"] = 3] = "DISTANCE_LEARNING";
     DegreeTypeEnum[DegreeTypeEnum["SHORT_COURSES"] = 4] = "SHORT_COURSES";
-})(DegreeTypeEnum || (exports.DegreeTypeEnum = DegreeTypeEnum = {}));
+})(DegreeTypeEnum = exports.DegreeTypeEnum || (exports.DegreeTypeEnum = {}));
 //# sourceMappingURL=DegreeTypeEnum.js.map

package/{src → bin/src}/organisations/DegreeTypeEnum.js.map

@@ -1 +1 @@
-{"version":3,"file":"DegreeTypeEnum.js","sourceRoot":"","sources":["../../../src/organisations/DegreeTypeEnum.ts"],"names":[],"mappings":";;;AAAA,IAAY,cAMX;AAND,WAAY,cAAc;IACzB,uDAAU,CAAA;IACV,2DAAY,CAAA;IACZ,iDAAO,CAAA;IACP,6EAAqB,CAAA;IACrB,qEAAiB,CAAA;AAClB,CAAC,EANW,cAAc,8BAAd,cAAc,QAMzB"}
+{"version":3,"file":"DegreeTypeEnum.js","sourceRoot":"","sources":["../../../src/organisations/DegreeTypeEnum.ts"],"names":[],"mappings":";;;AAAA,IAAY,cAMX;AAND,WAAY,cAAc;IACzB,uDAAU,CAAA;IACV,2DAAY,CAAA;IACZ,iDAAO,CAAA;IACP,6EAAqB,CAAA;IACrB,qEAAiB,CAAA;AAClB,CAAC,EANW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAMzB"}

package/{src → bin/src}/organisations/DeliveryMethodEnum.js

@@ -6,5 +6,5 @@ var DeliveryMethodEnum;
     DeliveryMethodEnum["ONLINE"] = "online";
     DeliveryMethodEnum["ON_CAMPUS"] = "oncampus";
     DeliveryMethodEnum["BLENDED"] = "blended";
-})(DeliveryMethodEnum || (exports.DeliveryMethodEnum = DeliveryMethodEnum = {}));
+})(DeliveryMethodEnum = exports.DeliveryMethodEnum || (exports.DeliveryMethodEnum = {}));
 //# sourceMappingURL=DeliveryMethodEnum.js.map

package/{src → bin/src}/organisations/DeliveryMethodEnum.js.map

@@ -1 +1 @@
-{"version":3,"file":"DeliveryMethodEnum.js","sourceRoot":"","sources":["../../../src/organisations/DeliveryMethodEnum.ts"],"names":[],"mappings":";;;AAAA,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC7B,uCAAiB,CAAA;IACjB,4CAAsB,CAAA;IACtB,yCAAmB,CAAA;AACpB,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B"}
+{"version":3,"file":"DeliveryMethodEnum.js","sourceRoot":"","sources":["../../../src/organisations/DeliveryMethodEnum.ts"],"names":[],"mappings":";;;AAAA,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC7B,uCAAiB,CAAA;IACjB,4CAAsB,CAAA;IACtB,yCAAmB,CAAA;AACpB,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B"}

package/bin/src/programmes/IProgrammeSearchFilters.d.ts

@@ -0,0 +1,17 @@
+import { AttendanceFilterOptionValue, DegreeTypeFilterOptionValue, DurationFilterOptionValue, EducationLevelFilterOptionValue, EducationalFormFilterOptionValue, SpecialProgrammesFilterOptionValue } from "@studyportals/search-filters";
+import { TuitionFeeFilterValueDTO } from "./TuitionFeeFilterValueDTO";
+export declare class IProgrammeSearchFilters {
+    readonly attendances?: AttendanceFilterOptionValue[];
+    readonly degreeTypes?: DegreeTypeFilterOptionValue[];
+    readonly disciplines?: string[];
+    readonly durations?: DurationFilterOptionValue[];
+    readonly educationalLevels?: EducationLevelFilterOptionValue[];
+    readonly educationalForms?: EducationalFormFilterOptionValue[];
+    readonly keyword?: string;
+    readonly areaIds?: string[];
+    readonly regionIds?: string[];
+    readonly countryIsoCodes?: string[];
+    readonly organisationId?: string;
+    readonly specialProgrammes?: SpecialProgrammesFilterOptionValue[];
+    readonly tuitionFee?: TuitionFeeFilterValueDTO;
+}

package/{src → bin/src}/programmes/IProgrammeSearchFilters.js.map

@@ -1 +1 @@
-{"version":3,"file":"IProgrammeSearchFilters.js","sourceRoot":"","sources":["../../../src/programmes/IProgrammeSearchFilters.ts"],"names":[],"mappings":";;;AAAA,MAAa,uBAAuB;CAmBnC;AAnBD,0DAmBC"}
+{"version":3,"file":"IProgrammeSearchFilters.js","sourceRoot":"","sources":["../../../src/programmes/IProgrammeSearchFilters.ts"],"names":[],"mappings":";;;AAWA,MAAa,uBAAuB;CAgBnC;AAhBD,0DAgBC"}

package/bin/src/programmes/ProgrammeSearchFilters.d.ts

@@ -0,0 +1,23 @@
+import { IProgrammeSearchFilters } from "./IProgrammeSearchFilters";
+import { ProgrammeSearchInput } from "./ProgrammeSearchInput";
+import { AttendanceFilterOptionValue, DegreeTypeFilterOptionValue, DurationFilterOptionValue, EducationLevelFilterOptionValue, EducationalFormFilterOptionValue, SpecialProgrammesFilterOptionValue } from "@studyportals/search-filters";
+export declare class ProgrammeSearchFilters implements IProgrammeSearchFilters {
+    attendances?: AttendanceFilterOptionValue[];
+    degreeTypes?: DegreeTypeFilterOptionValue[];
+    disciplines?: string[];
+    durations?: DurationFilterOptionValue[];
+    educationalLevels?: EducationLevelFilterOptionValue[];
+    educationalForms?: EducationalFormFilterOptionValue[];
+    keyword?: string;
+    areaIds?: string[];
+    regionIds?: string[];
+    countryIsoCodes?: string[];
+    organisationId?: string;
+    specialProgrammes?: SpecialProgrammesFilterOptionValue[];
+    tuitionFee?: {
+        min: number;
+        max: number;
+    };
+    from(input: ProgrammeSearchInput): IProgrammeSearchFilters;
+    private numbersToStringsOrUndefined;
+}

package/bin/src/programmes/ProgrammeSearchFilters.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProgrammeSearchFilters = void 0;
+class ProgrammeSearchFilters {
+    from(input) {
+        this.attendances = input.attendances;
+        this.degreeTypes = input.degreeTypes;
+        this.disciplines = this.numbersToStringsOrUndefined(input.disciplines);
+        this.durations = input.durations;
+        this.educationalLevels = input.educationalLevels;
+        this.educationalForms = input.educationalForms;
+        this.keyword = input.keyword;
+        this.areaIds = this.numbersToStringsOrUndefined(input.areaIds);
+        this.regionIds = this.numbersToStringsOrUndefined(input.regionIds);
+        this.countryIsoCodes = input.countryIsoCodes;
+        this.organisationId = input.organisationId ? input.organisationId.toString() : undefined;
+        this.specialProgrammes = input.specialProgrammes;
+        this.tuitionFee = input.tuitionFee;
+        return this;
+    }
+    numbersToStringsOrUndefined(values) {
+        if (values === undefined)
+            return;
+        return values.map(value => value.toString());
+    }
+}
+exports.ProgrammeSearchFilters = ProgrammeSearchFilters;
+//# sourceMappingURL=ProgrammeSearchFilters.js.map

package/{src → bin/src}/programmes/ProgrammeSearchFilters.js.map

@@ -1 +1 @@
-{"version":3,"file":"ProgrammeSearchFilters.js","sourceRoot":"","sources":["../../../src/programmes/ProgrammeSearchFilters.ts"],"names":[],"mappings":";;;AAGA,MAAa,sBAAsB;IAoB3B,IAAI,CAAC,KAA2B;QACtC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACvE,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACjD,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAE7B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QAE7C,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACzF,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAA;QAEhD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QAEnC,OAAO,IAAI,CAAC;IACb,CAAC;IACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAkCI;IAEK,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;AAhFD,wDAgFC"}
+{"version":3,"file":"ProgrammeSearchFilters.js","sourceRoot":"","sources":["../../../src/programmes/ProgrammeSearchFilters.ts"],"names":[],"mappings":";;;AAcA,MAAa,sBAAsB;IAoB3B,IAAI,CAAC,KAA2B;QACtC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACvE,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACjD,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAE7B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QAE7C,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACzF,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAA;QAEhD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QAEnC,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;AA7CD,wDA6CC"}

package/bin/src/programmes/ProgrammeSearchInput.d.ts

@@ -0,0 +1,19 @@
+import { AttendanceFilterOptionValue, DegreeTypeFilterOptionValue, DurationFilterOptionValue, EducationLevelFilterOptionValue, EducationalFormFilterOptionValue, SpecialProgrammesFilterOptionValue } from "@studyportals/search-filters";
+import { TuitionFeeFilterValueDTO } from "./TuitionFeeFilterValueDTO";
+export type ProgrammeSearchInput = {
+    resultSize: number;
+    resultOffset: number;
+    attendances?: AttendanceFilterOptionValue[];
+    degreeTypes?: DegreeTypeFilterOptionValue[];
+    disciplines?: number[];
+    durations?: DurationFilterOptionValue[];
+    educationalLevels?: EducationLevelFilterOptionValue[];
+    educationalForms?: EducationalFormFilterOptionValue[];
+    keyword: string;
+    areaIds?: number[];
+    regionIds?: number[];
+    countryIsoCodes?: string[];
+    organisationId?: number;
+    specialProgrammes?: SpecialProgrammesFilterOptionValue[];
+    tuitionFee?: TuitionFeeFilterValueDTO;
+};

package/bin/src/programmes/TuitionFeeFilterValueDTO.d.ts

@@ -0,0 +1,4 @@
+export interface TuitionFeeFilterValueDTO {
+    min: number;
+    max: number;
+}

package/bin/src/programmes/TuitionFeeFilterValueDTO.js

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

package/bin/src/programmes/TuitionFeeFilterValueDTO.js.map

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

package/index.ts

@@ -0,0 +1,30 @@
+import { DegreeTypeEnum } from "./src/organisations/DegreeTypeEnum";
+import { DeliveryMethodEnum } from "./src/organisations/DeliveryMethodEnum";
+import { IOrganisationSearchFilters } from "./src/organisations/IOrganisationSearchFilters";
+import { IOrganisationSearchResponse } from "./src/organisations/IOrganisationSearchResponse";
+import { OrganisationSearchFilters } from "./src/organisations/OrganisationSearchFilters";
+import { OrganisationSearchInput } from "./src/organisations/OrganisationSearchInput";
+import { SearchApiOrganisationClient } from "./src/organisations/SearchApiOrganisationClient";
+import { IProgrammeSearchFilters } from "./src/programmes/IProgrammeSearchFilters";
+import { IProgrammeSearchResponse } from "./src/programmes/IProgrammeSearchResponse";
+import { ProgrammeSearchFilters } from "./src/programmes/ProgrammeSearchFilters";
+import { ProgrammeSearchInput } from "./src/programmes/ProgrammeSearchInput";
+import { SearchApiProgrammeClient } from "./src/programmes/SearchApiProgrammeClient";
+
+export {
+	SearchApiOrganisationClient,
+	IOrganisationSearchResponse,
+	IOrganisationSearchFilters,
+	OrganisationSearchFilters,
+
+	SearchApiProgrammeClient,
+	IProgrammeSearchResponse,
+	IProgrammeSearchFilters,
+	ProgrammeSearchFilters,
+
+	OrganisationSearchInput,
+	ProgrammeSearchInput,
+
+	DegreeTypeEnum,
+	DeliveryMethodEnum
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@studyportals/search-api-interface",
-	"version": "1.2.2-0",
+	"version": "1.2.2-1",
 	"description": "Typescript library containing resources that facilitate integration with SearchApi",
 	"main": "bin/index.js",
 	"scripts": {
@@ -25,5 +25,7 @@
 		"typescript": "^4.7.3",
 		"typescript-transform-paths": "^3.4.6"
 	},
-	"dependencies": {}
+	"dependencies": {
+		"@studyportals/search-filters": "^4.3.0"
+	}
 }

package/src/SearchApiClientBase.ts

@@ -0,0 +1,10 @@
+export class SearchApiClientBase {
+	public constructor(private readonly domain: string,
+		private readonly apiUriBase: string
+	) {
+	}
+
+	protected constructUri(relativeUri: string): string {
+		return `${this.apiUriBase}/${this.domain}/${relativeUri}`;
+	}
+}

package/src/organisations/DegreeTypeEnum.ts

@@ -0,0 +1,7 @@
+export enum DegreeTypeEnum {
+	MASTER = 0,
+	BACHELOR = 1,
+	PHD = 2,
+	DISTANCE_LEARNING = 3,
+	SHORT_COURSES = 4,
+}

package/src/organisations/DeliveryMethodEnum.ts

@@ -0,0 +1,5 @@
+export enum DeliveryMethodEnum {
+	ONLINE = "online",
+	ON_CAMPUS = "oncampus",
+	BLENDED = "blended"
+}

package/src/organisations/IOrganisationSearchFilters.ts

@@ -0,0 +1,12 @@
+import { DegreeTypeEnum } from "./DegreeTypeEnum";
+import { DeliveryMethodEnum } from "./DeliveryMethodEnum";
+
+export class IOrganisationSearchFilters {
+	readonly organisationId: string | undefined;
+	readonly degree: DegreeTypeEnum | undefined;
+	readonly disciplines: string[] | undefined;
+	readonly deliveryMethods: DeliveryMethodEnum[] | undefined;
+	readonly countryIsoCodes: string[] | undefined;
+	readonly regionIds: string[] | undefined;
+	readonly areaIds: string[] | undefined;
+}

package/src/organisations/IOrganisationSearchResponse.ts

@@ -0,0 +1,5 @@
+export interface IOrganisationSearchResponse<T> {
+	readonly organisations: readonly T[];
+	readonly hitsTotal: number;
+	readonly hitsTotalRelation: "more than" | "exactly";
+}

package/src/organisations/OrganisationSearchFilters.ts

@@ -0,0 +1,65 @@
+import { DegreeTypeEnum } from "./DegreeTypeEnum";
+import { DeliveryMethodEnum } from "./DeliveryMethodEnum";
+import { OrganisationSearchInput } from "./OrganisationSearchInput";
+import { IOrganisationSearchFilters } from "./IOrganisationSearchFilters";
+
+export class OrganisationSearchFilters implements IOrganisationSearchFilters {
+	public organisationId: string | undefined;
+	public degree: DegreeTypeEnum | undefined;
+	public disciplines: string[] | undefined;
+	public deliveryMethods: DeliveryMethodEnum[] | undefined;
+	public countryIsoCodes: string[] | undefined;
+	public regionIds: string[] | undefined;
+	public areaIds: string[] | undefined;
+
+	public from(input: OrganisationSearchInput): OrganisationSearchFilters {
+		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.regionIds = this.numbersToStringsOrUndefined(input.regionIds);
+		this.areaIds = this.numbersToStringsOrUndefined(input.areaIds);
+		return this;
+	}
+
+	public consideringId(id: string): OrganisationSearchFilters {
+		this.organisationId = id;
+		return this;
+	}
+
+	public consideringDegree(degree: DegreeTypeEnum): OrganisationSearchFilters {
+		this.degree = degree;
+		return this;
+	}
+
+	public consideringDisciplines(disciplines: string[]): OrganisationSearchFilters {
+		this.disciplines = disciplines;
+		return this;
+	}
+
+	public consideringDeliveryMethods(deliveryMethods: DeliveryMethodEnum[]): OrganisationSearchFilters {
+		this.deliveryMethods = deliveryMethods;
+		return this;
+	}
+
+	public consideringCountryIsoCodes(countryIsoCodes: string[]): OrganisationSearchFilters {
+		this.countryIsoCodes = countryIsoCodes;
+		return this;
+	}
+
+	public consideringRegionIds(regionIds: string[]): OrganisationSearchFilters {
+		this.regionIds = regionIds;
+		return this;
+	}
+
+	public consideringAreaIds(areaIds: string[]): OrganisationSearchFilters {
+		this.areaIds = areaIds;
+		return this;
+	}
+
+	private numbersToStringsOrUndefined(values: number[] | undefined): string[] | undefined {
+		if (values === undefined) return;
+		return values.map(value => value.toString());
+	}
+}

package/src/organisations/OrganisationSearchInput.ts

@@ -0,0 +1,14 @@
+import { DegreeTypeEnum } from "./DegreeTypeEnum";
+import { DeliveryMethodEnum } from "./DeliveryMethodEnum";
+
+export type OrganisationSearchInput = {
+	resultSize: number,
+	resultOffset: number,
+	organisationId?: number,
+	disciplines?: number[],
+	countryIsoCodes?: string[],
+	regionIds?: number[],
+	areaIds?: number[],
+	degree?: DegreeTypeEnum,
+	deliveryMethods?: DeliveryMethodEnum[]
+};

package/src/organisations/SearchApiOrganisationClient.ts

@@ -0,0 +1,42 @@
+import { SearchApiClientBase } from "../SearchApiClientBase";
+import { IRequestSender, ISuperAgentRequestFactory } from "@studyportals/mb-platform-http-requests";
+import { IOrganisationCard, OrganisationCardClient } from "@studyportals/domain-client";
+import { IOrganisationSearchResponse } from "./IOrganisationSearchResponse";
+import { IModelDescription } from "@studyportals/domain-client/src/i-model-description";
+
+export class SearchApiOrganisationClient extends SearchApiClientBase {
+
+	private readonly requestFactory: ISuperAgentRequestFactory;
+	private readonly requestSender: IRequestSender;
+	private readonly organisationCardFactory = new OrganisationCardClient();
+
+	public constructor(apiUriBase: string,
+		requestFactory: ISuperAgentRequestFactory,
+		requestSender: IRequestSender
+	) {
+		super("organisations", apiUriBase);
+
+		this.requestFactory = requestFactory;
+		this.requestSender = requestSender;
+		this.organisationCardFactory = new OrganisationCardClient("N/A", "N/A", 1);
+	}
+
+	public async searchCards(filters: any, resultSize: number, resultOffset: number): Promise<IOrganisationSearchResponse<IOrganisationCard>> {
+		const request = this.requestFactory.get(this.constructUri("search"))
+			.query({ ...filters, resultSize, resultOffset });
+
+		const result = await this.requestSender.sendAndExtractBody<IOrganisationSearchResponse<IModelDescription>>(request);
+
+		return {
+			...result,
+			organisations: this.organisationCardFactory.fromDescriptions([...result.organisations])
+		}
+	}
+
+	public async searchIds(filters: any, resultSize: number, resultOffset: number): Promise<IOrganisationSearchResponse<string>> {
+		const request = this.requestFactory.get(this.constructUri("search/ids"))
+			.query({ ...filters, resultSize, resultOffset });
+
+		return await this.requestSender.sendAndExtractBody<IOrganisationSearchResponse<string>>(request);
+	}
+}

package/src/programmes/IProgrammeSearchFilters.ts

@@ -0,0 +1,28 @@
+import {
+	AttendanceFilterOptionValue,
+	DegreeTypeFilterOptionValue,
+	DurationFilterOptionValue,
+	EducationLevelFilterOptionValue,
+	EducationalFormFilterOptionValue,
+	SpecialProgrammesFilterOptionValue
+} from "@studyportals/search-filters";
+
+import { TuitionFeeFilterValueDTO } from "./TuitionFeeFilterValueDTO";
+
+export class IProgrammeSearchFilters {
+	readonly attendances?: AttendanceFilterOptionValue[];
+	readonly degreeTypes?: DegreeTypeFilterOptionValue[];
+	readonly disciplines?: string[];
+	readonly durations?: DurationFilterOptionValue[];
+	readonly educationalLevels?: EducationLevelFilterOptionValue[];
+	readonly educationalForms?: EducationalFormFilterOptionValue[];
+	readonly keyword?: string;
+
+	readonly areaIds?: string[];
+	readonly regionIds?: string[];
+	readonly countryIsoCodes?: string[];
+	readonly organisationId?: string;
+
+	readonly specialProgrammes?: SpecialProgrammesFilterOptionValue[];
+	readonly tuitionFee?: TuitionFeeFilterValueDTO
+}

package/src/programmes/IProgrammeSearchResponse.ts

@@ -0,0 +1,5 @@
+export interface IProgrammeSearchResponse<T> {
+	readonly programmes: readonly T[];
+	readonly hitsTotal: number;
+	readonly hitsTotalRelation: "more than" | "exactly";
+}

package/src/programmes/ProgrammeSearchFilters.ts

@@ -0,0 +1,60 @@
+import { IProgrammeSearchFilters } from "./IProgrammeSearchFilters";
+import { ProgrammeSearchInput } from "./ProgrammeSearchInput";
+
+import {
+	AttendanceFilterOptionValue,
+	DegreeTypeFilterOptionValue,
+	DurationFilterOptionValue,
+	EducationLevelFilterOptionValue,
+	EducationalFormFilterOptionValue,
+	SpecialProgrammesFilterOptionValue
+} from "@studyportals/search-filters";
+
+import { TuitionFeeFilterValueDTO } from "./TuitionFeeFilterValueDTO";
+
+export class ProgrammeSearchFilters implements IProgrammeSearchFilters {
+	public attendances?: AttendanceFilterOptionValue[];
+	public degreeTypes?: DegreeTypeFilterOptionValue[];
+	public disciplines?: string[];
+	public durations?: DurationFilterOptionValue[];
+	public educationalLevels?: EducationLevelFilterOptionValue[];
+	public educationalForms?: EducationalFormFilterOptionValue[];
+	public keyword?: string;
+
+	public areaIds?: string[];
+	public regionIds?: string[];
+	public countryIsoCodes?: string[];
+	public organisationId?: string;
+
+	public specialProgrammes?: SpecialProgrammesFilterOptionValue[];
+	public tuitionFee?: {
+		min: number
+		max: number
+	}
+
+	public from(input: ProgrammeSearchInput): IProgrammeSearchFilters {
+		this.attendances = input.attendances;
+		this.degreeTypes = input.degreeTypes;
+		this.disciplines = this.numbersToStringsOrUndefined(input.disciplines);
+		this.durations = input.durations;
+		this.educationalLevels = input.educationalLevels;
+		this.educationalForms = input.educationalForms;
+		this.keyword = input.keyword;
+
+		this.areaIds = this.numbersToStringsOrUndefined(input.areaIds);
+		this.regionIds = this.numbersToStringsOrUndefined(input.regionIds);
+		this.countryIsoCodes = input.countryIsoCodes;
+
+		this.organisationId = input.organisationId ? input.organisationId.toString() : undefined;
+		this.specialProgrammes = input.specialProgrammes
+
+		this.tuitionFee = input.tuitionFee;
+
+		return this;
+	}
+
+	private numbersToStringsOrUndefined(values: number[] | undefined): string[] | undefined {
+		if (values === undefined) return;
+		return values.map(value => value.toString());
+	}
+}

package/src/programmes/ProgrammeSearchInput.ts

@@ -0,0 +1,33 @@
+import {
+	AttendanceFilterOptionValue,
+	DegreeTypeFilterOptionValue,
+	DurationFilterOptionValue,
+	EducationLevelFilterOptionValue,
+	EducationalFormFilterOptionValue,
+	SpecialProgrammesFilterOptionValue
+} from "@studyportals/search-filters";
+
+import { TuitionFeeFilterValueDTO } from "./TuitionFeeFilterValueDTO";
+
+export type ProgrammeSearchInput = {
+	resultSize: number,
+	resultOffset: number,
+
+	attendances?: AttendanceFilterOptionValue[],
+	degreeTypes?: DegreeTypeFilterOptionValue[],
+	disciplines?: number[],
+	durations?: DurationFilterOptionValue[],
+	educationalLevels?: EducationLevelFilterOptionValue[],
+	educationalForms?: EducationalFormFilterOptionValue[]
+
+	keyword: string
+
+	areaIds?: number[],
+	regionIds?: number[],
+	countryIsoCodes?: string[],
+	organisationId?: number,
+
+	specialProgrammes?: SpecialProgrammesFilterOptionValue[]
+	tuitionFee?: TuitionFeeFilterValueDTO
+
+};

package/src/programmes/SearchApiProgrammeClient.ts

@@ -0,0 +1,42 @@
+import { SearchApiClientBase } from "../SearchApiClientBase";
+import { IRequestSender, ISuperAgentRequestFactory } from "@studyportals/mb-platform-http-requests";
+import { IModelDescription } from "@studyportals/domain-client/src/i-model-description";
+import { IProgrammeCard, ProgrammeCardClient } from "@studyportals/domain-client";
+import { IProgrammeSearchResponse } from "./IProgrammeSearchResponse";
+
+export class SearchApiProgrammeClient extends SearchApiClientBase {
+
+	private readonly requestFactory: ISuperAgentRequestFactory;
+	private readonly requestSender: IRequestSender;
+	private readonly organisationCardFactory = new ProgrammeCardClient();
+
+	public constructor(apiUriBase: string,
+		requestFactory: ISuperAgentRequestFactory,
+		requestSender: IRequestSender
+	) {
+		super("organisations", apiUriBase);
+
+		this.requestFactory = requestFactory;
+		this.requestSender = requestSender;
+		this.organisationCardFactory = new ProgrammeCardClient("N/A", "N/A", 1);
+	}
+
+	public async searchCards(filters: any, resultSize: number, resultOffset: number): Promise<IProgrammeSearchResponse<IProgrammeCard>> {
+		const request = this.requestFactory.get(this.constructUri("search"))
+			.query({ ...filters, resultSize, resultOffset });
+
+		const result = await this.requestSender.sendAndExtractBody<IProgrammeSearchResponse<IModelDescription>>(request);
+
+		return {
+			...result,
+			programmes: this.organisationCardFactory.fromDescriptions([...result.programmes])
+		}
+	}
+
+	public async searchIds(filters: any, resultSize: number, resultOffset: number): Promise<IProgrammeSearchResponse<string>> {
+		const request = this.requestFactory.get(this.constructUri("search/ids"))
+			.query({ ...filters, resultSize, resultOffset });
+
+		return await this.requestSender.sendAndExtractBody<IProgrammeSearchResponse<string>>(request);
+	}
+}

package/src/programmes/TuitionFeeFilterValueDTO.ts

@@ -0,0 +1,4 @@
+export interface TuitionFeeFilterValueDTO {
+	min: number;
+	max: number;
+}

package/tsconfig.json

@@ -0,0 +1,47 @@
+{
+	"compilerOptions": {
+		"outDir": "bin",
+		"declaration": true,
+		"rootDirs": [
+			"./"
+		],
+		"moduleResolution": "node",
+		"alwaysStrict": true,
+		"strictNullChecks": true,
+		"allowJs": false,
+		"allowUnreachableCode": false,
+		"allowUnusedLabels": false,
+		"noUnusedLocals": false,
+		"noUnusedParameters": false,
+		"noFallthroughCasesInSwitch": true,
+		"noImplicitAny": true,
+		"noImplicitReturns": true,
+		"noImplicitThis": true,
+		"sourceMap": true,
+		"target": "ES6",
+		"module": "commonjs",
+		"experimentalDecorators": true,
+		"paths": {
+			"@/*": [
+				"./*"
+			]
+		},
+		"plugins": [
+			{
+				"transform": "typescript-transform-paths"
+			},
+			{
+				"transform": "typescript-transform-paths",
+				"afterDeclarations": true
+			}
+		]
+	},
+	"typeRoots": [
+		"node_modules/@types/"
+	],
+	"exclude": [
+		"node_modules",
+		"bin",
+		".vscode"
+	]
+}

package/src/programmes/IProgrammeSearchFilters.d.ts

@@ -1,18 +0,0 @@
-export declare class IProgrammeSearchFilters {
-    readonly attendances?: string[];
-    readonly degreeTypes?: string[];
-    readonly disciplines?: string[];
-    readonly durations?: string[];
-    readonly educationalLevels?: string[];
-    readonly educationalForms?: string[];
-    readonly keyword?: string;
-    readonly areaIds?: string[];
-    readonly regionIds?: string[];
-    readonly countryIsoCodes?: string[];
-    readonly organisationId?: string;
-    readonly specialProgrammes?: string[];
-    readonly tuitionFee?: {
-        min: number;
-        max: number;
-    };
-}

package/src/programmes/ProgrammeSearchFilters.d.ts

@@ -1,22 +0,0 @@
-import { IProgrammeSearchFilters } from "./IProgrammeSearchFilters";
-import { ProgrammeSearchInput } from "./ProgrammeSearchInput";
-export declare class ProgrammeSearchFilters implements IProgrammeSearchFilters {
-    attendances?: string[];
-    degreeTypes?: string[];
-    disciplines?: string[];
-    durations?: string[];
-    educationalLevels?: string[];
-    educationalForms?: string[];
-    keyword?: string;
-    areaIds?: string[];
-    regionIds?: string[];
-    countryIsoCodes?: string[];
-    organisationId?: string;
-    specialProgrammes?: string[];
-    tuitionFee?: {
-        min: number;
-        max: number;
-    };
-    from(input: ProgrammeSearchInput): IProgrammeSearchFilters;
-    private numbersToStringsOrUndefined;
-}

package/src/programmes/ProgrammeSearchFilters.js

@@ -1,63 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProgrammeSearchFilters = void 0;
-class ProgrammeSearchFilters {
-    from(input) {
-        this.attendances = input.attendances;
-        this.degreeTypes = input.degreeTypes;
-        this.disciplines = this.numbersToStringsOrUndefined(input.disciplines);
-        this.durations = input.durations;
-        this.educationalLevels = input.educationalLevels;
-        this.educationalForms = input.educationalForms;
-        this.keyword = input.keyword;
-        this.areaIds = this.numbersToStringsOrUndefined(input.areaIds);
-        this.regionIds = this.numbersToStringsOrUndefined(input.regionIds);
-        this.countryIsoCodes = input.countryIsoCodes;
-        this.organisationId = input.organisationId ? input.organisationId.toString() : undefined;
-        this.specialProgrammes = input.specialProgrammes;
-        this.tuitionFee = input.tuitionFee;
-        return this;
-    }
-    /*
-        public consideringId(id: string): OrganisationSearchFilters {
-            this.organisationId = id;
-            return this;
-        }
-    
-        public consideringDegree(degree: DegreeTypeEnum): OrganisationSearchFilters {
-            this.degree = degree;
-            return this;
-        }
-    
-        public consideringDisciplines(disciplines: string[]): OrganisationSearchFilters {
-            this.disciplines = disciplines;
-            return this;
-        }
-    
-        public consideringDeliveryMethods(deliveryMethods: DeliveryMethodEnum[]): OrganisationSearchFilters {
-            this.deliveryMethods = deliveryMethods;
-            return this;
-        }
-    
-        public consideringCountryIsoCodes(countryIsoCodes: string[]): OrganisationSearchFilters {
-            this.countryIsoCodes = countryIsoCodes;
-            return this;
-        }
-    
-        public consideringRegionIds(regionIds: string[]): OrganisationSearchFilters {
-            this.regionIds = regionIds;
-            return this;
-        }
-    
-        public consideringAreaIds(areaIds: string[]): OrganisationSearchFilters {
-            this.areaIds = areaIds;
-            return this;
-        }*/
-    numbersToStringsOrUndefined(values) {
-        if (values === undefined)
-            return;
-        return values.map(value => value.toString());
-    }
-}
-exports.ProgrammeSearchFilters = ProgrammeSearchFilters;
-//# sourceMappingURL=ProgrammeSearchFilters.js.map

package/src/programmes/ProgrammeSearchInput.d.ts

@@ -1,20 +0,0 @@
-export type ProgrammeSearchInput = {
-    resultSize: number;
-    resultOffset: number;
-    attendances: string[];
-    degreeTypes: string[];
-    disciplines?: number[];
-    durations: string[];
-    educationalLevels: string[];
-    educationalForms: string[];
-    keyword: string;
-    areaIds?: number[];
-    regionIds?: number[];
-    countryIsoCodes?: string[];
-    organisationId?: number;
-    specialProgrammes: string[];
-    tuitionFee: {
-        min: number;
-        max: number;
-    };
-};