@tasenor/common-plugins 1.9.125 → 1.9.127

package/src/TickerData/backend/hel.json

@@ -0,0 +1,144 @@
+{
+  "ACG1V": "Aspocomp Group Oyj",
+  "AFAGR": "Afarak Group",
+  "AKTIA": "Aktia Bank Abp",
+  "ALBAV": "Ålandsbanken Abp A",
+  "ALBBV": "Ålandsbanken Abp B",
+  "ALISA": "Alisa Pankki Oyj",
+  "ALMA": "Alma Media Oyj",
+  "ANORA": "Anora Group Oyj",
+  "APETIT": "Apetit Oyj",
+  "ASPO": "Aspo Oyj",
+  "ATRAV": "Atria Oyj A",
+  "BIOBV": "Biohit Oyj B",
+  "BITTI": "Bittium Oyj",
+  "BOREO": "Boreo Oyj",
+  "CAPMAN": "CapMan Oyj",
+  "CAV1V": "Caverion Oyj",
+  "CGCBV": "Cargotec Oyj",
+  "CONSTI": "Consti Oyj",
+  "CTH1V": "Componenta Oyj",
+  "CTY1S": "Citycon Oyj",
+  "DIGIA": "Digia Oyj",
+  "DIGIGR": "Digitalist Group Oyj",
+  "DOV1V": "Dovre Group Oyj",
+  "EEZY": "Eezy Oyj",
+  "ELEAV": "Elecster Oyj A",
+  "ELISA": "Elisa Oyj",
+  "ENENTO": "Enento Group Oyj",
+  "EQV1V": "eQ Oyj",
+  "ESENSE": "Enersense International Oyj",
+  "ETTE": "Etteplan Oyj",
+  "EVLI": "Evli Oyj",
+  "EXL1V": "Exel Composites Oyj",
+  "FIA1S": "Finnair Oyj",
+  "FORTUM": "Fortum Oyj",
+  "FSECURE": "F-Secure Oyj",
+  "FSKRS": "Fiskars Oyj Abp",
+  "GLA1V": "Glaston Oyj Abp",
+  "GOFORE": "Gofore Oyj",
+  "HARVIA": "Harvia Oyj",
+  "HKSAV": "HKScan Oyj A",
+  "HONBS": "Honkarakenne Oyj B",
+  "HUH1V": "Huhtamäki Oyj",
+  "ICP1V": "Incap Oyj",
+  "IFA1V": "Innofactor Plc",
+  "ILKKA2": "Ilkka Oyj 2",
+  "INVEST": "Investors House Oyj",
+  "KAMUX": "Kamux Oyj",
+  "KCR": "Konecranes Oyj",
+  "KELAS": "Kesla Oyj A",
+  "KEMIRA": "Kemira Oyj",
+  "KESKOA": "Kesko Oyj A",
+  "KESKOB": "Kesko Oyj B",
+  "KHG": "KH Group Oyj",
+  "KNEBV": "KONE Oyj",
+  "KOJAMO": "Kojamo Oyj",
+  "KOSKI": "Koskisen Oyj",
+  "KREATE": "Kreate Group Oyj",
+  "KSLAV": "Keskisuomalainen Oyj A",
+  "LAMOR": "Lamor Corporation Oyj",
+  "LAT1V": "Lassila & Tikanoja Oyj",
+  "LEHTO": "Lehto Group Oyj",
+  "MANTA": "Mandatum",
+  "MARAS": "Martela Oyj A",
+  "MEKKO": "Marimekko Oyj",
+  "METSA": "Metsä Board Oyj A",
+  "METSB": "Metsä Board Oyj B",
+  "METSO": "Metso Oyj",
+  "MUSTI": "Musti Group Oyj",
+  "NDA_FI": "Nordea Bank Abp",
+  "NESTE": "Neste Oyj",
+  "NLG1V": "Nurminen Logistics Oyj",
+  "NOHO": "NoHo Partners Oyj",
+  "NOKIA": "Nokia Oyj",
+  "OKDAV": "Oriola Oyj A",
+  "OKDBV": "Oriola Oyj B",
+  "OLVAS": "Olvi Oyj A",
+  "OMASP": "Oma Säästöpankki Oyj",
+  "OPTOMED": "Optomed Oyj",
+  "ORNAV": "Orion Oyj A",
+  "ORNBV": "Orion Oyj B",
+  "ORTHEX": "Orthex Oyj",
+  "OUT1V": "Outokumpu Oyj",
+  "OVARO": "Ovaro Kiinteistösijoitus Oyj",
+  "PAMPALO": "Endomines Finland Oyj",
+  "PIHLIS": "Pihlajalinna Oyj",
+  "PNA1V": "Panostaja Oyj",
+  "PON1V": "Ponsse Oyj 1",
+  "PUMU": "PunaMusta Media Oyj",
+  "PURMO": "Purmo Group Oyj C",
+  "PUUILO": "Puuilo Oyj",
+  "QPR1V": "QPR Software Oyj",
+  "QTCOM": "Qt Group Oyj",
+  "RAIVV": "Raisio Oyj Vaihto-osake",
+  "RAP1V": "Rapala VMC Oyj",
+  "RAUTE": "Raute Oyj",
+  "REG1V": "Revenio Group Oyj",
+  "REKA": "Reka Industrial Oyj",
+  "RELAIS": "Relais Group Oyj",
+  "REMEDY": "Remedy Entertainment Oyj",
+  "ROBIT": "Robit Oyj",
+  "ROVIO": "Rovio Entertainment Oyj",
+  "SAGCV": "Saga Furs Oyj C",
+  "SAMPO": "Sampo Oyj A",
+  "SANOMA": "Sanoma Oyj",
+  "SCANFL": "Scanfil Oyj",
+  "SIILI": "Siili Solutions Oyj",
+  "SITOWS": "Sitowise Group Oyj",
+  "SOLTEQ": "Solteq Oyj",
+  "SOSI1": "Sotkamo Silver AB",
+  "SRV1V": "SRV Yhtiöt Oyj",
+  "SSABAH": "SSAB A",
+  "SSABBH": "SSAB B",
+  "SSH1V": "SSH Communications Security",
+  "STEAV": "Stora Enso Oyj A",
+  "STERV": "Stora Enso Oyj R",
+  "STOCKA": "Stockmann Oyj Abp",
+  "SUY1V": "Suominen Oyj",
+  "TAALA": "Taaleri Oyj",
+  "TALLINK": "AS Tallink Grupp FDR",
+  "TELIA1": "Telia Company",
+  "TEM1V": "Tecnotree Oyj",
+  "TIETO": "TietoEVRY Oyj",
+  "TLT1V": "Teleste Oyj",
+  "TNOM": "Talenom Oyj",
+  "TOKMAN": "Tokmanni Group Oyj",
+  "TRH1V": "Trainers´ House Oyj",
+  "TTALO": "Terveystalo Oyj",
+  "TULAV": "Tulikivi Oyj A",
+  "TYRES": "Nokian Renkaat Oyj",
+  "UNITED": "United Bankers Oyj",
+  "UPM": "UPM-Kymmene Oyj",
+  "UPONOR": "Uponor Oyj",
+  "VAIAS": "Vaisala Oyj A",
+  "VALMT": "Valmet Oyj",
+  "VALOE": "Valoe Oyj",
+  "VERK": "Verkkokauppa.com Oyj",
+  "VIK1V": "Viking Line Abp",
+  "WETTERI": "Wetteri Oyj",
+  "WITH": "WithSecure Oyj",
+  "WRT1V": "Wärtsilä Oyj Abp",
+  "WUF1V": "Wulff-Yhtiöt Oyj",
+  "YIT": "YIT Oyj"
+}

