@ndla/types-backend 1.0.26 → 1.0.28

package/build/frontpage-api.d.ts

@@ -21,7 +21,7 @@ export interface IErrorBody {
     occurredAt: string;
     statusCode: number;
 }
-export interface IFilmFrontPageDataDTO {
+export interface IFilmFrontPageDTO {
     name: string;
     about: IAboutFilmSubjectDTO[];
     movieThemes: IMovieThemeDTO[];
@@ -56,7 +56,7 @@ export interface INewOrUpdatedAboutSubjectDTO {
     language: string;
     visualElement: INewOrUpdatedVisualElementDTO;
 }
-export interface INewOrUpdatedFilmFrontPageDataDTO {
+export interface INewOrUpdatedFilmFrontPageDTO {
     name: string;
     about: INewOrUpdatedAboutSubjectDTO[];
     movieThemes: INewOrUpdatedMovieThemeDTO[];
@@ -80,7 +80,7 @@ export interface INewOrUpdatedVisualElementDTO {
     id: string;
     alt?: string;
 }
-export interface INewSubjectFrontPageDataDTO {
+export interface INewSubjectPageDTO {
     name: string;
     externalId?: string;
     banner: INewOrUpdateBannerImageDTO;
@@ -91,7 +91,7 @@ export interface INewSubjectFrontPageDataDTO {
     buildsOn?: string[];
     leadsTo?: string[];
 }
-export interface ISubjectPageDataDTO {
+export interface ISubjectPageDTO {
     id: number;
     name: string;
     banner: IBannerImageDTO;
@@ -103,7 +103,7 @@ export interface ISubjectPageDataDTO {
     buildsOn: string[];
     leadsTo: string[];
 }
-export interface IUpdatedSubjectFrontPageDataDTO {
+export interface IUpdatedSubjectPageDTO {
     name?: string;
     externalId?: string;
     banner?: INewOrUpdateBannerImageDTO;

package/build/search-api.d.ts

@@ -174,7 +174,7 @@ export interface IGroupSearchResultDTO {
     page?: number;
     pageSize: number;
     language: string;
-    results: IMultiSearchSummaryDTO[];
+    results: MultiSummaryBaseDTO[];
     suggestions: IMultiSearchSuggestionDTO[];
     aggregations: IMultiSearchTermsAggregationDTO[];
     resourceType: string;
@@ -235,7 +235,7 @@ export interface IMultiSearchResultDTO {
     page?: number;
     pageSize: number;
     language: string;
-    results: IMultiSearchSummaryDTO[];
+    results: MultiSummaryBaseDTO[];
     suggestions: IMultiSearchSuggestionDTO[];
     aggregations: IMultiSearchTermsAggregationDTO[];
 }
@@ -271,6 +271,7 @@ export interface IMultiSearchSummaryDTO {
     published?: string;
     favorited?: number;
     resultType: SearchType;
+    typename: "MultiSearchSummaryDTO";
 }
 export interface IMultiSearchTermsAggregationDTO {
     field: string;
@@ -278,11 +279,30 @@ export interface IMultiSearchTermsAggregationDTO {
     docCountErrorUpperBound: number;
     values: ITermValueDTO[];
 }
+export interface INODE {
+    typename: "NODE";
+}
+export interface INodeHitDTO {
+    id: string;
+    title: string;
+    url?: string;
+    subjectPage?: ISubjectPageSummaryDTO;
+    typename: "NodeHitDTO";
+}
+export interface IPROGRAMME {
+    typename: "PROGRAMME";
+}
+export interface IRESOURCE {
+    typename: "RESOURCE";
+}
 export interface IRevisionMetaDTO {
     revisionDate: string;
     note: string;
     status: string;
 }
+export interface ISUBJECT {
+    typename: "SUBJECT";
+}
 export interface ISearchParamsDTO {
     page?: number;
     pageSize?: number;
@@ -304,6 +324,8 @@ export interface ISearchParamsDTO {
     embedResource?: string[];
     embedId?: string;
     filterInactive?: boolean;
+    resultTypes?: SearchType[];
+    nodeTypeFilter?: NodeType[];
     sort?: string;
 }
 export interface ISearchSuggestionDTO {
@@ -330,10 +352,18 @@ export interface ISubjectAggregationsDTO {
 export interface ISubjectAggsInputDTO {
     subjects?: string[];
 }
+export interface ISubjectPageSummaryDTO {
+    id: number;
+    name: string;
+    metaDescription: IMetaDescriptionDTO;
+}
 export interface ISuggestOptionDTO {
     text: string;
     score: number;
 }
+export interface ITOPIC {
+    typename: "TOPIC";
+}
 export interface ITaxonomyResourceTypeDTO {
     id: string;
     name: string;
@@ -353,8 +383,10 @@ export interface ITitleWithHtmlDTO {
     language: string;
 }
 export type LearningResourceType = ("standard" | "topic-article" | "frontpage-article" | "learningpath" | "concept" | "gloss");
+export type MultiSummaryBaseDTO = (IMultiSearchSummaryDTO | INodeHitDTO);
+export type NodeType = (ISUBJECT | IRESOURCE | INODE | IPROGRAMME | ITOPIC);
 export type SearchTrait = ("VIDEO" | "H5P" | "AUDIO" | "PODCAST");
-export type SearchType = ("article" | "draft" | "learningpath" | "concept" | "grep");
+export type SearchType = ("article" | "draft" | "learningpath" | "concept" | "grep" | "node");
 export type Sort = SortEnum;
 export declare enum SortEnum {
     ByRelevanceDesc = "-relevance",

package/build/search-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"search-api.js","sourceRoot":"","sources":["../search-api.ts"],"names":[],"mappings":";AAAA,2CAA2C;;;AA6Z3C,IAAY,QA6BX;AA7BD,WAAY,QAAQ;IAClB,0CAA8B,CAAA;IAC9B,wCAA4B,CAAA;IAC5B,kCAAsB,CAAA;IACtB,gCAAoB,CAAA;IACpB,8CAAkC,CAAA;IAClC,4CAAgC,CAAA;IAChC,4BAAgB,CAAA;IAChB,0BAAc,CAAA;IACd,wCAA4B,CAAA;IAC5B,sCAA0B,CAAA;IAC1B,8CAAkC,CAAA;IAClC,gDAAoC,CAAA;IACpC,kEAAsD,CAAA;IACtD,oEAAwD,CAAA;IACxD,kCAAsB,CAAA;IACtB,oCAAwB,CAAA;IACxB,8CAAkC,CAAA;IAClC,4CAAgC,CAAA;IAChC,sDAA0C,CAAA;IAC1C,oDAAwC,CAAA;IACxC,8CAAkC,CAAA;IAClC,4CAAgC,CAAA;IAChC,gDAAoC,CAAA;IACpC,8CAAkC,CAAA;IAClC,0CAA8B,CAAA;IAC9B,wCAA4B,CAAA;IAC5B,0CAA8B,CAAA;IAC9B,wCAA4B,CAAA;AAC9B,CAAC,EA7BW,QAAQ,wBAAR,QAAQ,QA6BnB"}
+{"version":3,"file":"search-api.js","sourceRoot":"","sources":["../search-api.ts"],"names":[],"mappings":";AAAA,2CAA2C;;;AAsc3C,IAAY,QA6BX;AA7BD,WAAY,QAAQ;IAClB,0CAA8B,CAAA;IAC9B,wCAA4B,CAAA;IAC5B,kCAAsB,CAAA;IACtB,gCAAoB,CAAA;IACpB,8CAAkC,CAAA;IAClC,4CAAgC,CAAA;IAChC,4BAAgB,CAAA;IAChB,0BAAc,CAAA;IACd,wCAA4B,CAAA;IAC5B,sCAA0B,CAAA;IAC1B,8CAAkC,CAAA;IAClC,gDAAoC,CAAA;IACpC,kEAAsD,CAAA;IACtD,oEAAwD,CAAA;IACxD,kCAAsB,CAAA;IACtB,oCAAwB,CAAA;IACxB,8CAAkC,CAAA;IAClC,4CAAgC,CAAA;IAChC,sDAA0C,CAAA;IAC1C,oDAAwC,CAAA;IACxC,8CAAkC,CAAA;IAClC,4CAAgC,CAAA;IAChC,gDAAoC,CAAA;IACpC,8CAAkC,CAAA;IAClC,0CAA8B,CAAA;IAC9B,wCAA4B,CAAA;IAC5B,0CAA8B,CAAA;IAC9B,wCAA4B,CAAA;AAC9B,CAAC,EA7BW,QAAQ,wBAAR,QAAQ,QA6BnB"}

package/package.json

@@ -27,5 +27,5 @@
     "devDependencies": {
         "typescript": "^5.3.3"
     },
-    "version": "1.0.26"
+    "version": "1.0.28"
 }