machinaos 0.0.1 → 0.0.7

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.
Files changed (422) hide show
  1. package/.env.template +71 -71
  2. package/LICENSE +21 -21
  3. package/README.md +163 -87
  4. package/bin/cli.js +62 -106
  5. package/client/.dockerignore +45 -45
  6. package/client/Dockerfile +68 -68
  7. package/client/dist/assets/index-DFSC53FP.css +1 -0
  8. package/client/dist/assets/index-fJ-1gTf5.js +613 -0
  9. package/client/dist/index.html +14 -0
  10. package/client/eslint.config.js +34 -16
  11. package/client/nginx.conf +66 -66
  12. package/client/package.json +61 -48
  13. package/client/src/App.tsx +27 -27
  14. package/client/src/Dashboard.tsx +1200 -1172
  15. package/client/src/ParameterPanel.tsx +302 -300
  16. package/client/src/components/AIAgentNode.tsx +315 -321
  17. package/client/src/components/APIKeyValidator.tsx +117 -117
  18. package/client/src/components/ClaudeChatModelNode.tsx +17 -17
  19. package/client/src/components/CredentialsModal.tsx +1200 -306
  20. package/client/src/components/GeminiChatModelNode.tsx +17 -17
  21. package/client/src/components/GenericNode.tsx +356 -356
  22. package/client/src/components/LocationParameterPanel.tsx +153 -153
  23. package/client/src/components/ModelNode.tsx +285 -285
  24. package/client/src/components/OpenAIChatModelNode.tsx +17 -17
  25. package/client/src/components/OutputPanel.tsx +470 -470
  26. package/client/src/components/ParameterRenderer.tsx +1873 -1873
  27. package/client/src/components/SkillEditorModal.tsx +3 -3
  28. package/client/src/components/SquareNode.tsx +812 -796
  29. package/client/src/components/ToolkitNode.tsx +365 -365
  30. package/client/src/components/auth/LoginPage.tsx +247 -247
  31. package/client/src/components/auth/ProtectedRoute.tsx +59 -59
  32. package/client/src/components/base/BaseChatModelNode.tsx +270 -270
  33. package/client/src/components/icons/AIProviderIcons.tsx +50 -50
  34. package/client/src/components/maps/GoogleMapsPicker.tsx +136 -136
  35. package/client/src/components/maps/MapsPreviewPanel.tsx +109 -109
  36. package/client/src/components/maps/index.ts +25 -25
  37. package/client/src/components/parameterPanel/InputSection.tsx +1094 -1094
  38. package/client/src/components/parameterPanel/LocationPanelLayout.tsx +64 -64
  39. package/client/src/components/parameterPanel/MapsSection.tsx +91 -91
  40. package/client/src/components/parameterPanel/MiddleSection.tsx +867 -571
  41. package/client/src/components/parameterPanel/OutputSection.tsx +80 -80
  42. package/client/src/components/parameterPanel/ParameterPanelLayout.tsx +81 -81
  43. package/client/src/components/parameterPanel/ToolSchemaEditor.tsx +436 -436
  44. package/client/src/components/parameterPanel/index.ts +41 -41
  45. package/client/src/components/shared/DataPanel.tsx +142 -142
  46. package/client/src/components/shared/JSONTreeRenderer.tsx +105 -105
  47. package/client/src/components/ui/AIResultModal.tsx +203 -203
  48. package/client/src/components/ui/ApiKeyInput.tsx +93 -0
  49. package/client/src/components/ui/CodeEditor.tsx +81 -81
  50. package/client/src/components/ui/CollapsibleSection.tsx +87 -87
  51. package/client/src/components/ui/ComponentItem.tsx +153 -153
  52. package/client/src/components/ui/ComponentPalette.tsx +320 -320
  53. package/client/src/components/ui/ConsolePanel.tsx +151 -43
  54. package/client/src/components/ui/ErrorBoundary.tsx +195 -195
  55. package/client/src/components/ui/InputNodesPanel.tsx +203 -203
  56. package/client/src/components/ui/MapSelector.tsx +313 -313
  57. package/client/src/components/ui/Modal.tsx +151 -148
  58. package/client/src/components/ui/NodeOutputPanel.tsx +1150 -1150
  59. package/client/src/components/ui/OutputDisplayPanel.tsx +381 -381
  60. package/client/src/components/ui/QRCodeDisplay.tsx +182 -0
  61. package/client/src/components/ui/TopToolbar.tsx +736 -736
  62. package/client/src/components/ui/WorkflowSidebar.tsx +293 -293
  63. package/client/src/config/antdTheme.ts +186 -186
  64. package/client/src/contexts/AuthContext.tsx +221 -221
  65. package/client/src/contexts/ThemeContext.tsx +42 -42
  66. package/client/src/contexts/WebSocketContext.tsx +2144 -1971
  67. package/client/src/factories/baseChatModelFactory.ts +255 -255
  68. package/client/src/hooks/useAndroidOperations.ts +118 -164
  69. package/client/src/hooks/useApiKeyValidation.ts +106 -106
  70. package/client/src/hooks/useApiKeys.ts +238 -238
  71. package/client/src/hooks/useAppTheme.ts +17 -17
  72. package/client/src/hooks/useComponentPalette.ts +50 -50
  73. package/client/src/hooks/useDragAndDrop.ts +123 -123
  74. package/client/src/hooks/useDragVariable.ts +88 -88
  75. package/client/src/hooks/useExecution.ts +319 -313
  76. package/client/src/hooks/useParameterPanel.ts +176 -176
  77. package/client/src/hooks/useReactFlowNodes.ts +188 -188
  78. package/client/src/hooks/useToolSchema.ts +209 -209
  79. package/client/src/hooks/useWhatsApp.ts +196 -196
  80. package/client/src/hooks/useWorkflowManagement.ts +45 -45
  81. package/client/src/index.css +314 -314
  82. package/client/src/nodeDefinitions/aiAgentNodes.ts +335 -335
  83. package/client/src/nodeDefinitions/aiModelNodes.ts +340 -340
  84. package/client/src/nodeDefinitions/androidServiceNodes.ts +383 -383
  85. package/client/src/nodeDefinitions/chatNodes.ts +135 -135
  86. package/client/src/nodeDefinitions/codeNodes.ts +54 -54
  87. package/client/src/nodeDefinitions/index.ts +14 -14
  88. package/client/src/nodeDefinitions/locationNodes.ts +462 -462
  89. package/client/src/nodeDefinitions/schedulerNodes.ts +220 -220
  90. package/client/src/nodeDefinitions/skillNodes.ts +17 -5
  91. package/client/src/nodeDefinitions/utilityNodes.ts +284 -284
  92. package/client/src/nodeDefinitions/whatsappNodes.ts +821 -865
  93. package/client/src/nodeDefinitions.ts +101 -103
  94. package/client/src/services/dynamicParameterService.ts +95 -95
  95. package/client/src/services/execution/aiAgentExecutionService.ts +34 -34
  96. package/client/src/services/executionService.ts +227 -231
  97. package/client/src/services/workflowApi.ts +91 -91
  98. package/client/src/store/useAppStore.ts +578 -581
  99. package/client/src/styles/theme.ts +513 -508
  100. package/client/src/styles/zIndex.ts +16 -16
  101. package/client/src/types/ComponentTypes.ts +38 -38
  102. package/client/src/types/INodeProperties.ts +287 -287
  103. package/client/src/types/NodeTypes.ts +27 -27
  104. package/client/src/utils/formatters.ts +32 -32
  105. package/client/src/utils/googleMapsLoader.ts +139 -139
  106. package/client/src/utils/locationUtils.ts +84 -84
  107. package/client/src/utils/nodeUtils.ts +30 -30
  108. package/client/src/utils/workflow.ts +29 -29
  109. package/client/src/vite-env.d.ts +12 -12
  110. package/client/tailwind.config.js +59 -59
  111. package/client/tsconfig.json +25 -25
  112. package/client/vite.config.js +35 -35
  113. package/install.ps1 +308 -0
  114. package/install.sh +343 -0
  115. package/package.json +81 -70
  116. package/scripts/build.js +174 -51
  117. package/scripts/clean.js +40 -40
  118. package/scripts/start.js +234 -210
  119. package/scripts/stop.js +301 -325
  120. package/server/.dockerignore +44 -44
  121. package/server/Dockerfile +45 -45
  122. package/server/constants.py +244 -249
  123. package/server/core/cache.py +460 -460
  124. package/server/core/config.py +127 -127
  125. package/server/core/container.py +98 -98
  126. package/server/core/database.py +1296 -1210
  127. package/server/core/logging.py +313 -313
  128. package/server/main.py +288 -288
  129. package/server/middleware/__init__.py +5 -5
  130. package/server/middleware/auth.py +89 -89
  131. package/server/models/auth.py +52 -52
  132. package/server/models/cache.py +24 -24
  133. package/server/models/database.py +235 -210
  134. package/server/models/nodes.py +435 -455
  135. package/server/pyproject.toml +75 -72
  136. package/server/requirements.txt +83 -83
  137. package/server/routers/android.py +294 -294
  138. package/server/routers/auth.py +203 -203
  139. package/server/routers/database.py +150 -150
  140. package/server/routers/maps.py +141 -141
  141. package/server/routers/nodejs_compat.py +288 -288
  142. package/server/routers/webhook.py +90 -90
  143. package/server/routers/websocket.py +2239 -2127
  144. package/server/routers/whatsapp.py +761 -761
  145. package/server/routers/workflow.py +199 -199
  146. package/server/services/ai.py +2444 -2414
  147. package/server/services/android_service.py +588 -588
  148. package/server/services/auth.py +130 -130
  149. package/server/services/chat_client.py +160 -160
  150. package/server/services/deployment/manager.py +706 -706
  151. package/server/services/event_waiter.py +675 -785
  152. package/server/services/execution/executor.py +1351 -1351
  153. package/server/services/execution/models.py +1 -1
  154. package/server/services/handlers/__init__.py +122 -126
  155. package/server/services/handlers/ai.py +390 -355
  156. package/server/services/handlers/android.py +69 -260
  157. package/server/services/handlers/code.py +278 -278
  158. package/server/services/handlers/http.py +193 -193
  159. package/server/services/handlers/tools.py +146 -32
  160. package/server/services/handlers/triggers.py +107 -107
  161. package/server/services/handlers/utility.py +822 -822
  162. package/server/services/handlers/whatsapp.py +423 -476
  163. package/server/services/maps.py +288 -288
  164. package/server/services/memory_store.py +103 -103
  165. package/server/services/node_executor.py +372 -375
  166. package/server/services/scheduler.py +155 -155
  167. package/server/services/skill_loader.py +1 -1
  168. package/server/services/status_broadcaster.py +834 -826
  169. package/server/services/temporal/__init__.py +23 -23
  170. package/server/services/temporal/activities.py +344 -344
  171. package/server/services/temporal/client.py +76 -76
  172. package/server/services/temporal/executor.py +147 -147
  173. package/server/services/temporal/worker.py +251 -251
  174. package/server/services/temporal/workflow.py +355 -355
  175. package/server/services/temporal/ws_client.py +236 -236
  176. package/server/services/text.py +110 -110
  177. package/server/services/user_auth.py +172 -172
  178. package/server/services/websocket_client.py +29 -29
  179. package/server/services/workflow.py +597 -597
  180. package/server/skills/android-skill/SKILL.md +4 -4
  181. package/server/skills/code-skill/SKILL.md +123 -89
  182. package/server/skills/maps-skill/SKILL.md +3 -3
  183. package/server/skills/memory-skill/SKILL.md +1 -1
  184. package/server/skills/web-search-skill/SKILL.md +154 -0
  185. package/server/skills/whatsapp-skill/SKILL.md +3 -3
  186. package/server/uv.lock +461 -100
  187. package/server/whatsapp-rpc/.dockerignore +30 -30
  188. package/server/whatsapp-rpc/Dockerfile +44 -44
  189. package/server/whatsapp-rpc/Dockerfile.web +17 -17
  190. package/server/whatsapp-rpc/README.md +139 -139
  191. package/server/whatsapp-rpc/bin/whatsapp-rpc-server +0 -0
  192. package/server/whatsapp-rpc/cli.js +95 -95
  193. package/server/whatsapp-rpc/configs/config.yaml +6 -6
  194. package/server/whatsapp-rpc/docker-compose.yml +35 -35
  195. package/server/whatsapp-rpc/docs/API.md +410 -410
  196. package/server/whatsapp-rpc/node_modules/.package-lock.json +259 -0
  197. package/server/whatsapp-rpc/node_modules/chalk/license +9 -0
  198. package/server/whatsapp-rpc/node_modules/chalk/package.json +83 -0
  199. package/server/whatsapp-rpc/node_modules/chalk/readme.md +297 -0
  200. package/server/whatsapp-rpc/node_modules/chalk/source/index.d.ts +325 -0
  201. package/server/whatsapp-rpc/node_modules/chalk/source/index.js +225 -0
  202. package/server/whatsapp-rpc/node_modules/chalk/source/utilities.js +33 -0
  203. package/server/whatsapp-rpc/node_modules/chalk/source/vendor/ansi-styles/index.d.ts +236 -0
  204. package/server/whatsapp-rpc/node_modules/chalk/source/vendor/ansi-styles/index.js +223 -0
  205. package/server/whatsapp-rpc/node_modules/chalk/source/vendor/supports-color/browser.d.ts +1 -0
  206. package/server/whatsapp-rpc/node_modules/chalk/source/vendor/supports-color/browser.js +34 -0
  207. package/server/whatsapp-rpc/node_modules/chalk/source/vendor/supports-color/index.d.ts +55 -0
  208. package/server/whatsapp-rpc/node_modules/chalk/source/vendor/supports-color/index.js +190 -0
  209. package/server/whatsapp-rpc/node_modules/commander/LICENSE +22 -0
  210. package/server/whatsapp-rpc/node_modules/commander/Readme.md +1148 -0
  211. package/server/whatsapp-rpc/node_modules/commander/esm.mjs +16 -0
  212. package/server/whatsapp-rpc/node_modules/commander/index.js +26 -0
  213. package/server/whatsapp-rpc/node_modules/commander/lib/argument.js +145 -0
  214. package/server/whatsapp-rpc/node_modules/commander/lib/command.js +2179 -0
  215. package/server/whatsapp-rpc/node_modules/commander/lib/error.js +43 -0
  216. package/server/whatsapp-rpc/node_modules/commander/lib/help.js +462 -0
  217. package/server/whatsapp-rpc/node_modules/commander/lib/option.js +329 -0
  218. package/server/whatsapp-rpc/node_modules/commander/lib/suggestSimilar.js +100 -0
  219. package/server/whatsapp-rpc/node_modules/commander/package-support.json +16 -0
  220. package/server/whatsapp-rpc/node_modules/commander/package.json +80 -0
  221. package/server/whatsapp-rpc/node_modules/commander/typings/esm.d.mts +3 -0
  222. package/server/whatsapp-rpc/node_modules/commander/typings/index.d.ts +884 -0
  223. package/server/whatsapp-rpc/node_modules/cross-spawn/LICENSE +21 -0
  224. package/server/whatsapp-rpc/node_modules/cross-spawn/README.md +89 -0
  225. package/server/whatsapp-rpc/node_modules/cross-spawn/index.js +39 -0
  226. package/server/whatsapp-rpc/node_modules/cross-spawn/lib/enoent.js +59 -0
  227. package/server/whatsapp-rpc/node_modules/cross-spawn/lib/parse.js +91 -0
  228. package/server/whatsapp-rpc/node_modules/cross-spawn/lib/util/escape.js +47 -0
  229. package/server/whatsapp-rpc/node_modules/cross-spawn/lib/util/readShebang.js +23 -0
  230. package/server/whatsapp-rpc/node_modules/cross-spawn/lib/util/resolveCommand.js +52 -0
  231. package/server/whatsapp-rpc/node_modules/cross-spawn/package.json +73 -0
  232. package/server/whatsapp-rpc/node_modules/execa/index.d.ts +955 -0
  233. package/server/whatsapp-rpc/node_modules/execa/index.js +309 -0
  234. package/server/whatsapp-rpc/node_modules/execa/lib/command.js +119 -0
  235. package/server/whatsapp-rpc/node_modules/execa/lib/error.js +87 -0
  236. package/server/whatsapp-rpc/node_modules/execa/lib/kill.js +102 -0
  237. package/server/whatsapp-rpc/node_modules/execa/lib/pipe.js +42 -0
  238. package/server/whatsapp-rpc/node_modules/execa/lib/promise.js +36 -0
  239. package/server/whatsapp-rpc/node_modules/execa/lib/stdio.js +49 -0
  240. package/server/whatsapp-rpc/node_modules/execa/lib/stream.js +133 -0
  241. package/server/whatsapp-rpc/node_modules/execa/lib/verbose.js +19 -0
  242. package/server/whatsapp-rpc/node_modules/execa/license +9 -0
  243. package/server/whatsapp-rpc/node_modules/execa/package.json +90 -0
  244. package/server/whatsapp-rpc/node_modules/execa/readme.md +822 -0
  245. package/server/whatsapp-rpc/node_modules/get-stream/license +9 -0
  246. package/server/whatsapp-rpc/node_modules/get-stream/package.json +53 -0
  247. package/server/whatsapp-rpc/node_modules/get-stream/readme.md +291 -0
  248. package/server/whatsapp-rpc/node_modules/get-stream/source/array-buffer.js +84 -0
  249. package/server/whatsapp-rpc/node_modules/get-stream/source/array.js +32 -0
  250. package/server/whatsapp-rpc/node_modules/get-stream/source/buffer.js +20 -0
  251. package/server/whatsapp-rpc/node_modules/get-stream/source/contents.js +101 -0
  252. package/server/whatsapp-rpc/node_modules/get-stream/source/index.d.ts +119 -0
  253. package/server/whatsapp-rpc/node_modules/get-stream/source/index.js +5 -0
  254. package/server/whatsapp-rpc/node_modules/get-stream/source/string.js +36 -0
  255. package/server/whatsapp-rpc/node_modules/get-stream/source/utils.js +11 -0
  256. package/server/whatsapp-rpc/node_modules/get-them-args/LICENSE +21 -0
  257. package/server/whatsapp-rpc/node_modules/get-them-args/README.md +95 -0
  258. package/server/whatsapp-rpc/node_modules/get-them-args/index.js +97 -0
  259. package/server/whatsapp-rpc/node_modules/get-them-args/package.json +36 -0
  260. package/server/whatsapp-rpc/node_modules/human-signals/LICENSE +201 -0
  261. package/server/whatsapp-rpc/node_modules/human-signals/README.md +168 -0
  262. package/server/whatsapp-rpc/node_modules/human-signals/build/src/core.js +273 -0
  263. package/server/whatsapp-rpc/node_modules/human-signals/build/src/main.d.ts +73 -0
  264. package/server/whatsapp-rpc/node_modules/human-signals/build/src/main.js +70 -0
  265. package/server/whatsapp-rpc/node_modules/human-signals/build/src/realtime.js +16 -0
  266. package/server/whatsapp-rpc/node_modules/human-signals/build/src/signals.js +34 -0
  267. package/server/whatsapp-rpc/node_modules/human-signals/package.json +61 -0
  268. package/server/whatsapp-rpc/node_modules/is-stream/index.d.ts +81 -0
  269. package/server/whatsapp-rpc/node_modules/is-stream/index.js +29 -0
  270. package/server/whatsapp-rpc/node_modules/is-stream/license +9 -0
  271. package/server/whatsapp-rpc/node_modules/is-stream/package.json +44 -0
  272. package/server/whatsapp-rpc/node_modules/is-stream/readme.md +60 -0
  273. package/server/whatsapp-rpc/node_modules/isexe/LICENSE +15 -0
  274. package/server/whatsapp-rpc/node_modules/isexe/README.md +51 -0
  275. package/server/whatsapp-rpc/node_modules/isexe/index.js +57 -0
  276. package/server/whatsapp-rpc/node_modules/isexe/mode.js +41 -0
  277. package/server/whatsapp-rpc/node_modules/isexe/package.json +31 -0
  278. package/server/whatsapp-rpc/node_modules/isexe/test/basic.js +221 -0
  279. package/server/whatsapp-rpc/node_modules/isexe/windows.js +42 -0
  280. package/server/whatsapp-rpc/node_modules/kill-port/.editorconfig +12 -0
  281. package/server/whatsapp-rpc/node_modules/kill-port/.gitattributes +1 -0
  282. package/server/whatsapp-rpc/node_modules/kill-port/LICENSE +21 -0
  283. package/server/whatsapp-rpc/node_modules/kill-port/README.md +140 -0
  284. package/server/whatsapp-rpc/node_modules/kill-port/cli.js +25 -0
  285. package/server/whatsapp-rpc/node_modules/kill-port/example.js +21 -0
  286. package/server/whatsapp-rpc/node_modules/kill-port/index.js +46 -0
  287. package/server/whatsapp-rpc/node_modules/kill-port/logo.png +0 -0
  288. package/server/whatsapp-rpc/node_modules/kill-port/package.json +41 -0
  289. package/server/whatsapp-rpc/node_modules/kill-port/pnpm-lock.yaml +4606 -0
  290. package/server/whatsapp-rpc/node_modules/kill-port/test.js +16 -0
  291. package/server/whatsapp-rpc/node_modules/merge-stream/LICENSE +21 -0
  292. package/server/whatsapp-rpc/node_modules/merge-stream/README.md +78 -0
  293. package/server/whatsapp-rpc/node_modules/merge-stream/index.js +41 -0
  294. package/server/whatsapp-rpc/node_modules/merge-stream/package.json +19 -0
  295. package/server/whatsapp-rpc/node_modules/mimic-fn/index.d.ts +52 -0
  296. package/server/whatsapp-rpc/node_modules/mimic-fn/index.js +71 -0
  297. package/server/whatsapp-rpc/node_modules/mimic-fn/license +9 -0
  298. package/server/whatsapp-rpc/node_modules/mimic-fn/package.json +45 -0
  299. package/server/whatsapp-rpc/node_modules/mimic-fn/readme.md +90 -0
  300. package/server/whatsapp-rpc/node_modules/npm-run-path/index.d.ts +90 -0
  301. package/server/whatsapp-rpc/node_modules/npm-run-path/index.js +52 -0
  302. package/server/whatsapp-rpc/node_modules/npm-run-path/license +9 -0
  303. package/server/whatsapp-rpc/node_modules/npm-run-path/node_modules/path-key/index.d.ts +31 -0
  304. package/server/whatsapp-rpc/node_modules/npm-run-path/node_modules/path-key/index.js +12 -0
  305. package/server/whatsapp-rpc/node_modules/npm-run-path/node_modules/path-key/license +9 -0
  306. package/server/whatsapp-rpc/node_modules/npm-run-path/node_modules/path-key/package.json +41 -0
  307. package/server/whatsapp-rpc/node_modules/npm-run-path/node_modules/path-key/readme.md +57 -0
  308. package/server/whatsapp-rpc/node_modules/npm-run-path/package.json +49 -0
  309. package/server/whatsapp-rpc/node_modules/npm-run-path/readme.md +104 -0
  310. package/server/whatsapp-rpc/node_modules/onetime/index.d.ts +59 -0
  311. package/server/whatsapp-rpc/node_modules/onetime/index.js +41 -0
  312. package/server/whatsapp-rpc/node_modules/onetime/license +9 -0
  313. package/server/whatsapp-rpc/node_modules/onetime/package.json +45 -0
  314. package/server/whatsapp-rpc/node_modules/onetime/readme.md +94 -0
  315. package/server/whatsapp-rpc/node_modules/path-key/index.d.ts +40 -0
  316. package/server/whatsapp-rpc/node_modules/path-key/index.js +16 -0
  317. package/server/whatsapp-rpc/node_modules/path-key/license +9 -0
  318. package/server/whatsapp-rpc/node_modules/path-key/package.json +39 -0
  319. package/server/whatsapp-rpc/node_modules/path-key/readme.md +61 -0
  320. package/server/whatsapp-rpc/node_modules/shebang-command/index.js +19 -0
  321. package/server/whatsapp-rpc/node_modules/shebang-command/license +9 -0
  322. package/server/whatsapp-rpc/node_modules/shebang-command/package.json +34 -0
  323. package/server/whatsapp-rpc/node_modules/shebang-command/readme.md +34 -0
  324. package/server/whatsapp-rpc/node_modules/shebang-regex/index.d.ts +22 -0
  325. package/server/whatsapp-rpc/node_modules/shebang-regex/index.js +2 -0
  326. package/server/whatsapp-rpc/node_modules/shebang-regex/license +9 -0
  327. package/server/whatsapp-rpc/node_modules/shebang-regex/package.json +35 -0
  328. package/server/whatsapp-rpc/node_modules/shebang-regex/readme.md +33 -0
  329. package/server/whatsapp-rpc/node_modules/shell-exec/LICENSE +21 -0
  330. package/server/whatsapp-rpc/node_modules/shell-exec/README.md +60 -0
  331. package/server/whatsapp-rpc/node_modules/shell-exec/index.js +47 -0
  332. package/server/whatsapp-rpc/node_modules/shell-exec/package.json +29 -0
  333. package/server/whatsapp-rpc/node_modules/signal-exit/LICENSE.txt +16 -0
  334. package/server/whatsapp-rpc/node_modules/signal-exit/README.md +74 -0
  335. package/server/whatsapp-rpc/node_modules/signal-exit/dist/cjs/browser.d.ts +12 -0
  336. package/server/whatsapp-rpc/node_modules/signal-exit/dist/cjs/browser.d.ts.map +1 -0
  337. package/server/whatsapp-rpc/node_modules/signal-exit/dist/cjs/browser.js +10 -0
  338. package/server/whatsapp-rpc/node_modules/signal-exit/dist/cjs/browser.js.map +1 -0
  339. package/server/whatsapp-rpc/node_modules/signal-exit/dist/cjs/index.d.ts +48 -0
  340. package/server/whatsapp-rpc/node_modules/signal-exit/dist/cjs/index.d.ts.map +1 -0
  341. package/server/whatsapp-rpc/node_modules/signal-exit/dist/cjs/index.js +279 -0
  342. package/server/whatsapp-rpc/node_modules/signal-exit/dist/cjs/index.js.map +1 -0
  343. package/server/whatsapp-rpc/node_modules/signal-exit/dist/cjs/package.json +3 -0
  344. package/server/whatsapp-rpc/node_modules/signal-exit/dist/cjs/signals.d.ts +29 -0
  345. package/server/whatsapp-rpc/node_modules/signal-exit/dist/cjs/signals.d.ts.map +1 -0
  346. package/server/whatsapp-rpc/node_modules/signal-exit/dist/cjs/signals.js +42 -0
  347. package/server/whatsapp-rpc/node_modules/signal-exit/dist/cjs/signals.js.map +1 -0
  348. package/server/whatsapp-rpc/node_modules/signal-exit/dist/mjs/browser.d.ts +12 -0
  349. package/server/whatsapp-rpc/node_modules/signal-exit/dist/mjs/browser.d.ts.map +1 -0
  350. package/server/whatsapp-rpc/node_modules/signal-exit/dist/mjs/browser.js +4 -0
  351. package/server/whatsapp-rpc/node_modules/signal-exit/dist/mjs/browser.js.map +1 -0
  352. package/server/whatsapp-rpc/node_modules/signal-exit/dist/mjs/index.d.ts +48 -0
  353. package/server/whatsapp-rpc/node_modules/signal-exit/dist/mjs/index.d.ts.map +1 -0
  354. package/server/whatsapp-rpc/node_modules/signal-exit/dist/mjs/index.js +275 -0
  355. package/server/whatsapp-rpc/node_modules/signal-exit/dist/mjs/index.js.map +1 -0
  356. package/server/whatsapp-rpc/node_modules/signal-exit/dist/mjs/package.json +3 -0
  357. package/server/whatsapp-rpc/node_modules/signal-exit/dist/mjs/signals.d.ts +29 -0
  358. package/server/whatsapp-rpc/node_modules/signal-exit/dist/mjs/signals.d.ts.map +1 -0
  359. package/server/whatsapp-rpc/node_modules/signal-exit/dist/mjs/signals.js +39 -0
  360. package/server/whatsapp-rpc/node_modules/signal-exit/dist/mjs/signals.js.map +1 -0
  361. package/server/whatsapp-rpc/node_modules/signal-exit/package.json +106 -0
  362. package/server/whatsapp-rpc/node_modules/strip-final-newline/index.js +14 -0
  363. package/server/whatsapp-rpc/node_modules/strip-final-newline/license +9 -0
  364. package/server/whatsapp-rpc/node_modules/strip-final-newline/package.json +43 -0
  365. package/server/whatsapp-rpc/node_modules/strip-final-newline/readme.md +35 -0
  366. package/server/whatsapp-rpc/node_modules/which/CHANGELOG.md +166 -0
  367. package/server/whatsapp-rpc/node_modules/which/LICENSE +15 -0
  368. package/server/whatsapp-rpc/node_modules/which/README.md +54 -0
  369. package/server/whatsapp-rpc/node_modules/which/bin/node-which +52 -0
  370. package/server/whatsapp-rpc/node_modules/which/package.json +43 -0
  371. package/server/whatsapp-rpc/node_modules/which/which.js +125 -0
  372. package/server/whatsapp-rpc/package-lock.json +272 -0
  373. package/server/whatsapp-rpc/package.json +30 -30
  374. package/server/whatsapp-rpc/schema.json +1294 -1294
  375. package/server/whatsapp-rpc/scripts/clean.cjs +66 -66
  376. package/server/whatsapp-rpc/scripts/cli.js +162 -162
  377. package/server/whatsapp-rpc/src/go/whatsapp/history.go +166 -166
  378. package/server/whatsapp-rpc/src/python/pyproject.toml +15 -15
  379. package/server/whatsapp-rpc/src/python/whatsapp_rpc/__init__.py +4 -4
  380. package/server/whatsapp-rpc/src/python/whatsapp_rpc/client.py +427 -427
  381. package/server/whatsapp-rpc/web/app.py +609 -609
  382. package/server/whatsapp-rpc/web/requirements.txt +6 -6
  383. package/server/whatsapp-rpc/web/rpc_client.py +427 -427
  384. package/server/whatsapp-rpc/web/static/openapi.yaml +59 -59
  385. package/server/whatsapp-rpc/web/templates/base.html +149 -149
  386. package/server/whatsapp-rpc/web/templates/contacts.html +240 -240
  387. package/server/whatsapp-rpc/web/templates/dashboard.html +319 -319
  388. package/server/whatsapp-rpc/web/templates/groups.html +328 -328
  389. package/server/whatsapp-rpc/web/templates/messages.html +465 -465
  390. package/server/whatsapp-rpc/web/templates/messaging.html +680 -680
  391. package/server/whatsapp-rpc/web/templates/send.html +258 -258
  392. package/server/whatsapp-rpc/web/templates/settings.html +459 -459
  393. package/client/src/components/ui/AndroidSettingsPanel.tsx +0 -401
  394. package/client/src/components/ui/WhatsAppSettingsPanel.tsx +0 -345
  395. package/client/src/nodeDefinitions/androidDeviceNodes.ts +0 -140
  396. package/docker-compose.prod.yml +0 -107
  397. package/docker-compose.yml +0 -104
  398. package/docs-MachinaOs/README.md +0 -85
  399. package/docs-MachinaOs/deployment/docker.mdx +0 -228
  400. package/docs-MachinaOs/deployment/production.mdx +0 -345
  401. package/docs-MachinaOs/docs.json +0 -75
  402. package/docs-MachinaOs/faq.mdx +0 -309
  403. package/docs-MachinaOs/favicon.svg +0 -5
  404. package/docs-MachinaOs/installation.mdx +0 -160
  405. package/docs-MachinaOs/introduction.mdx +0 -114
  406. package/docs-MachinaOs/logo/dark.svg +0 -6
  407. package/docs-MachinaOs/logo/light.svg +0 -6
  408. package/docs-MachinaOs/nodes/ai-agent.mdx +0 -216
  409. package/docs-MachinaOs/nodes/ai-models.mdx +0 -240
  410. package/docs-MachinaOs/nodes/android.mdx +0 -411
  411. package/docs-MachinaOs/nodes/overview.mdx +0 -181
  412. package/docs-MachinaOs/nodes/schedulers.mdx +0 -316
  413. package/docs-MachinaOs/nodes/webhooks.mdx +0 -330
  414. package/docs-MachinaOs/nodes/whatsapp.mdx +0 -305
  415. package/docs-MachinaOs/quickstart.mdx +0 -119
  416. package/docs-MachinaOs/tutorials/ai-agent-workflow.mdx +0 -177
  417. package/docs-MachinaOs/tutorials/android-automation.mdx +0 -242
  418. package/docs-MachinaOs/tutorials/first-workflow.mdx +0 -134
  419. package/docs-MachinaOs/tutorials/whatsapp-automation.mdx +0 -185
  420. package/nul +0 -0
  421. package/scripts/check-ports.ps1 +0 -33
  422. package/scripts/kill-port.ps1 +0 -154
