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

package/dist/effect/values/application-response-type-code-schema.d.ts

@@ -0,0 +1,21 @@
+import { ApplicationResponseTypeCodesKeys } from "../../values/application-response-type-codes.generated.js";
+import { Schema } from "effect";
+//#region src/effect/values/application-response-type-code-schema.d.ts
+/**
+ * @description An application response type code as defined by the PEPPOL subset of UNCL 4343.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343/
+ */
+export type PeppolApplicationResponseTypeCode = ApplicationResponseTypeCodesKeys;
+/**
+ * @description Validates an application response type code against the PEPPOL subset of UNCL 4343.
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns An Effect schema that accepts only valid application response type codes.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343/
+ */
+export declare function applicationResponseTypeCodeSchema(error?: string): Schema.Literals<readonly ["AB", "AP", "RE"]>;
+//#endregion
+//# sourceMappingURL=application-response-type-code-schema.d.ts.map

package/dist/effect/values/application-response-type-code-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"application-response-type-code-schema.d.ts","names":[],"sources":["../../../src/effect/values/application-response-type-code-schema.ts"],"mappings":";;;;;;;;YAWY,oCAAoC;;;;;;;;;;wBAWhC,kCAAkC,iBAAc,OAAA"}

package/dist/effect/values/application-response-type-code-schema.js

@@ -0,0 +1,20 @@
+import { applicationResponseTypeCodesKeys } from "../../values/application-response-type-codes.generated.js";
+import { Schema } from "effect";
+//#region src/effect/values/application-response-type-code-schema.ts
+/**
+* @description Validates an application response type code against the PEPPOL subset of UNCL 4343.
+*
+* @param error - The custom error message to use when validation fails.
+*
+* @returns An Effect schema that accepts only valid application response type codes.
+*
+* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343/
+*/
+function applicationResponseTypeCodeSchema(error) {
+	const schema = Schema.Literals(applicationResponseTypeCodesKeys);
+	return error === void 0 ? schema : schema.annotate({ message: error });
+}
+//#endregion
+export { applicationResponseTypeCodeSchema };
+
+//# sourceMappingURL=application-response-type-code-schema.js.map

package/dist/effect/values/application-response-type-code-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"application-response-type-code-schema.js","names":[],"sources":["../../../src/effect/values/application-response-type-code-schema.ts"],"sourcesContent":["import { Schema } from 'effect';\n\nimport type { ApplicationResponseTypeCodesKeys } from '#/values/application-response-type-codes.generated';\n\nimport { applicationResponseTypeCodesKeys } from '#/values/application-response-type-codes.generated';\n\n/**\n * @description An application response type code as defined by the PEPPOL subset of UNCL 4343.\n *\n * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343/\n */\nexport type PeppolApplicationResponseTypeCode = ApplicationResponseTypeCodesKeys;\n\n/**\n * @description Validates an application response type code against the PEPPOL subset of UNCL 4343.\n *\n * @param error - The custom error message to use when validation fails.\n *\n * @returns An Effect schema that accepts only valid application response type codes.\n *\n * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343/\n */\nexport function applicationResponseTypeCodeSchema(error?: string) {\n  const schema = Schema.Literals(applicationResponseTypeCodesKeys);\n  return error === undefined ? schema : schema.annotate({ message: error });\n}\n"],"mappings":";;;;;;;;;;;;AAsBA,SAAgB,kCAAkC,OAAgB;CAChE,MAAM,SAAS,OAAO,SAAS,gCAAgC;CAC/D,OAAO,UAAU,KAAA,IAAY,SAAS,OAAO,SAAS,EAAE,SAAS,MAAM,CAAC;AAC1E"}

package/dist/effect/values/charge-reason-code-schema.d.ts

@@ -0,0 +1,24 @@
+import { ChargeReasonCodesKeys } from "../../values/charge-reason-codes.generated.js";
+import { Schema } from "effect";
+//#region src/effect/values/charge-reason-code-schema.d.ts
+/**
+ * @description A charge reason code as defined by the PEPPOL subset of UNCL 7161.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL7161/
+ */
+export type PeppolChargeReasonCode = ChargeReasonCodesKeys;
+/**
+ * @description Validates a charge reason code against the PEPPOL subset of UNCL 7161 (D.16B).
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns An Effect schema that accepts only valid charge reason codes.
+ *
+ * @validations
+ * - PEPPOL-EN16931-CL003: Charge reason code MUST be according to UNCL 7161 D.16B.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL7161/
+ */
+export declare function chargeReasonCodeSchema(error?: string): Schema.Literals<[string, ...string[]]>;
+//#endregion
+//# sourceMappingURL=charge-reason-code-schema.d.ts.map

package/dist/effect/values/charge-reason-code-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"charge-reason-code-schema.d.ts","names":[],"sources":["../../../src/effect/values/charge-reason-code-schema.ts"],"mappings":";;;;;;;;YAWY,yBAAyB;;;;;;;;;;;;;wBAcrB,uBAAuB,iBAAc,OAAA"}

package/dist/effect/values/charge-reason-code-schema.js

@@ -0,0 +1,23 @@
+import { chargeReasonCodesKeys } from "../../values/charge-reason-codes.generated.js";
+import { Schema } from "effect";
+//#region src/effect/values/charge-reason-code-schema.ts
+/**
+* @description Validates a charge reason code against the PEPPOL subset of UNCL 7161 (D.16B).
+*
+* @param error - The custom error message to use when validation fails.
+*
+* @returns An Effect schema that accepts only valid charge reason codes.
+*
+* @validations
+* - PEPPOL-EN16931-CL003: Charge reason code MUST be according to UNCL 7161 D.16B.
+*
+* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL7161/
+*/
+function chargeReasonCodeSchema(error) {
+	const schema = Schema.Literals(chargeReasonCodesKeys);
+	return error === void 0 ? schema : schema.annotate({ message: error });
+}
+//#endregion
+export { chargeReasonCodeSchema };
+
+//# sourceMappingURL=charge-reason-code-schema.js.map

