feat(dts-gen): add missing kintone JS API type definitions - #3882
Open
shabaraba wants to merge 1 commit into
Open
feat(dts-gen): add missing kintone JS API type definitions#3882shabaraba wants to merge 1 commit into
shabaraba wants to merge 1 commit into
Conversation
Add 90 missing JS API definitions to kintone.d.ts: - kintone.*: getUserPreference, isUsersAndSystemAdministrator, getAvailableServices, getDomain, getAvailableApiTypes, isAccessWithClientCertificateAuthentication, isMobileApp, isMobilePage, isRevampedUI, getPageType, showConfirmDialog, createDialog, showNotification, showLoading, buildPageUrl, setKeyboardShortcuts, getKeyboardShortcuts (17 APIs + mobile variants) - kintone.user.*: getOrganizations, getGroups, getCustomFields, getIcons (4 APIs, new namespace) - kintone.app.*: get, getFormFields, getFormLayout, isTestEnvironment, isMaintenanceMode, showDescription, getDescriptionDisplayState, getIcons, getView, getViews, getReports, getStatus, getCategories, getPermissions, showAddRecordButton, getAddRecordButtonDisplayState, showAppSettingsButton, getAppSettingsButtonDisplayState, showOptionsButton, getOptionsButtonDisplayState, showFilterButton, getFilterButtonDisplayState, showReportButton, getReportButtonDisplayState, showViewAndReportSelector, getViewAndReportSelectorDisplayState, showViewSelectorItems, getViewSelectorItemsDisplayState, showReportSelectorItems, getReportSelectorItemsDisplayState, setRecordListStyle, getRecordListStyle (32 APIs) - kintone.app.record.*: isGroupFieldOpen, getPermissions, getFieldPermissions, getStatusHistory, getStatusActions, getAssignees, getActions, isFieldVisible, showEditRecordButton, getEditRecordButtonDisplayState, showDuplicateRecordButton, getDuplicateRecordButtonDisplayState, showPager, getPagerDisplayState, showSideBar, getSideBarDisplayState, showChangeAssigneeButton, getChangeAssigneeButtonDisplayState, showActionButton, getActionButtonDisplayState, showStatusActionButton, getStatusActionButtonDisplayState, setFieldStyle, getFieldStyle (24 APIs) - kintone.space.*: get, getPermissions (2 APIs) - kintone.system.*: getAvailableFeatures, getPermissions (2 APIs, new namespace) - kintone.license.*: isTrial, getSubscriptionPlan (2 APIs, new namespace) - kintone.mobile.*: showNotification, showLoading, showConfirmBottomSheet, createBottomSheet + mirrors of app/record APIs with mobile support
shabaraba
requested review from
chihiro-adachi and
nameless-mc
and removed request for
a team
July 13, 2026 04:08
Contributor
There was a problem hiding this comment.
Copilot wasn't able to review any files in this pull request.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
kintone.d.tsinpackages/dts-genis manually maintained and has fallen significantly behind the JS API published on the Cybozu Developer Network. A cross-reference against the full Cybozu Developer Network JS API index found 90 documented pages with no corresponding type definition (mobile counterparts pushed the real gap well beyond 90 individual functions).What
Added type definitions for all missing APIs, cross-checked page by page against the Cybozu Developer Network to confirm exact function names, namespaces, and PC/mobile availability:
kintone.*:getUserPreference,isUsersAndSystemAdministrator,getAvailableServices,getDomain,getAvailableApiTypes,isAccessWithClientCertificateAuthentication,isMobileApp,isMobilePage,isRevampedUI,getPageType,showConfirmDialog,createDialog,showNotification,showLoading,buildPageUrl,setKeyboardShortcuts,getKeyboardShortcutskintone.user.*(new namespace):getOrganizations,getGroups,getCustomFields,getIconskintone.app.*:get,getFormFields,getFormLayout,isTestEnvironment,isMaintenanceMode,showDescription,getDescriptionDisplayState,getIcons,getView,getViews,getReports,getStatus,getCategories,getPermissions, and the show/get-display-state button pairs for add-record / app-settings / options / filter / report / view-and-report-selector / view-selector-items / report-selector-items, plussetRecordListStyle/getRecordListStylekintone.app.record.*:isGroupFieldOpen,getPermissions,getFieldPermissions,getStatusHistory,getStatusActions,getAssignees,getActions,isFieldVisible, and the show/get-display-state pairs for edit-record / duplicate-record / pager / side-bar / change-assignee / action-button / status-action-button, plussetFieldStyle/getFieldStylekintone.space.*:get,getPermissionskintone.system.*(new namespace):getAvailableFeatures,getPermissionskintone.license.*(new namespace):isTrial,getSubscriptionPlankintone.mobile.*: mirrors of all the above where the Cybozu Developer Network documents a separate mobile-only or mobile-mirrored signature (showNotification,showLoading,showConfirmBottomSheet,createBottomSheet, and themobile.app.*/mobile.app.record.*mirrors)Type precision: simple types (
boolean/string/literal unions) and structurally simple response objects are typed precisely; large free-form objects that mirror the REST API response shape (getFormFields,getFormLayout,getStatus) are typed asany, consistent with the existing style in this file.How to test
The new definitions were cross-checked against the full Cybozu Developer Network JS API index and verified with a standalone
tsccompile check.Checklist
pnpm lintandpnpm teston the root directory.