@syncbridge/common 0.9.3 → 0.9.5

package/constants.js

@@ -1,4 +1,4 @@
-export const version = '0.9.3';
+export const version = '0.9.5';
 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncbridge/common",
-  "version": "0.9.3",
+  "version": "0.9.5",
   "description": "SyncBridge Common utilities",
   "author": "Panates Inc",
   "license": "MIT",
@@ -11,8 +11,8 @@
     "caller-callsite": "^6.0.0",
     "reflect-metadata": "^0.2.2",
     "semver": "^7.7.4",
-    "ts-gems": "^3.11.5",
-    "valgen": "^5.19.5"
+    "ts-gems": "^3.11.6",
+    "valgen": "^6.0.3"
   },
   "peerDependencies": {
     "@opra/common": ">=1.17.1 <2"

package/registry/extension-package.d.ts

@@ -26,8 +26,9 @@ export declare abstract class ExtensionBase {
     readonly pkg: ExtensionPackage;
     readonly exportName: string;
     readonly metadata: ElementMetadata;
-    readonly name: string;
+    readonly organization: string;
     readonly packageName: string;
+    readonly className: string;
     protected constructor(pkg: ExtensionPackage, exportName: string, metadata: ElementMetadata, ctor?: Type<BaseElement>);
     get uri(): string;
     get displayName(): string;

package/registry/extension-package.js

@@ -17,15 +17,18 @@ export class ExtensionBase {
     pkg;
     exportName;
     metadata;
-    name;
+    organization;
     packageName;
+    className;
     constructor(pkg, exportName, metadata, ctor) {
         this.pkg = pkg;
         this.exportName = exportName;
         this.metadata = metadata;
         this._ctor = ctor;
-        const [packageName, name] = metadata.uri.split(':');
-        this.name = name;
+        const [pn, className] = metadata.uri.split(':');
+        const [organization, packageName] = pn.split('/');
+        this.className = className;
+        this.organization = (organization || '').replace('@', '');
         this.packageName = packageName;
     }
     get uri() {

package/registry/extension-registry.d.ts

@@ -1,4 +1,5 @@
 import { ResponsiveMap } from '@opra/common';
+import { AsyncEventEmitter } from 'node-events-async';
 import { Type } from 'ts-gems';
 import { ComponentBase } from '../classes/component-base.js';
 import { ProcessorBase } from '../classes/processor-base.js';
@@ -12,7 +13,7 @@ declare const instanceSymbol: unique symbol;
  *
  * @class ExtensionRegistry
  */
-export declare class ExtensionRegistry {
+export declare class ExtensionRegistry extends AsyncEventEmitter {
     protected static [instanceSymbol]: ExtensionRegistry;
     static get packages(): ResponsiveMap<ExtensionPackage[]>;
     static get components(): ResponsiveMap<ComponentExtension[]>;
@@ -28,6 +29,10 @@ export declare class ExtensionRegistry {
     static registerClass<T extends ComponentBase>(ctor: Type<T>): Promise<ComponentExtension>;
     static registerClass<T extends ProcessorBase>(ctor: Type<T>): Promise<ProcessorExtension>;
     static storePackage(pkg: ExtensionPackage): void;
+    static onRegisterPackage(fn: (pkg: ExtensionPackage) => void): void;
+    static onRegisterComponent(fn: (pkg: ComponentExtension) => void): void;
+    static onRegisterProcessor(fn: (pkg: ProcessorExtension) => void): void;
+    constructor();
     protected _resolver: ExtensionRegistry.PackageResolver;
     readonly packages: ResponsiveMap<ExtensionPackage[]>;
     readonly components: ResponsiveMap<ComponentExtension[]>;

package/registry/extension-registry.js

@@ -3,6 +3,7 @@ import path from 'node:path';
 import { pathToFileURL } from 'node:url';
 import { updateErrorMessage } from '@jsopen/objects';
 import { ResponsiveMap } from '@opra/common';
+import { AsyncEventEmitter } from 'node-events-async';
 import semver from 'semver';
 import { SbError } from '../classes/sb-error.js';
 import { CLASS_METADATA, CLASS_TYPE } from '../constants.js';
@@ -19,7 +20,7 @@ const instanceSymbol = Symbol.for('instance');
  *
  * @class ExtensionRegistry
  */
-export class ExtensionRegistry {
+export class ExtensionRegistry extends AsyncEventEmitter {
     static [instanceSymbol] = new ExtensionRegistry();
     static get packages() {
         return this[instanceSymbol].packages;
@@ -60,6 +61,19 @@ export class ExtensionRegistry {
     static storePackage(pkg) {
         return this[instanceSymbol].storePackage(pkg);
     }
+    static onRegisterPackage(fn) {
+        this[instanceSymbol].on('register-package', fn);
+    }
+    static onRegisterComponent(fn) {
+        this[instanceSymbol].on('register-component', fn);
+    }
+    static onRegisterProcessor(fn) {
+        this[instanceSymbol].on('register-processor', fn);
+    }
+    constructor() {
+        super();
+        this.setMaxListeners(1000);
+    }
     _resolver = import.meta.resolve;
     packages = new ResponsiveMap();
     components = new ResponsiveMap();
@@ -243,16 +257,17 @@ export class ExtensionRegistry {
                 else
                     items.push(cmp);
                 /** Store to componentsByClassName */
-                items = this.componentsByClassName.get(cmp.name);
+                items = this.componentsByClassName.get(cmp.className);
                 if (!items) {
                     items = [];
-                    this.componentsByClassName.set(cmp.name, items);
+                    this.componentsByClassName.set(cmp.className, items);
                 }
                 i = items.findIndex(v => v.version === cmp.version);
                 if (i >= 0)
                     items[i] = cmp;
                 else
                     items.push(cmp);
+                this.emitSafe('register-component', cmp);
             }
         }
         if (pkg.processors?.length) {
@@ -272,17 +287,19 @@ export class ExtensionRegistry {
                 else
                     items.push(prc);
                 /** Store to componentsByClassName */
-                items = this.processors.get(prc.name);
+                items = this.processors.get(prc.className);
                 if (!items) {
                     items = [];
-                    this.processorsByClassName.set(prc.name, items);
+                    this.processorsByClassName.set(prc.className, items);
                 }
                 i = items.findIndex(v => v.version === prc.version);
                 if (i >= 0)
                     items[i] = prc;
                 else
                     items.push(prc);
+                this.emitSafe('register-processor', prc);
             }
         }
+        this.emitSafe('register-package', pkg);
     }
 }

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