@endevops/peppol-schema 0.1.3 → 0.1.5

package/dist/validations.d.ts

@@ -1,54 +1,148 @@
 //#region src/peppol-validations/add-piva.d.ts
 /**
  * @description Helper function for calculating weighted sum for Italian PIVA validation.
+ *
+ * @example
+ *   ```ts
+ *   addPIVA('123', 0); // 8
+ *   ```;
+ *
+ * @param arg - The digit string to sum, processed one character at a time.
+ * @param pari - Parity flag toggled at each recursion; `1` maps the digit through the `0246813579` table, `0` keeps it as is.
+ *
+ * @returns The weighted sum, or `0` when `arg` contains a non-digit.
+ *
+ * @see {@link checkPIVA}
  */
 export declare function addPIVA(arg: string, pari: number): number;
 //#endregion
 //#region src/peppol-validations/check-cf.d.ts
 /**
  * @description Validates both 16 and 11 character Italian fiscal codes.
+ *
+ * @example
+ *   ```ts
+ *   checkCF('RSSMRA80A01H501U'); // true
+ *   ```;
+ *
+ * @param arg - The fiscal code to validate. Whitespace is normalised first.
+ *
+ * @returns `true` when the normalised code is a valid 16 character personal fiscal code or an 11 digit VAT code, otherwise `false`.
+ *
+ * @see {@link checkCF16}
  */
 export declare function checkCF(arg: string): boolean;
 //#endregion
 //#region src/peppol-validations/check-cf16.d.ts
 /**
  * @description Validates 16-character Italian fiscal codes.
+ *
+ * @example
+ *   ```ts
+ *   checkCF16('RSSMRA80A01H501U'); // true
+ *   ```;
+ *
+ * @param arg - The fiscal code to validate. Whitespace is normalised first.
+ *
+ * @returns `true` when the normalised code is 16 characters and matches `{6 letters}{2 digits}{letter}{2 digits}{letter}{3 digits}{letter}`,
+ *   otherwise `false`.
+ *
+ * @see {@link checkCF}
  */
 export declare function checkCF16(arg: string): boolean;
 //#endregion
 //#region src/peppol-validations/check-piva-se-it.d.ts
 /**
  * @description Validates Italian VAT numbers with IT prefix.
+ *
+ * @example
+ *   ```ts
+ *   checkPIVAseIT('IT00743110157'); // true
+ *   ```;
+ *
+ * @param arg - The VAT identifier including its two letter country prefix.
+ *
+ * @returns `true` when the prefix is not `IT`, or when the 11 digit Italian part passes {@link checkPIVA}; otherwise `false`.
+ *
+ * @see {@link checkPIVA}
  */
 export declare function checkPIVAseIT(arg: string): boolean;
 //#endregion
 //#region src/peppol-validations/check-piva.d.ts
 /**
  * @description Validates Italian VAT numbers (PIVA)
+ *
+ * @example
+ *   ```ts
+ *   checkPIVA('00743110157'); // 0
+ *   ```;
+ *
+ * @param arg - The Italian VAT number without the `IT` prefix.
+ *
+ * @returns `0` when valid, otherwise the non-zero remainder of {@link addPIVA}, or `1` when `arg` contains a non-digit.
+ *
+ * @see {@link addPIVA}
  */
 export declare function checkPIVA(arg: string): number;
 //#endregion
 //#region src/peppol-validations/check-se-orgnr.d.ts
 /**
  * @description Validates Swedish organization numbers (0007)
+ *
+ * @example
+ *   ```ts
+ *   checkSEOrgnr('5560160680'); // true
+ *   ```;
+ *
+ * @param number - The organization number to validate. Whitespace is normalised first.
+ *
+ * @returns `true` when the normalised number is 10 digits and its Luhn check digit matches, otherwise `false`.
  */
 export declare function checkSEOrgnr(number: string): boolean;
 //#endregion
 //#region src/peppol-validations/greek-tin-verification.d.ts
 /**
  * @description Greek TIN verification.
+ *
+ * @example
+ *   ```ts
+ *   greekTinVerification('123456783'); // true
+ *   ```;
+ *
+ * @param val - The nine digit Greek tax identification number.
+ *
+ * @returns `true` when the value is nine digits and the computed checksum matches the last digit, otherwise `false`.
  */
 export declare function greekTinVerification(val: string): boolean;
 //#endregion
 //#region src/peppol-validations/is-valid-abn.d.ts
 /**
  * @description Australian Business Number (ABN) validation.
+ *
+ * @example
+ *   ```ts
+ *   isValidABN('51 824 753 556'); // true
+ *   ```;
+ *
+ * @param val - The ABN to validate. Whitespace is normalised first.
+ *
+ * @returns `true` when the normalised value is 11 digits and the weighted checksum is divisible by 89, otherwise `false`.
  */
 export declare function isValidABN(val: string): boolean;
 //#endregion
 //#region src/peppol-validations/is-valid-gln.d.ts
 /**
  * @description [GLN](https://en.wikipedia.org/wiki/Global_Location_Number) check (GS1)
+ *
+ * @example
+ *   ```ts
+ *   isValidGLN('1234567890128'); // { success: true }
+ *   ```;
+ *
+ * @param val - The GLN to validate. Whitespace is stripped first.
+ *
+ * @returns `{ success: true }` when the computed check digit matches the last digit, otherwise `{ success: false, expected, actual }` with the
+ *   computed and supplied check digits.
  */
 export declare function isValidGLN(val: string): {
   success: true;
@@ -61,18 +155,47 @@ export declare function isValidGLN(val: string): {
 //#region src/peppol-validations/is-valid-iban.d.ts
 /**
  * @description IBAN validation using mod 97 algorithm.
+ *
+ * @example
+ *   ```ts
+ *   isValidIBAN('GB82 WEST 1234 5698 7654 32'); // true
+ *   ```;
+ *
+ * @param iban - The IBAN to validate, with or without spaces.
+ *
+ * @returns `true` when the normalised value matches the `{2 letters}{2 digits}{up to 30 alphanumerics}` shape and its mod 97 remainder is 1,
+ *   otherwise `false`.
  */
 export declare function isValidIBAN(iban: string): boolean;
 //#endregion
 //#region src/peppol-validations/is-valid-mod11.d.ts
 /**
  * @description Validates Norwegian organization numbers using mod11 algorithm.
+ *
+ * @example
+ *   ```ts
+ *   isValidMod11('923609016'); // true
+ *   ```;
+ *
+ * @param val - The organization number to validate. Whitespace is normalised first.
+ *
+ * @returns `true` when the normalised value is at least two digits and its mod 11 check digit matches, otherwise `false`.
  */
 export declare function isValidMod11(val: string): boolean;
 //#endregion
 //#region src/peppol-validations/is-valid-mod97-0208.d.ts
 /**
  * @description Belgian enterprise number validation (mod 97-0208)
+ *
+ * @example
+ *   ```ts
+ *   isValidMod97_0208('0123456749'); // { success: true }
+ *   ```;
+ *
+ * @param val - The enterprise number to validate. Whitespace is normalised first.
+ *
+ * @returns `{ success: true }` when the last two digits equal `97 - (first eight digits % 97)`, otherwise `{ success: false, expected, actual }` with
+ *   the computed and supplied check digits.
  */
 export declare function isValidMod97_0208(val: string): {
   success: true;
@@ -85,6 +208,15 @@ export declare function isValidMod97_0208(val: string): {
 //#region src/peppol-validations/luhn-check.d.ts
 /**
  * @description Luhn algorithm check (used for credit card validation)
+ *
+ * @example
+ *   ```ts
+ *   luhnCheck('4242424242424242'); // true
+ *   ```;
+ *
+ * @param number - The numeric string to check. Whitespace is normalised first.
+ *
+ * @returns `true` when the value contains only digits and its Luhn checksum is divisible by 10, otherwise `false`.
  */
 export declare function luhnCheck(number: string): boolean;
 //#endregion

package/dist/validations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validations.d.ts","names":[],"sources":["../src/peppol-validations/add-piva.ts","../src/peppol-validations/check-cf.ts","../src/peppol-validations/check-cf16.ts","../src/peppol-validations/check-piva-se-it.ts","../src/peppol-validations/check-piva.ts","../src/peppol-validations/check-se-orgnr.ts","../src/peppol-validations/greek-tin-verification.ts","../src/peppol-validations/is-valid-abn.ts","../src/peppol-validations/is-valid-gln.ts","../src/peppol-validations/is-valid-iban.ts","../src/peppol-validations/is-valid-mod11.ts","../src/peppol-validations/is-valid-mod97-0208.ts","../src/peppol-validations/luhn-check.ts"],"mappings":";;;;wBAKgB,QAAQ,aAAa;;;;;;wBCCrB,QAAQ;;;;;;wBCDR,UAAU;;;;;;wBCAV,cAAc;;;;;;wBCAd,UAAU;;;;;;wBCAV,aAAa;;;;;;wBCFb,qBAAqB;;;;;;wBCErB,WAAW;;;;;;wBCFX,WAAW;EAAgB;;EAAoB;EAAgB;EAAkB;;;;;;;wBCEjF,YAAY;;;;;;wBCAZ,aAAa;;;;;;wBCAb,kBAAkB;EAAgB;;EAAoB;EAAgB;EAAkB;;;;;;;wBCAxF,UAAU"}
+{"version":3,"file":"validations.d.ts","names":[],"sources":["../src/peppol-validations/add-piva.ts","../src/peppol-validations/check-cf.ts","../src/peppol-validations/check-cf16.ts","../src/peppol-validations/check-piva-se-it.ts","../src/peppol-validations/check-piva.ts","../src/peppol-validations/check-se-orgnr.ts","../src/peppol-validations/greek-tin-verification.ts","../src/peppol-validations/is-valid-abn.ts","../src/peppol-validations/is-valid-gln.ts","../src/peppol-validations/is-valid-iban.ts","../src/peppol-validations/is-valid-mod11.ts","../src/peppol-validations/is-valid-mod97-0208.ts","../src/peppol-validations/luhn-check.ts"],"mappings":";;;;;;;;;;;;;;;;wBAiBgB,QAAQ,aAAa;;;;;;;;;;;;;;;;;wBCArB,QAAQ;;;;;;;;;;;;;;;;;;wBCAR,UAAU;;;;;;;;;;;;;;;;;wBCDV,cAAc;;;;;;;;;;;;;;;;;wBCAd,UAAU;;;;;;;;;;;;;;;wBCFV,aAAa;;;;;;;;;;;;;;;wBCFb,qBAAqB;;;;;;;;;;;;;;;wBCErB,WAAW;;;;;;;;;;;;;;;;wBCDX,WAAW;EAAgB;;EAAoB;EAAgB;EAAkB;;;;;;;;;;;;;;;;;wBCEjF,YAAY;;;;;;;;;;;;;;;wBCDZ,aAAa;;;;;;;;;;;;;;;;wBCCb,kBAAkB;EAAgB;;EAAoB;EAAgB;EAAkB;;;;;;;;;;;;;;;;wBCDxF,UAAU"}

package/dist/validations.js

@@ -1,8 +1,17 @@
-import { n as normalizeSpace, t as isValidMod97_0208 } from "./is-valid-mod97-0208-CzMOXMO-.js";
-import { a as addPIVA, c as isValidGLN, d as isValidIBAN, i as checkPIVA, l as isValidMod11, n as checkSEOrgnr, o as checkCF, r as checkPIVAseIT, s as checkCF16, t as isValidABN, u as greekTinVerification } from "./is-valid-abn-160i38PG.js";
+import { n as normalizeSpace, t as isValidMod97_0208 } from "./is-valid-mod97-0208-CjR324eG.js";
+import { a as addPIVA, c as isValidGLN, d as isValidIBAN, i as checkPIVA, l as isValidMod11, n as checkSEOrgnr, o as checkCF, r as checkPIVAseIT, s as checkCF16, t as isValidABN, u as greekTinVerification } from "./is-valid-abn-D7eSygBG.js";
 //#region src/peppol-validations/luhn-check.ts
 /**
 * @description Luhn algorithm check (used for credit card validation)
+*
+* @example
+*   ```ts
+*   luhnCheck('4242424242424242'); // true
+*   ```;
+*
+* @param number - The numeric string to check. Whitespace is normalised first.
+*
+* @returns `true` when the value contains only digits and its Luhn checksum is divisible by 10, otherwise `false`.
 */
 function luhnCheck(number) {
 	const s = normalizeSpace(number);

package/dist/validations.js.map

@@ -1 +1 @@
-{"version":3,"file":"validations.js","names":[],"sources":["../src/peppol-validations/luhn-check.ts"],"sourcesContent":["import { normalizeSpace } from './normalize-space.ts';\n\n/**\n * @description Luhn algorithm check (used for credit card validation)\n */\nexport function luhnCheck(number: string): boolean {\n  const s = normalizeSpace(number);\n  if (!/^\\d+$/.test(s)) return false;\n  let sum = 0;\n  let dbl = false;\n  for (let i = s.length - 1; i >= 0; i -= 1) {\n    let n = s.charCodeAt(i) - 48;\n    if (dbl) {\n      n *= 2;\n      if (n > 9) n -= 9;\n    }\n    sum += n;\n    dbl = !dbl;\n  }\n  return sum % 10 === 0;\n}\n"],"mappings":";;;;;;AAKA,SAAgB,UAAU,QAAyB;CACjD,MAAM,IAAI,eAAe,MAAM;CAC/B,IAAI,CAAC,QAAQ,KAAK,CAAC,GAAG,OAAO;CAC7B,IAAI,MAAM;CACV,IAAI,MAAM;CACV,KAAK,IAAI,IAAI,EAAE,SAAS,GAAG,KAAK,GAAG,KAAK,GAAG;EACzC,IAAI,IAAI,EAAE,WAAW,CAAC,IAAI;EAC1B,IAAI,KAAK;GACP,KAAK;GACL,IAAI,IAAI,GAAG,KAAK;EAClB;EACA,OAAO;EACP,MAAM,CAAC;CACT;CACA,OAAO,MAAM,OAAO;AACtB"}
+{"version":3,"file":"validations.js","names":[],"sources":["../src/peppol-validations/luhn-check.ts"],"sourcesContent":["import { normalizeSpace } from './normalize-space.ts';\n\n/**\n * @description Luhn algorithm check (used for credit card validation)\n *\n * @example\n *   ```ts\n *   luhnCheck('4242424242424242'); // true\n *   ```;\n *\n * @param number - The numeric string to check. Whitespace is normalised first.\n *\n * @returns `true` when the value contains only digits and its Luhn checksum is divisible by 10, otherwise `false`.\n */\nexport function luhnCheck(number: string): boolean {\n  const s = normalizeSpace(number);\n  if (!/^\\d+$/.test(s)) return false;\n  let sum = 0;\n  let dbl = false;\n  for (let i = s.length - 1; i >= 0; i -= 1) {\n    let n = s.charCodeAt(i) - 48;\n    if (dbl) {\n      n *= 2;\n      if (n > 9) n -= 9;\n    }\n    sum += n;\n    dbl = !dbl;\n  }\n  return sum % 10 === 0;\n}\n"],"mappings":";;;;;;;;;;;;;;;AAcA,SAAgB,UAAU,QAAyB;CACjD,MAAM,IAAI,eAAe,MAAM;CAC/B,IAAI,CAAC,QAAQ,KAAK,CAAC,GAAG,OAAO;CAC7B,IAAI,MAAM;CACV,IAAI,MAAM;CACV,KAAK,IAAI,IAAI,EAAE,SAAS,GAAG,KAAK,GAAG,KAAK,GAAG;EACzC,IAAI,IAAI,EAAE,WAAW,CAAC,IAAI;EAC1B,IAAI,KAAK;GACP,KAAK;GACL,IAAI,IAAI,GAAG,KAAK;EAClB;EACA,OAAO;EACP,MAAM,CAAC;CACT;CACA,OAAO,MAAM,OAAO;AACtB"}

package/dist/values.d.ts

@@ -1,4 +1,3 @@
-import { a as applicationResponseTypeCodes, c as creditNoteTypeCodes, i as ApplicationResponseTypeCodesKeys, l as creditNoteTypeCodesKeys, n as vatDateCodes, o as applicationResponseTypeCodesKeys, r as vatDateCodesKeys, s as CreditNoteTypeCodesKeys, t as VatDateCodesKeys } from "./vat-dates.generated-CxFvt7m3.js";
 import { n as invoiceStatusCodes, r as invoiceStatusCodesKeys, t as InvoiceStatusCodesKeys } from "./invoice-status-codes.generated-DL-agLdx.js";
 //#region src/values/additional-document-reference-codes.generated.d.ts
 /**
@@ -44,6 +43,28 @@ export type AllowanceChargeReasonCodesKeys = '41' | '42' | '60' | '62' | '63' |
  */
 export declare const allowanceChargeReasonCodesKeys: [string, ...string[]];
 //#endregion
+//#region src/values/application-response-type-codes.generated.d.ts
+/**
+ * @version D.17A
+ *
+ * @category Peppol Values
+ *
+ * @title Application Response type code (UNCL4343 Subset)
+ *
+ * @enum
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343/
+ */
+export declare const applicationResponseTypeCodes: Record<ApplicationResponseTypeCodesKeys, string>;
+/**
+ * @description Keys of {@link applicationResponseTypeCodes}.
+ */
+export type ApplicationResponseTypeCodesKeys = 'AB' | 'AP' | 'RE';
+/**
+ * @description Keys of {@link applicationResponseTypeCodes}.
+ */
+export declare const applicationResponseTypeCodesKeys: readonly ['AB', 'AP', 'RE'];
+//#endregion
 //#region src/values/charge-reason-codes.generated.d.ts
 /**
  * @version D.16B
@@ -88,6 +109,28 @@ export type CountryCodesKeys = 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' |
  */
 export declare const countryCodesKeys: [string, ...string[]];
 //#endregion
+//#region src/values/credit-notes-type-codes.generated.d.ts
+/**
+ * @version D.16B
+ *
+ * @category Peppol Values
+ *
+ * @title Credit note type code (UNCL1001 subset)
+ *
+ * @enum
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-cn/
+ */
+export declare const creditNoteTypeCodes: Record<CreditNoteTypeCodesKeys, string>;
+/**
+ * @description Keys of {@link creditNoteTypeCodes}.
+ */
+export type CreditNoteTypeCodesKeys = '81' | '83' | '381' | '396' | '532';
+/**
+ * @description Keys of {@link creditNoteTypeCodes}.
+ */
+export declare const creditNoteTypeCodesKeys: readonly ['81', '83', '381', '396', '532'];
+//#endregion
 //#region src/values/currency-code.generated.d.ts
 /**
  * @version 2018-01-01
@@ -420,6 +463,28 @@ export type QuantityUnitCodesKeys = '10' | '11' | '13' | '14' | '15' | '20' | '2
  */
 export declare const quantityUnitCodesKeys: [string, ...string[]];
 //#endregion
+//#region src/values/vat-dates.generated.d.ts
+/**
+ * @version D.16B
+ *
+ * @category Peppol Values
+ *
+ * @title VAT date code (UNCL2005 subset)
+ *
+ * @enum
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL2005/
+ */
+export declare const vatDateCodes: Record<VatDateCodesKeys, string>;
+/**
+ * @description Keys of {@link vatDateCodes}.
+ */
+export type VatDateCodesKeys = '3' | '35' | '432';
+/**
+ * @description Keys of {@link vatDateCodes}.
+ */
+export declare const vatDateCodesKeys: readonly ['3', '35', '432'];
+//#endregion
 //#region src/values/vatex-codes.generated.d.ts
 /**
  * @category Peppol Values
@@ -440,5 +505,5 @@ export type VatexCodesKeys = 'VATEX-EU-79-C' | 'VATEX-EU-132' | 'VATEX-EU-132-1A
  */
 export declare const vatexCodesKeys: [string, ...string[]];
 //#endregion
-export { ApplicationResponseTypeCodesKeys, CreditNoteTypeCodesKeys, InvoiceStatusCodesKeys, VatDateCodesKeys, applicationResponseTypeCodes, applicationResponseTypeCodesKeys, creditNoteTypeCodes, creditNoteTypeCodesKeys, invoiceStatusCodes, invoiceStatusCodesKeys, vatDateCodes, vatDateCodesKeys };
+export { InvoiceStatusCodesKeys, invoiceStatusCodes, invoiceStatusCodesKeys };
 //# sourceMappingURL=values.d.ts.map

package/dist/values.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"values.d.ts","names":[],"sources":["../src/values/additional-document-reference-codes.generated.ts","../src/values/allowance-charge-reason-codes.generated.ts","../src/values/charge-reason-codes.generated.ts","../src/values/country-code.generated.ts","../src/values/currency-code.generated.ts","../src/values/document-type-codes.generated.ts","../src/values/document-type.generated.ts","../src/values/duty-tax-fee-categories.generated.ts","../src/values/eas-codes.generated.ts","../src/values/icd-codes.generated.ts","../src/values/invoice-type-codes.generated.ts","../src/values/item-classification-code.generated.ts","../src/values/mime-codes.generated.ts","../src/values/op-status-action.generated.ts","../src/values/op-status-reason.generated.ts","../src/values/participant-identifier-schemes.generated.ts","../src/values/payment-means-codes.generated.ts","../src/values/processes.generated.ts","../src/values/quantity-unit-codes.generated.ts","../src/values/vatex-codes.generated.ts"],"mappings":";;;;;;;;;;;;;;qBAca,kCAAkC,OAAO;;;;YAkvG1C;;;;qBAuzBC;;;;;;;;;;;;;;qBCziIA,4BAA4B,OAAO;;;;YA2CpC;;;;qBAwBC;;;;;;;;;;;;;;qBCnEA,mBAAmB,OAAO;;;;YA+sB3B;;;;qBAuLC;;;;;;;;;;;;;;qBCt4BA,cAAc,OAAO;;;;YA2ftB;;;;qBAgQC;;;;;;;;;;;;;;qBC3vBA,eAAe,OAAO;;;;YA2WvB;;;;qBAwLC;;;;;;;;;;;;;;qBCniBA,mBAAmB,OAAO;;;;YAmlG3B;;;;qBA6tBC;;;qBC3zHA,oBAAoB,OAAO,wBAAwB;;;;YA2UpD;;;;qBAKC;qBAEA;qBAEA,yBAAyB,eAAe;EAAQ;EAAgB;;qBAs5BhE;;;;qBAuUA;;;;;;;;;;;;;;qBCtiDA,sBAAsB,OAAO;;;;YAkD9B;;;;qBAKC;;;;;;;;;;;;qBCzDA,wBAAwB,OAAO;;;;YAkMhC;;;;qBAmGC;;;;;;;;;;;;qBCrSA,UAAU,OAAO;;;;YAqsClB;;;;qBAqPC;;;;;;;;;;;;;;qBCx7CA,kBAAkB,OAAO;;;;YAuH1B;;;;qBAgCC;;;;;;;;;;;;;;qBCvJA,yBAAyB,OAAO;;;;YAkvBjC;;;;qBA8LC;;;;;;;;;;;;;;qBCh7BA,WAAW,OAAO;;;;YAiBnB;;;;qBAWC;;;;;;;;;;;;;;qBC5BA,gBAAgB,OAAO;;;;YAkCxB;;;;qBAKC;;;;;;;;;;;;;;qBCvCA,gBAAgB,OAAO;;;;YA+DxB;;;;qBAKC;;;;;;;;;;;;qBCtEA,8BAA8B,OAAO;;;;YA4uCtC;;;;qBA8GC;qBA4GA,yCAAyC,eAAe,MAAM;;;;qBAkH9D;;;;;;;;;;;;;;qBCtjDA,mBAAmB,OAAO;;;;YAsW3B;;;;qBAyFC;;;;;;;;;;;;qBCjcA,WAAW,OAAO,eAAe;;;;YAoHlC;;;;qBAKC;qBAEA;qBAEA;;;;qBAmHA;;;;;;;;;;;;;;qBC9OA,mBAAmB,OAAO;;;;YA6yL3B;;;;qBAunEC;;;;;;;;;;;;qBCt6PA,YAAY,OAAO;;;;YAmWpB;;;;qBA6FC"}
+{"version":3,"file":"values.d.ts","names":[],"sources":["../src/values/additional-document-reference-codes.generated.ts","../src/values/allowance-charge-reason-codes.generated.ts","../src/values/application-response-type-codes.generated.ts","../src/values/charge-reason-codes.generated.ts","../src/values/country-code.generated.ts","../src/values/credit-notes-type-codes.generated.ts","../src/values/currency-code.generated.ts","../src/values/document-type-codes.generated.ts","../src/values/document-type.generated.ts","../src/values/duty-tax-fee-categories.generated.ts","../src/values/eas-codes.generated.ts","../src/values/icd-codes.generated.ts","../src/values/invoice-type-codes.generated.ts","../src/values/item-classification-code.generated.ts","../src/values/mime-codes.generated.ts","../src/values/op-status-action.generated.ts","../src/values/op-status-reason.generated.ts","../src/values/participant-identifier-schemes.generated.ts","../src/values/payment-means-codes.generated.ts","../src/values/processes.generated.ts","../src/values/quantity-unit-codes.generated.ts","../src/values/vat-dates.generated.ts","../src/values/vatex-codes.generated.ts"],"mappings":";;;;;;;;;;;;;qBAca,kCAAkC,OAAO;;;;YAkvG1C;;;;qBAuzBC;;;;;;;;;;;;;;qBCziIA,4BAA4B,OAAO;;;;YA2CpC;;;;qBAwBC;;;;;;;;;;;;;;qBCnEA,8BAA8B,OAAO;;;;YAWtC;;;;qBAKC;;;;;;;;;;;;;;qBChBA,mBAAmB,OAAO;;;;YA+sB3B;;;;qBAuLC;;;;;;;;;;;;;;qBCt4BA,cAAc,OAAO;;;;YA2ftB;;;;qBAgQC;;;;;;;;;;;;;;qBC3vBA,qBAAqB,OAAO;;;;YA0B7B;;;;qBAKC;;;;;;;;;;;;;;qBC/BA,eAAe,OAAO;;;;YA2WvB;;;;qBAwLC;;;;;;;;;;;;;;qBCniBA,mBAAmB,OAAO;;;;YAmlG3B;;;;qBA6tBC;;;qBC3zHA,oBAAoB,OAAO,wBAAwB;;;;YA2UpD;;;;qBAKC;qBAEA;qBAEA,yBAAyB,eAAe;EAAQ;EAAgB;;qBAs5BhE;;;;qBAuUA;;;;;;;;;;;;;;qBCtiDA,sBAAsB,OAAO;;;;YAkD9B;;;;qBAKC;;;;;;;;;;;;qBCzDA,wBAAwB,OAAO;;;;YAkMhC;;;;qBAmGC;;;;;;;;;;;;qBCrSA,UAAU,OAAO;;;;YAqsClB;;;;qBAqPC;;;;;;;;;;;;;;qBCx7CA,kBAAkB,OAAO;;;;YAuH1B;;;;qBAgCC;;;;;;;;;;;;;;qBCvJA,yBAAyB,OAAO;;;;YAkvBjC;;;;qBA8LC;;;;;;;;;;;;;;qBCh7BA,WAAW,OAAO;;;;YAiBnB;;;;qBAWC;;;;;;;;;;;;;;qBC5BA,gBAAgB,OAAO;;;;YAkCxB;;;;qBAKC;;;;;;;;;;;;;;qBCvCA,gBAAgB,OAAO;;;;YA+DxB;;;;qBAKC;;;;;;;;;;;;qBCtEA,8BAA8B,OAAO;;;;YA4uCtC;;;;qBA8GC;qBA4GA,yCAAyC,eAAe,MAAM;;;;qBAkH9D;;;;;;;;;;;;;;qBCtjDA,mBAAmB,OAAO;;;;YAsW3B;;;;qBAyFC;;;;;;;;;;;;qBCjcA,WAAW,OAAO,eAAe;;;;YAoHlC;;;;qBAKC;qBAEA;qBAEA;;;;qBAmHA;;;;;;;;;;;;;;qBC9OA,mBAAmB,OAAO;;;;YA6yL3B;;;;qBAunEC;;;;;;;;;;;;;;qBCp6PA,cAAc,OAAO;;;;YAWtB;;;;qBAKC;;;;;;;;;;;;qBClBA,YAAY,OAAO;;;;YAmWpB;;;;qBA6FC"}

package/dist/xml.d.ts

@@ -1,5 +1,14 @@
 import { Effect } from "effect";
 //#region src/xml/builder-options.d.ts
+/**
+ * @description Default `fast-xml-builder` options for serialising PEPPOL documents: {@link commonXmlOptions} with `suppressEmptyNode` forced on.
+ *
+ * @example
+ *   ```ts
+ *   builderOptions.attributeNamePrefix; // '@'
+ *   builderOptions.suppressEmptyNode; // true
+ *   ```;
+ */
 export declare const builderOptions: {
   attributeNamePrefix: string;
   format: false;
@@ -18,9 +27,30 @@ export declare const builderOptions: {
 type XmlNode = any;
 //#endregion
 //#region src/xml/nodable-parser.d.ts
+/**
+ * @description Parses an XML string into an {@link XmlNode} tree with the nodable compact builder, coercing values and removing `@xmlns`.
+ *
+ * @example
+ *   ```ts
+ *   parseXmlNodable('<root xmlns="urn:x"><a>1</a></root>'); // { root: { a: 1 } }
+ *   ```;
+ *
+ * @param value - The XML document to parse.
+ *
+ * @returns The parsed {@link XmlNode} tree with `@xmlns` stripped.
+ */
 export declare function parseXmlNodable(value: string): XmlNode;
 //#endregion
 //#region src/xml/parser-options.d.ts
+/**
+ * @description Default `fast-xml-parser` options for parsing PEPPOL documents. Equal to {@link commonXmlOptions}.
+ *
+ * @example
+ *   ```ts
+ *   parserOptions.attributeNamePrefix; // '@'
+ *   parserOptions.ignoreAttributes; // false
+ *   ```;
+ */
 export declare const parserOptions: {
   attributeNamePrefix: string;
   format: false;

package/dist/xml.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"xml.d.ts","names":[],"sources":["../src/xml/builder-options.ts","../src/helpers/get-prop.ts","../src/xml/nodable-parser.ts","../src/xml/parser-options.ts"],"mappings":";;qBAIa;;;;;;;;;;;;;;;KCDD;;;wBCkBI,gBAAgB,gBAAgB;;;qBCjBnC"}
+{"version":3,"file":"xml.d.ts","names":[],"sources":["../src/xml/builder-options.ts","../src/helpers/get-prop.ts","../src/xml/nodable-parser.ts","../src/xml/parser-options.ts"],"mappings":";;;;;;;;;;;qBAaa;;;;;;;;;;;;;;;KCVD;;;;;;;;;;;;;;;wBC8BI,gBAAgB,gBAAgB;;;;;;;;;;;;qBCpBnC"}

package/dist/xml.js

@@ -1,5 +1,14 @@
-import { n as builderOptions, r as commonXmlOptions, t as parseXmlNodable } from "./nodable-parser-CyDZtLCK.js";
+import { n as builderOptions, r as commonXmlOptions, t as parseXmlNodable } from "./nodable-parser-CupS2H55.js";
 //#region src/xml/parser-options.ts
+/**
+* @description Default `fast-xml-parser` options for parsing PEPPOL documents. Equal to {@link commonXmlOptions}.
+*
+* @example
+*   ```ts
+*   parserOptions.attributeNamePrefix; // '@'
+*   parserOptions.ignoreAttributes; // false
+*   ```;
+*/
 const parserOptions = { ...commonXmlOptions };
 //#endregion
 export { builderOptions, parseXmlNodable, parserOptions };

package/dist/xml.js.map

@@ -1 +1 @@
-{"version":3,"file":"xml.js","names":[],"sources":["../src/xml/parser-options.ts"],"sourcesContent":["import type { X2jOptions } from 'fast-xml-parser';\n\nimport { commonXmlOptions } from '#/xml/common-xml-options.ts';\n\nexport const parserOptions = { ...commonXmlOptions } satisfies X2jOptions;\n"],"mappings":";;AAIA,MAAa,gBAAgB,EAAE,GAAG,iBAAiB"}
+{"version":3,"file":"xml.js","names":[],"sources":["../src/xml/parser-options.ts"],"sourcesContent":["import type { X2jOptions } from 'fast-xml-parser';\n\nimport { commonXmlOptions } from '#/xml/common-xml-options.ts';\n\n/**\n * @description Default `fast-xml-parser` options for parsing PEPPOL documents. Equal to {@link commonXmlOptions}.\n *\n * @example\n *   ```ts\n *   parserOptions.attributeNamePrefix; // '@'\n *   parserOptions.ignoreAttributes; // false\n *   ```;\n */\nexport const parserOptions = { ...commonXmlOptions } satisfies X2jOptions;\n"],"mappings":";;;;;;;;;;;AAaA,MAAa,gBAAgB,EAAE,GAAG,iBAAiB"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://raw.githubusercontent.com/SchemaStore/schemastore/refs/heads/master/src/schemas/json/package.json",
   "name": "@endevops/peppol-schema",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "TypeScript Effect Schema models for PEPPOL BIS Billing 3.0 — decode, validate and encode Invoice, Credit Note, Invoice Response and Message Level Response XML, with generated code lists, Schematron rules and identifier validations",
   "keywords": [
     "bis-billing",

package/src/constants/credit-note-doctype-id.ts

@@ -1,4 +1,13 @@
 import { documentScheme } from '#/constants/document-scheme.ts';
 
+/**
+ * @description PEPPOL document type identifier for a UBL CreditNote. It combines the {@link documentScheme} scheme with the UBL `CreditNote-2` root element, the EN
+ * 16931 / PEPPOL BIS Billing 3.0 customization id, and version 2.1. The document schema it identifies is {@link PeppolCreditNote}.
+ *
+ * @example
+ *   ```ts
+ *   CREDIT_NOTE_DOCTYPE_ID; // 'busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##...::2.1'
+ *   ```;
+ */
 export const CREDIT_NOTE_DOCTYPE_ID =
   `${documentScheme}::urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1` as const;

package/src/constants/credit-note-process-id.ts

@@ -1,3 +1,12 @@
 import { processScheme } from '#/constants/process-scheme.ts';
 
+/**
+ * @description PEPPOL business process identifier for the billing process used by credit notes. It combines the {@link processScheme} scheme with the
+ * `urn:fdc:peppol.eu:2017:poacc:billing:01:1.0` business process id, the same value used by {@link INVOICE_PROCESS_ID}.
+ *
+ * @example
+ *   ```ts
+ *   CREDIT_NOTE_PROCESS_ID; // 'cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0'
+ *   ```;
+ */
 export const CREDIT_NOTE_PROCESS_ID = `${processScheme}::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0` as const;

package/src/constants/document-scheme.ts

@@ -1 +1,10 @@
+/**
+ * @description Scheme id for PEPPOL document type identifiers. It forms the `<scheme>::` prefix of {@link INVOICE_DOCTYPE_ID}, {@link CREDIT_NOTE_DOCTYPE_ID},
+ * {@link INVOICE_RESPONSE_DOCTYPE_ID}, and {@link MESSAGE_LEVEL_RESPONSE_DOCTYPE_ID}.
+ *
+ * @example
+ *   ```ts
+ *   documentScheme; // 'busdox-docid-qns'
+ *   ```;
+ */
 export const documentScheme = 'busdox-docid-qns' as const;

package/src/constants/invoice-doctype-id.ts

@@ -1,4 +1,13 @@
 import { documentScheme } from '#/constants/document-scheme.ts';
 
+/**
+ * @description PEPPOL document type identifier for a UBL Invoice. It combines the {@link documentScheme} scheme with the UBL `Invoice-2` root element, the EN 16931
+ * / PEPPOL BIS Billing 3.0 customization id, and version 2.1. The document schema it identifies is {@link PeppolInvoice}.
+ *
+ * @example
+ *   ```ts
+ *   INVOICE_DOCTYPE_ID; // 'busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##...::2.1'
+ *   ```;
+ */
 export const INVOICE_DOCTYPE_ID =
   `${documentScheme}::urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1` as const;

package/src/constants/invoice-process-id.ts

@@ -1,3 +1,13 @@
 import { processScheme } from '#/constants/process-scheme.ts';
 
+/**
+ * @description PEPPOL business process identifier for the billing process. It combines the {@link processScheme} scheme with the
+ * `urn:fdc:peppol.eu:2017:poacc:billing:01:1.0` business process id, which is the `cbc:ProfileID` value defaulted by the billing document schemas
+ * such as {@link PeppolInvoice}.
+ *
+ * @example
+ *   ```ts
+ *   INVOICE_PROCESS_ID; // 'cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0'
+ *   ```;
+ */
 export const INVOICE_PROCESS_ID = `${processScheme}::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0` as const;

package/src/constants/invoice-response-doctype-id.ts

@@ -1,4 +1,14 @@
 import { documentScheme } from '#/constants/document-scheme.ts';
 
+/**
+ * @description PEPPOL document type identifier for a UBL ApplicationResponse carrying an invoice response. It combines the {@link documentScheme} scheme with the
+ * UBL `ApplicationResponse-2` root element, the `urn:fdc:peppol.eu:poacc:trns:invoice_response:3` customization id, and version 2.1. The document
+ * schema it identifies is {@link PeppolInvoiceResponse}.
+ *
+ * @example
+ *   ```ts
+ *   INVOICE_RESPONSE_DOCTYPE_ID; // 'busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::...::2.1'
+ *   ```;
+ */
 export const INVOICE_RESPONSE_DOCTYPE_ID =
   `${documentScheme}::urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::ApplicationResponse##urn:fdc:peppol.eu:poacc:trns:invoice_response:3::2.1` as const;

package/src/constants/invoice-response-process-id.ts

@@ -1,4 +1,13 @@
 import { INVOICE_RESPONSE_PROFILE_ID } from '#/constants/invoice-response-profile-id.ts';
 import { processScheme } from '#/constants/process-scheme.ts';
 
+/**
+ * @description PEPPOL business process identifier for the invoice response process. It combines the {@link processScheme} scheme with
+ * {@link INVOICE_RESPONSE_PROFILE_ID}, which is the `cbc:ProfileID` value fixed by {@link PeppolInvoiceResponse}.
+ *
+ * @example
+ *   ```ts
+ *   INVOICE_RESPONSE_PROCESS_ID; // 'cenbii-procid-ubl::urn:fdc:peppol.eu:poacc:bis:invoice_response:3'
+ *   ```;
+ */
 export const INVOICE_RESPONSE_PROCESS_ID = `${processScheme}::${INVOICE_RESPONSE_PROFILE_ID}` as const;

package/src/constants/invoice-response-profile-id.ts

@@ -1 +1,10 @@
+/**
+ * @description PEPPOL profile id for the invoice response, version 3. It is the `cbc:ProfileID` value fixed by {@link PeppolInvoiceResponse} and is matched when
+ * dispatching `ApplicationResponse` documents to that schema.
+ *
+ * @example
+ *   ```ts
+ *   INVOICE_RESPONSE_PROFILE_ID; // 'urn:fdc:peppol.eu:poacc:bis:invoice_response:3'
+ *   ```;
+ */
 export const INVOICE_RESPONSE_PROFILE_ID = 'urn:fdc:peppol.eu:poacc:bis:invoice_response:3' as const;

package/src/constants/message-level-response-doctype-id.ts

@@ -1,4 +1,14 @@
 import { documentScheme } from '#/constants/document-scheme.ts';
 
+/**
+ * @description PEPPOL document type identifier for a UBL ApplicationResponse carrying a message level response. It combines the {@link documentScheme} scheme with
+ * the UBL `ApplicationResponse-2` root element, the `urn:fdc:peppol.eu:poacc:trns:mlr:3` customization id, and version 2.1. The document schema it
+ * identifies is {@link PeppolMessageLevelResponse}.
+ *
+ * @example
+ *   ```ts
+ *   MESSAGE_LEVEL_RESPONSE_DOCTYPE_ID; // 'busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::...::2.1'
+ *   ```;
+ */
 export const MESSAGE_LEVEL_RESPONSE_DOCTYPE_ID =
   `${documentScheme}::urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::ApplicationResponse##urn:fdc:peppol.eu:poacc:trns:mlr:3::2.1` as const;

package/src/constants/message-level-response-process-id.ts

@@ -1,4 +1,13 @@
 import { MESSAGE_LEVEL_RESPONSE_PROFILE_ID } from '#/constants/message-level-response-profile-id.ts';
 import { processScheme } from '#/constants/process-scheme.ts';
 
+/**
+ * @description PEPPOL business process identifier for the message level response process. It combines the {@link processScheme} scheme with
+ * {@link MESSAGE_LEVEL_RESPONSE_PROFILE_ID}, which is the `cbc:ProfileID` value fixed by {@link PeppolMessageLevelResponse}.
+ *
+ * @example
+ *   ```ts
+ *   MESSAGE_LEVEL_RESPONSE_PROCESS_ID; // 'cenbii-procid-ubl::urn:fdc:peppol.eu:poacc:bis:mlr:3'
+ *   ```;
+ */
 export const MESSAGE_LEVEL_RESPONSE_PROCESS_ID = `${processScheme}::${MESSAGE_LEVEL_RESPONSE_PROFILE_ID}` as const;

package/src/constants/message-level-response-profile-id.ts

@@ -1 +1,10 @@
+/**
+ * @description PEPPOL profile id for the message level response, version 3. It is the `cbc:ProfileID` value fixed by {@link PeppolMessageLevelResponse} and is
+ * matched when dispatching `ApplicationResponse` documents to that schema.
+ *
+ * @example
+ *   ```ts
+ *   MESSAGE_LEVEL_RESPONSE_PROFILE_ID; // 'urn:fdc:peppol.eu:poacc:bis:mlr:3'
+ *   ```;
+ */
 export const MESSAGE_LEVEL_RESPONSE_PROFILE_ID = 'urn:fdc:peppol.eu:poacc:bis:mlr:3' as const;

package/src/constants/participant-scheme.ts

@@ -1,5 +1,15 @@
+/**
+ * @description Scheme id for ISO 6523 actor identifiers, used to qualify PEPPOL participant and endpoint identifiers.
+ *
+ * @example
+ *   ```ts
+ *   PARTICIPANT_SCHEME; // 'iso6523-actorid-upis'
+ *   ```;
+ */
 export const PARTICIPANT_SCHEME = 'iso6523-actorid-upis' as const;
 /**
+ * @description Deprecated alias of {@link PARTICIPANT_SCHEME}.
+ *
  * @deprecated use `PARTICIPANT_SCHEME` instead.
  */
 export const participantScheme = PARTICIPANT_SCHEME;

package/src/constants/process-scheme.ts

@@ -1 +1,10 @@
+/**
+ * @description Process scheme id for PEPPOL UBL business process identifiers. It forms the `<scheme>::` prefix of {@link INVOICE_PROCESS_ID},
+ * {@link CREDIT_NOTE_PROCESS_ID}, {@link INVOICE_RESPONSE_PROCESS_ID}, and {@link MESSAGE_LEVEL_RESPONSE_PROCESS_ID}.
+ *
+ * @example
+ *   ```ts
+ *   processScheme; // 'cenbii-procid-ubl'
+ *   ```;
+ */
 export const processScheme = 'cenbii-procid-ubl' as const;

package/src/constants/transport-profile.ts

@@ -1,5 +1,15 @@
+/**
+ * @description PEPPOL AS4 transport profile identifier for transport profile version 2.0.
+ *
+ * @example
+ *   ```ts
+ *   TRANSPORT_PROFILE; // 'peppol-transport-as4-v2_0'
+ *   ```;
+ */
 export const TRANSPORT_PROFILE = 'peppol-transport-as4-v2_0' as const;
 /**
+ * @description Deprecated alias of {@link TRANSPORT_PROFILE}.
+ *
  * @deprecated
  */
 export const transportProfile = TRANSPORT_PROFILE;