Lovrabet TypeScript SDK

https://open.lovrabet.com/en/docs/
Admin
A lightweight JavaScript/TypeScript SDK that provides convenient data access capabilities for the...
Tokens:288,345
Snippets:2,433
Trust Score:4.5
Update:6 months ago
Show doc for...
Tokens:
Raw
### CLI Environment Setup

Source: https://open.lovrabet.com/en/docs/guides/toolchain

Commands to install the CLI, authenticate, and initialize a new project.

```bash
# 1. Install and login
npm install -g @lovrabet/cli
lovrabet auth

# 2. Create project
lovrabet create order-management

# 3. Generate SDK config
cd order-management
lovrabet api pull --appcode your-app-code
```

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

### Lovrabet CLI Setup

Source: https://open.lovrabet.com/en/docs/openapi/comparison

Commands to install the CLI, create a project, and configure the API.

```bash
# Install CLI  
npm install -g @lovrabet/cli  
  
# Create project  
lovrabet create my-custom-page  
  
# Configure and pull SDK  
lovrabet config set app <your-app-code>  
lovrabet api pull
```

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

### Practical CLI Workflow Examples

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/commands

Common workflows for starting new projects versus integrating into existing ones.

```bash
# Scenario 1: Starting new project - Use create  
lovrabet create my-shop-project  
cd my-shop-project  
lovrabet start  
  
# Scenario 2: Existing project - Use init  
cd my-existing-react-app  
lovrabet init --appcode shop-app  
lovrabet api pull  
lovrabet start  

```

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

### Start Development Server

Source: https://open.lovrabet.com/en/docs/guides/tutorial

Navigates to the project directory and starts the local development server.

```bash
cd customer-management  
lovrabet start
```

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

### Install AI Development Skills

Source: https://open.lovrabet.com/en/docs/lovrabet-cli

Use npx to automatically detect your IDE and install development standards and guides.

```bash
# Recommended: Using npx skills  
npx skills add lovrabet/lovrabet-skill  
```

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

### User Management System Example

Source: https://open.lovrabet.com/en/docs/lovrabet-sdk/filter-api

A complete example showing client initialization and a filtered query for user records.

```javascript
import { createClient } from "@lovrabet/sdk";  
  
const client = createClient();  
  
// Query active VIP users from China aged between 18 and 45  
// Return only necessary fields, sorted by last login time descending  
const result = await client.models.users.filter({  
  where: {  
    $and: [  
      { age: { $gte: 18, $lte: 45 } },  
      { country: { $in: ["China", "USA", "Japan"] } },  
      { vip: { $ne: null } },  
      { active: { $eq: true } },  
      { name: { $contain: "hello" } },  
    ],  
  },  
  select: ["id", "name", "age", "country", "lastLoginAt", "email"],  
  orderBy: [{ lastLoginAt: "desc" }, { name: "asc" }],  
  currentPage: 1,  
  pageSize: 20,  
});  
  
console.log(`Found ${result.total} matching users`);  
result.tableData.forEach((user) => {  
  console.log(`${user.name} (${user.age} years old) - ${user.email}`);  
});  
```

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

### Initialize and Query with Lovrabet Client

Source: https://open.lovrabet.com/en/docs/openapi/quickstart

Basic setup for the Lovrabet client and examples for querying data lists or single records in a Node.js environment.

```javascript
import { createClient } from "@lovrabet/sdk";  
  
// Create client (using accessKey)  
const client = createClient({  
  appCode: "your-app-code",  
  accessKey: process.env.LOVRABET_ACCESS_KEY, // Read from environment variable  
  models: {  
    users: {  
      tableName: "users",  
      datasetCode: "your-dataset-code",  
    },  
  },  
});  
  
// Query data list  
const response = await client.models.users.filter({  
  currentPage: 1,  
  pageSize: 20,  
});  
  
console.log("Total count:", response.paging.totalCount);  
console.log("Data:", response.tableData);  
  
// Query single record  
const user = await client.models.users.getOne("user-id");  
console.log("User details:", user);  
```

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

### Create Record Complete Example

Source: https://open.lovrabet.com/en/docs/java-opensdk/api-reference

A full implementation example showing client initialization, request construction, and result processing.

