@internetarchive/search-service - npm Package Compare versions

Comparing version 1.2.5-alpha.0 to 1.2.5-alpha.1

dist/src/responses/search-response-details.d.ts

@@ -5,2 +5,4 @@ import { Aggregation } from '../models/aggregation';
 import type { SearchHitSchema } from './search-hit-schema';
+import { AccountExtraInfo } from './account-extra-info';
+import { PageElementMap, SearchResponseHits } from './page-elements';
 /**
@@ -10,16 +12,10 @@ * The structure of the response body returned from the PPS endpoint.
 export interface SearchResponseBody {
-    hits: SearchResponseHits;
+    hits?: SearchResponseHits;
     aggregations?: Record<string, Aggregation>;
     collection_titles?: Record<string, string>;
     collection_extra_info?: CollectionExtraInfo;
+    account_extra_info?: AccountExtraInfo;
+    page_elements?: PageElementMap;
 }
 /**
- * The structure of the response body `hits` object returned from the PPS endpoint.
- */
-export interface SearchResponseHits {
-    total: number;
-    returned: number;
-    hits: Record<string, any>[];
-}
-/**
  * This is the search response details inside the SearchResponse object that contains
@@ -61,2 +57,11 @@ * the search results, under the `results` key.
     /**
+     * Extra info about the target account, returned when the page type is
+     * `account_details`.
+     */
+    accountExtraInfo?: AccountExtraInfo;
+    /**
+     * Specific page elements requested from the PPS will be present in this map
+     */
+    pageElements?: PageElementMap;
+    /**
      * The hit schema for this response
@@ -63,0 +68,0 @@ */

dist/src/responses/search-response-details.js

@@ -34,2 +34,8 @@ /* eslint-disable @typescript-eslint/no-explicit-any */
         }
+        if (body === null || body === void 0 ? void 0 : body.account_extra_info) {
+            this.accountExtraInfo = body.account_extra_info;
+        }
+        if (body === null || body === void 0 ? void 0 : body.page_elements) {
+            this.pageElements = body.page_elements;
+        }
     }
@@ -36,0 +42,0 @@ /**

package.json

 {
   "name": "@internetarchive/search-service",
-  "version": "1.2.5-alpha.0",
+  "version": "1.2.5-alpha.1",
   "description": "A search service for the Internet Archive",
@@ -5,0 +5,0 @@ "license": "AGPL-3.0-only",

src/models/hit-types/item-hit.ts

@@ -0,0 +0,0 @@ /* eslint-disable @typescript-eslint/no-explicit-any */

src/responses/search-response-details.ts

@@ -9,2 +9,4 @@ /* eslint-disable @typescript-eslint/no-explicit-any */
 import type { SearchHitSchema } from './search-hit-schema';
+import { AccountExtraInfo } from './account-extra-info';
+import { PageElementMap, SearchResponseHits } from './page-elements';
 
@@ -15,18 +17,11 @@ /**
 export interface SearchResponseBody {
-  hits: SearchResponseHits;
+  hits?: SearchResponseHits;
   aggregations?: Record<string, Aggregation>;
   collection_titles?: Record<string, string>;
   collection_extra_info?: CollectionExtraInfo;
+  account_extra_info?: AccountExtraInfo;
+  page_elements?: PageElementMap;
 }
 
 /**
- * The structure of the response body `hits` object returned from the PPS endpoint.
- */
-export interface SearchResponseHits {
-  total: number;
-  returned: number;
-  hits: Record<string, any>[];
-}
-
-/**
  * This is the search response details inside the SearchResponse object that contains
@@ -74,2 +69,13 @@ * the search results, under the `results` key.
   /**
+   * Extra info about the target account, returned when the page type is
+   * `account_details`.
+   */
+  accountExtraInfo?: AccountExtraInfo;
+
+  /**
+   * Specific page elements requested from the PPS will be present in this map
+   */
+  pageElements?: PageElementMap;
+
+  /**
    * The hit schema for this response
@@ -108,2 +114,10 @@ */
     }
+
+    if (body?.account_extra_info) {
+      this.accountExtraInfo = body.account_extra_info;
+    }
+
+    if (body?.page_elements) {
+      this.pageElements = body.page_elements;
+    }
   }
@@ -110,0 +124,0 @@

src/search-backend/base-search-backend.ts

@@ -0,0 +0,0 @@ /* eslint-disable @typescript-eslint/no-explicit-any */

src/search-params.ts

@@ -156,4 +156,3 @@ export interface AggregateSearchParam {
   | 'collection_details'
-  | 'account_details'
-  ;
+  | 'account_details';
 
@@ -160,0 +159,0 @@ /**

test/search-backend/fulltext-search-backend.test.ts

@@ -0,0 +0,0 @@ /* eslint-disable @typescript-eslint/no-unused-vars */

test/search-backend/metadata-search-backend.test.ts

@@ -0,0 +0,0 @@ /* eslint-disable @typescript-eslint/no-unused-vars */

No alert changes

Improved metrics

Total package byte prevSize

914590

increased by0.84%

Number of package files

254

increased by3.25%

Lines of code

13047

increased by1.79%

No dependency changes