@studyportals/domain-client 6.0.0 → 6.1.0-beta.0

package/coverage/sorter.js

@@ -0,0 +1,196 @@
+/* eslint-disable */
+var addSorting = (function() {
+    'use strict';
+    var cols,
+        currentSort = {
+            index: 0,
+            desc: false
+        };
+
+    // returns the summary table element
+    function getTable() {
+        return document.querySelector('.coverage-summary');
+    }
+    // returns the thead element of the summary table
+    function getTableHeader() {
+        return getTable().querySelector('thead tr');
+    }
+    // returns the tbody element of the summary table
+    function getTableBody() {
+        return getTable().querySelector('tbody');
+    }
+    // returns the th element for nth column
+    function getNthColumn(n) {
+        return getTableHeader().querySelectorAll('th')[n];
+    }
+
+    function onFilterInput() {
+        const searchValue = document.getElementById('fileSearch').value;
+        const rows = document.getElementsByTagName('tbody')[0].children;
+        for (let i = 0; i < rows.length; i++) {
+            const row = rows[i];
+            if (
+                row.textContent
+                    .toLowerCase()
+                    .includes(searchValue.toLowerCase())
+            ) {
+                row.style.display = '';
+            } else {
+                row.style.display = 'none';
+            }
+        }
+    }
+
+    // loads the search box
+    function addSearchBox() {
+        var template = document.getElementById('filterTemplate');
+        var templateClone = template.content.cloneNode(true);
+        templateClone.getElementById('fileSearch').oninput = onFilterInput;
+        template.parentElement.appendChild(templateClone);
+    }
+
+    // loads all columns
+    function loadColumns() {
+        var colNodes = getTableHeader().querySelectorAll('th'),
+            colNode,
+            cols = [],
+            col,
+            i;
+
+        for (i = 0; i < colNodes.length; i += 1) {
+            colNode = colNodes[i];
+            col = {
+                key: colNode.getAttribute('data-col'),
+                sortable: !colNode.getAttribute('data-nosort'),
+                type: colNode.getAttribute('data-type') || 'string'
+            };
+            cols.push(col);
+            if (col.sortable) {
+                col.defaultDescSort = col.type === 'number';
+                colNode.innerHTML =
+                    colNode.innerHTML + '<span class="sorter"></span>';
+            }
+        }
+        return cols;
+    }
+    // attaches a data attribute to every tr element with an object
+    // of data values keyed by column name
+    function loadRowData(tableRow) {
+        var tableCols = tableRow.querySelectorAll('td'),
+            colNode,
+            col,
+            data = {},
+            i,
+            val;
+        for (i = 0; i < tableCols.length; i += 1) {
+            colNode = tableCols[i];
+            col = cols[i];
+            val = colNode.getAttribute('data-value');
+            if (col.type === 'number') {
+                val = Number(val);
+            }
+            data[col.key] = val;
+        }
+        return data;
+    }
+    // loads all row data
+    function loadData() {
+        var rows = getTableBody().querySelectorAll('tr'),
+            i;
+
+        for (i = 0; i < rows.length; i += 1) {
+            rows[i].data = loadRowData(rows[i]);
+        }
+    }
+    // sorts the table using the data for the ith column
+    function sortByIndex(index, desc) {
+        var key = cols[index].key,
+            sorter = function(a, b) {
+                a = a.data[key];
+                b = b.data[key];
+                return a < b ? -1 : a > b ? 1 : 0;
+            },
+            finalSorter = sorter,
+            tableBody = document.querySelector('.coverage-summary tbody'),
+            rowNodes = tableBody.querySelectorAll('tr'),
+            rows = [],
+            i;
+
+        if (desc) {
+            finalSorter = function(a, b) {
+                return -1 * sorter(a, b);
+            };
+        }
+
+        for (i = 0; i < rowNodes.length; i += 1) {
+            rows.push(rowNodes[i]);
+            tableBody.removeChild(rowNodes[i]);
+        }
+
+        rows.sort(finalSorter);
+
+        for (i = 0; i < rows.length; i += 1) {
+            tableBody.appendChild(rows[i]);
+        }
+    }
+    // removes sort indicators for current column being sorted
+    function removeSortIndicators() {
+        var col = getNthColumn(currentSort.index),
+            cls = col.className;
+
+        cls = cls.replace(/ sorted$/, '').replace(/ sorted-desc$/, '');
+        col.className = cls;
+    }
+    // adds sort indicators for current column being sorted
+    function addSortIndicators() {
+        getNthColumn(currentSort.index).className += currentSort.desc
+            ? ' sorted-desc'
+            : ' sorted';
+    }
+    // adds event listeners for all sorter widgets
+    function enableUI() {
+        var i,
+            el,
+            ithSorter = function ithSorter(i) {
+                var col = cols[i];
+
+                return function() {
+                    var desc = col.defaultDescSort;
+
+                    if (currentSort.index === i) {
+                        desc = !currentSort.desc;
+                    }
+                    sortByIndex(i, desc);
+                    removeSortIndicators();
+                    currentSort.index = i;
+                    currentSort.desc = desc;
+                    addSortIndicators();
+                };
+            };
+        for (i = 0; i < cols.length; i += 1) {
+            if (cols[i].sortable) {
+                // add the click event handler on the th so users
+                // dont have to click on those tiny arrows
+                el = getNthColumn(i).querySelector('.sorter').parentElement;
+                if (el.addEventListener) {
+                    el.addEventListener('click', ithSorter(i));
+                } else {
+                    el.attachEvent('onclick', ithSorter(i));
+                }
+            }
+        }
+    }
+    // adds sorting functionality to the UI
+    return function() {
+        if (!getTable()) {
+            return;
+        }
+        cols = loadColumns();
+        loadData();
+        addSearchBox();
+        addSortIndicators();
+        enableUI();
+    };
+})();
+
+window.addEventListener('load', addSorting);

