README
What is this repository for?
- This repository is for getting evaluated outcome based on the rules
npm i @deliverysolutions/rule-engine- Current version is 1.0.0-beta.1
How do I use it?
To use the CustomRateEngineController, you would need to just import the library.
import { CustomRateEngineController } from '@deliverysolutions/rule-engine'
- Create instance of the class
const customRateEngineController = new CustomRateEngineController();
The CustomRateEngineController class exposes following public methods
getRates(order, corporateDsp): Promise<number|null>
The above method will do the following:
- Evaluate individual rate cards and find the valid scenario from the rate card
- From the tiers defined in valid scenario, find the valid tier based on delivery distance
- Calculate the custom rates based on tier selected
Peer Dependencies
This library requires the following peer dependencies to be installed in your project:
@deliverysolutions/logger (version ^6.0.0-beta.1 or later)@deliverysolutions/order-status-mapping (version ^3.0.0-beta.1 or later)@deliverysolutions/response-error-structure (version ^1.4.0-rc.1 or later)@deliverysolutions/utils (version ^3.0.0-beta.1 or later)
Installation
To install the required peer dependencies, run:
npm install \
@deliverysolutions/logger@^6.0.0-beta.1 \
@deliverysolutions/order-status-mapping@^3.0.0-beta.1 \
@deliverysolutions/response-error-structure@^1.4.0-rc.1" \
@deliverysolutions/utils: "3.0.0-beta.1"
关于 @deliverysolutions/rule-engine 的常见问题
@deliverysolutions/rule-engine 是什么？
This library calculates the output for a given input condition.
如何安装 @deliverysolutions/rule-engine？
在项目目录运行 npm install @deliverysolutions/rule-engine，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@deliverysolutions/utils（^3.0.0 || ^3.0.0-beta.1 || ^3.0.0-rc.0）、@deliverysolutions/logger（^6.0.0 || ^6.0.0-beta.1 || ^6.0.0-rc.0）、@deliverysolutions/order-status-mapping（^3.0.0 || ^3.0.0-beta.3 || ^3.0.0-rc.0）、@deliverysolutions/response-error-structure（^3.0.1 || ^2.0.0-beta.1 || ^2.0.0-rc.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。
@deliverysolutions/rule-engine 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
@deliverysolutions/rule-engine 支持 ESM 还是 CommonJS？
以 CommonJS 形式发布，可以直接 require()；在 ES Module 项目中也可以用 import 引入（Node.js 会把 module.exports 作为默认导出）。
@deliverysolutions/rule-engine 需要什么版本的 Node.js？
package.json 的 engines 字段要求 Node.js >=20.0.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。
@deliverysolutions/rule-engine 可以商用吗？
@deliverysolutions/rule-engine 使用 ISC 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
@deliverysolutions/rule-engine 的下载量有多少？
根据 npm 官方下载统计，@deliverysolutions/rule-engine 在 2026/10/12 – 2026/11/10 这 30 天内被下载 14,717 次，日均约 491 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@deliverysolutions/rule-engine 还在维护吗？
最新版本 5.7.2 发布于 2026/04/21（6 个月前）；至今共发布 356 个版本，其中过去 12 个月发布了 17 个；首次发布于 2021/08/06。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。