@opengovsg/confetti 0.0.10 → 0.0.12

package/build/index.d.ts

@@ -43,13 +43,14 @@ interface ConfettiProviderProps {
   apiBaseUrl?: string;
   isSurveyVisible?: boolean | ((_: {
     lastRespondedAt: Date | null;
+    lastDismissedAt: Date | null;
   }) => boolean);
 }
 declare const ConfettiProvider: ({
   children,
   surveyId,
   publishableKey,
-  respondent,
+  respondent: respondentInput,
   metadata,
   isSurveyVisible: isSurveyVisibleInput,
   apiBaseUrl

package/build/index.js

@@ -177,7 +177,12 @@ const publicPutResponseInputSchema = z.object({
 	])),
 	metadata: z.record(z.string().check(z.trim(), z.maxLength(1e3)), z.string().check(z.trim(), z.maxLength(1e3)))
 });
-const publicGetRespondentOutputSchema = z.object({ lastRespondedAt: z.nullable(z.union([z.iso.datetime(), z.date()])) });
+const publicGetRespondentOutputSchema = z.object({
+	lastRespondedAt: z.nullable(z.union([z.iso.datetime(), z.date()])),
+	lastViewedAt: z.nullable(z.union([z.iso.datetime(), z.date()])),
+	lastDismissedAt: z.nullable(z.union([z.iso.datetime(), z.date()]))
+});
+const publicPostRespondentEventInputSchema = z.object({ type: z.enum(["view", "dismiss"]) });
 
 //#endregion
 //#region src/core/logic/api.ts
@@ -194,15 +199,18 @@ const client = ky.create({
 //#endregion
 //#region src/core/ConfettiProvider.tsx
 const ConfettiContext = createContext(null);
-const ConfettiProvider = ({ children, surveyId, publishableKey, respondent, metadata = {}, isSurveyVisible: isSurveyVisibleInput, apiBaseUrl }) => {
+const ConfettiProvider = ({ children, surveyId, publishableKey, respondent: respondentInput, metadata = {}, isSurveyVisible: isSurveyVisibleInput, apiBaseUrl }) => {
+	const hasTrackedViewRef = useRef(false);
 	const [survey, setSurvey] = useState();
 	const [lastRespondedAt, setLastRespondedAt] = useState();
+	const [lastDismissedAt, setLastDismissedAt] = useState();
 	const responseId = useMemo(() => crypto.randomUUID(), []);
 	const [internalRespondentId, setInternalRespondentId] = useLocalStorage(`cfti:${surveyId}:respondent`, "");
 	useEffect(() => {
 		if (internalRespondentId) return;
 		setInternalRespondentId(crypto.randomUUID());
 	}, [internalRespondentId, setInternalRespondentId]);
+	const respondent = useMemo(() => respondentInput || internalRespondentId, [respondentInput, internalRespondentId]);
 	const client$1 = useMemo(() => {
 		const properties = { headers: { "x-cfti-pk": publishableKey } };
 		if (apiBaseUrl) properties.prefixUrl = apiBaseUrl;
@@ -214,14 +222,16 @@ const ConfettiProvider = ({ children, surveyId, publishableKey, respondent, meta
 			if (!parseResult.success) return;
 			setSurvey(parseResult.data);
 		});
-		if (!respondent && !internalRespondentId) return;
-		client$1.get(`v1/cfti/${surveyId}/respondent/${respondent || internalRespondentId}`).json().then((data) => {
+		if (!respondent) return;
+		client$1.get(`v1/cfti/${surveyId}/respondent/${respondent}`).json().then((data) => {
 			const parseResult = publicGetRespondentOutputSchema.safeParse(data);
 			if (!parseResult.success) {
 				setLastRespondedAt(null);
+				setLastDismissedAt(null);
 				return;
 			}
 			setLastRespondedAt(parseResult.data.lastRespondedAt ? new Date(parseResult.data.lastRespondedAt) : null);
+			setLastDismissedAt(parseResult.data.lastDismissedAt ? new Date(parseResult.data.lastDismissedAt) : null);
 		});
 	}, [
 		apiBaseUrl,
@@ -232,13 +242,12 @@ const ConfettiProvider = ({ children, surveyId, publishableKey, respondent, meta
 	]);
 	const submit = useCallback(async ({ answers }) => {
 		await client$1.put(`v1/cfti/${surveyId}/response/${responseId}`, { json: {
-			respondent: respondent || internalRespondentId,
+			respondent,
 			data: answers,
 			metadata
 		} });
 	}, [
 		client$1,
-		internalRespondentId,
 		metadata,
 		respondent,
 		responseId,
@@ -246,13 +255,38 @@ const ConfettiProvider = ({ children, surveyId, publishableKey, respondent, meta
 	]);
 	const dismiss = useCallback(() => {
 		setSurvey(void 0);
-	}, []);
-	if (!useMemo(() => {
+		client$1.post(`v1/cfti/${surveyId}/respondent/${respondent}/event`, { json: { type: "dismiss" } }).catch(() => {});
+	}, [
+		client$1,
+		respondent,
+		surveyId
+	]);
+	const isSurveyVisible = useMemo(() => {
 		if (isSurveyVisibleInput === void 0) return true;
 		if (typeof isSurveyVisibleInput === "boolean") return isSurveyVisibleInput;
-		if (lastRespondedAt === void 0) return false;
-		return isSurveyVisibleInput({ lastRespondedAt });
-	}, [isSurveyVisibleInput, lastRespondedAt]) || !survey) return null;
+		if (lastRespondedAt === void 0 || lastDismissedAt === void 0) return false;
+		return isSurveyVisibleInput({
+			lastRespondedAt,
+			lastDismissedAt
+		});
+	}, [
+		isSurveyVisibleInput,
+		lastRespondedAt,
+		lastDismissedAt
+	]);
+	useEffect(() => {
+		if (hasTrackedViewRef.current) return;
+		if (isSurveyVisible) {
+			hasTrackedViewRef.current = true;
+			client$1.post(`v1/cfti/${surveyId}/respondent/${respondent}/event`, { json: { type: "view" } }).catch(() => {});
+		}
+	}, [
+		client$1,
+		isSurveyVisible,
+		respondent,
+		surveyId
+	]);
+	if (!isSurveyVisible || !survey) return null;
 	return /* @__PURE__ */ jsx(ConfettiContext.Provider, {
 		value: {
 			submit,

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "@opengovsg/confetti",
-  "version": "0.0.10",
+  "version": "0.0.12",
   "sideEffects": false,
   "description": "Widgets for Confetti",
   "license": "SEE LICENSE IN LICENSE.md",
   "type": "module",
   "repository": "https://github.com/hfpg2026/confetti",
   "homepage": "https://github.com/hfpg2026/confetti",
+  "main": "./build/index.js",
+  "types": "./build/index.d.ts",
   "exports": {
     ".": {
       "import": "./build/index.js",