@konomi-app/k2 1.3.0 → 1.4.0

package/README.md

@@ -1,3 +1,67 @@
 # k2 - 🍳 kintone kitchen 🍳
 
-kintone sdk for node.js
+kintone SDK for Node.js
+
+## 🥦 Installation
+
+```bash
+npm install @konomi-app/k2
+```
+
+## 🥚 Requirements
+
+### mkcert
+
+K2 uses `mkcert` to generate a self-signed certificate for local development. You can install it by following the instructions [here](https://github.com/FiloSottile/mkcert).
+
+```bash
+# Windows
+choco install mkcert
+
+# macOS
+brew install mkcert
+```
+
+If you are using Windows, you may need to install `Chocolatey` first. You can find the instructions [here](https://chocolatey.org/install).
+
+## 🥕 Usage (kintone Customization)
+
+### 1. Initialize
+
+```bash
+npx k2 init
+```
+
+This command will create a `.k2` directory in your project root. This directory contains the configuration files for K2.
+
+### 2. Local Development
+
+```bash
+npx k2 dev
+```
+
+By executing the above command, a local server will be launched on the port number specified in the configuration file. By setting the URL of the local server to the app implementing kintone customization, you can develop in a local environment.
+
+### 3. Build
+
+```bash
+npx k2 build
+```
+
+## 🥬 Usage (kintone Plugin)
+
+### 1. Initialize
+
+```bash
+npx plugin init
+```
+
+This command will create a `.plugin` directory in your project root. This directory contains the configuration files for the plugin.
+
+### 2. Local Development
+
+```bash
+npx plugin dev
+```
+
+By executing the above command, a local server will be launched on the port number specified in the configuration file. By setting the URL of the local server to the app implementing kintone plugin, you can develop in a local environment.

package/dist/commands/build-esbuild.js

@@ -38,7 +38,7 @@ export async function action(options) {
                 outdir,
                 sourcemap: false,
                 minify: true,
-                target: 'es2020',
+                legalComments: 'none',
             }),
             buildTailwind(fullConfig),
         ]);

package/dist/commands/plugin-dev/upload.js

@@ -4,7 +4,7 @@ import { getContentsZipBuffer, getZipFileNameSuffix, outputContentsZip } from '.
 import fs from 'fs-extra';
 import path from 'path';
 import { PLUGIN_WORKSPACE_DIRECTORY } from '../../lib/constants.js';
