@m4l/testing 0.0.23 → 1.0.1

package/types/packages/testing/playwright/src/installers/index.d.ts

@@ -0,0 +1,20 @@
+export * from './installHostAlarmsCountRoute';
+export * from './installHostAreasRoute';
+export * from './installHostAuthenticatedBootstrapRoutes';
+export * from './installHostAuthenticatedMfModuleDictionaryRoute';
+export * from './installHostAuthenticatedMfPreviewBootstrap';
+export * from './installHostAuthenticatedSessionRoute';
+export * from './installHostCookiesRoute';
+export * from './installHostGuestBootstrapRoutes';
+export * from './installHostGuestSessionRoute';
+export * from './installHostLocaleRoute';
+export * from './installHostMenusRoute';
+export * from './installHostModuleDictionaryRoute';
+export * from './installHostPasswordNewRoute';
+export * from './installHostPasswordResetRoute';
+export * from './installHostUiConfigAssetRoutes';
+export * from './installHostUiConfigRoute';
+export * from './installHostUserPreferencesRoute';
+export * from './installListEndpointRoute';
+export * from './installModulePrivilegesRoute';
+export * from './installMicrofrontendRenderStub';

package/types/packages/testing/playwright/src/installers/installHostAlarmsCountRoute.d.ts

@@ -0,0 +1,5 @@
+import type { InstallHostAlarmsCountRouteOptions } from '../types';
+/**
+ * Install the alarms-count route used by the host app-bar badge refresh flow.
+ */
+export declare function installHostAlarmsCountRoute(options: InstallHostAlarmsCountRouteOptions): Promise<void>;

package/types/packages/testing/playwright/src/installers/installHostAreasRoute.d.ts

@@ -0,0 +1,5 @@
+import type { InstallHostAreasRouteOptions } from '../types';
+/**
+ * Install the authenticated areas route used by the host platform shell.
+ */
+export declare function installHostAreasRoute(options: InstallHostAreasRouteOptions): Promise<void>;

package/types/packages/testing/playwright/src/installers/installHostAuthenticatedBootstrapRoutes.d.ts

@@ -0,0 +1,6 @@
+import type { InstallHostAuthenticatedBootstrapRoutesOptions } from '../types';
+/**
+ * Install the standard authenticated bootstrap route set used by host-style
+ * platform shells.
+ */
+export declare function installHostAuthenticatedBootstrapRoutes(options: InstallHostAuthenticatedBootstrapRoutesOptions): Promise<void>;

package/types/packages/testing/playwright/src/installers/installHostAuthenticatedMfModuleDictionaryRoute.d.ts

@@ -0,0 +1,5 @@
+import type { InstallHostAuthenticatedMfModuleDictionaryRouteOptions } from '../types';
+/**
+ * Install the standard authenticated MF module-dictionary route after host-side launch.
+ */
+export declare function installHostAuthenticatedMfModuleDictionaryRoute(options: InstallHostAuthenticatedMfModuleDictionaryRouteOptions): Promise<void>;

package/types/packages/testing/playwright/src/installers/installHostAuthenticatedMfPreviewBootstrap.d.ts

@@ -0,0 +1,11 @@
+import type { InstallHostAuthenticatedMfPreviewBootstrapOptions } from '../types';
+/**
+ * Install the authenticated host-shell baseline plus one deterministic MF menu entry.
+ *
+ * `menuPosition` decides which host menu carries that entry. `sidebar` (the default) is
+ * the door every list module has. `account` publishes the entry to the avatar popover
+ * instead and leaves the sidebar empty, which is the only faithful shape for the
+ * user-scoped preferences modules: the product never lists them in the sidebar, so a
+ * suite that found them there would be passing on an invented door.
+ */
+export declare function installHostAuthenticatedMfPreviewBootstrap(options: InstallHostAuthenticatedMfPreviewBootstrapOptions): Promise<void>;

package/types/packages/testing/playwright/src/installers/installHostAuthenticatedSessionRoute.d.ts

