@aiquants/markdown-explorer 0.0.0-stage → 0.2.0

package/dist/core/geometry.d.cts

@@ -0,0 +1,51 @@
+export declare const GOLDEN_RATIO: number;
+export declare const EXPLORER_DEFAULT_PERCENT: number;
+export declare const EXPLORER_MULTI_DEFAULT_PERCENT: number;
+export declare const EXPLORER_MAX_PERCENT: number;
+export declare const EXPLORER_MIN_REM = 13;
+export declare const ASSUMED_ROOT_FONT_PIXELS = 16;
+export declare const SPLIT_HANDLE_PIXELS: Readonly<{
+    gripThickness: 5;
+    gripLength: 34;
+    barThickness: 2;
+    barLength: 21;
+}>;
+export declare const FIBONACCI_SPACING_PIXELS: readonly [
+    1,
+    2,
+    3,
+    5,
+    8,
+    13,
+    21,
+    34,
+    55
+];
+export declare const FIBONACCI_DURATIONS_MS: readonly [
+    89,
+    144,
+    233,
+    377
+];
+export declare const CONTROL_BLOCK_PIXELS = 34;
+export declare const COARSE_TARGET_PIXELS = 44;
+export declare const FINE_TARGET_PIXELS = 24;
+export declare const PANEL_MAX_BLOCK_RATIO: number;
+export declare const PANEL_MIN_BLOCK_RATIO: number;
+export declare const COLUMN_MIN_MEASURE = "40ch";
+export declare const explorerMinPixels: (rootFontPixels: number) => number;
+export declare const explorerSheetBelowPixels: (rootFontPixels: number) => number;
+export declare const EXPLORER_WIDTH_PERSIST_DELAY_MS = 233;
+export declare const PREFETCH_DWELL_MS: 89;
+export type ColumnPlanInput = {
+    readonly trackInlineSize: number;
+    readonly gap: number;
+    readonly minColumnInlineSize: number;
+    readonly logicalColumns: number;
+};
+export declare const planVisibleColumns: ({ trackInlineSize, gap, minColumnInlineSize, logicalColumns }: ColumnPlanInput) => number;
+export declare const replanVisibleColumns: (previous: number | null, input: ColumnPlanInput) => number | null;
+export declare const columnGroups: (logicalColumns: number, visibleColumns: number) => ReadonlyArray<readonly [
+    start: number,
+    end: number
+]>;

package/dist/core/geometry.d.ts

@@ -0,0 +1,51 @@
+export declare const GOLDEN_RATIO: number;
+export declare const EXPLORER_DEFAULT_PERCENT: number;
+export declare const EXPLORER_MULTI_DEFAULT_PERCENT: number;
+export declare const EXPLORER_MAX_PERCENT: number;
+export declare const EXPLORER_MIN_REM = 13;
+export declare const ASSUMED_ROOT_FONT_PIXELS = 16;
+export declare const SPLIT_HANDLE_PIXELS: Readonly<{
+    gripThickness: 5;
+    gripLength: 34;
+    barThickness: 2;
+    barLength: 21;
+}>;
+export declare const FIBONACCI_SPACING_PIXELS: readonly [
+    1,
+    2,
+    3,
+    5,
+    8,
+    13,
+    21,
+    34,
+    55
+];
+export declare const FIBONACCI_DURATIONS_MS: readonly [
+    89,
+    144,
+    233,
+    377
+];
+export declare const CONTROL_BLOCK_PIXELS = 34;
+export declare const COARSE_TARGET_PIXELS = 44;
+export declare const FINE_TARGET_PIXELS = 24;
+export declare const PANEL_MAX_BLOCK_RATIO: number;
+export declare const PANEL_MIN_BLOCK_RATIO: number;
+export declare const COLUMN_MIN_MEASURE = "40ch";
+export declare const explorerMinPixels: (rootFontPixels: number) => number;
+export declare const explorerSheetBelowPixels: (rootFontPixels: number) => number;
+export declare const EXPLORER_WIDTH_PERSIST_DELAY_MS = 233;
+export declare const PREFETCH_DWELL_MS: 89;
+export type ColumnPlanInput = {
+    readonly trackInlineSize: number;
+    readonly gap: number;
+    readonly minColumnInlineSize: number;
+    readonly logicalColumns: number;
+};
+export declare const planVisibleColumns: ({ trackInlineSize, gap, minColumnInlineSize, logicalColumns }: ColumnPlanInput) => number;
+export declare const replanVisibleColumns: (previous: number | null, input: ColumnPlanInput) => number | null;
+export declare const columnGroups: (logicalColumns: number, visibleColumns: number) => ReadonlyArray<readonly [
+    start: number,
+    end: number
+]>;

