@voiceflow/base-types 2.47.0 → 2.48.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 (27) hide show
  1. package/build/common/runtimeLogs/logs/base.d.ts +3 -3
  2. package/build/common/runtimeLogs/logs/global/nluIntentResolved.d.ts +12 -0
  3. package/build/common/runtimeLogs/logs/global/nluIntentResolved.js +2 -0
  4. package/build/common/runtimeLogs/logs/kinds.d.ts +2 -1
  5. package/build/common/runtimeLogs/logs/kinds.js +1 -0
  6. package/build/common/runtimeLogs/logs/logs.d.ts +2 -1
  7. package/build/common/runtimeLogs/logs/steps/api.d.ts +2 -2
  8. package/build/common/runtimeLogs/logs/steps/capture.d.ts +2 -6
  9. package/build/common/runtimeLogs/logs/steps/code.d.ts +3 -9
  10. package/build/common/runtimeLogs/logs/steps/flow.d.ts +3 -1
  11. package/build/common/runtimeLogs/utils/logs.d.ts +1 -0
  12. package/build/common/runtimeLogs/utils/logs.js +2 -1
  13. package/build/common/runtimeLogs/utils/types.d.ts +6 -5
  14. package/build/esm/runtimeLogs/logs/base.d.ts +3 -3
  15. package/build/esm/runtimeLogs/logs/global/nluIntentResolved.d.ts +12 -0
  16. package/build/esm/runtimeLogs/logs/global/nluIntentResolved.js +1 -0
  17. package/build/esm/runtimeLogs/logs/kinds.d.ts +2 -1
  18. package/build/esm/runtimeLogs/logs/kinds.js +1 -0
  19. package/build/esm/runtimeLogs/logs/logs.d.ts +2 -1
  20. package/build/esm/runtimeLogs/logs/steps/api.d.ts +2 -2
  21. package/build/esm/runtimeLogs/logs/steps/capture.d.ts +2 -6
  22. package/build/esm/runtimeLogs/logs/steps/code.d.ts +3 -9
  23. package/build/esm/runtimeLogs/logs/steps/flow.d.ts +3 -1
  24. package/build/esm/runtimeLogs/utils/logs.d.ts +1 -0
  25. package/build/esm/runtimeLogs/utils/logs.js +1 -0
  26. package/build/esm/runtimeLogs/utils/types.d.ts +6 -5
  27. package/package.json +3 -3
@@ -1,5 +1,5 @@
1
1
  import { EmptyObject } from '@voiceflow/common';
2
- import { Iso8601Timestamp, PathReference } from '../utils';
2
+ import { DEFAULT_LOG_LEVEL, Iso8601Timestamp, PathReference } from '../utils';
3
3
  import { GlobalLogKind, StepLogKind } from './kinds';
4
4
  import { LogLevel } from './levels';
5
5
  /** The base log interface. This should not be used directly, use one of the subtypes instead. */
@@ -9,12 +9,12 @@ interface BaseLog {
9
9
  message: EmptyObject;
10
10
  level: LogLevel;
11
11
  }
