@northguild/gmt 1.17.0 → 1.19.0

package/dist/intermodal/parse/parseX12DateTime.js

@@ -0,0 +1,53 @@
+import { readEdiValue } from "../../internal/ediDateTimeFields.js";
+/**
+ * Parse an X12 Date Time Period value that states a date and a time, as an ISO 8601 local
+ * date-time.
+ *
+ * A `DTP` segment carries a format qualifier in `DTP-02` (data element **1250**) and its value
+ * in `DTP-03` (data element **1251**); `DTM-05` and `DTM-06` carry the same pair. This function
+ * reads the codes whose value is one date-time. Codes are release 005010, read from
+ * [Stedi's X12-licensed dictionary](https://www.stedi.com/edi/x12-005010/element/1250); the X12
+ * text itself was not reached.
+ *
+ * ### Format codes
+ * | Code | Mask | The dictionary's definition |
+ * |---|---|---|
+ * | `DT` | `CCYYMMDDHHMM` | "Date and Time Expressed in Format CCYYMMDDHHMM" |
+ * | `RTS` | `CCYYMMDDHHMMSS` | "Date and Time Expressed in Format CCYYMMDDHHMMSS" |
+ *
+ * - **The result is local, never UTC.** No 1250 code carries an offset, so the result has no
+ *   `Z` and no offset. Pass it and the place's IANA zone to `resolveLocal` to get the instant.
+ * - `RTS` is one date-time, despite the `R` that marks a range in other codes.
+ * - The value must be the digits of its code's mask: `"202406151430"` is a `DT` value and not
+ *   an `RTS` one.
+ * - Seconds are always written in the result, `00` for `DT`.
+ * - Fields are checked, not clamped: hour 24, second 60, 31 June and 29 February 2023 return
+ *   `""`.
+ * - **A freight segment sends the date and the time as two elements** (373 and 337 in `AT7`,
+ *   `G62` and `DTM-02`/`03`), not as one 1250 value: read those with `parseX12DateAndTime`.
+ * - A two-digit year (`TR`, `DDMMYYHHMM`) is not read: X12 does not say which century it
+ *   belongs to. Read one with
+ *   `parseDateTimeWithPattern("1506241430", "ddMMyyHHmm", undefined, { yearWindow: 2000 })`.
+ * - Returns `""` for any other code, a code of another kind included (`D8` is read by
+ *   `parseX12Date`), and for a non-string argument.
+ *
+ * @param value The data element 1251 value (e.g. "202406151430")
+ * @param format X12 data element 1250 format qualifier
+ * @returns the local date-time as `YYYY-MM-DDTHH:MM:SS`, or "" on invalid input
+ *
+ * @example parseX12DateTime("202406151430", "DT") // "2024-06-15T14:30:00"
+ * @example parseX12DateTime("20240615143045", "RTS") // "2024-06-15T14:30:45"
+ * @example parseX12DateTime("202406151430", "RTS") // "" (twelve digits is a DT value)
+ * @example parseX12DateTime("202302291430", "DT") // "" (2023 has no 29 February)
+ * @example parseX12DateTime("202406152430", "DT") // "" (hour 24)
+ * @example parseX12DateTime("20240615", "D8") // "" (a date code: use parseX12Date)
+ */
+export function parseX12DateTime(value, format) {
+    try {
+        return readEdiValue("x12", "dateTime", format, value);
+    }
+    catch {
+        // Never throws (Core Rule 3): a hostile argument is invalid input, not an exception.
+        return "";
+    }
+}

package/dist/intermodal/parse/parseX12DateTimeRange.d.ts

@@ -0,0 +1,46 @@
+import type { EdiDateTimePeriod, X12DateTimeRangeFormat } from "../../types/edi.js";
+/**
+ * Parse an X12 Date Time Period value that states a range between two local date-times, as its
+ * start and end.
+ *
+ * A `DTP` segment carries a format qualifier in `DTP-02` (data element **1250**) and its value
+ * in `DTP-03` (data element **1251**); `DTM-05` and `DTM-06` carry the same pair. Codes are
+ * release 005010, read from
+ * [Stedi's X12-licensed dictionary](https://www.stedi.com/edi/x12-005010/element/1250); the X12
+ * text itself was not reached.
+ *
+ * ### Format codes
+ * | Code | Mask | The dictionary's definition |
+ * |---|---|---|
+ * | `RDT` | `CCYYMMDDHHMM-CCYYMMDDHHMM` | "Range of Date and Time, Expressed in Format CCYYMMDDHHMM-CCYYMMDDHHMM" |
+ * | `DTS` | `CCYYMMDDHHMMSS-CCYYMMDDHHMMSS` | "Range of Date and Time Expressed in Format CCYYMMDDHHMMSS-CCYYMMDDHHMMSS" |
+ *
+ * - **A range is transmitted with exactly one hyphen**: `"202406151430-202406201600"` reads,
+ *   and the same digits run together return `null`.
+ * - **`start` and `end` are local date-times as transmitted**, each `YYYY-MM-DDTHH:MM:SS`, with
+ *   seconds `00` for `RDT`. No 1250 code carries an offset, so neither names an instant: pass
+ *   each and the place's IANA zone to `resolveLocal`.
+ * - X12 does not say here whether the end is inside the range. Pass the pair to the plain
+ *   interval functions as `(start, end)`, for example
+ *   `intervalLengthDateTime(range.start, range.end, "hours")`; they leave `end` outside the
+ *   interval.
+ * - `DTS` is a range, despite having no `R`.
+ * - **An end before its start returns `null`**: a reversed range names no span of time. An end
+ *   equal to its start is a valid range.
+ * - Fields are checked, not clamped: hour 24, second 60 and 29 February 2023 return `null`.
+ * - A range with a date on one side and a date-time on the other (`DDT`, `DTD`) is not read,
+ *   and neither is a range of times with no date (`RTM`).
+ * - Returns `null` for any other code, a code of another kind included (`RD8` is read by
+ *   `parseX12DateRange`), and for a non-string argument.
+ *
+ * @param value The data element 1251 value (e.g. "202406151430-202406201600")
+ * @param format X12 data element 1250 format qualifier
+ * @returns `{ start, end }`, two ISO 8601 local date-times, or null on invalid input
+ *
+ * @example parseX12DateTimeRange("202406151430-202406201600", "RDT") // { start: "2024-06-15T14:30:00", end: "2024-06-20T16:00:00" }
+ * @example parseX12DateTimeRange("20240615143045-20240620160030", "DTS") // { start: "2024-06-15T14:30:45", end: "2024-06-20T16:00:30" }
+ * @example parseX12DateTimeRange("202406151430202406201600", "RDT") // null (a range is transmitted with its hyphen)
+ * @example parseX12DateTimeRange("202406151431-202406151430", "RDT") // null (the end precedes the start)
+ * @example parseX12DateTimeRange("20240615-20240620", "RD8") // null (a date range code: use parseX12DateRange)
+ */
+export declare function parseX12DateTimeRange(value: string, format: X12DateTimeRangeFormat): EdiDateTimePeriod | null;

