@empathyco/x-components 3.0.0-alpha.415 → 3.0.0-alpha.416

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 (75) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/core/index.js.map +1 -1
  3. package/design-system/deprecated-full-theme.css +52 -52
  4. package/docs/API-reference/api/x-components.cancelfetchandsavecontrols.md +13 -0
  5. package/docs/API-reference/api/x-components.experiencecontrols.md +22 -0
  6. package/docs/API-reference/api/x-components.experiencecontrols.oneventschanged.md +24 -0
  7. package/docs/API-reference/api/x-components.experiencecontrols.render.md +15 -0
  8. package/docs/API-reference/api/x-components.experiencecontrolsactioncontext.md +15 -0
  9. package/docs/API-reference/api/x-components.experiencecontrolsactions.fetchandsaveexperiencecontrolsresponse.md +24 -0
  10. package/docs/API-reference/api/x-components.experiencecontrolsactions.fetchexperiencecontrolsresponse.md +26 -0
  11. package/docs/API-reference/api/x-components.experiencecontrolsactions.md +21 -0
  12. package/docs/API-reference/api/x-components.experiencecontrolsgetters.experiencecontrolsrequest.md +13 -0
  13. package/docs/API-reference/api/x-components.experiencecontrolsgetters.md +20 -0
  14. package/docs/API-reference/api/x-components.experiencecontrolsmutations.md +23 -0
  15. package/docs/API-reference/api/x-components.experiencecontrolsmutations.setcontrols.md +24 -0
  16. package/docs/API-reference/api/x-components.experiencecontrolsmutations.setevents.md +24 -0
  17. package/docs/API-reference/api/x-components.experiencecontrolsmutations.setparams.md +24 -0
  18. package/docs/API-reference/api/x-components.experiencecontrolsrequest.md +13 -0
  19. package/docs/API-reference/api/x-components.experiencecontrolsstate.controls.md +13 -0
  20. package/docs/API-reference/api/x-components.experiencecontrolsstate.events.md +11 -0
  21. package/docs/API-reference/api/x-components.experiencecontrolsstate.md +23 -0
  22. package/docs/API-reference/api/x-components.experiencecontrolsstate.params.md +11 -0
  23. package/docs/API-reference/api/x-components.experiencecontrolsxevents.experiencecontrolseventschanged.md +11 -0
  24. package/docs/API-reference/api/x-components.experiencecontrolsxevents.experiencecontrolsrequestupdated.md +11 -0
  25. package/docs/API-reference/api/x-components.experiencecontrolsxevents.md +21 -0
  26. package/docs/API-reference/api/x-components.experiencecontrolsxmodule.md +13 -0
  27. package/docs/API-reference/api/x-components.experiencecontrolsxstoremodule.md +15 -0
  28. package/docs/API-reference/api/x-components.fetchandsaveexperiencecontrolsresponse.md +13 -0
  29. package/docs/API-reference/api/x-components.fetchandsaveexperiencecontrolswire.md +13 -0
  30. package/docs/API-reference/api/x-components.fetchexperiencecontrolsresponse.md +13 -0
  31. package/docs/API-reference/api/x-components.md +15 -0
  32. package/docs/API-reference/api/x-components.xeventstypes.md +1 -1
  33. package/docs/API-reference/api/x-components.xmodulestree.md +1 -1
  34. package/experience-controls/index.d.ts +1 -0
  35. package/experience-controls/index.js +8 -0
  36. package/js/index.js +8 -0
  37. package/js/index.js.map +1 -1
  38. package/js/x-modules/experience-controls/components/experience-controls.vue.js +39 -0
  39. package/js/x-modules/experience-controls/components/experience-controls.vue.js.map +1 -0
  40. package/js/x-modules/experience-controls/components/experience-controls.vue_rollup-plugin-vue_script.vue.js +39 -0
  41. package/js/x-modules/experience-controls/components/experience-controls.vue_rollup-plugin-vue_script.vue.js.map +1 -0
  42. package/js/x-modules/experience-controls/store/actions/fetch-and-save-experience-controls.action.js +26 -0
  43. package/js/x-modules/experience-controls/store/actions/fetch-and-save-experience-controls.action.js.map +1 -0
  44. package/js/x-modules/experience-controls/store/actions/fetch-experience-controls.action.js +21 -0
  45. package/js/x-modules/experience-controls/store/actions/fetch-experience-controls.action.js.map +1 -0
  46. package/js/x-modules/experience-controls/store/emitters.js +17 -0
  47. package/js/x-modules/experience-controls/store/emitters.js.map +1 -0
  48. package/js/x-modules/experience-controls/store/getters/experience-controls-results-request.getter.js +19 -0
  49. package/js/x-modules/experience-controls/store/getters/experience-controls-results-request.getter.js.map +1 -0
  50. package/js/x-modules/experience-controls/store/module.js +43 -0
  51. package/js/x-modules/experience-controls/store/module.js.map +1 -0
  52. package/js/x-modules/experience-controls/wiring.js +44 -0
  53. package/js/x-modules/experience-controls/wiring.js.map +1 -0
  54. package/js/x-modules/experience-controls/x-module.js +19 -0
  55. package/js/x-modules/experience-controls/x-module.js.map +1 -0
  56. package/package.json +2 -2
  57. package/report/x-components.api.json +1083 -2
  58. package/report/x-components.api.md +95 -4
  59. package/types/index.d.ts +1 -0
  60. package/types/index.d.ts.map +1 -1
  61. package/types/x-modules/experience-controls/components/experience-controls.vue.d.ts +18 -0
  62. package/types/x-modules/experience-controls/components/experience-controls.vue.d.ts.map +1 -0
  63. package/types/x-modules/experience-controls/components/index.d.ts +2 -0
  64. package/types/x-modules/experience-controls/components/index.d.ts.map +1 -0
  65. package/types/x-modules/experience-controls/index.d.ts +6 -0
  66. package/types/x-modules/experience-controls/index.d.ts.map +1 -0
  67. package/types/x-modules/experience-controls/store/actions/fetch-and-save-experience-controls.action.d.ts +2 -2
  68. package/types/x-modules/experience-controls/store/actions/index.d.ts +3 -0
  69. package/types/x-modules/experience-controls/store/actions/index.d.ts.map +1 -0
  70. package/types/x-modules/experience-controls/store/getters/index.d.ts +2 -0
  71. package/types/x-modules/experience-controls/store/getters/index.d.ts.map +1 -0
  72. package/types/x-modules/experience-controls/store/index.d.ts +6 -0
  73. package/types/x-modules/experience-controls/store/index.d.ts.map +1 -0
  74. package/types/x-modules/experience-controls/store/types.d.ts +5 -0
  75. package/types/x-modules/experience-controls/store/types.d.ts.map +1 -1
