@cloudbase/manager-node 4.2.3 → 4.2.5

package/src/third/index.ts

@@ -1,24 +0,0 @@
-import { Environment } from '../environment'
-import { CloudService } from '../utils'
-
-export class ThirdService {
-    private cloudService: CloudService
-
-    constructor(environment: Environment) {
-        this.cloudService = new CloudService(environment.cloudBaseContext, 'tcb', '2018-06-08')
-    }
-
-    // 解除第三方小程序绑定
-    async deleteThirdPartAttach(options: {
-        ThirdPartAppid: string
-        TypeFlag: number
-    }): Promise<{
-        RequestId: string
-    }> {
-        const { ThirdPartAppid, TypeFlag } = options
-        return this.cloudService.request('DeleteThirdPartAttach', {
-            ThirdPartAppid,
-            TypeFlag
-        })
-    }
-}

package/src/user/index.ts

@@ -1,174 +0,0 @@
-import { Environment } from '../environment'
-import { CloudService, preLazy } from '../utils'
-import { EndUserInfo , EndUserStatus } from './types'
-
-export class UserService {
-    private environment: Environment
-    private tcbService: CloudService
-
-    constructor(environment: Environment) {
-        this.environment = environment
-        this.tcbService = new CloudService(environment.cloudBaseContext, 'tcb', '2018-06-08')
-    }
-
-    // 获取云开发用户列表
-    @preLazy()
-    public async getEndUserList(options: {
-        limit: number,
-        offset: number,
-    }) {
-        const { limit, offset } = options
-        const { EnvId } = this.environment.lazyEnvironmentConfig
-
-        return this.tcbService.request<{
-            Total: number
-            Users: EndUserInfo[]
-            RequestId: string
-        }>('DescribeEndUsers', {
-            EnvId,
-            Limit: limit,
-            Offset: offset
-        })
-    }
-
-    // // 停用云开发用户
-    // @preLazy()
-    // public async disableEndUser(options: {
-    //     uuid: string
-    // }) {
-    //     const { uuid } = options
-    //     const { EnvId } = this.environment.lazyEnvironmentConfig
-
-    //     return this.tcbService.request<{
-    //         RequestId: string
-    //     }>('ModifyEndUser', {
-    //         EnvId,
-    //         UUId: uuid,
-    //         Status: 'DISABLE'
-    //     })
-    // }
-
-    // 设置云开发用户状态（停用或启用）
-    @preLazy()
-    public async setEndUserStatus(options: {
-        uuid: string,
-        status: EndUserStatus
-    }) {
-        const { uuid, status } = options
-        const { EnvId } = this.environment.lazyEnvironmentConfig
-
-        return this.tcbService.request<{
-            RequestId: string
-        }>('ModifyEndUser', {
-            EnvId,
-            UUId: uuid,
-            Status: status
-        })
-    }
-
-    // 批量删除云开发用户
-    @preLazy()
-    public async deleteEndUsers(options: {
-        userList: string[]
-    }) {
-        const { userList } = options
-        const { EnvId } = this.environment.lazyEnvironmentConfig
-
-        return this.tcbService.request<{
-            RequestId: string
-        }>('DeleteEndUser', {
-            EnvId,
-            UserList: userList
-        })
-    }
-
-    // 创建用户名密码
-    @preLazy()
-    public async createEndUser(options: {
-        username: string
-        password: string
-    }) {
-        const { username, password } = options
-        const { EnvId } = this.environment.lazyEnvironmentConfig
-
-        return this.tcbService.request<{
-            RequestId: string,
-            User: EndUserInfo
-        }>('CreateEndUserAccount', {
-            EnvId,
-            Username: username,
-            Password: password,
-        })
-    }
-
-    // 更改用户账户
-    @preLazy()
-    public async modifyEndUser(options: {
-        uuid: string,
-        password?: string,
-        username?: string
-    }) {
-        const { uuid, username, password } = options
-        const { EnvId } = this.environment.lazyEnvironmentConfig
-
-        const reqData: any = {
-            EnvId,
-            Uuid: uuid
-        }
-
-        if (this.isValidStr(username)) {
-            reqData.Username = username
-        }
-        if (this.isValidStr(password)) {
-            reqData.Password = password
-        }
-
-        return this.tcbService.request<{
-            RequestId: string
-        }>('ModifyEndUserAccount', reqData)
-    }
-
-    // 更改用户信息
-    @preLazy()
-    public async updateEndUser(options: {
-        uuid: string,
-        nickName: string,
-        gender: string,
-        avatarUrl: string,
-        country: string,
-        province: string,
-        city: string
-    }) {
-        const { uuid, nickName, gender, avatarUrl, country, province, city } = options
-        const { EnvId } = this.environment.lazyEnvironmentConfig
-
-        return this.tcbService.request<{
-            RequestId: string
-        }>('ModifyEndUserInfo', {
-            UUId: uuid,
-            EnvId,
-            Data: [{
-                Key: 'Name',
-                Value: nickName
-            },{
-                Key: 'Gender',
-                Value: gender
-            },{
-                Key: 'AvatarUrl',
-                Value: avatarUrl
-            },{
-                Key: 'Country',
-                Value: country
-            },{
-                Key: 'Province',
-                Value: province
-            },{
-                Key: 'City',
-                Value: city
-            }]})
-    }
-
-    private isValidStr(obj: any) {
-        return typeof obj === 'string' && obj.trim().length > 0
-    }
-}

