@epic-web/workshop-utils 6.63.0 → 6.64.0

package/dist/config.server.d.ts

@@ -2,29 +2,13 @@ import { z } from 'zod';
 export declare const StackBlitzConfigSchema: z.ZodObject<{
     title: z.ZodOptional<z.ZodString>;
     startScript: z.ZodOptional<z.ZodString>;
-    view: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"editor">, z.ZodLiteral<"preview">, z.ZodLiteral<"both">]>>;
+    view: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"editor">, z.ZodLiteral<"preview">, z.ZodLiteral<"both">]>>;
     file: z.ZodOptional<z.ZodString>;
     hidedevtools: z.ZodOptional<z.ZodString>;
     terminalHeight: z.ZodOptional<z.ZodString>;
     hideNavigation: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    title?: string | undefined;
-    startScript?: string | undefined;
-    view?: "editor" | "preview" | "both" | undefined;
-    file?: string | undefined;
-    hidedevtools?: string | undefined;
-    terminalHeight?: string | undefined;
-    hideNavigation?: string | undefined;
-}, {
-    title?: string | undefined;
-    startScript?: string | undefined;
-    view?: "editor" | "preview" | "both" | undefined;
-    file?: string | undefined;
-    hidedevtools?: string | undefined;
-    terminalHeight?: string | undefined;
-    hideNavigation?: string | undefined;
-}>;
-declare const PartialWorkshopConfigSchema: z.ZodEffects<z.ZodObject<{
+}, z.core.$strip>;
+declare const PartialWorkshopConfigSchema: z.ZodPipe<z.ZodObject<{
     title: z.ZodOptional<z.ZodString>;
     subtitle: z.ZodOptional<z.ZodString>;
     instructor: z.ZodOptional<z.ZodObject<{
@@ -32,64 +16,14 @@ declare const PartialWorkshopConfigSchema: z.ZodEffects<z.ZodObject<{
         avatar: z.ZodOptional<z.ZodString>;
         𝕏: z.ZodOptional<z.ZodString>;
         xHandle: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        name?: string | undefined;
-        avatar?: string | undefined;
-        𝕏?: string | undefined;
-        xHandle?: string | undefined;
-    }, {
-        name?: string | undefined;
-        avatar?: string | undefined;
-        𝕏?: string | undefined;
-        xHandle?: string | undefined;
-    }>>;
+    }, z.core.$strip>>;
     product: z.ZodOptional<z.ZodObject<{
         host: z.ZodOptional<z.ZodString>;
         displayName: z.ZodOptional<z.ZodString>;
         displayNameShort: z.ZodOptional<z.ZodString>;
         slug: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        host?: string | undefined;
-        displayName?: string | undefined;
-        displayNameShort?: string | undefined;
-        slug?: string | undefined;
-    }, {
-        host?: string | undefined;
-        displayName?: string | undefined;
-        displayNameShort?: string | undefined;
-        slug?: string | undefined;
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    title?: string | undefined;
-    subtitle?: string | undefined;
-    instructor?: {
-        name?: string | undefined;
-        avatar?: string | undefined;
-        𝕏?: string | undefined;
-        xHandle?: string | undefined;
-    } | undefined;
-    product?: {
-        host?: string | undefined;
-        displayName?: string | undefined;
-        displayNameShort?: string | undefined;
-        slug?: string | undefined;
-    } | undefined;
-}, {
-    title?: string | undefined;
-    subtitle?: string | undefined;
-    instructor?: {
-        name?: string | undefined;
-        avatar?: string | undefined;
-        𝕏?: string | undefined;
-        xHandle?: string | undefined;
-    } | undefined;
-    product?: {
-        host?: string | undefined;
-        displayName?: string | undefined;
-        displayNameShort?: string | undefined;
-        slug?: string | undefined;
-    } | undefined;
-}>, {
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodTransform<{
     title?: string | undefined;
     subtitle?: string | undefined;
     instructor?: {
@@ -126,9 +60,9 @@ declare const PartialWorkshopConfigSchema: z.ZodEffects<z.ZodObject<{
         displayNameShort?: string | undefined;
         slug?: string | undefined;
     } | undefined;
-}>;
+}>>;
 export type PartialWorkshopConfig = z.infer<typeof PartialWorkshopConfigSchema>;
-declare const WorkshopConfigSchema: z.ZodEffects<z.ZodObject<{
+declare const WorkshopConfigSchema: z.ZodPipe<z.ZodObject<{
     title: z.ZodString;
     subdomain: z.ZodOptional<z.ZodString>;
     product: z.ZodDefault<z.ZodObject<{
@@ -138,130 +72,67 @@ declare const WorkshopConfigSchema: z.ZodEffects<z.ZodObject<{
         logo: z.ZodDefault<z.ZodString>;
         slug: z.ZodOptional<z.ZodString>;
         discordChannelId: z.ZodOptional<z.ZodString>;
-        discordTags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    }, "strip", z.ZodTypeAny, {
-        host: string;
-        displayName: string;
-        displayNameShort: string;
-        logo: string;
-        slug?: string | undefined;
-        discordChannelId?: string | undefined;
-        discordTags?: string[] | undefined;
-    }, {
-        host?: string | undefined;
-        displayName?: string | undefined;
-        displayNameShort?: string | undefined;
-        slug?: string | undefined;
-        logo?: string | undefined;
-        discordChannelId?: string | undefined;
-        discordTags?: string[] | undefined;
-    }>>;
-    githubRepo: z.ZodEffects<z.ZodString, string, string>;
-    githubRoot: z.ZodEffects<z.ZodString, string, string>;
+        discordTags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>;
+    githubRepo: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    githubRoot: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
     stackBlitzConfig: z.ZodOptional<z.ZodObject<{
         title: z.ZodOptional<z.ZodString>;
         startScript: z.ZodOptional<z.ZodString>;
-        view: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"editor">, z.ZodLiteral<"preview">, z.ZodLiteral<"both">]>>;
+        view: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"editor">, z.ZodLiteral<"preview">, z.ZodLiteral<"both">]>>;
         file: z.ZodOptional<z.ZodString>;
         hidedevtools: z.ZodOptional<z.ZodString>;
         terminalHeight: z.ZodOptional<z.ZodString>;
         hideNavigation: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        title?: string | undefined;
-        startScript?: string | undefined;
-        view?: "editor" | "preview" | "both" | undefined;
-        file?: string | undefined;
-        hidedevtools?: string | undefined;
-        terminalHeight?: string | undefined;
-        hideNavigation?: string | undefined;
-    }, {
-        title?: string | undefined;
-        startScript?: string | undefined;
-        view?: "editor" | "preview" | "both" | undefined;
-        file?: string | undefined;
-        hidedevtools?: string | undefined;
-        terminalHeight?: string | undefined;
-        hideNavigation?: string | undefined;
-    }>>;
+    }, z.core.$strip>>;
     forms: z.ZodDefault<z.ZodObject<{
         workshop: z.ZodDefault<z.ZodString>;
         exercise: z.ZodDefault<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        workshop: string;
-        exercise: string;
-    }, {
-        workshop?: string | undefined;
-        exercise?: string | undefined;
-    }>>;
+    }, z.core.$strip>>;
     testTab: z.ZodDefault<z.ZodObject<{
         enabled: z.ZodDefault<z.ZodBoolean>;
-    }, "strip", z.ZodTypeAny, {
-        enabled: boolean;
-    }, {
-        enabled?: boolean | undefined;
-    }>>;
+    }, z.core.$strip>>;
     scripts: z.ZodOptional<z.ZodObject<{
         postupdate: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        postupdate?: string | undefined;
-    }, {
-        postupdate?: string | undefined;
-    }>>;
+    }, z.core.$strip>>;
     initialRoute: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     notifications: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
         id: z.ZodString;
         title: z.ZodString;
         message: z.ZodString;
         link: z.ZodOptional<z.ZodString>;
