kintone-migrator 0.1.2 → 0.2.0

package/README.md

@@ -19,19 +19,33 @@ Connection details for kintone can be specified via CLI arguments or environment
 | CLI Argument | Environment Variable | Description |
 |---------|----------|------|
 | `--domain`, `-d` | `KINTONE_DOMAIN` | kintone domain (e.g., `example.cybozu.com`) |
+| `--api-token`, `-t` | `KINTONE_API_TOKEN` | kintone API token |
 | `--username`, `-u` | `KINTONE_USERNAME` | kintone username |
 | `--password`, `-p` | `KINTONE_PASSWORD` | kintone password |
 | `--app-id`, `-a` | `KINTONE_APP_ID` | kintone app ID |
 | `--schema-file`, `-f` | `SCHEMA_FILE_PATH` | Schema file path (default: `schema.yaml`) |
 
+### Authentication
+
+Two authentication methods are supported:
+
+- **API Token** (`KINTONE_API_TOKEN`): Recommended. Scoped per app for better security. Multiple tokens can be specified as a comma-separated string (e.g., `token1,token2`).
+- **Username/Password** (`KINTONE_USERNAME` / `KINTONE_PASSWORD`): Basic authentication with user credentials.
+
+If both are provided, API Token takes priority. At least one method must be configured.
+
 ### .env File
 
 Environment variables can also be defined in a `.env` file and loaded with `dotenv-cli` or similar tools.
 
 ```env
 KINTONE_DOMAIN=example.cybozu.com
+
+# Authentication: Use either API Token or Username/Password (API Token takes priority)
+# KINTONE_API_TOKEN=your_api_token
 KINTONE_USERNAME=your_username
 KINTONE_PASSWORD=your_password
+
 KINTONE_APP_ID=123
 SCHEMA_FILE_PATH=schema.yaml
 ```

package/dist/index.mjs

@@ -4,11 +4,95 @@ import { cli, define } from "gunshi";
 import * as p from "@clack/prompts";
 import pc from "picocolors";
 import { KintoneRestAPIClient, KintoneRestAPIError } from "@kintone/rest-api-client";
+import * as v from "valibot";
 import { mkdir, readFile, writeFile } from "node:fs/promises";
 import { dirname } from "node:path";
 import { parse, stringify } from "yaml";
-import * as v from "valibot";
 
