Compare commits

...

9 Commits

Author SHA1 Message Date
3c6cb193eb 🔪🐛 Fixed pnpm in Dockerfile, moved config to src
All checks were successful
Deploy application / deploy (push) Successful in 10s
2025-02-09 13:02:02 +01:00
c5b1ec20d6 🧹 Moved Sb1 API to separate workspace and created common workspace
- Created common workspace
- Create Sparebank1Api workspace
- Moved logger to common
- Moved SB1 types to types.ts
- Logger will avoid duplicating first line when capturing console.logs
- Updated imports and added type keyword
- Added nonUniqueId type
2025-02-09 12:35:08 +01:00
efa9e785f2 🧹 Pino transports API and capture console.log
All checks were successful
Deploy application / deploy (push) Successful in 26s
2025-02-06 19:37:11 +01:00
71e70a2713 🧹 Delete token from db if expired 2025-02-06 19:13:23 +01:00
4f05382fc4 🚀 Daily is now Bank agnostic
- Separated createDir into a new file fs.ts
- Moved mapTransactions into Bank interface
- Take interval as input into importTransactions
2025-02-06 18:56:51 +01:00
066331cca8 🔪🐛 Fix corepack bug, removed unused envs, npm in docker
All checks were successful
Deploy application / deploy (push) Successful in 28s
- Replaced pnpm to npm in docker container because of a bug infestation
- Remove only allow pnpm
- Added missing envs to docker compose
2025-02-05 20:27:08 +01:00
75ad4946d2 🎉 Allow syncing multiple accounts at once
All checks were successful
Deploy application / deploy (push) Successful in 3s
- By defining multiple account keys in the .env, will fetch from all and upload to correct account
- If transaction id is 0, will not be marked as cleared
- Added accountKey to Transaction interface
2025-02-02 12:37:43 +01:00
14257fa058 ❄ Nix shell using flake 2025-02-02 12:34:09 +01:00
9b0391be7c Graceful shutdown on exceptions 2025-02-02 11:22:29 +01:00
32 changed files with 429 additions and 271 deletions

View File

@ -4,7 +4,7 @@ httpRequests
.env.* .env.*
*.sqlite *.sqlite
jest.config.ts jest.config.ts
node_modules **/node_modules
.git .git
.gitignore .gitignore
*.md *.md

View File

@ -9,8 +9,6 @@ ACTUAL_DATA_DIR=.cache
BANK_INITIAL_REFRESH_TOKEN=initial-valid-refresh-token BANK_INITIAL_REFRESH_TOKEN=initial-valid-refresh-token
BANK_OAUTH_CLIENT_ID=your-client-id BANK_OAUTH_CLIENT_ID=your-client-id
BANK_OAUTH_CLIENT_SECRET=your-client-secret BANK_OAUTH_CLIENT_SECRET=your-client-secret
BANK_OAUTH_STATE=your-state
BANK_OAUTH_REDIRECT_URI=http://your-redirect-uri.com
BANK_ACCOUNT_IDS=your-account-id1,your-account-id2 BANK_ACCOUNT_IDS=your-account-id1,your-account-id2
# Configuration # Configuration
LOG_LEVEL=info# trace | error | warn | info | debug | trace LOG_LEVEL=info# trace | error | warn | info | debug | trace

View File

@ -15,13 +15,11 @@ jobs:
ACTUAL_SERVER_URL: ${{ secrets.ACTUAL_SERVER_URL }} ACTUAL_SERVER_URL: ${{ secrets.ACTUAL_SERVER_URL }}
ACTUAL_PASSWORD: ${{ secrets.ACTUAL_PASSWORD }} ACTUAL_PASSWORD: ${{ secrets.ACTUAL_PASSWORD }}
ACTUAL_ACCOUNT_IDS: ${{ secrets.ACTUAL_ACCOUNT_IDS }} ACTUAL_ACCOUNT_IDS: ${{ secrets.ACTUAL_ACCOUNT_IDS }}
ACTUAL_DATA_DIR: ${{ var.ACTUAL_DATA_DIR }} ACTUAL_DATA_DIR: ${{ vars.ACTUAL_DATA_DIR }}
# Bank # Bank
BANK_INITIAL_REFRESH_TOKEN: ${{ secrets.BANK_INITIAL_REFRESH_TOKEN }} BANK_INITIAL_REFRESH_TOKEN: ${{ secrets.BANK_INITIAL_REFRESH_TOKEN }}
BANK_OAUTH_CLIENT_ID: ${{ secrets.BANK_OAUTH_CLIENT_ID }} BANK_OAUTH_CLIENT_ID: ${{ secrets.BANK_OAUTH_CLIENT_ID }}
BANK_OAUTH_CLIENT_SECRET: ${{ secrets.BANK_OAUTH_CLIENT_SECRET }} BANK_OAUTH_CLIENT_SECRET: ${{ secrets.BANK_OAUTH_CLIENT_SECRET }}
BANK_OAUTH_STATE: ${{ secrets.BANK_OAUTH_STATE }}
BANK_OAUTH_REDIRECT_URI: ${{ secrets.BANK_OAUTH_REDIRECT_URI }}
BANK_ACCOUNT_IDS: ${{ secrets.BANK_ACCOUNT_IDS }} BANK_ACCOUNT_IDS: ${{ secrets.BANK_ACCOUNT_IDS }}
# Configuration # Configuration
LOG_LEVEL: ${{ vars.LOG_LEVEL }} LOG_LEVEL: ${{ vars.LOG_LEVEL }}

