@mnaoumov/obsidian-lib 10.10.0 → 10.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (133) hide show
  1. package/README.md +26 -0
  2. package/components/all-windows-status-bar-item-component/package.json +6 -0
  3. package/components/shared-component-pool-component/package.json +6 -0
  4. package/components/workspace-layout-state-component/package.json +6 -0
  5. package/dist/lib/cjs/__merged.cjs +90 -1
  6. package/dist/lib/cjs/__merged.d.cts +13 -4
  7. package/dist/lib/cjs/bug-report-diagnostics.cjs +222 -0
  8. package/dist/lib/cjs/bug-report-diagnostics.d.cts +186 -0
  9. package/dist/lib/cjs/bug-report.cjs +36 -10
  10. package/dist/lib/cjs/bug-report.d.cts +65 -0
  11. package/dist/lib/cjs/command-handlers/open-bug-report-command-handler.cjs +93 -2
  12. package/dist/lib/cjs/command-handlers/open-bug-report-command-handler.d.cts +34 -2
  13. package/dist/lib/cjs/components/all-windows-status-bar-item-component.cjs +245 -0
  14. package/dist/lib/cjs/components/all-windows-status-bar-item-component.d.cts +146 -0
  15. package/dist/lib/cjs/components/embed-extensions-component.cjs +20 -3
  16. package/dist/lib/cjs/components/embed-extensions-component.d.cts +8 -0
  17. package/dist/lib/cjs/components/embeddable-markdown-editor-component.cjs +16 -2
  18. package/dist/lib/cjs/components/embeddable-markdown-editor-component.d.cts +9 -0
  19. package/dist/lib/cjs/components/index.cjs +12 -3
  20. package/dist/lib/cjs/components/index.d.cts +3 -0
  21. package/dist/lib/cjs/components/plugin-gate-component.cjs +2 -9
  22. package/dist/lib/cjs/components/plugin-settings-component.cjs +7 -2
  23. package/dist/lib/cjs/components/shared-component-pool-component.cjs +368 -0
  24. package/dist/lib/cjs/components/shared-component-pool-component.d.cts +129 -0
  25. package/dist/lib/cjs/components/workspace-layout-state-component.cjs +495 -0
  26. package/dist/lib/cjs/components/workspace-layout-state-component.d.cts +239 -0
  27. package/dist/lib/cjs/css-class.cjs +5 -1
  28. package/dist/lib/cjs/css-class.d.cts +16 -0
  29. package/dist/lib/cjs/data-handler.cjs +156 -5
  30. package/dist/lib/cjs/data-handler.d.cts +128 -2
  31. package/dist/lib/cjs/desktop-git-runner.cjs +4 -14
  32. package/dist/lib/cjs/desktop-git-runner.d.cts +8 -2
  33. package/dist/lib/cjs/generated-during-build.cjs +2 -2
  34. package/dist/lib/cjs/git-rename-history.cjs +1 -1
  35. package/dist/lib/cjs/git-rename-history.d.cts +2 -2
  36. package/dist/lib/cjs/i18n/locales/en.cjs +29 -1
  37. package/dist/lib/cjs/i18n/locales/en.d.cts +28 -0
  38. package/dist/lib/cjs/i18n/locales/translations-map.d.cts +28 -0
  39. package/dist/lib/cjs/index.cjs +10 -1
  40. package/dist/lib/cjs/index.d.cts +3 -0
  41. package/dist/lib/cjs/link.cjs +40 -1
  42. package/dist/lib/cjs/link.d.cts +37 -1
  43. package/dist/lib/cjs/markdown-view.cjs +191 -3
  44. package/dist/lib/cjs/markdown-view.d.cts +48 -1
  45. package/dist/lib/cjs/modals/copy-text-manually.cjs +181 -0
  46. package/dist/lib/cjs/modals/copy-text-manually.d.cts +38 -0
  47. package/dist/lib/cjs/modals/index.cjs +7 -1
  48. package/dist/lib/cjs/modals/index.d.cts +2 -0
  49. package/dist/lib/cjs/modals/review-bug-report-diagnostics.cjs +202 -0
  50. package/dist/lib/cjs/modals/review-bug-report-diagnostics.d.cts +30 -0
  51. package/dist/lib/cjs/plugin/index.cjs +4 -1
  52. package/dist/lib/cjs/plugin/index.d.cts +1 -0
  53. package/dist/lib/cjs/plugin/plugin-api.cjs +13 -4
  54. package/dist/lib/cjs/plugin/plugin-api.d.cts +5 -1
  55. package/dist/lib/cjs/plugin/plugin-install-state.cjs +46 -1
  56. package/dist/lib/cjs/plugin/plugin-install-state.d.cts +30 -0
  57. package/dist/lib/cjs/plugin/plugin-instance.cjs +448 -0
  58. package/dist/lib/cjs/plugin/plugin-instance.d.cts +251 -0
  59. package/dist/lib/cjs/plugin/plugin.cjs +16 -1
  60. package/dist/lib/cjs/plugin/plugin.d.cts +7 -0
  61. package/dist/lib/cjs/reference-definition.cjs +234 -0
  62. package/dist/lib/cjs/reference-definition.d.cts +47 -0
  63. package/dist/lib/cjs/release-asset.cjs +279 -0
  64. package/dist/lib/cjs/release-asset.d.cts +190 -0
  65. package/dist/lib/cjs/workspace.cjs +3 -2
  66. package/dist/lib/cjs/workspace.d.cts +6 -0
  67. package/dist/lib/esm/__merged.d.mts +13 -4
  68. package/dist/lib/esm/__merged.mjs +97 -3
  69. package/dist/lib/esm/bug-report-diagnostics.d.mts +186 -0
  70. package/dist/lib/esm/bug-report-diagnostics.mjs +127 -0
  71. package/dist/lib/esm/bug-report.d.mts +65 -0
  72. package/dist/lib/esm/bug-report.mjs +33 -10
  73. package/dist/lib/esm/command-handlers/open-bug-report-command-handler.d.mts +34 -2
  74. package/dist/lib/esm/command-handlers/open-bug-report-command-handler.mjs +99 -3
  75. package/dist/lib/esm/components/all-windows-status-bar-item-component.d.mts +146 -0
  76. package/dist/lib/esm/components/all-windows-status-bar-item-component.mjs +154 -0
  77. package/dist/lib/esm/components/embed-extensions-component.d.mts +8 -0
  78. package/dist/lib/esm/components/embed-extensions-component.mjs +20 -3
  79. package/dist/lib/esm/components/embeddable-markdown-editor-component.d.mts +9 -0
  80. package/dist/lib/esm/components/embeddable-markdown-editor-component.mjs +16 -2
  81. package/dist/lib/esm/components/index.d.mts +3 -0
  82. package/dist/lib/esm/components/index.mjs +8 -2
  83. package/dist/lib/esm/components/plugin-gate-component.mjs +5 -13
  84. package/dist/lib/esm/components/plugin-settings-component.mjs +7 -2
  85. package/dist/lib/esm/components/shared-component-pool-component.d.mts +129 -0
  86. package/dist/lib/esm/components/shared-component-pool-component.mjs +280 -0
  87. package/dist/lib/esm/components/workspace-layout-state-component.d.mts +239 -0
  88. package/dist/lib/esm/components/workspace-layout-state-component.mjs +404 -0
  89. package/dist/lib/esm/css-class.d.mts +16 -0
  90. package/dist/lib/esm/css-class.mjs +5 -1
  91. package/dist/lib/esm/data-handler.d.mts +128 -2
  92. package/dist/lib/esm/data-handler.mjs +152 -4
  93. package/dist/lib/esm/desktop-git-runner.d.mts +8 -2
  94. package/dist/lib/esm/desktop-git-runner.mjs +3 -3
  95. package/dist/lib/esm/generated-during-build.mjs +2 -2
  96. package/dist/lib/esm/git-rename-history.d.mts +2 -2
  97. package/dist/lib/esm/git-rename-history.mjs +1 -1
  98. package/dist/lib/esm/i18n/locales/en.d.mts +28 -0
  99. package/dist/lib/esm/i18n/locales/en.mjs +29 -1
  100. package/dist/lib/esm/i18n/locales/translations-map.d.mts +28 -0
  101. package/dist/lib/esm/index.d.mts +3 -0
  102. package/dist/lib/esm/index.mjs +7 -1
  103. package/dist/lib/esm/link.d.mts +37 -1
  104. package/dist/lib/esm/link.mjs +40 -1
  105. package/dist/lib/esm/markdown-view.d.mts +48 -1
  106. package/dist/lib/esm/markdown-view.mjs +192 -2
  107. package/dist/lib/esm/modals/copy-text-manually.d.mts +38 -0
  108. package/dist/lib/esm/modals/copy-text-manually.mjs +99 -0
  109. package/dist/lib/esm/modals/index.d.mts +2 -0
  110. package/dist/lib/esm/modals/index.mjs +5 -1
  111. package/dist/lib/esm/modals/review-bug-report-diagnostics.d.mts +30 -0
  112. package/dist/lib/esm/modals/review-bug-report-diagnostics.mjs +120 -0
  113. package/dist/lib/esm/plugin/index.d.mts +1 -0
  114. package/dist/lib/esm/plugin/index.mjs +3 -1
  115. package/dist/lib/esm/plugin/plugin-api.d.mts +5 -1
  116. package/dist/lib/esm/plugin/plugin-api.mjs +13 -4
  117. package/dist/lib/esm/plugin/plugin-install-state.d.mts +30 -0
  118. package/dist/lib/esm/plugin/plugin-install-state.mjs +44 -1
  119. package/dist/lib/esm/plugin/plugin-instance.d.mts +251 -0
  120. package/dist/lib/esm/plugin/plugin-instance.mjs +366 -0
  121. package/dist/lib/esm/plugin/plugin.d.mts +7 -0
  122. package/dist/lib/esm/plugin/plugin.mjs +16 -1
  123. package/dist/lib/esm/reference-definition.d.mts +47 -0
  124. package/dist/lib/esm/reference-definition.mjs +146 -0
  125. package/dist/lib/esm/release-asset.d.mts +190 -0
  126. package/dist/lib/esm/release-asset.mjs +187 -0
  127. package/dist/lib/esm/workspace.d.mts +6 -0
  128. package/dist/lib/esm/workspace.mjs +3 -2
  129. package/dist/styles.css +16 -1
  130. package/modals/copy-text-manually/package.json +6 -0
  131. package/modals/review-bug-report-diagnostics/package.json +6 -0
  132. package/package.json +2 -1
  133. package/plugin/plugin-instance/package.json +6 -0
