feat: add asw and account module

Author: yugasun

__tests__/account.test.ts

@@ -0,0 +1,23 @@
+import { Account } from '../src';
+
+describe('Account', () => {
+  const credentials = {
+    SecretId: process.env.TENCENT_SECRET_ID,
+    SecretKey: process.env.TENCENT_SECRET_KEY,
+  };
+  const account = new Account(credentials);
+
+  test('get', async () => {
+    const res = await account.get();
+    expect(res).toEqual({
+      ownerUin: +process.env.TENCENT_UIN,
+      uin: +process.env.TENCENT_UIN,
+      appId: +process.env.TENCENT_APP_ID,
+      account: expect.any(String),
+      userType: expect.any(String),
+      type: expect.any(String),
+      area: expect.any(String),
+      tel: expect.any(String),
+    });
+  });
+});

__tests__/asw.test.ts

@@ -0,0 +1,98 @@
+import { sleep } from '@ygkit/request';
+import Asw from '../src/modules/asw';
+import { UpdateOptions, CreateResult } from './../src/modules/asw/interface';
+
+describe('Account', () => {
+  const credentials = {
+    SecretId: process.env.TENCENT_SECRET_ID,
+    SecretKey: process.env.TENCENT_SECRET_KEY,
+  };
+  const client = new Asw(credentials);
+
+  const options: {
+    definition: string;
+    name: string;
+    resourceId?: string;
+    role?: string;
+  } = {
+    definition: JSON.stringify({
+      Comment: 'Serverless Test',
+      StartAt: 'Hello',
+      States: {
+        Hello: { Type: 'Pass', Comment: '传递', Next: 'World' },
+        World: { Type: 'Pass', Comment: '传递', End: true },
+      },
+    }),
+    name: 'serverless-test',
+  };
+
+  const input = JSON.stringify({
+    key1: 'test value 1',
+    key2: 'test value 2',
+  });
+
+  let executeName: string;
+  let createResult: CreateResult;
+
+  test('create', async () => {
+    const res = await client.create(options);
+    expect(res).toEqual({
+      requestId: expect.any(String),
+      resourceId: expect.any(String),
+      isNewRole: expect.any(Boolean),
+      roleName: expect.stringContaining('serverless-test_'),
+    });
+    createResult = res;
+  });
+
+  test('update', async () => {
+    options.resourceId = createResult.resourceId;
+    options.role = createResult.roleName;
+    const res = await client.update(options as UpdateOptions);
+    expect(res).toEqual({
+      requestId: expect.any(String),
+      resourceId: createResult.resourceId,
+      isNewRole: expect.any(Boolean),
+      roleName: expect.stringContaining('serverless-test_'),
+    });
+  });
+
+  test('execute', async () => {
+    const res = await client.execute({
+      resourceId: createResult.resourceId,
+      name: 'serverless',
+      input,
+    });
+
+    expect(res).toEqual({
+      requestId: expect.any(String),
+      resourceId: createResult.resourceId,
+      executeName: expect.stringContaining('qrn:qcs:asw:'),
+    });
+
+    ({ executeName } = res);
+  });
+
+  test('getExecuteState', async () => {
+    // 等待执行完成
+    await sleep(5000);
+    const res = await client.getExecuteState(executeName);
+
+    expect(res.ExecutionResourceName).toBe(executeName);
+    expect(res.Name).toBe('serverless');
+    expect(res.Input).toBe(input);
+  });
+
+  test('delete', async () => {
+    const res = await client.delete(createResult.resourceId);
+    expect(res).toEqual({
+      requestId: expect.any(String),
+      resourceId: createResult.resourceId,
+    });
+
+    // 删除测试创建的角色
+    if (createResult.isNewRole) {
+      await client.cam.DeleteRole(createResult.roleName);
+    }
+  });
+});

src/index.ts

@@ -15,3 +15,5 @@ export { default as Cynosdb } from './modules/cynosdb';
 export { default as Cls } from './modules/cls';
 export { default as Clb } from './modules/clb';
 export { default as Monitor } from './modules/monitor';
+export { default as Account } from './modules/account';
+export { default as Asw } from './modules/asw';

src/modules/account/apis.ts

@@ -0,0 +1,15 @@
+import { ApiFactory } from '../../utils/api';
+import { ApiServiceType } from '../interface';
+
+const ACTIONS = ['DescribeCurrentUserDetails'] as const;
+
+export type ActionType = typeof ACTIONS[number];
+
+const APIS = ApiFactory({
+  // debug: true,
+  serviceType: ApiServiceType.account,
+  version: '2018-12-25',
+  actions: ACTIONS,
+});
+
+export default APIS;

src/modules/account/index.ts

@@ -0,0 +1,51 @@
+import { ActionType } from './apis';
+import { CapiCredentials, RegionType, ApiServiceType } from '../interface';
+import { Capi } from '@tencent-sdk/capi';
+import APIS from './apis';
+import { AccountDetail } from './interface';
+
+/** CAM （访问管理）for serverless */
+export default class Cam {
+  region: RegionType;
+  credentials: CapiCredentials;
+  capi: Capi;
+
+  constructor(credentials: CapiCredentials, region: RegionType = 'ap-guangzhou') {
+    this.region = region;
+    this.credentials = credentials;
+
+    this.capi = new Capi({
+      Region: this.region,
+      ServiceType: ApiServiceType.cam,
+      SecretId: this.credentials.SecretId!,
+      SecretKey: this.credentials.SecretKey!,
+      Token: this.credentials.Token,
+    });
+  }
+
+  async request({ Action, ...data }: { Action: ActionType; [key: string]: any }) {
+    const result = await APIS[Action](this.capi, data);
+    return result;
+  }
+
+  /**
+   * 获取账号详情
+   * @returns 账号详情
+   */
+  async get(): Promise<AccountDetail> {
+    const res = await this.request({
+      Action: 'DescribeCurrentUserDetails',
+    });
+
+    return {
+      ownerUin: res.OwnerUin,
+      uin: res.Uin,
+      appId: res.AppId![0] || '',
+      account: res.Account,
+      userType: res.UserType,
+      type: res.Type,
+      area: res.Area,
+      tel: res.Tel,
+    };
+  }
+}

src/modules/account/interface.ts

@@ -0,0 +1,10 @@
+export interface AccountDetail {
+  ownerUin: string;
+  uin: string;
+  appId: string;
+  account: string;
+  userType: string;
+  type: string;
+  area: string;
+  tel: string;
+}

src/modules/asw/apis.ts

@@ -0,0 +1,25 @@
+import { ApiFactory } from '../../utils/api';
+import { ApiServiceType } from '../interface';
+
+const ACTIONS = [
+  'DescribeFlowServices',
+  'DescribeFlowServiceDetail',
+  'CreateFlowService',
+  'ModifyFlowService',
+  'DeleteFlowService',
+  'StartExecution',
+  'DescribeExecution',
+  'StopExecution',
+] as const;
+
+export type ActionType = typeof ACTIONS[number];
+
+const APIS = ApiFactory({
+  debug: false,
+  isV3: true,
+  serviceType: ApiServiceType.asw,
+  version: '2020-07-22',
+  actions: ACTIONS,
+});
+
+export default APIS;