@mnaoumov/obsidian-lib 0.0.0 → 1.0.0

package/dist/lib/esm/logger.d.mts

@@ -0,0 +1,37 @@
+/// <reference path="./library.d.mts" />
+/**
+ * @file
+ *
+ * Contains utility functions for logging in Obsidian.
+ */
+import type { Promisable } from 'type-fest';
+/**
+ * Parameters for {@link invokeAsyncAndLog}.
+ */
+export interface InvokeAsyncAndLogParams {
+    /**
+     * The function to invoke.
+     *
+     * @param abortSignal - The abort signal to control the execution of the function.
+     * @returns A {@link Promisable} that resolves when the function is complete.
+     */
+    readonly $function: (abortSignal: AbortSignal) => Promisable<void>;
+    /**
+     * The abort signal to control the execution of the function.
+     */
+    readonly abortSignal?: AbortSignal;
+    /**
+     * Optional stack trace.
+     */
+    readonly stackTrace?: string;
+    /**
+     * The title of the log.
+     */
+    readonly title: string;
+}
+/**
+ * Invokes a function and logs the start, end, and duration of the invocation.
+ *
+ * @param params - The parameters for the invocation.
+ */
+export declare function invokeAsyncAndLog(params: InvokeAsyncAndLogParams): Promise<void>;

package/dist/lib/esm/logger.mjs

