@studyportals/domain-client 3.6.0-1 → 3.6.0-2

package/.eslintignore

@@ -0,0 +1,3 @@
+**/node_modules/*
+**/bin/*
+**/tests/*

package/.eslintrc.js

@@ -0,0 +1,12 @@
+module.exports = {
+    root: true,
+    env: {
+        node: true
+    },
+    rules: {
+        "no-shadow": "off",
+    },
+    extends: [
+        './node_modules/@studyportals/code-style/.eslintrc.js'
+    ]
+}

package/.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+  - package-ecosystem: npm
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "04:00"
+    open-pull-requests-limit: 10
+    reviewers:
+      - studyportals/plop
+    labels:
+      - component-library
+    allow:
+      - dependency-name: "@studyportals/*"
+    ignore:
+      - dependency-name: "@studyportals/*"
+        update-types: ["version-update:semver-patch"]

package/.github/stale.yml

@@ -0,0 +1,10 @@
+daysUntilStale: 14
+daysUntilClose: 46
+exemptLabels:
+  - pinned
+staleLabel: stale
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+closeComment: false

package/.mocharc.yml

@@ -0,0 +1,3 @@
+require:
+  - source-map-support/register
+  - ts-node/register

package/.nycrc

@@ -0,0 +1,15 @@
+{
+  "all": true,
+  "check-coverage": true,
+  "reporter": "text",
+  "exclude": [
+    "src/models/**/*.ts",
+    "src/i-*.ts",
+    "tests/**/*.ts",
+    "**/*.js"
+  ],
+  "branches": 100,
+  "lines": 100,
+  "functions": 100,
+  "statements": 100
+}

package/README.md

@@ -0,0 +1,117 @@
+# Domain Client
+
+A lightweight client for fetching data from the Domain API and returning it as 
+strongly typed classes defined by the `Domain API`. 
+
+## Installation 
+
+```
+npm install @studyportals/domain-client --save
+```
+
+## Publishing new version
+To publish a new version to npm run one of the following commnads
+```bash
+npm run publish-beta # Increase the beta version and publishes
+npm run publish-major # Increases the major version publishes
+npm run publish-minor # Increases the minor version and publishes
+npm run publish-patch # Increases the patch version and publishes
+npm run publish-current # Publishes the current version. 
+```
+
+## Default usage
+
+Instantiate your client class (_ProgrammeCard client as example_) with all 
+parameters:
+```typescript
+const client = new ProgrammeCardClient(
+    domainApiUrl, // The url to the Domain API endpoint
+    apiKey, // The API key provided by PLOP for your implementation
+    probabilitySeed, // Number between 1 and 100 (inclusive)
+    portalMap // PortalMap mapping between PortalType and portal base url
+);
+```
+
+A PortalMap example: 
+```typescript
+    const portalMap = new Map<PortalType, string>()
+        .set(PortalType.MASTER, 'https://42069.mastersportal.fyi')
+        .set(PortalType.PHD, 'https://42069.phdportal.fyi')
+        .set(PortalType.BACHELOR, 'https://42069.bachelorsportal.fyi')
+        .set(PortalType.SHORT, 'https://42069.shortcoursesportal.fyi')
+        .set(PortalType.DISTANCE_LEARNING, 'https://42069.distancelearningportal.fyi')
+```
+
+Fetch your model using the `fetch()` method with the requested ID (_in this 
+example programme ID_):
+```typescript
+const card: IProgrammeCard = await client.fetch(5);
+```
+Or get multiple using `fetchMultiple()` with the requested IDs (_in this example 
+programme IDs_):
+```typescript
+const cards: IProgrammeCard[] = await client.fetchMultiple([5, 9, 13]);
+```
+Some functions are accompanied by a `canShow` function that indicates its 
+availability. If the value is not set the function will throw a 
+`PropertyNotAvailableException`:
+
+```typescript
+const card: IProgrammeCard = await client.fetch(5);
+
+// Might throw PropertyNotAvailableException
+const cover: ICover = card.getCover();
+
+// Safe behaviour
+if (card.canShowCover()) {
+    const cover: ICover = card.getCover();
+}
+```
+
+## Separated usage
+
+In some cases you might want to separate the fetching of the information from 
+the usage of that information; for instance getting the information in your 
+back-end service and passing it to the front-end application for usage.
+
+First instantiate your client class with all parameters:
+```typescript
+const client = new ProgrammeCardClient(
+    domainApiUrl, // The url to the Domain API endpoint
+    apiKey, // The API key provided by PLOP for your implementation
+    probabilitySeed // Number between 1 and 100 (inclusive)
+);
+```
+To do this you can use the `fetchDescription()` method instead and encode it as 
+JSON:  
+```typescript
+const card: IModelDescription = await client.fetchDescription(5);
+const jsonData: string = JSON.stringify(card);
+```
+Or use the `fetchMultipleDescriptions()` function to fetch multiple descriptions:
+```typescript
+const cards: IModelDescription[] = await client.fetchMultipleDescriptions([5, 9, 13]);
+const jsonData: string = JSON.stringify(cards);
+```
+
+When you're ready to use the information in the models you can use the existing 
+client or instantiate a new one without parameters:
+```typescript
+const client = new ProgrammeCardClient();
+```
+After which you can use the `fromDescription()` and `fromDescriptions()` 
+functions to retrieve your models:
+```typescript
+const descriptions: IModelDescription[] = JSON.parse(jsonData);
+const card: IProgrammeCard = client.fromDescription(descriptions[0]);
+const cards: IProgrammeCard[] = client.fromDescriptions(descriptions);
+```
+Note that creating a client without providing the required parameters will 
+result in all network functionalities of the client being unavailable. In this 
+case the following functions will throw a `ClientException`: 
+```typescript
+await client.fetch(1);
+await client.fetchMultiple([5, 9, 13]);
+await client.fetchDescription(1);
+await client.fetchMultipleDescriptions([5, 9, 13]);
+```

