@endevops/peppol-schema 0.0.1

package/src/schemas/utils/is-valid-process.ts

@@ -0,0 +1,7 @@
+import type { PeppolProcesses } from '#/schemas/values/process-schema';
+
+import { processesList } from '#/values/processes.generated';
+
+export function isValidProcess(code: string): code is PeppolProcesses {
+  return processesList.includes(code);
+}

package/src/schemas/utils/quantity-unit-code-to-intl-unit.ts

@@ -0,0 +1,111 @@
+import type { PeppolQuantityUnitCode } from '#/schemas/values/quantity-unit-codes-schema';
+
+type BaseIntlUnit =
+  | 'acre'
+  | 'bit'
+  | 'byte'
+  | 'celsius'
+  | 'centimeter'
+  | 'degree'
+  | 'fahrenheit'
+  | 'fluid-ounce'
+  | 'foot'
+  | 'gallon'
+  | 'gigabit'
+  | 'gigabyte'
+  | 'gram'
+  | 'hectare'
+  | 'inch'
+  | 'kilobit'
+  | 'kilobyte'
+  | 'kilogram'
+  | 'kilometer'
+  | 'liter'
+  | 'megabit'
+  | 'megabyte'
+  | 'meter'
+  | 'mile'
+  | 'mile-scandinavian'
+  | 'milliliter'
+  | 'millimeter'
+  | 'ounce'
+  | 'percent'
+  | 'petabyte'
+  | 'pound'
+  | 'stone'
+  | 'terabit'
+  | 'terabyte'
+  | 'yard';
+type TimeIntlUnit = 'nanosecond' | 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year';
+
+export type IntlUnit = BaseIntlUnit | TimeIntlUnit | `${BaseIntlUnit}-per-${TimeIntlUnit}`;
+
+export const quantityToIntlUnitMap = {
+  CMT: 'centimeter',
+  MTR: 'meter',
+  MMT: 'millimeter',
+  KMT: 'kilometer',
+  INH: 'inch',
+  FOT: 'foot',
+  YRD: 'yard',
+  SMI: 'mile',
+  F49: 'mile-scandinavian',
+  ACR: 'acre',
+  H18: 'hectare',
+  LTR: 'liter',
+  MLT: 'milliliter',
+  GLI: 'gallon',
+  GLL: 'gallon',
+  OZA: 'fluid-ounce',
+  GRM: 'gram',
+  KGM: 'kilogram',
+  LBR: 'pound',
+  ONZ: 'ounce',
+  STI: 'stone',
+  STN: 'stone',
+  SEC: 'second',
+  MIN: 'minute',
+  HUR: 'hour',
+  DAY: 'day',
+  WEE: 'week',
+  MON: 'month',
+  ANN: 'year',
+  B98: 'microsecond',
+  C26: 'millisecond',
+  C47: 'nanosecond',
+  CEL: 'celsius',
+  FAH: 'fahrenheit',
+  A99: 'bit',
+  AD: 'byte',
+  '2P': 'kilobyte',
+  '4L': 'megabyte',
+  E34: 'gigabyte',
+  E35: 'terabyte',
+  E36: 'petabyte',
+  B68: 'gigabit',
+  B80: 'gigabit',
+  C21: 'kilobit',
+  B10: 'bit',
+  DD: 'degree',
+  P1: 'percent',
+  KMH: 'kilometer-per-hour',
+  MTS: 'meter-per-second',
+  HM: 'mile-per-hour',
+  KNT: 'kilometer-per-hour',
+  '2X': 'meter-per-minute',
+  '40': 'milliliter-per-second',
+  '41': 'milliliter-per-minute',
+  '4G': 'milliliter',
+  '4H': 'micrometer' as IntlUnit,
+  A44: 'liter',
+  A45: 'meter',
+  A11: 'meter',
+  A12: 'kilometer',
+  B57: 'kilometer',
+  '4U': 'pound-per-hour',
+  '4M': 'gram-per-hour' as IntlUnit,
+} satisfies Partial<Record<string, IntlUnit>>;
+
+export function quantityUnitCodeToIntlUnit(code: PeppolQuantityUnitCode | (string & {})): IntlUnit | undefined {
+  return (quantityToIntlUnitMap as Record<string, IntlUnit>)[code];
+}

package/src/schemas/utils/vat-regex.ts

