@immense/vue-pom-generator 1.0.31 → 1.0.33

package/dist/index.mjs

@@ -1818,6 +1818,12 @@ function applyResolvedDataTestId(args) {
   const existingIdBehavior = args.existingIdBehavior ?? "preserve";
   const nameCollisionBehavior = args.nameCollisionBehavior ?? "suffix";
   const warn = args.warn;
+  const getBestKeyAccessCandidates = (expr) => {
+    if (!expr) {
+      return [];
+    }
+    return expr.split("??").map((part) => part.trim()).filter(Boolean);
+  };
   let dataTestId = args.preferredGeneratedValue;
   let fromExisting = false;
   const existing = tryGetExistingElementDataTestId(args.element, testIdAttribute);
@@ -1840,6 +1846,7 @@ Bulk cleanup: run ESLint with the @immense/vue-pom-generator/remove-existing-tes
     if (existingIdBehavior === "preserve") {
       if (existing.isDynamic) {
         if (existing.template) {
+          const existingTemplate = existing.template;
           if ((existing.templateExpressionCount ?? 0) !== 1) {
             throw new Error(
               `[vue-pom-generator] Existing ${attrLabel} is a template literal with multiple interpolations and cannot be preserved safely.
@@ -1850,8 +1857,8 @@ Existing ${attrLabel}: ${JSON.stringify(existing.value)}
 Fix: reduce the template to a single key-based interpolation, or remove the explicit ${attrLabel} so it can be auto-generated.`
             );
           }
-          const hasExact = args.bestKeyPlaceholder && existing.template.includes(args.bestKeyPlaceholder);
-          const hasVarAccess = args.bestKeyVariable && existing.template.includes(args.bestKeyVariable);
+          const hasExact = args.bestKeyPlaceholder && existingTemplate.includes(args.bestKeyPlaceholder);
+          const hasVarAccess = getBestKeyAccessCandidates(args.bestKeyVariable).some((candidate) => existingTemplate.includes(candidate));
           if (!hasExact && !hasVarAccess && args.bestKeyPlaceholder) {
             throw new Error(
               `[vue-pom-generator] Existing ${attrLabel} appears to be missing the key placeholder needed to keep it unique.
@@ -3842,14 +3849,18 @@ function generateViewObjectModelContent(componentName, dependencies, componentHi
     }
     return false;
   };
+  const customPomClassIdentifierMap = options.customPomClassIdentifierMap ?? {};
+  const customPomAvailableClassIdentifiers = options.customPomAvailableClassIdentifiers ?? /* @__PURE__ */ new Set();
   const attachmentsForThisClass = customPomAttachments.filter((a) => {
+    if (!Object.prototype.hasOwnProperty.call(customPomClassIdentifierMap, a.className))
+      return false;
     const scope = a.attachTo ?? "views";
     const scopeOk = isView ? scope === "views" || scope === "both" : scope === "components" || scope === "both";
     if (!scopeOk)
       return false;
     return a.attachWhenUsesComponents.some((c) => hasChildComponent(c));
   }).map((a) => ({
-    className: options.customPomClassIdentifierMap?.[a.className] ?? a.className,
+    className: customPomClassIdentifierMap[a.className],
     propertyName: a.propertyName
   }));
   let content = "";
@@ -3889,7 +3900,7 @@ function generateViewObjectModelContent(componentName, dependencies, componentHi
   content += `
 export class ${className} extends BasePage {
 `;
-  const widgetInstances = isView ? getWidgetInstancesForView(componentName, dependencies.dataTestIdSet) : [];
+  const widgetInstances = isView ? getWidgetInstancesForView(componentName, dependencies.dataTestIdSet, customPomAvailableClassIdentifiers) : [];
   const componentRefsForInstances = isView ? usedComponentSet?.size ? usedComponentSet : childrenComponentSet : childrenComponentSet;
   if (isView && (componentRefsForInstances.size > 0 || attachmentsForThisClass.length > 0 || widgetInstances.length > 0)) {
     content += getComponentInstances(componentRefsForInstances, componentHierarchyMap, attachmentsForThisClass, widgetInstances);
@@ -4047,6 +4058,7 @@ Fix by setting generation.playwright.customPoms.importAliases["${exportName}"] t
       return customPomClassIdentifierMap2;
     };
     const customPomClassIdentifierMap = addCustomPomImports();
+    const customPomAvailableClassIdentifiers = new Set(Object.values(customPomClassIdentifierMap ?? {}));
     const referencedTargets = /* @__PURE__ */ new Set();
     for (const [, deps] of items) {
       for (const dt of deps.dataTestIdSet) {
@@ -4199,6 +4211,7 @@ Fix by setting generation.playwright.customPoms.importAliases["${exportName}"] t
         aggregated: true,
         customPomAttachments: options.customPomAttachments ?? [],
         customPomClassIdentifierMap,
+        customPomAvailableClassIdentifiers,
         testIdAttribute: options.testIdAttribute,
         vueRouterFluentChaining: options.vueRouterFluentChaining,
         routeMetaByComponent: options.routeMetaByComponent
@@ -4293,7 +4306,7 @@ function toPascalCaseLocal(str) {
     return preserveInternalCaps ? upperFirst(word) : upperFirst(word.toLowerCase());
   }).join("");
 }
-function getWidgetInstancesForView(componentName, dataTestIdSet) {
+function getWidgetInstancesForView(componentName, dataTestIdSet, availableClassIdentifiers) {
   const out = [];
   const usedPropNames = /* @__PURE__ */ new Set();
   const ensureUnique = (base) => {
@@ -4324,6 +4337,8 @@ function getWidgetInstancesForView(componentName, dataTestIdSet) {
     } else {
       continue;
     }
+    if (!availableClassIdentifiers.has(className))
+      continue;
     const viewPrefix = `${componentName}-`;
     const descriptorRaw = stem.startsWith(viewPrefix) ? stem.slice(viewPrefix.length) : stem;
     const descriptorPascal = toPascalCaseLocal(descriptorRaw);
@@ -4392,6 +4407,32 @@ function getConstructor(childrenComponent, componentHierarchyMap, attachmentsFor
   return `${content}
 `;
 }
+function getGenerationMetrics(componentHierarchyMap) {
+  let selectorCount = 0;
+  let generatedMethodCount = 0;
+  for (const deps of componentHierarchyMap.values()) {
+    selectorCount += deps.dataTestIdSet?.size ?? 0;
+    generatedMethodCount += deps.generatedMethods?.size ?? 0;
+  }
+  return {
+    entryCount: componentHierarchyMap.size,
+    selectorCount,
+    generatedMethodCount
+  };
+}
+function isLessRich(current, previous) {
+  if (current.entryCount !== previous.entryCount) {
+    return current.entryCount < previous.entryCount;
+  }
+  if (current.selectorCount !== previous.selectorCount) {
+    return current.selectorCount < previous.selectorCount;
+  }
+  return current.generatedMethodCount < previous.generatedMethodCount;
+}
+function getGenerationMetricsKey(projectRoot, outDir) {
+  return path.resolve(projectRoot, outDir ?? "./pom");
+}
+const buildGenerationMetricsByOutputKey = /* @__PURE__ */ new Map();
 function createBuildProcessorPlugin(options) {
   const {
     componentHierarchyMap,
@@ -4414,7 +4455,6 @@ function createBuildProcessorPlugin(options) {
     routerModuleShims,
     loggerRef
   } = options;
-  let lastGeneratedEntryCount = 0;
   return {
     name: "vue-pom-generator-build",
     // This plugin exists to generate code on build output; it is not needed during dev-server HMR.
@@ -4461,11 +4501,13 @@ function createBuildProcessorPlugin(options) {
       this.addWatchFile(pointerPath);
     },
     buildEnd() {
-      const entryCount = componentHierarchyMap.size;
-      if (entryCount <= 0) {
+      const metrics = getGenerationMetrics(componentHierarchyMap);
+      if (metrics.entryCount <= 0 || metrics.selectorCount <= 0) {
         return;
       }
-      if (entryCount < lastGeneratedEntryCount) {
+      const generationMetricsKey = getGenerationMetricsKey(projectRootRef.current, outDir);
+      const previousMetrics = buildGenerationMetricsByOutputKey.get(generationMetricsKey);
+      if (previousMetrics && isLessRich(metrics, previousMetrics)) {
         return;
       }
       generateFiles(componentHierarchyMap, vueFilesPathMap, normalizedBasePagePath, {
@@ -4483,8 +4525,8 @@ function createBuildProcessorPlugin(options) {
         routerEntry: resolvedRouterEntry,
         routerType
       });
-      lastGeneratedEntryCount = entryCount;
-      loggerRef.current.info(`generated POMs (${entryCount} entries)`);
+      buildGenerationMetricsByOutputKey.set(generationMetricsKey, metrics);
+      loggerRef.current.info(`generated POMs (${metrics.entryCount} entries, ${metrics.selectorCount} selectors)`);
     },
     closeBundle() {
       loggerRef.current.info("build complete");
@@ -4522,6 +4564,89 @@ function toKebabCaseTag(tag) {
   }
   return result;
 }
+function getStaticAttributeContent(element, name) {
+  const attr = element.props.find((prop) => {
+    return prop.type === NodeTypes.ATTRIBUTE && prop.name === name;
+  });
+  return attr?.value?.content?.trim() || null;
+}
+function getNativeHtmlControlRole(element) {
+  const tag = (element.tag || "").toLowerCase();
+  const type = (getStaticAttributeContent(element, "type") || "").toLowerCase();
+  if (tag === "textarea") {
+    return "input";
+  }
+  if (tag === "select") {
+    return "select";
+  }
+  if (tag !== "input") {
+    return null;
+  }
+  if (type === "radio") {
+    return "radio";
+  }
+  if (type === "checkbox") {
+    return "checkbox";
+  }
+  return "input";
+}
+function normalizeControlLabelText(value) {
+  const normalized = (value ?? "").replace(/\*/g, " ").replace(/\s+/g, " ").trim();
+  return normalized || null;
+}
+function getLabelNodeText(labelNode) {
+  for (const child of labelNode.children || []) {
+    if (child.type === NodeTypes.TEXT) {
+      const normalized2 = normalizeControlLabelText(child.content);
+      if (normalized2) {
+        return normalized2;
+      }
+      continue;
+    }
+    if (child.type !== NodeTypes.ELEMENT) {
+      continue;
+    }
+    if (getNativeHtmlControlRole(child)) {
+      continue;
+    }
+    const normalized = normalizeControlLabelText(getInnerText(child));
+    if (normalized) {
+      return normalized;
+    }
+  }
+  return normalizeControlLabelText(getInnerText(labelNode));
+}
+function getAssociatedLabelText(element, hierarchyMap2) {
+  let parent = hierarchyMap2.get(element) || null;
+  while (parent) {
+    if (parent.tag === "label") {
+      return getLabelNodeText(parent);
+    }
+    parent = hierarchyMap2.get(parent) || null;
+  }
+  const id = getStaticAttributeContent(element, "id");
+  if (!id) {
+    return null;
+  }
+  const candidates = /* @__PURE__ */ new Set();
+  for (const child of hierarchyMap2.keys()) {
+    candidates.add(child);
+  }
+  for (const maybeParent of hierarchyMap2.values()) {
+    if (maybeParent) {
+      candidates.add(maybeParent);
+    }
+  }
+  for (const candidate of candidates) {
+    if (candidate.tag !== "label") {
+      continue;
+    }
+    if (getStaticAttributeContent(candidate, "for") === id) {
+      return getLabelNodeText(candidate);
+    }
+  }
+  return null;
+}
 function normalizeSearchRoots(wrapperSearchRoots) {
   const normalized = /* @__PURE__ */ new Set();
   for (const root of wrapperSearchRoots) {
@@ -5189,7 +5314,9 @@ function createTestIdTransform(componentName, componentHierarchyMap, nativeWrapp
       }
     }
     const getBestAvailableKeyValue = () => {
-      const vForKey = getKeyDirectiveValue(element, context) || getSelfClosingForDirectiveKeyAttrValue(element) || getContainedInVForDirectiveKeyValue(context, element, hierarchyMap);
+      const parentNode = context.parent && typeof context.parent === "object" ? context.parent : null;
+      const isDirectVForChild = parentNode?.type === NodeTypes.FOR;
+      const vForKey = (isDirectVForChild ? getKeyDirectiveValue(element, context) : null) || getContainedInVForDirectiveKeyValue(context, element, hierarchyMap);
       if (vForKey) return vForKey;
       return getContainedInSlotDataKeyValue(element, hierarchyMap);
     };
@@ -5346,6 +5473,50 @@ Fix: remove the explicit ${attrLabel}, or change existingIdBehavior to "overwrit
       });
       return;
     }
+    const nativeHtmlRole = getNativeHtmlControlRole(element);
+    if (nativeHtmlRole) {
+      const rawIdentifier = getStaticAttributeContent(element, "id") || getStaticAttributeContent(element, "name");
+      const labelText = getAssociatedLabelText(element, hierarchyMap);
+      const { vModel, modelValue } = getModelBindingValues(element);
+      const bindingHint = modelValue || vModel || null;
+      const labelToken = labelText ? toPascalCase(labelText) : "";
+      const bindingToken = bindingHint ? toPascalCase(bindingHint) : "";
+      let identifierToken = null;
+      let semanticNameHint2;
+      if (nativeHtmlRole === "radio" || nativeHtmlRole === "checkbox") {
+        if (rawIdentifier) {
+          identifierToken = rawIdentifier;
+          semanticNameHint2 = rawIdentifier;
+        } else if (bindingToken && labelToken) {
+          identifierToken = `${bindingToken}${labelToken}`;
+          semanticNameHint2 = `${bindingHint || bindingToken} ${labelText || labelToken}`;
+        } else if (labelToken) {
+          identifierToken = labelToken;
+          semanticNameHint2 = labelText || labelToken;
+        } else if (bindingToken) {
+          identifierToken = bindingToken;
+          semanticNameHint2 = bindingHint || bindingToken;
+        }
+      } else if (rawIdentifier) {
+        identifierToken = rawIdentifier;
+        semanticNameHint2 = rawIdentifier;
+      } else if (labelToken) {
+        identifierToken = labelToken;
+        semanticNameHint2 = labelText || labelToken;
+      } else if (bindingToken) {
+        identifierToken = bindingToken;
+        semanticNameHint2 = bindingHint || bindingToken;
+      }
+      if (identifierToken) {
+        const preferredGeneratedValue = bestKeyPlaceholder ? templateAttributeValue(`${componentName}-${bestKeyPlaceholder}-${identifierToken}-${nativeHtmlRole}`) : staticAttributeValue(`${componentName}-${identifierToken}-${nativeHtmlRole}`);
+        applyResolvedDataTestIdForElement({
+          preferredGeneratedValue,
+          nativeRoleOverride: nativeHtmlRole,
+          semanticNameHint: semanticNameHint2 || conditionalHint || void 0
+        });
+        return;
+      }
+    }
     const innerText = getInnerText(element) || null;
     const toDirective = nodeHasToDirective(element);
     if (toDirective) {
@@ -5464,6 +5635,7 @@ function resolveComponentNameFromPath(options) {
   }
   return toPascalCase(path.parse(absFilename).name);
 }
+const devStartupMetricsByOutputKey = /* @__PURE__ */ new Map();
 function createDevProcessorPlugin(options) {
   const {
     nativeWrappers,
@@ -5657,6 +5829,21 @@ function createDevProcessorPlugin(options) {
         logInfo(`initial compile: ${compiledCount}/${totalVueFiles} files in ${formatMs(t1 - t0)} (components=${snapshotHierarchy.size})`);
       };
       const generateAggregatedFromSnapshot = (reason) => {
+        const metrics = getGenerationMetrics(snapshotHierarchy);
+        if (metrics.entryCount <= 0 || metrics.selectorCount <= 0) {
+          logInfo(`generate(${reason}): skipped empty snapshot (components=${metrics.entryCount}, selectors=${metrics.selectorCount})`);
+          return;
+        }
+        const generationMetricsKey = getGenerationMetricsKey(projectRootRef.current, outDir);
+        if (reason === "startup") {
+          const previousMetrics = devStartupMetricsByOutputKey.get(generationMetricsKey);
+          if (previousMetrics && isLessRich(metrics, previousMetrics)) {
+            logInfo(
+              `generate(${reason}): skipped smaller snapshot (components=${metrics.entryCount}, selectors=${metrics.selectorCount})`
+            );
+            return;
+          }
+        }
         const t0 = performance.now();
         generateFiles(snapshotHierarchy, snapshotVuePathMap, normalizedBasePagePath, {
           outDir,
@@ -5673,8 +5860,11 @@ function createDevProcessorPlugin(options) {
           routerEntry: resolvedRouterEntry,
           routerType
         });
+        if (reason === "startup") {
+          devStartupMetricsByOutputKey.set(generationMetricsKey, metrics);
+        }
         const t1 = performance.now();
-        logInfo(`generate(${reason}): components=${snapshotHierarchy.size} in ${formatMs(t1 - t0)}`);
+        logInfo(`generate(${reason}): components=${metrics.entryCount} selectors=${metrics.selectorCount} in ${formatMs(t1 - t0)}`);
       };
       const initialBuildPromise = (async () => {
         const t0 = performance.now();
@@ -6195,20 +6385,21 @@ function createVuePluginWithTestIds(options) {
       }
     ];
   };
+  const runtimeNodeTransform = (node, context) => {
+    const filename = context.filename;
+    if (!filename || !filename.endsWith(".vue") || !isFileInScope(filename)) {
+      return;
+    }
+    const transforms = getNodeTransforms(filename);
+    const ourTransform = transforms[transforms.length - 1];
+    return ourTransform(node, context);
+  };
   const templateCompilerOptions = {
     ...userCompilerOptions,
     prefixIdentifiers: true,
     nodeTransforms: [
       ...userNodeTransforms,
-      (node, context) => {
-        const filename = context.filename;
-        if (!filename || !filename.endsWith(".vue") || !isFileInScope(filename)) {
-          return;
-        }
-        const transforms = getNodeTransforms(filename);
-        const ourTransform = transforms[transforms.length - 1];
-        return ourTransform(node, context);
-      }
+      runtimeNodeTransform
     ]
   };
   const metadataCollectorPlugin = {
@@ -6247,7 +6438,42 @@ function createVuePluginWithTestIds(options) {
     ...vueOptions,
     template
   });
-  return { metadataCollectorPlugin, internalVuePlugin };
+  const nuxtVueBridgePlugin = {
+    name: "vue-pom-generator-nuxt-vue-bridge",
+    apply: "serve",
+    configResolved(config) {
+      const viteVuePlugin = config.plugins.find((plugin) => {
+        return typeof plugin === "object" && plugin !== null && "name" in plugin && plugin.name === "vite:vue" && "api" in plugin;
+      });
+      const api = viteVuePlugin?.api;
+      if (!api) {
+        loggerRef.current.warn("[vue-pom-generator] Nuxt bridge could not find vite:vue plugin to patch.");
+        return;
+      }
+      const currentOptions = api.options ?? {};
+      const currentTemplate = currentOptions.template ?? {};
+      const currentCompilerOptions = currentTemplate.compilerOptions ?? {};
+      const currentNodeTransforms = currentCompilerOptions.nodeTransforms ?? [];
+      if (currentNodeTransforms.includes(runtimeNodeTransform)) {
+        return;
+      }
+      api.options = {
+        ...currentOptions,
+        template: {
+          ...currentTemplate,
+          compilerOptions: {
+            ...currentCompilerOptions,
+            prefixIdentifiers: true,
+            nodeTransforms: [
+              ...currentNodeTransforms,
+              runtimeNodeTransform
+            ]
+          }
+        }
+      };
+    }
+  };
+  return { metadataCollectorPlugin, internalVuePlugin, nuxtVueBridgePlugin };
 }
 function assertNonEmptyString(value, name) {
   if (!value || !value.trim()) {
@@ -6373,7 +6599,7 @@ function createVuePomGeneratorPlugins(options = {}) {
   const semanticNameMap = /* @__PURE__ */ new Map();
   const componentHierarchyMap = /* @__PURE__ */ new Map();
   const vueFilesPathMap = /* @__PURE__ */ new Map();
-  const { metadataCollectorPlugin, internalVuePlugin } = createVuePluginWithTestIds({
+  const { metadataCollectorPlugin, internalVuePlugin, nuxtVueBridgePlugin } = createVuePluginWithTestIds({
     vueOptions,
     existingIdBehavior,
     nameCollisionBehavior,
@@ -6424,7 +6650,7 @@ function createVuePomGeneratorPlugins(options = {}) {
   const resultPlugins = [
     configPlugin,
     metadataCollectorPlugin,
-    ...isNuxt ? [] : [internalVuePlugin],
+    ...isNuxt ? [nuxtVueBridgePlugin] : [internalVuePlugin],
     ...supportPlugins
   ];
   if (!generationEnabled) {
@@ -6432,7 +6658,7 @@ function createVuePomGeneratorPlugins(options = {}) {
     return [
       configPlugin,
       metadataCollectorPlugin,
-      ...isNuxt ? [] : [internalVuePlugin],
+      ...isNuxt ? [nuxtVueBridgePlugin] : [internalVuePlugin],
       virtualModules
     ];
   }