Merge pull request #1 from serverless-tencent/sls-sdk

Sls sdk

Author: anycodes

README.md

@@ -10,6 +10,7 @@
 - [一键登录功能](#一键登录功能)
 - [检测用户实名](#检测用户实名)
 - [判断中国用户](#判断中国用户)
+- [ServerlessApi](#ServerlessApi)
 
 
 ## 基本功能
@@ -373,4 +374,24 @@ new OthersAction().getIsInChina()
 | IsInChina | 输出参数true或false，如果是true，表示是中国用户，否则表示非中国用户 |
 
 
+### ServerlessApi
+
+serverless api
+
+```javascript
+const {Serverless} = require('serverless-tencent-tools');
+
+const sls = new Serverless({
+ appid: app_id,
+ secret_id: secret_id,
+ secret_key: secret_key,
+ options: {
+ region: 'ap-guangzhou'
+ }
+});
+
+const ret = await sls.getComponentAndVersions('Component name');
+console.log(ret)
+```
+
 （* 该接口目前为1.0版本，后期会增加其复杂度，但是接口规范不会变。）

sdk/index.js

@@ -3,5 +3,6 @@ module.exports = {
  Login: require('./login/index'),
  Logs: require('./logs/index'),
  Account: require('./account/index'),
- Others: require('./others/index')
+ Others: require('./others/index'),
+ Serverless: require('./serverless')
 }

sdk/serverless/index.js

@@ -0,0 +1,202 @@
+'use strict';
+const util = require('util');
+const assert = require('assert');
+const Tencentcloud = require('tencentcloud-sdk-nodejs');
+const ClientProfile = require('tencentcloud-sdk-nodejs/tencentcloud/common/profile/client_profile.js');
+const HttpProfile = require('tencentcloud-sdk-nodejs/tencentcloud/common/profile/http_profile.js');
+const SlsClient = Tencentcloud.sls.v20200205.Client;
+const SlsModels = Tencentcloud.sls.v20200205.Models;
+const { Credential } = Tencentcloud.common;
+const { BindRole } = require('../cam');
+
+class Serverless {
+ constructor ({appid, secret_id, secret_key, options}) {
+ this.appid = appid;
+ this.secretKey = secret_key;
+ this.secretId = secret_id;
+ this.options = options;
+ assert(options, 'Options should not is empty');
+ this._slsClient = Serverless.createClient(secret_id, secret_key, options);
+ }
+
+
+ static getCredential(secret_id, secret_key, options) {
+ const cred = options.token
+ ? new Credential(secret_id, secret_key, options.token)
+ : new Credential(secret_id, secret_key)
+ const httpProfile = new HttpProfile();
+ httpProfile.reqTimeout = 30;
+ const clientProfile = new ClientProfile('HmacSHA256', httpProfile);
+ assert(options.region, 'Region should not is empty');
+ return {
+ cred: cred,
+ region: options.region,
+ clientProfile: clientProfile
+ }
+ }
+
+
+ static createClient(secret_id, secret_key, options) {
+ const info = Serverless.getCredential(secret_id, secret_key, options);
+ const scfCli = new SlsClient(info.cred, info.region, info.clientProfile);
+ scfCli.sdkVersion = 'ServerlessFramework';
+ return scfCli;
+ }
+
+
+ async getComponentAndVersions(name) {
+ const compVersion = {
+ ComponentName: name
+ }
+ const req = new SlsModels.GetComponentAndVersionsRequest();
+ req.from_json_string(JSON.stringify(compVersion));
+ return await this._call('GetComponentAndVersions', req);
+ }
+
+ async _call(api, params) {
+ const handler = util.promisify(this._slsClient[api].bind(this._slsClient));
+ return await handler(params);
+ }
+
+
+ async getComponentVersion(name, version) {
+ const componentVersion = {
+ ComponentName: name, 
+ ComponentVersion: version
+ }
+ const req = new SlsModels.GetComponentVersionRequest();
+ req.from_json_string(JSON.stringify(componentVersion));
+ return await this._call('GetComponentVersion', req);
+ }
+
+
+ async prePublishComponent(body) {
+ const pubComponent = {
+ Body: body
+ }
+
+ const req = new SlsModels.PrePublishComponentRequest();
+ req.from_json_string(JSON.stringify(pubComponent));
+ return await this._call('PrePublishComponent', req);
+ }
+
+
+ async postPublishComponent(body) {
+ const pubComponent = {
+ Body: body
+ }
+ const req = new SlsModels.PostPublishComponentRequest();
+ req.from_json_string(JSON.stringify(pubComponent));
+ return await this._call('PostPublishComponent', req);
+ }
+
+
+ async getInstance(body) {
+ const ins = {
+ Body: body
+ }
+ const req = new SlsModels.GetInstanceRequest();
+ req.from_json_string(JSON.stringify(ins));
+ return await this._call('GetInstance', req);
+ }
+
+
+ async saveInstance(body) {
+ const ins = {
+ Body: body
+ }
+ const req = new SlsModels.SaveInstanceRequest();
+ req.from_json_string(JSON.stringify(ins));
+ return await this._call('SaveInstance', req);
+ }
+
+
+ async listInstances(body) {
+ const ins = {
+ Body: body
+ }
+ const req = new SlsModels.ListInstancesRequest();
+ req.from_json_string(JSON.stringify(ins));
+ return await this._call('ListInstances', req);
+ }
+
+
+ async getUploadUrls(body) {
+ const uploadUrl = {
+ Body: body
+ }
+ const req = new SlsModels.GetUploadUrlsRequest();
+ req.from_json_string(JSON.stringify(uploadUrl));
+ return await this._call('GetUploadUrls', req);
+ }
+
+
+ async runComponent(body) {
+ const comp = {
+ Body: body
+ }
+ const req = new SlsModels.RunComponentRequest();
+ req.from_json_string(JSON.stringify(comp));
+ return await this._call('RunComponent', req);
+ }
+
+
+ async runFinishComponent(body) {
+ const comp = {
+ Body: body
+ }
+ const req = new SlsModels.RunFinishComponentRequest();
+ req.from_json_string(JSON.stringify(comp));
+ return await this._call('RunFinishComponent', req);
+ }
+
+
+ async unpublishComponentVersion(name, version) {
+ const componentVersion = {
+ Name: name, 
+ ComponentVersion: version
+ }
+ const req = new SlsModels.UnpublishComponentVersionRequest();
+ req.from_json_string(JSON.stringify(componentVersion));
+ return await this._call('UnpublishComponentVersion', req);
+ }
+ 
+
+ async publishComponentVersion({name, componentVersion, org, author, description, keywords, license}) {
+ 
+ const camRole = new BindRole.BindRole({
+ SecretId: this.secret_id, 
+ SecretKey: this.secret_key,
+ token: this.options.token
+ });
+
+ camRole.bindSLSQcsRole();
+
+ const pubComVersionRequest = {
+ Name: name,
+ ComponentVersion: componentVersion,
+ Org: org,
+ Author: author,
+ Description: description,
+ Keywords: keywords,
+ License: license
+ }
+
+ const req = new SlsModels.PublishComponentVersionRequest()
+ req.from_json_string(JSON.stringify(pubComVersionRequest));
+ return await this._call('PublishComponentVersion', req);
+ }
+
+
+ async fetchComponentMetadata(name, version) {
+ const componentVersion = {
+ Name: name, 
+ ComponentVersion: version
+ }
+ const req = new SlsModels.FetchComponentMetadataRequest();
+ req.from_json_string(JSON.stringify(componentVersion));
+ return await this._call('FetchComponentMetadata', req);
+ }
+}
+
+module.exports = Serverless;