package/dist/intermodal/parse/parseX12DateTimeRange.js

@@ -0,0 +1,54 @@
+import { readEdiRange } from "../../internal/ediDateTimeFields.js";
+/**
+ * Parse an X12 Date Time Period value that states a range between two local date-times, as its
+ * start and end.
+ *
+ * A `DTP` segment carries a format qualifier in `DTP-02` (data element **1250**) and its value
+ * in `DTP-03` (data element **1251**); `DTM-05` and `DTM-06` carry the same pair. Codes are
+ * release 005010, read from
+ * [Stedi's X12-licensed dictionary](https://www.stedi.com/edi/x12-005010/element/1250); the X12
+ * text itself was not reached.
+ *
+ * ### Format codes
+ * | Code | Mask | The dictionary's definition |
+ * |---|---|---|
+ * | `RDT` | `CCYYMMDDHHMM-CCYYMMDDHHMM` | "Range of Date and Time, Expressed in Format CCYYMMDDHHMM-CCYYMMDDHHMM" |
+ * | `DTS` | `CCYYMMDDHHMMSS-CCYYMMDDHHMMSS` | "Range of Date and Time Expressed in Format CCYYMMDDHHMMSS-CCYYMMDDHHMMSS" |
+ *
+ * - **A range is transmitted with exactly one hyphen**: `"202406151430-202406201600"` reads,
+ *   and the same digits run together return `null`.
+ * - **`start` and `end` are local date-times as transmitted**, each `YYYY-MM-DDTHH:MM:SS`, with
+ *   seconds `00` for `RDT`. No 1250 code carries an offset, so neither names an instant: pass
+ *   each and the place's IANA zone to `resolveLocal`.
+ * - X12 does not say here whether the end is inside the range. Pass the pair to the plain
+ *   interval functions as `(start, end)`, for example
+ *   `intervalLengthDateTime(range.start, range.end, "hours")`; they leave `end` outside the
+ *   interval.
+ * - `DTS` is a range, despite having no `R`.
+ * - **An end before its start returns `null`**: a reversed range names no span of time. An end
+ *   equal to its start is a valid range.
+ * - Fields are checked, not clamped: hour 24, second 60 and 29 February 2023 return `null`.
+ * - A range with a date on one side and a date-time on the other (`DDT`, `DTD`) is not read,
+ *   and neither is a range of times with no date (`RTM`).
+ * - Returns `null` for any other code, a code of another kind included (`RD8` is read by
+ *   `parseX12DateRange`), and for a non-string argument.
+ *
+ * @param value The data element 1251 value (e.g. "202406151430-202406201600")
+ * @param format X12 data element 1250 format qualifier
+ * @returns `{ start, end }`, two ISO 8601 local date-times, or null on invalid input
+ *
+ * @example parseX12DateTimeRange("202406151430-202406201600", "RDT") // { start: "2024-06-15T14:30:00", end: "2024-06-20T16:00:00" }
+ * @example parseX12DateTimeRange("20240615143045-20240620160030", "DTS") // { start: "2024-06-15T14:30:45", end: "2024-06-20T16:00:30" }
+ * @example parseX12DateTimeRange("202406151430202406201600", "RDT") // null (a range is transmitted with its hyphen)
+ * @example parseX12DateTimeRange("202406151431-202406151430", "RDT") // null (the end precedes the start)
+ * @example parseX12DateTimeRange("20240615-20240620", "RD8") // null (a date range code: use parseX12DateRange)
+ */
+export function parseX12DateTimeRange(value, format) {
+    try {
+        return readEdiRange("x12", "dateTimeRange", format, value);
+    }
+    catch {
+        // Never throws (Core Rule 3): a hostile argument is invalid input, not an exception.
+        return null;
+    }
+}

package/dist/intermodal/parse/parseX12Time.d.ts

