@sap-ux/project-access 1.34.7 → 1.35.0

package/dist/index.d.ts

@@ -5,5 +5,6 @@ export { addPackageDevDependency, clearCdsModuleCache, createApplicationAccess,
 export { execNpmCommand } from './command/npm-command';
 export * from './types';
 export * from './library';
+export { findRecursiveHierarchyKey, getTableCapabilitiesByEntitySet } from './odata';
 export { hasDependency } from './project';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -15,7 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.hasUI5CliV3 = exports.getWebappPath = exports.getProjectType = exports.getProject = exports.getPathMappings = exports.getNodeModulesPath = exports.getMockDataPath = exports.getMockServerConfig = exports.getMtaPath = exports.getMinimumUI5Version = exports.getMinUI5VersionAsArray = exports.getMinUI5VersionFromManifest = exports.getI18nBundles = exports.getI18nPropertiesPaths = exports.getSpecificationPath = exports.getSpecificationModuleFromCache = exports.getSpecification = exports.getCapI18nFolderNames = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapServiceName = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.getAppType = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.getAllUi5YamlFileNames = exports.findRootsForPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findCapProjectRoot = exports.findAllApps = exports.filterDataSourcesByType = exports.deleteCapApp = exports.createProjectAccess = exports.createApplicationAccess = exports.clearCdsModuleCache = exports.addPackageDevDependency = exports.normalizePath = exports.getFilePaths = exports.fioriToolsDirectory = exports.MinCdsVersion = exports.MinCdsPluginUi5Version = exports.FioriToolsSettings = exports.DirName = exports.FileName = void 0;
-exports.hasDependency = exports.execNpmCommand = exports.getMainService = exports.processServices = exports.readFlexChanges = exports.checkCdsUi5PluginEnabled = exports.hasMinCdsVersion = exports.getWorkspaceInfo = exports.updatePackageScript = exports.toReferenceUri = exports.refreshSpecificationDistTags = exports.readUi5Yaml = exports.readCapServiceMetadataEdmx = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = void 0;
+exports.hasDependency = exports.getTableCapabilitiesByEntitySet = exports.findRecursiveHierarchyKey = exports.execNpmCommand = exports.getMainService = exports.processServices = exports.readFlexChanges = exports.checkCdsUi5PluginEnabled = exports.hasMinCdsVersion = exports.getWorkspaceInfo = exports.updatePackageScript = exports.toReferenceUri = exports.refreshSpecificationDistTags = exports.readUi5Yaml = exports.readCapServiceMetadataEdmx = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = void 0;
 var constants_1 = require("./constants");
 Object.defineProperty(exports, "FileName", { enumerable: true, get: function () { return constants_1.FileName; } });
 Object.defineProperty(exports, "DirName", { enumerable: true, get: function () { return constants_1.DirName; } });
@@ -89,6 +89,9 @@ var npm_command_1 = require("./command/npm-command");
 Object.defineProperty(exports, "execNpmCommand", { enumerable: true, get: function () { return npm_command_1.execNpmCommand; } });
 __exportStar(require("./types"), exports);
 __exportStar(require("./library"), exports);
+var odata_1 = require("./odata");
+Object.defineProperty(exports, "findRecursiveHierarchyKey", { enumerable: true, get: function () { return odata_1.findRecursiveHierarchyKey; } });
+Object.defineProperty(exports, "getTableCapabilitiesByEntitySet", { enumerable: true, get: function () { return odata_1.getTableCapabilitiesByEntitySet; } });
 var project_2 = require("./project");
 Object.defineProperty(exports, "hasDependency", { enumerable: true, get: function () { return project_2.hasDependency; } });
 //# sourceMappingURL=index.js.map

package/dist/odata/index.d.ts

@@ -0,0 +1,2 @@
+export { findRecursiveHierarchyKey, getTableCapabilitiesByEntitySet } from './metadata';
+//# sourceMappingURL=index.d.ts.map

package/dist/odata/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTableCapabilitiesByEntitySet = exports.findRecursiveHierarchyKey = void 0;
+var metadata_1 = require("./metadata");
+Object.defineProperty(exports, "findRecursiveHierarchyKey", { enumerable: true, get: function () { return metadata_1.findRecursiveHierarchyKey; } });
+Object.defineProperty(exports, "getTableCapabilitiesByEntitySet", { enumerable: true, get: function () { return metadata_1.getTableCapabilitiesByEntitySet; } });
+//# sourceMappingURL=index.js.map

package/dist/odata/metadata.d.ts

@@ -0,0 +1,25 @@
+import type { EntitySet } from '@sap-ux/vocabularies-types';
+/**
+ * Finds the RecursiveHierarchy annotation key for the given entity set.
+ * This is a helper function that both existence check and qualifier extraction can use.
+ *
+ * @param entitySet The entity set to check for recursive hierarchy annotation.
+ * @returns The RecursiveHierarchy key if found, undefined otherwise.
+ */
+export declare function findRecursiveHierarchyKey(entitySet: EntitySet): string | undefined;
+/**
+ * Determines table capabilities for a given entity set, analyzing its transformations and hierarchy.
+ *
+ * @param entitySet The entity set for which capabilities are being evaluated.
+ * @param requiredTransformations An optional array of required transformation names to be considered.
+ * @returns An object containing flags for aggregate transformations and recursive hierarchy specific to the entity set:
+ * - `hasAggregateTransformations`: Indicates if aggregate transformations are present in general.
+ * - `hasAggregateTransformationsForEntitySet`: Indicates if aggregate transformations are applicable to the specific entity set.
+ * - `hasRecursiveHierarchyForEntitySet`: Indicates if a recursive hierarchy is present for the specific entity set.
+ */
+export declare function getTableCapabilitiesByEntitySet(entitySet: EntitySet, requiredTransformations?: readonly string[]): {
+    hasAggregateTransformations: boolean;
+    hasAggregateTransformationsForEntitySet: boolean;
+    hasRecursiveHierarchyForEntitySet: boolean;
+};
+//# sourceMappingURL=metadata.d.ts.map

package/dist/odata/metadata.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findRecursiveHierarchyKey = findRecursiveHierarchyKey;
+exports.getTableCapabilitiesByEntitySet = getTableCapabilitiesByEntitySet;
+/**
+ * Annotation pattern for RecursiveHierarchy.
+ */
+const RECURSIVE_HIERARCHY_ANNOTATION = 'RecursiveHierarchy';
+/**
+ * Checks if the given entity set has a Hierarchy.RecursiveHierarchy annotation.
+ *
+ * @param entitySet The entity set to check for recursive hierarchy annotation.
+ * @returns true if the entity set has Hierarchy.RecursiveHierarchy annotation, false otherwise.
+ */
+function hasRecursiveHierarchyForEntitySet(entitySet) {
+    return !!findRecursiveHierarchyKey(entitySet);
+}
+/**
+ * Finds the RecursiveHierarchy annotation key for the given entity set.
+ * This is a helper function that both existence check and qualifier extraction can use.
+ *
+ * @param entitySet The entity set to check for recursive hierarchy annotation.
+ * @returns The RecursiveHierarchy key if found, undefined otherwise.
+ */
+function findRecursiveHierarchyKey(entitySet) {
+    const hierarchyAnnotations = entitySet?.entityType?.annotations?.Hierarchy;
+    if (!hierarchyAnnotations) {
+        return undefined;
+    }
+    // First try exact match for the most common case
+    if (hierarchyAnnotations[RECURSIVE_HIERARCHY_ANNOTATION]) {
+        return RECURSIVE_HIERARCHY_ANNOTATION;
+    }
+    // Then check for qualified versions (RecursiveHierarchy#qualifier)
+    return Object.keys(hierarchyAnnotations).find((key) => key.startsWith(RECURSIVE_HIERARCHY_ANNOTATION));
+}
+/**
+ * Checks if the given entity set has aggregate transformations.
+ * Returns true if ANY transformations are present in either entity set or entity type annotations.
+ *
+ * @param entitySet The entity set to check for aggregate transformations.
+ * @returns true if the entity set has any aggregate transformations, false otherwise.
+ */
+function hasAggregateTransformations(entitySet) {
+    const transformations = entitySet.annotations?.Aggregation?.ApplySupported?.Transformations ||
+        entitySet.entityType?.annotations?.Aggregation?.ApplySupported?.Transformations;
+    return Array.isArray(transformations) && transformations.length > 0;
+}
+/**
+ * Checks if the given entity set has aggregate transformations.
+ * If specific transformations are provided, checks if ALL of those transformations are present.
+ * If no transformations are specified, returns true if ANY transformations are present.
+ *
+ * @param entitySet The entity set to check for aggregate transformations.
+ * @param requiredTransformations Optional array of specific transformations to check for. If not provided, checks for any transformations.
+ * @returns true if the entity set has the required transformations, false otherwise.
+ */
+function hasAggregateTransformationsForEntitySet(entitySet, requiredTransformations) {
+    const transformations = entitySet.annotations?.Aggregation?.ApplySupported?.Transformations ||
+        entitySet.entityType?.annotations?.Aggregation?.ApplySupported?.Transformations;
+    if (!Array.isArray(transformations)) {
+        return false;
+    }
+    // If no specific transformations required, return true if any transformations exist
+    if (!requiredTransformations || requiredTransformations.length === 0) {
+        return transformations.length > 0;
+    }
+    // Check if all required transformations are present
+    return requiredTransformations.every((transformation) => transformations.includes(transformation));
+}
+/**
+ * Determines table capabilities for a given entity set, analyzing its transformations and hierarchy.
+ *
+ * @param entitySet The entity set for which capabilities are being evaluated.
+ * @param requiredTransformations An optional array of required transformation names to be considered.
+ * @returns An object containing flags for aggregate transformations and recursive hierarchy specific to the entity set:
+ * - `hasAggregateTransformations`: Indicates if aggregate transformations are present in general.
+ * - `hasAggregateTransformationsForEntitySet`: Indicates if aggregate transformations are applicable to the specific entity set.
+ * - `hasRecursiveHierarchyForEntitySet`: Indicates if a recursive hierarchy is present for the specific entity set.
+ */
+function getTableCapabilitiesByEntitySet(entitySet, requiredTransformations) {
+    return {
+        hasAggregateTransformations: hasAggregateTransformations(entitySet),
+        hasAggregateTransformationsForEntitySet: hasAggregateTransformationsForEntitySet(entitySet, requiredTransformations),
+        hasRecursiveHierarchyForEntitySet: hasRecursiveHierarchyForEntitySet(entitySet)
+    };
+}
+//# sourceMappingURL=metadata.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-access",
-  "version": "1.34.7",
+  "version": "1.35.0",
   "description": "Library to access SAP Fiori tools projects",
   "repository": {
     "type": "git",
@@ -33,6 +33,7 @@
     "@sap-ux/ui5-config": "0.29.15"
   },
   "devDependencies": {
+    "@sap-ux/vocabularies-types": "0.14.5",
     "@types/mem-fs": "1.1.2",
     "@types/mem-fs-editor": "7.0.1",
     "@types/semver": "7.7.1",