[OPDATA-3889] Ftse EA Parsing Utils

.changeset/ninety-lamps-help.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/ftse-sftp-adapter': minor
+---
+
+Added parser utils for FTSE EA

packages/scripts/src/generate-readme/readmeBlacklist.json

@@ -66,6 +66,7 @@
     "xsushi-price",
     "coinbase-prime",
     "harris-and-trotter",
-    "nav-consulting"
+    "nav-consulting",
+    "ftse-sftp"
   ]
 }

packages/sources/ftse-sftp/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@chainlink/ftse-sftp-adapter",
+  "version": "0.0.0",
+  "description": "Chainlink ftse-sftp adapter.",
+  "keywords": [
+    "Chainlink",
+    "LINK",
+    "blockchain",
+    "oracle",
+    "ftse-sftp"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "url": "https://github.com/smartcontractkit/external-adapters-js",
+    "type": "git"
+  },
+  "license": "MIT",
+  "scripts": {
+    "clean": "rm -rf dist && rm -f tsconfig.tsbuildinfo",
+    "prepack": "yarn build",
+    "build": "tsc -b",
+    "server": "node -e 'require(\"./index.js\").server()'",
+    "server:dist": "node -e 'require(\"./dist/index.js\").server()'",
+    "start": "yarn server:dist"
+  },
+  "dependencies": {
+    "@chainlink/external-adapter-framework": "2.7.0",
+    "csv-parse": "5.5.6",
+    "decimal.js": "^10.5.0",
+    "tslib": "^2.3.1"
+  },
+  "devDependencies": {
+    "@sinonjs/fake-timers": "^14.0.0",
+    "@types/jest": "^29.5.14",
+    "@types/node": "22.14.1",
+    "jest": "^29.7.0",
+    "jest-util": "^29.7.0",
+    "nock": "13.5.6",
+    "ts-jest": "^29.2.5",
+    "typescript": "5.8.3"
+  }
+}

packages/sources/ftse-sftp/src/parsing/base-parser.ts

@@ -0,0 +1,56 @@
+import { Options, parse } from 'csv-parse/sync'
+import { CSVParser, ParsedData } from './interfaces'
+
+/**
+ * Abstract base class for CSV parsers
+ * Uses the csv-parse library for robust CSV parsing
+ */
+export abstract class BaseCSVParser<T extends ParsedData = ParsedData> implements CSVParser<T> {
+  protected config: Options
+
+  constructor(config: Options = {}) {
+    this.config = { ...config }
+  }
+
+  /**
+   * Abstract method that must be implemented by concrete classes
+   */
+  abstract parse(csvContent: string): Promise<T>
+
+  /**
+   * Helper method to parse CSV content as records with column headers
+   */
+  protected parseCSVRecords(csvContent: string, options?: Options): Record<string, string>[] {
+    const finalConfig: Options = { ...this.config, ...options, columns: true }
+
+    try {
+      return parse(csvContent, finalConfig)
+    } catch (error) {
+      throw new Error(`Error parsing CSV as records: ${error}`)
+    }
+  }
+
+  /**
+   * Helper method to parse CSV content as arrays
+   */
+  protected parseCSVArrays(csvContent: string, options?: Options): string[][] {
+    const finalConfig: Options = { ...this.config, ...options, columns: false }
+
+    try {
+      return parse(csvContent, finalConfig)
+    } catch (error) {
+      throw new Error(`Error parsing CSV as arrays: ${error}`)
+    }
+  }
+
+  /**
+   * Convert a string value to a number and invalid values
+   */
+  protected convertToNumber(value: string): number {
+    if (!value || value.trim() === '') {
+      return 0
+    }
+    const numValue = parseFloat(value)
+    return isNaN(numValue) ? 0 : numValue
+  }
+}

packages/sources/ftse-sftp/src/parsing/factory.ts

@@ -0,0 +1,33 @@
+import { CSVParser } from './interfaces'
+import { FTSE100Parser } from './ftse100'
+import { RussellDailyValuesParser } from './russell'
+
+/**
+ * Supported CSV parser types
+ */
+export const instrumentToElementMap = {
+  Russell1000INDEX: 'Russell 1000® Index',
+  Russell2000INDEX: 'Russell 2000® Index',
+  Russell3000INDEX: 'Russell 3000® Index',
+}
+
+/**
+ * Factory class for creating CSV parsers
+ */
+export class CSVParserFactory {
+  /**
+   * Auto-detect parser type based on instrument
+   */
+  static detectParserByInstrument(instrument: string): CSVParser | null {
+    switch (instrument) {
+      case 'FTSE100INDEX':
+        return new FTSE100Parser()
+      case 'Russell1000INDEX':
+      case 'Russell2000INDEX':
+      case 'Russell3000INDEX':
+        return new RussellDailyValuesParser(instrumentToElementMap[instrument])
+      default:
+        return null
+    }
+  }
+}