@ndla/types-backend 0.2.94 → 0.2.96

package/build/draft-api.d.ts

@@ -1,4 +1,14 @@
 export type Availability = ("everyone" | "teacher");
+export declare enum DraftSortEnum {
+    ByRelevanceDesc = "-relevance",
+    ByRelevanceAsc = "relevance",
+    ByTitleDesc = "-title",
+    ByTitleAsc = "title",
+    ByLastUpdatedDesc = "-lastUpdated",
+    ByLastUpdatedAsc = "lastUpdated",
+    ByIdDesc = "-id",
+    ByIdAsc = "id"
+}
 export type Grade = (1 | 2 | 3 | 4 | 5);
 export interface IArticle {
     id: number;
@@ -53,6 +63,19 @@ export interface IArticleMetaImage {
     alt: string;
     language: string;
 }
+export interface IArticleSearchParams {
+    query?: string;
+    language?: string;
+    license?: string;
+    page?: number;
+    pageSize?: number;
+    ids?: number[];
+    articleTypes?: string[];
+    sort?: Sort;
+    scrollId?: string;
+    fallback?: boolean;
+    grepCodes?: string[];
+}
 export interface IArticleSummary {
     id: number;
     title: IArticleTitle;
@@ -256,5 +279,6 @@ export interface IVisualElement {
     visualElement: string;
     language: string;
 }
+export type Sort = DraftSortEnum;
 export type UpdateOrDeleteNewArticleMetaImage = (null | undefined | INewArticleMetaImage);
 export type UpdateOrDeleteString = (null | undefined | string);

package/build/draft-api.js

@@ -1,4 +1,16 @@
 "use strict";
 // DO NOT EDIT: generated file by scala-tsi
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DraftSortEnum = void 0;
+var DraftSortEnum;
+(function (DraftSortEnum) {
+    DraftSortEnum["ByRelevanceDesc"] = "-relevance";
+    DraftSortEnum["ByRelevanceAsc"] = "relevance";
+    DraftSortEnum["ByTitleDesc"] = "-title";
+    DraftSortEnum["ByTitleAsc"] = "title";
+    DraftSortEnum["ByLastUpdatedDesc"] = "-lastUpdated";
+    DraftSortEnum["ByLastUpdatedAsc"] = "lastUpdated";
+    DraftSortEnum["ByIdDesc"] = "-id";
+    DraftSortEnum["ByIdAsc"] = "id";
+})(DraftSortEnum || (exports.DraftSortEnum = DraftSortEnum = {}));
 //# sourceMappingURL=draft-api.js.map

package/build/draft-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"draft-api.js","sourceRoot":"","sources":["../draft-api.ts"],"names":[],"mappings":";AAAA,2CAA2C"}
+{"version":3,"file":"draft-api.js","sourceRoot":"","sources":["../draft-api.ts"],"names":[],"mappings":";AAAA,2CAA2C;;;AAI3C,IAAY,aASX;AATD,WAAY,aAAa;IACvB,+CAA8B,CAAA;IAC9B,6CAA4B,CAAA;IAC5B,uCAAsB,CAAA;IACtB,qCAAoB,CAAA;IACpB,mDAAkC,CAAA;IAClC,iDAAgC,CAAA;IAChC,iCAAgB,CAAA;IAChB,+BAAc,CAAA;AAChB,CAAC,EATW,aAAa,6BAAb,aAAa,QASxB"}

package/build/search-api.d.ts

@@ -214,6 +214,28 @@ export interface ISearchError {
     type: string;
     errorMsg: string;
 }
+export interface ISearchParams {
+    page?: number;
+    pageSize?: number;
+    articleTypes?: string[];
+    scrollId?: string;
+    query?: string;
+    fallback?: boolean;
+    language?: string;
+    license?: string;
+    ids?: number[];
+    subjects?: string[];
+    resourceTypes?: string[];
+    contextTypes?: string[];
+    relevance?: string[];
+    languageFilter?: string[];
+    grepCodes?: string[];
+    aggregatePaths?: string[];
+    embedResource?: string[];
+    embedId?: string;
+    filterInactive?: boolean;
+    sort?: string;
+}
 export interface ISearchSuggestion {
     text: string;
     offset: number;

package/build/search-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"search-api.js","sourceRoot":"","sources":["../search-api.ts"],"names":[],"mappings":";AAAA,2CAA2C;;;AA4S3C,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;;;AAmU3C,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": "0.2.94"
+    "version": "0.2.96"
 }