```java
import com.lovrabet.runtime.opensdk.client.LovrabetSDKClient;  
import com.lovrabet.runtime.opensdk.model.LovrabetRequest;  
import com.lovrabet.runtime.opensdk.model.LovrabetResult;  
import java.util.HashMap;  
import java.util.Map;  
  
public class CreateExample {  
    public static void main(String[] args) {  
        // Create client  
        LovrabetSDKClient sdkClient = new LovrabetSDKClient(  
            "ak-OD8xWhMOsL5ChQ3Akhv4uYYiu1fPOFQGVF9BULIeov8",  
            "https://runtime.lovrabet.com/openapi"  
        );  
  
        // Build request  
        LovrabetRequest request = new LovrabetRequest();  
        request.setAppCode("app-c2dd52a2");  
        request.setModelCode("32c036010c504757b80d438e3c0ec8b7");  
  
        // Set business data  
        Map<String, Object> paramMap = new HashMap<>();  
        paramMap.put("TEXT_1", "Sales Order 1010");      // Text field  
        paramMap.put("NUMBER_3", 121);                   // Number field  
        paramMap.put("NUMBER_8", 888);                   // Number field  
        paramMap.put("SELECT_4", "china-north");         // Select field  
        paramMap.put("SELECT_7", 463);                   // Select field  
        request.setParamMap(paramMap);  
  
        // Call interface  
        LovrabetResult<String> result = sdkClient.create(request);  
  
        // Process result  
        if (result.isSuccess()) {  
            String newId = result.getData();  
            System.out.println("Created successfully, new record ID: " + newId);  
        } else {  
            System.err.println("Creation failed: " + result.getResultMsg());  
        }  
    }  
}  
```

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

### Verify and Install SDK

Source: https://open.lovrabet.com/en/docs/lovrabet-sdk/troubleshooting

Commands to check if the SDK is installed and to install necessary dependencies.

```bash
# Confirm SDK is installed  
npm list @lovrabet/sdk  
  
# If not installed, install it  
npm install @lovrabet/sdk  
  
# If it's a TypeScript project, confirm type support  
npm install --save-dev typescript
```

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

### BFF API - Quick Start Examples

Source: https://open.lovrabet.com/en/docs/lovrabet-sdk/bff-api

Illustrates basic and parameterized calls to the `execute` method, including TypeScript type support.

```javascript
import { createClient } from "@lovrabet/sdk";

const client = createClient({
  accessKey: process.env.LOVRABET_ACCESS_KEY,
  appCode: "your-app-code",
});

// Basic Call
const result = await client.bff.execute({
  scriptName: 'getUserDashboard'
});
console.log("User data:", result);

// Call with Parameters
const price = await client.bff.execute({
  scriptName: 'calculatePrice',
  params: {
    productId: '123',
    quantity: 10,
    userLevel: 'VIP'
  }
});
console.log("Calculation result:", price);

// TypeScript Type Support
interface PriceResult {
  originalPrice: number;
  discountedPrice: number;
  discount: number;
  finalPrice: number;
}

const typedPrice = await client.bff.execute<PriceResult>({
  scriptName: 'calculatePrice',
  params: { productId: '123', quantity: 10 }
});
console.log(`Original price: ${typedPrice.originalPrice}`);
```

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

### SDK Installation

Source: https://open.lovrabet.com/en/docs/openapi/intro

Commands to install the official OpenLovaRabet SDK using npm or bun.

```bash
npm install @lovrabet/sdk  
# or  
bun add @lovrabet/sdk
```

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

### Install Lovrabet SDK

Source: https://open.lovrabet.com/en/docs/openapi/quickstart

Commands to install the official SDK using npm or bun.

```bash
npm install @lovrabet/sdk  
# or  
bun add @lovrabet/sdk  
```

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

### Install CLI and Authenticate

Source: https://open.lovrabet.com/en/docs/guides/step-guide

Install the global CLI tool and authenticate your session to enable project management commands.

```bash
# Install CLI tool (global installation, only needed once)  
npm install -g @lovrabet/cli  
  
# Login to your Lovrabet account  
lovrabet auth
```

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

### Start Local Development Server

Source: https://open.lovrabet.com/en/docs/guides/faq

Run the `lovrabet start` command to launch the local development server. The extended application will be accessible independently.

```bash
lovrabet start  
# Extended app runs independently at http://localhost:3000  
# Can debug business logic, data fetched from real system via SDK  
```

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

### Install Lovrabet SDK

Source: https://open.lovrabet.com/en/docs/lovrabet-sdk/quick-start

Commands to install the SDK using npm or yarn.

```bash
npm install @lovrabet/sdk  
# or  
yarn add @lovrabet/sdk  
```

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

### SDK Usage Example

Source: https://open.lovrabet.com/en/docs/openapi/intro

Examples demonstrating how to use the official SDK for various operations.

```APIDOC
## SDK Usage Examples

### Batch Query
```javascript
// Batch query (supports pagination, sorting, filtering)
const users = await client.models.users.filter(
  {
    currentPage: 1,
    pageSize: 20,
    status: "active", // Filtering
  },
  [
    { priority: SortOrder.DESC }, // Multi-field sorting
    { createTime: SortOrder.DESC },
  ]
);
```

### Single Query
```javascript
// Query single record
const user = await client.models.users.getOne(123);
```

### Create Data
```javascript
// Create data
const newUser = await client.models.users.create({
  name: "John Doe",
  email: "john@example.com",
});
```

### Update Data
```javascript
// Update data
const updated = await client.models.users.update(123, {
  status: "inactive",
});
```
```

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

### Example of Setting AppCode

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/quickstart

An example demonstrating how to use the `lovrabet config set appcode` command with a specific AppCode value.

```bash
lovrabet config set appcode app-c4c89304
```

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

### Install Lovrabet CLI

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/installation

