// 配置文件应该由 `module.exports` 导出
module.exports = {
	lans: ["en-US", "es-MX"],
	refer: "en-US",
	output: "build/locales"
}

{
	translation: {
		auto: true,
		retryTime: 0,
		interval: 1000,
		inBatch: false,
		resolve: {}
	},
}

interface TranslationResolveChatgpt {
	translator: "chatgpt"
	rules?: string[]
	options: {
		organization: string
		apiKey: string
	}
	proxy?: tunnel.ProxyOptions
}

resolve: {
	translator: "chatgpt",
	rules: [],
	options: {
		organization: "",
		apiKey: "",
	},
	proxy: {
		host: "127.0.0.1",
		port: 10809,
	},
},

interface TranslationResolveYoudao {
	translator: "youdao"
	options: {
		key: string
		appkey: string
		api?: string
		vocabId?: string
	}
}
	
resolve: {
	translator: "youdao",
	options: {
		key: "",
		appkey: "",
	},
},

type Translator= (props: { config: Config; from: string; to: string; content:  I18NPLAN.TranslationContent[] }) => Promise<I18NPLAN.TranslationContent[] | TranslationError>
type TranslationContent = { key: string[]; value: string; lanName: string }
type TranslationError = {
	errorCode: number
	error: any
}

resolve: {
	custom: ({ config, from, to, content }) => {
		return new Promise((resolve, reject) => {
			resolve(content.map(item => ({...item, value: "from the custom translation"})))
		})
	},
}

function setLan(lanRes: I18NPLAN.Lan, isRestore?: boolean): I18NPLAN.Lan

function  getLan(key: string | string[], params?: Record<string, I18NPLAN.BasicLanValue>): I18NPLAN.BasicLanValue | undefined

import { setLan, getLan } from "i18n-plan"
console.log(
	setLan({
		page1: {
			name: "hello, I'm the page one",
			templateString: "what's the time? It's ${date}",
		},
	})
)
console.log(getLan("page1,templateString", { date: new Date().toLocaleTimeString() })) // what's the time? It's 11:28:45 AM
console.log(
	setLan({
		page2: {
			name: "while I'm the page two",
		},
	})
)
console.log(getLan("page2,name")) // while I'm the page two
console.log(setLan({}, true)) // {}

//  如果你想要翻译 `page1` 和 `page2` 中的 `name`
{
	"page1": {
		"name": "hello, I'm the page one",
		"templateString": "what's the time? It's ${date}"
	},
	"page2": {
		"name": "while I'm the page two",
	}
}
// 期望的文件内容是:
 {
 	"keys": ["page1,name", "page2,name"]
 }

module.exports = {
	/*
		定义翻译的目标语言。此设置中列出的每一项都是输出文件的名称。
		当与翻译功能一起使用时，每一项都将作为翻译的目标语言发送给翻译服务，所以该值必须与翻译器要求的语言代码一致
	*/
	lans: ["en-US", "es-MX", "zh-CN"],
	// 指定将用作生成其他语言参考的主要语言
	refer: "en-US",
	// 指定输出目录，相对于根目录的路径
	output: "locales",
	// 是否缓存历史增删项. 如果设为 true，你可以在 `_cache.json` 文件中找到增删项的 key
	generateCache: true,
	// 翻译配置
	translation: {
		/* 
			默认: false
			是否在同步语言资源后自动化翻译。如果设置为 true，则新增加项将自动放入翻译队列中
		*/
		auto: true,
		/*
			默认: 0
			如果有翻译项失败，进行重试的次数
		*/
		 retryTime: 0,
		/*
			默认: 1000
			设置请求的时间间隔。建议避免发送过于频繁的请求
		*/
		 interval: 1000,
		/*
			默认: false
			是逐个翻译项目，还是一次性翻译某种语言的所有项目。只适用于 ChatGPT 和自定义翻译
		*/
		inBatch: true,
		/* 
			两个翻译服务开箱即用：有道和ChatGPT，此外，还提供了一个自定义函数，可以将其他翻译服务（如谷歌或DeepL）集成到我们的流程中
		*/
		resolve: {
			translator: "chatgpt",
			// 设置一个正则表达式数组，指导 ChatGPT 跳过与其匹配的特定文本，可以让 ChatGPT 排除某些单词或格式保留其原始文本
			rules: ["(<[a-zA-Z /]+>)"],
			options: {
				// organization key
				organization: "",
				// apiKey
				apiKey: "",
			},
			// 如果你所在的地区需要通过 VPN 才能访问 ChatGPT, 那么 `proxy` 配置是必需的
			proxy: {
				host: "127.0.0.1",
				port: 10809,
			},
		},
		resolve: {
			translator: "youdao",
			options: {
				api: "https://openapi.youdao.com/api",
				// key
				key: "",
				// appkey
				appkey: "",
				// 有道翻译使用自己的词典来过滤特殊单词或格式。请查看官方文档以获取详细信息
				vocabId: "",
			},
		},
		/*
			这个自定义函数允许您根据您的喜好集成其他的翻译服务
		*/ 
		resolve: {
			/*
				type Translator= (props: { config: Config; from: string; to: string; content:  I18NPLAN.TranslationContent[] }) => Promise<I18NPLAN.TranslationContent[] | TranslationError>
				type TranslationContent = { key: string[]; value: string; lanName: string }
				type TranslationError = {
					errorCode: number
					error: any
				}
			*/
			custom: ({ config, from, to, content }) => {
				return new Promise((resolve, reject) => {
					resolve(content.map(item => ({...item, value: "来自自定义翻译器"})))
				})
			},
		}
	},
}