@modern-js/utils 2.12.1-alpha.1 → 2.12.1-alpha.3

package/dist/compiled/inquirer/lib/objects/choice.d.ts

@@ -0,0 +1,65 @@
+import { Answers, CheckboxChoiceOptions, ExpandChoiceOptions, ListChoiceOptions } from '../..';
+
+/**
+ * Represents a choice for several question-types.
+ *
+ * @template T
+ * The type of the answers.
+ */
+declare class Choice<T extends Answers = Answers>
+    implements ListChoiceOptions<T>, CheckboxChoiceOptions<T>, ExpandChoiceOptions {
+    /**
+     * @inheritdoc
+     */
+    type?: 'choice' | undefined;
+
+    /**
+     * @inheritdoc
+     */
+    name: string;
+
+    /**
+     * @inheritdoc
+     */
+    short: string;
+
+    /**
+     * @inheritdoc
+     */
+    value: any;
+
+    /**
+     * @inheritdoc
+     */
+    checked?: boolean | undefined;
+
+    /**
+     * @inheritdoc
+     */
+    disabled: boolean;
+
+    /**
+     * The key to press for selecting the choice.
+     *
+     * @inheritdoc
+     */
+    key?: string | undefined;
+
+    /**
+     * @inheritdoc
+     */
+    extra?: any;
+
+    /**
+     * Initializes a new instance of the `Choice` class.
+     *
+     * @param value
+     * The value of the choice.
+     *
+     * @param answers
+     * An object which contains the answers to the questions.
+     */
+    constructor(value: any, answers: T);
+}
+
+export = Choice;

package/dist/compiled/inquirer/lib/objects/choices.d.ts

@@ -0,0 +1,206 @@
+import { AllChoiceMap, Answers, KeyUnion, UnionToIntersection } from '../..';
+import Choice = require('./choice');
+import Separator = require('./separator');
+
+/**
+ * Represents a valid choice for the `Choices` class.
+ *
+ * @template T
+ * The type of the answers.
+ */
+type DistinctChoice<T extends Answers> = AllChoiceMap<T>[keyof AllChoiceMap<T>];
+
+/**
+ * Represents a valid real choice for the `Choices` class.
+ *
+ * @template T
+ * The type of the answers.
+ */
+type RealChoice<T extends Answers> = Exclude<DistinctChoice<T>, { type: Separator['type'] }>;
+
+/**
+ * Represents a property-name of any choice-type.
+ *
+ * @template T
+ * The type of the answers.
+ */
+type ChoiceProperty<T extends Answers> = KeyUnion<UnionToIntersection<RealChoice<T>>>;
+
+/**
+ * A collection of multiple `Choice`-objects.
+ *
+ * @template T
+ * The type of the answers.
+ */
+declare class Choices<T extends Answers = Answers> {
+    /**
+     * The number of selectable choices.
+     */
+    realLength: number;
+
+    /**
+     * The number of choices.
+     */
+    length: number;
+
+    /**
+     * The unfiltered choices.
+     */
+    choices: Array<DistinctChoice<T>>;
+
+    /**
+     * The selectable choices.
+     */
+    realChoices: Array<RealChoice<T>>;
+
+    /**
+     * Initializes a new instance of the `Choices` class.
+     *
+     * @param choices
+     * The choices to add to the collection.
+     *
+     * @param answers
+     * The `answers`-object.
+     */
+    constructor(choices: Array<DistinctChoice<T>>, answers: T);
+
+    /**
+     * Gets the choice at the specified index.
+     *
+     * @param index
+     * The index of the choice to get.
+     *
+     * @returns
+     * The choice at the specified index.
+     */
+    getChoice(index: number): RealChoice<T>;
+
+    /**
+     * Gets the item at the specified index.
+     *
+     * @param index
+     * The index of the item to get.
+     *
+     * @returns
+     * The item at the specified index.
+     */
+    get(index: number): DistinctChoice<T>;
+
+    /**
+     * Gets all choices which apply to the where-clause.
+     *
+     * @param whereClause
+     * The where-clause to apply.
+     *
+     * @returns
+     * The choices which apply to the where-clause.
+     */
+    where(whereClause: object): Array<RealChoice<T>>;
+
+    /**
+     * Retrieves the specified `property` from all choices.
+     *
+     * @template TProperty
+     * The name of the property to get.
+     *
+     * @param property
+     * The property to query.
+     *
+     * @returns
+     * The value of the property of each choice.
+     */
+    pluck<TProperty extends ChoiceProperty<T>>(
+        property: TProperty | ChoiceProperty<T>,
+    ): Array<(RealChoice<T> & { [key: string]: undefined })[TProperty]>;
+
+    /**
+     * Returns the index of the first occurrence of a value in an array.
+     *
+     * @param searchElement
+     * The value to locate in the array.
+     *
+     * @param fromIndex
+     * The array index at which to begin the search.
+     *
+     * If fromIndex is omitted, the search starts at index 0.
+     *
+     * @returns
+     * The index of the specified `searchElement`.
+     */
+    indexOf(searchElement: Choice<T> | Separator, fromIndex?: number): number;
+
+    /**
+     * Performs the specified action for each element in an array.
+     *
+     * @param callbackfn
+     * A function that accepts up to three arguments.
+     *
+     * `forEach` calls the callbackfn function one time for each element in the array.
+     *
+     * @param thisArg
+     * An object to which the this keyword can refer in the callbackfn function.
+     *
+     * If `thisArg` is omitted, undefined is used as the this value.
+     */
+    forEach(
+        callbackfn: (value: Choice<T> | Separator, index: number, array: Array<Choice<T> | Separator>) => void,
+        thisArg?: any,
+    ): void;
+
+    /**
+     * Returns the elements of an array that meet the condition specified in a callback function.
+     *
+     * @param callbackfn
+     * A function that accepts up to three arguments.
+     *
+     * The filter method calls the `callbackfn` function one time for each element in the array.
+     *
+     * @param thisArg
+     * An object to which the `this` keyword can refer in the callbackfn function.
+     *
+     * If `thisArg` is omitted, undefined is used as the this value.
+     *
+     * @returns
+     * The elements in the collection which meet the conditions.
+     */
+    filter<TElement extends Choice<T> | Separator>(
+        callbackfn: (
+            value: Choice<T> | Separator,
+            index: number,
+            array: Array<Choice<T> | Separator>,
+        ) => value is TElement,
+        thisArg?: any,
+    ): TElement[];
+
+    /**
+     * Returns the value of the first element in the array where predicate is true, and `undefined` otherwise.
+     *
+     * @param predicate
+     * `find` calls `predicate` once for each element of the array, in ascending order, until it finds one where predicate returns `true`.
+     *
+     * If such an element is found, `find` immediately returns that element value.
+     * Otherwise, find returns undefined.
+     *
+     * @param thisArg
+     * If provided, it will be used as the `this` value for each invocation of `predicate`.
+     *
+     * If it is not provided, undefined is used instead.
+     */
+    find(
+        predicate: (value: Choice<T> | Separator, index: number, obj: Array<Choice<T> | Separator>) => boolean,
+        thisArg?: any,
+    ): Choice<T> | Separator;
+
+    /**
+     * Appends new elements to an array, and returns the new length of the array.
+     *
+     * @param items
+     * The elements to add to the array.
+     *
+     * @returns
+     * The new length of the array.
+     */
+    push(...items: Array<Choice<T> | Separator>): number;
+}
+
+export = Choices;

