libmodulor 0.2.0 → 0.4.0

package/docs/getting-started/010_Create_the_cli_Target.md

@@ -1,102 +0,0 @@
-# Create the cli Target
-
-We'll use the pre-built [Node.js parseArgs](https://nodejs.org/api/util.html#utilparseargsconfig) CLI program.
-
-```sh
-mkdir src/products/SuperTrader/cli
-touch src/products/SuperTrader/cli/{container.ts,index.ts}
-```
-
-## container.ts
-
-```typescript
-import {
-    CONTAINER_OPTS,
-    type ServerClientManagerSettings,
-    TARGET_DEFAULT_SERVER_CLIENT_MANAGER_SETTINGS,
-    bindCommon,
-    bindProduct,
-} from 'libmodulor';
-import { bindNodeCLI, bindNodeCore } from 'libmodulor/node';
-import { Container } from 'inversify';
-
-import { I18n } from '../i18n.js';
-import { Manifest } from '../manifest.js';
-
-const container = new Container(CONTAINER_OPTS);
-
-bindCommon<ServerClientManagerSettings>(container, () => ({
-    ...TARGET_DEFAULT_SERVER_CLIENT_MANAGER_SETTINGS,
-}));
-bindNodeCore(container);
-bindNodeCLI(container);
-bindProduct(container, Manifest, I18n);
-
-export default container;
-```
-
-## index.ts
-
-```typescript
-import {
-    APPS_ROOT_DIR_NAME,
-    type FSManager,
-    type I18nManager,
-} from 'libmodulor';
-import { NodeCoreCLIManager } from 'libmodulor/node';
-
-import container from './container.js';
-
-await container.get<I18nManager>('I18nManager').init();
-
-await container.resolve(NodeCoreCLIManager).handleCommand({
-    appsRootPath: container
-        .get<FSManager>('FSManager')
-        .path('..', '..', '..', APPS_ROOT_DIR_NAME),
-    srcImporter: (path) => import(path),
-});
-```
-
-## Build & Run
-
-Update `package.json` to add a new entry to the `scripts`.
-
-```json
-"run:cli": "cd dist/products/SuperTrader/cli && node index.js",
-```
-
-```sh
-yarn build && yarn run:cli
-```
-
-You can see the CLI help appearing with the available commands.
-
-> [!TIP]
-> Update the app's `i18n.ts` to add `uc_BuyAsset_desc` and `ucif_isin_desc` to have a more detailed help section.
-
-Start the server if it's not running.
-
-```sh
-yarn run:server
-```
-
-Execute the CLI in another terminal or tab.
-
-```sh
-yarn run:cli BuyAsset
-# ❌ ISIN must be filled
-yarn run:cli BuyAsset --isin US02079K3059 --limit 123.5 --qty 150
-# ✅ {"parts":{"_0":{"items":[{"executedDirectly":false,"id":"da3dc295-6d7c-41b1-a00a-62683f3e6ab9"}],"total":1}}}
-```
-
-Open the SQLite database with you with your favorite DB editor (e.g. TablePlus, DBeaver...).
-
-```sh
-open dist/products/SuperTrader/server/uc-data-store.sqlite
-```
-
-```sh
-yarn lint && git add . && git commit -m "feat: add the cli target"
-```
-
-Now that's done, let's [Create the mcp-server Target](./011_Create_the_mcp_server_Target.md).

package/docs/getting-started/011_Create_the_mcp_server_Target.md

