@nmakarov/cli-toolkit 0.5.0 → 0.7.0

package/README.md

@@ -33,13 +33,15 @@ npm install @nmakarov/cli-toolkit
 ## Requirements
 
 - **Node.js**: v20.0.0 or higher (recommended: v24+)
-- **For Screen module**: `ink` and `react` as peer dependencies
+- **For Screen module**: `ink` and `react` as peer dependencies (ESM-only packages)
 
 ```bash
 # Install peer dependencies for interactive UIs
 npm install ink react
 ```
 
+**Note**: The Screen module has special requirements for CommonJS usage. See [CommonJS Support](#screen-module---esm-only-dependencies) for details.
+
 ## Quick Start
 
 ### Args - Parse Command Line Arguments
@@ -194,9 +196,8 @@ const client = new HttpClient({ useTestServer: 'http://localhost:5030' });
 ### Screen - Interactive Terminal UIs
 
 ```typescript
+// ESM (recommended)
 import { showListScreen } from '@nmakarov/cli-toolkit/screen';
-import { createElement as h } from 'react';
-import { Text } from 'ink';
 
 const choice = await showListScreen({
     title: "Main Menu",
@@ -212,6 +213,8 @@ const choice = await showListScreen({
 console.log(`Selected: ${choice}`);
 ```
 
+**Note**: The Screen module requires ESM dependencies (`ink` and `react`). For CommonJS usage, see [CommonJS Support](#screen-module---esm-only-dependencies) section.
+
 [📖 Full Screen Documentation](docs/SCREEN.md)
 
 ### Logger - Structured Logging
@@ -385,16 +388,50 @@ const logger = new CliToolkitLogger({ prefix: 'APP' });
 
 ## CommonJS Support
 
-All modules support both ESM and CommonJS:
+Most modules support both ESM and CommonJS:
 
 ```javascript
 // ESM (TypeScript/Modern Node)
 import { Args } from '@nmakarov/cli-toolkit/args';
+import { Params } from '@nmakarov/cli-toolkit/params';
+import { CliToolkitLogger } from '@nmakarov/cli-toolkit/logger';
 
 // CommonJS (Traditional Node.js)
 const { Args } = require('@nmakarov/cli-toolkit/args');
+const { Params } = require('@nmakarov/cli-toolkit/params');
+const { CliToolkitLogger } = require('@nmakarov/cli-toolkit/logger');
+```
+
+### Screen Module - ESM-Only Dependencies
+
+⚠️ **Important**: The `screen` module depends on `ink` and `react`, which are ESM-only packages. Due to Node.js limitations, synchronous `require()` cannot load ESM modules.
+
+**Recommended (ESM):**
+```javascript
+// Use ESM import (recommended)
+import { showScreen, showListScreen } from '@nmakarov/cli-toolkit/screen';
 ```
 
+**CommonJS Workaround:**
+If you must use CommonJS, you need to pre-load the ESM dependencies:
+
+```javascript
+// CommonJS with async pre-loading
+const screen = require('@nmakarov/cli-toolkit/screen');
+
+(async () => {
+  // Pre-load ESM dependencies before using the module
+  await screen.load();
+  
+  // Now you can use screen functions
+  const { showScreen, showListScreen } = screen;
+  
+  await showScreen({ /* ... */ });
+})();
+```
+
+See the [Screen Module Documentation](docs/SCREEN.md#commonjs-usage) for more details.
+
 ## Contributing
 
 Contributions are welcome! Please read the [development documentation](docs/README.md) for details.

package/dist/index.cjs

@@ -31,6 +31,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   Args: () => Args,
+  Box: () => import_ink5.Box,
   Db: () => Db,
   Divider: () => Divider,
   FileDatabase: () => FileDatabase,
@@ -43,12 +44,14 @@ __export(src_exports, {
   MultiColumnListComponent: () => MultiColumnListComponent,
   MultiColumnListWithPreviewComponent: () => MultiColumnListWithPreviewComponent,
   Params: () => Params,
+  React: () => import_react5.default,
   ScreenBody: () => ScreenBody,
   ScreenContainer: () => ScreenContainer,
   ScreenDivider: () => ScreenDivider,
   ScreenFooter: () => ScreenFooter,
   ScreenRow: () => ScreenRow,
   ScreenTitle: () => ScreenTitle,
+  Text: () => import_ink5.Text,
   TextBlock: () => TextBlock,
   buildBreadcrumb: () => buildBreadcrumb,
   buildDetailBreadcrumb: () => buildDetailBreadcrumb,
@@ -57,8 +60,10 @@ __export(src_exports, {
   defaultVersionSynopsisFunction: () => defaultVersionSynopsisFunction,
   getArgsInstance: () => getArgsInstance,
   getParamsInstance: () => getParamsInstance,
+  h: () => import_react5.createElement,
   joiEdateType: () => joiEdateType,
   joiStringArrayType: () => joiStringArrayType,
+  load: () => load,
   organizeFooterMessages: () => organizeFooterMessages,
   setupContext: () => setupContext,
   showListScreen: () => showListScreen,
@@ -66,7 +71,13 @@ __export(src_exports, {
   showMultiColumnListScreen: () => showMultiColumnListScreen,
   showMultiColumnListWithPreviewScreen: () => showMultiColumnListWithPreviewScreen,
   showScreen: () => showScreen,
-  showWordGridScreen: () => showWordGridScreen
+  showWordGridScreen: () => showWordGridScreen,
+  useCallback: () => import_react5.useCallback,
+  useEffect: () => import_react5.useEffect,
+  useInput: () => import_ink5.useInput,
+  useMemo: () => import_react5.useMemo,
+  useRef: () => import_react5.useRef,
+  useState: () => import_react5.useState
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -799,6 +810,10 @@ var Params = class {
 var paramsInstance = null;
 var getParamsInstance = () => paramsInstance;
 
+// src/screen/index.ts
+var import_react5 = __toESM(require("react"), 1);
+var import_ink5 = require("ink");
+
 // src/screen/screens.ts
 var import_react3 = require("react");
 var import_ink3 = require("ink");
@@ -1779,6 +1794,22 @@ function organizeFooterMessages(messages) {
   return lines;
 }
 
+// src/screen/index.ts
+var loadPromise = null;
+async function load() {
+  if (loadPromise) return loadPromise;
+  loadPromise = Promise.all([
+    import("react"),
+    import("ink")
+  ]).then(() => {
+  });
+  return loadPromise;
+}
+if (typeof window === "undefined") {
+  load().catch(() => {
+  });
+}
+
 // src/filedatabase/index.ts
 var import_fs4 = __toESM(require("fs"), 1);
 var import_path4 = __toESM(require("path"), 1);
@@ -3246,6 +3277,7 @@ function setupContext(opts = {}) {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Args,
+  Box,
   Db,
   Divider,
   FileDatabase,
@@ -3258,12 +3290,14 @@ function setupContext(opts = {}) {
   MultiColumnListComponent,
   MultiColumnListWithPreviewComponent,
   Params,
+  React,
   ScreenBody,
   ScreenContainer,
   ScreenDivider,
   ScreenFooter,
   ScreenRow,
   ScreenTitle,
+  Text,
   TextBlock,
   buildBreadcrumb,
   buildDetailBreadcrumb,
@@ -3272,8 +3306,10 @@ function setupContext(opts = {}) {
   defaultVersionSynopsisFunction,
   getArgsInstance,
   getParamsInstance,
+  h,
   joiEdateType,
   joiStringArrayType,
+  load,
   organizeFooterMessages,
   setupContext,
   showListScreen,
@@ -3281,6 +3317,12 @@ function setupContext(opts = {}) {
   showMultiColumnListScreen,
   showMultiColumnListWithPreviewScreen,
   showScreen,
-  showWordGridScreen
+  showWordGridScreen,
+  useCallback,
+  useEffect,
+  useInput,
+  useMemo,
+  useRef,
+  useState
 });
 //# sourceMappingURL=index.cjs.map