@endevops/peppol-schema 0.0.1 → 0.1.0-beta.1

package/dist/effect/document-parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-parser.d.ts","names":[],"sources":["../../src/effect/document-parser.ts"],"mappings":";;;;;;qBAiCa,sBAAoB,OAAA,gBAAA,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAErB,wBAAwB,qBAAqB;;;;wBA6BzC,mBAAmB,cAAc;;;;wBAOjC,mBAAmB,UAAU;;;;wBAqB7B,qBAAqB,cAAc,OAAO,OAAO;;;;wBAOjD,qBAAqB,UAAU,iBAAiB,OAAO;qBAK1D,0BAAiB;qBACjB,mBAAU;qBACV,4BAAmB;qBACnB,qBAAY"}

package/dist/effect/document-parser.js

@@ -0,0 +1,90 @@
+import { invoiceSchema } from "./invoice.js";
+import { creditNoteSchema } from "./credit-note.js";
+import "../constants/message-level-response-profile-id.js";
+import { messageLevelResponse } from "./message-level-response-schema.js";
+import "../constants/invoice-response-profile-id.js";
+import { invoiceResponseSchema } from "./invoice-response-schema.js";
+import { strOrUnd } from "../helpers/str-or-und.js";
+import { decodeCreditNote } from "../decoders/decode-credit-note.js";
+import { decodeInvoice } from "../decoders/decode-invoice.js";
+import { decodeInvoiceResponse } from "../decoders/decode-invoice-response.js";
+import { decodeMessageLevelResponse } from "../decoders/decode-message-level-response.js";
+import { encodeCreditNote } from "../decoders/encode-credit-note.js";
+import { encodeInvoice } from "../decoders/encode-invoice.js";
+import { encodeInvoiceResponse } from "../decoders/encode-invoice-response.js";
+import { encodeMessageLevelResponse } from "../decoders/encode-message-level-response.js";
+import { builderOptions } from "../xml/builder-options.js";
+import { parserOptions } from "../xml/parser-options.js";
+import { Effect, Schema } from "effect";
+import XMLBuilder from "fast-xml-builder";
+import { XMLParser } from "fast-xml-parser";
+//#region src/effect/document-parser.ts
+/**
+* @description Union of every supported PEPPOL business document (Effect port of the `z.xor` side of `documentParser`). Members discriminate cleanly: invoice vs
+* credit note via `invoiceLines`/`creditNoteLines`, message-level vs invoice response via the `profileId` literal.
+*/
+const PeppolDocumentSchema = Schema.Union([
+	invoiceSchema,
+	creditNoteSchema,
+	messageLevelResponse,
+	invoiceResponseSchema
+]);
+/**
+* @description Parse an XML string into raw decoded JSON, branching exactly like `documentParser.decode`. ISO dates stay plain strings (the shared `decode*`
+* helpers never build `Date` objects).
+*
+* @throws When the root element is not a supported document type.
+*/
+function parseXmlToRawDocument(xml) {
+	const parsed = new XMLParser({
+		...parserOptions,
+		removeNSPrefix: true
+	}).parse(xml);
+	if (parsed.Invoice) return decodeInvoice(parsed);
+	else if (parsed.CreditNote) return decodeCreditNote(parsed);
+	else if (parsed.ApplicationResponse) {
+		const profile = strOrUnd(parsed.ApplicationResponse, "cbc:ProfileID");
+		if (profile === "urn:fdc:peppol.eu:poacc:bis:mlr:3") return decodeMessageLevelResponse(parsed);
+		else if (profile === "urn:fdc:peppol.eu:poacc:bis:invoice_response:3") return decodeInvoiceResponse(parsed);
+	}
+	throw new Error(`Unsupported document type: ${Object.keys(parsed).join(",")}`);
+}
+/**
+* @description Decode a PEPPOL XML string into a validated `PeppolDocument`. Throws on error.
+*/
+function decodeDocumentSync(xml) {
+	return Schema.decodeUnknownSync(PeppolDocumentSchema)(parseXmlToRawDocument(xml));
+}
+/**
+* @description Encode a `PeppolDocument` back into a PEPPOL XML string. Throws on error.
+*/
+function encodeDocumentSync(document) {
+	let content;
+	if ("invoiceLines" in document) content = encodeInvoice(document);
+	else if ("creditNoteLines" in document) content = encodeCreditNote(document);
+	else if ("documentResponse" in document) {
+		if (document.profileId === "urn:fdc:peppol.eu:poacc:bis:mlr:3") content = encodeMessageLevelResponse(document);
+		else if (document.profileId === "urn:fdc:peppol.eu:poacc:bis:invoice_response:3") content = encodeInvoiceResponse(document);
+	}
+	return new XMLBuilder(builderOptions).build(content);
+}
+/**
+* @description Effect variant of {@link decodeDocumentSync}: parses and validates, capturing failures in the error channel.
+*/
+function decodeDocumentEffect(xml) {
+	return Effect.try(() => decodeDocumentSync(xml));
+}
+/**
+* @description Effect variant of {@link encodeDocumentSync}: serializes, capturing failures in the error channel.
+*/
+function encodeDocumentEffect(document) {
+	return Effect.try(() => encodeDocumentSync(document));
+}
+const decodeUnknownSync = decodeDocumentSync;
+const encodeSync = encodeDocumentSync;
+const decodeUnknownEffect = decodeDocumentEffect;
+const encodeEffect = encodeDocumentEffect;
+//#endregion
+export { PeppolDocumentSchema, decodeDocumentEffect, decodeDocumentSync, decodeUnknownEffect, decodeUnknownSync, encodeDocumentEffect, encodeDocumentSync, encodeEffect, encodeSync };
+
+//# sourceMappingURL=document-parser.js.map