@@ -0,0 +1,51 @@
+import * as z from 'zod/mini';
+
+import { isValidMod97_0208 } from '#/peppol-validations/is-valid-mod97-0208';
+
+export const vatRegexSchema = z.union([
+  z.string().check(
+    z.startsWith('BE'),
+    z.length(12),
+    z.regex(/^BE[01]\d{9}$/, { error: () => 'Invalid belgian vat number' }),
+    z.superRefine((value, ctx) => {
+      const result = isValidMod97_0208(value.substring(2));
+      if (!result.success) {
+        const message = 'Invalid belgian vat number';
+
+        if (import.meta.env['DEV']) {
+          console.log(`Validation ${result.actual} != ${result.expected}`);
+          message.concat(`(Validation ${result.actual} != ${result.expected})`);
+        }
+
+        ctx.addIssue({ code: 'custom', continue: false, input: value, message });
+      }
+    })
+  ),
+  z.string().check(z.startsWith('AT'), z.regex(/^ATU\d{8}$/)),
+  z.string().check(z.startsWith('BG'), z.regex(/^BG\d{9,10}$/)),
+  z.string().check(z.startsWith('CY'), z.regex(/^CY\d{8}L$/)),
+  z.string().check(z.startsWith('CZ'), z.regex(/^CZ\d{8,10}$/)),
+  z.string().check(z.startsWith('DE'), z.regex(/^DE\d{9}$/)),
+  z.string().check(z.startsWith('DK'), z.regex(/^DK\d{8}$/)),
+  z.string().check(z.startsWith('EE'), z.regex(/^EE\d{9}$/)),
+  z.string().check(z.startsWith('EL'), z.regex(/^EL\d{9}$/)),
+  z.string().check(z.startsWith('GR'), z.regex(/^GR\d{9}$/)),
+  z.string().check(z.startsWith('ES'), z.regex(/^ES[0-9A-Z]\d{7}[0-9A-Z]$/)),
+  z.string().check(z.startsWith('FI'), z.regex(/^FI\d{8}$/)),
+  z.string().check(z.startsWith('FR'), z.regex(/^FR[0-9A-Z]{2}\d{9}$/)),
+  z.string().check(z.startsWith('GB'), z.regex(/^GB(\d{9}(\d{3})?|[A-Z]{2}\d{3})$/)),
+  z.string().check(z.startsWith('HU'), z.regex(/^HU\d{8}$/)),
+  z.string().check(z.startsWith('IE'), z.regex(/^IE\dS\d{5}L$/)),
+  z.string().check(z.startsWith('IT'), z.regex(/^IT\d{11}$/)),
+  z.string().check(z.startsWith('LT'), z.regex(/^LT(\d{9}|\d{12})$/)),
+  z.string().check(z.startsWith('LU'), z.regex(/^LU\d{8}$/)),
+  z.string().check(z.startsWith('LV'), z.regex(/^LV\d{11}$/)),
+  z.string().check(z.startsWith('MT'), z.regex(/^MT\d{8}$/)),
+  z.string().check(z.startsWith('NL'), z.regex(/^NL\d{9}B\d{2}$/)),
+  z.string().check(z.startsWith('PL'), z.regex(/^PL\d{10}$/)),
+  z.string().check(z.startsWith('PT'), z.regex(/^PT\d{9}$/)),
+  z.string().check(z.startsWith('RO'), z.regex(/^RO\d{2,10}$/)),
+  z.string().check(z.startsWith('SE'), z.regex(/^SE\d{12}$/)),
+  z.string().check(z.startsWith('SI'), z.regex(/^SI\d{8}$/)),
+  z.string().check(z.startsWith('SK'), z.regex(/^SK\d{10}$/)),
+]);

package/src/schemas/utils/xsd-time.ts

@@ -0,0 +1,9 @@
+import * as z from 'zod/mini';
+
+export const xsdTime = z
+  .string()
+  .check(
+    z.regex(/^(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d{1,9})?(?:Z|-0[1-9]|-1\d|-2[0-3]|-00:?(?:0[1-9]|[1-5]\d)|\+[01]\d|\+2[0-3])?(?:|:?[0-5]\d)$/, {
+      error: 'Invalid ISO time',
+    })
+  );

package/src/schemas/values/additional-document-reference-code.ts

