Technical API Reference

import {
  IastToDevanagariDigitPolicy,
  IastToDevanagariOptions,
  IastToDevanagariPunctuationPolicy,
  toDevanagari,
  toPlainEnglish,
} from 'lipimala';

const script = toDevanagari('Kṛṣṇa');
console.log(script.rendered); // कृष्ण
console.log(script.restoreOriginal()); // Kṛṣṇa

console.log(toDevanagari('Rāma 2.', {
  options: new IastToDevanagariOptions({
    digitPolicy: IastToDevanagariDigitPolicy.CONVERT_TO_SCRIPT,
    punctuationPolicy: IastToDevanagariPunctuationPolicy.INDIC_DANDA,
  }),
}).rendered); // राम २।

const english = toPlainEnglish('Rāma');
console.log(english.rendered); // Ram
console.log(english.restoreOriginal()); // Rāma

from lipimala import (
    IastToDevanagariDigitPolicy,
    IastToDevanagariOptions,
    IastToDevanagariPunctuationPolicy,
    to_devanagari,
    to_plain_english,
)

script = to_devanagari('Kṛṣṇa')
print(script.rendered)  # कृष्ण
print(script.restore_original())  # Kṛṣṇa

print(to_devanagari('Rāma 2.', IastToDevanagariOptions(
    digit_policy=IastToDevanagariDigitPolicy.CONVERT_TO_SCRIPT,
    punctuation_policy=IastToDevanagariPunctuationPolicy.INDIC_DANDA,
)).rendered)  # राम २।

english = to_plain_english('Rāma')
print(english.rendered)  # Ram
print(english.restore_original())  # Rāma

use Lipimala\IastToDevanagariDigitPolicy;
use Lipimala\IastToDevanagariOptions;
use Lipimala\IastToDevanagariPunctuationPolicy;

use function Lipimala\toDevanagari;
use function Lipimala\toPlainEnglish;

$script = toDevanagari('Kṛṣṇa');
echo $script->rendered, PHP_EOL; // कृष्ण
echo $script->restoreOriginal(), PHP_EOL; // Kṛṣṇa

echo toDevanagari('Rāma 2.', new IastToDevanagariOptions(
    digitPolicy: IastToDevanagariDigitPolicy::CONVERT_TO_SCRIPT,
    punctuationPolicy: IastToDevanagariPunctuationPolicy::INDIC_DANDA,
))->rendered, PHP_EOL; // राम २।

$english = toPlainEnglish('Rāma');
echo $english->rendered, PHP_EOL; // Ram
echo $english->restoreOriginal(), PHP_EOL; // Rāma

import {
  DevanagariRomanizationProfile,
  IastToDevanagariAmbiguousLPolicy,
  IastToDevanagariOmPolicy,
  IastToDevanagariOptions,
  IastToDevanagariUnknownLatinPolicy,
  hasEmbeddedExactSource,
  stripExactSourceMetadata,
  toDevanagariFromIast,
} from 'lipimala';

console.log(toDevanagariFromIast('shiva')); // शिव
console.log(toDevanagariFromIast('shiva', new IastToDevanagariOptions({
  profile: DevanagariRomanizationProfile.STRICT_IAST,
}))); // sहिव

console.log(toDevanagariFromIast('Raama')); // रअम
console.log(toDevanagariFromIast('Raama', new IastToDevanagariOptions({
  acceptAsciiLongVowels: true,
}))); // राम

console.log(toDevanagariFromIast('oṃ')); // ओं
console.log(toDevanagariFromIast('oṃ', new IastToDevanagariOptions({
  omPolicy: IastToDevanagariOmPolicy.USE_OM_SIGN,
}))); // ॐ

console.log(toDevanagariFromIast('ə')); // ə
console.log(toDevanagariFromIast('ə', new IastToDevanagariOptions({
  unknownLatinPolicy: IastToDevanagariUnknownLatinPolicy.BRACKET,
}))); // [ə]

console.log(toDevanagariFromIast('kḷ')); // कॢ
console.log(toDevanagariFromIast('kḷ', new IastToDevanagariOptions({
  ambiguousLPolicy: IastToDevanagariAmbiguousLPolicy.PREFER_CONSONANT,
}))); // क्ळ्

console.log(toDevanagariFromIast('sha', new IastToDevanagariOptions({
  acceptPlainSh: false,
}))); // sह  (default श)
console.log(toDevanagariFromIast('xa', new IastToDevanagariOptions({
  acceptPlainXAsKha: false,
}))); // xअ  (default ख़)
console.log(toDevanagariFromIast('swa', new IastToDevanagariOptions({
  acceptWAsVa: false,
}))); // स्wअ  (default स्व)
console.log(toDevanagariFromIast('ā́', new IastToDevanagariOptions({
  preserveVedicAccentMarks: false,
}))); // आ  (default आ॑)
console.log(toDevanagariFromIast('a  b', new IastToDevanagariOptions({
  collapseWhitespace: true,
}))); // अ ब्

