@mnaoumov/typescript-lib 0.0.0 → 1.0.1

package/dist/lib/cjs/string.d.cts

@@ -0,0 +1,362 @@
+/// <reference path="./library-references.d.cts" />
+/// <reference lib="dom" />
+/**
+ * @file
+ *
+ * Contains utility functions for string operations.
+ */
+import type { MaybeReturn } from './type.cjs';
+import type { ValueProvider } from './value-provider.cjs';
+/**
+ * An empty string constant.
+ *
+ * A shared sentinel for the `${EMPTY}` prefix that silences the `obsidianmd/ui/sentence-case` ESLint
+ * false positive on legitimate lower-case UI text (e.g. `cursor` colliding with the `Cursor` brand).
+ * `setName(`${EMPTY}...at cursor...`)` renders byte-identical `''` at runtime while the `{...}`
+ * placeholder makes the rule skip the string. Consumers import this instead of redefining a per-file
+ * `const EMPTY = ''`.
+ */
+export declare const EMPTY = "";
+/**
+ * A synchronous/asynchronous function that generates replacement strings, or a string to replace with.
+ *
+ * @typeParam CapturedGroupArguments - The types of the captured group arguments.
+ */
+export type AsyncReplacer<CapturedGroupArguments extends string[]> = ValueProvider<StringReplacement, ReplaceArguments<CapturedGroupArguments>>;
+/**
+ * Common arguments for the `replaceAll`/`replaceAllAsync` functions.
+ *
+ * @typeParam CapturedGroupArguments - The types of the captured group arguments.
+ */
+export interface ReplaceArguments<CapturedGroupArguments extends string[]> {
+    /**
+     * Captured group arguments.
+     */
+    capturedGroupArguments: CapturedGroupArguments;
+    /**
+     * Groups of the match.
+     */
+    groups: Record<string, string | undefined> | undefined;
+    /**
+     * Indices of the groups that were not found in the match.
+     */
+    missingGroupIndices: number[];
+    /**
+     * An offset of the match.
+     */
+    offset: number;
+    /**
+     * A source of the match.
+     */
+    source: string;
+    /**
+     * A substring of the match.
+     */
+    substring: string;
+}
+/**
+ * A synchronous function that generates replacement strings, or a string to replace with.
+ *
+ * @typeParam CapturedGroupArguments - The types of the captured group arguments.
+ */
+export type Replacer<CapturedGroupArguments extends string[]> = (($arguments: ReplaceArguments<CapturedGroupArguments>) => StringReplacement) | StringReplacement;
+type StringReplacement = MaybeReturn<string>;
+/**
+ * Parameters for {@link ensureEndsWith}.
+ */
+export interface EnsureEndsWithParams {
+    /**
+     * The string to check.
+     */
+    readonly $string: string;
+    /**
+     * The suffix to ensure.
+     */
+    readonly suffix: string;
+}
+/**
+ * Parameters for {@link ensureStartsWith}.
+ */
+export interface EnsureStartsWithParams {
+    /**
+     * The string to check.
+     */
+    readonly $string: string;
+    /**
+     * The prefix to ensure.
+     */
+    readonly prefix: string;
+}
+/**
+ * Parameters for {@link hasSingleOccurrence}.
+ */
+export interface HasSingleOccurrenceParams {
+    /**
+     * The string to check.
+     */
+    readonly $string: string;
+    /**
+     * The search value to check for.
+     */
+    readonly searchValue: string;
+}
+/**
+ * Parameters for {@link indent}.
+ */
+export interface IndentParams {
+    /**
+     * The prefix to add to each line.
+     */
+    readonly prefix: string;
+    /**
+     * The string to indent.
+     */
+    readonly text: string;
+}
+/**
+ * Parameters for {@link insertAt}.
+ */
+export interface InsertAtParams {
+    /**
+     * The string to insert the substring into.
+     */
+    readonly $string: string;
+    /**
+     * The index to end the substring at.
+     */
+    readonly endIndex?: number;
+    /**
+     * The index to insert the substring at.
+     */
+    readonly startIndex: number;
+    /**
+     * The substring to insert.
+     */
+    readonly substring: string;
+}
+/**
+ * Parameters for {@link replaceAllAsync}.
+ *
+ * @typeParam ReplaceGroupArguments - The types of the captured group arguments.
+ */
+export interface ReplaceAllAsyncParams<ReplaceGroupArguments extends string[]> {
+    /**
+     * The string in which to perform replacements.
+     */
+    readonly $string: string;
+    /**
+     * The abort signal to control the execution of the function.
+     */
+    readonly abortSignal?: AbortSignal;
+    /**
+     * A synchronous/asynchronous function that generates replacement strings, or a string to replace with.
+     */
+    readonly replacer: AsyncReplacer<ReplaceGroupArguments>;
+    /**
+     * The string or regular expression to search for.
+     */
+    readonly searchValue: RegExp | string;
+}
+/**
+ * Parameters for {@link replaceAll}.
+ *
+ * @typeParam CapturedGroupArguments - The types of the captured group arguments.
+ */
+export interface ReplaceAllParams<CapturedGroupArguments extends string[]> {
+    /**
+     * The string in which to perform replacements.
+     */
+    readonly $string: string;
+    /**
+     * A replacer function that generates replacement strings, or a string to replace with.
+     */
+    readonly replacer: Replacer<CapturedGroupArguments>;
+    /**
+     * The string or regular expression to search for.
+     */
+    readonly searchValue: RegExp | string;
+}
+/**
+ * Parameters for {@link trimEnd}.
+ */
+export interface TrimEndParams {
+    /**
+     * The string to trim.
+     */
+    readonly $string: string;
+    /**
+     * If `true`, throws an error if the string does not end with the suffix.
+     *
+     * @default `false`
+     */
+    readonly shouldValidate?: boolean;
+    /**
+     * The suffix to remove from the end of the string.
+     */
+    readonly suffix: string;
+}
+/**
+ * Parameters for {@link trimStart}.
+ */
+export interface TrimStartParams {
+    /**
+     * The string to trim.
+     */
+    readonly $string: string;
+    /**
+     * The prefix to remove from the start of the string.
+     */
+    readonly prefix: string;
+    /**
+     * If `true`, throws an error if the string does not start with the prefix.
+     *
+     * @default `false`
+     */
+    readonly shouldValidate?: boolean;
+}
+/**
+ * Parameters for {@link unindent}.
+ */
+export interface UnindentParams {
+    /**
+     * The prefix to remove from each line.
+     */
+    readonly prefix: string;
+    /**
+     * If `true`, throws an error if a line is not indented with the prefix.
+     *
+     * @default `false`
+     */
+    readonly shouldThrowIfNotIndented?: boolean;
+    /**
+     * The string to unindent.
+     */
+    readonly text: string;
+}
+/**
+ * Ensures that a string ends with the specified suffix, adding it if necessary.
+ *
+ * @param params - The parameters.
+ * @returns The string that ends with the suffix.
+ */
+export declare function ensureEndsWith(params: EnsureEndsWithParams): string;
+/**
+ * Ensures that a string has `LF` line endings.
+ *
+ * It replaces `CRLF` line endings with `LF`.
+ *
+ * @param $string - The string.
+ * @returns The string with `LF` line endings.
+ */
+export declare function ensureLfEndings($string: string): string;
+/**
+ * Ensures that a string starts with the specified prefix, adding it if necessary.
+ *
+ * @param params - The parameters.
+ * @returns The string that starts with the prefix.
+ */
+export declare function ensureStartsWith(params: EnsureStartsWithParams): string;
+/**
+ * Escapes special characters in a string.
+ *
+ * @param $string - The string to escape.
+ * @returns The escaped string.
+ */
+export declare function escape($string: string): string;
+/**
+ * Returns a function that maps LF-normalized offsets to original offsets.
+ *
+ * @param $string - The string to get the LF-normalized indices from.
+ * @returns A function that maps LF-normalized offsets to original offsets.
+ */
+export declare function getLfNormalizedOffsetToOriginalOffsetMapper($string: string): (lfOffset: number) => number;
+/**
+ * Checks if a string has a single occurrence of a search value.
+ *
+ * @param params - The parameters.
+ * @returns `true` if the string has a single occurrence of the search value, `false` otherwise.
+ */
+export declare function hasSingleOccurrence(params: HasSingleOccurrenceParams): boolean;
+/**
+ * Indents a string by adding a prefix to each line.
+ *
+ * @param params - The parameters.
+ * @returns The indented string.
+ */
+export declare function indent(params: IndentParams): string;
+/**
+ * Inserts a substring at a specified position in a string.
+ *
+ * @param params - The parameters.
+ * @returns The modified string with the substring inserted.
+ */
+export declare function insertAt(params: InsertAtParams): string;
+/**
+ * Converts a string into a valid JavaScript variable name by replacing invalid characters with underscores.
+ *
+ * @param $string - The string to convert.
+ * @returns The valid variable name.
+ */
+export declare function makeValidVariableName($string: string): string;
+/**
+ * Normalizes a string by converting it to the NFC form and replacing non-breaking spaces with regular spaces.
+ *
+ * @param $string - The string to normalize.
+ * @returns The normalized string.
+ */
+export declare function normalizeString($string: string): string;
+/**
+ * Replaces occurrences of strings in a given string based on a replacements map.
+ *
+ * @param $string - The string to perform replacements on.
+ * @param replacementsMap - An object mapping strings to their replacement values.
+ * @returns The modified string with replacements applied.
+ */
+export declare function replace($string: string, replacementsMap: Record<string, string>): string;
+/**
+ * Replaces all occurrences of a search string or pattern with the results of an replacer function.
+ *
+ * @typeParam CapturedGroupArguments - The types of the captured group arguments.
+ * @param params - The parameters.
+ * @returns The string with all replacements made.
+ */
+export declare function replaceAll<CapturedGroupArguments extends string[]>(params: ReplaceAllParams<CapturedGroupArguments>): string;
+/**
+ * Asynchronously replaces all occurrences of a search string or pattern with the results of an asynchronous replacer function.
+ *
+ * @typeParam ReplaceGroupArguments - The types of the captured group arguments.
+ * @param params - The parameters.
+ * @returns A {@link Promise} that resolves to the string with all replacements made.
+ */
+export declare function replaceAllAsync<ReplaceGroupArguments extends string[]>(params: ReplaceAllAsyncParams<ReplaceGroupArguments>): Promise<string>;
+/**
+ * Trims the specified suffix from the end of a string.
+ *
+ * @param params - The parameters.
+ * @returns The trimmed string.
+ * @throws If `shouldValidate` is `true` and the string does not end with the suffix.
+ */
+export declare function trimEnd(params: TrimEndParams): string;
+/**
+ * Trims the specified prefix from the start of a string.
+ *
+ * @param params - The parameters.
+ * @returns The trimmed string.
+ * @throws If `shouldValidate` is `true` and the string does not start with the prefix.
+ */
+export declare function trimStart(params: TrimStartParams): string;
+/**
+ * Unescapes a string by replacing escape sequences with their corresponding characters.
+ *
+ * @param $string - The string to unescape.
+ * @returns The unescaped string.
+ */
+export declare function unescape($string: string): string;
+/**
+ * Unindents a string by removing a prefix from each line.
+ *
+ * @param params - The parameters.
+ * @returns The unindented string.
+ */
+export declare function unindent(params: UnindentParams): string;
+export {};

