@digo-org/digo-api 1.0.35 → 1.0.36

package/README.md

@@ -1,11 +1,6 @@
 # Digo API
 
-This package provides the API interfaces for DIGO Assets, making them available to other workspaces in the monorepo or external projects via npm.
-
-
-## Overview
-
-The Digo API package contains interfaces and utility functions that define and facilitate communication with Digo Assets. These components form the foundation for building applications that work with the Digo ecosystem.
+TypeScript API for building interactive data visualizations with the DIGO ecosystem.
 
 ## Installation
 
@@ -13,94 +8,80 @@ The Digo API package contains interfaces and utility functions that define and f
 npm install @digo-org/digo-api
 ```
 
-## Usage
+## Quick Start
 
-```typescript
-import { DigoApi } from '@digo-org/digo-api';
-// or specific components
-import { YourSpecificComponent } from '@digo-org/digo-api';
-```
+Create a visualization asset by extending the base class:
 
-## Updating the Package
-
-When you need to update the Digo API package, follow these steps:
-
-1. **Make Your Changes**:
-   - Update existing files or add new files in the `src/` directory
-   - Ensure you export any new types, interfaces, or functions from index.ts
-
-2. **Update Version**:
-   - Increment the version number in package.json following [Semantic Versioning](https://semver.org/):
-     - MAJOR version for incompatible API changes
-     - MINOR version for backward-compatible functionality
-     - PATCH version for backward-compatible bug fixes
-
-3. **Build & Test**:
-   ```bash
-   # Lint your code
-   npm run lint
-   
-   # Fix linting issues automatically
-   npm run lint:fix
-   
-   # Build the package
-   npm run build
-   ```
-
-4. **Commit Changes**:
-   - Commit all changes to your repository
-   - Use descriptive commit messages that explain your changes
-
-5. **Publish**:
-   ```bash
-   # The prepublish script will automatically run build
-   npm publish
-   ```
-
-## Understanding package.json
-
-The package.json file contains important configurations:
-
-```json
-{
-  "name": "@digo-org/digo-api",  // Package name with org scope
-  "private": false,              // Allows publishing to npm
-  "version": "1.0.2",            // Current package version
-  "type": "module",              // Use ES modules
-  "main": "src/index.ts",        // Main entry point
-  "types": "src/index.ts",       // TypeScript types entry point
-  "publishConfig": {             // Publishing configuration
-    "access": "public"           // Makes the scoped package publicly available
-  },
-  "scripts": {                   // NPM scripts
-    "build": "tsc --build",      // Compile TypeScript
-    "lint": "eslint ./src",      // Check code quality
-    "lint:fix": "eslint ./src --fix", // Fix code quality issues
-    "prepublish": "rm -rf ./dist && npm run build" // Pre-publish hook
-  },
-  "devDependencies": {           // Development dependencies
-    "@digo/dev-dependencies": "*" // Shared dev dependencies
+```typescript
+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>
+    );
   }
 }
 ```
 
-## Publishing
+## 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`](src/digo-asset.ts) - Base class for visualization assets
+
+### Data Definition
+- [`DataAssetDefinition`](src/types-data.ts) - Structure for tabular data
+- [`Row`](src/types-data.ts), [`Column`](src/types-data.ts) - Data components
+
+### Visualization Definition  
+- [`VizAssetDefinition`](src/types-viz.ts) - Visualization configuration
+- [`Instance`](src/types-viz.ts) - Individual visualization instances
+- [`VizAssetFiles`](src/types-viz-files.ts) - File structure for viz assets
 
-Publishing is handled through npm:
+### Parameters
+- [`ParameterType`](src/types-common.ts) - Available parameter types
+- [`Parameter`](src/types-common.ts) - Parameter definitions
+- [`ParameterValue`](src/types-common.ts) - Parameter values
+
+### Constants
+- [`API_MESSAGES`](src/constants.ts) - Message types for asset communication
+
+### Examples
+- [`DATA_ASSET_DEFINITION_EXAMPLES`](src/examples/data-examples.ts) - Sample data structures
+
+> **Note**: Types in [`types-misc.ts`](src/types-misc.ts) and [`types-llm.ts`](src/types-llm.ts) are internal implementation details and not intended for public use.
+
+## Development
 
 ```bash
-# Login to npm if not already logged in
-npm login
+# Build the package
+npm run build
 
-# Publish package
-npm publish
+# Lint code
+npm run lint
+npm run lint:fix
 ```
 
-The `prepublish` script will automatically:
-1. Remove the old `dist` directory
-2. Run the build process to create a new `dist` directory with the latest code
+## Publishing
+
+Update version in `package.json` and run:
+
+```bash
+npm publish
+```
 
-#### Publishing Issues
-- Verify you're logged into npm with the correct account
-- Ensure the version has been incremented
-- Check that you have the necessary permissions in the @digo-org organization
+The prepublish script automatically builds the package before publishing.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@digo-org/digo-api",
   "private": false,
-  "version": "1.0.35",
+  "version": "1.0.36",
   "type": "module",
   "main": "src/index.ts",
   "types": "src/index.ts",

package/src/types-llm.ts

@@ -1,20 +1,20 @@
 import { CommonMetadata, DataAssetDefinition, Links, VizAssetDefinition, VizAssetFiles } from '@digo-org/digo-api';
 
-export interface Artifact extends CommonMetadata {
-  type:  ArtifactType;
-  value: DataAssetDefinition | VizAssetFiles | VizAssetDefinition | Links;
-}
+export type Artifacts = Partial<Record<ArtifactType, ArtifactValue>> & CommonMetadata;
 
 export enum ArtifactType {
   DATA_ASSET_DEFINITION = 'DATA_ASSET_DEFINITION',
   VIZ_ASSET_FILES =       'VIZ_ASSET_FILES',
   VIZ_ASSET_DEFINITION =  'VIZ_ASSET_DEFINITION',
   LINKS =                 'LINKS',
+  PROJECT_DEFINITION =    'PROJECT_DEFINITION',
 }
 
+export type ArtifactValue = DataAssetDefinition | VizAssetFiles | VizAssetDefinition | Links;
+
 export interface MessagePart {
   type:  MessageType;
-  value: string | Artifact;
+  value: string | Artifacts;
 }
 
 export enum MessageType {

package/src/types-misc.ts

@@ -1,4 +1,4 @@
-import { ArtifactType, DataAssetDefinition, MessagePart, ParameterDefinition, ParameterValueArray, VizAssetDefinition, VizAssetFiles } from '@digo-org/digo-api';
+import { ArtifactType, ArtifactValue, DataAssetDefinition, MessagePart, ParameterDefinition, ParameterValueArray, VizAssetDefinition, VizAssetFiles } from '@digo-org/digo-api';
 
 export type Links = Record<string, string>; /* parameter-id -> column-id */
 
@@ -50,3 +50,8 @@ export enum ArctifactStepAction {
   GENERATED = 'GENERATED',
   EDITED    = 'EDITED',
 }
+
+export interface Artifact extends CommonMetadata {
+  type:  ArtifactType;
+  value: ArtifactValue | ProjectDefinition;
+}