@endevops/peppol-schema 0.0.1 → 0.1.0-beta.2

package/src/effect/utils/is-valid-invoice-type-code.ts

@@ -0,0 +1 @@
+export { isValidInvoiceTypeCode } from '#/schemas/utils/is-valid-invoice-type-code';

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

@@ -0,0 +1 @@
+export { isValidProcess } from '#/schemas/utils/is-valid-process';

package/src/effect/utils/peppol-base-64-schema.ts

@@ -0,0 +1,33 @@
+import { Schema } from 'effect';
+
+// RFC 4648 §4 — Base 64 Encoding
+//
+// Alphabet: A-Z a-z 0-9 + /  (pad: =)
+// Encoding quanta: 4 characters represent 3 bytes.
+// Padding rules (only at the very end):
+//   • 0 pad chars  → last quantum is xxxx  (input length % 3 === 0)
+//   • 1 pad char   → last quantum is xxx=  (input length % 3 === 2)
+//   • 2 pad chars  → last quantum is xx==  (input length % 3 === 1)
+//
+// §3.1: CRLF / LF line endings are treated as non-alphabet characters
+//        and stripped before validation (as in PEM / MIME / XML).
+// §3.3: Implementations MUST reject data with non-alphabet characters
+//        (other than the allowed line endings stripped above).
+//
+// The regex below encodes all three quantum variants in a single pass:
+//   ([A-Za-z0-9+/]{4})*   — zero or more full quanta (no padding)
+//   followed by one of:
+//     [A-Za-z0-9+/]{2}==  — 2-pad quantum  (1 remaining input byte)
+//     [A-Za-z0-9+/]{3}=   — 1-pad quantum  (2 remaining input bytes)
+//     (empty)             — no trailing partial quantum
+const BASE64_RE = /^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/;
+
+/**
+ * @description RFC 4648 base64 string (PEM / MIME / XML line endings tolerated). Effect port of `base64Schema` (`z.string().check(z.refine(...))`): strips CRLF /
+ * LF line endings before testing the quantum regex.
+ */
+export const peppolBase64Schema = Schema.String.check(Schema.makeFilter((val: string) => BASE64_RE.test(val.replace(/\r?\n/g, '')))).annotate({
+  message: 'Invalid base64',
+});
+
+export type Base64 = typeof peppolBase64Schema.Type;

package/src/effect/utils/peppol-vat-regex-schema.ts

