@lumeo_hq/openbooks-statements 0.1.0 → 0.2.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/README.md +9 -9
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
# @lumeo_hq/openbooks-statements
|
|
2
|
-
|
|
3
|
-
`runFile` / `runFiles` from [@lumeo_hq/openbooks-core](https://www.npmjs.com/package/@lumeo_hq/openbooks-core), restricted to the statements layouts
|
|
4
|
-
(`LAYOUTS`). A file that proves out under any other layout comes back as a refusal with code `UNKNOWN_LAYOUT` and
|
|
5
|
-
`restricted: true`. Detection and proof happen in the Python engine; nothing is re-implemented here.
|
|
6
|
-
|
|
7
|
-
```ts
|
|
8
|
-
import { runFile, LAYOUTS } from "@lumeo_hq/openbooks-statements";
|
|
9
|
-
```
|
|
1
|
+
# @lumeo_hq/openbooks-statements
|
|
2
|
+
|
|
3
|
+
`runFile` / `runFiles` from [@lumeo_hq/openbooks-core](https://www.npmjs.com/package/@lumeo_hq/openbooks-core), restricted to the statements layouts
|
|
4
|
+
(`LAYOUTS`). A file that proves out under any other layout comes back as a refusal with code `UNKNOWN_LAYOUT` and
|
|
5
|
+
`restricted: true`. Detection and proof happen in the Python engine; nothing is re-implemented here.
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
import { runFile, LAYOUTS } from "@lumeo_hq/openbooks-statements";
|
|
9
|
+
```
|
package/dist/index.d.ts
CHANGED
|
@@ -3,6 +3,6 @@ export type { RunOptions, RunResult, Released, Refused } from "@lumeo_hq/openboo
|
|
|
3
3
|
export { isReleased, EngineError } from "@lumeo_hq/openbooks-core";
|
|
4
4
|
/** The layouts this package reads. A file that proves out under any other layout comes back refused (UNKNOWN_LAYOUT). */
|
|
5
5
|
export declare const LAYOUTS: readonly ["bank_csv.v1", "ofx.v1", "mt940.v1", "bank_statement_pdf.v1"];
|
|
6
|
-
/** Bank statements: bank CSV, OFX, MT940, and PDFs or scans (the engine
|
|
6
|
+
/** Bank statements: bank CSV, OFX, MT940, and PDFs or scans (scans need the engine's [scan] extra: pip install 'openbooks[scan]'). */
|
|
7
7
|
export declare const runFile: (file: string, opts?: RunOptions) => Promise<RunResult>;
|
|
8
8
|
export declare const runFiles: (files: readonly string[], opts?: RunOptions) => Promise<RunResult[]>;
|
package/dist/index.js
CHANGED
|
@@ -2,6 +2,6 @@ import { runFile as coreRunFile, runFiles as coreRunFiles } from "@lumeo_hq/open
|
|
|
2
2
|
export { isReleased, EngineError } from "@lumeo_hq/openbooks-core";
|
|
3
3
|
/** The layouts this package reads. A file that proves out under any other layout comes back refused (UNKNOWN_LAYOUT). */
|
|
4
4
|
export const LAYOUTS = ["bank_csv.v1", "ofx.v1", "mt940.v1", "bank_statement_pdf.v1"];
|
|
5
|
-
/** Bank statements: bank CSV, OFX, MT940, and PDFs or scans (the engine
|
|
5
|
+
/** Bank statements: bank CSV, OFX, MT940, and PDFs or scans (scans need the engine's [scan] extra: pip install 'openbooks[scan]'). */
|
|
6
6
|
export const runFile = (file, opts = {}) => coreRunFile(file, { ...opts, accept: LAYOUTS });
|
|
7
7
|
export const runFiles = (files, opts = {}) => coreRunFiles(files, { ...opts, accept: LAYOUTS });
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lumeo_hq/openbooks-statements",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Open Books statements wrapper: typed access to the Python engine, restricted to the statements layouts",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"type": "module",
|
|
@@ -20,6 +20,6 @@
|
|
|
20
20
|
"node": ">=20"
|
|
21
21
|
},
|
|
22
22
|
"dependencies": {
|
|
23
|
-
"@lumeo_hq/openbooks-core": "0.
|
|
23
|
+
"@lumeo_hq/openbooks-core": "0.2.0"
|
|
24
24
|
}
|
|
25
25
|
}
|