package/dist/effect/document-parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-parser.js","names":[],"sources":["../../src/effect/document-parser.ts"],"sourcesContent":["import { Effect, Schema } from 'effect';\nimport XMLBuilder from 'fast-xml-builder';\nimport { XMLParser } from 'fast-xml-parser';\n\nimport type { XmlNode } from '#/helpers/get-prop';\nimport type { PeppolCreditNote as ZodPeppolCreditNote } from '#/schemas/credit-note';\nimport type { PeppolInvoice as ZodPeppolInvoice } from '#/schemas/invoice';\nimport type { PeppolInvoiceResponse as ZodPeppolInvoiceResponse } from '#/schemas/invoice-response-schema';\nimport type { PeppolMessageLevelResponse as ZodPeppolMessageLevelResponse } from '#/schemas/message-level-response-schema';\n\nimport { INVOICE_RESPONSE_PROFILE_ID } from '#/constants/invoice-response-profile-id';\nimport { MESSAGE_LEVEL_RESPONSE_PROFILE_ID } from '#/constants/message-level-response-profile-id';\nimport { decodeCreditNote } from '#/decoders/decode-credit-note';\nimport { decodeInvoice } from '#/decoders/decode-invoice';\nimport { decodeInvoiceResponse } from '#/decoders/decode-invoice-response';\nimport { decodeMessageLevelResponse } from '#/decoders/decode-message-level-response';\nimport { encodeCreditNote } from '#/decoders/encode-credit-note';\nimport { encodeInvoice } from '#/decoders/encode-invoice';\nimport { encodeInvoiceResponse } from '#/decoders/encode-invoice-response';\nimport { encodeMessageLevelResponse } from '#/decoders/encode-message-level-response';\nimport { strOrUnd } from '#/helpers/str-or-und';\nimport { builderOptions } from '#/xml/builder-options';\nimport { parserOptions } from '#/xml/parser-options';\n\nimport { creditNoteSchema } from './credit-note';\nimport { invoiceSchema } from './invoice';\nimport { invoiceResponseSchema } from './invoice-response-schema';\nimport { messageLevelResponse } from './message-level-response-schema';\n\n/**\n * @description Union of every supported PEPPOL business document (Effect port of the `z.xor` side of `documentParser`). Members discriminate cleanly: invoice vs\n * credit note via `invoiceLines`/`creditNoteLines`, message-level vs invoice response via the `profileId` literal.\n */\nexport const PeppolDocumentSchema = Schema.Union([invoiceSchema, creditNoteSchema, messageLevelResponse, invoiceResponseSchema]);\n\nexport type PeppolDocument = typeof PeppolDocumentSchema.Type;\n\n/**\n * @description Parse an XML string into raw decoded JSON, branching exactly like `documentParser.decode`. ISO dates stay plain strings (the shared `decode*`\n * helpers never build `Date` objects).\n *\n * @throws When the root element is not a supported document type.\n */\nfunction parseXmlToRawDocument(xml: string): unknown {\n  const parser = new XMLParser({ ...parserOptions, removeNSPrefix: true });\n  const parsed: XmlNode = parser.parse(xml);\n  if (parsed.Invoice) {\n    return decodeInvoice(parsed);\n  } else if (parsed.CreditNote) {\n    return decodeCreditNote(parsed);\n  } else if (parsed.ApplicationResponse) {\n    const profile = strOrUnd(parsed.ApplicationResponse, 'cbc:ProfileID');\n    if (profile === MESSAGE_LEVEL_RESPONSE_PROFILE_ID) {\n      return decodeMessageLevelResponse(parsed);\n    } else if (profile === INVOICE_RESPONSE_PROFILE_ID) {\n      return decodeInvoiceResponse(parsed);\n    }\n  }\n  throw new Error(`Unsupported document type: ${Object.keys(parsed).join(',')}`);\n}\n\n/**\n * @description Decode a PEPPOL XML string into a validated `PeppolDocument`. Throws on error.\n */\nexport function decodeDocumentSync(xml: string): PeppolDocument {\n  return Schema.decodeUnknownSync(PeppolDocumentSchema)(parseXmlToRawDocument(xml));\n}\n\n/**\n * @description Encode a `PeppolDocument` back into a PEPPOL XML string. Throws on error.\n */\nexport function encodeDocumentSync(document: PeppolDocument): string {\n  let content: unknown;\n  if ('invoiceLines' in document) {\n    content = encodeInvoice(document as unknown as ZodPeppolInvoice);\n  } else if ('creditNoteLines' in document) {\n    content = encodeCreditNote(document as unknown as ZodPeppolCreditNote);\n  } else if ('documentResponse' in document) {\n    if (document.profileId === MESSAGE_LEVEL_RESPONSE_PROFILE_ID) {\n      content = encodeMessageLevelResponse(document as unknown as ZodPeppolMessageLevelResponse);\n    } else if (document.profileId === INVOICE_RESPONSE_PROFILE_ID) {\n      content = encodeInvoiceResponse(document as unknown as ZodPeppolInvoiceResponse);\n    }\n  }\n\n  const builder = new XMLBuilder(builderOptions);\n  return builder.build(content);\n}\n\n/**\n * @description Effect variant of {@link decodeDocumentSync}: parses and validates, capturing failures in the error channel.\n */\nexport function decodeDocumentEffect(xml: string): Effect.Effect<PeppolDocument, unknown> {\n  return Effect.try(() => decodeDocumentSync(xml));\n}\n\n/**\n * @description Effect variant of {@link encodeDocumentSync}: serializes, capturing failures in the error channel.\n */\nexport function encodeDocumentEffect(document: PeppolDocument): Effect.Effect<string, unknown> {\n  return Effect.try(() => encodeDocumentSync(document));\n}\n\n// Aliases matching the `decodeUnknownSync`/`encodeSync` + `decodeUnknownEffect`/`encodeEffect` naming.\nexport const decodeUnknownSync = decodeDocumentSync;\nexport const encodeSync = encodeDocumentSync;\nexport const decodeUnknownEffect = decodeDocumentEffect;\nexport const encodeEffect = encodeDocumentEffect;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAiCA,MAAa,uBAAuB,OAAO,MAAM;CAAC;CAAe;CAAkB;CAAsB;AAAqB,CAAC;;;;;;;AAU/H,SAAS,sBAAsB,KAAsB;CAEnD,MAAM,SAAkB,IADL,UAAU;EAAE,GAAG;EAAe,gBAAgB;CAAK,CACzC,CAAC,CAAC,MAAM,GAAG;CACxC,IAAI,OAAO,SACT,OAAO,cAAc,MAAM;MACtB,IAAI,OAAO,YAChB,OAAO,iBAAiB,MAAM;MACzB,IAAI,OAAO,qBAAqB;EACrC,MAAM,UAAU,SAAS,OAAO,qBAAqB,eAAe;EACpE,IAAI,YAAA,qCACF,OAAO,2BAA2B,MAAM;OACnC,IAAI,YAAA,kDACT,OAAO,sBAAsB,MAAM;CAEvC;CACA,MAAM,IAAI,MAAM,8BAA8B,OAAO,KAAK,MAAM,CAAC,CAAC,KAAK,GAAG,GAAG;AAC/E;;;;AAKA,SAAgB,mBAAmB,KAA6B;CAC9D,OAAO,OAAO,kBAAkB,oBAAoB,CAAC,CAAC,sBAAsB,GAAG,CAAC;AAClF;;;;AAKA,SAAgB,mBAAmB,UAAkC;CACnE,IAAI;CACJ,IAAI,kBAAkB,UACpB,UAAU,cAAc,QAAuC;MAC1D,IAAI,qBAAqB,UAC9B,UAAU,iBAAiB,QAA0C;MAChE,IAAI,sBAAsB,UAAU;EACzC,IAAI,SAAS,cAAA,qCACX,UAAU,2BAA2B,QAAoD;OACpF,IAAI,SAAS,cAAA,kDAClB,UAAU,sBAAsB,QAA+C;CAEnF;CAGA,OAAO,IADa,WAAW,cAClB,CAAC,CAAC,MAAM,OAAO;AAC9B;;;;AAKA,SAAgB,qBAAqB,KAAqD;CACxF,OAAO,OAAO,UAAU,mBAAmB,GAAG,CAAC;AACjD;;;;AAKA,SAAgB,qBAAqB,UAA0D;CAC7F,OAAO,OAAO,UAAU,mBAAmB,QAAQ,CAAC;AACtD;AAGA,MAAa,oBAAoB;AACjC,MAAa,aAAa;AAC1B,MAAa,sBAAsB;AACnC,MAAa,eAAe"}

