@konomi-app/k2 0.1.0

package/README.md

@@ -0,0 +1,3 @@
+# k2 - 🍳 kintone kitchen 🍳
+
+kintone sdk for node.js

package/dist/commands/build/index.js

@@ -0,0 +1,30 @@
+import { program } from 'commander';
+import { build } from 'vite';
+import { importPluginConfig } from '../../lib/import.js';
+import { getViteConfig } from '../../lib/vite.js';
+import { CONTENTS_DIRECTORY } from '../../lib/constants.js';
+export default function command() {
+    program
+        .command('build')
+        .description("Build the project for production. (It's a wrapper of Vite build command.)")
+        .action(action);
+}
+export async function action() {
+    console.group('🚀 Build the project for production');
+    try {
+        const config = await importPluginConfig();
+        const viteConfig = getViteConfig(config);
+        await build({
+            ...viteConfig,
+            mode: 'production',
+            build: { ...viteConfig.build, outDir: CONTENTS_DIRECTORY },
+        });
+        console.log('✨ Build success.');
+    }
+    catch (error) {
+        throw error;
+    }
+    finally {
+        console.groupEnd();
+    }
+}

package/dist/commands/dev/index.js

@@ -0,0 +1,112 @@
+import { program } from 'commander';
+import { importPluginConfig } from '../../lib/import.js';
+import express from 'express';
+import { createServer } from 'https';
+import path from 'path';
+import { DEFAULT_PORT, DEVELOPMENT_DIRECTORY, WORKSPACE_DIRECTORY, } from '../../lib/constants.js';
+import fs from 'fs-extra';
+import { outputManifest } from '../../lib/plugin-manifest.js';
+import { copyPluginContents } from '../../lib/plugin-contents.js';
+import chokider from 'chokidar';
+import { generateCert } from '../../lib/cert.js';
+import { getContentsZipBuffer, getZipFileNameSuffix, outputContentsZip, } from '../../lib/zip.js';
+import packer from '@kintone/plugin-packer';
+import { uploadZip } from '../../lib/utils.js';
+import { buildWithEsbuild } from '../../lib/esbuild.js';
+export default function command() {
+    program
+        .command('dev')
+        .description('Start development server.')
+        .action(action);
+}
+export async function action() {
+    console.group('🚀 Start development server');
+    try {
+        const config = await importPluginConfig();
+        const port = config.server?.port ?? DEFAULT_PORT;
+        const manifest = await outputManifest('dev', {
+            config: {
+                ...config,
+                manifest: {
+                    ...config.manifest,
+                    dev: {
+                        config: {
+                            ...config.manifest?.dev?.config,
+                            js: [`https://localhost:${port}/config.js`],
+                            css: [`https://localhost:${port}/config.css`],
+                        },
+                        desktop: {
+                            ...config.manifest?.dev?.desktop,
+                            js: [`https://localhost:${port}/desktop.js`],
+                            css: [`https://localhost:${port}/desktop.css`],
+                        },
+                        mobile: {
+                            ...config.manifest?.dev?.mobile,
+                            js: [`https://localhost:${port}/desktop.js`],
+                            css: [`https://localhost:${port}/desktop.css`],
+                        },
+                    },
+                },
+            },
+        });
+        console.log(`📝 manifest.json generated`);
+        const contentsListener = async () => {
+            try {
+                await copyPluginContents();
+                console.log('📁 contents updated');
+            }
+            catch (error) {
+                console.error('📁 contents update failed');
+            }
+        };
+        await contentsListener();
+        const watcher = chokider.watch(['src/contents/**/*'], {
+            ignored: /node_modules/,
+            persistent: true,
+        });
+        watcher.on('change', contentsListener);
+        watcher.on('add', contentsListener);
+        watcher.on('unlink', contentsListener);
+        await outputContentsZip(manifest);
+        const buffer = await getContentsZipBuffer();
+        const pluginPrivateKey = await fs.readFile(path.join(WORKSPACE_DIRECTORY, 'private.ppk'), 'utf8');
+        const output = await packer(buffer, pluginPrivateKey);
+        const zipFileName = `plugin${getZipFileNameSuffix('dev')}.zip`;
+        await fs.writeFile(path.join(WORKSPACE_DIRECTORY, zipFileName), output.plugin);
+        uploadZip('dev').then(({ stdout, stderr }) => {
+            console.log(stdout);
+            console.error(stderr);
+        });
+        const app = express();
+        app.use(express.static(DEVELOPMENT_DIRECTORY));
+        const privateKeyPath = path.join(WORKSPACE_DIRECTORY, 'localhost-key.pem');
+        const certificatePath = path.join(WORKSPACE_DIRECTORY, 'localhost-cert.pem');
+        if (!fs.existsSync(privateKeyPath) || !fs.existsSync(certificatePath)) {
+            await generateCert(WORKSPACE_DIRECTORY);
+            console.log('🔑 Certificate generated');
+        }
+        const privateKey = fs.readFileSync(privateKeyPath);
+        const certificate = fs.readFileSync(certificatePath);
+        const server = createServer({ key: privateKey, cert: certificate }, app);
+        const res = server.listen(port);
+        buildWithEsbuild({
+            entryPoints: ['desktop', 'config'].map((dir) => ({
+                in: path.join('src', dir, 'index.ts'),
+                out: dir,
+            })),
+            outdir: DEVELOPMENT_DIRECTORY,
+        });
+        res.on('error', (error) => {
+            console.error(error);
+        });
+        res.on('listening', () => {
+            console.log(`🚀 Server started! https://localhost:${port}`);
+        });
+    }
+    catch (error) {
+        throw error;
+    }
+    finally {
+        console.groupEnd();
+    }
+}