package/index.ts

@@ -0,0 +1,177 @@
+import { BadRequestException } from "./src/exceptions/bad-request-exception";
+import { ClientException } from "./src/exceptions/client-exception";
+import { InternalServerException } from "./src/exceptions/internal-server-exception";
+import { NotFoundException } from "./src/exceptions/not-found-exception";
+import { PropertyNotAvailableException } from "./src/exceptions/property-not-available-exception";
+import { ICover } from "./src/models/programme-card/i-cover";
+import { ILink } from "./src/models/programme-card/i-link";
+import { IOptionalLink } from "./src/models/programme-card/i-optional-link";
+import { ILocation } from "./src/models/programme-card/i-location";
+import { IClickTrackingData } from "./src/models/programme-card/i-click-tracking-data";
+import { ITracking } from "./src/models/programme-card/i-tracking";
+import { IDuration } from "./src/models/programme-card/i-duration";
+import { IDeadline } from "./src/models/programme-card/i-deadline";
+import { IStartDate } from "./src/models/programme-card/i-start-date";
+import { ITiming } from "./src/models/programme-card/i-timing";
+import { ITrackedLink } from "./src/models/programme-card/i-tracked-link";
+import { IProgrammeCard } from "./src/models/programme-card/i-programme-card";
+import { ProgrammeCardClient } from "./src/models/programme-card/programme-card-client";
+import { ITuitionValues } from "./src/models/search-projection/i-tuition-values";
+import { IPremiumValues } from "./src/models/search-projection/i-premium-values";
+import { IOrganisationValues } from "./src/models/search-projection/i-organisation-values";
+import { IGeoTargetingConfiguration } from "./src/models/search-projection/i-geo-targeting-configuration";
+import { IGeoTargetingValues } from "./src/models/search-projection/i-geo-targeting-values";
+import { ISearchProjection } from "./src/models/search-projection/i-search-projection";
+import { SearchProjectionClient } from "./src/models/search-projection/search-projection-client";
+import { ILivingCost } from "./src/models/bestfit-programme/i-living-cost";
+import { IGPARequirement } from "./src/models/common/i-g-p-a-requirement";
+import { IBestFitProgramme } from "./src/models/bestfit-programme/i-best-fit-programme";
+import { BestfitProgrammeClient } from "./src/models/bestfit-programme/bestfit-programme-client";
+import { ILogo } from "./src/models/common/i-logo";
+import { ITuitionFee } from "./src/models/common/i-tuition-fee";
+import { IEnglishRequirements } from "./src/models/common/i-english-requirements";
+import { IInternalLink } from "./src/models/customerio-programme/i-internal-link";
+import { ICustomerIOProgramme } from "./src/models/customerio-programme/i-customer-io-programme";
+import { CustomerIOProgrammeClient } from "./src/models/customerio-programme/customerio-programme-client";
+import { IFaqStaticContent } from "./src/models/faq-static-content/i-faq-static-content";
+import { IFaq } from "./src/models/faq-static-content/i-faq";
+import { IStaticContentUrl } from "./src/models/faq-static-content/i-static-content-url";
+import { PublicFaqStaticContentClient } from "./src/models/faq-static-content/public-faq-static-content-client";
+import { ISitemapProgrammeInfo } from "./src/models/sitemap-programme-info/i-sitemap-programme-info";
+import { SitemapProgrammeInfoClient } from "./src/models/sitemap-programme-info/sitemap-programme-info-client";
+import { ISitemapCountryInfo } from "./src/models/sitemap-countries-info/i-sitemap-country-info";
+import { SitemapCountriesInfoClient } from "./src/models/sitemap-countries-info/sitemap-countries-info-client";
+import { IDegreeInfo } from "./src/models/sitemap-country-degree-info/i-degree-info";
+import { ISitemapCountryDegreeInfo } from "./src/models/sitemap-country-degree-info/i-sitemap-country-degree-info";
+import { SitemapCountryDegreeInfoClient } from "./src/models/sitemap-country-degree-info/sitemap-country-degree-info-client";
+import { ISearchDiscipline } from "./src/models/search-discipline/i-search-discipline";
+import { PublicSearchDisciplineClient } from "./src/models/search-discipline/public-search-discipline-client";
+import { ISitemapDisciplineInfo } from "./src/models/sitemap-disciplines-info/i-sitemap-discipline-info";
+import { SitemapDisciplinesInfoClient } from "./src/models/sitemap-disciplines-info/sitemap-disciplines-info-client";
+import { ICountry } from "./src/models/common/i-country";
+import { ICity } from "./src/models/common/i-city";
+import { IReview } from "./src/models/customerio-organisation/i-review";
+import { ICustomerIOOrganisation } from "./src/models/customerio-organisation/i-customer-io-organisation";
+import { CustomerIOOrganisationClient } from "./src/models/customerio-organisation/customerio-organisation-client";
+import { ISitemapOrganisationInfo } from "./src/models/sitemap-organisations-info/i-sitemap-organisation-info";
+import { SitemapOrganisationsInfoClient } from "./src/models/sitemap-organisations-info/sitemap-organisations-info-client";
+import { IOrganisationCard } from "./src/models/organisation-card/i-organisation-card";
+import { IRankingDiscipline } from "./src/models/organisation-card/i-ranking-discipline";
+import { OrganisationCardClient } from "./src/models/organisation-card/organisation-card-client";
+import { IOrganisationSearchDocument } from "./src/models/organisation-search-document/i-organisation-search-document";
+import { OrganisationSearchDocumentClient } from "./src/models/organisation-search-document/organisation-search-document-client";
+import { ISitemapRankingsInfo } from "./src/models/sitemap-rankings-info/i-sitemap-rankings-info";
+import { SitemapRankingsInfoClient } from "./src/models/sitemap-rankings-info/sitemap-rankings-info-client";
+import { ISitemapArticleInfo } from "./src/models/sitemap-articles-info/i-sitemap-article-info";
+import { SitemapArticlesInfoClient } from "./src/models/sitemap-articles-info/sitemap-articles-info-client";
+import { ISitemapCityInfo } from "./src/models/sitemap-cities-info/i-sitemap-city-info";
+import { SitemapCitiesInfoClient } from "./src/models/sitemap-cities-info/sitemap-cities-info-client";
+import { IScholarshipCard } from "./src/models/scholarship-card/i-scholarship-card";
+import { PublicScholarshipCardClient } from "./src/models/scholarship-card/public-scholarship-card-client";
+import { ScholarshipCardV2Client } from "./src/models/scholarship-card/scholarship-card-v2-client";
+import { IScholarshipSearchDocument } from "./src/models/scholarship-search-document/i-scholarship-search-document";
+import { ScholarshipSearchDocumentClient } from "./src/models/scholarship-search-document/scholarship-search-document-client";
+import { IRanking } from './src/models/ranking-cards/i-ranking';
+import { PortalType } from "./src/types/portal-type";
+import { PortalMap } from "./src/types/portal-map";
+import { ModelClient } from "./src/model-client";
+import { IOrganisationForSearch } from "./src/models/organisation-for-search/i-organisation-for-search";
+import { PublicOrganisationForSearchClient } from "./src/models/organisation-for-search/public-organisation-for-search-client";
+import { ICopilotProgramme } from "./src/models/copilot-programme/i-copilot-programme";
+import { CopilotProgrammeClient } from "./src/models/copilot-programme/copilot-programme-client";
+import { ICopilotCountry } from "./src/models/copilot-country/i-copilot-country";
+import { CopilotCountryClient } from "./src/models/copilot-country/copilot-country-client";
+import { ICopilotRankingCard } from "./src/models/copilot-country/i-copilot-ranking-card";
+import { IReviewRating } from "./src/models/common/i-review-rating";
+
+export {
+	BadRequestException,
+	ClientException,
+	InternalServerException,
+	NotFoundException,
+	PropertyNotAvailableException,
+	ICover,
+	ILink,
+	IOptionalLink,
+	ILocation,
+	IClickTrackingData,
+	ITracking,
+	IDuration,
+	IDeadline,
+	IStartDate,
+	ITiming,
+	ITrackedLink,
+	IProgrammeCard,
+	ProgrammeCardClient,
+	ITuitionValues,
+	IPremiumValues,
+	IOrganisationValues,
+	IGeoTargetingConfiguration,
+	IGeoTargetingValues,
+	ISearchProjection,
+	SearchProjectionClient,
+	ILivingCost,
+	IGPARequirement,
+	IBestFitProgramme,
+	BestfitProgrammeClient,
+	ILogo,
+	ITuitionFee,
+	IEnglishRequirements,
+	IInternalLink,
+	ICustomerIOProgramme,
+	CustomerIOProgrammeClient,
+	IFaqStaticContent,
+	PublicFaqStaticContentClient,
+	IFaq,
+	IStaticContentUrl,
+	ISitemapProgrammeInfo,
+	SitemapProgrammeInfoClient,
+	ISitemapCountryInfo,
+	SitemapCountriesInfoClient,
+	IDegreeInfo,
+	ISitemapCountryDegreeInfo,
+	SitemapCountryDegreeInfoClient,
+	ISearchDiscipline,
+	PublicSearchDisciplineClient,
+	ISitemapDisciplineInfo,
+	SitemapDisciplinesInfoClient,
+	ICountry,
+	ICity,
+	IReview,
+	ICustomerIOOrganisation,
+	CustomerIOOrganisationClient,
+	ISitemapOrganisationInfo,
+	SitemapOrganisationsInfoClient,
+	IOrganisationSearchDocument,
+	OrganisationSearchDocumentClient,
+	ISitemapRankingsInfo,
+	SitemapRankingsInfoClient,
+	ISitemapArticleInfo,
+	SitemapArticlesInfoClient,
+	ISitemapCityInfo,
+	SitemapCitiesInfoClient,
+	IScholarshipCard,
+	PublicScholarshipCardClient,
+	ScholarshipCardV2Client,
+	IScholarshipSearchDocument,
+	ScholarshipSearchDocumentClient,
+	IRanking,
+	PortalType,
+	PortalMap,
+	ModelClient,
+	IOrganisationForSearch,
+	PublicOrganisationForSearchClient,
+	IOrganisationCard,
+	IRankingDiscipline,
+	OrganisationCardClient,
+	ICopilotProgramme,
+	ICopilotCountry,
+	CopilotProgrammeClient,
+	CopilotCountryClient,
+	ICopilotRankingCard,
+	IReviewRating
+};
+
+
+export * from './src/clients';
+export * from './protobuf';

