@northguild/gmt 1.18.0 → 1.20.0

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] };
+}

package/dist/intermodal/validate/index.d.ts

@@ -0,0 +1,18 @@
+export * from "./isValidEdifactDate.js";
+export * from "./isValidEdifactDatePeriod.js";
+export * from "./isValidEdifactDateTime.js";
+export * from "./isValidEdifactDateTimePeriod.js";
+export * from "./isValidEdifactDtmFormat.js";
+export * from "./isValidEdifactOffsetDateTime.js";
+export * from "./isValidEdifactTime.js";
+export * from "./isValidEpcisEvent.js";
+export * from "./isValidEpcisEventTime.js";
+export * from "./isValidEpcisTimeZoneOffset.js";
+export * from "./isValidX12Date.js";
+export * from "./isValidX12DateAndTime.js";
+export * from "./isValidX12DateRange.js";
+export * from "./isValidX12DateTime.js";
+export * from "./isValidX12DateTimePeriodFormat.js";
+export * from "./isValidX12DateTimeRange.js";
+export * from "./isValidX12Time.js";
+export * from "./isValidX12TimeCode.js";

package/dist/intermodal/validate/index.js

@@ -0,0 +1,18 @@
+export * from "./isValidEdifactDate.js";
+export * from "./isValidEdifactDatePeriod.js";
+export * from "./isValidEdifactDateTime.js";
+export * from "./isValidEdifactDateTimePeriod.js";
+export * from "./isValidEdifactDtmFormat.js";
+export * from "./isValidEdifactOffsetDateTime.js";
+export * from "./isValidEdifactTime.js";
+export * from "./isValidEpcisEvent.js";
+export * from "./isValidEpcisEventTime.js";
+export * from "./isValidEpcisTimeZoneOffset.js";
+export * from "./isValidX12Date.js";
+export * from "./isValidX12DateAndTime.js";
+export * from "./isValidX12DateRange.js";
+export * from "./isValidX12DateTime.js";
+export * from "./isValidX12DateTimePeriodFormat.js";
+export * from "./isValidX12DateTimeRange.js";
+export * from "./isValidX12Time.js";
+export * from "./isValidX12TimeCode.js";

package/dist/intermodal/validate/isValidEdifactDate.d.ts

@@ -0,0 +1,26 @@
+import type { EdifactDateFormat } from "../../types/edi.js";
+/**
+ * Return true when `value` is a UN/EDIFACT `DTM` value (data element 2380) that states a real
+ * calendar date in a date format code (data element 2379).
+ *
+ * ### Format code
+ * | Code | Mask | The directory's description |
+ * |---|---|---|
+ * | `102` | `CCYYMMDD` | "Calendar date: C = Century ; Y = Year ; M = Month ; D = Day." |
+ *
+ * - True exactly when `parseEdifactDate` returns a date for the same arguments: the validator
+ *   calls the parser, so the two cannot disagree.
+ * - Checks the calendar as well as the shape: 31 June and 29 February 2023 are false.
+ * - False for any other code, a code of another kind included; check a code alone with
+ *   `isValidEdifactDtmFormat`. False for a non-string argument.
+ *
+ * @param value The data element 2380 value (e.g. "20240615")
+ * @param format The data element 2379 format code
+ * @returns boolean indicating validity
+ *
+ * @example isValidEdifactDate("20240615", "102") // true
+ * @example isValidEdifactDate("20230229", "102") // false (2023 has no 29 February)
+ * @example isValidEdifactDate("240615", "102") // false (a two-digit year is not read)
+ * @example isValidEdifactDate("202406151430", "203") // false (a date-time code)
+ */
+export declare function isValidEdifactDate(value: string, format: EdifactDateFormat): boolean;

package/dist/intermodal/validate/isValidEdifactDate.js

