@microsoft/m365-spec-parser 0.0.2-alpha.0

package/dist/src/utils.d.ts

@@ -0,0 +1,44 @@
+import { OpenAPIV3 } from "openapi-types";
+import SwaggerParser from '@apidevtools/swagger-parser';
+import { AuthSchema, CheckParamResult, ErrorResult, Parameter, ValidateResult, WarningResult } from "./interfaces";
+import { IMessagingExtensionCommand } from "@microsoft/teams-manifest";
+export declare class Utils {
+    static checkParameters(paramObject: OpenAPIV3.ParameterObject[]): CheckParamResult;
+    static checkPostBody(schema: OpenAPIV3.SchemaObject, isRequired?: boolean): CheckParamResult;
+    /**
+     * Checks if the given API is supported.
+     * @param {string} method - The HTTP method of the API.
+     * @param {string} path - The path of the API.
+     * @param {OpenAPIV3.Document} spec - The OpenAPI specification document.
+     * @returns {boolean} - Returns true if the API is supported, false otherwise.
+     * @description The following APIs are supported:
+     * 1. only support Get/Post operation without auth property
+     * 2. parameter inside query or path only support string, number, boolean and integer
+     * 3. parameter inside post body only support string, number, boolean, integer and object
+     * 4. request body + required parameters <= 1
+     * 5. response body should be “application/json” and not empty, and response code should be 20X
+     * 6. only support request body with “application/json” content type
+     */
+    static isSupportedApi(method: string, path: string, spec: OpenAPIV3.Document, allowMissingId: boolean, allowAPIKeyAuth: boolean, allowMultipleParameters: boolean, allowOauth2: boolean): boolean;
+    static isSupportedAuth(authSchemaArray: AuthSchema[][], allowAPIKeyAuth: boolean, allowOauth2: boolean): boolean;
+    static isAPIKeyAuth(authSchema: OpenAPIV3.SecuritySchemeObject): boolean;
+    static isBearerTokenAuth(authSchema: OpenAPIV3.SecuritySchemeObject): boolean;
+    static getAuthArray(securities: OpenAPIV3.SecurityRequirementObject[] | undefined, spec: OpenAPIV3.Document): AuthSchema[][];
+    static updateFirstLetter(str: string): string;
+    static getResponseJson(operationObject: OpenAPIV3.OperationObject | undefined): OpenAPIV3.MediaTypeObject;
+    static convertPathToCamelCase(path: string): string;
+    static getUrlProtocol(urlString: string): string | undefined;
+    static resolveServerUrl(url: string): string;
+    static checkServerUrl(servers: OpenAPIV3.ServerObject[]): ErrorResult[];
+    static validateServer(spec: OpenAPIV3.Document, allowMissingId: boolean, allowAPIKeyAuth: boolean, allowMultipleParameters: boolean, allowOauth2: boolean): ErrorResult[];
+    static isWellKnownName(name: string, wellknownNameList: string[]): boolean;
+    static generateParametersFromSchema(schema: OpenAPIV3.SchemaObject, name: string, allowMultipleParameters: boolean, isRequired?: boolean): [Parameter[], Parameter[]];
+    static updateParameterWithInputType(schema: OpenAPIV3.SchemaObject, param: Parameter): void;
+    static parseApiInfo(operationItem: OpenAPIV3.OperationObject, allowMultipleParameters: boolean): [IMessagingExtensionCommand, WarningResult | undefined];
+    static listSupportedAPIs(spec: OpenAPIV3.Document, allowMissingId: boolean, allowAPIKeyAuth: boolean, allowMultipleParameters: boolean, allowOauth2: boolean): {
+        [key: string]: OpenAPIV3.OperationObject;
+    };
+    static validateSpec(spec: OpenAPIV3.Document, parser: SwaggerParser, isSwaggerFile: boolean, allowMissingId: boolean, allowAPIKeyAuth: boolean, allowMultipleParameters: boolean, allowOauth2: boolean): ValidateResult;
+    static format(str: string, ...args: string[]): string;
+    static getSafeRegistrationIdEnvName(authName: string): string;
+}

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@microsoft/m365-spec-parser",
+  "version": "0.0.2-alpha.0",
+  "description": "OpenAPI specification files Parser for M365 Apps",
+  "main": "dist/index.node.cjs.js",
+  "browser": "dist/index.esm2017.js",
+  "module": "dist/index.esm2017.mjs",
+  "esm5": "dist/index.esm5.js",
+  "types": "dist/src/index.d.ts",
+  "scripts": {
+    "build": "rollup -c",
+    "test:unit:node": "nyc --no-clean -- mocha \"test/*.test.ts\" -r config/mocha.env.ts --config config/.mocharc.json",
+    "test:unit:browser": "karma start karma.conf.cjs --single-run --unit",
+    "test:unit": "npm run test:unit:node && npm run test:unit:browser "
+  },
+  "files": [
+    "dist/*js",
+    "dist/*js.map",
+    "dist/src/*d.ts"
+  ],
+  "repository": "https://github.com/OfficeDev/TeamsFx",
+  "engines": {
+    "node": ">=10.0.0"
+  },
+  "keywords": [
+    "typescript"
+  ],
+  "author": "Microsoft Corporation",
+  "license": "MIT",
+  "homepage": "https://github.com/OfficeDev/TeamsFx",
+  "sideEffects": false,
+  "dependencies": {
+    "@apidevtools/swagger-parser": "^10.1.0",
+    "@microsoft/teams-manifest": "^0.1.3",
+    "@types/webpack": "^5.28.5",
+    "c8": "^9.1.0",
+    "dotenv": "^16.4.1",
+    "fs-extra": "^11.2.0",
+    "http": "^0.0.1-security",
+    "https-browserify": "^1.0.0",
+    "js-yaml": "^4.1.0",
+    "openapi-types": "^7.2.3",
+    "process": "^0.11.10",
+    "stream-browserify": "^3.0.0",
+    "stream-http": "^3.2.0",
+    "swagger2openapi": "^7.0.8",
+    "url": "^0.11.3",
+    "webpack": "^5.90.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@istanbuljs/nyc-config-typescript": "^1.0.2",
+    "@rollup/plugin-json": "^6.1.0",
+    "@types/chai": "^4.2.22",
+    "@types/fs-extra": "^11.0.4",
+    "@types/js-yaml": "^4.0.9",
+    "@types/mocha": "^9.0.0",
+    "@types/sinon": "^17.0.3",
+    "@types/swagger2openapi": "^7.0.4",
+    "chai": "^4.3.4",
+    "karma": "^6.3.8",
+    "karma-chrome-launcher": "^3.1.0",
+    "karma-cli": "^2.0.0",
+    "karma-coverage": "^2.0.0",
+    "karma-env-preprocessor": "^0.1.1",
+    "karma-junit-reporter": "^2.0.1",
+    "karma-mocha": "^2.0.1",
+    "karma-mocha-reporter": "^2.2.5",
+    "karma-sourcemap-loader": "^0.3.8",
+    "karma-webpack": "^5.0.0",
+    "mocha": "^9.2.0",
+    "mock-fs": "^5.2.0",
+    "mocked-env": "^1.3.5",
+    "puppeteer": "^13.1.3",
+    "rollup": "^2.41.0",
+    "rollup-plugin-typescript2": "^0.31.0",
+    "sinon": "^12.0.1",
+    "source-map-loader": "^3.0.0",
+    "ts-loader": "^9.2.6",
+    "ts-node": "^10.4.0",
+    "typescript": "^4.4.4",
+    "util": "^0.12.5"
+  }
+}