npm - @blinkk/root - Versions diffs - 3.0.1 → 3.0.3 - Mend

@blinkk/root 3.0.1 → 3.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (117) hide show

package/dist/{chunk-FQBA5QSG.js → chunk-3Z5TNZEP.js} +3 -3
package/dist/chunk-3Z5TNZEP.js.map +7 -0
package/dist/{chunk-JCRXBB26.js → chunk-6NBKAR5Y.js} +2 -2
package/dist/chunk-6NBKAR5Y.js.map +7 -0
package/dist/chunk-6P3B7ZXL.js +1 -1
package/dist/chunk-6P3B7ZXL.js.map +7 -1
package/dist/{chunk-PVBPP5LN.js → chunk-7PSEEE6C.js} +10 -10
package/dist/chunk-7PSEEE6C.js.map +7 -0
package/dist/{chunk-M6WGW5VY.js → chunk-DU7JUEDY.js} +48 -6
package/dist/chunk-DU7JUEDY.js.map +7 -0
package/dist/{chunk-GSR74KEI.js → chunk-JTZWI4MH.js} +279 -73
package/dist/chunk-JTZWI4MH.js.map +7 -0
package/dist/{chunk-WAZTR3DX.js → chunk-KW7KTYGC.js} +2 -2
package/dist/chunk-KW7KTYGC.js.map +7 -0
package/dist/chunk-XSNCF7WU.js +1 -1
package/dist/chunk-XSNCF7WU.js.map +7 -1
package/dist/cli/build.d.ts +7 -0
package/dist/cli/cli.d.ts +12 -0
package/dist/cli/codegen.d.ts +5 -0
package/dist/cli/create-package.d.ts +14 -0
package/dist/cli/dev.d.ts +10 -0
package/dist/cli/gae-deploy.d.ts +18 -0
package/dist/cli/preview.d.ts +8 -0
package/dist/cli/start.d.ts +8 -0
package/dist/cli/startup/check-version.d.ts +17 -0
package/dist/cli/startup/startup-tasks.d.ts +39 -0
package/dist/cli.js +4 -4
package/dist/cli.js.map +7 -1
package/dist/core/components/Body.d.ts +23 -0
package/dist/core/components/Head.d.ts +18 -0
package/dist/core/components/Html.d.ts +24 -0
package/dist/core/components/Script.d.ts +16 -0
package/dist/core/config.d.ts +285 -0
package/dist/core/core.d.ts +14 -0
package/dist/core/hooks/useI18nContext.d.ts +11 -0
package/dist/core/hooks/useRequestContext.d.ts +36 -0
package/dist/core/hooks/useStringParams.d.ts +34 -0
package/dist/core/hooks/useTranslations.d.ts +20 -0
package/dist/core/hooks/useTranslationsMiddleware.d.ts +25 -0
package/dist/core/pages/DevErrorPage.d.ts +9 -0
package/dist/core/pages/DevNotFoundPage.d.ts +10 -0
package/dist/core/pages/ErrorPage.d.ts +9 -0
package/dist/core/plugin.d.ts +80 -0
package/dist/core/pod.d.ts +54 -0
package/dist/core/types.d.ts +228 -0
package/dist/core.js +3 -3
package/dist/core.js.map +7 -1
package/dist/functions/functions.d.ts +1 -0
package/dist/functions/server.d.ts +10 -0
package/dist/functions.js +5 -5
package/dist/functions.js.map +7 -1
package/dist/jsx/jsx-dev-runtime.d.ts +10 -1
package/dist/jsx/jsx-dev-runtime.js +2 -2
package/dist/jsx/jsx-dev-runtime.js.map +7 -1
package/dist/{jsx-C8BaDh-4.d.ts → jsx/jsx-render.d.ts} +3 -6
package/dist/jsx/jsx-runtime.d.ts +120 -1
package/dist/jsx/jsx-runtime.js +2 -2
package/dist/jsx/jsx-runtime.js.map +7 -1
package/dist/jsx/jsx.d.ts +37 -0
package/dist/{jsx-dev-runtime-DUJrvx5P.d.ts → jsx/types.d.ts} +9 -125
package/dist/jsx.js +3 -3
package/dist/jsx.js.map +7 -1
package/dist/middleware/common.d.ts +22 -0
package/dist/middleware/hooks.d.ts +8 -0
package/dist/middleware/middleware.d.ts +3 -0
package/dist/middleware/multipart.d.ts +11 -0
package/dist/middleware/redirects.d.ts +10 -0
package/dist/middleware/session.d.ts +24 -0
package/dist/middleware.js +2 -2
package/dist/middleware.js.map +7 -1
package/dist/node/element-graph.d.ts +51 -0
package/dist/node/load-config.d.ts +17 -0
package/dist/node/monorepo.d.ts +14 -0
package/dist/node/node.d.ts +4 -0
package/dist/node/pod-collector.d.ts +33 -0
package/dist/node/pods-vite-plugin.d.ts +6 -0
package/dist/node/vite-plugin-preact-alias.d.ts +10 -0
package/dist/node/vite-plugin-prune-empty-chunks.d.ts +27 -0
package/dist/node/vite-plugin-root-jsx-virtual.d.ts +16 -0
package/dist/node/vite.d.ts +18 -0
package/dist/node.js +2 -2
package/dist/node.js.map +7 -1
package/dist/render/accept-language.d.ts +8 -0
package/dist/render/asset-map/asset-map.d.ts +25 -0
package/dist/render/asset-map/build-asset-map.d.ts +47 -0
package/dist/render/asset-map/dev-asset-map.d.ts +26 -0
package/dist/render/countrie-language.d.ts +13 -0
package/dist/render/html-minify.d.ts +3 -0
package/dist/render/html-pretty.d.ts +3 -0
package/dist/render/i18n-fallbacks.d.ts +11 -0
package/dist/render/render.d.ts +91 -0
package/dist/render/route-trie.d.ts +44 -0
package/dist/render/router.d.ts +18 -0
package/dist/render.js +9 -9
package/dist/render.js.map +7 -1
package/dist/utils/batch.d.ts +1 -0
package/dist/utils/elements.d.ts +12 -0
package/dist/utils/fsutils.d.ts +24 -0
package/dist/utils/i18n.d.ts +8 -0
package/dist/utils/ports.d.ts +8 -0
package/dist/utils/rand.d.ts +10 -0
package/dist/utils/url-path-params.d.ts +2 -0
package/package.json +14 -15
package/dist/chunk-FQBA5QSG.js.map +0 -1
package/dist/chunk-GSR74KEI.js.map +0 -1
package/dist/chunk-JCRXBB26.js.map +0 -1
package/dist/chunk-M6WGW5VY.js.map +0 -1
package/dist/chunk-PVBPP5LN.js.map +0 -1
package/dist/chunk-WAZTR3DX.js.map +0 -1
package/dist/cli.d.ts +0 -60
package/dist/core.d.ts +0 -214
package/dist/functions.d.ts +0 -14
package/dist/jsx.d.ts +0 -2
package/dist/middleware.d.ts +0 -43
package/dist/node.d.ts +0 -91
package/dist/render.d.ts +0 -8
package/dist/types-Cksf99CK.d.ts +0 -827

