@mnaoumov/obsidian-lib 0.0.0 → 1.0.1

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

@@ -0,0 +1,249 @@
+/// <reference path="./library.d.cts" />
+/**
+ * @file
+ *
+ * This module provides utility functions for working with Dataview in Obsidian.
+ */
+import type { Promisable } from 'type-fest' with { 'resolution-mode': 'import' };
+import type { DataviewInlineApi as DataviewInlineApiOriginal } from './@types/dataview/api/inline-api.d.cjs';
+import type { DataArray, DataviewApi, SMarkdownPage } from './@types/dataview/index.d.cjs';
+import type { PathOrFile } from './file-system.cjs';
+import type { CombinedFrontmatter } from './frontmatter.cjs';
+/**
+ * Export DateTime and Link types from the Dataview API.
+ */
+export type { DateTime, Link } from './@types/dataview/index.d.cjs';
+declare global {
+    /**
+     * A {@link DataviewApi} object represents the API for interacting with Dataview in Obsidian.
+     */
+    var DataviewAPI: DataviewApi | undefined;
+}
+/**
+ * A combined page type, which includes the front matter and the SMarkdownPage.
+ *
+ * @typeParam CustomFrontmatter - The type of the custom front matter.
+ */
+export type CombinedPage<CustomFrontmatter = unknown> = CombinedFrontmatter<CustomFrontmatter> & SMarkdownPage;
+/**
+ * Extended interface for the Dataview Inline API, providing additional methods for custom page types and array handling.
+ */
+export interface DataviewInlineApi extends DataviewInlineApiOriginal {
+    /**
+     * Wraps an array of items into a {@link DataArray} object.
+     *
+     * @typeParam T - The type of the items in the array.
+     * @param array - The array of items to wrap.
+     * @returns A {@link DataArray} containing the items.
+     */
+    array: <T>(array: T[]) => DataArray<T>;
+    /**
+     * Retrieves the current page, with an optional custom page type.
+     *
+     * @typeParam CustomPage - The type of the custom page. Defaults to `SMarkdownPage`.
+     * @returns The current page.
+     */
+    current: <CustomFrontmatter = unknown>() => CombinedPage<CustomFrontmatter>;
+    /**
+     * Retrieves pages based on an optional query, with an optional custom page type.
+     *
+     * @typeParam CustomPage - The type of the custom page. Defaults to `SMarkdownPage`.
+     * @param query - An optional string query to filter the pages.
+     * @returns A {@link DataArray} of pages matching the query.
+     */
+    pages: <CustomFrontmatter = unknown>(query?: string) => DataArray<CombinedPage<CustomFrontmatter>>;
+    /**
+     * Creates a paragraph HTML element with the provided text and optional DOM element options.
+     *
+     * @param text - The content of the paragraph.
+     * @param options - Optional DOM element options, including an optional container.
+     * @returns The created HTML paragraph element.
+     */
+    paragraph: (text: unknown, options?: DomElementInfoWithContainer) => HTMLParagraphElement;
+}
+/**
+ * DomElementInfo with an optional container.
+ */
+export type DomElementInfoWithContainer = ContainerInfo & DomElementInfo;
+/**
+ * A combined file type, which includes the front matter and the SMarkdownFile.
+ */
+export type PageFile = SMarkdownPage['file'];
+/**
+ * List of page files.
+ */
+export type PageFiles = ArrayOrDataArray<PageFile>;
+interface ContainerInfo {
+    container?: HTMLElement;
+}
+/**
+ * Reloads the current file cache using the Dataview API.
+ *
+ * @param dv - The DataviewInlineApi instance.
+ * @returns A {@link Promise} that resolves when the cache is reloaded.
+ */
+export declare function reloadCurrentFileCache(dv: DataviewInlineApi): Promise<void>;
+/**
+ * Array or DataArray type.
+ *
+ * @typeParam T - The type of the elements.
+ */
+export type ArrayOrDataArray<T> = DataArray<T> | T[];
+/**
+ * Parameters for {@link insertCodeBlock}.
+ */
+export interface InsertCodeBlockParams {
+    /**
+     * The code content to be inserted into the code block.
+     */
+    readonly code: string;
+    /**
+     * The DataviewInlineApi instance to insert the code block into.
+     */
+    readonly dv: DataviewInlineApi;
+    /**
+     * The language identifier for the code block.
+     */
+    readonly language: string;
+}
+/**
+ * Options for {@link renderIframe}.
+ */
+export interface RenderIframeParams {
+    /**
+     * A {@link DataviewInlineApi} instance.
+     */
+    readonly dv: DataviewInlineApi;
+    /**
+     * A height of the iframe.
+     *
+     * @default `'600px'`
+     */
+    readonly height?: string;
+    /**
+     * A relative path to the resource to be displayed in the iframe.
+     */
+    readonly relativePathOrFile: PathOrFile;
+    /**
+     * A width of the iframe.
+     *
+     * @default `'100%'`
+     */
+    readonly width?: string;
+}
+/**
+ * Options for {@link renderPaginatedList}.
+ *
+ * @typeParam T - The type of the list items.
+ */
+export interface RenderPaginatedListParams<T> {
+    /**
+     * A {@link DataviewInlineApi} instance.
+     */
+    readonly dv: DataviewInlineApi;
+    /**
+     * Options for items per page.
+     *
+     * @default `[10, 20, 50, 100]`
+     */
+    readonly itemsPerPageOptions?: number[];
+    /**
+     * A list of items to paginate.
+     */
+    readonly rows: ArrayOrDataArray<T>;
+}
+/**
+ * Options for {@link renderPaginated}.
+ *
+ * @typeParam T - The type of the items to paginate.
+ */
+export interface RenderPaginatedParams<T> {
+    /**
+     * A {@link DataviewInlineApi} instance.
+     */
+    readonly dv: DataviewInlineApi;
+    /**
+     * Options for items per page.
+     *
+     * @default `[10, 20, 50, 100]`
+     */
+    readonly itemsPerPageOptions?: number[];
+    /**
+     * Display the paginated content.
+     *
+     * @param rowsForOnePage - The rows to render.
+     * @returns A {@link Promise} that resolves when the content is rendered.
+     */
+    readonly renderer: (rowsForOnePage: ArrayOrDataArray<T>) => Promisable<void>;
+    /**
+     * Rows to paginate.
+     */
+    readonly rows: ArrayOrDataArray<T>;
+}
+/**
+ * Options for {@link renderPaginatedTable}.
+ *
+ * @typeParam T - The type of the table row data.
+ */
+export interface RenderPaginatedTableParams<T> {
+    /**
+     * A {@link DataviewInlineApi} instance.
+     */
+    readonly dv: DataviewInlineApi;
+    /**
+     * A headers of the table.
+     */
+    readonly headers: string[];
+    /**
+     * Options for items per page.
+     *
+     * @default `[10, 20, 50, 100]`
+     */
+    readonly itemsPerPageOptions?: number[];
+    /**
+     * Rows of the table to paginate.
+     */
+    readonly rows: ArrayOrDataArray<T>;
+}
+/**
+ * Renders the content using the provided renderer function in a temporary container,
+ * and then returns the container.
+ *
+ * @param dv - The DataviewInlineApi instance.
+ * @param renderer - The function responsible for rendering the content.
+ * @returns A {@link Promise} that resolves to the HTML paragraph element
+ * that was used as the temporary container.
+ */
+export declare function getRenderedContainer(dv: DataviewInlineApi, renderer: () => Promisable<void>): Promise<HTMLParagraphElement>;
+/**
+ * Inserts a code block into the specified Dataview instance using the provided language and code.
+ *
+ * @param params - The parameters for inserting the code block.
+ */
+export declare function insertCodeBlock(params: InsertCodeBlockParams): void;
+/**
+ * Renders an iframe in the Dataview container with the specified relative path, width, and height.
+ *
+ * @param params - The parameters for rendering the iframe.
+ */
+export declare function renderIframe(params: RenderIframeParams): void;
+/**
+ * Renders a paginated list using the provided DataviewInlineApi instance.
+ *
+ * @typeParam T - The type of items in the list.
+ *
+ * @param params - The parameters for rendering the paginated list.
+ *
+ * @returns A {@link Promise} that resolves when the list is rendered.
+ */
+export declare function renderPaginatedList<T>(params: RenderPaginatedListParams<T>): Promise<void>;
+/**
+ * Renders a paginated table using the provided DataviewInlineApi instance.
+ *
+ * @typeParam T - The type of items in the table rows.
+ *
+ * @param params - The parameters for rendering the paginated table.
+ *
+ * @returns A {@link Promise} that resolves when the table is rendered.
+ */
+export declare function renderPaginatedTable<T extends unknown[]>(params: RenderPaginatedTableParams<T>): Promise<void>;

