fix(types): use StaticDecode vs Static to infer types (#797)

With Typebox, `Static` is used to infer types from schema, however,
`StaticDecode` is needed for Transform types which have a `Decode()`
function.  This is important also for schemas composed of other
schemas that make use of transform types.

We already use `StaticDecode` in `validateAndCoerceTypes()` which
is the most important place and filters down to regular use of the
library.  But now that we are exporting all types again (per previous
commit), this is important to make sure that users who are importing
types directly get the correct type.  And I think solved some edge
cases where certain types will still coming through incorrectly.

cc: @eddie-atkinson

src/modules/chart.ts

@@ -1,6 +1,6 @@
 // Co-authored by @gadicc, @PythonCreator27 and @huned.
 
-import { Static, Type } from "@sinclair/typebox";
+import { StaticDecode, Type } from "@sinclair/typebox";
 import type {
   ModuleOptions,
   ModuleOptionsWithValidateTrue,
@@ -262,15 +262,15 @@ const ChartOptionsWithReturnObjectSchema = Type.Composite(
   },
 );
 
-export type ChartOptions = Static<typeof ChartOptionsSchema>;
-export type ChartOptionsWithReturnObject = Static<
+export type ChartOptions = StaticDecode<typeof ChartOptionsSchema>;
+export type ChartOptionsWithReturnObject = StaticDecode<
   typeof ChartOptionsWithReturnObjectSchema
 >;
-export type ChartResultObject = Static<typeof ChartResultObjectSchema>;
-export type ChartOptionsWithReturnArray = Static<
+export type ChartResultObject = StaticDecode<typeof ChartResultObjectSchema>;
+export type ChartOptionsWithReturnArray = StaticDecode<
   typeof ChartOptionsWithReturnArraySchema
 >;
-export type ChartResultArray = Static<typeof ChartResultArraySchema>;
+export type ChartResultArray = StaticDecode<typeof ChartResultArraySchema>;
 
 const queryOptionsDefaults: Omit<ChartOptions, "period1"> = {
   useYfid: true,

src/modules/dailyGainers.ts

@@ -1,4 +1,4 @@
-import { Static, Type } from "@sinclair/typebox";
+import { StaticDecode, Type } from "@sinclair/typebox";
 import type {
   ModuleOptions,
   ModuleOptionsWithValidateTrue,
@@ -155,8 +155,10 @@ const DailyGainersResultSchema = Type.Object(
   { title: "DailyGainersResult" },
 );
 
-export type DailyGainersResult = Static<typeof DailyGainersResultSchema>;
-export type DailyGainersOptions = Static<typeof DailyGainersOptionsSchema>;
+export type DailyGainersResult = StaticDecode<typeof DailyGainersResultSchema>;
+export type DailyGainersOptions = StaticDecode<
+  typeof DailyGainersOptionsSchema
+>;
 
 const queryOptionsDefaults = {
   lang: "en-US",

src/modules/fundamentalsTimeSeries.ts

@@ -1,4 +1,4 @@
-import { Static, Type } from "@sinclair/typebox";
+import { StaticDecode, Type } from "@sinclair/typebox";
 import type {
   ModuleOptions,
   ModuleOptionsWithValidateTrue,
@@ -47,15 +47,15 @@ const FundamentalsTimeSeriesOptionsSchema = Type.Object(
   },
 );
 
-export type FundamentalsTimeSeriesOptions = Static<
+export type FundamentalsTimeSeriesOptions = StaticDecode<
   typeof FundamentalsTimeSeriesOptionsSchema
 >;
 
 const FundamentalsTimeSeriesResultsSchema = Type.Array(
   FundamentalsTimeSeriesResultSchema,
 );
 
-export type FundamentalsTimeSeriesResult = Static<
+export type FundamentalsTimeSeriesResult = StaticDecode<
   typeof FundamentalsTimeSeriesResultSchema
 >;
 

src/modules/historical.ts

@@ -1,4 +1,4 @@
-import { Static, Type } from "@sinclair/typebox";
+import { StaticDecode, Type } from "@sinclair/typebox";
 import { Value } from "@sinclair/typebox/value";
 import type {
   ModuleOptions,
@@ -26,7 +26,9 @@ const HistoricalRowHistorySchema = Type.Object(
     title: "HistoricalRowHistory",
   },
 );
-export type HistoricalRowHistory = Static<typeof HistoricalRowHistorySchema>;
+export type HistoricalRowHistory = StaticDecode<
+  typeof HistoricalRowHistorySchema
+>;
 
 const HistoricalRowDividendSchema = Type.Object(
   {
@@ -35,7 +37,9 @@ const HistoricalRowDividendSchema = Type.Object(
   },
   { title: "HistoricalRowDividend" },
 );
-export type HistoricalRowDividend = Static<typeof HistoricalRowDividendSchema>;
+export type HistoricalRowDividend = StaticDecode<
+  typeof HistoricalRowDividendSchema
+>;
 
 const HistoricalRowStockSplitSchema = Type.Object(
   {
@@ -44,7 +48,7 @@ const HistoricalRowStockSplitSchema = Type.Object(
   },
   { title: "HistoricalRowStockSplit" },
 );
-export type HistoricalRowStockSplit = Static<
+export type HistoricalRowStockSplit = StaticDecode<
   typeof HistoricalRowStockSplitSchema
 >;
 
@@ -73,7 +77,7 @@ const HistoricalOptionsSchema = Type.Object(
   },
   { title: "HistoricalOptions" },
 );
-export type HistoricalOptions = Static<typeof HistoricalOptionsSchema>;
+export type HistoricalOptions = StaticDecode<typeof HistoricalOptionsSchema>;
 
 const HistoricalOptionsEventsHistorySchema = Type.Composite(
   [
@@ -84,7 +88,7 @@ const HistoricalOptionsEventsHistorySchema = Type.Composite(
   ],
   { title: "HistoricalOptionsEventsHistory" },
 );
-export type HistoricalOptionsEventsHistory = Static<
+export type HistoricalOptionsEventsHistory = StaticDecode<
   typeof HistoricalOptionsEventsHistorySchema
 >;
 
@@ -97,7 +101,7 @@ const HistoricalOptionsEventsDividendsSchema = Type.Composite(
   ],
   { title: "HistoricalOptionsEventsDividends" },
 );
-export type HistoricalOptionsEventsDividends = Static<
+export type HistoricalOptionsEventsDividends = StaticDecode<
   typeof HistoricalOptionsEventsDividendsSchema
 >;
 
@@ -110,14 +114,14 @@ const HistoricalOptionsEventsSplitSchema = Type.Composite(
   ],
   { title: "HistoricalOptionsEventsSplit" },
 );
-export type HistoricalOptionsEventsSplit = Static<
+export type HistoricalOptionsEventsSplit = StaticDecode<
   typeof HistoricalOptionsEventsSplitSchema
 >;
 
 const HistoricalHistoryResultSchema = Type.Array(HistoricalRowHistorySchema, {
   title: "HistoricalHistoryResult",
 });
-export type HistoricalHistoryResult = Static<
+export type HistoricalHistoryResult = StaticDecode<
   typeof HistoricalHistoryResultSchema
 >;
 
@@ -127,7 +131,7 @@ const HistoricalDividendsResultSchema = Type.Array(
     title: "HistoricalDividendsResult",
   },
 );
-export type HistoricalDividendsResult = Static<
+export type HistoricalDividendsResult = StaticDecode<
   typeof HistoricalDividendsResultSchema
 >;
 
@@ -137,7 +141,7 @@ const HistoricalStockSplitsResultSchema = Type.Array(
     title: "HistoricalRowStockSplit",
   },
 );
-export type HistoricalStockSplitsResult = Static<
+export type HistoricalStockSplitsResult = StaticDecode<
   typeof HistoricalStockSplitsResultSchema
 >;
 

src/modules/insights.ts

@@ -4,7 +4,7 @@ import type {
   ModuleOptionsWithValidateFalse,
   ModuleThis,
 } from "../lib/moduleCommon.js";
-import { Type, Static } from "@sinclair/typebox";
+import { Type, StaticDecode } from "@sinclair/typebox";
 
 import {
   YahooDateInMs,
@@ -236,8 +236,8 @@ const InsightsResultSchema = Type.Object(
   },
 );
 
-export type InsightsResult = Static<typeof InsightsResultSchema>;
-export type InsightsOutlook = Static<typeof InsightsOutlookSchema>;
+export type InsightsResult = StaticDecode<typeof InsightsResultSchema>;
+export type InsightsOutlook = StaticDecode<typeof InsightsOutlookSchema>;
 
 export interface InsightsInstrumentInfo {
   [key: string]: any;
@@ -298,7 +298,7 @@ const InsightsOptionsSchema = Type.Object(
   { title: "InsightsOptions" },
 );
 
-export type InsightsOptions = Static<typeof InsightsOptionsSchema>;
+export type InsightsOptions = StaticDecode<typeof InsightsOptionsSchema>;
 
 const queryOptionsDefaults = {
   lang: "en-US",

src/modules/options.ts

@@ -4,7 +4,7 @@ import type {
   ModuleOptionsWithValidateFalse,
   ModuleThis,
 } from "../lib/moduleCommon.js";
-import { Type, Static } from "@sinclair/typebox";
+import { Type, StaticDecode } from "@sinclair/typebox";
 
 import { YahooFinanceDate, YahooNumber } from "../lib/yahooFinanceTypes.js";
 import { QuoteBase } from "./quote.js";
@@ -212,8 +212,8 @@ const OptionsOptionsSchema = Type.Object(
   },
 );
 
-export type OptionsOptions = Static<typeof OptionsOptionsSchema>;
-export type OptionsResult = Static<typeof OptionsResultSchema>;
+export type OptionsOptions = StaticDecode<typeof OptionsOptionsSchema>;
+export type OptionsResult = StaticDecode<typeof OptionsResultSchema>;
 
 const queryOptionsDefaults: OptionsOptions = {
   formatted: false,

src/modules/quote.ts

@@ -5,7 +5,7 @@ import type {
   ModuleThis,
 } from "../lib/moduleCommon.js";
 
-import { Static, Type } from "@sinclair/typebox";
+import { StaticDecode, Type } from "@sinclair/typebox";
 import {
   YahooDateInMs,
   YahooFinanceDate,
@@ -229,7 +229,7 @@ const QuoteSchema = Type.Union([
   QuoteOption,
 ]);
 
-export type Quote = Static<typeof QuoteSchema>;
+export type Quote = StaticDecode<typeof QuoteSchema>;
 
 const QuoteField = Type.KeyOf(QuoteSchema);
 
@@ -270,19 +270,19 @@ const QuoteOptionsWithReturnObjectSchema = Type.Composite([
   }),
 ]);
 
-export type QuoteOptionsWithReturnArray = Static<
+export type QuoteOptionsWithReturnArray = StaticDecode<
   typeof QuoteOptionsWithReturnArraySchema
 >;
 
-export type QuoteOptionsWithReturnMap = Static<
+export type QuoteOptionsWithReturnMap = StaticDecode<
   typeof QuoteOptionsWithReturnMapSchema
 >;
 
-export type QuoteOptionsWithReturnObject = Static<
+export type QuoteOptionsWithReturnObject = StaticDecode<
   typeof QuoteOptionsWithReturnObjectSchema
 >;
 
-export type QuoteOptions = Static<typeof QuoteOptionsSchema>;
+export type QuoteOptions = StaticDecode<typeof QuoteOptionsSchema>;
 
 const queryOptionsDefaults = {};