@fin.cx/compatibility 5.0.1 → 5.1.0

package/ts/encoding/index.ts

@@ -57,3 +57,20 @@ export const encodeWindows1252 = (textArg: string): IWindows1252Result => {
   }
   return { bytes: Uint8Array.from(bytes), replaced };
 };
+
+const CODE_POINT_OF_HIGH_BYTE = new Map<number, number>(HIGH_BYTES.map(([codePointArg, byteArg]) => [byteArg, codePointArg]));
+
+/**
+ * Decodes Windows-1252 as the WHATWG Encoding Standard does: the 27 characters
+ * of 0x80–0x9F by the table above, every other byte as the code point of its
+ * own number (the five bytes the standard leaves to C1 controls included).
+ * It does not rest on the platform's decoder: Node 25.2.1 reads 0x96 as
+ * U+0096, not as the dash.
+ */
+export const decodeWindows1252 = (bytesArg: Uint8Array): string => {
+  let text = '';
+  for (const byte of bytesArg) {
+    text += String.fromCharCode(CODE_POINT_OF_HIGH_BYTE.get(byte) ?? byte);
+  }
+  return text;
+};

package/ts/error.ts

@@ -1,5 +1,5 @@
 /**
- * Why an exchange file could not be written:
+ * Why an exchange file could not be written or read:
  * - `invalid_bookings`: a draft the account policy refuses, the message names it; a general reversal among the
  *   bookings handed over to a correction Buchungsstapel (a correction file passed as the state handed over); or a row
  *   or booking a Buchungsstapel does not hold (no day, an amount that is not positive) or whose Belegdatum lies
@@ -10,16 +10,42 @@
  * - `invalid_documents`: a document of a document-image archive DATEV does not take (its GUID, its format), or none;
  * - `nothing_to_correct`: a correction Buchungsstapel whose current bookings are the ones handed over;
  * - `handed_over_cost_centres_unknown`: a correction of a period whose bookings handed over include one whose cost
- *   centres its record does not state (stored before 4.1) and no rows sent were given; the message names it.
+ *   centres its record does not state (stored before 4.1) and no rows sent were given; the message names it;
+ * - `invalid_buchungsliste`: a Buchungsliste that cannot be read or booked as it is: no header line, a required
+ *   column missing, a field that is not of its format, a field this version does not map, or a row that gives no
+ *   valid entry; `details` names the line, the row and the field where it can.
  */
-export type TCompatibilityErrorCode = 'invalid_bookings' | 'invalid_header' | 'export_failed' | 'invalid_documents' | 'nothing_to_correct' | 'handed_over_cost_centres_unknown';
+export type TCompatibilityErrorCode =
+  | 'invalid_bookings'
+  | 'invalid_header'
+  | 'export_failed'
+  | 'invalid_documents'
+  | 'nothing_to_correct'
+  | 'handed_over_cost_centres_unknown'
+  | 'invalid_buchungsliste';
+
+/** Where a refusal of a file read stands, as far as it is known; empty for a file written. */
+export interface ICompatibilityErrorDetails {
+  /** the data row, from 1 */
+  row?: number;
+  /** the line of the file, from 1 */
+  line?: number;
+  /** the field, by the name of its column as the file states it */
+  field?: string;
+  /** the field's value as the file states it */
+  value?: string;
+  /** what the check of the entry found (`@fin.cx/skr` `validateJournalDraft`) */
+  errors?: string[];
+}
 
 export class CompatibilityError extends Error {
   public readonly code: TCompatibilityErrorCode;
+  public readonly details: ICompatibilityErrorDetails;
 
-  constructor(codeArg: TCompatibilityErrorCode, messageArg: string) {
+  constructor(codeArg: TCompatibilityErrorCode, messageArg: string, detailsArg: ICompatibilityErrorDetails = {}) {
     super(messageArg);
     this.name = 'CompatibilityError';
     this.code = codeArg;
+    this.details = detailsArg;
   }
 }

package/ts/index.ts

@@ -2,3 +2,4 @@ export * from './error.js';
 export * from './encoding/index.js';
 export * as extf from './extf/index.js';
 export * as belegbilder from './belegbilder/index.js';
+export * as buchungsliste from './buchungsliste/index.js';