perf: spec-parser to separate package (#10842)

* perf: init spec-parser package * perf(spec-parser): remove unused package, use correct option (#10776) Co-authored-by: turenlong <rentu@microsoft.com> * perf: add test (#10789) * perf: add test files * perf: update test * test: add browser test (#10796) * test: add browser test * perf: remove useless code * test: fix coverage = 0 bug (#10802) * perf: not allow res/req body has type other than json (#10803) Co-authored-by: turenlong <rentu@microsoft.com> * ci: add ci for spec-parser (#10805) * ci: add ci for spec-parser * test: update test * test: update test * test: update dependency * ci: add cd for spec parser (#10816) * ci: add cd for spec parser * fix: fix pacakge * test: fix ut * ci: fix cd for spec parser (#10819) * ci: update node version to 18 (#10820) * perf(spec-parser): try to fix browser lib issue (#10821) * perf: try to fix browser lib issue * perf: add missing constant export --------- Co-authored-by: turenlong <rentu@microsoft.com> * ci: update version (#10822) * perf: add format for spec parser (#10827) * perf: add format for spec parser * fix: add eslint file * build: update lock file * perf: export utils in spec parser (#10829) * perf: add license and update package.json (#10837) * perf: add license and update package.json * ci: update version * perf(spec-parser): add README.md and update export (#10838) Co-authored-by: turenlong <rentu@microsoft.com> * ci: update version (#10839) * perf: init spec-parser package * perf(spec-parser): remove unused package, use correct option (#10776) Co-authored-by: turenlong <rentu@microsoft.com> * perf: add test (#10789) * perf: add test files * perf: update test * test: add browser test (#10796) * test: add browser test * perf: remove useless code * test: fix coverage = 0 bug (#10802) * perf: not allow res/req body has type other than json (#10803) Co-authored-by: turenlong <rentu@microsoft.com> * ci: add ci for spec-parser (#10805) * ci: add ci for spec-parser * test: update test * test: update test * test: update dependency * ci: add cd for spec parser (#10816) * ci: add cd for spec parser * fix: fix pacakge * test: fix ut * ci: fix cd for spec parser (#10819) * ci: update node version to 18 (#10820) * perf(spec-parser): try to fix browser lib issue (#10821) * perf: try to fix browser lib issue * perf: add missing constant export --------- Co-authored-by: turenlong <rentu@microsoft.com> * ci: update version (#10822) * perf: add format for spec parser (#10827) * perf: add format for spec parser * fix: add eslint file * build: update lock file * perf: export utils in spec parser (#10829) * perf: add license and update package.json (#10837) * perf: add license and update package.json * ci: update version * perf(spec-parser): add README.md and update export (#10838) Co-authored-by: turenlong <rentu@microsoft.com> * ci: update version (#10839) * perf: update * docs: update readme * perf: update package.json * test: fix test * perf: update pnpm-lock * test: fix ut * build: update config in webpack * fix: fix format --------- Co-authored-by: rentu <5545529+SLdragon@users.noreply.github.com> Co-authored-by: turenlong <rentu@microsoft.com> Co-authored-by: wenyutang-ms <wenyutang@microsoft.com>
OfficeDev · Feb 18, 2024 · e2f9e98 · e2f9e98
1 parent 670e706
commit e2f9e98
Show file tree

Hide file tree

Showing 40 changed files with 17,037 additions and 4 deletions.
diff --git a/.github/workflows/spec-parser-cd.yml b/.github/workflows/spec-parser-cd.yml
@@ -3,13 +3,64 @@ run-name: Spec-Parser-${{ github.run_id }}-${{ github.ref_name }}
 
 on:
   workflow_dispatch:
+    inputs:
+      preid:
+        description: "preid name(alpha, rc, stable)"
+        required: true
+        default: "alpha"
 
 jobs:
   cd:
     runs-on: ubuntu-latest
     steps:
-      - name: Output
-        if: ${{ github.event_name == 'workflow_dispatch' && github.ref != 'refs/heads/spec-parser' }}
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install
+        working-directory: packages/spec-parser/
+        run: |
+          npm install
+
+      - name: Build
+        working-directory: packages/spec-parser/
+        run: |
+          npm run build
+
+      - name: Setup npm registry
+        run: |
+          echo "${{ secrets.NPMRC }}" > ~/.npmrc
+
+      - name: Version alpha
+        if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.preid == 'alpha' }}
+        working-directory: packages/spec-parser/
+        run: |
+          npm version prerelease --preid=alpha
+
+      - name: Version rc
+        if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.preid == 'rc' }}
+        working-directory: packages/spec-parser/
+        run: |
+          npm version prerelease --preid=rc
+
+      - name: publish alpha release to npm org
+        if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.preid == 'alpha' }}
+        working-directory: packages/spec-parser/
+        run: |
+          npm publish --tag alpha
+
+      - name: publish rc release to npm org
+        if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.preid == 'rc' }}
+        working-directory: packages/spec-parser/
+        run: |
+          npm publish --tag rc
+
+      - name: publish stable release to npm org
+        if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.preid == 'stable' }}
+        working-directory: packages/spec-parser/
         run: |
