@xndrjs/i18n 0.8.0 → 0.8.2-alpha.0

package/src/codegen/emit/instance-file.ts

@@ -1,257 +0,0 @@
-import { GENERATED_FILE_BANNER, toModuleBasename, toRelativeModuleImport } from "../paths.js";
-import type { DeliveryMode, LoaderStrategy } from "../codegen-config-schema.js";
-import type { ImportExtension } from "../types.js";
-
-/** Emits the generated instance module: `createI18n` factory wrapping the ICU provider. */
-export interface InstanceFileOptions {
-  typesOutputPath: string;
-  namespaceLoadersOutputPath: string;
-  paramsTypeName: string;
-  schemaTypeName: string;
-  localeTypeName: string;
-  localeFallbackConstName: string;
-  factoryName: string;
-  hasLocaleFallback: boolean;
-  hasLocaleType: boolean;
-  importExtension: ImportExtension;
-  delivery: DeliveryMode;
-  localeDeliveryAreaConstName?: string;
-  loaderStrategy?: LoaderStrategy;
-}
-
-const STATE_TYPE = `{ dictionary: InitialSchema; resources?: readonly (readonly [string, string])[] }`;
-
-export function formatInstanceFile(options: InstanceFileOptions): string {
-  const {
-    typesOutputPath,
-    namespaceLoadersOutputPath,
-    paramsTypeName,
-    schemaTypeName,
-    localeTypeName,
-    localeFallbackConstName,
-    factoryName,
-    hasLocaleFallback,
-    hasLocaleType,
-    importExtension,
-    delivery,
-    localeDeliveryAreaConstName = "LOCALE_DELIVERY_AREA",
-    loaderStrategy = "import",
-  } = options;
-
-  const providerClass = "IcuTranslationProviderMulti";
-  const typesModule = toModuleBasename(typesOutputPath);
-  const typesImport = toRelativeModuleImport(typesModule, importExtension);
-  const loadersModule = toModuleBasename(namespaceLoadersOutputPath);
-  const loadersImport = toRelativeModuleImport(loadersModule, importExtension);
-  const schemaTypesImport = `import type { ${paramsTypeName}, ${schemaTypeName}, InitialSchema } from '${typesImport}';\n`;
-  const typesImportLine = formatTypesValueImport({
-    hasLocaleType,
-    hasLocaleFallback,
-    localeTypeName,
-    localeFallbackConstName,
-    localeDeliveryAreaConstName,
-    delivery,
-    typesImport,
-  });
-  const packageImports = formatPackageImports(providerClass, loaderStrategy);
-  const loadersImportLine =
-    loaderStrategy === "fetch"
-      ? `import { createNamespaceLoaders } from '${loadersImport}';\n`
-      : `import { namespaceLoaders } from '${loadersImport}';\n`;
-
-  const createFactoryBlock = formatCreateI18nFactory({
-    providerClass,
-    schemaTypeName,
-    paramsTypeName,
-    localeTypeName,
-    localeFallbackConstName,
-    factoryName,
-    hasLocaleFallback,
-    delivery,
-    localeDeliveryAreaConstName,
-    loaderStrategy,
-  });
-
-  return (
-    `${GENERATED_FILE_BANNER}` +
-    `import {\n` +
-    `  ${packageImports},\n` +
-    `} from '@xndrjs/i18n';\n` +
-    schemaTypesImport +
-    typesImportLine +
-    loadersImportLine +
-    `\n` +
-    createFactoryBlock
-  );
-}
-
-function formatTypesValueImport(options: {
-  hasLocaleType: boolean;
-  hasLocaleFallback: boolean;
-  localeTypeName: string;
-  localeFallbackConstName: string;
-  localeDeliveryAreaConstName: string;
-  delivery: DeliveryMode;
-  typesImport: string;
-}): string {
-  const {
-    hasLocaleType,
-    hasLocaleFallback,
-    localeTypeName,
-    localeFallbackConstName,
-    localeDeliveryAreaConstName,
-    delivery,
-    typesImport,
-  } = options;
-
-  if (!hasLocaleType && delivery !== "custom") {
-    return "";
-  }
-
-  const valueNames: string[] = [];
-  if (hasLocaleFallback) {
-    valueNames.push(localeFallbackConstName);
-  }
-  if (delivery === "custom") {
-    valueNames.push(localeDeliveryAreaConstName);
-  }
-
-  if (valueNames.length > 0 && hasLocaleType) {
-    return `import { ${valueNames.join(", ")}, type ${localeTypeName} } from '${typesImport}';\n`;
-  }
-  if (valueNames.length > 0) {
-    return `import { ${valueNames.join(", ")} } from '${typesImport}';\n`;
-  }
-  if (hasLocaleType) {
-    return `import type { ${localeTypeName} } from '${typesImport}';\n`;
-  }
-  return "";
-}
-
-function formatCreateI18nFactory(options: {
-  providerClass: string;
-  schemaTypeName: string;
-  paramsTypeName: string;
-  localeTypeName: string;
-  localeFallbackConstName: string;
-  factoryName: string;
-  hasLocaleFallback: boolean;
-  delivery: DeliveryMode;
-  localeDeliveryAreaConstName: string;
-  loaderStrategy: LoaderStrategy;
-}): string {
-  const {
-    providerClass,
-    schemaTypeName,
-    paramsTypeName,
-    localeTypeName,
-    localeFallbackConstName,
-    factoryName,
-    hasLocaleFallback,
-    delivery,
-    localeDeliveryAreaConstName,
-    loaderStrategy,
-  } = options;
-
-  const providerTypeArgs = hasLocaleFallback
-    ? `${schemaTypeName}, ${paramsTypeName}, ${localeTypeName}, typeof ${localeFallbackConstName}`
-    : `${schemaTypeName}, ${paramsTypeName}`;
-  const handleReturnType = `I18nHandle<${schemaTypeName}, ${paramsTypeName}, ${localeTypeName}>`;
-  const handleTypeArgs = `<${schemaTypeName}, ${paramsTypeName}, ${localeTypeName}>`;
-
-  const partitionForLocale =
-    delivery === "custom"
-      ? `    partitionForLocale: (locale) => ${localeDeliveryAreaConstName}[locale],\n`
-      : `    partitionForLocale: (locale) => locale,\n`;
-
-  const optionsType =
-    loaderStrategy === "fetch"
-      ? `{ fetchImpl: FetchArtifact; state?: ${STATE_TYPE}; onMissing?: OnMissingTranslation }`
-      : `{ state?: ${STATE_TYPE}; onMissing?: OnMissingTranslation }`;
-
-  const optionsParam =
-    loaderStrategy === "fetch" ? `  options: ${optionsType},\n` : `  options?: ${optionsType},\n`;
-
-  const namespaceLoadersLine =
-    loaderStrategy === "fetch"
-      ? `    namespaceLoaders: createNamespaceLoaders(fetchImpl),\n`
-      : `    namespaceLoaders,\n`;
-
-  return (
-    `export function ${factoryName}(\n` +
-    optionsParam +
-    `): ${handleReturnType} {\n` +
-    formatBody({
-      providerClass,
-      providerTypeArgs,
-      hasLocaleFallback,
-      localeFallbackConstName,
-      loaderStrategy,
-    }) +
-    `  engine.seedBuilderResources(normalized.resources);\n` +
-    `  return createI18nHandle${handleTypeArgs}(engine, {\n` +
-    namespaceLoadersLine +
-    partitionForLocale +
-    `  } as I18nHandleOptions<${schemaTypeName}, ${localeTypeName}>);\n` +
-    `}\n`
-  );
-}
-
-function formatBody(options: {
-  providerClass: string;
-  providerTypeArgs: string;
-  hasLocaleFallback: boolean;
-  localeFallbackConstName: string;
-  loaderStrategy: LoaderStrategy;
-}): string {
-  const {
-    providerClass,
-    providerTypeArgs,
-    hasLocaleFallback,
-    localeFallbackConstName,
-    loaderStrategy,
-  } = options;
-
-  if (loaderStrategy === "fetch") {
-    const engineBlock = hasLocaleFallback
-      ? `  const engine = new ${providerClass}<${providerTypeArgs}>(normalized.dictionary, {\n` +
-        `    localeFallback: ${localeFallbackConstName},\n` +
-        `    ...providerOptions,\n` +
-        `  });\n`
-      : `  const engine = new ${providerClass}<${providerTypeArgs}>(normalized.dictionary, providerOptions);\n`;
-
-    return (
-      `  const { fetchImpl, state, ...providerOptions } = options;\n` +
-      `  const normalized = normalizeI18nCreateInput(state);\n` +
-      engineBlock
-    );
-  }
-
-  const engineBlock = hasLocaleFallback
-    ? `  const engine = new ${providerClass}<${providerTypeArgs}>(normalized.dictionary, {\n` +
-      `    localeFallback: ${localeFallbackConstName},\n` +
-      `    ...providerOptions,\n` +
-      `  });\n`
-    : `  const engine = new ${providerClass}<${providerTypeArgs}>(normalized.dictionary, providerOptions);\n`;
-
-  return (
-    `  const { state, ...providerOptions } = options ?? {};\n` +
-    `  const normalized = normalizeI18nCreateInput(state);\n` +
-    engineBlock
-  );
-}
-
-function formatPackageImports(providerClass: string, loaderStrategy: LoaderStrategy): string {
-  const names = [
-    providerClass,
-    "createI18nHandle",
-    "normalizeI18nCreateInput",
-    "type I18nHandle",
-    "type I18nHandleOptions",
-    "type OnMissingTranslation",
-  ];
-  if (loaderStrategy === "fetch") {
-    names.push("type FetchArtifact");
-  }
-  return names.join(",\n  ");
-}

