8 Commits

Author SHA1 Message Date
5f18c0b791 chore: update dependencies in package-lock.json for improved stability and security 2025-10-02 13:28:21 +09:00
94b7277b3a feat: Upgrade plugin version to 2.0.0 and refactor configuration handling
- Updated version numbers in package.json, package-lock.json, and manifest.json to 2.0.0.
- Refactored configuration types to use data sources (SELF, APP) instead of type-based configurations.
- Enhanced settings UI to allow selection between using the current record or another app's record.
- Improved error handling and validation for configuration settings.
- Added new input component for better handling of text inputs in settings.
- Updated localization files for new settings structure and error messages.
- Optimized API calls with memoization for fetching form field properties and checking configurations.
2025-10-02 13:26:46 +09:00
99251b4748 refactor: enhance configuration handling and error checking for template fields in the Word output plugin 2025-10-02 13:26:13 +09:00
b1540e8374 refactor: update type definitions for Kintone fields to improve type safety and clarity 2025-09-30 22:21:03 +09:00
a396952331 refactor: update VSCode configurations and scripts for improved compatibility and performance 2025-09-30 21:45:50 +09:00
43a55bbb2b refactor: streamline MenuPanel by removing unused functions and introducing generateWordFileData for DOCX generation 2025-09-30 21:08:06 +09:00
db4e21607e removed dependency of @shin-chan/kypes. 2025-09-30 19:56:15 +09:00
c8a2c8087a introduce biome instead of prettier and eslint. 2025-09-30 19:14:47 +09:00
46 changed files with 3192 additions and 1198 deletions

View File

@@ -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"
]
}

View File

@@ -1,8 +0,0 @@
{
"$schema": "https://json.schemastore.org/prettierrc",
"semi": true,
"tabWidth": 2,
"singleQuote": true,
"printWidth": 120,
"trailingComma": "all"
}

View File

@@ -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
View File

@@ -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
View 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"
}
}
}
}

View File

@@ -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: ['/'] }],
},
},
];

2905
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,6 +1,6 @@
{
"name": "kintone-plugin-docx",
"version": "1.0.2",
"version": "2.0.0",
"scripts": {
"gen": "run-s gen:*",
"gen:key": "node scripts/generate-private-key.js",
@@ -10,45 +10,45 @@
"prebuild:prod": "npm run gen",
"build": "cross-env NODE_ENV=development rspack build",
"build:prod": "cross-env NODE_ENV=production rspack build",
"lint": "eslint src --ext .js,.jsx,.ts,.tsx",
"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.5.0",
"@kintone/rest-api-client": "^5.7.5",
"angular-expressions": "^1.5.1",
"clsx": "^2.1.1",
"dayjs": "^1.11.13",
"docxtemplater": "^3.65.1",
"dayjs": "^1.11.18",
"docxtemplater": "^3.66.4",
"file-saver": "^2.0.5",
"i18next": "^25.3.0",
"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": "^15.6.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.4.3",
"@rspack/core": "^1.4.3",
"@shin-chan/kypes": "^0.0.7",
"@rspack/cli": "^1.5.8",
"@rspack/core": "^1.5.8",
"@types/file-saver": "^2.0.7",
"@types/node": "^24.0.10",
"@types/react": "^19.1.8",
"@types/react-dom": "^19.1.6",
"cross-env": "^7.0.3",
"env-cmd": "^10.1.0",
"eslint": "^9.30.1",
"eslint-plugin-react": "^7.37.5",
"globals": "^16.3.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.6.2",
"ts-node": "^10.9.2",
"typescript": "^5.8.3"
"typescript": "^5.9.3"
}
}

View File