package/dist/lib/cjs/transformers/date-transformer.cjs

@@ -0,0 +1,71 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var date_transformer_exports = {};
+__export(date_transformer_exports, {
+  DateTransformer: () => DateTransformer
+});
+module.exports = __toCommonJS(date_transformer_exports);
+var import_typed_transformer = require('./typed-transformer.cjs');
+class DateTransformer extends import_typed_transformer.TypedTransformer {
+  /**
+   * An id of the transformer.
+   *
+   * @returns `date`.
+   */
+  get id() {
+    return "date";
+  }
+  /**
+   * Determines if the value is a Date.
+   *
+   * @param value - The value to check.
+   * @returns A boolean indicating if the value is a Date.
+   */
+  canTransform(value) {
+    return value instanceof Date;
+  }
+  /**
+   * Restores the value from a string.
+   *
+   * @param transformedValue - The transformed value.
+   * @returns The restored value.
+   */
+  restoreValue(transformedValue) {
+    return new Date(transformedValue);
+  }
+  /**
+   * Transforms the value to a string.
+   *
+   * @param value - The value to transform.
+   * @returns The transformed value.
+   */
+  transformValue(value) {
+    return value.toISOString();
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DateTransformer
+});
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL3RyYW5zZm9ybWVycy9kYXRlLXRyYW5zZm9ybWVyLnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyIvKipcbiAqIEBmaWxlXG4gKlxuICogQSB0cmFuc2Zvcm1lciB0aGF0IGNhbiB0cmFuc2Zvcm0gRGF0ZSB0byBhbiBJU08gc3RyaW5nIGFuZCBiYWNrLlxuICovXG5cbmltcG9ydCB7IFR5cGVkVHJhbnNmb3JtZXIgfSBmcm9tICcuL3R5cGVkLXRyYW5zZm9ybWVyLnRzJztcblxuLyoqXG4gKiBBIHRyYW5zZm9ybWVyIHRoYXQgY2FuIHRyYW5zZm9ybSBEYXRlIHRvIGFuIElTTyBzdHJpbmcgYW5kIGJhY2suXG4gKi9cbmV4cG9ydCBjbGFzcyBEYXRlVHJhbnNmb3JtZXIgZXh0ZW5kcyBUeXBlZFRyYW5zZm9ybWVyPERhdGUsIHN0cmluZz4ge1xuICAvKipcbiAgICogQW4gaWQgb2YgdGhlIHRyYW5zZm9ybWVyLlxuICAgKlxuICAgKiBAcmV0dXJucyBgZGF0ZWAuXG4gICAqL1xuICBwdWJsaWMgb3ZlcnJpZGUgZ2V0IGlkKCk6IHN0cmluZyB7XG4gICAgcmV0dXJuICdkYXRlJztcbiAgfVxuXG4gIC8qKlxuICAgKiBEZXRlcm1pbmVzIGlmIHRoZSB2YWx1ZSBpcyBhIERhdGUuXG4gICAqXG4gICAqIEBwYXJhbSB2YWx1ZSAtIFRoZSB2YWx1ZSB0byBjaGVjay5cbiAgICogQHJldHVybnMgQSBib29sZWFuIGluZGljYXRpbmcgaWYgdGhlIHZhbHVlIGlzIGEgRGF0ZS5cbiAgICovXG4gIHB1YmxpYyBvdmVycmlkZSBjYW5UcmFuc2Zvcm0odmFsdWU6IHVua25vd24pOiB2YWx1ZSBpcyBEYXRlIHtcbiAgICByZXR1cm4gdmFsdWUgaW5zdGFuY2VvZiBEYXRlO1xuICB9XG5cbiAgLyoqXG4gICAqIFJlc3RvcmVzIHRoZSB2YWx1ZSBmcm9tIGEgc3RyaW5nLlxuICAgKlxuICAgKiBAcGFyYW0gdHJhbnNmb3JtZWRWYWx1ZSAtIFRoZSB0cmFuc2Zvcm1lZCB2YWx1ZS5cbiAgICogQHJldHVybnMgVGhlIHJlc3RvcmVkIHZhbHVlLlxuICAgKi9cbiAgcHVibGljIG92ZXJyaWRlIHJlc3RvcmVWYWx1ZSh0cmFuc2Zvcm1lZFZhbHVlOiBzdHJpbmcpOiBEYXRlIHtcbiAgICByZXR1cm4gbmV3IERhdGUodHJhbnNmb3JtZWRWYWx1ZSk7XG4gIH1cblxuICAvKipcbiAgICogVHJhbnNmb3JtcyB0aGUgdmFsdWUgdG8gYSBzdHJpbmcuXG4gICAqXG4gICAqIEBwYXJhbSB2YWx1ZSAtIFRoZSB2YWx1ZSB0byB0cmFuc2Zvcm0uXG4gICAqIEByZXR1cm5zIFRoZSB0cmFuc2Zvcm1lZCB2YWx1ZS5cbiAgICovXG4gIHB1YmxpYyBvdmVycmlkZSB0cmFuc2Zvcm1WYWx1ZSh2YWx1ZTogRGF0ZSk6IHN0cmluZyB7XG4gICAgcmV0dXJuIHZhbHVlLnRvSVNPU3RyaW5nKCk7XG4gIH1cbn1cbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQU1BLCtCQUFpQztBQUsxQixNQUFNLHdCQUF3QiwwQ0FBK0I7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFNbEUsSUFBb0IsS0FBYTtBQUMvQixXQUFPO0FBQUEsRUFDVDtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBUWdCLGFBQWEsT0FBK0I7QUFDMUQsV0FBTyxpQkFBaUI7QUFBQSxFQUMxQjtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBUWdCLGFBQWEsa0JBQWdDO0FBQzNELFdBQU8sSUFBSSxLQUFLLGdCQUFnQjtBQUFBLEVBQ2xDO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFRZ0IsZUFBZSxPQUFxQjtBQUNsRCxXQUFPLE1BQU0sWUFBWTtBQUFBLEVBQzNCO0FBQ0Y7IiwKICAibmFtZXMiOiBbXQp9Cg==

