@studyportals/domain-client - npm Package Compare versions

Comparing version 3.2.0 to 3.3.0-beta.0

index.d.ts

@@ -16,6 +16,2 @@ import { BadRequestException } from "./src/exceptions/bad-request-exception";
 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";
@@ -30,4 +26,4 @@ import { ProgrammeCardClient } from "./src/models/programme-card/programme-card-client";
 import { SearchProjectionClient } from "./src/models/search-projection/search-projection-client";
-import { PortalMap } from "./src/types/portal-map";
-import { PortalType } from "./src/types/portal-type";
-export { BadRequestException, ClientException, InternalServerException, NotFoundException, PropertyNotAvailableException, IInternalLink, ILogo, ICover, ILink, IOptionalLink, ILocation, IClickTrackingData, ITracking, ITuitionFee, IDuration, IDeadline, IStartDate, ITiming, ITrackedLink, IProgrammeCard, ProgrammeCardClient, ITuitionValues, IPremiumValues, IOrganisationValues, IGeoTargetingConfiguration, IGeoTargetingValues, ISearchProjection, SearchProjectionClient, PortalMap, PortalType };
+import { ISearchCountryFaq } from "./src/models/search-country-faq/i-search-country-faq";
+import { SearchCountryFaqClient } from "./src/models/search-country-faq/search-country-faq-client";
+export { BadRequestException, ClientException, InternalServerException, NotFoundException, PropertyNotAvailableException, IInternalLink, ILogo, ICover, ILink, IOptionalLink, ILocation, IClickTrackingData, ITracking, ITuitionFee, IDuration, IProgrammeCard, ProgrammeCardClient, ITuitionValues, IPremiumValues, IOrganisationValues, IGeoTargetingConfiguration, IGeoTargetingValues, ISearchProjection, SearchProjectionClient, ISearchCountryFaq, SearchCountryFaqClient };

index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PortalType = exports.SearchProjectionClient = exports.ProgrammeCardClient = exports.PropertyNotAvailableException = exports.NotFoundException = exports.InternalServerException = exports.ClientException = exports.BadRequestException = void 0;
+exports.SearchCountryFaqClient = exports.SearchProjectionClient = exports.ProgrammeCardClient = exports.PropertyNotAvailableException = exports.NotFoundException = exports.InternalServerException = exports.ClientException = exports.BadRequestException = void 0;
 const bad_request_exception_1 = require("./src/exceptions/bad-request-exception");
@@ -18,4 +18,4 @@ Object.defineProperty(exports, "BadRequestException", { enumerable: true, get: function () { return bad_request_exception_1.BadRequestException; } });
 Object.defineProperty(exports, "SearchProjectionClient", { enumerable: true, get: function () { return search_projection_client_1.SearchProjectionClient; } });
-const portal_type_1 = require("./src/types/portal-type");
-Object.defineProperty(exports, "PortalType", { enumerable: true, get: function () { return portal_type_1.PortalType; } });
+const search_country_faq_client_1 = require("./src/models/search-country-faq/search-country-faq-client");
+Object.defineProperty(exports, "SearchCountryFaqClient", { enumerable: true, get: function () { return search_country_faq_client_1.SearchCountryFaqClient; } });
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@studyportals/domain-client",
-  "version": "3.2.0",
+  "version": "3.3.0-beta.0",
   "description": "Responsible for fetching data from the Domain API",
@@ -5,0 +5,0 @@ "main": "bin/index.js",

src/factories/InternalLinkFactory.d.ts

 import { IClassFactory } from "../i-class-factory";
-import { CallableReturnType, Model } from "../types";
+import { Model } from "../types";
 import { PortalMap } from "../types/portal-map";
@@ -7,4 +7,4 @@ export declare class InternalLinkFactory implements IClassFactory {
     constructor(portalMap: PortalMap);
-    create(link: Model): CallableReturnType;
+    create(link: Model): Model;
     private getPortalBaseUrl;
 }

src/i-class-factory.d.ts

@@ -1,4 +0,4 @@
-import { CallableReturnType, Model } from "./types";
+import { Model } from "./types";
 export interface IClassFactory {
-    create(data: Model, parameters?: any[]): CallableReturnType;
+    create(data: Model): Model;
 }

src/i-model-description.d.ts

