@genfeedai/workflows 0.1.0

package/README.md

@@ -0,0 +1,96 @@
+# @genfeedai/workflows
+
+Official workflow templates for Genfeed - the AI-first content creation platform.
+
+## Installation
+
+```bash
+npm install @genfeedai/workflows
+# or
+bun add @genfeedai/workflows
+```
+
+## Usage
+
+### Using the Registry
+
+```typescript
+import {
+  WORKFLOW_REGISTRY,
+  getWorkflowIds,
+  getWorkflowMetadata,
+  getWorkflowsByCategory,
+  searchWorkflowsByTag,
+} from '@genfeedai/workflows';
+
+// List all workflow IDs
+const ids = getWorkflowIds();
+// ['single-image', 'single-video', 'image-series', ...]
+
+// Get metadata for a specific workflow
+const metadata = getWorkflowMetadata('single-image');
+// { id: 'single-image', name: 'Single Image Generation', ... }
+
+// Get workflows by category
+const imageWorkflows = getWorkflowsByCategory('image');
+
+// Search by tag
+const simpleWorkflows = searchWorkflowsByTag('simple');
+```
+
+### Accessing Workflow Files
+
+The actual workflow JSON files are in the `workflows/` directory:
+
+```typescript
+import singleImage from '@genfeedai/workflows/workflows/single-image.json';
+import singleVideo from '@genfeedai/workflows/workflows/single-video.json';
+```
+
+## Available Workflows
+
+### Image Workflows
+
+| ID | Name | Description |
+|----|------|-------------|
+| `single-image` | Single Image Generation | Generate an AI image from a source image (img2img) |
+| `image-series` | Image Series | Generate related images using LLM expansion |
+
+### Video Workflows
+
+| ID | Name | Description |
+|----|------|-------------|
+| `single-video` | Single Video Generation | Generate a video from a source image (img2video) |
+| `image-to-video` | Image to Video | Create interpolated video between two images |
+
+### Full Pipeline Workflows
+
+| ID | Name | Description |
+|----|------|-------------|
+| `full-pipeline` | Full Content Pipeline | Complete workflow: concept → images → videos → stitched output |
+
+## Workflow Schema
+
+Each workflow follows the `WorkflowFile` interface from `@genfeedai/types`:
+
+```typescript
+interface WorkflowFile {
+  version: number;
+  name: string;
+  description: string;
+  nodes: WorkflowNode[];
+  edges: WorkflowEdge[];
+  edgeStyle: 'bezier' | 'smoothstep' | 'straight';
+  groups?: NodeGroup[];
+  createdAt: string;
+  updatedAt: string;
+}
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on submitting new workflows.
+
+## License
+
+AGPL-3.0

package/dist/index.d.mts

@@ -0,0 +1,185 @@
+import { ComfyUIPrompt, ComfyUIQueuePromptResponse, ComfyUIHistoryEntry, ComfyUIWorkflowTemplate, WorkflowNode, WorkflowEdge } from '@genfeedai/types';
+
+interface ComfyUIClientOptions {
+    /** Polling interval in ms when waiting for completion */
+    pollMs?: number;
+    /** Max time to wait for completion in ms */
+    timeoutMs?: number;
+}
+/**
+ * Lightweight HTTP client for the ComfyUI REST API.
+ *
+ * Talks to:
+ *   POST /prompt          — queue a new prompt
+ *   GET  /history/{id}    — check prompt status + outputs
+ *   GET  /view            — download an output file
+ *   GET  /system_stats    — health check
+ */
+declare class ComfyUIClient {
+    private readonly baseUrl;
+    constructor(baseUrl: string);
+    /**
+     * Queue a prompt for execution on ComfyUI.
+     */
+    queuePrompt(prompt: ComfyUIPrompt): Promise<ComfyUIQueuePromptResponse>;
+    /**
+     * Get history for a specific prompt execution.
+     */
+    getHistory(promptId: string): Promise<ComfyUIHistoryEntry | undefined>;
+    /**
+     * Download an output file (image/video) from ComfyUI.
+     */
+    getOutput(filename: string, subfolder: string): Promise<Buffer>;
+    /**
+     * Poll ComfyUI until the prompt completes or times out.
+     * Returns the history entry with outputs.
+     */
+    waitForCompletion(promptId: string, opts?: ComfyUIClientOptions): Promise<ComfyUIHistoryEntry>;
+    /**
+     * Health check — pings the ComfyUI instance.
+     */
+    ping(): Promise<boolean>;
+    private sleep;
+}
+
+/**
+ * Resolves a ComfyUI workflow template with user-provided inputs,
+ * then executes it on a ComfyUI instance.
+ */
+declare class ComfyUITemplateRunner {
+    private readonly client;
+    constructor(client: ComfyUIClient);
+    /**
+     * Resolve template inputs into a concrete prompt.
+     * Injects user values into the template's node graph.
+     */
+    resolvePrompt(template: ComfyUIWorkflowTemplate, values: Record<string, unknown>): ComfyUIPrompt;
+    /**
+     * Run a template with the given inputs and wait for completion.
+     */
+    run(template: ComfyUIWorkflowTemplate, values: Record<string, unknown>): Promise<ComfyUIHistoryEntry>;
+}
+
+interface FluxDevParams {
+    prompt: string;
+    seed?: number;
+    width?: number;
+    height?: number;
+    steps?: number;
+    cfg?: number;
+    negativePrompt?: string;
+}
+declare function buildFluxDevPrompt(params: FluxDevParams): ComfyUIPrompt;
+interface PulidFluxParams {
+    prompt: string;
+    faceImage: string;
+    seed?: number;
+    width?: number;
+    height?: number;
+    steps?: number;
+    cfg?: number;
+    pulidStrength?: number;
+}
+declare function buildPulidFluxPrompt(params: PulidFluxParams): ComfyUIPrompt;
+interface ZImageTurboParams {
+    prompt: string;
+    seed?: number;
+    width?: number;
+    height?: number;
+    steps?: number;
+}
+declare function buildZImageTurboPrompt(params: ZImageTurboParams): ComfyUIPrompt;
+interface Flux2DevParams {
+    prompt: string;
+    seed?: number;
+    width?: number;
+    height?: number;
+    steps?: number;
+    guidance?: number;
+}
+declare function buildFlux2DevPrompt(params: Flux2DevParams): ComfyUIPrompt;
+interface Flux2PulidParams extends Flux2DevParams {
+    faceImage: string;
+    pulidStrength?: number;
+}
+declare function buildFlux2DevPulidPrompt(params: Flux2PulidParams): ComfyUIPrompt;
+interface Flux2PulidLoraParams extends Flux2PulidParams {
+    loraPath: string;
+    loraStrength?: number;
+    realismLora?: string;
+    realismLoraStrength?: number;
+}
+declare function buildFlux2DevPulidLoraPrompt(params: Flux2PulidLoraParams): ComfyUIPrompt;
+interface Flux2KleinParams {
+    prompt: string;
+    seed?: number;
+    width?: number;
+    height?: number;
+    steps?: number;
+}
+declare function buildFlux2KleinPrompt(params: Flux2KleinParams): ComfyUIPrompt;
+
+/**
+ * Workflow Registry for @genfeedai/workflows
+ *
+ * This registry contains metadata for all official workflow templates.
+ * The actual workflow JSON files are stored in the `workflows/` directory.
+ */
+
+interface WorkflowJson {
+    version: number;
+    name: string;
+    description: string;
+    edgeStyle: string;
+    createdAt: string;
+    updatedAt: string;
+    nodes: WorkflowNode[];
+    edges: WorkflowEdge[];
+}
+interface WorkflowMetadata {
+    slug: string;
+    title: string;
+    description: string;
+    category: 'image-generation' | 'video-generation' | 'full-pipeline';
+    tags: string[];
+    tier: 'free' | 'paid' | 'premium';
+    icon: string;
+    defaultModel: string;
+    inputTypes: string[];
+    outputTypes: string[];
+    version: number;
+}
+/**
+ * Registry of all available workflow templates
+ */
+declare const WORKFLOW_REGISTRY: Record<string, WorkflowMetadata>;
+/**
+ * Get all workflows
+ */
+declare function getAllWorkflows(): WorkflowMetadata[];
+/**
+ * Get workflow metadata by slug
+ */
+declare function getWorkflow(slug: string): WorkflowMetadata | undefined;
+/**
+ * Get workflow JSON by slug
+ */
+declare function getWorkflowJson(slug: string): WorkflowJson | undefined;
+/**
+ * Get all workflow IDs (legacy compatibility)
+ */
+declare function getWorkflowIds(): string[];
+/**
+ * Get workflow metadata by ID (legacy compatibility)
+ */
+declare function getWorkflowMetadata(id: string): WorkflowMetadata | undefined;
+/**
+ * Get workflows by category
+ */
+declare function getWorkflowsByCategory(category: WorkflowMetadata['category']): WorkflowMetadata[];
+/**
+ * Search workflows by tag
+ */
+declare function searchWorkflowsByTag(tag: string): WorkflowMetadata[];
+
+export { ComfyUIClient, type ComfyUIClientOptions, ComfyUITemplateRunner, type Flux2DevParams, type Flux2KleinParams, type Flux2PulidLoraParams, type Flux2PulidParams, type FluxDevParams, type PulidFluxParams, WORKFLOW_REGISTRY, type WorkflowJson, type WorkflowMetadata, type ZImageTurboParams, buildFlux2DevPrompt, buildFlux2DevPulidLoraPrompt, buildFlux2DevPulidPrompt, buildFlux2KleinPrompt, buildFluxDevPrompt, buildPulidFluxPrompt, buildZImageTurboPrompt, getAllWorkflows, getWorkflow, getWorkflowIds, getWorkflowJson, getWorkflowMetadata, getWorkflowsByCategory, searchWorkflowsByTag };

package/dist/index.d.ts

@@ -0,0 +1,185 @@
+import { ComfyUIPrompt, ComfyUIQueuePromptResponse, ComfyUIHistoryEntry, ComfyUIWorkflowTemplate, WorkflowNode, WorkflowEdge } from '@genfeedai/types';
+
+interface ComfyUIClientOptions {
+    /** Polling interval in ms when waiting for completion */
+    pollMs?: number;
+    /** Max time to wait for completion in ms */
+    timeoutMs?: number;
+}
+/**
+ * Lightweight HTTP client for the ComfyUI REST API.
+ *
+ * Talks to:
+ *   POST /prompt          — queue a new prompt
+ *   GET  /history/{id}    — check prompt status + outputs
+ *   GET  /view            — download an output file
+ *   GET  /system_stats    — health check
+ */
+declare class ComfyUIClient {
+    private readonly baseUrl;
+    constructor(baseUrl: string);
+    /**
+     * Queue a prompt for execution on ComfyUI.
+     */
+    queuePrompt(prompt: ComfyUIPrompt): Promise<ComfyUIQueuePromptResponse>;
+    /**
+     * Get history for a specific prompt execution.
+     */
+    getHistory(promptId: string): Promise<ComfyUIHistoryEntry | undefined>;
+    /**
+     * Download an output file (image/video) from ComfyUI.
+     */
+    getOutput(filename: string, subfolder: string): Promise<Buffer>;
+    /**
+     * Poll ComfyUI until the prompt completes or times out.
+     * Returns the history entry with outputs.
+     */
+    waitForCompletion(promptId: string, opts?: ComfyUIClientOptions): Promise<ComfyUIHistoryEntry>;
+    /**
+     * Health check — pings the ComfyUI instance.
+     */
+    ping(): Promise<boolean>;
+    private sleep;
+}
+
+/**
+ * Resolves a ComfyUI workflow template with user-provided inputs,
+ * then executes it on a ComfyUI instance.
+ */
+declare class ComfyUITemplateRunner {
+    private readonly client;
+    constructor(client: ComfyUIClient);
+    /**
+     * Resolve template inputs into a concrete prompt.
+     * Injects user values into the template's node graph.
+     */
+    resolvePrompt(template: ComfyUIWorkflowTemplate, values: Record<string, unknown>): ComfyUIPrompt;
+    /**
+     * Run a template with the given inputs and wait for completion.
+     */
+    run(template: ComfyUIWorkflowTemplate, values: Record<string, unknown>): Promise<ComfyUIHistoryEntry>;
+}
+
+interface FluxDevParams {
+    prompt: string;
+    seed?: number;
+    width?: number;
+    height?: number;
+    steps?: number;
+    cfg?: number;
+    negativePrompt?: string;
+}
+declare function buildFluxDevPrompt(params: FluxDevParams): ComfyUIPrompt;
+interface PulidFluxParams {
+    prompt: string;
+    faceImage: string;
+    seed?: number;
+    width?: number;
+    height?: number;
+    steps?: number;
+    cfg?: number;
+    pulidStrength?: number;
+}
+declare function buildPulidFluxPrompt(params: PulidFluxParams): ComfyUIPrompt;
+interface ZImageTurboParams {
+    prompt: string;
+    seed?: number;
+    width?: number;
+    height?: number;
+    steps?: number;
+}
+declare function buildZImageTurboPrompt(params: ZImageTurboParams): ComfyUIPrompt;
+interface Flux2DevParams {
+    prompt: string;
+    seed?: number;
+    width?: number;
+    height?: number;
+    steps?: number;
+    guidance?: number;
+}
+declare function buildFlux2DevPrompt(params: Flux2DevParams): ComfyUIPrompt;
+interface Flux2PulidParams extends Flux2DevParams {
+    faceImage: string;
+    pulidStrength?: number;
+}
+declare function buildFlux2DevPulidPrompt(params: Flux2PulidParams): ComfyUIPrompt;
+interface Flux2PulidLoraParams extends Flux2PulidParams {
+    loraPath: string;
+    loraStrength?: number;
+    realismLora?: string;
+    realismLoraStrength?: number;
+}
+declare function buildFlux2DevPulidLoraPrompt(params: Flux2PulidLoraParams): ComfyUIPrompt;
+interface Flux2KleinParams {
+    prompt: string;
+    seed?: number;
+    width?: number;
+    height?: number;
+    steps?: number;
+}
+declare function buildFlux2KleinPrompt(params: Flux2KleinParams): ComfyUIPrompt;
+
+/**
+ * Workflow Registry for @genfeedai/workflows
+ *
+ * This registry contains metadata for all official workflow templates.
+ * The actual workflow JSON files are stored in the `workflows/` directory.
+ */
+
+interface WorkflowJson {
+    version: number;
+    name: string;
+    description: string;
+    edgeStyle: string;
+    createdAt: string;
+    updatedAt: string;
+    nodes: WorkflowNode[];
+    edges: WorkflowEdge[];
+}
+interface WorkflowMetadata {
+    slug: string;
+    title: string;
+    description: string;
+    category: 'image-generation' | 'video-generation' | 'full-pipeline';
+    tags: string[];
+    tier: 'free' | 'paid' | 'premium';
+    icon: string;
+    defaultModel: string;
+    inputTypes: string[];
+    outputTypes: string[];
+    version: number;
+}
+/**
+ * Registry of all available workflow templates
+ */
+declare const WORKFLOW_REGISTRY: Record<string, WorkflowMetadata>;
+/**
+ * Get all workflows
+ */
+declare function getAllWorkflows(): WorkflowMetadata[];
+/**
+ * Get workflow metadata by slug
+ */
+declare function getWorkflow(slug: string): WorkflowMetadata | undefined;
+/**
+ * Get workflow JSON by slug
+ */
+declare function getWorkflowJson(slug: string): WorkflowJson | undefined;
+/**
+ * Get all workflow IDs (legacy compatibility)
+ */
+declare function getWorkflowIds(): string[];
+/**
+ * Get workflow metadata by ID (legacy compatibility)
+ */
+declare function getWorkflowMetadata(id: string): WorkflowMetadata | undefined;
+/**
+ * Get workflows by category
+ */
+declare function getWorkflowsByCategory(category: WorkflowMetadata['category']): WorkflowMetadata[];
+/**
+ * Search workflows by tag
+ */
+declare function searchWorkflowsByTag(tag: string): WorkflowMetadata[];
+
+export { ComfyUIClient, type ComfyUIClientOptions, ComfyUITemplateRunner, type Flux2DevParams, type Flux2KleinParams, type Flux2PulidLoraParams, type Flux2PulidParams, type FluxDevParams, type PulidFluxParams, WORKFLOW_REGISTRY, type WorkflowJson, type WorkflowMetadata, type ZImageTurboParams, buildFlux2DevPrompt, buildFlux2DevPulidLoraPrompt, buildFlux2DevPulidPrompt, buildFlux2KleinPrompt, buildFluxDevPrompt, buildPulidFluxPrompt, buildZImageTurboPrompt, getAllWorkflows, getWorkflow, getWorkflowIds, getWorkflowJson, getWorkflowMetadata, getWorkflowsByCategory, searchWorkflowsByTag };