slicerPrinterMatch.ts 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397
  1. // Printer-compatibility matching for the SliceModal's process / filament
  2. // dropdowns (#1325).
  3. //
  4. // Compatibility is resolved in this order, stopping on the first non-unknown
  5. // answer:
  6. //
  7. // 1. Imported (local-tier) presets carry the slicer's own
  8. // `compatible_printers` list — an exact list of printer-preset names.
  9. // 2. The `@<printer>` naming convention, in both shapes the slicer
  10. // writes: `@BBL <model>` on shipped cloud / standard presets, and
  11. // `@Bambu Lab <model> <size> nozzle` on presets a user saved for a
  12. // specific printer (#2628). The token → printer-fragment table is
  13. // derived from the backend's canonical PRINTER_MODEL_MAP (fetched via
  14. // /slicer/printer-models), not duplicated here.
  15. //
  16. // Only a definite 'mismatch' is acted on: the dropdown holds those back
  17. // behind a "Show all" link. A preset no rule covers classifies as 'unknown'
  18. // and always stays in the list — absence of evidence is not evidence of
  19. // incompatibility, and hiding an untagged preset would make a user's own
  20. // imported profiles disappear. That asymmetry is why every parse failure
  21. // below returns 'unknown' rather than guessing a mismatch.
  22. export type PrinterCompatibility = 'match' | 'mismatch' | 'unknown';
  23. // Lookup tables consumed by `presetCompatibility`. `bambuModelByShortCode`
  24. // is the @BBL token → printer-preset fragment map derived from the backend's
  25. // PRINTER_MODEL_MAP — e.g. `X1C` → `X1 Carbon`. An empty map means the @BBL
  26. // fallback still works when token and printer-name fragment match directly
  27. // (raw-token comparison), and gracefully degrades otherwise.
  28. export interface PrinterCompatibilityIndex {
  29. bambuModelByShortCode: Record<string, string>;
  30. }
  31. /** An empty index — used when the model map hasn't loaded yet. */
  32. export const EMPTY_COMPATIBILITY_INDEX: PrinterCompatibilityIndex = {
  33. bambuModelByShortCode: {},
  34. };
  35. // Bambu cloud started shipping terse model codes in `@BBL <code>` suffixes
  36. // mid-2026 — the most visible one is "A1 Mini" → "A1M" (#1649, reported by
  37. // @technopaw). User-authored profiles still use the long display name, so
  38. // both shapes have to match the same printer. The table is uppercase-normalised
  39. // for case-insensitive lookups; add a row when a future rename is spotted via
  40. // `/api/v1/cloud/settings`. Keep narrow on purpose — wide-net aliasing
  41. // (e.g. "X1" ⇄ "X1C") would silently group truly distinct printers.
  42. const PRINTER_MODEL_SUFFIX_ALIASES: Record<string, readonly string[]> = {
  43. 'A1 MINI': ['A1M'],
  44. };
  45. /**
  46. * True when ``presetSuffix`` (the token extracted from a "@BBL <code>" or
  47. * preset-name suffix) refers to the same printer as ``printerModel``
  48. * (the display name selected in the picker). Case-insensitive; consults
  49. * the alias table for short codes Bambu introduced after the long forms
  50. * shipped (#1649).
  51. */
  52. export function matchesPrinterModelSuffix(presetSuffix: string, printerModel: string): boolean {
  53. const p = presetSuffix.toUpperCase();
  54. const m = printerModel.toUpperCase();
  55. if (p === m) return true;
  56. const aliasesOfM = PRINTER_MODEL_SUFFIX_ALIASES[m];
  57. if (aliasesOfM && aliasesOfM.includes(p)) return true;
  58. const aliasesOfP = PRINTER_MODEL_SUFFIX_ALIASES[p];
  59. if (aliasesOfP && aliasesOfP.includes(m)) return true;
  60. return false;
  61. }
  62. /**
  63. * Invert the backend's PRINTER_MODEL_MAP into the shape the @BBL fallback
  64. * needs: short code → printer-preset fragment (the part of "Bambu Lab X1
  65. * Carbon" the user sees in a printer preset name, minus the "Bambu Lab "
  66. * brand prefix).
  67. *
  68. * Backend ships e.g. `{"Bambu Lab X1 Carbon": "X1C", "Bambu Lab A1 mini":
  69. * "A1 Mini", "Bambu Lab A1 Mini": "A1 Mini"}` — multiple long forms can map
  70. * to the same short. We pick the first long-form encountered for each short
  71. * code; case normalisation happens at match time so "A1 mini" vs "A1 Mini"
  72. * never matters.
  73. */
  74. function buildShortCodeMap(
  75. printerModels: Record<string, string>,
  76. ): Record<string, string> {
  77. const out: Record<string, string> = {};
  78. for (const [longName, shortCode] of Object.entries(printerModels)) {
  79. if (shortCode in out) continue;
  80. out[shortCode] = longName.replace(/^Bambu Lab\s+/, '');
  81. }
  82. return out;
  83. }
  84. /**
  85. * Build the compatibility index from the backend printer-model registry.
  86. */
  87. export function buildCompatibilityIndex(
  88. printerModels: Record<string, string> = {},
  89. ): PrinterCompatibilityIndex {
  90. return {
  91. bambuModelByShortCode: buildShortCodeMap(printerModels),
  92. };
  93. }
  94. function normalizeModelFragment(s: string): string {
  95. return s.replace(/\s+/g, '').toLowerCase();
  96. }
  97. /**
  98. * Drop BambuStudio's ``"# "`` user-clone prefix.
  99. *
  100. * Editing a system preset saves a copy named ``"# Bambu Lab X1 Carbon 0.4
  101. * nozzle"``, and `.bbscfg` bundle exports use the same convention. Two places
  102. * need it off:
  103. *
  104. * 1. ``extractPrinterPresetModel`` — the prefix fails its "Bambu Lab …"
  105. * test, so a cloned *printer* made every preset classify as 'unknown'
  106. * and the dropdown filter silently did nothing.
  107. * 2. The ``compatible_printers`` comparison, where a prefix on one side
  108. * alone reads as a mismatch against the very printer the preset was
  109. * cloned from — and a mismatch now hides the preset.
  110. *
  111. * The ``@`` tag extractors need no such handling: they scan for "@BBL " or
  112. * the last "@", both of which skip a leading prefix already.
  113. *
  114. * The backend normalises the same prefix in ``_canonical_printer_model``.
  115. */
  116. function stripUserClonePrefix(name: string): string {
  117. return name.replace(/^#\s*/, '').trim();
  118. }
  119. // Bambu Studio's naming convention for bundled presets: the 0.4 nozzle is
  120. // the default and its variants drop the nozzle suffix; 0.2 / 0.6 / 0.8
  121. // carry an explicit "<size> nozzle" segment. So a process with no suffix
  122. // is implicitly a 0.4 process — required to compare correctly against a
  123. // 0.4 printer preset, which DOES carry the suffix.
  124. const DEFAULT_NOZZLE = '0.4';
  125. // Strip a trailing "<size> nozzle" segment, returning the nozzle string
  126. // (e.g. "0.6") or null when absent. Used by both BBL-token and printer-
  127. // preset extractors so the suffix is parsed identically on both sides.
  128. function takeNozzleSuffix(s: string): { stripped: string; nozzle: string | null } {
  129. const m = s.match(/^(.*?)\s+([\d.]+)\s*nozzle\s*$/i);
  130. if (!m) return { stripped: s.trim(), nozzle: null };
  131. return { stripped: m[1].trim(), nozzle: m[2] };
  132. }
  133. // Pull the model token and nozzle out of a "@BBL <token> [<size> nozzle]"
  134. // suffix. The token may contain a space (e.g. "A1 mini"), so we strip a
  135. // trailing nozzle segment rather than splitting on the first whitespace.
  136. function extractBblToken(presetName: string): { token: string; nozzle: string | null } | null {
  137. const marker = '@BBL ';
  138. const idx = presetName.indexOf(marker);
  139. if (idx < 0) return null;
  140. const rest = presetName.slice(idx + marker.length).trim();
  141. const { stripped, nozzle } = takeNozzleSuffix(rest);
  142. return stripped ? { token: stripped, nozzle } : null;
  143. }
  144. // Pull the model fragment and nozzle out of a "Bambu Lab <model> [<size>
  145. // nozzle]" printer preset name. Returns null for non-Bambu printer
  146. // presets — there is no reliable name-based match against those.
  147. function extractPrinterPresetModel(printerPresetName: string): { model: string; nozzle: string | null } | null {
  148. const m = stripUserClonePrefix(printerPresetName).match(/^Bambu Lab\s+(.+)$/i);
  149. if (!m) return null;
  150. const { stripped, nozzle } = takeNozzleSuffix(m[1]);
  151. return stripped ? { model: stripped, nozzle } : null;
  152. }
  153. // Trailing parenthetical the slicer appends to user-saved presets —
  154. // "… @Bambu Lab H2D 0.4 nozzle (Custom)". Dropped before the nozzle suffix
  155. // is parsed, or the tag would resolve to a nonsense model token and the
  156. // preset would be branded a mismatch against its OWN printer.
  157. function stripTrailingParenthetical(s: string): string {
  158. return s.replace(/\s*\([^)]*\)\s*$/, '').trim();
  159. }
  160. // Nozzle sizes Bambu ships run 0.2 – 0.8. The range guard keeps a tag that
  161. // merely looks numeric ("PLA @2026") from being read as a nozzle and branded
  162. // incompatible with every printer.
  163. const MIN_NOZZLE_MM = 0.1;
  164. const MAX_NOZZLE_MM = 2.0;
  165. // Compare two nozzle strings numerically, so "0.20" and "0.2" are the same
  166. // size. Unparseable values never match — a size we can't read is not evidence.
  167. function sameNozzle(a: string, b: string): boolean {
  168. const x = Number.parseFloat(a);
  169. const y = Number.parseFloat(b);
  170. if (Number.isNaN(x) || Number.isNaN(y)) return false;
  171. return x === y;
  172. }
  173. // Pull the model token and nozzle out of a preset name's printer tag.
  174. // Three shapes exist in the wild (#2628):
  175. //
  176. // "0.20mm Standard @BBL X1C" — short code, the form
  177. // Bambu ships its own cloud / standard presets under.
  178. // "SUNLU TPU 95A @Bambu Lab H2D 0.4 nozzle" — the full printer-preset
  179. // name, the form the slicer writes when a user saves their own preset
  180. // for a printer. Handling only the short form left these classified
  181. // 'unknown', so an H2D-scoped filament was offered (and auto-picked)
  182. // for an A1 slice, which the CLI then rejected.
  183. // "Overture PLA Matte @0.2" — nozzle only, no model.
  184. // Returned with a null token: the size can rule a printer OUT, but
  185. // says nothing about which models the profile belongs to.
  186. //
  187. // The first two shapes are also parsed in ConfigureAmsSlotModal (#1623).
  188. function extractPrinterTag(presetName: string): { token: string | null; nozzle: string | null } | null {
  189. const cleaned = stripTrailingParenthetical(presetName);
  190. const bbl = extractBblToken(cleaned);
  191. if (bbl) return bbl;
  192. // The printer tag is a suffix by convention, so read from the LAST '@' —
  193. // a stray earlier one ("My @work PLA @Bambu Lab H2D 0.4 nozzle") must not
  194. // swallow it. Anything that doesn't parse as a Bambu printer preset name
  195. // falls through to 'unknown', never to a guessed mismatch.
  196. const at = cleaned.lastIndexOf('@');
  197. if (at < 0) return null;
  198. const suffix = cleaned.slice(at + 1).trim();
  199. const longForm = extractPrinterPresetModel(suffix);
  200. if (longForm) return { token: longForm.model, nozzle: longForm.nozzle };
  201. const nozzleOnly = suffix.match(/^([\d.]+)\s*(?:mm)?\s*(?:nozzle)?$/i);
  202. if (nozzleOnly) {
  203. const size = Number.parseFloat(nozzleOnly[1]);
  204. if (!Number.isNaN(size) && size >= MIN_NOZZLE_MM && size <= MAX_NOZZLE_MM) {
  205. return { token: null, nozzle: nozzleOnly[1] };
  206. }
  207. }
  208. return null;
  209. }
  210. /**
  211. * Name-based fallback for presets carrying a printer tag — BambuStudio's own
  212. * `@BBL <model>` (#1325 follow-up), the full `@Bambu Lab <model> <size>
  213. * nozzle` form user-saved presets get, or a bare `@<size>` (#2628).
  214. * Used only after `compatible_printers` has returned `'unknown'`.
  215. *
  216. * Compares BOTH model AND nozzle. The nozzle filter is required because
  217. * Bambu ships per-nozzle process / filament variants (0.2 / 0.4 / 0.6 /
  218. * 0.8) — a 0.6-nozzle process is unusable on a 0.4-nozzle printer.
  219. * 0.4 is Bambu's default and its variants drop the nozzle suffix, so a
  220. * preset with no suffix counts as 0.4.
  221. */
  222. function classifyByBambuName(
  223. presetName: string,
  224. selectedPrinterName: string,
  225. bambuModelByShortCode: Record<string, string>,
  226. ): PrinterCompatibility {
  227. const parsed = extractPrinterTag(presetName);
  228. if (!parsed) return 'unknown';
  229. const selectedParts = extractPrinterPresetModel(selectedPrinterName);
  230. if (!selectedParts) return 'unknown';
  231. if (parsed.token === null) {
  232. // Nozzle-only tag ("Overture PLA Matte @0.2"). The size can rule a
  233. // printer OUT, but a matching size proves nothing about the model, so
  234. // the best this can ever return is 'unknown' — never 'match'.
  235. if (
  236. selectedParts.nozzle !== null
  237. && parsed.nozzle !== null
  238. && !sameNozzle(parsed.nozzle, selectedParts.nozzle)
  239. ) {
  240. return 'mismatch';
  241. }
  242. return 'unknown';
  243. }
  244. // If the token isn't in the table (a brand-new Bambu model whose short
  245. // code the backend registry hasn't added yet, or the model map hasn't
  246. // loaded yet), fall back to comparing the raw token. That keeps the
  247. // matcher working when token and printer-name fragment happen to be
  248. // identical — e.g. "Q1" preset against "Bambu Lab Q1 0.4 nozzle" —
  249. // without us having to ship a code update. When they differ in form
  250. // (X1C vs "X1 Carbon"), the registry is what makes the match work.
  251. const inferredModel = bambuModelByShortCode[parsed.token] ?? parsed.token;
  252. // The raw inferred model and the printer-preset fragment may differ only by
  253. // the Bambu short-code rename (e.g. preset token "A1M" vs printer "A1 Mini").
  254. // ``matchesPrinterModelSuffix`` consults the alias table before declaring a
  255. // mismatch — see #1649.
  256. if (
  257. normalizeModelFragment(selectedParts.model) !== normalizeModelFragment(inferredModel)
  258. && !matchesPrinterModelSuffix(parsed.token, selectedParts.model)
  259. ) {
  260. return 'mismatch';
  261. }
  262. // Nozzle compare — only when we have a usable size from the printer
  263. // side. A Bambu printer preset always carries one, so this branch is
  264. // taken in practice; the null path is defensive degrade for hand-typed
  265. // or non-Bambu printer names that happened to match the model.
  266. if (selectedParts.nozzle !== null) {
  267. const presetNozzle = parsed.nozzle ?? DEFAULT_NOZZLE;
  268. if (!sameNozzle(presetNozzle, selectedParts.nozzle)) return 'mismatch';
  269. }
  270. return 'match';
  271. }
  272. /**
  273. * Classify a process / filament preset against the selected printer.
  274. *
  275. * - 'match' — the preset is compatible with the selected printer.
  276. * - 'mismatch' — the preset resolves to a *different* printer.
  277. * - 'unknown' — compatibility can't be determined (no `compatible_printers`,
  278. * no recognizable `@BBL` tag, or no printer is selected);
  279. * the caller must not hide it.
  280. */
  281. export function presetCompatibility(
  282. preset: { name: string; compatible_printers?: string[] | null },
  283. _slot: 'process' | 'filament',
  284. selectedPrinterName: string | null,
  285. index: PrinterCompatibilityIndex,
  286. ): PrinterCompatibility {
  287. if (!selectedPrinterName) return 'unknown';
  288. // (1) Imported presets carry the slicer's own compatible_printers list —
  289. // authoritative when set.
  290. const compat = preset.compatible_printers;
  291. if (compat && compat.length > 0) {
  292. // Compared with the clone prefix off both sides: a preset cloned from a
  293. // system printer lists the *unprefixed* name, and comparing that raw
  294. // against a selected "# Bambu Lab …" reads as a mismatch — which now
  295. // hides the preset rather than merely demoting it.
  296. const selected = stripUserClonePrefix(selectedPrinterName);
  297. return compat.some((name) => stripUserClonePrefix(name) === selected) ? 'match' : 'mismatch';
  298. }
  299. // (2) BambuStudio's `@BBL <model>` name convention — covers cloud /
  300. // standard presets that don't carry compatible_printers.
  301. return classifyByBambuName(preset.name, selectedPrinterName, index.bambuModelByShortCode);
  302. }
  303. // model token compiles to a flexible-whitespace word-boundary regex.
  304. function _tokenToRegex(token: string): RegExp {
  305. const escaped = token.replace(/[.*+?^${}()|[\]\\]/g, '\\$&').replace(/\s+/g, '\\s+');
  306. return new RegExp(`\\b${escaped}\\b`, 'i');
  307. }
  308. // Extract printer model from a preset name → normalized short code
  309. // (e.g. "X1C", "H2D"). Two strategies in order:
  310. //
  311. // (1) ``@`` suffix — the BambuStudio naming convention. Two shapes:
  312. // - "@BBL X1C 0.4 nozzle" → "X1C" (short-code form,
  313. // Bambu Cloud system presets)
  314. // - "@Bambu Lab X1 Carbon 0.4 nozzle" → "X1C" (long-form, used by
  315. // user-renamed Bambu Cloud presets and most Orca Cloud profiles —
  316. // reverse-looked-up via the backend printer-model registry)
  317. //
  318. // (2) Body scan — many user-authored / Orca Cloud presets put the printer
  319. // model at the START of the name with no @ suffix at all (the literal
  320. // shape that surfaced #1623: "X1C eSUN PETG-Basic Filament"). Scan the
  321. // name for any known model token (every long-name fragment + every short
  322. // code from the registry) and return the first match. Long-first sort
  323. // keeps "A1 Mini" / "X1 Carbon" / "H2D Pro" from being eaten by their
  324. // shorter sibling ("A1" / "X1" / "H2D"). Word-boundary regex prevents
  325. // false-positives on partial substrings (e.g. "PA1" doesn't match "A1",
  326. // "X1Box" doesn't match "X1").
  327. //
  328. // Returns null when neither strategy resolves; the caller keeps such
  329. // presets visible (can't filter what we can't classify).
  330. //
  331. // ``printerModelsLongToShort`` is the backend's PRINTER_MODEL_MAP shape:
  332. // keys are "Bambu Lab <long>", values are short codes.
  333. export function extractPresetModel(
  334. name: string,
  335. printerModelsLongToShort: Record<string, string>,
  336. ): string | null {
  337. const atIdx = name.indexOf('@');
  338. if (atIdx >= 0) {
  339. const suffix = name.slice(atIdx + 1).trim();
  340. const bblMatch = suffix.match(/^BBL\s+(.+?)(?:\s+[\d.]+\s*nozzle)?$/i);
  341. if (bblMatch) return bblMatch[1].trim();
  342. const longMatch = suffix.match(/^Bambu Lab\s+(.+?)(?:\s+[\d.]+\s*nozzle)?$/i);
  343. if (longMatch) {
  344. const longFragment = longMatch[1].trim();
  345. const fullKey = `Bambu Lab ${longFragment}`;
  346. if (printerModelsLongToShort[fullKey]) return printerModelsLongToShort[fullKey];
  347. const lower = fullKey.toLowerCase();
  348. for (const [k, v] of Object.entries(printerModelsLongToShort)) {
  349. if (k.toLowerCase() === lower) return v;
  350. }
  351. return longFragment;
  352. }
  353. }
  354. // Body scan — accumulate {token, short} pairs and try long-first.
  355. const tokens: Array<{ token: string; short: string }> = [];
  356. const seen = new Set<string>();
  357. for (const [longName, short] of Object.entries(printerModelsLongToShort)) {
  358. const fragment = longName.replace(/^Bambu Lab\s+/, '');
  359. const key = fragment.toLowerCase();
  360. if (!seen.has(key)) {
  361. tokens.push({ token: fragment, short });
  362. seen.add(key);
  363. }
  364. const shortKey = short.toLowerCase();
  365. if (!seen.has(shortKey)) {
  366. tokens.push({ token: short, short });
  367. seen.add(shortKey);
  368. }
  369. }
  370. tokens.sort((a, b) => b.token.length - a.token.length);
  371. for (const { token, short } of tokens) {
  372. if (_tokenToRegex(token).test(name)) return short;
  373. }
  374. return null;
  375. }