@sprucelabs/spruce-conversation-plugin 52.1.4 → 52.2.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 (17) hide show
  1. package/build/.spruce/errors/options.types.d.ts +1 -1
  2. package/build/conversations/ConversationCoordinator.d.ts +2 -2
  3. package/build/esm/.spruce/errors/options.types.d.ts +1 -1
  4. package/build/esm/conversations/ConversationCoordinator.d.ts +2 -2
  5. package/build/esm/interfaces/TestGraphicsInterface.d.ts +1 -1
  6. package/build/esm/tests/ScriptTester.d.ts +3 -3
  7. package/build/esm/tests/messageTest.utility.d.ts +1 -1
  8. package/build/esm/topics/TopicScriptPlayer.d.ts +1 -1
  9. package/build/esm/types/conversation.types.d.ts +13 -13
  10. package/build/esm/utilities/suggester.utility.d.ts +1 -1
  11. package/build/interfaces/TestGraphicsInterface.d.ts +1 -1
  12. package/build/tests/ScriptTester.d.ts +3 -3
  13. package/build/tests/messageTest.utility.d.ts +1 -1
  14. package/build/topics/TopicScriptPlayer.d.ts +1 -1
  15. package/build/types/conversation.types.d.ts +13 -13
  16. package/build/utilities/suggester.utility.d.ts +1 -1
  17. package/package.json +5 -5
package/build/.spruce/errors/options.types.d.ts CHANGED
@@ -21,5 +21,5 @@ export interface ConversationAbortedErrorOptions extends SpruceErrors.Conversati
21
21
  export interface AbortErrorOptions extends SpruceErrors.Conversation.Abort, ISpruceErrorOptions {
22
22
  code: 'ABORT';
23
23
  }
24
- declare type ErrorOptions = TopicNotFoundErrorOptions | TesterNotStartedErrorOptions | MissingDependenciesErrorOptions | InvalidTopicErrorOptions | ConversationPluginErrorErrorOptions | ConversationAbortedErrorOptions | AbortErrorOptions;
24
+ type ErrorOptions = TopicNotFoundErrorOptions | TesterNotStartedErrorOptions | MissingDependenciesErrorOptions | InvalidTopicErrorOptions | ConversationPluginErrorErrorOptions | ConversationAbortedErrorOptions | AbortErrorOptions;
25
25
  export default ErrorOptions;
package/build/conversations/ConversationCoordinator.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  import { SkillEventContract } from '@sprucelabs/mercury-core-events';
2
2
  import { SchemaValues } from '@sprucelabs/schema';
3
3
  import { Message, SendMessageHandler } from '../types/conversation.types';
