libmodulor 0.13.1 → 0.14.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v0.14.0 (2025-05-24)
+
+- Introduce `useAction` for react targets : it's a use case agnostic way of invoking an action
+
 ## v0.13.1 (2025-05-02)
 
 **Fixed**

package/README.md

@@ -17,4 +17,4 @@ If you think you can help in any way, feel free to contact me (cf. `author` in `
 
 ## ⚖️ License
 
-[LGPL-3.0](https://github.com/c100k/libmodulor/blob/v0.13.1/LICENSE)
+[LGPL-3.0](https://github.com/c100k/libmodulor/blob/v0.14.0/LICENSE)

package/dist/esm/apps/Helper/src/lib/project.js

@@ -42,18 +42,18 @@ export const PACKAGE_JSON = (name) => `{
     },
     "devDependencies": {
         "@biomejs/biome": "^1.9.4",
-        "@types/node": "^22.15.2",
-        "@vitest/coverage-v8": "^3.1.2",
+        "@types/node": "^22.15.19",
+        "@vitest/coverage-v8": "^3.1.3",
         "buffer": "^6.0.3",
         "cookie-parser": "^1.4.7",
         "express": "^5.1.0",
         "express-fileupload": "^1.5.1",
         "fast-check": "^4.1.1",
         "helmet": "^8.1.0",
-        "jose": "^6.0.10",
+        "jose": "^6.0.11",
         "typescript": "^5.8.3",
-        "vite": "^6.3.3",
-        "vitest": "^3.1.2"
+        "vite": "^6.3.5",
+        "vitest": "^3.1.3"
     }
 }
 `;

package/dist/esm/index.react.d.ts

@@ -6,5 +6,6 @@ export { UCContainer } from './target/lib/react/UCContainer.js';
 export { UCEntrypoint } from './target/lib/react/UCEntrypoint.js';
 export { type Props as UCOutputFieldValueFragmentProps, UCOutputFieldValueFragment, } from './target/lib/react/UCOutputFieldValueFragment.js';
 export { UCPanel } from './target/lib/react/UCPanel.js';
+export { type UseActionOpts, useAction, } from './target/lib/react/useAction.js';
 export { type CloneFunc, type DivertFunc, type RefillFunc, useUC, } from './target/lib/react/useUC.js';
 export { type AppendFunc, type RemoveFunc, type UpdateFunc, useUCOR, } from './target/lib/react/useUCOR.js';

package/dist/esm/index.react.js

@@ -3,5 +3,6 @@ export { UCContainer } from './target/lib/react/UCContainer.js';
 export { UCEntrypoint } from './target/lib/react/UCEntrypoint.js';
 export { UCOutputFieldValueFragment, } from './target/lib/react/UCOutputFieldValueFragment.js';
 export { UCPanel } from './target/lib/react/UCPanel.js';
+export { useAction, } from './target/lib/react/useAction.js';
 export { useUC, } from './target/lib/react/useUC.js';
 export { useUCOR, } from './target/lib/react/useUCOR.js';

package/dist/esm/target/lib/react/UCPanel.js

@@ -1,27 +1,31 @@
-import React, { useEffect, useState } from 'react';
+import React, { useState } from 'react';
 import { ucIsDisabled, ucIsLoading, } from '../../../uc/index.js';
 import { sleep } from '../../../utils/index.js';
 import { useDIContext } from './DIContextProvider.js';
 import { UCContainer } from './UCContainer.js';
+import { useAction } from './useAction.js';
 export function UCPanel({ autoExec = false, clearAfterExec = true, onDone, onError, onInit, onStartSubmitting, renderAutoExecLoader, renderForm, renderExecTouchable, sleepInMs, uc, }) {
     const { container } = useDIContext();
     const [ucManager] = useState(container.get('UCManager'));
-    const [execState, setExecState] = useState(onInit ? 'initializing' : 'idle');
-    useEffect(() => {
-        if (!autoExec) {
-            return;
-        }
-        onSubmit();
-    }, [autoExec]);
-    useEffect(() => {
-        if (execState !== 'initializing') {
-            return;
-        }
-        (async () => {
-            await onInit?.(uc);
-            setExecState('idle');
-        })();
-    }, [execState, onInit, uc]);
+    const { exec, execState } = useAction({
+        action: async () => {
+            const ucor = await ucManager.execClient(uc);
+            await onDone?.(ucor);
+            clear();
+        },
+        autoExec,
+        confirm: async () => await ucManager.confirmClient(uc),
+        onError,
+        onInit: async () => await onInit?.(uc),
+        onStart: async () => {
+            // Is some targets, the confirmClient blocks the main thread (e.g. window.confirm()).
+            // This leads to the state set above not being updated.
+            // This is a "hacky" workaroud to let React re-render the control with 'submitting' state before
+            await sleep(100);
+            await onStartSubmitting?.();
+        },
+        sleepInMs,
+    });
     const onChange = (f, op, v) => {
         f.setValue(op, v);
     };
@@ -31,38 +35,6 @@ export function UCPanel({ autoExec = false, clearAfterExec = true, onDone, onErr
         }
         uc.clear();
     };
-    const onSubmit = async () => {
-        setExecState('submitting');
-        // Is some targets, the confirmClient blocks the main thread (e.g. window.confirm()).
-        // This leads to the state set above not being updated.
-        // This is a "hacky" workaroud to let React re-render the control with 'submitting' state before
-        await sleep(100);
-        await onStartSubmitting?.();
-        const confirmed = await ucManager.confirmClient(uc);
-        if (!confirmed) {
-            setExecState('idle');
-            return false;
-        }
-        if (sleepInMs !== undefined) {
-            await sleep(sleepInMs);
-        }
-        try {
-            const ucor = await ucManager.execClient(uc);
-            await onDone?.(ucor);
-            clear();
-            return true;
-        }
-        catch (err) {
-            if (!onError) {
-                throw err;
-            }
-            onError(err);
-            return false;
-        }
-        finally {
-            setExecState('idle');
-        }
-    };
     const disabled = ucIsDisabled(execState);
     const loading = ucIsLoading(execState);
     // TODO : Keep these as a state to avoid recomputation
@@ -79,12 +51,12 @@ export function UCPanel({ autoExec = false, clearAfterExec = true, onDone, onErr
             !needsInputFilling &&
                 renderExecTouchable({
                     ...ctx,
-                    onSubmit,
+                    onSubmit: exec,
                 }),
             needsInputFilling &&
                 renderForm({
                     ...ctx,
                     onChange,
-                    onSubmit,
+                    onSubmit: exec,
                 })))));
 }

package/dist/esm/target/lib/react/panel.d.ts

@@ -1,9 +1,10 @@
 import type { UC, UCExecState, UCInput, UCOPIBase, UCOutputReader } from '../../../uc/index.js';
+import type { UseActionExec, UseActionOnError } from './useAction.js';
 export type UCPanelOnDone<I extends UCInput | undefined = undefined, OPI0 extends UCOPIBase | undefined = undefined, OPI1 extends UCOPIBase | undefined = undefined> = (ucor: UCOutputReader<I, OPI0, OPI1>) => Promise<void>;
-export type UCPanelOnError = (err: Error) => Promise<void>;
+export type UCPanelOnError = UseActionOnError;
 export type UCPanelOnInit<I extends UCInput | undefined = undefined, OPI0 extends UCOPIBase | undefined = undefined, OPI1 extends UCOPIBase | undefined = undefined> = (uc: UC<I, OPI0, OPI1>) => Promise<void>;
 export type UCPanelOnStartSubmitting = () => Promise<void>;
-export type UCPanelOnSubmit = () => Promise<boolean>;
+export type UCPanelOnSubmit = UseActionExec;
 export interface UCPanelState {
     clearAfterExec?: boolean;
     disabled: boolean;

package/dist/esm/target/lib/react/useAction.d.ts

@@ -0,0 +1,24 @@
+import type { ErrorMessage, UIntDuration } from '../../../dt/index.js';
+import type { UCExecRes, UCExecState } from '../../../uc/exec.js';
+export type UseActionAction = () => Promise<void>;
+export type UseActionConfirm = () => Promise<boolean>;
+export type UseActionExec = () => Promise<UCExecRes>;
+export type UseActionOnError = (err: Error) => Promise<void>;
+export type UseActionOnInit = () => Promise<void>;
+export type UseActionOnStart = () => Promise<void>;
+export interface UseActionOpts {
+    action: UseActionAction;
+    autoExec?: boolean;
+    confirm?: UseActionConfirm;
+    onError?: UseActionOnError | undefined;
+    onInit?: UseActionOnInit;
+    onStart?: UseActionOnStart;
+    sleepInMs?: UIntDuration | undefined;
+}
+export interface UseActionRes {
+    errMsg: ErrorMessage | null;
+    exec: UseActionExec;
+    execRes: UCExecRes | null;
+    execState: UCExecState;
+}
+export declare function useAction({ action, autoExec, confirm, onError, onInit, onStart, sleepInMs, }: UseActionOpts): UseActionRes;

package/dist/esm/target/lib/react/useAction.js

@@ -0,0 +1,57 @@
+import { useEffect, useState } from 'react';
+import { sleep } from '../../../utils/index.js';
+export function useAction({ action, autoExec = false, confirm, onError, onInit, onStart, sleepInMs, }) {
+    const [errMsg, setErrMsg] = useState(null);
+    const [execRes, setExecRes] = useState(null);
+    const [execState, setExecState] = useState(onInit ? 'initializing' : 'idle');
+    useEffect(() => {
+        if (execState !== 'initializing') {
+            return;
+        }
+        (async () => {
+            await onInit?.();
+            setExecState('idle');
+        })();
+    }, [execState, onInit]);
+    const exec = async () => {
+        setErrMsg(null);
+        setExecRes(null);
+        setExecState('submitting');
+        await onStart?.();
+        const confirmed = confirm ? await confirm?.() : true;
+        if (!confirmed) {
+            setExecState('idle');
+            setExecRes('aborted');
+            return 'aborted';
+        }
+        if (sleepInMs !== undefined) {
+            await sleep(sleepInMs);
+        }
+        try {
+            await action();
+            setExecRes('succeeded');
+            return 'succeeded';
+        }
+        catch (err) {
+            setExecRes('failed');
+            if (onError) {
+                await onError?.(err);
+            }
+            else {
+                setErrMsg(err.message);
+            }
+            return 'failed';
+        }
+        finally {
+            setExecState('idle');
+        }
+    };
+    // biome-ignore lint/correctness/useExhaustiveDependencies(exec): it complains if I add it AND if I don't add it !
+    useEffect(() => {
+        if (!autoExec) {
+            return;
+        }
+        exec();
+    }, [autoExec]);
+    return { errMsg, exec, execRes, execState };
+}

package/dist/esm/uc/exec.d.ts

@@ -14,6 +14,14 @@ export declare enum UCExecMode {
      */
     USER = "user"
 }
+/**
+ * Result of execution of a use case
+ *
+ * - `aborted`      : The user aborted the exec (e.g. by not confirming)
+ * - `failed`       : The exec failed
+ * - `succeeded`    : The exec succeeded
+ */
+export type UCExecRes = 'aborted' | 'failed' | 'succeeded';
 /**
  * State of execution of a use case
  *
@@ -44,3 +52,10 @@ export declare function ucIsDisabled(execState: UCExecState): boolean;
  * @returns
  */
 export declare function ucIsLoading(execState: UCExecState): boolean;
+/**
+ * Check whether the execution corresponds to an "error" result
+ *
+ * @param execRes
+ * @returns
+ */
+export declare function ucIsOnErr(execRes: UCExecRes | null): boolean;

package/dist/esm/uc/exec.js

@@ -38,3 +38,12 @@ export function ucIsDisabled(execState) {
 export function ucIsLoading(execState) {
     return execState === 'submitting';
 }
+/**
+ * Check whether the execution corresponds to an "error" result
+ *
+ * @param execRes
+ * @returns
+ */
+export function ucIsOnErr(execRes) {
+    return execRes === 'failed';
+}

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "libmodulor",
     "description": "A TypeScript library to create platform-agnostic applications",
-    "version": "0.13.1",
+    "version": "0.14.0",
     "license": "LGPL-3.0",
     "author": "Chafik H'nini <chafik.hnini@gmail.com>",
     "homepage": "https://libmodulor.c100k.eu",
@@ -82,7 +82,7 @@
     },
     "peerDependencies": {
         "@hono/node-server": "^1.14.1",
-        "@modelcontextprotocol/sdk": "^1.10.2",
+        "@modelcontextprotocol/sdk": "^1.11.4",
         "@stricli/core": "^1.1.2",
         "buffer": "^6.0.3",
         "cookie-parser": "^1.4.7",
@@ -90,20 +90,20 @@
         "express-fileupload": "^1.5.1",
         "fast-check": "^4.1.1",
         "helmet": "^8.1.0",
-        "hono": "^4.7.7",
+        "hono": "^4.7.10",
         "inversify": "^7.5.1",
-        "jose": "^6.0.10",
+        "jose": "^6.0.11",
         "knex": "^3.1.0",
-        "next": "^15.3.1",
-        "pg": "^8.15.6",
+        "next": "^15.3.2",
+        "pg": "^8.16.0",
         "react": "^19.1.0",
         "react-dom": "^19.1.0",
-        "react-native": "^0.79.1",
+        "react-native": "^0.79.2",
         "reflect-metadata": "^0.2.2",
         "sqlite3": "^5.1.7",
         "typescript": "^5.8.3",
-        "vite": "^6.3.3",
-        "vitest": "^3.1.2"
+        "vite": "^6.3.5",
+        "vitest": "^3.1.3"
     },
     "peerDependenciesMeta": {
         "@hono/node-server": {