package/package.json

@@ -1,52 +1,50 @@
-{
-	"name": "@studyportals/domain-client",
-	"version": "6.0.0",
-	"description": "Responsible for fetching data from the Domain API",
-	"main": "index.js",
-	"author": "StudyPortals B.V.",
-	"sideEffects": false,
-	"contributors": [
-		"braaibander <danny@studyportals.com>"
-	],
-	"license": "BSD-3-Clause",
-	"scripts": {
-		"test": "vitest run",
-		"test:watch": "vitest",
-		"coverage": "vitest run --coverage",
-		"lint": "eslint . --ext .ts --max-warnings=0",
-		"lint:fix": "eslint . --ext .ts --fix",
-		"pre-push": "npm run test && npm run coverage && npm run lint",
-		"prepare-dist": "npm run test  && rm -fR bin && npx tsc && cp package.json bin/package.json && rm -fR bin/tests",
-		"publish-beta": "npm version prerelease --preid=beta && npm run prepare-dist && npm publish ./bin --tag beta",
-		"publish-major": "npm version major && npm run prepare-dist && npm publish ./bin",
-		"publish-minor": "npm version minor && npm run prepare-dist && npm publish ./bin",
-		"publish-patch": "npm version patch && npm run prepare-dist && npm publish ./bin",
-		"publish-current": "npm run prepare-dist && npm publish ./bin"
-	},
-	"husky": {
-		"hooks": {
-			"pre-push": "npm run pre-push"
-		}
-	},
-	"dependencies": {
-
-	},
-	"devDependencies": {
-		"@studyportals/code-style": "^2.0.4",
-		"@types/node": "^24.1.0",
-		"@types/reflect-metadata": "^0.1.0",
-		"@typescript-eslint/eslint-plugin": "^4.8.1",
-		"@typescript-eslint/parser": "^4.8.1",
-		"eslint": "^7.13.0",
-		"eslint-plugin-import": "^2.22.1",
-		"eslint-plugin-mocha": "^10.1.0",
-		"husky": "^4.3.0",
-		"nyc": "^15.1.0",
-		"source-map-support": "^0.5.19",
-		"tslint": "^6.1.3",
-		"typemoq": "^2.1.0",
-		"vitest": "^3.2.4",
-		"@vitest/coverage-v8": "^3.2.4",
-		"typescript": "^5.9.2"
-	}
-}
+{
+	"name": "@studyportals/domain-client",
+	"version": "6.1.0-beta.0",
+	"description": "Responsible for fetching data from the Domain API",
+	"main": "index.js",
+	"author": "StudyPortals B.V.",
+	"sideEffects": false,
+	"contributors": [
+		"braaibander <danny@studyportals.com>"
+	],
+	"license": "BSD-3-Clause",
+	"scripts": {
+		"test": "vitest run",
+		"test:watch": "vitest",
+		"coverage": "vitest run --coverage",
+		"lint": "eslint . --ext .ts --max-warnings=0",
+		"lint:fix": "eslint . --ext .ts --fix",
+		"pre-push": "npm run test && npm run coverage && npm run lint",
+		"prepare-dist": "npm run test  && rm -fR bin && npx tsc && cp package.json bin/package.json && rm -fR bin/tests",
+		"publish-beta": "npm version prerelease --preid=beta && npm run prepare-dist && npm publish ./bin --tag beta",
+		"publish-major": "npm version major && npm run prepare-dist && npm publish ./bin",
+		"publish-minor": "npm version minor && npm run prepare-dist && npm publish ./bin",
+		"publish-patch": "npm version patch && npm run prepare-dist && npm publish ./bin",
+		"publish-current": "npm run prepare-dist && npm publish ./bin"
+	},
+	"husky": {
+		"hooks": {
+			"pre-push": "npm run pre-push"
+		}
+	},
+	"dependencies": {},
+	"devDependencies": {
+		"@studyportals/code-style": "^2.0.4",
+		"@types/node": "^24.1.0",
+		"@types/reflect-metadata": "^0.1.0",
+		"@typescript-eslint/eslint-plugin": "^4.8.1",
+		"@typescript-eslint/parser": "^4.8.1",
+		"eslint": "^7.13.0",
+		"eslint-plugin-import": "^2.22.1",
+		"eslint-plugin-mocha": "^10.1.0",
+		"husky": "^4.3.0",
+		"nyc": "^15.1.0",
+		"source-map-support": "^0.5.19",
+		"tslint": "^6.1.3",
+		"typemoq": "^2.1.0",
+		"vitest": "^3.2.4",
+		"@vitest/coverage-v8": "^3.2.4",
+		"typescript": "^5.9.2"
+	}
+}

package/protobuf/Area.ts

@@ -0,0 +1,46 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.5
+//   protoc               v3.12.4
+// source: Area.proto
+
+/* eslint-disable */
+
+export interface Area {
+  id: number;
+  name?: string | undefined;
+  code?: string | undefined;
+}
+
+export const Area: MessageFns<Area> = {
+  fromJSON(object: any): Area {
+    return {
+      id: isSet(object.id) ? globalThis.Number(object.id) : 0,
+      name: isSet(object.name) ? globalThis.String(object.name) : undefined,
+      code: isSet(object.code) ? globalThis.String(object.code) : undefined,
+    };
+  },
+
+  toJSON(message: Area): unknown {
+    const obj: any = {};
+    if (message.id !== 0) {
+      obj.id = Math.round(message.id);
+    }
+    if (message.name !== undefined) {
+      obj.name = message.name;
+    }
+    if (message.code !== undefined) {
+      obj.code = message.code;
+    }
+    return obj;
+  },
+};
+
+function isSet(value: any): boolean {
+  return value !== null && value !== undefined;
+}
+
+interface MessageFns<T> {
+  fromJSON(object: any): T;
+  toJSON(message: T): unknown;
+}