@lssm/lib.feature-flags 0.0.0-canary-20251217083314 → 1.41.1
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/dist/contracts/index.js +1 -910
- package/dist/docs/feature-flags.docblock.js +2 -21
- package/dist/docs/index.js +1 -1
- package/dist/entities/index.js +1 -325
- package/dist/evaluation/index.js +1 -220
- package/dist/events.js +1 -459
- package/dist/feature-flags.feature.js +1 -139
- package/dist/index.js +1 -8
- package/package.json +13 -13
- package/dist/contracts/dist/capabilities/openbanking.js +0 -88
- package/dist/contracts/dist/client/index.js +0 -5
- package/dist/contracts/dist/client/react/feature-render.js +0 -2
- package/dist/contracts/dist/client/react/form-render.js +0 -4
- package/dist/contracts/dist/client/react/index.js +0 -4
- package/dist/contracts/dist/contract-registry/index.js +0 -1
- package/dist/contracts/dist/contract-registry/schemas.js +0 -60
- package/dist/contracts/dist/docs/PUBLISHING.docblock.js +0 -16
- package/dist/contracts/dist/docs/accessibility_wcag_compliance_specs.docblock.js +0 -16
- package/dist/contracts/dist/docs/index.js +0 -29
- package/dist/contracts/dist/docs/presentations.js +0 -71
- package/dist/contracts/dist/docs/registry.js +0 -44
- package/dist/contracts/dist/docs/tech/PHASE_1_QUICKSTART.docblock.js +0 -16
- package/dist/contracts/dist/docs/tech/PHASE_2_AI_NATIVE_OPERATIONS.docblock.js +0 -16
- package/dist/contracts/dist/docs/tech/PHASE_3_AUTO_EVOLUTION.docblock.js +0 -16
- package/dist/contracts/dist/docs/tech/PHASE_4_PERSONALIZATION_ENGINE.docblock.js +0 -16
- package/dist/contracts/dist/docs/tech/PHASE_5_ZERO_TOUCH_OPERATIONS.docblock.js +0 -16
- package/dist/contracts/dist/docs/tech/auth/better-auth-nextjs.docblock.js +0 -80
- package/dist/contracts/dist/docs/tech/contracts/openapi-export.docblock.js +0 -57
- package/dist/contracts/dist/docs/tech/lifecycle-stage-system.docblock.js +0 -16
- package/dist/contracts/dist/docs/tech/llm/llm-integration.docblock.js +0 -357
- package/dist/contracts/dist/docs/tech/mcp-endpoints.docblock.js +0 -37
- package/dist/contracts/dist/docs/tech/presentation-runtime.docblock.js +0 -16
- package/dist/contracts/dist/docs/tech/schema/README.docblock.js +0 -20
- package/dist/contracts/dist/docs/tech/studio/learning-events.docblock.js +0 -48
- package/dist/contracts/dist/docs/tech/studio/learning-journeys.docblock.js +0 -79
- package/dist/contracts/dist/docs/tech/studio/platform-admin-panel.docblock.js +0 -84
- package/dist/contracts/dist/docs/tech/studio/project-access-teams.docblock.js +0 -45
- package/dist/contracts/dist/docs/tech/studio/project-routing.docblock.js +0 -67
- package/dist/contracts/dist/docs/tech/studio/sandbox-unlogged.docblock.js +0 -40
- package/dist/contracts/dist/docs/tech/studio/team-invitations.docblock.js +0 -69
- package/dist/contracts/dist/docs/tech/studio/workspace-ops.docblock.js +0 -47
- package/dist/contracts/dist/docs/tech/studio/workspaces.docblock.js +0 -62
- package/dist/contracts/dist/docs/tech/telemetry-ingest.docblock.js +0 -155
- package/dist/contracts/dist/docs/tech/templates/runtime.docblock.js +0 -20
- package/dist/contracts/dist/docs/tech/vscode-extension.docblock.js +0 -101
- package/dist/contracts/dist/docs/tech/workflows/overview.docblock.js +0 -20
- package/dist/contracts/dist/events.js +0 -10
- package/dist/contracts/dist/experiments/evaluator.js +0 -1
- package/dist/contracts/dist/index.js +0 -71
- package/dist/contracts/dist/install.js +0 -2
- package/dist/contracts/dist/integrations/contracts.js +0 -377
- package/dist/contracts/dist/integrations/index.js +0 -18
- package/dist/contracts/dist/integrations/openbanking/contracts/accounts.js +0 -228
- package/dist/contracts/dist/integrations/openbanking/contracts/balances.js +0 -159
- package/dist/contracts/dist/integrations/openbanking/contracts/index.js +0 -3
- package/dist/contracts/dist/integrations/openbanking/contracts/transactions.js +0 -210
- package/dist/contracts/dist/integrations/openbanking/models.js +0 -242
- package/dist/contracts/dist/integrations/openbanking/telemetry.js +0 -13
- package/dist/contracts/dist/integrations/providers/elevenlabs.js +0 -52
- package/dist/contracts/dist/integrations/providers/gcs-storage.js +0 -75
- package/dist/contracts/dist/integrations/providers/gmail.js +0 -87
- package/dist/contracts/dist/integrations/providers/google-calendar.js +0 -66
- package/dist/contracts/dist/integrations/providers/index.js +0 -11
- package/dist/contracts/dist/integrations/providers/mistral.js +0 -68
- package/dist/contracts/dist/integrations/providers/postmark.js +0 -68
- package/dist/contracts/dist/integrations/providers/powens.js +0 -116
- package/dist/contracts/dist/integrations/providers/qdrant.js +0 -73
- package/dist/contracts/dist/integrations/providers/registry.js +0 -10
- package/dist/contracts/dist/integrations/providers/stripe.js +0 -83
- package/dist/contracts/dist/integrations/providers/twilio-sms.js +0 -61
- package/dist/contracts/dist/jsonschema.js +0 -1
- package/dist/contracts/dist/knowledge/contracts.js +0 -306
- package/dist/contracts/dist/knowledge/index.js +0 -7
- package/dist/contracts/dist/knowledge/spaces/email-threads.js +0 -34
- package/dist/contracts/dist/knowledge/spaces/financial-docs.js +0 -34
- package/dist/contracts/dist/knowledge/spaces/financial-overview.js +0 -38
- package/dist/contracts/dist/knowledge/spaces/index.js +0 -6
- package/dist/contracts/dist/knowledge/spaces/product-canon.js +0 -34
- package/dist/contracts/dist/knowledge/spaces/support-faq.js +0 -37
- package/dist/contracts/dist/knowledge/spaces/uploaded-docs.js +0 -34
- package/dist/contracts/dist/llm/exporters.js +0 -19
- package/dist/contracts/dist/llm/index.js +0 -2
- package/dist/contracts/dist/llm/prompts.js +0 -1
- package/dist/contracts/dist/onboarding-base.js +0 -196
- package/dist/contracts/dist/openapi.js +0 -1
- package/dist/contracts/dist/ownership.js +0 -21
- package/dist/contracts/dist/presentations.js +0 -1
- package/dist/contracts/dist/presentations.v2.js +0 -11
- package/dist/contracts/dist/prompt.js +0 -1
- package/dist/contracts/dist/promptRegistry.js +0 -1
- package/dist/contracts/dist/regenerator/index.js +0 -1
- package/dist/contracts/dist/regenerator/service.js +0 -6
- package/dist/contracts/dist/registry.js +0 -2
- package/dist/contracts/dist/resources.js +0 -1
- package/dist/contracts/dist/schema/dist/EnumType.js +0 -2
- package/dist/contracts/dist/schema/dist/FieldType.js +0 -49
- package/dist/contracts/dist/schema/dist/ScalarTypeEnum.js +0 -236
- package/dist/contracts/dist/schema/dist/SchemaModel.js +0 -34
- package/dist/contracts/dist/schema/dist/entity/defineEntity.js +0 -1
- package/dist/contracts/dist/schema/dist/entity/index.js +0 -2
- package/dist/contracts/dist/schema/dist/entity/types.js +0 -1
- package/dist/contracts/dist/schema/dist/index.js +0 -6
- package/dist/contracts/dist/server/graphql-pothos.js +0 -6
- package/dist/contracts/dist/server/index.js +0 -8
- package/dist/contracts/dist/server/mcp/createMcpServer.js +0 -4
- package/dist/contracts/dist/server/mcp/registerPresentations.js +0 -2
- package/dist/contracts/dist/server/mcp/registerPrompts.js +0 -1
- package/dist/contracts/dist/server/mcp/registerResources.js +0 -2
- package/dist/contracts/dist/server/mcp/registerTools.js +0 -1
- package/dist/contracts/dist/server/provider-mcp.js +0 -1
- package/dist/contracts/dist/server/rest-elysia.js +0 -1
- package/dist/contracts/dist/server/rest-express.js +0 -1
- package/dist/contracts/dist/server/rest-generic.js +0 -1
- package/dist/contracts/dist/server/rest-next-app.js +0 -1
- package/dist/contracts/dist/server/rest-next-pages.js +0 -1
- package/dist/contracts/dist/spec.js +0 -34
- package/dist/contracts/dist/telemetry/index.js +0 -1
- package/dist/contracts/dist/telemetry/tracker.js +0 -1
- package/dist/contracts/dist/tests/index.js +0 -1
- package/dist/contracts/dist/tests/runner.js +0 -2
- package/dist/contracts/dist/workflow/index.js +0 -1
- package/dist/contracts/dist/workflow/runner.js +0 -1
- package/dist/contracts/index.d.ts +0 -1006
- package/dist/docs/feature-flags.docblock.d.ts +0 -1
- package/dist/docs/index.d.ts +0 -1
- package/dist/entities/index.d.ts +0 -200
- package/dist/evaluation/index.d.ts +0 -162
- package/dist/events.d.ts +0 -624
- package/dist/feature-flags.feature.d.ts +0 -11
- package/dist/index.d.ts +0 -6
- package/dist/schema/dist/EnumType.js +0 -2
- package/dist/schema/dist/FieldType.js +0 -49
- package/dist/schema/dist/ScalarTypeEnum.js +0 -236
- package/dist/schema/dist/SchemaModel.js +0 -39
- package/dist/schema/dist/entity/defineEntity.js +0 -236
- package/dist/schema/dist/entity/index.js +0 -2
- package/dist/schema/dist/entity/types.js +0 -1
- package/dist/schema/dist/index.js +0 -6
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
import { registerDocBlocks } from "../../registry.js";
|
|
2
|
-
|
|
3
|
-
//#region ../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
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
import { registerDocBlocks } from "../registry.js";
|
|
2
|
-
|
|
3
|
-
//#region ../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
|
|
@@ -1,357 +0,0 @@
|
|
|
1
|
-
import { registerDocBlocks } from "../../registry.js";
|
|
2
|
-
|
|
3
|
-
//#region ../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
|
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
import { registerDocBlocks } from "../registry.js";
|
|
2
|
-
|
|
3
|
-
//#region ../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
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
import { registerDocBlocks } from "../registry.js";
|
|
2
|
-
|
|
3
|
-
//#region ../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
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
import { registerDocBlocks } from "../../registry.js";
|
|
2
|
-
|
|
3
|
-
//#region ../contracts/dist/docs/tech/schema/README.docblock.js
|
|
4
|
-
const tech_schema_README_DocBlocks = [{
|
|
5
|
-
id: "docs.tech.schema.README",
|
|
6
|
-
title: "Multi‑File Prisma Schema Conventions (per database)",
|
|
7
|
-
summary: "We adopt Prisma multi‑file schema (GA ≥ v6.7) to organize each database’s models by domain and to import core LSSM module schemas locally.",
|
|
8
|
-
kind: "reference",
|
|
9
|
-
visibility: "public",
|
|
10
|
-
route: "/docs/tech/schema/README",
|
|
11
|
-
tags: [
|
|
12
|
-
"tech",
|
|
13
|
-
"schema",
|
|
14
|
-
"README"
|
|
15
|
-
],
|
|
16
|
-
body: "# Multi‑File Prisma Schema Conventions (per database)\n\nWe adopt Prisma multi‑file schema (GA ≥ v6.7) to organize each database’s models by domain and to import core LSSM module schemas locally.\n\nCanonical layout per DB:\n\n```\nprisma/\n schema/\n main.prisma # datasource + generators only\n imported/\n lssm_sigil/*.prisma # imported models/enums only (no datasource/generator)\n lssm_content/*.prisma # idem\n <domain>/*.prisma # vertical‑specific models split by bounded context\n```\n\nNotes:\n\n- Imported files contain only `model` and `enum` blocks (strip `datasource`/`generator`).\n- Preserve `@@schema(\"…\")` annotations to keep tables in their Postgres schemas; we now explicitly list schemas in `main.prisma` to avoid P1012: `schemas = [\"public\",\"lssm_sigil\",\"lssm_content\",\"lssm_featureflags\",\"lssm_ops\",\"lssm_planning\",\"lssm_quill\",\"lssm_geoterro\"]`.\n- Use `@lssm/app.cli-database` CLI: `database import|check|generate|migrate:*|seed` to manage a single DB; `@lssm/app.cli-databases` orchestrates multiple DBs.\n\n## Typed merger config\n\n- Define imported module list once per DB with a typed config:\n\n```ts\n// prisma-merger.config.ts\nimport { defineMergedPrismaConfig } from '@lssm/app.cli-database';\n\nexport default defineMergedPrismaConfig({\n modules: [\n '@lssm/app.cli-database-sigil',\n '@lssm/app.cli-database-content',\n // ...\n ],\n});\n```\n\n- Then run `database import --target .` (no need to pass `--modules`).\n\n## Prisma Config (prisma.config.ts)\n\nWe use Prisma Config per official docs to point Prisma to the multi-file schema folder and migrations:\n\n```ts\n// prisma.config.ts\nimport path from 'node:path';\nimport { defineConfig } from 'prisma/config';\n\nexport default defineConfig({\n schema: path.join('prisma', 'schema'),\n migrations: { path: path.join('prisma', 'migrations') },\n});\n```\n\nReference: Prisma blog – Organize Your Prisma Schema into Multiple Files: https://www.prisma.io/blog/organize-your-prisma-schema-with-multi-file-support\n\n---\n\n# LSSM Auth (Sigil) – Models & Integration\n\nThis document tracks the identity models and integration points used by the LSSM Sigil module.\n\n## Models (Prisma `lssm_sigil`)\n\n- `User` – core identity with email, optional phone, role, passkeys, apiKeys\n- `Session` – session tokens and metadata; includes `activeOrganizationId`\n- `Account` – external providers (password, OAuth)\n- `Organization` – tenant boundary; includes `type` additional field\n- `Member`, `Invitation`, `Team`, `TeamMember` – org/teams\n- `Role`, `Permission`, `PolicyBinding` – RBAC\n- `ApiKey`, `Passkey` – programmable access and WebAuthn\n- `SsoProvider` – OIDC/SAML provider configuration (org- or user-scoped)\n- `OAuthApplication`, `OAuthAccessToken`, `OAuthConsent` – first/third-party OAuth\n\nThese mirror STRIT additions so Better Auth advanced plugins (admin, organization, apiKey, passkey, genericOAuth) work uniformly across apps.\n\n## Better Auth (server)\n\nEnabled methods:\n\n- Email & password\n- Phone OTP (Telnyx)\n- Passkey (WebAuthn)\n- API keys\n- Organizations & Teams\n- Generic OAuth (FranceConnect+ via OIDC with JWE/JWS using JOSE)\n\nServer config lives at `packages/lssm/modules/sigil/src/application/services/auth.ts`.\n\n## Clients (Expo / React)\n\nClient config lives at `packages/lssm/modules/sigil/src/presentation/providers/auth/expo.ts` with plugins for admin, passkey, apiKey, organization, phone, genericOAuth.\n\n## Environment Variables\n\nTelnyx (phone OTP):\n\n- `TELNYX_API_KEY`\n- `TELNYX_MESSAGING_PROFILE_ID`\n- `TELNYX_FROM_NUMBER`\n\nFranceConnect+ (prefer LSSM*… but STRIT*… fallbacks are supported):\n\n- `LSSM_FRANCECONNECTPLUS_DISCOVERY_URL`\n- `LSSM_FRANCECONNECTPLUS_CLIENT_ID`\n- `LSSM_FRANCECONNECTPLUS_CLIENT_SECRET`\n- `LSSM_FRANCECONNECTPLUS_ENC_PRIVATE_KEY_PEM` (PKCS8; RSA-OAEP-256)\n\nGeneric:\n\n- `API_URL_IDENTITIES` – base URL for Better Auth server\n- `BETTER_AUTH_SECRET` – server secret\n\nKeep this in sync with code changes to avoid drift.\n\n## HCircle domain splits and auth removal\n\n- Auth/identity models are not defined locally anymore. They come from `@lssm/app.cli-database-sigil` under the `lssm_sigil` schema.\n- `packages/hcircle/libs/database-coliving/prisma/schema/domain/` is split by domain; newsletter/waiting list lives in `newsletter.prisma` and uses `@@map(\"waiting_list\")`.\n- To avoid collisions with module names, the local event models were renamed to `SocialEvent`, `SocialEventAttendee`, and `SocialEventRecurrence` with `@@map` pointing to existing table names.\n\n---\n\n## Vertical profiles (current)\n\n### STRIT\n\n- prisma-merger modules:\n - `@lssm/app.cli-database-sigil`, `@lssm/app.cli-database-content`, `@lssm/app.cli-database-ops`, `@lssm/app.cli-database-planning`, `@lssm/app.cli-database-quill`, `@lssm/app.cli-database-geoterro`\n- main.prisma schemas:\n - `schemas = [\"public\",\"lssm_sigil\",\"lssm_content\",\"lssm_ops\",\"lssm_planning\",\"lssm_quill\",\"lssm_geoterro\"]`\n- domain splits (`packages/strit/libs/database/prisma/schema/domain/`):\n - `bookings.prisma` (Booking, StritDocument + links to Content `File` and Sigil `Organization`)\n - `commerce.prisma` (Wholesale models; `sellerId` linked to Sigil `Organization`)\n - `files.prisma` (PublicFile, PublicFileAccessLog; `ownerId`→Organization, `uploadedBy`→User)\n - `geo.prisma` (PublicCountry, PublicAddress, City; links to Spots/Series)\n - `spots.prisma`, `urbanism.prisma`, `analytics.prisma`, `onboarding.prisma`, `referrals.prisma`, `subscriptions.prisma`, `content.prisma`\n- auth models are imported from Sigil (no local auth tables).\n- Back-relations for `Organization` (e.g., `files`, seller relations) are declared in the Sigil module to avoid scattering.\n\n### ARTISANOS\n\n- prisma-merger modules:\n - `@lssm/app.cli-database-sigil`, `@lssm/app.cli-database-content`, `@lssm/app.cli-database-featureflags`, `@lssm/app.cli-database-ops`, `@lssm/app.cli-database-planning`, `@lssm/app.cli-database-quill`, `@lssm/app.cli-database-geoterro`\n- main.prisma schemas:\n - `schemas = [\"public\",\"lssm_sigil\",\"lssm_content\",\"lssm_featureflags\",\"lssm_ops\",\"lssm_planning\",\"lssm_quill\",\"lssm_geoterro\"]`\n- domain splits (`packages/artisanos/libs/database-artisan/prisma/schema/domain/`):\n - `sales.prisma` (Client, Quote, QuoteTemplate, Invoice, FollowUps)\n - `subsidies.prisma` (SubsidyProgram, AidApplication, SupportingDocument)\n - `projects.prisma` (Project, ProjectPlanningSettings)\n - `crm.prisma` (OrganizationProfessionalProfile, OrganizationCertification)\n - `professions.prisma`, `products.prisma`, `templates.prisma`, `analytics.prisma`, `onboarding.prisma`, `referrals.prisma`, `subscriptions.prisma`, `files.prisma`\n- auth/organization/team models are provided by Sigil; local legacy copies were removed.\n- Where names collide with Content, local models are prefixed (e.g., `PublicFile`) and use `@@map` to keep existing table names where applicable.\n\n## Schema Dictionary: `@lssm/lib.schema`\n\n### Purpose\n\nDescribe operation I/O once and generate:\n\n- zod (runtime validation)\n- GraphQL (Pothos types/refs)\n- JSON Schema (via `zod-to-json-schema` or native descriptors)\n\n### Primitives\n\n- **FieldType<T>**: describes a scalar or composite field and carries:\n - `zod` schema for validation\n - optional JSON Schema descriptor\n - optional GraphQL scalar reference/name\n- **SchemaModel**: named object model composed of fields. Exposes helpers:\n - `getZod(): z.ZodObject<ZodShapeFromFields<Fields>> | z.ZodArray<z.ZodObject<...>>`\n - Preserves each field's schema, optionality, and array-ness\n - Top-level lists are supported via `config.isArray: true`\n - `getJsonSchema(): JSONSchema7` (export for docs, MCP, forms)\n - `getPothosInput()` (GraphQL input object name)\n\n### Conventions\n\n- Name models with PascalCase; suffix with `Input`/`Result` when ambiguous.\n- Use explicit enums for multi-value constants; reuse the same enum across input/output.\n- Define domain enums via `defineEnum('Name', [...])` in the relevant domain package (e.g., `packages/strit/libs/contracts-strit/src/enums/`), not in `ScalarTypeEnum`.\n- Reference those enums in `SchemaModel` fields directly (they expose `getZod`, `getPothos`, `getJsonSchema`).\n\n#### Example (STRIT)\n\n```ts\n// packages/strit/libs/contracts-strit/src/enums/recurrence.ts\nimport { defineEnum } from '@lssm/lib.schema';\nexport const SpotEnum = {\n Weekday: () =>\n defineEnum('Weekday', ['MO', 'TU', 'WE', 'TH', 'FR', 'SA', 'SU'] as const),\n RecurrenceFrequency: () =>\n defineEnum('RecurrenceFrequency', [\n 'DAILY',\n 'WEEKLY',\n 'MONTHLY',\n 'YEARLY',\n ] as const),\n} as const;\n```\n\n```ts\n// usage in contracts\nfrequency: { type: SpotEnum.RecurrenceFrequency(), isOptional: false },\nbyWeekday: { type: SpotEnum.Weekday(), isOptional: true, isArray: true },\n```\n\n- Use `Date` type for temporal values and ensure ISO strings in JSON transports where needed.\n\n### Mapping rules (summary)\n\n- Strings → GraphQL `String`\n- Numbers → `Int` if safe 32-bit integer else `Float`\n- Booleans → `Boolean`\n- Dates → custom `Date` scalar\n- Arrays<T> → list of mapped T (set `isArray: true` on the field)\n- Top-level arrays → set `isArray: true` on the model config\n- Objects → input/output object types with stable field order\n- Unions → supported for output; input unions map to JSON (structural input is not supported by GraphQL)\n\n### JSON Schema export\n\nPrefer `getZod()` + `zod-to-json-schema` for consistency. For advanced cases, provide a custom `getJsonSchema()` on the model.\n\n### Example\n\n```ts\nimport { ScalarTypeEnum, SchemaModel } from '@lssm/lib.schema';\n\n// Nested model\nconst Weekday = new SchemaModel({\n name: 'Weekday',\n fields: {\n value: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n },\n});\n\n// Parent model with array field and nested object\nconst Rule = new SchemaModel({\n name: 'Rule',\n fields: {\n timezone: { type: ScalarTypeEnum.TimeZone(), isOptional: false },\n byWeekday: { type: Weekday, isOptional: true, isArray: true },\n },\n});\n\nconst CreateThingInput = new SchemaModel({\n name: 'CreateThingInput',\n fields: {\n name: { type: ScalarTypeEnum.NonEmptyString(), isOptional: false },\n rule: { type: Rule, isOptional: false },\n },\n});\n\n// zod\nconst z = CreateThingInput.getZod();\n```\n"
|
|
17
|
-
}];
|
|
18
|
-
registerDocBlocks(tech_schema_README_DocBlocks);
|
|
19
|
-
|
|
20
|
-
//#endregion
|
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
import { registerDocBlocks } from "../../registry.js";
|
|
2
|
-
|
|
3
|
-
//#region ../contracts/dist/docs/tech/studio/learning-events.docblock.js
|
|
4
|
-
const tech_studio_learning_events_DocBlocks = [{
|
|
5
|
-
id: "docs.tech.studio.learning-events",
|
|
6
|
-
title: "Studio Learning Events",
|
|
7
|
-
summary: "Studio persists learning/activity events to the database; Sandbox keeps learning local-first and unlogged.",
|
|
8
|
-
kind: "reference",
|
|
9
|
-
visibility: "public",
|
|
10
|
-
route: "/docs/tech/studio/learning-events",
|
|
11
|
-
tags: [
|
|
12
|
-
"studio",
|
|
13
|
-
"learning",
|
|
14
|
-
"events",
|
|
15
|
-
"analytics",
|
|
16
|
-
"sandbox"
|
|
17
|
-
],
|
|
18
|
-
body: `# Studio Learning Events
|
|
19
|
-
|
|
20
|
-
Studio emits lightweight **learning/activity events** to support onboarding, ambient coaching, and learning journeys.
|
|
21
|
-
|
|
22
|
-
## Persistence model
|
|
23
|
-
|
|
24
|
-
- **Studio**: events are persisted to the database in \`StudioLearningEvent\` and are organization-scoped (optionally project-scoped).
|
|
25
|
-
- **Sandbox**: events remain **local-only** (unlogged); they must never be sent to backend services.
|
|
26
|
-
|
|
27
|
-
## GraphQL API
|
|
28
|
-
|
|
29
|
-
- \`recordLearningEvent(input: { name, projectId?, payload? })\`
|
|
30
|
-
- \`myLearningEvents(projectId?, limit?)\`
|
|
31
|
-
- \`myOnboardingTracks(productId?, includeProgress?)\`
|
|
32
|
-
- \`myOnboardingProgress(trackKey)\`
|
|
33
|
-
- \`dismissOnboardingTrack(trackKey)\`
|
|
34
|
-
|
|
35
|
-
## Common event names (convention)
|
|
36
|
-
|
|
37
|
-
- \`module.navigated\` — user navigated to a Studio module (payload at minimum: \`{ moduleId }\`).
|
|
38
|
-
- \`studio.template.instantiated\` — created a new Studio project (starter template). Payload commonly includes \`{ templateId, projectSlug }\`.
|
|
39
|
-
- \`spec.changed\` — created or updated a Studio spec. Payload may include \`{ action: 'create' | 'update', specId?, specType? }\`.
|
|
40
|
-
- \`regeneration.completed\` — finished a “regen/deploy” action (currently emitted on successful Studio deploy actions).
|
|
41
|
-
- \`studio.evolution.applied\` — completed an Evolution session (payload commonly includes \`{ evolutionSessionId }\`).
|
|
42
|
-
|
|
43
|
-
These events are intentionally minimal and must avoid PII/secrets in payloads.
|
|
44
|
-
`
|
|
45
|
-
}];
|
|
46
|
-
registerDocBlocks(tech_studio_learning_events_DocBlocks);
|
|
47
|
-
|
|
48
|
-
//#endregion
|