@@ -9,7 +9,8 @@ export { getIndexedBacklinksForFile, iterateReferencesAffectedByRename } from '.
9
9
  export { renderBacklinksTable, renderDelayedBacklinks, renderDelayedBacklinksForFolder } from './backlink.cjs';
10
10
  export { PluginBasesViewRegistrar } from './bases-view-registrar.cjs';
11
11
  export { BrokenLinkCandidateFinder, BrokenLinkEvidenceKind, getParentPath, getPathMapping } from './broken-link-candidates.cjs';
12
- export { BUG_REPORT_ISSUE_FORM_TEMPLATE, BugReportIssueFormFieldId, formatBugReportEnvironment, getBugReportEnvironment, getBugReportIssueFormUrl, getGitHubIssueFormUrl } from './bug-report.cjs';
12
+ export { BugReportLogBuffer, createSettingsDiagnosticSection, DEFAULT_BUG_REPORT_LOG_MAX_ENTRIES, DEFAULT_BUG_REPORT_LOG_MAX_ENTRY_LENGTH, formatBugReportDiagnostics, getMarkdownFence, REDACTED_VALUE, redactSettings } from './bug-report-diagnostics.cjs';
13
+ export { BUG_REPORT_ISSUE_FORM_TEMPLATE, BUG_REPORT_PASTE_INSTRUCTIONS, BugReportIssueFormFieldId, buildBugReportIssueFormLink, DEFAULT_BUG_REPORT_MAX_URL_LENGTH, formatBugReportEnvironment, getBugReportEnvironment, getBugReportIssueFormUrl, getGitHubIssueFormUrl } from './bug-report.cjs';
13
14
  export { BULK_OPERATION_HOLD_INTERVAL_IN_MILLISECONDS, holdBulkOperationWhile, registerBulkOperationProgressListener, reportBulkOperationProgress } from './bulk-operation-progress.cjs';
14
15
  export { buildBeforeOperationCommitSubject, buildOperationCommitMessage, BULK_OPERATION_LOCK_FILE_NAME, BULK_OPERATION_LOCK_STALE_AFTER_IN_MILLISECONDS, formatOperationId, getNextOperationId, isBulkOperationLock, isBulkOperationLockStale, OPERATION_TRAILER_KEY, parseBulkOperationCommit, parseOperationNumber, PLUGIN_TRAILER_KEY } from './bulk-operation.cjs';
15
16
  export { CalloutMode, renderCallout, wrapForCallout } from './callout.cjs';
