@testchimp/playwright 0.1.6 → 0.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/runtime.d.ts CHANGED
@@ -12,4 +12,12 @@
12
12
  * (including `mergeTests(...)` output). Returns the same instance for chaining.
13
13
  */
14
14
  export declare function installTrueCoverage(test: any): any;
15
+ /**
16
+ * Marks the current logical screen/state so it appears as a Playwright **step** in traces and reporters.
17
+ * Call from inside a test (or hook) after the UI has reached a stable state.
18
+ *
19
+ * @param screenName logical screen (e.g. "Login", "Dashboard")
20
+ * @param stateName optional state within the screen; defaults to `"default"`
21
+ */
22
+ export declare function markScreenState(screenName: string, stateName?: string): Promise<void>;
15
23
  //# sourceMappingURL=runtime.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAqBH;;;GAGG;AAEH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,CAyDlD"}
1
+ {"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAwBH;;;GAGG;AAEH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,CAyDlD;AAID;;;;;;GAMG;AACH,wBAAsB,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAgB3F"}
package/dist/runtime.js CHANGED
@@ -43,10 +43,13 @@ var __importStar = (this && this.__importStar) || (function () {
43
43
  })();
44
44
  Object.defineProperty(exports, "__esModule", { value: true });
45
45
  exports.installTrueCoverage = installTrueCoverage;
46
+ exports.markScreenState = markScreenState;
46
47
  const fs = __importStar(require("fs"));
47
48
  const path = __importStar(require("path"));
48
49
  const module_1 = require("module");
49
50
  const utils_1 = require("./utils");
51
+ /** Resolve `@playwright/test` from the consumer project (same as `installTrueCoverage` side-effect path). */
52
+ const pwRequire = (0, module_1.createRequire)(path.join(process.cwd(), 'package.json'));
50
53
  const BATCH_ID_FILENAME = '.testchimp-batch-invocation-id';
51
54
  function readBatchInvocationId(projectRootDir) {
52
55
  const fromEnv = process.env.TESTCHIMP_BATCH_INVOCATION_ID;
@@ -116,8 +119,30 @@ function installTrueCoverage(test) {
116
119
  },
117
120
  });
118
121
  }
119
- // IMPORTANT: resolve @playwright/test from the *consumer* project, not from this package.
120
- const pwRequire = (0, module_1.createRequire)(path.join(process.cwd(), 'package.json'));
122
+ const DEFAULT_SCREEN_STATE = 'default';
123
+ /**
124
+ * Marks the current logical screen/state so it appears as a Playwright **step** in traces and reporters.
125
+ * Call from inside a test (or hook) after the UI has reached a stable state.
126
+ *
127
+ * @param screenName logical screen (e.g. "Login", "Dashboard")
128
+ * @param stateName optional state within the screen; defaults to `"default"`
129
+ */
130
+ async function markScreenState(screenName, stateName) {
131
+ const screen = String(screenName ?? '').trim();
132
+ if (!screen) {
133
+ return;
134
+ }
135
+ const state = stateName != null && String(stateName).trim() !== ''
136
+ ? String(stateName).trim()
137
+ : DEFAULT_SCREEN_STATE;
138
+ const title = `ScreenState: ${screen} | ${state}`;
139
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
140
+ const { test } = pwRequire('@playwright/test');
141
+ await test.step(title, async () => {
142
+ // eslint-disable-next-line no-console
143
+ console.log(`reached ${screen} | ${state}`);
144
+ });
145
+ }
121
146
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
122
147
  const { test: rootTest } = pwRequire('@playwright/test');
123
148
  installTrueCoverage(rootTest);
