@sap-ux/system-access 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,22 @@
1
+ # `@sap-ux/system-access`
2
+
3
+ Module offering reusable functionality to access SAP systems. This module is currently in a 0.x version and is only recommended to be used by modules within the `open-ux-tools` monorepo because the API is subject to change without notice.
4
+
5
+
6
+ ## Installation
7
+ Npm
8
+ `npm install --save @sap-ux/system-access`
9
+
10
+ Yarn
11
+ `yarn add @sap-ux/system-access`
12
+
13
+ Pnpm
14
+ `pnpm add @sap-ux/system-access`
15
+
16
+ ## Usage
17
+ See usage in `test/` folder.
18
+
19
+ ## Keywords
20
+ * SAP Fiori tools
21
+ * SAP Fiori elements
22
+ * SAP Fiori freestyle
@@ -0,0 +1,21 @@
1
+ import type { Logger } from '@sap-ux/logger';
2
+ import type { AbapTarget, UrlAbapTarget } from '../types';
3
+ import type { AbapServiceProvider, AxiosRequestConfig, ProviderConfiguration } from '@sap-ux/axios-extension';
4
+ /**
5
+ * Check if it is a url or destination target.
6
+ *
7
+ * @param target target configuration
8
+ * @returns true is it is a UrlAbapTarget
9
+ */
10
+ export declare function isUrlTarget(target: AbapTarget): target is UrlAbapTarget;
11
+ /**
12
+ * Create an instance of an ABAP service provider connected to the given target configuration.
13
+ *
14
+ * @param target - target configuration
15
+ * @param requestOptions - additional AxiosRequestOptions
16
+ * @param prompt - prompt the user for missing information
17
+ * @param logger - optional reference to the logger instance
18
+ * @returns service instance
19
+ */
20
+ export declare function createAbapServiceProvider(target: AbapTarget, requestOptions: (AxiosRequestConfig & Partial<ProviderConfiguration>) | undefined, prompt: boolean, logger: Logger): Promise<AbapServiceProvider>;
21
+ //# sourceMappingURL=connect.d.ts.map
@@ -0,0 +1,143 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ var __importDefault = (this && this.__importDefault) || function (mod) {
12
+ return (mod && mod.__esModule) ? mod : { "default": mod };
13
+ };
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.createAbapServiceProvider = exports.isUrlTarget = void 0;
16
+ const axios_extension_1 = require("@sap-ux/axios-extension");
17
+ const credentials_1 = require("./credentials");
18
+ const btp_utils_1 = require("@sap-ux/btp-utils");
19
+ const prompts_1 = require("./prompts");
20
+ const prompts_2 = __importDefault(require("prompts"));
21
+ const fs_1 = require("fs");
22
+ /**
23
+ * Check if it is a url or destination target.
24
+ *
25
+ * @param target target configuration
26
+ * @returns true is it is a UrlAbapTarget
27
+ */
28
+ function isUrlTarget(target) {
29
+ return target.url !== undefined;
30
+ }
31
+ exports.isUrlTarget = isUrlTarget;
32
+ /**
33
+ * Enhance axios options and create a service provider instance for an ABAP Cloud system.
34
+ *
35
+ * @param options - predefined axios options
36
+ * @param target - url target configuration
37
+ * @param prompt - prompt the user for missing information
38
+ * @param logger - reference to the logger instance
39
+ * @returns an abap service provider
40
+ */
41
+ function createAbapCloudServiceProvider(options, target, prompt, logger) {
42
+ return __awaiter(this, void 0, void 0, function* () {
43
+ const providerConfig = Object.assign(Object.assign({}, options), { environment: axios_extension_1.AbapCloudEnvironment.Standalone, service: target.serviceKey });
44
+ if (!providerConfig.service) {
45
+ // first try reading the keys from the store
46
+ const storedOpts = yield (0, credentials_1.getCredentialsFromStore)(target, logger);
47
+ if ((0, credentials_1.isServiceAuth)(storedOpts)) {
48
+ providerConfig.service = storedOpts.serviceKeys;
49
+ providerConfig.refreshToken = storedOpts.refreshToken;
50
+ logger.info(`Using system [${storedOpts.name}] from System store`);
51
+ }
52
+ if (!providerConfig.service && prompt) {
53
+ const { path } = yield (0, prompts_2.default)(prompts_1.questions.serviceKeysPath);
54
+ providerConfig.service = JSON.parse((0, fs_1.readFileSync)(path, 'utf-8'));
55
+ }
56
+ }
57
+ // if no keys are available throw and error
58
+ if (providerConfig.service) {
59
+ return (0, axios_extension_1.createForAbapOnCloud)(providerConfig);
60
+ }
61
+ else {
62
+ throw new Error('Service keys required for ABAP Cloud environment.');
63
+ }
64
+ });
65
+ }
66
+ /**
67
+ * Enhance axios options and create a service provider instance for an on-premise ABAP system.
68
+ *
69
+ * @param options predefined axios options
70
+ * @param target url target configuration
71
+ * @param prompt - prompt the user for missing information
72
+ * @param logger reference to the logger instance
73
+ * @returns an ABAPServiceProvider instance
74
+ */
75
+ function createAbapOnPremServiceProvider(options, target, prompt, logger) {
76
+ return __awaiter(this, void 0, void 0, function* () {
77
+ options.baseURL = target.url;
78
+ if (target.client) {
79
+ options.params['sap-client'] = target.client;
80
+ }
81
+ if (!options.auth) {
82
+ const storedOpts = yield (0, credentials_1.getCredentialsFromStore)(target, logger);
83
+ if ((0, credentials_1.isBasicAuth)(storedOpts)) {
84
+ options.auth = {
85
+ username: storedOpts.username,
86
+ password: storedOpts.password
87
+ };
88
+ }
89
+ else {
90
+ if ((0, credentials_1.isServiceAuth)(storedOpts)) {
91
+ throw new Error('This is an ABAP Cloud system, please correct your configuration.');
92
+ }
93
+ if (prompt) {
94
+ const credentials = yield (0, credentials_1.getCredentialsWithPrompts)(storedOpts === null || storedOpts === void 0 ? void 0 : storedOpts.username);
95
+ options.auth = credentials;
96
+ process.env.FIORI_TOOLS_USER = credentials.username;
97
+ process.env.FIORI_TOOLS_PASSWORD = credentials.password;
98
+ }
99
+ }
100
+ }
101
+ return (0, axios_extension_1.createForAbap)(options);
102
+ });
103
+ }
104
+ /**
105
+ * Create an instance of an ABAP service provider connected to the given target configuration.
106
+ *
107
+ * @param target - target configuration
108
+ * @param requestOptions - additional AxiosRequestOptions
109
+ * @param prompt - prompt the user for missing information
110
+ * @param logger - optional reference to the logger instance
111
+ * @returns service instance
112
+ */
113
+ function createAbapServiceProvider(target, requestOptions, prompt, logger) {
114
+ var _a;
115
+ return __awaiter(this, void 0, void 0, function* () {
116
+ let provider;
117
+ const options = Object.assign({ params: (_a = target.params) !== null && _a !== void 0 ? _a : {} }, requestOptions);
118
+ // Destination only supported on Business Application studio
119
+ if ((0, btp_utils_1.isAppStudio)() && target.destination) {
120
+ // Need additional properties to determine the type of destination we are dealing with
121
+ const destinations = yield (0, btp_utils_1.listDestinations)();
122
+ const destination = destinations === null || destinations === void 0 ? void 0 : destinations[target.destination];
123
+ if (!destination) {
124
+ throw new Error(`Destination ${target.destination} not found on subaccount`);
125
+ }
126
+ provider = (0, axios_extension_1.createForDestination)(options, destination);
127
+ }
128
+ else if (isUrlTarget(target)) {
129
+ if (target.scp) {
130
+ provider = yield createAbapCloudServiceProvider(options, target, prompt, logger);
131
+ }
132
+ else {
133
+ provider = yield createAbapOnPremServiceProvider(options, target, prompt, logger);
134
+ }
135
+ }
136
+ else {
137
+ throw new Error('Unable to handle the configuration in the current environment.');
138
+ }
139
+ return provider;
140
+ });
141
+ }
142
+ exports.createAbapServiceProvider = createAbapServiceProvider;
143
+ //# sourceMappingURL=connect.js.map
@@ -0,0 +1,61 @@
1
+ import type { Logger } from '@sap-ux/logger';
2
+ import { BackendSystem } from '@sap-ux/store';
3
+ import type { UrlAbapTarget } from '../types';
4
+ export type BasicAuth = Required<Pick<BackendSystem, 'username' | 'password'>>;
5
+ export type ServiceAuth = Required<Pick<BackendSystem, 'serviceKeys' | 'name' | 'refreshToken'>>;
6
+ /**
7
+ * Checks if credentials are of basic auth type.
8
+ *
9
+ * @param authOpts credential options
10
+ * @returns boolean
11
+ */
12
+ export declare function isBasicAuth(authOpts: BackendSystem | BasicAuth | undefined): authOpts is BasicAuth;
13
+ /**
14
+ * Checks if credentials are of service auth type.
15
+ *
16
+ * @param authOpts credential options
17
+ * @returns boolean
18
+ */
19
+ export declare function isServiceAuth(authOpts: BackendSystem | ServiceAuth | undefined): authOpts is ServiceAuth;
20
+ /**
21
+ * Check the secure storage if it has credentials for the given target.
22
+ *
23
+ * @param target ABAP target
24
+ * @param logger - reference to the logger instance
25
+ * @returns credentials from the store or undefined.
26
+ */
27
+ export declare function getCredentialsFromStore(target: UrlAbapTarget, logger: Logger): Promise<BackendSystem | undefined>;
28
+ /**
29
+ * Store the credentials in the secure storage.
30
+ *
31
+ * @param name system name
32
+ * @param target target
33
+ * @param target.url system url
34
+ * @param target.client optional system client
35
+ * @param credentials basic auth credentials
36
+ * @param credentials.username username
37
+ * @param credentials.password password
38
+ * @param logger reference to the logger instance
39
+ * @returns true if the credentials are successfully stored
40
+ */
41
+ export declare function storeCredentials(name: string, target: {
42
+ url: string;
43
+ client?: string;
44
+ }, credentials: {
45
+ username: string;
46
+ password: string;
47
+ }, logger: Logger): Promise<boolean>;
48
+ /**
49
+ * Checks the environment variables for Fiori tools settings.
50
+ *
51
+ * @returns basic auth credentials from the environment or undefined.
52
+ */
53
+ export declare function getCredentialsFromEnvVariables(): BasicAuth | undefined;
54
+ /**
55
+ * Prompt for username and password.
56
+ *
57
+ * @param username - optional username that is to be offered as default
58
+ * @returns credentials object with username/password
59
+ */
60
+ export declare function getCredentialsWithPrompts(username?: string): Promise<BasicAuth>;
61
+ //# sourceMappingURL=credentials.d.ts.map
@@ -0,0 +1,130 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ var __importDefault = (this && this.__importDefault) || function (mod) {
12
+ return (mod && mod.__esModule) ? mod : { "default": mod };
13
+ };
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.getCredentialsWithPrompts = exports.getCredentialsFromEnvVariables = exports.storeCredentials = exports.getCredentialsFromStore = exports.isServiceAuth = exports.isBasicAuth = void 0;
16
+ const store_1 = require("@sap-ux/store");
17
+ const btp_utils_1 = require("@sap-ux/btp-utils");
18
+ const prompts_1 = __importDefault(require("prompts"));
19
+ const prompts_2 = require("./prompts");
20
+ /**
21
+ * Checks if credentials are of basic auth type.
22
+ *
23
+ * @param authOpts credential options
24
+ * @returns boolean
25
+ */
26
+ function isBasicAuth(authOpts) {
27
+ return !!authOpts && authOpts.password !== undefined;
28
+ }
29
+ exports.isBasicAuth = isBasicAuth;
30
+ /**
31
+ * Checks if credentials are of service auth type.
32
+ *
33
+ * @param authOpts credential options
34
+ * @returns boolean
35
+ */
36
+ function isServiceAuth(authOpts) {
37
+ return !!authOpts && authOpts.serviceKeys !== undefined;
38
+ }
39
+ exports.isServiceAuth = isServiceAuth;
40
+ /**
41
+ * Check the secure storage if it has credentials for the given target.
42
+ *
43
+ * @param target ABAP target
44
+ * @param logger - reference to the logger instance
45
+ * @returns credentials from the store or undefined.
46
+ */
47
+ function getCredentialsFromStore(target, logger) {
48
+ return __awaiter(this, void 0, void 0, function* () {
49
+ try {
50
+ if (!(0, btp_utils_1.isAppStudio)()) {
51
+ const systemService = yield (0, store_1.getService)({ entityName: 'system' });
52
+ let system = yield systemService.read(new store_1.BackendSystemKey({ url: target.url, client: target.client }));
53
+ // check if there are credentials for the default client
54
+ if (!system && target.client) {
55
+ system = yield systemService.read(new store_1.BackendSystemKey({ url: target.url }));
56
+ }
57
+ return system;
58
+ }
59
+ }
60
+ catch (error) {
61
+ logger.warn('Reading credentials from store failed');
62
+ logger.debug(error.message);
63
+ }
64
+ return undefined;
65
+ });
66
+ }
67
+ exports.getCredentialsFromStore = getCredentialsFromStore;
68
+ /**
69
+ * Store the credentials in the secure storage.
70
+ *
71
+ * @param name system name
72
+ * @param target target
73
+ * @param target.url system url
74
+ * @param target.client optional system client
75
+ * @param credentials basic auth credentials
76
+ * @param credentials.username username
77
+ * @param credentials.password password
78
+ * @param logger reference to the logger instance
79
+ * @returns true if the credentials are successfully stored
80
+ */
81
+ function storeCredentials(name, target, credentials, logger) {
82
+ return __awaiter(this, void 0, void 0, function* () {
83
+ try {
84
+ const systemService = yield (0, store_1.getService)({ entityName: 'system' });
85
+ const system = new store_1.BackendSystem(Object.assign(Object.assign({ name }, target), credentials));
86
+ yield systemService.write(system);
87
+ return true;
88
+ }
89
+ catch (error) {
90
+ logger.error('Could not store credentials.');
91
+ logger.debug(error);
92
+ return false;
93
+ }
94
+ });
95
+ }
96
+ exports.storeCredentials = storeCredentials;
97
+ /**
98
+ * Checks the environment variables for Fiori tools settings.
99
+ *
100
+ * @returns basic auth credentials from the environment or undefined.
101
+ */
102
+ function getCredentialsFromEnvVariables() {
103
+ if (process.env.FIORI_TOOLS_USER && process.env.FIORI_TOOLS_PASSWORD) {
104
+ return {
105
+ username: process.env.FIORI_TOOLS_USER,
106
+ password: process.env.FIORI_TOOLS_PASSWORD
107
+ };
108
+ }
109
+ else {
110
+ return undefined;
111
+ }
112
+ }
113
+ exports.getCredentialsFromEnvVariables = getCredentialsFromEnvVariables;
114
+ /**
115
+ * Prompt for username and password.
116
+ *
117
+ * @param username - optional username that is to be offered as default
118
+ * @returns credentials object with username/password
119
+ */
120
+ function getCredentialsWithPrompts(username) {
121
+ return __awaiter(this, void 0, void 0, function* () {
122
+ const credentials = yield (0, prompts_1.default)([
123
+ Object.assign(Object.assign({}, prompts_2.questions.username), { initial: username }),
124
+ prompts_2.questions.password
125
+ ]);
126
+ return credentials;
127
+ });
128
+ }
129
+ exports.getCredentialsWithPrompts = getCredentialsWithPrompts;
130
+ //# sourceMappingURL=credentials.js.map
@@ -0,0 +1,20 @@
1
+ import type { PromptObject } from 'prompts';
2
+ /**
3
+ * Export map of questions for usage with the prompts modules
4
+ */
5
+ export declare const questions: {
6
+ readonly username: PromptObject<string>;
7
+ readonly password: PromptObject<string>;
8
+ readonly serviceKeysPath: PromptObject<string>;
9
+ readonly storeCredentials: PromptObject<string>;
10
+ readonly systemName: PromptObject<string>;
11
+ };
12
+ type keys = keyof typeof questions;
13
+ /**
14
+ * Generate a map of questions for usages with inquirer (e.g. in yeoman)
15
+ */
16
+ export declare const inquirer: {
17
+ [key in keys]: object;
18
+ };
19
+ export {};
20
+ //# sourceMappingURL=prompts.d.ts.map
@@ -0,0 +1,57 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.inquirer = exports.questions = void 0;
4
+ const fs_1 = require("fs");
5
+ const username = {
6
+ type: 'text',
7
+ name: 'username',
8
+ message: 'Username:'
9
+ };
10
+ const password = {
11
+ type: 'password',
12
+ name: 'password',
13
+ message: 'Password:'
14
+ };
15
+ const serviceKeysPath = {
16
+ type: 'text',
17
+ name: 'path',
18
+ message: 'Please provide the service keys as file:',
19
+ validate: (input) => (0, fs_1.existsSync)(input)
20
+ };
21
+ const storeCredentials = {
22
+ type: 'confirm',
23
+ name: 'store',
24
+ message: 'Do you want to store your credentials in the secure storage?',
25
+ initial: true
26
+ };
27
+ const systemName = {
28
+ type: 'text',
29
+ name: 'name',
30
+ message: 'System name:',
31
+ validate: (input) => !!input
32
+ };
33
+ /**
34
+ * Export map of questions for usage with the prompts modules
35
+ */
36
+ exports.questions = {
37
+ username,
38
+ password,
39
+ serviceKeysPath,
40
+ storeCredentials,
41
+ systemName
42
+ };
43
+ /**
44
+ * Generate a map of questions for usages with inquirer (e.g. in yeoman)
45
+ */
46
+ exports.inquirer = {};
47
+ for (const key in exports.questions) {
48
+ const question = exports.questions[key];
49
+ exports.inquirer[key] = {
50
+ type: question.type === 'text' ? 'input' : question.type,
51
+ name: question.name,
52
+ message: question.message,
53
+ validate: question.validate,
54
+ default: question.initial
55
+ };
56
+ }
57
+ //# sourceMappingURL=prompts.js.map
@@ -0,0 +1,5 @@
1
+ export * from './base/connect';
2
+ export * from './base/credentials';
3
+ export * from './base/prompts';
4
+ export * from './types';
5
+ //# sourceMappingURL=index.d.ts.map
package/dist/index.js ADDED
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./base/connect"), exports);
18
+ __exportStar(require("./base/credentials"), exports);
19
+ __exportStar(require("./base/prompts"), exports);
20
+ __exportStar(require("./types"), exports);
21
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1,13 @@
1
+ import type { AxiosRequestConfig, ServiceInfo } from '@sap-ux/axios-extension';
2
+ export interface UrlAbapTarget {
3
+ url: string;
4
+ client?: string;
5
+ scp?: boolean;
6
+ serviceKey?: ServiceInfo;
7
+ params?: AxiosRequestConfig['params'];
8
+ }
9
+ export interface DestinationAbapTarget {
10
+ destination: string;
11
+ }
12
+ export type AbapTarget = (UrlAbapTarget & Partial<DestinationAbapTarget>) | (DestinationAbapTarget & Partial<UrlAbapTarget>);
13
+ //# sourceMappingURL=types.d.ts.map
package/dist/types.js ADDED
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=types.js.map
package/package.json ADDED
@@ -0,0 +1,52 @@
1
+ {
2
+ "name": "@sap-ux/system-access",
3
+ "description": "Reusable module allowing to access systems using the store or prompts.",
4
+ "repository": {
5
+ "type": "git",
6
+ "url": "https://github.com/SAP/open-ux-tools.git",
7
+ "directory": "packages/system-access"
8
+ },
9
+ "bugs": {
10
+ "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Asystem-access"
11
+ },
12
+ "version": "0.2.0",
13
+ "license": "Apache-2.0",
14
+ "author": "@SAP/ux-tools-team",
15
+ "main": "dist/index.js",
16
+ "files": [
17
+ "LICENSE",
18
+ "dist",
19
+ "ui5.yaml",
20
+ "bin",
21
+ "!dist/*.map",
22
+ "!dist/**/*.map"
23
+ ],
24
+ "dependencies": {
25
+ "prompts": "2.4.2",
26
+ "@sap-ux/axios-extension": "1.4.1",
27
+ "@sap-ux/btp-utils": "0.11.8",
28
+ "@sap-ux/logger": "0.3.7",
29
+ "@sap-ux/store": "0.3.12"
30
+ },
31
+ "devDependencies": {
32
+ "@types/prompts": "2.0.14",
33
+ "rimraf": "5.0.1",
34
+ "@sap-ux/project-access": "1.11.2"
35
+ },
36
+ "engines": {
37
+ "pnpm": ">=6.26.1 < 7.0.0 || >=7.1.0",
38
+ "node": ">= 14.16.0 < 15.0.0 || >=16.1.0 < 17.0.0 || >=18.0.0 < 19.0.0"
39
+ },
40
+ "scripts": {
41
+ "build": "tsc --build",
42
+ "watch": "tsc --watch",
43
+ "clean": "rimraf --glob dist test/test-output coverage *.tsbuildinfo",
44
+ "format": "prettier --write '**/*.{js,json,ts,yaml,yml}' --ignore-path ../../.prettierignore",
45
+ "lint": "eslint . --ext .ts",
46
+ "lint:fix": "eslint . --ext .ts --fix",
47
+ "test": "jest --ci --forceExit --detectOpenHandles --colors --testPathPattern=test/unit",
48
+ "test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
49
+ "link": "pnpm link --global",
50
+ "unlink": "pnpm unlink --global"
51
+ }
52
+ }