Evolutics TypeScript SDK

A TypeScript SDK for interacting with Evolutics services.

Installation

npm install evolutics-ts-sdk

Features

• 🚀 Full TypeScript support with type definitions
• 📦 Tree-shakeable ESM and CommonJS builds
• 🔒 Type-safe API interactions
• 📝 Comprehensive documentation

Development

Setup

# Install dependencies
npm install

# Build the SDK
npm run build

# Run tests
npm test

# Run linter
npm run lint

# Format code
npm run format

Project Structure

evolutics-ts-sdk/
├── src/              # Source files
├── dist/             # Build output
├── tests/            # Test files
└── examples/         # Usage examples

API Documentation

EvoluticsClient

The main client class for interacting with Evolutics services.

Constructor Options

interface EvoluticsClientConfig {
  apiKey: string;
  baseURL?: string;
  timeout?: number;
}

Publishing & Deployment

Quick Release (Git + npm)

# Patch release (0.1.0 → 0.1.1) - bug fixes
npm run release:patch

# Minor release (0.1.0 → 0.2.0) - new features
npm run release:minor

# Major release (0.1.0 → 1.0.0) - breaking changes
npm run release:major

Git Deployment Only

# Deploy to git without npm publish
npm run deploy

# Manual git operations
npm run git:commit    # Commit changes
npm run git:tag       # Create version tag
npm run git:push:all  # Push commits and tags

Documentation:

• PUBLISHING.md - Detailed npm publishing guide
• GIT_WORKFLOW.md - Git commands and workflow

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

See CONTRIBUTING.md for detailed guidelines.

License

MIT

Support

For issues and questions, please visit GitHub Issues.