@voiceflow/base-types 2.32.2 → 2.34.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. package/build/common/models/version/index.d.ts +2 -0
  2. package/build/common/node/buttons.d.ts +13 -1
  3. package/build/common/node/buttons.js +3 -0
  4. package/build/common/node/constants.d.ts +1 -0
  5. package/build/common/node/constants.js +1 -0
  6. package/build/common/node/index.d.ts +4 -2
  7. package/build/common/node/index.js +2 -1
  8. package/build/common/node/interaction.d.ts +13 -1
  9. package/build/common/node/interaction.js +3 -0
  10. package/build/common/node/url.d.ts +12 -0
  11. package/build/common/node/url.js +2 -0
  12. package/build/common/utils/node.d.ts +1 -0
  13. package/build/common/utils/node.js +2 -1
  14. package/build/common/utils/nodeType.d.ts +1 -0
  15. package/build/common/utils/nodeType.js +2 -1
  16. package/build/common/utils/step.d.ts +1 -0
  17. package/build/common/utils/step.js +2 -1
  18. package/build/esm/models/version/index.d.ts +2 -0
  19. package/build/esm/node/buttons.d.ts +13 -1
  20. package/build/esm/node/buttons.js +3 -0
  21. package/build/esm/node/constants.d.ts +1 -0
  22. package/build/esm/node/constants.js +1 -0
  23. package/build/esm/node/index.d.ts +4 -2
  24. package/build/esm/node/index.js +1 -0
  25. package/build/esm/node/interaction.d.ts +13 -1
  26. package/build/esm/node/interaction.js +3 -0
  27. package/build/esm/node/url.d.ts +12 -0
  28. package/build/esm/node/url.js +1 -0
  29. package/build/esm/utils/node.d.ts +1 -0
  30. package/build/esm/utils/node.js +1 -0
  31. package/build/esm/utils/nodeType.d.ts +1 -0
  32. package/build/esm/utils/nodeType.js +1 -0
  33. package/build/esm/utils/step.d.ts +1 -0
  34. package/build/esm/utils/step.js +1 -0
  35. package/package.json +2 -2
@@ -43,4 +43,6 @@ export interface Model<_PlatformData extends PlatformData, Command extends BaseC
43
43
  prototype?: Prototype<Command, Locale>;
44
44
  components?: FolderItem[];
45
45
  platformData: _PlatformData;
46
+ manualSave?: boolean;
47
+ autoSaveFromRestore?: boolean;
46
48
  }
@@ -2,16 +2,28 @@ import { Nullable } from '@voiceflow/common';
2
2
  import { StepButtonsLayout } from '../button';
3
3
  import { NodeType } from './constants';
4
4
  import { BaseNoMatchStepData, BaseNoReplyStepData, BaseStep, BaseStepNoMatch, DataID, NoMatchNoReplyStepPorts, StepIntentScope } from './utils';
5
+ /**
6
+ * @deprecated use `actions` instead
7
+ */
5
8
  export declare enum ButtonAction {
6
9
  URL = "URL",
7
10
  PATH = "PATH",
8
11
  INTENT = "INTENT"
9
12
  }
10
13
  export interface Button extends DataID {
11
- url?: Nullable<string>;
12
14
  name: string;
13
15
  intent?: Nullable<string>;
16
+ /**
17
+ * @deprecated use `actions` instead
18
+ */
19
+ url?: Nullable<string>;
20
+ /**
21
+ * @deprecated use `actions` instead
22
+ */
14
23
  actions: ButtonAction[];
24
+ /**
25
+ * @deprecated use `actions` instead
26
+ */
15
27
  diagramID?: Nullable<string>;
16
28
  }
