@endevops/peppol-schema 0.1.2 → 0.1.4

package/README.md

@@ -16,9 +16,9 @@ Decode any PEPPOL document from an XML string (dispatches on the root element; `
 
 ```ts
 import { Schema } from 'effect';
-import { PeppolCreditNote, PeppolInvoice, PeppolInvoiceResponse, PeppolMessageLevelResponse, peppolDocumentSchema } from '@endevops/peppol-schema';
+import { PeppolCreditNote, PeppolDocumentSchema, PeppolInvoice, PeppolInvoiceResponse, PeppolMessageLevelResponse } from '@endevops/peppol-schema';
 
-const doc = Schema.decodeUnknownSync(peppolDocumentSchema)(xmlString);
+const doc = Schema.decodeUnknownSync(PeppolDocumentSchema)(xmlString);
 if (Schema.is(PeppolInvoice)(doc)) {
   /* doc.invoiceLines … */
 } else if (Schema.is(PeppolCreditNote)(doc)) {
@@ -30,7 +30,7 @@ if (Schema.is(PeppolInvoice)(doc)) {
 }
 
 // Round-trip back to XML:
-const xml = Schema.encodeUnknownSync(peppolDocumentSchema)(doc);
+const xml = Schema.encodeUnknownSync(PeppolDocumentSchema)(doc);
 ```
 
 Run the Schematron rule set or a single rule:
@@ -59,7 +59,7 @@ invoiceTypeCodes['380']; // 'Commercial invoice'
 
 ## Features
 
-- **4 document types**: Invoice, Credit Note, Invoice Response, Message Level Response (UBL 2.1, BIS Billing 3.0) with XML round-trip via `peppolDocumentSchema`
+- **4 document types**: Invoice, Credit Note, Invoice Response, Message Level Response (UBL 2.1, BIS Billing 3.0) with XML round-trip via `PeppolDocumentSchema`
 - **Effect Schema** models with typed decode/encode and `isPeppol*` type guards
 - **Generated code lists** (`/values`): currencies, countries, tax schemes, UNCL, UNTDID, EAS, ICD etc. from OpenPEPPOL
 - **Schematron rules** (`/schematron`): shared PEPPOL + CEN rules and per-country overlays (`de`, `dk`, `gr`, `is`, `it`, `nl`, `no`, `se`), runnable as an Effect service or one rule at a time
@@ -71,7 +71,7 @@ invoiceTypeCodes['380']; // 'Commercial invoice'
 
 | Import path                                      | Description                                              |
 | ------------------------------------------------ | -------------------------------------------------------- |
-| `@endevops/peppol-schema`                        | Document schemas, `peppolDocumentSchema`, types          |
+| `@endevops/peppol-schema`                        | Document schemas, `PeppolDocumentSchema`, types          |
 | `@endevops/peppol-schema/generate-translations`  | CLI that generates translation files                     |
 | `@endevops/peppol-schema/schematron`             | PEPPOL + CEN + per-country Schematron rules              |
 | `@endevops/peppol-schema/validations`            | Identifier and checksum validation rules                 |

package/dist/constants.d.ts

@@ -1,49 +1,180 @@
 //#region src/constants/credit-note-doctype-id.d.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 declare const CREDIT_NOTE_DOCTYPE_ID: "busdox-docid-qns::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";
 //#endregion
 //#region src/constants/credit-note-process-id.d.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 declare const CREDIT_NOTE_PROCESS_ID: "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0";
 //#endregion
 //#region src/constants/document-scheme.d.ts
+/**
+ * @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 declare const documentScheme: 'busdox-docid-qns';
 //#endregion
 //#region src/constants/invoice-doctype-id.d.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 declare const INVOICE_DOCTYPE_ID: "busdox-docid-qns::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";
 //#endregion
 //#region src/constants/invoice-process-id.d.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 declare const INVOICE_PROCESS_ID: "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0";
 //#endregion
 //#region src/constants/invoice-response-doctype-id.d.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 declare const INVOICE_RESPONSE_DOCTYPE_ID: "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::ApplicationResponse##urn:fdc:peppol.eu:poacc:trns:invoice_response:3::2.1";
 //#endregion
 //#region src/constants/invoice-response-process-id.d.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 declare const INVOICE_RESPONSE_PROCESS_ID: "cenbii-procid-ubl::urn:fdc:peppol.eu:poacc:bis:invoice_response:3";
 //#endregion
 //#region src/constants/invoice-response-profile-id.d.ts
+/**
+ * @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 declare const INVOICE_RESPONSE_PROFILE_ID: 'urn:fdc:peppol.eu:poacc:bis:invoice_response:3';
 //#endregion
 //#region src/constants/message-level-response-doctype-id.d.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 declare const MESSAGE_LEVEL_RESPONSE_DOCTYPE_ID: "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::ApplicationResponse##urn:fdc:peppol.eu:poacc:trns:mlr:3::2.1";
 //#endregion
 //#region src/constants/message-level-response-process-id.d.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 declare const MESSAGE_LEVEL_RESPONSE_PROCESS_ID: "cenbii-procid-ubl::urn:fdc:peppol.eu:poacc:bis:mlr:3";
 //#endregion
 //#region src/constants/message-level-response-profile-id.d.ts
+/**
+ * @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 declare const MESSAGE_LEVEL_RESPONSE_PROFILE_ID: 'urn:fdc:peppol.eu:poacc:bis:mlr:3';
 //#endregion
 //#region src/constants/participant-scheme.d.ts
+/**
+ * @description Scheme id for ISO 6523 actor identifiers, used to qualify PEPPOL participant and endpoint identifiers.
+ *
+ * @example
+ *   ```ts
+ *   PARTICIPANT_SCHEME; // 'iso6523-actorid-upis'
+ *   ```;
+ */
 export declare const PARTICIPANT_SCHEME: 'iso6523-actorid-upis';
 /**
+ * @description Deprecated alias of {@link PARTICIPANT_SCHEME}.
+ *
  * @deprecated use `PARTICIPANT_SCHEME` instead.
  */
 export declare const participantScheme: "iso6523-actorid-upis";
 //#endregion
 //#region src/constants/process-scheme.d.ts
+/**
+ * @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 declare const processScheme: 'cenbii-procid-ubl';
 //#endregion
 //#region src/constants/transport-profile.d.ts
+/**
+ * @description PEPPOL AS4 transport profile identifier for transport profile version 2.0.
+ *
+ * @example
+ *   ```ts
+ *   TRANSPORT_PROFILE; // 'peppol-transport-as4-v2_0'
+ *   ```;
+ */
 export declare const TRANSPORT_PROFILE: 'peppol-transport-as4-v2_0';
 /**
+ * @description Deprecated alias of {@link TRANSPORT_PROFILE}.
+ *
  * @deprecated
  */
 export declare const transportProfile: "peppol-transport-as4-v2_0";

package/dist/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","names":[],"sources":["../src/constants/credit-note-doctype-id.ts","../src/constants/credit-note-process-id.ts","../src/constants/document-scheme.ts","../src/constants/invoice-doctype-id.ts","../src/constants/invoice-process-id.ts","../src/constants/invoice-response-doctype-id.ts","../src/constants/invoice-response-process-id.ts","../src/constants/invoice-response-profile-id.ts","../src/constants/message-level-response-doctype-id.ts","../src/constants/message-level-response-process-id.ts","../src/constants/message-level-response-profile-id.ts","../src/constants/participant-scheme.ts","../src/constants/process-scheme.ts","../src/constants/transport-profile.ts"],"mappings":";qBAEa;;;qBCAA;;;qBCFA;;;qBCEA;;;qBCAA;;;qBCAA;;;qBCCA;;;qBCHA;;;qBCEA;;;qBCCA;;;qBCHA;;;qBCAA;;;;qBAIA;;;qBCJA;;;qBCAA;;;;qBAIA"}
+{"version":3,"file":"constants.d.ts","names":[],"sources":["../src/constants/credit-note-doctype-id.ts","../src/constants/credit-note-process-id.ts","../src/constants/document-scheme.ts","../src/constants/invoice-doctype-id.ts","../src/constants/invoice-process-id.ts","../src/constants/invoice-response-doctype-id.ts","../src/constants/invoice-response-process-id.ts","../src/constants/invoice-response-profile-id.ts","../src/constants/message-level-response-doctype-id.ts","../src/constants/message-level-response-process-id.ts","../src/constants/message-level-response-profile-id.ts","../src/constants/participant-scheme.ts","../src/constants/process-scheme.ts","../src/constants/transport-profile.ts"],"mappings":";;;;;;;;;;qBAWa;;;;;;;;;;;;qBCAA;;;;;;;;;;;;qBCFA;;;;;;;;;;;;qBCEA;;;;;;;;;;;;;qBCCA;;;;;;;;;;;;;qBCAA;;;;;;;;;;;;qBCAA;;;;;;;;;;;;qBCHA;;;;;;;;;;;;;qBCGA;;;;;;;;;;;;qBCAA;;;;;;;;;;;;qBCHA;;;;;;;;;;;qBCDA;;;;;;qBAMA;;;;;;;;;;;;qBCLA;;;;;;;;;;;qBCDA;;;;;;qBAMA"}

package/dist/constants.js

@@ -1,44 +1,157 @@
-import { n as INVOICE_RESPONSE_PROFILE_ID, t as MESSAGE_LEVEL_RESPONSE_PROFILE_ID } from "./message-level-response-profile-id-DBpOW91B.js";
+import { n as INVOICE_RESPONSE_PROFILE_ID, t as MESSAGE_LEVEL_RESPONSE_PROFILE_ID } from "./message-level-response-profile-id-B9c0A7S_.js";
 //#region src/constants/document-scheme.ts
+/**
+* @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'
+*   ```;
+*/
 const documentScheme = "busdox-docid-qns";
 //#endregion
 //#region src/constants/credit-note-doctype-id.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'
+*   ```;
+*/
 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`;
 //#endregion
 //#region src/constants/process-scheme.ts
+/**
+* @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'
+*   ```;
+*/
 const processScheme = "cenbii-procid-ubl";
 //#endregion
 //#region src/constants/credit-note-process-id.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'
+*   ```;
+*/
 const CREDIT_NOTE_PROCESS_ID = `${processScheme}::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0`;
 //#endregion
 //#region src/constants/invoice-doctype-id.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'
+*   ```;
+*/
 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`;
 //#endregion
 //#region src/constants/invoice-process-id.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'
+*   ```;
+*/
 const INVOICE_PROCESS_ID = `${processScheme}::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0`;
 //#endregion
 //#region src/constants/invoice-response-doctype-id.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'
+*   ```;
+*/
 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`;
 //#endregion
 //#region src/constants/invoice-response-process-id.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'
+*   ```;
+*/
 const INVOICE_RESPONSE_PROCESS_ID = `${processScheme}::${INVOICE_RESPONSE_PROFILE_ID}`;
 //#endregion
 //#region src/constants/message-level-response-doctype-id.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'
+*   ```;
+*/
 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`;
 //#endregion
 //#region src/constants/message-level-response-process-id.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'
+*   ```;
+*/
 const MESSAGE_LEVEL_RESPONSE_PROCESS_ID = `${processScheme}::${MESSAGE_LEVEL_RESPONSE_PROFILE_ID}`;
 //#endregion
 //#region src/constants/participant-scheme.ts
+/**
+* @description Scheme id for ISO 6523 actor identifiers, used to qualify PEPPOL participant and endpoint identifiers.
+*
+* @example
+*   ```ts
+*   PARTICIPANT_SCHEME; // 'iso6523-actorid-upis'
+*   ```;
+*/
 const PARTICIPANT_SCHEME = "iso6523-actorid-upis";
 /**
+* @description Deprecated alias of {@link PARTICIPANT_SCHEME}.
+*
 * @deprecated use `PARTICIPANT_SCHEME` instead.
 */
 const participantScheme = PARTICIPANT_SCHEME;
 //#endregion
 //#region src/constants/transport-profile.ts
+/**
+* @description PEPPOL AS4 transport profile identifier for transport profile version 2.0.
+*
+* @example
+*   ```ts
+*   TRANSPORT_PROFILE; // 'peppol-transport-as4-v2_0'
+*   ```;
+*/
 const TRANSPORT_PROFILE = "peppol-transport-as4-v2_0";
 /**
+* @description Deprecated alias of {@link TRANSPORT_PROFILE}.
+*
 * @deprecated
 */
 const transportProfile = TRANSPORT_PROFILE;

package/dist/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","names":[],"sources":["../src/constants/document-scheme.ts","../src/constants/credit-note-doctype-id.ts","../src/constants/process-scheme.ts","../src/constants/credit-note-process-id.ts","../src/constants/invoice-doctype-id.ts","../src/constants/invoice-process-id.ts","../src/constants/invoice-response-doctype-id.ts","../src/constants/invoice-response-process-id.ts","../src/constants/message-level-response-doctype-id.ts","../src/constants/message-level-response-process-id.ts","../src/constants/participant-scheme.ts","../src/constants/transport-profile.ts"],"sourcesContent":["export const documentScheme = 'busdox-docid-qns' as const;\n","import { documentScheme } from '#/constants/document-scheme.ts';\n\nexport const CREDIT_NOTE_DOCTYPE_ID =\n  `${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;\n","export const processScheme = 'cenbii-procid-ubl' as const;\n","import { processScheme } from '#/constants/process-scheme.ts';\n\nexport const CREDIT_NOTE_PROCESS_ID = `${processScheme}::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0` as const;\n","import { documentScheme } from '#/constants/document-scheme.ts';\n\nexport const INVOICE_DOCTYPE_ID =\n  `${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;\n","import { processScheme } from '#/constants/process-scheme.ts';\n\nexport const INVOICE_PROCESS_ID = `${processScheme}::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0` as const;\n","import { documentScheme } from '#/constants/document-scheme.ts';\n\nexport const INVOICE_RESPONSE_DOCTYPE_ID =\n  `${documentScheme}::urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::ApplicationResponse##urn:fdc:peppol.eu:poacc:trns:invoice_response:3::2.1` as const;\n","import { INVOICE_RESPONSE_PROFILE_ID } from '#/constants/invoice-response-profile-id.ts';\nimport { processScheme } from '#/constants/process-scheme.ts';\n\nexport const INVOICE_RESPONSE_PROCESS_ID = `${processScheme}::${INVOICE_RESPONSE_PROFILE_ID}` as const;\n","import { documentScheme } from '#/constants/document-scheme.ts';\n\nexport const MESSAGE_LEVEL_RESPONSE_DOCTYPE_ID =\n  `${documentScheme}::urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::ApplicationResponse##urn:fdc:peppol.eu:poacc:trns:mlr:3::2.1` as const;\n","import { MESSAGE_LEVEL_RESPONSE_PROFILE_ID } from '#/constants/message-level-response-profile-id.ts';\nimport { processScheme } from '#/constants/process-scheme.ts';\n\nexport const MESSAGE_LEVEL_RESPONSE_PROCESS_ID = `${processScheme}::${MESSAGE_LEVEL_RESPONSE_PROFILE_ID}` as const;\n","export const PARTICIPANT_SCHEME = 'iso6523-actorid-upis' as const;\n/**\n * @deprecated use `PARTICIPANT_SCHEME` instead.\n */\nexport const participantScheme = PARTICIPANT_SCHEME;\n","export const TRANSPORT_PROFILE = 'peppol-transport-as4-v2_0' as const;\n/**\n * @deprecated\n */\nexport const transportProfile = TRANSPORT_PROFILE;\n"],"mappings":";;AAAA,MAAa,iBAAiB;;;ACE9B,MAAa,yBACX,GAAG,eAAe;;;ACHpB,MAAa,gBAAgB;;;ACE7B,MAAa,yBAAyB,GAAG,cAAc;;;ACAvD,MAAa,qBACX,GAAG,eAAe;;;ACDpB,MAAa,qBAAqB,GAAG,cAAc;;;ACAnD,MAAa,8BACX,GAAG,eAAe;;;ACApB,MAAa,8BAA8B,GAAG,cAAc,IAAI;;;ACDhE,MAAa,oCACX,GAAG,eAAe;;;ACApB,MAAa,oCAAoC,GAAG,cAAc,IAAI;;;ACHtE,MAAa,qBAAqB;;;;AAIlC,MAAa,oBAAoB;;;ACJjC,MAAa,oBAAoB;;;;AAIjC,MAAa,mBAAmB"}
+{"version":3,"file":"constants.js","names":[],"sources":["../src/constants/document-scheme.ts","../src/constants/credit-note-doctype-id.ts","../src/constants/process-scheme.ts","../src/constants/credit-note-process-id.ts","../src/constants/invoice-doctype-id.ts","../src/constants/invoice-process-id.ts","../src/constants/invoice-response-doctype-id.ts","../src/constants/invoice-response-process-id.ts","../src/constants/message-level-response-doctype-id.ts","../src/constants/message-level-response-process-id.ts","../src/constants/participant-scheme.ts","../src/constants/transport-profile.ts"],"sourcesContent":["/**\n * @description Scheme id for PEPPOL document type identifiers. It forms the `<scheme>::` prefix of {@link INVOICE_DOCTYPE_ID}, {@link CREDIT_NOTE_DOCTYPE_ID},\n * {@link INVOICE_RESPONSE_DOCTYPE_ID}, and {@link MESSAGE_LEVEL_RESPONSE_DOCTYPE_ID}.\n *\n * @example\n *   ```ts\n *   documentScheme; // 'busdox-docid-qns'\n *   ```;\n */\nexport const documentScheme = 'busdox-docid-qns' as const;\n","import { documentScheme } from '#/constants/document-scheme.ts';\n\n/**\n * @description PEPPOL document type identifier for a UBL CreditNote. It combines the {@link documentScheme} scheme with the UBL `CreditNote-2` root element, the EN\n * 16931 / PEPPOL BIS Billing 3.0 customization id, and version 2.1. The document schema it identifies is {@link PeppolCreditNote}.\n *\n * @example\n *   ```ts\n *   CREDIT_NOTE_DOCTYPE_ID; // 'busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##...::2.1'\n *   ```;\n */\nexport const CREDIT_NOTE_DOCTYPE_ID =\n  `${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;\n","/**\n * @description Process scheme id for PEPPOL UBL business process identifiers. It forms the `<scheme>::` prefix of {@link INVOICE_PROCESS_ID},\n * {@link CREDIT_NOTE_PROCESS_ID}, {@link INVOICE_RESPONSE_PROCESS_ID}, and {@link MESSAGE_LEVEL_RESPONSE_PROCESS_ID}.\n *\n * @example\n *   ```ts\n *   processScheme; // 'cenbii-procid-ubl'\n *   ```;\n */\nexport const processScheme = 'cenbii-procid-ubl' as const;\n","import { processScheme } from '#/constants/process-scheme.ts';\n\n/**\n * @description PEPPOL business process identifier for the billing process used by credit notes. It combines the {@link processScheme} scheme with the\n * `urn:fdc:peppol.eu:2017:poacc:billing:01:1.0` business process id, the same value used by {@link INVOICE_PROCESS_ID}.\n *\n * @example\n *   ```ts\n *   CREDIT_NOTE_PROCESS_ID; // 'cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0'\n *   ```;\n */\nexport const CREDIT_NOTE_PROCESS_ID = `${processScheme}::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0` as const;\n","import { documentScheme } from '#/constants/document-scheme.ts';\n\n/**\n * @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\n * / PEPPOL BIS Billing 3.0 customization id, and version 2.1. The document schema it identifies is {@link PeppolInvoice}.\n *\n * @example\n *   ```ts\n *   INVOICE_DOCTYPE_ID; // 'busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##...::2.1'\n *   ```;\n */\nexport const INVOICE_DOCTYPE_ID =\n  `${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;\n","import { processScheme } from '#/constants/process-scheme.ts';\n\n/**\n * @description PEPPOL business process identifier for the billing process. It combines the {@link processScheme} scheme with the\n * `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\n * such as {@link PeppolInvoice}.\n *\n * @example\n *   ```ts\n *   INVOICE_PROCESS_ID; // 'cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0'\n *   ```;\n */\nexport const INVOICE_PROCESS_ID = `${processScheme}::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0` as const;\n","import { documentScheme } from '#/constants/document-scheme.ts';\n\n/**\n * @description PEPPOL document type identifier for a UBL ApplicationResponse carrying an invoice response. It combines the {@link documentScheme} scheme with the\n * UBL `ApplicationResponse-2` root element, the `urn:fdc:peppol.eu:poacc:trns:invoice_response:3` customization id, and version 2.1. The document\n * schema it identifies is {@link PeppolInvoiceResponse}.\n *\n * @example\n *   ```ts\n *   INVOICE_RESPONSE_DOCTYPE_ID; // 'busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::...::2.1'\n *   ```;\n */\nexport const INVOICE_RESPONSE_DOCTYPE_ID =\n  `${documentScheme}::urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::ApplicationResponse##urn:fdc:peppol.eu:poacc:trns:invoice_response:3::2.1` as const;\n","import { INVOICE_RESPONSE_PROFILE_ID } from '#/constants/invoice-response-profile-id.ts';\nimport { processScheme } from '#/constants/process-scheme.ts';\n\n/**\n * @description PEPPOL business process identifier for the invoice response process. It combines the {@link processScheme} scheme with\n * {@link INVOICE_RESPONSE_PROFILE_ID}, which is the `cbc:ProfileID` value fixed by {@link PeppolInvoiceResponse}.\n *\n * @example\n *   ```ts\n *   INVOICE_RESPONSE_PROCESS_ID; // 'cenbii-procid-ubl::urn:fdc:peppol.eu:poacc:bis:invoice_response:3'\n *   ```;\n */\nexport const INVOICE_RESPONSE_PROCESS_ID = `${processScheme}::${INVOICE_RESPONSE_PROFILE_ID}` as const;\n","import { documentScheme } from '#/constants/document-scheme.ts';\n\n/**\n * @description PEPPOL document type identifier for a UBL ApplicationResponse carrying a message level response. It combines the {@link documentScheme} scheme with\n * 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\n * identifies is {@link PeppolMessageLevelResponse}.\n *\n * @example\n *   ```ts\n *   MESSAGE_LEVEL_RESPONSE_DOCTYPE_ID; // 'busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::...::2.1'\n *   ```;\n */\nexport const MESSAGE_LEVEL_RESPONSE_DOCTYPE_ID =\n  `${documentScheme}::urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::ApplicationResponse##urn:fdc:peppol.eu:poacc:trns:mlr:3::2.1` as const;\n","import { MESSAGE_LEVEL_RESPONSE_PROFILE_ID } from '#/constants/message-level-response-profile-id.ts';\nimport { processScheme } from '#/constants/process-scheme.ts';\n\n/**\n * @description PEPPOL business process identifier for the message level response process. It combines the {@link processScheme} scheme with\n * {@link MESSAGE_LEVEL_RESPONSE_PROFILE_ID}, which is the `cbc:ProfileID` value fixed by {@link PeppolMessageLevelResponse}.\n *\n * @example\n *   ```ts\n *   MESSAGE_LEVEL_RESPONSE_PROCESS_ID; // 'cenbii-procid-ubl::urn:fdc:peppol.eu:poacc:bis:mlr:3'\n *   ```;\n */\nexport const MESSAGE_LEVEL_RESPONSE_PROCESS_ID = `${processScheme}::${MESSAGE_LEVEL_RESPONSE_PROFILE_ID}` as const;\n","/**\n * @description Scheme id for ISO 6523 actor identifiers, used to qualify PEPPOL participant and endpoint identifiers.\n *\n * @example\n *   ```ts\n *   PARTICIPANT_SCHEME; // 'iso6523-actorid-upis'\n *   ```;\n */\nexport const PARTICIPANT_SCHEME = 'iso6523-actorid-upis' as const;\n/**\n * @description Deprecated alias of {@link PARTICIPANT_SCHEME}.\n *\n * @deprecated use `PARTICIPANT_SCHEME` instead.\n */\nexport const participantScheme = PARTICIPANT_SCHEME;\n","/**\n * @description PEPPOL AS4 transport profile identifier for transport profile version 2.0.\n *\n * @example\n *   ```ts\n *   TRANSPORT_PROFILE; // 'peppol-transport-as4-v2_0'\n *   ```;\n */\nexport const TRANSPORT_PROFILE = 'peppol-transport-as4-v2_0' as const;\n/**\n * @description Deprecated alias of {@link TRANSPORT_PROFILE}.\n *\n * @deprecated\n */\nexport const transportProfile = TRANSPORT_PROFILE;\n"],"mappings":";;;;;;;;;;;AASA,MAAa,iBAAiB;;;;;;;;;;;;ACE9B,MAAa,yBACX,GAAG,eAAe;;;;;;;;;;;;ACHpB,MAAa,gBAAgB;;;;;;;;;;;;ACE7B,MAAa,yBAAyB,GAAG,cAAc;;;;;;;;;;;;ACAvD,MAAa,qBACX,GAAG,eAAe;;;;;;;;;;;;;ACApB,MAAa,qBAAqB,GAAG,cAAc;;;;;;;;;;;;;ACAnD,MAAa,8BACX,GAAG,eAAe;;;;;;;;;;;;ACDpB,MAAa,8BAA8B,GAAG,cAAc,IAAI;;;;;;;;;;;;;ACAhE,MAAa,oCACX,GAAG,eAAe;;;;;;;;;;;;ACDpB,MAAa,oCAAoC,GAAG,cAAc,IAAI;;;;;;;;;;;ACJtE,MAAa,qBAAqB;;;;;;AAMlC,MAAa,oBAAoB;;;;;;;;;;;ACNjC,MAAa,oBAAoB;;;;;;AAMjC,MAAa,mBAAmB"}