@bleedingdev/modern-js-utils 3.9.0-ultramodern.2 → 3.9.0-ultramodern.4

package/dist/compiled/inquirer/lib/prompts/list.d.ts

@@ -0,0 +1,89 @@
+import Prompt = require('./base');
+import { Answers, ListQuestionOptions } from '../..';
+import Paginator = require('../utils/paginator');
+import { Interface as ReadlineInterface } from 'readline';
+
+/**
+ * The question-options for the `ListPrompt<T>`.
+ */
+type Question = ListQuestionOptions;
+
+/**
+ * Represents a prompt which provides a list to choose an answer from.
+ *
+ * @template TQuestion
+ * The options for the question.
+ */
+declare class ListPrompt<TQuestion extends Question = Question> extends Prompt<TQuestion> {
+    /**
+     * Resolves the value of the prompt.
+     */
+    protected done: (value: any) => void;
+
+    /**
+     * Gets or sets a value indicating whether the prompt has been rendered the first time.
+     */
+    protected firstRender: boolean;
+
+    /**
+     * The index of the selected choice.
+     */
+    protected selected: number;
+
+    /**
+     * Gets or sets an object for paginating the content.
+     */
+    protected paginator: Paginator;
+
+    /**
+     * Initializes a new instance of the `ListPrompt<T>` class.
+     *
+     * @param question
+     * The question to prompt the user to answer.
+     *
+     * @param readLine
+     * An object for performing read from and write to the console.
+     *
+     * @param answers
+     * The answer-object.
+     */
+    constructor(question: TQuestion, readLine: ReadlineInterface, answers: Answers);
+
+    /**
+     * Renders the prompt.
+     */
+    protected render(): void;
+
+    /**
+     * Gets the current value of the prompt.
+     */
+    protected getCurrentValue(): any;
+
+    /**
+     * Handles the `upKey`-event.
+     */
+    protected onUpKey(): void;
+
+    /**
+     * Handles the `downKey`-event.
+     */
+    protected onDownKey(): void;
+
+    /**
+     * Handles the `numberKey`-event.
+     *
+     * @param input
+     * The number that has been pressed.
+     */
+    protected onNumberKey(input: number): void;
+
+    /**
+     * Handles the `success`-event of the prompt.
+     *
+     * @param value
+     * The value of the prompt.
+     */
+    protected onSubmit(value: any): void;
+}
+
+export = ListPrompt;

package/dist/compiled/inquirer/lib/prompts/number.d.ts

@@ -0,0 +1,32 @@
+import InputPrompt = require('./input');
+import { Answers, NumberQuestionOptions } from '../..';
+import { Interface as ReadlineInterface } from 'readline';
+
+/**
+ * The question for the `NumberPrompt<T>`.
+ */
+type Question = NumberQuestionOptions;
+
+/**
+ * Provides a prompt which allows the user to type a number as answer.
+ *
+ * @template TQuestion
+ * The options for the question.
+ */
+declare class NumberPrompt<TQuestion extends Question = Question> extends InputPrompt<TQuestion> {
+    /**
+     * Initializes a new instance of the `NumberPrompt<T>` class.
+     *
+     * @param question
+     * The question to prompt the user to answer.
+     *
+     * @param readLine
+     * An object for performing read from and write to the console.
+     *
+     * @param answers
+     * The answer-object.
+     */
+    constructor(question: TQuestion, readLine: ReadlineInterface, answers: Answers);
+}
+
+export = NumberPrompt;

package/dist/compiled/inquirer/lib/prompts/password.d.ts

