tinky-termcap 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.ja-JP.md

@@ -0,0 +1,285 @@
+# tinky-termcap
+
+[Tinky](https://github.com/ByteLandTechnology/tinky) アプリケーション向けのターミナル機能検出ライブラリ。背景色、Kitty キーボードプロトコル対応、modifyOtherKeys モードなどのターミナル機能を検出するための React フックとユーティリティを提供します。
+
+## 機能
+
+- 🎨 **背景色検出** - OSC 11 経由でターミナルテーマ（ライト/ダーク）を検出
+- 📝 **ターミナル識別** - ターミナル名とバージョンを取得（xterm、kitty、WezTerm など）
+- ⌨️ **Kitty キーボードプロトコル** - 拡張キーボード入力対応を検出
+- 🔧 **modifyOtherKeys** - キーシーケンスの区別を検出（Ctrl+I と Tab）
+- ⚛️ **React 統合** - Tinky アプリ向けのシームレスなフックとコンテキストプロバイダー
+
+## 謝辞
+
+このプロジェクトは [gemini-cli](https://github.com/google-gemini/gemini-cli) のターミナル機能検出実装に基づいています。
+
+## インストール
+
+```bash
+npm install tinky-termcap
+```
+
+**ピア依存関係：**
+
+- `tinky` >= 1.0.0
+
+## クイックスタート
+
+### Provider と Hook の使用
+
+アプリケーションを `TermcapProvider` でラップし、`useTermcap` フックでターミナル機能にアクセスします。
+
+```tsx
+import { render, Box, Text } from "tinky";
+import { TermcapProvider, useTermcap } from "tinky-termcap";
+
+function App() {
+  const { isReady, backgroundColor, terminalName, kittyProtocol } =
+    useTermcap();
+
+  if (!isReady) {
+    return <Text>ターミナル機能を検出中...</Text>;
+  }
+
+  return (
+    <Box flexDirection="column">
+      <Text>ターミナル：{terminalName ?? "不明"}</Text>
+      <Text>背景色：{backgroundColor ?? "不明"}</Text>
+      <Text>Kitty プロトコル：{kittyProtocol ? "対応" : "非対応"}</Text>
+    </Box>
+  );
+}
+
+render(
+  <TermcapProvider>
+    <App />
+  </TermcapProvider>,
+);
+```
+
+### ターミナルテーマへの適応
+
+```tsx
+import { useTermcap } from "tinky-termcap";
+import { useMemo } from "react";
+
+function ThemedComponent() {
+  const { backgroundColor } = useTermcap();
+
+  const isDarkTheme = useMemo(() => {
+    if (!backgroundColor) return true; // 不明な場合はダークと仮定
+
+    const hex = backgroundColor.slice(1);
+    const r = parseInt(hex.slice(0, 2), 16);
+    const g = parseInt(hex.slice(2, 4), 16);
+    const b = parseInt(hex.slice(4, 6), 16);
+    const luminance = (0.299 * r + 0.587 * g + 0.114 * b) / 255;
+
+    return luminance < 0.5;
+  }, [backgroundColor]);
+
+  return (
+    <Box borderStyle="round" borderColor={isDarkTheme ? "white" : "black"}>
+      <Text color={isDarkTheme ? "cyan" : "blue"}>アダプティブコンテンツ</Text>
+    </Box>
+  );
+}
+```
+
+### 直接使用（React なし）
+
+```typescript
+import { detectTermcap } from "tinky-termcap";
+
+async function main() {
+  // ターミナル応答を読み取るために raw モードを有効化
+  process.stdin.setRawMode(true);
+
+  const caps = await detectTermcap(process.stdin, process.stdout, 1000);
+
+  console.log("検出完了：");
+  console.log("  ターミナル：", caps.terminalName ?? "不明");
+  console.log("  背景色：", caps.backgroundColor ?? "不明");
+  console.log("  Kitty プロトコル：", caps.kittyProtocol ? "はい" : "いいえ");
+  console.log("  modifyOtherKeys：", caps.modifyOtherKeys ? "はい" : "いいえ");
+
+  process.stdin.setRawMode(false);
+  process.exit(0);
+}
+
+main();
+```
+
+## API リファレンス
+
+### `TermcapProvider`
+
+ターミナル機能検出を実行する React コンテキストプロバイダー。
+
+#### Props
+
+| Prop                  | 型                | デフォルト | 説明                                             |
+| --------------------- | ----------------- | ---------- | ------------------------------------------------ |
+| `children`            | `React.ReactNode` | -          | 子コンポーネント                                 |
+| `timeout`             | `number`          | `1000`     | 検出タイムアウト（ミリ秒）                       |
+| `initialCapabilities` | `TermcapInfo`     | -          | 検出をスキップして提供された値を使用（テスト用） |
+
+#### カスタムタイムアウトの例
+
+```tsx
+<TermcapProvider timeout={500}>
+  <App />
+</TermcapProvider>
+```
+
+#### テスト用の例
+
+```tsx
+<TermcapProvider
+  initialCapabilities={{
+    isReady: true,
+    backgroundColor: "#1a1a1a",
+    terminalName: "xterm-256color",
+    kittyProtocol: true,
+    modifyOtherKeys: true,
+  }}
+>
+  <ComponentUnderTest />
+</TermcapProvider>
+```
+
+### `useTermcap()`
+
+ターミナル機能にアクセスする React フック。`TermcapProvider` 内で使用する必要があります。
+
+#### 戻り値：`TermcapInfo`
+
+| プロパティ        | 型                    | 説明                              |
+| ----------------- | --------------------- | --------------------------------- |
+| `isReady`         | `boolean`             | 検出が完了したかどうか            |
+| `backgroundColor` | `string \| undefined` | `#rrggbb` 形式の背景色            |
+| `terminalName`    | `string \| undefined` | ターミナル名/バージョン文字列     |
+| `kittyProtocol`   | `boolean`             | Kitty キーボードプロトコル対応    |
+| `modifyOtherKeys` | `boolean`             | modifyOtherKeys（レベル ≥ 2）対応 |
+
+#### 例
+
+```tsx
+function MyComponent() {
+  const { isReady, backgroundColor, kittyProtocol, modifyOtherKeys } =
+    useTermcap();
+
+  if (!isReady) {
+    return <Text>読み込み中...</Text>;
+  }
+
+  return (
+    <Box flexDirection="column">
+      <Text>背景色：{backgroundColor ?? "不明"}</Text>
+      <Text>
+        拡張キーボード：{kittyProtocol || modifyOtherKeys ? "✓" : "✗"}
+      </Text>
+    </Box>
+  );
+}
+```
+
+### `detectTermcap()`
+
+直接ターミナル機能検出を行う低レベル関数。
+
+```typescript
+function detectTermcap(
+  stdin?: ReadStream,
+  stdout?: WriteStream,
+  timeout?: number,
+): Promise<TermcapInfo>;
+```
+
+#### パラメータ
+
+| パラメータ | 型            | 説明                                   |
+| ---------- | ------------- | -------------------------------------- |
+| `stdin`    | `ReadStream`  | 入力ストリーム（例：`process.stdin`）  |
+| `stdout`   | `WriteStream` | 出力ストリーム（例：`process.stdout`） |
+| `timeout`  | `number`      | 検出タイムアウト（ミリ秒）             |
+
+#### 例
+
+```typescript
+import { detectTermcap } from "tinky-termcap";
+
+const caps = await detectTermcap(process.stdin, process.stdout, 1000);
+```
+
+### ターミナル機能
+
+ライブラリは高度なユースケース向けに機能定義をエクスポートします：
+
+```typescript
+import {
+  KittyFeature,
+  Osc11Feature,
+  TerminalNameFeature,
+  DeviceAttributesFeature,
+  ModifyOtherKeysFeature,
+  type TermFeature,
+} from "tinky-termcap/utils/term-features";
+
+// 各機能には以下が含まれます：
+// - query：送信する ANSI エスケープシーケンス
+// - responseRegex：応答にマッチするパターン
+
+// 例：カスタム検出
+process.stdout.write(KittyFeature.query);
+// KittyFeature.responseRegex にマッチする応答をリッスン
+```
+
+## 動作原理
+
+1. **マウント時**：`TermcapProvider` が raw モードを有効にし、検出クエリを送信
+2. **クエリシーケンス**：各機能のエスケープシーケンスを送信：
+   - Kitty キーボードプロトコルクエリ
+   - OSC 11（背景色）
+   - XTVERSION（ターミナル名）
+   - modifyOtherKeys クエリ
+   - Device Attributes（センチネル）
+3. **応答解析**：到着したターミナル応答を解析
+4. **完了**：以下のいずれかで検出が完了：
+   - Device Attributes 応答を受信（すべての応答が送信されたことを示す）
+   - タイムアウト到達
+
+## テスト済みターミナル
+
+テスト済み：
+
+- **xterm** - OSC 11 と XTVERSION を完全サポート
+- **kitty** - Kitty プロトコル、XTVERSION、OSC 11
+- **WezTerm** - 全機能サポート
+- **iTerm2** - OSC 11、XTVERSION
+- **Alacritty** - OSC 11
+- **macOS Terminal** - 基本サポート
+- **VS Code Terminal** - OSC 11
+
+## 開発
+
+```bash
+# 依存関係のインストール
+npm install
+
+# ビルド
+npm run build
+
+# テストの実行
+bun test
+
+# ドキュメント生成
+npm run docs
+```
+
+## ライセンス
+
+Apache-2.0
+
+詳細は [LICENSE](./LICENSE) を参照してください。