View File

@ -1,11 +1,14 @@
FROM node:22-slim FROM node:22-slim
LABEL authors="Martin Berg Alstad" LABEL authors="Martin Berg Alstad"
COPY . . COPY . ./app
WORKDIR ./app
ENV PNPM_HOME="/pnpm" ENV PNPM_HOME="/pnpm"
ENV PATH="$PNPM_HOME:$PATH" ENV PATH="$PNPM_HOME:$PATH"
RUN corepack enable RUN corepack enable pnpm
RUN --mount=type=cache,id=pnpm,target=/pnpm/store pnpm install --prod --frozen-lockfile RUN corepack prepare pnpm@9.15.3 --activate
RUN npm i -g corepack@latest
RUN --mount=type=cache,id=pnpm,target=/pnpm/store pnpm install --prod --recursive --frozen-lockfile
CMD ["pnpm", "start-prod"] ENTRYPOINT ["pnpm", "start-prod"]

View File

@ -1,10 +1,8 @@
# Sparebank1 ActualBudget Integration # Sparebank1 ActualBudget Integration
🔧 WIP!
### Setting up the environment ### Setting up the environment
In order to start the application, a `.env.local` file must be present at the root level. The possible and required In order to start the application, an `.env.local` file must be present at the root level. The possible and required
fields fields
can be found in the [.env.example](.env.example) file and `config.ts`. can be found in the [.env.example](.env.example) file and `config.ts`.

View File

@ -1,7 +1,7 @@
services: services:
server: server:
container_name: actual_sparebank1_cronjob container_name: actual_sparebank1_cronjob
restart: unless-stopped restart: no
build: build:
context: . context: .
environment: environment:
@ -14,13 +14,14 @@ services:
- BANK_INITIAL_REFRESH_TOKEN - BANK_INITIAL_REFRESH_TOKEN
- BANK_OAUTH_CLIENT_ID - BANK_OAUTH_CLIENT_ID
- BANK_OAUTH_CLIENT_SECRET - BANK_OAUTH_CLIENT_SECRET
- BANK_OAUTH_STATE
- BANK_OAUTH_REDIRECT_URI
- BANK_ACCOUNT_IDS - BANK_ACCOUNT_IDS
- LOG_LEVEL - LOG_LEVEL
- DB_DIRECTORY # Required for Docker Compose - DB_DIRECTORY # Required for Docker Compose
- DB_FILENAME - DB_FILENAME
- TRANSACTION_RELATIVE_FROM_DATE
- TRANSACTION_RELATIVE_TO_DATE
volumes: volumes:
# TODO CACHE directory in volume?
- data:/${DB_DIRECTORY} - data:/${DB_DIRECTORY}
volumes: volumes:

27
flake.lock generated Normal file
View File

@ -0,0 +1,27 @@
{
"nodes": {
"nixpkgs": {
"locked": {
"lastModified": 1738277201,
"narHash": "sha256-6L+WXKCw5mqnUIExvqkD99pJQ41xgyCk6z/H9snClwk=",
"owner": "NixOS",
"repo": "nixpkgs",
"rev": "666e1b3f09c267afd66addebe80fb05a5ef2b554",
"type": "github"
},
"original": {
"owner": "NixOS",
"ref": "nixos-24.11",
"repo": "nixpkgs",
"type": "github"
}
},
"root": {
"inputs": {
"nixpkgs": "nixpkgs"
}
}
},
"root": "root",
"version": 7
}

28
flake.nix Normal file
View File

@ -0,0 +1,28 @@
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.11";
};
outputs = inputs@{ nixpkgs, ... }:
let
system = "x86_64-linux";
in
{
devShells.${system}.default =
let
pkgs = import nixpkgs {
inherit system;
};
in
pkgs.mkShell {
packages = with pkgs; [
git
nodejs_22
pnpm
nodePackages.prettier
];
shellHook = "fish";
};
};
}

View File

@ -51,6 +51,8 @@ GET {{bankingBaseUrl}}/accounts
Authorization: Bearer {{ACCESS_TOKEN}} Authorization: Bearer {{ACCESS_TOKEN}}
### Fetch all transactions of specific days (inclusive) ### Fetch all transactions of specific days (inclusive)
GET {{bankingBaseUrl}}/transactions?accountKey={{brukskontoAccountKey}}&fromDate=2025-01-20&toDate=2025-01-22 GET {{bankingBaseUrl}}/transactions?accountKey={{accountKey1}}&accountKey={{accountKey2}}&
fromDate=2025-01-20&
toDate=2025-01-24
Authorization: Bearer {{ACCESS_TOKEN}} Authorization: Bearer {{ACCESS_TOKEN}}
Accept: application/vnd.sparebank1.v1+json; charset=utf-8 Accept: application/vnd.sparebank1.v1+json; charset=utf-8

View File