const tagged = toDevanagariFromIast('Kṛṣṇa', new IastToDevanagariOptions({
  embedExactSourceMetadata: true,
}));
console.log(stripExactSourceMetadata(tagged)); // कृष्ण
console.log(hasEmbeddedExactSource(tagged)); // true

from lipimala import (
    DevanagariRomanizationProfile,
    IastToDevanagariAmbiguousLPolicy,
    IastToDevanagariOmPolicy,
    IastToDevanagariOptions,
    IastToDevanagariUnknownLatinPolicy,
    has_embedded_exact_source,
    strip_exact_source_metadata,
    to_devanagari_from_iast,
)

print(to_devanagari_from_iast('shiva'))  # शिव
print(to_devanagari_from_iast('shiva', IastToDevanagariOptions(
    profile=DevanagariRomanizationProfile.STRICT_IAST,
)))  # sहिव

print(to_devanagari_from_iast('Raama'))  # रअम
print(to_devanagari_from_iast('Raama', IastToDevanagariOptions(
    accept_ascii_long_vowels=True,
)))  # राम

print(to_devanagari_from_iast('oṃ'))  # ओं
print(to_devanagari_from_iast('oṃ', IastToDevanagariOptions(
    om_policy=IastToDevanagariOmPolicy.USE_OM_SIGN,
)))  # ॐ

print(to_devanagari_from_iast('ə'))  # ə
print(to_devanagari_from_iast('ə', IastToDevanagariOptions(
    unknown_latin_policy=IastToDevanagariUnknownLatinPolicy.BRACKET,
)))  # [ə]

print(to_devanagari_from_iast('kḷ'))  # कॢ
print(to_devanagari_from_iast('kḷ', IastToDevanagariOptions(
    ambiguous_l_policy=IastToDevanagariAmbiguousLPolicy.PREFER_CONSONANT,
)))  # क्ळ्

print(to_devanagari_from_iast('sha', IastToDevanagariOptions(accept_plain_sh=False)))  # sह
print(to_devanagari_from_iast('xa', IastToDevanagariOptions(accept_plain_x_as_kha=False)))  # xअ
print(to_devanagari_from_iast('swa', IastToDevanagariOptions(accept_w_as_va=False)))  # स्wअ
print(to_devanagari_from_iast('ā́', IastToDevanagariOptions(preserve_vedic_accent_marks=False)))  # आ
print(to_devanagari_from_iast('a  b', IastToDevanagariOptions(collapse_whitespace=True)))  # अ ब्

tagged = to_devanagari_from_iast('Kṛṣṇa', IastToDevanagariOptions(
    embed_exact_source_metadata=True,
))
print(strip_exact_source_metadata(tagged))  # कृष्ण
print(has_embedded_exact_source(tagged))  # True

use Lipimala\DevanagariRomanizationProfile;
use Lipimala\IastToDevanagariAmbiguousLPolicy;
use Lipimala\IastToDevanagariOmPolicy;
use Lipimala\IastToDevanagariOptions;
use Lipimala\IastToDevanagariUnknownLatinPolicy;

use function Lipimala\hasEmbeddedExactSource;
use function Lipimala\stripExactSourceMetadata;
use function Lipimala\toDevanagariFromIast;

echo toDevanagariFromIast('shiva'), PHP_EOL; // शिव
echo toDevanagariFromIast('shiva', new IastToDevanagariOptions(
    profile: DevanagariRomanizationProfile::STRICT_IAST,
)), PHP_EOL; // sहिव

echo toDevanagariFromIast('Raama'), PHP_EOL; // रअम
echo toDevanagariFromIast('Raama', new IastToDevanagariOptions(
    acceptAsciiLongVowels: true,
)), PHP_EOL; // राम

echo toDevanagariFromIast('oṃ'), PHP_EOL; // ओं
echo toDevanagariFromIast('oṃ', new IastToDevanagariOptions(
    omPolicy: IastToDevanagariOmPolicy::USE_OM_SIGN,
)), PHP_EOL; // ॐ

echo toDevanagariFromIast('ə'), PHP_EOL; // ə
echo toDevanagariFromIast('ə', new IastToDevanagariOptions(
    unknownLatinPolicy: IastToDevanagariUnknownLatinPolicy::BRACKET,
)), PHP_EOL; // [ə]

