matt/Rocky_Mountain_Vending
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Rocky_Mountain_Vending/.pnpm-store/v10/files/da/6d2876772f869e80695c28fb08d99166e9fb2d66d5bcdd2abbe97a517bf56d261c895aac481be70d89ef33b4cc3b83e3ce02a5662411ae9e352364028b75bc
DMleadgen 46d973904b
Initial commit: Rocky Mountain Vending website 
Next.js website for Rocky Mountain Vending company featuring:
- Product catalog with Stripe integration
- Service areas and parts pages
- Admin dashboard with Clerk authentication
- SEO optimized pages with JSON-LD structured data

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-02-12 16:22:15 -07:00

636 lines
20 KiB
Text
Raw Blame History

/**
* Next.js Metadata API
*
* This file defines the types used by Next.js to configure metadata
* through static exports or dynamic `generateMetadata` functions in Server Components.
*
* @remarks
* - The static `metadata` object and `generateMetadata` function are only supported in Server Components.
* - Do not export both a `metadata` object and a `generateMetadata` function from the same route segment.
* - You can still render metadata in client components directly as part of the component's JSX.
*
* @see https://nextjs.org/docs/app/api-reference/metadata
*/
import type { AlternateURLs, Languages, ResolvedAlternateURLs } from './alternative-urls-types';
import type { AppleWebApp, AppLinks, Facebook, FormatDetection, ItunesApp, Pinterest, ResolvedAppleWebApp, ResolvedAppLinks, ResolvedFacebook, ResolvedPinterest, ViewportLayout } from './extra-types';
import type { DeprecatedMetadataFields, AbsoluteTemplateString, Author, ColorSchemeEnum, Icon, Icons, IconURL, ReferrerEnum, ResolvedIcons, ResolvedVerification, Robots, ResolvedRobots, TemplateString, Verification, ThemeColorDescriptor, Videos } from './metadata-types';
import type { Manifest as ManifestFile } from './manifest-types';
import type { OpenGraph, ResolvedOpenGraph } from './opengraph-types';
import type { ResolvedTwitterMetadata, Twitter } from './twitter-types';
/**
* Metadata interface to describe all the metadata fields that can be set in a document.
*
* @remarks
* This interface covers all the metadata fields available in Next.js including title, description,
* icons, openGraph, twitter, and more. Fields such as `metadataBase` help in composing absolute URLs
* from relative ones. The `title` field supports both simple strings and a template object with `default`,
* `template`, and `absolute` properties.
*
* @example
* ```tsx
* // Static metadata export in a layout or page:
* import type { Metadata } from 'next'
*
* export const metadata: Metadata = {
* metadataBase: new URL('https://example.com'),
* title: { default: 'My Site', template: '%s | My Site' },
* description: 'Welcome to My Site',
* alternates: {
* canonical: 'https://example.com',
* languages: {
* 'en-US': 'https://example.com/en-US',
* 'de-DE': 'https://example.com/de-DE'
* }
* },
* openGraph: {
* title: 'My Site',
* description: 'Welcome to My Site',
* url: 'https://example.com',
* siteName: 'My Site',
* images: [{ url: 'https://example.com/og.png' }]
* },
* }
* ```
*/
interface Metadata extends DeprecatedMetadataFields {
/**
* The base path and origin for absolute URLs in various metadata fields.
*
* @remarks
* When relative URLs (for Open Graph images, alternates, etc.) are used, they are composed with this base.
* If not provided, Next.js will populate a default value based on environment variables.
*/
metadataBase?: null | string | URL | undefined;
/**
* The document title.
*
* @remarks
* The title can be a simple string (e.g., `"My Blog"`) or an object with:
* - `default`: A fallback title for child segments.
* - `template`: A title template (e.g., `"%s | My Website"`) applied to child titles.
* - `absolute`: A title that overrides parent templates.
*
* @example
* ```tsx
* // As a simple string:
* title: "My Blog"
*
* // As a template object:
* title: { default: "Dashboard", template: "%s | My Website" }
*
* // Using absolute value (ignores parent template):
* title: { absolute: "My Blog", template: "%s | My Website" }
* ```
*/
title?: null | string | TemplateString | undefined;
/**
* The document description, and optionally the Open Graph and Twitter descriptions.
*
* @example
* ```tsx
* description: "My Blog Description"
* // Renders: <meta name="description" content="My Blog Description" />
* ```
*/
description?: null | string | undefined;
/**
* The application name.
*
* @example
* ```tsx
* applicationName: "My Blog"
* // Renders: <meta name="application-name" content="My Blog" />
* ```
*/
applicationName?: null | string | undefined;
/**
* The authors of the document.
*
* @example
* ```tsx
* authors: [{ name: "Next.js Team", url: "https://nextjs.org" }]
* // Renders:
* // <meta name="author" content="Next.js Team" />
* // <link rel="author" href="https://nextjs.org" />
* ```
*/
authors?: null | Author | Array<Author> | undefined;
/**
* The generator used for the document.
*
* @example
* ```tsx
* generator: "Next.js"
* // Renders: <meta name="generator" content="Next.js" />
* ```
*/
generator?: null | string | undefined;
/**
* The keywords for the document.
*
* @remarks
* When an array is provided, keywords are flattened into a comma-separated string.
*
* @example
* ```tsx
* keywords: "nextjs, react, blog"
* // or
* keywords: ["react", "server components"]
* ```
*/
keywords?: null | string | Array<string> | undefined;
/**
* The referrer setting for the document.
*
* @example
* ```tsx
* referrer: "origin"
* // Renders: <meta name="referrer" content="origin" />
* ```
*/
referrer?: null | ReferrerEnum | undefined;
/**
* The theme color for the document.
*
* @deprecated Use the new viewport configuration (`export const viewport: Viewport = { ... }`) instead.
*/
themeColor?: null | string | ThemeColorDescriptor | ThemeColorDescriptor[] | undefined;
/**
* The color scheme for the document.
*
* @deprecated Use the new viewport configuration (`export const viewport: Viewport = { ... }`) instead.
*/
colorScheme?: null | ColorSchemeEnum | undefined;
/**
* The viewport setting for the document.
*
* @deprecated Use the new viewport configuration (`export const viewport: Viewport = { ... }`) instead.
*/
viewport?: null | string | ViewportLayout | undefined;
/**
* The creator of the document.
*
* @example
* ```tsx
* creator: "Next.js Team"
* // Renders: <meta name="creator" content="Next.js Team" />
* ```
*/
creator?: null | string | undefined;
/**
* The publisher of the document.
*
* @example
* ```tsx
* publisher: "Vercel"
* // Renders: <meta name="publisher" content="Vercel" />
* ```
*/
publisher?: null | string | undefined;
/**
* The robots setting for the document.
*
* @remarks
* Can be a string (e.g., "index, follow") or an object with more granular rules.
*
* @example
* ```tsx
* robots: "index, follow"
* // or
* robots: { index: true, follow: true }
* ```
*
* @see https://developer.mozilla.org/docs/Glossary/Robots.txt
*/
robots?: null | string | Robots | undefined;
/**
* The canonical and alternate URLs for the document.
*
* @remarks
* This field allows defining a canonical URL as well as alternate URLs (such as for multiple languages).
*
* @example
* ```tsx
* alternates: {
* canonical: "https://example.com",
* languages: {
* "en-US": "https://example.com/en-US"
* }
* }
* ```
*/
alternates?: null | AlternateURLs | undefined;
/**
* The icons for the document. Defaults to rel="icon".
*
* @remarks
* You can specify a simple URL or an object to differentiate between icon types (e.g., apple-touch-icon).
*
* @example
* ```tsx
* icons: "https://example.com/icon.png"
* // or
* icons: {
* icon: "https://example.com/icon.png",
* apple: "https://example.com/apple-icon.png"
* }
* ```
*
* @see https://developer.mozilla.org/docs/Web/HTML/Attributes/rel#attr-icon
*/
icons?: null | IconURL | Array<Icon> | Icons | undefined;
/**
* A web application manifest, as defined in the Web Application Manifest specification.
*
* @example
* ```tsx
* manifest: "https://example.com/manifest.json"
* // Renders: <link rel="manifest" href="https://example.com/manifest.json" />
* ```
*
* @see https://developer.mozilla.org/docs/Web/Manifest
*/
manifest?: null | string | URL | undefined;
/**
* The Open Graph metadata for the document.
*
* @remarks
* Follows the Open Graph protocol to enrich link previews.
*
* @example
* ```tsx
* openGraph: {
* type: "website",
* url: "https://example.com",
* title: "My Website",
* description: "My Website Description",
* siteName: "My Website",
* images: [{ url: "https://example.com/og.png" }]
* }
* ```
*
* @see https://ogp.me/
*/
openGraph?: null | OpenGraph | undefined;
/**
* The Twitter metadata for the document.
*
* @remarks
* - Used for configuring Twitter Cards and can include details such as `card`, `site`, and `creator`.
* - Notably, more sites than just Twitter (now X) use this format.
*
* @example
* ```tsx
* twitter: {
* card: "summary_large_image",
* site: "@site",
* creator: "@creator",
* images: "https://example.com/og.png"
* }
* ```
*/
twitter?: null | Twitter | undefined;
/**
* The Facebook metadata for the document.
*
* @remarks
* Specify either `appId` or `admins` (but not both) to configure Facebook integration.
*
* @example
* ```tsx
* facebook: { appId: "12345678" }
* // Renders <meta property="fb:app_id" content="12345678" />
* // or
* facebook: { admins: ["12345678"] }
* // Renders <meta property="fb:admins" content="12345678" />
* ```
*/
facebook?: null | Facebook | undefined;
/**
* The Pinterest metadata for the document to choose whether opt out of rich pin data.
*
* @example
* ```tsx
* pinterest: { richPin: true }
* // Renders <meta name="pinterest-rich-pin" content="true" />
* ```
*/
pinterest?: null | Pinterest;
/**
* The common verification tokens for the document.
*
* @example
* ```tsx
* verification: { google: "1234567890", yandex: "1234567890", "me": "1234567890" }
* // Renders <meta name="google-site-verification" content="1234567890" />
* // <meta name="yandex-verification" content="1234567890" />
* // <meta name="me" content="@me" />
* ```
*/
verification?: Verification | undefined;
/**
* The Apple web app metadata for the document.
*
* @example
* ```tsx
* appleWebApp: { capable: true, title: "My Website", statusBarStyle: "black-translucent" }
* ```
*
* @see https://developer.apple.com/library/archive/documentation/AppleApplications/Reference/SafariHTMLRef/Articles/MetaTags.html
*/
appleWebApp?: null | boolean | AppleWebApp | undefined;
/**
* Indicates whether devices should interpret certain formats (such as telephone numbers) as actionable links.
*
* @example
* ```tsx
* formatDetection: { telephone: false }
* // Renders: <meta name="format-detection" content="telephone=no" />
* ```
*/
formatDetection?: null | FormatDetection | undefined;
/**
* The metadata for the iTunes App.
*
* @remarks
* Adds the `name="apple-itunes-app"` meta tag.
*
* @example
* ```tsx
* itunes: { app: { id: "123456789", affiliateData: "123456789", appArguments: "123456789" } }
* // Renders <meta name="apple-itunes-app" content="app-id=123456789, affiliate-data=123456789, app-arguments=123456789" />
* ```
*/
itunes?: null | ItunesApp | undefined;
/**
* A brief description of the web page.
*
* @remarks
* Rendered as the `abstract` meta tag. This is *not recommended* as it is superseded by `description`.
*
* @example
* ```tsx
* abstract: "My Website Description"
* // Renders <meta name="abstract" content="My Website Description" />
* ```
*/
abstract?: null | string | undefined;
/**
* The Facebook AppLinks metadata for the document.
*
* @example
* ```tsx
* appLinks: {
* ios: { appStoreId: "123456789", url: "https://example.com" },
* android: { packageName: "com.example", url: "https://example.com" }
* }
*
* // Renders
* <meta property="al:ios:app_store_id" content="123456789" />
* <meta property="al:ios:url" content="https://example.com" />
* <meta property="al:android:package" content="com.example" />
* <meta property="al:android:url" content="https://example.com" />
* ```
*/
appLinks?: null | AppLinks | undefined;
/**
* The archives link rel property.
*
* @example
* ```tsx
* archives: "https://example.com/archives"
* // Renders <link rel="archives" href="https://example.com/archives" />
* ```
*/
archives?: null | string | Array<string> | undefined;
/**
* The assets link rel property.
*
* @example
* ```tsx
* assets: "https://example.com/assets"
* // Renders <link rel="assets" href="https://example.com/assets" />
* ```
*/
assets?: null | string | Array<string> | undefined;
/**
* The bookmarks link rel property.
*
* @remarks
* Although technically against the HTML spec, this is used in practice.
*
* @example
* ```tsx
* bookmarks: "https://example.com/bookmarks"
* // Renders <link rel="bookmarks" href="https://example.com/bookmarks" />
* ```
*/
bookmarks?: null | string | Array<string> | undefined;
/**
* The pagination link rel properties.
*
* @example
* ```tsx
* pagination: {
* previous: "https://example.com/items?page=1",
* next: "https://example.com/items?page=3"
* }
*
* // Renders
* <link rel="prev" href="https://example.com/items?page=1" />
* <link rel="next" href="https://example.com/items?page=3" />
* ```
*
* @see https://developers.google.com/search/blog/2011/09/pagination-with-relnext-and-relprev
*/
pagination?: {
previous?: null | string | URL | undefined;
next?: null | string | URL | undefined;
};
/**
* The category meta name property.
*
* @example
* ```tsx
* category: "My Category"
* // Renders <meta name="category" content="My Category" />
* ```
*/
category?: null | string | undefined;
/**
* The classification meta name property.
*
* @example
* ```tsx
* classification: "My Classification"
* // Renders <meta name="classification" content="My Classification" />
* ```
*/
classification?: null | string | undefined;
/**
* Arbitrary name/value pairs for additional metadata.
*
* @remarks
* Use this field to define custom meta tags that are not directly supported.
*
* @example
* ```tsx
* other: { custom: ["meta1", "meta2"] }
* ```
*/
other?: ({
[name: string]: string | number | Array<string | number>;
} & DeprecatedMetadataFields) | undefined;
}
/**
* ResolvedMetadataWithURLs represents the fully processed metadata after
* defaults are applied and relative URLs are composed with `metadataBase`.
*/
interface ResolvedMetadataWithURLs extends DeprecatedMetadataFields {
metadataBase: string | null | URL;
title: null | AbsoluteTemplateString;
description: null | string;
applicationName: null | string;
authors: null | Array<Author>;
generator: null | string;
keywords: null | Array<string>;
referrer: null | ReferrerEnum;
/**
* @deprecated
*/
themeColor: null | ThemeColorDescriptor[];
/**
* @deprecated
*/
colorScheme: null | ColorSchemeEnum;
/**
* @deprecated
*/
viewport: null | string;
creator: null | string;
publisher: null | string;
robots: null | ResolvedRobots;
alternates: null | ResolvedAlternateURLs;
icons: null | ResolvedIcons;
openGraph: null | ResolvedOpenGraph;
manifest: null | string | URL;
twitter: null | ResolvedTwitterMetadata;
facebook: null | ResolvedFacebook;
pinterest: null | ResolvedPinterest;
verification: null | ResolvedVerification;
appleWebApp: null | ResolvedAppleWebApp;
formatDetection: null | FormatDetection;
itunes: null | ItunesApp;
abstract: null | string;
appLinks: null | ResolvedAppLinks;
archives: null | Array<string>;
assets: null | Array<string>;
bookmarks: null | Array<string>;
pagination: {
previous: null | string;
next: null | string;
};
category: null | string;
classification: null | string;
other: null | ({
[name: string]: string | number | Array<string | number>;
} & DeprecatedMetadataFields);
}
export type WithStringifiedURLs<T> = T extends URL ? string : T extends object ? {
[K in keyof T]: WithStringifiedURLs<T[K]>;
} : T;
/**
* ResolvedMetadata represents the fully processed metadata after defaults are
* applied and relative URLs are composed with `metadataBase`.
*/
type ResolvedMetadata = WithStringifiedURLs<ResolvedMetadataWithURLs>;
type RobotsFile = {
rules: {
userAgent?: string | string[] | undefined;
allow?: string | string[] | undefined;
disallow?: string | string[] | undefined;
crawlDelay?: number | undefined;
} | Array<{
userAgent: string | string[];
allow?: string | string[] | undefined;
disallow?: string | string[] | undefined;
crawlDelay?: number | undefined;
}>;
sitemap?: string | string[] | undefined;
host?: string | undefined;
};
type SitemapFile = Array<{
url: string;
lastModified?: string | Date | undefined;
changeFrequency?: 'always' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'never' | undefined;
priority?: number | undefined;
alternates?: {
languages?: Languages<string> | undefined;
} | undefined;
images?: string[] | undefined;
videos?: Videos[] | undefined;
}>;
type ResolvingMetadata = Promise<ResolvedMetadata>;
declare namespace MetadataRoute {
type Robots = RobotsFile;
type Sitemap = SitemapFile;
type Manifest = ManifestFile;
}
/**
* Interface for the viewport configuration.
*
* @remarks
* This configuration allows defining properties such as width, initial scale, theme colors,
* and color scheme.
*
* @example
* ```tsx
* export const viewport: Viewport = {
* width: "device-width",
* initialScale: 1,
* themeColor: [
* { media: "(prefers-color-scheme: dark)", color: "#000000" },
* { media: "(prefers-color-scheme: light)", color: "#ffffff" }
* ],
* colorScheme: "dark"
* }
* ```
*/
interface Viewport extends ViewportLayout {
/**
* The theme color for the document.
*
* @example
* ```tsx
* themeColor: "#000000"
* // Renders <meta name="theme-color" content="#000000" />
*
* themeColor: { media: "(prefers-color-scheme: dark)", color: "#000000" }
* // Renders <meta name="theme-color" media="(prefers-color-scheme: dark)" content="#000000" />
*
* themeColor: [
* { media: "(prefers-color-scheme: dark)", color: "#000000" },
* { media: "(prefers-color-scheme: light)", color: "#ffffff" }
* ]
* // Renders <meta name="theme-color" media="(prefers-color-scheme: dark)" content="#000000" />
* // Renders <meta name="theme-color" media="(prefers-color-scheme: light)" content="#ffffff" />
* ```
*/
themeColor?: null | string | ThemeColorDescriptor | ThemeColorDescriptor[] | undefined;
/**
* The color scheme for the document.
*
* @example
* ```tsx
* colorScheme: "dark"
* // Renders <meta name="color-scheme" content="dark" />
* ```
*/
colorScheme?: null | ColorSchemeEnum | undefined;
}
interface ResolvedViewport extends ViewportLayout {
themeColor: null | ThemeColorDescriptor[];
colorScheme: null | ColorSchemeEnum;
}
type ResolvingViewport = Promise<ResolvedViewport>;
export type { Metadata, ResolvedMetadata, ResolvedMetadataWithURLs, ResolvingMetadata, MetadataRoute, Viewport, ResolvingViewport, ResolvedViewport, };
Reference in a new issue View git blame Copy permalink