@studyportals/search-api-interface 1.0.0-beta.0

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/index.d.ts

@@ -0,0 +1,4 @@
+import { DegreeTypeEnum } from "./src/DegreeTypeEnum";
+import { IOrganisationSearchResponse } from "./src/IOrganisationSearchResponse";
+import { SearchApiOrganisationClient } from "./src/SearchApiOrganisationClient";
+export { SearchApiOrganisationClient, IOrganisationSearchResponse, DegreeTypeEnum };

package/bin/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DegreeTypeEnum = exports.SearchApiOrganisationClient = void 0;
+const DegreeTypeEnum_1 = require("./src/DegreeTypeEnum");
+Object.defineProperty(exports, "DegreeTypeEnum", { enumerable: true, get: function () { return DegreeTypeEnum_1.DegreeTypeEnum; } });
+const SearchApiOrganisationClient_1 = require("./src/SearchApiOrganisationClient");
+Object.defineProperty(exports, "SearchApiOrganisationClient", { enumerable: true, get: function () { return SearchApiOrganisationClient_1.SearchApiOrganisationClient; } });
+//# sourceMappingURL=index.js.map

package/bin/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,yDAAsD;AAQrD,+FARQ,+BAAc,OAQR;AANf,mFAAgF;AAG/E,4GAHQ,yDAA2B,OAGR"}

package/bin/src/DegreeTypeEnum.d.ts

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

package/bin/src/DegreeTypeEnum.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DegreeTypeEnum = void 0;
+var DegreeTypeEnum;
+(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";
+})(DegreeTypeEnum = exports.DegreeTypeEnum || (exports.DegreeTypeEnum = {}));
+//# sourceMappingURL=DegreeTypeEnum.js.map

package/bin/src/DegreeTypeEnum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DegreeTypeEnum.js","sourceRoot":"","sources":["../../src/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/bin/src/IOrganisationSearchResponse.d.ts

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

package/bin/src/IOrganisationSearchResponse.js

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

package/bin/src/IOrganisationSearchResponse.js.map

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

package/bin/src/SearchApiClientBase.d.ts

@@ -0,0 +1,6 @@
+export declare class SearchApiClientBase {
+    private readonly domain;
+    private readonly apiUriBase;
+    constructor(domain: string, apiUriBase: string);
+    protected constructUri(relativeUri: string): string;
+}

package/bin/src/SearchApiClientBase.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchApiClientBase = void 0;
+class SearchApiClientBase {
+    constructor(domain, apiUriBase) {
+        this.domain = domain;
+        this.apiUriBase = apiUriBase;
+    }
+    constructUri(relativeUri) {
+        return `${this.apiUriBase}/${this.domain}${relativeUri}`;
+    }
+}
+exports.SearchApiClientBase = SearchApiClientBase;
+//# sourceMappingURL=SearchApiClientBase.js.map

package/bin/src/SearchApiClientBase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SearchApiClientBase.js","sourceRoot":"","sources":["../../src/SearchApiClientBase.ts"],"names":[],"mappings":";;;AAAA,MAAa,mBAAmB;IAC/B,YAAoC,MAAc,EAChC,UAAkB;QADA,WAAM,GAAN,MAAM,CAAQ;QAChC,eAAU,GAAV,UAAU,CAAQ;IAEpC,CAAC;IAES,YAAY,CAAC,WAAmB;QACzC,OAAO,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,MAAM,GAAG,WAAW,EAAE,CAAC;IAC1D,CAAC;CACD;AATD,kDASC"}

package/bin/src/SearchApiOrganisationClient.d.ts

@@ -0,0 +1,10 @@
+import { SearchApiClientBase } from "./SearchApiClientBase";
+import { IRequestSender, ISuperAgentRequestFactory } from "@studyportals/mb-platform-http-requests";
+import { IOrganisationCard } from "@studyportals/domain-client";
+import { IOrganisationSearchResponse } from "./IOrganisationSearchResponse";
+export declare class SearchApiOrganisationClient extends SearchApiClientBase {
+    private readonly requestFactory;
+    private readonly requestSender;
+    constructor(apiUriBase: string, requestFactory: ISuperAgentRequestFactory, requestSender: IRequestSender);
+    searchCards(filters: any, resultCount: number, resultOffset: number): Promise<IOrganisationSearchResponse<IOrganisationCard>>;
+}

