@almadar/core 1.0.17 → 2.0.0

package/LICENSE

@@ -1,72 +1,21 @@
-Business Source License 1.1
-
-Parameters
-
-Licensor:             Almadar FZE
-Licensed Work:        KFlow Builder / Almadar
-                      The Licensed Work is (c) 2025-2026 Almadar FZE.
-Additional Use Grant: You may make production use of the Licensed Work for
-                      non-commercial purposes and for internal evaluation.
-                      Production use for commercial purposes requires a
-                      commercial license from the Licensor.
-Change Date:          2030-02-01
-Change License:       Apache License, Version 2.0
-
-Terms
-
-The Licensor hereby grants you the right to copy, modify, create derivative
-works, redistribute, and make non-production use of the Licensed Work. The
-Licensor may make an Additional Use Grant, above, permitting limited
-production use.
-
-Effective on the Change Date, or the fourth anniversary of the first publicly
-available distribution of a specific version of the Licensed Work under this
-License, whichever comes first, the Licensor hereby grants you rights under
-the terms of the Change License, and the rights granted in the paragraph
-above terminate.
-
-If your use of the Licensed Work does not comply with the requirements
-currently in effect as described in this License, you must purchase a
-commercial license from the Licensor, its affiliated entities, or authorized
-resellers, or you must refrain from using the Licensed Work.
-
-All copies of the original and modified Licensed Work, and derivative works
-of the Licensed Work, are subject to this License. This License applies
-separately for each version of the Licensed Work and the Change Date may vary
-for each version of the Licensed Work released by Licensor.
-
-You must conspicuously display this License on each original or modified copy
-of the Licensed Work. If you receive the Licensed Work in original or
-modified form from a third party, the terms and conditions set forth in this
-License apply to your use of that work.
-
-Any use of the Licensed Work in violation of this License will automatically
-terminate your rights under this License for the current and all other
-versions of the Licensed Work.
-
-This License does not grant you any right in any trademark or logo of
-Licensor or its affiliates (provided that you may use a trademark or logo of
-Licensor as expressly required by this License).
-
-TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
-AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
-EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
-TITLE.
-
----
-
-License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
-"Business Source License" is a trademark of MariaDB Corporation Ab.
-
-ADDITIONAL TERMS:
-
-Documentation (builder/packages/website/docs/) is licensed under CC BY 4.0.
-
-TRADEMARKS:
-
-"Orbital", "KFlow", "Almadar", and the Almadar logo are trademarks of
-Almadar FZE. You may not use these trademarks without prior written
-permission from Almadar FZE.
-
-For licensing inquiries: licensing@almadar.io
+MIT License
+
+Copyright (c) 2026 Almadar Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,25 @@
+# @almadar/core
+
+> Core schema types and definitions for Almadar
+
+Part of the [Almadar](https://github.com/almadar-io/almadar) platform.
+
+## Installation
+
+```bash
+npm install @almadar/core
+```
+
+## Usage
+
+```typescript
+import { /* ... */ } from '@almadar/core';
+```
+
+## API
+
+<!-- Document public exports here -->
+
+## License
+
+MIT

package/dist/domain-language/index.d.ts

@@ -1,4 +1,4 @@
-import { bp as SExpr, T as Entity, aZ as Page, O as OrbitalSchema, b$ as Trait } from '../schema-DYj-zJWb.js';
+import { bq as SExpr, V as Entity, a_ as Page, O as OrbitalSchema, b$ as Trait } from '../schema-N46ASk3M.js';
 import 'zod';
 import '@almadar/patterns';
 
@@ -915,4 +915,14 @@ declare function getRegistryStats(): {
     uiSlots: number;
 };
 
-export { type ASTNode, type ComparisonCondition, type ComparisonOperator, type DomainBehavior, type DomainChunk, type DomainDocument, type DomainEffect, type DomainEntity, type DomainField, type DomainFieldType, type DomainGuard, type DomainPage, type DomainPageAction, type DomainPageSection, type DomainRelationship, type DomainTick, type DomainToSchemaResult, type DomainTransition, EFFECT_REGISTRY, type EffectMapping, type EffectType, FIELD_TYPE_REGISTRY, type FieldCheckCondition, type FieldReference, type FieldTypeMapping, GUARD_REGISTRY, type GuardCondition, type GuardMapping, KEYWORDS, Lexer, type LogicalCondition, type LogicalOperator, MULTI_WORD_KEYWORDS, type MappingStore, type MergeResult, type ParseError, type ParseResult, type RelationshipType, type SchemaToDomainResult, type SectionMapping, type SourceLocation, type SourceRange, type Token, TokenType, type UserCheckCondition, applySectionUpdate, computeSchemaHash, convertDomainToSchema, convertEntitiesToDomain, convertPagesToDomain, convertSchemaToDomain, convertTraitsToDomain, createMappingStore, deleteSection, detectChanges, domainKeywordToSchemaType, findMapping, findMappingByPath, findMappingsByType, formatBehaviorToDomain, formatBehaviorToSchema, formatDomainGuardToSchema, formatEntityToDomain, formatEntityToSchema, formatGuardConditionToDomain, formatGuardToDomain, formatGuardToSchema, formatMergeSummary, formatPageToDomain, formatPageToSchema, formatSchemaEntityToDomain, formatSchemaGuardToDomain, formatSchemaPageToDomain, formatSchemaTraitToDomain, generateSectionId, getEffectMapping, getFieldTypeMapping, getGuardMapping, getRegisteredEffects, getRegisteredFieldTypes, getRegisteredGuards, getRegistryStats, getSchemaPath, hasSchemaChanged, isEffectRegistered, isFieldTypeRegistered, isGuardRegistered, mergeDomainChunks, parseBehavior, parseDomainEffect, parseDomainEffects, parseDomainGuard, parseEntity, parseGuard, parsePage, parseSectionId, removeMapping, resolveConflict, schemaEntityToDomainEntity, schemaPageToDomainPage, schemaTraitToDomainBehavior, schemaTypeToDomainKeyword, tokenize, updateMappingRange, updateSchemaHash, upsertMapping, validateDomainChunk };
+/**
+ * Domain Language Reference — pure function that generates reference docs from the type registry.
+ *
+ * Separated from generate-docs.ts (CLI script) so it can be compiled and exported.
+ */
+/**
+ * Generate the complete Domain Language reference document as a string.
+ */
+declare function generateDomainLanguageReference(): string;
+
+export { type ASTNode, type ComparisonCondition, type ComparisonOperator, type DomainBehavior, type DomainChunk, type DomainDocument, type DomainEffect, type DomainEntity, type DomainField, type DomainFieldType, type DomainGuard, type DomainPage, type DomainPageAction, type DomainPageSection, type DomainRelationship, type DomainTick, type DomainToSchemaResult, type DomainTransition, EFFECT_REGISTRY, type EffectMapping, type EffectType, FIELD_TYPE_REGISTRY, type FieldCheckCondition, type FieldReference, type FieldTypeMapping, GUARD_REGISTRY, type GuardCondition, type GuardMapping, KEYWORDS, Lexer, type LogicalCondition, type LogicalOperator, MULTI_WORD_KEYWORDS, type MappingStore, type MergeResult, type ParseError, type ParseResult, type RelationshipType, type SchemaToDomainResult, type SectionMapping, type SourceLocation, type SourceRange, type Token, TokenType, type UserCheckCondition, applySectionUpdate, computeSchemaHash, convertDomainToSchema, convertEntitiesToDomain, convertPagesToDomain, convertSchemaToDomain, convertTraitsToDomain, createMappingStore, deleteSection, detectChanges, domainKeywordToSchemaType, findMapping, findMappingByPath, findMappingsByType, formatBehaviorToDomain, formatBehaviorToSchema, formatDomainGuardToSchema, formatEntityToDomain, formatEntityToSchema, formatGuardConditionToDomain, formatGuardToDomain, formatGuardToSchema, formatMergeSummary, formatPageToDomain, formatPageToSchema, formatSchemaEntityToDomain, formatSchemaGuardToDomain, formatSchemaPageToDomain, formatSchemaTraitToDomain, generateDomainLanguageReference, generateSectionId, getEffectMapping, getFieldTypeMapping, getGuardMapping, getRegisteredEffects, getRegisteredFieldTypes, getRegisteredGuards, getRegistryStats, getSchemaPath, hasSchemaChanged, isEffectRegistered, isFieldTypeRegistered, isGuardRegistered, mergeDomainChunks, parseBehavior, parseDomainEffect, parseDomainEffects, parseDomainGuard, parseEntity, parseGuard, parsePage, parseSectionId, removeMapping, resolveConflict, schemaEntityToDomainEntity, schemaPageToDomainPage, schemaTraitToDomainBehavior, schemaTypeToDomainKeyword, tokenize, updateMappingRange, updateSchemaHash, upsertMapping, validateDomainChunk };

package/dist/domain-language/index.js

@@ -4067,7 +4067,7 @@ z.string().refine(
     if (!val.startsWith("@")) return false;
     const parts = val.slice(1).split(".");
     if (parts.length === 0 || parts[0] === "") return false;
-    return parts.every((part) => /^[a-zA-Z_][a-zA-Z0-9_]*$/.test(part));
+    return parts.every((part) => /^[\p{L}_][\p{L}0-9_]*$/u.test(part));
   },
   { message: "Invalid binding format. Must be @name or @name.path.to.field" }
 );
