algoliasearch 5.0.0-alpha.3 → 5.0.0-alpha.4

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 (105) hide show
  1. package/dist/algoliasearch/builds/browser.d.ts +14 -9
  2. package/dist/algoliasearch/builds/browser.d.ts.map +1 -1
  3. package/dist/algoliasearch/builds/node.d.ts +14 -9
  4. package/dist/algoliasearch/builds/node.d.ts.map +1 -1
  5. package/dist/algoliasearch/lite/model/acl.d.ts +3 -0
  6. package/dist/algoliasearch/lite/model/acl.d.ts.map +1 -1
  7. package/dist/algoliasearch/lite/model/addApiKeyResponse.d.ts +1 -1
  8. package/dist/algoliasearch/lite/model/attributeToUpdate.d.ts +3 -0
  9. package/dist/algoliasearch/lite/model/attributeToUpdate.d.ts.map +1 -0
  10. package/dist/algoliasearch/lite/model/baseGetApiKeyResponse.d.ts +11 -0
  11. package/dist/algoliasearch/lite/model/baseGetApiKeyResponse.d.ts.map +1 -0
  12. package/dist/algoliasearch/lite/model/getApiKeyResponse.d.ts +4 -0
  13. package/dist/algoliasearch/lite/model/getApiKeyResponse.d.ts.map +1 -0
  14. package/dist/algoliasearch/lite/model/index.d.ts +3 -3
  15. package/dist/algoliasearch/lite/model/index.d.ts.map +1 -1
  16. package/dist/algoliasearch/lite/src/liteClient.d.ts +9 -1
  17. package/dist/algoliasearch/lite/src/liteClient.d.ts.map +1 -1
  18. package/dist/algoliasearch.cjs.js +185 -24
  19. package/dist/algoliasearch.esm.browser.js +213 -52
  20. package/dist/algoliasearch.esm.node.js +186 -25
  21. package/dist/algoliasearch.umd.js +2 -2
  22. package/dist/builds/browser.d.ts +14 -9
  23. package/dist/builds/browser.d.ts.map +1 -1
  24. package/dist/builds/node.d.ts +14 -9
  25. package/dist/builds/node.d.ts.map +1 -1
  26. package/dist/client-abtesting/src/abtestingClient.d.ts +9 -1
  27. package/dist/client-abtesting/src/abtestingClient.d.ts.map +1 -1
  28. package/dist/client-analytics/src/analyticsClient.d.ts +9 -1
  29. package/dist/client-analytics/src/analyticsClient.d.ts.map +1 -1
  30. package/dist/client-personalization/src/personalizationClient.d.ts +9 -1
  31. package/dist/client-personalization/src/personalizationClient.d.ts.map +1 -1
  32. package/dist/client-search/model/acl.d.ts +3 -0
  33. package/dist/client-search/model/acl.d.ts.map +1 -1
  34. package/dist/client-search/model/addApiKeyResponse.d.ts +1 -1
  35. package/dist/client-search/model/attributeToUpdate.d.ts +3 -0
  36. package/dist/client-search/model/attributeToUpdate.d.ts.map +1 -0
  37. package/dist/client-search/model/baseGetApiKeyResponse.d.ts +11 -0
  38. package/dist/client-search/model/baseGetApiKeyResponse.d.ts.map +1 -0
  39. package/dist/client-search/model/batchParams.d.ts +1 -1
  40. package/dist/client-search/model/batchParams.d.ts.map +1 -1
  41. package/dist/client-search/model/clientMethodProps.d.ts +20 -7
  42. package/dist/client-search/model/clientMethodProps.d.ts.map +1 -1
  43. package/dist/client-search/model/getApiKeyResponse.d.ts +4 -0
  44. package/dist/client-search/model/getApiKeyResponse.d.ts.map +1 -0
  45. package/dist/client-search/model/getObjectsParams.d.ts +1 -1
  46. package/dist/client-search/model/getObjectsParams.d.ts.map +1 -1
  47. package/dist/client-search/model/index.d.ts +3 -3
  48. package/dist/client-search/model/index.d.ts.map +1 -1
  49. package/dist/client-search/model/listApiKeysResponse.d.ts +2 -2
  50. package/dist/client-search/model/listApiKeysResponse.d.ts.map +1 -1
  51. package/dist/client-search/model/multipleBatchRequest.d.ts +3 -3
  52. package/dist/client-search/model/multipleBatchRequest.d.ts.map +1 -1
  53. package/dist/client-search/model/multipleBatchResponse.d.ts +2 -2
  54. package/dist/client-search/model/multipleBatchResponse.d.ts.map +1 -1
  55. package/dist/client-search/model/updateApiKeyResponse.d.ts +1 -1
  56. package/dist/client-search/src/searchClient.d.ts +62 -15
  57. package/dist/client-search/src/searchClient.d.ts.map +1 -1
  58. package/dist/lite/builds/browser.d.ts +14 -9
  59. package/dist/lite/builds/browser.d.ts.map +1 -1
  60. package/dist/lite/builds/node.d.ts +14 -9
  61. package/dist/lite/builds/node.d.ts.map +1 -1
  62. package/dist/lite/lite/model/acl.d.ts +3 -0
  63. package/dist/lite/lite/model/acl.d.ts.map +1 -1
  64. package/dist/lite/lite/model/addApiKeyResponse.d.ts +1 -1
  65. package/dist/lite/lite/model/attributeToUpdate.d.ts +3 -0
  66. package/dist/lite/lite/model/attributeToUpdate.d.ts.map +1 -0
  67. package/dist/lite/lite/model/baseGetApiKeyResponse.d.ts +11 -0
  68. package/dist/lite/lite/model/baseGetApiKeyResponse.d.ts.map +1 -0
  69. package/dist/lite/lite/model/getApiKeyResponse.d.ts +4 -0
  70. package/dist/lite/lite/model/getApiKeyResponse.d.ts.map +1 -0
  71. package/dist/lite/lite/model/index.d.ts +3 -3
  72. package/dist/lite/lite/model/index.d.ts.map +1 -1
  73. package/dist/lite/lite/src/liteClient.d.ts +9 -1
  74. package/dist/lite/lite/src/liteClient.d.ts.map +1 -1
  75. package/dist/lite/lite.cjs.js +14 -1
  76. package/dist/lite/lite.esm.browser.js +14 -1
  77. package/dist/lite/lite.esm.node.js +14 -1
  78. package/dist/lite/lite.umd.js +2 -2
  79. package/lite/model/acl.ts +3 -0
  80. package/lite/model/addApiKeyResponse.ts +1 -1
  81. package/lite/model/{attributeOrBuiltInOperation.ts → attributeToUpdate.ts} +1 -1
  82. package/lite/model/baseGetApiKeyResponse.ts +13 -0
  83. package/lite/model/{key.ts → getApiKeyResponse.ts} +2 -2
  84. package/lite/model/index.ts +3 -3
  85. package/lite/src/liteClient.ts +19 -1
  86. package/package.json +9 -9
  87. package/dist/algoliasearch/lite/model/attributeOrBuiltInOperation.d.ts +0 -3
  88. package/dist/algoliasearch/lite/model/attributeOrBuiltInOperation.d.ts.map +0 -1
  89. package/dist/algoliasearch/lite/model/createdAtObject.d.ts +0 -7
  90. package/dist/algoliasearch/lite/model/createdAtObject.d.ts.map +0 -1
  91. package/dist/algoliasearch/lite/model/key.d.ts +0 -4
  92. package/dist/algoliasearch/lite/model/key.d.ts.map +0 -1
  93. package/dist/client-search/model/attributeOrBuiltInOperation.d.ts +0 -3
  94. package/dist/client-search/model/attributeOrBuiltInOperation.d.ts.map +0 -1
  95. package/dist/client-search/model/createdAtObject.d.ts +0 -7
  96. package/dist/client-search/model/createdAtObject.d.ts.map +0 -1
  97. package/dist/client-search/model/key.d.ts +0 -4
  98. package/dist/client-search/model/key.d.ts.map +0 -1
  99. package/dist/lite/lite/model/attributeOrBuiltInOperation.d.ts +0 -3
  100. package/dist/lite/lite/model/attributeOrBuiltInOperation.d.ts.map +0 -1
  101. package/dist/lite/lite/model/createdAtObject.d.ts +0 -7
  102. package/dist/lite/lite/model/createdAtObject.d.ts.map +0 -1
  103. package/dist/lite/lite/model/key.d.ts +0 -4
  104. package/dist/lite/lite/model/key.d.ts.map +0 -1
  105. package/lite/model/createdAtObject.ts +0 -8