package/dist/effect/document-response-document-reference-schema.d.ts

@@ -0,0 +1,37 @@
+import { Schema } from "effect";
+//#region src/effect/document-response-document-reference-schema.d.ts
+export declare const documentResponseDocumentReferenceSchema: Schema.Struct<{
+  /**
+   * @description Identifies the document on which the message level response is based.
+   *
+   * @example
+   *   `EnvelopeID-12345`;
+   *
+   * @summary Document identifier
+   *
+   * @name `cbc:ID`
+   */
+  readonly id: Schema.String;
+  /**
+   * @description The type of the document being referred to, expressed as a code.
+   *
+   * @summary Document type code
+   *
+   * @name `cbc:DocumentTypeCode`
+   */
+  readonly documentTypeCode: Schema.optional<Schema.Literals<[string, ...string[]]>>;
+  /**
+   * @description The version of the document that has been identifier with the document identifier.
+   *
+   * @example
+   *   `2`;
+   *
+   * @summary Document version identifier
+   *
+   * @name `cbc:VersionID`
+   */
+  readonly versionId: Schema.optional<Schema.String>;
+}>;
+export type PeppolMessageLevelDocumentResponseDocumentReference = typeof documentResponseDocumentReferenceSchema.Type;
+//#endregion
+//# sourceMappingURL=document-response-document-reference-schema.d.ts.map

