@studyportals/insight-composer-api-interface 1.0.0-beta.0

package/index.d.ts

@@ -0,0 +1,4 @@
+import { InsightComposerApiClient } from "./src/insight-composer-api-client";
+import { IProgrammesInsightsInput } from "./src/programmes/programmes-insights-input.interface";
+import { IProgrammesInsights } from "./src/programmes/programmes-insights.interface";
+export { InsightComposerApiClient, IProgrammesInsightsInput, IProgrammesInsights };

package/index.js

@@ -0,0 +1,3 @@
+import { InsightComposerApiClient } from "./src/insight-composer-api-client";
+export { InsightComposerApiClient };
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAI7E,OAAO,EACN,wBAAwB,EAGxB,CAAA"}

package/package.json

@@ -0,0 +1,29 @@
+{
+	"name": "@studyportals/insight-composer-api-interface",
+	"version": "1.0.0-beta.0",
+	"description": "Typescript library containing resources that facilitate integration with Insight Composer API",
+	"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": {
+		"@types/superagent": "^8.1.9",
+		"superagent": "^10.2.3",
+		"typescript": "^5.9.3"
+	},
+	"dependencies": {
+		"@studyportals/mb-platform-http-requests": "^2.8.0",
+		"@studyportals/search-api-interface": "^3.8.0",
+		"@studyportals/search-filters": "^6.3.1"
+	}
+}

package/src/insight-composer-api-client.d.ts

@@ -0,0 +1,6 @@
+import { IProgrammesInsightsInput } from "./programmes/programmes-insights-input.interface";
+import { RequestBase } from "./request-base";
+import { IProgrammesInsights } from "./programmes/programmes-insights.interface";
+export declare class InsightComposerApiClient extends RequestBase {
+    getProgrammesInsights(input: IProgrammesInsightsInput): Promise<IProgrammesInsights>;
+}

package/src/insight-composer-api-client.js

@@ -0,0 +1,7 @@
+import { RequestBase } from "./request-base";
+export class InsightComposerApiClient extends RequestBase {
+    async getProgrammesInsights(input) {
+        return (await this.getRequest(`programmes`, input)).body;
+    }
+}
+//# sourceMappingURL=insight-composer-api-client.js.map

package/src/insight-composer-api-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"insight-composer-api-client.js","sourceRoot":"","sources":["../../src/insight-composer-api-client.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAG7C,MAAM,OAAO,wBAAyB,SAAQ,WAAW;IACxD,KAAK,CAAC,qBAAqB,CAAC,KAA+B;QAC1D,OAAO,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,KAAK,CAA2B,CAAA,CAAC,IAA2B,CAAC;IAC1G,CAAC;CACD"}

package/src/programmes/programmes-insights-input.interface.d.ts

@@ -0,0 +1,24 @@
+import { ProgrammeSortType, TextSearchAlgorithmType } from "@studyportals/search-api-interface";
+import { AttendanceFilterOptionValue, DegreeTypeFilterOptionValue, DurationFilterOptionValue, EducationLevelFilterOptionValue, EducationalFormFilterOptionValue, FormatFilterOptionValue, SpecialProgrammesFilterOptionValue } from "@studyportals/search-filters/server-side";
+export interface IProgrammesInsightsInput {
+    readonly attendances?: AttendanceFilterOptionValue[];
+    readonly degreeTypes?: DegreeTypeFilterOptionValue[];
+    readonly disciplines?: number[];
+    readonly durations?: DurationFilterOptionValue[];
+    readonly educationalLevels?: EducationLevelFilterOptionValue[];
+    readonly educationalForms?: EducationalFormFilterOptionValue[];
+    readonly densities?: FormatFilterOptionValue[];
+    readonly text?: string;
+    readonly areaIds?: number[];
+    readonly regionIds?: number[];
+    readonly countryIsoCodes?: string[];
+    readonly organisationIds?: number[];
+    readonly specialProgrammes?: SpecialProgrammesFilterOptionValue[];
+    readonly tuitionFeeMin?: number;
+    readonly tuitionFeeMax?: number;
+    readonly nationalityCountryIso?: string;
+    readonly sortBy: ProgrammeSortType;
+    readonly suggestionSize?: number;
+    readonly campaignTypes?: string[];
+    readonly textSearchAlgorithm?: TextSearchAlgorithmType;
+}

package/src/programmes/programmes-insights-input.interface.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=programmes-insights-input.interface.js.map

package/src/programmes/programmes-insights-input.interface.js.map

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

package/src/programmes/programmes-insights.interface.d.ts

@@ -0,0 +1,5 @@
+export interface IProgrammesInsights {
+    averageInternationalTuitionFee?: number | null;
+    averageNationalTuitionFee?: number | null;
+    onlineAttendancePercentage?: number;
+}

package/src/programmes/programmes-insights.interface.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=programmes-insights.interface.js.map

package/src/programmes/programmes-insights.interface.js.map

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

package/src/request-base.d.ts

@@ -0,0 +1,6 @@
+export declare class RequestBase {
+    private publicUrl;
+    constructor(apiUriBase: string);
+    getRequest(relative?: string, query?: Record<string, any> | string, apiKey?: string): Promise<any>;
+    private buildBaseUrl;
+}

package/src/request-base.js

@@ -0,0 +1,18 @@
+import * as superagent from "superagent";
+export class RequestBase {
+    publicUrl;
+    constructor(apiUriBase) {
+        this.publicUrl = `${apiUriBase}/insights/`;
+    }
+    async getRequest(relative = "", query = "", apiKey = "") {
+        const request = superagent.get(this.buildBaseUrl(relative))
+            .set("Content-Type", "application/json")
+            .set("x-api-key", apiKey)
+            .query(query);
+        return await request.send();
+    }
+    buildBaseUrl(relative) {
+        return `${this.publicUrl}${relative}`;
+    }
+}
+//# sourceMappingURL=request-base.js.map

package/src/request-base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-base.js","sourceRoot":"","sources":["../../src/request-base.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,YAAY,CAAC;AAEzC,MAAM,OAAO,WAAW;IACf,SAAS,CAAS;IAE1B,YAAY,UAAkB;QAC7B,IAAI,CAAC,SAAS,GAAG,GAAG,UAAU,YAAY,CAAC;IAC5C,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,WAAmB,EAAE,EAAE,QAAsC,EAAE,EAAE,SAAiB,EAAE;QAC3G,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aACzD,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC;aACvC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC;aACxB,KAAK,CAAC,KAAK,CAAC,CAAC;QAEf,OAAO,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC;IAC7B,CAAC;IAEO,YAAY,CAAC,QAAgB;QACpC,OAAO,GAAG,IAAI,CAAC,SAAS,GAAG,QAAQ,EAAE,CAAC;IACvC,CAAC;CACD"}