Function: buildScriptResponse()

buildScriptResponse(input): ScriptMessage

Build a spec-clean SCRIPT response (<Status>/<Error>/<Verify>) message. Refuses to construct a response with no <Code> (SCRIPT_BUILD_CODES.MISSING_RESPONSE_CODE): the one field the parser itself flags as required, or an XML-illegal control character (SCRIPT_BUILD_CODES.INVALID_CHARACTER).

Parameters

input

ScriptResponseInput

The response kind, code, optional description, and header.

Returns

ScriptMessage

A frozen ScriptMessage carrying the response body.

Throws

NcpdpScriptBuildError when the input cannot form a spec-clean response.

Example

import { buildScriptResponse } from "@cosyte/ncpdp/script";
const ack = buildScriptResponse({
  kind: "Status",
  code: "010",
  header: { relatesToMessageId: "SYNTH-1" },
});
ack.disposition; // "success"