echo toDevanagariFromIast('kḷ'), PHP_EOL; // कॢ
echo toDevanagariFromIast('kḷ', new IastToDevanagariOptions(
    ambiguousLPolicy: IastToDevanagariAmbiguousLPolicy::PREFER_CONSONANT,
)), PHP_EOL; // क्ळ्

echo toDevanagariFromIast('sha', new IastToDevanagariOptions(acceptPlainSh: false)), PHP_EOL; // sह
echo toDevanagariFromIast('xa', new IastToDevanagariOptions(acceptPlainXAsKha: false)), PHP_EOL; // xअ
echo toDevanagariFromIast('swa', new IastToDevanagariOptions(acceptWAsVa: false)), PHP_EOL; // स्wअ
echo toDevanagariFromIast('ā́', new IastToDevanagariOptions(preserveVedicAccentMarks: false)), PHP_EOL; // आ
echo toDevanagariFromIast('a  b', new IastToDevanagariOptions(collapseWhitespace: true)), PHP_EOL; // अ ब्

$tagged = toDevanagariFromIast('Kṛṣṇa', new IastToDevanagariOptions(embedExactSourceMetadata: true));
echo stripExactSourceMetadata($tagged), PHP_EOL; // कृष्ण
echo hasEmbeddedExactSource($tagged) ? 'true' : 'false', PHP_EOL; // true

import {
  FinalAPolicy,
  GlottalStopPolicy,
  IastPlainEnglishOptions,
  JnaPolicy,
  NyaPolicy,
  PlainEnglishRomanizationProfile,
  toPlainEnglishFromIast,
} from 'lipimala';

console.log(toPlainEnglishFromIast('vrata')); // vrat
console.log(toPlainEnglishFromIast('vrata', new IastPlainEnglishOptions({
  finalA: FinalAPolicy.KEEP,
}))); // vrata
console.log(toPlainEnglishFromIast('Kṛṣṇa')); // Krishna
console.log(toPlainEnglishFromIast('Kṛṣṇa', new IastPlainEnglishOptions({
  finalA: FinalAPolicy.DROP,
}))); // Krishn
console.log(toPlainEnglishFromIast('Rāma', new IastPlainEnglishOptions({
  keepFinalAForWords: ['rama'],
}))); // Rama

console.log(toPlainEnglishFromIast('jñāna')); // gyan
console.log(toPlainEnglishFromIast('jñāna', new IastPlainEnglishOptions({
  jna: JnaPolicy.JNYA,
}))); // jnyan
console.log(toPlainEnglishFromIast('jñāna', new IastPlainEnglishOptions({
  jna: JnaPolicy.JNA,
}))); // jnan

console.log(toPlainEnglishFromIast('pañca')); // panch
console.log(toPlainEnglishFromIast('pañca', new IastPlainEnglishOptions({
  nya: NyaPolicy.NYA,
}))); // panycha
console.log(toPlainEnglishFromIast('pañca', new IastPlainEnglishOptions({
  nya: NyaPolicy.GNA,
}))); // pagncha

console.log(toPlainEnglishFromIast('svarga')); // svarg
console.log(toPlainEnglishFromIast('svarga', new IastPlainEnglishOptions({
  profile: PlainEnglishRomanizationProfile.HUNTERIAN,
}))); // swarg

console.log(toPlainEnglishFromIast('candra', new IastPlainEnglishOptions({
  convertCToCh: false,
}))); // candra  (default chandra)
console.log(toPlainEnglishFromIast('aʔa', new IastPlainEnglishOptions({
  glottalStop: GlottalStopPolicy.APOSTROPHE,
}))); // a'  (default aa)
console.log(toPlainEnglishFromIast('saṃskāra', new IastPlainEnglishOptions({
  assimilateAnusvara: false,
}))); // samskar  (default sanskar)
console.log(toPlainEnglishFromIast("so'ham", new IastPlainEnglishOptions({
  removeAvagraha: false,
}))); // so'ham  (default soham)
console.log(toPlainEnglishFromIast('a  b', new IastPlainEnglishOptions({
  collapseWhitespace: true,
}))); // a b
console.log(toPlainEnglishFromIast('rāmagupta', new IastPlainEnglishOptions({
  enableInternalSchwaSyncope: true,
}))); // ramgupt  (default ramagupt)

from lipimala import (
    FinalAPolicy,
    GlottalStopPolicy,
    IastPlainEnglishOptions,
    JnaPolicy,
    NyaPolicy,
    PlainEnglishRomanizationProfile,
    to_plain_english_from_iast,
)

