avro-bangla-suggestions 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Hasnat Shohag
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,163 @@
+# avro-bangla-suggestions
+
+A lightweight React hook providing **Avro phonetics-based Bangla typing suggestions** — drop it into any React or Next.js project to get instant Bangla word suggestions as users type in English phonetics.
+
+[![npm version](https://badge.fury.io/js/avro-bangla-suggestions.svg)](https://www.npmjs.com/package/avro-bangla-suggestions)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
+
+---
+
+## Features
+
+- 🔤 Avro phonetics-to-Bangla suggestions in real time
+- ⌨️ Keyboard navigation (Arrow keys + Enter to select)
+- 🔄 Space-to-commit: pressing space auto-converts the current word
+- 🧵 Web Worker powered — phonetics processing happens off the main thread
+- 🌐 Works with `<input>` and `<textarea>` elements
+- 📦 Zero UI dependencies — bring your own suggestion UI
+
+---
+
+## Installation
+
+```bash
+npm install avro-bangla-suggestions
+# or
+yarn add avro-bangla-suggestions
+# or
+pnpm add avro-bangla-suggestions
+```
+
+> **Peer dependencies**: `react` and `react-dom` v18 or v19 must be installed in your project.
+
+---
+
+## Quick Start
+
+```tsx
+import { useRef, useState } from "react";
+import { useBanglaTyping } from "avro-bangla-suggestions";
+
+export default function BanglaInput() {
+  const inputRef = useRef<HTMLTextAreaElement>(null);
+  const [mode, setMode] = useState<"bangla" | "english">("bangla");
+
+  const {
+    text,
+    handleChange,
+    handleKeyDown,
+    handlePaste,
+    handleFocus,
+    handleBlur,
+    suggestions,
+    selectedSuggestionIndex,
+    applySuggestion,
+    isFocused,
+  } = useBanglaTyping({ mode });
+
+  return (
+    <div style={{ position: "relative" }}>
+      <textarea
+        ref={inputRef}
+        value={text}
+        onChange={handleChange}
+        onKeyDown={handleKeyDown}
+        onPaste={handlePaste}
+        onFocus={handleFocus}
+        onBlur={handleBlur}
+      />
+
+      {/* Suggestion dropdown */}
+      {isFocused && suggestions.length > 0 && (
+        <div style={{ display: "flex", gap: 4, position: "absolute" }}>
+          {suggestions.map((word, idx) => (
+            <button
+              key={idx}
+              onMouseDown={(e) => {
+                e.preventDefault(); // prevent blur
+                applySuggestion(word, inputRef.current);
+              }}
+              style={{
+                background: selectedSuggestionIndex === idx ? "#7c3aed" : "#f3f4f6",
+                color: selectedSuggestionIndex === idx ? "#fff" : "#374151",
+              }}
+            >
+              {word}
+            </button>
+          ))}
+        </div>
+      )}
+    </div>
+  );
+}
+```
+
+---
+
+## `useBanglaTyping` API
+
+### Parameters
+
+| Prop | Type | Default | Description |
+|------|------|---------|-------------|
+| `mode` | `"bangla" \| "english"` | `"english"` | Enable Bangla suggestions only when `"bangla"` |
+| `initialText` | `string` | `""` | Initial value of the text state |
+| `onTextChange` | `(text: string) => void` | — | Called whenever the text changes |
+| `onSuggestionsChange` | `(suggestions: string[]) => void` | — | Called when the suggestion list updates |
+| `onSuggestionsHidden` | `() => void` | — | Called when suggestions are dismissed |
+
+### Returns
+
+| Name | Type | Description |
+|------|------|-------------|
+| `text` | `string` | Current text value (use as controlled `value`) |
+| `handleChange` | `ChangeEventHandler` | Attach to `onChange` |
+| `handleKeyDown` | `KeyboardEventHandler` | Attach to `onKeyDown` |
+| `handlePaste` | `ClipboardEventHandler` | Attach to `onPaste` |
+| `handleFocus` | `() => void` | Attach to `onFocus` |
+| `handleBlur` | `() => void` | Attach to `onBlur` |
+| `suggestions` | `string[]` | Current suggestion list |
+| `selectedSuggestionIndex` | `number` | Index of the highlighted suggestion |
+| `applySuggestion` | `(word: string, el: HTMLInputElement \| HTMLTextAreaElement \| null) => void` | Call on suggestion click |
+| `isFocused` | `boolean` | Whether the input is focused |
+| `hideSuggestions` | `() => void` | Programmatically dismiss suggestions |
+
+### Keyboard Shortcuts (Bangla mode)
+
+| Key | Action |
+|-----|--------|
+| `→` / `↓` | Select next suggestion |
+| `←` / `↑` | Select previous suggestion |
+| `Enter` | Apply selected suggestion |
+| `Space` | Auto-convert and commit current word |
+
+---
+
+## TypeScript Types
+
+```ts
+import type { TAvroSuggestion, TAvroPhonetic } from "avro-bangla-suggestions";
+```
+
+---
+
+## Advanced: Worker Utilities
+
+If you need direct access to the Avro worker:
+
+```ts
+import { initAvroWorker, getGlobalAvroWorker } from "avro-bangla-suggestions";
+
+// Create a new instance (useful if you need isolated state)
+const worker = initAvroWorker();
+const result = await worker.getSuggestion("ami");
+
+// Or use the shared singleton
+const sharedWorker = getGlobalAvroWorker();
+```
+
+---
+
+## License
+
+[MIT](./LICENSE) © Hasnat Shohag

package/dist/avro/index.d.ts

@@ -0,0 +1,11 @@
+import { Remote } from 'comlink';
+import { TAvroPhonetic } from './types';
+
+export * from './types';
+/**
+ * Initializes the Avro worker.
+ *
+ * @returns A promise that resolves to the Comlink-wrapped worker API.
+ */
+export declare const initAvroWorker: () => Remote<TAvroPhonetic>;
+export declare const getGlobalAvroWorker: () => Remote<TAvroPhonetic>;

package/dist/avro/instance.d.ts

@@ -0,0 +1,6 @@
+import { TAvroSuggestion } from './types';
+
+export declare function ensureAvroLoaded(): Promise<void>;
+export declare function getSuggestion(subtext: string): TAvroSuggestion | null;
+export declare function setCommit(queryText: string, bnValue: string): void;
+export declare function getVersion(): string;

package/dist/avro/static/avro.min.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Type declarations for the bundled Avro Phonetics engine.
+ * avro.min.js is the pre-built AvroPhonetic library.
+ */
+export declare class AvroPhonetic {
+  version: string;
+  constructor(
+    getter: () => Record<string, unknown>,
+    setter: (cs: Record<string, unknown>) => void,
+  );
+  suggest(queryText: string): { words: string[]; prevSelection: number };
+  candidate(queryText: string): string;
+  commit(queryText: string, bnValue: string): void;
+}

package/dist/avro/types.d.ts

@@ -0,0 +1,9 @@
+export type TAvroSuggestion = {
+    prevSelection: number;
+    words: Array<string>;
+};
+export type TAvroPhonetic = {
+    getVersion: () => string;
+    getSuggestion: (queryText: string) => TAvroSuggestion;
+    setCommit: (queryText: string, bnValue: string) => void;
+};

package/dist/avro/useBanglaTyping.d.ts

@@ -0,0 +1,23 @@
+import { default as React } from 'react';
+
+interface UseBanglaTypingProps {
+    initialText?: string;
+    onTextChange?: (newText: string) => void;
+    onSuggestionsChange?: (suggestions: Array<string>) => void;
+    onSuggestionsHidden?: () => void;
+    mode?: "bangla" | "english";
+}
+export declare function useBanglaTyping({ initialText, onTextChange, onSuggestionsChange, onSuggestionsHidden, mode, }?: UseBanglaTypingProps): {
+    text: string;
+    handleChange: (e: React.ChangeEvent<HTMLInputElement | HTMLTextAreaElement>) => void;
+    handleKeyDown: (e: React.KeyboardEvent<HTMLInputElement | HTMLTextAreaElement>) => Promise<void>;
+    suggestions: string[];
+    selectedSuggestionIndex: number;
+    applySuggestion: (suggestion: string, element: HTMLInputElement | HTMLTextAreaElement | null) => void;
+    handlePaste: () => void;
+    hideSuggestions: () => void;
+    handleFocus: () => void;
+    handleBlur: () => void;
+    isFocused: boolean;
+};
+export {};