@sap-ux/cap-config-writer 0.9.21 → 0.9.22

package/dist/cap-config/index.d.ts

@@ -1,8 +1,4 @@
 import type { Editor } from 'mem-fs-editor';
-import type { CdsVersionInfo } from '@sap-ux/project-access';
-import { minCdsVersion } from './package-json';
-export { satisfiesMinCdsVersion } from './package-json';
-import type { CdsUi5PluginInfo } from './types';
 /**
  * Enable workspace and cds-plugin-ui5 for given CAP project.
  *
@@ -11,33 +7,4 @@ import type { CdsUi5PluginInfo } from './types';
  * @returns Promise<Editor> - memfs editor instance with updated files
  */
 export declare function enableCdsUi5Plugin(basePath: string, fs?: Editor): Promise<Editor>;
-/**
- * Check if cds-plugin-ui5 is enabled on a CAP project. Checks also all prerequisites, like minimum @sap/cds version.
- * Overloaded function that returns detailed CAP plugin info.
- *
- * @param basePath - root path of the CAP project, where package.json is located
- * @param [fs] - optional: the memfs editor instance
- * @returns true: cds-plugin-ui5 and all prerequisites are fulfilled; false: cds-plugin-ui5 is not enabled or not all prerequisites are fulfilled
- */
-export declare function checkCdsUi5PluginEnabled(basePath: string, fs?: Editor): Promise<boolean>;
-/**
- * Check if cds-plugin-ui5 is enabled on a CAP project. Checks also all prerequisites, like minimum @sap/cds version.
- *
- * @param basePath - root path of the CAP project, where package.json is located
- * @param [fs] - optional: the memfs editor instance
- * @param [moreInfo] if true return an object specifying detailed info about the cds and workspace state
- * @returns false if package.json is not found at specified path or {@link CdsUi5PluginInfo} with additional info
- */
-export declare function checkCdsUi5PluginEnabled(basePath: string, fs?: Editor, moreInfo?: boolean): Promise<boolean | CdsUi5PluginInfo>;
-/**
- * Check if cds-plugin-ui5 is enabled on a CAP project. Checks also all prerequisites, like minimum @sap/cds version.
- *
- * @param basePath - root path of the CAP project, where package.json is located
- * @param [fs] - optional: the memfs editor instance
- * @param [moreInfo] if true return an object specifying detailed info about the cds and workspace state
- * @param {CdsVersionInfo} [cdsVersionInfo] - If provided will be used instead of parsing the package.json file to determine the cds version.
- * @returns false if package.json is not found at specified path or {@link CdsUi5PluginInfo} with additional info
- */
-export declare function checkCdsUi5PluginEnabled(basePath: string, fs?: Editor, moreInfo?: boolean, cdsVersionInfo?: CdsVersionInfo): Promise<boolean | CdsUi5PluginInfo>;
-export { minCdsVersion };
 //# sourceMappingURL=index.d.ts.map

package/dist/cap-config/index.js

@@ -1,16 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.minCdsVersion = exports.satisfiesMinCdsVersion = void 0;
 exports.enableCdsUi5Plugin = enableCdsUi5Plugin;
-exports.checkCdsUi5PluginEnabled = checkCdsUi5PluginEnabled;
 const path_1 = require("path");
 const mem_fs_1 = require("mem-fs");
 const mem_fs_editor_1 = require("mem-fs-editor");
 const package_json_1 = require("./package-json");
