@codingame/monaco-vscode-chat-service-override 20.1.1 → 20.2.0

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/markdownExtensionsCodec/parsers/frontMatterHeader.d.ts

@@ -3,18 +3,47 @@ import { FrontMatterHeader } from "../tokens/frontMatterHeader.js";
 import { TSimpleDecoderToken } from "../../simpleCodec/simpleDecoder.js";
 import { FrontMatterMarker, TMarkerToken } from "../tokens/frontMatterMarker.js";
 import { ParserBase, TAcceptTokenResult } from "../../simpleCodec/parserBase.js";
+/**
+ * Parses the start marker of a Front Matter header.
+ */
 export declare class PartialFrontMatterStartMarker extends ParserBase<TMarkerToken, PartialFrontMatterStartMarker | PartialFrontMatterHeader> {
     constructor(token: Dash);
     accept(token: TSimpleDecoderToken): TAcceptTokenResult<PartialFrontMatterStartMarker | PartialFrontMatterHeader>;
+    /**
+     * Check if provided dash token can be a start of a Front Matter header.
+     */
     static mayStartHeader(token: TSimpleDecoderToken): token is Dash;
 }
+/**
+ * Parses a Front Matter header that already has a start marker
+ * and possibly some content that follows.
+ */
 export declare class PartialFrontMatterHeader extends ParserBase<TSimpleDecoderToken, PartialFrontMatterHeader | FrontMatterHeader> {
     readonly startMarker: FrontMatterMarker;
+    /**
+     * Parser instance for the end marker of the Front Matter header.
+     */
     private maybeEndMarker?;
     constructor(startMarker: FrontMatterMarker);
     get tokens(): readonly TSimpleDecoderToken[];
+    /**
+     * Convert the current token sequence into a {@link FrontMatterHeader} token.
+     *
+     * Note! that this method marks the current parser object as "consumed"
+     *       hence it should not be used after this method is called.
+     */
     asFrontMatterHeader(): FrontMatterHeader;
     accept(token: TSimpleDecoderToken): TAcceptTokenResult<PartialFrontMatterHeader | FrontMatterHeader>;
+    /**
+     * When a end marker parser is present, we pass all tokens to it
+     * until it is completes the parsing process(either success or failure).
+     */
     private acceptEndMarkerToken;
+    /**
+     * On failure to parse the end marker, we need to continue parsing
+     * the header because there might be another valid end marker in
+     * the stream of tokens. Therefore we copy over the end marker tokens
+     * into the list of "content" tokens and reset the end marker parser.
+     */
     private handleEndMarkerParsingFailure;
 }

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/markdownExtensionsCodec/tokens/frontMatterHeader.d.ts

@@ -3,14 +3,32 @@ import { Range } from "@codingame/monaco-vscode-api/vscode/vs/editor/common/core
 import { MarkdownExtensionsToken } from "./markdownExtensionsToken.js";
 import { TSimpleDecoderToken } from "../../simpleCodec/simpleDecoder.js";
 import { FrontMatterMarker, TMarkerToken } from "./frontMatterMarker.js";
+/**
+ * Token that represents a `Front Matter` header in a text.
+ */
 export declare class FrontMatterHeader extends MarkdownExtensionsToken {
     readonly startMarker: FrontMatterMarker;
     readonly content: Text;
     readonly endMarker: FrontMatterMarker;
     constructor(range: Range, startMarker: FrontMatterMarker, content: Text, endMarker: FrontMatterMarker);
+    /**
+     * Return complete text representation of the token.
+     */
     get text(): string;
+    /**
+     * Range of the content of the Front Matter header.
+     */
     get contentRange(): Range;
+    /**
+     * Content token of the Front Matter header.
+     */
     get contentToken(): Text;
+    /**
+     * Create new instance of the token from the given tokens.
+     */
     static fromTokens(startMarkerTokens: readonly TMarkerToken[], contentTokens: readonly TSimpleDecoderToken[], endMarkerTokens: readonly TMarkerToken[]): FrontMatterHeader;
+    /**
+     * Returns a string representation of the token.
+     */
     toString(): string;
 }

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/markdownExtensionsCodec/tokens/frontMatterMarker.d.ts

@@ -3,12 +3,28 @@ import { Dash } from "../../simpleCodec/tokens/dash.js";
 import { NewLine } from "../../linesCodec/tokens/newLine.js";
 import { MarkdownExtensionsToken } from "./markdownExtensionsToken.js";
 import { CarriageReturn } from "../../linesCodec/tokens/carriageReturn.js";
