@voerkai18n/runtime/src/types.ts

runtime of voerkai18n

import type { VoerkaI18nManager } from "./manager"
import { VoerkaI18nFormatterConfig } from "./formatter/types"
import type { VoerkaI18nScope, VoerkaI18nScopeOptions } from "./scope" 
import type { BCP47LanguageTagName } from "bcp47-language-tags"  
import { LiteEventListener,LiteEventSubscriber } from "flex-tools/events/liteEvent" 


export type SupportedDateTypes = "String" | "Number" | "Boolean" | "Object" | "Array" | "Function" | "Error" | "Symbol" | "RegExp" | "Date" | "Null" | "Undefined" | "Set" | "Map" | "WeakSet" | "WeakMap"

// 语言包
export type VoerkaI18nLanguageMessages = Record<
    string, 
    string | string[] | VoerkaI18nFormatterConfig | boolean
>

export type VoerkaI18nLanguageMessagePack = Record<LanguageName, 
    VoerkaI18nLanguageMessages 
    | VoerkaI18nLanguageLoader
    | VoerkaI18nLanguageAsyncChunk
> 

export type VoerkaI18nLanguageAsyncChunk = ()=> Promise<any>

export type VoerkaI18nDynamicLanguageMessages = Record<string, string | string[]> & {
    $config?: VoerkaI18nFormatterConfig
}   

export interface VoerkaI18nLanguagePack {
    [language: string]: VoerkaI18nLanguageMessages
}

export type Voerkai18nIdMap = Record<string, number>

export type VoerkaI18nToBeTranslatedMessage = string | ((language:string,vars?:VoerkaI18nTranslateVars,options?: VoerkaI18nTranslateOptions)=>string | Promise<string>)


 
export interface VoerkaI18nLanguage {
    name        : string               // 语言代码
    title?      : string               // 语言标题
    nativeTitle?: string               // 用原语言表达的标题
    default?    : boolean              // 是否默认语言
    active?     : boolean              // 是否激活      
    fallback?   : string               // 回退语言
}

// 提供一个简单的KV存储接口,用来加载相关的存储
export interface IVoerkaI18nStorage{
    get(key:string):any
    set(key:string,value:any):void
    remove(key:string):any
}

export type VoerkaI18nNamespaces = Record<string, string | string[] | ((file: string) => boolean)>
 
export type VoerkaI18nLanguageLoader = (newLanguage:string,scope:VoerkaI18nScope)=>Promise<VoerkaI18nLanguageMessages | undefined | void>
 
export type VoerkaI18nTranslateOptions = {
    language?:  LanguageCodes
    transform?:  boolean
}
export type VoerkaI18nTranslateVars = Record<string,any> | number | boolean | string | (number | boolean | string)[] | (()=>VoerkaI18nTranslateVars)


export type VoerkaI18nTranslate<R=string> = (message:string, vars?:VoerkaI18nTranslateVars, options?:VoerkaI18nTranslateOptions)=>R
 
export interface VoerkaI18nSupportedLanguages {
    [key: string]: VoerkaI18nLanguage
}

export type VoerkaI18nPlugin = (manager:VoerkaI18nManager)=>void

export type LanguageName = string
declare global {   
    export var VoerkaI18n: VoerkaI18nManager
    export var __VoerkaI18nScopes__: VoerkaI18nScope[]
    export var __VoerkaI18nPlugins__: VoerkaI18nPlugin[]
}

   
  
export type VoerkaI18nEvents = {
    log             : { level: string, message:string }                  // 当有日志输出时
    init            : ()=>string                                         // 当第一个应用Scope注册时触发
    ready           : string                                             // 当初始化切换完成后触发
    change          : string                                             // 当语言切换后时, payload=language
    restore         : { scope:string,language:string }                   // 当Scope加载并从本地存储中读取语言包合并到语言包时 ，data={language,scope}
    patched         : { scope:string,language:string }                   // 当Scope加载并从本地存储中读取语言包合并到语言包时 ，data={language,scope}    
    error           : Error                                              // 当有错误发生时    
    "scope/change"  : { scope:string,language:string }                   //  
    "scope/fallback": { scope:string,from:string,to:string}              // 当切换到无效的语言或者加载失败时，进行回退
} 
    
export type Dict<T=any> = Record<string,T>

export type LanguageCodes = BCP47LanguageTagName
 

export type VoerkaI18nSettings ={
    entry?                  : string                // 语言包入口，默认为"languages"
    readonly defaultLanguage: string
    readonly activeLanguage : string
} & Omit<VoerkaI18nScopeOptions, 'storage' | 'idMap' | 'formatters' | 'log' | 'attached' | 'loader' | 'messages'>  


export type VoerkaI18nLanguageParagraphs = Record<string, any>
// { zh-CN: { <id>: message,..., <id>: message} }
export type VoerkaI18nParagraphs = Record<LanguageName, Record<string, VoerkaI18nLanguageParagraphs>>


export type VoerkaI18nTranslateProps<
    Options extends VoerkaI18nTranslateOptions = VoerkaI18nTranslateOptions,
    Children=any
>= {
    id?       : string
    message?  : VoerkaI18nToBeTranslatedMessage
    vars?     : VoerkaI18nTranslateVars
    default?  : any
    tag?      : string
    options?  : Options    
    children? : Children 
    style?    : any
    className?: string
}

export type VoerkaI18nTranslateComponentBuilder<Component=any> = (scope:VoerkaI18nScope)=>Component


export type VoerkaI18nTranslateTransformer<R> = (result:string,vars?:VoerkaI18nTranslateVars,options?:VoerkaI18nTranslateOptions)=>R
export type VoerkaI18nTranslateTransformBuilder<R> = (scope:VoerkaI18nScope)=>VoerkaI18nTranslateTransformer<R>

export type VoerkaI18nEventListener = LiteEventListener
export type VoerkaI18nEventSubscriber = LiteEventSubscriber