Global installation commands for the Lovrabet CLI using npm or Bun.

```bash
npm install --global @lovrabet/cli  
```

```bash
bun install --global @lovrabet/cli  
```

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

### Amp CLI Installation

Source: https://open.lovrabet.com/en/docs/mcp/config-guide

Install the Lovrabet MCP server using the Amp CLI.

```bash
amp mcp add lovrabet-dataset -- npx -y @lovrabet/dataset-mcp-server
```

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

### Install Lovrabet CLI via sudo

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/windows-guide

Use this command to install the CLI globally on WSL if you have sufficient permissions.

```bash
sudo npm install --global @lovrabet/cli
```

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

### Recommended Menu Naming Examples

Source: https://open.lovrabet.com/en/docs/guides/faq

Examples of concise and clear menu names that follow platform standards.

```text
Customer Analysis
Sales Funnel
Data Reports
```

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

### Complete Example: Create Product List Page

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/pages

This example shows how to create a product list page using the 'hello-world' template, highlighting the selection process.

```bash
$ lovrabet add page  
❓ Please select a page template:  
  ◆ blank (blank page)  
  ◆ hello-world (example page) ← Select this  
  
❓ Please enter route path: shop/products  
  
✅ Page created successfully!  
   File location: src/pages/shop/products/  
   Access URL: http://localhost:5173/shop/products  

```

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

### Fuzzy Matching Examples

Source: https://open.lovrabet.com/en/docs/lovrabet-sdk/filter-api

Utilize $contain for partial string matches and $startWith for prefix matches. Examples query names containing 'hello' and emails starting with 'admin'.

```javascript
const result = await client.models.users.filter({
  where: {
    name: { $contain: "hello" },
  },
});

const result = await client.models.users.filter({
  where: {
    email: { $startWith: "admin" },
  },
});
```

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

### Get Select Options Usage Examples

Source: https://open.lovrabet.com/en/docs/lovrabet-sdk/api-reference

Illustrates fetching user, order status, and department options using getSelectOptions, including a React example with useState and useEffect.

```javascript
// Get user dropdown options
const userOptions = await client.models.users.getSelectOptions({
  code: "user_id",
  label: "user_name",
});

console.log(userOptions);
// [
//   { label: 'Zhang San', value: 'user001' },
//   { label: 'Li Si', value: 'user002' }
// ]

// Use in React Select component
import { Select } from "antd";

function UserSelector() {
  const [options, setOptions] = useState([]);

  useEffect(() => {
    const loadOptions = async () => {
      const data = await client.models.users.getSelectOptions({
        code: "id",
        label: "name",
      });
      setOptions(data);
    };
    loadOptions();
  }, []);

  return (
    <Select placeholder="Select user">
      {options.map((opt) => (
        <Option key={opt.value} value={opt.value}>
          {opt.label}
        </Option>
      ))}
    </Select>
  );
}

// Order status selector
const statusOptions = await client.models.orderStatus.getSelectOptions({
  code: "status_code",
  label: "status_name",
});

// Department selector
const deptOptions = await client.models.departments.getSelectOptions({
  code: "dept_id",
  label: "dept_name",
});
```

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

### Initialize New Project

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/commands

Create a new project structure from scratch including dependencies and configuration.

```bash
lovrabet create my-new-project  
cd my-new-project  

```

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

### Generated API Configuration Files

Source: https://open.lovrabet.com/en/docs/lovrabet-sdk/model-aliases

Example of the auto-generated model configuration and client setup files.

```typescript
import { registerModels, type ModelsConfig } from "@lovrabet/sdk";  
  
export const LOVRABET_MODELS_CONFIG: ModelsConfig = {  
  appCode: "your-app-code",  
  models: [  
    {  
      datasetCode: "8d2dcbae08b54bdd84c00be558ed48df",  
      tableName: "orders",  
      alias: "orders"  
    },  
    {  
      datasetCode: "a1b2c3d4e5f6789012345678abcdef12",  
      tableName: "customers",  
      alias: "customers"  
    },  
    {  
      datasetCode: "f9e8d7c6b5a4321098765432fedcba98",  
      tableName: "products",  
      alias: "products"  
    },  
    // ... all datasets auto-generated  
  ],  
};  
  
registerModels(LOVRABET_MODELS_CONFIG);  
```

```typescript
import { createClient } from "@lovrabet/sdk";  
import "./api"; // Auto-register configuration  
  
export const lovrabetClient = createClient();  
```

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

### Incorrect Route Path Examples

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/pages

These examples illustrate invalid route path formats that will cause errors. Ensure your paths do not start with '/', end with '/', contain '//', spaces, or special characters.

```bash
/about                   # Cannot start with /  
about/                   # Cannot end with /  
user//profile            # Cannot contain consecutive //  
user profile             # Cannot contain spaces  
user@profile             # Cannot contain special characters  
中文页面                  # Chinese names not supported  

```

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

### Create a New Project

Source: https://open.lovrabet.com/en/docs/guides/step-guide

