zuby 1.0.47 → 1.0.48

package/config.d.ts

@@ -48,3 +48,7 @@ export type ExecutePluginsParams = Omit<ZubyHookParams, 'command' | 'logger' | '
  * @param plugins
  */
 export declare const normalizePlugins: (plugins: (ZubyPlugin | ZubyPlugin[] | VitePluginOption | VitePluginOption[])[]) => Promise<(ZubyPlugin | VitePlugin)[]>;
+/**
+ * Returns random build ID.
+ */
+export declare const generateDefaultBuildId: () => string;

package/config.js

@@ -1,6 +1,7 @@
 import { PLUGIN_HOOKS, } from './types.js';
 import { BUILD_CHUNKS_MANIFEST, ZUBY_CONFIG_FILE } from './constants.js';
 import { existsSync } from 'fs';
+import { randomBytes } from 'crypto';
 import { bundleRequire } from 'bundle-require';
 import { createLogger } from './logger/index.js';
 // Plugins
@@ -103,6 +104,8 @@ export const mergeDefaultConfig = async (config) => {
     config.minifyCSS = config.minifyCSS ?? true;
     config.minifyHTML = config.minifyHTML ?? true;
     config.minifyJS = config.minifyJS ?? true;
+    // Build ID generator
+    config.generateBuildId = config.generateBuildId ?? generateDefaultBuildId;
     // Add logger
     config.customLogger =
         config.customLogger ??
@@ -134,6 +137,7 @@ export const mergeDefaultConfig = async (config) => {
     return {
         ...config,
         templateExtensions: ['js', 'jsx', 'ts', 'tsx'],
+        buildId: await config.generateBuildId(),
     };
 };
 /**
@@ -206,3 +210,9 @@ export const normalizePlugins = async (plugins) => {
         // Remove false, undefined, null values
         .filter(plugin => !!plugin);
 };
+/**
+ * Returns random build ID.
+ */
+export const generateDefaultBuildId = () => {
+    return randomBytes(8).toString('hex');
+};

package/context/index.d.ts

@@ -20,5 +20,6 @@ export declare class ZubyContext {
         locales: string[];
         defaultLocale: string;
     } | undefined;
+    get buildId(): string | undefined;
 }
 export declare const getContext: () => ZubyContext;

package/context/index.js

@@ -23,6 +23,9 @@ export class ZubyContext {
     get i18n() {
         return this.rawContext.i18n;
     }
+    get buildId() {
+        return this.rawContext.buildId;
+    }
 }
 const getRawContext = () => {
     return globalThis.ZubyRawContext;

package/context/types.d.ts

@@ -35,6 +35,10 @@ export interface ZubyRawContext {
      * @example 1.0.0
      */
     version?: string;
+    /**
+     * The build ID of the site.
+     */
+    buildId?: string;
     /**
      * The internalization config from ZubyConfig.
      * @example {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zuby",
-  "version": "1.0.47",
+  "version": "1.0.48",
   "description": "Zuby.js is framework for building SPA apps using Vite",
   "type": "module",
   "main": "index.js",

package/pageContext/index.d.ts

@@ -172,4 +172,9 @@ export declare class ZubyPageContext {
      * was made by the Zuby.js pre-render build step.
      */
     get isPrerendering(): boolean;
+    /**
+     * The current build ID of the site.
+     * @example ecdf1a94cc9b4f4c
+     */
+    get buildId(): string | undefined;
 }

package/pageContext/index.js

@@ -225,4 +225,11 @@ export class ZubyPageContext {
     get isPrerendering() {
         return this._request?.headers?.get('user-agent') === 'zuby-prerender';
     }
+    /**
+     * The current build ID of the site.
+     * @example ecdf1a94cc9b4f4c
+     */
+    get buildId() {
+        return this._zubyContext.buildId;
+    }
 }

package/plugins/contextPlugin/index.js

@@ -25,7 +25,7 @@ export default function index() {
     };
 }
 export async function generateCompileTimeContextCode(ssr) {
-    const { site, i18n } = await getZubyInternalConfig();
+    const { site, i18n, buildId } = await getZubyInternalConfig();
     const { version } = await getZubyPackageConfig();
     return `globalThis.ZubyRawContext = {
         ...(globalThis.ZubyRawContext || {}),
@@ -34,6 +34,7 @@ export async function generateCompileTimeContextCode(ssr) {
         site: '${site || ''}',
         generator: 'Zuby.js ${version}',
         version: '${version}',
+        buildId: '${buildId}',
         i18n: ${JSON.stringify(i18n)},
     };`;
 }