@ -2,13 +2,11 @@
"name": "sparebank1_actual_budget_integration", "name": "sparebank1_actual_budget_integration",
"version": "1.0.0", "version": "1.0.0",
"description": "", "description": "",
"main": "index.js",
"scripts": { "scripts": {
"preinstall": "npx only-allow pnpm", "start": "dotenvx run --env-file=.env.local -- node --import=tsx ./src/main.ts | ./packages/common/node_modules/pino-pretty/bin.js",
"start": "dotenvx run --env-file=.env.local -- node --import=tsx ./src/main.ts | pino-pretty",
"start-prod": "node --import=tsx ./src/main.ts", "start-prod": "node --import=tsx ./src/main.ts",
"run-once": "ONCE=true dotenvx run --env-file=.env.local -- node --import=tsx ./src/main.ts | pino-pretty", "run-once": "ONCE=true dotenvx run --env-file=.env.local -- node --import=tsx ./src/main.ts | ./packages/common/node_modules/pino-pretty/bin.js",
"test": "dotenvx run --env-file=.env.test.local -- node --experimental-vm-modules node_modules/jest/bin/jest.js | pino-pretty", "test": "dotenvx run --env-file=.env.test.local -- node --experimental-vm-modules node_modules/jest/bin/jest.js | ./packages/common/node_modules/pino-pretty/bin.js",
"docker-build": "DB_DIRECTORY=data docker compose --env-file .env.local up -d --build", "docker-build": "DB_DIRECTORY=data docker compose --env-file .env.local up -d --build",
"format": "prettier --write \"./**/*.{js,mjs,ts,md,json}\"" "format": "prettier --write \"./**/*.{js,mjs,ts,md,json}\""
}, },
@ -22,7 +20,6 @@
"cron": "^3.5.0", "cron": "^3.5.0",
"dayjs": "^1.11.13", "dayjs": "^1.11.13",
"dotenv": "^16.4.7", "dotenv": "^16.4.7",
"pino": "^9.6.0",
"prettier": "^3.4.2", "prettier": "^3.4.2",
"tsx": "^4.19.2" "tsx": "^4.19.2"
}, },
@ -32,7 +29,6 @@
"@types/jest": "^29.5.14", "@types/jest": "^29.5.14",
"@types/node": "^22.10.7", "@types/node": "^22.10.7",
"jest": "^29.7.0", "jest": "^29.7.0",
"pino-pretty": "^13.0.0",
"ts-jest": "^29.2.5", "ts-jest": "^29.2.5",
"ts-node": "^10.9.2", "ts-node": "^10.9.2",
"typescript": "^5.7.3" "typescript": "^5.7.3"

21
packages/common/logger.ts Normal file
View File

@ -0,0 +1,21 @@
import pino from "pino"
import { LOG_LEVEL } from "@/config.ts"
/**
* / Returns a logging instance with the default log-level "info"
*/
const logger = pino(
pino.destination({
level: LOG_LEVEL,
}),
)
console.log = function (...args): void {
if (args.length > 1) {
logger.info(args?.slice(1), args?.[0])
} else {
logger.info(args?.[0])
}
}
export default logger

View File

@ -0,0 +1,12 @@
{
"name": "common",
"version": "1.0.0",
"description": "",
"license": "ISC",
"dependencies": {
"pino": "^9.6.0"
},
"devDependencies": {
"pino-pretty": "^13.0.0"
}
}

View File

@ -0,0 +1,12 @@
import type { Failure, Success } from "./types"
export const baseUrl = "https://api.sparebank1.no"
export const success = <T>(data: T): Success<T> => ({
status: "success",
data: data,
})
export const failure = <T>(data: T): Failure<T> => ({
status: "failure",
data: data,
})

View File

@ -0,0 +1,30 @@
import { OAuthTokenResponse, Result } from "./types"
import * as querystring from "node:querystring"
import { baseUrl, failure, success } from "./common"
import logger from "@common/logger"
export async function refreshToken(
clientId: string,
clientSecret: string,
refreshToken: string,
): Promise<Result<OAuthTokenResponse, string>> {
const queries = querystring.stringify({
client_id: clientId,
client_secret: clientSecret,
refresh_token: refreshToken,
grant_type: "refresh_token",
})
const url = `${baseUrl}/oauth/token?${queries}`
logger.debug(`Sending POST request to url: '${url}'`)
const response = await fetch(url, {
method: "post",
headers: {
"Content-Type": "application/x-www-form-urlencoded",
},
})
logger.debug(`Received response with status '${response.status}'`)
if (!response.ok) {
return failure(await response.text())
}
return success(await response.json())
}

View File

@ -0,0 +1,6 @@
{
"name": "packages",
"version": "1.0.0",
"description": "",
"license": "ISC"
}

View File

@ -0,0 +1,35 @@
import type { Interval, TransactionResponse } from "./types"
import * as querystring from "node:querystring"
import { toISODateString } from "@common/date"
import logger from "@common/logger"
import { baseUrl } from "./common"
export async function list(
accessToken: string,
accountKeys: string | ReadonlyArray<string>,
interval?: Interval,
): Promise<TransactionResponse> {
const queryString = querystring.stringify({
accountKey: accountKeys,
...(interval && {
fromDate: toISODateString(interval.fromDate),
toDate: toISODateString(interval.toDate),
}),
})
const url = `${baseUrl}/personal/banking/transactions?${queryString}`
logger.debug(`Sending GET request to '${url}'`)
const response = await fetch(url, {
headers: {
Authorization: `Bearer ${accessToken}`,
Accept: "application/vnd.sparebank1.v1+json;charset=utf-8",
},
})
logger.debug(`Received response with status '${response.status}'`)
if (response.ok) {
return response.json()
} else {
logger.warn(await response.json())
return { transactions: [] }
}
}

View File

