@biblioteksentralen/bmdb-search 0.0.0-beta.64 → 0.0.0-beta.66

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.
@@ -761,12 +761,15 @@ interface components$1 {
761
761
  /** @description Internal note on the entity. Used for identifying and differentiating entities with similar names. */
762
762
  scopeNote?: string;
763
763
  };
764
+ /** @enum {string} */
765
+ CordataEnumEventTypeCode: "fire" | "genocide" | "famine" | "war" | "criminal_case" | "crisis" | "military_operation" | "natural_disaster" | "uprising" | "pandemic" | "revolution" | "battle" | "strike" | "era" | "time_span" | "concert" | "accident";
764
766
  /** @description Conference, music festival or other type of event. */
765
767
  SubjectTypeEvent: components$1["schemas"]["SubjectBase"] & {
766
768
  /** @constant */
767
769
  type: "SubjectTypeEvent";
768
770
  /** @constant */
769
771
  entityType: "event";
772
+ eventType?: components$1["schemas"]["CordataEnumEventTypeCode"];
770
773
  /** @description Map of identifiers for matching records in external systems. */
771
774
  identifiers: {
772
775
  /** @description Identifier assigned by Biblioteksentralen for authority records. Unique for all authorities independent of type. */
@@ -783,13 +786,14 @@ interface components$1 {
783
786
  type: "SubjectTypeWork";
784
787
  /** @constant */
785
788
  entityType: "work";
789
+ workType: components$1["schemas"]["CordataEnumWorkTypeCode"];
786
790
  /** @description Map of identifiers for matching records in external systems. */
787
791
  identifiers: {
788
792
  bibbiAuthorityId?: string;
789
793
  };
790
794
  };
791
795
  /** @enum {string} */
792
- CordataEnumCollectionTypeCode: "series" | "fictional_universe" | "multipart_work";
796
+ CordataEnumCollectionTypeCode: "series" | "fictional_universe" | "multipart_work" | "game_family";
793
797
  /** @description A Collection is a set of entities - manifestations or works - that share certain features.
794
798
  * The collection can be explicitly named in the source material, such as the series "SF Masterworks" which is a collection of acclaimed SF novels published by Gollancz, or constructed from a set of features that the collected entities have in common, such as "The Lovecraft Mythos" for works that use creatures and features from H.P. Lovecraft's fictional universe. */
795
799
  SubjectTypeCollection: components$1["schemas"]["SubjectBase"] & {
@@ -967,6 +971,17 @@ interface components$1 {
967
971
  domain?: "Expression" | "Manifestation";
968
972
  isUnstable: components$1["schemas"]["IsUnstable"];
969
973
  };
974
+ /** @description Map of other identifiers for the entity */
975
+ CollectionWorkIdentifiers: {
976
+ /** @description Identifier assigned by Biblioteksentralen for authority records. Unique for all authorities independent of type. */
977
+ bibbiAuthorityId?: string;
978
+ /** @description Identifier for the BMDB entity from id.nb.no */
979
+ nbBmdbUri?: string;
980
+ /** @description Identifier for the entity from IMDb */
981
+ imdbId?: string;
982
+ /** @description Identifier for the entity from Wikidata */
983
+ wikidataId?: string;
984
+ };
970
985
  /** @description A Collection is a set of entities - manifestations or works - that share certain features.
971
986
  *
972
987
  * The collection can be explicitly named in the source material, such as the series "SF Masterworks" which is a collection of acclaimed SF novels published by Gollancz, or constructed from a set of features that the collected entities have in common, such as "The Lovecraft Mythos" for works that use creatures and features from H.P. Lovecraft's fictional universe.
@@ -978,17 +993,7 @@ interface components$1 {
978
993
  /** @constant */
979
994
  entityType: "collection_work";
980
995
  id: components$1["schemas"]["Id"];
981
- /** @description Map of other identifiers for the entity */
982
- identifiers: {
983
- /** @description Identifier assigned by Biblioteksentralen for authority records. Unique for all authorities independent of type. */
984
- bibbiAuthorityId?: string;
985
- /** @description Identifier for the BMDB entity from id.nb.no */
986
- nbBmdbUri?: string;
987
- /** @description Identifier for the entity from IMDb */
988
- imdbId?: string;
989
- /** @description Identifier for the entity from Wikidata */
990
- wikidataId?: string;
991
- };
996
+ identifiers: components$1["schemas"]["CollectionWorkIdentifiers"];
992
997
  collectionType: components$1["schemas"]["CordataEnumCollectionTypeCode"];
993
998
  workType?: components$1["schemas"]["CordataEnumWorkType"];
994
999
  /** @description TODO */
@@ -1894,6 +1899,48 @@ interface paths {
1894
1899
  patch?: never;
1895
1900
  trace?: never;
1896
1901
  };
1902
+ "/{searchProfile}/subjects/search": {
1903
+ parameters: {
1904
+ query?: never;
1905
+ header?: never;
1906
+ path?: never;
1907
+ cookie?: never;
1908
+ };
1909
+ /**
1910
+ * Search subjects
1911
+ * @description Endpoint for searching BMDB subjects.
1912
+ *
1913
+ */
1914
+ get: operations["searchSubjects"];
1915
+ put?: never;
1916
+ post?: never;
1917
+ delete?: never;
1918
+ options?: never;
1919
+ head?: never;
1920
+ patch?: never;
1921
+ trace?: never;
1922
+ };
1923
+ "/{searchProfile}/subjects": {
1924
+ parameters: {
1925
+ query?: never;
1926
+ header?: never;
1927
+ path?: never;
1928
+ cookie?: never;
1929
+ };
1930
+ /**
1931
+ * Get subjects
1932
+ * @description Endpoint for getting BMDB subjects.
1933
+ *
1934
+ */
1935
+ get: operations["getSubjects"];
1936
+ put?: never;
1937
+ post?: never;
1938
+ delete?: never;
1939
+ options?: never;
1940
+ head?: never;
1941
+ patch?: never;
1942
+ trace?: never;
1943
+ };
1897
1944
  "/{searchProfile}/catalogue-records": {
1898
1945
  parameters: {
1899
1946
  query?: never;
@@ -1915,6 +1962,27 @@ interface paths {
1915
1962
  patch?: never;
1916
1963
  trace?: never;
1917
1964
  };
1965
+ "/{searchProfile}/suggestions/search": {
1966
+ parameters: {
1967
+ query?: never;
1968
+ header?: never;
1969
+ path?: never;
1970
+ cookie?: never;
1971
+ };
1972
+ /**
1973
+ * Search suggestions
1974
+ * @description Endpoint for searching suggestions.
1975
+ *
1976
+ */
1977
+ get: operations["searchSuggestions"];
1978
+ put?: never;
1979
+ post?: never;
1980
+ delete?: never;
1981
+ options?: never;
1982
+ head?: never;
1983
+ patch?: never;
1984
+ trace?: never;
1985
+ };
1918
1986
  "/search-profiles": {
1919
1987
  parameters: {
1920
1988
  query?: never;
@@ -2265,7 +2333,7 @@ interface components {
2265
2333
  roles: components["schemas"]["CordataEnumContributorRoleTranslated"][];
2266
2334
  };
2267
2335
  /** @enum {string} */
2268
- CordataEnumCollectionTypeCode: "series" | "fictional_universe" | "multipart_work";
2336
+ CordataEnumCollectionTypeCode: "series" | "fictional_universe" | "multipart_work" | "game_family";
2269
2337
  CordataEnumCollectionTypeTranslated: {
2270
2338
  code: components["schemas"]["CordataEnumCollectionTypeCode"];
2271
2339
  label: string;
@@ -2895,12 +2963,15 @@ interface components {
2895
2963
  /** @description Internal note on the entity. Used for identifying and differentiating entities with similar names. */
2896
2964
  scopeNote?: string;
2897
2965
  };
2966
+ /** @enum {string} */
2967
+ CordataEnumEventTypeCode: "fire" | "genocide" | "famine" | "war" | "criminal_case" | "crisis" | "military_operation" | "natural_disaster" | "uprising" | "pandemic" | "revolution" | "battle" | "strike" | "era" | "time_span" | "concert" | "accident";
2898
2968
  /** @description Conference, music festival or other type of event. */
2899
2969
  SubjectTypeEvent: components["schemas"]["SubjectBase"] & {
2900
2970
  /** @constant */
2901
2971
  type: "SubjectTypeEvent";
2902
2972
  /** @constant */
2903
2973
  entityType: "event";
2974
+ eventType?: components["schemas"]["CordataEnumEventTypeCode"];
2904
2975
  /** @description Map of identifiers for matching records in external systems. */
2905
2976
  identifiers: {
2906
2977
  /** @description Identifier assigned by Biblioteksentralen for authority records. Unique for all authorities independent of type. */
@@ -2917,6 +2988,7 @@ interface components {
2917
2988
  type: "SubjectTypeWork";
2918
2989
  /** @constant */
2919
2990
  entityType: "work";
2991
+ workType: components["schemas"]["CordataEnumWorkTypeCode"];
2920
2992
  /** @description Map of identifiers for matching records in external systems. */
2921
2993
  identifiers: {
2922
2994
  bibbiAuthorityId?: string;
@@ -3097,6 +3169,17 @@ interface components {
3097
3169
  domain?: "Expression" | "Manifestation";
3098
3170
  isUnstable: components["schemas"]["IsUnstable"];
3099
3171
  };
3172
+ /** @description Map of other identifiers for the entity */
3173
+ CollectionWorkIdentifiers: {
3174
+ /** @description Identifier assigned by Biblioteksentralen for authority records. Unique for all authorities independent of type. */
3175
+ bibbiAuthorityId?: string;
3176
+ /** @description Identifier for the BMDB entity from id.nb.no */
3177
+ nbBmdbUri?: string;
3178
+ /** @description Identifier for the entity from IMDb */
3179
+ imdbId?: string;
3180
+ /** @description Identifier for the entity from Wikidata */
3181
+ wikidataId?: string;
3182
+ };
3100
3183
  /** @description A Collection is a set of entities - manifestations or works - that share certain features.
3101
3184
  *
3102
3185
  * The collection can be explicitly named in the source material, such as the series "SF Masterworks" which is a collection of acclaimed SF novels published by Gollancz, or constructed from a set of features that the collected entities have in common, such as "The Lovecraft Mythos" for works that use creatures and features from H.P. Lovecraft's fictional universe.
@@ -3108,17 +3191,7 @@ interface components {
3108
3191
  /** @constant */
3109
3192
  entityType: "collection_work";
3110
3193
  id: components["schemas"]["Id"];
3111
- /** @description Map of other identifiers for the entity */
3112
- identifiers: {
3113
- /** @description Identifier assigned by Biblioteksentralen for authority records. Unique for all authorities independent of type. */
3114
- bibbiAuthorityId?: string;
3115
- /** @description Identifier for the BMDB entity from id.nb.no */
3116
- nbBmdbUri?: string;
3117
- /** @description Identifier for the entity from IMDb */
3118
- imdbId?: string;
3119
- /** @description Identifier for the entity from Wikidata */
3120
- wikidataId?: string;
3121
- };
3194
+ identifiers: components["schemas"]["CollectionWorkIdentifiers"];
3122
3195
  collectionType: components["schemas"]["CordataEnumCollectionTypeCode"];
3123
3196
  workType?: components["schemas"]["CordataEnumWorkType"];
3124
3197
  /** @description TODO */
@@ -3698,11 +3771,7 @@ interface components {
3698
3771
  /** @constant */
3699
3772
  entityType: "collection_work";
3700
3773
  id: components["schemas"]["Id"];
3701
- /** @description Map of other identifiers for the entity */
3702
- identifiers: {
3703
- /** @description Identifier assigned by Biblioteksentralen for authority records. Unique for all authorities independent of type. */
3704
- bibbiAuthorityId?: string;
3705
- };
3774
+ identifiers: components["schemas"]["CollectionWorkIdentifiers"];
3706
3775
  collectionType: components["schemas"]["CordataEnumCollectionTypeTranslated"];
3707
3776
  workType?: components["schemas"]["CordataEnumWorkTypeTranslated"];
3708
3777
  expressionType?: components["schemas"]["CordataEnumExpressionTypeTranslated"];
@@ -3805,6 +3874,125 @@ interface components {
3805
3874
  collection: components["schemas"]["CollectionWork"];
3806
3875
  }[];
3807
3876
  };
3877
+ SubjectSearchFilterType: {
3878
+ identifier?: string;
3879
+ id?: string;
3880
+ /** @enum {string} */
3881
+ type?: "concept" | "event" | "agent" | "work" | "collection_work";
3882
+ catalogue?: string;
3883
+ };
3884
+ /**
3885
+ * @description How the search results should be sorted. Available options:
3886
+ *
3887
+ * - `relevance.desc`
3888
+ * - `updateTime.desc`
3889
+ * - `updateTime.asc`
3890
+ * @enum {string}
3891
+ */
3892
+ SubjectSearchSortType: "relevance.desc" | "updateTime.desc" | "updateTime.asc";
3893
+ /** @enum {string} */
3894
+ SubjectSearchFacetType: "catalogue";
3895
+ CordataEnumConceptTypeTranslated: {
3896
+ code: components["schemas"]["CordataEnumConceptTypeCode"];
3897
+ label: string;
3898
+ };
3899
+ CordataEnumEventTypeTranslated: {
3900
+ code: components["schemas"]["CordataEnumEventTypeCode"];
3901
+ label: string;
3902
+ };
3903
+ CordataEnumPlaceTypeTranslated: {
3904
+ code: components["schemas"]["CordataEnumPlaceTypeCode"];
3905
+ label: string;
3906
+ };
3907
+ SubjectSummary: {
3908
+ id: components["schemas"]["Id"];
3909
+ name: string;
3910
+ /** @constant */
3911
+ type: "SubjectSummary";
3912
+ /** @constant */
3913
+ entityType: "subject";
3914
+ about?: {
3915
+ /** @constant */
3916
+ type: "SubjectSummaryConcept";
3917
+ /** @constant */
3918
+ entityType: "concept";
3919
+ conceptType: components["schemas"]["CordataEnumConceptTypeTranslated"];
3920
+ identifiers: {
3921
+ /** @description Identifier assigned by Biblioteksentralen for authority records. Unique for all authorities independent of type. */
3922
+ bibbiAuthorityId?: string;
3923
+ /** @description Identifier from Norske emneord (NEO). */
3924
+ neoUri?: string;
3925
+ };
3926
+ } | {
3927
+ /** @constant */
3928
+ type: "SubjectSummaryEvent";
3929
+ /** @constant */
3930
+ entityType: "event";
3931
+ eventType?: components["schemas"]["CordataEnumEventTypeTranslated"];
3932
+ identifiers: {
3933
+ /** @description Identifier assigned by Biblioteksentralen for authority records. Unique for all authorities independent of type. */
3934
+ bibbiAuthorityId?: string;
3935
+ neoUri?: string;
3936
+ };
3937
+ } | {
3938
+ /** @constant */
3939
+ type: "SubjectSummaryPlace";
3940
+ /** @constant */
3941
+ entityType: "place";
3942
+ placeType?: components["schemas"]["CordataEnumPlaceTypeTranslated"];
3943
+ identifiers: {
3944
+ /** @description Identifier assigned by Biblioteksentralen for authority records. Unique for all authorities independent of type. */
3945
+ bibbiAuthorityId?: string;
3946
+ /** @description Identifier from Norske emneord (NEO). */
3947
+ neoUri?: string;
3948
+ };
3949
+ } | {
3950
+ /** @constant */
3951
+ type: "SubjectSummaryAgent";
3952
+ /** @constant */
3953
+ entityType: "agent";
3954
+ agentType: components["schemas"]["CordataEnumAgentTypeTranslated"];
3955
+ identifiers: components["schemas"]["AgentIdentifiers"];
3956
+ } | {
3957
+ /** @constant */
3958
+ type: "SubjectSummaryWork";
3959
+ /** @constant */
3960
+ entityType: "work";
3961
+ workType: components["schemas"]["CordataEnumWorkTypeTranslated"];
3962
+ identifiers: components["schemas"]["WorkIdentifiers"];
3963
+ } | {
3964
+ /** @constant */
3965
+ type: "SubjectSummaryCollection";
3966
+ /** @constant */
3967
+ entityType: "collection_work";
3968
+ collectionType: components["schemas"]["CordataEnumCollectionTypeTranslated"];
3969
+ identifiers: components["schemas"]["CollectionWorkIdentifiers"];
3970
+ };
3971
+ };
3972
+ SubjectFacet: {
3973
+ type: components["schemas"]["SubjectSearchFacetType"];
3974
+ /** @description A displayable (human readable) facet name. */
3975
+ name?: string;
3976
+ terms: components["schemas"]["FacetTerm"][];
3977
+ };
3978
+ SearchSubjects200Response: {
3979
+ total?: components["schemas"]["total"];
3980
+ results: {
3981
+ subject: components["schemas"]["SubjectSummary"];
3982
+ }[];
3983
+ endOfResults: components["schemas"]["endOfResults"];
3984
+ /** @description This array contains the requested facets, and their terms. Each facet type should only appear once in the array. */
3985
+ facets?: components["schemas"]["SubjectFacet"][];
3986
+ queryType?: components["schemas"]["queryType"];
3987
+ advancedQueryErrors?: components["schemas"]["advancedQueryErrors"];
3988
+ sorting: components["schemas"]["SubjectSearchSortType"];
3989
+ };
3990
+ GetSubjects200Response: {
3991
+ total?: components["schemas"]["total"];
3992
+ results: {
3993
+ subject: components["schemas"]["Subject"];
3994
+ }[];
3995
+ };
3808
3996
  CatalogueRecordWork: {
3809
3997
  /** @constant */
3810
3998
  type: "CatalogueRecordWork";
@@ -3891,6 +4079,93 @@ interface components {
3891
4079
  catalogueRecord: components["schemas"]["CatalogueRecord"];
3892
4080
  }[];
3893
4081
  };
4082
+ SuggestionSearchFilterType: {
4083
+ /**
4084
+ * @description Suggestion type
4085
+ * @enum {string}
4086
+ */
4087
+ type?: "work" | "agent" | "collection" | "subject";
4088
+ };
4089
+ SuggestionAgentBase: {
4090
+ id: components["schemas"]["Id"];
4091
+ name: string;
4092
+ /** @constant */
4093
+ entityType: "agent";
4094
+ agentType: components["schemas"]["CordataEnumAgentTypeTranslated"];
4095
+ collectiveAgentType?: components["schemas"]["CordataEnumCollectiveAgentTypeTranslated"];
4096
+ identifiers: components["schemas"]["AgentIdentifiers"];
4097
+ };
4098
+ SuggestionContributor: {
4099
+ agent: {
4100
+ /** @constant */
4101
+ type: "ContributorAgentSuggestion";
4102
+ } & components["schemas"]["SuggestionAgentBase"];
4103
+ /**
4104
+ * Role
4105
+ * @description The Role shows which function the Agent has had in the process of producing an entity.
4106
+ */
4107
+ roles: components["schemas"]["CordataEnumContributorRoleTranslated"][];
4108
+ };
4109
+ Suggestion: {
4110
+ /** @constant */
4111
+ type: "WorkSuggestion";
4112
+ /** @constant */
4113
+ entityType: "work";
4114
+ id: components["schemas"]["Id"];
4115
+ workType: components["schemas"]["CordataEnumWorkTypeTranslated"];
4116
+ expressionTypes: components["schemas"]["CordataEnumExpressionTypeTranslated"][];
4117
+ title: string;
4118
+ identifiers: components["schemas"]["WorkIdentifiers"];
4119
+ contributors: components["schemas"]["SuggestionContributor"][];
4120
+ } | ({
4121
+ /** @constant */
4122
+ type: "AgentSuggestion";
4123
+ } & components["schemas"]["SuggestionAgentBase"]) | {
4124
+ /** @constant */
4125
+ type: "CollectionSuggestion";
4126
+ /** @constant */
4127
+ entityType: "collection_work";
4128
+ collectionType: components["schemas"]["CordataEnumCollectionTypeTranslated"];
4129
+ workType?: components["schemas"]["CordataEnumWorkTypeTranslated"];
4130
+ expressionTypes?: components["schemas"]["CordataEnumExpressionTypeTranslated"][];
4131
+ id: components["schemas"]["Id"];
4132
+ title: string;
4133
+ identifiers: components["schemas"]["CollectionWorkIdentifiers"];
4134
+ contributors: components["schemas"]["SuggestionContributor"][];
4135
+ } | {
4136
+ /** @constant */
4137
+ type: "SubjectSuggestion";
4138
+ /** @constant */
4139
+ entityType: "subject";
4140
+ subjectType: {
4141
+ /** @enum {string} */
4142
+ code: "concept" | "event" | "place" | "person" | "collective_agent" | "artificial_agent" | "work" | "collection";
4143
+ label: string;
4144
+ };
4145
+ id: components["schemas"]["Id"];
4146
+ label: string;
4147
+ /** @description Map of other identifiers for the entity. */
4148
+ identifiers: {
4149
+ bibbiAuthorityId?: string;
4150
+ /** @description Identifier from Norske emneord (NEO). */
4151
+ neoUri?: string;
4152
+ norafId?: string;
4153
+ /** @description Unique ID assigned to an agent in Bokbasen. */
4154
+ bokbasenId?: string;
4155
+ /** @description International Standard Name Identifier. */
4156
+ isni?: string;
4157
+ };
4158
+ };
4159
+ SearchSuggestions200Response: {
4160
+ results: {
4161
+ suggestion: components["schemas"]["Suggestion"];
4162
+ }[];
4163
+ warnings?: {
4164
+ /** @enum {string} */
4165
+ code: "query_too_short" | "advanced_search_detected";
4166
+ message: string;
4167
+ }[];
4168
+ };
3894
4169
  LibrarySystem: {
3895
4170
  /** @constant */
3896
4171
  librarySystemType: "bibliofil";
@@ -4328,6 +4603,86 @@ interface operations {
4328
4603
  };
4329
4604
  };
4330
4605
  };
4606
+ searchSubjects: {
4607
+ parameters: {
4608
+ query?: {
4609
+ /** @description The search query. */
4610
+ query?: components["parameters"]["QueryParameter"];
4611
+ /** @description Page size (default 10).
4612
+ * It's important to be aware that, the page size here is only a preferred page size, the result set can be both small and greater, depending on the implementation from the LMS provider.
4613
+ * This is important to consider in any product design.
4614
+ * */
4615
+ size?: components["parameters"]["SizeParameter"];
4616
+ /** @description Page number (default 1). */
4617
+ page?: components["parameters"]["PageParameter"];
4618
+ /** @description The filters are AND'ed together.
4619
+ * All filters support multiple comma-separated values that are OR'ed together except `catalogue`.
4620
+ * */
4621
+ filter?: components["schemas"]["SubjectSearchFilterType"];
4622
+ /** @description Sorting */
4623
+ sort?: components["schemas"]["SubjectSearchSortType"];
4624
+ facet?: components["schemas"]["SubjectSearchFacetType"][];
4625
+ /** @description Return this number of facet terms for each requested facet (default 10). */
4626
+ facet_terms_size?: components["parameters"]["FacetTermsSizeParameter"];
4627
+ /** @description The UI language determines the language of human-readable labels and descriptions in the API responses.
4628
+ * */
4629
+ ui_language?: components["parameters"]["UiLanguageParameter"];
4630
+ /** @description Feature flags for enabling or disabling experimental features in the API. These flags are intended for testing and may be removed without notice.
4631
+ * */
4632
+ ft?: components["parameters"]["FeatureFlagParameter"];
4633
+ };
4634
+ header?: never;
4635
+ path: {
4636
+ /** @description The search profile defines the scope of the search. Each library has their own search profile. A special search profile called "global" is available for searching across all libraries.
4637
+ * */
4638
+ searchProfile: components["parameters"]["SearchProfileParameter"];
4639
+ };
4640
+ cookie?: never;
4641
+ };
4642
+ requestBody?: never;
4643
+ responses: {
4644
+ /** @description List of subjects */
4645
+ 200: {
4646
+ headers: {
4647
+ [name: string]: unknown;
4648
+ };
4649
+ content: {
4650
+ "application/json": components["schemas"]["SearchSubjects200Response"];
4651
+ };
4652
+ };
4653
+ };
4654
+ };
4655
+ getSubjects: {
4656
+ parameters: {
4657
+ query: {
4658
+ /** @description Comma-separated IDs. Accepts different formats where appropriate.
4659
+ * */
4660
+ ids: components["parameters"]["IdsParameter"];
4661
+ /** @description The UI language determines the language of human-readable labels and descriptions in the API responses.
4662
+ * */
4663
+ ui_language?: components["parameters"]["UiLanguageParameter"];
4664
+ };
4665
+ header?: never;
4666
+ path: {
4667
+ /** @description The search profile defines the scope of the search. Each library has their own search profile. A special search profile called "global" is available for searching across all libraries.
4668
+ * */
4669
+ searchProfile: components["parameters"]["SearchProfileParameter"];
4670
+ };
4671
+ cookie?: never;
4672
+ };
4673
+ requestBody?: never;
4674
+ responses: {
4675
+ /** @description List of subjects */
4676
+ 200: {
4677
+ headers: {
4678
+ [name: string]: unknown;
4679
+ };
4680
+ content: {
4681
+ "application/json": components["schemas"]["GetSubjects200Response"];
4682
+ };
4683
+ };
4684
+ };
4685
+ };
4331
4686
  getCatalogueRecords: {
4332
4687
  parameters: {
4333
4688
  query: {
@@ -4380,6 +4735,67 @@ interface operations {
4380
4735
  };
4381
4736
  };
4382
4737
  };
4738
+ searchSuggestions: {
4739
+ parameters: {
4740
+ query?: {
4741
+ /** @description The search query. */
4742
+ query?: components["parameters"]["QueryParameter"];
4743
+ /** @description Page size (default 10).
4744
+ * It's important to be aware that, the page size here is only a preferred page size, the result set can be both small and greater, depending on the implementation from the LMS provider.
4745
+ * This is important to consider in any product design.
4746
+ * */
4747
+ size?: components["parameters"]["SizeParameter"];
4748
+ /** @description The filters are AND'ed together.
4749
+ * These filters support multiple comma-separated values that are OR'ed together:
4750
+ * `type`
4751
+ * */
4752
+ filter?: components["schemas"]["SuggestionSearchFilterType"];
4753
+ /** @description The UI language determines the language of human-readable labels and descriptions in the API responses.
4754
+ * */
4755
+ ui_language?: components["parameters"]["UiLanguageParameter"];
4756
+ /** @description Feature flags for enabling or disabling experimental features in the API. These flags are intended for testing and may be removed without notice.
4757
+ * */
4758
+ ft?: components["parameters"]["FeatureFlagParameter"];
4759
+ };
4760
+ header?: never;
4761
+ path: {
4762
+ /** @description The search profile defines the scope of the search. Each library has their own search profile. A special search profile called "global" is available for searching across all libraries.
4763
+ * */
4764
+ searchProfile: components["parameters"]["SearchProfileParameter"];
4765
+ };
4766
+ cookie?: never;
4767
+ };
4768
+ requestBody?: never;
4769
+ responses: {
4770
+ /** @description List of suggestions */
4771
+ 200: {
4772
+ headers: {
4773
+ [name: string]: unknown;
4774
+ };
4775
+ content: {
4776
+ "application/json": components["schemas"]["SearchSuggestions200Response"];
4777
+ };
4778
+ };
4779
+ /** @description Search profile not found */
4780
+ 404: {
4781
+ headers: {
4782
+ [name: string]: unknown;
4783
+ };
4784
+ content: {
4785
+ "application/problem+json": components["schemas"]["SearchProfileNotFoundError"];
4786
+ };
4787
+ };
4788
+ /** @description Request validation error */
4789
+ 422: {
4790
+ headers: {
4791
+ [name: string]: unknown;
4792
+ };
4793
+ content: {
4794
+ "application/problem+json": components["schemas"]["RequestValidationError"];
4795
+ };
4796
+ };
4797
+ };
4798
+ };
4383
4799
  getSearchProfiles: {
4384
4800
  parameters: {
4385
4801
  query?: {
@@ -4542,11 +4958,21 @@ declare const cordataEnumExpressionTypeMap: {
4542
4958
  readonly comments: null;
4543
4959
  readonly domain: "cordata";
4544
4960
  readonly work_type: "literary";
4545
- readonly preferred_plural_name: {
4961
+ readonly preferred_name_definite: {
4962
+ readonly nb: "boken";
4963
+ readonly nn: "boka";
4964
+ readonly en: "book";
4965
+ };
4966
+ readonly preferred_name_plural: {
4546
4967
  readonly nb: "bøker";
4547
4968
  readonly nn: "bøker";
4548
4969
  readonly en: "books";
4549
4970
  };
4971
+ readonly preferred_name_definite_plural: {
4972
+ readonly nb: "bøkene";
4973
+ readonly nn: "bøkene";
4974
+ readonly en: "books";
4975
+ };
4550
4976
  readonly type: "expression_type";
4551
4977
  };
4552
4978
  readonly audiobook: {
@@ -4560,11 +4986,21 @@ declare const cordataEnumExpressionTypeMap: {
4560
4986
  readonly comments: null;
4561
4987
  readonly domain: "cordata";
4562
4988
  readonly work_type: "literary";
4563
- readonly preferred_plural_name: {
4989
+ readonly preferred_name_definite: {
4990
+ readonly nb: "lydboken";
4991
+ readonly nn: "lydboka";
4992
+ readonly en: "audiobook";
4993
+ };
4994
+ readonly preferred_name_plural: {
4564
4995
  readonly nb: "lydbøker";
4565
4996
  readonly nn: "lydbøker";
4566
4997
  readonly en: "audiobooks";
4567
4998
  };
4999
+ readonly preferred_name_definite_plural: {
5000
+ readonly nb: "lydbøkene";
5001
+ readonly nn: "lydbøkene";
5002
+ readonly en: "audiobooks";
5003
+ };
4568
5004
  readonly type: "expression_type";
4569
5005
  };
4570
5006
  readonly combined: {
@@ -4578,11 +5014,21 @@ declare const cordataEnumExpressionTypeMap: {
4578
5014
  readonly comments: null;
4579
5015
  readonly domain: "cordata";
4580
5016
  readonly work_type: "literary";
4581
- readonly preferred_plural_name: {
5017
+ readonly preferred_name_definite: {
5018
+ readonly nb: "kombidokumentet";
5019
+ readonly nn: "kombidokumentet";
5020
+ readonly en: "mixed materials";
5021
+ };
5022
+ readonly preferred_name_plural: {
4582
5023
  readonly nb: "kombidokumenter";
4583
5024
  readonly nn: "kombidokument";
4584
5025
  readonly en: "mixed materials";
4585
5026
  };
5027
+ readonly preferred_name_definite_plural: {
5028
+ readonly nb: "kombidokumentene";
5029
+ readonly nn: "kombidokumenta";
5030
+ readonly en: "mixed materials";
5031
+ };
4586
5032
  readonly type: "expression_type";
4587
5033
  };
4588
5034
  readonly box_set: {
@@ -4596,11 +5042,21 @@ declare const cordataEnumExpressionTypeMap: {
4596
5042
  readonly comments: null;
4597
5043
  readonly domain: "cordata";
4598
5044
  readonly work_type: "literary";
4599
- readonly preferred_plural_name: {
5045
+ readonly preferred_name_definite: {
5046
+ readonly nb: "samleboksen";
5047
+ readonly nn: "samleboksen";
5048
+ readonly en: "box set";
5049
+ };
5050
+ readonly preferred_name_plural: {
4600
5051
  readonly nb: "samlebokser";
4601
5052
  readonly nn: "samleboksar";
4602
5053
  readonly en: "box sets";
4603
5054
  };
5055
+ readonly preferred_name_definite_plural: {
5056
+ readonly nb: "samleboksene";
5057
+ readonly nn: "samleboksane";
5058
+ readonly en: "box sets";
5059
+ };
4604
5060
  readonly type: "expression_type";
4605
5061
  };
4606
5062
  readonly atlas: {
@@ -4614,11 +5070,21 @@ declare const cordataEnumExpressionTypeMap: {
4614
5070
  readonly comments: null;
4615
5071
  readonly domain: "cordata";
4616
5072
  readonly work_type: "cartographic";
4617
- readonly preferred_plural_name: {
5073
+ readonly preferred_name_definite: {
5074
+ readonly nb: "atlaset";
5075
+ readonly nn: "atlaset";
5076
+ readonly en: "atlas";
5077
+ };
5078
+ readonly preferred_name_plural: {
4618
5079
  readonly nb: "atlas";
4619
5080
  readonly nn: "atlas";
4620
5081
  readonly en: "atlases";
4621
5082
  };
5083
+ readonly preferred_name_definite_plural: {
5084
+ readonly nb: "atlasene";
5085
+ readonly nn: "atlasa";
5086
+ readonly en: "atlases";
5087
+ };
4622
5088
  readonly type: "expression_type";
4623
5089
  };
4624
5090
  readonly map: {
@@ -4632,11 +5098,21 @@ declare const cordataEnumExpressionTypeMap: {
4632
5098
  readonly comments: null;
4633
5099
  readonly domain: "cordata";
4634
5100
  readonly work_type: "cartographic";
4635
- readonly preferred_plural_name: {
5101
+ readonly preferred_name_definite: {
5102
+ readonly nb: "kartet";
5103
+ readonly nn: "kartet";
5104
+ readonly en: "map";
5105
+ };
5106
+ readonly preferred_name_plural: {
4636
5107
  readonly nb: "kart";
4637
5108
  readonly nn: "kart";
4638
5109
  readonly en: "maps";
4639
5110
  };
5111
+ readonly preferred_name_definite_plural: {
5112
+ readonly nb: "kartene";
5113
+ readonly nn: "karta";
5114
+ readonly en: "maps";
5115
+ };
4640
5116
  readonly type: "expression_type";
4641
5117
  };
4642
5118
  readonly musical_recording: {
@@ -4650,11 +5126,21 @@ declare const cordataEnumExpressionTypeMap: {
4650
5126
  readonly comments: null;
4651
5127
  readonly domain: "cordata";
4652
5128
  readonly work_type: "music";
4653
- readonly preferred_plural_name: {
5129
+ readonly preferred_name_definite: {
5130
+ readonly nb: "musikkinnspillingen";
5131
+ readonly nn: "musikkinnspelinga";
5132
+ readonly en: "musical recording";
5133
+ };
5134
+ readonly preferred_name_plural: {
4654
5135
  readonly nb: "musikkinnspillinger";
4655
5136
  readonly nn: "musikkinnspelingar";
4656
5137
  readonly en: "musical recordings";
4657
5138
  };
5139
+ readonly preferred_name_definite_plural: {
5140
+ readonly nb: "musikkinnspillingene";
5141
+ readonly nn: "musikkinnspelingane";
5142
+ readonly en: "musical recordings";
5143
+ };
4658
5144
  readonly type: "expression_type";
4659
5145
  };
4660
5146
  readonly musical_notation: {
@@ -4668,11 +5154,21 @@ declare const cordataEnumExpressionTypeMap: {
4668
5154
  readonly comments: null;
4669
5155
  readonly domain: "cordata";
4670
5156
  readonly work_type: "music";
4671
- readonly preferred_plural_name: {
5157
+ readonly preferred_name_definite: {
5158
+ readonly nb: "musikknotasjonen";
5159
+ readonly nn: "musikknotasjonen";
5160
+ readonly en: "musical notation";
5161
+ };
5162
+ readonly preferred_name_plural: {
4672
5163
  readonly nb: "musikknotasjon";
4673
5164
  readonly nn: "musikknotasjon";
4674
5165
  readonly en: "musical notation";
4675
5166
  };
5167
+ readonly preferred_name_definite_plural: {
5168
+ readonly nb: "musikknotasjonen";
5169
+ readonly nn: "musikknotasjonen";
5170
+ readonly en: "musical notation";
5171
+ };
4676
5172
  readonly type: "expression_type";
4677
5173
  };
4678
5174
  readonly movie: {
@@ -4686,11 +5182,21 @@ declare const cordataEnumExpressionTypeMap: {
4686
5182
  readonly comments: null;
4687
5183
  readonly domain: "cordata";
4688
5184
  readonly work_type: "moving_image";
4689
- readonly preferred_plural_name: {
5185
+ readonly preferred_name_definite: {
5186
+ readonly nb: "filmen";
5187
+ readonly nn: "filmen";
5188
+ readonly en: "movie";
5189
+ };
5190
+ readonly preferred_name_plural: {
4690
5191
  readonly nb: "filmer";
4691
5192
  readonly nn: "filmar";
4692
5193
  readonly en: "movies";
4693
5194
  };
5195
+ readonly preferred_name_definite_plural: {
5196
+ readonly nb: "filmene";
5197
+ readonly nn: "filmane";
5198
+ readonly en: "movies";
5199
+ };
4694
5200
  readonly type: "expression_type";
4695
5201
  };
4696
5202
  readonly videogame: {
@@ -4704,11 +5210,21 @@ declare const cordataEnumExpressionTypeMap: {
4704
5210
  readonly comments: null;
4705
5211
  readonly domain: "cordata";
4706
5212
  readonly work_type: "interactive";
4707
- readonly preferred_plural_name: {
5213
+ readonly preferred_name_definite: {
5214
+ readonly nb: "dataspillet";
5215
+ readonly nn: "dataspelet";
5216
+ readonly en: "video game";
5217
+ };
5218
+ readonly preferred_name_plural: {
4708
5219
  readonly nb: "dataspill";
4709
5220
  readonly nn: "dataspel";
4710
5221
  readonly en: "video games";
4711
5222
  };
5223
+ readonly preferred_name_definite_plural: {
5224
+ readonly nb: "dataspillene";
5225
+ readonly nn: "dataspela";
5226
+ readonly en: "video games";
5227
+ };
4712
5228
  readonly type: "expression_type";
4713
5229
  };
4714
5230
  readonly software: {
@@ -4722,11 +5238,21 @@ declare const cordataEnumExpressionTypeMap: {
4722
5238
  readonly comments: null;
4723
5239
  readonly domain: "cordata";
4724
5240
  readonly work_type: "interactive";
4725
- readonly preferred_plural_name: {
5241
+ readonly preferred_name_definite: {
5242
+ readonly nb: "programvaren";
5243
+ readonly nn: "programvaren";
5244
+ readonly en: "software";
5245
+ };
5246
+ readonly preferred_name_plural: {
4726
5247
  readonly nb: "programvare";
4727
5248
  readonly nn: "programvare";
4728
5249
  readonly en: "software";
4729
5250
  };
5251
+ readonly preferred_name_definite_plural: {
5252
+ readonly nb: "programvaren";
5253
+ readonly nn: "programvaren";
5254
+ readonly en: "software";
5255
+ };
4730
5256
  readonly type: "expression_type";
4731
5257
  };
4732
5258
  readonly board_game: {
@@ -4740,11 +5266,21 @@ declare const cordataEnumExpressionTypeMap: {
4740
5266
  readonly comments: null;
4741
5267
  readonly domain: "cordata";
4742
5268
  readonly work_type: "interactive";
4743
- readonly preferred_plural_name: {
5269
+ readonly preferred_name_definite: {
5270
+ readonly nb: "brettspillet";
5271
+ readonly nn: "brettspillet";
5272
+ readonly en: "board game";
5273
+ };
5274
+ readonly preferred_name_plural: {
4744
5275
  readonly nb: "brettspill";
4745
5276
  readonly nn: "brettspel";
4746
5277
  readonly en: "board games";
4747
5278
  };
5279
+ readonly preferred_name_definite_plural: {
5280
+ readonly nb: "brettspillene";
5281
+ readonly nn: "brettspela";
5282
+ readonly en: "board games";
5283
+ };
4748
5284
  readonly type: "expression_type";
4749
5285
  };
4750
5286
  };
@@ -9509,4 +10045,4 @@ type BmdbSearchClient = Client<BmdbCordataApiV1Paths>;
9509
10045
  declare const createBmdbFetchClient: (options: BmdbSearchClientOptions) => BmdbSearchClient;
9510
10046
  //#endregion
9511
10047
  export { serializeCatalogueRecordId as C, serializeCatalogueId as E, parseCatalogueRecordId as S, parseCatalogueId as T, ParsedDigitalServiceRecordId as _, BmdbApiSchemas as a, CatalogueRecordId as b, isCordataEnumAgeGroupCode as c, isCordataEnumExpressionTypeCode as d, isCordataEnumLanguageCode as f, DigitalServiceRecordId as g, formatIsbdTitle as h, BmdbApiPaths as i, isCordataEnumAgeLimitCode as l, isCordataEnumWorkTypeCode as m, BmdbSearchClientOptions as n, BmdbCordataApiV1Paths as o, isCordataEnumManifestationMediumCode as p, createBmdbFetchClient as r, BmdbCordataApiV1Schemas as s, BmdbSearchClient as t, isCordataEnumContributorRoleCode as u, parseDigitalServiceRecordId as v, ParsedCatalogueId as w, ParsedCatalogueRecordId as x, serializeDigitalServiceRecordId as y };
9512
- //# sourceMappingURL=index-DqejK_yd.d.cts.map
10048
+ //# sourceMappingURL=index-CUQjKe2y.d.cts.map