Initialize a new project using the CLI and start the development server.

```bash
lovrabet create
```

```bash
* Project name: my-crm  
* Application AppCode [optional]: app-c4c89304  
  
✔ Copy project files  
✔ Update project configuration  
✔ Install npm dependencies  
✔ Pull API configuration  
  
🎉 Project created successfully!  
  
  cd my-crm  
  lovrabet start
```

```bash
cd my-crm  
lovrabet start
```

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

### Create SDK Client Instance

Source: https://open.lovrabet.com/en/docs/java-opensdk/core-concepts

Example of instantiating the client with access credentials.

```java
String accessKey = "ak-OD8xWhMOsL5ChQ3Akhv4uYYiu1fPOFQGVF9BULIeov8";  
String baseUrl = "https://runtime.lovrabet.com/openapi";  
  
LovrabetSDKClient sdkClient = new LovrabetSDKClient(accessKey, baseUrl);
```

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

### Correct Route Path Examples

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/pages

Follow these examples for valid route path naming conventions when creating new pages. Avoid starting or ending with slashes, consecutive slashes, spaces, or unsupported characters.

```bash
about                    # About page  
contact                  # Contact page  
user/profile             # User profile  
user/settings            # User settings  
admin/dashboard          # Admin dashboard  
shop/product/detail      # Product detail page  
user-center              # Using hyphens  
api_docs                 # Using underscores  

```

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

### Complete Example: Create User Profile Page

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/pages

This example demonstrates the interactive CLI prompts for creating a user profile page using the 'blank' template.

```bash
$ lovrabet add page  
❓ Please select a page template:  
  ◆ blank (blank page)  
  ◆ hello-world (example page)  
  
❓ Please enter route path: user/profile  
  
✅ Page created successfully!  
   File location: src/pages/user/profile/  
   Access URL: http://localhost:5173/user/profile  

```

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

### View Installed Skills

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/skills

Commands to inspect the skill manifest and guide files within the project directory.

```bash
# View manifest  
cat .lovrabet/skill-manifest.json  
  
# View guides directory  
ls .lovrabet/skill/.shared/guides/  
  
# Read specific guide  
cat .lovrabet/skill/.shared/guides/01-typescript-sdk/guide.md
```

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

### Get BFF Script Details Tool Parameters and Response

Source: https://open.lovrabet.com/en/docs/mcp/bff-save

Schema for the get_bff_script_info tool and an example of its returned data.

```json
{
  id: number;            // BFF script ID (required)  
  appCode?: string;      // Application code (optional)  
  cookie?: string;       // Authentication cookie (optional)  
}
```

```json
{
  "id": 123,
  "name": "getUserInfo",
  "description": "Get user detailed information",
  "scriptContent": "export default async function(params, context) {\n  const userId = params.userId;\n  const user = await context.client.models.customer.getOne({ id: userId });\n  return { success: true, data: user };\n}",
  "scriptType": "ENDPOINT",
  "createTime": "2026-03-20 10:30:00",
  "updateTime": "2026-03-26 14:20:00",
  "createUser": "user@example.com",
  "updateUser": "user@example.com"
}
```

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

### Start Development Server

Source: https://open.lovrabet.com/en/docs/guides/scenario-data-list

Command to launch the development environment and verify the implementation.

```bash
lovrabet start  
```

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

### Initialize Existing Project

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/commands

Workflow for adding Lovrabet support to an existing project version 1.1.12 or higher.

```bash
lovrabet auth                         # Login (if not already logged in)  
cd existing-project                   # Enter project  
lovrabet init --appcode my-app        # Initialize configuration  
lovrabet api pull                     # Generate API code  
lovrabet api doc                      # Generate API documentation  
lovrabet menu sync                    # Sync menus to platform (v1.1.15+)  
lovrabet start                        # Start development
```

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

### Get Model Configuration Usage Example

Source: https://open.lovrabet.com/en/docs/lovrabet-sdk/api-reference

Demonstrates how to call getConfig and access properties like tableName and datasetCode from the returned configuration object.

```javascript
const config = client.models.users.getConfig();
console.log("Table name:", config.tableName);
console.log("Dataset ID:", config.datasetCode);
```

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

### Security Best Practices for Client Initialization

Source: https://open.lovrabet.com/en/docs/openapi/intro

Examples showing insecure versus secure methods for handling access keys and tokens when initializing the client.

```javascript
// Dangerous! Will expose secret key  
const client = createClient({  
  accessKey: "sk_live_xxx", // Don't do this!  
});
```

```javascript
// Server-side: Use environment variables  
const client = createClient({  
  accessKey: process.env.LOVRABET_ACCESS_KEY,  
});  
  
// Browser: Use pre-generated token  
const { token } = await fetch("/api/token").then((r) => r.json());  
const client = createClient({ token });
```

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

### Project File Structure

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/commands

The directory layout created after installing Lovrabet AI skills, including IDE-specific rules and shared development guides.

