@columenlabs/lumen-ui-types 0.1.1 → 0.1.3

package/README.md

@@ -2,4 +2,4 @@
 
 Lumen's view model: view config, formulas (Jexl), domains and joins, the data catalog, frames, chart formulas and market shapes. It has no React and can be used on a server.
 
-See the [Lumen README](https://github.com/columenlabs/lumen#readme). MIT.
+See the [Lumen README](https://github.com/columenlabs/lumen-ui#readme). MIT.

package/dist/chart-formula.d.ts

@@ -1,16 +1,16 @@
 import { z } from 'zod';
 /** The bar fields a formula reads. */
-export declare const FORMULA_FIELDS: readonly ["open", "high", "low", "close"];
+export declare const FORMULA_FIELDS: readonly ['open', 'high', 'low', 'close'];
 export type FormulaField = (typeof FORMULA_FIELDS)[number];
 /** Each function's arguments: `x` a series, `n` a window in bars (a whole number written as is). */
 export declare const FORMULA_FUNCTIONS: {
     readonly sma: {
         readonly args: readonly ["x", "n"];
-        readonly about: "simple moving average";
+        readonly about: 'simple moving average';
     };
     readonly ema: {
         readonly args: readonly ["x", "n"];
-        readonly about: "exponential moving average";
+        readonly about: 'exponential moving average';
     };
     readonly rsi: {
         readonly args: readonly ["x", "n"];
@@ -18,48 +18,48 @@ export declare const FORMULA_FUNCTIONS: {
     };
     readonly stdev: {
         readonly args: readonly ["x", "n"];
-        readonly about: "standard deviation over n bars";
+        readonly about: 'standard deviation over n bars';
     };
     readonly highest: {
         readonly args: readonly ["x", "n"];
-        readonly about: "highest over n bars";
+        readonly about: 'highest over n bars';
     };
     readonly lowest: {
         readonly args: readonly ["x", "n"];
-        readonly about: "lowest over n bars";
+        readonly about: 'lowest over n bars';
     };
     readonly sum: {
         readonly args: readonly ["x", "n"];
-        readonly about: "sum over n bars";
+        readonly about: 'sum over n bars';
     };
     readonly ref: {
         readonly args: readonly ["x", "n"];
-        readonly about: "x n bars ago";
+        readonly about: 'x n bars ago';
     };
     readonly change: {
         readonly args: readonly ["x", "n"];
-        readonly about: "% change over n bars";
+        readonly about: '% change over n bars';
     };
     readonly atr: {
         readonly args: readonly ["n"];
-        readonly about: "average true range";
+        readonly about: 'average true range';
     };
     readonly abs: {
         readonly args: readonly ["x"];
-        readonly about: "absolute value";
+        readonly about: 'absolute value';
     };
     readonly min: {
         readonly args: readonly ["x", "x"];
-        readonly about: "the lower of two";
+        readonly about: 'the lower of two';
     };
     readonly max: {
         readonly args: readonly ["x", "x"];
-        readonly about: "the higher of two";
+        readonly about: 'the higher of two';
     };
 };
 export type FormulaFunction = keyof typeof FORMULA_FUNCTIONS;
 /** The chart's catalog (LumenShell's `CHART_INDICATORS`), by id, for checking a spec on the server. */
-export declare const CHART_INDICATOR_IDS: readonly ["sma_20", "sma_50", "sma_200", "ema_9", "ema_21", "ema_50", "bollinger", "high_low_52w", "rsi_14", "macd", "atr_14", "rel_volume_20", "vwap_distance", "pe_trailing", "pe_forward", "iv30", "est_eps"];
+export declare const CHART_INDICATOR_IDS: readonly ['sma_20', 'sma_50', 'sma_200', 'ema_9', 'ema_21', 'ema_50', 'bollinger', 'high_low_52w', 'rsi_14', 'macd', 'atr_14', 'rel_volume_20', 'vwap_distance', 'pe_trailing', 'pe_forward', 'iv30', 'est_eps'];
 export type ChartIndicatorId = (typeof CHART_INDICATOR_IDS)[number];
 /** A window: 1 to 400 bars, like an app's indicators. */
 export declare const MAX_FORMULA_WINDOW = 400;

package/dist/frames.d.ts

@@ -9,7 +9,7 @@ export declare const FRAME_COLUMNS = 50;
 /** Most hand edits a frame keeps (the latest per cell); past it the oldest go. */
 export declare const FRAME_EDITS = 500;
 /** The formats a frame column can carry; the assistant may set one, else number or text. */
-export declare const FRAME_FORMATS: readonly ["number", "rounded", "compact", "integer", "price", "price_rounded", "price_signed", "percent", "weight", "signed", "text", "amount", "amount_signed", "quantity"];
+export declare const FRAME_FORMATS: readonly ['number', 'rounded', 'compact', 'integer', 'price', 'price_rounded', 'price_signed', 'percent', 'weight', 'signed', 'text', 'amount', 'amount_signed', 'quantity'];
 export type FrameFormat = (typeof FRAME_FORMATS)[number];
 export declare function frameFormat(f: FrameFormat): {
     format: ViewFormat;
@@ -133,11 +133,11 @@ export type FrameEditInput = z.infer<typeof frameEditSchema>;
 /** A field key from a column name: `Day %` → `day_pct`. */
 export declare function columnKey(name: string, taken: Set<string>): string;
 /** The columns that make a frame's rows carry a symbol key (the registry's Symbol join). */
-export declare const SYMBOL_COLUMNS: readonly ["symbol", "ticker", "underlying"];
+export declare const SYMBOL_COLUMNS: readonly ['symbol', 'ticker', 'underlying'];
 /** The columns that make a frame's rows carry an account key (the registry's Account join). */
-export declare const ACCOUNT_COLUMNS: readonly ["account", "account_id"];
+export declare const ACCOUNT_COLUMNS: readonly ['account', 'account_id'];
 /** The frame's column for a join key, if it has one: a text column named like that key. */
-export declare const frameKeyAt: (meta: Pick<FrameMeta, "columns">, key: JoinKey) => number;
+export declare const frameKeyAt: (meta: Pick<FrameMeta, 'columns'>, key: JoinKey) => number;
 /**
  * Columns a frame with a symbol column must not carry where the app has a live feed (a price in a frame freezes): the card's Symbol join fills live Price and Day % by
  * itself. Keys as `columnKey` makes them; a dated price goes in under its own name (`close_q3`).
@@ -146,7 +146,7 @@ export declare const LIVE_QUOTE_COLUMNS: Record<string, 'price' | 'change_pct'>;
 /** The live quote columns a frame carries that its Symbol join already gives. */
 export declare function liveQuoteColumns(columns: FrameColumn[]): FrameColumn[];
 /** The frame's symbol column, if it has one: a text column named like a ticker column. */
-export declare const frameSymbolAt: (meta: Pick<FrameMeta, "columns">) => number;
+export declare const frameSymbolAt: (meta: Pick<FrameMeta, 'columns'>) => number;
 /** The key column a Your data frame starts with, for a join key. */
 export declare const yourKeyColumn: (key: JoinKey) => FrameColumn;
 /**

package/dist/market.d.ts

@@ -105,7 +105,7 @@ export type MarketServerMessage = {
     at: number;
 };
 /** Chart dialog windows. */
-export declare const marketWindows: readonly ["1D", "5D", "1M", "6M", "YTD", "1Y", "5Y", "Max"];
+export declare const marketWindows: readonly ['1D', '5D', '1M', '6M', 'YTD', '1Y', '5Y', 'Max'];
 export type MarketWindow = (typeof marketWindows)[number];
 /** `GET /api/v1/market/bars?symbol=&window=`: one symbol's history over a window. */
 export interface MarketBarsResponse {
@@ -127,7 +127,7 @@ export interface MarketBarsResponse {
  * Indicator lines bars cannot give, read from the warehouse once when the person adds one to the
  * chart: P/E trailing and forward, IV 30d, the EPS estimate.
  */
-export declare const SOURCED_INDICATORS: readonly ["pe_trailing", "pe_forward", "iv30", "est_eps"];
+export declare const SOURCED_INDICATORS: readonly ['pe_trailing', 'pe_forward', 'iv30', 'est_eps'];
 export type SourcedIndicator = (typeof SOURCED_INDICATORS)[number];
 export declare const isSourcedIndicator: (s: string) => s is SourcedIndicator;
 /** `GET /api/v1/market/indicators?symbol=&names=`: one symbol's sourced lines, `[t, value]` a day. */

package/dist/tasks.d.ts

@@ -4,7 +4,7 @@
  * Search, a Sweep, a backfill, a sync). Every app shows them in the header's Tasks list; the engines
  * keep their own internals and only report here.
  */
-export declare const TASK_STATES: readonly ["queued", "running", "done", "failed", "cancelled"];
+export declare const TASK_STATES: readonly ['queued', 'running', 'done', 'failed', 'cancelled'];
 export type TaskState = (typeof TASK_STATES)[number];
 export interface Task {
     id: string;
@@ -42,4 +42,4 @@ export interface TaskList {
     /** Ended and not seen yet. */
     unseen: number;
 }
-export declare const isActive: (t: Pick<Task, "state">) => boolean;
+export declare const isActive: (t: Pick<Task, 'state'>) => boolean;

package/dist/view-formula.d.ts

@@ -5,7 +5,7 @@ export interface ViewFormulaScope {
     groupSum: (key: string) => number;
     totalSum: (key: string) => number;
 }
-export declare const viewFormulaFunctions: readonly ["group_sum", "total_sum"];
+export declare const viewFormulaFunctions: readonly ['group_sum', 'total_sum'];
 /** Compiles a formula (throws on a syntax error) into a row evaluator; a failed row is null. */
 export declare function compileViewFormula(expr: string): (scope: ViewFormulaScope) => number | string | null;
 /**