@@ -0,0 +1,65 @@
+import type { X12TimeFormat } from "../../types/edi.js";
+/**
+ * Parse an X12 time as an ISO 8601 time: a data element 337 value with no qualifier, or a time
+ * that arrives with a data element 1250 format qualifier.
+ *
+ * X12 sends a time two ways, and `format` says which the caller holds:
+ *
+ * - **With no qualifier**: the time element of a freight segment (`AT7-06`, `G62-04`,
+ *   `DTM-03`) is data element 337, which fixes its own four forms. Omit `format`.
+ * - **With a qualifier**: a `DTP` segment (`DTP-02` and `DTP-03`), and `DTM-05` and `DTM-06`,
+ *   send a data element 1250 format qualifier beside the value. Pass it as `format`, and the
+ *   value is read against that qualifier's mask alone.
+ *
+ * Definitions are release 005010, read from Stedi's X12-licensed dictionary
+ * ([337](https://www.stedi.com/edi/x12-005010/element/337),
+ * [1250](https://www.stedi.com/edi/x12-005010/element/1250)); the X12 text itself was not
+ * reached.
+ *
+ * ### Forms
+ * | `format` | Digits | Mask | The dictionary's definition |
+ * |---|---|---|---|
+ * | omitted | 4, 6, 7 or 8 | `HHMM`, `HHMMSS`, `HHMMSSD`, `HHMMSSDD` | Element 337: "H = hours (00-23), M = minutes (00-59), S = integer seconds (00-59) … D = tenths (0-9) and DD = hundredths (00-99)" |
+ * | `TM` | 4 | `HHMM` | "Time Expressed in Format HHMM" |
+ * | `TS` | 6 | `HHMMSS` | "Time Expressed in Format HHMMSS" |
+ *
+ * - **A qualifier is strict.** `"143045"` is a `TS` value and returns `""` under `TM`, and no
+ *   1250 code holds decimal seconds, so a 7- or 8-digit value returns `""` under either
+ *   qualifier. The same values read when `format` is omitted.
+ * - **A `format` that is present and is not `TM` or `TS` returns `""`**, never the unqualified
+ *   read: a code of another kind (`D8`), a code that is not read (`RTM`, `TT`), an empty string
+ *   and a non-string. Only an omitted or `undefined` format means "no qualifier".
+ * - Seconds are always written in the result, `00` for `HHMM`.
+ * - With no qualifier, tenths and hundredths become the fraction of the second exactly:
+ *   `1430001` is `14:30:00.1` and `14300012` is `14:30:00.12`. A zero fraction is not written
+ *   (`14300000` is `14:30:00`).
+ * - **To write the value back**, use `formatX12TimeElement` for an element 337 time and name
+ *   the form by its mask: `formatX12TimeElement("14:30:00.12", "HHMMSSDD")` is `14300012`. Use
+ *   `formatX12Time` for a time that travels with a `TM` or `TS` qualifier.
+ * - Fields are checked, not clamped: hour 24, minute 60, second 60 and a value of 5 or 9 digits
+ *   return `""`.
+ * - **The time is local to a place the value does not name.** In a freight segment the time
+ *   code beside it (data element 623) says where the clock was: classify it with
+ *   `classifyX12TimeCode`. To read the date and time elements together, use
+ *   `parseX12DateAndTime`.
+ * - A range of times (`RTM`, `HHMM-HHMM`) is not read.
+ * - Returns `""` for a non-string value.
+ *
+ * @param value The time as transmitted (e.g. "1430")
+ * @param format X12 data element 1250 format qualifier the time arrived with; omit it for a data element 337 value
+ * @returns the time as `HH:MM:SS`, with a fraction of one or two digits when a 337 value has one, or "" on invalid input
+ *
+ * @example parseX12Time("1430") // "14:30:00"
+ * @example parseX12Time("1430", "TM") // "14:30:00"
+ * @example parseX12Time("143045", "TS") // "14:30:45"
+ * @example parseX12Time("143045") // "14:30:45"
+ * @example parseX12Time("1430001") // "14:30:00.1" (a tenth of a second)
+ * @example parseX12Time("14300012") // "14:30:00.12" (hundredths of a second)
+ * @example parseX12Time("14300000") // "14:30:00" (a zero fraction is not written)
+ * @example parseX12Time("143045", "TM") // "" (six digits is a TS value)
+ * @example parseX12Time("14300012", "TS") // "" (no 1250 code holds decimal seconds)
+ * @example parseX12Time("2430") // "" (hour 24)
+ * @example parseX12Time("14304") // "" (five digits is not an element 337 form)
+ * @example parseX12Time("14:30") // "" (the value is the digits of the element)
+ */
+export declare function parseX12Time(value: string, format?: X12TimeFormat): string;

package/dist/intermodal/parse/parseX12Time.js