package/dist/lib/cjs/debug.cjs

@@ -0,0 +1,148 @@
+/*
+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"
+  };
+  const existingProcess = globalThis.process;
+  if (!existingProcess) {
+    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 keepName($unknown) {
+  return $unknown;
+}
+
+(function initCjs() {
+  const globalThisRecord = globalThis;
+  ensureDisposeSymbols();
+  globalThisRecord["__name"] ??= keepName;
+  globalThisRecord["__extractDefault"] ??= extractDefault;
+  ensureBrowserProcess();
+  function extractDefault(module) {
+    return module && module.__esModule && "default" in module ? module.default : module;
+  }
+})();
+})();
+(function patchObsidianRequire() {
+  const originalRequire = require;
+  if (!originalRequire || originalRequire.__isPatched) {
+    return;
+  }
+  require = Object.assign(
+    (id) => requirePatched(id),
+    originalRequire,
+    {
+      __isPatched: true
+    }
+  );
+  function extractDefault(module) {
+    return module && module.__esModule && "default" in module ? module.default : module;
+  }
+  const OBSIDIAN_BUILT_IN_MODULE_NAMES = /* @__PURE__ */ new Set([
+    "@codemirror/autocomplete",
+    "@codemirror/collab",
+    "@codemirror/commands",
+    "@codemirror/language",
+    "@codemirror/lint",
+    "@codemirror/search",
+    "@codemirror/state",
+    "@codemirror/text",
+    "@codemirror/view",
+    "@lezer/common",
+    "@lezer/highlight",
+    "@lezer/lr",
+    "obsidian"
+  ]);
+  const DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES = /* @__PURE__ */ new Set([
+    "@codemirror/closebrackets",
+    "@codemirror/comment",
+    "@codemirror/fold",
+    "@codemirror/gutter",
+    "@codemirror/highlight",
+    "@codemirror/history",
+    "@codemirror/matchbrackets",
+    "@codemirror/panel",
+    "@codemirror/rangeset",
+    "@codemirror/rectangular-selection",
+    "@codemirror/stream-parser",
+    "@codemirror/tooltip"
+  ]);
+  function requirePatched(id) {
+    if (OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id) || DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id)) {
+      return originalRequire?.(id);
+    }
+    if (globalThis.app.isMobile) {
+      if (id === "process" || id === "node:process") {
+        console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Fake process object is returned instead.`);
+        return process;
+      }
+    } else {
+      const module = originalRequire?.(id);
+      if (module) {
+        return extractDefault(module);
+      }
+    }
+    console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Empty object is returned instead.`);
+    return {};
+  }
+})();
+
+"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 debug_exports = {};
+__export(debug_exports, {
+  getObsidianLibDebugger: () => getObsidianLibDebugger
+});
+module.exports = __toCommonJS(debug_exports);
+var import_debug = require('@mnaoumov/typescript-lib/debug');
+var import_library = require('@mnaoumov/typescript-lib/library');
+var import_library2 = require('./library.cjs');
+function getObsidianLibDebugger(namespace) {
+  return (0, import_debug.getDebugger)(`${import_library.Library.debugPrefixNamespace}${import_library2.OBSIDIAN_LIBRARY_NAME}:${namespace}`);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getObsidianLibDebugger
+});
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjL2RlYnVnLnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyIvKipcbiAqIEBmaWxlXG4gKlxuICogVGhlIGRlYnVnZ2VycyBvZiBgQG1uYW91bW92L29ic2lkaWFuLWxpYmAncyBvd24gbW9kdWxlcy5cbiAqL1xuXG5pbXBvcnQgeyBnZXREZWJ1Z2dlciB9IGZyb20gJ0BtbmFvdW1vdi90eXBlc2NyaXB0LWxpYi9kZWJ1Zyc7XG5pbXBvcnQgeyBMaWJyYXJ5IH0gZnJvbSAnQG1uYW91bW92L3R5cGVzY3JpcHQtbGliL2xpYnJhcnknO1xuXG5pbXBvcnQgeyBPQlNJRElBTl9MSUJSQVJZX05BTUUgfSBmcm9tICcuL2xpYnJhcnkudHMnO1xuXG4vKipcbiAqIFJldHVybnMgYSBkZWJ1Z2dlciBmb3Igb25lIG9mIHRoaXMgbGlicmFyeSdzIG93biBtb2R1bGVzLlxuICpcbiAqIFRoZSBuYW1lc3BhY2UgaXMgYWx3YXlzIHVuZGVyIHtAbGluayBPQlNJRElBTl9MSUJSQVJZX05BTUV9LCB3aGV0aGVyIG9yIG5vdCBgaW5pdFBsdWdpbkNvbnRleHRgIGhhcyBydW4geWV0LCBzb1xuICogYSBuYW1lc3BhY2UgYSBndWlkZSB0ZWxscyB1c2VycyB0byBlbmFibGUgKGBvYnNpZGlhbi1kZXYtdXRpbHM6UGx1Z2luQXBpYCkgbWVhbnMgdGhlIHNhbWUgdGhpbmcgaW4gYSB0ZXN0LCBpbiBhXG4gKiBzY3JpcHQgYW5kIGluIGEgcGx1Z2luLiBUaGUgZ2VuZXJpYyBtb2R1bGVzIG9mIGBAbW5hb3Vtb3YvdHlwZXNjcmlwdC1saWJgIGxvZyB1bmRlciB0aGUgbmFtZXNwYWNlXG4gKiBgaW5pdFBsdWdpbkNvbnRleHRgIGluamVjdHMgaW50byB0aGUgZ2VuZXJpYyBgTGlicmFyeWAsIHdoaWNoIGlzIHRoZSBzYW1lIG9uZSBvbmNlIGEgcGx1Z2luIGlzIHVwLlxuICpcbiAqIEBwYXJhbSBuYW1lc3BhY2UgLSBUaGUgbmFtZXNwYWNlIHdpdGhpbiB0aGUgbGlicmFyeSdzLlxuICogQHJldHVybnMgVGhlIGRlYnVnZ2VyLlxuICovXG5leHBvcnQgZnVuY3Rpb24gZ2V0T2JzaWRpYW5MaWJEZWJ1Z2dlcihuYW1lc3BhY2U6IHN0cmluZyk6IFJldHVyblR5cGU8dHlwZW9mIGdldERlYnVnZ2VyPiB7XG4gIHJldHVybiBnZXREZWJ1Z2dlcihgJHtMaWJyYXJ5LmRlYnVnUHJlZml4TmFtZXNwYWNlfSR7T0JTSURJQU5fTElCUkFSWV9OQU1FfToke25hbWVzcGFjZX1gKTtcbn1cbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFNQSxtQkFBNEI7QUFDNUIscUJBQXdCO0FBRXhCLElBQUFBLGtCQUFzQztBQWEvQixTQUFTLHVCQUF1QixXQUFtRDtBQUN4RixhQUFPLDBCQUFZLEdBQUcsdUJBQVEsb0JBQW9CLEdBQUcscUNBQXFCLElBQUksU0FBUyxFQUFFO0FBQzNGOyIsCiAgIm5hbWVzIjogWyJpbXBvcnRfbGlicmFyeSJdCn0K

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

