@empathyco/x-components 3.0.0-alpha.414 → 3.0.0-alpha.415
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 +9 -0
- package/design-system/deprecated-full-theme.css +43 -43
- package/docs/API-reference/api/x-adapter-platform.experiencecontrolsendpointadapter.md +13 -0
- package/docs/API-reference/api/x-adapter-platform.experiencecontrolsrequestmapper.md +13 -0
- package/docs/API-reference/api/x-adapter-platform.experiencecontrolsrequestschema.md +13 -0
- package/docs/API-reference/api/x-adapter-platform.experiencecontrolsresponsemapper.md +13 -0
- package/docs/API-reference/api/x-adapter-platform.experiencecontrolsresponseschema.md +13 -0
- package/docs/API-reference/api/x-adapter-platform.md +7 -0
- package/docs/API-reference/api/x-adapter-platform.platformadapter.experiencecontrols.md +11 -0
- package/docs/API-reference/api/x-adapter-platform.platformexperiencecontrolsrequest.md +15 -0
- package/docs/API-reference/api/x-adapter-platform.platformexperiencecontrolsresponse.md +15 -0
- package/docs/API-reference/api/x-components.xeventstypes.md +2 -2
- package/docs/API-reference/api/x-components.xmodulestree.experiencecontrols.md +11 -0
- package/docs/API-reference/api/x-components.xmodulestree.md +1 -0
- package/docs/API-reference/api/x-types.experiencecontrolsrequest.md +15 -0
- package/docs/API-reference/api/x-types.experiencecontrolsresponse.controls.md +11 -0
- package/docs/API-reference/api/x-types.experiencecontrolsresponse.events.md +11 -0
- package/docs/API-reference/api/x-types.experiencecontrolsresponse.md +21 -0
- package/docs/API-reference/api/x-types.md +2 -0
- package/docs/API-reference/api/x-types.xcomponentsadapter.experiencecontrols.md +11 -0
- package/docs/API-reference/api/x-types.xcomponentsadapter.md +1 -0
- package/docs/API-reference/components/experience-controls/x-components.experience-controls.md +30 -0
- package/js/store/x.module.js +2 -1
- package/js/store/x.module.js.map +1 -1
- package/package.json +4 -4
- package/report/x-adapter-platform.api.json +366 -0
- package/report/x-components.api.json +41 -0
- package/report/x-components.api.md +7 -1
- package/report/x-types.api.json +163 -0
- package/types/adapter/e2e-adapter.d.ts.map +1 -1
- package/types/store/x.module.d.ts.map +1 -1
- package/types/views/adapter.d.ts.map +1 -1
- package/types/wiring/events.types.d.ts +2 -1
- package/types/wiring/events.types.d.ts.map +1 -1
- package/types/x-modules/experience-controls/events.types.d.ts +12 -0
- package/types/x-modules/experience-controls/events.types.d.ts.map +1 -0
- package/types/x-modules/experience-controls/store/actions/fetch-and-save-experience-controls.action.d.ts +15 -0
- package/types/x-modules/experience-controls/store/actions/fetch-and-save-experience-controls.action.d.ts.map +1 -0
- package/types/x-modules/experience-controls/store/actions/fetch-experience-controls.action.d.ts +13 -0
- package/types/x-modules/experience-controls/store/actions/fetch-experience-controls.action.d.ts.map +1 -0
- package/types/x-modules/experience-controls/store/emitters.d.ts +12 -0
- package/types/x-modules/experience-controls/store/emitters.d.ts.map +1 -0
- package/types/x-modules/experience-controls/store/getters/experience-controls-results-request.getter.d.ts +13 -0
- package/types/x-modules/experience-controls/store/getters/experience-controls-results-request.getter.d.ts.map +1 -0
- package/types/x-modules/experience-controls/store/module.d.ts +8 -0
- package/types/x-modules/experience-controls/store/module.d.ts.map +1 -0
- package/types/x-modules/experience-controls/store/types.d.ts +84 -0
- package/types/x-modules/experience-controls/store/types.d.ts.map +1 -0
- package/types/x-modules/experience-controls/wiring.d.ts +26 -0
- package/types/x-modules/experience-controls/wiring.d.ts.map +1 -0
- package/types/x-modules/experience-controls/x-module.d.ts +16 -0
- package/types/x-modules/experience-controls/x-module.d.ts.map +1 -0
- package/types/x-modules/x-modules.types.d.ts +2 -0
- package/types/x-modules/x-modules.types.d.ts.map +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,15 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [3.0.0-alpha.415](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.414...@empathyco/x-components@3.0.0-alpha.415) (2023-10-04)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Features
|
|
10
|
+
|
|
11
|
+
* **experience-controls:** experience controls module and adapter (#1307) ([6ae3f6b](https://github.com/empathyco/x/commit/6ae3f6b3d537910781dbfebf3b2e670eff391911))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
6
15
|
## [3.0.0-alpha.414](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.413...@empathyco/x-components@3.0.0-alpha.414) (2023-09-22)
|
|
7
16
|
|
|
8
17
|
|
|
@@ -6761,6 +6761,49 @@
|
|
|
6761
6761
|
--x-size-border-width-bottom-input-group-line: var(--x-size-border-width-input-group-line);
|
|
6762
6762
|
--x-size-border-width-left-input-group-line: 0;
|
|
6763
6763
|
}
|
|
6764
|
+
:root {
|
|
6765
|
+
--x-color-background-input-group-default: var(--x-color-background-input-default);
|
|
6766
|
+
--x-color-border-input-group-default: var(--x-color-border-input-default);
|
|
6767
|
+
--x-color-border-input-group-default-focus: var(--x-color-border-input-default-focus);
|
|
6768
|
+
--x-color-text-input-group-default: var(--x-color-text-input-default);
|
|
6769
|
+
--x-color-text-input-group-placeholder-default: var(--x-color-text-input-placeholder-default);
|
|
6770
|
+
--x-size-height-input-group-default: var(--x-size-height-input-default);
|
|
6771
|
+
--x-size-gap-input-group-default: var(--x-size-base-03);
|
|
6772
|
+
--x-size-padding-left-input-group-default: var(--x-size-base-06);
|
|
6773
|
+
--x-size-padding-right-input-group-default: var(--x-size-padding-left-input-group-default);
|
|
6774
|
+
--x-size-padding-input-group-default-action: var(--x-size-base-03);
|
|
6775
|
+
--x-size-border-width-input-group-default: var(--x-size-border-width-input-default);
|
|
6776
|
+
--x-size-border-width-top-input-group-default: var(--x-size-border-width-input-group-default);
|
|
6777
|
+
--x-size-border-width-right-input-group-default: var(--x-size-border-width-input-group-default);
|
|
6778
|
+
--x-size-border-width-bottom-input-group-default: var(--x-size-border-width-input-group-default);
|
|
6779
|
+
--x-size-border-width-left-input-group-default: var(--x-size-border-width-input-group-default);
|
|
6780
|
+
--x-size-border-radius-input-group-default: var(--x-size-border-radius-input-default);
|
|
6781
|
+
--x-size-border-radius-top-left-input-group-default: var(
|
|
6782
|
+
--x-size-border-radius-input-group-default
|
|
6783
|
+
);
|
|
6784
|
+
--x-size-border-radius-top-right-input-group-default: var(
|
|
6785
|
+
--x-size-border-radius-input-group-default
|
|
6786
|
+
);
|
|
6787
|
+
--x-size-border-radius-bottom-right-input-group-default: var(
|
|
6788
|
+
--x-size-border-radius-input-group-default
|
|
6789
|
+
);
|
|
6790
|
+
--x-size-border-radius-bottom-left-input-group-default: var(
|
|
6791
|
+
--x-size-border-radius-input-group-default
|
|
6792
|
+
);
|
|
6793
|
+
--x-font-family-input-group-default: var(--x-font-family-input-default);
|
|
6794
|
+
--x-size-font-input-group-default: var(--x-size-font-input-default);
|
|
6795
|
+
--x-size-line-height-input-group-default: var(--x-size-line-height-input-default);
|
|
6796
|
+
--x-number-font-weight-input-group-default: var(--x-number-font-weight-input-default);
|
|
6797
|
+
--x-font-family-input-group-placeholder-default: var(--x-font-family-input-group-default);
|
|
6798
|
+
--x-size-font-input-group-placeholder-default: var(--x-size-font-input-group-default);
|
|
6799
|
+
--x-size-line-height-input-group-placeholder-default: var(
|
|
6800
|
+
--x-size-line-height-input-group-default
|
|
6801
|
+
);
|
|
6802
|
+
--x-number-font-weight-input-group-placeholder-default: var(
|
|
6803
|
+
--x-number-font-weight-input-group-default
|
|
6804
|
+
);
|
|
6805
|
+
--x-number-font-weight-input-group-default-button: var(--x-number-font-weight-base-light);
|
|
6806
|
+
}
|
|
6764
6807
|
:root {
|
|
6765
6808
|
--x-size-padding-left-input-group-line: 0;
|
|
6766
6809
|
--x-size-padding-right-input-group-line: 0;
|
|
@@ -6855,49 +6898,6 @@
|
|
|
6855
6898
|
);
|
|
6856
6899
|
--x-number-font-weight-input-group-default-button: var(--x-number-font-weight-base-light);
|
|
6857
6900
|
}
|
|
6858
|
-
:root {
|
|
6859
|
-
--x-color-background-input-group-default: var(--x-color-background-input-default);
|
|
6860
|
-
--x-color-border-input-group-default: var(--x-color-border-input-default);
|
|
6861
|
-
--x-color-border-input-group-default-focus: var(--x-color-border-input-default-focus);
|
|
6862
|
-
--x-color-text-input-group-default: var(--x-color-text-input-default);
|
|
6863
|
-
--x-color-text-input-group-placeholder-default: var(--x-color-text-input-placeholder-default);
|
|
6864
|
-
--x-size-height-input-group-default: var(--x-size-height-input-default);
|
|
6865
|
-
--x-size-gap-input-group-default: var(--x-size-base-03);
|
|
6866
|
-
--x-size-padding-left-input-group-default: var(--x-size-base-06);
|
|
6867
|
-
--x-size-padding-right-input-group-default: var(--x-size-padding-left-input-group-default);
|
|
6868
|
-
--x-size-padding-input-group-default-action: var(--x-size-base-03);
|
|
6869
|
-
--x-size-border-width-input-group-default: var(--x-size-border-width-input-default);
|
|
6870
|
-
--x-size-border-width-top-input-group-default: var(--x-size-border-width-input-group-default);
|
|
6871
|
-
--x-size-border-width-right-input-group-default: var(--x-size-border-width-input-group-default);
|
|
6872
|
-
--x-size-border-width-bottom-input-group-default: var(--x-size-border-width-input-group-default);
|
|
6873
|
-
--x-size-border-width-left-input-group-default: var(--x-size-border-width-input-group-default);
|
|
6874
|
-
--x-size-border-radius-input-group-default: var(--x-size-border-radius-input-default);
|
|
6875
|
-
--x-size-border-radius-top-left-input-group-default: var(
|
|
6876
|
-
--x-size-border-radius-input-group-default
|
|
6877
|
-
);
|
|
6878
|
-
--x-size-border-radius-top-right-input-group-default: var(
|
|
6879
|
-
--x-size-border-radius-input-group-default
|
|
6880
|
-
);
|
|
6881
|
-
--x-size-border-radius-bottom-right-input-group-default: var(
|
|
6882
|
-
--x-size-border-radius-input-group-default
|
|
6883
|
-
);
|
|
6884
|
-
--x-size-border-radius-bottom-left-input-group-default: var(
|
|
6885
|
-
--x-size-border-radius-input-group-default
|
|
6886
|
-
);
|
|
6887
|
-
--x-font-family-input-group-default: var(--x-font-family-input-default);
|
|
6888
|
-
--x-size-font-input-group-default: var(--x-size-font-input-default);
|
|
6889
|
-
--x-size-line-height-input-group-default: var(--x-size-line-height-input-default);
|
|
6890
|
-
--x-number-font-weight-input-group-default: var(--x-number-font-weight-input-default);
|
|
6891
|
-
--x-font-family-input-group-placeholder-default: var(--x-font-family-input-group-default);
|
|
6892
|
-
--x-size-font-input-group-placeholder-default: var(--x-size-font-input-group-default);
|
|
6893
|
-
--x-size-line-height-input-group-placeholder-default: var(
|
|
6894
|
-
--x-size-line-height-input-group-default
|
|
6895
|
-
);
|
|
6896
|
-
--x-number-font-weight-input-group-placeholder-default: var(
|
|
6897
|
-
--x-number-font-weight-input-group-default
|
|
6898
|
-
);
|
|
6899
|
-
--x-number-font-weight-input-group-default-button: var(--x-number-font-weight-base-light);
|
|
6900
|
-
}
|
|
6901
6901
|
|
|
6902
6902
|
[dir="ltr"] .x-input-group {
|
|
6903
6903
|
border-right-width: var(--x-size-border-width-right-input-group-default);
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-adapter-platform](./x-adapter-platform.md) > [experienceControlsEndpointAdapter](./x-adapter-platform.experiencecontrolsendpointadapter.md)
|
|
4
|
+
|
|
5
|
+
## experienceControlsEndpointAdapter variable
|
|
6
|
+
|
|
7
|
+
. Default adapter for the experience controls endpoint.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
experienceControlsEndpointAdapter: import("@empathyco/x-adapter").ExtendableEndpointAdapter<ExperienceControlsRequest, ExperienceControlsResponse>
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-adapter-platform](./x-adapter-platform.md) > [experienceControlsRequestMapper](./x-adapter-platform.experiencecontrolsrequestmapper.md)
|
|
4
|
+
|
|
5
|
+
## experienceControlsRequestMapper variable
|
|
6
|
+
|
|
7
|
+
Default implementation for the ExperienceControlsRequestMapper.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
experienceControlsRequestMapper: import("@empathyco/x-adapter").Mapper<ExperienceControlsRequest, PlatformExperienceControlsRequest>
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-adapter-platform](./x-adapter-platform.md) > [experienceControlsRequestSchema](./x-adapter-platform.experiencecontrolsrequestschema.md)
|
|
4
|
+
|
|
5
|
+
## experienceControlsRequestSchema variable
|
|
6
|
+
|
|
7
|
+
Default implementation for the ExperienceControlsRequestSchema.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
experienceControlsRequestSchema: import("@empathyco/x-adapter").MutableSchema<ExperienceControlsRequest, PlatformExperienceControlsRequest>
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-adapter-platform](./x-adapter-platform.md) > [experienceControlsResponseMapper](./x-adapter-platform.experiencecontrolsresponsemapper.md)
|
|
4
|
+
|
|
5
|
+
## experienceControlsResponseMapper variable
|
|
6
|
+
|
|
7
|
+
Default implementation for the ExperienceControlsResponseMapper.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
experienceControlsResponseMapper: import("@empathyco/x-adapter").Mapper<PlatformExperienceControlsResponse, ExperienceControlsResponse>
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-adapter-platform](./x-adapter-platform.md) > [experienceControlsResponseSchema](./x-adapter-platform.experiencecontrolsresponseschema.md)
|
|
4
|
+
|
|
5
|
+
## experienceControlsResponseSchema variable
|
|
6
|
+
|
|
7
|
+
Default implementation for the ExperienceControlsResponseSchema.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
experienceControlsResponseSchema: import("@empathyco/x-adapter").MutableSchema<PlatformExperienceControlsResponse, ExperienceControlsResponse>
|
|
13
|
+
```
|
|
@@ -20,6 +20,8 @@
|
|
|
20
20
|
| [FacetConfig](./x-adapter-platform.facetconfig.md) | Facet configuration containing the model name and the schema. |
|
|
21
21
|
| [PlatformAdapter](./x-adapter-platform.platformadapter.md) | Platform adapter interface. |
|
|
22
22
|
| [PlatformBanner](./x-adapter-platform.platformbanner.md) | Banner model for the <code>platform</code> API. |
|
|
23
|
+
| [PlatformExperienceControlsRequest](./x-adapter-platform.platformexperiencecontrolsrequest.md) | Request for the <code>experience controls</code> endpoint. |
|
|
24
|
+
| [PlatformExperienceControlsResponse](./x-adapter-platform.platformexperiencecontrolsresponse.md) | Response for the <code>experience controls</code> endpoint. |
|
|
23
25
|
| [PlatformFacet](./x-adapter-platform.platformfacet.md) | Facet model for the <code>platform</code> API. |
|
|
24
26
|
| [PlatformFilter](./x-adapter-platform.platformfilter.md) | Filter model for the <code>platform</code> API. |
|
|
25
27
|
| [PlatformHierarchicalFilter](./x-adapter-platform.platformhierarchicalfilter.md) | HierarchicalFilter model for the <code>platform</code> API. |
|
|
@@ -54,6 +56,11 @@
|
|
|
54
56
|
| Variable | Description |
|
|
55
57
|
| --- | --- |
|
|
56
58
|
| [bannerSchema](./x-adapter-platform.bannerschema.md) | Default implementation for the BannerSchema. |
|
|
59
|
+
| [experienceControlsEndpointAdapter](./x-adapter-platform.experiencecontrolsendpointadapter.md) | . Default adapter for the experience controls endpoint. |
|
|
60
|
+
| [experienceControlsRequestMapper](./x-adapter-platform.experiencecontrolsrequestmapper.md) | Default implementation for the ExperienceControlsRequestMapper. |
|
|
61
|
+
| [experienceControlsRequestSchema](./x-adapter-platform.experiencecontrolsrequestschema.md) | Default implementation for the ExperienceControlsRequestSchema. |
|
|
62
|
+
| [experienceControlsResponseMapper](./x-adapter-platform.experiencecontrolsresponsemapper.md) | Default implementation for the ExperienceControlsResponseMapper. |
|
|
63
|
+
| [experienceControlsResponseSchema](./x-adapter-platform.experiencecontrolsresponseschema.md) | Default implementation for the ExperienceControlsResponseSchema. |
|
|
57
64
|
| [facetSchema](./x-adapter-platform.facetschema.md) | Default implementation for the FacetSchema. |
|
|
58
65
|
| [hierarchicalFilterSchema](./x-adapter-platform.hierarchicalfilterschema.md) | Default implementation for the HierarchicalFilterSchema. |
|
|
59
66
|
| [identifierResultsEndpointAdapter](./x-adapter-platform.identifierresultsendpointadapter.md) | Default adapter for the identifier results endpoint. |
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-adapter-platform](./x-adapter-platform.md) > [PlatformAdapter](./x-adapter-platform.platformadapter.md) > [experienceControls](./x-adapter-platform.platformadapter.experiencecontrols.md)
|
|
4
|
+
|
|
5
|
+
## PlatformAdapter.experienceControls property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
experienceControls: ExtendableEndpointAdapter<ExperienceControlsRequest, ExperienceControlsResponse>;
|
|
11
|
+
```
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-adapter-platform](./x-adapter-platform.md) > [PlatformExperienceControlsRequest](./x-adapter-platform.platformexperiencecontrolsrequest.md)
|
|
4
|
+
|
|
5
|
+
## PlatformExperienceControlsRequest interface
|
|
6
|
+
|
|
7
|
+
Request for the `experience controls` endpoint.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface PlatformExperienceControlsRequest extends PlatformExtraParamsRequest
|
|
13
|
+
```
|
|
14
|
+
**Extends:** PlatformExtraParamsRequest
|
|
15
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-adapter-platform](./x-adapter-platform.md) > [PlatformExperienceControlsResponse](./x-adapter-platform.platformexperiencecontrolsresponse.md)
|
|
4
|
+
|
|
5
|
+
## PlatformExperienceControlsResponse interface
|
|
6
|
+
|
|
7
|
+
Response for the `experience controls` endpoint.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface PlatformExperienceControlsResponse extends Dictionary<unknown>
|
|
13
|
+
```
|
|
14
|
+
**Extends:** Dictionary<unknown>
|
|
15
|
+
|
|
@@ -9,9 +9,9 @@
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
export interface XEventsTypes extends DeviceXEvents, EmpathizeXEvents, ExtraParamsXEvents, FacetsXEvents, HistoryQueriesXEvents, IdentifierResultsXEvents, NextQueriesXEvents, PopularSearchesXEvents, QueriesPreviewXEvents, QuerySuggestionsXEvents, RecommendationsXEvents, RelatedTagsXEvents, ScrollXEvents, SearchBoxXEvents, SearchXEvents, SemanticQueriesXEvents, TaggingXEvents, UrlXEvents
|
|
12
|
+
export interface XEventsTypes extends DeviceXEvents, EmpathizeXEvents, ExtraParamsXEvents, FacetsXEvents, HistoryQueriesXEvents, IdentifierResultsXEvents, NextQueriesXEvents, PopularSearchesXEvents, QueriesPreviewXEvents, QuerySuggestionsXEvents, RecommendationsXEvents, RelatedTagsXEvents, ScrollXEvents, SearchBoxXEvents, SearchXEvents, SemanticQueriesXEvents, TaggingXEvents, ExperienceControlsXEvents, UrlXEvents
|
|
13
13
|
```
|
|
14
|
-
**Extends:** [DeviceXEvents](./x-components.devicexevents.md)<!-- -->, [EmpathizeXEvents](./x-components.empathizexevents.md)<!-- -->, [ExtraParamsXEvents](./x-components.extraparamsxevents.md)<!-- -->, [FacetsXEvents](./x-components.facetsxevents.md)<!-- -->, [HistoryQueriesXEvents](./x-components.historyqueriesxevents.md)<!-- -->, [IdentifierResultsXEvents](./x-components.identifierresultsxevents.md)<!-- -->, [NextQueriesXEvents](./x-components.nextqueriesxevents.md)<!-- -->, [PopularSearchesXEvents](./x-components.popularsearchesxevents.md)<!-- -->, [QueriesPreviewXEvents](./x-components.queriespreviewxevents.md)<!-- -->, [QuerySuggestionsXEvents](./x-components.querysuggestionsxevents.md)<!-- -->, [RecommendationsXEvents](./x-components.recommendationsxevents.md)<!-- -->, [RelatedTagsXEvents](./x-components.relatedtagsxevents.md)<!-- -->, [ScrollXEvents](./x-components.scrollxevents.md)<!-- -->, [SearchBoxXEvents](./x-components.searchboxxevents.md)<!-- -->, [SearchXEvents](./x-components.searchxevents.md)<!-- -->, [SemanticQueriesXEvents](./x-components.semanticqueriesxevents.md)<!-- -->, [TaggingXEvents](./x-components.taggingxevents.md)<!-- -->, [UrlXEvents](./x-components.urlxevents.md)
|
|
14
|
+
**Extends:** [DeviceXEvents](./x-components.devicexevents.md)<!-- -->, [EmpathizeXEvents](./x-components.empathizexevents.md)<!-- -->, [ExtraParamsXEvents](./x-components.extraparamsxevents.md)<!-- -->, [FacetsXEvents](./x-components.facetsxevents.md)<!-- -->, [HistoryQueriesXEvents](./x-components.historyqueriesxevents.md)<!-- -->, [IdentifierResultsXEvents](./x-components.identifierresultsxevents.md)<!-- -->, [NextQueriesXEvents](./x-components.nextqueriesxevents.md)<!-- -->, [PopularSearchesXEvents](./x-components.popularsearchesxevents.md)<!-- -->, [QueriesPreviewXEvents](./x-components.queriespreviewxevents.md)<!-- -->, [QuerySuggestionsXEvents](./x-components.querysuggestionsxevents.md)<!-- -->, [RecommendationsXEvents](./x-components.recommendationsxevents.md)<!-- -->, [RelatedTagsXEvents](./x-components.relatedtagsxevents.md)<!-- -->, [ScrollXEvents](./x-components.scrollxevents.md)<!-- -->, [SearchBoxXEvents](./x-components.searchboxxevents.md)<!-- -->, [SearchXEvents](./x-components.searchxevents.md)<!-- -->, [SemanticQueriesXEvents](./x-components.semanticqueriesxevents.md)<!-- -->, [TaggingXEvents](./x-components.taggingxevents.md)<!-- -->, ExperienceControlsXEvents, [UrlXEvents](./x-components.urlxevents.md)
|
|
15
15
|
|
|
16
16
|
## Remarks
|
|
17
17
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [XModulesTree](./x-components.xmodulestree.md) > [experienceControls](./x-components.xmodulestree.experiencecontrols.md)
|
|
4
|
+
|
|
5
|
+
## XModulesTree.experienceControls property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
experienceControls: ExperienceControlsXModule;
|
|
11
|
+
```
|
|
@@ -18,6 +18,7 @@ export interface XModulesTree
|
|
|
18
18
|
| --- | --- | --- | --- |
|
|
19
19
|
| [device](./x-components.xmodulestree.device.md) | | [DeviceXModule](./x-components.devicexmodule.md) | |
|
|
20
20
|
| [empathize](./x-components.xmodulestree.empathize.md) | | [EmpathizeXModule](./x-components.empathizexmodule.md) | |
|
|
21
|
+
| [experienceControls](./x-components.xmodulestree.experiencecontrols.md) | | ExperienceControlsXModule | |
|
|
21
22
|
| [extraParams](./x-components.xmodulestree.extraparams.md) | | [ExtraParamsXModule](./x-components.extraparamsxmodule.md) | |
|
|
22
23
|
| [facets](./x-components.xmodulestree.facets.md) | | [FacetsXModule](./x-components.facetsxmodule.md) | |
|
|
23
24
|
| [historyQueries](./x-components.xmodulestree.historyqueries.md) | | [HistoryQueriesXModule](./x-components.historyqueriesxmodule.md) | |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-types](./x-types.md) > [ExperienceControlsRequest](./x-types.experiencecontrolsrequest.md)
|
|
4
|
+
|
|
5
|
+
## ExperienceControlsRequest interface
|
|
6
|
+
|
|
7
|
+
Request for Experience Controls endpoint.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface ExperienceControlsRequest extends ExtraParamsRequest
|
|
13
|
+
```
|
|
14
|
+
**Extends:** [ExtraParamsRequest](./x-types.extraparamsrequest.md)
|
|
15
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-types](./x-types.md) > [ExperienceControlsResponse](./x-types.experiencecontrolsresponse.md) > [controls](./x-types.experiencecontrolsresponse.controls.md)
|
|
4
|
+
|
|
5
|
+
## ExperienceControlsResponse.controls property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
controls: Dictionary<unknown>;
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-types](./x-types.md) > [ExperienceControlsResponse](./x-types.experiencecontrolsresponse.md) > [events](./x-types.experiencecontrolsresponse.events.md)
|
|
4
|
+
|
|
5
|
+
## ExperienceControlsResponse.events property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
events: Dictionary<unknown>;
|
|
11
|
+
```
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-types](./x-types.md) > [ExperienceControlsResponse](./x-types.experiencecontrolsresponse.md)
|
|
4
|
+
|
|
5
|
+
## ExperienceControlsResponse interface
|
|
6
|
+
|
|
7
|
+
Response for the experience controls endpoint.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface ExperienceControlsResponse
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
| Property | Modifiers | Type | Description |
|
|
18
|
+
| --- | --- | --- | --- |
|
|
19
|
+
| [controls](./x-types.experiencecontrolsresponse.controls.md) | | Dictionary<unknown> | |
|
|
20
|
+
| [events](./x-types.experiencecontrolsresponse.events.md) | | Dictionary<unknown> | |
|
|
21
|
+
|
|
@@ -34,6 +34,8 @@ Entry point to export search-type models and testing schemas in a unified api-ex
|
|
|
34
34
|
| [BooleanFilter](./x-types.booleanfilter.md) | A boolean filter used in a [FacetFilter](./x-types.facetfilter.md)<!-- -->, which status can be selected or not and it may contains the total results number that the filter should return. |
|
|
35
35
|
| [EditableNumberRangeFacet](./x-types.editablenumberrangefacet.md) | Editable Number Range Facet is a trait for filtering results using user editable [RangeValue](./x-types.rangevalue.md)<!-- -->.Editable means that the value max and min can be changed by the user instead of havingseveral boolean filters with different values. It extends from [Facet](./x-types.facet.md)<!-- -->,changes the modelName and uses [EditableNumberRangeFilter](./x-types.editablenumberrangefilter.md) as filters. |
|
|
36
36
|
| [EditableNumberRangeFilter](./x-types.editablenumberrangefilter.md) | A type of filter used in [EditableNumberRangeFacet](./x-types.editablenumberrangefacet.md) and extends from [FacetFilter](./x-types.facetfilter.md)<!-- -->. This filter has the particularity that its [RangeValue](./x-types.rangevalue.md) is editable by the user. Editable means that the value max and min can be changed by the user instead of having several boolean filters with different values. |
|
|
37
|
+
| [ExperienceControlsRequest](./x-types.experiencecontrolsrequest.md) | Request for Experience Controls endpoint. |
|
|
38
|
+
| [ExperienceControlsResponse](./x-types.experiencecontrolsresponse.md) | Response for the experience controls endpoint. |
|
|
37
39
|
| [ExtraParamsRequest](./x-types.extraparamsrequest.md) | Interface to support extra params in any request. |
|
|
38
40
|
| [Facet](./x-types.facet.md) | Facet is a trait for filtering results. It uses [Filter](./x-types.filter.md) as filters. |
|
|
39
41
|
| [FacetFilter](./x-types.facetfilter.md) | A filter which is associated with a [Facet](./x-types.facet.md)<!-- -->. |
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-types](./x-types.md) > [XComponentsAdapter](./x-types.xcomponentsadapter.md) > [experienceControls](./x-types.xcomponentsadapter.experiencecontrols.md)
|
|
4
|
+
|
|
5
|
+
## XComponentsAdapter.experienceControls property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
experienceControls: EndpointAdapter<ExperienceControlsRequest, ExperienceControlsResponse>;
|
|
11
|
+
```
|
|
@@ -14,6 +14,7 @@ export interface XComponentsAdapter
|
|
|
14
14
|
|
|
15
15
|
| Property | Modifiers | Type | Description |
|
|
16
16
|
| --- | --- | --- | --- |
|
|
17
|
+
| [experienceControls](./x-types.xcomponentsadapter.experiencecontrols.md) | | EndpointAdapter<[ExperienceControlsRequest](./x-types.experiencecontrolsrequest.md)<!-- -->, [ExperienceControlsResponse](./x-types.experiencecontrolsresponse.md)<!-- -->> | |
|
|
17
18
|
| [identifierResults](./x-types.xcomponentsadapter.identifierresults.md) | | EndpointAdapter<[IdentifierResultsRequest](./x-types.identifierresultsrequest.md)<!-- -->, [IdentifierResultsResponse](./x-types.identifierresultsresponse.md)<!-- -->> | |
|
|
18
19
|
| [nextQueries](./x-types.xcomponentsadapter.nextqueries.md) | | EndpointAdapter<[NextQueriesRequest](./x-types.nextqueriesrequest.md)<!-- -->, [NextQueriesResponse](./x-types.nextqueriesresponse.md)<!-- -->> | |
|
|
19
20
|
| [popularSearches](./x-types.xcomponentsadapter.popularsearches.md) | | EndpointAdapter<[PopularSearchesRequest](./x-types.popularsearchesrequest.md)<!-- -->, [PopularSearchesResponse](./x-types.popularsearchesresponse.md)<!-- -->> | |
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
|
|
3
|
+
title: ExperienceControls
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# ExperienceControls
|
|
8
|
+
|
|
9
|
+
This component subscribes to changes in the ExperienceControls module to fire the events that
|
|
10
|
+
propagate the configuration.
|
|
11
|
+
|
|
12
|
+
## Examples
|
|
13
|
+
|
|
14
|
+
This component will fire the events received in the `ExperienceControlsEventsChanged` event.
|
|
15
|
+
|
|
16
|
+
```vue
|
|
17
|
+
<template>
|
|
18
|
+
<ExperienceControls />
|
|
19
|
+
</template>
|
|
20
|
+
<script>
|
|
21
|
+
import { ExperienceControls } from '@empathyco/x-components/experience-controls';
|
|
22
|
+
|
|
23
|
+
export default {
|
|
24
|
+
name: 'ExperienceControlsDemo',
|
|
25
|
+
components: {
|
|
26
|
+
ExperienceControls
|
|
27
|
+
}
|
|
28
|
+
};
|
|
29
|
+
</script>
|
|
30
|
+
```
|
package/js/store/x.module.js
CHANGED
package/js/store/x.module.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"x.module.js","sources":["../../../src/store/x.module.ts"],"sourcesContent":["import { Module } from 'vuex';\nimport { RootXStoreState } from './store.types';\n\n/**\n * The type of the x module state has a property for each other sub-module assigned to `null`,\n * so we can avoid re-executing getters every time\n * the `store.registerModule` method is called.\n *\n * @internal\n */\nexport type XModuleState = { [Key in keyof RootXStoreState['x']]: null };\n\n/**\n * The main module of the X Store. All of the other {@link XModule | XModules} will be\n * registered as a sub-module of this one.\n *\n * @internal\n */\nexport const RootXStoreModule: Module<XModuleState, any> = {\n state: () => ({\n device: null,\n empathize: null,\n extraParams: null,\n facets: null,\n historyQueries: null,\n identifierResults: null,\n nextQueries: null,\n popularSearches: null,\n queriesPreview: null,\n querySuggestions: null,\n recommendations: null,\n relatedTags: null,\n scroll: null,\n search: null,\n searchBox: null,\n semanticQueries: null,\n tagging: null,\n url: null\n }),\n namespaced: true\n};\n"],"names":[],"mappings":"AAYA;;;;;AAKG;AACU,MAAA,gBAAgB,GAA8B;AACzD,IAAA,KAAK,EAAE,OAAO;AACZ,QAAA,MAAM,EAAE,IAAI;AACZ,QAAA,SAAS,EAAE,IAAI;AACf,QAAA,WAAW,EAAE,IAAI;AACjB,QAAA,MAAM,EAAE,IAAI;AACZ,QAAA,cAAc,EAAE,IAAI;AACpB,QAAA,iBAAiB,EAAE,IAAI;AACvB,QAAA,WAAW,EAAE,IAAI;AACjB,QAAA,eAAe,EAAE,IAAI;AACrB,QAAA,cAAc,EAAE,IAAI;AACpB,QAAA,gBAAgB,EAAE,IAAI;AACtB,QAAA,eAAe,EAAE,IAAI;AACrB,QAAA,WAAW,EAAE,IAAI;AACjB,QAAA,MAAM,EAAE,IAAI;AACZ,QAAA,MAAM,EAAE,IAAI;AACZ,QAAA,SAAS,EAAE,IAAI;AACf,QAAA,eAAe,EAAE,IAAI;AACrB,QAAA,OAAO,EAAE,IAAI;AACb,QAAA,GAAG,EAAE,IAAI;
|
|
1
|
+
{"version":3,"file":"x.module.js","sources":["../../../src/store/x.module.ts"],"sourcesContent":["import { Module } from 'vuex';\nimport { RootXStoreState } from './store.types';\n\n/**\n * The type of the x module state has a property for each other sub-module assigned to `null`,\n * so we can avoid re-executing getters every time\n * the `store.registerModule` method is called.\n *\n * @internal\n */\nexport type XModuleState = { [Key in keyof RootXStoreState['x']]: null };\n\n/**\n * The main module of the X Store. All of the other {@link XModule | XModules} will be\n * registered as a sub-module of this one.\n *\n * @internal\n */\nexport const RootXStoreModule: Module<XModuleState, any> = {\n state: () => ({\n device: null,\n empathize: null,\n extraParams: null,\n facets: null,\n historyQueries: null,\n identifierResults: null,\n nextQueries: null,\n popularSearches: null,\n queriesPreview: null,\n querySuggestions: null,\n recommendations: null,\n relatedTags: null,\n scroll: null,\n search: null,\n searchBox: null,\n semanticQueries: null,\n tagging: null,\n url: null,\n experienceControls: null\n }),\n namespaced: true\n};\n"],"names":[],"mappings":"AAYA;;;;;AAKG;AACU,MAAA,gBAAgB,GAA8B;AACzD,IAAA,KAAK,EAAE,OAAO;AACZ,QAAA,MAAM,EAAE,IAAI;AACZ,QAAA,SAAS,EAAE,IAAI;AACf,QAAA,WAAW,EAAE,IAAI;AACjB,QAAA,MAAM,EAAE,IAAI;AACZ,QAAA,cAAc,EAAE,IAAI;AACpB,QAAA,iBAAiB,EAAE,IAAI;AACvB,QAAA,WAAW,EAAE,IAAI;AACjB,QAAA,eAAe,EAAE,IAAI;AACrB,QAAA,cAAc,EAAE,IAAI;AACpB,QAAA,gBAAgB,EAAE,IAAI;AACtB,QAAA,eAAe,EAAE,IAAI;AACrB,QAAA,WAAW,EAAE,IAAI;AACjB,QAAA,MAAM,EAAE,IAAI;AACZ,QAAA,MAAM,EAAE,IAAI;AACZ,QAAA,SAAS,EAAE,IAAI;AACf,QAAA,eAAe,EAAE,IAAI;AACrB,QAAA,OAAO,EAAE,IAAI;AACb,QAAA,GAAG,EAAE,IAAI;AACT,QAAA,kBAAkB,EAAE,IAAI;KACzB,CAAC;AACF,IAAA,UAAU,EAAE,IAAI;;;;;"}
|
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.415",
|
|
4
4
|
"description": "Empathy X Components",
|
|
5
5
|
"author": "Empathy Systems Corporation S.L.",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -68,12 +68,12 @@
|
|
|
68
68
|
},
|
|
69
69
|
"dependencies": {
|
|
70
70
|
"@empathyco/x-adapter": "^8.0.0-alpha.34",
|
|
71
|
-
"@empathyco/x-adapter-platform": "^1.0.0-alpha.
|
|
71
|
+
"@empathyco/x-adapter-platform": "^1.0.0-alpha.86",
|
|
72
72
|
"@empathyco/x-bus": "^1.0.0-alpha.4",
|
|
73
73
|
"@empathyco/x-deep-merge": "^2.0.0-alpha.3",
|
|
74
74
|
"@empathyco/x-logger": "^1.2.0-alpha.11",
|
|
75
75
|
"@empathyco/x-storage-service": "^2.0.0-alpha.15",
|
|
76
|
-
"@empathyco/x-types": "^10.0.0-alpha.
|
|
76
|
+
"@empathyco/x-types": "^10.0.0-alpha.74",
|
|
77
77
|
"@empathyco/x-utils": "^1.0.0-alpha.23",
|
|
78
78
|
"@vue/devtools-api": "~6.5.0",
|
|
79
79
|
"@vueuse/core": "~10.1.0",
|
|
@@ -143,5 +143,5 @@
|
|
|
143
143
|
"access": "public",
|
|
144
144
|
"directory": "dist"
|
|
145
145
|
},
|
|
146
|
-
"gitHead": "
|
|
146
|
+
"gitHead": "95e728568518604017d28ae027d869581325de39"
|
|
147
147
|
}
|