@onozaty/growi-uploader 1.1.0 → 1.3.0

package/README.md

@@ -1,5 +1,7 @@
 # growi-uploader
 
+[![Test](https://github.com/onozaty/growi-uploader/actions/workflows/test.yaml/badge.svg)](https://github.com/onozaty/growi-uploader/actions/workflows/test.yaml)
+[![codecov](https://codecov.io/gh/onozaty/growi-uploader/graph/badge.svg?token=X0YN1OP5PB)](https://codecov.io/gh/onozaty/growi-uploader)
 [![npm version](https://badge.fury.io/js/@onozaty%2Fgrowi-uploader.svg)](https://www.npmjs.com/package/@onozaty/growi-uploader)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
@@ -161,6 +163,8 @@ Files referenced in markdown links are automatically detected as attachments:
 **Local Directory:**
 ```
 guide.md
+assets/
+  banner.png
 images/
   logo.png
   screenshot.png
@@ -170,9 +174,27 @@ images/
 ```markdown
 ![Logo](./images/logo.png)
 ![Screenshot](images/screenshot.png)
+![Banner](/assets/banner.png)
 ```
 
-Both `logo.png` and `screenshot.png` will be uploaded as attachments to the `/guide` page, even though they don't follow the `_attachment_` naming convention.
+All referenced files (`logo.png`, `screenshot.png`, and `banner.png`) will be uploaded as attachments to the `/guide` page, even though they don't follow the `_attachment_` naming convention.
+
+**Path resolution:**
+- Markdown escape sequences are unescaped (`\(` → `(`)
+- URL encoding (percent-encoding) is decoded (`%20` → space, `%E7%94%BB%E5%83%8F` → `画像`)
+- Relative paths (`./`, `../`, or no prefix): Resolved from the Markdown file's directory
+- Absolute paths (starting with `/`): Resolved from the source directory root
+  - Example: `/assets/banner.png` → `<source-dir>/assets/banner.png`
+
+**Supported link formats:**
+```markdown
+![Logo](./images/logo.png)                # Standard relative path
+![Logo](images/logo.png)                  # Relative path without ./
+![Image](./images/%E7%94%BB%E5%83%8F.png) # URL-encoded Japanese filename
+[File](./docs/my%20file.pdf)              # URL-encoded space
+[File](<./path/file (1).png>)             # Special chars with angle brackets
+![Image](./path/file\\(1\\).png)          # Special chars with escaping
+```
 
 **Excluded from detection:**
 - `.md` files (treated as page links)

package/dist/index.mjs

@@ -8,7 +8,7 @@ import { lookup } from "mime-types";
 import { glob } from "glob";
 
 //#region package.json
-var version = "1.1.0";
+var version = "1.3.0";
 
 //#endregion
 //#region src/config.ts
@@ -103,10 +103,11 @@ const formatErrorMessage = (error) => {
 * Create a new page or update an existing page in GROWI
 *
 * @param file Markdown file to upload
+* @param content Markdown content
 * @param shouldUpdate If true, update existing pages; if false, skip existing pages
 * @returns Result containing page ID, revision ID, and action taken
 */
-const createOrUpdatePage = async (file, shouldUpdate) => {
+const createOrUpdatePage = async (file, content, shouldUpdate) => {
 	try {
 		const actualResponse = (await getPage({ path: file.growiPath })).data;
 		if (actualResponse.page) {
@@ -120,7 +121,7 @@ const createOrUpdatePage = async (file, shouldUpdate) => {
 			return {
 				pageId,
 				revisionId: (await putPage({
-					body: file.content,
+					body: content,
 					pageId,
 					revisionId
 				})).data.page?.revision,
@@ -138,7 +139,7 @@ const createOrUpdatePage = async (file, shouldUpdate) => {
 	try {
 		const response = await postPage({
 			path: file.growiPath,
-			body: file.content
+			body: content
 		});
 		return {
 			pageId: response.data.page?._id,
@@ -226,19 +227,35 @@ const uploadAttachment = async (attachment, pageId, sourceDir) => {
 */
 const extractLinkedAttachments = (content, markdownFilePath, sourceDir) => {
 	const attachments = [];
-	const linkRegex = /!?\[([^\]]*)\]\((?:<([^>]+)>|((?:[^)\\]+|\\.)*))\)/g;
+	const linkRegex = new RegExp([
+		"!?",
+		"\\[(?<alt>[^\\]]*)\\]",
+		"\\(",
+		"(?:",
+		"<(?<anglePath>[^>]+)>",
+		"|",
+		"(?<regularPath>(?:[^)\\\\]+|\\\\.)*)",
+		")",
+		"\\)"
+	].join(""), "g");
 	let match;
 	while ((match = linkRegex.exec(content)) !== null) {
-		const angleBracketPath = match[2];
-		const regularPath = match[3];
-		const linkPath = angleBracketPath || regularPath;
+		const { anglePath, regularPath } = match.groups;
+		const linkPath = anglePath || regularPath;
 		if (!linkPath) continue;
-		const originalLinkPath = angleBracketPath ? `<${angleBracketPath}>` : regularPath;
+		const originalLinkPath = anglePath ? `<${anglePath}>` : regularPath;
 		if (linkPath.startsWith("http://") || linkPath.startsWith("https://")) continue;
 		if (linkPath.endsWith(".md")) continue;
-		if (linkPath.startsWith("/")) continue;
 		const unescapedPath = linkPath.replace(/\\([\\`*_{}[\]()#+\-.!])/g, "$1");
-		const absolutePath = resolve(dirname(join(sourceDir, markdownFilePath)), unescapedPath);
+		let decodedPath;
+		try {
+			decodedPath = decodeURIComponent(unescapedPath);
+		} catch {
+			decodedPath = unescapedPath;
+		}
+		let absolutePath;
+		if (linkPath.startsWith("/")) absolutePath = resolve(sourceDir, decodedPath.slice(1));
+		else absolutePath = resolve(dirname(join(sourceDir, markdownFilePath)), decodedPath);
 		if (!existsSync(absolutePath)) continue;
 		const normalizedPath = relative(sourceDir, absolutePath).replace(/\\/g, "/");
 		attachments.push({
@@ -294,7 +311,6 @@ const scanMarkdownFiles = async (sourceDir, basePath = "/") => {
 		return {
 			localPath: file,
 			growiPath: growiPath.startsWith("/") ? growiPath : `/${growiPath}`,
-			content,
 			attachments
 		};
 	}));
@@ -303,6 +319,14 @@ const scanMarkdownFiles = async (sourceDir, basePath = "/") => {
 //#endregion
 //#region src/markdown.ts
 /**
+* Escape special regex characters for safe use in RegExp
+* Escapes: . * + ? ^ $ { } ( ) | [ ] \ < >
+* Reference: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions#escaping
+*/
+const escapeRegex = (str) => {
+	return str.replace(/[.*+?^${}()|[\]\\<>]/g, "\\$&");
+};
+/**
 * Replace attachment links in Markdown content with GROWI format
 *
 * Supports two detection patterns:
@@ -322,16 +346,16 @@ const replaceAttachmentLinks = (markdown, attachments, pageName) => {
 		const growiPath = `/attachment/${attachment.attachmentId}`;
 		const patterns = [];
 		if (attachment.detectionPattern === "naming") {
-			const escapedFileName = `${pageName}_attachment_${attachment.fileName}`.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+			const escapedFileName = escapeRegex(`${pageName}_attachment_${attachment.fileName}`);
 			patterns.push(escapedFileName, `\\./${escapedFileName}`);
 		}
-		if (attachment.detectionPattern === "link" && attachment.originalLinkPaths) for (const linkPath of attachment.originalLinkPaths) {
-			const escapedPath = linkPath.replace(/[.*+?^${}()|[\]\\<>]/g, "\\$&");
+		if (attachment.originalLinkPaths) for (const linkPath of attachment.originalLinkPaths) {
+			const escapedPath = escapeRegex(linkPath);
 			patterns.push(escapedPath);
 			if (linkPath.startsWith("./")) {
-				const escapedWithoutDot = linkPath.substring(2).replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+				const escapedWithoutDot = escapeRegex(linkPath.substring(2));
 				patterns.push(escapedWithoutDot);
-			} else if (!linkPath.startsWith("../")) patterns.push(`\\./${escapedPath}`);
+			} else if (!linkPath.startsWith("../") && !linkPath.startsWith("<")) patterns.push(`\\./${escapedPath}`);
 		}
 		for (const pattern of patterns) {
 			const imgRegex = new RegExp(`!\\[([^\\]]*)\\]\\(${pattern}\\)`, "g");
@@ -355,18 +379,24 @@ const replaceAttachmentLinks = (markdown, attachments, pageName) => {
 * Replace .md extension in page links with GROWI format
 *
 * Converts Markdown page links to GROWI-compatible format by removing .md extension.
+* For absolute paths (starting with /), prepends basePath to the link.
 * External URLs (http://, https://) are excluded from replacement.
 *
 * Supported patterns:
 * - Relative path: [text](./page.md) → [text](./page)
 * - Filename only: [text](page.md) → [text](page)
+* - Absolute path: [text](/docs/page.md) → [text](/basePath/docs/page)
 * - With anchor: [text](./page.md#section) → [text](./page#section)
 *
 * @param markdown Original Markdown content
+* @param basePath Base path for GROWI pages (default: "/")
 * @returns Object with replaced content and whether any replacement occurred
 */
-const replaceMarkdownExtension = (markdown) => {
-	const result = markdown.replace(/(\[[^\]]*\]\((?!https?:\/\/)[^)]*?)\.md((?:#[^)]*)?\))/g, "$1$2");
+const replaceMarkdownExtension = (markdown, basePath = "/") => {
+	const result = markdown.replace(/(\[[^\]]*\]\((?!https?:\/\/))([^)]*?)\.md((?:#[^)]*)?\))/g, (match, prefix, path, suffix) => {
+		if (path.startsWith("/") && basePath !== "/") return `${prefix}${basePath.endsWith("/") ? basePath.slice(0, -1) : basePath}${path}${suffix}`;
+		return `${prefix}${path}${suffix}`;
+	});
 	return {
 		content: result,
 		replaced: result !== markdown
@@ -401,7 +431,8 @@ const uploadFiles = async (files, sourceDir, config) => {
 		linkReplacementErrors: 0
 	};
 	for (const file of files) {
-		const result = await createOrUpdatePage(file, config.update);
+		const content = readFileSync(join(sourceDir, file.localPath), "utf-8");
+		const result = await createOrUpdatePage(file, content, config.update);
 		if (result.action === "created") {
 			stats.pagesCreated++;
 			console.log(`[SUCCESS] ${file.localPath} → ${file.growiPath} (created)`);
@@ -416,7 +447,7 @@ const uploadFiles = async (files, sourceDir, config) => {
 			console.error(`[ERROR] ${file.localPath} → ${file.growiPath} (${result.errorMessage || "unknown error"})`);
 		}
 		if (result.pageId && (result.action === "created" || result.action === "updated")) {
-			let currentContent = file.content;
+			let currentContent = content;
 			let currentRevisionId = result.revisionId;
 			if (file.attachments.length > 0) {
 				let hasAttachments = false;
@@ -454,7 +485,7 @@ const uploadFiles = async (files, sourceDir, config) => {
 				}
 			}
 			if (currentRevisionId) {
-				const { content: linkedContent, replaced: linkReplaced } = replaceMarkdownExtension(currentContent);
+				const { content: linkedContent, replaced: linkReplaced } = replaceMarkdownExtension(currentContent, config.basePath);
 				if (linkReplaced) {
 					const updateResult = await updatePageContent(result.pageId, currentRevisionId, linkedContent);
 					if (updateResult.success && updateResult.revisionId) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onozaty/growi-uploader",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "A content uploader for GROWI",
   "type": "module",
   "bin": {