ResponseTranslator

A fresh IBS template registry holding the brand's built-ins.

plain-string description keys for translation; keys are preg_quote'd before matching

Defaults to no rewrites (RSRMID-2970). A brand that rewrites nothing used to have to say so in four members — two empty private constants and two hooks returning them — which is boilerplate asserting an absence, not a decision recorded.

This is not the "never no-op" case. That directive (see {\CNIC\CNR\Client}, RSRMID-2920) is about a capability the platform cannot honour, where a silent discard hides a caller's mistake. An empty rewrite map is the opposite: a complete and truthful answer to "which messages does this brand rewrite?", from a brand whose answer is "none". Nothing is discarded and no caller is misled — the two rewrite loops in {\CNIC\translate()} iterate over nothing, exactly as they did over an empty constant.

raw regex pattern keys for translation; keys are used as-is (not preg_quote'd)

Defaults to no rewrites, for the reasons on {\CNIC\descriptionRegexMap()}.

IBS carries the human-readable text in the message field.

IBS falls back to the "invalid" template when status is missing (JSON or plain) or present but empty. message is optional in success cases and is deliberately not checked.

The JSON arm is deliberately unanchored (RSRMID-2972). /"status":/i cannot tell a top-level status from one nested under product[0], so a payload whose only status sits inside a product satisfies the check and passes through untouched. Keep it that way. A stricter pattern would make this return true, and {\CNIC\AbstractResponseTranslator::translate()} replaces the payload wholesale with the "invalid" template — destroying product[0].code and product[0].message before {\CNIC\IBS\Response::getCode()} could read them. Those are exactly the fields RTLDEV-16781 exists to surface, so tightening this regex would discard the data the fallback downstream was added to recover.

The provisioning failure shape this protects always carries a top-level status too, so the leniency is not currently load-bearing for any observed response — it is load-bearing for the class of payload, and the cost of being wrong is silent data loss rather than a visible error. See {\CNIC\IBS\Response::isError()} for the shapes the API actually sends.

translate a raw api response

Replace known placeholders in the human-readable field while preserving literal brace content and unknown-token content in other fields.

Operates line-by-line on the brand's field (see fieldName()): provided placeholders are substituted, unknown {UPPER} tokens are stripped, and any other brace content (e.g. lowercase %{i} in SPF records) is left untouched.