@voiceflow/base-types 2.25.2 → 2.27.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 (179) hide show
  1. package/build/common/button/index.d.ts +1 -1
  2. package/build/common/index.d.ts +1 -0
  3. package/build/common/index.js +2 -1
  4. package/build/common/models/apiKey.d.ts +1 -1
  5. package/build/common/models/base/command.d.ts +1 -1
  6. package/build/common/models/base/node.d.ts +1 -1
  7. package/build/common/models/base/note.d.ts +1 -1
  8. package/build/common/models/base/port.d.ts +3 -3
  9. package/build/common/models/base/slot.d.ts +1 -1
  10. package/build/common/models/project/index.d.ts +1 -1
  11. package/build/common/models/project/member.d.ts +1 -1
  12. package/build/common/models/project/prototype.d.ts +1 -1
  13. package/build/common/models/version/index.d.ts +1 -1
  14. package/build/common/models/version/prototype.d.ts +1 -1
  15. package/build/common/node/_v1.d.ts +1 -1
  16. package/build/common/node/api.d.ts +1 -1
  17. package/build/common/node/buttons.d.ts +1 -1
  18. package/build/common/node/capture.d.ts +1 -1
  19. package/build/common/node/captureV2.d.ts +1 -1
  20. package/build/common/node/cardV2.d.ts +1 -1
  21. package/build/common/node/exit.d.ts +2 -2
  22. package/build/common/node/flow.d.ts +1 -1
  23. package/build/common/node/general.d.ts +1 -1
  24. package/build/common/node/goTo.d.ts +1 -1
  25. package/build/common/node/goToBlock.d.ts +1 -1
  26. package/build/common/node/googleSheets.d.ts +1 -1
  27. package/build/common/node/interaction.d.ts +1 -1
  28. package/build/common/node/jump.d.ts +1 -1
  29. package/build/common/node/push.d.ts +1 -1
  30. package/build/common/node/set.d.ts +1 -1
  31. package/build/common/node/setV2.d.ts +1 -1
  32. package/build/common/node/speak.d.ts +1 -1
  33. package/build/common/node/utils/base.d.ts +1 -1
  34. package/build/common/node/utils/command.d.ts +1 -1
  35. package/build/common/node/utils/expression.d.ts +1 -1
  36. package/build/common/node/utils/integration.d.ts +1 -1
  37. package/build/common/node/utils/noMatch.d.ts +1 -1
  38. package/build/common/node/utils/noReply.d.ts +1 -1
  39. package/build/common/node/visual.d.ts +1 -1
  40. package/build/common/project/index.d.ts +1 -1
  41. package/build/common/runtimeLogs/index.d.ts +2 -0
  42. package/build/common/runtimeLogs/index.js +14 -0
  43. package/build/common/runtimeLogs/logs/base.d.ts +21 -0
  44. package/build/common/runtimeLogs/logs/base.js +2 -0
  45. package/build/common/runtimeLogs/logs/global/conversationStart.d.ts +6 -0
  46. package/build/common/runtimeLogs/logs/global/conversationStart.js +2 -0
  47. package/build/common/runtimeLogs/logs/index.d.ts +23 -0
  48. package/build/common/runtimeLogs/logs/index.js +13 -0
  49. package/build/common/runtimeLogs/logs/steps/api.d.ts +33 -0
  50. package/build/common/runtimeLogs/logs/steps/api.js +2 -0
  51. package/build/common/runtimeLogs/logs/steps/buttons.d.ts +16 -0
  52. package/build/common/runtimeLogs/logs/steps/buttons.js +2 -0
  53. package/build/common/runtimeLogs/logs/steps/capture.d.ts +8 -0
  54. package/build/common/runtimeLogs/logs/steps/capture.js +2 -0
  55. package/build/common/runtimeLogs/logs/steps/code.d.ts +9 -0
  56. package/build/common/runtimeLogs/logs/steps/code.js +2 -0
  57. package/build/common/runtimeLogs/logs/steps/condition.d.ts +5 -0
  58. package/build/common/runtimeLogs/logs/steps/condition.js +2 -0
  59. package/build/common/runtimeLogs/logs/steps/customAction.d.ts +7 -0
  60. package/build/common/runtimeLogs/logs/steps/customAction.js +2 -0
  61. package/build/common/runtimeLogs/logs/steps/exit.d.ts +7 -0
  62. package/build/common/runtimeLogs/logs/steps/exit.js +2 -0
  63. package/build/common/runtimeLogs/logs/steps/flow.d.ts +5 -0
  64. package/build/common/runtimeLogs/logs/steps/flow.js +2 -0
  65. package/build/common/runtimeLogs/logs/steps/intent.d.ts +11 -0
  66. package/build/common/runtimeLogs/logs/steps/intent.js +2 -0
  67. package/build/common/runtimeLogs/logs/steps/random.d.ts +5 -0
  68. package/build/common/runtimeLogs/logs/steps/random.js +2 -0
  69. package/build/common/runtimeLogs/logs/steps/set.d.ts +6 -0
  70. package/build/common/runtimeLogs/logs/steps/set.js +2 -0
  71. package/build/common/runtimeLogs/logs/steps/speak.d.ts +5 -0
  72. package/build/common/runtimeLogs/logs/steps/speak.js +2 -0
  73. package/build/common/runtimeLogs/logs/steps/start.d.ts +4 -0
  74. package/build/common/runtimeLogs/logs/steps/start.js +2 -0
  75. package/build/common/runtimeLogs/logs/steps/text.d.ts +5 -0
  76. package/build/common/runtimeLogs/logs/steps/text.js +2 -0
  77. package/build/common/runtimeLogs/runtime/index.d.ts +1 -0
  78. package/build/common/runtimeLogs/runtime/index.js +13 -0
  79. package/build/common/runtimeLogs/runtime/logBuffer.d.ts +19 -0
  80. package/build/common/runtimeLogs/runtime/logBuffer.js +2 -0
  81. package/build/common/runtimeLogs/utils/index.d.ts +2 -0
  82. package/build/common/runtimeLogs/utils/index.js +14 -0
  83. package/build/common/runtimeLogs/utils/logs.d.ts +8 -0
  84. package/build/common/runtimeLogs/utils/logs.js +19 -0
  85. package/build/common/runtimeLogs/utils/types.d.ts +32 -0
  86. package/build/common/runtimeLogs/utils/types.js +36 -0
  87. package/build/common/types.d.ts +9 -4
  88. package/build/common/utils/step.d.ts +29 -29
  89. package/build/common/version/settings.d.ts +1 -1
  90. package/build/esm/button/index.d.ts +1 -1
  91. package/build/esm/index.d.ts +1 -0
  92. package/build/esm/index.js +1 -0
  93. package/build/esm/models/apiKey.d.ts +1 -1
  94. package/build/esm/models/base/command.d.ts +1 -1
  95. package/build/esm/models/base/node.d.ts +1 -1
  96. package/build/esm/models/base/note.d.ts +1 -1
  97. package/build/esm/models/base/port.d.ts +3 -3
  98. package/build/esm/models/base/slot.d.ts +1 -1
  99. package/build/esm/models/project/index.d.ts +1 -1
  100. package/build/esm/models/project/member.d.ts +1 -1
  101. package/build/esm/models/project/prototype.d.ts +1 -1
  102. package/build/esm/models/version/index.d.ts +1 -1
  103. package/build/esm/models/version/prototype.d.ts +1 -1
  104. package/build/esm/node/_v1.d.ts +1 -1
  105. package/build/esm/node/api.d.ts +1 -1
  106. package/build/esm/node/buttons.d.ts +1 -1
  107. package/build/esm/node/capture.d.ts +1 -1
  108. package/build/esm/node/captureV2.d.ts +1 -1
  109. package/build/esm/node/cardV2.d.ts +1 -1
  110. package/build/esm/node/exit.d.ts +2 -2
  111. package/build/esm/node/flow.d.ts +1 -1
  112. package/build/esm/node/general.d.ts +1 -1
  113. package/build/esm/node/goTo.d.ts +1 -1
  114. package/build/esm/node/goToBlock.d.ts +1 -1
  115. package/build/esm/node/googleSheets.d.ts +1 -1
  116. package/build/esm/node/interaction.d.ts +1 -1
  117. package/build/esm/node/jump.d.ts +1 -1
  118. package/build/esm/node/push.d.ts +1 -1
  119. package/build/esm/node/set.d.ts +1 -1
  120. package/build/esm/node/setV2.d.ts +1 -1
  121. package/build/esm/node/speak.d.ts +1 -1
  122. package/build/esm/node/utils/base.d.ts +1 -1
  123. package/build/esm/node/utils/command.d.ts +1 -1
  124. package/build/esm/node/utils/expression.d.ts +1 -1
  125. package/build/esm/node/utils/integration.d.ts +1 -1
  126. package/build/esm/node/utils/noMatch.d.ts +1 -1
  127. package/build/esm/node/utils/noReply.d.ts +1 -1
  128. package/build/esm/node/visual.d.ts +1 -1
  129. package/build/esm/project/index.d.ts +1 -1
  130. package/build/esm/runtimeLogs/index.d.ts +2 -0
  131. package/build/esm/runtimeLogs/index.js +2 -0
  132. package/build/esm/runtimeLogs/logs/base.d.ts +21 -0
  133. package/build/esm/runtimeLogs/logs/base.js +1 -0
  134. package/build/esm/runtimeLogs/logs/global/conversationStart.d.ts +6 -0
  135. package/build/esm/runtimeLogs/logs/global/conversationStart.js +1 -0
  136. package/build/esm/runtimeLogs/logs/index.d.ts +23 -0
  137. package/build/esm/runtimeLogs/logs/index.js +1 -0
  138. package/build/esm/runtimeLogs/logs/steps/api.d.ts +33 -0
  139. package/build/esm/runtimeLogs/logs/steps/api.js +1 -0
  140. package/build/esm/runtimeLogs/logs/steps/buttons.d.ts +16 -0
  141. package/build/esm/runtimeLogs/logs/steps/buttons.js +1 -0
  142. package/build/esm/runtimeLogs/logs/steps/capture.d.ts +8 -0
  143. package/build/esm/runtimeLogs/logs/steps/capture.js +1 -0
  144. package/build/esm/runtimeLogs/logs/steps/code.d.ts +9 -0
  145. package/build/esm/runtimeLogs/logs/steps/code.js +1 -0
  146. package/build/esm/runtimeLogs/logs/steps/condition.d.ts +5 -0
  147. package/build/esm/runtimeLogs/logs/steps/condition.js +1 -0
  148. package/build/esm/runtimeLogs/logs/steps/customAction.d.ts +7 -0
  149. package/build/esm/runtimeLogs/logs/steps/customAction.js +1 -0
  150. package/build/esm/runtimeLogs/logs/steps/exit.d.ts +7 -0
  151. package/build/esm/runtimeLogs/logs/steps/exit.js +1 -0
  152. package/build/esm/runtimeLogs/logs/steps/flow.d.ts +5 -0
  153. package/build/esm/runtimeLogs/logs/steps/flow.js +1 -0
  154. package/build/esm/runtimeLogs/logs/steps/intent.d.ts +11 -0
  155. package/build/esm/runtimeLogs/logs/steps/intent.js +1 -0
  156. package/build/esm/runtimeLogs/logs/steps/random.d.ts +5 -0
  157. package/build/esm/runtimeLogs/logs/steps/random.js +1 -0
  158. package/build/esm/runtimeLogs/logs/steps/set.d.ts +6 -0
  159. package/build/esm/runtimeLogs/logs/steps/set.js +1 -0
  160. package/build/esm/runtimeLogs/logs/steps/speak.d.ts +5 -0
  161. package/build/esm/runtimeLogs/logs/steps/speak.js +1 -0
  162. package/build/esm/runtimeLogs/logs/steps/start.d.ts +4 -0
  163. package/build/esm/runtimeLogs/logs/steps/start.js +1 -0
  164. package/build/esm/runtimeLogs/logs/steps/text.d.ts +5 -0
  165. package/build/esm/runtimeLogs/logs/steps/text.js +1 -0
  166. package/build/esm/runtimeLogs/runtime/index.d.ts +1 -0
  167. package/build/esm/runtimeLogs/runtime/index.js +1 -0
  168. package/build/esm/runtimeLogs/runtime/logBuffer.d.ts +19 -0
  169. package/build/esm/runtimeLogs/runtime/logBuffer.js +1 -0
  170. package/build/esm/runtimeLogs/utils/index.d.ts +2 -0
  171. package/build/esm/runtimeLogs/utils/index.js +2 -0
  172. package/build/esm/runtimeLogs/utils/logs.d.ts +8 -0
  173. package/build/esm/runtimeLogs/utils/logs.js +15 -0
  174. package/build/esm/runtimeLogs/utils/types.d.ts +32 -0
  175. package/build/esm/runtimeLogs/utils/types.js +33 -0
  176. package/build/esm/types.d.ts +9 -4
  177. package/build/esm/utils/step.d.ts +29 -29
  178. package/build/esm/version/settings.d.ts +1 -1
  179. package/package.json +2 -2