@@ -1,157 +0,0 @@
-# Create the mcp-server Target
-
-We'll use the pre-built local [stdio transport](https://modelcontextprotocol.io/docs/concepts/transports#standard-input-output-stdio) server.
-
-```sh
-yarn add "@modelcontextprotocol/sdk@^1.1.1"
-```
-
-```sh
-mkdir src/products/SuperTrader/mcp-server
-touch src/products/SuperTrader/mcp-server/{container.ts,index.ts}
-```
-
-## container.ts
-
-```typescript
-import {
-    CONTAINER_OPTS,
-    type ServerClientManagerSettings,
-    type ServerManager,
-    TARGET_DEFAULT_SERVER_CLIENT_MANAGER_SETTINGS,
-    bindCommon,
-    bindProduct,
-} from 'libmodulor';
-import { bindNodeCore, bindServer } from 'libmodulor/node';
-import { NodeLocalStdioMCPServerManager } from 'libmodulor/node-mcp';
-import { Container } from 'inversify';
-
-import { I18n } from '../i18n.js';
-import { Manifest } from '../manifest.js';
-
-type S = ServerClientManagerSettings;
-
-const container = new Container(CONTAINER_OPTS);
-
-bindCommon<S>(container, () => ({
-    ...TARGET_DEFAULT_SERVER_CLIENT_MANAGER_SETTINGS,
-    logger_level: 'error',
-}));
-bindNodeCore(container);
-bindServer(container);
-bindProduct(container, Manifest, I18n);
-
-container
-    .bind<ServerManager>('ServerManager')
-    .to(NodeLocalStdioMCPServerManager);
-
-export default container;
-```
-
-## index.ts
-
-```typescript
-import {
-    APPS_ROOT_DIR_NAME,
-    type FSManager,
-    type I18nManager,
-} from 'libmodulor';
-import { MCPServerBooter } from 'libmodulor/node-mcp';
-
-import container from './container.js';
-
-await container.get<I18nManager>('I18nManager').init();
-
-await container.resolve(MCPServerBooter).exec({
-    appsRootPath: container
-        .get<FSManager>('FSManager')
-        .path('..', '..', '..', APPS_ROOT_DIR_NAME),
-    srcImporter: (path) => import(path),
-});
-```
-
-> [!NOTE]
-> Note how we increase the level of logs to `error` because logging on stdout [messes with the stdio transport](https://modelcontextprotocol.io/docs/tools/debugging#server-side-logging).
-
-## Claude Desktop
-
-If you don't have [Claude Desktop](https://claude.ai/download) on your machine, install it.
-
-The following instructions are for macOS. You might need to adapt the paths if you are using another OS.
-
-Register the mcp server in Claude (make sure you adapt the absolute path to your `libmodulor-tuto` directory).
-
-```sh
-nano ~/Library/Application\ Support/Claude/claude_desktop_config.json
-```
-
-```json
-{
-    "mcpServers": {
-        "libmodulor-tuto": {
-            "command": "node",
-            "args": [
-                "/Users/toto/libmodulor-tuto/dist/products/SuperTrader/mcp-server/index.js"
-            ]
-        }
-    }
-}
-```
-
-If you want to enable debugging within Claude Desktop :
-
-```sh
-nano ~/Library/Application\ Support/Claude/developer_settings.json
-```
-
-```json
-{
-    "allowDevTools": true
-}
-```
-
-To vizualize the logs :
-
-```sh
-ls -la ~/Library/Logs/Claude
-tail -f ~/Library/Logs/Claude/mcp.log
-tail -f ~/Library/Logs/Claude/mcp-server-libmodulor-tuto.log
-```
-
-To open the Chrome Developer Tools wihtin Claude, press <kbd>cmd</kbd> + <kbd>option</kbd> + <kbd>shift</kbd> + <kbd>I</kbd> (should be easy if you're an emacs user).
-
-## Build & Run
-
-Press <kbd>ctrl</kbd> + <kbd>C</kbd> to stop the server.
-
-```sh
-yarn build && yarn run:server
-```
-
-Launch Claude Desktop.
-
-At the bottom right of the prompt you should see a little hammer 🔨 indicating `1 MCP Tool available`.
-
-Click on it. You should see the `BuyAsset` use case registered.
-
-Now just write a prompt like below :
-
-```txt
-Dear Claude. Please buy 150 shares of Google.
-```
-
-And let the magic happens.
-
-<img src="/docs/assets/trading-target-mcp-server.png" width="600px">
-
-Open the SQLite database with you with your favorite DB editor (e.g. TablePlus, DBeaver...).
-
-```sh
-open dist/products/SuperTrader/server/uc-data-store.sqlite
-```
-
-```sh
-yarn lint && git add . && git commit -m "feat: add the mcp-server target"
-```
-
-For now, we're done. Let's review what we've built : [Summary](./012_Summary.md).

package/docs/getting-started/012_Summary.md

@@ -1,29 +0,0 @@
-# Summary
-
-```sh
-git log --oneline
-```
-
-```sh
-7be4e06 (HEAD -> master) feat: add the mcp-server target
-0fb3d57 feat: add the cli target
-e8a52a6 feat: define wording for humans
-3d41f82 feat: persist data in SQLite
-d55bc42 feat: add the web target
-1af90ea feat: add the server target
-dffa202 feat: add the product
-8b83e1f test: init app tests
-0f99382 feat: add the use case
-33ac247 feat: add the app
-09909aa chore: init source code
-```
-
-That was cool ! In a couple of minutes we have created the foundations of a multi-platform application.
-
-And we have only touched the surface as `libmodulor` has much more to offer.
-
-We have used the "pre-built" targets, but it's totally possible to do the same with a Hono server, a stricli CLI, a Vue.js SPA and so on. All the targets implement generic interfaces provided by `libmodulor`, making the whole thing fully modular.
-
-Coming soon : the Advanced Guide.
-
-If you appreciated this Guide or have any feedback, of all kinds, please feel free to send me a message. I'll be happy to discuss and help.