package/dist/compiled/inquirer/lib/objects/separator.d.ts

@@ -0,0 +1,37 @@
+import { SeparatorOptions } from '../..';
+
+/**
+ * Represents a choice-item separator.
+ */
+declare class Separator implements SeparatorOptions {
+    /**
+     * @inheritdoc
+     */
+    readonly type: 'separator';
+
+    /**
+     * @inheritdoc
+     */
+    line: string;
+
+    /**
+     * Initializes a new instance of the `Separator` class.
+     *
+     * @param line
+     * The text of the separator.
+     */
+    constructor(line?: string);
+
+    /**
+     * Checks whether the specified `item` is not a separator.
+     *
+     * @param item
+     * The item to check.
+     *
+     * @returns
+     * A value indicating whether the item is not a separator.
+     */
+    static exclude(item: any): boolean;
+}
+
+export = Separator;

package/dist/compiled/inquirer/lib/ui/baseUI.d.ts

@@ -0,0 +1,37 @@
+import { Interface as ReadlineInterface } from 'readline';
+import inquirer = require('../..');
+
+/**
+ * Represents a ui.
+ */
+declare class UI {
+    /**
+     * Gets or sets an object for performing read from and write to the console.
+     */
+    protected rl: ReadlineInterface;
+
+    /**
+     * Gets or sets the currently active prompt.
+     */
+    protected activePrompt: inquirer.prompts.PromptBase;
+
+    /**
+     * Initializes a new instance of the `UI` class.
+     *
+     * @param options
+     * The input- and output-stream of the ui.
+     */
+    constructor(options?: inquirer.StreamOptions);
+
+    /**
+     * Handles a forced exit of the application.
+     */
+    protected onForceClose(): void;
+
+    /**
+     * Releases all unmanaged resources.
+     */
+    protected close(): void;
+}
+
+export = UI;

package/dist/compiled/inquirer/lib/ui/bottom-bar.d.ts

