festive-effects 1.0.0

package/dist/types/index.d.ts

@@ -0,0 +1,144 @@
+/**
+ * Union type of all supported festival effects
+ */
+export type FestivalType = 'christmas' | 'newyear' | 'valentine' | 'easter' | 'halloween' | 'thanksgiving' | 'diwali' | 'chinesenewyear' | 'holi' | 'eid' | 'stpatricks' | 'independence';
+/**
+ * Array of all valid festival types for validation
+ */
+export declare const FESTIVAL_TYPES: FestivalType[];
+/**
+ * Intensity levels for particle effects
+ */
+export type IntensityLevel = 'low' | 'medium' | 'high';
+/**
+ * Props for the main FestiveEffects component
+ */
+export interface FestiveEffectsProps {
+    /** The festival effect to display */
+    festival: FestivalType;
+    /** Intensity of the effect (particle count) */
+    intensity?: IntensityLevel;
+    /** Duration in milliseconds before effect stops */
+    duration?: number;
+    /** CSS z-index for the overlay */
+    zIndex?: number;
+    /** Whether to respect prefers-reduced-motion setting */
+    respectReducedMotion?: boolean;
+    /** Custom colors to override default festival colors */
+    colors?: string[];
+}
+/**
+ * Settings for each intensity level
+ */
+export interface IntensitySettings {
+    /** Multiplier for base particle count */
+    particleMultiplier: number;
+    /** Maximum number of particles allowed */
+    maxParticles: number;
+}
+/**
+ * Physics configuration for particle animations
+ */
+export interface PhysicsConfig {
+    /** Base animation speed */
+    speed: number;
+    /** Horizontal drift amount in pixels */
+    drift: number;
+    /** Rotation amount in degrees */
+    rotation: number;
+    /** Min/max scale range */
+    scale: [number, number];
+}
+/**
+ * All particle types available for effects
+ */
+export type ParticleType = 'snowflake' | 'firework' | 'confetti' | 'spark' | 'heart' | 'egg' | 'flower' | 'bat' | 'pumpkin' | 'spider' | 'leaf' | 'diya' | 'rangoli' | 'lantern' | 'dragon' | 'color-splash' | 'moon' | 'star' | 'shamrock' | 'rainbow';
+/**
+ * Animation types for particle effects
+ */
+export type AnimationType = 'fall' | 'rise' | 'explode' | 'float' | 'scatter';
+/**
+ * Configuration for a festival effect
+ */
+export interface FestivalConfig {
+    /** Base number of particles before intensity multiplier */
+    baseParticleCount: number;
+    /** Color palette for the effect */
+    colors: string[];
+    /** Types of particles used in this effect */
+    particleTypes: ParticleType[];
+    /** Primary animation type */
+    animationType: AnimationType;
+    /** Physics settings for animations */
+    physics: PhysicsConfig;
+}
+/**
+ * Viewport dimensions
+ */
+export interface Viewport {
+    width: number;
+    height: number;
+}
+/**
+ * Data for a single particle instance
+ */
+export interface ParticleData {
+    /** Unique identifier */
+    id: string;
+    /** Initial X position */
+    x: number;
+    /** Initial Y position */
+    y: number;
+    /** Particle size in pixels */
+    size: number;
+    /** Particle color */
+    color: string;
+    /** Type of particle shape */
+    type: ParticleType;
+    /** Animation delay in seconds */
+    delay: number;
+    /** Animation duration in seconds */
+    duration: number;
+    /** Additional custom properties for animation */
+    custom: Record<string, unknown>;
+}
+/**
+ * Framer Motion animation configuration
+ */
+export interface AnimationConfig {
+    /** Animation target values */
+    animate: {
+        x?: number | number[];
+        y?: number | number[];
+        rotate?: number | number[];
+        scale?: number | number[];
+        opacity?: number | number[];
+    };
+    /** Transition settings */
+    transition: {
+        duration: number;
+        ease?: string | number[];
+        repeat?: number;
+        repeatType?: 'loop' | 'reverse' | 'mirror';
+        delay?: number;
+    };
+}
+/**
+ * Props for individual particle components
+ */
+export interface ParticleProps {
+    /** Unique identifier */
+    id: string;
+    /** Initial X position */
+    initialX: number;
+    /** Initial Y position */
+    initialY: number;
+    /** Particle size */
+    size: number;
+    /** Particle color */
+    color: string;
+    /** Type of particle */
+    type: ParticleType;
+    /** Animation configuration */
+    animationConfig: AnimationConfig;
+}

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "festive-effects",
+  "version": "1.0.0",
+  "description": "A React component library for festival-themed visual effects using Framer Motion",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.esm.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "rollup -c",
+    "dev": "rollup -c -w",
+    "test": "jest",
+    "test:coverage": "jest --coverage",
+    "lint": "eslint src --ext .ts,.tsx",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "react",
+    "festive",
+    "effects",
+    "animations",
+    "framer-motion",
+    "christmas",
+    "halloween",
+    "diwali",
+    "particles",
+    "celebration",
+    "holiday",
+    "visual-effects",
+    "overlay"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "bugs": {
+    "url": ""
+  },
+  "homepage": "",
+  "peerDependencies": {
+    "react": ">=17.0.0 <20.0.0",
+    "react-dom": ">=17.0.0 <20.0.0",
+    "framer-motion": ">=10.0.0 <12.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react-dom": {
+      "optional": false
+    }
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@testing-library/jest-dom": "^6.4.2",
+    "@testing-library/react": "^14.2.1",
+    "@types/jest": "^29.5.12",
+    "@types/react": "^18.2.64",
+    "@types/react-dom": "^18.2.21",
+    "fast-check": "^3.15.1",
+    "framer-motion": "^11.0.8",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "rollup": "^4.12.1",
+    "rollup-plugin-dts": "^6.1.0",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.4.2"
+  }
+}