# lemon-model

> Common shared model definitions for Lemon Micro-Service Platform

Latest version **1.2.4** (published 2026-07-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install lemon-model
pnpm add lemon-model
yarn add lemon-model
bun add lemon-model
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.2.4 |
| Published | 2026-07-15 |
| First published | 2022-06-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=18.19.0 |
| Dependencies | 0 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Steve Jung |
| Maintainers | stevelemon |
| Keywords | lemoncloud, lemon-model, CoreModel |

## Links

- npm: https://www.npmjs.com/package/lemon-model
- Repository: https://github.com/lemoncloud-io/lemon-model
- Homepage: https://github.com/lemoncloud-io/lemon-model#readme
- Issues: https://github.com/lemoncloud-io/lemon-model/issues
- npm.io page: https://npm.io/package/lemon-model

## Recent versions

- 1.2.4 (latest) — 2026-07-15
- 1.2.3 — 2026-07-06
- 1.2.2 — 2026-06-12
- 1.2.1 — 2026-06-11
- 1.2.0 — 2026-06-11
- 1.1.1 — 2025-12-26
- 1.1.0 — 2025-12-26
- 1.0.6 — 2025-06-13
- 1.0.5 — 2025-05-13
- 1.0.4 — 2025-05-09
- 1.0.3 — 2024-12-20
- 1.0.2 — 2023-01-19
- 1.0.1 — 2022-12-26
- 1.0.0 — 2022-06-22

## README

# lemon-model

Common shared model definitions for both `backend` and `frontend`.

## Usage

!TIP! to develop `backend` api, use [lemon-core](https://github.com/lemoncloud-io/lemon-core) instead of this.

```sh
# install with npm
npm install --save lemon-model
```

Backend API services that need the full Lemon runtime should use `lemon-core`.

## Import

```ts
import type { NextContext } from 'lemon-model';
```

```js
const { HttpAbstractGenAI } = require('lemon-model');
```

Frontend bundlers use the ESM build. Existing Node `require()` consumers use the CommonJS build.

## Package Map

| Area | Responsibility | Detail Doc |
| --- | --- | --- |
| `types` | Shared request, identity, storage, and service shapes | Source types |
| `cores` | Small shared transform helpers | Source tests |
| `socket` | Peer socket, network contract, WebSocket bridge, JSON chunk transport | `src/socket/README.md` |
| `buffer` | Provider-neutral GenAI stream buffering and network adapters | `src/buffer/README.md` |
| `genai` | Gemini-like `generateContent()` adapter over Lemon agents APIs | `src/genai/README.md` |
| `samples` | Real usage cases and PR-ready sample notes | `samples/README.md` |

## User Sequence

```mermaid
sequenceDiagram
    participant App as App or service
    participant Package as lemon-model
    participant TS as TypeScript
    participant Runtime

    App->>Package: Install package
    App->>Package: Import selected type or helper
    Package-->>TS: Shared declarations
    TS-->>App: Contract check
    App->>Runtime: Run selected helper
    Runtime-->>App: Typed result
```

1. App installs `lemon-model`
2. App imports only the needed type or helper
3. TypeScript checks shared contracts
4. Runtime loads CJS or ESM build
5. Selected module handles its own job
6. Module README owns detailed behavior

## Choosing A Module

```mermaid
flowchart TD
    A[Need shared code] --> B{Need runtime behavior}
    B -- No --> C[Use types]
    B -- Yes --> D{Which behavior}
    D -- Data transforms --> E[Use cores]
    D -- Socket or network test --> F[Use socket]
    D -- GenAI stream batching --> J[Use buffer]
    D -- Agents generateContent --> G[Use genai]
    F --> H[Read src/socket/README.md]
    G --> I[Read src/genai/README.md]
    J --> K[Read src/buffer/README.md]
```

Main branch: type-only, transform helper, socket flow, GenAI stream buffer, or GenAI proxy.

## Buffer

`buffer` provides provider-neutral stream primitives for GenAI responses.

```ts
import { GenAIStreamBuffer, createGenAIStreamNetworkConsumer } from 'lemon-model';
```

Use it when a provider emits small stream fragments and the app needs consistent `start`, `chunk`, `progress`, `flush`, `eof`, and `error` events.

The network adapter can send `GenAIStreamEvent` over the shared socket/json-transport layer. Diagnostic helpers live under `lemon-model/buffer/testing`.

Provider probe tools are available under `tools/`, but provider SDKs are not part of the runtime package contract. Install the matching SDK in the workspace where you run a probe.

## Build Formats

- CommonJS entry: `dist/index.js`
- ESM entry: `dist/esm/index.js`
- Type declarations: `dist/index.d.ts`
- Package export: `import { ... } from 'lemon-model'`
- Test helper exports: `lemon-model/genai/testing`, `lemon-model/buffer/testing`, `lemon-model/socket/testing`

## Module Docs

- `src/socket/README.md`: peer socket and network contract
- `src/socket/JSON_TRANSPORT_SPEC.md`: JSON chunk transport protocol
- `src/buffer/README.md`: GenAI stream buffering and network adapter contract
- `src/genai/README.md`: GenAI adapter contract
- `samples/README.md`: sample case rules

## Contribution

Plz, request PR.

See [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md)

## LICENSE

[MIT](LICENSE) - (C) 2019 LemonCloud Co Ltd. - All Rights Reserved.„

----------------

## VERSION INFO

| Version   | Description
|--         |--
| 1.0.6     | optimized `SearchBody` with `knn` support.
| 1.0.5     | optimized `NextIdentity` with `authorization`.
| 1.0.4     | optimized `NextIdentity` with `referer` and `origin`.
| 1.0.3     | optimized `NextIdentityCognito`
| 1.0.0     | initial types out of the original `lemon-core@3.1.1`

---
_Source: https://npm.io/package/lemon-model · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._