@engineering-tf/shared 1.0.0

package/dist/types/shared.d.ts

@@ -0,0 +1,376 @@
+/**
+ * table filters shared for Smart Flow and Full Flow
+ */
+type ColumnsState = {
+    show?: boolean;
+    fixed?: 'right' | 'left' | undefined;
+    order?: number;
+    disable?: boolean | {
+        checkbox: boolean;
+    };
+};
+/**
+ * the reason why [string] for expiration_date for example
+ * is that in the column filter only accept array: filteredValue: tableFilters.expiration_date || null,
+ *
+ */
+export interface TableFiltersProps {
+    /** DAYS UNTIL EXPIRY */
+    [TABLEFILTER_KEY.EXPIRY_DAYS]: [string] | null;
+    /** TICKER */
+    [TABLEFILTER_KEY.SYMBOL]: string | null;
+    /** UNDERLYING */
+    [TABLEFILTER_KEY.UNDERLYING_TYPE]: [UNDERLYING_TYPE_TAG] | null;
+    /** CALL/PUT */
+    [TABLEFILTER_KEY.PUT_CALL]: [CALL_PUT_TAG] | null;
+    /** STRIKE */
+    [TABLEFILTER_KEY.STRIKE]: [string] | null;
+    /** PRICE */
+    [TABLEFILTER_KEY.PRICE]: [string] | null;
+    /** SIZE */
+    [TABLEFILTER_KEY.SIZE]: [string] | null;
+    /** REF */
+    [TABLEFILTER_KEY.UNDERLYING_PRICE]: [string] | null;
+    /** SCORE */
+    [TABLEFILTER_KEY.SCORE]: [string] | null;
+    /** PREM */
+    [TABLEFILTER_KEY.PREMIUM]: [string] | null;
+    /** VOL */
+    [TABLEFILTER_KEY.DAILY_VOLUME]: [string] | null;
+    /** OI */
+    [TABLEFILTER_KEY.OI]: [string] | null;
+    /** TRADE */
+    [TABLEFILTER_KEY.OPTION_ACTIVITY_TYPE]: [OPTION_ACTIVITY_TYPE] | null;
+    /** MONEYNESS */
+    [TABLEFILTER_KEY.MONEYNESS]: [MONEYNESS_LABEL] | null;
+    /** SIDE */
+    [TABLEFILTER_KEY.SIDE]: [SIDE_LABEL] | null;
+    /** SIDE */
+    [TABLEFILTER_KEY.SENTIMENT]: [SENTIMENT_TAG] | null;
+    /** OPENING */
+    [TABLEFILTER_KEY.IS_OPENING_ONLY]: [boolean] | null;
+    /** DATE FILTER */
+    [TABLEFILTER_KEY.DATE_FILTER]: {
+        start_date: string;
+        end_date: string;
+        max_trading_date: string;
+    };
+    /** ['09:30:00','15:00:00']*/
+    [TABLEFILTER_KEY.TIME_FILTER]: [string, string];
+    sorter?: {
+        columnKey?: any;
+        order?: any;
+    };
+    pagination: {
+        current: number;
+        pageSize: number;
+    };
+    /** LABEL */
+    [TABLEFILTER_KEY.STRATEGY_LABEL]: [STRATEGY_LABEL] | null;
+    /** DELTA */
+    [TABLEFILTER_KEY.DELTA]: [string] | null;
+    /** IV */
+    [TABLEFILTER_KEY.IV]: [string] | null;
+    /**DEI**/
+    [TABLEFILTER_KEY.DEI]: [string] | null;
+    /**DEX**/
+    [TABLEFILTER_KEY.DEX]: [string] | null;
+    /** UPCOMING EARNING */
+    [TABLEFILTER_KEY.IS_RECENT_EARNING_ONLY]: [boolean] | null;
+    /**
+     * determine whether smart mode is historical mode, it is supposed to be in the config object
+     * but since we need to pass this info into model inside one param, we have to embed it into tableFilters
+     */
+    columnsStateMap: Record<string, ColumnsState> | null;
+    watchlistOnly: boolean;
+    watchlist?: string[];
+    default: boolean;
+    version: string;
+    id: string;
+    itemOptionChainInfo?: any;
+    market_data?: any;
+    greek_algo_data?: any;
+    option_algo_data?: any;
+    symbol_meta_data?: any;
+}
+export declare enum TABLEFILTER_KEY {
+    DATE = "date",
+    TIME = "time",
+    PREMIUM = "premium",
+    MONEYNESS = "moneyness",
+    OI = "oi",
+    DELTA = "delta",
+    IV = "iv",
+    EXPIRY_DAYS = "expiry_days",
+    EXPIRATION_DATE = "expiration_date",
+    SYMBOL = "symbol",
+    UNDERLYING_TYPE = "underlying_type",
+    PUT_CALL = "put_call",
+    STRIKE = "strike",
+    PRICE = "price",
+    SIZE = "size",
+    UNDERLYING_PRICE = "underlying_price",
+    SCORE = "score",
+    SENTIMENT = "sentiment",
+    IS_OPENING_ONLY = "is_opening_only",
+    DATE_FILTER = "date_filter",
+    TIME_FILTER = "time_filter",
+    STRATEGY_LABEL = "strategy_label",
+    IS_RECENT_EARNING_ONLY = "is_recent_earning_only",
+    COLUMNS_STATE_MAP = "columnsStateMap",
+    WATCHLIST_ONLY = "watchlistOnly",
+    DEFAULT = "default",
+    VERSION = "version",
+    ID = "id",
+    DAILY_VOLUME = "daily_volume",
+    OPTION_ACTIVITY_TYPE = "option_activity_type",
+    SIDE = "side",
+    DEI = "dei",
+    DEX = "dex",
+    EARNING_DATE = "earning_date",
+    TRADE_COUNT = "trade_count",
+    SYMBOLS = "symbols"
+}
+/**
+ * smart mode fetch request props
+ */
+/**
+ * full mode fetch request props
+ */
+/**
+ * @deprecated
+ * Base type used in both SmartOptionFlow and FullOptionFlow
+ * FF: Full Flow, SM: Smart Flow
+ */
+export interface OptionFlowItem {
+    /** SHARED BETWEEN SMART FLOW and FULL FLOW */
+    id: string;
+    size: number;
+    /** PRICE */
+    price: number;
+    /** PREM */
+    cost_basis: number;
+    bid: number;
+    ask: number;
+    date: string;
+    time: string;
+    /** TICKER */
+    ticker: string;
+    /** CALL/PUT */
+    put_call: CALL_PUT_TAG;
+    /** STRIKE */
+    strike_price: number;
+    /** EXPIRY DATE */
+    date_expiration: string;
+    /** UNDERLYING */
+    underlying_type: UNDERLYING_TYPE_TAG;
+    /** TRADE */
+    option_activity_type: OPTION_ACTIVITY_TYPE;
+    /** OI */
+    open_interest: number;
+    /** DAILY VOLUME */
+    volume: number;
+    /** REF */
+    ref: number;
+    sentiment: SENTIMENT_TAG;
+    earning: string;
+    midpoint: number;
+    option_symbol: string;
+    trade_count: number;
+    updated: number;
+    /***********************BELOW IS EXTENDED FIELDS******************************/
+    /** the amount of days to expiration */
+    expiry_days: number;
+    /** side is calculated based on aggressor_ind*/
+    side: SIDE_LABEL;
+    /** moneyness is calculated based on strike price and ref*/
+    moneyness: MONEYNESS_LABEL;
+    /** calculate the score */
+    ttl: number;
+    /** calculate the score */
+    score: number;
+    /** @deprecated labelling strategy */
+    strategy_label: STRATEGY_LABEL[];
+    /** delta hedging in shares, aka, DEX, always positive */
+    deltaExposure: number;
+    /** deltaExposure/daily average stock volume, aka, DEI, eg: 2.3, which represents that the 2.3%, always positive */
+    deltaImpact: number;
+    /** IV*/
+    iv: number;
+    /***********************BELOW IS Option Chain Information******************************/
+    delta: number;
+    theta: number;
+    gamma: number;
+    vega: number;
+    itemOptionChainInfo?: ItemOptionChainInfo;
+}
+/**
+ * if expired is false, delta/oi/price could be null
+ */
+export interface ItemOptionChainInfo {
+    delta?: number;
+    openInterest?: number;
+    price?: number;
+    iv?: number;
+    expired: boolean;
+}
+/**
+ * @description indicates the props for the request to the full api
+ * @usage api-service, process-service
+ */
+/**
+ * @description Trade Code
+ * https://unusualwhales.com/glossary/trade-code
+ */
+export declare enum OPTION_ACTIVITY_TYPE {
+    /**
+     * Aggregated trades are trades that are grouped together by our server if the trade time is exactly the same for the same contract
+     */
+    AGGREGATED = "AGGREGATED",
+    SWEEP = "SWEEP",
+    BLOCK = "BLOCK",
+    TRADE = "TRADE",
+    /** Introduced from MC API */
+    MULTILEG = "MULTILEG",
+    COMBO = "COMBO",
+    /**
+     * Transaction represents the option portion of an order involving a single option leg (buy or sell of a call or put) and stock.
+     * Prefix appears solely for information: process as a regular transaction.
+     */
+    BUYWRITE = "BUYWRITE",
+    /**
+      * Transaction represents the buying of a call and the selling of a put for the same underlying stock or index.
+     */
+    STRADDLE = "STRADDLE",
+    SPREAD = "SPREAD",
+    /**
+     * Transaction was the execution of an order identified as an Intermarket Sweep Order. Process like normal transaction.
+     */
+    IntermarketSweep = "IntermarketSweep"
+}
+/**
+ * SIDE
+ */
+export declare enum SIDE_LABEL {
+    ABOVE_ASK = "AASK",
+    ASK = "ASK",
+    MID = "MID",
+    BID = "BID",
+    BELOW_BID = "BBID"
+}
+/**
+ * MONEYNESS
+ */
+export declare enum MONEYNESS_LABEL {
+    ITM = "ITM",
+    ATM = "ATM",
+    OTM = "OTM"
+}
+/**
+ * for strategy
+ */
+export declare enum SENTIMENT_TAG {
+    BULLISH = "BULLISH",
+    BEARISH = "BEARISH",
+    NEUTRAL = "NEUTRAL"
+}
+export declare enum CALL_PUT_TAG {
+    CALL = "CALL",
+    PUT = "PUT"
+}
+export declare enum UNDERLYING_TYPE_TAG {
+    STOCK = "STOCK",
+    ETF = "ETF",
+    ETN = "ETN",
+    MLB = "MLB",
+    REIT = "REIT",
+    INDEX = "INDEX"
+}
+export interface FormattedResponse {
+    status: STATUS;
+    errorMsg?: string;
+    errorCode?: string;
+    data?: any;
+}
+export declare enum STATUS {
+    SUCCESS = "SUCCESS",
+    ERROR = "ERROR"
+}
+export declare const FORMATTED_ERROR: {
+    AUTHENTICATED_FAILURE: {
+        CODE: string;
+        MESSAGE: string;
+    };
+    SESSION_EXPIRED: {
+        CODE: string;
+        MESSAGE: string;
+    };
+    SUBSCRIPTION_EXPIRED: {
+        CODE: string;
+    };
+    UNKNOWN_ERROR: {
+        CODE: string;
+        MESSAGE: string;
+    };
+};
+export declare enum STRIPE_SUBSCRIPTION_STATUS {
+    ACTIVE = "active",
+    PAST_DUE = "past_due",
+    CANCELED = "canceled",
+    TRIALING = "trialing",
+    PAUSED = "paused",
+    INCOMPLETE = "incomplete",
+    INCOMPLETE_EXPIRED = "incomplete_expired"
+}
+export declare enum CHECKOUT_TYPE {
+    REGISTRATION = "registration",
+    RESUBSCRIPTION = "resubscription"
+}
+export declare enum HTTP_ERROR_CODE {
+    OK = 200,
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    FORBIDDEN = 403,
+    INTERNAL_SERVER_ERROR = 500
+}
+/**
+ * @deprecated
+ */
+/**
+ * @deprecated
+ * for strategy
+ */
+export declare enum STRATEGY_LABEL {
+    NONE = 0,
+    NOVA = 1,
+    SWING = 2,
+    DT = "DT",
+    ACT = "ACT",
+    Δ = "\u0394",
+    Δ_plus = "\u0394+",
+    Γ = "\u0393",
+    Θ = "\u0398",
+    V = "V",
+    CLR = "CLR",
+    SELL = "SELL",
+    HV = "HV",
+    LV = "LV",
+    INSTITUTE_SELL_CALL = "INSTITUTE_SELL_CALL",
+    INSTITUTE_BUY_PUT = "INSTITUTE_BUY_PUT",
+    EXTEND = "EXTEND",
+    FULL = "FULL",
+    SMART = "SMART"
+}
+export {};
+/**
+ * used in OptionData
+ */
+/**
+ * @usage cron-service process-service
+ * https://documentation.tradier.com/brokerage-api/markets/get-options-chains
+ * used in
+ */
+/**
+ * used to record the daily meta data of a symbol
+ * @usage process-service websocket-service
+ */