@@ -0,0 +1,27 @@
+import * as z from 'zod/mini';
+
+import type { AdditionalDocumentReferenceCodesKeys } from '#/values/additional-document-reference-codes.generated';
+
+import { additionalDocumentReferenceCodesKeys } from '#/values/additional-document-reference-codes.generated';
+
+/**
+ * @description Additional document reference.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1153/
+ * @see {@link additionalDocumentReferenceCodesKeys}
+ */
+export type PeppolAdditionalDocumentReferenceCode = AdditionalDocumentReferenceCodesKeys;
+
+/**
+ * @description Validates an additional document reference code against the PEPPOL subset of UNCL 1153 (reference qualifiers).
+ *
+ * @param error - The custom error message to use when validation fails. Defaults to Zod's generic message.
+ *
+ * @returns A Zod string schema that accepts only valid additional document reference codes.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1153/
+ * @see {@link additionalDocumentReferenceCodesKeys}
+ */
+export function additionalDocumentReferenceCodeSchema(error?: string) {
+  return z.string(error).check(z.refine(val => additionalDocumentReferenceCodesKeys.includes(val), error));
+}

package/src/schemas/values/allowance-charge-reason-code.ts

@@ -0,0 +1,29 @@
+import * as z from 'zod/mini';
+
+import type { AllowanceChargeReasonCodesKeys } from '#/values/allowance-charge-reason-codes.generated';
+
+import { allowanceChargeReasonCodesKeys } from '#/values/allowance-charge-reason-codes.generated';
+
+/**
+ * @description An allowance or charge reason code as defined by the PEPPOL subset of UNCL 5189.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5189/
+ */
+export type PeppolAllowanceChargeReasonCode = AllowanceChargeReasonCodesKeys;
+
+/**
+ * @description Validates an allowance or charge reason code against the PEPPOL subset of UNCL 5189 (D.16B).
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns A Zod string schema that accepts only valid allowance/charge reason codes.
+ *
+ * @validations
+ * - PEPPOL-EN16931-CL002: Document allowance reason code MUST be according to the subset of UNCL 5189 D.16B.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5189/
+ */
+export function allowanceChargeReasonCodeSchema(error?: string) {
+  // validate against PEPPOL-EN16931-CL002: Reason code MUST be according to subset of UNCL 5189 D.16B.
+  return z.string(error).check(z.refine(val => allowanceChargeReasonCodesKeys.includes(val), error));
+}

package/src/schemas/values/application-response-type-codes.ts

@@ -0,0 +1,25 @@
+import * as z from 'zod/mini';
+
+import type { ApplicationResponseTypeCodesKeys } from '#/values/application-response-type-codes.generated';
+
+import { applicationResponseTypeCodesKeys } from '#/values/application-response-type-codes.generated';
+
+/**
+ * @description An application response type code as defined by the PEPPOL subset of UNCL 4343.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343/
+ */
+export type PeppolApplicationResponseTypeCode = ApplicationResponseTypeCodesKeys;
+
+/**
+ * @description Validates an application response type code against the PEPPOL subset of UNCL 4343.
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns A Zod string schema that accepts only valid application response type codes.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343/
+ */
+export function applicationResponseTypeCodeSchema(error?: string) {
+  return z.string(error).check(z.refine(val => applicationResponseTypeCodesKeys.includes(val as never), error));
+}

package/src/schemas/values/charge-reason-code.ts

@@ -0,0 +1,29 @@
+import * as z from 'zod/mini';
+
+import type { ChargeReasonCodesKeys } from '#/values/charge-reason-codes.generated';
+
+import { chargeReasonCodesKeys } from '#/values/charge-reason-codes.generated';
+
+/**
+ * @description A charge reason code as defined by the PEPPOL subset of UNCL 7161.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL7161/
+ */
+export type PeppolChargeReasonCode = ChargeReasonCodesKeys;
+
+/**
+ * @description Validates a charge reason code against the PEPPOL subset of UNCL 7161 (D.16B).
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns A Zod string schema that accepts only valid charge reason codes.
+ *
+ * @validations
+ * - PEPPOL-EN16931-CL003: Charge reason code MUST be according to UNCL 7161 D.16B.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL7161/
+ */
+export function chargeReasonCodeSchema(error?: string) {
+  // validate against PEPPOL-EN16931-CL003: Reason code MUST be according to UNCL 7161 D.16B.
+  return z.string(error).check(z.refine(val => chargeReasonCodesKeys.includes(val as never), error));
+}

package/src/schemas/values/country-code.ts

