///
import { FatalError as Fatal } from './error.js';
import { Logger, LogLevel } from './output.js';
import { ConcurrentOutputProps } from '../../private/node/ui/components/ConcurrentOutput.js';
import { handleCtrlC, render } from '../../private/node/ui.js';
import { AlertOptions } from '../../private/node/ui/alert.js';
import { CustomSection } from '../../private/node/ui/components/Alert.js';
import ScalarDict from '../../private/node/ui/components/Table/ScalarDict.js';
import { TableColumn, TableProps } from '../../private/node/ui/components/Table/Table.js';
import { InlineToken, LinkToken, ListToken, TokenItem } from '../../private/node/ui/components/TokenizedText.js';
import { DangerousConfirmationPromptProps } from '../../private/node/ui/components/DangerousConfirmationPrompt.js';
import { SelectPromptProps } from '../../private/node/ui/components/SelectPrompt.js';
import { Task } from '../../private/node/ui/components/Tasks.js';
import { TextPromptProps } from '../../private/node/ui/components/TextPrompt.js';
import { AutocompletePromptProps } from '../../private/node/ui/components/AutocompletePrompt.js';
import { InfoTableSection } from '../../private/node/ui/components/Prompts/InfoTable.js';
import { InfoMessageProps } from '../../private/node/ui/components/Prompts/InfoMessage.js';
import { Key as InkKey, RenderOptions } from 'ink';
type PartialBy = Omit & Partial>;
interface UIDebugOptions {
/** If true, don't check if the current terminal is interactive or not */
skipTTYCheck: boolean;
}
export interface RenderConcurrentOptions extends PartialBy {
renderOptions?: RenderOptions;
}
/**
* Renders output from concurrent processes to the terminal with {@link ConcurrentOutput}.
* @example
* 00:00:00 │ backend │ first backend message
* 00:00:00 │ backend │ second backend message
* 00:00:00 │ backend │ third backend message
* 00:00:00 │ frontend │ first frontend message
* 00:00:00 │ frontend │ second frontend message
* 00:00:00 │ frontend │ third frontend message
*
*/
export declare function renderConcurrent({ renderOptions, ...props }: RenderConcurrentOptions): Promise;
export type AlertCustomSection = CustomSection;
export type RenderAlertOptions = Omit;
/**
* Renders an information banner to the console.
* @example Basic
* ╭─ info ───────────────────────────────────────────────────╮
* │ │
* │ CLI update available. │
* │ │
* │ Run `npm run shopify upgrade`. │
* │ │
* ╰──────────────────────────────────────────────────────────╯
*
* @example Complete
* ╭─ info ───────────────────────────────────────────────────╮
* │ │
* │ my-app initialized and ready to build. │
* │ │
* │ Next steps │
* │ • Run `cd verification-app` │
* │ • To preview your project, run `npm app dev` │
* │ • To add extensions, run `npm generate extension` │
* │ │
* │ Reference │
* │ • Run `npm shopify help` │
* │ • Dev docs [1] │
* │ │
* │ Custom section │
* │ • Item 1 [2] │
* │ • Item 2 │
* │ • Item 3 [3] │
* │ │
* ╰──────────────────────────────────────────────────────────╯
* [1] https://shopify.dev
* [2] https://www.google.com/search?q=jh56t9l34kpo35tw8s28hn7s
* 9s2xvzla01d8cn6j7yq&rlz=1C1GCEU_enUS832US832&oq=jh56t9l34kpo
* 35tw8s28hn7s9s2xvzla01d8cn6j7yq&aqs=chrome.0.35i39l2j0l4j46j
* 69i60.2711j0j7&sourceid=chrome&ie=UTF-8
* [3] https://shopify.com
*
*/
export declare function renderInfo(options: RenderAlertOptions): string | undefined;
/**
* Renders a success banner to the console.
* @example Basic
* ╭─ success ────────────────────────────────────────────────╮
* │ │
* │ CLI updated. │
* │ │
* │ You are now running version 3.47. │
* │ │
* ╰──────────────────────────────────────────────────────────╯
*
* @example Complete
* ╭─ success ────────────────────────────────────────────────╮
* │ │
* │ Deployment successful. │
* │ │
* │ Your extensions have been uploaded to your Shopify │
* │ Partners Dashboard. │
* │ │
* │ Next steps │
* │ • See your deployment and set it live [1] │
* │ │
* ╰──────────────────────────────────────────────────────────╯
* [1] https://partners.shopify.com/1797046/apps/4523695/deploy
* ments
*
*/
export declare function renderSuccess(options: RenderAlertOptions): string | undefined;
/**
* Renders a warning banner to the console.
* @example Basic
* ╭─ warning ────────────────────────────────────────────────╮
* │ │
* │ You have reached your limit of checkout extensions for │
* │ this app. │
* │ │
* │ You can free up space for a new one by deleting an │
* │ existing one. │
* │ │
* ╰──────────────────────────────────────────────────────────╯
*
* @example Complete
* ╭─ warning ────────────────────────────────────────────────╮
* │ │
* │ Required access scope update. │
* │ │
* │ The deadline for re-selecting your app scopes is May │
* │ 1, 2022. │
* │ │
* │ Reference │
* │ • Dev docs [1] │
* │ │
* ╰──────────────────────────────────────────────────────────╯
* [1] https://shopify.dev/app/scopes
*
*/
export declare function renderWarning(options: RenderAlertOptions): string | undefined;
/**
* Renders an error banner to the console.
* @example
* ╭─ error ──────────────────────────────────────────────────╮
* │ │
* │ Version couldn't be released. │
* │ │
* │ This version needs to be submitted for review and │
* │ approved by Shopify before it can be released. │
* │ │
* ╰──────────────────────────────────────────────────────────╯
*
*/
export declare function renderError(options: RenderAlertOptions): string | undefined;
interface RenderFatalErrorOptions {
renderOptions?: RenderOptions;
}
/**
* Renders a Fatal error to the console inside a banner.
* @example Basic
* ╭─ error ──────────────────────────────────────────────────╮
* │ │
* │ Something went wrong. │
* │ │
* │ To investigate the issue, examine this stack trace: │
* │ at _compile (internal/modules/cjs/loader.js:1137) │
* │ at js (internal/modules/cjs/loader.js:1157) │
* │ at load (internal/modules/cjs/loader.js:985) │
* │ at _load (internal/modules/cjs/loader.js:878) │
* │ │
* ╰──────────────────────────────────────────────────────────╯
*
* @example Complete
* ╭─ error ──────────────────────────────────────────────────╮
* │ │
* │ No Organization found │
* │ │
* │ Next steps │
* │ • Have you created a Shopify Partners organization │
* │ [1]? │
* │ • Have you confirmed your accounts from the emails │
* │ you received? │
* │ • Need to connect to a different App or │
* │ organization? Run the command again with `--reset` │
* │ │
* │ amortizable-marketplace-ext │
* │ • Some other error │
* │ Validation errors │
* │ • Missing expected key(s). │
* │ │
* │ amortizable-marketplace-ext-2 │
* │ • Something was not found │
* │ │
* ╰──────────────────────────────────────────────────────────╯
* [1] https://partners.shopify.com/signup
*
*/
export declare function renderFatalError(error: Fatal, { renderOptions }?: RenderFatalErrorOptions): string | undefined;
export interface RenderSelectPromptOptions extends Omit, 'onSubmit'> {
isConfirmationPrompt?: boolean;
renderOptions?: RenderOptions;
}
/**
* Renders a select prompt to the console.
* @example
* ? Associate your project with the org Castile Ventures?
*
* ┃ Add
* ┃ • new-ext
* ┃
* ┃ Remove
* ┃ • integrated-demand-ext
* ┃ • order-discount
*
* Automations
* > fifth
* sixth
*
* Merchant Admin
* eighth
* ninth
*
* Other
* first
* second
* third (limit reached)
* fourth
* seventh
* tenth
*
* Press ↑↓ arrows to select, enter to confirm.
*
*/
export declare function renderSelectPrompt({ renderOptions, isConfirmationPrompt, ...props }: RenderSelectPromptOptions, uiDebugOptions?: UIDebugOptions): Promise;
export interface RenderConfirmationPromptOptions extends Pick, 'message' | 'infoTable' | 'infoMessage' | 'gitDiff' | 'abortSignal'> {
confirmationMessage?: string;
cancellationMessage?: string;
renderOptions?: RenderOptions;
defaultValue?: boolean;
}
/**
* Renders a confirmation prompt to the console.
* @example
* ? Delete the following themes from the store?
*
* ┃ Info message title
* ┃
* ┃ Info message body
* ┃
* ┃ • first theme (#1)
* ┃ • second theme (#2)
*
* > (y) Yes, confirm changes
* (n) Cancel
*
* Press ↑↓ arrows to select, enter or a shortcut to
* confirm.
*
*/
export declare function renderConfirmationPrompt({ message, infoTable, gitDiff, confirmationMessage, cancellationMessage, renderOptions, defaultValue, abortSignal, infoMessage, }: RenderConfirmationPromptOptions): Promise;
export interface RenderAutocompleteOptions extends PartialBy, 'onSubmit'>, 'search'> {
renderOptions?: RenderOptions;
}
/**
* Renders an autocomplete prompt to the console.
* @example
* ? Select a template: Type to search...
*
* ┃ Info message title
* ┃
* ┃ Info message body
*
* > first
* second
* third
* fourth
* fifth
* sixth
* seventh
* eighth
* ninth
* tenth
* eleventh
* twelfth
* thirteenth
* fourteenth
* fifteenth
* sixteenth
* seventeenth
* eighteenth
* nineteenth (disabled)
* twentieth
* twenty-first
* twenty-second
* twenty-third
* twenty-fourth
* twenty-fifth
*
* Press ↑↓ arrows to select, enter to confirm.
*
*/
export declare function renderAutocompletePrompt({ renderOptions, ...props }: RenderAutocompleteOptions, uiDebugOptions?: UIDebugOptions): Promise;
interface RenderTableOptions extends TableProps {
renderOptions?: RenderOptions;
}
/**
* Renders a table to the console.
* @example
* ID Name email
* ── ────────── ─────────────
* 1 John Doe jon@doe.com
* 2 Jane Doe jane@doe.com
* 3 John Smith jon@smith.com
*/
export declare function renderTable({ renderOptions, ...props }: RenderTableOptions): string | undefined;
interface RenderTasksOptions {
renderOptions?: RenderOptions;
}
/**
* Runs async tasks and displays their progress to the console.
* @example
* ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
* Installing dependencies ...
*/
export declare function renderTasks(tasks: Task[], { renderOptions }?: RenderTasksOptions): Promise;
export interface RenderTextPromptOptions extends Omit {
renderOptions?: RenderOptions;
}
/**
* Renders a text prompt to the console.
* @example
* ? App project name (can be changed later):
* > expansive commerce app
* ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
*
*/
export declare function renderTextPrompt({ renderOptions, ...props }: RenderTextPromptOptions, uiDebugOptions?: UIDebugOptions): Promise;
export interface RenderDangerousConfirmationPromptOptions extends Omit {
renderOptions?: RenderOptions;
}
/**
* Renders a dangerous confirmation prompt to the console, forcing the user to
* type a confirmation string to proceed.
* @example
* ? Release a new version of nightly-app-2023-06-19?
*
* ┃ Includes:
* ┃ + web-px (new)
* ┃ + sub-ui-ext
* ┃ + theme-app-ext
* ┃ + paymentify (from Partner Dashboard)
* ┃
* ┃ Removes:
* ┃ - prod-discount-fun
* ┃
* ┃ This can permanently delete app user data.
*
* Type nightly-app-2023-06-19 to confirm, or press Escape
* to cancel.
* > █
* ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
*
*/
export declare function renderDangerousConfirmationPrompt({ renderOptions, ...props }: RenderDangerousConfirmationPromptOptions, uiDebugOptions?: UIDebugOptions): Promise;
interface RenderTextOptions {
text: string;
logLevel?: LogLevel;
logger?: Logger;
}
/** Renders a text string to the console.
* Using this function makes sure that correct spacing is applied among the various components.
* @example
* Hello world!
*
*/
export declare function renderText({ text, logLevel, logger }: RenderTextOptions): string;
/** Waits for any key to be pressed except Ctrl+C which will terminate the process. */
export declare const keypress: (stdin?: NodeJS.ReadStream & {
fd: 0;
}, uiDebugOptions?: UIDebugOptions) => Promise;
export type Key = InkKey;
export type InfoMessage = InfoMessageProps['message'];
export { Task, TokenItem, InlineToken, LinkToken, TableColumn, InfoTableSection, ListToken, render, handleCtrlC };