@@ -0,0 +1,2 @@
1
+ export * from './logs';
2
+ export * from './runtime';
@@ -0,0 +1,2 @@
1
+ export * from './logs';
2
+ export * from './runtime';
@@ -0,0 +1,21 @@
1
+ import { EmptyObject } from '@voiceflow/common';
2
+ import { GlobalLogKinds, Iso8601Timestamp, LoggingNodeType, PathReference } from '../utils';
3
+ import { LogLevel } from '../utils/logs';
4
+ /** The base log interface. This should not be used directly, use one of the subtypes instead. */
5
+ interface BaseLog {
6
+ kind: string;
7
+ timestamp: Iso8601Timestamp;
8
+ message: EmptyObject;
9
+ level: LogLevel;
10
+ }
11
+ export interface BaseGlobalLog<Kind extends GlobalLogKinds, Message extends EmptyObject, Level extends LogLevel = LogLevel.INFO> extends BaseLog {
12
+ kind: `global.${Kind}`;
13
+ level: Level;
14
+ message: Message;
15
+ }
16
+ export interface BaseStepLog<Kind extends LoggingNodeType, Message extends EmptyObject, Level extends LogLevel = LogLevel.INFO> extends BaseLog {
17
+ kind: `step.${Kind}`;
18
+ level: Level;
19
+ message: PathReference & Message;
20
+ }
21
+ export {};
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,6 @@
1
+ import { GlobalLogKinds } from "../../utils";
2
+ import { BaseGlobalLog } from '../base';
3
+ export declare type ConversationStartLog = BaseGlobalLog<GlobalLogKinds.CONVERSATION_START, {
4
+ versionID: string;
5
+ userID: string;
6
+ }>;
@@ -0,0 +1,23 @@
1
+ import { ConversationStartLog } from './global/conversationStart';
2
+ import { ApiStepLog } from './steps/api';
3
+ import { ButtonsStepLog } from './steps/buttons';
4
+ import { CaptureStepLog } from './steps/capture';
5
+ import { CodeStepLog } from './steps/code';
6
+ import { ConditionStepLog } from './steps/condition';
7
+ import { CustomActionStepLog } from './steps/customAction';
8
+ import { ExitStepLog } from './steps/exit';
9
+ import { FlowStepLog } from './steps/flow';
10
+ import { IntentStepLog } from './steps/intent';
11
+ import { RandomStepLog } from './steps/random';
12
+ import { SetStepLog } from './steps/set';
13
+ import { SpeakStepLog } from './steps/speak';
14
+ import { StartStepLog } from './steps/start';
15
+ import { TextStepLog } from './steps/text';
16
+ export * from './global/conversationStart';
17
+ export { ApiStepLog, ButtonsStepLog, CaptureStepLog, CodeStepLog, ConditionStepLog, CustomActionStepLog, ExitStepLog, FlowStepLog, IntentStepLog, RandomStepLog, SetStepLog, SpeakStepLog, StartStepLog, TextStepLog, };
18
+ /** All possible runtime logs for global events. */
19
+ declare type GlobalLog = ConversationStartLog;
20
+ /** All possible runtime logs for steps. */
21
+ declare type StepLog = ApiStepLog | ButtonsStepLog | CaptureStepLog | CodeStepLog | ConditionStepLog | CustomActionStepLog | ExitStepLog | FlowStepLog | IntentStepLog | RandomStepLog | SetStepLog | SpeakStepLog | StartStepLog | TextStepLog;
22
+ /** All possible runtime logs. */
23
+ export declare type Log = GlobalLog | StepLog;
@@ -0,0 +1 @@
1
+ export * from './global/conversationStart';
@@ -0,0 +1,33 @@
1
+ import { APIBodyType, APIMethod } from "../../../node/api";
2
+ import { LoggingNodeType, LogLevel } from '../../utils';
3
+ import { BaseStepLog } from '../base';
4
+ interface ApiLogMessage {
5
+ request: {
6
+ method: APIMethod;
7
+ url: string;
8
+ };
9
+ response: {
10
+ statusCode: number;
11
+ statusMessage: string;
12
+ };
13
+ }
14
+ interface VerboseApiLogMessage {
15
+ request: {
16
+ headers: Record<string, string>;
17
+ query: Record<string, string>;
18
+ } & ({
19
+ method: Exclude<APIMethod, APIMethod.GET>;
20
+ bodyType: APIBodyType;
21
+ body: string;
22
+ } | {
23
+ method: APIMethod.GET;
24
+ bodyType: null;
25
+ body: null;
26
+ });
27
+ response: {
28
+ headers: Record<string, string>;
29
+ body: string;
30
+ };
31
+ }
32
+ export declare type ApiStepLog = BaseStepLog<LoggingNodeType.API, ApiLogMessage, LogLevel.INFO | LogLevel.ERROR> | BaseStepLog<LoggingNodeType.API, ApiLogMessage & VerboseApiLogMessage, LogLevel.VERBOSE | LogLevel.ERROR>;
33
+ export {};
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,16 @@
1
+ import { Nullable } from '@voiceflow/common';
2
+ import { LoggingNodeType, PathReference } from '../../utils';
3
+ import { BaseStepLog } from '../base';
4
+ interface UrlButtonLogMessage {
5
+ url: Nullable<string>;
6
+ }
7
+ interface FollowPathButtonLogMessage extends UrlButtonLogMessage {
8
+ intent: null;
9
+ path: PathReference;
10
+ }
11
+ interface GoToIntentButtonLogMessage extends UrlButtonLogMessage {
12
+ intent: string;
13
+ path: null;
14
+ }
15
+ export declare type ButtonsStepLog = BaseStepLog<LoggingNodeType.BUTTONS, FollowPathButtonLogMessage | GoToIntentButtonLogMessage>;
16
+ export {};
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,8 @@
1
+ import { LoggingNodeType } from '../../utils';
2
+ import { BaseStepLog } from '../base';
3
+ export declare type CaptureStepLog = BaseStepLog<LoggingNodeType.CAPTURE, {
4
+ slots: Array<{
5
+ utteredValue: string;
6
+ canonicalValue: string;
7
+ }>;
8
+ }>;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,9 @@
1
+ import { LoggingNodeType, LogLevel } from '../../utils';
2
+ import { BaseStepLog } from '../base';
3
+ export declare type CodeStepLog = BaseStepLog<LoggingNodeType.CUSTOM_CODE, {
4
+ data: any;
5
+ error: null;
6
+ }, LogLevel.INFO> | BaseStepLog<LoggingNodeType.CUSTOM_CODE, {
7
+ data: null;
8
+ error: any;
9
+ }, LogLevel.ERROR>;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,5 @@
1
+ import { LoggingNodeType, PathReference } from '../../utils';
2
+ import { BaseStepLog } from '../base';
3
+ export declare type ConditionStepLog = BaseStepLog<LoggingNodeType.CONDITION, {
4
+ path: PathReference;
5
+ }>;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,7 @@
1
+ import { Nullable } from '@voiceflow/common';
2
+ import { LoggingNodeType, PathReference } from '../../utils';
3
+ import { BaseStepLog } from '../base';
4
+ export declare type CustomActionStepLog = BaseStepLog<LoggingNodeType.CUSTOM_ACTION, {
5
+ actionBody: Nullable<string>;
6
+ path: PathReference;
7
+ }>;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,7 @@
1
+ import { EmptyObject } from '@voiceflow/common';
2
+ import { LoggingNodeType } from '../../utils';
3
+ import { BaseStepLog } from '../base';
4
+ export declare type ExitStepLog = BaseStepLog<LoggingNodeType.EXIT, {
5
+ /** The state of the program on exit. */
6
+ state: EmptyObject;
7
+ }>;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,5 @@
1
+ import { LoggingNodeType, PathReference } from '../../utils';
2
+ import { BaseStepLog } from '../base';
3
+ export declare type FlowStepLog = BaseStepLog<LoggingNodeType.FLOW, {
4
+ path: PathReference;
5
+ }>;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,11 @@
1
+ import { LoggingNodeType } from '../../utils';
2
+ import { BaseStepLog } from '../base';
3
+ export declare type IntentStepLog = BaseStepLog<LoggingNodeType.INTENT, {
4
+ intentName: string;
5
+ utterance: string;
6
+ confidence: number;
7
+ slots: Array<{
8
+ utteredValue: string;
9
+ canonicalValue: string;
10
+ }>;
11
+ }>;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,5 @@
1
+ import { LoggingNodeType, PathReference } from '../../utils';
2
+ import { BaseStepLog } from '../base';
3
+ export declare type RandomStepLog = BaseStepLog<LoggingNodeType.RANDOM, {
4
+ path: PathReference;
5
+ }>;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,6 @@
1
+ import { LoggingNodeType } from '../../utils';
2
+ import { BaseStepLog } from '../base';
3
+ export declare type SetStepLog = BaseStepLog<LoggingNodeType.SET, {
4
+ variableName: string;
5
+ expression: string;
6
+ }>;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,5 @@
1
+ import { LoggingNodeType } from '../../utils';
2
+ import { BaseStepLog } from '../base';
3
+ export declare type SpeakStepLog = BaseStepLog<LoggingNodeType.SPEAK, {
4
+ text: string;
5
+ }>;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,4 @@
1
+ import { EmptyObject } from '@voiceflow/common';
2
+ import { LoggingNodeType } from '../../utils';
3
+ import { BaseStepLog } from '../base';
4
+ export declare type StartStepLog = BaseStepLog<LoggingNodeType.START, EmptyObject>;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,5 @@
1
+ import { LoggingNodeType } from '../../utils';
2
+ import { BaseStepLog } from '../base';
3
+ export declare type TextStepLog = BaseStepLog<LoggingNodeType.TEXT, {
4
+ text: string;
5
+ }>;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1 @@
1
+ export * from './logBuffer';
@@ -0,0 +1 @@
1
+ export * from './logBuffer';
@@ -0,0 +1,19 @@
1
+ import { Log } from '../logs';
2
+ /**
3
+ * It acts as a buffer in between the runtime which produces the logs and the service/datastore which consumes the logs.
4
+ * In practice, this will almost always be implemented as part of the runtime itself.
5
+ */
6
+ export interface LogBuffer {
7
+ /** The number of {@link Log} in this {@link LogBuffer}'s buffer. */
8
+ readonly bufferSize: number;
9
+ /** Add {@link Log} to this {@link LogBuffer}'s buffer. */
10
+ push(...logs: Log[]): void;
11
+ /** Dispatch all {@link Log} from this {@link LogBuffer}'s buffer and then remove them. */
12
+ flush(): void;
13
+ /** Remove all {@link Log} from this {@link LogBuffer}'s buffer. */
14
+ clear(): void;
15
+ }
16
+ export interface AsyncLogBuffer extends LogBuffer {
17
+ flush(): void | Promise<void>;
18
+ clear(): void | Promise<void>;
19
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,2 @@
1
+ export * from './logs';
2
+ export * from './types';
@@ -0,0 +1,2 @@
1
+ export * from './logs';
2
+ export * from './types';
@@ -0,0 +1,8 @@
1
+ export declare enum LogLevel {
2
+ ERROR = "error",
3
+ WARN = "warn",
4
+ INFO = "info",
5
+ VERBOSE = "verbose"
6
+ }
7
+ /** Returns the number (non-negative integer) value of `level`. A higher number is more verbose. `0` is the least verbose and most "important". */
8
+ export declare const getValueForLogLevel: (level: LogLevel) => number;
@@ -0,0 +1,15 @@
1
+ export var LogLevel;
2
+ (function (LogLevel) {
3
+ LogLevel["ERROR"] = "error";
4
+ LogLevel["WARN"] = "warn";
5
+ LogLevel["INFO"] = "info";
6
+ LogLevel["VERBOSE"] = "verbose";
7
+ })(LogLevel || (LogLevel = {}));
8
+ const logLevelValues = {
9
+ [LogLevel.ERROR]: 0,
10
+ [LogLevel.WARN]: 1,
11
+ [LogLevel.INFO]: 2,
12
+ [LogLevel.VERBOSE]: 3,
13
+ };
14
+ /** Returns the number (non-negative integer) value of `level`. A higher number is more verbose. `0` is the least verbose and most "important". */
15
+ export const getValueForLogLevel = (level) => logLevelValues[level];
@@ -0,0 +1,32 @@
1
+ export declare type Iso8601Timestamp = string;
2
+ /** Similar to {@link NodeType}, but for runtime logging */
3
+ export declare enum LoggingNodeType {
4
+ TEXT = "text",
5
+ SPEAK = "speak",
6
+ AUDIO = "audio",
7
+ VISUALS = "visuals",
8
+ BUTTONS = "buttons",
9
+ CHOICE = "choice",
10
+ CAPTURE = "capture",
11
+ PROMPT = "prompt",
12
+ INTENT = "intent",
13
+ CONDITION = "condition",
14
+ SET = "set",
15
+ RANDOM = "random",
16
+ FLOW = "flow",
17
+ EXIT = "exit",
18
+ API = "api",
19
+ /** @deprecated Will be removed soon */
20
+ GOOGLE_SHEETS = "google_sheets",
21
+ CUSTOM_CODE = "custom_code",
22
+ CUSTOM_ACTION = "custom_action",
23
+ START = "start"
24
+ }
25
+ export declare enum GlobalLogKinds {
26
+ CONVERSATION_START = "conversation_start"
27
+ }
28
+ /** A reference to a path on the canvas. */
29
+ export interface PathReference {
30
+ componentName: LoggingNodeType;
31
+ stepID: string;
32
+ }
@@ -0,0 +1,33 @@
1
+ /** Similar to {@link NodeType}, but for runtime logging */
2
+ export var LoggingNodeType;
3
+ (function (LoggingNodeType) {
4
+ // Response
5
+ LoggingNodeType["TEXT"] = "text";
6
+ LoggingNodeType["SPEAK"] = "speak";
7
+ LoggingNodeType["AUDIO"] = "audio";
8
+ LoggingNodeType["VISUALS"] = "visuals";
9
+ // User input
10
+ LoggingNodeType["BUTTONS"] = "buttons";
11
+ LoggingNodeType["CHOICE"] = "choice";
12
+ LoggingNodeType["CAPTURE"] = "capture";
13
+ LoggingNodeType["PROMPT"] = "prompt";
14
+ LoggingNodeType["INTENT"] = "intent";
15
+ // Logic
16
+ LoggingNodeType["CONDITION"] = "condition";
17
+ LoggingNodeType["SET"] = "set";
18
+ LoggingNodeType["RANDOM"] = "random";
19
+ LoggingNodeType["FLOW"] = "flow";
20
+ LoggingNodeType["EXIT"] = "exit";
21
+ // Integration
22
+ LoggingNodeType["API"] = "api";
23
+ /** @deprecated Will be removed soon */
24
+ LoggingNodeType["GOOGLE_SHEETS"] = "google_sheets";
25
+ LoggingNodeType["CUSTOM_CODE"] = "custom_code";
26
+ LoggingNodeType["CUSTOM_ACTION"] = "custom_action";
27
+ // Special
28
+ LoggingNodeType["START"] = "start";
29
+ })(LoggingNodeType || (LoggingNodeType = {}));
30
+ export var GlobalLogKinds;
31
+ (function (GlobalLogKinds) {
32
+ GlobalLogKinds["CONVERSATION_START"] = "conversation_start";
33
+ })(GlobalLogKinds || (GlobalLogKinds = {}));
@@ -1,7 +1,12 @@
1
- export declare type Nullable<T> = T | null;
2
- export declare type AnyRecord = Record<string, any>;
3
- export declare type UnknownRecord = Record<string, unknown>;
4
- export declare type EmptyRecord = Record<string, never>;
1
+ export {
2
+ /** @deprecated Use `AnyRecord` from `@voiceflow/common`. */
3
+ AnyRecord,
4
+ /** @deprecated Use `EmptyObject` from `@voiceflow/common`. */
5
+ EmptyObject as EmptyRecord,
6
+ /** @deprecated Use `Nullable` from `@voiceflow/common`. */
7
+ Nullable,
8
+ /** @deprecated Use `Struct` from `@voiceflow/common`. */
9
+ Struct as UnknownRecord, } from '@voiceflow/common';
5
10
  export declare type DeepPartialByKey<T, K extends keyof T> = {
6
11
  [P in keyof T]?: P extends K ? Partial<T[P]> : T[P];
7
12
  };
@@ -1,33 +1,33 @@
1
1
  import * as BaseModels from "../models";
2
2
  import * as Node from "../node";
3
- export declare const createStepTypeguard: <R extends BaseModels.BaseDiagramNode<import("..").AnyRecord>>(values: R["type"] | R["type"][]) => (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is R;
4
- export declare const isIf: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.If.Step<Node.If.StepData>;
5
- export declare const isSet: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.Set.Step<Node.Set.StepData>;
6
- export declare const isApi: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.Api.Step<Node.Api.StepData>;
7
- export declare const isText: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.Text.Step<Node.Text.StepData>;
8
- export declare const isCard: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.Card.Step<Node.Card.StepData>;
9
- export declare const isIfV2: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.IfV2.Step<Node.IfV2.StepData>;
10
- export declare const isFlow: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.Flow.Step<Node.Component.StepData>;
11
- export declare const isCode: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.Code.Step<Node.Code.StepData>;
12
- export declare const isExit: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.Exit.Step<import("..").UnknownRecord>;
13
- export declare const isSpeak: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.Speak.Step<Node.Speak.StepData>;
14
- export declare const isStart: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.Start.Step<Node.Start.StepData>;
15
- export declare const isSetV2: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.SetV2.Step<Node.SetV2.StepData>;
16
- export declare const isPrompt: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.Prompt.Step<Node.Prompt.StepData>;
17
- export declare const isVisual: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.Visual.Step<Node.Visual.StepData>;
18
- export declare const isIntent: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.Intent.Step<Node.Intent.StepData>;
19
- export declare const isStream: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.Stream.Step<Node.Stream.StepData, Node.Stream.StepPorts<Node.Stream.StepDefaultBuiltPorts>>;
20
- export declare const isZapier: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.Zapier.Step<Node.Zapier.StepData>;
21
- export declare const isRandom: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.Random.Step<Node.Random.StepData>;
22
- export declare const isCommand: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.Command.Step<Node.Command.StepData>;
23
- export declare const isButtons: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.Buttons.Step<Node.Buttons.StepData>;
24
- export declare const isCapture: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.Capture.Step<Node.Capture.StepData>;
25
- export declare const isGeneral: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.General.Step<Node.General.StepData<Node.General.AnyTrace>>;
26
- export declare const isDirective: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.Directive.Step<Node.Directive.StepData>;
27
- export declare const isComponent: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.Component.Step<Node.Component.StepData>;
28
- export declare const isCaptureV2: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.CaptureV2.Step<Node.CaptureV2.StepData>;
29
- export declare const isDeprecated: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is BaseModels.BaseDiagramNode<import("..").AnyRecord> & {
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
+ export declare const isIf: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.If.Step<Node.If.StepData>;
5
+ export declare const isSet: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Set.Step<Node.Set.StepData>;
6
+ export declare const isApi: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Api.Step<Node.Api.StepData>;
7
+ export declare const isText: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Text.Step<Node.Text.StepData>;
8
+ export declare const isCard: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Card.Step<Node.Card.StepData>;
9
+ export declare const isIfV2: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.IfV2.Step<Node.IfV2.StepData>;
10
+ export declare const isFlow: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Flow.Step<Node.Component.StepData>;
11
+ export declare const isCode: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Code.Step<Node.Code.StepData>;
12
+ export declare const isExit: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Exit.Step<import("@voiceflow/common").Struct>;
13
+ export declare const isSpeak: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Speak.Step<Node.Speak.StepData>;
14
+ export declare const isStart: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Start.Step<Node.Start.StepData>;
15
+ export declare const isSetV2: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.SetV2.Step<Node.SetV2.StepData>;
16
+ export declare const isPrompt: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Prompt.Step<Node.Prompt.StepData>;
17
+ export declare const isVisual: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Visual.Step<Node.Visual.StepData>;
18
+ export declare const isIntent: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Intent.Step<Node.Intent.StepData>;
19
+ export declare const isStream: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Stream.Step<Node.Stream.StepData, Node.Stream.StepPorts<Node.Stream.StepDefaultBuiltPorts>>;
20
+ export declare const isZapier: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Zapier.Step<Node.Zapier.StepData>;
21
+ export declare const isRandom: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Random.Step<Node.Random.StepData>;
22
+ export declare const isCommand: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Command.Step<Node.Command.StepData>;
23
+ export declare const isButtons: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Buttons.Step<Node.Buttons.StepData>;
24
+ export declare const isCapture: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Capture.Step<Node.Capture.StepData>;
25
+ export declare const isGeneral: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.General.Step<Node.General.StepData<Node.General.AnyTrace>>;
26
+ export declare const isDirective: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Directive.Step<Node.Directive.StepData>;
27
+ export declare const isComponent: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Component.Step<Node.Component.StepData>;
28
+ export declare const isCaptureV2: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.CaptureV2.Step<Node.CaptureV2.StepData>;
29
+ export declare const isDeprecated: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord> & {
30
30
  type: Node.NodeType.DEPRECATED;
31
31
  };
32
- export declare const isInteraction: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.Interaction.Step<Node.Interaction.StepData>;
33
- export declare const isGoogleSheets: (value: BaseModels.BaseDiagramNode<import("..").AnyRecord>) => value is Node.GoogleSheets.Step<Node.GoogleSheets.StepData>;
32
+ export declare const isInteraction: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.Interaction.Step<Node.Interaction.StepData>;
33
+ export declare const isGoogleSheets: (value: BaseModels.BaseDiagramNode<import("@voiceflow/common").AnyRecord>) => value is Node.GoogleSheets.Step<Node.GoogleSheets.StepData>;
@@ -1,5 +1,5 @@
1
1
  import { CardLayout } from "../node/cardV2";
2
- import { Nullable } from "../types";
2
+ import { Nullable } from '@voiceflow/common';
3
3
  import { Utils } from '../node';
4
4
  export declare enum RepeatType {
5
5
  OFF = "OFF",
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.25.2",
4
+ "version": "2.27.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": "e60f8588e20c179f50b5048b25c76f74ab78fb9f"
46
+ "gitHead": "32f0757eae3d1cee6af9220f541feac9d8cd9e75"
47
47
  }