package/dist/core/labels.d.cts

@@ -0,0 +1,180 @@
+export declare const MARKDOWN_EXPLORER_LOCALES: readonly [
+    "en",
+    "ja"
+];
+export type MarkdownExplorerLocale = (typeof MARKDOWN_EXPLORER_LOCALES)[number];
+export declare const DEFAULT_MARKDOWN_EXPLORER_LOCALE: MarkdownExplorerLocale;
+export type MarkdownExplorerLabels = {
+    readonly explorerRegion: string;
+    readonly sourceLabel: string;
+    readonly refreshTreeLabel: string;
+    readonly refreshTree: string;
+    readonly treeRefreshed: string;
+    readonly treeRefreshFailed: (reason: string) => string;
+    readonly refreshDocumentLabel: string;
+    readonly refreshDocument: string;
+    readonly refreshDocumentNamed: (name: string) => string;
+    readonly documentRefreshed: (name: string) => string;
+    readonly documentRefreshFailed: (reason: string) => string;
+    readonly expandAll: string;
+    readonly collapseAll: string;
+    readonly treeSettings: string;
+    readonly switchToMulti: string;
+    readonly switchToTree: string;
+    readonly resizeExplorer: string;
+    readonly showExplorer: string;
+    readonly hideExplorer: string;
+    readonly treeRegion: string;
+    readonly treeLoading: string;
+    readonly treeEmptyTitle: string;
+    readonly treeEmptyBody: string;
+    readonly folderLoadFailed: string;
+    readonly loopFolderName: (name: string) => string;
+    readonly foldersLoadFailedNamed: (names: readonly string[]) => string;
+    readonly foldersLoading: (count: number) => string;
+    readonly expandAllStarted: string;
+    readonly expandAllProgress: (opened: number, loading: number) => string;
+    readonly expandAllDone: (opened: number, failed: number, complete: boolean) => string;
+    readonly expandAllFolderLimit: (opened: number, limit: number, expandAll: string) => string;
+    readonly expandAllDepthLimit: (opened: number, depth: number) => string;
+    readonly treeEntryKindDirectory: string;
+    readonly treeEntryKindFile: string;
+    readonly treeScrollUp: string;
+    readonly treeScrollDown: string;
+    readonly treeScrollToTop: string;
+    readonly treeScrollToBottom: string;
+    readonly selectionTitle: (count: number) => string;
+    readonly clearSelection: string;
+    readonly openSelectionInMulti: (count: number) => string;
+    readonly removeFromSelection: (name: string) => string;
+    readonly settingSortMode: string;
+    readonly sortNative: string;
+    readonly sortAscending: string;
+    readonly sortDescending: string;
+    readonly settingDirectoriesFirst: string;
+    readonly settingSelectionMode: string;
+    readonly selectionSingle: string;
+    readonly selectionMultiple: string;
+    readonly selectionNone: string;
+    readonly settingDoubleClick: string;
+    readonly doubleClickRecursive: string;
+    readonly doubleClickToggle: string;
+    readonly settingExpandIconSize: string;
+    readonly expandIconSizeValue: (pixels: number) => string;
+    readonly settingAlwaysExpanded: string;
+    readonly settingRemoveRootIndent: string;
+    readonly settingTreeLines: string;
+    readonly settingExpandIcons: string;
+    readonly settingDirectoryIcons: string;
+    readonly settingFileIcons: string;
+    readonly settingOn: string;
+    readonly settingOff: string;
+    readonly settingAnnouncement: (setting: string, value: string) => string;
+    readonly documentRegion: string;
+    readonly documentEmpty: string;
+    readonly documentLoading: string;
+    readonly documentShown: (name: string) => string;
+    readonly documentFailed: (name: string, title: string) => string;
+    readonly announcementSequence: (messages: readonly string[]) => string;
+    readonly textTruncated: string;
+    readonly inertLink: string;
+    readonly failureUnauthorizedTitle: string;
+    readonly failureUnauthorizedBody: string;
+    readonly failureForbiddenTitle: string;
+    readonly failureForbiddenBody: string;
+    readonly failureNotFoundTitle: string;
+    readonly failureNotFoundBody: string;
+    readonly failureNotConfiguredTitle: string;
+    readonly failureNotConfiguredBody: string;
+    readonly failureInvalidTitle: string;
+    readonly failureInvalidBody: string;
+    readonly failureTooLargeTitle: string;
+    readonly failureTooLargeBody: string;
+    readonly failureUnsupportedTitle: string;
+    readonly failureUnsupportedBody: string;
+    readonly failureFailedTitle: string;
+    readonly failureFailedBody: string;
+    readonly retry: string;
+    readonly reloadPage: string;
+    readonly imageZoomIn: string;
+    readonly imageZoomOut: string;
+    readonly imageFit: string;
+    readonly imageFitLevel: string;
+    readonly imageZoomLevel: (percent: number) => string;
+    readonly openInNewTab: string;
+    readonly download: string;
+    readonly mediaUnsupported: string;
+    readonly fileNotShown: string;
+    readonly viewerLoading: string;
+    readonly viewerErrorPrefix: string;
+    readonly viewerStyleTitle: string;
+    readonly viewerSelectStyle: string;
+    readonly viewerPinStyle: string;
+    readonly viewerUnpinStyle: string;
+    readonly viewerErrorTitle: string;
+    readonly viewerMissingImage: string;
+    readonly viewerOpenToc: string;
+    readonly viewerTocTitle: string;
+    readonly viewerPinToc: string;
+    readonly viewerUnpinToc: string;
+    readonly viewerSelectAlign: string;
+    readonly viewerAlignTitle: string;
+    readonly viewerPinAlign: string;
+    readonly viewerUnpinAlign: string;
+    readonly viewerAlignLeft: string;
+    readonly viewerAlignCenter: string;
+    readonly viewerAlignRight: string;
+    readonly viewerMermaidInteractionMode: string;
+    readonly viewerMermaidModeNone: string;
+    readonly viewerMermaidModeZoom: string;
+    readonly viewerMermaidModePan: string;
+    readonly viewerMermaidModePanShift: string;
+    readonly viewerMermaidModeBoth: string;
+    readonly viewerMermaidModeBothShift: string;
+    readonly viewerMermaidZoomIn: string;
+    readonly viewerMermaidZoomOut: string;
+    readonly viewerMermaidResetView: string;
+    readonly viewerMermaidRetry: string;
+    readonly viewerEmbeddedVideo: string;
+    readonly viewerEmbeddedPost: string;
+    readonly viewerEmbeddedFrame: string;
+    readonly multiRegion: string;
+    readonly multiEmpty: string;
+    readonly panelLimit: (max: number) => string;
+    readonly panelOpened: (name: string) => string;
+    readonly panelClosed: (name: string) => string;
+    readonly panelAlreadyOpen: (name: string) => string;
+    readonly panelHidden: (name: string) => string;
+    readonly panelShown: (name: string) => string;
+    readonly panelMaximized: (name: string) => string;
+    readonly panelRestored: (name: string) => string;
+    readonly panelHide: string;
+    readonly panelMaximize: string;
+    readonly panelRestore: string;
+    readonly panelClose: string;
+    readonly panelSwitchToCustomDrag: string;
+    readonly panelSwitchToNormalDrag: string;
+    readonly panelCustomDragBadge: string;
+    readonly panelMovePreviousColumn: string;
+    readonly panelMoveNextColumn: string;
+    readonly panelMoveUp: string;
+    readonly panelMoveDown: string;
+    readonly panelMoved: string;
+    readonly panelMoveUnavailable: string;
+    readonly panelDragStarted: string;
+    readonly panelDragCancelled: string;
+    readonly hiddenPanelsTitle: string;
+    readonly hiddenPanelBadge: string;
+    readonly hiddenPanelNotice: string;
+    readonly multiColumnEmpty: string;
+    readonly multiColumnRegion: string;
+    readonly panelDropHere: string;
+};
+export type MarkdownExplorerLabelKey = keyof MarkdownExplorerLabels;
+export type MarkdownExplorerLabelOverrides = Partial<MarkdownExplorerLabels>;
+export declare const MARKDOWN_EXPLORER_LABEL_TEMPLATES: Readonly<Partial<Record<MarkdownExplorerLabelKey, readonly string[]>>>;
+export declare const MARKDOWN_EXPLORER_LABEL_CATALOGS: Readonly<Record<MarkdownExplorerLocale, MarkdownExplorerLabels>>;
+export declare const MARKDOWN_EXPLORER_LABEL_KEYS: readonly MarkdownExplorerLabelKey[];
+export declare const resolveMarkdownExplorerLocale: (locale: unknown) => MarkdownExplorerLocale;
+export declare const resolveMarkdownExplorerLabels: (locale: unknown, overrides: unknown) => MarkdownExplorerLabels;
+export declare const areLabelOverridesEqual: (previous: unknown, next: unknown) => boolean;