package/dist/effect/document-response-document-reference-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-response-document-reference-schema.d.ts","names":[],"sources":["../../src/effect/document-response-document-reference-schema.ts"],"mappings":";;qBAIa,yCAAuC,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAiCxC,6DAA6D,wCAAwC"}

package/dist/effect/document-response-document-reference-schema.js

@@ -0,0 +1,39 @@
+import { documentTypeCodeSchema } from "./values/document-type-codes.js";
+import { Schema } from "effect";
+//#region src/effect/document-response-document-reference-schema.ts
+const documentResponseDocumentReferenceSchema = Schema.Struct({
+	/**
+	* @description Identifies the document on which the message level response is based.
+	*
+	* @example
+	*   `EnvelopeID-12345`;
+	*
+	* @summary Document identifier
+	*
+	* @name `cbc:ID`
+	*/
+	id: Schema.String,
+	/**
+	* @description The type of the document being referred to, expressed as a code.
+	*
+	* @summary Document type code
+	*
+	* @name `cbc:DocumentTypeCode`
+	*/
+	documentTypeCode: Schema.optional(documentTypeCodeSchema()),
+	/**
+	* @description The version of the document that has been identifier with the document identifier.
+	*
+	* @example
+	*   `2`;
+	*
+	* @summary Document version identifier
+	*
+	* @name `cbc:VersionID`
+	*/
+	versionId: Schema.optional(Schema.String)
+});
+//#endregion
+export { documentResponseDocumentReferenceSchema };
+
+//# sourceMappingURL=document-response-document-reference-schema.js.map

package/dist/effect/document-response-document-reference-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-response-document-reference-schema.js","names":[],"sources":["../../src/effect/document-response-document-reference-schema.ts"],"sourcesContent":["import { Schema } from 'effect';\n\nimport { documentTypeCodeSchema } from './values/document-type-codes';\n\nexport const documentResponseDocumentReferenceSchema = Schema.Struct({\n  /**\n   * @description Identifies the document on which the message level response is based.\n   *\n   * @example\n   *   `EnvelopeID-12345`;\n   *\n   * @summary Document identifier\n   *\n   * @name `cbc:ID`\n   */\n  id: Schema.String,\n  /**\n   * @description The type of the document being referred to, expressed as a code.\n   *\n   * @summary Document type code\n   *\n   * @name `cbc:DocumentTypeCode`\n   */\n  documentTypeCode: Schema.optional(documentTypeCodeSchema()),\n  /**\n   * @description The version of the document that has been identifier with the document identifier.\n   *\n   * @example\n   *   `2`;\n   *\n   * @summary Document version identifier\n   *\n   * @name `cbc:VersionID`\n   */\n  versionId: Schema.optional(Schema.String),\n});\n\nexport type PeppolMessageLevelDocumentResponseDocumentReference = typeof documentResponseDocumentReferenceSchema.Type;\n"],"mappings":";;;AAIA,MAAa,0CAA0C,OAAO,OAAO;;;;;;;;;;;CAWnE,IAAI,OAAO;;;;;;;;CAQX,kBAAkB,OAAO,SAAS,uBAAuB,CAAC;;;;;;;;;;;CAW1D,WAAW,OAAO,SAAS,OAAO,MAAM;AAC1C,CAAC"}

