@engyalo/workflow-types 1.4.2 → 1.5.0-main-8336661

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.
@@ -20,6 +20,7 @@ export declare enum IComponentType {
20
20
  step = "step",
21
21
  webhook = "webhook",
22
22
  customAgent = "customAgent",
23
+ customAgentV2 = "customAgentV2",
23
24
  voiceUpsellAgent = "voiceUpsellAgent",
24
25
  orisVoice = "orisVoice",
25
26
  customVoiceAgent = "customVoiceAgent",
@@ -97,6 +98,112 @@ export interface CustomAgent {
97
98
  maxInputLength?: number;
98
99
  strictInstructions?: boolean;
99
100
  }
101
+ interface ICustomAgentV2Flow {
102
+ flowId: string;
103
+ step?: string;
104
+ stepUid?: string;
105
+ stepName?: string;
106
+ stepType?: string;
107
+ activityId?: string;
108
+ }
109
+ interface ICustomAgentV2TransitionLogic {
110
+ type: 'menu' | 'human' | 'custom' | 'error';
111
+ key?: string;
112
+ description?: string;
113
+ redirectionStep: number;
114
+ redirectionStepUid?: string;
115
+ }
116
+ interface ICustomAgentV2Guardrails {
117
+ enabled?: boolean;
118
+ prohibitedTopics?: string;
119
+ customPrompt?: string;
120
+ fallbackMessage?: string;
121
+ }
122
+ interface ICustomAgentV2Locale {
123
+ enabled?: boolean;
124
+ multilingual?: boolean;
125
+ defaultLanguage?: string;
126
+ customPrompt?: string;
127
+ }
128
+ interface ICustomAgentV2AudioTranscription {
129
+ hints?: string;
130
+ advancedModel?: boolean;
131
+ }
132
+ interface ICustomAgentV2SkillBase {
133
+ enabled?: boolean;
134
+ silenceFillerEnabled?: boolean;
135
+ }
136
+ interface ICustomAgentV2OutputFormattingConfig {
137
+ richFormatting?: boolean;
138
+ nativeMultimedia?: boolean;
139
+ }
140
+ type ICustomAgentV2FaqFilterOperator = 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'nin';
141
+ interface ICustomAgentV2FaqAttributeFilter {
142
+ key: string;
143
+ value: string | number | boolean | string[];
144
+ type?: ICustomAgentV2FaqFilterOperator;
145
+ }
146
+ interface ICustomAgentV2FaqCollectionConfig {
147
+ name: string;
148
+ description: string;
149
+ filters?: ICustomAgentV2FaqAttributeFilter[];
150
+ }
151
+ export interface ICustomAgentV2FaqSkill extends ICustomAgentV2SkillBase {
152
+ triggerDescription?: string;
153
+ vectorStoreId: string;
154
+ collections?: ICustomAgentV2FaqCollectionConfig[];
155
+ maxNumResults?: number;
156
+ scoreThreshold?: number;
157
+ retrievalGuidance?: string;
158
+ responseGuidance?: string;
159
+ outputFormatting?: ICustomAgentV2OutputFormattingConfig;
160
+ }
161
+ interface ICustomAgentV2ModelConfig {
162
+ name?: string;
163
+ temperature?: number;
164
+ historyMaxMessages?: number;
165
+ }
166
+ interface ICustomAgentV2McpServerConfig {
167
+ url: string;
168
+ transport?: 'streamable_http' | 'sse';
169
+ headers?: Record<string, string>;
170
+ }
171
+ interface ICustomAgentV2MemoryConfig {
172
+ storeEnabled?: boolean;
173
+ retrieveEnabled?: boolean;
174
+ keysEnabled?: boolean;
175
+ }
176
+ interface ICustomAgentV2TransferConfig {
177
+ enabled?: boolean;
178
+ }
179
+ interface ICustomAgentV2LuaToolConfig {
180
+ name: string;
181
+ description: string;
182
+ code: string;
183
+ paramsSchema?: Record<string, unknown>;
184
+ }
185
+ export interface ICustomAgentV2CustomSkill extends ICustomAgentV2SkillBase {
186
+ triggerDescription: string;
187
+ prompt?: string;
188
+ model?: ICustomAgentV2ModelConfig;
189
+ outputFormatting?: ICustomAgentV2OutputFormattingConfig;
190
+ mcpServers?: Record<string, ICustomAgentV2McpServerConfig>;
191
+ memory?: ICustomAgentV2MemoryConfig;
192
+ transfer?: ICustomAgentV2TransferConfig;
193
+ luaTools?: ICustomAgentV2LuaToolConfig[];
194
+ }
195
+ export type ICustomAgentV2Skill = ICustomAgentV2FaqSkill | ICustomAgentV2CustomSkill;
196
+ export interface CustomAgentV2 {
197
+ name: string;
198
+ objective?: string;
199
+ flow: ICustomAgentV2Flow;
200
+ skills?: Record<string, ICustomAgentV2Skill>;
201
+ transitionLogics?: ICustomAgentV2TransitionLogic[];
202
+ guardrails?: ICustomAgentV2Guardrails;
203
+ locale?: ICustomAgentV2Locale;
204
+ audioTranscription?: ICustomAgentV2AudioTranscription;
205
+ brandGuidelines?: string;
206
+ }
100
207
  export interface FaqAgent {
101
208
  systemPrompt: string;
102
209
  fallbackMessage: string;
@@ -243,6 +350,7 @@ export interface IComponent {
243
350
  funnel?: IFunnel[];
244
351
  ai?: IAi;
245
352
  customAgent?: CustomAgent;
353
+ customAgentV2?: CustomAgentV2;
246
354
  voiceUpsellAgent?: VoiceUpsellAgent;
247
355
  AITrainer?: IAiTrainer;
248
356
  knowledgeGenie?: IKnowledgeGenie;
@@ -21,6 +21,7 @@ var IComponentType;
21
21
  IComponentType["step"] = "step";
22
22
  IComponentType["webhook"] = "webhook";
23
23
  IComponentType["customAgent"] = "customAgent";
24
+ IComponentType["customAgentV2"] = "customAgentV2";
24
25
  IComponentType["voiceUpsellAgent"] = "voiceUpsellAgent";
25
26
  IComponentType["orisVoice"] = "orisVoice";
26
27
  IComponentType["customVoiceAgent"] = "customVoiceAgent";
@@ -44,6 +45,7 @@ exports.ComponentTypeEnum = [
44
45
  'audience',
45
46
  'notification',
46
47
  'customAgent',
48
+ 'customAgentV2',
47
49
  'voiceUpsellAgent',
48
50
  'orisVoice',
49
51
  'customVoiceAgent',
@@ -1 +1 @@
1
- {"version":3,"file":"components.js","sourceRoot":"","sources":["../../src/models/components.ts"],"names":[],"mappings":";;;AAKA,oDAAoD;AACpD,IAAY,cAuBX;AAvBD,WAAY,cAAc;IACzB,uCAAqB,CAAA;IACrB,iCAAe,CAAA;IACf,mCAAiB,CAAA;IACjB,uCAAqB,CAAA;IACrB,uCAAqB,CAAA;IACrB,2DAAyC,CAAA;IACzC,yCAAuB,CAAA;IACvB,+BAAa,CAAA;IACb,+CAA6B,CAAA;IAC7B,mDAAiC,CAAA;IACjC,+CAA6B,CAAA;IAC7B,yCAAuB,CAAA;IACvB,iCAAe,CAAA;IACf,iCAAe,CAAA;IACf,+BAAa,CAAA;IACb,qCAAmB,CAAA;IACnB,6CAA2B,CAAA;IAC3B,uDAAqC,CAAA;IACrC,yCAAuB,CAAA;IACvB,uDAAqC,CAAA;IACrC,qCAAmB,CAAA;IACnB,uCAAqB,CAAA;AACtB,CAAC,EAvBW,cAAc,8BAAd,cAAc,QAuBzB;AAEY,QAAA,iBAAiB,GAAG;IAChC,OAAO;IACP,MAAM;IACN,OAAO;IACP,UAAU;IACV,SAAS;IACT,QAAQ;IACR,WAAW;IACX,cAAc;IACd,WAAW;IACX,MAAM;IACN,gBAAgB;IAChB,OAAO;IACP,oBAAoB;IACpB,UAAU;IACV,cAAc;IACd,aAAa;IACb,kBAAkB;IAClB,WAAW;IACX,kBAAkB;IAClB,SAAS;IACT,UAAU;CACV,CAAC;AAmcF,IAAY,UAQX;AARD,WAAY,UAAU;IACrB,+CAAU,CAAA;IACV,+CAAU,CAAA;IACV,iDAAW,CAAA;IACX,qDAAa,CAAA;IACb,mDAAY,CAAA;IACZ,+CAAU,CAAA;IACV,mDAAY,CAAA;AACb,CAAC,EARW,UAAU,0BAAV,UAAU,QAQrB;AAED,IAAY,YAIX;AAJD,WAAY,YAAY;IACvB,qCAAqB,CAAA;IACrB,6CAA6B,CAAA;IAC7B,2CAA2B,CAAA;AAC5B,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB"}
1
+ {"version":3,"file":"components.js","sourceRoot":"","sources":["../../src/models/components.ts"],"names":[],"mappings":";;;AAKA,oDAAoD;AACpD,IAAY,cAwBX;AAxBD,WAAY,cAAc;IACzB,uCAAqB,CAAA;IACrB,iCAAe,CAAA;IACf,mCAAiB,CAAA;IACjB,uCAAqB,CAAA;IACrB,uCAAqB,CAAA;IACrB,2DAAyC,CAAA;IACzC,yCAAuB,CAAA;IACvB,+BAAa,CAAA;IACb,+CAA6B,CAAA;IAC7B,mDAAiC,CAAA;IACjC,+CAA6B,CAAA;IAC7B,yCAAuB,CAAA;IACvB,iCAAe,CAAA;IACf,iCAAe,CAAA;IACf,+BAAa,CAAA;IACb,qCAAmB,CAAA;IACnB,6CAA2B,CAAA;IAC3B,iDAA+B,CAAA;IAC/B,uDAAqC,CAAA;IACrC,yCAAuB,CAAA;IACvB,uDAAqC,CAAA;IACrC,qCAAmB,CAAA;IACnB,uCAAqB,CAAA;AACtB,CAAC,EAxBW,cAAc,8BAAd,cAAc,QAwBzB;AAEY,QAAA,iBAAiB,GAAG;IAChC,OAAO;IACP,MAAM;IACN,OAAO;IACP,UAAU;IACV,SAAS;IACT,QAAQ;IACR,WAAW;IACX,cAAc;IACd,WAAW;IACX,MAAM;IACN,gBAAgB;IAChB,OAAO;IACP,oBAAoB;IACpB,UAAU;IACV,cAAc;IACd,aAAa;IACb,eAAe;IACf,kBAAkB;IAClB,WAAW;IACX,kBAAkB;IAClB,SAAS;IACT,UAAU;CACV,CAAC;AA0mBF,IAAY,UAQX;AARD,WAAY,UAAU;IACrB,+CAAU,CAAA;IACV,+CAAU,CAAA;IACV,iDAAW,CAAA;IACX,qDAAa,CAAA;IACb,mDAAY,CAAA;IACZ,+CAAU,CAAA;IACV,mDAAY,CAAA;AACb,CAAC,EARW,UAAU,0BAAV,UAAU,QAQrB;AAED,IAAY,YAIX;AAJD,WAAY,YAAY;IACvB,qCAAqB,CAAA;IACrB,6CAA6B,CAAA;IAC7B,2CAA2B,CAAA;AAC5B,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB"}
@@ -3,7 +3,7 @@ export { IGeneralStatus } from './status';
3
3
  export { TriggerTypes, ITriggers } from './triggers';
4
4
  export { IWorkflow, IWorkflowCreatePayload, IWorkflowCreateRespose, IWorkflowUpdatePayload, IWorkflowUpdateResponse, IWorkflowDeletePayload, IWorkflowDeleteResponse } from './workflows';
5
5
  export { IActivity, IActivityRelease, IActivityEvent } from './activities';
6
- export { IComponent, IComponentLight, IComponentConfig, IActionUI, IReactionUI, IReminderUI, ITriggersUI, ISourceUI, IContentUI, IContentThenUI, ComponentTypeEnum, IComponentType, LinkComponent, LinkItem, IEventUI, CustomVoiceAgent, OrisVoice, CustomAgent, VoiceUpsellAgent, FaqAgent, } from './components';
6
+ export { IComponent, IComponentLight, IComponentConfig, IActionUI, IReactionUI, IReminderUI, ITriggersUI, ISourceUI, IContentUI, IContentThenUI, ComponentTypeEnum, IComponentType, LinkComponent, LinkItem, IEventUI, CustomVoiceAgent, OrisVoice, CustomAgent, CustomAgentV2, VoiceUpsellAgent, FaqAgent, } from './components';
7
7
  export { IChannel, IFacebookChannel, IWhatsAppChannel } from './channel';
8
8
  export { IReaction, ITrigger, IAction } from './step';
9
9
  export { IUser, IAccessUserLog } from './users';
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":";;;AAAA,mCAAmH;AAAjG,+FAAA,KAAK,OAAA;AAAmC,oGAAA,UAAU,OAAA;AAAc,wGAAA,cAAc,OAAA;AAChG,mCAA0C;AAAjC,wGAAA,cAAc,OAAA;AACvB,uCAAqD;AAA5C,wGAAA,YAAY,OAAA;AAGrB,2CAqBsB;AAVrB,+GAAA,iBAAiB,OAAA;AACjB,4GAAA,cAAc,OAAA;AAgBf,uCAeoB;AAXnB,2GAAA,eAAe,OAAA;AACf,kHAAA,sBAAsB,OAAA;AACtB,kHAAA,sBAAsB,OAAA;AACtB,yHAAA,6BAA6B,OAAA;AAC7B,kHAAA,sBAAsB,OAAA;AACtB,8GAAA,kBAAkB,OAAA;AAClB,gHAAA,oBAAoB,OAAA;AACpB,gHAAA,oBAAoB,OAAA;AACpB,mHAAA,uBAAuB,OAAA;AACvB,+GAAA,mBAAmB,OAAA;AACnB,gHAAA,oBAAoB,OAAA;AAGrB,mCAA+E;AAA/C,sGAAA,YAAY,OAAA;AAC5C,2DAAgK;AAAvJ,2HAAA,qBAAqB,OAAA;AAE9B,mDAAsE;AAA9C,qHAAA,mBAAmB,OAAA;AAE3C,mDAA0I;AAAjI,mHAAA,iBAAiB,OAAA;AAAsB,kHAAA,gBAAgB,OAAA;AAAqB,qHAAA,mBAAmB,OAAA;AAGxG,qDAAmK;AAAlF,mHAAA,gBAAgB,OAAA;AAAoB,qHAAA,kBAAkB,OAAA;AAEvI,6CAAkG;AAA5D,6GAAA,cAAc,OAAA;AAAE,mHAAA,oBAAoB,OAAA;AAE1E,qDAAuG;AAA7E,yHAAA,sBAAsB,OAAA;AAAE,4HAAA,yBAAyB,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":";;;AAAA,mCAAmH;AAAjG,+FAAA,KAAK,OAAA;AAAmC,oGAAA,UAAU,OAAA;AAAc,wGAAA,cAAc,OAAA;AAChG,mCAA0C;AAAjC,wGAAA,cAAc,OAAA;AACvB,uCAAqD;AAA5C,wGAAA,YAAY,OAAA;AAGrB,2CAsBsB;AAXrB,+GAAA,iBAAiB,OAAA;AACjB,4GAAA,cAAc,OAAA;AAiBf,uCAeoB;AAXnB,2GAAA,eAAe,OAAA;AACf,kHAAA,sBAAsB,OAAA;AACtB,kHAAA,sBAAsB,OAAA;AACtB,yHAAA,6BAA6B,OAAA;AAC7B,kHAAA,sBAAsB,OAAA;AACtB,8GAAA,kBAAkB,OAAA;AAClB,gHAAA,oBAAoB,OAAA;AACpB,gHAAA,oBAAoB,OAAA;AACpB,mHAAA,uBAAuB,OAAA;AACvB,+GAAA,mBAAmB,OAAA;AACnB,gHAAA,oBAAoB,OAAA;AAGrB,mCAA+E;AAA/C,sGAAA,YAAY,OAAA;AAC5C,2DAAgK;AAAvJ,2HAAA,qBAAqB,OAAA;AAE9B,mDAAsE;AAA9C,qHAAA,mBAAmB,OAAA;AAE3C,mDAA0I;AAAjI,mHAAA,iBAAiB,OAAA;AAAsB,kHAAA,gBAAgB,OAAA;AAAqB,qHAAA,mBAAmB,OAAA;AAGxG,qDAAmK;AAAlF,mHAAA,gBAAgB,OAAA;AAAoB,qHAAA,kBAAkB,OAAA;AAEvI,6CAAkG;AAA5D,6GAAA,cAAc,OAAA;AAAE,mHAAA,oBAAoB,OAAA;AAE1E,qDAAuG;AAA7E,yHAAA,sBAAsB,OAAA;AAAE,4HAAA,yBAAyB,OAAA"}
package/package.json CHANGED
@@ -1,106 +1,106 @@
1
1
  {
2
- "name": "@engyalo/workflow-types",
3
- "version": "1.4.2",
4
- "description": "",
5
- "main": "./lib/index.js",
6
- "types": "./lib/index.d.ts",
7
- "scripts": {
8
- "lint": "eslint . --ext ts --fix",
9
- "tsc": "tsc --build",
10
- "clearjs": "npx rimraf ./lib",
11
- "pretest": "typescript-json-schema src/models/workflows.ts \"*\" --strictNullChecks --noExtraProps --required --id workflowsSchema -o tests/schemas/workflows.schema.json",
12
- "test": "jest",
13
- "prebuild": "npm run clearjs",
14
- "build": "npm run tsc"
15
- },
16
- "repository": {
17
- "type": "git",
18
- "url": "git@github.com:yalochat/worfklows-types.git"
19
- },
20
- "directories": {
21
- "lib": "lib"
22
- },
23
- "files": [
24
- "lib"
25
- ],
26
- "keywords": [
27
- "workflow",
28
- "types"
29
- ],
30
- "author": "Engineering @ Yalo",
31
- "license": "MIT",
32
- "eslintConfig": {
33
- "extends": [
34
- "plugin:@typescript-eslint/recommended",
35
- "plugin:prettier/recommended"
36
- ],
37
- "parser": "@typescript-eslint/parser",
38
- "rules": {
39
- "quotes": [
40
- 2,
41
- "single",
42
- "avoid-escape"
43
- ],
44
- "no-debugger": "error",
45
- "no-process-env": "off",
46
- "import/prefer-default-export": "off",
47
- "@typescript-eslint/explicit-function-return-type": "off",
48
- "@typescript-eslint/no-unused-vars": [
49
- "error",
50
- {
51
- "vars": "all",
52
- "args": "after-used",
53
- "ignoreRestSiblings": true
54
- }
55
- ],
56
- "new-cap": [
57
- "error",
58
- {
59
- "capIsNewExceptions": [
60
- "Injectable",
61
- "Inject"
62
- ]
63
- }
64
- ],
65
- "prefer-destructuring": [
66
- "error",
67
- {
68
- "VariableDeclarator": {
69
- "array": false,
70
- "object": true
71
- },
72
- "AssignmentExpression": {
73
- "array": true,
74
- "object": false
75
- }
76
- },
77
- {
78
- "enforceForRenamedProperties": false
79
- }
80
- ]
81
- }
82
- },
83
- "devDependencies": {
84
- "@types/jest": "29.5.14",
85
- "@types/jest-json-schema": "6.1.5",
86
- "@types/node": "16.18.126",
87
- "@typescript-eslint/eslint-plugin": "6.10.0",
88
- "@typescript-eslint/parser": "6.10.0",
89
- "eslint": "8.57.1",
90
- "eslint-config-prettier": "10.1.8",
91
- "eslint-plugin-import": "2.32.0",
92
- "eslint-plugin-prettier": "5.5.5",
93
- "jest": "29.7.0",
94
- "jest-json-schema": "6.1.0",
95
- "prettier": "3.8.3",
96
- "ts-jest": "29.4.11",
97
- "typescript": "5.2.2",
98
- "typescript-json-schema": "0.62.0"
99
- },
100
- "dependencies": {
101
- "zod": "3.22.4"
102
- },
103
- "overrides": {
104
- "cross-spawn": "7.0.6"
105
- }
106
- }
2
+ "name": "@engyalo/workflow-types",
3
+ "version": "1.5.0-main-8336661",
4
+ "description": "",
5
+ "main": "./lib/index.js",
6
+ "types": "./lib/index.d.ts",
7
+ "scripts": {
8
+ "lint": "eslint . --ext ts --fix",
9
+ "tsc": "tsc --build",
10
+ "clearjs": "npx rimraf ./lib",
11
+ "pretest": "typescript-json-schema src/models/workflows.ts \"*\" --strictNullChecks --noExtraProps --required --id workflowsSchema -o tests/schemas/workflows.schema.json",
12
+ "test": "jest",
13
+ "prebuild": "npm run clearjs",
14
+ "build": "npm run tsc"
15
+ },
16
+ "repository": {
17
+ "type": "git",
18
+ "url": "git@github.com:yalochat/worfklows-types.git"
19
+ },
20
+ "directories": {
21
+ "lib": "lib"
22
+ },
23
+ "files": [
24
+ "lib"
25
+ ],
26
+ "keywords": [
27
+ "workflow",
28
+ "types"
29
+ ],
30
+ "author": "Engineering @ Yalo",
31
+ "license": "MIT",
32
+ "eslintConfig": {
33
+ "extends": [
34
+ "plugin:@typescript-eslint/recommended",
35
+ "plugin:prettier/recommended"
36
+ ],
37
+ "parser": "@typescript-eslint/parser",
38
+ "rules": {
39
+ "quotes": [
40
+ 2,
41
+ "single",
42
+ "avoid-escape"
43
+ ],
44
+ "no-debugger": "error",
45
+ "no-process-env": "off",
46
+ "import/prefer-default-export": "off",
47
+ "@typescript-eslint/explicit-function-return-type": "off",
48
+ "@typescript-eslint/no-unused-vars": [
49
+ "error",
50
+ {
51
+ "vars": "all",
52
+ "args": "after-used",
53
+ "ignoreRestSiblings": true
54
+ }
55
+ ],
56
+ "new-cap": [
57
+ "error",
58
+ {
59
+ "capIsNewExceptions": [
60
+ "Injectable",
61
+ "Inject"
62
+ ]
63
+ }
64
+ ],
65
+ "prefer-destructuring": [
66
+ "error",
67
+ {
68
+ "VariableDeclarator": {
69
+ "array": false,
70
+ "object": true
71
+ },
72
+ "AssignmentExpression": {
73
+ "array": true,
74
+ "object": false
75
+ }
76
+ },
77
+ {
78
+ "enforceForRenamedProperties": false
79
+ }
80
+ ]
81
+ }
82
+ },
83
+ "devDependencies": {
84
+ "@types/jest": "29.5.14",
85
+ "@types/jest-json-schema": "6.1.5",
86
+ "@types/node": "16.18.126",
87
+ "@typescript-eslint/eslint-plugin": "6.10.0",
88
+ "@typescript-eslint/parser": "6.10.0",
89
+ "eslint": "8.57.1",
90
+ "eslint-config-prettier": "10.1.8",
91
+ "eslint-plugin-import": "2.32.0",
92
+ "eslint-plugin-prettier": "5.5.5",
93
+ "jest": "29.7.0",
94
+ "jest-json-schema": "6.1.0",
95
+ "prettier": "3.8.3",
96
+ "ts-jest": "29.4.11",
97
+ "typescript": "5.2.2",
98
+ "typescript-json-schema": "0.62.0"
99
+ },
100
+ "dependencies": {
101
+ "zod": "3.22.4"
102
+ },
103
+ "overrides": {
104
+ "cross-spawn": "7.0.6"
105
+ }
106
+ }