{domainName}

A structured template package for vNext workflow components with domain-based architecture.

📦 Installation

Create a new project with your domain name:

``bash
npx @burgan-tech/vnext-template
`

$3

`bash
npx @burgan-tech/vnext-template user-management
`

This will create a new directory with your domain name, copy all template files, replace {domainName} instances, and install dependencies automatically.

$3

`bash
npx @burgan-tech/vnext-template@
`

Example:

`bash
npx @burgan-tech/vnext-template@1.0.0 user-management
`

$3

`bash
npm install @burgan-tech/vnext-template
npm run setup
`

Or install specific version:

`bash
npm install @burgan-tech/vnext-template@
npm run setup
`

Or use environment variable:

`bash
DOMAIN_NAME=user-management npm install @burgan-tech/vnext-template@
`

🚀 Usage

After installation, your project structure will be:

`
/
├── Extensions/
├── Functions/
├── Schemas/
├── Tasks/
├── Views/
└── Workflows/
`

$3

`javascript
const vnextTemplate = require('@burgan-tech/vnext-template');

// Get domain configuration
const config = vnextTemplate.getDomainConfig();

// Get paths configuration
const paths = vnextTemplate.getPathsConfig();

// Get all schemas
const schemas = vnextTemplate.getSchemas();

// Get all workflows
const workflows = vnextTemplate.getWorkflows();

// Get all tasks
const tasks = vnextTemplate.getTasks();

// Get component path for a specific type
const schemasPath = vnextTemplate.getComponentPath('schemas');
`

$3

| Method | Description |
|--------|-------------|
| getDomainConfig() | Get domain configuration from vnext.config.json |
| getPathsConfig() | Get paths configuration with defaults |
| getSchemas() | Get all schemas |
| getWorkflows() | Get all workflows |
| getTasks() | Get all tasks |
| getViews() | Get all views |
| getFunctions() | Get all functions |
| getExtensions() | Get all extensions |
| getDomainName() | Get domain directory name |
| getAvailableTypes() | Get list of available component types |
| getComponentPath(type) | Get full path for a component type |

⚙️ Configuration

The vnext.config.json file allows you to customize paths and exports:

`json
{
"domain": "my-domain",
"paths": {
"componentsRoot": "my-domain",
"schemas": "Schemas",
"workflows": "Workflows",
"tasks": "Tasks",
"views": "Views",
"functions": "Functions",
"extensions": "Extensions"
},
"exports": {
"schemas": ["schema1.json", "schema2.json"],
"workflows": ["workflow1.json"],
"tasks": [],
"views": [],
"functions": [],
"extensions": []
}
}
`

$3

You can customize component directory names:

`json
{
"paths": {
"componentsRoot": "src",
"workflows": "Flows",
"schemas": "Models"
}
}
`

✅ Validation

Validate your project structure and schemas:

`bash
npm run validate
`

This will check:
- Package.json structure and content
- Main entry point functionality
- vnext.config.json validation
- Domain directory structure
- JSON file syntax validation
- Schema validation using @burgan-tech/vnext-schema
- Module functionality
- Semantic versioning compliance

$3

The validation provides detailed output with:
- ✅ Passed validations
- ❌ Failed validations with file paths and line numbers
- 📊 Summary statistics
- 📋 Failed files summary for easy navigation

🏗️ Build

Build your domain package for deployment or cross-domain usage:

`bash


Runtime build (default) - Complete domain structure

npm run build

Reference build - Only exported components

npm run build:reference

Runtime build explicitly

npm run build:runtime
`

$3

`bash
npm run build -- [options]

Options:
-o, --output

Output directory (default: dist)
-t, --type Build type: reference or runtime (default: runtime)
--skip-validation Skip validation during build
-h, --help Show help message
`

$3

| Type | Description | Use Case |
|------|-------------|----------|
| runtime | Complete domain structure with all files | Engine deployment |
| reference | Only exported components from vnext.config.json | Cross-domain usage |

$3

`bash


Build to custom directory

npm run build -- -o my-build

Reference build to custom directory

npm run build -- -t reference -o packages/ref

Skip validation for faster builds

npm run build -- --skip-validation
`

$3

Runtime Build:
`
dist/
├── /
│ ├── Extensions/
│ ├── Functions/
│ ├── Schemas/
│ ├── Tasks/
│ ├── Views/
│ └── Workflows/
├── vnext.config.json
├── package.json
├── README.md
└── LICENSE
`

Reference Build:
`
dist/
├── /
│ ├── Extensions/ # Only exported files
│ ├── Functions/ # Only exported files
│ ├── Schemas/ # Only exported files
│ ├── Tasks/ # Only exported files
│ ├── Views/ # Only exported files
│ └── Workflows/ # Only exported files
├── vnext.config.json
├── package.json
├── README.md
└── LICENSE
`

📜 Available Scripts

| Script | Description |
|--------|-------------|
| npm run validate | Validate project structure and schemas |
| npm run build | Build runtime package to dist/ |
| npm run build:runtime | Build runtime package explicitly |
| npm run build:reference | Build reference package with exports only |
| npm run setup | Setup domain with given name |
| npm run sync-schema | Sync schema version from dependencies |
| npm test` | Run tests |

📄 License

MIT