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

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://raw.githubusercontent.com/SchemaStore/schemastore/refs/heads/master/src/schemas/json/package.json",
   "name": "@endevops/peppol-schema",
-  "version": "0.1.0-beta.3",
+  "version": "0.1.0-beta.4",
   "description": "A simple example library built by tsdown",
   "license": "Apache-2.0",
   "contributors": [

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

@@ -111,4 +111,4 @@ export const peppolAdditionalDocumentReferenceSchema = peppolIdentifierSchema.pi
   })
 );
 
-export type PeppolAdditionalDocumentReference = typeof peppolAdditionalDocumentReferenceSchema.Type;
+export interface PeppolAdditionalDocumentReference extends Schema.Schema.Type<typeof peppolAdditionalDocumentReferenceSchema> {}

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

@@ -91,4 +91,5 @@ export const peppolAllowanceChargeSchema = Schema.Union([
   ),
 ]).annotate({ message: 'unable to decode allowance charge' });
 
-export type PeppolAllowanceCharge = typeof peppolAllowanceChargeSchema.Type;
+export type PeppolAllowanceCharge = Schema.Schema.Type<typeof peppolAllowanceChargeSchema>;
+export type PeppolAllowanceChargeEncoded = Schema.Codec.Encoded<typeof peppolAllowanceChargeSchema>;

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

@@ -18,4 +18,5 @@ export const peppolAmountSchema = Schema.Struct({
   value: Schema.Finite,
 });
 
-export type PeppolAmount = typeof peppolAmountSchema.Type;
+export interface PeppolAmount extends Schema.Schema.Type<typeof peppolAmountSchema> {}
+export interface PeppolAmountEncoded extends Schema.Codec.Encoded<typeof peppolAmountSchema> {}

package/src/effect/fields/peppol-credit-note-line-schema.ts

@@ -39,3 +39,4 @@ export const peppolCreditNoteLineSchema = peppolBaseLineSchema.pipe(
 );
 
 export interface PeppolCreditNoteLine extends Schema.Schema.Type<typeof peppolCreditNoteLineSchema> {}
+export interface PeppolCreditNoteLineEncoded extends Schema.Codec.Encoded<typeof peppolCreditNoteLineSchema> {}

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

@@ -43,3 +43,4 @@ export const peppolInvoiceLineSchema = peppolBaseLineSchema.pipe(
 );
 
 export interface PeppolInvoiceLine extends Schema.Schema.Type<typeof peppolInvoiceLineSchema> {}
+export interface PeppolInvoiceLineEncoded extends Schema.Codec.Encoded<typeof peppolInvoiceLineSchema> {}

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

@@ -59,5 +59,6 @@ export const peppolLineAllowanceChargeSchema = Schema.Union([
 ]).annotate({ message: 'unable to decode line allowance charge' });
 
 export type PeppolLineAllowanceCharge = typeof peppolLineAllowanceChargeSchema.Type;
+export type PeppolLineAllowanceChargeEncoded = typeof peppolLineAllowanceChargeSchema.Encoded;
 
 export { baseLineAllowanceChargeSchema };

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

@@ -8,6 +8,30 @@ import { peppolPartyTaxSchemeSchema } from '#/effect/fields/peppol-party-tax-sch
 import { electronicCodesSchema } from '#/effect/values/electronic-codes-schema';
 import { icdCodesSchema } from '#/effect/values/icd-codes-schema';
 
+export const peppolPartyEndpointIdSchema = peppolIdentifierSchema.pipe(
+  Schema.fieldsAssign({
+    /**
+     * @description Identifies the Seller/buyer's electronic address to which the application level response to the invoice may be delivered.
+     *
+     * @example
+     *   7300010000001;
+     *
+     * @summary Seller/Buyer electronic address
+     *
+     * @name `#text`
+     */
+    id: Schema.String,
+    /**
+     * @description The identification scheme identifier of the Seller/Buyer electronic address.
+     *
+     * @summary Seller/Buyer electronic address identification scheme identifier
+     *
+     * @name `@schemeID`
+     */
+    schemeId: electronicCodesSchema,
+  })
+);
+
 /**
  * @summary Party common substructure
  *
@@ -24,29 +48,7 @@ export const peppolPartyBaseSchema = Schema.Struct({
    *
    * @name `cbc:EndpointID`
    */
-  endpointId: peppolIdentifierSchema.pipe(
-    Schema.fieldsAssign({
-      /**
-       * @description Identifies the Seller/buyer's electronic address to which the application level response to the invoice may be delivered.
-       *
-       * @example
-       *   7300010000001;
-       *
-       * @summary Seller/Buyer electronic address
-       *
-       * @name `#text`
-       */
-      id: Schema.String,
-      /**
-       * @description The identification scheme identifier of the Seller/Buyer electronic address.
-       *
-       * @summary Seller/Buyer electronic address identification scheme identifier
-       *
-       * @name `@schemeID`
-       */
-      schemeId: electronicCodesSchema,
-    })
-  ),
+  endpointId: peppolPartyEndpointIdSchema,
   /**
    * @example
    *   5060012349998;

package/src/effect/fields/peppol-tax-subtotal-category-schema.ts

@@ -26,4 +26,5 @@ export const peppolTaxSubtotalCategorySchema = peppolTaxCategorySchema.pipe(
   })
 );
 
-export type PeppolTaxSubTotalCategory = typeof peppolTaxSubtotalCategorySchema.Type;
+export interface PeppolTaxSubTotalCategory extends Schema.Schema.Type<typeof peppolTaxSubtotalCategorySchema> {}
+export interface PeppolTaxSubTotalCategoryEncoded extends Schema.Codec.Encoded<typeof peppolTaxSubtotalCategorySchema> {}

package/src/effect/peppol-document-schema.ts

@@ -127,7 +127,7 @@ export const peppolDocumentSchema = peppolDocumentObjectSchema.pipe(
   })
 );
 
-export type PeppolDocumentEncoded = string;
+export type PeppolDocumentEncoded = Schema.Codec.Encoded<typeof peppolDocumentSchema>;
 export interface PeppolDocumentDecoded extends AllUnionFields<Schema.Schema.Type<typeof peppolDocumentSchema>> {}
 
 /**

package/src/effect/values/currency-code-schema.ts

@@ -14,7 +14,13 @@ import { currencyCodesKeys } from '#/values/currency-code.generated';
  *
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/
  */
-export type PeppolCurrencyCode = typeof currencyCodeSchema.Type;
+export type PeppolCurrencyCode = Schema.Schema.Type<typeof currencyCodeSchema>;
+/**
+ * @description An ISO 4217 currency code as defined by the PEPPOL subset.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/
+ */
+export type PeppolCurrencyCodeEncoded = Schema.Codec.Encoded<typeof currencyCodeSchema>;
 
 /**
  * @description Validates an ISO 4217 currency code against the PEPPOL codelist.

package/src/effect/values/duty-tax-fee-category-schema.ts

@@ -8,6 +8,7 @@ import { dutyTaxFeeCategoriesKeys } from '#/values/duty-tax-fee-categories.gener
  * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5305/
  */
 export type PeppolDutyTaxFeeCategoryCode = typeof dutyTaxFeeCategorySchema.Type;
+export type PeppolDutyTaxFeeCategoryCodeEncoded = typeof dutyTaxFeeCategorySchema.Encoded;
 
 /**
  * @description Validates a duty, tax or fee category code against the PEPPOL subset of UNCL 5305 (VAT category code).