```text
your-project/  
├── .cursorrules              # Cursor general rules  
├── .cursor/  
│   ├── mcp.json              # MCP configuration (if MCP is configured)  
│   └── skills/               # Cursor skills  
├── .lovrabet/  
│   ├── skill-manifest.json   # Skill manifest  
│   └── skill/  
│       └── .shared/  
│           └── guides/       # Shared development guides  
│               ├── 01-typescript-sdk/guide.md  
│               ├── 02-mcp-sql-workflow/guide.md  
│               ├── 03-antd-style/guide.md  
│               ├── 05-api-integration/guide.md  
│               ├── 06-menu-management/guide.md  
│               └── 07-backend-function/guide.md  
└── agents.md                 # Claude Code rules
```

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

### Set and View Application Code

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/configuration

This example shows how to set the application code and then view the current setting. This is crucial for ensuring team members use the same backend application.

```bash
# Set application code
lovrabet config set app my-shop-app
```

```bash
# View current setting
lovrabet config get app
```

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

### Navigate and Start Lovrabet Project

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/quickstart

After creating your project, change into the project directory and start the development server using these commands. This will launch Vite and open the project in your browser.

```bash
cd my-app
lovrabet start
```

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

### Generated Lovrabet API Configuration (v1.2.0+)

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/commands

Example of the generated API configuration file using array format with `datasetCode`. This format is used starting from v1.2.0.

```typescript
export const LOVRABET_MODELS_CONFIG = {
  appCode: 'my-app',
  models: [
    {
      datasetCode: '8d2dcbae08b54bdd84c00be558ed48df',
      tableName: 'users',
      alias: 'users',      // Optional: Model alias (syntactic sugar) 
      name: 'User Management',    // Optional: UI display name  
    },
  ],
} as const;
```

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

### Get Model Instance by Index

Source: https://open.lovrabet.com/en/docs/lovrabet-sdk/api-reference

Retrieve a model instance using its numerical index (starting from 0). This allows access to model methods for data operations.

```typescript
// Get the first model by index
const firstModel = client.getModel(0);
const data = await firstModel.filter();
```

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

### Get Dataset List Example

Source: https://open.lovrabet.com/en/docs/java-opensdk/api-reference

Use this to retrieve a list of all dataset codes associated with a specific application. Ensure the appCode is valid and exists within the Lovrabet system.

```java
import com.lovrabet.runtime.opensdk.client.LovrabetSDKClient;
import com.lovrabet.runtime.opensdk.model.LovrabetRequest;
import com.lovrabet.runtime.opensdk.model.LovrabetResult;
import java.util.List;

public class GetDatasetListExample {
    public static void main(String[] args) {
        // Create client
        LovrabetSDKClient sdkClient = new LovrabetSDKClient(
            "ak-OD8xWhMOsL5ChQ3Akhv4uYYiu1fPOFQGVF9BULIeov8",
            "https://runtime.lovrabet.com/openapi"
        );

        // Build request
        LovrabetRequest request = new LovrabetRequest();
        request.setAppCode("app-c2dd52a2");

        // Call interface
        LovrabetResult<?> result = sdkClient.getDatasetCodeList(request);

        // Process result
        if (result.isSuccess()) {
            List<String> datasetList = (List<String>) result.getData();
            System.out.println("Dataset count: " + datasetList.size());
            System.out.println("Dataset list: " + datasetList);
        } else {
            System.err.println("Failed to get: " + result.getResultMsg());
        }
    }
}
```

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

### Lovrabet CLI AI Integration Setup

Source: https://open.lovrabet.com/en/docs/changelog

Commands for setting up AI integration with the Lovrabet CLI, including configuring Cursor MCP and installing development standards Skills.

```bash
# AI integration (New)
lovrabet mcp install --cursor    # Configure Cursor MCP
lovrabet skill install --cursor  # Install development standards Skill

```

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

### Start Development Server with Lovrabet CLI

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/cors-solution

Launches the development server which automatically maps the local project to the dev.lovrabet.com domain.

```bash
# Start development server  
lovrabet start  
  
# Access URL will be automatically mapped to  
# https://dev.lovrabet.com/your-app-path  
```

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

### Initialize and Use LovrabetSDKClient

Source: https://open.lovrabet.com/en/docs/java-opensdk/quickstart

Create a client instance with your credentials and execute a request to fetch the dataset list.

```java
package com.example.demo;  
  
import com.lovrabet.runtime.opensdk.client.LovrabetSDKClient;  
import com.lovrabet.runtime.opensdk.model.LovrabetRequest;  
import com.lovrabet.runtime.opensdk.model.LovrabetResult;  
  
import java.util.List;  
  
public class QuickStartDemo {  
    public static void main(String[] args) {  
        // 1. Configure access credentials (replace with your own)  
        String accessKey = "ak-OD8xWhMOsL5ChQ3Akhv4uYYiu1fPOFQGVF9BULIeov8";  
        String appCode = "app-c2dd52a2";  
        String baseUrl = "https://runtime.lovrabet.com/openapi";  
  
        // 2. Create SDK client  
        LovrabetSDKClient sdkClient = new LovrabetSDKClient(accessKey, baseUrl);  
  
        // 3. Build request parameters  
        LovrabetRequest request = new LovrabetRequest();  
        request.setAppCode(appCode);  
  
        // 4. Call API interface  
        LovrabetResult<?> result = sdkClient.getDatasetCodeList(request);  
  
        // 5. Handle response  
        if (result.isSuccess()) {  
            List<String> datasetList = (List<String>) result.getData();  
            System.out.println("✅ Success!");  
            System.out.println("Dataset count: " + datasetList.size());  
            System.out.println("Dataset list: " + datasetList);  
        } else {  
            System.err.println("❌ Failed: " + result.getResultMsg());  
        }  
    }  
}  
```

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

