slack-block-builder - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

CHANGELOG.md

 # Change Log
 
+## v1.1.0 – 2020-06-17
+
+* Methods that build a `Surface` object can now be called multiple times. Calling a building method after the initial build does not mutate the object in any way – it just returns the built result. These methods include `buildToJSON`, `buildToObject`, `getBlocks()`, `printPreviewUrl()`.
+* Add links to Slack channels for discussing **Block Builder** to the README.        
+
 ## v1.0.0 – 2020-06-17
@@ -4,0 +9,0 @@

package.json

 {
   "name": "slack-block-builder",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Maintainable code for interactive Slack messages, modals and home tabs. A must-have for the Slack Block Kit framework.",
@@ -13,3 +13,3 @@ "author": {
   },
-  "homepage": "https://github.com/raycharius/slack-block-builder#readme",
+  "homepage": "https://blockbuilder.dev",
   "bugs": {
@@ -16,0 +16,0 @@ "url": "https://github.com/raycharius/slack-block-builder/issues"

README.md

@@ -10,3 +10,3 @@ <p align="center">
 <p align="center">
-    Lightweight, zero-dependency JavasScript library for <strong>Slack Block Kit UI</strong>.
+    Lightweight, zero-dependency JavaScript library for <strong>Slack Block Kit UI</strong>.
     <br />
@@ -34,8 +34,6 @@ <br />
 
-**Block Builder** helps you keep your Slack app code for UI maintainable, testable, and reusable. It has a simple builder syntax inspired by [SwiftUI](https://developer.apple.com/documentation/swiftui) and lets you code the _you_ want to code.
+**Block Builder** helps you keep your Slack app code for UI maintainable, testable, and reusable. It has a simple builder syntax inspired by [SwiftUI](https://developer.apple.com/documentation/swiftui) and lets you code the way _you_ want to code.
 
+### :zap: &nbsp; Features
 
-
-## :zap: &nbsp; Features
-
 * Simple [SwiftUI](https://developer.apple.com/xcode/swiftui/) inspired syntax.
@@ -49,3 +47,3 @@ * In-depth [doc site](https://blockbuilder.dev) at [https://blockbuilder.dev](https://blockbuilder.dev).
 
-## :rocket: &nbsp; Coming Soon
+### :rocket: &nbsp; Coming Soon
 
@@ -58,3 +56,3 @@ * TypeScript type definitions.
 
-## :gift: &nbsp; Benefits
+### :gift: &nbsp; Benefits
 
@@ -68,4 +66,11 @@ * Write three times less code.
 
-## :floppy_disk: &nbsp; Installation 
+### :phone: Let's Talk?
 
+Feedback – love it! Aside from GitHub Issues, there are Slack channels available in popular bot communities to discuss **Block Builder** – we'll see you there! :raised_hands:
+
+* **Slack Community** – [\#block-builder](https://slackcommunity.com)
+* **Bot Developer Hangout** – [\#block-builder](https://community.botkit.ai)
+
+### :floppy_disk: &nbsp; Installation 
+
 #### Using NPM: 
@@ -83,5 +88,5 @@
 
-## :space_invader: &nbsp; Usage
+### :space_invader: &nbsp; Usage
 
-:books: **For full documentation, make sure you head over to [https://blockbuilder.dev](https://blockbuilder.dev).**
+For full documentation, make sure you head over to [https://blockbuilder.dev](https://blockbuilder.dev).
 
@@ -291,3 +296,3 @@
 
-[Bolt for Javascript](https://github.com/SlackAPI/bolt) – A simple framework for building [Slack](https://slack.com) apps, developed by [Slack](https://slack.com) themselves.
+[Bolt for JavaScript](https://github.com/SlackAPI/bolt) – A simple framework for building [Slack](https://slack.com) apps, developed by [Slack](https://slack.com) themselves.
 
@@ -294,0 +299,0 @@ [Node Slack SDK](https://github.com/slackapi/node-slack-sdk) – A great and powerful SDK for building [Slack](https://slack.com) Apps from the ground up.

src/surfaces/home-tab.js

@@ -36,7 +36,11 @@ const { AdvancedSurface } = require('./base');
   build() {
-    const augmentedProps = {
-      blocks: BuilderHelper.getBuilderResults(this.props.blocks),
-    };
+    if (!this.hasBeenBuilt) {
+      const augmentedProps = {
+        blocks: BuilderHelper.getBuilderResults(this.props.blocks),
+      };
 
-    return this.getResult(HomeTabDto, augmentedProps);
+      this.getResult(HomeTabDto, augmentedProps);
+    }
+
+    return this.result;
   }
@@ -43,0 +47,0 @@ }

src/surfaces/message.js

@@ -166,7 +166,11 @@ const { Surface } = require('./base');
   build() {
-    const augmentedProps = {
-      blocks: BuilderHelper.getBuilderResults(this.props.blocks),
-    };
+    if (!this.hasBeenBuilt) {
+      const augmentedProps = {
+        blocks: BuilderHelper.getBuilderResults(this.props.blocks),
+      };
 
-    return this.getResult(MessageDto, augmentedProps);
+      this.getResult(MessageDto, augmentedProps);
+    }
+
+    return this.result;
   }
@@ -173,0 +177,0 @@ }

src/surfaces/modal.js

@@ -117,10 +117,14 @@ const { AdvancedSurface } = require('./base');
   build() {
-    const augmentedProps = {
-      title: BuilderHelper.getPlainTextObject(this.props.title),
-      blocks: BuilderHelper.getBuilderResults(this.props.blocks),
-      close: BuilderHelper.getPlainTextObject(this.props.close),
-      submit: BuilderHelper.getPlainTextObject(this.props.submit),
-    };
+    if (!this.hasBeenBuilt) {
+      const augmentedProps = {
+        title: BuilderHelper.getPlainTextObject(this.props.title),
+        blocks: BuilderHelper.getBuilderResults(this.props.blocks),
+        close: BuilderHelper.getPlainTextObject(this.props.close),
+        submit: BuilderHelper.getPlainTextObject(this.props.submit),
+      };
 
-    return this.getResult(ModalDto, augmentedProps);
+      this.getResult(ModalDto, augmentedProps);
+    }
+
+    return this.result;
   }
@@ -127,0 +131,0 @@ }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

154609

increased by0.59%

Lines of code

3657

increased by0.25%

Number of lines in readme file

305

increased by1.67%

No dependency changes