@altimateai/dbt-integration
v0.2.2
Published
Altimate TypeScript library for dbt integration
Downloads
286
Readme
@altimateai/dbt-integration
A comprehensive TypeScript library that provides a unified integration layer for dbt (data build tool) projects. Supports multiple dbt deployment strategies including dbt Core, dbt Cloud, dbt Fusion, and command-line execution.
Features
- Multiple Integration Strategies: Support for dbt Core (Python bridge), dbt Cloud API, dbt Fusion, and CLI-based execution
- Unified Interface: Framework-agnostic
DBTFacadeinterface for all dbt operations - Manifest Parsing: Complete parsing of dbt manifests including models, sources, tests, macros, exposures, and metrics
- Dependency Graph: Build and analyze dbt project dependency graphs and lineage
- Python Integration: Direct Python bridge integration with dbt-core
- Type Safety: Full TypeScript support with comprehensive type definitions
Installation
npm install @altimateai/dbt-integration
# or
yarn add @altimateai/dbt-integrationRequirements: Node.js 18+
Setup
yarn installCommands
Build
yarn build- Build the library (CJS, ESM, and TypeScript declarations)yarn dev- Build in watch mode
Testing
yarn test- Run Jest test suiteyarn test:watch- Run tests in watch modeyarn test:coverage- Generate test coverage reportyarn test:integration- Run integration tests
Code Quality
yarn lint- Run ESLintyarn lint:fix- Fix ESLint issuesyarn format- Format code with Prettieryarn format:check- Check code formattingyarn typecheck- Run TypeScript type checking
Publishing
- Update version in
package.json - Build the library:
yarn build - Publish to npm:
npm publish
The library is configured with:
- TypeScript for type safety
- tsup for bundling
- Jest for testing
- ESLint and Prettier for code quality
- Husky for git hooks
- Commitlint for conventional commits
- MSW for API mocking in tests
Commit Convention
This project uses Conventional Commits. Valid commit types:
feat: New featurefix: Bug fixdocs: Documentation changesstyle: Code style changes (formatting, etc)refactor: Code refactoringperf: Performance improvementstest: Test changesbuild: Build system changesci: CI/CD changeschore: Other changesrevert: Revert previous commit
License
MIT