@@ -0,0 +1,884 @@
1
+ // Type definitions for commander
2
+ // Original definitions by: Alan Agius <https://github.com/alan-agius4>, Marcelo Dezem <https://github.com/mdezem>, vvakame <https://github.com/vvakame>, Jules Randolph <https://github.com/sveinburne>
3
+
4
+ // Using method rather than property for method-signature-style, to document method overloads separately. Allow either.
5
+ /* eslint-disable @typescript-eslint/method-signature-style */
6
+ /* eslint-disable @typescript-eslint/no-explicit-any */
7
+
8
+ // This is a trick to encourage editor to suggest the known literals while still
9
+ // allowing any BaseType value.
10
+ // References:
11
+ // - https://github.com/microsoft/TypeScript/issues/29729
12
+ // - https://github.com/sindresorhus/type-fest/blob/main/source/literal-union.d.ts
13
+ // - https://github.com/sindresorhus/type-fest/blob/main/source/primitive.d.ts
14
+ type LiteralUnion<LiteralType, BaseType extends string | number> = LiteralType | (BaseType & Record<never, never>);
15
+
16
+ export class CommanderError extends Error {
17
+ code: string;
18
+ exitCode: number;
19
+ message: string;
20
+ nestedError?: string;
21
+
22
+ /**
23
+ * Constructs the CommanderError class
24
+ * @param exitCode - suggested exit code which could be used with process.exit
25
+ * @param code - an id string representing the error
26
+ * @param message - human-readable description of the error
27
+ * @constructor
28
+ */
29
+ constructor(exitCode: number, code: string, message: string);
30
+ }
31
+
32
+ export class InvalidArgumentError extends CommanderError {
33
+ /**
34
+ * Constructs the InvalidArgumentError class
35
+ * @param message - explanation of why argument is invalid
36
+ * @constructor
37
+ */
38
+ constructor(message: string);
39
+ }
40
+ export { InvalidArgumentError as InvalidOptionArgumentError }; // deprecated old name
41
+
42
+ export interface ErrorOptions { // optional parameter for error()
43
+ /** an id string representing the error */
44
+ code?: string;
45
+ /** suggested exit code which could be used with process.exit */
46
+ exitCode?: number;
47
+ }
48
+
49
+ export class Argument {
50
+ description: string;
51
+ required: boolean;
52
+ variadic: boolean;
53
+ defaultValue?: any;
54
+ defaultValueDescription?: string;
55
+ argChoices?: string[];
56
+
57
+ /**
58
+ * Initialize a new command argument with the given name and description.
59
+ * The default is that the argument is required, and you can explicitly
60
+ * indicate this with <> around the name. Put [] around the name for an optional argument.
61
+ */
62
+ constructor(arg: string, description?: string);
63
+
64
+ /**
65
+ * Return argument name.
66
+ */
67
+ name(): string;
68
+
69
+ /**
70
+ * Set the default value, and optionally supply the description to be displayed in the help.
71
+ */
72
+ default(value: unknown, description?: string): this;
73
+
74
+ /**
75
+ * Set the custom handler for processing CLI command arguments into argument values.
76
+ */
77
+ argParser<T>(fn: (value: string, previous: T) => T): this;
78
+
79
+ /**
80
+ * Only allow argument value to be one of choices.
81
+ */
82
+ choices(values: readonly string[]): this;
83
+
84
+ /**
85
+ * Make argument required.
86
+ */
87
+ argRequired(): this;
88
+
89
+ /**
90
+ * Make argument optional.
91
+ */
92
+ argOptional(): this;
93
+ }
94
+
95
+ export class Option {
96
+ flags: string;
97
+ description: string;
98
+
99
+ required: boolean; // A value must be supplied when the option is specified.
100
+ optional: boolean; // A value is optional when the option is specified.
101
+ variadic: boolean;
102
+ mandatory: boolean; // The option must have a value after parsing, which usually means it must be specified on command line.
103
+ short?: string;
104
+ long?: string;
105
+ negate: boolean;
106
+ defaultValue?: any;
107
+ defaultValueDescription?: string;
108
+ presetArg?: unknown;
109
+ envVar?: string;
110
+ parseArg?: <T>(value: string, previous: T) => T;
111
+ hidden: boolean;
112
+ argChoices?: string[];
113
+
114
+ constructor(flags: string, description?: string);
115
+
116
+ /**
117
+ * Set the default value, and optionally supply the description to be displayed in the help.
118
+ */
119
+ default(value: unknown, description?: string): this;
120
+
121
+ /**
122
+ * Preset to use when option used without option-argument, especially optional but also boolean and negated.
123
+ * The custom processing (parseArg) is called.
124
+ *
125
+ * @example
126
+ * ```ts
127
+ * new Option('--color').default('GREYSCALE').preset('RGB');
128
+ * new Option('--donate [amount]').preset('20').argParser(parseFloat);
129
+ * ```
130
+ */
131
+ preset(arg: unknown): this;
132
+
133
+ /**
134
+ * Add option name(s) that conflict with this option.
135
+ * An error will be displayed if conflicting options are found during parsing.
136
+ *
137
+ * @example
138
+ * ```ts
139
+ * new Option('--rgb').conflicts('cmyk');
140
+ * new Option('--js').conflicts(['ts', 'jsx']);
141
+ * ```
142
+ */
143
+ conflicts(names: string | string[]): this;
144
+
145
+ /**
146
+ * Specify implied option values for when this option is set and the implied options are not.
147
+ *
148
+ * The custom processing (parseArg) is not called on the implied values.
149
+ *
150
+ * @example
151
+ * program
152
+ * .addOption(new Option('--log', 'write logging information to file'))
153
+ * .addOption(new Option('--trace', 'log extra details').implies({ log: 'trace.txt' }));
154
+ */
155
+ implies(optionValues: OptionValues): this;
156
+
157
+ /**
158
+ * Set environment variable to check for option value.
159
+ *
160
+ * An environment variables is only used if when processed the current option value is
161
+ * undefined, or the source of the current value is 'default' or 'config' or 'env'.
162
+ */
163
+ env(name: string): this;
164
+
165
+ /**
166
+ * Calculate the full description, including defaultValue etc.
167
+ */
168
+ fullDescription(): string;
169
+
170
+ /**
171
+ * Set the custom handler for processing CLI option arguments into option values.
172
+ */
173
+ argParser<T>(fn: (value: string, previous: T) => T): this;
174
+
175
+ /**
176
+ * Whether the option is mandatory and must have a value after parsing.
177
+ */
178
+ makeOptionMandatory(mandatory?: boolean): this;
179
+
180
+ /**
181
+ * Hide option in help.
182
+ */
183
+ hideHelp(hide?: boolean): this;
184
+
185
+ /**
186
+ * Only allow option value to be one of choices.
187
+ */
188
+ choices(values: readonly string[]): this;
189
+
190
+ /**
191
+ * Return option name.
192
+ */
193
+ name(): string;
194
+
195
+ /**
196
+ * Return option name, in a camelcase format that can be used
197
+ * as a object attribute key.
198
+ */
199
+ attributeName(): string;
200
+
201
+ /**
202
+ * Return whether a boolean option.
203
+ *
204
+ * Options are one of boolean, negated, required argument, or optional argument.
205
+ */
206
+ isBoolean(): boolean;
207
+ }
208
+
209
+ export class Help {
210
+ /** output helpWidth, long lines are wrapped to fit */
211
+ helpWidth?: number;
212
+ sortSubcommands: boolean;
213
+ sortOptions: boolean;
214
+ showGlobalOptions: boolean;
215
+
216
+ constructor();
217
+
218
+ /** Get the command term to show in the list of subcommands. */
219
+ subcommandTerm(cmd: Command): string;
220
+ /** Get the command summary to show in the list of subcommands. */
221
+ subcommandDescription(cmd: Command): string;
222
+ /** Get the option term to show in the list of options. */
223
+ optionTerm(option: Option): string;
224
+ /** Get the option description to show in the list of options. */
225
+ optionDescription(option: Option): string;
226
+ /** Get the argument term to show in the list of arguments. */
227
+ argumentTerm(argument: Argument): string;
228
+ /** Get the argument description to show in the list of arguments. */
229
+ argumentDescription(argument: Argument): string;
230
+
231
+ /** Get the command usage to be displayed at the top of the built-in help. */
232
+ commandUsage(cmd: Command): string;
233
+ /** Get the description for the command. */
234
+ commandDescription(cmd: Command): string;
235
+
236
+ /** Get an array of the visible subcommands. Includes a placeholder for the implicit help command, if there is one. */
237
+ visibleCommands(cmd: Command): Command[];
238
+ /** Get an array of the visible options. Includes a placeholder for the implicit help option, if there is one. */
239
+ visibleOptions(cmd: Command): Option[];
240
+ /** Get an array of the visible global options. (Not including help.) */
241
+ visibleGlobalOptions(cmd: Command): Option[];
242
+ /** Get an array of the arguments which have descriptions. */
243
+ visibleArguments(cmd: Command): Argument[];
244
+
245
+ /** Get the longest command term length. */
246
+ longestSubcommandTermLength(cmd: Command, helper: Help): number;
247
+ /** Get the longest option term length. */
248
+ longestOptionTermLength(cmd: Command, helper: Help): number;
249
+ /** Get the longest global option term length. */
250
+ longestGlobalOptionTermLength(cmd: Command, helper: Help): number;
251
+ /** Get the longest argument term length. */
252
+ longestArgumentTermLength(cmd: Command, helper: Help): number;
253
+ /** Calculate the pad width from the maximum term length. */
254
+ padWidth(cmd: Command, helper: Help): number;
255
+
256
+ /**
257
+ * Wrap the given string to width characters per line, with lines after the first indented.
258
+ * Do not wrap if insufficient room for wrapping (minColumnWidth), or string is manually formatted.
259
+ */
260
+ wrap(str: string, width: number, indent: number, minColumnWidth?: number): string;
261
+
262
+ /** Generate the built-in help text. */
263
+ formatHelp(cmd: Command, helper: Help): string;
264
+ }
265
+ export type HelpConfiguration = Partial<Help>;
266
+
267
+ export interface ParseOptions {
268
+ from: 'node' | 'electron' | 'user';
269
+ }
270
+ export interface HelpContext { // optional parameter for .help() and .outputHelp()
271
+ error: boolean;
272
+ }
273
+ export interface AddHelpTextContext { // passed to text function used with .addHelpText()
274
+ error: boolean;
275
+ command: Command;
276
+ }
277
+ export interface OutputConfiguration {
278
+ writeOut?(str: string): void;
279
+ writeErr?(str: string): void;
280
+ getOutHelpWidth?(): number;
281
+ getErrHelpWidth?(): number;
282
+ outputError?(str: string, write: (str: string) => void): void;
283
+
284
+ }
285
+
286
+ export type AddHelpTextPosition = 'beforeAll' | 'before' | 'after' | 'afterAll';
287
+ export type HookEvent = 'preSubcommand' | 'preAction' | 'postAction';
288
+ // The source is a string so author can define their own too.
289
+ export type OptionValueSource = LiteralUnion<'default' | 'config' | 'env' | 'cli' | 'implied', string> | undefined;
290
+
291
+ export type OptionValues = Record<string, any>;
292
+
293
+ export class Command {
294
+ args: string[];
295
+ processedArgs: any[];
296
+ readonly commands: readonly Command[];
297
+ readonly options: readonly Option[];
298
+ readonly registeredArguments: readonly Argument[];
299
+ parent: Command | null;
300
+
301
+ constructor(name?: string);
302
+
303
+ /**
304
+ * Set the program version to `str`.
305
+ *
306
+ * This method auto-registers the "-V, --version" flag
307
+ * which will print the version number when passed.
308
+ *
309
+ * You can optionally supply the flags and description to override the defaults.
310
+ */
311
+ version(str: string, flags?: string, description?: string): this;
312
+ /**
313
+ * Get the program version.
314
+ */
315
+ version(): string | undefined;
316
+
317
+ /**
318
+ * Define a command, implemented using an action handler.
319
+ *
320
+ * @remarks
321
+ * The command description is supplied using `.description`, not as a parameter to `.command`.
322
+ *
323
+ * @example
324
+ * ```ts
325
+ * program
326
+ * .command('clone <source> [destination]')
327
+ * .description('clone a repository into a newly created directory')
328
+ * .action((source, destination) => {
329
+ * console.log('clone command called');
330
+ * });
331
+ * ```
332
+ *
333
+ * @param nameAndArgs - command name and arguments, args are `<required>` or `[optional]` and last may also be `variadic...`
334
+ * @param opts - configuration options
335
+ * @returns new command
336
+ */
337
+ command(nameAndArgs: string, opts?: CommandOptions): ReturnType<this['createCommand']>;
338
+ /**
339
+ * Define a command, implemented in a separate executable file.
340
+ *
341
+ * @remarks
342
+ * The command description is supplied as the second parameter to `.command`.
343
+ *
344
+ * @example
345
+ * ```ts
346
+ * program
347
+ * .command('start <service>', 'start named service')
348
+ * .command('stop [service]', 'stop named service, or all if no name supplied');
349
+ * ```
350
+ *
351
+ * @param nameAndArgs - command name and arguments, args are `<required>` or `[optional]` and last may also be `variadic...`
352
+ * @param description - description of executable command
353
+ * @param opts - configuration options
354
+ * @returns `this` command for chaining
355
+ */
356
+ command(nameAndArgs: string, description: string, opts?: ExecutableCommandOptions): this;
357
+
358
+ /**
359
+ * Factory routine to create a new unattached command.
360
+ *
361
+ * See .command() for creating an attached subcommand, which uses this routine to
362
+ * create the command. You can override createCommand to customise subcommands.
363
+ */
364
+ createCommand(name?: string): Command;
365
+
366
+ /**
367
+ * Add a prepared subcommand.
368
+ *
369
+ * See .command() for creating an attached subcommand which inherits settings from its parent.
370
+ *
371
+ * @returns `this` command for chaining
372
+ */
373
+ addCommand(cmd: Command, opts?: CommandOptions): this;
374
+
375
+ /**
376
+ * Factory routine to create a new unattached argument.
377
+ *
378
+ * See .argument() for creating an attached argument, which uses this routine to
379
+ * create the argument. You can override createArgument to return a custom argument.
380
+ */
381
+ createArgument(name: string, description?: string): Argument;
382
+
383
+ /**
384
+ * Define argument syntax for command.
385
+ *
386
+ * The default is that the argument is required, and you can explicitly
387
+ * indicate this with <> around the name. Put [] around the name for an optional argument.
388
+ *
389
+ * @example
390
+ * ```
391
+ * program.argument('<input-file>');
392
+ * program.argument('[output-file]');
393
+ * ```
394
+ *
395
+ * @returns `this` command for chaining
396
+ */
397
+ argument<T>(flags: string, description: string, fn: (value: string, previous: T) => T, defaultValue?: T): this;
398
+ argument(name: string, description?: string, defaultValue?: unknown): this;
399
+
400
+ /**
401
+ * Define argument syntax for command, adding a prepared argument.
402
+ *
403
+ * @returns `this` command for chaining
404
+ */
405
+ addArgument(arg: Argument): this;
406
+
407
+ /**
408
+ * Define argument syntax for command, adding multiple at once (without descriptions).
409
+ *
410
+ * See also .argument().
411
+ *
412
+ * @example
413
+ * ```
414
+ * program.arguments('<cmd> [env]');
415
+ * ```
416
+ *
417
+ * @returns `this` command for chaining
418
+ */
419
+ arguments(names: string): this;
420
+
421
+ /**
422
+ * Override default decision whether to add implicit help command.
423
+ *
424
+ * @example
425
+ * ```
426
+ * addHelpCommand() // force on
427
+ * addHelpCommand(false); // force off
428
+ * addHelpCommand('help [cmd]', 'display help for [cmd]'); // force on with custom details
429
+ * ```
430
+ *
431
+ * @returns `this` command for chaining
432
+ */
433
+ addHelpCommand(enableOrNameAndArgs?: string | boolean, description?: string): this;
434
+
435
+ /**
436
+ * Add hook for life cycle event.
437
+ */
438
+ hook(event: HookEvent, listener: (thisCommand: Command, actionCommand: Command) => void | Promise<void>): this;
439
+
440
+ /**
441
+ * Register callback to use as replacement for calling process.exit.
442
+ */
443
+ exitOverride(callback?: (err: CommanderError) => never | void): this;
444
+
445
+ /**
446
+ * Display error message and exit (or call exitOverride).
447
+ */
448
+ error(message: string, errorOptions?: ErrorOptions): never;
449
+
450
+ /**
451
+ * You can customise the help with a subclass of Help by overriding createHelp,
452
+ * or by overriding Help properties using configureHelp().
453
+ */
454
+ createHelp(): Help;
455
+
456
+ /**
457
+ * You can customise the help by overriding Help properties using configureHelp(),
458
+ * or with a subclass of Help by overriding createHelp().
459
+ */
460
+ configureHelp(configuration: HelpConfiguration): this;
461
+ /** Get configuration */
462
+ configureHelp(): HelpConfiguration;
463
+
464
+ /**
465
+ * The default output goes to stdout and stderr. You can customise this for special
466
+ * applications. You can also customise the display of errors by overriding outputError.
467
+ *
468
+ * The configuration properties are all functions:
469
+ * ```
470
+ * // functions to change where being written, stdout and stderr
471
+ * writeOut(str)
472
+ * writeErr(str)
473
+ * // matching functions to specify width for wrapping help
474
+ * getOutHelpWidth()
475
+ * getErrHelpWidth()
476
+ * // functions based on what is being written out
477
+ * outputError(str, write) // used for displaying errors, and not used for displaying help
478
+ * ```
479
+ */
480
+ configureOutput(configuration: OutputConfiguration): this;
481
+ /** Get configuration */
482
+ configureOutput(): OutputConfiguration;
483
+
484
+ /**
485
+ * Copy settings that are useful to have in common across root command and subcommands.
486
+ *
487
+ * (Used internally when adding a command using `.command()` so subcommands inherit parent settings.)
488
+ */
489
+ copyInheritedSettings(sourceCommand: Command): this;
490
+
491
+ /**
492
+ * Display the help or a custom message after an error occurs.
493
+ */
494
+ showHelpAfterError(displayHelp?: boolean | string): this;
495
+
496
+ /**
497
+ * Display suggestion of similar commands for unknown commands, or options for unknown options.
498
+ */
499
+ showSuggestionAfterError(displaySuggestion?: boolean): this;
500
+
501
+ /**
502
+ * Register callback `fn` for the command.
503
+ *
504
+ * @example
505
+ * ```
506
+ * program
507
+ * .command('serve')
508
+ * .description('start service')
509
+ * .action(function() {
510
+ * // do work here
511
+ * });
512
+ * ```
513
+ *
514
+ * @returns `this` command for chaining
515
+ */
516
+ action(fn: (...args: any[]) => void | Promise<void>): this;
517
+
518
+ /**
519
+ * Define option with `flags`, `description`, and optional argument parsing function or `defaultValue` or both.
520
+ *
521
+ * The `flags` string contains the short and/or long flags, separated by comma, a pipe or space. A required
522
+ * option-argument is indicated by `<>` and an optional option-argument by `[]`.
523
+ *
524
+ * See the README for more details, and see also addOption() and requiredOption().
525
+ *
526
+ * @example
527
+ *
528
+ * ```js
529
+ * program
530
+ * .option('-p, --pepper', 'add pepper')
531
+ * .option('-p, --pizza-type <TYPE>', 'type of pizza') // required option-argument
532
+ * .option('-c, --cheese [CHEESE]', 'add extra cheese', 'mozzarella') // optional option-argument with default
533
+ * .option('-t, --tip <VALUE>', 'add tip to purchase cost', parseFloat) // custom parse function
534
+ * ```
535
+ *
536
+ * @returns `this` command for chaining
537
+ */
538
+ option(flags: string, description?: string, defaultValue?: string | boolean | string[]): this;
539
+ option<T>(flags: string, description: string, parseArg: (value: string, previous: T) => T, defaultValue?: T): this;
540
+ /** @deprecated since v7, instead use choices or a custom function */
541
+ option(flags: string, description: string, regexp: RegExp, defaultValue?: string | boolean | string[]): this;
542
+
543
+ /**
544
+ * Define a required option, which must have a value after parsing. This usually means
545
+ * the option must be specified on the command line. (Otherwise the same as .option().)
546
+ *
547
+ * The `flags` string contains the short and/or long flags, separated by comma, a pipe or space.
548
+ */
549
+ requiredOption(flags: string, description?: string, defaultValue?: string | boolean | string[]): this;
550
+ requiredOption<T>(flags: string, description: string, parseArg: (value: string, previous: T) => T, defaultValue?: T): this;
551
+ /** @deprecated since v7, instead use choices or a custom function */
552
+ requiredOption(flags: string, description: string, regexp: RegExp, defaultValue?: string | boolean | string[]): this;
553
+
554
+ /**
555
+ * Factory routine to create a new unattached option.
556
+ *
557
+ * See .option() for creating an attached option, which uses this routine to
558
+ * create the option. You can override createOption to return a custom option.
559
+ */
560
+
561
+ createOption(flags: string, description?: string): Option;
562
+
563
+ /**
564
+ * Add a prepared Option.
565
+ *
566
+ * See .option() and .requiredOption() for creating and attaching an option in a single call.
567
+ */
568
+ addOption(option: Option): this;
569
+
570
+ /**
571
+ * Whether to store option values as properties on command object,
572
+ * or store separately (specify false). In both cases the option values can be accessed using .opts().
573
+ *
574
+ * @returns `this` command for chaining
575
+ */
576
+ storeOptionsAsProperties<T extends OptionValues>(): this & T;
577
+ storeOptionsAsProperties<T extends OptionValues>(storeAsProperties: true): this & T;
578
+ storeOptionsAsProperties(storeAsProperties?: boolean): this;
579
+
580
+ /**
581
+ * Retrieve option value.
582
+ */
583
+ getOptionValue(key: string): any;
584
+
585
+ /**
586
+ * Store option value.
587
+ */
588
+ setOptionValue(key: string, value: unknown): this;
589
+
590
+ /**
591
+ * Store option value and where the value came from.
592
+ */
593
+ setOptionValueWithSource(key: string, value: unknown, source: OptionValueSource): this;
594
+
595
+ /**
596
+ * Get source of option value.
597
+ */
598
+ getOptionValueSource(key: string): OptionValueSource | undefined;
599
+
600
+ /**
601
+ * Get source of option value. See also .optsWithGlobals().
602
+ */
603
+ getOptionValueSourceWithGlobals(key: string): OptionValueSource | undefined;
604
+
605
+ /**
606
+ * Alter parsing of short flags with optional values.
607
+ *
608
+ * @example
609
+ * ```
610
+ * // for `.option('-f,--flag [value]'):
611
+ * .combineFlagAndOptionalValue(true) // `-f80` is treated like `--flag=80`, this is the default behaviour
612
+ * .combineFlagAndOptionalValue(false) // `-fb` is treated like `-f -b`
613
+ * ```
614
+ *
615
+ * @returns `this` command for chaining
616
+ */
617
+ combineFlagAndOptionalValue(combine?: boolean): this;
618
+
619
+ /**
620
+ * Allow unknown options on the command line.
621
+ *
622
+ * @returns `this` command for chaining
623
+ */
624
+ allowUnknownOption(allowUnknown?: boolean): this;
625
+
626
+ /**
627
+ * Allow excess command-arguments on the command line. Pass false to make excess arguments an error.
628
+ *
629
+ * @returns `this` command for chaining
630
+ */
631
+ allowExcessArguments(allowExcess?: boolean): this;
632
+
633
+ /**
634
+ * Enable positional options. Positional means global options are specified before subcommands which lets
635
+ * subcommands reuse the same option names, and also enables subcommands to turn on passThroughOptions.
636
+ *
637
+ * The default behaviour is non-positional and global options may appear anywhere on the command line.
638
+ *
639
+ * @returns `this` command for chaining
640
+ */
641
+ enablePositionalOptions(positional?: boolean): this;
642
+
643
+ /**
644
+ * Pass through options that come after command-arguments rather than treat them as command-options,
645
+ * so actual command-options come before command-arguments. Turning this on for a subcommand requires
646
+ * positional options to have been enabled on the program (parent commands).
647
+ *
648
+ * The default behaviour is non-positional and options may appear before or after command-arguments.
649
+ *
650
+ * @returns `this` command for chaining
651
+ */
652
+ passThroughOptions(passThrough?: boolean): this;
653
+
654
+ /**
655
+ * Parse `argv`, setting options and invoking commands when defined.
656
+ *
657
+ * The default expectation is that the arguments are from node and have the application as argv[0]
658
+ * and the script being run in argv[1], with user parameters after that.
659
+ *
660
+ * @example
661
+ * ```
662
+ * program.parse(process.argv);
663
+ * program.parse(); // implicitly use process.argv and auto-detect node vs electron conventions
664
+ * program.parse(my-args, { from: 'user' }); // just user supplied arguments, nothing special about argv[0]
665
+ * ```
666
+ *
667
+ * @returns `this` command for chaining
668
+ */
669
+ parse(argv?: readonly string[], options?: ParseOptions): this;
670
+
671
+ /**
672
+ * Parse `argv`, setting options and invoking commands when defined.
673
+ *
674
+ * Use parseAsync instead of parse if any of your action handlers are async. Returns a Promise.
675
+ *
676
+ * The default expectation is that the arguments are from node and have the application as argv[0]
677
+ * and the script being run in argv[1], with user parameters after that.
678
+ *
679
+ * @example
680
+ * ```
681
+ * program.parseAsync(process.argv);
682
+ * program.parseAsync(); // implicitly use process.argv and auto-detect node vs electron conventions
683
+ * program.parseAsync(my-args, { from: 'user' }); // just user supplied arguments, nothing special about argv[0]
684
+ * ```
685
+ *
686
+ * @returns Promise
687
+ */
688
+ parseAsync(argv?: readonly string[], options?: ParseOptions): Promise<this>;
689
+
690
+ /**
691
+ * Parse options from `argv` removing known options,
692
+ * and return argv split into operands and unknown arguments.
693
+ *
694
+ * argv => operands, unknown
695
+ * --known kkk op => [op], []
696
+ * op --known kkk => [op], []
697
+ * sub --unknown uuu op => [sub], [--unknown uuu op]
698
+ * sub -- --unknown uuu op => [sub --unknown uuu op], []
699
+ */
700
+ parseOptions(argv: string[]): ParseOptionsResult;
701
+
702
+ /**
703
+ * Return an object containing local option values as key-value pairs
704
+ */
705
+ opts<T extends OptionValues>(): T;
706
+
707
+ /**
708
+ * Return an object containing merged local and global option values as key-value pairs.
709
+ */
710
+ optsWithGlobals<T extends OptionValues>(): T;
711
+
712
+ /**
713
+ * Set the description.
714
+ *
715
+ * @returns `this` command for chaining
716
+ */
717
+
718
+ description(str: string): this;
719
+ /** @deprecated since v8, instead use .argument to add command argument with description */
720
+ description(str: string, argsDescription: Record<string, string>): this;
721
+ /**
722
+ * Get the description.
723
+ */
724
+ description(): string;
725
+
726
+ /**
727
+ * Set the summary. Used when listed as subcommand of parent.
728
+ *
729
+ * @returns `this` command for chaining
730
+ */
731
+
732
+ summary(str: string): this;
733
+ /**
734
+ * Get the summary.
735
+ */
736
+ summary(): string;
737
+
738
+ /**
739
+ * Set an alias for the command.
740
+ *
741
+ * You may call more than once to add multiple aliases. Only the first alias is shown in the auto-generated help.
742
+ *
743
+ * @returns `this` command for chaining
744
+ */
745
+ alias(alias: string): this;
746
+ /**
747
+ * Get alias for the command.
748
+ */
749
+ alias(): string;
750
+
751
+ /**
752
+ * Set aliases for the command.
753
+ *
754
+ * Only the first alias is shown in the auto-generated help.
755
+ *
756
+ * @returns `this` command for chaining
757
+ */
758
+ aliases(aliases: readonly string[]): this;
759
+ /**
760
+ * Get aliases for the command.
761
+ */
762
+ aliases(): string[];
763
+
764
+ /**
765
+ * Set the command usage.
766
+ *
767
+ * @returns `this` command for chaining
768
+ */
769
+ usage(str: string): this;
770
+ /**
771
+ * Get the command usage.
772
+ */
773
+ usage(): string;
774
+
775
+ /**
776
+ * Set the name of the command.
777
+ *
778
+ * @returns `this` command for chaining
779
+ */
780
+ name(str: string): this;
781
+ /**
782
+ * Get the name of the command.
783
+ */
784
+ name(): string;
785
+
786
+ /**
787
+ * Set the name of the command from script filename, such as process.argv[1],
788
+ * or require.main.filename, or __filename.
789
+ *
790
+ * (Used internally and public although not documented in README.)
791
+ *
792
+ * @example
793
+ * ```ts
794
+ * program.nameFromFilename(require.main.filename);
795
+ * ```
796
+ *
797
+ * @returns `this` command for chaining
798
+ */
799
+ nameFromFilename(filename: string): this;
800
+
801
+ /**
802
+ * Set the directory for searching for executable subcommands of this command.
803
+ *
804
+ * @example
805
+ * ```ts
806
+ * program.executableDir(__dirname);
807
+ * // or
808
+ * program.executableDir('subcommands');
809
+ * ```
810
+ *
811
+ * @returns `this` command for chaining
812
+ */
813
+ executableDir(path: string): this;
814
+ /**
815
+ * Get the executable search directory.
816
+ */
817
+ executableDir(): string | null;
818
+
819
+ /**
820
+ * Output help information for this command.
821
+ *
822
+ * Outputs built-in help, and custom text added using `.addHelpText()`.
823
+ *
824
+ */
825
+ outputHelp(context?: HelpContext): void;
826
+ /** @deprecated since v7 */
827
+ outputHelp(cb?: (str: string) => string): void;
828
+
829
+ /**
830
+ * Return command help documentation.
831
+ */
832
+ helpInformation(context?: HelpContext): string;
833
+
834
+ /**
835
+ * You can pass in flags and a description to override the help
836
+ * flags and help description for your command. Pass in false
837
+ * to disable the built-in help option.
838
+ */
839
+ helpOption(flags?: string | boolean, description?: string): this;
840
+
841
+ /**
842
+ * Output help information and exit.
843
+ *
844
+ * Outputs built-in help, and custom text added using `.addHelpText()`.
845
+ */
846
+ help(context?: HelpContext): never;
847
+ /** @deprecated since v7 */
848
+ help(cb?: (str: string) => string): never;
849
+
850
+ /**
851
+ * Add additional text to be displayed with the built-in help.
852
+ *
853
+ * Position is 'before' or 'after' to affect just this command,
854
+ * and 'beforeAll' or 'afterAll' to affect this command and all its subcommands.
855
+ */
856
+ addHelpText(position: AddHelpTextPosition, text: string): this;
857
+ addHelpText(position: AddHelpTextPosition, text: (context: AddHelpTextContext) => string): this;
858
+
859
+ /**
860
+ * Add a listener (callback) for when events occur. (Implemented using EventEmitter.)
861
+ */
862
+ on(event: string | symbol, listener: (...args: any[]) => void): this;
863
+ }
864
+
865
+ export interface CommandOptions {
866
+ hidden?: boolean;
867
+ isDefault?: boolean;
868
+ /** @deprecated since v7, replaced by hidden */
869
+ noHelp?: boolean;
870
+ }
871
+ export interface ExecutableCommandOptions extends CommandOptions {
872
+ executableFile?: string;
873
+ }
874
+
875
+ export interface ParseOptionsResult {
876
+ operands: string[];
877
+ unknown: string[];
878
+ }
879
+
880
+ export function createCommand(name?: string): Command;
881
+ export function createOption(flags: string, description?: string): Option;
882
+ export function createArgument(name: string, description?: string): Argument;
883
+
884
+ export const program: Command;