Compare commits
12 Commits
Author | SHA1 | Date | |
---|---|---|---|
5f18c0b791
|
|||
94b7277b3a
|
|||
99251b4748
|
|||
b1540e8374
|
|||
a396952331
|
|||
43a55bbb2b
|
|||
db4e21607e
|
|||
c8a2c8087a
|
|||
dd1fd35238
|
|||
be0daf2097
|
|||
83f29b8e63
|
|||
5926c08da5
|
15
.cspell.json
15
.cspell.json
@@ -5,6 +5,7 @@
|
||||
"words": [
|
||||
"blankspace",
|
||||
"docxtemplater",
|
||||
"errback",
|
||||
"Heiti",
|
||||
"Kaku",
|
||||
"kintone",
|
||||
@@ -13,11 +14,21 @@
|
||||
"Ligh",
|
||||
"moize",
|
||||
"officedocument",
|
||||
"OKUMURA",
|
||||
"openxmlformats",
|
||||
"pcss",
|
||||
"pizzip",
|
||||
"rspack",
|
||||
"styl",
|
||||
"SUBTABLE",
|
||||
"wordprocessingml"
|
||||
"wordprocessingml",
|
||||
"Yoshihiro"
|
||||
],
|
||||
"ignorePaths": [".env"]
|
||||
"ignorePaths": [
|
||||
".env",
|
||||
"dist",
|
||||
"node_modules",
|
||||
"scripts",
|
||||
"plugin"
|
||||
]
|
||||
}
|
||||
|
@@ -1,8 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json.schemastore.org/prettierrc",
|
||||
"semi": true,
|
||||
"tabWidth": 2,
|
||||
"singleQuote": true,
|
||||
"printWidth": 120,
|
||||
"trailingComma": "all"
|
||||
}
|
3
.vscode/extensions.json
vendored
3
.vscode/extensions.json
vendored
@@ -1,8 +1,7 @@
|
||||
{
|
||||
"recommendations": [
|
||||
"esbenp.prettier-vscode",
|
||||
"biomejs.biome",
|
||||
"streetsidesoftware.code-spell-checker",
|
||||
"dbaeumer.vscode-eslint",
|
||||
"jawandarajbir.react-vscode-extension-pack"
|
||||
]
|
||||
}
|
||||
|
39
.vscode/settings.json
vendored
39
.vscode/settings.json
vendored
@@ -1,39 +1,40 @@
|
||||
{
|
||||
"editor.formatOnSave": true,
|
||||
"editor.codeActionsOnSave": {
|
||||
"source.fixAll.biome": "explicit",
|
||||
"quickfix.biome": "explicit",
|
||||
"source.organizeImports": "explicit"
|
||||
},
|
||||
"[css]": {
|
||||
"editor.defaultFormatter": "biomejs.biome"
|
||||
},
|
||||
"[javascript]": {
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode"
|
||||
"editor.defaultFormatter": "biomejs.biome"
|
||||
},
|
||||
"[javascriptreact]": {
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode"
|
||||
},
|
||||
"[typescript]": {
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode"
|
||||
},
|
||||
"[typescriptreact]": {
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode"
|
||||
},
|
||||
"[html]": {
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode"
|
||||
},
|
||||
"[css]": {
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode"
|
||||
"editor.defaultFormatter": "biomejs.biome"
|
||||
},
|
||||
"[json]": {
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode"
|
||||
"editor.defaultFormatter": "biomejs.biome"
|
||||
},
|
||||
"[jsonc]": {
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode"
|
||||
"editor.defaultFormatter": "biomejs.biome"
|
||||
},
|
||||
"[typescript]": {
|
||||
"editor.defaultFormatter": "biomejs.biome"
|
||||
},
|
||||
"[typescriptreact]": {
|
||||
"editor.defaultFormatter": "biomejs.biome"
|
||||
},
|
||||
// Extensions - Biome
|
||||
// - see: biome.json
|
||||
// Exteions - cSpell
|
||||
// - see: .cspell.json
|
||||
// Extensions - ESLint
|
||||
"eslint.enable": false,
|
||||
// Extensions - HTML
|
||||
"html.format.wrapLineLength": 0,
|
||||
// Extentions - Prettier
|
||||
// - see: .prettierrc.json
|
||||
// Extentions - Typescript
|
||||
"javascript.updateImportsOnFileMove.enabled": "always",
|
||||
"typescript.updateImportsOnFileMove.enabled": "always"
|
||||
"typescript.updateImportsOnFileMove.enabled": "always",
|
||||
}
|
||||
|
43
biome.json
Normal file
43
biome.json
Normal file
@@ -0,0 +1,43 @@
|
||||
{
|
||||
"$schema": "https://biomejs.dev/schemas/2.2.4/schema.json",
|
||||
"vcs": {
|
||||
"enabled": true,
|
||||
"clientKind": "git",
|
||||
"useIgnoreFile": true
|
||||
},
|
||||
"files": {
|
||||
"ignoreUnknown": false,
|
||||
"includes": ["src/**", "scripts/**"]
|
||||
},
|
||||
"formatter": {
|
||||
"enabled": true,
|
||||
"formatWithErrors": false,
|
||||
"indentStyle": "space",
|
||||
"lineEnding": "lf",
|
||||
"indentWidth": 2,
|
||||
"lineWidth": 120,
|
||||
"attributePosition": "auto"
|
||||
},
|
||||
"linter": {
|
||||
"enabled": true,
|
||||
"domains": {
|
||||
"react": "recommended"
|
||||
},
|
||||
"rules": {
|
||||
"recommended": true
|
||||
}
|
||||
},
|
||||
"javascript": {
|
||||
"formatter": {
|
||||
"quoteStyle": "single"
|
||||
}
|
||||
},
|
||||
"assist": {
|
||||
"enabled": true,
|
||||
"actions": {
|
||||
"source": {
|
||||
"organizeImports": "on"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
@@ -1,17 +0,0 @@
|
||||
import presetsPrettier from '@cybozu/eslint-config/flat/presets/react-typescript-prettier.js';
|
||||
import globals from 'globals';
|
||||
|
||||
/** @type {import("eslint").Linter.Config[]} */
|
||||
export default [
|
||||
...presetsPrettier,
|
||||
{
|
||||
languageOptions: {
|
||||
globals: {
|
||||
...globals.node,
|
||||
},
|
||||
},
|
||||
rules: {
|
||||
'spaced-comment': ['error', 'always', { markers: ['/'] }],
|
||||
},
|
||||
},
|
||||
];
|
3412
package-lock.json
generated
3412
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
61
package.json
61
package.json
@@ -1,51 +1,54 @@
|
||||
{
|
||||
"name": "kintone-plugin-docx",
|
||||
"version": "1.0.1",
|
||||
"version": "2.0.0",
|
||||
"scripts": {
|
||||
"prepare": "node scripts/prepare-private-key.js",
|
||||
"gen": "run-s gen:*",
|
||||
"gen:key": "node scripts/generate-private-key.js",
|
||||
"start": "node scripts/npm-start.js",
|
||||
"develop": "npm run build -- --watch",
|
||||
"build": "npm run prepare && cross-env NODE_ENV=development rspack build",
|
||||
"build:prod": "npm run prepare && cross-env NODE_ENV=production rspack build",
|
||||
"dts-gen": "kintone-dts-gen",
|
||||
"lint": "eslint src --ext .js,.jsx,.ts,.tsx",
|
||||
"prebuild": "npm run gen",
|
||||
"prebuild:prod": "npm run gen",
|
||||
"build": "cross-env NODE_ENV=development rspack build",
|
||||
"build:prod": "cross-env NODE_ENV=production rspack build",
|
||||
"cspell": "cspell .",
|
||||
"lint": "biome lint .",
|
||||
"format": "biome check --write .",
|
||||
"upload": "env-cmd --silent kintone-plugin-uploader dist/plugin.zip --watch --waiting-dialog-ms 3000"
|
||||
},
|
||||
"dependencies": {
|
||||
"@kintone/rest-api-client": "^5.7.4",
|
||||
"angular-expressions": "^1.4.3",
|
||||
"@kintone/rest-api-client": "^5.7.5",
|
||||
"angular-expressions": "^1.5.1",
|
||||
"clsx": "^2.1.1",
|
||||
"dayjs": "^1.11.13",
|
||||
"docxtemplater": "^3.65.0",
|
||||
"dayjs": "^1.11.18",
|
||||
"docxtemplater": "^3.66.4",
|
||||
"file-saver": "^2.0.5",
|
||||
"i18next": "^25.5.3",
|
||||
"moize": "^6.1.6",
|
||||
"pizzip": "^3.2.0",
|
||||
"react": "^19.1.0",
|
||||
"react-dom": "^19.1.0",
|
||||
"react": "^19.2.0",
|
||||
"react-dom": "^19.2.0",
|
||||
"react-error-boundary": "^6.0.0",
|
||||
"react-i18next": "^16.0.0",
|
||||
"tiny-invariant": "^1.3.3"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@cybozu/eslint-config": "^24.0.0",
|
||||
"@kintone/dts-gen": "^8.1.2",
|
||||
"@biomejs/biome": "^2.2.4",
|
||||
"@kintone/dts-gen": "^8.1.3",
|
||||
"@kintone/plugin-uploader": "^9.1.5",
|
||||
"@kintone/webpack-plugin-kintone-plugin": "^8.0.11",
|
||||
"@rspack/cli": "^1.3.15",
|
||||
"@rspack/core": "^1.3.15",
|
||||
"@shin-chan/kypes": "^0.0.7",
|
||||
"@swc/helpers": "^0.5.17",
|
||||
"@rspack/cli": "^1.5.8",
|
||||
"@rspack/core": "^1.5.8",
|
||||
"@types/file-saver": "^2.0.7",
|
||||
"@types/react": "^19.1.8",
|
||||
"@types/react-dom": "^19.1.6",
|
||||
"cross-env": "^7.0.3",
|
||||
"css-loader": "^7.1.2",
|
||||
"env-cmd": "^10.1.0",
|
||||
"eslint": "^9.29.0",
|
||||
"eslint-plugin-react": "^7.37.5",
|
||||
"globals": "^16.2.0",
|
||||
"@types/node": "^24.6.2",
|
||||
"@types/react": "^19.2.0",
|
||||
"@types/react-dom": "^19.2.0",
|
||||
"cross-env": "^10.1.0",
|
||||
"cspell": "^9.2.1",
|
||||
"env-cmd": "^11.0.0",
|
||||
"globals": "^16.4.0",
|
||||
"npm-run-all": "^4.1.5",
|
||||
"prettier": "^3.5.3",
|
||||
"style-loader": "^4.0.0",
|
||||
"typescript": "^5.8.3"
|
||||
"prettier": "^3.6.2",
|
||||
"ts-node": "^10.9.2",
|
||||
"typescript": "^5.9.3"
|
||||
}
|
||||
}
|
||||
|
@@ -1,19 +1,21 @@
|
||||
{
|
||||
"$schema": "https://raw.githubusercontent.com/kintone/js-sdk/%40kintone/plugin-manifest-validator%4010.2.0/packages/plugin-manifest-validator/manifest-schema.json",
|
||||
"manifest_version": 1,
|
||||
"version": "1.0.1",
|
||||
"version": "2.0.0",
|
||||
"type": "APP",
|
||||
"desktop": {
|
||||
"js": ["js/desktop.js"]
|
||||
"js": ["js/desktop.js"],
|
||||
"css": ["js/desktop.css"]
|
||||
},
|
||||
"mobile": {
|
||||
"js": ["js/desktop.js"]
|
||||
"js": ["js/desktop.js"],
|
||||
"css": ["js/desktop.css"]
|
||||
},
|
||||
"icon": "image/icon.png",
|
||||
"config": {
|
||||
"html": "html/config.html",
|
||||
"js": ["js/config.js"],
|
||||
"required_params": ["template"]
|
||||
"css": ["js/config.css"]
|
||||
},
|
||||
"name": {
|
||||
"en": "Word output plugin",
|
||||
|
@@ -1,99 +0,0 @@
|
||||
/* eslint-env node */
|
||||
|
||||
const path = require('path');
|
||||
const KintonePlugin = require('@kintone/webpack-plugin-kintone-plugin');
|
||||
|
||||
const isProduction = process.env.NODE_ENV === 'production';
|
||||
|
||||
module.exports = {
|
||||
mode: isProduction ? 'production' : 'development',
|
||||
devtool: isProduction ? false : 'inline-cheap-module-source-map',
|
||||
entry: { config: './src/config/index.tsx', desktop: './src/desktop/index.tsx' },
|
||||
output: {
|
||||
path: path.resolve(__dirname, 'plugin', 'js'),
|
||||
filename: '[name].js',
|
||||
},
|
||||
resolve: {
|
||||
extensions: ['.ts', '.tsx', '.js'],
|
||||
},
|
||||
module: {
|
||||
rules: [
|
||||
{
|
||||
test: /\.(j|t)s$/,
|
||||
exclude: [/[\\/]node_modules[\\/]/],
|
||||
loader: 'builtin:swc-loader',
|
||||
options: {
|
||||
sourceMaps: !isProduction,
|
||||
jsc: {
|
||||
parser: {
|
||||
syntax: 'typescript',
|
||||
},
|
||||
transform: {
|
||||
react: {
|
||||
runtime: 'automatic',
|
||||
development: !isProduction,
|
||||
},
|
||||
},
|
||||
externalHelpers: true,
|
||||
},
|
||||
env: {
|
||||
targets: 'Chrome >= 48',
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
test: /\.(j|t)sx$/,
|
||||
loader: 'builtin:swc-loader',
|
||||
exclude: [/[\\/]node_modules[\\/]/],
|
||||
options: {
|
||||
sourceMaps: !isProduction,
|
||||
jsc: {
|
||||
parser: {
|
||||
syntax: 'typescript',
|
||||
tsx: true,
|
||||
},
|
||||
transform: {
|
||||
react: {
|
||||
runtime: 'automatic',
|
||||
development: !isProduction,
|
||||
},
|
||||
},
|
||||
externalHelpers: true,
|
||||
},
|
||||
env: {
|
||||
targets: 'Chrome >= 48', // browser compatibility
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
test: /\.css$/i,
|
||||
use: ['style-loader', 'css-loader'],
|
||||
exclude: /\.module\.css$/,
|
||||
},
|
||||
{
|
||||
test: /\.module\.css$/i,
|
||||
use: [
|
||||
'style-loader',
|
||||
{
|
||||
loader: 'css-loader',
|
||||
options: {
|
||||
importLoaders: 1,
|
||||
sourceMap: !isProduction,
|
||||
modules: {
|
||||
localIdentName: isProduction ? '[hash:base64]' : '[name]__[local]--[hash:base64:5]',
|
||||
namedExport: false,
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
plugins: [
|
||||
new KintonePlugin({
|
||||
manifestJSONPath: './plugin/manifest.json',
|
||||
privateKeyPath: './private.ppk',
|
||||
pluginZipPath: './dist/plugin.zip',
|
||||
}),
|
||||
],
|
||||
};
|
69
rspack.config.ts
Normal file
69
rspack.config.ts
Normal file
@@ -0,0 +1,69 @@
|
||||
import { defineConfig } from '@rspack/cli';
|
||||
import { rspack } from '@rspack/core';
|
||||
|
||||
import KintonePlugin from '@kintone/webpack-plugin-kintone-plugin';
|
||||
|
||||
const isDev = process.env.NODE_ENV === 'development';
|
||||
|
||||
// Target browsers, see: https://github.com/browserslist/browserslist
|
||||
const targets = ['last 2 versions', '> 0.2%', 'not dead', 'Firefox ESR'];
|
||||
|
||||
export default defineConfig({
|
||||
mode: isDev ? 'development' : 'production',
|
||||
devtool: isDev ? 'inline-cheap-module-source-map' : false,
|
||||
entry: { config: './src/config/index.tsx', desktop: './src/desktop/index.tsx' },
|
||||
output: {
|
||||
path: './plugin/js',
|
||||
filename: '[name].js',
|
||||
},
|
||||
resolve: {
|
||||
extensions: ['...', '.ts', '.tsx'],
|
||||
},
|
||||
module: {
|
||||
rules: [
|
||||
{
|
||||
test: /\.(tsx?)$/,
|
||||
use: [
|
||||
{
|
||||
loader: 'builtin:swc-loader',
|
||||
options: {
|
||||
jsc: {
|
||||
parser: {
|
||||
syntax: 'typescript',
|
||||
tsx: true,
|
||||
},
|
||||
},
|
||||
env: { targets },
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
parser: {
|
||||
'css/auto': {
|
||||
namedExports: false,
|
||||
},
|
||||
},
|
||||
},
|
||||
plugins: [
|
||||
new KintonePlugin({
|
||||
manifestJSONPath: './plugin/manifest.json',
|
||||
privateKeyPath: './private.ppk',
|
||||
pluginZipPath: './dist/plugin.zip',
|
||||
}),
|
||||
],
|
||||
optimization: {
|
||||
minimizer: [
|
||||
new rspack.SwcJsMinimizerRspackPlugin(),
|
||||
new rspack.LightningCssMinimizerRspackPlugin({
|
||||
minimizerOptions: { targets },
|
||||
}),
|
||||
],
|
||||
},
|
||||
experiments: {
|
||||
css: true,
|
||||
},
|
||||
performance: {
|
||||
hints: false,
|
||||
},
|
||||
});
|
@@ -1,7 +1,4 @@
|
||||
/* eslint-env node */
|
||||
'use strict';
|
||||
|
||||
const fs = require('fs');
|
||||
const fs = require('node:fs');
|
||||
const RSA = require('node-rsa');
|
||||
|
||||
const privateKeyFile = './private.ppk';
|
@@ -1,6 +1,3 @@
|
||||
/* eslint-env node */
|
||||
'use strict';
|
||||
|
||||
const runAll = require('npm-run-all');
|
||||
|
||||
runAll(['develop', 'upload'], {
|
||||
|
@@ -1,5 +1,4 @@
|
||||
import React from 'react';
|
||||
|
||||
import ReactDOM from 'react-dom';
|
||||
import invariant from 'tiny-invariant';
|
||||
|
||||
@@ -21,8 +20,7 @@ const DynamicPortal: React.FC<DynamicPortalProps> = (props) => {
|
||||
el.parentNode.removeChild(el);
|
||||
}
|
||||
};
|
||||
// eslint-disable-next-line react-hooks/exhaustive-deps
|
||||
}, []);
|
||||
}, [el]);
|
||||
return ReactDOM.createPortal(children, el);
|
||||
};
|
||||
export default DynamicPortal;
|
||||
|
@@ -1,5 +1,5 @@
|
||||
// biome-ignore lint/style/useImportType: React is required in scope for the old JSX transform.
|
||||
import React from 'react';
|
||||
|
||||
import KintonePluginAlert from './ui/KintonePluginAlert';
|
||||
|
||||
interface Props {
|
||||
@@ -8,11 +8,6 @@ interface Props {
|
||||
|
||||
const ErrorFallback: React.FC<Props> = (props) => {
|
||||
const { error } = props;
|
||||
return (
|
||||
<KintonePluginAlert>
|
||||
<p>Something went wrong:</p>
|
||||
<pre>{error.message}</pre>
|
||||
</KintonePluginAlert>
|
||||
);
|
||||
return <KintonePluginAlert>{error.message}</KintonePluginAlert>;
|
||||
};
|
||||
export default ErrorFallback;
|
||||
|
@@ -7,14 +7,16 @@
|
||||
background-color: rgba(0, 0, 0, 0.7);
|
||||
z-index: 9999;
|
||||
}
|
||||
.spinner-container {
|
||||
|
||||
.spinnerContainer {
|
||||
position: fixed;
|
||||
top: 50%;
|
||||
left: 50%;
|
||||
transform: translate(-50%, -50%);
|
||||
z-index: 10000;
|
||||
}
|
||||
.spinner-container .spinner {
|
||||
|
||||
.spinnerContainer .spinner {
|
||||
font-size: 10px;
|
||||
width: 1em;
|
||||
height: 1em;
|
||||
@@ -24,6 +26,7 @@
|
||||
animation: mulShdSpin 1.1s infinite ease;
|
||||
transform: translateZ(0);
|
||||
}
|
||||
|
||||
@keyframes mulShdSpin {
|
||||
0%,
|
||||
100% {
|
||||
|
@@ -1,5 +1,5 @@
|
||||
// biome-ignore lint/style/useImportType: React is required in scope for the old JSX transform.
|
||||
import React from 'react';
|
||||
|
||||
import DynamicPortal from './DynamicPortal';
|
||||
|
||||
import styles from './Loading.module.css';
|
||||
|
41
src/common/config.ts
Normal file
41
src/common/config.ts
Normal file
@@ -0,0 +1,41 @@
|
||||
export const PluginConfigDataSource = {
|
||||
SELF: 'self',
|
||||
APP: 'app',
|
||||
} as const;
|
||||
export type PluginConfigDataSource = (typeof PluginConfigDataSource)[keyof typeof PluginConfigDataSource];
|
||||
|
||||
export interface PluginConfigSelf {
|
||||
dataSource: typeof PluginConfigDataSource.SELF;
|
||||
fieldCode: string;
|
||||
}
|
||||
export interface PluginConfigApp {
|
||||
dataSource: typeof PluginConfigDataSource.APP;
|
||||
appId: string;
|
||||
recordId: string;
|
||||
fieldCode: string;
|
||||
}
|
||||
|
||||
export type PluginConfig = PluginConfigSelf | PluginConfigApp;
|
||||
|
||||
const DEFAULT_CONFIG: PluginConfig = {
|
||||
dataSource: PluginConfigDataSource.SELF,
|
||||
fieldCode: '',
|
||||
} as const;
|
||||
|
||||
export const saveConfig = (config: PluginConfig, callback?: () => void): void => {
|
||||
kintone.plugin.app.setConfig(config, callback);
|
||||
};
|
||||
|
||||
export const loadConfig = (pluginId: string): PluginConfig => {
|
||||
const config = kintone.plugin.app.getConfig(pluginId);
|
||||
if (!config || Object.keys(config).length === 0) {
|
||||
// initial state
|
||||
return { ...DEFAULT_CONFIG };
|
||||
}
|
||||
if (config.dataSource != null) {
|
||||
// current version of config format
|
||||
return config as PluginConfig;
|
||||
}
|
||||
// old version of config format
|
||||
return { dataSource: PluginConfigDataSource.SELF, fieldCode: config.template || '' };
|
||||
};
|
1
src/common/constants.ts
Normal file
1
src/common/constants.ts
Normal file
@@ -0,0 +1 @@
|
||||
export const DOCX_CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.wordprocessingml.document';
|
@@ -1,14 +0,0 @@
|
||||
import invariant from 'tiny-invariant';
|
||||
|
||||
export const PLUGIN_ID = kintone.$PLUGIN_ID;
|
||||
invariant(PLUGIN_ID, 'The PLUGIN_ID is not available. Please ensure you are on a Kintone plugin page.');
|
||||
|
||||
const KintoneUserLanguages = ['en', 'ja', 'zh', 'zh-TW', 'es', 'pt-BR', 'th'] as const;
|
||||
export type KintoneUserLanguages = (typeof KintoneUserLanguages)[number];
|
||||
export const LANGUAGE = kintone.getLoginUser().language as KintoneUserLanguages;
|
||||
invariant(
|
||||
KintoneUserLanguages.includes(LANGUAGE),
|
||||
`Unsupported language: ${LANGUAGE}. Supported languages are: ${KintoneUserLanguages.join(', ')}`,
|
||||
);
|
||||
|
||||
export const DOCX_CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.wordprocessingml.document';
|
10
src/common/kintoneLanguageDetector.ts
Normal file
10
src/common/kintoneLanguageDetector.ts
Normal file
@@ -0,0 +1,10 @@
|
||||
import type { LanguageDetectorModule } from 'i18next';
|
||||
|
||||
const KintoneLanguageDetector: LanguageDetectorModule = {
|
||||
type: 'languageDetector',
|
||||
// init: () => {},
|
||||
detect: () => kintone.getLoginUser().language,
|
||||
// cacheUserLanguage: () => {},
|
||||
};
|
||||
|
||||
export default KintoneLanguageDetector;
|
7
src/common/stringUtils.ts
Normal file
7
src/common/stringUtils.ts
Normal file
@@ -0,0 +1,7 @@
|
||||
export const naturalCompare = (a: string, b: string): number => {
|
||||
const locales = new Set<string>([...navigator.languages, 'en-US', 'ja-JP']);
|
||||
return new Intl.Collator(Array.from(locales), {
|
||||
sensitivity: 'variant',
|
||||
numeric: true,
|
||||
}).compare(a, b);
|
||||
};
|
5
src/common/types.ts
Normal file
5
src/common/types.ts
Normal file
@@ -0,0 +1,5 @@
|
||||
import type { KintoneFormFieldProperty } from '@kintone/rest-api-client';
|
||||
|
||||
export type KintoneFormFieldProperties = {
|
||||
[fieldCode: string]: KintoneFormFieldProperty.OneOf;
|
||||
};
|
File diff suppressed because one or more lines are too long
@@ -1,6 +1,6 @@
|
||||
import React from 'react';
|
||||
|
||||
import clsx from 'clsx';
|
||||
// biome-ignore lint/style/useImportType: React is required in scope for the old JSX transform.
|
||||
import React from 'react';
|
||||
|
||||
export type KintonePluginAlertProps = React.PropsWithChildren<{
|
||||
className?: string;
|
||||
|
@@ -1,6 +1,6 @@
|
||||
import React from 'react';
|
||||
|
||||
import clsx from 'clsx';
|
||||
// biome-ignore lint/style/useImportType: React is required in scope for the old JSX transform.
|
||||
import React from 'react';
|
||||
|
||||
export type KintonePluginButtonProps = React.PropsWithChildren<{
|
||||
className?: string;
|
||||
|
@@ -1,6 +1,6 @@
|
||||
import React from 'react';
|
||||
|
||||
import clsx from 'clsx';
|
||||
// biome-ignore lint/style/useImportType: React is required in scope for the old JSX transform.
|
||||
import React from 'react';
|
||||
|
||||
export type KintonePluginDescProps = React.PropsWithChildren<{
|
||||
className?: string;
|
||||
|
46
src/common/ui/KintonePluginInputText.tsx
Normal file
46
src/common/ui/KintonePluginInputText.tsx
Normal file
@@ -0,0 +1,46 @@
|
||||
import clsx from 'clsx';
|
||||
// biome-ignore lint/style/useImportType: React is required in scope for the old JSX transform.
|
||||
import React from 'react';
|
||||
|
||||
export type KintonePluginInputTextProps = {
|
||||
id?: string;
|
||||
className?: string;
|
||||
value: string;
|
||||
size?: number;
|
||||
maxLength?: number;
|
||||
disabled?: boolean;
|
||||
required?: boolean;
|
||||
placeholder?: string;
|
||||
onChange: (value: string) => void;
|
||||
};
|
||||
|
||||
const KintonePluginInputText: React.FC<KintonePluginInputTextProps> = (props) => {
|
||||
const { id, className, value, size, maxLength, disabled, required, placeholder, onChange } = props;
|
||||
const handleOnChange: React.ChangeEventHandler<HTMLInputElement> = (e) => {
|
||||
onChange(e.target.value);
|
||||
};
|
||||
return (
|
||||
<div className={clsx('kintoneplugin-input-outer', className)}>
|
||||
<input
|
||||
id={id}
|
||||
className="kintoneplugin-input-text"
|
||||
type="text"
|
||||
value={value}
|
||||
size={size}
|
||||
maxLength={maxLength}
|
||||
disabled={disabled}
|
||||
required={required}
|
||||
placeholder={placeholder}
|
||||
aria-required={required}
|
||||
aria-disabled={disabled}
|
||||
aria-invalid={required && value === ''}
|
||||
autoComplete="off"
|
||||
autoCorrect="off"
|
||||
autoCapitalize="off"
|
||||
spellCheck={false}
|
||||
onChange={handleOnChange}
|
||||
/>
|
||||
</div>
|
||||
);
|
||||
};
|
||||
export default KintonePluginInputText;
|
@@ -1,6 +1,6 @@
|
||||
import React from 'react';
|
||||
|
||||
import clsx from 'clsx';
|
||||
// biome-ignore lint/style/useImportType: React is required in scope for the old JSX transform.
|
||||
import React from 'react';
|
||||
|
||||
export type KintonePluginLabelProps = React.PropsWithChildren<{
|
||||
className?: string;
|
||||
|
@@ -1,6 +1,6 @@
|
||||
import React from 'react';
|
||||
|
||||
import clsx from 'clsx';
|
||||
// biome-ignore lint/style/useImportType: React is required in scope for the old JSX transform.
|
||||
import React from 'react';
|
||||
|
||||
export type KintonePluginRequire = React.PropsWithChildren<{
|
||||
className?: string;
|
||||
|
@@ -1,6 +1,6 @@
|
||||
import React from 'react';
|
||||
|
||||
import clsx from 'clsx';
|
||||
// biome-ignore lint/style/useImportType: React is required in scope for the old JSX transform.
|
||||
import React from 'react';
|
||||
|
||||
export type KintonePluginRowProps = React.PropsWithChildren<{
|
||||
className?: string;
|
||||
|
@@ -1,6 +1,5 @@
|
||||
import React from 'react';
|
||||
|
||||
import clsx from 'clsx';
|
||||
import React from 'react';
|
||||
|
||||
export type KintonePluginSelectOptionData = {
|
||||
value: string;
|
||||
|
@@ -1,6 +1,6 @@
|
||||
import React from 'react';
|
||||
|
||||
import clsx from 'clsx';
|
||||
// biome-ignore lint/style/useImportType: React is required in scope for the old JSX transform.
|
||||
import React from 'react';
|
||||
|
||||
export type KintonePluginTitleProps = React.PropsWithChildren<{
|
||||
className?: string;
|
||||
|
@@ -1,15 +1,34 @@
|
||||
import { KintoneRestAPIClient } from '@kintone/rest-api-client';
|
||||
import moize from 'moize';
|
||||
import React from 'react';
|
||||
|
||||
import { ErrorBoundary } from 'react-error-boundary';
|
||||
import invariant from 'tiny-invariant';
|
||||
import ErrorFallback from '../common/ErrorFallback';
|
||||
import Loading from '../common/Loading';
|
||||
import type { KintoneFormFieldProperties } from '../common/types';
|
||||
import Settings from './Settings';
|
||||
|
||||
const ConfigApp: React.FC = () => {
|
||||
interface ConfigAppProps {
|
||||
pluginId: string;
|
||||
}
|
||||
|
||||
const cachedFormFieldsProperties = moize.promise(async (appId: number): Promise<KintoneFormFieldProperties> => {
|
||||
const client = new KintoneRestAPIClient();
|
||||
const { properties } = await client.app.getFormFields({ app: appId, preview: true });
|
||||
return properties;
|
||||
});
|
||||
|
||||
const ConfigApp: React.FC<ConfigAppProps> = (props) => {
|
||||
const { pluginId } = props;
|
||||
|
||||
const appId = kintone.app.getId();
|
||||
invariant(appId, 'The app ID is not available. Please ensure you are on a Kintone app page.');
|
||||
const propertiesPromise = cachedFormFieldsProperties(appId);
|
||||
|
||||
return (
|
||||
<ErrorBoundary FallbackComponent={ErrorFallback}>
|
||||
<React.Suspense fallback={<Loading />}>
|
||||
<Settings />
|
||||
<Settings pluginId={pluginId} appId={appId} propertiesPromise={propertiesPromise} />
|
||||
</React.Suspense>
|
||||
</ErrorBoundary>
|
||||
);
|
||||
|
@@ -1,3 +1,10 @@
|
||||
.settings .app {
|
||||
display: flex;
|
||||
gap: 2em;
|
||||
align-items: center;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
.buttons > *:not(:last-child) {
|
||||
margin-right: 0.5em;
|
||||
}
|
||||
|
@@ -1,88 +1,186 @@
|
||||
import React from 'react';
|
||||
|
||||
import { KintoneRestAPIClient } from '@kintone/rest-api-client';
|
||||
import { Properties as KintoneFormFieldProperties } from '@kintone/rest-api-client/lib/src/client/types';
|
||||
import moize from 'moize';
|
||||
import invariant from 'tiny-invariant';
|
||||
import { PLUGIN_ID } from '../common/global';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import type { PluginConfig } from '../common/config';
|
||||
import { loadConfig, PluginConfigDataSource, saveConfig } from '../common/config';
|
||||
import { naturalCompare } from '../common/stringUtils';
|
||||
import type { KintoneFormFieldProperties } from '../common/types';
|
||||
import KintonePluginAlert from '../common/ui/KintonePluginAlert';
|
||||
import KintonePluginButton from '../common/ui/KintonePluginButton';
|
||||
import KintonePluginDesc from '../common/ui/KintonePluginDesc';
|
||||
import KintonePluginInputText from '../common/ui/KintonePluginInputText';
|
||||
import KintonePluginLabel from '../common/ui/KintonePluginLabel';
|
||||
import KintonePluginRequire from '../common/ui/KintonePluginRequire';
|
||||
import KintonePluginRow from '../common/ui/KintonePluginRow';
|
||||
import KintonePluginSelect, { KintonePluginSelectOptionData } from '../common/ui/KintonePluginSelect';
|
||||
import KintonePluginSelect, { type KintonePluginSelectOptionData } from '../common/ui/KintonePluginSelect';
|
||||
import KintonePluginTitle from '../common/ui/KintonePluginTitle';
|
||||
|
||||
import styles from './Settings.module.css';
|
||||
|
||||
const cachedFormFieldsProperties = moize.promise(async (appId: number): Promise<KintoneFormFieldProperties> => {
|
||||
const client = new KintoneRestAPIClient();
|
||||
const { properties } = await client.app.getFormFields({ app: appId, lang: 'en', preview: false });
|
||||
return properties;
|
||||
});
|
||||
interface SettingsProps {
|
||||
pluginId: string;
|
||||
appId: number;
|
||||
propertiesPromise: Promise<KintoneFormFieldProperties>;
|
||||
}
|
||||
|
||||
const Settings: React.FC = () => {
|
||||
const config = kintone.plugin.app.getConfig(PLUGIN_ID);
|
||||
const appId = kintone.app.getId();
|
||||
invariant(appId, 'The app ID is not available. Please ensure you are on a Kintone app page.');
|
||||
const properties = React.use(cachedFormFieldsProperties(appId));
|
||||
const fileFields = Object.values(properties).filter((property) => property.type === 'FILE');
|
||||
const Settings: React.FC<SettingsProps> = (props) => {
|
||||
const { pluginId, appId, propertiesPromise } = props;
|
||||
const { t } = useTranslation();
|
||||
const config = loadConfig(pluginId);
|
||||
const properties = React.use(propertiesPromise);
|
||||
// data source options
|
||||
const dataSourceOptions = [
|
||||
{ value: PluginConfigDataSource.SELF, label: t('settings.datasource.labels.self') },
|
||||
{ value: PluginConfigDataSource.APP, label: t('settings.datasource.labels.app') },
|
||||
];
|
||||
const [dataSource, setDataSource] = React.useState<
|
||||
(typeof PluginConfigDataSource)[keyof typeof PluginConfigDataSource]
|
||||
>(config.dataSource);
|
||||
|
||||
// states for SELF data source
|
||||
const fileFields = Object.values(properties)
|
||||
.filter((property) => property.type === 'FILE')
|
||||
.sort((a, b) => naturalCompare(`${a.label} (${a.code})`, `${b.label} (${b.code})`));
|
||||
const options: KintonePluginSelectOptionData[] = [
|
||||
{ value: '', label: 'Select a File field', disabled: true }, // Default option
|
||||
{ value: '', label: t('settings.self.messages.select-an-attachment-fields'), disabled: true }, // Default option
|
||||
...fileFields.map((property) => ({
|
||||
value: property.code,
|
||||
label: `${property.label} (${property.code})`,
|
||||
})),
|
||||
];
|
||||
const [fieldCode, setFieldCode] = React.useState<string>(
|
||||
() =>
|
||||
options.find((option) => config.dataSource === PluginConfigDataSource.SELF && option.value === config.fieldCode)
|
||||
?.value ?? '',
|
||||
);
|
||||
|
||||
const [template, setTemplate] = React.useState<string>(
|
||||
() => options.find((option) => option.value === (config.template ?? ''))?.value ?? '',
|
||||
// states for APP data source
|
||||
const [otherAppId, setOtherAppId] = React.useState<string>(
|
||||
config.dataSource === PluginConfigDataSource.APP ? config.appId : '',
|
||||
);
|
||||
const [otherRecordId, setOtherRecordId] = React.useState<string>(
|
||||
config.dataSource === PluginConfigDataSource.APP ? config.recordId : '',
|
||||
);
|
||||
const [otherFieldCode, setOtherFieldCode] = React.useState<string>(
|
||||
config.dataSource === PluginConfigDataSource.APP ? config.fieldCode : '',
|
||||
);
|
||||
|
||||
const handleOnSubmit = (e: React.FormEvent<HTMLFormElement>) => {
|
||||
e.preventDefault();
|
||||
kintone.plugin.app.setConfig({ template }, () => {
|
||||
alert('The plug-in settings have been saved. Please update the app!');
|
||||
let configToSave: PluginConfig;
|
||||
if (dataSource === PluginConfigDataSource.SELF) {
|
||||
configToSave = { dataSource: PluginConfigDataSource.SELF, fieldCode };
|
||||
} else if (dataSource === PluginConfigDataSource.APP) {
|
||||
configToSave = {
|
||||
dataSource: PluginConfigDataSource.APP,
|
||||
appId: otherAppId,
|
||||
fieldCode: otherFieldCode,
|
||||
recordId: otherRecordId,
|
||||
};
|
||||
} else {
|
||||
return;
|
||||
}
|
||||
saveConfig(configToSave, () => {
|
||||
alert(t('on-saved'));
|
||||
window.location.href = `../../flow?app=${appId}`;
|
||||
});
|
||||
};
|
||||
|
||||
const handleOnChangeTemplate = (value: string) => {
|
||||
setTemplate(value);
|
||||
};
|
||||
|
||||
const handleOnClickCancel = () => {
|
||||
window.location.href = `../../${appId}/plugin/`;
|
||||
};
|
||||
|
||||
return (
|
||||
<section className="settings">
|
||||
<KintonePluginLabel>Settings for the Kintone Word output plugin</KintonePluginLabel>
|
||||
<div className={styles.settings}>
|
||||
<KintonePluginLabel>{t('title')}</KintonePluginLabel>
|
||||
<form onSubmit={handleOnSubmit}>
|
||||
<KintonePluginRow>
|
||||
<KintonePluginTitle>
|
||||
Template<KintonePluginRequire>*</KintonePluginRequire>
|
||||
{t('settings.datasource.title')}
|
||||
<KintonePluginRequire>*</KintonePluginRequire>
|
||||
</KintonePluginTitle>
|
||||
<KintonePluginDesc>Select a file field that contains the Word template file.</KintonePluginDesc>
|
||||
{fileFields.length === 0 ? (
|
||||
<KintonePluginAlert>
|
||||
No file fields found in the app. Please add a file field to use this plugin.
|
||||
</KintonePluginAlert>
|
||||
) : (
|
||||
<KintonePluginSelect value={template} onChange={handleOnChangeTemplate} options={options} />
|
||||
)}
|
||||
<KintonePluginDesc>{t('settings.datasource.description')}</KintonePluginDesc>
|
||||
<KintonePluginSelect
|
||||
value={String(dataSource)}
|
||||
onChange={(value) => {
|
||||
const newDataSource = value as PluginConfigDataSource;
|
||||
if (Object.values(PluginConfigDataSource).includes(newDataSource)) {
|
||||
setDataSource(newDataSource);
|
||||
}
|
||||
}}
|
||||
options={dataSourceOptions.map((opt) => ({ value: String(opt.value), label: opt.label }))}
|
||||
/>
|
||||
</KintonePluginRow>
|
||||
{dataSource === PluginConfigDataSource.SELF && (
|
||||
<KintonePluginRow>
|
||||
<KintonePluginTitle>
|
||||
{t('settings.self.title')}
|
||||
<KintonePluginRequire>*</KintonePluginRequire>
|
||||
</KintonePluginTitle>
|
||||
<KintonePluginDesc>{t('settings.self.description')}</KintonePluginDesc>
|
||||
{fileFields.length === 0 ? (
|
||||
<KintonePluginAlert>{t('settings.self.errors.no-attachment-field-found')}</KintonePluginAlert>
|
||||
) : (
|
||||
<KintonePluginSelect value={fieldCode} onChange={(value) => setFieldCode(value)} options={options} />
|
||||
)}
|
||||
</KintonePluginRow>
|
||||
)}
|
||||
{dataSource === PluginConfigDataSource.APP && (
|
||||
<KintonePluginRow>
|
||||
<KintonePluginTitle>
|
||||
{t('settings.app.title')}
|
||||
<KintonePluginRequire>*</KintonePluginRequire>
|
||||
</KintonePluginTitle>
|
||||
<KintonePluginDesc>{t('settings.app.description')}</KintonePluginDesc>
|
||||
<div className={styles.app}>
|
||||
<label htmlFor="otherAppIdInput">
|
||||
{t('settings.app.labels.app-id')} <KintonePluginRequire>*</KintonePluginRequire>
|
||||
<br />
|
||||
<KintonePluginInputText
|
||||
id="otherAppIdInput"
|
||||
value={otherAppId}
|
||||
required
|
||||
onChange={(value) => {
|
||||
setOtherAppId(value);
|
||||
}}
|
||||
/>
|
||||
</label>
|
||||
<label htmlFor="otherRecordIdInput">
|
||||
{t('settings.app.labels.record-id')} <KintonePluginRequire>*</KintonePluginRequire>
|
||||
<br />
|
||||
<KintonePluginInputText
|
||||
id="otherRecordIdInput"
|
||||
value={otherRecordId}
|
||||
required
|
||||
onChange={(value) => {
|
||||
setOtherRecordId(value);
|
||||
}}
|
||||
/>
|
||||
</label>
|
||||
<label htmlFor="otherFieldCodeInput">
|
||||
{t('settings.app.labels.field-code')} <KintonePluginRequire>*</KintonePluginRequire>
|
||||
<br />
|
||||
<KintonePluginInputText
|
||||
id="otherFieldCodeInput"
|
||||
value={otherFieldCode}
|
||||
required
|
||||
onChange={(value) => {
|
||||
setOtherFieldCode(value);
|
||||
}}
|
||||
/>
|
||||
</label>
|
||||
</div>
|
||||
</KintonePluginRow>
|
||||
)}
|
||||
<KintonePluginRow className={styles.buttons}>
|
||||
<KintonePluginButton variant="dialog-cancel" type="button" onClick={handleOnClickCancel}>
|
||||
Cancel
|
||||
{t('buttons.cancel')}
|
||||
</KintonePluginButton>
|
||||
<KintonePluginButton variant="dialog-ok" type="submit">
|
||||
Save
|
||||
{t('buttons.save')}
|
||||
</KintonePluginButton>
|
||||
</KintonePluginRow>
|
||||
</form>
|
||||
</section>
|
||||
</div>
|
||||
);
|
||||
};
|
||||
export default Settings;
|
||||
|
27
src/config/i18n.ts
Normal file
27
src/config/i18n.ts
Normal file
@@ -0,0 +1,27 @@
|
||||
import i18n from 'i18next';
|
||||
import { initReactI18next } from 'react-i18next';
|
||||
import kintoneLanguageDetector from '../common/kintoneLanguageDetector';
|
||||
|
||||
import enTranslation from './locales/en.json';
|
||||
import jaTranslation from './locales/ja.json';
|
||||
|
||||
i18n
|
||||
.use(kintoneLanguageDetector)
|
||||
.use(initReactI18next)
|
||||
.init({
|
||||
fallbackLng: 'en',
|
||||
// debug: true,
|
||||
interpolation: {
|
||||
escapeValue: false, // not needed for react as it escapes by default
|
||||
},
|
||||
resources: {
|
||||
en: {
|
||||
translation: enTranslation,
|
||||
},
|
||||
ja: {
|
||||
translation: jaTranslation,
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
export default i18n;
|
@@ -1,16 +1,19 @@
|
||||
import React from 'react';
|
||||
|
||||
import ReactDOM from 'react-dom/client';
|
||||
import invariant from 'tiny-invariant';
|
||||
import ConfigApp from './ConfigApp';
|
||||
|
||||
import '../common/ui/51-modern-default.css';
|
||||
|
||||
const root = document.getElementById('plugin-config-root');
|
||||
invariant(root, 'The plugin configuration root element "plugin-config-root" is not found.');
|
||||
import './i18n';
|
||||
|
||||
ReactDOM.createRoot(root).render(
|
||||
<React.StrictMode>
|
||||
<ConfigApp />
|
||||
</React.StrictMode>,
|
||||
);
|
||||
((PLUGIN_ID) => {
|
||||
const root = document.getElementById('plugin-config-root');
|
||||
invariant(root, 'The plugin configuration root element "plugin-config-root" is not found.');
|
||||
|
||||
ReactDOM.createRoot(root).render(
|
||||
<React.StrictMode>
|
||||
<ConfigApp pluginId={PLUGIN_ID} />
|
||||
</React.StrictMode>,
|
||||
);
|
||||
})(kintone.$PLUGIN_ID);
|
||||
|
37
src/config/locales/en.json
Normal file
37
src/config/locales/en.json
Normal file
@@ -0,0 +1,37 @@
|
||||
{
|
||||
"title": "Settings for the Kintone Word output plugin",
|
||||
"settings": {
|
||||
"datasource": {
|
||||
"title": "Select data source for Word template file",
|
||||
"description": "Please select the data source for the Word template file.",
|
||||
"labels": {
|
||||
"self": "Own record",
|
||||
"app": "Record from another app"
|
||||
}
|
||||
},
|
||||
"self": {
|
||||
"title": "Template",
|
||||
"description": "Select an attachment field that contains the Word template file.",
|
||||
"messages": {
|
||||
"select-an-attachment-fields": "(Select an attachment field)"
|
||||
},
|
||||
"errors": {
|
||||
"no-attachment-field-found": "No attachment fields found in the app. Please add an attachment field to use this plugin."
|
||||
}
|
||||
},
|
||||
"app": {
|
||||
"title": "Attachment file info from another app",
|
||||
"description": "Enter App ID, Record ID, and Attachment Field Code.",
|
||||
"labels": {
|
||||
"app-id": "App ID",
|
||||
"record-id": "Record ID",
|
||||
"field-code": "Attachment Field Code"
|
||||
}
|
||||
}
|
||||
},
|
||||
"buttons": {
|
||||
"save": "Save",
|
||||
"cancel": "Cancel"
|
||||
},
|
||||
"on-saved": "The plug-in settings have been saved. Please update the app!"
|
||||
}
|
37
src/config/locales/ja.json
Normal file
37
src/config/locales/ja.json
Normal file
@@ -0,0 +1,37 @@
|
||||
{
|
||||
"title": "Word出力プラグイン設定",
|
||||
"settings": {
|
||||
"datasource": {
|
||||
"title": "WORD雛形ファイルのデータソース選択",
|
||||
"description": "WORD雛形ファイルのデータソースを選択してください。",
|
||||
"labels": {
|
||||
"self": "自レコード",
|
||||
"app": "他アプリのレコード"
|
||||
}
|
||||
},
|
||||
"self": {
|
||||
"title": "雛形ファイル",
|
||||
"description": "Word雛形ファイルを保存する添付ファイルフィールドを選択してください。",
|
||||
"messages": {
|
||||
"select-an-attachment-fields": "(選択してください)"
|
||||
},
|
||||
"errors": {
|
||||
"no-attachment-field-found": "このアプリに添付ファイルフィールドが見つかりません。フォームに添付ファイルフィールドを追加してください。"
|
||||
}
|
||||
},
|
||||
"app": {
|
||||
"title": "他アプリの添付ファイル情報",
|
||||
"description": "アプリID・レコード番号・添付ファイルフィールドコードを入力してください。",
|
||||
"labels": {
|
||||
"app-id": "アプリID",
|
||||
"record-id": "レコード番号",
|
||||
"field-code": "添付ファイルフィールドコード"
|
||||
}
|
||||
}
|
||||
},
|
||||
"buttons": {
|
||||
"save": "保存",
|
||||
"cancel": "キャンセル"
|
||||
},
|
||||
"on-saved": "設定を保存しました。アプリを更新してください。"
|
||||
}
|
@@ -1,20 +1,47 @@
|
||||
import { KintoneRestAPIClient } from '@kintone/rest-api-client';
|
||||
import moize from 'moize';
|
||||
import React from 'react';
|
||||
|
||||
import { ErrorBoundary } from 'react-error-boundary';
|
||||
import { loadConfig, type PluginConfig } from '../common/config';
|
||||
import ErrorFallback from '../common/ErrorFallback';
|
||||
import Loading from '../common/Loading';
|
||||
import type { KintoneFormFieldProperties } from '../common/types';
|
||||
import { checkConfig } from './checkConfig';
|
||||
import MenuPanel from './MenuPanel';
|
||||
|
||||
interface DesktopAppProps {
|
||||
pluginId: string;
|
||||
event: kintone.events.AppRecordDetailShowEvent | kintone.events.MobileAppRecordDetailShowEvent;
|
||||
}
|
||||
|
||||
const cachedFormFieldsProperties = moize.promise(async (appId: number): Promise<KintoneFormFieldProperties> => {
|
||||
const client = new KintoneRestAPIClient();
|
||||
const { properties } = await client.app.getFormFields({ app: appId, preview: false });
|
||||
return properties;
|
||||
});
|
||||
|
||||
const cachedConfigCheck = moize.promise(
|
||||
async (config: PluginConfig, record: kintone.types.SavedFields): Promise<string> => {
|
||||
return await checkConfig(config, record);
|
||||
},
|
||||
);
|
||||
|
||||
const DesktopApp: React.FC<DesktopAppProps> = (props) => {
|
||||
const { event } = props;
|
||||
const { pluginId, event } = props;
|
||||
|
||||
const config = loadConfig(pluginId);
|
||||
const propertiesPromise = cachedFormFieldsProperties(event.appId);
|
||||
const fileKeyPromise = cachedConfigCheck(config, event.record);
|
||||
|
||||
return (
|
||||
<ErrorBoundary FallbackComponent={ErrorFallback}>
|
||||
<React.Suspense fallback={<Loading />}>
|
||||
<MenuPanel event={event} />
|
||||
<MenuPanel
|
||||
pluginId={pluginId}
|
||||
event={event}
|
||||
propertiesPromise={propertiesPromise}
|
||||
fileKeyPromise={fileKeyPromise}
|
||||
/>
|
||||
</React.Suspense>
|
||||
</ErrorBoundary>
|
||||
);
|
||||
|
@@ -1,238 +1,32 @@
|
||||
import { KintoneRestAPIClient } from '@kintone/rest-api-client';
|
||||
import saveAs from 'file-saver';
|
||||
import React from 'react';
|
||||
|
||||
import { KintoneFormFieldProperty, KintoneRestAPIClient } from '@kintone/rest-api-client';
|
||||
import { Properties as KintoneFormFieldProperties } from '@kintone/rest-api-client/lib/src/client/types';
|
||||
import { KintoneRecord } from '@shin-chan/kypes/types/page';
|
||||
import dayjs from 'dayjs';
|
||||
import Docxtemplater from 'docxtemplater';
|
||||
import expressionParser from 'docxtemplater/expressions';
|
||||
import { saveAs } from 'file-saver';
|
||||
import moize from 'moize';
|
||||
import PizZip from 'pizzip';
|
||||
import invariant from 'tiny-invariant';
|
||||
import { DOCX_CONTENT_TYPE, LANGUAGE, PLUGIN_ID } from '../common/global';
|
||||
import KintonePluginAlert from '../common/ui/KintonePluginAlert';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import type { KintoneFormFieldProperties } from '../common/types';
|
||||
import KintonePluginButton from '../common/ui/KintonePluginButton';
|
||||
import generateWordFileData from './generateWordFileData';
|
||||
|
||||
interface TemplateData {
|
||||
[key: string]: TemplateData | TemplateData[] | string | string[];
|
||||
}
|
||||
|
||||
interface MenuPanelProps {
|
||||
export interface MenuPanelProps {
|
||||
pluginId: string;
|
||||
event: kintone.events.AppRecordDetailShowEvent | kintone.events.MobileAppRecordDetailShowEvent;
|
||||
propertiesPromise: Promise<KintoneFormFieldProperties>;
|
||||
fileKeyPromise: Promise<string>;
|
||||
}
|
||||
|
||||
const cachedFormFieldsProperties = moize.promise(async (appId: number): Promise<KintoneFormFieldProperties> => {
|
||||
const client = new KintoneRestAPIClient();
|
||||
const { properties } = await client.app.getFormFields({ app: appId, lang: 'en', preview: false });
|
||||
return properties;
|
||||
});
|
||||
|
||||
const formatNumberValue = (value: string, digit: boolean, scale?: number): string => {
|
||||
if (value !== '' && !isNaN(Number(value))) {
|
||||
const numberValue = Number(value);
|
||||
const options: Intl.NumberFormatOptions = {
|
||||
useGrouping: digit,
|
||||
};
|
||||
if (scale != null && scale >= 0) {
|
||||
options.minimumFractionDigits = scale;
|
||||
options.maximumFractionDigits = scale;
|
||||
}
|
||||
return new Intl.NumberFormat('en-US', options).format(numberValue);
|
||||
}
|
||||
return value;
|
||||
};
|
||||
|
||||
const formatValueWithUnit = (
|
||||
value: string,
|
||||
property: KintoneFormFieldProperty.Number | KintoneFormFieldProperty.Calc,
|
||||
): string => {
|
||||
if (value !== '' && property.unit !== '') {
|
||||
if (property.unitPosition === 'BEFORE') {
|
||||
return `${property.unit} ${value}`;
|
||||
} else if (property.unitPosition === 'AFTER') {
|
||||
return `${value} ${property.unit}`;
|
||||
}
|
||||
}
|
||||
return value;
|
||||
};
|
||||
|
||||
const formatNumberRecordValue = (
|
||||
value: string,
|
||||
property: KintoneFormFieldProperty.Number | KintoneFormFieldProperty.Lookup,
|
||||
): string => {
|
||||
if ('lookup' in property) {
|
||||
return value;
|
||||
}
|
||||
const scale = property.displayScale !== '' ? Number(property.displayScale) : undefined;
|
||||
const digit = property.digit ?? false;
|
||||
const formattedValue = formatNumberValue(value, digit, scale);
|
||||
return formatValueWithUnit(formattedValue, property);
|
||||
};
|
||||
|
||||
const formatCalculatedRecordValue = (value: string, property: KintoneFormFieldProperty.Calc): string => {
|
||||
const { format } = property;
|
||||
if (value === '') {
|
||||
return '';
|
||||
}
|
||||
const scale = property.displayScale !== '' ? Number(property.displayScale) : undefined;
|
||||
let formattedValue: string;
|
||||
if (format === 'NUMBER') {
|
||||
formattedValue = formatNumberValue(value, false, scale);
|
||||
} else if (format === 'NUMBER_DIGIT') {
|
||||
formattedValue = formatNumberValue(value, true, scale);
|
||||
} else if (format === 'DATETIME') {
|
||||
// "2025-05-30T00:00:00Z" -> "2025-05-30 9:00" (browser local timezone)
|
||||
const date = new Date(value);
|
||||
invariant(!isNaN(date.getTime()), `Expected value to be a valid date string, but got ${value}`);
|
||||
formattedValue = dayjs(date).format('YYYY-MM-DD h:mm');
|
||||
} else if (format === 'DATE') {
|
||||
// "2025-05-30T00:00:00Z" -> "2025-05-30" (browser local timezone)
|
||||
const date = new Date(value);
|
||||
invariant(!isNaN(date.getTime()), `Expected value to be a valid date string, but got ${value}`);
|
||||
formattedValue = dayjs(date).format('YYYY-MM-DD');
|
||||
} else if (format === 'TIME') {
|
||||
// "00:30" -> "0:30"
|
||||
const [hours, minutes] = value.split(':').map((v) => Number(v));
|
||||
invariant(
|
||||
!isNaN(hours) && !isNaN(minutes),
|
||||
`Expected hours and minutes to be numbers, but got hours: ${hours}, minutes: ${minutes}`,
|
||||
);
|
||||
formattedValue = `${hours}:${String(minutes).padStart(2, '0')}`;
|
||||
} else if (format === 'HOUR_MINUTE') {
|
||||
// "49:30" -> en:"49 hours 30 minutes", ja: "49時間30分"
|
||||
const [hours, minutes] = value.split(':').map((v) => Number(v));
|
||||
invariant(
|
||||
!isNaN(hours) && !isNaN(minutes),
|
||||
`Expected hours and minutes to be numbers, but got hours: ${hours}, minutes: ${minutes}`,
|
||||
);
|
||||
formattedValue = LANGUAGE === 'ja' ? `${hours}時間${minutes}分` : `${hours} hours ${minutes} minutes`;
|
||||
} else if (format === 'DAY_HOUR_MINUTE') {
|
||||
// "49:30" -> en: "2 days 1 hour 30 minutes", ja: "2日1時間30分
|
||||
const [hours, minutes] = value.split(':').map((v) => Number(v));
|
||||
invariant(
|
||||
!isNaN(hours) && !isNaN(minutes),
|
||||
`Expected hours and minutes to be numbers, but got hours: ${hours}, minutes: ${minutes}`,
|
||||
);
|
||||
const days = Math.floor(Number(hours) / 24);
|
||||
const remainingHours = Number(hours) % 24;
|
||||
formattedValue =
|
||||
LANGUAGE === 'ja'
|
||||
? `${days}日${remainingHours}時間${minutes}分`
|
||||
: `${days} days ${remainingHours} hours ${minutes} minutes`;
|
||||
} else {
|
||||
// DATETIME, DATE, TIME
|
||||
formattedValue = value;
|
||||
}
|
||||
return formatValueWithUnit(formattedValue, property);
|
||||
};
|
||||
|
||||
const record2data = (properties: KintoneFormFieldProperties, record: Partial<KintoneRecord>): TemplateData => {
|
||||
const data: TemplateData = {};
|
||||
for (const key in record) {
|
||||
if (Object.prototype.hasOwnProperty.call(record, key) && Object.prototype.hasOwnProperty.call(properties, key)) {
|
||||
const item = record[key];
|
||||
const property = properties[key];
|
||||
if (item == null) continue;
|
||||
const { type, value } = item;
|
||||
if (value == null) {
|
||||
data[key] = '';
|
||||
} else if (type === 'CREATOR' || type === 'MODIFIER') {
|
||||
data[key] = {
|
||||
name: value.name,
|
||||
code: value.code,
|
||||
};
|
||||
} else if (type === 'NUMBER') {
|
||||
invariant(property.type === 'NUMBER', `Expected property type to be NUMBER, but got ${property.type}`);
|
||||
data[key] = formatNumberRecordValue(value, property);
|
||||
} else if (type === 'CALC') {
|
||||
invariant(property.type === 'CALC', `Expected property type to be CALC, but got ${property.type}`);
|
||||
data[key] = formatCalculatedRecordValue(value, property);
|
||||
} else if (type === 'CHECK_BOX' || type === 'MULTI_SELECT' || type === 'CATEGORY') {
|
||||
data[key] = value.map((v) => v);
|
||||
} else if (
|
||||
type === 'USER_SELECT' ||
|
||||
type === 'ORGANIZATION_SELECT' ||
|
||||
type === 'GROUP_SELECT' ||
|
||||
type === 'STATUS_ASSIGNEE'
|
||||
) {
|
||||
data[key] = value.map((v) => {
|
||||
return { name: v.name, code: v.code };
|
||||
});
|
||||
} else if (type === 'SUBTABLE') {
|
||||
invariant(property.type === 'SUBTABLE', `Expected property type to be SUBTABLE, but got ${property.type}`);
|
||||
data[key] = value.map((subRecord) => record2data(property.fields, subRecord.value));
|
||||
} else if (type === 'FILE') {
|
||||
invariant(property.type === 'FILE', `Expected property type to be FILE, but got ${property.type}`);
|
||||
data[key] = value.map((file) => ({
|
||||
name: file.name,
|
||||
size: file.size,
|
||||
contentType: file.contentType,
|
||||
fileKey: file.fileKey,
|
||||
}));
|
||||
} else {
|
||||
// RECORD_NUMBER, __ID__, __REVISION__, CREATED_TIME, UPDATED_TIME
|
||||
// SINGLE_LINE_TEXT, MULTI_LINE_TEXT, RICH_TEXT, RADIO_BUTTON, DROP_DOWN, DATE, TIME, DATETIME, LINK, STATUS
|
||||
data[key] = value;
|
||||
}
|
||||
}
|
||||
}
|
||||
return data;
|
||||
};
|
||||
|
||||
const MenuPanel: React.FC<MenuPanelProps> = (props) => {
|
||||
const { event } = props;
|
||||
const appId = event.appId;
|
||||
const properties = React.use(cachedFormFieldsProperties(appId));
|
||||
const config = kintone.plugin.app.getConfig(PLUGIN_ID);
|
||||
const template: string = config.template ?? '';
|
||||
if (template === '') {
|
||||
return (
|
||||
<KintonePluginAlert>
|
||||
Word output plugin: Template field is not set. Please configure the plugin.
|
||||
</KintonePluginAlert>
|
||||
);
|
||||
}
|
||||
const record = event.record[template];
|
||||
if (record == null) {
|
||||
return <KintonePluginAlert>Word output plugin: Template field is not available in this app.</KintonePluginAlert>;
|
||||
}
|
||||
if (record.type !== 'FILE') {
|
||||
return <KintonePluginAlert>Word output plugin: Template field must be a file field.</KintonePluginAlert>;
|
||||
}
|
||||
if (record.value.length === 0) {
|
||||
return <KintonePluginAlert>Word output plugin: Template field does not contain any files.</KintonePluginAlert>;
|
||||
}
|
||||
if (record.value.length > 1) {
|
||||
return (
|
||||
<KintonePluginAlert>
|
||||
Word output plugin: Template field contains multiple files. Please ensure it contains only one file.
|
||||
</KintonePluginAlert>
|
||||
);
|
||||
}
|
||||
const { fileKey, contentType } = record.value[0];
|
||||
if (contentType !== DOCX_CONTENT_TYPE) {
|
||||
return (
|
||||
<KintonePluginAlert>
|
||||
Word output plugin: The template file must be a DOCX file. The current file type is {contentType}.
|
||||
</KintonePluginAlert>
|
||||
);
|
||||
}
|
||||
const { event, propertiesPromise, fileKeyPromise } = props;
|
||||
const { t } = useTranslation();
|
||||
const language = kintone.getLoginUser().language;
|
||||
const properties = React.use(propertiesPromise);
|
||||
const fileKey = React.use(fileKeyPromise);
|
||||
|
||||
const handleOnClickOutputButton = (e: React.MouseEvent<HTMLButtonElement>) => {
|
||||
e.preventDefault();
|
||||
const client = new KintoneRestAPIClient();
|
||||
client.file
|
||||
.downloadFile({ fileKey })
|
||||
.then((content) => {
|
||||
const zip = new PizZip(content);
|
||||
const doc = new Docxtemplater(zip, {
|
||||
paragraphLoop: true,
|
||||
linebreaks: true,
|
||||
parser: expressionParser,
|
||||
nullGetter: () => '',
|
||||
});
|
||||
doc.render(record2data(properties, event.record));
|
||||
const out = doc.getZip().generate({ type: 'blob', mimeType: DOCX_CONTENT_TYPE });
|
||||
const out = generateWordFileData(content, properties, event.record, language);
|
||||
saveAs(out, 'output.docx');
|
||||
})
|
||||
.catch((error) => {
|
||||
@@ -243,7 +37,7 @@ const MenuPanel: React.FC<MenuPanelProps> = (props) => {
|
||||
|
||||
return (
|
||||
<KintonePluginButton variant="normal" onClick={handleOnClickOutputButton}>
|
||||
Word出力
|
||||
{t('buttons.output')}
|
||||
</KintonePluginButton>
|
||||
);
|
||||
};
|
||||
|
78
src/desktop/checkConfig.ts
Normal file
78
src/desktop/checkConfig.ts
Normal file
@@ -0,0 +1,78 @@
|
||||
import { KintoneRestAPIClient } from '@kintone/rest-api-client';
|
||||
import i18n from 'i18next';
|
||||
import {
|
||||
type PluginConfig,
|
||||
type PluginConfigApp,
|
||||
PluginConfigDataSource,
|
||||
type PluginConfigSelf,
|
||||
} from '../common/config';
|
||||
import { DOCX_CONTENT_TYPE } from '../common/constants';
|
||||
|
||||
const checkConfigSelf = (config: PluginConfigSelf, record: kintone.types.SavedFields): string => {
|
||||
const { fieldCode } = config;
|
||||
if (fieldCode === '') {
|
||||
throw new Error(i18n.t('errors.template-field-is-required'));
|
||||
}
|
||||
const field = record[fieldCode];
|
||||
if (!field) {
|
||||
throw new Error(i18n.t('errors.template-field-is-not-available'));
|
||||
}
|
||||
if (field.type !== 'FILE') {
|
||||
throw new Error(i18n.t('errors.template-field-must-be-an-attachment-field'));
|
||||
}
|
||||
const files = Array.isArray(field.value) ? (field.value as kintone.fieldTypes.File['value']) : [];
|
||||
if (files.length === 0) {
|
||||
throw new Error(i18n.t('errors.template-field-does-not-contain-any-files'));
|
||||
}
|
||||
if (files.length > 1) {
|
||||
throw new Error(i18n.t('errors.template-field-contains-multiple-files'));
|
||||
}
|
||||
if (files[0].contentType !== DOCX_CONTENT_TYPE) {
|
||||
throw new Error(i18n.t('errors.template-file-must-be-a-docx', { contentType: files[0].contentType }));
|
||||
}
|
||||
return files[0].fileKey;
|
||||
};
|
||||
|
||||
const checkConfigApp = async (config: PluginConfigApp): Promise<string> => {
|
||||
const { appId, fieldCode, recordId } = config;
|
||||
if (appId === '') {
|
||||
throw new Error(i18n.t('errors.app-id-is-required'));
|
||||
}
|
||||
if (recordId === '') {
|
||||
throw new Error(i18n.t('errors.record-id-is-required'));
|
||||
}
|
||||
if (fieldCode === '') {
|
||||
throw new Error(i18n.t('errors.template-field-is-required'));
|
||||
}
|
||||
const client = new KintoneRestAPIClient();
|
||||
const { record } = await client.record.getRecord({ app: appId, id: recordId }).catch((_error) => {
|
||||
throw new Error(i18n.t('errors.record-is-not-available'));
|
||||
});
|
||||
const field = record[fieldCode];
|
||||
if (!field) {
|
||||
throw new Error(i18n.t('errors.template-field-is-not-available'));
|
||||
}
|
||||
if (field.type !== 'FILE') {
|
||||
throw new Error(i18n.t('errors.template-field-must-be-an-attachment-field'));
|
||||
}
|
||||
const files = Array.isArray(field.value) ? (field.value as kintone.fieldTypes.File['value']) : [];
|
||||
if (files.length === 0) {
|
||||
throw new Error(i18n.t('errors.template-field-does-not-contain-any-files'));
|
||||
}
|
||||
if (files.length > 1) {
|
||||
throw new Error(i18n.t('errors.template-field-contains-multiple-files'));
|
||||
}
|
||||
if (files[0].contentType !== DOCX_CONTENT_TYPE) {
|
||||
throw new Error(i18n.t('errors.template-file-must-be-a-docx', { contentType: files[0].contentType }));
|
||||
}
|
||||
return files[0].fileKey;
|
||||
};
|
||||
|
||||
export const checkConfig = async (config: PluginConfig, record: kintone.types.SavedFields): Promise<string> => {
|
||||
if (config.dataSource === PluginConfigDataSource.SELF) {
|
||||
return checkConfigSelf(config, record);
|
||||
} else if (config.dataSource === PluginConfigDataSource.APP) {
|
||||
return checkConfigApp(config);
|
||||
}
|
||||
throw new Error(i18n.t('errors.unexpected-error-occurred'));
|
||||
};
|
223
src/desktop/generateWordFileData.ts
Normal file
223
src/desktop/generateWordFileData.ts
Normal file
@@ -0,0 +1,223 @@
|
||||
import type { KintoneFormFieldProperty } from '@kintone/rest-api-client';
|
||||
import dayjs from 'dayjs';
|
||||
import Docxtemplater from 'docxtemplater';
|
||||
import expressionParser from 'docxtemplater/expressions';
|
||||
import PizZip from 'pizzip';
|
||||
import invariant from 'tiny-invariant';
|
||||
import { DOCX_CONTENT_TYPE } from '../common/constants';
|
||||
import type { KintoneFormFieldProperties } from '../common/types';
|
||||
|
||||
interface TemplateData {
|
||||
[key: string]: TemplateData | TemplateData[] | string | string[];
|
||||
}
|
||||
|
||||
const formatNumberValue = (value: string, digit: boolean, scale?: number): string => {
|
||||
if (value !== '' && !Number.isNaN(Number(value))) {
|
||||
const numberValue = Number(value);
|
||||
const options: Intl.NumberFormatOptions = {
|
||||
useGrouping: digit,
|
||||
};
|
||||
if (scale != null && scale >= 0) {
|
||||
options.minimumFractionDigits = scale;
|
||||
options.maximumFractionDigits = scale;
|
||||
}
|
||||
return new Intl.NumberFormat('en-US', options).format(numberValue);
|
||||
}
|
||||
return value;
|
||||
};
|
||||
|
||||
const formatValueWithUnit = (
|
||||
value: string,
|
||||
property: KintoneFormFieldProperty.Number | KintoneFormFieldProperty.Calc,
|
||||
): string => {
|
||||
if (value !== '' && property.unit !== '') {
|
||||
if (property.unitPosition === 'BEFORE') {
|
||||
return `${property.unit} ${value}`;
|
||||
} else if (property.unitPosition === 'AFTER') {
|
||||
return `${value} ${property.unit}`;
|
||||
}
|
||||
}
|
||||
return value;
|
||||
};
|
||||
|
||||
const formatNumberRecordValue = (
|
||||
value: string,
|
||||
property: KintoneFormFieldProperty.Number | KintoneFormFieldProperty.Lookup,
|
||||
): string => {
|
||||
if ('lookup' in property) {
|
||||
return value;
|
||||
}
|
||||
const scale = property.displayScale !== '' ? Number(property.displayScale) : undefined;
|
||||
const digit = property.digit ?? false;
|
||||
const formattedValue = formatNumberValue(value, digit, scale);
|
||||
return formatValueWithUnit(formattedValue, property);
|
||||
};
|
||||
|
||||
const formatCalculatedRecordValue = (
|
||||
value: string,
|
||||
property: KintoneFormFieldProperty.Calc,
|
||||
language: string,
|
||||
): string => {
|
||||
const { format } = property;
|
||||
if (value === '') {
|
||||
return '';
|
||||
}
|
||||
const scale = property.displayScale !== '' ? Number(property.displayScale) : undefined;
|
||||
let formattedValue: string;
|
||||
if (format === 'NUMBER') {
|
||||
formattedValue = formatNumberValue(value, false, scale);
|
||||
} else if (format === 'NUMBER_DIGIT') {
|
||||
formattedValue = formatNumberValue(value, true, scale);
|
||||
} else if (format === 'DATETIME') {
|
||||
// "2025-05-30T00:00:00Z" -> "2025-05-30 9:00" (browser local timezone)
|
||||
const date = new Date(value);
|
||||
invariant(!Number.isNaN(date.getTime()), `Expected value to be a valid date string, but got ${value}`);
|
||||
formattedValue = dayjs(date).format('YYYY-MM-DD h:mm');
|
||||
} else if (format === 'DATE') {
|
||||
// "2025-05-30T00:00:00Z" -> "2025-05-30" (browser local timezone)
|
||||
const date = new Date(value);
|
||||
invariant(!Number.isNaN(date.getTime()), `Expected value to be a valid date string, but got ${value}`);
|
||||
formattedValue = dayjs(date).format('YYYY-MM-DD');
|
||||
} else if (format === 'TIME') {
|
||||
// "00:30" -> "0:30"
|
||||
const [hours, minutes] = value.split(':').map((v) => Number(v));
|
||||
invariant(
|
||||
!Number.isNaN(hours) && !Number.isNaN(minutes),
|
||||
`Expected hours and minutes to be numbers, but got hours: ${hours}, minutes: ${minutes}`,
|
||||
);
|
||||
formattedValue = `${hours}:${String(minutes).padStart(2, '0')}`;
|
||||
} else if (format === 'HOUR_MINUTE') {
|
||||
// "49:30" -> en:"49 hours 30 minutes", ja: "49時間30分"
|
||||
const [hours, minutes] = value.split(':').map((v) => Number(v));
|
||||
invariant(
|
||||
!Number.isNaN(hours) && !Number.isNaN(minutes),
|
||||
`Expected hours and minutes to be numbers, but got hours: ${hours}, minutes: ${minutes}`,
|
||||
);
|
||||
formattedValue = language === 'ja' ? `${hours}時間${minutes}分` : `${hours} hours ${minutes} minutes`;
|
||||
} else if (format === 'DAY_HOUR_MINUTE') {
|
||||
// "49:30" -> en: "2 days 1 hour 30 minutes", ja: "2日1時間30分
|
||||
const [hours, minutes] = value.split(':').map((v) => Number(v));
|
||||
invariant(
|
||||
!Number.isNaN(hours) && !Number.isNaN(minutes),
|
||||
`Expected hours and minutes to be numbers, but got hours: ${hours}, minutes: ${minutes}`,
|
||||
);
|
||||
const days = Math.floor(Number(hours) / 24);
|
||||
const remainingHours = Number(hours) % 24;
|
||||
formattedValue =
|
||||
language === 'ja'
|
||||
? `${days}日${remainingHours}時間${minutes}分`
|
||||
: `${days} days ${remainingHours} hours ${minutes} minutes`;
|
||||
} else {
|
||||
// DATETIME, DATE, TIME
|
||||
formattedValue = value;
|
||||
}
|
||||
return formatValueWithUnit(formattedValue, property);
|
||||
};
|
||||
|
||||
const record2templateData = (
|
||||
properties: KintoneFormFieldProperties,
|
||||
record: Partial<kintone.types.AllFields>,
|
||||
language: string,
|
||||
): TemplateData => {
|
||||
const data: TemplateData = {};
|
||||
for (const key in record) {
|
||||
// biome-ignore lint/suspicious/noPrototypeBuiltins: avoid prototype pollution
|
||||
if (Object.prototype.hasOwnProperty.call(record, key) && Object.prototype.hasOwnProperty.call(properties, key)) {
|
||||
const item = record[key];
|
||||
const property = properties[key];
|
||||
if (item == null) continue;
|
||||
const { type, value } = item;
|
||||
if (value == null) {
|
||||
data[key] = '';
|
||||
} else if (type === 'CREATOR' || type === 'MODIFIER') {
|
||||
data[key] = {
|
||||
name: value.name,
|
||||
code: value.code,
|
||||
};
|
||||
} else if (type === 'NUMBER') {
|
||||
invariant(property.type === 'NUMBER', `Expected property type to be NUMBER, but got ${property.type}`);
|
||||
data[key] = formatNumberRecordValue(value, property);
|
||||
} else if (type === 'CALC') {
|
||||
invariant(property.type === 'CALC', `Expected property type to be CALC, but got ${property.type}`);
|
||||
data[key] = formatCalculatedRecordValue(value, property, language);
|
||||
} else if (type === 'CHECK_BOX' || type === 'MULTI_SELECT' || type === 'CATEGORY') {
|
||||
data[key] = value.map((v) => v);
|
||||
} else if (
|
||||
type === 'USER_SELECT' ||
|
||||
type === 'ORGANIZATION_SELECT' ||
|
||||
type === 'GROUP_SELECT' ||
|
||||
type === 'STATUS_ASSIGNEE'
|
||||
) {
|
||||
data[key] = value.map((v) => {
|
||||
return { name: v.name, code: v.code };
|
||||
});
|
||||
} else if (type === 'SUBTABLE') {
|
||||
invariant(property.type === 'SUBTABLE', `Expected property type to be SUBTABLE, but got ${property.type}`);
|
||||
data[key] = value.map((subRecord) => record2templateData(property.fields, subRecord.value, language));
|
||||
} else if (type === 'FILE') {
|
||||
invariant(property.type === 'FILE', `Expected property type to be FILE, but got ${property.type}`);
|
||||
data[key] = value.map((file) => ({
|
||||
name: file.name,
|
||||
size: file.size,
|
||||
contentType: file.contentType,
|
||||
fileKey: file.fileKey,
|
||||
}));
|
||||
} else {
|
||||
// RECORD_NUMBER, __ID__, __REVISION__, CREATED_TIME, UPDATED_TIME
|
||||
// SINGLE_LINE_TEXT, MULTI_LINE_TEXT, RICH_TEXT, RADIO_BUTTON, DROP_DOWN, DATE, TIME, DATETIME, LINK, STATUS
|
||||
data[key] = value;
|
||||
}
|
||||
}
|
||||
}
|
||||
return data;
|
||||
};
|
||||
|
||||
const generateWordFileData = (
|
||||
content: ArrayBuffer,
|
||||
properties: KintoneFormFieldProperties,
|
||||
record: kintone.types.AllFields,
|
||||
language: string,
|
||||
) => {
|
||||
const zip = new PizZip(content);
|
||||
const parser = expressionParser.configure({
|
||||
filters: {
|
||||
toUpperCase: (str: string): string => str.toUpperCase(),
|
||||
toLowerCase: (str: string): string => str.toLowerCase(),
|
||||
regexMatch: (str: string, regex: string): boolean | string[] => {
|
||||
const pattern = new RegExp(regex);
|
||||
return pattern.test(str);
|
||||
},
|
||||
regexFilter: (arr: string[], regex: string): string[] => {
|
||||
const pattern = new RegExp(regex);
|
||||
if (Array.isArray(arr)) {
|
||||
return arr.filter((item) => pattern.test(item));
|
||||
}
|
||||
return [];
|
||||
},
|
||||
includes: (arr: string[] | string, str: string): boolean => {
|
||||
if (Array.isArray(arr)) {
|
||||
return arr.includes(str);
|
||||
} else {
|
||||
return arr === str;
|
||||
}
|
||||
},
|
||||
indexOf: (arr: string[] | string, str: string): number => {
|
||||
if (Array.isArray(arr)) {
|
||||
return arr.indexOf(str);
|
||||
} else {
|
||||
return arr === str ? 0 : -1;
|
||||
}
|
||||
},
|
||||
},
|
||||
});
|
||||
const doc = new Docxtemplater(zip, {
|
||||
paragraphLoop: true,
|
||||
linebreaks: true,
|
||||
parser: parser,
|
||||
nullGetter: () => '',
|
||||
});
|
||||
doc.render(record2templateData(properties, record, language));
|
||||
return doc.getZip().generate({ type: 'blob', mimeType: DOCX_CONTENT_TYPE });
|
||||
};
|
||||
|
||||
export default generateWordFileData;
|
27
src/desktop/i18n.ts
Normal file
27
src/desktop/i18n.ts
Normal file
@@ -0,0 +1,27 @@
|
||||
import i18n from 'i18next';
|
||||
import { initReactI18next } from 'react-i18next';
|
||||
import kintoneLanguageDetector from '../common/kintoneLanguageDetector';
|
||||
|
||||
import enTranslation from './locales/en.json';
|
||||
import jaTranslation from './locales/ja.json';
|
||||
|
||||
i18n
|
||||
.use(kintoneLanguageDetector)
|
||||
.use(initReactI18next)
|
||||
.init({
|
||||
fallbackLng: 'en',
|
||||
// debug: true,
|
||||
interpolation: {
|
||||
escapeValue: false, // not needed for react as it escapes by default
|
||||
},
|
||||
resources: {
|
||||
en: {
|
||||
translation: enTranslation,
|
||||
},
|
||||
ja: {
|
||||
translation: jaTranslation,
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
export default i18n;
|
@@ -1,32 +1,35 @@
|
||||
import React from 'react';
|
||||
|
||||
import ReactDOM from 'react-dom/client';
|
||||
import invariant from 'tiny-invariant';
|
||||
import DesktopApp from './DesktopApp';
|
||||
|
||||
import '../common/ui/51-modern-default.css';
|
||||
|
||||
kintone.events.on(
|
||||
['app.record.detail.show', 'mobile.app.record.detail.show'],
|
||||
async (event: kintone.events.AppRecordDetailShowEvent | kintone.events.MobileAppRecordDetailShowEvent) => {
|
||||
const spaceElement =
|
||||
event.type === 'app.record.detail.show'
|
||||
? kintone.app.record.getHeaderMenuSpaceElement()
|
||||
: kintone.mobile.app.getHeaderSpaceElement();
|
||||
invariant(
|
||||
spaceElement,
|
||||
'The header menu space element is not available. Please ensure you are on a Kintone app record detail page.',
|
||||
);
|
||||
import './i18n';
|
||||
|
||||
const root = document.createElement('div');
|
||||
spaceElement.appendChild(root);
|
||||
((PLUGIN_ID) => {
|
||||
kintone.events.on(
|
||||
['app.record.detail.show', 'mobile.app.record.detail.show'],
|
||||
async (event: kintone.events.AppRecordDetailShowEvent | kintone.events.MobileAppRecordDetailShowEvent) => {
|
||||
const spaceElement =
|
||||
event.type === 'app.record.detail.show'
|
||||
? kintone.app.record.getHeaderMenuSpaceElement()
|
||||
: kintone.mobile.app.getHeaderSpaceElement();
|
||||
invariant(
|
||||
spaceElement,
|
||||
'The header menu space element is not available. Please ensure you are on a Kintone app record detail page.',
|
||||
);
|
||||
|
||||
ReactDOM.createRoot(root).render(
|
||||
<React.StrictMode>
|
||||
<DesktopApp event={event} />
|
||||
</React.StrictMode>,
|
||||
);
|
||||
const root = document.createElement('div');
|
||||
spaceElement.appendChild(root);
|
||||
|
||||
return event;
|
||||
},
|
||||
);
|
||||
ReactDOM.createRoot(root).render(
|
||||
<React.StrictMode>
|
||||
<DesktopApp pluginId={PLUGIN_ID} event={event} />
|
||||
</React.StrictMode>,
|
||||
);
|
||||
|
||||
return event;
|
||||
},
|
||||
);
|
||||
})(kintone.$PLUGIN_ID);
|
||||
|
18
src/desktop/locales/en.json
Normal file
18
src/desktop/locales/en.json
Normal file
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"name": "Word output plugin",
|
||||
"errors": {
|
||||
"template-field-is-required": "The template field is not configured. Please check the plugin settings.",
|
||||
"template-field-is-not-available": "The template field is not available. Please check the plugin settings.",
|
||||
"template-field-must-be-an-attachment-field": "The template field must be an attachment field. Please check the plugin settings.",
|
||||
"template-field-does-not-contain-any-files": "The template field does not contain any files.",
|
||||
"template-field-contains-multiple-files": "The template field contains multiple files. Please attach only one file.",
|
||||
"template-file-must-be-a-docx": "The template file must be a Word (.docx) file. 'Mime-Type: {{contentType}}'.",
|
||||
"app-id-is-required": "The app ID for the template file is required. Please check the plugin settings.",
|
||||
"record-id-is-required": "The record ID for the template file is required. Please check the plugin settings.",
|
||||
"record-is-not-available": "The record is not available. Please check the plugin settings.",
|
||||
"unexpected-error-occurred": "An unexpected error occurred."
|
||||
},
|
||||
"buttons": {
|
||||
"output": "Output Word"
|
||||
}
|
||||
}
|
18
src/desktop/locales/ja.json
Normal file
18
src/desktop/locales/ja.json
Normal file
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"name": "Word出力プラグイン",
|
||||
"errors": {
|
||||
"template-field-is-required": "雛形ファイルが設定されていません。プラグインの設定を見直してください。",
|
||||
"template-field-is-not-available": "雛形ファイルに設定された添付ファイルフィールドが見つかりませんでした。プラグインの設定を見直してください。",
|
||||
"template-field-must-be-an-attachment-field": "雛形ファイルに設定されたフィールド型が添付ファイルフィールドではありません。プラグインの設定を見直してください。",
|
||||
"template-field-does-not-contain-any-files": "雛形ファイルが添付されていません。",
|
||||
"template-field-contains-multiple-files": "雛形ファイルとして複数のファイルが添付されています。1つだけ添付してください。",
|
||||
"template-file-must-be-a-docx": "雛形ファイルがWord形式(.docx)ではありません。'Mime-Type: {{contentType}}'",
|
||||
"app-id-is-required": "雛形ファイルを格納するアプリIDが設定されていません。プラグインの設定を見直してください。",
|
||||
"record-id-is-required": "雛形ファイルを格納するアプリのレコードIDが設定されていません。プラグインの設定を見直してください。",
|
||||
"record-is-not-available": "雛形ファイルを格納されたアプリのレコードが取得できません。プラグインの設定を見直してください。",
|
||||
"unexpected-error-occurred": "予期しないエラーが発生しました。"
|
||||
},
|
||||
"buttons": {
|
||||
"output": "Word出力"
|
||||
}
|
||||
}
|
17
src/kintone-env.d.ts
vendored
17
src/kintone-env.d.ts
vendored
@@ -1,17 +0,0 @@
|
||||
/// <reference types="@shin-chan/kypes" />
|
||||
|
||||
// CSS modules
|
||||
type CSSModuleClasses = { readonly [key: string]: string };
|
||||
|
||||
declare module '*.module.css' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.scss' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
|
||||
// CSS
|
||||
declare module '*.css' {}
|
||||
declare module '*.scss' {}
|
93
src/types/css-modules.d.ts
vendored
Normal file
93
src/types/css-modules.d.ts
vendored
Normal file
@@ -0,0 +1,93 @@
|
||||
// CSS modules
|
||||
type CSSModuleClasses = { readonly [key: string]: string };
|
||||
|
||||
declare module '*.module.css' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.scss' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.sass' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.less' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.styl' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.stylus' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.pcss' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.sss' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
|
||||
// CSS
|
||||
declare module '*.css' {
|
||||
/**
|
||||
* @deprecated Use `import style from './style.css?inline'` instead.
|
||||
*/
|
||||
const css: string;
|
||||
export default css;
|
||||
}
|
||||
declare module '*.scss' {
|
||||
/**
|
||||
* @deprecated Use `import style from './style.scss?inline'` instead.
|
||||
*/
|
||||
const css: string;
|
||||
export default css;
|
||||
}
|
||||
declare module '*.sass' {
|
||||
/**
|
||||
* @deprecated Use `import style from './style.sass?inline'` instead.
|
||||
*/
|
||||
const css: string;
|
||||
export default css;
|
||||
}
|
||||
declare module '*.less' {
|
||||
/**
|
||||
* @deprecated Use `import style from './style.less?inline'` instead.
|
||||
*/
|
||||
const css: string;
|
||||
export default css;
|
||||
}
|
||||
declare module '*.styl' {
|
||||
/**
|
||||
* @deprecated Use `import style from './style.styl?inline'` instead.
|
||||
*/
|
||||
const css: string;
|
||||
export default css;
|
||||
}
|
||||
declare module '*.stylus' {
|
||||
/**
|
||||
* @deprecated Use `import style from './style.stylus?inline'` instead.
|
||||
*/
|
||||
const css: string;
|
||||
export default css;
|
||||
}
|
||||
declare module '*.pcss' {
|
||||
/**
|
||||
* @deprecated Use `import style from './style.pcss?inline'` instead.
|
||||
*/
|
||||
const css: string;
|
||||
export default css;
|
||||
}
|
||||
declare module '*.sss' {
|
||||
/**
|
||||
* @deprecated Use `import style from './style.sss?inline'` instead.
|
||||
*/
|
||||
const css: string;
|
||||
export default css;
|
||||
}
|
30
src/types/cybozu.d.ts
vendored
Normal file
30
src/types/cybozu.d.ts
vendored
Normal file
@@ -0,0 +1,30 @@
|
||||
declare namespace cybozu.data {
|
||||
namespace types {
|
||||
type SchemaDataField = {
|
||||
id: string;
|
||||
label: string; // field name
|
||||
properties: Record<string, string>;
|
||||
type: string;
|
||||
var: string; // field code
|
||||
};
|
||||
type SchemaDataTable = cybozu.data.types.SchemaDataField & {
|
||||
fieldList: Record<string, cybozu.data.types.SchemaDataField>;
|
||||
};
|
||||
type SchemaDataSubtable = Record<string, cybozu.data.types.SchemaDataTable>;
|
||||
type SchemaDataGroups = Array<{
|
||||
table: cybozu.data.types.SchemaDataTable;
|
||||
subTable: cybozu.data.types.SchemaDataSubtable;
|
||||
}>;
|
||||
type SchemaData = {
|
||||
groups: cybozu.data.types.SchemaDataGroups;
|
||||
revision: string;
|
||||
table: cybozu.data.types.SchemaDataTable;
|
||||
subTable: cybozu.data.types.SchemaDataSubtable;
|
||||
};
|
||||
}
|
||||
namespace page {
|
||||
const FORM_DATA: {
|
||||
schema: cybozu.data.types.SchemaData;
|
||||
};
|
||||
}
|
||||
}
|
117
src/types/kintone.d.ts
vendored
Normal file
117
src/types/kintone.d.ts
vendored
Normal file
@@ -0,0 +1,117 @@
|
||||
declare namespace kintone {
|
||||
namespace fieldTypes {
|
||||
interface Category {
|
||||
type?: 'CATEGORY';
|
||||
value: Array<string>;
|
||||
}
|
||||
interface Status {
|
||||
type?: 'STATUS';
|
||||
value: string;
|
||||
}
|
||||
interface StatusAssignee {
|
||||
type?: 'STATUS_ASSIGNEE';
|
||||
value: kintone.fieldTypes.UserSelect['value'];
|
||||
}
|
||||
type InSubtableFieldTypes =
|
||||
| kintone.fieldTypes.SingleLineText
|
||||
| kintone.fieldTypes.RichText
|
||||
| kintone.fieldTypes.MultiLineText
|
||||
| kintone.fieldTypes.Number
|
||||
| kintone.fieldTypes.Calc
|
||||
| kintone.fieldTypes.RadioButton
|
||||
| kintone.fieldTypes.DropDown
|
||||
| kintone.fieldTypes.Date
|
||||
| kintone.fieldTypes.Time
|
||||
| kintone.fieldTypes.DateTime
|
||||
| kintone.fieldTypes.Link
|
||||
| kintone.fieldTypes.CheckBox
|
||||
| kintone.fieldTypes.MultiSelect
|
||||
| kintone.fieldTypes.UserSelect
|
||||
| kintone.fieldTypes.OrganizationSelect
|
||||
| kintone.fieldTypes.GroupSelect
|
||||
| kintone.fieldTypes.File;
|
||||
type SystemFieldTypes =
|
||||
| kintone.fieldTypes.Id
|
||||
| kintone.fieldTypes.Revision
|
||||
| kintone.fieldTypes.Modifier
|
||||
| kintone.fieldTypes.Creator
|
||||
| kintone.fieldTypes.RecordNumber
|
||||
| kintone.fieldTypes.UpdatedTime
|
||||
| kintone.fieldTypes.CreatedTime;
|
||||
type SubtableValueItem<T extends string> = {
|
||||
id: string;
|
||||
value: Record<T, kintone.fieldTypes.InSubtableFieldTypes>;
|
||||
};
|
||||
type Subtable<T extends string> = {
|
||||
type: 'SUBTABLE';
|
||||
value: Array<kintone.fieldTypes.SubtableValueItem<T>>;
|
||||
};
|
||||
type ExtraFieldTypes = kintone.fieldTypes.Category | kintone.fieldTypes.Status | kintone.fieldTypes.StatusAssignee;
|
||||
type GenericFieldTypes = kintone.fieldTypes.InSubtableFieldTypes | kintone.fieldTypes.Subtable<string>;
|
||||
type GenericSavedFieldTypes = kintone.fieldTypes.GenericFieldTypes | kintone.fieldTypes.SystemFieldTypes;
|
||||
type AllFieldTypes = kintone.fieldTypes.GenericSavedFieldTypes | kintone.fieldTypes.ExtraFieldTypes;
|
||||
}
|
||||
|
||||
namespace types {
|
||||
type GenericFields = Record<string, kintone.fieldTypes.GenericFieldTypes>;
|
||||
type GenericSavedFields = Record<string, kintone.fieldTypes.GenericSavedFieldTypes>;
|
||||
type AllFields = Record<string, kintone.fieldTypes.AllFieldTypes>;
|
||||
|
||||
type Fields = kintone.types.GenericFields;
|
||||
type SavedFields = kintone.types.GenericSavedFields;
|
||||
}
|
||||
|
||||
namespace events {
|
||||
interface AppRecordIndexEditShowEvent {
|
||||
type: 'app.record.index.edit.show';
|
||||
appId: number;
|
||||
recordId: number;
|
||||
record: kintone.types.SavedFields;
|
||||
}
|
||||
interface AppRecordCreateShowEvent {
|
||||
type: 'app.record.create.show';
|
||||
appId: number;
|
||||
record: kintone.types.Fields;
|
||||
reuse: boolean;
|
||||
}
|
||||
interface AppRecordEditShowEvent {
|
||||
type: 'app.record.edit.show';
|
||||
appId: number;
|
||||
recordId: number;
|
||||
record: kintone.types.SavedFields;
|
||||
}
|
||||
interface AppRecordDetailShowEvent {
|
||||
type: 'app.record.detail.show';
|
||||
appId: number;
|
||||
recordId: number;
|
||||
record: kintone.types.SavedFields;
|
||||
}
|
||||
interface MobileAppRecordDetailShowEvent {
|
||||
type: 'mobile.app.record.detail.show';
|
||||
appId: number;
|
||||
recordId: number;
|
||||
record: kintone.types.SavedFields;
|
||||
}
|
||||
}
|
||||
|
||||
namespace app {
|
||||
function getFormFields(): Promise<unknown>;
|
||||
function getFormLayout(): Promise<unknown>;
|
||||
}
|
||||
|
||||
function proxy(
|
||||
url: string,
|
||||
method: string,
|
||||
headers: Record<string, string>,
|
||||
data: Record<string, unknown> | string,
|
||||
): Promise<[string, number, Record<string, string>]>;
|
||||
|
||||
function proxy(
|
||||
url: string,
|
||||
method: string,
|
||||
headers: Record<string, string>,
|
||||
data: Record<string, unknown> | string,
|
||||
callback: (resp: [string, number, Record<string, string>]) => void,
|
||||
errback: (err: Error) => void,
|
||||
): void;
|
||||
}
|
@@ -1,73 +1,29 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
/* Visit https://aka.ms/tsconfig.json to read more about this file */
|
||||
"lib": ["DOM", "ES2020"],
|
||||
"jsx": "react-jsx",
|
||||
"target": "ES2020",
|
||||
"noEmit": true,
|
||||
"skipLibCheck": true,
|
||||
"useDefineForClassFields": true,
|
||||
|
||||
/* Basic Options */
|
||||
// "incremental": true, /* Enable incremental compilation */
|
||||
"target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
|
||||
"module": "es2015", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
|
||||
"lib": ["dom", "es2020"], /* Specify library files to be included in the compilation. */
|
||||
// "allowJs": true, /* Allow javascript files to be compiled. */
|
||||
// "checkJs": true, /* Report errors in .js files. */
|
||||
"jsx": "react", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
|
||||
// "declaration": true, /* Generates corresponding '.d.ts' file. */
|
||||
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
|
||||
// "sourceMap": true, /* Generates corresponding '.map' file. */
|
||||
// "outFile": "./", /* Concatenate and emit output to single file. */
|
||||
"outDir": "./plugin", /* Redirect output structure to the directory. */
|
||||
"rootDir": "./src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
|
||||
// "composite": true, /* Enable project compilation */
|
||||
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
|
||||
// "removeComments": true, /* Do not emit comments to output. */
|
||||
// "noEmit": true, /* Do not emit outputs. */
|
||||
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
|
||||
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
|
||||
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
|
||||
/* modules */
|
||||
"module": "ESNext",
|
||||
"resolveJsonModule": true,
|
||||
"moduleResolution": "bundler",
|
||||
"esModuleInterop": true,
|
||||
"allowImportingTsExtensions": true,
|
||||
|
||||
/* Strict Type-Checking Options */
|
||||
"strict": true, /* Enable all strict type-checking options. */
|
||||
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
|
||||
// "strictNullChecks": true, /* Enable strict null checks. */
|
||||
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
|
||||
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
|
||||
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
|
||||
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
|
||||
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
|
||||
|
||||
/* Additional Checks */
|
||||
// "noUnusedLocals": true, /* Report errors on unused locals. */
|
||||
// "noUnusedParameters": true, /* Report errors on unused parameters. */
|
||||
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
|
||||
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
|
||||
|
||||
/* Module Resolution Options */
|
||||
"moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
|
||||
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
|
||||
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
|
||||
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
|
||||
// "typeRoots": [], /* List of folders to include type definitions from. */
|
||||
// "types": [], /* Type declaration files to be included in compilation. */
|
||||
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
|
||||
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
|
||||
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
|
||||
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
|
||||
|
||||
/* Source Map Options */
|
||||
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
|
||||
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
|
||||
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
|
||||
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
|
||||
|
||||
/* Experimental Options */
|
||||
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
|
||||
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
|
||||
|
||||
/* Advanced Options */
|
||||
"skipLibCheck": true, /* Skip type checking of declaration files. */
|
||||
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
|
||||
/* type checking */
|
||||
"strict": true,
|
||||
"noUnusedLocals": true,
|
||||
"noUnusedParameters": true
|
||||
},
|
||||
"include": [
|
||||
"src/**/*",
|
||||
"./node_modules/@kintone/dts-gen/kintone.d.ts"
|
||||
]
|
||||
"files": ["./node_modules/@kintone/dts-gen/kintone.d.ts"],
|
||||
"include": ["src/**/*"],
|
||||
"ts-node": {
|
||||
"compilerOptions": {
|
||||
"module": "CommonJS"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
Reference in New Issue
Block a user