@shopify/cli-kit 3.44.1 → 3.45.0-pre.2

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

@@ -1,7 +1,8 @@
 import { FatalError as Fatal } from './error.js';
 import { Logger, LogLevel } from './output.js';
 import { ConcurrentOutputProps } from '../../private/node/ui/components/ConcurrentOutput.js';
-import { AlertProps, CustomSection } from '../../private/node/ui/components/Alert.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 { SelectPromptProps } from '../../private/node/ui/components/SelectPrompt.js';
@@ -16,226 +17,286 @@ export interface RenderConcurrentOptions extends PartialBy<ConcurrentOutputProps
 }
 /**
  * Renders output from concurrent processes to the terminal with {@link ConcurrentOutput}.
+ * @example
+ * 0000-00-00 00:00:00 | backend  | first backend message
+ * 0000-00-00 00:00:00 | backend  | second backend message
+ * 0000-00-00 00:00:00 | backend  | third backend message
+ * 0000-00-00 00:00:00 | frontend | first frontend message
+ * 0000-00-00 00:00:00 | frontend | second frontend message
+ * 0000-00-00 00:00:00 | frontend | third frontend message
+ *
+ * › Press p | open your browser
+ * › Press q | quit.
+ *
+ * Preview URL: https://shopify.com
+ *
  */
 export declare function renderConcurrent({ renderOptions, ...props }: RenderConcurrentOptions): Promise<void>;
 export type AlertCustomSection = CustomSection;
-export type RenderAlertOptions = Omit<AlertProps, 'type'>;
+export type RenderAlertOptions = Omit<AlertOptions, 'type'>;
 /**
  * Renders an information banner to the console.
- *
- * Basic:
- *
- * ```
+ * @example Basic
  * ╭─ info ───────────────────────────────────────────────────╮
  * │                                                          │
- * │  Body                                                    │
+ * │  CLI update available                                    │
+ * │                                                          │
+ * │  Run `npm run shopify upgrade`.                          │
  * │                                                          │
  * ╰──────────────────────────────────────────────────────────╯
- * ```
  *
- * Complete:
- * ```
+ * @example Complete
  * ╭─ info ───────────────────────────────────────────────────╮
  * │                                                          │
- * │  Title                                                   │
- * │                                                          │
- * │  Body                                                    │
+ * │  my-app initialized and ready to build.                  │
  * │                                                          │
  * │  Next steps                                              │
- * │    • Run `cd santorini-goods`                            │
+ * │    • Run `cd verification-app`                           │
  * │    • To preview your project, run `npm app dev`          │
  * │    • To add extensions, run `npm generate extension`     │
  * │                                                          │
  * │  Reference                                               │
  * │    • Run `npm shopify help`                              │
- * │    • Press 'return' to open the dev docs:                │
- * │      https://shopify.dev                                 │
+ * │    • Dev docs ( https://shopify.dev )                    │
  * │                                                          │
- * │  Link: https://shopify.com                               │
+ * │  Custom section                                          │
+ * │    • Item 1                                              │
+ * │    • Item 2                                              │
+ * │    • Item 3                                              │
  * │                                                          │
  * ╰──────────────────────────────────────────────────────────╯
- * ```
+ *
  */
-export declare function renderInfo(options: RenderAlertOptions): void;
+export declare function renderInfo(options: RenderAlertOptions): string | undefined;
 /**
  * Renders a success banner to the console.
- *
- * Basic:
- *
- * ```
+ * @example Basic
  * ╭─ success ────────────────────────────────────────────────╮
  * │                                                          │
- * │  Title                                                   │
+ * │  CLI updated.                                            │
+ * │                                                          │
+ * │  You are now running version 3.47.                       │
  * │                                                          │
  * ╰──────────────────────────────────────────────────────────╯
- * ```
  *
- * Complete:
- * ```
+ * @example Complete
  * ╭─ success ────────────────────────────────────────────────╮
  * │                                                          │
- * │  Title                                                   │
+ * │  Deployment successful.                                  │
  * │                                                          │
- * │  Body                                                    │
+ * │  Your extensions have been uploaded to your Shopify      │
+ * │  Partners Dashboard.                                     │
  * │                                                          │
  * │  Next steps                                              │
- * │    • Run `cd santorini-goods`                              │
- * │    • To preview your project, run `npm app dev`            │
- * │    • To add extensions, run `npm generate extension`       │
- * │                                                          │
- * │  Reference                                               │
- * │    • Run `npm shopify help`                                │
- * │    • Press 'return' to open the dev docs:                │
- * │      https://shopify.dev                                 │
- * │                                                          │
- * │  Link: https://shopify.com                               │
+ * │    • See your deployment and set it live ( https://part  │
+ * │      ners.shopify.com/1797046/apps/4523695/deployments   │
+ * │      )                                                   │
  * │                                                          │
  * ╰──────────────────────────────────────────────────────────╯
- * ```
+ *
  */
