libmodulor 0.3.0 → 0.5.0

package/CHANGELOG.md

@@ -1,10 +1,38 @@
 # CHANGELOG
 
+## v0.5.0 (2025-02-24)
+
+**BREAKING**
+
+- Replace `.js` by `.ts` for `ProductManifest`
+
+**Added**
+
+- Introduce a 3<sup>rd</sup> implementation of `LLMManager` (`OllamaLLMManager`) to run models locally
+- Introduce `LLMManager` with 2 implementations (`MistralAILLMManager` and `OpenAILLMManager`)
+
+**Misc**
+
+- Simplify the signature of `UCDef.ext.http.transform` removing the generic `T` return
+- Add JSDocs and comments for a better in-place documentation (i.e. in .d.ts files)
+- Add the Tutorial code in the repo at `examples/libmodulor-tuto` and add a new "Expose a rn Target" step
+
+## v0.4.0 (2025-01-31)
+
+**feat(target): introduce react-native-pure**
+
+To help with the creation of specific targets, we've added a new one : `react-native-pure`. It's as simple as `react-web-pure`, with no specific UI style. It's a good starting point to take inspiration to create your own GUI target, with your own style.
+
+**Misc**
+
+- Introduced Guides in docs for more advanced scenarios (e.g. Create a target) (https://github.com/c100k/libmodulor/pull/10)
+- Improved the docs for a better readability (https://github.com/c100k/libmodulor/pull/10)
+
 ## v0.3.0 (2025-01-23)
 
 **feat(uc): introduce alternate mounting point**
 
-Added a new property `UcDef.ext.http.mountAlsoAt` to be able to define path aliases. See the comment below to understand why.
+Added a new property `UCDef.ext.http.mountAlsoAt` to be able to define path aliases. See the comment below to understand why.
 
 ```typescript
 /**

package/README.md

@@ -25,193 +25,18 @@ Applications created with `libmodulor` have **6 main properties** :
 
 ---
 
-## 📚 Philosophy
-
-One might argue that, with so many "JS frameworks" on the market, there are already too many ways to build new applications today. And they would be right.
-
-That's why the angle taken by `libmodulor` is different. Although opinionated about some things (see below), it is not, regarding the technical side. Instead, it focuses mainly on the "core" of your application.
-
-Thus, you are free to use :
-
-- the data store of your choice (PostgreSQL, MySQL, MariaDB, DynamoDB, SQLite, MongoDB...),
-- the frontend framework of your choice (React, Svelte, Angular, Vue, Solid...),
-- the server of your choice (Express, Fastify, Hono...),
-- the meta framework of your choice (Next, Remix, Astro, Nuxt...),
-- the runtime of your choice (Node, Deno, Bun...)
-- the libraries of your choice (Lodash, React Query...)
-- the tools of your choice (Biome, ESLint, Prettier...)
-- the styling library of your choice for web (tailwind, shadcn, bootstrap, vanilla CSS...)
-- the hosting of your choice (Cloud, IaaS, PaaS, On-Prem, RaspberryPi, your fridge...)
-
-The main goal is to offer higher level primitives that make building business applications faster, without having to use a boilerplate or worse, no/low code, and thus, avoid vendor lock-in.
-
-## 💡 How it works
-
-The library defines a **4-layer architecture** composed of : `UseCase`, `App`, `Product`, `Target`.
-
-```mermaid
-block-beta
-    Target1:2
-    Target2:2
-    Target3:2
-    columns 6
-    Product1:6
-    App1:3
-    App2:3
-    UseCase1
-    UseCase2
-    UseCase3
-    UseCase4
-    UseCase6
-```
-
-_If you're not seeing the mermaid chart (e.g. on npm), head to GitHub._
-
-### UseCase
-
-A use case is the smallest unit. It defines the contract, mainly as an `Input` that goes into lifecycle methods (`client` and/or `server`) to finally give an `Output`. In the end, it constitutes a piece of business functionality.
-
-Inspired by [UML's Use case diagram](https://en.wikipedia.org/wiki/Use_case_diagram) and [Event-driven architecture](https://en.wikipedia.org/wiki/Event-driven_architecture), schematically, it could be defined as follows :
-
-```math
-O = clientMain(serverMain(I))
-```
-
-_Examples : `SignIn`, `CreatePost`, `TransferAccount`, `InviteContacts`_...
-
-Note how it always starts with a verb.
-
-### App
-
-An app is a logical group of use cases.
-
-It's like a "module" (_whatever that means_), inspired by [Domain-driven design (DDD)](https://en.wikipedia.org/wiki/Domain-driven_design) bounded contexts.
-
-_Examples : `Auth`, `Accounting`, `CMS`..._
-
-### Product
-
-A product is a logical group of apps that are assembled together.
-
-Behind this barbaric definition, it's simply what end users know and use.
-
-_Examples : `GitHub`, `Facebook`, `LinkedIn`, `Airbnb`..._
-
-When defined correctly, apps are reusable across multiple products (e.g. `Auth`).
-
-### Target
-
-A target defines how a product is "exposed" to the end user. It's a combination of platform and runtime.
-
-_Examples : `web-react`, `web-angular`, `server-node`, `cli-node`, `cli-stricli`..._
-
-Note that it's the only place where the "infrastructure" choices are applied.
-
-## 👀 At a glance
-
-Here is what a typical use case looks like. For more details, please follow the Guide below.
-
-```typescript
-import { UCInput, /* omitted for brevity */ } from 'libmodulor';
-import { Manifest } from '../manifest.js';
-import { SignInServerMain } from './SignInServerMain.js';
-
-export interface SignInInput extends UCInput {
-    email: UCInputFieldValue<Email>;
-    password: UCInputFieldValue<Password>;
-}
-
-export interface SignInOPI0 extends UCOPIBase {
-    jwt: JWT;
-}
-
-export const SignInUCD: UCDef<SignInInput, SignInOPI0> = {
-    io: {
-        i: {
-            fields: {
-                email: {
-                    type: new TEmail(),
-                },
-                password: {
-                    type: new TPassword({ minLength: 10 }),
-                },
-            },
-        },
-        o: {
-            parts: {
-                _0: {
-                    fields: {
-                        jwt: {
-                            type: new TJWT(),
-                        },
-                    },
-                },
-            },
-        },
-    },
-    lifecycle: {
-        client: {
-            main: SendClientMain,
-            policy: AnonymousUCPolicy,
-        },
-        server: {
-            main: SignInServerMain,
-            policy: AnonymousUCPolicy,
-        },
-    },
-    metadata: Manifest.ucReg.SignIn,
-};
-```
-
 ## 🚀 Getting Started
 
-Enough theory, let's dive in and learn by doing.
-
-> [!NOTE]
-> This Guide is voluntarily very verbose and not scripted so you can get a full overview of how things work. `npx` magic is good. But understanding what happens behind the scenes is good as well.
-
-In this Guide, we'll init a repository (a repository can contain multiple apps and products) and create a real life application using the `libmodulor` primitives.
-
-We'll build a small trading application. It will contain one `App` named `Trading`, which will contain one `UseCase` named `BuyAsset`. The `App` will be mounted in a `Product` called `SuperTrader` which will be exposed via a `server` `Target`, a `web` `Target`, a `cli` `Target` and finally, a `mcp-server` `Target`.
-
-> [!NOTE]
-> MCP stands for [Model Context Protocol](https://modelcontextprotocol.io) introduced recently by [@anthropics](https://github.com/anthropics).
-
-If we adapt the abstract mermaid chart displayed above, concretely, it looks like this :
+To get started, we recommend reading the [📖 Introduction](https://github.com/c100k/libmodulor/blob/v0.5.0/docs/Introduction.md) first. It will give you an overview of what `libmodulor` is and how it works.
 
-```mermaid
-block-beta
-    server
-    web
-    cli
-    mcp_server
-    columns 4
-    SuperTrader:4
-    Trading:2
-    Auth:2
-    BuyAsset
-    ListOrders
-    SignUp
-    SignIn
-```
+Then, you can follow the [🚀 Tutorial](https://github.com/c100k/libmodulor/blob/v0.5.0/docs/Tutorial.md) that will show you all the main notions by building something real. We'll build a small Trading app that will allow us to buy an asset from a web page, a Terminal, Claude Desktop, Android and iOS ! All within a single, simple codebase.
 
-_If you're not seeing the mermaid chart (e.g. on npm), head to GitHub._
+Finally, for more advanced usages, go to the [📜 Guides](https://github.com/c100k/libmodulor/blob/v0.5.0/docs/Guides.md).
 
-Please note that we'll only develop one use case to keep the Guide straightforward but you'll quickly get the idea to develop all the others by yourself.
+## 👨‍💻 Contribute
 
-Here are the steps we're going to follow. Don't worry. Even though it seems a lot, it will be super quick, efficient and straight to the point.
+If you think you can help in any way, feel free to contact me (cf. `author` in `package.json`). I'd love to chat.
 
-1. [Create the project](https://github.com/c100k/libmodulor/blob/v0.3.0/docs/getting-started/001_Create_the_project.md)
-1. [Create the App](https://github.com/c100k/libmodulor/blob/v0.3.0/docs/getting-started/002_Create_the_App.md)
-1. [Create the UseCase](https://github.com/c100k/libmodulor/blob/v0.3.0/docs/getting-started/003_Create_the_UseCase.md)
-1. [Test the App](https://github.com/c100k/libmodulor/blob/v0.3.0/docs/getting-started/004_Test_the_App.md)
-1. [Create the Product](https://github.com/c100k/libmodulor/blob/v0.3.0/docs/getting-started/005_Create_the_Product.md)
-1. [Create the server Target](https://github.com/c100k/libmodulor/blob/v0.3.0/docs/getting-started/006_Create_the_server_Target.md)
-1. [Create the web Target](https://github.com/c100k/libmodulor/blob/v0.3.0/docs/getting-started/007_Create_the_web_Target.md)
-1. [Switch to a persistent data storage](https://github.com/c100k/libmodulor/blob/v0.3.0/docs/getting-started/008_Switch_to_a_persistent_data_storage.md)
-1. [Define wording for humans](https://github.com/c100k/libmodulor/blob/v0.3.0/docs/getting-started/009_Define_wording_for_humans.md)
-1. [Create the cli Target](https://github.com/c100k/libmodulor/blob/v0.3.0/docs/getting-started/010_Create_the_cli_Target.md)
-1. [Create the mcp-server Target](https://github.com/c100k/libmodulor/blob/v0.3.0/docs/getting-started/011_Create_the_mcp_server_Target.md)
-1. [Summary](https://github.com/c100k/libmodulor/blob/v0.3.0/docs/getting-started/012_Summary.md)
+## ⚖️ License
 
-Let's go with the first step : [Create the project](https://github.com/c100k/libmodulor/blob/v0.3.0/docs/getting-started/001_Create_the_project.md).
+[LGPL-3.0](./LICENSE)

package/dist/esm/app/workers/AppSrcFilePathBuilder.d.ts

@@ -3,10 +3,26 @@ import type { FSManager, Logger, Worker } from '../../std/index.js';
 import type { AppName } from '../manifest.js';
 export interface Input {
     appName: AppName;
+    /**
+     * If set, it uses this value to build the path. Otherwise, it fallbacks on {@link appsRootPath}.
+     * @see {@link APPS_ROOT_ALIAS}
+     */
     appsRootAlias?: FilePath | undefined;
+    /**
+     * If `true`, it uses {@link APPS_ROOT_ALIAS} to build the path. Otherwise, it checks {@link appsRootAlias}.
+     */
     appsRootAliasUseDefault?: boolean | undefined;
+    /**
+     * @defaultValue {@link APPS_ROOT_DIR_NAME}
+     */
     appsRootPath?: FilePath | undefined;
     ext?: 'js' | 'ts' | undefined;
+    /**
+     * For example, it can be `[APP_MANIFEST_NAME]`.
+     *
+     * Do not include the extension. This must be passed by the caller via {@link ext}.
+     * Indeed, depending on the context, the extension is not needed (e.g. in tests).
+     */
     filePathParts: FilePath[];
 }
 type Output = FilePath;

package/dist/esm/app/workers/AppSrcFilePathBuilder.js

@@ -23,16 +23,18 @@ let AppSrcFilePathBuilder = class AppSrcFilePathBuilder {
         const appPath = this.fsManager.path(appsRootPath ?? APPS_ROOT_DIR_NAME, appName);
         let importPath = '';
         if (appsRootAliasUseDefault) {
-            importPath = this.fsManager.path(APPS_ROOT_ALIAS, appName);
+            importPath = this.fsManager.path(APPS_ROOT_ALIAS, appName); // @apps/MyApp
         }
         else if (appsRootAlias) {
-            importPath = this.fsManager.path(appsRootAlias, appName);
+            importPath = this.fsManager.path(appsRootAlias, appName); // @myapps/MyApp
         }
         else {
-            importPath = this.fsManager.path(appPath);
-            importPath = `./${importPath}`;
+            importPath = this.fsManager.path(appPath); // src/apps/MyApp
+            importPath = `./${importPath}`; // ./src/apps/MyApp
         }
         const filePath = this.fsManager.path(APP_SRC_DIR_NAME, ...filePathParts);
+        // NOTE 1 : We don't check if the path exists because it wouldn't work when using an alias. So we let the caller do it. For example when using `import` it will fail by itself.
+        // NOTE 2 : Not using `path()` to join in order to avoid the initial `./` to be removed (this is the default behavior of node's join function).
         const suffix = ext ? `.${ext}` : '';
         const path = `${importPath}/${filePath}${suffix}`;
         this.logger.trace('Resolving app src', { path });

package/dist/esm/apps/Helper/index.js

@@ -1,2 +1,3 @@
+// Expose only what's necessary
 export { I18n } from './src/i18n.js';
 export { Manifest } from './src/manifest.js';

package/dist/esm/apps/Helper/src/ucds/GenerateAppsTestsUCD.js

@@ -36,6 +36,7 @@ let GenerateAppsTestsClientMain = class GenerateAppsTestsClientMain {
         const { apps } = await this.appSrcBrowser.exec({
             appsPath,
         });
+        // Keeping it simple without any defensive programming. Be responsible !
         const depsMappingParsed = new Map((depsMapping || []).map((dm) => dm.split(DEP_MAPPING_SEP)));
         let idx = 0;
         for await (const [appPath] of apps) {
@@ -70,7 +71,7 @@ export const GenerateAppsTestsUCD = {
                 ...AppInputFieldsDef,
                 depsMapping: {
                     cardinality: {
-                        max: 20,
+                        max: 20, // A totally arbitrary number
                         min: 0,
                     },
                     type: new TDepMapping().setExamples([
@@ -91,7 +92,7 @@ export const GenerateAppsTestsUCD = {
                     },
                     type: new THostPort()
                         .setDefaultValue(14_000)
-                        .setExamples([14_000]),
+                        .setExamples([14_000]), // "Calvados ❤️"
                 },
             },
         },

package/dist/esm/bundlers/vite/StripUCDLifecycleServerPlugin.js

@@ -1,6 +1,9 @@
 import { UC_DEF_FILE_NAME_SUFFIX } from '../../convention.js';
 import { stripUCDLifecycleServer } from '../../uc/index.js';
 export const StripUCDLifecycleServerPlugin = {
+    // Why enforce ?
+    // Otherwise Rollup parses the file and strips trailing commas.
+    // We need them to strip correctly (although the implementation will be made more robust).
     enforce: 'pre',
     name: 'strip-ucd-lifecycle-server',
     transform: (src, id) => {

package/dist/esm/convention.d.ts

@@ -23,6 +23,7 @@ export declare const APP_TEST_REPORTS_DIR_NAME: string;
 export declare const PRODUCTS_ROOT_ALIAS: string;
 export declare const PRODUCTS_ROOT_PATH: string[];
 export declare const PRODUCT_MANIFEST_NAME: string;
+export declare const PRODUCT_MANIFEST_FILE_EXT: string;
 export declare const PRODUCT_MANIFEST_FILE_NAME: string;
 export declare const PRODUCT_NAME_PLACEHOLDER: ProductName;
 export declare const UC_DEF_SUFFIX: string;

package/dist/esm/convention.js

@@ -1,4 +1,10 @@
+/*
+ * Common
+ */
 export const SRC_DIR_NAME = 'src';
+/*
+ * App
+ */
 export const APPS_ROOT_DIR_NAME = 'apps';
 export const APPS_ROOT_ALIAS = `@${APPS_ROOT_DIR_NAME}`;
 export const APPS_ROOT_PATH = [SRC_DIR_NAME, APPS_ROOT_DIR_NAME];
@@ -7,22 +13,29 @@ export const APP_I18N_NAME = 'I18n';
 export const APP_I18N_FILE_NAME = `${APP_I18N_NAME.toLowerCase()}.ts`;
 export const APP_INDEX_NAME = 'index';
 export const APP_INDEX_FILE_NAME = `${APP_INDEX_NAME}.ts`;
-export const APP_INDEX_FILE_NAME_FOR_IMPORT = 'index.js';
+export const APP_INDEX_FILE_NAME_FOR_IMPORT = 'index.js'; // ESM
 export const APP_MANIFEST_NAME = 'Manifest';
 export const APP_MANIFEST_FILE_EXT = '.ts';
-export const APP_MANIFEST_FILE_NAME = `${APP_MANIFEST_NAME.toLowerCase()}.ts`;
+export const APP_MANIFEST_FILE_NAME = `${APP_MANIFEST_NAME.toLowerCase()}${APP_MANIFEST_FILE_EXT}`;
 export const APP_NAME_PLACEHOLDER = 'AppX';
-export const APP_ROOT_FROM_UCD = ['..', '..', '..'];
+export const APP_ROOT_FROM_UCD = ['..', '..', '..']; // $root/src/ucds/XyzUCD.ts
 export const APP_SRC_DIR_NAME = SRC_DIR_NAME;
 export const APP_SRC_UCDS_DIR_NAME = 'ucds';
 export const APP_TEST_DIR_NAME = 'test';
 export const APP_TEST_MAIN_FILE_NAME = 'App.test.ts';
 export const APP_TEST_REPORTS_DIR_NAME = 'reports';
+/*
+ * Product
+ */
 export const PRODUCTS_ROOT_ALIAS = '@p';
 export const PRODUCTS_ROOT_PATH = [SRC_DIR_NAME, 'products'];
 export const PRODUCT_MANIFEST_NAME = 'Manifest';
-export const PRODUCT_MANIFEST_FILE_NAME = `${PRODUCT_MANIFEST_NAME.toLowerCase()}.js`;
+export const PRODUCT_MANIFEST_FILE_EXT = '.ts';
+export const PRODUCT_MANIFEST_FILE_NAME = `${PRODUCT_MANIFEST_NAME.toLowerCase()}${PRODUCT_MANIFEST_FILE_EXT}`;
 export const PRODUCT_NAME_PLACEHOLDER = 'ProductX';
+/*
+ * Use Case
+ */
 export const UC_DEF_SUFFIX = 'UCD';
 export const UC_DEF_FILE_NAME_EXT = '.ts';
 export const UC_DEF_FILE_NAME_SUFFIX = `${UC_DEF_SUFFIX}${UC_DEF_FILE_NAME_EXT}`;

package/dist/esm/dt/Validation.d.ts

@@ -19,6 +19,14 @@ export declare class Validation {
     get(idx?: NumIndex): [ViolationI18nable, string] | null;
     getViolations(): Violation[];
     getViolationsAsI18nables(): ViolationI18nable[];
+    /**
+     * Check whether the validation has succeeded or not
+     *
+     * If you want to get a violation, use directly {@link get} and check if it's null.
+     * No need to check if `!validation.isOK()` and then call `validation.get()`.
+     *
+     * @returns
+     */
     isOK(): boolean;
     private violationAsI18nable;
 }

package/dist/esm/dt/Validation.js

@@ -24,6 +24,14 @@ export class Validation {
     getViolationsAsI18nables() {
         return this.violations.map((v) => this.violationAsI18nable(v));
     }
+    /**
+     * Check whether the validation has succeeded or not
+     *
+     * If you want to get a violation, use directly {@link get} and check if it's null.
+     * No need to check if `!validation.isOK()` and then call `validation.get()`.
+     *
+     * @returns
+     */
     isOK() {
         return this.violations.length === 0;
     }

package/dist/esm/dt/base/TBase.d.ts

@@ -19,7 +19,8 @@ export interface SemanticsValue {
     color?: Color;
     variant?: SemanticsVariant;
 }
-export type SemanticsMapping = Record<string, SemanticsValue>;
+export type SemanticsMapping = Record<string, // corresponds to T.toString()
+SemanticsValue>;
 export type SemanticsPredicate<T> = (value: T) => SemanticsValue;
 export interface OptionsOpts {
     shouldTranslateLabels?: boolean;

package/dist/esm/dt/base/TBoolean.js

@@ -4,10 +4,12 @@ export class TBoolean extends TBase {
         return 'Boolean';
     }
     assign(raw) {
+        // It's not a string at all
         if (typeof raw !== 'string') {
             super.assign(raw);
             return this;
         }
+        // It's a string, let's try to parse it
         if (raw === 'true') {
             super.assign(true);
             return this;

package/dist/esm/dt/base/TInt.js

@@ -9,15 +9,18 @@ export class TInt extends TNumber {
         return 'Int';
     }
     assign(raw) {
+        // It's not a string at all
         if (typeof raw !== 'string') {
             super.assign(raw);
             return this;
         }
+        // It's a string, let's try to parse it
         const parsed = Number.parseInt(raw, 10);
         if (Number.isNaN(parsed)) {
             super.assign(raw);
             return this;
         }
+        // It's been parsed correctly, let's make sure it's not a float that has been "truncated" into an int
         if (parsed.toString() !== raw) {
             super.assign(raw);
             return this;

package/dist/esm/dt/base/TNumber.js

@@ -18,10 +18,12 @@ export class TNumber extends TBase {
         return 'Number';
     }
     assign(raw) {
+        // It's not a string at all
         if (typeof raw !== 'string') {
             super.assign(raw);
             return this;
         }
+        // It's a string, let's try to parse it
         const parsed = Number.parseFloat(raw);
         super.assign(parsed);
         return this;

package/dist/esm/dt/base/TObject.d.ts

@@ -1,10 +1,25 @@
 import type { Validation } from '../Validation.js';
 import { TBase, type TName } from './TBase.js';
 export declare enum TObjectShapeValidationStrategy {
+    /**
+     * No shape validation is performed
+     *
+     * To be used when the object can have multiple shapes or that its shape is not important.
+     *
+     * Otherwise, you can still override {@link validate} in the `T*` class and do your own validation.
+     */
     NONE = "NONE",
+    /**
+     * Validate against the {@link TObject.example()}
+     *
+     * It checks that the keys of the value, sorted alphabetically, are the same as the example's keys.
+     */
     SAME_AS_EXAMPLE = "SAME_AS_EXAMPLE"
 }
 export interface TObjectConstraints {
+    /**
+     * @defaultValue {@link TObjectShapeValidationStrategy.SAME_AS_EXAMPLE}
+     */
     shapeValidationStrategy: TObjectShapeValidationStrategy;
 }
 export declare class TObject<T extends object> extends TBase<T> {

package/dist/esm/dt/base/TObject.js

@@ -1,7 +1,19 @@
 import { TBase } from './TBase.js';
 export var TObjectShapeValidationStrategy;
 (function (TObjectShapeValidationStrategy) {
+    /**
+     * No shape validation is performed
+     *
+     * To be used when the object can have multiple shapes or that its shape is not important.
+     *
+     * Otherwise, you can still override {@link validate} in the `T*` class and do your own validation.
+     */
     TObjectShapeValidationStrategy["NONE"] = "NONE";
+    /**
+     * Validate against the {@link TObject.example()}
+     *
+     * It checks that the keys of the value, sorted alphabetically, are the same as the example's keys.
+     */
     TObjectShapeValidationStrategy["SAME_AS_EXAMPLE"] = "SAME_AS_EXAMPLE";
 })(TObjectShapeValidationStrategy || (TObjectShapeValidationStrategy = {}));
 export class TObject extends TBase {
@@ -19,6 +31,7 @@ export class TObject extends TBase {
         return {};
     }
     fmt(ifNullOrUndefined) {
+        // typeof this.raw is 'object', hence the check for nullity
         if (this.raw === null || typeof this.raw !== 'object') {
             return super.fmt(ifNullOrUndefined);
         }
@@ -26,6 +39,7 @@ export class TObject extends TBase {
     }
     validate() {
         const validation = super.validate();
+        // typeof this.raw is 'object', hence the check for nullity
         if (this.raw === null || typeof this.raw !== 'object') {
             validation.add({
                 constraint: 'type',

package/dist/esm/dt/base/TString.js

@@ -1,7 +1,7 @@
 import { TBase } from './TBase.js';
 export class TString extends TBase {
     constraints;
-    static DEFAULT_MAX_LENGTH = 999_999;
+    static DEFAULT_MAX_LENGTH = 999_999; // This is totally arbitrary and will probably be changed
     static DEFAULT_MIN_LENGTH = 0;
     constructor(constraints) {
         super();

package/dist/esm/dt/final/TAmount.js

@@ -1,4 +1,5 @@
 import { TNumber } from '../base/TNumber.js';
+// NOTE : We accept negative values (used for example in accounting)
 export class TAmount extends TNumber {
     currencyCode;
     constructor(currencyCode, constraints, decimalsCount) {

package/dist/esm/dt/final/TCountryISO3166Alpha2.js

@@ -1,5 +1,6 @@
 import { TString } from '../base/TString.js';
 export class TCountryISO3166Alpha2 extends TString {
+    // From https://www.iban.com/country-codes
     static OPTIONS = [
         ['Afghanistan', 'AF'],
         ['Albania', 'AL'],

package/dist/esm/dt/final/TCurrencyISO4217.js

@@ -1,5 +1,6 @@
 import { TString } from '../base/TString.js';
 export class TCurrencyISO4217 extends TString {
+    // From https://www.iban.com/currency-codes
     static OPTIONS = [
         ['Euro', 'EUR', '€'],
         ['Pound Sterling', 'GBP', '£'],

package/dist/esm/dt/final/TDateTimeFormat.js

@@ -1,4 +1,5 @@
 import { TString } from '../base/TString.js';
+// TODO : Validate this model with some simple heuristics. Do not make it too complicated, it's not really worth it.
 export class TDateTimeFormat extends TString {
     tName() {
         return 'DateTimeFormat';

package/dist/esm/dt/final/TEmail.js

@@ -1,5 +1,7 @@
 import { TString } from '../base/TString.js';
 export class TEmail extends TString {
+    // Inspired by https://github.com/jquense/yup/blob/master/src/string.ts#L19
+    // Which is inspired by https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address
     static FORMAT = /^[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/;
     constructor(constraints) {
         super({

package/dist/esm/dt/final/TEmoji.js

@@ -1,4 +1,8 @@
 import { TString } from '../base/TString.js';
+// It is too difficult to validate safely an emoji
+// See : https://stackoverflow.com/questions/18862256/how-to-detect-emoji-using-javascript
+// Plus it does not bring much
+// At first, I used maxLength/minLength == 1 but it was naive. Composite ones' length is greater than 1.
 export class TEmoji extends TString {
     tName() {
         return 'Emoji';

package/dist/esm/dt/final/TFile.js

@@ -6,6 +6,8 @@ export class TFile extends TObject {
     fileConstraints;
     constructor(fileConstraints) {
         super({
+            // We usually process instances of https://developer.mozilla.org/fr/docs/Web/API/File
+            // Therefore, it's not strictly the same as the example, with some extra fields that we don't control.
             shapeValidationStrategy: TObjectShapeValidationStrategy.NONE,
         });
         this.fileConstraints = fileConstraints;
@@ -36,6 +38,7 @@ export class TFile extends TObject {
         validation.concat(new TFileMimeType(this.fileConstraints.type)
             .assign(val.type)
             .validate());
+        // TODO : Add validation on file size
         return validation;
     }
 }

package/dist/esm/dt/final/THostAddress.js

@@ -1,4 +1,6 @@
 import { TString } from '../base/TString.js';
+// TODO : Validate using IPv4, DomainName, etc. rules
+// But watch out, hostname can be as simple as "localhost" as well
 export class THostAddress extends TString {
     tName() {
         return 'HostAddress';

package/dist/esm/dt/final/TIPv6.js

@@ -1,5 +1,6 @@
 import { TString } from '../base/TString.js';
 export class TIPv6 extends TString {
+    // Inspired by https://community.fortra.com/forums/intermapper/miscellaneous-topics/5acc4fcf-fa83-e511-80cf-0050568460e4?_ga=2.113564423.1432958022.1523882681-2146416484.1523557976
     static FORMAT = /^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/;
     constructor(constraints) {
         super({