zuby 1.0.74 → 1.0.76

package/contexts/globalContext.d.ts

@@ -39,6 +39,11 @@ export interface GlobalContext {
      * The build ID of the site.
      */
     buildId: string;
+    /**
+     * The environment of the site.
+     * @example development
+     */
+    environment?: 'development' | 'production' | string;
     /**
      * The internalization config from ZubyConfig.
      * @example {

package/contexts/pageContext.d.ts

@@ -58,6 +58,17 @@ export declare class PageContext {
      * Returns true if the current environment is browser.
      */
     get isBrowserEnv(): boolean;
+    /**
+     * Returns true if app
+     * is running in production environment.
+     */
+    get isProductionEnv(): boolean;
+    /**
+     * Returns the current environment
+     * where the app is running.
+     * @example development
+     */
+    get environment(): string | undefined;
     /**
      * The value of 'site' property from the ZubyConfig.
      * @example https://example.com

package/contexts/pageContext.js

@@ -85,6 +85,21 @@ export class PageContext {
     get isBrowserEnv() {
         return typeof window !== 'undefined';
     }
+    /**
+     * Returns true if app
+     * is running in production environment.
+     */
+    get isProductionEnv() {
+        return this._globalContext.environment === 'production';
+    }
+    /**
+     * Returns the current environment
+     * where the app is running.
+     * @example development
+     */
+    get environment() {
+        return this._globalContext.environment;
+    }
     /**
      * The value of 'site' property from the ZubyConfig.
      * @example https://example.com

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zuby",
-  "version": "1.0.74",
+  "version": "1.0.76",
   "description": "Zuby.js is a framework for building modern apps using Preact or React.",
   "type": "module",
   "main": "index.js",

package/plugins/contextPlugin/index.js

@@ -36,6 +36,7 @@ export async function generateCompileTimeContextCode(ssr) {
         generator: 'Zuby.js ${version}',
         version: '${version}',
         buildId: '${buildId}',
+        environment: '${process.env.NODE_ENV || 'development'}',
         props: ${JSON.stringify(props)},
         image: ${await generateImageCode()},
         serverProps: ${JSON.stringify(ssr ? serverProps : {})},

package/preload/index.js

@@ -59,6 +59,10 @@ export function preloadPage(href, onHandle = () => { }) {
         preload(href);
         return;
     }
+    // Do nothing if app runs in development mode
+    if (context.environment === 'development') {
+        return;
+    }
     window.requestIdleCallback(async () => {
         const preloadManifest = await getPreloadManifest();
         // Preload assets such as scripts and styles

package/server/index.js

@@ -1927,6 +1927,21 @@ var PageContext = class {
   get isBrowserEnv() {
     return typeof window !== "undefined";
   }
+  /**
+   * Returns true if app
+   * is running in production environment.
+   */
+  get isProductionEnv() {
+    return this._globalContext.environment === "production";
+  }
+  /**
+   * Returns the current environment
+   * where the app is running.
+   * @example development
+   */
+  get environment() {
+    return this._globalContext.environment;
+  }
   /**
    * The value of 'site' property from the ZubyConfig.
    * @example https://example.com

package/server/zubyDevRenderer.d.ts

@@ -12,6 +12,6 @@ export default class ZubyDevRenderer extends ZubyRenderer {
     getJs(_templates: LazyTemplate[]): Promise<string[]>;
     getTemplateMods(template: LazyTemplate): Set<ModuleNode>;
     collectCss(mod: ModuleNode | undefined, cssUrls: Set<string>, visitedModules: Set<string>): void;
-    errorHtmlResponse(_error: any): Response;
+    errorHtmlResponse(error: any): Response;
     errorJsonResponse(error: any): Response;
 }

package/server/zubyDevRenderer.js

@@ -66,7 +66,8 @@ export default class ZubyDevRenderer extends ZubyRenderer {
             this.collectCss(dep, cssUrls, visitedModules);
         });
     }
-    errorHtmlResponse(_error) {
+    errorHtmlResponse(error) {
+        console.error(`[Zuby.js] Internal Server Error:`, error.stack || error.toString());
         return new Response(`<!DOCTYPE html>
 <html>
   <head>

package/types.d.ts

@@ -1,10 +1,11 @@
 /// <reference types="node" />
 import type { UserConfig as ViteUserConfig, InlineConfig as ViteInlineConfig, PluginOption as VitePluginOption, Plugin as VitePlugin } from 'vite';
 import { ZubyLogger } from './logger/types.js';
-import ReadableStream = NodeJS.ReadableStream;
 import { PathParamsType, Template, TemplateFile } from './templates/types.js';
 import ZubyDevServer from './server/zubyDevServer.js';
 import { GlobalContext } from './contexts/index.js';
+import ReadableStream = NodeJS.ReadableStream;
+import WritableStream = NodeJS.WritableStream;
 export interface ZubyConfig {
     /**
      * The JSX provider which will be used to render the pages.
@@ -335,8 +336,34 @@ export interface JsxProvider {
     errorTemplateFile: string;
     loaderTemplateFile: string;
 }
+export interface PipeableStream {
+    abort: (reason?: unknown) => void;
+    pipe: <Writable extends WritableStream>(destination: Writable) => Writable;
+}
+/**
+ * Function that renders the passed JSX vnode to a string.
+ * NOTE: This follows the pattern of the `renderToString` from `react-dom/server`
+ * but unlike the original function, it should support waiting for Suspense and re-hydratation.
+ * See https://react.dev/reference/react-dom/server/renderToString
+ */
 export type RenderToString = (vnode: any) => Promise<string> | string;
+/**
+ * Function that renders the passed JSX vnode to static Node.js stream.
+ * NOTE: This follows the pattern of the `renderToStaticNodeStream` from `react-dom/server` (deprecated from React 18.3.0).
+ * See https://react.dev/reference/react-dom/server/renderToStaticNodeStream
+ */
 export type RenderToStream = (vnode: any) => Promise<ReadableStream> | ReadableStream;
+/**
+ * Function that renders the passed JSX vnode to a pipeable Node.js stream.
+ * NOTE: This follows the pattern of the `renderToPipeableStream` from `react-dom/server`.
+ * See https://react.dev/reference/react-dom/server/renderToPipeableStream
+ */
+export type RenderToPipeableStream = (vnode: any) => Promise<PipeableStream> | PipeableStream;
+export type JsxRenderer = {
+    renderToString?: RenderToString;
+    renderToStream?: RenderToStream;
+    renderToPipeableStream?: RenderToPipeableStream;
+};
 /**
  * Export this property with boolean value from page module
  * to enable/disable the pre-rendering of the page.