package/dist/cli/startup/startup-tasks.d.ts ADDED Viewed

@@ -0,0 +1,39 @@
+export interface StartupTaskContext {
+    /** Absolute path to the root project directory. */
+    rootDir: string;
+    /** Currently installed version of the `@blinkk/root` package. */
+    version?: string;
+}
+export interface StartupTask {
+    /**
+     * Unique id for the task. Used as the persistence key for the last run time,
+     * so it must remain stable across releases.
+     */
+    name: string;
+    /**
+     * Minimum time (in milliseconds) that must elapse between runs. When set, the
+     * task is skipped if it last ran more recently than this interval. Omit to
+     * run on every startup.
+     */
+    throttle?: number;
+    /**
+     * Optional predicate evaluated before the throttle check. When it returns
+     * false the task is skipped entirely (and its throttle is left untouched).
+     * Useful for opt-out flags, e.g. an env var that disables the task.
+     */
+    enabled?: (ctx: StartupTaskContext) => boolean;
+    /**
+     * Task logic. Thrown errors are swallowed by the runner so that a failing
+     * startup task never prevents `root` commands from starting.
+     */
+    run: (ctx: StartupTaskContext) => Promise<void>;
+}
+/**
+ * Runs all registered startup tasks, honoring each task's throttle interval.
+ *
+ * Tasks are best-effort: failures are swallowed and never block startup. The
+ * last run time of each task is persisted to the user's home directory so that
+ * throttled tasks (e.g. the version check) run at most once per interval across
+ * separate `root` invocations.
+ */
+export declare function runStartupTasks(ctx: StartupTaskContext): Promise<void>;

