@attraqt/search - npm Package Compare versions

Comparing version 1.6.0 to 1.7.0

dist/models/index.d.ts

@@ -0,2 +1,3 @@
+export * from './autocomplete';
 export * from './search';
 export * from './suggest';

dist/models/search.d.ts

@@ -1,11 +0,14 @@
-import { FacetRequestOptions as FacetRequestOptionsCommons, SearchOptions as SearchOptionsCommons, SearchRequest as SearchRequestCommons, SearchContext as SearchContextCommons } from '@attraqt/search-commons';
+import { FacetRequestOptions as FacetRequestOptionsCommons, SearchItemOptions as SearchItemOptionsCommons, SearchRequest as SearchRequestCommons, SearchContext as SearchContextCommons, SearchGroupOptions as SearchGroupOptionsCommons } from '@attraqt/search-commons';
 declare type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 export declare type SearchContext = Partial<SearchContextCommons>;
 export declare type FacetRequestOptions = PartialBy<PartialBy<FacetRequestOptionsCommons, 'attribute'>, 'id'>;
-export declare type SearchOptions = Omit<Partial<SearchOptionsCommons>, 'facets'> & {
+export declare type SearchItemOptions = Omit<Partial<SearchItemOptionsCommons>, 'facets'> & {
     facets?: FacetRequestOptions[];
 };
+export declare type SearchGroupOptions = Partial<SearchGroupOptionsCommons>;
+/** @deprecated Use `SearchItemOptions` instead */
+export declare type SearchOptions = SearchItemOptions;
 export declare type SearchRequest = Omit<SearchRequestCommons, 'options'> & {
-    options?: SearchOptions;
+    options?: SearchItemOptions;
 };
-export { DisableOptions, SortOptions, SearchResponseProduct, SearchResponseRedirectItem, SearchResponseItem, SearchResponseMetadata_Facet_Value, SearchResponseMetadata_Facet, SearchResponseMetadata, SearchResponse } from '@attraqt/search-commons';
+export { DisableOptions, GroupByOptions, SortOptions, SearchResponseGroup, SearchResponseProduct, SearchResponseRedirectItem, SearchResponseItem, SearchResponseMetadata_Facet_Value, SearchResponseMetadata_Facet, SearchResponseMetadata, SearchResponse } from '@attraqt/search-commons';

dist/models/suggest.d.ts

@@ -1,6 +0,22 @@
-import { ProductSuggestOptions as ProductSuggestOptionsCommons, ProductSuggestRequest as ProductSuggestRequestCommons } from '@attraqt/search-commons';
-export declare type ProductSuggestOptions = Partial<ProductSuggestOptionsCommons>;
-export declare type ProductSuggestRequest = Omit<ProductSuggestRequestCommons, 'options'> & {
-    options: ProductSuggestOptions;
-};
-export { GroupOptions, ProductSuggestMetadata, ProductSuggestResponse_Group, ProductSuggestResponse } from '@attraqt/search-commons';
+import { SearchResponseMetadata as SearchResponseMetadataCommons, SearchResponseGroup, SearchContext, GroupByOptions } from '@attraqt/search-commons';
+import { SearchGroupOptions } from './search';
+/** @deprecated Use `SearchGroupOptions` instead */
+export declare type ProductSuggestOptions = SearchGroupOptions;
+/** @deprecated Use `SearchResponseMetadata` instead */
+export declare type ProductSuggestMetadata = Omit<SearchResponseMetadataCommons, 'facets'>;
+/** @deprecated Use `GroupByOptions` instead */
+export declare type GroupOptions = GroupByOptions;
+/** @deprecated Use `SearchResponseGroup` instead */
+export declare type ProductSuggestResponse_Group = SearchResponseGroup;
+/** @deprecated Use `SearchRequest` instead */
+export interface ProductSuggestRequest {
+    token: string;
+    query: string;
+    options?: SearchGroupOptions;
+    context?: SearchContext;
+}
+/** @deprecated Use `SearchResponse` instead */
+export interface ProductSuggestResponse {
+    metadata?: ProductSuggestMetadata;
+    groups: SearchResponseGroup[];
+}

dist/search.d.ts

 import { HttpClient } from '@attraqt/http-client-common';
-import { ProductSuggestOptions, SearchContext, SearchOptions, SearchResponse } from './models';
+import { AutocompleteOptions, SearchContext, SearchGroupOptions, SearchItemOptions, SearchResponse } from './models';
 /**
@@ -14,4 +14,5 @@ * Search module.
     init(options: SearchInitOptions, httpClient?: HttpClient): void;
-    query(query: string, options?: SearchOptions, requestOptions?: SearchRequestOptions, context?: SearchContext): Promise<SearchResponse>;
-    suggest(query: string, options?: ProductSuggestOptions, requestOptions?: SearchRequestOptions, context?: SearchContext): Promise<SearchResponse>;
+    query(query: string, options?: SearchItemOptions, requestOptions?: SearchRequestOptions, context?: SearchContext): Promise<SearchResponse>;
+    suggest(query: string, options?: SearchGroupOptions, requestOptions?: SearchRequestOptions, context?: SearchContext): Promise<SearchResponse>;
+    autocomplete(query: string, options?: AutocompleteOptions, requestOptions?: SearchRequestOptions): Promise<SearchResponse>;
     private sendRequest;
@@ -18,0 +19,0 @@ private assertIsInit;

dist/search.js

@@ -54,5 +54,6 @@ "use strict";
 var http_client_common_1 = require("@attraqt/http-client-common");
-var validateSearchOptionsSchema_1 = __importDefault(require("./models/validateSearchOptionsSchema"));
+var validateSearchItemOptionsSchema_1 = __importDefault(require("./models/validateSearchItemOptionsSchema"));
+var validateSearchGroupOptionsSchema_1 = __importDefault(require("./models/validateSearchGroupOptionsSchema"));
 var validateSearchContextSchema_1 = __importDefault(require("./models/validateSearchContextSchema"));
-var validateSuggestOptionsSchema_1 = __importDefault(require("./models/validateSuggestOptionsSchema"));
+var validateAutocompleteOptionsSchema_1 = __importDefault(require("./models/validateAutocompleteOptionsSchema"));
 /**
@@ -80,3 +81,3 @@ * Search module.
                 this.assertIsInit();
-                if (options && !validateSearchOptionsSchema_1.default(options)) {
+                if (options && !validateSearchItemOptionsSchema_1.default(options)) {
                     throw Error("The provided search options doesn't match the required format.");
@@ -95,4 +96,4 @@ }
                 this.assertIsInit();
-                if (options && !validateSuggestOptionsSchema_1.default(options)) {
-                    throw Error("The provided suggest options don't match the required format.");
+                if (options && !validateSearchGroupOptionsSchema_1.default(options)) {
+                    throw Error("The provided group options don't match the required format.");
                 }
@@ -106,2 +107,13 @@ if (context && !validateSearchContextSchema_1.default(context)) {
     };
+    Search.prototype.autocomplete = function (query, options, requestOptions) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                this.assertIsInit();
+                if (options && !validateAutocompleteOptionsSchema_1.default(options)) {
+                    throw Error("The provided autocomplete options don't match the required format.");
+                }
+                return [2 /*return*/, this.sendRequest('/search/autocomplete', query, options, undefined, requestOptions)];
+            });
+        });
+    };
     Search.prototype.sendRequest = function (path, query, options, context, requestOptions) {
@@ -108,0 +120,0 @@ return __awaiter(this, void 0, void 0, function () {

package.json

 {
   "name": "@attraqt/search",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "license": "MIT",
@@ -17,10 +17,12 @@ "repository": "git://github.com:Attraqt/attraqt-js.git",
   "scripts": {
-    "generate-json-schemas-search-options": "typescript-json-schema ./src/models/search.ts SearchOptions --out ./src/models/search-options.schema.json --required --noExtraProps",
+    "generate-json-schemas-search-item-options": "typescript-json-schema ./src/models/search.ts SearchItemOptions --out ./src/models/search-item-options.schema.json --required --noExtraProps",
+    "generate-json-schemas-search-group-options": "typescript-json-schema ./src/models/search.ts SearchGroupOptions --out ./src/models/search-group-options.schema.json --required --noExtraProps",
     "generate-json-schemas-search-context": "typescript-json-schema ./src/models/search.ts SearchContext --out ./src/models/search-context.schema.json --required --noExtraProps",
-    "generate-json-schemas-suggest-options": "typescript-json-schema ./src/models/suggest.ts ProductSuggestOptions --out ./src/models/suggest-options.schema.json --required --noExtraProps",
-    "generate-json-schemas": "npm run generate-json-schemas-search-options && npm run generate-json-schemas-search-context && npm run generate-json-schemas-suggest-options",
-    "generate-validation-search-options": "ajv compile -s ./src/models/search-options.schema.json -o ./src/models/validateSearchOptionsSchema.js --strict=true --all-errors --verbose --comment --code-es5 --allow-union-types",
+    "generate-json-schemas-autocomplete": "typescript-json-schema ./src/models/autocomplete.ts AutocompleteOptions --out ./src/models/autocomplete-options.schema.json --required --noExtraProps",
+    "generate-json-schemas": "npm run generate-json-schemas-search-item-options && npm run generate-json-schemas-search-group-options && npm run generate-json-schemas-search-context && npm run generate-json-schemas-autocomplete",
+    "generate-validation-search-item-options": "ajv compile -s ./src/models/search-item-options.schema.json -o ./src/models/validateSearchItemOptionsSchema.js --strict=true --all-errors --verbose --comment --code-es5 --allow-union-types",
+    "generate-validation-search-group-options": "ajv compile -s ./src/models/search-group-options.schema.json -o ./src/models/validateSearchGroupOptionsSchema.js --strict=true --all-errors --verbose --comment --code-es5 --allow-union-types",
     "generate-validation-search-context": "ajv compile -s ./src/models/search-context.schema.json -o ./src/models/validateSearchContextSchema.js --strict=true --all-errors --verbose --comment --code-es5 --allow-union-types",
-    "generate-validation-suggest-options": "ajv compile -s ./src/models/suggest-options.schema.json -o ./src/models/validateSuggestOptionsSchema.js --strict=true --all-errors --verbose --comment --code-es5 --allow-union-types",
-    "generate-validation": "npm run generate-validation-search-options && npm run generate-validation-search-context && npm run generate-validation-suggest-options",
+    "generate-validation-autocomplete": "ajv compile -s ./src/models/autocomplete-options.schema.json -o ./src/models/validateAutocompleteOptionsSchema.js --strict=true --all-errors --verbose --comment --code-es5 --allow-union-types",
+    "generate-validation": "npm run generate-validation-search-item-options && npm run generate-validation-search-group-options && npm run generate-validation-search-context && npm run generate-validation-autocomplete",
     "copy-json-schemas": "cp ./src/models/*.schema.json ./dist/models",
@@ -35,16 +37,17 @@ "build": "npm run generate-json-schemas && npm run generate-validation && npm run clean && npm run compile && npm run copy-json-schemas",
   "dependencies": {
-    "@attraqt/http-client-browser": "^1.5.1",
+    "@attraqt/http-client-browser": "^1.7.0",
     "@attraqt/http-client-common": "^1.5.1",
-    "@attraqt/http-client-node": "^1.5.1",
-    "@attraqt/search-commons": "1.11.0"
+    "@attraqt/http-client-node": "^1.7.0",
+    "@attraqt/search-commons": "2.0.0"
   },
   "devDependencies": {
-    "ajv": "^8.0.5",
-    "ajv-cli": "^5.0.0",
-    "jest": "^24.9.0",
-    "jest-fetch-mock": "^3.0.3",
+    "@types/babel__traverse": "7.18.2",
+    "ajv": "8.0.5",
+    "ajv-cli": "5.0.0",
+    "jest": "24.9.0",
+    "jest-fetch-mock": "3.0.3",
     "typescript": "3.8.3",
-    "typescript-json-schema": "^0.42.0"
+    "typescript-json-schema": "0.42.0"
   },
-  "gitHead": "d04411f25d312dd80584c25468d7df5b6edb7d64"
+  "gitHead": "3d491dc40199ac3fa205923163b0cf964473378e"
 }

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

156267

increased by31.93%

Number of package files

46

increased by27.78%

Lines of code

1734

increased by29.69%

Worsened metrics

Dev dependency count

7

increased by16.67%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@attraqt/search-commons@2.0.0(transitive)

• - Removed@attraqt/search-commons@1.11.0(transitive)

• Updated@attraqt/http-client-browser@^1.7.0

• Updated@attraqt/http-client-node@^1.7.0

• Updated@attraqt/search-commons@2.0.0