tinky-mouse 0.1.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 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
+
+Copyright 2026 ByteLand Technology Limited
+
+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,95 @@
+# tinky-mouse 🐭
+
+> `tinky` アプリケーションのためのマウスイベント処理。
+
+`tinky-mouse` は、`tinky` で構築されたターミナルアプリケーションにおけるマウスイベント処理のための堅牢なシステムを提供します。SGR (1006) および X11 マウス追跡プロトコルを明示的にサポートし、React フレンドリーな API を提供します。
+
+## 機能
+
+- **プロトコルサポート**: SGR (1006) とレガシーな X11 マウス追跡の両方を処理します。
+- **リッチなイベント**: クリック（左、右、中）、リリース、スクロール（上、下、左、右）、および移動を検出します。
+- **React フック**: コンポーネントで使いやすい `useMouse` フック。
+- **コンテキストベース**: `MouseContext` を介した効率的なイベント配信。
+
+## インストール
+
+```bash
+npm install tinky-mouse
+```
+
+## 使い方
+
+アプリケーションを `MouseProvider` でラップし、コンポーネント内で `useMouse` フックを使用します。
+
+### 1. プロバイダーのセットアップ
+
+```tsx
+import React from "react";
+import { render } from "tinky";
+import { MouseProvider } from "tinky-mouse";
+import App from "./App";
+
+render(
+  <MouseProvider mouseEventsEnabled={true}>
+    <App />
+  </MouseProvider>,
+);
+```
+
+### 2. イベントのリスニング
+
+```tsx
+import React, { useState } from "react";
+import { Text } from "tinky";
+import { useMouse } from "tinky-mouse";
+
+function ClickCounter() {
+  const [count, setCount] = useState(0);
+
+  useMouse((event) => {
+    if (event.name === "left-press") {
+      setCount((c) => c + 1);
+    }
+  });
+
+  return <Text>Clicks: {count}</Text>;
+}
+```
+
+## API リファレンス
+
+### `MouseProvider`
+
+マウス追跡を有効にするトップレベルのコンポーネントです。
+
+| プロパティ           | 型          | 説明                                                  |
+| -------------------- | ----------- | ----------------------------------------------------- |
+| `children`           | `ReactNode` | 子コンポーネント。                                    |
+| `mouseEventsEnabled` | `boolean`   | マウス追跡を有効にするかどうか。デフォルト: `false`。 |
+
+### `useMouse(handler, options)`
+
+マウスイベントをサブスクライブするためのフックです。
+
+| 引数      | 型                            | 説明                                               |
+| --------- | ----------------------------- | -------------------------------------------------- |
+| `handler` | `(event: MouseEvent) => void` | マウスイベントのコールバック関数。                 |
+| `options` | `{ isActive?: boolean }`      | オプション設定。`isActive` のデフォルトは `true`。 |
+
+### `MouseEvent` オブジェクト
+
+```ts
+interface MouseEvent {
+  name: MouseEventName; // 'left-press', 'scroll-up', 'move' など
+  col: number; // 列 (x)
+  row: number; // 行 (y)
+  shift: boolean; // Shift キーが押されているか
+  meta: boolean; // Meta/Alt キーが押されているか
+  ctrl: boolean; // Ctrl キーが押されているか
+  button: "left" | "middle" | "right" | "none";
+}
+```
+
+## ライセンス
+
+Apache-2.0

package/README.md

@@ -0,0 +1,95 @@
+# tinky-mouse 🐭
+
+> Mouse event handling for `tinky` applications.
+
+`tinky-mouse` provides a robust system for handling mouse events in terminal applications built with `tinky`. It explicitly supports SGR (1006) and X11 mouse tracking protocols, offering a React-friendly API.
+
+## Features
+
+- **Protocol Support**: Handles both SGR (1006) and legacy X11 mouse tracking.
+- **Rich Events**: Detects clicks (left, right, middle), releases, scrolls (up, down, left, right), and movement.
+- **React Hooks**: Easy-to-use `useMouse` hook for components.
+- **Context-based**: Efficient event distribution via `MouseContext`.
+
+## Installation
+
+```bash
+npm install tinky-mouse
+```
+
+## Usage
+
+Wrap your application in `MouseProvider` and use the `useMouse` hook in your components.
+
+### 1. Setup the Provider
+
+```tsx
+import React from "react";
+import { render } from "tinky";
+import { MouseProvider } from "tinky-mouse";
+import App from "./App";
+
+render(
+  <MouseProvider mouseEventsEnabled={true}>
+    <App />
+  </MouseProvider>,
+);
+```
+
+### 2. Listen for Events
+
+```tsx
+import React, { useState } from "react";
+import { Text } from "tinky";
+import { useMouse } from "tinky-mouse";
+
+function ClickCounter() {
+  const [count, setCount] = useState(0);
+
+  useMouse((event) => {
+    if (event.name === "left-press") {
+      setCount((c) => c + 1);
+    }
+  });
+
+  return <Text>Clicks: {count}</Text>;
+}
+```
+
+## API Reference
+
+### `MouseProvider`
+
+The top-level component that enables mouse tracking.
+
+| Prop                 | Type        | Description                                         |
+| -------------------- | ----------- | --------------------------------------------------- |
+| `children`           | `ReactNode` | Child components.                                   |
+| `mouseEventsEnabled` | `boolean`   | Whether to enable mouse tracking. Default: `false`. |
+
+### `useMouse(handler, options)`
+
+Hook to subscribe to mouse events.
+
+| Argument  | Type                          | Description                                     |
+| --------- | ----------------------------- | ----------------------------------------------- |
+| `handler` | `(event: MouseEvent) => void` | Callback function for mouse events.             |
+| `options` | `{ isActive?: boolean }`      | Optional config. `isActive` defaults to `true`. |
+
+### `MouseEvent` Object
+
+```ts
+interface MouseEvent {
+  name: MouseEventName; // 'left-press', 'scroll-up', 'move', etc.
+  col: number; // Column (x)
+  row: number; // Row (y)
+  shift: boolean; // Shift key held
+  meta: boolean; // Meta/Alt key held
+  ctrl: boolean; // Ctrl key held
+  button: "left" | "middle" | "right" | "none";
+}
+```
+
+## License
+
+Apache-2.0

