@tradecanvas/commons 1.46.0 → 1.47.0

package/dist/market/presets.d.ts

@@ -15,7 +15,7 @@ export declare const VN30F_SESSIONS: TradingSession[];
  * from the reference; zone Asia/Ho_Chi_Minh; the price board's colours
  * (`VN_COLORS`); the ATO, two continuous sessions and ATC (`HOSE_SESSIONS`).
  * With `chart.setMarket`: `setPriceLimits(reference)` for the day's ceiling
- * and floor, `setTimezone('exchange')` for the axis in Vietnam's time.
+ * and floor, `setTimeZone('exchange')` for the axis in Vietnam's time.
  */
 export declare const MARKET_HOSE: MarketConfig;
 /** HOSE ETFs and covered warrants: 10 dong at every price. */

package/dist/types/chart.d.ts

@@ -154,10 +154,10 @@ export interface ChartOptions {
      */
     freePan?: boolean;
     /**
-     * Timezone for the time axis, crosshair, tooltip, day breaks and range
+     * Time zone for the time axis, crosshair, tooltip, day breaks and range
      * presets: an IANA zone (`'America/New_York'`, daylight saving included), a
      * fixed offset in minutes east of UTC, `'exchange'` for the symbol's zone
-     * or else its market's (`setTimezone`), or null (default) for the browser's.
+     * or else its market's (`setTimeZone`), or null (default) for the browser's.
      */
     timeZone?: string | number | null;
     /**

package/dist/types/realtime.d.ts

@@ -92,9 +92,9 @@ export interface DataAdapter {
     /** Optional: symbols matching `query`, best first — for a symbol search box. */
     searchSymbols?(query: string, options?: SymbolSearchOptions): Promise<SymbolInfo[]>;
     /**
-     * Optional: what the feed knows about `symbol` (name, price step, exchange
-     * timezone and hours), or null when it doesn't know it. A connected chart
-     * asks for it and applies it.
+     * Optional: what the feed knows about `symbol` (name, price step, the
+     * exchange's `timeZone` and hours), or null when it doesn't know it. A
+     * connected chart asks for it and applies it.
      */
     resolveSymbol?(symbol: string): Promise<SymbolInfo | null>;
     /**

package/dist/types/symbol.d.ts

@@ -1,4 +1,4 @@
-/** A regular trading window, wall-clock times in the symbol's `timezone`. */
+/** A regular trading window, wall-clock times in the symbol's `timeZone`. */
 export interface SymbolSession {
     /** Opening time, `'09:30'`. */
     start: string;
@@ -26,8 +26,14 @@ export interface SymbolInfo {
     /** Smallest price step. */
     minTick?: number;
     /** IANA zone the exchange keeps its hours in, e.g. `'America/New_York'`. */
+    timeZone?: string;
+    /**
+     * @deprecated Use `timeZone`, spelled as the chart's `timeZone` option is.
+     * Still read when `timeZone` is left out (`timeZone` comes first when both
+     * are given); the chart's `getSymbolInfo()` gives both.
+     */
     timezone?: string;
-    /** Regular trading hours in `timezone`; none means around the clock. */
+    /** Regular trading hours in `timeZone`; none means around the clock. */
     sessions?: SymbolSession[];
     /** Currency prices are quoted in. */
     currency?: string;

package/dist/types/symbol.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"symbol.d.ts","sourceRoot":"","sources":["../../src/types/symbol.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,MAAM,WAAW,aAAa;IAC5B,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,yEAAyE;IACzE,GAAG,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,8EAA8E;AAC9E,MAAM,WAAW,UAAU;IACzB,qDAAqD;IACrD,MAAM,EAAE,MAAM,CAAC;IACf,uDAAuD;IACvD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gEAAgE;IAChE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,2BAA2B;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wEAAwE;IACxE,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC;IAC3B,qCAAqC;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,+CAA+C;AAC/C,MAAM,WAAW,mBAAmB;IAClC,2CAA2C;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sDAAsD;IACtD,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB"}
+{"version":3,"file":"symbol.d.ts","sourceRoot":"","sources":["../../src/types/symbol.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,MAAM,WAAW,aAAa;IAC5B,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,yEAAyE;IACzE,GAAG,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,8EAA8E;AAC9E,MAAM,WAAW,UAAU;IACzB,qDAAqD;IACrD,MAAM,EAAE,MAAM,CAAC;IACf,uDAAuD;IACvD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gEAAgE;IAChE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,2BAA2B;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wEAAwE;IACxE,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC;IAC3B,qCAAqC;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,+CAA+C;AAC/C,MAAM,WAAW,mBAAmB;IAClC,2CAA2C;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sDAAsD;IACtD,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB"}

package/dist/utils/symbols.d.ts

@@ -8,6 +8,8 @@ import { SymbolInfo } from '../types/symbol.js';
 export declare function rankSymbols(symbols: readonly SymbolInfo[], query: string, limit?: number, boost?: (info: SymbolInfo) => number): SymbolInfo[];
 /** Decimals in a price step: `'0.01000000'` → 2, `'1'` → 0, `1e-8` → 8. */
 export declare function stepDecimals(step: number | string): number;
+/** The zone a symbol keeps its hours in: its `timeZone`, else the older `timezone`. */
+export declare function symbolTimeZone(info: Pick<SymbolInfo, 'timeZone' | 'timezone'> | null | undefined): string | undefined;
 /** `'09:30'` → 570 (`'24:00'`, a day's end, → 1440), or null for anything that isn't a time of day. */
 export declare function sessionMinute(time: string): number | null;
 //# sourceMappingURL=symbols.d.ts.map

package/dist/utils/symbols.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"symbols.d.ts","sourceRoot":"","sources":["../../src/utils/symbols.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAWrD;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,OAAO,EAAE,SAAS,UAAU,EAAE,EAC9B,KAAK,EAAE,MAAM,EACb,KAAK,SAAK,EACV,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,MAAM,GACnC,UAAU,EAAE,CAad;AAED,2EAA2E;AAC3E,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAQ1D;AAED,uGAAuG;AACvG,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAOzD"}
+{"version":3,"file":"symbols.d.ts","sourceRoot":"","sources":["../../src/utils/symbols.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAWrD;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,OAAO,EAAE,SAAS,UAAU,EAAE,EAC9B,KAAK,EAAE,MAAM,EACb,KAAK,SAAK,EACV,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,MAAM,GACnC,UAAU,EAAE,CAad;AAED,2EAA2E;AAC3E,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAQ1D;AAED,uFAAuF;AACvF,wBAAgB,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,UAAU,GAAG,UAAU,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAErH;AAED,uGAAuG;AACvG,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAOzD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tradecanvas/commons",
-  "version": "1.46.0",
+  "version": "1.47.0",
   "type": "module",
   "description": "Shared types and utilities for @tradecanvas/chart",
   "license": "MIT",