@shopify/cli-kit 3.24.1 → 3.26.0

package/dist/private/node/ui/components/FilePath.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+interface Props {
+    filePath: string;
+}
+/**
+ * `FilePath` displays a path to a file.
+ */
+declare const FilePath: React.FC<Props>;
+export { FilePath };

package/dist/private/node/ui/components/FilePath.js

@@ -0,0 +1,13 @@
+import { Text } from 'ink';
+import React from 'react';
+/**
+ * `FilePath` displays a path to a file.
+ */
+const FilePath = ({ filePath }) => {
+    return React.createElement(Text, null,
+        "\"",
+        filePath,
+        "\"");
+};
+export { FilePath };
+//# sourceMappingURL=FilePath.js.map

package/dist/private/node/ui/components/FilePath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FilePath.js","sourceRoot":"","sources":["../../../../../src/private/node/ui/components/FilePath.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,KAAK,CAAA;AACxB,OAAO,KAAK,MAAM,OAAO,CAAA;AAMzB;;GAEG;AACH,MAAM,QAAQ,GAAoB,CAAC,EAAC,QAAQ,EAAiC,EAAe,EAAE;IAC5F,OAAO,oBAAC,IAAI;;QAAG,QAAQ;aAAS,CAAA;AAClC,CAAC,CAAA;AAED,OAAO,EAAC,QAAQ,EAAC,CAAA","sourcesContent":["import {Text} from 'ink'\nimport React from 'react'\n\ninterface Props {\n  filePath: string\n}\n\n/**\n * `FilePath` displays a path to a file.\n */\nconst FilePath: React.FC<Props> = ({filePath}: React.PropsWithChildren<Props>): JSX.Element => {\n  return <Text>\"{filePath}\"</Text>\n}\n\nexport {FilePath}\n"]}

package/dist/private/node/ui/components/FilePath.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/private/node/ui/components/FilePath.test.js

@@ -0,0 +1,11 @@
+import { FilePath } from './FilePath.js';
+import { renderString } from '../../ui.js';
+import { describe, expect, test } from 'vitest';
+import React from 'react';
+describe('FilePath', async () => {
+    test('renders correctly', async () => {
+        const { output } = renderString(React.createElement(FilePath, { filePath: "src/this/is/a/test.js" }));
+        expect(output).toMatchInlineSnapshot('"\\"src/this/is/a/test.js\\""');
+    });
+});
+//# sourceMappingURL=FilePath.test.js.map

