typedoc 0.26.11 → 0.27.0-beta.1

package/dist/lib/internationalization/internationalization.js

@@ -1,24 +1,42 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Internationalization = void 0;
-const assert_1 = require("assert");
-const utils_1 = require("../utils");
-const translatable_1 = require("./translatable");
-const fs_1 = require("fs");
-const path_1 = require("path");
-const kind_1 = require("../models/reflections/kind");
-const models_1 = require("../models");
-// If we're running in ts-node, then we need the TS source rather than
-// the compiled file.
-const ext = process[Symbol.for("ts-node.register.instance")]
-    ? "cts"
-    : "cjs";
+import { ok } from "assert";
+import { DefaultMap, unique } from "../utils/index.js";
+import { readdirSync } from "fs";
+import { join } from "path";
+import { ReflectionKind } from "../models/reflections/kind.js";
+import { ReflectionFlag } from "../models/index.js";
+import {} from "./translatable.js";
+import translatable from "./locales/en.cjs";
+import { createRequire } from "node:module";
+import { fileURLToPath } from "node:url";
 /**
  * Simple internationalization module which supports placeholders.
  * See {@link TranslatableStrings} for a description of how this module works and how
  * plugins should add translations.
  */
-class Internationalization {
+export class Internationalization {
+    application;
+    allTranslations = new DefaultMap((lang) => {
+        const req = createRequire(fileURLToPath(import.meta.url));
+        // Make sure this isn't abused to load some random file by mistake
+        ok(/^[A-Za-z-]+$/.test(lang), "Locale names may only contain letters and dashes");
+        try {
+            return new Map(Object.entries(req(`./locales/${lang}.cjs`)));
+        }
+        catch {
+            return new Map();
+        }
+    });
+    /**
+     * Proxy object which supports dynamically translating
+     * all supported keys. This is generally used rather than the translate
+     * method so that renaming a key on the `translatable` object that contains
+     * all of the default translations will automatically update usage locations.
+     */
+    proxy = new Proxy(this, {
+        get(internationalization, key) {
+            return (...args) => internationalization.translate(key, ...args);
+        },
+    });
     /**
      * If constructed without an application, will use the default language.
      * Intended for use in unit tests only.
@@ -26,29 +44,6 @@ class Internationalization {
      */
     constructor(application) {
         this.application = application;
-        this.allTranslations = new utils_1.DefaultMap((lang) => {
-            // Make sure this isn't abused to load some random file by mistake
-            (0, assert_1.ok)(/^[A-Za-z-]+$/.test(lang), "Locale names may only contain letters and dashes");
-            try {
-                return new Map(
-                // eslint-disable-next-line @typescript-eslint/no-require-imports
-                Object.entries(require(`./locales/${lang}.${ext}`)));
-            }
-            catch {
-                return new Map();
-            }
-        });
-        /**
-         * Proxy object which supports dynamically translating
-         * all supported keys. This is generally used rather than the translate
-         * method so that renaming a key on the `translatable` object that contains
-         * all of the default translations will automatically update usage locations.
-         */
-        this.proxy = new Proxy(this, {
-            get(internationalization, key) {
-                return (...args) => internationalization.translate(key, ...args);
-            },
-        });
     }
     /**
      * Get the translation of the specified key, replacing placeholders
@@ -56,139 +51,139 @@ class Internationalization {
      */
     translate(key, ...args) {
         return (this.allTranslations.get(this.application?.lang ?? "en").get(key) ??
-            translatable_1.translatable[key]).replace(/\{(\d+)\}/g, (_, index) => {
+            translatable[key]).replace(/\{(\d+)\}/g, (_, index) => {
             return args[+index] ?? "(no placeholder)";
         });
     }
     kindSingularString(kind) {
         switch (kind) {
-            case kind_1.ReflectionKind.Project:
+            case ReflectionKind.Project:
                 return this.proxy.kind_project();
-            case kind_1.ReflectionKind.Module:
+            case ReflectionKind.Module:
                 return this.proxy.kind_module();
-            case kind_1.ReflectionKind.Namespace:
+            case ReflectionKind.Namespace:
                 return this.proxy.kind_namespace();
-            case kind_1.ReflectionKind.Enum:
+            case ReflectionKind.Enum:
                 return this.proxy.kind_enum();
-            case kind_1.ReflectionKind.EnumMember:
+            case ReflectionKind.EnumMember:
                 return this.proxy.kind_enum_member();
-            case kind_1.ReflectionKind.Variable:
+            case ReflectionKind.Variable:
                 return this.proxy.kind_variable();
-            case kind_1.ReflectionKind.Function:
+            case ReflectionKind.Function:
                 return this.proxy.kind_function();
-            case kind_1.ReflectionKind.Class:
+            case ReflectionKind.Class:
                 return this.proxy.kind_class();
-            case kind_1.ReflectionKind.Interface:
+            case ReflectionKind.Interface:
                 return this.proxy.kind_interface();
-            case kind_1.ReflectionKind.Constructor:
+            case ReflectionKind.Constructor:
                 return this.proxy.kind_constructor();
-            case kind_1.ReflectionKind.Property:
+            case ReflectionKind.Property:
                 return this.proxy.kind_property();
-            case kind_1.ReflectionKind.Method:
+            case ReflectionKind.Method:
                 return this.proxy.kind_method();
-            case kind_1.ReflectionKind.CallSignature:
+            case ReflectionKind.CallSignature:
                 return this.proxy.kind_call_signature();
-            case kind_1.ReflectionKind.IndexSignature:
+            case ReflectionKind.IndexSignature:
                 return this.proxy.kind_index_signature();
-            case kind_1.ReflectionKind.ConstructorSignature:
+            case ReflectionKind.ConstructorSignature:
                 return this.proxy.kind_constructor_signature();
-            case kind_1.ReflectionKind.Parameter:
+            case ReflectionKind.Parameter:
                 return this.proxy.kind_parameter();
-            case kind_1.ReflectionKind.TypeLiteral:
+            case ReflectionKind.TypeLiteral:
                 return this.proxy.kind_type_literal();
-            case kind_1.ReflectionKind.TypeParameter:
+            case ReflectionKind.TypeParameter:
                 return this.proxy.kind_type_parameter();
-            case kind_1.ReflectionKind.Accessor:
+            case ReflectionKind.Accessor:
                 return this.proxy.kind_accessor();
-            case kind_1.ReflectionKind.GetSignature:
+            case ReflectionKind.GetSignature:
                 return this.proxy.kind_get_signature();
-            case kind_1.ReflectionKind.SetSignature:
+            case ReflectionKind.SetSignature:
                 return this.proxy.kind_set_signature();
-            case kind_1.ReflectionKind.TypeAlias:
+            case ReflectionKind.TypeAlias:
                 return this.proxy.kind_type_alias();
-            case kind_1.ReflectionKind.Reference:
+            case ReflectionKind.Reference:
                 return this.proxy.kind_reference();
-            case kind_1.ReflectionKind.Document:
+            case ReflectionKind.Document:
                 return this.proxy.kind_document();
         }
     }
     kindPluralString(kind) {
         switch (kind) {
-            case kind_1.ReflectionKind.Project:
+            case ReflectionKind.Project:
                 return this.proxy.kind_plural_project();
-            case kind_1.ReflectionKind.Module:
+            case ReflectionKind.Module:
                 return this.proxy.kind_plural_module();
-            case kind_1.ReflectionKind.Namespace:
+            case ReflectionKind.Namespace:
                 return this.proxy.kind_plural_namespace();
-            case kind_1.ReflectionKind.Enum:
+            case ReflectionKind.Enum:
                 return this.proxy.kind_plural_enum();
-            case kind_1.ReflectionKind.EnumMember:
+            case ReflectionKind.EnumMember:
                 return this.proxy.kind_plural_enum_member();
-            case kind_1.ReflectionKind.Variable:
+            case ReflectionKind.Variable:
                 return this.proxy.kind_plural_variable();
-            case kind_1.ReflectionKind.Function:
+            case ReflectionKind.Function:
                 return this.proxy.kind_plural_function();
-            case kind_1.ReflectionKind.Class:
+            case ReflectionKind.Class:
                 return this.proxy.kind_plural_class();
-            case kind_1.ReflectionKind.Interface:
+            case ReflectionKind.Interface:
                 return this.proxy.kind_plural_interface();
-            case kind_1.ReflectionKind.Constructor:
+            case ReflectionKind.Constructor:
                 return this.proxy.kind_plural_constructor();
-            case kind_1.ReflectionKind.Property:
+            case ReflectionKind.Property:
                 return this.proxy.kind_plural_property();
-            case kind_1.ReflectionKind.Method:
+            case ReflectionKind.Method:
                 return this.proxy.kind_plural_method();
-            case kind_1.ReflectionKind.CallSignature:
+            case ReflectionKind.CallSignature:
                 return this.proxy.kind_plural_call_signature();
-            case kind_1.ReflectionKind.IndexSignature:
+            case ReflectionKind.IndexSignature:
                 return this.proxy.kind_plural_index_signature();
-            case kind_1.ReflectionKind.ConstructorSignature:
+            case ReflectionKind.ConstructorSignature:
                 return this.proxy.kind_plural_constructor_signature();
-            case kind_1.ReflectionKind.Parameter:
+            case ReflectionKind.Parameter:
                 return this.proxy.kind_plural_parameter();
-            case kind_1.ReflectionKind.TypeLiteral:
+            case ReflectionKind.TypeLiteral:
                 return this.proxy.kind_plural_type_literal();
-            case kind_1.ReflectionKind.TypeParameter:
+            case ReflectionKind.TypeParameter:
                 return this.proxy.kind_plural_type_parameter();
-            case kind_1.ReflectionKind.Accessor:
+            case ReflectionKind.Accessor:
                 return this.proxy.kind_plural_accessor();
-            case kind_1.ReflectionKind.GetSignature:
+            case ReflectionKind.GetSignature:
                 return this.proxy.kind_plural_get_signature();
-            case kind_1.ReflectionKind.SetSignature:
+            case ReflectionKind.SetSignature:
                 return this.proxy.kind_plural_set_signature();
-            case kind_1.ReflectionKind.TypeAlias:
+            case ReflectionKind.TypeAlias:
                 return this.proxy.kind_plural_type_alias();
-            case kind_1.ReflectionKind.Reference:
+            case ReflectionKind.Reference:
                 return this.proxy.kind_plural_reference();
-            case kind_1.ReflectionKind.Document:
+            case ReflectionKind.Document:
                 return this.proxy.kind_plural_document();
         }
     }
     flagString(flag) {
         switch (flag) {
-            case models_1.ReflectionFlag.None:
+            case ReflectionFlag.None:
                 throw new Error("Should be unreachable");
-            case models_1.ReflectionFlag.Private:
+            case ReflectionFlag.Private:
                 return this.proxy.flag_private();
-            case models_1.ReflectionFlag.Protected:
+            case ReflectionFlag.Protected:
                 return this.proxy.flag_protected();
-            case models_1.ReflectionFlag.Public:
+            case ReflectionFlag.Public:
                 return this.proxy.flag_public();
-            case models_1.ReflectionFlag.Static:
+            case ReflectionFlag.Static:
                 return this.proxy.flag_static();
-            case models_1.ReflectionFlag.External:
+            case ReflectionFlag.External:
                 return this.proxy.flag_external();
-            case models_1.ReflectionFlag.Optional:
+            case ReflectionFlag.Optional:
                 return this.proxy.flag_optional();
-            case models_1.ReflectionFlag.Rest:
+            case ReflectionFlag.Rest:
                 return this.proxy.flag_rest();
-            case models_1.ReflectionFlag.Abstract:
+            case ReflectionFlag.Abstract:
                 return this.proxy.flag_abstract();
-            case models_1.ReflectionFlag.Const:
+            case ReflectionFlag.Const:
                 return this.proxy.flag_const();
-            case models_1.ReflectionFlag.Readonly:
+            case ReflectionFlag.Readonly:
                 return this.proxy.flag_readonly();
-            case models_1.ReflectionFlag.Inherited:
+            case ReflectionFlag.Inherited:
                 return this.proxy.flag_inherited();
         }
     }
@@ -226,10 +221,9 @@ class Internationalization {
      * Gets a list of all languages with at least one translation.
      */
     getSupportedLanguages() {
-        return (0, utils_1.unique)([
-            ...(0, fs_1.readdirSync)((0, path_1.join)(__dirname, "locales")).map((x) => x.substring(0, x.indexOf("."))),
+        return unique([
+            ...readdirSync(join(fileURLToPath(import.meta.url), "../locales")).map((x) => x.substring(0, x.indexOf("."))),
             ...this.allTranslations.keys(),
         ]).sort();
     }
 }
-exports.Internationalization = Internationalization;

package/dist/lib/internationalization/locale-utils.cjs

@@ -0,0 +1,8 @@
+"use strict";
+function buildTranslation(translations) {
+    return translations;
+}
+function buildIncompleteTranslation(translations) {
+    return translations;
+}
+module.exports = { buildTranslation, buildIncompleteTranslation };

package/dist/lib/internationalization/locale-utils.d.cts

@@ -0,0 +1,8 @@
+import type { BuiltinTranslatableStringConstraints } from "./translatable.js" with { "resolution-mode": "import" };
+declare function buildTranslation<T extends BuiltinTranslatableStringConstraints>(translations: T): T;
+declare function buildIncompleteTranslation<T extends Partial<BuiltinTranslatableStringConstraints>>(translations: T): T;
+declare const _default: {
+    buildTranslation: typeof buildTranslation;
+    buildIncompleteTranslation: typeof buildIncompleteTranslation;
+};
+export = _default;