@@ -9385,6 +9385,29 @@
9385
9385
  "endIndex": 7
9386
9386
  }
9387
9387
  },
9388
+ {
9389
+ "kind": "Variable",
9390
+ "canonicalReference": "@empathyco/x-components!cancelFetchAndSaveControls:var",
9391
+ "docComment": "/**\n * Default implementation for fetchAndSaveExperienceControls action.\n *\n * @public\n */\n",
9392
+ "excerptTokens": [
9393
+ {
9394
+ "kind": "Content",
9395
+ "text": "cancelFetchAndSaveControls: "
9396
+ },
9397
+ {
9398
+ "kind": "Content",
9399
+ "text": "() => void"
9400
+ }
9401
+ ],
9402
+ "fileUrlPath": "src/x-modules/experience-controls/store/actions/fetch-and-save-experience-controls.action.ts",
9403
+ "isReadonly": true,
9404
+ "releaseTag": "Public",
9405
+ "name": "cancelFetchAndSaveControls",
9406
+ "variableTypeTokenRange": {
9407
+ "startIndex": 1,
9408
+ "endIndex": 2
9409
+ }
9410
+ },
9388
9411
  {
9389
9412
  "kind": "Variable",
9390
9413
  "canonicalReference": "@empathyco/x-components!cancelFetchAndSaveIdentifierResults:var",
@@ -15643,6 +15666,945 @@
15643
15666
  },
15644
15667
  "implementsTokenRanges": []
15645
15668
  },
