feat(message): add unfurlLinks and unfurlMedia methods

Cherry-picked from PR raycharius#130 with bug fixes:
- Fixed duplicate UnfurlLinks enum key (should be UnfurlMedia)
- Fixed unfurlMedia method using wrong Prop (UnfurlLinks → UnfurlMedia)
- Fixed unfurl-media.ts test using wrong Prop references

Closes raycharius#119

Author: james-gre

docs/surfaces/message.md

@@ -33,6 +33,10 @@ Each instance of the `MessageBuilder` object has chainable setter methods for th
 
 `ts` – *String*
 
+`unfurlLinks` - *Boolean*
+
+`unfurlMedia` - *Boolean*
+
 
 ?> **Note:** For an explanation of any one of the parameters, see its corresponding setter method below.
 

src/internal/constants/props.ts

@@ -64,6 +64,8 @@ export enum Prop {
   DeleteOriginal = 'deleteOriginal',
   ResponseType = 'responseType',
   PostAt = 'postAt',
+  UnfurlLinks = 'unfurlLinks',
+  UnfurlMedia = 'unfurlMedia',
   Ephemeral = 'ephemeral',
   InChannel = 'inChannel',
   Ts = 'ts',
@@ -89,4 +91,5 @@ export enum Prop {
   VideoUrl = 'videoUrl',
   MaxFiles = 'maxFiles',
   Filetypes = 'filetypes',
+
 }

src/internal/dto/slack-dto.ts

@@ -66,6 +66,8 @@ export enum Param {
   deleteOriginal = 'delete_original',
   responseType = 'response_type',
   postAt = 'post_at',
+  unfurlLinks = 'unfurl_links',
+  unfurlMedia = 'unfurl_media',
   color = 'color',
   fallback = 'fallback',
   attachments = 'attachments',

src/internal/methods/set-methods.ts

@@ -561,6 +561,32 @@ export abstract class PostAt extends Builder {
   }
 }
 
+export abstract class UnfurlLinks extends Builder {
+  /**
+   * @description Enables (or disables) unfurling of primarily text-based content.
+   *
+   * {@link https://api.slack.com/block-kit|Open Official Slack Block Kit Documentation}
+   * {@link https://www.blockbuilder.dev|Open Block Builder Documentation}
+   */
+
+  public unfurlLinks(unfurlLinks: Settable<boolean>): this {
+    return this.set(unfurlLinks, Prop.UnfurlLinks);
+  }
+}
+
+export abstract class UnfurlMedia extends Builder {
+  /**
+   * @description Enables (or disables) unfurling of primarily text-based content.
+   *
+   * {@link https://api.slack.com/block-kit|Open Official Slack Block Kit Documentation}
+   * {@link https://www.blockbuilder.dev|Open Block Builder Documentation}
+   */
+
+  public unfurlMedia(unfurlMedia: Settable<boolean>): this {
+    return this.set(unfurlMedia, Prop.UnfurlMedia);
+  }
+}
+
 export abstract class PrivateMetaData extends Builder {
   /**
    * @description Defines a string sent back to your server with view and interaction payloads.

src/surfaces/index.ts

@@ -39,6 +39,8 @@ export function HomeTab(params?: HomeTabParams): HomeTabBuilder {
  * @param {string} [params.text] Text to be displayed in the notification on the Message, or in the body, if there are no Blocks available.
  * @param {timestamp} [params.threadTs] Sets the message to be a reply in a thread to the message whose timestamp is passed.
  * @param {timestamp} [params.postAt] Sets a time for the message to be posted, as a scheduled message.
+ * @param {boolean} [params.unfurlLinks] Sets whether Slack should unfurl links in the Message.
+ * @param {boolean} [params.unfurlMedia] Sets whether Slack should unfurl media in the Message.
  *
  * {@link https://docs.slack.dev/messaging/composing|View in Slack API Documentation}
  */

src/surfaces/message.ts

@@ -21,6 +21,8 @@ import {
   GetBlocks,
   GetPreviewUrl,
   PrintPreviewUrl,
+  UnfurlLinks,
+  UnfurlMedia,
 } from '../internal/methods';
 
 import type { SlackBlockDto, SlackDto } from '../internal/dto';
@@ -32,6 +34,8 @@ export interface MessageParams {
   text?: string;
   threadTs?: string;
   ts?: string;
+  unfurlLinks?: boolean;
+  unfurlMedia?: boolean;
 }
 
 export interface MessageBuilder extends AsUser,
@@ -47,6 +51,8 @@ export interface MessageBuilder extends AsUser,
   Text,
   ThreadTs,
   Ts,
+  UnfurlLinks,
+  UnfurlMedia,
   BuildToJSON,
   BuildToObject<SlackMessageDto>,
   GetAttachments,
@@ -85,6 +91,8 @@ applyMixins(MessageBuilder, [
   Text,
   ThreadTs,
   Ts,
+  UnfurlLinks,
+  UnfurlMedia,
   BuildToJSON,
   BuildToObject,
   GetAttachments,

tests/methods/index.ts

@@ -84,3 +84,5 @@ export * from './value';
 export * from './video-url';
 export * from './max-files';
 export * from './filetypes';
+export * from './unfurl-links';
+export * from './unfurl-media';

tests/methods/unfurl-links.ts

@@ -0,0 +1,18 @@
+import { CompositeBuilderClassConfig } from '../test-config-types';
+import { Prop } from '../../src/internal/constants';
+import { methodArgMocks } from '../mocks/method-arg-mocks';
+import { SlackDto } from '../../src/internal';
+import * as checks from '../checks';
+
+export const unfurlLinks = (params: CompositeBuilderClassConfig): void => {
+  const config = {
+    ...params,
+    methodArgMock: methodArgMocks.unfurlLinks,
+    methodName: Prop.UnfurlLinks,
+    propSetterPropName: Prop.UnfurlLinks,
+    slackDtoParamName: SlackDto.mapParam(Prop.UnfurlLinks),
+  };
+
+  checks.settableProperty(config);
+  checks.literalBuild(config);
+};

tests/methods/unfurl-media.ts

@@ -0,0 +1,18 @@
+import { CompositeBuilderClassConfig } from '../test-config-types';
+import { Prop } from '../../src/internal/constants';
+import { methodArgMocks } from '../mocks/method-arg-mocks';
+import { SlackDto } from '../../src/internal';
+import * as checks from '../checks';
+
+export const unfurlMedia = (params: CompositeBuilderClassConfig): void => {
+  const config = {
+    ...params,
+    methodArgMock: methodArgMocks.unfurlMedia,
+    methodName: Prop.UnfurlMedia,
+    propSetterPropName: Prop.UnfurlMedia,
+    slackDtoParamName: SlackDto.mapParam(Prop.UnfurlMedia),
+  };
+
+  checks.settableProperty(config);
+  checks.literalBuild(config);
+};

tests/mocks/method-arg-mocks.ts

@@ -61,6 +61,8 @@ export const methodArgMocks = {
   asUser: methodArgMocksByType.bool,
   threadTs: methodArgMocksByType.string,
   ts: methodArgMocksByType.string,
+  unfurlLinks: methodArgMocksByType.bool,
+  unfurlMedia: methodArgMocksByType.bool,
   replaceOriginal: methodArgMocksByType.bool,
   deleteOriginal: methodArgMocksByType.bool,
   responseType: methodArgMocksByType.ephemeral,