feat(xcontrols): add actions

packages/x-components/src/wiring/events.types.ts

@@ -20,6 +20,7 @@ import { TaggingXEvents } from '../x-modules/tagging/events.types';
 import { UrlXEvents } from '../x-modules/url/events.types';
 import { XModuleName } from '../x-modules/x-modules.types';
 import { SemanticQueriesXEvents } from '../x-modules/semantic-queries/events.types';
+import { ExperienceControlsXEvents } from '../x-modules/experience-controls/events.types';
 import { WireMetadata } from './wiring.types';
 /* eslint-disable max-len */
 /**.
@@ -70,6 +71,7 @@ export interface XEventsTypes
     SearchXEvents,
     SemanticQueriesXEvents,
     TaggingXEvents,
+    ExperienceControlsXEvents,
     UrlXEvents {
   /**
    * The provided number of columns of a grid has changed.

packages/x-components/src/x-modules/experience-controls/events.types.ts

@@ -0,0 +1,14 @@
+import { XEventsTypes } from '../../wiring';
+
+/**
+ * Dictionary of the events of Experience Controls XModule.
+ *
+ * @public
+ */
+export interface ExperienceControlsXEvents {
+  /**
+   * The experience-controls-events closed following its events configuration.
+   * * Payload: none.
+   */
+  ExperienceControlsClosed: Partial<XEventsTypes>;
+}

packages/x-components/src/x-modules/experience-controls/store/actions/fetch-and-save-controls.action.ts

@@ -0,0 +1,29 @@
+import { createFetchAndSaveActions } from '../../../../store/utils/fetch-and-save-action.utils';
+import { ExperienceControlsActionContext } from '../types';
+
+const { fetchAndSave, cancelPrevious } = createFetchAndSaveActions<
+  ExperienceControlsActionContext,
+  any,
+  any
+>({
+  fetch({ dispatch }, request) {
+    return dispatch('fetchControls', request);
+  },
+  onSuccess({ commit }, controls) {
+    commit('setControls', controls);
+  }
+});
+
+/**
+ * Default implementation for {@link ExperienceControlsActions.fetchAndSaveControls} action.
+ *
+ * @public
+ */
+export const fetchAndSaveControls = fetchAndSave;
+
+/**
+ * Default implementation for {@link ExperienceControlsActions.cancelFetchAndSaveControls} action.
+ *
+ * @public
+ */
+export const cancelFetchAndSaveControls = cancelPrevious;

packages/x-components/src/x-modules/experience-controls/store/actions/fetch-controls.action.ts

@@ -0,0 +1,21 @@
+import { ExperienceControlsXStoreModule } from '../types';
+
+/**
+ * Default implementation for the {@link ExperienceControlsActions.fetchControls}.
+ *
+ * @param _context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions,
+ * provided by Vuex.
+ * @param request - To be done.
+ * @returns To be done.
+ *
+ * @public
+ */
+
+export const fetchControls: ExperienceControlsXStoreModule['actions']['fetchControls'] = () => {
+  return fetch(
+    // eslint-disable-next-line max-len
+    'https://config-service.internal.test.empathy.co/public/configs?service=xcontrols&instance=empathy'
+  ).then(response => response.json());
+
+  //return XPlugin.adapter.experienceControls(request).then(({ controls }) => controls);
+};

packages/x-components/src/x-modules/experience-controls/store/emitters.ts

@@ -1,6 +1,9 @@
+import { createStoreEmitters } from '../../../store';
+import { experienceControlsXStoreModule } from './module';
+
 /**
- * {@link StoreEmitters} For the experience-controls module.
+ * {@link StoreEmitters} For the {@link ExperienceControlsXModule}.
  *
  * @internal
  */
-export const experienceControlsEmitters = {};
+export const experienceControlsEmitters = createStoreEmitters(experienceControlsXStoreModule, {});

packages/x-components/src/x-modules/experience-controls/store/module.ts

@@ -1,3 +1,5 @@
+import { fetchAndSaveControls } from './actions/fetch-and-save-controls.action';
+import { fetchControls } from './actions/fetch-controls.action';
 import { ExperienceControlsXStoreModule } from './types';
 
 /**.
@@ -20,5 +22,8 @@ export const experienceControlsXStoreModule: ExperienceControlsXStoreModule = {
       Object.assign(state.events, events);
     }
   },
-  actions: {}
+  actions: {
+    fetchControls,
+    fetchAndSaveControls
+  }
 };

packages/x-components/src/x-modules/experience-controls/store/types.ts

@@ -43,7 +43,20 @@ export interface ExperienceControlsMutations {
   setEvents(events: Partial<XEventsTypes>): void;
 }
 
-export interface ExperienceControlsActions {}
+export interface ExperienceControlsActions {
+  /**
+   * Fetches the {@link ExperienceControlsState.controls} property.
+   *
+   * @param request - The request to fetch the {@link ExperienceControlsState.controls}.
+   * @returns A promise of the {@link ExperienceControlsState.controls}.
+   */
+  fetchControls(request: any): Promise<{ [key: string]: unknown }>;
+
+  /**
+   * Fetches and saves the {@link ExperienceControlsState.controls} property.
+   */
+  fetchAndSaveControls(request: any): void;
+}
 
 /**
  * Experience Controls type safe store module.

packages/x-components/src/x-modules/experience-controls/wiring.ts

@@ -1,8 +1,20 @@
+import { wireCommit } from '../../wiring';
 import { createWiring } from '../../wiring/wiring.utils';
 
+/**
+ * WireCommit for {@link ExperienceControlsXModule}.
+ *
+ * @internal
+ */
+export const controlEvents = wireCommit('setControls');
+
 /**
  * Wiring configuration for the {@link ExperienceControlsXModule | experience-controls module}.
  *
  * @internal
  */
-export const experienceControlsWiring = createWiring({});
+export const experienceControlsWiring = createWiring({
+  ExperienceControlsClosed: {
+    controlEvents
+  }
+});