Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 87 additions & 8 deletions scripts/notionClient.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ vi.mock("chalk", () => ({

describe("notionClient", () => {
let mockClient: any;
let mockN2M: any;
let notionToMarkdownInstances: any[];
let originalEnv: NodeJS.ProcessEnv;
let consoleMocks: ReturnType<typeof mockConsole>;

Expand Down Expand Up @@ -71,12 +71,6 @@ describe("notionClient", () => {
blocks: { children: { list: vi.fn() }, append: vi.fn(), delete: vi.fn() },
};

// Create mock NotionToMarkdown
mockN2M = {
pageToMarkdown: vi.fn(),
toMarkdownString: vi.fn(),
};

// Set up constructor mocks - create a proper constructor function
const MockClientClass = vi.fn().mockImplementation(function (
this: any,
Expand All @@ -85,11 +79,39 @@ describe("notionClient", () => {
return mockClient;
});

notionToMarkdownInstances = [];

const MockNotionToMarkdownClass = vi.fn().mockImplementation(function (
this: any,
config: any
) {
return mockN2M;
const instance: any = {
pageToMarkdown: vi.fn(),
toMarkdownString: vi.fn(),
customTransformers: {} as Record<string, any>,
};

instance.blockToMarkdown = vi.fn(async function (this: any, block: any) {
const transformer = this.customTransformers?.[block.type];

if (transformer) {
throw new Error("paragraph transformer recursion");
}

return `default:${block.id ?? ""}`;
});

instance.setCustomTransformer = vi.fn(function (
this: any,
type: string,
transformer: unknown
) {
this.customTransformers[type] = transformer;
return this;
});

notionToMarkdownInstances.push(instance);
return instance;
});

// Replace the Client and NotionToMarkdown with our mocks
Expand Down Expand Up @@ -176,6 +198,63 @@ describe("notionClient", () => {
// Assert
expect(DATABASE_ID).toBe("exported-database-id");
});

it("should register a spacer transformer for empty paragraph blocks", async () => {
await import("./notionClient");

expect(notionToMarkdownInstances.length).toBe(1);

const [primaryN2M] = notionToMarkdownInstances;

expect(primaryN2M.setCustomTransformer).toHaveBeenCalledWith(
"paragraph",
expect.any(Function)
);

const transformer = primaryN2M.setCustomTransformer.mock.calls.find(
(call: any[]) => call[0] === "paragraph"
)?.[1];

expect(typeof transformer).toBe("function");

const emptyParagraph = {
id: "empty",
type: "paragraph",
has_children: false,
paragraph: {
rich_text: [],
},
} as any;

const spacerResult = await transformer(emptyParagraph);
expect(typeof spacerResult).toBe("string");
expect(spacerResult).toContain("notion-spacer");
expect(primaryN2M.blockToMarkdown).not.toHaveBeenCalled();

const populatedParagraph = {
id: "content",
type: "paragraph",
has_children: false,
paragraph: {
rich_text: [
{
type: "text",
text: { content: "Hello" },
plain_text: "Hello",
},
],
},
} as any;

primaryN2M.blockToMarkdown.mockClear();

const markdownResult = await transformer(populatedParagraph);
expect(primaryN2M.blockToMarkdown).toHaveBeenCalledWith(
populatedParagraph
);
expect(markdownResult).toBe(`default:${populatedParagraph.id}`);
expect(primaryN2M.customTransformers.paragraph).toBe(transformer);
});
});

describe("enhancedNotion.databasesQuery", () => {
Expand Down
80 changes: 80 additions & 0 deletions scripts/notionClient.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
import dotenv from "dotenv";
import { Client } from "@notionhq/client";
import { NotionToMarkdown } from "notion-to-md";
import type {
BlockObjectResponse,
ParagraphBlockObjectResponse,
} from "@notionhq/client/build/src/api-endpoints";
import chalk from "chalk";
import { perfTelemetry } from "./perfTelemetry";
import {
scheduleRequest,
setCircuitBreakerCheck,
} from "./notion-fetch/requestScheduler";

type MarkdownBlock = Awaited<
ReturnType<InstanceType<typeof NotionToMarkdown>["blockToMarkdown"]>
>;

dotenv.config();

if (!process.env.NOTION_API_KEY) {
Expand Down Expand Up @@ -250,6 +258,78 @@ const notion = new Client({

const n2m = new NotionToMarkdown({ notionClient: notion });

type BlockToMarkdown = InstanceType<typeof NotionToMarkdown>["blockToMarkdown"];
const defaultParagraphToMarkdown = n2m.blockToMarkdown.bind(
n2m
) as BlockToMarkdown;

const NOTION_SPACER_HTML =
'<div class="notion-spacer" aria-hidden="true" role="presentation"></div>';

function hasVisibleParagraphContent(
block: ParagraphBlockObjectResponse
): boolean {
const richText = block.paragraph?.rich_text;
if (!Array.isArray(richText) || richText.length === 0) {
return false;
}

return richText.some((item) => {
if (item.type === "text") {
const content = item.text?.content ?? item.plain_text ?? "";
return content.trim().length > 0;
}

if (item.type === "equation") {
return (item.equation?.expression ?? "").trim().length > 0;
}

const plainText = item.plain_text ?? "";
return plainText.trim().length > 0;
});
}

const paragraphTransformer: BlockToMarkdown = async (block) => {
const paragraphBlock = block as ParagraphBlockObjectResponse;

if (paragraphBlock?.type !== "paragraph") {
return defaultParagraphToMarkdown(block as BlockObjectResponse);
}

const hasChildren = paragraphBlock.has_children === true;
const hasContent = hasVisibleParagraphContent(paragraphBlock);

if (!hasChildren && !hasContent) {
return NOTION_SPACER_HTML as MarkdownBlock;
}

const customTransformers = (
n2m as unknown as {
customTransformers?: Record<string, BlockToMarkdown>;
}
).customTransformers;

let previousParagraphTransformer: BlockToMarkdown | undefined;

if (customTransformers) {
previousParagraphTransformer = customTransformers.paragraph;

if (previousParagraphTransformer) {
delete customTransformers.paragraph;
}
}

try {
return defaultParagraphToMarkdown(paragraphBlock as BlockObjectResponse);
Comment on lines +322 to +323

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Preserve nested indentation when delegating paragraph transform

The custom paragraphTransformer returns early for empty blocks and otherwise delegates to the original blockToMarkdown. However, the delegation at defaultParagraphToMarkdown(paragraphBlock as BlockObjectResponse) does not forward any of the extra arguments that NotionToMarkdown passes to custom transformers (e.g. the current nesting depth). As a result every non‑empty paragraph is rendered with a nesting level of 0, so paragraphs that appear inside list items, callouts, or other nested contexts lose their indentation in the generated Markdown. Accept the extra parameters (...args) and pass them along to defaultParagraphToMarkdown so nested paragraphs still render correctly.

Useful? React with 👍 / 👎.

} finally {
if (customTransformers && previousParagraphTransformer) {
customTransformers.paragraph = previousParagraphTransformer;
}
}
};

n2m.setCustomTransformer("paragraph", paragraphTransformer);

export const DATABASE_ID = resolvedDatabaseId;

// For v5 API compatibility - export data source ID
Expand Down
2 changes: 2 additions & 0 deletions scripts/test-utils/mocks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ export const createMockNotionClient = () => ({
export const createMockNotionToMarkdown = () => ({
pageToMarkdown: vi.fn(),
toMarkdownString: vi.fn(),
setCustomTransformer: vi.fn(),
blockToMarkdown: vi.fn(),
});

/**
Expand Down
18 changes: 18 additions & 0 deletions src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -314,3 +314,21 @@ details {
[data-theme="dark"] details {
background-color: rgba(229, 228, 226, 0.15) !important;
}

/* Preserve intentional gaps from Notion empty paragraph spacers */
:root {
--notion-paragraph-gap-base: var(--ifm-paragraph-margin-bottom, 1.25rem);
--notion-spacer-gap: clamp(
calc(var(--notion-paragraph-gap-base) * 0.55),
calc(var(--notion-paragraph-gap-base) * 0.65 + 0.2rem),
calc(var(--notion-paragraph-gap-base) * 0.75 + 0.25rem)
);
}

.notion-spacer {
display: block;
width: 100%;
height: var(--notion-spacer-gap);
margin: 0;
pointer-events: none;
}
Loading