slice-machine-ui 1.23.2-alpha.bmo-add-github-settings-page.5 → 1.23.2-alpha.bmo-add-github-settings-page.7

package/src/modules/useSliceMachineActions.ts

@@ -10,7 +10,7 @@ import {
   hasSeenTutorialsToolTipCreator,
   hasSeenSimulatorToolTipCreator,
   hasSeenChangesToolTipCreator,
-  changesPushSuccessCreator,
+  changesPushSuccess,
 } from "./userContext";
 import { getChangelogCreator, refreshStateCreator } from "./environment";
 import {
@@ -19,17 +19,17 @@ import {
 } from "./simulator";
 import ServerState from "@models/server/ServerState";
 import {
-  createCustomTypeCreator,
-  deleteCustomTypeCreator,
-  renameAvailableCustomType,
-  saveCustomTypeCreator,
+  customTypeCreateSuccess,
+  customTypeDeleteSuccess,
+  customTypeRenameSuccess,
+  customTypeSaveSuccess,
 } from "./availableCustomTypes";
 import {
-  createSlice,
-  deleteSliceCreator,
-  generateSliceCustomScreenshotCreator,
-  renameSliceCreator,
-  updateSliceCreator,
+  sliceCreateSuccess,
+  sliceDeleteSuccess,
+  sliceGenerateCustomScreenshotSuccess,
+  sliceUpdateSuccess,
+  sliceRenameSuccess,
 } from "./slices";
 import { UserContextStoreType, UserReviewType } from "./userContext/types";
 import { GenericToastTypes, openToasterCreator } from "./toaster";
@@ -38,8 +38,8 @@ import { CustomType } from "@prismicio/types-internal/lib/customtypes";
 import { ComponentUI, ScreenshotUI } from "../../lib/models/common/ComponentUI";
 import { saveSliceMockCreator } from "./simulator";
 import { SaveSliceMockRequest } from "@src/apiClient";
-import { CustomTypeFormat } from "@slicemachine/manager";
 import { LibraryUI } from "@lib/models/common/LibraryUI";
+import { SliceSM } from "@lib/models/common/Slice";
 
 const useSliceMachineActions = () => {
   const dispatch = useDispatch();
@@ -62,14 +62,8 @@ const useSliceMachineActions = () => {
     dispatch(modalOpenCreator({ modalKey: ModalKeysEnum.LOGIN }));
   const openScreenshotsModal = () =>
     dispatch(modalOpenCreator({ modalKey: ModalKeysEnum.SCREENSHOTS }));
-  const openRenameSliceModal = () =>
-    dispatch(modalOpenCreator({ modalKey: ModalKeysEnum.RENAME_SLICE }));
-  const openCreateCustomTypeModal = () =>
-    dispatch(modalOpenCreator({ modalKey: ModalKeysEnum.CREATE_CUSTOM_TYPE }));
   const openScreenshotPreviewModal = () =>
     dispatch(modalOpenCreator({ modalKey: ModalKeysEnum.SCREENSHOT_PREVIEW }));
-  const openDeleteSliceModal = () =>
-    dispatch(modalOpenCreator({ modalKey: ModalKeysEnum.DELETE_SLICE }));
   const openSimulatorSetupModal = () =>
     dispatch(modalOpenCreator({ modalKey: ModalKeysEnum.SIMULATOR_SETUP }));
 
@@ -104,122 +98,112 @@ const useSliceMachineActions = () => {
     dispatch(hasSeenTutorialsToolTipCreator());
   const setSeenChangesToolTip = () => dispatch(hasSeenChangesToolTipCreator());
 
-  // Custom types module
-  const createCustomType = (
-    id: string,
-    label: string,
-    repeatable: boolean,
-    format: CustomTypeFormat,
-  ) =>
+  // Toaster store
+  const openToaster = (
+    content: string | React.ReactNode,
+    type: GenericToastTypes,
+  ) => dispatch(openToasterCreator({ content, type }));
+
+  // Simulator
+  const saveSliceMock = (payload: SaveSliceMockRequest) =>
+    dispatch(saveSliceMockCreator.request(payload));
+
+  // State Action (used by multiple stores)
+  const refreshState = (serverState: ServerState) => {
     dispatch(
-      createCustomTypeCreator.request({ id, label, repeatable, format }),
+      refreshStateCreator({
+        env: serverState.env,
+        remoteCustomTypes: serverState.remoteCustomTypes,
+        localCustomTypes: serverState.customTypes,
+        libraries: serverState.libraries,
+        remoteSlices: serverState.remoteSlices,
+        clientError: serverState.clientError,
+      }),
     );
+  };
+
+  const getChangelog = () => {
+    dispatch(getChangelogCreator.request());
+  };
 
   /**
    * Success actions = sync store state from external actions. If its name
    * contains "Creator", it means it is still used in a saga and that `.request`
    * and `.failure` need to be preserved
    */
+
+  /**
+   * Custom Type module
+   */
+  const createCustomTypeSuccess = (newCustomType: CustomType) =>
+    dispatch(
+      customTypeCreateSuccess({
+        newCustomType: CustomTypes.toSM(newCustomType),
+      }),
+    );
   const saveCustomTypeSuccess = (customType: CustomType) =>
     dispatch(
-      saveCustomTypeCreator.success({
-        customType: CustomTypes.toSM(customType),
+      customTypeSaveSuccess({
+        newCustomType: CustomTypes.toSM(customType),
       }),
     );
-
   const deleteCustomTypeSuccess = (id: string) =>
     dispatch(
-      deleteCustomTypeCreator.success({
+      customTypeDeleteSuccess({
         customTypeId: id,
       }),
     );
-
-  const renameAvailableCustomTypeSuccess = (customType: CustomType) =>
+  const renameCustomTypeSuccess = (customType: CustomType) =>
     dispatch(
-      renameAvailableCustomType({
+      customTypeRenameSuccess({
         renamedCustomType: CustomTypes.toSM(customType),
       }),
     );
 
-  /** End of sucess actions */
-
-  // Slice module
+  /**
+   * Slice module
+   */
   const saveSliceSuccess = (component: ComponentUI) => {
     dispatch(
-      updateSliceCreator.success({
+      sliceUpdateSuccess({
         component,
       }),
     );
   };
-
   const saveSliceCustomScreenshotSuccess = (
     variationId: string,
     screenshot: ScreenshotUI,
     component: ComponentUI,
   ) => {
     dispatch(
-      generateSliceCustomScreenshotCreator.success({
+      sliceGenerateCustomScreenshotSuccess({
         variationId,
         screenshot,
         component,
       }),
     );
   };
-
   const createSliceSuccess = (libraries: readonly LibraryUI[]) =>
-    dispatch(createSlice({ libraries }));
-
-  const renameSlice = (
-    libName: string,
-    sliceId: string,
-    newSliceName: string,
-  ) =>
+    dispatch(sliceCreateSuccess({ libraries }));
+  const deleteSliceSuccess = (sliceId: string, libName: string) =>
     dispatch(
-      renameSliceCreator.request({
+      sliceDeleteSuccess({
         sliceId,
-        newSliceName,
         libName,
       }),
     );
-
-  const deleteSlice = (sliceId: string, sliceName: string, libName: string) =>
+  const renameSliceSuccess = (libName: string, renamedSlice: SliceSM) =>
     dispatch(
-      deleteSliceCreator.request({
-        sliceId,
-        sliceName,
+      sliceRenameSuccess({
+        renamedSlice,
         libName,
       }),
     );
 
-  const pushChangesSuccess = () => dispatch(changesPushSuccessCreator());
-
-  // Toaster store
-  const openToaster = (
-    content: string | React.ReactNode,
-    type: GenericToastTypes,
-  ) => dispatch(openToasterCreator({ content, type }));
-
-  // Simulator
-  const saveSliceMock = (payload: SaveSliceMockRequest) =>
-    dispatch(saveSliceMockCreator.request(payload));
-
-  // State Action (used by multiple stores)
-  const refreshState = (serverState: ServerState) => {
-    dispatch(
-      refreshStateCreator({
-        env: serverState.env,
-        remoteCustomTypes: serverState.remoteCustomTypes,
-        localCustomTypes: serverState.customTypes,
-        libraries: serverState.libraries,
-        remoteSlices: serverState.remoteSlices,
-        clientError: serverState.clientError,
-      }),
-    );
-  };
-
-  const getChangelog = () => {
-    dispatch(getChangelogCreator.request());
-  };
+  /**
+   * Changes module
+   */
+  const pushChangesSuccess = () => dispatch(changesPushSuccess());
 
   return {
     checkSimulatorSetup,
@@ -233,31 +217,28 @@ const useSliceMachineActions = () => {
     stopLoadingLogin,
     stopLoadingReview,
     startLoadingReview,
-    createCustomType,
     deleteCustomTypeSuccess,
-    renameAvailableCustomTypeSuccess,
+    renameCustomTypeSuccess,
     saveCustomTypeSuccess,
     saveSliceSuccess,
     saveSliceCustomScreenshotSuccess,
     createSliceSuccess,
-    renameSlice,
-    deleteSlice,
+    renameSliceSuccess,
+    deleteSliceSuccess,
     sendAReview,
     skipReview,
     setUpdatesViewed,
     setSeenTutorialsToolTip,
     setSeenSimulatorToolTip,
     setSeenChangesToolTip,
-    openCreateCustomTypeModal,
     openScreenshotPreviewModal,
-    openDeleteSliceModal,
     openSimulatorSetupModal,
-    openRenameSliceModal,
     closeModals,
     openToaster,
     saveSliceMock,
     getChangelog,
     pushChangesSuccess,
+    createCustomTypeSuccess,
   };
 };
 

package/src/modules/userContext/index.ts

@@ -53,7 +53,7 @@ export const hasSeenChangesToolTipCreator = createAction(
   "USER_CONTEXT/VIEW_CHANGES_TOOL_TIP",
 )();
 
-export const changesPushSuccessCreator = createAction(
+export const changesPushSuccess = createAction(
   "USER_CONTEXT/CHANGES_PUSH_SUCCESS",
 )();
 
@@ -65,7 +65,7 @@ type userContextActions = ActionType<
   | typeof hasSeenSimulatorToolTipCreator
   | typeof hasSeenChangesToolTipCreator
   | typeof refreshStateCreator
-  | typeof changesPushSuccessCreator
+  | typeof changesPushSuccess
 >;
 
 // Selectors
@@ -140,7 +140,7 @@ export const userContextReducer: Reducer<
         authStatus: getAuthStatus(action.payload.clientError),
       };
     }
-    case getType(changesPushSuccessCreator): {
+    case getType(changesPushSuccess): {
       return {
         ...state,
         lastSyncChange: Date.now(),

package/src/redux/saga.ts

@@ -1,16 +1,12 @@
 import { fork } from "redux-saga/effects";
 
 import { watchSimulatorSagas } from "@src/modules/simulator";
-import { watchAvailableCustomTypesSagas } from "@src/modules/availableCustomTypes";
-import { watchSliceSagas } from "@src/modules/slices";
 import { watchToasterSagas } from "@src/modules/toaster";
 import { watchChangelogSagas } from "@src/modules/environment";
 
 // Single entry point to start all Sagas at once
 export default function* rootSaga() {
   yield fork(watchSimulatorSagas);
-  yield fork(watchAvailableCustomTypesSagas);
-  yield fork(watchSliceSagas);
   yield fork(watchToasterSagas);
   yield fork(watchChangelogSagas);
 }

package/test/src/modules/availableCustomTypes/index.test.ts

@@ -1,22 +1,10 @@
 import { describe, expect, it } from "vitest";
-import {
-  createCustomTypeSaga,
-  createCustomTypeCreator,
-  availableCustomTypesReducer,
-  deleteCustomTypeCreator,
-} from "@src/modules/availableCustomTypes";
-import { testSaga } from "redux-saga-test-plan";
+
+import { availableCustomTypesReducer } from "@src/modules/availableCustomTypes";
 import { AvailableCustomTypesStoreType } from "@src/modules/availableCustomTypes/types";
 import { refreshStateCreator } from "@src/modules/environment";
 
 import { dummyServerState } from "../__fixtures__/serverState";
-import { updateCustomType } from "@src/apiClient";
-import { createCustomType } from "@src/features/customTypes/customTypesTable/createCustomType";
-import { push } from "connected-next-router";
-import { modalCloseCreator } from "@src/modules/modal";
-import { openToasterCreator, ToasterType } from "@src/modules/toaster";
-import { CustomTypeSM, CustomTypes } from "@lib/models/common/CustomType";
-import { deleteSliceCreator } from "@src/modules/slices";
 
 const dummyCustomTypesState: AvailableCustomTypesStoreType = {};
 
@@ -57,234 +45,5 @@ describe("[Available Custom types module]", () => {
         },
       });
     });
-    it("should update the custom types state given CUSTOM_TYPES/CREATE.SUCCESS action", () => {
-      const createdCustomType: CustomTypeSM = {
-        id: "id",
-        label: "lama",
-        repeatable: false,
-        status: true,
-        format: "custom",
-        tabs: [
-          {
-            key: "Main",
-            value: [],
-          },
-        ],
-      };
-
-      const action = createCustomTypeCreator.success({
-        newCustomType: createdCustomType,
-      });
-
-      expect(
-        availableCustomTypesReducer(dummyCustomTypesState, action),
-      ).toEqual({
-        ...dummyCustomTypesState,
-        [createdCustomType.id]: {
-          local: createdCustomType,
-        },
-      });
-    });
-
-    it("should update the custom types state given CUSTOM_TYPES/DELETE.SUCCESS action", () => {
-      const customTypeIdToDelete = "id";
-      const mockCustomTypeToDelete: CustomTypeSM = {
-        id: "id",
-        label: "lama",
-        repeatable: false,
-        status: true,
-        format: "custom",
-        tabs: [
-          {
-            key: "Main",
-            value: [],
-          },
-        ],
-      };
-
-      const originalState = { ...dummyCustomTypesState };
-
-      originalState[customTypeIdToDelete] = {
-        local: mockCustomTypeToDelete,
-      };
-      mockCustomTypeToDelete.id = "another_ct";
-      originalState["another_ct"] = { local: mockCustomTypeToDelete };
-
-      const action = deleteCustomTypeCreator.success({
-        customTypeId: customTypeIdToDelete,
-      });
-
-      const result = availableCustomTypesReducer(originalState, action);
-
-      const expectState = { ...originalState };
-      delete expectState[customTypeIdToDelete];
-
-      expect(result).toEqual(expectState);
-    });
-
-    it("should update the custom types state given SLICES/DELETE.SUCCESS action", () => {
-      const sliceToDeleteId = "slice_id";
-      const mockCustomTypeToUpdate: CustomTypeSM = {
-        id: "id",
-        label: "lama",
-        repeatable: false,
-        status: true,
-        format: "custom",
-        tabs: [
-          {
-            key: "Main",
-            value: [],
-            sliceZone: {
-              key: "slices",
-              value: [
-                {
-                  key: sliceToDeleteId,
-                  value: {
-                    type: "SharedSlice",
-                  },
-                },
-                {
-                  key: "slice_2",
-                  value: {
-                    type: "SharedSlice",
-                  },
-                },
-              ],
-            },
-          },
-        ],
-      };
-
-      const originalState = { ...dummyCustomTypesState };
-
-      originalState["id"] = {
-        local: mockCustomTypeToUpdate,
-        remote: mockCustomTypeToUpdate,
-      };
-      const action = deleteSliceCreator.success({
-        sliceId: sliceToDeleteId,
-        sliceName: "slice_name",
-        libName: "lib",
-      });
-
-      const result = availableCustomTypesReducer(
-        originalState,
-        action,
-      ) as AvailableCustomTypesStoreType;
-
-      expect(
-        Object.values(result).flatMap((localAndRemote) => {
-          return Object.values(localAndRemote);
-        }),
-      ).not.toContain(undefined);
-
-      expect(result).toEqual({
-        id: {
-          local: {
-            id: "id",
-            label: "lama",
-            repeatable: false,
-            status: true,
-            format: "custom",
-            tabs: [
-              {
-                key: "Main",
-                value: [],
-                sliceZone: {
-                  key: "slices",
-                  value: [
-                    {
-                      key: "slice_2",
-                      value: {
-                        type: "SharedSlice",
-                      },
-                    },
-                  ],
-                },
-              },
-            ],
-          },
-          remote: mockCustomTypeToUpdate,
-        },
-      });
-    });
-  });
-
-  describe("[createCustomTypeSaga]", () => {
-    it("should call the api and dispatch the good actions on success", () => {
-      const actionPayload = {
-        format: "custom" as const, // CustomTypeFormat,
-        id: "id",
-        label: "label",
-        repeatable: true,
-      };
-      const customTypeCreated = CustomTypes.toSM(
-        createCustomType(
-          actionPayload.id,
-          actionPayload.label,
-          actionPayload.repeatable,
-          actionPayload.format,
-        ),
-      );
-      const saga = testSaga(
-        createCustomTypeSaga,
-        createCustomTypeCreator.request(actionPayload),
-      );
-
-      saga.next().call(updateCustomType, CustomTypes.fromSM(customTypeCreated));
-      saga
-        .next()
-        .put(
-          createCustomTypeCreator.success({ newCustomType: customTypeCreated }),
-        );
-      saga.next().put(modalCloseCreator());
-      saga.next().put(
-        push({
-          pathname: "/custom-types/id",
-          query: undefined,
-        }),
-      );
-      saga
-        .next()
-        .inspect(
-          (action: {
-            payload: { action: { type: string; payload: { type: string } } };
-          }) => {
-            expect(action.payload.action.type).toBe("TOASTER/OPEN");
-            expect(action.payload.action.payload.type).toBe(
-              ToasterType.SUCCESS,
-            );
-          },
-        );
-      saga.next().isDone();
-    });
-
-    it("should call the api and dispatch the good actions on failure", () => {
-      const actionPayload = {
-        id: "id",
-        label: "label",
-        repeatable: true,
-        format: "custom" as const,
-      };
-      const customTypeCreated = createCustomType(
-        actionPayload.id,
-        actionPayload.label,
-        actionPayload.repeatable,
-        actionPayload.format,
-      );
-      const saga = testSaga(
-        createCustomTypeSaga,
-        createCustomTypeCreator.request(actionPayload),
-      );
-
-      saga.next().call(updateCustomType, customTypeCreated);
-      saga.throw(new Error()).put(
-        openToasterCreator({
-          content: "Internal Error: Custom type not saved",
-          type: ToasterType.ERROR,
-        }),
-      );
-      saga.next().isDone();
-    });
   });
 });