example.video-api-showcase
Generate API documentation videos from contract spec definitions using the ApiOverview composition.
@lssm-tech/example.video-api-showcasebun add @lssm-tech/example.video-api-showcaseManifest declarations describe the current workspace; they do not verify registry publication or runtime execution.
Package guide
Website: https://contractspec.io
Generate API documentation videos from contract spec definitions using the ApiOverview composition.
What This Demonstrates
- Video generation pipeline from contract specs.
- ApiOverview composition pattern.
- Sample spec definitions for video input.
src/docs/contains docblocks and documentation-facing exports.src/docs/contains docblocks and documentation-facing exports.
Running Locally
From examples/video-api-showcase:
bun run devbun run buildbun run testbun run typecheck
Usage
Use @lssm-tech/example.video-api-showcase as a reference implementation, or import its exported surfaces into a workspace that composes ContractSpec examples and bundles.
Architecture
src/build-api-video.tsis part of the package's public or composition surface.src/docs/contains docblocks and documentation-facing exports.src/example.tsis the runnable example entrypoint.src/index.tsis the root public barrel and package entrypoint.src/sample-specs.tsis part of the package's public or composition surface.src/video-api-showcase.feature.tsdefines a feature entrypoint.
Public Entry Points
- Export
.resolves through./src/index.ts. - Export
./build-api-videoresolves through./src/build-api-video.ts. - Export
./docsresolves through./src/docs/index.ts. - Export
./docs/video-api-showcase.docblockis an alias of./docsand resolves through./src/docs/index.ts. - Export
./exampleresolves through./src/example.ts. - Export
./sample-specsresolves through./src/sample-specs.ts. - Export
./video-api-showcase.featureresolves through./src/video-api-showcase.feature.ts.
Local Commands
bun run dev— contractspec-bun-build devbun run build— contractspec-bun-build buildbun run test— bun test --pass-with-no-testsbun run lint— bun lint:fixbun run lint:check— biome check .bun run lint:fix— biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .bun run typecheck— tsgo --noEmitbun run publish:pkg— bun publish --tolerate-republish --ignore-scripts --verbosebun run publish:pkg:canary— bun publish:pkg --tag canarybun run clean— rimraf dist .turbobun run build:bundle— contractspec-bun-build transpilebun run build:types— contractspec-bun-build typesbun run prebuild— contractspec-bun-build prebuild
Recent Updates
- Replace eslint+prettier by biomejs to optimize speed.
- Missing contract layers.
Notes
- Works alongside
@lssm-tech/lib.contracts-integrations,@lssm-tech/lib.contracts-spec,@lssm-tech/lib.video-gen,@lssm-tech/tool.bun,@lssm-tech/tool.typescript.
Relationships
Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.
3 declarations
@lssm-tech/lib.contracts-specworkspace:^
Read the package manual ↗@lssm-tech/lib.contracts-integrationsworkspace:^
Read the package manual ↗@lssm-tech/lib.video-genworkspace:^
Read the package manual ↗
Declared capabilities
This manifest does not declare a capability catalogue. Use the guide, import map and source to assess the package.
Scripts
publish:pkgbun publish --tolerate-republish --ignore-scripts --verbosepublish:pkg:canarybun publish:pkg --tag canarybuildcontractspec-bun-build buildbuild:bundlecontractspec-bun-build transpilebuild:typescontractspec-bun-build typesdevcontractspec-bun-build devcleanrimraf dist .turbolintbun lint:fixlint:fixnode ../../scripts/biome.cjs check --write --unsafe --only=nursery/useSortedClasses . && node ../../scripts/biome.cjs check --write .lint:checknode ../../scripts/biome.cjs check .testbun test --pass-with-no-testsprebuildcontractspec-bun-build prebuildtypechecktsgo --noEmit