package/dist/commands/genkey/index.js

@@ -0,0 +1,25 @@
+import { program } from 'commander';
+import { generateCert } from '../../lib/cert.js';
+import { WORKSPACE_DIRECTORY } from '../../lib/constants.js';
+export default function command() {
+    program
+        .command('genkey')
+        .description('Generate SSL key for localhost. (Require mkcert)')
+        .option('-o, --output <output>', 'Output directory.', WORKSPACE_DIRECTORY)
+        .action(action);
+}
+export async function action(options) {
+    const { output } = options;
+    console.group('🔑 Generate SSL key for localhost');
+    try {
+        const { stdout } = await generateCert(output);
+        console.log(stdout);
+        console.log('key generation success.');
+    }
+    catch (error) {
+        throw error;
+    }
+    finally {
+        console.groupEnd();
+    }
+}

package/dist/commands/init/index.js

@@ -0,0 +1,47 @@
+import { program } from 'commander';
+import fs from 'fs-extra';
+import path from 'path';
+import packer from '@kintone/plugin-packer';
+import { outputManifest } from '../../lib/plugin-manifest.js';
+import { WORKSPACE_DIRECTORY } from '../../lib/constants.js';
+import { getContentsZipBuffer, outputContentsZip } from '../../lib/zip.js';
+import { copyPluginContents } from '../../lib/plugin-contents.js';
+export default function command() {
+    program
+        .command('init')
+        .description('generate private.ppk and kitting config')
+        .action(action);
+}
+export async function action() {
+    console.group('🚀 Executing plugin initialization setup');
+    try {
+        const manifest = await outputManifest('dev');
+        console.log('📝 manifest.json generated');
+        await copyPluginContents();
+        console.log('📁 contents copied');
+        let privateKey;
+        const keyPath = path.join(WORKSPACE_DIRECTORY, 'private.ppk');
+        if (fs.existsSync(keyPath)) {
+            privateKey = await fs.readFile(keyPath, 'utf8');
+        }
+        await outputContentsZip(manifest);
+        const buffer = await getContentsZipBuffer();
+        const output = await packer(buffer, privateKey);
+        if (!privateKey) {
+            await fs.writeFile(path.join(WORKSPACE_DIRECTORY, 'private.ppk'), output.privateKey);
+            console.log('🔐 private.ppk generated');
+        }
+        else {
+            console.log('🔐 private.ppk already exists. The existing private.ppk will be used.');
+        }
+        await fs.writeFile(path.join(WORKSPACE_DIRECTORY, 'plugin.zip'), output.plugin);
+        console.log('📦 plugin.zip generated');
+        console.log('✨ Plugin initialization setup completed! zip file path is ./.plugin/plugin.zip');
+    }
+    catch (error) {
+        throw error;
+    }
+    finally {
+        console.groupEnd();
+    }
+}

package/dist/commands/manifest/index.js