@@ -0,0 +1,51 @@
+import { Schema } from 'effect';
+
+import { isValidMod97_0208 } from '#/peppol-validations/is-valid-mod97-0208';
+
+/**
+ * @description Belgian VAT number (`BE` + 10 digits with mod 97-0208 check digits). Effect port of the `BE` member of `vatRegexSchema`: prefix, exact length,
+ * pattern, and mod 97 check-digit validation share the original `'Invalid belgian vat number'` message.
+ */
+const belgianVat = Schema.String.check(
+  Schema.isStartsWith('BE'),
+  Schema.isLengthBetween(12, 12),
+  Schema.isPattern(/^BE[01]\d{9}$/),
+  Schema.makeFilter((value: string) => isValidMod97_0208(value.substring(2)).success)
+).annotate({ message: 'Invalid belgian vat number' });
+
+/**
+ * @description EU VAT identification number (one member per member-state prefix/pattern). Effect port of `vatRegexSchema` (`z.union([...])` of
+ * `z.string().check(...)` members): each member keeps its original prefix + pattern checks as `Schema.String.check` filters.
+ */
+export const peppolVatRegexSchema = Schema.Union([
+  belgianVat,
+  Schema.String.check(Schema.isStartsWith('AT'), Schema.isPattern(/^ATU\d{8}$/)),
+  Schema.String.check(Schema.isStartsWith('BG'), Schema.isPattern(/^BG\d{9,10}$/)),
+  Schema.String.check(Schema.isStartsWith('CY'), Schema.isPattern(/^CY\d{8}L$/)),
+  Schema.String.check(Schema.isStartsWith('CZ'), Schema.isPattern(/^CZ\d{8,10}$/)),
+  Schema.String.check(Schema.isStartsWith('DE'), Schema.isPattern(/^DE\d{9}$/)),
+  Schema.String.check(Schema.isStartsWith('DK'), Schema.isPattern(/^DK\d{8}$/)),
+  Schema.String.check(Schema.isStartsWith('EE'), Schema.isPattern(/^EE\d{9}$/)),
+  Schema.String.check(Schema.isStartsWith('EL'), Schema.isPattern(/^EL\d{9}$/)),
+  Schema.String.check(Schema.isStartsWith('GR'), Schema.isPattern(/^GR\d{9}$/)),
+  Schema.String.check(Schema.isStartsWith('ES'), Schema.isPattern(/^ES[0-9A-Z]\d{7}[0-9A-Z]$/)),
+  Schema.String.check(Schema.isStartsWith('FI'), Schema.isPattern(/^FI\d{8}$/)),
+  Schema.String.check(Schema.isStartsWith('FR'), Schema.isPattern(/^FR[0-9A-Z]{2}\d{9}$/)),
+  Schema.String.check(Schema.isStartsWith('GB'), Schema.isPattern(/^GB(\d{9}(\d{3})?|[A-Z]{2}\d{3})$/)),
+  Schema.String.check(Schema.isStartsWith('HU'), Schema.isPattern(/^HU\d{8}$/)),
+  Schema.String.check(Schema.isStartsWith('IE'), Schema.isPattern(/^IE\dS\d{5}L$/)),
+  Schema.String.check(Schema.isStartsWith('IT'), Schema.isPattern(/^IT\d{11}$/)),
+  Schema.String.check(Schema.isStartsWith('LT'), Schema.isPattern(/^LT(\d{9}|\d{12})$/)),
+  Schema.String.check(Schema.isStartsWith('LU'), Schema.isPattern(/^LU\d{8}$/)),
+  Schema.String.check(Schema.isStartsWith('LV'), Schema.isPattern(/^LV\d{11}$/)),
+  Schema.String.check(Schema.isStartsWith('MT'), Schema.isPattern(/^MT\d{8}$/)),
+  Schema.String.check(Schema.isStartsWith('NL'), Schema.isPattern(/^NL\d{9}B\d{2}$/)),
+  Schema.String.check(Schema.isStartsWith('PL'), Schema.isPattern(/^PL\d{10}$/)),
+  Schema.String.check(Schema.isStartsWith('PT'), Schema.isPattern(/^PT\d{9}$/)),
+  Schema.String.check(Schema.isStartsWith('RO'), Schema.isPattern(/^RO\d{2,10}$/)),
+  Schema.String.check(Schema.isStartsWith('SE'), Schema.isPattern(/^SE\d{12}$/)),
+  Schema.String.check(Schema.isStartsWith('SI'), Schema.isPattern(/^SI\d{8}$/)),
+  Schema.String.check(Schema.isStartsWith('SK'), Schema.isPattern(/^SK\d{10}$/)),
+]);
+
+export type VatRegex = typeof peppolVatRegexSchema.Type;

package/src/effect/utils/peppol-xsd-time-schema.ts

@@ -0,0 +1,13 @@
+import { Schema } from 'effect';
+
+/**
+ * @description XSD `time` lexical value (`HH:MM:SS` with optional fractional seconds and timezone). Effect port of `xsdTime` (`z.string().check(z.regex(...))`):
+ * keeps the value as a plain string and only validates the shape.
+ */
+export const peppolXsdTimeSchema = Schema.String.check(
+  Schema.isPattern(
+    /^(?:[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)$/
+  )
+).annotate({ message: 'Invalid ISO time' });
+
+export type XsdTime = typeof peppolXsdTimeSchema.Type;

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

@@ -0,0 +1,2 @@
+export { quantityToIntlUnitMap, quantityUnitCodeToIntlUnit } from '#/schemas/utils/quantity-unit-code-to-intl-unit';
+export type { IntlUnit } from '#/schemas/utils/quantity-unit-code-to-intl-unit';

package/src/effect/values/additional-document-reference-code-schema.ts

@@ -0,0 +1,28 @@
+import { Schema } from 'effect';
+
+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 the generic message.
+ *
+ * @returns An Effect 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) {
+  const schema = Schema.Literals(additionalDocumentReferenceCodesKeys);
+  return error === undefined ? schema : schema.annotate({ message: error });
+}

package/src/effect/values/allowance-charge-reason-code-schema.ts

@@ -0,0 +1,30 @@
+import { Schema } from 'effect';
+
+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 An Effect 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.
+  const schema = Schema.Literals(allowanceChargeReasonCodesKeys);
+  return error === undefined ? schema : schema.annotate({ message: error });
+}

package/src/effect/values/application-response-type-code-schema.ts

@@ -0,0 +1,26 @@
+import { Schema } from 'effect';
+
+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 An Effect 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) {
+  const schema = Schema.Literals(applicationResponseTypeCodesKeys);
+  return error === undefined ? schema : schema.annotate({ message: error });
+}

package/src/effect/values/charge-reason-code-schema.ts

