@fullstackcraftllc/floe 0.0.5 → 0.0.6

package/README.md

@@ -4,7 +4,7 @@
 
 Zero-dependency TypeScript functions for options flow: Black-Scholes, Greeks, and dealer exposures, and more, with a clean, type-safe API. Built for use in trading platforms and fintech applications.
 
-The same library that is used in Full Stack Craft's various fintech products including [The Wheel Screener](https://wheelscreener.com), [LEAPS Screener](https://leapsscreener.com), [Option Screener](https://option-screener.com), [AMT JOY](https://amtjoy.com), and [VannaCharm](https://vannacharm.com).
+The same library that is used in [Full Stack Craft's](https://fullstackcraft.com) various fintech products including [The Wheel Screener](https://wheelscreener.com), [LEAPS Screener](https://leapsscreener.com), [Option Screener](https://option-screener.com), [AMT JOY](https://amtjoy.com), and [VannaCharm](https://vannacharm.com).
 
 ## Quick Start / Documentation / Examples
 
@@ -23,12 +23,15 @@ The same library that is used in Full Stack Craft's various fintech products inc
 
 ## Features
 
-- 🎯 **Black-Scholes Pricing** - Fast, accurate options pricing
-- 📊 **Greeks Calculations** - Delta, gamma, theta, vega, rho
-- 🔄 **Dealer Exposure Metrics** - GEX, VEX, and CEX exposures
-- 🔌 **Broker-Agnostic** - Normalize data from any broker
-- 💪 **Type-Safe** - Full TypeScript support
-- ⚡ **Zero Dependencies** - Lightweight and fast
+- **Black-Scholes Pricing** - Fast, accurate options pricing
+- **Greeks Calculations** - Delta, gamma, theta, vega, rho
+- **Dealer Exposure Metrics** - GEX, VEX, and CEX exposures
+- **Implied Volatility & Surfaces** - Calculate IV from market prices and build volatility surfaces
+- **Implied PDF** - Risk-neutral probability density functions
+- **Real-Time Data** - Stream normalized options data from multiple brokers
+- **Broker-Agnostic** - Normalize data from any broker
+- **Type-Safe** - Full TypeScript support
+- **Zero Dependencies** - Lightweight and fast
 
 ## Broker Support Roadmap
 

package/dist/client/FloeClient.d.ts

@@ -119,7 +119,7 @@ export declare class FloeClient {
      * Establishes a connection to a broker's API.
      *
      * @param broker - The broker to connect to (e.g., Broker.TRADIER)
-     * @param authKey - The API authentication key or token for the broker
+     * @param authToken - The API authentication token for the broker
      *
      * @throws {Error} Throws if the specified broker is not supported
      *
@@ -132,7 +132,7 @@ export declare class FloeClient {
      * await client.connect(Broker.TRADIER, 'your-tradier-api-key');
      * ```
      */
-    connect(broker: Broker, authKey: string): Promise<void>;
+    connect(broker: Broker, authToken: string): Promise<void>;
     /**
      * Disconnects from the current broker.
      *

package/dist/client/FloeClient.js

@@ -104,7 +104,7 @@ class FloeClient {
      * Establishes a connection to a broker's API.
      *
      * @param broker - The broker to connect to (e.g., Broker.TRADIER)
-     * @param authKey - The API authentication key or token for the broker
+     * @param authToken - The API authentication token for the broker
      *
      * @throws {Error} Throws if the specified broker is not supported
      *
@@ -117,12 +117,12 @@ class FloeClient {
      * await client.connect(Broker.TRADIER, 'your-tradier-api-key');
      * ```
      */
-    async connect(broker, authKey) {
+    async connect(broker, authToken) {
         this.currentBroker = broker;
-        // Connection logic to the broker's API using the authKey
+        // Connection logic to the broker's API using the authToken
         switch (broker.toLowerCase()) {
             case Broker.TRADIER:
-                this.tradierClient = new TradierClient_1.TradierClient(authKey, { verbose: this.verbose });
+                this.tradierClient = new TradierClient_1.TradierClient(authToken, { verbose: this.verbose });
                 // Wire up TradierClient events to FloeClient events
                 this.tradierClient.on('tickerUpdate', (ticker) => {
                     this.emit('tickerUpdate', ticker);
@@ -140,9 +140,9 @@ class FloeClient {
                 await this.tradierClient.connect();
                 break;
             case Broker.TASTYTRADE:
-                // For TastyTrade, authKey is the session token
+                // For TastyTrade, authToken is the session token
                 this.tastyTradeClient = new TastyTradeClient_1.TastyTradeClient({
-                    sessionToken: authKey,
+                    sessionToken: authToken,
                     verbose: this.verbose,
                 });
                 // Wire up TastyTradeClient events to FloeClient events
@@ -162,9 +162,9 @@ class FloeClient {
                 await this.tastyTradeClient.connect();
                 break;
             case Broker.TRADESTATION:
-                // For TradeStation, authKey is the OAuth access token
+                // For TradeStation, authToken is the OAuth access token
                 this.tradeStationClient = new TradeStationClient_1.TradeStationClient({
-                    accessToken: authKey,
+                    accessToken: authToken,
                     verbose: this.verbose,
                 });
                 // Wire up TradeStationClient events to FloeClient events
@@ -184,9 +184,9 @@ class FloeClient {
                 await this.tradeStationClient.connect();
                 break;
             case Broker.SCHWAB:
-                // For Schwab, authKey is the OAuth access token
+                // For Schwab, authToken is the OAuth access token
                 this.schwabClient = new SchwabClient_1.SchwabClient({
-                    accessToken: authKey,
+                    accessToken: authToken,
                     verbose: this.verbose,
                 });
                 // Wire up SchwabClient events to FloeClient events

package/dist/client/brokers/TradierClient.d.ts

@@ -107,7 +107,7 @@ type TradierEventListener<T> = (data: T) => void;
  */
 export declare class TradierClient {
     /** Tradier API authentication token */
-    private authKey;
+    private authToken;
     /** Current streaming session */
     private streamSession;
     /** WebSocket connection */
@@ -152,11 +152,11 @@ export declare class TradierClient {
     /**
      * Creates a new TradierClient instance.
      *
-     * @param authKey - Tradier API access token
+     * @param authToken - Tradier API auth token
      * @param options - Optional configuration options
      * @param options.verbose - Whether to log verbose debug information (default: false)
      */
-    constructor(authKey: string, options?: {
+    constructor(authToken: string, options?: {
         verbose?: boolean;
     });
     /**

package/dist/client/brokers/TradierClient.js

@@ -33,11 +33,11 @@ class TradierClient {
     /**
      * Creates a new TradierClient instance.
      *
-     * @param authKey - Tradier API access token
+     * @param authToken - Tradier API auth token
      * @param options - Optional configuration options
      * @param options.verbose - Whether to log verbose debug information (default: false)
      */
-    constructor(authKey, options) {
+    constructor(authToken, options) {
         /** Current streaming session */
         this.streamSession = null;
         /** WebSocket connection */
@@ -77,7 +77,7 @@ class TradierClient {
         this.apiBaseUrl = 'https://api.tradier.com/v1';
         /** Tradier WebSocket URL */
         this.wsUrl = 'wss://ws.tradier.com/v1/markets/events';
-        this.authKey = authKey;
+        this.authToken = authToken;
         this.verbose = options?.verbose ?? false;
         // Initialize event listener maps
         this.eventListeners.set('tickerUpdate', new Set());
@@ -176,7 +176,7 @@ class TradierClient {
             const response = await fetch(url, {
                 method: 'GET',
                 headers: {
-                    'Authorization': `Bearer ${this.authKey}`,
+                    'Authorization': `Bearer ${this.authToken}`,
                     'Accept': 'application/json',
                 },
             });
@@ -354,7 +354,7 @@ class TradierClient {
             const response = await fetch(`${this.apiBaseUrl}/markets/events/session`, {
                 method: 'POST',
                 headers: {
-                    'Authorization': `Bearer ${this.authKey}`,
+                    'Authorization': `Bearer ${this.authToken}`,
                     'Accept': 'application/json',
                 },
             });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fullstackcraftllc/floe",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Production-ready options analytics toolkit. Normalize broker data structures and calculate Black-Scholes, Greeks, and exposures with a clean, type-safe API. Built for trading platforms and fintech applications.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",