print(to_plain_english_from_iast('vrata'))  # vrat
print(to_plain_english_from_iast('vrata', IastPlainEnglishOptions(final_a=FinalAPolicy.KEEP)))  # vrata
print(to_plain_english_from_iast('Kṛṣṇa'))  # Krishna
print(to_plain_english_from_iast('Kṛṣṇa', IastPlainEnglishOptions(final_a=FinalAPolicy.DROP)))  # Krishn
print(to_plain_english_from_iast('Rāma', IastPlainEnglishOptions(
    keep_final_a_for_words=frozenset({'rama'}),
)))  # Rama

print(to_plain_english_from_iast('jñāna'))  # gyan
print(to_plain_english_from_iast('jñāna', IastPlainEnglishOptions(jna=JnaPolicy.JNYA)))  # jnyan
print(to_plain_english_from_iast('jñāna', IastPlainEnglishOptions(jna=JnaPolicy.JNA)))  # jnan

print(to_plain_english_from_iast('pañca'))  # panch
print(to_plain_english_from_iast('pañca', IastPlainEnglishOptions(nya=NyaPolicy.NYA)))  # panycha
print(to_plain_english_from_iast('pañca', IastPlainEnglishOptions(nya=NyaPolicy.GNA)))  # pagncha

print(to_plain_english_from_iast('svarga'))  # svarg
print(to_plain_english_from_iast('svarga', IastPlainEnglishOptions(
    profile=PlainEnglishRomanizationProfile.HUNTERIAN,
)))  # swarg

print(to_plain_english_from_iast('candra', IastPlainEnglishOptions(convert_c_to_ch=False)))  # candra
print(to_plain_english_from_iast('aʔa', IastPlainEnglishOptions(
    glottal_stop=GlottalStopPolicy.APOSTROPHE,
)))  # a'
print(to_plain_english_from_iast('saṃskāra', IastPlainEnglishOptions(assimilate_anusvara=False)))  # samskar
print(to_plain_english_from_iast("so'ham", IastPlainEnglishOptions(remove_avagraha=False)))  # so'ham
print(to_plain_english_from_iast('a  b', IastPlainEnglishOptions(collapse_whitespace=True)))  # a b
print(to_plain_english_from_iast('rāmagupta', IastPlainEnglishOptions(
    enable_internal_schwa_syncope=True,
)))  # ramgupt

use Lipimala\FinalAPolicy;
use Lipimala\GlottalStopPolicy;
use Lipimala\IastPlainEnglishOptions;
use Lipimala\JnaPolicy;
use Lipimala\NyaPolicy;
use Lipimala\PlainEnglishRomanizationProfile;

use function Lipimala\toPlainEnglishFromIast;

echo toPlainEnglishFromIast('vrata'), PHP_EOL; // vrat
echo toPlainEnglishFromIast('vrata', new IastPlainEnglishOptions(finalA: FinalAPolicy::KEEP)), PHP_EOL; // vrata
echo toPlainEnglishFromIast('Kṛṣṇa'), PHP_EOL; // Krishna
echo toPlainEnglishFromIast('Kṛṣṇa', new IastPlainEnglishOptions(finalA: FinalAPolicy::DROP)), PHP_EOL; // Krishn
echo toPlainEnglishFromIast('Rāma', new IastPlainEnglishOptions(keepFinalAForWords: ['rama'])), PHP_EOL; // Rama

echo toPlainEnglishFromIast('jñāna'), PHP_EOL; // gyan
echo toPlainEnglishFromIast('jñāna', new IastPlainEnglishOptions(jna: JnaPolicy::JNYA)), PHP_EOL; // jnyan
echo toPlainEnglishFromIast('jñāna', new IastPlainEnglishOptions(jna: JnaPolicy::JNA)), PHP_EOL; // jnan

echo toPlainEnglishFromIast('pañca'), PHP_EOL; // panch
echo toPlainEnglishFromIast('pañca', new IastPlainEnglishOptions(nya: NyaPolicy::NYA)), PHP_EOL; // panycha
echo toPlainEnglishFromIast('pañca', new IastPlainEnglishOptions(nya: NyaPolicy::GNA)), PHP_EOL; // pagncha

echo toPlainEnglishFromIast('svarga'), PHP_EOL; // svarg
echo toPlainEnglishFromIast('svarga', new IastPlainEnglishOptions(
    profile: PlainEnglishRomanizationProfile::HUNTERIAN,
)), PHP_EOL; // swarg