@@ -0,0 +1,19 @@
+/// <reference path="./library.d.cts" />
+/**
+ * @file
+ *
+ * The debuggers of `@mnaoumov/obsidian-lib`'s own modules.
+ */
+import { getDebugger } from '@mnaoumov/typescript-lib/debug';
+/**
+ * Returns a debugger for one of this library's own modules.
+ *
+ * The namespace is always under {@link OBSIDIAN_LIBRARY_NAME}, whether or not `initPluginContext` has run yet, so
+ * a namespace a guide tells users to enable (`obsidian-dev-utils:PluginApi`) means the same thing in a test, in a
+ * script and in a plugin. The generic modules of `@mnaoumov/typescript-lib` log under the namespace
+ * `initPluginContext` injects into the generic `Library`, which is the same one once a plugin is up.
+ *
+ * @param namespace - The namespace within the library's.
+ * @returns The debugger.
+ */
+export declare function getObsidianLibDebugger(namespace: string): ReturnType<typeof getDebugger>;

package/dist/lib/cjs/demo-vault-helper-settings.cjs

@@ -0,0 +1,131 @@
+/*
+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"
+  };
+  const existingProcess = globalThis.process;
+  if (!existingProcess) {
+    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 keepName($unknown) {
+  return $unknown;
+}
+
+(function initCjs() {
+  const globalThisRecord = globalThis;
+  ensureDisposeSymbols();
+  globalThisRecord["__name"] ??= keepName;
+  globalThisRecord["__extractDefault"] ??= extractDefault;
+  ensureBrowserProcess();
+  function extractDefault(module) {
+    return module && module.__esModule && "default" in module ? module.default : module;
+  }
+})();
+})();
+(function patchObsidianRequire() {
+  const originalRequire = require;
+  if (!originalRequire || originalRequire.__isPatched) {
+    return;
+  }
+  require = Object.assign(
+    (id) => requirePatched(id),
+    originalRequire,
+    {
+      __isPatched: true
+    }
+  );
+  function extractDefault(module) {
+    return module && module.__esModule && "default" in module ? module.default : module;
+  }
+  const OBSIDIAN_BUILT_IN_MODULE_NAMES = /* @__PURE__ */ new Set([
+    "@codemirror/autocomplete",
+    "@codemirror/collab",
+    "@codemirror/commands",
+    "@codemirror/language",
+    "@codemirror/lint",
+    "@codemirror/search",
+    "@codemirror/state",
+    "@codemirror/text",
+    "@codemirror/view",
+    "@lezer/common",
+    "@lezer/highlight",
+    "@lezer/lr",
+    "obsidian"
+  ]);
+  const DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES = /* @__PURE__ */ new Set([
+    "@codemirror/closebrackets",
+    "@codemirror/comment",
+    "@codemirror/fold",
+    "@codemirror/gutter",
+    "@codemirror/highlight",
+    "@codemirror/history",
+    "@codemirror/matchbrackets",
+    "@codemirror/panel",
+    "@codemirror/rangeset",
+    "@codemirror/rectangular-selection",
+    "@codemirror/stream-parser",
+    "@codemirror/tooltip"
+  ]);
+  function requirePatched(id) {
+    if (OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id) || DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id)) {
+      return originalRequire?.(id);
+    }
+    if (globalThis.app.isMobile) {
+      if (id === "process" || id === "node:process") {
+        console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Fake process object is returned instead.`);
+        return process;
+      }
+    } else {
+      const module = originalRequire?.(id);
+      if (module) {
+        return extractDefault(module);
+      }
+    }
+    console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Empty object is returned instead.`);
+    return {};
+  }
+})();
+
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 demo_vault_helper_settings_exports = {};
+module.exports = __toCommonJS(demo_vault_helper_settings_exports);
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjL2RlbW8tdmF1bHQtaGVscGVyLXNldHRpbmdzLnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyIvKipcbiAqIEBmaWxlXG4gKlxuICogVGhlIGBkZW1vLXZhdWx0LWhlbHBlcmAgcGx1Z2luJ3Mgb3duIHNldHRpbmdzIFx1MjAxNCB0aGUgY29udHJhY3QgYmV0d2VlbiB0aGUgZGVtby12YXVsdCBwYWNrYWdpbmcgc3RlcFxuICogYW5kIHRoZSBib290c3RyYXAgdGhhdCBydW5zIGluc2lkZSB0aGUgb3BlbmVkIHZhdWx0LlxuICpcbiAqIFRoZSBoZWxwZXIgaGFzIHRvIG5hbWUgdGhlIHBsdWdpbiB0aGUgdmF1bHQgZGVtb25zdHJhdGVzLCBhbmQgbm90aGluZyBpbnNpZGUgdGhlIHZhdWx0IHJlbGlhYmx5IHNheXNcbiAqIHdoaWNoIG9uZSB0aGF0IGlzOiB0aGUgcGx1Z2luIGZvbGRlcnMgYWxzbyBob2xkIHRoZSBoZWxwZXIgaXRzZWxmLCBDb2RlU2NyaXB0IFRvb2xraXQgb25jZSB0aGVcbiAqIGJvb3RzdHJhcCBoYXMgaW5zdGFsbGVkIGl0LCBhbmQgYW55dGhpbmcgYSBkZW1vIG5vdGUncyBwcmVyZXF1aXNpdGVzIGluc3RhbGxlZCwgc28gY291bnRpbmcgdGhlbVxuICogZ3Vlc3NlcyAoYW5kIGd1ZXNzZXMgZGlmZmVyZW50bHkgb24gYSByZS1vcGVuKS4gVGhlIHBhY2thZ2luZyBzdGVwLCBvbiB0aGUgb3RoZXIgaGFuZCwgS05PV1MgXHUyMDE0IGl0XG4gKiByZWFkcyB0aGUgcGx1Z2luJ3MgYG1hbmlmZXN0Lmpzb25gIHRvIG5hbWUgdGhlIGFyY2hpdmUgXHUyMDE0IHNvIGl0IHdyaXRlcyB0aGUgaWQgZG93biBoZXJlIGFuZCB0aGVcbiAqIGJvb3RzdHJhcCBzaW1wbHkgcmVhZHMgaXQuXG4gKlxuICogVGhlIG1hcmtlciBhbmQgdGhlIGhlbHBlciBiaW5hcnkgYXJlIHdyaXR0ZW4gdG9nZXRoZXIsIGJ5IHRoZSBzYW1lIGBvYnNpZGlhbi1kZXYtdXRpbHNgIHZlcnNpb24sIGludG9cbiAqIHRoZSBzYW1lIGFyY2hpdmUsIHNvIHRoZSB0d28gY2FuIG5ldmVyIGRpc2FncmVlLlxuICpcbiAqIEtlcHQgZnJlZSBvZiBgb2JzaWRpYW5gIGltcG9ydHMgb24gcHVycG9zZTogdGhlIHBhY2thZ2luZyBzdGVwICh7QGxpbmsgYXJjaGl2ZVBsdWdpbkRlbW9WYXVsdH0pIHJ1bnNcbiAqIHVuZGVyIE5vZGUsIHdoZXJlIHRoZSBgb2JzaWRpYW5gIG1vZHVsZSBkb2VzIG5vdCBleGlzdC5cbiAqL1xuXG4vKipcbiAqIFRoZSBgZGVtby12YXVsdC1oZWxwZXJgIHBsdWdpbidzIGBkYXRhLmpzb25gLCB3cml0dGVuIGludG8gdGhlIGRlbW8gdmF1bHQgYXQgcGFja2FnaW5nIHRpbWUuXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgRGVtb1ZhdWx0SGVscGVyU2V0dGluZ3Mge1xuICAvKipcbiAgICogVGhlIGlkIG9mIHRoZSBwbHVnaW4gdGhlIHZhdWx0IGRlbW9uc3RyYXRlcywgdGFrZW4gZnJvbSB0aGF0IHBsdWdpbidzIGBtYW5pZmVzdC5qc29uYC5cbiAgICovXG4gIHJlYWRvbmx5IGRlbW9lZFBsdWdpbklkOiBzdHJpbmc7XG59XG4iXSwKICAibWFwcGluZ3MiOiAiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBO0FBQUE7IiwKICAibmFtZXMiOiBbXQp9Cg==