package/bin/src/SearchApiOrganisationClient.js

@@ -0,0 +1,29 @@
+"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.SearchApiOrganisationClient = void 0;
+const SearchApiClientBase_1 = require("./SearchApiClientBase");
+class SearchApiOrganisationClient extends SearchApiClientBase_1.SearchApiClientBase {
+    constructor(apiUriBase, requestFactory, requestSender) {
+        super("organisations", apiUriBase);
+        this.requestFactory = requestFactory;
+        this.requestSender = requestSender;
+    }
+    searchCards(filters, resultCount, resultOffset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const request = this.requestFactory.get(this.constructUri("search"))
+                .query(Object.assign(Object.assign({}, filters), { resultCount, resultOffset }));
+            return yield this.requestSender.sendAndExtractBody(request);
+        });
+    }
+}
+exports.SearchApiOrganisationClient = SearchApiOrganisationClient;
+//# sourceMappingURL=SearchApiOrganisationClient.js.map

package/bin/src/SearchApiOrganisationClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SearchApiOrganisationClient.js","sourceRoot":"","sources":["../../src/SearchApiOrganisationClient.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+DAA4D;AAK5D,MAAa,2BAA4B,SAAQ,yCAAmB;IAKnE,YAAmB,UAAkB,EACpC,cAAyC,EACzC,aAA6B;QAE7B,KAAK,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;QAEnC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACpC,CAAC;IAEY,WAAW,CAAC,OAAY,EAAE,WAAmB,EAAE,YAAoB;;YAC/E,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;iBAClE,KAAK,iCAAM,OAAO,KAAE,WAAW,EAAE,YAAY,IAAG,CAAC;YAEnD,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAiD,OAAO,CAAC,CAAC;QAC7G,CAAC;KAAA;CACD;AArBD,kEAqBC"}

package/index.ts

@@ -0,0 +1,10 @@
+import { DegreeTypeEnum } from "./src/DegreeTypeEnum";
+import { IOrganisationSearchResponse } from "./src/IOrganisationSearchResponse";
+import { SearchApiOrganisationClient } from "./src/SearchApiOrganisationClient";
+
+export {
+	SearchApiOrganisationClient,
+	IOrganisationSearchResponse,
+
+	DegreeTypeEnum
+}

package/package.json

@@ -0,0 +1,29 @@
+{
+	"name": "@studyportals/search-api-interface",
+	"version": "1.0.0-beta.0",
+	"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-prerelease": "npm version prerelease && npm run deploy-beta",
+		"deploy-beta": "npm run prepare-deployment && npm publish ./bin --tag beta",
+		"deploy": "npm run prepare-deployment && npm publish ./bin",
+		"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": {}
+}

package/src/DegreeTypeEnum.ts

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

package/src/IOrganisationSearchResponse.ts

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

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/SearchApiOrganisationClient.ts

@@ -0,0 +1,27 @@
+import { SearchApiClientBase } from "./SearchApiClientBase";
+import { IRequestSender, ISuperAgentRequestFactory } from "@studyportals/mb-platform-http-requests";
+import { IOrganisationCard } from "@studyportals/domain-client";
+import { IOrganisationSearchResponse } from "./IOrganisationSearchResponse";
+
+export class SearchApiOrganisationClient extends SearchApiClientBase {
+
+	private readonly requestFactory: ISuperAgentRequestFactory;
+	private readonly requestSender: IRequestSender;
+
+	public constructor(apiUriBase: string,
+		requestFactory: ISuperAgentRequestFactory,
+		requestSender: IRequestSender
+	) {
+		super("organisations", apiUriBase);
+
+		this.requestFactory = requestFactory;
+		this.requestSender = requestSender;
+	}
+
+	public async searchCards(filters: any, resultCount: number, resultOffset: number): Promise<IOrganisationSearchResponse<IOrganisationCard>> {
+		const request = this.requestFactory.get(this.constructUri("search"))
+			.query({ ...filters, resultCount, resultOffset });
+
+		return await this.requestSender.sendAndExtractBody<IOrganisationSearchResponse<IOrganisationCard>>(request);
+	}
+}

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"
+	]
+}