@@ -0,0 +1,77 @@
+import { readEdiValue, readX12Time } from "../../internal/ediDateTimeFields.js";
+/**
+ * Parse an X12 time as an ISO 8601 time: a data element 337 value with no qualifier, or a time
+ * that arrives with a data element 1250 format qualifier.
+ *
+ * X12 sends a time two ways, and `format` says which the caller holds:
+ *
+ * - **With no qualifier**: the time element of a freight segment (`AT7-06`, `G62-04`,
+ *   `DTM-03`) is data element 337, which fixes its own four forms. Omit `format`.
+ * - **With a qualifier**: a `DTP` segment (`DTP-02` and `DTP-03`), and `DTM-05` and `DTM-06`,
+ *   send a data element 1250 format qualifier beside the value. Pass it as `format`, and the
+ *   value is read against that qualifier's mask alone.
+ *
+ * Definitions are release 005010, read from Stedi's X12-licensed dictionary
+ * ([337](https://www.stedi.com/edi/x12-005010/element/337),
+ * [1250](https://www.stedi.com/edi/x12-005010/element/1250)); the X12 text itself was not
+ * reached.
+ *
+ * ### Forms
+ * | `format` | Digits | Mask | The dictionary's definition |
+ * |---|---|---|---|
+ * | omitted | 4, 6, 7 or 8 | `HHMM`, `HHMMSS`, `HHMMSSD`, `HHMMSSDD` | Element 337: "H = hours (00-23), M = minutes (00-59), S = integer seconds (00-59) … D = tenths (0-9) and DD = hundredths (00-99)" |
+ * | `TM` | 4 | `HHMM` | "Time Expressed in Format HHMM" |
+ * | `TS` | 6 | `HHMMSS` | "Time Expressed in Format HHMMSS" |
+ *
+ * - **A qualifier is strict.** `"143045"` is a `TS` value and returns `""` under `TM`, and no
+ *   1250 code holds decimal seconds, so a 7- or 8-digit value returns `""` under either
+ *   qualifier. The same values read when `format` is omitted.
+ * - **A `format` that is present and is not `TM` or `TS` returns `""`**, never the unqualified
+ *   read: a code of another kind (`D8`), a code that is not read (`RTM`, `TT`), an empty string
+ *   and a non-string. Only an omitted or `undefined` format means "no qualifier".
+ * - Seconds are always written in the result, `00` for `HHMM`.
+ * - With no qualifier, tenths and hundredths become the fraction of the second exactly:
+ *   `1430001` is `14:30:00.1` and `14300012` is `14:30:00.12`. A zero fraction is not written
+ *   (`14300000` is `14:30:00`).
+ * - **To write the value back**, use `formatX12TimeElement` for an element 337 time and name
+ *   the form by its mask: `formatX12TimeElement("14:30:00.12", "HHMMSSDD")` is `14300012`. Use
+ *   `formatX12Time` for a time that travels with a `TM` or `TS` qualifier.
+ * - Fields are checked, not clamped: hour 24, minute 60, second 60 and a value of 5 or 9 digits
+ *   return `""`.
+ * - **The time is local to a place the value does not name.** In a freight segment the time
+ *   code beside it (data element 623) says where the clock was: classify it with
+ *   `classifyX12TimeCode`. To read the date and time elements together, use
+ *   `parseX12DateAndTime`.
+ * - A range of times (`RTM`, `HHMM-HHMM`) is not read.
+ * - Returns `""` for a non-string value.
+ *
+ * @param value The time as transmitted (e.g. "1430")
+ * @param format X12 data element 1250 format qualifier the time arrived with; omit it for a data element 337 value
+ * @returns the time as `HH:MM:SS`, with a fraction of one or two digits when a 337 value has one, or "" on invalid input
+ *
+ * @example parseX12Time("1430") // "14:30:00"
+ * @example parseX12Time("1430", "TM") // "14:30:00"
+ * @example parseX12Time("143045", "TS") // "14:30:45"
+ * @example parseX12Time("143045") // "14:30:45"
+ * @example parseX12Time("1430001") // "14:30:00.1" (a tenth of a second)
+ * @example parseX12Time("14300012") // "14:30:00.12" (hundredths of a second)
+ * @example parseX12Time("14300000") // "14:30:00" (a zero fraction is not written)
+ * @example parseX12Time("143045", "TM") // "" (six digits is a TS value)
+ * @example parseX12Time("14300012", "TS") // "" (no 1250 code holds decimal seconds)
+ * @example parseX12Time("2430") // "" (hour 24)
+ * @example parseX12Time("14304") // "" (five digits is not an element 337 form)
+ * @example parseX12Time("14:30") // "" (the value is the digits of the element)
+ */
+export function parseX12Time(value, format) {
+    try {
+        // No qualifier: the element fixes its own forms. With one, the value is read against that
+        // code's mask, and a code that is not a time code is refused there.
+        return format === undefined
+            ? readX12Time(value)
+            : readEdiValue("x12", "time", format, value);
+    }
+    catch {
+        // Never throws (Core Rule 3): a hostile argument is invalid input, not an exception.
+        return "";
+    }
+}

package/dist/intermodal/parse/x12TimeCodeOffset.d.ts

