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

package/src/decoders/errors.ts

@@ -1,11 +0,0 @@
-import { Schema } from 'effect';
-
-/**
- * @description Raised when a PEPPOL document cannot be decoded from its XML node representation.
- */
-export class PeppolDecodeError extends Schema.TaggedError<PeppolDecodeError>()('PeppolDecodeError', { message: Schema.String }) {}
-
-/**
- * @description Raised when a PEPPOL document cannot be encoded into its XML node representation.
- */
-export class PeppolEncodeError extends Schema.TaggedError<PeppolEncodeError>()('PeppolEncodeError', { message: Schema.String }) {}

package/src/document-parser.ts

@@ -1,70 +0,0 @@
-import { Effect } from 'effect';
-import XMLBuilder from 'fast-xml-builder';
-import { XMLParser } from 'fast-xml-parser';
-import * as z from 'zod/mini';
-
-import type { PeppolCreditNote, PeppolInvoiceResponse, PeppolMessageLevelResponse } from '#/schemas';
-import type { PeppolInvoice } from '#/schemas/invoice';
-
-import { INVOICE_RESPONSE_PROFILE_ID } from '#/constants/invoice-response-profile-id';
-import { MESSAGE_LEVEL_RESPONSE_PROFILE_ID } from '#/constants/message-level-response-profile-id';
-import { decodeCreditNote } from '#/decoders/decode-credit-note';
-import { decodeInvoice } from '#/decoders/decode-invoice';
-import { decodeInvoiceResponse } from '#/decoders/decode-invoice-response';
-import { decodeMessageLevelResponse } from '#/decoders/decode-message-level-response';
-import { encodeCreditNote } from '#/decoders/encode-credit-note';
-import { encodeInvoice } from '#/decoders/encode-invoice';
-import { encodeInvoiceResponse } from '#/decoders/encode-invoice-response';
-import { encodeMessageLevelResponse } from '#/decoders/encode-message-level-response';
-import { PeppolDecodeError } from '#/decoders/errors';
-import { strOrUnd } from '#/helpers/str-or-und';
-import { creditNoteSchema } from '#/schemas/credit-note';
-import { invoiceSchema } from '#/schemas/invoice';
-import { invoiceResponseSchema } from '#/schemas/invoice-response-schema';
-import { messageLevelResponse } from '#/schemas/message-level-response-schema';
-import { builderOptions } from '#/xml/builder-options';
-import { parserOptions } from '#/xml/parser-options';
-
-/**
- * @deprecated use `PeppolDocumentParser` instead
- */
-export const documentParser = z.codec(
-  z.string(),
-  z.xor([invoiceSchema, creditNoteSchema, messageLevelResponse, invoiceResponseSchema], 'invalid document'),
-  {
-    decode(value) {
-      const parser = new XMLParser({ ...parserOptions, removeNSPrefix: true });
-      const parsed = parser.parse(value);
-      if (parsed.Invoice) {
-        return Effect.runSync(decodeInvoice(parsed));
-      } else if (parsed.CreditNote) {
-        return Effect.runSync(decodeCreditNote(parsed));
-      } else if (parsed.ApplicationResponse) {
-        const profile = Effect.runSync(strOrUnd(parsed.ApplicationResponse, 'cbc:ProfileID'));
-        if (profile === MESSAGE_LEVEL_RESPONSE_PROFILE_ID) {
-          return Effect.runSync(decodeMessageLevelResponse(parsed));
-        } else if (profile === INVOICE_RESPONSE_PROFILE_ID) {
-          return Effect.runSync(decodeInvoiceResponse(parsed));
-        }
-      }
-      throw new PeppolDecodeError({ message: `Unsupported document type: ${Object.keys(parsed).join(',')}` });
-    },
-    encode(value) {
-      let content: unknown;
-      if ('invoiceLines' in value) {
-        content = Effect.runSync(encodeInvoice(value as PeppolInvoice));
-      } else if ('creditNoteLines' in value) {
-        content = Effect.runSync(encodeCreditNote(value as PeppolCreditNote));
-      } else if ('documentResponse' in value) {
-        if (value.profileId === MESSAGE_LEVEL_RESPONSE_PROFILE_ID) {
-          content = Effect.runSync(encodeMessageLevelResponse(value as PeppolMessageLevelResponse));
-        } else if (value.profileId === INVOICE_RESPONSE_PROFILE_ID) {
-          content = Effect.runSync(encodeInvoiceResponse(value as PeppolInvoiceResponse));
-        }
-      }
-
-      const builder = new XMLBuilder(builderOptions);
-      return builder.build(content);
-    },
-  }
-);