package/dist/cli.js CHANGED Viewed

@@ -8,10 +8,10 @@ import {
   dev,
   preview,
   start
-} from "./chunk-GSR74KEI.js";
+} from "./chunk-JTZWI4MH.js";
 import "./chunk-6P3B7ZXL.js";
-import "./chunk-JCRXBB26.js";
-import "./chunk-PVBPP5LN.js";
+import "./chunk-6NBKAR5Y.js";
+import "./chunk-7PSEEE6C.js";
 import "./chunk-XSNCF7WU.js";
 export {
   CliRunner,
@@ -24,4 +24,4 @@ export {
   preview,
   start
 };
-//# sourceMappingURL=cli.js.map
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map CHANGED Viewed

@@ -1 +1,7 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}

package/dist/core/components/Body.d.ts ADDED Viewed

@@ -0,0 +1,23 @@
+import { ComponentChildren, FunctionalComponent } from 'preact';
+export type BodyProps = preact.JSX.HTMLAttributes<HTMLBodyElement> & {
+    children?: ComponentChildren;
+};
+/**
+ * The `<Body>` component can be used to update attrs in the `<body>` tag.
+ *
+ * Usage:
+ *
+ * ```tsx
+ * <Body className="body">
+ *   <h1>Hello world</h1>
+ * </Body>
+ * ```
+ *
+ * Output:
+ *
+ * ```html
+ * <body class="body">
+ *   <h1>Hello world</h1>
+ * </body>
+ */
+export declare const Body: FunctionalComponent<BodyProps>;

package/dist/core/components/Head.d.ts ADDED Viewed

@@ -0,0 +1,18 @@
+import { ComponentChildren, FunctionalComponent } from 'preact';
+export type HeadProps = preact.JSX.HTMLAttributes<HTMLHeadElement> & {
+    children?: ComponentChildren;
+};
+/**
+ * The <Head> component can be used for injecting elements into the HTML head
+ * tag from any part of a page. The <Head> can be added via any component or
+ * sub-component and will automatically be hoisted to the `<head>` element.
+ *
+ * Usage:
+ *
+ * ```tsx
+ * <Head>
+ *   <link rel="preconnect" href="https://fonts.googleapis.com" />
+ * </Head>
+ * ```
+ */
+export declare const Head: FunctionalComponent<HeadProps>;

package/dist/core/components/Html.d.ts ADDED Viewed

@@ -0,0 +1,24 @@
+import { ComponentChildren, FunctionalComponent } from 'preact';
+export interface HtmlContext {
+    htmlAttrs: preact.JSX.HTMLAttributes<HTMLHtmlElement>;
+    headAttrs: preact.JSX.HTMLAttributes<HTMLHeadElement>;
+    headComponents: ComponentChildren[];
+    bodyAttrs: preact.JSX.HTMLAttributes<HTMLBodyElement>;
+    scriptDeps: Array<preact.JSX.ScriptHTMLAttributes<HTMLScriptElement>>;
+}
+export declare const HTML_CONTEXT: import("preact").Context<HtmlContext | null>;
+export type HtmlProps = preact.JSX.HTMLAttributes<HTMLHtmlElement> & {
+    children?: ComponentChildren;
+};
+/**
+ * The `<Html>` component can be used to update attrs in the `<html>` tag.
+ *
+ * Usage:
+ *
+ * ```tsx
+ * <Html lang="en-US">
+ *   <h1>Hello world</h1>
+ * </Html>
+ * ```
+ */
+export declare const Html: FunctionalComponent<HtmlProps>;

package/dist/core/components/Script.d.ts ADDED Viewed

@@ -0,0 +1,16 @@
+import { FunctionalComponent } from 'preact';
+export type ScriptProps = preact.JSX.HTMLAttributes<HTMLScriptElement> & {
+    src?: string;
+};
+/**
+ * The <Script> component is used for rendering any custom script modules. At
+ * the moment, the system only pre-renders and bundles files that are in the
+ * `/bundles` folder at the root of the project.
+ *
+ * Usage:
+ *
+ * ```tsx
+ * <Script src="/bundles/main.ts" />
+ * ```
+ */
+export declare const Script: FunctionalComponent<ScriptProps>;