@@ -0,0 +1,6 @@
+import type { InstallHostAuthenticatedSessionRouteOptions } from '../types';
+/**
+ * Install the authenticated session bootstrap route used by host platform
+ * flows.
+ */
+export declare function installHostAuthenticatedSessionRoute(options: InstallHostAuthenticatedSessionRouteOptions): Promise<void>;

package/types/packages/testing/playwright/src/installers/installHostCookiesRoute.d.ts

@@ -0,0 +1,8 @@
+import type { InstallHostCookiesRouteOptions } from '../types';
+/**
+ * Install the cookies route used by the host platform shell.
+ * The authenticated baseline needs deterministic GET data plus an in-memory
+ * mutation store so close/reopen flows can observe the cookie writes they just
+ * persisted through the shell seam.
+ */
+export declare function installHostCookiesRoute(options: InstallHostCookiesRouteOptions): Promise<void>;

package/types/packages/testing/playwright/src/installers/installHostGuestBootstrapRoutes.d.ts

@@ -0,0 +1,7 @@
+import type { InstallHostGuestBootstrapRoutesOptions } from '../types';
+/**
+ * Install the standard guest bootstrap route set used by host-style apps.
+ * Reuse this when the flow matches the shared host shell; keep selectors and
+ * feature assertions local to the owning app E2E project.
+ */
+export declare function installHostGuestBootstrapRoutes(options: InstallHostGuestBootstrapRoutesOptions): Promise<void>;

package/types/packages/testing/playwright/src/installers/installHostGuestSessionRoute.d.ts

@@ -0,0 +1,7 @@
+import type { InstallHostGuestSessionRouteOptions } from '../types';
+/**
+ * Install the unauthenticated session bootstrap route used by host guest flows.
+ * This only handles the initial GET auth probe and lets app-specific POST login
+ * flows stay local or use separate installers.
+ */
+export declare function installHostGuestSessionRoute(options: InstallHostGuestSessionRouteOptions): Promise<void>;

package/types/packages/testing/playwright/src/installers/installHostLocaleRoute.d.ts

@@ -0,0 +1,5 @@
+import type { InstallHostLocaleRouteOptions } from '../types';
+/**
+ * Install the host locale bootstrap route used before the app shell renders.
+ */
+export declare function installHostLocaleRoute(options: InstallHostLocaleRouteOptions): Promise<void>;

package/types/packages/testing/playwright/src/installers/installHostMenusRoute.d.ts

@@ -0,0 +1,11 @@
+import type { InstallHostMenusRouteOptions } from '../types';
+/**
+ * Install the menus route used by the host platform shell.
+ * Keep concrete menu-item shapes local to the consuming app when a test cares
+ * about menu interaction details.
+ *
+ * Serves `accountMenuData` to the account popover when the caller supplies it, and
+ * `menuData` to everything else. Without `accountMenuData` both positions answer with
+ * `menuData`, preserving the behaviour every suite written before the split relies on.
+ */
+export declare function installHostMenusRoute(options: InstallHostMenusRouteOptions): Promise<void>;

package/types/packages/testing/playwright/src/installers/installHostModuleDictionaryRoute.d.ts

@@ -0,0 +1,6 @@
+import type { InstallHostModuleDictionaryRouteOptions } from '../types';
+/**
+ * Install the no-auth/auth module-dictionary bootstrap route for a specific
+ * module. Keep module-specific dictionary contents local to the app E2E project.
+ */
+export declare function installHostModuleDictionaryRoute(options: InstallHostModuleDictionaryRouteOptions): Promise<void>;

package/types/packages/testing/playwright/src/installers/installHostPasswordNewRoute.d.ts

@@ -0,0 +1,6 @@
+import type { InstallHostPasswordNewRouteOptions } from '../types';
+/**
+ * Install the shared new-password submit route used by host-style guest
+ * flows.
+ */
+export declare function installHostPasswordNewRoute(options: InstallHostPasswordNewRouteOptions): Promise<void>;