package/dist/effect/values/charge-reason-code-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"charge-reason-code-schema.js","names":[],"sources":["../../../src/effect/values/charge-reason-code-schema.ts"],"sourcesContent":["import { Schema } from 'effect';\n\nimport type { ChargeReasonCodesKeys } from '#/values/charge-reason-codes.generated';\n\nimport { chargeReasonCodesKeys } from '#/values/charge-reason-codes.generated';\n\n/**\n * @description A charge reason code as defined by the PEPPOL subset of UNCL 7161.\n *\n * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL7161/\n */\nexport type PeppolChargeReasonCode = ChargeReasonCodesKeys;\n\n/**\n * @description Validates a charge reason code against the PEPPOL subset of UNCL 7161 (D.16B).\n *\n * @param error - The custom error message to use when validation fails.\n *\n * @returns An Effect schema that accepts only valid charge reason codes.\n *\n * @validations\n * - PEPPOL-EN16931-CL003: Charge reason code MUST be according to UNCL 7161 D.16B.\n *\n * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL7161/\n */\nexport function chargeReasonCodeSchema(error?: string) {\n  // validate against PEPPOL-EN16931-CL003: Reason code MUST be according to UNCL 7161 D.16B.\n  const schema = Schema.Literals(chargeReasonCodesKeys);\n  return error === undefined ? schema : schema.annotate({ message: error });\n}\n"],"mappings":";;;;;;;;;;;;;;;AAyBA,SAAgB,uBAAuB,OAAgB;CAErD,MAAM,SAAS,OAAO,SAAS,qBAAqB;CACpD,OAAO,UAAU,KAAA,IAAY,SAAS,OAAO,SAAS,EAAE,SAAS,MAAM,CAAC;AAC1E"}

package/dist/effect/values/credit-note-type-code-schema.d.ts

@@ -0,0 +1,21 @@
+import { CreditNoteTypeCodesKeys } from "../../values/credit-notes-type-codes.generated.js";
+import { Schema } from "effect";
+//#region src/effect/values/credit-note-type-code-schema.d.ts
+/**
+ * @description A credit note type code as defined by the PEPPOL subset of UNCL 1001 (credit note).
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-cn/
+ */
+export type PeppolCreditNoteTypeCode = CreditNoteTypeCodesKeys;
+/**
+ * @description Validates a credit note type code against the PEPPOL subset of UNCL 1001 (credit note).
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns An Effect schema that accepts only valid credit note type codes.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-cn/
+ */
+export declare function creditNoteTypeCodeSchema(error?: string): Schema.Literals<readonly ["81", "83", "381", "396", "532"]>;
+//#endregion
+//# sourceMappingURL=credit-note-type-code-schema.d.ts.map

package/dist/effect/values/credit-note-type-code-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"credit-note-type-code-schema.d.ts","names":[],"sources":["../../../src/effect/values/credit-note-type-code-schema.ts"],"mappings":";;;;;;;;YAWY,2BAA2B;;;;;;;;;;wBAWvB,yBAAyB,iBAAc,OAAA"}

package/dist/effect/values/credit-note-type-code-schema.js

@@ -0,0 +1,20 @@
+import { creditNoteTypeCodesKeys } from "../../values/credit-notes-type-codes.generated.js";
+import { Schema } from "effect";
+//#region src/effect/values/credit-note-type-code-schema.ts
+/**
+* @description Validates a credit note type code against the PEPPOL subset of UNCL 1001 (credit note).
+*
+* @param error - The custom error message to use when validation fails.
+*
+* @returns An Effect schema that accepts only valid credit note type codes.
+*
+* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-cn/
+*/
+function creditNoteTypeCodeSchema(error) {
+	const schema = Schema.Literals(creditNoteTypeCodesKeys);
+	return error === void 0 ? schema : schema.annotate({ message: error });
+}
+//#endregion
+export { creditNoteTypeCodeSchema };
+
+//# sourceMappingURL=credit-note-type-code-schema.js.map

package/dist/effect/values/credit-note-type-code-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"credit-note-type-code-schema.js","names":[],"sources":["../../../src/effect/values/credit-note-type-code-schema.ts"],"sourcesContent":["import { Schema } from 'effect';\n\nimport type { CreditNoteTypeCodesKeys } from '#/values/credit-notes-type-codes.generated';\n\nimport { creditNoteTypeCodesKeys } from '#/values/credit-notes-type-codes.generated';\n\n/**\n * @description A credit note type code as defined by the PEPPOL subset of UNCL 1001 (credit note).\n *\n * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-cn/\n */\nexport type PeppolCreditNoteTypeCode = CreditNoteTypeCodesKeys;\n\n/**\n * @description Validates a credit note type code against the PEPPOL subset of UNCL 1001 (credit note).\n *\n * @param error - The custom error message to use when validation fails.\n *\n * @returns An Effect schema that accepts only valid credit note type codes.\n *\n * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-cn/\n */\nexport function creditNoteTypeCodeSchema(error?: string) {\n  const schema = Schema.Literals(creditNoteTypeCodesKeys);\n  return error === undefined ? schema : schema.annotate({ message: error });\n}\n"],"mappings":";;;;;;;;;;;;AAsBA,SAAgB,yBAAyB,OAAgB;CACvD,MAAM,SAAS,OAAO,SAAS,uBAAuB;CACtD,OAAO,UAAU,KAAA,IAAY,SAAS,OAAO,SAAS,EAAE,SAAS,MAAM,CAAC;AAC1E"}

