@syncbridge/common 0.12.6 → 0.13.0

package/constants.js

@@ -1,4 +1,4 @@
-export const version = '0.12.6';
+export const version = '0.13.0';
 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.d.ts

@@ -5,7 +5,7 @@ import { ComponentMetadata } from '../models/index.js';
 import { UseComponent as _UseComponent } from './use-component.decorator.js';
 export declare function Component<T extends ComponentBase>(options: Component.Options): (target: Type<T>) => void;
 export declare namespace Component {
-    type Options = DeepPartial<StrictOmit<ComponentMetadata, 'uri' | 'components' | 'variables' | 'version'>> & {
+    type Options = DeepPartial<StrictOmit<ComponentMetadata, 'classType' | 'className' | 'components' | 'variables' | 'version'>> & {
         className?: string;
     };
     function UseVariables<T extends ComponentBase>(variablesClass?: Type): (target: T, propertyKey: "values") => void;

package/decorators/component.decorator.js

@@ -6,7 +6,7 @@ import { ComponentBase } from '../classes/component-base.js';
 import { CLASS_METADATA, CLASS_TYPE } from '../constants.js';
 import { ComponentMetadata } from '../models/index.js';
 import { resolvePackageJson } from '../utils/locate-package-json.js';
-import { defineOwnMetadata, parseNpmAuthor } from './decorator-helpers.js';
+import { defineOwnMetadata } from './decorator-helpers.js';
 import { UseComponent as _UseComponent } from './use-component.decorator.js';
 import { UseVariables as _UseVariables } from './use-variables.decorator.js';
 const NAME_PATTERN = /^([A-Z][A-Za-z0-9_]*?)(Component)?$/;
@@ -36,12 +36,20 @@ export function Component(options) {
         const packageName = pkgjson.syncbridge?.name || pkgjson.name;
         const uri = packageName + ':' + className;
         const metadata = defineOwnMetadata(target, CLASS_METADATA, {
+            classType: 'component',
             uri,
+            className,
             displayName: className,
             version: pkgjson.version,
             abstract: !!options.abstract,
-            author: parseNpmAuthor(pkgjson.author),
-            ...omit(options, ['uri', 'components', 'variables', 'version']),
+            ...omit(options, [
+                'uri',
+                'classType',
+                'className',
+                'components',
+                'variables',
+                'version',
+            ]),
         });
         const base = Object.getPrototypeOf(target);
         const baseMetadata = Reflect.getMetadata(CLASS_METADATA, base);

package/decorators/decorator-helpers.d.ts

@@ -1,4 +1,2 @@
 import 'reflect-metadata';
-import { AuthorMetadata } from '../models/index.js';
 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,6 +1,5 @@
 import 'reflect-metadata';
 import { merge } from '@jsopen/objects';
-import { AuthorMetadata } from '../models/index.js';
 export function defineOwnMetadata(target, metadataKey, overwrite) {
     let metadata = Reflect.getOwnMetadata(metadataKey, target);
     const sources = [];
@@ -23,24 +22,3 @@ export function defineOwnMetadata(target, metadataKey, overwrite) {
     Reflect.defineMetadata(metadataKey, metadata, target);
     return metadata;
 }
-const AUTHOR_PATTERN = /^\s*([^<(]+?)\s*(?:<([^>]+)>)?\s*(?:\(([^)]+)\))?\s*$/;
-export function parseNpmAuthor(value) {
-    if (!value)
-        return;
-    if (typeof value === 'string') {
-        const m = AUTHOR_PATTERN.exec(value);
-        if (m)
-            return new AuthorMetadata({
-                name: m[1],
-                email: m[2],
-                url: m[3],
-            });
-    }
-    else if (typeof value === 'object') {
-        return new AuthorMetadata({
-            name: value.name,
-            email: value.email,
-            url: value.url,
-        });
-    }
-}

package/decorators/processor.decorator.d.ts

@@ -23,7 +23,7 @@ export declare namespace Processor {
     function OnUpdateProfile<T extends ProcessorBase>(): (target: Type<T>, propertyKey: string | symbol) => void;
 }
 export declare namespace Processor {
-    type Options = DeepPartial<StrictOmit<ProcessorMetadata, 'uri' | 'components' | 'variables' | 'version'>> & {
+    type Options = DeepPartial<StrictOmit<ProcessorMetadata, 'classType' | 'className' | 'components' | 'variables' | 'version'>> & {
         className?: string;
     };
 }

package/decorators/processor.decorator.js

@@ -36,11 +36,20 @@ export function Processor(options) {
         const packageName = pkgjson.syncbridge?.name || pkgjson.name;
         const uri = packageName + ':' + className;
         defineOwnMetadata(target, CLASS_METADATA, {
+            classType: 'processor',
             uri,
+            className,
             displayName: className,
             version: pkgjson.version,
             abstract: !!options?.abstract,
-            ...omit(options, ['uri', 'components', 'variables', 'version']),
+            ...omit(options, [
+                'uri',
+                'classType',
+                'className',
+                'components',
+                'variables',
+                'version',
+            ]),
         });
         target.uri = uri;
         target.packageName = packageName;

package/models/index.d.ts

@@ -2,7 +2,6 @@ export * from './enums/log-level.js';
 export * from './enums/service-status.js';
 export * from './enums/variable-format.enum.js';
 export * from './enums/variable-type.enum.js';
-export * from './metadata/author-metadata.js';
 export * from './metadata/component-metadata.js';
 export * from './metadata/element-component-metadata.js';
 export * from './metadata/element-metadata.js';

package/models/index.js

@@ -2,7 +2,6 @@ export * from './enums/log-level.js';
 export * from './enums/service-status.js';
 export * from './enums/variable-format.enum.js';
 export * from './enums/variable-type.enum.js';
-export * from './metadata/author-metadata.js';
 export * from './metadata/component-metadata.js';
 export * from './metadata/element-component-metadata.js';
 export * from './metadata/element-metadata.js';

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

@@ -4,5 +4,6 @@ import { ElementMetadata } from './element-metadata.js';
  */
 export declare class ComponentMetadata extends ElementMetadata {
     constructor(init?: Partial<ComponentMetadata>);
+    classType: 'component';
     interfaces: string[];
 }

package/models/metadata/component-metadata.js

@@ -9,6 +9,14 @@ let ComponentMetadata = class ComponentMetadata extends ElementMetadata {
         super(init);
     }
 };
+__decorate([
+    ApiField({
+        label: 'Class Type',
+        description: 'Determines the type of the class',
+        fixed: 'component',
+    }),
+    __metadata("design:type", String)
+], ComponentMetadata.prototype, "classType", void 0);
 __decorate([
     ApiField({
         label: 'Interfaces',

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

@@ -1,4 +1,3 @@
-import { AuthorMetadata } from './author-metadata.js';
 import type { ElementComponentMetadataRecord } from './element-component-metadata.js';
 import { VariableMetadataRecord } from './variable-metadata.js';
 /**
@@ -7,12 +6,11 @@ import { VariableMetadataRecord } from './variable-metadata.js';
 export declare class ElementMetadata {
     constructor(init?: Partial<ElementMetadata>);
     abstract?: boolean;
-    uri: string;
-    version?: string;
+    className: string;
+    version: string;
     displayName: string;
     iconUrl?: string;
     description?: string;
-    author: AuthorMetadata;
     variables?: VariableMetadataRecord;
     components?: ElementComponentMetadataRecord;
     tags: string[];

package/models/metadata/element-metadata.js

@@ -1,6 +1,5 @@
 import { __decorate, __metadata } from "tslib";
 import { ApiField, ArrayType, ComplexType } from '@opra/common';
-import { AuthorMetadata } from './author-metadata.js';
 import { VariableMetadataRecord } from './variable-metadata.js';
 /**
  *
@@ -14,17 +13,18 @@ let ElementMetadata = class ElementMetadata {
 };
 __decorate([
     ApiField({
-        label: 'Class URI',
-        description: 'URI of the class',
-        examples: ['@syncbridge/net:TcpClient', '@syncbridge/sqb:SqbClient'],
+        label: 'Class Name',
+        description: 'Computer friendly class name',
+        required: true,
     }),
     __metadata("design:type", String)
-], ElementMetadata.prototype, "uri", void 0);
+], ElementMetadata.prototype, "className", void 0);
 __decorate([
     ApiField({
         label: 'Version',
         description: 'Version of the class',
         examples: ['0.2.1', '2.1.5', '1.18.1-alpha.1'],
+        required: true,
     }),
     __metadata("design:type", String)
 ], ElementMetadata.prototype, "version", void 0);
@@ -50,13 +50,6 @@ __decorate([
     }),
     __metadata("design:type", String)
 ], ElementMetadata.prototype, "description", void 0);
-__decorate([
-    ApiField({
-        label: 'Author',
-        description: 'Author',
-    }),
-    __metadata("design:type", AuthorMetadata)
-], ElementMetadata.prototype, "author", void 0);
 __decorate([
     ApiField({
         label: 'Variables',

package/models/metadata/processor-metadata.d.ts

@@ -1,5 +1,6 @@
 import { ElementMetadata } from './element-metadata.js';
 export declare class ProcessorMetadata extends ElementMetadata {
     constructor(init?: Partial<ProcessorMetadata>);
+    classType: 'processor';
     staticEvents?: Record<string, string>;
 }

package/models/metadata/processor-metadata.js

@@ -1,5 +1,5 @@
 import { __decorate, __metadata } from "tslib";
-import { ComplexType } from '@opra/common';
+import { ApiField, ComplexType } from '@opra/common';
 import { ElementMetadata } from './element-metadata.js';
 let ProcessorMetadata = class ProcessorMetadata extends ElementMetadata {
     constructor(init) {
@@ -7,6 +7,14 @@ let ProcessorMetadata = class ProcessorMetadata extends ElementMetadata {
     }
     staticEvents;
 };
+__decorate([
+    ApiField({
+        label: 'Class Type',
+        description: 'Determines the type of the class',
+        fixed: 'processor',
+    }),
+    __metadata("design:type", String)
+], ProcessorMetadata.prototype, "classType", void 0);
 ProcessorMetadata = __decorate([
     ComplexType(),
     __metadata("design:paramtypes", [Object])

package/package.json

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

package/registry/extension-package.d.ts

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

package/registry/extension-package.js

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

package/utils/materialize-metadata.js

@@ -31,12 +31,12 @@ export function materializeMetadataSilent(profile, options) {
     const stackExecutor = new StackExecutor();
     const processorRec = ExtensionRegistry.getProcessor(profile.processorUri);
     const metadata = omitUndefined(clone({
-        uri: processorRec.metadata.uri,
+        classType: processorRec.metadata.classType,
+        className: processorRec.metadata.className,
         version: processorRec.version,
         displayName: processorRec.metadata.displayName,
         description: processorRec.metadata.description,
         iconUrl: processorRec.metadata.iconUrl,
-        author: processorRec.metadata.author,
         tags: processorRec.metadata.tags,
         variables: processorRec.metadata.variables,
         components: processorRec.metadata.components,

package/utils/normalize-metadata.js

@@ -24,11 +24,11 @@ export async function normalizeProcessorMetadata(metadata) {
 export async function normalizeProcessorMetadataSilent(metadata) {
     const decoder = await getProcMetadataTypeDecoder();
     let cloned = deepClone({
-        uri: metadata.uri,
+        classType: 'processor',
+        className: metadata.className,
         displayName: metadata.displayName,
         description: metadata.description,
         iconUrl: metadata.iconUrl,
-        author: metadata.author,
         tags: metadata.tags,
         abstract: metadata.abstract,
         variables: metadata.variables,
@@ -44,8 +44,10 @@ export async function normalizeProcessorMetadataSilent(metadata) {
     return {
         metadata: value || cloned,
         issues: errors?.map(x => ({
-            ...x.issue,
+            message: x.message,
             severity: 'error',
+            location: x.location,
+            code: 'validation-error:' + x.rule,
         })),
     };
 }
@@ -69,11 +71,11 @@ export async function normalizeComponentMetadata(metadata) {
 export async function normalizeComponentMetadataSilent(metadata) {
     const decoder = await getCompMetadataTypeDecoder();
     let cloned = deepClone({
-        uri: metadata.uri,
+        classType: 'component',
+        className: metadata.className,
         displayName: metadata.displayName,
         description: metadata.description,
         iconUrl: metadata.iconUrl,
-        author: metadata.author,
         interfaces: metadata.interfaces,
         tags: metadata.tags,
         abstract: metadata.abstract,
@@ -90,8 +92,10 @@ export async function normalizeComponentMetadataSilent(metadata) {
     return {
         metadata: value || cloned,
         issues: errors?.map(x => ({
-            ...x.issue,
+            message: x.message,
             severity: 'error',
+            location: x.location,
+            code: 'validation-error:' + x.rule,
         })),
     };
 }

package/models/metadata/author-metadata.d.ts

@@ -1,8 +0,0 @@
-export declare class AuthorMetadata {
-    constructor(init?: Partial<AuthorMetadata>);
-    name?: string;
-    email?: string;
-    url?: string;
-    logoUrl?: string;
-    iconUrl?: string;
-}

package/models/metadata/author-metadata.js

@@ -1,48 +0,0 @@
-import { __decorate, __metadata } from "tslib";
-import { ApiField, ComplexType } from '@opra/common';
-let AuthorMetadata = class AuthorMetadata {
-    constructor(init) {
-        if (init)
-            Object.assign(this, init);
-    }
-};
-__decorate([
-    ApiField({
-        label: 'Name',
-        description: 'Name of the author. This is used to identify the author. ',
-    }),
-    __metadata("design:type", String)
-], AuthorMetadata.prototype, "name", void 0);
-__decorate([
-    ApiField({
-        label: 'Email',
-        description: 'Email of the author',
-    }),
-    __metadata("design:type", String)
-], AuthorMetadata.prototype, "email", void 0);
-__decorate([
-    ApiField({
-        label: 'Url',
-        description: 'Url of the author',
-    }),
-    __metadata("design:type", String)
-], AuthorMetadata.prototype, "url", void 0);
-__decorate([
-    ApiField({
-        label: 'Logo Url',
-        description: 'Url of the author logo. Dimensions should be 800x600, 400x300',
-    }),
-    __metadata("design:type", String)
-], AuthorMetadata.prototype, "logoUrl", void 0);
-__decorate([
-    ApiField({
-        label: 'Logomark Url',
-        description: 'Url of the author logomark. Dimensions should be square',
-    }),
-    __metadata("design:type", String)
-], AuthorMetadata.prototype, "iconUrl", void 0);
-AuthorMetadata = __decorate([
-    ComplexType(),
-    __metadata("design:paramtypes", [Object])
-], AuthorMetadata);
-export { AuthorMetadata };