@alcyone-labs/arg-parser 2.3.0 → 2.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +433 -14
- package/dist/core/ArgParser.d.ts +73 -2
- package/dist/core/ArgParser.d.ts.map +1 -1
- package/dist/core/ArgParserBase.d.ts +6 -0
- package/dist/core/ArgParserBase.d.ts.map +1 -1
- package/dist/core/FlagManager.d.ts.map +1 -1
- package/dist/core/types.d.ts +36 -102
- package/dist/core/types.d.ts.map +1 -1
- package/dist/dxt/DxtGenerator.d.ts +58 -1
- package/dist/dxt/DxtGenerator.d.ts.map +1 -1
- package/dist/index.cjs +1962 -1527
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +4 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.min.mjs +6493 -6183
- package/dist/index.min.mjs.map +1 -1
- package/dist/index.mjs +1962 -1527
- package/dist/index.mjs.map +1 -1
- package/dist/mcp/mcp-integration.d.ts.map +1 -1
- package/dist/mcp/mcp-lifecycle.d.ts +163 -0
- package/dist/mcp/mcp-lifecycle.d.ts.map +1 -0
- package/dist/mcp/mcp-utils.d.ts +20 -0
- package/dist/mcp/mcp-utils.d.ts.map +1 -0
- package/dist/mcp/zod-compatibility.d.ts +74 -0
- package/dist/mcp/zod-compatibility.d.ts.map +1 -0
- package/dist/utils/debug-utils.d.ts +40 -0
- package/dist/utils/debug-utils.d.ts.map +1 -0
- package/package.json +8 -7
package/dist/core/ArgParser.d.ts
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
|
+
import { type McpLoggerOptions } from "@alcyone-labs/simple-mcp-logger";
|
|
1
2
|
import type { GenerateMcpToolsOptions, IMcpToolStructure } from "../mcp/mcp-integration";
|
|
3
|
+
import type { McpLifecycleEvents } from "../mcp/mcp-lifecycle";
|
|
2
4
|
import { ArgParserBase, type IArgParserParams } from "./ArgParserBase";
|
|
3
5
|
import { type LogPath } from "./log-path-utils";
|
|
4
6
|
import type { IFlag, IHandlerContext, OutputSchemaConfig } from "./types";
|
|
@@ -56,6 +58,44 @@ export type DxtServerInfo = {
|
|
|
56
58
|
*/
|
|
57
59
|
logo?: string;
|
|
58
60
|
};
|
|
61
|
+
/**
|
|
62
|
+
* Copy entry for DXT package bundling, compatible with TSDown's copy options
|
|
63
|
+
*/
|
|
64
|
+
export type DxtCopyEntry = {
|
|
65
|
+
from: string;
|
|
66
|
+
to: string;
|
|
67
|
+
};
|
|
68
|
+
/**
|
|
69
|
+
* Copy options for DXT package bundling, compatible with TSDown's copy options
|
|
70
|
+
* @example
|
|
71
|
+
* ```ts
|
|
72
|
+
* [
|
|
73
|
+
* 'migrations',
|
|
74
|
+
* { from: 'migrations', to: 'migrations' },
|
|
75
|
+
* { from: 'config/default.json', to: 'config/default.json' }
|
|
76
|
+
* ]
|
|
77
|
+
* ```
|
|
78
|
+
*/
|
|
79
|
+
export type DxtCopyOptions = Array<string | DxtCopyEntry>;
|
|
80
|
+
/**
|
|
81
|
+
* DXT-specific configuration options
|
|
82
|
+
*/
|
|
83
|
+
export type DxtOptions = {
|
|
84
|
+
/**
|
|
85
|
+
* Additional files and directories to include in the DXT package.
|
|
86
|
+
* Paths are relative to the project root (where package.json/tsconfig.json are located).
|
|
87
|
+
*
|
|
88
|
+
* @example
|
|
89
|
+
* ```ts
|
|
90
|
+
* include: [
|
|
91
|
+
* 'migrations', // Copy entire migrations folder
|
|
92
|
+
* { from: 'config/prod.json', to: 'config.json' }, // Copy and rename file
|
|
93
|
+
* 'assets/logo.png' // Copy specific file
|
|
94
|
+
* ]
|
|
95
|
+
* ```
|
|
96
|
+
*/
|
|
97
|
+
include?: DxtCopyOptions;
|
|
98
|
+
};
|
|
59
99
|
/**
|
|
60
100
|
* MCP server configuration options for withMcp() method
|
|
61
101
|
* This centralizes MCP server metadata that was previously scattered across addMcpSubCommand calls
|
|
@@ -72,6 +112,8 @@ export type McpServerOptions = {
|
|
|
72
112
|
/**
|
|
73
113
|
* Custom log file path for MCP server logs (default: "./logs/mcp.log" relative to entry point)
|
|
74
114
|
*
|
|
115
|
+
* @deprecated Use 'log' property instead for more comprehensive logging configuration
|
|
116
|
+
*
|
|
75
117
|
* Can be:
|
|
76
118
|
* - Simple string: "./logs/app.log" (relative to entry point)
|
|
77
119
|
* - Absolute path: "/tmp/app.log"
|
|
@@ -79,6 +121,26 @@ export type McpServerOptions = {
|
|
|
79
121
|
* - Config object: { path: "./logs/app.log", relativeTo: "entry" | "cwd" | "absolute" }
|
|
80
122
|
*/
|
|
81
123
|
logPath?: LogPath;
|
|
124
|
+
/**
|
|
125
|
+
* MCP logger configuration options
|
|
126
|
+
*
|
|
127
|
+
* Can be:
|
|
128
|
+
* - Simple string: "./logs/app.log" (equivalent to logPath for backward compatibility)
|
|
129
|
+
* - Full options object: { level: "debug", logToFile: "./logs/app.log", prefix: "MyServer" }
|
|
130
|
+
*
|
|
131
|
+
* When both 'log' and 'logPath' are specified, they are merged intelligently:
|
|
132
|
+
* - 'log' provides logger options (level, prefix, mcpMode)
|
|
133
|
+
* - 'logPath' provides flexible path resolution (relativeTo, basePath)
|
|
134
|
+
* - If 'log' has logToFile, 'logPath' still takes precedence for path resolution
|
|
135
|
+
*/
|
|
136
|
+
log?: string | McpLoggerOptions;
|
|
137
|
+
/**
|
|
138
|
+
* Lifecycle event handlers for MCP server operations
|
|
139
|
+
* These provide hooks for initialization, cleanup, and other lifecycle events
|
|
140
|
+
*/
|
|
141
|
+
lifecycle?: McpLifecycleEvents;
|
|
142
|
+
/** DXT package configuration options */
|
|
143
|
+
dxt?: DxtOptions;
|
|
82
144
|
};
|
|
83
145
|
/**
|
|
84
146
|
* Combined options for withMcp() method
|
|
@@ -97,7 +159,11 @@ export type ArgParserWithMcpOptions<THandlerReturn = any> = WithMcpOptions<THand
|
|
|
97
159
|
* @deprecated Use ToolConfig and addTool() instead. Will be removed in v2.0.
|
|
98
160
|
*/
|
|
99
161
|
export type McpToolConfig = {
|
|
100
|
-
/**
|
|
162
|
+
/**
|
|
163
|
+
* Tool name (must be unique within the server)
|
|
164
|
+
* Note: For MCP compatibility, names will be automatically sanitized to match ^[a-zA-Z0-9_-]{1,64}$
|
|
165
|
+
* Invalid characters will be replaced with underscores
|
|
166
|
+
*/
|
|
101
167
|
name: string;
|
|
102
168
|
/** Tool description */
|
|
103
169
|
description?: string;
|
|
@@ -112,7 +178,11 @@ export type McpToolConfig = {
|
|
|
112
178
|
* Configuration for a unified tool that works in both CLI and MCP modes
|
|
113
179
|
*/
|
|
114
180
|
export type ToolConfig = {
|
|
115
|
-
/**
|
|
181
|
+
/**
|
|
182
|
+
* Tool name (CLI subcommand name & MCP tool name)
|
|
183
|
+
* Note: For MCP compatibility, names will be automatically sanitized to match ^[a-zA-Z0-9_-]{1,64}$
|
|
184
|
+
* Invalid characters will be replaced with underscores
|
|
185
|
+
*/
|
|
116
186
|
name: string;
|
|
117
187
|
/** Tool description */
|
|
118
188
|
description?: string;
|
|
@@ -277,6 +347,7 @@ export declare class ArgParser<THandlerReturn = any> extends ArgParserBase<THand
|
|
|
277
347
|
* Create an MCP server with tools generated from this ArgParser
|
|
278
348
|
* @param serverInfo Server configuration
|
|
279
349
|
* @param toolOptions Optional MCP tool generation options
|
|
350
|
+
* @param logPath Optional log path (deprecated, use log config in withMcp instead)
|
|
280
351
|
* @returns Configured MCP server instance
|
|
281
352
|
*/
|
|
282
353
|
createMcpServer(serverInfo?: DxtServerInfo, toolOptions?: GenerateMcpToolsOptions, logPath?: LogPath): Promise<any>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ArgParser.d.ts","sourceRoot":"","sources":["../../src/core/ArgParser.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"ArgParser.d.ts","sourceRoot":"","sources":["../../src/core/ArgParser.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,gBAAgB,EACtB,MAAM,iCAAiC,CAAC;AAOzC,OAAO,KAAK,EACV,uBAAuB,EACvB,iBAAiB,EAClB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAU/D,OAAO,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACvE,OAAO,EAAkB,KAAK,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAChE,OAAO,KAAK,EACV,KAAK,EACL,eAAe,EACf,kBAAkB,EAEnB,MAAM,SAAS,CAAC;AAIjB;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,OAAO,GAAG,KAAK,GAAG,iBAAiB,CAAC;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kBAAkB,CAAC,EAAE,MAAM,MAAM,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,4EAA4E;IAC5E,iBAAiB,CAAC,EAAE,kBAAkB,EAAE,CAAC;IACzC,+EAA+E;IAC/E,gBAAgB,CAAC,EAAE,kBAAkB,CAAC;CACvC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,GAAG,CAAC,EAAE,MAAM,CAAC;KACd,CAAC;IACF,8CAA8C;IAC9C,UAAU,CAAC,EAAE;QACX,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;IACF,0CAA0C;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yCAAyC;IACzC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0CAA0C;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gCAAgC;IAChC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,GAAG,YAAY,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,0BAA0B;IAC1B,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B,0DAA0D;IAC1D,iBAAiB,CAAC,EAAE,kBAAkB,EAAE,CAAC;IACzC,gFAAgF;IAChF,gBAAgB,CAAC,EAAE,kBAAkB,CAAC;IACtC,iDAAiD;IACjD,WAAW,CAAC,EAAE,uBAAuB,CAAC;IACtC;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAC;IAChC;;;OAGG;IACH,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAC/B,wCAAwC;IACxC,GAAG,CAAC,EAAE,UAAU,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,cAAc,GAAG,GAAG,IAC7C,gBAAgB,CAAC,cAAc,CAAC,GAAG;IACjC,wCAAwC;IACxC,GAAG,CAAC,EAAE,gBAAgB,CAAC;CACxB,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,uBAAuB,CAAC,cAAc,GAAG,GAAG,IACtD,cAAc,CAAC,cAAc,CAAC,CAAC;AAEjC;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,uBAAuB;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,GAAG,CAAC;IAClB,8CAA8C;IAC9C,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,oCAAoC;IACpC,OAAO,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,uBAAuB;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yDAAyD;IACzD,KAAK,EAAE,SAAS,KAAK,EAAE,CAAC;IACxB,oCAAoC;IACpC,OAAO,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;IACtD,gGAAgG;IAChG,YAAY,CAAC,EAAE,kBAAkB,CAAC;CACnC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,SAAS,CACpB,cAAc,GAAG,GAAG,CACpB,SAAQ,aAAa,CAAC,cAAc,CAAC;;IACrC,qDAAqD;IACrD,OAAO,CAAC,gBAAgB,CAAC,CAAmB;IAE5C,wCAAwC;IACxC,OAAO,CAAC,SAAS,CAAyC;IAE1D,+BAA+B;IAC/B,OAAO,CAAC,MAAM,CAAsC;IAEpD,+BAA+B;IAC/B,OAAO,CAAC,oBAAoB,CAAC,CAA2B;IACxD,OAAO,CAAC,gBAAgB,CAAoD;IAC5E,OAAO,CAAC,yBAAyB,CAAC,CAEsB;IAExD,kDAAkD;IAClD,OAAO,CAAC,mBAAmB,CAAwC;IAEnE;;;OAGG;IACI,kBAAkB,IAAI,gBAAgB,GAAG,SAAS;IA8EzD;;;;OAIG;IACI,sBAAsB,CAAC,MAAM,EAAE,kBAAkB,GAAG,IAAI;IAK/D;;;;;OAKG;IACI,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,IAAI;IAK1E;;;;OAIG;IACI,sBAAsB,CAC3B,OAAO,GACH,OAAO,GACP,MAAM,cAAc,SAAS,EAAE,oBAA2B,GAC7D,IAAI;IAKP;;;;OAIG;IACI,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAKnD;;;;OAIG;IACH,OAAO,CAAC,qBAAqB;IAK7B;;;;;;;OAOG;IACI,OAAO,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAwE5C;;;;;OAKG;IACI,UAAU,CAAC,UAAU,EAAE,aAAa,GAAG,IAAI;IA+ClD;;;OAGG;IACI,QAAQ,IAAI,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC;IAI1C;;;;OAIG;IACI,WAAW,IAAI,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC;IAIhD;;;;OAIG;IACI,WAAW,CAAC,OAAO,CAAC,EAAE,uBAAuB,GAAG;QACrD,YAAY,EAAE,MAAM,EAAE,CAAC;QACvB,cAAc,EAAE,MAAM,EAAE,CAAC;QACzB,QAAQ,EAAE,MAAM,EAAE,CAAC;QACnB,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,EAAE,MAAM,EAAE,CAAC;KACtB;IA4BD;;;;;OAKG;IACI,cAAc,CAAC,OAAO,CAAC,EAAE,uBAAuB,GAAG;QACxD,WAAW,EAAE,MAAM,EAAE,CAAC;QACtB,QAAQ,EAAE,MAAM,EAAE,CAAC;QACnB,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,EAAE,MAAM,EAAE,CAAC;KACtB;IAUD;;;OAGG;IACI,mBAAmB,IAAI;QAC5B,OAAO,EAAE,OAAO,CAAC;QACjB,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,cAAc,EAAE,MAAM,EAAE,CAAC;QACzB,QAAQ,EAAE,MAAM,EAAE,CAAC;KACpB;IAuCD;;;;;;OAMG;IACU,kBAAkB,CAC7B,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,GAAQ,GACb,OAAO,CAAC;QACT,OAAO,EAAE,OAAO,CAAC;QACjB,MAAM,CAAC,EAAE,GAAG,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IA6BF;;;;OAIG;IACI,UAAU,CAAC,OAAO,CAAC,EAAE,uBAAuB,GAAG,iBAAiB,EAAE;IAqRzE;;;;;;OAMG;IACU,eAAe,CAC1B,UAAU,CAAC,EAAE,aAAa,EAC1B,WAAW,CAAC,EAAE,uBAAuB,EACrC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,GAAG,CAAC;IAslBf;;;OAGG;IACH,OAAO,CAAC,2BAA2B;IAenC;;;;;OAKG;IACU,cAAc,CACzB,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,EACD,WAAW,CAAC,EAAE,uBAAuB,GACpC,OAAO,CAAC,IAAI,CAAC;IAShB;;;;;;OAMG;IACU,oCAAoC,CAC/C,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,EACD,UAAU,EAAE,KAAK,CAAC;QAChB,IAAI,EAAE,OAAO,GAAG,KAAK,GAAG,iBAAiB,CAAC;QAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,kBAAkB,CAAC,EAAE,MAAM,MAAM,CAAC;KACnC,CAAC,EACF,WAAW,CAAC,EAAE,uBAAuB,EACrC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,IAAI,CAAC;IAiBhB;;;;;;;OAOG;IACU,2BAA2B,CACtC,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,EACD,aAAa,EAAE,OAAO,GAAG,KAAK,GAAG,iBAAiB,EAClD,gBAAgB,GAAE;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,kBAAkB,CAAC,EAAE,MAAM,MAAM,CAAC;KAC9B,EACN,WAAW,CAAC,EAAE,uBAAuB,EACrC,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,IAAI,CAAC;IAuJH,KAAK,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IA2BvE;;;;OAIG;IACI,WAAW,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,GAAG;IAuB9D;;;;;OAKG;IACI,UAAU,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IA4CtE;;;;;;;OAOG;IACI,gBAAgB,CACrB,cAAc,EAAE,MAAM,GAAG,SAAS,EAClC,UAAU,EAAE,aAAa,EACzB,OAAO,CAAC,EAAE,oBAAoB,GAAG;QAAE,WAAW,CAAC,EAAE,uBAAuB,CAAA;KAAE,GACzE,IAAI;IAEP;;;;;;;OAOG;IACI,gBAAgB,CACrB,cAAc,EAAE,MAAM,GAAG,SAAS,EAClC,UAAU,EAAE,aAAa,EACzB,WAAW,CAAC,EAAE,uBAAuB,GACpC,IAAI;IAoLP;;;;;;;;OAQG;WACW,OAAO,CAAC,CAAC,GAAG,GAAG,EAC3B,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,EAC3B,YAAY,CAAC,EAAE,SAAS,KAAK,EAAE,GAC9B,SAAS,CAAC,CAAC,CAAC;IAoBf;;;OAGG;WACW,MAAM,CAAC,CAAC,GAAG,GAAG,EAC1B,OAAO,CAAC,EAAE,qBAAqB,CAAC,OAAO,aAAa,CAAC,CAAC,CAAC,CAAC,EACxD,YAAY,CAAC,EAAE,qBAAqB,CAAC,OAAO,aAAa,CAAC,CAAC,CAAC,CAAC,GAC5D,SAAS,CAAC,CAAC,CAAC;IASf;;;OAGG;WACW,UAAU,CAAC,CAAC,GAAG,GAAG,EAC9B,OAAO,CAAC,EAAE,qBAAqB,CAAC,OAAO,aAAa,CAAC,CAAC,CAAC,CAAC,EACxD,YAAY,CAAC,EAAE,qBAAqB,CAAC,OAAO,aAAa,CAAC,CAAC,CAAC,CAAC,GAC5D,SAAS,CAAC,CAAC,CAAC;WASD,aAAa,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;CA+B7E"}
|
|
@@ -153,6 +153,12 @@ export declare class ArgParserBase<THandlerReturn = any> {
|
|
|
153
153
|
helpText(): string;
|
|
154
154
|
getSubCommand(name: string): ISubCommand | undefined;
|
|
155
155
|
hasFlag(name: string): boolean;
|
|
156
|
+
/**
|
|
157
|
+
* Get flag definition by name
|
|
158
|
+
* @param name Flag name
|
|
159
|
+
* @returns Flag definition or undefined if not found
|
|
160
|
+
*/
|
|
161
|
+
getFlagDefinition(name: string): ProcessedFlag | undefined;
|
|
156
162
|
getCommandChain(): string[];
|
|
157
163
|
getLastParseResult(): TParsedArgs<ProcessedFlag[]>;
|
|
158
164
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ArgParserBase.d.ts","sourceRoot":"","sources":["../../src/core/ArgParserBase.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,aAAa,EACb,uBAAuB,EACxB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC3E,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,yBAAyB,CAAC;
|
|
1
|
+
{"version":3,"file":"ArgParserBase.d.ts","sourceRoot":"","sources":["../../src/core/ArgParserBase.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,aAAa,EACb,uBAAuB,EACxB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC3E,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,yBAAyB,CAAC;AAIjC,OAAO,KAAK,EACV,KAAK,EACL,eAAe,EACf,WAAW,EACX,WAAW,EACX,aAAa,EACb,WAAW,EACZ,MAAM,SAAS,CAAC;AAEjB,qBAAa,cAAe,SAAQ,KAAK;IAI9B,QAAQ,EAAE,MAAM,EAAE;IAHpB,YAAY,EAAE,MAAM,EAAE,CAAC;gBAE5B,OAAO,EAAE,MAAM,EACR,QAAQ,GAAE,MAAM,EAAO;CAMjC;AAED,MAAM,WAAW,gBAAgB,CAAC,cAAc,GAAG,GAAG;IACpD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,WAAW,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE,CACR,GAAG,EAAE,eAAe,CAAC,GAAG,EAAE,GAAG,CAAC,KAC3B,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAE9C;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,KAAK,sBAAsB,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG;IACzC,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,gBAAgB,CAAC,EAAE;QAAE,OAAO,EAAE,QAAQ,CAAC;QAAC,OAAO,EAAE,eAAe,CAAA;KAAE,CAAC;CACpE,CAAC;AAOF,qBAAa,aAAa,CAAC,cAAc,GAAG,GAAG;;gBA+B3C,OAAO,GAAE,gBAAgB,CAAC,cAAc,CAAM,EAC9C,YAAY,CAAC,EAAE,SAAS,KAAK,EAAE;IAoEjC,IAAI,KAAK,IAAI,aAAa,EAAE,CAE3B;IAED,IAAI,SAAS,IAAI,MAAM,EAAE,CAExB;IAEM,UAAU,IAAI,MAAM,GAAG,SAAS;IAIhC,iBAAiB,IAAI,MAAM,GAAG,SAAS;IAIvC,iBAAiB,IAAI,MAAM;IAI3B,cAAc,IAAI,MAAM,GAAG,SAAS;IAIpC,WAAW,IAAI,OAAO;IAI7B;;;OAGG;IACH,OAAO,CAAC,WAAW;IA0BZ,UAAU,IAAI,CAAC,CAAC,GAAG,EAAE,eAAe,KAAK,IAAI,CAAC,GAAG,SAAS;IAI1D,cAAc,IAAI,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC;YAInC,YAAY;IA4D1B,QAAQ,CAAC,KAAK,EAAE,SAAS,KAAK,EAAE,GAAG,IAAI;IAKvC,OAAO,CAAC,IAAI,EAAE,KAAK,GAAG,IAAI;IAK1B,aAAa,CAAC,gBAAgB,EAAE,WAAW,GAAG,IAAI;IA0ClD;;;;;;;OAOG;IACH,UAAU,CACR,OAAO,EAAE,CACP,GAAG,EAAE,eAAe,CAAC,GAAG,EAAE,GAAG,CAAC,KAC3B,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,GAC5C,IAAI;IAKP,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI;IA6nB3B,KAAK,CACT,WAAW,CAAC,EAAE,MAAM,EAAE,EACtB,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,sBAAsB,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC;IA2KrD;;;;;OAKG;IACI,UAAU,CACf,WAAW,CAAC,EAAE,MAAM,EAAE,EACtB,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,sBAAsB,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC;IAIrD;;;OAGG;YACW,eAAe;IA6L7B,QAAQ,IAAI,MAAM;IAiLX,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;IAIpD,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAKrC;;;;OAIG;IACI,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS;IAI1D,eAAe,IAAI,MAAM,EAAE;IAU3B,kBAAkB,IAAI,WAAW,CAAC,aAAa,EAAE,CAAC;IA+SzD;;OAEG;IACH,cAAc,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;IAU/C;;OAEG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAQrC;;OAEG;IACH,eAAe,IAAI,iBAAiB,EAAE;IAItC;;OAEG;IACH,YAAY,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI;IAM3C;;OAEG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAQnC;;OAEG;IACH,aAAa,IAAI,eAAe,EAAE;IAIlC;;OAEG;IACH,WAAW,CACT,QAAQ,EAAE,CAAC,KAAK,EAAE;QAChB,IAAI,EAAE,aAAa,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;QACf,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,KAAK,IAAI,GACT,IAAI;IAKP;;OAEG;IACH,YAAY,CACV,QAAQ,EAAE,CAAC,KAAK,EAAE;QAChB,IAAI,EAAE,aAAa,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;QACf,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,KAAK,IAAI,GACT,IAAI;IAKP;;OAEG;IACH,0BAA0B,IAAI,uBAAuB;IAIrD;;OAEG;IACH,sBAAsB,IAAI,mBAAmB;IAI7C;;OAEG;IACH,oBAAoB,IAAI,iBAAiB;CAyd1C"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FlagManager.d.ts","sourceRoot":"","sources":["../../src/core/FlagManager.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAEpD,qBAAa,WAAW;;gBAKpB,OAAO,GAAE;QAAE,sBAAsB,CAAC,EAAE,OAAO,CAAA;KAAO,EAClD,YAAY,GAAE,SAAS,KAAK,EAAO;IAMrC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,GAAG,aAAa;
|
|
1
|
+
{"version":3,"file":"FlagManager.d.ts","sourceRoot":"","sources":["../../src/core/FlagManager.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAEpD,qBAAa,WAAW;;gBAKpB,OAAO,GAAE;QAAE,sBAAsB,CAAC,EAAE,OAAO,CAAA;KAAO,EAClD,YAAY,GAAE,SAAS,KAAK,EAAO;IAMrC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,GAAG,aAAa;IAyC5C,OAAO,CAAC,IAAI,EAAE,KAAK,GAAG,IAAI;IAoB1B,+BAA+B,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI;IAQnE,QAAQ,CAAC,KAAK,EAAE,SAAS,KAAK,EAAE,GAAG,IAAI;IAOvC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI9B,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS;IAIhD,IAAI,KAAK,IAAI,aAAa,EAAE,CAE3B;IAED,IAAI,SAAS,IAAI,MAAM,EAAE,CAExB;CACF"}
|
package/dist/core/types.d.ts
CHANGED
|
@@ -1,56 +1,34 @@
|
|
|
1
1
|
import { z } from "zod";
|
|
2
2
|
export type ArgParserInstance = any;
|
|
3
|
-
export declare const zodFlagSchema: z.
|
|
3
|
+
export declare const zodFlagSchema: z.ZodPipe<z.ZodObject<{
|
|
4
4
|
name: z.ZodString;
|
|
5
5
|
allowLigature: z.ZodDefault<z.ZodBoolean>;
|
|
6
6
|
allowMultiple: z.ZodDefault<z.ZodBoolean>;
|
|
7
|
-
description: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString
|
|
8
|
-
options: z.ZodArray<z.ZodString
|
|
7
|
+
description: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
8
|
+
options: z.ZodArray<z.ZodString>;
|
|
9
9
|
defaultValue: z.ZodOptional<z.ZodAny>;
|
|
10
|
-
type: z.ZodDefault<z.ZodUnion<[z.
|
|
11
|
-
mandatory: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.
|
|
10
|
+
type: z.ZodDefault<z.ZodUnion<readonly [z.ZodAny, z.ZodAny, z.ZodAny, z.ZodAny, z.ZodAny, z.ZodCustom<(value: string) => any | Promise<any>, (value: string) => any | Promise<any>>, z.ZodString]>>;
|
|
11
|
+
mandatory: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodCustom<(value?: any, parsedArgs?: any) => boolean, (value?: any, parsedArgs?: any) => boolean>]>>;
|
|
12
12
|
flagOnly: z.ZodDefault<z.ZodBoolean>;
|
|
13
|
-
validate: z.ZodOptional<z.
|
|
14
|
-
enum: z.ZodOptional<z.ZodArray<z.ZodAny
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
allowLigature: z.ZodDefault<z.ZodBoolean>;
|
|
18
|
-
allowMultiple: z.ZodDefault<z.ZodBoolean>;
|
|
19
|
-
description: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
|
|
20
|
-
options: z.ZodArray<z.ZodString, "many">;
|
|
21
|
-
defaultValue: z.ZodOptional<z.ZodAny>;
|
|
22
|
-
type: z.ZodDefault<z.ZodUnion<[z.ZodEffects<z.ZodAny, any, any>, z.ZodEffects<z.ZodAny, any, any>, z.ZodEffects<z.ZodAny, any, any>, z.ZodEffects<z.ZodAny, any, any>, z.ZodEffects<z.ZodAny, any, any>, z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodUnion<[z.ZodAny, z.ZodPromise<z.ZodAny>]>>, z.ZodEffects<z.ZodString, string, string>]>>;
|
|
23
|
-
mandatory: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodFunction<z.ZodTuple<[z.ZodAny], z.ZodUnknown>, z.ZodBoolean>]>>;
|
|
24
|
-
flagOnly: z.ZodDefault<z.ZodBoolean>;
|
|
25
|
-
validate: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodOptional<z.ZodAny>, z.ZodOptional<z.ZodAny>], z.ZodUnknown>, z.ZodUnion<[z.ZodBoolean, z.ZodString, z.ZodVoid, z.ZodPromise<z.ZodUnion<[z.ZodBoolean, z.ZodString, z.ZodVoid]>>]>>>;
|
|
26
|
-
enum: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
|
|
27
|
-
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
28
|
-
name: z.ZodString;
|
|
29
|
-
allowLigature: z.ZodDefault<z.ZodBoolean>;
|
|
30
|
-
allowMultiple: z.ZodDefault<z.ZodBoolean>;
|
|
31
|
-
description: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
|
|
32
|
-
options: z.ZodArray<z.ZodString, "many">;
|
|
33
|
-
defaultValue: z.ZodOptional<z.ZodAny>;
|
|
34
|
-
type: z.ZodDefault<z.ZodUnion<[z.ZodEffects<z.ZodAny, any, any>, z.ZodEffects<z.ZodAny, any, any>, z.ZodEffects<z.ZodAny, any, any>, z.ZodEffects<z.ZodAny, any, any>, z.ZodEffects<z.ZodAny, any, any>, z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodUnion<[z.ZodAny, z.ZodPromise<z.ZodAny>]>>, z.ZodEffects<z.ZodString, string, string>]>>;
|
|
35
|
-
mandatory: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodFunction<z.ZodTuple<[z.ZodAny], z.ZodUnknown>, z.ZodBoolean>]>>;
|
|
36
|
-
flagOnly: z.ZodDefault<z.ZodBoolean>;
|
|
37
|
-
validate: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodOptional<z.ZodAny>, z.ZodOptional<z.ZodAny>], z.ZodUnknown>, z.ZodUnion<[z.ZodBoolean, z.ZodString, z.ZodVoid, z.ZodPromise<z.ZodUnion<[z.ZodBoolean, z.ZodString, z.ZodVoid]>>]>>>;
|
|
38
|
-
enum: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
|
|
39
|
-
}, z.ZodTypeAny, "passthrough">>, {
|
|
13
|
+
validate: z.ZodOptional<z.ZodCustom<(value?: any, parsedArgs?: any) => boolean | string | void | Promise<boolean | string | void>, (value?: any, parsedArgs?: any) => boolean | string | void | Promise<boolean | string | void>>>;
|
|
14
|
+
enum: z.ZodOptional<z.ZodArray<z.ZodAny>>;
|
|
15
|
+
env: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
16
|
+
}, z.core.$strip>, z.ZodTransform<{
|
|
40
17
|
[key: string]: any;
|
|
41
|
-
},
|
|
42
|
-
name:
|
|
43
|
-
allowLigature:
|
|
44
|
-
allowMultiple:
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
validate
|
|
52
|
-
enum
|
|
53
|
-
|
|
18
|
+
}, {
|
|
19
|
+
name: string;
|
|
20
|
+
allowLigature: boolean;
|
|
21
|
+
allowMultiple: boolean;
|
|
22
|
+
options: string[];
|
|
23
|
+
type: any;
|
|
24
|
+
flagOnly: boolean;
|
|
25
|
+
description?: string | string[] | undefined;
|
|
26
|
+
defaultValue?: any;
|
|
27
|
+
mandatory?: boolean | ((value?: any, parsedArgs?: any) => boolean) | undefined;
|
|
28
|
+
validate?: ((value?: any, parsedArgs?: any) => boolean | string | void | Promise<boolean | string | void>) | undefined;
|
|
29
|
+
enum?: any[] | undefined;
|
|
30
|
+
env?: string | string[] | undefined;
|
|
31
|
+
}>>;
|
|
54
32
|
/**
|
|
55
33
|
* The raw input type for defining a flag, before Zod processing (aliases, defaults).
|
|
56
34
|
*/
|
|
@@ -89,6 +67,7 @@ export type ProcessedFlag = Omit<ProcessedFlagCore, "validate" | "enum" | "manda
|
|
|
89
67
|
validate?: (value: any, parsedArgs?: TParsedArgs<ProcessedFlag[]>) => boolean | string | void | Promise<boolean | string | void>;
|
|
90
68
|
enum?: any[];
|
|
91
69
|
mandatory?: boolean | ((parsedArgs: TParsedArgs<ProcessedFlag[]>) => boolean);
|
|
70
|
+
env?: string | string[];
|
|
92
71
|
};
|
|
93
72
|
/**
|
|
94
73
|
* Resolves the TypeScript type from a flag's `type` definition.
|
|
@@ -128,6 +107,11 @@ export type IHandlerContext<TCurrentCommandArgs extends Record<string, any> = Re
|
|
|
128
107
|
/** Optional: The root `ArgParser` instance of the CLI. */
|
|
129
108
|
/** Indicates if the handler is being called from MCP mode (true) or CLI mode (false). */
|
|
130
109
|
isMcp?: boolean;
|
|
110
|
+
/**
|
|
111
|
+
* Get a flag value with proper resolution priority (CLI flag > ENV > default).
|
|
112
|
+
* Only available in MCP mode when isMcp is true.
|
|
113
|
+
*/
|
|
114
|
+
getFlag?: (name: string) => any;
|
|
131
115
|
};
|
|
132
116
|
/**
|
|
133
117
|
* Generic type for the collection of processed flags that an ArgParser instance manages.
|
|
@@ -160,52 +144,26 @@ export declare const OutputSchemaPatterns: {
|
|
|
160
144
|
success: z.ZodBoolean;
|
|
161
145
|
message: z.ZodOptional<z.ZodString>;
|
|
162
146
|
error: z.ZodOptional<z.ZodString>;
|
|
163
|
-
},
|
|
164
|
-
success: boolean;
|
|
165
|
-
message?: string | undefined;
|
|
166
|
-
error?: string | undefined;
|
|
167
|
-
}, {
|
|
168
|
-
success: boolean;
|
|
169
|
-
message?: string | undefined;
|
|
170
|
-
error?: string | undefined;
|
|
171
|
-
}>;
|
|
147
|
+
}, z.core.$strip>;
|
|
172
148
|
/**
|
|
173
149
|
* Success response with data payload
|
|
174
150
|
* @example { success: true, data: {...}, message: "Data retrieved" }
|
|
175
151
|
*/
|
|
176
152
|
readonly successWithData: (dataSchema?: z.ZodTypeAny) => z.ZodObject<{
|
|
177
153
|
success: z.ZodBoolean;
|
|
178
|
-
data: z.
|
|
154
|
+
data: z.ZodAny | z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
|
|
179
155
|
message: z.ZodOptional<z.ZodString>;
|
|
180
156
|
error: z.ZodOptional<z.ZodString>;
|
|
181
|
-
},
|
|
182
|
-
success: boolean;
|
|
183
|
-
message?: string | undefined;
|
|
184
|
-
error?: string | undefined;
|
|
185
|
-
data?: any;
|
|
186
|
-
}, {
|
|
187
|
-
success: boolean;
|
|
188
|
-
message?: string | undefined;
|
|
189
|
-
error?: string | undefined;
|
|
190
|
-
data?: any;
|
|
191
|
-
}>;
|
|
157
|
+
}, z.core.$strip>;
|
|
192
158
|
/**
|
|
193
159
|
* List/array response pattern
|
|
194
160
|
* @example { items: [...], count: 5, hasMore: false }
|
|
195
161
|
*/
|
|
196
162
|
readonly list: (itemSchema?: z.ZodTypeAny) => z.ZodObject<{
|
|
197
|
-
items: z.ZodArray<z.
|
|
163
|
+
items: z.ZodArray<z.ZodAny | z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
|
|
198
164
|
count: z.ZodOptional<z.ZodNumber>;
|
|
199
165
|
hasMore: z.ZodOptional<z.ZodBoolean>;
|
|
200
|
-
},
|
|
201
|
-
items: any[];
|
|
202
|
-
count?: number | undefined;
|
|
203
|
-
hasMore?: boolean | undefined;
|
|
204
|
-
}, {
|
|
205
|
-
items: any[];
|
|
206
|
-
count?: number | undefined;
|
|
207
|
-
hasMore?: boolean | undefined;
|
|
208
|
-
}>;
|
|
166
|
+
}, z.core.$strip>;
|
|
209
167
|
/**
|
|
210
168
|
* File operation response pattern
|
|
211
169
|
* @example { path: "/path/to/file", size: 1024, created: true }
|
|
@@ -216,19 +174,7 @@ export declare const OutputSchemaPatterns: {
|
|
|
216
174
|
created: z.ZodOptional<z.ZodBoolean>;
|
|
217
175
|
modified: z.ZodOptional<z.ZodBoolean>;
|
|
218
176
|
exists: z.ZodOptional<z.ZodBoolean>;
|
|
219
|
-
},
|
|
220
|
-
path: string;
|
|
221
|
-
size?: number | undefined;
|
|
222
|
-
created?: boolean | undefined;
|
|
223
|
-
modified?: boolean | undefined;
|
|
224
|
-
exists?: boolean | undefined;
|
|
225
|
-
}, {
|
|
226
|
-
path: string;
|
|
227
|
-
size?: number | undefined;
|
|
228
|
-
created?: boolean | undefined;
|
|
229
|
-
modified?: boolean | undefined;
|
|
230
|
-
exists?: boolean | undefined;
|
|
231
|
-
}>;
|
|
177
|
+
}, z.core.$strip>;
|
|
232
178
|
/**
|
|
233
179
|
* Process execution response pattern
|
|
234
180
|
* @example { exitCode: 0, stdout: "output", stderr: "", duration: 1500 }
|
|
@@ -239,19 +185,7 @@ export declare const OutputSchemaPatterns: {
|
|
|
239
185
|
stderr: z.ZodOptional<z.ZodString>;
|
|
240
186
|
duration: z.ZodOptional<z.ZodNumber>;
|
|
241
187
|
command: z.ZodOptional<z.ZodString>;
|
|
242
|
-
},
|
|
243
|
-
exitCode: number;
|
|
244
|
-
stdout?: string | undefined;
|
|
245
|
-
stderr?: string | undefined;
|
|
246
|
-
duration?: number | undefined;
|
|
247
|
-
command?: string | undefined;
|
|
248
|
-
}, {
|
|
249
|
-
exitCode: number;
|
|
250
|
-
stdout?: string | undefined;
|
|
251
|
-
stderr?: string | undefined;
|
|
252
|
-
duration?: number | undefined;
|
|
253
|
-
command?: string | undefined;
|
|
254
|
-
}>;
|
|
188
|
+
}, z.core.$strip>;
|
|
255
189
|
};
|
|
256
190
|
/**
|
|
257
191
|
* Type for output schema pattern names with auto-completion support
|
package/dist/core/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/core/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB,MAAM,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAEpC,eAAO,MAAM,aAAa
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/core/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB,MAAM,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAEpC,eAAO,MAAM,aAAa;;;;;;;kHAmDD,MAAM,KAAK,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,UAA7B,MAAM,KAAK,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;qFAuB5B,GAAG,eAAe,GAAG,KAAK,OAAO,WAAjC,GAAG,eAAe,GAAG,KAAK,OAAO;;iDAkBzC,GAAG,eACE,GAAG,KACb,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC,WAFrD,GAAG,eACE,GAAG,KACb,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;;;;;;;;;;;;;;oCApB7C,GAAG,eAAe,GAAG,KAAK,OAAO;yBAkBzC,GAAG,eACE,GAAG,KACb,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;;;GAsCnE,CAAC;AAEL;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAEtD;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAClC,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,gBAAgB,GAChB,iBAAiB,GACjB,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,GAAG,CAAC,GACxB,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC,GACjC,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,OAAO,GACP,QAAQ,CAAC;AAEb;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,aAAa,CAAC,EAAE,MAAM,CAAC,GAAG;IAC7E,IAAI,EAAE,0BAA0B,CAAC;CAClC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,KAAK,GAAG,SAAS,GAAG;IAC9B,0BAA0B;IAC1B,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,uBAAuB;IACvB,QAAQ,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,UAAU,EAAE,WAAW,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,CAAC;IACjE,sFAAsF;IACtF,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,IAAI,CAC9B,iBAAiB,EACjB,UAAU,GAAG,MAAM,GAAG,WAAW,CAClC,GAAG;IAEF,QAAQ,CAAC,EAAE,CACT,KAAK,EAAE,GAAG,EACV,UAAU,CAAC,EAAE,WAAW,CAAC,aAAa,EAAE,CAAC,KACtC,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC,CAAC;IAChE,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACb,SAAS,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,UAAU,EAAE,WAAW,CAAC,aAAa,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC;IAC9E,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,0BAA0B,IAC1D,CAAC,SAAS,iBAAiB,GACvB,MAAM,GACN,CAAC,SAAS,iBAAiB,GACzB,MAAM,GACN,CAAC,SAAS,kBAAkB,GAC1B,OAAO,GACP,CAAC,SAAS,gBAAgB,GACxB,GAAG,EAAE,GACL,CAAC,SAAS,iBAAiB,GACzB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACnB,CAAC,SAAS,QAAQ,GAChB,MAAM,GACN,CAAC,SAAS,QAAQ,GAChB,MAAM,GACN,CAAC,SAAS,SAAS,GACjB,OAAO,GACP,CAAC,SAAS,OAAO,GACf,GAAG,EAAE,GACL,CAAC,SAAS,QAAQ,GAChB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACnB,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC,GAClC,CAAC,GACD,GAAG,CAAC;AAE9B;;;GAGG;AACH,MAAM,MAAM,eAAe,CAAC,KAAK,SAAS,aAAa,IACrD,KAAK,CAAC,UAAU,CAAC,SAAS,IAAI,GAC1B,KAAK,CAAC,eAAe,CAAC,SAAS,IAAI,GACjC,OAAO,EAAE,GACT,OAAO,GACT,KAAK,CAAC,eAAe,CAAC,SAAS,IAAI,GACjC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,GACjC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;AAEnC;;;;GAIG;AACH,MAAM,MAAM,WAAW,CAAC,MAAM,SAAS,SAAS,aAAa,EAAE,IAAI;KAChE,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,eAAe,CAC5C,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,CACrC;CACF,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,eAAe,CACzB,mBAAmB,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACrE,kBAAkB,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAClE;IACF,wDAAwD;IACxD,IAAI,EAAE,mBAAmB,CAAC;IAC1B,yEAAyE;IACzE,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAChC,8DAA8D;IAC9D,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,2FAA2F;IAC3F,MAAM,EAAE,iBAAiB,CAAC;IAC1B,wEAAwE;IACxE,YAAY,CAAC,EAAE,iBAAiB,CAAC;IACjC,0DAA0D;IAE1D,yFAAyF;IACzF,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,GAAG,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,SAAS,aAAa,EAAE,CAAC;AAElD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,0BAA0B,GACnC,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,OAAO,GAAG,QAAQ,CAqCtD;AAED;;GAEG;AACH,eAAO,MAAM,oBAAoB;IAC/B;;;OAGG;;;;;;IAcH;;;OAGG;4CAC4B,CAAC,CAAC,UAAU;;;;;;IAc3C;;;OAGG;iCACiB,CAAC,CAAC,UAAU;;;;;IAUhC;;;OAGG;;;;;;;;IAaH;;;OAGG;;;;;;;;CAYK,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,OAAO,oBAAoB,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B,uBAAuB,GACvB,CAAC,CAAC,UAAU,GACZ,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC;AAEjC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,kBAAkB,GAAG,CAAC,CAAC,UAAU,CAkB5E;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW,CAC1B,gBAAgB,SAAS,UAAU,GAAG,UAAU,EAChD,mBAAmB,SAAS,UAAU,GAAG,UAAU,EACnD,cAAc,GAAG,GAAG;IAEpB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4EAA4E;IAE5E,MAAM,EAAE,iBAAiB,CAAC;IAC1B,4CAA4C;IAC5C,OAAO,CAAC,EAAE,CACR,GAAG,EAAE,eAAe,CAClB,WAAW,CAAC,gBAAgB,CAAC,EAC7B,WAAW,CAAC,mBAAmB,CAAC,CACjC,KACE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAC9C,0FAA0F;IAC1F,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,gDAAgD;IAChD,aAAa,CAAC,EAAE;QACd,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,qDAAqD;IACrD,cAAc,CAAC,EAAE,GAAG,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,GAAG;IAClC,yCAAyC;IACzC,OAAO,EAAE,OAAO,CAAC;IACjB,8DAA8D;IAC9D,QAAQ,EAAE,MAAM,CAAC;IACjB,6CAA6C;IAC7C,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,8CAA8C;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gEAAgE;IAChE,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,yCAAyC;IACzC,IAAI,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;CAC3D;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,mHAAmH;IACnH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,iGAAiG;IACjG,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,mHAAmH;IACnH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,iGAAiG;IACjG,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,MAAM,WAAW,CACrB,YAAY,SAAS,UAAU,GAAG,UAAU,EAC5C,kBAAkB,SAAS,UAAU,GAAG,UAAU,EAClD,cAAc,GAAG,GAAG,IAClB,CACF,GAAG,EAAE,eAAe,CAClB,WAAW,CAAC,YAAY,CAAC,EACzB,WAAW,CAAC,kBAAkB,CAAC,CAChC,KACE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC"}
|
|
@@ -33,7 +33,63 @@ export declare class DxtGenerator {
|
|
|
33
33
|
*/
|
|
34
34
|
private buildDxtWithTsdown;
|
|
35
35
|
/**
|
|
36
|
-
*
|
|
36
|
+
* Checks if a module ID is a Node.js built-in
|
|
37
|
+
*/
|
|
38
|
+
isNodeBuiltin(id: string): boolean;
|
|
39
|
+
/**
|
|
40
|
+
* Determines if a module should be treated as external based on bundling configuration.
|
|
41
|
+
* This logic is shared between external and noExternal configurations.
|
|
42
|
+
*
|
|
43
|
+
* @param id - The module identifier (e.g., 'lodash', '@types/node', './utils')
|
|
44
|
+
* @param importer - The file path that is importing this module (undefined for entry points)
|
|
45
|
+
* @param withNodeModules - Whether to include node_modules in the bundle
|
|
46
|
+
* @returns true if the module should be external (not bundled), false if it should be bundled
|
|
47
|
+
*
|
|
48
|
+
* Logic flow:
|
|
49
|
+
* 1. Node built-ins (fs, path, etc.) are always external
|
|
50
|
+
* 2. If no importer (entry point), always bundle
|
|
51
|
+
* 3. If withNodeModules is false, bundle everything except Node built-ins
|
|
52
|
+
* 4. If withNodeModules is true:
|
|
53
|
+
* - If importer is from node_modules, make external
|
|
54
|
+
* - If module resolves to a project file (via TS paths or regular paths), bundle it
|
|
55
|
+
* - Otherwise, make external (likely npm package)
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* // Node built-in - always external
|
|
59
|
+
* shouldModuleBeExternal('fs', './src/main.ts', true) // returns true
|
|
60
|
+
*
|
|
61
|
+
* // Project file via TS paths or regular paths - bundle it
|
|
62
|
+
* shouldModuleBeExternal('@/utils', './src/main.ts', true) // returns false
|
|
63
|
+
*
|
|
64
|
+
* // NPM package - external when withNodeModules=true
|
|
65
|
+
* shouldModuleBeExternal('lodash', './src/main.ts', true) // returns true
|
|
66
|
+
*/
|
|
67
|
+
private shouldModuleBeExternal;
|
|
68
|
+
/**
|
|
69
|
+
* Checks if a package ID exists in the local node_modules folder.
|
|
70
|
+
* Only checks the folder or parent folder that contains the nearest package.json file.
|
|
71
|
+
* Returns false if no package.json file is found after 3 parent directory traversals.
|
|
72
|
+
*
|
|
73
|
+
* Alternative approach using require.resolve():
|
|
74
|
+
* ```ts
|
|
75
|
+
* public isNodeModulesPackageWithResolve(packageId: string): boolean {
|
|
76
|
+
* try {
|
|
77
|
+
* require.resolve(packageId);
|
|
78
|
+
* return true;
|
|
79
|
+
* } catch {
|
|
80
|
+
* return false;
|
|
81
|
+
* }
|
|
82
|
+
* }
|
|
83
|
+
* ```
|
|
84
|
+
*
|
|
85
|
+
* Filesystem approach is preferred for bundler context because:
|
|
86
|
+
* - Faster (no module resolution overhead)
|
|
87
|
+
* - No side effects during build
|
|
88
|
+
* - Predictable behavior in build vs runtime contexts
|
|
89
|
+
*/
|
|
90
|
+
isNodeModulesPackage(packageId: string): boolean;
|
|
91
|
+
/**
|
|
92
|
+
* Get the path to the .dxtignore template file
|
|
37
93
|
*/
|
|
38
94
|
private getDxtIgnoreTemplatePath;
|
|
39
95
|
/**
|
|
@@ -53,5 +109,6 @@ export declare class DxtGenerator {
|
|
|
53
109
|
envVars: Record<string, string>;
|
|
54
110
|
userConfig: Record<string, any>;
|
|
55
111
|
};
|
|
112
|
+
private resolveModulePath;
|
|
56
113
|
}
|
|
57
114
|
//# sourceMappingURL=DxtGenerator.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DxtGenerator.d.ts","sourceRoot":"","sources":["../../src/dxt/DxtGenerator.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"DxtGenerator.d.ts","sourceRoot":"","sources":["../../src/dxt/DxtGenerator.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAIjD;;;GAGG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,iBAAiB,CAAM;gBAEnB,iBAAiB,EAAE,GAAG;IAIlC;;OAEG;IACH,OAAO,CAAC,WAAW;IA0BnB;;OAEG;IACU,kBAAkB,CAC7B,WAAW,EAAE,MAAM,EAAE,EACrB,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,OAAO,GAAG,WAAW,CAAC;IAgJjC;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAmC5B,OAAO,CAAC,sBAAsB;IA4F9B;;OAEG;IACH;;;OAGG;YACW,eAAe;IA6J7B;;OAEG;YACW,kBAAkB;IAwQhC;;OAEG;IACI,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IA4CzC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,OAAO,CAAC,sBAAsB;IAkC9B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAyCvD;;OAEG;IACH,OAAO,CAAC,wBAAwB;IAyChC;;OAEG;YACW,oBAAoB;IA0JlC;;OAEG;IACH,OAAO,CAAC,sBAAsB;IAkI9B,OAAO,CAAC,eAAe;IAyBvB;;;OAGG;IACI,wBAAwB,IAAI;QACjC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAChC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KACjC;IA6ED,OAAO,CAAC,iBAAiB;CAoN1B"}
|