package/preload/index.js

@@ -1,4 +1,5 @@
 import { getContext } from '../context/index.js';
+import { PREALOD_MANIFEST } from '../constants.js';
 /**
  * The set of links that were already preloaded.
  */
@@ -59,7 +60,7 @@ export function preloadPage(href, onHandle = () => { }) {
         return;
     }
     window.requestIdleCallback(async () => {
-        await loadPreloadManifest();
+        const preloadManifest = await getPreloadManifest();
         // Preload assets such as scripts and styles
         const preloadAssets = preloadManifest?.[page.filename] || [];
         preloadAssets.forEach(href => preload(href));
@@ -78,10 +79,16 @@ function addPreloadEntry({ href, as }) {
     preloadLink.rel = 'preload';
     document.head.appendChild(preloadLink);
 }
-async function loadPreloadManifest() {
-    if (preloadManifest)
-        return;
-    preloadManifest = {};
-    const res = await fetch('/preload-manifest.json');
-    preloadManifest = await res.json();
+/**
+ * Returns preload manifest the way
+ * that ensures it is loaded only once.
+ */
+async function getPreloadManifest() {
+    return (preloadManifest =
+        preloadManifest ||
+            (async () => {
+                const { buildId } = getContext();
+                const res = await fetch(`/${PREALOD_MANIFEST}?${buildId}`);
+                return res.json();
+            })());
 }

package/server/index.js

@@ -2088,6 +2088,9 @@ var ZubyContext = class {
   get i18n() {
     return this.rawContext.i18n;
   }
+  get buildId() {
+    return this.rawContext.buildId;
+  }
 };
 var getRawContext = () => {
   return globalThis.ZubyRawContext;
@@ -2326,6 +2329,13 @@ var ZubyPageContext = class {
   get isPrerendering() {
     return this._request?.headers?.get("user-agent") === "zuby-prerender";
   }
+  /**
+   * The current build ID of the site.
+   * @example ecdf1a94cc9b4f4c
+   */
+  get buildId() {
+    return this._zubyContext.buildId;
+  }
 };
 
 // src/server/zubyRenderer.ts

package/types.d.ts

@@ -122,6 +122,11 @@ export interface ZubyConfig {
      * @private
      */
     configFilePath?: string;
+    /**
+     * If you're building in multiple environments,
+     * you can use this option to generate consistent build IDs.
+     */
+    generateBuildId?: () => string | Promise<string>;
 }
 export interface ZubyInternalConfig extends Required<ZubyConfig> {
     /**
@@ -136,6 +141,10 @@ export interface ZubyInternalConfig extends Required<ZubyConfig> {
      * @default []
      */
     plugins: ZubyPlugin[];
+    /**
+     * The current build ID
+     */
+    buildId: string;
 }
 export interface BaseCommandOptions {
     /**
@@ -304,6 +313,14 @@ export interface ZubyPlugin extends VitePlugin {
 export interface ZubyConfigSetupHookParams {
     config: ZubyConfig;
     command: 'dev' | 'build';
+    addEntryTemplate: (entryFile: string) => void;
+    addAppTemplate: (appFile: string, path?: string) => void;
+    addLayoutTemplate: (layoutFile: string, path?: string) => void;
+    addInnerLayoutTemplate: (innerLayoutFile: string, path?: string) => void;
+    addErrorTemplate: (errorFile: string, path?: string) => void;
+    addLoaderTemplate: (loaderFile: string, path?: string) => void;
+    addPage: (pageFile: string, path?: string) => void;
+    addHandler: (handlerFile: string, path?: string) => void;
 }
 export interface ZubyConfigDoneHookParams extends ZubyConfigSetupHookParams {
     config: ZubyInternalConfig;