@@ -0,0 +1,36 @@
+/**
+ * @description ISO 3166-1 alpha-2 country codes with additional entries These codes identify countries and territories worldwide.
+ *
+ * @module schemas/values/country-code
+ *
+ * @see https://www.iso.org/iso-3166-country-codes.html
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO3166/
+ */
+
+import * as z from 'zod/mini';
+
+import type { CountryCodesKeys } from '#/values/country-code.generated';
+
+import { countryCodesKeys } from '#/values/country-code.generated';
+
+/**
+ * @description An ISO 3166-1 alpha-2 country code as defined by the PEPPOL subset.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO3166/
+ */
+export type PeppolCountryCode = CountryCodesKeys;
+
+/**
+ * @description Validates a two character ISO 3166-1 alpha-2 country code against the PEPPOL codelist.
+ *
+ * @returns A Zod string schema that accepts only valid country codes.
+ *
+ * @validations
+ * - BR-CL-14 / BR-CL-15: Country code MUST be a valid ISO 3166-1 alpha-2 code.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO3166/
+ */
+export const countryCodeSchema = z.string().check(
+  z.length(2),
+  z.refine(val => countryCodesKeys.includes(val as never))
+);

package/src/schemas/values/credit-note-type-code-schema.ts

@@ -0,0 +1,25 @@
+import * as z from 'zod/mini';
+
+import type { CreditNoteTypeCodesKeys } from '#/values/credit-notes-type-codes.generated';
+
+import { creditNoteTypeCodesKeys } from '#/values/credit-notes-type-codes.generated';
+
+/**
+ * @description A credit note type code as defined by the PEPPOL subset of UNCL 1001 (credit note).
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-cn/
+ */
+export type PeppolCreditNoteTypeCode = CreditNoteTypeCodesKeys;
+
+/**
+ * @description Validates a credit note type code against the PEPPOL subset of UNCL 1001 (credit note).
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns A Zod string schema that accepts only valid credit note type codes.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-cn/
+ */
+export function creditNoteTypeCodeSchema(error?: string) {
+  return z.string().check(z.refine(val => creditNoteTypeCodesKeys.includes(val as never), error));
+}

package/src/schemas/values/currency-codes.ts

@@ -0,0 +1,35 @@
+/**
+ * @description Currency codes as defined by ISO 4217.
+ *
+ * @see https://www.iso.org/iso-4217-currency-codes.html
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/
+ */
+
+import * as z from 'zod/mini';
+
+import type { CurrencyCodesKeys } from '#/values/currency-code.generated';
+
+import { currencyCodesKeys } from '#/values/currency-code.generated';
+
+/**
+ * @description An ISO 4217 currency code as defined by the PEPPOL subset.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/
+ */
+export type PeppolCurrencyCode = CurrencyCodesKeys;
+
+/**
+ * @description Validates an ISO 4217 currency code against the PEPPOL codelist.
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns A Zod string schema that accepts only valid currency codes.
+ *
+ * @validations
+ * - PEPPOL-EN16931-CL007: Currency codes MUST be valid ISO 4217 codes.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/
+ */
+export function currencyCodeSchema(error?: string) {
+  return z.string().check(z.refine(val => currencyCodesKeys.includes(val as never), error));
+}

package/src/schemas/values/document-type-codes.ts

@@ -0,0 +1,25 @@
+import * as z from 'zod/mini';
+
+import type { DocumentTypeCodesKeys } from '#/values/document-type-codes.generated';
+
+import { documentTypeCodesKeys } from '#/values/document-type-codes.generated';
+
+/**
+ * @description A document type code as defined by the PEPPOL subset of UNCL 1001 (document/message name code).
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001/
+ */
+export type PeppolDocumentTypeCode = DocumentTypeCodesKeys;
+
+/**
+ * @description Validates a document type code against the PEPPOL subset of UNCL 1001.
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns A Zod string schema that accepts only valid document type codes.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001/
+ */
+export function documentTypeCodeSchema(error?: string) {
+  return z.string().check(z.refine(val => documentTypeCodesKeys.includes(val as never), error));
+}

package/src/schemas/values/document-type-schema.ts

