@thinkwise/testwise 0.2.103 → 0.2.111

package/interfaces/ITabTask.ts

@@ -0,0 +1,21 @@
+/**
+ * Represents a single subject+variant combination that has qualifying task
+ * buttons, as stored in `seed-data/tab-tasks.json` after the
+ * `TaskDataBuilder` pipeline step.
+ *
+ * Tasks with `custom_display_type === 4` are stripped at fetch time and never
+ * appear here. If all tasks for a subject+variant had that type, the entry is
+ * omitted entirely and that subject receives a plain `ActionBar`.
+ */
+export interface ITabTask {
+  /** Thinkwise subject identifier (matches `ISubject.subject`). */
+  subject: string;
+  /** Subject variant identifier (matches `ISubject.variant`). */
+  variant: string;
+  /**
+   * Ordered list of qualifying task IDs.
+   * Each entry becomes a named getter on the generated custom ActionBar class.
+   * e.g. `"supplier-item-add"` → `get supplierItemAddButton(): Locator`
+   */
+  tasks: string[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thinkwise/testwise",
-  "version": "0.2.103",
+  "version": "0.2.111",
   "main": "dist/index.js",
   "type": "module",
   "bin": {
@@ -11,6 +11,8 @@
     "lint": "eslint ./ --cache --ignore-pattern .gitignore",
     "format:fix": "run-s \"lint --fix\" && biome check --fix --unsafe",
     "format:check": "run-s \"lint \" && biome check",
+    "build": "tsc",
+    "prepack": "rimraf dist && tsc && node scripts/checkPackageContents.js",
     "postinstall": "node scripts/main.js postinstall",
     "test": "vitest run",
     "test:watch": "vitest",
@@ -22,7 +24,7 @@
   "license": "ISC",
   "description": "",
   "dependencies": {
-    "@thinkwise/backups": "^1.0.20",
+    "@thinkwise/backups": "^1.0.19",
     "axios": "^1.9.0",
     "chalk": "^5.4.1",
     "change-case": "^5.4.4",

package/page-overrides/FillOverride.ts

@@ -71,26 +71,8 @@ export class FillOverride {
           locator.fill = async (value, options) => {
             if (waitForRequestsToComplete) await this.flightTracker.waitToContinue();
 
-            const [valueIsDifferent, isQualifyingFormField] = await Promise.all([
-              locator.inputValue().then((v) => v !== value),
-              locator.evaluate((el) => {
-                const testId = el.getAttribute('data-testid');
-                return (
-                  !!testId && testId.includes('form-field__') && el.closest('[data-testid^="form-section__"]') !== null
-                );
-              })
-            ]);
-
             await page.waitEventHandler.waitForCanContinue();
-
             await originalFill(value, options);
-
-            if (isQualifyingFormField) {
-              if (valueIsDifferent) page.waitEventHandler.waitForResponse('/staged');
-              await locator.evaluate((el) => {
-                if (!el.getAttribute('aria-expanded')) el.blur();
-              });
-            }
           };
 
           for (const method of locatorMethods) {

package/promptCredentials.js

@@ -1,124 +1,124 @@
-#!/usr/bin/env node
-import { spawnSync } from 'node:child_process';
-import { readFileSync } from 'node:fs';
-import process from 'node:process';
-import chalk from 'chalk';
-import prompts from 'prompts';
-
-const packageScripts = JSON.parse(readFileSync('./package.json')).scripts;
-
-function exitWithError(error) {
-  console.log(chalk.red(error));
-  process.exit(1);
-}
-
-function startTestSolution() {
-  console.log('Now starting test solution...');
-  spawnSync(`yarn --cwd ../ ${args.join(' ')}`, {
-    shell: true,
-    stdio: 'inherit'
-  });
-  process.exit();
-}
-
-const args = process.argv.slice(2);
-
-if (!args.length) {
-  exitWithError('Error: Got too few parameters. Usage: yarn test:credentials test');
-}
-
-const yarnScriptToExec = args[0];
-
-if (!packageScripts[yarnScriptToExec]) {
-  exitWithError(`Error: Given script "${yarnScriptToExec}" doesn't exist in package.json.`);
-}
-
-// INCOMING HACK!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-// temp fix to be reworked when converting this file to TS
-import fs from 'node:fs';
-import path from 'node:path';
-
-const indiciumURL = (() => {
-  try {
-    const configPath = path.resolve(process.cwd(), './Testwise.json');
-    const config = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
-    return config.environmentSettings?.serviceUrl || '';
-  } catch (error) {
-    console.error('Error reading Testwise.json:', error);
-    return '';
-  }
-})();
-
-// END OF HACK!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
-if (process.env.SF_TEST_USERNAME && process.env.SF_TEST_PASSWORD) {
-  console.log('Using SF_TEST_USERNAME and SF_TEST_PASSWORD environment variables.');
-  startTestSolution();
-}
-
-const questions = [
-  {
-    type: 'text',
-    name: 'username',
-    message: 'Username:',
-    validate: (value) => {
-      if (!value?.length) {
-        return 'Username is required';
-      }
-
-      if (value.toLowerCase() === 'demo') {
-        return 'Running tests locally with demo is forbidden as it results in dataset concurrency problems';
-      }
-
-      return true;
-    }
-  },
-  {
-    type: 'invisible',
-    name: 'password',
-    message: 'Password:',
-    validate: (value) => (!value?.length ? 'Password is required' : true)
-  }
-];
-
-(async () => {
-  const credentialsResponse = await prompts(questions);
-
-  if (!credentialsResponse?.username || !credentialsResponse.password) {
-    exitWithError('Username or password was not given');
-  }
-
-  const { password, username } = credentialsResponse;
-  const params = new URLSearchParams();
-
-  params.append('UserName', username);
-  params.append('Password', password);
-
-  const fetch = (await import('node-fetch')).default;
-  const authResponse = await fetch(`${indiciumURL}/account/api/login`, {
-    method: 'POST',
-    body: params
-  });
-
-  if (authResponse.status === 204) {
-    console.log('Confirmed credentials work @', indiciumURL);
-  } else {
-    const confirmResponse = await prompts([
-      {
-        type: 'confirm',
-        name: 'value',
-        message: `Can't login to ${indiciumURL} with the given credentials. Continue anyways?`,
-        initial: true
-      }
-    ]);
-
-    if (!confirmResponse.value) {
-      return;
-    }
-  }
-
-  process.env.SF_TEST_USERNAME = username;
-  process.env.SF_TEST_PASSWORD = password;
-
-  startTestSolution();
-})();
+#!/usr/bin/env node
+import { spawnSync } from 'node:child_process';
+import { readFileSync } from 'node:fs';
+import process from 'node:process';
+import chalk from 'chalk';
+import prompts from 'prompts';
+
+const packageScripts = JSON.parse(readFileSync('./package.json')).scripts;
+
+function exitWithError(error) {
+  console.log(chalk.red(error));
+  process.exit(1);
+}
+
+function startTestSolution() {
+  console.log('Now starting test solution...');
+  spawnSync(`yarn --cwd ../ ${args.join(' ')}`, {
+    shell: true,
+    stdio: 'inherit'
+  });
+  process.exit();
+}
+
+const args = process.argv.slice(2);
+
+if (!args.length) {
+  exitWithError('Error: Got too few parameters. Usage: yarn test:credentials test');
+}
+
+const yarnScriptToExec = args[0];
+
+if (!packageScripts[yarnScriptToExec]) {
+  exitWithError(`Error: Given script "${yarnScriptToExec}" doesn't exist in package.json.`);
+}
+
+// INCOMING HACK!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+// temp fix to be reworked when converting this file to TS
+import fs from 'node:fs';
+import path from 'node:path';
+
+const indiciumURL = (() => {
+  try {
+    const configPath = path.resolve(process.cwd(), './Testwise.json');
+    const config = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
+    return config.environmentSettings?.serviceUrl || '';
+  } catch (error) {
+    console.error('Error reading Testwise.json:', error);
+    return '';
+  }
+})();
+
+// END OF HACK!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+if (process.env.SF_TEST_USERNAME && process.env.SF_TEST_PASSWORD) {
+  console.log('Using SF_TEST_USERNAME and SF_TEST_PASSWORD environment variables.');
+  startTestSolution();
+}
+
+const questions = [
+  {
+    type: 'text',
+    name: 'username',
+    message: 'Username:',
+    validate: (value) => {
+      if (!value?.length) {
+        return 'Username is required';
+      }
+
+      if (value.toLowerCase() === 'demo') {
+        return 'Running tests locally with demo is forbidden as it results in dataset concurrency problems';
+      }
+
+      return true;
+    }
+  },
+  {
+    type: 'invisible',
+    name: 'password',
+    message: 'Password:',
+    validate: (value) => (!value?.length ? 'Password is required' : true)
+  }
+];
+
+(async () => {
+  const credentialsResponse = await prompts(questions);
+
+  if (!credentialsResponse?.username || !credentialsResponse.password) {
+    exitWithError('Username or password was not given');
+  }
+
+  const { password, username } = credentialsResponse;
+  const params = new URLSearchParams();
+
+  params.append('UserName', username);
+  params.append('Password', password);
+
+  const fetch = (await import('node-fetch')).default;
+  const authResponse = await fetch(`${indiciumURL}/account/api/login`, {
+    method: 'POST',
+    body: params
+  });
+
+  if (authResponse.status === 204) {
+    console.log('Confirmed credentials work @', indiciumURL);
+  } else {
+    const confirmResponse = await prompts([
+      {
+        type: 'confirm',
+        name: 'value',
+        message: `Can't login to ${indiciumURL} with the given credentials. Continue anyways?`,
+        initial: true
+      }
+    ]);
+
+    if (!confirmResponse.value) {
+      return;
+    }
+  }
+
+  process.env.SF_TEST_USERNAME = username;
+  process.env.SF_TEST_PASSWORD = password;
+
+  startTestSolution();
+})();

package/scripts/checkPackageContents.js

@@ -0,0 +1,39 @@
+import { execSync } from 'node:child_process';
+import process from 'node:process';
+
+/**
+ * Refuses to pack when generated model files would be published.
+ *
+ * `testwise sync` writes subject classes, screen interfaces, schemas and seed data
+ * for whichever application it last ran against, and `package.json` `files`
+ * publishes all of `dist/`. This runs at the end of `prepack`, after `dist/` was
+ * emptied and rebuilt, and fails the pack when anything under `seed-data/` or
+ * `test-artifacts/` does not come from a file tracked in git.
+ */
+
+const packedFiles = JSON.parse(
+  execSync('npm pack --dry-run --json --ignore-scripts', { encoding: 'utf8' })
+)[0].files.map((file) => file.path);
+
+const trackedSources = new Set(
+  execSync('git ls-files test-artifacts', { encoding: 'utf8' })
+    .split(/\r?\n/)
+    .filter(Boolean)
+    .map((file) => file.replace(/\.ts$/, ''))
+);
+
+const toSource = (file) => file.replace(/^dist\//, '').replace(/\.(d\.ts\.map|d\.ts|js\.map|js|ts)$/, '');
+
+const generatedFiles = packedFiles.filter(
+  (file) =>
+    file.includes('seed-data/') || (/^(dist\/)?test-artifacts\//.test(file) && !trackedSources.has(toSource(file)))
+);
+
+if (generatedFiles.length > 0) {
+  console.error(
+    `Refusing to pack: ${generatedFiles.length} generated model file(s) would be published, for example ${generatedFiles.slice(0, 5).join(', ')}. Delete dist/ and build again.`
+  );
+  process.exit(1);
+}
+
+console.log(`Package contents checked: ${packedFiles.length} files, no generated model files.`);

package/scripts/sync.js

@@ -391,6 +391,7 @@ async function phaseBuildModelData(ctx) {
   Logger.phase(2, PHASE_NAMES.BUILD);
 
   const { buildSubjects, buildScreens } = await import('../dist/artifact-builder/ModelDataBuilder.js');
+  const { buildTaskData } = await import('../dist/artifact-builder/TaskDataBuilder.js');
 
   const subjectsResult = await runStep(ctx, 'Build subjects from model data', async () => {
     await buildSubjects();
@@ -407,6 +408,14 @@ async function phaseBuildModelData(ctx) {
   if (!screensResult.success) {
     throw screensResult.error;
   }
+
+  const taskDataResult = await runStep(ctx, 'Build task data for custom ActionBar generation', async () => {
+    await buildTaskData();
+  });
+
+  if (!taskDataResult.success) {
+    throw taskDataResult.error;
+  }
 }
 
 /**
@@ -447,6 +456,7 @@ async function phaseGenerateArtifacts(ctx) {
     SchemaGenerator,
     SubjectComponentGenerator,
     SubjectGenerator,
+    CustomActionBarGenerator,
     SubjectRegistration
   } = await import('../dist/artifact-builder/index.js');
 
@@ -478,6 +488,10 @@ async function phaseGenerateArtifacts(ctx) {
       name: 'Generate subject classes',
       fn: () => new SubjectGenerator().run()
     },
+    {
+      name: 'Generate custom ActionBar subclasses for subjects with tasks',
+      fn: () => new CustomActionBarGenerator().run()
+    },
     {
       name: 'Add subjects to registry',
       fn: async () => await new SubjectRegistration().run()

package/services/IndiciumApi.service.ts

@@ -178,6 +178,27 @@ export class IndiciumApiService {
     }
   }
 
+  /**
+   * Fetches all task button records (`i_ui_tab_task`) for the verified GUI application.
+   * Results include all tasks regardless of `custom_display_type`; callers are
+   * responsible for filtering out `custom_display_type === 4` entries.
+   * @returns An array of tab task objects, or an empty array if not verified or on error.
+   */
+  public async getTabTasks(): Promise<any[]> {
+    await this.ensureReady();
+    if (!this.isVerified || !this.guiApplId) return [];
+
+    try {
+      const response = await this.axiosInstance!.get(
+        `/iam/${this.metaEndpoint}/i_ui_tab_task?$filter=gui_appl_id%20eq%20${this.guiApplId}`
+      );
+      return response.data?.value || [];
+    } catch (error) {
+      console.error(`IndiciumApiService: Failed to fetch tab tasks: ${IndiciumApiService.extractMessage(error)}`);
+      return [];
+    }
+  }
+
   /**
    * Returns the verified GUI Application ID.
    * Throws an error if verification failed or the alias was not found.

package/types/PollTypes.ts

@@ -11,4 +11,9 @@ export type PollOptions<T = unknown> = {
   interval?: number; // ms (default 200)
   predicate?: (v: T) => boolean; // default truthy
   onTick?: (v: T, elapsedMs: number) => void;
+  /**
+   * What is being waited for, phrased to follow "waiting for ...". Included in the
+   * timeout message, so a failure reads as a sentence rather than a bare timeout.
+   */
+  description?: string;
 };