package/dist/core/labels.d.ts

@@ -0,0 +1,180 @@
+export declare const MARKDOWN_EXPLORER_LOCALES: readonly [
+    "en",
+    "ja"
+];
+export type MarkdownExplorerLocale = (typeof MARKDOWN_EXPLORER_LOCALES)[number];
+export declare const DEFAULT_MARKDOWN_EXPLORER_LOCALE: MarkdownExplorerLocale;
+export type MarkdownExplorerLabels = {
+    readonly explorerRegion: string;
+    readonly sourceLabel: string;
+    readonly refreshTreeLabel: string;
+    readonly refreshTree: string;
+    readonly treeRefreshed: string;
+    readonly treeRefreshFailed: (reason: string) => string;
+    readonly refreshDocumentLabel: string;
+    readonly refreshDocument: string;
+    readonly refreshDocumentNamed: (name: string) => string;
+    readonly documentRefreshed: (name: string) => string;
+    readonly documentRefreshFailed: (reason: string) => string;
+    readonly expandAll: string;
+    readonly collapseAll: string;
+    readonly treeSettings: string;
+    readonly switchToMulti: string;
+    readonly switchToTree: string;
+    readonly resizeExplorer: string;
+    readonly showExplorer: string;
+    readonly hideExplorer: string;
+    readonly treeRegion: string;
+    readonly treeLoading: string;
+    readonly treeEmptyTitle: string;
+    readonly treeEmptyBody: string;
+    readonly folderLoadFailed: string;
+    readonly loopFolderName: (name: string) => string;
+    readonly foldersLoadFailedNamed: (names: readonly string[]) => string;
+    readonly foldersLoading: (count: number) => string;
+    readonly expandAllStarted: string;
+    readonly expandAllProgress: (opened: number, loading: number) => string;
+    readonly expandAllDone: (opened: number, failed: number, complete: boolean) => string;
+    readonly expandAllFolderLimit: (opened: number, limit: number, expandAll: string) => string;
+    readonly expandAllDepthLimit: (opened: number, depth: number) => string;
+    readonly treeEntryKindDirectory: string;
+    readonly treeEntryKindFile: string;
+    readonly treeScrollUp: string;
+    readonly treeScrollDown: string;
+    readonly treeScrollToTop: string;
+    readonly treeScrollToBottom: string;
+    readonly selectionTitle: (count: number) => string;
+    readonly clearSelection: string;
+    readonly openSelectionInMulti: (count: number) => string;
+    readonly removeFromSelection: (name: string) => string;
+    readonly settingSortMode: string;
+    readonly sortNative: string;
+    readonly sortAscending: string;
+    readonly sortDescending: string;
+    readonly settingDirectoriesFirst: string;
+    readonly settingSelectionMode: string;
+    readonly selectionSingle: string;
+    readonly selectionMultiple: string;
+    readonly selectionNone: string;
+    readonly settingDoubleClick: string;
+    readonly doubleClickRecursive: string;
+    readonly doubleClickToggle: string;
+    readonly settingExpandIconSize: string;
+    readonly expandIconSizeValue: (pixels: number) => string;
+    readonly settingAlwaysExpanded: string;
+    readonly settingRemoveRootIndent: string;
+    readonly settingTreeLines: string;
+    readonly settingExpandIcons: string;
+    readonly settingDirectoryIcons: string;
+    readonly settingFileIcons: string;
+    readonly settingOn: string;
+    readonly settingOff: string;
+    readonly settingAnnouncement: (setting: string, value: string) => string;
+    readonly documentRegion: string;
+    readonly documentEmpty: string;
+    readonly documentLoading: string;
+    readonly documentShown: (name: string) => string;
+    readonly documentFailed: (name: string, title: string) => string;
+    readonly announcementSequence: (messages: readonly string[]) => string;
+    readonly textTruncated: string;
+    readonly inertLink: string;
+    readonly failureUnauthorizedTitle: string;
+    readonly failureUnauthorizedBody: string;
+    readonly failureForbiddenTitle: string;
+    readonly failureForbiddenBody: string;
+    readonly failureNotFoundTitle: string;
+    readonly failureNotFoundBody: string;
+    readonly failureNotConfiguredTitle: string;
+    readonly failureNotConfiguredBody: string;
+    readonly failureInvalidTitle: string;
+    readonly failureInvalidBody: string;
+    readonly failureTooLargeTitle: string;
+    readonly failureTooLargeBody: string;
+    readonly failureUnsupportedTitle: string;
+    readonly failureUnsupportedBody: string;
+    readonly failureFailedTitle: string;
+    readonly failureFailedBody: string;
+    readonly retry: string;
+    readonly reloadPage: string;
+    readonly imageZoomIn: string;
+    readonly imageZoomOut: string;
+    readonly imageFit: string;
+    readonly imageFitLevel: string;
+    readonly imageZoomLevel: (percent: number) => string;
+    readonly openInNewTab: string;
+    readonly download: string;
+    readonly mediaUnsupported: string;
+    readonly fileNotShown: string;
+    readonly viewerLoading: string;
+    readonly viewerErrorPrefix: string;
+    readonly viewerStyleTitle: string;
+    readonly viewerSelectStyle: string;
+    readonly viewerPinStyle: string;
+    readonly viewerUnpinStyle: string;
+    readonly viewerErrorTitle: string;
+    readonly viewerMissingImage: string;
+    readonly viewerOpenToc: string;
+    readonly viewerTocTitle: string;
+    readonly viewerPinToc: string;
+    readonly viewerUnpinToc: string;
+    readonly viewerSelectAlign: string;
+    readonly viewerAlignTitle: string;
+    readonly viewerPinAlign: string;
+    readonly viewerUnpinAlign: string;
+    readonly viewerAlignLeft: string;
+    readonly viewerAlignCenter: string;
+    readonly viewerAlignRight: string;
+    readonly viewerMermaidInteractionMode: string;
+    readonly viewerMermaidModeNone: string;
+    readonly viewerMermaidModeZoom: string;
+    readonly viewerMermaidModePan: string;
+    readonly viewerMermaidModePanShift: string;
+    readonly viewerMermaidModeBoth: string;
+    readonly viewerMermaidModeBothShift: string;
+    readonly viewerMermaidZoomIn: string;
+    readonly viewerMermaidZoomOut: string;
+    readonly viewerMermaidResetView: string;
+    readonly viewerMermaidRetry: string;
+    readonly viewerEmbeddedVideo: string;
+    readonly viewerEmbeddedPost: string;
+    readonly viewerEmbeddedFrame: string;
+    readonly multiRegion: string;
+    readonly multiEmpty: string;
+    readonly panelLimit: (max: number) => string;
+    readonly panelOpened: (name: string) => string;
+    readonly panelClosed: (name: string) => string;
+    readonly panelAlreadyOpen: (name: string) => string;
+    readonly panelHidden: (name: string) => string;
+    readonly panelShown: (name: string) => string;
+    readonly panelMaximized: (name: string) => string;
+    readonly panelRestored: (name: string) => string;
+    readonly panelHide: string;
+    readonly panelMaximize: string;
+    readonly panelRestore: string;
+    readonly panelClose: string;
+    readonly panelSwitchToCustomDrag: string;
+    readonly panelSwitchToNormalDrag: string;
+    readonly panelCustomDragBadge: string;
+    readonly panelMovePreviousColumn: string;
+    readonly panelMoveNextColumn: string;
+    readonly panelMoveUp: string;
+    readonly panelMoveDown: string;
+    readonly panelMoved: string;
+    readonly panelMoveUnavailable: string;
+    readonly panelDragStarted: string;
+    readonly panelDragCancelled: string;
+    readonly hiddenPanelsTitle: string;
+    readonly hiddenPanelBadge: string;
+    readonly hiddenPanelNotice: string;
+    readonly multiColumnEmpty: string;
+    readonly multiColumnRegion: string;
+    readonly panelDropHere: string;
+};
+export type MarkdownExplorerLabelKey = keyof MarkdownExplorerLabels;
+export type MarkdownExplorerLabelOverrides = Partial<MarkdownExplorerLabels>;
+export declare const MARKDOWN_EXPLORER_LABEL_TEMPLATES: Readonly<Partial<Record<MarkdownExplorerLabelKey, readonly string[]>>>;
+export declare const MARKDOWN_EXPLORER_LABEL_CATALOGS: Readonly<Record<MarkdownExplorerLocale, MarkdownExplorerLabels>>;
+export declare const MARKDOWN_EXPLORER_LABEL_KEYS: readonly MarkdownExplorerLabelKey[];
+export declare const resolveMarkdownExplorerLocale: (locale: unknown) => MarkdownExplorerLocale;
+export declare const resolveMarkdownExplorerLabels: (locale: unknown, overrides: unknown) => MarkdownExplorerLabels;
+export declare const areLabelOverridesEqual: (previous: unknown, next: unknown) => boolean;

