@dialpad/i18n 1.22.3 → 1.24.0

package/src/locale-manager.ts

@@ -1,198 +0,0 @@
-import type { App } from 'vue';
-import type {
-  LocaleManagerParams,
-  SetLocaleParams,
-  UseI18N,
-} from '@dialpad/i18n-services/locale-manager';
-import { computed, ref, inject } from 'vue';
-import type { Ref } from 'vue';
-import { BaseLocaleManager } from '@dialpad/i18n-services/locale-manager';
-
-export const INJECTION_KEY_PREFIX = 'GLOBAL_LOCALE_MANAGER';
-
-/**
- * This is a backup storage for LocaleManagers in order to solve
- * the constraint of having to call useI18N() inside a <script setup>.
- *
- * This is kinda hackish (I tried to keep it simple as well) but otherwise we're forcing consumers
- * (i.e. Dialtone) to potentially modify their whole database
- * and set the <script> for each components to <script setup>
- *
- * (I haven't found a way to do this only relying on Vue 3 capabilities T_T)
- */
-export const globalLocaleManagers = new Map<string, LocaleManager>();
-
-export class LocaleManager extends BaseLocaleManager {
-  currentLocaleProp: Ref<string | null> = ref<string | null>(null);
-  app: App | null = null;
-
-  constructor(params: LocaleManagerParams) {
-    super(params);
-    this.setCurrentLocaleProp(
-      this.determineLocale({
-        preferredLocale: params.preferredLocale,
-        allowedLocales: params.allowedLocales,
-      }),
-    );
-  }
-
-  protected setCurrentLocaleProp(locale: string): void {
-    this.currentLocaleProp = ref(locale);
-  }
-
-  /**
-   * Registers this LocaleManager with the Vue instance so that it can
-   * be used by the {@link useI18N} hook.
-   *
-   * @param app - The Vue app to register with.
-   * @param namespace - The namespace to install the LocaleManager under.
-   *                     Defaults to 'default'
-   */
-  install(app: App, namespace = 'default'): void {
-    // initializes fluent if not initialized
-    this.initFluent();
-    this.addToVue(app, namespace);
-  }
-
-  private addToVue(app: App, namespace: string): void {
-    if (!this.fluent) {
-      throw new Error(
-        'fluent not ready, you probably want to call install(...) first',
-      );
-    }
-    this.app = app;
-
-    // Only install fluent plugin if not already installed
-    // This prevents "component i18n has already been registered" warnings
-    const isFluentInstalled = app.component('i18n') !== undefined;
-    if (!isFluentInstalled) {
-      app.use(this.fluent);
-    }
-
-    // Always register this LocaleManager for injection, regardless of plugin installation
-    app.provide(parseInjectionName(namespace), this);
-    globalLocaleManagers.set(parseInjectionName(namespace), this);
-  }
-
-  /**
-   * Changes the locale of the {@link LocaleManager} that is currently active in
-   * the app, or the one specified by the namespace.
-   *
-   * @param args - Optional parameters to pass to the underlying
-   *               {@link BaseLocaleManager#updateLocaleSettings} method.
-   * @param namespace - Optional namespace to change the locale of. If not
-   *                    provided, all LocaleManagers will be changed.
-   */
-  changeLocale(args?: Partial<SetLocaleParams>, namespace?: string): void {
-    const localeManagers = namespace
-      ? this.getLocaleManagerByNamespace(namespace)
-      : this.getAllLocaleManagers();
-
-    for (const localeManager of localeManagers) {
-      localeManager.updateLocaleSettings(args);
-    }
-  }
-
-  private getLocaleManagerByNamespace(namespace: string): LocaleManager[] {
-    const localeManager =
-      this.findLocaleManagerInProvides(namespace) ??
-      findLocaleManager(namespace);
-    if (!localeManager) {
-      throw new Error('LocaleManager not found!');
-    }
-    return [localeManager];
-  }
-
-  // This method mostly focuses on remain backward compatible and reduce risks when implementing new instance providing mechanisms
-  private findLocaleManagerInProvides(
-    namespace: string,
-  ): LocaleManager | undefined {
-    const providedValues = this.app?._context.provides;
-    if (!providedValues) {
-      return;
-    }
-
-    const targetKey = parseInjectionName(namespace);
-    return this.findLocaleManagersByKeyFilter(
-      providedValues,
-      (key) => key === targetKey,
-    )[0];
-  }
-
-  private getAllLocaleManagers(): LocaleManager[] {
-    const providedValues = this.app?._context.provides;
-    if (!providedValues) {
-      throw new Error('No locale managers are set up yet!');
-    }
-
-    return this.findLocaleManagersByKeyFilter(providedValues, (key) =>
-      key.startsWith(INJECTION_KEY_PREFIX.toString()),
-    );
-  }
-
-  private findLocaleManagersByKeyFilter(
-    providedValues: Record<string | symbol, unknown>,
-    keyFilter: (key: string) => boolean,
-  ): LocaleManager[] {
-    const localeManagers: LocaleManager[] = [];
-    Object.entries(providedValues).forEach(([key, value]) => {
-      if (
-        typeof key === 'string' &&
-        keyFilter(key) &&
-        value instanceof LocaleManager
-      ) {
-        localeManagers.push(value);
-      }
-    });
-
-    return localeManagers;
-  }
-
-  useI18N(namespace = 'default'): UseI18N {
-    this.initFluent();
-    const l = this;
-    return {
-      currentLocale: computed(() => this.currentLocaleProp.value),
-      setI18N: (args?: Partial<SetLocaleParams>, namespace?: string) => {
-        l.changeLocale(args, namespace);
-      },
-      get $t() {
-        return l.fluentFormat;
-      },
-      get $ta() {
-        return l.fluentFormatAttrs;
-      },
-    };
-  }
-}
-
-/**
- * Use i18n functionality without requiring to depend only on Vue's inject
- * @param namespace - The namespace of the locale manager to use, defaults to 'default'
- */
-export function findLocaleManager(
-  namespace: string,
-): LocaleManager | undefined {
-  const injectionKey = parseInjectionName(namespace);
-  // Use null as default to suppress Vue injection warning when key is not found
-  const injected = inject<LocaleManager | null>(injectionKey, null);
-  return injected ?? globalLocaleManagers.get(injectionKey);
-}
-
-// TODO - allow custom injection key or whatever???
-// TODO - also maybe just use getCurrentApp + the app's global config? idk.
-export function useI18N(namespace = 'default'): UseI18N {
-  const localeManager = findLocaleManager(namespace);
-
-  if (!localeManager) {
-    throw new Error(
-      `locale manager doesn't exist using ${namespace}. Make sure your locale manager was set up correctly`,
-    );
-  }
-
-  return localeManager.useI18N(namespace);
-}
-
-function parseInjectionName(namespace: string): string {
-  return `${INJECTION_KEY_PREFIX}.${namespace}`;
-}

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "./base-tsconfig.json",
-  "include": ["src/**/*.ts", "index.ts"],
-  "exclude": ["**/*.test.ts", "**/*.test-d.ts"],
-  "compilerOptions": {
-    "baseUrl": ".",
-    "outDir": "dist/types",
-    "declaration": true
-  }
-}

package/vite.config.ts

@@ -1,39 +0,0 @@
-import { defineConfig } from 'vite';
-import vue from '@vitejs/plugin-vue';
-import { fileURLToPath, URL } from 'node:url';
-
-export default defineConfig({
-  build: {
-    sourcemap: true,
-    minify: false,
-    rollupOptions: {
-      external: ['vue'],
-      output: {
-        preserveModules: false,
-        minifyInternalExports: false,
-        exports: 'named',
-      },
-      treeshake: 'smallest',
-    },
-    lib: {
-      entry: './index.ts',
-      formats: ['es', 'cjs'],
-    },
-  },
-  test: {
-    // Add test runner globals like test/it/describe/afterEach etc.
-    // This is required for VTL to automically call cleanup() in afterEach().
-    // See: https://vitest.dev/guide/migration.html
-    globals: true,
-    environment: 'jsdom',
-    coverage: {
-      reporter: ['html', 'json'],
-    },
-  },
-  plugins: [vue()],
-  resolve: {
-    alias: {
-      '@': fileURLToPath(new URL('../src', import.meta.url)),
-    },
-  },
-});