-export declare function renderSuccess(options: RenderAlertOptions): void;
+export declare function renderSuccess(options: RenderAlertOptions): string | undefined;
 /**
  * Renders a warning banner to the console.
- *
- * Basic:
- *
- * ```
+ * @example Basic
  * ╭─ warning ────────────────────────────────────────────────╮
  * │                                                          │
- * │  Title                                                   │
+ * │  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.                                           │
  * │                                                          │
  * ╰──────────────────────────────────────────────────────────╯
- * ```
  *
- * Complete:
- * ```
+ * @example Complete
  * ╭─ warning ────────────────────────────────────────────────╮
  * │                                                          │
- * │  Title                                                   │
+ * │  Required access scope update.                           │
  * │                                                          │
- * │  Body                                                    │
- * │                                                          │
- * │  Next steps                                              │
- * │    • Run `cd santorini-goods`                            │
- * │    • To preview your project, run `npm app dev`          │
- * │    • To add extensions, run `npm generate extension`     │
+ * │  The deadline for re-selecting your app scopes is May    │
+ * │  1, 2022.                                                │
  * │                                                          │
  * │  Reference                                               │
- * │    • Run `npm shopify help`                              │
- * │    • Press 'return' to open the dev docs:                │
- * │      https://shopify.dev                                 │
- * │                                                          │
- * │  Link: https://shopify.com                               │
+ * │    • Dev docs ( https://shopify.dev/app/scopes )         │
  * │                                                          │
  * ╰──────────────────────────────────────────────────────────╯
- * ```
+ *
  */