package/dist/core/config.d.ts ADDED Viewed

@@ -0,0 +1,285 @@
+import { UserConfig as ViteUserConfig } from 'vite';
+import { JsxRenderOptions } from '../jsx/jsx-render.js';
+import { HtmlMinifyOptions } from '../render/html-minify.js';
+import { HtmlPrettyOptions } from '../render/html-pretty.js';
+import { Plugin } from './plugin.js';
+import { PodConfig } from './pod.js';
+import { RequestMiddleware } from './types.js';
+export interface RootUserConfig {
+    /**
+     * Canonical domain the website will serve on. Useful for things like the
+     * sitemap, SEO tags, etc.
+     */
+    domain?: string;
+    /**
+     * The base URL path that the site will serve on. Defaults to `/`;
+     */
+    base?: string;
+    /**
+     * Config for auto-injecting custom element dependencies.
+     */
+    elements?: {
+        /**
+         * A list of directories to use to look for custom elements. The dir path
+         * should be relative to the project dir, e.g. "path/to/elements".
+         */
+        include?: string[];
+        /**
+         * A list of RegEx patterns to exclude. The string passed to the RegEx is
+         * the file URL relative to the project root, e.g. "/elements/foo/foo.ts".
+         */
+        exclude?: RegExp[];
+    };
+    /**
+     * Config for manually injecting stylesheet entries as
+     * `<link rel="stylesheet">` tags.
+     */
+    styles?: {
+        /**
+         * Project-root-relative stylesheet files to include on every rendered
+         * page, e.g. `styles/index.css`.
+         *
+         * Entries are normalized as URL paths, so both `styles/index.css` and
+         * `/styles/index.css` resolve to `/styles/index.css`.
+         *
+         * Manual entries are injected first, then auto-collected CSS
+         * dependencies are merged after. Duplicate URLs are de-duped so each
+         * stylesheet is only injected once.
+         */
+        entries?: string[];
+    };
+    /**
+     * Config options for localization and internationalization.
+     */
+    i18n?: RootI18nConfig;
+    /**
+     * Config options for the Root.js express server.
+     */
+    server?: RootServerConfig;
+    /**
+     * Build options for the `root build` command.
+     */
+    build?: RootBuildConfig;
+    /**
+     * Vite config.
+     * @see {@link https://vitejs.dev/config/} for more information.
+     */
+    vite?: ViteUserConfig;
+    /**
+     * Config for the built-in JSX-to-HTML renderer.
+     *
+     * - `mode: 'pretty'` (default) — block-level elements render on their own
+     *   line with no indentation.
+     * - `mode: 'minimal'` — compact output with no extra whitespace.
+     *
+     * Use `blockElements` to specify additional custom element tag names that
+     * should be treated as block-level in pretty mode.
+     *
+     * @example
+     * ```ts
+     * export default defineConfig({
+     *   jsxRenderer: {
+     *     mode: 'pretty',
+     *     blockElements: ['my-card', 'my-section'],
+     *   },
+     * });
+     * ```
+     */
+    jsxRenderer?: JsxRenderOptions;
+    /**
+     * Whether to automatically minify HTML output. This is enabled by default,
+     * in order to disable, pass `minifyHtml: false` to root.config.ts.
+     */
+    minifyHtml?: boolean;
+    /**
+     * Options to pass to html-minifier-terser.
+     */
+    minifyHtmlOptions?: HtmlMinifyOptions;
+    /**
+     * Whether to pretty print HTML output.
+     */
+    prettyHtml?: boolean;
+    /**
+     * Options to pass to js-beautify.
+     */
+    prettyHtmlOptions?: HtmlPrettyOptions;
+    /**
+     * Whether to include a sitemap.xml file to the build output.
+     */
+    sitemap?: boolean;
+    /**
+     * Plugins.
+     */
+    plugins?: Plugin[];
+    /**
+     * Per-pod user-level overrides. The key is the pod name as declared in
+     * Pod.name.
+     */
+    pods?: Record<string, PodConfig>;
+    /**
+     * Experimental config options. Note: these are subject to change at any time.
+     */
+    experiments?: {
+        /** Whether to render `<script>` tags with `async`. */
+        enableScriptAsync?: boolean;
+    };
+}
+export type RootConfig = RootUserConfig & {
+    rootDir: string;
+};
+export interface LocaleGroup {
+    label?: string;
+    locales: string[];
+}
+export interface RootI18nConfig {
+    /**
+     * Locales enabled for the site.
+     */
+    locales?: string[];
+    /**
+     * The default locale to use. Defaults is `en`.
+     */
+    defaultLocale?: string;
+    /**
+     * URL format for localized content. Default is `/[locale]/[base]/[path]`.
+     */
+    urlFormat?: string;
+    /**
+     * Localization groups, to help UIs (like Root.js CMS) logically group
+     * locales.
+     */
+    groups?: Record<string, LocaleGroup>;
+}
+export interface RootBuildConfig {
+    /**
+     * Excludes the `/intl/{defaultLocale}/...` path from the SSG build.
+     */
+    excludeDefaultLocaleFromIntlPaths?: boolean;
+}
+export interface RootRedirectConfig {
+    /**
+     * The source path to redirect. Accepts placeholders in the format
+     * `[key]` or `[...key]`. Use `[key]` for single segments and
+     * `[...key]` for multi-segment wildcards.
+     * @example "/old-path/[id]" or "/old-path/[...wildcard]"
+     */
+    source: string;
+    /**
+     * The destination to redirect to. Placeholders from the source can
+     * optionally be inserted into the destination using the same
+     * placeholder format.
+     * @example "/new-path/[id]" or "/new-path/[...wildcard]"
+     */
+    destination: string;
+    /**
+     * The redirect type (`301` = permanent, `302` = temporary). If unspecified,
+     * defaults to `302` (temporary).
+     */
+    type?: 301 | 302;
+}
+export interface RootHeaderConfig {
+    /** A glob pattern match (regex not supported yet). */
+    source: string;
+    headers: Array<{
+        key: string;
+        value: string;
+    }>;
+}
+export interface ContentSecurityPolicyConfig {
+    directives?: Record<string, string[]>;
+    reportOnly?: boolean;
+}
+export interface XFrameOptionsConfig {
+    action: 'DENY' | 'SAMEORIGIN';
+}
+export interface RootSecurityConfig {
+    /**
+     * Content-Security-Policy config. If enabled, a nonce is auto-generated
+     * for every request and appended to script and stylesheet tags. You can
+     * validate your CSP headers using a tool like {@link https://csp-evaluator.withgoogle.com/}.
+     *
+     * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP}
+     */
+    contentSecurityPolicy?: ContentSecurityPolicyConfig | boolean;
+    /**
+     * Strict-Transport-Security config. When enabled, the header value is set
+     * to `Strict-Transport-Security: max-age=63072000; includeSubDomains; preload`.
+     */
+    strictTransportSecurity?: boolean;
+    /**
+     * X-Content-Type-Options config. When enabled, the header value is set to
+     * `X-Content-Type-Options: nosniff`.
+     */
+    xContentTypeOptions?: boolean;
+    /**
+     * X-Frame-Options config. Setting this value to `true` will default the
+     * header value to `X-Frame-Options: SAMEORIGIN`.
+     *
+     * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options}
+     */
+    xFrameOptions?: 'DENY' | 'SAMEORIGIN' | boolean;
+    /**
+     * X-XSS-Protection config. When enabled, the header value is set to
+     * `X-XSS-Protection: 1; mode=block`.
+     */
+    xXssProtection?: boolean;
+}
+export interface RootServerConfig {
+    /**
+     * An array of middleware to add to the express server. These middleware are
+     * added to the beginning of the express app.
+     */
+    middlewares?: RequestMiddleware[];
+    /**
+     * The `trailingSlash` config allows you to control how the server handles
+     * trailing slashes. This config only affects URLs that do not have a file
+     * extension (i.e. HTML paths).
+     *
+     * - When `true`, the server redirects URLs to add a trailing slash
+     * - When `false`, the server redirects URLs to remove a trailing slash
+     * - When unspecified, the server allows URLs with and without trailing slash
+     */
+    trailingSlash?: boolean;
+    /**
+     * Cookie secret for the session middleware.
+     *
+     * Generate a secure secret with:
+     * ```
+     * node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"
+     * ```
+     */
+    sessionCookieSecret?: string | string[];
+    /**
+     * List of redirects. Supports optional wildcards.
+     *
+     * @example
+     * ```ts
+     * redirects: [
+     *   {
+     *     source: '/old-path/[id]',
+     *     destination: '/new-path/[id]',
+     *     type: 301,
+     *   },
+     *   {
+     *     source: '/old-path/[...wildcard]',
+     *     destination: '/new-path/[...wildcard]',
+     *   },
+     * ]
+     * ```
+     */
+    redirects?: RootRedirectConfig[];
+    /**
+     * HTTP headers to add to a response.
+     */
+    headers?: RootHeaderConfig[];
+    /**
+     * HTTP security settings. By default, all security settings are enabled with
+     * commonly used default values.
+     */
+    security?: RootSecurityConfig;
+    /**
+     * Home page URL path, which is printed when the dev server starts.
+     */
+    homePagePath?: string;
+}
+export declare function defineConfig(config: RootUserConfig): RootUserConfig;

