@goqoo/trunks 0.2.0 → 1.0.0

package/dts/customer-fields.d.ts

@@ -1,28 +0,0 @@
-declare namespace kintone.types {
-  interface CustomerFields {
-    顧客情報メモ欄: kintone.fieldTypes.MultiLineText;
-    文字列__1行_: kintone.fieldTypes.SingleLineText;
-    Webサイト: kintone.fieldTypes.Link;
-    建物名: kintone.fieldTypes.SingleLineText;
-    顧客ランク: kintone.fieldTypes.RadioButton;
-    支払日: kintone.fieldTypes.DropDown;
-    住所: kintone.fieldTypes.SingleLineText;
-    電話番号: kintone.fieldTypes.Link;
-    会社名: kintone.fieldTypes.SingleLineText;
-    郵便番号: kintone.fieldTypes.SingleLineText;
-    業種: kintone.fieldTypes.DropDown;
-    文字列__1行__0: kintone.fieldTypes.SingleLineText;
-    都道府県: kintone.fieldTypes.DropDown;
-    締め日: kintone.fieldTypes.DropDown;
-    FAX: kintone.fieldTypes.Link;
-  }
-  interface SavedCustomerFields extends CustomerFields {
-    $id: kintone.fieldTypes.Id;
-    $revision: kintone.fieldTypes.Revision;
-    更新者: kintone.fieldTypes.Modifier;
-    作成者: kintone.fieldTypes.Creator;
-    顧客No: kintone.fieldTypes.RecordNumber;
-    更新日時: kintone.fieldTypes.UpdatedTime;
-    作成日時: kintone.fieldTypes.CreatedTime;
-  }
-}

package/jest.config.js

@@ -1,19 +0,0 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} */
-export default {
-  preset: 'ts-jest/presets/default-esm',
-  testEnvironment: 'node',
-  extensionsToTreatAsEsm: ['.ts'],
-  moduleNameMapper: {
-    '^(\\.{1,2}/.*)\\.js$': '$1',
-  },
-  transform: {
-    '^.+\\.ts$': [
-      'ts-jest',
-      {
-        useESM: true,
-      },
-    ],
-  },
-  testMatch: ['<rootDir>/test/**/*.test.ts'],
-  collectCoverageFrom: ['src/**/*.ts', '!src/cli.ts'],
-};

package/src/cli.ts

@@ -1,28 +0,0 @@
-#!/usr/bin/env node
-import { Command } from 'commander';
-import chalk from 'chalk';
-import { loadConfig } from './config.js';
-import { generate } from './generate.js';
-
-const program = new Command();
-
-program
-  .name('trunks')
-  .description('Generate TypeScript type definitions for multiple Kintone apps')
-  .version('0.1.0');
-
-program
-  .command('generate', { isDefault: true })
-  .description('Generate type definitions for all configured apps')
-  .option('-c, --config <path>', 'Path to config file')
-  .action(async (options) => {
-    try {
-      const config = await loadConfig(options.config ? undefined : process.cwd());
-      await generate(config);
-    } catch (error) {
-      console.error(chalk.red('Error:'), error instanceof Error ? error.message : error);
-      process.exit(1);
-    }
-  });
-
-program.parse();

package/src/config.ts

@@ -1,23 +0,0 @@
-import { existsSync } from 'fs';
-import { resolve } from 'path';
-import { createJiti } from 'jiti';
-import type { Config } from './types.js';
-
-const CONFIG_FILES = ['trunks.config.ts', 'trunks.config.js', 'trunks.config.mjs'];
-
-// 設定ファイルを検索して読み込む
-export async function loadConfig(cwd: string = process.cwd()): Promise<Config> {
-  const jiti = createJiti(cwd, { interopDefault: true });
-
-  for (const filename of CONFIG_FILES) {
-    const configPath = resolve(cwd, filename);
-    if (existsSync(configPath)) {
-      const config = await jiti.import(configPath);
-      return config as Config;
-    }
-  }
-
-  throw new Error(
-    `Config file not found. Create one of: ${CONFIG_FILES.join(', ')}`
-  );
-}