@@ -0,0 +1,30 @@
+import { Schema } from 'effect';
+
+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 An Effect 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.
+  const schema = Schema.Literals(chargeReasonCodesKeys);
+  return error === undefined ? schema : schema.annotate({ message: error });
+}

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

@@ -0,0 +1,26 @@
+import { Schema } from 'effect';
+
+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 An Effect 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) {
+  const schema = Schema.Literals(creditNoteTypeCodesKeys);
+  return error === undefined ? schema : schema.annotate({ message: error });
+}

package/src/effect/values/currency-code-schema.ts

@@ -0,0 +1,36 @@
+/**
+ * @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 { Schema } from 'effect';
+
+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 An Effect 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) {
+  const schema = Schema.Literals(currencyCodesKeys);
+  return error === undefined ? schema : schema.annotate({ message: error });
+}

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

@@ -0,0 +1,16 @@
+import { Schema } from 'effect';
+
+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 An Effect schema that accepts only valid document type schemes.
+ *
+ * @see {@link documentTypesScheme}
+ */
+export function documentTypeSchemesSchema(error = 'invalid Peppol document type scheme') {
+  return Schema.Literals(documentTypesScheme as [string, ...Array<string>]).annotate({ message: error });
+}

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

@@ -0,0 +1,17 @@
+import { Schema } from 'effect';
+
+import { documentTypesTable } from '#/values/document-type.generated';
+
+/**
+ * @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 An Effect schema that accepts only valid document type values.
+ *
+ * @see {@link documentTypesTable}
+ */
+export function documentTypeValuesSchema(error = 'invalid Peppol document type value') {
+  const values = Object.values(documentTypesTable).flat();
+  return Schema.String.check(Schema.makeFilter((val: string) => values.includes(val as never))).annotate({ message: error });
+}

package/src/effect/values/duty-tax-fee-category-schema.ts

@@ -0,0 +1,29 @@
+import { Schema } from 'effect';
+
+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 An Effect 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) {
+  const schema = Schema.Literals(dutyTaxFeeCategoriesKeys);
+  return error === undefined ? schema : schema.annotate({ message: error });
+}

package/src/effect/values/electronic-codes-schema.ts

@@ -0,0 +1,36 @@
+/**
+ * @module effect/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 { Schema } from 'effect';
+
+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 An Effect 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) {
+  const schema = Schema.Literals(electronicAddressCodesKeys);
+  return error === undefined ? schema : schema.annotate({ message: error });
+}

package/src/effect/values/icd-codes-schema.ts

@@ -0,0 +1,28 @@
+import { Schema } from 'effect';
+
+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 An Effect 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 Schema.Literals(icdCodesKeys).annotate({ message: error });
+}

package/src/effect/values/index.ts

@@ -0,0 +1,28 @@
+export * from './additional-document-reference-code-schema';
+export * from './allowance-charge-reason-code-schema';
+export * from './application-response-type-code-schema';
+export * from './charge-reason-code-schema';
+export * from './peppol-country-code-schema';
+export * from './credit-note-type-code-schema';
+export * from './currency-code-schema';
+export * from './peppol-document-type-code-schema';
+export * from './peppol-document-type-schema';
+export * from './document-type-schemes-schema';
+export * from './document-type-values-schema';
+export * from './duty-tax-fee-category-schema';
+export * from './electronic-codes-schema';
+export * from './icd-codes-schema';
+export * from './invoice-status-code-schema';
+export * from './invoice-type-code-schema';
+export * from './item-classification-codes-schema';
+export * from './mime-codes-schema';
+export * from './op-status-action-schema';
+export * from './op-status-reason-schema';
+export * from './participant-identifier-code-schema';
+export * from './payment-means-code-schema';
+export * from './process-from-document-type-schema';
+export * from './peppol-process-schema';
+export * from './process-xml-identifier-schema';
+export * from './quantity-unit-codes-schema';
+export * from './vatex-code-schema';
+export * from './vat-date-code-schema';

package/src/effect/values/invoice-status-code-schema.ts

@@ -0,0 +1,23 @@
+import { Schema } from 'effect';
+
+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 An Effect schema that accepts only valid invoice status codes.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343-T111/
+ */
+export const invoiceStatusCodeSchema = Schema.Literals(invoiceStatusCodesKeys);

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

@@ -0,0 +1,26 @@
+import { Schema } from 'effect';
+
+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 An Effect 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) {
+  const schema = Schema.Literals(invoiceTypeCodesKeys);
+  return error === undefined ? schema : schema.annotate({ message: error });
+}

package/src/effect/values/item-classification-codes-schema.ts