@@ -0,0 +1,57 @@
+import type { X12OffsetTimeCode } from "../../types/edi.js";
+/**
+ * Read the UTC offset an X12 time code (data element 623) states.
+ *
+ * Data element 623 is the code beside the date (element 373) and time (element 337) of an X12
+ * `AT7`, `G62` or `DTM` segment, and the only thing in the segment that says where the clock
+ * was. 31 of its 56 codes state an offset; this function reads those. The element's own
+ * definition: "Code identifying the time. In accordance with International Standards
+ * Organization standard 8601, time can be specified by a + or - and an indication in hours in
+ * relation to Universal Time Coordinate (UTC) time; since + is a restricted character, + and -
+ * are substituted by P and M in the codes that follow". Codes are release 008010, read from
+ * [Stedi's X12-licensed dictionary](https://www.stedi.com/edi/x12-008010/element/623); the X12
+ * text itself was not reached.
+ *
+ * ### Time codes that state an offset
+ * | Codes | The dictionary's definition | Offset |
+ * |---|---|---|
+ * | `01`–`12` | "Equivalent to ISO P01" … "P12" | `+01:00` … `+12:00` |
+ * | `13`–`24` | "Equivalent to ISO M12" … "M01" | `-12:00` … `-01:00`, counting down |
+ * | `25`–`29` | "Equivalent to ISO M2:30", "M3:30", "P5:30", "P9:30", "P10:30" | `-02:30`, `-03:30`, `+05:30`, `+09:30`, `+10:30` |
+ * | `UT` | "Universal Time Coordinate" | `+00:00` |
+ * | `GM` | "Greenwich Mean Time" | `+00:00` |
+ *
+ * - **`13`–`24` count down**: `13` is `-12:00` and `24` is `-01:00`. The code rises as the
+ *   offset nears UTC, so `20` is `-05:00`.
+ * - **`25`–`29` were added in release 006010** and are not valid in an 004010 or 005010
+ *   interchange. The function takes no release, so it reads them.
+ * - **`GM` is `+00:00` by a GMT rule, not by X12's statement.** X12 defines it only by the name
+ *   "Greenwich Mean Time". UN/ECE Recommendation 7 ¶12 names one scale by both names,
+ *   "Co-ordinated Universal Time (formerly known as Greenwich Mean Time)", so GMT reads `GM` as
+ *   UTC.
+ * - **A named code returns `""`**: X12 states no offset for `ET`, `ES`, `PD` or `LT`, and GMT
+ *   holds no table of zone offsets. Read one with `x12TimeCodeZone`.
+ * - **To get the instant**, resolve the segment's local date-time at the offset:
+ *   `resolveLocal(parseX12DateAndTime("20240615", "1430"), x12TimeCodeOffset("20"))` is
+ *   `"2024-06-15T19:30:00Z"`.
+ * - **For a code that arrives as a string**, call `classifyX12TimeCode` first: its `"offset"`
+ *   result carries the code narrowed to this function's parameter.
+ * - Matching is exact: two characters, upper case, no padding. Returns `""` for a code that is
+ *   not one of the 56 and for a non-string. Use `isValidX12TimeCode` to check a code.
+ *
+ * @param timeCode X12 data element 623 time code (e.g. "20")
+ * @returns the offset as `±HH:MM`, or "" on invalid input
+ *
+ * @example x12TimeCodeOffset("20") // "-05:00"
+ * @example x12TimeCodeOffset("01") // "+01:00"
+ * @example x12TimeCodeOffset("12") // "+12:00"
+ * @example x12TimeCodeOffset("13") // "-12:00" (the 13–24 run counts down)
+ * @example x12TimeCodeOffset("24") // "-01:00"
+ * @example x12TimeCodeOffset("27") // "+05:30"
+ * @example x12TimeCodeOffset("UT") // "+00:00"
+ * @example x12TimeCodeOffset("GM") // "+00:00"
+ * @example x12TimeCodeOffset("ET") // "" (a zone name: X12 states no offset for it)
+ * @example x12TimeCodeOffset("30") // "" (not a 623 code)
+ * @example x12TimeCodeOffset("ut") // "" (matching is exact)
+ */
+export declare function x12TimeCodeOffset(timeCode: X12OffsetTimeCode): string;

package/dist/intermodal/parse/x12TimeCodeOffset.js