@@ -5,4 +5,3 @@ import { AcceptedType } from "./types";
     func: Record<string, AcceptedType | IModelDescription>;
-    parameters?: any[];
 }
 export declare function isModelDescription(arg: any): arg is IModelDescription;

src/i-model-description.js

@@ -7,5 +7,5 @@ "use strict";
     // eslint-disable-next-line
-    return arg && arg.class && (arg.func || arg.parameters);
+    return arg && arg.class && arg.func;
 }
 exports.isModelDescription = isModelDescription;
 //# sourceMappingURL=i-model-description.js.map

src/model-factory.d.ts

@@ -10,3 +10,2 @@ import { IModelDescription } from "./i-model-description";
     private getCallable;
-    private unpackArray;
 }

src/model-factory.js

@@ -5,3 +5,2 @@ "use strict";
 const InternalLinkFactory_1 = require("./factories/InternalLinkFactory");
-const DateFactory_1 = require("./factories/DateFactory");
 const i_model_description_1 = require("./i-model-description");
@@ -13,3 +12,2 @@ const property_not_available_exception_1 = require("./exceptions/property-not-available-exception");
         factories.set('IInternalLink', new InternalLinkFactory_1.InternalLinkFactory(portalMap));
-        factories.set('SerializableDateTime', new DateFactory_1.DateFactory());
         this.customClassFactories = factories;
@@ -34,3 +32,3 @@ }
         if (factory !== undefined) {
-            return factory.create(unpacked, data.parameters);
+            return factory.create(unpacked);
         }
@@ -47,5 +45,2 @@ return unpacked;
         }
-        else if (Array.isArray(value)) {
-            returnValue = this.unpackArray(value);
-        }
         else {
@@ -66,12 +61,4 @@ returnValue = value;
     }
-    unpackArray(list) {
-        return list.map(item => {
-            if (i_model_description_1.isModelDescription(item)) {
-                return this.unpackClass(item);
-            }
-            return item;
-        });
-    }
 }
 exports.ModelFactory = ModelFactory;
 //# sourceMappingURL=model-factory.js.map

src/models/programme-card/i-internal-link.d.ts

@@ -12,3 +12,2 @@ export interface IInternalLink {
      * Returns on which portal a this link should link towards.
-     *
      * @return string
@@ -20,4 +19,7 @@ */
      *
-     * Returns a full url whenever the PortalType can be found in the supplied PortalMap
-     * If it doesnt found a match in the PortalMap it will return a relative path.
+     * Note that the url provided is always a relative URL. A base URL is needed
+     * to make it a full valid path.
+     * The only exception is when an external link is provided (meaning, outside
+     * of StudyPortals-maintained domains). In this case a full url will be
+     * provided.
      *
@@ -24,0 +26,0 @@ * @return string

src/models/programme-card/i-programme-card.d.ts

@@ -1,2 +0,2 @@
-import { ICover, IDuration, IInternalLink, ILink, ILocation, ILogo, ITiming, ITrackedLink, ITracking, ITuitionFee } from "../../..";
+import { ICover, IDuration, IInternalLink, ILink, ILocation, ILogo, ITracking, ITuitionFee } from "../../..";
 export interface IProgrammeCard {
@@ -68,9 +68,2 @@ /**
     /**
-     * Get programme's referral link
-     *
-     * @return ITrackedLink
-     */
-    getReferralLink(): ITrackedLink;
-    canShowReferralLink(): boolean;
-    /**
      * Get the summary of the programme.
@@ -82,9 +75,2 @@ *
     /**
-     * Get all start dates
-     *
-     * @return ITiming[]
-     */
-    getTimings(): ITiming[];
-    canShowTimings(): boolean;
-    /**
      * Get the programme title.
@@ -91,0 +77,0 @@ *

src/types.d.ts

 export declare type Model = Record<string, Callable>;
-export declare type Callable = () => CallableReturnType | CallableReturnType[];
+export declare type Callable = () => CallableReturnType;
 export declare type CallableReturnType = AcceptedType | Model;
-export declare type AcceptedType = string | string[] | number | number[] | boolean | null | Date;
+export declare type AcceptedType = string | string[] | number | number[] | boolean | null;

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

54144

decreased by-8.9%

Number of package files

112

decreased by-7.44%

Lines of code

1206

decreased by-10.73%

Number of low quality alerts

2

increased by100%

No dependency changes