@fin.cx/compatibility 1.1.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist_ts/00_commitinfo_data.js +1 -1
- package/dist_ts/extf/index.d.ts +31 -3
- package/dist_ts/extf/index.js +68 -4
- package/package.json +2 -2
- package/readme.md +4 -1
- package/ts/00_commitinfo_data.ts +1 -1
- package/ts/extf/index.ts +93 -5
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@fin.cx/compatibility',
|
|
6
|
-
version: '
|
|
6
|
+
version: '2.0.0',
|
|
7
7
|
description: 'Exchange formats of third-party accounting systems: the EXTF Buchungsstapel in Windows-1252 on the rows of @fin.cx/skr, and the document-image archive (document.xml and ZIP)'
|
|
8
8
|
};
|
|
9
9
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSx1QkFBdUI7SUFDN0IsT0FBTyxFQUFFLE9BQU87SUFDaEIsV0FBVyxFQUFFLCtLQUErSztDQUM3TCxDQUFBIn0=
|
package/dist_ts/extf/index.d.ts
CHANGED
|
@@ -33,7 +33,9 @@ export declare const bookingsOfRows: (rowsArg: readonly IDatevBuchungsstapelRow[
|
|
|
33
33
|
export declare const differingBookingCount: (leftArg: readonly IExportBooking[], rightArg: readonly IExportBooking[]) => number;
|
|
34
34
|
/**
|
|
35
35
|
* Checks every draft against the account policy and turns the drafts into
|
|
36
|
-
* Buchungsstapel rows (`@fin.cx/skr` `journalDraftsToDatevRows
|
|
36
|
+
* Buchungsstapel rows (`@fin.cx/skr` `journalDraftsToDatevRows` under that
|
|
37
|
+
* policy, not fixed): its Automatikkonten and VAT accounts decide which VAT
|
|
38
|
+
* lines fold into their base.
|
|
37
39
|
* A draft the policy refuses throws `invalid_bookings`, naming the draft; a
|
|
38
40
|
* failure of the conversion throws `export_failed`.
|
|
39
41
|
*/
|
|
@@ -47,6 +49,32 @@ export interface IBuchungsstapelOptions {
|
|
|
47
49
|
/** the file's name, for example `extfFilename('2026-03')` */
|
|
48
50
|
filename: string;
|
|
49
51
|
}
|
|
52
|
+
/**
|
|
53
|
+
* A character a Buchungsstapel cannot hold in Windows-1252, written as `?`,
|
|
54
|
+
* with where it stands: `offset` in the whole text, and for a character of a
|
|
55
|
+
* booking row the index of that row in `rows` (from 0) and the number of its
|
|
56
|
+
* DATEV field (from 1, 14 is the Buchungstext). A character of the header
|
|
57
|
+
* line has neither.
|
|
58
|
+
*/
|
|
59
|
+
export interface IBuchungsstapelReplacement extends IReplacedCharacter {
|
|
60
|
+
row?: number;
|
|
61
|
+
field?: number;
|
|
62
|
+
}
|
|
63
|
+
/** A character of one booking row the file cannot hold, as `replacedCharactersOfRows` reports it. */
|
|
64
|
+
export interface IRowReplacement {
|
|
65
|
+
/** the index of the row in the rows given, from 0 */
|
|
66
|
+
row: number;
|
|
67
|
+
/** the number of the DATEV field it stands in, from 1 (14 is the Buchungstext) */
|
|
68
|
+
field: number;
|
|
69
|
+
character: string;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* The characters of each row that a Buchungsstapel in Windows-1252 cannot
|
|
73
|
+
* hold, in row order, without writing a file: the rows' lines as the writer
|
|
74
|
+
* writes them (`@fin.cx/skr` `datevRowFields`), so a character a field is cut
|
|
75
|
+
* off before is not named. A row the writer refuses throws as it does.
|
|
76
|
+
*/
|
|
77
|
+
export declare const replacedCharactersOfRows: (rowsArg: readonly IDatevBuchungsstapelRow[]) => IRowReplacement[];
|
|
50
78
|
export interface IBuchungsstapelFile {
|
|
51
79
|
filename: string;
|
|
52
80
|
/** the file as text, lines ending in CRLF */
|
|
@@ -55,8 +83,8 @@ export interface IBuchungsstapelFile {
|
|
|
55
83
|
bytes: Uint8Array;
|
|
56
84
|
rows: IDatevBuchungsstapelRow[];
|
|
57
85
|
bookings: IExportBooking[];
|
|
58
|
-
/** the characters Windows-1252 cannot write, each written as
|
|
59
|
-
replacedCharacters:
|
|
86
|
+
/** the characters Windows-1252 cannot write, each written as `?`, with the row and field it stands in */
|
|
87
|
+
replacedCharacters: IBuchungsstapelReplacement[];
|
|
60
88
|
}
|
|
61
89
|
/** Writes a Buchungsstapel: the rows of the drafts, the header and the caption row, encoded in Windows-1252. */
|
|
62
90
|
export declare const writeBuchungsstapel: (optionsArg: IBuchungsstapelOptions) => IBuchungsstapelFile;
|
package/dist_ts/extf/index.js
CHANGED
|
@@ -50,7 +50,9 @@ export const differingBookingCount = (leftArg, rightArg) => {
|
|
|
50
50
|
};
|
|
51
51
|
/**
|
|
52
52
|
* Checks every draft against the account policy and turns the drafts into
|
|
53
|
-
* Buchungsstapel rows (`@fin.cx/skr` `journalDraftsToDatevRows
|
|
53
|
+
* Buchungsstapel rows (`@fin.cx/skr` `journalDraftsToDatevRows` under that
|
|
54
|
+
* policy, not fixed): its Automatikkonten and VAT accounts decide which VAT
|
|
55
|
+
* lines fold into their base.
|
|
54
56
|
* A draft the policy refuses throws `invalid_bookings`, naming the draft; a
|
|
55
57
|
* failure of the conversion throws `export_failed`.
|
|
56
58
|
*/
|
|
@@ -62,17 +64,79 @@ export const datevRowsOf = (draftsArg, policyArg) => {
|
|
|
62
64
|
}
|
|
63
65
|
}
|
|
64
66
|
try {
|
|
65
|
-
|
|
67
|
+
// the rows consolidate under the same policy the drafts are checked against, not the chart's default one
|
|
68
|
+
return plugins.skrCore.journalDraftsToDatevRows([...draftsArg], { festschreibung: false, policy: policyArg });
|
|
66
69
|
}
|
|
67
70
|
catch (error) {
|
|
68
71
|
throw new CompatibilityError('export_failed', error instanceof Error ? error.message : String(error));
|
|
69
72
|
}
|
|
70
73
|
};
|
|
74
|
+
/**
|
|
75
|
+
* Where the characters of one row stand in its line: the line is the fields
|
|
76
|
+
* joined with `;` (`@fin.cx/skr` `datevRowFields`), so field n begins after
|
|
77
|
+
* the lengths of the fields before it and one separator each.
|
|
78
|
+
*/
|
|
79
|
+
const fieldStartsOf = (fieldsArg) => {
|
|
80
|
+
const starts = [];
|
|
81
|
+
let offset = 0;
|
|
82
|
+
for (const field of fieldsArg) {
|
|
83
|
+
starts.push(offset);
|
|
84
|
+
offset += field.length + 1;
|
|
85
|
+
}
|
|
86
|
+
return starts;
|
|
87
|
+
};
|
|
88
|
+
const fieldAt = (startsArg, offsetArg) => {
|
|
89
|
+
let field = 0;
|
|
90
|
+
while (field + 1 < startsArg.length && startsArg[field + 1] <= offsetArg) {
|
|
91
|
+
field += 1;
|
|
92
|
+
}
|
|
93
|
+
return field + 1;
|
|
94
|
+
};
|
|
95
|
+
/**
|
|
96
|
+
* The characters of each row that a Buchungsstapel in Windows-1252 cannot
|
|
97
|
+
* hold, in row order, without writing a file: the rows' lines as the writer
|
|
98
|
+
* writes them (`@fin.cx/skr` `datevRowFields`), so a character a field is cut
|
|
99
|
+
* off before is not named. A row the writer refuses throws as it does.
|
|
100
|
+
*/
|
|
101
|
+
export const replacedCharactersOfRows = (rowsArg) => {
|
|
102
|
+
const replacements = [];
|
|
103
|
+
rowsArg.forEach((rowArg, rowIndex) => {
|
|
104
|
+
const fields = plugins.skrCore.datevRowFields(rowArg);
|
|
105
|
+
const starts = fieldStartsOf(fields);
|
|
106
|
+
for (const replaced of encodeWindows1252(fields.join(';')).replaced) {
|
|
107
|
+
replacements.push({ row: rowIndex, field: fieldAt(starts, replaced.offset), character: replaced.character });
|
|
108
|
+
}
|
|
109
|
+
});
|
|
110
|
+
return replacements;
|
|
111
|
+
};
|
|
71
112
|
/** Writes a Buchungsstapel: the rows of the drafts, the header and the caption row, encoded in Windows-1252. */
|
|
72
113
|
export const writeBuchungsstapel = (optionsArg) => {
|
|
73
114
|
const rows = datevRowsOf(optionsArg.drafts, optionsArg.policy);
|
|
74
115
|
const { csv } = plugins.skrCore.writeExtfBuchungsstapel(rows, optionsArg.header);
|
|
75
116
|
const { bytes, replaced } = encodeWindows1252(csv);
|
|
76
|
-
|
|
117
|
+
// the file is the header line, the caption line and one line per row, each ending in CRLF (`writeExtfBuchungsstapel`)
|
|
118
|
+
const rowLines = rows.map((rowArg) => plugins.skrCore.datevRowFields(rowArg));
|
|
119
|
+
const [headerLine = '', captionLine = ''] = csv.split('\r\n', 2);
|
|
120
|
+
const rowsStart = headerLine.length + 2 + captionLine.length + 2;
|
|
121
|
+
const lineStarts = [];
|
|
122
|
+
let offset = rowsStart;
|
|
123
|
+
for (const fields of rowLines) {
|
|
124
|
+
lineStarts.push(offset);
|
|
125
|
+
offset += fields.join(';').length + 2;
|
|
126
|
+
}
|
|
127
|
+
if (offset !== csv.length || rowLines.some((fieldsArg, indexArg) => csv.slice(lineStarts[indexArg], lineStarts[indexArg] + fieldsArg.join(';').length) !== fieldsArg.join(';'))) {
|
|
128
|
+
throw new CompatibilityError('export_failed', 'the rows of the Buchungsstapel are not the lines @fin.cx/skr writes for them');
|
|
129
|
+
}
|
|
130
|
+
const replacedCharacters = replaced.map((replacedArg) => {
|
|
131
|
+
if (replacedArg.offset < rowsStart) {
|
|
132
|
+
return { ...replacedArg };
|
|
133
|
+
}
|
|
134
|
+
let row = 0;
|
|
135
|
+
while (row + 1 < lineStarts.length && lineStarts[row + 1] <= replacedArg.offset) {
|
|
136
|
+
row += 1;
|
|
137
|
+
}
|
|
138
|
+
return { ...replacedArg, row, field: fieldAt(fieldStartsOf(rowLines[row]), replacedArg.offset - lineStarts[row]) };
|
|
139
|
+
});
|
|
140
|
+
return { filename: optionsArg.filename, csv, bytes, rows, bookings: bookingsOfRows(rows), replacedCharacters };
|
|
77
141
|
};
|
|
78
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
142
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"index.js","sourceRoot":"","sources":["../../ts/extf/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAA2B,MAAM,sBAAsB,CAAC;AAElF,OAAO,EAAE,kBAAkB,EAAgC,MAAM,aAAa,CAAC;AAK/E,sFAAsF;AACtF,MAAM,CAAC,MAAM,iBAAiB,GAAG,gCAAgC,CAAC;AAElE,wFAAwF;AACxF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,QAAgB,EAAU,EAAE,CAAC,uBAAuB,QAAQ,MAAM,CAAC;AAkBhG,0EAA0E;AAC1E,MAAM,UAAU,GAAG,CAAC,OAAe,EAAU,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;AAElH,4CAA4C;AAC5C,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAA2C,EAAoB,EAAE,CAC9F,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC,WAAW;IAC/B,SAAS,EAAE,MAAM,CAAC,SAAS;IAC3B,KAAK,EAAE,MAAM,CAAC,KAAK;IACnB,UAAU,EAAE,MAAM,CAAC,UAAU;IAC7B,KAAK,EAAE,MAAM,CAAC,YAAY;IAC1B,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC;IAClD,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/D,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/D,IAAI,EAAE,MAAM,CAAC,YAAY;IACzB,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;CAC5E,CAAC,CAAC,CAAC;AAEN;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,OAAkC,EAAE,QAAmC,EAAU,EAAE;IACvH,MAAM,KAAK,GAAG,CAAC,UAA0B,EAAU,EAAE,CACnD,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,WAAW,EAAE,UAAU,CAAC,SAAS,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,UAAU,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpK,MAAM,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC5C,KAAK,MAAM,OAAO,IAAI,OAAO,EAAE,CAAC;QAC9B,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1E,CAAC;IACD,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,IAAI,GAAG,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;QAChD,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;YACb,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC;QAC1C,CAAC;aAAM,CAAC;YACN,SAAS,IAAI,CAAC,CAAC;QACjB,CAAC;IACH,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC;QACtC,SAAS,IAAI,IAAI,CAAC;IACpB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,SAAmD,EAAE,SAAyC,EAA6B,EAAE;IACvJ,KAAK,MAAM,KAAK,IAAI,SAAS,EAAE,CAAC;QAC9B,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC1E,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;YACtB,MAAM,IAAI,kBAAkB,CAAC,kBAAkB,EAAE,UAAU,KAAK,CAAC,WAAW,MAAM,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpH,CAAC;IACH,CAAC;IACD,IAAI,CAAC;QACH,yGAAyG;QACzG,OAAO,OAAO,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAChH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,kBAAkB,CAAC,eAAe,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACxG,CAAC;AACH,CAAC,CAAC;AAiCF;;;;GAIG;AACH,MAAM,aAAa,GAAG,CAAC,SAA4B,EAAY,EAAE;IAC/D,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,KAAK,IAAI,SAAS,EAAE,CAAC;QAC9B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IAC7B,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,SAA4B,EAAE,SAAiB,EAAU,EAAE;IAC1E,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,OAAO,KAAK,GAAG,CAAC,GAAG,SAAS,CAAC,MAAM,IAAI,SAAS,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,SAAS,EAAE,CAAC;QACzE,KAAK,IAAI,CAAC,CAAC;IACb,CAAC;IACD,OAAO,KAAK,GAAG,CAAC,CAAC;AACnB,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,OAA2C,EAAqB,EAAE;IACzG,MAAM,YAAY,GAAsB,EAAE,CAAC;IAC3C,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE;QACnC,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;QACrC,KAAK,MAAM,QAAQ,IAAI,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;YACpE,YAAY,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC;QAC/G,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AAcF,gHAAgH;AAChH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,UAAkC,EAAuB,EAAE;IAC7F,MAAM,IAAI,GAAG,WAAW,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IAC/D,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,uBAAuB,CAAC,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IACjF,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACnD,sHAAsH;IACtH,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9E,MAAM,CAAC,UAAU,GAAG,EAAE,EAAE,WAAW,GAAG,EAAE,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACjE,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,GAAG,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;IACjE,MAAM,UAAU,GAAa,EAAE,CAAC;IAChC,IAAI,MAAM,GAAG,SAAS,CAAC;IACvB,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE,CAAC;QAC9B,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACxB,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACxC,CAAC;IACD,IAAI,MAAM,KAAK,GAAG,CAAC,MAAM,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;QAChL,MAAM,IAAI,kBAAkB,CAAC,eAAe,EAAE,8EAA8E,CAAC,CAAC;IAChI,CAAC;IACD,MAAM,kBAAkB,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,WAAW,EAA8B,EAAE;QAClF,IAAI,WAAW,CAAC,MAAM,GAAG,SAAS,EAAE,CAAC;YACnC,OAAO,EAAE,GAAG,WAAW,EAAE,CAAC;QAC5B,CAAC;QACD,IAAI,GAAG,GAAG,CAAC,CAAC;QACZ,OAAO,GAAG,GAAG,CAAC,GAAG,UAAU,CAAC,MAAM,IAAI,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;YAChF,GAAG,IAAI,CAAC,CAAC;QACX,CAAC;QACD,OAAO,EAAE,GAAG,WAAW,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,WAAW,CAAC,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;IACrH,CAAC,CAAC,CAAC;IACH,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,cAAc,CAAC,IAAI,CAAC,EAAE,kBAAkB,EAAE,CAAC;AACjH,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fin.cx/compatibility",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "2.0.0",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Exchange formats of third-party accounting systems: the EXTF Buchungsstapel in Windows-1252 on the rows of @fin.cx/skr, and the document-image archive (document.xml and ZIP)",
|
|
6
6
|
"main": "dist_ts/index.js",
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
},
|
|
43
43
|
"homepage": "https://code.foss.global/fin.cx/compatibility#readme",
|
|
44
44
|
"dependencies": {
|
|
45
|
-
"@fin.cx/skr": "^
|
|
45
|
+
"@fin.cx/skr": "^5.2.0",
|
|
46
46
|
"@push.rocks/smartarchive": "^5.4.1"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
package/readme.md
CHANGED
|
@@ -41,9 +41,12 @@ const file = extf.writeBuchungsstapel({
|
|
|
41
41
|
});
|
|
42
42
|
file.bytes; // Uint8Array in Windows-1252, served as extf.EXTF_CONTENT_TYPE
|
|
43
43
|
file.bookings; // what each row says, for keeping and comparing
|
|
44
|
-
file.replacedCharacters; // [{ offset, character: 'ő' }, …]: written as "?"
|
|
44
|
+
file.replacedCharacters; // [{ offset, character: 'ő', row: 1, field: 14 }, …]: written as "?"
|
|
45
45
|
```
|
|
46
46
|
|
|
47
|
+
- **Where a character that became `?` stands.** Each entry of `replacedCharacters` names its `offset` in the text and, for a booking row, the index of that row in `rows` (from 0) and the number of its DATEV field (from 1; 14 is the Buchungstext). A character of the header line (the label) has neither.
|
|
48
|
+
- **The same without a file.** `extf.replacedCharactersOfRows(rows)` names the characters of each row the file could not hold (`{ row, field, character }`), without a header and without writing anything: for a preview, before the consultant and client numbers of the header are known. It reads each row's line as the writer writes it (`@fin.cx/skr` `datevRowFields`), so a character a field is cut off before (the Buchungstext keeps 60 characters) is not named.
|
|
49
|
+
|
|
47
50
|
- **A draft the account policy refuses** throws `CompatibilityError` with code `invalid_bookings` and a message naming the draft.
|
|
48
51
|
- **A failed conversion** throws code `export_failed`.
|
|
49
52
|
- **`differingBookingCount(left, right)`** counts the rows two Stapel of one period do not share. It compares each booking's day, amount, side, accounts, BU key and Belegfeld 1, as a multiset, and ignores wording and document links.
|
package/ts/00_commitinfo_data.ts
CHANGED
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@fin.cx/compatibility',
|
|
6
|
-
version: '
|
|
6
|
+
version: '2.0.0',
|
|
7
7
|
description: 'Exchange formats of third-party accounting systems: the EXTF Buchungsstapel in Windows-1252 on the rows of @fin.cx/skr, and the document-image archive (document.xml and ZIP)'
|
|
8
8
|
}
|
package/ts/extf/index.ts
CHANGED
|
@@ -77,7 +77,9 @@ export const differingBookingCount = (leftArg: readonly IExportBooking[], rightA
|
|
|
77
77
|
|
|
78
78
|
/**
|
|
79
79
|
* Checks every draft against the account policy and turns the drafts into
|
|
80
|
-
* Buchungsstapel rows (`@fin.cx/skr` `journalDraftsToDatevRows
|
|
80
|
+
* Buchungsstapel rows (`@fin.cx/skr` `journalDraftsToDatevRows` under that
|
|
81
|
+
* policy, not fixed): its Automatikkonten and VAT accounts decide which VAT
|
|
82
|
+
* lines fold into their base.
|
|
81
83
|
* A draft the policy refuses throws `invalid_bookings`, naming the draft; a
|
|
82
84
|
* failure of the conversion throws `export_failed`.
|
|
83
85
|
*/
|
|
@@ -89,7 +91,8 @@ export const datevRowsOf = (draftsArg: readonly plugins.skrCore.IJournalDraft[],
|
|
|
89
91
|
}
|
|
90
92
|
}
|
|
91
93
|
try {
|
|
92
|
-
|
|
94
|
+
// the rows consolidate under the same policy the drafts are checked against, not the chart's default one
|
|
95
|
+
return plugins.skrCore.journalDraftsToDatevRows([...draftsArg], { festschreibung: false, policy: policyArg });
|
|
93
96
|
} catch (error) {
|
|
94
97
|
throw new CompatibilityError('export_failed', error instanceof Error ? error.message : String(error));
|
|
95
98
|
}
|
|
@@ -105,6 +108,68 @@ export interface IBuchungsstapelOptions {
|
|
|
105
108
|
filename: string;
|
|
106
109
|
}
|
|
107
110
|
|
|
111
|
+
/**
|
|
112
|
+
* A character a Buchungsstapel cannot hold in Windows-1252, written as `?`,
|
|
113
|
+
* with where it stands: `offset` in the whole text, and for a character of a
|
|
114
|
+
* booking row the index of that row in `rows` (from 0) and the number of its
|
|
115
|
+
* DATEV field (from 1, 14 is the Buchungstext). A character of the header
|
|
116
|
+
* line has neither.
|
|
117
|
+
*/
|
|
118
|
+
export interface IBuchungsstapelReplacement extends IReplacedCharacter {
|
|
119
|
+
row?: number;
|
|
120
|
+
field?: number;
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
/** A character of one booking row the file cannot hold, as `replacedCharactersOfRows` reports it. */
|
|
124
|
+
export interface IRowReplacement {
|
|
125
|
+
/** the index of the row in the rows given, from 0 */
|
|
126
|
+
row: number;
|
|
127
|
+
/** the number of the DATEV field it stands in, from 1 (14 is the Buchungstext) */
|
|
128
|
+
field: number;
|
|
129
|
+
character: string;
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
/**
|
|
133
|
+
* Where the characters of one row stand in its line: the line is the fields
|
|
134
|
+
* joined with `;` (`@fin.cx/skr` `datevRowFields`), so field n begins after
|
|
135
|
+
* the lengths of the fields before it and one separator each.
|
|
136
|
+
*/
|
|
137
|
+
const fieldStartsOf = (fieldsArg: readonly string[]): number[] => {
|
|
138
|
+
const starts: number[] = [];
|
|
139
|
+
let offset = 0;
|
|
140
|
+
for (const field of fieldsArg) {
|
|
141
|
+
starts.push(offset);
|
|
142
|
+
offset += field.length + 1;
|
|
143
|
+
}
|
|
144
|
+
return starts;
|
|
145
|
+
};
|
|
146
|
+
|
|
147
|
+
const fieldAt = (startsArg: readonly number[], offsetArg: number): number => {
|
|
148
|
+
let field = 0;
|
|
149
|
+
while (field + 1 < startsArg.length && startsArg[field + 1] <= offsetArg) {
|
|
150
|
+
field += 1;
|
|
151
|
+
}
|
|
152
|
+
return field + 1;
|
|
153
|
+
};
|
|
154
|
+
|
|
155
|
+
/**
|
|
156
|
+
* The characters of each row that a Buchungsstapel in Windows-1252 cannot
|
|
157
|
+
* hold, in row order, without writing a file: the rows' lines as the writer
|
|
158
|
+
* writes them (`@fin.cx/skr` `datevRowFields`), so a character a field is cut
|
|
159
|
+
* off before is not named. A row the writer refuses throws as it does.
|
|
160
|
+
*/
|
|
161
|
+
export const replacedCharactersOfRows = (rowsArg: readonly IDatevBuchungsstapelRow[]): IRowReplacement[] => {
|
|
162
|
+
const replacements: IRowReplacement[] = [];
|
|
163
|
+
rowsArg.forEach((rowArg, rowIndex) => {
|
|
164
|
+
const fields = plugins.skrCore.datevRowFields(rowArg);
|
|
165
|
+
const starts = fieldStartsOf(fields);
|
|
166
|
+
for (const replaced of encodeWindows1252(fields.join(';')).replaced) {
|
|
167
|
+
replacements.push({ row: rowIndex, field: fieldAt(starts, replaced.offset), character: replaced.character });
|
|
168
|
+
}
|
|
169
|
+
});
|
|
170
|
+
return replacements;
|
|
171
|
+
};
|
|
172
|
+
|
|
108
173
|
export interface IBuchungsstapelFile {
|
|
109
174
|
filename: string;
|
|
110
175
|
/** the file as text, lines ending in CRLF */
|
|
@@ -113,8 +178,8 @@ export interface IBuchungsstapelFile {
|
|
|
113
178
|
bytes: Uint8Array;
|
|
114
179
|
rows: IDatevBuchungsstapelRow[];
|
|
115
180
|
bookings: IExportBooking[];
|
|
116
|
-
/** the characters Windows-1252 cannot write, each written as
|
|
117
|
-
replacedCharacters:
|
|
181
|
+
/** the characters Windows-1252 cannot write, each written as `?`, with the row and field it stands in */
|
|
182
|
+
replacedCharacters: IBuchungsstapelReplacement[];
|
|
118
183
|
}
|
|
119
184
|
|
|
120
185
|
/** Writes a Buchungsstapel: the rows of the drafts, the header and the caption row, encoded in Windows-1252. */
|
|
@@ -122,5 +187,28 @@ export const writeBuchungsstapel = (optionsArg: IBuchungsstapelOptions): IBuchun
|
|
|
122
187
|
const rows = datevRowsOf(optionsArg.drafts, optionsArg.policy);
|
|
123
188
|
const { csv } = plugins.skrCore.writeExtfBuchungsstapel(rows, optionsArg.header);
|
|
124
189
|
const { bytes, replaced } = encodeWindows1252(csv);
|
|
125
|
-
|
|
190
|
+
// the file is the header line, the caption line and one line per row, each ending in CRLF (`writeExtfBuchungsstapel`)
|
|
191
|
+
const rowLines = rows.map((rowArg) => plugins.skrCore.datevRowFields(rowArg));
|
|
192
|
+
const [headerLine = '', captionLine = ''] = csv.split('\r\n', 2);
|
|
193
|
+
const rowsStart = headerLine.length + 2 + captionLine.length + 2;
|
|
194
|
+
const lineStarts: number[] = [];
|
|
195
|
+
let offset = rowsStart;
|
|
196
|
+
for (const fields of rowLines) {
|
|
197
|
+
lineStarts.push(offset);
|
|
198
|
+
offset += fields.join(';').length + 2;
|
|
199
|
+
}
|
|
200
|
+
if (offset !== csv.length || rowLines.some((fieldsArg, indexArg) => csv.slice(lineStarts[indexArg], lineStarts[indexArg] + fieldsArg.join(';').length) !== fieldsArg.join(';'))) {
|
|
201
|
+
throw new CompatibilityError('export_failed', 'the rows of the Buchungsstapel are not the lines @fin.cx/skr writes for them');
|
|
202
|
+
}
|
|
203
|
+
const replacedCharacters = replaced.map((replacedArg): IBuchungsstapelReplacement => {
|
|
204
|
+
if (replacedArg.offset < rowsStart) {
|
|
205
|
+
return { ...replacedArg };
|
|
206
|
+
}
|
|
207
|
+
let row = 0;
|
|
208
|
+
while (row + 1 < lineStarts.length && lineStarts[row + 1] <= replacedArg.offset) {
|
|
209
|
+
row += 1;
|
|
210
|
+
}
|
|
211
|
+
return { ...replacedArg, row, field: fieldAt(fieldStartsOf(rowLines[row]), replacedArg.offset - lineStarts[row]) };
|
|
212
|
+
});
|
|
213
|
+
return { filename: optionsArg.filename, csv, bytes, rows, bookings: bookingsOfRows(rows), replacedCharacters };
|
|
126
214
|
};
|