package/dist/lib/cjs/demo-vault-helper-settings.d.cts

@@ -0,0 +1,29 @@
+/// <reference path="./library.d.cts" />
+/**
+ * @file
+ *
+ * The `demo-vault-helper` plugin's own settings — the contract between the demo-vault packaging step
+ * and the bootstrap that runs inside the opened vault.
+ *
+ * The helper has to name the plugin the vault demonstrates, and nothing inside the vault reliably says
+ * which one that is: the plugin folders also hold the helper itself, CodeScript Toolkit once the
+ * bootstrap has installed it, and anything a demo note's prerequisites installed, so counting them
+ * guesses (and guesses differently on a re-open). The packaging step, on the other hand, KNOWS — it
+ * reads the plugin's `manifest.json` to name the archive — so it writes the id down here and the
+ * bootstrap simply reads it.
+ *
+ * The marker and the helper binary are written together, by the same `obsidian-dev-utils` version, into
+ * the same archive, so the two can never disagree.
+ *
+ * Kept free of `obsidian` imports on purpose: the packaging step ({@link archivePluginDemoVault}) runs
+ * under Node, where the `obsidian` module does not exist.
+ */
+/**
+ * The `demo-vault-helper` plugin's `data.json`, written into the demo vault at packaging time.
+ */
+export interface DemoVaultHelperSettings {
+    /**
+     * The id of the plugin the vault demonstrates, taken from that plugin's `manifest.json`.
+     */
+    readonly demoedPluginId: string;
+}