@@ -22,7 +22,7 @@ import type {
22
22
  import type { SearchMethodParams } from '../model/searchMethodParams';
23
23
  import type { SearchResponses } from '../model/searchResponses';
24
24
 
25
- export const apiClientVersion = '5.0.0-alpha.3';
25
+ export const apiClientVersion = '5.0.0-alpha.4';
26
26
 
27
27
  function getDefaultHosts(appId: string): Host[] {
28
28
  return (
@@ -89,12 +89,29 @@ export function createLiteClient({
89
89
 
90
90
  return {
91
91
  transporter,
92
+
93
+ /**
94
+ * The `appId` currently in use.
95
+ */
96
+ appId: appIdOption,
97
+
98
+ /**
99
+ * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
100
+ */
101
+ clearCache(): Promise<void> {
102
+ return Promise.all([
103
+ transporter.requestsCache.clear(),
104
+ transporter.responsesCache.clear(),
105
+ ]).then(() => undefined);
106
+ },
107
+
92
108
  /**
93
109
  * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
94
110
  */
95
111
  get _ua(): string {
96
112
  return transporter.algoliaAgent.value;
97
113
  },
114
+
98
115
  /**
99
116
  * Adds a `segment` to the `x-algolia-agent` sent with every requests.
100
117
  *
@@ -104,6 +121,7 @@ export function createLiteClient({
104
121
  addAlgoliaAgent(segment: string, version?: string): void {
105
122
  transporter.algoliaAgent.add({ segment, version });
106
123
  },
124
+
107
125
  /**
108
126
  * This method allow you to send requests to the Algolia REST API.
109
127
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "algoliasearch",
3
- "version": "5.0.0-alpha.3",
3
+ "version": "5.0.0-alpha.4",
4
4
  "description": "A fully-featured and blazing-fast JavaScript API client to interact with Algolia API.",
5
5
  "repository": "algolia/algoliasearch-client-javascript",
6
6
  "license": "MIT",
@@ -58,17 +58,17 @@
58
58
  "test": "jest"
59
59
  },
60
60
  "dependencies": {
61
- "@algolia/client-abtesting": "5.0.0-alpha.3",
62
- "@algolia/client-analytics": "5.0.0-alpha.3",
63
- "@algolia/client-common": "5.0.0-alpha.3",
64
- "@algolia/client-personalization": "5.0.0-alpha.3",
65
- "@algolia/client-search": "5.0.0-alpha.3",
66
- "@algolia/requester-browser-xhr": "5.0.0-alpha.3",
67
- "@algolia/requester-node-http": "5.0.0-alpha.3"
61
+ "@algolia/client-abtesting": "5.0.0-alpha.4",
62
+ "@algolia/client-analytics": "5.0.0-alpha.4",
63
+ "@algolia/client-common": "5.0.0-alpha.4",
64
+ "@algolia/client-personalization": "5.0.0-alpha.4",
65
+ "@algolia/client-search": "5.0.0-alpha.4",
66
+ "@algolia/requester-browser-xhr": "5.0.0-alpha.4",
67
+ "@algolia/requester-node-http": "5.0.0-alpha.4"
68
68
  },
69
69
  "devDependencies": {
70
70
  "@types/jest": "28.1.6",
71
- "@types/node": "16.11.45",
71
+ "@types/node": "16.11.47",
72
72
  "jest": "28.1.3",
73
73
  "ts-jest": "28.0.7",
74
74
  "typescript": "4.7.4"
@@ -1,3 +0,0 @@
1
- import type { BuiltInOperation } from './builtInOperation';
2
- export declare type AttributeOrBuiltInOperation = BuiltInOperation | string;
3
- //# sourceMappingURL=attributeOrBuiltInOperation.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"attributeOrBuiltInOperation.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/attributeOrBuiltInOperation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,oBAAY,2BAA2B,GAAG,gBAAgB,GAAG,MAAM,CAAC"}
@@ -1,7 +0,0 @@
1
- export declare type CreatedAtObject = {
2
- /**
3
- * Date of creation (ISO-8601 format).
4
- */
5
- createdAt: string;
6
- };
7
- //# sourceMappingURL=createdAtObject.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"createdAtObject.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/createdAtObject.ts"],"names":[],"mappings":"AAEA,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
@@ -1,4 +0,0 @@
1
- import type { ApiKey } from './apiKey';
2
- import type { CreatedAtObject } from './createdAtObject';
3
- export declare type Key = ApiKey & CreatedAtObject;
4
- //# sourceMappingURL=key.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"key.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/key.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,GAAG,GAAG,MAAM,GAAG,eAAe,CAAC"}
@@ -1,3 +0,0 @@
1
- import type { BuiltInOperation } from './builtInOperation';
2
- export declare type AttributeOrBuiltInOperation = BuiltInOperation | string;
3
- //# sourceMappingURL=attributeOrBuiltInOperation.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"attributeOrBuiltInOperation.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/attributeOrBuiltInOperation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,oBAAY,2BAA2B,GAAG,gBAAgB,GAAG,MAAM,CAAC"}
@@ -1,7 +0,0 @@
1
- export declare type CreatedAtObject = {
2
- /**
3
- * Date of creation (ISO-8601 format).
4
- */
5
- createdAt: string;
6
- };
7
- //# sourceMappingURL=createdAtObject.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"createdAtObject.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/createdAtObject.ts"],"names":[],"mappings":"AAEA,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
@@ -1,4 +0,0 @@
1
- import type { ApiKey } from './apiKey';
2
- import type { CreatedAtObject } from './createdAtObject';
3
- export declare type Key = ApiKey & CreatedAtObject;
4
- //# sourceMappingURL=key.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"key.d.ts","sourceRoot":"","sources":["../../../../../packages/client-search/model/key.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,GAAG,GAAG,MAAM,GAAG,eAAe,CAAC"}
@@ -1,3 +0,0 @@
1
- import type { BuiltInOperation } from './builtInOperation';
2
- export declare type AttributeOrBuiltInOperation = BuiltInOperation | string;
3
- //# sourceMappingURL=attributeOrBuiltInOperation.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"attributeOrBuiltInOperation.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/attributeOrBuiltInOperation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,oBAAY,2BAA2B,GAAG,gBAAgB,GAAG,MAAM,CAAC"}
@@ -1,7 +0,0 @@
1
- export declare type CreatedAtObject = {
2
- /**
3
- * Date of creation (ISO-8601 format).
4
- */
5
- createdAt: string;
6
- };
7
- //# sourceMappingURL=createdAtObject.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"createdAtObject.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/createdAtObject.ts"],"names":[],"mappings":"AAEA,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
@@ -1,4 +0,0 @@
1
- import type { ApiKey } from './apiKey';
2
- import type { CreatedAtObject } from './createdAtObject';
3
- export declare type Key = ApiKey & CreatedAtObject;
4
- //# sourceMappingURL=key.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"key.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/key.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,GAAG,GAAG,MAAM,GAAG,eAAe,CAAC"}
@@ -1,8 +0,0 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2
-
3
- export type CreatedAtObject = {
4
- /**
5
- * Date of creation (ISO-8601 format).
6
- */
7
- createdAt: string;
8
- };