package/src/document.ts

@@ -1,19 +0,0 @@
-import type { AllUnionFields } from 'type-fest';
-
-import type { PeppolCreditNote } from '#/schemas/credit-note';
-import type { PeppolCreditNoteLine } from '#/schemas/fields/credit-note-line-schema';
-import type { PeppolInvoiceLine } from '#/schemas/fields/invoice-line-schema';
-import type { PeppolInvoice } from '#/schemas/invoice';
-import type { PeppolInvoiceResponse } from '#/schemas/invoice-response-schema';
-import type { PeppolMessageLevelResponse } from '#/schemas/message-level-response-schema';
-
-/**
- * @description This defines the types of documents that are sent/received through the peppol network.
- */
-export type PeppolDocument = AllUnionFields<PeppolInvoice | PeppolCreditNote>;
-/**
- * @description This defines the types of message that are sent/received through the peppol network.
- */
-export type PeppolMessage = AllUnionFields<PeppolMessageLevelResponse | PeppolInvoiceResponse>;
-export type PeppolAllDocuments = AllUnionFields<PeppolDocument | PeppolMessage>;
-export type PeppolDocumentLine = AllUnionFields<PeppolInvoiceLine | PeppolCreditNoteLine>;

package/src/effect/fields/default-customization-id.ts

@@ -1 +0,0 @@
-export const DEFAULT_CUSTOMIZATION_ID = 'urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0' as const;

package/src/effect/fields/default-profile-id.ts

@@ -1 +0,0 @@
-export const DEFAULT_PROFILE_ID = 'urn:fdc:peppol.eu:2017:poacc:billing:01:1.0' as const;

package/src/effect/fields/peppol-additional-document-reference-schema.ts

