@studyportals/search-api-interface 2.2.0-beta.0 → 2.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +2 -1
- package/index.js +3 -1
- package/index.js.map +1 -1
- package/package.json +31 -31
- package/src/TextSearchAlgorithmType.d.ts +4 -0
- package/src/TextSearchAlgorithmType.js +9 -0
- package/src/TextSearchAlgorithmType.js.map +1 -0
- package/src/programmes/IProgrammeSearchFilters.d.ts +2 -0
- package/src/programmes/IProgrammeSearchFilters.js.map +1 -1
- package/src/programmes/ProgrammeSearchFilters.d.ts +2 -0
- package/src/programmes/ProgrammeSearchFilters.js +1 -0
- package/src/programmes/ProgrammeSearchFilters.js.map +1 -1
- package/src/programmes/ProgrammeSearchInput.d.ts +2 -0
package/index.d.ts
CHANGED
|
@@ -14,5 +14,6 @@ import { ProgrammeSearchInput } from "./src/programmes/ProgrammeSearchInput";
|
|
|
14
14
|
import { SearchApiProgrammeClient } from "./src/programmes/SearchApiProgrammeClient";
|
|
15
15
|
import { FacetResponseType, FacetValues } from "./src/facets/FacetResponseType";
|
|
16
16
|
import { ProgrammeSortType } from "./src/programmes/ProgrammeSortType";
|
|
17
|
+
import { TextSearchAlgorithmType } from "./src/TextSearchAlgorithmType";
|
|
17
18
|
import { ProgrammeFilterType } from "./src/programmes/ProgrammeFilterType";
|
|
18
|
-
export { SearchApiOrganisationClient, IOrganisationSearchResponse, IOrganisationSearchFilters, OrganisationSearchFilters, SearchApiProgrammeClient, IProgrammeSearchResponse, IProgrammeSearchFilters, ProgrammeSearchFilters, OrganisationSearchInput, ProgrammeSearchInput, IProgrammeResult, DegreeTypeEnum, DeliveryMethodEnum, HitsTotalRelation, ProgrammeSortType, FacetResponseType, FacetValues, ProgrammeFilterType };
|
|
19
|
+
export { SearchApiOrganisationClient, IOrganisationSearchResponse, IOrganisationSearchFilters, OrganisationSearchFilters, SearchApiProgrammeClient, IProgrammeSearchResponse, IProgrammeSearchFilters, ProgrammeSearchFilters, OrganisationSearchInput, ProgrammeSearchInput, IProgrammeResult, DegreeTypeEnum, DeliveryMethodEnum, HitsTotalRelation, ProgrammeSortType, FacetResponseType, FacetValues, TextSearchAlgorithmType, ProgrammeFilterType };
|
package/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.ProgrammeFilterType = exports.ProgrammeSortType = exports.HitsTotalRelation = exports.DeliveryMethodEnum = exports.DegreeTypeEnum = exports.IProgrammeResult = exports.ProgrammeSearchFilters = exports.IProgrammeSearchFilters = exports.SearchApiProgrammeClient = exports.OrganisationSearchFilters = exports.IOrganisationSearchFilters = exports.SearchApiOrganisationClient = void 0;
|
|
3
|
+
exports.ProgrammeFilterType = exports.TextSearchAlgorithmType = exports.ProgrammeSortType = exports.HitsTotalRelation = exports.DeliveryMethodEnum = exports.DegreeTypeEnum = exports.IProgrammeResult = exports.ProgrammeSearchFilters = exports.IProgrammeSearchFilters = exports.SearchApiProgrammeClient = exports.OrganisationSearchFilters = exports.IOrganisationSearchFilters = exports.SearchApiOrganisationClient = void 0;
|
|
4
4
|
const HitsTotalRelation_1 = require("./src/HitsTotalRelation");
|
|
5
5
|
Object.defineProperty(exports, "HitsTotalRelation", { enumerable: true, get: function () { return HitsTotalRelation_1.HitsTotalRelation; } });
|
|
6
6
|
const DegreeTypeEnum_1 = require("./src/organisations/DegreeTypeEnum");
|
|
@@ -23,6 +23,8 @@ const SearchApiProgrammeClient_1 = require("./src/programmes/SearchApiProgrammeC
|
|
|
23
23
|
Object.defineProperty(exports, "SearchApiProgrammeClient", { enumerable: true, get: function () { return SearchApiProgrammeClient_1.SearchApiProgrammeClient; } });
|
|
24
24
|
const ProgrammeSortType_1 = require("./src/programmes/ProgrammeSortType");
|
|
25
25
|
Object.defineProperty(exports, "ProgrammeSortType", { enumerable: true, get: function () { return ProgrammeSortType_1.ProgrammeSortType; } });
|
|
26
|
+
const TextSearchAlgorithmType_1 = require("./src/TextSearchAlgorithmType");
|
|
27
|
+
Object.defineProperty(exports, "TextSearchAlgorithmType", { enumerable: true, get: function () { return TextSearchAlgorithmType_1.TextSearchAlgorithmType; } });
|
|
26
28
|
const ProgrammeFilterType_1 = require("./src/programmes/ProgrammeFilterType");
|
|
27
29
|
Object.defineProperty(exports, "ProgrammeFilterType", { enumerable: true, get: function () { return ProgrammeFilterType_1.ProgrammeFilterType; } });
|
|
28
30
|
//# sourceMappingURL=index.js.map
|
package/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,+DAA4D;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,+DAA4D;AAoC3D,kGApCQ,qCAAiB,OAoCR;AAnClB,uEAAoE;AAiCnE,+FAjCQ,+BAAc,OAiCR;AAhCf,+EAA4E;AAiC3E,mGAjCQ,uCAAkB,OAiCR;AAhCnB,+FAA4F;AAmB3F,2GAnBQ,uDAA0B,OAmBR;AAjB3B,6FAA0F;AAkBzF,0GAlBQ,qDAAyB,OAkBR;AAhB1B,iGAA8F;AAa7F,4GAbQ,yDAA2B,OAaR;AAZ5B,wEAAqE;AAwBpE,iGAxBQ,mCAAgB,OAwBR;AAvBjB,sFAAmF;AAkBlF,wGAlBQ,iDAAuB,OAkBR;AAhBxB,oFAAiF;AAiBhF,uGAjBQ,+CAAsB,OAiBR;AAfvB,wFAAqF;AAYpF,yGAZQ,mDAAwB,OAYR;AAVzB,0EAAuE;AAuBtE,kGAvBQ,qCAAiB,OAuBR;AAtBlB,2EAAwE;AA2BvE,wGA3BQ,iDAAuB,OA2BR;AA1BxB,8EAA2E;AA2B1E,oGA3BQ,yCAAmB,OA2BR"}
|
package/package.json
CHANGED
|
@@ -1,31 +1,31 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@studyportals/search-api-interface",
|
|
3
|
-
"version": "2.2.
|
|
4
|
-
"description": "Typescript library containing resources that facilitate integration with SearchApi",
|
|
5
|
-
"main": "index.js",
|
|
6
|
-
"scripts": {
|
|
7
|
-
"compile": "rm -fR bin && npx tsc",
|
|
8
|
-
"deploy-patch": "npm version patch && npm run deploy",
|
|
9
|
-
"deploy-minor": "npm version minor && npm run deploy",
|
|
10
|
-
"deploy-major": "npm version major && npm run deploy",
|
|
11
|
-
"deploy-beta": "npm version prerelease && npm run prepare-deployment && npm publish ./bin --tag beta",
|
|
12
|
-
"deploy": "npm run prepare-deployment && npm publish ./bin",
|
|
13
|
-
"prepare-deployment": "npm run compile && cp package.json bin/package.json",
|
|
14
|
-
"lint": "eslint . --ext .ts",
|
|
15
|
-
"lint:fix": "eslint . --ext .ts --fix"
|
|
16
|
-
},
|
|
17
|
-
"author": "Seal Team Six",
|
|
18
|
-
"license": "BSD-3-Clause",
|
|
19
|
-
"devDependencies": {
|
|
20
|
-
"@studyportals/code-style": "^1.7.0",
|
|
21
|
-
"@types/superagent": "^4.1.15",
|
|
22
|
-
"@typescript-eslint/eslint-plugin": "^5.27.0",
|
|
23
|
-
"@typescript-eslint/parser": "^5.27.0",
|
|
24
|
-
"eslint": "^8.17.0",
|
|
25
|
-
"typescript": "^5.5.4",
|
|
26
|
-
"typescript-transform-paths": "^3.4.6"
|
|
27
|
-
},
|
|
28
|
-
"dependencies": {
|
|
29
|
-
"@studyportals/search-filters": "
|
|
30
|
-
}
|
|
31
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "@studyportals/search-api-interface",
|
|
3
|
+
"version": "2.2.1",
|
|
4
|
+
"description": "Typescript library containing resources that facilitate integration with SearchApi",
|
|
5
|
+
"main": "index.js",
|
|
6
|
+
"scripts": {
|
|
7
|
+
"compile": "rm -fR bin && npx tsc",
|
|
8
|
+
"deploy-patch": "npm version patch && npm run deploy",
|
|
9
|
+
"deploy-minor": "npm version minor && npm run deploy",
|
|
10
|
+
"deploy-major": "npm version major && npm run deploy",
|
|
11
|
+
"deploy-beta": "npm version prerelease && npm run prepare-deployment && npm publish ./bin --tag beta",
|
|
12
|
+
"deploy": "npm run prepare-deployment && npm publish ./bin",
|
|
13
|
+
"prepare-deployment": "npm run compile && cp package.json bin/package.json",
|
|
14
|
+
"lint": "eslint . --ext .ts",
|
|
15
|
+
"lint:fix": "eslint . --ext .ts --fix"
|
|
16
|
+
},
|
|
17
|
+
"author": "Seal Team Six",
|
|
18
|
+
"license": "BSD-3-Clause",
|
|
19
|
+
"devDependencies": {
|
|
20
|
+
"@studyportals/code-style": "^1.7.0",
|
|
21
|
+
"@types/superagent": "^4.1.15",
|
|
22
|
+
"@typescript-eslint/eslint-plugin": "^5.27.0",
|
|
23
|
+
"@typescript-eslint/parser": "^5.27.0",
|
|
24
|
+
"eslint": "^8.17.0",
|
|
25
|
+
"typescript": "^5.5.4",
|
|
26
|
+
"typescript-transform-paths": "^3.4.6"
|
|
27
|
+
},
|
|
28
|
+
"dependencies": {
|
|
29
|
+
"@studyportals/search-filters": "4.9.2"
|
|
30
|
+
}
|
|
31
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.TextSearchAlgorithmType = void 0;
|
|
4
|
+
var TextSearchAlgorithmType;
|
|
5
|
+
(function (TextSearchAlgorithmType) {
|
|
6
|
+
TextSearchAlgorithmType["KEYWORD"] = "keyword";
|
|
7
|
+
TextSearchAlgorithmType["SIMILARITY_SEARCH"] = "similarity";
|
|
8
|
+
})(TextSearchAlgorithmType || (exports.TextSearchAlgorithmType = TextSearchAlgorithmType = {}));
|
|
9
|
+
//# sourceMappingURL=TextSearchAlgorithmType.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"TextSearchAlgorithmType.js","sourceRoot":"","sources":["../../src/TextSearchAlgorithmType.ts"],"names":[],"mappings":";;;AAAA,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IAClC,8CAAiB,CAAA;IACjB,2DAA8B,CAAA;AAC/B,CAAC,EAHW,uBAAuB,uCAAvB,uBAAuB,QAGlC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { AttendanceFilterOptionValue, DegreeTypeFilterOptionValue, EducationLevelFilterOptionValue, EducationalFormFilterOptionValue, SpecialProgrammesFilterOptionValue, DurationFilterOptionValue, FormatFilterOptionValue, FacetOptionValue } from "@studyportals/search-filters/server-side";
|
|
2
2
|
import { ProgrammeSortType } from "./ProgrammeSortType";
|
|
3
|
+
import { TextSearchAlgorithmType } from "@/src/TextSearchAlgorithmType";
|
|
3
4
|
export declare class IProgrammeSearchFilters {
|
|
4
5
|
readonly attendances?: AttendanceFilterOptionValue[];
|
|
5
6
|
readonly degreeTypes?: DegreeTypeFilterOptionValue[];
|
|
@@ -20,5 +21,6 @@ export declare class IProgrammeSearchFilters {
|
|
|
20
21
|
readonly sortBy: ProgrammeSortType;
|
|
21
22
|
readonly facets?: FacetOptionValue[];
|
|
22
23
|
readonly facetsDurations?: DurationFilterOptionValue[];
|
|
24
|
+
readonly textSearchAlgorithm?: TextSearchAlgorithmType;
|
|
23
25
|
readonly showHidden?: boolean;
|
|
24
26
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IProgrammeSearchFilters.js","sourceRoot":"","sources":["../../../src/programmes/IProgrammeSearchFilters.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"IProgrammeSearchFilters.js","sourceRoot":"","sources":["../../../src/programmes/IProgrammeSearchFilters.ts"],"names":[],"mappings":";;;AAaA,MAAa,uBAAuB;CA8BnC;AA9BD,0DA8BC"}
|
|
@@ -2,6 +2,7 @@ import { IProgrammeSearchFilters } from "./IProgrammeSearchFilters";
|
|
|
2
2
|
import { ProgrammeSearchInput } from "./ProgrammeSearchInput";
|
|
3
3
|
import { AttendanceFilterOptionValue, DegreeTypeFilterOptionValue, DurationFilterOptionValue, EducationalFormFilterOptionValue, EducationLevelFilterOptionValue, FacetOptionValue, SpecialProgrammesFilterOptionValue, FormatFilterOptionValue } from "@studyportals/search-filters/server-side";
|
|
4
4
|
import { ProgrammeSortType } from "./ProgrammeSortType";
|
|
5
|
+
import { TextSearchAlgorithmType } from "@/src/TextSearchAlgorithmType";
|
|
5
6
|
export declare class ProgrammeSearchFilters implements IProgrammeSearchFilters {
|
|
6
7
|
attendances?: AttendanceFilterOptionValue[];
|
|
7
8
|
degreeTypes?: DegreeTypeFilterOptionValue[];
|
|
@@ -22,6 +23,7 @@ export declare class ProgrammeSearchFilters implements IProgrammeSearchFilters {
|
|
|
22
23
|
sortBy: ProgrammeSortType;
|
|
23
24
|
facets?: FacetOptionValue[];
|
|
24
25
|
facetsDurations?: DurationFilterOptionValue[];
|
|
26
|
+
textSearchAlgorithm?: TextSearchAlgorithmType;
|
|
25
27
|
showHidden?: boolean;
|
|
26
28
|
from(input: ProgrammeSearchInput): IProgrammeSearchFilters;
|
|
27
29
|
private numbersToStringsOrUndefined;
|
|
@@ -23,6 +23,7 @@ class ProgrammeSearchFilters {
|
|
|
23
23
|
this.sortBy = input.sortBy || ProgrammeSortType_1.ProgrammeSortType.DEFAULT;
|
|
24
24
|
this.facets = input.facets;
|
|
25
25
|
this.facetsDurations = input.facetsDurations;
|
|
26
|
+
this.textSearchAlgorithm = input.textSearchAlgorithm;
|
|
26
27
|
this.showHidden = input.showHidden;
|
|
27
28
|
return this;
|
|
28
29
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ProgrammeSearchFilters.js","sourceRoot":"","sources":["../../../src/programmes/ProgrammeSearchFilters.ts"],"names":[],"mappings":";;;AAaA,2DAAwD;
|
|
1
|
+
{"version":3,"file":"ProgrammeSearchFilters.js","sourceRoot":"","sources":["../../../src/programmes/ProgrammeSearchFilters.ts"],"names":[],"mappings":";;;AAaA,2DAAwD;AAGxD,MAAa,sBAAsB;IAgC3B,IAAI,CAAC,KAA2B;QACtC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACvE,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACjD,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAEjC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QAEvB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QAE7C,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1G,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACjD,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,CAAC;QAEzD,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;QACzC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;QAEzC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,qCAAiB,CAAC,OAAO,CAAC;QAExD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QAE7C,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QAEnC,OAAO,IAAI,CAAC;IACb,CAAC;IAEO,2BAA2B,CAAC,MAA4B;QAC/D,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO;QACjC,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC9C,CAAC;CACD;AArED,wDAqEC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { AttendanceFilterOptionValue, DegreeTypeFilterOptionValue, DurationFilterOptionValue, EducationLevelFilterOptionValue, EducationalFormFilterOptionValue, SpecialProgrammesFilterOptionValue, FormatFilterOptionValue, FacetOptionValue } from "@studyportals/search-filters/server-side";
|
|
2
2
|
import { ProgrammeSortType } from "./ProgrammeSortType";
|
|
3
|
+
import { TextSearchAlgorithmType } from "@/src/TextSearchAlgorithmType";
|
|
3
4
|
export type ProgrammeSearchInput = {
|
|
4
5
|
attendances?: AttendanceFilterOptionValue[];
|
|
5
6
|
degreeTypes?: DegreeTypeFilterOptionValue[];
|
|
@@ -20,5 +21,6 @@ export type ProgrammeSearchInput = {
|
|
|
20
21
|
sortBy?: ProgrammeSortType;
|
|
21
22
|
facets?: FacetOptionValue[];
|
|
22
23
|
facetsDurations?: DurationFilterOptionValue[];
|
|
24
|
+
textSearchAlgorithm?: TextSearchAlgorithmType;
|
|
23
25
|
showHidden?: boolean;
|
|
24
26
|
};
|