package/dist/lib/cjs/transformers/date-transformer.d.cts

@@ -0,0 +1,39 @@
+/// <reference path="../library-references.d.cts" />
+/**
+ * @file
+ *
+ * A transformer that can transform Date to an ISO string and back.
+ */
+import { TypedTransformer } from './typed-transformer.cjs';
+/**
+ * A transformer that can transform Date to an ISO string and back.
+ */
+export declare class DateTransformer extends TypedTransformer<Date, string> {
+    /**
+     * An id of the transformer.
+     *
+     * @returns `date`.
+     */
+    get id(): string;
+    /**
+     * Determines if the value is a Date.
+     *
+     * @param value - The value to check.
+     * @returns A boolean indicating if the value is a Date.
+     */
+    canTransform(value: unknown): value is Date;
+    /**
+     * Restores the value from a string.
+     *
+     * @param transformedValue - The transformed value.
+     * @returns The restored value.
+     */
+    restoreValue(transformedValue: string): Date;
+    /**
+     * Transforms the value to a string.
+     *
+     * @param value - The value to transform.
+     * @returns The transformed value.
+     */
+    transformValue(value: Date): string;
+}

package/dist/lib/cjs/transformers/group-transformer.cjs

@@ -0,0 +1,115 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var group_transformer_exports = {};
+__export(group_transformer_exports, {
+  GroupTransformer: () => GroupTransformer
+});
+module.exports = __toCommonJS(group_transformer_exports);
+var import_type_guards = require('../type-guards.cjs');
+var import_transformer = require('./transformer.cjs');
+class GroupTransformer extends import_transformer.Transformer {
+  /**
+   * Transformers to combine.
+   *
+   * @param transformers - The transformers to combine.
+   */
+  constructor(transformers) {
+    super();
+    this.transformers = transformers;
+  }
+  transformers;
+  /**
+   * An id of the transformer.
+   *
+   * @returns `group`.
+   */
+  get id() {
+    return "group";
+  }
+  /**
+   * Determines if the value can be transformed by any of the transformers.
+   *
+   * @param value - The value to check.
+   * @param key - The key of the value to check.
+   * @returns A boolean indicating if the value can be transformed.
+   */
+  canTransform(value, key) {
+    return this.getFirstTransformerThatCanTransform(value, key) !== null;
+  }
+  /**
+   * Gets the transformer with the given id.
+   *
+   * @param transformerId - The id of the transformer to get.
+   * @returns The transformer with the given id.
+   */
+  getTransformer(transformerId) {
+    return (0, import_type_guards.ensureNonNullable)(this.transformers.find((t) => t.id === transformerId), `No transformer with id ${transformerId} found`);
+  }
+  /**
+   * Transforms the value using the first transformer that can transform it.
+   *
+   * @param value - The value to transform.
+   * @param key - The key of the value to transform.
+   * @returns The transformed value.
+   */
+  transformValue(value, key) {
+    const transformer = this.getFirstTransformerThatCanTransform(value, key);
+    (0, import_type_guards.assertNonNullable)(transformer, "No transformer can transform the value");
+    return transformer.transformValue(value, key);
+  }
+  /**
+   * Gets the id of the transformer that can transform the given value.
+   *
+   * @param value - The value to get the transformer id for.
+   * @param key - The key of the value to get the transformer id for.
+   * @returns The id of the transformer that can transform the given value.
+   */
+  getTransformerId(value, key) {
+    const transformer = this.getFirstTransformerThatCanTransform(value, key);
+    return transformer === null ? null : transformer.id;
+  }
+  /**
+   * This transformer does not support restoring values.
+   *
+   * @throws
+   */
+  restoreValue() {
+    throw new Error("GroupTransformer does not support restoring values");
+  }
+  /**
+   * Gets the first transformer that can transform the given value.
+   *
+   * @param value - The value to get the first transformer for.
+   * @param key - The key of the value to get the first transformer for.
+   * @returns The first transformer that can transform the given value.
+   */
+  getFirstTransformerThatCanTransform(value, key) {
+    return this.transformers.find((t) => t.canTransform(value, key)) ?? null;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  GroupTransformer
+});
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL3RyYW5zZm9ybWVycy9ncm91cC10cmFuc2Zvcm1lci50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyoqXG4gKiBAZmlsZVxuICpcbiAqIEEgdHJhbnNmb3JtZXIgdGhhdCBjb21iaW5lcyBtdWx0aXBsZSB0cmFuc2Zvcm1lcnMuXG4gKi9cblxuaW1wb3J0IHtcbiAgYXNzZXJ0Tm9uTnVsbGFibGUsXG4gIGVuc3VyZU5vbk51bGxhYmxlXG59IGZyb20gJy4uL3R5cGUtZ3VhcmRzLnRzJztcbmltcG9ydCB7IFRyYW5zZm9ybWVyIH0gZnJvbSAnLi90cmFuc2Zvcm1lci50cyc7XG5cbi8qKlxuICogQSB0cmFuc2Zvcm1lciB0aGF0IGNvbWJpbmVzIG11bHRpcGxlIHRyYW5zZm9ybWVycy5cbiAqL1xuZXhwb3J0IGNsYXNzIEdyb3VwVHJhbnNmb3JtZXIgZXh0ZW5kcyBUcmFuc2Zvcm1lciB7XG4gIC8qKlxuICAgKiBBbiBpZCBvZiB0aGUgdHJhbnNmb3JtZXIuXG4gICAqXG4gICAqIEByZXR1cm5zIGBncm91cGAuXG4gICAqL1xuICBwdWJsaWMgb3ZlcnJpZGUgZ2V0IGlkKCk6IHN0cmluZyB7XG4gICAgcmV0dXJuICdncm91cCc7XG4gIH1cblxuICAvKipcbiAgICogVHJhbnNmb3JtZXJzIHRvIGNvbWJpbmUuXG4gICAqXG4gICAqIEBwYXJhbSB0cmFuc2Zvcm1lcnMgLSBUaGUgdHJhbnNmb3JtZXJzIHRvIGNvbWJpbmUuXG4gICAqL1xuICBwdWJsaWMgY29uc3RydWN0b3IocHJvdGVjdGVkIHJlYWRvbmx5IHRyYW5zZm9ybWVyczogVHJhbnNmb3JtZXJbXSkge1xuICAgIHN1cGVyKCk7XG4gIH1cblxuICAvKipcbiAgICogRGV0ZXJtaW5lcyBpZiB0aGUgdmFsdWUgY2FuIGJlIHRyYW5zZm9ybWVkIGJ5IGFueSBvZiB0aGUgdHJhbnNmb3JtZXJzLlxuICAgKlxuICAgKiBAcGFyYW0gdmFsdWUgLSBUaGUgdmFsdWUgdG8gY2hlY2suXG4gICAqIEBwYXJhbSBrZXkgLSBUaGUga2V5IG9mIHRoZSB2YWx1ZSB0byBjaGVjay5cbiAgICogQHJldHVybnMgQSBib29sZWFuIGluZGljYXRpbmcgaWYgdGhlIHZhbHVlIGNhbiBiZSB0cmFuc2Zvcm1lZC5cbiAgICovXG4gIHB1YmxpYyBvdmVycmlkZSBjYW5UcmFuc2Zvcm0odmFsdWU6IHVua25vd24sIGtleTogc3RyaW5nKTogYm9vbGVhbiB7XG4gICAgcmV0dXJuIHRoaXMuZ2V0Rmlyc3RUcmFuc2Zvcm1lclRoYXRDYW5UcmFuc2Zvcm0odmFsdWUsIGtleSkgIT09IG51bGw7XG4gIH1cblxuICAvKipcbiAgICogR2V0cyB0aGUgdHJhbnNmb3JtZXIgd2l0aCB0aGUgZ2l2ZW4gaWQuXG4gICAqXG4gICAqIEBwYXJhbSB0cmFuc2Zvcm1lcklkIC0gVGhlIGlkIG9mIHRoZSB0cmFuc2Zvcm1lciB0byBnZXQuXG4gICAqIEByZXR1cm5zIFRoZSB0cmFuc2Zvcm1lciB3aXRoIHRoZSBnaXZlbiBpZC5cbiAgICovXG4gIHB1YmxpYyBvdmVycmlkZSBnZXRUcmFuc2Zvcm1lcih0cmFuc2Zvcm1lcklkOiBzdHJpbmcpOiBUcmFuc2Zvcm1lciB7XG4gICAgcmV0dXJuIGVuc3VyZU5vbk51bGxhYmxlKHRoaXMudHJhbnNmb3JtZXJzLmZpbmQoKHQpID0+IHQuaWQgPT09IHRyYW5zZm9ybWVySWQpLCBgTm8gdHJhbnNmb3JtZXIgd2l0aCBpZCAke3RyYW5zZm9ybWVySWR9IGZvdW5kYCk7XG4gIH1cblxuICAvKipcbiAgICogVHJhbnNmb3JtcyB0aGUgdmFsdWUgdXNpbmcgdGhlIGZpcnN0IHRyYW5zZm9ybWVyIHRoYXQgY2FuIHRyYW5zZm9ybSBpdC5cbiAgICpcbiAgICogQHBhcmFtIHZhbHVlIC0gVGhlIHZhbHVlIHRvIHRyYW5zZm9ybS5cbiAgICogQHBhcmFtIGtleSAtIFRoZSBrZXkgb2YgdGhlIHZhbHVlIHRvIHRyYW5zZm9ybS5cbiAgICogQHJldHVybnMgVGhlIHRyYW5zZm9ybWVkIHZhbHVlLlxuICAgKi9cbiAgcHVibGljIG92ZXJyaWRlIHRyYW5zZm9ybVZhbHVlKHZhbHVlOiB1bmtub3duLCBrZXk6IHN0cmluZyk6IHVua25vd24ge1xuICAgIGNvbnN0IHRyYW5zZm9ybWVyID0gdGhpcy5nZXRGaXJzdFRyYW5zZm9ybWVyVGhhdENhblRyYW5zZm9ybSh2YWx1ZSwga2V5KTtcbiAgICBhc3NlcnROb25OdWxsYWJsZSh0cmFuc2Zvcm1lciwgJ05vIHRyYW5zZm9ybWVyIGNhbiB0cmFuc2Zvcm0gdGhlIHZhbHVlJyk7XG5cbiAgICByZXR1cm4gdHJhbnNmb3JtZXIudHJhbnNmb3JtVmFsdWUodmFsdWUsIGtleSk7XG4gIH1cblxuICAvKipcbiAgICogR2V0cyB0aGUgaWQgb2YgdGhlIHRyYW5zZm9ybWVyIHRoYXQgY2FuIHRyYW5zZm9ybSB0aGUgZ2l2ZW4gdmFsdWUuXG4gICAqXG4gICAqIEBwYXJhbSB2YWx1ZSAtIFRoZSB2YWx1ZSB0byBnZXQgdGhlIHRyYW5zZm9ybWVyIGlkIGZvci5cbiAgICogQHBhcmFtIGtleSAtIFRoZSBrZXkgb2YgdGhlIHZhbHVlIHRvIGdldCB0aGUgdHJhbnNmb3JtZXIgaWQgZm9yLlxuICAgKiBAcmV0dXJucyBUaGUgaWQgb2YgdGhlIHRyYW5zZm9ybWVyIHRoYXQgY2FuIHRyYW5zZm9ybSB0aGUgZ2l2ZW4gdmFsdWUuXG4gICAqL1xuICBwcm90ZWN0ZWQgb3ZlcnJpZGUgZ2V0VHJhbnNmb3JtZXJJZCh2YWx1ZTogdW5rbm93biwga2V5OiBzdHJpbmcpOiBudWxsIHwgc3RyaW5nIHtcbiAgICBjb25zdCB0cmFuc2Zvcm1lciA9IHRoaXMuZ2V0Rmlyc3RUcmFuc2Zvcm1lclRoYXRDYW5UcmFuc2Zvcm0odmFsdWUsIGtleSk7XG4gICAgcmV0dXJuIHRyYW5zZm9ybWVyID09PSBudWxsID8gbnVsbCA6IHRyYW5zZm9ybWVyLmlkO1xuICB9XG5cbiAgLyoqXG4gICAqIFRoaXMgdHJhbnNmb3JtZXIgZG9lcyBub3Qgc3VwcG9ydCByZXN0b3JpbmcgdmFsdWVzLlxuICAgKlxuICAgKiBAdGhyb3dzXG4gICAqL1xuICBwcm90ZWN0ZWQgb3ZlcnJpZGUgcmVzdG9yZVZhbHVlKCk6IG5ldmVyIHtcbiAgICB0aHJvdyBuZXcgRXJyb3IoJ0dyb3VwVHJhbnNmb3JtZXIgZG9lcyBub3Qgc3VwcG9ydCByZXN0b3JpbmcgdmFsdWVzJyk7XG4gIH1cblxuICAvKipcbiAgICogR2V0cyB0aGUgZmlyc3QgdHJhbnNmb3JtZXIgdGhhdCBjYW4gdHJhbnNmb3JtIHRoZSBnaXZlbiB2YWx1ZS5cbiAgICpcbiAgICogQHBhcmFtIHZhbHVlIC0gVGhlIHZhbHVlIHRvIGdldCB0aGUgZmlyc3QgdHJhbnNmb3JtZXIgZm9yLlxuICAgKiBAcGFyYW0ga2V5IC0gVGhlIGtleSBvZiB0aGUgdmFsdWUgdG8gZ2V0IHRoZSBmaXJzdCB0cmFuc2Zvcm1lciBmb3IuXG4gICAqIEByZXR1cm5zIFRoZSBmaXJzdCB0cmFuc2Zvcm1lciB0aGF0IGNhbiB0cmFuc2Zvcm0gdGhlIGdpdmVuIHZhbHVlLlxuICAgKi9cbiAgcHJpdmF0ZSBnZXRGaXJzdFRyYW5zZm9ybWVyVGhhdENhblRyYW5zZm9ybSh2YWx1ZTogdW5rbm93biwga2V5OiBzdHJpbmcpOiBudWxsIHwgVHJhbnNmb3JtZXIge1xuICAgIHJldHVybiB0aGlzLnRyYW5zZm9ybWVycy5maW5kKCh0KSA9PiB0LmNhblRyYW5zZm9ybSh2YWx1ZSwga2V5KSkgPz8gbnVsbDtcbiAgfVxufVxuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBTUEseUJBR087QUFDUCx5QkFBNEI7QUFLckIsTUFBTSx5QkFBeUIsK0JBQVk7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFlekMsWUFBK0IsY0FBNkI7QUFDakUsVUFBTTtBQUQ4QjtBQUFBLEVBRXRDO0FBQUEsRUFGc0M7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFUdEMsSUFBb0IsS0FBYTtBQUMvQixXQUFPO0FBQUEsRUFDVDtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFrQmdCLGFBQWEsT0FBZ0IsS0FBc0I7QUFDakUsV0FBTyxLQUFLLG9DQUFvQyxPQUFPLEdBQUcsTUFBTTtBQUFBLEVBQ2xFO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFRZ0IsZUFBZSxlQUFvQztBQUNqRSxlQUFPLHNDQUFrQixLQUFLLGFBQWEsS0FBSyxDQUFDLE1BQU0sRUFBRSxPQUFPLGFBQWEsR0FBRywwQkFBMEIsYUFBYSxRQUFRO0FBQUEsRUFDakk7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBU2dCLGVBQWUsT0FBZ0IsS0FBc0I7QUFDbkUsVUFBTSxjQUFjLEtBQUssb0NBQW9DLE9BQU8sR0FBRztBQUN2RSw4Q0FBa0IsYUFBYSx3Q0FBd0M7QUFFdkUsV0FBTyxZQUFZLGVBQWUsT0FBTyxHQUFHO0FBQUEsRUFDOUM7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBU21CLGlCQUFpQixPQUFnQixLQUE0QjtBQUM5RSxVQUFNLGNBQWMsS0FBSyxvQ0FBb0MsT0FBTyxHQUFHO0FBQ3ZFLFdBQU8sZ0JBQWdCLE9BQU8sT0FBTyxZQUFZO0FBQUEsRUFDbkQ7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFPbUIsZUFBc0I7QUFDdkMsVUFBTSxJQUFJLE1BQU0sb0RBQW9EO0FBQUEsRUFDdEU7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBU1Esb0NBQW9DLE9BQWdCLEtBQWlDO0FBQzNGLFdBQU8sS0FBSyxhQUFhLEtBQUssQ0FBQyxNQUFNLEVBQUUsYUFBYSxPQUFPLEdBQUcsQ0FBQyxLQUFLO0FBQUEsRUFDdEU7QUFDRjsiLAogICJuYW1lcyI6IFtdCn0K