@@ -0,0 +1,28 @@
+import { program } from 'commander';
+import { outputManifest } from '../../lib/plugin-manifest.js';
+import { copyPluginContents } from '../../lib/plugin-contents.js';
+export default function command() {
+    program
+        .command('manifest')
+        .option('-e, --env <env>', 'create manifest', 'prod')
+        .action(action);
+}
+async function action(options) {
+    console.group('🚀 Executing manifest generation');
+    try {
+        const { env } = options;
+        if (env !== 'prod' && env !== 'dev' && env !== 'standalone') {
+            throw new Error('Invalid environment');
+        }
+        await copyPluginContents();
+        console.log('📁 contents copied');
+        await outputManifest(env);
+        console.log(`📝 manifest.json generated (${env})`);
+    }
+    catch (error) {
+        throw error;
+    }
+    finally {
+        console.groupEnd();
+    }
+}

package/dist/commands/test/index.js

@@ -0,0 +1,16 @@
+import { program } from 'commander';
+import fs from 'fs-extra';
+import { esmImport } from '../../lib/import.js';
+export default function command() {
+    program.command('test').description('test').action(action);
+}
+export async function action() {
+    console.group('package.json');
+    const packageJson = fs.readJSONSync('package.json');
+    console.log('package.json detected');
+    console.groupEnd();
+    console.group('Config');
+    const config = await esmImport('plugin.config.mjs');
+    console.log('plugin.config.mjs detected', config);
+    console.groupEnd();
+}

package/dist/commands/upload/index.js

@@ -0,0 +1,30 @@
+import { program } from 'commander';
+import { config } from 'dotenv';
+import { isEnv, uploadZip } from '../../lib/utils.js';
+export default function command() {
+    program
+        .command('upload')
+        .description('upload plugin.zip to your kintone')
+        .option('-e, --env <env>', 'plugin environment (dev, prod, standalone)', 'prod')
+        .action(action);
+}
+async function action(options) {
+    console.group('🚀 Uploading plugin.zip to your kintone');
+    try {
+        config();
+        const { env } = options;
+        if (!isEnv(env)) {
+            throw new Error('Invalid environment');
+        }
+        const { stderr } = await uploadZip(env);
+        if (stderr) {
+            console.error(JSON.stringify(stderr, null, 2));
+        }
+    }
+    catch (error) {
+        throw error;
+    }
+    finally {
+        console.groupEnd();
+    }
+}

package/dist/commands/vite-dev/index.js

@@ -0,0 +1,48 @@
+import { program } from 'commander';
+import { createServer, build } from 'vite';
+import { importPluginConfig } from '../../lib/import.js';
+import { getViteConfig } from '../../lib/vite.js';
+import chokidar from 'chokidar';
+import { DEVELOPMENT_DIRECTORY } from '../../lib/constants.js';
+export default function command() {
+    program
+        .command('dev')
+        .description('Start development server.')
+        .action(action);
+}
+export async function action() {
+    console.group('🚀 Start development server');
+    try {
+        const config = await importPluginConfig();
+        const watcher = chokidar.watch(['src/**/*.{ts,js,jsx,tsx}'], {
+            ignored: /node_modules/,
+            persistent: true,
+        });
+        const viteConfig = getViteConfig(config);
+        const listener = async () => build({
+            ...viteConfig,
+            mode: 'development',
+            build: {
+                ...viteConfig.build,
+                sourcemap: 'inline',
+                chunkSizeWarningLimit: 8192,
+            },
+        });
+        await listener();
+        watcher.on('change', listener);
+        watcher.on('add', listener);
+        watcher.on('unlink', listener);
+        const server = await createServer({
+            ...viteConfig,
+            root: DEVELOPMENT_DIRECTORY,
+        });
+        await server.listen();
+        server.printUrls();
+    }
+    catch (error) {
+        throw error;
+    }
+    finally {
+        console.groupEnd();
+    }
+}

package/dist/commands/zip/index.js

