@sapui5/sap.fe.core 1.99.0 → 1.101.1

package/src/sap/fe/core/buildingBlocks/BuildingBlock.ts

@@ -0,0 +1,178 @@
+import deepClone from "sap/base/util/deepClone";
+import { registerBuildingBlock } from "sap/fe/core/buildingBlocks/BuildingBlockRuntime";
+import { generate } from "sap/fe/core/helpers/StableIdHelper";
+/**
+ * Base class for Building Block
+ */
+export class BuildingBlockBase {
+	constructor(oProps: Record<string, any>) {
+		Object.keys(oProps).forEach((propName) => {
+			this[propName as keyof this] = oProps[propName];
+		});
+	}
+
+	/**
+	 * Convert the given local element ID to a globally unique ID by prefixing with the Building Block ID.
+	 *
+	 * @param stringParts
+	 * @returns Either the global ID or undefined if the Building Block doesn't have an ID
+	 */
+	public createId(...stringParts: string[]) {
+		// If the child instance has an ID property use it otherwise return undefined
+		if ((this as any).id) {
+			return generate([(this as any).id, ...stringParts]);
+		}
+		return undefined;
+	}
+	/*
+	// This block is commented out because I am not using them for now / need to change this but still want to keep them around
+	static getConverterContext = function (oVisualizationObjectPath: any, contextPath: any, mSettings: any, mExtraParams?: any) {
+		const oAppComponent = mSettings.appComponent;
+		const originalViewData = mSettings.models.viewData && mSettings.models.viewData.getData();
+		let viewData = Object.assign({}, originalViewData);
+		delete viewData.resourceBundle;
+		viewData = deepClone(viewData);
+		viewData.controlConfiguration = merge(viewData.controlConfiguration, mExtraParams);
+		return ConverterContext.createConverterContextForMacro(
+			oVisualizationObjectPath.startingEntitySet.name,
+			mSettings.models.metaModel,
+			oAppComponent && oAppComponent.getDiagnostics(),
+			merge,
+			oVisualizationObjectPath.contextLocation,
+			viewData
+		);
+	};
+	static getMetadata() {
+		// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+		// @ts-ignore
+		// eslint-disable-next-line @typescript-eslint/no-this-alias
+		return {
+			getAllProperties(this: BuildingBlockDefinition) {
+				// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+				// @ts-ignore
+				return this.metadata.properties;
+			},
+			getName(this: BuildingBlockDefinition) {
+				return `${this.namespace}.${this.name}`;
+			},
+			getAllAggregations() {
+				return {};
+			},
+			getDefaultAggregationName() {
+				return "";
+			}
+		};
+	}*/
+	static register() {
+		// To be overriden
+	}
+}
+
+export type BuildingBlockPropertyDefinition = {
+	type: string;
+	isPublic?: boolean;
+	defaultValue?: any;
+	computed?: boolean;
+	required?: boolean;
+	$kind?: string[];
+};
+export type BuildingBlockMetadataContextDefinition = {
+	type: string;
+	isPublic?: boolean;
+	required?: boolean;
+	computed?: boolean;
+	$Type?: string[];
+	$kind?: string[];
+};
+export type BuildingBlockEvent = {};
+export type BuildingBlockAggregationDefinition = {
+	isPublic?: boolean;
+	type: string;
+	slot?: string;
+};
+type CommonBuildingBlockDefinition = {
+	namespace: string;
+	name: string;
+	xmlTag?: string;
+	fragment?: string;
+	publicNamespace?: string;
+
+	isOpen?: boolean;
+};
+export type BuildingBlockDefinitionV2 = CommonBuildingBlockDefinition &
+	typeof BuildingBlockBase & {
+		apiVersion: 2;
+		metadata: BuildingBlockMetadata;
+	};
+
+export type BuildingBlockDefinitionV1 = CommonBuildingBlockDefinition & {
+	name: string;
+	apiVersion?: 1;
+	create?: Function;
+	getTemplate?: Function;
+	metadata: BuildingBlockMetadata;
+};
+export type BuildingBlockDefinition = BuildingBlockDefinitionV2 | BuildingBlockDefinitionV1;
+export type BuildingBlockMetadata = {
+	events: Record<string, BuildingBlockEvent>;
+	properties: Record<string, BuildingBlockPropertyDefinition>;
+	aggregations: Record<string, BuildingBlockAggregationDefinition>;
+};
+
+const ensureMetadata = function (target: any): BuildingBlockMetadata {
+	if (!target.hasOwnProperty("metadata")) {
+		target.metadata = deepClone(
+			target.metadata || {
+				properties: {},
+				aggregations: {},
+				events: {}
+			}
+		);
+	}
+	return target.metadata;
+};
+
+/**
+ * Indicates that the property shall be declared as an xml attribute that can be used from the outside of the building block.
+ *
+ * @param attributeDefinition
+ * @returns The decorated property
+ */
+export function xmlAttribute(attributeDefinition: BuildingBlockPropertyDefinition): PropertyDecorator {
+	return function (target: BuildingBlockBase, propertyKey: string, propertyDescriptor: TypedPropertyDescriptor<any>) {
+		const metadata = ensureMetadata(target.constructor);
+		delete (propertyDescriptor as any).initializer;
+		if (!metadata.properties[propertyKey]) {
+			metadata.properties[propertyKey] = attributeDefinition;
+		}
+
+		return propertyDescriptor;
+	} as any;
+}
+
+export function xmlEvent(): PropertyDecorator {
+	return function (target: BuildingBlockBase, propertyKey: string, propertyDescriptor: TypedPropertyDescriptor<any>) {
+		const metadata = ensureMetadata(target.constructor);
+		delete (propertyDescriptor as any).initializer;
+		if (!metadata.events[propertyKey]) {
+			metadata.events[propertyKey] = { type: "Function" };
+		}
+
+		return propertyDescriptor;
+	} as any;
+}
+
+export function defineBuildingBlock(oBuildingBlockDefinition: CommonBuildingBlockDefinition) {
+	return function (classDefinition: any) {
+		ensureMetadata(classDefinition);
+		classDefinition.xmlTag = oBuildingBlockDefinition.name;
+		classDefinition.namespace = oBuildingBlockDefinition.namespace;
+		classDefinition.publicNamespace = oBuildingBlockDefinition.publicNamespace;
+		classDefinition.fragment = oBuildingBlockDefinition.fragment;
+		classDefinition.isOpen = oBuildingBlockDefinition.isOpen;
+		classDefinition.apiVersion = 2;
+		classDefinition.register = function () {
+			registerBuildingBlock(classDefinition);
+		};
+	};
+}