fix: export global composer interface

Author: kazupon

src/composer.ts

@@ -86,6 +86,7 @@ export type CustomBlocks = string[] | PreCompileHandler
 /**
  * Composer Options
  *
+ * @remarks
  * This is options to create composer.
  */
 export interface ComposerOptions {
@@ -117,6 +118,7 @@ export interface ComposerInternalOptions {
 /**
  * Composer Interfaces
  *
+ * @remarks
  * This is the interface for being used for Vue 3 Composition API.
  */
 export type Composer = {
@@ -265,6 +267,7 @@ export function addPreCompileMessages(
 
 /**
  * Create composer interface factory
+ *
  * @internal
  */
 export function createComposer(

src/directive.ts

@@ -21,10 +21,10 @@ function getComposer(
   instance: ComponentInternalInstance
 ): Composer | null {
   if (i18n.mode === 'composable') {
-    return i18n._getComposer(instance) || i18n._global
+    return i18n._getComposer(instance) || i18n.global
   } else {
     const vueI18n = i18n._getLegacy(instance)
-    return vueI18n != null ? vueI18n.__composer : i18n._global
+    return vueI18n != null ? vueI18n.__composer : i18n.global
   }
 }
 

src/i18n.ts

@@ -20,23 +20,28 @@ import { defineMixin } from './mixin'
 import { isEmptyObject } from './utils'
 
 /**
- * I18n Options
+ * I18n Options for `createI18n`
  *
  * @remarks
- * `I18nOptions` is inherited {@link ComposerOptions} and {@link VueI18nOptions}, so you can specify these options.
+ * `I18nOptions` is inherited {@link I18nAdditionalOptions}, {@link ComposerOptions} and {@link VueI18nOptions},
+ * so you can specify these options.
  *
  */
+export type I18nOptions = I18nAdditionalOptions &
+  (ComposerOptions | VueI18nOptions)
+
+/**
+ * I18n Additional Options for `createI18n`
+ */
 export interface I18nAdditionalOptions {
   /**
    * Whether vue-i18n legacy API use on your Vue App.
+   *
    * @defaultValue `false`
    */
   legacy?: boolean
 }
 
-export type I18nOptions = I18nAdditionalOptions &
-  (ComposerOptions | VueI18nOptions)
-
 /**
  * I18n API mode
  */
@@ -46,16 +51,32 @@ export type I18nMode = 'legacy' | 'composable'
  * I18n interface
  */
 export interface I18n {
+  /**
+   * I18n API mode
+   *
+   * @remarks
+   * if you specified `legacy: true` option in `createI18n`, return `legacy`,
+   * else `composable`
+   *
+   * @defaultValue `composable`
+   */
   readonly mode: I18nMode
+  /**
+   * Global composer
+   */
+  readonly global: Composer
+  /**
+   * @internal
+   */
   install(app: App, ...options: unknown[]): void
 }
 
 /**
  * I18n interface for internal usage
+ *
  * @internal
  */
 export interface I18nInternal {
-  readonly _global: Composer
   _getComposer(instance: ComponentInternalInstance): Composer | null
   _setComposer(instance: ComponentInternalInstance, composer: Composer): void
   _deleteComposer(instance: ComponentInternalInstance): void
@@ -70,17 +91,24 @@ export interface I18nInternal {
 export type I18nScope = 'local' | 'parent' | 'global'
 
 /**
- * Composer additional options
+ * I18n Options for `useI18n`
+ *
+ * @remarks
+ * `UseI18nOptions` is inherited {@link ComposerAdditionalOptions} and {@link ComposerOptions},
+ * so you can specify these options.
+ */
+export type UseI18nOptions = ComposerAdditionalOptions & ComposerOptions
+
+/**
+ * Composer additional options for `useI18n`
  *
- *  @remarks
+ * @remarks
  * `ComposerAdditionalOptions` is extend for {@link ComposerOptions}, so you can specify these options.
  */
 export interface ComposerAdditionalOptions {
-  useScope?: I18nScope // default 'global'
+  useScope?: I18nScope
 }
 
-export type UseI18nOptions = ComposerAdditionalOptions & ComposerOptions
-
 /**
  * I18n instance injectin key
  * @internal
@@ -97,7 +125,7 @@ export const I18nSymbol: InjectionKey<I18n & I18nInternal> = Symbol.for(
  *
  * @remarks
  * When you use Composable API, you need to specify options of {@link ComposerOptions}.
- * When you use Legacy API, you need toto specify options of {@link VueI18nOptions} and `legacy: true`.
+ * When you use Legacy API, you need toto specify options of {@link VueI18nOptions} and `legacy: true` option.
  *
  * @example
  * case: for Composable API
@@ -181,7 +209,7 @@ export function createI18n(options: I18nOptions = {}): I18n {
         )
       }
     },
-    get _global(): Composer {
+    get global(): Composer {
       return __legacyMode
         ? (__global as VueI18n).__composer
         : (__global as Composer)
@@ -264,7 +292,7 @@ export function useI18n(options: UseI18nOptions = {}): Composer {
     throw new Error('TODO')
   }
 
-  const global = i18n._global
+  const global = i18n.global
 
   let emptyOption = false
   // prettier-ignore

src/index.ts

@@ -48,4 +48,8 @@ export {
   UseI18nOptions
 } from './i18n'
 export { I18nPluginOptions } from './plugin'
+
+/**
+ * vue-i18n version
+ */
 export const VERSION = __VERSION__

src/legacy.ts

@@ -59,6 +59,7 @@ export interface Formatter {
 /**
  *  VueI18n Options
  *
+ *  @remarks
  *  This option is compatible with the constructor options of `VueI18n` class (offered with [email protected]).
  */
 export interface VueI18nOptions {
@@ -86,6 +87,7 @@ export interface VueI18nOptions {
 /**
  *  VueI18n Interfaces
  *
+ *  @remarks
  *  This interface is compatible with interface of `VueI18n` class (offered with [email protected]).
  */
 export type VueI18n = {
@@ -154,6 +156,7 @@ export type VueI18n = {
 
 /**
  * Convert to I18n Composer Options from VueI18n Options
+ *
  * @internal
  */
 function convertComposerOptions(
@@ -236,6 +239,7 @@ function convertComposerOptions(
 
 /**
  * create VueI18n interface factory
+ *
  * @internal
  */
 export function createVueI18n(

src/plugin.ts

@@ -4,7 +4,14 @@ import { Translation, NumberFormat, DatetimeFormat } from './components'
 import { vTDirective } from './directive'
 import { isPlainObject, isString, warn } from './utils'
 
+/**
+ * I18n plugin options
+ *
+ * @remarks
+ * An options specified when installing vue-i18n as Vue plugin with using `app.use`.
+ */
 export interface I18nPluginOptions {
+  // TODO: should be more redisigned, we should change to `boolean` option
   'i18n-t'?: string
 }