@flamingo-stack/openframe-frontend-core 0.0.726 → 0.0.728
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/dist/{chunk-3UZET2G7.js → chunk-2F4DO7DS.js} +2 -2
- package/dist/{chunk-X2PG6XWF.cjs → chunk-32QAIKXR.cjs} +9 -9
- package/dist/{chunk-Q2G7NVFH.cjs → chunk-33QHEG7K.cjs} +289 -285
- package/dist/{chunk-VPABPC2M.cjs → chunk-4ICMFNCJ.cjs} +29 -56
- package/dist/{chunk-MZY6LBM5.cjs → chunk-5K3QUH7C.cjs} +3 -3
- package/dist/{chunk-AZKVHJA5.js → chunk-66XG5RFJ.js} +2 -2
- package/dist/{chunk-DXDLCYCM.cjs → chunk-7N6M77PI.cjs} +3 -3
- package/dist/{chunk-4ND65E2B.cjs → chunk-7VYBSCCL.cjs} +35 -35
- package/dist/{chunk-R3BOJNZI.cjs → chunk-APJCBQ7X.cjs} +16 -16
- package/dist/{chunk-RVSNXG6J.cjs → chunk-CELBOIKC.cjs} +488 -421
- package/dist/{chunk-MZ3TMXIX.cjs → chunk-CI7KWY6L.cjs} +3 -3
- package/dist/{chunk-COFT3YPA.js → chunk-EM3WCK2K.js} +5 -5
- package/dist/{chunk-YVWJ3TRY.js → chunk-GEUUDNCI.js} +5 -5
- package/dist/{chunk-SCTS3EMJ.js → chunk-GINCQZMM.js} +3 -3
- package/dist/{chunk-4VRHDFF2.js → chunk-HP4C2DFL.js} +1 -1
- package/dist/{chunk-NLWIBA55.js → chunk-HTQJSW3Y.js} +3 -3
- package/dist/{chunk-EHYAOIE4.cjs → chunk-OKEJY2GC.cjs} +8 -8
- package/dist/{chunk-RSE3MU4G.cjs → chunk-OYU7QNLQ.cjs} +11 -11
- package/dist/{chunk-NZYMMYWN.js → chunk-QL4RUHKU.js} +1 -1
- package/dist/{chunk-5SWQ2ZU5.cjs → chunk-RMXLHYEG.cjs} +26 -26
- package/dist/{chunk-MM66P4X4.js → chunk-SKEW5NMJ.js} +22 -49
- package/dist/{chunk-XEIDJ6SL.cjs → chunk-SSXQYS5K.cjs} +65 -65
- package/dist/{chunk-3XDVGHL4.js → chunk-TYMLEI2I.js} +2 -2
- package/dist/{chunk-SBPPM65Y.js → chunk-UF3NFAQK.js} +265 -198
- package/dist/{chunk-FMFCPX3R.cjs → chunk-UJZ5Y3RK.cjs} +33 -33
- package/dist/{chunk-C5KMQLJP.js → chunk-URYLQ4MC.js} +15 -11
- package/dist/{chunk-MQ3ZM7FJ.js → chunk-VGRQK7YS.js} +1 -1
- package/dist/{chunk-JYJBL7GD.js → chunk-XYSKJ7GA.js} +1 -1
- package/dist/{chunk-Z3VAFLYK.cjs → chunk-YREYU6DY.cjs} +9 -9
- package/dist/{chunk-VKR56R3U.js → chunk-ZDGK2TNJ.js} +3 -3
- package/dist/{cloud-tenants-5JTQ2ENQ.cjs → cloud-tenants-XP3L6PWO.cjs} +3 -3
- package/dist/{cloud-tenants-NH7VE7KE.js → cloud-tenants-XVVFCOK2.js} +2 -2
- package/dist/components/case-studies/index.cjs +14 -14
- package/dist/components/case-studies/index.js +3 -3
- package/dist/components/chat/assistant-ask-prompts.d.ts +34 -14
- package/dist/components/chat/assistant-ask-prompts.d.ts.map +1 -1
- package/dist/components/chat/hooks/index.d.ts +1 -1
- package/dist/components/chat/hooks/index.d.ts.map +1 -1
- package/dist/components/chat/hooks/use-ask-prompts.d.ts +34 -7
- package/dist/components/chat/hooks/use-ask-prompts.d.ts.map +1 -1
- package/dist/components/chat/index.cjs +2 -4
- package/dist/components/chat/index.js +3 -5
- package/dist/components/contact/index.cjs +4 -4
- package/dist/components/contact/index.js +3 -3
- package/dist/components/docs/index.cjs +7 -7
- package/dist/components/docs/index.js +6 -6
- package/dist/components/embeds/index.cjs +4 -4
- package/dist/components/embeds/index.js +3 -3
- package/dist/components/faq/faq-ask-card.d.ts +8 -11
- package/dist/components/faq/faq-ask-card.d.ts.map +1 -1
- package/dist/components/faq/index.cjs +4 -4
- package/dist/components/faq/index.js +3 -3
- package/dist/components/features/auth/auth-benefits-panel.d.ts +3 -1
- package/dist/components/features/auth/auth-benefits-panel.d.ts.map +1 -1
- package/dist/components/features/auth/auth-shell.d.ts +3 -1
- package/dist/components/features/auth/auth-shell.d.ts.map +1 -1
- package/dist/components/features/index.cjs +3 -3
- package/dist/components/features/index.js +2 -2
- package/dist/components/help-center-pages/index.cjs +71 -71
- package/dist/components/help-center-pages/index.js +13 -13
- package/dist/components/index.cjs +35 -37
- package/dist/components/index.js +14 -16
- package/dist/components/meeting-scheduler/index.cjs +19 -19
- package/dist/components/meeting-scheduler/index.js +2 -2
- package/dist/components/navigation/index.cjs +6 -6
- package/dist/components/navigation/index.js +5 -5
- package/dist/components/onboarding-guides/index.cjs +5 -5
- package/dist/components/onboarding-guides/index.js +4 -4
- package/dist/components/product-demo/index.cjs +6 -6
- package/dist/components/product-demo/index.js +6 -6
- package/dist/components/tickets/index.cjs +7 -7
- package/dist/components/tickets/index.js +6 -6
- package/dist/components/ui/index.cjs +3 -5
- package/dist/components/ui/index.js +4 -6
- package/dist/{devices-PV76NGQO.cjs → devices-MMHLY67A.cjs} +4 -4
- package/dist/{devices-OC7JEI6U.js → devices-S7PJJI66.js} +2 -2
- package/dist/index.cjs +7 -7
- package/dist/index.js +14 -14
- package/dist/{knowledge-5AYFIVKD.cjs → knowledge-LJNFAJNE.cjs} +4 -4
- package/dist/{knowledge-L7WQ7IEP.js → knowledge-WW3LOQKN.js} +2 -2
- package/dist/{logs-4F77RJXJ.cjs → logs-F4ZVNUKQ.cjs} +11 -11
- package/dist/{logs-MGFHGVIE.js → logs-I4DMHQDA.js} +2 -2
- package/dist/{policies-VCGM3C5Z.cjs → policies-KZXFXGD7.cjs} +7 -7
- package/dist/{policies-WRDZFNIB.js → policies-RX55V46V.js} +2 -2
- package/dist/{software-update-YD2MNL3K.cjs → software-update-4A242VDB.cjs} +6 -6
- package/dist/{software-update-WVG2GDZO.js → software-update-VI7FQYR4.js} +2 -2
- package/dist/utils/index.cjs +8 -6
- package/dist/utils/index.d.ts +1 -1
- package/dist/utils/index.d.ts.map +1 -1
- package/dist/utils/index.js +6 -5
- package/dist/utils/trial.d.ts +17 -9
- package/dist/utils/trial.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/components/chat/assistant-ask-prompts.tsx +84 -39
- package/src/components/chat/hooks/index.ts +3 -2
- package/src/components/chat/hooks/use-ask-prompts.ts +140 -56
- package/src/components/faq/faq-ask-card.tsx +22 -67
- package/src/components/features/auth/auth-benefits-panel.tsx +15 -8
- package/src/components/features/auth/auth-shell.tsx +4 -2
- package/src/utils/index.ts +1 -1
- package/src/utils/trial.ts +16 -10
|
@@ -1,74 +1,119 @@
|
|
|
1
1
|
'use client';
|
|
2
2
|
|
|
3
|
-
import { useMemo } from 'react';
|
|
4
3
|
import {
|
|
5
4
|
AssistantRuntimeContext,
|
|
6
5
|
useAssistantRuntime,
|
|
7
6
|
type AssistantOpenRequest,
|
|
8
7
|
} from '../../contexts/assistant-runtime-context';
|
|
9
|
-
import { AskPrompts, type AskPromptsProps } from './ask-prompts';
|
|
10
|
-
import {
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
}
|
|
8
|
+
import { AskCard, AskPrompts, type AskPromptsProps } from './ask-prompts';
|
|
9
|
+
import { assistantAvailable, ASK_PROMPTS_DEFAULT_COUNT, useAskSurface } from './hooks/use-ask-prompts';
|
|
10
|
+
|
|
11
|
+
/** The lib's own wording of the card, when neither the host nor the runtime states it. */
|
|
12
|
+
const DEFAULT_ASK_CARD = {
|
|
13
|
+
title: 'Still deciding?',
|
|
14
|
+
description: '{assistant} answers from our docs and customer stories.',
|
|
15
|
+
} as const;
|
|
16
|
+
|
|
17
|
+
const fillAssistant = (text: string, name: string) => text.split('{assistant}').join(name);
|
|
17
18
|
|
|
18
19
|
export interface AssistantAskPromptsProps extends Pick<AskPromptsProps, 'align' | 'fadeColor' | 'className'> {
|
|
19
|
-
/**
|
|
20
|
+
/**
|
|
21
|
+
* How the surface looks. `row` (default): the launcher, then the questions,
|
|
22
|
+
* for a page section. `card`: the "still deciding?" card beside a list of
|
|
23
|
+
* questions (a FAQ), with a title, a line of description and the launcher.
|
|
24
|
+
*/
|
|
25
|
+
variant?: 'row' | 'card';
|
|
26
|
+
/** What this surface is about: any string the host's questions endpoint knows. Reported with every click. */
|
|
20
27
|
topic?: string;
|
|
21
|
-
/** How many questions
|
|
28
|
+
/** How many questions it offers: the same number of slots on every load. Absent: three (a card: the runtime's, else three). */
|
|
22
29
|
count?: number;
|
|
30
|
+
/**
|
|
31
|
+
* Ids of questions never to offer. Absent: the ones the page's other "ask"
|
|
32
|
+
* surfaces show, which this one waits for. `null`: wait.
|
|
33
|
+
*/
|
|
34
|
+
exclude?: readonly string[] | null;
|
|
35
|
+
/** False: the surface does not pick yet (its host is waiting for it to be reached). Default true. */
|
|
36
|
+
enabled?: boolean;
|
|
23
37
|
/** The launcher's name. Absent: the assistant's configured name, else the launcher's default. */
|
|
24
38
|
label?: string;
|
|
25
|
-
/** Something else the
|
|
39
|
+
/** Something else the surface waits for (the host is still reading the name it will show). */
|
|
26
40
|
loading?: boolean;
|
|
27
|
-
/**
|
|
41
|
+
/** A card's wording. `{assistant}` is replaced by the assistant's name. Absent: the runtime's, else the lib's. */
|
|
42
|
+
title?: string;
|
|
43
|
+
description?: string;
|
|
44
|
+
/** How the chat is opened from THIS surface. Absent: the assistant runtime's opener. */
|
|
28
45
|
onOpen?: (request: AssistantOpenRequest) => void;
|
|
29
46
|
}
|
|
30
47
|
|
|
31
48
|
/**
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
49
|
+
* THE "ask the assistant" surface, wired by itself: a row of questions in a
|
|
50
|
+
* page section, or the card beside a FAQ (`variant`). Everything comes from
|
|
51
|
+
* the nearest assistant runtime (`AssistantRuntimeContext`) through ONE hook,
|
|
52
|
+
* `useAskSurface`: whether a chat is there, the identity, the questions the
|
|
53
|
+
* host picked for this surface's `topic`, the opener and the click report.
|
|
54
|
+
* Surfaces of one page pick one after another and never show a question
|
|
55
|
+
* another already shows, so two of them may share a topic. While a pick is on
|
|
56
|
+
* its way the surface is the SAME block (a chip skeleton in every slot), so
|
|
57
|
+
* nothing moves when the questions land.
|
|
58
|
+
*
|
|
59
|
+
* Nothing renders with no chat. A row also renders nothing with no questions
|
|
60
|
+
* endpoint, or once its pick has settled empty; a card needs the assistant's
|
|
61
|
+
* name for its words, and with no endpoint is the launcher alone.
|
|
41
62
|
*/
|
|
42
63
|
export function AssistantAskPrompts({
|
|
64
|
+
variant = 'row',
|
|
43
65
|
topic,
|
|
44
|
-
count
|
|
66
|
+
count,
|
|
67
|
+
exclude,
|
|
68
|
+
enabled,
|
|
45
69
|
label,
|
|
46
70
|
loading = false,
|
|
71
|
+
title,
|
|
72
|
+
description,
|
|
47
73
|
onOpen,
|
|
48
74
|
align,
|
|
49
75
|
fadeColor,
|
|
50
76
|
className,
|
|
51
77
|
}: AssistantAskPromptsProps) {
|
|
78
|
+
const card = variant === 'card';
|
|
52
79
|
const assistant = useAssistantRuntime();
|
|
53
|
-
const
|
|
54
|
-
const
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
80
|
+
const slots = count ?? (card ? assistant?.askCard?.count : undefined) ?? ASK_PROMPTS_DEFAULT_COUNT;
|
|
81
|
+
const ask = useAskSurface({ topic, count: slots, exclude, enabled, onOpen });
|
|
82
|
+
if (!assistantAvailable(assistant)) return null;
|
|
83
|
+
|
|
84
|
+
const shared = {
|
|
85
|
+
prompts: ask.prompts,
|
|
86
|
+
loading: ask.isLoading || loading,
|
|
87
|
+
source: assistant.source,
|
|
88
|
+
icon: assistant.icon,
|
|
89
|
+
onOpen: ask.open,
|
|
90
|
+
onAsk: ask.reportAsk,
|
|
91
|
+
};
|
|
92
|
+
if (card) {
|
|
93
|
+
const name = label ?? assistant.name;
|
|
94
|
+
if (!name) return null;
|
|
95
|
+
const words = description ?? assistant.askCard?.description ?? DEFAULT_ASK_CARD.description;
|
|
96
|
+
return (
|
|
97
|
+
<AssistantRuntimeContext.Provider value={ask.scoped}>
|
|
98
|
+
<AskCard
|
|
99
|
+
{...shared}
|
|
100
|
+
title={fillAssistant(title ?? assistant.askCard?.title ?? DEFAULT_ASK_CARD.title, name)}
|
|
101
|
+
description={words ? fillAssistant(words, name) : undefined}
|
|
102
|
+
// Fixed slots, one question per row: chip skeletons until the pick lands, the same box after.
|
|
103
|
+
count={ask.supported ? slots : 0}
|
|
104
|
+
label={name}
|
|
105
|
+
className={className}
|
|
106
|
+
/>
|
|
107
|
+
</AssistantRuntimeContext.Provider>
|
|
108
|
+
);
|
|
109
|
+
}
|
|
110
|
+
if (!ask.supported) return null;
|
|
61
111
|
return (
|
|
62
|
-
<AssistantRuntimeContext.Provider value={scoped}>
|
|
112
|
+
<AssistantRuntimeContext.Provider value={ask.scoped}>
|
|
63
113
|
<AskPrompts
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
count={count}
|
|
67
|
-
source={assistant.source}
|
|
114
|
+
{...shared}
|
|
115
|
+
count={slots}
|
|
68
116
|
label={label ?? assistant.name ?? undefined}
|
|
69
|
-
icon={assistant.icon}
|
|
70
|
-
onOpen={open}
|
|
71
|
-
onAsk={prompt => assistant.onAsk?.({ promptId: prompt.id, topic })}
|
|
72
117
|
align={align}
|
|
73
118
|
fadeColor={fadeColor}
|
|
74
119
|
className={className}
|
|
@@ -45,9 +45,10 @@ export {
|
|
|
45
45
|
buildAskPromptsUrl,
|
|
46
46
|
useAskPrompts,
|
|
47
47
|
useAssistantOpen,
|
|
48
|
-
|
|
49
|
-
useShownAskPrompts,
|
|
48
|
+
useAskSurface,
|
|
50
49
|
type AskPromptsResponse,
|
|
51
50
|
type UseAskPromptsOptions,
|
|
52
51
|
type UseAskPromptsResult,
|
|
52
|
+
type UseAskSurfaceOptions,
|
|
53
|
+
type UseAskSurfaceResult,
|
|
53
54
|
} from './use-ask-prompts';
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
'use client';
|
|
2
2
|
|
|
3
|
-
import { useCallback, useId, useLayoutEffect, useSyncExternalStore } from 'react';
|
|
3
|
+
import { useCallback, useId, useLayoutEffect, useMemo, useState, useSyncExternalStore } from 'react';
|
|
4
4
|
import {
|
|
5
5
|
useAssistantRuntime,
|
|
6
6
|
type AssistantOpenRequest,
|
|
@@ -71,8 +71,10 @@ export function useAskPrompts({
|
|
|
71
71
|
const assistant = useAssistantRuntime();
|
|
72
72
|
const base = assistantAvailable(assistant) ? assistant.askPromptsUrl : undefined;
|
|
73
73
|
const url = base && enabled ? buildAskPromptsUrl(base, { count, topic, exclude }) : null;
|
|
74
|
-
const { data,
|
|
75
|
-
|
|
74
|
+
const { data, dataUrl, error } = useSelfFetch<AskPromptsResponse>(url);
|
|
75
|
+
// Landed for THIS url (or failed): never the frame between a url appearing and its fetch starting.
|
|
76
|
+
const landed = url !== null && (dataUrl === url || error);
|
|
77
|
+
return { prompts: landed ? (data?.prompts ?? []) : [], isLoading: !!base && !landed, supported: !!base };
|
|
76
78
|
}
|
|
77
79
|
|
|
78
80
|
/**
|
|
@@ -99,90 +101,172 @@ export function useAssistantOpen(
|
|
|
99
101
|
);
|
|
100
102
|
}
|
|
101
103
|
|
|
102
|
-
// ───
|
|
103
|
-
// Every surface that
|
|
104
|
-
// a
|
|
105
|
-
//
|
|
106
|
-
//
|
|
107
|
-
//
|
|
108
|
-
//
|
|
104
|
+
// ─── One pick at a time, and never a question twice ──────────────────────────
|
|
105
|
+
// Every surface that offers questions (a row in a section, the FAQ's card)
|
|
106
|
+
// takes a TURN before it picks, in the order the surfaces came to need one:
|
|
107
|
+
// document order for the ones a page mounts together, later for one that waits
|
|
108
|
+
// to be reached (the FAQ's card). A surface picks once every surface ahead of
|
|
109
|
+
// it has settled, and leaves out every question the page already shows. So no
|
|
110
|
+
// two surfaces of a page can show the same question, whatever their topics,
|
|
111
|
+
// with no wiring by the host. One queue per QUESTIONS ENDPOINT (the runtime's
|
|
112
|
+
// `askPromptsUrl`): two assistants on one page read different questions, and
|
|
113
|
+
// never wait for or leave out each other's. A module store, read through
|
|
114
|
+
// React's external-store hook.
|
|
109
115
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
remove(surface: string): void;
|
|
116
|
+
/** One endpoint's queue: each surface's turn and the questions it settled on (`null`: not yet). */
|
|
117
|
+
interface AskQueue {
|
|
118
|
+
enter(surface: string): void;
|
|
119
|
+
settle(surface: string, ids: readonly string[] | null): void;
|
|
120
|
+
leave(surface: string): void;
|
|
116
121
|
subscribe(listener: () => void): () => void;
|
|
117
|
-
|
|
122
|
+
/**
|
|
123
|
+
* What `surface` must leave out, as a comma-joined list ('' for nothing),
|
|
124
|
+
* once it may pick; `null` while it has no turn or a surface ahead of it is
|
|
125
|
+
* still picking. A string, so React can compare two readings.
|
|
126
|
+
*/
|
|
127
|
+
turnOf(surface: string): string | null;
|
|
118
128
|
}
|
|
119
129
|
|
|
120
|
-
function
|
|
121
|
-
const
|
|
130
|
+
function createAskQueue(): AskQueue {
|
|
131
|
+
const entries = new Map<string, { turn: number; ids: readonly string[] | null }>();
|
|
122
132
|
const listeners = new Set<() => void>();
|
|
123
|
-
let
|
|
133
|
+
let next = 0;
|
|
124
134
|
const publish = (): void => {
|
|
125
|
-
const lists = [...bySurface.values()];
|
|
126
|
-
const next = lists.some(list => list === null) ? null : lists.flatMap(list => list ?? []);
|
|
127
|
-
const same = next === null ? snapshot === null : snapshot !== null && next.join(',') === snapshot.join(',');
|
|
128
|
-
if (same) return;
|
|
129
|
-
snapshot = next === null ? null : next.length > 0 ? next : NO_IDS;
|
|
130
135
|
for (const listener of listeners) listener();
|
|
131
136
|
};
|
|
132
137
|
return {
|
|
133
|
-
|
|
134
|
-
|
|
138
|
+
enter(surface) {
|
|
139
|
+
if (entries.has(surface)) return;
|
|
140
|
+
entries.set(surface, { turn: next++, ids: null });
|
|
135
141
|
publish();
|
|
136
142
|
},
|
|
137
|
-
|
|
138
|
-
|
|
143
|
+
settle(surface, ids) {
|
|
144
|
+
const entry = entries.get(surface);
|
|
145
|
+
if (!entry || (entry.ids?.join(',') ?? null) === (ids?.join(',') ?? null)) return;
|
|
146
|
+
entry.ids = ids;
|
|
139
147
|
publish();
|
|
140
148
|
},
|
|
149
|
+
leave(surface) {
|
|
150
|
+
if (entries.delete(surface)) publish();
|
|
151
|
+
},
|
|
141
152
|
subscribe(listener) {
|
|
142
153
|
listeners.add(listener);
|
|
143
154
|
return () => listeners.delete(listener);
|
|
144
155
|
},
|
|
145
|
-
|
|
156
|
+
turnOf(surface) {
|
|
157
|
+
const own = entries.get(surface);
|
|
158
|
+
if (!own) return null;
|
|
159
|
+
const shown: string[] = [];
|
|
160
|
+
for (const [other, entry] of entries) {
|
|
161
|
+
if (other === surface) continue;
|
|
162
|
+
if (entry.ids === null) {
|
|
163
|
+
if (entry.turn < own.turn) return null;
|
|
164
|
+
continue;
|
|
165
|
+
}
|
|
166
|
+
shown.push(...entry.ids);
|
|
167
|
+
}
|
|
168
|
+
return shown.join(',');
|
|
169
|
+
},
|
|
146
170
|
};
|
|
147
171
|
}
|
|
148
172
|
|
|
149
|
-
const
|
|
173
|
+
const askQueues = new Map<string, AskQueue>();
|
|
150
174
|
|
|
151
|
-
/** The
|
|
152
|
-
function
|
|
175
|
+
/** The queue a surface belongs to: the questions endpoint of its assistant runtime. */
|
|
176
|
+
function useAskQueue(): AskQueue {
|
|
153
177
|
const scope = useAssistantRuntime()?.askPromptsUrl ?? '';
|
|
154
|
-
let
|
|
155
|
-
if (!
|
|
156
|
-
|
|
157
|
-
|
|
178
|
+
let queue = askQueues.get(scope);
|
|
179
|
+
if (!queue) {
|
|
180
|
+
queue = createAskQueue();
|
|
181
|
+
askQueues.set(scope, queue);
|
|
158
182
|
}
|
|
159
|
-
return
|
|
183
|
+
return queue;
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
export interface UseAskSurfaceOptions {
|
|
187
|
+
/** What the surface is about (see `UseAskPromptsOptions.topic`). */
|
|
188
|
+
topic?: string;
|
|
189
|
+
count?: number;
|
|
190
|
+
/**
|
|
191
|
+
* Ids of questions never to offer. Absent: the ones the page's other
|
|
192
|
+
* surfaces show, which this one waits for. A list: exactly those, picked at
|
|
193
|
+
* once with no wait (the surfaces after it still leave its questions out).
|
|
194
|
+
* `null`: the surface waits and never picks.
|
|
195
|
+
*/
|
|
196
|
+
exclude?: readonly string[] | null;
|
|
197
|
+
/** False: the surface is not ready to pick yet (it takes its turn when it is). Default true. */
|
|
198
|
+
enabled?: boolean;
|
|
199
|
+
/** How the chat is opened from THIS surface. Absent: the assistant runtime's opener. */
|
|
200
|
+
onOpen?: (request: AssistantOpenRequest) => void;
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
export interface UseAskSurfaceResult extends UseAskPromptsResult {
|
|
204
|
+
/** The nearest assistant runtime; `null` with none mounted. */
|
|
205
|
+
assistant: AssistantRuntime | null;
|
|
206
|
+
/** The same runtime with THIS surface's opener: what the surface's launcher reads. */
|
|
207
|
+
scoped: AssistantRuntime | null;
|
|
208
|
+
/** Opens the chat (and asks, with a prompt), carrying the surface's topic. */
|
|
209
|
+
open: (request: { prompt?: string }) => void;
|
|
210
|
+
/** Reports a question that was asked (the runtime's `onAsk`, with the topic). */
|
|
211
|
+
reportAsk: (prompt: AskPrompt) => void;
|
|
160
212
|
}
|
|
161
213
|
|
|
162
214
|
/**
|
|
163
|
-
*
|
|
164
|
-
*
|
|
165
|
-
*
|
|
215
|
+
* THE wiring of an "ask" surface, whatever it looks like: the assistant
|
|
216
|
+
* runtime, the surface's questions (picked on its turn, never one the page
|
|
217
|
+
* already shows), the opener and the click report. `AssistantAskPrompts` is its
|
|
218
|
+
* one component; nothing else picks questions for a page.
|
|
166
219
|
*/
|
|
167
|
-
export function
|
|
220
|
+
export function useAskSurface({
|
|
221
|
+
topic,
|
|
222
|
+
count = ASK_PROMPTS_DEFAULT_COUNT,
|
|
223
|
+
exclude,
|
|
224
|
+
enabled = true,
|
|
225
|
+
onOpen,
|
|
226
|
+
}: UseAskSurfaceOptions = {}): UseAskSurfaceResult {
|
|
227
|
+
const assistant = useAssistantRuntime();
|
|
168
228
|
const surface = useId();
|
|
169
|
-
const
|
|
170
|
-
const
|
|
171
|
-
|
|
229
|
+
const queue = useAskQueue();
|
|
230
|
+
const picks = assistantAvailable(assistant) && !!assistant.askPromptsUrl && enabled && exclude !== null;
|
|
231
|
+
|
|
232
|
+
// A layout effect: surfaces a page mounts together take their turns in document order.
|
|
172
233
|
useLayoutEffect(() => {
|
|
173
|
-
if (
|
|
174
|
-
|
|
175
|
-
return () =>
|
|
176
|
-
}, [
|
|
177
|
-
|
|
234
|
+
if (!picks) return undefined;
|
|
235
|
+
queue.enter(surface);
|
|
236
|
+
return () => queue.leave(surface);
|
|
237
|
+
}, [queue, surface, picks]);
|
|
238
|
+
|
|
239
|
+
const turn = useSyncExternalStore(
|
|
240
|
+
queue.subscribe,
|
|
241
|
+
() => queue.turnOf(surface),
|
|
242
|
+
() => null,
|
|
243
|
+
);
|
|
244
|
+
// ONE pick per mount: what the page showed when this surface's turn came is what it leaves out, for good.
|
|
245
|
+
const [shownAtTurn, setShownAtTurn] = useState<string | null>(null);
|
|
246
|
+
if (picks && turn !== null && shownAtTurn === null) setShownAtTurn(turn);
|
|
247
|
+
const leftOut = useMemo(() => exclude ?? (shownAtTurn ? shownAtTurn.split(',') : undefined), [exclude, shownAtTurn]);
|
|
248
|
+
|
|
249
|
+
const { prompts, isLoading, supported } = useAskPrompts({
|
|
250
|
+
topic,
|
|
251
|
+
count,
|
|
252
|
+
exclude: leftOut,
|
|
253
|
+
// Told exactly what to leave out, a surface needs nobody's pick: it never waits for a turn.
|
|
254
|
+
enabled: picks && (exclude !== undefined || shownAtTurn !== null),
|
|
255
|
+
});
|
|
256
|
+
const settled = picks && !isLoading ? prompts.map(prompt => prompt.id).join(',') : null;
|
|
257
|
+
useLayoutEffect(() => {
|
|
258
|
+
queue.settle(surface, settled === null ? null : settled ? settled.split(',') : []);
|
|
259
|
+
}, [queue, surface, settled]);
|
|
178
260
|
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
const
|
|
182
|
-
|
|
261
|
+
const open = useAssistantOpen(topic, onOpen);
|
|
262
|
+
const scoped = useMemo(() => (assistant ? { ...assistant, open } : null), [assistant, open]);
|
|
263
|
+
const onAsk = assistant?.onAsk;
|
|
264
|
+
const reportAsk = useCallback((prompt: AskPrompt) => onAsk?.({ promptId: prompt.id, topic }), [onAsk, topic]);
|
|
265
|
+
// A surface that waits (not reached, or told to) is loading wherever questions can exist.
|
|
266
|
+
return { assistant, scoped, prompts, isLoading: supported && (!picks || isLoading), supported, open, reportAsk };
|
|
183
267
|
}
|
|
184
268
|
|
|
185
269
|
/** Tests only: forget every surface. */
|
|
186
|
-
export function
|
|
187
|
-
|
|
270
|
+
export function resetAskSurfaces(): void {
|
|
271
|
+
askQueues.clear();
|
|
188
272
|
}
|
|
@@ -1,21 +1,10 @@
|
|
|
1
1
|
'use client';
|
|
2
2
|
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
AssistantRuntimeContext,
|
|
6
|
-
useAssistantRuntime,
|
|
7
|
-
type AssistantOpenRequest,
|
|
8
|
-
type AssistantRuntime,
|
|
9
|
-
} from '../../contexts/assistant-runtime-context';
|
|
3
|
+
import { useState } from 'react';
|
|
4
|
+
import type { AssistantOpenRequest, AssistantRuntime } from '../../contexts/assistant-runtime-context';
|
|
10
5
|
import { useInView } from '../../hooks/ui/use-in-view';
|
|
11
|
-
import {
|
|
12
|
-
import {
|
|
13
|
-
assistantAvailable,
|
|
14
|
-
ASK_PROMPTS_DEFAULT_COUNT,
|
|
15
|
-
useAskPrompts,
|
|
16
|
-
useAssistantOpen,
|
|
17
|
-
useShownAskPromptIds,
|
|
18
|
-
} from '../chat/hooks/use-ask-prompts';
|
|
6
|
+
import { AssistantAskPrompts } from '../chat/assistant-ask-prompts';
|
|
7
|
+
import { assistantAvailable } from '../chat/hooks/use-ask-prompts';
|
|
19
8
|
|
|
20
9
|
/** The card beside a FAQ, as a host may shape it. Every field is optional. */
|
|
21
10
|
export interface FaqAskOptions {
|
|
@@ -29,8 +18,7 @@ export interface FaqAskOptions {
|
|
|
29
18
|
topic?: string;
|
|
30
19
|
/**
|
|
31
20
|
* Ids of questions never to offer. Absent: the ones the page's other "ask"
|
|
32
|
-
* surfaces show
|
|
33
|
-
* card waits for. `null`: wait.
|
|
21
|
+
* surfaces show, which the card waits for. `null`: wait.
|
|
34
22
|
*/
|
|
35
23
|
exclude?: readonly string[] | null;
|
|
36
24
|
/** How many questions the card offers. Absent: the runtime's, else three. */
|
|
@@ -46,70 +34,37 @@ export interface FaqAskOptions {
|
|
|
46
34
|
onOpen?: (request: AssistantOpenRequest) => void;
|
|
47
35
|
}
|
|
48
36
|
|
|
49
|
-
/** The lib's own wording, when neither the host nor the runtime states it. */
|
|
50
|
-
const DEFAULT_ASK_CARD = {
|
|
51
|
-
title: 'Still deciding?',
|
|
52
|
-
description: '{assistant} answers from our docs and customer stories.',
|
|
53
|
-
} as const;
|
|
54
|
-
|
|
55
37
|
/** How far below the viewport the card is when it picks its questions. */
|
|
56
38
|
const PICK_ROOT_MARGIN = '600px';
|
|
57
39
|
|
|
58
|
-
const fillAssistant = (text: string, name: string) => text.split('{assistant}').join(name);
|
|
59
|
-
|
|
60
40
|
/** True when a FAQ under this runtime shows the card: a chat to open, and a name for the card's words. */
|
|
61
41
|
export function faqAskCardShown(assistant: AssistantRuntime | null): assistant is AssistantRuntime {
|
|
62
42
|
return assistantAvailable(assistant) && !!assistant.name;
|
|
63
43
|
}
|
|
64
44
|
|
|
65
45
|
/**
|
|
66
|
-
* The "ask the assistant" card of a FAQ:
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
* height before and after the questions arrive. A host with no questions
|
|
72
|
-
* endpoint gets the launcher with no questions.
|
|
46
|
+
* The "ask the assistant" card of a FAQ: THE ask surface (`AssistantAskPrompts`)
|
|
47
|
+
* as a card, told when to pick. It picks ONCE, when the card first comes near
|
|
48
|
+
* the viewport: a visitor who never reaches the FAQ costs no request, and the
|
|
49
|
+
* card then leaves out every question the page above already shows. The card
|
|
50
|
+
* is the same height before and after the questions arrive.
|
|
73
51
|
*/
|
|
74
52
|
export function FaqAskCard({ topic, exclude, count, title, description, onOpen }: FaqAskOptions & { topic: string }) {
|
|
75
|
-
const assistant = useAssistantRuntime();
|
|
76
53
|
const { ref, inView } = useInView<HTMLDivElement>({ rootMargin: PICK_ROOT_MARGIN });
|
|
77
54
|
const [reached, setReached] = useState(false);
|
|
78
55
|
if (inView && !reached) setReached(true);
|
|
79
|
-
|
|
80
|
-
const shownElsewhere = useShownAskPromptIds();
|
|
81
|
-
const excluded = exclude === undefined ? shownElsewhere : exclude;
|
|
82
|
-
const slots = count ?? assistant?.askCard?.count ?? ASK_PROMPTS_DEFAULT_COUNT;
|
|
83
|
-
const { prompts, isLoading, supported } = useAskPrompts({
|
|
84
|
-
topic,
|
|
85
|
-
count: slots,
|
|
86
|
-
exclude: excluded ?? undefined,
|
|
87
|
-
enabled: reached && excluded !== null,
|
|
88
|
-
});
|
|
89
|
-
const open = useAssistantOpen(topic, onOpen);
|
|
90
|
-
// The card's launcher opens the same chat as its questions, with the card's topic: it reads the runtime.
|
|
91
|
-
const scoped = useMemo(() => (assistant ? { ...assistant, open } : null), [assistant, open]);
|
|
92
|
-
|
|
93
|
-
if (!faqAskCardShown(assistant) || !assistant.name) return null;
|
|
94
|
-
const name = assistant.name;
|
|
95
|
-
const cardDescription = description ?? assistant.askCard?.description ?? DEFAULT_ASK_CARD.description;
|
|
96
56
|
return (
|
|
97
|
-
<
|
|
98
|
-
<
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
onOpen={open}
|
|
110
|
-
onAsk={prompt => assistant.onAsk?.({ promptId: prompt.id, topic })}
|
|
111
|
-
/>
|
|
112
|
-
</div>
|
|
113
|
-
</AssistantRuntimeContext.Provider>
|
|
57
|
+
<div ref={ref}>
|
|
58
|
+
<AssistantAskPrompts
|
|
59
|
+
variant="card"
|
|
60
|
+
topic={topic}
|
|
61
|
+
count={count}
|
|
62
|
+
exclude={exclude}
|
|
63
|
+
enabled={reached}
|
|
64
|
+
title={title}
|
|
65
|
+
description={description}
|
|
66
|
+
onOpen={onOpen}
|
|
67
|
+
/>
|
|
68
|
+
</div>
|
|
114
69
|
);
|
|
115
70
|
}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
import type { ReactNode } from 'react';
|
|
4
4
|
import { cn } from '../../../utils/cn';
|
|
5
|
-
import {
|
|
5
|
+
import { trialLabels } from '../../../utils/trial';
|
|
6
6
|
import { OpenFrameLogo } from '../../icons';
|
|
7
7
|
import { FileOffIcon } from '../../icons-v2-generated/documents/file-off-icon';
|
|
8
8
|
import { CreditCardXmarkIcon } from '../../icons-v2-generated/finance/credit-card-xmark-icon';
|
|
@@ -19,6 +19,8 @@ export interface AuthBenefitsPanelProps {
|
|
|
19
19
|
title?: string;
|
|
20
20
|
description?: string;
|
|
21
21
|
benefits?: AuthBenefit[];
|
|
22
|
+
/** The free trial's length in days, as the host read it from the billing plan. Without it the length is not stated. */
|
|
23
|
+
trialDays?: number | null;
|
|
22
24
|
learnMoreLabel?: string;
|
|
23
25
|
learnMoreUrl?: string;
|
|
24
26
|
className?: string;
|
|
@@ -29,12 +31,16 @@ const DEFAULT_TITLE = 'The All-in-One Open Platform for MSPs';
|
|
|
29
31
|
const DEFAULT_DESCRIPTION =
|
|
30
32
|
'All your core ops in one place - built for MSPs who are done duct-taping tools together. Unified stack, AI-ready, no vendor tax. Just solid software that lets you run lean and fast.';
|
|
31
33
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
34
|
+
/** The default chips: the trial's terms, and its length when the host knows it. */
|
|
35
|
+
function defaultBenefits(trialDays: number | null | undefined): AuthBenefit[] {
|
|
36
|
+
const labels = trialLabels(trialDays);
|
|
37
|
+
return [
|
|
38
|
+
{ icon: <CreditCardXmarkIcon />, label: labels.noCard },
|
|
39
|
+
{ icon: <XmarkAltIcon />, label: labels.cancel },
|
|
40
|
+
...(labels.length ? [{ icon: <FlaskVialIcon />, label: labels.length }] : []),
|
|
41
|
+
{ icon: <FileOffIcon />, label: labels.noContract },
|
|
42
|
+
];
|
|
43
|
+
}
|
|
38
44
|
|
|
39
45
|
/**
|
|
40
46
|
* Marketing panel shown alongside the auth forms — title, blurb, benefit chips
|
|
@@ -43,7 +49,8 @@ const DEFAULT_BENEFITS: AuthBenefit[] = [
|
|
|
43
49
|
export function AuthBenefitsPanel({
|
|
44
50
|
title = DEFAULT_TITLE,
|
|
45
51
|
description = DEFAULT_DESCRIPTION,
|
|
46
|
-
|
|
52
|
+
trialDays,
|
|
53
|
+
benefits = defaultBenefits(trialDays),
|
|
47
54
|
learnMoreLabel = 'Learn More About OpenFrame',
|
|
48
55
|
learnMoreUrl = 'https://www.flamingo.run/',
|
|
49
56
|
className,
|
|
@@ -12,6 +12,8 @@ export interface AuthShellProps {
|
|
|
12
12
|
children: ReactNode;
|
|
13
13
|
/** Marketing panel. Defaults to <AuthBenefitsPanel />. */
|
|
14
14
|
benefits?: ReactNode;
|
|
15
|
+
/** The free trial's length in days, from the host's billing plan; the default panel states it when given. */
|
|
16
|
+
trialDays?: number | null;
|
|
15
17
|
/** Pinned to the bottom-left of the form column on desktop only (e.g. "Back to Login"). */
|
|
16
18
|
footer?: ReactNode;
|
|
17
19
|
className?: string;
|
|
@@ -28,8 +30,8 @@ export interface AuthShellProps {
|
|
|
28
30
|
* `of-auth-shell` on the root is a stable hook for shell/consumer CSS (the
|
|
29
31
|
* native mobile shell pads it by the top safe-area inset).
|
|
30
32
|
*/
|
|
31
|
-
export function AuthShell({ tabs, children, benefits, footer, className }: AuthShellProps) {
|
|
32
|
-
const benefitsNode = benefits ?? <AuthBenefitsPanel />;
|
|
33
|
+
export function AuthShell({ tabs, children, benefits, trialDays, footer, className }: AuthShellProps) {
|
|
34
|
+
const benefitsNode = benefits ?? <AuthBenefitsPanel trialDays={trialDays} />;
|
|
33
35
|
|
|
34
36
|
return (
|
|
35
37
|
<div
|
package/src/utils/index.ts
CHANGED
|
@@ -19,7 +19,7 @@ export {
|
|
|
19
19
|
export { formatDate, formatNumber, formatPrice, formatBytes, formatUrlForDisplay } from './format';
|
|
20
20
|
export * from './ai-providers';
|
|
21
21
|
export * from './model-token-rates';
|
|
22
|
-
export {
|
|
22
|
+
export { TRIAL_TERMS, trialLabels, trialLengthLabel } from './trial';
|
|
23
23
|
export {
|
|
24
24
|
VENDOR_CLASSIFICATIONS,
|
|
25
25
|
OPENFRAME_CLASSIFICATIONS,
|