npm - @json-render/next - Versions diffs - 0.15.0 - Mend

@json-render/next 0.15.0

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 (25) hide show

package/LICENSE +201 -0
package/README.md +103 -0
package/dist/chunk-37T7IDU5.js +104 -0
package/dist/chunk-37T7IDU5.js.map +1 -0
package/dist/chunk-KWYBSJZC.mjs +104 -0
package/dist/chunk-KWYBSJZC.mjs.map +1 -0
package/dist/index.d.mts +314 -0
package/dist/index.d.ts +314 -0
package/dist/index.js +135 -0
package/dist/index.js.map +1 -0
package/dist/index.mjs +135 -0
package/dist/index.mjs.map +1 -0
package/dist/page-renderer-client.d.mts +25 -0
package/dist/page-renderer-client.d.ts +25 -0
package/dist/page-renderer-client.js +9 -0
package/dist/page-renderer-client.js.map +1 -0
package/dist/page-renderer-client.mjs +9 -0
package/dist/page-renderer-client.mjs.map +1 -0
package/dist/server.d.mts +358 -0
package/dist/server.d.ts +358 -0
package/dist/server.js +538 -0
package/dist/server.js.map +1 -0
package/dist/server.mjs +506 -0
package/dist/server.mjs.map +1 -0
package/package.json +71 -0

package/dist/index.d.mts ADDED Viewed