package/README.zh-CN.md

@@ -0,0 +1,95 @@
+# tinky-mouse 🐭
+
+> 适用于 `tinky` 应用程序的鼠标事件处理。
+
+`tinky-mouse` 为使用 `tinky` 构建的终端应用程序提供了一套强大的鼠标事件处理系统。它显式支持 SGR (1006) 和 X11 鼠标追踪协议，并提供了 React 友好的 API。
+
+## 功能特性
+
+- **协议支持**：同时处理 SGR (1006) 和传统的 X11 鼠标追踪。
+- **丰富的事件**：检测点击（左键、右键、中键）、释放、滚动（上、下、左、右）以及移动。
+- **React Hooks**：易于使用的 `useMouse` hook，方便在组件中使用。
+- **基于 Context**：通过 `MouseContext` 进行高效的事件分发。
+
+## 安装
+
+```bash
+npm install tinky-mouse
+```
+
+## 使用方法
+
+使用 `MouseProvider` 包裹你的应用程序，并在组件中使用 `useMouse` hook。
+
+### 1. 设置 Provider
+
+```tsx
+import React from "react";
+import { render } from "tinky";
+import { MouseProvider } from "tinky-mouse";
+import App from "./App";
+
+render(
+  <MouseProvider mouseEventsEnabled={true}>
+    <App />
+  </MouseProvider>,
+);
+```
+
+### 2. 监听事件
+
+```tsx
+import React, { useState } from "react";
+import { Text } from "tinky";
+import { useMouse } from "tinky-mouse";
+
+function ClickCounter() {
+  const [count, setCount] = useState(0);
+
+  useMouse((event) => {
+    if (event.name === "left-press") {
+      setCount((c) => c + 1);
+    }
+  });
+
+  return <Text>Clicks: {count}</Text>;
+}
+```
+
+## API 参考
+
+### `MouseProvider`
+
+启用鼠标追踪的顶层组件。
+
+| 属性                 | 类型        | 描述                                |
+| -------------------- | ----------- | ----------------------------------- |
+| `children`           | `ReactNode` | 子组件。                            |
+| `mouseEventsEnabled` | `boolean`   | 是否启用鼠标追踪。默认值：`false`。 |
+
+### `useMouse(handler, options)`
+
+用于订阅鼠标事件的 Hook。
+
+| 参数      | 类型                          | 描述                                 |
+| --------- | ----------------------------- | ------------------------------------ |
+| `handler` | `(event: MouseEvent) => void` | 鼠标事件的回调函数。                 |
+| `options` | `{ isActive?: boolean }`      | 可选配置。`isActive` 默认为 `true`。 |
+
+### `MouseEvent` 对象
+
+```ts
+interface MouseEvent {
+  name: MouseEventName; // 'left-press', 'scroll-up', 'move' 等
+  col: number; // 列 (x)
+  row: number; // 行 (y)
+  shift: boolean; // 是否按住 Shift 键
+  meta: boolean; // 是否按住 Meta/Alt 键
+  ctrl: boolean; // 是否按住 Ctrl 键
+  button: "left" | "middle" | "right" | "none";
+}
+```
+
+## 许可证
+
+Apache-2.0

package/lib/contexts/MouseContext.d.ts

@@ -0,0 +1,53 @@
+import type React from "react";
+import { type MouseEvent, type MouseEventName, type MouseHandler } from "../utils/mouse.js";
+export type { MouseEvent, MouseEventName, MouseHandler };
+/**
+ * Enable mouse event reporting in the terminal.
+ */
+export declare function enableMouseEvents(): void;
+/**
+ * Disable mouse event reporting in the terminal.
+ */
+export declare function disableMouseEvents(): void;
+/**
+ * Context value for mouse event handling.
+ */
+export interface MouseContextValue {
+    /**
+     * Subscribes a handler to mouse events.
+     * @param handler - The handler function.
+     */
+    subscribe: (handler: MouseHandler) => void;
+    /**
+     * Unsubscribes a handler from mouse events.
+     * @param handler - The handler function to remove.
+     */
+    unsubscribe: (handler: MouseHandler) => void;
+}
+/**
+ * Context for managing mouse events.
+ */
+export declare const MouseContext: React.Context<MouseContextValue | undefined>;
+/**
+ * Provider component that sets up mouse event listening and distribution.
+ *
+ * It enables mouse reporting on mount (if enabled) and disables it on unmount.
+ * It uses the `tinky` `useStdin` hook to read from the input stream.
+ *
+ * @example
+ * ```tsx
+ * <MouseProvider mouseEventsEnabled={true}>
+ *   <App />
+ * </MouseProvider>
+ * ```
+ *
+ * @param props - The component props.
+ * @param props.children - The child components.
+ * @param props.mouseEventsEnabled - Whether to enable mouse event reporting. Defaults to `false` (implicit).
+ */
+export declare function MouseProvider({ children, mouseEventsEnabled, }: {
+    /** The child components that will have access to the mouse context. */
+    children: React.ReactNode;
+    /** Whether to enable mouse event reporting. */
+    mouseEventsEnabled?: boolean;
+}): import("react/jsx-runtime").JSX.Element;