-import { uploadZip } from '../../lib/utils.js';
+import { apiUploadZip } from '../../lib/utils.js';
 import chokider from 'chokidar';
 import chalk from 'chalk';
 export const watchContentsAndUploadZip = async (params) => {
@@ -31,13 +31,10 @@ export const watchContentsAndUploadZip = async (params) => {
             const output = await packer(buffer, pluginPrivateKey);
             const zipFileName = `plugin${getZipFileNameSuffix('dev')}.zip`;
             await fs.writeFile(path.join(PLUGIN_WORKSPACE_DIRECTORY, zipFileName), output.plugin);
+            const { method } = await apiUploadZip({ env: 'dev', pluginId: output.id });
             console.log(chalk.hex('#e5e7eb')(`${new Date().toLocaleTimeString()} `) +
                 chalk.cyan(`[upload] `) +
-                `start uploading`);
-            await uploadZip('dev');
-            console.log(chalk.hex('#e5e7eb')(`${new Date().toLocaleTimeString()} `) +
-                chalk.cyan(`[upload] `) +
-                `done`);
+                `uploaded ${method === 'POST' ? '(new)' : '(update)'}`);
         }
         catch (error) {
             console.log(chalk.hex('#e5e7eb')(`${new Date().toLocaleTimeString()} `) +

package/dist/commands/plugin-esbuild.js

@@ -5,6 +5,7 @@ import { PLUGIN_CONTENTS_DIRECTORY } from '../lib/constants.js';
 import { importPluginConfig } from '../lib/import.js';
 import { getTailwindConfig, outputCss } from '../lib/tailwind.js';
 import { buildWithEsbuild } from '../lib/esbuild.js';
+import { lint } from '../lib/lint.js';
 export default function command() {
     program
         .command('esbuild')
@@ -15,13 +16,13 @@ export async function action() {
     console.group('🍳 Build the project for production');
     try {
         const config = await importPluginConfig();
+        if (config?.lint?.build) {
+            await lint();
+            console.log('✨ Lint success.');
+        }
         if (!fs.existsSync(PLUGIN_CONTENTS_DIRECTORY)) {
             await fs.mkdir(PLUGIN_CONTENTS_DIRECTORY, { recursive: true });
         }
-        const entries = {
-            desktop: path.join('src', 'desktop', 'index.ts'),
-            config: path.join('src', 'config', 'index.ts'),
-        };
         if (config.tailwind?.css && config.tailwind?.config) {
             const tailwindConfig = await getTailwindConfig(config.tailwind);
             const inputFile = path.resolve(config.tailwind.css);
@@ -30,12 +31,14 @@ export async function action() {
                 inputPath,
                 outputPath: path.join(PLUGIN_CONTENTS_DIRECTORY, 'config.css'),
                 config: tailwindConfig.config,
+                minify: true,
             });
             console.log('✨ Built config.css');
             await outputCss({
                 inputPath,
                 outputPath: path.join(PLUGIN_CONTENTS_DIRECTORY, 'desktop.css'),
-                config: tailwindConfig.config,
+                config: tailwindConfig.desktop,
+                minify: true,
             });
             console.log('✨ Built desktop.css');
         }
@@ -48,6 +51,7 @@ export async function action() {
             outdir: PLUGIN_CONTENTS_DIRECTORY,
             minify: true,
             sourcemap: false,
+            legalComments: 'none',
         });
         console.log('✨ Built desktop.js and config.js');
         console.log('✨ Build success.');

package/dist/index.js

@@ -7,7 +7,7 @@ import viteDev from './commands/dev-vite.js';
 import genkey from './commands/genkey.js';
 import esbuildBuild from './commands/build-esbuild.js';
 import lint from './commands/lint.js';
-program.name('k2').version('0.9.0').description('k2 - 🍳 kintone kitchen 🍳');
+program.name('k2').version('1.4.0').description('k2 - 🍳 kintone kitchen 🍳');
 build();
 viteBuild();
 esbuildBuild();

package/dist/lib/kintone-api-client.js

@@ -0,0 +1,94 @@
+import { config } from 'dotenv';
+export class KintoneApiClient {
+    #baseUrl;
+    #authHeader;
+    constructor() {
+        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 authHeader = {
+            'X-Cybozu-Authorization': Buffer.from(`${KINTONE_USERNAME}:${KINTONE_PASSWORD}`).toString('base64'),
+            ...(KINTONE_BASIC_AUTH_USERNAME &&
+                KINTONE_BASIC_AUTH_PASSWORD && {
+                Authorization: `Basic ${Buffer.from(`${KINTONE_BASIC_AUTH_USERNAME}:${KINTONE_BASIC_AUTH_PASSWORD}`).toString('base64')}`,
+            }),
+        };
+        this.#baseUrl = KINTONE_BASE_URL;
+        this.#authHeader = authHeader;
+    }
+    getEndpointUrl(path) {
+        return `${this.#baseUrl}${path}`;
+    }
+    async upload(params) {
+        const { blob, fileName } = params;
+        const form = new FormData();
+        form.append('file', blob, fileName);
+        const uploadResult = await fetch(this.getEndpointUrl('/k/v1/file.json'), {
+            method: 'POST',
+            headers: this.#authHeader,
+            body: form,
+        });
+        const { fileKey } = await uploadResult.json();
+        return fileKey;
+    }
+    async getPlugins(params = {}) {
+        const url = new URL(this.getEndpointUrl('/k/v1/plugins.json'));
+        if (params.offset) {
+            url.searchParams.set('offset', String(params.offset));
+        }
+        if (params.limit) {
+            url.searchParams.set('limit', String(params.limit));
+        }
+        const pluginResponse = await fetch(url.toString(), {
+            headers: this.#authHeader,
+        });
+        return pluginResponse.json();
+    }
+    async getAllPlugins() {
+        const plugins = [];
+        let offset = 0;
+        let limit = 100;
+        let hasMore = true;
+        while (hasMore) {
+            const { plugins: currentPlugins } = await this.getPlugins({ offset, limit });
+            plugins.push(...currentPlugins);
+            if (currentPlugins.length < limit) {
+                hasMore = false;
+            }
+            else {
+                offset += limit;
+            }
+        }
+        return plugins;
+    }
+    async addPlugin(params) {
+        const { fileKey } = params;
+        const pluginResponse = await fetch(this.getEndpointUrl('/k/v1/plugin.json'), {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                ...this.#authHeader,
+            },
+            body: JSON.stringify({
+                fileKey,
+            }),
+        });
+        return pluginResponse.json();
+    }
+    async updatePlugin(params) {
+        const pluginResponse = await fetch(this.getEndpointUrl('/k/v1/plugin.json'), {
+            method: 'PUT',
+            headers: {
+                'Content-Type': 'application/json',
+                ...this.#authHeader,
+            },
+            body: JSON.stringify(params),
+        });
+        return pluginResponse.json();
+    }
+}

package/dist/lib/utils.js

@@ -1,10 +1,41 @@
 import { PLUGIN_WORKSPACE_DIRECTORY } from './constants.js';
 import { exec } from './exec.js';
+import { KintoneApiClient } from './kintone-api-client.js';
 import { getZipFileNameSuffix } from './zip.js';
 import { config } from 'dotenv';
+import fs from 'fs-extra';
+import path from 'path';
 export const isEnv = (env) => {
     return ['prod', 'dev', 'standalone'].includes(env);
 };
+/**
+ * プラグインを追加・更新するAPIを利用してプラグインをアップロードします
+ */
+export const apiUploadZip = async (params) => {
+    const { env, pluginId } = params;
+    const kc = new KintoneApiClient();
+    const zipFileName = `plugin${getZipFileNameSuffix(env)}.zip`;
+    const zipFile = new Blob([await fs.readFile(path.join(PLUGIN_WORKSPACE_DIRECTORY, zipFileName))]);
+    const fileKey = await kc.upload({ blob: zipFile, fileName: zipFileName });
+    const plugins = await kc.getAllPlugins();
+    const plugin = plugins.find((p) => p.id === pluginId);
+    if (plugin) {
+        const json = await kc.updatePlugin({ id: pluginId, fileKey });
+        if ('errors' in json && json.errors) {
+            console.error((json.errors.id?.messages ?? []).map((m) => `Error: ${m}`).join('\n'));
+        }
+        return { method: 'PUT' };
+    }
+    const result = await kc.addPlugin({ fileKey });
+    if ('code' in result) {
+        console.error(`Error: ${result.message}`);
+    }
+    return { method: 'POST' };
+};
+/**
+ * @kintone/plugin-uploaderを利用してプラグインをアップロードします
+ * APIを使用した方が高速ですが、2024年11月までは設定により無効になる可能性があるため、暫定的に残しています
+ */
 export const uploadZip = async (env) => {
     config();
     const { KINTONE_BASE_URL, KINTONE_USERNAME, KINTONE_PASSWORD, KINTONE_BASIC_AUTH_USERNAME = '', KINTONE_BASIC_AUTH_PASSWORD = '', } = process.env;
@@ -12,8 +43,7 @@ export const uploadZip = async (env) => {
         throw new Error(`.envの設定が不十分です。以下のパラメータは必須です
 KINTONE_BASE_URL
 KINTONE_USERNAME
-KINTONE_PASSWORD
-    `);
+KINTONE_PASSWORD`);
     }
     const zipFileName = `plugin${getZipFileNameSuffix(env)}.zip`;
     let command = `kintone-plugin-uploader ${PLUGIN_WORKSPACE_DIRECTORY}/${zipFileName} --base-url ${KINTONE_BASE_URL} --username ${KINTONE_USERNAME} --password ${KINTONE_PASSWORD}`;

package/dist/lib/zip.js

@@ -5,8 +5,22 @@ import invariant from 'tiny-invariant';
 import { PLUGIN_CONTENTS_DIRECTORY, PLUGIN_WORKSPACE_DIRECTORY } from './constants.js';
 export const outputContentsZip = async (manifest) => {
     const archive = archiver('zip', { zlib: { level: 9 } });
+    archive.on('warning', (error) => {
+        if (error.code === 'ENOENT') {
+            console.warn(error);
+        }
+        else {
+            throw error;
+        }
+    });
     const outputZipPath = path.join(PLUGIN_WORKSPACE_DIRECTORY, 'contents.zip');
     const outputZipStream = fs.createWriteStream(outputZipPath);
+    outputZipStream.on('close', () => {
+        console.log(`📦 ${archive.pointer()} total bytes`);
+    });
+    outputZipStream.on('end', function () {
+        console.log('📦 Data has been drained');
+    });
     const filterLocalContent = (file) => {
         return !/^https?:\/\//.test(file);
     };
@@ -24,17 +38,22 @@ export const outputContentsZip = async (manifest) => {
             ...(manifest.config.css || []).filter(filterLocalContent),
         ]),
     ];
-    console.log('📁 Target files');
-    console.dir(targetFiles);
-    targetFiles.forEach((file) => {
+    console.group('📁 Target files');
+    targetFiles.forEach((file, i) => {
+        const prefix = i === targetFiles.length - 1 ? '└─' : '├─';
+        console.log(`${prefix} 📄 ${file}`);
+    });
+    console.groupEnd();
+    for (const file of targetFiles) {
         const filePath = path.join(PLUGIN_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();
+    await new Promise((resolve) => outputZipStream.on('close', resolve));
 };
 export const getContentsZipBuffer = async () => {
     const outputZipPath = path.join(PLUGIN_WORKSPACE_DIRECTORY, 'contents.zip');

package/dist/plugin.js

@@ -10,7 +10,7 @@ import test from './commands/test/index.js';
 import upload from './commands/upload/index.js';
 import zip from './commands/plugin-zip.js';
 import lint from './commands/lint.js';
-program.name('plugin').version('0.9.0').description('🍳 kintone kitchen 🍳 for kintone plugin');
+program.name('plugin').version('1.4.0').description('🍳 kintone kitchen 🍳 for kintone plugin');
 build();
 esbuild();
 dev();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@konomi-app/k2",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "kintone sdk",
   "main": "./dist/index.js",
   "type": "module",
@@ -48,7 +48,7 @@
     "mini-css-extract-plugin": "^2",
     "postcss": "^8",
     "sass": "^1",
-    "sass-loader": "^14",
+    "sass-loader": "^16",
     "style-loader": "^4",
     "tailwindcss": "^3",
     "terser-webpack-plugin": "^5",
@@ -67,4 +67,4 @@
     "@types/html-minifier": "^4",
     "typescript": "*"
   }
-}
+}