@ -0,0 +1,43 @@
import type { Dayjs } from "dayjs"
export type Success<T> = { status: "success"; data: T }
export type Failure<T> = { status: "failure"; data: T }
export type Result<OK, Err> = Success<OK> | Failure<Err>
export interface Interval {
fromDate: Dayjs
toDate: Dayjs
}
export interface OAuthTokenResponse {
access_token: string
expires_in: number
refresh_token_expires_in: number
refresh_token_absolute_expires_in: number
token_type: "Bearer"
refresh_token: string
}
export type BookingStatus = "PENDING" | "BOOKED"
export type NonUniqueId = "000000000000000000" | `${number}`
export interface SB1Transaction {
id: string
nonUniqueId: NonUniqueId
// The Id of the account
accountKey: string
// Unix time
date: number
// Amount in NOK
amount: number
cleanedDescription: string
remoteAccountName: string
bookingStatus: BookingStatus
[key: string]: string | number | boolean | unknown
}
export interface TransactionResponse {
transactions: ReadonlyArray<SB1Transaction>
}

18
pnpm-lock.yaml generated
View File

@ -26,9 +26,6 @@ importers:
dotenv: dotenv:
specifier: ^16.4.7 specifier: ^16.4.7
version: 16.4.7 version: 16.4.7
pino:
specifier: ^9.6.0
version: 9.6.0
prettier: prettier:
specifier: ^3.4.2 specifier: ^3.4.2
version: 3.4.2 version: 3.4.2
@ -51,9 +48,6 @@ importers:
jest: jest:
specifier: ^29.7.0 specifier: ^29.7.0
version: 29.7.0(@types/node@22.10.7)(ts-node@10.9.2(@types/node@22.10.7)(typescript@5.7.3)) version: 29.7.0(@types/node@22.10.7)(ts-node@10.9.2(@types/node@22.10.7)(typescript@5.7.3))
pino-pretty:
specifier: ^13.0.0
version: 13.0.0
ts-jest: ts-jest:
specifier: ^29.2.5 specifier: ^29.2.5
version: 29.2.5(@babel/core@7.26.0)(@jest/transform@29.7.0)(@jest/types@29.6.3)(babel-jest@29.7.0(@babel/core@7.26.0))(jest@29.7.0(@types/node@22.10.7)(ts-node@10.9.2(@types/node@22.10.7)(typescript@5.7.3)))(typescript@5.7.3) version: 29.2.5(@babel/core@7.26.0)(@jest/transform@29.7.0)(@jest/types@29.6.3)(babel-jest@29.7.0(@babel/core@7.26.0))(jest@29.7.0(@types/node@22.10.7)(ts-node@10.9.2(@types/node@22.10.7)(typescript@5.7.3)))(typescript@5.7.3)
@ -64,6 +58,18 @@ importers:
specifier: ^5.7.3 specifier: ^5.7.3
version: 5.7.3 version: 5.7.3
packages/common:
dependencies:
pino:
specifier: ^9.6.0
version: 9.6.0
devDependencies:
pino-pretty:
specifier: ^13.0.0
version: 13.0.0
packages/sparebank1Api: {}
packages: packages:
'@actual-app/api@25.1.0': '@actual-app/api@25.1.0':

2
pnpm-workspace.yaml Normal file
View File

@ -0,0 +1,2 @@
packages:
- "packages/*"

View File

@ -4,21 +4,22 @@ import {
ACTUAL_PASSWORD, ACTUAL_PASSWORD,
ACTUAL_SERVER_URL, ACTUAL_SERVER_URL,
ACTUAL_SYNC_ID, ACTUAL_SYNC_ID,
} from "../config.ts" } from "@/config.ts"
import type { TransactionEntity } from "@actual-app/api/@types/loot-core/types/models" import type { TransactionEntity } from "@actual-app/api/@types/loot-core/types/models"
import { type UUID } from "node:crypto" import { type UUID } from "node:crypto"
import logger from "@/logger.ts" import logger from "@common/logger.ts"
export interface Actual { export interface Actual {
importTransactions: ( importTransactions: (
accountId: UUID, accountId: UUID,
transactions: ReadonlyArray<ActualTransaction>, transactions: Iterable<ActualTransaction>,
) => Promise<ImportTransactionsResponse> ) => Promise<ImportTransactionsResponse>
shutdown: () => Promise<void> shutdown: () => Promise<void>
} }
export interface ActualTransaction extends TransactionEntity { export interface ActualTransaction extends TransactionEntity {
account: UUID
payee_name?: string payee_name?: string
} }
@ -51,7 +52,7 @@ export class ActualImpl implements Actual {
async importTransactions( async importTransactions(
accountId: UUID, accountId: UUID,
transactions: ReadonlyArray<ActualTransaction>, transactions: Iterable<ActualTransaction>,
): Promise<ImportTransactionsResponse> { ): Promise<ImportTransactionsResponse> {
return actual.importTransactions(accountId, transactions) return actual.importTransactions(accountId, transactions)
} }

View File

@ -1,7 +1,7 @@
import Database from "better-sqlite3" import Database from "better-sqlite3"
import { type OAuthTokenResponse } from "@/bank/sparebank1.ts"
import dayjs, { type Dayjs } from "dayjs" import dayjs, { type Dayjs } from "dayjs"
import type { OAuthTokenResponse } from "@sb1/types.ts"
export type TokenResponse = { export type TokenResponse = {
key: TokenKey key: TokenKey
@ -9,10 +9,8 @@ export type TokenResponse = {
expires_at: Dayjs expires_at: Dayjs
} }
export type TokenResponseRaw = { type TokenResponseRaw = {
key: TokenResponse["key"] [K in keyof TokenResponse]: K extends "expires_at" ? string : TokenResponse[K]
token: TokenResponse["token"]
expires_at: string
} }
export type TokenKey = "access-token" | "refresh-token" export type TokenKey = "access-token" | "refresh-token"
@ -50,7 +48,7 @@ function insertRefreshToken(
db: Database.Database, db: Database.Database,
refreshToken: string, refreshToken: string,
expiresIn: number, expiresIn: number,
) { ): void {
insert(db, "refresh-token", refreshToken, expiresIn) insert(db, "refresh-token", refreshToken, expiresIn)
} }
@ -59,7 +57,7 @@ function insert(
key: TokenKey, key: TokenKey,
token: string, token: string,
expiresIn: number, expiresIn: number,
) { ): void {
db.prepare("INSERT OR REPLACE INTO tokens VALUES (?, ?, ?)").run( db.prepare("INSERT OR REPLACE INTO tokens VALUES (?, ?, ?)").run(
key, key,
token, token,
@ -82,3 +80,10 @@ export function fetchToken(
} }
) )
} }
export function clearTokens(db: Database.Database): void {
db.prepare("DELETE FROM tokens WHERE key in ( ?, ? )").run([
"access-token",
"refresh-token",
] as TokenKey[])
}

