polen 0.11.0-next.14 → 0.11.0-next.15

package/src/template/stores/toast.ts

@@ -1,63 +1,82 @@
+import { Schema as S } from 'effect'
 import { proxy } from 'valtio'
 
+// ============================================================================
+// Schema Definitions
+// ============================================================================
+
 /**
- * Toast notification types
+ * Toast notification types schema
  */
-export const Type = {
-  info: 'info',
-  success: 'success',
-  warning: 'warning',
-  error: 'error',
-} as const
+export const Type = S.Enums(
+  {
+    Info: 'info',
+    Success: 'success',
+    Warning: 'warning',
+    Error: 'error',
+  } as const,
+)
+export type Type = S.Schema.Type<typeof Type>
+
+/**
+ * Toast action schema
+ */
+export const ToastAction = S.Struct({
+  /** Action button label */
+  label: S.String,
+  /** Action button click handler */
+  onClick: S.Any, // Functions can't be validated
+})
 
-export type Type = typeof Type[keyof typeof Type]
+export type ToastAction = S.Schema.Type<typeof ToastAction>
 
 /**
- * Toast notification interface
+ * Toast notification schema
  */
-export interface Toast {
+export const Toast = S.Struct({
   /** Unique identifier for the toast */
-  id: string
+  id: S.String,
   /** Primary message text */
-  message: string
+  message: S.String,
   /** Optional secondary description text */
-  description?: string
+  description: S.optional(S.String),
   /** Visual type/variant of the toast */
-  type?: Type
+  type: S.optional(Type),
   /** Duration in milliseconds before auto-dismiss. Set to 0 to disable auto-dismiss */
-  duration?: number
+  duration: S.optional(S.Number),
   /** Optional action buttons configuration */
-  actions: {
-    /** Action button label */
-    label: string
-    /** Action button click handler */
-    onClick: () => void
-  }[]
-}
+  actions: S.Array(ToastAction),
+})
+
+export type Toast = S.Schema.Type<typeof Toast>
 
 /**
- * Toast store state interface
+ * Toast store state
  */
-export interface State {
+export const State = S.Struct({
   /** Array of active toast notifications */
-  toasts: Toast[]
-}
+  toasts: S.mutable(S.Array(Toast)),
+})
+
+export type State = S.Schema.Type<typeof State>
+
+// ============================================================================
+// Initial State & Defaults
+// ============================================================================
 
-/**
- * Initial state for the toast store
- */
 export const initialState: State = {
   toasts: [],
 }
 
-/**
- * Default values for toast properties
- */
 const toastDefaults = {
   duration: 5000,
   actions: [],
 } satisfies Partial<Toast>
 