package/dist/core/location.d.cts

@@ -0,0 +1,82 @@
+import { ExplorerConfig, ExplorerLocationConfig } from "./config.cjs";
+import { ContentAlignment } from "./viewSettings.cjs";
+export type ExplorerOverrides = {
+    readonly style?: string;
+    readonly align?: ContentAlignment;
+};
+export type ExplorerEmbedOptions = {
+    readonly showToc?: boolean;
+    readonly showStyle?: boolean;
+    readonly showAlign?: boolean;
+    readonly padding?: number;
+    readonly width?: string;
+    readonly maxWidth?: string;
+};
+export type ExplorerLocation = {
+    readonly view: "tree";
+    readonly source: string;
+    readonly doc: string | null;
+    readonly overrides: ExplorerOverrides;
+} | {
+    readonly view: "multi";
+    readonly source: string;
+    readonly docs: readonly string[];
+    readonly maximized: string | null;
+} | {
+    readonly view: "single";
+    readonly source: string;
+    readonly doc: string;
+    readonly overrides: ExplorerOverrides;
+    readonly embed: ExplorerEmbedOptions;
+};
+export type ExplorerLocationResult = {
+    readonly kind: "location";
+    readonly location: ExplorerLocation;
+} | {
+    readonly kind: "redirect";
+    readonly href: string;
+    readonly location: ExplorerLocation;
+};
+export type ExplorerHrefTarget = {
+    readonly view: "tree";
+    readonly source?: string;
+    readonly doc?: string | null;
+    readonly overrides?: ExplorerOverrides;
+} | {
+    readonly view: "multi";
+    readonly source?: string;
+    readonly docs?: readonly string[];
+    readonly maximized?: string | null;
+} | {
+    readonly view: "single";
+    readonly source?: string;
+    readonly doc: string;
+    readonly overrides?: ExplorerOverrides;
+    readonly embed?: ExplorerEmbedOptions;
+};
+export type ExplorerSourcelessHrefTarget = ExplorerHrefTarget & {
+    readonly source?: undefined;
+};
+type ExplorerHrefWriter = {
+    (config: ExplorerLocationConfig, target: ExplorerHrefTarget): string;
+    (config: ExplorerConfig, target: ExplorerSourcelessHrefTarget): string;
+};
+export declare const EXPLORER_QUERY: Readonly<{
+    readonly source: "source";
+    readonly doc: "doc";
+    readonly maximized: "maximized";
+    readonly style: "style";
+    readonly align: "align";
+    readonly showToc: "showToc";
+    readonly showStyle: "showStyle";
+    readonly showAlign: "showAlign";
+    readonly padding: "padding";
+    readonly width: "width";
+    readonly maxWidth: "maxWidth";
+}>;
+export declare const encodeDocumentSegment: (path: string) => string;
+export declare const decodeDocumentSegment: (segment: string) => string;
+export declare const canonicalMultiDocuments: (config: ExplorerConfig, docs: readonly string[]) => readonly string[];
+export declare const explorerHref: ExplorerHrefWriter;
+export declare const resolveExplorerLocation: (config: ExplorerLocationConfig, splat: string | undefined, search: URLSearchParams) => ExplorerLocationResult;
+export {};