@@ -0,0 +1,82 @@
+import Prompt = require('./base');
+import inquirer = require('../..');
+import { Interface as ReadlineInterface } from 'readline';
+
+/**
+ * The question for the `PasswordPrompt<T>`.
+ */
+type Question = inquirer.PasswordQuestionOptions<inquirer.Answers>;
+
+/**
+ * Represents a prompt which allows the user to type a password.
+ *
+ * @template TQuestion
+ * The options for the question.
+ */
+declare class PasswordPrompt<TQuestion extends Question = Question> extends Prompt<TQuestion> {
+    /**
+     * Resolves the value of the prompt.
+     */
+    protected done: (value: any) => void;
+
+    /**
+     * The answer to this prompt.
+     */
+    protected answer: any;
+
+    /**
+     * Initializes a new instance of the `PasswordPrompt<T>` class.
+     *
+     * @param question
+     * The question to prompt the user to answer.
+     *
+     * @param readLine
+     * An object for performing read from and write to the console.
+     *
+     * @param answers
+     * The answer-object.
+     */
+    constructor(question: TQuestion, readLine: ReadlineInterface, answers: inquirer.Answers);
+
+    /**
+     * Renders the prompt.
+     *
+     * @param error
+     * The error to render.
+     */
+    protected render(error?: string): void;
+
+    /**
+     * Filters the specified `input`.
+     *
+     * @param input
+     * The input to filter.
+     *
+     * @returns
+     * The filtered input.
+     */
+    protected filterInput(input: string): string;
+
+    /**
+     * Handles the `keypress`-event of the prompt.
+     */
+    protected onKeypress(): void;
+
+    /**
+     * Handles the `success`-event of the prompt.
+     *
+     * @param eventArgs
+     * An object which contains event-data.
+     */
+    protected onEnd(eventArgs: inquirer.prompts.SuccessfulPromptStateData): void;
+
+    /**
+     * Handles the `error`-event of the prompt.
+     *
+     * @param eventArgs
+     * An object which contains event-data.
+     */
+    protected onError(eventArgs: inquirer.prompts.FailedPromptStateData): void;
+}
+
+export = PasswordPrompt;

package/dist/compiled/inquirer/lib/prompts/rawlist.d.ts

@@ -0,0 +1,111 @@
+import inquirer = require('../..');
+import Prompt = require('./base');
+import Paginator = require('../utils/paginator');
+import { Interface as ReadlineInterface } from 'readline';
+
+/**
+ * The question for the `RawListPrompt<T>`.
+ */
+type Question = inquirer.RawListQuestionOptions<inquirer.Answers>;
+
+/**
+ * Represents a prompt which provides a list to choose an answer from.
+ *
+ * @template TQuestion
+ * The options for the question.
+ */
+declare class RawListPrompt<TQuestion extends Question = Question> extends Prompt<TQuestion> {
+    /**
+     * Resolves the value of the prompt.
+     */
+    protected done: (value: any) => void;
+
+    /**
+     * The index of the selected choice.
+     */
+    protected selected: number;
+
+    /**
+     * Gets or sets the default index.
+     */
+    protected rawDefault: number;
+
+    /**
+     * Gets or sets an object for paginating the content.
+     */
+    protected paginator: Paginator;
+
+    /**
+     * Initializes a new instance of the `RawListPrompt<T>` class.
+     *
+     * @param question
+     * The question to prompt the user to answer.
+     *
+     * @param readLine
+     * An object for performing read from and write to the console.
+     *
+     * @param answers
+     * The answer-object.
+     */
+    constructor(question: TQuestion, readLine: ReadlineInterface, answers: inquirer.Answers);
+
+    /**
+     * Renders the prompt.
+     *
+     * @param error
+     * The error to render.
+     */
+    protected render(error?: string): void;
+
+    /**
+     * Gets the value of the specified `index`.
+     *
+     * @param index
+     * The index to get the value for.
+     *
+     * @returns
+     * The value of the specified `index`.
+     */
+    protected getCurrentValue(index: number): any;
+
+    /**
+     * Handles the `Keypress`-event of the prompt.
+     */
+    protected onKeypress(): void;
+
+    /**
+     * Handles the `UpdKey`-event of the prompt.
+     */
+    protected onUpKey(): void;
+
+    /**
+     * Handles the `DownKey`-event of the prompt.
+     */
+    protected onDownKey(): void;
+
+    /**
+     * Handles the `ArrowKey`-event of the prompt.
+     *
+     * @param type
+     * A value indicating whether the up or the down-arrow is being pressed.
+     */
+    protected onArrowKey(type: 'up' | 'down'): void;
+
+    /**
+     * Handles the `success`-event of the prompt.
+     *
+     * @param eventArgs
+     * An object which contains event-data.
+     */
+    protected onEnd(eventArgs: inquirer.prompts.SuccessfulPromptStateData): void;
+
+    /**
+     * Handles the `error`-event of the prompt.
+     *
+     * @param eventArgs
+     * An object which contains event-data.
+     */
+    protected onError(): void;
+}
+
+export = RawListPrompt;