@@ -0,0 +1,28 @@
+import { parseEdifactDate } from "../parse/parseEdifactDate.js";
+/**
+ * Return true when `value` is a UN/EDIFACT `DTM` value (data element 2380) that states a real
+ * calendar date in a date format code (data element 2379).
+ *
+ * ### Format code
+ * | Code | Mask | The directory's description |
+ * |---|---|---|
+ * | `102` | `CCYYMMDD` | "Calendar date: C = Century ; Y = Year ; M = Month ; D = Day." |
+ *
+ * - True exactly when `parseEdifactDate` returns a date for the same arguments: the validator
+ *   calls the parser, so the two cannot disagree.
+ * - Checks the calendar as well as the shape: 31 June and 29 February 2023 are false.
+ * - False for any other code, a code of another kind included; check a code alone with
+ *   `isValidEdifactDtmFormat`. False for a non-string argument.
+ *
+ * @param value The data element 2380 value (e.g. "20240615")
+ * @param format The data element 2379 format code
+ * @returns boolean indicating validity
+ *
+ * @example isValidEdifactDate("20240615", "102") // true
+ * @example isValidEdifactDate("20230229", "102") // false (2023 has no 29 February)
+ * @example isValidEdifactDate("240615", "102") // false (a two-digit year is not read)
+ * @example isValidEdifactDate("202406151430", "203") // false (a date-time code)
+ */
+export function isValidEdifactDate(value, format) {
+    return parseEdifactDate(value, format) !== "";
+}

package/dist/intermodal/validate/isValidEdifactDatePeriod.d.ts

@@ -0,0 +1,28 @@
+import type { EdifactDatePeriodFormat } from "../../types/edi.js";
+/**
+ * Return true when `value` is a UN/EDIFACT `DTM` value (data element 2380) that states a period
+ * between two real calendar dates, in a date period format code (data element 2379).
+ *
+ * ### Format code
+ * | Code | Mask | The directory's description |
+ * |---|---|---|
+ * | `718` | `CCYYMMDD-CCYYMMDD` | "A period of time specified by giving the start date followed by the end date (both including century). Data is to be transmitted as consecutive characters without hyphen." |
+ *
+ * - True exactly when `parseEdifactDatePeriod` returns a period for the same arguments: the
+ *   validator calls the parser, so the two cannot disagree.
+ * - A period is valid in its wire form only, with no hyphen: `"20240615-20240620"` is false.
+ * - A period whose end precedes its start is false; an end equal to its start is true.
+ * - Checks the calendar as well as the shape: 29 February 2023 in either date is false.
+ * - False for any other code, a code of another kind included; check a code alone with
+ *   `isValidEdifactDtmFormat`. False for a non-string argument.
+ *
+ * @param value The data element 2380 value (e.g. "2024061520240620")
+ * @param format The data element 2379 format code
+ * @returns boolean indicating validity
+ *
+ * @example isValidEdifactDatePeriod("2024061520240620", "718") // true
+ * @example isValidEdifactDatePeriod("20240615-20240620", "718") // false (a period is transmitted without a hyphen)
+ * @example isValidEdifactDatePeriod("2024062020240615", "718") // false (the end precedes the start)
+ * @example isValidEdifactDatePeriod("20240615", "718") // false (one date)
+ */
+export declare function isValidEdifactDatePeriod(value: string, format: EdifactDatePeriodFormat): boolean;

package/dist/intermodal/validate/isValidEdifactDatePeriod.js

@@ -0,0 +1,30 @@
+import { parseEdifactDatePeriod } from "../parse/parseEdifactDatePeriod.js";
+/**
+ * Return true when `value` is a UN/EDIFACT `DTM` value (data element 2380) that states a period
+ * between two real calendar dates, in a date period format code (data element 2379).
+ *
+ * ### Format code
+ * | Code | Mask | The directory's description |
+ * |---|---|---|
+ * | `718` | `CCYYMMDD-CCYYMMDD` | "A period of time specified by giving the start date followed by the end date (both including century). Data is to be transmitted as consecutive characters without hyphen." |
+ *
+ * - True exactly when `parseEdifactDatePeriod` returns a period for the same arguments: the
+ *   validator calls the parser, so the two cannot disagree.
+ * - A period is valid in its wire form only, with no hyphen: `"20240615-20240620"` is false.
+ * - A period whose end precedes its start is false; an end equal to its start is true.
+ * - Checks the calendar as well as the shape: 29 February 2023 in either date is false.
+ * - False for any other code, a code of another kind included; check a code alone with
+ *   `isValidEdifactDtmFormat`. False for a non-string argument.
+ *
+ * @param value The data element 2380 value (e.g. "2024061520240620")
+ * @param format The data element 2379 format code
+ * @returns boolean indicating validity
+ *
+ * @example isValidEdifactDatePeriod("2024061520240620", "718") // true
+ * @example isValidEdifactDatePeriod("20240615-20240620", "718") // false (a period is transmitted without a hyphen)
+ * @example isValidEdifactDatePeriod("2024062020240615", "718") // false (the end precedes the start)
+ * @example isValidEdifactDatePeriod("20240615", "718") // false (one date)
+ */
+export function isValidEdifactDatePeriod(value, format) {
+    return parseEdifactDatePeriod(value, format) !== null;
+}