package/dist/core/location.d.ts

@@ -0,0 +1,82 @@
+import { ExplorerConfig, ExplorerLocationConfig } from "./config.js";
+import { ContentAlignment } from "./viewSettings.js";
+export type ExplorerOverrides = {
+    readonly style?: string;
+    readonly align?: ContentAlignment;
+};
+export type ExplorerEmbedOptions = {
+    readonly showToc?: boolean;
+    readonly showStyle?: boolean;
+    readonly showAlign?: boolean;
+    readonly padding?: number;
+    readonly width?: string;
+    readonly maxWidth?: string;
+};
+export type ExplorerLocation = {
+    readonly view: "tree";
+    readonly source: string;
+    readonly doc: string | null;
+    readonly overrides: ExplorerOverrides;
+} | {
+    readonly view: "multi";
+    readonly source: string;
+    readonly docs: readonly string[];
+    readonly maximized: string | null;
+} | {
+    readonly view: "single";
+    readonly source: string;
+    readonly doc: string;
+    readonly overrides: ExplorerOverrides;
+    readonly embed: ExplorerEmbedOptions;
+};
+export type ExplorerLocationResult = {
+    readonly kind: "location";
+    readonly location: ExplorerLocation;
+} | {
+    readonly kind: "redirect";
+    readonly href: string;
+    readonly location: ExplorerLocation;
+};
+export type ExplorerHrefTarget = {
+    readonly view: "tree";
+    readonly source?: string;
+    readonly doc?: string | null;
+    readonly overrides?: ExplorerOverrides;
+} | {
+    readonly view: "multi";
+    readonly source?: string;
+    readonly docs?: readonly string[];
+    readonly maximized?: string | null;
+} | {
+    readonly view: "single";
+    readonly source?: string;
+    readonly doc: string;
+    readonly overrides?: ExplorerOverrides;
+    readonly embed?: ExplorerEmbedOptions;
+};
+export type ExplorerSourcelessHrefTarget = ExplorerHrefTarget & {
+    readonly source?: undefined;
+};
+type ExplorerHrefWriter = {
+    (config: ExplorerLocationConfig, target: ExplorerHrefTarget): string;
+    (config: ExplorerConfig, target: ExplorerSourcelessHrefTarget): string;
+};
+export declare const EXPLORER_QUERY: Readonly<{
+    readonly source: "source";
+    readonly doc: "doc";
+    readonly maximized: "maximized";
+    readonly style: "style";
+    readonly align: "align";
+    readonly showToc: "showToc";
+    readonly showStyle: "showStyle";
+    readonly showAlign: "showAlign";
+    readonly padding: "padding";
+    readonly width: "width";
+    readonly maxWidth: "maxWidth";
+}>;
+export declare const encodeDocumentSegment: (path: string) => string;
+export declare const decodeDocumentSegment: (segment: string) => string;
+export declare const canonicalMultiDocuments: (config: ExplorerConfig, docs: readonly string[]) => readonly string[];
+export declare const explorerHref: ExplorerHrefWriter;
+export declare const resolveExplorerLocation: (config: ExplorerLocationConfig, splat: string | undefined, search: URLSearchParams) => ExplorerLocationResult;
+export {};