### Correct Lovrabet Route Path Formats

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/troubleshooting

Examples of correct and incorrect route path formats for Lovrabet pages. Ensure routes do not start with '/', end with '/', or contain spaces or special characters.

```bash
# Correct examples
about
user/profile
admin/user/list

# Wrong examples
/about        # Cannot start with /
about/        # Cannot end with /
user profile  # Cannot contain spaces
user@profile  # Cannot contain special characters
```

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

### Server-Side Application Client Setup

Source: https://open.lovrabet.com/en/docs/lovrabet-sdk/authentication

Configure the Lovrabet client for a server-side application using environment variables for app code, dataset codes, and authentication keys. Includes an example API route for fetching user data.

```typescript
// server/lovrabet-client.ts
import { registerModels, createClient } from "@lovrabet/sdk";

registerModels({
  appCode: process.env.LOVRABET_APP_CODE,
  models: [
    {
      datasetCode: process.env.USERS_DATASET_CODE,
      tableName: "users",
      alias: "users",
    },
    {
      datasetCode: process.env.ORDERS_DATASET_CODE,
      tableName: "orders",
      alias: "orders",
    },
  ],
});

// Use keys from environment variables
export const serverClient = createClient({
  accessKey: process.env.LOVRABET_ACCESS_KEY,
  secretKey: process.env.LOVRABET_SECRET_KEY,
});

// Use in API routes
export async function GET() {
  try {
    // Use datasetCode from environment variables
    const users = await serverClient.models[`dataset_${process.env.USERS_DATASET_CODE}`].filter({
      currentPage: 1,
      pageSize: 100,
    });

    return Response.json(users);
  } catch (error) {
    console.error("Failed to fetch user data:", error);
    return Response.json({ error: "Internal Server Error" }, { status: 500 });
  }
}
```

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

### Common API Documentation Scenarios

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/commands

Practical examples for team collaboration, selective documentation updates, and multi-app management workflows.

```bash
# Scenario 1: Team collaboration - Generate docs and commit to Git  
lovrabet api doc  
git add docs/  
git commit -m "docs: Update API documentation"  
  
# Scenario 2: Selective generation - Only update specific dataset docs  
lovrabet api doc --datasetcode users,orders  
  
# Scenario 3: Multi-app management - Generate separate docs for different apps  
lovrabet api doc --appcode user-app --output ./docs/user-api  
lovrabet api doc --appcode admin-app --output ./docs/admin-api
```

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

### Get Single Record Example

Source: https://open.lovrabet.com/en/docs/java-opensdk/api-reference

Retrieve a single data record from a specified dataset using its primary key ID. Requires a valid appCode, modelCode, and the record's ID. Handles potential errors like missing parameters or non-existent IDs.

```java
import com.lovrabet.runtime.opensdk.client.LovrabetSDKClient;
import com.lovrabet.runtime.opensdk.model.LovrabetRequest;
import com.lovrabet.runtime.opensdk.model.LovrabetResult;
import java.util.Map;

public class GetOneExample {
    public static void main(String[] args) {
        // Create client
        LovrabetSDKClient sdkClient = new LovrabetSDKClient(
            "ak-OD8xWhMOsL5ChQ3Akhv4uYYiu1fPOFQGVF9BULIeov8",
            "https://runtime.lovrabet.com/openapi"
        );

        // Build request
        LovrabetRequest request = new LovrabetRequest();
        request.setAppCode("app-c2dd52a2");
        request.setModelCode("32c036010c504757b80d438e3c0ec8b7");
        request.setId(513L);

        // Call interface
        LovrabetResult<?> result = sdkClient.getOne(request);

        // Process result
        if (result.isSuccess()) {
            Map<String, Object> data = (Map<String, Object>) result.getData();
            System.out.println("Data content: " + data);

            // Access specific fields
            System.out.println("ID: " + data.get("id"));
            System.out.println("TEXT_1: " + data.get("TEXT_1"));
            System.out.println("NUMBER_3: " + data.get("NUMBER_3"));
        } else {
            System.err.println("Failed to get: " + result.getResultMsg());
        }
    }
}
```

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

### Build and Deploy Project

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/menu-sync

Build your project and deploy it to a CDN to get the necessary resource links for syncing.