@@ -6610,6 +6610,160 @@ function getRegistryStats() {
   };
 }
 
-export { EFFECT_REGISTRY, FIELD_TYPE_REGISTRY, GUARD_REGISTRY, KEYWORDS, Lexer, MULTI_WORD_KEYWORDS, TokenType, applySectionUpdate, computeSchemaHash, convertDomainToSchema, convertEntitiesToDomain, convertPagesToDomain, convertSchemaToDomain, convertTraitsToDomain, createMappingStore, deleteSection, detectChanges, domainKeywordToSchemaType, findMapping, findMappingByPath, findMappingsByType, formatBehaviorToDomain, formatBehaviorToSchema, formatDomainGuardToSchema, formatEntityToDomain, formatEntityToSchema, formatGuardConditionToDomain, formatGuardToDomain, formatGuardToSchema, formatMergeSummary, formatPageToDomain, formatPageToSchema, formatSchemaEntityToDomain, formatSchemaGuardToDomain, formatSchemaPageToDomain, formatSchemaTraitToDomain, generateSectionId, getEffectMapping, getFieldTypeMapping, getGuardMapping, getRegisteredEffects, getRegisteredFieldTypes, getRegisteredGuards, getRegistryStats, getSchemaPath, hasSchemaChanged, isEffectRegistered, isFieldTypeRegistered, isGuardRegistered, mergeDomainChunks, parseBehavior, parseDomainEffect, parseDomainEffects, parseDomainGuard, parseEntity, parseGuard, parsePage, parseSectionId, removeMapping, resolveConflict, schemaEntityToDomainEntity, schemaPageToDomainPage, schemaTraitToDomainBehavior, schemaTypeToDomainKeyword, tokenize, updateMappingRange, updateSchemaHash, upsertMapping, validateDomainChunk };
+// src/domain-language/domain-language-reference.ts
+function generateDomainLanguageReference() {
+  const lines = [];
+  const stats = getRegistryStats();
+  lines.push("# Domain Language Reference");
+  lines.push("");
+  lines.push("> Auto-generated from type registry");
+  lines.push(`> Last updated: ${(/* @__PURE__ */ new Date()).toISOString().split("T")[0]}`);
+  lines.push("");
+  lines.push("This document describes the Domain Language syntax that maps to OrbitalSchema.");
+  lines.push("Domain Language is a human-readable format that is converted to/from OrbitalSchema JSON.");
+  lines.push("");
+  lines.push("## Table of Contents");
+  lines.push("");
+  lines.push("- [Field Types](#field-types)");
+  lines.push("- [Effects](#effects)");
+  lines.push("- [Guards](#guards)");
+  lines.push("- [UI Slots](#ui-slots)");
+  lines.push("- [Bindings](#bindings)");
+  lines.push("- [Statistics](#statistics)");
+  lines.push("");
+  lines.push("## Field Types");
+  lines.push("");
+  lines.push("| Schema Type | Domain Keywords | Description |");
+  lines.push("|-------------|-----------------|-------------|");
+  for (const [type, mapping] of Object.entries(FIELD_TYPE_REGISTRY)) {
+    const keywords = mapping.domainKeywords.map((k) => `\`${k}\``).join(", ");
+    lines.push(`| \`${type}\` | ${keywords} | - |`);
+  }
+  lines.push("");
+  lines.push("## Effects");
+  lines.push("");
+  lines.push("Effects are actions that occur during state transitions.");
+  lines.push("In Domain Language, they are written as human-readable statements.");
+  lines.push("The `domain:to-schema` converter translates them to S-Expression arrays.");
+  lines.push("");
+  lines.push("| Operator | Domain Patterns | Description |");
+  lines.push("|----------|-----------------|-------------|");
+  for (const [op, mapping] of Object.entries(EFFECT_REGISTRY)) {
+    const patterns = mapping.domainPatterns.map((p) => `\`${p}\``).join(", ");
+    lines.push(`| \`${op}\` | ${patterns} | ${mapping.description} |`);
+  }
+  lines.push("");
+  lines.push("### Effect Examples");
+  lines.push("");
+  lines.push("```");
+  lines.push("# Update a field");
+  lines.push("then update status to 'done'");
+  lines.push("");
+  lines.push("# Emit an event");
+  lines.push("then emit TASK_COMPLETED");
+  lines.push("then emit ORDER_PLACED with orderId");
+  lines.push("");
+  lines.push("# Render UI");
+  lines.push("then render entity-table to main for Task");
+  lines.push("then render form-section to modal for Order");
+  lines.push("then render null to modal");
+  lines.push("");
+  lines.push("# Navigation");
+  lines.push("then navigate to /tasks");
+  lines.push("");
+  lines.push("# Database");
+  lines.push("then persist create Task");
+  lines.push("then persist update Order");
+  lines.push("then persist delete Item");
+  lines.push("");
+  lines.push("# External services");
+  lines.push("then call stripe.charge with amount");
+  lines.push("");
+  lines.push("# Game effects");
+  lines.push("then spawn Bullet at Player's position");
+  lines.push("then despawn");
+  lines.push("");
+  lines.push("# Notifications");
+  lines.push("then show success notification 'Saved!'");
+  lines.push("```");
+  lines.push("");
+  lines.push("## Guards");
+  lines.push("");
+  lines.push("Guards are conditions that must be true for a transition to occur.");
+  lines.push("");
+  lines.push("| Operator | Domain Patterns | Description |");
+  lines.push("|----------|-----------------|-------------|");
+  for (const [op, mapping] of Object.entries(GUARD_REGISTRY)) {
+    const patterns = mapping.domainPatterns.map((p) => `\`${p}\``).join(", ");
+    lines.push(`| \`${op}\` | ${patterns} | ${mapping.description} |`);
+  }
+  lines.push("");
+  lines.push("### Guard Examples");
+  lines.push("");
+  lines.push("```");
+  lines.push("# Comparison guards");
+  lines.push("if status is 'active'");
+  lines.push("if amount > 100");
+  lines.push("if health is at least 0");
+  lines.push("if priority <= 3");
+  lines.push("");
+  lines.push("# Compound guards");
+  lines.push("if health >= 30 and health < 70");
+  lines.push("if status is 'active' or status is 'pending'");
+  lines.push("if status is not 'deleted'");
+  lines.push("");
+  lines.push("# Payload checks");
+  lines.push("if incoming amount > 0");
+  lines.push("```");
+  lines.push("");
+  lines.push("## UI Slots");
+  lines.push("");
+  lines.push("UI slots are named regions where patterns can be rendered.");
+  lines.push("");
+  lines.push("| Slot | Description |");
+  lines.push("|------|-------------|");
+  const slotDescriptions = {
+    "main": "Primary content area",
+    "sidebar": "Side navigation or secondary content",
+    "modal": "Modal dialog overlay",
+    "drawer": "Slide-out panel",
+    "overlay": "Full-screen overlay",
+    "center": "Centered content area",
+    "toast": "Toast notifications",
+    "hud-top": "Top HUD (games)",
+    "hud-bottom": "Bottom HUD (games)",
+    "floating": "Floating elements",
+    "system": "System components (invisible)"
+  };
+  for (const slot of UI_SLOTS2) {
+    const desc = slotDescriptions[slot] || "-";
+    lines.push(`| \`${slot}\` | ${desc} |`);
+  }
+  lines.push("");
+  lines.push("## Bindings");
+  lines.push("");
+  lines.push("Bindings reference data in S-Expression context.");
+  lines.push("In Domain Language, these are expressed more naturally.");
+  lines.push("");
+  lines.push("| S-Expression | Domain Language |");
+  lines.push("|--------------|-----------------|");
+  lines.push("| `@entity.field` | `field` or `Entity's field` |");
+  lines.push("| `@payload.field` | `incoming field` |");
+  lines.push("| `@state` | `current state` |");
+  lines.push("| `@now` | `now` |");
+  lines.push("");
+  lines.push("## Statistics");
+  lines.push("");
+  lines.push("| Category | Count |");
+  lines.push("|----------|-------|");
+  lines.push(`| Field Types | ${stats.fieldTypes} |`);
+  lines.push(`| Effects | ${stats.effects} |`);
+  lines.push(`| Guards | ${stats.guards} |`);
+  lines.push(`| UI Slots | ${stats.uiSlots} |`);
+  lines.push("");
+  return lines.join("\n");
+}
+
+export { EFFECT_REGISTRY, FIELD_TYPE_REGISTRY, GUARD_REGISTRY, KEYWORDS, Lexer, MULTI_WORD_KEYWORDS, TokenType, applySectionUpdate, computeSchemaHash, convertDomainToSchema, convertEntitiesToDomain, convertPagesToDomain, convertSchemaToDomain, convertTraitsToDomain, createMappingStore, deleteSection, detectChanges, domainKeywordToSchemaType, findMapping, findMappingByPath, findMappingsByType, formatBehaviorToDomain, formatBehaviorToSchema, formatDomainGuardToSchema, formatEntityToDomain, formatEntityToSchema, formatGuardConditionToDomain, formatGuardToDomain, formatGuardToSchema, formatMergeSummary, formatPageToDomain, formatPageToSchema, formatSchemaEntityToDomain, formatSchemaGuardToDomain, formatSchemaPageToDomain, formatSchemaTraitToDomain, generateDomainLanguageReference, generateSectionId, getEffectMapping, getFieldTypeMapping, getGuardMapping, getRegisteredEffects, getRegisteredFieldTypes, getRegisteredGuards, getRegistryStats, getSchemaPath, hasSchemaChanged, isEffectRegistered, isFieldTypeRegistered, isGuardRegistered, mergeDomainChunks, parseBehavior, parseDomainEffect, parseDomainEffects, parseDomainGuard, parseEntity, parseGuard, parsePage, parseSectionId, removeMapping, resolveConflict, schemaEntityToDomainEntity, schemaPageToDomainPage, schemaTraitToDomainBehavior, schemaTypeToDomainKeyword, tokenize, updateMappingRange, updateSchemaHash, upsertMapping, validateDomainChunk };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map