@sap-ux/abap-deploy-config-writer 0.0.1
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 +201 -0
- package/README.md +47 -0
- package/dist/config.d.ts +21 -0
- package/dist/config.js +77 -0
- package/dist/constants.d.ts +12 -0
- package/dist/constants.js +15 -0
- package/dist/file.d.ts +27 -0
- package/dist/file.js +86 -0
- package/dist/index.d.ts +15 -0
- package/dist/index.js +73 -0
- package/dist/types.d.ts +5 -0
- package/dist/types.js +3 -0
- package/package.json +52 -0
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,47 @@
|
|
|
1
|
+
# @sap-ux/abap-deploy-config-writer
|
|
2
|
+
|
|
3
|
+
Easy to use ABAP deployment configuration writer for use within Yeoman generator and other prompting libraries.
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
## Installation
|
|
7
|
+
Npm
|
|
8
|
+
`npm install --save @sap-ux/abap-deploy-config-writer`
|
|
9
|
+
|
|
10
|
+
Yarn
|
|
11
|
+
`yarn add @sap-ux/abap-deploy-config-writer`
|
|
12
|
+
|
|
13
|
+
Pnpm
|
|
14
|
+
`pnpm add @sap-ux/abap-deploy-config-writer`
|
|
15
|
+
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
Calling the `generate` function
|
|
20
|
+
```javascript
|
|
21
|
+
import { generate } from '@sap-ux/abap-deploy-config-writer'
|
|
22
|
+
import { join } from 'path';
|
|
23
|
+
import type { AbapDeployConfig } from '@sap-ux/ui5-config';
|
|
24
|
+
|
|
25
|
+
const exampleWriter = async () => {
|
|
26
|
+
|
|
27
|
+
const abapDeployConfig: AbapDeployConfig[] = [
|
|
28
|
+
{
|
|
29
|
+
target: { url: 'https://example.com', client: '000', scp: false },
|
|
30
|
+
app: { name: 'testapp', package: 'TESTPKG12', description: 'Deployment description', transport: 'TR123' }
|
|
31
|
+
}
|
|
32
|
+
];
|
|
33
|
+
|
|
34
|
+
const projectDir = join(__dirname, 'testapp');
|
|
35
|
+
const fs = await generate(projectDir, abapDeployConfig);
|
|
36
|
+
return new Promise((resolve) => {
|
|
37
|
+
fs.commit(resolve); // When using with Yeoman it handle the fs commit.
|
|
38
|
+
});
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
// Calling the function
|
|
42
|
+
await exampleWriter();
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Keywords
|
|
47
|
+
SAP Reuse Library
|
package/dist/config.d.ts
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { UI5Config } from '@sap-ux/ui5-config';
|
|
2
|
+
import type { Editor } from 'mem-fs-editor';
|
|
3
|
+
import type { AbapDeployConfig } from '@sap-ux/ui5-config';
|
|
4
|
+
/**
|
|
5
|
+
* Updates the base config with the required custom tasks.
|
|
6
|
+
*
|
|
7
|
+
* @param isLib - whether the project is a library
|
|
8
|
+
* @param basePath - the base path
|
|
9
|
+
* @param baseConfig - the base config
|
|
10
|
+
* @param fs - the memfs editor instance
|
|
11
|
+
*/
|
|
12
|
+
export declare function updateBaseConfig(isLib: boolean, basePath: string, baseConfig: UI5Config, fs: Editor): void;
|
|
13
|
+
/**
|
|
14
|
+
* Returns the deployment config.
|
|
15
|
+
*
|
|
16
|
+
* @param config - the deploy config
|
|
17
|
+
* @param baseConfig - the base config
|
|
18
|
+
* @returns the deploy config
|
|
19
|
+
*/
|
|
20
|
+
export declare function getDeployConfig(config: AbapDeployConfig, baseConfig: UI5Config): Promise<UI5Config>;
|
|
21
|
+
//# sourceMappingURL=config.d.ts.map
|
package/dist/config.js
ADDED
|
@@ -0,0 +1,77 @@
|
|
|
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
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
exports.getDeployConfig = exports.updateBaseConfig = void 0;
|
|
13
|
+
const btp_utils_1 = require("@sap-ux/btp-utils");
|
|
14
|
+
const ui5_config_1 = require("@sap-ux/ui5-config");
|
|
15
|
+
const constants_1 = require("./constants");
|
|
16
|
+
/**
|
|
17
|
+
* Updates the base config with the required custom tasks.
|
|
18
|
+
*
|
|
19
|
+
* @param isLib - whether the project is a library
|
|
20
|
+
* @param basePath - the base path
|
|
21
|
+
* @param baseConfig - the base config
|
|
22
|
+
* @param fs - the memfs editor instance
|
|
23
|
+
*/
|
|
24
|
+
function updateBaseConfig(isLib, basePath, baseConfig, fs) {
|
|
25
|
+
if (isLib) {
|
|
26
|
+
const customTask = {
|
|
27
|
+
name: constants_1.UI5_TASK_FLATTEN_LIB,
|
|
28
|
+
afterTask: 'generateResourcesJson'
|
|
29
|
+
};
|
|
30
|
+
baseConfig.addCustomTasks([customTask]);
|
|
31
|
+
fs.write(basePath, baseConfig.toString());
|
|
32
|
+
baseConfig.removeConfig('builder');
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
exports.updateBaseConfig = updateBaseConfig;
|
|
36
|
+
/**
|
|
37
|
+
* Returns the deployment config.
|
|
38
|
+
*
|
|
39
|
+
* @param config - the deploy config
|
|
40
|
+
* @param baseConfig - the base config
|
|
41
|
+
* @returns the deploy config
|
|
42
|
+
*/
|
|
43
|
+
function getDeployConfig(config, baseConfig) {
|
|
44
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
45
|
+
const target = {};
|
|
46
|
+
if (config.target.destination !== undefined) {
|
|
47
|
+
target.destination = config.target.destination;
|
|
48
|
+
}
|
|
49
|
+
if (config.target.url !== undefined) {
|
|
50
|
+
target.url = config.target.url;
|
|
51
|
+
}
|
|
52
|
+
if (config.target.client) {
|
|
53
|
+
target.client = config.target.client;
|
|
54
|
+
}
|
|
55
|
+
if (config.target.scp) {
|
|
56
|
+
target.scp = true;
|
|
57
|
+
}
|
|
58
|
+
if (!(0, btp_utils_1.isAppStudio)()) {
|
|
59
|
+
const backendConfigs = baseConfig.getBackendConfigsFromFioriToolsProxydMiddleware();
|
|
60
|
+
for (const backend of backendConfigs) {
|
|
61
|
+
if (backend.authenticationType === 'reentranceTicket') {
|
|
62
|
+
target.authenticationType = 'reentranceTicket';
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
const baseUi5Doc = baseConfig.removeConfig('server');
|
|
67
|
+
const ui5DeployConfig = yield ui5_config_1.UI5Config.newInstance(baseUi5Doc.toString());
|
|
68
|
+
ui5DeployConfig.addComment({
|
|
69
|
+
comment: ' yaml-language-server: $schema=https://sap.github.io/ui5-tooling/schema/ui5.yaml.json',
|
|
70
|
+
location: 'beginning'
|
|
71
|
+
});
|
|
72
|
+
ui5DeployConfig.addAbapDeployTask(target, config.app, true, ['/test/'], config.index);
|
|
73
|
+
return ui5DeployConfig;
|
|
74
|
+
});
|
|
75
|
+
}
|
|
76
|
+
exports.getDeployConfig = getDeployConfig;
|
|
77
|
+
//# sourceMappingURL=config.js.map
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export declare const ABAP_DEPLOY_TASK = "deploy-to-abap";
|
|
2
|
+
export declare const BUILD_SCRIPT = "npm run build";
|
|
3
|
+
export declare const DEPLOY_SCRIPT = "fiori deploy";
|
|
4
|
+
export declare const UNDEPLOY_SCRIPT = "fiori undeploy";
|
|
5
|
+
export declare const RIMRAF_VERSION = "^5.0.5";
|
|
6
|
+
export declare const RIMRAF = "rimraf";
|
|
7
|
+
export declare const UI5_TASK_FLATTEN_LIB = "ui5-task-flatten-library";
|
|
8
|
+
export declare const UI5_TASK_FLATTEN_LIB_VERSION = "3.0.2";
|
|
9
|
+
export declare const UI5_REPO_TEXT_FILES = ".Ui5RepositoryTextFiles";
|
|
10
|
+
export declare const UI5_CLI_LIB = "@ui5/cli";
|
|
11
|
+
export declare const UI5_CLI_MIN_VERSION = "3.0.0";
|
|
12
|
+
//# sourceMappingURL=constants.d.ts.map
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.UI5_CLI_MIN_VERSION = exports.UI5_CLI_LIB = exports.UI5_REPO_TEXT_FILES = exports.UI5_TASK_FLATTEN_LIB_VERSION = exports.UI5_TASK_FLATTEN_LIB = exports.RIMRAF = exports.RIMRAF_VERSION = exports.UNDEPLOY_SCRIPT = exports.DEPLOY_SCRIPT = exports.BUILD_SCRIPT = exports.ABAP_DEPLOY_TASK = void 0;
|
|
4
|
+
exports.ABAP_DEPLOY_TASK = 'deploy-to-abap';
|
|
5
|
+
exports.BUILD_SCRIPT = 'npm run build';
|
|
6
|
+
exports.DEPLOY_SCRIPT = 'fiori deploy';
|
|
7
|
+
exports.UNDEPLOY_SCRIPT = 'fiori undeploy';
|
|
8
|
+
exports.RIMRAF_VERSION = '^5.0.5';
|
|
9
|
+
exports.RIMRAF = 'rimraf';
|
|
10
|
+
exports.UI5_TASK_FLATTEN_LIB = 'ui5-task-flatten-library';
|
|
11
|
+
exports.UI5_TASK_FLATTEN_LIB_VERSION = '3.0.2';
|
|
12
|
+
exports.UI5_REPO_TEXT_FILES = '.Ui5RepositoryTextFiles';
|
|
13
|
+
exports.UI5_CLI_LIB = '@ui5/cli';
|
|
14
|
+
exports.UI5_CLI_MIN_VERSION = '3.0.0';
|
|
15
|
+
//# sourceMappingURL=constants.js.map
|
package/dist/file.d.ts
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { Editor } from 'mem-fs-editor';
|
|
2
|
+
/**
|
|
3
|
+
* Adds a new UI5 dependency to the package.json.
|
|
4
|
+
* No longer required for `@ui5/cli` v3 and above.
|
|
5
|
+
*
|
|
6
|
+
* @param fs - the memfs editor instance
|
|
7
|
+
* @param basePath - the base path
|
|
8
|
+
* @param depName - the dependency name
|
|
9
|
+
*/
|
|
10
|
+
export declare function addUi5Dependency(fs: Editor, basePath: string, depName: string): void;
|
|
11
|
+
/**
|
|
12
|
+
* Writes the UI5 repository file.
|
|
13
|
+
*
|
|
14
|
+
* @param fs - the memfs editor instance
|
|
15
|
+
* @param basePath - the base path
|
|
16
|
+
* @param ui5RepositoryFile - the UI5 repository file
|
|
17
|
+
* @param addContent - the content to be added
|
|
18
|
+
*/
|
|
19
|
+
export declare const writeUi5RepositoryFile: (fs: Editor, basePath: string, ui5RepositoryFile: string, addContent: string) => void;
|
|
20
|
+
/**
|
|
21
|
+
* Writes the UI5 repository files if typescript files are found.
|
|
22
|
+
*
|
|
23
|
+
* @param fs - the memfs editor instance
|
|
24
|
+
* @param basePath - the base path
|
|
25
|
+
*/
|
|
26
|
+
export declare const writeUi5RepositoryFiles: (fs: Editor, basePath: string) => Promise<void>;
|
|
27
|
+
//# sourceMappingURL=file.d.ts.map
|
package/dist/file.js
ADDED
|
@@ -0,0 +1,86 @@
|
|
|
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.writeUi5RepositoryFiles = exports.writeUi5RepositoryFile = exports.addUi5Dependency = void 0;
|
|
16
|
+
const path_1 = require("path");
|
|
17
|
+
const fast_glob_1 = __importDefault(require("fast-glob"));
|
|
18
|
+
const os_1 = require("os");
|
|
19
|
+
const project_access_1 = require("@sap-ux/project-access");
|
|
20
|
+
const constants_1 = require("./constants");
|
|
21
|
+
const semver_1 = require("semver");
|
|
22
|
+
/**
|
|
23
|
+
* Adds a new UI5 dependency to the package.json.
|
|
24
|
+
* No longer required for `@ui5/cli` v3 and above.
|
|
25
|
+
*
|
|
26
|
+
* @param fs - the memfs editor instance
|
|
27
|
+
* @param basePath - the base path
|
|
28
|
+
* @param depName - the dependency name
|
|
29
|
+
*/
|
|
30
|
+
function addUi5Dependency(fs, basePath, depName) {
|
|
31
|
+
var _a, _b, _c, _d;
|
|
32
|
+
const filePath = (0, path_1.join)(basePath, project_access_1.FileName.Package);
|
|
33
|
+
const packageJson = ((_a = fs.readJSON(filePath)) !== null && _a !== void 0 ? _a : {});
|
|
34
|
+
const ui5CliVersion = (0, semver_1.coerce)((_b = packageJson === null || packageJson === void 0 ? void 0 : packageJson.devDependencies) === null || _b === void 0 ? void 0 : _b[constants_1.UI5_CLI_LIB]);
|
|
35
|
+
if (ui5CliVersion && (0, semver_1.satisfies)(ui5CliVersion, `>=${constants_1.UI5_CLI_MIN_VERSION}`)) {
|
|
36
|
+
// https://sap.github.io/ui5-tooling/v3/updates/migrate-v3/#changes-to-dependency-configuration
|
|
37
|
+
return;
|
|
38
|
+
}
|
|
39
|
+
packageJson.ui5 = (_c = packageJson.ui5) !== null && _c !== void 0 ? _c : {};
|
|
40
|
+
packageJson.ui5.dependencies = (_d = packageJson.ui5.dependencies) !== null && _d !== void 0 ? _d : [];
|
|
41
|
+
if (!packageJson.ui5.dependencies.includes(depName)) {
|
|
42
|
+
packageJson.ui5.dependencies.push(depName);
|
|
43
|
+
}
|
|
44
|
+
fs.writeJSON(filePath, packageJson);
|
|
45
|
+
}
|
|
46
|
+
exports.addUi5Dependency = addUi5Dependency;
|
|
47
|
+
/**
|
|
48
|
+
* Writes the UI5 repository file.
|
|
49
|
+
*
|
|
50
|
+
* @param fs - the memfs editor instance
|
|
51
|
+
* @param basePath - the base path
|
|
52
|
+
* @param ui5RepositoryFile - the UI5 repository file
|
|
53
|
+
* @param addContent - the content to be added
|
|
54
|
+
*/
|
|
55
|
+
const writeUi5RepositoryFile = (fs, basePath, ui5RepositoryFile, addContent) => {
|
|
56
|
+
const filePath = (0, path_1.join)(basePath, ui5RepositoryFile);
|
|
57
|
+
let content;
|
|
58
|
+
if (fs.exists(filePath)) {
|
|
59
|
+
content = fs.read(filePath);
|
|
60
|
+
if (!content.includes(addContent)) {
|
|
61
|
+
content = `${content}\n${addContent}`;
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
else {
|
|
65
|
+
content = addContent;
|
|
66
|
+
}
|
|
67
|
+
fs.write(filePath, content);
|
|
68
|
+
};
|
|
69
|
+
exports.writeUi5RepositoryFile = writeUi5RepositoryFile;
|
|
70
|
+
/**
|
|
71
|
+
* Writes the UI5 repository files if typescript files are found.
|
|
72
|
+
*
|
|
73
|
+
* @param fs - the memfs editor instance
|
|
74
|
+
* @param basePath - the base path
|
|
75
|
+
*/
|
|
76
|
+
const writeUi5RepositoryFiles = (fs, basePath) => __awaiter(void 0, void 0, void 0, function* () {
|
|
77
|
+
const webappPath = yield (0, project_access_1.getWebappPath)(basePath);
|
|
78
|
+
const typescriptPattern = (0, path_1.join)(webappPath, '/**/*.ts');
|
|
79
|
+
const normalisedPath = (0, os_1.platform)() === 'win32' ? typescriptPattern.replace(/\\/g, '/') : typescriptPattern;
|
|
80
|
+
const typeScriptFilesPaths = yield (0, fast_glob_1.default)(normalisedPath);
|
|
81
|
+
if ((typeScriptFilesPaths === null || typeScriptFilesPaths === void 0 ? void 0 : typeScriptFilesPaths.length) > 0) {
|
|
82
|
+
(0, exports.writeUi5RepositoryFile)(fs, webappPath, constants_1.UI5_REPO_TEXT_FILES, '^.*.ts$');
|
|
83
|
+
}
|
|
84
|
+
});
|
|
85
|
+
exports.writeUi5RepositoryFiles = writeUi5RepositoryFiles;
|
|
86
|
+
//# sourceMappingURL=file.js.map
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { DeployConfigOptions } from './types';
|
|
2
|
+
import type { Editor } from 'mem-fs-editor';
|
|
3
|
+
import type { AbapDeployConfig } from '@sap-ux/ui5-config';
|
|
4
|
+
/**
|
|
5
|
+
* Writes the template to the memfs editor instance.
|
|
6
|
+
*
|
|
7
|
+
* @param basePath - the base path
|
|
8
|
+
* @param abapDeployConfig - the abap deploy config
|
|
9
|
+
* @param options - the deploy config options
|
|
10
|
+
* @param fs - the memfs editor instance
|
|
11
|
+
* @returns the updated memfs editor instance
|
|
12
|
+
*/
|
|
13
|
+
declare function generate(basePath: string, abapDeployConfig: AbapDeployConfig, options?: DeployConfigOptions, fs?: Editor): Promise<Editor>;
|
|
14
|
+
export { generate };
|
|
15
|
+
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
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.generate = void 0;
|
|
16
|
+
const path_1 = require("path");
|
|
17
|
+
const mem_fs_1 = require("mem-fs");
|
|
18
|
+
const mem_fs_editor_1 = require("mem-fs-editor");
|
|
19
|
+
const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
|
|
20
|
+
const project_access_1 = require("@sap-ux/project-access");
|
|
21
|
+
const config_1 = require("./config");
|
|
22
|
+
const file_1 = require("./file");
|
|
23
|
+
const constants_1 = require("./constants");
|
|
24
|
+
/**
|
|
25
|
+
* Writes the template to the memfs editor instance.
|
|
26
|
+
*
|
|
27
|
+
* @param basePath - the base path
|
|
28
|
+
* @param abapDeployConfig - the abap deploy config
|
|
29
|
+
* @param options - the deploy config options
|
|
30
|
+
* @param fs - the memfs editor instance
|
|
31
|
+
* @returns the updated memfs editor instance
|
|
32
|
+
*/
|
|
33
|
+
function generate(basePath, abapDeployConfig, options, fs) {
|
|
34
|
+
var _a, _b;
|
|
35
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
36
|
+
const abapConfig = (0, cloneDeep_1.default)(abapDeployConfig);
|
|
37
|
+
if (!fs) {
|
|
38
|
+
fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
|
|
39
|
+
}
|
|
40
|
+
// base config
|
|
41
|
+
const baseConfigFile = (_a = options === null || options === void 0 ? void 0 : options.baseFile) !== null && _a !== void 0 ? _a : project_access_1.FileName.Ui5Yaml;
|
|
42
|
+
const baseConfig = yield (0, project_access_1.readUi5Yaml)(basePath, baseConfigFile, fs);
|
|
43
|
+
const isLib = baseConfig.getType() === 'library';
|
|
44
|
+
const baseConfigPath = (0, path_1.join)(basePath, baseConfigFile);
|
|
45
|
+
(0, config_1.updateBaseConfig)(isLib, baseConfigPath, baseConfig, fs);
|
|
46
|
+
// deploy config
|
|
47
|
+
const deployConfigFile = (_b = options === null || options === void 0 ? void 0 : options.deployFile) !== null && _b !== void 0 ? _b : project_access_1.FileName.UI5DeployYaml;
|
|
48
|
+
const deployFilePath = (0, path_1.join)(basePath, deployConfigFile);
|
|
49
|
+
const deployConfig = yield (0, config_1.getDeployConfig)(abapConfig, baseConfig);
|
|
50
|
+
fs.write(deployFilePath, deployConfig.toString());
|
|
51
|
+
// package.json
|
|
52
|
+
// deploy script
|
|
53
|
+
const deployScript = `${constants_1.BUILD_SCRIPT} && ${constants_1.DEPLOY_SCRIPT} --config ${deployConfigFile} && ${constants_1.RIMRAF} archive.zip`;
|
|
54
|
+
yield (0, project_access_1.updatePackageScript)(basePath, 'deploy', deployScript, fs);
|
|
55
|
+
// undeploy script
|
|
56
|
+
const undeployScript = `${constants_1.BUILD_SCRIPT} && ${constants_1.UNDEPLOY_SCRIPT} --config ${deployConfigFile}`;
|
|
57
|
+
yield (0, project_access_1.updatePackageScript)(basePath, 'undeploy', undeployScript, fs);
|
|
58
|
+
// test mode script
|
|
59
|
+
const deployTestModeScript = `${constants_1.BUILD_SCRIPT} && ${constants_1.DEPLOY_SCRIPT} --config ${deployConfigFile} --testMode true`;
|
|
60
|
+
yield (0, project_access_1.updatePackageScript)(basePath, 'deploy-test', deployTestModeScript, fs);
|
|
61
|
+
// dependencies
|
|
62
|
+
yield (0, project_access_1.addPackageDevDependency)(basePath, constants_1.RIMRAF, constants_1.RIMRAF_VERSION, fs);
|
|
63
|
+
if (isLib) {
|
|
64
|
+
yield (0, project_access_1.addPackageDevDependency)(basePath, constants_1.UI5_TASK_FLATTEN_LIB, constants_1.UI5_TASK_FLATTEN_LIB_VERSION, fs);
|
|
65
|
+
(0, file_1.addUi5Dependency)(fs, basePath, constants_1.UI5_TASK_FLATTEN_LIB);
|
|
66
|
+
}
|
|
67
|
+
// ui5 repo files
|
|
68
|
+
yield (0, file_1.writeUi5RepositoryFiles)(fs, basePath);
|
|
69
|
+
return fs;
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
exports.generate = generate;
|
|
73
|
+
//# sourceMappingURL=index.js.map
|
package/dist/types.d.ts
ADDED
package/dist/types.js
ADDED
package/package.json
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@sap-ux/abap-deploy-config-writer",
|
|
3
|
+
"description": "Writer module to add abap deployment configuration to an existing Fiori application",
|
|
4
|
+
"repository": {
|
|
5
|
+
"type": "git",
|
|
6
|
+
"url": "https://github.com/SAP/open-ux-tools.git",
|
|
7
|
+
"directory": "packages/abap-deploy-config-writer"
|
|
8
|
+
},
|
|
9
|
+
"version": "0.0.1",
|
|
10
|
+
"license": "Apache-2.0",
|
|
11
|
+
"main": "dist/index.js",
|
|
12
|
+
"files": [
|
|
13
|
+
"LICENSE",
|
|
14
|
+
"dist",
|
|
15
|
+
"!dist/*.map",
|
|
16
|
+
"!dist/**/*.map"
|
|
17
|
+
],
|
|
18
|
+
"engines": {
|
|
19
|
+
"node": ">=18.x"
|
|
20
|
+
},
|
|
21
|
+
"dependencies": {
|
|
22
|
+
"fast-glob": "3.3.1",
|
|
23
|
+
"lodash": "4.17.21",
|
|
24
|
+
"mem-fs": "2.1.0",
|
|
25
|
+
"mem-fs-editor": "9.4.0",
|
|
26
|
+
"semver": "7.5.4",
|
|
27
|
+
"@sap-ux/btp-utils": "0.14.4",
|
|
28
|
+
"@sap-ux/project-access": "1.22.2",
|
|
29
|
+
"@sap-ux/system-access": "0.4.2",
|
|
30
|
+
"@sap-ux/ui5-config": "0.22.9"
|
|
31
|
+
},
|
|
32
|
+
"devDependencies": {
|
|
33
|
+
"@types/fs-extra": "9.0.13",
|
|
34
|
+
"@types/lodash": "4.14.202",
|
|
35
|
+
"@types/mem-fs-editor": "7.0.1",
|
|
36
|
+
"@types/mem-fs": "1.1.2",
|
|
37
|
+
"@types/semver": "7.5.2",
|
|
38
|
+
"fs-extra": "10.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",
|
|
48
|
+
"test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
|
|
49
|
+
"link": "pnpm link --global",
|
|
50
|
+
"unlink": "pnpm unlink --global"
|
|
51
|
+
}
|
|
52
|
+
}
|