package/dist/compiled/inquirer/lib/utils/events.d.ts

@@ -0,0 +1,72 @@
+import { Interface as ReadlineInterface, Key } from 'readline';
+import { Observable } from '../../rxjs';
+
+/**
+ * Provides a description about a key.
+ */
+interface KeyDescriptor {
+    /**
+     * The value of the key.
+     */
+    value: string;
+
+    /**
+     * Thedescription of the key.
+     */
+    key: Key;
+}
+
+/**
+ * A set of events.
+ */
+interface Events {
+    /**
+     * The event-flow of the `line`-event of the readline-object.
+     */
+    line: Observable<string>;
+
+    /**
+     * The event-flow of the `keypress`-event of the readline-object.
+     */
+    keypress: Observable<KeyDescriptor>;
+
+    /**
+     * The event-flow of the `normalizedUpKey`-event.
+     */
+    normalizedUpKey: Observable<KeyDescriptor>;
+
+    /**
+     * The event-flow of the `normalizedDownKey`-event.
+     */
+    normalizedDownKey: Observable<KeyDescriptor>;
+
+    /**
+     * The event-flow of the `numberKey`-event.
+     */
+    numberKey: Observable<KeyDescriptor>;
+
+    /**
+     * The event-flow of the `spaceKey`-event.
+     */
+    spaceKey: Observable<KeyDescriptor>;
+
+    /**
+     * The event-flow of the `aKey`-event.
+     */
+    aKey: Observable<KeyDescriptor>;
+
+    /**
+     * The event-flow of the `iKey`-event.
+     */
+    iKey: Observable<KeyDescriptor>;
+}
+
+/**
+ * Observes a readline-object.
+ *
+ * @param readline
+ * The readline-object to observe.
+ */
+declare function observe(readline: ReadlineInterface): Events;
+
+export = observe;

package/dist/compiled/inquirer/lib/utils/incrementListIndex.d.ts

@@ -0,0 +1,23 @@
+import Choices = require('../objects/choices');
+
+type Direction = 'up' | 'down';
+interface Options {
+    choices: Choices;
+    loop?: boolean;
+}
+
+/**
+ * Find the index of the next answer to be selected.
+ *
+ * @param current
+ * Index of the answer currently selected.
+ * @param dir
+ * Whether to go up or down in the answers list.
+ * @param opt
+ * The option used for the question initialization.
+ * @return
+ * The index of the next answer to be selected.
+ */
+declare function incrementListIndex(current: number, dir: Direction, opt: Options): number;
+
+export = incrementListIndex;

package/dist/compiled/inquirer/lib/utils/paginator.d.ts

@@ -0,0 +1,55 @@
+import ScreenManager = require('./screen-manager');
+
+interface PaginatorOptions {
+    /**
+     * Whether or not to loop the content.
+     */
+    isInfinite: boolean;
+}
+
+/**
+ * Provides the functionality to draw paginated content using a `ScreenManager`.
+ */
+declare class Paginator {
+    /**
+     * Gets or sets the index of the currently focused line.
+     */
+    protected pointer: number;
+
+    /**
+     * Gets or sets the index of the last focused line.
+     */
+    protected lastIndex: number;
+
+    /**
+     * Gets or sets an object for drawing the paginated content.
+     */
+    protected screen: ScreenManager;
+
+    /**
+     * Initializes a new instance of the `Paginator` class.
+     *
+     * @param screenManager
+     * A screen-manager for drawing the paginated content.
+     */
+    constructor(screenManager: ScreenManager, options?: PaginatorOptions);
+
+    /**
+     * Paginates the specified `content`.
+     *
+     * @param content
+     * The content to paginate.
+     *
+     * @param selectedIndex
+     * The number of the selected line.
+     *
+     * @param pageSize
+     * The number of lines to display at a time.
+     *
+     * @returns
+     * The paginated content.
+     */
+    paginate(content: string, selectedIndex: number, pageSize?: number): string;
+}
+
+export = Paginator;

package/dist/compiled/inquirer/lib/utils/readline.d.ts