package/src/generate.ts

@@ -1,273 +0,0 @@
-import { spawn, spawnSync } from 'child_process';
-import { mkdirSync } from 'fs';
-import * as readline from 'readline';
-import chalk from 'chalk';
-import { kebabCase, pascalCase } from 'change-case';
-import type { AgentOptions, Config } from './types.js';
-import { getOauthToken } from './oauth.js';
-
-// npx prettierが実行可能かチェック
-function isPrettierAvailable(): boolean {
-  const result = spawnSync('npx', ['prettier', '--version'], {
-    stdio: 'pipe',
-    encoding: 'utf-8',
-  });
-  return result.status === 0;
-}
-
-// Prettierでファイルをフォーマット
-function formatWithPrettier(filePath: string): Promise<boolean> {
-  return new Promise((resolve) => {
-    const proc = spawn('npx', ['prettier', '--write', filePath], {
-      cwd: process.cwd(),
-      stdio: 'pipe',
-    });
-
-    proc.on('close', (code) => {
-      resolve(code === 0);
-    });
-
-    proc.on('error', () => {
-      resolve(false);
-    });
-  });
-}
-
-type DtsGenArgs = Record<string, string | undefined>;
-
-// 標準入力からテキストを取得
-function prompt(question: string): Promise<string> {
-  const rl = readline.createInterface({
-    input: process.stdin,
-    output: process.stdout,
-  });
-
-  return new Promise((resolve) => {
-    rl.question(question, (answer) => {
-      rl.close();
-      resolve(answer);
-    });
-  });
-}
-
-// 標準入力からパスワードを取得（入力を隠す）
-function promptPassword(question: string): Promise<string> {
-  return new Promise((resolve) => {
-    process.stdout.write(question);
-
-    const stdin = process.stdin;
-    if (!stdin.isTTY) {
-      // TTYでない場合は通常の入力
-      const rl = readline.createInterface({ input: stdin, output: process.stdout });
-      rl.question('', (answer) => {
-        rl.close();
-        resolve(answer);
-      });
-      return;
-    }
-
-    // TTYの場合はraw modeで入力を隠す
-    stdin.setRawMode(true);
-    stdin.resume();
-    stdin.setEncoding('utf8');
-
-    let password = '';
-    const onData = (char: string) => {
-      if (char === '\n' || char === '\r' || char === '\u0004') {
-        // Enter or Ctrl+D
-        stdin.setRawMode(false);
-        stdin.removeListener('data', onData);
-        stdin.pause();
-        process.stdout.write('\n');
-        resolve(password);
-      } else if (char === '\u0003') {
-        // Ctrl+C
-        stdin.setRawMode(false);
-        process.stdout.write('\n');
-        process.exit(1);
-      } else if (char === '\u007F' || char === '\b') {
-        // Backspace
-        password = password.slice(0, -1);
-      } else {
-        password += char;
-      }
-    };
-
-    stdin.on('data', onData);
-  });
-}
-
-// 認証引数を構築
-async function buildAuthArgs(config: Config): Promise<DtsGenArgs> {
-  const args: DtsGenArgs = {};
-
-  switch (config.auth.type) {
-    case 'password': {
-      let username = process.env.KINTONE_USERNAME;
-      let password = process.env.KINTONE_PASSWORD;
-
-      // 環境変数が未設定の場合は標準入力で取得
-      if (!username) {
-        username = await prompt('Kintone Username: ');
-      }
-      if (!password) {
-        password = await promptPassword('Kintone Password: ');
-      }
-
-      if (!username || !password) {
-        throw new Error('Username and password are required for password auth');
-      }
-
-      args['username'] = username;
-      args['password'] = password;
-      break;
-    }
-    case 'oauth': {
-      // Gyumaを使ってOAuthトークンを取得
-      const agentOptions: AgentOptions = {
-        proxy: config.proxy ? `http://${config.proxy.host}:${config.proxy.port}` : undefined,
-        pfx: config.pfx,
-      };
-      const oauthToken = await getOauthToken(config.host, config.auth.scope, agentOptions);
-      args['oauth-token'] = oauthToken;
-      break;
-    }
-    case 'api-token':
-      args['api-token'] = config.auth.token;
-      break;
-  }
-
-  // Basic認証
-  if (config.basicAuth) {
-    args['basic-auth-username'] = config.basicAuth.username;
-    args['basic-auth-password'] = config.basicAuth.password;
-  }
-
-  // プロキシ
-  if (config.proxy) {
-    args['proxy'] = `http://${config.proxy.host}:${config.proxy.port}`;
-  }
-
-  return args;
-}
-
-// kintoneのエラーレスポンスを抽出
-function extractKintoneError(output: string): { code: string; id: string; message: string } | null {
-  // 形式: code: 'GAIA_AP15' または "code": "GAIA_AP15"
-  const codeMatch = output.match(/code:\s*'([^']+)'/) ?? output.match(/"code":\s*"([^"]+)"/);
-  const idMatch = output.match(/id:\s*'([^']+)'/) ?? output.match(/"id":\s*"([^"]+)"/);
-  const messageMatch = output.match(/message:\s*'([^']+)'/) ?? output.match(/"message":\s*"([^"]+)"/);
-
-  const code = codeMatch?.[1];
-  const id = idMatch?.[1];
-  const message = messageMatch?.[1];
-
-  if (code && message) {
-    return { code, id: id ?? '', message };
-  }
-  return null;
-}
-
-// 単一アプリの型定義を生成
-function generateForApp(
-  appName: string,
-  appId: number,
-  config: Config,
-  authArgs: DtsGenArgs,
-  outDir: string
-): Promise<{ success: boolean; output: string }> {
-  return new Promise((resolve) => {
-    const outputPath = `${outDir}/${kebabCase(appName)}-fields.d.ts`;
-    const args: DtsGenArgs = {
-      'base-url': `https://${config.host}`,
-      ...authArgs,
-      'type-name': `${pascalCase(appName)}Fields`,
-      'app-id': String(appId),
-      'output': outputPath,
-      'guest-space-id': config.guestSpaceId !== undefined ? String(config.guestSpaceId) : undefined,
-      'namespace': config.namespace,
-    };
-
-    // undefined値をフィルタリングして引数配列を作成
-    const cliArgs = Object.entries(args)
-      .filter(([, value]) => value !== undefined)
-      .map(([key, value]) => `--${key}=${value}`);
-
-    // プレビュー環境の場合は--previewフラグを追加
-    if (config.preview) {
-      cliArgs.push('--preview');
-    }
-
-    const proc = spawn('npx', ['kintone-dts-gen', ...cliArgs], {
-      cwd: process.cwd(),
-      stdio: ['inherit', 'pipe', 'pipe'],
-    });
-
-    let stdout = '';
-    let stderr = '';
-    proc.stdout?.on('data', (data) => {
-      stdout += data.toString();
-    });
-    proc.stderr?.on('data', (data) => {
-      stderr += data.toString();
-    });
-
-    proc.on('close', (code) => {
-      if (code !== 0) {
-        // stdoutとstderr両方からエラー情報を探す
-        const output = stdout + stderr;
-        const kintoneError = extractKintoneError(output);
-        if (kintoneError) {
-          console.error(chalk.red(`Error [${appName}]:`), kintoneError.message);
-          console.error(chalk.gray(`  code: ${kintoneError.code}, id: ${kintoneError.id}`));
-        } else {
-          console.error(chalk.red(`Error [${appName}]:`), `kintone-dts-gen exited with code ${code}`);
-        }
-        resolve({ success: false, output: outputPath });
-      } else {
-        console.info(`${chalk.cyan('info')} ${chalk.magenta('Created')} ${chalk.green(outputPath)}`);
-        resolve({ success: true, output: outputPath });
-      }
-    });
-
-    proc.on('error', (err) => {
-      console.error(chalk.red(`Error [${appName}]:`), err.message);
-      resolve({ success: false, output: outputPath });
-    });
-  });
-}
-
-// 全アプリの型定義を生成
-export async function generate(config: Config): Promise<void> {
-  const outDir = config.outDir ?? 'dts';
-  mkdirSync(outDir, { recursive: true });
-
-  const authArgs = await buildAuthArgs(config);
-  const apps = Object.entries(config.apps);
-
-  // format: trueの場合のみPrettierを使用
-  const usePrettier = config.format === true && isPrettierAvailable();
-
-  console.info(chalk.cyan(`Generating type definitions for ${apps.length} app(s)...`));
-
-  // 順次実行（並列だとコンソール出力が混在する）
-  const results: { success: boolean; output: string }[] = [];
-  for (const [appName, appId] of apps) {
-    const result = await generateForApp(appName, appId, config, authArgs, outDir);
-    results.push(result);
-
-    // 成功したファイルをPrettierでフォーマット
-    if (result.success && usePrettier) {
-      await formatWithPrettier(result.output);
-    }
-  }
-
-  const successCount = results.filter((r) => r.success).length;
-  const failCount = results.length - successCount;
-
-  if (failCount > 0) {
-    console.info(chalk.yellow(`\nCompleted with ${failCount} error(s). (${successCount}/${results.length} succeeded)`));
-  } else {
-    console.info(chalk.green('Done!'));
-  }
-}

