// Copyright 2023 GoEdge CDN goedge.cdn@gmail.com. All rights reserved. Official site: https://goedge.cn .
//go:build plus

package ossconfigs

type OSSBucketParam = string

const (
	OSSBucketParamInput     OSSBucketParam = "input"     // 输入Bucket
	OSSBucketParamPrefix    OSSBucketParam = "prefix"    // 作为前缀，类似于：/bucket/filename
	OSSBucketParamArg       OSSBucketParam = "arg"       // 从参数中提取
	OSSBucketParamSubDomain OSSBucketParam = "subDomain" // 子域名
)

type OSSBucketParamDefinition struct {
	Name        string         `json:"name"`
	Code        OSSBucketParam `json:"code"`
	Description string         `json:"description"`
	Example     string         `json:"example"`
}

func FindAllOSSBucketParamDefinitions() []*OSSBucketParamDefinition {
	return []*OSSBucketParamDefinition{
		{
			Name:        "指定${optionName}",
			Code:        OSSBucketParamInput,
			Description: "在当前表单中输入${optionName}名称",
		},
		{
			Name:        "URL前缀",
			Code:        OSSBucketParamPrefix,
			Description: "从访问的URL中的文件路径前缀中获取${optionName}名称",
			Example:     "/BUCKET-NAME/filename",
		},
		{
			Name:        "参数",
			Code:        OSSBucketParamArg,
			Description: "从访问的URL参数中获取${optionName}名称",
			Example:     "/filename?ARG=BUCKET-NAME",
		},
		{
			Name:        "子域名",
			Code:        OSSBucketParamSubDomain,
			Description: "从访问的子域名中获取${optionName}名称",
			Example:     "BUCKET-NAME.example.com/filename",
		},
	}
}