package/dist/effect/values/currency-code-schema.d.ts

@@ -0,0 +1,24 @@
+import { CurrencyCodesKeys } from "../../values/currency-code.generated.js";
+import { Schema } from "effect";
+//#region src/effect/values/currency-code-schema.d.ts
+/**
+ * @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 PeppolCurrencyCode = CurrencyCodesKeys;
+/**
+ * @description Validates an ISO 4217 currency code against the PEPPOL codelist.
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns An Effect schema that accepts only valid currency codes.
+ *
+ * @validations
+ * - PEPPOL-EN16931-CL007: Currency codes MUST be valid ISO 4217 codes.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/
+ */
+export declare function currencyCodeSchema(error?: string): Schema.Literals<[string, ...string[]]>;
+//#endregion
+//# sourceMappingURL=currency-code-schema.d.ts.map

package/dist/effect/values/currency-code-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"currency-code-schema.d.ts","names":[],"sources":["../../../src/effect/values/currency-code-schema.ts"],"mappings":";;;;;;;;YAkBY,qBAAqB;;;;;;;;;;;;;wBAcjB,mBAAmB,iBAAc,OAAA"}

package/dist/effect/values/currency-code-schema.js

@@ -0,0 +1,29 @@
+import { currencyCodesKeys } from "../../values/currency-code.generated.js";
+import { Schema } from "effect";
+//#region src/effect/values/currency-code-schema.ts
+/**
+* @description Currency codes as defined by ISO 4217.
+*
+* @see https://www.iso.org/iso-4217-currency-codes.html
+* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/
+*/
+/**
+* @description Validates an ISO 4217 currency code against the PEPPOL codelist.
+*
+* @param error - The custom error message to use when validation fails.
+*
+* @returns An Effect schema that accepts only valid currency codes.
+*
+* @validations
+* - PEPPOL-EN16931-CL007: Currency codes MUST be valid ISO 4217 codes.
+*
+* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/
+*/
+function currencyCodeSchema(error) {
+	const schema = Schema.Literals(currencyCodesKeys);
+	return error === void 0 ? schema : schema.annotate({ message: error });
+}
+//#endregion
+export { currencyCodeSchema };
+
+//# sourceMappingURL=currency-code-schema.js.map

package/dist/effect/values/currency-code-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"currency-code-schema.js","names":[],"sources":["../../../src/effect/values/currency-code-schema.ts"],"sourcesContent":["/**\n * @description Currency codes as defined by ISO 4217.\n *\n * @see https://www.iso.org/iso-4217-currency-codes.html\n * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/\n */\n\nimport { Schema } from 'effect';\n\nimport type { CurrencyCodesKeys } from '#/values/currency-code.generated';\n\nimport { currencyCodesKeys } from '#/values/currency-code.generated';\n\n/**\n * @description An ISO 4217 currency code as defined by the PEPPOL subset.\n *\n * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/\n */\nexport type PeppolCurrencyCode = CurrencyCodesKeys;\n\n/**\n * @description Validates an ISO 4217 currency code against the PEPPOL codelist.\n *\n * @param error - The custom error message to use when validation fails.\n *\n * @returns An Effect schema that accepts only valid currency codes.\n *\n * @validations\n * - PEPPOL-EN16931-CL007: Currency codes MUST be valid ISO 4217 codes.\n *\n * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/\n */\nexport function currencyCodeSchema(error?: string) {\n  const schema = Schema.Literals(currencyCodesKeys);\n  return error === undefined ? schema : schema.annotate({ message: error });\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAgCA,SAAgB,mBAAmB,OAAgB;CACjD,MAAM,SAAS,OAAO,SAAS,iBAAiB;CAChD,OAAO,UAAU,KAAA,IAAY,SAAS,OAAO,SAAS,EAAE,SAAS,MAAM,CAAC;AAC1E"}

package/dist/effect/values/document-type-schemes-schema.d.ts

@@ -0,0 +1,14 @@
+import { Schema } from "effect";
+//#region src/effect/values/document-type-schemes-schema.d.ts
+/**
+ * @description Validates a PEPPOL document type scheme (e.g. `busdox-docid-qns`, `peppol-doctype-wildcard`).
+ *
+ * @param error - The error message to use when validation fails. Defaults to `'invalid Peppol document type scheme'`.
+ *
+ * @returns An Effect schema that accepts only valid document type schemes.
+ *
+ * @see {@link documentTypesScheme}
+ */
+export declare function documentTypeSchemesSchema(error?: string): Schema.Literals<[string, ...string[]]>;
+//#endregion
+//# sourceMappingURL=document-type-schemes-schema.d.ts.map

package/dist/effect/values/document-type-schemes-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-type-schemes-schema.d.ts","names":[],"sources":["../../../src/effect/values/document-type-schemes-schema.ts"],"mappings":";;;;;;;;;;;wBAagB,0BAA0B,iBAA6C,OAAA"}

package/dist/effect/values/document-type-schemes-schema.js

@@ -0,0 +1,19 @@
+import { documentTypesScheme } from "../../values/document-type.generated.js";
+import { Schema } from "effect";
+//#region src/effect/values/document-type-schemes-schema.ts
+/**
+* @description Validates a PEPPOL document type scheme (e.g. `busdox-docid-qns`, `peppol-doctype-wildcard`).
+*
+* @param error - The error message to use when validation fails. Defaults to `'invalid Peppol document type scheme'`.
+*
+* @returns An Effect schema that accepts only valid document type schemes.
+*
+* @see {@link documentTypesScheme}
+*/
+function documentTypeSchemesSchema(error = "invalid Peppol document type scheme") {
+	return Schema.Literals(documentTypesScheme).annotate({ message: error });
+}
+//#endregion
+export { documentTypeSchemesSchema };
+
+//# sourceMappingURL=document-type-schemes-schema.js.map

