Add type definitions for i18n component and v-t directive

Demivan · Demivan · commit b32127827fd9 · 2023-06-15T14:00:42.000+03:00
diff --git a/index.d.ts b/index.d.ts
@@ -1,19 +1,57 @@
-// #region Vue 2
-declare module 'vue/types/vue' {
-  interface Vue {
-    $t: (key: string, values?: Record<string, unknown>) => string
-    $ta: (key: string, values?: Record<string, unknown>) => Record<string, string>
+import { PropType, DefineComponent, FunctionDirective } from 'vue-demi'
+import { FluentVariable } from '@fluent/bundle'
+
+type ComponentType = DefineComponent<{
+  /**
+   * The key of the translation.
+   */
+  path: {
+    type: StringConstructor,
+    required: true,
+  },
+  /**
+   * Arguments to pass to the translation.
+   */
+  args: {
+    type: PropType<Record<string, FluentVariable>>,
+    default: () => Record<string, FluentVariable>,
+  },
+  /**
+   * The tag to use as a root element.
+   */
+  tag: {
+    type: StringConstructor,
+    default: 'span',
+  },
+  /**
+   * Whether to render translation as html.
+   */
+  html: {
+    type: BooleanConstructor,
+    default: false,
+  },
+  /**
+   * Whether to render translation without a root element.
+   */
+  noTag: {
+    type: BooleanConstructor,
+    default: false,
   }
-}
-// #endregion
+}>
 
-// #region Vue 3
-declare module '@vue/runtime-core' {
+declare module 'vue' {
   interface ComponentCustomProperties {
     $t: (key: string, values?: Record<string, unknown>) => string
     $ta: (key: string, values?: Record<string, unknown>) => Record<string, string>
   }
+
+  interface ComponentCustomProperties {
+    vT: FunctionDirective<HTMLElement, Record<string, FluentVariable>>
+  }
+
+  interface GlobalComponents {
+    i18n: ComponentType
+  }
 }
-// #endregion
 
 export * from './dist'