package/src/index.ts

@@ -1,14 +0,0 @@
-export { defineConfig } from './types.js';
-export type {
-  Config,
-  Auth,
-  PasswordAuth,
-  OAuthAuth,
-  ApiTokenAuth,
-  ProxyConfig,
-  BasicAuthConfig,
-  PfxConfig,
-  AgentOptions,
-} from './types.js';
-export { loadConfig } from './config.js';
-export { generate } from './generate.js';

package/src/oauth.ts

@@ -1,14 +0,0 @@
-import { gyuma } from 'gyuma';
-import type { AgentOptions } from './types.js';
-
-// dts-genはフィールド情報を読み取るので k:app_settings:read が必要
-const DEFAULT_SCOPE = 'k:app_settings:read';
-
-export const getOauthToken = async (
-  domain: string,
-  scope: string | undefined,
-  agentOptions: AgentOptions
-): Promise<string> => {
-  const token = await gyuma({ domain, scope: scope ?? DEFAULT_SCOPE, ...agentOptions }, true);
-  return token;
-};

package/src/types.ts

@@ -1,65 +0,0 @@
-// 認証設定
-export type PasswordAuth = {
-  type: 'password';
-  // 環境変数 KINTONE_USERNAME, KINTONE_PASSWORD から取得
-};
-
-export type OAuthAuth = {
-  type: 'oauth';
-  scope?: string;
-};
-
-export type ApiTokenAuth = {
-  type: 'api-token';
-  token: string;
-};
-
-export type Auth = PasswordAuth | OAuthAuth | ApiTokenAuth;
-
-// プロキシ設定
-export type ProxyConfig = {
-  host: string;
-  port: number;
-};
-
-// Basic認証設定
-export type BasicAuthConfig = {
-  username: string;
-  password: string;
-};
-
-// クライアント証明書設定（PFX/PKCS#12形式）
-export type PfxConfig = {
-  filepath: string;
-  password: string;
-};
-
-// Gyuma用のエージェントオプション
-export type AgentOptions = {
-  proxy?: string;
-  pfx?: PfxConfig;
-};
-
-// メイン設定
-export type Config = {
-  host: string; // Kintone環境のホスト（例: "example.cybozu.com"）
-  apps: Record<string, number>; // { appName: appId }
-  auth: Auth;
-  proxy?: ProxyConfig;
-  basicAuth?: BasicAuthConfig;
-  // クライアント証明書（OAuth使用時にGyumaへ渡す）
-  pfx?: PfxConfig;
-  // 出力ディレクトリ（デフォルト: "dts"）
-  outDir?: string;
-  // プレビュー環境を参照する場合はtrue（デフォルト: false）
-  preview?: boolean;
-  // ゲストスペースID（ゲストスペース内のアプリの場合に指定）
-  guestSpaceId?: number;
-  // 生成する型のnamespace（デフォルト: "kintone.types"）
-  namespace?: string;
-  // 生成後にPrettierでフォーマットするか（デフォルト: false）
-  format?: boolean;
-};
-
-// 設定ファイルの型（defineConfigのため）
-export const defineConfig = (config: Config): Config => config;