@@ -0,0 +1,49 @@
+import { objectEntries } from 'ts-extras';
+import * as z from 'zod/mini';
+
+import type { DocumentTypesTableKeys } from '#/values/document-type.generated';
+
+import { documentTypesTable, documentTypesTableKeys } from '#/values/document-type.generated';
+
+/**
+ * @description One of the PEPPOL document type schemes (e.g. `busdox-docid-qns`, `peppol-doctype-wildcard`).
+ *
+ * @see {@link documentTypesTable}
+ */
+export type PeppolDocumentType = `${DocumentTypesTableKeys}::${string}`;
+
+const entries = /* @__PURE__ */ objectEntries(documentTypesTable);
+
+/**
+ * @description Validates a full PEPPOL document type identifier (`<scheme>::<root>::…`) against the known document type table.
+ *
+ * @param error - The custom error message to use when validation fails. Defaults to `'invalid peppol document type'`.
+ *
+ * @returns A Zod template-literal schema that matches a valid `scheme::value` document type identifier.
+ *
+ * @see {@link documentTypesTable}
+ */
+export function documentTypeSchema(error = 'invalid peppol document type') {
+  return z
+    .templateLiteral(
+      [
+        // NOTE: segment matching is structural, so the scheme prefix is narrowed
+        // to the known keys while the full identifier is still checked against
+        // the document type table by the `.check` below.
+        z.enum(documentTypesTableKeys),
+        z.literal('::'),
+        z.string(),
+      ],
+      error
+    )
+    .check(
+      z.refine(
+        val => {
+          const [prefix, ...suffix] = val.split('::') as [string, string, string, string];
+          const [, info] = entries.find(([code]) => code === prefix) ?? [];
+          return info?.some(v => v === suffix.join('::'));
+        },
+        { error }
+      )
+    );
+}

package/src/schemas/values/document-type-schemes-schema.ts

@@ -0,0 +1,16 @@
+import * as z from 'zod/mini';
+
+import { documentTypesScheme } from '#/values/document-type.generated';
+
+/**
+ * @description Validates a PEPPOL document type scheme (e.g. `busdox-docid-qns`, `peppol-doctype-wildcard`).
+ *
+ * @param error - The error message to use when validation fails. Defaults to `'invalid Peppol document type scheme'`.
+ *
+ * @returns A Zod string schema that accepts only valid document type schemes.
+ *
+ * @see {@link documentTypesScheme}
+ */
+export function documentTypeSchemesSchema(error = 'invalid Peppol document type scheme') {
+  return z.string(error).check(z.refine(val => documentTypesScheme.includes(val as never), error));
+}

package/src/schemas/values/document-type-values-schema.ts

@@ -0,0 +1,19 @@
+import { objectEntries } from 'ts-extras';
+import * as z from 'zod/mini';
+
+import { documentTypesTable } from '#/values/document-type.generated';
+
+const entries = /* @__PURE__ */ objectEntries(documentTypesTable);
+
+/**
+ * @description Validates the value part of a PEPPOL document type identifier (the portion after the scheme prefix) against the known document type table.
+ *
+ * @param error - The error message to use when validation fails. Defaults to `'invalid Peppol document type value'`.
+ *
+ * @returns A Zod string schema that accepts only valid document type values.
+ *
+ * @see {@link documentTypesTable}
+ */
+export function documentTypeValuesSchema(error = 'invalid Peppol document type value') {
+  return z.string(error).check(z.refine(val => entries.flatMap(([, value]) => value).includes(val as never)));
+}

package/src/schemas/values/duty-tax-fee-cateogries.ts

@@ -0,0 +1,28 @@
+import * as z from 'zod/mini';
+
+import type { DutyTaxFeeCategoriesKeys } from '#/values/duty-tax-fee-categories.generated';
+
+import { dutyTaxFeeCategoriesKeys } from '#/values/duty-tax-fee-categories.generated';
+
+/**
+ * @description A duty, tax or fee category code as defined by the PEPPOL subset of UNCL 5305 (VAT category code).
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5305/
+ */
+export type PeppolDutyTaxFeeCategoryCode = DutyTaxFeeCategoriesKeys;
+
+/**
+ * @description Validates a duty, tax or fee category code against the PEPPOL subset of UNCL 5305 (VAT category code).
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns A Zod string schema that accepts only valid duty/tax/fee category codes.
+ *
+ * @validations
+ * - BR-CL-17 / BR-CL-18: VAT category code MUST be a valid UNCL 5305 code.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5305/
+ */
+export function dutyTaxFeeCategorySchema(error?: string) {
+  return z.string().check(z.refine(val => dutyTaxFeeCategoriesKeys.includes(val as never), error));
+}