-          echo It's not allowed to run CD on other branch except spec-parser.
-          exit 1
+          npm publish
diff --git a/.github/workflows/spec-parser-ci.yml b/.github/workflows/spec-parser-ci.yml
@@ -0,0 +1,35 @@
+name: Spec-Parser CI
+
+on:
+  push:
+    paths:
+      - "packages/spec-parser/**"
+    branches: ["main", "dev", "prerelease", "spec-parser"]
+  pull_request:
+    paths:
+      - "packages/spec-parser/**"
+    branches: ["main", "dev", "prerelease", "spec-parser"]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.version }}
+
+      - name: Install
+        working-directory: packages/spec-parser/
+        run: |
+          npm install
+
+      - name: Test
+        working-directory: packages/spec-parser/
+        run: |
+          npm run test:unit
diff --git a/README.md b/README.md
@@ -56,6 +56,7 @@ This repository contains the following packages:
 | **API** [packages/api](https://github.com/OfficeDev/TeamsFx/tree/main/packages/api) | The API package is a collection of contracts supported by the IDE Extensions and CLI. It enables developers to write plugins to extend TeamsFx with new capabilities. |
 | **Core** [packages/fx-core](https://github.com/OfficeDev/TeamsFx/tree/main/packages/fx-core) | The Core package centralizes implementation of capabilities shared by the IDE Extensions and the CLI. |
 | **Azure Functions Support** [packages/function-extension](https://github.com/OfficeDev/TeamsFx/tree/main/packages/function-extension) | Teams Toolkit helps developers include server-side code in their Teams application backed by [Azure Functions](https://docs.microsoft.com/azure/azure-functions/). This plugin adds support to simplify the integration of an authentication-aware Azure Function into your Teams app. |
+| **Spec Parser** [packages/spec-parser](https://github.com/OfficeDev/TeamsFx/tree/main/packages/spec-parser) | Teams Toolkit automates the process of generating [API-based message extensions](https://learn.microsoft.com/en-us/microsoftteams/platform/messaging-extensions/api-based-overview) and Adaptive Cards by parsing the OpenAPI description document. |
 
 ## Contributions
 

diff --git a/packages/spec-parser/.eslintignore b/packages/spec-parser/.eslintignore
@@ -0,0 +1 @@
+dist*/*
diff --git a/packages/spec-parser/.eslintrc.js b/packages/spec-parser/.eslintrc.js
@@ -0,0 +1,17 @@
+module.exports = {
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+  },
+  extends: ["../eslint-plugin-teamsfx/config/shared.js"],
+  overrides: [
+    {
+      files: ["src/*.ts"],
+      extends: [
+        "../eslint-plugin-teamsfx/config/header.js",
+        "../eslint-plugin-teamsfx/config/promise.js",
+        "../eslint-plugin-teamsfx/config/type.js",
+      ],
+    },
+  ],
+};
diff --git a/packages/spec-parser/.gitignore b/packages/spec-parser/.gitignore
@@ -0,0 +1,7 @@
+# Build results
+dist/
+types/
+coverage-browser/
+test-results*.xml
+node_modules/
+*.tgz
diff --git a/packages/spec-parser/.nycrc b/packages/spec-parser/.nycrc
@@ -0,0 +1,19 @@
+{
+  "extends": "@istanbuljs/nyc-config-typescript",
+  "all": true,
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "src/**/*.browser.ts"
+  ],
+  "reporter": [
+    "text",
+    "html",
+    "json-summary",
+    "cobertura",
+    "lcov"
+  ],
+  "check-coverage": true,
+  "lines": 0
+}
diff --git a/packages/spec-parser/.prettierignore b/packages/spec-parser/.prettierignore
@@ -0,0 +1,6 @@
+**/src/generated/
+**/*.d.ts
+
+coverage/
+.nyc_output/
+.prettierignore
diff --git a/packages/spec-parser/.prettierrc.js b/packages/spec-parser/.prettierrc.js
@@ -0,0 +1,3 @@
+module.exports = {
+  ...require("../prettier-config"),
+};
diff --git a/packages/spec-parser/LICENSE.txt b/packages/spec-parser/LICENSE.txt
@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/packages/spec-parser/README.md b/packages/spec-parser/README.md
@@ -0,0 +1,125 @@
+# M365 Spec Parser
+
+The M365 Spec Parser package is designed to parse OpenAPI specification files to generate resources for M365 applications.
+
+## Sample Usage
+
+### For NodeJS environment
+```typescript
+import { SpecParser, ParseOptions } from "@microsoft/m365-spec-parser";
+
+// Define parsing options
+const option: ParseOptions = {
+  allowMissingId: true, // Allow missing IDs in the specification, default true
+  allowSwagger: true, // Allow Swagger specifications, default true
+  allowAPIKeyAuth: false, // Disallow API key authentication, default false
+  allowMultipleParameters: false, // Disallow multiple parameters, default false
+  allowOauth2: false, // Disallow OAuth2 authentication, default false
+};
+
+// Create a new SpecParser instance with the given options
+const parser = new SpecParser("path/to/spec/file", option);
+
+// Validate the specification
+const validateResult = await parser.validate();
+// If the specification is not valid, log the errors and warnings
+if (validateResult.status !== ValidationStatus.Valid) {
+  console.log(validateResult.errors);
+  console.log(validateResult.warnings);
+}
+
+// List the operations in the specification
+const listResult = await parser.list();
+// Log each operation
+for (let i = 0; i < listResult.length; i++) {
+  console.log(listResult[i]);
+}
+
+// Define a filter for the operations to generate
+const filter = ["GET /pet/{id}"];
+// Define the paths for the Teams app manifest file, the output specification file, and the output adaptive card folder
+const teamsAppManifestFilePath = "path/to/teamsapp/manifest/file";
+const outputSpecFilePath = "path/to/output/spec/path";
+const outputAdaptiveCardFolder = "adaptivecard/folder";
+// Generate the operations
+const generateResult = await parser.generate(
+  teamsAppManifestFilePath,
+  filter,
+  outputSpecFilePath,
+  outputAdaptiveCardFolder
+);
+
+// If not all operations were successfully generated, log the warnings
+if (!generateResult.allSuccess) {
+  console.log(generateResult.warnings);
+}
+```
+
+### For browser environment
+```typescript
+import { SpecParser, ParseOptions } from "@microsoft/m365-spec-parser";
+
+// Define parsing options
+const option: ParseOptions = {
+  allowMissingId: false, // Allow missing IDs in the specification, default false
+  allowSwagger: false, // Allow Swagger specifications, default false
+  allowAPIKeyAuth: false, // Disallow API key authentication, default false
+  allowMultipleParameters: false, // Disallow multiple parameters, default false
+  allowOauth2: false, // Disallow OAuth2 authentication, default false
+};
+
+// Create a new SpecParser instance with the given options
+const parser = new SpecParser("path/to/spec/file", option);
+
+// Validate the specification
+const validateResult = await parser.validate();
+// If the specification is not valid, log the errors and warnings
+if (validateResult.status !== ValidationStatus.Valid) {
+  console.log(validateResult.errors);
+  console.log(validateResult.warnings);
+}
+
+// List the operations in the specification
+const listResult = await parser.listSupportedAPIInfo();
+// Log each operation
+for (let i = 0; i < listResult.length; i++) {
+  console.log(listResult[i]);
+}
+```
+
+## Data Collection.
+
+The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.
+
+## Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+
+## Contributing
+
+There are many ways in which you can participate in the project, for example:
+
+- [Submit bugs and feature requests](https://github.com/OfficeDev/TeamsFx/issues), and help us verify as they are checked in
+- Review [source code changes](https://github.com/OfficeDev/TeamsFx/pulls)
+
+If you are interested in fixing issues and contributing directly to the code base, please see the [Contributing Guide](./CONTRIBUTING.md).
+
+## Reporting Security Issues
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
+
+If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
+
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
+
+## Trademarks
+
+This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.
+
+## License
+
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+Licensed under the [MIT](LICENSE.txt) license.
diff --git a/packages/spec-parser/config/.mocharc.json b/packages/spec-parser/config/.mocharc.json
@@ -0,0 +1,5 @@
+{
+    "extensions": ["ts"],
+    "spec": ["test/*.test.ts"],
+    "require": ["ts-node/register"]
+}
diff --git a/packages/spec-parser/config/mocha.env.ts b/packages/spec-parser/config/mocha.env.ts
@@ -0,0 +1,8 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+/*
+ * Specify test tsconfig file for Windows
+ */
+process.env.TS_NODE_COMPILER_OPTIONS = '{ "module": "commonjs", "target": "es2016" }';
+process.env.TS_NODE_FILES = "true";
diff --git a/packages/spec-parser/config/webpack.test.cjs b/packages/spec-parser/config/webpack.test.cjs
@@ -0,0 +1,52 @@
+const webpack = require("webpack");
+module.exports = {
+  mode: "development",
+  devtool: "source-map",
+  module: {
+    rules: [
+      {
+        test: /\.tsx?$/,
+        use: {
+          loader: "ts-loader",
+          options: {
+            compilerOptions: {
+              module: "commonjs",
+              target: "es2017",
+              downlevelIteration: true,
+              resolveJsonModule: true,
+            },
+          },
+        },
+      },
+      {
+        test: /\.[tj]sx?$/,
+        exclude: /node_modules/,
+        use: "source-map-loader",
+        enforce: "pre",
+      },
+    ],
+  },
+  resolve: {
+    modules: ["node_modules"],
+    mainFields: ["browser", "module", "main"],
+    extensions: [".js", ".ts"],
+    symlinks: true,
+    fallback: {
+      url: require.resolve("url/"),
+      http: require.resolve("stream-http"),
+      https: require.resolve("https-browserify"),
+      stream: require.resolve("stream-browserify"),
+      buffer: require.resolve("buffer"),
+      "process/browser": require.resolve("process/browser"),
+      util: false,
+    },
+  },
+  plugins: [
+    new webpack.ProvidePlugin({
+      process: "process/browser",
+    }),
+    new webpack.ProvidePlugin({
+      Buffer: ["buffer", "Buffer"],
+    }),
+  ],
+};