@endevops/peppol-schema 0.1.0-beta.4 → 0.1.0-beta.5

package/src/schematron/se/se-r-007.ts

@@ -1,8 +1,7 @@
-import type { PeppolDocument } from '#/document';
+import type { PeppolDocument } from '#/schemas/peppol-document-schema';
 import type { SchematronRule } from '#/schematron/helpers';
-import type { SchematronRuleResult } from '#/schematron/types';
 
-import { getSupplierCountry, schematronResult } from '#/schematron/helpers';
+import { getSupplierCountry, schematronRule } from '#/schematron/helpers';
 
 const rule = {
   id: 'SE-R-007',
@@ -10,9 +9,9 @@ const rule = {
   message: 'For Swedish suppliers using Plusgiro, the Account ID must be numeric ',
 } as const satisfies SchematronRule;
 
-export function validateSeR007(document: PeppolDocument): SchematronRuleResult {
+function evaluateSeR007(document: PeppolDocument): boolean {
   if (getSupplierCountry(document) !== 'SE') {
-    return schematronResult(rule, true);
+    return true;
   }
   const passed = (document.paymentMeans ?? []).every(payment => {
     if (payment.paymentMeansCode.code !== '30' || payment.payeeFinancialAccount?.financialInstitutionBranch?.id !== 'SE:PLUSGIRO') {
@@ -21,5 +20,7 @@ export function validateSeR007(document: PeppolDocument): SchematronRuleResult {
     const accountId = payment.payeeFinancialAccount?.id;
     return accountId !== undefined && /^\d+$/.test(accountId.trim());
   });
-  return schematronResult(rule, passed);
+  return passed;
 }
+
+export const validateSeR007 = schematronRule(rule, evaluateSeR007);

package/src/schematron/se/se-r-008.ts

@@ -1,8 +1,7 @@
-import type { PeppolDocument } from '#/document';
+import type { PeppolDocument } from '#/schemas/peppol-document-schema';
 import type { SchematronRule } from '#/schematron/helpers';
-import type { SchematronRuleResult } from '#/schematron/types';
 
-import { getSupplierCountry, schematronResult } from '#/schematron/helpers';
+import { getSupplierCountry, schematronRule } from '#/schematron/helpers';
 
 const rule = {
   id: 'SE-R-008',
@@ -10,9 +9,9 @@ const rule = {
   message: 'For Swedish suppliers using Bankgiro, the Account ID must be numeric ',
 } as const satisfies SchematronRule;
 
-export function validateSeR008(document: PeppolDocument): SchematronRuleResult {
+function evaluateSeR008(document: PeppolDocument): boolean {
   if (getSupplierCountry(document) !== 'SE') {
-    return schematronResult(rule, true);
+    return true;
   }
   const passed = (document.paymentMeans ?? []).every(payment => {
     if (payment.paymentMeansCode.code !== '30' || payment.payeeFinancialAccount?.financialInstitutionBranch?.id !== 'SE:BANKGIRO') {
@@ -21,5 +20,7 @@ export function validateSeR008(document: PeppolDocument): SchematronRuleResult {
     const accountId = payment.payeeFinancialAccount?.id;
     return accountId !== undefined && /^\d+$/.test(accountId.trim());
   });
-  return schematronResult(rule, passed);
+  return passed;
 }
+
+export const validateSeR008 = schematronRule(rule, evaluateSeR008);

package/src/schematron/se/se-r-009.ts

@@ -1,8 +1,7 @@
-import type { PeppolDocument } from '#/document';
+import type { PeppolDocument } from '#/schemas/peppol-document-schema';
 import type { SchematronRule } from '#/schematron/helpers';
-import type { SchematronRuleResult } from '#/schematron/types';
 
-import { getSupplierCountry, schematronResult } from '#/schematron/helpers';
+import { getSupplierCountry, schematronRule } from '#/schematron/helpers';
 
 const rule = {
   id: 'SE-R-009',
@@ -10,9 +9,9 @@ const rule = {
   message: 'For Swedish suppliers using Bankgiro, the Account ID must have 7-8 characters',
 } as const satisfies SchematronRule;
 
-export function validateSeR009(document: PeppolDocument): SchematronRuleResult {
+function evaluateSeR009(document: PeppolDocument): boolean {
   if (getSupplierCountry(document) !== 'SE') {
-    return schematronResult(rule, true);
+    return true;
   }
   const passed = (document.paymentMeans ?? []).every(payment => {
     if (payment.paymentMeansCode.code !== '30' || payment.payeeFinancialAccount?.financialInstitutionBranch?.id !== 'SE:BANKGIRO') {
@@ -21,5 +20,7 @@ export function validateSeR009(document: PeppolDocument): SchematronRuleResult {
     const accountId = payment.payeeFinancialAccount?.id;
     return accountId !== undefined && (accountId.trim().length === 7 || accountId.trim().length === 8);
   });
-  return schematronResult(rule, passed);
+  return passed;
 }
+
+export const validateSeR009 = schematronRule(rule, evaluateSeR009);

package/src/schematron/se/se-r-010.ts

@@ -1,8 +1,7 @@
-import type { PeppolDocument } from '#/document';
+import type { PeppolDocument } from '#/schemas/peppol-document-schema';
 import type { SchematronRule } from '#/schematron/helpers';
-import type { SchematronRuleResult } from '#/schematron/types';
 
-import { getSupplierCountry, schematronResult } from '#/schematron/helpers';
+import { getSupplierCountry, schematronRule } from '#/schematron/helpers';
 
 const rule = {
   id: 'SE-R-010',
@@ -10,9 +9,9 @@ const rule = {
   message: 'For Swedish suppliers using Plusgiro, the Account ID must have 2-8 characters',
 } as const satisfies SchematronRule;
 
-export function validateSeR010(document: PeppolDocument): SchematronRuleResult {
+function evaluateSeR010(document: PeppolDocument): boolean {
   if (getSupplierCountry(document) !== 'SE') {
-    return schematronResult(rule, true);
+    return true;
   }
   const passed = (document.paymentMeans ?? []).every(payment => {
     if (payment.paymentMeansCode.code !== '30' || payment.payeeFinancialAccount?.financialInstitutionBranch?.id !== 'SE:PLUSGIRO') {
@@ -21,5 +20,7 @@ export function validateSeR010(document: PeppolDocument): SchematronRuleResult {
     const accountId = payment.payeeFinancialAccount?.id;
     return accountId !== undefined && accountId.trim().length >= 2 && accountId.trim().length <= 8;
   });
-  return schematronResult(rule, passed);
+  return passed;
 }
+
+export const validateSeR010 = schematronRule(rule, evaluateSeR010);

package/src/schematron/se/se-r-011.ts

@@ -1,8 +1,7 @@
-import type { PeppolDocument } from '#/document';
+import type { PeppolDocument } from '#/schemas/peppol-document-schema';
 import type { SchematronRule } from '#/schematron/helpers';
-import type { SchematronRuleResult } from '#/schematron/types';
 
-import { getSupplierCountry, schematronResult } from '#/schematron/helpers';
+import { getSupplierCountry, schematronRule } from '#/schematron/helpers';
 
 const rule = {
   id: 'SE-R-011',
@@ -11,13 +10,15 @@ const rule = {
     'For Swedish suppliers using Swedish Bankgiro or Plusgiro, the proper way to indicate this is to use Code 30 for PaymentMeans and FinancialInstitutionBranch ID with code SE:BANKGIRO or SE:PLUSGIRO',
 } as const satisfies SchematronRule;
 
-export function validateSeR011(document: PeppolDocument): SchematronRuleResult {
+function evaluateSeR011(document: PeppolDocument): boolean {
   if (getSupplierCountry(document) !== 'SE') {
-    return schematronResult(rule, true);
+    return true;
   }
   const passed = (document.paymentMeans ?? []).every(payment => {
     const code = payment.paymentMeansCode.code;
     return code !== '50' && code !== '56';
   });
-  return schematronResult(rule, passed);
+  return passed;
 }
+
+export const validateSeR011 = schematronRule(rule, evaluateSeR011);

package/src/schematron/se/se-r-012.ts

@@ -1,8 +1,7 @@
-import type { PeppolDocument } from '#/document';
+import type { PeppolDocument } from '#/schemas/peppol-document-schema';
 import type { SchematronRule } from '#/schematron/helpers';
-import type { SchematronRuleResult } from '#/schematron/types';
 
-import { getCustomerCountry, getSupplierCountry, schematronResult } from '#/schematron/helpers';
+import { getCustomerCountry, getSupplierCountry, schematronRule } from '#/schematron/helpers';
 
 const rule = {
   id: 'SE-R-012',
@@ -10,10 +9,12 @@ const rule = {
   message: 'For domestic transactions between Swedish trading partners, credit transfer should be indicated by PaymentMeansCode="30"',
 } as const satisfies SchematronRule;
 
-export function validateSeR012(document: PeppolDocument): SchematronRuleResult {
+function evaluateSeR012(document: PeppolDocument): boolean {
   if (getSupplierCountry(document) !== 'SE' || getCustomerCountry(document) !== 'SE') {
-    return schematronResult(rule, true);
+    return true;
   }
   const passed = (document.paymentMeans ?? []).every(payment => payment.paymentMeansCode.code !== '31');
-  return schematronResult(rule, passed);
+  return passed;
 }
+
+export const validateSeR012 = schematronRule(rule, evaluateSeR012);

package/src/schematron/se/se-r-013.ts

@@ -1,9 +1,8 @@
-import type { PeppolDocument } from '#/document';
+import type { PeppolDocument } from '#/schemas/peppol-document-schema';
 import type { SchematronRule } from '#/schematron/helpers';
-import type { SchematronRuleResult } from '#/schematron/types';
 
 import { checkSEOrgnr } from '#/peppol-validations/check-se-orgnr';
-import { getSupplierCountry, schematronResult } from '#/schematron/helpers';
+import { getSupplierCountry, schematronRule } from '#/schematron/helpers';
 
 const rule = {
   id: 'SE-R-013',
@@ -11,10 +10,12 @@ const rule = {
   message: 'The last digit of a Swedish organization number must be valid according to the Luhn algorithm.',
 } as const satisfies SchematronRule;
 
-export function validateSeR013(document: PeppolDocument): SchematronRuleResult {
+function evaluateSeR013(document: PeppolDocument): boolean {
   if (getSupplierCountry(document) !== 'SE') {
-    return schematronResult(rule, true);
+    return true;
   }
   const companyId = document.accountingSupplierParty.partyLegalEntity.companyId;
-  return schematronResult(rule, companyId === undefined || checkSEOrgnr(companyId.id));
+  return companyId === undefined || checkSEOrgnr(companyId.id);
 }
+
+export const validateSeR013 = schematronRule(rule, evaluateSeR013);

package/src/values/additional-document-reference-codes.generated.ts

@@ -12,7 +12,7 @@
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1153/
  */
-export const additionalDocumentReferenceCodes = {
+export const additionalDocumentReferenceCodes: Record<AdditionalDocumentReferenceCodesKeys, string> = {
   /**
    * @description [1018] Reference number identifying the acknowledgement of an order.
    */
@@ -123,8 +123,7 @@ export const additionalDocumentReferenceCodes = {
    */
   ABA: 'Customs valuation decision number',
   /**
-   * @description Reference issued by a Customs administration authorizing a preferential rate of duty if a product is used for a specified purpose, see: 1001 =
-   * 990.
+   * @description Reference issued by a Customs administration authorizing a preferential rate of duty if a product is used for a specified purpose, see: 1001 = 990.
    */
   ABB: 'End use authorization number',
   /**

package/src/values/allowance-charge-reason-codes.generated.ts

@@ -12,7 +12,7 @@
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5189/
  */
-export const allowanceChargeReasonCodes = {
+export const allowanceChargeReasonCodes: Record<AllowanceChargeReasonCodesKeys, string> = {
   '41': 'Bonus for works ahead of schedule',
 
   '42': 'Other bonus',

package/src/values/application-response-type-codes.generated.ts

@@ -12,7 +12,7 @@
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343/
  */
-export const applicationResponseTypeCodes = {
+export const applicationResponseTypeCodes: Record<ApplicationResponseTypeCodesKeys, string> = {
   AB: 'Message acknowledgement',
 
   AP: 'Accepted',

package/src/values/charge-reason-codes.generated.ts

@@ -12,7 +12,7 @@
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL7161/
  */
-export const chargeReasonCodes = {
+export const chargeReasonCodes: Record<ChargeReasonCodesKeys, string> = {
   /**
    * @description The service of providing advertising.
    */

package/src/values/country-code.generated.ts

@@ -12,7 +12,7 @@
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO3166/
  */
-export const countryCodes = {
+export const countryCodes: Record<CountryCodesKeys, string> = {
   AD: 'Andorra',
 
   AE: 'United Arab Emirates',

package/src/values/credit-notes-type-codes.generated.ts

@@ -12,7 +12,7 @@
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-cn/
  */
-export const creditNoteTypeCodes = {
+export const creditNoteTypeCodes: Record<CreditNoteTypeCodesKeys, string> = {
   /**
    * @description Document message used to provide credit information related to a transaction for goods or services to the relevant party.
    */

package/src/values/currency-code.generated.ts

@@ -12,7 +12,7 @@
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/
  */
-export const currencyCodes = {
+export const currencyCodes: Record<CurrencyCodesKeys, string> = {
   AED: 'UAE Dirham',
 
   AFN: 'Afghani',

package/src/values/document-type-codes.generated.ts

@@ -12,7 +12,7 @@
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001/
  */
-export const documentTypeCodes = {
+export const documentTypeCodes: Record<DocumentTypeCodesKeys, string> = {
   /**
    * @description Certificate providing the values of an analysis.
    */

package/src/values/document-type.generated.ts

@@ -1,7 +1,7 @@
 // oxlint-disable
 /// Do not edit this file directly. It is generated by `scripts/values.ts`
 
-export const documentTypesTable = {
+export const documentTypesTable: Record<DocumentTypesTableKeys, Array<string>> = {
   'busdox-docid-qns': [
     'urn:www.peppol.eu:schema:xsd:VirtualCompanyDossier-1::VirtualCompanyDossier##urn:www.cenbii.eu:transaction:biicoretrdm991:ver0.1:#urn:www.peppol.eu:bis:peppol991a:ver1.0::0.1',
     'urn:www.peppol.eu:schema:xsd:VirtualCompanyDossierPackage-1::VirtualCompanyDossierPackage##urn:www.cenbii.eu:transaction:biicoretrdm992:ver0.1:#urn:www.peppol.eu:bis:peppol992a:ver1.0::0.1',
@@ -341,7 +341,7 @@ export const documentTypesTableKeys = ['busdox-docid-qns', 'peppol-doctype-wildc
 
 export const documentTypesScheme = ['busdox-docid-qns', 'peppol-doctype-wildcard'];
 
-export const documentTypesProcessIds = {
+export const documentTypesProcessIds: Record<string, Array<{ scheme: string; value: string }>> = {
   'busdox-docid-qns::urn:www.peppol.eu:schema:xsd:VirtualCompanyDossier-1::VirtualCompanyDossier##urn:www.cenbii.eu:transaction:biicoretrdm991:ver0.1:#urn:www.peppol.eu:bis:peppol991a:ver1.0::0.1':
     [{ scheme: 'cenbii-procid-ubl', value: 'none' }],
   'busdox-docid-qns::urn:www.peppol.eu:schema:xsd:VirtualCompanyDossierPackage-1::VirtualCompanyDossierPackage##urn:www.cenbii.eu:transaction:biicoretrdm992:ver0.1:#urn:www.peppol.eu:bis:peppol992a:ver1.0::0.1':

package/src/values/duty-tax-fee-categories.generated.ts

@@ -12,7 +12,7 @@
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5305/
  */
-export const dutyTaxFeeCategories = {
+export const dutyTaxFeeCategories: Record<DutyTaxFeeCategoriesKeys, string> = {
   /**
    * @description Code specifying that the standard VAT rate is levied from the invoicee.
    */

package/src/values/eas-codes.generated.ts

@@ -10,7 +10,7 @@
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/eas/
  */
-export const electronicAddressCodes = {
+export const electronicAddressCodes: Record<ElectronicAddressCodesKeys, string> = {
   '0002': 'System Information et Repertoire des Entreprise et des Etablissements: SIRENE',
 
   '0007': 'Organisationsnummer (Swedish legal entities)',

package/src/values/icd-codes.generated.ts

@@ -10,7 +10,7 @@
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ICD/
  */
-export const icdCodes = {
+export const icdCodes: Record<IcdCodesKeys, string> = {
   /**
    * @description Notes on Use of Code: The Sirene number is used in France mainly for the official registration in the Trade Register and as the only number used
    * between authorities and organizations, and between authorities when dealing with data interchange on organizations. Issuing agency: Institut
@@ -95,8 +95,8 @@ export const icdCodes = {
    */
   '0017': 'COMMON LANGUAGE',
   /**
-   * @description Notes on Use of Code: The ICD code will also form the initial part of the OSI Network addressing and naming tree as depicted in Addendum 2 to ISO
-   * 8348. Issuing agency: International Business Machines Corporation, USA.
+   * @description Notes on Use of Code: The ICD code will also form the initial part of the OSI Network addressing and naming tree as depicted in Addendum 2 to ISO 8348.
+   * Issuing agency: International Business Machines Corporation, USA.
    */
   '0018': 'SNA/OSI Network',
   /**
@@ -401,8 +401,8 @@ export const icdCodes = {
    */
   '0078': 'Mitel terminal or switching equipment',
   /**
-   * @description Notes on Use of Code: The ICD code will also form part of the Initial Domain Part of the OSI network addressing as specified in Addendum 2 to ISO
-   * 8348. Issuing agency: The ATM Forum, USA.
+   * @description Notes on Use of Code: The ICD code will also form part of the Initial Domain Part of the OSI network addressing as specified in Addendum 2 to ISO 8348.
+   * Issuing agency: The ATM Forum, USA.
    */
   '0079': 'ATM Forum',
   /**
@@ -419,8 +419,8 @@ export const icdCodes = {
    */
   '0082': "Norwegian Telecommunications Authority's, NTA'S, EDI, identifier scheme (EDIRA compliant)",
   /**
-   * @description Notes on Use of Code: The ICD code will also form part of the Initial Domain Part of the OSI network addressing as specified in Addendum 2 to ISO
-   * 8348. Issuing agency: ATM Ltd, ENGLAND.
+   * @description Notes on Use of Code: The ICD code will also form part of the Initial Domain Part of the OSI network addressing as specified in Addendum 2 to ISO 8348.
+   * Issuing agency: ATM Ltd, ENGLAND.
    */
   '0083': 'Advanced Telecommunications Modules Limited, Corporate Network',
   /**

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

@@ -12,7 +12,7 @@
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343-T111/
  */
-export const invoiceStatusCodes = {
+export const invoiceStatusCodes: Record<InvoiceStatusCodesKeys, string> = {
   /**
    * @description Indicates that an acknowledgement relating to receipt of message or transaction is required. Status is used when Buyer has received a readable
    * invoice message that can be understood and submitted for processing by the Buyer.

package/src/values/invoice-type-codes.generated.ts

@@ -12,7 +12,7 @@
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-inv/
  */
-export const invoiceTypeCodes = {
+export const invoiceTypeCodes: Record<InvoiceTypeCodesKeys, string> = {
   /**
    * @description Document/message issued by a creditor to a debtor to request payment of one or more invoices past due.
    */

package/src/values/item-classification-code.generated.ts

@@ -12,7 +12,7 @@
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL7143/
  */
-export const itemClassificationCodes = {
+export const itemClassificationCodes: Record<ItemClassificationCodesKeys, string> = {
   /**
    * @description Number assigned by manufacturer or seller to identify the release of a product.
    */

package/src/values/mime-codes.generated.ts

@@ -12,7 +12,7 @@
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/MimeCode/
  */
-export const mimeCodes = {
+export const mimeCodes: Record<MimeCodesKeys, string> = {
   'text/csv': 'text/csv',
 
   'application/pdf': 'application/pdf',

package/src/values/op-status-action.generated.ts

@@ -12,7 +12,7 @@
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/OPStatusAction/
  */
-export const opStatusAction = {
+export const opStatusAction: Record<OpStatusActionKeys, string> = {
   /**
    * @description No action required.
    */

package/src/values/op-status-reason.generated.ts

@@ -12,7 +12,7 @@
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/OPStatusReason/
  */
-export const opStatusReason = {
+export const opStatusReason: Record<OpStatusReasonKeys, string> = {
   /**
    * @description Indicates that receiver of the documents sends the message just to update the status and there are no problems with document processing.
    */

package/src/values/participant-identifier-schemes.generated.ts

@@ -10,7 +10,7 @@
  *
  * @enum
  */
-export const participantIdentifierSchemes = {
+export const participantIdentifierSchemes: Record<ParticipantIdentifierSchemesKeys, string> = {
   /**
    * @since 1.0.0
    *
@@ -1488,7 +1488,7 @@ export const participantIdentifierSchemesKeys = [
   '9959',
 ] as [string, ...string[]];
 
-export const participantIdentifierSchemesValidations = {
+export const participantIdentifierSchemesValidations: Record<string, Array<RegExp> | undefined> = {
   '0002': [/[0-9]{9}([0-9]{5})?/g],
   '0007': [/[0-9]{10}/g],
   '0009': [/[0-9]{14}/g],

package/src/values/payment-means-codes.generated.ts

@@ -12,7 +12,7 @@
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4461/
  */
-export const paymentMeansCodes = {
+export const paymentMeansCodes: Record<PaymentMeansCodesKeys, string> = {
   /**
    * @description Not defined legally enforceable agreement between two or more parties (expressing a contractual right or a right to the payment of money).
    */

package/src/values/processes.generated.ts

@@ -10,7 +10,7 @@
  *
  * @enum
  */
-export const processes = {
+export const processes: Record<ProcessesKeys, Array<string>> = {
   'cenbii-procid-ubl': [
     'none',
     'urn:www.cenbii.eu:profile:bii01:ver1.0',

package/src/values/quantity-unit-codes.generated.ts

@@ -12,7 +12,7 @@
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNECERec20/
  */
-export const quantityUnitCodes = {
+export const quantityUnitCodes: Record<QuantityUnitCodesKeys, string> = {
   /**
    * @description A unit of count defining the number of groups (group: set of items classified together).
    */

package/src/values/vat-dates.generated.ts

@@ -12,7 +12,7 @@
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL2005/
  */
-export const vatDateCodes = {
+export const vatDateCodes: Record<VatDateCodesKeys, string> = {
   '3': 'Invoice document issue date time',
 
   '35': 'Delivery date/time, actual',

package/src/values/vatex-codes.generated.ts

@@ -10,7 +10,7 @@
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/vatex/
  */
-export const vatexCodes = {
+export const vatexCodes: Record<VatexCodesKeys, string> = {
   /**
    * @description Exemptions relating to repayment of expenditures. Remark, Repayment of expenditure is not an exemption in the sense of the VAT Directive but may
    * be handled as such in the context of the EN16931.