View File

@ -1,49 +1,33 @@
import { import {
BANK_INITIAL_REFRESH_TOKEN, BANK_INITIAL_REFRESH_TOKEN,
TRANSACTION_RELATIVE_FROM_DATE, BANK_OAUTH_CLIENT_ID,
TRANSACTION_RELATIVE_TO_DATE, BANK_OAUTH_CLIENT_SECRET,
} from "@/../config.ts" } from "@/config.ts"
import logger from "@/logger.ts" import logger from "@common/logger.ts"
import dayjs from "dayjs" import dayjs, { type Dayjs } from "dayjs"
import { Database } from "better-sqlite3" import type { Database } from "better-sqlite3"
import { import {
clearTokens,
fetchToken, fetchToken,
insertTokens, insertTokens,
type TokenResponse, type TokenResponse,
} from "@/bank/db/queries.ts" } from "@/bank/db/queries.ts"
import * as Api from "./sparebank1Api.ts" import * as Oauth from "@sb1/oauth.ts"
import * as Transactions from "@sb1/transactions.ts"
export interface OAuthTokenResponse { import type { ActualTransaction } from "@/actual.ts"
access_token: string import { bankTransactionIntoActualTransaction } from "@/mappings.ts"
expires_in: number import type { OAuthTokenResponse } from "@sb1/types.ts"
refresh_token_expires_in: number
refresh_token_absolute_expires_in: number
token_type: "Bearer"
refresh_token: string
}
export type BookingStatus = "PENDING" | "BOOKED"
export interface Transaction {
id: string
nonUniqueId: string
date: number // Unix time
amount: number // Amount in NOK
cleanedDescription: string
remoteAccountName: string
bookingStatus: BookingStatus
[key: string]: string | number | boolean | unknown
}
export interface TransactionResponse {
transactions: ReadonlyArray<Transaction>
}
export interface Bank { export interface Bank {
transactionsPastDay: ( fetchTransactions: (
interval: Interval,
...accountKeys: ReadonlyArray<string> ...accountKeys: ReadonlyArray<string>
) => Promise<TransactionResponse> ) => Promise<ReadonlyArray<ActualTransaction>>
}
export interface Interval {
fromDate: Dayjs
toDate: Dayjs
} }
export class Sparebank1Impl implements Bank { export class Sparebank1Impl implements Bank {
@ -53,6 +37,19 @@ export class Sparebank1Impl implements Bank {
this.db = db this.db = db
} }
async fetchTransactions(
interval: Interval,
...accountKeys: ReadonlyArray<string>
): Promise<ReadonlyArray<ActualTransaction>> {
const response = await Transactions.list(
await this.getAccessToken(),
accountKeys,
interval,
)
const sparebankTransactions = response.transactions
return sparebankTransactions.map(bankTransactionIntoActualTransaction)
}
private async getAccessToken(): Promise<string> { private async getAccessToken(): Promise<string> {
const accessToken = fetchToken(this.db, "access-token") const accessToken = fetchToken(this.db, "access-token")
@ -76,34 +73,25 @@ export class Sparebank1Impl implements Bank {
} else if (this.isValidToken(tokenResponse)) { } else if (this.isValidToken(tokenResponse)) {
return tokenResponse.token return tokenResponse.token
} }
// TODO clear database, if refresh token is invalid, will cause Exceptions on each call logger.warn("Refresh token expired, deleting tokens from database")
clearTokens(this.db)
throw new Error("Refresh token is expired. Create a new one") throw new Error("Refresh token is expired. Create a new one")
} }
async fetchNewTokens(): Promise<OAuthTokenResponse> { private async fetchNewTokens(): Promise<OAuthTokenResponse> {
const refreshToken = await this.getRefreshToken() const refreshToken = await this.getRefreshToken()
const result = await Api.refreshToken(refreshToken) const result = await Oauth.refreshToken(
BANK_OAUTH_CLIENT_ID,
BANK_OAUTH_CLIENT_SECRET,
refreshToken,
)
if (result.status === "failure") { if (result.status === "failure") {
throw logger.error({ throw new Error(`Failed to fetch refresh token: '${result.data}'`)
err: new Error(`Failed to fetch refresh token: '${result.data}'`),
})
} }
const oAuthToken = result.data const oAuthToken = result.data
insertTokens(this.db, oAuthToken) insertTokens(this.db, oAuthToken)
return oAuthToken return oAuthToken
} }
async transactionsPastDay(
...accountKeys: ReadonlyArray<string>
): Promise<TransactionResponse> {
const today = dayjs()
const fromDate = today.subtract(TRANSACTION_RELATIVE_FROM_DATE, "days")
const toDate = today.subtract(TRANSACTION_RELATIVE_TO_DATE, "days")
return await Api.transactions(await this.getAccessToken(), accountKeys, {
fromDate,
toDate,
})
}
} }