@@ -0,0 +1,110 @@
+/**
+ * X12 data element 623 code → the offset its definition states, release 008010, read from
+ * Stedi's X12-licensed dictionary (https://www.stedi.com/edi/x12-008010/element/623); the X12
+ * text was not reached. Each comment quotes the definition. The offsets are the standard's data,
+ * written out rather than computed: `P` is plus and `M` is minus, and the `13`–`24` run counts
+ * down. `25`–`29` were added in release 006010. Typed by `X12OffsetTimeCode`, so a missing code
+ * fails typecheck.
+ */
+const X12_TIME_CODE_OFFSET = {
+    // "Equivalent to ISO P01" … "P12"
+    "01": "+01:00",
+    "02": "+02:00",
+    "03": "+03:00",
+    "04": "+04:00",
+    "05": "+05:00",
+    "06": "+06:00",
+    "07": "+07:00",
+    "08": "+08:00",
+    "09": "+09:00",
+    "10": "+10:00",
+    "11": "+11:00",
+    "12": "+12:00",
+    // "Equivalent to ISO M12" … "M01": descending, so the code rises as the offset nears UTC.
+    "13": "-12:00",
+    "14": "-11:00",
+    "15": "-10:00",
+    "16": "-09:00",
+    "17": "-08:00",
+    "18": "-07:00",
+    "19": "-06:00",
+    "20": "-05:00",
+    "21": "-04:00",
+    "22": "-03:00",
+    "23": "-02:00",
+    "24": "-01:00",
+    // "Equivalent to ISO M2:30", "M3:30", "P5:30", "P9:30", "P10:30"
+    "25": "-02:30",
+    "26": "-03:30",
+    "27": "+05:30",
+    "28": "+09:30",
+    "29": "+10:30",
+    // "Greenwich Mean Time". X12 gives the name and no ISO designator, so the offset is a GMT
+    // rule: UN/ECE Recommendation 7 ¶12 names the scale "Co-ordinated Universal Time (formerly
+    // known as Greenwich Mean Time)". It is the one zone-name code that resolves to an offset.
+    GM: "+00:00",
+    // "Universal Time Coordinate": UTC itself.
+    UT: "+00:00",
+};
+/**
+ * Read the UTC offset an X12 time code (data element 623) states.
+ *
+ * Data element 623 is the code beside the date (element 373) and time (element 337) of an X12
+ * `AT7`, `G62` or `DTM` segment, and the only thing in the segment that says where the clock
+ * was. 31 of its 56 codes state an offset; this function reads those. The element's own
+ * definition: "Code identifying the time. In accordance with International Standards
+ * Organization standard 8601, time can be specified by a + or - and an indication in hours in
+ * relation to Universal Time Coordinate (UTC) time; since + is a restricted character, + and -
+ * are substituted by P and M in the codes that follow". Codes are release 008010, read from
+ * [Stedi's X12-licensed dictionary](https://www.stedi.com/edi/x12-008010/element/623); the X12
+ * text itself was not reached.
+ *
+ * ### Time codes that state an offset
+ * | Codes | The dictionary's definition | Offset |
+ * |---|---|---|
+ * | `01`–`12` | "Equivalent to ISO P01" … "P12" | `+01:00` … `+12:00` |
+ * | `13`–`24` | "Equivalent to ISO M12" … "M01" | `-12:00` … `-01:00`, counting down |
+ * | `25`–`29` | "Equivalent to ISO M2:30", "M3:30", "P5:30", "P9:30", "P10:30" | `-02:30`, `-03:30`, `+05:30`, `+09:30`, `+10:30` |
+ * | `UT` | "Universal Time Coordinate" | `+00:00` |
+ * | `GM` | "Greenwich Mean Time" | `+00:00` |
+ *
+ * - **`13`–`24` count down**: `13` is `-12:00` and `24` is `-01:00`. The code rises as the
+ *   offset nears UTC, so `20` is `-05:00`.
+ * - **`25`–`29` were added in release 006010** and are not valid in an 004010 or 005010
+ *   interchange. The function takes no release, so it reads them.
+ * - **`GM` is `+00:00` by a GMT rule, not by X12's statement.** X12 defines it only by the name
+ *   "Greenwich Mean Time". UN/ECE Recommendation 7 ¶12 names one scale by both names,
+ *   "Co-ordinated Universal Time (formerly known as Greenwich Mean Time)", so GMT reads `GM` as
+ *   UTC.
+ * - **A named code returns `""`**: X12 states no offset for `ET`, `ES`, `PD` or `LT`, and GMT
+ *   holds no table of zone offsets. Read one with `x12TimeCodeZone`.
+ * - **To get the instant**, resolve the segment's local date-time at the offset:
+ *   `resolveLocal(parseX12DateAndTime("20240615", "1430"), x12TimeCodeOffset("20"))` is
+ *   `"2024-06-15T19:30:00Z"`.
+ * - **For a code that arrives as a string**, call `classifyX12TimeCode` first: its `"offset"`
+ *   result carries the code narrowed to this function's parameter.
+ * - Matching is exact: two characters, upper case, no padding. Returns `""` for a code that is
+ *   not one of the 56 and for a non-string. Use `isValidX12TimeCode` to check a code.
+ *
+ * @param timeCode X12 data element 623 time code (e.g. "20")
+ * @returns the offset as `±HH:MM`, or "" on invalid input
+ *
+ * @example x12TimeCodeOffset("20") // "-05:00"
+ * @example x12TimeCodeOffset("01") // "+01:00"
+ * @example x12TimeCodeOffset("12") // "+12:00"
+ * @example x12TimeCodeOffset("13") // "-12:00" (the 13–24 run counts down)
+ * @example x12TimeCodeOffset("24") // "-01:00"
+ * @example x12TimeCodeOffset("27") // "+05:30"
+ * @example x12TimeCodeOffset("UT") // "+00:00"
+ * @example x12TimeCodeOffset("GM") // "+00:00"
+ * @example x12TimeCodeOffset("ET") // "" (a zone name: X12 states no offset for it)
+ * @example x12TimeCodeOffset("30") // "" (not a 623 code)
+ * @example x12TimeCodeOffset("ut") // "" (matching is exact)
+ */
+export function x12TimeCodeOffset(timeCode) {
+    if (typeof timeCode !== "string" ||
+        !Object.hasOwn(X12_TIME_CODE_OFFSET, timeCode)) {
+        return "";
+    }
+    return X12_TIME_CODE_OFFSET[timeCode];
+}

package/dist/intermodal/parse/x12TimeCodeZone.d.ts

