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

package/src/effect/values/index.ts

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

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

@@ -0,0 +1,26 @@
+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 function invoiceStatusCodeSchema(error?: string) {
+  const schema = Schema.Literals(invoiceStatusCodesKeys);
+  return error === undefined ? schema : schema.annotate({ message: error });
+}

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-code-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-code.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.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.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.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 });
+}

package/src/effect/values/payment-means-codes-schema.ts

@@ -0,0 +1,37 @@
+/**
+ * @module effect/values/payment-means-codes-schema
+ *
+ * Payment means codes as defined by UN/CEFACT UNCL4461.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4461/
+ */
+
+import { Schema } from 'effect';
+
+import type { PaymentMeansCodesKeys } from '#/values/payment-means-codes.generated';
+
+import { paymentMeansCodesKeys } from '#/values/payment-means-codes.generated';
+
+/**
+ * @description A payment means code as defined by the PEPPOL subset of UNCL 4461.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4461/
+ */
+export type PeppolPaymentMeansCode = PaymentMeansCodesKeys;
+
+/**
+ * @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.
+ *
+ * @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/
+ */
+export function paymentMeansCodeSchema(error?: string) {
+  const schema = Schema.Literals(paymentMeansCodesKeys);
+  return error === undefined ? schema : schema.annotate({ message: error });
+}

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

@@ -0,0 +1,26 @@
+import { Schema } from 'effect';
+
+import type { PeppolDocumentType } from '#/effect/values/document-type-schema';
+
+import { processSchema } from '#/effect/values/process-schema';
+import { documentTypesProcessIds } from '#/values/document-type.generated';
+
+/**
+ * @description Validates a business process identifier (`<scheme>::<value>`) against the processes allowed for a given document type.
+ *
+ * @param documentType - The PEPPOL document type scheme whose allowed processes should be used.
+ * @param error - The custom error message to use when validation fails. Defaults to `'invalid process type for document type'`.
+ *
+ * @returns An Effect schema that matches only processes allowed for the given document type.
+ *
+ * @see {@link processSchema}
+ * @see {@link documentTypesProcessIds}
+ */
+export function processFromDocumentTypeSchema(documentType: PeppolDocumentType, error = 'invalid process type for document type') {
+  const allowed = documentTypesProcessIds[documentType as keyof typeof documentTypesProcessIds];
+  if (allowed === undefined) {
+    return processSchema(error);
+  }
+  const values = allowed.map(p => `${p.scheme}::${p.value}`);
+  return Schema.String.check(Schema.makeFilter((val: string) => values.includes(val as never))).annotate({ message: error });
+}

package/src/effect/values/process-schema.ts

@@ -0,0 +1,32 @@
+import { Schema } from 'effect';
+
+import type { ProcessesKeys } from '#/values/processes.generated';
+
+import { processes } from '#/values/processes.generated';
+
+/**
+ * @description A PEPPOL business process identifier key as defined by the processes codelist.
+ *
+ * @see {@link processes}
+ */
+export type PeppolProcesses = `${ProcessesKeys}::${string}`;
+
+/**
+ * @description Validates a full PEPPOL business process identifier (`<scheme>::<value>`) against the known processes.
+ *
+ * @param error - The custom error message to use when validation fails. Defaults to `'invalid peppol process identifier'`.
+ *
+ * @returns An Effect schema that matches a valid `scheme::value` process identifier.
+ *
+ * @see {@link processes}
+ */
+export function processSchema(error = 'invalid peppol process identifier') {
+  return Schema.String.check(
+    Schema.makeFilter((val: string) => {
+      const [prefix, suffix] = val.split('::');
+      if (prefix === undefined || suffix === undefined) return false;
+      const info = processes[prefix as ProcessesKeys];
+      return info !== undefined && info.some(v => v === suffix);
+    })
+  ).annotate({ message: error });
+}

package/src/effect/values/process-xml-identifier-schema.ts

