@endevops/peppol-schema 0.1.3 → 0.1.5

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

@@ -1,23 +1,17 @@
 import { Schema } from 'effect';
 
-import type { CreditNoteTypeCodesKeys } from '#/values/credit-notes-type-codes.generated';
-
+import { opaque } from '#/schemas/utils/opaque.ts';
 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.
+ * @description A credit note type code from the PEPPOL subset of UNCL 1001 (credit note).
  *
- * @returns An Effect schema that accepts only valid credit note type codes.
+ * @example
+ *   ```ts
+ *   '81';
+ *   ```;
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-cn/
+ * @see {@link creditNoteTypeCodesKeys}
  */
-export const creditNoteTypeCodeSchema = Schema.Literals(creditNoteTypeCodesKeys);
+export class PeppolCreditNoteTypeCode extends opaque<PeppolCreditNoteTypeCode>()(Schema.Literals(creditNoteTypeCodesKeys)) {}

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

@@ -7,31 +7,28 @@
 
 import { Schema } from 'effect';
 
+import { opaque } from '#/schemas/utils/opaque.ts';
 import { currencyCodesKeys } from '#/values/currency-code.generated';
 
 /**
- * @description An ISO 4217 currency code as defined by the PEPPOL subset.
+ * @description An ISO 4217 currency code from the PEPPOL codelist.
  *
- * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/
- */
-export type PeppolCurrencyCode = Schema.Schema.Type<typeof currencyCodeSchema>;
-/**
- * @description An ISO 4217 currency code as defined by the PEPPOL subset.
+ * @example
+ *   ```ts
+ *   'AED';
+ *   ```;
+ *
+ * @validations
+ * - PEPPOL-EN16931-CL007: Currency codes MUST be valid ISO 4217 codes.
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/
+ * @see {@link currencyCodesKeys}
  */
-export type PeppolCurrencyCodeEncoded = Schema.Codec.Encoded<typeof currencyCodeSchema>;
+export class PeppolCurrencyCode extends opaque<PeppolCurrencyCode>()(Schema.Literals(currencyCodesKeys).pipe(Schema.brand('PeppolCurrencyCode'))) {}
 
 /**
- * @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.
+ * @description An ISO 4217 currency code as defined by the PEPPOL subset.
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/
  */
-export const currencyCodeSchema = Schema.Literals(currencyCodesKeys).pipe(Schema.brand('PeppolCurrencyCode'));
+export type PeppolCurrencyCodeEncoded = Schema.Codec.Encoded<typeof PeppolCurrencyCode>;

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

@@ -1,14 +1,18 @@
 import { Schema } from 'effect';
 
+import { opaque } from '#/schemas/utils/opaque.ts';
 import { documentTypesScheme } from '#/values/document-type.generated';
 
 /**
- * @description Validates a PEPPOL document type scheme (e.g. `busdox-docid-qns`, `peppol-doctype-wildcard`).
+ * @description A PEPPOL document type scheme, for example `busdox-docid-qns` or `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.
+ * @example
+ *   ```ts
+ *   'busdox-docid-qns';
+ *   ```;
  *
  * @see {@link documentTypesScheme}
  */
-export const documentTypeSchemesSchema = Schema.Literals(documentTypesScheme as [string, ...Array<string>]);
+export class PeppolDocumentTypeScheme extends opaque<PeppolDocumentTypeScheme>()(
+  Schema.Literals(documentTypesScheme as [string, ...Array<string>])
+) {}

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

@@ -1,16 +1,15 @@
 import { Record, Schema } from 'effect';
 
+import { opaque } from '#/schemas/utils/opaque.ts';
 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.
- *
- * @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.
+ * @description The value part of a PEPPOL document type identifier (the portion after the scheme prefix) from the known document type table.
  *
  * @see {@link documentTypesTable}
  */
-export const documentTypeValuesSchema = Schema.String.check(Schema.makeFilter((val: string) => values.includes(val as never)));
+export class PeppolDocumentTypeValue extends opaque<PeppolDocumentTypeValue>()(
+  Schema.String.check(Schema.makeFilter((val: string) => values.includes(val as never)))
+) {}

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

@@ -1,25 +1,27 @@
 import { Schema } from 'effect';
 
+import { opaque } from '#/schemas/utils/opaque.ts';
 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).
