@contractspec/example.content-generation 3.7.6 → 3.7.10

package/.turbo/turbo-build.log

@@ -13,7 +13,7 @@ Bundled 6 modules in 18ms
   ./generate.js                        1.72 KB  (entry point)
 
 [contractspec-bun-build] transpile target=node root=src entries=6 noBundle=false
-Bundled 6 modules in 22ms
+Bundled 6 modules in 11ms
 
   ./content-generation.feature.js      0.61 KB  (entry point)
   ./index.js                           4.63 KB  (entry point)
@@ -23,7 +23,7 @@ Bundled 6 modules in 22ms
   ./generate.js                        1.71 KB  (entry point)
 
 [contractspec-bun-build] transpile target=browser root=src entries=6 noBundle=false
-Bundled 6 modules in 25ms
+Bundled 6 modules in 17ms
 
   ./content-generation.feature.js      0.61 KB  (entry point)
   ./index.js                           4.63 KB  (entry point)

package/AGENTS.md

@@ -1,31 +1,52 @@
-# AI Agent Guide -- `@contractspec/example.content-generation`
+# AI Agent Guide — `@contractspec/example.content-generation`
 
 Scope: `packages/examples/content-generation/*`
 
-Demonstrates AI-powered content generation using the content-gen lib with structured logging.
+Content generation example using @contractspec/lib.content-gen.
 
 ## Quick Context
 
-- **Layer**: example
-- **Related Packages**: `lib.contracts-spec`, `lib.content-gen`, `lib.logger`
+- Layer: `example`.
+- Package visibility: published package.
+- Primary consumers are example explorers, template authors, and documentation readers.
+- Related packages: `@contractspec/lib.content-gen`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.logger`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.
 
-## What This Demonstrates
+## Architecture
 
-- Content generation pipeline with typed contracts
-- Integration with the content-gen library
-- Structured logging for generation steps
-- DocBlock documentation for the generation flow
+- `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 Exports
+## Public Surface
 
-- `.` -- root barrel
-- `./docs` -- DocBlock documentation
-- `./example` -- runnable example entry point
-- `./generate` -- generation logic
+- 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` resolves through `./src/docs/content-generation.docblock.ts`.
+- Export `./example` resolves through `./src/example.ts`.
+- Export `./generate` resolves through `./src/generate.ts`.
+
+## Guardrails
+
+- Keep the example package demonstrative, buildable, and aligned with the exported feature surface.
+- Do not add hidden production assumptions that are not actually implemented in the example.
+- Changes here can affect downstream packages such as `@contractspec/lib.content-gen`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.logger`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.
+- Changes here can affect downstream packages such as `@contractspec/lib.content-gen`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.logger`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.
 
 ## Local Commands
 
-- Build: `bun run build`
-- Dev: `bun run dev`
-- Test: `bun test`
-- Typecheck: `bun run typecheck`
+- `bun run dev` — contractspec-bun-build dev
+- `bun run build` — bun run prebuild && bun run build:bundle && bun run build:types
+- `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` — tsc --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

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @contractspec/example.content-generation
 
+## 3.7.10
+
+### Patch Changes
+
+- 1a44cb6: feat: improve examples to increase coverage of Contracts type
+- Updated dependencies [1a44cb6]
+  - @contractspec/lib.contracts-spec@4.1.2
+  - @contractspec/lib.content-gen@3.7.10
+  - @contractspec/lib.logger@3.7.8
+
+## 3.7.9
+
+### Patch Changes
+
+- fix: release
+- Updated dependencies
+  - @contractspec/lib.contracts-spec@4.1.1
+  - @contractspec/lib.content-gen@3.7.9
+  - @contractspec/lib.logger@3.7.7
+
 ## 3.7.6
 
 ### Patch Changes
@@ -414,6 +434,7 @@
 - 7f3203a: fix: make workspace test runs resilient when packages have no tests
 
   Updates package test scripts to pass cleanly when no matching test files exist:
+
   - Uses `bun test --pass-with-no-tests` in Bun-based packages that currently ship without test files.
   - Uses `jest --passWithNoTests` for the UI kit web package.
   - Adds `.vscode-test.mjs` for `vscode-contractspec` so VS Code extension test runs have an explicit config and stop failing on missing default configuration.
@@ -776,14 +797,17 @@
   feat: Contract layers support (features, examples, app-configs)
 
   ### New CLI Commands
+
   - `contractspec list layers` - List all contract layers with filtering
 
   ### Enhanced Commands
+
   - `contractspec ci` - New `layers` check category validates features/examples/config
   - `contractspec doctor` - New `layers` health checks
   - `contractspec integrity` - Now shows layer statistics
 
   ### New APIs
+
   - `discoverLayers()` - Scan workspace for all layer files
   - `scanExampleSource()` - Parse ExampleSpec from source code
   - `isExampleFile()` - Check if file is an example spec

package/README.md

@@ -1,14 +1,68 @@
-# Content Generation Example
+# @contractspec/example.content-generation
 
-Website: https://contractspec.io/
+Website: https://contractspec.io
 
+**Content generation example using @contractspec/lib.content-gen.**
 
-Shows how to take a ContractSpec content brief and produce marketing assets with `@contractspec/lib.content-gen`.
+## What This Demonstrates
 
-## Generates
+- Content generation pipeline with typed contracts.
+- Integration with the content-gen library.
+- Structured logging for generation steps.
+- DocBlock documentation for the generation flow.
+- `src/docs/` contains docblocks and documentation-facing exports.
+- `src/docs/` contains docblocks and documentation-facing exports.
 
-- Long-form blog post
-- Landing page hero copy
-- Email announcement
-- Social posts
-- SEO metadata
+## Running Locally
+
+From `packages/examples/content-generation`:
+- `bun run dev`
+- `bun run build`
+- `bun run test`
+- `bun run typecheck`
+
+## Usage
+
+Use `@contractspec/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` resolves through `./src/docs/content-generation.docblock.ts`.
+- Export `./example` resolves through `./src/example.ts`.
+- Export `./generate` resolves through `./src/generate.ts`.
+
+## Local Commands
+
+- `bun run dev` — contractspec-bun-build dev
+- `bun run build` — bun run prebuild && bun run build:bundle && bun run build:types
+- `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` — tsc --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 `@contractspec/lib.content-gen`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.logger`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export * from './generate';
 export * from './content-generation.feature';
 export { default as example } from './example';
