@apollo/client 3.9.0-alpha.3 → 3.9.0-alpha.5

package/testing/internal/profile/Render.d.ts

@@ -1,4 +1,6 @@
+/// <reference types="react" />
 import { screen } from "@testing-library/dom";
+/** @internal */
 export interface BaseRender {
     id: string;
     phase: "mount" | "update" | "nested-update";
@@ -6,22 +8,50 @@ export interface BaseRender {
     baseDuration: number;
     startTime: number;
     commitTime: number;
+    /**
+     * The number of renders that have happened so far (including this render).
+     */
     count: number;
 }
 type Screen = typeof screen;
+/** @internal */
 export type SyncScreen = {
     [K in keyof Screen]: K extends `find${string}` ? {
+        /** @deprecated A snapshot is static, so avoid async queries! */
         (...args: Parameters<Screen[K]>): ReturnType<Screen[K]>;
     } : Screen[K];
 };
+/** @internal */
 export interface Render<Snapshot> extends BaseRender {
+    /**
+     * The snapshot, as returned by the `takeSnapshot` option of `profile`.
+     * (If using `profileHook`, this is the return value of the hook.)
+     */
     snapshot: Snapshot;
+    /**
+     * A DOM snapshot of the rendered component, if the `snapshotDOM`
+     * option of `profile` was enabled.
+     */
     readonly domSnapshot: HTMLElement;
+    /**
+     * Returns a callback to receive a `screen` instance that is scoped to the
+     * DOM snapshot of this `Render` instance.
+     * Note: this is used as a callback to prevent linter errors.
+     * @example
+     * ```diff
+     * const { withinDOM } = RenderedComponent.takeRender();
+     * -expect(screen.getByText("foo")).toBeInTheDocument();
+     * +expect(withinDOM().getByText("foo")).toBeInTheDocument();
+     * ```
+     */
     withinDOM: () => SyncScreen;
+    renderedComponents: Array<string | React.ComponentType>;
 }
+/** @internal */
 export declare class RenderInstance<Snapshot> implements Render<Snapshot> {
     snapshot: Snapshot;
     private stringifiedDOM;
+    renderedComponents: Array<string | React.ComponentType>;
     id: string;
     phase: "mount" | "update" | "nested-update";
     actualDuration: number;
@@ -29,7 +59,7 @@ export declare class RenderInstance<Snapshot> implements Render<Snapshot> {
     startTime: number;
     commitTime: number;
     count: number;
-    constructor(baseRender: BaseRender, snapshot: Snapshot, stringifiedDOM: string | undefined);
+    constructor(baseRender: BaseRender, snapshot: Snapshot, stringifiedDOM: string | undefined, renderedComponents: Array<string | React.ComponentType>);
     private _domSnapshot;
     get domSnapshot(): HTMLElement;
     get withinDOM(): () => {
@@ -135,6 +165,7 @@ export declare class RenderInstance<Snapshot> implements Render<Snapshot> {
         logTestingPlaygroundURL: (element?: Element | HTMLDocument | undefined) => void;
     };
 }
+/** @internal */
 export declare function errorOnDomInteraction(): void;
 export {};
 //# sourceMappingURL=Render.d.ts.map

package/testing/internal/profile/Render.js

@@ -1,11 +1,22 @@
+/* istanbul ignore file */
 import { __spreadArray } from "tslib";
+/*
+Something in this file does not compile correctly while measuring code coverage
+and will lead to a
+  Uncaught [ReferenceError: cov_1zb8w312au is not defined]
+if we do not ignore this file in code coverage.
+
+As we only use this file in our internal tests, we can safely ignore it.
+*/
 import { within, screen } from "@testing-library/dom";
 import { JSDOM, VirtualConsole } from "jsdom";
 import { applyStackTrace, captureStackTrace } from "./traces.js";
-var RenderInstance = (function () {
-    function RenderInstance(baseRender, snapshot, stringifiedDOM) {
+/** @internal */
+var RenderInstance = /** @class */ (function () {
+    function RenderInstance(baseRender, snapshot, stringifiedDOM, renderedComponents) {
         this.snapshot = snapshot;
         this.stringifiedDOM = stringifiedDOM;
+        this.renderedComponents = renderedComponents;
         this.id = baseRender.id;
         this.phase = baseRender.phase;
         this.actualDuration = baseRender.actualDuration;
@@ -71,6 +82,7 @@ var RenderInstance = (function () {
     return RenderInstance;
 }());
 export { RenderInstance };
+/** @internal */
 export function errorOnDomInteraction() {
     var events = [
         "auxclick",

package/testing/internal/profile/Render.js.map

@@ -1 +1 @@
-{"version":3,"file":"Render.js","sourceRoot":"","sources":["../../../../src/testing/internal/profile/Render.tsx"],"names":[],"mappings":";AAWA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAsDjE;IASE,wBACE,UAAsB,EACf,QAAkB,EACjB,cAAkC;QADnC,aAAQ,GAAR,QAAQ,CAAU;QACjB,mBAAc,GAAd,cAAc,CAAoB;QAE1C,IAAI,CAAC,EAAE,GAAG,UAAU,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;QAC9B,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;QAChD,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC;QAC5C,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;QACtC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;QACxC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;IAChC,CAAC;IAGD,sBAAI,uCAAW;aAAf;YACE,IAAI,IAAI,CAAC,YAAY;gBAAE,OAAO,IAAI,CAAC,YAAY,CAAC;YAChD,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;gBACxB,MAAM,IAAI,KAAK,CACb,qEAAqE,CACtE,CAAC;aACH;YAED,IAAM,cAAc,GAAG,IAAI,cAAc,EAAE,CAAC;YAC5C,IAAM,UAAU,GAAG,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;YAC3D,cAAc,CAAC,EAAE,CAAC,YAAY,EAAE,UAAC,KAAK;gBACpC,MAAM,eAAe,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;YAC3C,CAAC,CAAC,CAAC;YAEH,IAAM,OAAO,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE;gBAC7C,UAAU,EAAE,aAAa;gBACzB,cAAc,gBAAA;aACf,CAAC,CAAC;YACH,IAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC;YACzC,IAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;YAC3B,IAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YAChD,MAAM,CAAC,IAAI,GAAG,iBAAiB,CAAC;YAChC,MAAM,CAAC,IAAI,GAAG,oBACR,qBAAqB,CAAC,QAAQ,EAAE,wBAChC,qBAAqB,CAAC,IAAI,gBAC7B,CAAC;YACJ,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YACzB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YAEzB,OAAO,CAAC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;QACpC,CAAC;;;OAAA;IAED,sBAAI,qCAAS;aAAb;YAAA,iBAgBC;YAfC,IAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;gBACzD,KAAK,EAAE;oBACL,YAAqE;yBAArE,UAAqE,EAArE,qBAAqE,EAArE,IAAqE;wBAArE,uBAAqE;;oBAArE,IAAI,UAAsB,EAAtB,GAAG,mBAAG,KAAI,CAAC,WAAW,KAAA,EAAK,IAAI,cAAA,CAAkC;oBAErE,MAAM,CAAC,KAAK,OAAZ,MAAM,iBAAO,GAAG,GAAK,IAAI,UAAE;gBAC7B,CAAC;gBACD,uBAAuB,EAAE;oBACvB,YAEC;yBAFD,UAEC,EAFD,qBAEC,EAFD,IAEC;wBAFD,uBAEC;;oBAFD,IAAI,UAAsB,EAAtB,GAAG,mBAAG,KAAI,CAAC,WAAW,KAAA,EAAK,IAAI,cAAA,CAElC;oBAED,MAAM,CAAC,uBAAuB,OAA9B,MAAM,iBAAyB,GAAG,GAAK,IAAI,UAAE;gBAC/C,CAAC;aACF,CAAC,CAAC;YACH,OAAO,cAAM,OAAA,UAAU,EAAV,CAAU,CAAC;QAC1B,CAAC;;;OAAA;IACH,qBAAC;AAAD,CAAC,AAzED,IAyEC;;AAED,MAAM,UAAU,qBAAqB;IACnC,IAAM,MAAM,GAAkC;QAC5C,UAAU;QACV,MAAM;QACN,QAAQ;QACR,OAAO;QACP,MAAM;QACN,KAAK;QACL,UAAU;QACV,MAAM;QACN,SAAS;QACT,WAAW;QACX,WAAW;QACX,UAAU;QACV,WAAW;QACX,MAAM;QACN,OAAO;QACP,SAAS;QACT,UAAU;QACV,OAAO;QACP,SAAS;QACT,UAAU;QACV,OAAO;QACP,WAAW;QACX,YAAY;QACZ,YAAY;QACZ,WAAW;QACX,UAAU;QACV,WAAW;QACX,SAAS;QACT,OAAO;QACP,eAAe;QACf,aAAa;QACb,cAAc;QACd,cAAc;QACd,aAAa;QACb,YAAY;QACZ,aAAa;QACb,WAAW;QACX,QAAQ;QACR,QAAQ;QACR,iBAAiB;QACjB,aAAa;QACb,QAAQ;QACR,QAAQ;QACR,aAAa;QACb,UAAU;QACV,WAAW;QACX,YAAY;QACZ,OAAO;KACR,CAAC;IACF,SAAS,oBAAoB;QAC3B,MAAM,IAAI,KAAK,CAAC,8MAIf,CAAC,CAAC;IACL,CAAC;IACD,MAAM,CAAC,OAAO,CAAC,UAAC,KAAK;QACnB,QAAQ,CAAC,gBAAgB,CAAC,KAAK,EAAE,oBAAoB,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["/* istanbul ignore file */\n\n/*\nSomething in this file does not compile correctly while measuring code coverage\nand will lead to a\n  Uncaught [ReferenceError: cov_1zb8w312au is not defined]\nif we do not ignore this file in code coverage.\n\nAs we only use this file in our internal tests, we can safely ignore it.\n*/\n\nimport { within, screen } from \"@testing-library/dom\";\nimport { JSDOM, VirtualConsole } from \"jsdom\";\nimport { applyStackTrace, captureStackTrace } from \"./traces.js\";\n\n/** @internal */\nexport interface BaseRender {\n  id: string;\n  phase: \"mount\" | \"update\" | \"nested-update\";\n  actualDuration: number;\n  baseDuration: number;\n  startTime: number;\n  commitTime: number;\n  /**\n   * The number of renders that have happened so far (including this render).\n   */\n  count: number;\n}\n\ntype Screen = typeof screen;\n/** @internal */\nexport type SyncScreen = {\n  [K in keyof Screen]: K extends `find${string}`\n    ? {\n        /** @deprecated A snapshot is static, so avoid async queries! */\n        (...args: Parameters<Screen[K]>): ReturnType<Screen[K]>;\n      }\n    : Screen[K];\n};\n\n/** @internal */\nexport interface Render<Snapshot> extends BaseRender {\n  /**\n   * The snapshot, as returned by the `takeSnapshot` option of `profile`.\n   * (If using `profileHook`, this is the return value of the hook.)\n   */\n  snapshot: Snapshot;\n  /**\n   * A DOM snapshot of the rendered component, if the `snapshotDOM`\n   * option of `profile` was enabled.\n   */\n  readonly domSnapshot: HTMLElement;\n  /**\n   * Returns a callback to receive a `screen` instance that is scoped to the\n   * DOM snapshot of this `Render` instance.\n   * Note: this is used as a callback to prevent linter errors.\n   * @example\n   * ```diff\n   * const { withinDOM } = RenderedComponent.takeRender();\n   * -expect(screen.getByText(\"foo\")).toBeInTheDocument();\n   * +expect(withinDOM().getByText(\"foo\")).toBeInTheDocument();\n   * ```\n   */\n  withinDOM: () => SyncScreen;\n}\n\n/** @internal */\nexport class RenderInstance<Snapshot> implements Render<Snapshot> {\n  id: string;\n  phase: \"mount\" | \"update\" | \"nested-update\";\n  actualDuration: number;\n  baseDuration: number;\n  startTime: number;\n  commitTime: number;\n  count: number;\n\n  constructor(\n    baseRender: BaseRender,\n    public snapshot: Snapshot,\n    private stringifiedDOM: string | undefined\n  ) {\n    this.id = baseRender.id;\n    this.phase = baseRender.phase;\n    this.actualDuration = baseRender.actualDuration;\n    this.baseDuration = baseRender.baseDuration;\n    this.startTime = baseRender.startTime;\n    this.commitTime = baseRender.commitTime;\n    this.count = baseRender.count;\n  }\n\n  private _domSnapshot: HTMLElement | undefined;\n  get domSnapshot() {\n    if (this._domSnapshot) return this._domSnapshot;\n    if (!this.stringifiedDOM) {\n      throw new Error(\n        \"DOM snapshot is not available - please set the `snapshotDOM` option\"\n      );\n    }\n\n    const virtualConsole = new VirtualConsole();\n    const stackTrace = captureStackTrace(\"RenderInstance.get\");\n    virtualConsole.on(\"jsdomError\", (error) => {\n      throw applyStackTrace(error, stackTrace);\n    });\n\n    const snapDOM = new JSDOM(this.stringifiedDOM, {\n      runScripts: \"dangerously\",\n      virtualConsole,\n    });\n    const document = snapDOM.window.document;\n    const body = document.body;\n    const script = document.createElement(\"script\");\n    script.type = \"text/javascript\";\n    script.text = `\n        ${errorOnDomInteraction.toString()};\n        ${errorOnDomInteraction.name}();\n      `;\n    body.appendChild(script);\n    body.removeChild(script);\n\n    return (this._domSnapshot = body);\n  }\n\n  get withinDOM() {\n    const snapScreen = Object.assign(within(this.domSnapshot), {\n      debug: (\n        ...[dom = this.domSnapshot, ...rest]: Parameters<typeof screen.debug>\n      ) => {\n        screen.debug(dom, ...rest);\n      },\n      logTestingPlaygroundURL: (\n        ...[dom = this.domSnapshot, ...rest]: Parameters<\n          typeof screen.logTestingPlaygroundURL\n        >\n      ) => {\n        screen.logTestingPlaygroundURL(dom, ...rest);\n      },\n    });\n    return () => snapScreen;\n  }\n}\n/** @internal */\nexport function errorOnDomInteraction() {\n  const events: Array<keyof DocumentEventMap> = [\n    \"auxclick\",\n    \"blur\",\n    \"change\",\n    \"click\",\n    \"copy\",\n    \"cut\",\n    \"dblclick\",\n    \"drag\",\n    \"dragend\",\n    \"dragenter\",\n    \"dragleave\",\n    \"dragover\",\n    \"dragstart\",\n    \"drop\",\n    \"focus\",\n    \"focusin\",\n    \"focusout\",\n    \"input\",\n    \"keydown\",\n    \"keypress\",\n    \"keyup\",\n    \"mousedown\",\n    \"mouseenter\",\n    \"mouseleave\",\n    \"mousemove\",\n    \"mouseout\",\n    \"mouseover\",\n    \"mouseup\",\n    \"paste\",\n    \"pointercancel\",\n    \"pointerdown\",\n    \"pointerenter\",\n    \"pointerleave\",\n    \"pointermove\",\n    \"pointerout\",\n    \"pointerover\",\n    \"pointerup\",\n    \"scroll\",\n    \"select\",\n    \"selectionchange\",\n    \"selectstart\",\n    \"submit\",\n    \"toggle\",\n    \"touchcancel\",\n    \"touchend\",\n    \"touchmove\",\n    \"touchstart\",\n    \"wheel\",\n  ];\n  function warnOnDomInteraction() {\n    throw new Error(`\n    DOM interaction with a snapshot detected in test.\n    Please don't interact with the DOM you get from \\`withinDOM\\`,\n    but still use \\`screen\\' to get elements for simulating user interaction.\n    `);\n  }\n  events.forEach((event) => {\n    document.addEventListener(event, warnOnDomInteraction);\n  });\n}\n"]}
+{"version":3,"file":"Render.js","sourceRoot":"","sources":["../../../../src/testing/internal/profile/Render.tsx"],"names":[],"mappings":"AAAA,0BAA0B;;AAE1B;;;;;;;EAOE;AAEF,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAuDjE,gBAAgB;AAChB;IASE,wBACE,UAAsB,EACf,QAAkB,EACjB,cAAkC,EACnC,kBAAuD;QAFvD,aAAQ,GAAR,QAAQ,CAAU;QACjB,mBAAc,GAAd,cAAc,CAAoB;QACnC,uBAAkB,GAAlB,kBAAkB,CAAqC;QAE9D,IAAI,CAAC,EAAE,GAAG,UAAU,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;QAC9B,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;QAChD,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC;QAC5C,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;QACtC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;QACxC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;IAChC,CAAC;IAGD,sBAAI,uCAAW;aAAf;YACE,IAAI,IAAI,CAAC,YAAY;gBAAE,OAAO,IAAI,CAAC,YAAY,CAAC;YAChD,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CACb,qEAAqE,CACtE,CAAC;YACJ,CAAC;YAED,IAAM,cAAc,GAAG,IAAI,cAAc,EAAE,CAAC;YAC5C,IAAM,UAAU,GAAG,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;YAC3D,cAAc,CAAC,EAAE,CAAC,YAAY,EAAE,UAAC,KAAK;gBACpC,MAAM,eAAe,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;YAC3C,CAAC,CAAC,CAAC;YAEH,IAAM,OAAO,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE;gBAC7C,UAAU,EAAE,aAAa;gBACzB,cAAc,gBAAA;aACf,CAAC,CAAC;YACH,IAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC;YACzC,IAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;YAC3B,IAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YAChD,MAAM,CAAC,IAAI,GAAG,iBAAiB,CAAC;YAChC,MAAM,CAAC,IAAI,GAAG,oBACR,qBAAqB,CAAC,QAAQ,EAAE,wBAChC,qBAAqB,CAAC,IAAI,gBAC7B,CAAC;YACJ,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YACzB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YAEzB,OAAO,CAAC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;QACpC,CAAC;;;OAAA;IAED,sBAAI,qCAAS;aAAb;YAAA,iBAgBC;YAfC,IAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;gBACzD,KAAK,EAAE;oBACL,YAAqE;yBAArE,UAAqE,EAArE,qBAAqE,EAArE,IAAqE;wBAArE,uBAAqE;;oBAArE,IAAI,UAAsB,EAAtB,GAAG,mBAAG,KAAI,CAAC,WAAW,KAAA,EAAK,IAAI,cAAA,CAAkC;oBAErE,MAAM,CAAC,KAAK,OAAZ,MAAM,iBAAO,GAAG,GAAK,IAAI,UAAE;gBAC7B,CAAC;gBACD,uBAAuB,EAAE;oBACvB,YAEC;yBAFD,UAEC,EAFD,qBAEC,EAFD,IAEC;wBAFD,uBAEC;;oBAFD,IAAI,UAAsB,EAAtB,GAAG,mBAAG,KAAI,CAAC,WAAW,KAAA,EAAK,IAAI,cAAA,CAElC;oBAED,MAAM,CAAC,uBAAuB,OAA9B,MAAM,iBAAyB,GAAG,GAAK,IAAI,UAAE;gBAC/C,CAAC;aACF,CAAC,CAAC;YACH,OAAO,cAAM,OAAA,UAAU,EAAV,CAAU,CAAC;QAC1B,CAAC;;;OAAA;IACH,qBAAC;AAAD,CAAC,AA1ED,IA0EC;;AACD,gBAAgB;AAChB,MAAM,UAAU,qBAAqB;IACnC,IAAM,MAAM,GAAkC;QAC5C,UAAU;QACV,MAAM;QACN,QAAQ;QACR,OAAO;QACP,MAAM;QACN,KAAK;QACL,UAAU;QACV,MAAM;QACN,SAAS;QACT,WAAW;QACX,WAAW;QACX,UAAU;QACV,WAAW;QACX,MAAM;QACN,OAAO;QACP,SAAS;QACT,UAAU;QACV,OAAO;QACP,SAAS;QACT,UAAU;QACV,OAAO;QACP,WAAW;QACX,YAAY;QACZ,YAAY;QACZ,WAAW;QACX,UAAU;QACV,WAAW;QACX,SAAS;QACT,OAAO;QACP,eAAe;QACf,aAAa;QACb,cAAc;QACd,cAAc;QACd,aAAa;QACb,YAAY;QACZ,aAAa;QACb,WAAW;QACX,QAAQ;QACR,QAAQ;QACR,iBAAiB;QACjB,aAAa;QACb,QAAQ;QACR,QAAQ;QACR,aAAa;QACb,UAAU;QACV,WAAW;QACX,YAAY;QACZ,OAAO;KACR,CAAC;IACF,SAAS,oBAAoB;QAC3B,MAAM,IAAI,KAAK,CAAC,8MAIf,CAAC,CAAC;IACL,CAAC;IACD,MAAM,CAAC,OAAO,CAAC,UAAC,KAAK;QACnB,QAAQ,CAAC,gBAAgB,CAAC,KAAK,EAAE,oBAAoB,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["/* istanbul ignore file */\n\n/*\nSomething in this file does not compile correctly while measuring code coverage\nand will lead to a\n  Uncaught [ReferenceError: cov_1zb8w312au is not defined]\nif we do not ignore this file in code coverage.\n\nAs we only use this file in our internal tests, we can safely ignore it.\n*/\n\nimport { within, screen } from \"@testing-library/dom\";\nimport { JSDOM, VirtualConsole } from \"jsdom\";\nimport { applyStackTrace, captureStackTrace } from \"./traces.js\";\n\n/** @internal */\nexport interface BaseRender {\n  id: string;\n  phase: \"mount\" | \"update\" | \"nested-update\";\n  actualDuration: number;\n  baseDuration: number;\n  startTime: number;\n  commitTime: number;\n  /**\n   * The number of renders that have happened so far (including this render).\n   */\n  count: number;\n}\n\ntype Screen = typeof screen;\n/** @internal */\nexport type SyncScreen = {\n  [K in keyof Screen]: K extends `find${string}` ?\n    {\n      /** @deprecated A snapshot is static, so avoid async queries! */\n      (...args: Parameters<Screen[K]>): ReturnType<Screen[K]>;\n    }\n  : Screen[K];\n};\n\n/** @internal */\nexport interface Render<Snapshot> extends BaseRender {\n  /**\n   * The snapshot, as returned by the `takeSnapshot` option of `profile`.\n   * (If using `profileHook`, this is the return value of the hook.)\n   */\n  snapshot: Snapshot;\n  /**\n   * A DOM snapshot of the rendered component, if the `snapshotDOM`\n   * option of `profile` was enabled.\n   */\n  readonly domSnapshot: HTMLElement;\n  /**\n   * Returns a callback to receive a `screen` instance that is scoped to the\n   * DOM snapshot of this `Render` instance.\n   * Note: this is used as a callback to prevent linter errors.\n   * @example\n   * ```diff\n   * const { withinDOM } = RenderedComponent.takeRender();\n   * -expect(screen.getByText(\"foo\")).toBeInTheDocument();\n   * +expect(withinDOM().getByText(\"foo\")).toBeInTheDocument();\n   * ```\n   */\n  withinDOM: () => SyncScreen;\n\n  renderedComponents: Array<string | React.ComponentType>;\n}\n\n/** @internal */\nexport class RenderInstance<Snapshot> implements Render<Snapshot> {\n  id: string;\n  phase: \"mount\" | \"update\" | \"nested-update\";\n  actualDuration: number;\n  baseDuration: number;\n  startTime: number;\n  commitTime: number;\n  count: number;\n\n  constructor(\n    baseRender: BaseRender,\n    public snapshot: Snapshot,\n    private stringifiedDOM: string | undefined,\n    public renderedComponents: Array<string | React.ComponentType>\n  ) {\n    this.id = baseRender.id;\n    this.phase = baseRender.phase;\n    this.actualDuration = baseRender.actualDuration;\n    this.baseDuration = baseRender.baseDuration;\n    this.startTime = baseRender.startTime;\n    this.commitTime = baseRender.commitTime;\n    this.count = baseRender.count;\n  }\n\n  private _domSnapshot: HTMLElement | undefined;\n  get domSnapshot() {\n    if (this._domSnapshot) return this._domSnapshot;\n    if (!this.stringifiedDOM) {\n      throw new Error(\n        \"DOM snapshot is not available - please set the `snapshotDOM` option\"\n      );\n    }\n\n    const virtualConsole = new VirtualConsole();\n    const stackTrace = captureStackTrace(\"RenderInstance.get\");\n    virtualConsole.on(\"jsdomError\", (error) => {\n      throw applyStackTrace(error, stackTrace);\n    });\n\n    const snapDOM = new JSDOM(this.stringifiedDOM, {\n      runScripts: \"dangerously\",\n      virtualConsole,\n    });\n    const document = snapDOM.window.document;\n    const body = document.body;\n    const script = document.createElement(\"script\");\n    script.type = \"text/javascript\";\n    script.text = `\n        ${errorOnDomInteraction.toString()};\n        ${errorOnDomInteraction.name}();\n      `;\n    body.appendChild(script);\n    body.removeChild(script);\n\n    return (this._domSnapshot = body);\n  }\n\n  get withinDOM() {\n    const snapScreen = Object.assign(within(this.domSnapshot), {\n      debug: (\n        ...[dom = this.domSnapshot, ...rest]: Parameters<typeof screen.debug>\n      ) => {\n        screen.debug(dom, ...rest);\n      },\n      logTestingPlaygroundURL: (\n        ...[dom = this.domSnapshot, ...rest]: Parameters<\n          typeof screen.logTestingPlaygroundURL\n        >\n      ) => {\n        screen.logTestingPlaygroundURL(dom, ...rest);\n      },\n    });\n    return () => snapScreen;\n  }\n}\n/** @internal */\nexport function errorOnDomInteraction() {\n  const events: Array<keyof DocumentEventMap> = [\n    \"auxclick\",\n    \"blur\",\n    \"change\",\n    \"click\",\n    \"copy\",\n    \"cut\",\n    \"dblclick\",\n    \"drag\",\n    \"dragend\",\n    \"dragenter\",\n    \"dragleave\",\n    \"dragover\",\n    \"dragstart\",\n    \"drop\",\n    \"focus\",\n    \"focusin\",\n    \"focusout\",\n    \"input\",\n    \"keydown\",\n    \"keypress\",\n    \"keyup\",\n    \"mousedown\",\n    \"mouseenter\",\n    \"mouseleave\",\n    \"mousemove\",\n    \"mouseout\",\n    \"mouseover\",\n    \"mouseup\",\n    \"paste\",\n    \"pointercancel\",\n    \"pointerdown\",\n    \"pointerenter\",\n    \"pointerleave\",\n    \"pointermove\",\n    \"pointerout\",\n    \"pointerover\",\n    \"pointerup\",\n    \"scroll\",\n    \"select\",\n    \"selectionchange\",\n    \"selectstart\",\n    \"submit\",\n    \"toggle\",\n    \"touchcancel\",\n    \"touchend\",\n    \"touchmove\",\n    \"touchstart\",\n    \"wheel\",\n  ];\n  function warnOnDomInteraction() {\n    throw new Error(`\n    DOM interaction with a snapshot detected in test.\n    Please don't interact with the DOM you get from \\`withinDOM\\`,\n    but still use \\`screen\\' to get elements for simulating user interaction.\n    `);\n  }\n  events.forEach((event) => {\n    document.addEventListener(event, warnOnDomInteraction);\n  });\n}\n"]}

package/testing/internal/profile/context.d.ts

@@ -0,0 +1,10 @@
+import * as React from "react";
+export interface ProfilerContextValue {
+    renderedComponents: Array<React.ComponentType | string>;
+}
+export declare function ProfilerContextProvider({ children, value, }: {
+    children: React.ReactNode;
+    value: ProfilerContextValue;
+}): React.JSX.Element;
+export declare function useProfilerContext(): ProfilerContextValue | undefined;
+//# sourceMappingURL=context.d.ts.map

package/testing/internal/profile/context.js

@@ -0,0 +1,14 @@
+import * as React from "react";
+var ProfilerContext = React.createContext(undefined);
+export function ProfilerContextProvider(_a) {
+    var children = _a.children, value = _a.value;
+    var parentContext = useProfilerContext();
+    if (parentContext) {
+        throw new Error("Profilers should not be nested in the same tree");
+    }
+    return (React.createElement(ProfilerContext.Provider, { value: value }, children));
+}
+export function useProfilerContext() {
+    return React.useContext(ProfilerContext);
+}
+//# sourceMappingURL=context.js.map

package/testing/internal/profile/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../../../src/testing/internal/profile/context.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAM/B,IAAM,eAAe,GAAG,KAAK,CAAC,aAAa,CACzC,SAAS,CACV,CAAC;AAEF,MAAM,UAAU,uBAAuB,CAAC,EAMvC;QALC,QAAQ,cAAA,EACR,KAAK,WAAA;IAKL,IAAM,aAAa,GAAG,kBAAkB,EAAE,CAAC;IAE3C,IAAI,aAAa,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IAED,OAAO,CACL,oBAAC,eAAe,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,IACnC,QAAQ,CACgB,CAC5B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,kBAAkB;IAChC,OAAO,KAAK,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;AAC3C,CAAC","sourcesContent":["import * as React from \"react\";\n\nexport interface ProfilerContextValue {\n  renderedComponents: Array<React.ComponentType | string>;\n}\n\nconst ProfilerContext = React.createContext<ProfilerContextValue | undefined>(\n  undefined\n);\n\nexport function ProfilerContextProvider({\n  children,\n  value,\n}: {\n  children: React.ReactNode;\n  value: ProfilerContextValue;\n}) {\n  const parentContext = useProfilerContext();\n\n  if (parentContext) {\n    throw new Error(\"Profilers should not be nested in the same tree\");\n  }\n\n  return (\n    <ProfilerContext.Provider value={value}>\n      {children}\n    </ProfilerContext.Provider>\n  );\n}\n\nexport function useProfilerContext() {\n  return React.useContext(ProfilerContext);\n}\n"]}

package/testing/internal/profile/index.d.ts

@@ -1,4 +1,4 @@
-export type { NextRenderOptions, ProfiledComponent, ProfiledHook, } from "./profile.js";
-export { profile, profileHook, WaitForRenderTimeoutError } from "./profile.js";
+export type { NextRenderOptions, Profiler, ProfiledComponent, ProfiledHook, } from "./profile.js";
+export { createProfiler, profile, profileHook, useTrackRenders, WaitForRenderTimeoutError, } from "./profile.js";
 export type { SyncScreen } from "./Render.js";
 //# sourceMappingURL=index.d.ts.map

package/testing/internal/profile/index.js

@@ -1,2 +1,2 @@
-export { profile, profileHook, WaitForRenderTimeoutError } from "./profile.js";
+export { createProfiler, profile, profileHook, useTrackRenders, WaitForRenderTimeoutError, } from "./profile.js";
 //# sourceMappingURL=index.js.map

package/testing/internal/profile/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/testing/internal/profile/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC","sourcesContent":["export type {\n  NextRenderOptions,\n  ProfiledComponent,\n  ProfiledHook,\n} from \"./profile.js\";\nexport { profile, profileHook, WaitForRenderTimeoutError } from \"./profile.js\";\n\nexport type { SyncScreen } from \"./Render.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/testing/internal/profile/index.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,cAAc,EACd,OAAO,EACP,WAAW,EACX,eAAe,EACf,yBAAyB,GAC1B,MAAM,cAAc,CAAC","sourcesContent":["export type {\n  NextRenderOptions,\n  Profiler,\n  ProfiledComponent,\n  ProfiledHook,\n} from \"./profile.js\";\nexport {\n  createProfiler,\n  profile,\n  profileHook,\n  useTrackRenders,\n  WaitForRenderTimeoutError,\n} from \"./profile.js\";\n\nexport type { SyncScreen } from \"./Render.js\";\n"]}

package/testing/internal/profile/profile.d.ts

@@ -3,53 +3,107 @@ import type { Render, BaseRender } from "./Render.js";
 type ValidSnapshot = void | (object & {
     call?: never;
 });
+/** only used for passing around data internally */
 declare const _stackTrace: unique symbol;
+/** @internal */
 export interface NextRenderOptions {
     timeout?: number;
     [_stackTrace]?: string;
 }
-export interface ProfiledComponent<Props, Snapshot> extends React.FC<Props>, ProfiledComponentFields<Props, Snapshot>, ProfiledComponenOnlyFields<Props, Snapshot> {
+/** @internal */
+interface ProfilerProps {
+    children: React.ReactNode;
 }
-interface UpdateSnapshot<Snapshot> {
+/** @internal */
+export interface Profiler<Snapshot> extends React.FC<ProfilerProps>, ProfiledComponentFields<Snapshot>, ProfiledComponentOnlyFields<Snapshot> {
+}
+interface ReplaceSnapshot<Snapshot> {
     (newSnapshot: Snapshot): void;
     (updateSnapshot: (lastSnapshot: Readonly<Snapshot>) => Snapshot): void;
 }
-interface ProfiledComponenOnlyFields<Props, Snapshot> {
-    updateSnapshot: UpdateSnapshot<Snapshot>;
+interface MergeSnapshot<Snapshot> {
+    (partialSnapshot: Partial<Snapshot>): void;
+    (updatePartialSnapshot: (lastSnapshot: Readonly<Snapshot>) => Partial<Snapshot>): void;
+}
+interface ProfiledComponentOnlyFields<Snapshot> {
+    mergeSnapshot: MergeSnapshot<Snapshot>;
+    replaceSnapshot: ReplaceSnapshot<Snapshot>;
 }
-interface ProfiledComponentFields<Props, Snapshot> {
+interface ProfiledComponentFields<Snapshot> {
+    /**
+     * An array of all renders that have happened so far.
+     * Errors thrown during component render will be captured here, too.
+     */
     renders: Array<Render<Snapshot> | {
         phase: "snapshotError";
         count: number;
         error: unknown;
     }>;
+    /**
+     * Peeks the next render from the current iterator position, without advancing the iterator.
+     * If no render has happened yet, it will wait for the next render to happen.
+     * @throws {WaitForRenderTimeoutError} if no render happens within the timeout
+     */
     peekRender(options?: NextRenderOptions): Promise<Render<Snapshot>>;
+    /**
+     * Iterates to the next render and returns it.
+     * If no render has happened yet, it will wait for the next render to happen.
+     * @throws {WaitForRenderTimeoutError} if no render happens within the timeout
+     */
     takeRender(options?: NextRenderOptions): Promise<Render<Snapshot>>;
-    currentRenderCount(): number;
+    /**
+     * Returns the total number of renders.
+     */
+    totalRenderCount(): number;
+    /**
+     * Returns the current render.
+     * @throws {Error} if no render has happened yet
+     */
     getCurrentRender(): Render<Snapshot>;
-    takeUntilRenderCount(count: number, optionsPerRender?: NextRenderOptions): Promise<void>;
+    /**
+     * Waits for the next render to happen.
+     * Does not advance the render iterator.
+     */
     waitForNextRender(options?: NextRenderOptions): Promise<Render<Snapshot>>;
 }
-export declare function profile<Snapshot extends ValidSnapshot = void, Props = Record<string, never>>({ Component, onRender, snapshotDOM, initialSnapshot, }: {
+export interface ProfiledComponent<Snapshot extends ValidSnapshot, Props = {}> extends React.FC<Props>, ProfiledComponentFields<Snapshot>, ProfiledComponentOnlyFields<Snapshot> {
+}
+/** @internal */
+export declare function profile<Snapshot extends ValidSnapshot = void, Props = {}>({ Component, ...options }: Parameters<typeof createProfiler<Snapshot>>[0] & {
     Component: React.ComponentType<Props>;
+}): ProfiledComponent<Snapshot, Props>;
+/** @internal */
+export declare function createProfiler<Snapshot extends ValidSnapshot = void>({ onRender, snapshotDOM, initialSnapshot, skipNonTrackingRenders, }?: {
     onRender?: (info: BaseRender & {
         snapshot: Snapshot;
-        updateSnapshot: UpdateSnapshot<Snapshot>;
+        replaceSnapshot: ReplaceSnapshot<Snapshot>;
+        mergeSnapshot: MergeSnapshot<Snapshot>;
     }) => void;
     snapshotDOM?: boolean;
     initialSnapshot?: Snapshot;
-}): ProfiledComponent<Props, Snapshot>;
+    /**
+     * This will skip renders during which no renders tracked by
+     * `useTrackRenders` occured.
+     */
+    skipNonTrackingRenders?: boolean;
+}): Profiler<Snapshot>;
+/** @internal */
 export declare class WaitForRenderTimeoutError extends Error {
     constructor();
 }
 type StringReplaceRenderWithSnapshot<T extends string> = T extends `${infer Pre}Render${infer Post}` ? `${Pre}Snapshot${Post}` : T;
 type ResultReplaceRenderWithSnapshot<T> = T extends (...args: infer Args) => Render<infer Snapshot> ? (...args: Args) => Snapshot : T extends (...args: infer Args) => Promise<Render<infer Snapshot>> ? (...args: Args) => Promise<Snapshot> : T;
-type ProfiledHookFields<Props, ReturnValue> = ProfiledComponentFields<Props, ReturnValue> extends infer PC ? {
+type ProfiledHookFields<ReturnValue> = ProfiledComponentFields<ReturnValue> extends infer PC ? {
     [K in keyof PC as StringReplaceRenderWithSnapshot<K & string>]: ResultReplaceRenderWithSnapshot<PC[K]>;
 } : never;
-export interface ProfiledHook<Props, ReturnValue> extends React.FC<Props>, ProfiledHookFields<Props, ReturnValue> {
-    ProfiledComponent: ProfiledComponent<Props, ReturnValue>;
+/** @internal */
+export interface ProfiledHook<Props, ReturnValue> extends React.FC<Props>, ProfiledHookFields<ReturnValue> {
+    Profiler: Profiler<ReturnValue>;
 }
+/** @internal */
 export declare function profileHook<ReturnValue extends ValidSnapshot, Props>(renderCallback: (props: Props) => ReturnValue): ProfiledHook<Props, ReturnValue>;
+export declare function useTrackRenders({ name }?: {
+    name?: string;
+}): void;
 export {};
 //# sourceMappingURL=profile.d.ts.map