package/test/config.test.ts

@@ -1,15 +0,0 @@
-import { describe, it, expect } from '@jest/globals';
-import { resolve } from 'path';
-import { existsSync } from 'fs';
-import { loadConfig } from '../src/config';
-
-describe('loadConfig', () => {
-  it('設定ファイルが見つからない場合はエラーをスローする', async () => {
-    // 存在しないディレクトリを指定
-    await expect(loadConfig('/non-existent-dir-12345')).rejects.toThrow('Config file not found');
-  });
-
-  it('エラーメッセージに設定ファイル名の候補を含む', async () => {
-    await expect(loadConfig('/non-existent-dir-12345')).rejects.toThrow('trunks.config.ts');
-  });
-});

package/test/generate.test.ts

@@ -1,32 +0,0 @@
-import { describe, it, expect, beforeEach, afterEach } from '@jest/globals';
-import { generate } from '../src/generate';
-import type { Config } from '../src/types';
-
-describe('generate', () => {
-  const originalEnv = process.env;
-
-  beforeEach(() => {
-    process.env = { ...originalEnv };
-  });
-
-  afterEach(() => {
-    process.env = originalEnv;
-  });
-
-  // NOTE: パスワード認証で環境変数が未設定の場合は標準入力を求めるため、
-  // 自動テストでは検証が困難。手動テストで確認する。
-
-  // NOTE: OAuth認証はGyumaがブラウザを開いて認証フローを実行するため、
-  // 自動テストでは検証が困難。手動テストで確認する。
-
-  it('appsが空の場合でもエラーにならない', async () => {
-    const config: Config = {
-      host: 'example.cybozu.com',
-      apps: {},
-      auth: { type: 'api-token', token: 'test' },
-    };
-
-    // appsが空なのでspawnは呼ばれず、正常終了するはず
-    await expect(generate(config)).resolves.toBeUndefined();
-  });
-});

