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

package/src/effect/peppol-document-schema.ts

@@ -1,11 +1,14 @@
+import type { SchemaAST } from 'effect';
 import type { AllUnionFields } from 'type-fest';
 
-import { Effect, Equal, Predicate, Schema, SchemaGetter, SchemaIssue } from 'effect';
+import { Effect, Predicate, Schema, SchemaGetter, SchemaIssue } from 'effect';
 import XMLBuilder from 'fast-xml-builder';
 import { XMLParser } from 'fast-xml-parser';
 
-import type { peppolCreditNoteLineSchema } from '#/effect/fields/peppol-credit-note-line-schema';
-import type { peppolInvoiceLineSchema } from '#/effect/fields/peppol-invoice-line-schema';
+import type { PeppolCreditNoteLine } from '#/effect/fields/peppol-credit-note-line-schema';
+import type { PeppolInvoiceLine } from '#/effect/fields/peppol-invoice-line-schema';
+import type { PeppolCreditNote } from '#/effect/peppol-credit-note-schema';
+import type { PeppolInvoice } from '#/effect/peppol-invoice-schema';
 import type { XmlNode } from '#/helpers/get-prop';
 import type { PeppolCreditNote as ZodPeppolCreditNote } from '#/schemas/credit-note';
 import type { PeppolInvoice as ZodPeppolInvoice } from '#/schemas/invoice';
@@ -22,86 +25,118 @@ import { encodeCreditNote } from '#/decoders/encode-credit-note';
 import { encodeInvoice } from '#/decoders/encode-invoice';
 import { encodeInvoiceResponse } from '#/decoders/encode-invoice-response';
 import { encodeMessageLevelResponse } from '#/decoders/encode-message-level-response';
+import { peppolCreditNoteSchema } from '#/effect/peppol-credit-note-schema';
+import { peppolInvoiceResponseSchema } from '#/effect/peppol-invoice-response-schema';
+import { peppolInvoiceSchema } from '#/effect/peppol-invoice-schema';
+import { peppolMessageLevelResponseSchema } from '#/effect/peppol-message-level-response-schema';
 import { strOrUnd } from '#/helpers/str-or-und';
 import { builderOptions } from '#/xml/builder-options';
 import { parserOptions } from '#/xml/parser-options';
 
-import { peppolCreditNoteSchema } from './peppol-credit-note-schema';
-import { peppolInvoiceResponseSchema } from './peppol-invoice-response-schema';
-import { peppolInvoiceSchema } from './peppol-invoice-schema';
-import { peppolMessageLevelResponseSchema } from './peppol-message-level-response-schema';
-
 export class PeppolInvalidDocumentType extends Schema.TaggedError<PeppolInvalidDocumentType>()('PeppolInvalidDocumentType', {
   message: Schema.String,
   rootNodes: Schema.Array(Schema.String),
 }) {}
 
 /**
- * @description Union of every supported PEPPOL business document (Effect port of the `z.xor` side of `documentParser`). Members discriminate cleanly: invoice vs
- * credit note via `invoiceLines`/`creditNoteLines`, message-level vs invoice response via the `profileId` literal.
+ * @description Object representation of a PEPPOL document, before the member schemas normalise it (dates stay strings, enums stay loose). This is the shape
+ * produced by the legacy `#/decoders/*` functions and consumed by their `#/decoders/encode-*` counterparts.
  */