View File

@ -1,80 +0,0 @@
import { BANK_OAUTH_CLIENT_ID, BANK_OAUTH_CLIENT_SECRET } from "../../config.ts"
import type {
OAuthTokenResponse,
TransactionResponse,
} from "@/bank/sparebank1.ts"
import logger from "@/logger.ts"
import { type Dayjs } from "dayjs"
import { toISODateString } from "@/date.ts"
const baseUrl = "https://api.sparebank1.no"
type Success<T> = { status: "success"; data: T }
type Failure<T> = { status: "failure"; data: T }
type Result<OK, Err> = Success<OK> | Failure<Err>
function success<T>(data: T): Success<T> {
return { status: "success", data: data }
}
function failure<T>(data: T): Failure<T> {
return { status: "failure", data: data }
}
export async function transactions(
accessToken: string,
accountKeys: string | ReadonlyArray<string>,
timePeriod?: {
fromDate: Dayjs
toDate: Dayjs
},
): Promise<TransactionResponse> {
const queries = new URLSearchParams({
// TODO allow multiple accountKeys
accountKey: typeof accountKeys === "string" ? accountKeys : accountKeys[0],
...(timePeriod && {
fromDate: toISODateString(timePeriod.fromDate),
toDate: toISODateString(timePeriod.toDate),
}),
})
const url = `${baseUrl}/personal/banking/transactions?${queries}`
logger.debug(`Sending GET request to '${url}'`)
const response = await fetch(url, {
headers: {
Authorization: `Bearer ${accessToken}`,
Accept: "application/vnd.sparebank1.v1+json;charset=utf-8",
},
})
logger.debug(`Received response with status '${response.status}'`)
if (response.ok) {
return response.json()
} else {
logger.warn(await response.json())
return { transactions: [] }
}
}
export async function refreshToken(
refreshToken: string,
): Promise<Result<OAuthTokenResponse, string>> {
const queries = new URLSearchParams({
client_id: BANK_OAUTH_CLIENT_ID,
client_secret: BANK_OAUTH_CLIENT_SECRET,
refresh_token: refreshToken,
grant_type: "refresh_token",
})
const url = `${baseUrl}/oauth/token?${queries}`
logger.debug(`Sending POST request to url: '${url}'`)
const response = await fetch(url, {
method: "post",
headers: {
"Content-Type": "application/x-www-form-urlencoded",
},
})
logger.debug(`Received response with status '${response.status}'`)
if (!response.ok) {
return failure(await response.text())
}
return success(await response.json())
}

View File