package/test/types.test.ts

@@ -1,116 +0,0 @@
-import { describe, it, expect } from '@jest/globals';
-import { defineConfig } from '../src/types';
-import type { Config } from '../src/types';
-
-describe('defineConfig', () => {
-  it('パスワード認証の設定を返す', () => {
-    const config = defineConfig({
-      host: 'example.cybozu.com',
-      apps: { customer: 1, order: 2 },
-      auth: { type: 'password' },
-    });
-
-    expect(config.host).toBe('example.cybozu.com');
-    expect(config.apps).toEqual({ customer: 1, order: 2 });
-    expect(config.auth.type).toBe('password');
-  });
-
-  it('APIトークン認証の設定を返す', () => {
-    const config = defineConfig({
-      host: 'example.cybozu.com',
-      apps: { customer: 1 },
-      auth: { type: 'api-token', token: 'test-token' },
-    });
-
-    expect(config.auth.type).toBe('api-token');
-    if (config.auth.type === 'api-token') {
-      expect(config.auth.token).toBe('test-token');
-    }
-  });
-
-  it('OAuth認証の設定を返す', () => {
-    const config = defineConfig({
-      host: 'example.cybozu.com',
-      apps: { customer: 1 },
-      auth: { type: 'oauth', scope: 'k:app_record:read' },
-    });
-
-    expect(config.auth.type).toBe('oauth');
-    if (config.auth.type === 'oauth') {
-      expect(config.auth.scope).toBe('k:app_record:read');
-    }
-  });
-
-  it('オプション設定を含む設定を返す', () => {
-    const config = defineConfig({
-      host: 'example.cybozu.com',
-      apps: { customer: 1 },
-      auth: { type: 'password' },
-      proxy: { host: 'proxy.example.com', port: 8080 },
-      basicAuth: { username: 'user', password: 'pass' },
-      outDir: 'types',
-    });
-
-    expect(config.proxy).toEqual({ host: 'proxy.example.com', port: 8080 });
-    expect(config.basicAuth).toEqual({ username: 'user', password: 'pass' });
-    expect(config.outDir).toBe('types');
-  });
-
-  it('プレビュー環境の設定を返す', () => {
-    const config = defineConfig({
-      host: 'example.cybozu.com',
-      apps: { customer: 1 },
-      auth: { type: 'api-token', token: 'test-token' },
-      preview: true,
-    });
-
-    expect(config.preview).toBe(true);
-  });
-
-  it('ゲストスペースの設定を返す', () => {
-    const config = defineConfig({
-      host: 'example.cybozu.com',
-      apps: { customer: 1 },
-      auth: { type: 'api-token', token: 'test-token' },
-      guestSpaceId: 5,
-    });
-
-    expect(config.guestSpaceId).toBe(5);
-  });
-
-  it('namespaceの設定を返す', () => {
-    const config = defineConfig({
-      host: 'example.cybozu.com',
-      apps: { customer: 1 },
-      auth: { type: 'api-token', token: 'test-token' },
-      namespace: 'myapp.types',
-    });
-
-    expect(config.namespace).toBe('myapp.types');
-  });
-
-  it('型チェックが正しく機能する', () => {
-    // 型レベルでのテスト（コンパイルが通ればOK）
-    const passwordConfig: Config = {
-      host: 'example.cybozu.com',
-      apps: { app1: 1 },
-      auth: { type: 'password' },
-    };
-
-    const apiTokenConfig: Config = {
-      host: 'example.cybozu.com',
-      apps: { app1: 1 },
-      auth: { type: 'api-token', token: 'xxx' },
-    };
-
-    const oauthConfig: Config = {
-      host: 'example.cybozu.com',
-      apps: { app1: 1 },
-      auth: { type: 'oauth' },
-    };
-
-    expect(passwordConfig).toBeDefined();
-    expect(apiTokenConfig).toBeDefined();
-    expect(oauthConfig).toBeDefined();
-  });
-});

package/trunks.config.ts

@@ -1,19 +0,0 @@
-import { defineConfig } from './src/types'
-
-export default defineConfig({
-  host: 'the-red.cybozu.com',
-  format: true,
-  preview: false,
-  apps: {
-    activity: 265,
-    customer: 266,
-    // project: 267,
-  },
-  // 以下のいずれかの認証方式を選択
-  auth: { type: 'oauth' },
-  // または
-  // auth: {
-  //   type: 'api-token',
-  //   token: '6mrxShdoQdFdN943q9Wg50nr7LxdwMsy1TTFkttF,K6t3rpw8PGoKQm7UPtiG0lyZawUyK0SPyjy4x7wJ',
-  // }, // 環境変数 KINTONE_USERNAME, KINTONE_PASSWORD を使用
-})

package/tsconfig.json

@@ -1,16 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
-    "outDir": "dist",
-    "rootDir": "src",
-    "strict": true,
-    "isolatedModules": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "declaration": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist"]
-}