package/dist/core/core.d.ts ADDED Viewed

@@ -0,0 +1,14 @@
+export * from './config.js';
+export { Body } from './components/Body.js';
+export { Head } from './components/Head.js';
+export { Html, HTML_CONTEXT } from './components/Html.js';
+export { Script } from './components/Script.js';
+export { StringParamsContext, StringParamsProvider, useStringParams, } from './hooks/useStringParams.js';
+export { TranslationMiddlewareProvider, useTranslationMiddleware, } from './hooks/useTranslationsMiddleware.js';
+export { I18nContext, useI18nContext, getTranslations, } from './hooks/useI18nContext.js';
+export { RequestContext, useRequestContext } from './hooks/useRequestContext.js';
+export { useTranslations } from './hooks/useTranslations.js';
+export * from './pod.js';
+export * from './plugin.js';
+export * from './types.js';
+export * from '../utils/url-path-params.js';

package/dist/core/hooks/useI18nContext.d.ts ADDED Viewed

@@ -0,0 +1,11 @@
+export declare const I18N_CONTEXT: import("preact").Context<I18nContext | null>;
+export interface I18nContext {
+    locale: string;
+    translations: Record<string, string>;
+}
+/**
+ * A hook that returns information about the current i18n context, including the
+ * locale for the given route and a map of translations for that locale.
+ */
+export declare function useI18nContext(): I18nContext;
+export declare function getTranslations(locale: string): Record<string, string>;

