@sebspark/tradeinsight 0.5.0 → 1.0.0

package/README.md

@@ -1,3 +1,25 @@
 # `@sebspark/tradeinsight`
 
-Trade Insight client library with helpers for instrument IDs.
+TradeInsight client library with helpers for creating/parsing instrument IDs and consuming ticker feeds.
+
+## Instrument IDs
+
+### Create ID
+
+```javascript
+const isin = 'SE0000108656'
+const mic = 'XSTO'
+const currency = 'SEK'
+const id = createStockId({ isin, mic, currency })
+
+console.log(id)
+// STOCK-SE0000108656;XSTO;SEK
+```
+
+### Parse ID
+
+```javascript
+const { type, fromCurrency, toCurrency } = parseId('FOREX-USD;EUR')
+console.log(type, fromCurrency, toCurrency)
+// FOREX, USD, EUR
+```

package/dist/index.d.mts

@@ -25,9 +25,20 @@ declare const createStockId: ({ isin, mic, currency, }: {
     currency: string;
     mic: string;
 }) => string;
-declare const createForexId: ({ fromCurrency, toCurrency, }: {
-    toCurrency: string;
-    fromCurrency: string;
+/**
+ * Create an ID for a FOREX instrument, i.e. a currency relationship.
+ * The structure matches a currency pair:
+ *
+ * Base currency / quote currency = Exchange rate
+ *
+ * @see https://en.wikipedia.org/wiki/Currency_pair
+ * @example
+ * EUR/USD = 1.45
+ * This means a person would need 1.45 US dollars to purchase one Euro.
+ */
+declare const createForexId: ({ quoteCurrency, baseCurrency, }: {
+    baseCurrency: string;
+    quoteCurrency: string;
 }) => string;
 
 declare const parseId: (id: string) => {

package/dist/index.d.ts

@@ -25,9 +25,20 @@ declare const createStockId: ({ isin, mic, currency, }: {
     currency: string;
     mic: string;
 }) => string;
-declare const createForexId: ({ fromCurrency, toCurrency, }: {
-    toCurrency: string;
-    fromCurrency: string;
+/**
+ * Create an ID for a FOREX instrument, i.e. a currency relationship.
+ * The structure matches a currency pair:
+ *
+ * Base currency / quote currency = Exchange rate
+ *
+ * @see https://en.wikipedia.org/wiki/Currency_pair
+ * @example
+ * EUR/USD = 1.45
+ * This means a person would need 1.45 US dollars to purchase one Euro.
+ */
+declare const createForexId: ({ quoteCurrency, baseCurrency, }: {
+    baseCurrency: string;
+    quoteCurrency: string;
 }) => string;
 
 declare const parseId: (id: string) => {

package/dist/index.js

@@ -121,9 +121,9 @@ var createStockId = ({
   currency
 }) => `STOCK-${isin};${mic};${currency}`.toUpperCase();
 var createForexId = ({
-  fromCurrency,
-  toCurrency
-}) => `FOREX-${toCurrency};${fromCurrency}`.toUpperCase();
+  quoteCurrency,
+  baseCurrency
+}) => `FOREX-${baseCurrency};${quoteCurrency}`.toUpperCase();
 
 // src/instruments/parseId.ts
 var parseId = (id) => {

package/dist/index.mjs

@@ -91,9 +91,9 @@ var createStockId = ({
   currency
 }) => `STOCK-${isin};${mic};${currency}`.toUpperCase();
 var createForexId = ({
-  fromCurrency,
-  toCurrency
-}) => `FOREX-${toCurrency};${fromCurrency}`.toUpperCase();
+  quoteCurrency,
+  baseCurrency
+}) => `FOREX-${baseCurrency};${quoteCurrency}`.toUpperCase();
 
 // src/instruments/parseId.ts
 var parseId = (id) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sebspark/tradeinsight",
-  "version": "0.5.0",
+  "version": "1.0.0",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "module": "dist/index.mjs",