package/dist/intermodal/validate/isValidEdifactDateTime.d.ts

@@ -0,0 +1,30 @@
+import type { EdifactDateTimeFormat } from "../../types/edi.js";
+/**
+ * Return true when `value` is a UN/EDIFACT `DTM` value (data element 2380) that states a real
+ * date and time in a format code with no offset (data element 2379).
+ *
+ * ### Format codes
+ * | Code | Mask | The directory's description |
+ * |---|---|---|
+ * | `203` | `CCYYMMDDHHMM` | "Calendar date including time with minutes" |
+ * | `204` | `CCYYMMDDHHMMSS` | "Calendar date including time with seconds" |
+ *
+ * - True exactly when `parseEdifactDateTime` returns a date-time for the same arguments: the
+ *   validator calls the parser, so the two cannot disagree.
+ * - A value is valid only against its code: `"202406151430"` is a `203` value and not a `204`
+ *   one.
+ * - Checks the calendar as well as the shape: 31 June, 29 February 2023, hour 24 and second 60
+ *   are false.
+ * - False for any other code, a code of another kind included; check a code alone with
+ *   `isValidEdifactDtmFormat`. False for a non-string argument.
+ *
+ * @param value The data element 2380 value (e.g. "202406151430")
+ * @param format The data element 2379 format code
+ * @returns boolean indicating validity
+ *
+ * @example isValidEdifactDateTime("202406151430", "203") // true
+ * @example isValidEdifactDateTime("20240615143045", "204") // true
+ * @example isValidEdifactDateTime("202406151430", "204") // false (twelve digits is a 203 value)
+ * @example isValidEdifactDateTime("202302291430", "203") // false (2023 has no 29 February)
+ */
+export declare function isValidEdifactDateTime(value: string, format: EdifactDateTimeFormat): boolean;

package/dist/intermodal/validate/isValidEdifactDateTime.js

@@ -0,0 +1,32 @@
+import { parseEdifactDateTime } from "../parse/parseEdifactDateTime.js";
+/**
+ * Return true when `value` is a UN/EDIFACT `DTM` value (data element 2380) that states a real
+ * date and time in a format code with no offset (data element 2379).
+ *
+ * ### Format codes
+ * | Code | Mask | The directory's description |
+ * |---|---|---|
+ * | `203` | `CCYYMMDDHHMM` | "Calendar date including time with minutes" |
+ * | `204` | `CCYYMMDDHHMMSS` | "Calendar date including time with seconds" |
+ *
+ * - True exactly when `parseEdifactDateTime` returns a date-time for the same arguments: the
+ *   validator calls the parser, so the two cannot disagree.
+ * - A value is valid only against its code: `"202406151430"` is a `203` value and not a `204`
+ *   one.
+ * - Checks the calendar as well as the shape: 31 June, 29 February 2023, hour 24 and second 60
+ *   are false.
+ * - False for any other code, a code of another kind included; check a code alone with
+ *   `isValidEdifactDtmFormat`. False for a non-string argument.
+ *
+ * @param value The data element 2380 value (e.g. "202406151430")
+ * @param format The data element 2379 format code
+ * @returns boolean indicating validity
+ *
+ * @example isValidEdifactDateTime("202406151430", "203") // true
+ * @example isValidEdifactDateTime("20240615143045", "204") // true
+ * @example isValidEdifactDateTime("202406151430", "204") // false (twelve digits is a 203 value)
+ * @example isValidEdifactDateTime("202302291430", "203") // false (2023 has no 29 February)
+ */
+export function isValidEdifactDateTime(value, format) {
+    return parseEdifactDateTime(value, format) !== "";
+}