package/dist/types/shared.js

@@ -0,0 +1,218 @@
+"use strict";
+/**
+ * table filters shared for Smart Flow and Full Flow
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STRATEGY_LABEL = exports.HTTP_ERROR_CODE = exports.CHECKOUT_TYPE = exports.STRIPE_SUBSCRIPTION_STATUS = exports.FORMATTED_ERROR = exports.STATUS = exports.UNDERLYING_TYPE_TAG = exports.CALL_PUT_TAG = exports.SENTIMENT_TAG = exports.MONEYNESS_LABEL = exports.SIDE_LABEL = exports.OPTION_ACTIVITY_TYPE = exports.TABLEFILTER_KEY = void 0;
+var TABLEFILTER_KEY;
+(function (TABLEFILTER_KEY) {
+    TABLEFILTER_KEY["DATE"] = "date";
+    TABLEFILTER_KEY["TIME"] = "time";
+    TABLEFILTER_KEY["PREMIUM"] = "premium";
+    TABLEFILTER_KEY["MONEYNESS"] = "moneyness";
+    TABLEFILTER_KEY["OI"] = "oi";
+    TABLEFILTER_KEY["DELTA"] = "delta";
+    TABLEFILTER_KEY["IV"] = "iv";
+    TABLEFILTER_KEY["EXPIRY_DAYS"] = "expiry_days";
+    TABLEFILTER_KEY["EXPIRATION_DATE"] = "expiration_date";
+    TABLEFILTER_KEY["SYMBOL"] = "symbol";
+    TABLEFILTER_KEY["UNDERLYING_TYPE"] = "underlying_type";
+    TABLEFILTER_KEY["PUT_CALL"] = "put_call";
+    TABLEFILTER_KEY["STRIKE"] = "strike";
+    TABLEFILTER_KEY["PRICE"] = "price";
+    TABLEFILTER_KEY["SIZE"] = "size";
+    TABLEFILTER_KEY["UNDERLYING_PRICE"] = "underlying_price";
+    TABLEFILTER_KEY["SCORE"] = "score";
+    TABLEFILTER_KEY["SENTIMENT"] = "sentiment";
+    TABLEFILTER_KEY["IS_OPENING_ONLY"] = "is_opening_only";
+    TABLEFILTER_KEY["DATE_FILTER"] = "date_filter";
+    TABLEFILTER_KEY["TIME_FILTER"] = "time_filter";
+    TABLEFILTER_KEY["STRATEGY_LABEL"] = "strategy_label";
+    TABLEFILTER_KEY["IS_RECENT_EARNING_ONLY"] = "is_recent_earning_only";
+    TABLEFILTER_KEY["COLUMNS_STATE_MAP"] = "columnsStateMap";
+    TABLEFILTER_KEY["WATCHLIST_ONLY"] = "watchlistOnly";
+    TABLEFILTER_KEY["DEFAULT"] = "default";
+    TABLEFILTER_KEY["VERSION"] = "version";
+    TABLEFILTER_KEY["ID"] = "id";
+    TABLEFILTER_KEY["DAILY_VOLUME"] = "daily_volume";
+    TABLEFILTER_KEY["OPTION_ACTIVITY_TYPE"] = "option_activity_type";
+    TABLEFILTER_KEY["SIDE"] = "side";
+    TABLEFILTER_KEY["DEI"] = "dei";
+    TABLEFILTER_KEY["DEX"] = "dex";
+    TABLEFILTER_KEY["EARNING_DATE"] = "earning_date";
+    // fore cf-worker concept
+    TABLEFILTER_KEY["TRADE_COUNT"] = "trade_count";
+    TABLEFILTER_KEY["SYMBOLS"] = "symbols";
+})(TABLEFILTER_KEY = exports.TABLEFILTER_KEY || (exports.TABLEFILTER_KEY = {}));
+/**
+ * @description indicates the props for the request to the full api
+ * @usage api-service, process-service
+ */
+/**
+ * @description Trade Code
+ * https://unusualwhales.com/glossary/trade-code
+ */
+var OPTION_ACTIVITY_TYPE;
+(function (OPTION_ACTIVITY_TYPE) {
+    /**
+     * Aggregated trades are trades that are grouped together by our server if the trade time is exactly the same for the same contract
+     */
+    OPTION_ACTIVITY_TYPE["AGGREGATED"] = "AGGREGATED";
+    OPTION_ACTIVITY_TYPE["SWEEP"] = "SWEEP";
+    OPTION_ACTIVITY_TYPE["BLOCK"] = "BLOCK";
+    OPTION_ACTIVITY_TYPE["TRADE"] = "TRADE";
+    /** Introduced from MC API */
+    OPTION_ACTIVITY_TYPE["MULTILEG"] = "MULTILEG";
+    /*Transaction represents the buying of a call and the selling of a put for the same underlying stock or index.
+      Prefix appears solely for information; process as a regular transaction.
+    */
+    OPTION_ACTIVITY_TYPE["COMBO"] = "COMBO";
+    /**
+     * Transaction represents the option portion of an order involving a single option leg (buy or sell of a call or put) and stock.
+     * Prefix appears solely for information: process as a regular transaction.
+     */
+    OPTION_ACTIVITY_TYPE["BUYWRITE"] = "BUYWRITE";
+    /**
+      * Transaction represents the buying of a call and the selling of a put for the same underlying stock or index.
+     */
+    OPTION_ACTIVITY_TYPE["STRADDLE"] = "STRADDLE";
+    /*
+      *Transaction represents a trade in two options in the same class (a buy and a sell in the same class).
+       Prefix appears solely for information; process as a regular transaction.
+     */
+    OPTION_ACTIVITY_TYPE["SPREAD"] = "SPREAD";
+    /**
+     * Transaction was the execution of an order identified as an Intermarket Sweep Order. Process like normal transaction.
+     */
+    OPTION_ACTIVITY_TYPE["IntermarketSweep"] = "IntermarketSweep";
+})(OPTION_ACTIVITY_TYPE = exports.OPTION_ACTIVITY_TYPE || (exports.OPTION_ACTIVITY_TYPE = {}));
+/**
+ * SIDE
+ */
+var SIDE_LABEL;
+(function (SIDE_LABEL) {
+    SIDE_LABEL["ABOVE_ASK"] = "AASK";
+    SIDE_LABEL["ASK"] = "ASK";
+    SIDE_LABEL["MID"] = "MID";
+    SIDE_LABEL["BID"] = "BID";
+    SIDE_LABEL["BELOW_BID"] = "BBID";
+})(SIDE_LABEL = exports.SIDE_LABEL || (exports.SIDE_LABEL = {}));
+/**
+ * MONEYNESS
+ */
+var MONEYNESS_LABEL;
+(function (MONEYNESS_LABEL) {
+    MONEYNESS_LABEL["ITM"] = "ITM";
+    MONEYNESS_LABEL["ATM"] = "ATM";
+    MONEYNESS_LABEL["OTM"] = "OTM";
+})(MONEYNESS_LABEL = exports.MONEYNESS_LABEL || (exports.MONEYNESS_LABEL = {}));
+/**
+ * for strategy
+ */
+var SENTIMENT_TAG;
+(function (SENTIMENT_TAG) {
+    SENTIMENT_TAG["BULLISH"] = "BULLISH";
+    SENTIMENT_TAG["BEARISH"] = "BEARISH";
+    SENTIMENT_TAG["NEUTRAL"] = "NEUTRAL";
+})(SENTIMENT_TAG = exports.SENTIMENT_TAG || (exports.SENTIMENT_TAG = {}));
+var CALL_PUT_TAG;
+(function (CALL_PUT_TAG) {
+    CALL_PUT_TAG["CALL"] = "CALL";
+    CALL_PUT_TAG["PUT"] = "PUT";
+})(CALL_PUT_TAG = exports.CALL_PUT_TAG || (exports.CALL_PUT_TAG = {}));
+var UNDERLYING_TYPE_TAG;
+(function (UNDERLYING_TYPE_TAG) {
+    UNDERLYING_TYPE_TAG["STOCK"] = "STOCK";
+    UNDERLYING_TYPE_TAG["ETF"] = "ETF";
+    UNDERLYING_TYPE_TAG["ETN"] = "ETN";
+    UNDERLYING_TYPE_TAG["MLB"] = "MLB";
+    UNDERLYING_TYPE_TAG["REIT"] = "REIT";
+    UNDERLYING_TYPE_TAG["INDEX"] = "INDEX";
+})(UNDERLYING_TYPE_TAG = exports.UNDERLYING_TYPE_TAG || (exports.UNDERLYING_TYPE_TAG = {}));
+var STATUS;
+(function (STATUS) {
+    STATUS["SUCCESS"] = "SUCCESS";
+    STATUS["ERROR"] = "ERROR";
+})(STATUS = exports.STATUS || (exports.STATUS = {}));
+exports.FORMATTED_ERROR = {
+    AUTHENTICATED_FAILURE: {
+        CODE: "AUTHENTICATED_FAILURE",
+        MESSAGE: "You are not authorized, please login again",
+    },
+    SESSION_EXPIRED: {
+        CODE: "SESSION_EXPIRED",
+        MESSAGE: "Your session has expired, please sign in again",
+    },
+    SUBSCRIPTION_EXPIRED: {
+        CODE: "SUBSCRIPTION_EXPIRED",
+    },
+    UNKNOWN_ERROR: {
+        CODE: "UNKNOWN_ERROR",
+        MESSAGE: "Try again",
+    },
+};
+var STRIPE_SUBSCRIPTION_STATUS;
+(function (STRIPE_SUBSCRIPTION_STATUS) {
+    STRIPE_SUBSCRIPTION_STATUS["ACTIVE"] = "active";
+    STRIPE_SUBSCRIPTION_STATUS["PAST_DUE"] = "past_due";
+    STRIPE_SUBSCRIPTION_STATUS["CANCELED"] = "canceled";
+    STRIPE_SUBSCRIPTION_STATUS["TRIALING"] = "trialing";
+    STRIPE_SUBSCRIPTION_STATUS["PAUSED"] = "paused";
+    STRIPE_SUBSCRIPTION_STATUS["INCOMPLETE"] = "incomplete";
+    STRIPE_SUBSCRIPTION_STATUS["INCOMPLETE_EXPIRED"] = "incomplete_expired";
+})(STRIPE_SUBSCRIPTION_STATUS = exports.STRIPE_SUBSCRIPTION_STATUS || (exports.STRIPE_SUBSCRIPTION_STATUS = {}));
+var CHECKOUT_TYPE;
+(function (CHECKOUT_TYPE) {
+    CHECKOUT_TYPE["REGISTRATION"] = "registration";
+    CHECKOUT_TYPE["RESUBSCRIPTION"] = "resubscription";
+})(CHECKOUT_TYPE = exports.CHECKOUT_TYPE || (exports.CHECKOUT_TYPE = {}));
+var HTTP_ERROR_CODE;
+(function (HTTP_ERROR_CODE) {
+    HTTP_ERROR_CODE[HTTP_ERROR_CODE["OK"] = 200] = "OK";
+    HTTP_ERROR_CODE[HTTP_ERROR_CODE["BAD_REQUEST"] = 400] = "BAD_REQUEST";
+    HTTP_ERROR_CODE[HTTP_ERROR_CODE["UNAUTHORIZED"] = 401] = "UNAUTHORIZED";
+    HTTP_ERROR_CODE[HTTP_ERROR_CODE["FORBIDDEN"] = 403] = "FORBIDDEN";
+    HTTP_ERROR_CODE[HTTP_ERROR_CODE["INTERNAL_SERVER_ERROR"] = 500] = "INTERNAL_SERVER_ERROR";
+})(HTTP_ERROR_CODE = exports.HTTP_ERROR_CODE || (exports.HTTP_ERROR_CODE = {}));
+/**
+ * @deprecated
+ */
+// import the future cost_cap_ratio
+/**
+ * @deprecated
+ * for strategy
+ */
+var STRATEGY_LABEL;
+(function (STRATEGY_LABEL) {
+    STRATEGY_LABEL[STRATEGY_LABEL["NONE"] = 0] = "NONE";
+    STRATEGY_LABEL[STRATEGY_LABEL["NOVA"] = 1] = "NOVA";
+    STRATEGY_LABEL[STRATEGY_LABEL["SWING"] = 2] = "SWING";
+    STRATEGY_LABEL["DT"] = "DT";
+    STRATEGY_LABEL["ACT"] = "ACT";
+    STRATEGY_LABEL["\u0394"] = "\u0394";
+    STRATEGY_LABEL["\u0394_plus"] = "\u0394+";
+    STRATEGY_LABEL["\u0393"] = "\u0393";
+    STRATEGY_LABEL["\u0398"] = "\u0398";
+    STRATEGY_LABEL["V"] = "V";
+    STRATEGY_LABEL["CLR"] = "CLR";
+    STRATEGY_LABEL["SELL"] = "SELL";
+    STRATEGY_LABEL["HV"] = "HV";
+    STRATEGY_LABEL["LV"] = "LV";
+    STRATEGY_LABEL["INSTITUTE_SELL_CALL"] = "INSTITUTE_SELL_CALL";
+    STRATEGY_LABEL["INSTITUTE_BUY_PUT"] = "INSTITUTE_BUY_PUT";
+    STRATEGY_LABEL["EXTEND"] = "EXTEND";
+    STRATEGY_LABEL["FULL"] = "FULL";
+    STRATEGY_LABEL["SMART"] = "SMART";
+})(STRATEGY_LABEL = exports.STRATEGY_LABEL || (exports.STRATEGY_LABEL = {}));
+/**
+ * used in OptionData
+ */
+/**
+ * @usage cron-service process-service
+ * https://documentation.tradier.com/brokerage-api/markets/get-options-chains
+ * used in
+ */
+/**
+ * used to record the daily meta data of a symbol
+ * @usage process-service websocket-service
+ */