+ * @description A duty, tax or fee category code from the PEPPOL subset of UNCL 5305 (VAT category code).
  *
- * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5305/
- */
-export type PeppolDutyTaxFeeCategoryCode = typeof peppolDutyTaxFeeCategorySchema.Type;
-export type PeppolDutyTaxFeeCategoryCodeEncoded = typeof peppolDutyTaxFeeCategorySchema.Encoded;
-
-/**
- * @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.
+ * @example
+ *   ```ts
+ *   'AE';
+ *   ```;
  *
  * @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/
+ * @see {@link dutyTaxFeeCategoriesKeys}
+ */
+export class PeppolDutyTaxFeeCategoryCode extends opaque<PeppolDutyTaxFeeCategoryCode>()(
+  Schema.Literals(dutyTaxFeeCategoriesKeys).pipe(Schema.brand('PeppolDutyTaxFeeCategoryCode'))
+) {}
+
+/**
+ * @description The encoded form of {@link PeppolDutyTaxFeeCategoryCode}, a string literal union.
  */
-export const peppolDutyTaxFeeCategorySchema = Schema.Literals(dutyTaxFeeCategoriesKeys).pipe(Schema.brand('PeppolDutyTaxFeeCategoryCode'));
+export type PeppolDutyTaxFeeCategoryCodeEncoded = Schema.Codec.Encoded<typeof PeppolDutyTaxFeeCategoryCode>;

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

@@ -7,25 +7,23 @@
  */
 import { Schema } from 'effect';
 
+import { opaque } from '#/schemas/utils/opaque.ts';
 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).
+ * @description An electronic address scheme (EAS) code from the PEPPOL Electronic Address Identifier Scheme codelist.
  *
- * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/eas/
- */
-export type PeppolElectronicAddressCode = typeof electronicCodesSchema.Type;
-
-/**
- * @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.
+ * @example
+ *   ```ts
+ *   '0002';
+ *   ```;
  *
  * @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/
+ * @see {@link electronicAddressCodesKeys}
  */
-export const electronicCodesSchema = Schema.Literals(electronicAddressCodesKeys).pipe(Schema.brand('PeppolElectronicAddressCode'));
+export class PeppolElectronicAddressCode extends opaque<PeppolElectronicAddressCode>()(
+  Schema.Literals(electronicAddressCodesKeys).pipe(Schema.brand('PeppolElectronicAddressCode'))
+) {}

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

@@ -1,24 +1,20 @@
 import { Schema } from 'effect';
 
+import { opaque } from '#/schemas/utils/opaque.ts';
 import { icdCodesKeys } from '#/values/icd-codes.generated';
 
 /**
- * @description An ISO 6523 ICD (International Code Designator) code identifying an identifier scheme.
+ * @description An ISO 6523 ICD code from the PEPPOL codelist.
  *
- * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ICD/
- */
-export type PeppolIcdCode = typeof icdCodesSchema.Type;
-
-/**
- * @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.
+ * @example
+ *   ```ts
+ *   '0002';
+ *   ```;
  *
  * @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/
+ * @see {@link icdCodesKeys}
  */
-export const icdCodesSchema = Schema.Literals(icdCodesKeys).pipe(Schema.brand('PeppolIcdCode'));
+export class PeppolIcdCode extends opaque<PeppolIcdCode>()(Schema.Literals(icdCodesKeys).pipe(Schema.brand('PeppolIcdCode'))) {}

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

@@ -1,21 +1,19 @@
 import { Schema } from 'effect';
 
+import { opaque } from '#/schemas/utils/opaque.ts';
 import { invoiceStatusCodesKeys } from '#/values/invoice-status-codes.generated';
 
 /**
- * @description An invoice status code as defined by the PEPPOL subset of UNCL 4343 (T111).
+ * @description An invoice status code from the PEPPOL subset of UNCL 4343 (T111).
  *
- * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343-T111/
- */
-export type PeppolInvoiceStatusCodes = typeof invoiceStatusCodeSchema.Type;
-
-/**
- * @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.
+ * @example
+ *   ```ts
+ *   'AB';
+ *   ```;
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343-T111/
+ * @see {@link invoiceStatusCodesKeys}
  */
