@onozaty/growi-uploader 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 onozaty
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,247 @@
+# 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)
+
+A CLI tool to batch upload local Markdown files and attachments to [GROWI](https://growi.org/) Wiki.
+
+## Features
+
+- 📁 **Preserves directory structure** - Local folder hierarchy becomes GROWI page hierarchy
+- 📝 **Markdown file upload** - Creates or updates GROWI pages from `.md` files
+- 📎 **Automatic attachment detection** - Files matching `<page>_attachment_<file>` pattern are uploaded as attachments
+- 🔗 **Link replacement** - Automatically converts local attachment links to GROWI format (`/attachment/{id}`)
+- 🖼️ **Image embedding** - Supports image links (`![alt](image.png)`) with automatic conversion
+- ⚙️ **Flexible configuration** - Control base path, update behavior, and more
+
+## Quick Start
+
+1. Create a configuration file `growi-uploader.json`:
+
+```json
+{
+  "url": "https://your-growi-instance.com",
+  "token": "your-api-token",
+  "basePath": "/",
+  "update": false
+}
+```
+
+2. Run with npx (no installation required):
+
+```bash
+npx @onozaty/growi-uploader ./docs
+```
+
+That's it! Your local `./docs` directory will be uploaded to GROWI.
+
+## Installation
+
+### Using npx (Recommended)
+
+No installation required. Just run:
+
+```bash
+npx @onozaty/growi-uploader <source-dir>
+```
+
+### Global Installation
+
+For frequent use, you can install globally:
+
+```bash
+npm install -g @onozaty/growi-uploader
+growi-uploader <source-dir>
+```
+
+## Usage
+
+### Basic Command
+
+```bash
+growi-uploader <source-dir> [options]
+```
+
+**Arguments:**
+- `<source-dir>`: Path to the directory containing Markdown files
+
+**Options:**
+- `-c, --config <path>`: Path to config file (default: `growi-uploader.json`)
+- `-V, --version`: Output the version number
+- `-h, --help`: Display help information
+
+### Examples
+
+```bash
+# Upload with default config file
+npx @onozaty/growi-uploader ./docs
+
+# Upload with custom config file
+npx @onozaty/growi-uploader ./docs -c my-config.json
+```
+
+## Directory Structure Example
+
+### Local Directory
+
+```
+docs/
+  guide.md
+  guide_attachment_diagram.svg
+  guide_attachment_sample.txt
+  api/
+    overview.md
+    overview_attachment_example.json
+    authentication.md
+```
+
+### Resulting GROWI Pages
+
+```
+/docs/guide                    (from guide.md)
+  └─ diagram.svg               (attachment)
+  └─ sample.txt                (attachment)
+/docs/api/overview             (from api/overview.md)
+  └─ example.json              (attachment)
+/docs/api/authentication       (from api/authentication.md)
+```
+
+## Configuration File
+
+Create a `growi-uploader.json` file in your project root:
+
+```json
+{
+  "url": "https://your-growi-instance.com",
+  "token": "your-api-token",
+  "basePath": "/imported",
+  "update": true
+}
+```
+
+### Configuration Options
+
+| Option | Type | Required | Default | Description |
+|--------|------|----------|---------|-------------|
+| `url` | string | ✅ | - | GROWI instance URL |
+| `token` | string | ✅ | - | GROWI API access token |
+| `basePath` | string | ❌ | `/` | Base path for imported pages |
+| `update` | boolean | ❌ | `false` | Update existing pages if true, skip if false |
+
+### Getting an API Token
+
+1. Log in to your GROWI instance
+2. Go to **User Settings** → **API Settings**
+3. Click **Issue new token**
+4. Copy the generated token to your config file
+
+## Attachment Files
+
+### Naming Convention
+
+Attachment files must follow this naming pattern:
+
+```
+<page-name>_attachment_<filename>
+```
+
+**Example:**
+```
+guide.md                       → GROWI page: /guide
+guide_attachment_image.png     → Attached to /guide
+guide_attachment_document.pdf  → Attached to /guide
+```
+
+### Automatic Link Replacement
+
+Markdown links to attachments are automatically converted to GROWI format.
+
+**Local Markdown (before upload):**
+```markdown
+# User Guide
+
+![Diagram](./guide_attachment_diagram.png)
+
+Download the [documentation](guide_attachment_document.pdf).
+```
+
+**GROWI Page (after upload):**
+```markdown
+# User Guide
+
+![Diagram](/attachment/68f3a41c794f665ad2c0d322)
+
+Download the [documentation](/attachment/68f3a3fa794f665ad2c0d2b3).
+```
+
+### Supported Link Formats
+
+Both formats are automatically detected and converted:
+
+1. **Filename only**: `![alt](guide_attachment_image.png)`
+2. **Relative path**: `![alt](./guide_attachment_image.png)`
+
+## Advanced Usage
+
+### Update Existing Pages
+
+Set `update: true` in your config file to update existing pages:
+
+```json
+{
+  "url": "https://your-growi-instance.com",
+  "token": "your-api-token",
+  "update": true
+}
+```
+
+### Import to Specific Path
+
+Use `basePath` to import all pages under a specific path:
+
+```json
+{
+  "url": "https://your-growi-instance.com",
+  "token": "your-api-token",
+  "basePath": "/imported"
+}
+```
+
+**Result:**
+```
+docs/guide.md  →  /imported/docs/guide
+```
+
+### Output Example
+
+```
+Found 5 Markdown file(s) and 3 attachment(s)
+
+[SUCCESS] docs/guide.md → /docs/guide (created)
+[SUCCESS] docs/guide_attachment_diagram.svg → /docs/guide (attachment)
+[SUCCESS] docs/guide.md → /docs/guide (attachment links replaced)
+[SUCCESS] docs/api/overview.md → /docs/api/overview (created)
+[SKIP] docs/api/auth.md → /docs/api/auth (page already exists)
+
+Completed:
+- Pages created: 2
+- Pages updated: 0
+- Pages skipped: 1
+- Page errors: 0
+- Attachments uploaded: 2
+- Attachments skipped: 0
+- Attachment errors: 0
+```
+
+## Requirements
+
+- Node.js 18 or later
+- GROWI instance with REST API v3 support
+
+## License
+
+MIT
+
+## Author
+
+[onozaty](https://github.com/onozaty)

package/dist/index.mjs

@@ -0,0 +1,397 @@
+#!/usr/bin/env node
+import { Command } from "commander";
+import { basename, dirname, join, resolve } from "node:path";
+import { readFileSync } from "node:fs";
+import { glob } from "glob";
+import * as axios$1 from "axios";
+import axios from "axios";
+import { lookup } from "mime-types";
+
+//#region src/config.ts
+const loadConfig = (configPath) => {
+	const fullPath = resolve(configPath);
+	try {
+		const content = readFileSync(fullPath, "utf-8");
+		const config = JSON.parse(content);
+		if (!config.url) throw new Error("Missing required field: url");
+		if (!config.token) throw new Error("Missing required field: token");
+		if (config.basePath === void 0) config.basePath = "/";
+		if (config.update === void 0) config.update = false;
+		return config;
+	} catch (error) {
+		if (error.code === "ENOENT") throw new Error(`Config file not found: ${fullPath}`);
+		throw error;
+	}
+};
+
+//#endregion
+//#region src/scanner.ts
+const scanMarkdownFiles = async (sourceDir, basePath = "/") => {
+	const mdFiles = await glob("**/*.md", {
+		cwd: sourceDir,
+		absolute: false
+	});
+	mdFiles.sort();
+	return await Promise.all(mdFiles.map(async (file) => {
+		const content = readFileSync(join(sourceDir, file), "utf-8");
+		const growiPath = join(basePath, file.replace(/\.md$/, "")).replace(/\\/g, "/");
+		const dir = dirname(file);
+		const pageName = basename(file, ".md");
+		const attachments = (await glob(dir === "." ? `${pageName}_attachment_*` : `${dir}/${pageName}_attachment_*`, {
+			cwd: sourceDir,
+			absolute: false
+		})).map((attachFile) => ({
+			localPath: attachFile,
+			fileName: basename(attachFile).replace(`${pageName}_attachment_`, "")
+		}));
+		return {
+			localPath: file,
+			growiPath: growiPath.startsWith("/") ? growiPath : `/${growiPath}`,
+			content,
+			attachments
+		};
+	}));
+};
+
+//#endregion
+//#region src/growi.ts
+/**
+* Add attachment to the page
+* @summary /attachment
+*/
+const postAttachment = (postAttachmentBody, options) => {
+	return axios$1.default.post(`/attachment`, postAttachmentBody, options);
+};
+/**
+* get page by pagePath or pageId
+* @summary Get page
+*/
+const getPage = (params, options) => {
+	return axios$1.default.get(`/page`, {
+		...options,
+		params: {
+			...params,
+			...options?.params
+		}
+	});
+};
+/**
+* Create page
+* @summary Create page
+*/
+const postPage = (postPageBody, options) => {
+	return axios$1.default.post(`/page`, postPageBody, options);
+};
+/**
+* Update page
+*/
+const putPage = (putPageBody, options) => {
+	return axios$1.default.put(`/page`, putPageBody, options);
+};
+
+//#endregion
+//#region src/uploader.ts
+const configureAxios = (growiUrl, token) => {
+	axios.defaults.baseURL = `${growiUrl}/_api/v3`;
+	axios.defaults.headers.common["Authorization"] = `Bearer ${token}`;
+};
+const createOrUpdatePage = async (file, config) => {
+	try {
+		const actualResponse = (await getPage({ path: file.growiPath })).data;
+		if (actualResponse.page) {
+			const pageId = actualResponse.page._id;
+			const revisionId = actualResponse.page.revision?._id;
+			if (!config.update) {
+				console.log(`[SKIP] ${file.localPath} → ${file.growiPath} (page already exists)`);
+				return {
+					pageId,
+					revisionId,
+					action: "skipped"
+				};
+			}
+			const newRevisionId = (await putPage({
+				body: file.content,
+				pageId,
+				revisionId
+			})).data.page?.revision;
+			console.log(`[SUCCESS] ${file.localPath} → ${file.growiPath} (updated)`);
+			return {
+				pageId,
+				revisionId: newRevisionId || revisionId,
+				action: "updated"
+			};
+		}
+	} catch (error) {
+		if (!axios.isAxiosError(error) || error.response?.status !== 404) {
+			if (axios.isAxiosError(error)) {
+				const status = error.response?.status;
+				const message = error.response?.data?.message || error.message;
+				console.error(`[ERROR] ${file.localPath} → ${file.growiPath} (${status} ${message})`);
+			} else console.error(`[ERROR] ${file.localPath} → ${file.growiPath} (${error})`);
+			return {
+				pageId: void 0,
+				revisionId: void 0,
+				action: "error"
+			};
+		}
+	}
+	try {
+		const response = await postPage({
+			path: file.growiPath,
+			body: file.content
+		});
+		const pageId = response.data.page?._id;
+		const revisionId = response.data.page?.revision;
+		console.log(`[SUCCESS] ${file.localPath} → ${file.growiPath} (created)`);
+		return {
+			pageId,
+			revisionId,
+			action: "created"
+		};
+	} catch (error) {
+		if (axios.isAxiosError(error)) {
+			const status = error.response?.status;
+			const message = error.response?.data?.message || error.message;
+			console.error(`[ERROR] ${file.localPath} → ${file.growiPath} (${status} ${message})`);
+		} else console.error(`[ERROR] ${file.localPath} → ${file.growiPath} (${error})`);
+		return {
+			pageId: void 0,
+			revisionId: void 0,
+			action: "error"
+		};
+	}
+};
+/**
+* Replace attachment links in Markdown content with GROWI format
+*
+* Supports:
+* - Filename only: guide_attachment_file.png
+* - Relative path: ./guide_attachment_file.png
+*
+* @param markdown Original Markdown content
+* @param attachments List of attachments with their IDs
+* @param pageName Page name (without .md extension)
+* @returns Object with replaced content and whether any replacement occurred
+*/
+const replaceAttachmentLinks = (markdown, attachments, pageName) => {
+	let result = markdown;
+	let replaced = false;
+	for (const attachment of attachments) {
+		if (!attachment.attachmentId) continue;
+		const localFileName = `${pageName}_attachment_${attachment.fileName}`;
+		const growiPath = `/attachment/${attachment.attachmentId}`;
+		const escapedFileName = localFileName.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+		const patterns = [escapedFileName, `\\./${escapedFileName}`];
+		for (const pattern of patterns) {
+			const imgRegex = new RegExp(`!\\[([^\\]]*)\\]\\(${pattern}\\)`, "g");
+			if (imgRegex.test(result)) {
+				replaced = true;
+				result = result.replace(imgRegex, `![$1](${growiPath})`);
+			}
+			const linkRegex = new RegExp(`(?<!!)\\[([^\\]]*)\\]\\(${pattern}\\)`, "g");
+			if (linkRegex.test(result)) {
+				replaced = true;
+				result = result.replace(linkRegex, `[$1](${growiPath})`);
+			}
+		}
+	}
+	return {
+		content: result,
+		replaced
+	};
+};
+/**
+* Update page content only (for re-updating after attachment link replacement)
+*
+* @param pageId Page ID
+* @param revisionId Current revision ID
+* @param content New Markdown content
+* @param growiPath GROWI page path (for logging)
+* @returns True if update succeeded
+*/
+const updatePageContent = async (pageId, revisionId, content, growiPath) => {
+	try {
+		await putPage({
+			body: content,
+			pageId,
+			revisionId
+		});
+		return true;
+	} catch (error) {
+		if (axios.isAxiosError(error)) {
+			const status = error.response?.status;
+			const message = error.response?.data?.message || error.message;
+			console.error(`[WARN] Failed to update attachment links for ${growiPath} (${status} ${message})`);
+		} else console.error(`[WARN] Failed to update attachment links for ${growiPath}`);
+		return false;
+	}
+};
+const uploadAttachment = async (attachment, pageId, growiPath, sourceDir) => {
+	try {
+		const fileBuffer = readFileSync(join(sourceDir, attachment.localPath));
+		const mimeType = lookup(attachment.fileName) || "application/octet-stream";
+		const formData = new FormData();
+		formData.append("page_id", pageId);
+		formData.append("file", new Blob([fileBuffer], { type: mimeType }), attachment.fileName);
+		const response = await postAttachment(formData);
+		const attachmentId = response.data.attachment?._id;
+		const revisionId = typeof response.data.revision === "string" ? response.data.revision : void 0;
+		console.log(`[SUCCESS] ${attachment.localPath} → ${growiPath} (attachment)`);
+		if (attachmentId && revisionId) return {
+			success: true,
+			attachmentId,
+			revisionId
+		};
+		else if (attachmentId) return {
+			success: true,
+			attachmentId
+		};
+		else if (revisionId) return {
+			success: true,
+			revisionId
+		};
+		else return { success: true };
+	} catch (error) {
+		if (axios.isAxiosError(error)) {
+			const status = error.response?.status;
+			const message = error.response?.data?.message || error.message;
+			console.error(`[ERROR] ${attachment.localPath} → ${growiPath} (${status} ${message})`);
+		} else console.error(`[ERROR] ${attachment.localPath} → ${growiPath} (${error})`);
+		return { success: false };
+	}
+};
+
+//#endregion
+//#region package.json
+var name = "@onozaty/growi-uploader";
+var version = "1.0.0";
+var description = "A content uploader for GROWI";
+var type = "module";
+var bin = { "growi-uploader": "./dist/index.mjs" };
+var files = ["dist/**/*"];
+var scripts = {
+	"build": "pnpm gen && tsdown",
+	"prepublishOnly": "pnpm run build",
+	"dev": "tsx src/index.ts",
+	"gen": "orval",
+	"lint": "eslint .",
+	"typecheck": "tsc --noEmit",
+	"check": "pnpm run lint && pnpm run typecheck",
+	"format": "prettier --write src/"
+};
+var repository = {
+	"type": "git",
+	"url": "git+https://github.com/onozaty/growi-uploader.git"
+};
+var keywords = ["growi", "uploader"];
+var author = "onozaty";
+var license = "MIT";
+var bugs = { "url": "https://github.com/onozaty/growi-uploader/issues" };
+var homepage = "https://github.com/onozaty/growi-uploader#readme";
+var packageManager = "pnpm@10.12.1";
+var devDependencies = {
+	"@eslint/js": "^9.37.0",
+	"@types/mime-types": "^3.0.1",
+	"@types/node": "^24.7.2",
+	"eslint": "^9.37.0",
+	"globals": "^16.4.0",
+	"jiti": "^2.6.1",
+	"orval": "^7.13.2",
+	"prettier": "^3.6.2",
+	"tsdown": "^0.15.7",
+	"tsx": "^4.20.6",
+	"typescript": "^5.9.3",
+	"typescript-eslint": "^8.46.1"
+};
+var dependencies = {
+	"axios": "^1.12.2",
+	"commander": "^14.0.1",
+	"glob": "^11.0.3",
+	"mime-types": "^3.0.1"
+};
+var package_default = {
+	name,
+	version,
+	description,
+	type,
+	bin,
+	files,
+	scripts,
+	repository,
+	keywords,
+	author,
+	license,
+	bugs,
+	homepage,
+	packageManager,
+	devDependencies,
+	dependencies
+};
+
+//#endregion
+//#region src/index.ts
+const program = new Command();
+program.name("growi-uploader").description("A content uploader for GROWI").version(package_default.version).argument("<source-dir>", "Source directory containing Markdown files").option("-c, --config <path>", "Path to config file", "growi-uploader.json").action(async (sourceDir, options) => {
+	try {
+		const config = loadConfig(options.config);
+		const sourceDirPath = resolve(sourceDir);
+		configureAxios(config.url, config.token);
+		const files$1 = await scanMarkdownFiles(sourceDirPath, config.basePath);
+		const totalAttachments = files$1.reduce((sum, file) => sum + file.attachments.length, 0);
+		console.log(`Found ${files$1.length} Markdown file(s) and ${totalAttachments} attachment(s)\n`);
+		let pagesCreated = 0;
+		let pagesUpdated = 0;
+		let pagesSkipped = 0;
+		let pageErrors = 0;
+		let attachmentsUploaded = 0;
+		let attachmentsSkipped = 0;
+		let attachmentErrors = 0;
+		for (const file of files$1) {
+			const result = await createOrUpdatePage(file, config);
+			if (result.action === "created") pagesCreated++;
+			else if (result.action === "updated") pagesUpdated++;
+			else if (result.action === "skipped") pagesSkipped++;
+			else if (result.action === "error") pageErrors++;
+			if (result.pageId && (result.action === "created" || result.action === "updated") && file.attachments.length > 0) {
+				let hasAttachments = false;
+				let latestRevisionId = result.revisionId;
+				for (const attachment of file.attachments) {
+					const attachmentResult = await uploadAttachment(attachment, result.pageId, file.growiPath, sourceDirPath);
+					if (attachmentResult.success) {
+						attachmentsUploaded++;
+						if (attachmentResult.attachmentId) {
+							attachment.attachmentId = attachmentResult.attachmentId;
+							hasAttachments = true;
+						}
+						if (attachmentResult.revisionId) latestRevisionId = attachmentResult.revisionId;
+					} else attachmentErrors++;
+				}
+				if (hasAttachments && latestRevisionId) {
+					const pageName = basename(file.localPath, ".md");
+					const { content: replacedContent, replaced } = replaceAttachmentLinks(file.content, file.attachments, pageName);
+					if (replaced) {
+						if (await updatePageContent(result.pageId, latestRevisionId, replacedContent, file.growiPath)) console.log(`[SUCCESS] ${file.localPath} → ${file.growiPath} (attachment links replaced)`);
+					}
+				}
+			} else if (file.attachments.length > 0) for (const attachment of file.attachments) {
+				console.log(`[SKIP] ${attachment.localPath} → ${file.growiPath} (attachment skipped)`);
+				attachmentsSkipped++;
+			}
+		}
+		console.log("\nCompleted:");
+		console.log(`- Pages created: ${pagesCreated}`);
+		console.log(`- Pages updated: ${pagesUpdated}`);
+		console.log(`- Pages skipped: ${pagesSkipped}`);
+		console.log(`- Page errors: ${pageErrors}`);
+		console.log(`- Attachments uploaded: ${attachmentsUploaded}`);
+		console.log(`- Attachments skipped: ${attachmentsSkipped}`);
+		console.log(`- Attachment errors: ${attachmentErrors}`);
+	} catch (error) {
+		console.error("Error:", error instanceof Error ? error.message : error);
+		process.exit(1);
+	}
+});
+program.parse();
+
+//#endregion
+export {  };

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@onozaty/growi-uploader",
+  "version": "1.0.0",
+  "description": "A content uploader for GROWI",
+  "type": "module",
+  "bin": {
+    "growi-uploader": "./dist/index.mjs"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "scripts": {
+    "build": "pnpm gen && tsdown",
+    "prepublishOnly": "pnpm run build",
+    "dev": "tsx src/index.ts",
+    "gen": "orval",
+    "lint": "eslint .",
+    "typecheck": "tsc --noEmit",
+    "check": "pnpm run lint && pnpm run typecheck",
+    "format": "prettier --write src/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/onozaty/growi-uploader.git"
+  },
+  "keywords": [
+    "growi",
+    "uploader"
+  ],
+  "author": "onozaty",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/onozaty/growi-uploader/issues"
+  },
+  "homepage": "https://github.com/onozaty/growi-uploader#readme",
+  "packageManager": "pnpm@10.12.1",
+  "devDependencies": {
+    "@eslint/js": "^9.37.0",
+    "@types/mime-types": "^3.0.1",
+    "@types/node": "^24.7.2",
+    "eslint": "^9.37.0",
+    "globals": "^16.4.0",
+    "jiti": "^2.6.1",
+    "orval": "^7.13.2",
+    "prettier": "^3.6.2",
+    "tsdown": "^0.15.7",
+    "tsx": "^4.20.6",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.46.1"
+  },
+  "dependencies": {
+    "axios": "^1.12.2",
+    "commander": "^14.0.1",
+    "glob": "^11.0.3",
+    "mime-types": "^3.0.1"
+  }
+}