+/**
+ * Type for tokens inside a Front Matter header marker.
+ */
 export type TMarkerToken = Dash | CarriageReturn | NewLine;
+/**
+ * Marker for the start and end of a Front Matter header.
+ */
 export declare class FrontMatterMarker extends MarkdownExtensionsToken {
     readonly tokens: readonly TMarkerToken[];
+    /**
+     * Returns complete text representation of the token.
+     */
     get text(): string;
+    /**
+     * List of {@link Dash} tokens in the marker.
+     */
     get dashTokens(): readonly Dash[];
     constructor(range: Range, tokens: readonly TMarkerToken[]);
+    /**
+     * Create new instance of the token from a provided
+     * list of tokens.
+     */
     static fromTokens(tokens: readonly TMarkerToken[]): FrontMatterMarker;
     toString(): string;
 }

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/markdownExtensionsCodec/tokens/markdownExtensionsToken.d.ts

@@ -1,3 +1,6 @@
 import { MarkdownToken } from "../../markdownCodec/tokens/markdownToken.js";
+/**
+ * Base class for all tokens produced by the `MarkdownExtensionsDecoder`.
+ */
 export declare abstract class MarkdownExtensionsToken extends MarkdownToken {
 }

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/parserBase.d.ts

@@ -1,24 +1,87 @@
 import { BaseToken } from "../baseToken.js";
+/**
+ * Common interface for a result of accepting a next token
+ * in a sequence.
+ */
 export interface IAcceptTokenResult {
+    /**
+     * The result type of accepting a next token in a sequence.
+     */
     result: "success" | "failure";
+    /**
+     * Whether the token to accept was consumed by the parser
+     * during the accept operation.
+     */
     wasTokenConsumed: boolean;
 }
+/**
+ * Successful result of accepting a next token in a sequence.
+ */
 export interface IAcceptTokenSuccess<T> extends IAcceptTokenResult {
     result: "success";
     nextParser: T;
 }
+/**
+ * Failure result of accepting a next token in a sequence.
+ */
 export interface IAcceptTokenFailure extends IAcceptTokenResult {
     result: "failure";
 }
+/**
+ * The result of operation of accepting a next token in a sequence.
+ */
 export type TAcceptTokenResult<T> = IAcceptTokenSuccess<T> | IAcceptTokenFailure;
+/**
+ * An abstract parser class that is able to parse a sequence of
+ * tokens into a new single entity.
+ */
 export declare abstract class ParserBase<TToken extends BaseToken, TNextObject> {
+    /**
+     * Set of tokens that were accumulated so far.
+     */
     protected readonly currentTokens: TToken[];
+    /**
+     * Whether the parser object was "consumed" and should not be used anymore.
+     */
     protected isConsumed: boolean;
+    /**
+     * Whether the parser object was "consumed" hence must not be used anymore.
+     */
     get consumed(): boolean;
+    /**
+     * Number of tokens at the initialization of the current parser.
+     */
     protected readonly startTokensCount: number;
-    constructor(currentTokens?: TToken[]);
+    constructor(
+    /**
+     * Set of tokens that were accumulated so far.
+     */
+    currentTokens?: TToken[]);
+    /**
+     * Get the tokens that were accumulated so far.
+     */
     get tokens(): readonly TToken[];
+    /**
+     * Accept a new token returning parsing result:
+     *  - successful result must include the next parser object or a fully parsed out token
+     *  - failure result must indicate that the token was not consumed
+     *
+     * @param token The token to accept.
+     * @returns The parsing result.
+     */
     abstract accept(token: TToken): TAcceptTokenResult<TNextObject>;
+    /**
+     * A helper method that validates that the current parser object was not yet consumed,
+     * hence can still be used to accept new tokens in the parsing process.
+     *
+     * @throws if the parser object is already consumed.
+     */
     protected assertNotConsumed(): void;
 }
+/**
+ * Decorator that validates that the current parser object was not yet consumed,
+ * hence can still be used to accept new tokens in the parsing process.
+ *
+ * @throws the resulting decorated method throws if the parser object was already consumed.
+ */
 export declare function assertNotConsumed<T extends ParserBase<BaseToken, unknown>>(_target: T, propertyKey: "accept", descriptor: PropertyDescriptor): PropertyDescriptor;

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/simpleDecoder.d.ts

@@ -6,9 +6,24 @@ import { ISimpleTokenClass } from "./tokens/simpleToken.js";
 import { VSBuffer } from "@codingame/monaco-vscode-api/vscode/vs/base/common/buffer";
 import { BaseDecoder } from "../baseDecoder.js";
 import { ReadableStream } from "@codingame/monaco-vscode-api/vscode/vs/base/common/stream";