@@ -1,114 +0,0 @@
-import { Schema } from 'effect';
-
-import { peppolBinaryObjectSchema } from '#/effect/fields/peppol-binary-object-schema';
-import { peppolIdentifierSchema } from '#/effect/fields/peppol-identifier-schema';
-import { additionalDocumentReferenceCodeSchema } from '#/effect/values/additional-document-reference-code-schema';
-
-/**
- * @description A group of business terms providing information about additional supporting documents substantiating the claims made in the Invoice. The additional
- * supporting documents can be used for both referencing a document number which is expected to be known by the receiver, an external document
- * (referenced by a URL) or as an embedded document, Base64 encoded (such as a time report).
- *
- * @summary ADDITIONAL SUPPORTING DOCUMENTS
- *
- * @name `cac:AdditionalDocumentReference`
- */
-export const peppolAdditionalDocumentReferenceSchema = peppolIdentifierSchema.pipe(
-  Schema.fieldsAssign({
-    /**
-     * @description An identifier for an object on which the invoice is based (with DocumentTypeCode=130), given by the Seller, the identifier for the supporting
-     * document or the project reference identifier (DocumentTypeCode=50).
-     *
-     * @summary Invoiced object identifier, Supporting document reference or project reference
-     *
-     * @name `cbc:ID`
-     */
-    id: Schema.Struct({
-      /**
-       * @description An identifier for an object on which the invoice is based (with DocumentTypeCode=130), given by the Seller, the identifier for the supporting
-       * document or the project reference identifier (DocumentTypeCode=50).
-       *
-       * @summary Invoiced object identifier, Supporting document reference or project reference
-       *
-       * @name `#text`
-       */
-      id: Schema.String,
-      /**
-       * @description The identification scheme identifier of the Invoiced object identifier.
-       *
-       * @summary Scheme identifier
-       *
-       * @name `@schemeID`
-       */
-      schemeId: Schema.optional(additionalDocumentReferenceCodeSchema),
-    }),
-    /**
-     * @remarks
-     *   Code "130" MUST be used to indicate an invoice object reference and code "50" for project reference. Element is not used for other additional
-     *   documents.
-     *
-     * @default 130
-     *
-     * @summary Document type code
-     *
-     * @name `cbc:DocumentTypeCode`
-     */
-    documentTypeCode: Schema.optional(Schema.String),
-    /**
-     * @description A description of the supporting document, such as timesheet, usage report, etc.
-     *
-     * @example
-     *   Time list
-     *
-     * @summary Supporting document description
-     *
-     * @name `cbc:DocumentDescription`
-     */
-    documentDescription: Schema.optional(Schema.String),
-    /**
-     * @summary Attachment
-     *
-     * @name `cac:Attachment`
-     */
-    attachment: Schema.optional(
-      Schema.Struct({
-        /**
-         * @description An attached document embedded as binary object (Base64) or sent together with the invoice.
-         *
-         * @example
-         *   ```base64
-         *   aHR0cHM6Ly90ZXN0LXZlZmEuZGlmaS5uby9wZXBwb2xiaXMvcG9hY2MvYmlsbGluZy8zLjAvYmlzLw==
-         *   ```;
-         *
-         * @summary Attached document
-         *
-         * @name `cbc:EmbeddedDocumentBinaryObject`
-         */
-        embeddedDocumentBinaryObject: Schema.optional(peppolBinaryObjectSchema),
-        /**
-         * @summary EXTERNAL REFERENCE
-         *
-         * @name `cac:ExternalReference`
-         */
-        externalReference: Schema.optional(
-          Schema.Struct({
-            /**
-             * @description The URL (Uniform Resource Locator) that identifies where the external document is located. A means of locating the resource, including
-             * its primary access mechanism, e.g. http:// or ftp://.
-             *
-             * @example
-             *   `http://www.example.com/index.html`;
-             *
-             * @summary External document location
-             *
-             * @name `cbc:URI`
-             */
-            uri: Schema.String,
-          })
-        ),
-      })
-    ),
-  })
-);
-
-export interface PeppolAdditionalDocumentReference extends Schema.Schema.Type<typeof peppolAdditionalDocumentReferenceSchema> {}

package/src/effect/fields/peppol-address-schema.ts

@@ -1,105 +0,0 @@
-import { Schema } from 'effect';
-
-import { peppolCountryCodeSchema } from '#/effect/values/peppol-country-code-schema';
-
-/**
- * @summary Postal address
- *
- * @name `cac:PostalAddress`
- */
-export const peppolAddressSchema = Schema.Struct({
-  /**
-   * @description The main address line in an address.
-   *
-   * @example
-   *   Main Street 1
-   *
-   * @summary Address line 1
-   *
-   * @name `cbc:StreetName`
-   */
-  streetName: Schema.optional(Schema.String),
-  /**
-   * @description An additional address line in an address that can be used to give further details supplementing the main line.
-   *
-   * @example
-   *   Po Box 351
-   *
-   * @summary Address line 2
-   *
-   * @name `cbc:AdditionalStreetName`
-   */
-  additionalStreetName: Schema.optional(Schema.String),
-  /**
-   * @description The common name of the city, town or village, where the address is located.
-   *
-   * @example
-   *   London;
-   *
-   * @summary Seller city
-   *
-   * @name `cbc:CityName`
-   */
-  cityName: Schema.optional(Schema.String),
-  /**
-   * @description The identifier for an addressable group of properties according to the relevant postal service.
-   *
-   * @example
-   *   W1G 8LZ
-   *
-   * @summary post code
-   *
-   * @name `cbc:PostalZone`
-   */
-  postalZone: Schema.optional(Schema.String),
-  /**
-   * @description The subdivision of a country.
-   *
-   * @example
-   *   Region A
-   *
-   * @summary Seller country subdivision
-   *
-   * @name `cbc:CountrySubentity`
-   */
-  countrySubentity: Schema.optional(Schema.String),
-  /**
-   * @example
-   *   GB;
-   *
-   * @name `cac:Country`
-   */
-  countryCode: Schema.Struct({
-    /**
-     * @description A code that identifies the country.
-     *
-     * @example
-     *   GB;
-     *
-     * @summary Country code
-     *
-     * @name `cbc:IdentificationCode`
-     */
-    identificationCode: peppolCountryCodeSchema,
-  }),
-  /**
-   * @example
-   *   Building 23
-   *
-   * @name `cac:AddressLine`
-   */
-  addressLine: Schema.optional(
-    Schema.Struct({
-      /**
-       * @description An additional address line in an address that can be used to give further details supplementing the main line.
-       *
-       * @summary Address line 3
-       *
-       * @name `cbc:Line`
-       */
-      line: Schema.String,
-    })
-  ),
-});
-
-export type PeppolAddress = typeof peppolAddressSchema.Type;