@ -22,6 +22,7 @@ export const BANK_ACCOUNT_IDS = getArrayOrThrow("BANK_ACCOUNT_IDS")
export const DB_DIRECTORY = getOrDefault("DB_DIRECTORY", "data") export const DB_DIRECTORY = getOrDefault("DB_DIRECTORY", "data")
export const DB_FILENAME = getOrDefault("DB_FILENAME", "default") export const DB_FILENAME = getOrDefault("DB_FILENAME", "default")
export const LOG_LEVEL = getOrDefault("LOG_LEVEL", "info") export const LOG_LEVEL = getOrDefault("LOG_LEVEL", "info")
// TODO default to fetch 1 day
// Relative number of days in the past to start fetching transactions from // Relative number of days in the past to start fetching transactions from
export const TRANSACTION_RELATIVE_FROM_DATE = getNumberOrDefault( export const TRANSACTION_RELATIVE_FROM_DATE = getNumberOrDefault(
"TRANSACTION_RELATIVE_FROM_DATE", "TRANSACTION_RELATIVE_FROM_DATE",

View File

@ -1,5 +1,5 @@
import { CronJob } from "cron" import { CronJob } from "cron"
import logger from "@/logger.ts" import logger from "@common/logger.ts"
/** /**
* Run a function every day at 1 AM, Oslo time. * Run a function every day at 1 AM, Oslo time.

13
src/fs.ts Normal file
View File

@ -0,0 +1,13 @@
import * as fs from "node:fs"
import logger from "@common/logger"
export function createDirsIfMissing(...directories: string[]): void {
directories.forEach(createDirIfMissing)
}
export function createDirIfMissing(directory: string): void {
if (!fs.existsSync(directory)) {
logger.info(`Missing '${directory}', creating...`)
fs.mkdirSync(directory, { recursive: true })
}
}

View File

@ -1,9 +0,0 @@
import pino from "pino"
import { LOG_LEVEL } from "../config.ts"
/**
* / Returns a logging instance with the default log-level "info"
*/
export default pino({
level: LOG_LEVEL,
})

View File

@ -1,73 +1,67 @@
import { type Actual, ActualImpl } from "@/actual.ts" import { type Actual, ActualImpl } from "@/actual.ts"
import { cronJobDaily } from "@/cron.ts" import { cronJobDaily } from "@/cron.ts"
import { type Bank, type Interval, Sparebank1Impl } from "@/bank/sparebank1.ts"
import { import {
type Bank,
Sparebank1Impl,
type Transaction,
} from "@/bank/sparebank1.ts"
import { bankTransactionIntoActualTransaction } from "@/mappings.ts"
import {
ACTUAL_ACCOUNT_IDS,
ACTUAL_DATA_DIR, ACTUAL_DATA_DIR,
BANK_ACCOUNT_IDS, BANK_ACCOUNT_IDS,
DB_DIRECTORY, DB_DIRECTORY,
DB_FILENAME, DB_FILENAME,
} from "../config.ts" TRANSACTION_RELATIVE_FROM_DATE,
import logger from "@/logger.ts" TRANSACTION_RELATIVE_TO_DATE,
} from "@/config.ts"
import logger from "@common/logger.ts"
import type { UUID } from "node:crypto" import type { UUID } from "node:crypto"
import { createDb } from "@/bank/db/queries.ts" import { createDb } from "@/bank/db/queries.ts"
import * as fs from "node:fs"
import { CronJob } from "cron" import { CronJob } from "cron"
import { createDirsIfMissing } from "@/fs.ts"
import dayjs from "dayjs"
// TODO Transports api for pino https://github.com/pinojs/pino/blob/HEAD/docs/transports.md
// TODO move tsx to devDependency. Requires ts support for Node with support for @ alias // TODO move tsx to devDependency. Requires ts support for Node with support for @ alias
// TODO global exception handler, log and graceful shutdown
// TODO verbatimSyntax in tsconfig, conflicts with jest // TODO verbatimSyntax in tsconfig, conflicts with jest
// TODO multi module project. Main | DAL | Sparebank1 impl // TODO multi module project. Main | DAL | Sparebank1 impl
// TODO store last fetched date in db, and refetch from that date, if app has been offline for some time // TODO store last fetched date in db, and refetch from that date, if app has been offline for some time
// TODO do not fetch if saturday or sunday
export async function daily(actual: Actual, bank: Bank): Promise<void> { export async function daily(actual: Actual, bank: Bank): Promise<void> {
// Fetch transactions from the bank // Fetch transactions from the bank
const transactions = await fetchTransactionsFromPastDay(bank) const actualTransactions = await bank.fetchTransactions(
logger.info(`Fetched ${transactions.length} transactions`) relativeInterval(),
...BANK_ACCOUNT_IDS,
// TODO multiple accounts
const accountId = ACTUAL_ACCOUNT_IDS[0] as UUID
const actualTransactions = transactions.map((transaction) =>
// TODO move to Bank interface?
bankTransactionIntoActualTransaction(transaction, accountId),
) )
logger.info(`Fetched ${actualTransactions.length} transactions`)
// TODO Import transactions into Actual const transactionsByAccount = Object.groupBy(
// If multiple accounts, loop over them
// Get account ID from mapper
const response = await actual.importTransactions(
accountId,
actualTransactions, actualTransactions,
(transaction) => transaction.account,
)
const responses = await Promise.all(
Object.entries(transactionsByAccount).map(([accountId, transactions]) =>
actual.importTransactions(accountId as UUID, transactions || []),
),
)
logger.debug(
responses.map((response) => ({
added: response.added,
updated: response.updated,
})),
"Finished importing transactions",
) )
logger.info(`ImportTransactionsResponse=${JSON.stringify(response)}`)
} }
async function fetchTransactionsFromPastDay( function relativeInterval(): Interval {
bank: Bank, const today = dayjs()
): Promise<ReadonlyArray<Transaction>> { return {
const response = await bank.transactionsPastDay(...BANK_ACCOUNT_IDS) fromDate: today.subtract(TRANSACTION_RELATIVE_FROM_DATE, "days"),
return response.transactions toDate: today.subtract(TRANSACTION_RELATIVE_TO_DATE, "days"),
}
function createDirIfMissing(directory: string): void {
if (!fs.existsSync(directory)) {
logger.info(`Missing '${directory}', creating...`)
fs.mkdirSync(directory, { recursive: true })
} }
} }
async function main(): Promise<void> { async function main(): Promise<void> {
logger.info("Starting application") logger.info("Starting application")
createDirIfMissing(ACTUAL_DATA_DIR) createDirsIfMissing(ACTUAL_DATA_DIR, DB_DIRECTORY)
createDirIfMissing(DB_DIRECTORY)
const actual = await ActualImpl.init() const actual = await ActualImpl.init()
const databaseFilePath = `${DB_DIRECTORY}/${DB_FILENAME}.sqlite` const databaseFilePath = `${DB_DIRECTORY}/${DB_FILENAME}.sqlite`
@ -82,14 +76,21 @@ async function main(): Promise<void> {
let cronJob: CronJob | undefined let cronJob: CronJob | undefined
if (process.env.ONCE) { if (process.env.ONCE) {
await daily(actual, bank) try {
await shutdown() return await daily(actual, bank)
return } finally {
await shutdown()
}
} }
logger.info("Waiting for CRON job to start") logger.info("Waiting for CRON job to start")
// TODO init and shutdown resources when job runs? // TODO init and shutdown resources when job runs?
cronJob = cronJobDaily(async () => await daily(actual, bank)) try {
cronJob = cronJobDaily(async () => await daily(actual, bank))
} catch (exception) {
logger.error(exception, "Caught exception at daily job, shutting down!")
await shutdown()
}
async function shutdown(): Promise<void> { async function shutdown(): Promise<void> {
logger.info("Shutting down, Bye!") logger.info("Shutting down, Bye!")

View File

@ -1,29 +1,46 @@
import type { Transaction } from "@/bank/sparebank1.ts"
import type { UUID } from "node:crypto" import type { UUID } from "node:crypto"
import dayjs from "dayjs" import dayjs from "dayjs"
import { toISODateString } from "@/date.ts"
import { type ActualTransaction } from "@/actual.ts" import { type ActualTransaction } from "@/actual.ts"
import { ACTUAL_ACCOUNT_IDS, BANK_ACCOUNT_IDS } from "@/config.ts"
import logger from "@common/logger.ts"
import { toISODateString } from "@common/date.ts"
import type { SB1Transaction } from "@sb1/types.ts"
export function bankTransactionIntoActualTransaction( export function bankTransactionIntoActualTransaction(
transaction: Transaction, transaction: SB1Transaction,
accountId: UUID,
): ActualTransaction { ): ActualTransaction {
return { return {
id: transaction.id, id: transaction.id,
// Transactions with the same id will be ignored // Transactions with the same id will be ignored
imported_id: transaction.nonUniqueId, imported_id: transaction.nonUniqueId,
account: accountId, account: getActualAccountId(transaction),
// The value without decimals // The value without decimals
amount: transaction.amount * 100, amount: Math.floor(transaction.amount * 100),
date: toISODateString(dayjs(transaction.date)), date: toISODateString(dayjs(transaction.date)),
payee_name: transaction.cleanedDescription, payee_name: transaction.cleanedDescription,
// TODO if not cleared or nonUniqueId is 0, rerun later // TODO if not cleared or nonUniqueId is 0, rerun later
cleared: transaction.bookingStatus === "BOOKED", cleared: isCleared(transaction),
} }
} }
// TODO take the account from the bank and match it to the actual account export function isCleared(transaction: SB1Transaction): boolean {
// Use ENV const id = Number(transaction.nonUniqueId)
export function bankAccountIntoActualAccount(account: string): string { return transaction.bookingStatus === "BOOKED" && !Number.isNaN(id) && id > 0
throw new Error("Not implemented") }
function getActualAccountId(transcation: SB1Transaction): UUID {
for (
let i = 0;
i < Math.min(ACTUAL_ACCOUNT_IDS.length, BANK_ACCOUNT_IDS.length);
i++
) {
if (BANK_ACCOUNT_IDS[i] === transcation.accountKey) {
return ACTUAL_ACCOUNT_IDS[i] as UUID
}
}
const error = new Error(
"Failed to find ActualAccountId, length of BANK_ACCOUNT_IDS and ACTUAL_ACCOUNT_IDS must match",
)
logger.error(error)
throw error
} }

View File

@ -1,41 +1,41 @@
import type { import type { Bank, Interval } from "@/bank/sparebank1.ts"
Bank,
BookingStatus,
TransactionResponse,
} from "@/bank/sparebank1.ts"
import dayjs from "dayjs" import dayjs from "dayjs"
import type { ActualTransaction } from "@/actual.ts"
import { bankTransactionIntoActualTransaction } from "@/mappings.ts"
import type { BookingStatus, SB1Transaction } from "@sb1/types.ts"
export class BankStub implements Bank { export class BankStub implements Bank {
async transactionsPastDay( async fetchTransactions(
_interval: Interval,
_accountIds: ReadonlyArray<string> | string, _accountIds: ReadonlyArray<string> | string,
): Promise<TransactionResponse> { ): Promise<ReadonlyArray<ActualTransaction>> {
const someFields = { const someFields = {
date: dayjs("2019-08-20").unix(), date: dayjs("2019-08-20").unix(),
cleanedDescription: "Test transaction", cleanedDescription: "Test transaction",
remoteAccountName: "Test account", remoteAccountName: "Test account",
bookingStatus: "BOOKED" as BookingStatus, bookingStatus: "BOOKED" as BookingStatus,
accountKey: "1",
} }
return { const bankTransactions: ReadonlyArray<SB1Transaction> = [
transactions: [ {
{ id: "1",
id: "1", nonUniqueId: "1",
nonUniqueId: "1", amount: 100,
amount: 100, ...someFields,
...someFields, },
}, {
{ id: "2",
id: "2", nonUniqueId: "2",
nonUniqueId: "2", amount: 200,
amount: 200, ...someFields,
...someFields, },
}, {
{ id: "3",
id: "3", nonUniqueId: "3",
nonUniqueId: "3", amount: -50,
amount: -50, ...someFields,
...someFields, },
}, ]
], return bankTransactions.map(bankTransactionIntoActualTransaction)
}
} }
} }

View File

@ -1,5 +1,5 @@
{ {
"include": ["./src/**/*.ts", "./tests/**/*.ts"], "include": ["./src/**/*.ts", "./packages/**/*.ts", "./tests/**/*.ts"],
"compilerOptions": { "compilerOptions": {
"target": "esnext", "target": "esnext",
"module": "ESNext", "module": "ESNext",
@ -9,8 +9,11 @@
"strict": true, "strict": true,
"skipLibCheck": true, "skipLibCheck": true,
"allowImportingTsExtensions": true, "allowImportingTsExtensions": true,
"noEmit": true,
"paths": { "paths": {
"@/*": ["./src/*"] "@/*": ["./src/*"],
"@common/*": ["./packages/common/*"],
"@sb1/*": ["./packages/sparebank1Api/*"]
} }
}, },
"exclude": ["node_modules", "./*.ts", "__test__"] "exclude": ["node_modules", "./*.ts", "__test__"]