@sap-ux/ui5-library-writer 0.7.2 → 1.0.0

package/dist/data/index.d.ts

@@ -1,4 +1,4 @@
-import type { UI5LibInput, UI5LibConfig } from '../types';
+import type { UI5LibInput, UI5LibConfig } from '../types.js';
 /**
  * Merges UI5LibConfig instance with default properties.
  *

package/dist/data/index.js

@@ -1,15 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeWithDefaults = mergeWithDefaults;
-const validators_1 = require("./validators");
+import { validate } from './validators.js';
 /**
  * Merges UI5LibConfig instance with default properties.
  *
  * @param {UI5LibConfig} libConfig - the UI5LibConfig instance
  * @returns {UI5LibInput} - a new UI5LibInput instance with all required defaults set
  */
-function mergeWithDefaults(libConfig) {
-    (0, validators_1.validate)(libConfig);
+export function mergeWithDefaults(libConfig) {
+    validate(libConfig);
     const libraryNamespace = `${libConfig.namespace}.${libConfig.libraryName}`;
     const author = libConfig.author ?? 'UX Tools';
     const libInput = {

package/dist/data/validators.d.ts

@@ -1,4 +1,4 @@
-import type { UI5LibConfig } from '../types';
+import type { UI5LibConfig } from '../types.js';
 /**
  * Validates the specified lib name to ensure we do not create malformed documents.
  *

package/dist/data/validators.js

@@ -1,14 +1,5 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateLibName = validateLibName;
-exports.validateNamespace = validateNamespace;
-exports.validateUI5Version = validateUI5Version;
-exports.validate = validate;
-const semver_1 = __importDefault(require("semver"));
-const i18n_1 = require("../i18n");
+import semVer from 'semver';
+import { t } from '../i18n.js';
 /**
  * Validates the specified lib name to ensure we do not create malformed documents.
  *
@@ -16,12 +7,12 @@ const i18n_1 = require("../i18n");
  * @throws Error with validation message, if the app id is not valid
  * @returns true, if app id is validated
  */
-function validateLibName(libName) {
+export function validateLibName(libName) {
     if (!libName) {
-        throw new Error((0, i18n_1.t)('error.missingRequiredProperty', { propertyName: 'libraryName' }));
+        throw new Error(t('error.missingRequiredProperty', { propertyName: 'libraryName' }));
     }
     if (!/^[a-z][a-z0-9]*$/g.test(libName)) {
-        throw new Error((0, i18n_1.t)('error.useAlphaNumeric', { propertyName: 'libraryName' }));
+        throw new Error(t('error.useAlphaNumeric', { propertyName: 'libraryName' }));
     }
     return true;
 }
@@ -35,25 +26,25 @@ function validateLibName(libName) {
  */
 function validateNamespacePattern(namespace, libName) {
     if (!/^[a-zA-Z]/.test(namespace)) {
-        throw new Error((0, i18n_1.t)('error.invalidNamespace.mustStartWithLetter'));
+        throw new Error(t('error.invalidNamespace.mustStartWithLetter'));
     }
     if (namespace.endsWith('.')) {
-        throw new Error((0, i18n_1.t)('error.invalidNamespace.mustEndInPeriod'));
+        throw new Error(t('error.invalidNamespace.mustEndInPeriod'));
     }
     if (namespace.toUpperCase() === 'SAP') {
-        throw new Error((0, i18n_1.t)('error.invalidNamespace.cannotBeSap', { str: namespace }));
+        throw new Error(t('error.invalidNamespace.cannotBeSap', { str: namespace }));
     }
     if (namespace.toLowerCase().startsWith('new')) {
-        throw new Error((0, i18n_1.t)('error.invalidNamespace.cannotStartWithNew', { str: namespace.substring(0, 3) }));
+        throw new Error(t('error.invalidNamespace.cannotStartWithNew', { str: namespace.substring(0, 3) }));
     }
     if (/\.\d/.test(namespace)) {
-        throw new Error((0, i18n_1.t)('error.invalidNamespace.numAfterPeriod'));
+        throw new Error(t('error.invalidNamespace.numAfterPeriod'));
     }
     if (!/^[a-zA-Z\d_.]+$/.test(namespace)) {
-        throw new Error((0, i18n_1.t)('error.invalidNamespace.specialCharacter'));
+        throw new Error(t('error.invalidNamespace.specialCharacter'));
     }
     if ((libName + namespace).length > 70) {
-        throw new Error((0, i18n_1.t)('error.invalidNamespace.tooLong', { length: 70 }));
+        throw new Error(t('error.invalidNamespace.tooLong', { length: 70 }));
     }
     return true;
 }
@@ -65,9 +56,9 @@ function validateNamespacePattern(namespace, libName) {
  * @throws Error with validation message, if the namespace is not valid
  * @returns true, if app id is validated
  */
-function validateNamespace(namespace, libName) {
+export function validateNamespace(namespace, libName) {
     if (!namespace) {
-        throw new Error((0, i18n_1.t)('error.missingRequiredProperty', { propertyName: 'namespace' }));
+        throw new Error(t('error.missingRequiredProperty', { propertyName: 'namespace' }));
     }
     return validateNamespacePattern(namespace, libName);
 }
@@ -79,9 +70,9 @@ function validateNamespace(namespace, libName) {
  * @param version - the UI5 version string to validate
  * @returns - true if the specified UI5 version is considered valid
  */
-function validateUI5Version(version) {
-    if (version && semver_1.default.coerce(version) === null) {
-        throw new Error((0, i18n_1.t)('error.invalidUI5Version', { version }));
+export function validateUI5Version(version) {
+    if (version && semVer.coerce(version) === null) {
+        throw new Error(t('error.invalidUI5Version', { version }));
     }
     return true;
 }
@@ -92,7 +83,7 @@ function validateUI5Version(version) {
  * @returns true, if the ui5Lib is valid
  * @throws Error with validation message, if the ui5App is not valid
  */
-function validate(ui5Lib) {
+export function validate(ui5Lib) {
     return (validateLibName(ui5Lib.libraryName) &&
         validateNamespace(ui5Lib.namespace, ui5Lib.libraryName) &&
         validateUI5Version(ui5Lib.frameworkVersion));

package/dist/i18n.js

@@ -1,23 +1,15 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.i18n = void 0;
-exports.initI18n = initI18n;
-exports.t = t;
-const i18next_1 = __importDefault(require("i18next"));
-const ui5_library_writer_i18n_json_1 = __importDefault(require("./translations/ui5-library-writer.i18n.json"));
+import i18next from 'i18next';
+import translations from './translations/ui5-library-writer.i18n.json' with { type: 'json' };
 const NS = 'ui5-library-writer';
-exports.i18n = i18next_1.default.createInstance();
+export const i18n = i18next.createInstance();
 /**
  * Initialize i18next with the translations for this module.
  */
-async function initI18n() {
-    await exports.i18n.init({
+export async function initI18n() {
+    await i18n.init({
         resources: {
             en: {
-                [NS]: ui5_library_writer_i18n_json_1.default
+                [NS]: translations
             }
         },
         lng: 'en',
@@ -34,10 +26,8 @@ async function initI18n() {
  * @param options additional options
  * @returns {string} localized string stored for the given key
  */
-function t(key, options) {
-    return exports.i18n.t(key, options);
+export function t(key, options) {
+    return i18n.t(key, options);
 }
-initI18n().catch(() => {
-    // cannot do anything about it but the write will still work
-});
+void initI18n().catch(() => undefined);
 //# sourceMappingURL=i18n.js.map

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
-import type { UI5LibConfig } from './types';
+import type { UI5LibConfig } from './types.js';
 /**
  * Writes the template to the memfs editor instance.
  *

package/dist/index.js

@@ -1,16 +1,12 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generate = generate;
-const node_path_1 = require("node:path");
-const mem_fs_1 = require("mem-fs");
-const mem_fs_editor_1 = require("mem-fs-editor");
-const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
-const options_1 = require("./options");
-const data_1 = require("./data");
-const utils_1 = require("./utils");
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { create as createStorage } from 'mem-fs';
+import { create } from 'mem-fs-editor';
+import cloneDeep from 'lodash/cloneDeep.js';
+import { enableTypescript } from './options/index.js';
+import { mergeWithDefaults } from './data/index.js';
+import { getTemplateVersionPath } from './utils.js';
+const __dirname = dirname(fileURLToPath(import.meta.url));
 /**
  * Writes the template to the memfs editor instance.
  *
@@ -20,16 +16,16 @@ const utils_1 = require("./utils");
  * @returns the updated memfs editor instance
  */
 async function generate(basePath, ui5LibConfig, fs) {
-    const reuseLib = (0, cloneDeep_1.default)(ui5LibConfig);
+    const reuseLib = cloneDeep(ui5LibConfig);
     if (!fs) {
-        fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
+        fs = create(createStorage());
     }
-    const libInput = (0, data_1.mergeWithDefaults)(ui5LibConfig);
-    basePath = (0, node_path_1.join)(basePath, libInput.libraryNamespace);
-    const tmplPath = (0, node_path_1.join)(__dirname, '..', 'templates');
+    const libInput = mergeWithDefaults(ui5LibConfig);
+    basePath = join(basePath, libInput.libraryNamespace);
+    const tmplPath = join(__dirname, '..', 'templates');
     const ignore = [reuseLib.typescript ? '**/*.js' : '**/*.ts'];
-    const templateVersionPath = (0, utils_1.getTemplateVersionPath)(reuseLib.frameworkVersion);
-    fs.copyTpl((0, node_path_1.join)(tmplPath, 'common', templateVersionPath, '**/*.*'), basePath, libInput, undefined, {
+    const templateVersionPath = getTemplateVersionPath(reuseLib.frameworkVersion);
+    fs.copyTpl(join(tmplPath, 'common', templateVersionPath, '**/*.*'), basePath, libInput, undefined, {
         globOptions: { dot: true, ignore },
         processDestinationPath: (filePath) => filePath
             .replace('baselibrary', libInput.libraryNamespaceURI)
@@ -37,8 +33,9 @@ async function generate(basePath, ui5LibConfig, fs) {
             .replace(/karma.conf.tmpl/g, 'karma.conf.js')
     });
     if (reuseLib.typescript) {
-        await (0, options_1.enableTypescript)(libInput, basePath, tmplPath, fs);
+        await enableTypescript(libInput, basePath, tmplPath, fs);
     }
     return fs;
 }
+export { generate };
 //# sourceMappingURL=index.js.map

package/dist/options/index.d.ts

@@ -1,2 +1,2 @@
-export * from './typescript';
+export * from './typescript.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/options/index.js

@@ -1,18 +1,2 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./typescript"), exports);
+export * from './typescript.js';
 //# sourceMappingURL=index.js.map

package/dist/options/typescript.d.ts

@@ -1,5 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
-import type { UI5LibInput } from '../types';
+import type { UI5LibInput } from '../types.js';
 /**
  * Enable typescript for the given input.
  *

package/dist/options/typescript.js

@@ -1,11 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.enableTypescript = enableTypescript;
-const ejs_1 = require("ejs");
-const project_access_1 = require("@sap-ux/project-access");
-const ui5_config_1 = require("@sap-ux/ui5-config");
-const node_path_1 = require("node:path");
-const semver_1 = require("semver");
+import { render } from 'ejs';
+import { getFilePaths } from '@sap-ux/project-access';
+import { mergeObjects, UI5Config } from '@sap-ux/ui5-config';
+import { join } from 'node:path';
+import { gte } from 'semver';
 /**
  * Enable typescript for the given input.
  *
@@ -14,9 +11,9 @@ const semver_1 = require("semver");
  * @param tmplPath - the template path
  * @param fs - the memfs editor instance
  */
-async function enableTypescript(libInput, basePath, tmplPath, fs) {
-    const tsTmplDirPath = (0, node_path_1.join)(tmplPath, 'optional', 'typescript');
-    const tsTmplFilePaths = await (0, project_access_1.getFilePaths)(tsTmplDirPath);
+export async function enableTypescript(libInput, basePath, tmplPath, fs) {
+    const tsTmplDirPath = join(tmplPath, 'optional', 'typescript');
+    const tsTmplFilePaths = await getFilePaths(tsTmplDirPath);
     const tsLibInput = {
         ...libInput,
         tsTypes: getTypePackageFor(libInput.framework, libInput.frameworkVersion),
@@ -24,7 +21,7 @@ async function enableTypescript(libInput, basePath, tmplPath, fs) {
     };
     tsTmplFilePaths.forEach((tsTmplFilePath) => {
         const relPath = tsTmplFilePath.replace(tsTmplDirPath, '');
-        const outPath = (0, node_path_1.join)(basePath, relPath);
+        const outPath = join(basePath, relPath);
         // Extend or add
         if (!fs.exists(outPath)) {
             fs.copyTpl(tsTmplFilePath, outPath, tsLibInput, undefined, {
@@ -32,15 +29,15 @@ async function enableTypescript(libInput, basePath, tmplPath, fs) {
             });
         }
         else {
-            const add = JSON.parse((0, ejs_1.render)(fs.read(tsTmplFilePath), tsLibInput, {}));
+            const add = JSON.parse(render(fs.read(tsTmplFilePath), tsLibInput, {}));
             const existingFile = JSON.parse(fs.read(outPath));
-            const merged = (0, ui5_config_1.mergeObjects)(existingFile, add);
+            const merged = mergeObjects(existingFile, add);
             fs.writeJSON(outPath, merged);
         }
     });
     // ui5 yaml
-    const ui5ConfigPath = (0, node_path_1.join)(basePath, 'ui5.yaml');
-    const ui5Config = await ui5_config_1.UI5Config.newInstance(fs.read(ui5ConfigPath));
+    const ui5ConfigPath = join(basePath, 'ui5.yaml');
+    const ui5Config = await UI5Config.newInstance(fs.read(ui5ConfigPath));
     ui5Config.updateCustomMiddleware({
         name: 'fiori-tools-appreload',
         afterMiddleware: 'compression',
@@ -84,7 +81,7 @@ async function enableTypescript(libInput, basePath, tmplPath, fs) {
  * @returns types package
  */
 function getTypePackageFor(framework, version) {
-    const typesName = (0, semver_1.gte)(version, '1.113.0') ? 'types' : 'ts-types-esm';
+    const typesName = gte(version, '1.113.0') ? 'types' : 'ts-types-esm';
     return `@${framework.toLowerCase()}/${typesName}`;
 }
 //# sourceMappingURL=typescript.js.map

package/dist/types.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=types.js.map

package/dist/utils.js

@@ -1,11 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ui5LtsVersion_1_120 = exports.ui5LtsVersion_1_71 = void 0;
-exports.compareUI5VersionGte = compareUI5VersionGte;
-exports.getTemplateVersionPath = getTemplateVersionPath;
-const semver_1 = require("semver");
-exports.ui5LtsVersion_1_71 = '1.71.0';
-exports.ui5LtsVersion_1_120 = '1.120.0';
+import { gte } from 'semver';
+export const ui5LtsVersion_1_71 = '1.71.0';
+export const ui5LtsVersion_1_120 = '1.120.0';
 /**
  * Compares two UI5 versions to determine if the first is greater than or equal to the second.
  *
@@ -13,13 +8,13 @@ exports.ui5LtsVersion_1_120 = '1.120.0';
  * @param {string} ui5VersionB - The second UI5 version to compare.
  * @returns {boolean} - True if the first version is greater than or equal to the second, false otherwise.
  */
-function compareUI5VersionGte(ui5VersionA, ui5VersionB) {
+export function compareUI5VersionGte(ui5VersionA, ui5VersionB) {
     if (ui5VersionA === '') {
         // latest version
         return true;
     }
     else {
-        return (0, semver_1.gte)(ui5VersionA, ui5VersionB, { loose: true });
+        return gte(ui5VersionA, ui5VersionB, { loose: true });
     }
 }
 /**
@@ -28,13 +23,13 @@ function compareUI5VersionGte(ui5VersionA, ui5VersionB) {
  * @param version - The framework version.
  * @returns {string} - The template version path.
  */
-function getTemplateVersionPath(version) {
+export function getTemplateVersionPath(version) {
     let templateVersionPath = '';
-    if (compareUI5VersionGte(version, exports.ui5LtsVersion_1_120)) {
-        templateVersionPath = exports.ui5LtsVersion_1_120;
+    if (compareUI5VersionGte(version, ui5LtsVersion_1_120)) {
+        templateVersionPath = ui5LtsVersion_1_120;
     }
     else {
-        templateVersionPath = exports.ui5LtsVersion_1_71;
+        templateVersionPath = ui5LtsVersion_1_71;
     }
     return templateVersionPath;
 }

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@sap-ux/ui5-library-writer",
   "description": "Writer module to generate a new ui5 library",
+  "type": "module",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -9,7 +10,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Aui5-library-writer"
   },
-  "version": "0.7.2",
+  "version": "1.0.0",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "files": [
@@ -29,8 +30,8 @@
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "semver": "7.7.4",
-    "@sap-ux/project-access": "1.38.1",
-    "@sap-ux/ui5-config": "0.31.1"
+    "@sap-ux/project-access": "2.0.0",
+    "@sap-ux/ui5-config": "1.0.0"
   },
   "devDependencies": {
     "@types/ejs": "3.1.5",
@@ -40,7 +41,7 @@
     "@types/mem-fs": "1.1.2",
     "fs-extra": "11.3.4",
     "@types/semver": "7.7.1",
-    "@sap-ux/eslint-plugin-fiori-tools": "10.2.1"
+    "@sap-ux/eslint-plugin-fiori-tools": "10.4.0"
   },
   "scripts": {
     "build": "tsc --build",
@@ -49,8 +50,8 @@
     "format": "prettier --write '**/*.{js,json,ts,yaml,yml}' --ignore-path ../../.prettierignore",
     "lint": "eslint",
     "lint:fix": "eslint --fix",
-    "test": "jest --ci --forceExit --detectOpenHandles --colors",
-    "test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
+    "test": "cross-env NODE_OPTIONS='--experimental-vm-modules' jest --ci --forceExit --detectOpenHandles --colors",
+    "test-u": "cross-env NODE_OPTIONS='--experimental-vm-modules' jest --ci --forceExit --detectOpenHandles --colors -u",
     "link": "pnpm link --global",
     "unlink": "pnpm unlink --global"
   }