@@ -1,7 +1,7 @@
{
"$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.2",
"version": "2.0.0",
"type": "APP",
"desktop": {
"js": ["js/desktop.js"],
@@ -15,8 +15,7 @@
"config": {
"html": "html/config.html",
"js": ["js/config.js"],
"css": ["js/config.css"],
"required_params": ["template"]
"css": ["js/config.css"]
},
"name": {
"en": "Word output plugin",

View File

@@ -17,12 +17,12 @@ export default defineConfig({
filename: '[name].js',
},
resolve: {
extensions: ['...', '.ts', '.tsx', '.jsx'],
extensions: ['...', '.ts', '.tsx'],
},
module: {
rules: [
{
test: /\.(jsx?|tsx?)$/,
test: /\.(tsx?)$/,
use: [
{
loader: 'builtin:swc-loader',
@@ -64,7 +64,6 @@ export default defineConfig({
css: true,
},
performance: {
maxEntrypointSize: 1024000,
maxAssetSize: 1024000,
hints: false,
},
});

View File

@@ -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';

View File

@@ -1,6 +1,3 @@
/* eslint-env node */
'use strict';
const runAll = require('npm-run-all');
runAll(['develop', 'upload'], {

View File

@@ -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;

View File

@@ -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;

View File

@@ -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
View 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 || '' };
};

View File

@@ -1,4 +1,4 @@
import { LanguageDetectorModule } from 'i18next';
import type { LanguageDetectorModule } from 'i18next';
const KintoneLanguageDetector: LanguageDetectorModule = {
type: 'languageDetector',

View File

@@ -1,4 +1,4 @@
import { KintoneFormFieldProperty } from '@kintone/rest-api-client';
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

View File

@@ -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;

View File

@@ -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;

View File

@@ -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;

View 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;

View File

@@ -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;

View File

@@ -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;

View File

@@ -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;

View File

@@ -1,6 +1,5 @@
import React from 'react';
import clsx from 'clsx';
import React from 'react';
export type KintonePluginSelectOptionData = {
value: string;

View File

@@ -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;

View File

@@ -1,20 +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';
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 pluginId={pluginId} />
<Settings pluginId={pluginId} appId={appId} propertiesPromise={propertiesPromise} />
</React.Suspense>
</ErrorBoundary>
);

View File

@@ -1,3 +1,10 @@
.settings .app {
display: flex;
gap: 2em;
align-items: center;
margin-bottom: 1em;
}
.buttons > *:not(:last-child) {
margin-right: 0.5em;
}

View File

@@ -1,86 +1,176 @@
import React from 'react';
import { KintoneRestAPIClient } from '@kintone/rest-api-client';
import moize from 'moize';
import { useTranslation } from 'react-i18next';
import invariant from 'tiny-invariant';
import type { PluginConfig } from '../common/config';
import { loadConfig, PluginConfigDataSource, saveConfig } from '../common/config';
import { naturalCompare } from '../common/stringUtils';
import { KintoneFormFieldProperties } from '../common/types';
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, preview: true });
return properties;
});
interface SettingsProps {
pluginId: string;
appId: number;
propertiesPromise: Promise<KintoneFormFieldProperties>;
}
const Settings: React.FC<SettingsProps> = (props) => {
const { pluginId } = props;
const { pluginId, appId, propertiesPromise } = props;
const { t } = useTranslation();
const config = kintone.plugin.app.getConfig(pluginId);
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 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: t('settings.template.messages.select-an-attachment-fields'), 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 }, () => {
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">
<div className={styles.settings}>
<KintonePluginLabel>{t('title')}</KintonePluginLabel>
<form onSubmit={handleOnSubmit}>
<KintonePluginRow>
<KintonePluginTitle>
{t('settings.template.title')}
{t('settings.datasource.title')}
<KintonePluginRequire>*</KintonePluginRequire>
</KintonePluginTitle>
<KintonePluginDesc> {t('settings.template.description')}</KintonePluginDesc>
<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.template.errors.no-attachment-field-found')}</KintonePluginAlert>
<KintonePluginAlert>{t('settings.self.errors.no-attachment-field-found')}</KintonePluginAlert>
) : (
<KintonePluginSelect value={template} onChange={handleOnChangeTemplate} options={options} />
<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}>
{t('buttons.cancel')}
@@ -90,7 +180,7 @@ const Settings: React.FC<SettingsProps> = (props) => {
</KintonePluginButton>
</KintonePluginRow>
</form>
</section>
</div>
);
};
export default Settings;

View File

@@ -1,5 +1,4 @@
import React from 'react';
import ReactDOM from 'react-dom/client';
import invariant from 'tiny-invariant';
import ConfigApp from './ConfigApp';

View File

@@ -1,15 +1,32 @@
{
"title": "Settings for the Kintone Word output plugin",
"settings": {
"template": {
"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 a attachment field that contains the Word template file.",
"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": {

View File

@@ -1,7 +1,15 @@
{
"title": "Word出力プラグイン設定",
"settings": {
"template": {
"datasource": {
"title": "WORD雛形ファイルのデータソース選択",
"description": "WORD雛形ファイルのデータソースを選択してください。",
"labels": {
"self": "自レコード",
"app": "他アプリのレコード"
}
},
"self": {
"title": "雛形ファイル",
"description": "Word雛形ファイルを保存する添付ファイルフィールドを選択してください。",
"messages": {
@@ -10,6 +18,15 @@
"errors": {
"no-attachment-field-found": "このアプリに添付ファイルフィールドが見つかりません。フォームに添付ファイルフィールドを追加してください。"
}
},
"app": {
"title": "他アプリの添付ファイル情報",
"description": "アプリID・レコード番号・添付ファイルフィールドコードを入力してください。",
"labels": {
"app-id": "アプリID",
"record-id": "レコード番号",
"field-code": "添付ファイルフィールドコード"
}
}
},
"buttons": {

View File

@@ -1,8 +1,12 @@
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 {
@@ -10,12 +14,34 @@ interface DesktopAppProps {
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 { 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 pluginId={pluginId} event={event} />
<MenuPanel
pluginId={pluginId}
event={event}
propertiesPromise={propertiesPromise}
fileKeyPromise={fileKeyPromise}
/>
</React.Suspense>
</ErrorBoundary>
);

View File

@@ -1,248 +1,24 @@
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 { 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 { useTranslation } from 'react-i18next';
import invariant from 'tiny-invariant';
import { DOCX_CONTENT_TYPE } from '../common/constants';
import { KintoneFormFieldProperties } from '../common/types';
import KintonePluginAlert from '../common/ui/KintonePluginAlert';
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, 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,
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(!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>,
language: string,
): 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, 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) => record2data(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 MenuPanel: React.FC<MenuPanelProps> = (props) => {
const { pluginId, event } = props;
const { event, propertiesPromise, fileKeyPromise } = props;
const { t } = useTranslation();
const appId = event.appId;
const properties = React.use(cachedFormFieldsProperties(appId));
const language = kintone.getLoginUser().language;
const config = kintone.plugin.app.getConfig(pluginId);
const template: string = config.template ?? '';
if (template === '') {
return (
<KintonePluginAlert>
{t('name')}: {t('errors.template-field-is-not-set')}
</KintonePluginAlert>
);
}
const record = event.record[template];
if (record == null) {
return (
<KintonePluginAlert>
{t('name')}: {t('errors.template-field-is-not-available')}
</KintonePluginAlert>
);
}
if (record.type !== 'FILE') {
return (
<KintonePluginAlert>
{t('name')}: {t('errors.template-field-must-be-an-attachment-field')}
</KintonePluginAlert>
);
}
if (record.value.length === 0) {
return (
<KintonePluginAlert>
{t('name')}: {t('errors.template-field-does-not-contain-any-files')}
</KintonePluginAlert>
);
}
if (record.value.length > 1) {
return (
<KintonePluginAlert>
{t('name')}: {t('errors.template-field-contains-multiple-files')}
</KintonePluginAlert>
);
}
const { fileKey, contentType } = record.value[0];
if (contentType !== DOCX_CONTENT_TYPE) {
return (
<KintonePluginAlert>
{t('name')}: {t('errors.template-file-must-be-a-docx', { contentType })}
</KintonePluginAlert>
);
}
const properties = React.use(propertiesPromise);
const fileKey = React.use(fileKeyPromise);
const handleOnClickOutputButton = (e: React.MouseEvent<HTMLButtonElement>) => {
e.preventDefault();
@@ -250,15 +26,7 @@ const MenuPanel: React.FC<MenuPanelProps> = (props) => {
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, language));
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) => {

View 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'));
};

View 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;

View File

@@ -1,5 +1,4 @@
import React from 'react';
import ReactDOM from 'react-dom/client';
import invariant from 'tiny-invariant';
import DesktopApp from './DesktopApp';

View File

@@ -1,12 +1,16 @@
{
"name": "Word output plugin",
"errors": {
"template-field-is-not-set": "Template field is not set. Please configure the plugin.",
"template-field-is-not-available": "Template field is not available in this app.",
"template-field-must-be-an-attachment-field": "Template field must be an attachment field.",
"template-field-does-not-contain-any-files": "Template field does not contain any files.",
"template-field-contains-multiple-files": "Template field contains multiple files. Please ensure it contains only one file.",
"template-file-must-be-a-docx": "The template file must be a Word (.docx) file. 'Mime-Type: {{contentType}}'."
"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"

View File

@@ -1,12 +1,16 @@
{
"name": "Word出力プラグイン",
"errors": {
"template-field-is-not-set": "雛形ファイルが設定されていません。プラグインの設定を見直してください。",
"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}}'"
"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出力"

12
src/kintone-env.d.ts vendored
View File

@@ -1,12 +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;
}
// CSS
declare module '*.css' {}

93
src/types/css-modules.d.ts vendored Normal file
View 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
View 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
View 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;
}

View File

@@ -19,7 +19,8 @@
"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"