package/dist/effect/values/document-type-schemes-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-type-schemes-schema.js","names":[],"sources":["../../../src/effect/values/document-type-schemes-schema.ts"],"sourcesContent":["import { Schema } from 'effect';\n\nimport { documentTypesScheme } from '#/values/document-type.generated';\n\n/**\n * @description Validates a PEPPOL document type scheme (e.g. `busdox-docid-qns`, `peppol-doctype-wildcard`).\n *\n * @param error - The error message to use when validation fails. Defaults to `'invalid Peppol document type scheme'`.\n *\n * @returns An Effect schema that accepts only valid document type schemes.\n *\n * @see {@link documentTypesScheme}\n */\nexport function documentTypeSchemesSchema(error = 'invalid Peppol document type scheme') {\n  return Schema.Literals(documentTypesScheme as [string, ...Array<string>]).annotate({ message: error });\n}\n"],"mappings":";;;;;;;;;;;;AAaA,SAAgB,0BAA0B,QAAQ,uCAAuC;CACvF,OAAO,OAAO,SAAS,mBAAiD,CAAC,CAAC,SAAS,EAAE,SAAS,MAAM,CAAC;AACvG"}

package/dist/effect/values/document-type-values-schema.d.ts

@@ -0,0 +1,14 @@
+import { Schema } from "effect";
+//#region src/effect/values/document-type-values-schema.d.ts
+/**
+ * @description Validates the value part of a PEPPOL document type identifier (the portion after the scheme prefix) against the known document type table.
+ *
+ * @param error - The error message to use when validation fails. Defaults to `'invalid Peppol document type value'`.
+ *
+ * @returns An Effect schema that accepts only valid document type values.
+ *
+ * @see {@link documentTypesTable}
+ */
+export declare function documentTypeValuesSchema(error?: string): Schema.String;
+//#endregion
+//# sourceMappingURL=document-type-values-schema.d.ts.map

package/dist/effect/values/document-type-values-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-type-values-schema.d.ts","names":[],"sources":["../../../src/effect/values/document-type-values-schema.ts"],"mappings":";;;;;;;;;;;wBAagB,yBAAyB,iBAA4C,OAAA"}

package/dist/effect/values/document-type-values-schema.js

@@ -0,0 +1,20 @@
+import { documentTypesTable } from "../../values/document-type.generated.js";
+import { Schema } from "effect";
+//#region src/effect/values/document-type-values-schema.ts
+/**
+* @description Validates the value part of a PEPPOL document type identifier (the portion after the scheme prefix) against the known document type table.
+*
+* @param error - The error message to use when validation fails. Defaults to `'invalid Peppol document type value'`.
+*
+* @returns An Effect schema that accepts only valid document type values.
+*
+* @see {@link documentTypesTable}
+*/
+function documentTypeValuesSchema(error = "invalid Peppol document type value") {
+	const values = Object.values(documentTypesTable).flat();
+	return Schema.String.check(Schema.makeFilter((val) => values.includes(val))).annotate({ message: error });
+}
+//#endregion
+export { documentTypeValuesSchema };
+
+//# sourceMappingURL=document-type-values-schema.js.map

package/dist/effect/values/document-type-values-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-type-values-schema.js","names":[],"sources":["../../../src/effect/values/document-type-values-schema.ts"],"sourcesContent":["import { Schema } from 'effect';\n\nimport { documentTypesTable } from '#/values/document-type.generated';\n\n/**\n * @description Validates the value part of a PEPPOL document type identifier (the portion after the scheme prefix) against the known document type table.\n *\n * @param error - The error message to use when validation fails. Defaults to `'invalid Peppol document type value'`.\n *\n * @returns An Effect schema that accepts only valid document type values.\n *\n * @see {@link documentTypesTable}\n */\nexport function documentTypeValuesSchema(error = 'invalid Peppol document type value') {\n  const values = Object.values(documentTypesTable).flat();\n  return Schema.String.check(Schema.makeFilter((val: string) => values.includes(val as never))).annotate({ message: error });\n}\n"],"mappings":";;;;;;;;;;;;AAaA,SAAgB,yBAAyB,QAAQ,sCAAsC;CACrF,MAAM,SAAS,OAAO,OAAO,kBAAkB,CAAC,CAAC,KAAK;CACtD,OAAO,OAAO,OAAO,MAAM,OAAO,YAAY,QAAgB,OAAO,SAAS,GAAY,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,SAAS,MAAM,CAAC;AAC3H"}

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

@@ -0,0 +1,24 @@
+import { DutyTaxFeeCategoriesKeys } from "../../values/duty-tax-fee-categories.generated.js";
+import { Schema } from "effect";
+//#region src/effect/values/duty-tax-fee-category-schema.d.ts
+/**
+ * @description A duty, tax or fee category code as defined by the PEPPOL subset of UNCL 5305 (VAT category code).
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5305/
+ */
+export type PeppolDutyTaxFeeCategoryCode = DutyTaxFeeCategoriesKeys;
+/**
+ * @description Validates a duty, tax or fee category code against the PEPPOL subset of UNCL 5305 (VAT category code).
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns An Effect schema that accepts only valid duty/tax/fee category codes.
+ *
+ * @validations
+ * - BR-CL-17 / BR-CL-18: VAT category code MUST be a valid UNCL 5305 code.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5305/
+ */
+export declare function dutyTaxFeeCategorySchema(error?: string): Schema.Literals<readonly ["AE", "E", "S", "Z", "G", "O", "K", "L", "M", "B"]>;
+//#endregion
+//# sourceMappingURL=duty-tax-fee-category-schema.d.ts.map

