@searchspring/snap-client 0.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (129) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +174 -0
  3. package/dist/cjs/Client/Client.d.ts +15 -0
  4. package/dist/cjs/Client/Client.d.ts.map +1 -0
  5. package/dist/cjs/Client/Client.js +198 -0
  6. package/dist/cjs/Client/NetworkCache/NetworkCache.d.ts +10 -0
  7. package/dist/cjs/Client/NetworkCache/NetworkCache.d.ts.map +1 -0
  8. package/dist/cjs/Client/NetworkCache/NetworkCache.js +104 -0
  9. package/dist/cjs/Client/apis/Abstract.d.ts +49 -0
  10. package/dist/cjs/Client/apis/Abstract.d.ts.map +1 -0
  11. package/dist/cjs/Client/apis/Abstract.js +209 -0
  12. package/dist/cjs/Client/apis/Hybrid.d.ts +10 -0
  13. package/dist/cjs/Client/apis/Hybrid.d.ts.map +1 -0
  14. package/dist/cjs/Client/apis/Hybrid.js +137 -0
  15. package/dist/cjs/Client/apis/Legacy.d.ts +11 -0
  16. package/dist/cjs/Client/apis/Legacy.d.ts.map +1 -0
  17. package/dist/cjs/Client/apis/Legacy.js +147 -0
  18. package/dist/cjs/Client/apis/Recommend.d.ts +81 -0
  19. package/dist/cjs/Client/apis/Recommend.d.ts.map +1 -0
  20. package/dist/cjs/Client/apis/Recommend.js +222 -0
  21. package/dist/cjs/Client/apis/Snap.d.ts +8 -0
  22. package/dist/cjs/Client/apis/Snap.d.ts.map +1 -0
  23. package/dist/cjs/Client/apis/Snap.js +126 -0
  24. package/dist/cjs/Client/apis/Suggest.d.ts +45 -0
  25. package/dist/cjs/Client/apis/Suggest.d.ts.map +1 -0
  26. package/dist/cjs/Client/apis/Suggest.js +145 -0
  27. package/dist/cjs/Client/apis/index.d.ts +7 -0
  28. package/dist/cjs/Client/apis/index.d.ts.map +1 -0
  29. package/dist/cjs/Client/apis/index.js +18 -0
  30. package/dist/cjs/Client/transforms/index.d.ts +4 -0
  31. package/dist/cjs/Client/transforms/index.d.ts.map +1 -0
  32. package/dist/cjs/Client/transforms/index.js +15 -0
  33. package/dist/cjs/Client/transforms/searchRequest.d.ts +47 -0
  34. package/dist/cjs/Client/transforms/searchRequest.d.ts.map +1 -0
  35. package/dist/cjs/Client/transforms/searchRequest.js +151 -0
  36. package/dist/cjs/Client/transforms/searchResponse.d.ts +31 -0
  37. package/dist/cjs/Client/transforms/searchResponse.d.ts.map +1 -0
  38. package/dist/cjs/Client/transforms/searchResponse.js +246 -0
  39. package/dist/cjs/Client/transforms/suggestResponse.d.ts +29 -0
  40. package/dist/cjs/Client/transforms/suggestResponse.d.ts.map +1 -0
  41. package/dist/cjs/Client/transforms/suggestResponse.js +53 -0
  42. package/dist/cjs/Client/utils/charsParams.d.ts +3 -0
  43. package/dist/cjs/Client/utils/charsParams.d.ts.map +1 -0
  44. package/dist/cjs/Client/utils/charsParams.js +23 -0
  45. package/dist/cjs/Client/utils/fibonacci.d.ts +2 -0
  46. package/dist/cjs/Client/utils/fibonacci.d.ts.map +1 -0
  47. package/dist/cjs/Client/utils/fibonacci.js +14 -0
  48. package/dist/cjs/Client/utils/hashParams.d.ts +3 -0
  49. package/dist/cjs/Client/utils/hashParams.d.ts.map +1 -0
  50. package/dist/cjs/Client/utils/hashParams.js +10 -0
  51. package/dist/cjs/Client/utils/htmlUnescape.d.ts +2 -0
  52. package/dist/cjs/Client/utils/htmlUnescape.d.ts.map +1 -0
  53. package/dist/cjs/Client/utils/htmlUnescape.js +12 -0
  54. package/dist/cjs/Client/utils/index.d.ts +2 -0
  55. package/dist/cjs/Client/utils/index.d.ts.map +1 -0
  56. package/dist/cjs/Client/utils/index.js +13 -0
  57. package/dist/cjs/Client/utils/mergeParams.d.ts +2 -0
  58. package/dist/cjs/Client/utils/mergeParams.d.ts.map +1 -0
  59. package/dist/cjs/Client/utils/mergeParams.js +18 -0
  60. package/dist/cjs/index.d.ts +3 -0
  61. package/dist/cjs/index.d.ts.map +1 -0
  62. package/dist/cjs/index.js +13 -0
  63. package/dist/cjs/types.d.ts +45 -0
  64. package/dist/cjs/types.d.ts.map +1 -0
  65. package/dist/cjs/types.js +2 -0
  66. package/dist/esm/Client/Client.d.ts +15 -0
  67. package/dist/esm/Client/Client.d.ts.map +1 -0
  68. package/dist/esm/Client/Client.js +108 -0
  69. package/dist/esm/Client/NetworkCache/NetworkCache.d.ts +10 -0
  70. package/dist/esm/Client/NetworkCache/NetworkCache.d.ts.map +1 -0
  71. package/dist/esm/Client/NetworkCache/NetworkCache.js +89 -0
  72. package/dist/esm/Client/apis/Abstract.d.ts +49 -0
  73. package/dist/esm/Client/apis/Abstract.d.ts.map +1 -0
  74. package/dist/esm/Client/apis/Abstract.js +119 -0
  75. package/dist/esm/Client/apis/Hybrid.d.ts +10 -0
  76. package/dist/esm/Client/apis/Hybrid.d.ts.map +1 -0
  77. package/dist/esm/Client/apis/Hybrid.js +49 -0
  78. package/dist/esm/Client/apis/Legacy.d.ts +11 -0
  79. package/dist/esm/Client/apis/Legacy.d.ts.map +1 -0
  80. package/dist/esm/Client/apis/Legacy.js +44 -0
  81. package/dist/esm/Client/apis/Recommend.d.ts +81 -0
  82. package/dist/esm/Client/apis/Recommend.d.ts.map +1 -0
  83. package/dist/esm/Client/apis/Recommend.js +91 -0
  84. package/dist/esm/Client/apis/Snap.d.ts +8 -0
  85. package/dist/esm/Client/apis/Snap.d.ts.map +1 -0
  86. package/dist/esm/Client/apis/Snap.js +36 -0
  87. package/dist/esm/Client/apis/Suggest.d.ts +45 -0
  88. package/dist/esm/Client/apis/Suggest.d.ts.map +1 -0
  89. package/dist/esm/Client/apis/Suggest.js +45 -0
  90. package/dist/esm/Client/apis/index.d.ts +7 -0
  91. package/dist/esm/Client/apis/index.d.ts.map +1 -0
  92. package/dist/esm/Client/apis/index.js +6 -0
  93. package/dist/esm/Client/transforms/index.d.ts +4 -0
  94. package/dist/esm/Client/transforms/index.d.ts.map +1 -0
  95. package/dist/esm/Client/transforms/index.js +3 -0
  96. package/dist/esm/Client/transforms/searchRequest.d.ts +47 -0
  97. package/dist/esm/Client/transforms/searchRequest.d.ts.map +1 -0
  98. package/dist/esm/Client/transforms/searchRequest.js +133 -0
  99. package/dist/esm/Client/transforms/searchResponse.d.ts +31 -0
  100. package/dist/esm/Client/transforms/searchResponse.d.ts.map +1 -0
  101. package/dist/esm/Client/transforms/searchResponse.js +249 -0
  102. package/dist/esm/Client/transforms/suggestResponse.d.ts +29 -0
  103. package/dist/esm/Client/transforms/suggestResponse.d.ts.map +1 -0
  104. package/dist/esm/Client/transforms/suggestResponse.js +42 -0
  105. package/dist/esm/Client/utils/charsParams.d.ts +3 -0
  106. package/dist/esm/Client/utils/charsParams.d.ts.map +1 -0
  107. package/dist/esm/Client/utils/charsParams.js +19 -0
  108. package/dist/esm/Client/utils/fibonacci.d.ts +2 -0
  109. package/dist/esm/Client/utils/fibonacci.d.ts.map +1 -0
  110. package/dist/esm/Client/utils/fibonacci.js +10 -0
  111. package/dist/esm/Client/utils/hashParams.d.ts +3 -0
  112. package/dist/esm/Client/utils/hashParams.d.ts.map +1 -0
  113. package/dist/esm/Client/utils/hashParams.js +6 -0
  114. package/dist/esm/Client/utils/htmlUnescape.d.ts +2 -0
  115. package/dist/esm/Client/utils/htmlUnescape.d.ts.map +1 -0
  116. package/dist/esm/Client/utils/htmlUnescape.js +8 -0
  117. package/dist/esm/Client/utils/index.d.ts +2 -0
  118. package/dist/esm/Client/utils/index.d.ts.map +1 -0
  119. package/dist/esm/Client/utils/index.js +1 -0
  120. package/dist/esm/Client/utils/mergeParams.d.ts +2 -0
  121. package/dist/esm/Client/utils/mergeParams.d.ts.map +1 -0
  122. package/dist/esm/Client/utils/mergeParams.js +10 -0
  123. package/dist/esm/index.d.ts +3 -0
  124. package/dist/esm/index.d.ts.map +1 -0
  125. package/dist/esm/index.js +1 -0
  126. package/dist/esm/types.d.ts +45 -0
  127. package/dist/esm/types.d.ts.map +1 -0
  128. package/dist/esm/types.js +1 -0
  129. package/package.json +27 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2022 Searchspring
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,174 @@
1
+ # Snap Javascript Client
2
+
3
+ Simple Javascript client for communicating with the Searchspring Snap API.
4
+
5
+ ## Quick Links
6
+
7
+ [Snap API docs](https://snapi.kube.searchspring.io/api/v1/) - Search & Autocomplete API documentation
8
+
9
+ [Snapi Explorer](https://searchspring.github.io/snapi-explorer/) - a tool for making requests to Searchspring's API
10
+
11
+ ## Installation
12
+
13
+ ```bash
14
+ npm install --save @searchspring/snap-client
15
+ ```
16
+
17
+ ## Import
18
+ ```typescript
19
+ import { Client } from '@searchspring/snap-client';
20
+ ```
21
+
22
+ ## Global Config
23
+ Client is constructed with `globals`.
24
+
25
+ Globals are API parameters that will be applied to all searches requested by the client. This will typically contain just the *siteId*; but could also include global filters, background filters, sorts, or merchandising segments.
26
+
27
+ `siteId` (required)
28
+
29
+ ```typescript
30
+ const globals = {
31
+ siteId: 'a1b2c3'
32
+ };
33
+ ```
34
+
35
+ Any other keys defined here will be passed to the API request
36
+
37
+ For a full list of parameters please see the [Snap API docs](https://snapi.kube.searchspring.io/api/v1/)
38
+
39
+ For example, with background filter:
40
+
41
+ ```typescript
42
+ const globals = {
43
+ siteId: 'a1b2c3',
44
+ filters: [{
45
+ field: 'stock_status',
46
+ value: 'yes',
47
+ type: 'value',
48
+ background: true
49
+ }]
50
+ };
51
+ ```
52
+
53
+ ## Client Config
54
+ Object required for all controllers
55
+
56
+ ```typescript
57
+ export type ClientConfig = {
58
+ meta?: {
59
+ api?: SnapApiConfig;
60
+ cache?: CacheConfig;
61
+ };
62
+ search?: {
63
+ api?: SnapApiConfig;
64
+ cache?: CacheConfig;
65
+ };
66
+ autocomplete?: {
67
+ api?: SnapApiConfig;
68
+ cache?: CacheConfig;
69
+ };
70
+ recommend?: {
71
+ api?: SnapApiConfig;
72
+ cache?: CacheConfig;
73
+ };
74
+ suggest?: {
75
+ api?: SnapApiConfig;
76
+ cache?: CacheConfig;
77
+ };
78
+ };
79
+
80
+ export type CacheConfig = {
81
+ enabled?: boolean;
82
+ ttl?: number;
83
+ maxSize?: number;
84
+ purgeable?: boolean;
85
+ };
86
+
87
+ export type SnapApiConfig = {
88
+ origin?: string;
89
+ };
90
+
91
+ ```
92
+
93
+ ## Controller usage
94
+ Snap Client is a dependency of Snap Controller and it is recommended to use the Controller's `search` method to perform a search.
95
+
96
+
97
+
98
+ ## Cache usage
99
+ Each requester in the Snap Client has its own cache settings, which can be configured via the `ClientConfig` under `cache`. Settings include:
100
+
101
+ `enabled`: to opt out - Defaults to `true`,
102
+
103
+ `ttl`: to adjust how long the requests are stored (in ms) - Defaults to `300000`,
104
+
105
+ `maxSize`: to adjust the maximum size of the cache allowed to be stored in localStorage (in kb - Defaults to `200`,
106
+
107
+ `purgeable`: to allow auto purging of the requests from localstorage when maxSize is hit, based on time remaining to expiration. - Defaults to `true` with the exception of `meta`,
108
+
109
+
110
+ ## Standalone usage
111
+ ```typescript
112
+ const client = new Client(globals, clientConfig);
113
+
114
+ const results = await client.search({
115
+ search: {
116
+ query: {
117
+ string: 'dress'
118
+ }
119
+ }
120
+ });
121
+ ```
122
+
123
+ ## `search` method
124
+ Makes a request to the Searchspring Search API and returns a promise.
125
+
126
+ ```typescript
127
+ const client = new Client(globals, clientConfig);
128
+
129
+ const results = await client.search({
130
+ search: {
131
+ query: {
132
+ string: 'dress'
133
+ }
134
+ }
135
+ });
136
+ ```
137
+
138
+ ## `autocomplete` method
139
+ Makes a request to the Searchspring Autocomplete API and returns a promise.
140
+
141
+ ```typescript
142
+ const client = new Client(globals, clientConfig);
143
+
144
+ const results = await client.autocomplete({
145
+ suggestions: {
146
+ count: 5
147
+ },
148
+ search: {
149
+ query: {
150
+ string: 'yellw',
151
+ spellCorrection: true
152
+ }
153
+ }
154
+ });
155
+ ```
156
+
157
+ ## `meta` property
158
+ The meta property contains the metadata related to the siteId that the client was instantiated with. This data is to be used together with search results. Metadata contains site configuration like facet and sorting information.
159
+
160
+ Note that the `search` method sets the `meta` property, therefore it must be called before attempting to access the `meta` property.
161
+
162
+ ```typescript
163
+ const client = new Client(globals, clientConfig);
164
+
165
+ const results = await client.search({
166
+ search: {
167
+ query: {
168
+ string: 'dress'
169
+ }
170
+ }
171
+ });
172
+
173
+ const meta = client.meta;
174
+ ```
@@ -0,0 +1,15 @@
1
+ import { TrendingRequestModel, TrendingResponseModel, RecommendCombinedRequestModel, RecommendCombinedResponseModel } from './apis';
2
+ import type { ClientGlobals, ClientConfig } from '../types';
3
+ import type { MetaRequestModel, MetaResponseModel, SearchRequestModel, SearchResponseModel, AutocompleteRequestModel, AutocompleteResponseModel } from '@searchspring/snapi-types';
4
+ export declare class Client {
5
+ private globals;
6
+ private config;
7
+ private requesters;
8
+ constructor(globals: ClientGlobals, config?: ClientConfig);
9
+ meta(params?: MetaRequestModel): Promise<MetaResponseModel>;
10
+ autocomplete(params?: AutocompleteRequestModel): Promise<[MetaResponseModel, AutocompleteResponseModel]>;
11
+ search(params?: SearchRequestModel): Promise<[MetaResponseModel, SearchResponseModel]>;
12
+ trending(params: Partial<TrendingRequestModel>): Promise<TrendingResponseModel>;
13
+ recommend(params: RecommendCombinedRequestModel): Promise<RecommendCombinedResponseModel>;
14
+ }
15
+ //# sourceMappingURL=Client.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Client.d.ts","sourceRoot":"","sources":["../../../src/Client/Client.ts"],"names":[],"mappings":"AAAA,OAAO,EAKN,oBAAoB,EACpB,qBAAqB,EAErB,6BAA6B,EAC7B,8BAA8B,EAG9B,MAAM,QAAQ,CAAC;AAEhB,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAE5D,OAAO,KAAK,EACX,gBAAgB,EAChB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,wBAAwB,EACxB,yBAAyB,EACzB,MAAM,2BAA2B,CAAC;AAgCnC,qBAAa,MAAM;IAClB,OAAO,CAAC,OAAO,CAAgB;IAC/B,OAAO,CAAC,MAAM,CAAe;IAC7B,OAAO,CAAC,UAAU,CAMhB;gBAEU,OAAO,EAAE,aAAa,EAAE,MAAM,GAAE,YAAiB;IA0CvD,IAAI,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAO3D,YAAY,CAAC,MAAM,GAAE,wBAA6B,GAAG,OAAO,CAAC,CAAC,iBAAiB,EAAE,yBAAyB,CAAC,CAAC;IAU5G,MAAM,CAAC,MAAM,GAAE,kBAAuB,GAAG,OAAO,CAAC,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,CAAC;IAM1F,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAM/E,SAAS,CAAC,MAAM,EAAE,6BAA6B,GAAG,OAAO,CAAC,8BAA8B,CAAC;CAkC/F"}
@@ -0,0 +1,198 @@
1
+ "use strict";
2
+ var __assign = (this && this.__assign) || function () {
3
+ __assign = Object.assign || function(t) {
4
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
5
+ s = arguments[i];
6
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
7
+ t[p] = s[p];
8
+ }
9
+ return t;
10
+ };
11
+ return __assign.apply(this, arguments);
12
+ };
13
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
14
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
15
+ return new (P || (P = Promise))(function (resolve, reject) {
16
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
17
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
18
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
19
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
20
+ });
21
+ };
22
+ var __generator = (this && this.__generator) || function (thisArg, body) {
23
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
24
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
25
+ function verb(n) { return function (v) { return step([n, v]); }; }
26
+ function step(op) {
27
+ if (f) throw new TypeError("Generator is already executing.");
28
+ while (_) try {
29
+ if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
30
+ if (y = 0, t) op = [op[0] & 2, t.value];
31
+ switch (op[0]) {
32
+ case 0: case 1: t = op; break;
33
+ case 4: _.label++; return { value: op[1], done: false };
34
+ case 5: _.label++; y = op[1]; op = [0]; continue;
35
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
36
+ default:
37
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
38
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
39
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
40
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
41
+ if (t[2]) _.ops.pop();
42
+ _.trys.pop(); continue;
43
+ }
44
+ op = body.call(thisArg, _);
45
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
46
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
47
+ }
48
+ };
49
+ var __rest = (this && this.__rest) || function (s, e) {
50
+ var t = {};
51
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
52
+ t[p] = s[p];
53
+ if (s != null && typeof Object.getOwnPropertySymbols === "function")
54
+ for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
55
+ if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
56
+ t[p[i]] = s[p[i]];
57
+ }
58
+ return t;
59
+ };
60
+ var __importDefault = (this && this.__importDefault) || function (mod) {
61
+ return (mod && mod.__esModule) ? mod : { "default": mod };
62
+ };
63
+ Object.defineProperty(exports, "__esModule", { value: true });
64
+ exports.Client = void 0;
65
+ var apis_1 = require("./apis");
66
+ var deepmerge_1 = __importDefault(require("deepmerge"));
67
+ var defaultConfig = {
68
+ meta: {
69
+ cache: {
70
+ purgeable: false,
71
+ },
72
+ },
73
+ search: {
74
+ api: {
75
+ // origin: 'https://snapi.kube.searchspring.io',
76
+ },
77
+ },
78
+ autocomplete: {
79
+ api: {
80
+ // origin: 'https://snapi.kube.searchspring.io',
81
+ },
82
+ },
83
+ recommend: {
84
+ api: {
85
+ // origin: 'https://snapi.kube.searchspring.io',
86
+ },
87
+ },
88
+ suggest: {
89
+ api: {
90
+ // origin: 'https://snapi.kube.searchspring.io',
91
+ },
92
+ },
93
+ };
94
+ var Client = /** @class */ (function () {
95
+ function Client(globals, config) {
96
+ if (config === void 0) { config = {}; }
97
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
98
+ if (!(globals === null || globals === void 0 ? void 0 : globals.siteId)) {
99
+ throw 'no siteId specified!';
100
+ }
101
+ this.globals = globals;
102
+ this.config = (0, deepmerge_1.default)(defaultConfig, config);
103
+ this.requesters = {
104
+ autocomplete: new apis_1.HybridAPI(new apis_1.ApiConfiguration({
105
+ origin: (_b = (_a = this.config.autocomplete) === null || _a === void 0 ? void 0 : _a.api) === null || _b === void 0 ? void 0 : _b.origin,
106
+ cacheSettings: this.config.autocomplete.cache,
107
+ })),
108
+ meta: new apis_1.HybridAPI(new apis_1.ApiConfiguration({
109
+ origin: (_d = (_c = this.config.meta) === null || _c === void 0 ? void 0 : _c.api) === null || _d === void 0 ? void 0 : _d.origin,
110
+ cacheSettings: this.config.meta.cache,
111
+ })),
112
+ recommend: new apis_1.RecommendAPI(new apis_1.ApiConfiguration({
113
+ origin: (_f = (_e = this.config.recommend) === null || _e === void 0 ? void 0 : _e.api) === null || _f === void 0 ? void 0 : _f.origin,
114
+ cacheSettings: this.config.recommend.cache,
115
+ })),
116
+ search: new apis_1.HybridAPI(new apis_1.ApiConfiguration({
117
+ origin: (_h = (_g = this.config.search) === null || _g === void 0 ? void 0 : _g.api) === null || _h === void 0 ? void 0 : _h.origin,
118
+ cacheSettings: this.config.search.cache,
119
+ })),
120
+ suggest: new apis_1.SuggestAPI(new apis_1.ApiConfiguration({
121
+ origin: (_k = (_j = this.config.suggest) === null || _j === void 0 ? void 0 : _j.api) === null || _k === void 0 ? void 0 : _k.origin,
122
+ cacheSettings: this.config.suggest.cache,
123
+ })),
124
+ };
125
+ }
126
+ Client.prototype.meta = function (params) {
127
+ return __awaiter(this, void 0, void 0, function () {
128
+ var defaultParams;
129
+ return __generator(this, function (_a) {
130
+ defaultParams = { siteId: this.globals.siteId };
131
+ params = (0, deepmerge_1.default)(defaultParams, params || {});
132
+ return [2 /*return*/, this.requesters.meta.getMeta(params)];
133
+ });
134
+ });
135
+ };
136
+ Client.prototype.autocomplete = function (params) {
137
+ var _a, _b;
138
+ if (params === void 0) { params = {}; }
139
+ return __awaiter(this, void 0, void 0, function () {
140
+ return __generator(this, function (_c) {
141
+ if (!((_b = (_a = params.search) === null || _a === void 0 ? void 0 : _a.query) === null || _b === void 0 ? void 0 : _b.string)) {
142
+ throw 'query string parameter is required';
143
+ }
144
+ params = (0, deepmerge_1.default)(this.globals, params);
145
+ return [2 /*return*/, Promise.all([this.meta({ siteId: params.siteId }), this.requesters.autocomplete.getAutocomplete(params)])];
146
+ });
147
+ });
148
+ };
149
+ Client.prototype.search = function (params) {
150
+ if (params === void 0) { params = {}; }
151
+ return __awaiter(this, void 0, void 0, function () {
152
+ return __generator(this, function (_a) {
153
+ params = (0, deepmerge_1.default)(this.globals, params);
154
+ return [2 /*return*/, Promise.all([this.meta({ siteId: params.siteId }), this.requesters.search.getSearch(params)])];
155
+ });
156
+ });
157
+ };
158
+ Client.prototype.trending = function (params) {
159
+ return __awaiter(this, void 0, void 0, function () {
160
+ return __generator(this, function (_a) {
161
+ params = (0, deepmerge_1.default)({ siteId: this.globals.siteId }, params || {});
162
+ return [2 /*return*/, this.requesters.suggest.getTrending(params)];
163
+ });
164
+ });
165
+ };
166
+ Client.prototype.recommend = function (params) {
167
+ return __awaiter(this, void 0, void 0, function () {
168
+ var tag, otherParams, profileParams, recommendParams, _a, profile, recommendations;
169
+ return __generator(this, function (_b) {
170
+ switch (_b.label) {
171
+ case 0:
172
+ tag = params.tag, otherParams = __rest(params, ["tag"]);
173
+ if (!tag) {
174
+ throw 'tag parameter is required';
175
+ }
176
+ profileParams = {
177
+ tag: tag,
178
+ siteId: params.siteId || this.globals.siteId,
179
+ };
180
+ if (otherParams.branch) {
181
+ profileParams.branch = otherParams.branch;
182
+ delete otherParams.branch;
183
+ }
184
+ recommendParams = __assign({ tags: [tag], siteId: params.siteId || this.globals.siteId }, otherParams);
185
+ return [4 /*yield*/, Promise.all([
186
+ this.requesters.recommend.getProfile(profileParams),
187
+ this.requesters.recommend.batchRecommendations(recommendParams),
188
+ ])];
189
+ case 1:
190
+ _a = _b.sent(), profile = _a[0], recommendations = _a[1];
191
+ return [2 /*return*/, __assign(__assign({}, profile), { results: recommendations[0].results })];
192
+ }
193
+ });
194
+ });
195
+ };
196
+ return Client;
197
+ }());
198
+ exports.Client = Client;
@@ -0,0 +1,10 @@
1
+ import { CacheConfig } from '../../types';
2
+ export declare class NetworkCache {
3
+ private memoryCache;
4
+ config: CacheConfig;
5
+ constructor(config?: CacheConfig);
6
+ get(key: string): Response;
7
+ set(key: string, value: Response): void;
8
+ clear(): void;
9
+ }
10
+ //# sourceMappingURL=NetworkCache.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"NetworkCache.d.ts","sourceRoot":"","sources":["../../../../src/Client/NetworkCache/NetworkCache.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAS,MAAM,aAAa,CAAC;AAWjD,qBAAa,YAAY;IACxB,OAAO,CAAC,WAAW,CAAa;IAChC,MAAM,EAAE,WAAW,CAAC;gBAER,MAAM,CAAC,EAAE,WAAW;IAIzB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ;IAgC1B,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,GAAG,IAAI;IAyCvC,KAAK;CAQZ"}
@@ -0,0 +1,104 @@
1
+ "use strict";
2
+ var __assign = (this && this.__assign) || function () {
3
+ __assign = Object.assign || function(t) {
4
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
5
+ s = arguments[i];
6
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
7
+ t[p] = s[p];
8
+ }
9
+ return t;
10
+ };
11
+ return __assign.apply(this, arguments);
12
+ };
13
+ var __importDefault = (this && this.__importDefault) || function (mod) {
14
+ return (mod && mod.__esModule) ? mod : { "default": mod };
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ exports.NetworkCache = void 0;
18
+ var deepmerge_1 = __importDefault(require("deepmerge"));
19
+ var CACHE_STORAGE_KEY = 'ss-networkcache';
20
+ var defaultConfig = {
21
+ enabled: true,
22
+ ttl: 300000,
23
+ maxSize: 200,
24
+ purgeable: true,
25
+ };
26
+ var NetworkCache = /** @class */ (function () {
27
+ function NetworkCache(config) {
28
+ this.memoryCache = {};
29
+ this.config = (0, deepmerge_1.default)(defaultConfig, config || {});
30
+ }
31
+ NetworkCache.prototype.get = function (key) {
32
+ try {
33
+ if (this.memoryCache[key]) {
34
+ if (Date.now() < this.memoryCache[key].expires) {
35
+ return this.memoryCache[key].value;
36
+ }
37
+ }
38
+ var stored = sessionStorage.getItem(CACHE_STORAGE_KEY);
39
+ var localData = stored && JSON.parse(stored);
40
+ if (localData && key && localData[key]) {
41
+ // compare the expiry time of the item with the current time
42
+ if (Date.now() > localData[key].expires) {
43
+ // remove item
44
+ var newStored = __assign({}, localData);
45
+ delete newStored[key];
46
+ //update storage
47
+ sessionStorage.setItem(CACHE_STORAGE_KEY, JSON.stringify(newStored));
48
+ return undefined;
49
+ }
50
+ else {
51
+ return localData[key].value;
52
+ }
53
+ }
54
+ }
55
+ catch (err) {
56
+ console.warn('something went wrong, browser might not have cookies enabled');
57
+ }
58
+ };
59
+ NetworkCache.prototype.set = function (key, value) {
60
+ if (this.config.enabled) {
61
+ try {
62
+ var cacheObject = {
63
+ value: value,
64
+ expires: Date.now() + this.config.ttl,
65
+ purgeable: this.config.purgeable,
66
+ };
67
+ this.memoryCache[key] = cacheObject;
68
+ var stored = sessionStorage.getItem(CACHE_STORAGE_KEY);
69
+ var newStored_1 = __assign({}, (stored && JSON.parse(stored)));
70
+ newStored_1[key] = cacheObject;
71
+ var size = new Blob([JSON.stringify(newStored_1)], { endings: 'native' }).size / 1024;
72
+ while (size > this.config.maxSize) {
73
+ var oldestKey = Object.keys(newStored_1)
74
+ .filter(function (key) { return newStored_1[key].purgeable; })
75
+ .sort(function (a, b) {
76
+ return newStored_1[a].expires - newStored_1[b].expires;
77
+ })[0];
78
+ if (!oldestKey)
79
+ break;
80
+ delete newStored_1[oldestKey];
81
+ // recalculate size after removing oldest
82
+ size = new Blob([JSON.stringify(newStored_1)], { endings: 'native' }).size / 1024;
83
+ }
84
+ if (size < this.config.maxSize) {
85
+ sessionStorage.setItem(CACHE_STORAGE_KEY, JSON.stringify(newStored_1));
86
+ }
87
+ }
88
+ catch (err) {
89
+ console.warn('something went wrong, browser might not have cookies enabled');
90
+ }
91
+ }
92
+ };
93
+ NetworkCache.prototype.clear = function () {
94
+ try {
95
+ this.memoryCache = {};
96
+ sessionStorage.setItem(CACHE_STORAGE_KEY, '');
97
+ }
98
+ catch (err) {
99
+ console.warn('something went wrong, browser might not have cookies enabled');
100
+ }
101
+ };
102
+ return NetworkCache;
103
+ }());
104
+ exports.NetworkCache = NetworkCache;
@@ -0,0 +1,49 @@
1
+ import { NetworkCache } from '../NetworkCache/NetworkCache';
2
+ import { CacheConfig } from '../../types';
3
+ export declare type Json = any;
4
+ export declare type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
5
+ export declare type HTTPHeaders = {
6
+ [key: string]: string;
7
+ };
8
+ export declare type HTTPQuery = {
9
+ [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | HTTPQuery;
10
+ };
11
+ export declare type HTTPBody = Json | FormData | URLSearchParams;
12
+ export interface RequestOpts {
13
+ path: string;
14
+ method: HTTPMethod;
15
+ headers: HTTPHeaders;
16
+ query?: HTTPQuery;
17
+ body?: HTTPBody;
18
+ }
19
+ export declare class API {
20
+ protected configuration: ApiConfiguration;
21
+ private retryDelay;
22
+ private retryCount;
23
+ cache: NetworkCache;
24
+ constructor(configuration: ApiConfiguration);
25
+ protected request(context: RequestOpts, cacheKey?: any): Promise<Response>;
26
+ private createFetchParams;
27
+ private fetchApi;
28
+ }
29
+ export declare type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
30
+ export interface ApiConfigurationParameters {
31
+ origin?: string;
32
+ fetchApi?: FetchAPI;
33
+ queryParamsStringify?: (params: HTTPQuery) => string;
34
+ headers?: HTTPHeaders;
35
+ maxRetry?: number;
36
+ cacheSettings?: CacheConfig;
37
+ }
38
+ export declare class ApiConfiguration {
39
+ private configuration;
40
+ constructor(configuration: ApiConfigurationParameters);
41
+ get cacheSettings(): CacheConfig;
42
+ get maxRetry(): number;
43
+ get origin(): string;
44
+ get fetchApi(): FetchAPI;
45
+ get queryParamsStringify(): (params: HTTPQuery) => string;
46
+ get headers(): HTTPHeaders | undefined;
47
+ }
48
+ export declare function querystring(params: HTTPQuery, prefix?: string): string;
49
+ //# sourceMappingURL=Abstract.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Abstract.d.ts","sourceRoot":"","sources":["../../../../src/Client/apis/Abstract.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAI1C,oBAAY,IAAI,GAAG,GAAG,CAAC;AACvB,oBAAY,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;AAC1F,oBAAY,WAAW,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AACpD,oBAAY,SAAS,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,GAAG,SAAS,CAAA;CAAE,CAAC;AAClI,oBAAY,QAAQ,GAAG,IAAI,GAAG,QAAQ,GAAG,eAAe,CAAC;AAEzD,MAAM,WAAW,WAAW;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,EAAE,WAAW,CAAC;IACrB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,IAAI,CAAC,EAAE,QAAQ,CAAC;CAChB;AAED,qBAAa,GAAG;IAMH,SAAS,CAAC,aAAa,EAAE,gBAAgB;IALrD,OAAO,CAAC,UAAU,CAAQ;IAC1B,OAAO,CAAC,UAAU,CAAK;IAEhB,KAAK,EAAE,YAAY,CAAC;gBAEL,aAAa,EAAE,gBAAgB;cAIrC,OAAO,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC;IAmChF,OAAO,CAAC,iBAAiB;IA+BzB,OAAO,CAAC,QAAQ,CAId;CACF;AAED,oBAAY,QAAQ,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;AAE1D,MAAM,WAAW,0BAA0B;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,oBAAoB,CAAC,EAAE,CAAC,MAAM,EAAE,SAAS,KAAK,MAAM,CAAC;IACrD,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,WAAW,CAAC;CAC5B;AAED,qBAAa,gBAAgB;IAChB,OAAO,CAAC,aAAa;gBAAb,aAAa,EAAE,0BAA0B;IAM7D,IAAI,aAAa,IAAI,WAAW,CAE/B;IAED,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,QAAQ,IAAI,QAAQ,CAEvB;IAED,IAAI,oBAAoB,IAAI,CAAC,MAAM,EAAE,SAAS,KAAK,MAAM,CAExD;IAED,IAAI,OAAO,IAAI,WAAW,GAAG,SAAS,CAErC;CACD;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,SAAK,GAAG,MAAM,CAmBlE"}