-Object.defineProperty(exports, "minCdsVersion", { enumerable: true, get: function () { return package_json_1.minCdsVersion; } });
-var package_json_2 = require("./package-json");
-Object.defineProperty(exports, "satisfiesMinCdsVersion", { enumerable: true, get: function () { return package_json_2.satisfiesMinCdsVersion; } });
-const semver_1 = require("semver");
 /**
  * Enable workspace and cds-plugin-ui5 for given CAP project.
  *
@@ -30,39 +24,4 @@ async function enableCdsUi5Plugin(basePath, fs) {
     fs.writeJSON(packageJsonPath, packageJson);
     return fs;
 }
-/**
- * Implementation of the overloaded function.
- * Check if cds-plugin-ui5 is enabled on a CAP project. Checks also all prerequisites, like minimum @sap/cds version.
- *
- * @param basePath - root path of the CAP project, where package.json is located
- * @param [fs] - optional: the memfs editor instance
- * @param [moreInfo] if true return an object specifying detailed info about the cds and workspace state
- * @param {CdsVersionInfo} [cdsVersionInfo] - If provided will be used instead of parsing the package.json file to determine the cds version.
- * @returns false if package.json is not found at specified path or {@link CdsUi5PluginInfo} with additional info or true if
- * cds-plugin-ui5 and all prerequisites are fulfilled
- */
-async function checkCdsUi5PluginEnabled(basePath, fs, moreInfo, cdsVersionInfo) {
-    if (!fs) {
-        fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
-    }
-    const packageJsonPath = (0, path_1.join)(basePath, 'package.json');
-    if (!fs.exists(packageJsonPath)) {
-        return false;
-    }
-    const packageJson = fs.readJSON(packageJsonPath);
-    const { workspaceEnabled } = await (0, package_json_1.getWorkspaceInfo)(basePath, packageJson);
-    const cdsInfo = {
-        // Below line checks if 'cdsVersionInfo' is available and contains version information.
-        // If it does, it uses that version information to determine if it satisfies the minimum CDS version required.
-        // If 'cdsVersionInfo' is not available or does not contain version information,it falls back to check the version specified in the package.json file.
-        hasMinCdsVersion: cdsVersionInfo?.version
-            ? (0, semver_1.satisfies)(cdsVersionInfo?.version, `>=${package_json_1.minCdsVersion}`)
-            : (0, package_json_1.satisfiesMinCdsVersion)(packageJson),
-        isWorkspaceEnabled: workspaceEnabled,
-        hasCdsUi5Plugin: (0, package_json_1.hasCdsPluginUi5)(packageJson),
-        isCdsUi5PluginEnabled: false
-    };
-    cdsInfo.isCdsUi5PluginEnabled = cdsInfo.hasMinCdsVersion && cdsInfo.isWorkspaceEnabled && cdsInfo.hasCdsUi5Plugin;
-    return moreInfo ? cdsInfo : cdsInfo.isCdsUi5PluginEnabled;
-}
 //# sourceMappingURL=index.js.map

package/dist/cap-config/package-json.d.ts

@@ -1,5 +1,4 @@
-import type { Package } from '@sap-ux/project-access';
-export declare const minCdsVersion = "6.8.2";
+import { type Package } from '@sap-ux/project-access';
 /**
  * Ensure a minimum version of @sap/cds in dependencies.
  *
@@ -19,37 +18,4 @@ export declare function enableWorkspaces(basePath: string, packageJson: Package)
  * @param packageJson - the parsed package.json
  */
 export declare function addCdsPluginUi5(packageJson: Package): void;
-/**
- * Check if package.json has dependency to the minimum min version of @sap/cds,
- * that is required to enable cds-plugin-ui.
- *
- * @param packageJson - the parsed package.json
- * @returns - true: min cds version is present; false: cds version needs update
- */
-export declare function hasMinCdsVersion(packageJson: Package): boolean;
-/**
- * Check if package.json has version or version range that satisfies the minimum version of @sap/cds.
- *
- * @param packageJson  - the parsed package.json
- * @returns - true: cds version satisfies the min cds version; false: cds version does not satisfy min cds version
- */
-export declare function satisfiesMinCdsVersion(packageJson: Package): boolean;
-/**
- * Get information about the workspaces in the CAP project.
- *
- * @param basePath - root path of the CAP project, where package.json is located
- * @param packageJson - the parsed package.json
- * @returns - appWorkspace containing the path to the appWorkspace including wildcard; workspaceEnabled: boolean that states whether workspace for apps are enabled
- */
-export declare function getWorkspaceInfo(basePath: string, packageJson: Package): Promise<{
-    appWorkspace: string;
-    workspaceEnabled: boolean;
-}>;
-/**
- * Check if devDependency to cds-plugin-ui5 is present in package.json.
- *
- * @param packageJson - the parsed package.json
- * @returns true: devDependency to cds-plugin-ui5 exists; false: devDependency to cds-plugin-ui5 does not exist
- */
-export declare function hasCdsPluginUi5(packageJson: Package): boolean;
 //# sourceMappingURL=package-json.d.ts.map

package/dist/cap-config/package-json.js

@@ -1,16 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.minCdsVersion = void 0;
 exports.ensureMinCdsVersion = ensureMinCdsVersion;
 exports.enableWorkspaces = enableWorkspaces;
 exports.addCdsPluginUi5 = addCdsPluginUi5;
-exports.hasMinCdsVersion = hasMinCdsVersion;
-exports.satisfiesMinCdsVersion = satisfiesMinCdsVersion;
-exports.getWorkspaceInfo = getWorkspaceInfo;
-exports.hasCdsPluginUi5 = hasCdsPluginUi5;
-const semver_1 = require("semver");
 const project_access_1 = require("@sap-ux/project-access");
