@genfeedai/workflows 0.3.0 → 0.3.1

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.
Files changed (2) hide show
  1. package/README.md +14 -94
  2. package/package.json +4 -2
package/README.md CHANGED
@@ -1,112 +1,32 @@
1
1
  # @genfeedai/workflows
2
2
 
3
- Official workflow templates for Genfeed - the AI-first content creation platform.
3
+ Official Genfeed workflow templates and registry helpers.
4
4
 
5
- ## Installation
5
+ ## Install
6
6
 
7
7
  ```bash
8
- npm install @genfeedai/workflows
9
- # or
10
- bun add @genfeedai/workflows
8
+ npm i @genfeedai/workflows
11
9
  ```
12
10
 
13
11
  ## Usage
14
12
 
15
- ### Using the Registry
16
-
17
- ```typescript
18
- import {
19
- WORKFLOW_REGISTRY,
20
- getWorkflowIds,
21
- getWorkflowMetadata,
22
- getWorkflowsByCategory,
23
- searchWorkflowsByTag,
24
- } from '@genfeedai/workflows';
25
-
26
- // List all workflow IDs
27
- const ids = getWorkflowIds();
28
- // ['single-image', 'single-video', 'image-series', ...]
29
-
30
- // Get metadata for a specific workflow
31
- const metadata = getWorkflowMetadata('single-image');
32
- // { id: 'single-image', name: 'Single Image Generation', ... }
33
-
34
- // Get workflows by category
35
- const imageWorkflows = getWorkflowsByCategory('image');
36
-
37
- // Search by tag
38
- const simpleWorkflows = searchWorkflowsByTag('simple');
39
- ```
40
-
41
- ### Accessing Workflow Files
42
-
43
- The actual workflow JSON files are in the `workflows/` directory:
44
-
45
- ```typescript
13
+ ```ts
14
+ import { WORKFLOW_REGISTRY, getWorkflowMetadata } from '@genfeedai/workflows';
46
15
  import singleImage from '@genfeedai/workflows/workflows/single-image.json';
47
- import singleVideo from '@genfeedai/workflows/workflows/single-video.json';
48
- ```
49
-
50
- ## Available Workflows
51
-
52
- ### Image Workflows
53
-
54
- | ID | Name | Description |
55
- |----|------|-------------|
56
- | `single-image` | Single Image Generation | Generate an AI image from a source image (img2img) |
57
- | `image-series` | Image Series | Generate related images using LLM expansion |
58
16
 
59
- ### Video Workflows
60
-
61
- | ID | Name | Description |
62
- |----|------|-------------|
63
- | `single-video` | Single Video Generation | Generate a video from a source image (img2video) |
64
- | `image-to-video` | Image to Video | Create interpolated video between two images |
65
-
66
- ### Full Pipeline Workflows
67
-
68
- | ID | Name | Description |
69
- |----|------|-------------|
70
- | `full-pipeline` | Full Content Pipeline | Complete workflow: concept → images → videos → stitched output |
71
-
72
- ## Workflow Schema
73
-
74
- Each workflow follows the `WorkflowFile` interface from `@genfeedai/types`:
75
-
76
- ```typescript
77
- interface WorkflowFile {
78
- version: number;
79
- name: string;
80
- description: string;
81
- nodes: WorkflowNode[];
82
- edges: WorkflowEdge[];
83
- edgeStyle: 'bezier' | 'smoothstep' | 'straight';
84
- groups?: NodeGroup[];
85
- createdAt: string;
86
- updatedAt: string;
87
- }
17
+ const meta = getWorkflowMetadata('single-image');
18
+ console.log(meta?.title, singleImage.nodes.length);
88
19
  ```
89
20
 
90
- ## Contributing
21
+ ## Related Packages
91
22
 
92
- See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on submitting new workflows.
93
-
94
- ## License
95
-
96
- AGPL-3.0
23
+ - `@genfeedai/types`
24
+ - `@genfeedai/prompts`
97
25
 
26
+ ## Build Faster with Genfeed
98
27
 
99
- ## Extension & Engine Contracts
28
+ Use production-ready templates in code, or run them in Genfeed at [https://genfeed.ai](https://genfeed.ai).
100
29
 
101
- Use shared contracts for workflow engines and cloud extension packs:
102
-
103
- ```typescript
104
- import type {
105
- ExecutableWorkflow,
106
- NodeDefinition,
107
- ExtensionPack,
108
- NodeRegistry,
109
- } from '@genfeedai/workflows/contracts';
110
- ```
30
+ ## License
111
31
 
112
- These contracts are designed so private/cloud node packs can extend public core workflows without forking type definitions.
32
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@genfeedai/workflows",
3
- "version": "0.3.0",
3
+ "version": "0.3.1",
4
4
  "sideEffects": false,
5
5
  "license": "AGPL-3.0",
6
6
  "repository": {
@@ -37,13 +37,15 @@
37
37
  "workflows",
38
38
  "metadata"
39
39
  ],
40
+ "dependencies": {
41
+ "@genfeedai/types": "^0.2.2"
42
+ },
40
43
  "scripts": {
41
44
  "build": "tsup src/index.ts src/contracts/index.ts --format esm,cjs --dts --clean",
42
45
  "dev": "tsup src/index.ts src/contracts/index.ts --format esm,cjs --dts --watch",
43
46
  "prepublishOnly": "bun run build"
44
47
  },
45
48
  "devDependencies": {
46
- "@genfeedai/types": "^0.2.0",
47
49
  "@types/node": "^25.2.3",
48
50
  "tsup": "8.4.0",
49
51
  "typescript": "5.9.3"