@webuildbots/webuildbots-sdk 8.2.1 → 9.1.0

package/lib/builder/block/unset-form-bb.d.ts

@@ -0,0 +1,4 @@
+import FunctionBB from './function-bb';
+export default class UnsetFormBB<T = any> extends FunctionBB<T> {
+    constructor(fncName?: keyof T, args?: any);
+}

package/lib/builder/block/unset-form-bb.js

@@ -0,0 +1,30 @@
+"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 function_bb_1 = __importDefault(require("./function-bb"));
+var block_enums_1 = require("../../const/block-enums");
+var UnsetFormBB = /** @class */ (function (_super) {
+    __extends(UnsetFormBB, _super);
+    function UnsetFormBB(fncName, args) {
+        var _this = _super.call(this, fncName, args) || this;
+        _this.block.function.type = block_enums_1.FunctionTypes.UNSET_FORM;
+        return _this;
+    }
+    return UnsetFormBB;
+}(function_bb_1.default));
+exports.default = UnsetFormBB;

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

@@ -1,6 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 var helpers_types_1 = require("../../helpers/helpers-types");
+var bson_objectid_1 = __importDefault(require("bson-objectid"));
 var ChoiceBuilder = /** @class */ (function () {
     function ChoiceBuilder(action, session, profile, functionArgs) {
         this.action = action;
@@ -34,6 +38,7 @@ var ChoiceBuilder = /** @class */ (function () {
         return this;
     };
     ChoiceBuilder.prototype.build = function () {
+        this.choice._id = new bson_objectid_1.default().toHexString();
         if (this.session) {
             this.choice.session = this.session;
         }

package/lib/builder/choice/common-cb.d.ts

@@ -1,3 +1,4 @@
 import BlockCB from './block-cb';
 export declare const backToMenu: () => BlockCB;
 export declare const speakToSomeoneCB: () => BlockCB;
+export declare const tryAgainCB: (value: any, args?: any) => BlockCB;

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

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.speakToSomeoneCB = exports.backToMenu = void 0;
+exports.tryAgainCB = exports.speakToSomeoneCB = exports.backToMenu = void 0;
 var block_cb_1 = __importDefault(require("./block-cb"));
 var common_blocks_enums_1 = require("../../const/common-blocks-enums");
 var languages_enums_1 = require("../../const/languages-enums");
@@ -21,3 +21,10 @@ var speakToSomeoneCB = function () {
         .addTitle(languages_enums_1.Languages.WELSH, "Siaradwch â'r tîm");
 };
 exports.speakToSomeoneCB = speakToSomeoneCB;
+var tryAgainCB = function (value, args) {
+    return new block_cb_1.default(value)
+        .addTitle(languages_enums_1.Languages.ENGLISH, 'Try again')
+        .addTitle(languages_enums_1.Languages.WELSH, 'Ceisio eto')
+        .args(args);
+};
+exports.tryAgainCB = tryAgainCB;

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

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

package/lib/builder/response-builder.js

@@ -45,6 +45,10 @@ var ResponseBuilder = /** @class */ (function () {
         };
         return this;
     };
+    ResponseBuilder.prototype.setFileLinkBlock = function (params) {
+        this.resp.fileLinkBlock = params;
+        return this;
+    };
     ResponseBuilder.prototype.build = function () {
         return this.resp;
     };

package/lib/const/block-enums.d.ts

@@ -41,5 +41,6 @@ export declare enum VoiceAction {
     TELL = "tell"
 }
 export declare enum FunctionTypes {
-    EMAIL_FORM_AS_TABLE = "email-form-as-table"
+    EMAIL_FORM_AS_TABLE = "email-form-as-table",
+    UNSET_FORM = "unset-form"
 }

package/lib/const/block-enums.js

@@ -54,4 +54,5 @@ var VoiceAction;
 var FunctionTypes;
 (function (FunctionTypes) {
     FunctionTypes["EMAIL_FORM_AS_TABLE"] = "email-form-as-table";
+    FunctionTypes["UNSET_FORM"] = "unset-form";
 })(FunctionTypes = exports.FunctionTypes || (exports.FunctionTypes = {}));

package/lib/const/media-use-case-enums.d.ts

@@ -0,0 +1,9 @@
+export declare enum MediaUseCase {
+    PLAYER_AVATAR = "player-avatar",
+    MESSAGE_ATTACHMENT = "message-attachment",
+    BLOCK_CONTENT = "block-content",
+    USER_AVATAR = "user-avatar",
+    AGENT_AVATAR = "agent-avatar",
+    CLIENT_MEDIA = "client-media",
+    SELFIE = "selfie"
+}

package/lib/const/media-use-case-enums.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MediaUseCase = void 0;
+var MediaUseCase;
+(function (MediaUseCase) {
+    MediaUseCase["PLAYER_AVATAR"] = "player-avatar";
+    MediaUseCase["MESSAGE_ATTACHMENT"] = "message-attachment";
+    MediaUseCase["BLOCK_CONTENT"] = "block-content";
+    MediaUseCase["USER_AVATAR"] = "user-avatar";
+    MediaUseCase["AGENT_AVATAR"] = "agent-avatar";
+    MediaUseCase["CLIENT_MEDIA"] = "client-media";
+    MediaUseCase["SELFIE"] = "selfie";
+})(MediaUseCase = exports.MediaUseCase || (exports.MediaUseCase = {}));

package/lib/index.d.ts

@@ -4,6 +4,7 @@ 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';
+import UnsetFormBB from './builder/block/unset-form-bb';
 import FunctionBB from './builder/block/function-bb';
 import ImageBB from './builder/block/image-bb';
 import SelectBB from './builder/block/select-bb';
@@ -20,4 +21,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, GalleryBB, BasicBB, ItemBuilder, WebhookResponse, WebhookRequest, ResponseUnit, ResponseUnitType, BlockPointer, ResponseBuilder, Client, JWTPayload };
+export { BlockBuilder, ComplexBB, FunctionBB, EmailFormTableBB, UnsetFormBB, 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,7 +3,7 @@ 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.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;
+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.UnsetFormBB = 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"));
@@ -16,6 +16,8 @@ var dev_switch_bb_1 = __importDefault(require("./builder/block/dev-switch-bb"));
 exports.DevSwitchBB = dev_switch_bb_1.default;
 var email_form_table_bb_1 = __importDefault(require("./builder/block/email-form-table-bb"));
 exports.EmailFormTableBB = email_form_table_bb_1.default;
+var unset_form_bb_1 = __importDefault(require("./builder/block/unset-form-bb"));
+exports.UnsetFormBB = unset_form_bb_1.default;
 var function_bb_1 = __importDefault(require("./builder/block/function-bb"));
 exports.FunctionBB = function_bb_1.default;
 var image_bb_1 = __importDefault(require("./builder/block/image-bb"));

package/lib/interfaces/webhook.d.ts

@@ -1,7 +1,9 @@
+/// <reference types="node" />
 import Block from './block';
 import User from './user';
 import WBBEvent from './wbb-event';
 import { DeepPartial } from '../helpers/helpers-types';
+import { MediaUseCase } from '../const/media-use-case-enums';
 export interface WebhookResponse {
     profiling?: any;
     unsetFunctionForm?: boolean;
@@ -9,6 +11,7 @@ export interface WebhookResponse {
     errBlockPointer?: BlockPointer;
     botResponse: ResponseUnit[];
     followUp?: FollowUpParams;
+    fileLinkBlock?: FileLinkBlockParams;
 }
 export interface Client {
     system: {
@@ -52,3 +55,10 @@ export interface FollowUpParams {
     blockArgs?: Record<string, any>;
     cancelExisting?: boolean;
 }
+export interface FileLinkBlockParams {
+    blockId: string;
+    args?: Record<string, any>;
+    clientName: string;
+    mediaOptions?: MediaUseCase;
+    file?: Buffer;
+}

package/package.json

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