@@ -0,0 +1,123 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+(function () {
+function ensureDisposeSymbols(symbolConstructor = Symbol) {
+  symbolConstructor.asyncDispose ??= symbolConstructor.for('Symbol.asyncDispose');
+  symbolConstructor.dispose ??= symbolConstructor.for('Symbol.dispose');
+}
+
+function ensureBrowserProcess() {
+  const browserProcess = {
+    browser: true,
+    cwd() {
+      return '/';
+    },
+    env: {},
+    platform: 'android'
+  };
+
+  // eslint-disable-next-line obsidianmd/no-global-this, unicorn/no-unnecessary-global-this -- Must stay `globalThis`-qualified: in the emitted banner a bare `process` is a free identifier, so reading it where the host has none throws a ReferenceError instead of yielding `undefined`. That is the very case this function exists to handle.
+  const existingProcess = globalThis.process;
+
+  if (!existingProcess) {
+    // eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
+    globalThis.process = browserProcess;
+    return;
+  }
+
+  if (existingProcess.versions?.node) {
+    return;
+  }
+
+  const existingProcessRecord = existingProcess;
+
+  for (const [key, value] of Object.entries(browserProcess)) {
+    existingProcessRecord[key] ??= value;
+  }
+
+  existingProcessRecord['browser'] = true;
+}
+
+(function initEsm() {
+  ensureDisposeSymbols();
+  ensureBrowserProcess();
+})();
+})();
+
+import { abortSignalNever } from "@mnaoumov/typescript-lib/abort-controller";
+import { printWithStackTrace } from "@mnaoumov/typescript-lib/debug";
+import { getStackTrace } from "@mnaoumov/typescript-lib/error";
+import { getObsidianLibDebugger } from "./debug.mjs";
+async function invokeAsyncAndLog(params) {
+  const {
+    $function,
+    abortSignal = abortSignalNever(),
+    title
+  } = params;
+  abortSignal.throwIfAborted();
+  const invokeAsyncAndLogDebugger = getObsidianLibDebugger("Logger:invokeAsyncAndLog");
+  const timestampStart = performance.now();
+  const stackTrace = params.stackTrace ?? getStackTrace(1);
+  printWithStackTrace({
+    $arguments: [{
+      $function,
+      timestampStart
+    }],
+    debuggerInstance: invokeAsyncAndLogDebugger,
+    message: `${title}:start`,
+    stackTrace
+  });
+  try {
+    await $function(abortSignal);
+    const timestampEnd = performance.now();
+    const duration = Math.trunc(timestampEnd - timestampStart);
+    if (abortSignal.aborted) {
+      printWithStackTrace({
+        $arguments: [{
+          $function,
+          abortReason: abortSignal.reason,
+          duration,
+          timestampEnd,
+          timestampStart
+        }],
+        debuggerInstance: invokeAsyncAndLogDebugger,
+        message: `${title}:aborted`,
+        stackTrace
+      });
+      abortSignal.throwIfAborted();
+    }
+    printWithStackTrace({
+      $arguments: [{
+        $function,
+        duration,
+        timestampEnd,
+        timestampStart
+      }],
+      debuggerInstance: invokeAsyncAndLogDebugger,
+      message: `${title}:end`,
+      stackTrace
+    });
+  } catch (error) {
+    const timestampEnd = performance.now();
+    printWithStackTrace({
+      $arguments: [{
+        $function,
+        duration: Math.trunc(timestampEnd - timestampStart),
+        error,
+        timestampEnd,
+        timestampStart
+      }],
+      debuggerInstance: invokeAsyncAndLogDebugger,
+      message: `${title}:error`,
+      stackTrace
+    });
+    throw error;
+  }
+}
+export {
+  invokeAsyncAndLog
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjL2xvZ2dlci50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyoqXG4gKiBAZmlsZVxuICpcbiAqIENvbnRhaW5zIHV0aWxpdHkgZnVuY3Rpb25zIGZvciBsb2dnaW5nIGluIE9ic2lkaWFuLlxuICovXG5cbmltcG9ydCB0eXBlIHsgUHJvbWlzYWJsZSB9IGZyb20gJ3R5cGUtZmVzdCc7XG5cbmltcG9ydCB7IGFib3J0U2lnbmFsTmV2ZXIgfSBmcm9tICdAbW5hb3Vtb3YvdHlwZXNjcmlwdC1saWIvYWJvcnQtY29udHJvbGxlcic7XG5pbXBvcnQgeyBwcmludFdpdGhTdGFja1RyYWNlIH0gZnJvbSAnQG1uYW91bW92L3R5cGVzY3JpcHQtbGliL2RlYnVnJztcbmltcG9ydCB7IGdldFN0YWNrVHJhY2UgfSBmcm9tICdAbW5hb3Vtb3YvdHlwZXNjcmlwdC1saWIvZXJyb3InO1xuXG5pbXBvcnQgeyBnZXRPYnNpZGlhbkxpYkRlYnVnZ2VyIH0gZnJvbSAnLi9kZWJ1Zy50cyc7XG5cbi8qKlxuICogUGFyYW1ldGVycyBmb3Ige0BsaW5rIGludm9rZUFzeW5jQW5kTG9nfS5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBJbnZva2VBc3luY0FuZExvZ1BhcmFtcyB7XG4gIC8qKlxuICAgKiBUaGUgZnVuY3Rpb24gdG8gaW52b2tlLlxuICAgKlxuICAgKiBAcGFyYW0gYWJvcnRTaWduYWwgLSBUaGUgYWJvcnQgc2lnbmFsIHRvIGNvbnRyb2wgdGhlIGV4ZWN1dGlvbiBvZiB0aGUgZnVuY3Rpb24uXG4gICAqIEByZXR1cm5zIEEge0BsaW5rIFByb21pc2FibGV9IHRoYXQgcmVzb2x2ZXMgd2hlbiB0aGUgZnVuY3Rpb24gaXMgY29tcGxldGUuXG4gICAqL1xuICByZWFkb25seSAkZnVuY3Rpb246IChhYm9ydFNpZ25hbDogQWJvcnRTaWduYWwpID0+IFByb21pc2FibGU8dm9pZD47XG5cbiAgLyoqXG4gICAqIFRoZSBhYm9ydCBzaWduYWwgdG8gY29udHJvbCB0aGUgZXhlY3V0aW9uIG9mIHRoZSBmdW5jdGlvbi5cbiAgICovXG4gIHJlYWRvbmx5IGFib3J0U2lnbmFsPzogQWJvcnRTaWduYWw7XG5cbiAgLyoqXG4gICAqIE9wdGlvbmFsIHN0YWNrIHRyYWNlLlxuICAgKi9cbiAgcmVhZG9ubHkgc3RhY2tUcmFjZT86IHN0cmluZztcblxuICAvKipcbiAgICogVGhlIHRpdGxlIG9mIHRoZSBsb2cuXG4gICAqL1xuICByZWFkb25seSB0aXRsZTogc3RyaW5nO1xufVxuXG4vKipcbiAqIEludm9rZXMgYSBmdW5jdGlvbiBhbmQgbG9ncyB0aGUgc3RhcnQsIGVuZCwgYW5kIGR1cmF0aW9uIG9mIHRoZSBpbnZvY2F0aW9uLlxuICpcbiAqIEBwYXJhbSBwYXJhbXMgLSBUaGUgcGFyYW1ldGVycyBmb3IgdGhlIGludm9jYXRpb24uXG4gKi9cbmV4cG9ydCBhc3luYyBmdW5jdGlvbiBpbnZva2VBc3luY0FuZExvZyhwYXJhbXM6IEludm9rZUFzeW5jQW5kTG9nUGFyYW1zKTogUHJvbWlzZTx2b2lkPiB7XG4gIGNvbnN0IHtcbiAgICAkZnVuY3Rpb24sXG4gICAgYWJvcnRTaWduYWwgPSBhYm9ydFNpZ25hbE5ldmVyKCksXG4gICAgdGl0bGVcbiAgfSA9IHBhcmFtcztcbiAgYWJvcnRTaWduYWwudGhyb3dJZkFib3J0ZWQoKTtcbiAgY29uc3QgaW52b2tlQXN5bmNBbmRMb2dEZWJ1Z2dlciA9IGdldE9ic2lkaWFuTGliRGVidWdnZXIoJ0xvZ2dlcjppbnZva2VBc3luY0FuZExvZycpO1xuICBjb25zdCB0aW1lc3RhbXBTdGFydCA9IHBlcmZvcm1hbmNlLm5vdygpO1xuICBjb25zdCBzdGFja1RyYWNlID0gcGFyYW1zLnN0YWNrVHJhY2UgPz8gZ2V0U3RhY2tUcmFjZSgxKTtcbiAgcHJpbnRXaXRoU3RhY2tUcmFjZSh7XG4gICAgJGFyZ3VtZW50czogW3tcbiAgICAgICRmdW5jdGlvbixcbiAgICAgIHRpbWVzdGFtcFN0YXJ0XG4gICAgfV0sXG4gICAgZGVidWdnZXJJbnN0YW5jZTogaW52b2tlQXN5bmNBbmRMb2dEZWJ1Z2dlcixcbiAgICBtZXNzYWdlOiBgJHt0aXRsZX06c3RhcnRgLFxuICAgIHN0YWNrVHJhY2VcbiAgfSk7XG4gIHRyeSB7XG4gICAgYXdhaXQgJGZ1bmN0aW9uKGFib3J0U2lnbmFsKTtcbiAgICBjb25zdCB0aW1lc3RhbXBFbmQgPSBwZXJmb3JtYW5jZS5ub3coKTtcbiAgICBjb25zdCBkdXJhdGlvbiA9IE1hdGgudHJ1bmModGltZXN0YW1wRW5kIC0gdGltZXN0YW1wU3RhcnQpO1xuICAgIGlmIChhYm9ydFNpZ25hbC5hYm9ydGVkKSB7XG4gICAgICBwcmludFdpdGhTdGFja1RyYWNlKHtcbiAgICAgICAgJGFyZ3VtZW50czogW3tcbiAgICAgICAgICAkZnVuY3Rpb24sXG4gICAgICAgICAgYWJvcnRSZWFzb246IGFib3J0U2lnbmFsLnJlYXNvbiBhcyB1bmtub3duLFxuICAgICAgICAgIGR1cmF0aW9uLFxuICAgICAgICAgIHRpbWVzdGFtcEVuZCxcbiAgICAgICAgICB0aW1lc3RhbXBTdGFydFxuICAgICAgICB9XSxcbiAgICAgICAgZGVidWdnZXJJbnN0YW5jZTogaW52b2tlQXN5bmNBbmRMb2dEZWJ1Z2dlcixcbiAgICAgICAgbWVzc2FnZTogYCR7dGl0bGV9OmFib3J0ZWRgLFxuICAgICAgICBzdGFja1RyYWNlXG4gICAgICB9KTtcbiAgICAgIGFib3J0U2lnbmFsLnRocm93SWZBYm9ydGVkKCk7XG4gICAgfVxuICAgIHByaW50V2l0aFN0YWNrVHJhY2Uoe1xuICAgICAgJGFyZ3VtZW50czogW3tcbiAgICAgICAgJGZ1bmN0aW9uLFxuICAgICAgICBkdXJhdGlvbixcbiAgICAgICAgdGltZXN0YW1wRW5kLFxuICAgICAgICB0aW1lc3RhbXBTdGFydFxuICAgICAgfV0sXG4gICAgICBkZWJ1Z2dlckluc3RhbmNlOiBpbnZva2VBc3luY0FuZExvZ0RlYnVnZ2VyLFxuICAgICAgbWVzc2FnZTogYCR7dGl0bGV9OmVuZGAsXG4gICAgICBzdGFja1RyYWNlXG4gICAgfSk7XG4gIH0gY2F0Y2ggKGVycm9yKSB7XG4gICAgY29uc3QgdGltZXN0YW1wRW5kID0gcGVyZm9ybWFuY2Uubm93KCk7XG4gICAgcHJpbnRXaXRoU3RhY2tUcmFjZSh7XG4gICAgICAkYXJndW1lbnRzOiBbe1xuICAgICAgICAkZnVuY3Rpb24sXG4gICAgICAgIGR1cmF0aW9uOiBNYXRoLnRydW5jKHRpbWVzdGFtcEVuZCAtIHRpbWVzdGFtcFN0YXJ0KSxcbiAgICAgICAgZXJyb3IsXG4gICAgICAgIHRpbWVzdGFtcEVuZCxcbiAgICAgICAgdGltZXN0YW1wU3RhcnRcbiAgICAgIH1dLFxuICAgICAgZGVidWdnZXJJbnN0YW5jZTogaW52b2tlQXN5bmNBbmRMb2dEZWJ1Z2dlcixcbiAgICAgIG1lc3NhZ2U6IGAke3RpdGxlfTplcnJvcmAsXG4gICAgICBzdGFja1RyYWNlXG4gICAgfSk7XG4gICAgdGhyb3cgZXJyb3I7XG4gIH1cbn1cbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFRQSxTQUFTLHdCQUF3QjtBQUNqQyxTQUFTLDJCQUEyQjtBQUNwQyxTQUFTLHFCQUFxQjtBQUU5QixTQUFTLDhCQUE4QjtBQW1DdkMsZUFBc0Isa0JBQWtCLFFBQWdEO0FBQ3RGLFFBQU07QUFBQSxJQUNKO0FBQUEsSUFDQSxjQUFjLGlCQUFpQjtBQUFBLElBQy9CO0FBQUEsRUFDRixJQUFJO0FBQ0osY0FBWSxlQUFlO0FBQzNCLFFBQU0sNEJBQTRCLHVCQUF1QiwwQkFBMEI7QUFDbkYsUUFBTSxpQkFBaUIsWUFBWSxJQUFJO0FBQ3ZDLFFBQU0sYUFBYSxPQUFPLGNBQWMsY0FBYyxDQUFDO0FBQ3ZELHNCQUFvQjtBQUFBLElBQ2xCLFlBQVksQ0FBQztBQUFBLE1BQ1g7QUFBQSxNQUNBO0FBQUEsSUFDRixDQUFDO0FBQUEsSUFDRCxrQkFBa0I7QUFBQSxJQUNsQixTQUFTLEdBQUcsS0FBSztBQUFBLElBQ2pCO0FBQUEsRUFDRixDQUFDO0FBQ0QsTUFBSTtBQUNGLFVBQU0sVUFBVSxXQUFXO0FBQzNCLFVBQU0sZUFBZSxZQUFZLElBQUk7QUFDckMsVUFBTSxXQUFXLEtBQUssTUFBTSxlQUFlLGNBQWM7QUFDekQsUUFBSSxZQUFZLFNBQVM7QUFDdkIsMEJBQW9CO0FBQUEsUUFDbEIsWUFBWSxDQUFDO0FBQUEsVUFDWDtBQUFBLFVBQ0EsYUFBYSxZQUFZO0FBQUEsVUFDekI7QUFBQSxVQUNBO0FBQUEsVUFDQTtBQUFBLFFBQ0YsQ0FBQztBQUFBLFFBQ0Qsa0JBQWtCO0FBQUEsUUFDbEIsU0FBUyxHQUFHLEtBQUs7QUFBQSxRQUNqQjtBQUFBLE1BQ0YsQ0FBQztBQUNELGtCQUFZLGVBQWU7QUFBQSxJQUM3QjtBQUNBLHdCQUFvQjtBQUFBLE1BQ2xCLFlBQVksQ0FBQztBQUFBLFFBQ1g7QUFBQSxRQUNBO0FBQUEsUUFDQTtBQUFBLFFBQ0E7QUFBQSxNQUNGLENBQUM7QUFBQSxNQUNELGtCQUFrQjtBQUFBLE1BQ2xCLFNBQVMsR0FBRyxLQUFLO0FBQUEsTUFDakI7QUFBQSxJQUNGLENBQUM7QUFBQSxFQUNILFNBQVMsT0FBTztBQUNkLFVBQU0sZUFBZSxZQUFZLElBQUk7QUFDckMsd0JBQW9CO0FBQUEsTUFDbEIsWUFBWSxDQUFDO0FBQUEsUUFDWDtBQUFBLFFBQ0EsVUFBVSxLQUFLLE1BQU0sZUFBZSxjQUFjO0FBQUEsUUFDbEQ7QUFBQSxRQUNBO0FBQUEsUUFDQTtBQUFBLE1BQ0YsQ0FBQztBQUFBLE1BQ0Qsa0JBQWtCO0FBQUEsTUFDbEIsU0FBUyxHQUFHLEtBQUs7QUFBQSxNQUNqQjtBQUFBLElBQ0YsQ0FBQztBQUNELFVBQU07QUFBQSxFQUNSO0FBQ0Y7IiwKICAibmFtZXMiOiBbXQp9Cg==

package/dist/lib/esm/loop.d.mts

@@ -0,0 +1,104 @@
+/// <reference path="./library.d.mts" />
+/**
+ * @file
+ *
+ * Contains utility functions for looping in Obsidian.
+ */
+import type { Promisable } from 'type-fest';
+import type { PluginNoticeComponent } from './components/plugin-notice-component.mjs';
+/**
+ * Parameters for the {@link LoopParams.buildNoticeMessage} callback.
+ *
+ * @typeParam T - The type of the items to loop over.
+ */
+export interface LoopBuildNoticeMessageParams<T> {
+    /**
+     * The current item.
+     */
+    readonly item: T;
+    /**
+     * A string representing the current iteration.
+     */
+    readonly iterationString: string;
+}
+/**
+ * Options for {@link loop}.
+ *
+ * @typeParam T - The type of the items to loop over.
+ */
+export interface LoopParams<T> {
+    /**
+     * An optional abort signal to cancel the loop.
+     */
+    readonly abortSignal?: AbortSignal;
+    /**
+     * Build a notice message for each item.
+     *
+     * @param params - The parameters for building the notice message.
+     * @returns A string to display in the notice.
+     */
+    readonly buildNoticeMessage: (params: LoopBuildNoticeMessageParams<T>) => string;
+    /**
+     * Items to loop over.
+     */
+    readonly items: T[];
+    /**
+     * A timeout for the notice before it is shown.
+     *
+     * @default `500`
+     */
+    readonly noticeBeforeShownTimeoutInMilliseconds?: number;
+    /**
+     * A minimum timeout for the notice.
+     *
+     * @default `2000`
+     */
+    readonly noticeMinTimeoutInMilliseconds?: number;
+    /**
+     * A component to show notices.
+     */
+    readonly pluginNoticeComponent: null | PluginNoticeComponent;
+    /**
+     * Process each item.
+     *
+     * @param item - The current item.
+     */
+    readonly processItem: (item: T) => Promisable<void>;
+    /**
+     * A title of the progress bar.
+     *
+     * @default `''`
+     */
+    readonly progressBarTitle?: string;
+    /**
+     * Whether to continue the loop on error.
+     *
+     * @default `true`
+     */
+    readonly shouldContinueOnError?: boolean;
+    /**
+     * Whether to show a notice.
+     *
+     * @default `true`
+     */
+    readonly shouldShowNotice?: boolean;
+    /**
+     * Whether to show a progress bar.
+     *
+     * @default `true`
+     */
+    readonly shouldShowProgressBar?: boolean;
+    /**
+     * A threshold for the UI update.
+     *
+     * @default `100`
+     */
+    readonly uiUpdateThresholdInMilliseconds?: number;
+}
+/**
+ * Loops over a list of items and processes each item.
+ *
+ * @typeParam T - The type of the items to loop over.
+ * @param params - The parameters for the loop.
+ */
+export declare function loop<T>(params: LoopParams<T>): Promise<void>;

package/dist/lib/esm/loop.mjs

@@ -0,0 +1,159 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+(function () {
+function ensureDisposeSymbols(symbolConstructor = Symbol) {
+  symbolConstructor.asyncDispose ??= symbolConstructor.for('Symbol.asyncDispose');
+  symbolConstructor.dispose ??= symbolConstructor.for('Symbol.dispose');
+}
+
+function ensureBrowserProcess() {
+  const browserProcess = {
+    browser: true,
+    cwd() {
+      return '/';
+    },
+    env: {},
+    platform: 'android'
+  };
+
+  // eslint-disable-next-line obsidianmd/no-global-this, unicorn/no-unnecessary-global-this -- Must stay `globalThis`-qualified: in the emitted banner a bare `process` is a free identifier, so reading it where the host has none throws a ReferenceError instead of yielding `undefined`. That is the very case this function exists to handle.
+  const existingProcess = globalThis.process;
+
+  if (!existingProcess) {
+    // eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
+    globalThis.process = browserProcess;
+    return;
+  }
+
+  if (existingProcess.versions?.node) {
+    return;
+  }
+
+  const existingProcessRecord = existingProcess;
+
+  for (const [key, value] of Object.entries(browserProcess)) {
+    existingProcessRecord[key] ??= value;
+  }
+
+  existingProcessRecord['browser'] = true;
+}
+
+(function initEsm() {
+  ensureDisposeSymbols();
+  ensureBrowserProcess();
+})();
+})();
+
+import { abortSignalNever } from "@mnaoumov/typescript-lib/abort-controller";
+import { requestAnimationFrameAsync } from "@mnaoumov/typescript-lib/async";
+import {
+  ASYNC_WRAPPER_ERROR_MESSAGE,
+  CustomStackTraceError,
+  emitAsyncErrorEvent,
+  getStackTrace
+} from "@mnaoumov/typescript-lib/error";
+import { noop } from "@mnaoumov/typescript-lib/function";
+import { getObsidianLibDebugger } from "./debug.mjs";
+import { addPluginCssClasses } from "./plugin/plugin-context.mjs";
+async function loop(params) {
+  const DEFAULT_OPTIONS = {
+    abortSignal: abortSignalNever(),
+    /* v8 ignore start -- buildNoticeMessage is required in LoopParams and always overridden by the spread. */
+    buildNoticeMessage() {
+      throw new Error("buildNoticeMessage is required");
+    },
+    /* v8 ignore stop */
+    items: [],
+    // eslint-disable-next-line no-magic-numbers -- Extracting magic number as a constant would be repetitive, as the value is used only once and its name would be the same as the property.
+    noticeBeforeShownTimeoutInMilliseconds: 500,
+    // eslint-disable-next-line no-magic-numbers -- Extracting magic number as a constant would be repetitive, as the value is used only once and its name would be the same as the property.
+    noticeMinTimeoutInMilliseconds: 2e3,
+    processItem: noop,
+    progressBarTitle: "",
+    shouldContinueOnError: true,
+    shouldShowNotice: true,
+    shouldShowProgressBar: true,
+    // eslint-disable-next-line no-magic-numbers -- Extracting magic number as a constant would be repetitive, as the value is used only once and its name would be the same as the property.
+    uiUpdateThresholdInMilliseconds: 100
+  };
+  const fullOptions = {
+    ...DEFAULT_OPTIONS,
+    ...params
+  };
+  const stackTrace = getStackTrace(1);
+  const items = fullOptions.items;
+  let iterationCount = 0;
+  const progressBarEl = createEl("progress");
+  addPluginCssClasses(progressBarEl, "loop");
+  progressBarEl.max = items.length;
+  let isNoticeShown = false;
+  let latestMessage = "";
+  const delayedNotice = fullOptions.shouldShowNotice ? params.pluginNoticeComponent?.showNoticeAfterDelay({
+    content: () => {
+      isNoticeShown = true;
+      return fullOptions.shouldShowProgressBar ? buildProgressBarFragment() : latestMessage;
+    },
+    delayInMilliseconds: fullOptions.noticeBeforeShownTimeoutInMilliseconds
+  }) ?? null : null;
+  const noticeMinTimeoutPromise = sleep(fullOptions.noticeMinTimeoutInMilliseconds);
+  let lastUIUpdateTimestamp = performance.now();
+  try {
+    for (const item of items) {
+      if (fullOptions.abortSignal.aborted) {
+        return;
+      }
+      iterationCount++;
+      const iterationString = `# ${String(iterationCount)} / ${String(items.length)}`;
+      const message = fullOptions.buildNoticeMessage({ item, iterationString });
+      if (!fullOptions.shouldShowProgressBar) {
+        latestMessage = message;
+        if (isNoticeShown) {
+          delayedNotice?.setContent(message);
+        }
+      }
+      getObsidianLibDebugger("Loop")(message);
+      try {
+        if (performance.now() - lastUIUpdateTimestamp > fullOptions.uiUpdateThresholdInMilliseconds) {
+          await requestAnimationFrameAsync();
+          lastUIUpdateTimestamp = performance.now();
+        }
+        await fullOptions.processItem(item);
+      } catch (error) {
+        console.error("Error processing item", item);
+        if (!fullOptions.shouldContinueOnError) {
+          throw new CustomStackTraceError({
+            cause: error,
+            message: "loop failed",
+            stackTrace
+          });
+        }
+        emitAsyncErrorEvent(
+          new CustomStackTraceError({
+            cause: error,
+            message: ASYNC_WRAPPER_ERROR_MESSAGE,
+            stackTrace
+          })
+        );
+      }
+      progressBarEl.value++;
+    }
+    if (isNoticeShown) {
+      await noticeMinTimeoutPromise;
+    }
+  } finally {
+    delayedNotice?.[Symbol.dispose]();
+  }
+  function buildProgressBarFragment() {
+    const fragment = createFragment();
+    fragment.createDiv({ text: fullOptions.progressBarTitle });
+    fragment.append(progressBarEl);
+    return fragment;
+  }
+}
+export {
+  loop
+};
+//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../src/loop.ts"],
  "sourcesContent": ["/**\n * @file\n *\n * Contains utility functions for looping in Obsidian.\n */\n\nimport type { Promisable } from 'type-fest';\n\nimport { abortSignalNever } from '@mnaoumov/typescript-lib/abort-controller';\nimport { requestAnimationFrameAsync } from '@mnaoumov/typescript-lib/async';\nimport {\n  ASYNC_WRAPPER_ERROR_MESSAGE,\n  CustomStackTraceError,\n  emitAsyncErrorEvent,\n  getStackTrace\n} from '@mnaoumov/typescript-lib/error';\nimport { noop } from '@mnaoumov/typescript-lib/function';\n\nimport type { PluginNoticeComponent } from './components/plugin-notice-component.ts';\n\nimport { getObsidianLibDebugger } from './debug.ts';\nimport { addPluginCssClasses } from './plugin/plugin-context.ts';\n\n/**\n * Parameters for the {@link LoopParams.buildNoticeMessage} callback.\n *\n * @typeParam T - The type of the items to loop over.\n */\nexport interface LoopBuildNoticeMessageParams<T> {\n  /**\n   * The current item.\n   */\n  readonly item: T;\n\n  /**\n   * A string representing the current iteration.\n   */\n  readonly iterationString: string;\n}\n\n/**\n * Options for {@link loop}.\n *\n * @typeParam T - The type of the items to loop over.\n */\nexport interface LoopParams<T> {\n  /**\n   * An optional abort signal to cancel the loop.\n   */\n  readonly abortSignal?: AbortSignal;\n\n  /**\n   * Build a notice message for each item.\n   *\n   * @param params - The parameters for building the notice message.\n   * @returns A string to display in the notice.\n   */\n  readonly buildNoticeMessage: (params: LoopBuildNoticeMessageParams<T>) => string;\n\n  /**\n   * Items to loop over.\n   */\n  readonly items: T[];\n\n  /**\n   * A timeout for the notice before it is shown.\n   *\n   * @default `500`\n   */\n  readonly noticeBeforeShownTimeoutInMilliseconds?: number;\n\n  /**\n   * A minimum timeout for the notice.\n   *\n   * @default `2000`\n   */\n  readonly noticeMinTimeoutInMilliseconds?: number;\n\n  /**\n   * A component to show notices.\n   */\n  readonly pluginNoticeComponent: null | PluginNoticeComponent;\n\n  /**\n   * Process each item.\n   *\n   * @param item - The current item.\n   */\n  readonly processItem: (item: T) => Promisable<void>;\n\n  /**\n   * A title of the progress bar.\n   *\n   * @default `''`\n   */\n  readonly progressBarTitle?: string;\n\n  /**\n   * Whether to continue the loop on error.\n   *\n   * @default `true`\n   */\n  readonly shouldContinueOnError?: boolean;\n\n  /**\n   * Whether to show a notice.\n   *\n   * @default `true`\n   */\n  readonly shouldShowNotice?: boolean;\n\n  /**\n   * Whether to show a progress bar.\n   *\n   * @default `true`\n   */\n  readonly shouldShowProgressBar?: boolean;\n\n  /**\n   * A threshold for the UI update.\n   *\n   * @default `100`\n   */\n  readonly uiUpdateThresholdInMilliseconds?: number;\n}\n\n/**\n * Loops over a list of items and processes each item.\n *\n * @typeParam T - The type of the items to loop over.\n * @param params - The parameters for the loop.\n */\nexport async function loop<T>(params: LoopParams<T>): Promise<void> {\n  const DEFAULT_OPTIONS = {\n    abortSignal: abortSignalNever(),\n    /* v8 ignore start -- buildNoticeMessage is required in LoopParams and always overridden by the spread. */\n    buildNoticeMessage(): string {\n      throw new Error('buildNoticeMessage is required');\n    },\n    /* v8 ignore stop */\n    items: [],\n    // eslint-disable-next-line no-magic-numbers -- Extracting magic number as a constant would be repetitive, as the value is used only once and its name would be the same as the property.\n    noticeBeforeShownTimeoutInMilliseconds: 500,\n    // eslint-disable-next-line no-magic-numbers -- Extracting magic number as a constant would be repetitive, as the value is used only once and its name would be the same as the property.\n    noticeMinTimeoutInMilliseconds: 2000,\n    processItem: noop,\n    progressBarTitle: '',\n    shouldContinueOnError: true,\n    shouldShowNotice: true,\n    shouldShowProgressBar: true,\n    // eslint-disable-next-line no-magic-numbers -- Extracting magic number as a constant would be repetitive, as the value is used only once and its name would be the same as the property.\n    uiUpdateThresholdInMilliseconds: 100\n  };\n\n  const fullOptions: Required<LoopParams<T>> = {\n    ...DEFAULT_OPTIONS,\n    ...params\n  };\n\n  const stackTrace = getStackTrace(1);\n\n  const items = fullOptions.items;\n  let iterationCount = 0;\n\n  const progressBarEl = createEl('progress');\n  addPluginCssClasses(progressBarEl, 'loop');\n  progressBarEl.max = items.length;\n\n  // The content provider is resolved only once the delay elapses, so it doubles as the notice-was-shown signal.\n  let isNoticeShown = false as boolean;\n  let latestMessage = '';\n  // A delayed notice stays until it is disposed. Obsidian's default duration would hide it a few seconds into a\n  // long run while the loop carries on.\n  const delayedNotice = fullOptions.shouldShowNotice\n    ? params.pluginNoticeComponent?.showNoticeAfterDelay({\n      content: () => {\n        isNoticeShown = true;\n        return fullOptions.shouldShowProgressBar ? buildProgressBarFragment() : latestMessage;\n      },\n      delayInMilliseconds: fullOptions.noticeBeforeShownTimeoutInMilliseconds\n    }) ?? null\n    : null;\n\n  const noticeMinTimeoutPromise = sleep(fullOptions.noticeMinTimeoutInMilliseconds);\n  let lastUIUpdateTimestamp = performance.now();\n\n  try {\n    for (const item of items) {\n      if (fullOptions.abortSignal.aborted) {\n        return;\n      }\n      iterationCount++;\n      const iterationString = `# ${String(iterationCount)} / ${String(items.length)}`;\n      const message = fullOptions.buildNoticeMessage({ item, iterationString });\n      if (!fullOptions.shouldShowProgressBar) {\n        latestMessage = message;\n        if (isNoticeShown) {\n          delayedNotice?.setContent(message);\n        }\n      }\n      getObsidianLibDebugger('Loop')(message);\n\n      try {\n        if (performance.now() - lastUIUpdateTimestamp > fullOptions.uiUpdateThresholdInMilliseconds) {\n          await requestAnimationFrameAsync();\n          lastUIUpdateTimestamp = performance.now();\n        }\n        await fullOptions.processItem(item);\n      } catch (error) {\n        console.error('Error processing item', item);\n        if (!fullOptions.shouldContinueOnError) {\n          throw new CustomStackTraceError({\n            cause: error,\n            message: 'loop failed',\n            stackTrace\n          });\n        }\n\n        emitAsyncErrorEvent(\n          new CustomStackTraceError({\n            cause: error,\n            message: ASYNC_WRAPPER_ERROR_MESSAGE,\n            stackTrace\n          })\n        );\n      }\n      progressBarEl.value++;\n    }\n    if (isNoticeShown) {\n      await noticeMinTimeoutPromise;\n    }\n  } finally {\n    // Disposed by an explicit call rather than a `using` declaration: `using` looks the method up under a different\n    // key than the handle is built with on an engine lacking `Symbol.dispose`, and `loop()` runs on every platform.\n    delayedNotice?.[Symbol.dispose]();\n  }\n\n  function buildProgressBarFragment(): DocumentFragment {\n    const fragment = createFragment();\n    fragment.createDiv({ text: fullOptions.progressBarTitle });\n    fragment.append(progressBarEl);\n    return fragment;\n  }\n}\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAQA,SAAS,wBAAwB;AACjC,SAAS,kCAAkC;AAC3C;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,YAAY;AAIrB,SAAS,8BAA8B;AACvC,SAAS,2BAA2B;AA+GpC,eAAsB,KAAQ,QAAsC;AAClE,QAAM,kBAAkB;AAAA,IACtB,aAAa,iBAAiB;AAAA;AAAA,IAE9B,qBAA6B;AAC3B,YAAM,IAAI,MAAM,gCAAgC;AAAA,IAClD;AAAA;AAAA,IAEA,OAAO,CAAC;AAAA;AAAA,IAER,wCAAwC;AAAA;AAAA,IAExC,gCAAgC;AAAA,IAChC,aAAa;AAAA,IACb,kBAAkB;AAAA,IAClB,uBAAuB;AAAA,IACvB,kBAAkB;AAAA,IAClB,uBAAuB;AAAA;AAAA,IAEvB,iCAAiC;AAAA,EACnC;AAEA,QAAM,cAAuC;AAAA,IAC3C,GAAG;AAAA,IACH,GAAG;AAAA,EACL;AAEA,QAAM,aAAa,cAAc,CAAC;AAElC,QAAM,QAAQ,YAAY;AAC1B,MAAI,iBAAiB;AAErB,QAAM,gBAAgB,SAAS,UAAU;AACzC,sBAAoB,eAAe,MAAM;AACzC,gBAAc,MAAM,MAAM;AAG1B,MAAI,gBAAgB;AACpB,MAAI,gBAAgB;AAGpB,QAAM,gBAAgB,YAAY,mBAC9B,OAAO,uBAAuB,qBAAqB;AAAA,IACnD,SAAS,MAAM;AACb,sBAAgB;AAChB,aAAO,YAAY,wBAAwB,yBAAyB,IAAI;AAAA,IAC1E;AAAA,IACA,qBAAqB,YAAY;AAAA,EACnC,CAAC,KAAK,OACJ;AAEJ,QAAM,0BAA0B,MAAM,YAAY,8BAA8B;AAChF,MAAI,wBAAwB,YAAY,IAAI;AAE5C,MAAI;AACF,eAAW,QAAQ,OAAO;AACxB,UAAI,YAAY,YAAY,SAAS;AACnC;AAAA,MACF;AACA;AACA,YAAM,kBAAkB,KAAK,OAAO,cAAc,CAAC,MAAM,OAAO,MAAM,MAAM,CAAC;AAC7E,YAAM,UAAU,YAAY,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACxE,UAAI,CAAC,YAAY,uBAAuB;AACtC,wBAAgB;AAChB,YAAI,eAAe;AACjB,yBAAe,WAAW,OAAO;AAAA,QACnC;AAAA,MACF;AACA,6BAAuB,MAAM,EAAE,OAAO;AAEtC,UAAI;AACF,YAAI,YAAY,IAAI,IAAI,wBAAwB,YAAY,iCAAiC;AAC3F,gBAAM,2BAA2B;AACjC,kCAAwB,YAAY,IAAI;AAAA,QAC1C;AACA,cAAM,YAAY,YAAY,IAAI;AAAA,MACpC,SAAS,OAAO;AACd,gBAAQ,MAAM,yBAAyB,IAAI;AAC3C,YAAI,CAAC,YAAY,uBAAuB;AACtC,gBAAM,IAAI,sBAAsB;AAAA,YAC9B,OAAO;AAAA,YACP,SAAS;AAAA,YACT;AAAA,UACF,CAAC;AAAA,QACH;AAEA;AAAA,UACE,IAAI,sBAAsB;AAAA,YACxB,OAAO;AAAA,YACP,SAAS;AAAA,YACT;AAAA,UACF,CAAC;AAAA,QACH;AAAA,MACF;AACA,oBAAc;AAAA,IAChB;AACA,QAAI,eAAe;AACjB,YAAM;AAAA,IACR;AAAA,EACF,UAAE;AAGA,oBAAgB,OAAO,OAAO,EAAE;AAAA,EAClC;AAEA,WAAS,2BAA6C;AACpD,UAAM,WAAW,eAAe;AAChC,aAAS,UAAU,EAAE,MAAM,YAAY,iBAAiB,CAAC;AACzD,aAAS,OAAO,aAAa;AAC7B,WAAO;AAAA,EACT;AACF;",
  "names": []
}


package/dist/lib/esm/markdown-code-block-processor-registrar.d.mts

@@ -0,0 +1,62 @@
+/// <reference path="./library.d.mts" />
+/**
+ * @file
+ *
+ * Registers a markdown code block processor.
+ */
+import type { MarkdownPostProcessor, MarkdownPostProcessorContext, Plugin } from 'obsidian';
+import type { Promisable } from 'type-fest';
+/**
+ * A registrar for markdown code block processors.
+ */
+export interface MarkdownCodeBlockProcessorRegistrar {
+    /**
+     * Registers a markdown code block processor.
+     *
+     * @param params - The parameters for the markdown code block processor.
+     * @returns The markdown post processor.
+     */
+    registerMarkdownCodeBlockProcessor: (params: MarkdownCodeBlockProcessorRegistrarRegisterMarkdownCodeBlockProcessorParams) => MarkdownPostProcessor;
+}
+interface MarkdownCodeBlockProcessorRegistrarRegisterMarkdownCodeBlockProcessorParams {
+    /**
+     * Handler function for the code block processor.
+     *
+     * @param source - The source code of the code block.
+     * @param element - The HTML element representing the code block.
+     * @param context - The context for the markdown post processor.
+     */
+    readonly handler: (source: string, element: HTMLElement, context: MarkdownPostProcessorContext) => Promisable<void>;
+    /**
+     * The language of the code block to register the processor for.
+     */
+    readonly language: string;
+    /**
+     * The sort order of the processor. Lower numbers are processed first. Defaults to 0.
+     */
+    readonly sortOrder?: number;
+}
+type PluginMarkdownCodeBlockProcessorRegistrarRegisterMarkdownCodeBlockProcessorParams = MarkdownCodeBlockProcessorRegistrarRegisterMarkdownCodeBlockProcessorParams;
+/**
+ * A registrar for markdown code block processors.
+ */
+export declare class PluginMarkdownCodeBlockProcessorRegistrar implements MarkdownCodeBlockProcessorRegistrar {
+    /**
+     * The Obsidian plugin instance the code block processors are registered with.
+     */
+    protected readonly plugin: Plugin;
+    /**
+     * Creates a new markdown code block processor registrar.
+     *
+     * @param plugin - The plugin to register the markdown code block processor with.
+     */
+    constructor(plugin: Plugin);
+    /**
+     * Registers a markdown code block processor.
+     *
+     * @param params - The parameters for the markdown code block processor.
+     * @returns The markdown post processor.
+     */
+    registerMarkdownCodeBlockProcessor(params: PluginMarkdownCodeBlockProcessorRegistrarRegisterMarkdownCodeBlockProcessorParams): MarkdownPostProcessor;
+}
+export {};

package/dist/lib/esm/markdown-code-block-processor-registrar.mjs

@@ -0,0 +1,77 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+(function () {
+function ensureDisposeSymbols(symbolConstructor = Symbol) {
+  symbolConstructor.asyncDispose ??= symbolConstructor.for('Symbol.asyncDispose');
+  symbolConstructor.dispose ??= symbolConstructor.for('Symbol.dispose');
+}
+
+function ensureBrowserProcess() {
+  const browserProcess = {
+    browser: true,
+    cwd() {
+      return '/';
+    },
+    env: {},
+    platform: 'android'
+  };
+
+  // eslint-disable-next-line obsidianmd/no-global-this, unicorn/no-unnecessary-global-this -- Must stay `globalThis`-qualified: in the emitted banner a bare `process` is a free identifier, so reading it where the host has none throws a ReferenceError instead of yielding `undefined`. That is the very case this function exists to handle.
+  const existingProcess = globalThis.process;
+
+  if (!existingProcess) {
+    // eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
+    globalThis.process = browserProcess;
+    return;
+  }
+
+  if (existingProcess.versions?.node) {
+    return;
+  }
+
+  const existingProcessRecord = existingProcess;
+
+  for (const [key, value] of Object.entries(browserProcess)) {
+    existingProcessRecord[key] ??= value;
+  }
+
+  existingProcessRecord['browser'] = true;
+}
+
+(function initEsm() {
+  ensureDisposeSymbols();
+  ensureBrowserProcess();
+})();
+})();
+
+import { normalizePromisable } from "@mnaoumov/typescript-lib/async";
+class PluginMarkdownCodeBlockProcessorRegistrar {
+  /**
+   * The Obsidian plugin instance the code block processors are registered with.
+   */
+  plugin;
+  /**
+   * Creates a new markdown code block processor registrar.
+   *
+   * @param plugin - The plugin to register the markdown code block processor with.
+   */
+  constructor(plugin) {
+    this.plugin = plugin;
+  }
+  /**
+   * Registers a markdown code block processor.
+   *
+   * @param params - The parameters for the markdown code block processor.
+   * @returns The markdown post processor.
+   */
+  registerMarkdownCodeBlockProcessor(params) {
+    return this.plugin.registerMarkdownCodeBlockProcessor(params.language, (source, element, context) => normalizePromisable(params.handler(source, element, context)), params.sortOrder);
+  }
+}
+export {
+  PluginMarkdownCodeBlockProcessorRegistrar
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjL21hcmtkb3duLWNvZGUtYmxvY2stcHJvY2Vzc29yLXJlZ2lzdHJhci50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyoqXG4gKiBAZmlsZVxuICpcbiAqIFJlZ2lzdGVycyBhIG1hcmtkb3duIGNvZGUgYmxvY2sgcHJvY2Vzc29yLlxuICovXG5cbmltcG9ydCB0eXBlIHtcbiAgTWFya2Rvd25Qb3N0UHJvY2Vzc29yLFxuICBNYXJrZG93blBvc3RQcm9jZXNzb3JDb250ZXh0LFxuICBQbHVnaW5cbn0gZnJvbSAnb2JzaWRpYW4nO1xuaW1wb3J0IHR5cGUgeyBQcm9taXNhYmxlIH0gZnJvbSAndHlwZS1mZXN0JztcblxuaW1wb3J0IHsgbm9ybWFsaXplUHJvbWlzYWJsZSB9IGZyb20gJ0BtbmFvdW1vdi90eXBlc2NyaXB0LWxpYi9hc3luYyc7XG5cbi8qKlxuICogQSByZWdpc3RyYXIgZm9yIG1hcmtkb3duIGNvZGUgYmxvY2sgcHJvY2Vzc29ycy5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBNYXJrZG93bkNvZGVCbG9ja1Byb2Nlc3NvclJlZ2lzdHJhciB7XG4gIC8qKlxuICAgKiBSZWdpc3RlcnMgYSBtYXJrZG93biBjb2RlIGJsb2NrIHByb2Nlc3Nvci5cbiAgICpcbiAgICogQHBhcmFtIHBhcmFtcyAtIFRoZSBwYXJhbWV0ZXJzIGZvciB0aGUgbWFya2Rvd24gY29kZSBibG9jayBwcm9jZXNzb3IuXG4gICAqIEByZXR1cm5zIFRoZSBtYXJrZG93biBwb3N0IHByb2Nlc3Nvci5cbiAgICovXG4gIHJlZ2lzdGVyTWFya2Rvd25Db2RlQmxvY2tQcm9jZXNzb3I6IChwYXJhbXM6IE1hcmtkb3duQ29kZUJsb2NrUHJvY2Vzc29yUmVnaXN0cmFyUmVnaXN0ZXJNYXJrZG93bkNvZGVCbG9ja1Byb2Nlc3NvclBhcmFtcykgPT4gTWFya2Rvd25Qb3N0UHJvY2Vzc29yO1xufVxuXG5pbnRlcmZhY2UgTWFya2Rvd25Db2RlQmxvY2tQcm9jZXNzb3JSZWdpc3RyYXJSZWdpc3Rlck1hcmtkb3duQ29kZUJsb2NrUHJvY2Vzc29yUGFyYW1zIHtcbiAgLyoqXG4gICAqIEhhbmRsZXIgZnVuY3Rpb24gZm9yIHRoZSBjb2RlIGJsb2NrIHByb2Nlc3Nvci5cbiAgICpcbiAgICogQHBhcmFtIHNvdXJjZSAtIFRoZSBzb3VyY2UgY29kZSBvZiB0aGUgY29kZSBibG9jay5cbiAgICogQHBhcmFtIGVsZW1lbnQgLSBUaGUgSFRNTCBlbGVtZW50IHJlcHJlc2VudGluZyB0aGUgY29kZSBibG9jay5cbiAgICogQHBhcmFtIGNvbnRleHQgLSBUaGUgY29udGV4dCBmb3IgdGhlIG1hcmtkb3duIHBvc3QgcHJvY2Vzc29yLlxuICAgKi9cbiAgcmVhZG9ubHkgaGFuZGxlcjogKHNvdXJjZTogc3RyaW5nLCBlbGVtZW50OiBIVE1MRWxlbWVudCwgY29udGV4dDogTWFya2Rvd25Qb3N0UHJvY2Vzc29yQ29udGV4dCkgPT4gUHJvbWlzYWJsZTx2b2lkPjtcblxuICAvKipcbiAgICogVGhlIGxhbmd1YWdlIG9mIHRoZSBjb2RlIGJsb2NrIHRvIHJlZ2lzdGVyIHRoZSBwcm9jZXNzb3IgZm9yLlxuICAgKi9cbiAgcmVhZG9ubHkgbGFuZ3VhZ2U6IHN0cmluZztcblxuICAvKipcbiAgICogVGhlIHNvcnQgb3JkZXIgb2YgdGhlIHByb2Nlc3Nvci4gTG93ZXIgbnVtYmVycyBhcmUgcHJvY2Vzc2VkIGZpcnN0LiBEZWZhdWx0cyB0byAwLlxuICAgKi9cbiAgcmVhZG9ubHkgc29ydE9yZGVyPzogbnVtYmVyO1xufVxuXG50eXBlIFBsdWdpbk1hcmtkb3duQ29kZUJsb2NrUHJvY2Vzc29yUmVnaXN0cmFyUmVnaXN0ZXJNYXJrZG93bkNvZGVCbG9ja1Byb2Nlc3NvclBhcmFtcyA9IE1hcmtkb3duQ29kZUJsb2NrUHJvY2Vzc29yUmVnaXN0cmFyUmVnaXN0ZXJNYXJrZG93bkNvZGVCbG9ja1Byb2Nlc3NvclBhcmFtcztcblxuLyoqXG4gKiBBIHJlZ2lzdHJhciBmb3IgbWFya2Rvd24gY29kZSBibG9jayBwcm9jZXNzb3JzLlxuICovXG5leHBvcnQgY2xhc3MgUGx1Z2luTWFya2Rvd25Db2RlQmxvY2tQcm9jZXNzb3JSZWdpc3RyYXIgaW1wbGVtZW50cyBNYXJrZG93bkNvZGVCbG9ja1Byb2Nlc3NvclJlZ2lzdHJhciB7XG4gIC8qKlxuICAgKiBUaGUgT2JzaWRpYW4gcGx1Z2luIGluc3RhbmNlIHRoZSBjb2RlIGJsb2NrIHByb2Nlc3NvcnMgYXJlIHJlZ2lzdGVyZWQgd2l0aC5cbiAgICovXG4gIHByb3RlY3RlZCByZWFkb25seSBwbHVnaW46IFBsdWdpbjtcblxuICAvKipcbiAgICogQ3JlYXRlcyBhIG5ldyBtYXJrZG93biBjb2RlIGJsb2NrIHByb2Nlc3NvciByZWdpc3RyYXIuXG4gICAqXG4gICAqIEBwYXJhbSBwbHVnaW4gLSBUaGUgcGx1Z2luIHRvIHJlZ2lzdGVyIHRoZSBtYXJrZG93biBjb2RlIGJsb2NrIHByb2Nlc3NvciB3aXRoLlxuICAgKi9cbiAgcHVibGljIGNvbnN0cnVjdG9yKHBsdWdpbjogUGx1Z2luKSB7XG4gICAgdGhpcy5wbHVnaW4gPSBwbHVnaW47XG4gIH1cblxuICAvKipcbiAgICogUmVnaXN0ZXJzIGEgbWFya2Rvd24gY29kZSBibG9jayBwcm9jZXNzb3IuXG4gICAqXG4gICAqIEBwYXJhbSBwYXJhbXMgLSBUaGUgcGFyYW1ldGVycyBmb3IgdGhlIG1hcmtkb3duIGNvZGUgYmxvY2sgcHJvY2Vzc29yLlxuICAgKiBAcmV0dXJucyBUaGUgbWFya2Rvd24gcG9zdCBwcm9jZXNzb3IuXG4gICAqL1xuICBwdWJsaWMgcmVnaXN0ZXJNYXJrZG93bkNvZGVCbG9ja1Byb2Nlc3NvcihwYXJhbXM6IFBsdWdpbk1hcmtkb3duQ29kZUJsb2NrUHJvY2Vzc29yUmVnaXN0cmFyUmVnaXN0ZXJNYXJrZG93bkNvZGVCbG9ja1Byb2Nlc3NvclBhcmFtcyk6IE1hcmtkb3duUG9zdFByb2Nlc3NvciB7XG4gICAgcmV0dXJuIHRoaXMucGx1Z2luLnJlZ2lzdGVyTWFya2Rvd25Db2RlQmxvY2tQcm9jZXNzb3IocGFyYW1zLmxhbmd1YWdlLCAoc291cmNlLCBlbGVtZW50LCBjb250ZXh0KSA9PiBub3JtYWxpemVQcm9taXNhYmxlKHBhcmFtcy5oYW5kbGVyKHNvdXJjZSwgZWxlbWVudCwgY29udGV4dCkpLCBwYXJhbXMuc29ydE9yZGVyKTtcbiAgfVxufVxuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQWFBLFNBQVMsMkJBQTJCO0FBeUM3QixNQUFNLDBDQUF5RjtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBSWpGO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBT1osWUFBWSxRQUFnQjtBQUNqQyxTQUFLLFNBQVM7QUFBQSxFQUNoQjtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBUU8sbUNBQW1DLFFBQWtIO0FBQzFKLFdBQU8sS0FBSyxPQUFPLG1DQUFtQyxPQUFPLFVBQVUsQ0FBQyxRQUFRLFNBQVMsWUFBWSxvQkFBb0IsT0FBTyxRQUFRLFFBQVEsU0FBUyxPQUFPLENBQUMsR0FBRyxPQUFPLFNBQVM7QUFBQSxFQUN0TDtBQUNGOyIsCiAgIm5hbWVzIjogW10KfQo=