+// ============================================================================
+// Store
+// ============================================================================
+
 /**
  * Toast notification store
  *
@@ -89,7 +108,7 @@ export const store = proxy({
    */
   remove(id: string): void {
     const index = store.toasts.findIndex(t => t.id === id)
-    if (index > -1) {
+    if (index !== -1) {
       store.toasts.splice(index, 1)
     }
   },
@@ -116,7 +135,7 @@ export const store = proxy({
    * @returns Generated toast ID
    */
   info(message: string, options?: InputOptions) {
-    return store.add({ ...toastDefaults, ...options, message, type: Type.info })
+    return store.add({ ...toastDefaults, ...options, message, type: Type.enums.Info })
   },
 
   /**
@@ -126,7 +145,7 @@ export const store = proxy({
    * @returns Generated toast ID
    */
   success(message: string, options?: InputOptions) {
-    return store.add({ ...toastDefaults, ...options, message, type: Type.success })
+    return store.add({ ...toastDefaults, ...options, message, type: Type.enums.Success })
   },
 
   /**
@@ -136,7 +155,7 @@ export const store = proxy({
    * @returns Generated toast ID
    */
   warning(message: string, options?: InputOptions) {
-    return store.add({ ...toastDefaults, ...options, message, type: Type.warning })
+    return store.add({ ...toastDefaults, ...options, message, type: Type.enums.Warning })
   },
 
   /**
@@ -146,7 +165,7 @@ export const store = proxy({
    * @returns Generated toast ID
    */
   error(message: string, options?: InputOptions) {
-    return store.add({ ...toastDefaults, ...options, message, type: Type.error })
+    return store.add({ ...toastDefaults, ...options, message, type: Type.enums.Error })
   },
 })
 

package/src/types/global-constants.d.ts

@@ -0,0 +1,36 @@
+// Global build-time constants injected by Vite
+
+/**
+ * Indicates whether the code is running during a production build.
+ * - `true` when running `polen build` command
+ * - `false` when running `polen dev` command
+ */
+declare const __BUILDING__: boolean
+
+/**
+ * Convenience boolean for checking if using Static Site Generation (SSG) architecture.
+ * - `true` when `__BUILD_ARCHITECTURE__ === 'ssg'`
+ * - `false` otherwise
+ */
+declare const __BUILD_ARCHITECTURE_SSG__: boolean
+
+/**
+ * The build architecture configured for the project.
+ * - `'ssg'` for Static Site Generation (default)
+ * - `'ssr'` for Server-Side Rendering (future support)
+ */
+declare const __BUILD_ARCHITECTURE__: import('#api/config/input').BuildArchitecture
+
+/**
+ * Indicates whether the code is running in development server mode.
+ * - `true` when running `polen dev` command
+ * - `false` when running `polen build` command
+ */
+declare const __SERVING__: boolean
+
+/**
+ * The raw Vite command being executed.
+ * - `'build'` for production builds
+ * - `'serve'` for development server
+ */
+declare const __COMMAND__: import('#dep/vite/index').Vite.ConfigEnv[`command`]

package/src/types/global.d.ts

@@ -0,0 +1,17 @@
+// Global window properties
+import type { GraphQLSchema } from 'graphql'
+import type { RouterState } from 'react-router'
+import type { PolenGlobalData } from '../template/constants'
+
+declare global {
+  var __POLEN__: PolenGlobalData
+
+  interface Window {
+    __polenCacheSchema?: GraphQLSchema | undefined
+    __staticRouterHydrationData?:
+      | Partial<
+        Pick<RouterState, `loaderData` | `actionData` | `errors`>
+      >
+      | undefined
+  }
+}

package/src/types/virtual-modules.d.ts

@@ -0,0 +1,41 @@
+declare module 'virtual:polen/vite/client/manifest' {
+  const manifest: import('vite').Manifest
+  export default manifest
+}
+
+declare module 'virtual:polen/template/variables' {
+  export const templateVariables: import('#api/config/configurator').TemplateVariables
+}
+
+declare module 'virtual:polen/project/routes.jsx' {
+  export const routes: import('#vite/plugins/core').ProjectRoutesModule['routes']
+}
+
+declare module 'virtual:polen/template/schema-augmentations' {
+  export const schemaAugmentations: import('#api/schema/augmentations/schema-augmentation').Augmentation[]
+}
+
+declare module 'virtual:polen/project/data.json' {
+  const data: import('#project-data').ProjectData
+  export { data as default }
+}
+
+declare module 'virtual:polen/project/schema.json' {
+  // Object mapping filenames to JSON content for the catalog bridge
+  const schema: Record<string, string> | null
+  export { schema as default }
+}
+
+declare module 'virtual:polen/project/data/pages-catalog.json' {
+  const data: import('#vite/plugins/pages').ProjectPagesCatalog
+  export { data as default }
+}
+
+declare module 'virtual:polen/project/assets/logo.svg' {
+  const src: string
+  export default src
+}
+
+declare module 'virtual:polen/project/hooks' {
+  export const navbar: ((props: import('#api/hooks/types').NavbarProps) => React.ReactNode) | null
+}

package/src/vite/config.ts

@@ -0,0 +1,27 @@
+import type { Api } from '#api/index'
+import { Vite } from '#dep/vite/index'
+import { Main } from './plugins/main.js'
+
+/**
+ * Transform Polen config into a Vite configuration.
+ */
+export const toViteUserConfig = (
+  config: Api.Config.Config,
+): ViteUserConfigWithPolen => {
+  const viteUserConfigFromPolen: Vite.UserConfig = {
+    base: config.build.base,
+    plugins: [Main(config)],
+  }
+
+  const viteUserConfigMerged = (config.advanced.vite
+    ? Vite.mergeConfig(viteUserConfigFromPolen, config.advanced.vite)
+    : viteUserConfigFromPolen) as ViteUserConfigWithPolen
+
+  viteUserConfigMerged._polen = config
+
+  return viteUserConfigMerged
+}
+
+export interface ViteUserConfigWithPolen extends Vite.UserConfig {
+  _polen: Api.Config.Config
+}

package/src/vite/index.ts

@@ -0,0 +1,5 @@
+export * from './config.js'
+export * from './log-filters.js'
+export * from './logger.js'
+export * from './plugins/index.js'
+export * from './vi.js'

package/src/vite/logger.ts

@@ -0,0 +1,90 @@
+import type { Config } from '#api/api'
+import { Vite } from '#dep/vite/index'
+import { Err, Str } from '@wollybeard/kit'
+import { stripAnsi } from 'consola/utils'
+import { onError } from 'effect/Stream'
+
+const baseLogger = Vite.createLogger(undefined)
+
+export const createLogger = (config: Config.Config): Vite.Logger => {
+  return {
+    ...baseLogger,
+    info(msg, options) {
+      // Filter out optimization-related messages
+      const msgString = typeof msg === `string` ? msg : String(msg)
+      if (
+        msgString.includes(`new dependencies optimized`)
+        || msgString.includes(`optimized dependencies changed`)
+        || msgString.includes(`Re-optimizing dependencies`)
+        || msgString.includes(`Forced re-optimization`)
+      ) {
+        return
+      }
+      baseLogger.info(msg, options)
+    },
+    error(msg, options) {
+      if (config.advanced.debug) {
+        const firstLine = stripAnsi(Str.lines(msg)[0] ?? `<no message>`)
+        const cause = options?.error
+        const error = new Error(firstLine, { cause })
+        Err.log(error)
+      }
+    },
+  }
+}
+
+export namespace ViteMemoryLogger {
+  export type MemoryLog<$Level extends Level = Level> = {
+    level: $Level
+    message: string
+    options: Vite.LogOptions | undefined
+  }
+
+  export type Store = {
+    all: MemoryLog[]
+    errors: MemoryLog<'error'>[]
+  }
+
+  export const createStore = (): Store => {
+    const store: Store = {
+      all: [],
+      errors: [],
+    }
+    return store
+  }
+  export const create = (params: {
+    store: Store
+    onError?: (error: Error) => void
+  }): Vite.Logger => {
+    const store = params.store ?? createStore()
+    return {
+      ...baseLogger,
+      info(message, options) {
+        store.all.push({ level: 'info', message, options })
+        return
+      },
+      error(message, options) {
+        if (options?.error) {
+          params.onError?.(options.error as any)
+        }
+        const log: MemoryLog<'error'> = {
+          level: 'error',
+          message,
+          options,
+        }
+        store.all.push(log)
+        store.errors.push(log)
+        return
+      },
+    }
+  }
+}
+
+export const LevelEnum = {
+  error: 'error',
+  info: 'info',
+} as const
+
+export type Level = keyof typeof LevelEnum
+export type LevelError = typeof LevelEnum.error
+export type LevelInfo = typeof LevelEnum.info

package/src/vite/plugins/branding.ts

@@ -0,0 +1,108 @@
+import type { Config } from '#api/api'
+import type { Vite } from '#dep/vite/index'
+import { type ExistenceDiff, getMutationType, MutationType } from '#lib/mutation-type'
+import { debugPolen } from '#singletons/debug'
+import { Fs } from '@wollybeard/kit'
+import type { Plugin } from 'vite'
+import { polenVirtual } from '../vi.js'
+
+const viLogo = polenVirtual([`project`, `assets`, `logo.svg`])
+
+const generateDefaultLogo = async () => {
+  return `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128" width="128" height="128">
+  <circle cx="64" cy="64" r="48" fill="none" stroke="black" stroke-width="8"/>
+</svg>`
+}
+
+export function Branding(config: Config.Config): Plugin {
+  const debug = debugPolen.sub(`vite-plugin:branding`)
+  debug(`initialized`)
+
+  return {
+    name: `polen:branding`,
+    enforce: `pre`,
+
+    async buildStart() {
+      this.addWatchFile(config.paths.project.absolute.public.logo)
+    },
+
+    async handleHotUpdate({ file, server }) {
+      return await handleWatchedFileChange({
+        watchedFile: config.paths.project.absolute.public.logo,
+        changedFile: file,
+        moduleId: viLogo.resolved,
+        server,
+        debug: debug,
+      })
+    },
+
+    resolveId(id) {
+      if (id === viLogo.id) {
+        return viLogo.resolved
+      }
+    },
+
+    async load(id) {
+      if (id === viLogo.resolved) {
+        const logoFileContent = await Fs.read(config.paths.project.absolute.public.logo)
+        const content = logoFileContent ? logoFileContent : await generateDefaultLogo()
+        const dataUrl = `data:image/svg+xml;base64,${Buffer.from(content).toString(`base64`)}`
+        return `export default ${JSON.stringify(dataUrl)}`
+      }
+    },
+  }
+}
+
+interface HandleWatchedFileChangeParams {
+  watchedFile: string
+  changedFile: string
+  moduleId: string
+  server: Vite.ViteDevServer
+  debug: (msg: string, data?: any) => void
+}
+
+const handleWatchedFileChange = async (
+  params: HandleWatchedFileChangeParams,
+): Promise<Vite.ModuleNode[] | void> => {
+  const { watchedFile, changedFile, moduleId, server, debug } = params
+
+  // Check if change is for watched file
+  if (changedFile !== watchedFile) return
+
+  // Check current existence
+  const existsNow = await Fs.exists(watchedFile)
+
+  // Check previous existence via module graph
+  const module = server.moduleGraph.getModuleById(moduleId)
+  const existedBefore = !!module
+
+  // Early return if no mutation
+  if (!existedBefore && !existsNow) {
+    debug(`no mutation detected - file didn't exist before or after`, { file: changedFile })
+    return
+  }
+
+  const mutationType = getMutationType({
+    before: existedBefore,
+    after: existsNow,
+  } as ExistenceDiff)
+
+  debug(`file ${mutationType}`, { file: changedFile })
+
+  switch (mutationType) {
+    case MutationType.Create:
+      // Full reload needed - module never existed
+      server.ws.send({
+        type: `full-reload`,
+        path: `*`,
+      })
+      break
+
+    case MutationType.Update:
+    case MutationType.Delete:
+      // Invalidate module for HMR
+      server.moduleGraph.invalidateModule(module!)
+      // Return empty array to prevent default HMR
+      return []
+  }
+}

package/src/vite/plugins/build.ts

@@ -0,0 +1,147 @@
+import type { Api } from '#api/index'
+import type { PolenBuildManifest } from '#api/static/manifest'
+import { Vite } from '#dep/vite/index'
+import { debugPolen } from '#singletons/debug'
+import { Fs, Path } from '@wollybeard/kit'
+import packageJson from '../../../package.json' with { type: 'json' }
+import { isKitUnusedExternalImport, isRadixModuleLevelDirective } from '../log-filters.js'
+import { RoutesManifest } from './routes-manifest.js'
+
+export const Build = (config: Api.Config.Config): Vite.Plugin[] => {
+  const debug = debugPolen.sub(`vite-build`)
+  debug(`construct`)
+  // let viteConfigResolved: Vite.ResolvedConfig
+
+  // const outDir = Path.join(config.paths.project.rootDir, `dist`)
+
+  return [
+    BuildManifest(config),
+    RoutesManifest(config),
+    {
+      name: `polen:build-client`,
+      apply: `build`,
+      applyToEnvironment: Vite.isEnvironmentClient,
+      // HACK: For some reason the ?url import doesn't lead to a rewrite in the build.
+      // Furthermore we need to rely on the manifest to get its final name because it is
+      // generated by the client build before the server build.
+      // However, we still need the asset in development.
+      // But we cannot exclude the import in build.
+      // So this does that for us but it is really hacky.
+      // FIXME
+      // 1. Raise issue about having ?url lead to expected build path rewrite?
+      // 2. And: Move asset generation to server build?
+      // 3. And/or: Use Vite Environments API?
+      generateBundle(_, bundle, isWrite) {
+        if (isWrite) {
+          for (const chunkOrAsset of Object.values(bundle)) {
+            if (chunkOrAsset.type === `asset` && chunkOrAsset.names.includes(`entry.client.jsx`)) {
+              delete bundle[chunkOrAsset.fileName]
+            }
+          }
+        }
+      },
+      onLog(_, message) {
+        if (isRadixModuleLevelDirective(message)) return
+        if (isKitUnusedExternalImport(message)) return
+      },
+      config() {
+        return {
+          environments: {
+            client: {
+              build: {
+                manifest: true,
+                rollupOptions: {
+                  input: [config.paths.framework.template.absolute.client.entrypoint],
+                  external: id => id.startsWith(`node:`),
+                  onwarn(message) {
+                    if (isKitUnusedExternalImport(message)) return
+                  },
+                },
+              },
+            },
+          },
+        }
+      },
+    },
+
+    {
+      name: `polen-ssr-build`,
+      apply: `build`,
+      applyToEnvironment: Vite.isEnvironmentSsr,
+      config() {
+        return {
+          // Have to configure this here??
+          // @see https://github.com/vitejs/vite/issues/20098
+          ssr: {
+            noExternal: true,
+            // Exclude lightningcss from bundling due to native bindings
+            // @see https://github.com/parcel-bundler/lightningcss/issues/701
+            external: ['lightningcss'],
+          },
+          environments: {
+            ssr: {
+              build: {
+                // NO EFFECT (see above)
+                // Bundle all dependencies instead of externalizing them
+                // noExternal: true,
+                // The SSR build will follow the client build, and emptying the dir would lose the output of the client build.
+                emptyOutDir: false,
+                rollupOptions: {
+                  input: [config.paths.framework.template.absolute.server.entrypoint],
+                  output: {
+                    entryFileNames: config.paths.project.relative.build.relative.serverEntrypoint,
+                  },
+                },
+              },
+            },
+          },
+        }
+      },
+      onLog(_, message) {
+        if (isKitUnusedExternalImport(message)) return
+      },
+      // generateBundle(_, bundle, isWrite) {
+      //   if (isWrite) {
+      //     for (const chunkOrAsset of Object.values(bundle)) {
+      //       console.log(chunkOrAsset)
+      //       if (chunkOrAsset.type === `chunk`) {
+      //         if (chunkOrAsset.facadeModuleId === viClientManifest.resolved) {
+      //           delete bundle[chunkOrAsset.fileName]
+      //         }
+      //       }
+      //     }
+      //   }
+      // },
+      async closeBundle() {
+        /**
+         * clean up the manifest. Was generated by client. For server build. Not needed after (unless debugging).
+         */
+        if (!config.advanced.debug) {
+          await Fs.remove(Path.join(config.paths.project.absolute.build.root, `.vite`))
+        }
+      },
+    },
+  ]
+}
+
+const BuildManifest = (config: Api.Config.Config): Vite.Plugin => {
+  return {
+    name: `polen:build-manifest`,
+    apply: `build`,
+    applyToEnvironment: Vite.isEnvironmentClient,
+    async generateBundle() {
+      const manifest: PolenBuildManifest = {
+        type: config.build.architecture === `ssr` ? `ssr` : `ssg`,
+        version: packageJson.version,
+        basePath: config.build.base ?? `/`,
+      }
+
+      // Emit the manifest as an asset
+      this.emitFile({
+        type: `asset`,
+        fileName: `.polen/build.json`,
+        source: JSON.stringify(manifest, null, 2),
+      })
+    },
+  }
+}