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

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,7 @@ 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 = typeof currencyCodeSchema.Type;
 
 /**
  * @description Validates an ISO 4217 currency code against the PEPPOL codelist.
@@ -30,7 +28,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)));

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

@@ -1,7 +1,5 @@
 import { Schema } from 'effect';
 
-import type { DutyTaxFeeCategoriesKeys } from '#/values/duty-tax-fee-categories.generated';
-
 import { dutyTaxFeeCategoriesKeys } from '#/values/duty-tax-fee-categories.generated';
 
 /**
@@ -9,7 +7,7 @@ import { dutyTaxFeeCategoriesKeys } from '#/values/duty-tax-fee-categories.gener
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5305/
  */
-export type PeppolDutyTaxFeeCategoryCode = DutyTaxFeeCategoriesKeys;
+export type PeppolDutyTaxFeeCategoryCode = typeof dutyTaxFeeCategorySchema.Type;
 
 /**
  * @description Validates a duty, tax or fee category code against the PEPPOL subset of UNCL 5305 (VAT category code).
@@ -23,7 +21,4 @@ export type PeppolDutyTaxFeeCategoryCode = DutyTaxFeeCategoriesKeys;
  *
  * @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 });
-}
+export const dutyTaxFeeCategorySchema = Schema.Literals(dutyTaxFeeCategoriesKeys).pipe(Schema.brand('PeppolDutyTaxFeeCategoryCode'));

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

@@ -7,8 +7,6 @@
  */
 import { Schema } from 'effect';
 
-import type { ElectronicAddressCodesKeys } from '#/values/eas-codes.generated';
-
 import { electronicAddressCodesKeys } from '#/values/eas-codes.generated';
 
 /**
@@ -16,7 +14,7 @@ import { electronicAddressCodesKeys } from '#/values/eas-codes.generated';
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/eas/
  */
-export type PeppolElectronicAddressCode = ElectronicAddressCodesKeys;
+export type PeppolElectronicAddressCode = typeof electronicCodesSchema.Type;
 
 /**
  * @description Validates an electronic address scheme (EAS) code against the PEPPOL Electronic Address Identifier Scheme codelist.
@@ -30,7 +28,4 @@ export type PeppolElectronicAddressCode = ElectronicAddressCodesKeys;
  *
  * @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 });
-}
+export const electronicCodesSchema = Schema.Literals(electronicAddressCodesKeys).pipe(Schema.brand('PeppolElectronicAddressCode'));

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

@@ -1,7 +1,5 @@
 import { Schema } from 'effect';
 
-import type { IcdCodesKeys } from '#/values/icd-codes.generated';
-
 import { icdCodesKeys } from '#/values/icd-codes.generated';
 
 /**
@@ -9,7 +7,7 @@ import { icdCodesKeys } from '#/values/icd-codes.generated';
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ICD/
  */
-export type PeppolIcdCode = IcdCodesKeys;
+export type PeppolIcdCode = typeof icdCodesSchema.Type;
 
 /**
  * @description Validates an ISO 6523 ICD code against the PEPPOL codelist.
@@ -23,6 +21,4 @@ export type PeppolIcdCode = IcdCodesKeys;
  *
  * @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 });
-}
+export const icdCodesSchema = Schema.Literals(icdCodesKeys).pipe(Schema.brand('PeppolIcdCode'));

package/src/effect/values/index.ts

@@ -22,7 +22,6 @@ 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

@@ -1,7 +1,5 @@
 import { Schema } from 'effect';
 
-import type { InvoiceStatusCodesKeys } from '#/values/invoice-status-codes.generated';
-
 import { invoiceStatusCodesKeys } from '#/values/invoice-status-codes.generated';
 
 /**
@@ -9,7 +7,7 @@ import { invoiceStatusCodesKeys } from '#/values/invoice-status-codes.generated'
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343-T111/
  */
-export type PeppolInvoiceStatusCodes = InvoiceStatusCodesKeys;
+export type PeppolInvoiceStatusCodes = typeof invoiceStatusCodeSchema.Type;
 
 /**
  * @description Validates an invoice status code against the PEPPOL subset of UNCL 4343 (T111).
@@ -20,4 +18,4 @@ export type PeppolInvoiceStatusCodes = InvoiceStatusCodesKeys;
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343-T111/
  */