-export const invoiceStatusCodeSchema = Schema.Literals(invoiceStatusCodesKeys).pipe(Schema.brand('PeppolInvoiceStatusCodes'));
+export class PeppolInvoiceStatusCodes extends opaque<PeppolInvoiceStatusCodes>()(
+  Schema.Literals(invoiceStatusCodesKeys).pipe(Schema.brand('PeppolInvoiceStatusCodes'))
+) {}

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

@@ -1,21 +1,19 @@
 import { Schema } from 'effect';
 
+import { opaque } from '#/schemas/utils/opaque.ts';
 import { invoiceTypeCodesKeys } from '#/values/invoice-type-codes.generated';
 
 /**
- * @description An invoice type code as defined by the PEPPOL subset of UNCL 1001 (invoice).
+ * @description An invoice type code from the PEPPOL subset of UNCL 1001.
  *
- * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-inv/
- */
-export type PeppolInvoiceTypeCode = typeof invoiceTypeCodeSchema.Type;
-
-/**
- * @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.
+ * @example
+ *   ```ts
+ *   '71';
+ *   ```;
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-inv/
+ * @see {@link invoiceTypeCodesKeys}
  */
-export const invoiceTypeCodeSchema = Schema.Literals(invoiceTypeCodesKeys).pipe(Schema.brand('PeppolInvoiceTypeCode'));
+export class PeppolInvoiceTypeCode extends opaque<PeppolInvoiceTypeCode>()(
+  Schema.Literals(invoiceTypeCodesKeys).pipe(Schema.brand('PeppolInvoiceTypeCode'))
+) {}

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

@@ -1,24 +1,22 @@
 import { Schema } from 'effect';
 
+import { opaque } from '#/schemas/utils/opaque.ts';
 import { itemClassificationCodesKeys } from '#/values/item-classification-code.generated';
 
 /**
- * @description An item classification code as defined by the PEPPOL subset of UNCL 7143.
+ * @description An item classification code from the PEPPOL subset of UNCL 7143.
  *
- * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL7143/
- */
-export type PeppolItemClassificationCode = typeof itemClassificationCodesSchema.Type;
-
-/**
- * @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.
+ * @example
+ *   ```ts
+ *   'AA';
+ *   ```;
  *
  * @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/
+ * @see {@link itemClassificationCodesKeys}
  */
-export const itemClassificationCodesSchema = Schema.Literals(itemClassificationCodesKeys).pipe(Schema.brand('PeppolItemClassificationCode'));
+export class PeppolItemClassificationCode extends opaque<PeppolItemClassificationCode>()(
+  Schema.Literals(itemClassificationCodesKeys).pipe(Schema.brand('PeppolItemClassificationCode'))
+) {}

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

@@ -1,26 +1,24 @@
 import { Schema } from 'effect';
 
+import { opaque } from '#/schemas/utils/opaque.ts';
 import { mimeCodesKeys } from '#/values/mime-codes.generated';
 
 /**
- * @description A MIME media type code (e.g. `application/pdf`) as used for attached documents.
+ * @description A MIME media type from the PEPPOL MIME code list.
  *
- * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/MimeCode/
- */
-export type PeppolMimeCode = typeof mimeCodesSchema.Type;
-
-/**
- * @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.
+ * @example
+ *   ```ts
+ *   'text/csv';
+ *   ```;
  *
  * @validations
  * - PEPPOL-EN16931-CL001: Attachment (MIME) type MUST come from the allowed list.
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/MimeCode/
+ * @see {@link mimeCodesKeys}
  */
