blinkbooks Types

Shared TypeScript interfaces for blinkbooks API and App.

Installation

Install from npm:

npm install @blinkbooks/types

Usage

import { Account, Invoice, Customer } from '@blinkbooks/types';

Development

# Build the package
npm run build

# Watch mode for development
npm run watch

# Clean build artifacts
npm run clean

Releasing

This package uses release-it with conventional changelog for version management.

# Create a new release (interactive - will prompt for version)
npm run release

# Create a patch release (1.0.0 -> 1.0.1)
npm run release:patch

# Create a minor release (1.0.0 -> 1.1.0)
npm run release:minor

# Create a major release (1.0.0 -> 2.0.0)
npm run release:major

# Dry run (see what would happen without actually releasing)
npm run release:dry

After releasing, the consuming projects (blinkbooks-api and blinkbooks-app) will be automatically updated via the update-consumers.sh script. You can also manually update them:

# From blinkbooks-api or blinkbooks-app
npm run update-types

# Or update all consumers at once from blinkbooks-types
./update-consumers.sh

Commit Message Convention

This package follows Conventional Commits:

• feat: - New features
• fix: - Bug fixes
• chore: - Maintenance tasks
• docs: - Documentation changes
• refactor: - Code refactoring

The changelog will be automatically generated based on these commit messages.