-export const peppolDocumentSchema = Schema.Union([
+const peppolDocumentObjectSchema = Schema.Union([
   peppolInvoiceSchema,
   peppolCreditNoteSchema,
   peppolMessageLevelResponseSchema,
   peppolInvoiceResponseSchema,
-]).pipe(
+]);
+
+type PeppolDocumentObject = typeof peppolDocumentObjectSchema.Encoded;
+
+const parseXml = (value: string): XmlNode => new XMLParser({ ...parserOptions, removeNSPrefix: true }).parse(value);
+
+const toInvalidValue = (error: { readonly message: string }, input: unknown, options: SchemaAST.ParseOptions) =>
+  new SchemaIssue.InvalidValue({ message: error.message }, input, options);
+
+/**
+ * @description XML string -> loose document object. Dispatches on the root element; `ApplicationResponse` is further split by its `cbc:ProfileID`.
+ */
+const decodeDocumentXml = Effect.fn(function* (value: string) {
+  const parsed = parseXml(value);
+
+  if (Predicate.isNotNullish(parsed.Invoice)) {
+    return yield* decodeInvoice(parsed);
+  }
+  if (Predicate.isNotNullish(parsed.CreditNote)) {
+    return yield* decodeCreditNote(parsed);
+  }
+  if (Predicate.isNotNullish(parsed.ApplicationResponse)) {
+    const profileId = yield* strOrUnd(parsed.ApplicationResponse, 'cbc:ProfileID');
+    if (profileId === MESSAGE_LEVEL_RESPONSE_PROFILE_ID) {
+      return yield* decodeMessageLevelResponse(parsed);
+    }
+    if (profileId === INVOICE_RESPONSE_PROFILE_ID) {
+      return yield* decodeInvoiceResponse(parsed);
+    }
+  }
+
+  const rootNodes = Object.keys(parsed);
+  return yield* new PeppolInvalidDocumentType({ message: `Unsupported document type: ${rootNodes.join(',')}`, rootNodes });
+});
+
+/**
+ * @description Loose document object -> XML string. Mirrors {@link decodeDocumentXml} by dispatching on the decoded discriminant.
+ */
+const encodeDocumentXml = Effect.fn(function* (document: PeppolDocumentObject) {
+  let content: unknown;
+
+  if (Predicate.hasProperty(document, 'invoiceLines')) {
+    content = yield* encodeInvoice(document as unknown as ZodPeppolInvoice);
+  } else if (Predicate.hasProperty(document, 'creditNoteLines')) {
+    content = yield* encodeCreditNote(document as unknown as ZodPeppolCreditNote);
+  } else if (Predicate.hasProperty(document, 'documentResponse')) {
+    if (document.profileId === MESSAGE_LEVEL_RESPONSE_PROFILE_ID) {
+      content = yield* encodeMessageLevelResponse(document as unknown as ZodPeppolMessageLevelResponse);
+    } else if (document.profileId === INVOICE_RESPONSE_PROFILE_ID) {
+      content = yield* encodeInvoiceResponse(document as unknown as ZodPeppolInvoiceResponse);
+    }
+  }
+
+  if (Predicate.isNullish(content)) {
+    const rootNodes = Object.keys(document);
+    return yield* new PeppolInvalidDocumentType({ message: `Unsupported document type: ${rootNodes.join(',')}`, rootNodes });
+  }
+
+  return new XMLBuilder(builderOptions).build(content) as string;
+});
+
+/**
+ * @description Union of every supported PEPPOL business document (Effect port of the `z.xor` side of `documentParser`). Members discriminate cleanly: invoice vs
+ * credit note via `invoiceLines`/`creditNoteLines`, message-level vs invoice response via the `profileId` literal.
+ */
+export const peppolDocumentSchema = peppolDocumentObjectSchema.pipe(
   Schema.encodeTo(Schema.String, {
-    encode: SchemaGetter.transformEffect(
-      Effect.fn(function* (document) {
-        let content: unknown;
-        if (Predicate.hasProperty(document, 'invoiceLines')) {
-          content = encodeInvoice(document as unknown as ZodPeppolInvoice);
-        } else if (Predicate.hasProperty(document, 'creditNoteLines')) {
-          content = encodeCreditNote(document as unknown as ZodPeppolCreditNote);
-        } else if (Predicate.hasProperty(document, 'documentResponse')) {
-          if (Equal.equals(document.profileId, MESSAGE_LEVEL_RESPONSE_PROFILE_ID)) {
-            content = encodeMessageLevelResponse(document as unknown as ZodPeppolMessageLevelResponse);
-          } else if (Equal.equals(document.profileId, INVOICE_RESPONSE_PROFILE_ID)) {
-            content = encodeInvoiceResponse(document as unknown as ZodPeppolInvoiceResponse);
-          }
-        }
-
-        const builder = new XMLBuilder(builderOptions);
-        return builder.build(content);
-      })
+    encode: SchemaGetter.transformEffect((document, options) =>
+      encodeDocumentXml(document).pipe(Effect.mapError(error => toInvalidValue(error, document, options)))
     ),
-    decode: SchemaGetter.transformEffect(
-      Effect.fn(function* (value, options) {
-        const parser = new XMLParser({ ...parserOptions, removeNSPrefix: true });
-        const parsed: XmlNode = parser.parse(value);
-
-        if (Predicate.isNotNullish(parsed.Invoice)) {
-          return decodeInvoice(parsed) as typeof peppolInvoiceSchema.Type;
-        } else if (Predicate.isNotNullish(parsed.CreditNote)) {
-          return decodeCreditNote(parsed) as typeof peppolCreditNoteSchema.Type;
-        } else if (Predicate.isNotNullish(parsed.ApplicationResponse)) {
-          const profile = strOrUnd(parsed.ApplicationResponse, 'cbc:ProfileID');
-          if (Equal.equals(profile, MESSAGE_LEVEL_RESPONSE_PROFILE_ID)) {
-            return decodeMessageLevelResponse(parsed) as typeof peppolMessageLevelResponseSchema.Type;
-          } else if (Equal.equals(profile, INVOICE_RESPONSE_PROFILE_ID)) {
-            return decodeInvoiceResponse(parsed) as typeof peppolInvoiceResponseSchema.Type;
-          }
-        }
-
-        return yield* Effect.fail(
-          new SchemaIssue.InvalidValue({ message: `Unsupported document type: ${Object.keys(parsed).join(',')}` }, value, options)
-        );
-      })
+    decode: SchemaGetter.transformEffect((value, options) =>
+      decodeDocumentXml(value).pipe(
+        // The legacy decoders emit loose values (e.g. `descriptionCode: string`); the union member below validates and narrows them.
+        Effect.map(document => document as PeppolDocumentObject),
+        Effect.mapError(error => toInvalidValue(error, value, options))
+      )
     ),
   })
 );
 
-export type PeppolDocumentEncoded = string;
-export interface PeppolDocumentDecoded extends AllUnionFields<typeof peppolDocumentSchema.Type> {}
+export type PeppolDocumentEncoded = Schema.Codec.Encoded<typeof peppolDocumentSchema>;
+export interface PeppolDocumentDecoded extends AllUnionFields<Schema.Schema.Type<typeof peppolDocumentSchema>> {}
 
 /**
  * @description This defines the types of documents that are sent/received through the peppol network.
  */
-export interface PeppolDocument extends AllUnionFields<typeof peppolInvoiceSchema.Type | typeof peppolCreditNoteSchema.Type> {}
+export interface PeppolDocument extends AllUnionFields<PeppolInvoice | PeppolCreditNote> {}
 /**
  * @description This defines the types of message that are sent/received through the peppol network.
  */
 export interface PeppolMessage extends AllUnionFields<typeof peppolMessageLevelResponseSchema.Type | typeof peppolInvoiceResponseSchema.Type> {}
 export interface PeppolAllDocuments extends AllUnionFields<PeppolDocument | PeppolMessage> {}
-export interface PeppolDocumentLine extends AllUnionFields<typeof peppolInvoiceLineSchema.Type | typeof peppolCreditNoteLineSchema.Type> {}
+export interface PeppolDocumentLine extends AllUnionFields<PeppolInvoiceLine | PeppolCreditNoteLine> {}

package/src/effect/peppol-invoice-response-document-actual-response-schema.ts

@@ -1,11 +1,10 @@
 import { Schema } from 'effect';
 
+import { peppolInvoiceResponseDocumentActualResponseStatusSchema } from '#/effect/peppol-invoice-response-document-actual-response-status-schema';
+import { peppolIsoDateStringSchema } from '#/effect/peppol-iso-date-string-schema';
 import { invoiceResponseCodeNeedsSchema } from '#/invoice-response-codes/invoice-response-code-needs-schema';
 import { invoiceResponseCodeNotNeedsSchema } from '#/invoice-response-codes/invoice-response-code-not-needs-schema';
 
-import { peppolInvoiceResponseDocumentActualResponseStatusSchema } from './peppol-invoice-response-document-actual-response-status-schema';
-import { peppolIsoDateStringSchema } from './peppol-iso-date-string-schema';
-
 const withStatusCodes = Schema.Literals(invoiceResponseCodeNeedsSchema);
 const withoutStatusCodes = Schema.Literals(invoiceResponseCodeNotNeedsSchema);
 

package/src/effect/peppol-invoice-response-document-actual-response-status-schema.ts

@@ -1,6 +1,6 @@
 import { Schema } from 'effect';
 
-import { peppolInvoiceResponseStatusReasonCodeSchema } from './peppol-invoice-response-status-reason-code-schema';
+import { peppolInvoiceResponseStatusReasonCodeSchema } from '#/effect/peppol-invoice-response-status-reason-code-schema';
 
 const invoiceResponseCondition = Schema.Struct({
   /**

package/src/effect/peppol-invoice-response-schema.ts

@@ -1,22 +1,21 @@
 import { Schema, Struct } from 'effect';
 
 import { INVOICE_RESPONSE_PROFILE_ID } from '#/constants/invoice-response-profile-id';
-
-import { identifierSchema } from './fields/identifier-schema';
-import { peppolContactSchema } from './fields/peppol-contact-schema';
-import { peppolPartyLegalEntitySchema } from './fields/peppol-party-legal-entity-schema';
-import { peppolInvoiceResponseDocumentActualResponseSchema } from './peppol-invoice-response-document-actual-response-schema';
-import { peppolIsoDateStringSchema } from './peppol-iso-date-string-schema';
-import { peppolMessageLevelResponsePartySchema } from './peppol-message-level-response-party-schema';
-import { peppolMessageLevelResponseSchema } from './peppol-message-level-response-schema';
-import { peppolDocumentTypeCodeSchema } from './values/peppol-document-type-code-schema';
+import { peppolContactSchema } from '#/effect/fields/peppol-contact-schema';
+import { peppolIdentifierSchema } from '#/effect/fields/peppol-identifier-schema';
+import { peppolPartyLegalEntitySchema } from '#/effect/fields/peppol-party-legal-entity-schema';
+import { peppolInvoiceResponseDocumentActualResponseSchema } from '#/effect/peppol-invoice-response-document-actual-response-schema';
+import { peppolIsoDateStringSchema } from '#/effect/peppol-iso-date-string-schema';
+import { peppolMessageLevelResponsePartySchema } from '#/effect/peppol-message-level-response-party-schema';
+import { peppolMessageLevelResponseSchema } from '#/effect/peppol-message-level-response-schema';
+import { peppolDocumentTypeCodeSchema } from '#/effect/values/peppol-document-type-code-schema';
 
 export const peppolInvoiceResponsePartySchema = peppolMessageLevelResponsePartySchema.pipe(
   Schema.fieldsAssign({
     /**
      * @summary Party partyIdentification
      */
-    partyIdentification: Schema.optional(identifierSchema()),
+    partyIdentification: Schema.optional(peppolIdentifierSchema),
     partyLegalEntity: peppolPartyLegalEntitySchema.mapFields(Struct.pick(['registrationName'])),
   })
 );
@@ -41,7 +40,7 @@ export const peppolInvoiceResponseDocumentResponsePartySchema = Schema.Struct({
   /**
    * @summary Party partyIdentification
    */
-  partyIdentification: Schema.optional(identifierSchema()),
+  partyIdentification: Schema.optional(peppolIdentifierSchema),
   /**
    * @example
    *   Seller Business Name AS
@@ -93,7 +92,7 @@ export const peppolInvoiceResponseDocumentReferenceSchema = Schema.Struct({
    *
    * @summary Identifier type code
    */
-  documentTypeCode: peppolDocumentTypeCodeSchema(),
+  documentTypeCode: peppolDocumentTypeCodeSchema,
 });
 
 export type PeppolInvoiceResponseDocumentReference = typeof peppolInvoiceResponseDocumentReferenceSchema.Type;

package/src/effect/peppol-invoice-response-status-reason-code-schema.ts

@@ -1,11 +1,11 @@
 import { Schema } from 'effect';
 
-import { opStatusActionSchema } from './values/op-status-action-schema';
-import { opStatusReasonSchema } from './values/op-status-reason-schema';
+import { opStatusActionSchema } from '#/effect/values/op-status-action-schema';
+import { opStatusReasonSchema } from '#/effect/values/op-status-reason-schema';
 
 export const peppolInvoiceResponseStatusReasonCodeSchema = Schema.Union([
   Schema.Struct({
-    value: opStatusActionSchema(),
+    value: opStatusActionSchema,
     /**
      * @description List identifier for clarification.
      *
@@ -16,7 +16,7 @@ export const peppolInvoiceResponseStatusReasonCodeSchema = Schema.Union([
     listId: Schema.Literal('OPStatusAction'),
   }),
   Schema.Struct({
-    value: opStatusReasonSchema(),
+    value: opStatusReasonSchema,
     /**
      * @description List identifier for clarification.
      *

package/src/effect/peppol-invoice-schema.ts

@@ -1,48 +1,42 @@
 import { Schema } from 'effect';
 
-import { peppolInvoiceLineSchema } from './fields/peppol-invoice-line-schema';
-import { peppolBillingBaseSchema } from './peppol-billing-base-schema';
-import { peppolIsoDateStringSchema } from './peppol-iso-date-string-schema';
-import { invoiceTypeCodeSchema } from './values/invoice-type-code-schema';
+import { peppolInvoiceLineSchema } from '#/effect/fields/peppol-invoice-line-schema';
+import { peppolBillingBaseSchema } from '#/effect/peppol-billing-base-schema';
+import { peppolIsoDateStringSchema } from '#/effect/peppol-iso-date-string-schema';
+import { invoiceTypeCodeSchema } from '#/effect/values/invoice-type-code-schema';
 
-/**
- * @description Main UBL Invoice schema (camelCase properties) Effect port of `invoiceSchema` (`z.extend(billingBaseSchema, ...)` →
- * `peppolBillingBaseSchema.pipe(Schema.fieldsAssign(...))`). `dueDate` stays a validated plain string via `peppolIsoDateStringSchema` (no `Date`
- * conversion); `z.optional` maps to `Schema.optional` (accepts explicit `undefined`, matching decoder output).
- */
-export const peppolInvoiceSchema = peppolBillingBaseSchema.pipe(
-  Schema.fieldsAssign({
-    /**
-     * @example
-     *   2017 - 11 - 01;
-     *
-     * @summary Payment due date
-     *
-     * @name cbc:DueDate
-     */
-    dueDate: Schema.optional(peppolIsoDateStringSchema),
-    /**
-     * @summary INVOICE LINE
-     *
-     * @name cac:InvoiceLine
-     */
-    invoiceLines: Schema.Array(peppolInvoiceLineSchema).check(Schema.isMinLength(1)),
-    /**
-     * @example
-     *   380;
-     *
-     * @summary Invoice type code
-     *
-     * @name cbc:InvoiceTypeCode
-     */
-    invoiceTypeCode: invoiceTypeCodeSchema(),
-    /**
-     * @summary PROJECT REFERENCE
-     *
-     * @name cac:ProjectReference
-     */
-    projectReference: Schema.optional(Schema.Struct({ id: Schema.String })),
-  })
-);
+export const peppolInvoiceSchema = Schema.Struct({
+  ...peppolBillingBaseSchema.fields,
+  /**
+   * @example
+   *   2017 - 11 - 01;
+   *
+   * @summary Payment due date
+   *
+   * @name cbc:DueDate
+   */
+  dueDate: Schema.optional(peppolIsoDateStringSchema),
+  /**
+   * @summary INVOICE LINE
+   *
+   * @name cac:InvoiceLine
+   */
+  invoiceLines: Schema.Array(peppolInvoiceLineSchema).check(Schema.isMinLength(1)),
+  /**
+   * @example
+   *   380;
+   *
+   * @summary Invoice type code
+   *
+   * @name cbc:InvoiceTypeCode
+   */
+  invoiceTypeCode: invoiceTypeCodeSchema,
+  /**
+   * @summary PROJECT REFERENCE
+   *
+   * @name cac:ProjectReference
+   */
+  projectReference: Schema.optional(Schema.Struct({ id: Schema.String })),
+});
 
-export type PeppolInvoice = typeof peppolInvoiceSchema.Type;
+export interface PeppolInvoice extends Schema.Schema.Type<typeof peppolInvoiceSchema> {}

package/src/effect/peppol-iso-date-string-schema.ts

@@ -1,4 +1,4 @@
-import { Schema } from 'effect';
+import { DateTime, Schema, SchemaGetter } from 'effect';
 
 /**
  * @description ISO 8601 calendar date string (`YYYY-MM-DD`). Effect port of `dateOnly` (`z.iso.date()`): keeps the value as a plain string and only validates the
@@ -8,6 +8,12 @@ import { Schema } from 'effect';
  *
  * @see PEPPOL-EN16931-F001: A date MUST be formatted YYYY-MM-DD.
  */
-export const peppolIsoDateStringSchema = Schema.String.check(Schema.isPattern(/^\d{4}-\d{2}-\d{2}$/));
+export const peppolIsoDateStringSchema = Schema.String.check(Schema.isPattern(/^\d{4}-\d{2}-\d{2}Z?$/)).pipe(
+  Schema.decodeTo(Schema.DateTimeUtc, {
+    decode: SchemaGetter.dateTimeUtcFromInput().map(DateTime.removeTime),
+    encode: SchemaGetter.transform(DateTime.formatIsoDate),
+  })
+);
 
-export type IsoDateString = typeof peppolIsoDateStringSchema.Type;
+export type PeppolIsoDateString = typeof peppolIsoDateStringSchema.Type;
+export type PeppolIsoDateEncoded = typeof peppolIsoDateStringSchema.Encoded;

package/src/effect/peppol-message-level-response-document-response-schema.ts

@@ -1,8 +1,8 @@
 import { Schema } from 'effect';
 
-import { peppolDocumentResponseDocumentReferenceSchema } from './peppol-document-response-document-reference-schema';
-import { peppolDocumentResponseDocumentSchema } from './peppol-document-response-document-schema';
-import { peppolDocumentResponseLineResponseSchema } from './peppol-document-response-line-response-schema';
+import { peppolDocumentResponseDocumentReferenceSchema } from '#/effect/peppol-document-response-document-reference-schema';
+import { peppolDocumentResponseDocumentSchema } from '#/effect/peppol-document-response-document-schema';
+import { peppolDocumentResponseLineResponseSchema } from '#/effect/peppol-document-response-line-response-schema';
 
 export const peppolMessageLevelResponseDocumentResponseSchema = Schema.Struct({
   /**

package/src/effect/peppol-message-level-response-party-schema.ts

@@ -1,6 +1,6 @@
 import { Schema } from 'effect';
 
-import { identifierSchema } from './fields/identifier-schema';
+import { peppolIdentifierSchema } from '#/effect/fields/peppol-identifier-schema';
 
 export const peppolMessageLevelResponsePartySchema = Schema.Struct({
   /**
@@ -13,7 +13,7 @@ export const peppolMessageLevelResponsePartySchema = Schema.Struct({
    *
    * @name `cbc:EndpointID (+ @schemeID)`
    */
-  endpointId: Schema.optional(identifierSchema()),
+  endpointId: Schema.optional(peppolIdentifierSchema),
 });
 
 export type PeppolMessageLevelResponseParty = typeof peppolMessageLevelResponsePartySchema.Type;

package/src/effect/peppol-message-level-response-schema.ts

@@ -1,11 +1,10 @@
 import { Schema } from 'effect';
 
 import { MESSAGE_LEVEL_RESPONSE_PROFILE_ID } from '#/constants/message-level-response-profile-id';
-
-import { peppolIsoDateStringSchema } from './peppol-iso-date-string-schema';
-import { peppolMessageLevelResponseDocumentResponseSchema } from './peppol-message-level-response-document-response-schema';
-import { peppolMessageLevelResponsePartySchema } from './peppol-message-level-response-party-schema';
-import { peppolXsdTimeSchema } from './utils/peppol-xsd-time-schema';
+import { peppolIsoDateStringSchema } from '#/effect/peppol-iso-date-string-schema';
+import { peppolMessageLevelResponseDocumentResponseSchema } from '#/effect/peppol-message-level-response-document-response-schema';
+import { peppolMessageLevelResponsePartySchema } from '#/effect/peppol-message-level-response-party-schema';
+import { peppolXsdTimeSchema } from '#/effect/utils/peppol-xsd-time-schema';
 
 export const peppolMessageLevelResponseSchema = Schema.Struct({
   /**

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

@@ -1,7 +1,5 @@
 import { Schema } from 'effect';
 
-import type { AdditionalDocumentReferenceCodesKeys } from '#/values/additional-document-reference-codes.generated';
-
 import { additionalDocumentReferenceCodesKeys } from '#/values/additional-document-reference-codes.generated';
 
 /**
@@ -10,7 +8,7 @@ import { additionalDocumentReferenceCodesKeys } from '#/values/additional-docume
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1153/
  * @see {@link additionalDocumentReferenceCodesKeys}
  */
-export type PeppolAdditionalDocumentReferenceCode = AdditionalDocumentReferenceCodesKeys;
+export type PeppolAdditionalDocumentReferenceCode = typeof additionalDocumentReferenceCodeSchema.Type;
 
 /**
  * @description Validates an additional document reference code against the PEPPOL subset of UNCL 1153 (reference qualifiers).
@@ -22,7 +20,6 @@ export type PeppolAdditionalDocumentReferenceCode = AdditionalDocumentReferenceC
  * @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 });
-}
+export const additionalDocumentReferenceCodeSchema = Schema.Literals(additionalDocumentReferenceCodesKeys).pipe(
+  Schema.brand('PeppolAdditionalDocumentReferenceCode')
+);

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

@@ -1,7 +1,5 @@
 import { Schema } from 'effect';
 
-import type { AllowanceChargeReasonCodesKeys } from '#/values/allowance-charge-reason-codes.generated';
-
 import { allowanceChargeReasonCodesKeys } from '#/values/allowance-charge-reason-codes.generated';
 
 /**
@@ -9,7 +7,7 @@ import { allowanceChargeReasonCodesKeys } from '#/values/allowance-charge-reason
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5189/
  */
-export type PeppolAllowanceChargeReasonCode = AllowanceChargeReasonCodesKeys;
+export type PeppolAllowanceChargeReasonCode = typeof allowanceChargeReasonCodeSchema.Type;
 
 /**
  * @description Validates an allowance or charge reason code against the PEPPOL subset of UNCL 5189 (D.16B).
@@ -23,8 +21,6 @@ export type PeppolAllowanceChargeReasonCode = AllowanceChargeReasonCodesKeys;
  *
  * @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 });
-}
+export const allowanceChargeReasonCodeSchema = Schema.Literals(allowanceChargeReasonCodesKeys)
+  .pipe(Schema.brand('PeppolAllowanceChargeReasonCode'))
+  .annotate({ documentation: 'PEPPOL-EN16931-CL002: Reason code MUST be according to subset of UNCL 5189 D.16B.' });

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

@@ -20,7 +20,4 @@ export type PeppolApplicationResponseTypeCode = ApplicationResponseTypeCodesKeys
  *
  * @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 });
-}
+export const applicationResponseTypeCodeSchema = Schema.Literals(applicationResponseTypeCodesKeys);

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

@@ -1,7 +1,5 @@
 import { Schema } from 'effect';
 
-import type { ChargeReasonCodesKeys } from '#/values/charge-reason-codes.generated';
-
 import { chargeReasonCodesKeys } from '#/values/charge-reason-codes.generated';
 
 /**
@@ -9,7 +7,7 @@ import { chargeReasonCodesKeys } from '#/values/charge-reason-codes.generated';
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL7161/
  */
-export type PeppolChargeReasonCode = ChargeReasonCodesKeys;
+export type PeppolChargeReasonCode = typeof chargeReasonCodeSchema.Type;
 
 /**
  * @description Validates a charge reason code against the PEPPOL subset of UNCL 7161 (D.16B).
@@ -23,8 +21,6 @@ export type PeppolChargeReasonCode = ChargeReasonCodesKeys;
  *
  * @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 });
-}
+export const chargeReasonCodeSchema = Schema.Literals(chargeReasonCodesKeys)
+  .pipe(Schema.brand('PeppolChargeReasonCode'))
+  .annotate({ documentation: 'PEPPOL-EN16931-CL003: Reason code MUST be according to UNCL 7161 D.16B.' });

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

@@ -20,7 +20,4 @@ export type PeppolCreditNoteTypeCode = CreditNoteTypeCodesKeys;
  *
  * @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 });
-}
+export const creditNoteTypeCodeSchema = Schema.Literals(creditNoteTypeCodesKeys);

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

@@ -7,8 +7,6 @@
 
 import { Schema } from 'effect';
 
-import type { CurrencyCodesKeys } from '#/values/currency-code.generated';
-
 import { currencyCodesKeys } from '#/values/currency-code.generated';
 
 /**
@@ -16,7 +14,13 @@ import { currencyCodesKeys } from '#/values/currency-code.generated';
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/
  */
-export type PeppolCurrencyCode = CurrencyCodesKeys;
+export type PeppolCurrencyCode = Schema.Schema.Type<typeof currencyCodeSchema>;
+/**
+ * @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 PeppolCurrencyCodeEncoded = Schema.Codec.Encoded<typeof currencyCodeSchema>;
 
 /**
  * @description Validates an ISO 4217 currency code against the PEPPOL codelist.
@@ -30,7 +34,4 @@ export type PeppolCurrencyCode = CurrencyCodesKeys;
  *
  * @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 });
-}
+export const currencyCodeSchema = Schema.Literals(currencyCodesKeys).pipe(Schema.brand('PeppolCurrencyCode'));

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

@@ -11,6 +11,4 @@ import { documentTypesScheme } from '#/values/document-type.generated';
  *
  * @see {@link documentTypesScheme}
  */
-export function documentTypeSchemesSchema(error = 'invalid Peppol document type scheme') {
-  return Schema.Literals(documentTypesScheme as [string, ...Array<string>]).annotate({ message: error });
-}
+export const documentTypeSchemesSchema = Schema.Literals(documentTypesScheme as [string, ...Array<string>]);

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

@@ -1,7 +1,9 @@
-import { Schema } from 'effect';
+import { Record, Schema } from 'effect';
 
 import { documentTypesTable } from '#/values/document-type.generated';
 
+const values = Record.values(documentTypesTable).flat();
+
 /**
  * @description Validates the value part of a PEPPOL document type identifier (the portion after the scheme prefix) against the known document type table.
  *
@@ -11,7 +13,4 @@ import { documentTypesTable } from '#/values/document-type.generated';
  *
  * @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 });
-}
+export const documentTypeValuesSchema = Schema.String.check(Schema.makeFilter((val: string) => values.includes(val as never)));