@blinkk/root 1.0.0-beta.11 → 1.0.0-beta.13

package/dist/core.d.ts

@@ -1,7 +1,7 @@
 import { R as Route } from './types-8310f09f.js';
 export { C as ConfigureServerHook, f as ConfigureServerOptions, j as GetStaticPaths, G as GetStaticProps, m as Handler, H as HandlerContext, N as NextFunction, P as Plugin, k as Request, l as Response, b as RootConfig, c as RootI18nConfig, d as RootServerConfig, a as RootUserConfig, R as Route, n as RouteModule, i as RouteParams, S as Server, g as configureServerPlugins, e as defineConfig, h as getVitePlugins } from './types-8310f09f.js';
 import * as preact$1 from 'preact';
-import { ComponentChildren, FunctionalComponent } from 'preact';
+import { FunctionalComponent, ComponentChildren } from 'preact';
 import 'express';
 import 'vite';
 import 'html-minifier-terser';
@@ -48,14 +48,6 @@ declare type HeadProps = preact.JSX.HTMLAttributes<HTMLHeadElement> & {
  */
 declare const Head: FunctionalComponent<HeadProps>;
 
-interface HtmlContext {
-    htmlAttrs: preact$1.JSX.HTMLAttributes<HTMLHtmlElement>;
-    headAttrs: preact$1.JSX.HTMLAttributes<HTMLHeadElement>;
-    headComponents: ComponentChildren[];
-    bodyAttrs: preact$1.JSX.HTMLAttributes<HTMLBodyElement>;
-    scriptDeps: Array<preact$1.JSX.HTMLAttributes<HTMLScriptElement>>;
-}
-declare const HTML_CONTEXT: preact$1.Context<HtmlContext | null>;
 declare type HtmlProps = preact$1.JSX.HTMLAttributes<HTMLHtmlElement> & {
     children?: ComponentChildren;
 };
@@ -86,7 +78,6 @@ declare type ScriptProps = preact.JSX.HTMLAttributes<HTMLScriptElement>;
  */
 declare const Script: FunctionalComponent<ScriptProps>;
 
-declare const I18N_CONTEXT: preact$1.Context<I18nContext | null>;
 interface I18nContext {
     locale: string;
     translations: Record<string, string>;
@@ -113,7 +104,6 @@ interface RequestContext {
     /** Translations map for the current locale. */
     translations: Record<string, string>;
 }
-declare const REQUEST_CONTEXT: preact$1.Context<RequestContext | null>;
 /**
  * A hook that returns information about the current route.
  *
@@ -141,4 +131,4 @@ declare function useRequestContext(): RequestContext;
  */
 declare function useTranslations(): (str: string, params?: Record<string, string>) => string;
 
-export { Body, BodyProps, HTML_CONTEXT, Head, HeadProps, Html, HtmlContext, HtmlProps, I18N_CONTEXT, I18nContext, REQUEST_CONTEXT, RequestContext, Script, ScriptProps, getTranslations, useI18nContext, useRequestContext, useTranslations };
+export { Body, Head, Html, I18nContext, RequestContext, Script, getTranslations, useI18nContext, useRequestContext, useTranslations };

package/dist/core.js

@@ -1,8 +1,6 @@
 import {
   HTML_CONTEXT,
   Html,
-  I18N_CONTEXT,
-  REQUEST_CONTEXT,
   getTranslations,
   useI18nContext,
   useRequestContext
@@ -78,11 +76,8 @@ function useTranslations() {
 }
 export {
   Body,
-  HTML_CONTEXT,
   Head,
   Html,
-  I18N_CONTEXT,
-  REQUEST_CONTEXT,
   Script,
   configureServerPlugins,
   defineConfig,

package/dist/core.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/core/config.ts","../src/core/components/Body.tsx","../src/core/components/Head.ts","../src/core/components/Script.ts","../src/core/hooks/useTranslations.ts"],"sourcesContent":["import {Request, Response, NextFunction} from './types';\nimport {Plugin} from './plugin';\nimport {UserConfig as ViteUserConfig} from 'vite';\nimport {HtmlMinifyOptions} from '../render/html-minify';\nimport {HtmlPrettyOptions} from '../render/html-pretty';\n\nexport interface RootUserConfig {\n  /**\n   * Canonical domain the website will serve on. Useful for things like the\n   * sitemap, SEO tags, etc.\n   */\n  domain?: string;\n\n  /**\n   * Config for auto-injecting custom element dependencies.\n   */\n  elements?: {\n    /**\n     * A list of directories to use to look for custom elements. The dir path\n     * should be relative to the project dir, e.g. \"path/to/elements\".\n     */\n    include?: string[];\n\n    /**\n     * A list of RegEx patterns to exclude. The string passed to the RegEx is\n     * the file URL relative to the project root, e.g. \"/elements/foo/foo.ts\".\n     */\n    exclude?: RegExp[];\n  };\n\n  /**\n   * Config options for localization and internationalization.\n   */\n  i18n?: RootI18nConfig;\n\n  /**\n   * Config options for the Root.js express server.\n   */\n  server?: RootServerConfig;\n\n  /**\n   * Vite config.\n   * @see {@link https://vitejs.dev/config/} for more information.\n   */\n  vite?: ViteUserConfig;\n\n  /**\n   * Whether to automatically minify HTML output. This is enabled by default,\n   * in order to disable, pass `minifyHtml: false` to root.config.ts.\n   */\n  minifyHtml?: boolean;\n\n  /**\n   * Options to pass to html-minifier-terser.\n   */\n  minifyHtmlOptions?: HtmlMinifyOptions;\n\n  /**\n   * Whether to pretty print HTML output.\n   */\n  prettyHtml?: boolean;\n\n  /**\n   * Options to pass to js-beautify.\n   */\n  prettyHtmlOptions?: HtmlPrettyOptions;\n\n  /**\n   * Whether to include a sitemap.xml file to the build output.\n   */\n  sitemap?: boolean;\n\n  /**\n   * Plugins.\n   */\n  plugins?: Plugin[];\n}\n\nexport type RootConfig = RootUserConfig & {\n  rootDir: string;\n};\n\nexport interface RootI18nConfig {\n  /**\n   * Locales enabled for the site.\n   */\n  locales?: string[];\n\n  /**\n   * The default locale to use. Defaults is `en`.\n   */\n  defaultLocale?: string;\n\n  /**\n   * URL format for localized content. Default is `/{locale}/{path}`.\n   */\n  urlFormat?: string;\n}\n\nexport interface RootServerConfig {\n  /**\n   * An array of middleware to add to the express server. These middleware are\n   * added to the beginning of the express app.\n   */\n  middlewares?: Array<\n    (req: Request, res: Response, next: NextFunction) => void | Promise<void>\n  >;\n}\n\nexport function defineConfig(config: RootUserConfig): RootUserConfig {\n  return config;\n}\n","import {ComponentChildren, FunctionalComponent} from 'preact';\nimport {useContext} from 'preact/hooks';\nimport {HTML_CONTEXT} from './Html';\n\nexport type BodyProps = preact.JSX.HTMLAttributes<HTMLBodyElement> & {\n  children?: ComponentChildren;\n};\n\n/**\n * The `<Body>` component can be used to update attrs in the `<body>` tag.\n *\n * Usage:\n *\n * ```tsx\n * <Body className=\"body\">\n *   <h1>Hello world</h1>\n * </Body>\n * ```\n *\n * Output:\n *\n * ```html\n * <body class=\"body\">\n *   <h1>Hello world</h1>\n * </body>\n */\nexport const Body: FunctionalComponent<BodyProps> = ({children, ...attrs}) => {\n  const context = useContext(HTML_CONTEXT);\n  if (!context) {\n    throw new Error(\n      'HTML_CONTEXT not found, double-check usage of the <Body> component'\n    );\n  }\n  context.bodyAttrs = attrs;\n  return <>{children}</>;\n};\n","import {ComponentChildren, FunctionalComponent} from 'preact';\nimport {useContext} from 'preact/hooks';\nimport {HTML_CONTEXT} from './Html';\n\nexport type HeadProps = preact.JSX.HTMLAttributes<HTMLHeadElement> & {\n  children?: ComponentChildren;\n};\n\n/**\n * The <Head> component can be used for injecting elements into the HTML head\n * tag from any part of a page. The <Head> can be added via any component or\n * sub-component and will automatically be hoisted to the `<head>` element.\n *\n * Usage:\n *\n * ```tsx\n * <Head>\n *   <link rel=\"preconnect\" href=\"https://fonts.googleapis.com\" />\n * </Head>\n * ```\n */\nexport const Head: FunctionalComponent<HeadProps> = ({children, ...attrs}) => {\n  const context = useContext(HTML_CONTEXT);\n  if (!context) {\n    throw new Error(\n      'HTML_CONTEXT not found, double-check usage of the <Head> component'\n    );\n  }\n  context.headComponents.push(children);\n  context.headAttrs = attrs;\n  return null;\n};\n","import {FunctionalComponent} from 'preact';\nimport {useContext} from 'preact/hooks';\nimport {HTML_CONTEXT} from './Html';\n\nexport type ScriptProps = preact.JSX.HTMLAttributes<HTMLScriptElement>;\n\n/**\n * The <Script> component is used for rendering any custom script modules. At\n * the moment, the system only pre-renders and bundles files that are in the\n * `/bundles` folder at the root of the project.\n *\n * Usage:\n *\n * ```tsx\n * <Script src=\"/bundles/main.ts\" />\n * ```\n */\nexport const Script: FunctionalComponent<ScriptProps> = (props) => {\n  const context = useContext(HTML_CONTEXT);\n  if (!context) {\n    throw new Error(\n      'HTML_CONTEXT not found, double-check usage of the <Script> component'\n    );\n  }\n  context.scriptDeps.push(props);\n  return null;\n};\n","import {useI18nContext} from './useI18nContext';\n\n/**\n * A hook that returns a function that can be used to translate a string, and\n * optionally replace any parameterized values that are surrounded in curly\n * braces.\n *\n * Usage:\n *\n * ```ts\n * const t = useTranslations();\n * t('Hello {name}', {name: 'Bob'});\n * // => 'Bounjour Bob'\n */\nexport function useTranslations() {\n  const context = useI18nContext();\n  const translations = context.translations || {};\n  const t = (str: string, params?: Record<string, string>) => {\n    let translation = translations[str] ?? str ?? '';\n    if (params) {\n      for (const key of Object.keys(params)) {\n        const val = String(params[key] ?? '');\n        translation = translation.replaceAll(`{${key}}`, val);\n      }\n    }\n    return translation;\n  };\n  return t;\n}\n"],"mappings":";;;;;;;;;;;;;;;AA6GO,SAAS,aAAa,QAAwC;AACnE,SAAO;AACT;;;AC9GA,SAAQ,kBAAiB;AAiChB;AARF,IAAM,OAAuC,CAAC,EAAC,aAAa,MAAK,MAAM;AAC5E,QAAM,UAAU,WAAW,YAAY;AACvC,MAAI,CAAC,SAAS;AACZ,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACA,UAAQ,YAAY;AACpB,SAAO;AAAA,IAAG;AAAA,GAAS;AACrB;;;AClCA,SAAQ,cAAAA,mBAAiB;AAoBlB,IAAM,OAAuC,CAAC,EAAC,aAAa,MAAK,MAAM;AAC5E,QAAM,UAAUC,YAAW,YAAY;AACvC,MAAI,CAAC,SAAS;AACZ,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACA,UAAQ,eAAe,KAAK,QAAQ;AACpC,UAAQ,YAAY;AACpB,SAAO;AACT;;;AC9BA,SAAQ,cAAAC,mBAAiB;AAgBlB,IAAM,SAA2C,CAAC,UAAU;AACjE,QAAM,UAAUC,YAAW,YAAY;AACvC,MAAI,CAAC,SAAS;AACZ,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACA,UAAQ,WAAW,KAAK,KAAK;AAC7B,SAAO;AACT;;;ACZO,SAAS,kBAAkB;AAChC,QAAM,UAAU,eAAe;AAC/B,QAAM,eAAe,QAAQ,gBAAgB,CAAC;AAC9C,QAAM,IAAI,CAAC,KAAa,WAAoC;AAC1D,QAAI,cAAc,aAAa,QAAQ,OAAO;AAC9C,QAAI,QAAQ;AACV,iBAAW,OAAO,OAAO,KAAK,MAAM,GAAG;AACrC,cAAM,MAAM,OAAO,OAAO,QAAQ,EAAE;AACpC,sBAAc,YAAY,WAAW,IAAI,QAAQ,GAAG;AAAA,MACtD;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACA,SAAO;AACT;","names":["useContext","useContext","useContext","useContext"]}
+{"version":3,"sources":["../src/core/config.ts","../src/core/components/Body.tsx","../src/core/components/Head.ts","../src/core/components/Script.ts","../src/core/hooks/useTranslations.ts"],"sourcesContent":["import {Request, Response, NextFunction} from './types';\nimport {Plugin} from './plugin';\nimport {UserConfig as ViteUserConfig} from 'vite';\nimport {HtmlMinifyOptions} from '../render/html-minify';\nimport {HtmlPrettyOptions} from '../render/html-pretty';\n\nexport interface RootUserConfig {\n  /**\n   * Canonical domain the website will serve on. Useful for things like the\n   * sitemap, SEO tags, etc.\n   */\n  domain?: string;\n\n  /**\n   * Config for auto-injecting custom element dependencies.\n   */\n  elements?: {\n    /**\n     * A list of directories to use to look for custom elements. The dir path\n     * should be relative to the project dir, e.g. \"path/to/elements\".\n     */\n    include?: string[];\n\n    /**\n     * A list of RegEx patterns to exclude. The string passed to the RegEx is\n     * the file URL relative to the project root, e.g. \"/elements/foo/foo.ts\".\n     */\n    exclude?: RegExp[];\n  };\n\n  /**\n   * Config options for localization and internationalization.\n   */\n  i18n?: RootI18nConfig;\n\n  /**\n   * Config options for the Root.js express server.\n   */\n  server?: RootServerConfig;\n\n  /**\n   * Vite config.\n   * @see {@link https://vitejs.dev/config/} for more information.\n   */\n  vite?: ViteUserConfig;\n\n  /**\n   * Whether to automatically minify HTML output. This is enabled by default,\n   * in order to disable, pass `minifyHtml: false` to root.config.ts.\n   */\n  minifyHtml?: boolean;\n\n  /**\n   * Options to pass to html-minifier-terser.\n   */\n  minifyHtmlOptions?: HtmlMinifyOptions;\n\n  /**\n   * Whether to pretty print HTML output.\n   */\n  prettyHtml?: boolean;\n\n  /**\n   * Options to pass to js-beautify.\n   */\n  prettyHtmlOptions?: HtmlPrettyOptions;\n\n  /**\n   * Whether to include a sitemap.xml file to the build output.\n   */\n  sitemap?: boolean;\n\n  /**\n   * Plugins.\n   */\n  plugins?: Plugin[];\n}\n\nexport type RootConfig = RootUserConfig & {\n  rootDir: string;\n};\n\nexport interface RootI18nConfig {\n  /**\n   * Locales enabled for the site.\n   */\n  locales?: string[];\n\n  /**\n   * The default locale to use. Defaults is `en`.\n   */\n  defaultLocale?: string;\n\n  /**\n   * URL format for localized content. Default is `/{locale}/{path}`.\n   */\n  urlFormat?: string;\n}\n\nexport interface RootServerConfig {\n  /**\n   * An array of middleware to add to the express server. These middleware are\n   * added to the beginning of the express app.\n   */\n  middlewares?: Array<\n    (req: Request, res: Response, next: NextFunction) => void | Promise<void>\n  >;\n}\n\nexport function defineConfig(config: RootUserConfig): RootUserConfig {\n  return config;\n}\n","import {ComponentChildren, FunctionalComponent} from 'preact';\nimport {useContext} from 'preact/hooks';\nimport {HTML_CONTEXT} from './Html';\n\nexport type BodyProps = preact.JSX.HTMLAttributes<HTMLBodyElement> & {\n  children?: ComponentChildren;\n};\n\n/**\n * The `<Body>` component can be used to update attrs in the `<body>` tag.\n *\n * Usage:\n *\n * ```tsx\n * <Body className=\"body\">\n *   <h1>Hello world</h1>\n * </Body>\n * ```\n *\n * Output:\n *\n * ```html\n * <body class=\"body\">\n *   <h1>Hello world</h1>\n * </body>\n */\nexport const Body: FunctionalComponent<BodyProps> = ({children, ...attrs}) => {\n  const context = useContext(HTML_CONTEXT);\n  if (!context) {\n    throw new Error(\n      'HTML_CONTEXT not found, double-check usage of the <Body> component'\n    );\n  }\n  context.bodyAttrs = attrs;\n  return <>{children}</>;\n};\n","import {ComponentChildren, FunctionalComponent} from 'preact';\nimport {useContext} from 'preact/hooks';\nimport {HTML_CONTEXT} from './Html';\n\nexport type HeadProps = preact.JSX.HTMLAttributes<HTMLHeadElement> & {\n  children?: ComponentChildren;\n};\n\n/**\n * The <Head> component can be used for injecting elements into the HTML head\n * tag from any part of a page. The <Head> can be added via any component or\n * sub-component and will automatically be hoisted to the `<head>` element.\n *\n * Usage:\n *\n * ```tsx\n * <Head>\n *   <link rel=\"preconnect\" href=\"https://fonts.googleapis.com\" />\n * </Head>\n * ```\n */\nexport const Head: FunctionalComponent<HeadProps> = ({children, ...attrs}) => {\n  const context = useContext(HTML_CONTEXT);\n  if (!context) {\n    throw new Error(\n      'HTML_CONTEXT not found, double-check usage of the <Head> component'\n    );\n  }\n  context.headComponents.push(children);\n  context.headAttrs = attrs;\n  return null;\n};\n","import {FunctionalComponent} from 'preact';\nimport {useContext} from 'preact/hooks';\nimport {HTML_CONTEXT} from './Html';\n\nexport type ScriptProps = preact.JSX.HTMLAttributes<HTMLScriptElement>;\n\n/**\n * The <Script> component is used for rendering any custom script modules. At\n * the moment, the system only pre-renders and bundles files that are in the\n * `/bundles` folder at the root of the project.\n *\n * Usage:\n *\n * ```tsx\n * <Script src=\"/bundles/main.ts\" />\n * ```\n */\nexport const Script: FunctionalComponent<ScriptProps> = (props) => {\n  const context = useContext(HTML_CONTEXT);\n  if (!context) {\n    throw new Error(\n      'HTML_CONTEXT not found, double-check usage of the <Script> component'\n    );\n  }\n  context.scriptDeps.push(props);\n  return null;\n};\n","import {useI18nContext} from './useI18nContext';\n\n/**\n * A hook that returns a function that can be used to translate a string, and\n * optionally replace any parameterized values that are surrounded in curly\n * braces.\n *\n * Usage:\n *\n * ```ts\n * const t = useTranslations();\n * t('Hello {name}', {name: 'Bob'});\n * // => 'Bounjour Bob'\n */\nexport function useTranslations() {\n  const context = useI18nContext();\n  const translations = context.translations || {};\n  const t = (str: string, params?: Record<string, string>) => {\n    let translation = translations[str] ?? str ?? '';\n    if (params) {\n      for (const key of Object.keys(params)) {\n        const val = String(params[key] ?? '');\n        translation = translation.replaceAll(`{${key}}`, val);\n      }\n    }\n    return translation;\n  };\n  return t;\n}\n"],"mappings":";;;;;;;;;;;;;AA6GO,SAAS,aAAa,QAAwC;AACnE,SAAO;AACT;;;AC9GA,SAAQ,kBAAiB;AAiChB;AARF,IAAM,OAAuC,CAAC,EAAC,aAAa,MAAK,MAAM;AAC5E,QAAM,UAAU,WAAW,YAAY;AACvC,MAAI,CAAC,SAAS;AACZ,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACA,UAAQ,YAAY;AACpB,SAAO;AAAA,IAAG;AAAA,GAAS;AACrB;;;AClCA,SAAQ,cAAAA,mBAAiB;AAoBlB,IAAM,OAAuC,CAAC,EAAC,aAAa,MAAK,MAAM;AAC5E,QAAM,UAAUC,YAAW,YAAY;AACvC,MAAI,CAAC,SAAS;AACZ,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACA,UAAQ,eAAe,KAAK,QAAQ;AACpC,UAAQ,YAAY;AACpB,SAAO;AACT;;;AC9BA,SAAQ,cAAAC,mBAAiB;AAgBlB,IAAM,SAA2C,CAAC,UAAU;AACjE,QAAM,UAAUC,YAAW,YAAY;AACvC,MAAI,CAAC,SAAS;AACZ,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACA,UAAQ,WAAW,KAAK,KAAK;AAC7B,SAAO;AACT;;;ACZO,SAAS,kBAAkB;AAChC,QAAM,UAAU,eAAe;AAC/B,QAAM,eAAe,QAAQ,gBAAgB,CAAC;AAC9C,QAAM,IAAI,CAAC,KAAa,WAAoC;AAC1D,QAAI,cAAc,aAAa,QAAQ,OAAO;AAC9C,QAAI,QAAQ;AACV,iBAAW,OAAO,OAAO,KAAK,MAAM,GAAG;AACrC,cAAM,MAAM,OAAO,OAAO,QAAQ,EAAE;AACpC,sBAAc,YAAY,WAAW,IAAI,QAAQ,GAAG;AAAA,MACtD;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACA,SAAO;AACT;","names":["useContext","useContext","useContext","useContext"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blinkk/root",
-  "version": "1.0.0-beta.11",
+  "version": "1.0.0-beta.13",
   "author": "s@blinkk.com",
   "license": "MIT",
   "engines": {