nihonput 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,216 @@
+import { ChangeEvent, FocusEvent, CompositionEvent } from 'react';
+
+type NormalizeOn = 'blur' | 'compositionEnd' | 'change';
+type ValidateOn = 'blur' | 'change' | 'submit';
+interface BaseFieldReturn {
+    value: string;
+    onChange: (e: ChangeEvent<HTMLInputElement>) => void;
+    onBlur: (e: FocusEvent<HTMLInputElement>) => void;
+    onCompositionStart: (e: CompositionEvent<HTMLInputElement>) => void;
+    onCompositionEnd: (e: CompositionEvent<HTMLInputElement>) => void;
+    error: string | null;
+    isValidating: boolean;
+    isComposing: boolean;
+}
+interface UseNameFieldOptions {
+    kanaMode: 'auto-convert' | 'error-on-hiragana';
+    normalizeOn?: NormalizeOn;
+    validateOn?: ValidateOn;
+    errorMessages?: {
+        katakanaOnly?: string;
+        invalidFormat?: string;
+    };
+}
+interface UseNameFieldReturn extends BaseFieldReturn {
+}
+interface UsePostalCodeFieldOptions {
+    widthMode: 'full-width-only' | 'half-width-only';
+    onInvalid: 'error' | 'auto-convert';
+    autoHyphen?: boolean;
+    normalizeOn?: NormalizeOn;
+    validateOn?: ValidateOn;
+    errorMessages?: {
+        invalidWidth?: string;
+        invalidFormat?: string;
+    };
+}
+interface UsePostalCodeFieldReturn extends BaseFieldReturn {
+}
+interface UsePrefectureFieldOptions {
+    autoComplete?: boolean;
+    normalizeOn?: NormalizeOn;
+    validateOn?: ValidateOn;
+    errorMessages?: {
+        invalidPrefecture?: string;
+    };
+}
+interface UsePrefectureFieldReturn extends BaseFieldReturn {
+}
+interface UseAddressFieldOptions {
+    alphanumericMode: 'full-width-only' | 'allow-half-width';
+    onInvalid: 'error' | 'auto-convert';
+    normalizeOn?: NormalizeOn;
+    validateOn?: ValidateOn;
+    errorMessages?: {
+        invalidWidth?: string;
+    };
+}
+interface UseAddressFieldReturn extends BaseFieldReturn {
+}
+interface UsePhoneNumberFieldOptions {
+    widthMode?: 'half-width-only';
+    onInvalid: 'error' | 'auto-convert';
+    autoHyphen?: boolean;
+    normalizeOn?: NormalizeOn;
+    validateOn?: ValidateOn;
+    errorMessages?: {
+        invalidWidth?: string;
+        invalidFormat?: string;
+    };
+}
+interface UsePhoneNumberFieldReturn extends BaseFieldReturn {
+}
+declare const defaultErrorMessages: {
+    katakanaOnly: string;
+    hiraganaOnly: string;
+    invalidPostalCode: string;
+    invalidPrefecture: string;
+    invalidPhoneNumber: string;
+    invalidWidth: string;
+    invalidFormat: string;
+};
+
+declare function useNameField(options: UseNameFieldOptions): UseNameFieldReturn;
+
+declare function usePostalCodeField(options: UsePostalCodeFieldOptions): UsePostalCodeFieldReturn;
+
+declare function usePrefectureField(options?: UsePrefectureFieldOptions): UsePrefectureFieldReturn;
+
+declare function useAddressField(options: UseAddressFieldOptions): UseAddressFieldReturn;
+
+declare function usePhoneNumberField(options: UsePhoneNumberFieldOptions): UsePhoneNumberFieldReturn;
+
+/**
+ * Validates if the string contains only Katakana characters
+ * Allows full-width Katakana (ァ-ヶ), prolonged sound mark (ー), and spaces
+ */
+declare function validateKatakana(value: string): boolean;
+/**
+ * Checks if the string contains any Hiragana characters
+ */
+declare function containsHiragana(value: string): boolean;
+
+/**
+ * Validates if the string contains only Hiragana characters
+ * Allows Hiragana (ぁ-ゖ), prolonged sound mark (ー), and spaces
+ */
+declare function validateHiragana(value: string): boolean;
+/**
+ * Checks if the string contains any Katakana characters
+ */
+declare function containsKatakana(value: string): boolean;
+
+/**
+ * Validates Japanese postal code format
+ * Accepts: 123-4567, 1234567, １２３-４５６７, １２３４５６７
+ */
+declare function validatePostalCode(value: string): boolean;
+/**
+ * Checks if postal code contains only half-width characters
+ */
+declare function isHalfWidthPostalCode(value: string): boolean;
+/**
+ * Checks if postal code contains only full-width characters
+ */
+declare function isFullWidthPostalCode(value: string): boolean;
+
+/**
+ * List of all 47 prefectures in Japan
+ */
+declare const PREFECTURES: readonly ["北海道", "青森県", "岩手県", "宮城県", "秋田県", "山形県", "福島県", "茨城県", "栃木県", "群馬県", "埼玉県", "千葉県", "東京都", "神奈川県", "新潟県", "富山県", "石川県", "福井県", "山梨県", "長野県", "岐阜県", "静岡県", "愛知県", "三重県", "滋賀県", "京都府", "大阪府", "兵庫県", "奈良県", "和歌山県", "鳥取県", "島根県", "岡山県", "広島県", "山口県", "徳島県", "香川県", "愛媛県", "高知県", "福岡県", "佐賀県", "長崎県", "熊本県", "大分県", "宮崎県", "鹿児島県", "沖縄県"];
+type Prefecture = (typeof PREFECTURES)[number];
+/**
+ * Short names for prefectures (without suffix)
+ */
+declare const PREFECTURE_SHORT_NAMES: Record<string, Prefecture>;
+/**
+ * Validates if the value is a valid Japanese prefecture
+ */
+declare function validatePrefecture(value: string): boolean;
+/**
+ * Normalizes prefecture name to full name
+ * e.g., "東京" -> "東京都", "大阪" -> "大阪府"
+ */
+declare function normalizePrefecture(value: string): string;
+
+/**
+ * Validates Japanese phone number format
+ * Accepts various formats: 03-1234-5678, 090-1234-5678, 0312345678, etc.
+ */
+declare function validatePhoneNumber(value: string): boolean;
+/**
+ * Checks if phone number contains only half-width characters
+ */
+declare function isHalfWidthPhoneNumber(value: string): boolean;
+/**
+ * Checks if phone number contains full-width characters
+ */
+declare function containsFullWidthPhoneNumber(value: string): boolean;
+
+/**
+ * Converts Hiragana to Katakana
+ * ひらがな (U+3040-U+309F) -> カタカナ (U+30A0-U+30FF)
+ */
+declare function toKatakana(value: string): string;
+
+/**
+ * Converts Katakana to Hiragana
+ * カタカナ (U+30A0-U+30FF) -> ひらがな (U+3040-U+309F)
+ * Note: Some Katakana characters don't have Hiragana equivalents
+ */
+declare function toHiragana(value: string): string;
+
+/**
+ * Converts half-width alphanumeric and symbols to full-width
+ * ASCII (U+0021-U+007E) -> Full-width (U+FF01-U+FF5E)
+ */
+declare function toFullWidth(value: string): string;
+/**
+ * Converts only half-width numbers to full-width
+ * 0-9 -> ０-９
+ */
+declare function toFullWidthNumbers(value: string): string;
+/**
+ * Converts half-width hyphen to full-width
+ */
+declare function toFullWidthHyphen(value: string): string;
+
+/**
+ * Converts full-width alphanumeric and symbols to half-width
+ * Full-width (U+FF01-U+FF5E) -> ASCII (U+0021-U+007E)
+ */
+declare function toHalfWidth(value: string): string;
+/**
+ * Converts only full-width numbers to half-width
+ * ０-９ -> 0-9
+ */
+declare function toHalfWidthNumbers(value: string): string;
+/**
+ * Converts full-width hyphen/dash to half-width
+ */
+declare function toHalfWidthHyphen(value: string): string;
+
+/**
+ * Adds hyphen to postal code
+ * 1234567 -> 123-4567
+ * Also normalizes to half-width
+ */
+declare function addPostalCodeHyphen(value: string): string;
+/**
+ * Adds hyphens to phone number
+ * Handles various Japanese phone number formats
+ * Also normalizes to half-width
+ */
+declare function addPhoneNumberHyphen(value: string): string;
+
+export { type BaseFieldReturn, type NormalizeOn, PREFECTURES, PREFECTURE_SHORT_NAMES, type Prefecture, type UseAddressFieldOptions, type UseAddressFieldReturn, type UseNameFieldOptions, type UseNameFieldReturn, type UsePhoneNumberFieldOptions, type UsePhoneNumberFieldReturn, type UsePostalCodeFieldOptions, type UsePostalCodeFieldReturn, type UsePrefectureFieldOptions, type UsePrefectureFieldReturn, type ValidateOn, addPhoneNumberHyphen, addPostalCodeHyphen, containsFullWidthPhoneNumber, containsHiragana, containsKatakana, defaultErrorMessages, isFullWidthPostalCode, isHalfWidthPhoneNumber, isHalfWidthPostalCode, normalizePrefecture, toFullWidth, toFullWidthHyphen, toFullWidthNumbers, toHalfWidth, toHalfWidthHyphen, toHalfWidthNumbers, toHiragana, toKatakana, useAddressField, useNameField, usePhoneNumberField, usePostalCodeField, usePrefectureField, validateHiragana, validateKatakana, validatePhoneNumber, validatePostalCode, validatePrefecture };

