Upgrading¶

What to change in your code when a release removes or changes something you use, newest release first. Each release's full list of changes is in the changelog. The reasons for each removal, and whether it could come back, are in API_REMOVALS.md.

0.32.0¶

Test values on built dies are read-only¶

die.testValues and die.testPass on a die from buildWaferMap are now built from the map's columns each time you read them, as a frozen object. Three things follow:

• Writing fails. die.testValues = … throws a TypeError. The objects are frozen, so die.testValues[1050] = … or delete throws in strict-mode code (ES modules, TypeScript output) and is silently ignored in a classic script. Put the values in the input to buildWaferMap, or make your own copy of the die: { ...die, testValues: { ...die.testValues, 1050: v } }.
• Each read is a new object, so die.testValues !== die.testValues. Compare values, not objects, and read the object once into a local variable inside a loop over tests.
• The map no longer shares your input's objects. Changing a record's testValues after the build does not change the map; build again.

A spread, structuredClone or JSON.stringify of a built die gives ordinary objects with the same values. Dies you build yourself keep ordinary objects.

Input values of the wrong type are left out¶

A bin, site number or test value that is not a number (for example the string "3"), or a verdict that is not true/false, is now treated as missing, the same as a value outside the STDF V4 ranges. It is still reported as the input-values-not-numbers warning. If your data can carry numbers as strings, convert them before calling buildWaferMap: a die whose only bin was text now has no verdict instead of counting as a fail, which can change yield. Pre-built dies get the same checks as results, and a pre-built die whose coordinates STDF cannot store becomes an unpositioned die.

Gallery cards off screen are drawn when needed¶

renderWaferGallery now draws a card's canvas only while the card is on (or near) the screen; the rest are drawn as they scroll into view. The gallery's own PNG, printing and a card's own PNG draw every card first, so they always show the whole gallery. If your app captures the cards itself — reading a card's <canvas> with toDataURL, or screenshotting the page with a tool such as html2canvas — cards that have not been on screen are blank: scroll them into view first, or use the gallery's own PNG export.

WaferMapResult.view is removed¶

view was marked @internal, and the renderers build their own draw list whenever they draw. If your code read result.view.plotMode, result.view.metadata or similar, read the same field on the result itself: result.plotMode, result.metadata, result.isLotStack, result.hbinDefs, result.sbinDefs, result.testDefs. There is no replacement for the draw list itself (rectangles, hoverPoints, overlays): draw with renderWaferMap or renderWaferGallery.

0.31.0¶

Removed exports¶

0.31.0 removes 74 exports: the 73 deprecated in 0.30.0 and renderFindingsReportHtml, deprecated in 0.30.3. Each one logged a console notice naming its replacement on first use. If your code calls buildWaferMap, renderWaferMap, renderWaferGallery, analyzeWaferMap and analyzeWaferLot, and imports none of the names below, you have nothing to change here.

To check: search your imports from @wafertools/wafermap for the names in these tables. In TypeScript, each one is now a compile error at the import.

Colours¶

// Before
const colours = resolveBinColors(result.dies, { passBins: [1, 5] });

// After: pass bins come from the result
const colours = binColorsForMaps(result);          // one map
const lotColours = binColorsForMaps(results);      // several, resolved together

Figures for your own tables, exports and charts¶

Every figure the charts, Summary panel and reports show comes back from the analysis. Options such as computePerTestStats are on analyzeWaferMap and analyzeWaferLot.

// Before
const yieldData = buildYieldData(items, [1]);

// After
const lot = analyzeWaferLot(results);
lot.lotYieldSeries;                  // [{ waferIndex, yieldPercent }, …]
lot.perWafer[0].summary.stats.regionYield.quadrant;   // [{ key, label, yieldPercent, n, passDies }, …]

Reports¶

Both report builders read pass bins and ring count from the built maps, so there is nothing to keep in step.

Die layouts and geometry¶

// Before
const wafer = createWafer({ diameter: 300 });
const dies = clipDiesToWafer(generateDies(wafer, { width: 10, height: 10 }), wafer, { width: 10, height: 10 });

// After
const layout = buildWaferMap({
  layout: true,
  waferConfig: { diameter: 300 },
  dieConfig: { width: 10, height: 10 },
});
renderWaferMap(container, layout);

Small helpers¶

The low-level drawing pipeline¶

buildView, toCanvas, buildHoverText, buildMapTitle, applyOrientation, transformDies, isInsideWafer, generateReticleGrid, applyProbeSequence, mapDataToDies and the affine* helpers are removed with no direct replacement. Build with buildWaferMap and draw with renderWaferMap or renderWaferGallery. If you drew maps yourself (to SVG, a server-side image or another canvas library), say what you need in an issue.

Options¶

Types¶

The types that belonged only to removed functions are removed with them. The types of everything that remains, such as WaferMapResult, StatsSummary and RenderOptions, are unchanged.

STDF value ranges¶

0.30.4 warned about values STDF V4 cannot store (input-values-outside-stdf) and used them as given. 0.31.0 treats them as missing. If that warning appeared on your data, the map now differs:

Fix the data at its source, or convert it before building. A coordinate given as 1.5 is the usual cause of a map losing its dies' positions: pass whole prober steps.