@@ -42,6 +43,7 @@ export { PluginCommandRegistrar } from './command-registrar.cjs';
42
43
  export { configureCommunityPlugin, ConfigureCommunityPluginResult, disableCommunityPlugin, enableCommunityPlugin, getCommunityPluginRepo, getLatestReleaseVersion, installCommunityPlugin, installConfigureEnableCommunityPlugin, PluginEnableRefusedError, searchCommunityPlugins, toggleEnableCommunityPlugin, toggleInstallCommunityPlugin, uninstallCommunityPlugin, updateCommunityPlugin, UpdateCommunityPluginResult } from './community-plugins.cjs';
43
44
  export { AbortSignalComponent } from './components/abort-signal-component.cjs';
44
45
  export { AllWindowsEventComponent, forEachWindow, registerBodyClass } from './components/all-windows-event-component.cjs';
46
+ export { AllWindowsStatusBarItemComponent, getPluginStatusBarItemCssClass, registerAllWindowsStatusBarItem, WINDOW_STATUS_BAR_CSS_CLASS } from './components/all-windows-status-bar-item-component.cjs';
45
47
  export { AsyncErrorHandlerComponent } from './components/async-error-handler-component.cjs';
46
48
  export { registerAsyncEvent } from './components/async-events-component.cjs';
47
49
  export { BulkOperationCommitComponent } from './components/bulk-operation-commit-component.cjs';
@@ -73,12 +75,14 @@ export { EmptyFolderBehavior, RenameDeleteHandlerComponent } from './components/
73
75
  export { NOT_EMPTY_DIRECTORY_ERROR_CODE, RmdirGuardComponent } from './components/rmdir-guard-component.cjs';
74
76
  export { SettingsFacetComponent } from './components/settings-facet-component.cjs';
75
77
  export { SettingsMigrationComponent } from './components/settings-migration-component.cjs';
78
+ export { SharedComponentPoolComponent } from './components/shared-component-pool-component.cjs';
76
79
  export { registerStyle, StyleSheetComponent } from './components/style-sheet-component.cjs';
77
80
  export { SyntaxHighlightingComponent } from './components/syntax-highlighting-component.cjs';
78
81
  export { TemplatesLanguageComponent } from './components/templates-language-component.cjs';
82
+ export { parseWorkspaceLayoutStateRecord, serializeWorkspaceLayoutStateRecord, WORKSPACE_LAYOUT_STATE_LAYOUT_KEY, WorkspaceLayoutStateComponent } from './components/workspace-layout-state-component.cjs';
79
83
  export { getDomEventsHandlersConstructor } from './constructors/get-dom-events-handlers-constructor.cjs';
80
84
  export { CssClass } from './css-class.cjs';
81
- export { PluginDataHandler } from './data-handler.cjs';
85
+ export { DEFAULT_PLUGIN_DATA_MAX_SIZE_IN_BYTES, PluginDataHandler, PluginDataOperation, PluginDataSizeLimitExceededError } from './data-handler.cjs';
82
86
  export { DataStoreLocations } from './data-stores/data-store-locations.cjs';
83
87
  export { DataStoreReplica, isDataStoreJsonValue, isDataStoreOperation } from './data-stores/data-store-replica.cjs';
84
88
  export { DataStoreSeeds, validateDataStoreSeed } from './data-stores/data-store-seeds.cjs';
@@ -132,7 +136,7 @@ export { loop } from './loop.cjs';
132
136
  export { PluginMarkdownCodeBlockProcessorRegistrar } from './markdown-code-block-processor-registrar.cjs';
133
137
  export { getCodeBlockMarkdownInfo, insertAfterCodeBlock, insertBeforeCodeBlock, removeCodeBlock, replaceCodeBlock } from './markdown-code-block-processor.cjs';
134
138
  export { PluginMarkdownPostProcessorRegistrar } from './markdown-post-processor-registrar.cjs';
135
- export { getFullContentHtml } from './markdown-view.cjs';
139
+ export { getFullContentHtml, rerenderPreviews } from './markdown-view.cjs';
136
140
  export { fullRender, markdownToHtml, registerLinkHandlers, renderExternalLink, renderInternalLink } from './markdown.cjs';
137
141
  export { addSingleChoiceMenuItems } from './menu.cjs';
138
142
  export { ADVANCED_METADATA_CACHE_PLUGIN_ID, BACKLINK_CACHE_PLUGIN_ID, CachedMetadataExFeature, ensureMetadataCacheReady, getBacklinksForFileOrPath, getBacklinksForFileSafe, getCacheSafe, getFrontmatterSafe, getReferences, hasBacklinkCachePlugin, isCachedMetadataEx, parseMetadata, registerFileCacheForNonExistingFile, registerFiles, unregisterFileCacheForNonExistingFile, unregisterFiles } from './metadata-cache.cjs';
@@ -140,10 +144,12 @@ export { getMobileAppInfo } from './mobile-app-info.cjs';
140
144
  export { alert } from './modals/alert.cjs';
141
145
  export { formatCodeBlock, showCodeBlockBuilder } from './modals/code-block-builder.cjs';
142
146
  export { confirm } from './modals/confirm.cjs';
147
+ export { copyTextManually } from './modals/copy-text-manually.cjs';
143
148
  export { MinimizableModal } from './modals/minimizable-modal.cjs';
144
149
  export { ModalCommandBuilder, ModalCommandsRenderMode } from './modals/modal-command-builder.cjs';
145
150
  export { ModalBase, showModal } from './modals/modal.cjs';
146
151
  export { prompt } from './modals/prompt.cjs';
152
+ export { reviewBugReportDiagnostics } from './modals/review-bug-report-diagnostics.cjs';
147
153
  export { selectItem } from './modals/select-item.cjs';
148
154
  export { selectOption } from './modals/select-option.cjs';
149
155
  export { SuggestModalCommandBuilder } from './modals/suggest-modal-command-builder.cjs';
