@cosyte/astm 0.0.11 → 0.0.13

package/dist/index.mjs

@@ -1385,7 +1385,8 @@ var AstmSerializeError = class extends Error {
   /**
    * Stable discriminant. `ASTM_EMIT_UNENCODABLE_VALUE` for a `CR`/`LF` in a value;
    * `ASTM_EMIT_INVALID_DELIMITERS` for a delimiter set that cannot be emitted
-   * reversibly.
+   * reversibly; `ASTM_EMIT_TYPE_LETTER_COLLISION` for a record whose own type
+   * letter the set being emitted with would escape away.
    */
   code;
   /** 0-based ordinal of the record within the message, when known. */
@@ -1449,10 +1450,24 @@ function serializeAstmRecord(record, d = CANONICAL_DELIMITERS) {
   return serializeRecordChecked(record, d);
 }
 function serializeRecordChecked(record, d) {
+  return assertTypeLetterSurvives(serializeRecordText(record, d), record);
+}
+function serializeRecordText(record, d) {
   if (record.type === "M" || record.type === "S") return serializeVerbatimRecord(record, d);
   if (record.type === "H") return serializeHeader(record, d);
   return record.fields.map((f) => encodeField(f.repeats, d, record.recordIndex)).join(d.field);
 }
+function recordTypeLetter(record) {
+  return record.type === "unsupported" ? record.rawType : record.type;
+}
+function assertTypeLetterSurvives(text, record) {
+  if (text.charAt(0) === recordTypeLetter(record)) return text;
+  throw new AstmSerializeError(
+    "A record's type letter is escaped away by the delimiters being emitted with, so the record would read back as a different record. The record's index is on the error; the letter itself is not quoted, because on an unsupported record it is a byte off the wire.",
+    record.recordIndex,
+    "ASTM_EMIT_TYPE_LETTER_COLLISION"
+  );
+}
 function serializeVerbatimRecord(record, d) {
   if (recoversVerbatim(record, d)) return record.rawLine;
   return record.fields.map((f) => encodeField(f.repeats, d, record.recordIndex)).join(d.field);
@@ -2227,7 +2242,9 @@ var AstmFrameEncodeError = class extends Error {
   /**
    * Position of the offending character within that record, when applicable:
    * its index in the string, never the character itself and never its code
-   * point. Enough to find it in the caller's own data.
+   * point. Enough to find it in the caller's own data. For a record supplied as
+   * a `Uint8Array` this is the offending byte's index, which is the same
+   * position: a record string is a byte string, so the two indices coincide.
    */
   characterIndex;
   /** @internal */
@@ -2257,6 +2274,20 @@ function toBytes(input, recordIndex) {
   }
   return out;
 }
+var RESERVED_STRUCTURE_BYTES = /* @__PURE__ */ new Set([STX, ETB, ETX]);
+function assertFramable(bytes, recordIndex) {
+  for (let i = 0; i < bytes.length; i += 1) {
+    const byte = bytes[i];
+    if (byte !== void 0 && RESERVED_STRUCTURE_BYTES.has(byte)) {
+      throw new AstmFrameEncodeError(
+        "A record contains a byte the framing layer reads as structure (STX, ETB or ETX). A frame has no escape sequence for one, so it cannot be carried inside a frame: remove it from the record before framing.",
+        recordIndex,
+        "ASTM_FRAME_RESERVED_BYTE",
+        i
+      );
+    }
+  }
+}
 function encodeFrame(text, frameNumber, isFinal) {
   const term = isFinal ? ETX : ETB;
   const bytes = [STX, FN_ZERO + frameNumber, ...text, term];
@@ -2278,6 +2309,7 @@ function composeAstmFrames(records, options = {}) {
         recordIndex
       );
     }
+    assertFramable(bytes, recordIndex);
     for (let offset = 0; offset < bytes.length; offset += MAX_FRAME_TEXT) {
       const chunk = bytes.subarray(offset, offset + MAX_FRAME_TEXT);
       const isFinal = offset + MAX_FRAME_TEXT >= bytes.length;
@@ -2313,7 +2345,7 @@ function concatBytes3(chunks) {
 }
 
 // src/index.ts
-var VERSION = "0.0.11";
+var VERSION = "0.0.13";
 
 export { ALL_ASTM_WARNING_CODES, AMBIGUOUS_CODES, ACK as ASTM_ACK, ENQ as ASTM_ENQ, EOT as ASTM_EOT, NAK as ASTM_NAK, AstmAmbiguousStreamError, AstmFrameEncodeError, AstmFrameStrictError, AstmParseError, AstmProfileDefinitionError, AstmSerializeError, AstmStrictError, CANONICAL_DELIMITERS, FATAL_CODES, FRAME_WARNING_CODES, LIVD_WARNING_CODES, LTP_WARNING_CODES, SAFETY_CRITICAL_CODES, TOLERABLE_CODES, VERSION, WARNING_CODES, ambiguousMessageKind, ambiguousValueSplit, applyAstmProfile, applyAstmProfileToWarnings, applyLivd, astmDateToLocalISO, astmProfiles, attachComments, buildAstmMessage, classifyMessage, comments, commentsFor, composeAstmFrames, computeChecksum, decodeAstmFrames, decodeEscapes, deepFreeze, defineAstmProfile, defineLivdCatalog, delimitersRedeclared, detectFraming, encodeComponent, fieldScalar, fieldsUnseparated, frameBadChecksum, frameOversize, frameSequenceGap, frameUnterminated, getAstmProfile, getDefaultAstmProfile, interpretAbnormalFlag, interpretResultStatus, isNonStandard, isSafetyCriticalCode, listAstmProfiles, livdAmbiguousMapping, livdUnmappedCode, lookupLivdForRecord, ltpAmbiguousTransport, ltpFrameRejected, ltpInitialState, ltpReduce, ltpUnexpectedEvent, messages, nonStandardDelimiters, orders, orphanComment, parseAstmDate, parseAstmRecords, parseChecksumHex, parseFramedAstm, parseReferenceRange, partialTimestamp, patient, primaryCode, profileQuirkApplied, query, readDelimiters, recognizeUniversalTestId, resolveProfileTransport, results, serializeAstmRecord, serializeAstmRecords, serializeField, serializeFramedAstm, setDefaultAstmProfile, splitEscapeAware, toChecksumHex, tokenizeHeader, tokenizeRecord, undefinedAbnormalFlag, undefinedResultStatus, uninterpretedQueryStatus, unitsAbsent, unknownEscapeSequence, unknownRecordType, unpairedEscapeCharacter, unparseableReferenceRange, unreadableRedeclaration };
 //# sourceMappingURL=index.mjs.map