package/bin/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@studyportals/domain-client",
+  "version": "3.6.0-2",
+  "description": "Responsible for fetching data from the Domain API",
+  "main": "bin/index.js",
+  "author": "StudyPortals B.V.",
+  "contributors": [
+    "braaibander <danny@studyportals.com>"
+  ],
+  "license": "BSD-3-Clause",
+  "scripts": {
+    "test": "mocha --reporter spec \"tests/**/*.test.ts\"",
+    "coverage": "nyc mocha --reporter dot \"tests/**/*.test.ts\"",
+    "lint": "eslint . --ext .ts --max-warnings=0",
+    "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": {
+    "axios": "^0.21.0"
+  },
+  "devDependencies": {
+    "@studyportals/code-style": "^1.3.1",
+    "@testdeck/mocha": "^0.1.2",
+    "@types/axios": "^0.14.0",
+    "@types/mocha": "^8.0.4",
+    "@types/moxios": "^0.4.9",
+    "@types/node": "^14.14.8",
+    "@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": "^8.0.0",
+    "husky": "^4.3.0",
+    "mocha": "^8.2.1",
+    "moxios": "^0.4.0",
+    "nyc": "^15.1.0",
+    "source-map-support": "^0.5.19",
+    "ts-node": "^9.0.0",
+    "tslint": "^6.1.3",
+    "typemoq": "^2.1.0",
+    "typescript": "^4.0.5"
+  }
+}

package/{src → bin/src}/models/dotdigital-organisation/i-dot-digital-organisation.d.ts

@@ -15,6 +15,7 @@ export interface IDotDigitalOrganisation {
     getLogoUrl(): string;
     getName(): string;
     getOrganisationUrl(): string;
+    getReasons(): string[];
     /**
      * @return IReview[]
      */