@empathyco/x-components 3.0.0-alpha.106 → 3.0.0-alpha.109
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.
- package/CHANGELOG.md +31 -0
- package/design-system/full-theme.css +7 -7
- package/docs/API-reference/api/x-types.extraparamsrequest.extraparams.md +13 -0
- package/docs/API-reference/api/x-types.extraparamsrequest.md +7 -0
- package/docs/API-reference/api/x-types.nextqueriesrequest.md +2 -2
- package/docs/API-reference/api/x-types.relatedtagsrequest.md +2 -2
- package/docs/functional-doc/web-local-storage.md +22 -0
- package/package.json +6 -6
- package/report/x-types.api.json +38 -28
- package/types/adapter/mocked-adapter.d.ts.map +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,37 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file. See
|
|
4
4
|
[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [3.0.0-alpha.109](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.108...@empathyco/x-components@3.0.0-alpha.109) (2022-06-13)
|
|
7
|
+
|
|
8
|
+
### Documentation
|
|
9
|
+
|
|
10
|
+
- add local storage info and data purposes
|
|
11
|
+
([c1b0b05](https://github.com/empathyco/x/commit/c1b0b05cd9260227cb0689283ff27f34a2b01e51)),
|
|
12
|
+
closes [EX-4123](https://searchbroker.atlassian.net/browse/EX-4123)
|
|
13
|
+
|
|
14
|
+
# Change Log
|
|
15
|
+
|
|
16
|
+
All notable changes to this project will be documented in this file. See
|
|
17
|
+
[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
18
|
+
|
|
19
|
+
## [3.0.0-alpha.108](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.107...@empathyco/x-components@3.0.0-alpha.108) (2022-06-09)
|
|
20
|
+
|
|
21
|
+
**Note:** Version bump only for package @empathyco/x-components
|
|
22
|
+
|
|
23
|
+
# Change Log
|
|
24
|
+
|
|
25
|
+
All notable changes to this project will be documented in this file. See
|
|
26
|
+
[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
27
|
+
|
|
28
|
+
## [3.0.0-alpha.107](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.106...@empathyco/x-components@3.0.0-alpha.107) (2022-06-09)
|
|
29
|
+
|
|
30
|
+
**Note:** Version bump only for package @empathyco/x-components
|
|
31
|
+
|
|
32
|
+
# Change Log
|
|
33
|
+
|
|
34
|
+
All notable changes to this project will be documented in this file. See
|
|
35
|
+
[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
36
|
+
|
|
6
37
|
## [3.0.0-alpha.106](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.105...@empathyco/x-components@3.0.0-alpha.106) (2022-06-09)
|
|
7
38
|
|
|
8
39
|
**Note:** Version bump only for package @empathyco/x-components
|
|
@@ -3904,6 +3904,13 @@
|
|
|
3904
3904
|
--x-number-font-weight-suggestion-default-matching
|
|
3905
3905
|
);
|
|
3906
3906
|
}
|
|
3907
|
+
:root {
|
|
3908
|
+
--x-size-border-radius-tag-card: var(--x-size-border-radius-base-s);
|
|
3909
|
+
--x-size-border-radius-top-left-tag-card: var(--x-size-border-radius-tag-card);
|
|
3910
|
+
--x-size-border-radius-top-right-tag-card: var(--x-size-border-radius-tag-card);
|
|
3911
|
+
--x-size-border-radius-bottom-right-tag-card: var(--x-size-border-radius-tag-card);
|
|
3912
|
+
--x-size-border-radius-bottom-left-tag-card: var(--x-size-border-radius-tag-card);
|
|
3913
|
+
}
|
|
3907
3914
|
.x-tag--card.x-tag,
|
|
3908
3915
|
.x-tag--card .x-tag {
|
|
3909
3916
|
--x-size-border-radius-tag-default: var(--x-size-border-radius-tag-card);
|
|
@@ -3914,13 +3921,6 @@
|
|
|
3914
3921
|
);
|
|
3915
3922
|
--x-size-border-radius-bottom-left-tag-default: var(--x-size-border-radius-bottom-left-tag-card);
|
|
3916
3923
|
}
|
|
3917
|
-
:root {
|
|
3918
|
-
--x-size-border-radius-tag-card: var(--x-size-border-radius-base-s);
|
|
3919
|
-
--x-size-border-radius-top-left-tag-card: var(--x-size-border-radius-tag-card);
|
|
3920
|
-
--x-size-border-radius-top-right-tag-card: var(--x-size-border-radius-tag-card);
|
|
3921
|
-
--x-size-border-radius-bottom-right-tag-card: var(--x-size-border-radius-tag-card);
|
|
3922
|
-
--x-size-border-radius-bottom-left-tag-card: var(--x-size-border-radius-tag-card);
|
|
3923
|
-
}
|
|
3924
3924
|
[dir="ltr"] .x-tag {
|
|
3925
3925
|
border-left-width: var(--x-size-border-width-left-tag-default);
|
|
3926
3926
|
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-types](./x-types.md) > [ExtraParamsRequest](./x-types.extraparamsrequest.md) > [extraParams](./x-types.extraparamsrequest.extraparams.md)
|
|
4
|
+
|
|
5
|
+
## ExtraParamsRequest.extraParams property
|
|
6
|
+
|
|
7
|
+
<b>Signature:</b>
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
extraParams: {
|
|
11
|
+
[key: string]: unknown;
|
|
12
|
+
};
|
|
13
|
+
```
|
|
@@ -11,3 +11,10 @@ Interface to support extra params in any request.
|
|
|
11
11
|
```typescript
|
|
12
12
|
export interface ExtraParamsRequest
|
|
13
13
|
```
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
| Property | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| [extraParams](./x-types.extraparamsrequest.extraparams.md) | { \[key: string\]: unknown; } | |
|
|
20
|
+
|
|
@@ -9,7 +9,7 @@ Request for Next Queries endpoint.
|
|
|
9
9
|
<b>Signature:</b>
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
export interface NextQueriesRequest extends QueryableRequest, ExtraParamsRequest
|
|
12
|
+
export interface NextQueriesRequest extends QueryableRequest, PageableRequest, ExtraParamsRequest
|
|
13
13
|
```
|
|
14
|
-
<b>Extends:</b> [QueryableRequest](./x-types.queryablerequest.md)<!-- -->, [ExtraParamsRequest](./x-types.extraparamsrequest.md)
|
|
14
|
+
<b>Extends:</b> [QueryableRequest](./x-types.queryablerequest.md)<!-- -->, [PageableRequest](./x-types.pageablerequest.md)<!-- -->, [ExtraParamsRequest](./x-types.extraparamsrequest.md)
|
|
15
15
|
|
|
@@ -9,7 +9,7 @@ Request for Related Tags endpoint.
|
|
|
9
9
|
<b>Signature:</b>
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
export interface RelatedTagsRequest extends QueryableRequest, ExtraParamsRequest
|
|
12
|
+
export interface RelatedTagsRequest extends QueryableRequest, PageableRequest, ExtraParamsRequest
|
|
13
13
|
```
|
|
14
|
-
<b>Extends:</b> [QueryableRequest](./x-types.queryablerequest.md)<!-- -->, [ExtraParamsRequest](./x-types.extraparamsrequest.md)
|
|
14
|
+
<b>Extends:</b> [QueryableRequest](./x-types.queryablerequest.md)<!-- -->, [PageableRequest](./x-types.pageablerequest.md)<!-- -->, [ExtraParamsRequest](./x-types.extraparamsrequest.md)
|
|
15
15
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Interface X data privacy and browser local storage
|
|
3
|
+
tags:
|
|
4
|
+
- x components
|
|
5
|
+
- interface x
|
|
6
|
+
- cookies
|
|
7
|
+
- local storage
|
|
8
|
+
- history queries
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Interface X data privacy and browser local storage
|
|
12
|
+
|
|
13
|
+
Interface X for web _doesn't use cookies_ for storing data. The Interface X Components use the web browser's local storage to
|
|
14
|
+
save the technical data required to provide the services associated with the search & discovery experience. The data remains in the shopper's device until the expiration time is reached or the shopper chooses to delete it.
|
|
15
|
+
|
|
16
|
+
More specifically, Interface X Components store the following elements in the browser's local storage:
|
|
17
|
+
|
|
18
|
+
| Key | Duration | Purpose |
|
|
19
|
+
| -------------------- | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
20
|
+
| `x-session-id` | 30 minutes | Short-term session ID to be sent to the Tagging API. It identifies short sessions in a device. It does not identify individual shoppers in any way. It is required for [Analytics](https://docs.empathy.co/explore-empathy-platform/understand-data-privacy/), [Next Queries](https://docs.empathy.co/explore-empathy-platform/features/history-queries-overview.html), and [Related Tags](https://docs.empathy.co/explore-empathy-platform/features/related-tags-overview.html) features |
|
|
21
|
+
| `x-session-time-stamp` | 30 minutes | Timestamp for the current session ID |
|
|
22
|
+
| `x-history-queries` | Stored until the shopper clears/disables the feature | List of the searches performed that the shopper has chosen to store, which are shown in different steps of the search journey. |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@empathyco/x-components",
|
|
3
|
-
"version": "3.0.0-alpha.
|
|
3
|
+
"version": "3.0.0-alpha.109",
|
|
4
4
|
"description": "Empathy X Components",
|
|
5
5
|
"author": "Empathy Systems Corporation S.L.",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -59,12 +59,12 @@
|
|
|
59
59
|
"cypress:open:component": "cypress open-ct"
|
|
60
60
|
},
|
|
61
61
|
"dependencies": {
|
|
62
|
-
"@empathyco/x-adapter": "^7.0.0-alpha.
|
|
63
|
-
"@empathyco/x-deep-merge": "^1.3.0-alpha.
|
|
62
|
+
"@empathyco/x-adapter": "^7.0.0-alpha.32",
|
|
63
|
+
"@empathyco/x-deep-merge": "^1.3.0-alpha.17",
|
|
64
64
|
"@empathyco/x-logger": "^1.2.0-alpha.3",
|
|
65
65
|
"@empathyco/x-storage-service": "^2.0.0-alpha.2",
|
|
66
|
-
"@empathyco/x-types": "^10.0.0-alpha.
|
|
67
|
-
"@empathyco/x-utils": "^1.0.0-alpha.
|
|
66
|
+
"@empathyco/x-types": "^10.0.0-alpha.24",
|
|
67
|
+
"@empathyco/x-utils": "^1.0.0-alpha.3",
|
|
68
68
|
"@types/resize-observer-browser": "~0.1.5",
|
|
69
69
|
"reflect-metadata": "~0.1.13",
|
|
70
70
|
"rxjs": "~7.4.0",
|
|
@@ -125,5 +125,5 @@
|
|
|
125
125
|
"access": "public",
|
|
126
126
|
"directory": "dist"
|
|
127
127
|
},
|
|
128
|
-
"gitHead": "
|
|
128
|
+
"gitHead": "a4607573d2ad1f95ecf629f6f90e3e409b3286ed"
|
|
129
129
|
}
|
package/report/x-types.api.json
CHANGED
|
@@ -743,46 +743,30 @@
|
|
|
743
743
|
"name": "ExtraParamsRequest",
|
|
744
744
|
"members": [
|
|
745
745
|
{
|
|
746
|
-
"kind": "
|
|
747
|
-
"canonicalReference": "@empathyco/x-types!ExtraParamsRequest:
|
|
746
|
+
"kind": "PropertySignature",
|
|
747
|
+
"canonicalReference": "@empathyco/x-types!ExtraParamsRequest#extraParams:member",
|
|
748
748
|
"docComment": "",
|
|
749
749
|
"excerptTokens": [
|
|
750
750
|
{
|
|
751
751
|
"kind": "Content",
|
|
752
|
-
"text": "
|
|
753
|
-
},
|
|
754
|
-
{
|
|
755
|
-
"kind": "Content",
|
|
756
|
-
"text": "string"
|
|
752
|
+
"text": "extraParams: "
|
|
757
753
|
},
|
|
758
754
|
{
|
|
759
755
|
"kind": "Content",
|
|
760
|
-
"text": "]: "
|
|
761
|
-
},
|
|
762
|
-
{
|
|
763
|
-
"kind": "Content",
|
|
764
|
-
"text": "any"
|
|
756
|
+
"text": "{\n [key: string]: unknown;\n }"
|
|
765
757
|
},
|
|
766
758
|
{
|
|
767
759
|
"kind": "Content",
|
|
768
760
|
"text": ";"
|
|
769
761
|
}
|
|
770
762
|
],
|
|
771
|
-
"
|
|
772
|
-
"startIndex": 3,
|
|
773
|
-
"endIndex": 4
|
|
774
|
-
},
|
|
763
|
+
"isOptional": false,
|
|
775
764
|
"releaseTag": "Public",
|
|
776
|
-
"
|
|
777
|
-
"
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
"startIndex": 1,
|
|
782
|
-
"endIndex": 2
|
|
783
|
-
}
|
|
784
|
-
}
|
|
785
|
-
]
|
|
765
|
+
"name": "extraParams",
|
|
766
|
+
"propertyTypeTokenRange": {
|
|
767
|
+
"startIndex": 1,
|
|
768
|
+
"endIndex": 2
|
|
769
|
+
}
|
|
786
770
|
}
|
|
787
771
|
],
|
|
788
772
|
"extendsTokenRanges": []
|
|
@@ -2588,6 +2572,15 @@
|
|
|
2588
2572
|
"kind": "Content",
|
|
2589
2573
|
"text": ", "
|
|
2590
2574
|
},
|
|
2575
|
+
{
|
|
2576
|
+
"kind": "Reference",
|
|
2577
|
+
"text": "PageableRequest",
|
|
2578
|
+
"canonicalReference": "@empathyco/x-types!PageableRequest:interface"
|
|
2579
|
+
},
|
|
2580
|
+
{
|
|
2581
|
+
"kind": "Content",
|
|
2582
|
+
"text": ", "
|
|
2583
|
+
},
|
|
2591
2584
|
{
|
|
2592
2585
|
"kind": "Reference",
|
|
2593
2586
|
"text": "ExtraParamsRequest",
|
|
@@ -2608,7 +2601,11 @@
|
|
|
2608
2601
|
},
|
|
2609
2602
|
{
|
|
2610
2603
|
"startIndex": 3,
|
|
2611
|
-
"endIndex":
|
|
2604
|
+
"endIndex": 4
|
|
2605
|
+
},
|
|
2606
|
+
{
|
|
2607
|
+
"startIndex": 5,
|
|
2608
|
+
"endIndex": 7
|
|
2612
2609
|
}
|
|
2613
2610
|
]
|
|
2614
2611
|
},
|
|
@@ -4224,6 +4221,15 @@
|
|
|
4224
4221
|
"kind": "Content",
|
|
4225
4222
|
"text": ", "
|
|
4226
4223
|
},
|
|
4224
|
+
{
|
|
4225
|
+
"kind": "Reference",
|
|
4226
|
+
"text": "PageableRequest",
|
|
4227
|
+
"canonicalReference": "@empathyco/x-types!PageableRequest:interface"
|
|
4228
|
+
},
|
|
4229
|
+
{
|
|
4230
|
+
"kind": "Content",
|
|
4231
|
+
"text": ", "
|
|
4232
|
+
},
|
|
4227
4233
|
{
|
|
4228
4234
|
"kind": "Reference",
|
|
4229
4235
|
"text": "ExtraParamsRequest",
|
|
@@ -4244,7 +4250,11 @@
|
|
|
4244
4250
|
},
|
|
4245
4251
|
{
|
|
4246
4252
|
"startIndex": 3,
|
|
4247
|
-
"endIndex":
|
|
4253
|
+
"endIndex": 4
|
|
4254
|
+
},
|
|
4255
|
+
{
|
|
4256
|
+
"startIndex": 5,
|
|
4257
|
+
"endIndex": 7
|
|
4248
4258
|
}
|
|
4249
4259
|
]
|
|
4250
4260
|
},
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"mocked-adapter.d.ts","sourceRoot":"","sources":["../../../src/adapter/mocked-adapter.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"mocked-adapter.d.ts","sourceRoot":"","sources":["../../../src/adapter/mocked-adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EAMd,aAAa,EASd,MAAM,sBAAsB,CAAC;AAI9B,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,eAAe,EAAE,mBAAmB,CAAC;KACtC;CACF;AAED,aAAK,iBAAiB,GAClB,iBAAiB,GACjB,WAAW,GACX,0BAA0B,GAC1B,6BAA6B,CAAC;AAClC,oBAAY,eAAe,GAAG,IAAI,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAC;AAErE,oBAAY,sBAAsB,GAAG;KAClC,MAAM,IAAI,MAAM,eAAe,GAAG,UAAU,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,SAAS,OAAO,CACpF,MAAM,KAAK,CACZ,GACG,KAAK,GAAG,KAAK,GACb,KAAK;CACV,CAAC;AAEF,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC,sBAAsB,CAAC,CAAC;CAC5C;AAwCD,eAAO,MAAM,aAAa,gBAEjB,CAAC"}
|