@@ -0,0 +1,21 @@
+import { Schema } from 'effect';
+
+import { processes } from '#/values/processes.generated';
+
+function processXmlMember(scheme: string, values: Array<string>) {
+  return Schema.Struct({ '#text': Schema.String.check(Schema.makeFilter((val: string) => values.includes(val))), '@scheme': Schema.Literal(scheme) });
+}
+
+/**
+ * @description Validates a raw XML process identifier object with `#text` and `@scheme` fields against the known processes.
+ *
+ * @param error - The custom error message to use when validation fails. Defaults to `'invalid Peppol document identifier'`.
+ *
+ * @returns An Effect union schema accepting objects whose `#text` value is valid for the given `@scheme`.
+ *
+ * @see {@link processes}
+ */
+export function processXmlIdentifierSchema(error: string = 'invalid Peppol document identifier') {
+  const members = Object.entries(processes).map(([scheme, values]) => processXmlMember(scheme, values));
+  return Schema.Union(members as [(typeof members)[number], ...Array<(typeof members)[number]>]).annotate({ message: error });
+}

package/src/effect/values/quantity-unit-codes-schema.ts

@@ -0,0 +1,29 @@
+import { Schema } from 'effect';
+
+import type { QuantityUnitCodesKeys } from '#/values/quantity-unit-codes.generated';
+
+import { quantityUnitCodesKeys } from '#/values/quantity-unit-codes.generated';
+
+/**
+ * @description A unit of measure code as defined by the PEPPOL subset of UN/ECE Recommendation 20.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNECERec20/
+ */
+export type PeppolQuantityUnitCode = QuantityUnitCodesKeys;
+
+/**
+ * @description Validates a unit of measure code against the PEPPOL subset of UN/ECE Recommendation 20.
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns An Effect schema that accepts only valid quantity unit codes.
+ *
+ * @validations
+ * - BR-CL-23: Unit of measure code MUST be a valid UN/ECE Rec 20 code.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNECERec20/
+ */
+export function quantityUnitCodesSchema(error?: string) {
+  const schema = Schema.Literals(quantityUnitCodesKeys);
+  return error === undefined ? schema : schema.annotate({ message: error });
+}

package/src/effect/values/vat-date-code.ts

@@ -0,0 +1,16 @@
+import { Schema } from 'effect';
+
+import type { VatDateCodesKeys } from '#/values/vat-dates.generated';
+
+import { vatDateCodesKeys } from '#/values/vat-dates.generated';
+
+export type PeppolVatDateCode = VatDateCodesKeys;
+
+/**
+ * @validations
+ * - PEPPOL-EN16931-CL006: Invoice period description code must be according to UNCL 2005 D.16B.
+ */
+export function vatDateCodeSchema(error?: string) {
+  const schema = Schema.Literals(vatDateCodesKeys);
+  return error === undefined ? schema : schema.annotate({ message: error });
+}

package/src/effect/values/vatex-code.ts

@@ -0,0 +1,29 @@
+import { Schema } from 'effect';
+
+import type { VatexCodesKeys } from '#/values/vatex-codes.generated';
+
+import { vatexCodesKeys } from '#/values/vatex-codes.generated';
+
+/**
+ * @description A VAT exemption reason code as defined by the CEF VATEX codelist.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/vatex/
+ */
+export type PeppolVatexCode = VatexCodesKeys;
+
+/**
+ * @description Validates a VAT exemption reason code against the CEF VATEX codelist.
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns An Effect schema that accepts only valid VAT exemption reason codes.
+ *
+ * @validations
+ * - BR-CL-22: VAT exemption reason code MUST be a valid CEF VATEX code.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/vatex/
+ */
+export function vatexCodeschema(error?: string) {
+  const schema = Schema.Literals(vatexCodesKeys);
+  return error === undefined ? schema : schema.annotate({ message: error });
+}

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