echo toPlainEnglishFromIast('candra', new IastPlainEnglishOptions(convertCToCh: false)), PHP_EOL; // candra
echo toPlainEnglishFromIast('aʔa', new IastPlainEnglishOptions(
    glottalStop: GlottalStopPolicy::APOSTROPHE,
)), PHP_EOL; // a'
echo toPlainEnglishFromIast('saṃskāra', new IastPlainEnglishOptions(assimilateAnusvara: false)), PHP_EOL; // samskar
echo toPlainEnglishFromIast("so'ham", new IastPlainEnglishOptions(removeAvagraha: false)), PHP_EOL; // so'ham
echo toPlainEnglishFromIast('a  b', new IastPlainEnglishOptions(collapseWhitespace: true)), PHP_EOL; // a b
echo toPlainEnglishFromIast('rāmagupta', new IastPlainEnglishOptions(
    enableInternalSchwaSyncope: true,
)), PHP_EOL; // ramgupt

import {
  BrahmicLanguage,
  BrahmicPlainEnglishOptions,
  BrahmicReadableStyle,
  BrahmicVowelLengthPolicy,
  toHunterianFromGujarati,
  toPlainEnglishFromDevanagari,
  toPlainEnglishFromGujarati,
} from 'lipimala';

const phrase = 'શ્વેતદ્વીપ સ્વરૂપ ધારણ કરીને ચાર માસ';
const natural = new BrahmicPlainEnglishOptions({
  readableStyle: BrahmicReadableStyle.NATURAL,
  vowelLength: BrahmicVowelLengthPolicy.SMART,
});

console.log(toPlainEnglishFromGujarati(phrase));
// shvetadveep svaroop dhaaran kareene chaar maas
console.log(toHunterianFromGujarati(phrase));
// shvetadvip svarup dharan karine char mas
console.log(toPlainEnglishFromGujarati(phrase, natural));
console.log(toHunterianFromGujarati(phrase, natural));
// shwetdweep swaroop dharan karine chaar maas

console.log(toPlainEnglishFromGujarati('દુઃખ')); // duhkh
console.log(toHunterianFromGujarati('દુઃખ')); // dukh

console.log(toPlainEnglishFromDevanagari('ऋतु', natural)); // ritu
console.log(toPlainEnglishFromDevanagari('ऋतु', new BrahmicPlainEnglishOptions({
  language: BrahmicLanguage.GUJARATI,
  readableStyle: BrahmicReadableStyle.NATURAL,
  vowelLength: BrahmicVowelLengthPolicy.SMART,
}))); // rutu
console.log(toPlainEnglishFromDevanagari('धर्म', new BrahmicPlainEnglishOptions({
  language: BrahmicLanguage.SANSKRIT,
  readableStyle: BrahmicReadableStyle.NATURAL,
  vowelLength: BrahmicVowelLengthPolicy.SMART,
}))); // dharma

console.log(toPlainEnglishFromGujarati('આજ મારે. શ્વેતદ્વીપ ધર્મ છે.', new BrahmicPlainEnglishOptions({
  readableStyle: BrahmicReadableStyle.NATURAL,
  vowelLength: BrahmicVowelLengthPolicy.SMART,
  capitalizeSentenceStarts: true,
  readableWordOverrides: { shwetdweep: 'Shwetdweep', dharm: 'Dharm' },
}))); // Aaj maare. Shwetdweep Dharm chhe.

from lipimala import (
    BrahmicLanguage,
    BrahmicPlainEnglishOptions,
    BrahmicReadableStyle,
    BrahmicVowelLengthPolicy,
    to_hunterian_from_gujarati,
    to_plain_english_from_devanagari,
    to_plain_english_from_gujarati,
)

phrase = 'શ્વેતદ્વીપ સ્વરૂપ ધારણ કરીને ચાર માસ'
natural = BrahmicPlainEnglishOptions(
    readable_style=BrahmicReadableStyle.NATURAL,
    vowel_length=BrahmicVowelLengthPolicy.SMART,
)

print(to_plain_english_from_gujarati(phrase))
# shvetadveep svaroop dhaaran kareene chaar maas
print(to_hunterian_from_gujarati(phrase))
# shvetadvip svarup dharan karine char mas
print(to_plain_english_from_gujarati(phrase, natural))
print(to_hunterian_from_gujarati(phrase, natural))
# shwetdweep swaroop dharan karine chaar maas

print(to_plain_english_from_gujarati('દુઃખ'))  # duhkh
print(to_hunterian_from_gujarati('દુઃખ'))  # dukh

print(to_plain_english_from_devanagari('ऋतु', natural))  # ritu
print(to_plain_english_from_devanagari('ऋतु', BrahmicPlainEnglishOptions(
    language=BrahmicLanguage.GUJARATI,
    readable_style=BrahmicReadableStyle.NATURAL,
    vowel_length=BrahmicVowelLengthPolicy.SMART,
)))  # rutu
print(to_plain_english_from_devanagari('धर्म', BrahmicPlainEnglishOptions(
    language=BrahmicLanguage.SANSKRIT,
    readable_style=BrahmicReadableStyle.NATURAL,
    vowel_length=BrahmicVowelLengthPolicy.SMART,
)))  # dharma

