orphic-cypress/src/intercept.ts

Set of utilities and typescript transformers to cover storybook stories with cypress component tests

import { Method } from "cypress/types/net-stubbing";

/**
 * Turn mockData intended for storybook plugin storybook-addon-mock
 * into cypress intercepts. Very likely to be used in a beforeEach.
 * Aliases as the url provided for each mock. Nothing crazy happening
 * here, you could just write `cy.intercept`s for non-storybook component
 * tests, or nbd to have ones that are redundant of mockData
 */
export const mockToCyIntercept = (
  mockData: Array<{
    /** url pattern to intercept */
    url: string;
    /** REST method */
    method: string;
    /** Expected status code */
    status: number;
    /** Response to send upon mocked request */
    response: unknown;
    /** Optionally alias intercept as a given name rather than full url */
    alias?: string;
  }>
) =>
  mockData.forEach(({ response, status, url, method, alias }) => {
    cy.intercept(method as Method, url, {
      body: response,
      statusCode: status,
    }).as(alias ?? url);
  });