package/dist/index.d.ts

@@ -0,0 +1,216 @@
+import { ChangeEvent, FocusEvent, CompositionEvent } from 'react';
+
+type NormalizeOn = 'blur' | 'compositionEnd' | 'change';
+type ValidateOn = 'blur' | 'change' | 'submit';
+interface BaseFieldReturn {
+    value: string;
+    onChange: (e: ChangeEvent<HTMLInputElement>) => void;
+    onBlur: (e: FocusEvent<HTMLInputElement>) => void;
+    onCompositionStart: (e: CompositionEvent<HTMLInputElement>) => void;
+    onCompositionEnd: (e: CompositionEvent<HTMLInputElement>) => void;
+    error: string | null;
+    isValidating: boolean;
+    isComposing: boolean;
+}
+interface UseNameFieldOptions {
+    kanaMode: 'auto-convert' | 'error-on-hiragana';
+    normalizeOn?: NormalizeOn;
+    validateOn?: ValidateOn;
+    errorMessages?: {
+        katakanaOnly?: string;
+        invalidFormat?: string;
+    };
+}
+interface UseNameFieldReturn extends BaseFieldReturn {
+}
+interface UsePostalCodeFieldOptions {
+    widthMode: 'full-width-only' | 'half-width-only';
+    onInvalid: 'error' | 'auto-convert';
+    autoHyphen?: boolean;
+    normalizeOn?: NormalizeOn;
+    validateOn?: ValidateOn;
+    errorMessages?: {
+        invalidWidth?: string;
+        invalidFormat?: string;
+    };
+}
+interface UsePostalCodeFieldReturn extends BaseFieldReturn {
+}
+interface UsePrefectureFieldOptions {
+    autoComplete?: boolean;
+    normalizeOn?: NormalizeOn;
+    validateOn?: ValidateOn;
+    errorMessages?: {
+        invalidPrefecture?: string;
+    };
+}
+interface UsePrefectureFieldReturn extends BaseFieldReturn {
+}
+interface UseAddressFieldOptions {
+    alphanumericMode: 'full-width-only' | 'allow-half-width';
+    onInvalid: 'error' | 'auto-convert';
+    normalizeOn?: NormalizeOn;
+    validateOn?: ValidateOn;
+    errorMessages?: {
+        invalidWidth?: string;
+    };
+}
+interface UseAddressFieldReturn extends BaseFieldReturn {
+}
+interface UsePhoneNumberFieldOptions {
+    widthMode?: 'half-width-only';
+    onInvalid: 'error' | 'auto-convert';
+    autoHyphen?: boolean;
+    normalizeOn?: NormalizeOn;
+    validateOn?: ValidateOn;
+    errorMessages?: {
+        invalidWidth?: string;
+        invalidFormat?: string;
+    };
+}
+interface UsePhoneNumberFieldReturn extends BaseFieldReturn {
+}
+declare const defaultErrorMessages: {
+    katakanaOnly: string;
+    hiraganaOnly: string;
+    invalidPostalCode: string;
+    invalidPrefecture: string;
+    invalidPhoneNumber: string;
+    invalidWidth: string;
+    invalidFormat: string;
+};
+
+declare function useNameField(options: UseNameFieldOptions): UseNameFieldReturn;
+
+declare function usePostalCodeField(options: UsePostalCodeFieldOptions): UsePostalCodeFieldReturn;
+
+declare function usePrefectureField(options?: UsePrefectureFieldOptions): UsePrefectureFieldReturn;
+
+declare function useAddressField(options: UseAddressFieldOptions): UseAddressFieldReturn;
+
+declare function usePhoneNumberField(options: UsePhoneNumberFieldOptions): UsePhoneNumberFieldReturn;
+
+/**
+ * Validates if the string contains only Katakana characters
+ * Allows full-width Katakana (ァ-ヶ), prolonged sound mark (ー), and spaces
+ */
+declare function validateKatakana(value: string): boolean;
+/**
+ * Checks if the string contains any Hiragana characters
+ */
+declare function containsHiragana(value: string): boolean;
+
+/**
+ * Validates if the string contains only Hiragana characters
+ * Allows Hiragana (ぁ-ゖ), prolonged sound mark (ー), and spaces
+ */
+declare function validateHiragana(value: string): boolean;
+/**
+ * Checks if the string contains any Katakana characters
+ */
+declare function containsKatakana(value: string): boolean;
+
+/**
+ * Validates Japanese postal code format
+ * Accepts: 123-4567, 1234567, １２３-４５６７, １２３４５６７
+ */
+declare function validatePostalCode(value: string): boolean;
+/**
+ * Checks if postal code contains only half-width characters
+ */
+declare function isHalfWidthPostalCode(value: string): boolean;
+/**
+ * Checks if postal code contains only full-width characters
+ */
+declare function isFullWidthPostalCode(value: string): boolean;
+
+/**
+ * List of all 47 prefectures in Japan
+ */
+declare const PREFECTURES: readonly ["北海道", "青森県", "岩手県", "宮城県", "秋田県", "山形県", "福島県", "茨城県", "栃木県", "群馬県", "埼玉県", "千葉県", "東京都", "神奈川県", "新潟県", "富山県", "石川県", "福井県", "山梨県", "長野県", "岐阜県", "静岡県", "愛知県", "三重県", "滋賀県", "京都府", "大阪府", "兵庫県", "奈良県", "和歌山県", "鳥取県", "島根県", "岡山県", "広島県", "山口県", "徳島県", "香川県", "愛媛県", "高知県", "福岡県", "佐賀県", "長崎県", "熊本県", "大分県", "宮崎県", "鹿児島県", "沖縄県"];
+type Prefecture = (typeof PREFECTURES)[number];
+/**
+ * Short names for prefectures (without suffix)
+ */
+declare const PREFECTURE_SHORT_NAMES: Record<string, Prefecture>;
+/**
+ * Validates if the value is a valid Japanese prefecture
+ */
+declare function validatePrefecture(value: string): boolean;
+/**
+ * Normalizes prefecture name to full name
+ * e.g., "東京" -> "東京都", "大阪" -> "大阪府"
+ */
+declare function normalizePrefecture(value: string): string;
+
+/**
+ * Validates Japanese phone number format
+ * Accepts various formats: 03-1234-5678, 090-1234-5678, 0312345678, etc.
+ */
+declare function validatePhoneNumber(value: string): boolean;
+/**
+ * Checks if phone number contains only half-width characters
+ */
+declare function isHalfWidthPhoneNumber(value: string): boolean;
+/**
+ * Checks if phone number contains full-width characters
+ */
+declare function containsFullWidthPhoneNumber(value: string): boolean;
+
+/**
+ * Converts Hiragana to Katakana
+ * ひらがな (U+3040-U+309F) -> カタカナ (U+30A0-U+30FF)
+ */
+declare function toKatakana(value: string): string;
+
+/**
+ * Converts Katakana to Hiragana
+ * カタカナ (U+30A0-U+30FF) -> ひらがな (U+3040-U+309F)
+ * Note: Some Katakana characters don't have Hiragana equivalents
+ */
+declare function toHiragana(value: string): string;
+
+/**
+ * Converts half-width alphanumeric and symbols to full-width
+ * ASCII (U+0021-U+007E) -> Full-width (U+FF01-U+FF5E)
+ */
+declare function toFullWidth(value: string): string;
+/**
+ * Converts only half-width numbers to full-width
+ * 0-9 -> ０-９
+ */
+declare function toFullWidthNumbers(value: string): string;
+/**
+ * Converts half-width hyphen to full-width
+ */
+declare function toFullWidthHyphen(value: string): string;
+
+/**
+ * Converts full-width alphanumeric and symbols to half-width
+ * Full-width (U+FF01-U+FF5E) -> ASCII (U+0021-U+007E)
+ */
+declare function toHalfWidth(value: string): string;
+/**
+ * Converts only full-width numbers to half-width
+ * ０-９ -> 0-9
+ */
+declare function toHalfWidthNumbers(value: string): string;
+/**
+ * Converts full-width hyphen/dash to half-width
+ */
+declare function toHalfWidthHyphen(value: string): string;
+
+/**
+ * Adds hyphen to postal code
+ * 1234567 -> 123-4567
+ * Also normalizes to half-width
+ */
+declare function addPostalCodeHyphen(value: string): string;
+/**
+ * Adds hyphens to phone number
+ * Handles various Japanese phone number formats
+ * Also normalizes to half-width
+ */
+declare function addPhoneNumberHyphen(value: string): string;
+
+export { type BaseFieldReturn, type NormalizeOn, PREFECTURES, PREFECTURE_SHORT_NAMES, type Prefecture, type UseAddressFieldOptions, type UseAddressFieldReturn, type UseNameFieldOptions, type UseNameFieldReturn, type UsePhoneNumberFieldOptions, type UsePhoneNumberFieldReturn, type UsePostalCodeFieldOptions, type UsePostalCodeFieldReturn, type UsePrefectureFieldOptions, type UsePrefectureFieldReturn, type ValidateOn, addPhoneNumberHyphen, addPostalCodeHyphen, containsFullWidthPhoneNumber, containsHiragana, containsKatakana, defaultErrorMessages, isFullWidthPostalCode, isHalfWidthPhoneNumber, isHalfWidthPostalCode, normalizePrefecture, toFullWidth, toFullWidthHyphen, toFullWidthNumbers, toHalfWidth, toHalfWidthHyphen, toHalfWidthNumbers, toHiragana, toKatakana, useAddressField, useNameField, usePhoneNumberField, usePostalCodeField, usePrefectureField, validateHiragana, validateKatakana, validatePhoneNumber, validatePostalCode, validatePrefecture };