package/dist/effect/document-response-document-schema.d.ts

@@ -0,0 +1,34 @@
+import { Schema } from "effect";
+//#region src/effect/document-response-document-schema.d.ts
+/**
+ * @summary Response information
+ *
+ * @name `cac:Response`
+ *
+ * @cardinality (1..1)
+ *
+ * @see {@link messageLevelResponseDocumentResponseSchema}
+ */
+export declare const documentResponseDocumentSchema: Schema.Struct<{
+  /**
+   * @description An indicator stating whether the referenced message was cleared through validation and advanced to the next step in the process. A negative
+   * response states that the document was not processed because of identified issues.
+   *
+   * @example
+   *   `RE`;
+   *
+   * @summary Message response code
+   *
+   * @name `cbc:ResponseCode`
+   */
+  readonly responseCode: Schema.Literals<readonly ["AB", "AP", "RE"]>;
+  /**
+   * @description Used to meake any comments or instructions relevant to the response. The use of this element requires manual assessment by the receiver.
+   *
+   * @summary Response textual notes
+   */
+  readonly description: Schema.optional<Schema.String>;
+}>;
+export type PeppolMessageLevelResponseDocumentResponseDocument = typeof documentResponseDocumentSchema.Type;
+//#endregion
+//# sourceMappingURL=document-response-document-schema.d.ts.map

package/dist/effect/document-response-document-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-response-document-schema.d.ts","names":[],"sources":["../../src/effect/document-response-document-schema.ts"],"mappings":";;;;;;;;;;;qBAaa,gCAA8B,OAAA;;;;;;;;;;;;;;;;;;;;YAqB/B,4DAA4D,+BAA+B"}

package/dist/effect/document-response-document-schema.js

@@ -0,0 +1,36 @@
+import { applicationResponseTypeCodeSchema } from "./values/application-response-type-codes.js";
+import { Schema } from "effect";
+//#region src/effect/document-response-document-schema.ts
+/**
+* @summary Response information
+*
+* @name `cac:Response`
+*
+* @cardinality (1..1)
+*
+* @see {@link messageLevelResponseDocumentResponseSchema}
+*/
+const documentResponseDocumentSchema = Schema.Struct({
+	/**
+	* @description An indicator stating whether the referenced message was cleared through validation and advanced to the next step in the process. A negative
+	* response states that the document was not processed because of identified issues.
+	*
+	* @example
+	*   `RE`;
+	*
+	* @summary Message response code
+	*
+	* @name `cbc:ResponseCode`
+	*/
+	responseCode: applicationResponseTypeCodeSchema(),
+	/**
+	* @description Used to meake any comments or instructions relevant to the response. The use of this element requires manual assessment by the receiver.
+	*
+	* @summary Response textual notes
+	*/
+	description: Schema.optional(Schema.String)
+});
+//#endregion
+export { documentResponseDocumentSchema };
+
+//# sourceMappingURL=document-response-document-schema.js.map

package/dist/effect/document-response-document-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-response-document-schema.js","names":[],"sources":["../../src/effect/document-response-document-schema.ts"],"sourcesContent":["import { Schema } from 'effect';\n\nimport { applicationResponseTypeCodeSchema } from './values/application-response-type-codes';\n\n/**\n * @summary Response information\n *\n * @name `cac:Response`\n *\n * @cardinality (1..1)\n *\n * @see {@link messageLevelResponseDocumentResponseSchema}\n */\nexport const documentResponseDocumentSchema = Schema.Struct({\n  /**\n   * @description An indicator stating whether the referenced message was cleared through validation and advanced to the next step in the process. A negative\n   * response states that the document was not processed because of identified issues.\n   *\n   * @example\n   *   `RE`;\n   *\n   * @summary Message response code\n   *\n   * @name `cbc:ResponseCode`\n   */\n  responseCode: applicationResponseTypeCodeSchema(),\n  /**\n   * @description Used to meake any comments or instructions relevant to the response. The use of this element requires manual assessment by the receiver.\n   *\n   * @summary Response textual notes\n   */\n  description: Schema.optional(Schema.String),\n});\n\nexport type PeppolMessageLevelResponseDocumentResponseDocument = typeof documentResponseDocumentSchema.Type;\n"],"mappings":";;;;;;;;;;;;AAaA,MAAa,iCAAiC,OAAO,OAAO;;;;;;;;;;;;CAY1D,cAAc,kCAAkC;;;;;;CAMhD,aAAa,OAAO,SAAS,OAAO,MAAM;AAC5C,CAAC"}

