@konomi-app/kintone-utilities 6.0.1 → 6.2.0

package/dist/index.d.cts

@@ -756,6 +756,7 @@ type Row<T extends OneOf$1[]> = {
     type: 'ROW';
     fields: T;
 };
+type LayoutRow<T extends OneOf$1[]> = Row<T>;
 type Subtable<T extends InSubtable$1[]> = {
     type: 'SUBTABLE';
     code: string;
@@ -929,7 +930,7 @@ declare namespace kintoneAPI {
     type LayoutField = OneOf$1;
     namespace layout {
         type Label = Label;
-        type Row = Row<LayoutField[]>;
+        type Row = LayoutRow<LayoutField[]>;
         type Group = Group<Row[]>;
         type Spacer = Spacer;
         type HR = HR;
@@ -975,6 +976,45 @@ declare namespace kintoneAPI {
         theme: 'WHITE' | 'CLIPBOARD' | 'BINDER' | 'PENCIL' | 'CLIPS' | 'RED' | 'BLUE' | 'GREEN' | 'YELLOW' | 'BLACK';
         revision: string;
     };
+    type AppStatusAssigneeEntityType = 'USER' | 'GROUP' | 'ORGANIZATION' | 'FIELD_ENTITY' | 'CREATOR' | 'CUSTOM_FIELD';
+    type AppStatusAssigneeEntity = {
+        entity: {
+            type: AppStatusAssigneeEntityType;
+            code: string | null;
+        };
+        includeSubs: boolean;
+    };
+    type AppStatusState = {
+        name: string;
+        index: string;
+        assignee: {
+            type: 'ONE' | 'ALL' | 'ANY';
+            entities: AppStatusAssigneeEntity[];
+        };
+    };
+    type AppStatusExecutableUserEntityType = 'USER' | 'GROUP' | 'ORGANIZATION' | 'FIELD_ENTITY';
+    type AppStatusAction = {
+        name: string;
+        from: string;
+        to: string;
+        filterCond: string;
+        type: 'PRIMARY' | 'SECONDARY';
+        executableUser?: {
+            entities: {
+                entity: {
+                    type: AppStatusExecutableUserEntityType;
+                    code: string;
+                };
+                includeSubs: boolean;
+            }[];
+        };
+    };
+    type AppStatus = {
+        enable: boolean;
+        states: Record<string, AppStatusState> | null;
+        actions: AppStatusAction[] | null;
+        revision: string;
+    };
     namespace response {
         type App = {
             readonly app?: kintoneAPI.App;
@@ -1398,15 +1438,6 @@ declare class KintoneEventManager {
  */
 declare const KintoneEventListener: typeof KintoneEventManager;
 
-/**
- * プラグインがアプリ単位で保存している設定情報を返却します
- *
- * 設定情報の取得に失敗した場合は、nullを返却します
- * @param id プラグインID
- * @returns プラグインの設定情報
- * @deprecated 代わりに{@link restorePluginConfig}を使用してください
- */
-declare const restoreStorage: <T = any>(id: string) => T | null;
 /**
  * アプリにプラグインの設定情報を保存します
  * @param target プラグインの設定情報
@@ -1458,21 +1489,73 @@ declare class PluginLocalStorage {
     get hasNewVersion(): boolean;
 }
 
+/** デバッグオプションを付与するユーティリティ型 */
 type WithDebug<T> = T & {
     debug?: boolean;
 };
+/** ゲストスペースIDオプションを付与するユーティリティ型 */
 type WithGuestSpaceId<T> = T & {
     guestSpaceId?: number | string;
 };
+/** デバッグ・ゲストスペースIDの共通リクエストパラメータを付与するユーティリティ型 */
 type WithCommonRequestParams<T> = WithDebug<WithGuestSpaceId<T>>;
 
+/**
+ * 指定したIDのアプリ情報を1件取得します。
+ *
+ * @param params.id - 取得対象のアプリID
+ * @param params.guestSpaceId - ゲストスペースID（省略可）
+ * @param params.debug - デバッグログを出力する場合は `true`
+ * @returns アプリ情報オブジェクト
+ *
+ * @example
+ * ```ts
+ * const app = await getApp({ id: 1 });
+ * console.log(app.name); // アプリ名
+ * ```
+ */
 declare const getApp: (params: WithCommonRequestParams<{
     id: kintoneAPI.IDToRequest;
 }>) => Promise<kintoneAPI.App>;
+/**
+ * kintone環境内の全アプリ情報を再帰的に取得します。
+ *
+ * APIの取得件数上限（100件）を超える場合も、全件自動で取得します。
+ *
+ * @param params.offset - 取得開始位置（デフォルト: `0`）
+ * @param params._apps - 内部用の蓄積配列（外部からの指定不要）
+ * @param params.guestSpaceId - ゲストスペースID（省略可）
+ * @param params.debug - デバッグログを出力する場合は `true`
+ * @returns 全アプリ情報の配列
+ *
+ * @example
+ * ```ts
+ * const apps = await getAllApps();
+ * console.log(`アプリ数: ${apps.length}`);
+ * ```
+ */
 declare const getAllApps: (params?: WithCommonRequestParams<{
     offset?: number;
     _apps?: kintoneAPI.App[];
 }>) => Promise<kintoneAPI.App[]>;
+/**
+ * 指定アプリの一覧（ビュー）情報を取得します。
+ *
+ * @param params.app - アプリID
+ * @param params.lang - 取得する言語（デフォルト: `'default'`）
+ * @param params.preview - プレビュー環境のビューを取得する場合は `true`
+ * @param params.guestSpaceId - ゲストスペースID（省略可）
+ * @param params.debug - デバッグログを出力する場合は `true`
+ * @returns ビュー情報のオブジェクトとリビジョン番号
+ *
+ * @example
+ * ```ts
+ * const { views, revision } = await getViews({ app: 1 });
+ * Object.keys(views).forEach((viewName) => {
+ *   console.log(viewName, views[viewName]);
+ * });
+ * ```
+ */
 declare const getViews: (params: WithCommonRequestParams<{
     app: kintoneAPI.IDToRequest;
     lang?: kintoneAPI.rest.Lang;
@@ -1481,10 +1564,48 @@ declare const getViews: (params: WithCommonRequestParams<{
     views: Record<string, kintoneAPI.view.Response>;
     revision: string;
 }>;
+/**
+ * 指定アプリの一覧（ビュー）設定を更新します。
+ *
+ * …※ プレビュー環境に対して更新されます。運用環境への反映には別途デプロイが必要です。
+ *
+ * @param params.app - アプリID
+ * @param params.views - 更新するビュー情報のオブジェクト
+ * @param params.guestSpaceId - ゲストスペースID（省略可）
+ * @param params.debug - デバッグログを出力する場合は `true`
+ * @returns 更新後のリビジョン情報
+ *
+ * @example
+ * ```ts
+ * await updateViews({
+ *   app: 1,
+ *   views: {
+ *     '一覧': { type: 'LIST', name: '一覧', fields: ['フィールドA'], index: 0 },
+ *   },
+ * });
+ * ```
+ */
 declare const updateViews: (params: WithCommonRequestParams<{
     app: kintoneAPI.IDToRequest;
     views: Record<string, kintoneAPI.view.Parameter>;
 }>) => Promise<any>;
+/**
+ * 指定アプリのフォームフィールド情報を取得します。
+ *
+ * @param params.app - アプリID
+ * @param params.preview - プレビュー環境のフィールドを取得する場合は `true`
+ * @param params.guestSpaceId - ゲストスペースID（省略可）
+ * @param params.debug - デバッグログを出力する場合は `true`
+ * @returns フィールドプロパティとリビジョン番号
+ *
+ * @example
+ * ```ts
+ * const { properties, revision } = await getFormFields({ app: 1 });
+ * Object.entries(properties).forEach(([code, field]) => {
+ *   console.log(`${code}: ${field.type}`);
+ * });
+ * ```
+ */
 declare const getFormFields: (params: WithCommonRequestParams<{
     app: kintoneAPI.IDToRequest;
     preview?: boolean;
@@ -1492,6 +1613,21 @@ declare const getFormFields: (params: WithCommonRequestParams<{
     properties: kintoneAPI.FieldProperties;
     revision: string;
 }>;
+/**
+ * 指定アプリのフォームレイアウト情報を取得します。
+ *
+ * @param params.app - アプリID
+ * @param params.preview - プレビュー環境のレイアウトを取得する場合は `true`
+ * @param params.guestSpaceId - ゲストスペースID（省略可）
+ * @param params.debug - デバッグログを出力する場合は `true`
+ * @returns レイアウト情報とリビジョン番号
+ *
+ * @example
+ * ```ts
+ * const { layout } = await getFormLayout({ app: 1 });
+ * layout.forEach((row) => console.log(row.type));
+ * ```
+ */
 declare const getFormLayout: (params: WithCommonRequestParams<{
     app: kintoneAPI.IDToRequest;
     preview?: boolean;
@@ -1499,10 +1635,49 @@ declare const getFormLayout: (params: WithCommonRequestParams<{
     layout: kintoneAPI.Layout;
     revision: string;
 }>;
+/**
+ * 指定アプリのアプリ設定（アイコン、テーマなど）を取得します。
+ *
+ * @param params.app - アプリID
+ * @param params.preview - プレビュー環境の設定を取得する場合は `true`
+ * @param params.guestSpaceId - ゲストスペースID（省略可）
+ * @param params.debug - デバッグログを出力する場合は `true`
+ * @returns アプリ設定オブジェクト
+ *
+ * @example
+ * ```ts
+ * const settings = await getAppSettings({ app: 1 });
+ * console.log(settings.name, settings.icon);
+ * ```
+ */
 declare const getAppSettings: (params: WithCommonRequestParams<{
     app: kintoneAPI.IDToRequest;
     preview?: boolean;
 }>) => Promise<kintoneAPI.AppSettings>;
+/**
+ * 指定アプリのプロセス管理設定を取得します。
+ *
+ * @param params.app - アプリID
+ * @param params.lang - 取得する言語（デフォルト: `'default'`）
+ * @param params.preview - プレビュー環境の設定を取得する場合は `true`
+ * @param params.guestSpaceId - ゲストスペースID（省略可）
+ * @param params.debug - デバッグログを出力する場合は `true`
+ * @returns プロセス管理設定オブジェクト（有効フラグ、ステータス一覧、アクション一覧）
+ *
+ * @example
+ * ```ts
+ * const status = await getAppStatus({ app: 1 });
+ * if (status.enable) {
+ *   console.log(Object.keys(status.states ?? {})); // ステータス名一覧
+ *   status.actions?.forEach((action) => console.log(action.name));
+ * }
+ * ```
+ */
+declare const getAppStatus: (params: WithCommonRequestParams<{
+    app: kintoneAPI.IDToRequest;
+    lang?: kintoneAPI.rest.Lang;
+    preview?: boolean;
+}>) => Promise<kintoneAPI.AppStatus>;
 
 declare const API_LIMIT_POST = 100;
 type BulkRequestProgressParams = {
@@ -1512,6 +1687,29 @@ type BulkRequestProgressParams = {
 type WithBulkRequestCallback<T> = T & {
     onProgress?: (params: BulkRequestProgressParams) => void;
 };
+/**
+ * バックドア（プロキシ経由）でkintone REST APIを呼び出します。
+ *
+ * APIトークン認証を使い、`kintone.proxy()` を通じてリクエストを送信します。
+ * アプリAのカスタマイズからアプリBのレコードを操作するようなケースで使用します。
+ *
+ * @param params.apiToken - APIトークン
+ * @param params.method - HTTPメソッド
+ * @param params.path - APIエンドポイントのパス
+ * @param params.body - リクエストボディ（省略可）
+ * @returns APIレスポンス（JSONパース済み）
+ * @throws レスポンスのステータスコードが200でない場合
+ *
+ * @example
+ * ```ts
+ * const record = await backdoor({
+ *   apiToken: 'YOUR_API_TOKEN',
+ *   method: 'GET',
+ *   path: 'record',
+ *   body: { app: 1, id: 100 },
+ * });
+ * ```
+ */
 declare const backdoor: (params: {
     apiToken: string;
     method: kintoneAPI.rest.Method;
@@ -1523,10 +1721,66 @@ type RecordGetRequest = {
     id: kintoneAPI.IDToRequest;
 };
 type GetRecordParams = WithCommonRequestParams<RecordGetRequest>;
+/**
+ * 指定したIDのレコードを1件取得します。
+ *
+ * @typeParam T - レコードの型
+ * @param params.app - アプリID
+ * @param params.id - レコードID
+ * @param params.guestSpaceId - ゲストスペースID（省略可）
+ * @param params.debug - デバッグログを出力する場合は `true`
+ * @returns レコードデータ
+ *
+ * @example
+ * ```ts
+ * const record = await getRecord({ app: 1, id: 100 });
+ * console.log(record['フィールドコード'].value);
+ * ```
+ */
 declare const getRecord: <T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData>(params: GetRecordParams) => Promise<T>;
+/**
+ * バックドア（APIトークン認証）を使用してレコードを1件取得します。
+ *
+ * @typeParam T - レコードの型
+ * @param params.app - アプリID
+ * @param params.id - レコードID
+ * @param params.apiToken - APIトークン
+ * @returns レコードデータ
+ *
+ * @example
+ * ```ts
+ * const record = await backdoorGetRecord({
+ *   app: 1,
+ *   id: 100,
+ *   apiToken: 'YOUR_API_TOKEN',
+ * });
+ * ```
+ */
 declare const backdoorGetRecord: <T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData>(params: RecordGetRequest & {
     apiToken: string;
 }) => Promise<T>;
+/**
+ * 複数のレコードを一度に取得します（最大500件）。
+ *
+ * クエリでフィルタリングやソートが可能です。500件を超える場合は `getAllRecords` を使用してください。
+ *
+ * @typeParam T - レコードの型
+ * @param params.app - アプリID
+ * @param params.query - クエリ文字列（省略可）
+ * @param params.fields - 取得するフィールドコードの配列（省略可）
+ * @param params.totalCount - トータルカウントを取得する場合は `true`
+ * @returns レコード配列とトータルカウント
+ *
+ * @example
+ * ```ts
+ * const { records, totalCount } = await getRecords({
+ *   app: 1,
+ *   query: 'ステータス in ("未処理")',
+ *   fields: ['$id', 'タイトル'],
+ *   totalCount: true,
+ * });
+ * ```
+ */
 declare const getRecords: <T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData>(params: GetRecordsParams) => Promise<kintoneAPI.rest.RecordsGetResponse<T>>;
 type UpdateKey<T extends kintoneAPI.rest.Frame> = {
     field: keyof T;
@@ -1543,13 +1797,75 @@ type RecordPutRequest<T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData> =
     revision?: kintoneAPI.rest.Revision;
 } & PrimaryKeyToUpdate<T>;
 type UpdateRecordParams<T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData> = WithCommonRequestParams<RecordPutRequest<T>>;
+/**
+ * レコードを1件更新します。
+ *
+ * `id` または `updateKey`（重複禁止フィールド）で更新対象を指定できます。
+ *
+ * @typeParam T - レコードの型
+ * @param params.app - アプリID
+ * @param params.id - 更新対象のレコードID（`id` または `updateKey` のどちらか一方を指定）
+ * @param params.updateKey - 重複禁止フィールドによる更新キー
+ * @param params.record - 更新内容
+ * @param params.revision - リビジョン番号（楽観的排他制御）
+ * @returns 更新後のリビジョン番号
+ *
+ * @example
+ * ```ts
+ * await updateRecord({
+ *   app: 1,
+ *   id: 100,
+ *   record: { タイトル: { value: '更新済み' } },
+ * });
+ * ```
+ */
 declare const updateRecord: <T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData>(params: UpdateRecordParams<T>) => Promise<kintoneAPI.rest.RecordPutResponse>;
 type RecordPostRequest<T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData> = {
     app: kintoneAPI.IDToRequest;
     record: kintoneAPI.rest.RecordToRequest<T>;
 };
 type AddRecordParams<T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData> = WithCommonRequestParams<RecordPostRequest<T>>;
+/**
+ * レコードを1件追加します。
+ *
+ * @typeParam T - レコードの型
+ * @param params.app - アプリID
+ * @param params.record - 追加するレコードデータ
+ * @param params.guestSpaceId - ゲストスペースID（省略可）
+ * @param params.debug - デバッグログを出力する場合は `true`
+ * @returns 追加されたレコードのIDとリビジョン
+ *
+ * @example
+ * ```ts
+ * const { id } = await addRecord({
+ *   app: 1,
+ *   record: { タイトル: { value: '新規レコード' } },
+ * });
+ * console.log(`作成されたレコードID: ${id}`);
+ * ```
+ */
 declare const addRecord: <T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData>(params: AddRecordParams<T>) => Promise<kintoneAPI.rest.RecordPostResponse>;
+/**
+ * 複数レコードを一度に追加します（最大100件）。
+ *
+ * 100件を超える場合は `addAllRecords` を使用してください。
+ *
+ * @typeParam T - レコードの型
+ * @param params.app - アプリID
+ * @param params.records - 追加するレコードの配列
+ * @returns 追加されたレコードのID配列とリビジョン配列
+ *
+ * @example
+ * ```ts
+ * const { ids } = await addRecords({
+ *   app: 1,
+ *   records: [
+ *     { タイトル: { value: 'レコード1' } },
+ *     { タイトル: { value: 'レコード2' } },
+ *   ],
+ * });
+ * ```
+ */
 declare const addRecords: <T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData>(params: WithCommonRequestParams<RecordsPostRequest<T>>) => Promise<kintoneAPI.rest.RecordsPostResponse>;
 type RecordUpsertRequest<T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData> = {
     app: kintoneAPI.IDToRequest;
@@ -1557,6 +1873,26 @@ type RecordUpsertRequest<T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData
     updateKey: UpdateKey<T>;
 };
 type UpsertRecordParams<T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData> = WithCommonRequestParams<RecordUpsertRequest<T>>;
+/**
+ * レコードのアップサート（存在すれば更新、なければ追加）を行います。
+ *
+ * `updateKey` で指定した重複禁止フィールドの値に基づき、既存レコードを検索して分岐します。
+ *
+ * @typeParam T - レコードの型
+ * @param params.app - アプリID
+ * @param params.record - 追加または更新するレコードデータ
+ * @param params.updateKey - 重複禁止フィールドによるキー
+ * @returns 追加または更新されたレコードのIDとリビジョン
+ *
+ * @example
+ * ```ts
+ * const result = await upsertRecord({
+ *   app: 1,
+ *   updateKey: { field: '社員番号', value: 'EMP001' },
+ *   record: { 氏名: { value: '山田太郎' } },
+ * });
+ * ```
+ */
 declare const upsertRecord: <T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData>(params: UpsertRecordParams<T>) => Promise<kintoneAPI.rest.RecordPostResponse>;
 type RecordsPutRequest<T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData> = {
     app: kintoneAPI.IDToRequest;
@@ -1573,6 +1909,29 @@ type RecordsPutRequest<T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData>
     }))[];
 };
 type UpdateAllRecordsParams<T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData> = WithBulkRequestCallback<WithCommonRequestParams<RecordsPutRequest<T>>>;
+/**
+ * 大量のレコードを一括更新します。
+ *
+ * 内部で `bulkRequest` を使用し、API制限ごとに自動分割してリクエストを送信します。
+ *
+ * @typeParam T - レコードの型
+ * @param params.app - アプリID
+ * @param params.records - 更新するレコードの配列（`id` または `updateKey` と `record` を含む）
+ * @param params.onProgress - 進捗コールバック（`{ total, done }` を受け取る）
+ * @returns 更新されたレコードのIDとリビジョンの配列
+ *
+ * @example
+ * ```ts
+ * await updateAllRecords({
+ *   app: 1,
+ *   records: [
+ *     { id: 1, record: { ステータス: { value: '完了' } } },
+ *     { id: 2, record: { ステータス: { value: '完了' } } },
+ *   ],
+ *   onProgress: ({ total, done }) => console.log(`${done}/${total}`),
+ * });
+ * ```
+ */
 declare const updateAllRecords: <T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData>(params: UpdateAllRecordsParams<T>) => Promise<kintoneAPI.rest.RecordsPutResponse>;
 type RecordsPostRequest<T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData> = {
     app: kintoneAPI.IDToRequest;
@@ -1580,6 +1939,30 @@ type RecordsPostRequest<T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData>
     limit?: number;
 };
 type AddAllRecordsParams<T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData> = WithBulkRequestCallback<WithCommonRequestParams<RecordsPostRequest<T>>>;
+/**
+ * 大量のレコードを一括追加します。
+ *
+ * 内部で `bulkRequest` を使用し、API制限ごとに自動分割してリクエストを送信します。
+ * 空配列を渡した場合は何もせず空の結果を返します。
+ *
+ * @typeParam T - レコードの型
+ * @param params.app - アプリID
+ * @param params.records - 追加するレコードの配列
+ * @param params.limit - 1リクエストあたりのレコード数上限（デフォルト: 100）
+ * @param params.onProgress - 進捗コールバック
+ * @returns 追加されたレコードのID配列とリビジョン配列
+ *
+ * @example
+ * ```ts
+ * const { ids } = await addAllRecords({
+ *   app: 1,
+ *   records: Array.from({ length: 500 }, (_, i) => ({
+ *     タイトル: { value: `レコード${i + 1}` },
+ *   })),
+ * });
+ * console.log(`${ids.length}件追加しました`);
+ * ```
+ */
 declare const addAllRecords: <T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData>(params: AddAllRecordsParams<T>) => Promise<kintoneAPI.rest.RecordsPostResponse>;
 type RecordsDeleteRequest = {
     app: kintoneAPI.IDToRequest;
@@ -1587,9 +1970,46 @@ type RecordsDeleteRequest = {
     revisions?: number[];
 };
 type DeleteAllRecordsParams = WithBulkRequestCallback<WithCommonRequestParams<RecordsDeleteRequest>>;
+/**
+ * 大量のレコードを一括削除します。
+ *
+ * 内部で `bulkRequest` を使用し、API制限ごとに自動分割して削除リクエストを送信します。
+ *
+ * @param params.app - アプリID
+ * @param params.ids - 削除対象のレコードIDの配列
+ * @param params.revisions - リビジョン番号の配列（楽観的排他制御、省略可）
+ * @param params.onProgress - 進捗コールバック
+ * @returns バルクリクエストの結果
+ *
+ * @example
+ * ```ts
+ * await deleteAllRecords({
+ *   app: 1,
+ *   ids: [1, 2, 3, 4, 5],
+ * });
+ * ```
+ */
 declare const deleteAllRecords: (params: DeleteAllRecordsParams) => Promise<{
     results: kintoneAPI.rest.RecordsDeleteResponse[];
 }>;
+/**
+ * クエリに一致する全レコードを削除します。
+ *
+ * 指定したクエリで全レコードを取得した後、そのIDを使って一括削除を実行します。
+ *
+ * @param params.app - アプリID
+ * @param params.query - 削除対象をフィルタリングするクエリ文字列
+ * @param params.onProgress - 進捗コールバック
+ * @returns バルクリクエストの結果
+ *
+ * @example
+ * ```ts
+ * await deleteAllRecordsByQuery({
+ *   app: 1,
+ *   query: 'ステータス in ("削除済み")',
+ * });
+ * ```
+ */
 declare const deleteAllRecordsByQuery: (params: WithBulkRequestCallback<WithCommonRequestParams<{
     app: kintoneAPI.IDToRequest;
     query: string;
@@ -1664,6 +2084,26 @@ type RecordAssigneesPutRequest = {
     revision?: kintoneAPI.IDToRequest;
 };
 type UpdateRecordAssigneesParams = WithCommonRequestParams<RecordAssigneesPutRequest>;
+/**
+ * レコードの作業者（アサイニー）を更新します。
+ *
+ * プロセス管理が有効なアプリで、レコードの作業者を変更する際に使用します。
+ *
+ * @param params.app - アプリID
+ * @param params.id - レコードID
+ * @param params.assignees - 作業者のログイン名の配列
+ * @param params.revision - リビジョン番号（省略可）
+ * @returns 更新後のリビジョン情報
+ *
+ * @example
+ * ```ts
+ * await updateRecordAssignees({
+ *   app: 1,
+ *   id: 100,
+ *   assignees: ['user1', 'user2'],
+ * });
+ * ```
+ */
 declare const updateRecordAssignees: (params: UpdateRecordAssigneesParams) => Promise<kintoneAPI.rest.RecordAssigneesPutResponse>;
 type RecordStatusToPut = {
     action: string;
@@ -1675,18 +2115,76 @@ type RecordStatusPutRequest = {
     app: kintoneAPI.IDToRequest;
 } & RecordStatusToPut;
 type UpdateRecordStatusParams = WithCommonRequestParams<RecordStatusPutRequest>;
+/**
+ * レコードのプロセスステータスを1件更新します。
+ *
+ * @param params.app - アプリID
+ * @param params.action - 実行するアクション名
+ * @param params.assignee - 次の作業者のログイン名（省略可）
+ * @param params.id - レコードID
+ * @param params.revision - リビジョン番号（省略可）
+ * @returns 更新後のリビジョン情報
+ *
+ * @example
+ * ```ts
+ * await updateRecordStatus({
+ *   app: 1,
+ *   id: 100,
+ *   action: '承認する',
+ *   assignee: 'manager1',
+ * });
+ * ```
+ */
 declare const updateRecordStatus: (params: UpdateRecordStatusParams) => Promise<kintoneAPI.rest.RecordStatusPutResponse>;
 type RecordStatusesPutRequest = {
     app: kintoneAPI.IDToRequest;
     records: RecordStatusToPut[];
 };
 type UpdateAllRecordStatusesParams = WithBulkRequestCallback<WithCommonRequestParams<RecordStatusesPutRequest>>;
+/**
+ * 複数レコードのプロセスステータスを一括更新します。
+ *
+ * 内部で `bulkRequest` を使用し、API制限ごとに自動分割してリクエストを送信します。
+ *
+ * @param params.app - アプリID
+ * @param params.records - 更新対象のレコード配列（`action`, `id` 等を含む）
+ * @param params.onProgress - 進捗コールバック
+ * @returns 更新されたレコードの配列
+ *
+ * @example
+ * ```ts
+ * await updateAllRecordStatuses({
+ *   app: 1,
+ *   records: [
+ *     { id: 1, action: '承認する' },
+ *     { id: 2, action: '承認する' },
+ *   ],
+ * });
+ * ```
+ */
 declare const updateAllRecordStatuses: (params: UpdateAllRecordStatusesParams) => Promise<kintoneAPI.rest.RecordStatusesPutResponse>;
 type RecordACLEvaluateGetRequest = {
     app: kintoneAPI.IDToRequest;
     ids: kintoneAPI.IDToRequest[];
 };
 type GetRecordACLEvaluateParams = WithCommonRequestParams<RecordACLEvaluateGetRequest>;
+/**
+ * レコードのアクセス権を評価します。
+ *
+ * 指定したレコードIDに対して、現在のユーザーのアクセス権情報を取得します。
+ *
+ * @param params.app - アプリID
+ * @param params.ids - 評価対象のレコードIDの配列
+ * @returns 各レコードのアクセス権評価結果
+ *
+ * @example
+ * ```ts
+ * const result = await getRecordACLEvaluate({
+ *   app: 1,
+ *   ids: [1, 2, 3],
+ * });
+ * ```
+ */
 declare const getRecordACLEvaluate: (params: GetRecordACLEvaluateParams) => Promise<kintoneAPI.rest.RecordACLEvaluateGetResponse>;
 type OneOfBulkRequest<T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData> = {
     method: kintoneAPI.rest.Method;
@@ -1722,12 +2220,51 @@ type BulkRequestParams<T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData>
     onProgress?: (params: BulkRequestProgressParams) => void;
     limit?: number;
 }>;
+/**
+ * 複数のAPIリクエストを一括で実行します（バルクリクエスト）。
+ *
+ * API制限ごとにリクエストを自動分割し、チャンクごとに順次実行します。
+ * レコードの追加・更新・削除・ステータス更新などの操作を混在させることができます。
+ *
+ * @typeParam T - レコードの型
+ * @param params.requests - 実行するリクエストの配列（type と params を持つ）
+ * @param params.onProgress - 進捗コールバック
+ * @param params.limit - 1回のバルクリクエストあたりのリクエスト数上限（デフォルト: 20）
+ * @returns 全リクエストの実行結果
+ *
+ * @example
+ * ```ts
+ * const result = await bulkRequest({
+ *   requests: [
+ *     { type: 'addAllRecords', params: { app: 1, records: [...] } },
+ *     { type: 'deleteRecords', params: { app: 2, ids: [1, 2, 3] } },
+ *   ],
+ * });
+ * ```
+ */
 declare const bulkRequest: <T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData>(params: BulkRequestParams<T>) => Promise<kintoneAPI.rest.BulkResponse>;
 
 /**
  * 🧪 実験的な実装
  *
- * APIクライアントをClassではなく、カリー化した関数で実装することで、ユーザーがAPIクライアントを拡張しやすくする
+ * APIクライアントをClassではなく、カリー化した関数で実装することで、ユーザーがAPIクライアントを拡張しやすくする。
+ *
+ * アプリ情報を事前に指定し、レコード操作時にはアプリ情報の指定を省略できます。
+ *
+ * @typeParam T - レコードの型
+ * @param props.app - アプリID
+ * @param props.guestsSpaceId - ゲストスペースID（省略可）
+ * @param props.debug - デバッグログを出力する場合は `true`
+ * @returns レコード操作用のメソッドを持つオブジェクト
+ *
+ * @example
+ * ```ts
+ * const client = useApi({ app: 1 });
+ * const result = await client.records.$post({
+ *   records: [{ タイトル: { value: 'テスト' } }],
+ * });
+ * console.log(result.ids);
+ * ```
  */
 declare const useApi: <T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData>(props: {
     app: kintoneAPI.IDToRequest;
@@ -1740,10 +2277,31 @@ declare const useApi: <T extends kintoneAPI.rest.Frame = kintoneAPI.RecordData>(
 };
 
 /**
- * kintoneへファイルをアップロードします
+ * kintoneへファイルをアップロードします。
  *
- * @param params
- * @returns
+ * `FormData` を使用し、`fetch` APIでファイルをアップロードします。
+ * アップロード成功後、返された `fileKey` をレコードの添付ファイルフィールドの値として使用できます。
+ *
+ * @param params.file.name - ファイル名
+ * @param params.file.data - ファイルデータ（Blob）
+ * @param params.guestSpaceId - ゲストスペースID（省略可）
+ * @param params.debug - デバッグログを出力する場合は `true`
+ * @returns アップロードされたファイルの `fileKey`
+ *
+ * @example
+ * ```ts
+ * const blob = new Blob(['テスト内容'], { type: 'text/plain' });
+ * const { fileKey } = await uploadFile({
+ *   file: { name: 'test.txt', data: blob },
+ * });
+ *
+ * // レコード更新時に使用
+ * await updateRecord({
+ *   app: 1,
+ *   id: 100,
+ *   record: { 添付ファイル: { value: [{ fileKey }] } },
+ * });
+ * ```
  */
 declare const uploadFile: (params: WithCommonRequestParams<{
     file: {
@@ -1753,10 +2311,46 @@ declare const uploadFile: (params: WithCommonRequestParams<{
 }>) => Promise<{
     fileKey: string;
 }>;
+/**
+ * kintoneからファイルをダウンロードします。
+ *
+ * `fileKey` を指定して、添付ファイルをBlobとして取得します。
+ *
+ * @param params.fileKey - ダウンロード対象のファイルキー
+ * @param params.guestSpaceId - ゲストスペースID（省略可）
+ * @param params.debug - デバッグログを出力する場合は `true`
+ * @returns ファイルデータ（Blob）
+ *
+ * @example
+ * ```ts
+ * const blob = await downloadFile({ fileKey: 'xxxx-xxxx-xxxx' });
+ * const url = URL.createObjectURL(blob);
+ * ```
+ */
 declare const downloadFile: (params: WithCommonRequestParams<{
     fileKey: string;
 }>) => Promise<Blob>;
 
+/**
+ * 指定レコードのコメントを全件取得します。
+ *
+ * APIの取得件数上限（10件）を超える場合も、全件自動で再帰的に取得します。
+ *
+ * @param props.app - アプリID
+ * @param props.record - レコードID
+ * @param props.order - ソート順（`'asc'` | `'desc'`）
+ * @returns コメントの配列
+ *
+ * @example
+ * ```ts
+ * const comments = await getRecordComments({
+ *   app: 1,
+ *   record: 100,
+ *   order: 'desc',
+ * });
+ * comments.forEach((c) => console.log(c.text));
+ * ```
+ */
 declare const getRecordComments: (props: kintoneAPI.rest.CommentsGetRequest) => Promise<{
     id: string;
     text: string;
@@ -1764,7 +2358,41 @@ declare const getRecordComments: (props: kintoneAPI.rest.CommentsGetRequest) =>
     creator: kintoneAPI.rest.People;
     mentions: kintoneAPI.rest.People[];
 }[]>;
+/**
+ * レコードにコメントを1件追加します。
+ *
+ * @param params.app - アプリID
+ * @param params.record - レコードID
+ * @param params.comment - コメント内容（`text`, `mentions` 等）
+ * @returns 追加されたコメントのID
+ *
+ * @example
+ * ```ts
+ * const { id } = await addRecordComment({
+ *   app: 1,
+ *   record: 100,
+ *   comment: { text: '確認しました' },
+ * });
+ * ```
+ */
 declare const addRecordComment: (params: kintoneAPI.rest.CommentPostRequest) => Promise<kintoneAPI.rest.CommentPostResponse>;
+/**
+ * レコードのコメントを1件削除します。
+ *
+ * @param params.app - アプリID
+ * @param params.record - レコードID
+ * @param params.comment - 削除するコメントのID
+ * @returns 空オブジェクト
+ *
+ * @example
+ * ```ts
+ * await deleteRecordComment({
+ *   app: 1,
+ *   record: 100,
+ *   comment: 5,
+ * });
+ * ```
+ */
 declare const deleteRecordComment: (params: kintoneAPI.rest.CommentDeleteRequest) => Promise<kintoneAPI.rest.CommentDeleteResponse>;
 
 type AppReportsGetRequest = {
@@ -1772,8 +2400,39 @@ type AppReportsGetRequest = {
     lang?: kintoneAPI.rest.Lang;
 };
 type GetAppChartsParams = WithCommonRequestParams<AppReportsGetRequest>;
+/**
+ * 指定アプリのグラフ（レポート）設定を取得します。
+ *
+ * @param params.app - アプリID
+ * @param params.lang - 取得する言語（省略可）
+ * @param params.guestSpaceId - ゲストスペースID（省略可）
+ * @param params.debug - デバッグログを出力する場合は `true`
+ * @returns グラフ設定情報
+ *
+ * @example
+ * ```ts
+ * const { reports } = await getAppCharts({ app: 1 });
+ * Object.keys(reports).forEach((name) => {
+ *   console.log(name, reports[name].chartType);
+ * });
+ * ```
+ */
 declare const getAppCharts: (params: GetAppChartsParams) => Promise<kintoneAPI.rest.AppReportsGetResponse>;
 
+/**
+ * 指定したスペースの情報を取得します。
+ *
+ * @param params.id - スペースID
+ * @param params.guestSpaceId - ゲストスペースID（省略可）
+ * @param params.debug - デバッグログを出力する場合は `true`
+ * @returns スペース情報
+ *
+ * @example
+ * ```ts
+ * const space = await getSpace({ id: 1 });
+ * console.log(space.name);
+ * ```
+ */
 declare const getSpace: (params: WithCommonRequestParams<kintoneAPI.rest.space.GetSpaceRequest>) => Promise<kintoneAPI.rest.space.GetSpaceResponse>;
 type CreateSpaceParams = WithCommonRequestParams<{
     id: kintoneAPI.IDToRequest;
@@ -1793,12 +2452,47 @@ type CreateSpaceParams = WithCommonRequestParams<{
 type CreateSpaceResponse = {
     id: string;
 };
+/**
+ * テンプレートからスペースを新規作成します。
+ *
+ * @param params.id - スペーステンプレートID
+ * @param params.name - スペース名
+ * @param params.members - メンバー情報の配列
+ * @param params.isPrivate - 非公開スペースにする場合は `true`
+ * @param params.isGuest - ゲストスペースにする場合は `true`
+ * @param params.fixedMember - メンバーを固定する場合は `true`
+ * @returns 作成されたスペースのID
+ *
+ * @example
+ * ```ts
+ * const { id } = await createSpace({
+ *   id: 10, // テンプレートID
+ *   name: '新規プロジェクト',
+ *   members: [
+ *     { entity: { type: 'USER', code: 'user1' }, isAdmin: true },
+ *   ],
+ * });
+ * ```
+ */
 declare const createSpace: (params: CreateSpaceParams) => Promise<CreateSpaceResponse>;
 type DeleteSpaceParams = WithCommonRequestParams<{
     /** 更新するスレッドのスレッドID */
     id: kintoneAPI.rest.space.SpaceIdToRequest;
 }>;
 type DeleteSpaceResponse = {};
+/**
+ * スペースを削除します。
+ *
+ * @param params.id - 削除対象のスペースID
+ * @param params.guestSpaceId - ゲストスペースID（省略可）
+ * @param params.debug - デバッグログを出力する場合は `true`
+ * @returns 空オブジェクト
+ *
+ * @example
+ * ```ts
+ * await deleteSpace({ id: 1 });
+ * ```
+ */
 declare const deleteSpace: (params: DeleteSpaceParams) => Promise<DeleteSpaceResponse>;
 type UpdateThreadParams = WithCommonRequestParams<{
     /** 更新するスレッドのスレッドID */
@@ -1825,6 +2519,25 @@ type UpdateThreadParams = WithCommonRequestParams<{
     body?: string;
 }>;
 type UpdateThreadResponse = {};
+/**
+ * スペース内のスレッド情報を更新します。
+ *
+ * スレッド名や本文を更新できます。シングルスレッドのスペースではスレッド名の更新はできません。
+ *
+ * @param params.id - スレッドID
+ * @param params.name - スレッド名（1～128文字、省略時は更新なし）
+ * @param params.body - スレッドの本文（HTML対応、65535文字まで、省略時は更新なし）
+ * @returns 空オブジェクト
+ *
+ * @example
+ * ```ts
+ * await updateThread({
+ *   id: 5,
+ *   name: '更新後のスレッド名',
+ *   body: '<b>重要なお知らせ</b>',
+ * });
+ * ```
+ */
 declare const updateThread: (params: UpdateThreadParams) => Promise<UpdateThreadResponse>;
 
 /**
@@ -1845,6 +2558,22 @@ declare const withSpaceIdFallback: <T extends (...args: any) => any>(params: {
     func: T;
     funcParams: Parameters<T>[0];
 }) => Promise<ReturnType<T>>;
+/**
+ * REST APIでアクセスする先のアプリがゲストスペースに存在するかどうかを判定します。
+ *
+ * ゲストスペースIDなしでアクセスし、`GAIA_IL23` エラーが返るかどうかで判定します。
+ *
+ * @param appId - 判定対象のアプリID
+ * @returns ゲストスペースのアプリであれば `true`
+ *
+ * @example
+ * ```ts
+ * const guest = await isGuestSpace('123');
+ * if (guest) {
+ *   console.log('ゲストスペースのアプリです');
+ * }
+ * ```
+ */
 declare const isGuestSpace: (appId: string) => Promise<boolean>;
 type Operator = '=' | '!=' | '>' | '<' | '>=' | '<=' | 'in' | 'not in' | 'like' | 'not like';
 type OrderBy = 'asc' | 'desc';
@@ -1880,17 +2609,6 @@ declare const useQuery: <T>(conditions: QueryCondition<T>[], options?: {
         orderBy: OrderBy;
     };
 }) => string;
-/**
- * 受け取った配列を指定したサイズで分割します
- *
- * @example
- * ```ts
- * const arr = [1, 2, 3, 4, 5, 6, 7, 8, 9];
- * const result = chunk(arr, 3);
- * console.log(result); // [[1, 2, 3], [4, 5, 6], [7, 8, 9]]
- * ```
- */
-declare const chunk: <T>(arr: T[], size: number) => T[][];
 
 type KintoneConfig = {
     baseUrl?: {
@@ -2288,4 +3006,4 @@ declare const getFieldElements: (fieldCode: string) => HTMLElement[] | null;
  */
 declare const xapp: typeof kintone.mobile.app | typeof kintone.app;
 
-export { API_LIMIT_POST, type AddAllRecordsParams, type AddRecordParams, type AppReportsGetRequest, type BulkRequestParams, type CreateSpaceParams, type CreateSpaceResponse, type DeleteAllRecordsParams, type DeleteSpaceParams, type DeleteSpaceResponse, type GetAllRecordsParams, type GetAppChartsParams, type GetRecordACLEvaluateParams, type GetRecordsParams, type GetYuruCharaOptions, type KintoneConfig, KintoneEventListener, KintoneEventManager, type OnFileLoadOptions, type OneOfBulkRequest, type PluginConfig, PluginLocalStorage, type PluginManifest, type PrimaryKeyToUpdate, type QueryCondition, type RecordACLEvaluateGetRequest, type RecordAssigneesPutRequest, type RecordGetRequest, type RecordPostRequest, type RecordPutRequest, type RecordStatusPutRequest, type RecordStatusToPut, type RecordStatusesPutRequest, type RecordUpsertRequest, type RecordsDeleteRequest, type RecordsGetRequest, type RecordsPostRequest, type RecordsPutRequest, type SavedFields, type UpdateAllRecordStatusesParams, type UpdateAllRecordsParams, type UpdateKey, type UpdateRecordAssigneesParams, type UpdateRecordParams, type UpdateRecordStatusParams, type UpdateThreadParams, type UpdateThreadResponse, type UpsertRecordParams, addAllRecords, addRecord, addRecordComment, addRecords, backdoor, backdoorGetRecord, bulkRequest, chunk, compareField, convertFullwidthAlphanumericToHalfwidth, convertHalfwidthKatakanaToFullwidth, convertKatakanaToHiragana, createSpace, cx, deleteAllRecords, deleteAllRecordsByQuery, deleteRecordComment, deleteSpace, detectGuestSpaceId, downloadFile, filterFieldProperties, getAllApps, getAllRecords, getAllRecordsWithCursor, getAllRecordsWithId, getApp, getAppCharts, getAppId, getAppObject, getAppSettings, getCalcFieldValueAsString, getCurrentRecord, getCybozuGroupUsers, getCybozuGroups, getCybozuOrganizationUsers, getCybozuOrganizations, getCybozuUserGroups, getCybozuUserOrganizations, getCybozuUsers, getDefaultValue, getEmptyValue, getFieldElement, getFieldElements, getFieldValueAsString, getFormFields, getFormLayout, getHeaderSpace, getMetaFieldId_UNSTABLE, getMetaFields_UNSTABLE, getMetaSubtableFields_UNSTABLE, getMetaSubtable_UNSTABLE, getMetaTable_UNSTABLE, getNumberFieldValueAsString, getQuery, getQueryCondition, getQueryString_UNSTABLE, getRecord, getRecordACLEvaluate, getRecordComments, getRecordId, getRecords, getSortFromQuery, getSpace, getSpaceElement, getViews, getWareki, getYuruChara, isGuestSpace, isMobile, kintoneAPI, onFileLoad, restorePluginConfig, restoreStorage, setCurrentRecord, setFieldShown, setPluginProxyConfig, sortField, storePluginConfig, storeStorage, updateAllRecordStatuses, updateAllRecords, updateRecord, updateRecordAssignees, updateRecordStatus, updateThread, updateViews, uploadFile, upsertRecord, useApi, useQuery, useSorting, withLogging, withMobileEvents, withSpaceIdFallback, xapp };
+export { API_LIMIT_POST, type AddAllRecordsParams, type AddRecordParams, type AppReportsGetRequest, type BulkRequestParams, type CreateSpaceParams, type CreateSpaceResponse, type DeleteAllRecordsParams, type DeleteSpaceParams, type DeleteSpaceResponse, type GetAllRecordsParams, type GetAppChartsParams, type GetRecordACLEvaluateParams, type GetRecordsParams, type GetYuruCharaOptions, type KintoneConfig, KintoneEventListener, KintoneEventManager, type OnFileLoadOptions, type OneOfBulkRequest, type PluginConfig, PluginLocalStorage, type PluginManifest, type PrimaryKeyToUpdate, type QueryCondition, type RecordACLEvaluateGetRequest, type RecordAssigneesPutRequest, type RecordGetRequest, type RecordPostRequest, type RecordPutRequest, type RecordStatusPutRequest, type RecordStatusToPut, type RecordStatusesPutRequest, type RecordUpsertRequest, type RecordsDeleteRequest, type RecordsGetRequest, type RecordsPostRequest, type RecordsPutRequest, type SavedFields, type UpdateAllRecordStatusesParams, type UpdateAllRecordsParams, type UpdateKey, type UpdateRecordAssigneesParams, type UpdateRecordParams, type UpdateRecordStatusParams, type UpdateThreadParams, type UpdateThreadResponse, type UpsertRecordParams, addAllRecords, addRecord, addRecordComment, addRecords, backdoor, backdoorGetRecord, bulkRequest, compareField, convertFullwidthAlphanumericToHalfwidth, convertHalfwidthKatakanaToFullwidth, convertKatakanaToHiragana, createSpace, cx, deleteAllRecords, deleteAllRecordsByQuery, deleteRecordComment, deleteSpace, detectGuestSpaceId, downloadFile, filterFieldProperties, getAllApps, getAllRecords, getAllRecordsWithCursor, getAllRecordsWithId, getApp, getAppCharts, getAppId, getAppObject, getAppSettings, getAppStatus, getCalcFieldValueAsString, getCurrentRecord, getCybozuGroupUsers, getCybozuGroups, getCybozuOrganizationUsers, getCybozuOrganizations, getCybozuUserGroups, getCybozuUserOrganizations, getCybozuUsers, getDefaultValue, getEmptyValue, getFieldElement, getFieldElements, getFieldValueAsString, getFormFields, getFormLayout, getHeaderSpace, getMetaFieldId_UNSTABLE, getMetaFields_UNSTABLE, getMetaSubtableFields_UNSTABLE, getMetaSubtable_UNSTABLE, getMetaTable_UNSTABLE, getNumberFieldValueAsString, getQuery, getQueryCondition, getQueryString_UNSTABLE, getRecord, getRecordACLEvaluate, getRecordComments, getRecordId, getRecords, getSortFromQuery, getSpace, getSpaceElement, getViews, getWareki, getYuruChara, isGuestSpace, isMobile, kintoneAPI, onFileLoad, restorePluginConfig, setCurrentRecord, setFieldShown, setPluginProxyConfig, sortField, storePluginConfig, storeStorage, updateAllRecordStatuses, updateAllRecords, updateRecord, updateRecordAssignees, updateRecordStatus, updateThread, updateViews, uploadFile, upsertRecord, useApi, useQuery, useSorting, withLogging, withMobileEvents, withSpaceIdFallback, xapp };