@syncbridge/common 0.9.4 → 0.9.6

package/constants.js

@@ -1,4 +1,4 @@
-export const version = '0.9.4';
+export const version = '0.9.6';
 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/decorators/component.decorator.js

@@ -34,15 +34,12 @@ export function Component(options) {
         const packageName = pkgjson.syncbridge?.name || pkgjson.name;
         const uri = packageName + ':' + className;
         const metadata = defineOwnMetadata(target, CLASS_METADATA, {
-            mergeBase: true,
-            overwrite: {
-                uri,
-                displayName: className,
-                version: pkgjson.version,
-                abstract: !!options.abstract,
-                author: parseNpmAuthor(pkgjson.author),
-                ...omit(options, ['uri']),
-            },
+            uri,
+            displayName: className,
+            version: pkgjson.version,
+            abstract: !!options.abstract,
+            author: parseNpmAuthor(pkgjson.author),
+            ...omit(options, ['uri']),
         });
         const base = Object.getPrototypeOf(target);
         const baseMetadata = Reflect.getMetadata(CLASS_METADATA, base);

package/decorators/decorator-helpers.d.ts

@@ -1,7 +1,4 @@
 import 'reflect-metadata';
 import { AuthorMetadata } from '../models/index.js';
-export declare function defineOwnMetadata(target: any, metadataKey: string | symbol, options?: {
-    overwrite?: any;
-    mergeBase?: boolean;
-}): any;
+export declare function defineOwnMetadata(target: any, metadataKey: string | symbol, overwrite?: any): any;
 export declare function parseNpmAuthor(value: any): AuthorMetadata | undefined;

package/decorators/decorator-helpers.js

@@ -1,20 +1,18 @@
 import 'reflect-metadata';
 import { merge } from '@jsopen/objects';
 import { AuthorMetadata } from '../models/index.js';
-export function defineOwnMetadata(target, metadataKey, options) {
+export function defineOwnMetadata(target, metadataKey, overwrite) {
     let metadata = Reflect.getOwnMetadata(metadataKey, target);
     const sources = [];
     if (!metadata) {
         metadata = {};
-        if (options?.mergeBase) {
-            const base = Object.getPrototypeOf(target);
-            const baseMetadata = Reflect.getMetadata(metadataKey, base);
-            if (baseMetadata)
-                sources.push(baseMetadata);
-        }
+        const base = Object.getPrototypeOf(target);
+        const baseMetadata = Reflect.getMetadata(metadataKey, base);
+        if (baseMetadata)
+            sources.push(baseMetadata);
     }
-    if (options?.overwrite)
-        sources.push(options?.overwrite);
+    if (overwrite)
+        sources.push(overwrite);
     if (sources.length)
         merge(metadata, sources, {
             deep: 'full',

package/decorators/processor-events.decorator.js

@@ -4,11 +4,8 @@ import { defineOwnMetadata } from './decorator-helpers.js';
 export function OnCreateProfile() {
     return function (target, propertyKey) {
         defineOwnMetadata(target, CLASS_METADATA, {
-            mergeBase: true,
-            overwrite: {
-                staticEvents: {
-                    onCreateProfile: propertyKey,
-                },
+            staticEvents: {
+                onCreateProfile: propertyKey,
             },
         });
     };
@@ -16,11 +13,8 @@ export function OnCreateProfile() {
 export function OnUpdateProfile() {
     return function (target, propertyKey) {
         defineOwnMetadata(target, CLASS_METADATA, {
-            mergeBase: true,
-            overwrite: {
-                staticEvents: {
-                    onUpdateProfile: propertyKey,
-                },
+            staticEvents: {
+                onUpdateProfile: propertyKey,
             },
         });
     };

package/decorators/processor.decorator.js

@@ -35,14 +35,11 @@ export function Processor(options) {
         const packageName = pkgjson.syncbridge?.name || pkgjson.name;
         const uri = packageName + ':' + className;
         defineOwnMetadata(target, CLASS_METADATA, {
-            mergeBase: true,
-            overwrite: {
-                uri,
-                displayName: className,
-                version: pkgjson.version,
-                abstract: !!options.abstract,
-                ...omit(options, ['uri']),
-            },
+            uri,
+            displayName: className,
+            version: pkgjson.version,
+            abstract: !!options.abstract,
+            ...omit(options, ['uri']),
         });
         target.uri = uri;
         target.packageName = packageName;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncbridge/common",
-  "version": "0.9.4",
+  "version": "0.9.6",
   "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,7 +54,7 @@ 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, () => {
@@ -62,9 +62,18 @@ function _materializeComponents(stackExecutor, srcMetadata, 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;
             }
             else {
                 /** istanbul ignore next */
@@ -88,7 +97,7 @@ function _materializeComponents(stackExecutor, srcMetadata, profile) {
                 }
                 if (reg.metadata.components) {
                     stackExecutor.execute('components', () => {
-                        materializedComponent.components = _materializeComponents(stackExecutor, reg.metadata.components, profileComponent);
+                        materializedComponent.components = _materializeComponents(stackExecutor, reg.metadata.components, profileComponent, returnUndefinedComponentsAsAbstract);
                     });
                 }
             }