@shell-shock/core 0.16.2 → 0.17.1

package/dist/components/state-builtin.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"state-builtin.mjs","names":[],"sources":["../../src/components/state-builtin.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                  ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/shell-shock\n Documentation:            https://docs.stormsoftware.com/projects/shell-shock\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { code, computed, For, Show, splitProps } from \"@alloy-js/core\";\nimport {\n  FunctionDeclaration,\n  InterfaceDeclaration,\n  InterfaceMember,\n  TypeDeclaration,\n  VarDeclaration\n} from \"@alloy-js/typescript\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components/spacing\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport type { BuiltinFileProps } from \"@powerlines/plugin-alloy/typescript/components/builtin-file\";\nimport { BuiltinFile } from \"@powerlines/plugin-alloy/typescript/components/builtin-file\";\nimport {\n  TSDoc,\n  TSDocInternal,\n  TSDocLink,\n  TSDocParam,\n  TSDocRemarks,\n  TSDocReturns\n} from \"@powerlines/plugin-alloy/typescript/components/tsdoc\";\nimport defu from \"defu\";\nimport { computedOptions } from \"../contexts/options\";\nimport { getAppBin } from \"../plugin-utils\";\nimport { getAppTitle } from \"../plugin-utils/context-helpers\";\nimport type { Context } from \"../types\";\nimport { OptionsMember } from \"./options-parser-logic\";\n\nexport function GlobalTypeDefinitions() {\n  const context = usePowerlines<Context>();\n\n  const options = computed(() => computedOptions(context.options));\n\n  return (\n    <>\n      <TSDoc\n        heading={`An object representing the global options available for every command in the ${getAppTitle(\n          context,\n          true\n        )} command-line application.`}\n      />\n      <InterfaceDeclaration export name=\"GlobalOptions\">\n        <For each={Object.values(options.value)} hardline>\n          {option => <OptionsMember option={option} />}\n        </For>\n      </InterfaceDeclaration>\n      <Spacing />\n      <TSDoc heading=\"The context object for the current command execution, containing the command path and segments.\" />\n      <InterfaceDeclaration\n        export\n        name=\"CommandContext\"\n        typeParameters={[\n          {\n            name: \"THandler\",\n            extends: \"(...params: any[]) => any\",\n            default: \"any\"\n          }\n        ]}>\n        <TSDoc\n          heading={`The full command path as a string. For example, if the user runs \\`${getAppBin(\n            context\n          )} foo bar\\`, this would be \\`foo bar\\`. This is useful for commands that need to know their full invocation path, such as for help text or for commands that have dynamic behavior based on their position in the command hierarchy.`}\n        />\n        <InterfaceMember name=\"path\" type=\"string\" />\n        <Spacing />\n        <TSDoc\n          heading={`An array of command path segments. For example, if the user runs \\`${getAppBin(\n            context\n          )} foo bar\\`, this would be \\`[\"foo\", \"bar\"]\\`. This is useful for commands that need to know their individual path segments, such as for dynamic routing or for commands that have behavior based on specific segments in the command hierarchy.`}\n        />\n        <InterfaceMember name=\"segments\" type=\"string[]\" />\n        <Spacing />\n        <TSDoc\n          heading={`The parameters for the current command's handler function.`}\n        />\n        <InterfaceMember name=\"params\" type=\"Parameters<THandler>\" />\n      </InterfaceDeclaration>\n      <Spacing />\n      <TypeDeclaration export name=\"GlobalContextStatus\">\n        {code`\"initializing\" | \"preparing\" | \"executing\" | \"completed\"`}\n      </TypeDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`The state object for the ${getAppTitle(context)} application context.`}\n      />\n      <InterfaceDeclaration export name=\"GlobalContextState\">\n        <TSDoc heading=\"The unique identifier for the current execution context.\" />\n        <InterfaceMember name=\"executionId\" type=\"string\" />\n        <Spacing />\n        <TSDoc heading=\"The status of the current execution context.\" />\n        <InterfaceMember name=\"status\" type=\"GlobalContextStatus\" />\n        <Spacing />\n        <TSDoc heading=\"Indicates whether the current execution context has encountered an error.\" />\n        <InterfaceMember name=\"isError\" type=\"boolean\" />\n        <Spacing />\n        <TSDoc heading=\"A map containing arbitrary data associated with the current execution context.\" />\n        <InterfaceMember name=\"meta\" type=\"Map<string, unknown>\" />\n      </InterfaceDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`The context object for the ${getAppTitle(context)} application.`}\n      />\n      <InterfaceDeclaration export name=\"GlobalContext\">\n        <TSDoc heading=\"The global options shared across all commands in the application.\" />\n        <InterfaceMember name=\"options\" type=\"GlobalOptions\" />\n        <Spacing />\n        <TSDoc heading=\"The raw command-line arguments passed to the application.\" />\n        <InterfaceMember name=\"inputArgs\" type=\"string[]\" />\n        <Spacing />\n        <TSDoc heading=\"The state of the current execution context.\" />\n        <InterfaceMember name=\"state\" type=\"GlobalContextState\" />\n      </InterfaceDeclaration>\n    </>\n  );\n}\n\n/**\n * Generates utilities for detecting terminal color support.\n */\nexport function ArgsUtilities() {\n  return (\n    <>\n      <TSDoc heading=\"Retrieves the command-line arguments from Deno or Node.js environments.\">\n        <TSDocRemarks>\n          {`This function is only intended for internal use. Please use \\`useArgs()\\` instead.`}\n        </TSDocRemarks>\n        <Spacing />\n        <TSDocInternal />\n        <Spacing />\n        <TSDocReturns>\n          {`An array of command-line arguments from Deno or Node.js environments.`}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration name=\"getInputArgs\" returnType=\"string[]\">\n        {code`return ((globalThis as { Deno?: { args: string[] } })?.Deno?.args ?? process.argv ?? []) as string[];`}\n      </FunctionDeclaration>\n    </>\n  );\n}\n\nexport function ContextUtilities() {\n  const context = usePowerlines<Context>();\n\n  return (\n    <>\n      <Spacing />\n\n      <TSDoc\n        heading={`The global ${getAppTitle(context)} application context store instance.`}>\n        <TSDocInternal />\n      </TSDoc>\n      <VarDeclaration export const name=\"unstable_globalStore\">\n        {code`  new AsyncLocalStorage<GlobalContext>({ name: \"globalStore\" }); `}\n      </VarDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`Get the ${getAppTitle(\n          context\n        )} application context for the current application.`}>\n        <TSDocParam name=\"options\">\n          {`The options to use when getting the context. This can include parameters for how to handle missing contexts, such as whether to throw an error or return undefined. By default, if the context is not available, this function will return undefined.`}\n        </TSDocParam>\n        <TSDocReturns>\n          {`The ${getAppTitle(\n            context\n          )} application context for the current application or undefined if the context is not available.`}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration export name=\"useGlobal\" returnType=\"GlobalContext\">\n        {code`return unstable_globalStore.getStore() as GlobalContext;`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`A utility hook function to get the command-line arguments from the ${getAppTitle(\n          context\n        )} application context.`}>\n        <TSDocReturns>\n          {\"An array of command-line arguments from the application context.\"}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration export name=\"useArgs\" returnType=\"string[]\">\n        {code`return useGlobal()?.inputArgs ?? getInputArgs();`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`A utility hook function to get the state of the ${getAppTitle(\n          context\n        )} application context.`}>\n        <TSDocReturns>{\"The state of the application context.\"}</TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration\n        export\n        name=\"useState\"\n        returnType=\"GlobalContextState\">\n        {code`return useGlobal()?.state;`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`A utility function to update the state of the ${getAppTitle(\n          context\n        )} application context.`}>\n        <TSDocRemarks>\n          {`This function will throw an error if the global context is not available, so it should only be used within a valid context scope, such as within a command handler or within the \\`withGlobal()\\` function.`}\n        </TSDocRemarks>\n        <Spacing />\n        <TSDocParam name=\"update\">\n          {`The new state or a function that receives the previous state and returns the new state. This allows for both direct state updates and functional updates based on the previous state.`}\n        </TSDocParam>\n      </TSDoc>\n      <FunctionDeclaration\n        export\n        name=\"setState\"\n        parameters={[\n          {\n            name: \"update\",\n            type: \"Partial<GlobalContextState> | ((prev: GlobalContextState) => GlobalContextState)\"\n          }\n        ]}>\n        {code`const prev = useGlobal()?.state;\n        if (!prev) {\n          throw new Error(\n            \\`The ${getAppTitle(\n              context\n            )} application context is not available. Make sure to call setState() within a valid context scope.\\`\n          );\n        }\n\n        useGlobal().state = typeof update === \"function\" ? update(prev) : { ...prev, ...update }; `}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`A utility hook function to get the execution ID of the ${getAppTitle(\n          context\n        )} application context.`}>\n        <TSDocReturns>\n          {\"The execution ID of the application context.\"}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration export name=\"useExecutionId\" returnType=\"string\">\n        {code`return useState().executionId;`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`A utility hook function to get the metadata of the ${getAppTitle(\n          context\n        )} application context.`}>\n        <TSDocReturns>\n          {\"The metadata of the application context.\"}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration\n        export\n        name=\"useMeta\"\n        returnType=\"Map<string, unknown>\">\n        {code`return useState().meta;`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`A utility hook function to get the current status of the ${getAppTitle(\n          context\n        )} application.`}>\n        <TSDocReturns>{\"The current status of the application.\"}</TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration\n        export\n        name=\"useStatus\"\n        returnType=\"GlobalContextStatus\">\n        {code`return useState().status;`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`The global ${getAppTitle(context)} - command context store instance.`}>\n        <TSDocInternal />\n      </TSDoc>\n      <VarDeclaration export name=\"unstable_commandStore\">\n        {code`new AsyncLocalStorage<CommandContext>({ name: \"commandStore\" });`}\n      </VarDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`Get the ${getAppTitle(context)} - command context for the current application.`}>\n        <TSDocReturns>\n          {`The ${getAppTitle(context)} - command context for the current application.`}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration export name=\"useCommand\" returnType=\"CommandContext\">\n        {code`const result = unstable_commandStore.getStore();\nif (!result) {\n  throw new Error(\n    \\`The ${getAppTitle(context)} - command context is not available. Make sure to call useCommand() within a valid context scope.\\`\n  );\n}\nreturn result;`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc heading=\"A utility hook function to get the individual segments of the current command path.\">\n        <TSDocReturns>{\"An array of command path segments.\"}</TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration export name=\"useSegments\" returnType=\"string[]\">\n        {code`return useCommand().segments;`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc heading=\"A utility hook function to get the full command path as a string.\">\n        <TSDocReturns>\n          {`The full command path as a string. For example, if the user runs \\`${getAppBin(\n            context\n          )} foo bar\\`, this would return \\`\"foo bar\"\\`. This is useful for commands that need to know their full invocation path, such as for help text or for commands that have dynamic behavior based on their position in the command hierarchy.`}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration export name=\"usePath\" returnType=\"string\">\n        {code`return useCommand().path;`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc heading=\"Checks if a specific flag is present in the command-line arguments.\">\n        <TSDocLink>\n          {\"https://github.com/sindresorhus/has-flag/blob/main/index.js\"}\n        </TSDocLink>\n        <TSDocParam name=\"flag\">\n          {\n            'The flag (or an array of flags/aliases) to check for, e.g., \"color\", \"no-color\".'\n          }\n        </TSDocParam>\n        <TSDocParam name=\"argv\">\n          {\n            \"The command-line arguments to check against. Defaults to global Deno args or process args.\"\n          }\n        </TSDocParam>\n        <TSDocReturns>\n          {\"True if the flag is present, false otherwise.\"}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration\n        export\n        name=\"hasFlag\"\n        parameters={[\n          { name: \"flag\", type: \"string | string[]\" },\n          {\n            name: \"argv\",\n            type: \"string[]\",\n            default: \"useArgs()\"\n          }\n        ]}>\n        <VarDeclaration\n          const\n          name=\"position\"\n          type=\"number\"\n          initializer={code`(Array.isArray(flag) ? flag : [flag]).reduce((ret, f) => {\n            const pos = argv.findIndex(arg => (f.startsWith(\"-\") ? \"\" : (f.length === 1 ? \"-\" : \"--\") + f)?.toLowerCase() === arg?.toLowerCase() || arg?.toLowerCase().startsWith((f.length === 1 ? \"-\" : \"--\") + f + \"=\"));\n            return pos !== -1 ? pos : ret;\n          }, -1);`}\n        />\n        <hbr />\n        {code`return position !== -1 && argv.indexOf(\"--\") === -1 || position < argv.indexOf(\"--\");`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc heading=\"A utility function to determine if the help flag is present or if the command is in an error state during preparation.\">\n        <TSDocReturns>\n          {`True if the help flag is present or if the command is in an error state during preparation, false otherwise. This can be used to conditionally display help text or to alter command behavior when the user is likely seeking help.`}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration export name=\"isHelp\" returnType=\"boolean\">\n        {code`return !isCI && (hasFlag([\"help\", \"h\", \"?\"]) || (useStatus() === \"preparing\" && useState().isError)); `}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`A utility function to wrap the ${getAppTitle(\n          context\n        )} application within the global context scope.`}>\n        <TSDocParam name=\"handler\">\n          {`The callback function to run within the global context scope. This function will receive the global context as its argument, allowing it to access any properties or utilities defined on the context. The callback function can be asynchronous and can return a value or a promise.`}\n        </TSDocParam>\n        <TSDocReturns>\n          {`The result of the callback function, which can be a value or a promise that resolves to a value.`}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration\n        export\n        async\n        name=\"withGlobal\"\n        parameters={[{ name: \"handler\", type: \"() => any\" }]}\n        returnType=\"Promise<void>\">\n        {code`\n        return unstable_globalStore.run({ options: {} as unknown as GlobalOptions, inputArgs: getInputArgs(), state: { executionId: randomUUID(), status: \"initializing\", isError: false, meta: new Map() } as GlobalContextState }, handler);`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`A utility function to wrap a ${getAppTitle(\n          context\n        )} application command handler within the command context scope.`}>\n        <TSDocParam name=\"handler\">\n          {`The callback function to run within the command context scope. This function will receive the command context as its argument, allowing it to access any properties or utilities defined on the context. The callback function can be asynchronous and can return a value or a promise.`}\n        </TSDocParam>\n        <TSDocReturns>\n          {`The result of the callback function, which can be a value or a promise that resolves to a value.`}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration\n        export\n        async\n        name=\"withCommand\"\n        typeParameters={[\n          {\n            name: \"THandler\",\n            extends: \"(this: CommandContext, ...params: any[]) => any\",\n            default: \"(this: CommandContext, ...params: any[]) => any\"\n          }\n        ]}\n        parameters={[\n          { name: \"path\", type: \"string\" },\n          { name: \"segments\", type: \"string[]\" },\n          { name: \"params\", type: \"Parameters<THandler>\" },\n          { name: \"handler\", type: \"THandler\" }\n        ]}\n        returnType=\"Promise<{ error: string | Error | null }>\">\n        {code`setState({ status: \"preparing\", isError: false });\n\n        const ctx = { path, segments, params } as CommandContext<THandler>;\n        const result = await Promise.resolve(unstable_commandStore.run(ctx, Reflect.apply(handler, ctx, params)));\n        if (result instanceof Error || (typeof result === \"object\" && ((result as { error: unknown }).error instanceof Error || typeof (result as { error: unknown }).error === \"string\"))) {\n          setState({ status: \"completed\", isError: true });\n          return { error: result instanceof Error ? result : (result as { error: Error | string }).error };\n        }\n\n        setState({ status: \"completed\", isError: false });\n        return { error: null }; `}\n      </FunctionDeclaration>\n    </>\n  );\n}\n\nexport interface StateBuiltinProps extends Omit<\n  BuiltinFileProps,\n  \"id\" | \"description\"\n> {}\n\n/**\n * A built-in module for handling application state utilities in Shell Shock.\n */\nexport function StateBuiltin(props: StateBuiltinProps) {\n  const [{ children }, rest] = splitProps(props, [\"children\"]);\n\n  return (\n    <BuiltinFile\n      id=\"state\"\n      description=\"A module that provides context hooks and utilities for accessing the application state.\"\n      {...rest}\n      imports={defu(rest.imports ?? {}, {\n        \"node:async_hooks\": [\"AsyncLocalStorage\"],\n        \"node:crypto\": [\"randomUUID\"]\n      })}\n      builtinImports={defu(rest.builtinImports ?? {}, {\n        env: [\"isCI\"]\n      })}>\n      <GlobalTypeDefinitions />\n      <Spacing />\n      <ArgsUtilities />\n      <Spacing />\n      <ContextUtilities />\n      <Spacing />\n      <Show when={Boolean(children)}>{children}</Show>\n    </BuiltinFile>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;AAgCA,SAAe,wBAAA;CACb,MAAA,UAAS,eAAA;CACT,MAAA,UAAU,eAAA,gBAAA,QAAA,QAAA,CAAA;AACV,QAAA;EAAA,gBAAY,OAAA,EACZ,IAAA,UAAA;AACI,UAAG,gFAAoD,YAAA,SAAA,KAAA,CAAA;KAE7D,CAAA;EAAM,gBAAkB,sBAAqB;GAC7C,UAAS;GACT,MAAS;GACT,IAAO,WAAO;AACR,WAAG,gBAAsB,KAAE;;AAE1B,aAAS,OAAA,OAAA,QAAuB,MAAC;;;KAGhC,WAAU,WAAU,gBAAK,eAAwB,UAEhD,CAAA;KACJ,CAAA;;GAEF,CAAC;EAAE,gBAAe,SAAO,EAAA,CAAA;EAAA,gBAAwB,OAAQ,EACxD,SAAM,mGACP,CAAC;EAAE,gBAAI,sBAAA;GACN,UAAO;GACP,MAAG;GACH,gBAAG,CAAA;IACD,MAAM;IACN,SAAK;IACL,SAAO;IACR,CAAC;GACF,IAAG,WAAS;AACV,WAAO;KAAA,gBAAa,OAAQ,EAC3B,IAAA,UAAA;AACC,aAAA,sEAAA,UAAA,QAAA,CAAA;QAED,CAAC;KAAA,gBAAgB,iBAAA;MAChB,MAAE;MACF,MAAI;MACL,CAAC;KAAE,gBAAgB,SAAW,EAAE,CAAC;KAAE,gBAAM,OAAA,EACxC,IAAI,UAAU;AACZ,aAAA,sEAAA,UAAA,QAAA,CAAA;QAEH,CAAC;KAAC,gBAAA,iBAAA;MACD,MAAE;MACF,MAAI;MACL,CAAC;KAAE,gBAAkB,SAAS,EAAE,CAAC;KAAA,gBAAmB,OAAO,EAC1D,SAAC,8DACF,CAAC;KAAC,gBAAgB,iBAAkB;MACnC,MAAC;MACD,MAAC;MACF,CAAC;KAAC;;GAEN,CAAC;EAAE,gBAAkB,SAAK,EAAM,CAAA;EAAG,gBAAkB,iBAAiB;GACrE,UAAK;GACL,MAAK;GACL,UAAK,IAAS;GACf,CAAC;EAAE,gBAAG,SAAA,EAAA,CAAA;EAAA,gBAAA,OAAA,EACL,IAAI,UAAU;AACZ,UAAG,4BAAA,YAAA,QAAA,CAAA;KAEN,CAAC;EAAE,gBAAE,sBAAoB;GACxB,UAAU;GACV,MAAG;GACH,IAAI,WAAO;AACT,WAAE;KAAA,gBAAe,OAAA,EAChB,SAAS,4DACT,CAAA;KAAA,gBAAA,iBAAA;MACC,MAAA;MACD,MAAA;MACA,CAAA;KAAA,gBAAqB,SAAO,EAAI,CAAC;KAAC,gBAAmB,OAAA,EACpD,SAAO,gDACR,CAAC;KAAC,gBAAgB,iBAAmB;MACpC,MAAC;MACD,MAAM;MACP,CAAC;KAAC,gBAAgB,SAAY,EAAE,CAAA;KAAA,gBAAM,OAAsB,EAC3D,SAAS,6EACV,CAAC;KAAC,gBAAe,iBAAqB;MACrC,MAAC;MACD,MAAC;MACF,CAAC;KAAC,gBAAiB,SAAI,EAAA,CAAU;KAAC,gBAAe,OAAW,EAC3D,SAAC,kFACF,CAAC;KAAA,gBAAoB,iBAAA;MACrB,MAAO;MACP,MAAA;MACA,CAAC;KAAA;;GAEL,CAAC;EAAE,gBAAC,SAAqB,EAAO,CAAA;EAAA,gBAAoB,OAAA,EACnD,IAAI,UAAO;AACT,UAAG,8BAA+B,YAAM,QAAgB,CAAA;KAE3D,CAAC;EAAE,gBAAkB,sBAAqB;GACzC,UAAK;GACL,MAAK;GACL,IAAI,WAAO;AACT,WAAG;KAAA,gBAAsB,OAAO,EAC9B,SAAA,qEACF,CAAA;KAAA,gBAAA,iBAAA;MACH,MAAA;MACH,MAAA;;;8BAEE,SAAA,6DACC,CAAA;KAAA,gBAAwB,iBAAkB;MAC3C,MAAA;MACK,MAAA;MACL,CAAM;KAAC,gBAAA,SAAA,EAAA,CAAA;KAAA,gBAAA,OAAA,EACJ,SAAA,+CACE,CAAA;KAAA,gBAAe,iBAAsB;MACpC,MAAC;MACD,MAAI;MACL,CAAC;KAAC;;GAEN,CAAC;EAAC;;;;;AAML,SAAO,gBAAyB;AAC9B,QAAO,CAAA,gBAAc,OAAW;EAC9B,SAAI;EACJ,IAAE,WAAA;AACH,UAAA;IAAA,gBAAA,cAAA,EACH,UAAA;;;;oCAEO,UAAS,yEACT,CAAC;IAAA;;EAEN,CAAA,EAAA,gBAAO,qBAAA;EACL,MAAC;EACD,YAAY;;EAEb,CAAC,CAAC;;AAEL,SAAS,mBAAe;CACtB,MAAM,UAAK,eAAA;AACX,QAAK;EAAA,gBAAqB,SAAO,EAAI,CAAC;EAAC,gBAAA,OAAqB;GAC1D,IAAI,UAAQ;AACV,WAAE,cAAc,YAAA,QAAA,CAAA;;GAElB,IAAG,WAAA;AACD,WAAE,gBAAoB,eAAW,EAAA,CAAA;;GAEpC,CAAC;EAAE,gBAAiB,gBAAgB;GACnC,UAAK;GACL,SAAQ;GACR,MAAM;GACN,UAAK,IAAA;GACN,CAAC;EAAE,gBAAY,SAAW,EAAA,CAAA;EAAA,gBAAA,OAAA;GACzB,IAAI,UAAI;AACN,WAAO,WAAW,YAAY,QAAK,CAAA;;GAErC,IAAI,WAAK;AACP,WAAC,CAAA,gBAAoB,YAAa;KAChC,MAAM;KACN,UAAA;KACD,CAAA,EAAA,gBAAS,cAAA,EACT,IAAA,WAAA;AACC,YAAS,OAAG,YAAa,QAAW,CAAC;OAEtC,CAAC,CAAC;;GAEN,CAAC;EAAE,gBAAkB,qBAAa;GACjC,UAAM;GACN,MAAI;GACJ,YAAG;GACH,UAAU,IAAA;GACX,CAAC;EAAE,gBAAE,SAAmB,EAAA,CAAA;EAAA,gBAAA,OAAA;GACvB,IAAG,UAAS;AACV,WAAC,sEAAA,YAAA,QAAA,CAAA;;GAEH,IAAI,WAAE;AACJ,WAAK,gBAAoB,cAAE,EACzB,UAAC,oEACF,CAAC;;GAEL,CAAC;EAAE,gBAAE,qBAAA;GACJ,UAAU;GACV,MAAI;GACJ,YAAU;GACV,UAAI,IAAA;GACL,CAAC;EAAE,gBAAU,SAAA,EAAA,CAAA;EAAA,gBAAA,OAAA;GACZ,IAAG,UAAA;AACD,WAAE,mDAAwD,YAAE,QAAW,CAAA;;GAEzE,IAAI,WAAG;AACL,WAAG,gBAAY,cAAA,EACb,UAAS,yCACV,CAAC;;GAEL,CAAC;EAAE,gBAAkB,qBAAS;GAC7B,UAAQ;GACR,MAAM;GACN,YAAS;GACT,UAAG,IAAA;GACJ,CAAC;EAAE,gBAAE,SAAA,EAAA,CAAA;EAAA,gBAAA,OAAA;GACJ,IAAI,UAAM;AACR,WAAE,iDAAY,YAAA,QAAA,CAAA;;GAEhB,IAAI,WAAW;AACb,WAAM;KAAA,gBAAe,cAAmB,EACtC,UAAE,+MACH,CAAC;KAAE,gBAAA,SAAA,EAAA,CAAA;KAAA,gBAAA,YAAA;MACF,MAAM;MACN,UAAU;MACX,CAAC;KAAC;;GAEN,CAAC;EAAE,gBAAQ,qBAAA;GACV,UAAU;GACV,MAAM;GACN,YAAI,CAAA;;IAEF,MAAE;IACH,CAAC;GACF,IAAG,WAAS;AACV,WAAC,IAAA;;;oBAGI,YAAqB,QAAC,CAAA;;;;;;GAM9B,CAAC;EAAE,gBAAe,SAAW,EAAA,CAAA;EAAA,gBAAa,OAAA;GACzC,IAAI,UAAA;AACF,WAAC,0DAAS,YAAA,QAAA,CAAA;;GAEZ,IAAI,WAAW;AACb,WAAI,gBAAA,cAAA,EACF,UAAG,gDACJ,CAAC;;GAEL,CAAC;EAAE,gBAAgB,qBAAA;GAClB,UAAS;GACT,MAAG;GACH,YAAI;GACJ,UAAU,IAAA;GACX,CAAC;EAAE,gBAAkB,SAAQ,EAAA,CAAA;EAAA,gBAAS,OAAA;GACrC,IAAI,UAAM;AACR,WAAE,sDAAmB,YAAA,QAAA,CAAA;;GAEvB,IAAG,WAAA;AACD,WAAE,gBAAoB,cAAiB,EACrC,UAAE,4CACH,CAAC;;GAEL,CAAC;EAAE,gBAAO,qBAAA;GACT,UAAG;GACH,MAAI;GACJ,YAAU;GACV,UAAI,IAAU;GACf,CAAC;EAAE,gBAAe,SAAW,EAAA,CAAA;EAAM,gBAAE,OAAA;GACpC,IAAI,UAAA;AACF,WAAC,4DAAS,YAAA,QAAA,CAAA;;GAEZ,IAAI,WAAU;AACZ,WAAG,gBAAe,cAAA,EAChB,UAAK,0CACN,CAAA;;GAEJ,CAAC;EAAE,gBAAgB,qBAAA;GAClB,UAAU;GACV,MAAG;GACH,YAAY;GACZ,UAAK,IAAA;GACN,CAAC;EAAE,gBAAY,SAAY,EAAA,CAAA;EAAQ,gBAAY,OAAY;GAC1D,IAAI,UAAE;AACJ,WAAO,cAAA,YAAA,QAAA,CAAA;;GAET,IAAI,WAAW;AACd,WAAQ,gBAAA,eAAA,EAAA,CAAA;;GAEV,CAAC;EAAE,gBAAkB,gBAAY;GACjC,UAAA;GACH,MAAA;GACA,UAAc,IAAC;GACZ,CAAC;EAAE,gBAAE,SAAmB,EAAA,CAAA;EAAA,gBAAA,OAAA;GACvB,IAAG,UAAS;AACV,WAAO,WAAW,YAAY,QAAC,CAAQ;;GAEzC,IAAI,WAAK;AACP,WAAC,gBAAoB,cAAa,EAChC,IAAC,WAAY;AACb,YAAA,OAAA,YAAmB,QAAA,CAAA;OAEpB,CAAA;;GAEJ,CAAC;EAAE,gBAAe,qBAAwB;GACzC,UAAQ;GACR,MAAM;GACN,YAAM;GACN,IAAI,WAAK;AACP,WAAC,IAAA;;;YAGA,YAAS,QAAA,CAAA;;;;;GAKb,CAAC;EAAE,gBAAkB,SAAO,EAAA,CAAA;EAAA,gBAAA,OAAA;GAC3B,SAAM;GACN,IAAI,WAAS;AACX,WAAI,gBAAA,cAAA,EACF,UAAE,sCACH,CAAC;;GAEL,CAAC;EAAE,gBAAkB,qBAAmB;GACvC,UAAM;GACN,MAAM;GACN,YAAK;GACL,UAAQ,IAAK;GACd,CAAC;EAAE,gBAAgB,SAAA,EAAA,CAAA;EAAA,gBAAA,OAAA;GAClB,SAAS;GACT,IAAG,WAAA;AACD,WAAE,gBAAA,cAAA,EACA,IAAI,WAAS;AACb,YAAA,sEAAY,UAAA,QAAA,CAAA;OAEb,CAAC;;GAEL,CAAC;EAAE,gBAAa,qBAAS;GACxB,UAAQ;GACR,MAAM;GACN,YAAM;GACN,UAAK,IAAA;GACN,CAAC;EAAE,gBAAI,SAAA,EAAA,CAAA;EAAA,gBAAA,OAAA;GACN,SAAM;GACN,IAAI,WAAQ;AACV,WAAI;KAAA,gBAAmB,WAAc,EACnC,UAAU,+DACX,CAAC;KAAE,gBAAkB,YAAU;MAC9B,MAAM;MACN,UAAC;MACF,CAAC;KAAC,gBAAK,YAAA;MACN,MAAM;MACN,UAAA;MACD,CAAA;KAAA,gBAAS,cAAA,EACT,UAAM,iDACN,CAAC;KAAC;;GAEN,CAAC;EAAE,gBAAgB,qBAAA;GAClB,UAAS;GACT,MAAG;GACH,YAAU,CAAA;IACR,MAAE;IACF,MAAC;IACF,EAAE;IACD,MAAE;IACF,MAAI;IACJ,SAAK;IACN,CAAC;GACF,IAAI,WAAQ;AACV,WAAI;KAAA,gBAAU,gBAAA;MACZ,SAAC;MACD,MAAI;MACJ,MAAE;MACF,aAAK,IAAA;;;;MAIN,CAAC;KAAA,gBAAgB,OAAA,EAAA,CAAA;KAAA,IAAA;KAAA;;GAErB,CAAC;EAAE,gBAAc,SAAa,EAAC,CAAA;EAAA,gBAAA,OAAA;GAC9B,SAAS;GACT,IAAI,WAAO;AACT,WAAE,gBAAmB,cAAA,EACpB,UAAS,uOACT,CAAA;;GAEJ,CAAC;EAAE,gBAAI,qBAAA;GACN,UAAO;GACP,MAAK;GACL,YAAY;GACZ,UAAM,IAAA;GACP,CAAC;EAAE,gBAAe,SAAA,EAAA,CAAA;EAAA,gBAAA,OAAA;GACjB,IAAI,UAAQ;AACV,WAAI,kCAAY,YAAA,QAAA,CAAA;;GAElB,IAAG,WAAA;AACD,WAAE,CAAA,gBAAA,YAAA;KACA,MAAA;KACA,UAAM;KACP,CAAC,EAAA,gBAAgB,cAAA,EAChB,UAAE,oGACH,CAAC,CAAC;;GAEN,CAAC;EAAE,gBAAiB,qBAAsB;GACzC,UAAM;GACN,OAAK;GACL,MAAI;GACJ,YAAY,CAAC;IACX,MAAM;IACN,MAAM;IACP,CAAC;GACF,YAAK;GACL,UAAI,IAAU;;;;;GAGd,IAAI,UAAU;AACZ,WAAO,gCAAgC,YAAA,QAAA,CAAqB;;GAE9D,IAAI,WAAW;AACb,WAAI,CAAA,gBAAsB,YAAY;KACpC,MAAA;;KAED,CAAC,EAAA,gBAAoB,cAAY,EAChC,UAAS,oGACV,CAAC,CAAA;;GAEL,CAAA;EAAA,gBAAA,qBAAA;GACH,UAAA;;GAEA,MAAO;GACL,gBAAgB,CAAA;IACZ,MAAI;IACP,SAAA;;IAED,CAAA;GACE,YAAU;IAAA;KACZ,MAAA;KACI,MAAC;KACL;IAAK;;KAEL,MAAO;KACJ;IAAA;KACC,MAAI;KACJ,MAAA;KACD;IAAE;KACD,MAAA;KACA,MAAG;KACJ;IAAC;GACF,YAAI;GACJ,UAAE,IAAA;;;;;;;;;;;GAWH,CAAA;EAAA"}
+{"version":3,"file":"state-builtin.mjs","names":[],"sources":["../../src/components/state-builtin.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                  ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/shell-shock\n Documentation:            https://docs.stormsoftware.com/projects/shell-shock\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { code, computed, For, Show, splitProps } from \"@alloy-js/core\";\nimport {\n  FunctionDeclaration,\n  InterfaceDeclaration,\n  InterfaceMember,\n  TypeDeclaration,\n  VarDeclaration\n} from \"@alloy-js/typescript\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components/spacing\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport type { BuiltinFileProps } from \"@powerlines/plugin-alloy/typescript/components/builtin-file\";\nimport { BuiltinFile } from \"@powerlines/plugin-alloy/typescript/components/builtin-file\";\nimport {\n  TSDoc,\n  TSDocInternal,\n  TSDocLink,\n  TSDocParam,\n  TSDocRemarks,\n  TSDocReturns\n} from \"@powerlines/plugin-alloy/typescript/components/tsdoc\";\nimport defu from \"defu\";\nimport { computedOptions } from \"../contexts/options\";\nimport { getAppBin } from \"../plugin-utils\";\nimport { getAppTitle } from \"../plugin-utils/context-helpers\";\nimport type { Context } from \"../types\";\nimport { OptionsMember, OptionsParserLogic } from \"./options-parser-logic\";\n\nexport function GlobalTypeDefinitions() {\n  const context = usePowerlines<Context>();\n\n  const options = computed(() => computedOptions(context.options));\n\n  return (\n    <>\n      <TSDoc\n        heading={`An object representing the global options available for every command in the ${getAppTitle(\n          context,\n          true\n        )} command-line application.`}\n      />\n      <InterfaceDeclaration export name=\"GlobalOptions\">\n        <For each={Object.values(options.value)} hardline>\n          {option => <OptionsMember option={option} />}\n        </For>\n      </InterfaceDeclaration>\n      <Spacing />\n      <TSDoc heading=\"The context object for the current command execution, containing the command path and segments.\" />\n      <InterfaceDeclaration\n        export\n        name=\"CommandContext\"\n        typeParameters={[\n          {\n            name: \"THandler\",\n            extends: \"(...params: any[]) => any\",\n            default: \"any\"\n          }\n        ]}>\n        <TSDoc\n          heading={`The full command path as a string. For example, if the user runs \\`${getAppBin(\n            context\n          )} foo bar\\`, this would be \\`foo bar\\`. This is useful for commands that need to know their full invocation path, such as for help text or for commands that have dynamic behavior based on their position in the command hierarchy.`}\n        />\n        <InterfaceMember name=\"path\" type=\"string\" />\n        <Spacing />\n        <TSDoc\n          heading={`An array of command path segments. For example, if the user runs \\`${getAppBin(\n            context\n          )} foo bar\\`, this would be \\`[\"foo\", \"bar\"]\\`. This is useful for commands that need to know their individual path segments, such as for dynamic routing or for commands that have behavior based on specific segments in the command hierarchy.`}\n        />\n        <InterfaceMember name=\"segments\" type=\"string[]\" />\n        <Spacing />\n        <TSDoc\n          heading={`The parameters for the current command's handler function.`}\n        />\n        <InterfaceMember name=\"params\" type=\"Parameters<THandler>\" />\n      </InterfaceDeclaration>\n      <Spacing />\n      <TypeDeclaration export name=\"GlobalContextStatus\">\n        {code`\"initializing\" | \"preparing\" | \"executing\" | \"completed\"`}\n      </TypeDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`The state object for the ${getAppTitle(context)} application context.`}\n      />\n      <InterfaceDeclaration export name=\"GlobalContextState\">\n        <TSDoc heading=\"The unique identifier for the current execution context.\" />\n        <InterfaceMember name=\"executionId\" type=\"string\" />\n        <Spacing />\n        <TSDoc heading=\"The status of the current execution context.\" />\n        <InterfaceMember name=\"status\" type=\"GlobalContextStatus\" />\n        <Spacing />\n        <TSDoc heading=\"Indicates whether the current execution context has encountered an error.\" />\n        <InterfaceMember name=\"isError\" type=\"boolean\" />\n        <Spacing />\n        <TSDoc heading=\"A map containing arbitrary data associated with the current execution context.\" />\n        <InterfaceMember name=\"meta\" type=\"Map<string, unknown>\" />\n      </InterfaceDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`The context object for the ${getAppTitle(context)} application.`}\n      />\n      <InterfaceDeclaration export name=\"GlobalContext\">\n        <TSDoc heading=\"The global options shared across all commands in the application.\" />\n        <InterfaceMember name=\"options\" type=\"GlobalOptions\" />\n        <Spacing />\n        <TSDoc heading=\"The raw command-line arguments passed to the application.\" />\n        <InterfaceMember name=\"inputArgs\" type=\"string[]\" />\n        <Spacing />\n        <TSDoc heading=\"The state of the current execution context.\" />\n        <InterfaceMember name=\"state\" type=\"GlobalContextState\" />\n      </InterfaceDeclaration>\n    </>\n  );\n}\n\n/**\n * Generates utilities for detecting terminal color support.\n */\nexport function ArgsUtilities() {\n  return (\n    <>\n      <TSDoc heading=\"Retrieves the command-line arguments from Deno or Node.js environments.\">\n        <TSDocRemarks>\n          {`This function is only intended for internal use. Please use \\`useArgs()\\` instead.`}\n        </TSDocRemarks>\n        <Spacing />\n        <TSDocInternal />\n        <Spacing />\n        <TSDocReturns>\n          {`An array of command-line arguments from Deno or Node.js environments.`}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration name=\"getInputArgs\" returnType=\"string[]\">\n        {code`return ((globalThis as { Deno?: { args: string[] } })?.Deno?.args ?? process.argv ?? []) as string[];`}\n      </FunctionDeclaration>\n    </>\n  );\n}\n\nexport function ContextUtilities() {\n  const context = usePowerlines<Context>();\n\n  const options = computed(() =>\n    Object.fromEntries(context.options.map(option => [option.name, option]))\n  );\n\n  return (\n    <>\n      <Spacing />\n\n      <TSDoc\n        heading={`The global ${getAppTitle(context)} application context store instance.`}>\n        <TSDocInternal />\n      </TSDoc>\n      <VarDeclaration export const name=\"unstable_globalStore\">\n        {code`  new AsyncLocalStorage<GlobalContext>({ name: \"globalStore\" }); `}\n      </VarDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`Get the ${getAppTitle(\n          context\n        )} application context for the current application.`}>\n        <TSDocReturns>\n          {`The ${getAppTitle(\n            context\n          )} application context for the current application or undefined if the context is not available.`}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration export name=\"useGlobal\" returnType=\"GlobalContext\">\n        {code`return unstable_globalStore.getStore() as GlobalContext;`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`A utility hook function to get the command-line arguments from the ${getAppTitle(\n          context\n        )} application context.`}>\n        <TSDocReturns>\n          {\"An array of command-line arguments from the application context.\"}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration export name=\"useArgs\" returnType=\"string[]\">\n        {code`return useGlobal()?.inputArgs ?? getInputArgs();`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`A utility hook function to get the command-line global options from the ${getAppTitle(\n          context\n        )} application context.`}>\n        <TSDocReturns>\n          {\n            \"An object containing the global options from the application context.\"\n          }\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration\n        export\n        name=\"useGlobalOptions\"\n        returnType=\"GlobalOptions\">\n        {code`return useGlobal()?.options ?? {};`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`A utility hook function to get the state of the ${getAppTitle(\n          context\n        )} application context.`}>\n        <TSDocReturns>{\"The state of the application context.\"}</TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration\n        export\n        name=\"useState\"\n        returnType=\"GlobalContextState\">\n        {code`return useGlobal()?.state;`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`A utility function to update the state of the ${getAppTitle(\n          context\n        )} application context.`}>\n        <TSDocRemarks>\n          {`This function will throw an error if the global context is not available, so it should only be used within a valid context scope, such as within a command handler or within the \\`withGlobal()\\` function.`}\n        </TSDocRemarks>\n        <Spacing />\n        <TSDocParam name=\"update\">\n          {`The new state or a function that receives the previous state and returns the new state. This allows for both direct state updates and functional updates based on the previous state.`}\n        </TSDocParam>\n      </TSDoc>\n      <FunctionDeclaration\n        export\n        name=\"setState\"\n        parameters={[\n          {\n            name: \"update\",\n            type: \"Partial<GlobalContextState> | ((prev: GlobalContextState) => GlobalContextState)\"\n          }\n        ]}>\n        {code`const prev = useGlobal()?.state;\n        if (!prev) {\n          throw new Error(\n            \\`The ${getAppTitle(\n              context\n            )} application context is not available. Make sure to call setState() within a valid context scope.\\`\n          );\n        }\n\n        useGlobal().state = typeof update === \"function\" ? update(prev) : { ...prev, ...update }; `}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`A utility hook function to get the execution ID of the ${getAppTitle(\n          context\n        )} application context.`}>\n        <TSDocReturns>\n          {\"The execution ID of the application context.\"}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration export name=\"useExecutionId\" returnType=\"string\">\n        {code`return useState().executionId;`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`A utility hook function to get the metadata of the ${getAppTitle(\n          context\n        )} application context.`}>\n        <TSDocReturns>\n          {\"The metadata of the application context.\"}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration\n        export\n        name=\"useMeta\"\n        returnType=\"Map<string, unknown>\">\n        {code`return useState().meta;`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`A utility hook function to get the current status of the ${getAppTitle(\n          context\n        )} application.`}>\n        <TSDocReturns>{\"The current status of the application.\"}</TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration\n        export\n        name=\"useStatus\"\n        returnType=\"GlobalContextStatus\">\n        {code`return useState().status;`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`The global ${getAppTitle(context)} - command context store instance.`}>\n        <TSDocInternal />\n      </TSDoc>\n      <VarDeclaration export name=\"unstable_commandStore\">\n        {code`new AsyncLocalStorage<CommandContext>({ name: \"commandStore\" });`}\n      </VarDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`Get the ${getAppTitle(context)} - command context for the current application.`}>\n        <TSDocReturns>\n          {`The ${getAppTitle(context)} - command context for the current application.`}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration export name=\"useCommand\" returnType=\"CommandContext\">\n        {code`const result = unstable_commandStore.getStore();\nif (!result) {\n  throw new Error(\n    \\`The ${getAppTitle(context)} - command context is not available. Make sure to call useCommand() within a valid context scope.\\`\n  );\n}\nreturn result;`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc heading=\"A utility hook function to get the individual segments of the current command path.\">\n        <TSDocReturns>{\"An array of command path segments.\"}</TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration export name=\"useSegments\" returnType=\"string[]\">\n        {code`return useCommand().segments;`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc heading=\"A utility hook function to get the full command path as a string.\">\n        <TSDocReturns>\n          {`The full command path as a string. For example, if the user runs \\`${getAppBin(\n            context\n          )} foo bar\\`, this would return \\`\"foo bar\"\\`. This is useful for commands that need to know their full invocation path, such as for help text or for commands that have dynamic behavior based on their position in the command hierarchy.`}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration export name=\"usePath\" returnType=\"string\">\n        {code`return useCommand().path;`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc heading=\"Checks if a specific flag is present in the command-line arguments.\">\n        <TSDocLink>\n          {\"https://github.com/sindresorhus/has-flag/blob/main/index.js\"}\n        </TSDocLink>\n        <TSDocParam name=\"flag\">\n          {\n            'The flag (or an array of flags/aliases) to check for, e.g., \"color\", \"no-color\".'\n          }\n        </TSDocParam>\n        <TSDocParam name=\"argv\">\n          {\n            \"The command-line arguments to check against. Defaults to global Deno args or process args.\"\n          }\n        </TSDocParam>\n        <TSDocReturns>\n          {\"True if the flag is present, false otherwise.\"}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration\n        export\n        name=\"hasFlag\"\n        parameters={[\n          { name: \"flag\", type: \"string | string[]\" },\n          {\n            name: \"argv\",\n            type: \"string[]\",\n            default: \"useArgs()\"\n          }\n        ]}>\n        <VarDeclaration\n          const\n          name=\"position\"\n          type=\"number\"\n          initializer={code`(Array.isArray(flag) ? flag : [flag]).reduce((ret, f) => {\n            const pos = argv.findIndex(arg => (f.startsWith(\"-\") ? \"\" : (f.length === 1 ? \"-\" : \"--\") + f)?.toLowerCase() === arg?.toLowerCase() || arg?.toLowerCase().startsWith((f.length === 1 ? \"-\" : \"--\") + f + \"=\"));\n            return pos !== -1 ? pos : ret;\n          }, -1);`}\n        />\n        <hbr />\n        {code`return position !== -1 && argv.indexOf(\"--\") === -1 || position < argv.indexOf(\"--\");`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc heading=\"A utility function to determine if the help flag is present or if the command is in an error state during preparation.\">\n        <TSDocReturns>\n          {`True if the help flag is present or if the command is in an error state during preparation, false otherwise. This can be used to conditionally display help text or to alter command behavior when the user is likely seeking help.`}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration export name=\"isHelp\" returnType=\"boolean\">\n        {code`return !isCI && (hasFlag([\"help\", \"h\", \"?\"]) || (useStatus() === \"preparing\" && useState().isError)); `}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`A utility function to wrap the ${getAppTitle(\n          context\n        )} application within the global context scope.`}>\n        <TSDocParam name=\"handler\">\n          {`The callback function to run within the global context scope. This function will receive the global context as its argument, allowing it to access any properties or utilities defined on the context. The callback function can be asynchronous and can return a value or a promise.`}\n        </TSDocParam>\n        <TSDocReturns>\n          {`The result of the callback function, which can be a value or a promise that resolves to a value.`}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration\n        export\n        async\n        name=\"withGlobal\"\n        parameters={[{ name: \"handler\", type: \"() => any\" }]}\n        returnType=\"Promise<void>\">\n        <VarDeclaration\n          const\n          name=\"args\"\n          initializer={code`getInputArgs(); `}\n        />\n        <Spacing />\n        <OptionsParserLogic\n          options={options.value}\n          appSpecificEnvPrefix={context.config.appSpecificEnvPrefix}\n          isCaseSensitive={context.config.isCaseSensitive}\n        />\n        <Spacing />\n        {code`\n        return unstable_globalStore.run({ options, inputArgs: args, state: { executionId: randomUUID(), status: \"initializing\", isError: false, meta: new Map() } as GlobalContextState }, handler);`}\n      </FunctionDeclaration>\n      <Spacing />\n      <TSDoc\n        heading={`A utility function to wrap a ${getAppTitle(\n          context\n        )} application command handler within the command context scope.`}>\n        <TSDocParam name=\"handler\">\n          {`The callback function to run within the command context scope. This function will receive the command context as its argument, allowing it to access any properties or utilities defined on the context. The callback function can be asynchronous and can return a value or a promise.`}\n        </TSDocParam>\n        <TSDocReturns>\n          {`The result of the callback function, which can be a value or a promise that resolves to a value.`}\n        </TSDocReturns>\n      </TSDoc>\n      <FunctionDeclaration\n        export\n        async\n        name=\"withCommand\"\n        typeParameters={[\n          {\n            name: \"THandler\",\n            extends: \"(this: CommandContext, ...params: any[]) => any\",\n            default: \"(this: CommandContext, ...params: any[]) => any\"\n          }\n        ]}\n        parameters={[\n          { name: \"path\", type: \"string\" },\n          { name: \"segments\", type: \"string[]\" },\n          { name: \"params\", type: \"Parameters<THandler>\" },\n          { name: \"handler\", type: \"THandler\" }\n        ]}\n        returnType=\"Promise<{ error: string | Error | null }>\">\n        {code`setState({ status: \"preparing\", isError: false });\n\n        const ctx = { path, segments, params } as CommandContext<THandler>;\n        const result = await Promise.resolve(unstable_commandStore.run(ctx, Reflect.apply(handler, ctx, params)));\n        if (result instanceof Error || (typeof result === \"object\" && ((result as { error: unknown }).error instanceof Error || typeof (result as { error: unknown }).error === \"string\"))) {\n          setState({ status: \"completed\", isError: true });\n          return { error: result instanceof Error ? result : (result as { error: Error | string }).error };\n        }\n\n        setState({ status: \"completed\", isError: false });\n        return { error: null }; `}\n      </FunctionDeclaration>\n    </>\n  );\n}\n\nexport interface StateBuiltinProps extends Omit<\n  BuiltinFileProps,\n  \"id\" | \"description\"\n> {}\n\n/**\n * A built-in module for handling application state utilities in Shell Shock.\n */\nexport function StateBuiltin(props: StateBuiltinProps) {\n  const [{ children }, rest] = splitProps(props, [\"children\"]);\n\n  return (\n    <BuiltinFile\n      id=\"state\"\n      description=\"A module that provides context hooks and utilities for accessing the application state.\"\n      {...rest}\n      imports={defu(rest.imports ?? {}, {\n        \"node:async_hooks\": [\"AsyncLocalStorage\"],\n        \"node:crypto\": [\"randomUUID\"]\n      })}\n      builtinImports={defu(rest.builtinImports ?? {}, {\n        env: [\"isCI\", \"env\"]\n      })}>\n      <GlobalTypeDefinitions />\n      <Spacing />\n      <ArgsUtilities />\n      <Spacing />\n      <ContextUtilities />\n      <Spacing />\n      <Show when={Boolean(children)}>{children}</Show>\n    </BuiltinFile>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;AAgCA,SAAe,wBAAA;CACb,MAAA,UAAS,eAAA;CACT,MAAA,UAAU,eAAA,gBAAA,QAAA,QAAA,CAAA;AACV,QAAA;EAAA,gBAAY,OAAA,EACZ,IAAA,UAAA;AACI,UAAG,gFAAoD,YAAA,SAAA,KAAA,CAAA;KAE7D,CAAA;EAAM,gBAAkB,sBAAqB;GAC7C,UAAS;GACT,MAAS;GACT,IAAO,WAAO;AACR,WAAG,gBAAe,KAAA;;AAEjB,aAAS,OAAA,OAAA,QAAuB,MAAC;;;KAGhC,WAAU,WAAU,gBAAK,eAAwB,UAEhD,CAAA;KACJ,CAAA;;GAEF,CAAC;EAAE,gBAAe,SAAO,EAAA,CAAA;EAAA,gBAAwB,OAAQ,EACxD,SAAM,mGACP,CAAC;EAAE,gBAAI,sBAAA;GACN,UAAO;GACP,MAAG;GACH,gBAAG,CAAA;IACD,MAAM;IACN,SAAK;IACL,SAAO;IACR,CAAC;GACF,IAAG,WAAS;AACV,WAAO;KAAA,gBAAa,OAAQ,EAC3B,IAAA,UAAA;AACC,aAAA,sEAAA,UAAA,QAAA,CAAA;QAED,CAAC;KAAA,gBAAgB,iBAAA;MAChB,MAAE;MACF,MAAI;MACL,CAAC;KAAE,gBAAgB,SAAW,EAAE,CAAC;KAAE,gBAAM,OAAA,EACxC,IAAI,UAAU;AACZ,aAAA,sEAAA,UAAA,QAAA,CAAA;QAEH,CAAC;KAAC,gBAAA,iBAAA;MACD,MAAE;MACF,MAAI;MACL,CAAC;KAAE,gBAAkB,SAAS,EAAE,CAAC;KAAA,gBAAmB,OAAO,EAC1D,SAAC,8DACF,CAAC;KAAC,gBAAgB,iBAAkB;MACnC,MAAC;MACD,MAAC;MACF,CAAC;KAAC;;GAEN,CAAC;EAAE,gBAAkB,SAAK,EAAM,CAAA;EAAG,gBAAkB,iBAAiB;GACrE,UAAK;GACL,MAAK;GACL,UAAK,IAAS;GACf,CAAC;EAAE,gBAAG,SAAA,EAAA,CAAA;EAAA,gBAAA,OAAA,EACL,IAAI,UAAU;AACZ,UAAG,4BAAA,YAAA,QAAA,CAAA;KAEN,CAAC;EAAE,gBAAE,sBAAoB;GACxB,UAAU;GACV,MAAG;GACH,IAAI,WAAO;AACT,WAAE;KAAA,gBAAe,OAAA,EAChB,SAAS,4DACT,CAAA;KAAA,gBAAA,iBAAA;MACC,MAAA;MACD,MAAA;MACA,CAAA;KAAA,gBAAqB,SAAO,EAAI,CAAC;KAAC,gBAAmB,OAAA,EACpD,SAAO,gDACR,CAAC;KAAC,gBAAgB,iBAAmB;MACpC,MAAC;MACD,MAAM;MACP,CAAC;KAAC,gBAAgB,SAAY,EAAE,CAAA;KAAA,gBAAM,OAAsB,EAC3D,SAAS,6EACV,CAAC;KAAC,gBAAe,iBAAqB;MACrC,MAAC;MACD,MAAC;MACF,CAAC;KAAC,gBAAiB,SAAI,EAAA,CAAU;KAAC,gBAAe,OAAW,EAC3D,SAAC,kFACF,CAAC;KAAA,gBAAoB,iBAAA;MACrB,MAAO;MACP,MAAA;MACA,CAAC;KAAA;;GAEL,CAAC;EAAE,gBAAC,SAAqB,EAAO,CAAA;EAAA,gBAAoB,OAAA,EACnD,IAAI,UAAO;AACT,UAAG,8BAA+B,YAAM,QAAgB,CAAA;KAE3D,CAAC;EAAE,gBAAkB,sBAAqB;GACzC,UAAK;GACL,MAAK;GACL,IAAI,WAAO;AACT,WAAG;KAAA,gBAAsB,OAAO,EAC9B,SAAA,qEACF,CAAA;KAAA,gBAAA,iBAAA;MACH,MAAA;MACH,MAAA;;;8BAEE,SAAA,6DACC,CAAA;KAAA,gBAAwB,iBAAkB;MAC3C,MAAA;MACK,MAAA;MACL,CAAM;KAAC,gBAAA,SAAA,EAAA,CAAA;KAAA,gBAAA,OAAA,EACJ,SAAA,+CACE,CAAA;KAAA,gBAAe,iBAAsB;MACpC,MAAC;MACD,MAAI;MACL,CAAC;KAAC;;GAEN,CAAC;EAAC;;;;;AAML,SAAO,gBAAyB;AAC9B,QAAO,CAAA,gBAAc,OAAW;EAC9B,SAAI;EACJ,IAAE,WAAA;AACH,UAAA;IAAA,gBAAA,cAAA,EACH,UAAA;;;;oCAEO,UAAS,yEACT,CAAC;IAAA;;EAEN,CAAA,EAAA,gBAAgB,qBAAa;EAC3B,MAAM;EACP,YAAA;;EAED,CAAA,CAAA;;AAEF,SAAgB,mBAAA;;CAEd,MAAK,UAAA,eAAA,OAAA,YAAA,QAAA,QAAA,KAAA,WAAA,CAAA,OAAA,MAAA,OAAA,CAAA,CAAA,CAAA;AACL,QAAM;EAAA,gBAAoB,SAAG,EAAA,CAAA;EAAW,gBAAW,OAAY;GAC7D,IAAI,UAAC;AACH,WAAO,cAAA,YAAA,QAAA,CAAA;;GAET,IAAI,WAAW;AACb,WAAE,gBAAc,eAAA,EAAA,CAAA;;GAEnB,CAAC;EAAE,gBAAC,gBAAA;GACH,UAAI;GACJ,SAAM;GACN,MAAM;GACN,UAAK,IAAA;GACN,CAAC;EAAE,gBAAY,SAAW,EAAA,CAAA;EAAA,gBAAA,OAAA;GACzB,IAAI,UAAI;AACN,WAAO,WAAW,YAAY,QAAK,CAAA;;GAErC,IAAI,WAAK;AACP,WAAC,gBAAoB,cAAa,EAChC,IAAC,WAAY;AACb,YAAA,OAAA,YAAmB,QAAA,CAAA;OAEpB,CAAA;;GAEJ,CAAC;EAAE,gBAAI,qBAAA;GACN,UAAO;GACP,MAAK;GACL,YAAW;GACX,UAAM,IAAA;GACP,CAAC;EAAE,gBAAO,SAAA,EAAA,CAAA;EAAA,gBAAA,OAAA;GACT,IAAG,UAAA;AACD,WAAO,sEAAkD,YAAA,QAAA,CAAA;;GAE3D,IAAG,WAAS;AACV,WAAC,gBAAA,cAAA,EACC,UAAU,oEACX,CAAC;;GAEL,CAAC;EAAE,gBAAe,qBAAA;GACjB,UAAM;GACN,MAAM;GACN,YAAM;GACN,UAAM,IAAA;GACP,CAAC;EAAE,gBAAO,SAAA,EAAA,CAAA;EAAA,gBAAA,OAAA;GACT,IAAG,UAAA;AACD,WAAE,2EAAA,YAAA,QAAA,CAAA;;GAEJ,IAAI,WAAW;AACb,WAAO,gBAAkB,cAAc,EACrC,UAAA,yEACD,CAAA;;GAEJ,CAAC;EAAE,gBAAc,qBAAyB;GACzC,UAAM;GACN,MAAM;GACN,YAAK;GACL,UAAS,IAAA;GACV,CAAC;EAAE,gBAAC,SAAA,EAAA,CAAA;EAAA,gBAAA,OAAA;GACH,IAAI,UAAA;AACF,WAAO,mDAAS,YAAA,QAAA,CAAA;;GAElB,IAAI,WAAM;AACR,WAAE,gBAAmB,cAAA,EACpB,UAAS,yCACT,CAAA;;GAEJ,CAAC;EAAE,gBAAI,qBAAA;GACN,UAAO;GACP,MAAK;GACL,YAAY;GACZ,UAAM,IAAA;GACP,CAAC;EAAE,gBAAY,SAAA,EAAA,CAAA;EAAA,gBAAA,OAAA;GACd,IAAI,UAAC;AACH,WAAM,iDAA8C,YAAe,QAAI,CAAA;;GAEzE,IAAI,WAAK;AACP,WAAC;KAAA,gBAAA,cAAA,EACC,UAAA,+MACD,CAAC;KAAA,gBAAc,SAAA,EAAA,CAAA;KAAA,gBAAA,YAAA;MACd,MAAA;MACA,UAAE;MACH,CAAC;KAAC;;GAEN,CAAC;EAAE,gBAAI,qBAAA;GACN,UAAM;GACN,MAAK;GACL,YAAS,CAAI;IACX,MAAI;IACJ,MAAM;IACP,CAAC;GACF,IAAI,WAAO;AACT,WAAK,IAAA;;;oBAGS,YAAQ,QAAO,CAAM;;;;;;GAMtC,CAAC;EAAE,gBAAiB,SAAU,EAAA,CAAA;EAAA,gBAAA,OAAA;GAC7B,IAAI,UAAC;AACH,WAAM,0DAA6C,YAAA,QAAA,CAAA;;GAErD,IAAI,WAAK;AACP,WAAC,gBAAoB,cAAa,EAChC,UAAM,gDACP,CAAC;;GAEL,CAAC;EAAE,gBAAC,qBAAA;GACH,UAAI;GACJ,MAAM;GACN,YAAO;GACP,UAAK,IAAA;GACN,CAAC;EAAE,gBAAkB,SAAQ,EAAA,CAAA;EAAA,gBAAqB,OAAA;GACjD,IAAI,UAAE;AACJ,WAAO,sDAAA,YAAA,QAAA,CAAA;;GAET,IAAI,WAAA;AACF,WAAO,gBAAQ,cAAA,EACb,UAAU,4CACX,CAAC;;GAEL,CAAC;EAAE,gBAAU,qBAAA;GACZ,UAAG;GACH,MAAI;GACJ,YAAM;GACN,UAAO,IAAA;GACR,CAAC;EAAE,gBAAkB,SAAI,EAAO,CAAC;EAAA,gBAAc,OAAa;GAC3D,IAAI,UAAK;AACP,WAAC,4DAAA,YAAA,QAAA,CAAA;;GAEH,IAAI,WAAM;AACR,WAAE,gBAAY,cAAoB,EAChC,UAAM,0CACP,CAAC;;GAEL,CAAC;EAAE,gBAAC,qBAAA;GACH,UAAI;GACJ,MAAK;GACL,YAAS;GACT,UAAG,IAAA;GACJ,CAAC;EAAE,gBAAY,SAAA,EAAiB,CAAC;EAAA,gBAAkB,OAAO;GACzD,IAAI,UAAA;AACF,WAAC,cAAS,YAAA,QAAA,CAAA;;GAEZ,IAAI,WAAU;AACZ,WAAG,gBAAY,eAAA,EAAA,CAAA;;GAElB,CAAC;EAAE,gBAAgB,gBAAA;GAClB,UAAS;GACT,MAAG;GACH,UAAU,IAAA;GACX,CAAC;EAAC,gBAAQ,SAAA,EAAA,CAAA;EAAA,gBAAA,OAAA;GACX,IAAM,UAAS;AACX,WAAM,WAAY,YAAY,QAAQ,CAAA;;GAE5C,IAAA,WAAA;AACM,WAAO,gBAAE,cAAA,EACP,IAAA,WAAA;AACD,YAAS,OAAA,YAAA,QAAA,CAAA;OAET,CAAC;;GAEL,CAAC;EAAE,gBAAC,qBAAiC;GACpC,UAAU;GACV,MAAI;GACJ,YAAY;GACZ,IAAG,WAAM;AACP,WAAG,IAAA;;;YAGG,YAAY,QAAK,CAAA;;;;;GAK1B,CAAC;EAAE,gBAAE,SAAmB,EAAA,CAAA;EAAA,gBAAA,OAAA;GACvB,SAAG;GACH,IAAG,WAAM;AACP,WAAG,gBAAS,cAAA,EACV,UAAU,sCACX,CAAC;;GAEL,CAAC;EAAE,gBAAI,qBAAA;GACN,UAAS;GACT,MAAM;GACN,YAAM;GACN,UAAK,IAAA;GACN,CAAC;EAAE,gBAAI,SAAA,EAAA,CAAA;EAAA,gBAAA,OAAA;GACN,SAAS;GACT,IAAI,WAAE;AACJ,WAAI,gBAAU,cAAA,EACZ,IAAC,WAAY;AACX,YAAO,sEAAyC,UAAA,QAAA,CAAA;OAEnD,CAAC;;GAEL,CAAC;EAAE,gBAAE,qBAAA;GACJ,UAAU;GACV,MAAI;GACJ,YAAY;GACZ,UAAM,IAAA;GACP,CAAC;EAAE,gBAAkB,SAAA,EAAA,CAAA;EAAA,gBAAA,OAAA;GACpB,SAAQ;GACR,IAAI,WAAW;AACb,WAAI;KAAA,gBAAA,WAAA,EACF,UAAE,+DACH,CAAC;KAAC,gBAAA,YAAA;MACD,MAAE;MACF,UAAQ;MACT,CAAC;KAAE,gBAAY,YAAA;MACd,MAAE;MACF,UAAU;MACX,CAAC;KAAE,gBAAkB,cAAa,EACjC,UAAU,iDACX,CAAC;KAAC;;GAEN,CAAC;EAAE,gBAAe,qBAAwB;GACzC,UAAI;GACJ,MAAG;GACH,YAAS,CAAA;IACP,MAAG;IACH,MAAM;IACP,EAAE;IACD,MAAE;IACF,MAAC;IACD,SAAQ;IACT,CAAC;GACF,IAAG,WAAS;AACV,WAAC;KAAA,gBAAA,gBAAA;MACC,SAAS;MACT,MAAE;MACF,MAAG;MACH,aAAY,IAAK;;;;MAIlB,CAAC;KAAE,gBAAgB,OAAI,EAAA,CAAQ;KAAC,IAAA;KAAsE;;GAE1G,CAAC;EAAE,gBAAO,SAAA,EAAA,CAAA;EAAA,gBAAA,OAAA;GACT,SAAG;GACH,IAAI,WAAA;AACF,WAAE,gBAAA,cAAA,EACA,UAAM,uOACP,CAAC;;GAEL,CAAC;EAAE,gBAAG,qBAAA;GACL,UAAM;GACN,MAAM;GACN,YAAM;GACN,UAAK,IAAA;GACN,CAAC;EAAE,gBAAY,SAAA,EAAA,CAAA;EAAA,gBAAA,OAAA;GACd,IAAI,UAAC;AACH,WAAI,kCAAsB,YAAA,QAAA,CAAA;;GAE5B,IAAI,WAAE;AACJ,WAAG,CAAA,gBAAA,YAAA;KACD,MAAC;KACD,UAAK;KACN,CAAC,EAAA,gBAAO,cAA2B,EAClC,UAAA,oGACD,CAAA,CAAA;;GAEJ,CAAC;EAAE,gBAAc,qBAAyB;GACzC,UAAM;GACN,OAAO;GACP,MAAK;GACL,YAAY,CAAA;IACV,MAAI;IACJ,MAAG;IACJ,CAAC;GACF,YAAM;GACN,IAAI,WAAK;AACP,WAAC;KAAA,gBAAA,gBAAA;MACC,SAAA;MACA,MAAA;MACA,aAAM,IAAW;MAClB,CAAC;KAAA,gBAAgB,SAAA,EAAA,CAAA;KAAA,gBAAA,oBAAA;MAChB,IAAE,UAAA;AACA,cAAO,QAAE;;MAEX,IAAI,uBAAiB;AACnB,cAAA,QAAA,OAAA;;MAEF,IAAA,kBAAY;AACV,cAAO,QAAQ,OAAO;;MAEzB,CAAC;KAAE,gBAAkB,SAAO,EAAA,CAAA;KAAA,IAAW;;KACA;;GAE3C,CAAC;EAAE,gBAAc,SAAU,EAAK,CAAC;EAAC,gBAAiB,OAAQ;GAC1D,IAAI,UAAM;;;GAGV,IAAI,WAAM;AACR,WAAM,CAAA,gBAAkB,YAAU;KAChC,MAAE;KACF,UAAU;KACX,CAAC,EAAA,gBAAA,cAAA,gHAED,CAAC,CAAA;;GAEL,CAAC;EAAE,gBAAE,qBAAmB;GACvB,UAAE;GACH,OAAA;GACH,MAAA;;IAEM,MAAC;IACL,SAAA;IACI,SAAI;IACP,CAAA;;;KAED,MAAA;KACG,MAAM;KACT;IAAA;KACI,MAAC;KACL,MAAS;;;KAET,MAAO;KACJ,MAAA;KACA;IAAC;KACA,MAAA;KACA,MAAI;KACL;IAAC;GACF,YAAU;GACV,UAAU,IAAA;;;;;;;;;;;GAWX,CAAC;EAAC"}

package/dist/components/utils-builtin.cjs

@@ -210,6 +210,149 @@ function FindSuggestionsDeclaration() {
 	];
 }
 /**
+* Generates utilities for detecting terminal size and whether the process is running in the foreground, which can be used to determine how to render output (e.g., whether to use a progress bar or spinner).
+*/
+function TerminalSizeDeclaration() {
+	return [
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.VarDeclaration, {
+			"export": true,
+			"const": true,
+			name: "DEFAULT_TERMINAL_COLUMNS",
+			doc: "Default number of terminal columns",
+			initializer: _alloy_js_core.code`80`
+		}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.VarDeclaration, {
+			"export": true,
+			"const": true,
+			name: "DEFAULT_TERMINAL_ROWS",
+			doc: "Default number of terminal rows",
+			initializer: _alloy_js_core.code`24`
+		}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.FunctionDeclaration, {
+			name: "isForegroundProcess",
+			children: _alloy_js_core.code`if (isLinux) {
+          return true;
+        }
+
+        try {
+          const statContents = readFileSync("/proc/self/stat", "utf8");
+          const closingParenthesisIndex = statContents.lastIndexOf(') ');
+
+          if (closingParenthesisIndex === -1) {
+            return false;
+          }
+
+          const statFields = statContents.slice(closingParenthesisIndex + 2).trim().split(/\\s+/);
+          const processGroupId = Number.parseInt(statFields[2], 10);
+          const foregroundProcessGroupId = Number.parseInt(statFields[5], 10);
+
+          if (Number.isNaN(processGroupId) || Number.isNaN(foregroundProcessGroupId)) {
+            return false;
+          }
+
+          if (foregroundProcessGroupId <= 0) {
+            return false;
+          }
+
+          return processGroupId === foregroundProcessGroupId;
+        } catch {
+          return false;
+        } `
+		}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.FunctionDeclaration, {
+			name: "tput",
+			children: _alloy_js_core.code`try {
+            const columns = execSync(["tput", "cols"], { env: { TERM: 'dumb', ...process.env } });
+            const rows = execSync(["tput", "lines"], { env: { TERM: 'dumb', ...process.env } });
+
+            if (columns && rows) {
+              return { columns: Number.parseInt(columns.toString().trim(), 10), rows: Number.parseInt(rows.toString().trim(), 10) };
+            }
+          } catch {}  `
+		}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.FunctionDeclaration, {
+			name: "devTty",
+			children: _alloy_js_core.code`try {
+          const writeStream = new WriteStream(
+            openSync(
+              "/dev/tty",
+              fsConstants.O_NONBLOCK
+            )
+          ).getWindowSize();
+
+          return { columns: writeStream[0], rows: writeStream[1] };
+        } catch {}  `
+		}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript_components_tsdoc.TSDoc, {
+			heading: "A utility function that attempts to determine the size of the terminal (number of columns and rows) using various methods, and falls back to default values if it cannot be determined. This can be used to adjust output formatting based on the available terminal size.",
+			get children() {
+				return [
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript_components_tsdoc.TSDocRemarks, { children: "The function first checks if the process is running in a TTY environment and if the stdout or stderr streams provide column and row information. If not, it attempts to use platform-specific methods (like reading from /proc/self/stat on Linux, using tput on Unix-like systems, or checking /dev/tty) to determine the terminal size. If all else fails, it returns default values." }),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript_components_tsdoc.TSDocReturns, { children: "An object containing the number of columns and rows of the terminal." })
+				];
+			}
+		}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.FunctionDeclaration, {
+			"export": true,
+			name: "getTerminalSize",
+			returnType: "{ columns: number; rows: number; }",
+			get children() {
+				return [
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.IfStatement, {
+						condition: _alloy_js_core.code`process.stdout?.columns && process.stdout?.rows`,
+						children: _alloy_js_core.code`return { columns: process.stdout.columns, rows: process.stdout.rows }; `
+					}),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.IfStatement, {
+						condition: _alloy_js_core.code`process.stderr?.columns && process.stderr?.rows`,
+						children: _alloy_js_core.code`return { columns: process.stderr.columns, rows: process.stderr.rows };`
+					}),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.IfStatement, {
+						condition: _alloy_js_core.code`isWindows`,
+						children: _alloy_js_core.code`return tput() ?? {
+            columns: DEFAULT_TERMINAL_COLUMNS,
+            rows: DEFAULT_TERMINAL_ROWS,
+          }; `
+					}),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.IfStatement, {
+						condition: _alloy_js_core.code`isMacOS`,
+						children: _alloy_js_core.code`return devTty() ?? tput() ?? {
+            columns: DEFAULT_TERMINAL_COLUMNS,
+            rows: DEFAULT_TERMINAL_ROWS,
+          }; `
+					}),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.VarDeclaration, {
+						"let": true,
+						name: "result",
+						initializer: _alloy_js_core.code`devTty() ?? tput(); `
+					}),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.IfStatement, {
+						condition: _alloy_js_core.code`!result && isForegroundProcess()`,
+						children: _alloy_js_core.code`try {
+          const size = execSync(["resize", "-u"]).match(/\\d+/g);
+          if (size.length === 2) {
+            result = { columns: Number.parseInt(size[0], 10), rows: Number.parseInt(size[1], 10) };
+          }
+        } catch {} `
+					}),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+					_alloy_js_core.code`return result ?? {
+          columns: DEFAULT_TERMINAL_COLUMNS,
+          rows: DEFAULT_TERMINAL_ROWS,
+        }; `
+				];
+			}
+		})
+	];
+}
+/**
 * Generates utilities for detecting terminal color support.
 */
 function EnvSupportUtilities() {
@@ -1562,6 +1705,10 @@ function UtilsBuiltin(props) {
 					"isAbsolute"
 				],
 				"node:fs": [
+					{
+						name: "constants",
+						alias: "fsConstants"
+					},
 					"openSync",
 					"closeSync",
 					"read",
@@ -1570,6 +1717,7 @@ function UtilsBuiltin(props) {
 					"realpathSync"
 				],
 				"node:fs/promises": ["stat"],
+				"node:tty": ["WriteStream"],
 				"node:util": ["promisify"],
 				"node:url": ["fileURLToPath", "pathToFileURL"],
 				"node:module": ["builtinModules"]
@@ -1587,9 +1735,12 @@ function UtilsBuiltin(props) {
 					"isCI",
 					"isTest",
 					"isWindows",
+					"isLinux",
+					"isMacOS",
 					"isDevelopment",
 					"isDebug"
 				],
+				exec: ["execSync"],
 				state: ["hasFlag"]
 			});
 		},
@@ -1615,6 +1766,8 @@ function UtilsBuiltin(props) {
 					children: _alloy_js_core.code`return new Promise((resolve) => setTimeout(resolve, durationMs)); `
 				}),
 				(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+				(0, _alloy_js_core_jsx_runtime.createComponent)(TerminalSizeDeclaration, {}),
+				(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
 				(0, _alloy_js_core_jsx_runtime.createComponent)(EnvSupportUtilities, {}),
 				(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
 				(0, _alloy_js_core_jsx_runtime.createComponent)(HyperlinkSupportUtilities, {}),
@@ -1642,5 +1795,6 @@ exports.EnvSupportUtilities = EnvSupportUtilities;
 exports.FindSuggestionsDeclaration = FindSuggestionsDeclaration;
 exports.HyperlinkSupportUtilities = HyperlinkSupportUtilities;
 exports.ResolveModuleFunctionDeclaration = ResolveModuleFunctionDeclaration;
+exports.TerminalSizeDeclaration = TerminalSizeDeclaration;
 exports.UtilsBuiltin = UtilsBuiltin;
 //# sourceMappingURL=utils-builtin.cjs.map