@pipedog/core 0.0.0 → 0.1.0

package/dist/transcriptions/language.d.ts

@@ -0,0 +1,376 @@
+/**
+ * Language codes for speech and text processing services.
+ *
+ * Provides comprehensive language code constants following ISO 639 and BCP 47
+ * standards. Includes both language-only codes (e.g., 'en') and
+ * language-region combinations (e.g., 'en-US') to support various speech
+ * synthesis, recognition, and translation services.
+ */
+export declare const Language: {
+    readonly AF: "af";
+    readonly AF_ZA: "af-ZA";
+    readonly AM: "am";
+    readonly AM_ET: "am-ET";
+    readonly AR: "ar";
+    readonly AR_AE: "ar-AE";
+    readonly AR_BH: "ar-BH";
+    readonly AR_DZ: "ar-DZ";
+    readonly AR_EG: "ar-EG";
+    readonly AR_IQ: "ar-IQ";
+    readonly AR_JO: "ar-JO";
+    readonly AR_KW: "ar-KW";
+    readonly AR_LB: "ar-LB";
+    readonly AR_LY: "ar-LY";
+    readonly AR_MA: "ar-MA";
+    readonly AR_OM: "ar-OM";
+    readonly AR_QA: "ar-QA";
+    readonly AR_SA: "ar-SA";
+    readonly AR_SY: "ar-SY";
+    readonly AR_TN: "ar-TN";
+    readonly AR_XA: "ar-XA";
+    readonly AR_YE: "ar-YE";
+    readonly AR_001: "ar-001";
+    readonly AS: "as";
+    readonly AS_IN: "as-IN";
+    readonly AST: "ast";
+    readonly AZ: "az";
+    readonly AZ_AZ: "az-AZ";
+    readonly BA: "ba";
+    readonly BE: "be";
+    readonly BE_BY: "be-BY";
+    readonly BG: "bg";
+    readonly BG_BG: "bg-BG";
+    readonly BN: "bn";
+    readonly BN_BD: "bn-BD";
+    readonly BN_IN: "bn-IN";
+    readonly BO: "bo";
+    readonly BR: "br";
+    readonly BRX: "brx";
+    readonly BRX_IN: "brx-IN";
+    readonly BS: "bs";
+    readonly BS_BA: "bs-BA";
+    readonly CA: "ca";
+    readonly CA_ES: "ca-ES";
+    readonly CEB: "ceb";
+    readonly CEB_PH: "ceb-PH";
+    readonly CKB: "ckb";
+    readonly CKB_IQ: "ckb-IQ";
+    readonly CKB_IR: "ckb-IR";
+    readonly CMN: "cmn";
+    readonly CMN_CN: "cmn-CN";
+    readonly CS: "cs";
+    readonly CS_CZ: "cs-CZ";
+    readonly CY: "cy";
+    readonly CY_GB: "cy-GB";
+    readonly DA: "da";
+    readonly DA_DK: "da-DK";
+    readonly DE: "de";
+    readonly DE_AT: "de-AT";
+    readonly DE_BE: "de-BE";
+    readonly DE_CH: "de-CH";
+    readonly DE_DE: "de-DE";
+    readonly DOI: "doi";
+    readonly DOI_IN: "doi-IN";
+    readonly EL: "el";
+    readonly EL_GR: "el-GR";
+    readonly EN: "en";
+    readonly EN_AB: "en-AB";
+    readonly EN_AU: "en-AU";
+    readonly EN_CA: "en-CA";
+    readonly EN_GB: "en-GB";
+    readonly EN_GH: "en-GH";
+    readonly EN_HK: "en-HK";
+    readonly EN_IE: "en-IE";
+    readonly EN_IN: "en-IN";
+    readonly EN_KE: "en-KE";
+    readonly EN_NG: "en-NG";
+    readonly EN_NZ: "en-NZ";
+    readonly EN_PH: "en-PH";
+    readonly EN_SG: "en-SG";
+    readonly EN_TZ: "en-TZ";
+    readonly EN_US: "en-US";
+    readonly EN_WL: "en-WL";
+    readonly EN_ZA: "en-ZA";
+    readonly EO: "eo";
+    readonly ES: "es";
+    readonly ES_AR: "es-AR";
+    readonly ES_BO: "es-BO";
+    readonly ES_CL: "es-CL";
+    readonly ES_CO: "es-CO";
+    readonly ES_CR: "es-CR";
+    readonly ES_CU: "es-CU";
+    readonly ES_DO: "es-DO";
+    readonly ES_EC: "es-EC";
+    readonly ES_ES: "es-ES";
+    readonly ES_GQ: "es-GQ";
+    readonly ES_GT: "es-GT";
+    readonly ES_HN: "es-HN";
+    readonly ES_MX: "es-MX";
+    readonly ES_NI: "es-NI";
+    readonly ES_PA: "es-PA";
+    readonly ES_PE: "es-PE";
+    readonly ES_PR: "es-PR";
+    readonly ES_PY: "es-PY";
+    readonly ES_SV: "es-SV";
+    readonly ES_US: "es-US";
+    readonly ES_UY: "es-UY";
+    readonly ES_VE: "es-VE";
+    readonly ES_419: "es-419";
+    readonly ET: "et";
+    readonly ET_EE: "et-EE";
+    readonly EU: "eu";
+    readonly EU_ES: "eu-ES";
+    readonly FA: "fa";
+    readonly FA_AF: "fa-AF";
+    readonly FA_IR: "fa-IR";
+    readonly FF: "ff";
+    readonly FI: "fi";
+    readonly FI_FI: "fi-FI";
+    readonly FIL: "fil";
+    readonly FIL_PH: "fil-PH";
+    readonly FO: "fo";
+    readonly FR: "fr";
+    readonly FR_BE: "fr-BE";
+    readonly FR_CA: "fr-CA";
+    readonly FR_CH: "fr-CH";
+    readonly FR_FR: "fr-FR";
+    readonly GA: "ga";
+    readonly GA_IE: "ga-IE";
+    readonly GD: "gd";
+    readonly GL: "gl";
+    readonly GL_ES: "gl-ES";
+    readonly GU: "gu";
+    readonly GU_IN: "gu-IN";
+    readonly HA: "ha";
+    readonly HAW: "haw";
+    readonly HE: "he";
+    readonly HE_IL: "he-IL";
+    readonly HI: "hi";
+    readonly HI_IN: "hi-IN";
+    readonly HR: "hr";
+    readonly HR_HR: "hr-HR";
+    readonly HT: "ht";
+    readonly HT_HT: "ht-HT";
+    readonly HU: "hu";
+    readonly HU_HU: "hu-HU";
+    readonly HY: "hy";
+    readonly HY_AM: "hy-AM";
+    readonly ID: "id";
+    readonly ID_ID: "id-ID";
+    readonly IG: "ig";
+    readonly IS: "is";
+    readonly IS_IS: "is-IS";
+    readonly IT: "it";
+    readonly IT_IT: "it-IT";
+    readonly IT_CH: "it-CH";
+    readonly IU_CANS: "iu-Cans";
+    readonly IU_CANS_CA: "iu-Cans-CA";
+    readonly IU_LATN: "iu-Latn";
+    readonly IU_LATN_CA: "iu-Latn-CA";
+    readonly JA: "ja";
+    readonly JA_JP: "ja-JP";
+    readonly JV: "jv";
+    readonly JV_ID: "jv-ID";
+    readonly JV_JV: "jv-JV";
+    readonly JW: "jw";
+    readonly KA: "ka";
+    readonly KA_GE: "ka-GE";
+    readonly KEA: "kea";
+    readonly KAB: "kab";
+    readonly KAB_DZ: "kab-DZ";
+    readonly KK: "kk";
+    readonly KK_KZ: "kk-KZ";
+    readonly KM: "km";
+    readonly KM_KH: "km-KH";
+    readonly KN: "kn";
+    readonly KN_IN: "kn-IN";
+    readonly KOK: "kok";
+    readonly KOK_IN: "kok-IN";
+    readonly KO: "ko";
+    readonly KO_KR: "ko-KR";
+    readonly KS: "ks";
+    readonly KS_IN: "ks-IN";
+    readonly KU: "ku";
+    readonly KY: "ky";
+    readonly KY_KG: "ky-KG";
+    readonly LA: "la";
+    readonly LA_VA: "la-VA";
+    readonly LB: "lb";
+    readonly LB_LU: "lb-LU";
+    readonly LN: "ln";
+    readonly LO: "lo";
+    readonly LO_LA: "lo-LA";
+    readonly LT: "lt";
+    readonly LT_LT: "lt-LT";
+    readonly LG: "lg";
+    readonly LUO: "luo";
+    readonly LV: "lv";
+    readonly LV_LV: "lv-LV";
+    readonly MG: "mg";
+    readonly MG_MG: "mg-MG";
+    readonly MI: "mi";
+    readonly MK: "mk";
+    readonly MK_MK: "mk-MK";
+    readonly MAI: "mai";
+    readonly MAI_IN: "mai-IN";
+    readonly ML: "ml";
+    readonly ML_IN: "ml-IN";
+    readonly MN: "mn";
+    readonly MN_MN: "mn-MN";
+    readonly MNI: "mni";
+    readonly MNI_IN: "mni-IN";
+    readonly MR: "mr";
+    readonly MR_IN: "mr-IN";
+    readonly MS: "ms";
+    readonly MS_MY: "ms-MY";
+    readonly MT: "mt";
+    readonly MT_MT: "mt-MT";
+    readonly MY: "my";
+    readonly MY_MM: "my-MM";
+    readonly MY_MR: "mymr";
+    readonly NB: "nb";
+    readonly NB_NO: "nb-NO";
+    readonly NO: "no";
+    readonly NN: "nn";
+    readonly NN_NO: "nn-NO";
+    readonly NE: "ne";
+    readonly NE_IN: "ne-IN";
+    readonly NE_NP: "ne-NP";
+    readonly NL: "nl";
+    readonly NL_BE: "nl-BE";
+    readonly NL_NL: "nl-NL";
+    readonly NSO: "nso";
+    readonly NY: "ny";
+    readonly OC: "oc";
+    readonly OR: "or";
+    readonly OR_IN: "or-IN";
+    readonly PA: "pa";
+    readonly PA_IN: "pa-IN";
+    readonly PL: "pl";
+    readonly PL_PL: "pl-PL";
+    readonly PS: "ps";
+    readonly PS_AF: "ps-AF";
+    readonly PT: "pt";
+    readonly PT_BR: "pt-BR";
+    readonly PT_PT: "pt-PT";
+    readonly RO: "ro";
+    readonly RO_RO: "ro-RO";
+    readonly RU: "ru";
+    readonly RU_RU: "ru-RU";
+    readonly SA: "sa";
+    readonly SA_IN: "sa-IN";
+    readonly SAT: "sat";
+    readonly SAT_IN: "sat-IN";
+    readonly SD: "sd";
+    readonly SD_IN: "sd-IN";
+    readonly SI: "si";
+    readonly SI_LK: "si-LK";
+    readonly SK: "sk";
+    readonly SK_SK: "sk-SK";
+    readonly SL: "sl";
+    readonly SL_SI: "sl-SI";
+    readonly SN: "sn";
+    readonly SO: "so";
+    readonly SO_SO: "so-SO";
+    readonly SQ: "sq";
+    readonly SQ_AL: "sq-AL";
+    readonly SR: "sr";
+    readonly SR_RS: "sr-RS";
+    readonly SR_LATN: "sr-Latn";
+    readonly SR_LATN_RS: "sr-Latn-RS";
+    readonly SU: "su";
+    readonly SU_ID: "su-ID";
+    readonly SV: "sv";
+    readonly SV_SE: "sv-SE";
+    readonly SW: "sw";
+    readonly SW_BI: "sw-BI";
+    readonly SW_KE: "sw-KE";
+    readonly SW_RW: "sw-RW";
+    readonly SW_TZ: "sw-TZ";
+    readonly SW_UG: "sw-UG";
+    readonly TA: "ta";
+    readonly TA_IN: "ta-IN";
+    readonly TA_LK: "ta-LK";
+    readonly TA_MY: "ta-MY";
+    readonly TA_SG: "ta-SG";
+    readonly TE: "te";
+    readonly TE_IN: "te-IN";
+    readonly TG: "tg";
+    readonly TH: "th";
+    readonly TH_TH: "th-TH";
+    readonly TK: "tk";
+    readonly TL: "tl";
+    readonly TR: "tr";
+    readonly TR_TR: "tr-TR";
+    readonly TT: "tt";
+    readonly UG: "ug";
+    readonly UK: "uk";
+    readonly UK_UA: "uk-UA";
+    readonly UMB: "umb";
+    readonly UR: "ur";
+    readonly UR_IN: "ur-IN";
+    readonly UR_PK: "ur-PK";
+    readonly UZ: "uz";
+    readonly UZ_UZ: "uz-UZ";
+    readonly VI: "vi";
+    readonly VI_VN: "vi-VN";
+    readonly WO: "wo";
+    readonly WUU: "wuu";
+    readonly WUU_CN: "wuu-CN";
+    readonly YI: "yi";
+    readonly YO: "yo";
+    readonly YUE: "yue";
+    readonly YUE_CN: "yue-CN";
+    readonly ZH: "zh";
+    readonly ZH_CN: "zh-CN";
+    readonly ZH_CN_GUANGXI: "zh-CN-guangxi";
+    readonly ZH_CN_HENAN: "zh-CN-henan";
+    readonly ZH_CN_LIAONING: "zh-CN-liaoning";
+    readonly ZH_CN_SHAANXI: "zh-CN-shaanxi";
+    readonly ZH_CN_SHANDONG: "zh-CN-shandong";
+    readonly ZH_CN_SICHUAN: "zh-CN-sichuan";
+    readonly ZH_HK: "zh-HK";
+    readonly ZH_TW: "zh-TW";
+    readonly XH: "xh-ZA";
+    readonly ZU: "zu";
+    readonly ZU_ZA: "zu-ZA";
+};
+export type Language = (typeof Language)[keyof typeof Language];
+/** Whether `value` is one of the Language codes (Python's `Language(value)` not raising). */
+export declare function isLanguage(value: string): value is Language;
+/**
+ * Resolve a Language value to a service-specific language code.
+ *
+ * Checks the language map first, then falls back to extracting the
+ * appropriate code format with a warning if not found in the verified list.
+ *
+ * @param language The Language value to convert.
+ * @param languageMap Mapping from Language values to service language codes.
+ * @param useBaseCode If true, a regional variant resolves through its base
+ *   language: the map's code for the base language (e.g. 'eng' for 'en-US'
+ *   when the map has `[Language.EN]: "eng"`), or the base code itself (e.g.
+ *   'en') when the map has no entry for it. If false, uses full language code
+ *   as-is.
+ * @returns The resolved language code for the service.
+ *
+ * @example
+ * // Service expecting base codes (e.g., Cartesia)
+ * const LANGUAGE_MAP = { [Language.EN]: "en", [Language.ES]: "es" };
+ * resolveLanguage(Language.EN_US, LANGUAGE_MAP, true);
+ * // Logs: "Language en-US not verified. Using base code 'en'."
+ * // => "en"
+ *
+ * // Service with its own code per base language (e.g., ElevenLabs STT)
+ * const LANGUAGE_MAP = { [Language.EN]: "eng", [Language.ES]: "spa" };
+ * resolveLanguage(Language.EN_US, LANGUAGE_MAP, true);
+ * // Logs: "Language en-US not verified. Using base code 'eng'."
+ * // => "eng"
+ *
+ * // Service expecting full codes (e.g., AWS)
+ * const LANGUAGE_MAP = { [Language.EN_US]: "en-US", [Language.ES_ES]: "es-ES" };
+ * resolveLanguage(Language.EN_GB, LANGUAGE_MAP, false);
+ * // Logs: "Language en-GB not verified. Using 'en-GB'."
+ * // => "en-GB"
+ */
+export declare function resolveLanguage(language: Language, languageMap: Partial<Record<Language, string>>, useBaseCode?: boolean): string;
+//# sourceMappingURL=language.d.ts.map