-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.' });
+export class PeppolMimeCode extends opaque<PeppolMimeCode>()(
+  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/schemas/values/op-status-action-schema.ts

@@ -1,21 +1,19 @@
 import { Schema } from 'effect';
 
+import { opaque } from '#/schemas/utils/opaque.ts';
 import { opStatusActionKeys } from '#/values/op-status-action.generated';
 
 /**
- * @description An OpenPeppol operation status action code (e.g. the outcome of a message response).
+ * @description An OpenPeppol operation status action code from the OPStatusAction codelist.
  *
- * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/OPStatusAction/
- */
-export type PeppolOpStatusAction = typeof opStatusActionSchema.Type;
-
-/**
- * @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.
+ * @example
+ *   ```ts
+ *   'NOA';
+ *   ```;
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/OPStatusAction/
+ * @see {@link opStatusActionKeys}
  */
-export const opStatusActionSchema = Schema.Literals(opStatusActionKeys).pipe(Schema.brand('PeppolOpStatusAction'));
+export class PeppolOpStatusAction extends opaque<PeppolOpStatusAction>()(
+  Schema.Literals(opStatusActionKeys).pipe(Schema.brand('PeppolOpStatusAction'))
+) {}

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

@@ -1,21 +1,19 @@
 import { Schema } from 'effect';
 
+import { opaque } from '#/schemas/utils/opaque.ts';
 import { opStatusReasonKeys } from '#/values/op-status-reason.generated';
 
 /**
- * @description An OpenPeppol operation status reason code (e.g. the reason for a message response outcome).
+ * @description An OpenPeppol operation status reason code from the OPStatusReason codelist.
  *
- * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/OPStatusReason/
- */
-export type PeppolOpStatusReason = typeof opStatusReasonSchema.Type;
-
-/**
- * @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.
+ * @example
+ *   ```ts
+ *   'NON';
+ *   ```;
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/OPStatusReason/
+ * @see {@link opStatusReasonKeys}
  */
-export const opStatusReasonSchema = Schema.Literals(opStatusReasonKeys).pipe(Schema.brand('PeppolOpStatusReason'));
+export class PeppolOpStatusReason extends opaque<PeppolOpStatusReason>()(
+  Schema.Literals(opStatusReasonKeys).pipe(Schema.brand('PeppolOpStatusReason'))
+) {}

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

@@ -1,21 +1,18 @@
 import { Schema } from 'effect';
 
+import { opaque } from '#/schemas/utils/opaque.ts';
 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).
+ * @description A PEPPOL participant identifier scheme from the participant identifier schemes codelist.
  *
- * @see https://docs.peppol.eu/poacc/billing/3.0/
- */
-export type PeppolParticipantIdentifierCode = typeof participantIdentifierCodeSchema.Type;
-
-/**
- * @description Validates a PEPPOL participant identifier scheme against the participant identifier schemes list.
- *
- * @param error - The custom error message to use when validation fails.
+ * @example
+ *   ```ts
+ *   '0002';
+ *   ```;
  *
- * @returns An Effect schema that accepts only valid participant identifier schemes.
+ * @see {@link participantIdentifierSchemesKeys}
  */
-export const participantIdentifierCodeSchema = Schema.Literals(participantIdentifierSchemesKeys).pipe(
-  Schema.brand('PeppolParticipantIdentifierCode')
-);
+export class PeppolParticipantIdentifierCode extends opaque<PeppolParticipantIdentifierCode>()(
+  Schema.Literals(participantIdentifierSchemesKeys).pipe(Schema.brand('PeppolParticipantIdentifierCode'))
+) {}

package/src/schemas/values/payment-means-code-schema.ts

@@ -8,25 +8,23 @@
 
 import { Schema } from 'effect';
 
+import { opaque } from '#/schemas/utils/opaque.ts';
 import { paymentMeansCodesKeys } from '#/values/payment-means-codes.generated';
 
 /**
- * @description A payment means code as defined by the PEPPOL subset of UNCL 4461.
+ * @description A payment means code from the PEPPOL subset of UNCL 4461.
  *
- * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4461/
- */
-export type PeppolPaymentMeansCode = typeof paymentMeansCodeSchema.Type;
-
-/**
- * @description Validates a payment means code against the PEPPOL subset of UNCL 4461.
- *
- * @param error - The custom error message to use when validation fails.
- *
- * @returns An Effect schema that accepts only valid payment means codes.
+ * @example
+ *   ```ts
+ *   '1';
+ *   ```;
  *
  * @validations
  * - BR-CL-16: Payment means code MUST be a valid UNCL 4461 code.
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4461/
+ * @see {@link paymentMeansCodesKeys}
  */
-export const paymentMeansCodeSchema = Schema.Literals(paymentMeansCodesKeys).pipe(Schema.brand('PeppolPaymentMeansCode'));
+export class PeppolPaymentMeansCodeValue extends opaque<PeppolPaymentMeansCodeValue>()(
+  Schema.Literals(paymentMeansCodesKeys).pipe(Schema.brand('PeppolPaymentMeansCodeValue'))
+) {}

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

