https://github.com/tensr-xyz/tensr-sdk-typescript

Last synced: 6 months ago · JSON representation

Repository

Basic Info

Host: GitHub
Owner: tensr-xyz
Language: TypeScript
Default Branch: main
Size: 35.8 MB

Statistics

Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Releases: 0

Created about 1 year ago · Last pushed 6 months ago

Metadata Files

Readme

Tensr SDK

A powerful TypeScript SDK for building statistical analysis plugins for the Tensr platform. Create custom data analysis tools that integrate seamlessly with Tensr's marketplace.

Features

Plugin-based architecture - Build modular statistical analysis tools
Rich data types - Support for CSV, XLSX, JSON data formats
UI components - Pre-built components for results display
Type safety - Full TypeScript support with comprehensive types
Performance optimized - Tree-shaking enabled for minimal bundle sizes
Testing ready - Comprehensive test suite with 23 passing tests
Easy deployment - Simple build and publish workflow

Installation

bash npm install @tensr/sdk

Quick Start

1. Create a Plugin Project

bash mkdir my-plugin cd my-plugin npm init -y npm install @tensr/sdk npm install -D typescript @types/node

2. Create Plugin Manifest

Create manifest.json:

json { "id": "my-statistics-plugin", "name": "My Statistics Plugin", "version": "1.0.0", "description": "Calculate descriptive statistics for numeric data", "author": "Your Name", "entryPoint": "dist/index.js", "ui": "ui.html", "capabilities": { "inputTypes": ["csv", "xlsx"], "outputTypes": ["table", "chart"] }, "tags": ["statistics", "descriptive"] }

3. Write Plugin Logic

Create src/index.ts:

```typescript import { TensrPlugin, DataSet, AnalysisResult } from '@tensr/sdk';

export const MyStatisticsPlugin: TensrPlugin = { async analyze(data: DataSet): Promise { // Get numeric columns const numericColumns = data.columns.filter(col => col.type === 'number');

if (numericColumns.length === 0) {
  throw new Error('No numeric columns found in dataset');
}

// Calculate statistics for each numeric column
const results = numericColumns.map(column => {
  const values = data.rows
    .map(row => row[column.id])
    .filter(val => typeof val === 'number' && !isNaN(val as number))
    .map(val => val as number);

  const sum = values.reduce((acc, val) => acc + val, 0);
  const mean = sum / values.length;
  const sorted = [...values].sort((a, b) => a - b);
  const median = sorted[Math.floor(sorted.length / 2)];

  return {
    column: column.name,
    count: values.length,
    mean: Number(mean.toFixed(2)),
    median: Number(median.toFixed(2)),
    min: Math.min(...values),
    max: Math.max(...values)
  };
});

return {
  type: 'table',
  data: {
    title: 'Descriptive Statistics',
    columns: ['Column', 'Count', 'Mean', 'Median', 'Min', 'Max'],
    rows: results.map(r => [
      r.column, 
      r.count, 
      r.mean, 
      r.median, 
      r.min, 
      r.max
    ])
  },
  metadata: {
    executionTime: Date.now(),
    pluginVersion: '1.0.0',
    columnsAnalyzed: numericColumns.length
  }
};

} };

export default MyStatisticsPlugin; ```

4. Create Plugin UI (Optional)

Create ui.html:

```html <!DOCTYPE html> Statistics Results

Statistics Results

<script>
    window.addEventListener('message', function(event) {
        if (event.data.type === 'plugin-result') {
            const data = event.data.result;
            document.getElementById('results').innerHTML = `
                <h3>${data.data.title}</h3>
                <table>
                    <thead>
                        <tr>
                            ${data.data.columns.map(col => `<th>${col}</th>`).join('')}
                        </tr>
                    </thead>
                    <tbody>
                        ${data.data.rows.map(row => `
                            <tr>
                                ${row.map(cell => `<td>${cell}</td>`).join('')}
                            </tr>
                        `).join('')}
                    </tbody>
                </table>
            `;
        }
    });
</script>

```

5. Build and Deploy

```bash

Build TypeScript

npx tsc

Test your plugin

node -e " import('./dist/index.js').then(module => { const plugin = module.default; console.log(' Plugin loaded successfully!'); }); "

Package for upload

zip -r my-plugin.zip . -x "node_modules/" ".git*" ```

SDK Components

Core Types

```typescript import { TensrPlugin, DataSet, AnalysisResult, TensrPluginManifest } from '@tensr/sdk';

// Plugin interface interface TensrPlugin { analyze(data: DataSet): Promise; }

// Dataset structure interface DataSet { columns: Column[]; rows: Record[]; totalRows: number; totalColumns: number; fileType: 'csv' | 'xlsx' | 'json'; }

// Analysis result interface AnalysisResult { type: 'table' | 'chart' | 'text'; data: any; metadata: { executionTime: number; pluginVersion: string; [key: string]: any; }; } ```