-export const invoiceStatusCodeSchema = Schema.Literals(invoiceStatusCodesKeys);
+export const invoiceStatusCodeSchema = Schema.Literals(invoiceStatusCodesKeys).pipe(Schema.brand('PeppolInvoiceStatusCodes'));

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

@@ -1,7 +1,5 @@
 import { Schema } from 'effect';
 
-import type { InvoiceTypeCodesKeys } from '#/values/invoice-type-codes.generated';
-
 import { invoiceTypeCodesKeys } from '#/values/invoice-type-codes.generated';
 
 /**
@@ -9,7 +7,7 @@ import { invoiceTypeCodesKeys } from '#/values/invoice-type-codes.generated';
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-inv/
  */
-export type PeppolInvoiceTypeCode = InvoiceTypeCodesKeys;
+export type PeppolInvoiceTypeCode = typeof invoiceTypeCodeSchema.Type;
 
 /**
  * @description Validates an invoice type code against the PEPPOL subset of UNCL 1001 (invoice).
@@ -20,7 +18,4 @@ export type PeppolInvoiceTypeCode = InvoiceTypeCodesKeys;
  *
  * @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 });
-}
+export const invoiceTypeCodeSchema = Schema.Literals(invoiceTypeCodesKeys).pipe(Schema.brand('PeppolInvoiceTypeCode'));

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

@@ -1,7 +1,5 @@
 import { Schema } from 'effect';
 
-import type { ItemClassificationCodesKeys } from '#/values/item-classification-code.generated';
-
 import { itemClassificationCodesKeys } from '#/values/item-classification-code.generated';
 
 /**
@@ -9,7 +7,7 @@ import { itemClassificationCodesKeys } from '#/values/item-classification-code.g
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL7143/
  */
-export type PeppolItemClassificationCode = ItemClassificationCodesKeys;
+export type PeppolItemClassificationCode = typeof itemClassificationCodesSchema.Type;
 
 /**
  * @description Validates an item classification code against the PEPPOL subset of UNCL 7143.
@@ -23,7 +21,4 @@ export type PeppolItemClassificationCode = ItemClassificationCodesKeys;
  *
  * @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 });
-}
+export const itemClassificationCodesSchema = Schema.Literals(itemClassificationCodesKeys).pipe(Schema.brand('PeppolItemClassificationCode'));

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

@@ -1,7 +1,5 @@
 import { Schema } from 'effect';
 
-import type { MimeCodesKeys } from '#/values/mime-codes.generated';
-
 import { mimeCodesKeys } from '#/values/mime-codes.generated';
 
 /**
@@ -9,7 +7,7 @@ import { mimeCodesKeys } from '#/values/mime-codes.generated';
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/MimeCode/
  */
-export type PeppolMimeCode = MimeCodesKeys;
+export type PeppolMimeCode = typeof mimeCodesSchema.Type;
 
 /**
  * @description Validates a MIME media type against the PEPPOL MIME code list.
@@ -23,7 +21,6 @@ export type PeppolMimeCode = MimeCodesKeys;
  *
  * @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 });
-}
+export const mimeCodesSchema = Schema.Literals(mimeCodesKeys)
+  .pipe(Schema.brand('PeppolMimeCode'))
+  .annotate({ documentation: 'PEPPOL-EN16931-CL001: Mime code must be according to subset of IANA code list.' });

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

@@ -1,7 +1,5 @@
 import { Schema } from 'effect';
 
-import type { OpStatusActionKeys } from '#/values/op-status-action.generated';
-
 import { opStatusActionKeys } from '#/values/op-status-action.generated';
 
 /**
@@ -9,7 +7,7 @@ import { opStatusActionKeys } from '#/values/op-status-action.generated';
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/OPStatusAction/
  */
-export type PeppolOpStatusAction = OpStatusActionKeys;
+export type PeppolOpStatusAction = typeof opStatusActionSchema.Type;
 
 /**
  * @description Validates an OpenPeppol operation status action code against the OPStatusAction codelist.
@@ -20,7 +18,4 @@ export type PeppolOpStatusAction = OpStatusActionKeys;
  *
  * @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 });
-}
+export const opStatusActionSchema = Schema.Literals(opStatusActionKeys).pipe(Schema.brand('PeppolOpStatusAction'));