@@ -12,19 +12,17 @@ import { Schema } from 'effect';
 import { countryCodesKeys } from '#/values/country-code.generated';
 
 /**
- * @description An ISO 3166-1 alpha-2 country code as defined by the PEPPOL subset.
+ * @description A two character ISO 3166-1 alpha-2 country code from the PEPPOL codelist. The literal union enforces the length.
  *
- * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO3166/
- */
-export type PeppolCountryCode = typeof peppolCountryCodeSchema.Type;
-
-/**
- * @description Validates a two character ISO 3166-1 alpha-2 country code against the PEPPOL codelist. All codes in the codelist are exactly 2 characters, so the
- * literals union implies the length check.
+ * @example
+ *   ```ts
+ *   'AD';
+ *   ```;
  *
  * @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/
+ * @see {@link countryCodesKeys}
  */
-export const peppolCountryCodeSchema = Schema.Literals(countryCodesKeys).pipe(Schema.brand('PeppolCountryCode'));
+export class PeppolCountryCodeValue extends Schema.Literals(countryCodesKeys).pipe(Schema.brand('PeppolCountryCodeValue')) {}

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

@@ -1,21 +1,19 @@
 import { Schema } from 'effect';
 
+import { opaque } from '#/schemas/utils/opaque.ts';
 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).
+ * @description A document type code from the PEPPOL subset of UNCL 1001.
  *
- * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001/
- */
-export type PeppolDocumentTypeCode = typeof peppolDocumentTypeCodeSchema.Type;
-
-/**
- * @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 An Effect schema that accepts only valid document type codes.
+ * @example
+ *   ```ts
+ *   '1';
+ *   ```;
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001/
+ * @see {@link documentTypeCodesKeys}
  */
-export const peppolDocumentTypeCodeSchema = Schema.Literals(documentTypeCodesKeys).pipe(Schema.brand('PeppolDocumentTypeCode'));
+export class PeppolDocumentTypeCode extends opaque<PeppolDocumentTypeCode>()(
+  Schema.Literals(documentTypeCodesKeys).pipe(Schema.brand('PeppolDocumentTypeCode'))
+) {}

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

@@ -2,30 +2,21 @@ import { Predicate, Schema } from 'effect';
 
 import type { DocumentTypesTableKeys } from '#/values/document-type.generated';
 
+import { opaque } from '#/schemas/utils/opaque.ts';
 import { documentTypesTable, documentTypesTableKeys } from '#/values/document-type.generated';
 
 /**
- * @description One of the PEPPOL document type schemes (e.g. `busdox-docid-qns`, `peppol-doctype-wildcard`).
+ * @description A full PEPPOL document type identifier in `<scheme>::<value>` form. The scheme prefix and value must both be known.
  *
  * @see {@link documentTypesTable}
  */
-export type PeppolDocumentType = typeof peppolDocumentTypeSchema.Type;
-
-/**
- * @description Validates a full PEPPOL document type identifier (`<scheme>::<value>`) against the known document type table. The scheme prefix must be a known key
- * and the full identifier must exist in the document type table (checked via a filter).
- *
- * @param error - The custom error message to use when validation fails. Defaults to `'invalid peppol document type'`.
- *
- * @returns An Effect schema that matches a valid `scheme::value` document type identifier.
- *
- * @see {@link documentTypesTable}
- */
-export const peppolDocumentTypeSchema = Schema.TemplateLiteral([Schema.Literals(documentTypesTableKeys), Schema.Literal('::'), Schema.String]).check(
-  Schema.makeFilter((val: string) => {
-    const [prefix, ...suffix] = val.split('::');
-    if (Predicate.isNullish(prefix) || !documentTypesTableKeys.includes(prefix as never)) return false;
-    const info = documentTypesTable[prefix as DocumentTypesTableKeys];
-    return Predicate.isNotNullish(info) && info.some(v => v === suffix.join('::'));
-  })
-);
+export class PeppolDocumentType extends opaque<PeppolDocumentType>()(
+  Schema.TemplateLiteral([Schema.Literals(documentTypesTableKeys), Schema.Literal('::'), Schema.String]).check(
+    Schema.makeFilter((val: string) => {
+      const [prefix, ...suffix] = val.split('::');
+      if (Predicate.isNullish(prefix) || !documentTypesTableKeys.includes(prefix as never)) return false;
+      const info = documentTypesTable[prefix as DocumentTypesTableKeys];
+      return Predicate.isNotNullish(info) && info.some(v => v === suffix.join('::'));
+    })
+  )
+) {}