@bfwk/di-editor - npm Package Compare versions

Comparing version 0.6.29 to 0.6.30

CHANGELOG.md

@@ -6,8 +6,8 @@ # Change Log
 
-## [0.6.29](https://github.com/salesforce/builder-framework/compare/v0.6.28...v0.6.29) (2021-06-14)
+## [0.6.30](https://github.com/salesforce/builder-framework/compare/v0.6.29...v0.6.30) (2021-06-15)
 
 
-### Bug Fixes
+### Features
 
-* initial errors for stateful property sheet @W-7849390 ([#95](https://github.com/salesforce/builder-framework/issues/95)) ([bb492c7](https://github.com/salesforce/builder-framework/commit/bb492c7b88682ca4eacd85f19404c123ff49d449))
+* surface event description and properties @W-9357242 ([#87](https://github.com/salesforce/builder-framework/issues/87)) ([4e7965d](https://github.com/salesforce/builder-framework/commit/4e7965d9aa6af7b4ac49ae252dfe330ffd66e816))
 
@@ -14,0 +14,0 @@

dist/index.js

@@ -120,2 +120,4 @@ import { ObservableCreator, clone, isEqual, WireValueChangeObservers, generateGuid, generateAdapterId, createWireAdapterFactory, configureObservers } from '@bfwk/utils';
             let sourceEventLabel = eventName;
+            let sourceEventDescription = '';
+            let sourceEventPropertyLabels = {};
             const propertyDescription = (await this.sourceSelectors[0]
@@ -126,4 +128,13 @@ .shapeProviderProvider(componentName)
                 const eventSchema = propertyDescription.events[eventName];
-                if (eventSchema && eventSchema.title) {
-                    sourceEventLabel = eventSchema.title;
+                if (eventSchema) {
+                    if (eventSchema.title) {
+                        sourceEventLabel = eventSchema.title;
+                    }
+                    if (eventSchema.description) {
+                        sourceEventDescription = eventSchema.description;
+                    }
+                    // Pass-through properties bag
+                    if (eventSchema.properties) {
+                        sourceEventPropertyLabels = eventSchema.properties;
+                    }
                 }
@@ -134,5 +145,12 @@ }
                 eventLabel: sourceEventLabel,
+                eventDescription: sourceEventDescription,
+                eventPropertyLabels: sourceEventPropertyLabels,
             };
         }
-        return { componentLabel: '', eventLabel: '' };
+        return {
+            componentLabel: '',
+            eventLabel: '',
+            eventDescription: '',
+            eventPropertyLabels: {},
+        };
     }
@@ -139,0 +157,0 @@ async getSourceEventContext(sourceEvent) {

dist/types/di-editor.d.ts

@@ -84,2 +84,4 @@ import { Observable, Guid } from '@bfwk/utils';
     eventLabel: string;
+    eventDescription: string;
+    eventPropertyLabels: {};
 }
@@ -86,0 +88,0 @@ export declare class DIEditor {

package.json

 {
   "name": "@bfwk/di-editor",
-  "version": "0.6.29",
+  "version": "0.6.30",
   "description": "DI Editor",
@@ -31,10 +31,10 @@ "type": "module",
   "dependencies": {
-    "@bfwk/command": "0.6.29",
-    "@bfwk/data-service": "0.6.29",
-    "@bfwk/document-model": "0.6.29",
-    "@bfwk/error-handler": "0.6.29",
-    "@bfwk/instrumentation": "0.6.29",
-    "@bfwk/property-editor": "0.6.29",
-    "@bfwk/pub-sub": "0.6.29",
-    "@bfwk/utils": "0.6.29",
+    "@bfwk/command": "0.6.30",
+    "@bfwk/data-service": "0.6.30",
+    "@bfwk/document-model": "0.6.30",
+    "@bfwk/error-handler": "0.6.30",
+    "@bfwk/instrumentation": "0.6.30",
+    "@bfwk/property-editor": "0.6.30",
+    "@bfwk/pub-sub": "0.6.30",
+    "@bfwk/utils": "0.6.30",
     "@lcem/declarative-type-validator": "0.6.13"
@@ -41,0 +41,0 @@ },

No alert changes

Improved metrics

Total package byte prevSize

38326

increased by2.05%

Lines of code

657

increased by3.14%

Dependency changes

• + Added@bfwk/command@0.6.30(transitive)

• + Added@bfwk/data-service@0.6.30(transitive)

• + Added@bfwk/document-model@0.6.30(transitive)

• + Added@bfwk/error-handler@0.6.30(transitive)

• + Added@bfwk/expression-completion@0.6.30(transitive)

• + Added@bfwk/instrumentation@0.6.30(transitive)

• + Added@bfwk/property-editor@0.6.30(transitive)

• + Added@bfwk/pub-sub@0.6.30(transitive)

• + Added@bfwk/sf-selector@0.6.30(transitive)

• + Added@bfwk/store@0.6.30(transitive)

• + Added@bfwk/undo-redo@0.6.30(transitive)

• + Added@bfwk/utils@0.6.30(transitive)

• - Removed@bfwk/command@0.6.29(transitive)

• - Removed@bfwk/data-service@0.6.29(transitive)

• - Removed@bfwk/document-model@0.6.29(transitive)

• - Removed@bfwk/error-handler@0.6.29(transitive)

• - Removed@bfwk/expression-completion@0.6.29(transitive)

• - Removed@bfwk/instrumentation@0.6.29(transitive)

• - Removed@bfwk/property-editor@0.6.29(transitive)

• - Removed@bfwk/pub-sub@0.6.29(transitive)

• - Removed@bfwk/sf-selector@0.6.29(transitive)

• - Removed@bfwk/store@0.6.29(transitive)

• - Removed@bfwk/undo-redo@0.6.29(transitive)

• - Removed@bfwk/utils@0.6.29(transitive)

• Updated@bfwk/command@0.6.30

• Updated@bfwk/data-service@0.6.30

• Updated@bfwk/document-model@0.6.30

• Updated@bfwk/error-handler@0.6.30

• Updated@bfwk/instrumentation@0.6.30

• Updated@bfwk/property-editor@0.6.30

• Updated@bfwk/pub-sub@0.6.30

• Updated@bfwk/utils@0.6.30