UI Components

```typescript import { DataTable, Chart, Dialog, DialogContent, DialogHeader, DialogTitle } from '@tensr/sdk';

// Data table component

// Chart component ```

Plugin Validation

```typescript import { validatePluginManifest } from '@tensr/sdk';

const manifest = { id: 'my-plugin', name: 'My Plugin', version: '1.0.0', // ... other fields };

const validation = validatePluginManifest(manifest); if (!validation.isValid) { console.error('Validation errors:', validation.errors); } ```

Examples

Complete Example Plugin

Check out the complete example in examples/my-first-plugin/:

Full plugin implementation with statistics calculations
Beautiful HTML UI with responsive design
TypeScript configuration and build setup
Plugin manifest with all required fields
Build scripts for easy deployment

bash cd examples/my-first-plugin npm install npm run build

Plugin Types

Descriptive Statistics

typescript // Calculate mean, median, std dev, variance const mean = values.reduce((sum, val) => sum + val, 0) / values.length; const median = calculateMedian(values); const stdDev = calculateStandardDeviation(values, mean);

Correlation Analysis

typescript // Calculate Pearson correlation const correlation = calculatePearsonCorrelation(xValues, yValues);

Data Visualization

typescript // Create chart data const chartData = { labels: ['Category 1', 'Category 2', 'Category 3'], datasets: [{ label: 'Values', data: [10, 20, 30], backgroundColor: 'rgba(54, 162, 235, 0.6)' }] };

API Reference

TensrPlugin

The main interface for all plugins:

typescript interface TensrPlugin { analyze(data: DataSet): Promise<AnalysisResult>; }

DataSet

Input data structure:

```typescript interface DataSet { columns: Column[]; rows: Record[]; totalRows: number; totalColumns: number; fileType: 'csv' | 'xlsx' | 'json'; }

interface Column { id: string; name: string; type: 'string' | 'number' | 'boolean' | 'date'; } ```

AnalysisResult

Output result structure:

```typescript interface AnalysisResult { type: 'table' | 'chart' | 'text'; data: TableData | ChartData | string; metadata: { executionTime: number; pluginVersion: string; [key: string]: any; }; }

interface TableData { title: string; columns: string[]; rows: (string | number)[][]; } ```

Plugin Manifest

Plugin metadata structure:

typescript interface TensrPluginManifest { id: string; name: string; version: string; description: string; author: string; entryPoint: string; ui: string; capabilities: { inputTypes: string[]; outputTypes: string[]; }; config?: { timeout?: number; maxMemory?: number; }; tags?: string[]; }

Development

Testing

The SDK includes a comprehensive test suite:

bash npm test # Run all tests npm run test:watch # Watch mode

Building

bash npm run build # Build for production npm run dev # Development mode npm run lint # Lint code

Tree Shaking

The SDK is optimized for tree shaking:

```typescript // Only import what you need import { TensrPlugin, DataSet } from '@tensr/sdk'; import { DataTable } from '@tensr/sdk/components';

// Unused code is automatically removed ```

Deployment

1. Build Your Plugin

bash npm run build

2. Validate Manifest

bash node -e " const manifest = require('./manifest.json'); const { validatePluginManifest } = require('@tensr/sdk'); const result = validatePluginManifest(manifest); console.log('Valid:', result.isValid); if (!result.isValid) console.log('Errors:', result.errors); "

3. Package for Upload

bash zip -r my-plugin.zip . -x "node_modules/*" "*.git*" "dist/*.map"

4. Upload to Tensr Platform

Login to Tensr platform
Go to Plugin Marketplace "Upload Plugin"
Upload your zip file
Fill in pricing and metadata
Submit for review

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

MIT License - see LICENSE file for details.

Support

Owner

Name: tensr
Login: tensr-xyz
Kind: organization

Repositories: 1
Profile: https://github.com/tensr-xyz

GitHub Events

Total

Member event: 1
Push event: 7
Create event: 6

Last Year

Member event: 1
Push event: 7
Create event: 6

Committers

Last synced: 6 months ago

All Time

Total Commits: 14
Total Committers: 1
Avg Commits per committer: 14.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 14
Committers: 1
Avg Commits per committer: 14.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
olliedarby	o**9@g**m	14

Packages

Total packages: 1
Total downloads:
- npm 8 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 6
Total maintainers: 1

npmjs.org: @tensr/sdk

Plugin SDK for Tensr statistical analysis platform

Homepage: https://github.com/tensr-xyz/tensr-sdk-typescript#readme
License: ISC
Latest release: 3.2.0
published 6 months ago

Versions: 6
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 8 Last month

Rankings

Dependent repos count: 25.2%

Average: 30.8%

Dependent packages count: 36.4%

Maintainers (1)

ollie.darby