17
29
  export interface StepData extends StepButtonsLayout, BaseNoReplyStepData, StepIntentScope, BaseNoMatchStepData {
@@ -1,6 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ButtonAction = void 0;
4
+ /**
5
+ * @deprecated use `actions` instead
6
+ */
4
7
  var ButtonAction;
5
8
  (function (ButtonAction) {
6
9
  ButtonAction["URL"] = "URL";
@@ -27,6 +27,7 @@ export declare enum NodeType {
27
27
  PROMPT = "prompt",
28
28
  COMMAND = "command",
29
29
  TRACE = "trace",
30
+ URL = "url",
30
31
  STREAM = "stream",
31
32
  VISUAL = "visual",
32
33
  GENERAL = "general",
@@ -36,6 +36,7 @@ var NodeType;
36
36
  NodeType["COMMAND"] = "command";
37
37
  NodeType["TRACE"] = "trace";
38
38
  // other
39
+ NodeType["URL"] = "url";
39
40
  NodeType["STREAM"] = "stream";
40
41
  NodeType["VISUAL"] = "visual";
41
42
  NodeType["GENERAL"] = "general";
@@ -17,6 +17,7 @@ import * as Random from './random';
17
17
  import * as Set from './set';
18
18
  import * as SetV2 from './setV2';
19
19
  import * as Start from './start';
20
+ import * as Url from './url';
20
21
  import * as Zapier from './zapier';
21
22
  export * as _v1 from './_v1';
22
23
  export * as Api from './api';
@@ -49,9 +50,10 @@ export * as Speak from './speak';
49
50
  export * as Start from './start';
50
51
  export * as Stream from './stream';
51
52
  export * as Text from './text';
53
+ export * as Url from './url';
52
54
  export * as Utils from './utils';
53
55
  export * as Visual from './visual';
54
56
  export * as Zapier from './zapier';
55
- export declare type AnyCommonStep = Set.Step | SetV2.Step | Flow.Step | Component.Step | Start.Step | Code.Step | Intent.Step | Command.Step | Api.Step | Exit.Step | Random.Step | Zapier.Step | GoogleSheets.Step | If.Step | IfV2.Step | General.Step | GoTo.Step | GoToNode.Step | _v1.Step;
56
- export declare type AnyCommonNode = Set.Node | SetV2.Node | Flow.Node | Start.Node | Code.Node | Integration.Node | Exit.Node | Random.Node | General.Node | If.Node | IfV2.Node | GoTo.Node | GoToNode.Node | _v1.Node;
57
+ export declare type AnyCommonStep = Set.Step | SetV2.Step | Flow.Step | Component.Step | Start.Step | Code.Step | Intent.Step | Command.Step | Api.Step | Exit.Step | Random.Step | Zapier.Step | GoogleSheets.Step | If.Step | IfV2.Step | General.Step | GoTo.Step | GoToNode.Step | Url.Step | _v1.Step;
58
+ export declare type AnyCommonNode = Set.Node | SetV2.Node | Flow.Node | Start.Node | Code.Node | Integration.Node | Exit.Node | Random.Node | General.Node | If.Node | IfV2.Node | GoTo.Node | Url.Node | GoToNode.Node | _v1.Node;
57
59
  export declare type AnyCommonCommand = Intent.Command | Command.Command;
@@ -22,7 +22,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
22
22
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
23
23
  };
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.Zapier = exports.Visual = exports.Utils = exports.Text = exports.Stream = exports.Start = exports.Speak = exports.SetV2 = exports.Set = exports.Random = exports.Command = exports.Prompt = exports.Intent = exports.Interaction = exports.Integration = exports.IfV2 = exports.If = exports.GoToNode = exports.GoTo = exports.GoogleSheets = exports.General = exports.Flow = exports.Exit = exports.Directive = exports.Component = exports.Code = exports.CardV2 = exports.Card = exports.CaptureV2 = exports.Capture = exports.Buttons = exports.Api = exports._v1 = void 0;
25
+ exports.Zapier = exports.Visual = exports.Utils = exports.Url = exports.Text = exports.Stream = exports.Start = exports.Speak = exports.SetV2 = exports.Set = exports.Random = exports.Command = exports.Prompt = exports.Intent = exports.Interaction = exports.Integration = exports.IfV2 = exports.If = exports.GoToNode = exports.GoTo = exports.GoogleSheets = exports.General = exports.Flow = exports.Exit = exports.Directive = exports.Component = exports.Code = exports.CardV2 = exports.Card = exports.CaptureV2 = exports.Capture = exports.Buttons = exports.Api = exports._v1 = void 0;
26
26
  exports._v1 = __importStar(require("./_v1"));
27
27
  exports.Api = __importStar(require("./api"));
28
28
  exports.Buttons = __importStar(require("./buttons"));
@@ -54,6 +54,7 @@ exports.Speak = __importStar(require("./speak"));
54
54
  exports.Start = __importStar(require("./start"));
55
55
  exports.Stream = __importStar(require("./stream"));
56
56
  exports.Text = __importStar(require("./text"));
57
+ exports.Url = __importStar(require("./url"));
57
58
  exports.Utils = __importStar(require("./utils"));
58
59
  exports.Visual = __importStar(require("./visual"));
59
60
  exports.Zapier = __importStar(require("./zapier"));
@@ -2,17 +2,29 @@ import { AnyRequestButton } from "../request";
2
2
  import { Nullable } from '@voiceflow/common';
3
3
  import { NodeType } from './constants';
4
4
  import { BaseEvent, BaseNode, BaseNoMatchNodeData, BaseNoMatchStepData, BaseNoReplyNodeData, BaseNoReplyStepData, BaseStep, BaseStepNoMatch, BaseTraceFrame, DeprecatedBaseNodeNoMatch, NodeIntentScope, NodeNextID, NoMatchNoReplyStepPorts, SlotMappings, StepIntentScope, TraceType } from './utils';
5
+ /**
6
+ * @deprecated use `actions` instead
7
+ */
5
8
  export declare enum ChoiceAction {
6
9
  PATH = "PATH",
7
10
  GO_TO = "GO_TO"
8
11
  }
12
+ /**
13
+ * @deprecated use `actions` instead
14
+ */
9
15
  export interface ChoiceGoTo {
10
16
  intentID: Nullable<string>;
11
17
  diagramID?: Nullable<string>;
12
18
  }
13
19
  export interface Choice extends SlotMappings {
14
- goTo?: ChoiceGoTo;
15
20
  intent: string;
21
+ /**
22
+ * @deprecated use `actions` instead
23
+ */
24
+ goTo?: ChoiceGoTo;
25
+ /**
26
+ * @deprecated use `actions` instead
27
+ */
16
28
  action?: ChoiceAction;
17
29
  }
18
30
  export interface StepData extends BaseNoReplyStepData, StepIntentScope, BaseNoMatchStepData {
@@ -1,6 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ChoiceAction = void 0;
4
+ /**
5
+ * @deprecated use `actions` instead
6
+ */
4
7
  var ChoiceAction;
5
8
  (function (ChoiceAction) {
6
9
  ChoiceAction["PATH"] = "PATH";
@@ -0,0 +1,12 @@
1
+ import { NodeType } from './constants';
2
+ import { BaseNode, BaseStep, NodeNextID } from './utils';
3
+ export interface StepData {
4
+ url: string;
5
+ }
6
+ export interface Step<Data = StepData> extends BaseStep<Data> {
7
+ type: NodeType.URL;
8
+ }
9
+ export interface Node extends BaseNode, NodeNextID {
10
+ type: NodeType.URL;
11
+ url: string;
12
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -3,6 +3,7 @@ import * as Node from "../node";
3
3
  export declare const createNodeTypeguard: <R extends BaseModels.BaseNode>(values: R["type"] | R["type"][]) => (value: BaseModels.BaseNode) => value is R;
4
4
  export declare const isV1: (node: BaseModels.BaseNode) => node is Node._v1.Node<Node.Utils.BaseEvent>;
5
5
  export declare const isIf: (value: BaseModels.BaseNode) => value is Node.If.Node;
6
+ export declare const isUrl: (value: BaseModels.BaseNode) => value is Node.Url.Node;
6
7
  export declare const isSet: (value: BaseModels.BaseNode) => value is Node.Set.Node;
7
8
  export declare const isText: (value: BaseModels.BaseNode) => value is Node.Text.Node;
8
9
  export declare const isGoTo: (value: BaseModels.BaseNode) => value is Node.GoTo.Node;
@@ -19,13 +19,14 @@ var __importStar = (this && this.__importStar) || function (mod) {
19
19
  return result;
20
20
  };
21
21
  Object.defineProperty(exports, "__esModule", { value: true });
22
- exports.isIntegrations = exports.isInteraction = exports.isCaptureV2 = exports.isDirective = exports.isGoToNode = exports.isGeneral = exports.isCapture = exports.isRandom = exports.isStream = exports.isCardV2 = exports.isVisual = exports.isSetV2 = exports.isStart = exports.isSpeak = exports.isExit = exports.isCode = exports.isFlow = exports.isIfV2 = exports.isCard = exports.isGoTo = exports.isText = exports.isSet = exports.isIf = exports.isV1 = exports.createNodeTypeguard = void 0;
22
+ exports.isIntegrations = exports.isInteraction = exports.isCaptureV2 = exports.isDirective = exports.isGoToNode = exports.isGeneral = exports.isCapture = exports.isRandom = exports.isStream = exports.isCardV2 = exports.isVisual = exports.isSetV2 = exports.isStart = exports.isSpeak = exports.isExit = exports.isCode = exports.isFlow = exports.isIfV2 = exports.isCard = exports.isGoTo = exports.isText = exports.isSet = exports.isUrl = exports.isIf = exports.isV1 = exports.createNodeTypeguard = void 0;
23
23
  const Node = __importStar(require("../node"));
24
24
  const common_1 = require("@voiceflow/common");
25
25
  exports.createNodeTypeguard = common_1.Utils.typeguard.createTypedTypeguardCreator();
26
26
  const isV1 = (node) => common_1.Utils.object.hasProperty(node, '_v') && node._v === 1;
27
27
  exports.isV1 = isV1;
28
28
  exports.isIf = (0, exports.createNodeTypeguard)(Node.NodeType.IF);
29
+ exports.isUrl = (0, exports.createNodeTypeguard)(Node.NodeType.URL);
29
30
  exports.isSet = (0, exports.createNodeTypeguard)(Node.NodeType.SET);
30
31
  exports.isText = (0, exports.createNodeTypeguard)(Node.NodeType.TEXT);
31
32
  exports.isGoTo = (0, exports.createNodeTypeguard)(Node.NodeType.GOTO);
@@ -1,6 +1,7 @@
1
1
  import * as Node from "../node";
2
2
  export declare const createNodeTypeTypeguard: <R extends Node.NodeType>(values: R | readonly R[] | R[]) => (value?: unknown) => value is R;
3
3
  export declare const isIf: (value?: unknown) => value is Node.NodeType.IF;
4
+ export declare const isUrl: (value?: unknown) => value is Node.NodeType.URL;
4
5
  export declare const isSet: (value?: unknown) => value is Node.NodeType.SET;
5
6
  export declare const isApi: (value?: unknown) => value is Node.NodeType.API;
6
7
  export declare const isGoTo: (value?: unknown) => value is Node.NodeType.GOTO;
@@ -19,11 +19,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
19
19
  return result;
20
20
  };
21
21
  Object.defineProperty(exports, "__esModule", { value: true });
22
- exports.isRuntimeOnly = exports.isGoogleSheets = exports.isIntegrations = exports.isInteraction = exports.isDeprecated = exports.isCaptureV2 = exports.isComponent = exports.isDirective = exports.isGoToNode = exports.isGeneral = exports.isCapture = exports.isButtons = exports.isCommand = exports.isRandom = exports.isZapier = exports.isStream = exports.isIntent = exports.isVisual = exports.isPrompt = exports.isCardV2 = exports.isSetV2 = exports.isStart = exports.isSpeak = exports.isExit = exports.isCode = exports.isFlow = exports.isIfV2 = exports.isCard = exports.isText = exports.isGoTo = exports.isApi = exports.isSet = exports.isIf = exports.createNodeTypeTypeguard = void 0;
22
+ exports.isRuntimeOnly = exports.isGoogleSheets = exports.isIntegrations = exports.isInteraction = exports.isDeprecated = exports.isCaptureV2 = exports.isComponent = exports.isDirective = exports.isGoToNode = exports.isGeneral = exports.isCapture = exports.isButtons = exports.isCommand = exports.isRandom = exports.isZapier = exports.isStream = exports.isIntent = exports.isVisual = exports.isPrompt = exports.isCardV2 = exports.isSetV2 = exports.isStart = exports.isSpeak = exports.isExit = exports.isCode = exports.isFlow = exports.isIfV2 = exports.isCard = exports.isText = exports.isGoTo = exports.isApi = exports.isSet = exports.isUrl = exports.isIf = exports.createNodeTypeTypeguard = void 0;
23
23
  const Node = __importStar(require("../node"));
24
24
  const common_1 = require("@voiceflow/common");
25
25
  exports.createNodeTypeTypeguard = common_1.Utils.typeguard.createTypeguardCreator();
26
26
  exports.isIf = (0, exports.createNodeTypeTypeguard)(Node.NodeType.IF);
27
+ exports.isUrl = (0, exports.createNodeTypeTypeguard)(Node.NodeType.URL);
27
28
  exports.isSet = (0, exports.createNodeTypeTypeguard)(Node.NodeType.SET);
28
29
  exports.isApi = (0, exports.createNodeTypeTypeguard)(Node.NodeType.API);
29
30
  exports.isGoTo = (0, exports.createNodeTypeTypeguard)(Node.NodeType.GOTO);
@@ -2,6 +2,7 @@ import * as BaseModels from "../models";
2
2
  import * as Node from "../node";
3
3
  export declare const createStepTypeguard: <R extends BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>>(values: R["type"] | R["type"][]) => (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is R;
4
4
  export declare const isIf: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.If.Step<Node.If.StepData>;
5
+ export declare const isUrl: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Url.Step<Node.Url.StepData>;
5
6
  export declare const isSet: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Set.Step<Node.Set.StepData>;
6
7
  export declare const isApi: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Api.Step<Node.Api.StepData>;
7
8
  export declare const isText: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Text.Step<Node.Text.StepData>;
@@ -19,11 +19,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
19
19
  return result;
20
20
  };
21
21
  Object.defineProperty(exports, "__esModule", { value: true });
22
- exports.isGoogleSheets = exports.isInteraction = exports.isDeprecated = exports.isCaptureV2 = exports.isComponent = exports.isDirective = exports.isGoToNode = exports.isGeneral = exports.isCapture = exports.isButtons = exports.isCommand = exports.isRandom = exports.isZapier = exports.isStream = exports.isIntent = exports.isVisual = exports.isCardV2 = exports.isPrompt = exports.isSetV2 = exports.isStart = exports.isSpeak = exports.isExit = exports.isCode = exports.isGoTo = exports.isFlow = exports.isIfV2 = exports.isCard = exports.isText = exports.isApi = exports.isSet = exports.isIf = exports.createStepTypeguard = void 0;
22
+ exports.isGoogleSheets = exports.isInteraction = exports.isDeprecated = exports.isCaptureV2 = exports.isComponent = exports.isDirective = exports.isGoToNode = exports.isGeneral = exports.isCapture = exports.isButtons = exports.isCommand = exports.isRandom = exports.isZapier = exports.isStream = exports.isIntent = exports.isVisual = exports.isCardV2 = exports.isPrompt = exports.isSetV2 = exports.isStart = exports.isSpeak = exports.isExit = exports.isCode = exports.isGoTo = exports.isFlow = exports.isIfV2 = exports.isCard = exports.isText = exports.isApi = exports.isSet = exports.isUrl = exports.isIf = exports.createStepTypeguard = void 0;
23
23
  const Node = __importStar(require("../node"));
24
24
  const common_1 = require("@voiceflow/common");
25
25
  exports.createStepTypeguard = common_1.Utils.typeguard.createTypedTypeguardCreator();
26
26
  exports.isIf = (0, exports.createStepTypeguard)(Node.NodeType.IF);
27
+ exports.isUrl = (0, exports.createStepTypeguard)(Node.NodeType.URL);
27
28
  exports.isSet = (0, exports.createStepTypeguard)(Node.NodeType.SET);
28
29
  exports.isApi = (0, exports.createStepTypeguard)(Node.NodeType.API);
29
30
  exports.isText = (0, exports.createStepTypeguard)(Node.NodeType.TEXT);
@@ -43,4 +43,6 @@ export interface Model<_PlatformData extends PlatformData, Command extends BaseC
43
43
  prototype?: Prototype<Command, Locale>;
44
44
  components?: FolderItem[];
45
45
  platformData: _PlatformData;
46
+ manualSave?: boolean;
47
+ autoSaveFromRestore?: boolean;
46
48
  }
@@ -2,16 +2,28 @@ import { Nullable } from '@voiceflow/common';
2
2
  import { StepButtonsLayout } from '../button';
3
3
  import { NodeType } from './constants';
4
4
  import { BaseNoMatchStepData, BaseNoReplyStepData, BaseStep, BaseStepNoMatch, DataID, NoMatchNoReplyStepPorts, StepIntentScope } from './utils';
5
+ /**
6
+ * @deprecated use `actions` instead
7
+ */
5
8
  export declare enum ButtonAction {
6
9
  URL = "URL",
7
10
  PATH = "PATH",
8
11
  INTENT = "INTENT"
9
12
  }
10
13
  export interface Button extends DataID {
11
- url?: Nullable<string>;
12
14
  name: string;
13
15
  intent?: Nullable<string>;
16
+ /**
17
+ * @deprecated use `actions` instead
18
+ */
19
+ url?: Nullable<string>;
20
+ /**
21
+ * @deprecated use `actions` instead
22
+ */
14
23
  actions: ButtonAction[];
24
+ /**
25
+ * @deprecated use `actions` instead
26
+ */
15
27
  diagramID?: Nullable<string>;
16
28
  }
17
29
  export interface StepData extends StepButtonsLayout, BaseNoReplyStepData, StepIntentScope, BaseNoMatchStepData {
@@ -1,3 +1,6 @@
1
+ /**
2
+ * @deprecated use `actions` instead
3
+ */
1
4
  export var ButtonAction;
2
5
  (function (ButtonAction) {
3
6
  ButtonAction["URL"] = "URL";
@@ -27,6 +27,7 @@ export declare enum NodeType {
27
27
  PROMPT = "prompt",
28
28
  COMMAND = "command",
29
29
  TRACE = "trace",
30
+ URL = "url",
30
31
  STREAM = "stream",
31
32
  VISUAL = "visual",
32
33
  GENERAL = "general",
@@ -33,6 +33,7 @@ export var NodeType;
33
33
  NodeType["COMMAND"] = "command";
34
34
  NodeType["TRACE"] = "trace";
35
35
  // other
36
+ NodeType["URL"] = "url";
36
37
  NodeType["STREAM"] = "stream";
37
38
  NodeType["VISUAL"] = "visual";
38
39
  NodeType["GENERAL"] = "general";
@@ -17,6 +17,7 @@ import * as Random from './random';
17
17
  import * as Set from './set';
18
18
  import * as SetV2 from './setV2';
19
19
  import * as Start from './start';
20
+ import * as Url from './url';
20
21
  import * as Zapier from './zapier';
21
22
  export * as _v1 from './_v1';
22
23
  export * as Api from './api';
@@ -49,9 +50,10 @@ export * as Speak from './speak';
49
50
  export * as Start from './start';
50
51
  export * as Stream from './stream';
51
52
  export * as Text from './text';
53
+ export * as Url from './url';
52
54
  export * as Utils from './utils';
53
55
  export * as Visual from './visual';
54
56
  export * as Zapier from './zapier';
55
- export declare type AnyCommonStep = Set.Step | SetV2.Step | Flow.Step | Component.Step | Start.Step | Code.Step | Intent.Step | Command.Step | Api.Step | Exit.Step | Random.Step | Zapier.Step | GoogleSheets.Step | If.Step | IfV2.Step | General.Step | GoTo.Step | GoToNode.Step | _v1.Step;
56
- export declare type AnyCommonNode = Set.Node | SetV2.Node | Flow.Node | Start.Node | Code.Node | Integration.Node | Exit.Node | Random.Node | General.Node | If.Node | IfV2.Node | GoTo.Node | GoToNode.Node | _v1.Node;
57
+ export declare type AnyCommonStep = Set.Step | SetV2.Step | Flow.Step | Component.Step | Start.Step | Code.Step | Intent.Step | Command.Step | Api.Step | Exit.Step | Random.Step | Zapier.Step | GoogleSheets.Step | If.Step | IfV2.Step | General.Step | GoTo.Step | GoToNode.Step | Url.Step | _v1.Step;
58
+ export declare type AnyCommonNode = Set.Node | SetV2.Node | Flow.Node | Start.Node | Code.Node | Integration.Node | Exit.Node | Random.Node | General.Node | If.Node | IfV2.Node | GoTo.Node | Url.Node | GoToNode.Node | _v1.Node;
57
59
  export declare type AnyCommonCommand = Intent.Command | Command.Command;
@@ -29,6 +29,7 @@ export * as Speak from './speak';
29
29
  export * as Start from './start';
30
30
  export * as Stream from './stream';
31
31
  export * as Text from './text';
32
+ export * as Url from './url';
32
33
  export * as Utils from './utils';
33
34
  export * as Visual from './visual';
34
35
  export * as Zapier from './zapier';
@@ -2,17 +2,29 @@ import { AnyRequestButton } from "../request";
2
2
  import { Nullable } from '@voiceflow/common';
3
3
  import { NodeType } from './constants';
4
4
  import { BaseEvent, BaseNode, BaseNoMatchNodeData, BaseNoMatchStepData, BaseNoReplyNodeData, BaseNoReplyStepData, BaseStep, BaseStepNoMatch, BaseTraceFrame, DeprecatedBaseNodeNoMatch, NodeIntentScope, NodeNextID, NoMatchNoReplyStepPorts, SlotMappings, StepIntentScope, TraceType } from './utils';
5
+ /**
6
+ * @deprecated use `actions` instead
7
+ */
5
8
  export declare enum ChoiceAction {
6
9
  PATH = "PATH",
7
10
  GO_TO = "GO_TO"
8
11
  }
12
+ /**
13
+ * @deprecated use `actions` instead
14
+ */
9
15
  export interface ChoiceGoTo {
10
16
  intentID: Nullable<string>;
11
17
  diagramID?: Nullable<string>;
12
18
  }
13
19
  export interface Choice extends SlotMappings {
14
- goTo?: ChoiceGoTo;
15
20
  intent: string;
21
+ /**
22
+ * @deprecated use `actions` instead
23
+ */
24
+ goTo?: ChoiceGoTo;
25
+ /**
26
+ * @deprecated use `actions` instead
27
+ */
16
28
  action?: ChoiceAction;
17
29
  }
18
30
  export interface StepData extends BaseNoReplyStepData, StepIntentScope, BaseNoMatchStepData {
@@ -1,3 +1,6 @@
1
+ /**
2
+ * @deprecated use `actions` instead
3
+ */
1
4
  export var ChoiceAction;
2
5
  (function (ChoiceAction) {
3
6
  ChoiceAction["PATH"] = "PATH";
@@ -0,0 +1,12 @@
1
+ import { NodeType } from './constants';
2
+ import { BaseNode, BaseStep, NodeNextID } from './utils';
3
+ export interface StepData {
4
+ url: string;
5
+ }
6
+ export interface Step<Data = StepData> extends BaseStep<Data> {
7
+ type: NodeType.URL;
8
+ }
9
+ export interface Node extends BaseNode, NodeNextID {
10
+ type: NodeType.URL;
11
+ url: string;
12
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -3,6 +3,7 @@ import * as Node from "../node";
3
3
  export declare const createNodeTypeguard: <R extends BaseModels.BaseNode>(values: R["type"] | R["type"][]) => (value: BaseModels.BaseNode) => value is R;
4
4
  export declare const isV1: (node: BaseModels.BaseNode) => node is Node._v1.Node<Node.Utils.BaseEvent>;
5
5
  export declare const isIf: (value: BaseModels.BaseNode) => value is Node.If.Node;
6
+ export declare const isUrl: (value: BaseModels.BaseNode) => value is Node.Url.Node;
6
7
  export declare const isSet: (value: BaseModels.BaseNode) => value is Node.Set.Node;
7
8
  export declare const isText: (value: BaseModels.BaseNode) => value is Node.Text.Node;
8
9
  export declare const isGoTo: (value: BaseModels.BaseNode) => value is Node.GoTo.Node;
@@ -3,6 +3,7 @@ import { Utils } from '@voiceflow/common';
3
3
  export const createNodeTypeguard = Utils.typeguard.createTypedTypeguardCreator();
4
4
  export const isV1 = (node) => Utils.object.hasProperty(node, '_v') && node._v === 1;
5
5
  export const isIf = createNodeTypeguard(Node.NodeType.IF);
6
+ export const isUrl = createNodeTypeguard(Node.NodeType.URL);
6
7
  export const isSet = createNodeTypeguard(Node.NodeType.SET);
7
8
  export const isText = createNodeTypeguard(Node.NodeType.TEXT);
8
9
  export const isGoTo = createNodeTypeguard(Node.NodeType.GOTO);
@@ -1,6 +1,7 @@
1
1
  import * as Node from "../node";
2
2
  export declare const createNodeTypeTypeguard: <R extends Node.NodeType>(values: R | readonly R[] | R[]) => (value?: unknown) => value is R;
3
3
  export declare const isIf: (value?: unknown) => value is Node.NodeType.IF;
4
+ export declare const isUrl: (value?: unknown) => value is Node.NodeType.URL;
4
5
  export declare const isSet: (value?: unknown) => value is Node.NodeType.SET;
5
6
  export declare const isApi: (value?: unknown) => value is Node.NodeType.API;
6
7
  export declare const isGoTo: (value?: unknown) => value is Node.NodeType.GOTO;
@@ -2,6 +2,7 @@ import * as Node from "../node";
2
2
  import { Utils } from '@voiceflow/common';
3
3
  export const createNodeTypeTypeguard = Utils.typeguard.createTypeguardCreator();
4
4
  export const isIf = createNodeTypeTypeguard(Node.NodeType.IF);
5
+ export const isUrl = createNodeTypeTypeguard(Node.NodeType.URL);
5
6
  export const isSet = createNodeTypeTypeguard(Node.NodeType.SET);
6
7
  export const isApi = createNodeTypeTypeguard(Node.NodeType.API);
7
8
  export const isGoTo = createNodeTypeTypeguard(Node.NodeType.GOTO);
@@ -2,6 +2,7 @@ import * as BaseModels from "../models";
2
2
  import * as Node from "../node";
3
3
  export declare const createStepTypeguard: <R extends BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>>(values: R["type"] | R["type"][]) => (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is R;
4
4
  export declare const isIf: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.If.Step<Node.If.StepData>;
5
+ export declare const isUrl: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Url.Step<Node.Url.StepData>;
5
6
  export declare const isSet: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Set.Step<Node.Set.StepData>;
6
7
  export declare const isApi: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Api.Step<Node.Api.StepData>;
7
8
  export declare const isText: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Text.Step<Node.Text.StepData>;
@@ -2,6 +2,7 @@ import * as Node from "../node";
2
2
  import { Utils } from '@voiceflow/common';
3
3
  export const createStepTypeguard = Utils.typeguard.createTypedTypeguardCreator();
4
4
  export const isIf = createStepTypeguard(Node.NodeType.IF);
5
+ export const isUrl = createStepTypeguard(Node.NodeType.URL);
5
6
  export const isSet = createStepTypeguard(Node.NodeType.SET);
6
7
  export const isApi = createStepTypeguard(Node.NodeType.API);
7
8
  export const isText = createStepTypeguard(Node.NodeType.TEXT);
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@voiceflow/base-types",
3
3
  "description": "Voiceflow base project types",
4
- "version": "2.32.2",
4
+ "version": "2.34.0",
5
5
  "author": "Voiceflow",
6
6
  "bugs": {
7
7
  "url": "https://github.com/voiceflow/libs/issues"
@@ -43,5 +43,5 @@
43
43
  "test:smoke": "exit 0",
44
44
  "test:unit": "exit 0"
45
45
  },
46
- "gitHead": "ddee78fe1b6b1ccf6177364739914014a3720e13"
46
+ "gitHead": "fb65c36898855debdef1d261fc40c030091dbab6"
47
47
  }