@@ -0,0 +1,314 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React, { ReactNode } from 'react';
+import { ComponentRegistry, ComponentRenderProps } from '@json-render/react';
+export { ActionFn, Actions, BaseComponentProps, ComponentContext, ComponentFn, ComponentRegistry, ComponentRenderProps, Components, EventHandle, SetState, StateModel } from '@json-render/react';
+export { PageRenderer, PageRendererProps } from './page-renderer-client.mjs';
+import { Spec } from '@json-render/core';
+export { Spec, StateStore, createStateStore } from '@json-render/core';
+/**
+ * Context value holding the component registry, action handlers,
+ * and the Next.js router navigate function.
+ */
+interface NextAppContextValue {
+    registry: ComponentRegistry;
+    handlers?: Record<string, (params: Record<string, unknown>) => Promise<unknown> | unknown>;
+    navigate: (href: string) => void;
+}
+/**
+ * Props for NextAppProvider.
+ */
+interface NextAppProviderProps {
+    /** Component registry for rendering */
+    registry: ComponentRegistry;
+    /** Action handlers */
+    handlers?: Record<string, (params: Record<string, unknown>) => Promise<unknown> | unknown>;
+    children: ReactNode;
+}
+/**
+ * Provider that holds the component registry and action handlers
+ * for the entire json-render Next.js application.
+ *
+ * Wrap your root layout with this provider:
+ *
+ * ```tsx
+ * // app/[[...slug]]/layout.tsx
+ * import { NextAppProvider } from "@json-render/next";
+ * import { registry, handlers } from "@/lib/registry";
+ *
+ * export default function Layout({ children }) {
+ *   return (
+ *     <html><body>
+ *       <NextAppProvider registry={registry} handlers={handlers}>
+ *         {children}
+ *       </NextAppProvider>
+ *     </body></html>
+ *   );
+ * }
+ * ```
+ */
+declare function NextAppProvider({ registry, handlers, children, }: NextAppProviderProps): react_jsx_runtime.JSX.Element;
+/**
+ * Hook to access the NextApp context.
+ * Must be used within a NextAppProvider.
+ */
+declare function useNextApp(): NextAppContextValue;
+/**
+ * Props for NextErrorBoundary.
+ */
+interface NextErrorBoundaryProps {
+    /** The error that occurred */
+    error: Error & {
+        digest?: string;
+    };
+    /** Function to attempt re-rendering the page */
+    reset: () => void;
+    /** Optional error UI spec from the matched route */
+    errorSpec?: Spec | null;
+}
+/**
+ * Error boundary component for json-render Next.js apps.
+ *
+ * If the matched route defines an `error` spec, it renders that.
+ * Otherwise renders a minimal default error UI.
+ *
+ * Must be used in a file with `"use client"` directive (Next.js requirement).
+ */
+declare function NextErrorBoundary({ error, reset, errorSpec, }: NextErrorBoundaryProps): react_jsx_runtime.JSX.Element;
+/**
+ * Props for NextLoading.
+ */
+interface NextLoadingProps {
+    /** Optional loading UI spec */
+    loadingSpec?: Spec | null;
+}
+/**
+ * Loading component for json-render Next.js apps.
+ *
+ * If a loading spec is provided, it will be rendered by the PageRenderer.
+ * Otherwise renders a minimal default loading indicator.
+ *
+ * Note: Since Next.js loading.tsx is static (no params), this renders
+ * a generic loading state. Route-specific loading can be achieved with
+ * Suspense boundaries in page content.
+ */
+declare function NextLoading({ loadingSpec: _loadingSpec }: NextLoadingProps): react_jsx_runtime.JSX.Element;
+/**
+ * Not-found component for json-render Next.js apps.
+ *
+ * Renders when the pathname does not match any route in the spec.
+ */
+declare function NextNotFound(): react_jsx_runtime.JSX.Element;
+/**
+ * Props expected by the Link component in json-render specs.
+ */
+interface LinkProps {
+    /** The target URL or route path */
+    href: string;
+    /** Whether to replace the current history entry */
+    replace?: boolean;
+    /** Whether to prefetch the linked route */
+    prefetch?: boolean;
+    /** CSS class name */
+    className?: string;
+    /** Inline styles */
+    style?: React.CSSProperties;
+}
+/**
+ * Built-in Link component for json-render Next.js specs.
+ *
+ * Wraps `next/link` for client-side navigation between routes.
+ *
+ * Usage in a spec:
+ * ```json
+ * {
+ *   "type": "Link",
+ *   "props": { "href": "/about" },
+ *   "children": ["link-text"]
+ * }
+ * ```
+ */
+declare function Link({ element, children }: ComponentRenderProps<LinkProps>): react_jsx_runtime.JSX.Element;
+/**
+ * Metadata for Next.js pages and layouts.
+ * Maps to Next.js's Metadata type.
+ */
+interface NextMetadata {
+    /** Page title — string or template config */
+    title?: string | {
+        /** Default title when no child overrides */
+        default: string;
+        /** Template string, use %s for the page title (e.g. "%s | My App") */
+        template?: string;
+        /** Absolute title that ignores parent templates */
+        absolute?: string;
+    };
+    /** Meta description */
+    description?: string;
+    /** Keywords for SEO */
+    keywords?: string[];
+    /** Open Graph metadata */
+    openGraph?: {
+        title?: string;
+        description?: string;
+        images?: string | string[];
+        type?: string;
+        url?: string;
+        siteName?: string;
+        locale?: string;
+    };
+    /** Twitter card metadata */
+    twitter?: {
+        card?: "summary" | "summary_large_image" | "app" | "player";
+        title?: string;
+        description?: string;
+        images?: string | string[];
+        creator?: string;
+        site?: string;
+    };
+    /** Robots directives */
+    robots?: string | {
+        index?: boolean;
+        follow?: boolean;
+    };
+    /** Canonical URL */
+    alternates?: {
+        canonical?: string;
+    };
+    /** Favicon and icons */
+    icons?: string | {
+        icon?: string;
+        apple?: string;
+        shortcut?: string;
+    };
+}
+/**
+ * A route definition within a NextAppSpec.
+ */
+interface NextRouteSpec {
+    /** Page content — standard json-render element tree */
+    page: Spec;
+    /** Per-route metadata for SEO */
+    metadata?: NextMetadata;
+    /** Layout key referencing an entry in NextAppSpec.layouts */
+    layout?: string;
+    /** Loading state element tree (rendered during Suspense) */
+    loading?: Spec;
+    /** Error state element tree */
+    error?: Spec;
+    /** Not-found element tree (for dynamic routes that don't match data) */
+    notFound?: Spec;
+    /** Server-side data loader name (references loaders in createNextApp) */
+    loader?: string;
+    /** Static params for generateStaticParams */
+    staticParams?: Record<string, string>[];
+}
+/**
+ * The full application spec for @json-render/next.
+ *
+ * Describes an entire Next.js application: routes, pages, layouts,
+ * metadata, and server-side data loading.
+ *
+ * Routes are keyed by URL patterns using Next.js conventions:
+ * - `"/"` — exact match
+ * - `"/blog/[slug]"` — dynamic segment
+ * - `"/docs/[...path]"` — catch-all segment
+ * - `"/settings/[[...path]]"` — optional catch-all segment
+ */
+interface NextAppSpec {
+    /** Root-level metadata applied to all routes (layouts can override) */
+    metadata?: NextMetadata;
+    /** Route definitions keyed by URL pattern */
+    routes: Record<string, NextRouteSpec>;
+    /**
+     * Reusable layout element trees. Each layout spec must include a
+     * `Slot` component type where page content will be injected.
+     */
+    layouts?: Record<string, Spec>;
+    /** Global initial state shared across all routes */
+    state?: Record<string, unknown>;
+}
+/**
+ * Result of matching a pathname against the spec's routes.
+ */
+interface MatchedRoute {
+    /** The matched route spec */
+    route: NextRouteSpec;
+    /** The URL pattern that matched (e.g. "/blog/[slug]") */
+    pattern: string;
+    /** Extracted route parameters (e.g. { slug: "hello-world" }) */
+    params: Record<string, string | string[]>;
+}
+/**
+ * Server-side data loader function signature.
+ * Receives route params and returns data to merge into initial state.
+ */
+type LoaderFn = (params: Record<string, string | string[]>) => Promise<Record<string, unknown>> | Record<string, unknown>;
+/**
+ * Options for createNextApp.
+ */
+interface CreateNextAppOptions {
+    /** The application spec */
+    spec: NextAppSpec | (() => NextAppSpec | Promise<NextAppSpec>);
+    /** Server-side data loaders keyed by name */
+    loaders?: Record<string, LoaderFn>;
+}
+/**
+ * Data returned by getPageData for client-side rendering.
+ */
+interface PageData {
+    /** Page element tree spec */
+    spec: Spec;
+    /** Initial state (merged from spec.state, global state, and loader data) */
+    initialState?: Record<string, unknown>;
+    /** Optional layout element tree spec */
+    layoutSpec?: Spec | null;
+}
+/**
+ * The result of createNextApp — exports for Next.js route files.
+ */
+interface NextAppExports {
+    /**
+     * Resolve page data for a given set of params.
+     * Returns null if no route matches (caller should call notFound()).
+     *
+     * Use this in your Server Component page.tsx alongside a client wrapper
+     * that renders PageRenderer:
+     *
+     * ```tsx
+     * // app/[[...slug]]/page.tsx
+     * import { getPageData, generateMetadata, generateStaticParams } from "@/lib/app";
+     * import { WebsiteRenderer } from "./renderer";
+     *
+     * export { generateMetadata, generateStaticParams };
+     *
+     * export default async function Page({ params }) {
+     *   const data = await getPageData({ params });
+     *   if (!data) notFound();
+     *   return <WebsiteRenderer {...data} />;
+     * }
+     * ```
+     */
+    getPageData: (props: {
+        params: Promise<{
+            slug?: string[];
+        }>;
+    }) => Promise<PageData | null>;
+    /** generateMetadata function for page.tsx */
+    generateMetadata: (props: {
+        params: Promise<{
+            slug?: string[];
+        }>;
+    }) => Promise<Record<string, unknown>>;
+    /** generateStaticParams function for page.tsx */
+    generateStaticParams: () => Promise<{
+        slug: string[];
+    }[]>;
+}
+export { type CreateNextAppOptions, Link, type LinkProps, type LoaderFn, type MatchedRoute, type NextAppContextValue, type NextAppExports, NextAppProvider, type NextAppProviderProps, type NextAppSpec, NextErrorBoundary, type NextErrorBoundaryProps, NextLoading, type NextLoadingProps, type NextMetadata, NextNotFound, type NextRouteSpec, type PageData, useNextApp };

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,314 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React, { ReactNode } from 'react';
+import { ComponentRegistry, ComponentRenderProps } from '@json-render/react';
+export { ActionFn, Actions, BaseComponentProps, ComponentContext, ComponentFn, ComponentRegistry, ComponentRenderProps, Components, EventHandle, SetState, StateModel } from '@json-render/react';
+export { PageRenderer, PageRendererProps } from './page-renderer-client.js';
+import { Spec } from '@json-render/core';
+export { Spec, StateStore, createStateStore } from '@json-render/core';
+/**
+ * Context value holding the component registry, action handlers,
+ * and the Next.js router navigate function.
+ */
+interface NextAppContextValue {
+    registry: ComponentRegistry;
+    handlers?: Record<string, (params: Record<string, unknown>) => Promise<unknown> | unknown>;
+    navigate: (href: string) => void;
+}
+/**
+ * Props for NextAppProvider.
+ */
+interface NextAppProviderProps {
+    /** Component registry for rendering */
+    registry: ComponentRegistry;
+    /** Action handlers */
+    handlers?: Record<string, (params: Record<string, unknown>) => Promise<unknown> | unknown>;
+    children: ReactNode;
+}
+/**
+ * Provider that holds the component registry and action handlers
+ * for the entire json-render Next.js application.
+ *
+ * Wrap your root layout with this provider:
+ *
+ * ```tsx
+ * // app/[[...slug]]/layout.tsx
+ * import { NextAppProvider } from "@json-render/next";
+ * import { registry, handlers } from "@/lib/registry";
+ *
+ * export default function Layout({ children }) {
+ *   return (
+ *     <html><body>
+ *       <NextAppProvider registry={registry} handlers={handlers}>
+ *         {children}
+ *       </NextAppProvider>
+ *     </body></html>
+ *   );
+ * }
+ * ```
+ */
+declare function NextAppProvider({ registry, handlers, children, }: NextAppProviderProps): react_jsx_runtime.JSX.Element;
+/**
+ * Hook to access the NextApp context.
+ * Must be used within a NextAppProvider.
+ */
+declare function useNextApp(): NextAppContextValue;
+/**
+ * Props for NextErrorBoundary.
+ */
+interface NextErrorBoundaryProps {
+    /** The error that occurred */
+    error: Error & {
+        digest?: string;
+    };
+    /** Function to attempt re-rendering the page */
+    reset: () => void;
+    /** Optional error UI spec from the matched route */
+    errorSpec?: Spec | null;
+}
+/**
+ * Error boundary component for json-render Next.js apps.
+ *
+ * If the matched route defines an `error` spec, it renders that.
+ * Otherwise renders a minimal default error UI.
+ *
+ * Must be used in a file with `"use client"` directive (Next.js requirement).
+ */
+declare function NextErrorBoundary({ error, reset, errorSpec, }: NextErrorBoundaryProps): react_jsx_runtime.JSX.Element;
+/**
+ * Props for NextLoading.
+ */
+interface NextLoadingProps {
+    /** Optional loading UI spec */
+    loadingSpec?: Spec | null;
+}
+/**
+ * Loading component for json-render Next.js apps.
+ *
+ * If a loading spec is provided, it will be rendered by the PageRenderer.
+ * Otherwise renders a minimal default loading indicator.
+ *
+ * Note: Since Next.js loading.tsx is static (no params), this renders
+ * a generic loading state. Route-specific loading can be achieved with
+ * Suspense boundaries in page content.
+ */
+declare function NextLoading({ loadingSpec: _loadingSpec }: NextLoadingProps): react_jsx_runtime.JSX.Element;
+/**
+ * Not-found component for json-render Next.js apps.
+ *
+ * Renders when the pathname does not match any route in the spec.
+ */
+declare function NextNotFound(): react_jsx_runtime.JSX.Element;
+/**
+ * Props expected by the Link component in json-render specs.
+ */
+interface LinkProps {
+    /** The target URL or route path */
+    href: string;
+    /** Whether to replace the current history entry */
+    replace?: boolean;
+    /** Whether to prefetch the linked route */
+    prefetch?: boolean;
+    /** CSS class name */
+    className?: string;
+    /** Inline styles */
+    style?: React.CSSProperties;
+}
+/**
+ * Built-in Link component for json-render Next.js specs.
+ *
+ * Wraps `next/link` for client-side navigation between routes.
+ *
+ * Usage in a spec:
+ * ```json
+ * {
+ *   "type": "Link",
+ *   "props": { "href": "/about" },
+ *   "children": ["link-text"]
+ * }
+ * ```
+ */
+declare function Link({ element, children }: ComponentRenderProps<LinkProps>): react_jsx_runtime.JSX.Element;
+/**
+ * Metadata for Next.js pages and layouts.
+ * Maps to Next.js's Metadata type.
+ */
+interface NextMetadata {
+    /** Page title — string or template config */
+    title?: string | {
+        /** Default title when no child overrides */
+        default: string;
+        /** Template string, use %s for the page title (e.g. "%s | My App") */
+        template?: string;
+        /** Absolute title that ignores parent templates */
+        absolute?: string;
+    };
+    /** Meta description */
+    description?: string;
+    /** Keywords for SEO */
+    keywords?: string[];
+    /** Open Graph metadata */
+    openGraph?: {
+        title?: string;
+        description?: string;
+        images?: string | string[];
+        type?: string;
+        url?: string;
+        siteName?: string;
+        locale?: string;
+    };
+    /** Twitter card metadata */
+    twitter?: {
+        card?: "summary" | "summary_large_image" | "app" | "player";
+        title?: string;
+        description?: string;
+        images?: string | string[];
+        creator?: string;
+        site?: string;
+    };
+    /** Robots directives */
+    robots?: string | {
+        index?: boolean;
+        follow?: boolean;
+    };
+    /** Canonical URL */
+    alternates?: {
+        canonical?: string;
+    };
+    /** Favicon and icons */
+    icons?: string | {
+        icon?: string;
+        apple?: string;
+        shortcut?: string;
+    };
+}
+/**
+ * A route definition within a NextAppSpec.
+ */
+interface NextRouteSpec {
+    /** Page content — standard json-render element tree */
+    page: Spec;
+    /** Per-route metadata for SEO */
+    metadata?: NextMetadata;
+    /** Layout key referencing an entry in NextAppSpec.layouts */
+    layout?: string;
+    /** Loading state element tree (rendered during Suspense) */
+    loading?: Spec;
+    /** Error state element tree */
+    error?: Spec;
+    /** Not-found element tree (for dynamic routes that don't match data) */
+    notFound?: Spec;
+    /** Server-side data loader name (references loaders in createNextApp) */
+    loader?: string;
+    /** Static params for generateStaticParams */
+    staticParams?: Record<string, string>[];
+}
+/**
+ * The full application spec for @json-render/next.
+ *
+ * Describes an entire Next.js application: routes, pages, layouts,
+ * metadata, and server-side data loading.
+ *
+ * Routes are keyed by URL patterns using Next.js conventions:
+ * - `"/"` — exact match
+ * - `"/blog/[slug]"` — dynamic segment
+ * - `"/docs/[...path]"` — catch-all segment
+ * - `"/settings/[[...path]]"` — optional catch-all segment
+ */
+interface NextAppSpec {
+    /** Root-level metadata applied to all routes (layouts can override) */
+    metadata?: NextMetadata;
+    /** Route definitions keyed by URL pattern */
+    routes: Record<string, NextRouteSpec>;
+    /**
+     * Reusable layout element trees. Each layout spec must include a
+     * `Slot` component type where page content will be injected.
+     */
+    layouts?: Record<string, Spec>;
+    /** Global initial state shared across all routes */
+    state?: Record<string, unknown>;
+}
+/**
+ * Result of matching a pathname against the spec's routes.
+ */
+interface MatchedRoute {
+    /** The matched route spec */
+    route: NextRouteSpec;
+    /** The URL pattern that matched (e.g. "/blog/[slug]") */
+    pattern: string;
+    /** Extracted route parameters (e.g. { slug: "hello-world" }) */
+    params: Record<string, string | string[]>;
+}
+/**
+ * Server-side data loader function signature.
+ * Receives route params and returns data to merge into initial state.
+ */
+type LoaderFn = (params: Record<string, string | string[]>) => Promise<Record<string, unknown>> | Record<string, unknown>;
+/**
+ * Options for createNextApp.
+ */
+interface CreateNextAppOptions {
+    /** The application spec */
+    spec: NextAppSpec | (() => NextAppSpec | Promise<NextAppSpec>);
+    /** Server-side data loaders keyed by name */
+    loaders?: Record<string, LoaderFn>;
+}
+/**
+ * Data returned by getPageData for client-side rendering.
+ */
+interface PageData {
+    /** Page element tree spec */
+    spec: Spec;
+    /** Initial state (merged from spec.state, global state, and loader data) */
+    initialState?: Record<string, unknown>;
+    /** Optional layout element tree spec */
+    layoutSpec?: Spec | null;
+}
+/**
+ * The result of createNextApp — exports for Next.js route files.
+ */
+interface NextAppExports {
+    /**
+     * Resolve page data for a given set of params.
+     * Returns null if no route matches (caller should call notFound()).
+     *
+     * Use this in your Server Component page.tsx alongside a client wrapper
+     * that renders PageRenderer:
+     *
+     * ```tsx
+     * // app/[[...slug]]/page.tsx
+     * import { getPageData, generateMetadata, generateStaticParams } from "@/lib/app";
+     * import { WebsiteRenderer } from "./renderer";
+     *
+     * export { generateMetadata, generateStaticParams };
+     *
+     * export default async function Page({ params }) {
+     *   const data = await getPageData({ params });
+     *   if (!data) notFound();
+     *   return <WebsiteRenderer {...data} />;
+     * }
+     * ```
+     */
+    getPageData: (props: {
+        params: Promise<{
+            slug?: string[];
+        }>;
+    }) => Promise<PageData | null>;
+    /** generateMetadata function for page.tsx */
+    generateMetadata: (props: {
+        params: Promise<{
+            slug?: string[];
+        }>;
+    }) => Promise<Record<string, unknown>>;
+    /** generateStaticParams function for page.tsx */
+    generateStaticParams: () => Promise<{
+        slug: string[];
+    }[]>;
+}
+export { type CreateNextAppOptions, Link, type LinkProps, type LoaderFn, type MatchedRoute, type NextAppContextValue, type NextAppExports, NextAppProvider, type NextAppProviderProps, type NextAppSpec, NextErrorBoundary, type NextErrorBoundaryProps, NextLoading, type NextLoadingProps, type NextMetadata, NextNotFound, type NextRouteSpec, type PageData, useNextApp };