@revealui/core 0.0.1-pre.0

package/dist/types/interfaces/app.ts

@@ -0,0 +1,700 @@
+import React, {
+  type ButtonHTMLAttributes,
+  type CSSProperties,
+  type ElementType,
+  type HTMLAttributes,
+  type HTMLProps,
+  type MouseEvent,
+  type MouseEventHandler,
+  type ReactElement,
+  type ReactNode,
+  type RefObject,
+} from "react";
+import { PageContext } from "./context";
+
+// Define the type for the product data
+export interface Category {
+  name: string;
+}
+
+export interface ProductData {
+  id: string;
+  name: string;
+  images?: string[];
+  category?: Category; // Now using Category type
+  price: number;
+}
+// Define the type for the return value of usePreviewModal
+export interface UsePreviewModalReturn {
+  onOpen: (productData: ProductData) => void;
+}
+export interface CartItem {
+  id: string;
+  name: string;
+  price: number;
+  quantity: number;
+  items: Array<any>;
+}
+// Define the type for the component's props
+export interface LoaderProps {
+  title?: string; // Optional prop
+}
+export interface InputProps
+  extends React.InputHTMLAttributes<HTMLInputElement> {}
+
+export interface FirechickenCardProps {
+  firechickenStats: Stat[];
+}
+export interface CardProps {
+  name: string;
+  image: string;
+  label: string;
+  cta: string;
+  href: string;
+}
+export interface LikeButtonProps {
+  songId: string;
+}
+// Define the type for the props
+export interface TopRightProps {
+  skewDeg?: number;
+  opacity?: number;
+}
+// Define a type for the component props
+export interface SolidProps {
+  children?: React.ReactNode;
+  color?: string;
+  darkColor?: string;
+  opacity?: number;
+  className?: string;
+  role?: string;
+  ariaLabel?: string;
+  negativeIndex?: number;
+}
+export interface GradientConicRevProps {
+  children?: ReactNode;
+  className?: string;
+  fromColor?: string;
+  viaColor?: string;
+  toColor?: string;
+  blendMode?: string;
+}
+export interface GradientConicProps {
+  children?: ReactNode;
+  gradientStops: string;
+  blendMode?: string;
+}
+export interface DecorativeDivProps {
+  gradient: string;
+  aspect: string;
+  width: string;
+  topPosition: string;
+}
+// Define the type for GradientToBottom props
+export interface GradientToBottomProps extends HTMLProps<HTMLDivElement> {
+  children?: React.ReactNode;
+  maxWidth?: string;
+  blendMode?: string;
+  zIndexClasses?: Record<number, string>;
+  negativeIndex?: number;
+  className?: string;
+}
+export interface GradientRadialLeftProps {
+  children: ReactNode;
+  className?: string;
+  gradientStops?: string;
+  blendMode?: string;
+}
+export interface GradientRadialProps {
+  children: ReactNode;
+  position?: string;
+  size?: string;
+  gradientStops: string;
+  responsivePositions?: Record<string, string>;
+}
+export interface GlassProps extends HTMLProps<HTMLDivElement> {
+  children: ReactNode;
+  className?: string;
+  style?: CSSProperties;
+}
+export interface Video {
+  id: {
+    videoId: string;
+  };
+  snippet: {
+    title: string;
+    thumbnails: {
+      medium: {
+        url: string;
+      };
+    };
+    channelTitle: string;
+  };
+}
+
+// Define the props for VideoList component
+export interface VideoListProps {
+  videos: Video[];
+  onVideoSelect: (video: Video) => void;
+}
+
+// Defines the type for the component's props
+export interface VideoItemProps {
+  video: Video;
+  onVideoSelect: (video: Video) => void;
+}
+export interface VideoDetail {
+  id: {
+    videoId: string;
+  };
+  snippet: {
+    title: string;
+    description?: string;
+  };
+}
+
+export interface VideoDetailProps {
+  video?: VideoDetail | null;
+}
+export interface VideoProps {
+  desktopSrc: string;
+  mobileSrc: string;
+  tabletSrc: string;
+}
+export interface TimeProps {
+  item: {
+    dateTime: string;
+    date: string;
+  };
+  className?: string;
+}
+export interface SpanProps {
+  children: React.ReactNode;
+  className?: string;
+  customStyles?: Record<string, string>;
+  color?: string;
+  size?: string;
+  weight?: string;
+  align?: string;
+  margin?: string;
+}
+export interface ParagraphProps {
+  children: ReactNode; // Content to be displayed within the paragraph
+  className?: string; // Additional CSS class names
+  customStyles?: Record<string, string>; // Custom styles for specific breakpoints
+  padding?: string; // Overall padding for the paragraph
+  paddingX?: string; // Horizontal padding
+  paddingY?: string; // Vertical padding
+  responsiveStyles?: Record<string, string>; // Responsive styles for specific breakpoints
+  align?: "start" | "center" | "end" | "justify"; // Text alignment
+  lineClamp?: number; // Limit the number of lines displayed
+  justify?: "start" | "center" | "end" | "between" | "around" | "evenly"; // Content justification
+  color?: string; // Text color
+  darkColor?: string; // Text color in dark mode
+}
+export interface MottoProps {
+  index?: number;
+  customClasses?: string;
+  className?: string;
+  width?: string;
+  padding?: string;
+  paddingX?: string;
+  paddingY?: string;
+  margin?: string;
+  marginX?: string;
+  marginY?: string;
+  border?: string;
+  bgColor?: string;
+  textAlign?: string;
+  ariaLabel?: string;
+  children?: ReactNode;
+}
+export interface LabelProps {
+  children: ReactNode;
+  className?: string;
+  as?: ElementType;
+  aria?: HTMLAttributes<HTMLElement>;
+}
+export type HeadingProps = {
+  children: ReactNode;
+  className?: string;
+  customStyles?: Record<string, string>;
+  variant?: "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
+  color?: string;
+  darkColor?: string;
+  size?: string;
+  weight?: string;
+  align?: string;
+  margin?: string;
+  as?: "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
+} & React.HTMLAttributes<HTMLHeadingElement>;
+
+export interface CurrencyProps {
+  value?: string | number;
+}
+export interface SkeletonProps {
+  width: string | number;
+  height: string | number;
+}
+export interface SectionProps extends React.HTMLAttributes<HTMLElement> {
+  children: React.ReactNode;
+  className?: string;
+}
+export interface UListProps {
+  items: string[];
+  className?: string;
+  // Use the correct type for rest of the props that `ul` can receive
+  [key: string]: string[] | string | undefined;
+}
+// Define the shape of each stat item
+export interface Stat {
+  label?: string;
+  category?: string;
+  value: string | number; // Adjust the type based on what `value` can be
+}
+
+// Define the props for StatsList component
+export interface StatsListProps {
+  stats: Stat[];
+}
+export interface ProductListProps {
+  title: string;
+  items: Product[];
+}
+export interface CarouselProps {
+  slides: {
+    url: string;
+  }[];
+}
+export interface UserType {
+  id: string;
+  name: string;
+  email: string;
+  avatar: string;
+}
+
+// Define the type for the component's props
+export interface ListItemProps {
+  image: string;
+  name: string;
+  href: string;
+  user?: UserType; // Replace 'UserType' with the actual type of your user object
+}
+export interface User {
+  id: string;
+  name: string;
+  email: string;
+  image: string;
+}
+
+export interface Session {
+  user: User;
+  back: () => void;
+  forward: () => void;
+  push: (url: string) => void;
+}
+
+export interface MusicHeaderProps {
+  children?: React.ReactNode;
+  className?: string;
+  session: Session;
+}
+
+export interface DetailedListProps
+  extends React.HTMLAttributes<HTMLDivElement> {
+  children: React.ReactNode;
+  className: string;
+  stats: Stat[];
+}
+export interface PromoBannerProps {
+  image: string;
+  alt: string;
+}
+// Define the type for the song data
+export interface SongData {
+  audio: string;
+  title: string;
+  artist: string;
+  // Add other relevant properties of the song here
+}
+
+export interface ImageProps extends React.ImgHTMLAttributes<HTMLImageElement> {
+  src?: string;
+  srcSet?: string;
+  sizes?: string;
+  fallback?: string;
+  alt?: string;
+  className?: string;
+  width?: string | number;
+  height?: string | number;
+  orientation?: "landscape" | "portrait";
+}
+export interface SongItemProps {
+  data: SongData;
+}
+export interface PlayPauseProps {
+  isPlaying: boolean;
+  activeSong: string;
+  song: string;
+  handlePause: () => void;
+  handlePlay: () => void;
+  togglePlay: () => void;
+  className?: string;
+}
+
+export type SongProps = {
+  id: string;
+  data: Song;
+  songs: Song[];
+};
+export interface FaIconProps {
+  onClick: (event: MouseEvent<SVGSVGElement>) => void;
+  className?: string;
+}
+export interface Song {
+  id: string;
+  cover: string;
+  audio: string;
+  captions: string;
+  name: string;
+  title: string;
+  artist: Artist;
+  album: string;
+  duration: number;
+  albumArtUrl: string;
+}
+
+export interface PlayerContentProps {
+  music: Song[];
+}
+export interface MusicSliderProps {
+  value: number;
+  onChange: (value: number) => void;
+  className?: string;
+}
+
+export interface VikingWarriorCardProps {
+  vikingWarriorStats: Stat[];
+}
+export interface VideoCard {
+  id: {
+    videoId: string;
+  };
+  snippet: {
+    title: string;
+    thumbnails: {
+      medium: {
+        url: string;
+      };
+    };
+    channelTitle: string;
+  };
+}
+export interface VideoCardProps {
+  videos: VideoCard[];
+  posts: {
+    id: string;
+    title: string;
+    content: string;
+    url: string;
+  }[];
+}
+export interface ImageType {
+  url: string;
+}
+
+export interface Product {
+  id: string | number;
+  name: string;
+  images?: ImageType[];
+  category?: Category;
+  price: number;
+  items: CartItem[];
+}
+
+export interface ProductCardProps {
+  data: Product;
+}
+
+// Define the type for the artist object within data
+export interface Artist {
+  name: string;
+}
+
+// Define the type for the media data object
+export interface MediaData {
+  id: string; // or number, depending on your data structure
+  name: string;
+  artist: Artist;
+}
+
+// Define the type for the component's props
+export interface MediaItemProps {
+  data: MediaData;
+  onPlay: (id: number) => void;
+  onClick: React.MouseEventHandler<HTMLButtonElement> | undefined;
+}
+export interface ContentSectionProps {
+  info: MainInfo;
+  index: number; // If you plan to use index
+  
+}
+export interface MainInfo {
+  id: number;
+  title: string;
+  subtitle: string;
+  description: string;
+  image: string;
+}
+export interface Event {
+  id: number;
+  title: string;
+  name: string;
+  description: string;
+  image: string;
+  alt: string;
+}
+
+// Define the type for the component's props
+export interface ImageGalleryProps {
+  images: ImageType[];
+}
+export interface MusicPlayerProps {
+  audioUrl: string;
+  captionUrl?: string;
+  music?: string;
+}
+export interface PageShellProps {
+  children: React.ReactNode;
+  pageContext?: PageContext;
+}
+export type LayoutProps = {
+  children: React.ReactNode;
+};
+export interface AudioTrackProps
+  extends React.AudioHTMLAttributes<HTMLAudioElement> {
+  audioRef: RefObject<HTMLAudioElement>;
+  audioUrl: string;
+  captionUrl?: string;
+  className?: string;
+}
+export interface Route {
+  name: string;
+  href: string;
+  current: boolean;
+}
+
+export interface PostDataParams {
+  url: string;
+  data: unknown;
+}
+
+export interface MusicTrack {
+  id: string;
+  name: string;
+  title: string;
+  artist: string;
+  cover: string;
+  audio: string;
+  captions: string;
+  color: string[];
+  active: boolean;
+}
+
+export interface FighterStat {
+  id?: number;
+  category: string;
+  value: string;
+}
+
+export interface Genre {
+  title: string;
+  value: string;
+}
+export interface IconProps {
+  size: number;
+  className?: string;
+}
+export interface ComponentModule {
+  default: React.ComponentType<Record<string, unknown>>;
+}
+
+export interface ErrorBoundaryState {
+  hasError: boolean;
+  error: Error | null;
+  errorInfo: React.ErrorInfo | null;
+}
+
+export interface ErrorBoundaryProps {
+  children: React.ReactNode;
+  onError?: (error: Error, errorInfo: React.ErrorInfo) => void;
+}
+export interface ParallaxComponentProps {
+  maxWidth?: string;
+  blendMode?: string;
+  zIndex?: number;
+  negativeIndex?: number;
+  className?: string;
+  children?: ReactNode;
+}
+
+// Define an interface for the expected structure of documentProps
+export interface DocumentProps {
+  title?: string;
+  description?: string;
+}
+// Define the prop types for the Logo component
+export interface LogoProps {
+  className?: string;
+  alt?: string;
+  width?: string;
+}
+// Define the type for GradientGlass props
+export interface GradientGlassProps {
+  id: string;
+  children?: React.ReactNode; // Type for child elements
+  key: string; // Key for React
+  indexClass: number; // Index class for z-index
+  className?: string; // Optional type for additional CSS classes
+}
+// Assuming `data` has a specific shape; modify as needed.
+export interface MusicButtonData {
+  id: string;
+  name: string;
+  artist: string;
+  album: string;
+  duration: number;
+  image: string;
+  url: string;
+  isPlaying: boolean;
+  isLiked: boolean;
+  disabled: boolean;
+}
+
+export interface MusicButtonProps
+  extends ButtonHTMLAttributes<HTMLButtonElement> {
+  className?: string;
+  data?: MusicButtonData | string;
+  children?: ReactNode;
+  disabled?: boolean;
+}
+export interface ButtonProps
+  extends React.ButtonHTMLAttributes<HTMLButtonElement> {
+  className?: string;
+  children: React.ReactNode;
+  disabled?: boolean;
+  type?: "button" | "submit" | "reset";
+  href?: string;
+}
+// Define the types for the props
+export interface BackgroundWrapperProps {
+  backgrounds: ReactElement[]; // Array of React elements
+  children: React.ReactNode; // Children elements
+}
+export interface IconButtonProps {
+  children?: ReactNode;
+  onClick: MouseEventHandler<HTMLButtonElement>;
+  icon: ReactNode;
+  className?: string;
+}
+export interface StraightProps {
+  children: ReactNode;
+  fromColor: string;
+  toColor: string;
+  ringColor: string;
+  lgRingColor: string;
+  skewAngle?: number;
+  shadowColor?: string;
+}
+
+export interface PageContextProps {
+  title: string;
+  description: string;
+  currentPath: string;
+  updateCurrentPath: (path: string) => void;
+  data?: unknown;
+}
+export type LinkProps = {
+  href: string;
+  className?: string;
+  children: React.ReactNode;
+  onClick?: (event: React.MouseEvent<HTMLAnchorElement>) => void;
+};
+export interface FieldProps extends React.HTMLAttributes<HTMLDivElement> {
+  customClasses?: string;
+  className?: string;
+  width?: string;
+  padding?: string;
+  paddingX?: string;
+  paddingY?: string;
+  margin?: string;
+  marginX?: string;
+  marginY?: string;
+  border?: string;
+  bgColor?: string;
+  textAlign?: string;
+  contentAlign?: string;
+  breakpoints?: Breakpoints;
+}
+export interface DiagonalProps {
+  children: ReactNode;
+}
+export interface GridContainerProps {
+  children: ReactNode;
+  className?: string;
+  index: number;
+  width?: string;
+  height?: string;
+  padding?: string;
+  columns?: string;
+  rows?: string;
+  gap?: string;
+  align?: "start" | "center" | "end" | "stretch" | "baseline";
+  justify?: "start" | "center" | "end" | "between" | "around" | "evenly";
+  layoutType?: "grid" | "flex";
+  customStyles?: string;
+  breakpoints?: Breakpoints;
+}
+
+export type FlexContainerProps = {
+  children: React.ReactNode;
+  className?: string;
+  index: number;
+  width?: string;
+  layoutType?: "flex" | "grid";
+  flexDirection?: "row" | "col" | "row-reverse" | "col-reverse" | "initial";
+  justifyContent?:
+    | "start"
+    | "center"
+    | "end"
+    | "between"
+    | "around"
+    | "evenly"
+    | "initial";
+  alignItems?: "start" | "center" | "end" | "stretch" | "initial";
+  layoutStyle?: 0 | 1 | 2 | 3 | 4 | 5;
+  customStyles?: string;
+  breakpoints?: Breakpoints;
+};
+export type ContainerProps = {
+  children: React.ReactNode;
+  index: number;
+  maxWidth?: string;
+  padding?: string;
+  className?: string;
+  as?: React.ElementType;
+  breakpoints?: Breakpoints;
+  customProps?: Record<string, undefined>;
+};
+
+// Define a type for customProps
+export type CustomProps = Record<string, string | undefined>;
+
+export type LayoutType = "flex" | "grid" | "container" | "stack";
+export type BreakpointSettings = Record<string, string | number>;
+export type Breakpoints = Record<string, BreakpointSettings>;
+
+export type GenerateRoutes = {
+  pageRoutes: Route[];
+  apiRoutes: Route[];
+};

package/dist/types/interfaces/client.ts

@@ -0,0 +1,10 @@
+export type { ClientDependency };
+
+type ClientDependency = {
+  // Can be:
+  //  - absolute path, or `
+  //  - `@reveal/dist/...`.
+  id: string;
+  onlyAssets: boolean;
+  eagerlyImported: boolean;
+};