prompts-data-productstage 1.0.0

package/README.md

@@ -0,0 +1,293 @@
+# @productstage/prompts-data
+
+Professional AI product photography prompts library for e-commerce and online stores. This package contains curated prompt templates designed for various product categories, optimized for AI image generation platforms like Midjourney, Stable Diffusion, and DALL-E.
+
+## Features
+
+- **29 Product Categories**: From jewelry and watches to furniture and handmade items
+- **100+ Prompt Templates**: Carefully crafted professional photography prompts
+- **Flexible Querying**: Filter by category, variant, keywords, and more
+- **TypeScript Support**: Full type definitions included
+- **Easy Integration**: Simple API for quick implementation
+
+## Installation
+
+```bash
+npm install @productstage/prompts-data
+```
+
+## Usage
+
+### Basic Usage
+
+```typescript
+import { 
+  getAllCategories, 
+  getPromptsWithCategories, 
+  formatPrompt 
+} from '@productstage/prompts-data';
+
+// Get all categories
+const categories = getAllCategories();
+console.log(`Available categories: ${categories.length}`);
+
+// Get prompts with category information
+const prompts = getPromptsWithCategories({ activeOnly: true });
+console.log(`Total active prompts: ${prompts.length}`);
+
+// Format a prompt with category names
+const formattedPrompt = formatPrompt(prompts[0]);
+console.log(formattedPrompt);
+```
+
+### Filter by Category
+
+```typescript
+import { getPromptsByCategoryId } from '@productstage/prompts-data';
+
+// Get prompts for jewelry (category ID 11)
+const jewelryPrompts = getPromptsByCategoryId(11);
+jewelryPrompts.forEach(prompt => {
+  console.log(`${prompt.variant}: ${prompt.template}`);
+});
+```
+
+### Advanced Querying
+
+```typescript
+import { getPromptsWithCategories } from '@productstage/prompts-data';
+
+// Get all hero prompts for jewelry
+const heroPrompts = getPromptsWithCategories({
+  mainCategory: 'jewelry',
+  variant: 'Hero',
+  activeOnly: true
+});
+
+// Get prompts for specific subcategory
+const necklacePrompts = getPromptsWithCategories({
+  subCategory: 'necklace',
+  activeOnly: true
+});
+
+// Find categories by keyword
+import { findCategoriesByKeyword } from '@productstage/prompts-data';
+const handmadeCategories = findCategoriesByKeyword('handmade');
+```
+
+### Random Prompts
+
+```typescript
+import { getRandomPrompts, getRandomPromptsByCategory } from '@productstage/prompts-data';
+
+// Get 5 random prompts
+const randomPrompts = getRandomPrompts(5);
+
+// Get 3 random prompts for watches
+const randomWatchPrompts = getRandomPromptsByCategory(8, 3);
+```
+
+### Custom Formatting
+
+```typescript
+import { formatPromptWithNames } from '@productstage/prompts-data';
+
+// Use a prompt template with custom product names
+const prompt = {
+  id: 1,
+  productCategoryId: 7,
+  template: '{main_category} {sub_category} on a marble surface...',
+  variant: 'Custom',
+  isActive: true
+};
+
+const customPrompt = formatPromptWithNames(
+  prompt, 
+  'luxury watch', 
+  'gold automatic'
+);
+console.log(customPrompt);
+// Output: "luxury watch gold automatic on a marble surface..."
+```
+
+## API Reference
+
+### Functions
+
+#### `getAllCategories(): ProductCategory[]`
+Returns all available product categories.
+
+#### `getCategoryById(id: number): ProductCategory | undefined`
+Returns a category by its ID.
+
+#### `findCategoriesByMainCategory(mainCategory: string): ProductCategory[]`
+Finds categories by main category name (case-insensitive).
+
+#### `findCategoriesByKeyword(keyword: string): ProductCategory[]`
+Finds categories matching a keyword in main category, subcategory, or keywords array.
+
+#### `getAllPrompts(): ProductPrompt[]`
+Returns all prompt templates.
+
+#### `getPromptsWithCategories(options?: PromptQueryOptions): PromptWithCategory[]`
+Returns prompts with category information, optionally filtered.
+
+**Options:**
+- `categoryId?: number` - Filter by category ID
+- `mainCategory?: string` - Filter by main category name
+- `subCategory?: string` - Filter by subcategory name
+- `variant?: string` - Filter by variant name (partial match)
+- `activeOnly?: boolean` - Return only active prompts
+- `keywords?: string[]` - Filter by category keywords
+
+#### `getPromptsByCategoryId(categoryId: number, activeOnly?: boolean): ProductPrompt[]`
+Returns all prompts for a specific category.
+
+#### `getRandomPrompts(count: number, activeOnly?: boolean): ProductPrompt[]`
+Returns random prompts from the collection.
+
+#### `getRandomPromptsByCategory(categoryId: number, count: number, activeOnly?: boolean): ProductPrompt[]`
+Returns random prompts for a specific category.
+
+#### `formatPrompt(prompt: ProductPrompt): string`
+Formats a prompt template by replacing `{main_category}` and `{sub_category}` placeholders with actual category names.
+
+#### `formatPromptWithNames(prompt: ProductPrompt, mainCategory: string, subCategory?: string): string`
+Formats a prompt template with custom category names.
+
+## Data Structure
+
+### ProductCategory
+```typescript
+interface ProductCategory {
+  id: number;
+  mainCategory: string;
+  subCategory: string | null;
+  keywords: string[];
+}
+```
+
+### ProductPrompt
+```typescript
+interface ProductPrompt {
+  id: number;
+  productCategoryId: number;
+  template: string;
+  variant: string;
+  isActive: boolean;
+}
+```
+
+### PromptWithCategory
+```typescript
+interface PromptWithCategory extends ProductPrompt {
+  category: ProductCategory;
+}
+```
+
+## Supported Categories
+
+The package includes prompts for the following product categories:
+
+- **Bags**: Shoulder bags, handbags
+- **Furniture**: Lounge chairs, home furniture
+- **Apparel**: Hats, clothing
+- **Accessories**: Fashion accessories
+- **Shoes**: Hiking boots, footwear
+- **Watches**: Bracelet watches, timepieces
+- **Jewelry**: Necklaces, bracelets, rings, earrings
+- **Handmade**: Ceramics, textiles, leather goods, woodwork
+- **Household**: Cleaning brushes, home items
+- **Beauty Tools**: Face mask bowls, cosmetic tools
+- **Kitchenware**: Cutting boards, cookware
+- **Home Decor**: Decorative bowls, vases
+- **Lighting**: Wall sconces, fixtures
+- **Home Organization**: Bookends, storage
+- **Headwear**: Caps, hats
+- **Clothing**: Men's shirts
+- **Toys**: Wooden models, playthings
+- **Home Appliances**: Humidifiers, electronics
+- **Electronics**: Headphones, tech accessories
+
+## Use Cases
+
+- **E-commerce Product Photography**: Generate professional product images for online stores
+- **Etsy Sellers**: Create lifestyle shots for handmade items
+- **Shopify Store Owners**: Produce consistent product imagery
+- **Amazon Sellers**: Generate compliant product photos
+- **Digital Marketers**: Create promotional product content
+- **Design Agencies**: Quick prototyping for product photography concepts
+
+## Examples
+
+### Generate Product Images with AI
+
+```typescript
+import { getPromptsByCategoryId, formatPrompt } from '@productstage/prompts-data';
+
+// Get prompts for necklace
+const necklacePrompts = getPromptsByCategoryId(11);
+const selectedPrompt = necklacePrompts[0];
+
+// Format and use with AI image generation
+const aiPrompt = formatPrompt(selectedPrompt);
+console.log(aiPrompt);
+
+// Now use aiPrompt with your preferred AI image generation API
+// e.g., OpenAI DALL-E, Stability AI, Midjourney, etc.
+```
+
+### Build a Product Photography Generator
+
+```typescript
+import { 
+  getAllCategories, 
+  getRandomPromptsByCategory 
+} from '@productstage/prompts-data';
+
+function generateProductImage(categoryName: string) {
+  const categories = getAllCategories();
+  const category = categories.find(c => 
+    c.mainCategory.toLowerCase() === categoryName.toLowerCase()
+  );
+  
+  if (!category) {
+    throw new Error('Category not found');
+  }
+  
+  const prompt = getRandomPromptsByCategory(category.id, 1)[0];
+  return prompt.template
+    .replace(/{main_category}/g, category.mainCategory)
+    .replace(/{sub_category}/g, category.subCategory || '');
+}
+
+// Usage
+const imagePrompt = generateProductImage('jewelry');
+```
+
+## License
+
+MIT
+
+## Author
+
+ProductStage.ai - Professional AI Product Photography Tools
+
+## Links
+
+- [ProductStage.ai](https://productstage.ai)
+- [GitHub Repository](https://github.com/LueYueqing/productstage.ai)
+- [Issues](https://github.com/LueYueqing/productstage.ai/issues)
+
+## Contributing
+
+We welcome contributions! If you have improvements or new prompt templates, please:
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Submit a pull request
+
+## Support
+
+For issues, questions, or suggestions, please open an issue on GitHub or visit [ProductStage.ai](https://productstage.ai).

package/dist/data/categories.d.ts

@@ -0,0 +1,2 @@
+import { ProductCategory } from '../types';
+export declare const categories: ProductCategory[];

package/dist/data/categories.js

@@ -0,0 +1,167 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.categories = void 0;
+exports.categories = [
+    {
+        "id": 1,
+        "mainCategory": "bags",
+        "subCategory": "shoulder bags",
+        "keywords": ["bags", "shoulder bags"]
+    },
+    {
+        "id": 2,
+        "mainCategory": "furniture",
+        "subCategory": "lounge chair",
+        "keywords": ["furniture", "lounge chair"]
+    },
+    {
+        "id": 4,
+        "mainCategory": "apparel",
+        "subCategory": "hats",
+        "keywords": ["apparel", "hats"]
+    },
+    {
+        "id": 5,
+        "mainCategory": "accessories",
+        "subCategory": "hats",
+        "keywords": ["accessories", "hats"]
+    },
+    {
+        "id": 6,
+        "mainCategory": "shoes",
+        "subCategory": "hiking boots",
+        "keywords": ["shoes", "hiking boots"]
+    },
+    {
+        "id": 7,
+        "mainCategory": "universal",
+        "subCategory": null,
+        "keywords": []
+    },
+    {
+        "id": 8,
+        "mainCategory": "watches",
+        "subCategory": "bracelet watches",
+        "keywords": ["watches", "bracelet watches"]
+    },
+    {
+        "id": 10,
+        "mainCategory": "footwear",
+        "subCategory": "slippers",
+        "keywords": ["footwear", "slippers"]
+    },
+    {
+        "id": 11,
+        "mainCategory": "jewelry",
+        "subCategory": "necklace",
+        "keywords": ["jewelry", "necklace"]
+    },
+    {
+        "id": 12,
+        "mainCategory": "jewelry",
+        "subCategory": "bracelet",
+        "keywords": ["jewelry", "bracelet", "bangle", "wrist wear"]
+    },
+    {
+        "id": 13,
+        "mainCategory": "jewelry",
+        "subCategory": "ring",
+        "keywords": ["jewelry", "ring", "finger ring", "band"]
+    },
+    {
+        "id": 14,
+        "mainCategory": "handmade",
+        "subCategory": "ceramic",
+        "keywords": ["handmade", "ceramic", "pottery", "artisan bowl", "handmade vase", "dinnerware"]
+    },
+    {
+        "id": 15,
+        "mainCategory": "handmade",
+        "subCategory": "textile",
+        "keywords": ["handmade", "knitted", "crochet", "textile", "chunky knit", "blanket", "scarf"]
+    },
+    {
+        "id": 16,
+        "mainCategory": "handmade",
+        "subCategory": "leather",
+        "keywords": ["handmade", "leather", "leather wallet", "leather bag", "vegetable tanned"]
+    },
+    {
+        "id": 17,
+        "mainCategory": "handmade",
+        "subCategory": "woodwork",
+        "keywords": ["handmade", "wood", "wooden", "cutting board", "live edge", "charcuterie board"]
+    },
+    {
+        "id": 18,
+        "mainCategory": "jewelry",
+        "subCategory": "earrings",
+        "keywords": ["jewelry", "earrings", "hoop earrings", "stud earrings", "dangle earrings"]
+    },
+    {
+        "id": 19,
+        "mainCategory": "household",
+        "subCategory": "cleaning brush",
+        "keywords": ["household", "cleaning brush"]
+    },
+    {
+        "id": 20,
+        "mainCategory": "beauty tools",
+        "subCategory": "face mask bowl and brush set",
+        "keywords": ["beauty tools", "face mask bowl and brush set"]
+    },
+    {
+        "id": 21,
+        "mainCategory": "kitchenware",
+        "subCategory": "cutting board",
+        "keywords": ["kitchenware", "cutting board"]
+    },
+    {
+        "id": 22,
+        "mainCategory": "home decor",
+        "subCategory": "decorative bowls and vases",
+        "keywords": ["home decor", "decorative bowls and vases"]
+    },
+    {
+        "id": 23,
+        "mainCategory": "lighting",
+        "subCategory": "wall sconce",
+        "keywords": ["lighting", "wall sconce"]
+    },
+    {
+        "id": 24,
+        "mainCategory": "home organization",
+        "subCategory": "bookends",
+        "keywords": ["home organization", "bookends"]
+    },
+    {
+        "id": 25,
+        "mainCategory": "headwear",
+        "subCategory": "caps",
+        "keywords": ["headwear", "caps"]
+    },
+    {
+        "id": 26,
+        "mainCategory": "clothing",
+        "subCategory": "men's shirts",
+        "keywords": ["clothing", "men's shirts"]
+    },
+    {
+        "id": 27,
+        "mainCategory": "toys",
+        "subCategory": "wooden model airplane",
+        "keywords": ["toys", "wooden model airplane"]
+    },
+    {
+        "id": 28,
+        "mainCategory": "home appliances",
+        "subCategory": "humidifiers",
+        "keywords": ["home appliances", "humidifiers"]
+    },
+    {
+        "id": 29,
+        "mainCategory": "electronics",
+        "subCategory": "headphones",
+        "keywords": ["electronics", "headphones"]
+    }
+];

package/dist/data/prompts.d.ts

@@ -0,0 +1,2 @@
+import { ProductPrompt } from '../types';
+export declare const prompts: ProductPrompt[];