@@ -161,7 +167,8 @@ export { findPluginApi, getValidatePluginApiPayloadsDebugSwitch, PluginApiPayloa
161
167
  export { DEFAULT_PLUGIN_ASYNC_CLEANUP_TIMEOUT_IN_MILLISECONDS, didPluginAsyncCleanupsSettle, hasPendingPluginAsyncCleanups, PLUGIN_ASYNC_CLEANUPS_STATE_KEY, registerPluginAsyncCleanup, trackPluginAsyncCleanup } from './plugin/plugin-async-cleanup.cjs';
162
168
  export { addPluginCssClasses, initDebugController, initPluginContext } from './plugin/plugin-context.cjs';
163
169
  export { PluginEventSourceImpl } from './plugin/plugin-event-source.cjs';
164
- export { getInstalledPluginState, getInstalledPluginVersion, installAndEnablePlugin, InstalledPluginState, updatePlugin } from './plugin/plugin-install-state.cjs';
170
+ export { comparePluginVersionWithMinimum, getInstalledPluginState, getInstalledPluginVersion, installAndEnablePlugin, InstalledPluginState, PluginVersionComparison, updatePlugin } from './plugin/plugin-install-state.cjs';
171
+ export { getLoadedPlugin, getPluginAvailability, PluginAvailability, PluginInstanceUnavailableError, requirePlugin, waitForPlugin } from './plugin/plugin-instance.cjs';
165
172
  export { PLUGIN_LOADED_EVENT_NAME, PLUGIN_UNLOADED_EVENT_NAME, triggerPluginLifecycleEvent } from './plugin/plugin-lifecycle-events.cjs';
166
173
  export { PluginSettingsTabBase, SAVE_TO_FILE_CONTEXT } from './plugin/plugin-settings-tab.cjs';
167
174
  export { PluginBase, reloadPlugin, showErrorAndDisablePlugin } from './plugin/plugin.cjs';
@@ -173,7 +180,9 @@ export { isPositionInOffsetRange, isPositionInside, isPositionInsideSome } from
173
180
  export { checkPropertyEntryMatches, isPropertyEntry, PROPERTY_ENTRY_PREFIX } from './property-entry.cjs';
174
181
  export { addToQueue, addToQueueAndWait, flushQueue } from './queue.cjs';
175
182
  export { AppContext, useApp } from './react/app-context.cjs';
183
+ export { referenceDefinitionToFileChange } from './reference-definition.cjs';
176
184
  export { getReferenceLinkText, isCanvasFileNodeReference, isCanvasReference, isCanvasTextNodeReference, isReferenceInHeading, isReferenceInOffsetRange, referenceToFileChange, sortReferences } from './reference.cjs';
185
+ export { computeSha256, ensureReleaseAsset, formatByteSize, getGitHubReleaseAssetUrl, ReleaseAssetChecksumError } from './release-asset.cjs';
177
186
  export { isOwnedByRenderedMarkdown, registerFoldHandlers, registerFootnoteLinkHandler } from './rendered-markdown.cjs';
178
187
  export { createRequestUrlFetch, encodeRequestUrlRequest, RequestUrlError, requestUrlEx, requestUrlStream } from './request-url.cjs';
179
188
  export { isResourceLockedForPath, isResourceLockedForPathByAncestor, lockResourceForPath, requestResourceUnlockForPath, ResourceLockComponent, ResourceLockedError, unlockResourceForPath } from './resource-lock.cjs';
@@ -0,0 +1,222 @@
1
+ /*
2
+ THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
3
+ if you want to view the source, please visit the github repository of this plugin
4
+ */
5
+ (function patchObsidianRequire() {
6
+ const originalRequire = require;
7
+ if (!originalRequire || originalRequire.__isPatched) {
8
+ return;
9
+ }
10
+ require = Object.assign(
11
+ (id) => requirePatched(id),
12
+ originalRequire,
13
+ {
14
+ __isPatched: true
15
+ }
16
+ );
17
+ function extractDefault($module) {
18
+ return $module && $module.__esModule && "default" in $module ? $module.default : $module;
19
+ }
20
+ const OBSIDIAN_BUILT_IN_MODULE_NAMES = /* @__PURE__ */ new Set([
21
+ "@codemirror/autocomplete",
22
+ "@codemirror/collab",
23
+ "@codemirror/commands",
24
+ "@codemirror/language",
25
+ "@codemirror/lint",
26
+ "@codemirror/search",
27
+ "@codemirror/state",
28
+ "@codemirror/text",
29
+ "@codemirror/view",
30
+ "@lezer/common",
31
+ "@lezer/highlight",
32
+ "@lezer/lr",
33
+ "obsidian"
34
+ ]);
35
+ const DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES = /* @__PURE__ */ new Set([
36
+ "@codemirror/closebrackets",
37
+ "@codemirror/comment",
38
+ "@codemirror/fold",
39
+ "@codemirror/gutter",
40
+ "@codemirror/highlight",
41
+ "@codemirror/history",
42
+ "@codemirror/matchbrackets",
43
+ "@codemirror/panel",
44
+ "@codemirror/rangeset",
45
+ "@codemirror/rectangular-selection",
46
+ "@codemirror/stream-parser",
47
+ "@codemirror/tooltip"
48
+ ]);
49
+ function requirePatched(id) {
50
+ if (OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id) || DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id)) {
51
+ return originalRequire?.(id);
52
+ }
53
+ const app = globalThis.app;
54
+ if (app?.isMobile) {
55
+ if (id === "process" || id === "node:process") {
56
+ console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Fake process object is returned instead.`);
57
+ return process;
58
+ }
59
+ } else {
60
+ const $module = originalRequire?.(id);
61
+ if ($module) {
62
+ return extractDefault($module);
63
+ }
64
+ }
65
+ console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Empty object is returned instead.`);
66
+ return {};
67
+ }
68
+ })();
69
+
70
+ "use strict";
71
+ var __defProp = Object.defineProperty;
72
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
73
+ var __getOwnPropNames = Object.getOwnPropertyNames;
74
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
75
+ var __export = (target, all) => {
76
+ for (var name in all)
77
+ __defProp(target, name, { get: all[name], enumerable: true });
78
+ };
79
+ var __copyProps = (to, from, except, desc) => {
80
+ if (from && typeof from === "object" || typeof from === "function") {
81
+ for (let key of __getOwnPropNames(from))
82
+ if (!__hasOwnProp.call(to, key) && key !== except)
83
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
84
+ }
85
+ return to;
86
+ };
87
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
88
+ var bug_report_diagnostics_exports = {};
89
+ __export(bug_report_diagnostics_exports, {
90
+ BugReportLogBuffer: () => BugReportLogBuffer,
91
+ DEFAULT_BUG_REPORT_LOG_MAX_ENTRIES: () => DEFAULT_BUG_REPORT_LOG_MAX_ENTRIES,
92
+ DEFAULT_BUG_REPORT_LOG_MAX_ENTRY_LENGTH: () => DEFAULT_BUG_REPORT_LOG_MAX_ENTRY_LENGTH,
93
+ REDACTED_VALUE: () => REDACTED_VALUE,
94
+ createSettingsDiagnosticSection: () => createSettingsDiagnosticSection,
95
+ formatBugReportDiagnostics: () => formatBugReportDiagnostics,
96
+ getMarkdownFence: () => getMarkdownFence,
97
+ redactSettings: () => redactSettings
98
+ });
99
+ module.exports = __toCommonJS(bug_report_diagnostics_exports);
100
+ const REDACTED_VALUE = "[redacted]";
101
+ const DEFAULT_BUG_REPORT_LOG_MAX_ENTRIES = 200;
102
+ const DEFAULT_BUG_REPORT_LOG_MAX_ENTRY_LENGTH = 2e3;
103
+ const JSON_INDENT = 2;
104
+ const MIN_FENCE_LENGTH = 3;
105
+ const TRUNCATION_MARKER = " [truncated]";
106
+ class BugReportLogBuffer {
107
+ entries = [];
108
+ maxEntries;
109
+ maxEntryLength;
110
+ now;
111
+ /**
112
+ * Constructs a new instance.
113
+ *
114
+ * @param options - Constructor options.
115
+ */
116
+ constructor(options = {}) {
117
+ this.maxEntries = Math.max(1, Math.floor(options.maxEntries ?? DEFAULT_BUG_REPORT_LOG_MAX_ENTRIES));
118
+ this.maxEntryLength = Math.max(1, Math.floor(options.maxEntryLength ?? DEFAULT_BUG_REPORT_LOG_MAX_ENTRY_LENGTH));
119
+ this.now = options.now ?? (() => /* @__PURE__ */ new Date());
120
+ }
121
+ /**
122
+ * Adds an entry, stamped with the current time.
123
+ *
124
+ * @param message - The entry's text.
125
+ */
126
+ add(message) {
127
+ const text = message.length > this.maxEntryLength ? message.slice(0, this.maxEntryLength) + TRUNCATION_MARKER : message;
128
+ this.entries.push(`${this.now().toISOString()} ${text}`);
129
+ if (this.entries.length > this.maxEntries) {
130
+ this.entries.splice(0, this.entries.length - this.maxEntries);
131
+ }
132
+ }
133
+ /**
134
+ * Removes every entry.
135
+ */
136
+ clear() {
137
+ this.entries.length = 0;
138
+ }
139
+ /**
140
+ * Gets the entries, oldest first.
141
+ *
142
+ * @returns The entries.
143
+ */
144
+ getEntries() {
145
+ return [...this.entries];
146
+ }
147
+ /**
148
+ * Builds a potentially private diagnostic section holding the entries.
149
+ *
150
+ * @param options - The options.
151
+ * @returns The section.
152
+ */
153
+ toSection(options = {}) {
154
+ return {
155
+ content: this.entries.length === 0 ? "(no log entries)" : this.entries.join("\n"),
156
+ id: options.id ?? "logs",
157
+ isPotentiallyPrivate: true,
158
+ title: options.title ?? "Logs"
159
+ };
160
+ }
161
+ }
162
+ function createSettingsDiagnosticSection(params) {
163
+ return {
164
+ content: JSON.stringify(redactSettings(params.settings, params.secretKeys ?? []), null, JSON_INDENT) ?? "undefined",
165
+ id: params.id ?? "settings",
166
+ isPotentiallyPrivate: true,
167
+ title: params.title ?? "Plugin settings"
168
+ };
169
+ }
170
+ function formatBugReportDiagnostics(sections) {
171
+ return sections.map((section) => {
172
+ const fence = getMarkdownFence(section.content);
173
+ return `### ${section.title}
174
+
175
+ ${fence}
176
+ ${section.content}
177
+ ${fence}`;
178
+ }).join("\n\n");
179
+ }
180
+ function getMarkdownFence(content) {
181
+ let longestRun = 0;
182
+ for (const match of content.matchAll(/`+/g)) {
183
+ longestRun = Math.max(longestRun, match[0].length);
184
+ }
185
+ return "`".repeat(Math.max(MIN_FENCE_LENGTH, longestRun + 1));
186
+ }
187
+ function redactSettings(settings, secretKeys) {
188
+ const lowerCaseSecretKeys = new Set(secretKeys.map((key) => key.toLowerCase()));
189
+ return redactValue(settings, lowerCaseSecretKeys, /* @__PURE__ */ new WeakSet());
190
+ }
191
+ function redactValue(value, lowerCaseSecretKeys, seen) {
192
+ if (typeof value !== "object" || value === null) {
193
+ return value;
194
+ }
195
+ if (seen.has(value)) {
196
+ return "[circular]";
197
+ }
198
+ seen.add(value);
199
+ if (Array.isArray(value)) {
200
+ const result2 = value.map((item) => redactValue(item, lowerCaseSecretKeys, seen));
201
+ seen.delete(value);
202
+ return result2;
203
+ }
204
+ const result = {};
205
+ for (const [key, child] of Object.entries(value)) {
206
+ result[key] = lowerCaseSecretKeys.has(key.toLowerCase()) ? REDACTED_VALUE : redactValue(child, lowerCaseSecretKeys, seen);
207
+ }
208
+ seen.delete(value);
209
+ return result;
210
+ }
211
+ // Annotate the CommonJS export names for ESM import in node:
212
+ 0 && (module.exports = {
213
+ BugReportLogBuffer,
214
+ DEFAULT_BUG_REPORT_LOG_MAX_ENTRIES,
215
+ DEFAULT_BUG_REPORT_LOG_MAX_ENTRY_LENGTH,
216
+ REDACTED_VALUE,
217
+ createSettingsDiagnosticSection,
218
+ formatBugReportDiagnostics,
219
+ getMarkdownFence,
220
+ redactSettings
221
+ });
222
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"sources":["../../../src/bug-report-diagnostics.ts"],"sourcesContent":["/**\n * @file\n *\n * Optional diagnostics a plugin can attach to a bug report: sections of text the user reviews before\n * anything leaves Obsidian, a bounded log buffer, and redaction of a plugin's own settings.\n *\n * Nothing here reads logs or settings by itself. A log buffer holds only what the plugin wrote to it since\n * the buffer was created, never the console's history, and a settings section holds only the object the\n * plugin hands over. Redaction replaces the values of caller-declared keys; it is not a promise to find\n * every secret, which is why every section is shown to the user, and a potentially private one is left\n * out unless the user includes it.\n */\n\n/**\n * A section of diagnostics for a bug report.\n */\nexport interface BugReportDiagnosticSection {\n  /**\n   * The section's text, shown to the user and sent as written.\n   */\n  readonly content: string;\n\n  /**\n   * A stable id, unique among the sections of one report.\n   */\n  readonly id: string;\n\n  /**\n   * Whether the section can hold private data, such as logs or settings. A potentially private section is\n   * left out of the report unless the user includes it.\n   *\n   * @default `false`\n   */\n  readonly isPotentiallyPrivate?: boolean;\n\n  /**\n   * The section's title.\n   */\n  readonly title: string;\n}\n\n/**\n * Constructor parameters for {@link BugReportLogBuffer}.\n */\nexport interface BugReportLogBufferConstructorOptions {\n  /**\n   * The most entries kept. Older entries are dropped first.\n   *\n   * @default {@link DEFAULT_BUG_REPORT_LOG_MAX_ENTRIES}\n   */\n  readonly maxEntries?: number;\n\n  /**\n   * The most characters kept of one entry. A longer entry is cut, and says so.\n   *\n   * @default {@link DEFAULT_BUG_REPORT_LOG_MAX_ENTRY_LENGTH}\n   */\n  readonly maxEntryLength?: number;\n\n  /**\n   * Gets the current time. For tests.\n   *\n   * @default `() => new Date()`\n   */\n  readonly now?: () => Date;\n}\n\n/**\n * Parameters for {@link BugReportLogBuffer.toSection}.\n */\nexport interface BugReportLogBufferToSectionOptions {\n  /**\n   * The section's id.\n   *\n   * @default `'logs'`\n   */\n  readonly id?: string;\n\n  /**\n   * The section's title.\n   *\n   * @default `'Logs'`\n   */\n  readonly title?: string;\n}\n\n/**\n * Parameters for {@link createSettingsDiagnosticSection}.\n */\nexport interface CreateSettingsDiagnosticSectionParams {\n  /**\n   * The section's id.\n   *\n   * @default `'settings'`\n   */\n  readonly id?: string;\n\n  /**\n   * The keys whose values are replaced with {@link REDACTED_VALUE}, at any depth, compared without case.\n   */\n  readonly secretKeys?: readonly string[];\n\n  /**\n   * The reporting plugin's own settings, such as its `data.json`.\n   */\n  readonly settings: unknown;\n\n  /**\n   * The section's title.\n   *\n   * @default `'Plugin settings'`\n   */\n  readonly title?: string;\n}\n\n/**\n * The value that replaces a redacted setting.\n */\nexport const REDACTED_VALUE = '[redacted]';\n\n/**\n * The default number of entries a {@link BugReportLogBuffer} keeps.\n */\nexport const DEFAULT_BUG_REPORT_LOG_MAX_ENTRIES = 200;\n\n/**\n * The default number of characters a {@link BugReportLogBuffer} keeps of one entry.\n */\nexport const DEFAULT_BUG_REPORT_LOG_MAX_ENTRY_LENGTH = 2000;\n\nconst JSON_INDENT = 2;\nconst MIN_FENCE_LENGTH = 3;\nconst TRUNCATION_MARKER = ' [truncated]';\n\n/**\n * A bounded buffer of log entries a plugin writes for its bug reports. It keeps only what the plugin adds\n * after creating it, at most {@link BugReportLogBufferConstructorOptions.maxEntries} entries, each cut to\n * {@link BugReportLogBufferConstructorOptions.maxEntryLength} characters.\n */\nexport class BugReportLogBuffer {\n  private readonly entries: string[] = [];\n  private readonly maxEntries: number;\n  private readonly maxEntryLength: number;\n  private readonly now: () => Date;\n\n  /**\n   * Constructs a new instance.\n   *\n   * @param options - Constructor options.\n   */\n  public constructor(options: BugReportLogBufferConstructorOptions = {}) {\n    this.maxEntries = Math.max(1, Math.floor(options.maxEntries ?? DEFAULT_BUG_REPORT_LOG_MAX_ENTRIES));\n    this.maxEntryLength = Math.max(1, Math.floor(options.maxEntryLength ?? DEFAULT_BUG_REPORT_LOG_MAX_ENTRY_LENGTH));\n    this.now = options.now ?? ((): Date => new Date());\n  }\n\n  /**\n   * Adds an entry, stamped with the current time.\n   *\n   * @param message - The entry's text.\n   */\n  public add(message: string): void {\n    const text = message.length > this.maxEntryLength\n      ? message.slice(0, this.maxEntryLength) + TRUNCATION_MARKER\n      : message;\n    this.entries.push(`${this.now().toISOString()} ${text}`);\n    if (this.entries.length > this.maxEntries) {\n      this.entries.splice(0, this.entries.length - this.maxEntries);\n    }\n  }\n\n  /**\n   * Removes every entry.\n   */\n  public clear(): void {\n    this.entries.length = 0;\n  }\n\n  /**\n   * Gets the entries, oldest first.\n   *\n   * @returns The entries.\n   */\n  public getEntries(): readonly string[] {\n    return [...this.entries];\n  }\n\n  /**\n   * Builds a potentially private diagnostic section holding the entries.\n   *\n   * @param options - The options.\n   * @returns The section.\n   */\n  public toSection(options: BugReportLogBufferToSectionOptions = {}): BugReportDiagnosticSection {\n    return {\n      content: this.entries.length === 0 ? '(no log entries)' : this.entries.join('\\n'),\n      id: options.id ?? 'logs',\n      isPotentiallyPrivate: true,\n      title: options.title ?? 'Logs'\n    };\n  }\n}\n\n/**\n * Builds a potentially private diagnostic section holding the plugin's settings as JSON, with the values\n * of {@link CreateSettingsDiagnosticSectionParams.secretKeys} redacted.\n *\n * @param params - The parameters.\n * @returns The section.\n */\nexport function createSettingsDiagnosticSection(params: CreateSettingsDiagnosticSectionParams): BugReportDiagnosticSection {\n  return {\n    content: JSON.stringify(redactSettings(params.settings, params.secretKeys ?? []), null, JSON_INDENT) ?? 'undefined',\n    id: params.id ?? 'settings',\n    isPotentiallyPrivate: true,\n    title: params.title ?? 'Plugin settings'\n  };\n}\n\n/**\n * Renders diagnostic sections as Markdown: a level-3 heading and a fenced code block per section. The\n * fence is longer than any run of backticks in the content, so no content can close it.\n *\n * @param sections - The sections.\n * @returns The Markdown, or an empty string when there are no sections.\n */\nexport function formatBugReportDiagnostics(sections: readonly BugReportDiagnosticSection[]): string {\n  return sections.map((section) => {\n    const fence = getMarkdownFence(section.content);\n    return `### ${section.title}\\n\\n${fence}\\n${section.content}\\n${fence}`;\n  }).join('\\n\\n');\n}\n\n/**\n * Gets a Markdown code fence that the given content cannot close.\n *\n * @param content - The content to fence.\n * @returns A run of backticks longer than the longest run in the content, and at least three long.\n */\nexport function getMarkdownFence(content: string): string {\n  let longestRun = 0;\n  for (const match of content.matchAll(/`+/g)) {\n    longestRun = Math.max(longestRun, match[0].length);\n  }\n  return '`'.repeat(Math.max(MIN_FENCE_LENGTH, longestRun + 1));\n}\n\n/**\n * Copies settings, replacing the value of every key in `secretKeys`, at any depth and compared without\n * case, with {@link REDACTED_VALUE}. The original is not changed.\n *\n * @param settings - The settings.\n * @param secretKeys - The keys to redact.\n * @returns The redacted copy.\n */\nexport function redactSettings(settings: unknown, secretKeys: readonly string[]): unknown {\n  const lowerCaseSecretKeys = new Set(secretKeys.map((key) => key.toLowerCase()));\n  return redactValue(settings, lowerCaseSecretKeys, new WeakSet());\n}\n\nfunction redactValue(value: unknown, lowerCaseSecretKeys: ReadonlySet<string>, seen: WeakSet<object>): unknown {\n  if (typeof value !== 'object' || value === null) {\n    return value;\n  }\n\n  if (seen.has(value)) {\n    return '[circular]';\n  }\n  seen.add(value);\n\n  if (Array.isArray(value)) {\n    const result = value.map((item: unknown) => redactValue(item, lowerCaseSecretKeys, seen));\n    seen.delete(value);\n    return result;\n  }\n\n  const result: Record<string, unknown> = {};\n  for (const [key, child] of Object.entries(value)) {\n    result[key] = lowerCaseSecretKeys.has(key.toLowerCase()) ? REDACTED_VALUE : redactValue(child, lowerCaseSecretKeys, seen);\n  }\n  seen.delete(value);\n  return result;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAsHO,MAAM,iBAAiB;AAKvB,MAAM,qCAAqC;AAK3C,MAAM,0CAA0C;AAEvD,MAAM,cAAc;AACpB,MAAM,mBAAmB;AACzB,MAAM,oBAAoB;AAOnB,MAAM,mBAAmB;AAAA,EACb,UAAoB,CAAC;AAAA,EACrB;AAAA,EACA;AAAA,EACA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOV,YAAY,UAAgD,CAAC,GAAG;AACrE,SAAK,aAAa,KAAK,IAAI,GAAG,KAAK,MAAM,QAAQ,cAAc,kCAAkC,CAAC;AAClG,SAAK,iBAAiB,KAAK,IAAI,GAAG,KAAK,MAAM,QAAQ,kBAAkB,uCAAuC,CAAC;AAC/G,SAAK,MAAM,QAAQ,QAAQ,MAAY,oBAAI,KAAK;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,IAAI,SAAuB;AAChC,UAAM,OAAO,QAAQ,SAAS,KAAK,iBAC/B,QAAQ,MAAM,GAAG,KAAK,cAAc,IAAI,oBACxC;AACJ,SAAK,QAAQ,KAAK,GAAG,KAAK,IAAI,EAAE,YAAY,CAAC,IAAI,IAAI,EAAE;AACvD,QAAI,KAAK,QAAQ,SAAS,KAAK,YAAY;AACzC,WAAK,QAAQ,OAAO,GAAG,KAAK,QAAQ,SAAS,KAAK,UAAU;AAAA,IAC9D;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKO,QAAc;AACnB,SAAK,QAAQ,SAAS;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,aAAgC;AACrC,WAAO,CAAC,GAAG,KAAK,OAAO;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,UAAU,UAA8C,CAAC,GAA+B;AAC7F,WAAO;AAAA,MACL,SAAS,KAAK,QAAQ,WAAW,IAAI,qBAAqB,KAAK,QAAQ,KAAK,IAAI;AAAA,MAChF,IAAI,QAAQ,MAAM;AAAA,MAClB,sBAAsB;AAAA,MACtB,OAAO,QAAQ,SAAS;AAAA,IAC1B;AAAA,EACF;AACF;AASO,SAAS,gCAAgC,QAA2E;AACzH,SAAO;AAAA,IACL,SAAS,KAAK,UAAU,eAAe,OAAO,UAAU,OAAO,cAAc,CAAC,CAAC,GAAG,MAAM,WAAW,KAAK;AAAA,IACxG,IAAI,OAAO,MAAM;AAAA,IACjB,sBAAsB;AAAA,IACtB,OAAO,OAAO,SAAS;AAAA,EACzB;AACF;AASO,SAAS,2BAA2B,UAAyD;AAClG,SAAO,SAAS,IAAI,CAAC,YAAY;AAC/B,UAAM,QAAQ,iBAAiB,QAAQ,OAAO;AAC9C,WAAO,OAAO,QAAQ,KAAK;AAAA;AAAA,EAAO,KAAK;AAAA,EAAK,QAAQ,OAAO;AAAA,EAAK,KAAK;AAAA,EACvE,CAAC,EAAE,KAAK,MAAM;AAChB;AAQO,SAAS,iBAAiB,SAAyB;AACxD,MAAI,aAAa;AACjB,aAAW,SAAS,QAAQ,SAAS,KAAK,GAAG;AAC3C,iBAAa,KAAK,IAAI,YAAY,MAAM,CAAC,EAAE,MAAM;AAAA,EACnD;AACA,SAAO,IAAI,OAAO,KAAK,IAAI,kBAAkB,aAAa,CAAC,CAAC;AAC9D;AAUO,SAAS,eAAe,UAAmB,YAAwC;AACxF,QAAM,sBAAsB,IAAI,IAAI,WAAW,IAAI,CAAC,QAAQ,IAAI,YAAY,CAAC,CAAC;AAC9E,SAAO,YAAY,UAAU,qBAAqB,oBAAI,QAAQ,CAAC;AACjE;AAEA,SAAS,YAAY,OAAgB,qBAA0C,MAAgC;AAC7G,MAAI,OAAO,UAAU,YAAY,UAAU,MAAM;AAC/C,WAAO;AAAA,EACT;AAEA,MAAI,KAAK,IAAI,KAAK,GAAG;AACnB,WAAO;AAAA,EACT;AACA,OAAK,IAAI,KAAK;AAEd,MAAI,MAAM,QAAQ,KAAK,GAAG;AACxB,UAAMA,UAAS,MAAM,IAAI,CAAC,SAAkB,YAAY,MAAM,qBAAqB,IAAI,CAAC;AACxF,SAAK,OAAO,KAAK;AACjB,WAAOA;AAAA,EACT;AAEA,QAAM,SAAkC,CAAC;AACzC,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,KAAK,GAAG;AAChD,WAAO,GAAG,IAAI,oBAAoB,IAAI,IAAI,YAAY,CAAC,IAAI,iBAAiB,YAAY,OAAO,qBAAqB,IAAI;AAAA,EAC1H;AACA,OAAK,OAAO,KAAK;AACjB,SAAO;AACT;","names":["result"]}
@@ -0,0 +1,186 @@
1
+ /// <reference path="./library-references.d.cts" />
2
+ /**
3
+ * @file
4
+ *
5
+ * Optional diagnostics a plugin can attach to a bug report: sections of text the user reviews before
6
+ * anything leaves Obsidian, a bounded log buffer, and redaction of a plugin's own settings.
7
+ *
8
+ * Nothing here reads logs or settings by itself. A log buffer holds only what the plugin wrote to it since
9
+ * the buffer was created, never the console's history, and a settings section holds only the object the
10
+ * plugin hands over. Redaction replaces the values of caller-declared keys; it is not a promise to find
11
+ * every secret, which is why every section is shown to the user, and a potentially private one is left
12
+ * out unless the user includes it.
13
+ */
14
+ /**
15
+ * A section of diagnostics for a bug report.
16
+ */
17
+ export interface BugReportDiagnosticSection {
18
+ /**
19
+ * The section's text, shown to the user and sent as written.
20
+ */
21
+ readonly content: string;
22
+ /**
23
+ * A stable id, unique among the sections of one report.
24
+ */
25
+ readonly id: string;
26
+ /**
27
+ * Whether the section can hold private data, such as logs or settings. A potentially private section is
28
+ * left out of the report unless the user includes it.
29
+ *
30
+ * @default `false`
31
+ */
32
+ readonly isPotentiallyPrivate?: boolean;
33
+ /**
34
+ * The section's title.
35
+ */
36
+ readonly title: string;
37
+ }
38
+ /**
39
+ * Constructor parameters for {@link BugReportLogBuffer}.
40
+ */
41
+ export interface BugReportLogBufferConstructorOptions {
42
+ /**
43
+ * The most entries kept. Older entries are dropped first.
44
+ *
45
+ * @default {@link DEFAULT_BUG_REPORT_LOG_MAX_ENTRIES}
46
+ */
47
+ readonly maxEntries?: number;
48
+ /**
49
+ * The most characters kept of one entry. A longer entry is cut, and says so.
50
+ *
51
+ * @default {@link DEFAULT_BUG_REPORT_LOG_MAX_ENTRY_LENGTH}
52
+ */
53
+ readonly maxEntryLength?: number;
54
+ /**
55
+ * Gets the current time. For tests.
56
+ *
57
+ * @default `() => new Date()`
58
+ */
59
+ readonly now?: () => Date;
60
+ }
61
+ /**
62
+ * Parameters for {@link BugReportLogBuffer.toSection}.
63
+ */
64
+ export interface BugReportLogBufferToSectionOptions {
65
+ /**
66
+ * The section's id.
67
+ *
68
+ * @default `'logs'`
69
+ */
70
+ readonly id?: string;
71
+ /**
72
+ * The section's title.
73
+ *
74
+ * @default `'Logs'`
75
+ */
76
+ readonly title?: string;
77
+ }
78
+ /**
79
+ * Parameters for {@link createSettingsDiagnosticSection}.
80
+ */
81
+ export interface CreateSettingsDiagnosticSectionParams {
82
+ /**
83
+ * The section's id.
84
+ *
85
+ * @default `'settings'`
86
+ */
87
+ readonly id?: string;
88
+ /**
89
+ * The keys whose values are replaced with {@link REDACTED_VALUE}, at any depth, compared without case.
90
+ */
91
+ readonly secretKeys?: readonly string[];
92
+ /**
93
+ * The reporting plugin's own settings, such as its `data.json`.
94
+ */
95
+ readonly settings: unknown;
96
+ /**
97
+ * The section's title.
98
+ *
99
+ * @default `'Plugin settings'`
100
+ */
101
+ readonly title?: string;
102
+ }
103
+ /**
104
+ * The value that replaces a redacted setting.
105
+ */
106
+ export declare const REDACTED_VALUE = "[redacted]";
107
+ /**
108
+ * The default number of entries a {@link BugReportLogBuffer} keeps.
109
+ */
110
+ export declare const DEFAULT_BUG_REPORT_LOG_MAX_ENTRIES = 200;
111
+ /**
112
+ * The default number of characters a {@link BugReportLogBuffer} keeps of one entry.
113
+ */
114
+ export declare const DEFAULT_BUG_REPORT_LOG_MAX_ENTRY_LENGTH = 2000;
115
+ /**
116
+ * A bounded buffer of log entries a plugin writes for its bug reports. It keeps only what the plugin adds
117
+ * after creating it, at most {@link BugReportLogBufferConstructorOptions.maxEntries} entries, each cut to
118
+ * {@link BugReportLogBufferConstructorOptions.maxEntryLength} characters.
119
+ */
120
+ export declare class BugReportLogBuffer {
121
+ private readonly entries;
122
+ private readonly maxEntries;
123
+ private readonly maxEntryLength;
124
+ private readonly now;
125
+ /**
126
+ * Constructs a new instance.
127
+ *
128
+ * @param options - Constructor options.
129
+ */
130
+ constructor(options?: BugReportLogBufferConstructorOptions);
131
+ /**
132
+ * Adds an entry, stamped with the current time.
133
+ *
134
+ * @param message - The entry's text.
135
+ */
136
+ add(message: string): void;
137
+ /**
138
+ * Removes every entry.
139
+ */
140
+ clear(): void;
141
+ /**
142
+ * Gets the entries, oldest first.
143
+ *
144
+ * @returns The entries.
145
+ */
146
+ getEntries(): readonly string[];
147
+ /**
148
+ * Builds a potentially private diagnostic section holding the entries.
149
+ *
150
+ * @param options - The options.
151
+ * @returns The section.
152
+ */
153
+ toSection(options?: BugReportLogBufferToSectionOptions): BugReportDiagnosticSection;
154
+ }
155
+ /**
156
+ * Builds a potentially private diagnostic section holding the plugin's settings as JSON, with the values
157
+ * of {@link CreateSettingsDiagnosticSectionParams.secretKeys} redacted.
158
+ *
159
+ * @param params - The parameters.
160
+ * @returns The section.
161
+ */
162
+ export declare function createSettingsDiagnosticSection(params: CreateSettingsDiagnosticSectionParams): BugReportDiagnosticSection;
163
+ /**
164
+ * Renders diagnostic sections as Markdown: a level-3 heading and a fenced code block per section. The
165
+ * fence is longer than any run of backticks in the content, so no content can close it.
166
+ *
167
+ * @param sections - The sections.
168
+ * @returns The Markdown, or an empty string when there are no sections.
169
+ */
170
+ export declare function formatBugReportDiagnostics(sections: readonly BugReportDiagnosticSection[]): string;
171
+ /**
172
+ * Gets a Markdown code fence that the given content cannot close.
173
+ *
174
+ * @param content - The content to fence.
175
+ * @returns A run of backticks longer than the longest run in the content, and at least three long.
176
+ */
177
+ export declare function getMarkdownFence(content: string): string;
178
+ /**
179
+ * Copies settings, replacing the value of every key in `secretKeys`, at any depth and compared without
180
+ * case, with {@link REDACTED_VALUE}. The original is not changed.
181
+ *
182
+ * @param settings - The settings.
183
+ * @param secretKeys - The keys to redact.
184
+ * @returns The redacted copy.
185
+ */
186
+ export declare function redactSettings(settings: unknown, secretKeys: readonly string[]): unknown;