package/dist/effect/document-response-line-response-content.d.ts

@@ -0,0 +1,43 @@
+import { Schema } from "effect";
+//#region src/effect/document-response-line-response-content.d.ts
+export declare const documentResponseLineResponseContent: Schema.Struct<{
+  /**
+   * @description An indicator stating whether the referenced message was cleared through validation and advanced to the next step in the process. A negative
+   * response states that the document was not processed because of identified issues.
+   *
+   * @example
+   *   `RE`;
+   *
+   * @summary Line response code
+   *
+   * @name `cbc:ResponseCode`
+   */
+  readonly responseCode: Schema.Literals<readonly ["AB", "AP", "RE"]>;
+  /**
+   * @description The description of the issued identifier in the transaction document.
+   *
+   * @example
+   *   `Validation gives error [CL-T77-R0002]- Tax categories MUST be coded using UN/ECE 5305 code list`;
+   *
+   * @summary Issue description
+   *
+   * @name `cbc:Description`
+   */
+  readonly description: Schema.String;
+  /**
+   * @name `cac:Status`
+   */
+  readonly status: Schema.Struct<{
+    /**
+     * @description A codified version of the issue description that describes the nature of the issue. e.g. Syntax violation, business rule violation, ...
+     *
+     * @summary Issue type coded
+     *
+     * @name `cbc:StatusReasonCode`
+     */
+    readonly statusReasonCode: Schema.Literals<readonly ["BV", "BW", "SV"]>;
+  }>;
+}>;
+export type DocumentResponseLineResponseContent = typeof documentResponseLineResponseContent.Type;
+//#endregion
+//# sourceMappingURL=document-response-line-response-content.d.ts.map

package/dist/effect/document-response-line-response-content.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-response-line-response-content.d.ts","names":[],"sources":["../../src/effect/document-response-line-response-content.ts"],"mappings":";;qBAIa,qCAAmC,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAuCpC,6CAA6C,oCAAoC"}

package/dist/effect/document-response-line-response-content.js

@@ -0,0 +1,48 @@
+import { applicationResponseTypeCodeSchema } from "./values/application-response-type-codes.js";
+import { Schema } from "effect";
+//#region src/effect/document-response-line-response-content.ts
+const documentResponseLineResponseContent = Schema.Struct({
+	/**
+	* @description An indicator stating whether the referenced message was cleared through validation and advanced to the next step in the process. A negative
+	* response states that the document was not processed because of identified issues.
+	*
+	* @example
+	*   `RE`;
+	*
+	* @summary Line response code
+	*
+	* @name `cbc:ResponseCode`
+	*/
+	responseCode: applicationResponseTypeCodeSchema(),
+	/**
+	* @description The description of the issued identifier in the transaction document.
+	*
+	* @example
+	*   `Validation gives error [CL-T77-R0002]- Tax categories MUST be coded using UN/ECE 5305 code list`;
+	*
+	* @summary Issue description
+	*
+	* @name `cbc:Description`
+	*/
+	description: Schema.String,
+	/**
+	* @name `cac:Status`
+	*/
+	status: Schema.Struct({ 
+	/**
+	* @description A codified version of the issue description that describes the nature of the issue. e.g. Syntax violation, business rule violation, ...
+	*
+	* @summary Issue type coded
+	*
+	* @name `cbc:StatusReasonCode`
+	*/
+statusReasonCode: Schema.Literals([
+		"BV",
+		"BW",
+		"SV"
+	]) })
+});
+//#endregion
+export { documentResponseLineResponseContent };
+
+//# sourceMappingURL=document-response-line-response-content.js.map