+//#region src/cli/config.ts
+const CliConfigSchema = v.object({
+	KINTONE_DOMAIN: v.pipe(v.string(), v.nonEmpty("KINTONE_DOMAIN is required")),
+	KINTONE_API_TOKEN: v.optional(v.string()),
+	KINTONE_USERNAME: v.optional(v.string()),
+	KINTONE_PASSWORD: v.optional(v.string()),
+	KINTONE_APP_ID: v.pipe(v.string(), v.nonEmpty("KINTONE_APP_ID is required")),
+	SCHEMA_FILE_PATH: v.optional(v.string(), "schema.yaml")
+});
+function buildKintoneAuth(auth) {
+	if (auth.type === "apiToken") return { apiToken: auth.apiToken };
+	return {
+		username: auth.username,
+		password: auth.password
+	};
+}
+const kintoneArgs = {
+	domain: {
+		type: "string",
+		short: "d",
+		description: "kintone domain (overrides KINTONE_DOMAIN env var)"
+	},
+	username: {
+		type: "string",
+		short: "u",
+		description: "kintone username (overrides KINTONE_USERNAME env var)"
+	},
+	password: {
+		type: "string",
+		short: "p",
+		description: "kintone password (overrides KINTONE_PASSWORD env var)"
+	},
+	"api-token": {
+		type: "string",
+		short: "t",
+		description: "kintone API token (overrides KINTONE_API_TOKEN env var)"
+	},
+	"app-id": {
+		type: "string",
+		short: "a",
+		description: "kintone app ID (overrides KINTONE_APP_ID env var)"
+	},
+	"schema-file": {
+		type: "string",
+		short: "f",
+		description: "Schema file path (default: schema.yaml)"
+	}
+};
+function resolveConfig(cliValues) {
+	const result = v.safeParse(CliConfigSchema, {
+		KINTONE_DOMAIN: cliValues.domain ?? process.env.KINTONE_DOMAIN ?? "",
+		KINTONE_API_TOKEN: cliValues["api-token"] ?? process.env.KINTONE_API_TOKEN ?? void 0,
+		KINTONE_USERNAME: cliValues.username ?? process.env.KINTONE_USERNAME ?? void 0,
+		KINTONE_PASSWORD: cliValues.password ?? process.env.KINTONE_PASSWORD ?? void 0,
+		KINTONE_APP_ID: cliValues["app-id"] ?? process.env.KINTONE_APP_ID ?? "",
+		SCHEMA_FILE_PATH: cliValues["schema-file"] ?? process.env.SCHEMA_FILE_PATH
+	});
+	if (!result.success) {
+		const missing = result.issues.map((issue) => issue.message).join("\n  ");
+		throw new Error(`Missing required configuration:\n  ${missing}`);
+	}
+	const { output } = result;
+	const auth = resolveAuth(output.KINTONE_API_TOKEN, output.KINTONE_USERNAME, output.KINTONE_PASSWORD);
+	return {
+		baseUrl: `https://${output.KINTONE_DOMAIN}`,
+		auth,
+		appId: output.KINTONE_APP_ID,
+		schemaFilePath: output.SCHEMA_FILE_PATH
+	};
+}
+function resolveAuth(apiToken, username, password) {
+	if (apiToken) return {
+		type: "apiToken",
+		apiToken: apiToken.includes(",") ? apiToken.split(",").map((t) => t.trim()) : apiToken
+	};
+	if (username && password) return {
+		type: "password",
+		username,
+		password
+	};
+	throw new Error("Missing required configuration:\n  Either KINTONE_API_TOKEN or KINTONE_USERNAME/KINTONE_PASSWORD is required");
+}
+
+//#endregion
 //#region src/lib/error.ts
 var AnyError = class extends Error {
 	constructor(message, cause) {
@@ -548,10 +632,7 @@ function isNodeError(error) {
 function createCliContainer(config) {
 	const client = new KintoneRestAPIClient({
 		baseUrl: config.baseUrl,
-		auth: {
-			username: config.username,
-			password: config.password
-		}
+		auth: buildKintoneAuth(config.auth)
 	});
 	return {
 		formConfigurator: new KintoneFormConfigurator(client, config.appId),
@@ -749,63 +830,6 @@ async function saveSchema({ container, input }) {
 	await container.schemaStorage.update(input.schemaText);
 }
 
-//#endregion
-//#region src/cli/config.ts
-const CliConfigSchema = v.object({
-	KINTONE_DOMAIN: v.pipe(v.string(), v.nonEmpty("KINTONE_DOMAIN is required")),
-	KINTONE_USERNAME: v.pipe(v.string(), v.nonEmpty("KINTONE_USERNAME is required")),
-	KINTONE_PASSWORD: v.pipe(v.string(), v.nonEmpty("KINTONE_PASSWORD is required")),
-	KINTONE_APP_ID: v.pipe(v.string(), v.nonEmpty("KINTONE_APP_ID is required")),
-	SCHEMA_FILE_PATH: v.optional(v.string(), "schema.yaml")
-});
-const kintoneArgs = {
-	domain: {
-		type: "string",
-		short: "d",
-		description: "kintone domain (overrides KINTONE_DOMAIN env var)"
-	},
-	username: {
-		type: "string",
-		short: "u",
-		description: "kintone username (overrides KINTONE_USERNAME env var)"
-	},
-	password: {
-		type: "string",
-		short: "p",
-		description: "kintone password (overrides KINTONE_PASSWORD env var)"
-	},
-	"app-id": {
-		type: "string",
-		short: "a",
-		description: "kintone app ID (overrides KINTONE_APP_ID env var)"
-	},
-	"schema-file": {
-		type: "string",
-		short: "f",
-		description: "Schema file path (default: schema.yaml)"
-	}
-};
-function resolveConfig(cliValues) {
-	const result = v.safeParse(CliConfigSchema, {
-		KINTONE_DOMAIN: cliValues.domain ?? process.env.KINTONE_DOMAIN ?? "",
-		KINTONE_USERNAME: cliValues.username ?? process.env.KINTONE_USERNAME ?? "",
-		KINTONE_PASSWORD: cliValues.password ?? process.env.KINTONE_PASSWORD ?? "",
-		KINTONE_APP_ID: cliValues["app-id"] ?? process.env.KINTONE_APP_ID ?? "",
-		SCHEMA_FILE_PATH: cliValues["schema-file"] ?? process.env.SCHEMA_FILE_PATH
-	});
-	if (!result.success) {
-		const missing = result.issues.map((issue) => issue.message).join("\n  ");
-		throw new Error(`Missing required configuration:\n  ${missing}`);
-	}
-	return {
-		baseUrl: `https://${result.output.KINTONE_DOMAIN}`,
-		username: result.output.KINTONE_USERNAME,
-		password: result.output.KINTONE_PASSWORD,
-		appId: result.output.KINTONE_APP_ID,
-		schemaFilePath: result.output.SCHEMA_FILE_PATH
-	};
-}
-
 //#endregion
 //#region src/cli/handleError.ts
 function handleCliError(error) {
@@ -1492,10 +1516,7 @@ var dump_default = define({
 			const config = resolveConfig(ctx.values);
 			const client = new KintoneRestAPIClient({
 				baseUrl: config.baseUrl,
-				auth: {
-					username: config.username,
-					password: config.password
-				}
+				auth: buildKintoneAuth(config.auth)
 			});
 			const s = p.spinner();
 			s.start("Fetching form fields and layout...");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kintone-migrator",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "kintone form schema migration tool",
   "license": "MIT",
   "author": "Hikaru Otabe",
@@ -53,10 +53,15 @@
   },
   "devDependencies": {
     "@biomejs/biome": "^2.3.14",
+    "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/github": "^12.0.5",
+    "@semantic-release/npm": "^13.1.4",
+    "@semantic-release/release-notes-generator": "^14.1.0",
     "@types/node": "^25.2.3",
     "@typescript/native-preview": "7.0.0-dev.20260211.1",
     "@vitest/coverage-v8": "^4.0.18",
     "dotenv-cli": "^11.0.0",
+    "semantic-release": "^25.0.3",
     "tsdown": "^0.20.3",
     "tsx": "^4.21.0",
     "typescript": "~5.9.3",