package/dist/lib/cjs/transformers/group-transformer.d.cts

@@ -0,0 +1,70 @@
+/// <reference path="../library-references.d.cts" />
+/**
+ * @file
+ *
+ * A transformer that combines multiple transformers.
+ */
+import { Transformer } from './transformer.cjs';
+/**
+ * A transformer that combines multiple transformers.
+ */
+export declare class GroupTransformer extends Transformer {
+    protected readonly transformers: Transformer[];
+    /**
+     * An id of the transformer.
+     *
+     * @returns `group`.
+     */
+    get id(): string;
+    /**
+     * Transformers to combine.
+     *
+     * @param transformers - The transformers to combine.
+     */
+    constructor(transformers: Transformer[]);
+    /**
+     * Determines if the value can be transformed by any of the transformers.
+     *
+     * @param value - The value to check.
+     * @param key - The key of the value to check.
+     * @returns A boolean indicating if the value can be transformed.
+     */
+    canTransform(value: unknown, key: string): boolean;
+    /**
+     * Gets the transformer with the given id.
+     *
+     * @param transformerId - The id of the transformer to get.
+     * @returns The transformer with the given id.
+     */
+    getTransformer(transformerId: string): Transformer;
+    /**
+     * Transforms the value using the first transformer that can transform it.
+     *
+     * @param value - The value to transform.
+     * @param key - The key of the value to transform.
+     * @returns The transformed value.
+     */
+    transformValue(value: unknown, key: string): unknown;
+    /**
+     * Gets the id of the transformer that can transform the given value.
+     *
+     * @param value - The value to get the transformer id for.
+     * @param key - The key of the value to get the transformer id for.
+     * @returns The id of the transformer that can transform the given value.
+     */
+    protected getTransformerId(value: unknown, key: string): null | string;
+    /**
+     * This transformer does not support restoring values.
+     *
+     * @throws
+     */
+    protected restoreValue(): never;
+    /**
+     * Gets the first transformer that can transform the given value.
+     *
+     * @param value - The value to get the first transformer for.
+     * @param key - The key of the value to get the first transformer for.
+     * @returns The first transformer that can transform the given value.
+     */
+    private getFirstTransformerThatCanTransform;
+}