package/dist/core/hooks/useRequestContext.d.ts ADDED Viewed

@@ -0,0 +1,36 @@
+import { Route } from '../types.js';
+export interface RequestContext {
+    /**
+     * The current request path, e.g. `/foo/bar` (default route path) or
+     * `/{locale}/foo/bar` (localized route path).
+     */
+    currentPath: string;
+    /** The route file. */
+    route: Route;
+    /**
+     * Route param values. E.g. for a route like `routes/blog/[slug].tsx`,
+     * visiting `/blog/foo` will pass {slug: 'foo'} here.
+     */
+    routeParams: Record<string, string>;
+    /** Props passed to the route's server component. */
+    props: any;
+    /** The current locale. */
+    locale: string;
+    /** Translations map for the current locale. */
+    translations: Record<string, string>;
+    /** CSP nonce value. */
+    nonce?: string;
+}
+export declare const REQUEST_CONTEXT: import("preact").Context<RequestContext | null>;
+/**
+ * A hook that returns information about the current route.
+ *
+ * Usage:
+ *
+ * ```ts
+ * const ctx = useRequestContext();
+ * ctx.route.src;
+ * // => 'routes/index.tsx'
+ * ```
+ */
+export declare function useRequestContext(): RequestContext;

package/dist/core/hooks/useStringParams.d.ts ADDED Viewed