15669
+ {
15670
+ "kind": "Class",
15671
+ "canonicalReference": "@empathyco/x-components!ExperienceControls:class",
15672
+ "docComment": "/**\n * This component subscribes to changes in the ExperienceControls module to fire the events that propagate the configuration.\n *\n * @public\n */\n",
15673
+ "excerptTokens": [
15674
+ {
15675
+ "kind": "Content",
15676
+ "text": "export default class ExperienceControls extends "
15677
+ },
15678
+ {
15679
+ "kind": "Reference",
15680
+ "text": "Vue",
15681
+ "canonicalReference": "vue!Vue:interface"
15682
+ },
15683
+ {
15684
+ "kind": "Content",
15685
+ "text": " "
15686
+ }
15687
+ ],
15688
+ "fileUrlPath": "dist/types/x-modules/experience-controls/components/experience-controls.vue.d.ts",
15689
+ "releaseTag": "Public",
15690
+ "isAbstract": false,
15691
+ "name": "ExperienceControls",
15692
+ "preserveMemberOrder": false,
15693
+ "members": [
15694
+ {
15695
+ "kind": "Method",
15696
+ "canonicalReference": "@empathyco/x-components!ExperienceControls#onEventsChanged:member(1)",
15697
+ "docComment": "/**\n * . Iterates the list of XEvents received and emits them\n *\n * @param events - events to be emitted\n */\n",
15698
+ "excerptTokens": [
15699
+ {
15700
+ "kind": "Content",
15701
+ "text": "onEventsChanged(events: "
15702
+ },
15703
+ {
15704
+ "kind": "Reference",
15705
+ "text": "Partial",
15706
+ "canonicalReference": "!Partial:type"
15707
+ },
15708
+ {
15709
+ "kind": "Content",
15710
+ "text": "<"
15711
+ },
15712
+ {
15713
+ "kind": "Reference",
15714
+ "text": "XEventsTypes",
15715
+ "canonicalReference": "@empathyco/x-components!XEventsTypes:interface"
15716
+ },
15717
+ {
15718
+ "kind": "Content",
15719
+ "text": ">"
15720
+ },
15721
+ {
15722
+ "kind": "Content",
15723
+ "text": "): "
15724
+ },
15725
+ {
15726
+ "kind": "Content",
15727
+ "text": "void"
15728
+ },
15729
+ {
15730
+ "kind": "Content",
15731
+ "text": ";"
15732
+ }
15733
+ ],
15734
+ "isStatic": false,
15735
+ "returnTypeTokenRange": {
15736
+ "startIndex": 6,
15737
+ "endIndex": 7
15738
+ },
15739
+ "releaseTag": "Public",
15740
+ "isProtected": false,
15741
+ "overloadIndex": 1,
15742
+ "parameters": [
15743
+ {
15744
+ "parameterName": "events",
15745
+ "parameterTypeTokenRange": {
15746
+ "startIndex": 1,
15747
+ "endIndex": 5
15748
+ },
15749
+ "isOptional": false
15750
+ }
15751
+ ],
15752
+ "isOptional": false,
15753
+ "isAbstract": false,
15754
+ "name": "onEventsChanged"
15755
+ },
15756
+ {
15757
+ "kind": "Method",
15758
+ "canonicalReference": "@empathyco/x-components!ExperienceControls#render:member(1)",
15759
+ "docComment": "",
15760
+ "excerptTokens": [
15761
+ {
15762
+ "kind": "Content",
15763
+ "text": "render(): "
15764
+ },
15765
+ {
15766
+ "kind": "Content",
15767
+ "text": "void"
15768
+ },
15769
+ {
15770
+ "kind": "Content",
15771
+ "text": ";"
15772
+ }
15773
+ ],
15774
+ "isStatic": false,
15775
+ "returnTypeTokenRange": {
15776
+ "startIndex": 1,
15777
+ "endIndex": 2
15778
+ },
15779
+ "releaseTag": "Public",
15780
+ "isProtected": false,
15781
+ "overloadIndex": 1,
15782
+ "parameters": [],
15783
+ "isOptional": false,
15784
+ "isAbstract": false,
15785
+ "name": "render"
15786
+ }
15787
+ ],
15788
+ "extendsTokenRange": {
15789
+ "startIndex": 1,
15790
+ "endIndex": 2
15791
+ },
15792
+ "implementsTokenRanges": []
15793
+ },
15794
+ {
15795
+ "kind": "TypeAlias",
15796
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsActionContext:type",
15797
+ "docComment": "/**\n * Alias type for actions context of the {@link ExperienceControlsXStoreModule}.\n *\n * @public\n */\n",
15798
+ "excerptTokens": [
15799
+ {
15800
+ "kind": "Content",
15801
+ "text": "export type ExperienceControlsActionContext = "
15802
+ },
15803
+ {
15804
+ "kind": "Reference",
15805
+ "text": "XActionContext",
15806
+ "canonicalReference": "@empathyco/x-components!XActionContext:interface"
15807
+ },
15808
+ {
15809
+ "kind": "Content",
15810
+ "text": "<"
15811
+ },
15812
+ {
15813
+ "kind": "Reference",
15814
+ "text": "ExperienceControlsState",
15815
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsState:interface"
15816
+ },
15817
+ {
15818
+ "kind": "Content",
15819
+ "text": ", "
15820
+ },
15821
+ {
15822
+ "kind": "Reference",
15823
+ "text": "ExperienceControlsGetters",
15824
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsGetters:interface"
15825
+ },
15826
+ {
15827
+ "kind": "Content",
15828
+ "text": ", "
15829
+ },
15830
+ {
15831
+ "kind": "Reference",
15832
+ "text": "ExperienceControlsMutations",
15833
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsMutations:interface"
15834
+ },
15835
+ {
15836
+ "kind": "Content",
15837
+ "text": ", "
15838
+ },
15839
+ {
15840
+ "kind": "Reference",
15841
+ "text": "ExperienceControlsActions",
15842
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsActions:interface"
15843
+ },
15844
+ {
15845
+ "kind": "Content",
15846
+ "text": ">"
15847
+ },
15848
+ {
15849
+ "kind": "Content",
15850
+ "text": ";"
15851
+ }
15852
+ ],
15853
+ "fileUrlPath": "src/x-modules/experience-controls/store/types.ts",
15854
+ "releaseTag": "Public",
15855
+ "name": "ExperienceControlsActionContext",
15856
+ "typeTokenRange": {
15857
+ "startIndex": 1,
15858
+ "endIndex": 11
15859
+ }
15860
+ },
15861
+ {
15862
+ "kind": "Interface",
15863
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsActions:interface",
15864
+ "docComment": "/**\n * Experience Controls store actions.\n *\n * @public\n */\n",
15865
+ "excerptTokens": [
15866
+ {
15867
+ "kind": "Content",
15868
+ "text": "export interface ExperienceControlsActions "
15869
+ }
15870
+ ],
15871
+ "fileUrlPath": "src/x-modules/experience-controls/store/types.ts",
15872
+ "releaseTag": "Public",
15873
+ "name": "ExperienceControlsActions",
15874
+ "preserveMemberOrder": false,
15875
+ "members": [
15876
+ {
15877
+ "kind": "MethodSignature",
15878
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsActions#fetchAndSaveExperienceControlsResponse:member(1)",
15879
+ "docComment": "/**\n * Requests the experience controls and saves them in the module.\n *\n * @param request - The request to fetch the experience controls.\n */\n",
15880
+ "excerptTokens": [
15881
+ {
15882
+ "kind": "Content",
15883
+ "text": "fetchAndSaveExperienceControlsResponse(request: "
15884
+ },
15885
+ {
15886
+ "kind": "Reference",
15887
+ "text": "ExperienceControlsRequest",
15888
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsRequest:interface"
15889
+ },
15890
+ {
15891
+ "kind": "Content",
15892
+ "text": " | null"
15893
+ },
15894
+ {
15895
+ "kind": "Content",
15896
+ "text": "): "
15897
+ },
15898
+ {
15899
+ "kind": "Content",
15900
+ "text": "void"
15901
+ },
15902
+ {
15903
+ "kind": "Content",
15904
+ "text": ";"
15905
+ }
15906
+ ],
15907
+ "isOptional": false,
15908
+ "returnTypeTokenRange": {
15909
+ "startIndex": 4,
15910
+ "endIndex": 5
15911
+ },
15912
+ "releaseTag": "Public",
15913
+ "overloadIndex": 1,
15914
+ "parameters": [
15915
+ {
15916
+ "parameterName": "request",
15917
+ "parameterTypeTokenRange": {
15918
+ "startIndex": 1,
15919
+ "endIndex": 3
15920
+ },
15921
+ "isOptional": false
15922
+ }
15923
+ ],
15924
+ "name": "fetchAndSaveExperienceControlsResponse"
15925
+ },
15926
+ {
15927
+ "kind": "MethodSignature",
15928
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsActions#fetchExperienceControlsResponse:member(1)",
15929
+ "docComment": "/**\n * . Requests the experience controls\n *\n * @param request - The request to fetch the experience controls.\n *\n * @returns the experience controls.\n */\n",
15930
+ "excerptTokens": [
15931
+ {
15932
+ "kind": "Content",
15933
+ "text": "fetchExperienceControlsResponse(request: "
15934
+ },
15935
+ {
15936
+ "kind": "Reference",
15937
+ "text": "ExperienceControlsRequest",
15938
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsRequest:interface"
15939
+ },
15940
+ {
15941
+ "kind": "Content",
15942
+ "text": " | null"
15943
+ },
15944
+ {
15945
+ "kind": "Content",
15946
+ "text": "): "
15947
+ },
15948
+ {
15949
+ "kind": "Reference",
15950
+ "text": "ExperienceControlsResponse",
15951
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsResponse:interface"
15952
+ },
15953
+ {
15954
+ "kind": "Content",
15955
+ "text": ";"
15956
+ }
15957
+ ],
15958
+ "isOptional": false,
15959
+ "returnTypeTokenRange": {
15960
+ "startIndex": 4,
15961
+ "endIndex": 5
15962
+ },
15963
+ "releaseTag": "Public",
15964
+ "overloadIndex": 1,
15965
+ "parameters": [
15966
+ {
15967
+ "parameterName": "request",
15968
+ "parameterTypeTokenRange": {
15969
+ "startIndex": 1,
15970
+ "endIndex": 3
15971
+ },
15972
+ "isOptional": false
15973
+ }
15974
+ ],
15975
+ "name": "fetchExperienceControlsResponse"
15976
+ }
15977
+ ],
15978
+ "extendsTokenRanges": []
15979
+ },
15980
+ {
15981
+ "kind": "Interface",
15982
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsGetters:interface",
15983
+ "docComment": "/**\n * Experience Controls store getters.\n *\n * @public\n */\n",
15984
+ "excerptTokens": [
15985
+ {
15986
+ "kind": "Content",
15987
+ "text": "export interface ExperienceControlsGetters "
15988
+ }
15989
+ ],
15990
+ "fileUrlPath": "src/x-modules/experience-controls/store/types.ts",
15991
+ "releaseTag": "Public",
15992
+ "name": "ExperienceControlsGetters",
15993
+ "preserveMemberOrder": false,
15994
+ "members": [
15995
+ {
15996
+ "kind": "PropertySignature",
15997
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsGetters#experienceControlsRequest:member",
15998
+ "docComment": "/**\n * The adapter request object for retrieving the controls request, or null if there is not valid data to create a request.\n */\n",
15999
+ "excerptTokens": [
16000
+ {
16001
+ "kind": "Content",
16002
+ "text": "experienceControlsRequest: "
16003
+ },
16004
+ {
16005
+ "kind": "Reference",
16006
+ "text": "ExperienceControlsRequest",
16007
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsRequest:interface"
16008
+ },
16009
+ {
16010
+ "kind": "Content",
16011
+ "text": " | null"
16012
+ },
16013
+ {
16014
+ "kind": "Content",
16015
+ "text": ";"
16016
+ }
16017
+ ],
16018
+ "isReadonly": false,
16019
+ "isOptional": false,
16020
+ "releaseTag": "Public",
16021
+ "name": "experienceControlsRequest",
16022
+ "propertyTypeTokenRange": {
16023
+ "startIndex": 1,
16024
+ "endIndex": 3
16025
+ }
16026
+ }
16027
+ ],
16028
+ "extendsTokenRanges": []
16029
+ },
16030
+ {
16031
+ "kind": "Interface",
16032
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsMutations:interface",
16033
+ "docComment": "/**\n * Experience Controls store mutations.\n *\n * @public\n */\n",
16034
+ "excerptTokens": [
16035
+ {
16036
+ "kind": "Content",
16037
+ "text": "export interface ExperienceControlsMutations extends "
16038
+ },
16039
+ {
16040
+ "kind": "Reference",
16041
+ "text": "StatusMutations",
16042
+ "canonicalReference": "@empathyco/x-components!StatusMutations:interface"
16043
+ },
16044
+ {
16045
+ "kind": "Content",
16046
+ "text": " "
16047
+ }
16048
+ ],
16049
+ "fileUrlPath": "src/x-modules/experience-controls/store/types.ts",
16050
+ "releaseTag": "Public",
16051
+ "name": "ExperienceControlsMutations",
16052
+ "preserveMemberOrder": false,
16053
+ "members": [
16054
+ {
16055
+ "kind": "MethodSignature",
16056
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsMutations#setControls:member(1)",
16057
+ "docComment": "/**\n * Sets the {@link ExperienceControlsState.controls} property.\n *\n * @param controls - The new {@link ExperienceControlsState.controls}.\n */\n",
16058
+ "excerptTokens": [
16059
+ {
16060
+ "kind": "Content",
16061
+ "text": "setControls(controls: "
16062
+ },
16063
+ {
16064
+ "kind": "Reference",
16065
+ "text": "Dictionary",
16066
+ "canonicalReference": "@empathyco/x-utils!Dictionary:type"
16067
+ },
16068
+ {
16069
+ "kind": "Content",
16070
+ "text": "<unknown>"
16071
+ },
16072
+ {
16073
+ "kind": "Content",
16074
+ "text": "): "
16075
+ },
16076
+ {
16077
+ "kind": "Content",
16078
+ "text": "void"
16079
+ },
16080
+ {
16081
+ "kind": "Content",
16082
+ "text": ";"
16083
+ }
16084
+ ],
16085
+ "isOptional": false,
16086
+ "returnTypeTokenRange": {
16087
+ "startIndex": 4,
16088
+ "endIndex": 5
16089
+ },
16090
+ "releaseTag": "Public",
16091
+ "overloadIndex": 1,
16092
+ "parameters": [
16093
+ {
16094
+ "parameterName": "controls",
16095
+ "parameterTypeTokenRange": {
16096
+ "startIndex": 1,
16097
+ "endIndex": 3
16098
+ },
16099
+ "isOptional": false
16100
+ }
16101
+ ],
16102
+ "name": "setControls"
16103
+ },
16104
+ {
16105
+ "kind": "MethodSignature",
16106
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsMutations#setEvents:member(1)",
16107
+ "docComment": "/**\n * Sets the {@link ExperienceControlsState.events} property.\n *\n * @param events - The new {@link ExperienceControlsState.events}.\n */\n",
16108
+ "excerptTokens": [
16109
+ {
16110
+ "kind": "Content",
16111
+ "text": "setEvents(events: "
16112
+ },
16113
+ {
16114
+ "kind": "Reference",
16115
+ "text": "Partial",
16116
+ "canonicalReference": "!Partial:type"
16117
+ },
16118
+ {
16119
+ "kind": "Content",
16120
+ "text": "<"
16121
+ },
16122
+ {
16123
+ "kind": "Reference",
16124
+ "text": "XEventsTypes",
16125
+ "canonicalReference": "@empathyco/x-components!XEventsTypes:interface"
16126
+ },
16127
+ {
16128
+ "kind": "Content",
16129
+ "text": ">"
16130
+ },
16131
+ {
16132
+ "kind": "Content",
16133
+ "text": "): "
16134
+ },
16135
+ {
16136
+ "kind": "Content",
16137
+ "text": "void"
16138
+ },
16139
+ {
16140
+ "kind": "Content",
16141
+ "text": ";"
16142
+ }
16143
+ ],
16144
+ "isOptional": false,
16145
+ "returnTypeTokenRange": {
16146
+ "startIndex": 6,
16147
+ "endIndex": 7
16148
+ },
16149
+ "releaseTag": "Public",
16150
+ "overloadIndex": 1,
16151
+ "parameters": [
16152
+ {
16153
+ "parameterName": "events",
16154
+ "parameterTypeTokenRange": {
16155
+ "startIndex": 1,
16156
+ "endIndex": 5
16157
+ },
16158
+ "isOptional": false
16159
+ }
16160
+ ],
16161
+ "name": "setEvents"
16162
+ },
16163
+ {
16164
+ "kind": "MethodSignature",
16165
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsMutations#setParams:member(1)",
16166
+ "docComment": "/**\n * Sets the extra params of the module.\n *\n * @param params - The new extra params.\n */\n",
16167
+ "excerptTokens": [
16168
+ {
16169
+ "kind": "Content",
16170
+ "text": "setParams(params: "
16171
+ },
16172
+ {
16173
+ "kind": "Reference",
16174
+ "text": "Dictionary",
16175
+ "canonicalReference": "@empathyco/x-utils!Dictionary:type"
16176
+ },
16177
+ {
16178
+ "kind": "Content",
16179
+ "text": "<unknown>"
16180
+ },
16181
+ {
16182
+ "kind": "Content",
16183
+ "text": "): "
16184
+ },
16185
+ {
16186
+ "kind": "Content",
16187
+ "text": "void"
16188
+ },
16189
+ {
16190
+ "kind": "Content",
16191
+ "text": ";"
16192
+ }
16193
+ ],
16194
+ "isOptional": false,
16195
+ "returnTypeTokenRange": {
16196
+ "startIndex": 4,
16197
+ "endIndex": 5
16198
+ },
16199
+ "releaseTag": "Public",
16200
+ "overloadIndex": 1,
16201
+ "parameters": [
16202
+ {
16203
+ "parameterName": "params",
16204
+ "parameterTypeTokenRange": {
16205
+ "startIndex": 1,
16206
+ "endIndex": 3
16207
+ },
16208
+ "isOptional": false
16209
+ }
16210
+ ],
16211
+ "name": "setParams"
16212
+ }
16213
+ ],
16214
+ "extendsTokenRanges": [
16215
+ {
16216
+ "startIndex": 1,
16217
+ "endIndex": 2
16218
+ }
16219
+ ]
16220
+ },
16221
+ {
16222
+ "kind": "Variable",
16223
+ "canonicalReference": "@empathyco/x-components!experienceControlsRequest:var",
16224
+ "docComment": "/**\n * Default implementation for the {@link ExperienceControlsGetters.experienceControlsRequest} getter.\n *\n * @param state - Current {@link https://vuex.vuejs.org/guide/state.html | state} of the controls results module.\n *\n * @returns The params results request to fetch data from the API.\n *\n * @public\n */\n",
16225
+ "excerptTokens": [
16226
+ {
16227
+ "kind": "Content",
16228
+ "text": "experienceControlsRequest: "
16229
+ },
16230
+ {
16231
+ "kind": "Reference",
16232
+ "text": "ExperienceControlsXStoreModule",
16233
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsXStoreModule:type"
16234
+ },
16235
+ {
16236
+ "kind": "Content",
16237
+ "text": "['getters']['experienceControlsRequest']"
16238
+ }
16239
+ ],
16240
+ "fileUrlPath": "src/x-modules/experience-controls/store/getters/experience-controls-results-request.getter.ts",
16241
+ "isReadonly": true,
16242
+ "releaseTag": "Public",
16243
+ "name": "experienceControlsRequest",
16244
+ "variableTypeTokenRange": {
16245
+ "startIndex": 1,
16246
+ "endIndex": 3
16247
+ }
16248
+ },
16249
+ {
16250
+ "kind": "Interface",
16251
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsState:interface",
16252
+ "docComment": "/**\n * Experience Controls store state.\n *\n * @public\n */\n",
16253
+ "excerptTokens": [
16254
+ {
16255
+ "kind": "Content",
16256
+ "text": "export interface ExperienceControlsState extends "
16257
+ },
16258
+ {
16259
+ "kind": "Reference",
16260
+ "text": "StatusState",
16261
+ "canonicalReference": "@empathyco/x-components!StatusState:interface"
16262
+ },
16263
+ {
16264
+ "kind": "Content",
16265
+ "text": " "
16266
+ }
16267
+ ],
16268
+ "fileUrlPath": "src/x-modules/experience-controls/store/types.ts",
16269
+ "releaseTag": "Public",
16270
+ "name": "ExperienceControlsState",
16271
+ "preserveMemberOrder": false,
16272
+ "members": [
16273
+ {
16274
+ "kind": "PropertySignature",
16275
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsState#controls:member",
16276
+ "docComment": "/**\n * Configuration for the `ExperienceControls` module.\n */\n",
16277
+ "excerptTokens": [
16278
+ {
16279
+ "kind": "Content",
16280
+ "text": "controls: "
16281
+ },
16282
+ {
16283
+ "kind": "Reference",
16284
+ "text": "Dictionary",
16285
+ "canonicalReference": "@empathyco/x-utils!Dictionary:type"
16286
+ },
16287
+ {
16288
+ "kind": "Content",
16289
+ "text": "<unknown>"
16290
+ },
16291
+ {
16292
+ "kind": "Content",
16293
+ "text": ";"
16294
+ }
16295
+ ],
16296
+ "isReadonly": false,
16297
+ "isOptional": false,
16298
+ "releaseTag": "Public",
16299
+ "name": "controls",
16300
+ "propertyTypeTokenRange": {
16301
+ "startIndex": 1,
16302
+ "endIndex": 3
16303
+ }
16304
+ },
16305
+ {
16306
+ "kind": "PropertySignature",
16307
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsState#events:member",
16308
+ "docComment": "",
16309
+ "excerptTokens": [
16310
+ {
16311
+ "kind": "Content",
16312
+ "text": "events: "
16313
+ },
16314
+ {
16315
+ "kind": "Reference",
16316
+ "text": "Partial",
16317
+ "canonicalReference": "!Partial:type"
16318
+ },
16319
+ {
16320
+ "kind": "Content",
16321
+ "text": "<"
16322
+ },
16323
+ {
16324
+ "kind": "Reference",
16325
+ "text": "XEventsTypes",
16326
+ "canonicalReference": "@empathyco/x-components!XEventsTypes:interface"
16327
+ },
16328
+ {
16329
+ "kind": "Content",
16330
+ "text": ">"
16331
+ },
16332
+ {
16333
+ "kind": "Content",
16334
+ "text": ";"
16335
+ }
16336
+ ],
16337
+ "isReadonly": false,
16338
+ "isOptional": false,
16339
+ "releaseTag": "Public",
16340
+ "name": "events",
16341
+ "propertyTypeTokenRange": {
16342
+ "startIndex": 1,
16343
+ "endIndex": 5
16344
+ }
16345
+ },
16346
+ {
16347
+ "kind": "PropertySignature",
16348
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsState#params:member",
16349
+ "docComment": "",
16350
+ "excerptTokens": [
16351
+ {
16352
+ "kind": "Content",
16353
+ "text": "params: "
16354
+ },
16355
+ {
16356
+ "kind": "Reference",
16357
+ "text": "Dictionary",
16358
+ "canonicalReference": "@empathyco/x-utils!Dictionary:type"
16359
+ },
16360
+ {
16361
+ "kind": "Content",
16362
+ "text": "<unknown>"
16363
+ },
16364
+ {
16365
+ "kind": "Content",
16366
+ "text": ";"
16367
+ }
16368
+ ],
16369
+ "isReadonly": false,
16370
+ "isOptional": false,
16371
+ "releaseTag": "Public",
16372
+ "name": "params",
16373
+ "propertyTypeTokenRange": {
16374
+ "startIndex": 1,
16375
+ "endIndex": 3
16376
+ }
16377
+ }
16378
+ ],
16379
+ "extendsTokenRanges": [
16380
+ {
16381
+ "startIndex": 1,
16382
+ "endIndex": 2
16383
+ }
16384
+ ]
16385
+ },
16386
+ {
16387
+ "kind": "Interface",
16388
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsXEvents:interface",
16389
+ "docComment": "/**\n * Dictionary of the events of Experience Controls XModule.\n *\n * @public\n */\n",
16390
+ "excerptTokens": [
16391
+ {
16392
+ "kind": "Content",
16393
+ "text": "export interface ExperienceControlsXEvents "
16394
+ }
16395
+ ],
16396
+ "fileUrlPath": "src/x-modules/experience-controls/events.types.ts",
16397
+ "releaseTag": "Public",
16398
+ "name": "ExperienceControlsXEvents",
16399
+ "preserveMemberOrder": false,
16400
+ "members": [
16401
+ {
16402
+ "kind": "PropertySignature",
16403
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsXEvents#ExperienceControlsEventsChanged:member",
16404
+ "docComment": "",
16405
+ "excerptTokens": [
16406
+ {
16407
+ "kind": "Content",
16408
+ "text": "ExperienceControlsEventsChanged: "
16409
+ },
16410
+ {
16411
+ "kind": "Reference",
16412
+ "text": "Partial",
16413
+ "canonicalReference": "!Partial:type"
16414
+ },
16415
+ {
16416
+ "kind": "Content",
16417
+ "text": "<"
16418
+ },
16419
+ {
16420
+ "kind": "Reference",
16421
+ "text": "XEventsTypes",
16422
+ "canonicalReference": "@empathyco/x-components!XEventsTypes:interface"
16423
+ },
16424
+ {
16425
+ "kind": "Content",
16426
+ "text": ">"
16427
+ },
16428
+ {
16429
+ "kind": "Content",
16430
+ "text": ";"
16431
+ }
16432
+ ],
16433
+ "isReadonly": false,
16434
+ "isOptional": false,
16435
+ "releaseTag": "Public",
16436
+ "name": "ExperienceControlsEventsChanged",
16437
+ "propertyTypeTokenRange": {
16438
+ "startIndex": 1,
16439
+ "endIndex": 5
16440
+ }
16441
+ },
16442
+ {
16443
+ "kind": "PropertySignature",
16444
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsXEvents#ExperienceControlsRequestUpdated:member",
16445
+ "docComment": "",
16446
+ "excerptTokens": [
16447
+ {
16448
+ "kind": "Content",
16449
+ "text": "ExperienceControlsRequestUpdated: "
16450
+ },
16451
+ {
16452
+ "kind": "Reference",
16453
+ "text": "ExperienceControlsRequest",
16454
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsRequest:interface"
16455
+ },
16456
+ {
16457
+ "kind": "Content",
16458
+ "text": " | null"
16459
+ },
16460
+ {
16461
+ "kind": "Content",
16462
+ "text": ";"
16463
+ }
16464
+ ],
16465
+ "isReadonly": false,
16466
+ "isOptional": false,
16467
+ "releaseTag": "Public",
16468
+ "name": "ExperienceControlsRequestUpdated",
16469
+ "propertyTypeTokenRange": {
16470
+ "startIndex": 1,
16471
+ "endIndex": 3
16472
+ }
16473
+ }
16474
+ ],
16475
+ "extendsTokenRanges": []
16476
+ },
16477
+ {
16478
+ "kind": "TypeAlias",
16479
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsXModule:type",
16480
+ "docComment": "/**\n * Search {@link XModule} alias.\n *\n * @public\n */\n",
16481
+ "excerptTokens": [
16482
+ {
16483
+ "kind": "Content",
16484
+ "text": "export type ExperienceControlsXModule = "
16485
+ },
16486
+ {
16487
+ "kind": "Reference",
16488
+ "text": "XModule",
16489
+ "canonicalReference": "@empathyco/x-components!XModule:interface"
16490
+ },
16491
+ {
16492
+ "kind": "Content",
16493
+ "text": "<"
16494
+ },
16495
+ {
16496
+ "kind": "Reference",
16497
+ "text": "ExperienceControlsXStoreModule",
16498
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsXStoreModule:type"
16499
+ },
16500
+ {
16501
+ "kind": "Content",
16502
+ "text": ">"
16503
+ },
16504
+ {
16505
+ "kind": "Content",
16506
+ "text": ";"
16507
+ }
16508
+ ],
16509
+ "fileUrlPath": "src/x-modules/experience-controls/x-module.ts",
16510
+ "releaseTag": "Public",
16511
+ "name": "ExperienceControlsXModule",
16512
+ "typeTokenRange": {
16513
+ "startIndex": 1,
16514
+ "endIndex": 5
16515
+ }
16516
+ },
16517
+ {
16518
+ "kind": "Variable",
16519
+ "canonicalReference": "@empathyco/x-components!experienceControlsXModule:var",
16520
+ "docComment": "/**\n * Search {@link XModule} implementation. This module is auto-registered as soon as you import any component from the `x-controls` entry point.\n *\n * @public\n */\n",
16521
+ "excerptTokens": [
16522
+ {
16523
+ "kind": "Content",
16524
+ "text": "experienceControlsXModule: "
16525
+ },
16526
+ {
16527
+ "kind": "Reference",
16528
+ "text": "ExperienceControlsXModule",
16529
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsXModule:type"
16530
+ }
16531
+ ],
16532
+ "fileUrlPath": "src/x-modules/experience-controls/x-module.ts",
16533
+ "isReadonly": true,
16534
+ "releaseTag": "Public",
16535
+ "name": "experienceControlsXModule",
16536
+ "variableTypeTokenRange": {
16537
+ "startIndex": 1,
16538
+ "endIndex": 2
16539
+ }
16540
+ },
16541
+ {
16542
+ "kind": "TypeAlias",
16543
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsXStoreModule:type",
16544
+ "docComment": "/**\n * Experience Controls type safe store module.\n *\n * @public\n */\n",
16545
+ "excerptTokens": [
16546
+ {
16547
+ "kind": "Content",
16548
+ "text": "export type ExperienceControlsXStoreModule = "
16549
+ },
16550
+ {
16551
+ "kind": "Reference",
16552
+ "text": "XStoreModule",
16553
+ "canonicalReference": "@empathyco/x-components!XStoreModule:interface"
16554
+ },
16555
+ {
16556
+ "kind": "Content",
16557
+ "text": "<"
16558
+ },
16559
+ {
16560
+ "kind": "Reference",
16561
+ "text": "ExperienceControlsState",
16562
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsState:interface"
16563
+ },
16564
+ {
16565
+ "kind": "Content",
16566
+ "text": ", "
16567
+ },
16568
+ {
16569
+ "kind": "Reference",
16570
+ "text": "ExperienceControlsGetters",
16571
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsGetters:interface"
16572
+ },
16573
+ {
16574
+ "kind": "Content",
16575
+ "text": ", "
16576
+ },
16577
+ {
16578
+ "kind": "Reference",
16579
+ "text": "ExperienceControlsMutations",
16580
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsMutations:interface"
16581
+ },
16582
+ {
16583
+ "kind": "Content",
16584
+ "text": ", "
16585
+ },
16586
+ {
16587
+ "kind": "Reference",
16588
+ "text": "ExperienceControlsActions",
16589
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsActions:interface"
16590
+ },
16591
+ {
16592
+ "kind": "Content",
16593
+ "text": ">"
16594
+ },
16595
+ {
16596
+ "kind": "Content",
16597
+ "text": ";"
16598
+ }
16599
+ ],
16600
+ "fileUrlPath": "src/x-modules/experience-controls/store/types.ts",
16601
+ "releaseTag": "Public",
16602
+ "name": "ExperienceControlsXStoreModule",
16603
+ "typeTokenRange": {
16604
+ "startIndex": 1,
16605
+ "endIndex": 11
16606
+ }
16607
+ },
15646
16608
  {
15647
16609
  "kind": "TypeAlias",
15648
16610
  "canonicalReference": "@empathyco/x-components!ExtractActionPayload:type",
@@ -20187,6 +21149,97 @@
20187
21149
  ],