-        type: z.ZodEnum<["info", "warning", "danger"]>;
+        type: z.ZodEnum<{
+            info: "info";
+            warning: "warning";
+            danger: "danger";
+        }>;
         expiresAt: z.ZodNullable<z.ZodDate>;
-    }, "strip", z.ZodTypeAny, {
-        message: string;
-        type: "info" | "warning" | "danger";
-        title: string;
-        id: string;
-        expiresAt: Date | null;
-        link?: string | undefined;
-    }, {
-        message: string;
-        type: "info" | "warning" | "danger";
-        title: string;
-        id: string;
-        expiresAt: Date | null;
-        link?: string | undefined;
-    }>, "many">>>;
+    }, z.core.$strip>>>>;
     sidecarProcesses: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
-    appType: z.ZodOptional<z.ZodEnum<["standard", "export"]>>;
+    appType: z.ZodOptional<z.ZodEnum<{
+        standard: "standard";
+        export: "export";
+    }>>;
     subtitle: z.ZodOptional<z.ZodString>;
     instructor: z.ZodOptional<z.ZodObject<{
         name: z.ZodOptional<z.ZodString>;
         avatar: z.ZodOptional<z.ZodString>;
         𝕏: z.ZodOptional<z.ZodString>;
         xHandle: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        name?: string | undefined;
-        avatar?: string | undefined;
-        𝕏?: string | undefined;
-        xHandle?: string | undefined;
-    }, {
-        name?: string | undefined;
-        avatar?: string | undefined;
-        𝕏?: string | undefined;
-        xHandle?: string | undefined;
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    githubRepo: string;
-    githubRoot: string;
-    title: string;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodTransform<{
     product: {
+        displayNameShort: string;
         host: string;
         displayName: string;
-        displayNameShort: string;
         logo: string;
         slug?: string | undefined;
         discordChannelId?: string | undefined;
         discordTags?: string[] | undefined;
     };
+    title: string;
+    githubRepo: string;
+    githubRoot: string;
     forms: {
         workshop: string;
         exercise: string;
@@ -271,21 +142,14 @@ declare const WorkshopConfigSchema: z.ZodEffects<z.ZodObject<{
     };
     initialRoute: string;
     notifications: {
+        id: string;
+        title: string;
         message: string;
         type: "info" | "warning" | "danger";
-        title: string;
-        id: string;
         expiresAt: Date | null;
         link?: string | undefined;
     }[];
     sidecarProcesses: Record<string, string>;
-    subtitle?: string | undefined;
-    instructor?: {
-        name?: string | undefined;
-        avatar?: string | undefined;
-        𝕏?: string | undefined;
-        xHandle?: string | undefined;
-    } | undefined;
     subdomain?: string | undefined;
     stackBlitzConfig?: {
         title?: string | undefined;
@@ -300,10 +164,6 @@ declare const WorkshopConfigSchema: z.ZodEffects<z.ZodObject<{
         postupdate?: string | undefined;
     } | undefined;
     appType?: "standard" | "export" | undefined;
-}, {
-    githubRepo: string;
-    githubRoot: string;
-    title: string;
     subtitle?: string | undefined;
     instructor?: {
         name?: string | undefined;
@@ -311,51 +171,12 @@ declare const WorkshopConfigSchema: z.ZodEffects<z.ZodObject<{
         𝕏?: string | undefined;
         xHandle?: string | undefined;
     } | undefined;
-    product?: {
-        host?: string | undefined;
-        displayName?: string | undefined;
-        displayNameShort?: string | undefined;
-        slug?: string | undefined;
-        logo?: string | undefined;
-        discordChannelId?: string | undefined;
-        discordTags?: string[] | undefined;
-    } | undefined;
-    subdomain?: string | undefined;
-    stackBlitzConfig?: {
-        title?: string | undefined;
-        startScript?: string | undefined;
-        view?: "editor" | "preview" | "both" | undefined;
-        file?: string | undefined;
-        hidedevtools?: string | undefined;
-        terminalHeight?: string | undefined;
-        hideNavigation?: string | undefined;
-    } | undefined;
-    forms?: {
-        workshop?: string | undefined;
-        exercise?: string | undefined;
-    } | undefined;
-    testTab?: {
-        enabled?: boolean | undefined;
-    } | undefined;
-    scripts?: {
-        postupdate?: string | undefined;
-    } | undefined;
-    initialRoute?: string | undefined;
-    notifications?: {
-        message: string;
-        type: "info" | "warning" | "danger";
-        title: string;
-        id: string;
-        expiresAt: Date | null;
-        link?: string | undefined;
-    }[] | undefined;
-    sidecarProcesses?: Record<string, string> | undefined;
-    appType?: "standard" | "export" | undefined;
-}>, {
+}, {
+    title: string;
     product: {
-        displayNameShort: string;
         host: string;
         displayName: string;
+        displayNameShort: string;
         logo: string;
         slug?: string | undefined;
         discordChannelId?: string | undefined;
@@ -363,7 +184,6 @@ declare const WorkshopConfigSchema: z.ZodEffects<z.ZodObject<{
     };
     githubRepo: string;
     githubRoot: string;
-    title: string;
     forms: {
         workshop: string;
         exercise: string;
@@ -373,21 +193,14 @@ declare const WorkshopConfigSchema: z.ZodEffects<z.ZodObject<{
     };
     initialRoute: string;
     notifications: {
+        id: string;
+        title: string;
         message: string;
         type: "info" | "warning" | "danger";
-        title: string;
-        id: string;
         expiresAt: Date | null;
         link?: string | undefined;
     }[];
     sidecarProcesses: Record<string, string>;
-    subtitle?: string | undefined;
-    instructor?: {
-        name?: string | undefined;
-        avatar?: string | undefined;
-        𝕏?: string | undefined;
-        xHandle?: string | undefined;
-    } | undefined;
     subdomain?: string | undefined;
     stackBlitzConfig?: {
         title?: string | undefined;
@@ -402,10 +215,6 @@ declare const WorkshopConfigSchema: z.ZodEffects<z.ZodObject<{
         postupdate?: string | undefined;
     } | undefined;
     appType?: "standard" | "export" | undefined;
-}, {
-    githubRepo: string;
-    githubRoot: string;
-    title: string;
     subtitle?: string | undefined;
     instructor?: {
         name?: string | undefined;
@@ -413,47 +222,7 @@ declare const WorkshopConfigSchema: z.ZodEffects<z.ZodObject<{
         𝕏?: string | undefined;
         xHandle?: string | undefined;
     } | undefined;
-    product?: {
-        host?: string | undefined;
-        displayName?: string | undefined;
-        displayNameShort?: string | undefined;
-        slug?: string | undefined;
-        logo?: string | undefined;
-        discordChannelId?: string | undefined;
-        discordTags?: string[] | undefined;
-    } | undefined;
-    subdomain?: string | undefined;
-    stackBlitzConfig?: {
-        title?: string | undefined;
-        startScript?: string | undefined;
-        view?: "editor" | "preview" | "both" | undefined;
-        file?: string | undefined;
-        hidedevtools?: string | undefined;
-        terminalHeight?: string | undefined;
-        hideNavigation?: string | undefined;
-    } | undefined;
-    forms?: {
-        workshop?: string | undefined;
-        exercise?: string | undefined;
-    } | undefined;
-    testTab?: {
-        enabled?: boolean | undefined;
-    } | undefined;
-    scripts?: {
-        postupdate?: string | undefined;
-    } | undefined;
-    initialRoute?: string | undefined;
-    notifications?: {
-        message: string;
-        type: "info" | "warning" | "danger";
-        title: string;
-        id: string;
-        expiresAt: Date | null;
-        link?: string | undefined;
-    }[] | undefined;
-    sidecarProcesses?: Record<string, string> | undefined;
-    appType?: "standard" | "export" | undefined;
-}>;
+}>>;
 export type WorkshopConfig = z.infer<typeof WorkshopConfigSchema>;
 /**
  * Parse epicshop config from an arbitrary package.json object.

package/dist/config.server.js

@@ -38,6 +38,7 @@ const BaseWorkshopConfigFields = {
     instructor: InstructorSchema.optional(),
     product: BaseProductSchema.optional(),
 };
+const formatFieldErrors = (errors) => Array.isArray(errors) ? errors.join(', ') : '';
 function transformProductFields(data) {
     const product = data.product ?? {};
     return {
@@ -50,6 +51,19 @@ function transformProductFields(data) {
         },
     };
 }
+const defaultProductConfig = {
+    host: 'www.epicweb.dev',
+    displayName: 'EpicWeb.dev',
+    displayNameShort: 'Epic Web',
+    logo: '/logo.svg',
+};
+const defaultFormsConfig = {
+    workshop: 'https://docs.google.com/forms/d/e/1FAIpQLSdRmj9p8-5zyoqRzxp3UpqSbC3aFkweXvvJIKes0a5s894gzg/viewform?hl=en&embedded=true&entry.2123647600={workshopTitle}',
+    exercise: 'https://docs.google.com/forms/d/e/1FAIpQLSf3o9xyjQepTlOTH5Z7ZwkeSTdXh6YWI_RGc9KiyD3oUN0p6w/viewform?hl=en&embedded=true&entry.1836176234={workshopTitle}&entry.428900931={exerciseTitle}',
+};
+const defaultTestTabConfig = {
+    enabled: true,
+};
 const PartialWorkshopConfigSchema = z
     .object(BaseWorkshopConfigFields)
     .transform(transformProductFields);
@@ -69,7 +83,7 @@ const WorkshopConfigSchema = z
         discordChannelId: z.string().optional(),
         discordTags: z.array(z.string()).optional(),
     })
-        .default({}),
+        .default(defaultProductConfig),
     githubRepo: z
         .string()
         .transform((githubRepo) => githubRepo ?? getEnv().EPICSHOP_GITHUB_REPO),
@@ -79,19 +93,15 @@ const WorkshopConfigSchema = z
     stackBlitzConfig: StackBlitzConfigSchema.optional(),
     forms: z
         .object({
-        workshop: z
-            .string()
-            .default('https://docs.google.com/forms/d/e/1FAIpQLSdRmj9p8-5zyoqRzxp3UpqSbC3aFkweXvvJIKes0a5s894gzg/viewform?hl=en&embedded=true&entry.2123647600={workshopTitle}'),
-        exercise: z
-            .string()
-            .default('https://docs.google.com/forms/d/e/1FAIpQLSf3o9xyjQepTlOTH5Z7ZwkeSTdXh6YWI_RGc9KiyD3oUN0p6w/viewform?hl=en&embedded=true&entry.1836176234={workshopTitle}&entry.428900931={exerciseTitle}'),
+        workshop: z.string().default(defaultFormsConfig.workshop),
+        exercise: z.string().default(defaultFormsConfig.exercise),
     })
-        .default({}),
+        .default(defaultFormsConfig),
     testTab: z
         .object({
         enabled: z.boolean().default(true),
     })
-        .default({}),
+        .default(defaultTestTabConfig),
     scripts: z
         .object({
         postupdate: z.string().optional(),
@@ -195,7 +205,7 @@ export function getWorkshopConfig() {
         if (error instanceof z.ZodError) {
             const flattenedErrors = error.flatten();
             const errorMessages = Object.entries(flattenedErrors.fieldErrors)
-                .map(([field, errors]) => `${field}: ${errors?.join(', ')}`)
+                .map(([field, errors]) => `${field}: ${formatFieldErrors(errors)}`)
                 .concat(flattenedErrors.formErrors);
             throw new Error(`Invalid epicshop configuration in ${getRootPkgJsonPath()}:\n${errorMessages.join('\n')}`);
         }
@@ -290,7 +300,7 @@ export async function getAppConfig(fullPath) {
                 .optional()
                 .default(workshopConfig.testTab?.enabled ?? true),
         })
-            .default({}),
+            .default({ enabled: workshopConfig.testTab?.enabled ?? true }),
         scripts: z
             .object({
             test: z.string().optional(),
@@ -331,7 +341,7 @@ export async function getAppConfig(fullPath) {
         if (error instanceof z.ZodError) {
             const flattenedErrors = error.flatten();
             const errorMessages = Object.entries(flattenedErrors.fieldErrors)
-                .map(([field, errors]) => `${field}: ${errors?.join(', ')}`)
+                .map(([field, errors]) => `${field}: ${formatFieldErrors(errors)}`)
                 .concat(flattenedErrors.formErrors);
             throw new Error(`Invalid app configuration for ${fullPath}:\n${errorMessages.join('\n')}`);
         }