@lssm/example.openbanking-powens 0.0.0-canary-20251217060834 → 0.0.0-canary-20251217073102
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$colon$bundle.log +75 -32
- package/.turbo/turbo-build.log +29 -33
- package/CHANGELOG.md +4 -3
- package/dist/docs/index.js +1 -1
- package/dist/docs/openbanking-powens.docblock.js +28 -12
- package/dist/example.js +39 -1
- package/dist/handlers/oauth-callback.js +63 -1
- package/dist/handlers/webhook-handler.js +87 -1
- package/dist/index.js +6 -1
- package/dist/integrations/providers-impls/dist/impls/powens-client.js +171 -0
- package/dist/integrations/providers-impls/dist/impls/powens-openbanking.js +218 -0
- package/dist/libs/contracts/dist/docs/PUBLISHING.docblock.js +16 -0
- package/dist/libs/contracts/dist/docs/accessibility_wcag_compliance_specs.docblock.js +16 -0
- package/dist/libs/contracts/dist/docs/index.js +29 -0
- package/dist/libs/contracts/dist/docs/presentations.js +71 -0
- package/dist/libs/contracts/dist/docs/registry.js +44 -0
- package/dist/libs/contracts/dist/docs/tech/PHASE_1_QUICKSTART.docblock.js +16 -0
- package/dist/libs/contracts/dist/docs/tech/PHASE_2_AI_NATIVE_OPERATIONS.docblock.js +16 -0
- package/dist/libs/contracts/dist/docs/tech/PHASE_3_AUTO_EVOLUTION.docblock.js +16 -0
- package/dist/libs/contracts/dist/docs/tech/PHASE_4_PERSONALIZATION_ENGINE.docblock.js +16 -0
- package/dist/libs/contracts/dist/docs/tech/PHASE_5_ZERO_TOUCH_OPERATIONS.docblock.js +16 -0
- package/dist/libs/contracts/dist/docs/tech/auth/better-auth-nextjs.docblock.js +80 -0
- package/dist/libs/contracts/dist/docs/tech/contracts/openapi-export.docblock.js +57 -0
- package/dist/libs/contracts/dist/docs/tech/lifecycle-stage-system.docblock.js +16 -0
- package/dist/libs/contracts/dist/docs/tech/llm/llm-integration.docblock.js +357 -0
- package/dist/libs/contracts/dist/docs/tech/mcp-endpoints.docblock.js +37 -0
- package/dist/libs/contracts/dist/docs/tech/presentation-runtime.docblock.js +16 -0
- package/dist/libs/contracts/dist/docs/tech/schema/README.docblock.js +20 -0
- package/dist/libs/contracts/dist/docs/tech/studio/learning-events.docblock.js +48 -0
- package/dist/libs/contracts/dist/docs/tech/studio/learning-journeys.docblock.js +79 -0
- package/dist/libs/contracts/dist/docs/tech/studio/platform-admin-panel.docblock.js +84 -0
- package/dist/libs/contracts/dist/docs/tech/studio/project-access-teams.docblock.js +45 -0
- package/dist/libs/contracts/dist/docs/tech/studio/project-routing.docblock.js +67 -0
- package/dist/libs/contracts/dist/docs/tech/studio/sandbox-unlogged.docblock.js +40 -0
- package/dist/libs/contracts/dist/docs/tech/studio/team-invitations.docblock.js +69 -0
- package/dist/libs/contracts/dist/docs/tech/studio/workspace-ops.docblock.js +47 -0
- package/dist/libs/contracts/dist/docs/tech/studio/workspaces.docblock.js +62 -0
- package/dist/libs/contracts/dist/docs/tech/telemetry-ingest.docblock.js +155 -0
- package/dist/libs/contracts/dist/docs/tech/templates/runtime.docblock.js +20 -0
- package/dist/libs/contracts/dist/docs/tech/vscode-extension.docblock.js +101 -0
- package/dist/libs/contracts/dist/docs/tech/workflows/overview.docblock.js +20 -0
- package/package.json +6 -5
- package/tsconfig.tsbuildinfo +1 -1
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { registerDocBlocks } from "../registry.js";
|
|
2
|
+
|
|
3
|
+
//#region ../../libs/contracts/dist/docs/tech/PHASE_3_AUTO_EVOLUTION.docblock.js
|
|
4
|
+
const tech_PHASE_3_AUTO_EVOLUTION_DocBlocks = [{
|
|
5
|
+
id: "docs.tech.PHASE_3_AUTO_EVOLUTION",
|
|
6
|
+
title: "Phase 3: Auto-Evolution Technical Notes",
|
|
7
|
+
summary: "**Status**: In progress",
|
|
8
|
+
kind: "reference",
|
|
9
|
+
visibility: "public",
|
|
10
|
+
route: "/docs/tech/PHASE_3_AUTO_EVOLUTION",
|
|
11
|
+
tags: ["tech", "PHASE_3_AUTO_EVOLUTION"],
|
|
12
|
+
body: "# Phase 3: Auto-Evolution Technical Notes\n\n**Status**: In progress \n**Last updated**: 2025-11-21 \n\nPhase 3 introduces self-learning capabilities that analyze production telemetry, suggest new specs, safely roll out variants, and generate golden tests from real traffic. This document captures the main building blocks delivered in this iteration.\n\n---\n\n## 1. Libraries\n\n### @lssm/lib.evolution\n\n- `SpecAnalyzer` converts raw telemetry samples into usage stats + anomalies.\n- `SpecGenerator` produces `SpecSuggestion` objects and validates confidence thresholds.\n- `SpecSuggestionOrchestrator` routes proposals through the AI approval workflow and writes approved specs to `packages/libs/contracts/src/generated`.\n- Storage adapters:\n - `InMemorySpecSuggestionRepository` for tests.\n - `PrismaSpecSuggestionRepository` persists to the new Prisma model (see §4).\n - `FileSystemSuggestionWriter` emits JSON envelopes for git review.\n\n### @lssm/lib.observability\n\n- Added intent detection modules:\n - `IntentAggregator` batches telemetry into rolling windows.\n - `IntentDetector` surfaces latency/error/throughput regressions and sequential intents.\n- `EvolutionPipeline` orchestrates aggregation → detection → intent events and exposes hooks for downstream orchestrators.\n- `createTracingMiddleware` now accepts `resolveOperation`/`onSample` hooks to feed telemetry samples into the pipeline.\n\n### @lssm/lib.growth\n\n- New `spec-experiments` module:\n - `SpecExperimentRegistry`, `SpecExperimentRunner`, `SpecExperimentAdapter`.\n - `SpecExperimentAnalyzer` + `SpecExperimentController` handle guardrails and staged rollouts.\n - Helper `createSpecVariantResolver` plugs directly into `HandlerCtx.specVariantResolver`.\n- `SpecVariantResolver` is now a first-class concept in `@lssm/lib.contracts`. The runtime will attempt to execute variant specs before falling back to the registered handler.\n\n### @lssm/lib.testing\n\n- `TrafficRecorder` + `TrafficStore` capture production requests with sampling and sanitization hooks.\n- `GoldenTestGenerator` converts `TrafficSnapshot`s into Vitest/Jest suites.\n- `generateVitestSuite` / `generateJestSuite` output self-contained test files, and `runGoldenTests` offers a programmatic harness for CI pipelines.\n\n---\n\n## 2. Telemetry → Intent → Spec Pipeline\n\n1. `createTracingMiddleware({ onSample })` emits `TelemetrySample`s for every HTTP request.\n2. `IntentAggregator` groups samples into statistical windows (default 15 minutes).\n3. `IntentDetector` raises signals for:\n - Error spikes\n - Latency regressions\n - Throughput drops\n - Sequential workflows that hint at missing specs\n4. `EvolutionPipeline` emits `intent.detected` events and hands them to `SpecGenerator`.\n5. `SpecSuggestionOrchestrator` persists suggestions, triggers approval workflows, and—upon approval—writes JSON envelopes to `packages/.../contracts/src/generated`.\n\n---\n\n## 3. Spec Experiments & Rollouts\n\n1. Register spec experiments in `SpecExperimentRegistry` with control + variant bindings.\n2. Expose bucketed specs by attaching `createSpecVariantResolver` to `HandlerCtx.specVariantResolver` inside adapters.\n3. Record outcomes via `SpecExperimentAdapter.trackOutcome()` (latency + error metrics).\n4. `SpecExperimentController` uses guardrails from config and `SpecExperimentAnalyzer` to:\n - Auto-rollback on error/latency breaches.\n - Advance rollout stages (1% → 10% → 50% → 100%) when metrics stay green.\n\n---\n\n## 4. Data Models (Prisma)\n\nFile: `packages/libs/database/prisma/schema.prisma`\n\n- `SpecSuggestion` – stores serialized suggestion payloads + statuses.\n- `IntentSnapshot` – captured detector output for auditing/training.\n- `TrafficSnapshot` – persisted production traffic (input/output/error blobs).\n- `SpecExperiment` / `SpecExperimentMetric` – rollout state + metrics for each variant.\n\n> Run `bun database generate` after pulling to refresh the Prisma client.\n\n---\n\n## 5. Golden Test Workflow\n\n1. Capture traffic via middleware or direct `TrafficRecorder.record`.\n2. Use the new CLI command to materialize suites:\n\n```bash\ncontractspec test generate \\\n --operation billing.createInvoice \\\n --output tests/billing.createInvoice.golden.test.ts \\\n --runner-import ./tests/run-operation \\\n --runner-fn runBillingCommand \\\n --from-production \\\n --days 7 \\\n --sample-rate 0.05\n```\n\n3. Generated files import your runner and assert against recorded outputs (or expected errors for negative paths).\n\n---\n\n## 6. Operational Notes\n\n- **Approvals**: By default, every suggestion still requires human approval. `EvolutionConfig.autoApproveThreshold` can be tuned per environment but should remain conservative (<0.3) until OverlaySpec tooling lands.\n- **Sampling**: Keep `TrafficRecorder.sampleRate` ≤ 0.05 in production to avoid sensitive payload storage; scrub PII through the `sanitize` callback before persistence.\n- **Rollouts**: Guardrails default to 5% error-rate and 750ms P99 latency. Override per experiment to match SLOs.\n\n---\n\n## 7. Next Steps\n\n1. Wire `SpecExperimentAdapter.trackOutcome` into adapters (REST, GraphQL, Workers) so every execution logs metrics automatically.\n2. Add a UI for reviewing `SpecSuggestion` objects alongside approval status.\n3. Expand `TrafficRecorder` to ship directly to the Prisma-backed store (currently in-memory by default).\n4. Integrate `EvolutionPipeline` events with the Regenerator to close the loop (auto-open proposals + attach evidence).\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n"
|
|
13
|
+
}];
|
|
14
|
+
registerDocBlocks(tech_PHASE_3_AUTO_EVOLUTION_DocBlocks);
|
|
15
|
+
|
|
16
|
+
//#endregion
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { registerDocBlocks } from "../registry.js";
|
|
2
|
+
|
|
3
|
+
//#region ../../libs/contracts/dist/docs/tech/PHASE_4_PERSONALIZATION_ENGINE.docblock.js
|
|
4
|
+
const tech_PHASE_4_PERSONALIZATION_ENGINE_DocBlocks = [{
|
|
5
|
+
id: "docs.tech.PHASE_4_PERSONALIZATION_ENGINE",
|
|
6
|
+
title: "Phase 4: Personalization Engine",
|
|
7
|
+
summary: "**Status**: Complete",
|
|
8
|
+
kind: "reference",
|
|
9
|
+
visibility: "public",
|
|
10
|
+
route: "/docs/tech/PHASE_4_PERSONALIZATION_ENGINE",
|
|
11
|
+
tags: ["tech", "PHASE_4_PERSONALIZATION_ENGINE"],
|
|
12
|
+
body: "# Phase 4: Personalization Engine\n\n**Status**: Complete \n**Last updated**: 2025-11-21\n\nPhase 4 unlocks tenant-scoped personalization with zero bespoke code. We shipped three new libraries, a signing-aware Overlay editor, and the persistence layer required to observe usage and apply overlays safely.\n\n---\n\n## 1. Libraries\n\n### @lssm/lib.overlay-engine\n\n- OverlaySpec types + validator mirror the public spec.\n- Cryptographic signer (`ed25519`, `rsa-pss-sha256`) with canonical JSON serialization.\n- Registry that merges tenant/role/user/device overlays with predictable specificity.\n- React hooks (`useOverlay`, `useOverlayFields`) for client-side rendering.\n- Runtime engine audits every applied overlay for traceability.\n\n### @lssm/lib.personalization\n\n- Behavior tracker buffers field/feature/workflow events and exports OTel metrics.\n- Analyzer summarizes field usage and workflow drop-offs into actionable insights.\n- Adapter translates insights into overlay suggestions or workflow tweaks.\n- In-memory store implementation + interface for plugging Prisma/ClickHouse later.\n\n### @lssm/lib.workflow-composer\n\n- `WorkflowComposer` merges base workflows with tenant/role/device extensions.\n- Step injection utilities keep transitions intact and validate anchor steps.\n- Template helpers for common tenant review/approval, plus merge helpers for multi-scope extensions.\n\n---\n\n## 2. Overlay Editor App\n\nPath: `packages/apps/overlay-editor`\n\n- Next.js App Router UI for toggling field visibility, renaming labels, and reordering lists.\n- Live JSON preview powered by `defineOverlay`.\n- Server action that signs overlays via PEM private keys (Ed25519 by default) using the overlay engine signer.\n\n---\n\n## 3. Persistence\n\nAdded Prisma models (see `packages/libs/database/prisma/schema.prisma`):\n\n- `UserBehaviorEvent` – field/feature/workflow telemetry.\n- `OverlaySigningKey` – tenant managed signing keys with revocation timestamps.\n- `Overlay` – stored overlays (tenant/user/role/device scope) plus signature metadata.\n\n---\n\n## 4. Integration Steps\n\n1. Track usage inside apps via `createBehaviorTracker`.\n2. Periodically run `BehaviorAnalyzer.analyze` to generate insights.\n3. Convert insights into OverlaySpecs or Workflow extensions.\n4. Register tenant overlays in `OverlayRegistry` and serve via presentation runtimes.\n5. Compose workflows per tenant using `WorkflowComposer`.\n\nSee the `docs/tech/personalization/*` guides for concrete examples.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n"
|
|
13
|
+
}];
|
|
14
|
+
registerDocBlocks(tech_PHASE_4_PERSONALIZATION_ENGINE_DocBlocks);
|
|
15
|
+
|
|
16
|
+
//#endregion
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { registerDocBlocks } from "../registry.js";
|
|
2
|
+
|
|
3
|
+
//#region ../../libs/contracts/dist/docs/tech/PHASE_5_ZERO_TOUCH_OPERATIONS.docblock.js
|
|
4
|
+
const tech_PHASE_5_ZERO_TOUCH_OPERATIONS_DocBlocks = [{
|
|
5
|
+
id: "docs.tech.PHASE_5_ZERO_TOUCH_OPERATIONS",
|
|
6
|
+
title: "Phase 5: Zero-Touch Operations",
|
|
7
|
+
summary: "**Status**: In progress",
|
|
8
|
+
kind: "reference",
|
|
9
|
+
visibility: "public",
|
|
10
|
+
route: "/docs/tech/PHASE_5_ZERO_TOUCH_OPERATIONS",
|
|
11
|
+
tags: ["tech", "PHASE_5_ZERO_TOUCH_OPERATIONS"],
|
|
12
|
+
body: "# Phase 5: Zero-Touch Operations\n\n**Status**: In progress \n**Last updated**: 2025-11-21\n\nPhase 5 delivers progressive delivery, SLO intelligence, cost attribution, and anomaly-driven remediation so the platform can deploy continuously without pager rotations.\n\n---\n\n## 1. New Libraries\n\n### @lssm/lib.progressive-delivery\n- `DeploymentStrategy` types capture canary vs blue-green rollouts.\n- `CanaryController` + `CanaryAnalyzer` orchestrate stage evaluation against telemetry thresholds.\n- `TrafficShifter` keeps stable/candidate splits in sync with feature-flag or router state.\n- `DeploymentCoordinator` drives stage progression, emits events, and triggers rollbacks.\n- `RollbackManager` encapsulates safe revert hooks (spec version revert, traffic shift, etc.).\n\n### @lssm/lib.slo\n- Declarative `SLODefinition` with latency + availability targets per capability/spec.\n- `SLOTracker` stores rolling snapshots + error budget positions.\n- `BurnRateCalculator` implements multi-window burn computations (fast vs slow burn).\n- `SLOMonitor` pushes incidents to Ops tooling automatically when burn exceeds thresholds.\n\n### @lssm/lib.cost-tracking\n- `CostTracker` normalizes DB/API/compute metrics into per-operation cost totals.\n- `BudgetAlertManager` raises tenant budget warnings (80% default) with contextual payloads.\n- `OptimizationRecommender` suggests batching, caching, or contract tweaks to cut spend.\n\n### Observability Anomaly Toolkit\n- `BaselineCalculator` establishes rolling intent metrics (latency, error rate, throughput).\n- `AnomalyDetector` flags spikes/drops via relative deltas after 10+ samples.\n- `RootCauseAnalyzer` correlates anomalies with recent deployments.\n- `AlertManager` deduplicates notifications and feeds MCP/SRE transports.\n\n---\n\n## 2. Data Model Additions\n\nFile: `packages/libs/database/prisma/schema.prisma`\n\n| Model | Purpose |\n| --- | --- |\n| `SLODefinition`, `SLOSnapshot`, `ErrorBudget`, `SLOIncident` | Persist definitions, rolling windows, and incidents. |\n| `OperationCost`, `TenantBudget`, `CostAlert`, `OptimizationSuggestion` | Track per-operation costs, budgets, and generated recommendations. |\n| `Deployment`, `DeploymentStage`, `RollbackEvent` | Audit progressive delivery runs and automated rollbacks. |\n| `MetricBaseline`, `AnomalyEvent` | Store computed baselines and anomaly evidence for training/analytics. |\n\nRun `bun database generate` after pulling to refresh the Prisma client.\n\n---\n\n## 3. Operational Flow\n\n1. **Deploy**: Define a `DeploymentStrategy` and feed telemetry via `@lssm/lib.observability`. Canary stages run automatically.\n2. **Protect**: `CanaryAnalyzer` evaluates error rate + latency thresholds. Failures trigger `RollbackManager`.\n3. **Observe**: `SLOMonitor` consumes snapshots and opens incidents when burn rate exceeds thresholds.\n4. **Optimize**: `CostTracker` aggregates spend per tenant + capability, while `OptimizationRecommender` surfaces fixes.\n5. **Detect**: Anomaly signals route to `RootCauseAnalyzer`, which links them to specific deployments for auto-rollback.\n\n---\n\n## 4. Integration Checklist\n\n1. Instrument adapters with `createTracingMiddleware({ onSample })` to feed metric points into `AnomalyDetector`.\n2. Register SLOs per critical operation (`billing.charge`, `knowledge.search`) and wire monitors to Ops notifications.\n3. Attach `CostTracker.recordSample` to workflow runners (DB instrumentation + external call wrappers).\n4. Store deployment metadata using the new Prisma models for auditing + UI surfacing.\n5. Update `@lssm/app.ops-console` (next iteration) to list deployments, SLO status, costs, and anomalies in one timeline.\n\n---\n\n## 5. Next Steps\n\n- Wire `DeploymentCoordinator` into the Contracts CLI so `contractspec deploy` can run staged rollouts.\n- Add UI for SLO dashboards (burn rate sparkline + incident feed).\n- Ship budget suggestions into Growth Agent for automated cost optimizations.\n- Connect `AnomalyEvent` stream to MCP agents for root-cause playbooks.\n"
|
|
13
|
+
}];
|
|
14
|
+
registerDocBlocks(tech_PHASE_5_ZERO_TOUCH_OPERATIONS_DocBlocks);
|
|
15
|
+
|
|
16
|
+
//#endregion
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import { registerDocBlocks } from "../../registry.js";
|
|
2
|
+
|
|
3
|
+
//#region ../../libs/contracts/dist/docs/tech/auth/better-auth-nextjs.docblock.js
|
|
4
|
+
const tech_auth_better_auth_nextjs_DocBlocks = [{
|
|
5
|
+
id: "docs.tech.auth.better-auth-nextjs",
|
|
6
|
+
title: "Better Auth + Next.js integration (ContractSpec)",
|
|
7
|
+
summary: "How ContractSpec wires Better Auth into Next.js (server config, client singleton, and proxy cookie-only redirects).",
|
|
8
|
+
kind: "reference",
|
|
9
|
+
visibility: "public",
|
|
10
|
+
route: "/docs/tech/auth/better-auth-nextjs",
|
|
11
|
+
tags: [
|
|
12
|
+
"auth",
|
|
13
|
+
"better-auth",
|
|
14
|
+
"nextjs",
|
|
15
|
+
"cookies",
|
|
16
|
+
"proxy",
|
|
17
|
+
"hmr"
|
|
18
|
+
],
|
|
19
|
+
body: `# Better Auth + Next.js integration (ContractSpec)
|
|
20
|
+
|
|
21
|
+
This repo uses Better Auth as the primary auth layer (sessions, organizations, teams, API keys, and OAuth).
|
|
22
|
+
|
|
23
|
+
## Server config (Better Auth)
|
|
24
|
+
|
|
25
|
+
- Source: \`packages/bundles/contractspec-studio/src/application/services/auth.ts\`
|
|
26
|
+
- Important: \`nextCookies()\` must be the **last** plugin in the Better Auth plugin list so \`Set-Cookie\` is applied correctly in Next.js environments.
|
|
27
|
+
|
|
28
|
+
## Better Auth Admin plugin
|
|
29
|
+
|
|
30
|
+
ContractSpec Studio enables the Better Auth **Admin plugin** to support platform-admin user operations (list users, impersonation, etc.).
|
|
31
|
+
|
|
32
|
+
- Server: \`admin()\` plugin in \`packages/bundles/contractspec-studio/src/application/services/auth.ts\`
|
|
33
|
+
- Client: \`adminClient()\` in \`packages/bundles/contractspec-studio/src/presentation/providers/auth/client.ts\`
|
|
34
|
+
|
|
35
|
+
### PLATFORM_ADMIN ⇒ Better Auth admin role
|
|
36
|
+
|
|
37
|
+
Better Auth Admin endpoints authorize via \`user.role\`. ContractSpec enforces an org-driven rule:
|
|
38
|
+
|
|
39
|
+
- If the **active organization** has \`type = PLATFORM_ADMIN\`, the signed-in user is ensured to have \`User.role\` containing \`admin\`.
|
|
40
|
+
- This is applied in the session creation hook and re-checked in \`assertsPlatformAdmin()\`.
|
|
41
|
+
|
|
42
|
+
This keeps admin enablement deterministic and avoids manual role backfills.
|
|
43
|
+
|
|
44
|
+
## Client config (React web + Expo)
|
|
45
|
+
|
|
46
|
+
To avoid duplicate background refresh/polling loops in dev (Fast Refresh/HMR), the Better Auth client is implemented as a singleton cached on \`globalThis\`.
|
|
47
|
+
|
|
48
|
+
- Web client: \`packages/bundles/contractspec-studio/src/presentation/providers/auth/client.ts\`
|
|
49
|
+
- Native client: \`packages/bundles/contractspec-studio/src/presentation/providers/auth/client.native.ts\`
|
|
50
|
+
|
|
51
|
+
Import guidance:
|
|
52
|
+
|
|
53
|
+
- If you only need the context/hook, prefer importing from \`@lssm/bundle.contractspec-studio/presentation/providers/auth\`.
|
|
54
|
+
- If you explicitly need the Better Auth client instance (e.g. admin impersonation, direct API calls), import from \`@lssm/bundle.contractspec-studio/presentation/providers/auth/client\`.
|
|
55
|
+
|
|
56
|
+
## Public routes (login / signup)
|
|
57
|
+
|
|
58
|
+
Public auth pages should avoid eager \`authClient\` initialization.
|
|
59
|
+
|
|
60
|
+
Pattern used:
|
|
61
|
+
|
|
62
|
+
- In the submit handler, dynamically import \`@lssm/bundle.contractspec-studio/presentation/providers/auth/index.web\` and call \`authClient.signIn.*\` / \`authClient.signUp.*\`.
|
|
63
|
+
|
|
64
|
+
This prevents session refresh behavior from starting just because a public page rendered.
|
|
65
|
+
|
|
66
|
+
## Next.js proxy auth (web-landing)
|
|
67
|
+
|
|
68
|
+
The Next.js proxy/middleware is used for **redirect decisions only**. It must not perform DB-backed session reads on every request.
|
|
69
|
+
|
|
70
|
+
- Source: \`packages/apps/web-landing/src/proxy.ts\`
|
|
71
|
+
- Approach: cookie-only checks via Better Auth cookies helpers:
|
|
72
|
+
- \`getSessionCookie(request)\`
|
|
73
|
+
- \`getCookieCache(request)\`
|
|
74
|
+
|
|
75
|
+
These checks are intentionally optimistic and should only gate routing. Full authorization must still be enforced on server-side actions/routes and GraphQL resolvers.
|
|
76
|
+
`
|
|
77
|
+
}];
|
|
78
|
+
registerDocBlocks(tech_auth_better_auth_nextjs_DocBlocks);
|
|
79
|
+
|
|
80
|
+
//#endregion
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import { registerDocBlocks } from "../../registry.js";
|
|
2
|
+
|
|
3
|
+
//#region ../../libs/contracts/dist/docs/tech/contracts/openapi-export.docblock.js
|
|
4
|
+
const tech_contracts_openapi_export_DocBlocks = [{
|
|
5
|
+
id: "docs.tech.contracts.openapi-export",
|
|
6
|
+
title: "OpenAPI export (OpenAPI 3.1) from SpecRegistry",
|
|
7
|
+
summary: "Generate a deterministic OpenAPI document from a SpecRegistry using jsonSchemaForSpec + REST transport metadata.",
|
|
8
|
+
kind: "reference",
|
|
9
|
+
visibility: "public",
|
|
10
|
+
route: "/docs/tech/contracts/openapi-export",
|
|
11
|
+
tags: [
|
|
12
|
+
"contracts",
|
|
13
|
+
"openapi",
|
|
14
|
+
"rest"
|
|
15
|
+
],
|
|
16
|
+
body: `## OpenAPI export (OpenAPI 3.1) from SpecRegistry
|
|
17
|
+
|
|
18
|
+
### Purpose
|
|
19
|
+
|
|
20
|
+
ContractSpec specs can be exported into an **OpenAPI 3.1** document for tooling (SDK generation, docs, gateways).
|
|
21
|
+
|
|
22
|
+
The export is **spec-first**:
|
|
23
|
+
|
|
24
|
+
- Uses \`jsonSchemaForSpec(spec)\` for input/output JSON Schema (from SchemaModel → zod → JSON Schema)
|
|
25
|
+
- Uses \`spec.transport.rest.method/path\` when present
|
|
26
|
+
- Falls back to deterministic defaults:
|
|
27
|
+
- Method: \`POST\` for commands, \`GET\` for queries
|
|
28
|
+
- Path: \`defaultRestPath(name, version)\` → \`/<dot/name>/v<version>\`
|
|
29
|
+
|
|
30
|
+
### Library API
|
|
31
|
+
|
|
32
|
+
- Function: \`openApiForRegistry(registry, options?)\`
|
|
33
|
+
- Location: \`@lssm/lib.contracts/openapi\`
|
|
34
|
+
|
|
35
|
+
### CLI
|
|
36
|
+
|
|
37
|
+
Export OpenAPI from a registry module:
|
|
38
|
+
|
|
39
|
+
\`\`\`bash
|
|
40
|
+
contractspec openapi --registry ./src/registry.ts --out ./openapi.json
|
|
41
|
+
\`\`\`
|
|
42
|
+
|
|
43
|
+
The registry module must export one of:
|
|
44
|
+
|
|
45
|
+
- \`registry: SpecRegistry\`
|
|
46
|
+
- \`default(): SpecRegistry | Promise<SpecRegistry>\`
|
|
47
|
+
- \`createRegistry(): SpecRegistry | Promise<SpecRegistry>\`
|
|
48
|
+
|
|
49
|
+
### Notes / limitations (current)
|
|
50
|
+
|
|
51
|
+
- Responses are generated as a basic \`200\` response (plus schemas when available).
|
|
52
|
+
- Query (GET) inputs are currently represented as a JSON request body when an input schema exists.
|
|
53
|
+
- Errors are not yet expanded into OpenAPI responses; that will be added when we standardize error envelopes.`
|
|
54
|
+
}];
|
|
55
|
+
registerDocBlocks(tech_contracts_openapi_export_DocBlocks);
|
|
56
|
+
|
|
57
|
+
//#endregion
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { registerDocBlocks } from "../registry.js";
|
|
2
|
+
|
|
3
|
+
//#region ../../libs/contracts/dist/docs/tech/lifecycle-stage-system.docblock.js
|
|
4
|
+
const tech_lifecycle_stage_system_DocBlocks = [{
|
|
5
|
+
id: "docs.tech.lifecycle-stage-system",
|
|
6
|
+
title: "ContractSpec Lifecycle Stage System – Technical Design",
|
|
7
|
+
summary: "This document describes how ContractSpec implements lifecycle detection and guidance. It covers architecture, module boundaries, scoring heuristics, and integration points so libraries, modules, bundles, and Studio surfaces stay synchronized.",
|
|
8
|
+
kind: "reference",
|
|
9
|
+
visibility: "public",
|
|
10
|
+
route: "/docs/tech/lifecycle-stage-system",
|
|
11
|
+
tags: ["tech", "lifecycle-stage-system"],
|
|
12
|
+
body: "## ContractSpec Lifecycle Stage System – Technical Design\n\nThis document describes how ContractSpec implements lifecycle detection and guidance. It covers architecture, module boundaries, scoring heuristics, and integration points so libraries, modules, bundles, and Studio surfaces stay synchronized.\n\n---\n\n### 1. Architecture Overview\n\n```\n┌──────────────────────┐\n│ @lssm/lib.lifecycle │ Types, enums, helpers (pure data)\n└───────────┬──────────┘\n │\n┌───────────▼──────────┐ ┌───────────────────────────┐\n│ modules/lifecycle- │ │ modules/lifecycle-advisor │\n│ core (detection) │ │ (guidance & ceremonies) │\n└───────────┬──────────┘ └───────────┬───────────────┘\n │ │\n ├────────────┬──────────────┤\n ▼ ▼ ▼\n Adapters: analytics, intent, questionnaires\n │\n┌───────────▼──────────┐\n│ bundles/lifecycle- │ Managed service for Studio\n│ managed │ (REST handlers, AI agent) │\n└───────────┬──────────┘\n │\n ContractSpec Studio surfaces\n (web/mobile APIs, CLI, docs)\n```\n\n- **Libraries** provide shared vocabulary.\n- **Modules** encapsulate logic, accepting adapters to avoid environment-specific code.\n- **Bundles** compose modules, register agents/events, and expose APIs for Studio.\n- **Apps** (web-landing, future Studio views) consume bundle APIs; they do not reimplement logic. For web-landing we now resolve `@lssm/bundle.contractspec-studio` and `@lssm/lib.database-contractspec-studio` directly from their `packages/.../src` folders via `tsconfig` path aliases so Prisma stays on the server build and Turbopack no longer pulls the prebundled `dist` artifacts into client chunks.\n\n---\n\n### 2. Core Library (`@lssm/lib.lifecycle`)\n\n- Stage enum (0–6) with metadata (`question`, `signals`, `traps`).\n- Axes types (`ProductPhase`, `CompanyPhase`, `CapitalPhase`).\n- `LifecycleSignal` (source, metric, value, timestamp).\n- `LifecycleMetricSnapshot` (aggregated numbers).\n- `LifecycleMilestone`, `LifecycleAction`, `LifecycleAssessment` interfaces.\n- Utility helpers:\n - `formatStageSummary(stage, assessment)`\n - `rankStageCandidates(scores)`\n\nThe library exports **no runtime dependencies** so it can be imported from apps, modules, and bundles alike.\n\n---\n\n### 3. Lifecycle Core Module\n\n**Location:** `packages/modules/lifecycle-core/`\n\n#### Components\n1. **StageSignalCollector**\n - Accepts adapter interfaces:\n - `AnalyticsAdapter` (pulls metrics from `@lssm/lib.analytics` or fixture streams).\n - `IntentAdapter` (hooks into `@lssm/lib.observability` intent detectors or logs).\n - `QuestionnaireAdapter` (loads JSON questionnaires and responses).\n - Produces normalized `LifecycleSignal[]`.\n\n2. **StageScorer**\n - Weighted scoring model:\n - Base weight per stage (reflecting expected maturity).\n - Feature weights (retention, revenue, team size, qualitative feedback).\n - Confidence computed via variance of contributing signals.\n - Supports pluggable scoring matrices via JSON config.\n - Accepts sparse metric snapshots; the orchestrator sanitizes metrics to numeric-only records before persisting assessments so downstream analytics stay consistent.\n\n3. **LifecycleOrchestrator**\n - Coordinates collectors + scorer.\n - Returns `LifecycleAssessment` with:\n - `stage`, `confidence`, `axisSnapshot`, `signalsUsed`.\n - Recommended focus areas (high-level categories only).\n - Emits events (internally) when stage confidence crosses thresholds (consumed later by bundle).\n\n4. **LifecycleMilestonePlanner**\n - Loads `milestones-catalog.json` (no DB).\n - Filters upcoming milestones per stage + axis.\n - Tracks completion using provided IDs (caller persists).\n\n#### Data Files\n- `configs/stage-weights.json`\n- `configs/milestones-catalog.json`\n- `questionnaires/stage-readiness.json`\n\n#### Extension Hooks\n- All adapters exported as TypeScript interfaces.\n- Implementations for analytics/intent can live in bundles or apps without modifying module code.\n\n---\n\n### 4. Lifecycle Advisor Module\n\n**Location:** `packages/modules/lifecycle-advisor/`\n\n#### Components\n1. **LifecycleRecommendationEngine**\n - Consumes `LifecycleAssessment`.\n - Maps gaps to `LifecycleAction[]` using rule tables (`stage-playbooks.ts`).\n - Supports override hooks for customer-specific rules.\n\n2. **ContractSpecLibraryRecommender**\n - Maintains mapping from stage → recommended libraries/modules/bundles.\n - Returns prioritized list with rationale and adoption prerequisites.\n\n3. **LifecycleCeremonyDesigner**\n - Provides textual/structural data for ceremonies (title, copy, animation cues, soundtrack references).\n - Ensures low-tech friendly instructions (clear copy, undo guidance).\n\n4. **AI Hooks**\n - Defines prompt templates and tool manifests for lifecycle advisor agents (consumed by bundles).\n - Keeps actual LLM integration outside module.\n\n---\n\n### 5. Managed Bundle (`lifecycle-managed`)\n\n**Responsibilities**\n- Wire modules together.\n- Provide HTTP/GraphQL handlers (exact transport optional).\n- Register LifecycleAdvisorAgent via `@lssm/lib.ai-agent`.\n- LifecycleAdvisorAgent meta: domain `operations`, owners `team-lifecycle`, stability `experimental`, tags `guide/lifecycle/ops` so ops tooling can route incidents quickly.\n- Emit lifecycle events through `@lssm/lib.bus` + `@lssm/lib.analytics`.\n- Integrate with `contractspec-studio` packages:\n - Use Studio contracts for authentication/tenant context (without accessing tenant DBs).\n - Store assessments in Studio-managed storage abstractions (in-memory or file-based for now).\n\n**APIs**\n- `POST /lifecycle/assessments`: Accepts metrics + optional questionnaire answers. Returns `LifecycleAssessment`.\n- `GET /lifecycle/playbooks/:stage`: Returns stage playbook + ceremonies.\n- `POST /lifecycle/advise`: Invokes LifecycleAdvisorAgent with context.\n\n**Events**\n- `LifecycleAssessmentCreated`\n- `LifecycleStageChanged`\n- `LifecycleGuidanceConsumed`\n\n---\n\n### 6. Library Enhancements\n\n| Library | Enhancement |\n| --- | --- |\n| `@lssm/lib.analytics` | Lifecycle metric collectors, helper to emit stage events, adapter implementation used by `StageSignalCollector`. |\n| `@lssm/lib.evolution` | Accepts `LifecycleContext` when ranking spec anomalies/suggestions. |\n| `@lssm/lib.growth` | Stage-specific experiment templates + guardrails referencing lifecycle enums. |\n| `@lssm/lib.observability` | Lifecycle KPI pipeline definitions (drift detection, regression alerts). |\n\nEach enhancement must import stage types from `@lssm/lib.lifecycle`.\n\n---\n\n### 7. Feature Flags & Progressive Delivery\n\n- Add new flags in progressive-delivery library:\n - `LIFECYCLE_DETECTION_ALPHA`\n - `LIFECYCLE_ADVISOR_ALPHA`\n - `LIFECYCLE_MANAGED_SERVICE`\n- Bundles/modules should check flags before enabling workflows.\n- Flags referenced in docs + Studio UI to avoid accidental exposure.\n\n---\n\n### 8. Analytics & Telemetry\n\n- Events defined in analytics library; consumed by bundle/app:\n - `lifecycle_assessment_run`\n - `lifecycle_stage_changed`\n - `lifecycle_guidance_consumed`\n- Observability pipeline includes:\n - Composite lifecycle health metric (weighted sum of KPIs).\n - Drift detection comparing stage predictions over time.\n - Alert manager recipes for regression (e.g., PMF drop).\n\n---\n\n### 9. Testing Strategy\n\n1. **Unit**\n - StageScorer weight matrix.\n - RecommendationEngine mapping.\n - Library recommender stage coverage.\n\n2. **Contract**\n - Adapters: ensure mock adapters satisfy interfaces.\n - Bundles: ensure HTTP handlers respect request/response contracts even without persistence.\n\n3. **Integration**\n - CLI example runs detection + guidance end-to-end on fixture data.\n - Dashboard example renders assessments, verifying JSON structures remain stable.\n\n---\n\n### 10. Implementation Checklist\n\n- [ ] Documentation (product, tech, ops, user).\n- [ ] Library creation (`@lssm/lib.lifecycle`).\n- [ ] Modules (`lifecycle-core`, `lifecycle-advisor`).\n- [ ] Bundle (`lifecycle-managed`) + Studio wiring.\n- [ ] Library enhancements (analytics/evolution/growth/observability).\n- [ ] Examples (CLI + dashboard).\n- [ ] Feature flags + telemetry.\n- [ ] Automated tests + fixtures.\n\nKeep this document in sync as modules evolve. When adding new stages or axes, update `@lssm/lib.lifecycle` first, then cascade to adapters, then refresh docs + Studio copy.*** End Patch*** End Patch\n\n\n"
|
|
13
|
+
}];
|
|
14
|
+
registerDocBlocks(tech_lifecycle_stage_system_DocBlocks);
|
|
15
|
+
|
|
16
|
+
//#endregion
|
|
@@ -0,0 +1,357 @@
|
|
|
1
|
+
import { registerDocBlocks } from "../../registry.js";
|
|
2
|
+
|
|
3
|
+
//#region ../../libs/contracts/dist/docs/tech/llm/llm-integration.docblock.js
|
|
4
|
+
const tech_llm_integration_DocBlocks = [
|
|
5
|
+
{
|
|
6
|
+
id: "docs.tech.llm.overview",
|
|
7
|
+
title: "LLM Integration Overview",
|
|
8
|
+
summary: "Export specs to LLM-friendly formats, generate implementation guides, and verify implementations.",
|
|
9
|
+
kind: "reference",
|
|
10
|
+
visibility: "public",
|
|
11
|
+
route: "/docs/tech/llm/overview",
|
|
12
|
+
tags: [
|
|
13
|
+
"llm",
|
|
14
|
+
"ai",
|
|
15
|
+
"export",
|
|
16
|
+
"guide",
|
|
17
|
+
"verify"
|
|
18
|
+
],
|
|
19
|
+
body: `# LLM Integration
|
|
20
|
+
|
|
21
|
+
ContractSpec provides first-class LLM integration to bridge specifications and AI coding agents.
|
|
22
|
+
|
|
23
|
+
## Core Features
|
|
24
|
+
|
|
25
|
+
### 1. Multi-Format Export
|
|
26
|
+
|
|
27
|
+
Export specs to markdown in formats optimized for LLM consumption:
|
|
28
|
+
|
|
29
|
+
- **Context format**: Summary for understanding (goal, context, acceptance criteria)
|
|
30
|
+
- **Full format**: Complete spec with all details (I/O schemas, policy, events)
|
|
31
|
+
- **Prompt format**: Actionable prompt with implementation instructions
|
|
32
|
+
|
|
33
|
+
### 2. Implementation Guidance
|
|
34
|
+
|
|
35
|
+
Generate agent-specific implementation plans:
|
|
36
|
+
|
|
37
|
+
- **Claude Code**: Extended thinking mode with structured prompts
|
|
38
|
+
- **Cursor CLI**: Background/composer mode with .mdc rules generation
|
|
39
|
+
- **Generic MCP**: Standard format for any MCP-compatible agent
|
|
40
|
+
|
|
41
|
+
### 3. Tiered Verification
|
|
42
|
+
|
|
43
|
+
Verify implementations against specs:
|
|
44
|
+
|
|
45
|
+
- **Tier 1 (Structure)**: Types, exports, imports validation
|
|
46
|
+
- **Tier 2 (Behavior)**: Scenario coverage, error handling, events
|
|
47
|
+
- **Tier 3 (AI Review)**: Semantic compliance analysis via LLM
|
|
48
|
+
|
|
49
|
+
## Access Points
|
|
50
|
+
|
|
51
|
+
| Surface | Commands/Tools |
|
|
52
|
+
|---------|---------------|
|
|
53
|
+
| CLI | \`contractspec llm export\`, \`guide\`, \`verify\`, \`copy\` |
|
|
54
|
+
| MCP | \`llm.export\`, \`llm.guide\`, \`llm.verify\` tools |
|
|
55
|
+
| VSCode | Export to LLM, Generate Guide, Verify, Copy commands |
|
|
56
|
+
|
|
57
|
+
## Quick Start
|
|
58
|
+
|
|
59
|
+
### CLI Usage
|
|
60
|
+
|
|
61
|
+
\`\`\`bash
|
|
62
|
+
# Export spec as markdown
|
|
63
|
+
contractspec llm export path/to/my.spec.ts --format full
|
|
64
|
+
|
|
65
|
+
# Generate implementation guide
|
|
66
|
+
contractspec llm guide path/to/my.spec.ts --agent claude-code
|
|
67
|
+
|
|
68
|
+
# Verify implementation
|
|
69
|
+
contractspec llm verify path/to/my.spec.ts path/to/impl.ts --tier 2
|
|
70
|
+
|
|
71
|
+
# Copy spec to clipboard
|
|
72
|
+
contractspec llm copy path/to/my.spec.ts --format context
|
|
73
|
+
\`\`\`
|
|
74
|
+
|
|
75
|
+
### MCP Usage
|
|
76
|
+
|
|
77
|
+
\`\`\`
|
|
78
|
+
# Export spec
|
|
79
|
+
llm.export { specPath: "path/to/my.spec.ts", format: "full" }
|
|
80
|
+
|
|
81
|
+
# Generate guide
|
|
82
|
+
llm.guide { specPath: "path/to/my.spec.ts", agent: "cursor-cli" }
|
|
83
|
+
|
|
84
|
+
# Verify implementation
|
|
85
|
+
llm.verify { specPath: "path/to/my.spec.ts", implementationPath: "path/to/impl.ts", tier: "2" }
|
|
86
|
+
\`\`\`
|
|
87
|
+
|
|
88
|
+
### Programmatic Usage
|
|
89
|
+
|
|
90
|
+
\`\`\`typescript
|
|
91
|
+
import { specToFullMarkdown, specToAgentPrompt } from '@lssm/lib.contracts/llm';
|
|
92
|
+
import { createAgentGuideService, createVerifyService } from '@lssm/bundle.contractspec-workspace';
|
|
93
|
+
|
|
94
|
+
// Export
|
|
95
|
+
const markdown = specToFullMarkdown(mySpec);
|
|
96
|
+
|
|
97
|
+
// Generate guide
|
|
98
|
+
const guideService = createAgentGuideService({ defaultAgent: 'claude-code' });
|
|
99
|
+
const guide = guideService.generateGuide(mySpec);
|
|
100
|
+
|
|
101
|
+
// Verify
|
|
102
|
+
const verifyService = createVerifyService();
|
|
103
|
+
const result = await verifyService.verify(mySpec, implementationCode, {
|
|
104
|
+
tiers: ['structure', 'behavior']
|
|
105
|
+
});
|
|
106
|
+
\`\`\`
|
|
107
|
+
`
|
|
108
|
+
},
|
|
109
|
+
{
|
|
110
|
+
id: "docs.tech.llm.export-formats",
|
|
111
|
+
title: "LLM Export Formats",
|
|
112
|
+
summary: "Detailed explanation of the three export formats for LLM consumption.",
|
|
113
|
+
kind: "reference",
|
|
114
|
+
visibility: "public",
|
|
115
|
+
route: "/docs/tech/llm/export-formats",
|
|
116
|
+
tags: [
|
|
117
|
+
"llm",
|
|
118
|
+
"export",
|
|
119
|
+
"markdown"
|
|
120
|
+
],
|
|
121
|
+
body: `# LLM Export Formats
|
|
122
|
+
|
|
123
|
+
ContractSpec provides three export formats optimized for different LLM use cases.
|
|
124
|
+
|
|
125
|
+
## Context Format
|
|
126
|
+
|
|
127
|
+
Best for: Understanding what a spec does, providing background to LLMs.
|
|
128
|
+
|
|
129
|
+
Includes:
|
|
130
|
+
- Spec name, version, type
|
|
131
|
+
- Goal and context
|
|
132
|
+
- Description
|
|
133
|
+
- Acceptance scenarios
|
|
134
|
+
|
|
135
|
+
Example:
|
|
136
|
+
|
|
137
|
+
\`\`\`markdown
|
|
138
|
+
# users.createUser (v1)
|
|
139
|
+
|
|
140
|
+
> Create a new user account with email verification.
|
|
141
|
+
|
|
142
|
+
**Type:** command | **Stability:** stable
|
|
143
|
+
|
|
144
|
+
## Goal
|
|
145
|
+
Create a new user in the system and trigger email verification.
|
|
146
|
+
|
|
147
|
+
## Context
|
|
148
|
+
Part of the user onboarding flow. Called after signup form submission.
|
|
149
|
+
|
|
150
|
+
## Acceptance Criteria
|
|
151
|
+
### Happy path
|
|
152
|
+
**Given:** Valid email and password
|
|
153
|
+
**When:** User submits registration
|
|
154
|
+
**Then:** Account is created, verification email is sent
|
|
155
|
+
\`\`\`
|
|
156
|
+
|
|
157
|
+
## Full Format
|
|
158
|
+
|
|
159
|
+
Best for: Complete documentation, implementation reference.
|
|
160
|
+
|
|
161
|
+
Includes everything:
|
|
162
|
+
- All metadata
|
|
163
|
+
- JSON schemas for I/O
|
|
164
|
+
- Error definitions
|
|
165
|
+
- Policy (auth, rate limits, PII)
|
|
166
|
+
- Events emitted
|
|
167
|
+
- Examples
|
|
168
|
+
- Transport configuration
|
|
169
|
+
|
|
170
|
+
## Prompt Format
|
|
171
|
+
|
|
172
|
+
Best for: Feeding directly to coding agents.
|
|
173
|
+
|
|
174
|
+
Includes:
|
|
175
|
+
- Task header with clear instructions
|
|
176
|
+
- Full spec context
|
|
177
|
+
- Implementation requirements
|
|
178
|
+
- Task-specific guidance (implement/test/refactor/review)
|
|
179
|
+
- Expected output format
|
|
180
|
+
|
|
181
|
+
The prompt format adapts based on task type:
|
|
182
|
+
- **implement**: Full implementation with tests
|
|
183
|
+
- **test**: Test generation for existing code
|
|
184
|
+
- **refactor**: Refactoring while maintaining behavior
|
|
185
|
+
- **review**: Code review against spec
|
|
186
|
+
`
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
id: "docs.tech.llm.agent-adapters",
|
|
190
|
+
title: "Agent Adapters",
|
|
191
|
+
summary: "Adapters for different AI coding agents (Claude, Cursor, MCP).",
|
|
192
|
+
kind: "reference",
|
|
193
|
+
visibility: "public",
|
|
194
|
+
route: "/docs/tech/llm/agent-adapters",
|
|
195
|
+
tags: [
|
|
196
|
+
"llm",
|
|
197
|
+
"agents",
|
|
198
|
+
"claude",
|
|
199
|
+
"cursor",
|
|
200
|
+
"mcp"
|
|
201
|
+
],
|
|
202
|
+
body: `# Agent Adapters
|
|
203
|
+
|
|
204
|
+
ContractSpec provides specialized adapters for different AI coding agents.
|
|
205
|
+
|
|
206
|
+
## Claude Code Adapter
|
|
207
|
+
|
|
208
|
+
Optimized for Anthropic Claude's extended thinking and code generation.
|
|
209
|
+
|
|
210
|
+
Features:
|
|
211
|
+
- Structured markdown with clear sections
|
|
212
|
+
- Checklists for steps and verification
|
|
213
|
+
- Icons for file operations (📝 create, ✏️ modify)
|
|
214
|
+
- System prompt for ContractSpec context
|
|
215
|
+
|
|
216
|
+
Usage:
|
|
217
|
+
\`\`\`typescript
|
|
218
|
+
const guideService = createAgentGuideService({ defaultAgent: 'claude-code' });
|
|
219
|
+
const result = guideService.generateGuide(spec, { agent: 'claude-code' });
|
|
220
|
+
// result.prompt.systemPrompt - Claude system context
|
|
221
|
+
// result.prompt.taskPrompt - Task-specific instructions
|
|
222
|
+
\`\`\`
|
|
223
|
+
|
|
224
|
+
## Cursor CLI Adapter
|
|
225
|
+
|
|
226
|
+
Optimized for Cursor's background/composer mode.
|
|
227
|
+
|
|
228
|
+
Features:
|
|
229
|
+
- Compact format for context efficiency
|
|
230
|
+
- .mdc cursor rules generation
|
|
231
|
+
- Integration with Cursor's file system
|
|
232
|
+
- Concise step lists
|
|
233
|
+
|
|
234
|
+
Generate Cursor Rules:
|
|
235
|
+
\`\`\`typescript
|
|
236
|
+
const cursorRules = guideService.generateAgentConfig(spec, 'cursor-cli');
|
|
237
|
+
// Save to .cursor/rules/my-spec.mdc
|
|
238
|
+
\`\`\`
|
|
239
|
+
|
|
240
|
+
## Generic MCP Adapter
|
|
241
|
+
|
|
242
|
+
Works with any MCP-compatible agent (Cline, Aider, etc.).
|
|
243
|
+
|
|
244
|
+
Features:
|
|
245
|
+
- Standard markdown format
|
|
246
|
+
- Table-based metadata
|
|
247
|
+
- JSON resource format support
|
|
248
|
+
- Prompt message format
|
|
249
|
+
|
|
250
|
+
The generic adapter is the default and works across all agents.
|
|
251
|
+
|
|
252
|
+
## Choosing an Adapter
|
|
253
|
+
|
|
254
|
+
| Agent | Best For | Key Features |
|
|
255
|
+
|-------|----------|--------------|
|
|
256
|
+
| Claude Code | Complex implementations | Extended thinking, detailed steps |
|
|
257
|
+
| Cursor CLI | IDE-integrated work | Cursor rules, compact format |
|
|
258
|
+
| Generic MCP | Any MCP agent | Universal compatibility |
|
|
259
|
+
`
|
|
260
|
+
},
|
|
261
|
+
{
|
|
262
|
+
id: "docs.tech.llm.verification",
|
|
263
|
+
title: "Implementation Verification",
|
|
264
|
+
summary: "Tiered verification of implementations against specifications.",
|
|
265
|
+
kind: "reference",
|
|
266
|
+
visibility: "public",
|
|
267
|
+
route: "/docs/tech/llm/verification",
|
|
268
|
+
tags: [
|
|
269
|
+
"llm",
|
|
270
|
+
"verify",
|
|
271
|
+
"validation",
|
|
272
|
+
"testing"
|
|
273
|
+
],
|
|
274
|
+
body: `# Implementation Verification
|
|
275
|
+
|
|
276
|
+
ContractSpec provides tiered verification to check if implementations comply with specs.
|
|
277
|
+
|
|
278
|
+
## Verification Tiers
|
|
279
|
+
|
|
280
|
+
### Tier 1: Structure (Fast)
|
|
281
|
+
|
|
282
|
+
Checks TypeScript structure against spec requirements:
|
|
283
|
+
|
|
284
|
+
| Check | What it validates |
|
|
285
|
+
|-------|------------------|
|
|
286
|
+
| Handler export | Function is properly exported |
|
|
287
|
+
| Contracts import | Imports from @lssm/lib.contracts |
|
|
288
|
+
| Schema import | Imports from @lssm/lib.schema |
|
|
289
|
+
| No \`any\` type | TypeScript strict compliance |
|
|
290
|
+
| Error handling | Error codes are referenced |
|
|
291
|
+
| Event emission | Event patterns exist |
|
|
292
|
+
| Input validation | Validation patterns used |
|
|
293
|
+
| Async patterns | Async/await for commands |
|
|
294
|
+
|
|
295
|
+
### Tier 2: Behavior (Comprehensive)
|
|
296
|
+
|
|
297
|
+
Checks implementation coverage of spec behaviors:
|
|
298
|
+
|
|
299
|
+
| Check | What it validates |
|
|
300
|
+
|-------|------------------|
|
|
301
|
+
| Scenario coverage | Acceptance scenarios implemented |
|
|
302
|
+
| Example coverage | Example I/O values referenced |
|
|
303
|
+
| Error cases | All error conditions handled |
|
|
304
|
+
| Event conditions | Events emitted correctly |
|
|
305
|
+
| Idempotency | Idempotent patterns (if required) |
|
|
306
|
+
|
|
307
|
+
### Tier 3: AI Review (Deep)
|
|
308
|
+
|
|
309
|
+
Uses LLM for semantic analysis:
|
|
310
|
+
|
|
311
|
+
- Does the implementation fulfill the spec's intent?
|
|
312
|
+
- Are edge cases properly handled?
|
|
313
|
+
- Is the code quality acceptable?
|
|
314
|
+
- Are there any subtle violations?
|
|
315
|
+
|
|
316
|
+
Requires AI API key configuration.
|
|
317
|
+
|
|
318
|
+
## Running Verification
|
|
319
|
+
|
|
320
|
+
\`\`\`typescript
|
|
321
|
+
const verifyService = createVerifyService({
|
|
322
|
+
aiApiKey: process.env.ANTHROPIC_API_KEY, // Optional, for Tier 3
|
|
323
|
+
aiProvider: 'anthropic',
|
|
324
|
+
});
|
|
325
|
+
|
|
326
|
+
const result = await verifyService.verify(spec, implementationCode, {
|
|
327
|
+
tiers: ['structure', 'behavior'],
|
|
328
|
+
failFast: false,
|
|
329
|
+
includeSuggestions: true,
|
|
330
|
+
});
|
|
331
|
+
|
|
332
|
+
console.log(result.passed); // true/false
|
|
333
|
+
console.log(result.score); // 0-100
|
|
334
|
+
console.log(result.summary); // Human-readable summary
|
|
335
|
+
\`\`\`
|
|
336
|
+
|
|
337
|
+
## Verification Report
|
|
338
|
+
|
|
339
|
+
The report includes:
|
|
340
|
+
|
|
341
|
+
- **passed**: Overall compliance
|
|
342
|
+
- **score**: 0-100 score
|
|
343
|
+
- **issues**: Array of problems found
|
|
344
|
+
- **suggestions**: Recommended fixes
|
|
345
|
+
- **coverage**: Metrics on scenario/error/field coverage
|
|
346
|
+
|
|
347
|
+
Each issue has:
|
|
348
|
+
- **severity**: error, warning, or info
|
|
349
|
+
- **category**: type, export, import, scenario, error_handling, semantic
|
|
350
|
+
- **message**: Description of the issue
|
|
351
|
+
- **suggestion**: How to fix it
|
|
352
|
+
`
|
|
353
|
+
}
|
|
354
|
+
];
|
|
355
|
+
registerDocBlocks(tech_llm_integration_DocBlocks);
|
|
356
|
+
|
|
357
|
+
//#endregion
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { registerDocBlocks } from "../registry.js";
|
|
2
|
+
|
|
3
|
+
//#region ../../libs/contracts/dist/docs/tech/mcp-endpoints.docblock.js
|
|
4
|
+
const tech_mcp_endpoints_DocBlocks = [{
|
|
5
|
+
id: "docs.tech.mcp.endpoints",
|
|
6
|
+
title: "ContractSpec MCP endpoints",
|
|
7
|
+
summary: "Dedicated MCP servers for docs, CLI usage, and internal development.",
|
|
8
|
+
kind: "reference",
|
|
9
|
+
visibility: "mixed",
|
|
10
|
+
route: "/docs/tech/mcp/endpoints",
|
|
11
|
+
tags: [
|
|
12
|
+
"mcp",
|
|
13
|
+
"docs",
|
|
14
|
+
"cli",
|
|
15
|
+
"internal"
|
|
16
|
+
],
|
|
17
|
+
body: `# ContractSpec MCP endpoints
|
|
18
|
+
|
|
19
|
+
Three dedicated MCP servers keep AI agents efficient and scoped:
|
|
20
|
+
|
|
21
|
+
- **Docs MCP**: \`/api/mcp/docs\` — exposes DocBlocks as resources + presentations. Tool: \`docs.search\`.
|
|
22
|
+
- **CLI MCP**: \`/api/mcp/cli\` — surfaces CLI quickstart/reference/README and suggests commands. Tool: \`cli.suggestCommand\`.
|
|
23
|
+
- **Internal MCP**: \`/api/mcp/internal\` — internal routing hints, playbook, and example registry access. Tool: \`internal.describe\`.
|
|
24
|
+
|
|
25
|
+
### Usage notes
|
|
26
|
+
- Transports are HTTP POST (streamable HTTP); SSE is disabled.
|
|
27
|
+
- Resources are namespaced (\`docs://*\`, \`cli://*\`, \`internal://*\`) and are read-only.
|
|
28
|
+
- Internal MCP also exposes the examples registry via \`examples://*\` resources:
|
|
29
|
+
- \`examples://list?q=<query>\`
|
|
30
|
+
- \`examples://example/<id>\`
|
|
31
|
+
- Prompts mirror each surface (navigator, usage, bootstrap) for quick agent onboarding.
|
|
32
|
+
- GraphQL remains at \`/graphql\`; health at \`/health\`.
|
|
33
|
+
`
|
|
34
|
+
}];
|
|
35
|
+
registerDocBlocks(tech_mcp_endpoints_DocBlocks);
|
|
36
|
+
|
|
37
|
+
//#endregion
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { registerDocBlocks } from "../registry.js";
|
|
2
|
+
|
|
3
|
+
//#region ../../libs/contracts/dist/docs/tech/presentation-runtime.docblock.js
|
|
4
|
+
const tech_presentation_runtime_DocBlocks = [{
|
|
5
|
+
id: "docs.tech.presentation-runtime",
|
|
6
|
+
title: "Presentation Runtime",
|
|
7
|
+
summary: "Cross-platform runtime for list pages and presentation flows.",
|
|
8
|
+
kind: "reference",
|
|
9
|
+
visibility: "public",
|
|
10
|
+
route: "/docs/tech/presentation-runtime",
|
|
11
|
+
tags: ["tech", "presentation-runtime"],
|
|
12
|
+
body: "## Presentation Runtime\n\nCross-platform runtime for list pages and presentation flows.\n\n### Packages\n\n- `@lssm/lib.presentation-runtime-core`: shared types and config helpers\n- `@lssm/lib.presentation-runtime-react`: React hooks (web/native-compatible API)\n- `@lssm/lib.presentation-runtime-react-native`: Native entrypoint (re-exports React API for now)\n\n### Next.js config helper\n\n```ts\n// next.config.mjs\nimport { withPresentationNextAliases } from '@lssm/lib.presentation-runtime-core/next';\n\nconst nextConfig = {\n webpack: (config) => withPresentationNextAliases(config),\n};\n\nexport default nextConfig;\n```\n\n### Metro config helper\n\n```js\n// metro.config.js (CJS)\nconst { getDefaultConfig } = require('expo/metro-config');\nconst {\n withPresentationMetroAliases,\n} = require('@lssm/lib.presentation-runtime-core/src/metro.cjs');\n\nconst projectRoot = __dirname;\nconst config = getDefaultConfig(projectRoot);\n\nmodule.exports = withPresentationMetroAliases(config);\n```\n\n### React hooks\n\n- `useListCoordinator`: URL + RHF + derived variables (no fetching)\n- `usePresentationController`: Same plus `fetcher` integration\n- `DataViewRenderer` (design-system): render `DataViewSpec` projections (`list`, `table`, `detail`, `grid`) using shared UI atoms\n\nBoth accept a `useUrlState` adapter. On web, use `useListUrlState` (design-system) or a Next adapter.\n\n### KYC molecules (bundle)\n\n- `ComplianceBadge` in `@lssm/bundle.strit/presentation/components/kyc` renders a status badge for KYC/compliance snapshots. It accepts a `state` (missing_core | incomplete | complete | expiring | unknown) and optional localized `labels`. Prefer consuming apps to pass translated labels (e.g., via `useT('appPlatformAdmin')`).\n\n### Markdown routes and llms.txt\n\n- Each web app exposes `/llms` (and `/llms.txt`, `/llms.md`) via rewrites. See [llmstxt.org](https://llmstxt.org/).\n- Catch‑all markdown handler lives at `app/[...slug].md/route.ts`. It resolves a page descriptor from `app/.presentations.manifest.json` and renders via the `presentations.v2` engine (target: `markdown`).\n- Per‑page companion convention: add `app/<route>/ai.ts` exporting a `PresentationDescriptorV2`.\n- Build‑time tool: `tools/generate-presentations-manifest.mjs <app-root>` populates the manifest.\n- CI check: `pnpm llms:check` verifies coverage (% of pages with descriptors) and fails if below threshold.\n"
|
|
13
|
+
}];
|
|
14
|
+
registerDocBlocks(tech_presentation_runtime_DocBlocks);
|
|
15
|
+
|
|
16
|
+
//#endregion
|