@contractspec/example.video-api-showcase 2.3.0 → 2.5.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/.turbo/turbo-build.log +3 -3
- package/CHANGELOG.md +31 -0
- package/README.md +29 -0
- package/package.json +6 -6
package/.turbo/turbo-build.log
CHANGED
|
@@ -3,7 +3,7 @@ $ bun run prebuild && bun run build:bundle && bun run build:types
|
|
|
3
3
|
$ contractspec-bun-build prebuild
|
|
4
4
|
$ contractspec-bun-build transpile
|
|
5
5
|
[contractspec-bun-build] transpile target=bun root=src entries=6
|
|
6
|
-
Bundled 6 modules in
|
|
6
|
+
Bundled 6 modules in 12ms
|
|
7
7
|
|
|
8
8
|
./build-api-video.js 1.31 KB (entry point)
|
|
9
9
|
./index.js 7.41 KB (entry point)
|
|
@@ -13,7 +13,7 @@ Bundled 6 modules in 17ms
|
|
|
13
13
|
./sample-specs.js 2.22 KB (entry point)
|
|
14
14
|
|
|
15
15
|
[contractspec-bun-build] transpile target=node root=src entries=6
|
|
16
|
-
Bundled 6 modules in
|
|
16
|
+
Bundled 6 modules in 19ms
|
|
17
17
|
|
|
18
18
|
./build-api-video.js 1.31 KB (entry point)
|
|
19
19
|
./index.js 7.40 KB (entry point)
|
|
@@ -23,7 +23,7 @@ Bundled 6 modules in 17ms
|
|
|
23
23
|
./sample-specs.js 2.21 KB (entry point)
|
|
24
24
|
|
|
25
25
|
[contractspec-bun-build] transpile target=browser root=src entries=6
|
|
26
|
-
Bundled 6 modules in
|
|
26
|
+
Bundled 6 modules in 25ms
|
|
27
27
|
|
|
28
28
|
./build-api-video.js 1.31 KB (entry point)
|
|
29
29
|
./index.js 7.40 KB (entry point)
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,36 @@
|
|
|
1
1
|
# @contractspec/example.video-api-showcase
|
|
2
2
|
|
|
3
|
+
## 2.5.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- c83c323: feat: major change to content generation
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- Updated dependencies [4fa3bd4]
|
|
12
|
+
- Updated dependencies [63eee9b]
|
|
13
|
+
- Updated dependencies [284cbe2]
|
|
14
|
+
- Updated dependencies [c83c323]
|
|
15
|
+
- Updated dependencies [397b7c0]
|
|
16
|
+
- Updated dependencies [4d19382]
|
|
17
|
+
- @contractspec/lib.contracts-spec@2.5.0
|
|
18
|
+
- @contractspec/lib.contracts-integrations@2.5.0
|
|
19
|
+
- @contractspec/lib.video-gen@1.46.0
|
|
20
|
+
|
|
21
|
+
## 2.4.0
|
|
22
|
+
|
|
23
|
+
### Minor Changes
|
|
24
|
+
|
|
25
|
+
- chore: improve documentation
|
|
26
|
+
|
|
27
|
+
### Patch Changes
|
|
28
|
+
|
|
29
|
+
- Updated dependencies
|
|
30
|
+
- @contractspec/lib.contracts-integrations@2.4.0
|
|
31
|
+
- @contractspec/lib.contracts-spec@2.4.0
|
|
32
|
+
- @contractspec/lib.video-gen@1.45.0
|
|
33
|
+
|
|
3
34
|
## 2.3.0
|
|
4
35
|
|
|
5
36
|
### Minor Changes
|
package/README.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# @contractspec/example.video-api-showcase
|
|
2
|
+
|
|
3
|
+
Website: https://contractspec.io/
|
|
4
|
+
|
|
5
|
+
Generate API documentation videos from contract spec definitions using the `ApiOverview` composition.
|
|
6
|
+
|
|
7
|
+
This package demonstrates:
|
|
8
|
+
|
|
9
|
+
- Manually constructing a `VideoProject` from spec metadata (name, method, endpoint, code)
|
|
10
|
+
- Mapping API spec definitions to `ApiOverview` composition props
|
|
11
|
+
- Configuring render output with quality presets (draft/standard/high)
|
|
12
|
+
- Batch-building video projects for multiple specs with `buildApiVideoSuite`
|
|
13
|
+
|
|
14
|
+
## Quickstart
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { buildApiVideo, buildRenderConfig } from "@contractspec/example.video-api-showcase";
|
|
18
|
+
import { createUserSpec } from "@contractspec/example.video-api-showcase";
|
|
19
|
+
|
|
20
|
+
// Build a single video project from a spec definition
|
|
21
|
+
const project = buildApiVideo(createUserSpec);
|
|
22
|
+
|
|
23
|
+
// Configure rendering
|
|
24
|
+
const config = buildRenderConfig("./out/create-user.mp4", "standard");
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Three sample specs are included: `createUserSpec` (POST /api/users), `listTransactionsSpec` (GET /api/transactions), and `sendNotificationSpec` (POST /api/notifications).
|
|
28
|
+
|
|
29
|
+
This example uses manual `VideoProject` construction rather than the `VideoGenerator` pipeline -- ideal when the video structure is known ahead of time.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@contractspec/example.video-api-showcase",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.5.0",
|
|
4
4
|
"description": "Generate API documentation videos from contract spec definitions using the ApiOverview composition.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
@@ -71,13 +71,13 @@
|
|
|
71
71
|
"typecheck": "tsc --noEmit"
|
|
72
72
|
},
|
|
73
73
|
"dependencies": {
|
|
74
|
-
"@contractspec/lib.contracts-spec": "2.
|
|
75
|
-
"@contractspec/lib.contracts-integrations": "2.
|
|
76
|
-
"@contractspec/lib.video-gen": "1.
|
|
74
|
+
"@contractspec/lib.contracts-spec": "2.5.0",
|
|
75
|
+
"@contractspec/lib.contracts-integrations": "2.5.0",
|
|
76
|
+
"@contractspec/lib.video-gen": "1.46.0"
|
|
77
77
|
},
|
|
78
78
|
"devDependencies": {
|
|
79
|
-
"@contractspec/tool.typescript": "2.
|
|
80
|
-
"@contractspec/tool.bun": "2.
|
|
79
|
+
"@contractspec/tool.typescript": "2.5.0",
|
|
80
|
+
"@contractspec/tool.bun": "2.5.0",
|
|
81
81
|
"typescript": "^5.9.3"
|
|
82
82
|
},
|
|
83
83
|
"publishConfig": {
|