@elaraai/e3

中文文档
1.0.107发布于 2026/11/13AGPL-3.0-or-laterTypeScriptES Module构建来源已验证近 30 天下载 5594

TypeScript SDK for authoring e3 packages

原始使用文档
文档目录8 节
  1. Installation
  2. Example
  3. API
  4. Claude Code plugin
  5. License
  6. Ecosystem
  7. Links
  8. About Elara

@elaraai/e3

SDK for authoring e3 packages.

Installation

npm install @elaraai/e3

Example

import e3 from '@elaraai/e3';
import { StringType, East, variant } from '@elaraai/east';

// Define input datasets with default values
const input_name = e3.input('name', StringType, variant('value', 'World'));
const input_prefix = e3.input('prefix', StringType, variant('value', 'Hello'));

// Define a task that combines inputs
const greet = e3.task(
  'greet',
  [input_prefix, input_name],
  East.function(
    [StringType, StringType],
    StringType,
    ($, prefix, name) => East.str`${prefix}, ${name}!`
  )
);

// Chain tasks - output of one feeds into the next
const shout = e3.task(
  'shout',
  [greet.output],  // reads from previous task's output
  East.function(
    [StringType],
    StringType,
    ($, greeting) => greeting.upperCase()
  )
);

// Create and export the package
const pkg = e3.package('greeting-pkg', '1.0.0', shout);
await e3.export(pkg, 'dist/greeting-pkg-1.0.0.zip');

This creates a package with:

  • .inputs.name - String input (default: "World")
  • .inputs.prefix - String input (default: "Hello")
  • .tasks.greet - Combines inputs into greeting
  • .tasks.shout - Transforms greeting to uppercase

API

  • e3.input(name, type, variant('value', default)) - Define an input dataset
  • e3.task(name, inputs, fn) - Define a task with East function
  • e3.streamTask(name, { inputs, output }, fn) - Define a task that emits its output instead of returning it; fn receives the inputs, then emit
  • e3.output.array(T), set(T), dict(K, V, { merge? }), fold(T, { zero, combine }) - The output kinds a stream task emits into: what emit takes, and how the parts of the output combine
  • e3.partition(dataset, { by? }) - Mark a stream task's input as one its work may be split over, a piece at a time, in parallel
  • e3.record(name, type, { initial?, indexes?, mutations?, migrations? }) - Define a record: state written only through its mutations, each an audited commit. A record is declared whole, its parts named in its declaration:
    • indexes: (index) => ({ by_site: index.on(["site"]), … }) - Second collections over a Dict record, in another order: index.on(fields), key(fn) or keys(fn), each with an optional value projection, or interval, area, series, nested and summary over the rows' times and boxes
    • mutations: (mutation) => ({ patch: mutation.patch(), … }) - Its mutations: mutation.reduce(fn), a reducer over the whole state; edit(fn), a body writing through an edit capability; or patch(), a patch a client sends
    • migrations: (migration) => [migration.value(name, fn), …] - The steps a deploy runs when a package changes the record's type, in order: value, rows or rekey
  • e3.package(name, version, ...items) - Create a package (dependencies collected automatically)
  • e3.export(pkg, path) - Export package to zip file

The user guide covers the rest of the SDK, the CLI and setting up a project.

Claude Code plugin

The East ecosystem also ships a Claude Code plugin — East language skills, example search, and preemptive diagnostics for East code — installed separately from the elaraai marketplace:

# Inside Claude Code
/plugin marketplace add elaraai/east-workspace
/plugin install east@elaraai
# From a terminal
claude plugin marketplace add elaraai/east-workspace
claude plugin install east@elaraai

License

Dual AGPL-3.0 / Commercial. See LICENSE.md.

Ecosystem

  • East: Statically typed, expression-based language with serializable IR. Run portable logic across TypeScript, Python, C, and other runtimes.

    • @elaraai/east: Core language SDK with type system, expressions, and reference JS compiler
  • East Node: Node.js platform functions for I/O, databases, and system operations.

  • East C: C11 native runtime for executing East IR. Distributed via npm (launcher + per-platform optional dependencies) and as tarballs on each GitHub Release.

    • @elaraai/east-c-cli: npm launcher — installs the matching native binary as an optional dependency
    • east-c: Core runtime — type system, IR interpreter, builtins, serialization (Beast2, JSON, CSV, East text)
    • east-c-std: Console, FileSystem, Fetch, Crypto, Time, Path, Random
    • east-c-cli: CLI for running East IR programs natively
  • East Python: Python runtime, standard platform, I/O, and data-science platform functions. Published to PyPI.

    • east-py: Core Python runtime — type system, IR compiler, 212+ builtins, Cython-accelerated hot paths
    • east-py-std: Console, FileSystem, Fetch, Crypto, Time, Path, Random
    • east-py-io: SQLite, PostgreSQL, MySQL, MongoDB, Redis, S3, FTP, SFTP, XLSX, XML, compression
    • east-py-cli: CLI for running East IR programs in Python
    • east-py-datascience (PyPI) + @elaraai/east-py-datascience (npm): Optimization (MADS, Optuna, ALNS, GoogleOR), ML (XGBoost, LightGBM, NGBoost, PyTorch, Lightning, GP), Bayesian inference (PyMC), explainability (SHAP), conformal prediction (MAPIE)
  • East UI: Typed UI component definitions and React renderer, plus VS Code preview.

  • e3 — East Execution Engine: Durable execution engine for running East pipelines at scale. Git-like content-addressable storage, automatic memoization, reactive dataflow, real-time monitoring.

About Elara

East is developed by Elara AI Pty Ltd, an AI-powered platform that creates economic digital twins of businesses that optimize performance. Elara combines business objectives, decisions and data to help organizations make data-driven decisions across operations, purchasing, sales and customer engagement, and project and investment planning. East powers the computational layer of Elara solutions, enabling the expression of complex business logic and data in a simple, type-safe and portable language.


Developed by Elara AI Pty Ltd.


Developed by Elara AI Pty Ltd

版本与发布记录

@elaraai/e3 共发布 165 个版本,首次发布于 2025/12/12;过去 12 个月发布了 165 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.0.107latest2026/11/13今天
1.0.1062026/11/094 天前
1.0.1052026/11/085 天前
1.0.1042026/11/067 天前
1.0.1032026/11/049 天前
1.0.1022026/11/0310 天前

其他发布通道:alpha → 0.0.1-alpha.3,beta → 0.0.2-beta.54。

关于 @elaraai/e3 的常见问题

@elaraai/e3 是什么?

TypeScript SDK for authoring e3 packages

如何安装 @elaraai/e3?

在项目目录运行 npm install @elaraai/e3,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@elaraai/east(1.0.107)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@elaraai/e3 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@elaraai/e3 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@elaraai/e3 可以商用吗?

@elaraai/e3 使用 AGPL-3.0-or-later 许可。最严格的 Copyleft:除分发外,通过网络向用户提供基于它的服务也需要开源对应源码。闭源 SaaS 使用前务必评估。以上为概括,不构成法律意见,请以许可原文为准。

@elaraai/e3 的下载量有多少?

根据 npm 官方下载统计,@elaraai/e3 在 2026/10/13 – 2026/11/11 这 30 天内被下载 5,594 次,日均约 186 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@elaraai/e3 还在维护吗?

最新版本 1.0.107 发布于 2026/11/13(今天);至今共发布 165 个版本,其中过去 12 个月发布了 165 个;首次发布于 2025/12/12。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。