+/**
+ * Type for all simple tokens.
+ */
 export type TSimpleToken = Space | Tab | VerticalTab | At | Quote | DoubleQuote | CarriageReturn | NewLine | FormFeed | TBracket | TAngleBracket | TCurlyBrace | TParenthesis | Colon | Hash | Dash | ExclamationMark | Slash | DollarSign | Comma | TLineBreakToken;
+/**
+* Type of tokens emitted by this decoder.
+*/
 export type TSimpleDecoderToken = TSimpleToken | Word;
+/**
+ * List of well-known distinct tokens that this decoder emits (excluding
+ * the word stop characters defined below). Everything else is considered
+ * an arbitrary "text" sequence and is emitted as a single {@link Word} token.
+ */
 export declare const WELL_KNOWN_TOKENS: readonly ISimpleTokenClass<TSimpleToken>[];
+/**
+ * A decoder that can decode a stream of `Line`s into a stream
+ * of simple token, - `Word`, `Space`, `Tab`, `NewLine`, etc.
+ */
 export declare class SimpleDecoder extends BaseDecoder<TSimpleDecoderToken, TLineToken> {
     constructor(stream: ReadableStream<VSBuffer>);
     protected onStreamData(line: TLineToken): void;

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/angleBrackets.d.ts

@@ -1,12 +1,41 @@
 import { SimpleToken } from "./simpleToken.js";
+/**
+ * A token that represent a `<` with a `range`. The `range`
+ * value reflects the position of the token in the original data.
+ */
 export declare class LeftAngleBracket extends SimpleToken<"<"> {
+    /**
+     * The underlying symbol of the token.
+     */
     static readonly symbol: "<";
+    /**
+     * Return text representation of the token.
+     */
     get text(): "<";
+    /**
+     * Returns a string representation of the token.
+     */
     toString(): string;
 }
+/**
+ * A token that represent a `>` with a `range`. The `range`
+ * value reflects the position of the token in the original data.
+ */
 export declare class RightAngleBracket extends SimpleToken<">"> {
+    /**
+     * The underlying symbol of the token.
+     */
     static readonly symbol: ">";
+    /**
+     * Return text representation of the token.
+     */
     get text(): ">";
+    /**
+     * Returns a string representation of the token.
+     */
     toString(): string;
 }
+/**
+ * General angle bracket token type.
+ */
 export type TAngleBracket = LeftAngleBracket | RightAngleBracket;

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/at.d.ts

@@ -1,6 +1,19 @@
 import { SimpleToken } from "./simpleToken.js";
+/**
+ * A token that represent a `@` with a `range`. The `range`
+ * value reflects the position of the token in the original data.
+ */
 export declare class At extends SimpleToken<"@"> {
+    /**
+     * The underlying symbol of the token.
+     */
     static readonly symbol: "@";
+    /**
+     * Return text representation of the token.
+     */
     get text(): "@";
+    /**
+     * Returns a string representation of the token.
+     */
     toString(): string;
 }

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/brackets.d.ts

@@ -1,12 +1,41 @@
 import { SimpleToken } from "./simpleToken.js";
+/**
+ * A token that represent a `[` with a `range`. The `range`
+ * value reflects the position of the token in the original data.
+ */
 export declare class LeftBracket extends SimpleToken<"["> {
+    /**
+     * The underlying symbol of the token.
+     */
     static readonly symbol: "[";
+    /**
+     * Return text representation of the token.
+     */
     get text(): "[";
+    /**
+     * Returns a string representation of the token.
+     */
     toString(): string;
 }
+/**
+ * A token that represent a `]` with a `range`. The `range`
+ * value reflects the position of the token in the original data.
+ */
 export declare class RightBracket extends SimpleToken<"]"> {
+    /**
+     * The underlying symbol of the token.
+     */
     static readonly symbol: "]";
+    /**
+     * Return text representation of the token.
+     */
     get text(): "]";
+    /**
+     * Returns a string representation of the token.
+     */
     toString(): string;
 }
+/**
+ * General bracket token type.
+ */
 export type TBracket = LeftBracket | RightBracket;

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/colon.d.ts

@@ -1,6 +1,19 @@
 import { SimpleToken } from "./simpleToken.js";
+/**
+ * A token that represent a `:` with a `range`. The `range`
+ * value reflects the position of the token in the original data.
+ */
 export declare class Colon extends SimpleToken<":"> {
+    /**
+     * The underlying symbol of the token.
+     */
     static readonly symbol: ":";
+    /**
+     * Return text representation of the token.
+     */
     get text(): ":";
+    /**
+     * Returns a string representation of the token.
+     */
     toString(): string;
 }

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/comma.d.ts

@@ -1,6 +1,19 @@
 import { SimpleToken } from "./simpleToken.js";
+/**
+ * A token that represent a `,` with a `range`. The `range`
+ * value reflects the position of the token in the original data.
+ */
 export declare class Comma extends SimpleToken<","> {
+    /**
+     * The underlying symbol of the token.
+     */
     static readonly symbol: ",";
+    /**
+     * Return text representation of the token.
+     */
     get text(): ",";
+    /**
+     * Returns a string representation of the token.
+     */
     toString(): string;
 }

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/curlyBraces.d.ts

@@ -1,12 +1,41 @@
 import { SimpleToken } from "./simpleToken.js";
+/**
+ * A token that represent a `{` with a `range`. The `range`
+ * value reflects the position of the token in the original data.
+ */
 export declare class LeftCurlyBrace extends SimpleToken<"{"> {
+    /**
+     * The underlying symbol of the token.
+     */
     static readonly symbol: "{";
+    /**
+     * Return text representation of the token.
+     */
     get text(): "{";
+    /**
+     * Returns a string representation of the token.
+     */
     toString(): string;
 }
+/**
+ * A token that represent a `}` with a `range`. The `range`
+ * value reflects the position of the token in the original data.
+ */
 export declare class RightCurlyBrace extends SimpleToken<"}"> {
+    /**
+     * The underlying symbol of the token.
+     */
     static readonly symbol: "}";
+    /**
+     * Return text representation of the token.
+     */
     get text(): "}";
+    /**
+     * Returns a string representation of the token.
+     */
     toString(): string;
 }
+/**
+ * General curly brace token type.
+ */
 export type TCurlyBrace = LeftCurlyBrace | RightCurlyBrace;

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/dash.d.ts

@@ -1,6 +1,19 @@
 import { SimpleToken } from "./simpleToken.js";
+/**
+ * A token that represent a `-` with a `range`. The `range`
+ * value reflects the position of the token in the original data.
+ */
 export declare class Dash extends SimpleToken<"-"> {
+    /**
+     * The underlying symbol of the token.
+     */
     static readonly symbol: "-";
+    /**
+     * Return text representation of the token.
+     */
     get text(): "-";
+    /**
+     * Returns a string representation of the token.
+     */
     toString(): string;
 }

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/dollarSign.d.ts

@@ -1,6 +1,19 @@
 import { SimpleToken } from "./simpleToken.js";
+/**
+ * A token that represent a `$` with a `range`. The `range`
+ * value reflects the position of the token in the original data.
+ */
 export declare class DollarSign extends SimpleToken<"$"> {
+    /**
+     * The underlying symbol of the token.
+     */
     static readonly symbol: "$";
+    /**
+     * Return text representation of the token.
+     */
     get text(): "$";
+    /**
+     * Returns a string representation of the token.
+     */
     toString(): string;
 }

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/doubleQuote.d.ts

@@ -1,8 +1,25 @@
 import { BaseToken } from "../../baseToken.js";
 import { SimpleToken } from "./simpleToken.js";
+/**
+ * A token that represent a `"` with a `range`. The `range`
+ * value reflects the position of the token in the original data.
+ */
 export declare class DoubleQuote extends SimpleToken<"\""> {
+    /**
+     * The underlying symbol of the token.
+     */
     static readonly symbol: "\"";
+    /**
+     * Return text representation of the token.
+     */
     get text(): "\"";
+    /**
+     * Checks if the provided token is of the same type
+     * as the current one.
+     */
     sameType(other: BaseToken): other is typeof this;
+    /**
+     * Returns a string representation of the token.
+     */
     toString(): string;
 }

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/exclamationMark.d.ts

@@ -1,6 +1,19 @@
 import { SimpleToken } from "./simpleToken.js";
+/**
+ * A token that represent a `!` with a `range`. The `range`
+ * value reflects the position of the token in the original data.
+ */
 export declare class ExclamationMark extends SimpleToken<"!"> {
+    /**
+     * The underlying symbol of the token.
+     */
     static readonly symbol: "!";
+    /**
+     * Return text representation of the token.
+     */
     get text(): "!";
+    /**
+     * Returns a string representation of the token.
+     */
     toString(): string;
 }

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/formFeed.d.ts

@@ -1,6 +1,19 @@
 import { SimpleToken } from "./simpleToken.js";
+/**
+ * Token that represent a `form feed` with a `range`. The `range`
+ * value reflects the position of the token in the original data.
+ */
 export declare class FormFeed extends SimpleToken<"\f"> {
+    /**
+     * The underlying symbol of the token.
+     */
     static readonly symbol: "\f";
+    /**
+     * Return text representation of the token.
+     */
     get text(): "\f";
+    /**
+     * Returns a string representation of the token.
+     */
     toString(): string;
 }

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/hash.d.ts

@@ -1,6 +1,19 @@
 import { SimpleToken } from "./simpleToken.js";
+/**
+ * A token that represent a `#` with a `range`. The `range`
+ * value reflects the position of the token in the original data.
+ */
 export declare class Hash extends SimpleToken<"#"> {
+    /**
+     * The underlying symbol of the token.
+     */
     static readonly symbol: "#";
+    /**
+     * Return text representation of the token.
+     */
     get text(): "#";
+    /**
+     * Returns a string representation of the token.
+     */
     toString(): string;
 }

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/parentheses.d.ts

@@ -1,12 +1,41 @@
 import { SimpleToken } from "./simpleToken.js";
+/**
+ * A token that represent a `(` with a `range`. The `range`
+ * value reflects the position of the token in the original data.
+ */
 export declare class LeftParenthesis extends SimpleToken<"("> {
+    /**
+     * The underlying symbol of the token.
+     */
     static readonly symbol: "(";
+    /**
+     * Return text representation of the token.
+     */
     get text(): "(";
+    /**
+     * Returns a string representation of the token.
+     */
     toString(): string;
 }
+/**
+ * A token that represent a `)` with a `range`. The `range`
+ * value reflects the position of the token in the original data.
+ */
 export declare class RightParenthesis extends SimpleToken<")"> {
+    /**
+     * The underlying symbol of the token.
+     */
     static readonly symbol: ")";
+    /**
+     * Return text representation of the token.
+     */
     get text(): ")";
+    /**
+     * Returns a string representation of the token.
+     */
     toString(): string;
 }
+/**
+ * General parenthesis token type.
+ */
 export type TParenthesis = LeftParenthesis | RightParenthesis;

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/quote.d.ts

@@ -1,8 +1,25 @@
 import { BaseToken } from "../../baseToken.js";
 import { SimpleToken } from "./simpleToken.js";
+/**
+ * A token that represent a `'` with a `range`. The `range`
+ * value reflects the position of the token in the original data.
+ */
 export declare class Quote extends SimpleToken<`'`> {
+    /**
+     * The underlying symbol of the token.
+     */
     static readonly symbol: "'";
+    /**
+     * Return text representation of the token.
+     */
     get text(): "'";
+    /**
+     * Checks if the provided token is of the same type
+     * as the current one.
+     */
     sameType(other: BaseToken): other is Quote;
+    /**
+     * Returns a string representation of the token.
+     */
     toString(): string;
 }

package/vscode/src/vs/workbench/contrib/chat/common/promptSyntax/codecs/base/simpleCodec/tokens/simpleToken.d.ts

@@ -1,12 +1,36 @@
 import { BaseToken } from "../../baseToken.js";
 import { Line } from "../../linesCodec/tokens/line.js";
+/**
+ * Interface for a class that can be instantiated into a {@link SimpleToken}.
+ */
 export interface ISimpleTokenClass<TSimpleToken extends SimpleToken<string>> {
+    /**
+     * Character representing the token.
+     */
     readonly symbol: string;
+    /**
+     * Constructor for the token.
+     */
     new (...args: any[]): TSimpleToken;
 }
+/**
+ * Base class for all "simple" tokens with a `range`.
+ * A simple token is the one that represents a single character.
+ */
 export declare abstract class SimpleToken<TSymbol extends string> extends BaseToken<TSymbol> {
+    /**
+     * The underlying symbol of the token.
+     */
     static readonly symbol: string;
+    /**
+     * Create new token instance with range inside
+     * the given `Line` at the given `column number`.
+     */
     static newOnLine<TSimpleToken extends SimpleToken<string>>(line: Line, atColumnNumber: number, Constructor: ISimpleTokenClass<TSimpleToken>): TSimpleToken;
 }
+/**
+ * Base class for all tokens that represent some form of
+ * a spacing character, e.g. 'space', 'tab', etc.
+ */
 export declare abstract class SpacingToken<TSymbol extends string = string> extends SimpleToken<TSymbol> {
 }