package/src/effect/fields/peppol-allowance-charge-schema.ts

@@ -1,95 +0,0 @@
-import { Effect, Schema } from 'effect';
-
-import { baseLineAllowanceChargeSchema } from '#/effect/fields/peppol-line-allowance-charge-schema';
-import { peppolTaxCategorySchema } from '#/effect/fields/peppol-tax-category-schema';
-import { allowanceChargeReasonCodeSchema } from '#/effect/values/allowance-charge-reason-code-schema';
-import { chargeReasonCodeSchema } from '#/effect/values/charge-reason-code-schema';
-import { dutyTaxFeeCategorySchema } from '#/effect/values/duty-tax-fee-category-schema';
-
-const baseAllowanceChargeSchema = baseLineAllowanceChargeSchema.pipe(
-  Schema.fieldsAssign({
-    /**
-     * @summary TAX CATEGORY
-     *
-     * @name cac:TaxCategory
-     */
-    taxCategory: Schema.optional(
-      peppolTaxCategorySchema.pipe(
-        Schema.fieldsAssign({
-          /**
-           * @description A coded identification of what VAT category applies to the document level allowance or charge.
-           *
-           * @summary Document level allowance or charge VAT category code
-           *
-           * @name `cbc:ID`
-           */
-          id: dutyTaxFeeCategorySchema,
-          /**
-           * @description The VAT rate, represented as percentage that applies to the document level allowance or charge.
-           *
-           * @summary Document level allowance or charge VAT rate
-           *
-           * @name `cbc:Percent`
-           */
-          percent: Schema.optional(Schema.Finite),
-          /**
-           * @default VAT
-           *
-           * @name `cac:TaxScheme`
-           */
-          taxSchemeId: Schema.Struct({
-            /**
-             * @description Mandatory element. Use "VAT"
-             *
-             * @name `cbc:ID`
-             */
-            id: Schema.String.pipe(Schema.withDecodingDefaultType(Effect.succeed('VAT'))),
-          }),
-        })
-      )
-    ),
-  })
-);
-
-/**
- * @summary Allowance/Charge
- *
- * @name cac:AllowanceCharge
- */
-export const peppolAllowanceChargeSchema = Schema.Union([
-  baseAllowanceChargeSchema.pipe(
-    Schema.fieldsAssign({
-      /**
-       * @name cbc:AllowanceChargeReasonCode
-       */
-      allowanceChargeReasonCode: Schema.optional(allowanceChargeReasonCodeSchema),
-      /**
-       * @name cbc:ChargeIndicator
-       *
-       * @value false
-       */
-      chargeIndicator: Schema.Literal(false).annotate({
-        message: "PEPPOL-EN16931-R043: Allowance/charge ChargeIndicator value MUST equal 'true' or 'false'",
-      }),
-    })
-  ),
-  baseAllowanceChargeSchema.pipe(
-    Schema.fieldsAssign({
-      /**
-       * @name cbc:AllowanceChargeReasonCode
-       */
-      allowanceChargeReasonCode: Schema.optional(chargeReasonCodeSchema),
-      /**
-       * @name cbc:ChargeIndicator
-       *
-       * @value false
-       */
-      chargeIndicator: Schema.Literal(true).annotate({
-        message: "PEPPOL-EN16931-R043: Allowance/charge ChargeIndicator value MUST equal 'true' or 'false'",
-      }),
-    })
-  ),
-]).annotate({ message: 'unable to decode allowance charge' });
-
-export type PeppolAllowanceCharge = Schema.Schema.Type<typeof peppolAllowanceChargeSchema>;
-export type PeppolAllowanceChargeEncoded = Schema.Codec.Encoded<typeof peppolAllowanceChargeSchema>;

