open-index/open-npm huggingface dataset:
npm package: @sthg-sdk/dataease.api
Description: DataEase API client built on top of STHG Tiangong SDK
Latest version: 1.2.7

# @sthg-sdk/dataease-api

DataEase API client built on top of the STHG Tiangong SDK infrastructure. This package provides a comprehensive TypeScript client for the DataEase visualization platform APIs.

## Installation

```bash
npm install @sthg-sdk/dataease-api
```

## Usage

```typescript
import { DataEaseClient } from '@sthg-sdk/dataease-api';
import { ClientFactory } from '@sthg-sdk/shared-client';

// Create an HTTP client using the shared client factory
const httpClient = ClientFactory.createHttpClient({
  baseUrl: 'https://your-dataease-instance.com',
  token: 'your-api-token',
});

// Create a DataEase client
const dataEaseClient = new DataEaseClient(httpClient);

// Use the client to make API calls
const watermarkInfo = await dataEaseClient.getWatermark();
await dataEaseClient.saveWatermark(watermarkRequest);
```

## Features

This client provides access to all major DataEase API endpoints including:

### Visualization Management
- Watermark management
- Visualization subjects
- Background management
- Canvas operations

### Data Visualization
- Dashboard operations
- View management
- Resource management
- Copy and export operations

### Sharing & Collaboration
- Share management
- Ticket system
- Access control

### Advanced Features
- Linkage management
- Jump configurations
- Outer parameters
- Store/favorites management

### File Operations
- Static resource uploads
- Template import/export

## API Reference

The `DataEaseClient` class provides methods for all supported DataEase API endpoints. Each method is properly typed with TypeScript interfaces that correspond to the DataEase API schema.

### Example Methods

```typescript
// Watermark operations
await client.saveWatermark(watermarkRequest);
const watermark = await client.getWatermark();

// Visualization operations
const visualizations = await client.getVisualizationTree(request);
await client.saveCanvas(canvasRequest);

// Share operations
await client.switcherShare(resourceId);
const shareDetail = await client.getShareDetail(resourceId);

// File uploads
await client.uploadStaticResource(fileId, file);
```

## Error Handling

The client automatically handles API errors through the underlying STHG Tiangong SDK infrastructure. All API errors are properly typed and include relevant error information.

## Contributing

This package is part of the STHG Tiangong SDK project. Please refer to the main project documentation for contribution guidelines.
npm package: @sthg-tiangong-sdk/dataease.api
Description: DataEase API client built on top of STHG Tiangong SDK
Latest version: 1.0.0

# @sthg-tiangong-sdk/dataease-api

DataEase API client built on top of the STHG Tiangong SDK infrastructure. This package provides a comprehensive TypeScript client for the DataEase visualization platform APIs.

## Installation

```bash
npm install @sthg-tiangong-sdk/dataease-api
```

## Usage

```typescript
import { DataEaseClient } from '@sthg-tiangong-sdk/dataease-api';
import { ClientFactory } from '@sthg-tiangong-sdk/shared-client';

// Create an HTTP client using the shared client factory
const httpClient = ClientFactory.createHttpClient({
  baseUrl: 'https://your-dataease-instance.com',
  token: 'your-api-token',
});

// Create a DataEase client
const dataEaseClient = new DataEaseClient(httpClient);

// Use the client to make API calls
const watermarkInfo = await dataEaseClient.getWatermark();
await dataEaseClient.saveWatermark(watermarkRequest);
```

## Features

This client provides access to all major DataEase API endpoints including:

### Visualization Management
- Watermark management
- Visualization subjects
- Background management
- Canvas operations

### Data Visualization
- Dashboard operations
- View management
- Resource management
- Copy and export operations

### Sharing & Collaboration
- Share management
- Ticket system
- Access control

### Advanced Features
- Linkage management
- Jump configurations
- Outer parameters
- Store/favorites management

### File Operations
- Static resource uploads
- Template import/export

## API Reference

The `DataEaseClient` class provides methods for all supported DataEase API endpoints. Each method is properly typed with TypeScript interfaces that correspond to the DataEase API schema.

### Example Methods

```typescript
// Watermark operations
await client.saveWatermark(watermarkRequest);
const watermark = await client.getWatermark();

// Visualization operations
const visualizations = await client.getVisualizationTree(request);
await client.saveCanvas(canvasRequest);

// Share operations
await client.switcherShare(resourceId);
const shareDetail = await client.getShareDetail(resourceId);

// File uploads
await client.uploadStaticResource(fileId, file);
```

## Error Handling

The client automatically handles API errors through the underlying STHG Tiangong SDK infrastructure. All API errors are properly typed and include relevant error information.

## Contributing

This package is part of the STHG Tiangong SDK project. Please refer to the main project documentation for contribution guidelines.