package/src/codegen/emit/namespace-loaders-file.test.ts

@@ -1,251 +0,0 @@
-import path from "node:path";
-import { describe, expect, it } from "vitest";
-import { formatNamespaceLoadersFile } from "./namespace-loaders-file.js";
-
-const projectRoot = "/project";
-const loadersOutputPath = path.join(projectRoot, "src/i18n/namespace-loaders.generated.ts");
-
-describe("formatNamespaceLoadersFile", () => {
-  it("emits ns(locale) loaders in split mode", () => {
-    const output = formatNamespaceLoadersFile({
-      loadersOutputPath,
-      lazyEntries: [
-        {
-          namespace: "billing",
-          filePath: "src/i18n/translations/billing.json",
-          absolutePath: path.join(projectRoot, "src/i18n/translations/billing.json"),
-        },
-        {
-          namespace: "default",
-          filePath: "src/i18n/translations/default.json",
-          absolutePath: path.join(projectRoot, "src/i18n/translations/default.json"),
-        },
-        {
-          namespace: "user",
-          filePath: "src/i18n/translations/user.json",
-          absolutePath: path.join(projectRoot, "src/i18n/translations/user.json"),
-        },
-      ],
-      schemaTypeName: "AppSchema",
-      localeTypeName: "AppLocale",
-      typesModule: "i18n-types.generated",
-      importExtension: "none",
-      projectRoot,
-      delivery: "split-by-locale",
-      requestLocales: ["en", "it", "de-CH"],
-      splitPathsByNamespace: {
-        billing: {
-          en: "src/i18n/generated/translations/billing.en.json",
-          it: "src/i18n/generated/translations/billing.it.json",
-          "de-CH": "src/i18n/generated/translations/billing.de-CH.json",
-        },
-        default: {
-          en: "src/i18n/generated/translations/default.en.json",
-          it: "src/i18n/generated/translations/default.it.json",
-          "de-CH": "src/i18n/generated/translations/default.de-CH.json",
-        },
-        user: {
-          en: "src/i18n/generated/translations/user.en.json",
-          it: "src/i18n/generated/translations/user.it.json",
-          "de-CH": "src/i18n/generated/translations/user.de-CH.json",
-        },
-      },
-    });
-
-    expect(output).toContain(
-      "import type { AppSchema, LazyNamespace, AppLocale } from './i18n-types.generated';"
-    );
-    expect(output).toContain("[K in LazyNamespace]: (locale: AppLocale) => Promise<AppSchema[K]>;");
-    expect(output).toContain("billing: (locale) => {");
-    expect(output).toContain('case "en":');
-    expect(output).toContain('case "it":');
-    expect(output).toContain('case "de-CH":');
-    expect(output).toContain(
-      'throw new Error(`[i18n] No translation artifact for namespace "billing" and locale "${String(locale)}".`);'
-    );
-    expect(output).toContain(
-      "return import('./generated/translations/billing.en.json').then((m) => m.default);"
-    );
-    expect(output).toContain("user: (locale) => {");
-    expect(output).toContain(
-      'export const defaultLazyNamespaces = ["billing", "default", "user"] as const;'
-    );
-    expect(output.match(/from '\.\/i18n-types\.generated'/g)?.length).toBe(1);
-  });
-
-  it("throws when a split path is missing", () => {
-    expect(() =>
-      formatNamespaceLoadersFile({
-        loadersOutputPath,
-        lazyEntries: [
-          {
-            namespace: "billing",
-            filePath: "src/i18n/translations/billing.json",
-            absolutePath: path.join(projectRoot, "src/i18n/translations/billing.json"),
-          },
-        ],
-        schemaTypeName: "AppSchema",
-        localeTypeName: "AppLocale",
-        typesModule: "i18n-types.generated",
-        importExtension: "none",
-        projectRoot,
-        delivery: "split-by-locale",
-        requestLocales: ["en", "it"],
-        splitPathsByNamespace: {
-          billing: {
-            en: "src/i18n/generated/translations/billing.en.json",
-          },
-        },
-      })
-    ).toThrow('[Codegen Error] Missing split path for namespace "billing", locale "it".');
-  });
-
-  it("emits ns(area) loaders in custom mode", () => {
-    const output = formatNamespaceLoadersFile({
-      loadersOutputPath,
-      lazyEntries: [
-        {
-          namespace: "billing",
-          filePath: "src/i18n/translations/billing.json",
-          absolutePath: path.join(projectRoot, "src/i18n/translations/billing.json"),
-        },
-        {
-          namespace: "default",
-          filePath: "src/i18n/translations/default.json",
-          absolutePath: path.join(projectRoot, "src/i18n/translations/default.json"),
-        },
-      ],
-      schemaTypeName: "AppSchema",
-      localeTypeName: "AppLocale",
-      typesModule: "i18n-types.generated",
-      importExtension: "none",
-      projectRoot,
-      delivery: "custom",
-      deliveryAreaTypeName: "AppDeliveryArea",
-      deliveryAreaNames: ["eu", "us"],
-      splitPathsByNamespace: {
-        billing: {
-          eu: "src/i18n/generated/translations/billing.eu.json",
-          us: "src/i18n/generated/translations/billing.us.json",
-        },
-        default: {
-          eu: "src/i18n/generated/translations/default.eu.json",
-          us: "src/i18n/generated/translations/default.us.json",
-        },
-      },
-    });
-
-    expect(output).toContain(
-      "import type { AppSchema, LazyNamespace, AppDeliveryArea } from './i18n-types.generated';"
-    );
-    expect(output).toContain(
-      "[K in LazyNamespace]: (area: AppDeliveryArea) => Promise<AppSchema[K]>;"
-    );
-    expect(output).toContain("billing: (area) => {");
-    expect(output).toContain('case "eu":');
-    expect(output).toContain('case "us":');
-    expect(output).toContain(
-      'throw new Error(`[i18n] No translation artifact for namespace "billing" and area "${String(area)}".`);'
-    );
-    expect(output).toContain(
-      "return import('./generated/translations/billing.eu.json').then((m) => m.default);"
-    );
-    expect(output).toContain(
-      'export const defaultLazyNamespaces = ["billing", "default"] as const;'
-    );
-  });
-
-  it("throws when a custom delivery split path is missing", () => {
-    expect(() =>
-      formatNamespaceLoadersFile({
-        loadersOutputPath,
-        lazyEntries: [
-          {
-            namespace: "billing",
-            filePath: "src/i18n/translations/billing.json",
-            absolutePath: path.join(projectRoot, "src/i18n/translations/billing.json"),
-          },
-        ],
-        schemaTypeName: "AppSchema",
-        localeTypeName: "AppLocale",
-        typesModule: "i18n-types.generated",
-        importExtension: "none",
-        projectRoot,
-        delivery: "custom",
-        deliveryAreaTypeName: "AppDeliveryArea",
-        deliveryAreaNames: ["eu", "us"],
-        splitPathsByNamespace: {
-          billing: {
-            eu: "src/i18n/generated/translations/billing.eu.json",
-          },
-        },
-      })
-    ).toThrow('[Codegen Error] Missing split path for namespace "billing", area "us".');
-  });
-
-  it("emits fetch loaders that pass a resource id to fetchImpl", () => {
-    const output = formatNamespaceLoadersFile({
-      loadersOutputPath,
-      lazyEntries: [
-        {
-          namespace: "billing",
-          filePath: "src/i18n/translations/billing.json",
-          absolutePath: path.join(projectRoot, "src/i18n/translations/billing.json"),
-        },
-      ],
-      schemaTypeName: "AppSchema",
-      localeTypeName: "AppLocale",
-      typesModule: "i18n-types.generated",
-      importExtension: "none",
-      projectRoot,
-      delivery: "split-by-locale",
-      requestLocales: ["en", "it"],
-      loaderStrategy: "fetch",
-      splitPathsByNamespace: {
-        billing: {
-          en: "src/i18n/generated/translations/billing.en.json",
-          it: "src/i18n/generated/translations/billing.it.json",
-        },
-      },
-    });
-
-    expect(output).toContain("export function createNamespaceLoaders");
-    expect(output).toContain("import type { FetchArtifact }");
-    expect(output).toContain(
-      'fetchImpl({ locale, namespace: "billing" }) as Promise<AppSchema["billing"]>'
-    );
-  });
-
-  it("emits custom-delivery fetch loaders with locale + area", () => {
-    const output = formatNamespaceLoadersFile({
-      loadersOutputPath,
-      lazyEntries: [
-        {
-          namespace: "billing",
-          filePath: "src/i18n/translations/billing.json",
-          absolutePath: path.join(projectRoot, "src/i18n/translations/billing.json"),
-        },
-      ],
-      schemaTypeName: "AppSchema",
-      localeTypeName: "AppLocale",
-      typesModule: "i18n-types.generated",
-      importExtension: "none",
-      projectRoot,
-      delivery: "custom",
-      deliveryAreaTypeName: "AppDeliveryArea",
-      deliveryAreaNames: ["eu", "us"],
-      loaderStrategy: "fetch",
-      splitPathsByNamespace: {
-        billing: {
-          eu: "src/i18n/generated/translations/billing.eu.json",
-          us: "src/i18n/generated/translations/billing.us.json",
-        },
-      },
-    });
-
-    expect(output).toContain("(area, { locale }) =>");
-    expect(output).toContain(
-      'fetchImpl({ locale, namespace: "billing", area }) as Promise<AppSchema["billing"]>'
-    );
-  });
-});