package/src/effect/fields/peppol-amount-schema.ts

@@ -1,22 +0,0 @@
-import { Schema } from 'effect';
-
-import { currencyCodeSchema } from '#/effect/values/currency-code-schema';
-
-/**
- * @summary Monetary amount with mandatory currency
- *
- * @name cbc:* (+ @currencyID)
- */
-export const peppolAmountSchema = Schema.Struct({
-  /**
-   * @name \@currencyID
-   */
-  currencyId: currencyCodeSchema,
-  /**
-   * @name #text (value)
-   */
-  value: Schema.Finite,
-});
-
-export interface PeppolAmount extends Schema.Schema.Type<typeof peppolAmountSchema> {}
-export interface PeppolAmountEncoded extends Schema.Codec.Encoded<typeof peppolAmountSchema> {}

package/src/effect/fields/peppol-base-line-schema.ts

@@ -1,138 +0,0 @@
-import { Effect, Schema } from 'effect';
-
-import { peppolAmountSchema } from '#/effect/fields/peppol-amount-schema';
-import { peppolIdentifierSchema } from '#/effect/fields/peppol-identifier-schema';
-import { peppolInvoiceLinePeriodSchema } from '#/effect/fields/peppol-invoice-line-period-schema';
-import { peppolLineAllowanceChargeSchema } from '#/effect/fields/peppol-line-allowance-charge-schema';
-import { peppolLineItemSchema } from '#/effect/fields/peppol-line-item-schema';
-import { peppolLinePriceSchema } from '#/effect/fields/peppol-line-price-schema';
-
-/**
- * @description Base of the invoice line and credit note line schemas.
- */
-export const peppolBaseLineSchema = Schema.Struct({
-  /**
-   * @description A textual value that specifies where to book the relevant data into the Buyer's financial accounts.
-   *
-   * @example
-   *   `1287:65464`;
-   *
-   * @summary Invoice line Buyer accounting reference
-   *
-   * @name cbc:AccountingCost
-   *
-   * @cardinality 0..1
-   */
-  accountingCost: Schema.optional(Schema.String),
-  /**
-   * @description A group of business terms providing information about allowances or charges applicable to the individual Invoice line.
-   *
-   * @summary Invoice line allowances or charges
-   *
-   * @name cac:AllowanceCharge
-   *
-   * @cardinality 0..n
-   */
-  allowanceCharges: Schema.optional(Schema.Array(peppolLineAllowanceChargeSchema)),
-  /**
-   * @summary Line object identifier
-   *
-   * @name cac:DocumentReference
-   *
-   * @cardinality 0..1
-   */
-  documentReference: Schema.optional(
-    Schema.Array(
-      peppolIdentifierSchema.pipe(
-        Schema.fieldsAssign({
-          /**
-           * @default 130
-           *
-           * @name cbc:DocumentTypeCode
-           */
-          documentTypeCode: Schema.String.pipe(Schema.withDecodingDefaultType(Effect.succeed('130'))),
-        })
-      )
-    )
-  ),
-  /**
-   * @description A unique identifier for the individual line within the Invoice.
-   *
-   * @example
-   *   12;
-   *
-   * @summary Invoice line identifier
-   *
-   * @name cbc:ID
-   *
-   * @cardinality 1..1
-   */
-  id: Schema.String,
-  /**
-   * @description A group of business terms providing information about the period relevant for the Invoice line.
-   *
-   * @summary Invoice line period
-   *
-   * @name cac:InvoicePeriod
-   *
-   * @cardinality 0..1
-   */
-  invoicePeriod: Schema.optional(peppolInvoiceLinePeriodSchema),
-  /**
-   * @description A group of business terms providing information about the goods and services invoiced.
-   *
-   * @summary Item information
-   *
-   * @name cac:Item
-   *
-   * @cardinality 1..1
-   */
-  item: peppolLineItemSchema,
-  /**
-   * @description The total amount of the Invoice line. The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other
-   * relevant taxes. Must be rounded to maximum 2 decimals.
-   *
-   * @example
-   *   { value: 2145.0, currencyId: "EUR" }
-   *
-   * @summary Invoice line net amount
-   *
-   * @name cbc:LineExtensionAmount (+ @currencyID)
-   *
-   * @cardinality 1..1
-   */
-  lineExtensionAmount: peppolAmountSchema,
-  /**
-   * @description A textual note that gives unstructured information that is relevant to the Invoice line.
-   *
-   * @example
-   *   New article number 12345
-   *
-   * @summary Invoice line note
-   *
-   * @name cbc:Note
-   *
-   * @cardinality 0..1
-   */
-  note: Schema.optional(Schema.String),
-  /**
-   * @summary Order line reference
-   *
-   * @name cac:OrderLineReference
-   *
-   * @cardinality 0..1
-   */
-  orderLineReference: Schema.optional(Schema.Struct({ lineId: Schema.String })),
-  /**
-   * @description A group of business terms providing information about the price applied for the goods and services invoices on the Invoice line.
-   *
-   * @summary Price Details
-   *
-   * @name cac:Price
-   *
-   * @cardinality 1..1
-   */
-  price: peppolLinePriceSchema,
-});
-
-export type PeppolBaseLine = typeof peppolBaseLineSchema.Type;