package/dist/effect/values/duty-tax-fee-category-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"duty-tax-fee-category-schema.d.ts","names":[],"sources":["../../../src/effect/values/duty-tax-fee-category-schema.ts"],"mappings":";;;;;;;;YAWY,+BAA+B;;;;;;;;;;;;;wBAc3B,yBAAyB,iBAAc,OAAA"}

package/dist/effect/values/duty-tax-fee-category-schema.js

@@ -0,0 +1,23 @@
+import { dutyTaxFeeCategoriesKeys } from "../../values/duty-tax-fee-categories.generated.js";
+import { Schema } from "effect";
+//#region src/effect/values/duty-tax-fee-category-schema.ts
+/**
+* @description Validates a duty, tax or fee category code against the PEPPOL subset of UNCL 5305 (VAT category code).
+*
+* @param error - The custom error message to use when validation fails.
+*
+* @returns An Effect schema that accepts only valid duty/tax/fee category codes.
+*
+* @validations
+* - BR-CL-17 / BR-CL-18: VAT category code MUST be a valid UNCL 5305 code.
+*
+* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5305/
+*/
+function dutyTaxFeeCategorySchema(error) {
+	const schema = Schema.Literals(dutyTaxFeeCategoriesKeys);
+	return error === void 0 ? schema : schema.annotate({ message: error });
+}
+//#endregion
+export { dutyTaxFeeCategorySchema };
+
+//# sourceMappingURL=duty-tax-fee-category-schema.js.map

package/dist/effect/values/duty-tax-fee-category-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"duty-tax-fee-category-schema.js","names":[],"sources":["../../../src/effect/values/duty-tax-fee-category-schema.ts"],"sourcesContent":["import { Schema } from 'effect';\n\nimport type { DutyTaxFeeCategoriesKeys } from '#/values/duty-tax-fee-categories.generated';\n\nimport { dutyTaxFeeCategoriesKeys } from '#/values/duty-tax-fee-categories.generated';\n\n/**\n * @description A duty, tax or fee category code as defined by the PEPPOL subset of UNCL 5305 (VAT category code).\n *\n * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5305/\n */\nexport type PeppolDutyTaxFeeCategoryCode = DutyTaxFeeCategoriesKeys;\n\n/**\n * @description Validates a duty, tax or fee category code against the PEPPOL subset of UNCL 5305 (VAT category code).\n *\n * @param error - The custom error message to use when validation fails.\n *\n * @returns An Effect schema that accepts only valid duty/tax/fee category codes.\n *\n * @validations\n * - BR-CL-17 / BR-CL-18: VAT category code MUST be a valid UNCL 5305 code.\n *\n * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5305/\n */\nexport function dutyTaxFeeCategorySchema(error?: string) {\n  const schema = Schema.Literals(dutyTaxFeeCategoriesKeys);\n  return error === undefined ? schema : schema.annotate({ message: error });\n}\n"],"mappings":";;;;;;;;;;;;;;;AAyBA,SAAgB,yBAAyB,OAAgB;CACvD,MAAM,SAAS,OAAO,SAAS,wBAAwB;CACvD,OAAO,UAAU,KAAA,IAAY,SAAS,OAAO,SAAS,EAAE,SAAS,MAAM,CAAC;AAC1E"}

package/dist/effect/values/electronic-codes-schema.d.ts

@@ -0,0 +1,24 @@
+import { ElectronicAddressCodesKeys } from "../../values/eas-codes.generated.js";
+import { Schema } from "effect";
+//#region src/effect/values/electronic-codes-schema.d.ts
+/**
+ * @description An electronic address scheme (EAS) code, identifying the scheme of an electronic address (e.g. `0088` for GLN).
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/eas/
+ */
+export type PeppolElectronicAddressCode = ElectronicAddressCodesKeys;
+/**
+ * @description Validates an electronic address scheme (EAS) code against the PEPPOL Electronic Address Identifier Scheme codelist.
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns An Effect schema that accepts only valid electronic address scheme codes.
+ *
+ * @validations
+ * - PEPPOL-EN16931-CL008: Electronic address identifier scheme MUST be from the codelist "Electronic Address Identifier Scheme".
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/eas/
+ */
+export declare function electronicCodesSchema(error?: string): Schema.Literals<[string, ...string[]]>;
+//#endregion
+//# sourceMappingURL=electronic-codes-schema.d.ts.map

package/dist/effect/values/electronic-codes-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"electronic-codes-schema.d.ts","names":[],"sources":["../../../src/effect/values/electronic-codes-schema.ts"],"mappings":";;;;;;;;YAkBY,8BAA8B;;;;;;;;;;;;;wBAc1B,sBAAsB,iBAAc,OAAA"}

package/dist/effect/values/electronic-codes-schema.js