print(to_plain_english_from_gujarati('આજ મારે. શ્વેતદ્વીપ ધર્મ છે.', BrahmicPlainEnglishOptions(
    readable_style=BrahmicReadableStyle.NATURAL,
    vowel_length=BrahmicVowelLengthPolicy.SMART,
    capitalize_sentence_starts=True,
    readable_word_overrides={'shwetdweep': 'Shwetdweep', 'dharm': 'Dharm'},
)))  # Aaj maare. Shwetdweep Dharm chhe.

use Lipimala\BrahmicLanguage;
use Lipimala\BrahmicPlainEnglishOptions;
use Lipimala\BrahmicReadableStyle;
use Lipimala\BrahmicVowelLengthPolicy;

use function Lipimala\toHunterianFromGujarati;
use function Lipimala\toPlainEnglishFromDevanagari;
use function Lipimala\toPlainEnglishFromGujarati;

$phrase = 'શ્વેતદ્વીપ સ્વરૂપ ધારણ કરીને ચાર માસ';
$natural = new BrahmicPlainEnglishOptions(
    vowelLength: BrahmicVowelLengthPolicy::SMART,
    readableStyle: BrahmicReadableStyle::NATURAL,
);

echo toPlainEnglishFromGujarati($phrase), PHP_EOL;
// shvetadveep svaroop dhaaran kareene chaar maas
echo toHunterianFromGujarati($phrase), PHP_EOL;
// shvetadvip svarup dharan karine char mas
echo toPlainEnglishFromGujarati($phrase, $natural), PHP_EOL;
echo toHunterianFromGujarati($phrase, $natural), PHP_EOL;
// shwetdweep swaroop dharan karine chaar maas

echo toPlainEnglishFromGujarati('દુઃખ'), PHP_EOL; // duhkh
echo toHunterianFromGujarati('દુઃખ'), PHP_EOL; // dukh

echo toPlainEnglishFromDevanagari('ऋतु', $natural), PHP_EOL; // ritu
echo toPlainEnglishFromDevanagari('ऋतु', new BrahmicPlainEnglishOptions(
    language: BrahmicLanguage::GUJARATI,
    vowelLength: BrahmicVowelLengthPolicy::SMART,
    readableStyle: BrahmicReadableStyle::NATURAL,
)), PHP_EOL; // rutu
echo toPlainEnglishFromDevanagari('धर्म', new BrahmicPlainEnglishOptions(
    language: BrahmicLanguage::SANSKRIT,
    vowelLength: BrahmicVowelLengthPolicy::SMART,
    readableStyle: BrahmicReadableStyle::NATURAL,
)), PHP_EOL; // dharma

echo toPlainEnglishFromGujarati('આજ મારે. શ્વેતદ્વીપ ધર્મ છે.', new BrahmicPlainEnglishOptions(
    vowelLength: BrahmicVowelLengthPolicy::SMART,
    readableStyle: BrahmicReadableStyle::NATURAL,
    capitalizeSentenceStarts: true,
    readableWordOverrides: ['shwetdweep' => 'Shwetdweep', 'dharm' => 'Dharm'],
)), PHP_EOL; // Aaj maare. Shwetdweep Dharm chhe.

import {
  IastToDevanagariOptions,
  ScriptToIastOptions,
  toCanonicalIastFromDevanagari,
  toDevanagariFromIast,
  toExactIastFromDevanagari,
  toIastFromDevanagari,
} from 'lipimala';

const tagged = toDevanagariFromIast('Kṛṣṇa', new IastToDevanagariOptions({
  embedExactSourceMetadata: true,
}));
console.log(toIastFromDevanagari(tagged)); // Kṛṣṇa
console.log(toCanonicalIastFromDevanagari(tagged)); // kṛṣṇa
console.log(toExactIastFromDevanagari(tagged)); // Kṛṣṇa

console.log(toCanonicalIastFromDevanagari('कृष्ण©')); // kṛṣṇa©
console.log(toCanonicalIastFromDevanagari('कृष्ण©', new ScriptToIastOptions({
  preserveUnmapped: false,
}))); // kṛṣṇa

from lipimala import (
    IastToDevanagariOptions,
    ScriptToIastOptions,
    to_canonical_iast_from_devanagari,
    to_devanagari_from_iast,
    to_exact_iast_from_devanagari,
    to_iast_from_devanagari,
)

