mirror of https://github.com/AutoMaker-Org/automaker.git synced 2026-01-30 06:12:03 +00:00

Files

Kacper 7ad7b63da2 docs: add comprehensive documentation for shared packages

- Added README.md for all 6 shared packages:
  - @automaker/types: Type definitions and interfaces
  - @automaker/utils: Utility functions (logger, error handling, images)
  - @automaker/platform: Platform utilities (paths, subprocess, security)
  - @automaker/model-resolver: Claude model resolution
  - @automaker/dependency-resolver: Feature dependency ordering
  - @automaker/git-utils: Git operations and diff generation

- Removed MIT license from all package.json files (using custom dual license)

- Created comprehensive LLM guide (docs/llm-shared-packages.md):
  - When to use each package
  - Import patterns and examples
  - Common usage patterns
  - Migration checklist
  - Do's and don'ts for LLMs

Documentation helps developers and AI assistants understand package purpose,
usage, and best practices.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

2025-12-19 23:52:42 +01:00

2.4 KiB

Raw Blame History

@automaker/types

Shared TypeScript type definitions for AutoMaker.

Overview

This package contains all core type definitions used across AutoMaker's server and UI components. It has no dependencies and serves as the foundation for other packages.

Installation

npm install @automaker/types

Exports

Provider Types

Types for AI provider integration and Claude SDK.

import type {
  ProviderConfig,
  ConversationMessage,
  ExecuteOptions,
  ContentBlock,
  ProviderMessage,
  InstallationStatus,
  ValidationResult,
  ModelDefinition
} from '@automaker/types';

Feature Types

Feature management and workflow types.

import type {
  Feature,
  FeatureStatus,
  PlanningMode,
  PlanSpec
} from '@automaker/types';

Feature Interface:

id - Unique feature identifier
category - Feature category/type
description - Feature description
dependencies - Array of feature IDs this depends on
status - Current status (pending/running/completed/failed/verified)
planningMode - Planning approach (skip/lite/spec/full)
planSpec - Plan specification and approval status

Session Types

Agent session management.

import type {
  AgentSession,
  SessionListItem,
  CreateSessionParams,
  UpdateSessionParams
} from '@automaker/types';

Error Types

Error classification and handling.

import type {
  ErrorType,
  ErrorInfo
} from '@automaker/types';

Image Types

Image handling for prompts.

import type {
  ImageData,
  ImageContentBlock
} from '@automaker/types';

Model Types

Claude model definitions and mappings.

import {
  CLAUDE_MODEL_MAP,
  DEFAULT_MODELS,
  type ModelAlias
} from '@automaker/types';

Usage Example

import type { Feature, ExecuteOptions } from '@automaker/types';

const feature: Feature = {
  id: 'auth-feature',
  category: 'backend',
  description: 'Implement user authentication',
  dependencies: ['database-setup'],
  status: 'pending',
  planningMode: 'spec'
};

const options: ExecuteOptions = {
  model: 'claude-sonnet-4-20250514',
  temperature: 0.7
};

Dependencies

None - this is a pure types package.

Used By

@automaker/utils
@automaker/platform
@automaker/model-resolver
@automaker/dependency-resolver
@automaker/git-utils
@automaker/server
@automaker/ui

2.4 KiB Raw Blame History