libmodulor 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # 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**
@@ -15,7 +32,7 @@ To help with the creation of specific targets, we've added a new one : `react-na
 
 **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

@@ -27,11 +27,11 @@ Applications created with `libmodulor` have **6 main properties** :
 
 ## 🚀 Getting Started
 
-To get started, we recommend reading the [📖 Introduction](https://github.com/c100k/libmodulor/blob/v0.4.0/docs/Introduction.md) first. It will give you an overview of what `libmodulor` is and how it works.
+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.
 
-Then, you can follow the [🚀 Tutorial](https://github.com/c100k/libmodulor/blob/v0.4.0/docs/Tutorial.md) that will show you all the main notions by building something real.
+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.
 
-Finally, for more advanced usages, go to the [📜 Guides](https://github.com/c100k/libmodulor/blob/v0.4.0/docs/Guides.md).
+Finally, for more advanced usages, go to the [📜 Guides](https://github.com/c100k/libmodulor/blob/v0.5.0/docs/Guides.md).
 
 ## 👨‍💻 Contribute
 

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({

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

@@ -23,12 +23,20 @@ export class TJWT extends TString {
                 });
             }
             const [header, payload, _signature] = parts;
+            // Using atob on Node.js platforms triggers the following deprecation message :
+            //
+            // This function is only provided for compatibility with legacy web platform APIs and should never be used in new code,
+            // because they use strings to represent binary data and predate the introduction of typed arrays in JavaScript.
+            // For code running using Node.js APIs, converting between base64-encoded strings and binary data should be performed using Buffer.from(str, 'base64') andbuf.toString('base64').
+            //
+            // However this code must be executable everywhere (including and especially browsers) so we need to use it, for portability reasons
             if (header) {
                 JSON.parse(atob(header));
             }
             if (payload) {
                 JSON.parse(atob(payload));
             }
+            // signature is ignored for now
         }
         catch (err) {
             validation.add({

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

@@ -1,4 +1,6 @@
 import { TNumber } from '../base/TNumber.js';
+// TODO : Add some constraints (e.g. between 0 and 1, etc.)
+// Not forgetting that a percentage can be higher hein ! 1.25 is a valid value for 125% !
 export class TPercentage extends TNumber {
     constructor(constraints, decimalsCount) {
         super(constraints, decimalsCount, 'percent');
@@ -13,6 +15,9 @@ export class TPercentage extends TNumber {
         if (typeof this.raw !== 'number') {
             return super.fmt(ifNullOrUndefined);
         }
+        // Although it works on web, using fmtNumber and setting the unit to 'percent' does not work on React Native (Hermes)
+        // Instead of displaying '89%', it displays '89 percent'
+        // Hence the usage here of style: 'percent' directly
         return new Intl.NumberFormat(undefined, {
             maximumFractionDigits: this.decimalsCount,
             style: 'percent',

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

@@ -1,4 +1,5 @@
 import { TString } from '../base/TString.js';
+// TODO : Add basic syntax validation (without adding any dependencies)
 export class TSQLQuery extends TString {
     tName() {
         return 'SQLQuery';

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

@@ -1,7 +1,9 @@
 import { TString } from '../base/TString.js';
 export const SSHPrivatekKeyTypes = ['OPENSSH', 'RSA'];
 export class TSSHPrivateKey extends TString {
-    static FORMAT = /^-----BEGIN (OPENSSH|RSA) PRIVATE KEY-----\n(.+)?\n-----END (OPENSSH|RSA) PRIVATE KEY-----$/is;
+    static FORMAT = 
+    // @ts-ignore
+    /^-----BEGIN (OPENSSH|RSA) PRIVATE KEY-----\n(.+)?\n-----END (OPENSSH|RSA) PRIVATE KEY-----$/is;
     constructor(constraints) {
         super({
             ...constraints,

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

@@ -1,4 +1,5 @@
 import { TString } from '../base/TString.js';
+// TODO : Add basic syntax validation (without adding any dependencies)
 export class TSemVerVersion extends TString {
     static FORMAT = /^([0-9]+)\.([0-9]+)\.([0-9]+)$/;
     constructor(constraints) {

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

@@ -1,4 +1,5 @@
 import { TString } from '../base/TString.js';
+// TODO : Add basic syntax validation (without adding any dependencies)
 export class TShellCommand extends TString {
     tName() {
         return 'ShellCommand';

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

@@ -1,5 +1,6 @@
 import { TString } from '../base/TString.js';
 export class TURL extends TString {
+    // Inspired by https://github.com/jquense/yup/blob/master/src/string.ts#L24
     static FORMAT = /^((https?|ftp):)?\/\/(((([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:)*@)?(((\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5]))|((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.?)(:\d*)?)(\/((([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:|@)+(\/(([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:|@)*)*)?)?(\?((([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:|@)|[\uE000-\uF8FF]|\/|\?)*)?(\#((([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:|@)|\/|\?)*)?$/i;
     constructor(constraints) {
         super({
@@ -20,6 +21,7 @@ export class TURL extends TString {
         return 'url';
     }
     validate() {
+        // Workaround for https://github.com/jquense/yup/issues/224
         if (this.isLocalhost()) {
             this.removeFormatConstraint();
         }

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

@@ -1,5 +1,6 @@
 import { TString } from '../base/TString.js';
 export class TUUID extends TString {
+    // Inspired by https://github.com/jquense/yup/blob/master/src/string.ts#L29
     static FORMAT = /^(?:[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|00000000-0000-0000-0000-000000000000)$/i;
     constructor(constraints) {
         super({

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

@@ -15,6 +15,6 @@ export class TYesNo extends TString {
         return 'YesNo';
     }
     example() {
-        return 'Y';
+        return 'Y'; // Yes Man !
     }
 }

package/dist/esm/i18n/WordingManager.d.ts

@@ -2,6 +2,22 @@ import type { DataType, TBase, TName } from '../dt/index.js';
 import type { ProductWording } from '../product/index.js';
 import type { I18nManager } from '../std/index.js';
 import type { UCClientConfirmConfig, UCDef, UCExecState, UCFieldKey, UCInput, UCInputField, UCName, UCOPIBase, UCOutputPartIdx, UCOutputPartWording, UCWording } from '../uc/index.js';
+/**
+ * A key to translate
+ *
+ *   - uc_CreateX_desc, uc_CreateX_label
+ *   - ucif_name_desc, uc_name_label, uc_isEnabled_desc, uc_isEnabled_label
+ *
+ * NOTE : The choice has been made to consider the input fields as "global".
+ * Which means, their key is not prefixed by the use case name (e.g. ucif_CreateX_ucif_name_desc).
+ * This has multiple advantages :
+ *
+ *   - The same field present in multiple use cases will be automatically translated
+ *   - It gives more consistency through the app with the same thing always named the same way
+ *
+ * One might argue that a label can be different for "name" in "CreateX" and "CreateY".
+ * In this case, we consider that the input field shouldn't be named "name" in both places.
+ */
 export type WordingManagerKey = `dt_${TName}_${string}_${keyof UCWording}` | `p_${keyof ProductWording}` | `uc_${UCName}_${keyof UCWording}` | `uc_${UCName}_client_confirm_${keyof UCClientConfirmConfig}` | `uc_${UCName}_i_submit_${UCExecState}` | `uc_${UCName}_op_${UCOutputPartIdx}_${keyof UCOutputPartWording}` | `ucif_${UCFieldKey}_${keyof UCWording}` | `ucof_${UCFieldKey}_${keyof UCWording}`;
 export declare class WordingManager {
     private i18nManager;

package/dist/esm/i18n/types.d.ts

@@ -1,6 +1,11 @@
 import type { ViolationI18nable, YesNo } from '../dt/index.js';
 import type { UCClientConfirmConfig, UCExecState, UCWording } from '../uc/index.js';
 export type I18nLanguageCode = 'en' | 'fr';
+/**
+ * A translation value
+ *
+ * It can contain `{{placeholders}}`.
+ */
 export type I18nTranslation = string;
 export type I18nTranslationKey = string;
 export type I18nCoreKey = ViolationI18nable | `dt_YesNo_${YesNo}_${keyof UCWording}` | `uc_client_confirm_${keyof UCClientConfirmConfig}` | `uc_i_submit_${UCExecState}`;

package/dist/esm/icon/Icon.d.ts

@@ -1 +1,8 @@
+/**
+ * The icon code (e.g. https://fontawesome.com/v6/search?o=s&m=free)
+ *
+ * There are thousands of them so we voluntarily keep it a simple string and not a union type that would become unmaintainable.
+ *
+ * You can naturally use a different icon library as long as the renderer handles it.
+ */
 export type IconCode = string;

package/dist/esm/index.d.ts

@@ -11,8 +11,11 @@ export * from './std/impl/FakeFSManager.js';
 export * from './std/impl/FakeHTTPAPICallExecutor.js';
 export * from './std/impl/FakeJobManager.js';
 export * from './std/impl/FetchHTTPAPICallExecutor.js';
+export * from './std/impl/MistralAILLMManager.js';
 export * from './std/impl/NoopHTTPAPICallExecutorAgentBuilder.js';
 export * from './std/impl/NoopXMLManager.js';
+export * from './std/impl/OllamaLLMManager.js';
+export * from './std/impl/OpenAILLMManager.js';
 export * from './std/impl/SettingsServerClientManager.js';
 export * from './std/impl/SimpleFormDataBuilder.js';
 export * from './std/impl/SimpleHTTPAPICaller.js';

package/dist/esm/index.js

@@ -1,3 +1,4 @@
+// Export only the implementations that have no external dependencies (Otherwise, export them in index.x.ts)
 export * from './app/index.js';
 export * from './dt/index.js';
 export * from './error/index.js';
@@ -11,8 +12,11 @@ export * from './std/impl/FakeFSManager.js';
 export * from './std/impl/FakeHTTPAPICallExecutor.js';
 export * from './std/impl/FakeJobManager.js';
 export * from './std/impl/FetchHTTPAPICallExecutor.js';
+export * from './std/impl/MistralAILLMManager.js';
 export * from './std/impl/NoopHTTPAPICallExecutorAgentBuilder.js';
 export * from './std/impl/NoopXMLManager.js';
+export * from './std/impl/OllamaLLMManager.js';
+export * from './std/impl/OpenAILLMManager.js';
 export * from './std/impl/SettingsServerClientManager.js';
 export * from './std/impl/SimpleFormDataBuilder.js';
 export * from './std/impl/SimpleHTTPAPICaller.js';