package/dist/effect/document-response-line-response-content.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-response-line-response-content.js","names":[],"sources":["../../src/effect/document-response-line-response-content.ts"],"sourcesContent":["import { Schema } from 'effect';\n\nimport { applicationResponseTypeCodeSchema } from './values/application-response-type-codes';\n\nexport const documentResponseLineResponseContent = Schema.Struct({\n  /**\n   * @description An indicator stating whether the referenced message was cleared through validation and advanced to the next step in the process. A negative\n   * response states that the document was not processed because of identified issues.\n   *\n   * @example\n   *   `RE`;\n   *\n   * @summary Line response code\n   *\n   * @name `cbc:ResponseCode`\n   */\n  responseCode: applicationResponseTypeCodeSchema(),\n  /**\n   * @description The description of the issued identifier in the transaction document.\n   *\n   * @example\n   *   `Validation gives error [CL-T77-R0002]- Tax categories MUST be coded using UN/ECE 5305 code list`;\n   *\n   * @summary Issue description\n   *\n   * @name `cbc:Description`\n   */\n  description: Schema.String,\n  /**\n   * @name `cac:Status`\n   */\n  status: Schema.Struct({\n    /**\n     * @description A codified version of the issue description that describes the nature of the issue. e.g. Syntax violation, business rule violation, ...\n     *\n     * @summary Issue type coded\n     *\n     * @name `cbc:StatusReasonCode`\n     */\n    statusReasonCode: Schema.Literals(['BV', 'BW', 'SV']),\n  }),\n});\n\nexport type DocumentResponseLineResponseContent = typeof documentResponseLineResponseContent.Type;\n"],"mappings":";;;AAIA,MAAa,sCAAsC,OAAO,OAAO;;;;;;;;;;;;CAY/D,cAAc,kCAAkC;;;;;;;;;;;CAWhD,aAAa,OAAO;;;;CAIpB,QAAQ,OAAO,OAAO;;;;;;;;AAQpB,kBAAkB,OAAO,SAAS;EAAC;EAAM;EAAM;CAAI,CAAC,EACtD,CAAC;AACH,CAAC"}

package/dist/effect/document-response-line-response-schema.d.ts

@@ -0,0 +1,38 @@
+import { Schema } from "effect";
+//#region src/effect/document-response-line-response-schema.d.ts
+export declare const documentResponseLineResponseSchema: Schema.Struct<{
+  /**
+   * @description Identifies the line in the business document to which the reported issue applies.
+   *
+   * @summary Line reference
+   *
+   * @name `cac:LineReference`
+   */
+  readonly lineReference: Schema.Struct<{
+    /**
+     * @description Identifies the section of the document to which the reported issue applied. The LineID element mustbe used to indicate where in the business
+     * document the error occurred by using XPath to reference the element causing the error. To cater for scenarios where it is not possible to
+     * provide XPath, a dummy value must be applied. The dummay value must consist of the characters NA. This is due to that the LineID element is
+     * mendatory in the ApplicationResponse message in UBL 2.1 on which the MLR message is based.
+     *
+     * @example
+     *   `/Catalogue/cac:CatalogueLine[3]/cac:Item[1]/cac:ClassifiedTaxCategory[1]/cbc:ID[1]`;
+     *
+     * @summary Section identifier
+     */
+    readonly lineId: Schema.String;
+  }>;
+  /**
+   * @summary Line response information
+   */
+  readonly response: Schema.Struct<{
+    readonly responseCode: Schema.Literals<readonly ["AB", "AP", "RE"]>;
+    readonly description: Schema.String;
+    readonly status: Schema.Struct<{
+      readonly statusReasonCode: Schema.Literals<readonly ["BV", "BW", "SV"]>;
+    }>;
+  }>;
+}>;
+export type PeppolMessageLevelDocumentResponseLineResponse = typeof documentResponseLineResponseSchema.Type;
+//#endregion
+//# sourceMappingURL=document-response-line-response-schema.d.ts.map

package/dist/effect/document-response-line-response-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-response-line-response-schema.d.ts","names":[],"sources":["../../src/effect/document-response-line-response-schema.ts"],"mappings":";;qBAIa,oCAAkC,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YA4BnC,wDAAwD,mCAAmC"}

package/dist/effect/document-response-line-response-schema.js

@@ -0,0 +1,33 @@
+import { documentResponseLineResponseContent } from "./document-response-line-response-content.js";
+import { Schema } from "effect";
+//#region src/effect/document-response-line-response-schema.ts
+const documentResponseLineResponseSchema = Schema.Struct({
+	/**
+	* @description Identifies the line in the business document to which the reported issue applies.
+	*
+	* @summary Line reference
+	*
+	* @name `cac:LineReference`
+	*/
+	lineReference: Schema.Struct({ 
+	/**
+	* @description Identifies the section of the document to which the reported issue applied. The LineID element mustbe used to indicate where in the business
+	* document the error occurred by using XPath to reference the element causing the error. To cater for scenarios where it is not possible to
+	* provide XPath, a dummy value must be applied. The dummay value must consist of the characters NA. This is due to that the LineID element is
+	* mendatory in the ApplicationResponse message in UBL 2.1 on which the MLR message is based.
+	*
+	* @example
+	*   `/Catalogue/cac:CatalogueLine[3]/cac:Item[1]/cac:ClassifiedTaxCategory[1]/cbc:ID[1]`;
+	*
+	* @summary Section identifier
+	*/
+lineId: Schema.String }),
+	/**
+	* @summary Line response information
+	*/
+	response: documentResponseLineResponseContent
+});
+//#endregion
+export { documentResponseLineResponseSchema };
+
+//# sourceMappingURL=document-response-line-response-schema.js.map