-exports.minCdsVersion = '6.8.2';
 const minCdsPluginUi5Version = '0.9.3';
 /**
  * Ensure a minimum version of @sap/cds in dependencies.
@@ -18,9 +11,9 @@ const minCdsPluginUi5Version = '0.9.3';
  * @param packageJson - the parsed package.json
  */
 function ensureMinCdsVersion(packageJson) {
-    if (!hasMinCdsVersion(packageJson)) {
+    if (!(0, project_access_1.hasMinCdsVersion)(packageJson)) {
         packageJson.dependencies ??= {};
-        packageJson.dependencies['@sap/cds'] = `^${exports.minCdsVersion}`;
+        packageJson.dependencies['@sap/cds'] = `^${project_access_1.MinCdsVersionUi5Plugin}`;
     }
 }
 /**
@@ -30,12 +23,11 @@ function ensureMinCdsVersion(packageJson) {
  * @param packageJson - the parsed package.json
  */
 async function enableWorkspaces(basePath, packageJson) {
-    const { appWorkspace, workspaceEnabled } = await getWorkspaceInfo(basePath, packageJson);
+    let { appWorkspace, workspaceEnabled, workspacePackages } = await (0, project_access_1.getWorkspaceInfo)(basePath, packageJson);
     if (workspaceEnabled) {
         return;
     }
-    let workspacePackages = getWorkspacePackages(packageJson);
-    if (!workspacePackages) {
+    if (workspacePackages.length === 0) {
         packageJson.workspaces ??= [];
         if (Array.isArray(packageJson.workspaces)) {
             workspacePackages = packageJson.workspaces;
@@ -53,69 +45,9 @@ async function enableWorkspaces(basePath, packageJson) {
  * @param packageJson - the parsed package.json
  */
 function addCdsPluginUi5(packageJson) {
-    if (!hasCdsPluginUi5(packageJson)) {
+    if (!(0, project_access_1.hasDependency)(packageJson, 'cds-plugin-ui5')) {
         packageJson.devDependencies ??= {};
         packageJson.devDependencies['cds-plugin-ui5'] = `^${minCdsPluginUi5Version}`;
     }
 }
-/**
- * Check if package.json has dependency to the minimum min version of @sap/cds,
- * that is required to enable cds-plugin-ui.
- *
- * @param packageJson - the parsed package.json
- * @returns - true: min cds version is present; false: cds version needs update
- */
-function hasMinCdsVersion(packageJson) {
-    return (0, semver_1.gte)((0, semver_1.coerce)(packageJson.dependencies?.['@sap/cds']) ?? '0.0.0', exports.minCdsVersion);
-}
-/**
- * Check if package.json has version or version range that satisfies the minimum version of @sap/cds.
- *
- * @param packageJson  - the parsed package.json
- * @returns - true: cds version satisfies the min cds version; false: cds version does not satisfy min cds version
- */
-function satisfiesMinCdsVersion(packageJson) {
-    return hasMinCdsVersion(packageJson) || (0, semver_1.satisfies)(exports.minCdsVersion, packageJson.dependencies?.['@sap/cds'] ?? '0.0.0');
-}
-/**
- * Get information about the workspaces in the CAP project.
- *
- * @param basePath - root path of the CAP project, where package.json is located
- * @param packageJson - the parsed package.json
- * @returns - appWorkspace containing the path to the appWorkspace including wildcard; workspaceEnabled: boolean that states whether workspace for apps are enabled
- */
-async function getWorkspaceInfo(basePath, packageJson) {
-    const capPaths = await (0, project_access_1.getCapCustomPaths)(basePath);
-    const appWorkspace = capPaths.app.endsWith('/') ? `${capPaths.app}*` : `${capPaths.app}/*`;
-    const workspacePackages = getWorkspacePackages(packageJson) ?? [];
-    const workspaceEnabled = workspacePackages.includes(appWorkspace);
-    return { appWorkspace, workspaceEnabled };
-}
-/**
- * Return the reference to the array of workspace packages or undefined if not defined.
- * The workspace packages can either be defined directly as workspaces in package.json
- * or in workspaces.packages, e.g. in yarn workspaces.
- *
- * @param packageJson - the parsed package.json
- * @returns ref to the packages in workspaces or undefined
- */
-function getWorkspacePackages(packageJson) {
-    let workspacePackages;
-    if (Array.isArray(packageJson.workspaces)) {
-        workspacePackages = packageJson.workspaces;
-    }
-    else if (Array.isArray(packageJson.workspaces?.packages)) {
-        workspacePackages = packageJson.workspaces?.packages;
-    }
-    return workspacePackages;
-}
-/**
- * Check if devDependency to cds-plugin-ui5 is present in package.json.
- *
- * @param packageJson - the parsed package.json
- * @returns true: devDependency to cds-plugin-ui5 exists; false: devDependency to cds-plugin-ui5 does not exist
- */
-function hasCdsPluginUi5(packageJson) {
-    return !!packageJson.devDependencies?.['cds-plugin-ui5'];
-}
 //# sourceMappingURL=package-json.js.map

package/dist/cap-config/types.d.ts

@@ -1,22 +1,4 @@
-import type { CdsVersionInfo } from '@sap-ux/project-access';
-export type CdsUi5PluginInfo = {
-    /**
-     * Convienience property. The CDS UI5 plugin is considered enabled if `hasCdsUi5Plugin`, `hasMinCdsVersion`, `isWorkspaceEnabled` are all true.
-     */
-    isCdsUi5PluginEnabled: boolean;
-    /**
-     * True if the CDS version satisfies the minimum supported CDS version
-     */
-    hasMinCdsVersion: boolean;
-    /**
-     * True if NPM workspaces are enabled at the root of a CAP project
-     */
-    isWorkspaceEnabled: boolean;
-    /**
-     * True if the CDS ui5 plugin is specified as a dependency
-     */
-    hasCdsUi5Plugin: boolean;
-};
+import type { CdsVersionInfo, CdsUi5PluginInfo } from '@sap-ux/project-access';
 export type CapRuntime = 'Node.js' | 'Java';
 export interface CapService {
     /**

package/dist/cap-writer/package-json.js

@@ -45,7 +45,7 @@ function updatePackageJsonWithScripts(fs, packageJsonPath, scripts) {
  * @returns {Promise<void>} A Promise that resolves once the scripts are updated.
  */
 async function updateScripts(fs, packageJsonPath, projectName, appId, enableNPMWorkspaces) {
-    const hasNPMworkspaces = await (0, cap_config_1.checkCdsUi5PluginEnabled)((0, path_1.dirname)(packageJsonPath), fs);
+    const hasNPMworkspaces = await (0, project_access_1.checkCdsUi5PluginEnabled)((0, path_1.dirname)(packageJsonPath), fs);
     let cdsScript;
     // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
     if (enableNPMWorkspaces || hasNPMworkspaces) {

package/dist/index.d.ts

@@ -1,5 +1,7 @@
-export { checkCdsUi5PluginEnabled, enableCdsUi5Plugin, satisfiesMinCdsVersion } from './cap-config';
+import { checkCdsUi5PluginEnabled } from '@sap-ux/project-access';
+export { checkCdsUi5PluginEnabled };
+export { enableCdsUi5Plugin } from './cap-config';
 export type { CapService, CapRuntime } from './cap-config/types';
-export type { CdsUi5PluginInfo, CapServiceCdsInfo, CapProjectSettings } from './cap-config/types';
+export type { CapServiceCdsInfo, CapProjectSettings } from './cap-config/types';
 export * from './cap-writer';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,10 +14,10 @@ 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 });
-exports.satisfiesMinCdsVersion = exports.enableCdsUi5Plugin = exports.checkCdsUi5PluginEnabled = void 0;
+exports.enableCdsUi5Plugin = exports.checkCdsUi5PluginEnabled = void 0;
+const project_access_1 = require("@sap-ux/project-access");
+Object.defineProperty(exports, "checkCdsUi5PluginEnabled", { enumerable: true, get: function () { return project_access_1.checkCdsUi5PluginEnabled; } });
 var cap_config_1 = require("./cap-config");
-Object.defineProperty(exports, "checkCdsUi5PluginEnabled", { enumerable: true, get: function () { return cap_config_1.checkCdsUi5PluginEnabled; } });
 Object.defineProperty(exports, "enableCdsUi5Plugin", { enumerable: true, get: function () { return cap_config_1.enableCdsUi5Plugin; } });
-Object.defineProperty(exports, "satisfiesMinCdsVersion", { enumerable: true, get: function () { return cap_config_1.satisfiesMinCdsVersion; } });
 __exportStar(require("./cap-writer"), exports);
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/cap-config-writer",
   "description": "Add or update configuration for SAP CAP projects",
-  "version": "0.9.21",
+  "version": "0.9.22",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -25,9 +25,9 @@
     "semver": "7.5.4",
     "xml-js": "1.6.11",
     "@sap-ux/logger": "0.6.0",
-    "@sap-ux/project-access": "1.29.17",
+    "@sap-ux/project-access": "1.29.18",
     "@sap-ux/yaml": "0.16.0",
-    "@sap-ux/fiori-generator-shared": "0.9.10"
+    "@sap-ux/fiori-generator-shared": "0.9.11"
   },
   "devDependencies": {
     "@types/mem-fs": "1.1.2",