@@ -1 +1 @@
1
- {"version":3,"file":"runtime.js","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BH,kDAyDC;AAjFD,uCAAyB;AACzB,2CAA6B;AAC7B,mCAAuC;AACvC,mCAAoF;AAEpF,MAAM,iBAAiB,GAAG,gCAAgC,CAAC;AAE3D,SAAS,qBAAqB,CAAC,cAAsB;IACnD,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC;IAC1D,IAAI,OAAO;QAAE,OAAO,OAAO,CAAC;IAC5B,MAAM,QAAQ,GACZ,OAAO,CAAC,GAAG,CAAC,uBAAuB,IAAI,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;IACtF,IAAI,CAAC;QACH,OAAO,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,SAAS,CAAC;IAC/D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,8DAA8D;AAC9D,SAAgB,mBAAmB,CAAC,IAAS;IAC3C,2DAA2D;IAC3D,EAAE;IACF,qGAAqG;IACrG,iGAAiG;IACjG,oFAAoF;IACpF,OAAO,IAAI,CAAC,MAAM,CAAC;QACjB,8DAA8D;QAC9D,IAAI,EAAE,KAAK,EAAE,EAAE,IAAI,EAAiB,EAAE,GAAQ,EAAE,QAAa,EAAE,EAAE;YACjE,MAAM,OAAO,GAAG,QAAQ,CAAC,OAA+B,CAAC;YACzD,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;YACxD,MAAM,WAAW,GAAG,IAAA,yBAAiB,EAAC,cAAc,CAAC,CAAC;YACtD,MAAM,KAAK,GAAG,IAAA,+BAAuB,EACnC,QAAoE,EACpE,WAAW,EACX,cAAc,EACd,KAAK,CACN,CAAC;YAEF,MAAM,UAAU,GAA4B;gBAC1C,UAAU,EAAE,KAAK,CAAC,UAAU;gBAC5B,QAAQ,EAAE,KAAK,CAAC,QAAQ;gBACxB,SAAS,EAAE,KAAK,CAAC,SAAS;gBAC1B,QAAQ,EAAE,KAAK,CAAC,QAAQ;aACzB,CAAC;YACF,MAAM,UAAU,GAAG,IAAA,qBAAa,GAAE,CAAC;YACnC,IAAI,UAAU;gBAAE,UAAU,CAAC,UAAU,GAAG,UAAU,CAAC;YACnD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC;YAC3E,IAAI,GAAG;gBAAE,UAAU,CAAC,WAAW,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;YACrD,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC;YACpF,IAAI,OAAO;gBAAE,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC;YAC1C,MAAM,iBAAiB,GAAG,qBAAqB,CAAC,cAAc,CAAC,CAAC;YAChE,IAAI,iBAAiB;gBAAE,UAAU,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;YAExE,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;YAC9C,MAAM,IAAI,CAAC,aAAa,CACtB,CAAC,IAAY,EAAE,EAAE;gBACf,6CAA6C;gBAC5C,UAAwD,CAAC,iBAAiB,GAAG,IAAI,CAAC;YACrF,CAAC,EACD,UAAU,CACX,CAAC;YAEF,iGAAiG;YACjG,gGAAgG;YAChG,6BAA6B;YAC7B,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAY,EAAE,EAAE;oBAClC,UAAwD,CAAC,iBAAiB,GAAG,IAAI,CAAC;gBACrF,CAAC,EAAE,UAAU,CAAC,CAAC;YACjB,CAAC;YAAC,MAAM,CAAC;gBACP,+CAA+C;YACjD,CAAC;YAEC,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC;QAClB,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED,0FAA0F;AAC1F,MAAM,SAAS,GAAG,IAAA,sBAAa,EAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC;AAC1E,8DAA8D;AAC9D,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC,kBAAkB,CAAQ,CAAC;AAEhE,mBAAmB,CAAC,QAAQ,CAAC,CAAC"}
1
+ {"version":3,"file":"runtime.js","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BH,kDAyDC;AAWD,0CAgBC;AA/GD,uCAAyB;AACzB,2CAA6B;AAC7B,mCAAuC;AACvC,mCAAoF;AAEpF,6GAA6G;AAC7G,MAAM,SAAS,GAAG,IAAA,sBAAa,EAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC;AAE1E,MAAM,iBAAiB,GAAG,gCAAgC,CAAC;AAE3D,SAAS,qBAAqB,CAAC,cAAsB;IACnD,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC;IAC1D,IAAI,OAAO;QAAE,OAAO,OAAO,CAAC;IAC5B,MAAM,QAAQ,GACZ,OAAO,CAAC,GAAG,CAAC,uBAAuB,IAAI,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;IACtF,IAAI,CAAC;QACH,OAAO,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,SAAS,CAAC;IAC/D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,8DAA8D;AAC9D,SAAgB,mBAAmB,CAAC,IAAS;IAC3C,2DAA2D;IAC3D,EAAE;IACF,qGAAqG;IACrG,iGAAiG;IACjG,oFAAoF;IACpF,OAAO,IAAI,CAAC,MAAM,CAAC;QACjB,8DAA8D;QAC9D,IAAI,EAAE,KAAK,EAAE,EAAE,IAAI,EAAiB,EAAE,GAAQ,EAAE,QAAa,EAAE,EAAE;YACjE,MAAM,OAAO,GAAG,QAAQ,CAAC,OAA+B,CAAC;YACzD,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;YACxD,MAAM,WAAW,GAAG,IAAA,yBAAiB,EAAC,cAAc,CAAC,CAAC;YACtD,MAAM,KAAK,GAAG,IAAA,+BAAuB,EACnC,QAAoE,EACpE,WAAW,EACX,cAAc,EACd,KAAK,CACN,CAAC;YAEF,MAAM,UAAU,GAA4B;gBAC1C,UAAU,EAAE,KAAK,CAAC,UAAU;gBAC5B,QAAQ,EAAE,KAAK,CAAC,QAAQ;gBACxB,SAAS,EAAE,KAAK,CAAC,SAAS;gBAC1B,QAAQ,EAAE,KAAK,CAAC,QAAQ;aACzB,CAAC;YACF,MAAM,UAAU,GAAG,IAAA,qBAAa,GAAE,CAAC;YACnC,IAAI,UAAU;gBAAE,UAAU,CAAC,UAAU,GAAG,UAAU,CAAC;YACnD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC;YAC3E,IAAI,GAAG;gBAAE,UAAU,CAAC,WAAW,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;YACrD,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC;YACpF,IAAI,OAAO;gBAAE,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC;YAC1C,MAAM,iBAAiB,GAAG,qBAAqB,CAAC,cAAc,CAAC,CAAC;YAChE,IAAI,iBAAiB;gBAAE,UAAU,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;YAExE,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;YAC9C,MAAM,IAAI,CAAC,aAAa,CACtB,CAAC,IAAY,EAAE,EAAE;gBACf,6CAA6C;gBAC5C,UAAwD,CAAC,iBAAiB,GAAG,IAAI,CAAC;YACrF,CAAC,EACD,UAAU,CACX,CAAC;YAEF,iGAAiG;YACjG,gGAAgG;YAChG,6BAA6B;YAC7B,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAY,EAAE,EAAE;oBAClC,UAAwD,CAAC,iBAAiB,GAAG,IAAI,CAAC;gBACrF,CAAC,EAAE,UAAU,CAAC,CAAC;YACjB,CAAC;YAAC,MAAM,CAAC;gBACP,+CAA+C;YACjD,CAAC;YAEC,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC;QAClB,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED,MAAM,oBAAoB,GAAG,SAAS,CAAC;AAEvC;;;;;;GAMG;AACI,KAAK,UAAU,eAAe,CAAC,UAAkB,EAAE,SAAkB;IAC1E,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAC/C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO;IACT,CAAC;IACD,MAAM,KAAK,GACT,SAAS,IAAI,IAAI,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE;QAClD,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE;QAC1B,CAAC,CAAC,oBAAoB,CAAC;IAC3B,MAAM,KAAK,GAAG,gBAAgB,MAAM,MAAM,KAAK,EAAE,CAAC;IAClD,8DAA8D;IAC9D,MAAM,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC,kBAAkB,CAAQ,CAAC;IACtD,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,IAAI,EAAE;QAChC,sCAAsC;QACtC,OAAO,CAAC,GAAG,CAAC,WAAW,MAAM,MAAM,KAAK,EAAE,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;AACL,CAAC;AAED,8DAA8D;AAC9D,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC,kBAAkB,CAAQ,CAAC;AAEhE,mBAAmB,CAAC,QAAQ,CAAC,CAAC"}
package/dist/runtime.mjs CHANGED
@@ -5,6 +5,7 @@ const require = createRequire(import.meta.url);
5
5
  const cjs = require('./runtime.js');
6
6
 
7
7
  export const installTrueCoverage = cjs.installTrueCoverage;
8
+ export const markScreenState = cjs.markScreenState;
8
9
 
9
10
  export * from './worldstate.mjs';
10
11
  export default cjs;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@testchimp/playwright",
3
- "version": "0.1.6",
3
+ "version": "0.1.7",
4
4
  "description": "Playwright reporter for TestChimp test execution tracking and coverage reporting",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",