@luxalgo/vela 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/NOTICE +28 -0
- package/README.md +135 -0
- package/dist/DataProvider-DKNDHpNv.d.cts +134 -0
- package/dist/DataProvider-Dzd-Erlk.d.ts +134 -0
- package/dist/chunk-7UFX5ZIG.js +5976 -0
- package/dist/chunk-GYD2THPV.js +252 -0
- package/dist/chunk-KCCZNKH7.js +19137 -0
- package/dist/chunk-KM6LHB3Y.js +76 -0
- package/dist/chunk-OVQKKXLZ.js +3978 -0
- package/dist/chunk-Q3XQHLIH.js +7 -0
- package/dist/chunk-RHIDOUFL.js +698 -0
- package/dist/contributions-hX3EUyjG.d.ts +1528 -0
- package/dist/contributions-o1GRKPI_.d.cts +1528 -0
- package/dist/history-Dzxz-MQj.d.ts +298 -0
- package/dist/history-LJkz4-sS.d.cts +298 -0
- package/dist/icons-BZYbJXSV.d.cts +10 -0
- package/dist/icons-BZYbJXSV.d.ts +10 -0
- package/dist/index.cjs +25294 -0
- package/dist/index.d.cts +1189 -0
- package/dist/index.d.ts +1189 -0
- package/dist/index.js +5 -0
- package/dist/keymap-CGOz5F5f.d.cts +64 -0
- package/dist/keymap-CGOz5F5f.d.ts +64 -0
- package/dist/options-Q-576hIi.d.cts +1545 -0
- package/dist/options-Q-576hIi.d.ts +1545 -0
- package/dist/plugin-D94muTV-.d.cts +405 -0
- package/dist/plugin-aGUD1epn.d.ts +405 -0
- package/dist/plugin.cjs +5967 -0
- package/dist/plugin.d.cts +7 -0
- package/dist/plugin.d.ts +7 -0
- package/dist/plugin.js +3 -0
- package/dist/providers/binance.cjs +390 -0
- package/dist/providers/binance.d.cts +62 -0
- package/dist/providers/binance.d.ts +62 -0
- package/dist/providers/binance.js +388 -0
- package/dist/providers/coinbase.cjs +462 -0
- package/dist/providers/coinbase.d.cts +59 -0
- package/dist/providers/coinbase.d.ts +59 -0
- package/dist/providers/coinbase.js +460 -0
- package/dist/providers/hyperliquid.cjs +361 -0
- package/dist/providers/hyperliquid.d.cts +54 -0
- package/dist/providers/hyperliquid.d.ts +54 -0
- package/dist/providers/hyperliquid.js +359 -0
- package/dist/side-panel-CT9ZwIGz.d.cts +63 -0
- package/dist/side-panel-CT9ZwIGz.d.ts +63 -0
- package/dist/ui.cjs +1030 -0
- package/dist/ui.d.cts +188 -0
- package/dist/ui.d.ts +188 -0
- package/dist/ui.js +3 -0
- package/dist/vela.global.js +26509 -0
- package/dist/vela.global.min.js +230 -0
- package/dist/widget.cjs +31178 -0
- package/dist/widget.d.cts +799 -0
- package/dist/widget.d.ts +799 -0
- package/dist/widget.js +1060 -0
- package/dist/workspace.cjs +31692 -0
- package/dist/workspace.d.cts +579 -0
- package/dist/workspace.d.ts +579 -0
- package/dist/workspace.js +1694 -0
- package/package.json +95 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
Vela
|
|
2
|
+
Copyright (c) 2026 LuxAlgo
|
|
3
|
+
https://luxalgo.com/vela
|
|
4
|
+
|
|
5
|
+
This product includes the Vela charting library, developed by LuxAlgo.
|
|
6
|
+
|
|
7
|
+
ATTRIBUTION REQUIREMENT
|
|
8
|
+
|
|
9
|
+
Any product, website, or application that displays charts rendered by this
|
|
10
|
+
software must show a visible attribution to the Vela project on every page or
|
|
11
|
+
screen where such a chart is displayed.
|
|
12
|
+
|
|
13
|
+
The library satisfies this requirement automatically: it renders an attribution
|
|
14
|
+
mark (the project logomark linking to the Vela project page) on the chart
|
|
15
|
+
itself, enabled by default. You may restyle or reposition this mark to fit your
|
|
16
|
+
design.
|
|
17
|
+
|
|
18
|
+
You may disable the built-in mark (renderer feature `attribution`) ONLY if you
|
|
19
|
+
display an equivalent visible attribution — the name "Vela" together with a
|
|
20
|
+
link to the project page above — elsewhere on the same page or screen, in a
|
|
21
|
+
place available to your users.
|
|
22
|
+
|
|
23
|
+
Removing, hiding, or obscuring the attribution without providing the
|
|
24
|
+
equivalent notice described above is not permitted.
|
|
25
|
+
|
|
26
|
+
This file constitutes the NOTICE file described in Section 4(d) of the Apache
|
|
27
|
+
License, Version 2.0: redistributions of this software, in source or binary
|
|
28
|
+
form, must include a readable copy of these attribution notices.
|
package/README.md
ADDED
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
# Vela
|
|
2
|
+
|
|
3
|
+
A fast, extensible financial charting library with its own native canvas renderer, a
|
|
4
|
+
headless core, a batteries-included widget, and a plugin SDK for custom chart types and
|
|
5
|
+
renderer layers.
|
|
6
|
+
|
|
7
|
+
- **`vela`** — the headless chart: data model, engines, drawings, providers, native renderer.
|
|
8
|
+
- **`vela/widget`** — the full chart app: topbar (symbol / timeframe / style / indicators),
|
|
9
|
+
status line, watermark, bottom bar (ranges, clock, timezone), object tree, keyboard-first UX.
|
|
10
|
+
- **`vela/ui`** — the component kit the widget is built on (design tokens + headless
|
|
11
|
+
[Zag.js](https://zagjs.com) machines + vanilla views) and the `KeymapManager`.
|
|
12
|
+
- **`vela/plugin`** — the extension SDK: chart types, renderer layers, native indicators.
|
|
13
|
+
- **`vela/workspace`** — the multi-chart shell: a grid of full charts under one shared
|
|
14
|
+
topbar, with named cells, sync groups and one persisted state document.
|
|
15
|
+
- **`vela/providers/*`** — data providers (Binance, Coinbase, Hyperliquid).
|
|
16
|
+
|
|
17
|
+
## Quick start
|
|
18
|
+
|
|
19
|
+
```ts
|
|
20
|
+
import { VelaWidget } from 'vela/widget';
|
|
21
|
+
import { BinanceProvider } from 'vela/providers/binance';
|
|
22
|
+
|
|
23
|
+
const widget = new VelaWidget('#chart', {
|
|
24
|
+
symbol: 'BTCUSDT', // bare = first declared provider listing it; 'binance:BTCUSDT' pins the venue
|
|
25
|
+
timeframe: '60',
|
|
26
|
+
live: true,
|
|
27
|
+
theme: 'dark',
|
|
28
|
+
providers: { binance: () => new BinanceProvider() },
|
|
29
|
+
persist: true, // restore the full state document — market, style, timezone, renderer
|
|
30
|
+
// config, drawings and indicators — from localStorage
|
|
31
|
+
urlState: true, // ?symbol=…&interval=… shareable links
|
|
32
|
+
});
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Prefer full control? Use the headless core directly:
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
import { Vela } from 'vela';
|
|
39
|
+
import { BinanceProvider } from 'vela/providers/binance';
|
|
40
|
+
|
|
41
|
+
const chart = new Vela('#chart', { symbol: 'binance:BTCUSDT', timeframe: '60', live: true });
|
|
42
|
+
chart.data.registerProvider('binance', new BinanceProvider());
|
|
43
|
+
await chart.ready();
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Indicators
|
|
47
|
+
|
|
48
|
+
Vela runs indicator scripts through pluggable engines and **ships none** — install the
|
|
49
|
+
addon for the language you want, or write one against the public `ScriptingEngine` port.
|
|
50
|
+
Pine Script lives in [`@luxalgo/vela-pinets`](https://github.com/LuxAlgo/Vela-pinets)
|
|
51
|
+
(`npm i @luxalgo/vela-pinets pinets`), which is **AGPL-3.0** because the PineTS runtime it
|
|
52
|
+
executes is — Vela itself stays Apache-2.0 and carries no Pine code:
|
|
53
|
+
|
|
54
|
+
```ts
|
|
55
|
+
import { PineEngine } from '@luxalgo/vela-pinets';
|
|
56
|
+
|
|
57
|
+
chart.registerEngine('pine', new PineEngine());
|
|
58
|
+
chart.addIndicator(`//@version=5
|
|
59
|
+
indicator("EMA 20", overlay=true)
|
|
60
|
+
plot(ta.ema(close, 20), color=color.orange, linewidth=2)`);
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Host tooling can execute-and-inject safely (`chart.runIndicator(source)` — structured
|
|
64
|
+
errors, no dead legend rows) and read a running script's state — including its **return
|
|
65
|
+
value** — via `handle.context()` (read-only snapshots, worker-safe). See the
|
|
66
|
+
[API reference](docs/user/api-reference.md#reading-a-scripts-execution-context), and
|
|
67
|
+
[Scripting engines](docs/user/scripting-engines.md) for the addon and for writing your own.
|
|
68
|
+
|
|
69
|
+
The widget takes an **indicator manifest** — inline JSON, a URL returning it, or an async
|
|
70
|
+
loader (`() => Promise<manifest>`):
|
|
71
|
+
|
|
72
|
+
```ts
|
|
73
|
+
new VelaWidget('#chart', {
|
|
74
|
+
// …
|
|
75
|
+
engines: { pine: () => new PineEngine() },
|
|
76
|
+
indicators: '/indicators.json', // or an inline [{ name, script | url, language?, enabled? }]
|
|
77
|
+
});
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## Keyboard
|
|
81
|
+
|
|
82
|
+
Type a **letter** → symbol search. Type a **digit** → timeframe entry (`15`, `4h`, `D`, `3M`…).
|
|
83
|
+
`mod+alt+S` (Ctrl+Alt+S, ⌥⌘S on macOS) → screenshot. `?` → the shortcuts panel. Bindings are declarative
|
|
84
|
+
(`widget.keymap.register({...})`) — plugins register theirs the same way.
|
|
85
|
+
|
|
86
|
+
## Extending (plugin SDK)
|
|
87
|
+
|
|
88
|
+
```ts
|
|
89
|
+
import { registerChartType, registerRendererLayer } from 'vela/plugin';
|
|
90
|
+
|
|
91
|
+
// A new price style: bar transform + optional per-bar data engine + ticker modifier.
|
|
92
|
+
registerChartType({
|
|
93
|
+
id: 'renko-like',
|
|
94
|
+
label: 'Renko-like',
|
|
95
|
+
barTransform: { full: (bars) => transformAll(bars), next: (bar) => transformOne(bar) },
|
|
96
|
+
});
|
|
97
|
+
|
|
98
|
+
// A custom canvas layer, painted every frame with the chart (its id = its data channel).
|
|
99
|
+
registerRendererLayer({
|
|
100
|
+
id: 'renko-like',
|
|
101
|
+
placement: 'above-data',
|
|
102
|
+
create: () => ({ mount(canvas) {/* keep it */}, render({ bars, data, coords, scale, bounds }) {/* paint */} }),
|
|
103
|
+
});
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
A registered chart type automatically appears in the widget's style dropdown; a chart
|
|
107
|
+
type's `dataEngine` pushes to its layer's channel with zero extra wiring. See
|
|
108
|
+
[docs/contributing/plugin-sdk.md](docs/contributing/plugin-sdk.md).
|
|
109
|
+
|
|
110
|
+
## Documentation
|
|
111
|
+
|
|
112
|
+
Full documentation lives in [docs/](docs/index.md) — user guides ([quickstart](docs/user/quickstart.md),
|
|
113
|
+
[the widget](docs/user/widget.md), [options](docs/user/options.md), [API reference](docs/user/api-reference.md)),
|
|
114
|
+
[architecture](docs/architecture/overview.md), and [contributing](docs/contributing/setup.md) guides
|
|
115
|
+
including the [plugin SDK](docs/contributing/plugin-sdk.md).
|
|
116
|
+
|
|
117
|
+
## Development
|
|
118
|
+
|
|
119
|
+
```bash
|
|
120
|
+
npm install
|
|
121
|
+
npm run playground # vite playground on http://localhost:5190
|
|
122
|
+
npm test # vitest
|
|
123
|
+
npm run build # tsup → dist/
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
## License
|
|
127
|
+
|
|
128
|
+
Apache-2.0 **with a mandatory attribution notice** (see [NOTICE](NOTICE)): charts render
|
|
129
|
+
a small Vela attribution mark by default; it may be disabled
|
|
130
|
+
(`chart.renderer.set('attribution', false)`) only if an equivalent visible attribution —
|
|
131
|
+
"Vela" linking to the project page — is shown elsewhere on the same page. This is the
|
|
132
|
+
same licensing model as other popular charting libraries.
|
|
133
|
+
|
|
134
|
+
No scripting engine ships with this package; the Pine Script addon
|
|
135
|
+
(`@luxalgo/vela-pinets`) is AGPL-3.0 and licensed separately (see *Indicators*).
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
import { M as MarketConfig, O as OHLCV, U as Unsubscribe } from './options-Q-576hIi.cjs';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Symbol metadata an engine may need (e.g. Pine `syminfo.*`). Free-form beyond
|
|
5
|
+
* `ticker` — engines read the keys they understand and synthesize a fallback for
|
|
6
|
+
* the rest.
|
|
7
|
+
*/
|
|
8
|
+
interface SymbolInfo {
|
|
9
|
+
ticker: string;
|
|
10
|
+
[key: string]: unknown;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* The market-data abstraction. Vela OWNS the candles: it loads history and
|
|
14
|
+
* streams live ticks through this port, holds the one canonical bar array, and
|
|
15
|
+
* hands it to whichever engine executes. Decoupled from scripting so every
|
|
16
|
+
* registered engine shares the same dataset (no per-engine re-fetch).
|
|
17
|
+
*
|
|
18
|
+
* Swappable: the default is `MultiProviderFeed` (a registry of `DataProvider`s); tests
|
|
19
|
+
* inject a fake; a host app can supply its own backend.
|
|
20
|
+
*/
|
|
21
|
+
/** A bounded fetch window (epoch ms). `from`/`to` inclusive-ish; `limit` caps the count. */
|
|
22
|
+
interface BarRange {
|
|
23
|
+
/** Oldest bar open-time to fetch from (inclusive). */
|
|
24
|
+
from?: number;
|
|
25
|
+
/** Newest bar open-time to fetch to (defaults to "now" when omitted). */
|
|
26
|
+
to?: number;
|
|
27
|
+
/** Max bars. */
|
|
28
|
+
limit?: number;
|
|
29
|
+
}
|
|
30
|
+
interface MarketDataFeed {
|
|
31
|
+
/** Load the initial history (from a provider or the offline `data` array). */
|
|
32
|
+
load(cfg: MarketConfig): Promise<OHLCV[]>;
|
|
33
|
+
/** Subscribe to live forming-candle ticks. Returns an unsubscribe fn. */
|
|
34
|
+
subscribe(cfg: MarketConfig, onBar: (bar: OHLCV) => void): Unsubscribe;
|
|
35
|
+
/** Optional symbol metadata for engines that need it; absent/undefined ≡ engine synthesizes. */
|
|
36
|
+
symbolInfo?(cfg: MarketConfig): SymbolInfo | undefined;
|
|
37
|
+
/**
|
|
38
|
+
* Fetch a bounded range. Used by the cache to pull ONLY the uncached tail
|
|
39
|
+
* (newly-closed + forming bars) instead of re-downloading the whole window.
|
|
40
|
+
* Absent ≡ no ranged support; the cache falls back to a full `load`.
|
|
41
|
+
*/
|
|
42
|
+
loadRange?(cfg: MarketConfig, range: BarRange): Promise<OHLCV[]>;
|
|
43
|
+
/**
|
|
44
|
+
* Report that a symbol cannot be served by anything registered — the load is PARKED
|
|
45
|
+
* (it resumes if a capable provider registers later). Hosts surface this instead of
|
|
46
|
+
* leaving a silently blank chart. Absent ≡ the feed never parks.
|
|
47
|
+
*/
|
|
48
|
+
onUnresolved?(cb: (info: {
|
|
49
|
+
symbol: string;
|
|
50
|
+
providers: string[];
|
|
51
|
+
}) => void): Unsubscribe;
|
|
52
|
+
/** Release feed-owned resources (parked waits, timers). Absent ≡ nothing to release. */
|
|
53
|
+
destroy?(): void;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* A descriptor for one symbol a provider serves. Powers the eager index built at
|
|
58
|
+
* registration (for bare-symbol resolution) and symbol autocomplete.
|
|
59
|
+
*/
|
|
60
|
+
interface SymbolDescriptor {
|
|
61
|
+
/** The ticker exactly as the provider expects it (e.g. `BTCUSDT`, `BTCUSDT.P`). */
|
|
62
|
+
ticker: string;
|
|
63
|
+
/** Human-readable label (e.g. `Bitcoin / TetherUS`). */
|
|
64
|
+
description?: string;
|
|
65
|
+
/** Instrument class, free-form (e.g. `crypto`, `futures`, `stock`). */
|
|
66
|
+
type?: string;
|
|
67
|
+
/** Owning provider name — annotated by the registry aggregation (badges in pickers). */
|
|
68
|
+
provider?: string;
|
|
69
|
+
}
|
|
70
|
+
/** What a provider can do — lets the registry/UI reason without provider-specific checks. */
|
|
71
|
+
interface ProviderCapabilities {
|
|
72
|
+
/** Implements `listSymbols()` (enumeration → eager index + autocomplete). */
|
|
73
|
+
enumerate: boolean;
|
|
74
|
+
/** Implements `subscribe()` (true streaming; otherwise the feed polls `getBars`). */
|
|
75
|
+
stream: boolean;
|
|
76
|
+
/** Implements `getSymbolInfo()` (per-symbol metadata for engine `syminfo.*`). */
|
|
77
|
+
symbolInfo: boolean;
|
|
78
|
+
}
|
|
79
|
+
/** Provider metadata, surfaced via `chart.data.providers()`. */
|
|
80
|
+
interface ProviderInfo {
|
|
81
|
+
/** Stable id (the registration name, lower-cased). */
|
|
82
|
+
name: string;
|
|
83
|
+
/** Display label (e.g. `Binance`). */
|
|
84
|
+
displayName?: string;
|
|
85
|
+
/** Whether the provider needs `configure()` before use. */
|
|
86
|
+
requiresApiKey?: boolean;
|
|
87
|
+
/** Timeframes the provider serves (canonical strings); informational. */
|
|
88
|
+
supportedTimeframes?: readonly string[];
|
|
89
|
+
capabilities: ProviderCapabilities;
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* A market-data source for ONE venue, neutral to Vela (no scripting-engine types). Register
|
|
93
|
+
* one with `chart.data.registerProvider(name, provider)`; the registry routes any
|
|
94
|
+
* `name:SYMBOL` (or bare `SYMBOL` it indexes) to it.
|
|
95
|
+
*
|
|
96
|
+
* Only `getBars` is required. Everything else is a progressive capability the
|
|
97
|
+
* registry uses when present and degrades around when absent — the same
|
|
98
|
+
* philosophy as the {@link MarketDataFeed} port.
|
|
99
|
+
*/
|
|
100
|
+
interface DataProvider {
|
|
101
|
+
/**
|
|
102
|
+
* Fetch bars for `ticker`/`timeframe`. `ticker` is exactly what the user typed
|
|
103
|
+
* minus any `provider:` prefix; any `.ext` suffix is KEPT (the provider owns its
|
|
104
|
+
* meaning — e.g. Binance `.P` = perpetual). The newest bar is treated as the
|
|
105
|
+
* forming candle. Bars: `{ time (open, epoch ms), open, high, low, close, volume? }`,
|
|
106
|
+
* sorted + de-duplicated by open-time.
|
|
107
|
+
*/
|
|
108
|
+
getBars(ticker: string, timeframe: string, range: BarRange): Promise<OHLCV[]>;
|
|
109
|
+
/** Provider metadata. Absent ⇒ the registry synthesizes a record from the methods present. */
|
|
110
|
+
info?(): ProviderInfo;
|
|
111
|
+
/**
|
|
112
|
+
* Enumerate the symbols this provider serves — drives the eager index built when
|
|
113
|
+
* the provider registers. Absent ⇒ no index: the provider can only be reached by
|
|
114
|
+
* an explicit `name:SYMBOL` prefix, never by resolving a bare symbol.
|
|
115
|
+
*/
|
|
116
|
+
listSymbols?(): Promise<SymbolDescriptor[]>;
|
|
117
|
+
/** Per-symbol metadata for engine `syminfo.*`. Absent ⇒ the engine synthesizes a fallback. */
|
|
118
|
+
getSymbolInfo?(ticker: string): Promise<SymbolInfo | undefined>;
|
|
119
|
+
/**
|
|
120
|
+
* Open a true live stream for `ticker`/`timeframe`. Each call to `onBar` delivers
|
|
121
|
+
* the forming candle (or a freshly-closed one). Returns an unsubscribe fn. Absent
|
|
122
|
+
* ⇒ the feed polls `getBars` for ticks instead.
|
|
123
|
+
*/
|
|
124
|
+
subscribe?(ticker: string, timeframe: string, onBar: (bar: OHLCV) => void): Unsubscribe;
|
|
125
|
+
/** Apply runtime config (e.g. API keys). Absent ⇒ no configuration needed. */
|
|
126
|
+
configure?(config: unknown): void;
|
|
127
|
+
/**
|
|
128
|
+
* Capabilities for ONE ticker, when they vary by instrument class within the venue.
|
|
129
|
+
* Absent ⇒ {@link ProviderInfo.capabilities} applies uniformly to every symbol.
|
|
130
|
+
*/
|
|
131
|
+
capabilitiesFor?(ticker: string): ProviderCapabilities;
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
export type { BarRange as B, DataProvider as D, MarketDataFeed as M, ProviderInfo as P, SymbolInfo as S, SymbolDescriptor as a, ProviderCapabilities as b };
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
import { M as MarketConfig, O as OHLCV, U as Unsubscribe } from './options-Q-576hIi.js';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Symbol metadata an engine may need (e.g. Pine `syminfo.*`). Free-form beyond
|
|
5
|
+
* `ticker` — engines read the keys they understand and synthesize a fallback for
|
|
6
|
+
* the rest.
|
|
7
|
+
*/
|
|
8
|
+
interface SymbolInfo {
|
|
9
|
+
ticker: string;
|
|
10
|
+
[key: string]: unknown;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* The market-data abstraction. Vela OWNS the candles: it loads history and
|
|
14
|
+
* streams live ticks through this port, holds the one canonical bar array, and
|
|
15
|
+
* hands it to whichever engine executes. Decoupled from scripting so every
|
|
16
|
+
* registered engine shares the same dataset (no per-engine re-fetch).
|
|
17
|
+
*
|
|
18
|
+
* Swappable: the default is `MultiProviderFeed` (a registry of `DataProvider`s); tests
|
|
19
|
+
* inject a fake; a host app can supply its own backend.
|
|
20
|
+
*/
|
|
21
|
+
/** A bounded fetch window (epoch ms). `from`/`to` inclusive-ish; `limit` caps the count. */
|
|
22
|
+
interface BarRange {
|
|
23
|
+
/** Oldest bar open-time to fetch from (inclusive). */
|
|
24
|
+
from?: number;
|
|
25
|
+
/** Newest bar open-time to fetch to (defaults to "now" when omitted). */
|
|
26
|
+
to?: number;
|
|
27
|
+
/** Max bars. */
|
|
28
|
+
limit?: number;
|
|
29
|
+
}
|
|
30
|
+
interface MarketDataFeed {
|
|
31
|
+
/** Load the initial history (from a provider or the offline `data` array). */
|
|
32
|
+
load(cfg: MarketConfig): Promise<OHLCV[]>;
|
|
33
|
+
/** Subscribe to live forming-candle ticks. Returns an unsubscribe fn. */
|
|
34
|
+
subscribe(cfg: MarketConfig, onBar: (bar: OHLCV) => void): Unsubscribe;
|
|
35
|
+
/** Optional symbol metadata for engines that need it; absent/undefined ≡ engine synthesizes. */
|
|
36
|
+
symbolInfo?(cfg: MarketConfig): SymbolInfo | undefined;
|
|
37
|
+
/**
|
|
38
|
+
* Fetch a bounded range. Used by the cache to pull ONLY the uncached tail
|
|
39
|
+
* (newly-closed + forming bars) instead of re-downloading the whole window.
|
|
40
|
+
* Absent ≡ no ranged support; the cache falls back to a full `load`.
|
|
41
|
+
*/
|
|
42
|
+
loadRange?(cfg: MarketConfig, range: BarRange): Promise<OHLCV[]>;
|
|
43
|
+
/**
|
|
44
|
+
* Report that a symbol cannot be served by anything registered — the load is PARKED
|
|
45
|
+
* (it resumes if a capable provider registers later). Hosts surface this instead of
|
|
46
|
+
* leaving a silently blank chart. Absent ≡ the feed never parks.
|
|
47
|
+
*/
|
|
48
|
+
onUnresolved?(cb: (info: {
|
|
49
|
+
symbol: string;
|
|
50
|
+
providers: string[];
|
|
51
|
+
}) => void): Unsubscribe;
|
|
52
|
+
/** Release feed-owned resources (parked waits, timers). Absent ≡ nothing to release. */
|
|
53
|
+
destroy?(): void;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* A descriptor for one symbol a provider serves. Powers the eager index built at
|
|
58
|
+
* registration (for bare-symbol resolution) and symbol autocomplete.
|
|
59
|
+
*/
|
|
60
|
+
interface SymbolDescriptor {
|
|
61
|
+
/** The ticker exactly as the provider expects it (e.g. `BTCUSDT`, `BTCUSDT.P`). */
|
|
62
|
+
ticker: string;
|
|
63
|
+
/** Human-readable label (e.g. `Bitcoin / TetherUS`). */
|
|
64
|
+
description?: string;
|
|
65
|
+
/** Instrument class, free-form (e.g. `crypto`, `futures`, `stock`). */
|
|
66
|
+
type?: string;
|
|
67
|
+
/** Owning provider name — annotated by the registry aggregation (badges in pickers). */
|
|
68
|
+
provider?: string;
|
|
69
|
+
}
|
|
70
|
+
/** What a provider can do — lets the registry/UI reason without provider-specific checks. */
|
|
71
|
+
interface ProviderCapabilities {
|
|
72
|
+
/** Implements `listSymbols()` (enumeration → eager index + autocomplete). */
|
|
73
|
+
enumerate: boolean;
|
|
74
|
+
/** Implements `subscribe()` (true streaming; otherwise the feed polls `getBars`). */
|
|
75
|
+
stream: boolean;
|
|
76
|
+
/** Implements `getSymbolInfo()` (per-symbol metadata for engine `syminfo.*`). */
|
|
77
|
+
symbolInfo: boolean;
|
|
78
|
+
}
|
|
79
|
+
/** Provider metadata, surfaced via `chart.data.providers()`. */
|
|
80
|
+
interface ProviderInfo {
|
|
81
|
+
/** Stable id (the registration name, lower-cased). */
|
|
82
|
+
name: string;
|
|
83
|
+
/** Display label (e.g. `Binance`). */
|
|
84
|
+
displayName?: string;
|
|
85
|
+
/** Whether the provider needs `configure()` before use. */
|
|
86
|
+
requiresApiKey?: boolean;
|
|
87
|
+
/** Timeframes the provider serves (canonical strings); informational. */
|
|
88
|
+
supportedTimeframes?: readonly string[];
|
|
89
|
+
capabilities: ProviderCapabilities;
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* A market-data source for ONE venue, neutral to Vela (no scripting-engine types). Register
|
|
93
|
+
* one with `chart.data.registerProvider(name, provider)`; the registry routes any
|
|
94
|
+
* `name:SYMBOL` (or bare `SYMBOL` it indexes) to it.
|
|
95
|
+
*
|
|
96
|
+
* Only `getBars` is required. Everything else is a progressive capability the
|
|
97
|
+
* registry uses when present and degrades around when absent — the same
|
|
98
|
+
* philosophy as the {@link MarketDataFeed} port.
|
|
99
|
+
*/
|
|
100
|
+
interface DataProvider {
|
|
101
|
+
/**
|
|
102
|
+
* Fetch bars for `ticker`/`timeframe`. `ticker` is exactly what the user typed
|
|
103
|
+
* minus any `provider:` prefix; any `.ext` suffix is KEPT (the provider owns its
|
|
104
|
+
* meaning — e.g. Binance `.P` = perpetual). The newest bar is treated as the
|
|
105
|
+
* forming candle. Bars: `{ time (open, epoch ms), open, high, low, close, volume? }`,
|
|
106
|
+
* sorted + de-duplicated by open-time.
|
|
107
|
+
*/
|
|
108
|
+
getBars(ticker: string, timeframe: string, range: BarRange): Promise<OHLCV[]>;
|
|
109
|
+
/** Provider metadata. Absent ⇒ the registry synthesizes a record from the methods present. */
|
|
110
|
+
info?(): ProviderInfo;
|
|
111
|
+
/**
|
|
112
|
+
* Enumerate the symbols this provider serves — drives the eager index built when
|
|
113
|
+
* the provider registers. Absent ⇒ no index: the provider can only be reached by
|
|
114
|
+
* an explicit `name:SYMBOL` prefix, never by resolving a bare symbol.
|
|
115
|
+
*/
|
|
116
|
+
listSymbols?(): Promise<SymbolDescriptor[]>;
|
|
117
|
+
/** Per-symbol metadata for engine `syminfo.*`. Absent ⇒ the engine synthesizes a fallback. */
|
|
118
|
+
getSymbolInfo?(ticker: string): Promise<SymbolInfo | undefined>;
|
|
119
|
+
/**
|
|
120
|
+
* Open a true live stream for `ticker`/`timeframe`. Each call to `onBar` delivers
|
|
121
|
+
* the forming candle (or a freshly-closed one). Returns an unsubscribe fn. Absent
|
|
122
|
+
* ⇒ the feed polls `getBars` for ticks instead.
|
|
123
|
+
*/
|
|
124
|
+
subscribe?(ticker: string, timeframe: string, onBar: (bar: OHLCV) => void): Unsubscribe;
|
|
125
|
+
/** Apply runtime config (e.g. API keys). Absent ⇒ no configuration needed. */
|
|
126
|
+
configure?(config: unknown): void;
|
|
127
|
+
/**
|
|
128
|
+
* Capabilities for ONE ticker, when they vary by instrument class within the venue.
|
|
129
|
+
* Absent ⇒ {@link ProviderInfo.capabilities} applies uniformly to every symbol.
|
|
130
|
+
*/
|
|
131
|
+
capabilitiesFor?(ticker: string): ProviderCapabilities;
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
export type { BarRange as B, DataProvider as D, MarketDataFeed as M, ProviderInfo as P, SymbolInfo as S, SymbolDescriptor as a, ProviderCapabilities as b };
|