slack-block-builder - npm Package Compare versions

Comparing version 1.7.2 to 1.8.0

CHANGELOG.md

 # Change Log
 
+## v1.8.0 – 2020-11-25
+
+* Add `fallback` to `Attachment` object.
+
 ## v1.7.2 – 2020-11-09
@@ -4,0 +8,0 @@

package.json

 {
   "name": "slack-block-builder",
-  "version": "1.7.2",
+  "version": "1.8.0",
   "description": "Maintainable code for interactive Slack messages, modals and home tabs. A must-have for the Slack Block Kit framework.",
@@ -5,0 +5,0 @@ "author": {

src/bits/attachment.js

@@ -11,2 +11,3 @@ const { Bit } = require('./base');
     this.color = params.color;
+    this.fallback = params.fallback;
     this.blocks = params.blocks;
@@ -23,2 +24,3 @@
     this.props.color = params.color;
+    this.props.fallback = params.fallback;
 
@@ -42,2 +44,15 @@ this.finalizeConstruction();
   /**
+   * Sets the plain text summary of the attachment used in clients that don't show formatted text (eg. IRC, mobile notifications).
+   *
+   * {@link https://api.slack.com/reference/messaging/attachments|View in Slack API Documentation}
+   *
+   * @param {string} string
+   * @return {this} The instance on which the method is called
+   */
+
+  fallback(string) {
+    return this.set(string, props.fallback);
+  }
+
+  /**
    * Adds Blocks to the Attachment object
@@ -44,0 +59,0 @@ *

src/types.d.ts

@@ -13,2 +13,3 @@ declare module 'slack-block-builder' {
         color?: string;
+        fallback?: string;
       }
@@ -18,2 +19,3 @@
         color(color: string): this;
+        fallback(fallback: string): this;
         blocks(...blocks: Array<Block.Block | Block.Block[]>): this;
@@ -20,0 +22,0 @@ }

src/utility/constants/param-map.js

@@ -62,2 +62,3 @@ module.exports = {
   color: 'color',
+  fallback: 'fallback',
   attachments: 'attachments',
@@ -64,0 +65,0 @@ dispatchAction: 'dispatch_action',

src/utility/constants/props.js

@@ -66,2 +66,3 @@ module.exports = {
   color: 'color',
+  fallback: 'fallback',
   attachments: 'attachments',
@@ -68,0 +69,0 @@ dispatchAction: 'dispatchAction',

src/utility/lib/builder.js

@@ -48,3 +48,3 @@ const { ValidationHelper } = require('../helpers');
   /**
-   * @protected
+   * @private
    */
@@ -64,3 +64,3 @@
   /**
-   * @protected
+   * @private
    */
@@ -67,0 +67,0 @@

src/utility/validators/default-type-rules.js

@@ -66,2 +66,3 @@ const types = require('./type-validators');
   color: types.isString,
+  fallback: types.isString,
   attachments: types.areAttachments,
@@ -68,0 +69,0 @@ dispatchAction: types.isBool,

src/utility/validators/type-validators.js

@@ -112,4 +112,4 @@ const Validator = require('../lib/validator');
     condition: (value) => new RegExp('([0-2][0-9]:[0-9][0-9])').test(value),
-    message: 'String in the \'HH:mm\' format, where \'HH\' is the 24-hour format of an hour, and \'mm\' is minutes with leading zero'
+    message: 'String in the \'HH:mm\' format, where \'HH\' is the 24-hour format of an hour, and \'mm\' is minutes with leading zero',
   }),
 };

No alert changes

Improved metrics

Total package byte prevSize

184272

increased by0.38%

Lines of code

4461

increased by0.41%

No dependency changes