@@ -0,0 +1,43 @@
+import { program } from 'commander';
+import { outputManifest } from '../../lib/plugin-manifest.js';
+import fs from 'fs-extra';
+import path from 'path';
+import { WORKSPACE_DIRECTORY } from '../../lib/constants.js';
+import packer from '@kintone/plugin-packer';
+import { getContentsZipBuffer, getZipFileNameSuffix, outputContentsZip, } from '../../lib/zip.js';
+import { copyPluginContents } from '../../lib/plugin-contents.js';
+import { isEnv } from '../../lib/utils.js';
+export default function command() {
+    program
+        .command('zip')
+        .description('generate plugin zip')
+        .option('-e, --env <env>', 'plugin environment (dev, prod, standalone)', 'prod')
+        .action(action);
+}
+async function action(options) {
+    console.group('🚀 Executing plugin zip generation');
+    try {
+        const { env } = options;
+        if (!isEnv(env)) {
+            throw new Error('Invalid environment');
+        }
+        await copyPluginContents();
+        console.log('📁 contents copied');
+        const manifest = await outputManifest(env);
+        console.log(`📝 manifest.json generated (${env})`);
+        await outputContentsZip(manifest);
+        const buffer = await getContentsZipBuffer();
+        const privateKey = await fs.readFile(path.join(WORKSPACE_DIRECTORY, 'private.ppk'), 'utf8');
+        const output = await packer(buffer, privateKey);
+        const zipFileName = `plugin${getZipFileNameSuffix(env)}.zip`;
+        await fs.writeFile(path.join(WORKSPACE_DIRECTORY, zipFileName), output.plugin);
+        console.log('📦 plugin.zip generated');
+        console.log(`✨ Plugin zip generation completed! zip file path is ./.plugin/${zipFileName}`);
+    }
+    catch (error) {
+        throw error;
+    }
+    finally {
+        console.groupEnd();
+    }
+}

package/dist/index.js

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+import { program } from 'commander';
+import build from './commands/build/index.js';
+import dev from './commands/dev/index.js';
+import genkey from './commands/genkey/index.js';
+import init from './commands/init/index.js';
+import manifest from './commands/manifest/index.js';
+import test from './commands/test/index.js';
+import upload from './commands/upload/index.js';
+import zip from './commands/zip/index.js';
+program.name('k2').version('0.1.0').description('');
+build();
+dev();
+genkey();
+init();
+manifest();
+test();
+upload();
+zip();
+program.parse(process.argv);

package/dist/lib/cert.js

@@ -0,0 +1,15 @@
+import { exec } from './exec.js';
+import fs from 'fs-extra';
+import path from 'path';
+export const generateCert = async (outDir) => {
+    const { stdout } = await exec(`mkcert localhost`);
+    [
+        { input: 'localhost.pem', output: 'localhost-cert.pem' },
+        { input: 'localhost-key.pem', output: 'localhost-key.pem' },
+    ].forEach(({ input, output }) => {
+        fs.moveSync(`./${input}`, path.join(outDir, output), {
+            overwrite: true,
+        });
+    });
+    return { stdout };
+};

package/dist/lib/constants.js

@@ -0,0 +1,5 @@
+import path from 'path';
+export const WORKSPACE_DIRECTORY = '.plugin';
+export const CONTENTS_DIRECTORY = path.join(WORKSPACE_DIRECTORY, 'contents');
+export const DEVELOPMENT_DIRECTORY = path.join(WORKSPACE_DIRECTORY, 'dev');
+export const DEFAULT_PORT = 32767;

package/dist/lib/esbuild.js

@@ -0,0 +1,60 @@
+import chalk from 'chalk';
+import esbuild from 'esbuild';
+import { compile } from 'sass';
+import { resolve } from 'path';
+export const getSassPlugin = () => {
+    const pluginName = 'esbuild-plugin-sass';
+    return {
+        name: pluginName,
+        setup(build) {
+            build.onResolve({ filter: /\.s[ac]ss$/ }, (args) => ({
+                path: resolve(args.resolveDir, args.path),
+                namespace: pluginName,
+            }));
+            build.onLoad({ filter: /.*/, namespace: pluginName }, async (args) => {
+                try {
+                    const result = compile(args.path);
+                    return {
+                        contents: result.css,
+                        loader: 'css',
+                        watchFiles: [args.path],
+                    };
+                }
+                catch (error) {
+                    return {
+                        pluginName,
+                        errors: [
+                            {
+                                text: error instanceof Error
+                                    ? error.message
+                                    : JSON.stringify(error),
+                                pluginName,
+                                location: { file: args.path, namespace: pluginName },
+                            },
+                        ],
+                    };
+                }
+            });
+        },
+    };
+};
+export const buildWithEsbuild = async (params) => {
+    const { entryPoints, outdir } = params;
+    const context = await esbuild.context({
+        entryPoints,
+        bundle: true,
+        sourcemap: 'inline',
+        platform: 'browser',
+        outdir,
+        plugins: [
+            {
+                name: 'on-end',
+                setup: ({ onEnd }) => onEnd(() => console.log(chalk.hex('#d1d5db')(`${new Date().toLocaleTimeString()} `) +
+                    chalk.cyan(`[content] `) +
+                    `Compiled successfully.`)),
+            },
+            getSassPlugin(),
+        ],
+    });
+    context.watch();
+};

