openalgo-script 0.1.0-alpha.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and do
+          not modify the License. You may add Your own attribution notices
+          within Derivative Works that You distribute, alongside or as an
+          addendum to the NOTICE text from the Work, provided that such
+          additional attribution notices cannot be construed as modifying
+          the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 OpenAlgo
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,12 @@
+OpenScript
+Copyright 2026 OpenScript contributors
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License. You may obtain a copy of the
+License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+OpenScript is an independent open source language. It is not affiliated with,
+sponsored by, or endorsed by any charting or trading platform. Its
+specification, documentation, error text and implementation are original work.

package/README.md

@@ -0,0 +1,255 @@
+<div align="center">
+
+# OpenScript
+
+**An open trading language. Write a study or a strategy once, plot it, backtest it, trade it.**
+
+Compiles in the browser in milliseconds with no build step and no `eval`, runs
+the same compiled program on a server, and is specified well enough that anyone
+can write their own engine for it.
+
+[![license](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](./LICENSE)
+[![status](https://img.shields.io/badge/status-early%20development-orange.svg)](./ROADMAP.md)
+
+</div>
+
+---
+
+## Status
+
+Early development. The specification is being written first, and the
+implementation follows it. Nothing here is stable yet. Watch
+[ROADMAP.md](./ROADMAP.md) for what lands when.
+
+## What it looks like
+
+```
+study("EMA cross", overlay = true)
+
+fast = input(9,  "Fast")
+slow = input(21, "Slow")
+
+ef = ema(close, fast)
+es = ema(close, slow)
+
+plot(ef, "Fast", aqua)
+plot(es, "Slow", orange)
+
+if crossUp(ef, es)
+    signal("BUY")
+```
+
+The same file becomes a strategy by adding orders:
+
+```
+strategy("EMA cross", overlay = true)
+
+if crossUp(ef, es)
+    buy(qty = 1)
+
+if crossDown(ef, es)
+    close()
+```
+
+One script. One set of numbers on the chart, in the backtest, and in the market.
+
+## Why it exists
+
+Chart scripting today is closed. You write in someone's editor, your script runs
+on their servers under their limits, and the only way out is a webhook. The
+numbers you backtest are not the numbers you trade, and you cannot check either.
+
+OpenScript is the opposite of that:
+
+- **Yours.** Plain text files in a folder. Version control, diffs, your own editor.
+- **Local.** It compiles and runs on your machine. No execution quota, no loop
+  timeout, no cap on how many things you may draw.
+- **Honest.** A higher timeframe read has to say whether it repaints. The
+  compiler warns when a script would.
+- **Connected.** The same script places real orders through your own broker
+  connection, on paper by default.
+- **Open.** Apache-2.0, a written specification, and a conformance suite anyone
+  can run against their own implementation.
+
+## How it is built
+
+The compiler does not emit JavaScript. It emits a **compiled program**: a plain
+data structure of instructions, defined by a versioned schema.
+
+That one decision carries the whole project:
+
+1. It runs in a browser under a strict content security policy, with no `eval`
+   and nothing for a security team to approve.
+2. A server-side engine is a few hundred lines that walk an instruction list,
+   not a second implementation of the language.
+3. Anyone can write an engine in any language, and prove it correct by running
+   the conformance suite.
+
+One compiler. One compiled format. Many small engines, all of which must agree
+to the last decimal.
+
+The same decision shapes the editor. This project ships the language
+intelligence as pure functions with no DOM: highlight, complete, diagnose, hover,
+signature, format. Highlighting comes from the real lexer, completions from the
+standard library manifest, and the errors you see while typing are the compiler's
+own, with their fixes taken from the error catalogue. A host supplies the text
+component and the panel around it, and keeps its own design. The editor is not a
+second implementation of the language to be kept in step.
+
+```
+source text
+   -> tokens
+   -> tree
+   -> checked tree        (errors carry a code, a line and a fix)
+   -> compiled program    (plain data, versioned schema)
+   -> any engine          (browser, server, yours)
+```
+
+## The pieces, and which way they point
+
+A platform adopting OpenScript usually already has a chart, or an editor, or a
+broker connection, and sometimes all three. So the pieces are separate packages
+and the dependencies only ever point one way.
+
+```
+   openalgo-script            a chart library
+   (knows nobody)             (knows nobody)
+        |      \              /
+        |       \            /
+        |   .../adapters/charts       <- knows both. The only place that does
+        |
+   .../editor
+        |
+   .../adapters/codemirror            <- knows the editor component. Nothing else does
+```
+
+The language ships as one package with an entry point per tier, so a consumer who
+wants only the compiler never pays for an adapter. A tier is declared only once it
+exists: an entry point that resolves to nothing fails at a consumer's run time
+rather than honestly at install.
+
+| Entry point | Is | Depends on |
+|---|---|---|
+| `openalgo-script` | Compiler and engine | Nothing |
+| `openalgo-script/editor` | Highlight, complete, diagnose, hover, signature, format. No DOM | The compiler |
+| `openalgo-script/adapters/charts` | Turns a compiled study into a chart's indicator descriptor | The compiler and a chart |
+| `openalgo-script/adapters/codemirror` | A drop-in editor language package | The editor half and an editor component |
+| The Python engine, on its own index | The same compiled program, run on a server | Nothing |
+
+An adapter is the only thing allowed to know two worlds at once, which is what
+makes it the piece a platform replaces rather than the piece they patch. A
+platform with its own chart writes their own chart adapter and keeps everything
+else. A platform with its own editor does the same on that side.
+
+This is enforced rather than promised. `scripts/check-layering.mjs` runs in
+continuous integration and fails the build if the compiler imports a chart, if
+anything outside an adapter imports a package, or if the compiler or the editor
+half so much as mentions a browser global.
+
+## Taking it, one step at a time
+
+Each row is usable on its own. Nobody has to take the next one.
+
+| You want | You add | Roughly |
+|---|---|---|
+| Scripts that produce numbers | `openalgo-script`, and the six-item host interface | An afternoon |
+| Those studies on your chart | the charts adapter, plus a chart | Days. Free if the chart is the one this adapter already targets |
+| Traders authoring in your app | `openalgo-script/editor`, and your own text component or the drop-in one | Days |
+| Traders trading from it | Wire the order half of the host interface to your order API | About a week |
+| To run it on your own stack | Implement the compiled program format in your language, then pass the conformance suite | Weeks |
+
+The last row is the one that matters for the standard. A platform that will not
+run our code at all reads the compiled program specification, writes its own
+engine, passes the suite, and its traders' scripts are the same scripts as
+everyone else's.
+
+## What is guaranteed, and what proves it
+
+A platform's engineering review asks two questions about a dependency: what do you
+promise, and how would I know. This table is the answer to the second one. Where a
+row says a check enforces something, that check runs in continuous integration and
+fails the build.
+
+| Guarantee | How you can tell | Today |
+|---|---|---|
+| No `eval`, no generated code, runs under a strict content security policy | Grep the source. There is no code construction anywhere, and the compiler emits data | Enforced |
+| Zero runtime dependencies | `dependencies` is empty and stays empty | Enforced |
+| The pieces are separable: take the language without the chart, or the chart without the language | `scripts/check-layering.mjs`. The core may not import a package or touch a browser global | Enforced |
+| Small modules with a stated surface | `scripts/check-modularity.mjs`. A module's index is its only door | Enforced |
+| Every error is documented, with a code, a cause and a fix | `scripts/check-error-codes.mjs`, and the code type is generated from the catalogue so an invented code will not compile | Enforced |
+| No fact is stated in two places | `scripts/check-duplication.mjs` | Enforced, with recorded debt |
+| The compiled program is implementable without reading our code | `spec/compiled-program.md` and `spec/host-interface.md` | Written |
+| Two engines agree to the last decimal | The conformance suite, run against both. A disagreement blocks a release | Phase 6 gate |
+| A runaway script stops | Instruction, memory and wall clock budgets, enforced by the engine that owns the loop | Phase 2 gate |
+| A failing script does not take anything else down | One script's failure is a diagnostic on that script | Phase 2 gate |
+| A saved script never stops working | The language version is declared per file and old front ends are retained | Phase 7, with a test per retained version |
+| Performance | A benchmark with a number, in continuous integration | Phase 2 gate |
+
+The rows marked as gates are not promises we intend to keep. They are conditions a
+phase does not finish without, and each one is written into the roadmap beside the
+phase that owes it.
+
+### Why a script cannot reach anything
+
+This is the row a security review spends its time on, so it is worth stating
+plainly rather than leaving as a property of the architecture.
+
+A compiled program is **data**. It is a list of instructions the engine walks. A
+script has no way to name a function the instruction set does not expose, so there
+is no call into the host, no network, no filesystem, no access to the object graph
+of the process it runs in. There is nothing to escape from, because nothing was
+ever handed over.
+
+That also makes the budgets real rather than best-effort. The engine owns the
+loop, so an instruction count per bar, a memory ceiling and a wall clock are
+counters in that loop rather than something to hope about. A platform running many
+customers' scripts in one process needs exactly this, and a design that generates
+code and runs it cannot offer it.
+
+## The host interface
+
+Whatever a platform takes, it supplies six things and nothing more:
+
+1. Bars: open, high, low, close, volume, time.
+2. Instrument facts: tick size, lot size, session, timezone.
+3. More bars on request, for another instrument or another timeframe.
+4. Somewhere to draw.
+5. Somewhere to send orders, if scripts are allowed to trade.
+6. Somewhere to save settings.
+
+No instrument naming scheme, no exchange rules and no broker concepts appear in
+the language. A symbol is opaque to it: a script names a contract by what the
+contract is, and the platform resolves that to whatever its own symbology calls
+it. A format built around one market's derivatives means nothing on a crypto
+exchange, and portability is the entire objective.
+
+## Errors
+
+Every error has a stable code, a message, the cause, the fix and an example,
+held in one machine-readable catalogue. The compiler, the editor and the
+documentation all read that same file, so the documentation cannot drift from
+the compiler. The build fails if an error exists without a documented entry, or
+an entry without a test.
+
+## Documentation
+
+- [ROADMAP.md](./ROADMAP.md) - what is being built, in what order
+- [docs/](./docs) - guides, once there is something to guide
+- [spec/](./spec) - the language specification and the compiled program schema
+- [CONTRIBUTING.md](./CONTRIBUTING.md) - how to work on this
+- [RELEASING.md](./RELEASING.md) - how a release is published, and the one manual step that cannot be automated
+
+## Licence
+
+Apache-2.0. See [LICENSE](./LICENSE) and [NOTICE](./NOTICE).
+
+Apache-2.0 was chosen deliberately over a copyleft licence. A trading platform
+that wants to embed OpenScript must be able to do so without publishing its own
+source, or the language cannot become a shared standard.
+
+## A note on independence
+
+OpenScript is an independent open source language. It is not affiliated with,
+sponsored by, or endorsed by any charting or trading platform, and it is not a
+reimplementation of any existing product. Its specification, its documentation
+and its error text are original work.

package/dist/core/ast/annotations.d.ts

@@ -0,0 +1,56 @@
+import type { Positioned } from '../span/index.js';
+/**
+ * A type as a script writes it, on a parameter, a `var` or a function result.
+ *
+ * The tree keeps the words rather than a resolved type. A resolved type is the
+ * checker's, it has no source position, and it exists for expressions that were
+ * never annotated at all; an annotation is a piece of syntax with a span that a
+ * caret can land on.
+ */
+/** The types a value can have, language.md 5.1. */
+export declare const VALUE_TYPE_NAMES: readonly ["number", "string", "bool", "color"];
+export type ValueTypeName = (typeof VALUE_TYPE_NAMES)[number];
+/**
+ * The runtime object types of language.md 5.4.
+ *
+ * These five are recognised in a type position only and are ordinary global
+ * function names everywhere else, which is why they are not reserved words. The
+ * declaration handle types `plot`, `fill` and `level` are deliberately missing:
+ * a handle can never be a `var`, a parameter, a result or an array element, so
+ * it can never be annotated.
+ */
+export declare const OBJECT_TYPE_NAMES: readonly ["line", "label", "box", "polyline", "table"];
+export type ObjectTypeName = (typeof OBJECT_TYPE_NAMES)[number];
+export declare function isValueTypeName(text: string): text is ValueTypeName;
+export declare function isObjectTypeName(text: string): text is ObjectTypeName;
+/**
+ * A type written as one word.
+ *
+ * The word is an arbitrary string rather than one of the two unions above,
+ * because "that is not a type" is OS2016 and OS2016 is a check, not a parse
+ * error. A parser that could only build a legal annotation would have to report
+ * a syntax error at `len: whole`, and the reader would get a caret and no
+ * sentence naming the types that do exist.
+ */
+export interface NamedType extends Positioned {
+    readonly kind: 'namedType';
+    readonly name: string;
+}
+/** `series number`: one value of the element type per bar, language.md 5.2. */
+export interface SeriesType extends Positioned {
+    readonly kind: 'seriesType';
+    readonly element: TypeAnnotation;
+}
+/**
+ * `array<number>`, language.md 14.1.
+ *
+ * The element is any annotation and not just a legal element type, for the
+ * reason `namedType` holds any word: `array<plot>` has to reach the checker so
+ * that OS2019 can name the types an array does hold.
+ */
+export interface ArrayType extends Positioned {
+    readonly kind: 'arrayType';
+    readonly element: TypeAnnotation;
+}
+export type TypeAnnotation = NamedType | SeriesType | ArrayType;
+//# sourceMappingURL=annotations.d.ts.map

package/dist/core/ast/annotations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"annotations.d.ts","sourceRoot":"","sources":["../../../src/core/ast/annotations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD;;;;;;;GAOG;AAEH,mDAAmD;AACnD,eAAO,MAAM,gBAAgB,gDAAiD,CAAC;AAC/E,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE9D;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB,wDAAyD,CAAC;AACxF,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEhE,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,aAAa,CAEnE;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,cAAc,CAErE;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,SAAU,SAAQ,UAAU;IAC3C,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,+EAA+E;AAC/E,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;CAClC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,SAAU,SAAQ,UAAU;IAC3C,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;CAClC;AAED,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,CAAC"}

package/dist/core/ast/annotations.js

@@ -0,0 +1,27 @@
+/**
+ * A type as a script writes it, on a parameter, a `var` or a function result.
+ *
+ * The tree keeps the words rather than a resolved type. A resolved type is the
+ * checker's, it has no source position, and it exists for expressions that were
+ * never annotated at all; an annotation is a piece of syntax with a span that a
+ * caret can land on.
+ */
+/** The types a value can have, language.md 5.1. */
+export const VALUE_TYPE_NAMES = ['number', 'string', 'bool', 'color'];
+/**
+ * The runtime object types of language.md 5.4.
+ *
+ * These five are recognised in a type position only and are ordinary global
+ * function names everywhere else, which is why they are not reserved words. The
+ * declaration handle types `plot`, `fill` and `level` are deliberately missing:
+ * a handle can never be a `var`, a parameter, a result or an array element, so
+ * it can never be annotated.
+ */
+export const OBJECT_TYPE_NAMES = ['line', 'label', 'box', 'polyline', 'table'];
+export function isValueTypeName(text) {
+    return VALUE_TYPE_NAMES.includes(text);
+}
+export function isObjectTypeName(text) {
+    return OBJECT_TYPE_NAMES.includes(text);
+}
+//# sourceMappingURL=annotations.js.map

package/dist/core/ast/annotations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"annotations.js","sourceRoot":"","sources":["../../../src/core/ast/annotations.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AAEH,mDAAmD;AACnD,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAU,CAAC;AAG/E;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,CAAU,CAAC;AAGxF,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,OAAQ,gBAAsC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,IAAY;IAC3C,OAAQ,iBAAuC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACjE,CAAC"}

package/dist/core/ast/build.d.ts

@@ -0,0 +1,25 @@
+import type { Span } from '../span/index.js';
+import type { NodeKind, NodeOfKind } from './node.js';
+/** Everything a node of one kind carries beyond its kind and its span. */
+export type NodeFields<K extends NodeKind> = Omit<NodeOfKind<K>, 'kind' | 'span'>;
+/**
+ * Builds any node.
+ *
+ * One constructor rather than forty two, because forty two would be a second
+ * place that has to agree with the interfaces, and the day one of them drifts
+ * is the day a field goes missing from a tree that still type checks at every
+ * call site. Here the fields are the interface, minus the two parts every node
+ * has, so a missing field, a misspelt one and a stray one are each a compile
+ * error at the parser's own line.
+ *
+ * It also reads as what it builds. `makeNode('binary', span, { operator, left,
+ * right })` names its three parts, where a positional constructor of the same
+ * arity would let a parser swap two of them and compile.
+ *
+ * No field is optional. A slot a script may leave out, such as a `step` or an
+ * `else`, is `undefined` and still has to be passed, because a parser that
+ * forgets one should hear about it rather than produce a node that is missing
+ * a branch.
+ */
+export declare function makeNode<K extends NodeKind>(kind: K, span: Span, fields: NodeFields<K>): NodeOfKind<K>;
+//# sourceMappingURL=build.d.ts.map

package/dist/core/ast/build.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../../src/core/ast/build.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAEtD,0EAA0E;AAC1E,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;AAElF;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,QAAQ,EACzC,IAAI,EAAE,CAAC,EACP,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,GACpB,UAAU,CAAC,CAAC,CAAC,CAKf"}

package/dist/core/ast/build.js

@@ -0,0 +1,26 @@
+/**
+ * Builds any node.
+ *
+ * One constructor rather than forty two, because forty two would be a second
+ * place that has to agree with the interfaces, and the day one of them drifts
+ * is the day a field goes missing from a tree that still type checks at every
+ * call site. Here the fields are the interface, minus the two parts every node
+ * has, so a missing field, a misspelt one and a stray one are each a compile
+ * error at the parser's own line.
+ *
+ * It also reads as what it builds. `makeNode('binary', span, { operator, left,
+ * right })` names its three parts, where a positional constructor of the same
+ * arity would let a parser swap two of them and compile.
+ *
+ * No field is optional. A slot a script may leave out, such as a `step` or an
+ * `else`, is `undefined` and still has to be passed, because a parser that
+ * forgets one should hear about it rather than produce a node that is missing
+ * a branch.
+ */
+export function makeNode(kind, span, fields) {
+    // The spread of a generic Omit cannot be proved to reconstruct the node it
+    // was taken from, so the one assertion in the module is here, where the
+    // signature above has already checked every field of every call.
+    return { ...fields, kind, span };
+}
+//# sourceMappingURL=build.js.map

package/dist/core/ast/build.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"build.js","sourceRoot":"","sources":["../../../src/core/ast/build.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,QAAQ,CACtB,IAAO,EACP,IAAU,EACV,MAAqB;IAErB,2EAA2E;IAC3E,wEAAwE;IACxE,iEAAiE;IACjE,OAAO,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,IAAI,EAA8B,CAAC;AAC/D,CAAC"}

package/dist/core/ast/children.d.ts

@@ -0,0 +1,15 @@
+import type { AstNode } from './node.js';
+/**
+ * The children of a node, in source order.
+ *
+ * This is the only place the shape of the tree is written down twice, and it is
+ * deliberately the only one. Everything that walks the tree walks it through
+ * here, so a field added to a node is connected once and every pass sees it,
+ * rather than being connected in the checker, forgotten in the code generator,
+ * and found by a user whose script compiled to something with a hole in it.
+ *
+ * The switch has no default arm on purpose: a new node kind stops the build
+ * here, at the one place that has to know about it.
+ */
+export declare function childrenOf(node: AstNode): readonly AstNode[];
+//# sourceMappingURL=children.d.ts.map

package/dist/core/ast/children.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"children.d.ts","sourceRoot":"","sources":["../../../src/core/ast/children.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AASzC;;;;;;;;;;;GAWG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,OAAO,GAAG,SAAS,OAAO,EAAE,CAwF5D"}