package/src/user/types.ts

@@ -1,21 +0,0 @@
-export interface EndUserInfo {
-    UUId: string
-    WXOpenId: string
-    QQOpenId: string
-    Phone: string
-    Email: string
-    NickName: string
-    Gender: string
-    AvatarUrl: string
-    Country: string
-    Province: string
-    City: string
-    UpdateTime: string
-    CreateTime: string
-    IsAnonymous: boolean
-    IsDisabled: boolean
-    HasPassword: boolean
-    UserName: string
-}
-
-export type EndUserStatus = 'ENABLE' | 'DISABLE'

package/src/utils/auth.ts

@@ -1,112 +0,0 @@
-import crypto from 'crypto'
-
-function camSafeUrlEncode(str) {
-    return encodeURIComponent(str)
-        .replace(/!/g, '%21')
-        .replace(/'/g, '%27')
-        .replace(/\(/g, '%28')
-        .replace(/\)/g, '%29')
-        .replace(/\*/g, '%2A')
-}
-
-export function getAuth(options: {
-    secretId: string
-    secretKey: string
-    method: string
-    pathname?: string
-    params?: Record<string, any>
-    headers?: Record<string, any>
-}) {
-    const SecretId = options.secretId
-    const SecretKey = options.secretKey
-    const method = options.method.toLowerCase() || 'get'
-    const queryParams = options.params || {}
-    const headers = options.headers || {}
-    let pathname = options.pathname || '/'
-    pathname.indexOf('/') !== 0 && (pathname = '/' + pathname)
-
-    if (!SecretId) {
-        throw Error('missing param SecretId')
-    }
-
-    if (!SecretKey) {
-        throw Error('missing param SecretKey')
-    }
-
-    const getObjectKeys = function(obj) {
-        return Object.keys(obj)
-            .filter(key => typeof obj[key] !== 'undefined')
-            .sort()
-    }
-
-    const objectToString = function(obj) {
-        const list = []
-        const keyList = getObjectKeys(obj)
-        keyList.forEach(key => {
-            let value = obj[key] === null || typeof obj[key] === 'undefined' ? '' : obj[key]
-            if (typeof value !== 'string') {
-                value = JSON.stringify(value)
-            }
-            list.push(`${camSafeUrlEncode(key.toLowerCase())}=${camSafeUrlEncode(value)}`)
-        })
-        return list.join('&')
-    }
-
-    // 签名有效起止时间
-    const now = Math.floor(Date.now() / 1000) - 1
-    // 签名过期时间为当前 + 900s
-    const exp = now + 900
-
-    // 要用到的 Authorization 参数列表
-    const qSignAlgorithm = 'sha1'
-    const qAk = SecretId
-    const qKeyTime = now + ';' + exp
-    const qHeaderList = getObjectKeys(headers)
-        .join(';')
-        .toLowerCase()
-
-    const qUrlParamList = getObjectKeys(queryParams)
-        .join(';')
-        .toLowerCase()
-
-    // 签名算法说明文档：https://www.qcloud.com/document/product/436/7778
-    // 步骤一：计算 SignKey
-    const signKey = crypto
-        .createHmac('sha1', SecretKey)
-        .update(qKeyTime)
-        .digest('hex')
-
-    // 步骤二：构成 FormatString
-    const formatString = [
-        method,
-        pathname,
-        objectToString(queryParams),
-        objectToString(headers),
-        ''
-    ].join('\n')
-
-    // 步骤三：计算 StringToSign
-    const sha1Algo = crypto.createHash('sha1')
-    sha1Algo.update(Buffer.from(formatString))
-    const res = sha1Algo.digest('hex')
-    const stringToSign = ['sha1', qKeyTime, res, ''].join('\n')
-
-    // 步骤四：计算 Signature
-    const qSignature = crypto
-        .createHmac('sha1', signKey)
-        .update(stringToSign)
-        .digest('hex')
-
-    // 步骤五：构造 Authorization
-    const authorization = [
-        'q-sign-algorithm=' + qSignAlgorithm,
-        'q-ak=' + qAk,
-        'q-sign-time=' + qKeyTime,
-        'q-key-time=' + qKeyTime,
-        'q-header-list=' + qHeaderList,
-        'q-url-param-list=' + qUrlParamList,
-        'q-signature=' + qSignature
-    ].join('&')
-
-    return authorization
-}

package/src/utils/cloud-api-request.ts

@@ -1,252 +0,0 @@
-import crypto from 'crypto'
-import { URL } from 'url'
-import QueryString from 'query-string'
-import { CloudBaseError } from '../error'
-import { CloudBaseContext } from '../context'
-import { fetch } from './http-request'
-import { RUN_ENV, ENV_NAME, ERROR } from '../constant'
-import { getRuntime, getEnvVar } from '../utils'
-
-function isObject(x) {
-    return typeof x === 'object' && !Array.isArray(x) && x !== null
-}
-
-// 移除对象中的空值
-function deepRemoveVoid(obj) {
-    if (Array.isArray(obj)) {
-        return obj.map(deepRemoveVoid)
-    } else if (isObject(obj)) {
-        let result = {}
-        for (let key in obj) {
-            if (Object.prototype.hasOwnProperty.call(obj, key)) {
-                const value = obj[key]
-                if (typeof value !== 'undefined' && value !== null) {
-                    result[key] = deepRemoveVoid(value)
-                }
-            }
-        }
-        return result
-    } else {
-        return obj
-    }
-}
-
-type HexBase64Latin1Encoding = 'latin1' | 'hex' | 'base64'
-
-function sha256(message: string, secret: string, encoding?: HexBase64Latin1Encoding) {
-    const hmac = crypto.createHmac('sha256', secret)
-    return hmac.update(message).digest(encoding)
-}
-
-function getHash(message: string): string {
-    const hash = crypto.createHash('sha256')
-    return hash.update(message).digest('hex')
-}
-
-function getDate(timestamp: number): string {
-    const date = new Date(timestamp * 1000)
-    const year = date.getUTCFullYear()
-    const month = ('0' + (date.getUTCMonth() + 1)).slice(-2)
-    // UTC 日期，非本地时间
-    const day = ('0' + date.getUTCDate()).slice(-2)
-    return `${year}-${month}-${day}`
-}
-
-export class CloudService {
-    service: string
-    version: string
-    url: string
-    action: string
-    method: 'POST' | 'GET'
-    secretId: string //
-    secretKey: string //
-    token: string //
-    timeout: number
-    data: Record<string, any>
-    payload: Record<string, any>
-    baseParams: Record<string, any>
-    cloudBaseContext: CloudBaseContext
-
-    /* eslint-disable-next-line */
-    constructor(
-        context: CloudBaseContext,
-        service: string,
-        version: string,
-        baseParams?: Record<string, any>
-    ) {
-        this.service = service
-        this.version = version
-        this.timeout = 60000
-        this.baseParams = baseParams || {}
-        this.cloudBaseContext = context
-    }
-
-    get baseUrl() {
-        const tcb = process.env.TCB_BASE_URL || 'https://tcb.tencentcloudapi.com'
-        const urlMap = {
-            tcb,
-            scf: 'https://scf.tencentcloudapi.com',
-            vpc: 'https://vpc.tencentcloudapi.com',
-            flexdb: 'https://flexdb.tencentcloudapi.com',
-            cam: 'https://cam.tencentcloudapi.com',
-            cdn: 'https://cdn.tencentcloudapi.com'
-        }
-        if (urlMap[this.service]) {
-            return urlMap[this.service]
-        } else {
-            return `https://${this.service}.tencentcloudapi.com`
-        }
-    }
-
-    async request<T extends {}>(
-        action: string,
-        data: Record<string, any> = {},
-        method: 'POST' | 'GET' = 'POST'
-    ): Promise<T> {
-        this.action = action
-        this.data = deepRemoveVoid({ ...data, ...this.baseParams })
-        this.method = method
-
-        this.url = this.baseUrl
-
-        let { secretId, secretKey, token } = this.cloudBaseContext
-
-        // 当在云函数环境下执行时，可init时不传入密钥，取环境变量中密钥使用
-        // request执行时一般处于main函数内部，取环境变量逻辑写这里更可靠
-        if (!secretId || !secretKey) {
-            // 未主动传入密钥，从环境变量中读取
-            const envSecretId = getEnvVar(ENV_NAME.ENV_SECRETID)
-            const envSecretKey = getEnvVar(ENV_NAME.ENV_SECRETKEY)
-            const envToken = getEnvVar(ENV_NAME.ENV_SESSIONTOKEN)
-            if (!envSecretId || !envSecretKey) {
-                if (getRuntime() === RUN_ENV.SCF) {
-                    throw new Error('missing authoration key, redeploy the function')
-                } else {
-                    throw new Error('missing secretId or secretKey of tencent cloud')
-                }
-            } else {
-                secretId = envSecretId
-                secretKey = envSecretKey
-                token = envToken
-            }
-        }
-
-        this.secretId = secretId
-        this.secretKey = secretKey
-        this.token = token
-
-        try {
-            const data: Record<string, any> = await this.requestWithSign()
-
-            if (data.Response.Error) {
-                const tcError = new CloudBaseError(data.Response.Error.Message, {
-                    action,
-                    requestId: data.Response.RequestId,
-                    code: data.Response.Error.Code,
-                    original: data.Response.Error
-                })
-                throw tcError
-            } else {
-                return data.Response
-            }
-        } catch (e) {
-            if (e.name === 'CloudBaseError') {
-                throw e
-            } else {
-                throw new CloudBaseError(e.message, {
-                    action,
-                    code: e.code
-                })
-            }
-        }
-    }
-
-    async requestWithSign() {
-        // data 中可能带有 readStream，由于需要计算整个 body 的 hash，
-        // 所以这里把 readStream 转为 Buffer
-        // await convertReadStreamToBuffer(data)
-        const timestamp = Math.floor(new Date().getTime() / 1000)
-        const { proxy } = this.cloudBaseContext
-
-        const { method, timeout, data = {} } = this
-
-        if (method === 'GET') {
-            this.url += '?' + QueryString.stringify(data)
-        }
-
-        if (method === 'POST') {
-            this.payload = data
-        }
-
-        const config: any = {
-            method,
-            timeout,
-            headers: {
-                Host: new URL(this.url).host,
-                'X-TC-Action': this.action,
-                // region 优先级 mock本地注入 > init 指定 > 云函数环境变量
-                'X-TC-Region':
-                    process.env.TCB_REGION ||
-                    this.cloudBaseContext.region ||
-                    process.env.TENCENTCLOUD_REGION ||
-                    'ap-shanghai',
-                'X-TC-Timestamp': timestamp,
-                'X-TC-Version': this.version
-            }
-        }
-
-        if (this.token) {
-            config.headers['X-TC-Token'] = this.token
-        }
-
-        if (method === 'GET') {
-            config.headers['Content-Type'] = 'application/x-www-form-urlencoded'
-        }
-        if (method === 'POST') {
-            config.body = JSON.stringify(data)
-            config.headers['Content-Type'] = 'application/json'
-        }
-
-        const sign = this.getRequestSign(timestamp)
-
-        config.headers['Authorization'] = sign
-
-        return fetch(this.url, config, proxy)
-    }
-
-    getRequestSign(timestamp: number) {
-        const { method = 'POST', url, service, secretId, secretKey } = this
-        const urlObj = new URL(url)
-
-        // 通用头部
-        let headers = ''
-        const signedHeaders = 'content-type;host'
-        if (method === 'GET') {
-            headers = 'content-type:application/x-www-form-urlencoded\n'
-        } else if (method === 'POST') {
-            headers = 'content-type:application/json\n'
-        }
-
-        headers += `host:${urlObj.hostname}\n`
-
-        const path = urlObj.pathname
-        const querystring = urlObj.search.slice(1)
-
-        const payloadHash = this.payload ? getHash(JSON.stringify(this.payload)) : getHash('')
-
-        const canonicalRequest = `${method}\n${path}\n${querystring}\n${headers}\n${signedHeaders}\n${payloadHash}`
-
-        const date = getDate(timestamp)
-
-        const StringToSign = `TC3-HMAC-SHA256\n${timestamp}\n${date}/${service}/tc3_request\n${getHash(
-            canonicalRequest
-        )}`
-
-        const kDate = sha256(date, `TC3${secretKey}`)
-        const kService = sha256(service, kDate)
-        const kSigning = sha256('tc3_request', kService)
-        const signature = sha256(StringToSign, kSigning, 'hex')
-
-        return `TC3-HMAC-SHA256 Credential=${secretId}/${date}/${service}/tc3_request, SignedHeaders=${signedHeaders}, Signature=${signature}`
-    }
-}

package/src/utils/cloudbase-request.ts

@@ -1,109 +0,0 @@
-import { getAuth } from './auth'
-import { fetch } from './http-request'
-
-const SUPPORT_REGIONS = ['ap-shanghai', 'ap-guangzhou']
-
-export async function cloudBaseRequest(options: {
-    config: {
-        envId: string
-        secretId: string
-        secretKey: string
-        token?: string
-        timeout?: number
-        proxy: string
-        region: string
-    }
-    params: Record<string, any>
-    method?: string
-    headers?: Record<string, any>
-}) {
-    // const url = 'https://tcb-admin.tencentcloudapi.com/admin'
-    const { config, params = {}, method = 'POST', headers = {} } = options
-    const { region, envId } = config
-    const isInScf = process.env.TENCENTCLOUD_RUNENV === 'SCF' // 是否scf环境内
-    const protocol = isInScf ? 'http' : 'https'
-    const isInContainer = !!process.env.KUBERNETES_SERVICE_HOST // 是否容器环境
-    // region 优先级 本地mock 注入 > init region > 云函数环境变量region
-    const finalRegion = process.env.TCB_REGION || region || process.env.TENCENTCLOUD_REGION || ''
-    let internetRegionEndpoint = ''
-    let internalRegionEndpoint = ''
-    if (finalRegion) {
-        if (SUPPORT_REGIONS.includes(finalRegion)) {
-            internetRegionEndpoint = `${finalRegion}.tcb-api.tencentcloudapi.com`
-            internalRegionEndpoint = `internal.${finalRegion}.tcb-api.tencentcloudapi.com`
-        } else {
-            console.warn('当前仅支持上海，广州地域，其他地域默认解析到固定域名(上海地域)')
-            internetRegionEndpoint = `tcb-api.tencentcloudapi.com`
-            internalRegionEndpoint = `internal.tcb-api.tencentcloudapi.com`
-        }
-    } else {
-        internetRegionEndpoint = `tcb-api.tencentcloudapi.com`
-        internalRegionEndpoint = `internal.tcb-api.tencentcloudapi.com`
-    }
-
-    // 有地域信息则访问地域级别域名，无地域信息则访问默认域名，默认域名固定解析到上海地域保持兼容
-    // const internetRegionEndpoint = finalRegion
-    //     ? `${finalRegion}.tcb-api.tencentcloudapi.com`
-    //     : `tcb-api.tencentcloudapi.com`
-
-    // const internalRegionEndpoint = finalRegion
-    //     ? `internal.${finalRegion}.tcb-api.tencentcloudapi.com`
-    //     : `internal.tcb-api.tencentcloudapi.com`
-
-    // 同地域走内网，跨地域走公网
-    const isSameRegionVisit = region ? region === process.env.TENCENTCLOUD_REGION : true
-
-    // const endpoint = isInScf || isInContainer ? internalRegionEndpoint : internetRegionEndpoint
-    const endpoint =
-        isSameRegionVisit && (isInScf || isInContainer)
-            ? internalRegionEndpoint
-            : internetRegionEndpoint
-    // const envpoint = envId ? `${envId}.${endpoint}` : endpoint
-    const envpoint = endpoint
-
-    const url = `${protocol}://${envpoint}/admin`
-
-    const requestData: any = {
-        ...params,
-        envName: config.envId,
-        timestamp: Date.now()
-    }
-
-    const requestHeaders = {
-        ...headers,
-        'content-type': 'application/json',
-        'user-agent': `cloudbase-manager-node/0.1.0`,
-        'x-tcb-source': 'cloudbase-manager-node, not-scf'
-    }
-
-    const { secretId, secretKey, token, proxy } = config
-
-    const authData = {
-        secretId,
-        secretKey,
-        method: method,
-        pathname: '/admin',
-        params: requestData,
-        headers: requestHeaders
-    }
-
-    const authorization = getAuth(authData)
-
-    const requestBody = {
-        ...requestData,
-        sessionToken: token,
-        authorization
-    }
-
-    const res = await fetch(
-        url,
-        {
-            method,
-            body: JSON.stringify(requestBody),
-            headers: requestHeaders
-        },
-        process.env.TCB_ADMIN_PROXY || proxy
-    )
-
-    return res
-}