@@ -0,0 +1,56 @@
+import { Interface as ReadlineInterface } from 'readline';
+
+/**
+ * Moves the cursor to the left.
+ *
+ * @param readLine
+ * The readline-object.
+ *
+ * @param count
+ * The number of columns to move the cursor.
+ */
+export function left(readLine: ReadlineInterface, count: number): void;
+
+/**
+ * Moves the cursor to the right.
+ *
+ * @param readLine
+ * The readline-object.
+ *
+ * @param count
+ * The number of columns to move the cursor.
+ */
+export function right(readLine: ReadlineInterface, count: number): void;
+
+/**
+ * Moves the cursor upwards.
+ *
+ * @param readLine
+ * The readline-object.
+ *
+ * @param count
+ * The number of lines to move the cursor.
+ */
+export function up(readLine: ReadlineInterface, count: number): void;
+
+/**
+ * Moves the cursor downwards.
+ *
+ * @param readLine
+ * The readline-object.
+ *
+ * @param count
+ * The number of lines to move the cursor.
+ */
+export function down(readLine: ReadlineInterface, count: number): void;
+
+/**
+ * Clears one or more lines.
+ *
+ * @param readLine
+ * The readline-object.
+ *
+ * @param count
+ * The number of lines to clear.
+ */
+export function clearLine(readLine: ReadlineInterface, count: number): void;

package/dist/compiled/inquirer/lib/utils/screen-manager.d.ts

@@ -0,0 +1,90 @@
+import { Interface as ReadLineInterface } from 'readline';
+
+/**
+ * Provides the functionality to manage the content of a console-screen.
+ */
+declare class ScreenManager {
+    /**
+     * Gets or sets the height of the screen.
+     */
+    height: number;
+
+    /**
+     * Gets or sets the number of extra-lines below the prompt.
+     */
+    extraLinesUnderPrompt: number;
+
+    /**
+     * Gets or sets an object for performing read from and write to the console.
+     */
+    rl: ReadLineInterface;
+
+    /**
+     * Initializes a new instance of the `ScreenManager` class.
+     *
+     * @param readLine
+     * An object for performing read from and write to the console.
+     */
+    constructor(readLine: ReadLineInterface);
+
+    /**
+     * Renders content to the screen.
+     *
+     * @param content
+     * The content to render.
+     *
+     * @param bottomContent
+     * The content to render to the bottom of the screen.
+     */
+    render(content: string, bottomContent: string): void;
+
+    /**
+     * Cleans all lines expect the first `extraLines`.
+     *
+     * @param extraLines
+     * The number of lines at the begin to skip.
+     */
+    clean(extraLines: number): void;
+
+    /**
+     * Releases all unmanaged resources.
+     */
+    done(): void;
+
+    /**
+     * Releases the cursor.
+     */
+    releaseCursor(): void;
+
+    /**
+     * Identifies the width of the screen.
+     *
+     * @returns
+     * The width of the screen.
+     */
+    protected normalizedCliWidth(): number;
+
+    /**
+     * Splits the `text` into multiple lines with the specified max `width`.
+     *
+     * @param text
+     * The text to process.
+     *
+     * @param width
+     * The max width of each line.
+     */
+    protected breakLines(text: string, width: number): string[];
+
+    /**
+     * Adds line-breaks to the specified `text` with the specified max `width`.
+     *
+     * @param text
+     * The text to process.
+     *
+     * @param width
+     * The max width of each line.
+     */
+    protected forceLineReturn(text: string, width: number): string;
+}
+
+export = ScreenManager;

package/dist/compiled/inquirer/lib/utils/utils.d.ts

@@ -0,0 +1,30 @@
+import { Answers, DistinctQuestion, KeyUnion, UnionToIntersection } from '../..';
+import { Observable } from '../../rxjs';
+
+/**
+ * Represents a property-name of any question-type.
+ */
+type QuestionProperty = KeyUnion<UnionToIntersection<DistinctQuestion>>;
+
+/**
+ * Fetches a property of the specified `question`.
+ *
+ * @param question
+ * The question to fetch the property from.
+ *
+ * @param prop
+ * The name of the property to fetch.
+ *
+ * @param answers
+ * The answers provided by the user.
+ *
+ * @returns
+ * The processed question.
+ */
+export function fetchAsyncQuestionProperty(
+    question: DistinctQuestion,
+    prop: QuestionProperty,
+    answers: Answers,
+): Observable<DistinctQuestion>;
+
+export {};