package/dist/intermodal/validate/isValidEdifactDateTimePeriod.d.ts

@@ -0,0 +1,28 @@
+import type { EdifactDateTimePeriodFormat } from "../../types/edi.js";
+/**
+ * Return true when `value` is a UN/EDIFACT `DTM` value (data element 2380) that states a period
+ * between two real local date-times, in a date-time period format code (data element 2379).
+ *
+ * ### Format code
+ * | Code | Mask | The directory's description |
+ * |---|---|---|
+ * | `719` | `CCYYMMDDHHMM-CCYYMMDDHHMM` | "A period of time which includes the century, year, month, day, hour and minute. Format of period to be given in actual message without hyphen." |
+ *
+ * - True exactly when `parseEdifactDateTimePeriod` returns a period for the same arguments: the
+ *   validator calls the parser, so the two cannot disagree.
+ * - A period is valid in its wire form only, with no hyphen.
+ * - A period whose end precedes its start is false; an end equal to its start is true.
+ * - Checks the calendar as well as the shape: hour 24 and 29 February 2023 are false.
+ * - False for any other code, a code of another kind included; check a code alone with
+ *   `isValidEdifactDtmFormat`. False for a non-string argument.
+ *
+ * @param value The data element 2380 value (e.g. "202406151430202406201600")
+ * @param format The data element 2379 format code
+ * @returns boolean indicating validity
+ *
+ * @example isValidEdifactDateTimePeriod("202406151430202406201600", "719") // true
+ * @example isValidEdifactDateTimePeriod("202406151430-202406201600", "719") // false (a period is transmitted without a hyphen)
+ * @example isValidEdifactDateTimePeriod("202406151431202406151430", "719") // false (the end precedes the start)
+ * @example isValidEdifactDateTimePeriod("202406151430", "719") // false (one date-time)
+ */
+export declare function isValidEdifactDateTimePeriod(value: string, format: EdifactDateTimePeriodFormat): boolean;

package/dist/intermodal/validate/isValidEdifactDateTimePeriod.js

@@ -0,0 +1,30 @@
+import { parseEdifactDateTimePeriod } from "../parse/parseEdifactDateTimePeriod.js";
+/**
+ * Return true when `value` is a UN/EDIFACT `DTM` value (data element 2380) that states a period
+ * between two real local date-times, in a date-time period format code (data element 2379).
+ *
+ * ### Format code
+ * | Code | Mask | The directory's description |
+ * |---|---|---|
+ * | `719` | `CCYYMMDDHHMM-CCYYMMDDHHMM` | "A period of time which includes the century, year, month, day, hour and minute. Format of period to be given in actual message without hyphen." |
+ *
+ * - True exactly when `parseEdifactDateTimePeriod` returns a period for the same arguments: the
+ *   validator calls the parser, so the two cannot disagree.
+ * - A period is valid in its wire form only, with no hyphen.
+ * - A period whose end precedes its start is false; an end equal to its start is true.
+ * - Checks the calendar as well as the shape: hour 24 and 29 February 2023 are false.
+ * - False for any other code, a code of another kind included; check a code alone with
+ *   `isValidEdifactDtmFormat`. False for a non-string argument.
+ *
+ * @param value The data element 2380 value (e.g. "202406151430202406201600")
+ * @param format The data element 2379 format code
+ * @returns boolean indicating validity
+ *
+ * @example isValidEdifactDateTimePeriod("202406151430202406201600", "719") // true
+ * @example isValidEdifactDateTimePeriod("202406151430-202406201600", "719") // false (a period is transmitted without a hyphen)
+ * @example isValidEdifactDateTimePeriod("202406151431202406151430", "719") // false (the end precedes the start)
+ * @example isValidEdifactDateTimePeriod("202406151430", "719") // false (one date-time)
+ */
+export function isValidEdifactDateTimePeriod(value, format) {
+    return parseEdifactDateTimePeriod(value, format) !== null;
+}