20188
21150
  "extendsTokenRanges": []
20189
21151
  },
21152
+ {
21153
+ "kind": "Variable",
21154
+ "canonicalReference": "@empathyco/x-components!fetchAndSaveExperienceControlsResponse:var",
21155
+ "docComment": "/**\n * Default implementation for fetchAndSaveExperienceControls action.\n *\n * @public\n */\n",
21156
+ "excerptTokens": [
21157
+ {
21158
+ "kind": "Content",
21159
+ "text": "fetchAndSaveExperienceControlsResponse: "
21160
+ },
21161
+ {
21162
+ "kind": "Content",
21163
+ "text": "(context: "
21164
+ },
21165
+ {
21166
+ "kind": "Reference",
21167
+ "text": "ExperienceControlsActionContext",
21168
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsActionContext:type"
21169
+ },
21170
+ {
21171
+ "kind": "Content",
21172
+ "text": ", request: "
21173
+ },
21174
+ {
21175
+ "kind": "Reference",
21176
+ "text": "ExperienceControlsRequest",
21177
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsRequest:interface"
21178
+ },
21179
+ {
21180
+ "kind": "Content",
21181
+ "text": " | null) => void | "
21182
+ },
21183
+ {
21184
+ "kind": "Reference",
21185
+ "text": "Promise",
21186
+ "canonicalReference": "!Promise:interface"
21187
+ },
21188
+ {
21189
+ "kind": "Content",
21190
+ "text": "<void>"
21191
+ }
21192
+ ],
21193
+ "fileUrlPath": "src/x-modules/experience-controls/store/actions/fetch-and-save-experience-controls.action.ts",
21194
+ "isReadonly": true,
21195
+ "releaseTag": "Public",
21196
+ "name": "fetchAndSaveExperienceControlsResponse",
21197
+ "variableTypeTokenRange": {
21198
+ "startIndex": 1,
21199
+ "endIndex": 8
21200
+ }
21201
+ },
21202
+ {
21203
+ "kind": "Variable",
21204
+ "canonicalReference": "@empathyco/x-components!fetchAndSaveExperienceControlsWire:var",
21205
+ "docComment": "/**\n * Requests and stores a new set of controls results.\n *\n * @public\n */\n",
21206
+ "excerptTokens": [
21207
+ {
21208
+ "kind": "Content",
21209
+ "text": "fetchAndSaveExperienceControlsWire: "
21210
+ },
21211
+ {
21212
+ "kind": "Content",
21213
+ "text": "import(\"../..\")."
21214
+ },
21215
+ {
21216
+ "kind": "Reference",
21217
+ "text": "Wire",
21218
+ "canonicalReference": "@empathyco/x-components!Wire:type"
21219
+ },
21220
+ {
21221
+ "kind": "Content",
21222
+ "text": "<import(\"@empathyco/x-types\")."
21223
+ },
21224
+ {
21225
+ "kind": "Reference",
21226
+ "text": "ExperienceControlsRequest",
21227
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsRequest:interface"
21228
+ },
21229
+ {
21230
+ "kind": "Content",
21231
+ "text": " | null>"
21232
+ }
21233
+ ],
21234
+ "fileUrlPath": "src/x-modules/experience-controls/wiring.ts",
21235
+ "isReadonly": true,
21236
+ "releaseTag": "Public",
21237
+ "name": "fetchAndSaveExperienceControlsWire",
21238
+ "variableTypeTokenRange": {
21239
+ "startIndex": 1,
21240
+ "endIndex": 6
21241
+ }
21242
+ },
20190
21243
  {
20191
21244
  "kind": "Interface",
20192
21245
  "canonicalReference": "@empathyco/x-components!FetchAndSaveHooks:interface",
@@ -21192,6 +22245,34 @@
21192
22245
  "endIndex": 6
21193
22246
  }
