@attraqt/search-commons - npm Package Compare versions

Comparing version 1.12.0 to 2.0.0

com/attraqt/search/protobuf/search.ts

 /* eslint-disable */
+
 export interface SortOptions {
@@ -42,5 +43,9 @@ /** Attribute to sort by */
   /** Pagination: index of the first item to return */
-  offset?: number | undefined;
+  offset?:
+    | number
+    | undefined;
   /** Pagination: size of the page */
-  limit?: number | undefined;
+  limit?:
+    | number
+    | undefined;
   /**
@@ -57,3 +62,5 @@ * List of sorting rules
   /** Filter string */
-  filter?: string | undefined;
+  filter?:
+    | string
+    | undefined;
   /**
@@ -66,3 +73,5 @@ * DEPRECATED: top-level `disable` feature should be used instead
   /** Response mask to return only specific attributes of items */
-  customResponseMask?: string | undefined;
+  customResponseMask?:
+    | string
+    | undefined;
   /**
@@ -84,3 +93,5 @@ * Toggle AI Search "on" or "off".
   /** Filter string */
-  filter?: string | undefined;
+  filter?:
+    | string
+    | undefined;
   /**
@@ -90,3 +101,5 @@ * Select which attribute & values for grouping the results.
    */
-  groupBy?: GroupByOptions | undefined;
+  groupBy?:
+    | GroupByOptions
+    | undefined;
   /** Response mask to return only specific attributes of items */
@@ -134,3 +147,5 @@ customResponseMask?: string | undefined;
    */
-  options?: SearchItemOptions | undefined;
+  options?:
+    | SearchItemOptions
+    | undefined;
   /**
@@ -140,9 +155,17 @@ * Context of the search request.
    */
-  context?: SearchContext | undefined;
+  context?:
+    | SearchContext
+    | undefined;
   /** Search options for items search. To control grouping, use `group_options` instead. */
-  itemOptions?: SearchItemOptions | undefined;
+  itemOptions?:
+    | SearchItemOptions
+    | undefined;
   /** Search options for grouping search. If omitted, no groups will be returned, only items. */
-  groupOptions?: SearchGroupOptions | undefined;
+  groupOptions?:
+    | SearchGroupOptions
+    | undefined;
   /** If specified, this configuration will be used instead of the default configuration set for the tenant */
-  configurationId?: string | undefined;
+  configurationId?:
+    | string
+    | undefined;
   /** Disable some search features. */
@@ -184,3 +207,5 @@ disable: DisableOptions[];
    */
-  product?: SearchResponseProduct | undefined;
+  product?:
+    | SearchResponseProduct
+    | undefined;
   /** If specified, it's a "redirect" item. */
@@ -203,3 +228,5 @@ redirect?: SearchResponseRedirectItem | undefined;
    */
-  count?: number | undefined;
+  count?:
+    | number
+    | undefined;
   /** Duration of the request */
@@ -215,3 +242,5 @@ time: number;
    */
-  offset?: number | undefined;
+  offset?:
+    | number
+    | undefined;
   /**
@@ -221,3 +250,5 @@ * Pagination: size of the page
    */
-  limit?: number | undefined;
+  limit?:
+    | number
+    | undefined;
   /**
@@ -234,3 +265,5 @@ * List of facets (and their values) found for the query
    */
-  exactCount?: boolean | undefined;
+  exactCount?:
+    | boolean
+    | undefined;
   /** Search configuration id */
@@ -277,1 +310,54 @@ configurationId: string;
 }
+
+export interface AutocompleteOptions {
+  /** Filter string */
+  filter?:
+    | string
+    | undefined;
+  /** Number of suggestions to be returned */
+  numberOfSuggestions?: number | undefined;
+}
+
+export interface AutocompleteRequest {
+  /** Search token, used by the client to authenticate himself */
+  token: string;
+  /** Text query */
+  query: string;
+  /** Suggest options */
+  options?: AutocompleteOptions;
+  /** If specified, this configuration will be used instead of the default configuration set for the tenant */
+  configurationId?:
+    | string
+    | undefined;
+  /** Disable some search features */
+  disable: DisableOptions[];
+}
+
+export interface AutocompleteResponseMetadata {
+  /** Number of suggestions matching the query */
+  count: number;
+  /** Duration of the request */
+  time: number;
+  /** Token used for the request */
+  token: string;
+  /** Unique id of the response */
+  id: string;
+  /** Search configuration id */
+  configurationId: string;
+  /** Default search configuration id. May be different from the one used for this query */
+  defaultConfigurationId: string;
+}
+
+export interface Suggestion {
+  /** Suggestion */
+  suggestion: string;
+  /** Number of items matching this value */
+  count?: number | undefined;
+}
+
+export interface AutocompleteResponse {
+  /** List of suggestions found */
+  suggestions: Suggestion[];
+  /** Response metadata */
+  metadata?: AutocompleteResponseMetadata;
+}

index.d.ts

@@ -1,2 +0,1 @@
-export * from './com/attraqt/search/protobuf/search';
-export * from './com/attraqt/search/protobuf/product_suggest';
+export * from './com/attraqt/search/protobuf/search';

package.json

 {
   "name": "@attraqt/search-commons",
   "description": "Typescript generated code for the search API definition",
-  "version": "1.12.0",
+  "version": "2.0.0",
   "author": "[e-mail]",
   "types": "index.d.ts"
 }

No alert changes

Improved metrics

Lines of code

327

increased by7.57%

Worsened metrics

Total package byte prevSize

9115

decreased by-0.56%

Number of package files

3

decreased by-25%

No dependency changes