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

package/src/schemas/fields/additional-document-reference-schema.ts

@@ -1,112 +0,0 @@
-import * as z from 'zod/mini';
-
-import { binaryObjectSchema } from '#/schemas/fields/binary-object-schema';
-import { identifierSchema } from '#/schemas/fields/identifier-schema';
-import { additionalDocumentReferenceCodeSchema } from '#/schemas/values/additional-document-reference-code';
-
-/**
- * @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 additionalDocumentReferenceSchema = z.extend(identifierSchema(), {
-  /**
-   * @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: z.object({
-    /**
-     * @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: z.string(),
-    /**
-     * @description The identification scheme identifier of the Invoiced object identifier.
-     *
-     * @summary Scheme identifier
-     *
-     * @name `@schemeID`
-     */
-    schemeId: z.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: z.optional(z.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: z.optional(z.string()),
-  /**
-   * @summary Attachment
-   *
-   * @name `cac:Attachment`
-   */
-  attachment: z.optional(
-    z.object({
-      /**
-       * @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: z.optional(binaryObjectSchema),
-      /**
-       * @summary EXTERNAL REFERENCE
-       *
-       * @name `cac:ExternalReference`
-       */
-      externalReference: z.optional(
-        z.object({
-          /**
-           * @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: z.string(),
-        })
-      ),
-    })
-  ),
-});
-
-export type PeppolAdditionalDocumentReference = z.infer<typeof additionalDocumentReferenceSchema>;

package/src/schemas/fields/address-schema.ts

@@ -1,105 +0,0 @@
-import * as z from 'zod/mini';
-
-import { countryCodeSchema } from '#/schemas/values/country-code';
-
-/**
- * @summary Postal address
- *
- * @name `cac:PostalAddress`
- */
-export const addressSchema = z.object({
-  /**
-   * @description The main address line in an address.
-   *
-   * @example
-   *   Main Street 1
-   *
-   * @summary Address line 1
-   *
-   * @name `cbc:StreetName`
-   */
-  streetName: z.optional(z.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: z.optional(z.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: z.optional(z.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: z.optional(z.string()),
-  /**
-   * @description The subdivision of a country.
-   *
-   * @example
-   *   Region A
-   *
-   * @summary Seller country subdivision
-   *
-   * @name `cbc:CountrySubentity`
-   */
-  countrySubentity: z.optional(z.string()),
-  /**
-   * @example
-   *   GB;
-   *
-   * @name `cac:Country`
-   */
-  countryCode: z.object({
-    /**
-     * @description A code that identifies the country.
-     *
-     * @example
-     *   GB;
-     *
-     * @summary Country code
-     *
-     * @name `cbc:IdentificationCode`
-     */
-    identificationCode: countryCodeSchema,
-  }),
-  /**
-   * @example
-   *   Building 23
-   *
-   * @name `cac:AddressLine`
-   */
-  addressLine: z.optional(
-    z.object({
-      /**
-       * @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: z.string(),
-    })
-  ),
-});
-
-export type PeppolAddress = z.infer<typeof addressSchema>;

package/src/schemas/fields/allowance-charge-schema.ts

@@ -1,86 +0,0 @@
-import * as z from 'zod/mini';
-
-import { baseLineAllowanceChargeSchema } from '#/schemas/fields/line-allowance-charge-schema';
-import { taxCategorySchema } from '#/schemas/fields/tax-category-schema';
-import { allowanceChargeReasonCodeSchema } from '#/schemas/values/allowance-charge-reason-code';
-import { chargeReasonCodeSchema } from '#/schemas/values/charge-reason-code';
-import { dutyTaxFeeCategorySchema } from '#/schemas/values/duty-tax-fee-cateogries';
-
-const baseAllowanceChargeSchema = z.extend(baseLineAllowanceChargeSchema, {
-  /**
-   * @summary TAX CATEGORY
-   *
-   * @name cac:TaxCategory
-   */
-  taxCategory: z.optional(
-    z.extend(taxCategorySchema, {
-      /**
-       * @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: z.optional(z.number()),
-      /**
-       * @default VAT
-       *
-       * @name `cac:TaxScheme`
-       */
-      taxSchemeId: z.object({
-        /**
-         * @description Mandatory element. Use "VAT"
-         *
-         * @name `cbc:ID`
-         */
-        id: z._default(z.string(), 'VAT'),
-      }),
-    })
-  ),
-});
-/**
- * @summary Allowance/Charge
- *
- * @name cac:AllowanceCharge
- */
-export const allowanceChargeSchema = z.discriminatedUnion(
-  'chargeIndicator',
-  [
-    z.extend(baseAllowanceChargeSchema, {
-      /**
-       * @name cbc:AllowanceChargeReasonCode
-       */
-      allowanceChargeReasonCode: z.optional(
-        allowanceChargeReasonCodeSchema('PEPPOL-EN16931-CL002: Reason code MUST be according to subset of UNCL 5189 D.16B.')
-      ),
-      /**
-       * @name cbc:ChargeIndicator
-       *
-       * @value false
-       */
-      chargeIndicator: z.literal(false, "PEPPOL-EN16931-R043: Allowance/charge ChargeIndicator value MUST equal 'true' or 'false'"),
-    }),
-    z.extend(baseAllowanceChargeSchema, {
-      /**
-       * @name cbc:AllowanceChargeReasonCode
-       */
-      allowanceChargeReasonCode: z.optional(chargeReasonCodeSchema('PEPPOL-EN16931-CL003: Reason code MUST be according to UNCL 7161 D.16B.')),
-      /**
-       * @name cbc:ChargeIndicator
-       *
-       * @value false
-       */
-      chargeIndicator: z.literal(true, "PEPPOL-EN16931-R043: Allowance/charge ChargeIndicator value MUST equal 'true' or 'false'"),
-    }),
-  ],
-  'unable to decode allowance charge'
-);
-export type PeppolAllowanceCharge = z.infer<typeof allowanceChargeSchema>;

package/src/schemas/fields/amount-schema.ts

@@ -1,21 +0,0 @@
-import * as z from 'zod/mini';
-
-import { currencyCodeSchema } from '#/schemas/values/currency-codes';
-
-/**
- * @summary Monetary amount with mandatory currency
- *
- * @name cbc:* (+ @currencyID)
- */
-export const amountSchema = z.object({
-  /**
-   * @name \@currencyID
-   */
-  currencyId: currencyCodeSchema(),
-  /**
-   * @name #text (value)
-   */
-  value: z.number(),
-});
-
-export type PeppolAmount = z.infer<typeof amountSchema>;

package/src/schemas/fields/base-line-schema.ts

@@ -1,136 +0,0 @@
-import * as z from 'zod/mini';
-
-import { amountSchema } from '#/schemas/fields/amount-schema';
-import { identifierSchema } from '#/schemas/fields/identifier-schema';
-import { invoiceLinePeriodSchema } from '#/schemas/fields/invoice-line-period-schema';
-import { lineAllowanceChargeSchema } from '#/schemas/fields/line-allowance-charge-schema';
-import { lineItemSchema } from '#/schemas/fields/line-item-schema';
-import { linePriceSchema } from '#/schemas/fields/price-schema';
-
-/**
- * @description Base of the invoice line and credit note line schemas.
- */
-export const baseLineSchema = z.object({
-  /**
-   * @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: z.optional(z.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: z.optional(z.array(lineAllowanceChargeSchema)),
-  /**
-   * @summary Line object identifier
-   *
-   * @name cac:DocumentReference
-   *
-   * @cardinality 0..1
-   */
-  documentReference: z.optional(
-    z.array(
-      z.extend(identifierSchema(), {
-        /**
-         * @default 130
-         *
-         * @name cbc:DocumentTypeCode
-         */
-        documentTypeCode: z._default(z.string(), '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: z.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: z.optional(invoiceLinePeriodSchema),
-  /**
-   * @description A group of business terms providing information about the goods and services invoiced.
-   *
-   * @summary Item information
-   *
-   * @name cac:Item
-   *
-   * @cardinality 1..1
-   */
-  item: lineItemSchema,
-  /**
-   * @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: amountSchema,
-  /**
-   * @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: z.optional(z.string()),
-  /**
-   * @summary Order line reference
-   *
-   * @name cac:OrderLineReference
-   *
-   * @cardinality 0..1
-   */
-  orderLineReference: z.optional(z.object({ lineId: z.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: linePriceSchema,
-});
-
-export type PeppolBaseLine = z.infer<typeof baseLineSchema>;

package/src/schemas/fields/billing-references-schema.ts

@@ -1,44 +0,0 @@
-import * as z from 'zod/mini';
-
-/**
- * @summary PRECEDING INVOICE REFERENCE (0..n)
- *
- * @name cac:BillingReference
- */
-export const billingReferenceSchema = z.object({
-  /**
-   * @example
-   *   inv123;
-   *
-   * @summary INVOICE DOCUMENT REFERENCE
-   *
-   * @name `cac:InvoiceDocumentReference`
-   */
-  invoiceDocumentReference: z.object({
-    /**
-     * @description The identification of an Invoice that was previously sent by the seller.
-     *
-     * @example
-     *   `inv123`;
-     *
-     * @summary Preceding invoice number
-     *
-     * @name `cbc:ID`
-     */
-    id: z.string(),
-    /**
-     * @description The date when the preceding invoice was issued. Shall be provided in case the preceding invoice identifier is not unique.
-     *
-     * @example
-     *   `2017-09-15`;
-     *
-     * @summary Preceding invoice issue date
-     *
-     * @format `YYYY-MM-DD`
-     *
-     * @name `cbc:IssueDate`
-     */
-    issueDate: z.optional(z.iso.date()),
-  }),
-});
-export type PeppolBillingReference = z.infer<typeof billingReferenceSchema>;

package/src/schemas/fields/binary-object-schema.ts

@@ -1,45 +0,0 @@
-import * as z from 'zod/mini';
-
-import { base64Schema } from '#/schemas/utils/base-64';
-import { mimeCodesSchema } from '#/schemas/values/mime-code';
-
-/**
- * @summary Binary object for attachments
- *
- * @name cbc:EmbeddedDocumentBinaryObject (+ @mimeCode, @filename)
- */
-export const binaryObjectSchema = z.object({
-  /**
-   * @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: z.union([z.base64(), z.base64url(), base64Schema]),
-  /**
-   * @description The mime code of the attached document.
-   *
-   * @example
-   *   text / csv;
-   *
-   * @summary Attached document Mime code
-   *
-   * @name `@mimeCode`
-   */
-  mimeCode: mimeCodesSchema('PEPPOL-EN16931-CL001: Mime code must be according to subset of IANA code list.'),
-  /**
-   * @description The file name of the attached document.
-   *
-   * @example
-   *   Hours - spent.csv;
-   *
-   * @summary Attached document Filename
-   *
-   * @name `@filename`
-   */
-  filename: z.string(),
-});

package/src/schemas/fields/contact-schema.ts

@@ -1,18 +0,0 @@
-import * as z from 'zod/mini';
-
-export const contactSchema = z.object({
-  /**
-   * @name cbc:ElectronicMail
-   */
-  electronicMail: z.optional(z.string()),
-  /**
-   * @name cbc:Name
-   */
-  name: z.optional(z.string()),
-  /**
-   * @name cbc:Telephone
-   */
-  telephone: z.optional(z.string()),
-});
-
-export type PeppolContact = z.infer<typeof contactSchema>;

package/src/schemas/fields/credit-note-line-schema.ts

@@ -1,37 +0,0 @@
-import * as z from 'zod/mini';
-
-import { baseLineSchema } from '#/schemas/fields/base-line-schema';
-import { quantitySchema } from '#/schemas/fields/quantity-schema';
-import { quantityUnitCodesSchema } from '#/schemas/values/quantity-unit-codes-schema';
-
-/**
- * @description Credit note line is identical to Invoice line except the quantity element name.
- */
-export const creditNoteLineSchema = z.extend(baseLineSchema, {
-  /**
-   * @description Invoiced/Credited quantity.
-   *
-   * @example
-   *   { value: 40, unitCode: "C62" }
-   *
-   * @name cbc:CreditedQuantity (+ @unitCode)
-   */
-  creditedQuantity: z.safeExtend(quantitySchema, {
-    /**
-     * @description The unit of measure that applies to the invoiced quantity. Codes for unit of packaging from UNECE Recommendation No. 21 can be used in
-     * accordance with the descriptions in the "Intro" section of UN/ECE Recommendation 20, Revision 11 (2015): The 2 character alphanumeric code
-     * values in UNECE Recommendation 21 shall be used. To avoid duplication with existing code values in UNECE Recommendation No. 20, each code value
-     * from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure.
-     *
-     * @example
-     *   `C62`;
-     *
-     * @summary Invoiced quantity unit of measure
-     *
-     * @see {@link quantityUnitCodes}
-     */
-    unitCode: quantityUnitCodesSchema(),
-  }),
-});
-
-export type PeppolCreditNoteLine = z.infer<typeof creditNoteLineSchema>;

package/src/schemas/fields/date-only-fn.ts

@@ -1,6 +0,0 @@
-import * as z from 'zod/mini';
-
-export function dateOnly(error?: string) {
-  return z.iso.date(error);
-}
-dateOnly.error = 'PEPPOL-EN16931-F001: A date MUST be formatted YYYY-MM-DD.';

package/src/schemas/fields/date-only-parser.ts

@@ -1,20 +0,0 @@
-import type { FormatOptions, ParseOptions } from 'date-fns';
-
-import { tz } from '@date-fns/tz';
-import { format, parse } from 'date-fns';
-import * as z from 'zod/mini';
-
-import { dateOnly } from '#/schemas/fields/date-only-fn';
-
-const dateFnsOptions = { in: tz('UTC') } as const satisfies ParseOptions & FormatOptions;
-
-export function dateOnlyParser() {
-  return z.codec(z.date(), z.iso.date(dateOnly.error), {
-    decode(value) {
-      return typeof value === 'string' ? value : format(value, 'yyyy-MM-dd', dateFnsOptions);
-    },
-    encode(value) {
-      return parse(value, 'yyyy-MM-dd', new Date(), dateFnsOptions);
-    },
-  });
-}