21194
22247
  },
22248
+ {
22249
+ "kind": "Variable",
22250
+ "canonicalReference": "@empathyco/x-components!fetchExperienceControlsResponse:var",
22251
+ "docComment": "/**\n * Default implementation for the {@link ExperienceControlsActions.fetchExperienceControlsResponse}.\n *\n * @param _context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions, provided by Vuex.\n *\n * @param request - The experience controls request to make.\n *\n * @returns The experience controls response.\n *\n * @public\n */\n",
22252
+ "excerptTokens": [
22253
+ {
22254
+ "kind": "Content",
22255
+ "text": "fetchExperienceControlsResponse: "
22256
+ },
22257
+ {
22258
+ "kind": "Reference",
22259
+ "text": "ExperienceControlsXStoreModule",
22260
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsXStoreModule:type"
22261
+ },
22262
+ {
22263
+ "kind": "Content",
22264
+ "text": "['actions']['fetchExperienceControlsResponse']"
22265
+ }
22266
+ ],
22267
+ "fileUrlPath": "src/x-modules/experience-controls/store/actions/fetch-experience-controls.action.ts",
22268
+ "isReadonly": true,
22269
+ "releaseTag": "Public",
22270
+ "name": "fetchExperienceControlsResponse",
22271
+ "variableTypeTokenRange": {
22272
+ "startIndex": 1,
22273
+ "endIndex": 3
22274
+ }
22275
+ },
21195
22276
  {
21196
22277
  "kind": "Variable",
21197
22278
  "canonicalReference": "@empathyco/x-components!fetchIdentifierResults:var",
@@ -66967,7 +68048,7 @@
66967
68048
  {
66968
68049
  "kind": "Reference",
66969
68050
  "text": "ExperienceControlsXEvents",
66970
- "canonicalReference": "@empathyco/x-components!~ExperienceControlsXEvents:interface"
68051
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsXEvents:interface"
66971
68052
  },
66972
68053
  {
66973
68054
  "kind": "Content",
@@ -68810,7 +69891,7 @@
68810
69891
  {
68811
69892
  "kind": "Reference",
68812
69893
  "text": "ExperienceControlsXModule",
68813
- "canonicalReference": "@empathyco/x-components!~ExperienceControlsXModule:type"
69894
+ "canonicalReference": "@empathyco/x-components!ExperienceControlsXModule:type"
68814
69895
  },
68815
69896
  {
68816
69897
  "kind": "Content",