@lingo.dev/_spec 0.26.3 → 0.26.4

package/build/index.cjs

@@ -288,7 +288,7 @@ var getLocaleCodeDelimiter = (locale) => {
     return null;
   }
 };
-var resolveOverridenLocale = (locale, delimiter) => {
+var resolveOverriddenLocale = (locale, delimiter) => {
   if (!delimiter) {
     return locale;
   }
@@ -527,4 +527,4 @@ var defaultConfig = LATEST_CONFIG_DEFINITION.defaultValue;
 
 
 
-exports.LATEST_CONFIG_DEFINITION = LATEST_CONFIG_DEFINITION; exports.bucketItemSchema = bucketItemSchema; exports.bucketTypeSchema = bucketTypeSchema; exports.bucketTypes = bucketTypes; exports.configV0Definition = configV0Definition; exports.configV1Definition = configV1Definition; exports.configV1_1Definition = configV1_1Definition; exports.configV1_2Definition = configV1_2Definition; exports.configV1_3Definition = configV1_3Definition; exports.configV1_4Definition = configV1_4Definition; exports.defaultConfig = defaultConfig; exports.getLocaleCodeDelimiter = getLocaleCodeDelimiter; exports.localeCodeSchema = localeCodeSchema; exports.localeCodes = localeCodes; exports.localeCodesFull = localeCodesFull; exports.localeCodesFullExplicitRegion = localeCodesFullExplicitRegion; exports.localeCodesFullUnderscore = localeCodesFullUnderscore; exports.localeCodesShort = localeCodesShort; exports.localeSchema = localeSchema; exports.normalizeLocale = normalizeLocale; exports.parseI18nConfig = parseI18nConfig; exports.resolveLocaleCode = resolveLocaleCode; exports.resolveOverridenLocale = resolveOverridenLocale;
+exports.LATEST_CONFIG_DEFINITION = LATEST_CONFIG_DEFINITION; exports.bucketItemSchema = bucketItemSchema; exports.bucketTypeSchema = bucketTypeSchema; exports.bucketTypes = bucketTypes; exports.configV0Definition = configV0Definition; exports.configV1Definition = configV1Definition; exports.configV1_1Definition = configV1_1Definition; exports.configV1_2Definition = configV1_2Definition; exports.configV1_3Definition = configV1_3Definition; exports.configV1_4Definition = configV1_4Definition; exports.defaultConfig = defaultConfig; exports.getLocaleCodeDelimiter = getLocaleCodeDelimiter; exports.localeCodeSchema = localeCodeSchema; exports.localeCodes = localeCodes; exports.localeCodesFull = localeCodesFull; exports.localeCodesFullExplicitRegion = localeCodesFullExplicitRegion; exports.localeCodesFullUnderscore = localeCodesFullUnderscore; exports.localeCodesShort = localeCodesShort; exports.localeSchema = localeSchema; exports.normalizeLocale = normalizeLocale; exports.parseI18nConfig = parseI18nConfig; exports.resolveLocaleCode = resolveLocaleCode; exports.resolveOverriddenLocale = resolveOverriddenLocale;

package/build/index.d.cts

@@ -69,15 +69,47 @@ declare const localeMap: {
 type LocaleCodeShort = keyof typeof localeMap;
 type LocaleCodeFull = (typeof localeMap)[LocaleCodeShort][number];
 type LocaleCode = LocaleCodeShort | LocaleCodeFull;
+type LocaleDelimiter = "-" | "_" | null;
 declare const localeCodesShort: LocaleCodeShort[];
 declare const localeCodesFull: LocaleCodeFull[];
 declare const localeCodesFullUnderscore: string[];
 declare const localeCodesFullExplicitRegion: string[];
 declare const localeCodes: LocaleCode[];
 declare const localeCodeSchema: Z.ZodEffects<Z.ZodString, string, string>;
-declare const resolveLocaleCode: (value: LocaleCode) => LocaleCodeFull;
-declare const getLocaleCodeDelimiter: (locale: string) => string | null;
-declare const resolveOverridenLocale: (locale: string, delimiter?: "-" | "_" | null) => string;
+/**
+ * Resolves a locale code to its full locale representation.
+ *
+ *  If the provided locale code is already a full locale code, it returns as is.
+ *  If the provided locale code is a short locale code, it returns the first corresponding full locale.
+ *  If the locale code is not found, it throws an error.
+ *
+ * @param {localeCodes} value - The locale code to resolve (either short or full)
+ * @return {LocaleCodeFull} The resolved full locale code
+ * @throws {Error} If the provided locale code is invalid.
+ */
+declare const resolveLocaleCode: (value: string) => LocaleCodeFull;
+/**
+ * Determines the delimiter used in a locale code
+ *
+ * @param {string} locale - the locale string (e.g.,"en_US","en-GB")
+ * @return { string | null} - The delimiter ("_" or "-") if found, otherwise `null`.
+ */
+declare const getLocaleCodeDelimiter: (locale: string) => LocaleDelimiter;
+/**
+ * Replaces the delimiter in a locale string with the specified delimiter.
+ *
+ * @param {string}locale - The locale string (e.g.,"en_US", "en-GB").
+ * @param {"-" | "_" | null} [delimiter] - The new delimiter to replace the existing one.
+ * @returns {string} The locale string with the replaced delimiter, or the original locale if no delimiter is provided.
+ */
+declare const resolveOverriddenLocale: (locale: string, delimiter?: LocaleDelimiter) => string;
+/**
+ * Normalizes a locale string by replacing underscores with hyphens
+ * and removing the "r" in certain regional codes (e.g., "fr-rCA" → "fr-CA")
+ *
+ * @param {string} locale - The locale string (e.g.,"en_US", "en-GB").
+ * @return {string} The normalized locale string.
+ */
 declare function normalizeLocale(locale: string): string;
 
 declare const bucketTypes: readonly ["android", "csv", "flutter", "html", "json", "markdown", "xcode-strings", "xcode-stringsdict", "xcode-xcstrings", "yaml", "yaml-root-key", "properties", "po", "xliff", "xml", "srt", "dato", "compiler", "vtt", "php", "po", "vue-json"];
@@ -484,4 +516,4 @@ declare const defaultConfig: {
     $schema: string;
 };
 
-export { type BucketItem, type I18nConfig, LATEST_CONFIG_DEFINITION, type LocaleCode, type LocaleCodeFull, type LocaleCodeShort, bucketItemSchema, bucketTypeSchema, bucketTypes, configV0Definition, configV1Definition, configV1_1Definition, configV1_2Definition, configV1_3Definition, configV1_4Definition, defaultConfig, getLocaleCodeDelimiter, localeCodeSchema, localeCodes, localeCodesFull, localeCodesFullExplicitRegion, localeCodesFullUnderscore, localeCodesShort, localeSchema, normalizeLocale, parseI18nConfig, resolveLocaleCode, resolveOverridenLocale };
+export { type BucketItem, type I18nConfig, LATEST_CONFIG_DEFINITION, type LocaleCode, type LocaleCodeFull, type LocaleCodeShort, type LocaleDelimiter, bucketItemSchema, bucketTypeSchema, bucketTypes, configV0Definition, configV1Definition, configV1_1Definition, configV1_2Definition, configV1_3Definition, configV1_4Definition, defaultConfig, getLocaleCodeDelimiter, localeCodeSchema, localeCodes, localeCodesFull, localeCodesFullExplicitRegion, localeCodesFullUnderscore, localeCodesShort, localeSchema, normalizeLocale, parseI18nConfig, resolveLocaleCode, resolveOverriddenLocale };

package/build/index.d.ts

@@ -69,15 +69,47 @@ declare const localeMap: {
 type LocaleCodeShort = keyof typeof localeMap;
 type LocaleCodeFull = (typeof localeMap)[LocaleCodeShort][number];
 type LocaleCode = LocaleCodeShort | LocaleCodeFull;
+type LocaleDelimiter = "-" | "_" | null;
 declare const localeCodesShort: LocaleCodeShort[];
 declare const localeCodesFull: LocaleCodeFull[];
 declare const localeCodesFullUnderscore: string[];
 declare const localeCodesFullExplicitRegion: string[];
 declare const localeCodes: LocaleCode[];
 declare const localeCodeSchema: Z.ZodEffects<Z.ZodString, string, string>;
-declare const resolveLocaleCode: (value: LocaleCode) => LocaleCodeFull;
-declare const getLocaleCodeDelimiter: (locale: string) => string | null;
-declare const resolveOverridenLocale: (locale: string, delimiter?: "-" | "_" | null) => string;
+/**
+ * Resolves a locale code to its full locale representation.
+ *
+ *  If the provided locale code is already a full locale code, it returns as is.
+ *  If the provided locale code is a short locale code, it returns the first corresponding full locale.
+ *  If the locale code is not found, it throws an error.
+ *
+ * @param {localeCodes} value - The locale code to resolve (either short or full)
+ * @return {LocaleCodeFull} The resolved full locale code
+ * @throws {Error} If the provided locale code is invalid.
+ */
+declare const resolveLocaleCode: (value: string) => LocaleCodeFull;
+/**
+ * Determines the delimiter used in a locale code
+ *
+ * @param {string} locale - the locale string (e.g.,"en_US","en-GB")
+ * @return { string | null} - The delimiter ("_" or "-") if found, otherwise `null`.
+ */
+declare const getLocaleCodeDelimiter: (locale: string) => LocaleDelimiter;
+/**
+ * Replaces the delimiter in a locale string with the specified delimiter.
+ *
+ * @param {string}locale - The locale string (e.g.,"en_US", "en-GB").
+ * @param {"-" | "_" | null} [delimiter] - The new delimiter to replace the existing one.
+ * @returns {string} The locale string with the replaced delimiter, or the original locale if no delimiter is provided.
+ */
+declare const resolveOverriddenLocale: (locale: string, delimiter?: LocaleDelimiter) => string;
+/**
+ * Normalizes a locale string by replacing underscores with hyphens
+ * and removing the "r" in certain regional codes (e.g., "fr-rCA" → "fr-CA")
+ *
+ * @param {string} locale - The locale string (e.g.,"en_US", "en-GB").
+ * @return {string} The normalized locale string.
+ */
 declare function normalizeLocale(locale: string): string;
 
 declare const bucketTypes: readonly ["android", "csv", "flutter", "html", "json", "markdown", "xcode-strings", "xcode-stringsdict", "xcode-xcstrings", "yaml", "yaml-root-key", "properties", "po", "xliff", "xml", "srt", "dato", "compiler", "vtt", "php", "po", "vue-json"];
@@ -484,4 +516,4 @@ declare const defaultConfig: {
     $schema: string;
 };
 
-export { type BucketItem, type I18nConfig, LATEST_CONFIG_DEFINITION, type LocaleCode, type LocaleCodeFull, type LocaleCodeShort, bucketItemSchema, bucketTypeSchema, bucketTypes, configV0Definition, configV1Definition, configV1_1Definition, configV1_2Definition, configV1_3Definition, configV1_4Definition, defaultConfig, getLocaleCodeDelimiter, localeCodeSchema, localeCodes, localeCodesFull, localeCodesFullExplicitRegion, localeCodesFullUnderscore, localeCodesShort, localeSchema, normalizeLocale, parseI18nConfig, resolveLocaleCode, resolveOverridenLocale };
+export { type BucketItem, type I18nConfig, LATEST_CONFIG_DEFINITION, type LocaleCode, type LocaleCodeFull, type LocaleCodeShort, type LocaleDelimiter, bucketItemSchema, bucketTypeSchema, bucketTypes, configV0Definition, configV1Definition, configV1_1Definition, configV1_2Definition, configV1_3Definition, configV1_4Definition, defaultConfig, getLocaleCodeDelimiter, localeCodeSchema, localeCodes, localeCodesFull, localeCodesFullExplicitRegion, localeCodesFullUnderscore, localeCodesShort, localeSchema, normalizeLocale, parseI18nConfig, resolveLocaleCode, resolveOverriddenLocale };

package/build/index.mjs

@@ -288,7 +288,7 @@ var getLocaleCodeDelimiter = (locale) => {
     return null;
   }
 };
-var resolveOverridenLocale = (locale, delimiter) => {
+var resolveOverriddenLocale = (locale, delimiter) => {
   if (!delimiter) {
     return locale;
   }
@@ -526,5 +526,5 @@ export {
   normalizeLocale,
   parseI18nConfig,
   resolveLocaleCode,
-  resolveOverridenLocale
+  resolveOverriddenLocale
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingo.dev/_spec",
-  "version": "0.26.3",
+  "version": "0.26.4",
   "description": "Lingo.dev open specification",
   "private": false,
   "publishConfig": {