Library/SDK Architecture Questions

Language and Platform

1. Primary language:

   • TypeScript/JavaScript
   • Python
   • Rust
   • Go
   • Java/Kotlin
   • C#
   • Other: ___

2. Target runtime:

   • Node.js
   • Browser (frontend)
   • Both Node.js + Browser (isomorphic)
   • Deno
   • Bun
   • Python runtime
   • Other: ___

3. Package registry:

   • npm (JavaScript)
   • PyPI (Python)
   • crates.io (Rust)
   • Maven Central (Java)
   • NuGet (.NET)
   • Go modules
   • Other: ___

API Design

1. Public API style:

   • Functional (pure functions)
   • OOP (classes/instances)
   • Fluent/Builder pattern
   • Mix

2. API surface size:

   • Minimal (focused, single purpose)
   • Comprehensive (many features)

3. Async handling:

   • Promises (async/await)
   • Callbacks
   • Observables (RxJS)
   • Synchronous only
   • Mix

Type Safety

1. Type system:

   • TypeScript (JavaScript)
   • Type hints (Python)
   • Strongly typed (Rust, Go, Java)
   • Runtime validation (Zod, Yup)
   • None (JavaScript)

2. Type definitions:

   • Bundled with package
   • @types package (DefinitelyTyped)
   • Not applicable

Build and Distribution

1. Build tool:

   • tsup (TypeScript, simple)
   • esbuild (fast)
   • Rollup
   • Webpack
   • Vite
   • tsc (TypeScript compiler only)
   • Not needed (pure JS)

2. Output format:

   • ESM (modern)
   • CommonJS (Node.js)
   • UMD (universal)
   • Multiple formats

3. Minification:

   • Yes (production bundle)
   • No (source code)
   • Source + minified both

Dependencies

1. Dependency strategy:

   • Zero dependencies (standalone)
   • Minimal dependencies
   • Standard dependencies OK

2. Peer dependencies:

   • Yes (e.g., React library requires React)
   • No

Documentation

1. Documentation approach:
   • README only
   • API docs (JSDoc, TypeDoc)
   • Full docs site (VitePress, Docusaurus)
   • Examples repo
   • All of the above

Testing

1. Test framework:

   • Jest (JavaScript)
   • Vitest (Vite-compatible)
   • Pytest (Python)
   • Cargo test (Rust)
   • Go test
   • Other: ___

2. Test coverage goal:

   • High (80%+)
   • Moderate (50-80%)
   • Critical paths only

Versioning and Releases

1. Versioning:

   • Semantic versioning (semver)
   • Calendar versioning (calver)
   • Other

2. Release automation:

   • Changesets
   • Semantic Release
   • Manual
   • GitHub Releases
   • Other: ___

Additional

1. CLI included: (if applicable)

   • Yes (command-line tool)
   • No (library only)

2. Configuration:

   • Config file (JSON, YAML)
   • Programmatic only
   • Both
   • None needed