@ethnolib/find-language 0.1.2 → 0.1.4

package/langtagProcessingHelpers.d.ts

@@ -0,0 +1,78 @@
+import { ILanguage, IScript, LanguageType } from './findLanguageInterfaces';
+export declare const COMMA_SEPARATOR = ", ";
+export interface ILanguageInternal {
+    autonym: string;
+    exonym: string;
+    iso639_3_code: string;
+    languageSubtag: string;
+    regionNames: Set<string>;
+    names: Set<string>;
+    scripts: {
+        [key: string]: IScript;
+    };
+    alternativeTags: Set<string>;
+    isRepresentativeForMacrolanguage: boolean;
+    isMacrolanguage: boolean;
+    parentMacrolanguage?: ILanguage;
+    languageType: LanguageType;
+}
+export interface ILangtagsJsonEntryInternal {
+    full: string;
+    iso639_3: string;
+    iana: string[];
+    latnnames: string[];
+    localname: string;
+    localnames: string[];
+    macrolang: string;
+    name: string;
+    names: string[];
+    nophonvars: boolean;
+    obsolete: boolean;
+    region: string;
+    regions: string[];
+    regionname: string;
+    rod: string;
+    script: string;
+    sldr: string;
+    supress: boolean;
+    tag: string;
+    tags: string[];
+    unwritten: boolean;
+    variants: string[];
+    windows: string;
+    isRepresentativeForMacrolanguage: boolean;
+}
+interface IIsoCodeDetailsInternal {
+    isMacrolanguage: boolean;
+    languageType: LanguageType;
+    iso639_3Code: string;
+    iso639_1Code: string;
+    name: string;
+}
+export declare const scriptNames: {
+    [key: string]: string;
+};
+export declare const isoCodesDetails: {
+    [key: string]: IIsoCodeDetailsInternal;
+};
+export declare const iso639_1To639_3: {
+    [key: string]: string;
+};
+export declare const indivlangsToMacrolangs: {
+    [key: string]: string;
+};
+export declare const macrolangsToRepresentativeLangs: {
+    [key: string]: string;
+};
+export declare const macrolanguagesByCode: {
+    [key: string]: ILanguage;
+};
+export declare function getLanguageType(iso639_3: string): LanguageType;
+export declare function isMacrolanguage(iso639_3: string): boolean;
+export declare function defaultScriptForLanguage(languageTag: string, language?: ILanguage): IScript | undefined;
+export declare function getAllPossibleNames(entry: ILangtagsJsonEntryInternal): Set<string>;
+export declare function uncomma(str: string | undefined): string | undefined;
+export declare function uncommaAll(strs: Set<string>): Set<string>;
+export declare function stripMacrolanguageParenthetical(languageName: string): string;
+export declare function stripMacrolanguageParentheticalFromAll(names: Set<string>): Set<string>;
+export {};

package/languageTagUtils.d.ts

