@djangocfg/nextjs 2.1.225 → 2.1.226

package/dist/og-image/index.d.mts

@@ -1,112 +1,52 @@
-import { ImageResponse } from 'next/og';
-import { NextRequest } from 'next/server';
-import { ReactElement } from 'react';
-import { OgImageTemplateProps } from './components/index.mjs';
-export { DefaultTemplate, LightTemplate } from './components/index.mjs';
-export { AppMetadataOptions, FontConfig, OgImageUrlParams, createAppMetadataGenerator, createFontLoader, createOgImageUrlBuilder, decodeBase64, encodeBase64, generateAppMetadata, generateOgImageUrl, getAbsoluteOgImageUrl, loadGoogleFont, loadGoogleFonts, parseOgImageData, parseOgImageUrl } from './utils/index.mjs';
-import 'next';
+import { Metadata } from 'next';
+
+type OGPreset = 'DARK' | 'DARK_BLUE' | 'DARK_PURPLE' | 'DARK_GREEN' | 'DARK_ROSE' | 'LIGHT' | 'LIGHT_GRAY' | 'LIGHT_WARM' | 'LIGHT_GREEN';
+type OGLayout = 'DEFAULT' | 'HERO' | 'ARTICLE' | 'MINIMAL';
+/** Mirrors Django OGImageParams exactly */
+interface OGImageParams {
+    title: string;
+    description?: string;
+    locale?: string;
+    style?: 'dark' | 'light';
+    bg_color?: string;
+    bg_color2?: string;
+    text_color?: string;
+    accent_color?: string;
+    /** e.g. "1200x630" */
+    size?: string;
+    preset?: OGPreset;
+    layout?: OGLayout;
+    /** Excluded from cache key on Django side */
+    page_url?: string;
+}
 
 /**
- * OG Image Route Handler
- *
- * Factory function to create OG Image route handler for Next.js App Router
+ * Builds an absolute (or relative) OG image URL pointing to Django's
+ * django_ogimage endpoint: /cfg/og/<base64params>/
  *
- * Usage:
- * ```tsx
- * // app/api/og/route.tsx
- * import { createOgImageHandler } from '@djangocfg/nextjs/og-image';
- * import { MyTemplate } from './templates';
- *
- * export const { GET, runtime } = createOgImageHandler({
- *   template: MyTemplate,
- *   defaultProps: {
- *     siteName: 'My Site',
- *   },
- *   fonts: [{ family: 'Manrope', weight: 700 }],
- * });
- * ```
+ * The URL is suitable for use in og:image and twitter:image meta tags.
  */
+declare function buildOgUrl(params: OGImageParams): string;
 
-interface OgImageHandlerConfig {
-    /** Custom template component (optional, defaults to DefaultTemplate) */
-    template?: (props: OgImageTemplateProps) => ReactElement;
-    /** Default props to merge with query params */
-    defaultProps?: Partial<OgImageTemplateProps>;
-    /** Google Fonts to load */
-    fonts?: Array<{
-        family: string;
-        weight: 400 | 500 | 600 | 700 | 800 | 900;
-    }>;
-    /** Image size */
-    size?: {
-        width: number;
-        height: number;
-    };
-    /** Enable debug mode */
-    debug?: boolean;
-}
 /**
- * Factory function to create OG Image route handler
+ * Creates Next.js Metadata fragment with og:image and twitter:image
+ * pointing to Django's django_ogimage renderer.
  *
- * @example
- * ```tsx
- * // app/api/og/route.tsx
- * import { createOgImageHandler } from '@djangocfg/nextjs/og-image';
- * import { MyTemplate } from '@/components/MyTemplate';
- *
- * export const { GET, runtime } = createOgImageHandler({
- *   template: MyTemplate,
- *   defaultProps: { siteName: 'My Site' },
- *   fonts: [{ family: 'Inter', weight: 700 }],
- * });
- * ```
+ * Usage in generateMetadata():
+ *   return createOgMetadata({ title: 'Page', preset: 'DARK_BLUE' })
  */
-declare function createOgImageHandler(config: OgImageHandlerConfig): {
-    GET: (req: NextRequest) => Promise<ImageResponse>;
-    runtime: "edge";
-};
+declare function createOgMetadata(params: OGImageParams): Metadata;
 /**
- * Create OG Image route handler for dynamic route with path parameter
- *
- * This is a convenience wrapper for Next.js dynamic routes like `/api/og/[data]/route.tsx`.
- * It extracts the `data` parameter from the path and passes it to the handler as a query parameter.
- * Also handles static export mode automatically.
- *
- * @example
- * ```tsx
- * // app/api/og/[data]/route.tsx
- * import { createOgImageDynamicRoute } from '@djangocfg/nextjs/og-image';
- * import { OgImageTemplate } from '@/components/OgImageTemplate';
+ * Merges og:image metadata into an existing Metadata object.
  *
- * export const runtime = 'nodejs';
- * export const dynamic = 'force-static';
- * export const revalidate = false;
- *
- * const handler = createOgImageDynamicRoute({
- *   template: OgImageTemplate,
- *   defaultProps: {
- *     siteName: 'My App',
- *     logo: '/logo.svg',
- *   },
- * });
- *
- * export async function GET(
- *   request: NextRequest,
- *   { params }: { params: { data: string } }
- ) {
- *   return handler(request, params);
- * }
- * ```
+ * Usage:
+ *   return withOgImage(
+ *     { title: 'Page', description: '...' },
+ *     { preset: 'DARK_BLUE', layout: 'HERO' }
+ *   )
  */
-declare function createOgImageDynamicRoute(config: OgImageHandlerConfig): {
-    GET: (request: NextRequest, context: {
-        params: Promise<{
-            data: string;
-        }>;
-    }) => Promise<Response>;
-    generateStaticParams: () => Promise<Array<{
-        data: string;
-    }>>;
-};
+declare function withOgImage(metadata: Metadata, params: OGImageParams & {
+    title?: string;
+}): Metadata;
 
-export { type OgImageHandlerConfig, OgImageTemplateProps, createOgImageDynamicRoute, createOgImageHandler };
+export { type OGImageParams, type OGLayout, type OGPreset, buildOgUrl, createOgMetadata, withOgImage };