@sunafterrainwm/telegram-entities-builder 0.1.4 → 0.2.0

package/dist/index.d.mts

@@ -1,5 +1,6 @@
-import * as TT from '@grammyjs/types';
+import * as TT from "@grammyjs/types";
 
+//#region src/index.d.ts
 type Telegram = TT.ApiMethods<never>;
 type ApiParameters<T extends keyof Telegram> = Parameters<Telegram[T]>[0];
 /**
@@ -18,191 +19,191 @@ type TextSegment = TextSegment.SingleTextSegment | TextSegment.MultiTextSegment;
  * Namespace for TextSegment types.
  */
 declare namespace TextSegment {
-    interface SingleTextSegment {
-        text: string;
-        entity?: AnyDraftEntity;
-        entities?: never;
-    }
-    interface MultiTextSegment {
-        text: string;
-        entity?: never;
-        entities: AnyDraftEntity[];
-    }
+  interface SingleTextSegment {
+    text: string;
+    entity?: AnyDraftEntity;
+    entities?: never;
+  }
+  interface MultiTextSegment {
+    text: string;
+    entity?: never;
+    entities: AnyDraftEntity[];
+  }
 }
 type PartialRequired<T, REQUIRED extends keyof T, OPTIONAL extends keyof T> = Required<Pick<T, REQUIRED>> & Pick<T, OPTIONAL>;
 /**
  * Base interface for entity builders, providing fundamental operations for appending text and managing builder state.
  */
 interface IEntityBuilderBase {
-    /**
-     * Appends plain text.
-     */
-    addText(text: string): this;
-    /**
-     * Appends text with a single entity.
-     */
-    addTextEntity(text: string, entity: AnyDraftEntity): this;
-    /**
-     * Appends text with multiple entities.
-     */
-    addTextEntities(text: string, entities: AnyDraftEntity[]): this;
-    /**
-     * Appends a list of text segments.
-     */
-    addTextSegmentList(segments: TextSegment[]): this;
-    /**
-     * Creates a deep clone of this builder.
-     */
-    clone(): IEntityBuilderBase;
-    /**
-     * Creates a child builder that forks from this instance.
-     */
-    fork(): IEntityBuilderBase;
-    /**
-     * Merges a forked builder back into its parent.
-     */
-    merge(wrapperEntities?: AnyDraftEntity[]): void;
+  /**
+   * Appends plain text.
+   */
+  addText(text: string): this;
+  /**
+   * Appends text with a single entity.
+   */
+  addTextEntity(text: string, entity: AnyDraftEntity): this;
+  /**
+   * Appends text with multiple entities.
+   */
+  addTextEntities(text: string, entities: AnyDraftEntity[]): this;
+  /**
+   * Appends a list of text segments.
+   */
+  addTextSegmentList(segments: TextSegment[]): this;
+  /**
+   * Creates a deep clone of this builder.
+   */
+  clone(): IEntityBuilderBase;
+  /**
+   * Creates a child builder that forks from this instance.
+   */
+  fork(): IEntityBuilderBase;
+  /**
+   * Merges a forked builder back into its parent.
+   */
+  merge(wrapperEntities?: AnyDraftEntity[]): void;
 }
 /**
  * Advanced entity builder interface supporting string manipulation, entity sorting, and payload generation.
  */
 interface IEntityBuilder extends IEntityBuilderBase {
-    /**
-     * Trims or slices the string in-place, and automatically recalculates, filters, or truncates the affected entities.
-     */
-    sliceInplace(start?: number, end?: number): this;
-    /**
-     * Returns a new sliced instance.
-     */
-    slice(start?: number, end?: number): IEntityBuilder;
-    /**
-     * Removes leading whitespace in-place.
-     */
-    trimStart(): this;
-    /**
-     * Removes trailing whitespace in-place.
-     */
-    trimEnd(): this;
-    /**
-     * Removes leading and trailing whitespace in-place.
-     */
-    trim(): this;
-    /**
-     * Sorts the entities based on their offset and length.
-     */
-    sortEntities(): this;
-    /**
-     * Builds the payload for sending a text message.
-     */
-    buildTextPayload(): PartialRequired<ApiParameters<'sendMessage'>, 'text', 'entities' | 'link_preview_options'>;
-    /**
-     * Builds the payload for sending a document with a caption.
-     */
-    buildCaptionPayload(): PartialRequired<ApiParameters<'sendDocument'>, 'caption', 'caption_entities'>;
-    /**
-     * Builds the payload for inline query results.
-     */
-    buildInlinePayload(): PartialRequired<TT.InputTextMessageContent, 'message_text', 'entities' | 'link_preview_options'>;
-    clone(): IEntityBuilder;
-    fork(): IEntityBuilder;
+  /**
+   * Trims or slices the string in-place, and automatically recalculates, filters, or truncates the affected entities.
+   */
+  sliceInplace(start?: number, end?: number): this;
+  /**
+   * Returns a new sliced instance.
+   */
+  slice(start?: number, end?: number): IEntityBuilder;
+  /**
+   * Removes leading whitespace in-place.
+   */
+  trimStart(): this;
+  /**
+   * Removes trailing whitespace in-place.
+   */
+  trimEnd(): this;
+  /**
+   * Removes leading and trailing whitespace in-place.
+   */
+  trim(): this;
+  /**
+   * Sorts the entities based on their offset and length.
+   */
+  sortEntities(): this;
+  /**
+   * Builds the payload for sending a text message.
+   */
+  buildTextPayload(): PartialRequired<ApiParameters<'sendMessage'>, 'text', 'entities' | 'link_preview_options'>;
+  /**
+   * Builds the payload for sending a document with a caption.
+   */
+  buildCaptionPayload(): PartialRequired<ApiParameters<'sendDocument'>, 'caption', 'caption_entities'>;
+  /**
+   * Builds the payload for inline query results.
+   */
+  buildInlinePayload(): PartialRequired<TT.InputTextMessageContent, 'message_text', 'entities' | 'link_preview_options'>;
+  clone(): IEntityBuilder;
+  fork(): IEntityBuilder;
 }
 /**
  * Main implementation of IEntityBuilder that eagerly evaluates and stores entities.
  */
 declare class EntityBuilder implements IEntityBuilder {
-    #private;
-    addText(text: string): this;
-    addTextEntity(text: string, entity: AnyDraftEntity): this;
-    addTextEntities(text: string, entities: AnyDraftEntity[]): this;
-    addTextSegmentList(segments: TextSegment[]): this;
-    buildTextPayload(): {
-        text: string;
-        entities: TT.MessageEntity[];
-    };
-    buildCaptionPayload(): {
-        caption: string;
-        caption_entities: TT.MessageEntity[];
-    };
-    buildInlinePayload(): {
-        message_text: string;
-        entities: TT.MessageEntity[];
-    };
-    sortEntities(): this;
-    sliceInplace(start?: number, end?: number): this;
-    slice(start?: number, end?: number): EntityBuilder;
-    trimStart(): this;
-    trimEnd(): this;
-    trim(): this;
-    clone(): EntityBuilder;
-    fork(): EntityBuilder;
-    /**
-     * Merges a payload text and its entities into this builder, optionally wrapping them with additional entities.
-     */
-    mergePayload(text: string, entities: TT.MessageEntity[], wrappers?: AnyDraftEntity[]): void;
-    merge(wrapperEntities?: AnyDraftEntity[]): void;
+  #private;
+  addText(text: string): this;
+  addTextEntity(text: string, entity: AnyDraftEntity): this;
+  addTextEntities(text: string, entities: AnyDraftEntity[]): this;
+  addTextSegmentList(segments: TextSegment[]): this;
+  buildTextPayload(): {
+    text: string;
+    entities: TT.MessageEntity[];
+  };
+  buildCaptionPayload(): {
+    caption: string;
+    caption_entities: TT.MessageEntity[];
+  };
+  buildInlinePayload(): {
+    message_text: string;
+    entities: TT.MessageEntity[];
+  };
+  sortEntities(): this;
+  sliceInplace(start?: number, end?: number): this;
+  slice(start?: number, end?: number): EntityBuilder;
+  trimStart(): this;
+  trimEnd(): this;
+  trim(): this;
+  clone(): EntityBuilder;
+  fork(): EntityBuilder;
+  /**
+   * Merges a payload text and its entities into this builder, optionally wrapping them with additional entities.
+   */
+  mergePayload(text: string, entities: TT.MessageEntity[], wrappers?: AnyDraftEntity[]): void;
+  merge(wrapperEntities?: AnyDraftEntity[]): void;
 }
 /**
  * A lazy implementation of IEntityBuilderBase that stores segments and flattens them into an EntityBuilder only when needed.
  */
 declare class LazyEntityBuilder implements IEntityBuilderBase {
-    #private;
-    /**
-     * Flattens the lazy segments into a new EntityBuilder instance.
-     */
-    flatten(): EntityBuilder;
-    addText(text: string): this;
-    addTextEntity(text: string, entity: AnyDraftEntity): this;
-    addTextEntities(text: string, entities: AnyDraftEntity[]): this;
-    addTextSegmentList(segments: TextSegment[]): this;
-    clone(): LazyEntityBuilder;
-    fork(): LazyEntityBuilder;
-    merge(wrapperEntities?: AnyDraftEntity[]): void;
+  #private;
+  /**
+   * Flattens the lazy segments into a new EntityBuilder instance.
+   */
+  flatten(): EntityBuilder;
+  addText(text: string): this;
+  addTextEntity(text: string, entity: AnyDraftEntity): this;
+  addTextEntities(text: string, entities: AnyDraftEntity[]): this;
+  addTextSegmentList(segments: TextSegment[]): this;
+  clone(): LazyEntityBuilder;
+  fork(): LazyEntityBuilder;
+  merge(wrapperEntities?: AnyDraftEntity[]): void;
 }
 /**
  * Abstract proxy class that delegates all IEntityBuilder operations to an underlying builder instance.
  */
 declare abstract class EntityBuilderProxy<THIS extends IEntityBuilder = IEntityBuilder> implements IEntityBuilder {
-    protected _entities: IEntityBuilder;
-    protected constructor(_entities: IEntityBuilder);
-    get entities(): IEntityBuilder;
-    addText(...args: Parameters<IEntityBuilder['addText']>): this;
-    addTextEntity(...args: Parameters<IEntityBuilder['addTextEntity']>): this;
-    addTextEntities(...args: Parameters<IEntityBuilder['addTextEntities']>): this;
-    addTextSegmentList(...args: Parameters<IEntityBuilder['addTextSegmentList']>): this;
-    sliceInplace(...args: Parameters<IEntityBuilder['sliceInplace']>): this;
-    slice(...args: Parameters<IEntityBuilder['slice']>): THIS;
-    trim(): this;
-    trimStart(): this;
-    trimEnd(): this;
-    sortEntities(): this;
-    clone(): THIS;
-    fork(): IEntityBuilder;
-    merge(...args: Parameters<IEntityBuilder['merge']>): void;
-    buildTextPayload(): PartialRequired<{
-        business_connection_id?: string;
-        chat_id: number | string;
-        message_thread_id?: number;
-        text: string;
-        parse_mode?: TT.ParseMode;
-        entities?: TT.MessageEntity[];
-        link_preview_options?: TT.LinkPreviewOptions;
-        disable_notification?: boolean;
-        protect_content?: boolean;
-        allow_paid_broadcast?: boolean;
-        message_effect_id?: string;
-        reply_parameters?: TT.ReplyParameters;
-        reply_markup?: TT.InlineKeyboardMarkup | TT.ReplyKeyboardMarkup | TT.ReplyKeyboardRemove | TT.ForceReply;
-        reply_to_message_id?: number;
-    }, "text", "entities" | "link_preview_options">;
-    buildCaptionPayload(): {
-        caption: string;
-        caption_entities: TT.MessageEntity[] | undefined;
-    };
-    buildInlinePayload(): {
-        message_text: string;
-        entities: TT.MessageEntity[] | undefined;
-        link_preview_options: TT.LinkPreviewOptions | undefined;
-    };
+  protected _entities: IEntityBuilder;
+  protected constructor(_entities: IEntityBuilder);
+  get entities(): IEntityBuilder;
+  addText(...args: Parameters<IEntityBuilder['addText']>): this;
+  addTextEntity(...args: Parameters<IEntityBuilder['addTextEntity']>): this;
+  addTextEntities(...args: Parameters<IEntityBuilder['addTextEntities']>): this;
+  addTextSegmentList(...args: Parameters<IEntityBuilder['addTextSegmentList']>): this;
+  sliceInplace(...args: Parameters<IEntityBuilder['sliceInplace']>): this;
+  slice(...args: Parameters<IEntityBuilder['slice']>): THIS;
+  trim(): this;
+  trimStart(): this;
+  trimEnd(): this;
+  sortEntities(): this;
+  clone(): THIS;
+  fork(): IEntityBuilder;
+  merge(...args: Parameters<IEntityBuilder['merge']>): void;
+  buildTextPayload(): PartialRequired<{
+    business_connection_id?: string;
+    chat_id: number | string;
+    message_thread_id?: number;
+    text: string;
+    parse_mode?: TT.ParseMode;
+    entities?: TT.MessageEntity[];
+    link_preview_options?: TT.LinkPreviewOptions;
+    disable_notification?: boolean;
+    protect_content?: boolean;
+    allow_paid_broadcast?: boolean;
+    message_effect_id?: string;
+    reply_parameters?: TT.ReplyParameters;
+    reply_markup?: TT.InlineKeyboardMarkup | TT.ReplyKeyboardMarkup | TT.ReplyKeyboardRemove | TT.ForceReply;
+    reply_to_message_id?: number;
+  }, "text", "entities" | "link_preview_options">;
+  buildCaptionPayload(): {
+    caption: string;
+    caption_entities: TT.MessageEntity[] | undefined;
+  };
+  buildInlinePayload(): {
+    message_text: string;
+    entities: TT.MessageEntity[] | undefined;
+    link_preview_options: TT.LinkPreviewOptions | undefined;
+  };
 }
 /**
  * Escapes a string to be used as a valid tag by removing or replacing invalid characters.
@@ -213,28 +214,29 @@ declare const SymbolMessageComposer: unique symbol;
  * A high-level composer that wraps an IEntityBuilder and provides additional features like tags and link preview options.
  */
 declare class MessageComposer extends EntityBuilderProxy<MessageComposer> {
-    #private;
-    protected [SymbolMessageComposer]: true;
-    /**
-     * Options for link preview generation.
-     */
-    linkPreviewOptions?: TT.LinkPreviewOptions;
-    constructor(entities?: IEntityBuilder & {
-        [SymbolMessageComposer]?: never;
-    });
-    /**
-     * Gets the current list of tags.
-     */
-    get tags(): string[];
-    /**
-     * Adds one or more tags, escaping them and avoiding duplicates.
-     */
-    addTags(...tags: string[]): this;
-    buildTextPayload(): {
-        link_preview_options: TT.LinkPreviewOptions | undefined;
-        text: string;
-        entities?: TT.MessageEntity[] | undefined;
-    };
+  #private;
+  protected [SymbolMessageComposer]: true;
+  /**
+   * Options for link preview generation.
+   */
+  linkPreviewOptions?: TT.LinkPreviewOptions;
+  constructor(entities?: IEntityBuilder & {
+    [SymbolMessageComposer]?: never;
+  });
+  /**
+   * Gets the current list of tags.
+   */
+  get tags(): string[];
+  /**
+   * Adds one or more tags, escaping them and avoiding duplicates.
+   */
+  addTags(...tags: string[]): this;
+  buildTextPayload(): {
+    link_preview_options: TT.LinkPreviewOptions | undefined;
+    text: string;
+    entities?: TT.MessageEntity[] | undefined;
+  };
 }
-
-export { type AnyDraftEntity, EntityBuilder, EntityBuilderProxy, type IEntityBuilder, type IEntityBuilderBase, LazyEntityBuilder, MessageComposer, type PartialEntity, TextSegment, escapeTag };
+//#endregion
+export { AnyDraftEntity, EntityBuilder, EntityBuilderProxy, IEntityBuilder, IEntityBuilderBase, LazyEntityBuilder, MessageComposer, MessageComposer as default, PartialEntity, TextSegment, escapeTag };
+//# sourceMappingURL=index.d.mts.map