@syncbridge/common 0.9.0 → 0.9.2

package/constants.js

@@ -1,4 +1,4 @@
-export const version = '0.9.0';
+export const version = '0.9.2';
 export const CLASS_METADATA = Symbol.for('CLASS_METADATA');
 export const CLASS_TYPE = Symbol.for('CLASS_TYPE');
 export const VARIABLE_CONTAINER = Symbol.for('VARIABLE_CONTAINER');

package/models/metadata/element-component-metadata.d.ts

@@ -10,6 +10,7 @@ export declare class ElementComponentMetadataRecord {
  */
 export declare class ElementComponentMetadata {
     propertyKey?: string;
+    abstract?: boolean;
     uri: string;
     description?: string;
     required?: boolean;

package/models/metadata/element-component-metadata.js

@@ -19,6 +19,14 @@ export { ElementComponentMetadataRecord };
 let ElementComponentMetadata = class ElementComponentMetadata {
     propertyKey;
 };
+__decorate([
+    ApiField({
+        label: 'Abstract',
+        description: 'Determines if the component uri is set in profile or it not. If set true an explicit uri is required.',
+        examples: ['@syncbridge/net:TcpClient', '@syncbridge/sqb:SqbClient'],
+    }),
+    __metadata("design:type", Boolean)
+], ElementComponentMetadata.prototype, "abstract", void 0);
 __decorate([
     ApiField({
         label: 'Class URI',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncbridge/common",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "description": "SyncBridge Common utilities",
   "author": "Panates Inc",
   "license": "MIT",

package/utils/materialize-metadata.d.ts

@@ -3,11 +3,11 @@ import { ProcessorMetadata, Profile } from '../models/index.js';
 /**
  * Materializes metadata from profile.
  */
-export declare function materializeMetadata(profile: Profile): ProcessorMetadata;
+export declare function materializeMetadata(profile: Profile, returnUndefinedComponentsAsAbstract?: boolean): ProcessorMetadata;
 /**
  *
  */
-export declare function materializeMetadataSilent(profile: Profile): {
+export declare function materializeMetadataSilent(profile: Profile, returnUndefinedComponentsAsAbstract?: boolean): {
     metadata: ProcessorMetadata;
     issues?: StackExecutor.Issue[];
 };

package/utils/materialize-metadata.js

@@ -6,8 +6,8 @@ import { ExtensionRegistry } from '../registry/extension-registry.js';
 /**
  * Materializes metadata from profile.
  */
-export function materializeMetadata(profile) {
-    const { metadata, issues } = materializeMetadataSilent(profile);
+export function materializeMetadata(profile, returnUndefinedComponentsAsAbstract) {
+    const { metadata, issues } = materializeMetadataSilent(profile, returnUndefinedComponentsAsAbstract);
     if (issues?.length) {
         const msg = 'Worker profile validation error.\n  ' +
             issues
@@ -27,7 +27,7 @@ export function materializeMetadata(profile) {
 /**
  *
  */
-export function materializeMetadataSilent(profile) {
+export function materializeMetadataSilent(profile, returnUndefinedComponentsAsAbstract) {
     const stackExecutor = new StackExecutor();
     const processorRec = ExtensionRegistry.getProcessor(profile.processorUri);
     const metadata = omitUndefined(clone({
@@ -43,7 +43,7 @@ export function materializeMetadataSilent(profile) {
     }, { deep: 'full' }));
     if (metadata.components) {
         stackExecutor.execute('components', () => {
-            metadata.components = _materializeComponents(stackExecutor, metadata.components, profile);
+            metadata.components = _materializeComponents(stackExecutor, metadata.components, profile, returnUndefinedComponentsAsAbstract);
         });
     }
     if (stackExecutor.issues?.length)
@@ -54,40 +54,52 @@ export function materializeMetadataSilent(profile) {
  *
  * @private
  */
-function _materializeComponents(stackExecutor, srcMetadata, profile) {
+function _materializeComponents(stackExecutor, srcMetadata, profile, returnUndefinedComponentsAsAbstract) {
     const out = {};
     for (const [componentName, metadataComponent,] of Object.entries(srcMetadata)) {
         stackExecutor.execute(componentName, () => {
             /** Check if component defined in profile */
+            let materializedComponent;
             const profileComponent = profile?.components?.[componentName];
             if (!profileComponent) {
-                if (metadataComponent.required)
-                    throw new SbValidationError(`Component "${componentName}" should be configured`);
-                return;
+                if (!returnUndefinedComponentsAsAbstract) {
+                    if (metadataComponent.required)
+                        throw new SbValidationError(`Component "${componentName}" should be configured`);
+                    return;
+                }
+                materializedComponent = {
+                    abstract: true,
+                    uri: metadataComponent.uri,
+                    description: metadataComponent.description,
+                    required: metadataComponent.required,
+                };
+                out[componentName] = materializedComponent;
             }
-            /** istanbul ignore next */
-            if (!profileComponent.uri)
-                throw new SbValidationError(`"uri" property required`);
-            const reg = ExtensionRegistry.getComponent(profileComponent.uri);
-            if (!(profileComponent.uri === metadataComponent.uri ||
-                reg.metadata.interfaces?.includes(metadataComponent.uri)))
-                throw new SbValidationError(`Selected component "${profileComponent.uri}" do not implement ${metadataComponent.uri}.`);
-            const materializedComponent = {
-                uri: profileComponent.uri,
-                ...omit(metadataComponent, ['uri', 'variables']),
-            };
-            out[componentName] = materializedComponent;
-            materializedComponent.variables = merge({}, [reg.metadata.variables || {}, metadataComponent.variables || {}], { deep: 'full' });
-            materializedComponent.variables = sortVariables(materializedComponent.variables);
-            /** Remove ignored variables */
-            for (const [k, variable] of Object.entries(materializedComponent.variables)) {
-                if (variable.ignored)
-                    delete materializedComponent.variables[k];
-            }
-            if (reg.metadata.components) {
-                stackExecutor.execute('components', () => {
-                    materializedComponent.components = _materializeComponents(stackExecutor, reg.metadata.components, profileComponent);
-                });
+            else {
+                /** istanbul ignore next */
+                if (!profileComponent.uri)
+                    throw new SbValidationError(`"uri" property required`);
+                const reg = ExtensionRegistry.getComponent(profileComponent.uri);
+                if (!(profileComponent.uri === metadataComponent.uri ||
+                    reg.metadata.interfaces?.includes(metadataComponent.uri)))
+                    throw new SbValidationError(`Selected component "${profileComponent.uri}" do not implement ${metadataComponent.uri}.`);
+                materializedComponent = {
+                    uri: profileComponent.uri,
+                    ...omit(metadataComponent, ['uri', 'variables']),
+                };
+                materializedComponent.variables = merge({}, [reg.metadata.variables || {}, metadataComponent.variables || {}], { deep: 'full' });
+                materializedComponent.variables = sortVariables(materializedComponent.variables);
+                out[componentName] = materializedComponent;
+                /** Remove ignored variables */
+                for (const [k, variable] of Object.entries(materializedComponent.variables)) {
+                    if (variable.ignored)
+                        delete materializedComponent.variables[k];
+                }
+                if (reg.metadata.components) {
+                    stackExecutor.execute('components', () => {
+                        materializedComponent.components = _materializeComponents(stackExecutor, reg.metadata.components, profileComponent, returnUndefinedComponentsAsAbstract);
+                    });
+                }
             }
         });
     }