4
- declare type MessageResponsePayloadSchema = SkillEventContract['eventSignatures']['did-message::v2020_12_25']['responsePayloadSchema'];
5
- declare type MessageResponsePayload = SchemaValues<MessageResponsePayloadSchema>;
4
+ type MessageResponsePayloadSchema = SkillEventContract['eventSignatures']['did-message::v2020_12_25']['responsePayloadSchema'];
5
+ type MessageResponsePayload = SchemaValues<MessageResponsePayloadSchema>;
6
6
  export declare class ConversationCoordinator {
7
7
  private suggester;
8
8
  private sendMessageHandler;
package/build/esm/.spruce/errors/options.types.d.ts CHANGED
@@ -21,5 +21,5 @@ export interface ConversationAbortedErrorOptions extends SpruceErrors.Conversati
21
21
  export interface AbortErrorOptions extends SpruceErrors.Conversation.Abort, ISpruceErrorOptions {
22
22
  code: 'ABORT';
23
23
  }
24
- declare type ErrorOptions = TopicNotFoundErrorOptions | TesterNotStartedErrorOptions | MissingDependenciesErrorOptions | InvalidTopicErrorOptions | ConversationPluginErrorErrorOptions | ConversationAbortedErrorOptions | AbortErrorOptions;
24
+ type ErrorOptions = TopicNotFoundErrorOptions | TesterNotStartedErrorOptions | MissingDependenciesErrorOptions | InvalidTopicErrorOptions | ConversationPluginErrorErrorOptions | ConversationAbortedErrorOptions | AbortErrorOptions;
25
25
  export default ErrorOptions;
package/build/esm/conversations/ConversationCoordinator.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  import { SkillEventContract } from '@sprucelabs/mercury-core-events';
2
2
  import { SchemaValues } from '@sprucelabs/schema';
3
3
  import { Message, SendMessageHandler } from '../types/conversation.types';
4
- declare type MessageResponsePayloadSchema = SkillEventContract['eventSignatures']['did-message::v2020_12_25']['responsePayloadSchema'];
5
- declare type MessageResponsePayload = SchemaValues<MessageResponsePayloadSchema>;
4
+ type MessageResponsePayloadSchema = SkillEventContract['eventSignatures']['did-message::v2020_12_25']['responsePayloadSchema'];
5
+ type MessageResponsePayload = SchemaValues<MessageResponsePayloadSchema>;
6
6
  export declare class ConversationCoordinator {
7
7
  private suggester;
8
8
  private sendMessageHandler;
package/build/esm/interfaces/TestGraphicsInterface.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { Message } from '../types/conversation.types';
2
2
  import MessageGraphicsInterface, { MessageGraphicsInterfaceOptions } from './MessageGraphicsInterface';
3
- export declare type PromptHandler = (message: Pick<Message, 'body'>) => Promise<string>;
3
+ export type PromptHandler = (message: Pick<Message, 'body'>) => Promise<string>;
4
4
  export default class TestGraphicsInterface extends MessageGraphicsInterface {
5
5
  private promptHandler;
6
6
  constructor(options: MessageGraphicsInterfaceOptions & {
package/build/esm/tests/ScriptTester.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  import { PromptHandler } from '../interfaces/TestGraphicsInterface';
2
2
  import { LoadedTopicDefinition, Message } from '../types/conversation.types';
3
- declare type WriteHandler = (message: Pick<Message, 'body' | 'choices'>) => void;
4
- declare type SelectHandler = (message: Pick<Message, 'body' | 'choices'>) => Promise<string>;
5
- declare type SimplifiedTopic = LoadedTopicDefinition;
3
+ type WriteHandler = (message: Pick<Message, 'body' | 'choices'>) => void;
4
+ type SelectHandler = (message: Pick<Message, 'body' | 'choices'>) => Promise<string>;
5
+ type SimplifiedTopic = LoadedTopicDefinition;
6
6
  export declare const END_OF_LINE = "END OF LINE \uD83D\uDC7E";
7
7
  export default class ScriptTester {
8
8
  private writeHandler;
package/build/esm/tests/messageTest.utility.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { SpruceSchemas } from '@sprucelabs/spruce-core-schemas';
2
- export declare type Message = SpruceSchemas.Spruce.v2020_07_22.Message;
2
+ export type Message = SpruceSchemas.Spruce.v2020_07_22.Message;
3
3
  declare const messageTestUtility: {
4
4
  buildMessage<T extends Partial<SpruceSchemas.Spruce.v2020_07_22.Message>>(values: T): SpruceSchemas.Spruce.v2020_07_22.Message & T;
5
5
  };
package/build/esm/topics/TopicScriptPlayer.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { SpruceSchemas } from '@sprucelabs/spruce-core-schemas';
2
2
  import { ScriptPlayerOptions, ScriptLine, DidMessageResponsePayload } from '../types/conversation.types';
3
- declare type Message = SpruceSchemas.Spruce.v2020_07_22.Message;
3
+ type Message = SpruceSchemas.Spruce.v2020_07_22.Message;
4
4
  export declare class TopicScriptPlayer {
5
5
  private script;
6
6
  private sendMessageHandler;
package/build/esm/types/conversation.types.d.ts CHANGED
@@ -5,22 +5,22 @@ import { SpruceSchemas } from '@sprucelabs/spruce-core-schemas';
5
5
  import { EventTarget } from '@sprucelabs/spruce-event-utils';
6
6
  import { GraphicsInterface, HealthCheckItem } from '@sprucelabs/spruce-skill-utils';
7
7
  import MessageGraphicsInterface from '../interfaces/MessageGraphicsInterface';
8
- export declare type Message = SpruceSchemas.Spruce.v2020_07_22.Message;
9
- export declare type SendMessage = SpruceSchemas.Spruce.v2020_07_22.SendMessage;
10
- export declare type SendMessageHandler = (message: SendMessage) => Promise<void>;
11
- export declare type DidMessageResponsePayloadSchema = SkillEventContract['eventSignatures']['did-message::v2020_12_25']['responsePayloadSchema'];
12
- export declare type DidMessageResponsePayload = SchemaValues<DidMessageResponsePayloadSchema>;
13
- export declare type ScriptLineCallbackOptions = {
8
+ export type Message = SpruceSchemas.Spruce.v2020_07_22.Message;
9
+ export type SendMessage = SpruceSchemas.Spruce.v2020_07_22.SendMessage;
10
+ export type SendMessageHandler = (message: SendMessage) => Promise<void>;
11
+ export type DidMessageResponsePayloadSchema = SkillEventContract['eventSignatures']['did-message::v2020_12_25']['responsePayloadSchema'];
12
+ export type DidMessageResponsePayload = SchemaValues<DidMessageResponsePayloadSchema>;
13
+ export type ScriptLineCallbackOptions = {
14
14
  ui: GraphicsInterface;
15
15
  state: Record<string, any>;
16
16
  rand<T>(possibilities: T[]): T;
17
17
  message: Message;
18
18
  };
19
- export declare type ScriptLine = string | ScriptLineCallback | string[];
19
+ export type ScriptLine = string | ScriptLineCallback | string[];
20
20
  export interface ScriptLineCallback {
21
21
  (options: ScriptLineCallbackOptions): Promise<void | DidMessageResponsePayload>;
22
22
  }
23
- export declare type Script = ScriptLine[];
23
+ export type Script = ScriptLine[];
24
24
  export interface ScriptPlayerOptions {
25
25
  script: Script;
26
26
  sendMessageHandler: SendMessageHandler;
@@ -28,7 +28,7 @@ export interface ScriptPlayerOptions {
28
28
  lineDelay?: number;
29
29
  graphicsInterface?: MessageGraphicsInterface;
30
30
  }
31
- export declare type ScriptPlayerSendMessage = {
31
+ export type ScriptPlayerSendMessage = {
32
32
  body: string;
33
33
  choices?: Message['choices'];
34
34
  };
@@ -49,8 +49,8 @@ export declare const suggestedConversationTopicSchema: {
49
49
  };
50
50
  };
51
51
  };
52
- export declare type SuggestedConversationTopicSchema = typeof suggestedConversationTopicSchema;
53
- export declare type SuggestedConversationTopic = SchemaValues<SuggestedConversationTopicSchema>;
52
+ export type SuggestedConversationTopicSchema = typeof suggestedConversationTopicSchema;
53
+ export type SuggestedConversationTopic = SchemaValues<SuggestedConversationTopicSchema>;
54
54
  export interface Topic {
55
55
  key: string;
56
56
  label: string;
@@ -62,7 +62,7 @@ export interface TopicDefinition extends Omit<Topic, 'key'> {
62
62
  export interface ConversationHealthCheckItem extends HealthCheckItem {
63
63
  topics: string[];
64
64
  }
65
- export declare type LoadedTopicDefinition = TopicDefinition & {
65
+ export type LoadedTopicDefinition = TopicDefinition & {
66
66
  key: string;
67
67
  };
68
68
  declare module '@sprucelabs/spruce-skill-utils/build/types/skill.types' {
@@ -70,7 +70,7 @@ declare module '@sprucelabs/spruce-skill-utils/build/types/skill.types' {
70
70
  conversation?: ConversationHealthCheckItem;
71
71
  }
72
72
  }
73
- export declare type ScriptPlayerSendMessageHandler = (message: ScriptPlayerSendMessage) => Promise<void>;
73
+ export type ScriptPlayerSendMessageHandler = (message: ScriptPlayerSendMessage) => Promise<void>;
74
74
  export interface FieldHandlerOptions<D extends FieldDefinitions = FieldDefinitions> {
75
75
  sendMessageHandler: ScriptPlayerSendMessageHandler;
76
76
  waitForNextMessageHandler: () => Promise<string>;
package/build/esm/utilities/suggester.utility.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- declare type Suggestion = {
1
+ type Suggestion = {
2
2
  key: string;
3
3
  score: number;
4
4
  };
package/build/interfaces/TestGraphicsInterface.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { Message } from '../types/conversation.types';
2
2
  import MessageGraphicsInterface, { MessageGraphicsInterfaceOptions } from './MessageGraphicsInterface';
3
- export declare type PromptHandler = (message: Pick<Message, 'body'>) => Promise<string>;
3
+ export type PromptHandler = (message: Pick<Message, 'body'>) => Promise<string>;
4
4
  export default class TestGraphicsInterface extends MessageGraphicsInterface {
5
5
  private promptHandler;
6
6
  constructor(options: MessageGraphicsInterfaceOptions & {
package/build/tests/ScriptTester.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  import { PromptHandler } from '../interfaces/TestGraphicsInterface';
2
2
  import { LoadedTopicDefinition, Message } from '../types/conversation.types';
3
- declare type WriteHandler = (message: Pick<Message, 'body' | 'choices'>) => void;
4
- declare type SelectHandler = (message: Pick<Message, 'body' | 'choices'>) => Promise<string>;
5
- declare type SimplifiedTopic = LoadedTopicDefinition;
3
+ type WriteHandler = (message: Pick<Message, 'body' | 'choices'>) => void;
4
+ type SelectHandler = (message: Pick<Message, 'body' | 'choices'>) => Promise<string>;
5
+ type SimplifiedTopic = LoadedTopicDefinition;
6
6
  export declare const END_OF_LINE = "END OF LINE \uD83D\uDC7E";
7
7
  export default class ScriptTester {
8
8
  private writeHandler;
package/build/tests/messageTest.utility.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { SpruceSchemas } from '@sprucelabs/spruce-core-schemas';
2
- export declare type Message = SpruceSchemas.Spruce.v2020_07_22.Message;
2
+ export type Message = SpruceSchemas.Spruce.v2020_07_22.Message;
3
3
  declare const messageTestUtility: {
4
4
  buildMessage<T extends Partial<SpruceSchemas.Spruce.v2020_07_22.Message>>(values: T): SpruceSchemas.Spruce.v2020_07_22.Message & T;
5
5
  };
package/build/topics/TopicScriptPlayer.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { SpruceSchemas } from '@sprucelabs/spruce-core-schemas';
2
2
  import { ScriptPlayerOptions, ScriptLine, DidMessageResponsePayload } from '../types/conversation.types';
3
- declare type Message = SpruceSchemas.Spruce.v2020_07_22.Message;
3
+ type Message = SpruceSchemas.Spruce.v2020_07_22.Message;
4
4
  export declare class TopicScriptPlayer {
5
5
  private script;
6
6
  private sendMessageHandler;
package/build/types/conversation.types.d.ts CHANGED
@@ -5,22 +5,22 @@ import { SpruceSchemas } from '@sprucelabs/spruce-core-schemas';
5
5
  import { EventTarget } from '@sprucelabs/spruce-event-utils';
6
6
  import { GraphicsInterface, HealthCheckItem } from '@sprucelabs/spruce-skill-utils';
7
7
  import MessageGraphicsInterface from '../interfaces/MessageGraphicsInterface';
8
- export declare type Message = SpruceSchemas.Spruce.v2020_07_22.Message;
9
- export declare type SendMessage = SpruceSchemas.Spruce.v2020_07_22.SendMessage;
10
- export declare type SendMessageHandler = (message: SendMessage) => Promise<void>;
11
- export declare type DidMessageResponsePayloadSchema = SkillEventContract['eventSignatures']['did-message::v2020_12_25']['responsePayloadSchema'];
12
- export declare type DidMessageResponsePayload = SchemaValues<DidMessageResponsePayloadSchema>;
13
- export declare type ScriptLineCallbackOptions = {
8
+ export type Message = SpruceSchemas.Spruce.v2020_07_22.Message;
9
+ export type SendMessage = SpruceSchemas.Spruce.v2020_07_22.SendMessage;
10
+ export type SendMessageHandler = (message: SendMessage) => Promise<void>;
11
+ export type DidMessageResponsePayloadSchema = SkillEventContract['eventSignatures']['did-message::v2020_12_25']['responsePayloadSchema'];
12
+ export type DidMessageResponsePayload = SchemaValues<DidMessageResponsePayloadSchema>;
13
+ export type ScriptLineCallbackOptions = {
14
14
  ui: GraphicsInterface;
15
15
  state: Record<string, any>;
16
16
  rand<T>(possibilities: T[]): T;
17
17
  message: Message;
18
18
  };
19
- export declare type ScriptLine = string | ScriptLineCallback | string[];
19
+ export type ScriptLine = string | ScriptLineCallback | string[];
20
20
  export interface ScriptLineCallback {
21
21
  (options: ScriptLineCallbackOptions): Promise<void | DidMessageResponsePayload>;
22
22
  }
23
- export declare type Script = ScriptLine[];
23
+ export type Script = ScriptLine[];
24
24
  export interface ScriptPlayerOptions {
25
25
  script: Script;
26
26
  sendMessageHandler: SendMessageHandler;
@@ -28,7 +28,7 @@ export interface ScriptPlayerOptions {
28
28
  lineDelay?: number;
29
29
  graphicsInterface?: MessageGraphicsInterface;
30
30
  }
31
- export declare type ScriptPlayerSendMessage = {
31
+ export type ScriptPlayerSendMessage = {
32
32
  body: string;
33
33
  choices?: Message['choices'];
34
34
  };
@@ -49,8 +49,8 @@ export declare const suggestedConversationTopicSchema: {
49
49
  };
50
50
  };
51
51
  };
52
- export declare type SuggestedConversationTopicSchema = typeof suggestedConversationTopicSchema;
53
- export declare type SuggestedConversationTopic = SchemaValues<SuggestedConversationTopicSchema>;
52
+ export type SuggestedConversationTopicSchema = typeof suggestedConversationTopicSchema;
53
+ export type SuggestedConversationTopic = SchemaValues<SuggestedConversationTopicSchema>;
54
54
  export interface Topic {
55
55
  key: string;
56
56
  label: string;
@@ -62,7 +62,7 @@ export interface TopicDefinition extends Omit<Topic, 'key'> {
62
62
  export interface ConversationHealthCheckItem extends HealthCheckItem {
63
63
  topics: string[];
64
64
  }
65
- export declare type LoadedTopicDefinition = TopicDefinition & {
65
+ export type LoadedTopicDefinition = TopicDefinition & {
66
66
  key: string;
67
67
  };
68
68
  declare module '@sprucelabs/spruce-skill-utils/build/types/skill.types' {
@@ -70,7 +70,7 @@ declare module '@sprucelabs/spruce-skill-utils/build/types/skill.types' {
70
70
  conversation?: ConversationHealthCheckItem;
71
71
  }
72
72
  }
73
- export declare type ScriptPlayerSendMessageHandler = (message: ScriptPlayerSendMessage) => Promise<void>;
73
+ export type ScriptPlayerSendMessageHandler = (message: ScriptPlayerSendMessage) => Promise<void>;
74
74
  export interface FieldHandlerOptions<D extends FieldDefinitions = FieldDefinitions> {
75
75
  sendMessageHandler: ScriptPlayerSendMessageHandler;
76
76
  waitForNextMessageHandler: () => Promise<string>;
package/build/utilities/suggester.utility.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- declare type Suggestion = {
1
+ type Suggestion = {
2
2
  key: string;
3
3
  score: number;
4
4
  };
package/package.json CHANGED
@@ -13,7 +13,7 @@
13
13
  "@types/inquirer"
14
14
  ]
15
15
  },
16
- "version": "52.1.4",
16
+ "version": "52.2.0",
17
17
  "files": [
18
18
  "build/**/*",
19
19
  "!build/__tests__",
@@ -68,11 +68,11 @@
68
68
  "@sprucelabs/mercury-core-events": "^15.0.70",
69
69
  "@sprucelabs/schema": "^28.5.66",
70
70
  "@sprucelabs/spruce-core-schemas": "^35.1.55",
71
- "@sprucelabs/spruce-event-plugin": "^52.1.4",
71
+ "@sprucelabs/spruce-event-plugin": "^52.2.0",
72
72
  "@sprucelabs/spruce-event-utils": "^29.1.58",
73
- "@sprucelabs/spruce-skill-booter": "^52.1.4",
73
+ "@sprucelabs/spruce-skill-booter": "^52.2.0",
74
74
  "@sprucelabs/spruce-skill-utils": "^28.0.50",
75
- "@sprucelabs/spruce-test-fixtures": "^52.1.4",
75
+ "@sprucelabs/spruce-test-fixtures": "^52.2.0",
76
76
  "fuzzyset": "^1.0.7",
77
77
  "globby": "^11.0.4",
78
78
  "inquirer": "^8.2.4",
@@ -119,5 +119,5 @@
119
119
  "^#spruce/(.*)$": "<rootDir>/build/.spruce/$1"
120
120
  }
121
121
  },
122
- "gitHead": "db82497db196160911f08646a10caef2d257e0e7"
122
+ "gitHead": "2b3162f292988316d9fa455fa48b1a03d4390de6"
123
123
  }