@@ -1,3 +1,4 @@
+import { ILanguage, IOrthography, IRegion, IScript } from './findLanguageInterfaces';
 export declare function getShortestSufficientLangtag(langtag: string): string | undefined;
 export declare function getMaximalLangtag(langtag: string): string | undefined;
 export declare function createTag({ languageCode, scriptCode, regionCode, dialectCode, }: {
@@ -6,3 +7,24 @@ export declare function createTag({ languageCode, scriptCode, regionCode, dialec
     regionCode?: string;
     dialectCode?: string;
 }): string;
+export declare function codeMatches(code1: string | undefined, code2: string | undefined): boolean;
+export declare const UNLISTED_LANGUAGE: ILanguage;
+export declare function isUnlistedLanguage(selectedLanguage: ILanguage | undefined): boolean;
+export declare function languageForManuallyEnteredTag(manuallyEnteredTag: string): ILanguage;
+export declare function isManuallyEnteredTagLanguage(selectedLanguage: ILanguage | undefined): boolean;
+export declare function isValidBcp47Tag(tag: string | undefined): boolean;
+interface ITagParts {
+    languageSubtag: string | undefined;
+    scriptSubtag: string | undefined;
+    regionSubtag: string | undefined;
+    variantSubtag?: string;
+    privateUseSubtag?: string;
+    otherSubtags?: string[];
+}
+export declare function splitTag(tag: string): ITagParts;
+export declare function parseLangtagFromLangChooser(languageTag: string, // must be the default language subtag for the language
+searchResultModifier?: (results: ILanguage[], searchString: string) => ILanguage[]): IOrthography | undefined;
+export declare function defaultRegionForLangTag(languageTag: string): IRegion | undefined;
+export declare function createTagFromOrthography(orthography: IOrthography): string;
+export declare function defaultDisplayName(language?: ILanguage, script?: IScript): string | undefined;
+export {};

package/matchingSubstringDemarcation.d.ts

@@ -1,7 +1,7 @@
-import { FuseResult } from 'fuse.js';
 import { ILanguage } from './findLanguageInterfaces';
 export declare const START_OF_MATCH_MARKER = "[";
 export declare const END_OF_MATCH_MARKER = "]";
-export declare function demarcateResults(results: FuseResult<ILanguage>[]): FuseResult<ILanguage>[];
+export declare const TEMPORARY_SEPARATOR = "###";
+export declare function demarcateResults(results: ILanguage[], searchString: string): ILanguage[];
 export declare function stripDemarcation(demarcatedText: string | undefined): string | undefined;
 export declare function deepStripDemarcation<T>(demarcated: T): T;

package/package.json

@@ -3,11 +3,12 @@
   "description": "A library for fuzzy-searching for languages and other utils for language choosers",
   "author": "SIL Global",
   "license": "MIT",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "main": "./index.js",
   "types": "./index.d.ts",
   "scripts": {
     "langtag-processing": "tsx ./langtagProcessing.ts",
+    "prebuild": "npm run langtag-processing",
     "build": "nx vite:build",
     "typecheck": "tsc",
     "test": "nx vite:test --config vitest.config.ts",
@@ -23,9 +24,5 @@
     "@types/node": "^20.16.11",
     "tsx": "^4.19.2",
     "typescript": "^5.2.2"
-  },
-  "// We've tested with 18 and have no reason to believe it won't work with higher versions": "",
-  "engines": {
-    "node": ">=18.18"
   }
 }

package/regionsAndScripts.d.ts

@@ -2,4 +2,4 @@ import { ILanguage, IRegion, IScript } from './findLanguageInterfaces';
 export declare function getAllRegions(): IRegion[];
 export declare function getRegionBySubtag(code: string): IRegion | undefined;
 export declare function getAllScripts(): IScript[];
-export declare function getScriptForLanguage(scriptCode: string, language: ILanguage): IScript | undefined;
+export declare function getScriptForLanguage(scriptCode: string, language?: ILanguage): IScript | undefined;

package/searchForLanguage.d.ts

@@ -1,5 +1,5 @@
-import { FuseResult } from 'fuse.js';
 import { ILanguage } from './findLanguageInterfaces';
 export declare const fieldsToSearch: string[];
-export declare function searchForLanguage(queryString: string): FuseResult<ILanguage>[];
-export declare function getLanguageBySubtag(code: string, searchResultModifier?: (results: FuseResult<ILanguage>[], searchString: string) => ILanguage[]): ILanguage | undefined;
+export declare function asyncSearchForLanguage(queryString: string, appendResults: (results: ILanguage[], forSearchString: string) => boolean): Promise<void>;
+export declare function asyncGetAllLanguageResults(searchString: string): Promise<ILanguage[]>;
+export declare function getLanguageBySubtag(code: string, searchResultModifier?: (results: ILanguage[], searchString: string) => ILanguage[]): ILanguage | undefined;

package/searchResultModifiers.d.ts

@@ -1,11 +1,8 @@
-import { FuseResult } from 'fuse.js';
 import { ILanguage, IScript } from './findLanguageInterfaces';
-export declare function stripResultMetadata(results: FuseResult<ILanguage>[]): ILanguage[];
 export declare function filterScripts(scriptFilter: (value: IScript) => boolean, results: ILanguage[]): ILanguage[];
 export declare function modifyScripts(scriptModifier: (value: IScript) => IScript, results: ILanguage[]): ILanguage[];
 export declare function rawIsoCode(result: ILanguage): string | undefined;
-export declare function codeMatches(code1: string | undefined, code2: string | undefined): boolean;
 export declare function substituteInModifiedEntry(targetCode: string, getModifiedEntry: (result: ILanguage) => ILanguage, results: ILanguage[]): ILanguage[];
 export declare function filterOnLanguageCode(langCodeFilter: (value: string) => boolean, results: ILanguage[]): ILanguage[];
 export declare function prioritizeLangByKeywords(keywords: string[], searchString: string, langCodeToPrioritize: string, results: ILanguage[]): ILanguage[];
-export declare function defaultSearchResultModifier(results: FuseResult<ILanguage>[], searchString: string): ILanguage[];
+export declare function defaultSearchResultModifier(results: ILanguage[], searchString: string): ILanguage[];

package/testUtils.d.ts

@@ -4,7 +4,8 @@ interface ILanguageTestEntry {
     exonym?: string;
     iso639_3_code?: string;
     languageSubtag?: string;
-    regionNames?: string;
+    regionNamesForDisplay?: string;
+    regionNamesForSearch?: string[];
     names?: string[];
     scripts?: IScript[];
     variants?: string;