-export declare function renderWarning(options: RenderAlertOptions): void;
+export declare function renderWarning(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 ──────────────────────────────────────────────────╮
  * │                                                          │
- * │  Couldn't connect to the Shopify Partner Dashboard.      │
+ * │  No Organization found                                   │
  * │                                                          │
- * │  Check your internet connection and try again.           │
+ * │  Next steps                                              │
+ * │    • Have you created a Shopify Partners organization (  │
+ * │       https://partners.shopify.com/signup )?             │
+ * │    • 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`  │
  * │                                                          │
  * ╰──────────────────────────────────────────────────────────╯
- * ```
+ *
  */
-export declare function renderFatalError(error: Fatal): void;
+export declare function renderFatalError(error: Fatal, { renderOptions }?: RenderFatalErrorOptions): string | undefined;
+export interface RenderSeletPromptOptions<T> extends Omit<SelectPromptProps<T>, 'onSubmit'> {
+    renderOptions?: RenderOptions;
+}
 /**
  * Renders a select prompt to the console.
- *
- * ```
+ * @example
  * ?  Associate your project with the org Castile Ventures?
  *
- *      Add:     • new-ext
+ *        Add:     • new-ext
  *
- *      Remove:  • integrated-demand-ext
- *               • order-discount
+ *        Remove:  • integrated-demand-ext
+ *                 • order-discount
  *
- * \>  (f) first
- *     (s) second
- *     (3) third
- *     (4) fourth
- *     (5) seventh
- *     (6) tenth
+ *    Automations
+ * >  (a) fifth
+ *    (2) sixth
  *
- *     Automations
- *     (7) fifth
- *     (8) sixth
+ *    Merchant Admin
+ *    (3) eighth
+ *    (4) ninth
  *
- *     Merchant Admin
- *     (9) eighth
- *     (10) ninth
+ *    Other
+ *    (f) first
+ *    (s) second
+ *    (7) third
+ *    (8) fourth
+ *    (9) seventh
+ *    (10) tenth
+ *
+ *    Press ↑↓ arrows to select, enter to confirm
  *
- *     Press ↑↓ arrows to select, enter to confirm
- * ```
  */
-export declare function renderSelectPrompt<T>(props: Omit<SelectPromptProps<T>, 'onSubmit'>): Promise<T>;
+export declare function renderSelectPrompt<T>({ renderOptions, ...props }: RenderSeletPromptOptions<T>): Promise<T>;
 export interface RenderConfirmationPromptOptions extends Pick<SelectPromptProps<boolean>, 'message' | 'infoTable'> {
     confirmationMessage?: string;
     cancellationMessage?: string;
+    renderOptions?: RenderOptions;
 }
 /**
  * Renders a confirmation prompt to the console.
+ * @example
+ * ?  Delete the following themes from the store?
  *
- * ?  Do you want to continue?
+ *        • first theme (#1)
+ *        • second theme (#2)
  *
- * \>  (y) Yes, confirm
- *     (n) No, canccel
+ * >  (y) Yes, confirm changes
+ *    (n) Cancel
+ *
+ *    Press ↑↓ arrows to select, enter or a shortcut to confirm
  *
- *     Press ↑↓ arrows to select, enter to confirm
  */
-export declare function renderConfirmationPrompt({ message, infoTable, confirmationMessage, cancellationMessage, }: RenderConfirmationPromptOptions): Promise<boolean>;
+export declare function renderConfirmationPrompt({ message, infoTable, confirmationMessage, cancellationMessage, renderOptions, }: RenderConfirmationPromptOptions): Promise<boolean>;
+export interface RenderAutocompleteOptions<T> extends PartialBy<Omit<AutocompletePromptProps<T>, 'onSubmit'>, 'search'> {
+    renderOptions?: RenderOptions;
+}
 /**
  * Renders an autocomplete prompt to the console.
- * ```
- * ?  Select a template  Type to search...
-
- * \>  first
- *     second
- *     third
-
- *  Press ↑↓ arrows to select, enter to confirm
- * ```
+ * @example
+ * ?  Select a template:   Type to search...
+ *
+ * >  first
+ *    second
+ *    third
+ *    fourth
+ *    fifth
+ *    sixth
+ *    seventh
+ *    eighth
+ *    ninth
+ *    tenth
+ *    eleventh
+ *    twelfth
+ *    thirteenth
+ *    fourteenth
+ *    fifteenth
+ *    sixteenth
+ *    seventeenth
+ *    eighteenth
+ *    nineteenth
+ *    twentieth
+ *    twenty-first
+ *    twenty-second
+ *    twenty-third
+ *    twenty-fourth
+ *    twenty-fifth
+ *
+ *    Press ↑↓ arrows to select, enter to confirm
+ *
  */
-export declare function renderAutocompletePrompt<T>(props: PartialBy<Omit<AutocompletePromptProps<T>, 'onSubmit'>, 'search'>): Promise<T>;
+export declare function renderAutocompletePrompt<T>({ renderOptions, ...props }: RenderAutocompleteOptions<T>): Promise<T>;
+interface RenderTableOptions<T extends ScalarDict> extends TableProps<T> {
+    renderOptions?: RenderOptions;
+}
 /**
  * Renders a table to the console.
- *
- * ```
- * name                      role           Identifier
- * ────────────────────────  ─────────────  ──────────
- * Dawn                      [live]         #1361
- * Studio                                   #1363
- * Debut                     [unpublished]  #1374
- * Development (1a23b4-MBP)  [development]  #1368
- * ```
+ * @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<T extends ScalarDict>(props: TableProps<T>): void;
+export declare function renderTable<T extends ScalarDict>({ renderOptions, ...props }: RenderTableOptions<T>): string | undefined;
+interface RenderTasksOptions {
+    renderOptions?: RenderOptions;
+}
 /**
  * Runs async tasks and displays their progress to the console.
+ * @example
+ * ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
+ * Installing dependencies ...
  */
-export declare function renderTasks<TContext>(tasks: Task<TContext>[]): Promise<void>;
+export declare function renderTasks<TContext>(tasks: Task<TContext>[], { renderOptions }?: RenderTasksOptions): Promise<void>;
+export interface RenderTextPromptOptions extends Omit<TextPromptProps, 'onSubmit'> {
+    renderOptions?: RenderOptions;
+}
 /**
  * Renders a text prompt to the console.
- * ```
- * ?  What is your name?
- * \>  John
- * ```
+ * @example
+ * ?  App project name (can be changed later):
+ * >  expansive commerce app
+ *    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
+ *
  */
-export declare function renderTextPrompt(props: Omit<TextPromptProps, 'onSubmit'>): Promise<string>;
+export declare function renderTextPrompt({ renderOptions, ...props }: RenderTextPromptOptions): Promise<string>;
 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. */
-export declare function renderText({ text, logLevel, logger }: RenderTextOptions): void;
+ * 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: () => Promise<unknown>;
 export type Key = InkKey;