@sapui5/sap.fe.core 1.100.0 → 1.102.0

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

@@ -0,0 +1,165 @@
+/*!
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+ *      (c) Copyright 2009-2021 SAP SE. All rights reserved
+ */
+sap.ui.define(["sap/base/util/deepClone", "sap/fe/core/buildingBlocks/BuildingBlockRuntime", "sap/fe/core/helpers/StableIdHelper"], function (deepClone, BuildingBlockRuntime, StableIdHelper) {
+  "use strict";
+
+  var _exports = {};
+  var generate = StableIdHelper.generate;
+  var registerBuildingBlock = BuildingBlockRuntime.registerBuildingBlock;
+
+  /**
+   * Base class for Building Block
+   */
+  var BuildingBlockBase = /*#__PURE__*/function () {
+    function BuildingBlockBase(oProps) {
+      var _this = this;
+
+      Object.keys(oProps).forEach(function (propName) {
+        _this[propName] = 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
+     */
+
+
+    _exports.BuildingBlockBase = BuildingBlockBase;
+    var _proto = BuildingBlockBase.prototype;
+
+    _proto.createId = function createId() {
+      // If the child instance has an ID property use it otherwise return undefined
+      if (this.id) {
+        for (var _len = arguments.length, stringParts = new Array(_len), _key = 0; _key < _len; _key++) {
+          stringParts[_key] = arguments[_key];
+        }
+
+        return generate([this.id].concat(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 "";
+    		}
+    	};
+    }*/
+    ;
+
+    BuildingBlockBase.register = function register() {// To be overriden
+    };
+
+    return BuildingBlockBase;
+  }();
+
+  _exports.BuildingBlockBase = BuildingBlockBase;
+
+  var ensureMetadata = function (target) {
+    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
+   */
+
+
+  function xmlAttribute(attributeDefinition) {
+    return function (target, propertyKey, propertyDescriptor) {
+      var metadata = ensureMetadata(target.constructor);
+      delete propertyDescriptor.initializer;
+
+      if (!metadata.properties[propertyKey]) {
+        metadata.properties[propertyKey] = attributeDefinition;
+      }
+
+      return propertyDescriptor;
+    };
+  }
+
+  _exports.xmlAttribute = xmlAttribute;
+
+  function xmlEvent() {
+    return function (target, propertyKey, propertyDescriptor) {
+      var metadata = ensureMetadata(target.constructor);
+      delete propertyDescriptor.initializer;
+
+      if (!metadata.events[propertyKey]) {
+        metadata.events[propertyKey] = {
+          type: "Function"
+        };
+      }
+
+      return propertyDescriptor;
+    };
+  }
+
+  _exports.xmlEvent = xmlEvent;
+
+  function defineBuildingBlock(oBuildingBlockDefinition) {
+    return function (classDefinition) {
+      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);
+      };
+    };
+  }
+
+  _exports.defineBuildingBlock = defineBuildingBlock;
+  return _exports;
+}, false);
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"sources":["BuildingBlock.ts"],"names":["BuildingBlockBase","oProps","Object","keys","forEach","propName","createId","id","stringParts","generate","undefined","register","ensureMetadata","target","hasOwnProperty","metadata","deepClone","properties","aggregations","events","xmlAttribute","attributeDefinition","propertyKey","propertyDescriptor","constructor","initializer","xmlEvent","type","defineBuildingBlock","oBuildingBlockDefinition","classDefinition","xmlTag","name","namespace","publicNamespace","fragment","isOpen","apiVersion","registerBuildingBlock"],"mappings":";AAAA;AACA;AACA;;;;;;;;AACA;AACA;AACA;MACaA,iB;AACZ,+BAAYC,MAAZ,EAAyC;AAAA;;AACxCC,MAAAA,MAAM,CAACC,IAAP,CAAYF,MAAZ,EAAoBG,OAApB,CAA4B,UAACC,QAAD,EAAc;AACzC,QAAA,KAAI,CAACA,QAAD,CAAJ,GAA+BJ,MAAM,CAACI,QAAD,CAArC;AACA,OAFD;AAGA;AAED;AACD;AACA;AACA;AACA;AACA;;;;;;WACQC,Q,GAAP,oBAA0C;AACzC;AACA,UAAK,IAAD,CAAcC,EAAlB,EAAsB;AAAA,0CAFJC,WAEI;AAFJA,UAAAA,WAEI;AAAA;;AACrB,eAAOC,QAAQ,EAAG,IAAD,CAAcF,EAAhB,SAAuBC,WAAvB,EAAf;AACA;;AACD,aAAOE,SAAP;AACA;AACD;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;sBACQC,Q,GAAP,oBAAkB,CACjB;AACA,K;;;;;;;AAsDF,MAAMC,cAAc,GAAG,UAAUC,MAAV,EAA8C;AACpE,QAAI,CAACA,MAAM,CAACC,cAAP,CAAsB,UAAtB,CAAL,EAAwC;AACvCD,MAAAA,MAAM,CAACE,QAAP,GAAkBC,SAAS,CAC1BH,MAAM,CAACE,QAAP,IAAmB;AAClBE,QAAAA,UAAU,EAAE,EADM;AAElBC,QAAAA,YAAY,EAAE,EAFI;AAGlBC,QAAAA,MAAM,EAAE;AAHU,OADO,CAA3B;AAOA;;AACD,WAAON,MAAM,CAACE,QAAd;AACA,GAXD;AAaA;AACA;AACA;AACA;AACA;AACA;;;AACO,WAASK,YAAT,CAAsBC,mBAAtB,EAA+F;AACrG,WAAO,UAAUR,MAAV,EAAqCS,WAArC,EAA0DC,kBAA1D,EAA4G;AAClH,UAAMR,QAAQ,GAAGH,cAAc,CAACC,MAAM,CAACW,WAAR,CAA/B;AACA,aAAQD,kBAAD,CAA4BE,WAAnC;;AACA,UAAI,CAACV,QAAQ,CAACE,UAAT,CAAoBK,WAApB,CAAL,EAAuC;AACtCP,QAAAA,QAAQ,CAACE,UAAT,CAAoBK,WAApB,IAAmCD,mBAAnC;AACA;;AAED,aAAOE,kBAAP;AACA,KARD;AASA;;;;AAEM,WAASG,QAAT,GAAuC;AAC7C,WAAO,UAAUb,MAAV,EAAqCS,WAArC,EAA0DC,kBAA1D,EAA4G;AAClH,UAAMR,QAAQ,GAAGH,cAAc,CAACC,MAAM,CAACW,WAAR,CAA/B;AACA,aAAQD,kBAAD,CAA4BE,WAAnC;;AACA,UAAI,CAACV,QAAQ,CAACI,MAAT,CAAgBG,WAAhB,CAAL,EAAmC;AAClCP,QAAAA,QAAQ,CAACI,MAAT,CAAgBG,WAAhB,IAA+B;AAAEK,UAAAA,IAAI,EAAE;AAAR,SAA/B;AACA;;AAED,aAAOJ,kBAAP;AACA,KARD;AASA;;;;AAEM,WAASK,mBAAT,CAA6BC,wBAA7B,EAAsF;AAC5F,WAAO,UAAUC,eAAV,EAAgC;AACtClB,MAAAA,cAAc,CAACkB,eAAD,CAAd;AACAA,MAAAA,eAAe,CAACC,MAAhB,GAAyBF,wBAAwB,CAACG,IAAlD;AACAF,MAAAA,eAAe,CAACG,SAAhB,GAA4BJ,wBAAwB,CAACI,SAArD;AACAH,MAAAA,eAAe,CAACI,eAAhB,GAAkCL,wBAAwB,CAACK,eAA3D;AACAJ,MAAAA,eAAe,CAACK,QAAhB,GAA2BN,wBAAwB,CAACM,QAApD;AACAL,MAAAA,eAAe,CAACM,MAAhB,GAAyBP,wBAAwB,CAACO,MAAlD;AACAN,MAAAA,eAAe,CAACO,UAAhB,GAA6B,CAA7B;;AACAP,MAAAA,eAAe,CAACnB,QAAhB,GAA2B,YAAY;AACtC2B,QAAAA,qBAAqB,CAACR,eAAD,CAArB;AACA,OAFD;AAGA,KAXD;AAYA","sourceRoot":".","sourcesContent":["import deepClone from \"sap/base/util/deepClone\";\nimport { registerBuildingBlock } from \"sap/fe/core/buildingBlocks/BuildingBlockRuntime\";\nimport { generate } from \"sap/fe/core/helpers/StableIdHelper\";\n/**\n * Base class for Building Block\n */\nexport class BuildingBlockBase {\n\tconstructor(oProps: Record<string, any>) {\n\t\tObject.keys(oProps).forEach((propName) => {\n\t\t\tthis[propName as keyof this] = oProps[propName];\n\t\t});\n\t}\n\n\t/**\n\t * Convert the given local element ID to a globally unique ID by prefixing with the Building Block ID.\n\t *\n\t * @param stringParts\n\t * @returns Either the global ID or undefined if the Building Block doesn't have an ID\n\t */\n\tpublic createId(...stringParts: string[]) {\n\t\t// If the child instance has an ID property use it otherwise return undefined\n\t\tif ((this as any).id) {\n\t\t\treturn generate([(this as any).id, ...stringParts]);\n\t\t}\n\t\treturn undefined;\n\t}\n\t/*\n\t// This block is commented out because I am not using them for now / need to change this but still want to keep them around\n\tstatic getConverterContext = function (oVisualizationObjectPath: any, contextPath: any, mSettings: any, mExtraParams?: any) {\n\t\tconst oAppComponent = mSettings.appComponent;\n\t\tconst originalViewData = mSettings.models.viewData && mSettings.models.viewData.getData();\n\t\tlet viewData = Object.assign({}, originalViewData);\n\t\tdelete viewData.resourceBundle;\n\t\tviewData = deepClone(viewData);\n\t\tviewData.controlConfiguration = merge(viewData.controlConfiguration, mExtraParams);\n\t\treturn ConverterContext.createConverterContextForMacro(\n\t\t\toVisualizationObjectPath.startingEntitySet.name,\n\t\t\tmSettings.models.metaModel,\n\t\t\toAppComponent && oAppComponent.getDiagnostics(),\n\t\t\tmerge,\n\t\t\toVisualizationObjectPath.contextLocation,\n\t\t\tviewData\n\t\t);\n\t};\n\tstatic getMetadata() {\n\t\t// eslint-disable-next-line @typescript-eslint/ban-ts-comment\n\t\t// @ts-ignore\n\t\t// eslint-disable-next-line @typescript-eslint/no-this-alias\n\t\treturn {\n\t\t\tgetAllProperties(this: BuildingBlockDefinition) {\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/ban-ts-comment\n\t\t\t\t// @ts-ignore\n\t\t\t\treturn this.metadata.properties;\n\t\t\t},\n\t\t\tgetName(this: BuildingBlockDefinition) {\n\t\t\t\treturn `${this.namespace}.${this.name}`;\n\t\t\t},\n\t\t\tgetAllAggregations() {\n\t\t\t\treturn {};\n\t\t\t},\n\t\t\tgetDefaultAggregationName() {\n\t\t\t\treturn \"\";\n\t\t\t}\n\t\t};\n\t}*/\n\tstatic register() {\n\t\t// To be overriden\n\t}\n}\n\nexport type BuildingBlockPropertyDefinition = {\n\ttype: string;\n\tisPublic?: boolean;\n\tdefaultValue?: any;\n\tcomputed?: boolean;\n\trequired?: boolean;\n\t$kind?: string[];\n};\nexport type BuildingBlockMetadataContextDefinition = {\n\ttype: string;\n\tisPublic?: boolean;\n\trequired?: boolean;\n\tcomputed?: boolean;\n\t$Type?: string[];\n\t$kind?: string[];\n};\nexport type BuildingBlockEvent = {};\nexport type BuildingBlockAggregationDefinition = {\n\tisPublic?: boolean;\n\ttype: string;\n\tslot?: string;\n};\ntype CommonBuildingBlockDefinition = {\n\tnamespace: string;\n\tname: string;\n\txmlTag?: string;\n\tfragment?: string;\n\tpublicNamespace?: string;\n\n\tisOpen?: boolean;\n};\nexport type BuildingBlockDefinitionV2 = CommonBuildingBlockDefinition &\n\ttypeof BuildingBlockBase & {\n\t\tapiVersion: 2;\n\t\tmetadata: BuildingBlockMetadata;\n\t};\n\nexport type BuildingBlockDefinitionV1 = CommonBuildingBlockDefinition & {\n\tname: string;\n\tapiVersion?: 1;\n\tcreate?: Function;\n\tgetTemplate?: Function;\n\tmetadata: BuildingBlockMetadata;\n};\nexport type BuildingBlockDefinition = BuildingBlockDefinitionV2 | BuildingBlockDefinitionV1;\nexport type BuildingBlockMetadata = {\n\tevents: Record<string, BuildingBlockEvent>;\n\tproperties: Record<string, BuildingBlockPropertyDefinition>;\n\taggregations: Record<string, BuildingBlockAggregationDefinition>;\n};\n\nconst ensureMetadata = function (target: any): BuildingBlockMetadata {\n\tif (!target.hasOwnProperty(\"metadata\")) {\n\t\ttarget.metadata = deepClone(\n\t\t\ttarget.metadata || {\n\t\t\t\tproperties: {},\n\t\t\t\taggregations: {},\n\t\t\t\tevents: {}\n\t\t\t}\n\t\t);\n\t}\n\treturn target.metadata;\n};\n\n/**\n * Indicates that the property shall be declared as an xml attribute that can be used from the outside of the building block.\n *\n * @param attributeDefinition\n * @returns The decorated property\n */\nexport function xmlAttribute(attributeDefinition: BuildingBlockPropertyDefinition): PropertyDecorator {\n\treturn function (target: BuildingBlockBase, propertyKey: string, propertyDescriptor: TypedPropertyDescriptor<any>) {\n\t\tconst metadata = ensureMetadata(target.constructor);\n\t\tdelete (propertyDescriptor as any).initializer;\n\t\tif (!metadata.properties[propertyKey]) {\n\t\t\tmetadata.properties[propertyKey] = attributeDefinition;\n\t\t}\n\n\t\treturn propertyDescriptor;\n\t} as any;\n}\n\nexport function xmlEvent(): PropertyDecorator {\n\treturn function (target: BuildingBlockBase, propertyKey: string, propertyDescriptor: TypedPropertyDescriptor<any>) {\n\t\tconst metadata = ensureMetadata(target.constructor);\n\t\tdelete (propertyDescriptor as any).initializer;\n\t\tif (!metadata.events[propertyKey]) {\n\t\t\tmetadata.events[propertyKey] = { type: \"Function\" };\n\t\t}\n\n\t\treturn propertyDescriptor;\n\t} as any;\n}\n\nexport function defineBuildingBlock(oBuildingBlockDefinition: CommonBuildingBlockDefinition) {\n\treturn function (classDefinition: any) {\n\t\tensureMetadata(classDefinition);\n\t\tclassDefinition.xmlTag = oBuildingBlockDefinition.name;\n\t\tclassDefinition.namespace = oBuildingBlockDefinition.namespace;\n\t\tclassDefinition.publicNamespace = oBuildingBlockDefinition.publicNamespace;\n\t\tclassDefinition.fragment = oBuildingBlockDefinition.fragment;\n\t\tclassDefinition.isOpen = oBuildingBlockDefinition.isOpen;\n\t\tclassDefinition.apiVersion = 2;\n\t\tclassDefinition.register = function () {\n\t\t\tregisterBuildingBlock(classDefinition);\n\t\t};\n\t};\n}\n"]}

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);
+		};
+	};
+}