@peassoft/mnr-langs 1.0.1 → 1.2.0

package/dist/index.d.ts

@@ -23,6 +23,27 @@ export declare const defaultLanguage: "en";
  * @public
  */
 export type SupportedLanguage = UnionOf<typeof supportedLanguages>;
+/**
+ * Descriptor of a supported language
+ *
+ * @public
+ */
+export type SupportedLanguageDescriptor = {
+    code: SupportedLanguage;
+    name: string;
+};
+/**
+ * Return supported languages descriptors
+ *
+ * @public
+ */
+export declare function supportedLanguagesDescriptors(): ReadonlyArray<SupportedLanguageDescriptor>;
+/**
+ * Return language descriptor for the default language
+ *
+ * @public
+ */
+export declare function defautlLanguageDescriptor(): SupportedLanguageDescriptor;
 /**
  * Get all remaining supported languages except the given one.
  *
@@ -37,5 +58,13 @@ export declare function getRemainingLanguages(lang: SupportedLanguage): Supporte
  * @public
  */
 export declare function langToPathSegment(lang: SupportedLanguage): '/' | `/${typeof lang}/`;
+/**
+ * Validate and type assert a value as a supported language.
+ *
+ * If the value is not a supported language, returns `null`.
+ *
+ * @public
+ */
+export declare function validateLanguage(value: unknown): SupportedLanguage | null;
 export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,mBAAmB;AACnB,KAAK,OAAO,CAAC,CAAC,SAAS,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC;AAE3D;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,uBAAwB,CAAC;AAExD;;;;GAIG;AACH,eAAO,MAAM,eAAe,MAAwB,CAAC;AAErD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAEnE;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,iBAAiB,GAAG,iBAAiB,EAAE,CAElF;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,iBAAiB,GAAG,GAAG,GAAG,IAAI,OAAO,IAAI,GAAG,CAGnF"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,mBAAmB;AACnB,KAAK,OAAO,CAAC,CAAC,SAAS,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC;AAE3D;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,uBAAwB,CAAC;AAExD;;;;GAIG;AACH,eAAO,MAAM,eAAe,MAAwB,CAAC;AAErD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAEnE;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,iBAAiB,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,6BAA6B,IAAI,aAAa,CAAC,2BAA2B,CAAC,CAK1F;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,IAAI,2BAA2B,CAEvE;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,iBAAiB,GAAG,iBAAiB,EAAE,CAElF;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,iBAAiB,GAAG,GAAG,GAAG,IAAI,OAAO,IAAI,GAAG,CAGnF;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,iBAAiB,GAAG,IAAI,CAKzE"}

package/dist/index.js

@@ -15,6 +15,25 @@ export const supportedLanguages = ['en', 'ru'];
  * @public
  */
 export const defaultLanguage = supportedLanguages[0];
+/**
+ * Return supported languages descriptors
+ *
+ * @public
+ */
+export function supportedLanguagesDescriptors() {
+    return [
+        { code: 'en', name: 'English' },
+        { code: 'ru', name: 'Русский' },
+    ];
+}
+/**
+ * Return language descriptor for the default language
+ *
+ * @public
+ */
+export function defautlLanguageDescriptor() {
+    return { code: 'en', name: 'English' };
+}
 /**
  * Get all remaining supported languages except the given one.
  *
@@ -35,4 +54,17 @@ export function langToPathSegment(lang) {
         return '/';
     return `/${lang}/`;
 }
+/**
+ * Validate and type assert a value as a supported language.
+ *
+ * If the value is not a supported language, returns `null`.
+ *
+ * @public
+ */
+export function validateLanguage(value) {
+    if (typeof value === 'string' && supportedLanguages.includes(value)) {
+        return value;
+    }
+    return null;
+}
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,IAAI,EAAE,IAAI,CAAU,CAAC;AAExD;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC;AASrD;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAAuB;IAC3D,OAAO,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAuB;IACvD,IAAI,IAAI,KAAK,eAAe;QAAE,OAAO,GAAG,CAAC;IACzC,OAAO,IAAI,IAAI,GAAG,CAAC;AACrB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,IAAI,EAAE,IAAI,CAAU,CAAC;AAExD;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC;AAmBrD;;;;GAIG;AACH,MAAM,UAAU,6BAA6B;IAC3C,OAAO;QACL,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE;QAC/B,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE;KAChC,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,yBAAyB;IACvC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;AACzC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAAuB;IAC3D,OAAO,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAuB;IACvD,IAAI,IAAI,KAAK,eAAe;QAAE,OAAO,GAAG,CAAC;IACzC,OAAO,IAAI,IAAI,GAAG,CAAC;AACrB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,kBAAkB,CAAC,QAAQ,CAAC,KAA0B,CAAC,EAAE,CAAC;QACzF,OAAO,KAA0B,CAAC;IACpC,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peassoft/mnr-langs",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "The source of truth for supported UI languages in Memorize'n'Revise",
   "type": "module",
   "exports": "./dist/index.js",
@@ -16,6 +16,7 @@
     "@memnrev/eslint-v9-config": "^0.4.0",
     "@microsoft/api-extractor": "^7.54.0",
     "@total-typescript/ts-reset": "^0.6.1",
+    "asserttt": "^1.0.1",
     "del-cli": "^7.0.0",
     "eslint": "^9.8.0",
     "typescript": "^5.2.0",