Refactor: Migrate to railway driven programming with typescript-functional-extensions

.cursor/mcp.json

@@ -0,0 +1,7 @@
+{
+  "mcpServers": {
+    "nx-mcp": {
+      "url": "http://localhost:9717/sse"
+    }
+  }
+}

.vscode/extensions.json

@@ -2,7 +2,6 @@
   "recommendations": [
     "nrwl.angular-console",
     "esbenp.prettier-vscode",
-    "dbaeumer.vscode-eslint",
-    "firsttris.vscode-jest-runner"
+    "dbaeumer.vscode-eslint"
   ]
 }

apps/papierkram-devkit-api-e2e/src/papierkram-devkit-api/import-current-week.spec.ts

@@ -6,8 +6,8 @@ describe('Import time entries form toggl', () => {
     const monday = 1
 
     const thisWeek = {
-      from: startOfWeek(new Date(), { weekStartsOn: monday }),
-      to: endOfWeek(new Date(), { weekStartsOn: monday })
+      from: startOfWeek(new Date('2025-05-15'), { weekStartsOn: monday }),
+      to: endOfWeek(new Date('2025-05-15'), { weekStartsOn: monday })
     }
 
     const response = await axios.post(

apps/papierkram-devkit-api/src/app/papierkram-api/time-entry/papierkram-read-client.service.ts

@@ -1,11 +1,13 @@
-import { Injectable, Logger } from '@nestjs/common'
 import { HttpService } from '@nestjs/axios'
+import { Injectable, Logger } from '@nestjs/common'
 
-import { PapierkramTimeEntry } from '../types/papierkram-time-entry'
-import { PapierkramApiConfig } from './papierkram-api-config.service'
 import { TimeFrame } from '../../utils/time-frame'
 import { toDateOnly } from '../../utils/to-date-only'
+import { PapierkramTimeEntry } from '../types/papierkram-time-entry'
+import { PapierkramApiConfig } from './papierkram-api-config.service'
 
+import { AxiosResponse } from 'axios'
+import { ResultAsync } from 'typescript-functional-extensions'
 @Injectable()
 export class PapierkramTimeEntryReadClient {
   private logger = new Logger('PapierkramTimeEntryReadClient')
@@ -15,34 +17,43 @@ export class PapierkramTimeEntryReadClient {
     private config: PapierkramApiConfig
   ) {}
 
-  async readTimeEntries(timeFrame: TimeFrame): Promise<PapierkramTimeEntry[]> {
-    const { from, to } = toDateOnly(timeFrame)
-
-    try {
-      const response = await this.httpClient.axiosRef.get<{
-        entries: PapierkramTimeEntry[]
-        hasMore: boolean
-      }>(`${this.config.apiUrl}/tracker/time_entries`, {
-        params: {
-          projectId: this.config.projectId,
-          start_time_range_start: from,
-          start_time_range_end: to
-        },
-        headers: {
-          Accept: 'application/json', // without papierkram-api yields 406 Not Acceptable
-          Authorization: `Bearer ${this.config.apiToken}`
-        }
-      })
+  readTimeEntries(timeFrame: TimeFrame): ResultAsync<PapierkramTimeEntry[]> {
+    return ResultAsync.from(this.getTimeEntries.apply(this, [timeFrame]))
+      .mapError(error =>
+        error instanceof Error
+          ? error.message
+          : '[Papierkram API]: Could not read time entries.'
+      )
+      .map(response => response.data)
+      .ensure(
+        response => !response.hasMore,
+        'Not Supported, yet - Not all time entries could be loaded within one request. Please shrink the time range to get fewer results in order to be able to compare time entries safely.'
+      )
+      .map(response => response.entries)
+      .tapFailure(reason => this.logger.error(reason))
+  }
 
-      if (response.data.hasMore)
-        throw new Error(
-          'Not Supported, yet - Not all time entries could be loaded within one request. Please shrink the time range to get fewer results in order to be able to compare time entries safely.'
-        )
+  private getTimeEntries(timeFrame: TimeFrame): Promise<
+    AxiosResponse<{
+      entries: PapierkramTimeEntry[]
+      hasMore: boolean
+    }>
+  > {
+    const { from, to } = toDateOnly(timeFrame)
 
-      return response.data.entries
-    } catch (error) {
-      this.logger.error(error)
-      return []
-    }
+    return this.httpClient.axiosRef.get<{
+      entries: PapierkramTimeEntry[]
+      hasMore: boolean
+    }>(`${this.config.apiUrl}/tracker/time_entries`, {
+      params: {
+        projectId: this.config.projectId,
+        start_time_range_start: from,
+        start_time_range_end: to
+      },
+      headers: {
+        Accept: 'application/json', // without papierkram-api yields 406 Not Acceptable
+        Authorization: `Bearer ${this.config.apiToken}`
+      }
+    })
   }
 }

apps/papierkram-devkit-api/src/app/papierkram-import/toggl/time-entries/papierkram-import-time-entry.controller.ts

@@ -1,12 +1,13 @@
 import { Body, Controller, Logger, Post } from '@nestjs/common'
 import {
-  PapierkramTimeEntryReadClient,
-  PapierkramTimeEntryImporter
+  PapierkramTimeEntryImporter,
+  PapierkramTimeEntryReadClient
 } from '@papierkram/api'
 import { TogglReadClient } from '@toggl/api'
 
-import { PapierkramTimeEntryOperationBuilder } from './papierkram-import-time-entry-operation-builder.service'
+import { ResultAsync } from 'typescript-functional-extensions'
 import { TimeFrame } from '../../../utils/time-frame'
+import { PapierkramTimeEntryOperationBuilder } from './papierkram-import-time-entry-operation-builder.service'
 
 @Controller('imports')
 export class PapierkramImportTimeEntryController {
@@ -21,26 +22,36 @@ export class PapierkramImportTimeEntryController {
 
   @Post('toggl')
   async import(@Body() timeFrame: TimeFrame) {
-    const [togglTimeEntries, papierkramTimeEntries] = await Promise.all([
-      this.togglReadClient.readTimeEntries(timeFrame),
-      this.papierkramReadClient.readTimeEntries(timeFrame)
-    ])
-
-    const importOperations = this.importOperationBuilder.buildWithToggl({
-      togglTimeEntries,
-      papierkramTimeEntries
+    return ResultAsync.combine({
+      papierkramTimeEntries:
+        this.papierkramReadClient.readTimeEntries(timeFrame),
+      togglTimeEntries: this.togglReadClient.readTimeEntries(timeFrame)
     })
-
-    for (const operation of importOperations) {
-      try {
-        await this.importer.execute(operation)
-      } catch (error) {
-        this.logger.error(error)
-      }
-    }
-
-    this.logger.log(
-      `${importOperations.length} time entries successfully imported`
-    )
+      .tap(() =>
+        this.logger.log(
+          `Import time entries from ${timeFrame.from} - ${timeFrame.to}`
+        )
+      )
+      .map(({ papierkramTimeEntries, togglTimeEntries }) =>
+        this.importOperationBuilder.buildWithToggl({
+          togglTimeEntries,
+          papierkramTimeEntries
+        })
+      )
+      .tap(async importOperations => {
+        for (const operation of importOperations) {
+          try {
+            await this.importer.execute(operation)
+          } catch (error) {
+            this.logger.error(error)
+          }
+        }
+      })
+      .tap(importOperations =>
+        this.logger.log(
+          `${importOperations.length} time entries successfully imported`
+        )
+      )
+      .toPromise()
   }
 }

apps/papierkram-devkit-api/src/app/toggl-api/toggl-read-client.service.ts

@@ -1,10 +1,12 @@
-import { Injectable, Logger } from '@nestjs/common'
 import { HttpService } from '@nestjs/axios'
+import { Injectable, Logger } from '@nestjs/common'
 
-import { TogglTimeEntry } from './types/toggl-time-entry'
-import { TogglApiConfig } from './toggl-api-config.service'
+import { AxiosResponse } from 'axios'
+import { ResultAsync } from 'typescript-functional-extensions'
 import { TimeFrame } from '../utils/time-frame'
 import { toDateOnly } from '../utils/to-date-only'
+import { TogglApiConfig } from './toggl-api-config.service'
+import { TogglTimeEntry } from './types/toggl-time-entry'
 
 @Injectable()
 export class TogglReadClient {
@@ -15,28 +17,34 @@ export class TogglReadClient {
     private readonly config: TogglApiConfig
   ) {}
 
-  async readTimeEntries(timeFrame: TimeFrame): Promise<TogglTimeEntry[]> {
+  readTimeEntries(timeFrame: TimeFrame): ResultAsync<TogglTimeEntry[]> {
+    return ResultAsync.from(this.getTimeEntries.apply(this, [timeFrame]))
+      .mapError(error =>
+        error instanceof Error
+          ? error.message
+          : '[Toggl API]: Could not read time entries.'
+      )
+      .map(response => response.data)
+      .tapFailure(reason => this.logger.error(reason))
+  }
+
+  private getTimeEntries(
+    timeFrame: TimeFrame
+  ): Promise<AxiosResponse<TogglTimeEntry[]>> {
     const { from, to } = toDateOnly(timeFrame)
 
-    try {
-      const response = await this.httpClient.axiosRef.get<TogglTimeEntry[]>(
-        `${this.config.apiUrl}/me/time_entries`,
-        {
-          params: {
-            start_date: from,
-            end_date: to
-          },
-          auth: {
-            username: this.config.username,
-            password: this.config.password
-          }
+    return this.httpClient.axiosRef.get<TogglTimeEntry[]>(
+      `${this.config.apiUrl}/me/time_entries`,
+      {
+        params: {
+          start_date: from,
+          end_date: to
+        },
+        auth: {
+          username: this.config.username,
+          password: this.config.password
         }
-      )
-
-      return response.data
-    } catch (error) {
-      this.logger.error(error)
-      return []
-    }
+      }
+    )
   }
 }

apps/papierkram-devkit-api/src/app/utils/to-date-only.ts

@@ -1,9 +1,9 @@
 import { TimeFrame } from './time-frame'
-import { formatDate } from 'date-fns'
+import { formatRFC3339 } from 'date-fns'
 
 export function toDateOnly(timeFrame: TimeFrame) {
   return {
-    from: formatDate(timeFrame.from, 'yyyy-MM-dd'),
-    to: formatDate(timeFrame.to, 'yyyy-MM-dd')
+    from: formatRFC3339(timeFrame.from),
+    to: formatRFC3339(timeFrame.to)
   }
 }

jest.config.ts

@@ -1,5 +1,5 @@
-import { getJestProjectsAsync } from '@nx/jest';
+import { getJestProjectsAsync } from '@nx/jest'
 
 export default async () => ({
   projects: await getJestProjectsAsync()
-});
+})

package.json

@@ -20,33 +20,34 @@
     "axios": "^1.8.2",
     "date-fns": "^4.1.0",
     "reflect-metadata": "^0.1.13",
-    "rxjs": "^7.8.0"
+    "rxjs": "^7.8.0",
+    "typescript-functional-extensions": "3.0.0-prerelease.27-1"
   },
   "devDependencies": {
     "@eslint/js": "^9.8.0",
     "@nestjs/schematics": "^10.0.1",
     "@nestjs/testing": "^10.0.2",
-    "@nx/eslint": "20.6.2",
-    "@nx/eslint-plugin": "20.6.2",
-    "@nx/jest": "20.6.2",
-    "@nx/js": "20.6.2",
-    "@nx/nest": "20.6.2",
-    "@nx/node": "20.6.2",
-    "@nx/web": "20.6.2",
-    "@nx/webpack": "20.6.2",
-    "@nx/workspace": "20.6.2",
+    "@nx/eslint": "20.7.2",
+    "@nx/eslint-plugin": "20.7.2",
+    "@nx/jest": "20.7.2",
+    "@nx/js": "20.7.2",
+    "@nx/nest": "20.7.2",
+    "@nx/node": "20.7.2",
+    "@nx/web": "20.7.2",
+    "@nx/webpack": "20.7.2",
+    "@nx/workspace": "20.7.2",
     "@swc-node/register": "~1.9.1",
     "@swc/core": "~1.5.29",
     "@swc/helpers": "~0.5.11",
     "@types/jest": "^29.5.12",
     "@types/node": "~18.16.9",
     "eslint": "^9.8.0",
-    "eslint-config-prettier": "^9.0.0",
+    "eslint-config-prettier": "10.1.1",
     "jest": "^29.7.0",
     "jest-environment-node": "^29.7.0",
     "jiti": "2.4.2",
     "jsdom": "~22.1.0",
-    "nx": "20.6.2",
+    "nx": "20.7.2",
     "prettier": "^2.6.2",
     "swc-loader": "^0.2.6",
     "ts-jest": "^29.1.0",