tagged = to_devanagari_from_iast('Kṛṣṇa', IastToDevanagariOptions(
    embed_exact_source_metadata=True,
))
print(to_iast_from_devanagari(tagged))  # Kṛṣṇa
print(to_canonical_iast_from_devanagari(tagged))  # kṛṣṇa
print(to_exact_iast_from_devanagari(tagged))  # Kṛṣṇa

print(to_canonical_iast_from_devanagari('कृष्ण©'))  # kṛṣṇa©
print(to_canonical_iast_from_devanagari('कृष्ण©', ScriptToIastOptions(
    preserve_unmapped=False,
)))  # kṛṣṇa

use Lipimala\IastToDevanagariOptions;
use Lipimala\ScriptToIastOptions;

use function Lipimala\toCanonicalIastFromDevanagari;
use function Lipimala\toDevanagariFromIast;
use function Lipimala\toExactIastFromDevanagari;
use function Lipimala\toIastFromDevanagari;

$tagged = toDevanagariFromIast('Kṛṣṇa', new IastToDevanagariOptions(
    embedExactSourceMetadata: true,
));
echo toIastFromDevanagari($tagged), PHP_EOL; // Kṛṣṇa
echo toCanonicalIastFromDevanagari($tagged), PHP_EOL; // kṛṣṇa
echo toExactIastFromDevanagari($tagged), PHP_EOL; // Kṛṣṇa

echo toCanonicalIastFromDevanagari('कृष्ण©'), PHP_EOL; // kṛṣṇa©
echo toCanonicalIastFromDevanagari('कृष्ण©', new ScriptToIastOptions(
    preserveUnmapped: false,
)), PHP_EOL; // kṛṣṇa

import {
  IndicScriptConversionOptions,
  IndicScriptDigitPolicy,
  hasExactDevanagariSourceMetadata,
  toCanonicalGujaratiFromDevanagari,
  toExactDevanagariFromGujarati,
  toGujaratiFromDevanagari,
  visibleWithoutExactSourceMetadata,
} from 'lipimala';

console.log(toCanonicalGujaratiFromDevanagari('कृष्ण २')); // કૃષ્ણ ૨
console.log(toCanonicalGujaratiFromDevanagari('कृष्ण २', new IndicScriptConversionOptions({
  digitPolicy: IndicScriptDigitPolicy.PRESERVE_SOURCE,
}))); // કૃષ્ણ २
console.log(toCanonicalGujaratiFromDevanagari('कृष्ण  कृष्ण', new IndicScriptConversionOptions({
  collapseWhitespace: true,
}))); // કૃષ્ણ કૃષ્ણ

const tagged = toGujaratiFromDevanagari('कृष्ण', new IndicScriptConversionOptions({
  embedExactSourceMetadata: true,
}));
console.log(hasExactDevanagariSourceMetadata(tagged)); // true
console.log(visibleWithoutExactSourceMetadata(tagged)); // કૃષ્ણ
console.log(toExactDevanagariFromGujarati(tagged)); // कृष्ण

from lipimala import (
    IndicScriptConversionOptions,
    IndicScriptDigitPolicy,
    has_exact_devanagari_source_metadata,
    to_canonical_gujarati_from_devanagari,
    to_exact_devanagari_from_gujarati,
    to_gujarati_from_devanagari,
    visible_without_exact_source_metadata,
)

print(to_canonical_gujarati_from_devanagari('कृष्ण २'))  # કૃષ્ણ ૨
print(to_canonical_gujarati_from_devanagari('कृष्ण २', IndicScriptConversionOptions(
    digit_policy=IndicScriptDigitPolicy.PRESERVE_SOURCE,
)))  # કૃષ્ણ २
print(to_canonical_gujarati_from_devanagari('कृष्ण  कृष्ण', IndicScriptConversionOptions(
    collapse_whitespace=True,
)))  # કૃષ્ણ કૃષ્ણ

tagged = to_gujarati_from_devanagari('कृष्ण', IndicScriptConversionOptions(
    embed_exact_source_metadata=True,
))
print(has_exact_devanagari_source_metadata(tagged))  # True
print(visible_without_exact_source_metadata(tagged))  # કૃષ્ણ
print(to_exact_devanagari_from_gujarati(tagged))  # कृष्ण

use Lipimala\IndicScriptConversionOptions;
use Lipimala\IndicScriptDigitPolicy;

use function Lipimala\hasExactDevanagariSourceMetadata;
use function Lipimala\toCanonicalGujaratiFromDevanagari;
use function Lipimala\toExactDevanagariFromGujarati;
use function Lipimala\toGujaratiFromDevanagari;
use function Lipimala\visibleWithoutExactSourceMetadata;