@@ -0,0 +1,34 @@
+import { ComponentChildren, FunctionalComponent } from 'preact';
+export type StringParamsContext = Record<string, string>;
+export declare const STRING_PARAMS_CONTEXT: import("preact").Context<StringParamsContext | null>;
+export interface StringParamsProviderProps {
+    value?: StringParamsContext;
+    children?: ComponentChildren;
+}
+export declare const StringParamsProvider: FunctionalComponent<StringParamsProviderProps>;
+/**
+ * A hook that returns a map of string params, configured via the
+ * `StringParamsProvider` context provider. These params are automatically
+ * applied to the `useTranslations()` hook.
+ *
+ *
+ * Usage:
+ *
+ * ```
+ * export default function Page() {
+ *   return (
+ *     <StringParamsProvider value={{name: 'Alice'}}>
+ *       <SayHello />
+ *     </StringParamsProvider>
+ *   );
+ * }
+ *
+ * function SayHello() {
+ *   const t = useTranslations();
+ *   return <h1>{t('Hello, {name}!')}</h1>;
+ * }
+ * ```
+ *
+ * This should render `<h1>Hello, Alice!</h1>`.
+ */
+export declare function useStringParams(): StringParamsContext;

package/dist/core/hooks/useTranslations.d.ts ADDED Viewed

@@ -0,0 +1,20 @@
+/**
+ * A hook that returns a function that can be used to translate a string, and
+ * optionally replace any parameterized values that are surrounded in curly
+ * braces.
+ *
+ * Usage:
+ *
+ * ```ts
+ * const t = useTranslations();
+ * t('Hello {name}', {name: 'Bob'});
+ * // => 'Bounjour Bob'
+ * ```
+ */
+export declare function useTranslations(): (str: string, params?: Record<string, string | number>) => string;
+/**
+ * Cleans a string that's used for translations. Performs the following:
+ * - Removes any leading/trailing whitespace
+ * - Removes spaces at the end of any line
+ */
+export declare function normalizeString(str: string): string;

package/dist/core/hooks/useTranslationsMiddleware.d.ts ADDED Viewed

@@ -0,0 +1,25 @@
+import { ComponentChildren, FunctionalComponent } from 'preact';
+type TransformFn = (str: string) => string;
+export interface TranslationMiddleware {
+    /** Transform the string before translation lookup. */
+    beforeTranslate?: TransformFn;
+    /** Transform the string after translation lookup. */
+    afterTranslate?: TransformFn;
+    /** Transform the string before `{param}` values are replaced. */
+    beforeReplaceParams?: TransformFn;
+    /** Transform the string after `{param}` values are replaced. */
+    afterReplaceParams?: TransformFn;
+}
+export interface TranslationMiddlewareContext {
+    beforeTranslateFns: TransformFn[];
+    afterTranslateFns: TransformFn[];
+    beforeReplaceParamsFns: TransformFn[];
+    afterReplaceParamsFns: TransformFn[];
+}
+export interface TranslationMiddlewareProviderProps {
+    value?: TranslationMiddleware;
+    children?: ComponentChildren;
+}
+export declare const TranslationMiddlewareProvider: FunctionalComponent<TranslationMiddlewareProviderProps>;
+export declare function useTranslationMiddleware(): TranslationMiddlewareContext;
+export {};

package/dist/core/pages/DevErrorPage.d.ts ADDED Viewed

@@ -0,0 +1,9 @@
+import { Request, Route, RouteParams } from '../types.js';
+interface DevErrorPageProps {
+    req: Request;
+    route?: Route;
+    routeParams?: RouteParams;
+    error: any;
+}
+export declare function DevErrorPage(props: DevErrorPageProps): import("preact").JSX.Element;
+export {};

package/dist/core/pages/DevNotFoundPage.d.ts ADDED Viewed

@@ -0,0 +1,10 @@
+import { Request, Route } from '../types.js';
+interface DevNotFoundPageProps {
+    req: Request;
+    sitemap: Record<string, {
+        route: Route;
+        params: Record<string, string>;
+    }>;
+}
+export declare function DevNotFoundPage(props: DevNotFoundPageProps): import("preact").JSX.Element;
+export {};

package/dist/core/pages/ErrorPage.d.ts ADDED Viewed

@@ -0,0 +1,9 @@
+import { ComponentChildren } from 'preact';
+export interface ErrorPageProps {
+    code: number;
+    title?: string;
+    message?: string;
+    children?: ComponentChildren;
+    align?: 'center';
+}
+export declare function ErrorPage(props: ErrorPageProps): import("preact").JSX.Element;