@webuildbots/webuildbots-sdk 7.2.1 → 8.2.1

package/lib/builder/block/complex-bb.d.ts

@@ -1,6 +1,9 @@
 import { ComplexBlockTypes, ImageAspectRatios, TopElementStyles } from '../../const/block-enums';
 import ItemBuilder from '../item-builder';
 import BlockBuilder from './block-builder';
+/**
+ * @depreciated - Use {@link GalleryBB} instead
+ */
 export default class ComplexBB extends BlockBuilder {
     static readonly ITEM_LIMIT = 10;
     constructor(complexBlockType?: ComplexBlockTypes, topElementStyle?: TopElementStyles, imageAspectRatio?: ImageAspectRatios);

package/lib/builder/block/complex-bb.js

@@ -18,6 +18,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 var block_enums_1 = require("../../const/block-enums");
 var block_builder_1 = __importDefault(require("./block-builder"));
+/**
+ * @depreciated - Use {@link GalleryBB} instead
+ */
 var ComplexBB = /** @class */ (function (_super) {
     __extends(ComplexBB, _super);
     function ComplexBB(complexBlockType, topElementStyle, imageAspectRatio) {

package/lib/builder/block/gallery-bb.d.ts

@@ -0,0 +1,3 @@
+import ComplexBB from './complex-bb';
+export default class GalleryBB extends ComplexBB {
+}

package/lib/builder/block/gallery-bb.js

@@ -0,0 +1,27 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var complex_bb_1 = __importDefault(require("./complex-bb"));
+var GalleryBB = /** @class */ (function (_super) {
+    __extends(GalleryBB, _super);
+    function GalleryBB() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return GalleryBB;
+}(complex_bb_1.default));
+exports.default = GalleryBB;

package/lib/builder/block/text-bb.d.ts

@@ -3,6 +3,7 @@ import Block from '../../interfaces/block';
 import Polylang from '../../interfaces/polylang';
 import Polyphrase from '../../interfaces/polyphrase';
 import BlockBuilder from './block-builder';
+import { DeepPartial } from '../../helpers/helpers-types';
 /**
  * @depreciated - Use {@link BasicBB} instead
  */
@@ -11,4 +12,5 @@ export default class TextBB extends BlockBuilder {
     addText(lang: string, text: string, textKey?: string): this;
     setText(polylang: Polylang, textKey?: string): this;
     setAllText(source: Polyphrase | Block): this;
+    build(): DeepPartial<Block>;
 }

package/lib/builder/block/text-bb.js

@@ -19,6 +19,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var block_enums_1 = require("../../const/block-enums");
 var text_overflow_enums_1 = require("../../const/text-overflow-enums");
 var block_builder_1 = __importDefault(require("./block-builder"));
+var defaultTextKey = 'default';
 function isBlock(arg) {
     return arg.content !== undefined;
 }
@@ -37,7 +38,7 @@ var TextBB = /** @class */ (function (_super) {
     }
     // {@code textKey} is used to identify when the text should be used e.g. sad, happy
     TextBB.prototype.addText = function (lang, text, textKey) {
-        if (textKey === void 0) { textKey = 'default'; }
+        if (textKey === void 0) { textKey = defaultTextKey; }
         if (!this.block.content.text[textKey]) {
             this.block.content.text[textKey] = {};
         }
@@ -45,7 +46,7 @@ var TextBB = /** @class */ (function (_super) {
         return this;
     };
     TextBB.prototype.setText = function (polylang, textKey) {
-        if (textKey === void 0) { textKey = 'default'; }
+        if (textKey === void 0) { textKey = defaultTextKey; }
         for (var _i = 0, _a = Object.keys(polylang); _i < _a.length; _i++) {
             var lang = _a[_i];
             this.addText(lang, polylang[lang], textKey);
@@ -56,6 +57,15 @@ var TextBB = /** @class */ (function (_super) {
         this.block.content.text = isBlock(source) ? source.content.text : source;
         return this;
     };
+    TextBB.prototype.build = function () {
+        var text = this.block.content.text;
+        var defaultPolylang = text[defaultTextKey] || {};
+        var firstTranslation = Object.values(defaultPolylang)[0];
+        if (!firstTranslation) {
+            throw new Error('This block requires at least some default text, you need to call setText(..) or addText(..) with a truthy value for the text');
+        }
+        return _super.prototype.build.call(this);
+    };
     return TextBB;
 }(block_builder_1.default));
 exports.default = TextBB;

package/lib/builder/choice/choice-builder.js

@@ -43,6 +43,9 @@ var ChoiceBuilder = /** @class */ (function () {
         if (this.functionArgs) {
             this.choice.functionArgs = this.functionArgs;
         }
+        if (!this.choice.title) {
+            throw new Error('This block requires a title, you need to call setTitle(..) or addTitle(..) with a truthy value for the title');
+        }
         // Clone here so we an use the same builder twice
         return helpers_types_1.clone(this.choice);
     };

package/lib/builder/response-builder.d.ts

@@ -7,12 +7,13 @@ import Block from '../interfaces/block';
 import { DeepPartial } from '../helpers/helpers-types';
 import { BlockPointer, WebhookResponse } from '..';
 import BlockBuilder from './block/block-builder';
-import { FunctionFailureParams } from '../interfaces/webhook';
+import { FollowUpParams, FunctionFailureParams } from '../interfaces/webhook';
 export default class ResponseBuilder {
     private resp;
     pushBlock(block: DeepPartial<Block> | BlockBuilder): this;
     pushBlockPointer(blockPointer: BlockPointer): this;
     functionFailure(params: FunctionFailureParams): this;
     unsetFunctionForm(): this;
+    setFollowUp(params: FollowUpParams): this;
     build(): WebhookResponse;
 }

package/lib/builder/response-builder.js

@@ -34,6 +34,17 @@ var ResponseBuilder = /** @class */ (function () {
         this.resp.unsetFunctionForm = true;
         return this;
     };
+    ResponseBuilder.prototype.setFollowUp = function (params) {
+        var block = params.block, schedule = params.schedule, _a = params.viaEmail, viaEmail = _a === void 0 ? false : _a, _b = params.cancelExisting, cancelExisting = _b === void 0 ? false : _b, _c = params.blockArgs, blockArgs = _c === void 0 ? {} : _c;
+        this.resp.followUp = {
+            block: block,
+            schedule: schedule,
+            viaEmail: viaEmail,
+            blockArgs: blockArgs,
+            cancelExisting: cancelExisting
+        };
+        return this;
+    };
     ResponseBuilder.prototype.build = function () {
         return this.resp;
     };

package/lib/index.d.ts

@@ -1,4 +1,6 @@
 import BlockBuilder from './builder/block/block-builder';
+import BasicBB from './builder/block/basic-bb';
+import GalleryBB from './builder/block/gallery-bb';
 import ComplexBB from './builder/block/complex-bb';
 import DevSwitchBB from './builder/block/dev-switch-bb';
 import EmailFormTableBB from './builder/block/email-form-table-bb';
@@ -18,4 +20,4 @@ import ItemBuilder from './builder/item-builder';
 import DefinedIB from './builder/defined-ib';
 import ResponseBuilder from './builder/response-builder';
 import { WebhookRequest, WebhookResponse, ResponseUnitType, ResponseUnit, BlockPointer, Client, JWTPayload } from './interfaces/webhook';
-export { BlockBuilder, ComplexBB, FunctionBB, EmailFormTableBB, ImageBB, SelectBB, TextBB, VideoBB, DevSwitchBB, BlockCB, ChoiceBuilder, DefinedCB, DefinedIB, ExtensionCB, LocationCB, PhoneCB, UrlCB, ItemBuilder, WebhookResponse, WebhookRequest, ResponseUnit, ResponseUnitType, BlockPointer, ResponseBuilder, Client, JWTPayload };
+export { BlockBuilder, ComplexBB, FunctionBB, EmailFormTableBB, ImageBB, SelectBB, TextBB, VideoBB, DevSwitchBB, BlockCB, ChoiceBuilder, DefinedCB, DefinedIB, ExtensionCB, LocationCB, PhoneCB, UrlCB, GalleryBB, BasicBB, ItemBuilder, WebhookResponse, WebhookRequest, ResponseUnit, ResponseUnitType, BlockPointer, ResponseBuilder, Client, JWTPayload };

package/lib/index.js

@@ -3,9 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ResponseBuilder = exports.ResponseUnitType = exports.ItemBuilder = exports.UrlCB = exports.PhoneCB = exports.LocationCB = exports.ExtensionCB = exports.DefinedIB = exports.DefinedCB = exports.ChoiceBuilder = exports.BlockCB = exports.DevSwitchBB = exports.VideoBB = exports.TextBB = exports.SelectBB = exports.ImageBB = exports.EmailFormTableBB = exports.FunctionBB = exports.ComplexBB = exports.BlockBuilder = void 0;
+exports.ResponseBuilder = exports.ResponseUnitType = exports.ItemBuilder = exports.BasicBB = exports.GalleryBB = exports.UrlCB = exports.PhoneCB = exports.LocationCB = exports.ExtensionCB = exports.DefinedIB = exports.DefinedCB = exports.ChoiceBuilder = exports.BlockCB = exports.DevSwitchBB = exports.VideoBB = exports.TextBB = exports.SelectBB = exports.ImageBB = exports.EmailFormTableBB = exports.FunctionBB = exports.ComplexBB = exports.BlockBuilder = void 0;
 var block_builder_1 = __importDefault(require("./builder/block/block-builder"));
 exports.BlockBuilder = block_builder_1.default;
+var basic_bb_1 = __importDefault(require("./builder/block/basic-bb"));
+exports.BasicBB = basic_bb_1.default;
+var gallery_bb_1 = __importDefault(require("./builder/block/gallery-bb"));
+exports.GalleryBB = gallery_bb_1.default;
 var complex_bb_1 = __importDefault(require("./builder/block/complex-bb"));
 exports.ComplexBB = complex_bb_1.default;
 var dev_switch_bb_1 = __importDefault(require("./builder/block/dev-switch-bb"));

package/lib/interfaces/webhook.d.ts

@@ -8,6 +8,7 @@ export interface WebhookResponse {
     tryAgain?: boolean;
     errBlockPointer?: BlockPointer;
     botResponse: ResponseUnit[];
+    followUp?: FollowUpParams;
 }
 export interface Client {
     system: {
@@ -44,3 +45,10 @@ export interface FunctionFailureParams {
     tryAgain?: boolean;
     resetForm?: boolean;
 }
+export interface FollowUpParams {
+    block: BlockPointer;
+    schedule: Date;
+    viaEmail?: boolean;
+    blockArgs?: Record<string, any>;
+    cancelExisting?: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webuildbots/webuildbots-sdk",
-  "version": "7.2.1",
+  "version": "8.2.1",
   "description": "webuildbots sdk",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",