package/dist/types/websocketCF.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @usage cf-service, web-app
+ * @description the params for websocket
+ */
+export interface WebSocketParams {
+    user_type: string | null;
+    symbols: string | null;
+    premium: string | null;
+    sentiment: string | null;
+    underlying_type: string | null;
+    moneyness: string | null;
+    delta: string | null;
+    is_recent_earning_only: string | null;
+    strike: string | null;
+    expiry_days: string | null;
+    put_call: string | null;
+    side: string | null;
+    oi: string | null;
+    iv: string | null;
+    option_activity_type: string | null;
+    is_opening_only: string | null;
+    trade_count: string | null;
+    dex: string | null;
+    underlying_price: string | null;
+    dei: string | null;
+    size: string | null;
+    daily_volume: string | null;
+    aggregation_mode: string | null;
+    test_mode?: string | null;
+}

package/dist/types/websocketCF.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/common/date-functions.d.ts

@@ -0,0 +1,45 @@
+import moment from "moment-timezone";
+export declare function isTradingDate(todayDateStr?: string): boolean;
+/**
+ * @description 取最近的交易日 in New York timezone, in the format of YYYY-MM-DD,
+ * exclude weekends and holidays, and before 9:30am(PST)
+ */
+export declare function getLastTradeDate(format?: string, currentMoment?: moment.Moment): string;
+/**
+ * @description 将Date Object转化为日期string YYYY-MM-DD
+ */
+export declare function convertDateToString(date: Date): string | undefined;
+/**
+ * @description 将string YYYY-MM-DD convert to YYYYMMDD
+ */
+export declare function convertDateFormatToYYYYMMDD(date: string): string;
+/**
+ * @description 计算一个未来的日期和今天的相差天数(按照UTC)
+ */
+export declare const getDiffDaysBetweenFutureAndToday: (future_date: string | Date) => number;
+/**
+ * @description 计算两个日期之间的相差天数
+ */
+export declare const getDiffDaysBetweenFutureAndPast: (future_date: string | Date, past_date: string | Date) => number;
+export declare function momentInNewYork(): moment.Moment;
+/**
+ * @description whether one date in format of YYYY-MM-DD is before/same before another date
+ */
+export declare function isOneDateBeforeAnotherDate(a_date: string, b_date?: string, could_be_same_date?: boolean): boolean;
+/**
+ *
+ * @param time unix time stamp
+ * @returns a date format in YYYY-MM-DD in New York Time Zone
+ */
+export declare function convertUnixTimestampToDate(time: string, format?: string): string;
+/**
+ *
+ * @param time unix time stamp
+ * @returns a date format in HH:mm:ss in New York Time Zone
+ */
+export declare function convertUnixTimestampToTime(time: string, format?: string): string;
+/**
+ * get current timestamp in unix format
+ */
+export declare function getTimestamp(): number;
+export declare function isMarketOpen(currentMoment?: moment.Moment): boolean;