@math.gl/sql 0.0.0-stage → 5.0.0-beta.12

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.
Files changed (353) hide show
  1. package/LICENSE +249 -0
  2. package/README.md +26 -2
  3. package/THIRD-PARTY-NOTICES.md +5 -0
  4. package/dist/arrow/aggregates.d.ts +46 -0
  5. package/dist/arrow/aggregates.d.ts.map +1 -0
  6. package/dist/arrow/aggregates.js +289 -0
  7. package/dist/arrow/aggregates.js.map +1 -0
  8. package/dist/arrow/buffers.d.ts +30 -0
  9. package/dist/arrow/buffers.d.ts.map +1 -0
  10. package/dist/arrow/buffers.js +177 -0
  11. package/dist/arrow/buffers.js.map +1 -0
  12. package/dist/arrow/cast.d.ts +19 -0
  13. package/dist/arrow/cast.d.ts.map +1 -0
  14. package/dist/arrow/cast.js +138 -0
  15. package/dist/arrow/cast.js.map +1 -0
  16. package/dist/arrow/compiler.d.ts +10 -0
  17. package/dist/arrow/compiler.d.ts.map +1 -0
  18. package/dist/arrow/compiler.js +1538 -0
  19. package/dist/arrow/compiler.js.map +1 -0
  20. package/dist/arrow/float16.d.ts +7 -0
  21. package/dist/arrow/float16.d.ts.map +1 -0
  22. package/dist/arrow/float16.js +26 -0
  23. package/dist/arrow/float16.js.map +1 -0
  24. package/dist/arrow/index.cjs +3321 -0
  25. package/dist/arrow/index.cjs.map +6 -0
  26. package/dist/arrow/index.d.ts +5 -0
  27. package/dist/arrow/index.d.ts.map +1 -0
  28. package/dist/arrow/index.js +7 -0
  29. package/dist/arrow/index.js.map +1 -0
  30. package/dist/arrow/like.d.ts +3 -0
  31. package/dist/arrow/like.d.ts.map +1 -0
  32. package/dist/arrow/like.js +75 -0
  33. package/dist/arrow/like.js.map +1 -0
  34. package/dist/arrow/list-values.d.ts +14 -0
  35. package/dist/arrow/list-values.d.ts.map +1 -0
  36. package/dist/arrow/list-values.js +201 -0
  37. package/dist/arrow/list-values.js.map +1 -0
  38. package/dist/arrow/predicate.d.ts +7 -0
  39. package/dist/arrow/predicate.d.ts.map +1 -0
  40. package/dist/arrow/predicate.js +10 -0
  41. package/dist/arrow/predicate.js.map +1 -0
  42. package/dist/arrow/query-arrow-aggregate-snapshots.d.ts +24 -0
  43. package/dist/arrow/query-arrow-aggregate-snapshots.d.ts.map +1 -0
  44. package/dist/arrow/query-arrow-aggregate-snapshots.js +64 -0
  45. package/dist/arrow/query-arrow-aggregate-snapshots.js.map +1 -0
  46. package/dist/arrow/query-arrow-sql.d.ts +8 -0
  47. package/dist/arrow/query-arrow-sql.d.ts.map +1 -0
  48. package/dist/arrow/query-arrow-sql.js +223 -0
  49. package/dist/arrow/query-arrow-sql.js.map +1 -0
  50. package/dist/arrow/query-arrow-table.d.ts +36 -0
  51. package/dist/arrow/query-arrow-table.d.ts.map +1 -0
  52. package/dist/arrow/query-arrow-table.js +208 -0
  53. package/dist/arrow/query-arrow-table.js.map +1 -0
  54. package/dist/arrow/query-worker-entry.d.ts +2 -0
  55. package/dist/arrow/query-worker-entry.d.ts.map +1 -0
  56. package/dist/arrow/query-worker-entry.js +7 -0
  57. package/dist/arrow/query-worker-entry.js.map +1 -0
  58. package/dist/arrow/query-worker.d.ts +65 -0
  59. package/dist/arrow/query-worker.d.ts.map +1 -0
  60. package/dist/arrow/query-worker.js +135 -0
  61. package/dist/arrow/query-worker.js.map +1 -0
  62. package/dist/arrow/registry.d.ts +4 -0
  63. package/dist/arrow/registry.d.ts.map +1 -0
  64. package/dist/arrow/registry.js +66 -0
  65. package/dist/arrow/registry.js.map +1 -0
  66. package/dist/arrow/relational-query.d.ts +36 -0
  67. package/dist/arrow/relational-query.d.ts.map +1 -0
  68. package/dist/arrow/relational-query.js +174 -0
  69. package/dist/arrow/relational-query.js.map +1 -0
  70. package/dist/arrow/replace-arrow-columns.d.ts +8 -0
  71. package/dist/arrow/replace-arrow-columns.d.ts.map +1 -0
  72. package/dist/arrow/replace-arrow-columns.js +63 -0
  73. package/dist/arrow/replace-arrow-columns.js.map +1 -0
  74. package/dist/arrow/signature.d.ts +6 -0
  75. package/dist/arrow/signature.d.ts.map +1 -0
  76. package/dist/arrow/signature.js +51 -0
  77. package/dist/arrow/signature.js.map +1 -0
  78. package/dist/arrow/temporal-cast.d.ts +9 -0
  79. package/dist/arrow/temporal-cast.d.ts.map +1 -0
  80. package/dist/arrow/temporal-cast.js +60 -0
  81. package/dist/arrow/temporal-cast.js.map +1 -0
  82. package/dist/arrow/types.d.ts +62 -0
  83. package/dist/arrow/types.d.ts.map +1 -0
  84. package/dist/arrow/types.js +5 -0
  85. package/dist/arrow/types.js.map +1 -0
  86. package/dist/arrow/unnest-arrow-column.d.ts +22 -0
  87. package/dist/arrow/unnest-arrow-column.d.ts.map +1 -0
  88. package/dist/arrow/unnest-arrow-column.js +112 -0
  89. package/dist/arrow/unnest-arrow-column.js.map +1 -0
  90. package/dist/arrow/worker-entry.d.ts +2 -0
  91. package/dist/arrow/worker-entry.d.ts.map +1 -0
  92. package/dist/arrow/worker-entry.js +9 -0
  93. package/dist/arrow/worker-entry.js.map +1 -0
  94. package/dist/arrow/worker.cjs +4074 -0
  95. package/dist/arrow/worker.cjs.map +6 -0
  96. package/dist/arrow/worker.d.ts +58 -0
  97. package/dist/arrow/worker.d.ts.map +1 -0
  98. package/dist/arrow/worker.js +84 -0
  99. package/dist/arrow/worker.js.map +1 -0
  100. package/dist/color-functions/index.cjs +382 -0
  101. package/dist/color-functions/index.cjs.map +6 -0
  102. package/dist/color-functions/index.d.ts +26 -0
  103. package/dist/color-functions/index.d.ts.map +1 -0
  104. package/dist/color-functions/index.js +306 -0
  105. package/dist/color-functions/index.js.map +1 -0
  106. package/dist/diagnostic-log.d.ts +8 -0
  107. package/dist/diagnostic-log.d.ts.map +1 -0
  108. package/dist/diagnostic-log.js +15 -0
  109. package/dist/diagnostic-log.js.map +1 -0
  110. package/dist/expressions/ast.d.ts +12 -0
  111. package/dist/expressions/ast.d.ts.map +1 -0
  112. package/dist/expressions/ast.js +114 -0
  113. package/dist/expressions/ast.js.map +1 -0
  114. package/dist/expressions/columnar-predicate.d.ts +56 -0
  115. package/dist/expressions/columnar-predicate.d.ts.map +1 -0
  116. package/dist/expressions/columnar-predicate.js +176 -0
  117. package/dist/expressions/columnar-predicate.js.map +1 -0
  118. package/dist/expressions/evaluation-error.d.ts +14 -0
  119. package/dist/expressions/evaluation-error.d.ts.map +1 -0
  120. package/dist/expressions/evaluation-error.js +26 -0
  121. package/dist/expressions/evaluation-error.js.map +1 -0
  122. package/dist/expressions/expression-eval.d.ts +105 -0
  123. package/dist/expressions/expression-eval.d.ts.map +1 -0
  124. package/dist/expressions/expression-eval.js +330 -0
  125. package/dist/expressions/expression-eval.js.map +1 -0
  126. package/dist/expressions/function-libraries.d.ts +63 -0
  127. package/dist/expressions/function-libraries.d.ts.map +1 -0
  128. package/dist/expressions/function-libraries.js +69 -0
  129. package/dist/expressions/function-libraries.js.map +1 -0
  130. package/dist/expressions/function-registry.d.ts +93 -0
  131. package/dist/expressions/function-registry.d.ts.map +1 -0
  132. package/dist/expressions/function-registry.js +139 -0
  133. package/dist/expressions/function-registry.js.map +1 -0
  134. package/dist/expressions/get.d.ts +9 -0
  135. package/dist/expressions/get.d.ts.map +1 -0
  136. package/dist/expressions/get.js +32 -0
  137. package/dist/expressions/get.js.map +1 -0
  138. package/dist/expressions/index.cjs +1888 -0
  139. package/dist/expressions/index.cjs.map +6 -0
  140. package/dist/expressions/index.d.ts +13 -0
  141. package/dist/expressions/index.d.ts.map +1 -0
  142. package/dist/expressions/index.js +14 -0
  143. package/dist/expressions/index.js.map +1 -0
  144. package/dist/expressions/numeric-functions.d.ts +277 -0
  145. package/dist/expressions/numeric-functions.d.ts.map +1 -0
  146. package/dist/expressions/numeric-functions.js +52 -0
  147. package/dist/expressions/numeric-functions.js.map +1 -0
  148. package/dist/expressions/parse-expression-string.d.ts +21 -0
  149. package/dist/expressions/parse-expression-string.d.ts.map +1 -0
  150. package/dist/expressions/parse-expression-string.js +61 -0
  151. package/dist/expressions/parse-expression-string.js.map +1 -0
  152. package/dist/expressions/predicate-expression.d.ts +7 -0
  153. package/dist/expressions/predicate-expression.d.ts.map +1 -0
  154. package/dist/expressions/predicate-expression.js +112 -0
  155. package/dist/expressions/predicate-expression.js.map +1 -0
  156. package/dist/expressions/scalar-type.d.ts +6 -0
  157. package/dist/expressions/scalar-type.d.ts.map +1 -0
  158. package/dist/expressions/scalar-type.js +23 -0
  159. package/dist/expressions/scalar-type.js.map +1 -0
  160. package/dist/expressions/vendor/jsep/runtime.d.ts +3 -0
  161. package/dist/expressions/vendor/jsep/runtime.d.ts.map +1 -0
  162. package/dist/expressions/vendor/jsep/runtime.js +972 -0
  163. package/dist/expressions/vendor/jsep/runtime.js.map +1 -0
  164. package/dist/expressions/vendor/jsep/types.d.ts +148 -0
  165. package/dist/expressions/vendor/jsep/types.d.ts.map +1 -0
  166. package/dist/expressions/vendor/jsep/types.js +6 -0
  167. package/dist/expressions/vendor/jsep/types.js.map +1 -0
  168. package/dist/index.cjs +5294 -0
  169. package/dist/index.cjs.map +6 -0
  170. package/dist/index.d.ts +11 -0
  171. package/dist/index.d.ts.map +1 -0
  172. package/dist/index.js +11 -0
  173. package/dist/index.js.map +1 -0
  174. package/dist/math-functions/index.cjs +444 -0
  175. package/dist/math-functions/index.cjs.map +6 -0
  176. package/dist/math-functions/index.d.ts +44 -0
  177. package/dist/math-functions/index.d.ts.map +1 -0
  178. package/dist/math-functions/index.js +182 -0
  179. package/dist/math-functions/index.js.map +1 -0
  180. package/dist/parser/bind-sql-predicate.d.ts +4 -0
  181. package/dist/parser/bind-sql-predicate.d.ts.map +1 -0
  182. package/dist/parser/bind-sql-predicate.js +11 -0
  183. package/dist/parser/bind-sql-predicate.js.map +1 -0
  184. package/dist/parser/index.cjs +1807 -0
  185. package/dist/parser/index.cjs.map +6 -0
  186. package/dist/parser/index.d.ts +12 -0
  187. package/dist/parser/index.d.ts.map +1 -0
  188. package/dist/parser/index.js +11 -0
  189. package/dist/parser/index.js.map +1 -0
  190. package/dist/parser/parameter-snapshots.d.ts +21 -0
  191. package/dist/parser/parameter-snapshots.d.ts.map +1 -0
  192. package/dist/parser/parameter-snapshots.js +85 -0
  193. package/dist/parser/parameter-snapshots.js.map +1 -0
  194. package/dist/parser/parse-sql-expression.d.ts +50 -0
  195. package/dist/parser/parse-sql-expression.d.ts.map +1 -0
  196. package/dist/parser/parse-sql-expression.js +501 -0
  197. package/dist/parser/parse-sql-expression.js.map +1 -0
  198. package/dist/parser/parse-sql-predicate.d.ts +13 -0
  199. package/dist/parser/parse-sql-predicate.d.ts.map +1 -0
  200. package/dist/parser/parse-sql-predicate.js +365 -0
  201. package/dist/parser/parse-sql-predicate.js.map +1 -0
  202. package/dist/parser/parse-sql-query.d.ts +9 -0
  203. package/dist/parser/parse-sql-query.d.ts.map +1 -0
  204. package/dist/parser/parse-sql-query.js +81 -0
  205. package/dist/parser/parse-sql-query.js.map +1 -0
  206. package/dist/parser/parse-sql-select.d.ts +57 -0
  207. package/dist/parser/parse-sql-select.d.ts.map +1 -0
  208. package/dist/parser/parse-sql-select.js +247 -0
  209. package/dist/parser/parse-sql-select.js.map +1 -0
  210. package/dist/parser/parse-sql-statement.d.ts +54 -0
  211. package/dist/parser/parse-sql-statement.d.ts.map +1 -0
  212. package/dist/parser/parse-sql-statement.js +207 -0
  213. package/dist/parser/parse-sql-statement.js.map +1 -0
  214. package/dist/parser/query-types.d.ts +56 -0
  215. package/dist/parser/query-types.d.ts.map +1 -0
  216. package/dist/parser/query-types.js +5 -0
  217. package/dist/parser/query-types.js.map +1 -0
  218. package/dist/parser/sql-parameters.d.ts +29 -0
  219. package/dist/parser/sql-parameters.d.ts.map +1 -0
  220. package/dist/parser/sql-parameters.js +110 -0
  221. package/dist/parser/sql-parameters.js.map +1 -0
  222. package/dist/parser/sql-parse-error.d.ts +13 -0
  223. package/dist/parser/sql-parse-error.d.ts.map +1 -0
  224. package/dist/parser/sql-parse-error.js +20 -0
  225. package/dist/parser/sql-parse-error.js.map +1 -0
  226. package/dist/parser/sql-predicate-schema.d.ts +164 -0
  227. package/dist/parser/sql-predicate-schema.d.ts.map +1 -0
  228. package/dist/parser/sql-predicate-schema.js +249 -0
  229. package/dist/parser/sql-predicate-schema.js.map +1 -0
  230. package/dist/parser/sql-predicate-types.d.ts +48 -0
  231. package/dist/parser/sql-predicate-types.d.ts.map +1 -0
  232. package/dist/parser/sql-predicate-types.js +9 -0
  233. package/dist/parser/sql-predicate-types.js.map +1 -0
  234. package/dist/parser/sql-predicate.d.ts +6 -0
  235. package/dist/parser/sql-predicate.d.ts.map +1 -0
  236. package/dist/parser/sql-predicate.js +8 -0
  237. package/dist/parser/sql-predicate.js.map +1 -0
  238. package/dist/scales/arrow-domains.d.ts +22 -0
  239. package/dist/scales/arrow-domains.d.ts.map +1 -0
  240. package/dist/scales/arrow-domains.js +166 -0
  241. package/dist/scales/arrow-domains.js.map +1 -0
  242. package/dist/scales/arrow-scales.d.ts +44 -0
  243. package/dist/scales/arrow-scales.d.ts.map +1 -0
  244. package/dist/scales/arrow-scales.js +255 -0
  245. package/dist/scales/arrow-scales.js.map +1 -0
  246. package/dist/scales/compile-scale.d.ts +2 -0
  247. package/dist/scales/compile-scale.d.ts.map +1 -0
  248. package/dist/scales/compile-scale.js +5 -0
  249. package/dist/scales/compile-scale.js.map +1 -0
  250. package/dist/scales/conformance.cjs +180 -0
  251. package/dist/scales/conformance.cjs.map +6 -0
  252. package/dist/scales/conformance.d.ts +26 -0
  253. package/dist/scales/conformance.d.ts.map +1 -0
  254. package/dist/scales/conformance.js +164 -0
  255. package/dist/scales/conformance.js.map +1 -0
  256. package/dist/scales/hdr-colors.d.ts +2 -0
  257. package/dist/scales/hdr-colors.d.ts.map +1 -0
  258. package/dist/scales/hdr-colors.js +5 -0
  259. package/dist/scales/hdr-colors.js.map +1 -0
  260. package/dist/scales/index.cjs +4334 -0
  261. package/dist/scales/index.cjs.map +6 -0
  262. package/dist/scales/index.d.ts +10 -0
  263. package/dist/scales/index.d.ts.map +1 -0
  264. package/dist/scales/index.js +11 -0
  265. package/dist/scales/index.js.map +1 -0
  266. package/dist/scales/palettes.d.ts +2 -0
  267. package/dist/scales/palettes.d.ts.map +1 -0
  268. package/dist/scales/palettes.js +5 -0
  269. package/dist/scales/palettes.js.map +1 -0
  270. package/dist/scales/parse-sql-scale.d.ts +27 -0
  271. package/dist/scales/parse-sql-scale.d.ts.map +1 -0
  272. package/dist/scales/parse-sql-scale.js +257 -0
  273. package/dist/scales/parse-sql-scale.js.map +1 -0
  274. package/dist/scales/quantile-sketch.d.ts +2 -0
  275. package/dist/scales/quantile-sketch.d.ts.map +1 -0
  276. package/dist/scales/quantile-sketch.js +5 -0
  277. package/dist/scales/quantile-sketch.js.map +1 -0
  278. package/dist/scales/scale-types.d.ts +2 -0
  279. package/dist/scales/scale-types.d.ts.map +1 -0
  280. package/dist/scales/scale-types.js +5 -0
  281. package/dist/scales/scale-types.js.map +1 -0
  282. package/dist/scales/streaming-domains.d.ts +18 -0
  283. package/dist/scales/streaming-domains.d.ts.map +1 -0
  284. package/dist/scales/streaming-domains.js +115 -0
  285. package/dist/scales/streaming-domains.js.map +1 -0
  286. package/package.json +92 -4
  287. package/src/arrow/aggregates.ts +386 -0
  288. package/src/arrow/buffers.ts +177 -0
  289. package/src/arrow/cast.ts +160 -0
  290. package/src/arrow/compiler.ts +1778 -0
  291. package/src/arrow/float16.ts +25 -0
  292. package/src/arrow/index.ts +22 -0
  293. package/src/arrow/like.ts +72 -0
  294. package/src/arrow/list-values.ts +221 -0
  295. package/src/arrow/predicate.ts +19 -0
  296. package/src/arrow/query-arrow-aggregate-snapshots.ts +107 -0
  297. package/src/arrow/query-arrow-sql.ts +255 -0
  298. package/src/arrow/query-arrow-table.ts +298 -0
  299. package/src/arrow/query-worker-entry.ts +8 -0
  300. package/src/arrow/query-worker.ts +194 -0
  301. package/src/arrow/registry.ts +87 -0
  302. package/src/arrow/relational-query.ts +247 -0
  303. package/src/arrow/replace-arrow-columns.ts +71 -0
  304. package/src/arrow/signature.ts +50 -0
  305. package/src/arrow/temporal-cast.ts +66 -0
  306. package/src/arrow/types.ts +76 -0
  307. package/src/arrow/unnest-arrow-column.ts +145 -0
  308. package/src/arrow/worker-entry.ts +10 -0
  309. package/src/arrow/worker.ts +143 -0
  310. package/src/color-functions/index.ts +405 -0
  311. package/src/diagnostic-log.ts +20 -0
  312. package/src/expressions/ast.ts +143 -0
  313. package/src/expressions/columnar-predicate.ts +293 -0
  314. package/src/expressions/evaluation-error.ts +29 -0
  315. package/src/expressions/expression-eval.ts +489 -0
  316. package/src/expressions/function-libraries.ts +126 -0
  317. package/src/expressions/function-registry.ts +171 -0
  318. package/src/expressions/get.ts +37 -0
  319. package/src/expressions/index.ts +40 -0
  320. package/src/expressions/numeric-functions.ts +99 -0
  321. package/src/expressions/parse-expression-string.ts +80 -0
  322. package/src/expressions/predicate-expression.ts +128 -0
  323. package/src/expressions/scalar-type.ts +39 -0
  324. package/src/expressions/vendor/jsep/LICENSE.txt +23 -0
  325. package/src/expressions/vendor/jsep/runtime.ts +949 -0
  326. package/src/expressions/vendor/jsep/types.ts +191 -0
  327. package/src/index.ts +54 -0
  328. package/src/math-functions/index.ts +235 -0
  329. package/src/parser/bind-sql-predicate.ts +21 -0
  330. package/src/parser/index.ts +43 -0
  331. package/src/parser/parameter-snapshots.ts +103 -0
  332. package/src/parser/parse-sql-expression.ts +500 -0
  333. package/src/parser/parse-sql-predicate.ts +454 -0
  334. package/src/parser/parse-sql-query.ts +90 -0
  335. package/src/parser/parse-sql-select.ts +272 -0
  336. package/src/parser/parse-sql-statement.ts +260 -0
  337. package/src/parser/query-types.ts +71 -0
  338. package/src/parser/sql-parameters.ts +174 -0
  339. package/src/parser/sql-parse-error.ts +33 -0
  340. package/src/parser/sql-predicate-schema.ts +279 -0
  341. package/src/parser/sql-predicate-types.ts +91 -0
  342. package/src/parser/sql-predicate.ts +28 -0
  343. package/src/scales/arrow-domains.ts +190 -0
  344. package/src/scales/arrow-scales.ts +363 -0
  345. package/src/scales/compile-scale.ts +5 -0
  346. package/src/scales/conformance.ts +186 -0
  347. package/src/scales/hdr-colors.ts +5 -0
  348. package/src/scales/index.ts +37 -0
  349. package/src/scales/palettes.ts +5 -0
  350. package/src/scales/parse-sql-scale.ts +300 -0
  351. package/src/scales/quantile-sketch.ts +5 -0
  352. package/src/scales/scale-types.ts +5 -0
  353. package/src/scales/streaming-domains.ts +139 -0