+export * from './generate';
 import './docs';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contractspec/example.content-generation",
-  "version": "3.7.6",
+  "version": "3.7.10",
   "description": "Content generation example using @contractspec/lib.content-gen.",
   "type": "module",
   "types": "./dist/index.d.ts",
@@ -57,21 +57,21 @@
     "dev": "contractspec-bun-build dev",
     "clean": "rimraf dist .turbo",
     "lint": "bun lint:fix",
-    "lint:fix": "eslint src --fix",
-    "lint:check": "eslint src",
+    "lint:fix": "biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .",
+    "lint:check": "biome check .",
     "test": "bun test --pass-with-no-tests",
     "prebuild": "contractspec-bun-build prebuild",
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@contractspec/lib.contracts-spec": "3.7.6",
-    "@contractspec/lib.content-gen": "3.7.6",
-    "@contractspec/lib.logger": "3.7.6"
+    "@contractspec/lib.contracts-spec": "4.1.2",
+    "@contractspec/lib.content-gen": "3.7.10",
+    "@contractspec/lib.logger": "3.7.8"
   },
   "devDependencies": {
-    "@contractspec/tool.typescript": "3.7.6",
+    "@contractspec/tool.typescript": "3.7.8",
     "typescript": "^5.9.3",
-    "@contractspec/tool.bun": "3.7.6"
+    "@contractspec/tool.bun": "3.7.8"
   },
   "publishConfig": {
     "access": "public",

package/src/content-generation.feature.ts

@@ -1,20 +1,20 @@
 import { defineFeature } from '@contractspec/lib.contracts-spec';
 
 export const ContentGenerationFeature = defineFeature({
-  meta: {
-    key: 'content-generation',
-    version: '1.0.0',
-    title: 'Content Generation',
-    description:
-      'AI content generation for blog posts, landing pages, emails, and social media',
-    domain: 'content',
-    owners: ['@examples'],
-    tags: ['content', 'ai', 'generation'],
-    stability: 'experimental',
-  },
+	meta: {
+		key: 'content-generation',
+		version: '1.0.0',
+		title: 'Content Generation',
+		description:
+			'AI content generation for blog posts, landing pages, emails, and social media',
+		domain: 'content',
+		owners: ['@examples'],
+		tags: ['content', 'ai', 'generation'],
+		stability: 'experimental',
+	},
 
-  docs: [
-    'docs.examples.content-generation',
-    'docs.examples.content-generation.usage',
-  ],
+	docs: [
+		'docs.examples.content-generation',
+		'docs.examples.content-generation.usage',
+	],
 });

package/src/docs/content-generation.docblock.ts

@@ -2,27 +2,27 @@ import type { DocBlock } from '@contractspec/lib.contracts-spec/docs';
 import { registerDocBlocks } from '@contractspec/lib.contracts-spec/docs';
 
 const blocks: DocBlock[] = [
-  {
-    id: 'docs.examples.content-generation',
-    title: 'Content Generation (example)',
-    summary:
-      'Generate a consistent set of marketing assets from a typed ContentBrief (blog, landing hero, email, social, SEO).',
-    kind: 'reference',
-    visibility: 'public',
-    route: '/docs/examples/content-generation',
-    tags: ['content', 'marketing', 'example'],
-    body: `## What this example shows\n- A spec-first-ish interface for content brief inputs (typed, validated).\n- Deterministic orchestration of generators (same input → same structure).\n\n## Outputs\n- Blog intro\n- Landing hero\n- Email subject/body\n- Social post bodies\n- SEO metadata`,
-  },
-  {
-    id: 'docs.examples.content-generation.usage',
-    title: 'Content Generation — Usage',
-    summary: 'How to run the example and extend the brief.',
-    kind: 'usage',
-    visibility: 'public',
-    route: '/docs/examples/content-generation/usage',
-    tags: ['content', 'usage'],
-    body: `## Usage\n- Call \`runContentGenerationExample()\`.\n- Modify the \`ContentBrief\` fields to drive different outputs.\n\n## Guardrails\n- Avoid PII in briefs.\n- Keep output logging structured; no raw \`console.log\` in library code.`,
-  },
+	{
+		id: 'docs.examples.content-generation',
+		title: 'Content Generation (example)',
+		summary:
+			'Generate a consistent set of marketing assets from a typed ContentBrief (blog, landing hero, email, social, SEO).',
+		kind: 'reference',
+		visibility: 'public',
+		route: '/docs/examples/content-generation',
+		tags: ['content', 'marketing', 'example'],
+		body: `## What this example shows\n- A spec-first-ish interface for content brief inputs (typed, validated).\n- Deterministic orchestration of generators (same input → same structure).\n\n## Outputs\n- Blog intro\n- Landing hero\n- Email subject/body\n- Social post bodies\n- SEO metadata`,
+	},
+	{
+		id: 'docs.examples.content-generation.usage',
+		title: 'Content Generation — Usage',
+		summary: 'How to run the example and extend the brief.',
+		kind: 'usage',
+		visibility: 'public',
+		route: '/docs/examples/content-generation/usage',
+		tags: ['content', 'usage'],
+		body: `## Usage\n- Call \`runContentGenerationExample()\`.\n- Modify the \`ContentBrief\` fields to drive different outputs.\n\n## Guardrails\n- Avoid PII in briefs.\n- Keep output logging structured; no raw \`console.log\` in library code.`,
+	},
 ];
 
 registerDocBlocks(blocks);

package/src/example.ts

@@ -1,32 +1,32 @@
 import { defineExample } from '@contractspec/lib.contracts-spec';
 
 const example = defineExample({
-  meta: {
-    key: 'content-generation',
-    version: '1.0.0',
-    title: 'Content Generation',
-    description:
-      'Generate blog/landing/email/social/SEO assets from a typed ContentBrief using @contractspec/lib.content-gen.',
-    kind: 'script',
-    visibility: 'public',
-    stability: 'experimental',
-    owners: ['@platform.core'],
-    tags: ['content', 'marketing', 'generation', 'ai'],
-  },
-  docs: {
-    rootDocId: 'docs.examples.content-generation',
-    usageDocId: 'docs.examples.content-generation.usage',
-  },
-  entrypoints: {
-    packageName: '@contractspec/example.content-generation',
-    docs: './docs',
-  },
-  surfaces: {
-    templates: true,
-    sandbox: { enabled: true, modes: ['markdown'] },
-    studio: { enabled: true, installable: true },
-    mcp: { enabled: true },
-  },
+	meta: {
+		key: 'content-generation',
+		version: '1.0.0',
+		title: 'Content Generation',
+		description:
+			'Generate blog/landing/email/social/SEO assets from a typed ContentBrief using @contractspec/lib.content-gen.',
+		kind: 'script',
+		visibility: 'public',
+		stability: 'experimental',
+		owners: ['@platform.core'],
+		tags: ['content', 'marketing', 'generation', 'ai'],
+	},
+	docs: {
+		rootDocId: 'docs.examples.content-generation',
+		usageDocId: 'docs.examples.content-generation.usage',
+	},
+	entrypoints: {
+		packageName: '@contractspec/example.content-generation',
+		docs: './docs',
+	},
+	surfaces: {
+		templates: true,
+		sandbox: { enabled: true, modes: ['markdown'] },
+		studio: { enabled: true, installable: true },
+		mcp: { enabled: true },
+	},
 });
 
 export default example;

package/src/generate.ts

@@ -1,54 +1,54 @@
+import type { ContentBrief } from '@contractspec/lib.content-gen';
 import {
-  BlogGenerator,
-  EmailCampaignGenerator,
-  LandingPageGenerator,
-  SocialPostGenerator,
+	BlogGenerator,
+	EmailCampaignGenerator,
+	LandingPageGenerator,
+	SocialPostGenerator,
 } from '@contractspec/lib.content-gen/generators';
 import { SeoOptimizer } from '@contractspec/lib.content-gen/seo';
-import type { ContentBrief } from '@contractspec/lib.content-gen';
 import { Logger, LogLevel } from '@contractspec/lib.logger';
 import type { LoggerConfig } from '@contractspec/lib.logger/types';
 
 const logger = new Logger({
-  level: process.env.NODE_ENV === 'production' ? LogLevel.INFO : LogLevel.DEBUG,
-  environment:
-    (process.env.NODE_ENV as LoggerConfig['environment']) || 'development',
-  enableColors: process.env.NODE_ENV !== 'production',
+	level: process.env.NODE_ENV === 'production' ? LogLevel.INFO : LogLevel.DEBUG,
+	environment:
+		(process.env.NODE_ENV as LoggerConfig['environment']) || 'development',
+	enableColors: process.env.NODE_ENV !== 'production',
 });
 
 export async function runContentGenerationExample(): Promise<void> {
-  const brief: ContentBrief = {
-    title: 'AI-Native Operations Copilot',
-    summary:
-      'Automates support resolutions, growth playbooks, and DevOps rituals.',
-    problems: [
-      'Support queues pile up after hours',
-      'Growth teams lack fresh experiments',
-    ],
-    solutions: [
-      'Stateful AI agents grounded in your knowledge spaces',
-      'CI-safe approval workflows for human review',
-      'Analytics + experimentation stack built into ContractSpec',
-    ],
-    metrics: ['80% auto-resolution rate', '10+ experiments shipped weekly'],
-    audience: { role: 'COO', industry: 'Fintech', maturity: 'scaleup' },
-    callToAction: 'Book a 15‑minute pilot run',
-  };
+	const brief: ContentBrief = {
+		title: 'AI-Native Operations Copilot',
+		summary:
+			'Automates support resolutions, growth playbooks, and DevOps rituals.',
+		problems: [
+			'Support queues pile up after hours',
+			'Growth teams lack fresh experiments',
+		],
+		solutions: [
+			'Stateful AI agents grounded in your knowledge spaces',
+			'CI-safe approval workflows for human review',
+			'Analytics + experimentation stack built into ContractSpec',
+		],
+		metrics: ['80% auto-resolution rate', '10+ experiments shipped weekly'],
+		audience: { role: 'COO', industry: 'Fintech', maturity: 'scaleup' },
+		callToAction: 'Book a 15‑minute pilot run',
+	};
 
-  const blog = await new BlogGenerator().generate(brief);
-  const landing = await new LandingPageGenerator().generate(brief);
-  const email = await new EmailCampaignGenerator().generate({
-    brief,
-    variant: 'announcement',
-  });
-  const social = await new SocialPostGenerator().generate(brief);
-  const seo = new SeoOptimizer().optimize(brief);
+	const blog = await new BlogGenerator().generate(brief);
+	const landing = await new LandingPageGenerator().generate(brief);
+	const email = await new EmailCampaignGenerator().generate({
+		brief,
+		variant: 'announcement',
+	});
+	const social = await new SocialPostGenerator().generate(brief);
+	const seo = new SeoOptimizer().optimize(brief);
 
-  logger.info('Generated content assets', {
-    blogIntro: blog.intro,
-    landingHero: landing.hero,
-    emailSubject: email.subject,
-    socialPosts: social.map((post) => post.body),
-    seo,
-  });
+	logger.info('Generated content assets', {
+		blogIntro: blog.intro,
+		landingHero: landing.hero,
+		emailSubject: email.subject,
+		socialPosts: social.map((post) => post.body),
+		seo,
+	});
 }

package/src/index.ts

@@ -1,4 +1,4 @@
-export * from './generate';
 export * from './content-generation.feature';
 export { default as example } from './example';
+export * from './generate';
 import './docs';

package/tsconfig.json

@@ -1,11 +1,9 @@
 {
-  "extends": "@contractspec/tool.typescript/react-library.json",
-  "include": ["src"],
-  "exclude": ["node_modules", "dist"],
-  "compilerOptions": {
-    "rootDir": "src",
-    "outDir": "dist"
-  }
+	"extends": "@contractspec/tool.typescript/react-library.json",
+	"include": ["src"],
+	"exclude": ["node_modules", "dist"],
+	"compilerOptions": {
+		"rootDir": "src",
+		"outDir": "dist"
+	}
 }
-
-

package/tsdown.config.js

@@ -1,5 +1,5 @@
 import { defineConfig, moduleLibrary } from '@contractspec/tool.bun';
 
 export default defineConfig(() => ({
-  ...moduleLibrary,
+	...moduleLibrary,
 }));