package/src/TickerData/backend/index.ts

@@ -0,0 +1,241 @@
+import { DataPlugin } from '@tasenor/common-node'
+import { ALL, PluginCode, Version, error } from '@tasenor/common'
+
+interface ExchangeInfo {
+  code: string
+  name: string
+  aliases: string[]
+  file: string
+  type: 'stock' | 'crypto' | 'currency'
+}
+
+interface TickerInfo {
+  exchange: Omit<Omit<ExchangeInfo, 'file'>, 'type'>
+  ticker: string
+  name: string
+  aliases: string[]
+}
+
+/**
+ * Data sets for stock tickers and crypto currencies.
+ *
+ * Backend Queries:
+ *
+ * * (*exchange*, ALL) - List of all known exhanges.
+ * * (*exchange*, *code*) - Exchange data if code, name or alias match, null otherwise.
+ * * (*ticker*, *type*:*code*) - Lookup from all exchanges the specific ticker of the given type.
+ * * (*ticker*, *type*:*exchange*:*code*) - Lookup from the given exchange the specific ticker.
+ *
+ * Data sources and/or ideas:
+ *
+ * * HEL - Manually constructed from public Nasdaq Helsinki data.
+ * * TAL - Manually constructed from public Nasdaq Helsinki data.
+ * * crypto - https://github.com/crypti/cryptocurrencies/blob/master/cryptocurrencies.json
+ *
+ *   ...others done manually so far (need some source and conversion tool)...
+ *
+ * Note: there is useful tool to generate from CSV in `tasenor-bookkeeper/apps/cli/bin/convert-csv-to-map.mjs`.
+ *
+ * Data file is simply a mapping from ticker to its name. If the ticker has aliases, it can be expressed
+ * as an array like
+ *   {
+ *     ...
+ *     "MAIN": ["Name of the main", "ALIAS1", "ALIAS2"]
+ *     ...
+ *   }
+ */
+class TickerData extends DataPlugin {
+
+  // TODO: Currency name data.
+
+  constructor() {
+    super({ common: [], backend: ['exchange', 'ticker'] })
+
+    this.code = 'TickerData'as PluginCode
+    this.title = 'Asset ticker names'
+    this.version = '1.0.0' as Version
+    this.icon = '<svg xmlns="http://www.w3.org/2000/svg" height="24px" viewBox="0 0 24 24" width="24px" fill="#000000"><path d="M0 0h24v24H0V0z" fill="none"/><path d="M16 7H5v10h11l3.55-5z" opacity=".3"/><path d="M17.63 5.84C17.27 5.33 16.67 5 16 5L5 5.01C3.9 5.01 3 5.9 3 7v10c0 1.1.9 1.99 2 1.99L16 19c.67 0 1.27-.33 1.63-.84L22 12l-4.37-6.16zM16 17H5V7h11l3.55 5L16 17z"/></svg>'
+    this.releaseDate = '2024-01-15'
+    this.use = 'backend'
+    this.type = 'data'
+    this.description = 'List of stock tickers and exchanges and their names. Lookup services for those.'
+
+    this.languages = {
+    }
+  }
+
+  async queryBackend<T>(dataSet: string, query: typeof ALL | string): Promise<undefined | T> {
+    if (dataSet === 'exchange') {
+      return this.queryExchange(query) as T
+    }
+    if (dataSet === 'ticker' && query !== ALL) {
+      return this.queryTicker(query) as T
+    }
+    return undefined
+  }
+
+  async queryExchange(query: typeof ALL | string): Promise<undefined | ExchangeInfo | ExchangeInfo[]> {
+    if (query === ALL) {
+      // This also priority order if there is no better knowledge for ticker exchange, when queried.
+      return [
+        {
+          code: 'ETF',
+          name: 'List of ETFs',
+          aliases: [],
+          file: 'etf.json',
+          type: 'stock'
+        },
+        {
+          code: 'NYSE',
+          name: 'New York Stock Exchange',
+          aliases: [],
+          file: 'nyse.json',
+          type: 'stock'
+        },
+        {
+          code: 'NASDAQ',
+          name: 'The Nasdaq Stock Market',
+          aliases: ['Nasdaq', 'National Association of Securities Dealers Automated Quotations'],
+          file: 'nasdaq.json',
+          type: 'stock'
+        },
+        {
+          code: 'XETRA',
+          name: 'Deutsche Börse',
+          aliases: [],
+          file: 'xetra.json',
+          type: 'stock'
+        },
+        {
+          code: 'HEL',
+          name: 'Nasdaq Helsinki',
+          aliases: ['HE'],
+          file: 'hel.json',
+          type: 'stock'
+        },
+        {
+          code: 'TAL',
+          name: 'Nasdaq Tallinn',
+          aliases: ['TL'],
+          file: 'tal.json',
+          type: 'stock'
+        },
+        {
+          code: 'OTC',
+          name: 'Over the Counter',
+          aliases: ['PINK', 'Pink Sheets'],
+          file: 'otc.json',
+          type: 'stock'
+        },
+        {
+          code: 'TSX',
+          name: 'Toronto Stock Exchange',
+          aliases: ['TO'],
+          file: 'tsx.json',
+          type: 'stock'
+        },
+        {
+          code: 'CRYPTO',
+          name: 'Crypto Currency',
+          aliases: [],
+          file: 'cryptocurrencies.json',
+          type: 'crypto'
+        },
+        {
+          code: 'CURRENCY',
+          name: 'Currency',
+          aliases: [],
+          file: 'currencies.json',
+          type: 'currency'
+        },
+      ]
+    }
+    const all = await this.queryExchange(ALL) as ExchangeInfo[]
+    for (const ex of all) {
+      if (ex.code === query || ex.name === query || ex.aliases.includes(query)) {
+        return ex
+      }
+    }
+    return undefined
+  }
+
+  /**
+   * Fill in aliases.
+   */
+  afterLoad<T>(fileName: string, data: Record<string, T>): Record<string, T> {
+    Object.keys(data).forEach(ticker => {
+      if (data[ticker] instanceof Array) {
+        for (const alias of (data[ticker] as Array<unknown>).splice(1)) {
+          if (data[`${alias}`] !== undefined) {
+            error(`${this.code}: Cannot re-use '${alias}' as an alias since it has already used as ${JSON.stringify(data[`${alias}`])}.`)
+          } else {
+            data[`${alias}`] = data[ticker][0]
+          }
+        }
+        data[ticker] = data[ticker][0]
+      }
+    })
+
+    return data
+  }
+
+  /**
+   * If the result is ambiquous, all results are returned.
+   */
+  async queryTicker(query: string): Promise<undefined | TickerInfo[]> {
+    if (query.indexOf(':') < 0) {
+      error(`${this.code}: Invalid query '${query}' for plugin '${this.code}'.`)
+      return undefined
+    }
+
+    const parts = query.split(':')
+    const type = parts[0]
+    const exchange = parts.length >= 3 ? parts[1] : null
+    const ticker = parts.length >= 3 ? parts[2] : parts[1]
+
+    // Single exchange.
+    if (exchange !== null) {
+      const ex = await this.queryExchange(exchange) as ExchangeInfo | undefined
+      if (ex === undefined) {
+        return undefined
+      }
+      if (ex.type !== type) {
+        error(`${this.code}: Invalid type '${type}' when queried from exchange '${exchange}'.`)
+        return undefined
+      }
+      const tickers: Record<string, string> = this.loadCached(ex.file)
+      if (tickers[ticker] === undefined) {
+        return undefined
+      }
+      return [{
+        exchange: { code: ex.code, name: ex.name, aliases: ex.aliases },
+        ticker,
+        name: tickers[ticker],
+        aliases: []
+      }]
+    }
+
+    // Scan all exchanges.
+    let result: TickerInfo[] = []
+    let typeFound = false
+    for (const ex of await this.queryExchange(ALL) as ExchangeInfo[]) {
+      if (ex.type === type) {
+        typeFound = true
+        const match = await this.queryTicker(`${type}:${ex.code}:${ticker}`)
+        if (match !== undefined) {
+          result = result.concat(match)
+        }
+      }
+    }
+    if (result.length) {
+      return result
+    }
+    if (!typeFound) {
+      error(`${this.code}: Cannot find any exchange to provide data for type '${type}'.`)
+    }
+
+    return undefined
+  }
+}
+
+export default TickerData