@@ -0,0 +1,57 @@
+import type { X12NamedZone, X12ZoneTimeCode } from "../../types/edi.js";
+/**
+ * Read the zone an X12 time code (data element 623) names.
+ *
+ * Data element 623 is the code beside the date (element 373) and time (element 337) of an X12
+ * `AT7`, `G62` or `DTM` segment. 25 of its 56 codes name a zone and state no offset; this
+ * function reads those. Codes are release 008010, read from
+ * [Stedi's X12-licensed dictionary](https://www.stedi.com/edi/x12-008010/element/623); the X12
+ * text itself was not reached.
+ *
+ * ### Time codes that name a zone
+ * | Codes | The dictionary's definition | `zone` |
+ * |---|---|---|
+ * | `AD`, `AS`, `AT` | "Alaska Daylight Time", "Alaska Standard Time", "Alaska Time" | `Alaska` |
+ * | `CD`, `CS`, `CT` | "Central Daylight Time", "Central Standard Time", "Central Time" | `Central` |
+ * | `ED`, `ES`, `ET` | "Eastern Daylight Time", "Eastern Standard Time", "Eastern Time" | `Eastern` |
+ * | `HD`, `HS`, `HT` | "Hawaii-Aleutian Daylight Time", "Hawaii-Aleutian Standard Time", "Hawaii-Aleutian Time" | `Hawaii-Aleutian` |
+ * | `MD`, `MS`, `MT` | "Mountain Daylight Time", "Mountain Standard Time", "Mountain Time" | `Mountain` |
+ * | `ND`, `NS`, `NT` | "Newfoundland Daylight Time", "Newfoundland Standard Time", "Newfoundland Time" | `Newfoundland` |
+ * | `PD`, `PS`, `PT` | "Pacific Daylight Time", "Pacific Standard Time", "Pacific Time" | `Pacific` |
+ * | `TD`, `TS`, `TT` | "Atlantic Daylight Time", "Atlantic Standard Time", "Atlantic Time" | `Atlantic` |
+ * | `LT` | "Local Time" | `Local` |
+ *
+ * - **The result is a zone name, not an offset.** X12 states no offset for these codes and GMT
+ *   holds no registry of places, so the caller maps the name to an IANA zone. A caller might
+ *   choose `America/New_York` for `Eastern`; the choice is the caller's. Resolve the local
+ *   date-time in that zone with `resolveLocal`.
+ * - **`daylight` is `true` for a `D` code, `false` for an `S` code and `null` for a `T` code**,
+ *   which says neither: the date decides. Both members are always present.
+ * - **`LT` is local to the event** and returns `{ zone: "Local", daylight: null }`. The place is
+ *   elsewhere in the message, so the caller supplies its zone.
+ * - **An offset code returns `null`**: `01`–`29`, `UT` and `GM` state an offset and name no
+ *   zone. Read one with `x12TimeCodeOffset`.
+ * - **`TS`, `TT`, `CD` and `MD` are codes of data element 1250 too**, with unrelated meanings:
+ *   here they are Atlantic Standard, Atlantic, Central Daylight and Mountain Daylight Time;
+ *   there `TS` is the format `HHMMSS`. Pass a time code here and a format qualifier to the
+ *   `parseX12…` functions.
+ * - **For a code that arrives as a string**, call `classifyX12TimeCode` first: its `"zone"`
+ *   result carries the code narrowed to this function's parameter.
+ * - Matching is exact: two characters, upper case, no padding. Each call returns a new object.
+ *   Returns `null` for a code that is not one of the 56 and for a non-string.
+ *
+ * @param timeCode X12 data element 623 time code (e.g. "ES")
+ * @returns `{ zone, daylight }`, or null on invalid input
+ *
+ * @example x12TimeCodeZone("ES") // { zone: "Eastern", daylight: false }
+ * @example x12TimeCodeZone("ED") // { zone: "Eastern", daylight: true }
+ * @example x12TimeCodeZone("ET") // { zone: "Eastern", daylight: null } (the date decides)
+ * @example x12TimeCodeZone("PD") // { zone: "Pacific", daylight: true }
+ * @example x12TimeCodeZone("TS") // { zone: "Atlantic", daylight: false }
+ * @example x12TimeCodeZone("LT") // { zone: "Local", daylight: null } (the place is elsewhere in the message)
+ * @example x12TimeCodeZone("UT") // null (an offset code: use x12TimeCodeOffset)
+ * @example x12TimeCodeZone("20") // null (an offset code)
+ * @example x12TimeCodeZone("EST") // null (not a 623 code)
+ * @example x12TimeCodeZone("et") // null (matching is exact)
+ */
+export declare function x12TimeCodeZone(timeCode: X12ZoneTimeCode): X12NamedZone | null;

package/dist/intermodal/parse/x12TimeCodeZone.js