package/src/effect/fields/peppol-binary-object-schema.ts

@@ -1,51 +0,0 @@
-import { Schema } from 'effect';
-
-import { peppolBase64Schema } from '#/effect/utils/peppol-base-64-schema';
-import { mimeCodesSchema } from '#/effect/values/mime-codes-schema';
-
-// RFC 4648 §5 — Base64url Encoding: URL/file-safe alphabet (A-Z a-z 0-9 - _), optional `=` padding.
-// Effect port of `z.base64url()`: keeps the value as a plain string and only validates the shape.
-const base64UrlSchema = Schema.String.check(Schema.isPattern(/^[A-Za-z0-9\-_]+={0,2}$/)).annotate({ message: 'Invalid base64url' });
-
-/**
- * @summary Binary object for attachments
- *
- * @name cbc:EmbeddedDocumentBinaryObject (+ @mimeCode, @filename)
- */
-export const peppolBinaryObjectSchema = Schema.Struct({
-  /**
-   * @description An attached document embedded as binary object (Base64) or sent together with the invoice.
-   *
-   * @example
-   *   aHR0cHM6Ly90ZXN0LXZlZmEuZGlmaS5uby9wZXBwb2xiaXMvcG9hY2MvYmlsbGluZy8zLjAvYmlzLw==
-   *
-   * @summary Attached document
-   *
-   * @name `#text` (Base64 content)
-   */
-  content: Schema.Union([peppolBase64Schema, base64UrlSchema]),
-  /**
-   * @description The mime code of the attached document.
-   *
-   * @example
-   *   text / csv;
-   *
-   * @summary Attached document Mime code
-   *
-   * @name `@mimeCode`
-   */
-  mimeCode: mimeCodesSchema,
-  /**
-   * @description The file name of the attached document.
-   *
-   * @example
-   *   Hours - spent.csv;
-   *
-   * @summary Attached document Filename
-   *
-   * @name `@filename`
-   */
-  filename: Schema.String,
-});
-
-export type PeppolBinaryObject = typeof peppolBinaryObjectSchema.Type;

package/src/effect/fields/peppol-contact-schema.ts

@@ -1,18 +0,0 @@
-import { Schema } from 'effect';
-
-export const peppolContactSchema = Schema.Struct({
-  /**
-   * @name cbc:ElectronicMail
-   */
-  electronicMail: Schema.optional(Schema.String),
-  /**
-   * @name cbc:Name
-   */
-  name: Schema.optional(Schema.String),
-  /**
-   * @name cbc:Telephone
-   */
-  telephone: Schema.optional(Schema.String),
-});
-
-export type PeppolContact = typeof peppolContactSchema.Type;