@docyrus/ui-pro-developer-tools

Installer-driven source distribution for Docyrus UI Pro components. Instead of importing compiled library code, this package copies component source directly into your app — similar to how shadcn/ui and Animate UI work.

Installation

npm install @docyrus/ui-pro-developer-tools
# or
pnpm add @docyrus/ui-pro-developer-tools

Prerequisites

Your target app must have:

• A components.json with aliases.ui set to @/components/ui
• A @/* path alias configured in tsconfig.json or tsconfig.app.json
• A src/ directory

Each installable component also declares its own required shadcn components and npm packages. The CLI validates all prerequisites before copying any files.

CLI Usage

The package provides a ui-pro-developer-tools CLI binary.

Add a component

npx ui-pro-developer-tools add <component-name> [options]

Options

| Option | Description | | --- | --- | | --cwd <path> | Target app directory (defaults to current directory) | | --dry-run | Preview files that would be written without making changes | | --overwrite | Allow overwriting existing files |

Examples

# Preview what would be installed
npx ui-pro-developer-tools add data-source-query-builder --dry-run

# Install into the current directory
npx ui-pro-developer-tools add data-source-query-builder

# Install into a specific app, replacing existing files
npx ui-pro-developer-tools add data-source-query-builder --cwd apps/my-app --overwrite

Available components

| Component | Description | | --- | --- | | data-source-query-builder | Visual query builder for Docyrus data sources with filters, columns, ordering, calculations, formulas, pivots, and child queries | | data-view | Data view shell with shared core and alias-based template |

Programmatic API

import { installComponent, installables } from '@docyrus/ui-pro-developer-tools';

// List available components
console.log(Object.keys(installables));

// Install a component
const result = installComponent('data-source-query-builder', {
  cwd: '/path/to/app',
  dryRun: false,
  overwrite: false
});

Exports

• installables — registry of all installable component definitions
• installComponent(name, options) — install a component into a target app
• Type exports for DataSourceQueryBuilder, DataView, and shared field/i18n types

How it works

1. The CLI validates the target app has the required shadcn components and npm packages installed
2. Source files from templates/ are copied into the app's src/ directory under components/docyrus/
3. Shared utilities (field types, i18n, helpers) are installed alongside the component
4. The installed source becomes part of your app — customize it freely

Required peer dependencies

• react ^19
• react-dom ^19

License

MIT