package/dist/lib/exec.js

@@ -0,0 +1,3 @@
+import { exec as defaultExec } from 'child_process';
+import { promisify } from 'util';
+export const exec = promisify(defaultExec);

package/dist/lib/import.js

@@ -0,0 +1,12 @@
+import { pathToFileURL } from 'url';
+export const esmImport = (path) => {
+    if (process.platform === 'win32') {
+        return import(pathToFileURL(path).toString());
+    }
+    else {
+        return import(path);
+    }
+};
+export const importPluginConfig = async () => {
+    return (await esmImport('plugin.config.mjs')).default;
+};

package/dist/lib/plugin-contents.js

@@ -0,0 +1,19 @@
+import fs from 'fs-extra';
+import path from 'path';
+import { CONTENTS_DIRECTORY } from './constants.js';
+import htmlMinifier from 'html-minifier';
+export const copyPluginContents = async () => {
+    await fs.copySync(path.join('src', 'contents'), path.join(CONTENTS_DIRECTORY), { overwrite: true });
+    const html = await fs.readFile(path.join(CONTENTS_DIRECTORY, 'config.html'), 'utf8');
+    const minified = htmlMinifier.minify(html, {
+        minifyCSS: true,
+        collapseWhitespace: true,
+        removeComments: true,
+        removeOptionalTags: true,
+        removeRedundantAttributes: true,
+        removeScriptTypeAttributes: true,
+        removeTagWhitespace: true,
+        useShortDoctype: true,
+    });
+    await fs.writeFile(path.join(CONTENTS_DIRECTORY, 'config.html'), minified);
+};

package/dist/lib/plugin-manifest.js

@@ -0,0 +1,25 @@
+import { CONTENTS_DIRECTORY } from './constants.js';
+import { importPluginConfig } from './import.js';
+import fs from 'fs-extra';
+import path from 'path';
+function merge(src, dst) {
+    return Object.entries(src).reduce((acc, [key, value]) => {
+        if (!dst[key]) {
+            return { ...acc, [key]: value };
+        }
+        if (typeof dst[key] === 'string') {
+            return { ...acc, [key]: dst[key] };
+        }
+        if (Array.isArray(value) && Array.isArray(dst[key])) {
+            return { ...acc, [key]: [...value, ...dst[key]] };
+        }
+        return { ...acc, [key]: merge(src[key], dst[key]) };
+    }, {});
+}
+export const outputManifest = async (env, options) => {
+    const config = options?.config || (await importPluginConfig());
+    const merged = merge(config.manifest.base, config.manifest[env] || {});
+    await fs.mkdirs(CONTENTS_DIRECTORY);
+    await fs.writeJson(path.join(CONTENTS_DIRECTORY, 'manifest.json'), merged);
+    return merged;
+};

package/dist/lib/utils.js

@@ -0,0 +1,25 @@
+import { WORKSPACE_DIRECTORY } from './constants.js';
+import { exec } from './exec.js';
+import { getZipFileNameSuffix } from './zip.js';
+import { config } from 'dotenv';
+export const isEnv = (env) => {
+    return ['prod', 'dev', 'standalone'].includes(env);
+};
+export const uploadZip = async (env) => {
+    config();
+    const { KINTONE_BASE_URL, KINTONE_USERNAME, KINTONE_PASSWORD, KINTONE_BASIC_AUTH_USERNAME = '', KINTONE_BASIC_AUTH_PASSWORD = '', } = process.env;
+    if (!KINTONE_BASE_URL || !KINTONE_USERNAME || !KINTONE_PASSWORD) {
+        throw new Error(`.envの設定が不十分です。以下のパラメータは必須です
+KINTONE_BASE_URL
+KINTONE_USERNAME
+KINTONE_PASSWORD
+    `);
+    }
+    const zipFileName = `plugin${getZipFileNameSuffix(env)}.zip`;
+    let command = `kintone-plugin-uploader ${WORKSPACE_DIRECTORY}/${zipFileName} --base-url ${KINTONE_BASE_URL} --username ${KINTONE_USERNAME} --password ${KINTONE_PASSWORD}`;
+    if (KINTONE_BASIC_AUTH_USERNAME && KINTONE_BASIC_AUTH_PASSWORD) {
+        command += ` --basic-auth-username ${KINTONE_BASIC_AUTH_USERNAME} --basic-auth-password ${KINTONE_BASIC_AUTH_PASSWORD}`;
+    }
+    command += ' --watch --waiting-dialog-ms 3000';
+    return exec(command);
+};