package/dist/effect/document-response-line-response-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-response-line-response-schema.js","names":[],"sources":["../../src/effect/document-response-line-response-schema.ts"],"sourcesContent":["import { Schema } from 'effect';\n\nimport { documentResponseLineResponseContent } from './document-response-line-response-content';\n\nexport const documentResponseLineResponseSchema = Schema.Struct({\n  /**\n   * @description Identifies the line in the business document to which the reported issue applies.\n   *\n   * @summary Line reference\n   *\n   * @name `cac:LineReference`\n   */\n  lineReference: Schema.Struct({\n    /**\n     * @description Identifies the section of the document to which the reported issue applied. The LineID element mustbe used to indicate where in the business\n     * document the error occurred by using XPath to reference the element causing the error. To cater for scenarios where it is not possible to\n     * provide XPath, a dummy value must be applied. The dummay value must consist of the characters NA. This is due to that the LineID element is\n     * mendatory in the ApplicationResponse message in UBL 2.1 on which the MLR message is based.\n     *\n     * @example\n     *   `/Catalogue/cac:CatalogueLine[3]/cac:Item[1]/cac:ClassifiedTaxCategory[1]/cbc:ID[1]`;\n     *\n     * @summary Section identifier\n     */\n    lineId: Schema.String,\n  }),\n  /**\n   * @summary Line response information\n   */\n  response: documentResponseLineResponseContent,\n});\n\nexport type PeppolMessageLevelDocumentResponseLineResponse = typeof documentResponseLineResponseSchema.Type;\n"],"mappings":";;;AAIA,MAAa,qCAAqC,OAAO,OAAO;;;;;;;;CAQ9D,eAAe,OAAO,OAAO;;;;;;;;;;;;AAY3B,QAAQ,OAAO,OACjB,CAAC;;;;CAID,UAAU;AACZ,CAAC"}

package/dist/effect/fields/additional-document-reference-schema.d.ts

@@ -0,0 +1,76 @@
+import { Schema } from "effect";
+//#region src/effect/fields/additional-document-reference-schema.d.ts
+/**
+ * @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 declare const additionalDocumentReferenceSchema: Schema.Struct<{
+  readonly schemeId: Schema.optional<Schema.String>;
+  readonly 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`
+     */
+    readonly id: Schema.String;
+    /**
+     * @description The identification scheme identifier of the Invoiced object identifier.
+     *
+     * @summary Scheme identifier
+     *
+     * @name `@schemeID`
+     */
+    readonly schemeId: Schema.optional<Schema.Literals<[string, ...string[]]>>;
+  }>;
+  readonly documentTypeCode: Schema.optional<Schema.String>;
+  readonly documentDescription: Schema.optional<Schema.String>;
+  readonly 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`
+     */
+    readonly embeddedDocumentBinaryObject: Schema.optional<Schema.Struct<{
+      readonly content: Schema.Union<readonly [Schema.String, Schema.String]>;
+      readonly mimeCode: Schema.Literals<readonly ["text/csv", "application/pdf", "image/png", "image/jpeg", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.oasis.opendocument.spreadsheet"]>;
+      readonly filename: Schema.String;
+    }>>;
+    /**
+     * @summary EXTERNAL REFERENCE
+     *
+     * @name `cac:ExternalReference`
+     */
+    readonly 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`
+       */
+      readonly uri: Schema.String;
+    }>>;
+  }>>;
+}>;
+export type PeppolAdditionalDocumentReference = typeof additionalDocumentReferenceSchema.Type;
+//#endregion
+//# sourceMappingURL=additional-document-reference-schema.d.ts.map

package/dist/effect/fields/additional-document-reference-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"additional-document-reference-schema.d.ts","names":[],"sources":["../../../src/effect/fields/additional-document-reference-schema.ts"],"mappings":";;;;;;;;;;;qBAgBa,mCAAiC,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAkGlC,2CAA2C,kCAAkC"}

package/dist/effect/fields/additional-document-reference-schema.js

@@ -0,0 +1,108 @@
+import { additionalDocumentReferenceCodeSchema } from "../values/additional-document-reference-code.js";
+import { binaryObjectSchema } from "./binary-object-schema.js";
+import { identifierSchema } from "./identifier-schema.js";
+import { Schema } from "effect";
+//#region src/effect/fields/additional-document-reference-schema.ts
+/**
+* @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`
+*/
+const additionalDocumentReferenceSchema = identifierSchema().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(binaryObjectSchema),
+		/**
+		* @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 }))
+	}))
+}));
+//#endregion
+export { additionalDocumentReferenceSchema };
+
+//# sourceMappingURL=additional-document-reference-schema.js.map