```bash
# Build project  
lovrabet build   # or npm run build  
  
# Deploy to CDN, get resource links  
# For example: https://cdn.example.com/assets/index.js  
# For example: https://cdn.example.com/assets/index.css  
```

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

### Install and Verify Lovrabet CLI

Source: https://open.lovrabet.com/en/docs/guides/tutorial

Installs the Lovrabet CLI globally via npm and verifies the installation by checking the version.

```bash
# Install CLI  
npm install -g @lovrabet/cli  
  
# Verify installation  
lovrabet --version
```

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

### Example CLI Output

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/installation

Expected output format when running the help command.

```text
Lovrabet CLI - Frontend Development Scaffold  
  
Usage:  
  lovrabet <command> [options]  
  
Available commands:  
  create    Create new project  
  auth      Login authentication  
  ...  
```

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

### Install Lovrabet Skill using npx

Source: https://open.lovrabet.com/en/docs/changelog

Use 'npx skills' for installing Lovrabet skills. The old 'lovrabet skill install' command is deprecated.

```bash
npx skills add lovrabet/lovrabet-skill
```

```bash
# lovrabet skill install --cursor
```

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

### Initialize SDK in Node.js

Source: https://open.lovrabet.com/en/docs/lovrabet-sdk/authentication

Sets up the SDK using environment variables and OpenAPI keys for server-side operations.

```javascript
// server/lovrabet.js  
const { registerModels, createClient } = require("@lovrabet/sdk");  
  
registerModels({  
  appCode: process.env.LOVRABET_APP_CODE,  
  models: [  
    { datasetCode: process.env.USERS_DATASET_CODE, tableName: "users", alias: "users" },  
  ],  
});  
  
const client = createClient({  
  accessKey: process.env.LOVRABET_ACCESS_KEY,  
  secretKey: process.env.LOVRABET_SECRET_KEY,  
});  
  
module.exports = { client };
```

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

### Install Node.js using nvm in WSL

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/windows-guide

Installs Node Version Manager (nvm), reloads the shell configuration, and then installs the latest LTS version of Node.js.

```bash
# Install nvm  
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash  
  
# Reload configuration  
source ~/.bashrc  
  
# Install Node.js  
nvm install --lts  
nvm use --lts  
```

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

### Install Node.js 20.x using NodeSource in WSL

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/windows-guide

Installs Node.js version 20.x and verifies the installation. This script is intended to be run within a WSL environment.

```bash
# Install Node.js 20.x using NodeSource  
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -  
sudo apt-get install -y nodejs  
  
# Verify installation  
node --version  
npm --version  
```

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

### Start Lovrabet on a Different Port

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/troubleshooting

Use this command to start the Lovrabet application on a specific port. Ensure the PORT environment variable is set before running the start command.

```bash
PORT=3000 lovrabet start
```

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

### Query Output Example

Source: https://open.lovrabet.com/en/docs/lovrabet-sdk/sql-tutorial

Example structure of the data returned by the API.

```text
Query successful, returned 2 records  
{  
  id: 1001,  
  name: 'Zhang San',  
  email: 'zhangsan@example.com',  
  login_count: 15,  
  action_count: 127,  
  last_login_time: '2025-11-12 10:30:00'  
}  
{  
  id: 1002,  
  name: 'Li Si',  
  email: 'lisi@example.com',  
  login_count: 12,  
  action_count: 98,  
  last_login_time: '2025-11-11 16:45:00'  
}  
```

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

### Hello Lovrabet: Basic SDK Usage

Source: https://open.lovrabet.com/en/docs/java-opensdk

A complete Java program demonstrating how to initialize the Lovrabet SDK client, build a request, call an API, and handle the result. Replace placeholder credentials with your actual Access Key and Base URL.

```java
import com.lovrabet.runtime.opensdk.client.LovrabetSDKClient;
import com.lovrabet.runtime.opensdk.model.LovrabetRequest;
import com.lovrabet.runtime.opensdk.model.LovrabetResult;

public class HelloLovrabet {
    public static void main(String[] args) {
        // 1. Create client
        String accessKey = "ak-your-access-key";
        String baseUrl = "https://runtime.lovrabet.com/openapi";
        LovrabetSDKClient client = new LovrabetSDKClient(accessKey, baseUrl);

        // 2. Build request
        LovrabetRequest request = new LovrabetRequest();
        request.setAppCode("app-xxx");

        // 3. Call API
        LovrabetResult<?> result = client.getDatasetCodeList(request);

        // 4. Handle result
        if (result.isSuccess()) {
            System.out.println("Dataset list: " + result.getData());
        } else {
            System.err.println("Failed: " + result.getResultMsg());
        }
    }
}
```

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

### Lovrabet Main Application Configuration Example

Source: https://open.lovrabet.com/en/docs/openapi/comparison

Example configuration for integrating a sub-application into the Lovrabet main application. This includes setting the route path, micro-app ID, and resource loading details.

```text
Route Path: /sales-funnel  
Micro-app Unique ID: salesFunnelApp  
Resource Loading Method: import (for es module)  
Resource Loading List:  
  https://your-domain.com/dist/sales-funnel/main.js  
  https://your-domain.com/dist/sales-funnel/main.css  

```

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