@@ -0,0 +1,105 @@
+/**
+ * X12 data element 623 code → the zone its definition names, release 008010, read from Stedi's
+ * X12-licensed dictionary (https://www.stedi.com/edi/x12-008010/element/623); the X12 text was
+ * not reached. Each comment quotes the definition. Typed by `X12ZoneTimeCode`, so a missing code
+ * fails typecheck.
+ */
+const X12_TIME_CODE_ZONE = {
+    // "Alaska Daylight Time", "Alaska Standard Time", "Alaska Time"
+    AD: { zone: "Alaska", daylight: true },
+    AS: { zone: "Alaska", daylight: false },
+    AT: { zone: "Alaska", daylight: null },
+    // "Central Daylight Time", "Central Standard Time", "Central Time"
+    CD: { zone: "Central", daylight: true },
+    CS: { zone: "Central", daylight: false },
+    CT: { zone: "Central", daylight: null },
+    // "Eastern Daylight Time", "Eastern Standard Time", "Eastern Time"
+    ED: { zone: "Eastern", daylight: true },
+    ES: { zone: "Eastern", daylight: false },
+    ET: { zone: "Eastern", daylight: null },
+    // "Hawaii-Aleutian Daylight Time", "Hawaii-Aleutian Standard Time", "Hawaii-Aleutian Time"
+    HD: { zone: "Hawaii-Aleutian", daylight: true },
+    HS: { zone: "Hawaii-Aleutian", daylight: false },
+    HT: { zone: "Hawaii-Aleutian", daylight: null },
+    // "Local Time"
+    LT: { zone: "Local", daylight: null },
+    // "Mountain Daylight Time", "Mountain Standard Time", "Mountain Time"
+    MD: { zone: "Mountain", daylight: true },
+    MS: { zone: "Mountain", daylight: false },
+    MT: { zone: "Mountain", daylight: null },
+    // "Newfoundland Daylight Time", "Newfoundland Standard Time", "Newfoundland Time"
+    ND: { zone: "Newfoundland", daylight: true },
+    NS: { zone: "Newfoundland", daylight: false },
+    NT: { zone: "Newfoundland", daylight: null },
+    // "Pacific Daylight Time", "Pacific Standard Time", "Pacific Time"
+    PD: { zone: "Pacific", daylight: true },
+    PS: { zone: "Pacific", daylight: false },
+    PT: { zone: "Pacific", daylight: null },
+    // "Atlantic Daylight Time", "Atlantic Standard Time", "Atlantic Time"
+    TD: { zone: "Atlantic", daylight: true },
+    TS: { zone: "Atlantic", daylight: false },
+    TT: { zone: "Atlantic", daylight: null },
+};
+/**
+ * Read the zone an X12 time code (data element 623) names.
+ *
+ * Data element 623 is the code beside the date (element 373) and time (element 337) of an X12
+ * `AT7`, `G62` or `DTM` segment. 25 of its 56 codes name a zone and state no offset; this
+ * function reads those. Codes are release 008010, read from
+ * [Stedi's X12-licensed dictionary](https://www.stedi.com/edi/x12-008010/element/623); the X12
+ * text itself was not reached.
+ *
+ * ### Time codes that name a zone
+ * | Codes | The dictionary's definition | `zone` |
+ * |---|---|---|
+ * | `AD`, `AS`, `AT` | "Alaska Daylight Time", "Alaska Standard Time", "Alaska Time" | `Alaska` |
+ * | `CD`, `CS`, `CT` | "Central Daylight Time", "Central Standard Time", "Central Time" | `Central` |
+ * | `ED`, `ES`, `ET` | "Eastern Daylight Time", "Eastern Standard Time", "Eastern Time" | `Eastern` |
+ * | `HD`, `HS`, `HT` | "Hawaii-Aleutian Daylight Time", "Hawaii-Aleutian Standard Time", "Hawaii-Aleutian Time" | `Hawaii-Aleutian` |
+ * | `MD`, `MS`, `MT` | "Mountain Daylight Time", "Mountain Standard Time", "Mountain Time" | `Mountain` |
+ * | `ND`, `NS`, `NT` | "Newfoundland Daylight Time", "Newfoundland Standard Time", "Newfoundland Time" | `Newfoundland` |
+ * | `PD`, `PS`, `PT` | "Pacific Daylight Time", "Pacific Standard Time", "Pacific Time" | `Pacific` |
+ * | `TD`, `TS`, `TT` | "Atlantic Daylight Time", "Atlantic Standard Time", "Atlantic Time" | `Atlantic` |
+ * | `LT` | "Local Time" | `Local` |
+ *
+ * - **The result is a zone name, not an offset.** X12 states no offset for these codes and GMT
+ *   holds no registry of places, so the caller maps the name to an IANA zone. A caller might
+ *   choose `America/New_York` for `Eastern`; the choice is the caller's. Resolve the local
+ *   date-time in that zone with `resolveLocal`.
+ * - **`daylight` is `true` for a `D` code, `false` for an `S` code and `null` for a `T` code**,
+ *   which says neither: the date decides. Both members are always present.
+ * - **`LT` is local to the event** and returns `{ zone: "Local", daylight: null }`. The place is
+ *   elsewhere in the message, so the caller supplies its zone.
+ * - **An offset code returns `null`**: `01`–`29`, `UT` and `GM` state an offset and name no
+ *   zone. Read one with `x12TimeCodeOffset`.
+ * - **`TS`, `TT`, `CD` and `MD` are codes of data element 1250 too**, with unrelated meanings:
+ *   here they are Atlantic Standard, Atlantic, Central Daylight and Mountain Daylight Time;
+ *   there `TS` is the format `HHMMSS`. Pass a time code here and a format qualifier to the
+ *   `parseX12…` functions.
+ * - **For a code that arrives as a string**, call `classifyX12TimeCode` first: its `"zone"`
+ *   result carries the code narrowed to this function's parameter.
+ * - Matching is exact: two characters, upper case, no padding. Each call returns a new object.
+ *   Returns `null` for a code that is not one of the 56 and for a non-string.
+ *
+ * @param timeCode X12 data element 623 time code (e.g. "ES")
+ * @returns `{ zone, daylight }`, or null on invalid input
+ *
+ * @example x12TimeCodeZone("ES") // { zone: "Eastern", daylight: false }
+ * @example x12TimeCodeZone("ED") // { zone: "Eastern", daylight: true }
+ * @example x12TimeCodeZone("ET") // { zone: "Eastern", daylight: null } (the date decides)
+ * @example x12TimeCodeZone("PD") // { zone: "Pacific", daylight: true }
+ * @example x12TimeCodeZone("TS") // { zone: "Atlantic", daylight: false }
+ * @example x12TimeCodeZone("LT") // { zone: "Local", daylight: null } (the place is elsewhere in the message)
+ * @example x12TimeCodeZone("UT") // null (an offset code: use x12TimeCodeOffset)
+ * @example x12TimeCodeZone("20") // null (an offset code)
+ * @example x12TimeCodeZone("EST") // null (not a 623 code)
+ * @example x12TimeCodeZone("et") // null (matching is exact)
+ */
+export function x12TimeCodeZone(timeCode) {
+    if (typeof timeCode !== "string" ||
+        !Object.hasOwn(X12_TIME_CODE_ZONE, timeCode)) {
+        return null;
+    }
+    // A copy, so a caller cannot change the table through a result.
+    return { ...X12_TIME_CODE_ZONE[timeCode] };
+}