@@ -0,0 +1,30 @@
+import { electronicAddressCodesKeys } from "../../values/eas-codes.generated.js";
+import { Schema } from "effect";
+//#region src/effect/values/electronic-codes-schema.ts
+/**
+* @module effect/values/eas-codes
+* Electronic Address Scheme (EAS) codes as used in PEPPOL networks
+* These codes identify the scheme used for electronic addresses of parties
+*
+* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/eas/
+*/
+/**
+* @description Validates an electronic address scheme (EAS) code against the PEPPOL Electronic Address Identifier Scheme codelist.
+*
+* @param error - The custom error message to use when validation fails.
+*
+* @returns An Effect schema that accepts only valid electronic address scheme codes.
+*
+* @validations
+* - PEPPOL-EN16931-CL008: Electronic address identifier scheme MUST be from the codelist "Electronic Address Identifier Scheme".
+*
+* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/eas/
+*/
+function electronicCodesSchema(error) {
+	const schema = Schema.Literals(electronicAddressCodesKeys);
+	return error === void 0 ? schema : schema.annotate({ message: error });
+}
+//#endregion
+export { electronicCodesSchema };
+
+//# sourceMappingURL=electronic-codes-schema.js.map

package/dist/effect/values/electronic-codes-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"electronic-codes-schema.js","names":[],"sources":["../../../src/effect/values/electronic-codes-schema.ts"],"sourcesContent":["/**\n * @module effect/values/eas-codes\n * Electronic Address Scheme (EAS) codes as used in PEPPOL networks\n * These codes identify the scheme used for electronic addresses of parties\n *\n * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/eas/\n */\nimport { Schema } from 'effect';\n\nimport type { ElectronicAddressCodesKeys } from '#/values/eas-codes.generated';\n\nimport { electronicAddressCodesKeys } from '#/values/eas-codes.generated';\n\n/**\n * @description An electronic address scheme (EAS) code, identifying the scheme of an electronic address (e.g. `0088` for GLN).\n *\n * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/eas/\n */\nexport type PeppolElectronicAddressCode = ElectronicAddressCodesKeys;\n\n/**\n * @description Validates an electronic address scheme (EAS) code against the PEPPOL Electronic Address Identifier Scheme codelist.\n *\n * @param error - The custom error message to use when validation fails.\n *\n * @returns An Effect schema that accepts only valid electronic address scheme codes.\n *\n * @validations\n * - PEPPOL-EN16931-CL008: Electronic address identifier scheme MUST be from the codelist \"Electronic Address Identifier Scheme\".\n *\n * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/eas/\n */\nexport function electronicCodesSchema(error?: string) {\n  const schema = Schema.Literals(electronicAddressCodesKeys);\n  return error === undefined ? schema : schema.annotate({ message: error });\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAgCA,SAAgB,sBAAsB,OAAgB;CACpD,MAAM,SAAS,OAAO,SAAS,0BAA0B;CACzD,OAAO,UAAU,KAAA,IAAY,SAAS,OAAO,SAAS,EAAE,SAAS,MAAM,CAAC;AAC1E"}

package/dist/effect/values/icd-codes-schema.d.ts

@@ -0,0 +1,24 @@
+import { IcdCodesKeys } from "../../values/icd-codes.generated.js";
+import { Schema } from "effect";
+//#region src/effect/values/icd-codes-schema.d.ts
+/**
+ * @description An ISO 6523 ICD (International Code Designator) code identifying an identifier scheme.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ICD/
+ */
+export type PeppolIcdCode = IcdCodesKeys;
+/**
+ * @description Validates an ISO 6523 ICD code against the PEPPOL codelist.
+ *
+ * @param error - The custom error message to use when validation fails. Defaults to `'Invalid ICD code provided'`.
+ *
+ * @returns An Effect schema that accepts only valid ICD codes.
+ *
+ * @validations
+ * - BR-CL-10 / BR-CL-11 / BR-CL-21: Identifier scheme MUST be a valid ISO 6523 ICD code.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ICD/
+ */
+export declare function icdCodesSchema(error?: string): Schema.Literals<[string, ...string[]]>;
+//#endregion
+//# sourceMappingURL=icd-codes-schema.d.ts.map

package/dist/effect/values/icd-codes-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"icd-codes-schema.d.ts","names":[],"sources":["../../../src/effect/values/icd-codes-schema.ts"],"mappings":";;;;;;;;YAWY,gBAAgB;;;;;;;;;;;;;wBAcZ,eAAe,iBAAmC,OAAA"}

package/dist/effect/values/icd-codes-schema.js

@@ -0,0 +1,22 @@
+import { icdCodesKeys } from "../../values/icd-codes.generated.js";
+import { Schema } from "effect";
+//#region src/effect/values/icd-codes-schema.ts
+/**
+* @description Validates an ISO 6523 ICD code against the PEPPOL codelist.
+*
+* @param error - The custom error message to use when validation fails. Defaults to `'Invalid ICD code provided'`.
+*
+* @returns An Effect schema that accepts only valid ICD codes.
+*
+* @validations
+* - BR-CL-10 / BR-CL-11 / BR-CL-21: Identifier scheme MUST be a valid ISO 6523 ICD code.
+*
+* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ICD/
+*/
+function icdCodesSchema(error = "Invalid ICD code provided") {
+	return Schema.Literals(icdCodesKeys).annotate({ message: error });
+}
+//#endregion
+export { icdCodesSchema };
+
+//# sourceMappingURL=icd-codes-schema.js.map