@@ -0,0 +1,489 @@
1
+ // math.gl
2
+ // SPDX-License-Identifier: MIT
3
+ // SPDX-FileCopyrightText: Copyright (c) 2013 Stephen Oney
4
+ // SPDX-FileCopyrightText: Copyright (c) 2023 Don McCurdy
5
+ // SPDX-FileCopyrightText: Copyright (c) vis.gl contributors
6
+ // SPDX-FileComment: Sources include jsep and expression-eval under MIT. Original source credits retained below.
7
+
8
+ /**
9
+ * Sources:
10
+ * - Copyright (c) 2013 Stephen Oney, http://jsep.from.so/, MIT License
11
+ * - Copyright (c) 2023 Don McCurdy, https://github.com/donmccurdy/expression-eval, MIT License
12
+ */
13
+ /* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-return, @typescript-eslint/restrict-plus-operands */
14
+
15
+ import {reportDiagnosticError, type DiagnosticLog} from '../diagnostic-log';
16
+ import jsepRuntime from './vendor/jsep/runtime';
17
+ import type {Jsep as JsepTypes} from './vendor/jsep/types';
18
+ import {mergeFunctionLibraries, type ExpressionEvaluationOptions} from './function-libraries';
19
+
20
+ const jsep: typeof JsepTypes = jsepRuntime;
21
+
22
+ /**
23
+ * Named values and functions available while evaluating an expression.
24
+ */
25
+ export type ExpressionContext = Record<string, unknown>;
26
+
27
+ /**
28
+ * A JSEP abstract syntax tree node supported by the evaluator.
29
+ */
30
+ export type Expression =
31
+ | JsepTypes.ArrayExpression
32
+ | JsepTypes.BinaryExpression
33
+ | JsepTypes.LogicalExpression
34
+ | (JsepTypes.CallExpression & {
35
+ /** SQL unquoted function names resolve case-insensitively. */ sqlFunction?: true;
36
+ })
37
+ | JsepTypes.ConditionalExpression
38
+ | JsepTypes.Identifier
39
+ | {
40
+ /** Literal node discriminator. */
41
+ type: 'Literal';
42
+ /** Original spelling when the literal came from source text. */
43
+ raw?: string;
44
+ /** Scalar value, including structured-cloneable binary and date parameters. */
45
+ value: JsepTypes.Literal['value'] | Date | Uint8Array;
46
+ /** Optional pre-encoded UTF-8 storage corresponding to a string value. */
47
+ utf8?: Uint8Array;
48
+ }
49
+ | JsepTypes.MemberExpression
50
+ | JsepTypes.ThisExpression
51
+ | JsepTypes.UnaryExpression;
52
+
53
+ /**
54
+ * Evaluator implementation for a custom unary operator.
55
+ *
56
+ * @param operand - Value produced by the operator's operand expression.
57
+ * @returns The operator result.
58
+ */
59
+ export type UnaryOperator = (operand: any) => any;
60
+
61
+ /**
62
+ * Evaluator implementation for a custom binary operator.
63
+ *
64
+ * @param left - Value produced by the left operand expression.
65
+ * @param right - Value produced by the right operand expression.
66
+ * @returns The operator result.
67
+ */
68
+ export type BinaryOperator = (left: any, right: any) => any;
69
+
70
+ type Callable = (...args: any[]) => any;
71
+
72
+ const DEFAULT_PRECEDENCE: Record<string, number> = {
73
+ '||': 1,
74
+ '&&': 2,
75
+ '|': 3,
76
+ '^': 4,
77
+ '&': 5,
78
+ '==': 6,
79
+ '!=': 6,
80
+ '===': 6,
81
+ '!==': 6,
82
+ '<': 7,
83
+ '>': 7,
84
+ '<=': 7,
85
+ '>=': 7,
86
+ '<<': 8,
87
+ '>>': 8,
88
+ '>>>': 8,
89
+ '+': 9,
90
+ '-': 9,
91
+ '*': 10,
92
+ '/': 10,
93
+ '%': 10
94
+ };
95
+
96
+ const binops: Record<string, (...args: any[]) => any> = {
97
+ '||': (a: unknown, b: unknown) => a || b,
98
+ '&&': (a: unknown, b: unknown) => a && b,
99
+ '|': (a: number, b: number) => a | b,
100
+ '^': (a: number, b: number) => a ^ b,
101
+ '&': (a: number, b: number) => a & b,
102
+ '==': (a: unknown, b: unknown) => {
103
+ // biome-ignore lint/suspicious/noDoubleEquals: this operator implements JavaScript loose equality.
104
+ return a == b;
105
+ },
106
+ '!=': (a: unknown, b: unknown) => {
107
+ // biome-ignore lint/suspicious/noDoubleEquals: this operator implements JavaScript loose inequality.
108
+ return a != b;
109
+ },
110
+ '===': (a: unknown, b: unknown) => a === b,
111
+ '!==': (a: unknown, b: unknown) => a !== b,
112
+ '<': (a: number | string, b: number | string) => a < b,
113
+ '>': (a: number | string, b: number | string) => a > b,
114
+ '<=': (a: number | string, b: number | string) => a <= b,
115
+ '>=': (a: number | string, b: number | string) => a >= b,
116
+ '<<': (a: number, b: number) => a << b,
117
+ '>>': (a: number, b: number) => a >> b,
118
+ '>>>': (a: number, b: number) => a >>> b,
119
+ '+': (a: unknown, b: unknown) => {
120
+ // @ts-expect-error Addition intentionally supports JS coercion semantics.
121
+ return a + b;
122
+ },
123
+ '-': (a: number, b: number) => a - b,
124
+ '*': (a: number, b: number) => a * b,
125
+ '/': (a: number, b: number) => a / b,
126
+ '%': (a: number, b: number) => a % b
127
+ };
128
+
129
+ const unops: Record<string, (...args: any[]) => any> = {
130
+ '-': (a: number) => -a,
131
+ '+': (a: unknown) => {
132
+ // eslint-disable-next-line no-implicit-coercion
133
+ return +a;
134
+ },
135
+ '~': (a: number) => ~a,
136
+ '!': (a: unknown) => !a
137
+ };
138
+
139
+ function evaluateArray(list: JsepTypes.Expression[], context: ExpressionContext): unknown[] {
140
+ return list.map(value => evaluate(value, context));
141
+ }
142
+
143
+ /** Evaluates each expression in an array concurrently. */
144
+ async function evaluateArrayAsync(
145
+ list: JsepTypes.Expression[],
146
+ context: ExpressionContext
147
+ ): Promise<unknown[]> {
148
+ return await Promise.all(list.map(value => evaluateExpressionAsync(value, context)));
149
+ }
150
+
151
+ /** Resolves a member expression and preserves its receiver for method calls. */
152
+ function evaluateMember(
153
+ node: JsepTypes.MemberExpression,
154
+ context: ExpressionContext
155
+ ): [Record<string, unknown>, unknown] {
156
+ const object = evaluate(node.object, context) as Record<string, unknown>;
157
+ const key = node.computed
158
+ ? (evaluate(node.property, context) as string)
159
+ : (node.property as JsepTypes.Identifier).name;
160
+
161
+ if (/^__proto__|prototype|constructor$/.test(key)) {
162
+ throw new Error(`Access to member "${key}" disallowed.`);
163
+ }
164
+
165
+ return [object, object?.[key]];
166
+ }
167
+
168
+ /** Asynchronously resolves a member expression and its receiver. */
169
+ async function evaluateMemberAsync(
170
+ node: JsepTypes.MemberExpression,
171
+ context: ExpressionContext
172
+ ): Promise<[Record<string, unknown>, unknown]> {
173
+ const object = (await evaluateExpressionAsync(node.object, context)) as Record<string, unknown>;
174
+ const key = node.computed
175
+ ? ((await evaluateExpressionAsync(node.property, context)) as string)
176
+ : (node.property as JsepTypes.Identifier).name;
177
+
178
+ if (/^__proto__|prototype|constructor$/.test(key)) {
179
+ throw new Error(`Access to member "${key}" disallowed.`);
180
+ }
181
+
182
+ return [object, object?.[key]];
183
+ }
184
+
185
+ /** Evaluates one expression node synchronously. */
186
+ // eslint-disable-next-line complexity
187
+ function evaluateExpression(
188
+ node: JsepTypes.Expression,
189
+ context: ExpressionContext,
190
+ options?: ExpressionEvaluationOptions
191
+ ): unknown {
192
+ const expression = node as Expression;
193
+ const mergedContext = mergeFunctionLibraries(context, options);
194
+
195
+ switch (expression.type) {
196
+ case 'ArrayExpression':
197
+ return evaluateArray(expression.elements, mergedContext);
198
+
199
+ case 'LogicalExpression':
200
+ case 'BinaryExpression':
201
+ if (expression.operator === '||') {
202
+ return (
203
+ evaluate(expression.left, mergedContext) || evaluate(expression.right, mergedContext)
204
+ );
205
+ }
206
+ if (expression.operator === '&&') {
207
+ return (
208
+ evaluate(expression.left, mergedContext) && evaluate(expression.right, mergedContext)
209
+ );
210
+ }
211
+ return binops[expression.operator](
212
+ evaluate(expression.left, mergedContext),
213
+ evaluate(expression.right, mergedContext)
214
+ );
215
+
216
+ case 'CallExpression': {
217
+ let caller: Record<string, unknown> | undefined;
218
+ let fn: Callable | undefined;
219
+
220
+ if (expression.callee.type === 'MemberExpression') {
221
+ const member = evaluateMember(
222
+ expression.callee as JsepTypes.MemberExpression,
223
+ mergedContext
224
+ );
225
+ caller = member[0];
226
+ fn = member[1] as Callable | undefined;
227
+ } else {
228
+ fn = evaluate(expression.callee, mergedContext) as Callable | undefined;
229
+ }
230
+
231
+ if (typeof fn !== 'function') {
232
+ return undefined;
233
+ }
234
+
235
+ return fn.apply(caller, evaluateArray(expression.arguments, mergedContext));
236
+ }
237
+
238
+ case 'ConditionalExpression':
239
+ return evaluate(expression.test, mergedContext)
240
+ ? evaluate(expression.consequent, mergedContext)
241
+ : evaluate(expression.alternate, mergedContext);
242
+
243
+ case 'Identifier':
244
+ return mergedContext[expression.name];
245
+
246
+ case 'Literal':
247
+ return expression.value;
248
+
249
+ case 'MemberExpression':
250
+ return evaluateMember(expression, mergedContext)[1];
251
+
252
+ case 'ThisExpression':
253
+ return mergedContext;
254
+
255
+ case 'UnaryExpression':
256
+ return unops[expression.operator](evaluate(expression.argument, mergedContext));
257
+
258
+ default:
259
+ return undefined;
260
+ }
261
+ }
262
+
263
+ /** Evaluates a nested expression using an already-merged context. */
264
+ function evaluate(node: JsepTypes.Expression, context: ExpressionContext): unknown {
265
+ return evaluateExpression(node, context);
266
+ }
267
+
268
+ /**
269
+ * Evaluates a parsed expression asynchronously.
270
+ *
271
+ * @param node - Expression AST to evaluate.
272
+ * @param context - Named values and functions available to the expression.
273
+ * @param options - Function libraries to add to the context.
274
+ * @returns The resolved expression value.
275
+ *
276
+ * @remarks
277
+ * Function calls are awaited, including calls nested inside arrays, member
278
+ * expressions, conditionals, unary expressions, and binary expressions.
279
+ */
280
+ // eslint-disable-next-line complexity
281
+ async function evaluateExpressionAsync(
282
+ node: JsepTypes.Expression,
283
+ context: ExpressionContext,
284
+ options?: ExpressionEvaluationOptions
285
+ ): Promise<unknown> {
286
+ const expression = node as Expression;
287
+ const mergedContext = mergeFunctionLibraries(context, options);
288
+
289
+ switch (expression.type) {
290
+ case 'ArrayExpression':
291
+ return await evaluateArrayAsync(expression.elements, mergedContext);
292
+
293
+ case 'LogicalExpression':
294
+ case 'BinaryExpression':
295
+ if (expression.operator === '||') {
296
+ return (
297
+ (await evaluateExpressionAsync(expression.left, mergedContext)) ||
298
+ (await evaluateExpressionAsync(expression.right, mergedContext))
299
+ );
300
+ }
301
+ if (expression.operator === '&&') {
302
+ return (
303
+ (await evaluateExpressionAsync(expression.left, mergedContext)) &&
304
+ (await evaluateExpressionAsync(expression.right, mergedContext))
305
+ );
306
+ }
307
+ return binops[expression.operator](
308
+ await evaluateExpressionAsync(expression.left, mergedContext),
309
+ await evaluateExpressionAsync(expression.right, mergedContext)
310
+ );
311
+
312
+ case 'CallExpression': {
313
+ let caller: Record<string, unknown> | undefined;
314
+ let fn: Callable | undefined;
315
+
316
+ if (expression.callee.type === 'MemberExpression') {
317
+ const member = await evaluateMemberAsync(
318
+ expression.callee as JsepTypes.MemberExpression,
319
+ mergedContext
320
+ );
321
+ caller = member[0];
322
+ fn = member[1] as Callable | undefined;
323
+ } else {
324
+ fn = (await evaluateExpressionAsync(expression.callee, mergedContext)) as
325
+ | Callable
326
+ | undefined;
327
+ }
328
+
329
+ if (typeof fn !== 'function') {
330
+ return undefined;
331
+ }
332
+
333
+ return await fn.apply(caller, await evaluateArrayAsync(expression.arguments, mergedContext));
334
+ }
335
+
336
+ case 'ConditionalExpression':
337
+ return (await evaluateExpressionAsync(expression.test, mergedContext))
338
+ ? await evaluateExpressionAsync(expression.consequent, mergedContext)
339
+ : await evaluateExpressionAsync(expression.alternate, mergedContext);
340
+
341
+ case 'Identifier':
342
+ return mergedContext[expression.name];
343
+
344
+ case 'Literal':
345
+ return expression.value;
346
+
347
+ case 'MemberExpression':
348
+ return (await evaluateMemberAsync(expression, mergedContext))[1];
349
+
350
+ case 'ThisExpression':
351
+ return mergedContext;
352
+
353
+ case 'UnaryExpression':
354
+ return unops[expression.operator](
355
+ await evaluateExpressionAsync(expression.argument, mergedContext)
356
+ );
357
+
358
+ default:
359
+ return undefined;
360
+ }
361
+ }
362
+
363
+ /**
364
+ * Compiles an expression into a reusable synchronous evaluator.
365
+ *
366
+ * @param expression - Expression source or a previously parsed AST.
367
+ * @param options - Function libraries to add to each evaluation context.
368
+ * @returns A function that evaluates the expression against a context.
369
+ */
370
+ export function compile(
371
+ expression: string | JsepTypes.Expression,
372
+ options?: ExpressionEvaluationOptions
373
+ ): (context: ExpressionContext) => unknown {
374
+ const ast = parse(expression, options);
375
+ return (context: ExpressionContext) => evaluateWithDiagnostics(ast, context, options);
376
+ }
377
+
378
+ /**
379
+ * Compiles an expression into a reusable asynchronous evaluator.
380
+ *
381
+ * @param expression - Expression source or a previously parsed AST.
382
+ * @param options - Function libraries to add to each evaluation context.
383
+ * @returns A function that asynchronously evaluates the expression.
384
+ */
385
+ export function compileAsync(
386
+ expression: string | JsepTypes.Expression,
387
+ options?: ExpressionEvaluationOptions
388
+ ): (context: ExpressionContext) => Promise<unknown> {
389
+ const ast = parse(expression, options);
390
+ return (context: ExpressionContext) => evaluateAsync(ast, context, options);
391
+ }
392
+
393
+ /**
394
+ * Registers a custom unary operator with the parser and evaluator.
395
+ *
396
+ * @param operator - Operator token to register.
397
+ * @param fn - Evaluator implementation for the operator.
398
+ *
399
+ * @remarks
400
+ * Registration changes module-global parser state and affects subsequent
401
+ * calls to {@link parse}.
402
+ */
403
+ export function addUnaryOp(operator: string, fn: UnaryOperator): void {
404
+ jsep.addUnaryOp(operator);
405
+ unops[operator] = fn;
406
+ }
407
+
408
+ /**
409
+ * Registers a custom binary operator with the parser and evaluator.
410
+ *
411
+ * @param operator - Operator token to register.
412
+ * @param precedenceOrFn - Parser precedence, or the evaluator implementation
413
+ * when using the default precedence for a built-in operator.
414
+ * @param fn - Evaluator implementation when an explicit precedence is given.
415
+ *
416
+ * @remarks
417
+ * Registration changes module-global parser state and affects subsequent
418
+ * calls to {@link parse}. New operators should provide explicit precedence.
419
+ */
420
+ export function addBinaryOp(
421
+ operator: string,
422
+ precedenceOrFn: number | BinaryOperator,
423
+ fn?: BinaryOperator
424
+ ): void {
425
+ if (fn) {
426
+ jsep.addBinaryOp(operator, precedenceOrFn as number);
427
+ binops[operator] = fn;
428
+ return;
429
+ }
430
+
431
+ jsep.addBinaryOp(operator, DEFAULT_PRECEDENCE[operator] || 1);
432
+ binops[operator] = precedenceOrFn as BinaryOperator;
433
+ }
434
+
435
+ /**
436
+ * Parses expression source into a JSEP abstract syntax tree.
437
+ *
438
+ * @param expression - Expression source or an existing AST.
439
+ * @returns A parsed AST, or the supplied AST unchanged.
440
+ * @throws If the expression string is not valid JSEP syntax.
441
+ */
442
+ export function parse(
443
+ expression: string | JsepTypes.Expression,
444
+ options?: {log?: DiagnosticLog}
445
+ ): JsepTypes.Expression {
446
+ try {
447
+ return typeof expression === 'string' ? jsep(expression) : expression;
448
+ } catch (error) {
449
+ reportDiagnosticError(options?.log, error);
450
+ throw error;
451
+ }
452
+ }
453
+
454
+ /**
455
+ * Evaluates a parsed expression synchronously.
456
+ *
457
+ * @param node - Expression AST to evaluate.
458
+ * @param context - Named values and functions available to the expression.
459
+ * @param options - Function libraries to add to the context.
460
+ * @returns The expression value.
461
+ */
462
+ function evaluateWithDiagnostics(
463
+ node: JsepTypes.Expression,
464
+ context: ExpressionContext,
465
+ options?: ExpressionEvaluationOptions
466
+ ): unknown {
467
+ try {
468
+ return evaluateExpression(node, context, options);
469
+ } catch (error) {
470
+ reportDiagnosticError(options?.log, error);
471
+ throw error;
472
+ }
473
+ }
474
+
475
+ export {evaluateWithDiagnostics as evaluate};
476
+
477
+ /** Evaluates an expression asynchronously and reports errors to the supplied logger. */
478
+ export async function evaluateAsync(
479
+ node: JsepTypes.Expression,
480
+ context: ExpressionContext,
481
+ options?: ExpressionEvaluationOptions
482
+ ): Promise<unknown> {
483
+ try {
484
+ return await evaluateExpressionAsync(node, context, options);
485
+ } catch (error) {
486
+ reportDiagnosticError(options?.log, error);
487
+ throw error;
488
+ }
489
+ }
@@ -0,0 +1,126 @@
1
+ // math.gl
2
+ // SPDX-License-Identifier: MIT
3
+ // SPDX-FileCopyrightText: Copyright (c) vis.gl contributors
4
+ /* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-return */
5
+
6
+ import type {DiagnosticLog} from '../diagnostic-log';
7
+ import {
8
+ clamp,
9
+ degrees,
10
+ lerp,
11
+ normalizeAngle,
12
+ radians,
13
+ safeMod,
14
+ toDegrees,
15
+ toRadians
16
+ } from '@math.gl/core';
17
+ import type {ExpressionFunctionRegistry} from './function-registry';
18
+
19
+ /**
20
+ * A function that can be exposed to evaluated expressions.
21
+ *
22
+ * @param args - Arguments supplied by a call expression.
23
+ * @returns The value made available to the expression.
24
+ */
25
+ export type ExpressionFunction = (...args: any[]) => any;
26
+
27
+ /**
28
+ * A named collection of functions that can be supplied to an expression
29
+ * evaluator through {@link ExpressionEvaluationOptions}.
30
+ */
31
+ export type ExpressionFunctionLibrary = Record<string, ExpressionFunction>;
32
+
33
+ /**
34
+ * Options shared by the synchronous and asynchronous expression evaluators.
35
+ */
36
+ export type ExpressionEvaluationOptions = {
37
+ /** Logs evaluation or compilation errors when supplied. */
38
+ log?: DiagnosticLog;
39
+ /**
40
+ * Instance-scoped registry of named functions available to the expression.
41
+ */
42
+ registry?: ExpressionFunctionRegistry;
43
+
44
+ /**
45
+ * Function libraries to add to the evaluation context.
46
+ *
47
+ * Libraries are merged from left to right. Functions in later libraries
48
+ * replace functions with the same name in earlier libraries. Values in the
49
+ * expression context replace functions with the same name in any library.
50
+ */
51
+ libraries?: ExpressionFunctionLibrary[];
52
+ };
53
+
54
+ /**
55
+ * General-purpose mathematical functions for expression evaluation.
56
+ *
57
+ * Includes JavaScript `Math` functions and math.gl helpers such as `clamp`,
58
+ * `lerp`, `normalizeAngle`, `safeMod`, `toDegrees`, and `toRadians`.
59
+ *
60
+ * @example
61
+ * ```ts
62
+ * const evaluate = compile("clamp(sin(angle), 0, 1)", {
63
+ * libraries: [BASIC_MATH_FUNCTION_LIBRARY]
64
+ * });
65
+ * evaluate({angle: Math.PI / 2});
66
+ * ```
67
+ */
68
+ export const BASIC_MATH_FUNCTION_LIBRARY: ExpressionFunctionLibrary = {
69
+ abs: Math.abs,
70
+ acos: Math.acos,
71
+ asin: Math.asin,
72
+ atan: Math.atan,
73
+ ceil: Math.ceil,
74
+ clamp,
75
+ cos: Math.cos,
76
+ degrees,
77
+ exp: Math.exp,
78
+ floor: Math.floor,
79
+ lerp,
80
+ log: Math.log,
81
+ max: Math.max,
82
+ min: Math.min,
83
+ normalizeAngle,
84
+ pow: Math.pow,
85
+ radians,
86
+ round: Math.round,
87
+ safeMod,
88
+ sign: Math.sign,
89
+ sin: Math.sin,
90
+ sqrt: Math.sqrt,
91
+ tan: Math.tan,
92
+ toDegrees,
93
+ toRadians,
94
+ trunc: Math.trunc
95
+ };
96
+
97
+ /**
98
+ /**
99
+ * Adds configured function libraries to an expression context.
100
+ *
101
+ * @param context - Values available to the expression.
102
+ * @param options - Function libraries to merge into the context.
103
+ * @returns The original context when no libraries are supplied, or a new
104
+ * context containing the libraries and context values.
105
+ *
106
+ * @remarks
107
+ * Libraries are merged from left to right, then overlaid with `context`.
108
+ * Registry functions have the lowest precedence. The input objects are not modified.
109
+ */
110
+ export function mergeFunctionLibraries(
111
+ context: Record<string, unknown>,
112
+ options?: ExpressionEvaluationOptions
113
+ ): Record<string, unknown> {
114
+ if (!options?.libraries?.length) {
115
+ if (!options?.registry) {
116
+ return context;
117
+ }
118
+ }
119
+
120
+ return Object.assign(
121
+ {},
122
+ options.registry?.getFunctionTable(),
123
+ ...(options.libraries || []),
124
+ context
125
+ );
126
+ }