@sunboard/react 0.1.2 → 0.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.
- package/dist/index.d.mts +79 -8
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +390 -28
- package/dist/index.mjs.map +1 -1
- package/dist/styles.css +773 -560
- package/package.json +2 -2
package/dist/index.d.mts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { ReactNode } from "react";
|
|
2
2
|
import { RuntimeBootstrapRequest, RuntimeBootstrapResponse, RuntimeExperience, RuntimeProgress, RuntimeTrackRequest, RuntimeTrackResponse, SunboardRuntimeApiError, SunboardRuntimeClient, SunboardRuntimeClientOptions } from "@sunboard/core/runtime-api";
|
|
3
|
-
import * as
|
|
4
|
-
import { NormalizedSunboardSpec, SunboardHotspot, SunboardStep, SunboardTourStep, TrackEventName } from "@sunboard/core";
|
|
3
|
+
import * as react_jsx_runtime1 from "react/jsx-runtime";
|
|
4
|
+
import { NormalizedSunboardSpec, SunboardHotspot, SunboardStep, SunboardTourStep, SurveyQuestionType, TrackEventName } from "@sunboard/core";
|
|
5
5
|
|
|
6
6
|
//#region src/adapters/navigation.d.ts
|
|
7
7
|
type NavigateCallback = (url: string) => void | Promise<void>;
|
|
@@ -20,6 +20,12 @@ type TrackResult = {
|
|
|
20
20
|
ok: false;
|
|
21
21
|
reason: "not-ready" | "missing-user" | "network-error";
|
|
22
22
|
};
|
|
23
|
+
type SurveyResult = {
|
|
24
|
+
ok: true;
|
|
25
|
+
} | {
|
|
26
|
+
ok: false;
|
|
27
|
+
reason: "not-ready" | "missing-user" | "not-survey" | "network-error";
|
|
28
|
+
};
|
|
23
29
|
type TourResult = {
|
|
24
30
|
ok: true;
|
|
25
31
|
} | {
|
|
@@ -54,8 +60,22 @@ type SunboardContextValue = {
|
|
|
54
60
|
activeTour: ActiveSunboardTour | null;
|
|
55
61
|
tourError: SunboardTourError | null;
|
|
56
62
|
track: (eventName: TrackEventName, properties?: TrackProperties) => Promise<TrackResult>;
|
|
63
|
+
/**
|
|
64
|
+
* Submit survey answers for the active survey experience. On success the
|
|
65
|
+
* runtime re-bootstraps so the freshly collected attributes route the user
|
|
66
|
+
* into the next experience in-session.
|
|
67
|
+
*/
|
|
68
|
+
submitSurvey: (answers: Record<string, unknown>) => Promise<SurveyResult>;
|
|
57
69
|
startTour: (tourKey: string) => Promise<TourResult>;
|
|
58
|
-
|
|
70
|
+
/**
|
|
71
|
+
* Close the active tour. User-initiated dismissals are reported to the
|
|
72
|
+
* runtime API as a negative signal ("the user bailed at this step");
|
|
73
|
+
* pass `silent: true` for programmatic closes (e.g. a missing tour
|
|
74
|
+
* target) that say nothing about the user's intent.
|
|
75
|
+
*/
|
|
76
|
+
dismissTour: (options?: {
|
|
77
|
+
silent?: boolean;
|
|
78
|
+
}) => Promise<TourResult>;
|
|
59
79
|
advanceTour: () => Promise<TourResult>;
|
|
60
80
|
navigateToStep: (step: SunboardStep) => Promise<void>;
|
|
61
81
|
startChecklistStep: (step: SunboardStep) => Promise<TourResult | void>;
|
|
@@ -97,18 +117,20 @@ declare function SunboardProvider({
|
|
|
97
117
|
environment,
|
|
98
118
|
onTrack,
|
|
99
119
|
children
|
|
100
|
-
}: SunboardProviderProps):
|
|
120
|
+
}: SunboardProviderProps): react_jsx_runtime1.JSX.Element;
|
|
101
121
|
//#endregion
|
|
102
122
|
//#region src/components/SunboardHotspots.d.ts
|
|
103
|
-
declare function SunboardHotspots():
|
|
123
|
+
declare function SunboardHotspots(): react_jsx_runtime1.JSX.Element;
|
|
104
124
|
//#endregion
|
|
105
125
|
//#region src/components/SunboardTour.d.ts
|
|
106
|
-
declare function SunboardTour():
|
|
126
|
+
declare function SunboardTour(): react_jsx_runtime1.JSX.Element | null;
|
|
107
127
|
//#endregion
|
|
108
128
|
//#region src/components/Sunboard.d.ts
|
|
109
|
-
declare function SunboardChecklist():
|
|
129
|
+
declare function SunboardChecklist(): react_jsx_runtime1.JSX.Element | null;
|
|
130
|
+
declare function SunboardSurvey(): react_jsx_runtime1.JSX.Element | null;
|
|
110
131
|
declare const Sunboard: typeof SunboardChecklist & {
|
|
111
132
|
Checklist: typeof SunboardChecklist;
|
|
133
|
+
Survey: typeof SunboardSurvey;
|
|
112
134
|
Hotspots: typeof SunboardHotspots;
|
|
113
135
|
Tour: typeof SunboardTour;
|
|
114
136
|
};
|
|
@@ -157,5 +179,54 @@ type UseChecklistResult = {
|
|
|
157
179
|
};
|
|
158
180
|
declare function useChecklist(): UseChecklistResult;
|
|
159
181
|
//#endregion
|
|
160
|
-
|
|
182
|
+
//#region src/hooks/useSurvey.d.ts
|
|
183
|
+
type SurveyViewOption = {
|
|
184
|
+
value: string;
|
|
185
|
+
label: string;
|
|
186
|
+
};
|
|
187
|
+
type SurveyViewQuestion = {
|
|
188
|
+
key: string;
|
|
189
|
+
prompt: string;
|
|
190
|
+
type: SurveyQuestionType;
|
|
191
|
+
required: boolean;
|
|
192
|
+
options: SurveyViewOption[];
|
|
193
|
+
};
|
|
194
|
+
type SurveyViewStep = {
|
|
195
|
+
title?: string;
|
|
196
|
+
subtitle?: string;
|
|
197
|
+
questions: SurveyViewQuestion[];
|
|
198
|
+
};
|
|
199
|
+
type UseSurveyResult = {
|
|
200
|
+
visible: boolean;
|
|
201
|
+
title?: string;
|
|
202
|
+
subtitle?: string;
|
|
203
|
+
/** Every question across all steps — for all-at-once renderers (the built-in modal). */
|
|
204
|
+
questions: SurveyViewQuestion[];
|
|
205
|
+
/** The authored step grouping (one question per step by default). */
|
|
206
|
+
steps: SurveyViewStep[];
|
|
207
|
+
/** Hook-owned navigation. */
|
|
208
|
+
stepIndex: number;
|
|
209
|
+
totalSteps: number;
|
|
210
|
+
currentStep?: SurveyViewStep;
|
|
211
|
+
progress: number;
|
|
212
|
+
isFirstStep: boolean;
|
|
213
|
+
isLastStep: boolean;
|
|
214
|
+
/** True when the current step's required questions are answered. */
|
|
215
|
+
canAdvance: boolean;
|
|
216
|
+
/** Advance to the next step, or submit on the last step. */
|
|
217
|
+
next: () => void;
|
|
218
|
+
back: () => void;
|
|
219
|
+
answers: Record<string, unknown>;
|
|
220
|
+
setAnswer: (key: string, value: string) => void;
|
|
221
|
+
toggleAnswer: (key: string, value: string) => void;
|
|
222
|
+
isAnswered: (key: string) => boolean;
|
|
223
|
+
/** True when every required question (across all steps) is answered. */
|
|
224
|
+
canSubmit: boolean;
|
|
225
|
+
submitting: boolean;
|
|
226
|
+
error: string | null;
|
|
227
|
+
submit: () => Promise<void>;
|
|
228
|
+
};
|
|
229
|
+
declare function useSurvey(): UseSurveyResult;
|
|
230
|
+
//#endregion
|
|
231
|
+
export { type ChecklistViewStep, type RuntimeBootstrapRequest, type RuntimeBootstrapResponse, type RuntimeExperience, type RuntimeProgress, type RuntimeTrackRequest, type RuntimeTrackResponse, Sunboard, SunboardChecklist, type SunboardContextValue, SunboardHotspots, type SunboardPreviewSpecState, SunboardProvider, type SunboardProviderProps, SunboardRuntimeApiError, SunboardRuntimeClient, type SunboardRuntimeClientOptions, type SunboardRuntimeMode, SunboardSurvey, SunboardTour, type SunboardTourError, type SunboardUser, type SurveyResult, type SurveyViewOption, type SurveyViewQuestion, type SurveyViewStep, type TourResult, type TrackProperties, type TrackResult, type UseChecklistResult, type UseSurveyResult, useChecklist, useSunboard, useSunboardPreviewSpec, useSurvey };
|
|
161
232
|
//# sourceMappingURL=index.d.mts.map
|
package/dist/index.d.mts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","names":[],"sources":["../src/adapters/navigation.ts","../src/hooks/sunboard-context.ts","../src/components/SunboardProvider.tsx","../src/components/SunboardHotspots.tsx","../src/components/SunboardTour.tsx","../src/components/Sunboard.tsx","../src/hooks/useSunboardPreviewSpec.ts","../src/hooks/useSunboard.ts","../src/hooks/useChecklist.ts"],"sourcesContent":[],"mappings":";;;;;;KAAY,gBAAA,2BAA2C;;;KCS3C,YAAA;;;;eAIG;ADbf,CAAA;KCgBY,eAAA,GAAkB;KAElB,WAAA;;AATZ,CAAA,GAAY;EAOA,EAAA,EAAA,KAAA;EAEA,MAAA,EAAA,WAAW,GAAA,cAAA,GAAA,eAAA;AAIvB,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.mts","names":[],"sources":["../src/adapters/navigation.ts","../src/hooks/sunboard-context.ts","../src/components/SunboardProvider.tsx","../src/components/SunboardHotspots.tsx","../src/components/SunboardTour.tsx","../src/components/Sunboard.tsx","../src/hooks/useSunboardPreviewSpec.ts","../src/hooks/useSunboard.ts","../src/hooks/useChecklist.ts","../src/hooks/useSurvey.ts"],"sourcesContent":[],"mappings":";;;;;;KAAY,gBAAA,2BAA2C;;;KCS3C,YAAA;;;;eAIG;ADbf,CAAA;KCgBY,eAAA,GAAkB;KAElB,WAAA;;AATZ,CAAA,GAAY;EAOA,EAAA,EAAA,KAAA;EAEA,MAAA,EAAA,WAAW,GAAA,cAAA,GAAA,eAAA;AAIvB,CAAA;AAOY,KAPA,YAAA,GAOU;EAIV,EAAA,EAAA,IAAA;AAEZ,CAAA,GAAY;EAQA,EAAA,EAAA,KAAA;EAQA,MAAA,EAAA,WAAA,GAAA,cAAoB,GAAA,YAAA,GAAA,eAAA;CACvB;AACA,KAxBG,UAAA,GAwBH;EAGD,EAAA,EAAA,IAAA;CACa,GAAA;EACA,EAAA,EAAA,KAAA;EAGP,MAAA,EAAA,WAAA,GAAA,cAAA,GAAA,cAAA;CACD;AAEE,KA/BH,mBAAA,GA+BG,YAAA,GAAA,SAAA;AACE,KA9BL,iBAAA,GA8BK;EACF,OAAA,EAAA,MAAA;EAAR,KAAA,CAAA,EAAA,MAAA;EAMmB,OAAA,CAAA,EAAA,MAAA;EAAoC,MAAA,CAAA,EAAA,MAAA;EAAR,OAAA,EAAA,MAAA;CACZ;AAAR,KA9BtB,kBAAA,GA8BsB;EAOyB,GAAA,EAAA,MAAA;EAAR,IAAA,EAAA,MAAA;EACtB,IAAA,EAnCrB,gBAmCqB;EAAR,SAAA,EAAA,MAAA;EACI,UAAA,EAAA,MAAA;CAAiB;AACb,KAhCjB,oBAAA,GAgCiB;EAAyB,IAAA,CAAA,EA/B7C,sBA+B6C,GAAA,IAAA;EAAR,IAAA,CAAA,EA9BrC,YA8BqC,GAAA,IAAA;EACnB,OAAA,EAAA,OAAA;EACsB,KAAA,CAAA,EAAA,MAAA;EAA9B,IAAA,EA7BX,mBA6BW;EAAK,iBAAA,EA5BH,WA4BG,CAAA,MAAA,CAAA;qBA3BH;;;ECnBT,UAAA,EDsBE,kBCtBmB,GAAA,IAAA;EACxB,SAAA,EDsBI,iBCtBJ,GAAA,IAAA;EACA,KAAA,EAAA,CAAA,SAAA,EDuBM,cCvBN,EAAA,UAAA,CAAA,EDwBQ,eCxBR,EAAA,GDyBF,OCzBE,CDyBM,WCzBN,CAAA;EAEA;;;;;EAeG,YAAA,EAAA,CAAA,OAAA,EDcc,MCdd,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,GDc0C,OCd1C,CDckD,YCdlD,CAAA;EAAS,SAAA,EAAA,CAAA,OAAA,EAAA,MAAA,EAAA,GDea,OCfb,CDeqB,UCfrB,CAAA;EAeL;;;;;;EAMd,WAAA,EAAA,CAAA,OAEA,CAFA,EAAA;IACA,MAAA,CAAA,EAAA,OAAA;EACA,CAAA,EAAA,GDDiD,OCCjD,CDDyD,UCCzD,CAAA;EACA,WAAA,EAAA,GAAA,GDDmB,OCCnB,CDD2B,UCC3B,CAAA;EACA,cAAA,EAAA,CAAA,IAAA,EDDuB,YCCvB,EAAA,GDDwC,OCCxC,CAAA,IAAA,CAAA;EACA,kBAAA,EAAA,CAAA,IAAA,EDD2B,YCC3B,EAAA,GDD4C,OCC5C,CDDoD,UCCpD,GAAA,IAAA,CAAA;EACC,eAAA,EAAA,CAAA,KAAA,EDDwB,iBCCxB,GAAA,IAAA,EAAA,GAAA,IAAA;EAAqB,eAAA,EDAL,KCAK,CAAA;IAAA,GAAA,EAAA,MAAA;aDAyB;;;;;KC9CrC,qBAAA;SACH;EFxCG,IAAA,CAAA,EEyCH,YFzCmB,GAAA,IAAA;;SE2CnB;;EDlCG,QAAA,CAAA,ECoCC,gBDhCE;EAGH;AAEZ;AAIA;AAOA;AAIA;EAEY,MAAA,CAAA,EAAA,MAAA;EAQA,cAAA,CAAA,EAAA,MAAkB;EAQlB,WAAA,CAAA,EAAA,MAAA;EACH,OAAA,CAAA,EAAA,CAAA,SAAA,ECGM,cDHN,EAAA,UAAA,CAAA,ECIQ,eDJR,EAAA,GAAA,IAAA,GCKK,ODLL,CAAA,IAAA,CAAA;EACA,QAAA,ECKG,SDLH;CAGD;AACa,iBCgBL,gBAAA,CDhBK;EAAA,IAAA,ECiBb,QDjBa;EAAA,IAAA;EAAA,OAAA,ECmBV,WDnBU;EAAA,IAAA,ECoBb,QDpBa;EAAA,KAAA;EAAA,QAAA;EAAA,MAAA;EAAA,cAAA;EAAA,WAAA;EAAA,OAAA;EAAA;AAAA,CAAA,EC4BlB,qBD5BkB,CAAA,EC4BG,kBAAA,CAAA,GAAA,CAAA,OD5BH;;;iBEtCL,gBAAA,CAAA,GAAgB,kBAAA,CAAA,GAAA,CAAA;;;iBCJhB,YAAA,CAAA,GAAY,kBAAA,CAAA,GAAA,CAAA,OAAA;;;iBCRZ,iBAAA,CAAA,GAAiB,kBAAA,CAAA,GAAA,CAAA,OAAA;iBAyIjB,cAAA,CAAA,GAAc,kBAAA,CAAA,GAAA,CAAA,OAAA;cA0KjB,iBAAQ;;EL1TT,MAAA,EAAA,qBAAgB;;;;;;KMKhB,wBAAA;SACH;;;QAGD;ANTR,CAAA;iBMYgB,sBAAA,CAAA,GAA0B;;;iBCT1B,WAAA,CAAA,GAAe;;;KCEnB,iBAAA;;;;;;ARLZ,CAAA;KQaY,mBAAA;;;EPJA,OAAA,CAAA,EAAA,MAAY;EAOZ,cAAA,CAAA,EAAA,MAAe;AAE3B,CAAA;AAIY,KOFA,kBAAA,GPEY;EAOZ,OAAA,EAAA,OAAU;EAIV,KAAA,CAAA,EAAA,MAAA;EAEA,QAAA,CAAA,EAAA,MAAA;EAQA,KAAA,EOnBH,iBPmBqB,EAAA;EAQlB,iBAAA,EO1BS,WP0BW,CAAA,MAAA,CAAA;EACvB,cAAA,EAAA,MAAA;EACA,UAAA,EAAA,MAAA;EAGD,cAAA,EAAA,MAAA;EACa,QAAA,EAAA,MAAA;EACA,WAAA,EAAA,CAAA,GAAA,EAAA,MAAA,EAAA,GAAA,OAAA;EAGP,SAAA,EAAA,CAAA,IAAA,EO9BM,iBP8BN,EAAA,GAAA,OAAA;EACD,SAAA,EAAA,CAAA,IAAA,EO9BO,iBP8BP,EAAA,GAAA,IAAA;EAEE,UAAA,CAAA,EO/BA,mBP+BA;EACE,iBAAA,EAAA,GAAA,GAAA,IAAA;CACF;AAAR,iBOZS,YAAA,CAAA,CPYT,EOZyB,kBPYzB;;;KQ7DK,gBAAA;;;;KAKA,kBAAA;ETVA,GAAA,EAAA,MAAA;;QSaJ;;ERJI,OAAA,EQMD,gBRNa,EAIT;AAGf,CAAA;AAEY,KQAA,cAAA,GRAW;EAIX,KAAA,CAAA,EAAA,MAAA;EAOA,QAAA,CAAA,EAAA,MAAU;EAIV,SAAA,EQZC,kBRYkB,EAAA;AAE/B,CAAA;AAQY,KQnBA,eAAA,GRmBkB;EAQlB,OAAA,EAAA,OAAA;EACH,KAAA,CAAA,EAAA,MAAA;EACA,QAAA,CAAA,EAAA,MAAA;EAGD;EACa,SAAA,EQ5BR,kBR4BQ,EAAA;EACA;EAGP,KAAA,EQ9BL,cR8BK,EAAA;EACD;EAEE,SAAA,EAAA,MAAA;EACE,UAAA,EAAA,MAAA;EACF,WAAA,CAAA,EQ/BC,cR+BD;EAAR,QAAA,EAAA,MAAA;EAMmB,WAAA,EAAA,OAAA;EAAoC,UAAA,EAAA,OAAA;EAAR;EACZ,UAAA,EAAA,OAAA;EAAR;EAOyB,IAAA,EAAA,GAAA,GAAA,IAAA;EAAR,IAAA,EAAA,GAAA,GAAA,IAAA;EACtB,OAAA,EQrClB,MRqCkB,CAAA,MAAA,EAAA,OAAA,CAAA;EAAR,SAAA,EAAA,CAAA,GAAA,EAAA,MAAA,EAAA,KAAA,EAAA,MAAA,EAAA,GAAA,IAAA;EACI,YAAA,EAAA,CAAA,GAAA,EAAA,MAAA,EAAA,KAAA,EAAA,MAAA,EAAA,GAAA,IAAA;EAAiB,UAAA,EAAA,CAAA,GAAA,EAAA,MAAA,EAAA,GAAA,OAAA;EACb;EAAyB,SAAA,EAAA,OAAA;EAAR,UAAA,EAAA,OAAA;EACnB,KAAA,EAAA,MAAA,GAAA,IAAA;EACsB,MAAA,EAAA,GAAA,GQjCjC,ORiCiC,CAAA,IAAA,CAAA;CAA9B;AAAK,iBQdR,SAAA,CAAA,CRcQ,EQdK,eRcL"}
|