package/dist/effect/values/icd-codes-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"icd-codes-schema.js","names":[],"sources":["../../../src/effect/values/icd-codes-schema.ts"],"sourcesContent":["import { Schema } from 'effect';\n\nimport type { IcdCodesKeys } from '#/values/icd-codes.generated';\n\nimport { icdCodesKeys } from '#/values/icd-codes.generated';\n\n/**\n * @description An ISO 6523 ICD (International Code Designator) code identifying an identifier scheme.\n *\n * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ICD/\n */\nexport type PeppolIcdCode = IcdCodesKeys;\n\n/**\n * @description Validates an ISO 6523 ICD code against the PEPPOL codelist.\n *\n * @param error - The custom error message to use when validation fails. Defaults to `'Invalid ICD code provided'`.\n *\n * @returns An Effect schema that accepts only valid ICD codes.\n *\n * @validations\n * - BR-CL-10 / BR-CL-11 / BR-CL-21: Identifier scheme MUST be a valid ISO 6523 ICD code.\n *\n * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ICD/\n */\nexport function icdCodesSchema(error = 'Invalid ICD code provided') {\n  return Schema.Literals(icdCodesKeys).annotate({ message: error });\n}\n"],"mappings":";;;;;;;;;;;;;;;AAyBA,SAAgB,eAAe,QAAQ,6BAA6B;CAClE,OAAO,OAAO,SAAS,YAAY,CAAC,CAAC,SAAS,EAAE,SAAS,MAAM,CAAC;AAClE"}

package/dist/effect/values/index.d.ts

@@ -0,0 +1,29 @@
+import { PeppolAdditionalDocumentReferenceCode, additionalDocumentReferenceCodeSchema } from "./additional-document-reference-code-schema.js";
+import { PeppolAllowanceChargeReasonCode, allowanceChargeReasonCodeSchema } from "./allowance-charge-reason-code-schema.js";
+import { PeppolApplicationResponseTypeCode, applicationResponseTypeCodeSchema } from "./application-response-type-code-schema.js";
+import { PeppolChargeReasonCode, chargeReasonCodeSchema } from "./charge-reason-code-schema.js";
+import { PeppolCountryCode, peppolCountryCodeSchema } from "./peppol-country-code-schema.js";
+import { PeppolCreditNoteTypeCode, creditNoteTypeCodeSchema } from "./credit-note-type-code-schema.js";
+import { PeppolCurrencyCode, currencyCodeSchema } from "./currency-code-schema.js";
+import { PeppolDocumentTypeCode, peppolDocumentTypeCodeSchema } from "./peppol-document-type-code-schema.js";
+import { PeppolDocumentType, peppolDocumentTypeSchema } from "./peppol-document-type-schema.js";
+import { documentTypeSchemesSchema } from "./document-type-schemes-schema.js";
+import { documentTypeValuesSchema } from "./document-type-values-schema.js";
+import { PeppolDutyTaxFeeCategoryCode, dutyTaxFeeCategorySchema } from "./duty-tax-fee-category-schema.js";
+import { PeppolElectronicAddressCode, electronicCodesSchema } from "./electronic-codes-schema.js";
+import { PeppolIcdCode, icdCodesSchema } from "./icd-codes-schema.js";
+import { PeppolInvoiceStatusCodes, invoiceStatusCodeSchema } from "./invoice-status-code-schema.js";
+import { PeppolInvoiceTypeCode, invoiceTypeCodeSchema } from "./invoice-type-code-schema.js";
+import { PeppolItemClassificationCode, itemClassificationCodesSchema } from "./item-classification-codes-schema.js";
+import { PeppolMimeCode, mimeCodesSchema } from "./mime-codes-schema.js";
+import { PeppolOpStatusAction, opStatusActionSchema } from "./op-status-action-schema.js";
+import { PeppolOpStatusReason, opStatusReasonSchema } from "./op-status-reason-schema.js";
+import { PeppolParticipantIdentifierCode, participantIdentifierCodeSchema } from "./participant-identifier-code-schema.js";
+import { PeppolPaymentMeansCode, paymentMeansCodeSchema } from "./payment-means-code-schema.js";
+import { processFromDocumentTypeSchema } from "./process-from-document-type-schema.js";
+import { PeppolProcesses, peppolProcessSchema } from "./peppol-process-schema.js";
+import { processXmlIdentifierSchema } from "./process-xml-identifier-schema.js";
+import { PeppolQuantityUnitCode, quantityUnitCodesSchema } from "./quantity-unit-codes-schema.js";
+import { PeppolVatexCode, vatexCodeSchema } from "./vatex-code-schema.js";
+import { PeppolVatDateCode, vatDateCodeSchema } from "./vat-date-code-schema.js";
+export { PeppolAdditionalDocumentReferenceCode, PeppolAllowanceChargeReasonCode, PeppolApplicationResponseTypeCode, PeppolChargeReasonCode, PeppolCountryCode, PeppolCreditNoteTypeCode, PeppolCurrencyCode, PeppolDocumentType, PeppolDocumentTypeCode, PeppolDutyTaxFeeCategoryCode, PeppolElectronicAddressCode, PeppolIcdCode, PeppolInvoiceStatusCodes, PeppolInvoiceTypeCode, PeppolItemClassificationCode, PeppolMimeCode, PeppolOpStatusAction, PeppolOpStatusReason, PeppolParticipantIdentifierCode, PeppolPaymentMeansCode, PeppolProcesses, PeppolQuantityUnitCode, PeppolVatDateCode, PeppolVatexCode, additionalDocumentReferenceCodeSchema, allowanceChargeReasonCodeSchema, applicationResponseTypeCodeSchema, chargeReasonCodeSchema, creditNoteTypeCodeSchema, currencyCodeSchema, documentTypeSchemesSchema, documentTypeValuesSchema, dutyTaxFeeCategorySchema, electronicCodesSchema, icdCodesSchema, invoiceStatusCodeSchema, invoiceTypeCodeSchema, itemClassificationCodesSchema, mimeCodesSchema, opStatusActionSchema, opStatusReasonSchema, participantIdentifierCodeSchema, paymentMeansCodeSchema, peppolCountryCodeSchema, peppolDocumentTypeCodeSchema, peppolDocumentTypeSchema, peppolProcessSchema, processFromDocumentTypeSchema, processXmlIdentifierSchema, quantityUnitCodesSchema, vatDateCodeSchema, vatexCodeSchema };

