@sap-ux/ui5-library-reference-inquirer 0.2.10

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,60 @@
1
+ # @sap-ux/ui5-library-reference-inquirer
2
+
3
+ Provides Inquirer based prompting to allow input and validation of data required to generate a UI5 library
4
+
5
+
6
+ ## Installation
7
+ Npm
8
+ `npm install --save @sap-ux/ui5-library-reference-inquirer`
9
+
10
+ Yarn
11
+ `yarn add @sap-ux/ui5-library-reference-inquirer`
12
+
13
+ Pnpm
14
+ `pnpm add @sap-ux/ui5-library-reference-inquirer`
15
+
16
+ ## Usage
17
+
18
+ Example with Yeoman generator no options, e.g. cli prompting only :
19
+
20
+ ```javascript
21
+ import Generator from 'yeoman-generator';
22
+ import { generate, type ReuseLibConfig } from '@sap-ux/ui5-library-reference-writer'
23
+ import { prompt, type UI5LibraryReferenceAnswers } from '@sap-ux/ui5-library-reference-inquirer';
24
+
25
+ export default class UI5LibraryReferenceGenerator extends Generator {
26
+ answers: UI5LibraryReferenceAnswers = {};
27
+
28
+ constructor(args: string | string[], opts: Generator.GeneratorOptions) {
29
+ super(args, opts);
30
+ }
31
+
32
+ public async prompting(): Promise<void> {
33
+ const answers = await prompt();
34
+ Object.assign(this.answers, answers);
35
+ }
36
+
37
+ public async writing(): Promise<void> {
38
+ const reuseLibConfigs: ReuseLibConfig[] = [];
39
+ if (answers.referenceLibraries) {
40
+ for (const lib of answers.referenceLibraries) {
41
+ reuseLibConfigs.push({
42
+ name: lib.name,
43
+ path: lib.path,
44
+ type: lib.type,
45
+ uri: lib.uri
46
+ });
47
+ }
48
+ }
49
+
50
+ try {
51
+ await generate(this.answers.targetFolder, reuseLibConfigs);
52
+ } catch (e) {}
53
+ }
54
+ }
55
+ ```
56
+
57
+ ## Keywords
58
+ SAP Fiori Elements
59
+ Yeoman
60
+ Generator
@@ -0,0 +1,18 @@
1
+ import type { AllAppResults, ReuseLib } from '@sap-ux/project-access';
2
+ import type { ListChoiceOptions } from 'inquirer';
3
+ import type { ReuseLibChoice } from './types';
4
+ /**
5
+ * Creates the project choice options.
6
+ *
7
+ * @param apps array of applications found in the workspace folders.
8
+ * @returns list of projects
9
+ */
10
+ export declare const getProjectChoices: (apps?: AllAppResults[]) => Promise<ListChoiceOptions[]>;
11
+ /**
12
+ * Creates the library choice options.
13
+ *
14
+ * @param libs - array of libraries found in the workspace folders.
15
+ * @returns list of libraries
16
+ */
17
+ export declare const getLibraryChoices: (libs?: ReuseLib[]) => Promise<ReuseLibChoice[]>;
18
+ //# sourceMappingURL=choices.d.ts.map
@@ -0,0 +1,48 @@
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.getLibraryChoices = exports.getProjectChoices = void 0;
13
+ const path_1 = require("path");
14
+ /**
15
+ * Creates the project choice options.
16
+ *
17
+ * @param apps array of applications found in the workspace folders.
18
+ * @returns list of projects
19
+ */
20
+ const getProjectChoices = (apps) => __awaiter(void 0, void 0, void 0, function* () {
21
+ const projectChoices = [];
22
+ if (apps) {
23
+ for (const app of apps) {
24
+ const name = (0, path_1.basename)(app.appRoot);
25
+ projectChoices.push({ name, value: { folderName: name, path: app.appRoot } });
26
+ }
27
+ }
28
+ return projectChoices;
29
+ });
30
+ exports.getProjectChoices = getProjectChoices;
31
+ /**
32
+ * Creates the library choice options.
33
+ *
34
+ * @param libs - array of libraries found in the workspace folders.
35
+ * @returns list of libraries
36
+ */
37
+ const getLibraryChoices = (libs) => __awaiter(void 0, void 0, void 0, function* () {
38
+ const libraryChoices = [];
39
+ if (libs) {
40
+ for (const lib of libs) {
41
+ const libName = [lib.name, lib.type, lib.description].filter(Boolean).join(' - ');
42
+ libraryChoices.push({ name: libName, value: lib });
43
+ }
44
+ }
45
+ return libraryChoices;
46
+ });
47
+ exports.getLibraryChoices = getLibraryChoices;
48
+ //# sourceMappingURL=choices.js.map
package/dist/i18n.d.ts ADDED
@@ -0,0 +1,14 @@
1
+ import type { TOptions } from 'i18next';
2
+ /**
3
+ * Initialize i18next with the translations for this module.
4
+ */
5
+ export declare function initI18n(): Promise<void>;
6
+ /**
7
+ * Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.
8
+ *
9
+ * @param key i18n key
10
+ * @param options additional options
11
+ * @returns {string} localized string stored for the given key
12
+ */
13
+ export declare function t(key: string, options?: TOptions): string;
14
+ //# sourceMappingURL=i18n.d.ts.map
package/dist/i18n.js ADDED
@@ -0,0 +1,45 @@
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.t = exports.initI18n = void 0;
16
+ const i18next_1 = __importDefault(require("i18next"));
17
+ const ui5_library_reference_inquirer_i18n_json_1 = __importDefault(require("./translations/ui5-library-reference-inquirer.i18n.json"));
18
+ const ui5LibI18nNamespace = 'ui5-library-reference-inquirer';
19
+ /**
20
+ * Initialize i18next with the translations for this module.
21
+ */
22
+ function initI18n() {
23
+ return __awaiter(this, void 0, void 0, function* () {
24
+ yield i18next_1.default.init({ lng: 'en', fallbackLng: 'en' }, () => i18next_1.default.addResourceBundle('en', ui5LibI18nNamespace, ui5_library_reference_inquirer_i18n_json_1.default));
25
+ });
26
+ }
27
+ exports.initI18n = initI18n;
28
+ /**
29
+ * Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.
30
+ *
31
+ * @param key i18n key
32
+ * @param options additional options
33
+ * @returns {string} localized string stored for the given key
34
+ */
35
+ function t(key, options) {
36
+ if (!(options === null || options === void 0 ? void 0 : options.ns)) {
37
+ options = Object.assign(options !== null && options !== void 0 ? options : {}, { ns: ui5LibI18nNamespace });
38
+ }
39
+ return i18next_1.default.t(key, options);
40
+ }
41
+ exports.t = t;
42
+ initI18n().catch(() => {
43
+ // Needed for lint
44
+ });
45
+ //# sourceMappingURL=i18n.js.map
@@ -0,0 +1,23 @@
1
+ import { type InquirerAdapter } from '@sap-ux/inquirer-common';
2
+ import { type Question } from 'inquirer';
3
+ import type { UI5LibraryReferenceAnswers, UI5LibraryReferencePromptOptions } from './types';
4
+ import { type WorkspaceFolder } from '@sap-ux/project-access';
5
+ /**
6
+ * Get the inquirer prompts for ui5 library inquirer.
7
+ *
8
+ * @param wsFolders - workspace folders to search for fiori artifacts
9
+ * @param promptOptions - options that can control some of the prompt behaviour
10
+ * @returns the prompts used to provide input for ui5 library generation
11
+ */
12
+ declare function getPrompts(wsFolders: readonly WorkspaceFolder[] | string[], promptOptions?: UI5LibraryReferencePromptOptions): Promise<Question<UI5LibraryReferenceAnswers>[]>;
13
+ /**
14
+ * Prompt for ui5 library generation inputs.
15
+ *
16
+ * @param wsFolders - workspace folders to search for fiori artifacts
17
+ * @param adapter - optionally provide references to a calling inquirer instance, this supports integration to Yeoman generators, for example
18
+ * @param promptOptions - options that can control some of the prompt behaviour
19
+ * @returns the prompt answers
20
+ */
21
+ declare function prompt(wsFolders?: readonly WorkspaceFolder[] | string[], adapter?: InquirerAdapter, promptOptions?: UI5LibraryReferencePromptOptions): Promise<UI5LibraryReferenceAnswers>;
22
+ export { getPrompts, prompt, type UI5LibraryReferencePromptOptions, type UI5LibraryReferenceAnswers, type InquirerAdapter };
23
+ //# sourceMappingURL=index.d.ts.map
package/dist/index.js ADDED
@@ -0,0 +1,56 @@
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.prompt = exports.getPrompts = void 0;
16
+ const inquirer_1 = __importDefault(require("inquirer"));
17
+ const prompts_1 = require("./prompts");
18
+ const project_access_1 = require("@sap-ux/project-access");
19
+ const choices_1 = require("./choices");
20
+ /**
21
+ * Get the inquirer prompts for ui5 library inquirer.
22
+ *
23
+ * @param wsFolders - workspace folders to search for fiori artifacts
24
+ * @param promptOptions - options that can control some of the prompt behaviour
25
+ * @returns the prompts used to provide input for ui5 library generation
26
+ */
27
+ function getPrompts(wsFolders, promptOptions) {
28
+ return __awaiter(this, void 0, void 0, function* () {
29
+ const options = {
30
+ wsFolders: wsFolders,
31
+ artifacts: ['applications', 'libraries']
32
+ };
33
+ const fioriArtifacts = yield (0, project_access_1.findFioriArtifacts)(options);
34
+ const reuseLibs = yield (0, project_access_1.getReuseLibs)(fioriArtifacts === null || fioriArtifacts === void 0 ? void 0 : fioriArtifacts.libraries);
35
+ const projectChoices = yield (0, choices_1.getProjectChoices)(fioriArtifacts === null || fioriArtifacts === void 0 ? void 0 : fioriArtifacts.applications);
36
+ const libraryChoices = yield (0, choices_1.getLibraryChoices)(reuseLibs);
37
+ return (0, prompts_1.getQuestions)(projectChoices, libraryChoices, promptOptions);
38
+ });
39
+ }
40
+ exports.getPrompts = getPrompts;
41
+ /**
42
+ * Prompt for ui5 library generation inputs.
43
+ *
44
+ * @param wsFolders - workspace folders to search for fiori artifacts
45
+ * @param adapter - optionally provide references to a calling inquirer instance, this supports integration to Yeoman generators, for example
46
+ * @param promptOptions - options that can control some of the prompt behaviour
47
+ * @returns the prompt answers
48
+ */
49
+ function prompt(wsFolders, adapter, promptOptions) {
50
+ return __awaiter(this, void 0, void 0, function* () {
51
+ const ui5LibPrompts = yield exports.getPrompts(promptOptions, wsFolders);
52
+ return adapter ? adapter.prompt(ui5LibPrompts) : inquirer_1.default.prompt(ui5LibPrompts);
53
+ });
54
+ }
55
+ exports.prompt = prompt;
56
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1,4 @@
1
+ export declare enum SourceType {
2
+ Workspace = "Workspace"
3
+ }
4
+ //# sourceMappingURL=constants.d.ts.map
@@ -0,0 +1,8 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.SourceType = void 0;
4
+ var SourceType;
5
+ (function (SourceType) {
6
+ SourceType["Workspace"] = "Workspace";
7
+ })(SourceType || (exports.SourceType = SourceType = {}));
8
+ //# sourceMappingURL=constants.js.map
@@ -0,0 +1,19 @@
1
+ import type { promptNames, UI5LibraryReferencePromptOptions, UI5LibraryReferenceQuestion } from '../types';
2
+ /**
3
+ * Will remove prompts from the specified prompts based on prompt options
4
+ * Removing prompts is preferable to using `when()` to prevent continuous re-evaluation.
5
+ *
6
+ * @param prompts Keyed prompts object containing all possible prompts
7
+ * @param promptOptions prompt options
8
+ * @returns the updated questions
9
+ */
10
+ export declare function hidePrompts(prompts: Record<promptNames, UI5LibraryReferenceQuestion>, promptOptions?: UI5LibraryReferencePromptOptions): UI5LibraryReferenceQuestion[];
11
+ /**
12
+ * Updates questions with extensions for specific properties. Only `validate`, `default` and `additionalMessages` are currently supported.
13
+ *
14
+ * @param questions - array of prompts to be extended
15
+ * @param promptOptions - the prompt options possibly containing function extensions
16
+ * @returns - the extended questions
17
+ */
18
+ export declare function extendWithOptions(questions: UI5LibraryReferenceQuestion[], promptOptions: UI5LibraryReferencePromptOptions): UI5LibraryReferenceQuestion[];
19
+ //# sourceMappingURL=helpers.d.ts.map
@@ -0,0 +1,89 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.extendWithOptions = exports.hidePrompts = void 0;
4
+ const inquirer_common_1 = require("@sap-ux/inquirer-common");
5
+ /**
6
+ * Will remove prompts from the specified prompts based on prompt options
7
+ * Removing prompts is preferable to using `when()` to prevent continuous re-evaluation.
8
+ *
9
+ * @param prompts Keyed prompts object containing all possible prompts
10
+ * @param promptOptions prompt options
11
+ * @returns the updated questions
12
+ */
13
+ function hidePrompts(prompts, promptOptions) {
14
+ const questions = [];
15
+ if (promptOptions) {
16
+ Object.keys(prompts).forEach((key) => {
17
+ var _a;
18
+ const promptKey = key;
19
+ if (!((_a = promptOptions === null || promptOptions === void 0 ? void 0 : promptOptions[promptKey]) === null || _a === void 0 ? void 0 : _a.hide)) {
20
+ questions.push(prompts[promptKey]);
21
+ }
22
+ });
23
+ }
24
+ else {
25
+ questions.push(...Object.values(prompts));
26
+ }
27
+ return questions;
28
+ }
29
+ exports.hidePrompts = hidePrompts;
30
+ /**
31
+ * Extends a validate function.
32
+ *
33
+ * @param question - the question to which the validate function will be applied
34
+ * @param validateFunc - the validate function which will be applied to the question
35
+ * @returns the extended validate function
36
+ */
37
+ function extendValidate(question, validateFunc) {
38
+ const validate = question.validate;
39
+ return (value, previousAnswers) => {
40
+ const extVal = validateFunc(value, previousAnswers);
41
+ if (extVal !== true) {
42
+ return extVal;
43
+ }
44
+ return typeof validate === 'function' ? validate(value, previousAnswers) : true;
45
+ };
46
+ }
47
+ /**
48
+ * Extend the existing prompt property function with the one specified in prompt options or add as new.
49
+ *
50
+ * @param question - the question to which the extending function will be applied
51
+ * @param promptOption - prompt options, containing extending functions
52
+ * @param funcName - the question property (function) name to extend
53
+ * @returns the extended question
54
+ */
55
+ function applyExtensionFunction(question, promptOption, funcName) {
56
+ let extendedFunc;
57
+ if (funcName === 'validate' && promptOption.validate) {
58
+ extendedFunc = extendValidate(question, promptOption.validate);
59
+ }
60
+ if (funcName === 'additionalMessages' && promptOption.additionalMessages) {
61
+ extendedFunc = (0, inquirer_common_1.extendAdditionalMessages)(question, promptOption.additionalMessages);
62
+ }
63
+ question = Object.assign(question, { [funcName]: extendedFunc });
64
+ return question;
65
+ }
66
+ /**
67
+ * Updates questions with extensions for specific properties. Only `validate`, `default` and `additionalMessages` are currently supported.
68
+ *
69
+ * @param questions - array of prompts to be extended
70
+ * @param promptOptions - the prompt options possibly containing function extensions
71
+ * @returns - the extended questions
72
+ */
73
+ function extendWithOptions(questions, promptOptions) {
74
+ questions.forEach((question) => {
75
+ const promptOptKey = question.name;
76
+ const promptOpt = promptOptions[promptOptKey];
77
+ if (promptOpt) {
78
+ const propsToExtend = Object.keys(promptOpt);
79
+ for (const extProp of propsToExtend) {
80
+ if (extProp === 'validate' || extProp === 'additionalMessages') {
81
+ question = applyExtensionFunction(question, promptOpt, extProp);
82
+ }
83
+ }
84
+ }
85
+ });
86
+ return questions;
87
+ }
88
+ exports.extendWithOptions = extendWithOptions;
89
+ //# sourceMappingURL=helpers.js.map
@@ -0,0 +1,2 @@
1
+ export * from './prompts';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1,18 @@
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("./prompts"), exports);
18
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1,12 @@
1
+ import type { ListChoiceOptions } from 'inquirer';
2
+ import { type UI5LibraryReferenceQuestion, type ReuseLibChoice, type UI5LibraryReferencePromptOptions } from '../types';
3
+ /**
4
+ * Get the prompts for the UI5 library reference writing.
5
+ *
6
+ * @param projectChoices - workspace projects
7
+ * @param reuseLibs - reuse libraries
8
+ * @param promptOptions - optional inputs used to pre-populate some prompt choices, default values and other prompting options
9
+ * @returns the prompts
10
+ */
11
+ export declare function getQuestions(projectChoices?: ListChoiceOptions[], reuseLibs?: ReuseLibChoice[], promptOptions?: UI5LibraryReferencePromptOptions): UI5LibraryReferenceQuestion[];
12
+ //# sourceMappingURL=prompts.d.ts.map
@@ -0,0 +1,105 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getQuestions = void 0;
4
+ const i18n_1 = require("../i18n");
5
+ const project_access_1 = require("@sap-ux/project-access");
6
+ const types_1 = require("../types");
7
+ const helpers_1 = require("./helpers");
8
+ const constants_1 = require("./constants");
9
+ /**
10
+ * Get the prompts for the UI5 library reference writing.
11
+ *
12
+ * @param projectChoices - workspace projects
13
+ * @param reuseLibs - reuse libraries
14
+ * @param promptOptions - optional inputs used to pre-populate some prompt choices, default values and other prompting options
15
+ * @returns the prompts
16
+ */
17
+ function getQuestions(projectChoices, reuseLibs, promptOptions) {
18
+ const keyedPrompts = {
19
+ [types_1.promptNames.targetProjectFolder]: getTargetProjectFolderPrompt(projectChoices),
20
+ [types_1.promptNames.source]: getSourcePrompt(),
21
+ [types_1.promptNames.referenceLibraries]: getReferenceLibrariesPrompt(reuseLibs)
22
+ };
23
+ // Hide not applicable prompts based on passed options
24
+ let questions = (0, helpers_1.hidePrompts)(keyedPrompts, promptOptions);
25
+ // Apply extended `validate`, `additionalMessages` or override `default` prompt properties
26
+ if (promptOptions) {
27
+ questions = (0, helpers_1.extendWithOptions)(questions, promptOptions);
28
+ }
29
+ return questions;
30
+ }
31
+ exports.getQuestions = getQuestions;
32
+ /**
33
+ * Get the target project folder prompt.
34
+ *
35
+ * @param projectChoices workspace projects
36
+ * @returns The `targetProjectFolder` prompt
37
+ */
38
+ function getTargetProjectFolderPrompt(projectChoices) {
39
+ return {
40
+ type: 'list',
41
+ guiOptions: {
42
+ breadcrumb: true
43
+ },
44
+ name: types_1.promptNames.targetProjectFolder,
45
+ message: (0, i18n_1.t)('prompts.targetProjectFolderLabel'),
46
+ choices: () => projectChoices,
47
+ default: () => {
48
+ return (projectChoices === null || projectChoices === void 0 ? void 0 : projectChoices.length) ? 0 : undefined;
49
+ },
50
+ validate: () => {
51
+ return !(projectChoices === null || projectChoices === void 0 ? void 0 : projectChoices.length) ? (0, i18n_1.t)('error.noProjectsFound') : true;
52
+ }
53
+ };
54
+ }
55
+ /**
56
+ * Get the source prompt.
57
+ *
58
+ * @returns The `source` prompt
59
+ */
60
+ function getSourcePrompt() {
61
+ return {
62
+ type: 'list',
63
+ guiOptions: {
64
+ breadcrumb: true
65
+ },
66
+ name: types_1.promptNames.source,
67
+ message: (0, i18n_1.t)('prompts.sourceLabel'),
68
+ choices: [{ name: (0, i18n_1.t)('LABEL_WORKSPACE'), value: constants_1.SourceType.Workspace }],
69
+ default: 0
70
+ };
71
+ }
72
+ /**
73
+ * Get the reference libraries prompt.
74
+ *
75
+ * @param reuseLibs reuse libraries
76
+ * @returns The `referenceLibraries` prompt
77
+ */
78
+ function getReferenceLibrariesPrompt(reuseLibs) {
79
+ let missingDeps;
80
+ return {
81
+ type: 'checkbox',
82
+ name: types_1.promptNames.referenceLibraries,
83
+ message: (0, i18n_1.t)('prompts.referenceLibrariesLabel'),
84
+ guiOptions: {
85
+ breadcrumb: true
86
+ },
87
+ choices: () => reuseLibs,
88
+ additionalMessages: () => {
89
+ return missingDeps ? (0, i18n_1.t)('STATUS_MISSING_DEPS', { dependencies: missingDeps }) : undefined;
90
+ },
91
+ validate: (answer) => {
92
+ if (!(reuseLibs === null || reuseLibs === void 0 ? void 0 : reuseLibs.length)) {
93
+ return (0, i18n_1.t)('ERROR_NO_LIBS_FOUND');
94
+ }
95
+ else if ((answer === null || answer === void 0 ? void 0 : answer.length) < 1) {
96
+ return (0, i18n_1.t)('ERROR_NO_LIB_SELECTED');
97
+ }
98
+ else if (answer === null || answer === void 0 ? void 0 : answer.length) {
99
+ missingDeps = (0, project_access_1.checkDependencies)(answer, reuseLibs.map((libs) => libs.value));
100
+ }
101
+ return true;
102
+ }
103
+ };
104
+ }
105
+ //# sourceMappingURL=prompts.js.map
@@ -0,0 +1,12 @@
1
+ {
2
+ "prompts": {
3
+ "targetProjectFolderLabel": "Project folder path",
4
+ "sourceLabel": "Reusable Library Source",
5
+ "referenceLibrariesLabel": "Select Reusable Libraries"
6
+ },
7
+ "error": {
8
+ "noProjectsFound": "No Fiori tools projects found in the workspace",
9
+ "noLibsFound": "No reuse libraries or components found in the workspace",
10
+ "noLibSelected": "You must select at least one reuse library or component"
11
+ }
12
+ }
@@ -0,0 +1,55 @@
1
+ import type { PromptSeverityMessage, validate, YUIQuestion } from '@sap-ux/inquirer-common';
2
+ import type { ReuseLib } from '@sap-ux/project-access';
3
+ import type { ListChoiceOptions } from 'inquirer';
4
+ /**
5
+ * Enumeration of prompt names used by UI5LibraryReferencePromptOptions
6
+ *
7
+ */
8
+ export declare enum promptNames {
9
+ /**
10
+ * Target project folder
11
+ */
12
+ targetProjectFolder = "targetProjectFolder",
13
+ /**
14
+ * Source of reuse libraries
15
+ */
16
+ source = "source",
17
+ /**
18
+ * Libraries to reference
19
+ */
20
+ referenceLibraries = "referenceLibraries"
21
+ }
22
+ type stringValuePromptType = typeof promptNames;
23
+ type stringValuePrompts = stringValuePromptType[keyof stringValuePromptType];
24
+ /**
25
+ * Defines prompt/question default values and/or whether or not they should be shown.
26
+ */
27
+ export type CommonPromptOptions = {
28
+ hide?: boolean;
29
+ validate?: validate<UI5LibraryReferenceAnswers>;
30
+ additionalMessages?: PromptSeverityMessage;
31
+ };
32
+ /**
33
+ * Provide the correct type checking for string value prompts and `ui5Version` options
34
+ *
35
+ */
36
+ type stringValuePromptOptions = Record<stringValuePrompts, CommonPromptOptions>;
37
+ /**
38
+ * Answers for the UI5 Library Reference
39
+ */
40
+ export interface UI5LibraryReferenceAnswers {
41
+ targetProjectFolder?: string;
42
+ source?: string;
43
+ referenceLibraries?: ReuseLib[];
44
+ }
45
+ export type UI5LibraryReferenceQuestion = YUIQuestion<UI5LibraryReferenceAnswers>;
46
+ export type UI5LibraryReferencePromptOptions = Partial<stringValuePromptOptions>;
47
+ /**
48
+ * Choice for the reuse library
49
+ */
50
+ export interface ReuseLibChoice extends ListChoiceOptions {
51
+ name: string;
52
+ value: ReuseLib;
53
+ }
54
+ export {};
55
+ //# sourceMappingURL=types.d.ts.map
package/dist/types.js ADDED
@@ -0,0 +1,23 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.promptNames = void 0;
4
+ /**
5
+ * Enumeration of prompt names used by UI5LibraryReferencePromptOptions
6
+ *
7
+ */
8
+ var promptNames;
9
+ (function (promptNames) {
10
+ /**
11
+ * Target project folder
12
+ */
13
+ promptNames["targetProjectFolder"] = "targetProjectFolder";
14
+ /**
15
+ * Source of reuse libraries
16
+ */
17
+ promptNames["source"] = "source";
18
+ /**
19
+ * Libraries to reference
20
+ */
21
+ promptNames["referenceLibraries"] = "referenceLibraries";
22
+ })(promptNames || (exports.promptNames = promptNames = {}));
23
+ //# sourceMappingURL=types.js.map
package/package.json ADDED
@@ -0,0 +1,44 @@
1
+ {
2
+ "name": "@sap-ux/ui5-library-reference-inquirer",
3
+ "description": "Prompts module that can provide prompts for UI5 library writer",
4
+ "version": "0.2.10",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "https://github.com/SAP/open-ux-tools.git",
8
+ "directory": "packages/ui5-library-reference-inquirer"
9
+ },
10
+ "bugs": {
11
+ "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Aui5-library-reference-inquirer"
12
+ },
13
+ "license": "Apache-2.0",
14
+ "main": "dist/index.js",
15
+ "files": [
16
+ "LICENSE",
17
+ "dist",
18
+ "!dist/*.map",
19
+ "!dist/**/*.map"
20
+ ],
21
+ "dependencies": {
22
+ "i18next": "23.5.1",
23
+ "@sap-ux/inquirer-common": "0.2.4",
24
+ "@sap-ux/project-access": "1.19.7"
25
+ },
26
+ "devDependencies": {
27
+ "inquirer": "8.2.6",
28
+ "@types/inquirer": "8.2.6"
29
+ },
30
+ "engines": {
31
+ "node": ">=18.x"
32
+ },
33
+ "scripts": {
34
+ "build": "tsc --build",
35
+ "clean": "rimraf --glob dist test/test-output coverage *.tsbuildinfo",
36
+ "watch": "tsc --watch",
37
+ "lint": "eslint . --ext .ts",
38
+ "lint:fix": "eslint . --ext .ts --fix",
39
+ "test": "jest --ci --forceExit --detectOpenHandles --colors --passWithNoTests",
40
+ "test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
41
+ "link": "pnpm link --global",
42
+ "unlink": "pnpm unlink --global"
43
+ }
44
+ }