@teamflojo/floimg-studio-shared 0.2.0 → 0.2.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.
- package/README.md +64 -0
- package/package.json +3 -2
package/README.md
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# @teamflojo/floimg-studio-shared
|
|
2
|
+
|
|
3
|
+
Shared TypeScript types for FloImg Studio frontend and backend.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @teamflojo/floimg-studio-shared
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type {
|
|
15
|
+
StudioNode,
|
|
16
|
+
StudioEdge,
|
|
17
|
+
StudioWorkflow,
|
|
18
|
+
ExecutionResult,
|
|
19
|
+
NodeDefinition,
|
|
20
|
+
} from "@teamflojo/floimg-studio-shared";
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Exports
|
|
24
|
+
|
|
25
|
+
### Node Types
|
|
26
|
+
|
|
27
|
+
- `StudioNode` — A node in the visual editor
|
|
28
|
+
- `StudioEdge` — A connection between nodes
|
|
29
|
+
- `StudioNodeType` — Node type enum: `generator`, `transform`, `save`, `input`, `vision`, `text`
|
|
30
|
+
- `GeneratorNodeData`, `TransformNodeData`, `SaveNodeData`, `InputNodeData`, `VisionNodeData`, `TextNodeData`
|
|
31
|
+
|
|
32
|
+
### Workflow Types
|
|
33
|
+
|
|
34
|
+
- `StudioWorkflow` — A complete workflow definition
|
|
35
|
+
- `GalleryTemplate` — A bundled workflow template
|
|
36
|
+
|
|
37
|
+
### Execution Types
|
|
38
|
+
|
|
39
|
+
- `ExecutionResult` — Full execution result
|
|
40
|
+
- `ExecutionStepResult` — Result from a single step
|
|
41
|
+
- `ExecutionStatus` — Status enum: `pending`, `running`, `completed`, `error`, `cancelled`
|
|
42
|
+
|
|
43
|
+
### WebSocket Events
|
|
44
|
+
|
|
45
|
+
- `WSEvent`, `WSExecutionStarted`, `WSExecutionStep`, `WSExecutionCompleted`, `WSExecutionError`
|
|
46
|
+
|
|
47
|
+
### API Types
|
|
48
|
+
|
|
49
|
+
- `CreateWorkflowRequest`, `ExecuteRequest`, `ExecuteResponse`
|
|
50
|
+
- `GenerateWorkflowRequest`, `GenerateWorkflowResponse` — AI workflow generation
|
|
51
|
+
|
|
52
|
+
### Schema Types
|
|
53
|
+
|
|
54
|
+
- `NodeDefinition` — Node definition for the palette
|
|
55
|
+
- `ParamSchema`, `ParamField` — Parameter schemas for dynamic forms
|
|
56
|
+
- `OutputSchema`, `OutputProperty` — Output schemas for structured JSON
|
|
57
|
+
|
|
58
|
+
## Related Packages
|
|
59
|
+
|
|
60
|
+
- [@teamflojo/floimg-studio-ui](https://www.npmjs.com/package/@teamflojo/floimg-studio-ui) — React components
|
|
61
|
+
|
|
62
|
+
## License
|
|
63
|
+
|
|
64
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@teamflojo/floimg-studio-shared",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"description": "Shared types and utilities for FloImg Studio",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -20,7 +20,8 @@
|
|
|
20
20
|
}
|
|
21
21
|
},
|
|
22
22
|
"files": [
|
|
23
|
-
"dist"
|
|
23
|
+
"dist",
|
|
24
|
+
"README.md"
|
|
24
25
|
],
|
|
25
26
|
"devDependencies": {
|
|
26
27
|
"typescript": "^5.7.2"
|