package/src/schemas/values/eas-codes.ts

@@ -0,0 +1,35 @@
+/**
+ * @module schemas/values/eas-codes
+ * Electronic Address Scheme (EAS) codes as used in PEPPOL networks
+ * These codes identify the scheme used for electronic addresses of parties
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/eas/
+ */
+import * as z from 'zod/mini';
+
+import type { ElectronicAddressCodesKeys } from '#/values/eas-codes.generated';
+
+import { electronicAddressCodesKeys } from '#/values/eas-codes.generated';
+
+/**
+ * @description An electronic address scheme (EAS) code, identifying the scheme of an electronic address (e.g. `0088` for GLN).
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/eas/
+ */
+export type PeppolElectronicAddressCode = ElectronicAddressCodesKeys;
+
+/**
+ * @description Validates an electronic address scheme (EAS) code against the PEPPOL Electronic Address Identifier Scheme codelist.
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns A Zod string schema that accepts only valid electronic address scheme codes.
+ *
+ * @validations
+ * - PEPPOL-EN16931-CL008: Electronic address identifier scheme MUST be from the codelist "Electronic Address Identifier Scheme".
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/eas/
+ */
+export function electronicCodesSchema(error?: string) {
+  return z.string().check(z.refine(val => electronicAddressCodesKeys.includes(val as never), error));
+}

package/src/schemas/values/icd-codes.ts

@@ -0,0 +1,28 @@
+import * as z from 'zod/mini';
+
+import type { IcdCodesKeys } from '#/values/icd-codes.generated';
+
+import { icdCodesKeys } from '#/values/icd-codes.generated';
+
+/**
+ * @description An ISO 6523 ICD (International Code Designator) code identifying an identifier scheme.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ICD/
+ */
+export type PeppolIcdCode = IcdCodesKeys;
+
+/**
+ * @description Validates an ISO 6523 ICD code against the PEPPOL codelist.
+ *
+ * @param error - The custom error message to use when validation fails. Defaults to `'Invalid ICD code provided'`.
+ *
+ * @returns A Zod string schema that accepts only valid ICD codes.
+ *
+ * @validations
+ * - BR-CL-10 / BR-CL-11 / BR-CL-21: Identifier scheme MUST be a valid ISO 6523 ICD code.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ICD/
+ */
+export function icdCodesSchema(error = 'Invalid ICD code provided') {
+  return z.string(error).check(z.refine(val => icdCodesKeys.includes(val as never), error));
+}

package/src/schemas/values/invoice-status-codes.ts

@@ -0,0 +1,25 @@
+import * as z from 'zod/mini';
+
+import type { InvoiceStatusCodesKeys } from '#/values/invoice-status-codes.generated';
+
+import { invoiceStatusCodesKeys } from '#/values/invoice-status-codes.generated';
+
+/**
+ * @description An invoice status code as defined by the PEPPOL subset of UNCL 4343 (T111).
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343-T111/
+ */
+export type PeppolInvoiceStatusCodes = InvoiceStatusCodesKeys;
+
+/**
+ * @description Validates an invoice status code against the PEPPOL subset of UNCL 4343 (T111).
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns A Zod string schema that accepts only valid invoice status codes.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343-T111/
+ */
+export function invoiceStatusCodeSchema(error?: string) {
+  return z.string(error).check(z.refine(val => invoiceStatusCodesKeys.includes(val as never), error));
+}

package/src/schemas/values/invoice-type-code-schema.ts

@@ -0,0 +1,25 @@
+import * as z from 'zod/mini';
+
+import type { InvoiceTypeCodesKeys } from '#/values/invoice-type-codes.generated';
+
+import { invoiceTypeCodesKeys } from '#/values/invoice-type-codes.generated';
+
+/**
+ * @description An invoice type code as defined by the PEPPOL subset of UNCL 1001 (invoice).
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-inv/
+ */
+export type PeppolInvoiceTypeCode = InvoiceTypeCodesKeys;
+
+/**
+ * @description Validates an invoice type code against the PEPPOL subset of UNCL 1001 (invoice).
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns A Zod string schema that accepts only valid invoice type codes.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-inv/
+ */
+export function invoiceTypeCodeSchema(error?: string) {
+  return z.string(error).check(z.refine(val => invoiceTypeCodesKeys.includes(val as never), error));
+}