package/dist/core/paths.d.cts

@@ -0,0 +1,17 @@
+export declare const MAX_DOCUMENT_PATH_LENGTH = 4096;
+export declare const DENY_DECODE_LEVELS = 3;
+export declare const DEFAULT_DENIED_PATH_SEGMENTS: readonly string[];
+export type ExplorerPathRules = readonly string[];
+export type CompiledPathRules = {
+    readonly deniesPath: (path: string) => boolean;
+    readonly deniesName: (name: string) => boolean;
+};
+export declare const lastPathSegment: (doc: string) => string;
+export declare const isAcceptableDocumentPath: (path: string) => boolean;
+export declare const foldForComparison: (text: string) => string;
+export declare const decodePercentLeniently: (text: string) => string;
+export declare const compilePathRules: (rules: ExplorerPathRules) => CompiledPathRules;
+export declare const DEFAULT_PATH_RULES: CompiledPathRules;
+export declare const NO_PATH_RULES: CompiledPathRules;
+export declare const resolvePathRules: (deny: ExplorerPathRules | false | undefined) => CompiledPathRules;
+export declare const isDeniedPath: (rules: ExplorerPathRules, path: string) => boolean;

package/dist/core/paths.d.ts

@@ -0,0 +1,17 @@
+export declare const MAX_DOCUMENT_PATH_LENGTH = 4096;
+export declare const DENY_DECODE_LEVELS = 3;
+export declare const DEFAULT_DENIED_PATH_SEGMENTS: readonly string[];
+export type ExplorerPathRules = readonly string[];
+export type CompiledPathRules = {
+    readonly deniesPath: (path: string) => boolean;
+    readonly deniesName: (name: string) => boolean;
+};
+export declare const lastPathSegment: (doc: string) => string;
+export declare const isAcceptableDocumentPath: (path: string) => boolean;
+export declare const foldForComparison: (text: string) => string;
+export declare const decodePercentLeniently: (text: string) => string;
+export declare const compilePathRules: (rules: ExplorerPathRules) => CompiledPathRules;
+export declare const DEFAULT_PATH_RULES: CompiledPathRules;
+export declare const NO_PATH_RULES: CompiledPathRules;
+export declare const resolvePathRules: (deny: ExplorerPathRules | false | undefined) => CompiledPathRules;
+export declare const isDeniedPath: (rules: ExplorerPathRules, path: string) => boolean;

package/dist/core/revalidation.d.cts

@@ -0,0 +1,2 @@
+import { ShouldRevalidateFunctionArgs } from "react-router";
+export declare const shouldRevalidateExplorer: ({ currentUrl, nextUrl, formMethod, defaultShouldRevalidate }: Pick<ShouldRevalidateFunctionArgs, "currentUrl" | "nextUrl" | "formMethod" | "defaultShouldRevalidate">) => boolean;

package/dist/core/revalidation.d.ts

@@ -0,0 +1,2 @@
+import { ShouldRevalidateFunctionArgs } from "react-router";
+export declare const shouldRevalidateExplorer: ({ currentUrl, nextUrl, formMethod, defaultShouldRevalidate }: Pick<ShouldRevalidateFunctionArgs, "currentUrl" | "nextUrl" | "formMethod" | "defaultShouldRevalidate">) => boolean;

package/dist/core/theme.d.cts

@@ -0,0 +1,6 @@
+export declare const EXPLORER_THEMES: readonly [
+    "light",
+    "dark"
+];
+export type ExplorerTheme = (typeof EXPLORER_THEMES)[number];
+export declare const resolveExplorerTheme: (theme: unknown) => ExplorerTheme;