zuby 1.0.62 → 1.0.63

package/commands/build.js

@@ -1,7 +1,7 @@
 import { MODES, PLUGIN_HOOKS } from '../types.js';
 import { executePlugins, getZubyInternalConfig } from '../config.js';
 import chalk from 'chalk';
-import { getTitle } from '../branding.js';
+import { getTitle } from '../utils/brandingUtils.js';
 import { build as viteBuild } from 'vite';
 import { dirname, join, resolve } from 'path';
 import { normalizePath } from '../utils/pathUtils.js';
@@ -22,7 +22,7 @@ export default async function build(options) {
     const nextBuildStep = (description) => {
         logger?.info(`${chalk.bgYellow.bold.whiteBright(` Step ${buildStep++}/${buildSteps} `)} ${chalk.gray(description)}`);
     };
-    process.env.NODE_ENV = MODES.production;
+    zubyInternalConfig.mode = process.env.NODE_ENV = MODES.production;
     logger?.info(getTitle(chalk.gray(`building for production...`)));
     // Load templates from the project directory
     const templates = await getTemplates();

package/commands/dev.js

@@ -1,7 +1,7 @@
 import { PLUGIN_HOOKS } from '../types.js';
 import { executePlugins, getZubyInternalConfig } from '../config.js';
 import { performance } from 'node:perf_hooks';
-import { getTitle } from '../branding.js';
+import { getTitle } from '../utils/brandingUtils.js';
 import chalk from 'chalk';
 import ZubyDevServer from '../server/zubyDevServer.js';
 export default async function dev(options) {

package/commands/init.js

@@ -1,6 +1,6 @@
 import inquirer from 'inquirer';
 import { createLogger } from '../logger/index.js';
-import { getTitle } from '../branding.js';
+import { getTitle } from '../utils/brandingUtils.js';
 import chalk from 'chalk';
 import { existsSync, readdirSync, cpSync, statSync } from 'fs';
 import { readFile, writeFile } from 'fs/promises';

package/commands/upgrade.js

@@ -3,7 +3,7 @@ import { existsSync, readFileSync, writeFileSync } from 'fs';
 import { resolve } from 'path';
 import { execSync } from 'child_process';
 import { getZubyPackageConfig } from '../packageConfig.js';
-import { getTitle } from '../branding.js';
+import { getTitle } from '../utils/brandingUtils.js';
 import chalk from 'chalk';
 export default async function upgrade({ configFile, tag }) {
     const { customLogger: logger } = await getZubyInternalConfig(configFile);

package/config.d.ts

@@ -49,6 +49,8 @@ export type ExecutePluginsParams = Omit<ZubyHookParams, 'command' | 'logger' | '
  */
 export declare const normalizePlugins: (plugins: (ZubyPlugin | ZubyPlugin[] | VitePluginOption | VitePluginOption[])[]) => Promise<(ZubyPlugin | VitePlugin)[]>;
 /**
- * Returns random build ID.
+ * Returns random base32 like build ID
+ * without special characters
+ * that can be used directly in URLs.
  */
 export declare const generateDefaultBuildId: () => string;

package/config.js

@@ -7,7 +7,6 @@ import { createLogger } from './logger/index.js';
 import { TEMPLATES } from './templates/types.js';
 // Plugins
 import contextPlugin from './plugins/contextPlugin/index.js';
-import compileTimePlugin from './plugins/compileTimePlugin/index.js';
 import chunkNamingPlugin from './plugins/chunkNamingPlugin/index.js';
 import manifestPlugin from './plugins/manifestPlugin/index.js';
 import prerenderPlugin from './plugins/prerenderPlugin/index.js';
@@ -62,6 +61,7 @@ export const getZubyInternalConfig = async (configFilePath, cache = true) => {
     zubyConfig.configFilePath = configFilePath;
     zubyConfig.templateFiles = zubyConfig.templateFiles || [];
     zubyConfig.headElements = zubyConfig.headElements || [];
+    zubyConfig.bodyElements = zubyConfig.bodyElements || [];
     // Run config setup hook
     await executePlugins(zubyConfig, PLUGIN_HOOKS.ZubyConfigSetup, {
         addEntryTemplate: (filename) => zubyConfig.templateFiles?.push({
@@ -161,6 +161,8 @@ export const mergeDefaultConfig = async (config) => {
     config.minifyCSS = config.minifyCSS ?? true;
     config.minifyHTML = config.minifyHTML ?? true;
     config.minifyJS = config.minifyJS ?? true;
+    config.compress = config.compress ?? true;
+    config.poweredByHeader = config.poweredByHeader ?? true;
     // Build ID generator
     config.generateBuildId = config.generateBuildId ?? generateDefaultBuildId;
     // Global props
@@ -217,7 +219,6 @@ export const getBuiltInPlugins = () => {
     return [
         injectPlugin(),
         contextPlugin(),
-        compileTimePlugin(),
         chunkNamingPlugin(),
         manifestPlugin(),
         prerenderPlugin(),
@@ -280,7 +281,9 @@ export const normalizePlugins = async (plugins) => {
         .filter(plugin => !!plugin);
 };
 /**
- * Returns random build ID.
+ * Returns random base32 like build ID
+ * without special characters
+ * that can be used directly in URLs.
  */
 export const generateDefaultBuildId = () => {
     return randomBytes(8).toString('base64').substring(0, 8);

package/constants.d.ts

@@ -9,13 +9,17 @@ export declare const HTTP_HEADERS: {
     Host: string;
     Server: string;
     UserAgent: string;
+    Location: string;
     ContentType: string;
     ContentLength: string;
     ContentRange: string;
     ContentEncoding: string;
     ContentLanguage: string;
     AcceptRanges: string;
+    AcceptEncoding: string;
     CacheControl: string;
+    LastModified: string;
+    XForwardedFor: string;
     XForwardedProto: string;
     XForwardedHost: string;
     XPoweredBy: string;

package/constants.js

@@ -11,13 +11,17 @@ export const HTTP_HEADERS = {
     Host: 'Host',
     Server: 'Server',
     UserAgent: 'User-Agent',
+    Location: 'Location',
     ContentType: 'Content-Type',
     ContentLength: 'Content-Length',
     ContentRange: 'Content-Range',
     ContentEncoding: 'Content-Encoding',
     ContentLanguage: 'Content-Language',
     AcceptRanges: 'Accept-Ranges',
+    AcceptEncoding: 'Accept-Encoding',
     CacheControl: 'Cache-Control',
+    LastModified: 'Last-Modified',
+    XForwardedFor: 'X-Forwarded-For',
     XForwardedProto: 'X-Forwarded-Proto',
     XForwardedHost: 'X-Forwarded-Host',
     XPoweredBy: 'X-Powered-By',

package/{context/types.d.ts → contexts/globalContext.d.ts}

@@ -1,22 +1,22 @@
 import { LazyTemplate } from '../templates/types.js';
 import { RenderToStream, RenderToString } from '../types.js';
-export interface ZubyRawContext {
+export interface GlobalContext {
     /**
      * The array with templates.
      */
-    templates?: {
-        pages?: LazyTemplate[];
-        apps?: LazyTemplate[];
-        errors?: LazyTemplate[];
-        layouts?: LazyTemplate[];
-        innerLayouts?: LazyTemplate[];
-        handlers?: LazyTemplate[];
-        loaders?: LazyTemplate[];
+    templates: {
+        pages: LazyTemplate[];
+        apps: LazyTemplate[];
+        errors: LazyTemplate[];
+        layouts: LazyTemplate[];
+        innerLayouts: LazyTemplate[];
+        handlers: LazyTemplate[];
+        loaders: LazyTemplate[];
     };
     /**
      * The render module from JsxProvider.
      */
-    render?: {
+    render: {
         renderToString?: RenderToString;
         renderToStream?: RenderToStream;
     };
@@ -24,21 +24,21 @@ export interface ZubyRawContext {
      * The URL of the site
      * @example https://example.com
      */
-    site?: string;
+    site: string;
     /**
      * The name of the generator together with its version number
      * @example Zuby.js 1.0.0
      */
-    generator?: string;
+    generator: string;
     /**
      * The version of used Zuby.js
      * @example 1.0.0
      */
-    version?: string;
+    version: string;
     /**
      * The build ID of the site.
      */
-    buildId?: string;
+    buildId: string;
     /**
      * The internalization config from ZubyConfig.
      * @example {
@@ -55,16 +55,22 @@ export interface ZubyRawContext {
      * that will be passed to all pages
      * on both client and server side.
      */
-    props?: Record<string, any>;
+    props: Record<string, any>;
     /**
      * The global server props for the site
      * that will be passed to all pages
      * only on server side.
      */
-    serverProps?: Record<string, any>;
+    serverProps: Record<string, any>;
     /**
      * Additional elements that should be added
      * to the head of the page.
      */
-    headElements?: string[];
+    headElements: string[];
+    /**
+     * Additional elements that should be added
+     * to the body of the page.
+     */
+    bodyElements: string[];
 }
+export declare const getGlobalContext: () => GlobalContext;

package/contexts/globalContext.js

@@ -0,0 +1,7 @@
+export const getGlobalContext = () => {
+    const globalContext = globalThis._zubyGlobalContext;
+    if (!globalContext) {
+        globalThis._zubyGlobalContext = {};
+    }
+    return globalContext;
+};

package/contexts/index.d.ts

@@ -0,0 +1,6 @@
+export * from './globalContext.js';
+export * from './pageContext.js';
+export { PageContext as HandlerContext } from './pageContext.js';
+export { PageContext as ZubyPageContext } from './pageContext.js';
+export { PageContext as ZubyHandlerContext } from './pageContext.js';
+export { GlobalContext as ZubyGlobalContext } from './globalContext.js';

package/contexts/index.js

@@ -0,0 +1,5 @@
+export * from './globalContext.js';
+export * from './pageContext.js';
+export { PageContext as HandlerContext } from './pageContext.js';
+export { PageContext as ZubyPageContext } from './pageContext.js';
+export { PageContext as ZubyHandlerContext } from './pageContext.js';

package/{pageContext/index.d.ts → contexts/pageContext.d.ts}

@@ -1,5 +1,5 @@
-import { ZubyContext } from '../context/index.js';
-export declare class ZubyPageContext {
+import { GlobalContext } from './globalContext.js';
+export declare class PageContext {
     protected _url: URL;
     protected _initialPath: string;
     protected _title: string;
@@ -12,7 +12,8 @@ export declare class ZubyPageContext {
     protected _props: Record<string, any>;
     protected _serverProps: Record<string, any>;
     protected _headElements: (string | (() => any))[];
-    protected _zubyContext: ZubyContext;
+    protected _bodyElements: (string | (() => any))[];
+    protected _globalContext: GlobalContext;
     constructor(options: {
         url?: URL;
         initialPath?: string;
@@ -22,7 +23,7 @@ export declare class ZubyPageContext {
         statusCode?: number;
         props?: Record<string, any>;
         headers?: Headers;
-        zubyContext?: ZubyContext;
+        globalContext?: GlobalContext;
     });
     /**
      * The current URL of the page.
@@ -61,31 +62,31 @@ export declare class ZubyPageContext {
      * The value of 'site' property from the ZubyConfig.
      * @example https://example.com
      */
-    get site(): string | undefined;
+    get site(): string;
     /**
      * The generator name
      * tha can be used in the meta tag.
      * @example Zuby.js v1.0.0
      */
-    get generator(): string | undefined;
+    get generator(): string;
     /**
      * The used Zuby version.
      * @example 1.0.0
      */
-    get version(): string | undefined;
+    get version(): string;
     /**
      * The object with all parsed templates.
      * The available templates differ in browser and server env.
      */
     get templates(): {
-        pages?: import("../templates/types.js").LazyTemplate[] | undefined;
-        apps?: import("../templates/types.js").LazyTemplate[] | undefined;
-        errors?: import("../templates/types.js").LazyTemplate[] | undefined;
-        layouts?: import("../templates/types.js").LazyTemplate[] | undefined;
-        innerLayouts?: import("../templates/types.js").LazyTemplate[] | undefined;
-        handlers?: import("../templates/types.js").LazyTemplate[] | undefined;
-        loaders?: import("../templates/types.js").LazyTemplate[] | undefined;
-    } | undefined;
+        pages: import("../templates/types.js").LazyTemplate[];
+        apps: import("../templates/types.js").LazyTemplate[];
+        errors: import("../templates/types.js").LazyTemplate[];
+        layouts: import("../templates/types.js").LazyTemplate[];
+        innerLayouts: import("../templates/types.js").LazyTemplate[];
+        handlers: import("../templates/types.js").LazyTemplate[];
+        loaders: import("../templates/types.js").LazyTemplate[];
+    };
     /**
      * The object with props that should be passed to the page component.
      * The props are shared between page and handlers on given path.
@@ -109,11 +110,11 @@ export declare class ZubyPageContext {
     /**
      * The global props from the ZubyConfig
      */
-    get globalProps(): Record<string, any> | undefined;
+    get globalProps(): Record<string, any>;
     /**
      * The global server props from the ZubyConfig
      */
-    get globalServerProps(): Record<string, any> | undefined;
+    get globalServerProps(): Record<string, any>;
     /**
      * The current status code that will be returned to the client.
      * This property has only effect in server-side.
@@ -196,17 +197,40 @@ export declare class ZubyPageContext {
      * The current build ID of the site.
      * @example ecdf1a94cc9b4f4c
      */
-    get buildId(): string | undefined;
+    get buildId(): string;
     /**
      * Adds the given HTML string
      * or Jsx Component to the head of the page
      * when it's rendered on the server.
+     * @param element The HTML string
+     * @param front If true, the element is added to the beginning of the head tag
      */
-    addToHead(element: string | (() => any)): void;
+    addToHead(element: string | (() => any), front?: boolean): number | undefined;
+    /**
+     * Adds the given HTML string
+     * or Jsx Component to the body of the page
+     * when it's rendered on the server.
+     * @param element The HTML string
+     * @param front If true, the element is added to the end of the body tag
+     */
+    addToBody(element: string | (() => any), front?: boolean): number | undefined;
     /**
      * Returns array of all elements as string
      * that should be added to the head of the page.
      * @private
      */
     getHeadElements(): Promise<string[]>;
+    /**
+     * Returns array of all elements as string
+     * that should be added to the body of the page.
+     * @private
+     */
+    getBodyElements(): Promise<string[]>;
+    /**
+     * Renders the given HTML element
+     * or function component to string
+     * @param element The HTML string or function component
+     * @private
+     */
+    protected getElement(element: string | (() => any)): Promise<string>;
 }

package/{pageContext/index.js → contexts/pageContext.js}

@@ -1,5 +1,5 @@
-import { getContext } from '../context/index.js';
-export class ZubyPageContext {
+import { getGlobalContext } from './globalContext.js';
+export class PageContext {
     constructor(options) {
         this._request = options?.request;
         this._url = options?.url || new URL(options?.request?.url || '/', 'http://localhost/');
@@ -12,8 +12,9 @@ export class ZubyPageContext {
         this._serverProps = {};
         this._cache = 0;
         this._headers = options?.headers || new Headers();
-        this._zubyContext = options?.zubyContext || getContext();
-        this._headElements = [...(this._zubyContext.headElements || [])];
+        this._globalContext = options?.globalContext || getGlobalContext();
+        this._headElements = [...(this._globalContext.headElements || [])];
+        this._bodyElements = [...(this._globalContext.bodyElements || [])];
     }
     /**
      * The current URL of the page.
@@ -78,7 +79,7 @@ export class ZubyPageContext {
      * @example https://example.com
      */
     get site() {
-        return this._zubyContext.site;
+        return this._globalContext.site;
     }
     /**
      * The generator name
@@ -86,21 +87,21 @@ export class ZubyPageContext {
      * @example Zuby.js v1.0.0
      */
     get generator() {
-        return this._zubyContext.generator;
+        return this._globalContext.generator;
     }
     /**
      * The used Zuby version.
      * @example 1.0.0
      */
     get version() {
-        return this._zubyContext.version;
+        return this._globalContext.version;
     }
     /**
      * The object with all parsed templates.
      * The available templates differ in browser and server env.
      */
     get templates() {
-        return this._zubyContext.templates;
+        return this._globalContext.templates;
     }
     /**
      * The object with props that should be passed to the page component.
@@ -126,7 +127,7 @@ export class ZubyPageContext {
      */
     get serverProps() {
         return {
-            ...(this._zubyContext.serverProps || {}),
+            ...(this._globalContext.serverProps || {}),
             ...(this._serverProps || {}),
         };
     }
@@ -137,13 +138,13 @@ export class ZubyPageContext {
      * The global props from the ZubyConfig
      */
     get globalProps() {
-        return this._zubyContext.props;
+        return this._globalContext.props;
     }
     /**
      * The global server props from the ZubyConfig
      */
     get globalServerProps() {
-        return this._zubyContext.serverProps;
+        return this._globalContext.serverProps;
     }
     /**
      * The current status code that will be returned to the client.
@@ -215,7 +216,7 @@ export class ZubyPageContext {
      * @example ['en', 'de', 'cs', 'pl']
      */
     get locales() {
-        return this._zubyContext.i18n?.locales || [];
+        return this._globalContext.i18n?.locales || [];
     }
     /**
      * The default locale
@@ -225,7 +226,7 @@ export class ZubyPageContext {
      * @example 'en'
      */
     get defaultLocale() {
-        return this._zubyContext.i18n?.defaultLocale;
+        return this._globalContext.i18n?.defaultLocale;
     }
     /**
      * The current active locale matched from the URL.
@@ -261,27 +262,58 @@ export class ZubyPageContext {
      * @example ecdf1a94cc9b4f4c
      */
     get buildId() {
-        return this._zubyContext.buildId;
+        return this._globalContext.buildId;
     }
     /**
      * Adds the given HTML string
      * or Jsx Component to the head of the page
      * when it's rendered on the server.
+     * @param element The HTML string
+     * @param front If true, the element is added to the beginning of the head tag
      */
-    addToHead(element) {
+    addToHead(element, front = false) {
+        if (front)
+            return this._headElements.unshift(element);
         this._headElements.push(element);
     }
+    /**
+     * Adds the given HTML string
+     * or Jsx Component to the body of the page
+     * when it's rendered on the server.
+     * @param element The HTML string
+     * @param front If true, the element is added to the end of the body tag
+     */
+    addToBody(element, front = false) {
+        if (front)
+            return this._bodyElements.unshift(element);
+        this._bodyElements.push(element);
+    }
     /**
      * Returns array of all elements as string
      * that should be added to the head of the page.
      * @private
      */
     async getHeadElements() {
-        return Promise.all(this._headElements.map(element => {
-            if (typeof element === 'function') {
-                return this._zubyContext?.renderToString?.(element()) || '';
-            }
-            return element;
-        }));
+        return Promise.all(this._headElements.map(element => this.getElement(element)));
+    }
+    /**
+     * Returns array of all elements as string
+     * that should be added to the body of the page.
+     * @private
+     */
+    async getBodyElements() {
+        return Promise.all(this._bodyElements.map(element => this.getElement(element)));
+    }
+    /**
+     * Renders the given HTML element
+     * or function component to string
+     * @param element The HTML string or function component
+     * @private
+     */
+    async getElement(element) {
+        if (typeof element === 'function') {
+            return this._globalContext?.render?.renderToString?.(element()) || '';
+        }
+        return element;
     }
 }

package/hooks/index.d.ts

@@ -0,0 +1 @@
+export * from './useGlobalContext.js';

package/hooks/index.js

@@ -0,0 +1 @@
+export * from './useGlobalContext.js';

package/hooks/useGlobalContext.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Returns the global context of the application.
+ * @returns GlobalContext
+ */
+export declare function useGlobalContext(): import("../contexts/globalContext.js").GlobalContext;

package/hooks/useGlobalContext.js

@@ -0,0 +1,8 @@
+import { getGlobalContext } from '../contexts/index.js';
+/**
+ * Returns the global context of the application.
+ * @returns GlobalContext
+ */
+export function useGlobalContext() {
+    return getGlobalContext();
+}

package/index.d.ts

@@ -1,7 +1,4 @@
 export * from './types.js';
 export * from './defineConfig.js';
-export * from './context/index.js';
-export * from './pageContext/index.js';
-export { ZubyContext as Context } from './context/index.js';
-export { ZubyPageContext as PageContext } from './pageContext/index.js';
-export { ZubyPageContext as HandlerContext } from './pageContext/index.js';
+export * from './contexts/index.js';
+export * from './hooks/index.js';

package/index.js

@@ -1,7 +1,4 @@
 export * from './types.js';
 export * from './defineConfig.js';
-export * from './context/index.js';
-export * from './pageContext/index.js';
-export { ZubyContext as Context } from './context/index.js';
-export { ZubyPageContext as PageContext } from './pageContext/index.js';
-export { ZubyPageContext as HandlerContext } from './pageContext/index.js';
+export * from './contexts/index.js';
+export * from './hooks/index.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zuby",
-  "version": "1.0.62",
+  "version": "1.0.63",
   "description": "Zuby.js is a framework for building modern apps using Preact or React.",
   "type": "module",
   "main": "index.js",
@@ -22,11 +22,9 @@
     "chalk": "^5.3.0",
     "chokidar": "^3.5.3",
     "commander": "^11.0.0",
-    "devalue": "^4.3.2",
     "esbuild": "^0.19.11",
     "glob": "^10.3.10",
     "inquirer": "^9.2.12",
-    "magic-string": "^0.30.5",
     "rollup": "^4.9.5",
     "vite": "^5.0.11"
   },

package/packageConfig.d.ts

@@ -1 +1,30 @@
-export declare const getZubyPackageConfig: (cache?: boolean) => any;
+export interface ZubyPackageConfig {
+    name: string;
+    version: string;
+    description: string;
+    type?: string;
+    private?: boolean;
+    publishConfig?: {
+        directory?: string;
+        linkDirectory?: boolean;
+    };
+    main?: string;
+    scripts?: Record<string, string>;
+    keywords?: string[];
+    devDependencies?: Record<string, string>;
+    dependencies?: Record<string, string>;
+    peerDependencies?: Record<string, string>;
+    bin?: Record<string, string>;
+    license?: string;
+    author?: string;
+    homepage?: string;
+    repository?: {
+        type: string;
+        url: string;
+    };
+}
+/**
+ * Returns the package.json content of the current package.
+ * @param cache - If true, the package.json content will be cached.
+ */
+export declare const getZubyPackageConfig: (cache?: boolean) => ZubyPackageConfig;

package/packageConfig.js

@@ -1,13 +1,17 @@
 import { fileURLToPath } from 'url';
 import { dirname, resolve } from 'path';
 import { readFileSync } from 'fs';
-let packageJson;
+let packageConfigCache;
+/**
+ * Returns the package.json content of the current package.
+ * @param cache - If true, the package.json content will be cached.
+ */
 export const getZubyPackageConfig = (cache = true) => {
-    if (cache && packageJson)
-        return packageJson;
+    if (cache && packageConfigCache)
+        return packageConfigCache;
     const __filename = fileURLToPath(import.meta.url);
     const __dirname = dirname(__filename);
     // Cache the package.json content
-    packageJson = JSON.parse(readFileSync(resolve(__dirname, 'package.json'), 'utf-8'));
-    return packageJson;
+    packageConfigCache = JSON.parse(readFileSync(resolve(__dirname, 'package.json'), 'utf-8'));
+    return packageConfigCache;
 };