feat(auth): support auth plugin

packages/framework-core/src/sam/index.ts

@@ -63,7 +63,7 @@ export class SamManager {
     let extensionId: string;
 
     // 没有资源需要部署的情况不走 SAM安装
-    if (!Object.keys(template.Resources).length) {
+    if (!Object.keys(template.Resources).length && !Object.keys(template.Config || {}).length) {
       return this.clear();
     }
 

packages/framework-core/src/sam/types.ts

@@ -29,6 +29,15 @@ export interface ISAM {
     Properties: any[];
     DependsOn: string[];
   }[];
+
+  Config: {
+    Login: {
+      Platform: string;
+      PlatformId?: string;
+      PlatformSecret?: string;
+      Status: string
+    }[];
+  };
 }
 
 export interface IExtensionFile {

packages/framework-plugin-auth/.gitignore

+lib

packages/framework-plugin-auth/LICENSE

+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Tencent. All rights reserved.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

packages/framework-plugin-auth/README.md

+<a href="https://github.com/TencentCloudBase/cloudbase-framework/tree/master/packages/framework-plugin-mp">![Tencent CloudBase Framework MP Plugin](https://main.qcloudimg.com/raw/3de9cef4b6ac7c72f9519f13d063fc13.jpg)</a>
+
+# Tencent CloudBase Framework MiniProgram Plugin
+
+[![Github License](https://img.shields.io/github/license/TencentCloudBase/cloudbase-framework)](LICENSE)
+[![Npm version](https://img.shields.io/npm/v/@cloudbase/framework-plugin-container)](https://www.npmjs.com/package/@cloudbase/framework-plugin-container)
+[![issue](https://img.shields.io/github/issues/TencentCloudBase/cloudbase-framework)](https://github.com/TencentCloudBase/cloudbase-framework/issues)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/TencentCloudBase/cloudbase-framework/pulls)
+[![star](https://img.shields.io/github/stars/TencentCloudBase/cloudbase-framework?style=social)](https://github.com/TencentCloudBase/cloudbase-framework)
+
+**云开发 CloudBase Framework 框架「小程序」插件**： 通过云开发 **[CloudBase Framework](https://github.com/TencentCloudBase/cloudbase-framework)** 框架一键部署微信小程序应用。
+
+## 功能特性
+
+## 使用方法
+
+### 步骤一. 准备工作
+
+具体步骤请参照 [准备云开发环境和 CloudBase CLI 命令工具](../../CLI_GUIDE.md)
+
+### 步骤二. 进入项目目录进行初始化
+
+如果是目前已有的小程序应用项目
+
+```bash
+cloudbase
+```
+
+### 步骤三. 一键部署
+
+```bash
+cloudbase framework:deploy
+```
+
+## 配置
+
+默认情况下仅需要配置 `appid`、`privateKeyPath` 即可使用，以下配置参数针对有特殊需求的场景
+
+### 配置示例
+
+`cloudbase init` 之后会创建云开发的配置文件 `cloudbaserc.json`，可在配置文件的 plugins 里修改和写入插件配置
+
+```json
+{
+  "envId": "{{envId}}",
+  "framework": {
+    "plugins": {
+      "client": {
+        "use": "@cloudbase/framework-plugin-mp",
+        "inputs": {
+          "appid": "",
+          "privateKeyPath": "",
+          "localPath": "./",
+          "ignores": ["node_modules/**/*"],
+          "deployMode": "preview",
+          "previewOptions": {
+            "desc": "CloudBase Framework 一键预览",
+            "setting": {
+              "es6": true
+            },
+            "qrcodeOutputPath": "./qrcode.jpg",
+            "pagePath": "pages/index/index"
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+> 默认模板的 `appid` 和 `privateKeyPath` 为空，需要开发者填入
+
+### 配置参数说明
+
+### `appid`
+
+必填，小程序应用的 appid
+
+### `privateKeyPath`
+
+必填，小程序应用的部署私钥的本地相对路径
+
+### `localPath`
+
+选填，小程序项目 `project.config.json` 所在的本地路径，默认值 `./`
+
+### `ignores`
+
+选填，小程序应用部署时忽略的文件路径，支持通配符，默认值`["node_modules/**/*"]`
+
+### `deployMode`
+
+选填，小程序应用的部署模式，支持 `preview|upload` 2 种部署模式
+
+### `previewOptions`
+
+`deployMode` 填写为 `preview` 时需要填写`previewOptions`，类型是对象格式
+
+| 属性名称         | 类型                          | 是否必填 | 描述                             |
+| ---------------- | ----------------------------- | -------- | -------------------------------- |
+| desc             | String                        | 否       | 小程序应用的版本描述             |
+| setting          | IMiniProgramBuildSetting 对象 | 否       | 小程序应用的编译设置             |
+| qrcodeOutputPath | String                        | 否       | 生成的预览二维码保存在本地的路径 |
+| pagePath         | String                        | 否       | 小程序应用的预览页面地址         |
+| searchQuery      | String                        | 否       | 小程序应用的预览页面参数         |
+| scene            | Number                        | 否       | 小程序应用的预览页面场景值       |
+
+例如
+
+```json
+{
+  "envId": "{{envId}}",
+  "framework": {
+    "plugins": {
+      "client": {
+        "use": "@cloudbase/framework-plugin-mp",
+        "inputs": {
+          "appid": "",
+          "privateKeyPath": "",
+          "localPath": "./",
+          "ignores": ["node_modules/**/*"],
+          "deployMode": "preview",
+          "previewOptions": {
+            "desc": "一键预览",
+            "setting": {
+              "es6": false
+            },
+            "qrcodeOutputPath": "./qrcode.jpg",
+            "pagePath": "pages/index/index",
+            "searchQuery": "",
+            "scene": 1011
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+### `uploadOptions`
+
+`deployMode` 填写为 `upload` 时需要填写`uploadOptions`，类型是对象格式
+
+| 属性名称 | 类型                          | 是否必填 | 描述                   |
+| -------- | ----------------------------- | -------- | ---------------------- |
+| version  | String 对象                   | 否       | 小程序应用上传的版本号 |
+| desc     | String 对象                   | 否       | 小程序应用的版本描述   |
+| setting  | IMiniProgramBuildSetting 对象 | 否       | 小程序应用的编译设置   |
+
+例如
+
+```json
+{
+  "envId": "{{envId}}",
+  "framework": {
+    "plugins": {
+      "client": {
+        "use": "@cloudbase/framework-plugin-mp",
+        "inputs": {
+          "appid": "",
+          "privateKeyPath": "",
+          "localPath": "./",
+          "ignores": ["node_modules/**/*"],
+          "deployMode": "upload",
+          "uploadOptions": {
+            "version": "1.0.0",
+            "desc": "CloudBase Framework 一键上传",
+            "setting": {
+              "es6": false
+            }
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+## 更多插件
+
+请访问 [CloudBase Framework 插件列表](https://github.com/TencentCloudBase/cloudbase-framework#%E7%9B%AE%E5%89%8D%E6%94%AF%E6%8C%81%E7%9A%84%E6%8F%92%E4%BB%B6%E5%88%97%E8%A1%A8) 搭配使用其他插件
+
+## 文档资料
+
+- 云开发官网地址： [https://cloudbase.net/](https://cloudbase.net/)
+- 云开发静态网站开通指南：[https://docs.cloudbase.net/hosting/](https://docs.cloudbase.net/hosting/)
+- 云开发控制台地址： [https://console.cloud.tencent.com/tcb](https://console.cloud.tencent.com/tcb)

packages/framework-plugin-auth/package.json

+{
+  "name": "@cloudbase/framework-plugin-auth",
+  "version": "1.2.10",
+  "description": "云开发 Tencent CloudBase Framework Auth Plugin 插件，可以一键设置项目下的登录配置。",
+  "author": "Tencent CloudBase Team",
+  "homepage": "https://github.com/TencentCloudBase/cloudbase-framework#readme",
+  "license": "Apache-2.0",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "directories": {
+    "lib": "lib",
+    "test": "__tests__"
+  },
+  "files": [
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TencentCloudBase/cloudbase-framework.git"
+  },
+  "scripts": {
+    "dev": "tsc -w",
+    "build": "tsc",
+    "test": "jest"
+  },
+  "bugs": {
+    "url": "https://github.com/TencentCloudBase/cloudbase-framework/issues"
+  },
+  "dependencies": {
+    "@cloudbase/framework-core": "^1.2.10"
+  },
+  "devDependencies": {
+    "jest": "^26.0.1",
+    "typescript": "^3.9.2"
+  },
+  "gitHead": "70c11d9fb556dd7f6b4b4c03eddf9cb558ccd958"
+}

packages/framework-plugin-auth/src/index.ts

+import { Plugin, PluginServiceApi } from "@cloudbase/framework-core";
+
+/**
+ * 导出接口用于生成 JSON Schema 来进行智能提示
+ */
+export interface IFrameworkPluginAuthInputs {
+  configs: IAuthConfig[]
+}
+
+export interface IAuthConfig {
+  /**
+   * 登录平台
+   */
+  platform: "NONLOGIN" | "ANONYMOUS"
+  /**
+   * 开通状态
+   */
+  status: "ENABLE" | "DISABLE"
+  /**
+   * 登录平台的 AppID，选填
+   */
+  platformId: string
+  /**
+   * 登录平台的 AppSecret，选填
+   */
+  platformSecret: string
+}
+
+class AuthPlugin extends Plugin {
+  protected resolvedInputs: IFrameworkPluginAuthInputs;
+  protected buildOutput: any;
+
+  constructor(
+    public name: string,
+    public api: PluginServiceApi,
+    public inputs: IFrameworkPluginAuthInputs
+  ) {
+    super(name, api, inputs);
+
+    const DEFAULT_INPUTS = {
+      
+    };
+    this.resolvedInputs = resolveInputs(this.inputs, DEFAULT_INPUTS);
+  }
+
+  /**
+   * 初始化
+   */
+  async init() {
+    this.api.logger.debug("AuthPlugin: init", this.resolvedInputs);
+  }
+
+  /**
+   * 执行本地命令
+   */
+  async run() {}
+
+  /**
+   * 删除资源
+   */
+  async remove() {}
+
+  /**
+   * 生成代码
+   */
+  async genCode() {}
+
+  /**
+   * 构建
+   */
+  async build() {}
+
+  /**
+   * 生成SAM文件
+   */
+  async compile() {
+    this.api.logger.debug("AuthPlugin: compile", this.resolvedInputs, this.buildOutput);
+
+    return {
+      Config: {
+        Login: this.resolvedInputs.configs.map((config: IAuthConfig) => {
+          const { platform, status, platformId, platformSecret } = config;
+          return {
+            Platform: platform,
+            PlatformId: platformId,
+            PlatformSecret: platformSecret,
+            Status: status
+          }
+        })
+      }
+    };
+  }
+
+  /**
+   * 部署
+   */
+  async deploy() {}
+}
+
+function resolveInputs(inputs: any, defaultInputs: any) {
+  return Object.assign({}, defaultInputs, inputs);
+}
+
+export const plugin = AuthPlugin;

packages/framework-plugin-auth/tsconfig.json

+{
+    "extends": "../../tsconfig.build.json",
+    "compilerOptions": {
+      "rootDir": "src",
+      "outDir": "lib"
+    },
+    "references": [{}]
+  }
+  
\ No newline at end of file