Digo API

TypeScript API for building interactive data visualizations with the DIGO ecosystem.

Installation

npm install @digo-org/digo-api

Quick Start

Create a visualization asset by extending the base class:

import { DigoAsset } from '@digo-org/digo-api';
import { ReactNode } from 'react';

export class MyVisualization extends DigoAsset {
  render(): ReactNode {
    return (
      <div>
        {this.instances.map(instance => (
          <div key={instance.id}>
            {/* Your visualization here */}
          </div>
        ))}
      </div>
    );
  }
}

Core Concepts

• DigoAsset: Base class for creating visualization components
• Data Types: Define data structure with columns, rows, and parameters
• Visualization Types: Configure interactive parameters and instances
• Parameter System: Type-safe parameter definitions (NUMBER, COLOR, TEXT, etc.)

Key Exports

Main Classes

• DigoAsset - Base class for visualization assets

Data Definition

• DataTableDefinition - Structure for tabular data
• Row, Column - Data components

Visualization Definition

• VizAssetDefinition - Visualization configuration
• Instance - Individual visualization instances
• CodeFiles - File structure for viz assets

Parameters

• ParameterType - Available parameter types
• Parameter - Parameter definitions
• ParameterValue - Parameter values

Constants

• API_MESSAGES - Message types for asset communication

Note: Types in types-misc.ts and types-llm.ts are internal implementation details and not intended for public use.

Development

# Build the package
npm run build

# Lint code
npm run lint
npm run lint:fix

Publishing

Update version in package.json and run:

npm publish

The prepublish script automatically builds the package before publishing.