package/dist/lib/vite.js

@@ -0,0 +1,41 @@
+import path from 'path';
+import fs from 'fs-extra';
+import { DEFAULT_PORT, DEVELOPMENT_DIRECTORY, WORKSPACE_DIRECTORY, } from './constants.js';
+import tsconfigPaths from 'vite-tsconfig-paths';
+export const getViteConfig = (config) => {
+    return {
+        configFile: false,
+        build: {
+            outDir: DEVELOPMENT_DIRECTORY,
+            emptyOutDir: true,
+            rollupOptions: {
+                input: {
+                    config: path.join('src', 'config', 'index.ts'),
+                    desktop: path.join('src', 'desktop', 'index.ts'),
+                },
+                output: {
+                    entryFileNames: '[name].js',
+                    chunkFileNames: '[name].js',
+                    assetFileNames: '[name].[ext]',
+                },
+                onwarn: (warning, warn) => {
+                    if (['MODULE_LEVEL_DIRECTIVE'].includes(warning.code ?? '')) {
+                        return;
+                    }
+                    warn(warning);
+                },
+            },
+        },
+        plugins: [tsconfigPaths()],
+        server: {
+            port: config.server?.port ?? DEFAULT_PORT,
+            https: {
+                key: fs.readFileSync(path.join(WORKSPACE_DIRECTORY, 'localhost-key.pem')),
+                cert: fs.readFileSync(path.join(WORKSPACE_DIRECTORY, 'localhost-cert.pem')),
+            },
+        },
+        resolve: {
+            alias: { '@': path.resolve('src') },
+        },
+    };
+};

package/dist/lib/zip.js

@@ -0,0 +1,46 @@
+import archiver from 'archiver';
+import fs from 'fs-extra';
+import path from 'path';
+import { CONTENTS_DIRECTORY, WORKSPACE_DIRECTORY } from './constants.js';
+export const outputContentsZip = async (manifest) => {
+    const archive = archiver('zip', { zlib: { level: 9 } });
+    const outputZipPath = path.join(WORKSPACE_DIRECTORY, 'contents.zip');
+    const outputZipStream = fs.createWriteStream(outputZipPath);
+    const filterLocalContent = (file) => {
+        return !/^https?:\/\//.test(file);
+    };
+    archive.file(path.join(CONTENTS_DIRECTORY, 'manifest.json'), {
+        name: 'manifest.json',
+    });
+    if (!manifest.config) {
+        throw new Error('manifest.config is required');
+    }
+    const targetFiles = [
+        ...new Set([
+            manifest.icon,
+            manifest.config.html,
+            ...(manifest.desktop?.js || []).filter(filterLocalContent),
+            ...(manifest.desktop?.css || []).filter(filterLocalContent),
+            ...(manifest.mobile?.js || []).filter(filterLocalContent),
+            ...(manifest.mobile?.css || []).filter(filterLocalContent),
+            ...(manifest.config.js || []).filter(filterLocalContent),
+            ...(manifest.config.css || []).filter(filterLocalContent),
+        ]),
+    ];
+    targetFiles.forEach((file) => {
+        const filePath = path.join(CONTENTS_DIRECTORY, file);
+        if (!fs.existsSync(filePath)) {
+            throw new Error(`${filePath} does not exist`);
+        }
+        archive.file(filePath, { name: file });
+    });
+    archive.pipe(outputZipStream);
+    await archive.finalize();
+};
+export const getContentsZipBuffer = async () => {
+    const outputZipPath = path.join(WORKSPACE_DIRECTORY, 'contents.zip');
+    return fs.readFile(outputZipPath);
+};
+export const getZipFileNameSuffix = (env) => {
+    return env === 'prod' ? '' : `-${env}`;
+};

