@domainlang/language 0.1.81 → 0.1.82

package/README.md

@@ -1,32 +1,163 @@
-# domain-lang-language
+# @domainlang/language
 
-This package contains the DomainLang grammar, language services (parsing, linking, validation), and the Model Query SDK.
+[![npm version](https://img.shields.io/npm/v/@domainlang/language.svg)](https://www.npmjs.com/package/@domainlang/language)
+[![License](https://img.shields.io/npm/l/@domainlang/language.svg)](https://github.com/larsbaunwall/DomainLang/blob/main/LICENSE)
 
-## Key paths
+Core language library for [DomainLang](https://github.com/larsbaunwall/DomainLang) - a Domain-Driven Design modeling language built with [Langium](https://langium.org/).
 
-- src/domain-lang.langium: grammar
-- src/generated/: generated output from Langium (do not edit)
-- src/validation/: semantic validation rules
-- src/lsp/: LSP features (hover, completion, formatting)
-- src/sdk/README.md: Model Query SDK documentation
+## Features
 
-## Common workflows
+- 🔤 **Parser** - Full DomainLang grammar with error recovery
+- ✅ **Validation** - Semantic validation for DDD best practices
+- 🔗 **Linking** - Cross-reference resolution across files and packages
+- 🔍 **Model Query SDK** - Programmatic access to DDD models with fluent queries
+- 🌐 **Browser Support** - Works in Node.js and browser environments
 
-From the workspace root (dsl/domain-lang/):
+## Installation
 
 ```bash
-# After editing packages/language/src/domain-lang.langium
+npm install @domainlang/language
+```
+
+## Quick Start
+
+### Parse and Query Models
+
+```typescript
+import { loadModelFromText } from '@domainlang/language/sdk';
+
+const { query } = await loadModelFromText(`
+  Domain Sales {
+    vision: "Enable seamless commerce"
+  }
+  
+  bc OrderContext for Sales as Core by SalesTeam {
+    description: "Handles order lifecycle"
+  }
+`);
+
+// Query bounded contexts
+const coreContexts = query.boundedContexts()
+  .withRole('Core')
+  .toArray();
+
+console.log(coreContexts[0].name); // 'OrderContext'
+```
+
+### Load from File (Node.js)
+
+```typescript
+import { loadModel } from '@domainlang/language/sdk/loader-node';
+
+const { model, query } = await loadModel('./my-model.dlang');
+
+// Access domains
+for (const domain of query.domains()) {
+  console.log(`${domain.name}: ${domain.vision}`);
+}
+```
+
+## API Overview
+
+### Entry Points
+
+| Function | Environment | Use Case |
+| -------- | ----------- | -------- |
+| `loadModelFromText(text)` | Browser & Node | Parse inline DSL text |
+| `loadModel(file)` | Node.js only | Load from file system |
+| `fromDocument(doc)` | LSP integration | Zero-copy from Langium document |
+| `fromModel(model)` | Advanced | Direct AST wrapping |
+
+### Query Builder
+
+The SDK provides fluent query builders with lazy evaluation:
+
+```typescript
+// Find all bounded contexts owned by a team
+const teamContexts = query.boundedContexts()
+  .withTeam('PaymentsTeam')
+  .toArray();
+
+// Get context maps containing specific contexts
+const maps = query.contextMaps()
+  .containing('OrderContext')
+  .toArray();
+```
+
+### Direct Property Access
+
+```typescript
+// Direct AST properties
+const desc = boundedContext.description;
+const vision = domain.vision;
+
+// SDK-augmented properties (with precedence resolution)
+const role = boundedContext.effectiveRole;  // Header 'as' wins over body 'role:'
+const team = boundedContext.effectiveTeam;  // Header 'by' wins over body 'team:'
+```
+
+## DomainLang Syntax
+
+DomainLang models Domain-Driven Design concepts:
+
+```dlang
+// Define domains with vision
+Domain Sales {
+  vision: "Drive revenue through great customer experience"
+}
+
+// Bounded contexts with ownership
+bc OrderContext for Sales as Core by SalesTeam {
+  description: "Order lifecycle management"
+}
+
+bc PaymentContext for Sales as Supporting by PaymentsTeam
+
+// Context maps showing integrations
+ContextMap SalesIntegration {
+  contains OrderContext, PaymentContext
+  
+  [OHS,PL] OrderContext -> [CF] PaymentContext
+}
+```
+
+## Package Structure
+
+| Path | Purpose |
+| ---- | ------- |
+| `src/domain-lang.langium` | Grammar definition |
+| `src/generated/` | Auto-generated AST (do not edit) |
+| `src/validation/` | Semantic validation rules |
+| `src/lsp/` | LSP features (hover, completion, formatting) |
+| `src/sdk/` | Model Query SDK |
+
+## Related Packages
+
+- [@domainlang/cli](https://www.npmjs.com/package/@domainlang/cli) - Command-line interface
+- [DomainLang VS Code Extension](https://marketplace.visualstudio.com/items?itemName=thinkability.domain-lang) - IDE support
+
+## Documentation
+
+- [Getting Started](https://github.com/larsbaunwall/DomainLang/blob/main/dsl/domain-lang/docs/getting-started.md)
+- [Language Reference](https://github.com/larsbaunwall/DomainLang/blob/main/dsl/domain-lang/docs/language.md)
+- [Quick Reference](https://github.com/larsbaunwall/DomainLang/blob/main/dsl/domain-lang/docs/quick-reference.md)
+- [SDK Documentation](https://github.com/larsbaunwall/DomainLang/blob/main/dsl/domain-lang/packages/language/src/sdk/README.md)
+
+## Development
+
+From the workspace root (`dsl/domain-lang/`):
+
+```bash
+# After editing the grammar
 npm run langium:generate
 
-# Build just this package
+# Build this package
 npm run build --workspace packages/language
 
 # Run tests
 npm test --workspace packages/language
 ```
 
-## Testing
-
-Tests live in test/ and cover parsing, linking, validation, scoping, and services.
+## License
 
-If you change the grammar or validation behavior, add or update tests alongside the change.
+Apache-2.0

package/package.json

@@ -1,22 +1,33 @@
 {
     "name": "@domainlang/language",
-    "version": "0.1.81",
-    "displayName": "DomainLang",
-    "description": "A DSL for Domain-Driven Design",
-    "publisher": "thinkability",
+    "version": "0.1.82",
+    "displayName": "DomainLang Language",
+    "description": "Core language library for DomainLang - parse, validate, and query Domain-Driven Design models programmatically",
     "author": "larsbaunwall",
-    "license": "Apache License 2.0",
+    "license": "Apache-2.0",
     "icon": "images/icon.png",
     "keywords": [
         "ddd",
         "domain-driven design",
         "langium",
         "dlang",
-        "domainlang"
+        "domainlang",
+        "bounded-context",
+        "context-map",
+        "aggregate",
+        "ubiquitous-language",
+        "dsl",
+        "modeling",
+        "architecture",
+        "strategic-design",
+        "parser",
+        "sdk"
     ],
+    "homepage": "https://github.com/larsbaunwall/DomainLang#readme",
     "repository": {
         "type": "git",
-        "url": "https://github.com/larsbaunwall/DomainLang"
+        "url": "https://github.com/larsbaunwall/DomainLang",
+        "directory": "dsl/domain-lang/packages/language"
     },
     "bugs": {
         "url": "https://github.com/larsbaunwall/DomainLang/issues"