@@ -0,0 +1,65 @@
+import { ThroughStream } from '../../through';
+import inquirer = require('../..');
+import UI = require('./baseUI');
+
+/**
+ * Represents the bottom-bar UI.
+ */
+declare class BottomBar extends UI {
+    /**
+     * Gets or sets a stream to write logs to.
+     */
+    log: ThroughStream;
+
+    /**
+     * Initializes a new instance of the `BottomBar` class.
+     *
+     * @param options
+     * Provides options for the bottom-bar ui.
+     */
+    constructor(options?: inquirer.ui.BottomBarOptions);
+
+    /**
+     * Renders the specified `text` to the bottom bar.
+     *
+     * @param text
+     * The text to print to the bottom bar.
+     */
+    updateBottomBar(text: string): this;
+
+    /**
+     * Renders the bottom bar.
+     */
+    protected render(): this;
+
+    /**
+     * Clean the bottom bar.
+     */
+    protected clean(): this;
+
+    /**
+     * Writes a message to the bottom bar.
+     *
+     * @param message
+     * The message to write.
+     */
+    protected write(message: string): void;
+
+    /**
+     * Writes the specified `data` to the log-zone.
+     *
+     * @param data
+     * The data to write to the log-zone.
+     */
+    protected writeLog(data: any): this;
+
+    /**
+     * Fixes the new-line characters of the specified `text`.
+     *
+     * @param text
+     * The text to process.
+     */
+    protected enforceLF(text: string): string;
+}
+
+export = BottomBar;

package/dist/compiled/inquirer/lib/ui/prompt.d.ts

@@ -0,0 +1,104 @@
+import { Observable } from '../../rxjs';
+import inquirer = require('../..');
+import UI = require('./baseUI');
+
+/**
+ * Represents the prompt ui.
+ */
+declare class PromptUI<T extends inquirer.Answers = inquirer.Answers> extends UI {
+    /**
+     * Gets or sets the prompts of the ui.
+     */
+    prompts: inquirer.prompts.PromptCollection;
+
+    /**
+     * Gets or sets the answers provided by the user.
+     */
+    answers: T;
+
+    /**
+     * Gets or sets the event-flow of the process.
+     */
+    process: Observable<inquirer.QuestionAnswer<T>>;
+
+    /**
+     * Initializes a new instance of the `PromptUI` class.
+     *
+     * @param prompts
+     * The prompts for the ui.
+     *
+     * @param options
+     * The input- and output-stream of the ui.
+     */
+    constructor(prompts: inquirer.prompts.PromptCollection, options?: inquirer.StreamOptions);
+
+    /**
+     * Runs the prompt-UI.
+     *
+     * @param questions
+     * The questions to prompt the user to answer.
+     *
+     * @returns
+     * The answers provided by the user.
+     */
+    run(questions: Array<inquirer.DistinctQuestion<T>>): Promise<T>;
+
+    /**
+     * Finishes the process.
+     */
+    protected onCompletion(): T;
+
+    /**
+     * Processes a question.
+     *
+     * @param question
+     * The question to process.
+     *
+     * @returns
+     * The answer to the question.
+     */
+    protected processQuestion(
+        question: inquirer.DistinctQuestion<T>,
+    ): Observable<inquirer.ui.FetchedAnswer>;
+
+    /**
+     * Fetches the answer to a question.
+     *
+     * @param question
+     * The question to fetch the answer for.
+     *
+     * @returns
+     * The answer to the question.
+     */
+    protected fetchAnswer(
+        question: inquirer.ui.FetchedQuestion<T>,
+    ): Observable<inquirer.ui.FetchedAnswer>;
+
+    /**
+     * Sets the type of the question if no question-type is specified.
+     *
+     * @param question
+     * The question to set the default type for.
+     *
+     * @returns
+     * The processed question.
+     */
+    protected setDefaultType(
+        question: inquirer.DistinctQuestion<T>,
+    ): Observable<inquirer.DistinctQuestion<T>>;
+
+    /**
+     * Filters the question if it is runnable.
+     *
+     * @param question
+     * The question to filter.
+     *
+     * @returns
+     * Either the event-flow of the question if it is runnable or an empty event-flow.
+     */
+    protected filterIfRunnable(
+        question: inquirer.DistinctQuestion<T>,
+    ): Observable<inquirer.DistinctQuestion<T>>;
+}
+
+export = PromptUI;

package/dist/compiled/inquirer/license

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Simon Boudrias
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

package/dist/compiled/inquirer/package.json

@@ -0,0 +1 @@
+{"name":"inquirer","author":"Simon Boudrias <admin@simonboudrias.com>","version":"8.2.2","license":"MIT"}

package/dist/compiled/inquirer/through/index.d.ts

@@ -0,0 +1,25 @@
+// Type definitions for through
+// Project: https://github.com/dominictarr/through
+// Definitions by: Andrew Gaspar <https://github.com/AndrewGaspar>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+/// <reference types="node" />
+
+import stream = require('stream');
+
+declare function through(
+    write?: (data: any) => void,
+    end?: () => void,
+    opts?: {
+        autoDestroy: boolean;
+    },
+): through.ThroughStream;
+
+declare namespace through {
+    export interface ThroughStream extends stream.Transform {
+        autoDestroy: boolean;
+        queue: (chunk: any) => any;
+    }
+}
+
+export = through;