Split openapi (SAP#1719)

* split http-client * changes * fix test error * add missing dependency * fix dep check * fix import path * revert fix import path * remarks review * lint error * fix * split open api * add missing dep
deekshas8 · Oct 20, 2021 · feedd62 · feedd62
1 parent fcd55c3
commit feedd62
Show file tree

Hide file tree

Showing 67 changed files with 268 additions and 94 deletions.
diff --git a/package.json b/package.json
@@ -15,8 +15,9 @@
   "workspaces": [
     "packages/analytics",
     "packages/connectivity",
-    "packages/core",
     "packages/http-client",
+    "packages/openapi",
+    "packages/core",
     "packages/eslint-config",
     "packages/generator",
     "packages/test-util",

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -36,6 +36,7 @@
     "@sap-cloud-sdk/util": "^1.50.0",
     "@sap-cloud-sdk/connectivity": "^1.50.0",
     "@sap-cloud-sdk/http-client": "^1.50.0",
+    "@sap-cloud-sdk/openapi": "^1.50.0",
     "@types/jsonwebtoken": "^8.3.8",
     "axios": "^0.23.0",
     "bignumber.js": "^9.0.0",

diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -50,4 +50,3 @@ export {
   uriConverters
 } from './odata-v2';
 export * from './odata-v4';
-export * from './openapi';
diff --git a/packages/core/src/openapi/index.ts b/packages/core/src/openapi/index.ts
diff --git a/packages/core/test/test-util/test-services/openapi/no-schema-service/default-api.ts b/packages/core/test/test-util/test-services/openapi/no-schema-service/default-api.ts
@@ -3,7 +3,7 @@
  *
  * This is a generated file powered by the SAP Cloud SDK for JavaScript.
  */
-import { OpenApiRequestBuilder } from '../../../../../src';
+import { OpenApiRequestBuilder } from '@sap-cloud-sdk/openapi';
 /**
  * Representation of the 'DefaultApi'.
  * This API is part of the 'no-schema-service' service.

diff --git a/packages/core/test/test-util/test-services/openapi/swagger-yaml-service/default-api.ts b/packages/core/test/test-util/test-services/openapi/swagger-yaml-service/default-api.ts
@@ -3,7 +3,7 @@
  *
  * This is a generated file powered by the SAP Cloud SDK for JavaScript.
  */
-import { OpenApiRequestBuilder } from '../../../../../src';
+import { OpenApiRequestBuilder } from '@sap-cloud-sdk/openapi';
 import type { TestEntity } from './schema';
 /**
  * Representation of the 'DefaultApi'.

diff --git a/packages/core/test/test-util/test-services/openapi/test-service/default-api.ts b/packages/core/test/test-util/test-services/openapi/test-service/default-api.ts
@@ -3,7 +3,7 @@
  *
  * This is a generated file powered by the SAP Cloud SDK for JavaScript.
  */
-import { OpenApiRequestBuilder } from '../../../../../src';
+import { OpenApiRequestBuilder } from '@sap-cloud-sdk/openapi';
 /**
  * Representation of the 'DefaultApi'.
  * This API is part of the 'test-service' service.

diff --git a/packages/core/test/test-util/test-services/openapi/test-service/entity-api.ts b/packages/core/test/test-util/test-services/openapi/test-service/entity-api.ts
@@ -3,7 +3,7 @@
  *
  * This is a generated file powered by the SAP Cloud SDK for JavaScript.
  */
-import { OpenApiRequestBuilder } from '../../../../../src';
+import { OpenApiRequestBuilder } from '@sap-cloud-sdk/openapi';
 import type { TestEntity } from './schema';
 /**
  * Representation of the 'EntityApi'.

diff --git a/packages/core/test/test-util/test-services/openapi/test-service/extension-api.ts b/packages/core/test/test-util/test-services/openapi/test-service/extension-api.ts
@@ -3,7 +3,7 @@
  *
  * This is a generated file powered by the SAP Cloud SDK for JavaScript.
  */
-import { OpenApiRequestBuilder } from '../../../../../src';
+import { OpenApiRequestBuilder } from '@sap-cloud-sdk/openapi';
 /**
  * Representation of the 'ExtensionApi'.
  * This API is part of the 'test-service' service.

diff --git a/packages/core/test/test-util/test-services/openapi/test-service/tag-dot-api.ts b/packages/core/test/test-util/test-services/openapi/test-service/tag-dot-api.ts
@@ -3,7 +3,7 @@
  *
  * This is a generated file powered by the SAP Cloud SDK for JavaScript.
  */
-import { OpenApiRequestBuilder } from '../../../../../src';
+import { OpenApiRequestBuilder } from '@sap-cloud-sdk/openapi';
 /**
  * Representation of the 'TagDotApi'.
  * This API is part of the 'test-service' service.

diff --git a/packages/core/test/test-util/test-services/openapi/test-service/tag-space-api.ts b/packages/core/test/test-util/test-services/openapi/test-service/tag-space-api.ts
@@ -3,7 +3,7 @@
  *
  * This is a generated file powered by the SAP Cloud SDK for JavaScript.
  */
-import { OpenApiRequestBuilder } from '../../../../../src';
+import { OpenApiRequestBuilder } from '@sap-cloud-sdk/openapi';
 /**
  * Representation of the 'TagSpaceApi'.
  * This API is part of the 'test-service' service.

diff --git a/packages/core/test/test-util/test-services/openapi/test-service/test-case-api.ts b/packages/core/test/test-util/test-services/openapi/test-service/test-case-api.ts
@@ -3,7 +3,7 @@
  *
  * This is a generated file powered by the SAP Cloud SDK for JavaScript.
  */
-import { OpenApiRequestBuilder } from '../../../../../src';
+import { OpenApiRequestBuilder } from '@sap-cloud-sdk/openapi';
 import type {
   SimpleTestEntity,
   ComplexTestEntity,

diff --git a/packages/openapi-generator/src/file-serializer/api-file.spec.ts b/packages/openapi-generator/src/file-serializer/api-file.spec.ts
@@ -28,7 +28,7 @@ describe('apiFile', () => {
       ]
     };
     expect(apiFile(api, 'MyserviceName')).toMatchInlineSnapshot(`
-      "import { OpenApiRequestBuilder } from '@sap-cloud-sdk/core';
+      "import { OpenApiRequestBuilder } from '@sap-cloud-sdk/openapi';
       /**
        * Representation of the 'TestApi'.
        * This API is part of the 'MyserviceName' service.
@@ -111,7 +111,7 @@ describe('apiFile', () => {
       ]
     };
     expect(apiFile(api, 'MyserviceName')).toMatchInlineSnapshot(`
-      "import { OpenApiRequestBuilder } from '@sap-cloud-sdk/core';
+      "import { OpenApiRequestBuilder } from '@sap-cloud-sdk/openapi';
       import type { QueryParameterType, RefType, ResponseType } from './schema';
       /**
        * Representation of the 'TestApi'.
@@ -166,7 +166,7 @@ describe('apiFile', () => {
     };
 
     expect(apiFile(api, 'TestService')).toMatchInlineSnapshot(`
-      "import { OpenApiRequestBuilder } from '@sap-cloud-sdk/core';
+      "import { OpenApiRequestBuilder } from '@sap-cloud-sdk/openapi';
       /**
        * Representation of the 'TestApi'.
        * This API is part of the 'TestService' service.

diff --git a/packages/openapi-generator/src/file-serializer/api-file.ts b/packages/openapi-generator/src/file-serializer/api-file.ts
@@ -63,7 +63,7 @@ function getImports(api: OpenApiApi): Import[] {
   };
   const coreImports = {
     names: ['OpenApiRequestBuilder'],
-    moduleIdentifier: '@sap-cloud-sdk/core'
+    moduleIdentifier: '@sap-cloud-sdk/openapi'
   };
 
   return [coreImports, refImports];

diff --git a/packages/openapi-generator/src/generator.ts b/packages/openapi-generator/src/generator.ts
@@ -107,7 +107,7 @@ export async function generateWithParsedOptions(
 
     if (!options.packageJson) {
       logger.info(
-        "Finished generation. Don't forget to add @sap-cloud-sdk/core to your dependencies."
+        "Finished generation. Don't forget to add @sap-cloud-sdk/openapi to your dependencies."
       );
     }
   }

diff --git a/packages/openapi/README.md b/packages/openapi/README.md
@@ -0,0 +1,55 @@
+<!-- sap-cloud-sdk-logo -->
+<!-- This block is inserted by scripts/replace-common-readme.ts. Do not adjust it manually. -->
+<a href="https://sap.com/s4sdk"><img src="https://help.sap.com/doc/2324e9c3b28748a4ae2ad08166d77675/1.0/en-US/logo-with-js.svg" alt="SAP Cloud SDK for JavaScript Logo" height="122.92" width="226.773"/></a>
+<!-- sap-cloud-sdk-logo-stop -->
+
+# @sap-cloud-sdk/openapi
+
+This package contains the OpenAPI request builder for different types of HTTP requests.
+.
+## Installation
+
+```
+$ npm install @sap-cloud-sdk/openapi
+```
+
+## Usage
+
+The openapi package is not intended for direct usage.
+
+For more detailed overview visit our [Execute OpenAPI request documentation](https://sap.github.io/cloud-sdk/docs/js/features/openapi/execute-openapi-request).
+
+<!-- sap-cloud-sdk-common-readme -->
+<!-- This block is inserted by scripts/replace-common-readme.ts. Do not adjust it manually. -->
+## Support
+
+The recommended way to get in touch with us is to create an issue in our [github repository](https://github.com/SAP/cloud-sdk-js/issues).
+Select the issue category `Bug`, `Feature` or `Question` depending on the nature of your request.
+We try to provide fixes, features and answers as soon as possible.
+
+We also monitor questions on [StackOverflow](https://stackoverflow.com/questions/tagged/sap-cloud-sdk?tab=Newest) and [ansers.sap.com](https://answers.sap.com/tags/73555000100800000895) but prefer issues on github.
+
+## Contribute
+
+If you would like to contribute to the SAP Cloud SDK, please make yourself familiar with our [contributing guidelines](https://github.com/SAP/cloud-sdk-js/blob/main/CONTRIBUTING.md) and follow the given instructions.
+
+## Links
+
+- [Github](https://github.com/SAP/cloud-sdk-js)
+- [Github - Releases](https://github.com/SAP/cloud-sdk-js/releases)
+
+<br>
+
+- [SAP Cloud SDK Documentation portal](https://sap.github.io/cloud-sdk/)
+- [SAP Cloud SDK Documentation portal - Getting started guide](https://sap.github.io/cloud-sdk/docs/js/getting-started)
+- [SAP Cloud SDK Documentation portal - API documentation](https://sap.github.io/cloud-sdk/docs/js/api-reference-js-ts)
+
+<br>
+
+- [developers.sap.com - Product Overview](https://developers.sap.com/topics/cloud-sdk.html)
+- [developers.sap.com - Tutorials](https://developers.sap.com/tutorial-navigator.html?tag=products:technology-platform/sap-cloud-sdk/sap-cloud-sdk&tag=topic:javascript)
+
+## License
+
+The SAP Cloud SDK is released under the [Apache License Version 2.0.](http://www.apache.org/licenses/)
+<!-- sap-cloud-sdk-common-readme-stop -->
diff --git a/packages/openapi/jest.config.js b/packages/openapi/jest.config.js
@@ -0,0 +1,6 @@
+// eslint-disable-next-line
+const commonConfig = require('../../test-resources/jest.common.config');
+module.exports = {
+  ...commonConfig,
+  displayName: 'openapi'
+};
diff --git a/packages/openapi/package.json b/packages/openapi/package.json
@@ -0,0 +1,45 @@
+{
+  "name": "@sap-cloud-sdk/openapi",
+  "version": "1.50.0",
+  "description": "SAP Cloud SDK for JavaScript openapi",
+  "homepage": "https://sap.github.io/cloud-sdk/docs/js/overview-cloud-sdk-for-javascript",
+  "license": "Apache-2.0",
+  "keywords": [
+    "sap-cloud-sdk",
+    "cloud-sdk",
+    "sap-cloud-platform",
+    "open-api"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.js.map",
+    "dist/**/*.d.ts",
+    "dist/**/*.d.ts.map",
+    "usage-analytics.js"
+  ],
+  "repository": "github:SAP/cloud-sdk-js",
+  "scripts": {
+    "compile": "yarn tsc -b",
+    "prepare": "yarn compile",
+    "postinstall": "node usage-analytics.js",
+    "test": "yarn jest",
+    "coverage": "yarn jest --coverage",
+    "check:dependencies": "depcheck ."
+  },
+  "dependencies": {
+    "@sap-cloud-sdk/analytics": "^1.50.0",
+    "@sap-cloud-sdk/util": "^1.50.0",
+    "@sap-cloud-sdk/connectivity": "^1.50.0",
+    "@sap-cloud-sdk/http-client": "^1.50.0",
+    "axios": "^0.21.1"
+  },
+  "devDependencies": {
+    "@sap-cloud-sdk/core": "^1.50.0",
+    "nock": "^13.0.11"
+  }
+}
diff --git a/packages/openapi/src/index.ts b/packages/openapi/src/index.ts
@@ -0,0 +1,8 @@
+export { OpenApiRequestBuilder } from './openapi-request-builder';
+export {
+  ParametersType,
+  FunctionReturnType,
+  UnwrapAxiosResponse,
+  UnPromisify,
+  ConstructorType
+} from './types';
diff --git a/...c/openapi/openapi-request-builder.spec.ts → ...enapi/src/openapi-request-builder.spec.ts b/...c/openapi/openapi-request-builder.spec.ts → ...enapi/src/openapi-request-builder.spec.ts
@@ -13,9 +13,9 @@ import {
   onlyIssuerXsuaaUrl,
   providerXsuaaUrl,
   providerServiceToken
-} from '../../test/test-util';
-import { wrapJwtInHeader } from '../../../connectivity/src/scp-cf/jwt';
-import { parseDestination } from '../../../connectivity/src/scp-cf/destination/destination';
+} from '@sap-cloud-sdk/core/test/test-util';
+import { wrapJwtInHeader } from '@sap-cloud-sdk/connectivity/src/scp-cf/jwt';
+import { parseDestination } from '@sap-cloud-sdk/connectivity/src/scp-cf/destination/destination';
 import { OpenApiRequestBuilder } from './openapi-request-builder';
 
 const destination = {

diff --git a/...re/src/openapi/openapi-request-builder.ts → ...es/openapi/src/openapi-request-builder.ts b/...re/src/openapi/openapi-request-builder.ts → ...es/openapi/src/openapi-request-builder.ts
diff --git a/packages/core/src/openapi/types.ts → packages/openapi/src/types.ts b/packages/core/src/openapi/types.ts → packages/openapi/src/types.ts
diff --git a/packages/openapi/tsconfig.json b/packages/openapi/tsconfig.json
@@ -0,0 +1,18 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist",
+    "tsBuildInfoFile": "./dist/.tsbuildinfo",
+    "composite": true
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["dist/**/*", "test/**/*", "**/*.spec.ts", "node_modules/**/*"],
+  "files": [],
+  "references": [
+    { "path": "../util" },
+    { "path": "../analytics" },
+    { "path": "../connectivity" },
+    { "path": "../http-client" }
+  ]
+}
diff --git a/packages/openapi/tsdoc.json b/packages/openapi/tsdoc.json
@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "extends": ["../../tsdoc.json"]
+}
diff --git a/packages/openapi/usage-analytics.js b/packages/openapi/usage-analytics.js
@@ -0,0 +1,12 @@
+try {
+  // See docs/specs/0005_analytics-lifecycle-trick.md
+  const analytics = require('@sap-cloud-sdk/analytics');
+  const path = require('path');
+
+  const pathOfPostinstallScript = path.resolve(__dirname);
+  analytics.performUsageAnalytics(pathOfPostinstallScript, {
+    event_type: 'npm_install_openapi'
+  });
+} catch (e) {
+  console.log('Looks like a local install to me.');
+}
diff --git a/scripts/check-public-api-cli.ts b/scripts/check-public-api-cli.ts
@@ -7,6 +7,7 @@ For a deatailed explaination what is happening here have a look at `0007-public-
 async function checkApiPackages() {
   await checkApiOfPackage(resolve(__dirname, '../packages/connectivity'));
   await checkApiOfPackage(resolve(__dirname, '../packages/http-client'));
+  await checkApiOfPackage(resolve(__dirname, '../packages/openapi'));
 }
 
 checkApiPackages();
diff --git a/test-packages/test-services/openapi/no-schema-service/default-api.d.ts b/test-packages/test-services/openapi/no-schema-service/default-api.d.ts
@@ -1,4 +1,4 @@
-import { OpenApiRequestBuilder } from '@sap-cloud-sdk/core';
+import { OpenApiRequestBuilder } from '@sap-cloud-sdk/openapi';
 /**
  * Representation of the 'DefaultApi'.
  * This API is part of the 'no-schema-service' service.

diff --git a/test-packages/test-services/openapi/no-schema-service/default-api.d.ts.map b/test-packages/test-services/openapi/no-schema-service/default-api.d.ts.map
diff --git a/test-packages/test-services/openapi/no-schema-service/default-api.js b/test-packages/test-services/openapi/no-schema-service/default-api.js
diff --git a/test-packages/test-services/openapi/no-schema-service/default-api.js.map b/test-packages/test-services/openapi/no-schema-service/default-api.js.map
diff --git a/test-packages/test-services/openapi/no-schema-service/default-api.ts b/test-packages/test-services/openapi/no-schema-service/default-api.ts
@@ -3,7 +3,7 @@
  *
  * This is a generated file powered by the SAP Cloud SDK for JavaScript.
  */
-import { OpenApiRequestBuilder } from '@sap-cloud-sdk/core';
+import { OpenApiRequestBuilder } from '@sap-cloud-sdk/openapi';
 /**
  * Representation of the 'DefaultApi'.
  * This API is part of the 'no-schema-service' service.

diff --git a/test-packages/test-services/openapi/swagger-yaml-service/default-api.d.ts b/test-packages/test-services/openapi/swagger-yaml-service/default-api.d.ts
@@ -1,4 +1,4 @@
-import { OpenApiRequestBuilder } from '@sap-cloud-sdk/core';
+import { OpenApiRequestBuilder } from '@sap-cloud-sdk/openapi';
 import type { TestEntity } from './schema';
 /**
  * Representation of the 'DefaultApi'.

diff --git a/test-packages/test-services/openapi/swagger-yaml-service/default-api.d.ts.map b/test-packages/test-services/openapi/swagger-yaml-service/default-api.d.ts.map