package/types/packages/testing/playwright/src/installers/installHostPasswordResetRoute.d.ts

@@ -0,0 +1,6 @@
+import type { InstallHostPasswordResetRouteOptions } from '../types';
+/**
+ * Install the shared password-reset submit route used by host-style guest
+ * flows.
+ */
+export declare function installHostPasswordResetRoute(options: InstallHostPasswordResetRouteOptions): Promise<void>;

package/types/packages/testing/playwright/src/installers/installHostUiConfigAssetRoutes.d.ts

@@ -0,0 +1,9 @@
+import type { HostUIConfigFixture } from '../types';
+/**
+ * Install placeholder asset routes for UI-config-driven branding assets so the
+ * no-auth shell can render deterministically without hitting remote storage.
+ */
+export declare function installHostUiConfigAssetRoutes(options: {
+    page: import('@playwright/test').Page;
+    uiConfig?: Partial<HostUIConfigFixture>;
+}): Promise<void>;

package/types/packages/testing/playwright/src/installers/installHostUiConfigRoute.d.ts

@@ -0,0 +1,7 @@
+import type { InstallHostUIConfigRouteOptions } from '../types';
+/**
+ * Install the blocking host UI-config route used during the first app-shell
+ * bootstrap. App E2E projects should keep only flow-specific assertions local
+ * and reuse this shared network contract when the bootstrap behavior is the same.
+ */
+export declare function installHostUiConfigRoute(options: InstallHostUIConfigRouteOptions): Promise<void>;

package/types/packages/testing/playwright/src/installers/installHostUserPreferencesRoute.d.ts

@@ -0,0 +1,6 @@
+import type { InstallHostUserPreferencesRouteOptions } from '../types';
+/**
+ * Install the authenticated user-preferences bootstrap route used by the host
+ * platform shell before authenticated runtime providers settle.
+ */
+export declare function installHostUserPreferencesRoute(options: InstallHostUserPreferencesRouteOptions): Promise<void>;

package/types/packages/testing/playwright/src/installers/installListEndpointRoute.d.ts

@@ -0,0 +1,7 @@
+import type { InstallListEndpointRouteOptions } from '../types';
+/**
+ * Intercept a list microfrontend's data endpoint and fulfill it with the shared
+ * `{ data, pager }` envelope, so any list E2E renders a deterministic set of rows
+ * without reaching a real backend.
+ */
+export declare function installListEndpointRoute<TRow>(options: InstallListEndpointRouteOptions<TRow>): Promise<void>;

package/types/packages/testing/playwright/src/installers/installMicrofrontendRenderStub.d.ts

@@ -0,0 +1,9 @@
+import type { InstallMicrofrontendRenderStubOptions } from '../types';
+/**
+ * Install a deterministic `window.render_v2_<prefix>_<moduleId>` /
+ * `window.unmount_<prefix>_<moduleId>` contract so host-shell E2E coverage can
+ * validate MF window ownership without downloading a real remote bundle.
+ *
+ * Keep app-specific selectors and assertions local to the consuming E2E project.
+ */
+export declare function installMicrofrontendRenderStub(options: InstallMicrofrontendRenderStubOptions): Promise<void>;

package/types/packages/testing/playwright/src/installers/installModulePrivilegesRoute.d.ts

@@ -0,0 +1,11 @@
+import type { InstallModulePrivilegesRouteOptions } from '../types';
+/**
+ * Grant module privileges in a host-preview E2E by intercepting the privileges
+ * probe (`GET auth/login?privileges=...`) and returning the granted keys. The
+ * module's `hasPrivilege(key)` only checks key presence, so any present key
+ * enables its privilege-gated action (e.g. the Add button).
+ *
+ * Install this AFTER the authenticated bootstrap so it takes precedence over the
+ * session route, which also matches `auth/login` but without the privileges query.
+ */
+export declare function installModulePrivilegesRoute(options: InstallModulePrivilegesRouteOptions): Promise<void>;