Skip to content
ContractSpec
Start here

Package manual · examples

·Examples and implementation patterns

example.content-generation

Content generation example using @lssm-tech/lib.content-gen.

examplesexamplev5.0.4stableservernode
@lssm-tech/example.content-generation
bun add @lssm-tech/example.content-generation
Package source ↗Manifest ↗

Manifest declarations describe the current workspace; they do not verify registry publication or runtime execution.

Package guide

Website: https://contractspec.io

Content generation example using @lssm-tech/lib.content-gen.

What This Demonstrates

  • Content generation pipeline with typed contracts.
  • Integration with the content-gen library.
  • Structured logging for generation steps.
  • DocBlock documentation for the generation flow.
  • Deterministic provider-free preview data for content, image, video, TTS, STT, and conversation workflow artifacts.
  • src/docs/ contains docblocks and documentation-facing exports.

Preview / export workflow

Content Generation previews use deterministic local pipeline fixtures for brief/prompt editing, generation review, publishing/version snapshots, and audit status. The ./ui export must not call LLM providers, production endpoints, or live storage.

The first-class preview packet covers these local artifact kinds:

  • content — blog, email, landing, social, and SEO draft outputs from typed briefs.
  • image — campaign hero image fixture references.
  • video — launch teaser storyboard fixture references.
  • tts — narration script fixture references.
  • stt — transcript fixture references.
  • conversation — human review assistant handoff fixture references.

Public key behavior is compatibility-sensitive because current catalog consumers may resolve both examples.content-generation and normalized keys. Document and test any alias migration before release. The Phase 0 compatibility gate lives in .omx/plans/content-generation-compatibility-matrix.md.

Compatibility / Migration Notes

  • Keep content-generation as the canonical feature key; any registry alias cleanup is major-version-only.
  • Prefer future contract-source imports from @lssm-tech/lib.contracts-spec/content-generation once the contracts lane lands them; existing @lssm-tech/lib.content-gen generator imports remain valid for this example.
  • Provider credentials are non-goals for this package. Real provider adapters belong in integration packages and are injected by apps/modules, while this example stays deterministic.
  • Keep this README synchronized with packages/apps/web-landing/public/llms-packages/example.content-generation.txt until generated docs own the mirror.

Running Locally

From examples/content-generation:

  • bun run dev
  • bun run build
  • bun run test
  • bun run typecheck

Usage

Use @lssm-tech/example.content-generation as a reference implementation, or import its exported surfaces into a workspace that composes ContractSpec examples and bundles.

Architecture

  • src/content-generation.feature.ts defines a feature entrypoint.
  • src/docs/ contains docblocks and documentation-facing exports.
  • src/example.ts is the runnable example entrypoint.
  • src/generate.ts is part of the package's public or composition surface.
  • src/index.ts is the root public barrel and package entrypoint.

Public Entry Points

  • Export . resolves through ./src/index.ts.
  • Export ./content-generation.feature resolves through ./src/content-generation.feature.ts.
  • Export ./docs resolves through ./src/docs/index.ts.
  • Export ./docs/content-generation.docblock is an alias of ./docs and resolves through ./src/docs/index.ts.
  • Export ./example resolves through ./src/example.ts.
  • Export ./generate resolves through ./src/generate.ts.
  • Export ./ui resolves through ./src/ui/index.ts.
  • Export ./ui/content-generation-preview.data resolves through ./src/ui/content-generation-preview.data.ts.
  • Export ./ui/ContentGenerationPreview resolves through ./src/ui/ContentGenerationPreview.tsx.

Local Commands

  • bun run dev — contractspec-bun-build dev
  • bun run build — contractspec-bun-build build
  • bun run test — bun test --pass-with-no-tests
  • bun run lint — bun lint:fix
  • bun run lint:check — biome check .
  • bun run lint:fix — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
  • bun run typecheck — tsgo --noEmit
  • bun run publish:pkg — bun publish --tolerate-republish --ignore-scripts --verbose
  • bun run publish:pkg:canary — bun publish:pkg --tag canary
  • bun run clean — rimraf dist .turbo
  • bun run build:bundle — contractspec-bun-build transpile
  • bun run build:types — contractspec-bun-build types
  • bun 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.content-gen, @lssm-tech/lib.contracts-spec, @lssm-tech/lib.logger, @lssm-tech/tool.bun, @lssm-tech/tool.typescript.

Relationships

THIS PACKAGEexample.content-generation9 import paths

Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.

6 declarations

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 --verbose
  • publish:pkg:canarybun publish:pkg --tag canary
  • buildcontractspec-bun-build build
  • build:bundlecontractspec-bun-build transpile
  • build:typescontractspec-bun-build types
  • devcontractspec-bun-build dev
  • cleanrimraf dist .turbo
  • lintbun lint:fix
  • lint: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-tests
  • prebuildcontractspec-bun-build prebuild
  • typechecktsgo --noEmit