echo toCanonicalGujaratiFromDevanagari('कृष्ण २'), PHP_EOL; // કૃષ્ણ ૨
echo toCanonicalGujaratiFromDevanagari('कृष्ण २', new IndicScriptConversionOptions(
    digitPolicy: IndicScriptDigitPolicy::PRESERVE_SOURCE,
)), PHP_EOL; // કૃષ્ણ २
echo toCanonicalGujaratiFromDevanagari('कृष्ण  कृष्ण', new IndicScriptConversionOptions(
    collapseWhitespace: true,
)), PHP_EOL; // કૃષ્ણ કૃષ્ણ

$tagged = toGujaratiFromDevanagari('कृष्ण', new IndicScriptConversionOptions(
    embedExactSourceMetadata: true,
));
echo hasExactDevanagariSourceMetadata($tagged) ? 'true' : 'false', PHP_EOL; // true
echo visibleWithoutExactSourceMetadata($tagged), PHP_EOL; // કૃષ્ણ
echo toExactDevanagariFromGujarati($tagged), PHP_EOL; // कृष्ण

import {
  UnicodeNormalizationForm,
  embedExactSourceMetadata,
  hasEmbeddedExactSource,
  isEncodedVedicMark,
  isUnicodeCombiningMark,
  normalizeUnicode,
  recoverEmbeddedExactSource,
  stripExactSourceMetadata,
  tryDecodeExactSourceMetadata,
} from 'lipimala';

const tagged = embedExactSourceMetadata('कृष्ण', 'Kṛṣṇa');
const decoded = tryDecodeExactSourceMetadata(tagged);
console.log(hasEmbeddedExactSource(tagged)); // true
console.log(decoded.visibleText); // कृष्ण
console.log(decoded.originalSource); // Kṛṣṇa
console.log(stripExactSourceMetadata(tagged)); // कृष्ण
console.log(recoverEmbeddedExactSource(tagged)); // Kṛṣṇa
console.log(normalizeUnicode('a\u0304', UnicodeNormalizationForm.NFC) === 'ā'); // true
console.log(isUnicodeCombiningMark(0x094D)); // true
console.log(isEncodedVedicMark(0x0951)); // true

from lipimala import (
    UnicodeNormalizationForm,
    embed_exact_source_metadata,
    has_embedded_exact_source,
    is_encoded_vedic_mark,
    is_unicode_combining_mark,
    normalize_unicode,
    recover_embedded_exact_source,
    strip_exact_source_metadata,
    try_decode_exact_source_metadata,
)

tagged = embed_exact_source_metadata('कृष्ण', 'Kṛṣṇa')
decoded = try_decode_exact_source_metadata(tagged)
print(has_embedded_exact_source(tagged))  # True
print(decoded.visible_text)  # कृष्ण
print(decoded.original_source)  # Kṛṣṇa
print(strip_exact_source_metadata(tagged))  # कृष्ण
print(recover_embedded_exact_source(tagged))  # Kṛṣṇa
print(normalize_unicode('a\u0304', UnicodeNormalizationForm.NFC) == 'ā')  # True
print(is_unicode_combining_mark(0x094D))  # True
print(is_encoded_vedic_mark(0x0951))  # True

use Lipimala\UnicodeNormalizationForm;

use function Lipimala\embedExactSourceMetadata;
use function Lipimala\hasEmbeddedExactSource;
use function Lipimala\isEncodedVedicMark;
use function Lipimala\isUnicodeCombiningMark;
use function Lipimala\normalizeUnicode;
use function Lipimala\recoverEmbeddedExactSource;
use function Lipimala\stripExactSourceMetadata;
use function Lipimala\tryDecodeExactSourceMetadata;

$tagged = embedExactSourceMetadata('कृष्ण', 'Kṛṣṇa');
$decoded = tryDecodeExactSourceMetadata($tagged);
echo hasEmbeddedExactSource($tagged) ? 'true' : 'false', PHP_EOL; // true
echo $decoded->visibleText, PHP_EOL; // कृष्ण
echo $decoded->originalSource, PHP_EOL; // Kṛṣṇa
echo stripExactSourceMetadata($tagged), PHP_EOL; // कृष्ण
echo recoverEmbeddedExactSource($tagged), PHP_EOL; // Kṛṣṇa
echo normalizeUnicode("a\u{0304}", UnicodeNormalizationForm::NFC) === 'ā' ? 'true' : 'false', PHP_EOL; // true
echo isUnicodeCombiningMark(0x094D) ? 'true' : 'false', PHP_EOL; // true
echo isEncodedVedicMark(0x0951) ? 'true' : 'false', PHP_EOL; // true