package/dist/effect/values/index.js

@@ -0,0 +1,29 @@
+import { additionalDocumentReferenceCodeSchema } from "./additional-document-reference-code-schema.js";
+import { mimeCodesSchema } from "./mime-codes-schema.js";
+import { allowanceChargeReasonCodeSchema } from "./allowance-charge-reason-code-schema.js";
+import { chargeReasonCodeSchema } from "./charge-reason-code-schema.js";
+import { dutyTaxFeeCategorySchema } from "./duty-tax-fee-category-schema.js";
+import { currencyCodeSchema } from "./currency-code-schema.js";
+import { icdCodesSchema } from "./icd-codes-schema.js";
+import { peppolCountryCodeSchema } from "./peppol-country-code-schema.js";
+import { vatDateCodeSchema } from "./vat-date-code-schema.js";
+import { electronicCodesSchema } from "./electronic-codes-schema.js";
+import { paymentMeansCodeSchema } from "./payment-means-code-schema.js";
+import { quantityUnitCodesSchema } from "./quantity-unit-codes-schema.js";
+import { itemClassificationCodesSchema } from "./item-classification-codes-schema.js";
+import { invoiceTypeCodeSchema } from "./invoice-type-code-schema.js";
+import { creditNoteTypeCodeSchema } from "./credit-note-type-code-schema.js";
+import { peppolDocumentTypeCodeSchema } from "./peppol-document-type-code-schema.js";
+import { applicationResponseTypeCodeSchema } from "./application-response-type-code-schema.js";
+import { opStatusActionSchema } from "./op-status-action-schema.js";
+import { opStatusReasonSchema } from "./op-status-reason-schema.js";
+import { peppolDocumentTypeSchema } from "./peppol-document-type-schema.js";
+import { documentTypeSchemesSchema } from "./document-type-schemes-schema.js";
+import { documentTypeValuesSchema } from "./document-type-values-schema.js";
+import { invoiceStatusCodeSchema } from "./invoice-status-code-schema.js";
+import { participantIdentifierCodeSchema } from "./participant-identifier-code-schema.js";
+import { peppolProcessSchema } from "./peppol-process-schema.js";
+import { processFromDocumentTypeSchema } from "./process-from-document-type-schema.js";
+import { processXmlIdentifierSchema } from "./process-xml-identifier-schema.js";
+import { vatexCodeSchema } from "./vatex-code-schema.js";
+export { additionalDocumentReferenceCodeSchema, allowanceChargeReasonCodeSchema, applicationResponseTypeCodeSchema, chargeReasonCodeSchema, creditNoteTypeCodeSchema, currencyCodeSchema, documentTypeSchemesSchema, documentTypeValuesSchema, dutyTaxFeeCategorySchema, electronicCodesSchema, icdCodesSchema, invoiceStatusCodeSchema, invoiceTypeCodeSchema, itemClassificationCodesSchema, mimeCodesSchema, opStatusActionSchema, opStatusReasonSchema, participantIdentifierCodeSchema, paymentMeansCodeSchema, peppolCountryCodeSchema, peppolDocumentTypeCodeSchema, peppolDocumentTypeSchema, peppolProcessSchema, processFromDocumentTypeSchema, processXmlIdentifierSchema, quantityUnitCodesSchema, vatDateCodeSchema, vatexCodeSchema };

package/dist/effect/values/invoice-status-code-schema.d.ts

@@ -0,0 +1,21 @@
+import { InvoiceStatusCodesKeys } from "../../values/invoice-status-codes.generated.js";
+import { Schema } from "effect";
+//#region src/effect/values/invoice-status-code-schema.d.ts
+/**
+ * @description An invoice status code as defined by the PEPPOL subset of UNCL 4343 (T111).
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343-T111/
+ */
+export type PeppolInvoiceStatusCodes = InvoiceStatusCodesKeys;
+/**
+ * @description Validates an invoice status code against the PEPPOL subset of UNCL 4343 (T111).
+ *
+ * @param error - The custom error message to use when validation fails.
+ *
+ * @returns An Effect schema that accepts only valid invoice status codes.
+ *
+ * @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343-T111/
+ */
+export declare const invoiceStatusCodeSchema: Schema.Literals<readonly ["AB", "AP", "RE", "IP", "UQ", "CA", "PD"]>;
+//#endregion
+//# sourceMappingURL=invoice-status-code-schema.d.ts.map

package/dist/effect/values/invoice-status-code-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"invoice-status-code-schema.d.ts","names":[],"sources":["../../../src/effect/values/invoice-status-code-schema.ts"],"mappings":";;;;;;;;YAWY,2BAA2B;;;;;;;;;;qBAW1B,yBAAuB,OAAA"}

package/dist/effect/values/invoice-status-code-schema.js

@@ -0,0 +1,17 @@
+import { invoiceStatusCodesKeys } from "../../values/invoice-status-codes.generated.js";
+import { Schema } from "effect";
+//#region src/effect/values/invoice-status-code-schema.ts
+/**
+* @description Validates an invoice status code against the PEPPOL subset of UNCL 4343 (T111).
+*
+* @param error - The custom error message to use when validation fails.
+*
+* @returns An Effect schema that accepts only valid invoice status codes.
+*
+* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343-T111/
+*/
+const invoiceStatusCodeSchema = Schema.Literals(invoiceStatusCodesKeys);
+//#endregion
+export { invoiceStatusCodeSchema };
+
+//# sourceMappingURL=invoice-status-code-schema.js.map