@genfeedai/prompts 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,115 @@
1
+ # @genfeedai/prompts
2
+
3
+ Official prompt templates for Genfeed - the AI-first content creation platform.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install @genfeedai/prompts
9
+ # or
10
+ bun add @genfeedai/prompts
11
+ ```
12
+
13
+ ## Usage
14
+
15
+ ### Using the Registry
16
+
17
+ ```typescript
18
+ import {
19
+ PROMPT_REGISTRY,
20
+ getAllPrompts,
21
+ getPrompt,
22
+ getPromptsByCategory,
23
+ searchPromptsByTag,
24
+ getPromptCategories,
25
+ } from '@genfeedai/prompts';
26
+
27
+ // List all prompts
28
+ const prompts = getAllPrompts();
29
+
30
+ // Get a specific prompt by ID
31
+ const prompt = getPrompt('product-photography');
32
+ // { id: 'product-photography', title: 'Product Photography', template: '...', ... }
33
+
34
+ // Get prompts by category
35
+ const imagePrompts = getPromptsByCategory('image-generation');
36
+ const videoPrompts = getPromptsByCategory('video-generation');
37
+ const contentPrompts = getPromptsByCategory('content');
38
+
39
+ // Search by tag
40
+ const marketingPrompts = searchPromptsByTag('marketing');
41
+
42
+ // List available categories
43
+ const categories = getPromptCategories();
44
+ ```
45
+
46
+ ### Accessing Prompt Files
47
+
48
+ The actual prompt JSON files are in the `prompts/` directory, organized by category:
49
+
50
+ ```typescript
51
+ import productPhoto from '@genfeedai/prompts/prompts/image-generation/product-photography.json';
52
+ import blogOutline from '@genfeedai/prompts/prompts/content/blog-outline.json';
53
+ ```
54
+
55
+ ## Available Prompts
56
+
57
+ ### Image Generation
58
+
59
+ | ID | Name | Description |
60
+ |----|------|-------------|
61
+ | `product-photography` | Product Photography | Professional product shots for e-commerce and marketing |
62
+ | `social-media-post` | Social Media Post | Eye-catching images optimized for social media engagement |
63
+ | `brand-ad` | Brand Advertisement | Professional brand advertisements that convert and engage |
64
+ | `portrait-headshot` | Portrait Headshot | Professional headshots for LinkedIn and business use |
65
+
66
+ ### Video Generation
67
+
68
+ | ID | Name | Description |
69
+ |----|------|-------------|
70
+ | `product-demo` | Product Demo Video | Engaging product demonstration videos that showcase features |
71
+ | `social-clip` | Social Media Clip | Short-form video content optimized for social platforms |
72
+ | `ugc-testimonial` | UGC Testimonial | Authentic user-generated content style testimonial videos |
73
+
74
+ ### Content
75
+
76
+ | ID | Name | Description |
77
+ |----|------|-------------|
78
+ | `blog-outline` | Blog Post Outline | Comprehensive blog post outlines for content marketing |
79
+ | `social-caption` | Social Media Caption | Engaging captions that drive interaction and engagement |
80
+ | `email-sequence` | Email Marketing Sequence | Effective email sequences for nurturing and conversion |
81
+
82
+ ## Prompt Schema
83
+
84
+ Each prompt follows the `PromptTemplate` interface from `@genfeedai/types`:
85
+
86
+ ```typescript
87
+ interface PromptTemplate {
88
+ id: string;
89
+ title: string;
90
+ description: string;
91
+ category: 'image-generation' | 'video-generation' | 'content';
92
+ tier: 'free' | 'paid' | 'premium';
93
+ template: string;
94
+ variables: PromptVariable[];
95
+ tags: string[];
96
+ exampleOutput?: string;
97
+ icon?: string;
98
+ version: number;
99
+ }
100
+
101
+ interface PromptVariable {
102
+ name: string;
103
+ label: string;
104
+ type: 'text' | 'select' | 'number' | 'boolean';
105
+ required?: boolean;
106
+ default?: string | number | boolean;
107
+ options?: string[];
108
+ placeholder?: string;
109
+ description?: string;
110
+ }
111
+ ```
112
+
113
+ ## License
114
+
115
+ AGPL-3.0
@@ -0,0 +1,85 @@
1
+ /**
2
+ * Types for @genfeedai/prompts package
3
+ */
4
+ interface PromptVariable {
5
+ name: string;
6
+ label: string;
7
+ type: 'text' | 'select' | 'number' | 'boolean';
8
+ required?: boolean;
9
+ default?: string | number | boolean;
10
+ options?: string[];
11
+ placeholder?: string;
12
+ description?: string;
13
+ }
14
+ interface PromptTemplate {
15
+ id: string;
16
+ title: string;
17
+ description: string;
18
+ category: 'image-generation' | 'video-generation' | 'content';
19
+ tier: 'free' | 'paid' | 'premium';
20
+ template: string;
21
+ variables: PromptVariable[];
22
+ tags: string[];
23
+ exampleOutput?: string;
24
+ icon?: string;
25
+ version: number;
26
+ createdAt?: string;
27
+ updatedAt?: string;
28
+ }
29
+ interface PromptCategory {
30
+ id: string;
31
+ name: string;
32
+ description: string;
33
+ icon: string;
34
+ count: number;
35
+ }
36
+ interface PromptCatalog {
37
+ prompts: Array<{
38
+ slug: string;
39
+ title: string;
40
+ description: string;
41
+ category: string;
42
+ tags: string[];
43
+ tier: string;
44
+ icon: string;
45
+ }>;
46
+ }
47
+
48
+ /**
49
+ * Prompt Registry for @genfeedai/prompts
50
+ */
51
+
52
+ /**
53
+ * Registry of all available prompt templates
54
+ */
55
+ declare const PROMPT_REGISTRY: Record<string, PromptTemplate>;
56
+ /**
57
+ * Available prompt categories
58
+ */
59
+ declare const PROMPT_CATEGORIES: PromptCategory[];
60
+ /**
61
+ * Get all prompt templates
62
+ */
63
+ declare function getAllPrompts(): PromptTemplate[];
64
+ /**
65
+ * Get prompt template by ID
66
+ */
67
+ declare function getPrompt(id: string): PromptTemplate | undefined;
68
+ /**
69
+ * Get prompt template JSON by ID
70
+ */
71
+ declare function getPromptJson(id: string): PromptTemplate | undefined;
72
+ /**
73
+ * Get prompts by category
74
+ */
75
+ declare function getPromptsByCategory(category: string): PromptTemplate[];
76
+ /**
77
+ * Search prompts by tag
78
+ */
79
+ declare function searchPromptsByTag(tag: string): PromptTemplate[];
80
+ /**
81
+ * Get all prompt categories
82
+ */
83
+ declare function getPromptCategories(): PromptCategory[];
84
+
85
+ export { PROMPT_CATEGORIES, PROMPT_REGISTRY, type PromptCatalog, type PromptCategory, type PromptTemplate, type PromptVariable, getAllPrompts, getPrompt, getPromptCategories, getPromptJson, getPromptsByCategory, searchPromptsByTag };
@@ -0,0 +1,85 @@
1
+ /**
2
+ * Types for @genfeedai/prompts package
3
+ */
4
+ interface PromptVariable {
5
+ name: string;
6
+ label: string;
7
+ type: 'text' | 'select' | 'number' | 'boolean';
8
+ required?: boolean;
9
+ default?: string | number | boolean;
10
+ options?: string[];
11
+ placeholder?: string;
12
+ description?: string;
13
+ }
14
+ interface PromptTemplate {
15
+ id: string;
16
+ title: string;
17
+ description: string;
18
+ category: 'image-generation' | 'video-generation' | 'content';
19
+ tier: 'free' | 'paid' | 'premium';
20
+ template: string;
21
+ variables: PromptVariable[];
22
+ tags: string[];
23
+ exampleOutput?: string;
24
+ icon?: string;
25
+ version: number;
26
+ createdAt?: string;
27
+ updatedAt?: string;
28
+ }
29
+ interface PromptCategory {
30
+ id: string;
31
+ name: string;
32
+ description: string;
33
+ icon: string;
34
+ count: number;
35
+ }
36
+ interface PromptCatalog {
37
+ prompts: Array<{
38
+ slug: string;
39
+ title: string;
40
+ description: string;
41
+ category: string;
42
+ tags: string[];
43
+ tier: string;
44
+ icon: string;
45
+ }>;
46
+ }
47
+
48
+ /**
49
+ * Prompt Registry for @genfeedai/prompts
50
+ */
51
+
52
+ /**
53
+ * Registry of all available prompt templates
54
+ */
55
+ declare const PROMPT_REGISTRY: Record<string, PromptTemplate>;
56
+ /**
57
+ * Available prompt categories
58
+ */
59
+ declare const PROMPT_CATEGORIES: PromptCategory[];
60
+ /**
61
+ * Get all prompt templates
62
+ */
63
+ declare function getAllPrompts(): PromptTemplate[];
64
+ /**
65
+ * Get prompt template by ID
66
+ */
67
+ declare function getPrompt(id: string): PromptTemplate | undefined;
68
+ /**
69
+ * Get prompt template JSON by ID
70
+ */
71
+ declare function getPromptJson(id: string): PromptTemplate | undefined;
72
+ /**
73
+ * Get prompts by category
74
+ */
75
+ declare function getPromptsByCategory(category: string): PromptTemplate[];
76
+ /**
77
+ * Search prompts by tag
78
+ */
79
+ declare function searchPromptsByTag(tag: string): PromptTemplate[];
80
+ /**
81
+ * Get all prompt categories
82
+ */
83
+ declare function getPromptCategories(): PromptCategory[];
84
+
85
+ export { PROMPT_CATEGORIES, PROMPT_REGISTRY, type PromptCatalog, type PromptCategory, type PromptTemplate, type PromptVariable, getAllPrompts, getPrompt, getPromptCategories, getPromptJson, getPromptsByCategory, searchPromptsByTag };