package/dist/private/node/ui/components/FilePath.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FilePath.test.js","sourceRoot":"","sources":["../../../../../src/private/node/ui/components/FilePath.test.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,eAAe,CAAA;AACtC,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAA;AACxC,OAAO,EAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,QAAQ,CAAA;AAC7C,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,QAAQ,CAAC,UAAU,EAAE,KAAK,IAAI,EAAE;IAC9B,IAAI,CAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;QACnC,MAAM,EAAC,MAAM,EAAC,GAAG,YAAY,CAAC,oBAAC,QAAQ,IAAC,QAAQ,EAAC,uBAAuB,GAAG,CAAC,CAAA;QAE5E,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC,+BAA+B,CAAC,CAAA;IACvE,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA","sourcesContent":["import {FilePath} from './FilePath.js'\nimport {renderString} from '../../ui.js'\nimport {describe, expect, test} from 'vitest'\nimport React from 'react'\n\ndescribe('FilePath', async () => {\n  test('renders correctly', async () => {\n    const {output} = renderString(<FilePath filePath=\"src/this/is/a/test.js\" />)\n\n    expect(output).toMatchInlineSnapshot('\"\\\\\"src/this/is/a/test.js\\\\\"\"')\n  })\n})\n"]}

package/dist/private/node/ui/components/Link.js

@@ -1,14 +1,15 @@
-import { Text, Transform } from 'ink';
+import chalk from 'chalk';
+import { Text } from 'ink';
 import React from 'react';
 import terminalLink from 'terminal-link';
+function fallback(text, url) {
+    return `${text} ${chalk.dim(`(${url})`)}`;
+}
 /**
  * `Link` displays a clickable link when supported by the terminal.
  */
 const Link = ({ url, label }) => {
-    return (React.createElement(Text, null,
-        label && React.createElement(Text, { dimColor: true }, `${label}: `),
-        React.createElement(Transform, { transform: (children) => terminalLink(children, url, { fallback: false }) },
-            React.createElement(Text, { underline: true }, url))));
+    return React.createElement(Text, null, terminalLink(label ?? url, url, { fallback: label ? fallback : false }));
 };
 export { Link };
 //# sourceMappingURL=Link.js.map

package/dist/private/node/ui/components/Link.js.map

@@ -1 +1 @@
-{"version":3,"file":"Link.js","sourceRoot":"","sources":["../../../../../src/private/node/ui/components/Link.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAE,SAAS,EAAC,MAAM,KAAK,CAAA;AACnC,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,YAAY,MAAM,eAAe,CAAA;AAOxC;;GAEG;AACH,MAAM,IAAI,GAAoB,CAAC,EAAC,GAAG,EAAE,KAAK,EAAiC,EAAe,EAAE;IAC1F,OAAO,CACL,oBAAC,IAAI;QACF,KAAK,IAAI,oBAAC,IAAI,IAAC,QAAQ,UAAE,GAAG,KAAK,IAAI,CAAQ;QAC9C,oBAAC,SAAS,IAAC,SAAS,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAC,QAAQ,EAAE,KAAK,EAAC,CAAC;YAChF,oBAAC,IAAI,IAAC,SAAS,UAAE,GAAG,CAAQ,CAClB,CACP,CACR,CAAA;AACH,CAAC,CAAA;AAED,OAAO,EAAC,IAAI,EAAC,CAAA","sourcesContent":["import {Text, Transform} from 'ink'\nimport React from 'react'\nimport terminalLink from 'terminal-link'\n\ninterface Props {\n  url: string\n  label?: string\n}\n\n/**\n * `Link` displays a clickable link when supported by the terminal.\n */\nconst Link: React.FC<Props> = ({url, label}: React.PropsWithChildren<Props>): JSX.Element => {\n  return (\n    <Text>\n      {label && <Text dimColor>{`${label}: `}</Text>}\n      <Transform transform={(children) => terminalLink(children, url, {fallback: false})}>\n        <Text underline>{url}</Text>\n      </Transform>\n    </Text>\n  )\n}\n\nexport {Link}\n"]}
+{"version":3,"file":"Link.js","sourceRoot":"","sources":["../../../../../src/private/node/ui/components/Link.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAC,IAAI,EAAC,MAAM,KAAK,CAAA;AACxB,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,YAAY,MAAM,eAAe,CAAA;AAOxC,SAAS,QAAQ,CAAC,IAAY,EAAE,GAAW;IACzC,OAAO,GAAG,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,EAAE,CAAA;AAC3C,CAAC;AAED;;GAEG;AACH,MAAM,IAAI,GAAoB,CAAC,EAAC,GAAG,EAAE,KAAK,EAAiC,EAAe,EAAE;IAC1F,OAAO,oBAAC,IAAI,QAAE,YAAY,CAAC,KAAK,IAAI,GAAG,EAAE,GAAG,EAAE,EAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,EAAC,CAAC,CAAQ,CAAA;AAC7F,CAAC,CAAA;AAED,OAAO,EAAC,IAAI,EAAC,CAAA","sourcesContent":["import chalk from 'chalk'\nimport {Text} from 'ink'\nimport React from 'react'\nimport terminalLink from 'terminal-link'\n\ninterface Props {\n  url: string\n  label?: string\n}\n\nfunction fallback(text: string, url: string) {\n  return `${text} ${chalk.dim(`(${url})`)}`\n}\n\n/**\n * `Link` displays a clickable link when supported by the terminal.\n */\nconst Link: React.FC<Props> = ({url, label}: React.PropsWithChildren<Props>): JSX.Element => {\n  return <Text>{terminalLink(label ?? url, url, {fallback: label ? fallback : false})}</Text>\n}\n\nexport {Link}\n"]}

package/dist/private/node/ui/components/Link.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/private/node/ui/components/Link.test.js

@@ -0,0 +1,22 @@
+import { Link } from './Link.js';
+import { renderString } from '../../ui.js';
+import { describe, expect, test } from 'vitest';
+import React from 'react';
+describe('Link', async () => {
+    test("renders correctly with a fallback for terminals that don't support hyperlinks", async () => {
+        const link = {
+            url: 'https://example.com',
+            label: 'Example',
+        };
+        const { output } = renderString(React.createElement(Link, { ...link }));
+        expect(output).toMatchInlineSnapshot('"Example (https://example.com)"');
+    });
+    test("it doesn't render a fallback if only url is passed", async () => {
+        const link = {
+            url: 'https://example.com',
+        };
+        const { output } = renderString(React.createElement(Link, { ...link }));
+        expect(output).toMatchInlineSnapshot('"https://example.com"');
+    });
+});
+//# sourceMappingURL=Link.test.js.map

package/dist/private/node/ui/components/Link.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Link.test.js","sourceRoot":"","sources":["../../../../../src/private/node/ui/components/Link.test.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAA;AAC9B,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAA;AACxC,OAAO,EAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,QAAQ,CAAA;AAC7C,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,QAAQ,CAAC,MAAM,EAAE,KAAK,IAAI,EAAE;IAC1B,IAAI,CAAC,+EAA+E,EAAE,KAAK,IAAI,EAAE;QAC/F,MAAM,IAAI,GAAG;YACX,GAAG,EAAE,qBAAqB;YAC1B,KAAK,EAAE,SAAS;SACjB,CAAA;QAED,MAAM,EAAC,MAAM,EAAC,GAAG,YAAY,CAAC,oBAAC,IAAI,OAAK,IAAI,GAAI,CAAC,CAAA;QAEjD,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC,0CAA0C,CAAC,CAAA;IAClF,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,IAAI,GAAG;YACX,GAAG,EAAE,qBAAqB;SAC3B,CAAA;QAED,MAAM,EAAC,MAAM,EAAC,GAAG,YAAY,CAAC,oBAAC,IAAI,OAAK,IAAI,GAAI,CAAC,CAAA;QAEjD,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC,uBAAuB,CAAC,CAAA;IAC/D,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA","sourcesContent":["import {Link} from './Link.js'\nimport {renderString} from '../../ui.js'\nimport {describe, expect, test} from 'vitest'\nimport React from 'react'\n\ndescribe('Link', async () => {\n  test(\"renders correctly with a fallback for terminals that don't support hyperlinks\", async () => {\n    const link = {\n      url: 'https://example.com',\n      label: 'Example',\n    }\n\n    const {output} = renderString(<Link {...link} />)\n\n    expect(output).toMatchInlineSnapshot('\"Example \u001b[2m(https://example.com)\u001b[22m\"')\n  })\n\n  test(\"it doesn't render a fallback if only url is passed\", async () => {\n    const link = {\n      url: 'https://example.com',\n    }\n\n    const {output} = renderString(<Link {...link} />)\n\n    expect(output).toMatchInlineSnapshot('\"https://example.com\"')\n  })\n})\n"]}

package/dist/private/node/ui/components/List.d.ts

@@ -1,7 +1,7 @@
 import { TokenItem } from './TokenizedText.js';
 import React from 'react';
 interface Props {
-    title: string;
+    title?: string;
     items: TokenItem[];
     ordered?: boolean;
 }

package/dist/private/node/ui/components/List.js

@@ -8,10 +8,10 @@ const DOT = '•';
  */
 const List = ({ title, items, ordered = false }) => {
     return (React.createElement(Box, { flexDirection: "column" },
-        React.createElement(Text, { dimColor: true }, title),
+        title && React.createElement(Text, { bold: true }, title),
         items.map((item, index) => (React.createElement(Box, { key: index },
             React.createElement(Box, null,
-                React.createElement(Text, { dimColor: true }, `  ${ordered ? `${index + 1}.` : DOT}`)),
+                React.createElement(Text, null, `  ${ordered ? `${index + 1}.` : DOT}`)),
             React.createElement(Box, { flexGrow: 1, marginLeft: 1 },
                 React.createElement(TokenizedText, { item: item })))))));
 };

package/dist/private/node/ui/components/List.js.map

@@ -1 +1 @@
-{"version":3,"file":"List.js","sourceRoot":"","sources":["../../../../../src/private/node/ui/components/List.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAY,aAAa,EAAC,MAAM,oBAAoB,CAAA;AAC3D,OAAO,EAAC,GAAG,EAAE,IAAI,EAAC,MAAM,KAAK,CAAA;AAC7B,OAAO,KAAK,MAAM,OAAO,CAAA;AAQzB,MAAM,GAAG,GAAG,GAAG,CAAA;AAEf;;;GAGG;AACH,MAAM,IAAI,GAAoB,CAAC,EAAC,KAAK,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,EAAiC,EAAe,EAAE;IAC7G,OAAO,CACL,oBAAC,GAAG,IAAC,aAAa,EAAC,QAAQ;QACzB,oBAAC,IAAI,IAAC,QAAQ,UAAE,KAAK,CAAQ;QAC5B,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAC1B,oBAAC,GAAG,IAAC,GAAG,EAAE,KAAK;YACb,oBAAC,GAAG;gBACF,oBAAC,IAAI,IAAC,QAAQ,UAAE,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,CAAQ,CAC1D;YAEN,oBAAC,GAAG,IAAC,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC;gBAC7B,oBAAC,aAAa,IAAC,IAAI,EAAE,IAAI,GAAI,CACzB,CACF,CACP,CAAC,CACE,CACP,CAAA;AACH,CAAC,CAAA;AAED,OAAO,EAAC,IAAI,EAAC,CAAA","sourcesContent":["import {TokenItem, TokenizedText} from './TokenizedText.js'\nimport {Box, Text} from 'ink'\nimport React from 'react'\n\ninterface Props {\n  title: string\n  items: TokenItem[]\n  ordered?: boolean\n}\n\nconst DOT = '•'\n\n/**\n * `List` displays an unordered or ordered list with text aligned with the bullet point\n * and wrapped to the container width.\n */\nconst List: React.FC<Props> = ({title, items, ordered = false}: React.PropsWithChildren<Props>): JSX.Element => {\n  return (\n    <Box flexDirection=\"column\">\n      <Text dimColor>{title}</Text>\n      {items.map((item, index) => (\n        <Box key={index}>\n          <Box>\n            <Text dimColor>{`  ${ordered ? `${index + 1}.` : DOT}`}</Text>\n          </Box>\n\n          <Box flexGrow={1} marginLeft={1}>\n            <TokenizedText item={item} />\n          </Box>\n        </Box>\n      ))}\n    </Box>\n  )\n}\n\nexport {List}\n"]}
+{"version":3,"file":"List.js","sourceRoot":"","sources":["../../../../../src/private/node/ui/components/List.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAY,aAAa,EAAC,MAAM,oBAAoB,CAAA;AAC3D,OAAO,EAAC,GAAG,EAAE,IAAI,EAAC,MAAM,KAAK,CAAA;AAC7B,OAAO,KAAK,MAAM,OAAO,CAAA;AAQzB,MAAM,GAAG,GAAG,GAAG,CAAA;AAEf;;;GAGG;AACH,MAAM,IAAI,GAAoB,CAAC,EAAC,KAAK,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,EAAC,EAAe,EAAE;IAC7E,OAAO,CACL,oBAAC,GAAG,IAAC,aAAa,EAAC,QAAQ;QACxB,KAAK,IAAI,oBAAC,IAAI,IAAC,IAAI,UAAE,KAAK,CAAQ;QAClC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAC1B,oBAAC,GAAG,IAAC,GAAG,EAAE,KAAK;YACb,oBAAC,GAAG;gBACF,oBAAC,IAAI,QAAE,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,CAAQ,CACjD;YAEN,oBAAC,GAAG,IAAC,QAAQ,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC;gBAC7B,oBAAC,aAAa,IAAC,IAAI,EAAE,IAAI,GAAI,CACzB,CACF,CACP,CAAC,CACE,CACP,CAAA;AACH,CAAC,CAAA;AAED,OAAO,EAAC,IAAI,EAAC,CAAA","sourcesContent":["import {TokenItem, TokenizedText} from './TokenizedText.js'\nimport {Box, Text} from 'ink'\nimport React from 'react'\n\ninterface Props {\n  title?: string\n  items: TokenItem[]\n  ordered?: boolean\n}\n\nconst DOT = '•'\n\n/**\n * `List` displays an unordered or ordered list with text aligned with the bullet point\n * and wrapped to the container width.\n */\nconst List: React.FC<Props> = ({title, items, ordered = false}): JSX.Element => {\n  return (\n    <Box flexDirection=\"column\">\n      {title && <Text bold>{title}</Text>}\n      {items.map((item, index) => (\n        <Box key={index}>\n          <Box>\n            <Text>{`  ${ordered ? `${index + 1}.` : DOT}`}</Text>\n          </Box>\n\n          <Box flexGrow={1} marginLeft={1}>\n            <TokenizedText item={item} />\n          </Box>\n        </Box>\n      ))}\n    </Box>\n  )\n}\n\nexport {List}\n"]}

package/dist/private/node/ui/components/List.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/private/node/ui/components/List.test.js

@@ -0,0 +1,34 @@
+import { List } from './List.js';
+import { renderString } from '../../ui.js';
+import { unstyled } from '../../../../output.js';
+import { describe, expect, test } from 'vitest';
+import React from 'react';
+describe('List', async () => {
+    test('renders unordered items', async () => {
+        const options = {
+            title: 'List title',
+            items: ['Item 1', 'Item 2', 'Item 3'],
+            ordered: false,
+        };
+        const { output } = renderString(React.createElement(List, { ...options }));
+        expect(unstyled(output)).toMatchInlineSnapshot(`
+      "List title
+        • Item 1
+        • Item 2
+        • Item 3"
+    `);
+    });
+    test('renders ordered items', async () => {
+        const options = {
+            items: ['Item 1', 'Item 2', 'Item 3'],
+            ordered: true,
+        };
+        const { output } = renderString(React.createElement(List, { ...options }));
+        expect(unstyled(output)).toMatchInlineSnapshot(`
+      "  1. Item 1
+        2. Item 2
+        3. Item 3"
+    `);
+    });
+});
+//# sourceMappingURL=List.test.js.map

package/dist/private/node/ui/components/List.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"List.test.js","sourceRoot":"","sources":["../../../../../src/private/node/ui/components/List.test.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAA;AAC9B,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAA;AACxC,OAAO,EAAC,QAAQ,EAAC,MAAM,uBAAuB,CAAA;AAC9C,OAAO,EAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,QAAQ,CAAA;AAC7C,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,QAAQ,CAAC,MAAM,EAAE,KAAK,IAAI,EAAE;IAC1B,IAAI,CAAC,yBAAyB,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,OAAO,GAAG;YACd,KAAK,EAAE,YAAY;YACnB,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;YACrC,OAAO,EAAE,KAAK;SACf,CAAA;QAED,MAAM,EAAC,MAAM,EAAC,GAAG,YAAY,CAAC,oBAAC,IAAI,OAAK,OAAO,GAAI,CAAC,CAAA;QAEpD,MAAM,CAAC,QAAQ,CAAC,MAAO,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;;KAK/C,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;QACvC,MAAM,OAAO,GAAG;YACd,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;YACrC,OAAO,EAAE,IAAI;SACd,CAAA;QAED,MAAM,EAAC,MAAM,EAAC,GAAG,YAAY,CAAC,oBAAC,IAAI,OAAK,OAAO,GAAI,CAAC,CAAA;QAEpD,MAAM,CAAC,QAAQ,CAAC,MAAO,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;KAI/C,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA","sourcesContent":["import {List} from './List.js'\nimport {renderString} from '../../ui.js'\nimport {unstyled} from '../../../../output.js'\nimport {describe, expect, test} from 'vitest'\nimport React from 'react'\n\ndescribe('List', async () => {\n  test('renders unordered items', async () => {\n    const options = {\n      title: 'List title',\n      items: ['Item 1', 'Item 2', 'Item 3'],\n      ordered: false,\n    }\n\n    const {output} = renderString(<List {...options} />)\n\n    expect(unstyled(output!)).toMatchInlineSnapshot(`\n      \"List title\n        • Item 1\n        • Item 2\n        • Item 3\"\n    `)\n  })\n\n  test('renders ordered items', async () => {\n    const options = {\n      items: ['Item 1', 'Item 2', 'Item 3'],\n      ordered: true,\n    }\n\n    const {output} = renderString(<List {...options} />)\n\n    expect(unstyled(output!)).toMatchInlineSnapshot(`\n      \"  1. Item 1\n        2. Item 2\n        3. Item 3\"\n    `)\n  })\n})\n"]}

package/dist/private/node/ui/components/TokenizedText.d.ts

@@ -11,7 +11,19 @@ interface LinkToken {
 interface CharToken {
     char: string;
 }
-declare type Token = string | CommandToken | LinkToken | CharToken;
+interface UserInputToken {
+    userInput: string;
+}
+interface FilePathToken {
+    filePath: string;
+}
+interface ListToken {
+    list: {
+        items: TokenItem[];
+        ordered?: boolean;
+    };
+}
+declare type Token = string | CommandToken | LinkToken | CharToken | UserInputToken | FilePathToken | ListToken;
 export declare type TokenItem = Token | Token[];
 interface Props {
     item: TokenItem;

package/dist/private/node/ui/components/TokenizedText.js

@@ -1,14 +1,38 @@
 import { Command } from './Command.js';
 import { Link } from './Link.js';
-import { Text } from 'ink';
+import { List } from './List.js';
+import { UserInput } from './UserInput.js';
+import { FilePath } from './FilePath.js';
+import { Box, Text } from 'ink';
 import React from 'react';
+function tokenToBlock(token) {
+    return {
+        display: typeof token !== 'string' && 'list' in token ? 'block' : 'inline',
+        value: token,
+    };
+}
+function splitByDisplayType(acc, item) {
+    if (item.display === 'block') {
+        acc.push([item]);
+    }
+    else {
+        const last = acc[acc.length - 1];
+        if (last && last[0].display === 'inline') {
+            last.push(item);
+        }
+        else {
+            acc.push([item]);
+        }
+    }
+    return acc;
+}
 /**
  * `TokenizedText` renders a text string with tokens that can be either strings,
  * links, and commands.
  */
 const TokenizedText = ({ item }) => {
     if (typeof item === 'string') {
-        return React.createElement(Text, { dimColor: true }, item);
+        return React.createElement(Text, null, item);
     }
     else if ('command' in item) {
         return React.createElement(Command, { command: item.command });
@@ -17,12 +41,29 @@ const TokenizedText = ({ item }) => {
         return React.createElement(Link, { ...item.link });
     }
     else if ('char' in item) {
-        return React.createElement(Text, { dimColor: true }, item.char[0]);
+        return React.createElement(Text, null, item.char[0]);
+    }
+    else if ('userInput' in item) {
+        return React.createElement(UserInput, { userInput: item.userInput });
+    }
+    else if ('filePath' in item) {
+        return React.createElement(FilePath, { filePath: item.filePath });
+    }
+    else if ('list' in item) {
+        return React.createElement(List, { ...item.list });
     }
     else {
-        return (React.createElement(Text, null, item.map((listItem, index) => (React.createElement(Text, { key: index },
-            index !== 0 && !(typeof listItem !== 'string' && 'char' in listItem) && React.createElement(Text, null, " "),
-            React.createElement(TokenizedText, { item: listItem }))))));
+        const groupedItems = item.map(tokenToBlock).reduce(splitByDisplayType, []);
+        return (React.createElement(Box, { flexDirection: "column" }, groupedItems.map((items, groupIndex) => {
+            if (items[0].display === 'inline') {
+                return (React.createElement(Text, { key: groupIndex }, items.map((item, itemIndex) => (React.createElement(Text, { key: itemIndex },
+                    itemIndex !== 0 && !(typeof item.value !== 'string' && 'char' in item.value) && React.createElement(Text, null, " "),
+                    React.createElement(TokenizedText, { item: item.value }))))));
+            }
+            else {
+                return React.createElement(List, { key: groupIndex, items: items[0].value.list.items });
+            }
+        })));
     }
 };
 export { TokenizedText };

package/dist/private/node/ui/components/TokenizedText.js.map

@@ -1 +1 @@
-{"version":3,"file":"TokenizedText.js","sourceRoot":"","sources":["../../../../../src/private/node/ui/components/TokenizedText.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAC,MAAM,cAAc,CAAA;AACpC,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAA;AAC9B,OAAO,EAAC,IAAI,EAAC,MAAM,KAAK,CAAA;AACxB,OAAO,KAAK,MAAM,OAAO,CAAA;AAwBzB;;;GAGG;AACH,MAAM,aAAa,GAAoB,CAAC,EAAC,IAAI,EAAC,EAAE,EAAE;IAChD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC5B,OAAO,oBAAC,IAAI,IAAC,QAAQ,UAAE,IAAI,CAAQ,CAAA;KACpC;SAAM,IAAI,SAAS,IAAI,IAAI,EAAE;QAC5B,OAAO,oBAAC,OAAO,IAAC,OAAO,EAAE,IAAI,CAAC,OAAO,GAAI,CAAA;KAC1C;SAAM,IAAI,MAAM,IAAI,IAAI,EAAE;QACzB,OAAO,oBAAC,IAAI,OAAK,IAAI,CAAC,IAAI,GAAI,CAAA;KAC/B;SAAM,IAAI,MAAM,IAAI,IAAI,EAAE;QACzB,OAAO,oBAAC,IAAI,IAAC,QAAQ,UAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAQ,CAAA;KAC5C;SAAM;QACL,OAAO,CACL,oBAAC,IAAI,QACF,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,CAAC,CAC7B,oBAAC,IAAI,IAAC,GAAG,EAAE,KAAK;YACb,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,QAAQ,KAAK,QAAQ,IAAI,MAAM,IAAI,QAAQ,CAAC,IAAI,oBAAC,IAAI,YAAS;YACvF,oBAAC,aAAa,IAAC,IAAI,EAAE,QAAQ,GAAI,CAC5B,CACR,CAAC,CACG,CACR,CAAA;KACF;AACH,CAAC,CAAA;AAED,OAAO,EAAC,aAAa,EAAC,CAAA","sourcesContent":["import {Command} from './Command.js'\nimport {Link} from './Link.js'\nimport {Text} from 'ink'\nimport React from 'react'\n\ninterface CommandToken {\n  command: string\n}\n\ninterface LinkToken {\n  link: {\n    label?: string\n    url: string\n  }\n}\n\ninterface CharToken {\n  char: string\n}\n\ntype Token = string | CommandToken | LinkToken | CharToken\nexport type TokenItem = Token | Token[]\n\ninterface Props {\n  item: TokenItem\n}\n\n/**\n * `TokenizedText` renders a text string with tokens that can be either strings,\n * links, and commands.\n */\nconst TokenizedText: React.FC<Props> = ({item}) => {\n  if (typeof item === 'string') {\n    return <Text dimColor>{item}</Text>\n  } else if ('command' in item) {\n    return <Command command={item.command} />\n  } else if ('link' in item) {\n    return <Link {...item.link} />\n  } else if ('char' in item) {\n    return <Text dimColor>{item.char[0]}</Text>\n  } else {\n    return (\n      <Text>\n        {item.map((listItem, index) => (\n          <Text key={index}>\n            {index !== 0 && !(typeof listItem !== 'string' && 'char' in listItem) && <Text> </Text>}\n            <TokenizedText item={listItem} />\n          </Text>\n        ))}\n      </Text>\n    )\n  }\n}\n\nexport {TokenizedText}\n"]}
+{"version":3,"file":"TokenizedText.js","sourceRoot":"","sources":["../../../../../src/private/node/ui/components/TokenizedText.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAC,MAAM,cAAc,CAAA;AACpC,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAA;AAC9B,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAA;AAC9B,OAAO,EAAC,SAAS,EAAC,MAAM,gBAAgB,CAAA;AACxC,OAAO,EAAC,QAAQ,EAAC,MAAM,eAAe,CAAA;AACtC,OAAO,EAAC,GAAG,EAAE,IAAI,EAAC,MAAM,KAAK,CAAA;AAC7B,OAAO,KAAK,MAAM,OAAO,CAAA;AAyCzB,SAAS,YAAY,CAAC,KAAY;IAChC,OAAO;QACL,OAAO,EAAE,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ;QAC1E,KAAK,EAAE,KAAK;KACb,CAAA;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,GAAc,EAAE,IAAW;IACrD,IAAI,IAAI,CAAC,OAAO,KAAK,OAAO,EAAE;QAC5B,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;KACjB;SAAM;QACL,MAAM,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAChC,IAAI,IAAI,IAAI,IAAI,CAAC,CAAC,CAAE,CAAC,OAAO,KAAK,QAAQ,EAAE;YACzC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;SAChB;aAAM;YACL,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;SACjB;KACF;IACD,OAAO,GAAG,CAAA;AACZ,CAAC;AAMD;;;GAGG;AACH,MAAM,aAAa,GAAoB,CAAC,EAAC,IAAI,EAAC,EAAE,EAAE;IAChD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC5B,OAAO,oBAAC,IAAI,QAAE,IAAI,CAAQ,CAAA;KAC3B;SAAM,IAAI,SAAS,IAAI,IAAI,EAAE;QAC5B,OAAO,oBAAC,OAAO,IAAC,OAAO,EAAE,IAAI,CAAC,OAAO,GAAI,CAAA;KAC1C;SAAM,IAAI,MAAM,IAAI,IAAI,EAAE;QACzB,OAAO,oBAAC,IAAI,OAAK,IAAI,CAAC,IAAI,GAAI,CAAA;KAC/B;SAAM,IAAI,MAAM,IAAI,IAAI,EAAE;QACzB,OAAO,oBAAC,IAAI,QAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAQ,CAAA;KACnC;SAAM,IAAI,WAAW,IAAI,IAAI,EAAE;QAC9B,OAAO,oBAAC,SAAS,IAAC,SAAS,EAAE,IAAI,CAAC,SAAS,GAAI,CAAA;KAChD;SAAM,IAAI,UAAU,IAAI,IAAI,EAAE;QAC7B,OAAO,oBAAC,QAAQ,IAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,GAAI,CAAA;KAC7C;SAAM,IAAI,MAAM,IAAI,IAAI,EAAE;QACzB,OAAO,oBAAC,IAAI,OAAK,IAAI,CAAC,IAAI,GAAI,CAAA;KAC/B;SAAM;QACL,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAA;QAE1E,OAAO,CACL,oBAAC,GAAG,IAAC,aAAa,EAAC,QAAQ,IACxB,YAAY,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;YACtC,IAAI,KAAK,CAAC,CAAC,CAAE,CAAC,OAAO,KAAK,QAAQ,EAAE;gBAClC,OAAO,CACL,oBAAC,IAAI,IAAC,GAAG,EAAE,UAAU,IAClB,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE,CAAC,CAC9B,oBAAC,IAAI,IAAC,GAAG,EAAE,SAAS;oBACjB,SAAS,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,IAAI,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,oBAAC,IAAI,YAAS;oBAC/F,oBAAC,aAAa,IAAC,IAAI,EAAE,IAAI,CAAC,KAAK,GAAI,CAC9B,CACR,CAAC,CACG,CACR,CAAA;aACF;iBAAM;gBACL,OAAO,oBAAC,IAAI,IAAC,GAAG,EAAE,UAAU,EAAE,KAAK,EAAG,KAAK,CAAC,CAAC,CAAE,CAAC,KAAmB,CAAC,IAAI,CAAC,KAAK,GAAI,CAAA;aACnF;QACH,CAAC,CAAC,CACE,CACP,CAAA;KACF;AACH,CAAC,CAAA;AAED,OAAO,EAAC,aAAa,EAAC,CAAA","sourcesContent":["import {Command} from './Command.js'\nimport {Link} from './Link.js'\nimport {List} from './List.js'\nimport {UserInput} from './UserInput.js'\nimport {FilePath} from './FilePath.js'\nimport {Box, Text} from 'ink'\nimport React from 'react'\n\ninterface CommandToken {\n  command: string\n}\n\ninterface LinkToken {\n  link: {\n    label?: string\n    url: string\n  }\n}\n\ninterface CharToken {\n  char: string\n}\n\ninterface UserInputToken {\n  userInput: string\n}\n\ninterface FilePathToken {\n  filePath: string\n}\n\ninterface ListToken {\n  list: {\n    items: TokenItem[]\n    ordered?: boolean\n  }\n}\n\ntype Token = string | CommandToken | LinkToken | CharToken | UserInputToken | FilePathToken | ListToken\nexport type TokenItem = Token | Token[]\n\ntype DisplayType = 'block' | 'inline'\ninterface Block {\n  display: DisplayType\n  value: Token\n}\n\nfunction tokenToBlock(token: Token): Block {\n  return {\n    display: typeof token !== 'string' && 'list' in token ? 'block' : 'inline',\n    value: token,\n  }\n}\n\nfunction splitByDisplayType(acc: Block[][], item: Block) {\n  if (item.display === 'block') {\n    acc.push([item])\n  } else {\n    const last = acc[acc.length - 1]\n    if (last && last[0]!.display === 'inline') {\n      last.push(item)\n    } else {\n      acc.push([item])\n    }\n  }\n  return acc\n}\n\ninterface Props {\n  item: TokenItem\n}\n\n/**\n * `TokenizedText` renders a text string with tokens that can be either strings,\n * links, and commands.\n */\nconst TokenizedText: React.FC<Props> = ({item}) => {\n  if (typeof item === 'string') {\n    return <Text>{item}</Text>\n  } else if ('command' in item) {\n    return <Command command={item.command} />\n  } else if ('link' in item) {\n    return <Link {...item.link} />\n  } else if ('char' in item) {\n    return <Text>{item.char[0]}</Text>\n  } else if ('userInput' in item) {\n    return <UserInput userInput={item.userInput} />\n  } else if ('filePath' in item) {\n    return <FilePath filePath={item.filePath} />\n  } else if ('list' in item) {\n    return <List {...item.list} />\n  } else {\n    const groupedItems = item.map(tokenToBlock).reduce(splitByDisplayType, [])\n\n    return (\n      <Box flexDirection=\"column\">\n        {groupedItems.map((items, groupIndex) => {\n          if (items[0]!.display === 'inline') {\n            return (\n              <Text key={groupIndex}>\n                {items.map((item, itemIndex) => (\n                  <Text key={itemIndex}>\n                    {itemIndex !== 0 && !(typeof item.value !== 'string' && 'char' in item.value) && <Text> </Text>}\n                    <TokenizedText item={item.value} />\n                  </Text>\n                ))}\n              </Text>\n            )\n          } else {\n            return <List key={groupIndex} items={(items[0]!.value as ListToken).list.items} />\n          }\n        })}\n      </Box>\n    )\n  }\n}\n\nexport {TokenizedText}\n"]}

package/dist/private/node/ui/components/TokenizedText.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/private/node/ui/components/TokenizedText.test.js

@@ -0,0 +1,44 @@
+import { TokenizedText } from './TokenizedText.js';
+import { renderString } from '../../ui.js';
+import { unstyled } from '../../../../output.js';
+import { describe, expect, test } from 'vitest';
+import React from 'react';
+describe('TokenizedText', async () => {
+    test('renders arrays of items separated by spaces', async () => {
+        const item = [
+            'Run',
+            {
+                command: 'cd verification-app',
+            },
+            {
+                link: {
+                    url: 'https://example.com',
+                    label: 'Example',
+                },
+            },
+            {
+                char: '!',
+            },
+            {
+                userInput: 'my-app',
+            },
+            {
+                list: {
+                    items: ['Item 1', 'Item 2', 'Item 3'],
+                },
+            },
+            {
+                filePath: 'src/this/is/a/test.js',
+            },
+        ];
+        const { output } = renderString(React.createElement(TokenizedText, { item: item }));
+        expect(unstyled(output)).toMatchInlineSnapshot(`
+      "Run \`cd verification-app\` Example (https://example.com)! my-app
+        • Item 1
+        • Item 2
+        • Item 3
+      \\"src/this/is/a/test.js\\""
+    `);
+    });
+});
+//# sourceMappingURL=TokenizedText.test.js.map

package/dist/private/node/ui/components/TokenizedText.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TokenizedText.test.js","sourceRoot":"","sources":["../../../../../src/private/node/ui/components/TokenizedText.test.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,oBAAoB,CAAA;AAChD,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAA;AACxC,OAAO,EAAC,QAAQ,EAAC,MAAM,uBAAuB,CAAA;AAC9C,OAAO,EAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,QAAQ,CAAA;AAC7C,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,QAAQ,CAAC,eAAe,EAAE,KAAK,IAAI,EAAE;IACnC,IAAI,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC7D,MAAM,IAAI,GAAG;YACX,KAAK;YACL;gBACE,OAAO,EAAE,qBAAqB;aAC/B;YACD;gBACE,IAAI,EAAE;oBACJ,GAAG,EAAE,qBAAqB;oBAC1B,KAAK,EAAE,SAAS;iBACjB;aACF;YACD;gBACE,IAAI,EAAE,GAAG;aACV;YACD;gBACE,SAAS,EAAE,QAAQ;aACpB;YACD;gBACE,IAAI,EAAE;oBACJ,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;iBACtC;aACF;YACD;gBACE,QAAQ,EAAE,uBAAuB;aAClC;SACF,CAAA;QAED,MAAM,EAAC,MAAM,EAAC,GAAG,YAAY,CAAC,oBAAC,aAAa,IAAC,IAAI,EAAE,IAAI,GAAI,CAAC,CAAA;QAE5D,MAAM,CAAC,QAAQ,CAAC,MAAO,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;;;KAM/C,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA","sourcesContent":["import {TokenizedText} from './TokenizedText.js'\nimport {renderString} from '../../ui.js'\nimport {unstyled} from '../../../../output.js'\nimport {describe, expect, test} from 'vitest'\nimport React from 'react'\n\ndescribe('TokenizedText', async () => {\n  test('renders arrays of items separated by spaces', async () => {\n    const item = [\n      'Run',\n      {\n        command: 'cd verification-app',\n      },\n      {\n        link: {\n          url: 'https://example.com',\n          label: 'Example',\n        },\n      },\n      {\n        char: '!',\n      },\n      {\n        userInput: 'my-app',\n      },\n      {\n        list: {\n          items: ['Item 1', 'Item 2', 'Item 3'],\n        },\n      },\n      {\n        filePath: 'src/this/is/a/test.js',\n      },\n    ]\n\n    const {output} = renderString(<TokenizedText item={item} />)\n\n    expect(unstyled(output!)).toMatchInlineSnapshot(`\n      \"Run \\`cd verification-app\\` Example (https://example.com)! my-app\n        • Item 1\n        • Item 2\n        • Item 3\n      \\\\\"src/this/is/a/test.js\\\\\"\"\n    `)\n  })\n})\n"]}

package/dist/private/node/ui/components/UserInput.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+interface Props {
+    userInput: string;
+}
+/**
+ * `UserInput` displays some text that represents input from the user.
+ * For example an answer to a selection prompt.
+ */
+declare const UserInput: React.FC<Props>;
+export { UserInput };

package/dist/private/node/ui/components/UserInput.js

@@ -0,0 +1,11 @@
+import { Text } from 'ink';
+import React from 'react';
+/**
+ * `UserInput` displays some text that represents input from the user.
+ * For example an answer to a selection prompt.
+ */
+const UserInput = ({ userInput }) => {
+    return React.createElement(Text, { color: "cyan" }, userInput);
+};
+export { UserInput };
+//# sourceMappingURL=UserInput.js.map

package/dist/private/node/ui/components/UserInput.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserInput.js","sourceRoot":"","sources":["../../../../../src/private/node/ui/components/UserInput.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,KAAK,CAAA;AACxB,OAAO,KAAK,MAAM,OAAO,CAAA;AAMzB;;;GAGG;AACH,MAAM,SAAS,GAAoB,CAAC,EAAC,SAAS,EAAiC,EAAe,EAAE;IAC9F,OAAO,oBAAC,IAAI,IAAC,KAAK,EAAC,MAAM,IAAE,SAAS,CAAQ,CAAA;AAC9C,CAAC,CAAA;AAED,OAAO,EAAC,SAAS,EAAC,CAAA","sourcesContent":["import {Text} from 'ink'\nimport React from 'react'\n\ninterface Props {\n  userInput: string\n}\n\n/**\n * `UserInput` displays some text that represents input from the user.\n * For example an answer to a selection prompt.\n */\nconst UserInput: React.FC<Props> = ({userInput}: React.PropsWithChildren<Props>): JSX.Element => {\n  return <Text color=\"cyan\">{userInput}</Text>\n}\n\nexport {UserInput}\n"]}

package/dist/private/node/ui/components/UserInput.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/private/node/ui/components/UserInput.test.js

@@ -0,0 +1,11 @@
+import { UserInput } from './UserInput.js';
+import { renderString } from '../../ui.js';
+import { describe, expect, test } from 'vitest';
+import React from 'react';
+describe('UserInput', async () => {
+    test('renders correctly', async () => {
+        const { output } = renderString(React.createElement(UserInput, { userInput: "my-app" }));
+        expect(output).toMatchInlineSnapshot('"my-app"');
+    });
+});
+//# sourceMappingURL=UserInput.test.js.map

package/dist/private/node/ui/components/UserInput.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserInput.test.js","sourceRoot":"","sources":["../../../../../src/private/node/ui/components/UserInput.test.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,gBAAgB,CAAA;AACxC,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAA;AACxC,OAAO,EAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAC,MAAM,QAAQ,CAAA;AAC7C,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,QAAQ,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;IAC/B,IAAI,CAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;QACnC,MAAM,EAAC,MAAM,EAAC,GAAG,YAAY,CAAC,oBAAC,SAAS,IAAC,SAAS,EAAC,QAAQ,GAAG,CAAC,CAAA;QAE/D,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,CAAA;IAC5D,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA","sourcesContent":["import {UserInput} from './UserInput.js'\nimport {renderString} from '../../ui.js'\nimport {describe, expect, test} from 'vitest'\nimport React from 'react'\n\ndescribe('UserInput', async () => {\n  test('renders correctly', async () => {\n    const {output} = renderString(<UserInput userInput=\"my-app\" />)\n\n    expect(output).toMatchInlineSnapshot('\"\u001b[36mmy-app\u001b[39m\"')\n  })\n})\n"]}

package/dist/public/node/github.d.ts

@@ -0,0 +1,50 @@
+import { Result } from './result.js';
+export interface GithubRelease {
+    id: number;
+    url: string;
+    tag_name: string;
+    name: string;
+    body: string;
+    draft: boolean;
+    prerelease: boolean;
+    created_at: string;
+    published_at: string;
+    tarball_url: string;
+}
+interface GetLatestGitHubReleaseOptions {
+    filter: (release: GithubRelease) => boolean;
+}
+/**
+ * Given a GitHub repository it obtains the latest release.
+ * @param owner - Repository owner (e.g., shopify)
+ * @param repo - Repository name (e.g., cli)
+ * @param options - Options
+ */
+export declare function getLatestGitHubRelease(owner: string, repo: string, options?: GetLatestGitHubReleaseOptions): Promise<GithubRelease>;
+interface ParseRepositoryURLOutput {
+    full: string;
+    site: string;
+    user: string;
+    name: string;
+    ref: string;
+    subDirectory: string;
+    ssh: string;
+    http: string;
+}
+/**
+ * Given a GitHub repository URL, it parses it and returns its coomponents.
+ * @param url - The GitHub repository URL
+ */
+export declare function parseGitHubRepositoryURL(url: string): Result<ParseRepositoryURLOutput, Error>;
+export interface GithubRepositoryReference {
+    baseURL: string;
+    branch?: string;
+    filePath?: string;
+}
+/**
+ * Given a GitHub repository URL it parses it and extracts the branch, file path,
+ * and base URL components
+ * @param reference - A GitHub repository URL (e.g. https://github.com/Shopify/cli/blob/main/package.json)
+ */
+export declare function parseGitHubRepositoryReference(reference: string): GithubRepositoryReference;
+export {};

package/dist/{github.js → public/node/github.js}

@@ -1,25 +1,35 @@
-import { fetch } from './http.js';
-import { Abort } from './error.js';
-import { content, debug } from './output.js';
+import { err, ok } from './result.js';
+import { fetch } from '../../http.js';
+import { content, debug } from '../../output.js';
 class GitHubClientError extends Error {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     constructor(url, statusCode, bodyJson) {
         super(`The request to GitHub API URL ${url} failed with status code ${statusCode} and the following error message: ${bodyJson.message}`);
     }
 }
-export async function getLatestRelease(user, repo, { filter } = { filter: () => true }) {
-    debug(content `Getting the latest release of GitHub repository ${user}/${repo}...`);
-    const url = `https://api.github.com/repos/${user}/${repo}/releases`;
+/**
+ * Given a GitHub repository it obtains the latest release.
+ * @param owner - Repository owner (e.g., shopify)
+ * @param repo - Repository name (e.g., cli)
+ * @param options - Options
+ */
+export async function getLatestGitHubRelease(owner, repo, options = { filter: () => true }) {
+    debug(content `Getting the latest release of GitHub repository ${owner}/${repo}...`);
+    const url = `https://api.github.com/repos/${owner}/${repo}/releases`;
     const fetchResult = await fetch(url);
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const jsonBody = await fetchResult.json();
     if (fetchResult.status !== 200) {
         throw new GitHubClientError(url, fetchResult.status, jsonBody);
     }
-    return jsonBody.find(filter);
+    return jsonBody.find(options.filter);
 }
-export function parseRepoUrl(src) {
-    const match = /^(?:(?:https:\/\/)?([^:/]+\.[^:/]+)\/|git@([^:/]+)[:/]|([^/]+):)?([^/\s]+)\/([^/\s#]+)(?:((?:\/[^/\s#]+)+))?(?:\/)?(?:#(.+))?/.exec(src);
+/**
+ * Given a GitHub repository URL, it parses it and returns its coomponents.
+ * @param url - The GitHub repository URL
+ */
+export function parseGitHubRepositoryURL(url) {
+    const match = /^(?:(?:https:\/\/)?([^:/]+\.[^:/]+)\/|git@([^:/]+)[:/]|([^/]+):)?([^/\s]+)\/([^/\s#]+)(?:((?:\/[^/\s#]+)+))?(?:\/)?(?:#(.+))?/.exec(url);
     if (!match) {
         const exampleFormats = [
             'github:user/repo',
@@ -28,7 +38,7 @@ export function parseRepoUrl(src) {
             'user/repo#dev',
             'https://github.com/user/repo',
         ];
-        throw new Abort(`Parsing the url ${src} failed. Supported formats are ${exampleFormats.join(', ')}.`);
+        return err(new Error(`Parsing the url ${url} failed. Supported formats are ${exampleFormats.join(', ')}.`));
     }
     const site = match[1] || match[2] || match[3] || 'github.com';
     const normalizedSite = site === 'github' ? 'github.com' : site;
@@ -40,15 +50,20 @@ export function parseRepoUrl(src) {
     const ssh = `git@${normalizedSite}:${user}/${name}`;
     const http = `https://${normalizedSite}/${user}/${name}`;
     const full = ['https:/', normalizedSite, user, name, subDirectory].join('/').concat(branch);
-    return { full, site: normalizedSite, user, name, ref, subDirectory, ssh, http };
+    return ok({ full, site: normalizedSite, user, name, ref, subDirectory, ssh, http });
 }
-export function parseGithubRepoReference(src) {
-    const url = new URL(src);
+/**
+ * Given a GitHub repository URL it parses it and extracts the branch, file path,
+ * and base URL components
+ * @param reference - A GitHub repository URL (e.g. https://github.com/Shopify/cli/blob/main/package.json)
+ */
+export function parseGitHubRepositoryReference(reference) {
+    const url = new URL(reference);
     const branch = url.hash ? url.hash.slice(1) : undefined;
     const [_, user, repo, ...repoPath] = url.pathname.split('/');
     const filePath = repoPath.length > 0 ? repoPath.join('/') : undefined;
     return {
-        repoBaseUrl: `${url.origin}/${user}/${repo}`,
+        baseURL: `${url.origin}/${user}/${repo}`,
         branch,
         filePath,
     };

package/dist/public/node/github.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"github.js","sourceRoot":"","sources":["../../../src/public/node/github.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,GAAG,EAAE,EAAE,EAAS,MAAM,aAAa,CAAA;AAC3C,OAAO,EAAC,KAAK,EAAC,MAAM,eAAe,CAAA;AACnC,OAAO,EAAC,OAAO,EAAE,KAAK,EAAC,MAAM,iBAAiB,CAAA;AAE9C,MAAM,iBAAkB,SAAQ,KAAK;IACnC,8DAA8D;IAC9D,YAAY,GAAW,EAAE,UAAkB,EAAE,QAAa;QACxD,KAAK,CACH,iCAAiC,GAAG,4BAA4B,UAAU,qCAAqC,QAAQ,CAAC,OAAO,EAAE,CAClI,CAAA;IACH,CAAC;CACF;AAmBD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,KAAa,EACb,IAAY,EACZ,UAAyC,EAAC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,EAAC;IAE7D,KAAK,CAAC,OAAO,CAAA,mDAAmD,KAAK,IAAI,IAAI,KAAK,CAAC,CAAA;IACnF,MAAM,GAAG,GAAG,gCAAgC,KAAK,IAAI,IAAI,WAAW,CAAA;IACpE,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAA;IACpC,8DAA8D;IAC9D,MAAM,QAAQ,GAAQ,MAAM,WAAW,CAAC,IAAI,EAAE,CAAA;IAE9C,IAAI,WAAW,CAAC,MAAM,KAAK,GAAG,EAAE;QAC9B,MAAM,IAAI,iBAAiB,CAAC,GAAG,EAAE,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;KAC/D;IAED,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;AACtC,CAAC;AAaD;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CAAC,GAAW;IAClD,MAAM,KAAK,GACT,+HAA+H,CAAC,IAAI,CAClI,GAAG,CACJ,CAAA;IAEH,IAAI,CAAC,KAAK,EAAE;QACV,MAAM,cAAc,GAAG;YACrB,kBAAkB;YAClB,wBAAwB;YACxB,0BAA0B;YAC1B,eAAe;YACf,8BAA8B;SAC/B,CAAA;QAED,OAAO,GAAG,CAAC,IAAI,KAAK,CAAC,mBAAmB,GAAG,kCAAkC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;KAC5G;IAED,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,IAAI,YAAY,CAAA;IAC7D,MAAM,cAAc,GAAG,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAA;IAC9D,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAE,CAAA;IACtB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;IAC5C,MAAM,YAAY,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAE,CAAA;IACxC,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAE,CAAA;IACrB,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;IACnC,MAAM,GAAG,GAAG,OAAO,cAAc,IAAI,IAAI,IAAI,IAAI,EAAE,CAAA;IACnD,MAAM,IAAI,GAAG,WAAW,cAAc,IAAI,IAAI,IAAI,IAAI,EAAE,CAAA;IACxD,MAAM,IAAI,GAAG,CAAC,SAAS,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAE3F,OAAO,EAAE,CAAC,EAAC,IAAI,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,EAAE,IAAI,EAAC,CAAC,CAAA;AACnF,CAAC;AAQD;;;;GAIG;AACH,MAAM,UAAU,8BAA8B,CAAC,SAAiB;IAC9D,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAA;IAC9B,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACvD,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC5D,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAErE,OAAO;QACL,OAAO,EAAE,GAAG,GAAG,CAAC,MAAM,IAAI,IAAI,IAAI,IAAI,EAAE;QACxC,MAAM;QACN,QAAQ;KACT,CAAA;AACH,CAAC","sourcesContent":["import {err, ok, Result} from './result.js'\nimport {fetch} from '../../http.js'\nimport {content, debug} from '../../output.js'\n\nclass GitHubClientError extends Error {\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  constructor(url: string, statusCode: number, bodyJson: any) {\n    super(\n      `The request to GitHub API URL ${url} failed with status code ${statusCode} and the following error message: ${bodyJson.message}`,\n    )\n  }\n}\n\nexport interface GithubRelease {\n  id: number\n  url: string\n  tag_name: string\n  name: string\n  body: string\n  draft: boolean\n  prerelease: boolean\n  created_at: string\n  published_at: string\n  tarball_url: string\n}\n\ninterface GetLatestGitHubReleaseOptions {\n  filter: (release: GithubRelease) => boolean\n}\n\n/**\n * Given a GitHub repository it obtains the latest release.\n * @param owner - Repository owner (e.g., shopify)\n * @param repo - Repository name (e.g., cli)\n * @param options - Options\n */\nexport async function getLatestGitHubRelease(\n  owner: string,\n  repo: string,\n  options: GetLatestGitHubReleaseOptions = {filter: () => true},\n): Promise<GithubRelease> {\n  debug(content`Getting the latest release of GitHub repository ${owner}/${repo}...`)\n  const url = `https://api.github.com/repos/${owner}/${repo}/releases`\n  const fetchResult = await fetch(url)\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  const jsonBody: any = await fetchResult.json()\n\n  if (fetchResult.status !== 200) {\n    throw new GitHubClientError(url, fetchResult.status, jsonBody)\n  }\n\n  return jsonBody.find(options.filter)\n}\n\ninterface ParseRepositoryURLOutput {\n  full: string\n  site: string\n  user: string\n  name: string\n  ref: string\n  subDirectory: string\n  ssh: string\n  http: string\n}\n\n/**\n * Given a GitHub repository URL, it parses it and returns its coomponents.\n * @param url - The GitHub repository URL\n */\nexport function parseGitHubRepositoryURL(url: string): Result<ParseRepositoryURLOutput, Error> {\n  const match =\n    /^(?:(?:https:\\/\\/)?([^:/]+\\.[^:/]+)\\/|git@([^:/]+)[:/]|([^/]+):)?([^/\\s]+)\\/([^/\\s#]+)(?:((?:\\/[^/\\s#]+)+))?(?:\\/)?(?:#(.+))?/.exec(\n      url,\n    )\n\n  if (!match) {\n    const exampleFormats = [\n      'github:user/repo',\n      'user/repo/subdirectory',\n      'git@github.com:user/repo',\n      'user/repo#dev',\n      'https://github.com/user/repo',\n    ]\n\n    return err(new Error(`Parsing the url ${url} failed. Supported formats are ${exampleFormats.join(', ')}.`))\n  }\n\n  const site = match[1] || match[2] || match[3] || 'github.com'\n  const normalizedSite = site === 'github' ? 'github.com' : site\n  const user = match[4]!\n  const name = match[5]!.replace(/\\.git$/, '')\n  const subDirectory = match[6]?.slice(1)!\n  const ref = match[7]!\n  const branch = ref ? `#${ref}` : ''\n  const ssh = `git@${normalizedSite}:${user}/${name}`\n  const http = `https://${normalizedSite}/${user}/${name}`\n  const full = ['https:/', normalizedSite, user, name, subDirectory].join('/').concat(branch)\n\n  return ok({full, site: normalizedSite, user, name, ref, subDirectory, ssh, http})\n}\n\nexport interface GithubRepositoryReference {\n  baseURL: string\n  branch?: string\n  filePath?: string\n}\n\n/**\n * Given a GitHub repository URL it parses it and extracts the branch, file path,\n * and base URL components\n * @param reference - A GitHub repository URL (e.g. https://github.com/Shopify/cli/blob/main/package.json)\n */\nexport function parseGitHubRepositoryReference(reference: string): GithubRepositoryReference {\n  const url = new URL(reference)\n  const branch = url.hash ? url.hash.slice(1) : undefined\n  const [_, user, repo, ...repoPath] = url.pathname.split('/')\n  const filePath = repoPath.length > 0 ? repoPath.join('/') : undefined\n\n  return {\n    baseURL: `${url.origin}/${user}/${repo}`,\n    branch,\n    filePath,\n  }\n}\n"]}

package/dist/public/node/plugins/tunnel.d.ts

@@ -1,4 +1,4 @@
-import { Result } from '../../common/result.js';
+import { Result } from '../result.js';
 import { FanoutHookFunction, PluginReturnsForHook } from '../../../plugins.js';
 import { ExtendableError } from '../../../error.js';
 export declare type TunnelErrorType = 'invalid-provider' | 'tunnel-already-running' | 'wrong-credentials' | 'unknown';

package/dist/public/node/plugins/tunnel.js

@@ -1,4 +1,4 @@
-import { err } from '../../common/result.js';
+import { err } from '../result.js';
 import { ExtendableError } from '../../../error.js';
 export class TunnelError extends ExtendableError {
     constructor(type, message) {

package/dist/public/node/plugins/tunnel.js.map

@@ -1 +1 @@
-{"version":3,"file":"tunnel.js","sourceRoot":"","sources":["../../../../src/public/node/plugins/tunnel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,GAAG,EAAS,MAAM,wBAAwB,CAAA;AAElD,OAAO,EAAC,eAAe,EAAC,MAAM,mBAAmB,CAAA;AAGjD,MAAM,OAAO,WAAY,SAAQ,eAAe;IAE9C,YAAY,IAAqB,EAAE,OAAgB;QACjD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;CACF;AA2BD,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,KAAqB,EAA0B,EAAE;IAC9E,OAAO,KAAK,IAAI,EAAE,CAAC,KAAK,CAAA;AAC1B,CAAC,CAAA;AACD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,OAAsD,EAAuB,EAAE;IACzG,OAAO,KAAK,EAAE,MAAwC,EAA8B,EAAE;QACpF,IAAI,MAAM,CAAC,QAAQ,KAAK,OAAO,CAAC,QAAQ;YAAE,OAAO,GAAG,CAAC,IAAI,WAAW,CAAC,kBAAkB,CAAC,CAAC,CAAA;QACzF,OAAO,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACpC,CAAC,CAAA;AACH,CAAC,CAAA","sourcesContent":["import {err, Result} from '../../common/result.js'\nimport {FanoutHookFunction, PluginReturnsForHook} from '../../../plugins.js'\nimport {ExtendableError} from '../../../error.js'\n\nexport type TunnelErrorType = 'invalid-provider' | 'tunnel-already-running' | 'wrong-credentials' | 'unknown'\nexport class TunnelError extends ExtendableError {\n  type: TunnelErrorType\n  constructor(type: TunnelErrorType, message?: string) {\n    super(message)\n    this.type = type\n  }\n}\n\n/**\n * Tunnel Plugins types\n *\n * Any plugin that provides tunnel functionality should implement `defineProvider`and `startTunnel`\n */\nexport interface HookReturnPerTunnelPlugin {\n  tunnel_start: {\n    options: {port: number; provider: string}\n    pluginReturns: {\n      [pluginName: string]: Result<{url: string}, TunnelError>\n    }\n  }\n  tunnel_provider: {\n    options: {[key: string]: never}\n    pluginReturns: {\n      [pluginName: string]: {name: string}\n    }\n  }\n}\n\nexport type TunnelProviderFunction = FanoutHookFunction<'tunnel_provider', ''>\nexport type TunnelStartFunction = FanoutHookFunction<'tunnel_start', ''>\nexport type TunnelStartReturn = PluginReturnsForHook<'tunnel_start', ''>\nexport type TunnelStartAction = (port: number) => Promise<TunnelStartReturn>\n\nexport const defineProvider = (input: {name: string}): TunnelProviderFunction => {\n  return async () => input\n}\nexport const startTunnel = (options: {provider: string; action: TunnelStartAction}): TunnelStartFunction => {\n  return async (inputs: {provider: string; port: number}): Promise<TunnelStartReturn> => {\n    if (inputs.provider !== options.provider) return err(new TunnelError('invalid-provider'))\n    return options.action(inputs.port)\n  }\n}\n"]}
+{"version":3,"file":"tunnel.js","sourceRoot":"","sources":["../../../../src/public/node/plugins/tunnel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,GAAG,EAAS,MAAM,cAAc,CAAA;AAExC,OAAO,EAAC,eAAe,EAAC,MAAM,mBAAmB,CAAA;AAGjD,MAAM,OAAO,WAAY,SAAQ,eAAe;IAE9C,YAAY,IAAqB,EAAE,OAAgB;QACjD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;CACF;AA2BD,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,KAAqB,EAA0B,EAAE;IAC9E,OAAO,KAAK,IAAI,EAAE,CAAC,KAAK,CAAA;AAC1B,CAAC,CAAA;AACD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,OAAsD,EAAuB,EAAE;IACzG,OAAO,KAAK,EAAE,MAAwC,EAA8B,EAAE;QACpF,IAAI,MAAM,CAAC,QAAQ,KAAK,OAAO,CAAC,QAAQ;YAAE,OAAO,GAAG,CAAC,IAAI,WAAW,CAAC,kBAAkB,CAAC,CAAC,CAAA;QACzF,OAAO,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACpC,CAAC,CAAA;AACH,CAAC,CAAA","sourcesContent":["import {err, Result} from '../result.js'\nimport {FanoutHookFunction, PluginReturnsForHook} from '../../../plugins.js'\nimport {ExtendableError} from '../../../error.js'\n\nexport type TunnelErrorType = 'invalid-provider' | 'tunnel-already-running' | 'wrong-credentials' | 'unknown'\nexport class TunnelError extends ExtendableError {\n  type: TunnelErrorType\n  constructor(type: TunnelErrorType, message?: string) {\n    super(message)\n    this.type = type\n  }\n}\n\n/**\n * Tunnel Plugins types\n *\n * Any plugin that provides tunnel functionality should implement `defineProvider`and `startTunnel`\n */\nexport interface HookReturnPerTunnelPlugin {\n  tunnel_start: {\n    options: {port: number; provider: string}\n    pluginReturns: {\n      [pluginName: string]: Result<{url: string}, TunnelError>\n    }\n  }\n  tunnel_provider: {\n    options: {[key: string]: never}\n    pluginReturns: {\n      [pluginName: string]: {name: string}\n    }\n  }\n}\n\nexport type TunnelProviderFunction = FanoutHookFunction<'tunnel_provider', ''>\nexport type TunnelStartFunction = FanoutHookFunction<'tunnel_start', ''>\nexport type TunnelStartReturn = PluginReturnsForHook<'tunnel_start', ''>\nexport type TunnelStartAction = (port: number) => Promise<TunnelStartReturn>\n\nexport const defineProvider = (input: {name: string}): TunnelProviderFunction => {\n  return async () => input\n}\nexport const startTunnel = (options: {provider: string; action: TunnelStartAction}): TunnelStartFunction => {\n  return async (inputs: {provider: string; port: number}): Promise<TunnelStartReturn> => {\n    if (inputs.provider !== options.provider) return err(new TunnelError('invalid-provider'))\n    return options.action(inputs.port)\n  }\n}\n"]}