@trustme24/flext 1.10.6 → 2.0.1

package/README.md

@@ -12,9 +12,9 @@ In many systems, templates start simple and gradually become fragile: fields app
 
 A Flext template can contain Markup, Metadata, Modules, and rendering hints in a single artifact. This makes templates easier to reuse, validate, and embed into larger systems such as document pipelines, reporting services, or contract generation platforms.
 
-- [GitHub: TrustMe-kz/flext](https://github.com/TrustMe-kz/flext)  
-- [NPM: @trustme24/flext](https://www.npmjs.com/package/@trustme24/flext)  
-- [Demo: Available at CodeSandbox](https://codesandbox.io/p/devbox/trustme24-flext-f5x2hy)  
+- [GitHub: TrustMe-kz/flext](https://github.com/TrustMe-kz/flext)
+- [NPM: @trustme24/flext](https://www.npmjs.com/package/@trustme24/flext)
+- [Demo: Available at CodeSandbox](https://codesandbox.io/p/devbox/trustme24-flext-f5x2hy)
 - [Documentation: Available at TrustMe Wiki](https://trustmekz.atlassian.net/wiki/external/MTUwYzM5NjUzNDE4NDViMGJlMTliOWEzNzM1Y2RiZWE)
 
 ---
@@ -46,17 +46,17 @@ Typical issues include: undocumented fields, incompatible template versions, dup
 ### A few common scenarios illustrate the problem:
 
 1. **A template expects a field that is not provided at runtime. The result is either a broken document or silent incorrect output.**  
-Solution with Flext: The template can explicitly declare required fields using Metadata so missing data is detected early.
+   Solution with Flext: The template can explicitly declare required fields using Metadata so missing data is detected early.
 
 ————————————
 
 2. **Multiple services use the same template but apply different helper logic or formatting rules.**  
-Solution with Flext: Templates can declare Module dependencies so rendering logic is predictable and consistent.
+   Solution with Flext: Templates can declare Module dependencies so rendering logic is predictable and consistent.
 
 ————————————
 
 3. **Templates evolve but older documents still rely on previous versions.**  
-Solution with Flext: Templates can carry explicit Version information and compatibility rules.
+   Solution with Flext: Templates can carry explicit Version information and compatibility rules.
 
 ---
 
@@ -74,7 +74,7 @@ This approach helps systems understand what a template requires before rendering
 import Flext from '@trustme24/flext';
 
 const template = `
-  {{!-- @v "1.0.beta4" --}}
+  {{!-- @syntax "1.0" --}}
   {{!-- @use "put" --}}
   <p>{{ put name 'Unknown user...' }}</p>
 `;
@@ -88,7 +88,7 @@ document.body.innerHTML = flext.html;
 
 ## Core Ideas
 
-A **Flext** template contains three conceptual layers. The first layer is markup: HTML and standard Handlebars expressions. The second layer is Metadata written as directives such as `@v`, `@field`, or `@use`. The third layer is runtime behavior provided through Modules and helpers.
+A **Flext** template contains three conceptual layers. The first layer is markup: HTML and standard Handlebars expressions. The second layer is Metadata written as directives such as `@syntax`, `@field`, or `@use`. The third layer is runtime behavior provided through Modules and helpers.
 
 Keeping these elements close together makes templates easier to move between systems and reduces hidden assumptions.
 
@@ -100,22 +100,22 @@ Metadata directives can describe template Version, language, title, rendering pa
 import Flext from '@trustme24/flext';
 
 const template = `
-  {{!-- @v "1.0.beta4" --}}
+  {{!-- @syntax "1.0" --}}
   {{!-- @use "put" --}}
   {{!-- @group "data" --}}
-  {{!-- @field "data.someField" type="string" label="Message" required --}}
+  {{!-- @field "data.helloWorld" type="string" label="Hello World" required --}}
 
-  <p class="text-center text-red-500">
-    {{ put data.someField 'No hello world...' }}
+  <p class="text-center">
+    {{ put data.helloWorld 'No hello world...' }}
   </p>
 `;
 
 const flext = new Flext(template, {
-  data: { someField: 'Hello World!' },
+  data: { helloWorld: 'Hello World!' },
 });
 
 console.log(flext.html);   // <p class="...">Hello World!</p>
-console.log(flext.model);  // {"name":"data","$":[{"name":"someField"}]}
+console.log(flext.model);  // {"name":"data","$":[{"name":"helloWorld"}]}
 ```
 
 > 💡 **In this example** the template carries additional information: Version, Field definition, and Module usage. This allows runtime tools to build a Data Model, validate input, and render HTML predictably.
@@ -128,7 +128,7 @@ console.log(flext.model);  // {"name":"data","$":[{"name":"someField"}]}
 
 **Flext** is intended for structured document generation. Common examples include contracts, invoices, reports, certificates, and internal document workflows. It is particularly useful when templates must be versioned, validated, reused across services, or rendered in multiple environments.
 
-Flext can be used on its own, but it is also designed to serve as a core library inside larger systems. Related tools include [vue-flext](https://www.npmjs.com/package/vue-flext) for Vue integration, [flext2pdf](https://www.npmjs.com/package/flext2pdf) for HTML‑to‑PDF rendering, and some **Flext Convert Service** for running document rendering as a microservice.
+Flext can be used on its own, but it is also designed to serve as a core library inside larger systems. Related tools include [Vue Flext](https://www.npmjs.com/package/vue-flext) for Vue integration, [flext2pdf](https://www.npmjs.com/package/flext2pdf) for HTML‑to‑PDF rendering, [Flext File](https://www.npmjs.com/package/flext-file) for portable document packaging and transfer, and some **Flext Service** for running document rendering as a microservice.
 
 Together these components allow Flext to power full document pipelines while remaining a lightweight core library.
 
@@ -141,7 +141,7 @@ Templates should stay declarative and focused on layout. Business logic is usual
 ### Example:
 
 ```handlebars
-{{!-- @v "1.0.beta4" --}}
+{{!-- @syntax "1.0" --}}
 {{!-- @use "put" "date" --}}
 {{!-- @group "data" --}
 {{!-- @field "data.city" type="string" label="City" required --}}
@@ -192,7 +192,7 @@ Directives / Modules
 PDF / Preview / Data Model / Export
 ```
 
-At runtime Flext parses the template, extracts Metadata, registers Modules, builds a Data Model, and generates preview. The output can then be passed to other tools to display, store, or generating PDF.
+At runtime Flext parses the template, extracts Metadata, registers Modules, builds a Data Model, and generates preview. The output can then be passed to other tools to display, store, or generating PDF. Flext-based documents can also be packaged as `.flext` artifacts with [Flext File](https://www.npmjs.com/package/flext-file) for portable storage or transfer between systems.
 
 - [Repo: More information about the repo can be found in ARCHITECTURE.md](https://github.com/TrustMe-kz/flext/blob/main/ARCHITECTURE.md)
 - [Documentation: More information about the API is available at TrustMe Wiki](https://trustmekz.atlassian.net/wiki/external/MTUwYzM5NjUzNDE4NDViMGJlMTliOWEzNzM1Y2RiZWE)

package/bin/flext.mjs

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+
+async function flext() {
+    const [ command = '' ] = process.argv.slice(2);
+
+
+    // Doing some checks
+
+    if (command !== 'sync') {
+        console.log(`Flext: Unknown command: '${command}'\n\nUsage: flext sync`);
+        return;
+    }
+
+
+    await import('./sync-dialects.mjs');
+}
+
+flext().catch((e) => {
+    const message = e instanceof Error ? e.message : String(e);
+
+    console.error('Flext: Unable to execute: ' + message);
+
+    process.exit(1);
+});

package/dist/dialects/index.d.ts

@@ -0,0 +1,2 @@
+export { default as Latest } from './latest';
+export { default as Legacy_1_0_beta4 } from './legacy-1-0-beta4';

package/dist/dialects/latest.d.ts

@@ -0,0 +1,6 @@
+import { Dialect } from '@flext/core';
+export declare class LatestDialect extends Dialect {
+    name: string;
+    aliases: string[];
+}
+export default LatestDialect;

package/dist/dialects/legacy-1-0-beta4.d.ts

@@ -0,0 +1,11 @@
+import { AST } from '@handlebars/parser';
+import { types, Dialect } from '@flext/core';
+export declare const HANDLEBARS_COMMENT_BEGIN = "{{!--";
+export declare const DIALECT_MACRO = "syntax";
+export declare const LEGACY_DIALECT_MACRO = "v";
+export declare class LegacyDialect extends Dialect {
+    name: string;
+    testAst(val: AST.Program, doWarn?: boolean | null): boolean;
+    templateToStandard(template: types.Template): types.StandardTemplate;
+}
+export default LegacyDialect;