@@ -0,0 +1,29 @@
+import { Schema } from 'effect';
+
+import type { ItemClassificationCodesKeys } from '#/values/item-classification-code.generated';
+
+import { itemClassificationCodesKeys } from '#/values/item-classification-code.generated';
+
+/**
+ * @description An item classification code as defined by the PEPPOL subset of UNCL 7143.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL7143/
+ */
+export type PeppolItemClassificationCode = ItemClassificationCodesKeys;
+
+/**
+ * @description Validates an item classification code against the PEPPOL subset of UNCL 7143.
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns An Effect schema that accepts only valid item classification codes.
+ *
+ * @validations
+ * - BR-CL-13: Item classification scheme MUST be a valid UNTDID 7143 code.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL7143/
+ */
+export function itemClassificationCodesSchema(error?: string) {
+  const schema = Schema.Literals(itemClassificationCodesKeys);
+  return error === undefined ? schema : schema.annotate({ message: error });
+}

package/src/effect/values/mime-codes-schema.ts

@@ -0,0 +1,29 @@
+import { Schema } from 'effect';
+
+import type { MimeCodesKeys } from '#/values/mime-codes.generated';
+
+import { mimeCodesKeys } from '#/values/mime-codes.generated';
+
+/**
+ * @description A MIME media type code (e.g. `application/pdf`) as used for attached documents.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/MimeCode/
+ */
+export type PeppolMimeCode = MimeCodesKeys;
+
+/**
+ * @description Validates a MIME media type against the PEPPOL MIME code list.
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns An Effect schema that accepts only valid MIME types.
+ *
+ * @validations
+ * - PEPPOL-EN16931-CL001: Attachment (MIME) type MUST come from the allowed list.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/MimeCode/
+ */
+export function mimeCodesSchema(error?: string) {
+  const schema = Schema.Literals(mimeCodesKeys);
+  return error === undefined ? schema : schema.annotate({ message: error });
+}

package/src/effect/values/op-status-action-schema.ts

@@ -0,0 +1,26 @@
+import { Schema } from 'effect';
+
+import type { OpStatusActionKeys } from '#/values/op-status-action.generated';
+
+import { opStatusActionKeys } from '#/values/op-status-action.generated';
+
+/**
+ * @description An OpenPeppol operation status action code (e.g. the outcome of a message response).
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/OPStatusAction/
+ */
+export type PeppolOpStatusAction = OpStatusActionKeys;
+
+/**
+ * @description Validates an OpenPeppol operation status action code against the OPStatusAction codelist.
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns An Effect schema that accepts only valid operation status action codes.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/OPStatusAction/
+ */
+export function opStatusActionSchema(error?: string) {
+  const schema = Schema.Literals(opStatusActionKeys);
+  return error === undefined ? schema : schema.annotate({ message: error });
+}

package/src/effect/values/op-status-reason-schema.ts

@@ -0,0 +1,26 @@
+import { Schema } from 'effect';
+
+import type { OpStatusReasonKeys } from '#/values/op-status-reason.generated';
+
+import { opStatusReasonKeys } from '#/values/op-status-reason.generated';
+
+/**
+ * @description An OpenPeppol operation status reason code (e.g. the reason for a message response outcome).
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/OPStatusReason/
+ */
+export type PeppolOpStatusReason = OpStatusReasonKeys;
+
+/**
+ * @description Validates an OpenPeppol operation status reason code against the OPStatusReason codelist.
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns An Effect schema that accepts only valid operation status reason codes.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/OPStatusReason/
+ */
+export function opStatusReasonSchema(error?: string) {
+  const schema = Schema.Literals(opStatusReasonKeys);
+  return error === undefined ? schema : schema.annotate({ message: error });
+}

package/src/effect/values/participant-identifier-code-schema.ts

@@ -0,0 +1,24 @@
+import { Schema } from 'effect';
+
+import type { ParticipantIdentifierSchemesKeys } from '#/values/participant-identifier-schemes.generated';
+
+import { participantIdentifierSchemesKeys } from '#/values/participant-identifier-schemes.generated';
+
+/**
+ * @description A PEPPOL participant identifier scheme, identifying the scheme of a participant identifier (e.g. EAS codes).
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/
+ */
+export type PeppolParticipantIdentifierCode = ParticipantIdentifierSchemesKeys;
+
+/**
+ * @description Validates a PEPPOL participant identifier scheme against the participant identifier schemes list.
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns An Effect schema that accepts only valid participant identifier schemes.
+ */
+export function participantIdentifierCodeSchema(error?: string) {
+  const schema = Schema.Literals(participantIdentifierSchemesKeys);
+  return error === undefined ? schema : schema.annotate({ message: error });
+}