fints-lib-cli 0.4.0 → 0.5.0

package/README.md

@@ -215,6 +215,122 @@ fints-lib submit-direct-debit --url https://example.com/fints --name username --
   --mandate-date 2022-01-10 --collection-date 2022-01-15 --remittance "Invoice 0815"
 ```
 
+## Practical CLI Examples
+
+### Using Environment Variables
+
+To avoid typing credentials repeatedly, create a shell script or use environment variables:
+
+```bash
+#!/bin/bash
+# save as fints-env.sh
+
+export FINTS_URL="https://banking.example.com/fints"
+export FINTS_USER="myusername"
+export FINTS_PIN="mypin"
+export FINTS_BLZ="12345678"
+
+# Then use in commands:
+# source fints-env.sh
+# fints-lib list-accounts --url $FINTS_URL -n $FINTS_USER -p $FINTS_PIN -b $FINTS_BLZ
+```
+
+### Quick Account Overview
+
+```bash
+# Get account list in JSON format for processing
+fints-lib list-accounts \
+  --url https://banking.example.com/fints \
+  -n username -p 12345 -b 12345678 \
+  --json | jq '.'
+
+# Check balance for a specific account
+fints-lib get-balance \
+  --url https://banking.example.com/fints \
+  -n username -p 12345 -b 12345678 \
+  -i DE89370400440532013000 \
+  --json | jq '.value'
+```
+
+### Export Transactions to File
+
+```bash
+# Fetch and save transactions as JSON
+fints-lib fetch-transactions \
+  --url https://banking.example.com/fints \
+  -n username -p 12345 -b 12345678 \
+  -i DE89370400440532013000 \
+  -s 2024-01-01 -e 2024-12-31 \
+  --json > transactions-2024.json
+
+# Or save verbose output to text file
+fints-lib fetch-transactions \
+  --url https://banking.example.com/fints \
+  -n username -p 12345 -b 12345678 \
+  -i DE89370400440532013000 \
+  -s 2024-01-01 -e 2024-12-31 \
+  --verbose > transactions-2024.txt
+```
+
+### Monthly Statement Automation
+
+```bash
+#!/bin/bash
+# monthly-statement.sh - Fetch last month's transactions
+
+# Calculate date range for last month
+# For Linux (GNU date):
+START_DATE=$(date -d "last month" +%Y-%m-01)
+END_DATE=$(date -d "-1 day $(date +%Y-%m-01)" +%Y-%m-%d)
+
+# For macOS (BSD date), install GNU coreutils and use 'gdate':
+# brew install coreutils
+# START_DATE=$(gdate -d "last month" +%Y-%m-01)
+# END_DATE=$(gdate -d "-1 day $(gdate +%Y-%m-01)" +%Y-%m-%d)
+
+# Fetch transactions
+fints-lib fetch-transactions \
+  --url "$FINTS_URL" \
+  -n "$FINTS_USER" \
+  -p "$FINTS_PIN" \
+  -b "$FINTS_BLZ" \
+  -i "$ACCOUNT_IBAN" \
+  -s "$START_DATE" \
+  -e "$END_DATE" \
+  --json > "statement-$(date +%Y-%m).json"
+
+echo "Statement saved for period: $START_DATE to $END_DATE"
+```
+
+### Check Multiple Accounts
+
+```bash
+#!/bin/bash
+# check-all-accounts.sh
+
+ACCOUNTS=("DE89370400440532013000" "DE89370400440532013001")
+
+for IBAN in "${ACCOUNTS[@]}"; do
+    echo "Checking account: $IBAN"
+    fints-lib get-balance \
+      --url "$FINTS_URL" \
+      -n "$FINTS_USER" \
+      -p "$FINTS_PIN" \
+      -b "$FINTS_BLZ" \
+      -i "$IBAN" \
+      --json | jq -r '"  Balance: \(.value.value) \(.value.currency)"'
+    echo ""
+done
+```
+
+## Tips
+
+- Use `--json` flag for machine-readable output that can be processed with tools like `jq`
+- Use `--verbose` flag to see detailed information during development
+- Use `--debug` flag to troubleshoot connection issues
+- Store credentials in environment variables or a secure credential manager
+- Use the [FinTS Institute Database](https://github.com/jhermsmeier/fints-institute-db) to find your bank's URL
+
 ## Resources
 
 - [Database of banks with their URLs](https://github.com/jhermsmeier/fints-institute-db)

package/dist/config.js

@@ -1,43 +1,10 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
 var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
     if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
@@ -45,10 +12,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseConfig = void 0;
 const clime_1 = require("clime");
 const fints_lib_1 = require("fints-lib");
-const YAML = __importStar(require("yamljs"));
+const yaml_1 = require("yaml");
 class BaseConfig extends clime_1.Options {
     get serializer() {
-        return this.json ? JSON.stringify : (obj) => YAML.stringify(obj, 4);
+        return this.json ? JSON.stringify : (obj) => (0, yaml_1.stringify)(obj, { indent: 4 });
     }
 }
 exports.BaseConfig = BaseConfig;

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iCAAwC;AACxC,yCAA6D;AAC7D,6CAA+B;AAE/B,MAAa,UAAW,SAAQ,eAAO;IA8BnC,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAC7E,CAAC;CACJ;AAjCD,gCAiCC;AA1BU;IANN,IAAA,cAAM,EAAC;QACJ,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,6BAA6B;QAC1C,OAAO,EAAE,wBAAY;KACxB,CAAC;;6CACuB;AAGlB;IADN,IAAA,cAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC;;uCACjD;AAGZ;IADN,IAAA,cAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,+BAA+B,EAAE,CAAC;;wCAChE;AAGb;IADN,IAAA,cAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,0BAA0B,EAAE,CAAC;;uCAC5D;AAGZ;IADN,IAAA,cAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,gCAAgC,EAAE,CAAC;;uCAClE;AAGZ;IADN,IAAA,cAAM,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;;yCACd;AAGf;IADN,IAAA,cAAM,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;;2CACZ;AAGjB;IADN,IAAA,cAAM,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;;wCACf"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iCAAwC;AACxC,yCAA6D;AAC7D,+BAAiC;AAEjC,MAAa,UAAW,SAAQ,eAAO;IA8BnC,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAQ,EAAE,EAAE,CAAC,IAAA,gBAAS,EAAC,GAAG,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;IACpF,CAAC;CACJ;AAjCD,gCAiCC;AA1BU;IANN,IAAA,cAAM,EAAC;QACJ,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,6BAA6B;QAC1C,OAAO,EAAE,wBAAY;KACxB,CAAC;;6CACuB;AAGlB;IADN,IAAA,cAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC;;uCACjD;AAGZ;IADN,IAAA,cAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,+BAA+B,EAAE,CAAC;;wCAChE;AAGb;IADN,IAAA,cAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,0BAA0B,EAAE,CAAC;;uCAC5D;AAGZ;IADN,IAAA,cAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,gCAAgC,EAAE,CAAC;;uCAClE;AAGZ;IADN,IAAA,cAAM,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;;yCACd;AAGf;IADN,IAAA,cAAM,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;;2CACZ;AAGjB;IADN,IAAA,cAAM,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;;wCACf"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "fints-lib-cli",
-    "version": "0.4.0",
+    "version": "0.5.0",
     "description": "FinTS command line interface.",
     "keywords": [
         "fints",