package/dist/plugin.js

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+import { program } from 'commander';
+import build from './commands/build/index.js';
+import dev from './commands/dev/index.js';
+import genkey from './commands/genkey/index.js';
+import init from './commands/init/index.js';
+import manifest from './commands/manifest/index.js';
+import test from './commands/test/index.js';
+import upload from './commands/upload/index.js';
+import zip from './commands/zip/index.js';
+program.name('plugin').version('0.0.1').description('');
+build();
+dev();
+genkey();
+init();
+manifest();
+test();
+upload();
+zip();
+program.parse(process.argv);

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@konomi-app/k2",
+  "version": "0.1.0",
+  "description": "kintone sdk",
+  "main": "./dist/index.js",
+  "type": "module",
+  "bin": {
+    "k2": "./dist/index.js",
+    "plugin": "./dist/plugin.js"
+  },
+  "files": [
+    "bin",
+    "dist",
+    "types",
+    "types.d.ts"
+  ],
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "rmdir /s /q dist & tsc",
+    "dev": "tsc -w",
+    "watch": "tsc -w"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@kintone/plugin-packer": "^8",
+    "@kintone/plugin-uploader": "^9",
+    "archiver": "^7",
+    "chalk": "^5",
+    "chokidar": "^3",
+    "commander": "^12",
+    "dotenv": "^16",
+    "esbuild": "^0.21",
+    "express": "^4",
+    "fs-extra": "^11",
+    "html-minifier": "^4",
+    "sass": "^1",
+    "vite": "^5",
+    "vite-tsconfig-paths": "^4"
+  },
+  "devDependencies": {
+    "@types/archiver": "*",
+    "@types/express": "^4.17.21",
+    "@types/fs-extra": "*",
+    "@types/html-minifier": "^4",
+    "typescript": "*"
+  }
+}

package/types/index.d.ts

@@ -0,0 +1 @@
+/// <reference path="plugin.d.ts" />

package/types/plugin.d.ts

@@ -0,0 +1,86 @@
+type Locales = {
+  /** 日本語 */
+  ja: string;
+  /** 英語 */
+  en: string;
+  /** 簡体字中国語 */
+  zh: string;
+};
+
+type Resources = {
+  /**
+   * プラグインのJavaScriptファイル
+   *
+   * URLの配列
+   */
+  js: string[];
+  /**
+   * プラグインのCSSファイル
+   *
+   * URLの配列
+   */
+  css: string[];
+};
+
+declare namespace Plugin {
+  namespace Meta {
+    type Env = 'dev' | 'prod' | 'standalone';
+
+    type Manifest = {
+      type: 'APP';
+      manifest_version: 1;
+      version: number | string;
+      /**
+       * プラグインの名前
+       *
+       * インストール時、プラグイン一覧画面で表示されます
+       */
+      name: Locales;
+      /**
+       * プラグインの説明
+       *
+       * インストール時、プラグイン一覧画面で表示されます
+       */
+      description?: Locales;
+      icon: string;
+      homepage_url?: Partial<Locales>;
+      desktop?: Partial<Resources>;
+      mobile?: Partial<Resources>;
+      config?: Partial<Resources> & {
+        /** ファイルの種類 (js/css/html) をキーとする設定画面用カスタマイズファイルと設定情報 */
+        html?: string;
+        /**
+         * 設定画面で設定必須とするパラメータの配列
+         *
+         * ASCIIで1文字以上64文字以下
+         */
+        required_params?: string[];
+      };
+    };
+
+    /**
+     * 公開しているプラグインテンプレートで使用する設定ファイル
+     *
+     * @see {@link https://github.com/local-bias/kintone-plugin-template | kintone-plugin-template}
+     */
+    type Config = {
+      id: string;
+      version?: 1;
+      manifest: {
+        base: Manifest;
+        dev?: Partial<Manifest>;
+        prod?: Partial<Manifest>;
+        standalone?: Partial<Manifest>;
+      };
+      pluginReleasePageUrl?: string;
+      inquiriesPageUrl?: string;
+      promotionPageUrl?: string;
+      bannerPageUrl?: string;
+      config_params?: Record<string, any>;
+      server?: {
+        /** 0から65535までのポート番号 */
+        port?: number;
+      };
+    };
+  }
+}

package/types.d.ts

@@ -0,0 +1 @@
+/// <reference path="types/index.d.ts" />