@epic-web/workshop-utils 6.50.14 → 6.51.0

package/dist/db.server.d.ts

@@ -135,6 +135,7 @@ declare const DataSchema: z.ZodObject<{
         }, {
             dismissed?: boolean | undefined;
         }>>>;
+        onboardingComplete: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
     }, "strip", z.ZodTypeAny, {
         player: {
             subtitle: {
@@ -157,6 +158,7 @@ declare const DataSchema: z.ZodObject<{
         exerciseWarning: {
             dismissed: boolean;
         };
+        onboardingComplete: string[];
         playground?: {
             persist: boolean;
         } | undefined;
@@ -187,6 +189,7 @@ declare const DataSchema: z.ZodObject<{
         exerciseWarning?: {
             dismissed?: boolean | undefined;
         } | undefined;
+        onboardingComplete?: string[] | undefined;
     }>>>;
     authInfo: z.ZodOptional<z.ZodObject<{
         id: z.ZodString;
@@ -285,6 +288,7 @@ declare const DataSchema: z.ZodObject<{
         exerciseWarning: {
             dismissed: boolean;
         };
+        onboardingComplete: string[];
         playground?: {
             persist: boolean;
         } | undefined;
@@ -339,6 +343,7 @@ declare const DataSchema: z.ZodObject<{
         exerciseWarning?: {
             dismissed?: boolean | undefined;
         } | undefined;
+        onboardingComplete?: string[] | undefined;
     } | undefined;
     authInfo?: {
         id: string;
@@ -391,6 +396,7 @@ export declare function readDb(): Promise<{
         exerciseWarning: {
             dismissed: boolean;
         };
+        onboardingComplete: string[];
         playground?: {
             persist: boolean;
         } | undefined;
@@ -487,6 +493,7 @@ export declare function getPreferences(): Promise<{
     exerciseWarning: {
         dismissed: boolean;
     };
+    onboardingComplete: string[];
     playground?: {
         persist: boolean;
     } | undefined;
@@ -518,7 +525,47 @@ export declare function setPreferences(preferences: z.input<typeof DataSchema>['
         persist?: boolean | undefined;
     } | undefined;
     fontSize?: number | undefined;
+    onboardingComplete?: string[] | undefined;
 }>;
+/**
+ * Mark an onboarding feature as complete.
+ * This is used to track which tips/indicators have been dismissed.
+ * @param featureId - Unique identifier for the feature (e.g., 'files-popover')
+ */
+export declare function markOnboardingComplete(featureId: string): Promise<{
+    onboardingComplete: string[];
+    player?: {
+        subtitle: {
+            mode: "disabled" | "hidden" | "showing" | null;
+            id: string | null;
+        };
+        minResolution?: number | undefined;
+        maxResolution?: number | undefined;
+        volumeRate?: number | undefined;
+        playbackRate?: number | undefined;
+        autoplay?: boolean | undefined;
+        muted?: boolean | undefined;
+        theater?: boolean | undefined;
+        defaultView?: string | undefined;
+        activeSidebarTab?: number | undefined;
+    } | undefined;
+    presence?: {
+        optOut: boolean;
+    } | undefined;
+    exerciseWarning?: {
+        dismissed: boolean;
+    } | undefined;
+    playground?: {
+        persist: boolean;
+    } | undefined;
+    fontSize?: number | undefined;
+} | undefined>;
+/**
+ * Check if a user has completed an onboarding feature.
+ * @param featureId - Unique identifier for the feature
+ * @returns true if the user has completed this onboarding, false otherwise
+ */
+export declare function isOnboardingComplete(featureId: string): Promise<boolean>;
 export declare function getMutedNotifications(): Promise<string[]>;
 export declare function muteNotification(id: string): Promise<string[]>;
 export declare function setFontSizePreference(fontSize: number | undefined): Promise<number | undefined>;

package/dist/db.server.js

@@ -68,6 +68,8 @@ const DataSchema = z.object({
         })
             .optional()
             .default({ dismissed: false }),
+        // Array of completed onboarding feature IDs (e.g., ['files-popover', 'persist-playground'])
+        onboardingComplete: z.array(z.string()).optional().default([]),
     })
         .optional()
         .default({}),
@@ -278,6 +280,37 @@ export async function setPreferences(preferences) {
     await saveJSON(updatedData);
     return updatedData.preferences;
 }
+/**
+ * Mark an onboarding feature as complete.
+ * This is used to track which tips/indicators have been dismissed.
+ * @param featureId - Unique identifier for the feature (e.g., 'files-popover')
+ */
+export async function markOnboardingComplete(featureId) {
+    const data = await readDb();
+    const currentComplete = data?.preferences?.onboardingComplete ?? [];
+    // Avoid duplicates
+    if (currentComplete.includes(featureId)) {
+        return data?.preferences;
+    }
+    const updatedData = {
+        ...data,
+        preferences: {
+            ...data?.preferences,
+            onboardingComplete: [...currentComplete, featureId],
+        },
+    };
+    await saveJSON(updatedData);
+    return updatedData.preferences;
+}
+/**
+ * Check if a user has completed an onboarding feature.
+ * @param featureId - Unique identifier for the feature
+ * @returns true if the user has completed this onboarding, false otherwise
+ */
+export async function isOnboardingComplete(featureId) {
+    const data = await readDb();
+    return data?.preferences?.onboardingComplete?.includes(featureId) ?? false;
+}
 export async function getMutedNotifications() {
     const data = await readDb();
     return data?.mutedNotifications ?? [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epic-web/workshop-utils",
-  "version": "6.50.14",
+  "version": "6.51.0",
   "publishConfig": {
     "access": "public"
   },