### GET /get_bff_script_info

Source: https://open.lovrabet.com/en/docs/mcp/tools

Get detailed information for a specified Backend Function script.

```APIDOC
## GET /get_bff_script_info

### Description
Get detailed information for a specified Backend Function script, including code content and parameter descriptions.

### Method
GET

### Endpoint
/get_bff_script_info

### Parameters
#### Query Parameters
- **appCode** (string) - Optional - Application code, defaults to environment variable
- **cookie** (string) - Optional - Cookie string
- **env** (string) - Optional - Environment: online (default) or daily
- **scriptName** (string) - Required - Script name

### Response
#### Success Response (200)
- **scriptName** (string) - Script name
- **description** (string) - Script description
- **code** (string) - Script code
- **params** (object) - Parameter descriptions
- **usage** (string) - Usage examples
```

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

### Complete Data Query in 3 Steps

Source: https://open.lovrabet.com/en/docs/java-opensdk

Demonstrates the basic steps to perform a data query using the LovrabetSDKClient. Ensure you have your accessKey and baseUrl configured.

```java
LovrabetSDKClient client = new LovrabetSDKClient(accessKey, baseUrl);
LovrabetRequest request = new LovrabetRequest();
request.setAppCode("app-xxx");
LovrabetResult<?> result = client.getDatasetCodeList(request);
```

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

### Create a New Project

Source: https://open.lovrabet.com/en/docs/guides/tutorial

Initializes a new project using the CLI, which prompts for project details and pulls API configurations.

```bash
# Create project  
lovrabet create
```

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

### Initialize Lovrabet Configuration

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/commands

Use `lovrabet init` to add Lovrabet support to existing projects by creating a `.lovrabetrc` file. It can be run interactively or with a specified appcode.

```bash
# Interactive initialization  
lovrabet init  
  
# Directly specify appcode  
lovrabet init --appcode my-app-code  
```

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

### Install MCP for Cursor

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/mcp

Executes the installation of the MCP protocol specifically for the Cursor editor.

```bash
lovrabet mcp install --cursor
```

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

### Real Login Flow Example

Source: https://open.lovrabet.com/en/docs/lovrabet-sdk/authentication

This example demonstrates a complete login flow, including API calls, token management, and local storage. It initializes the SDK client and handles user authentication.

```typescript
// auth/auth-manager.ts  
import { createClient } from "@lovrabet/sdk";  
import "./api"; // Import pre-registered configuration  
  
class AuthManager {  
  private client = createClient(); // Initialize client  
  
  async login(username: string, password: string) {  
    try {  
      // Call login API  
      const response = await fetch("/api/auth/login", {  
        method: "POST",  
        headers: { "Content-Type": "application/json" },  
        body: JSON.stringify({ username, password }),  
      });  
  
      if (response.ok) {  
        const { token } = await response.json();  
  
        // Set token to SDK  
        this.client.setToken(token);  
  
        // Store locally  
        localStorage.setItem("auth_token", token);  
  
        return { success: true };  
      } else {  
        return { success: false, error: "Login failed" };  
      }  
    } catch (error) {  
      return { success: false, error: "Network error" };  
    }  
  }  
  
  logout() {  
    // Clear token in SDK  
    this.client.setToken(null);  
  
    // Clear local storage  
    localStorage.removeItem("auth_token");  
  
    // Redirect to login page  
    window.location.href = "/login";  
  }  
  
  getClient() {  
    return this.client;  
  }  
  
  // Restore token from local storage on initialization  
  init() {  
    const token = localStorage.getItem("auth_token");  
    if (token) {  
      this.client.setToken(token);  
    }  
  }  
}  
  
export const authManager = new AuthManager();  
  
// Initialize on app startup  
authManager.init();  
  
// Export client for business code use  
export const lovrabetClient = authManager.getClient();  

```

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

### Install AI Skills

Source: https://open.lovrabet.com/en/docs/lovrabet-cli/mcp

Installs recommended AI skills to enhance MCP functionality.

```bash
# Install AI Skills (recommended)
npx skills add lovrabet/lovrabet-skill
```

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

### Create Project with CLI

Source: https://open.lovrabet.com/en/docs

Use the CLI to create a new Lovrabet project. It prompts for project name and app code, then automatically pulls API configuration and sets up the project.

```bash
$ lovrabet create  
  
* Project name: my-crm  
* App AppCode [Optional]: app-c4c89304  
√ Valid login status detected  
* Do you want to automatically pull API configuration? ▶ Yes  
  
✔ Copy project files  
✔ Update project configuration  
✔ Install npm dependencies  
✔ Pull API configuration  
  
🎉 Project created successfully!  
  
  cd my-crm  
  lovrabet start  
  
📦 Generated APIs:  
   └── src/api/  
       ├── api.ts      # API interfaces for all data tables  
       └── client.ts   # Encapsulated client, ready to use  

```
Tokens:
Raw