@fluxyte/sdk 0.2.3 → 0.2.4
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.
package/README.md
CHANGED
|
@@ -91,7 +91,7 @@ const stop = client.streamChat(
|
|
|
91
91
|
{
|
|
92
92
|
message: "What's the next step?",
|
|
93
93
|
sessionId: "sess_123",
|
|
94
|
-
context: {
|
|
94
|
+
context: { service: "premium-support", userTarget: "admin" },
|
|
95
95
|
},
|
|
96
96
|
(event) => {
|
|
97
97
|
if (event.type === "meta") console.log("Answer ID:", event.answerId);
|
|
@@ -115,12 +115,12 @@ const stop = client.streamChat(
|
|
|
115
115
|
Context is required for chat requests. Minimum shape:
|
|
116
116
|
|
|
117
117
|
```ts
|
|
118
|
-
context: { product
|
|
118
|
+
context: { product?: string; service?: string; userTarget: string }
|
|
119
119
|
```
|
|
120
120
|
|
|
121
121
|
Best practices:
|
|
122
122
|
|
|
123
|
-
- Use stable `product` identifiers
|
|
123
|
+
- Use stable `product` or `service` identifiers
|
|
124
124
|
- Always pass `userTarget`
|
|
125
125
|
- Include `flowSlug` / `stepSlug` when available
|
|
126
126
|
- Provide at least one stable identity: `sessionId` or `context.userId`
|
|
@@ -136,7 +136,7 @@ Identity guidance:
|
|
|
136
136
|
await client.sendEvent({
|
|
137
137
|
type: "STEP_COMPLETED",
|
|
138
138
|
context: {
|
|
139
|
-
|
|
139
|
+
service: "premium-support",
|
|
140
140
|
userTarget: "admin",
|
|
141
141
|
stepSlug: "connect_database",
|
|
142
142
|
},
|
|
@@ -180,7 +180,7 @@ const { send, data, loading, error } = useChat();
|
|
|
180
180
|
await send({
|
|
181
181
|
message: "How do I connect my database?",
|
|
182
182
|
sessionId: "sess_123",
|
|
183
|
-
context: {
|
|
183
|
+
context: { service: "premium-support", userTarget: "admin" },
|
|
184
184
|
});
|
|
185
185
|
```
|
|
186
186
|
|
|
@@ -195,9 +195,9 @@ start({
|
|
|
195
195
|
});
|
|
196
196
|
```
|
|
197
197
|
|
|
198
|
-
## Multi-
|
|
198
|
+
## Multi-Target
|
|
199
199
|
|
|
200
|
-
Use `context.product` to isolate
|
|
200
|
+
Use `context.product` or `context.service` to isolate onboarding targets under one account (apps, APIs, and services).
|
|
201
201
|
|
|
202
202
|
## Error Handling
|
|
203
203
|
|
|
@@ -49,7 +49,15 @@ export interface components {
|
|
|
49
49
|
* - alerts-feature
|
|
50
50
|
* - payments-api
|
|
51
51
|
*/
|
|
52
|
-
product
|
|
52
|
+
product?: string;
|
|
53
|
+
/**
|
|
54
|
+
* @description Service identifier when organization onboarding is service-led.
|
|
55
|
+
* Examples:
|
|
56
|
+
* - tax-advisory
|
|
57
|
+
* - compliance-audit
|
|
58
|
+
* - premium-support
|
|
59
|
+
*/
|
|
60
|
+
service?: string;
|
|
53
61
|
/**
|
|
54
62
|
* @description Target user role or persona for the onboarding flow.
|
|
55
63
|
* Examples:
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"openapi.d.ts","sourceRoot":"","sources":["../../src/generated/openapi.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,gCAAgC;AAChC,KAAK,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG;KAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC;AAEnE,MAAM,WAAW,KAAK;IACpB,mBAAmB,EAAE;QACnB,IAAI,EAAE,UAAU,CAAC,sBAAsB,CAAC,CAAC;KAC1C,CAAC;IACF,SAAS,EAAE;QACT,IAAI,EAAE,UAAU,CAAC,sBAAsB,CAAC,CAAC;KAC1C,CAAC;IACF,WAAW,EAAE;QACX,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAC;KACpC,CAAC;CACH;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAE7C,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE;QACP,KAAK,EAAE;YACL,KAAK,EAAE,MAAM,CAAC;SACf,CAAC;QACF;;;WAGG;QACH,cAAc,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;QACtD,qBAAqB;QACrB,UAAU,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,UAAU,CAAC;QACnD,qBAAqB;QACrB,aAAa,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,WAAW,GAAG,OAAO,GAAG,eAAe,CAAC;QAC9F;;;;;;;;WAQG;QACH,iBAAiB,EAAE;YACjB;;;;;;eAMG;YACH,OAAO,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"openapi.d.ts","sourceRoot":"","sources":["../../src/generated/openapi.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,gCAAgC;AAChC,KAAK,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG;KAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC;AAEnE,MAAM,WAAW,KAAK;IACpB,mBAAmB,EAAE;QACnB,IAAI,EAAE,UAAU,CAAC,sBAAsB,CAAC,CAAC;KAC1C,CAAC;IACF,SAAS,EAAE;QACT,IAAI,EAAE,UAAU,CAAC,sBAAsB,CAAC,CAAC;KAC1C,CAAC;IACF,WAAW,EAAE;QACX,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAC;KACpC,CAAC;CACH;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAE7C,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE;QACP,KAAK,EAAE;YACL,KAAK,EAAE,MAAM,CAAC;SACf,CAAC;QACF;;;WAGG;QACH,cAAc,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;QACtD,qBAAqB;QACrB,UAAU,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,UAAU,CAAC;QACnD,qBAAqB;QACrB,aAAa,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,WAAW,GAAG,OAAO,GAAG,eAAe,CAAC;QAC9F;;;;;;;;WAQG;QACH,iBAAiB,EAAE;YACjB;;;;;;eAMG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB;;;;;;eAMG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB;;;;;;eAMG;YACH,UAAU,EAAE,MAAM,CAAC;YACnB,6DAA6D;YAC7D,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,6EAA6E;YAC7E,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,6DAA6D;YAC7D,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,kBAAkB;YAClB,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,GAAG,CAAC,EAAE,MAAM,CAAC;YACb,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;SACxB,CAAC;QACF,wFAAwF;QACxF,qBAAqB,EAAE;YACrB,OAAO,EAAE,MAAM,CAAC;YAChB,4FAA4F;YAC5F,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,mBAAmB,CAAC,CAAC;YACpD,qBAAqB;YACrB,MAAM,CAAC,EAAE,OAAO,CAAC;YACjB,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAC;SAClD,CAAC;QACF,YAAY,EAAE;YACZ,QAAQ,EAAE,MAAM,CAAC;YACjB,OAAO,EAAE,MAAM,CAAC;YAChB,UAAU,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,CAAC;SACjD,CAAC;QACF,sBAAsB,EAAE;YACtB,0CAA0C;YAC1C,QAAQ,EAAE,MAAM,CAAC;YACjB,uDAAuD;YACvD,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAC;YAChD,IAAI,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;YAC9C,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAC3B,OAAO,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,EAAE,CAAC;SACnD,CAAC;QACF,cAAc,EAAE;YACd,qBAAqB;YACrB,IAAI,EAAE,MAAM,CAAC;YACb,QAAQ,EAAE,MAAM,CAAC;SAClB,CAAC;QACF,eAAe,EAAE;YACf,qBAAqB;YACrB,IAAI,EAAE,OAAO,CAAC;YACd,UAAU,EAAE,MAAM,CAAC;SACpB,CAAC;QACF,cAAc,EAAE;YACd,qBAAqB;YACrB,IAAI,EAAE,MAAM,CAAC;YACb,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAC3B,IAAI,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;YAC9C,OAAO,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,EAAE,CAAC;SACnD,CAAC;QACF,eAAe,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,iBAAiB,CAAC,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAC;QAC9I,qBAAqB;QACrB,mBAAmB,EAAE,cAAc,GAAG,aAAa,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,WAAW,CAAC;QACxG,mHAAmH;QACnH,sBAAsB,EAAE,YAAY,CAAC,CAAC;YACpC,IAAI,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC;YACnD,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,mBAAmB,CAAC,CAAC;YACpD,IAAI,CAAC,EAAE;gBACL,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;aACxB,GAAG,IAAI,CAAC;SACV,CAAC,GAAG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;SACjC,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;QACvB,qBAAqB;QACrB,cAAc,EAAE,UAAU,GAAG,KAAK,GAAG,IAAI,GAAG,MAAM,GAAG,WAAW,CAAC;QACjE,eAAe,EAAE;YACf,QAAQ,EAAE,MAAM,CAAC;YACjB,MAAM,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAC;YAChD,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACzB,CAAC;KACH,CAAC;IACF,SAAS,EAAE,KAAK,CAAC;IACjB,UAAU,EAAE,KAAK,CAAC;IAClB,aAAa,EAAE,KAAK,CAAC;IACrB,OAAO,EAAE,KAAK,CAAC;IACf,SAAS,EAAE,KAAK,CAAC;CAClB;AAED,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAE1C,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAE7C,MAAM,WAAW,UAAU;IAEzB,oBAAoB,EAAE;QACpB,WAAW,EAAE;YACX,OAAO,EAAE;gBACP,kBAAkB,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,CAAC;aACpE,CAAC;SACH,CAAC;QACF,SAAS,EAAE;YACT,sBAAsB;YACtB,GAAG,EAAE;gBACH,OAAO,EAAE;oBACP,kBAAkB,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,wBAAwB,CAAC,CAAC;oBACpE,mBAAmB,EAAE,MAAM,CAAC;iBAC7B,CAAC;aACH,CAAC;SACH,CAAC;KACH,CAAC;IACF,oBAAoB,EAAE;QACpB,WAAW,EAAE;YACX,OAAO,EAAE;gBACP,kBAAkB,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,wBAAwB,CAAC,CAAC;aACrE,CAAC;SACH,CAAC;QACF,SAAS,EAAE;YACT,8BAA8B;YAC9B,GAAG,EAAE;gBACH,OAAO,EAAE,KAAK,CAAC;aAChB,CAAC;SACH,CAAC;KACH,CAAC;IACF,cAAc,EAAE;QACd,WAAW,EAAE;YACX,OAAO,EAAE;gBACP,kBAAkB,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,iBAAiB,CAAC,CAAC;aAC9D,CAAC;SACH,CAAC;QACF,SAAS,EAAE;YACT,sBAAsB;YACtB,GAAG,EAAE;gBACH,OAAO,EAAE,KAAK,CAAC;aAChB,CAAC;YACF,4BAA4B;YAC5B,GAAG,EAAE;gBACH,OAAO,EAAE,KAAK,CAAC;aAChB,CAAC;SACH,CAAC;KACH,CAAC;CACH"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useChat.d.ts","sourceRoot":"","sources":["../../src/react/useChat.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAGvD,KAAK,WAAW,GAAG,IAAI,CACrB,UAAU,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,EAC9C,QAAQ,CACT,CAAC;AAGF,wBAAgB,OAAO;oBAOH,WAAW;;;
|
|
1
|
+
{"version":3,"file":"useChat.d.ts","sourceRoot":"","sources":["../../src/react/useChat.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAGvD,KAAK,WAAW,GAAG,IAAI,CACrB,UAAU,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,EAC9C,QAAQ,CACT,CAAC;AAGF,wBAAgB,OAAO;oBAOH,WAAW;;;gBAmBk/D,qBAAsB;eAAgC,qBAAsB;;kBAAoE,qBAAsB;;;;;gBAAtK,qBAAsB;eAAgC,qBAAsB;;kBAAoE,qBAAsB;;;;EADtrE"}
|