@@ -12,7 +12,7 @@ export const vatRegexSchema = z.union([
       if (!result.success) {
         const message = 'Invalid belgian vat number';
 
-        if (import.meta.env['DEV']) {
+        if (import.meta.env['DEV'] && !import.meta.env['TEST']) {
           console.log(`Validation ${result.actual} != ${result.expected}`);
           message.concat(`(Validation ${result.actual} != ${result.expected})`);
         }

package/dist/node_modules/.pnpm/type-fest@5.8.0/node_modules/type-fest/source/internal/object.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"object.d.ts","names":[],"sources":["../../../../../../../../node_modules/.pnpm/type-fest@5.8.0/node_modules/type-fest/source/internal/object.d.ts"],"x_google_ignoreList":[0],"mappings":";;;;;;;;;;;;KA8IY,aAAa,OAAO,YAAY,YAAY,UACvD,wBAAwB,kBAAkB,QAAQ,MAAM;;;;;;;;;;;;;;;;;;;;;KAsB7C,oBAAoB,SAAS,iCACvC,aAAa,SAAS,WAAU,KAAK,MAAM,MAAM,qBAAkB,KAAK,MAAM,MAAM,wBAAsB"}

package/dist/node_modules/.pnpm/type-fest@5.8.0/node_modules/type-fest/source/internal/type.d.ts

@@ -1,13 +0,0 @@
-import { Primitive } from "../primitive.js";
-//#region node_modules/.pnpm/type-fest@5.8.0/node_modules/type-fest/source/internal/type.d.ts
-/**
-Matches any primitive, `void`, `Date`, or `RegExp` value.
-*/
-type BuiltIns = Primitive | void | Date | RegExp;
-/**
-Matches non-recursive types.
-*/
-type NonRecursiveType = BuiltIns | Function | (new (...arguments_: any[]) => unknown) | Promise<unknown>;
-//#endregion
-export { BuiltIns, NonRecursiveType };
-//# sourceMappingURL=type.d.ts.map

package/dist/node_modules/.pnpm/type-fest@5.8.0/node_modules/type-fest/source/internal/type.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"type.d.ts","names":[],"sources":["../../../../../../../../node_modules/.pnpm/type-fest@5.8.0/node_modules/type-fest/source/internal/type.d.ts"],"x_google_ignoreList":[0],"mappings":";;;;;KAQY,WAAW,mBAAmB,OAAO;;;;KAKrC,mBAAmB,WAAW,oBAAoB,iCAAiC"}

package/dist/node_modules/.pnpm/type-fest@5.8.0/node_modules/type-fest/source/is-never.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"is-never.d.ts","names":[],"sources":["../../../../../../../node_modules/.pnpm/type-fest@5.8.0/node_modules/type-fest/source/is-never.d.ts"],"x_google_ignoreList":[0],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAqDY,QAAQ,MAAM"}

package/dist/node_modules/.pnpm/type-fest@5.8.0/node_modules/type-fest/source/keys-of-union.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"keys-of-union.d.ts","names":[],"sources":["../../../../../../../node_modules/.pnpm/type-fest@5.8.0/node_modules/type-fest/source/keys-of-union.d.ts"],"x_google_ignoreList":[0],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAuCY,YAAY;;MAEjB,oBAAoB,6BAA6B,aAAa"}

package/dist/node_modules/.pnpm/type-fest@5.8.0/node_modules/type-fest/source/primitive.d.ts

@@ -1,10 +0,0 @@
-//#region node_modules/.pnpm/type-fest@5.8.0/node_modules/type-fest/source/primitive.d.ts
-/**
-Matches any [primitive value](https://developer.mozilla.org/en-US/docs/Glossary/Primitive).
-
-@category Type
-*/
-type Primitive = null | undefined | string | number | boolean | symbol | bigint;
-//#endregion
-export { Primitive };
-//# sourceMappingURL=primitive.d.ts.map

package/dist/node_modules/.pnpm/type-fest@5.8.0/node_modules/type-fest/source/union-to-intersection.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"union-to-intersection.d.ts","names":[],"sources":["../../../../../../../node_modules/.pnpm/type-fest@5.8.0/node_modules/type-fest/source/union-to-intersection.d.ts"],"x_google_ignoreList":[0],"mappings":";;;;;;;;;;;;;;;;;;KAiBY,oBAAoB;;;;AAI/B;;;CAGI,kBAAkB;;;;;YAKX,0BAA0B;;AAEnC,eAAe"}