12
- export interface BaseGlobalLog<Kind extends GlobalLogKind, Message extends EmptyObject, Level extends LogLevel = LogLevel.INFO> extends BaseLog {
12
+ export interface BaseGlobalLog<Kind extends GlobalLogKind, Message extends EmptyObject, Level extends LogLevel = typeof DEFAULT_LOG_LEVEL> extends BaseLog {
13
13
  kind: `global.${Kind}`;
14
14
  level: Level;
15
15
  message: Message;
16
16
  }
17
- export interface BaseStepLog<Kind extends StepLogKind, Message extends EmptyObject, Level extends LogLevel = LogLevel.INFO> extends BaseLog {
17
+ export interface BaseStepLog<Kind extends StepLogKind, Message extends EmptyObject, Level extends LogLevel = typeof DEFAULT_LOG_LEVEL> extends BaseLog {
18
18
  kind: `step.${Kind}`;
19
19
  level: Level;
20
20
  message: PathReference & Message;
@@ -0,0 +1,12 @@
1
+ import { BaseGlobalLog } from '../base';
2
+ import { GlobalLogKind } from '../kinds';
3
+ interface Entity {
4
+ value: string;
5
+ }
6
+ export declare type NluIntentResolvedLog = BaseGlobalLog<GlobalLogKind.NLU_INTENT_RESOLVED, {
7
+ resolvedIntent: string;
8
+ confidence: number;
9
+ utterance: string;
10
+ entities: Record<string, Entity>;
11
+ }>;
12
+ export {};
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -25,7 +25,8 @@ export declare enum StepLogKind {
25
25
  START = "start"
26
26
  }
27
27
  export declare enum GlobalLogKind {
28
- CONVERSATION_START = "conversation_start"
28
+ CONVERSATION_START = "conversation_start",
29
+ NLU_INTENT_RESOLVED = "nlu.intent_resolved"
29
30
  }
30
31
  declare const NODE_TYPE_TO_STEP_LOG_KIND: {
31
32
  readonly text: StepLogKind.TEXT;
@@ -36,6 +36,7 @@ var StepLogKind;
36
36
  var GlobalLogKind;
37
37
  (function (GlobalLogKind) {
38
38
  GlobalLogKind["CONVERSATION_START"] = "conversation_start";
39
+ GlobalLogKind["NLU_INTENT_RESOLVED"] = "nlu.intent_resolved";
39
40
  })(GlobalLogKind = exports.GlobalLogKind || (exports.GlobalLogKind = {}));
40
41
  const NODE_TYPE_TO_STEP_LOG_KIND = {
41
42
  [node_1.NodeType.TEXT]: StepLogKind.TEXT,
@@ -1,4 +1,5 @@
1
1
  import { ConversationStartLog } from './global/conversationStart';
2
+ import { NluIntentResolvedLog } from './global/nluIntentResolved';
2
3
  import { ApiStepLog } from './steps/api';
3
4
  import { ButtonsStepLog } from './steps/buttons';
4
5
  import { CaptureStepLog } from './steps/capture';
@@ -15,6 +16,6 @@ import { StartStepLog } from './steps/start';
15
16
  import { TextStepLog } from './steps/text';
16
17
  export { ApiStepLog, ButtonsStepLog, CaptureStepLog, CodeStepLog, ConditionStepLog, ConversationStartLog, CustomActionStepLog, ExitStepLog, FlowStepLog, IntentStepLog, RandomStepLog, SetStepLog, SpeakStepLog, StartStepLog, TextStepLog, };
17
18
  /** All possible runtime logs for global events. */
18
- export declare type GlobalLog = ConversationStartLog;
19
+ export declare type GlobalLog = ConversationStartLog | NluIntentResolvedLog;
19
20
  /** All possible runtime logs for steps. */
20
21
  export declare type StepLog = ApiStepLog | ButtonsStepLog | CaptureStepLog | CodeStepLog | ConditionStepLog | CustomActionStepLog | ExitStepLog | FlowStepLog | IntentStepLog | RandomStepLog | SetStepLog | SpeakStepLog | StartStepLog | TextStepLog;
@@ -12,7 +12,7 @@ interface ApiLogMessageRequest {
12
12
  }
13
13
  interface ApiLogMessageResponse {
14
14
  statusCode: number;
15
- statusMessage: string;
15
+ statusText: string;
16
16
  headers: null;
17
17
  body: null;
18
18
  }
@@ -35,7 +35,7 @@ declare type VerboseApiLogMessageRequest = {
35
35
  });
36
36
  interface VerboseApiLogMessageResponse {
37
37
  statusCode: number;
38
- statusMessage: string;
38
+ statusText: string;
39
39
  headers: Record<string, string>;
40
40
  body: string;
41
41
  }
@@ -1,8 +1,4 @@
1
+ import { ChangedVariables, VariableValue } from "../../utils";
1
2
  import { BaseStepLog } from '../base';
2
3
  import { StepLogKind } from '../kinds';
3
- export declare type CaptureStepLog = BaseStepLog<StepLogKind.CAPTURE, {
4
- slots: Array<{
5
- utteredValue: string;
6
- canonicalValue: string;
7
- }>;
8
- }>;
4
+ export declare type CaptureStepLog = BaseStepLog<StepLogKind.CAPTURE, ChangedVariables<VariableValue | null, string, VariableValue>>;
@@ -1,15 +1,9 @@
1
+ import { ChangedVariables } from "../../utils";
1
2
  import { BaseStepLog } from '../base';
2
3
  import { StepLogKind } from '../kinds';
3
4
  import { LogLevel } from '../levels';
4
- interface ChangedVariable<T> {
5
- before: T;
6
- after: T;
7
- }
8
5
  export declare type CodeStepLog = BaseStepLog<StepLogKind.CUSTOM_CODE, {
9
6
  error: null;
10
- changedVariables: Record<string, ChangedVariable<any>>;
11
- }, LogLevel.INFO> | BaseStepLog<StepLogKind.CUSTOM_CODE, {
7
+ } & ChangedVariables<any>, LogLevel.INFO> | BaseStepLog<StepLogKind.CUSTOM_CODE, {
12
8
  error: any;
13
- changedVariables: null;
14
- }, LogLevel.ERROR>;
15
- export {};
9
+ } & Record<keyof ChangedVariables<never>, null>, LogLevel.ERROR>;
@@ -1,4 +1,6 @@
1
1
  import { FlowReference, ValueChange } from '../../utils';
2
2
  import { BaseStepLog } from '../base';
3
3
  import { StepLogKind } from '../kinds';
4
- export declare type FlowStepLog = BaseStepLog<StepLogKind.FLOW, ValueChange<FlowReference>>;
4
+ export declare type FlowStepLog = BaseStepLog<StepLogKind.FLOW, {
5
+ flow: null | ValueChange<FlowReference>;
6
+ }>;
@@ -2,3 +2,4 @@ import { LogLevel } from '../logs/levels';
2
2
  /** Returns the number (non-negative integer) value of `level`. A higher number is more verbose. `0` is the least verbose and most "important". The value `-1` is used to disable logging. */
3
3
  export declare const getValueForLogLevel: (level: LogLevel) => number;
4
4
  export declare const isLogLevel: (level: string) => level is LogLevel;
5
+ export declare const DEFAULT_LOG_LEVEL = LogLevel.INFO;
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.isLogLevel = exports.getValueForLogLevel = void 0;
3
+ exports.DEFAULT_LOG_LEVEL = exports.isLogLevel = exports.getValueForLogLevel = void 0;
4
4
  const levels_1 = require("../logs/levels");
5
5
  const logLevelValues = {
6
6
  [levels_1.LogLevel.OFF]: -1,
@@ -17,3 +17,4 @@ const isLogLevel = (level) => {
17
17
  return ALL_LOG_LEVELS.has(level);
18
18
  };
19
19
  exports.isLogLevel = isLogLevel;
20
+ exports.DEFAULT_LOG_LEVEL = levels_1.LogLevel.INFO;
@@ -11,14 +11,15 @@ export interface FlowReference {
11
11
  programID: string;
12
12
  }
13
13
  /** A common interface for representing a before & after change of a value. */
14
- export interface ValueChange<T> {
15
- before: T;
16
- after: T;
14
+ export interface ValueChange<Before, After = Before> {
15
+ before: Before;
16
+ after: After;
17
17
  }
18
18
  /**
19
19
  * An abstract interface for something that includes changed variables.
20
20
  * This enforces a consistent naming scheme of the property.
21
21
  */
22
- export interface ChangedVariables<V, K extends PropertyKey = string> {
23
- changedVariables: Record<K, ValueChange<V>>;
22
+ export interface ChangedVariables<V, K extends PropertyKey = string, V2 = V> {
23
+ changedVariables: Record<K, ValueChange<V, V2>>;
24
24
  }
25
+ export declare type VariableValue = string | number;
@@ -1,5 +1,5 @@
1
1
  import { EmptyObject } from '@voiceflow/common';
2
- import { Iso8601Timestamp, PathReference } from '../utils';
2
+ import { DEFAULT_LOG_LEVEL, Iso8601Timestamp, PathReference } from '../utils';
3
3
  import { GlobalLogKind, StepLogKind } from './kinds';
4
4
  import { LogLevel } from './levels';
5
5
  /** The base log interface. This should not be used directly, use one of the subtypes instead. */
@@ -9,12 +9,12 @@ interface BaseLog {
9
9
  message: EmptyObject;
10
10
  level: LogLevel;
11
11
  }
12
- export interface BaseGlobalLog<Kind extends GlobalLogKind, Message extends EmptyObject, Level extends LogLevel = LogLevel.INFO> extends BaseLog {
12
+ export interface BaseGlobalLog<Kind extends GlobalLogKind, Message extends EmptyObject, Level extends LogLevel = typeof DEFAULT_LOG_LEVEL> extends BaseLog {
13
13
  kind: `global.${Kind}`;
14
14
  level: Level;
15
15
  message: Message;
16
16
  }
17
- export interface BaseStepLog<Kind extends StepLogKind, Message extends EmptyObject, Level extends LogLevel = LogLevel.INFO> extends BaseLog {
17
+ export interface BaseStepLog<Kind extends StepLogKind, Message extends EmptyObject, Level extends LogLevel = typeof DEFAULT_LOG_LEVEL> extends BaseLog {
18
18
  kind: `step.${Kind}`;
19
19
  level: Level;
20
20
  message: PathReference & Message;
@@ -0,0 +1,12 @@
1
+ import { BaseGlobalLog } from '../base';
2
+ import { GlobalLogKind } from '../kinds';
3
+ interface Entity {
4
+ value: string;
5
+ }
6
+ export declare type NluIntentResolvedLog = BaseGlobalLog<GlobalLogKind.NLU_INTENT_RESOLVED, {
7
+ resolvedIntent: string;
8
+ confidence: number;
9
+ utterance: string;
10
+ entities: Record<string, Entity>;
11
+ }>;
12
+ export {};
@@ -25,7 +25,8 @@ export declare enum StepLogKind {
25
25
  START = "start"
26
26
  }
27
27
  export declare enum GlobalLogKind {
28
- CONVERSATION_START = "conversation_start"
28
+ CONVERSATION_START = "conversation_start",
29
+ NLU_INTENT_RESOLVED = "nlu.intent_resolved"
29
30
  }
30
31
  declare const NODE_TYPE_TO_STEP_LOG_KIND: {
31
32
  readonly text: StepLogKind.TEXT;
@@ -33,6 +33,7 @@ export var StepLogKind;
33
33
  export var GlobalLogKind;
34
34
  (function (GlobalLogKind) {
35
35
  GlobalLogKind["CONVERSATION_START"] = "conversation_start";
36
+ GlobalLogKind["NLU_INTENT_RESOLVED"] = "nlu.intent_resolved";
36
37
  })(GlobalLogKind || (GlobalLogKind = {}));
37
38
  const NODE_TYPE_TO_STEP_LOG_KIND = {
38
39
  [NodeType.TEXT]: StepLogKind.TEXT,
@@ -1,4 +1,5 @@
1
1
  import { ConversationStartLog } from './global/conversationStart';
2
+ import { NluIntentResolvedLog } from './global/nluIntentResolved';
2
3
  import { ApiStepLog } from './steps/api';
3
4
  import { ButtonsStepLog } from './steps/buttons';
4
5
  import { CaptureStepLog } from './steps/capture';
@@ -15,6 +16,6 @@ import { StartStepLog } from './steps/start';
15
16
  import { TextStepLog } from './steps/text';
16
17
  export { ApiStepLog, ButtonsStepLog, CaptureStepLog, CodeStepLog, ConditionStepLog, ConversationStartLog, CustomActionStepLog, ExitStepLog, FlowStepLog, IntentStepLog, RandomStepLog, SetStepLog, SpeakStepLog, StartStepLog, TextStepLog, };
17
18
  /** All possible runtime logs for global events. */
18
- export declare type GlobalLog = ConversationStartLog;
19
+ export declare type GlobalLog = ConversationStartLog | NluIntentResolvedLog;
19
20
  /** All possible runtime logs for steps. */
20
21
  export declare type StepLog = ApiStepLog | ButtonsStepLog | CaptureStepLog | CodeStepLog | ConditionStepLog | CustomActionStepLog | ExitStepLog | FlowStepLog | IntentStepLog | RandomStepLog | SetStepLog | SpeakStepLog | StartStepLog | TextStepLog;
@@ -12,7 +12,7 @@ interface ApiLogMessageRequest {
12
12
  }
13
13
  interface ApiLogMessageResponse {
14
14
  statusCode: number;
15
- statusMessage: string;
15
+ statusText: string;
16
16
  headers: null;
17
17
  body: null;
18
18
  }
@@ -35,7 +35,7 @@ declare type VerboseApiLogMessageRequest = {
35
35
  });
36
36
  interface VerboseApiLogMessageResponse {
37
37
  statusCode: number;
38
- statusMessage: string;
38
+ statusText: string;
39
39
  headers: Record<string, string>;
40
40
  body: string;
41
41
  }
@@ -1,8 +1,4 @@
1
+ import { ChangedVariables, VariableValue } from "../../utils";
1
2
  import { BaseStepLog } from '../base';
2
3
  import { StepLogKind } from '../kinds';
3
- export declare type CaptureStepLog = BaseStepLog<StepLogKind.CAPTURE, {
4
- slots: Array<{
5
- utteredValue: string;
6
- canonicalValue: string;
7
- }>;
8
- }>;
4
+ export declare type CaptureStepLog = BaseStepLog<StepLogKind.CAPTURE, ChangedVariables<VariableValue | null, string, VariableValue>>;
@@ -1,15 +1,9 @@
1
+ import { ChangedVariables } from "../../utils";
1
2
  import { BaseStepLog } from '../base';
2
3
  import { StepLogKind } from '../kinds';
3
4
  import { LogLevel } from '../levels';
4
- interface ChangedVariable<T> {
5
- before: T;
6
- after: T;
7
- }
8
5
  export declare type CodeStepLog = BaseStepLog<StepLogKind.CUSTOM_CODE, {
9
6
  error: null;
10
- changedVariables: Record<string, ChangedVariable<any>>;
11
- }, LogLevel.INFO> | BaseStepLog<StepLogKind.CUSTOM_CODE, {
7
+ } & ChangedVariables<any>, LogLevel.INFO> | BaseStepLog<StepLogKind.CUSTOM_CODE, {
12
8
  error: any;
13
- changedVariables: null;
14
- }, LogLevel.ERROR>;
15
- export {};
9
+ } & Record<keyof ChangedVariables<never>, null>, LogLevel.ERROR>;
@@ -1,4 +1,6 @@
1
1
  import { FlowReference, ValueChange } from '../../utils';
2
2
  import { BaseStepLog } from '../base';
3
3
  import { StepLogKind } from '../kinds';
4
- export declare type FlowStepLog = BaseStepLog<StepLogKind.FLOW, ValueChange<FlowReference>>;
4
+ export declare type FlowStepLog = BaseStepLog<StepLogKind.FLOW, {
5
+ flow: null | ValueChange<FlowReference>;
6
+ }>;
@@ -2,3 +2,4 @@ import { LogLevel } from '../logs/levels';
2
2
  /** Returns the number (non-negative integer) value of `level`. A higher number is more verbose. `0` is the least verbose and most "important". The value `-1` is used to disable logging. */
3
3
  export declare const getValueForLogLevel: (level: LogLevel) => number;
4
4
  export declare const isLogLevel: (level: string) => level is LogLevel;
5
+ export declare const DEFAULT_LOG_LEVEL = LogLevel.INFO;
@@ -12,3 +12,4 @@ const ALL_LOG_LEVELS = new Set(Object.values(LogLevel));
12
12
  export const isLogLevel = (level) => {
13
13
  return ALL_LOG_LEVELS.has(level);
14
14
  };
15
+ export const DEFAULT_LOG_LEVEL = LogLevel.INFO;
@@ -11,14 +11,15 @@ export interface FlowReference {
11
11
  programID: string;
12
12
  }
13
13
  /** A common interface for representing a before & after change of a value. */
14
- export interface ValueChange<T> {
15
- before: T;
16
- after: T;
14
+ export interface ValueChange<Before, After = Before> {
15
+ before: Before;
16
+ after: After;
17
17
  }
18
18
  /**
19
19
  * An abstract interface for something that includes changed variables.
20
20
  * This enforces a consistent naming scheme of the property.
21
21
  */
22
- export interface ChangedVariables<V, K extends PropertyKey = string> {
23
- changedVariables: Record<K, ValueChange<V>>;
22
+ export interface ChangedVariables<V, K extends PropertyKey = string, V2 = V> {
23
+ changedVariables: Record<K, ValueChange<V, V2>>;
24
24
  }
25
+ export declare type VariableValue = string | number;
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "@voiceflow/base-types",
3
3
  "description": "Voiceflow base project types",
4
- "version": "2.47.0",
4
+ "version": "2.48.0",
5
5
  "author": "Voiceflow",
6
6
  "bugs": {
7
7
  "url": "https://github.com/voiceflow/libs/issues"
8
8
  },
9
9
  "dependencies": {
10
- "@voiceflow/common": "^7.27.1",
10
+ "@voiceflow/common": "^7.27.3",
11
11
  "slate": "0.73.0"
12
12
  },
13
13
  "files": [
@@ -43,5 +43,5 @@
43
43
  "test:smoke": "exit 0",
44
44
  "test:unit": "exit 0"
45
45
  },
46
- "gitHead": "f406fe8ef03ec2b6c409362090d76fd93ab68bb4"
46
+ "gitHead": "1c4958eaddbe608e18d9cabb21ea35678025c7e5"
47
47
  }