sandstream-kit 1.0.0
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/LICENSE +21 -0
- package/README.md +617 -0
- package/dist/adapters/api-key-adapter.d.ts +35 -0
- package/dist/adapters/api-key-adapter.js +46 -0
- package/dist/adapters/api-key-adapter.js.map +1 -0
- package/dist/adapters/clerk-auth.d.ts +6 -0
- package/dist/adapters/clerk-auth.js +20 -0
- package/dist/adapters/clerk-auth.js.map +1 -0
- package/dist/adapters/cloudflare-r2.d.ts +6 -0
- package/dist/adapters/cloudflare-r2.js +136 -0
- package/dist/adapters/cloudflare-r2.js.map +1 -0
- package/dist/adapters/expo-eas.d.ts +6 -0
- package/dist/adapters/expo-eas.js +129 -0
- package/dist/adapters/expo-eas.js.map +1 -0
- package/dist/adapters/flagsmith-flags.d.ts +5 -0
- package/dist/adapters/flagsmith-flags.js +20 -0
- package/dist/adapters/flagsmith-flags.js.map +1 -0
- package/dist/adapters/flyio-hosting.d.ts +2 -0
- package/dist/adapters/flyio-hosting.js +143 -0
- package/dist/adapters/flyio-hosting.js.map +1 -0
- package/dist/adapters/index.d.ts +6 -0
- package/dist/adapters/index.js +48 -0
- package/dist/adapters/index.js.map +1 -0
- package/dist/adapters/inngest-background.d.ts +5 -0
- package/dist/adapters/inngest-background.js +19 -0
- package/dist/adapters/inngest-background.js.map +1 -0
- package/dist/adapters/liveblocks-realtime.d.ts +11 -0
- package/dist/adapters/liveblocks-realtime.js +62 -0
- package/dist/adapters/liveblocks-realtime.js.map +1 -0
- package/dist/adapters/loops-email.d.ts +6 -0
- package/dist/adapters/loops-email.js +18 -0
- package/dist/adapters/loops-email.js.map +1 -0
- package/dist/adapters/neon-db.d.ts +10 -0
- package/dist/adapters/neon-db.js +94 -0
- package/dist/adapters/neon-db.js.map +1 -0
- package/dist/adapters/planetscale-db.d.ts +11 -0
- package/dist/adapters/planetscale-db.js +134 -0
- package/dist/adapters/planetscale-db.js.map +1 -0
- package/dist/adapters/posthog-analytics.d.ts +6 -0
- package/dist/adapters/posthog-analytics.js +22 -0
- package/dist/adapters/posthog-analytics.js.map +1 -0
- package/dist/adapters/railway-hosting.d.ts +2 -0
- package/dist/adapters/railway-hosting.js +136 -0
- package/dist/adapters/railway-hosting.js.map +1 -0
- package/dist/adapters/resend-email.d.ts +35 -0
- package/dist/adapters/resend-email.js +109 -0
- package/dist/adapters/resend-email.js.map +1 -0
- package/dist/adapters/searxng-instance.d.ts +6 -0
- package/dist/adapters/searxng-instance.js +240 -0
- package/dist/adapters/searxng-instance.js.map +1 -0
- package/dist/adapters/sentry-monitoring.d.ts +7 -0
- package/dist/adapters/sentry-monitoring.js +27 -0
- package/dist/adapters/sentry-monitoring.js.map +1 -0
- package/dist/adapters/stripe-payments.d.ts +6 -0
- package/dist/adapters/stripe-payments.js +134 -0
- package/dist/adapters/stripe-payments.js.map +1 -0
- package/dist/adapters/supabase-db.d.ts +6 -0
- package/dist/adapters/supabase-db.js +130 -0
- package/dist/adapters/supabase-db.js.map +1 -0
- package/dist/adapters/tinybird-analytics.d.ts +5 -0
- package/dist/adapters/tinybird-analytics.js +20 -0
- package/dist/adapters/tinybird-analytics.js.map +1 -0
- package/dist/adapters/trigger-background.d.ts +6 -0
- package/dist/adapters/trigger-background.js +20 -0
- package/dist/adapters/trigger-background.js.map +1 -0
- package/dist/adapters/types.d.ts +7 -0
- package/dist/adapters/types.js +2 -0
- package/dist/adapters/types.js.map +1 -0
- package/dist/adapters/upstash-redis.d.ts +6 -0
- package/dist/adapters/upstash-redis.js +88 -0
- package/dist/adapters/upstash-redis.js.map +1 -0
- package/dist/adapters/vercel-hosting.d.ts +6 -0
- package/dist/adapters/vercel-hosting.js +112 -0
- package/dist/adapters/vercel-hosting.js.map +1 -0
- package/dist/agent-adapter-model.d.ts +108 -0
- package/dist/agent-adapter-model.js +6 -0
- package/dist/agent-adapter-model.js.map +1 -0
- package/dist/agent-adapter-service.d.ts +67 -0
- package/dist/agent-adapter-service.js +299 -0
- package/dist/agent-adapter-service.js.map +1 -0
- package/dist/agent-config.d.ts +56 -0
- package/dist/agent-config.js +129 -0
- package/dist/agent-config.js.map +1 -0
- package/dist/agent-governance-model.d.ts +128 -0
- package/dist/agent-governance-model.js +6 -0
- package/dist/agent-governance-model.js.map +1 -0
- package/dist/agent-governance-service.d.ts +101 -0
- package/dist/agent-governance-service.js +319 -0
- package/dist/agent-governance-service.js.map +1 -0
- package/dist/alert-rules-engine.d.ts +102 -0
- package/dist/alert-rules-engine.js +210 -0
- package/dist/alert-rules-engine.js.map +1 -0
- package/dist/analytics-service.d.ts +126 -0
- package/dist/analytics-service.js +318 -0
- package/dist/analytics-service.js.map +1 -0
- package/dist/analyze.d.ts +19 -0
- package/dist/analyze.js +311 -0
- package/dist/analyze.js.map +1 -0
- package/dist/apm-instrumentor.d.ts +119 -0
- package/dist/apm-instrumentor.js +225 -0
- package/dist/apm-instrumentor.js.map +1 -0
- package/dist/approval-model.d.ts +82 -0
- package/dist/approval-model.js +6 -0
- package/dist/approval-model.js.map +1 -0
- package/dist/approval-service.d.ts +39 -0
- package/dist/approval-service.js +236 -0
- package/dist/approval-service.js.map +1 -0
- package/dist/approval.d.ts +22 -0
- package/dist/approval.js +148 -0
- package/dist/approval.js.map +1 -0
- package/dist/audit-logging-model.d.ts +157 -0
- package/dist/audit-logging-model.js +6 -0
- package/dist/audit-logging-model.js.map +1 -0
- package/dist/audit-logging-service.d.ts +89 -0
- package/dist/audit-logging-service.js +367 -0
- package/dist/audit-logging-service.js.map +1 -0
- package/dist/audit-secrets.d.ts +42 -0
- package/dist/audit-secrets.js +126 -0
- package/dist/audit-secrets.js.map +1 -0
- package/dist/audit.d.ts +43 -0
- package/dist/audit.js +286 -0
- package/dist/audit.js.map +1 -0
- package/dist/author-dashboard.d.ts +84 -0
- package/dist/author-dashboard.js +204 -0
- package/dist/author-dashboard.js.map +1 -0
- package/dist/author-notifications.d.ts +130 -0
- package/dist/author-notifications.js +261 -0
- package/dist/author-notifications.js.map +1 -0
- package/dist/author-verification.d.ts +79 -0
- package/dist/author-verification.js +257 -0
- package/dist/author-verification.js.map +1 -0
- package/dist/autonomous-setup-model.d.ts +117 -0
- package/dist/autonomous-setup-model.js +6 -0
- package/dist/autonomous-setup-model.js.map +1 -0
- package/dist/autonomous-setup-service.d.ts +74 -0
- package/dist/autonomous-setup-service.js +325 -0
- package/dist/autonomous-setup-service.js.map +1 -0
- package/dist/badge-system.d.ts +70 -0
- package/dist/badge-system.js +210 -0
- package/dist/badge-system.js.map +1 -0
- package/dist/baseline.d.ts +34 -0
- package/dist/baseline.js +78 -0
- package/dist/baseline.js.map +1 -0
- package/dist/beta-program-service.d.ts +112 -0
- package/dist/beta-program-service.js +240 -0
- package/dist/beta-program-service.js.map +1 -0
- package/dist/budget.d.ts +34 -0
- package/dist/budget.js +159 -0
- package/dist/budget.js.map +1 -0
- package/dist/bumblebee.d.ts +143 -0
- package/dist/bumblebee.js +384 -0
- package/dist/bumblebee.js.map +1 -0
- package/dist/cache-manager.d.ts +97 -0
- package/dist/cache-manager.js +244 -0
- package/dist/cache-manager.js.map +1 -0
- package/dist/cdn-adapter.d.ts +64 -0
- package/dist/cdn-adapter.js +263 -0
- package/dist/cdn-adapter.js.map +1 -0
- package/dist/certification-workflow-model.d.ts +95 -0
- package/dist/certification-workflow-model.js +6 -0
- package/dist/certification-workflow-model.js.map +1 -0
- package/dist/certification-workflow-service.d.ts +72 -0
- package/dist/certification-workflow-service.js +305 -0
- package/dist/certification-workflow-service.js.map +1 -0
- package/dist/check-design.d.ts +38 -0
- package/dist/check-design.js +256 -0
- package/dist/check-design.js.map +1 -0
- package/dist/check-gitignore.d.ts +39 -0
- package/dist/check-gitignore.js +156 -0
- package/dist/check-gitignore.js.map +1 -0
- package/dist/check-hooks.d.ts +15 -0
- package/dist/check-hooks.js +72 -0
- package/dist/check-hooks.js.map +1 -0
- package/dist/check-lock.d.ts +16 -0
- package/dist/check-lock.js +94 -0
- package/dist/check-lock.js.map +1 -0
- package/dist/check-secrets.d.ts +11 -0
- package/dist/check-secrets.js +320 -0
- package/dist/check-secrets.js.map +1 -0
- package/dist/check-security.d.ts +13 -0
- package/dist/check-security.js +887 -0
- package/dist/check-security.js.map +1 -0
- package/dist/check-services.d.ts +10 -0
- package/dist/check-services.js +44 -0
- package/dist/check-services.js.map +1 -0
- package/dist/check-skills.d.ts +8 -0
- package/dist/check-skills.js +26 -0
- package/dist/check-skills.js.map +1 -0
- package/dist/check-tests.d.ts +43 -0
- package/dist/check-tests.js +175 -0
- package/dist/check-tests.js.map +1 -0
- package/dist/check-tools.d.ts +8 -0
- package/dist/check-tools.js +42 -0
- package/dist/check-tools.js.map +1 -0
- package/dist/check-web-search.d.ts +12 -0
- package/dist/check-web-search.js +168 -0
- package/dist/check-web-search.js.map +1 -0
- package/dist/ci-cd-publisher.d.ts +162 -0
- package/dist/ci-cd-publisher.js +319 -0
- package/dist/ci-cd-publisher.js.map +1 -0
- package/dist/cli.d.ts +2 -0
- package/dist/cli.js +4074 -0
- package/dist/cli.js.map +1 -0
- package/dist/clone.d.ts +25 -0
- package/dist/clone.js +73 -0
- package/dist/clone.js.map +1 -0
- package/dist/completions.d.ts +8 -0
- package/dist/completions.js +250 -0
- package/dist/completions.js.map +1 -0
- package/dist/compression-manager.d.ts +107 -0
- package/dist/compression-manager.js +250 -0
- package/dist/compression-manager.js.map +1 -0
- package/dist/config.d.ts +233 -0
- package/dist/config.js +255 -0
- package/dist/config.js.map +1 -0
- package/dist/context.d.ts +38 -0
- package/dist/context.js +86 -0
- package/dist/context.js.map +1 -0
- package/dist/cost-monitor.d.ts +72 -0
- package/dist/cost-monitor.js +218 -0
- package/dist/cost-monitor.js.map +1 -0
- package/dist/create-plugin.d.ts +22 -0
- package/dist/create-plugin.js +266 -0
- package/dist/create-plugin.js.map +1 -0
- package/dist/database.d.ts +123 -0
- package/dist/database.js +354 -0
- package/dist/database.js.map +1 -0
- package/dist/datadog-adapter.d.ts +60 -0
- package/dist/datadog-adapter.js +245 -0
- package/dist/datadog-adapter.js.map +1 -0
- package/dist/doctor.d.ts +15 -0
- package/dist/doctor.js +131 -0
- package/dist/doctor.js.map +1 -0
- package/dist/documentation-generator.d.ts +226 -0
- package/dist/documentation-generator.js +348 -0
- package/dist/documentation-generator.js.map +1 -0
- package/dist/elevation-scopes.d.ts +40 -0
- package/dist/elevation-scopes.js +110 -0
- package/dist/elevation-scopes.js.map +1 -0
- package/dist/elevation.d.ts +102 -0
- package/dist/elevation.js +449 -0
- package/dist/elevation.js.map +1 -0
- package/dist/env-diff.d.ts +27 -0
- package/dist/env-diff.js +104 -0
- package/dist/env-diff.js.map +1 -0
- package/dist/env-inspect.d.ts +28 -0
- package/dist/env-inspect.js +81 -0
- package/dist/env-inspect.js.map +1 -0
- package/dist/env-switch.d.ts +37 -0
- package/dist/env-switch.js +102 -0
- package/dist/env-switch.js.map +1 -0
- package/dist/environment.d.ts +27 -0
- package/dist/environment.js +148 -0
- package/dist/environment.js.map +1 -0
- package/dist/error-tracker.d.ts +92 -0
- package/dist/error-tracker.js +206 -0
- package/dist/error-tracker.js.map +1 -0
- package/dist/escalate.d.ts +11 -0
- package/dist/escalate.js +73 -0
- package/dist/escalate.js.map +1 -0
- package/dist/event-stream.d.ts +81 -0
- package/dist/event-stream.js +161 -0
- package/dist/event-stream.js.map +1 -0
- package/dist/fix.d.ts +42 -0
- package/dist/fix.js +419 -0
- package/dist/fix.js.map +1 -0
- package/dist/governance-middleware.d.ts +22 -0
- package/dist/governance-middleware.js +173 -0
- package/dist/governance-middleware.js.map +1 -0
- package/dist/governance.d.ts +44 -0
- package/dist/governance.js +236 -0
- package/dist/governance.js.map +1 -0
- package/dist/hooks.d.ts +25 -0
- package/dist/hooks.js +281 -0
- package/dist/hooks.js.map +1 -0
- package/dist/id-generator.d.ts +43 -0
- package/dist/id-generator.js +47 -0
- package/dist/id-generator.js.map +1 -0
- package/dist/image-optimizer.d.ts +92 -0
- package/dist/image-optimizer.js +202 -0
- package/dist/image-optimizer.js.map +1 -0
- package/dist/install.d.ts +15 -0
- package/dist/install.js +59 -0
- package/dist/install.js.map +1 -0
- package/dist/lock.d.ts +82 -0
- package/dist/lock.js +264 -0
- package/dist/lock.js.map +1 -0
- package/dist/login.d.ts +23 -0
- package/dist/login.js +132 -0
- package/dist/login.js.map +1 -0
- package/dist/mcp-kit-tools-model.d.ts +195 -0
- package/dist/mcp-kit-tools-model.js +6 -0
- package/dist/mcp-kit-tools-model.js.map +1 -0
- package/dist/mcp-kit-tools-service.d.ts +127 -0
- package/dist/mcp-kit-tools-service.js +943 -0
- package/dist/mcp-kit-tools-service.js.map +1 -0
- package/dist/mcp-orchestrator.d.ts +70 -0
- package/dist/mcp-orchestrator.js +175 -0
- package/dist/mcp-orchestrator.js.map +1 -0
- package/dist/mcp-server.d.ts +3 -0
- package/dist/mcp-server.js +722 -0
- package/dist/mcp-server.js.map +1 -0
- package/dist/middleware/rate-limiter.d.ts +74 -0
- package/dist/middleware/rate-limiter.js +342 -0
- package/dist/middleware/rate-limiter.js.map +1 -0
- package/dist/migration-runner.d.ts +66 -0
- package/dist/migration-runner.js +192 -0
- package/dist/migration-runner.js.map +1 -0
- package/dist/migrations.d.ts +25 -0
- package/dist/migrations.js +530 -0
- package/dist/migrations.js.map +1 -0
- package/dist/moderation-system.d.ts +153 -0
- package/dist/moderation-system.js +338 -0
- package/dist/moderation-system.js.map +1 -0
- package/dist/multi-agent-workflow-model.d.ts +125 -0
- package/dist/multi-agent-workflow-model.js +6 -0
- package/dist/multi-agent-workflow-model.js.map +1 -0
- package/dist/multi-agent-workflow-service.d.ts +102 -0
- package/dist/multi-agent-workflow-service.js +452 -0
- package/dist/multi-agent-workflow-service.js.map +1 -0
- package/dist/onepassword.d.ts +75 -0
- package/dist/onepassword.js +140 -0
- package/dist/onepassword.js.map +1 -0
- package/dist/open.d.ts +30 -0
- package/dist/open.js +166 -0
- package/dist/open.js.map +1 -0
- package/dist/output.d.ts +32 -0
- package/dist/output.js +295 -0
- package/dist/output.js.map +1 -0
- package/dist/partner-service.d.ts +101 -0
- package/dist/partner-service.js +191 -0
- package/dist/partner-service.js.map +1 -0
- package/dist/payout-service.d.ts +136 -0
- package/dist/payout-service.js +293 -0
- package/dist/payout-service.js.map +1 -0
- package/dist/pkg.d.ts +30 -0
- package/dist/pkg.js +162 -0
- package/dist/pkg.js.map +1 -0
- package/dist/plugin-loader.d.ts +16 -0
- package/dist/plugin-loader.js +124 -0
- package/dist/plugin-loader.js.map +1 -0
- package/dist/plugin-registry-model.d.ts +133 -0
- package/dist/plugin-registry-model.js +6 -0
- package/dist/plugin-registry-model.js.map +1 -0
- package/dist/plugin-registry-service.d.ts +109 -0
- package/dist/plugin-registry-service.js +361 -0
- package/dist/plugin-registry-service.js.map +1 -0
- package/dist/plugin-registry.d.ts +58 -0
- package/dist/plugin-registry.js +108 -0
- package/dist/plugin-registry.js.map +1 -0
- package/dist/plugin-updates.d.ts +135 -0
- package/dist/plugin-updates.js +326 -0
- package/dist/plugin-updates.js.map +1 -0
- package/dist/plugins-cli.d.ts +7 -0
- package/dist/plugins-cli.js +157 -0
- package/dist/plugins-cli.js.map +1 -0
- package/dist/plugins.d.ts +88 -0
- package/dist/plugins.js +251 -0
- package/dist/plugins.js.map +1 -0
- package/dist/policy.d.ts +66 -0
- package/dist/policy.js +160 -0
- package/dist/policy.js.map +1 -0
- package/dist/post-pull-audit.d.ts +39 -0
- package/dist/post-pull-audit.js +151 -0
- package/dist/post-pull-audit.js.map +1 -0
- package/dist/provision.d.ts +17 -0
- package/dist/provision.js +147 -0
- package/dist/provision.js.map +1 -0
- package/dist/query-optimizer.d.ts +102 -0
- package/dist/query-optimizer.js +199 -0
- package/dist/query-optimizer.js.map +1 -0
- package/dist/read-only-mode.d.ts +46 -0
- package/dist/read-only-mode.js +71 -0
- package/dist/read-only-mode.js.map +1 -0
- package/dist/redis-adapter.d.ts +71 -0
- package/dist/redis-adapter.js +278 -0
- package/dist/redis-adapter.js.map +1 -0
- package/dist/resilience-tests.d.ts +120 -0
- package/dist/resilience-tests.js +293 -0
- package/dist/resilience-tests.js.map +1 -0
- package/dist/revocation.d.ts +22 -0
- package/dist/revocation.js +100 -0
- package/dist/revocation.js.map +1 -0
- package/dist/run.d.ts +21 -0
- package/dist/run.js +80 -0
- package/dist/run.js.map +1 -0
- package/dist/scan-build.d.ts +18 -0
- package/dist/scan-build.js +100 -0
- package/dist/scan-build.js.map +1 -0
- package/dist/scan-plaintext.d.ts +24 -0
- package/dist/scan-plaintext.js +147 -0
- package/dist/scan-plaintext.js.map +1 -0
- package/dist/scan-staged.d.ts +15 -0
- package/dist/scan-staged.js +70 -0
- package/dist/scan-staged.js.map +1 -0
- package/dist/scan-transcripts.d.ts +23 -0
- package/dist/scan-transcripts.js +93 -0
- package/dist/scan-transcripts.js.map +1 -0
- package/dist/secret-backends.d.ts +50 -0
- package/dist/secret-backends.js +510 -0
- package/dist/secret-backends.js.map +1 -0
- package/dist/secret-expiration.d.ts +46 -0
- package/dist/secret-expiration.js +172 -0
- package/dist/secret-expiration.js.map +1 -0
- package/dist/secrets-migrate.d.ts +75 -0
- package/dist/secrets-migrate.js +185 -0
- package/dist/secrets-migrate.js.map +1 -0
- package/dist/secrets-model.d.ts +77 -0
- package/dist/secrets-model.js +6 -0
- package/dist/secrets-model.js.map +1 -0
- package/dist/secrets-onecli.d.ts +65 -0
- package/dist/secrets-onecli.js +113 -0
- package/dist/secrets-onecli.js.map +1 -0
- package/dist/secrets-propagate.d.ts +48 -0
- package/dist/secrets-propagate.js +201 -0
- package/dist/secrets-propagate.js.map +1 -0
- package/dist/secrets-pull.d.ts +34 -0
- package/dist/secrets-pull.js +118 -0
- package/dist/secrets-pull.js.map +1 -0
- package/dist/secrets-purge-history.d.ts +53 -0
- package/dist/secrets-purge-history.js +144 -0
- package/dist/secrets-purge-history.js.map +1 -0
- package/dist/secrets-rotate-cli.d.ts +54 -0
- package/dist/secrets-rotate-cli.js +438 -0
- package/dist/secrets-rotate-cli.js.map +1 -0
- package/dist/secrets-rotate.d.ts +38 -0
- package/dist/secrets-rotate.js +65 -0
- package/dist/secrets-rotate.js.map +1 -0
- package/dist/secrets-service.d.ts +73 -0
- package/dist/secrets-service.js +283 -0
- package/dist/secrets-service.js.map +1 -0
- package/dist/secrets-set.d.ts +25 -0
- package/dist/secrets-set.js +33 -0
- package/dist/secrets-set.js.map +1 -0
- package/dist/secrets-sync.d.ts +21 -0
- package/dist/secrets-sync.js +215 -0
- package/dist/secrets-sync.js.map +1 -0
- package/dist/secrets-validate.d.ts +41 -0
- package/dist/secrets-validate.js +126 -0
- package/dist/secrets-validate.js.map +1 -0
- package/dist/secrets-vault-migrate.d.ts +71 -0
- package/dist/secrets-vault-migrate.js +258 -0
- package/dist/secrets-vault-migrate.js.map +1 -0
- package/dist/secrets.d.ts +16 -0
- package/dist/secrets.js +72 -0
- package/dist/secrets.js.map +1 -0
- package/dist/security-hardening.d.ts +150 -0
- package/dist/security-hardening.js +275 -0
- package/dist/security-hardening.js.map +1 -0
- package/dist/security-policy.d.ts +89 -0
- package/dist/security-policy.js +174 -0
- package/dist/security-policy.js.map +1 -0
- package/dist/security-prescan.d.ts +117 -0
- package/dist/security-prescan.js +566 -0
- package/dist/security-prescan.js.map +1 -0
- package/dist/sentry-adapter.d.ts +49 -0
- package/dist/sentry-adapter.js +227 -0
- package/dist/sentry-adapter.js.map +1 -0
- package/dist/service-adapter.d.ts +94 -0
- package/dist/service-adapter.js +162 -0
- package/dist/service-adapter.js.map +1 -0
- package/dist/skills.d.ts +13 -0
- package/dist/skills.js +17 -0
- package/dist/skills.js.map +1 -0
- package/dist/sla-monitor.d.ts +107 -0
- package/dist/sla-monitor.js +233 -0
- package/dist/sla-monitor.js.map +1 -0
- package/dist/stack-detector.d.ts +12 -0
- package/dist/stack-detector.js +251 -0
- package/dist/stack-detector.js.map +1 -0
- package/dist/team-model.d.ts +58 -0
- package/dist/team-model.js +83 -0
- package/dist/team-model.js.map +1 -0
- package/dist/team-service.d.ts +54 -0
- package/dist/team-service.js +206 -0
- package/dist/team-service.js.map +1 -0
- package/dist/toml-generator.d.ts +8 -0
- package/dist/toml-generator.js +223 -0
- package/dist/toml-generator.js.map +1 -0
- package/dist/triage-sandbox.d.ts +34 -0
- package/dist/triage-sandbox.js +167 -0
- package/dist/triage-sandbox.js.map +1 -0
- package/dist/triage.d.ts +30 -0
- package/dist/triage.js +79 -0
- package/dist/triage.js.map +1 -0
- package/dist/update-check.d.ts +13 -0
- package/dist/update-check.js +91 -0
- package/dist/update-check.js.map +1 -0
- package/dist/utils/colors.d.ts +14 -0
- package/dist/utils/colors.js +15 -0
- package/dist/utils/colors.js.map +1 -0
- package/dist/utils/didYouMean.d.ts +15 -0
- package/dist/utils/didYouMean.js +47 -0
- package/dist/utils/didYouMean.js.map +1 -0
- package/dist/utils/exec.d.ts +21 -0
- package/dist/utils/exec.js +23 -0
- package/dist/utils/exec.js.map +1 -0
- package/dist/utils/execFileNoThrow.d.ts +14 -0
- package/dist/utils/execFileNoThrow.js +29 -0
- package/dist/utils/execFileNoThrow.js.map +1 -0
- package/dist/utils/flags.d.ts +19 -0
- package/dist/utils/flags.js +36 -0
- package/dist/utils/flags.js.map +1 -0
- package/dist/utils/parseCommand.d.ts +16 -0
- package/dist/utils/parseCommand.js +13 -0
- package/dist/utils/parseCommand.js.map +1 -0
- package/dist/utils/prompt.d.ts +13 -0
- package/dist/utils/prompt.js +35 -0
- package/dist/utils/prompt.js.map +1 -0
- package/dist/utils/promptSelect.d.ts +19 -0
- package/dist/utils/promptSelect.js +89 -0
- package/dist/utils/promptSelect.js.map +1 -0
- package/dist/utils/redactSecrets.d.ts +24 -0
- package/dist/utils/redactSecrets.js +134 -0
- package/dist/utils/redactSecrets.js.map +1 -0
- package/dist/validation/dynamic-schema.d.ts +29 -0
- package/dist/validation/dynamic-schema.js +76 -0
- package/dist/validation/dynamic-schema.js.map +1 -0
- package/package.json +52 -0
|
@@ -0,0 +1,245 @@
|
|
|
1
|
+
import { IdGenerators } from "./id-generator.js";
|
|
2
|
+
// ─── Datadog APM & Analytics Adapter ──────────────────────────────────────
|
|
3
|
+
import { AbstractServiceAdapter, } from "./service-adapter.js";
|
|
4
|
+
/**
|
|
5
|
+
* Datadog adapter for APM, metrics, and analytics.
|
|
6
|
+
*/
|
|
7
|
+
export class DatadogAdapter extends AbstractServiceAdapter {
|
|
8
|
+
lastHealthCheck = new Date().toISOString();
|
|
9
|
+
healthCheckErrors = 0;
|
|
10
|
+
metrics = new Map();
|
|
11
|
+
traces = new Map();
|
|
12
|
+
constructor(config = { enabled: false }) {
|
|
13
|
+
super("datadog", "1.0.0", config);
|
|
14
|
+
}
|
|
15
|
+
async connect() {
|
|
16
|
+
if (!this.config.enabled) {
|
|
17
|
+
this.connected = false;
|
|
18
|
+
return;
|
|
19
|
+
}
|
|
20
|
+
if (!this.config.apiKey) {
|
|
21
|
+
throw new Error("Datadog API Key is required");
|
|
22
|
+
}
|
|
23
|
+
// Validate API key format (should be alphanumeric)
|
|
24
|
+
if (!this.config.apiKey.match(/^[a-f0-9]{32}$/i)) {
|
|
25
|
+
throw new Error("Invalid Datadog API Key format");
|
|
26
|
+
}
|
|
27
|
+
// Simulate connection test
|
|
28
|
+
await new Promise((resolve) => setTimeout(resolve, 50));
|
|
29
|
+
this.connected = true;
|
|
30
|
+
// Flush queued events
|
|
31
|
+
await this.flushQueue();
|
|
32
|
+
}
|
|
33
|
+
async disconnect() {
|
|
34
|
+
if (this.healthCheckInterval) {
|
|
35
|
+
clearInterval(this.healthCheckInterval);
|
|
36
|
+
this.healthCheckInterval = null;
|
|
37
|
+
}
|
|
38
|
+
this.metrics.clear();
|
|
39
|
+
this.traces.clear();
|
|
40
|
+
this.connected = false;
|
|
41
|
+
}
|
|
42
|
+
async getHealth() {
|
|
43
|
+
const responseTime = Math.random() * 50;
|
|
44
|
+
try {
|
|
45
|
+
if (!this.connected) {
|
|
46
|
+
this.healthCheckErrors++;
|
|
47
|
+
}
|
|
48
|
+
this.lastHealthCheck = new Date().toISOString();
|
|
49
|
+
const status = this.healthCheckErrors < 3
|
|
50
|
+
? this.connected
|
|
51
|
+
? "healthy"
|
|
52
|
+
: "degraded"
|
|
53
|
+
: "unhealthy";
|
|
54
|
+
return {
|
|
55
|
+
status,
|
|
56
|
+
lastCheck: this.lastHealthCheck,
|
|
57
|
+
responseTime: Math.round(responseTime),
|
|
58
|
+
errorCount: this.healthCheckErrors,
|
|
59
|
+
};
|
|
60
|
+
}
|
|
61
|
+
catch {
|
|
62
|
+
this.healthCheckErrors++;
|
|
63
|
+
return {
|
|
64
|
+
status: "unhealthy",
|
|
65
|
+
lastCheck: new Date().toISOString(),
|
|
66
|
+
responseTime: -1,
|
|
67
|
+
errorCount: this.healthCheckErrors,
|
|
68
|
+
};
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
async sendEvent(event) {
|
|
72
|
+
if (!this.connected) {
|
|
73
|
+
throw new Error("Not connected to Datadog");
|
|
74
|
+
}
|
|
75
|
+
// Validate event
|
|
76
|
+
if (!event.type || !event.data) {
|
|
77
|
+
throw new Error("Invalid event format");
|
|
78
|
+
}
|
|
79
|
+
// Simulate sending to Datadog (fixed delay to avoid flaky tests)
|
|
80
|
+
await new Promise((resolve) => setTimeout(resolve, 5));
|
|
81
|
+
// Simulate occasional failures (disabled in test — use explicit error injection instead)
|
|
82
|
+
// if (Math.random() < 0.01) {
|
|
83
|
+
// throw new Error("Simulated Datadog API error");
|
|
84
|
+
// }
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* Record a metric value.
|
|
88
|
+
*/
|
|
89
|
+
async recordMetric(name, value, tags) {
|
|
90
|
+
this.metrics.set(name, value);
|
|
91
|
+
const event = {
|
|
92
|
+
type: "metric",
|
|
93
|
+
data: {
|
|
94
|
+
name,
|
|
95
|
+
value,
|
|
96
|
+
tags,
|
|
97
|
+
timestamp: Date.now(),
|
|
98
|
+
},
|
|
99
|
+
timestamp: new Date().toISOString(),
|
|
100
|
+
};
|
|
101
|
+
return this.send(event);
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* Increment a metric counter.
|
|
105
|
+
*/
|
|
106
|
+
async incrementMetric(name, increment = 1) {
|
|
107
|
+
const current = this.metrics.get(name) || 0;
|
|
108
|
+
this.metrics.set(name, current + increment);
|
|
109
|
+
return this.recordMetric(name, current + increment);
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* Get current metric value.
|
|
113
|
+
*/
|
|
114
|
+
getMetric(name) {
|
|
115
|
+
return this.metrics.get(name);
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* Start a trace span.
|
|
119
|
+
*/
|
|
120
|
+
async startSpan(traceId, spanName, parentSpanId) {
|
|
121
|
+
const spanId = `${traceId}-${IdGenerators.span().slice(-12)}`;
|
|
122
|
+
this.traces.set(spanId, {
|
|
123
|
+
startTime: Date.now(),
|
|
124
|
+
status: "active",
|
|
125
|
+
});
|
|
126
|
+
const event = {
|
|
127
|
+
type: "trace",
|
|
128
|
+
data: {
|
|
129
|
+
traceId,
|
|
130
|
+
spanId,
|
|
131
|
+
spanName,
|
|
132
|
+
parentSpanId,
|
|
133
|
+
startTime: Date.now(),
|
|
134
|
+
},
|
|
135
|
+
timestamp: new Date().toISOString(),
|
|
136
|
+
tags: {
|
|
137
|
+
spanType: "span",
|
|
138
|
+
},
|
|
139
|
+
};
|
|
140
|
+
await this.send(event);
|
|
141
|
+
return spanId;
|
|
142
|
+
}
|
|
143
|
+
/**
|
|
144
|
+
* End a trace span.
|
|
145
|
+
*/
|
|
146
|
+
async endSpan(spanId, status = "ok") {
|
|
147
|
+
const span = this.traces.get(spanId);
|
|
148
|
+
if (span) {
|
|
149
|
+
span.endTime = Date.now();
|
|
150
|
+
span.status = status;
|
|
151
|
+
}
|
|
152
|
+
const event = {
|
|
153
|
+
type: "trace",
|
|
154
|
+
data: {
|
|
155
|
+
spanId,
|
|
156
|
+
status,
|
|
157
|
+
endTime: Date.now(),
|
|
158
|
+
duration: span ? span.endTime - span.startTime : 0,
|
|
159
|
+
},
|
|
160
|
+
timestamp: new Date().toISOString(),
|
|
161
|
+
tags: {
|
|
162
|
+
spanType: "span-end",
|
|
163
|
+
},
|
|
164
|
+
};
|
|
165
|
+
await this.send(event);
|
|
166
|
+
}
|
|
167
|
+
/**
|
|
168
|
+
* Record a log event.
|
|
169
|
+
*/
|
|
170
|
+
async logEvent(message, level = "info", metadata) {
|
|
171
|
+
const event = {
|
|
172
|
+
type: "log",
|
|
173
|
+
data: {
|
|
174
|
+
message,
|
|
175
|
+
level,
|
|
176
|
+
metadata,
|
|
177
|
+
},
|
|
178
|
+
timestamp: new Date().toISOString(),
|
|
179
|
+
tags: {
|
|
180
|
+
level,
|
|
181
|
+
},
|
|
182
|
+
};
|
|
183
|
+
return this.send(event);
|
|
184
|
+
}
|
|
185
|
+
/**
|
|
186
|
+
* Record a custom event/incident.
|
|
187
|
+
*/
|
|
188
|
+
async recordEvent(title, text, tags, severity) {
|
|
189
|
+
const event = {
|
|
190
|
+
type: "event",
|
|
191
|
+
data: {
|
|
192
|
+
title,
|
|
193
|
+
text,
|
|
194
|
+
severity,
|
|
195
|
+
timestamp: Date.now(),
|
|
196
|
+
},
|
|
197
|
+
timestamp: new Date().toISOString(),
|
|
198
|
+
tags: {
|
|
199
|
+
...tags,
|
|
200
|
+
severity: severity || "medium",
|
|
201
|
+
},
|
|
202
|
+
};
|
|
203
|
+
return this.send(event);
|
|
204
|
+
}
|
|
205
|
+
/**
|
|
206
|
+
* Flush all queued events.
|
|
207
|
+
*/
|
|
208
|
+
async flushQueue() {
|
|
209
|
+
const queued = this.getQueuedEvents();
|
|
210
|
+
if (queued.length === 0)
|
|
211
|
+
return;
|
|
212
|
+
const { sent, failed } = await this.batch(queued);
|
|
213
|
+
if (sent > 0) {
|
|
214
|
+
this.clearQueue();
|
|
215
|
+
}
|
|
216
|
+
console.log(`Flushed Datadog queue: ${sent} sent, ${failed} failed`);
|
|
217
|
+
}
|
|
218
|
+
/**
|
|
219
|
+
* Get Datadog site configuration.
|
|
220
|
+
*/
|
|
221
|
+
getSiteInfo() {
|
|
222
|
+
return {
|
|
223
|
+
apiKey: this.config.apiKey || "",
|
|
224
|
+
site: this.config.endpoint || "datadoghq.com",
|
|
225
|
+
metricsCount: this.metrics.size,
|
|
226
|
+
tracesCount: this.traces.size,
|
|
227
|
+
};
|
|
228
|
+
}
|
|
229
|
+
}
|
|
230
|
+
/**
|
|
231
|
+
* Create a Datadog adapter from environment variables.
|
|
232
|
+
*/
|
|
233
|
+
export function createDatadogAdapter(enabled = true) {
|
|
234
|
+
const apiKey = process.env.DATADOG_API_KEY;
|
|
235
|
+
const site = process.env.DATADOG_SITE || "datadoghq.com";
|
|
236
|
+
if (enabled && !apiKey) {
|
|
237
|
+
console.warn("Datadog is enabled but DATADOG_API_KEY environment variable is not set");
|
|
238
|
+
}
|
|
239
|
+
return new DatadogAdapter({
|
|
240
|
+
enabled: enabled && !!apiKey,
|
|
241
|
+
apiKey,
|
|
242
|
+
endpoint: site,
|
|
243
|
+
});
|
|
244
|
+
}
|
|
245
|
+
//# sourceMappingURL=datadog-adapter.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"datadog-adapter.js","sourceRoot":"","sources":["../src/datadog-adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,6EAA6E;AAE7E,OAAO,EACL,sBAAsB,GAIvB,MAAM,sBAAsB,CAAC;AAE9B;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,sBAAsB;IAChD,eAAe,GAAW,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACnD,iBAAiB,GAAW,CAAC,CAAC;IAC9B,OAAO,GAAwB,IAAI,GAAG,EAAE,CAAC;IACzC,MAAM,GAAyE,IAAI,GAAG,EAAE,CAAC;IAEjG,YAAY,SAAwB,EAAE,OAAO,EAAE,KAAK,EAAE;QACpD,KAAK,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,OAAO;QACX,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACzB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;YACvB,OAAO;QACT,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjD,CAAC;QAED,mDAAmD;QACnD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE,CAAC;YACjD,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,CAAC;QAED,2BAA2B;QAC3B,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;QAExD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QAEtB,sBAAsB;QACtB,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,UAAU;QACd,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC7B,aAAa,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;YACxC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC;QAClC,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrB,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACpB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,SAAS;QACb,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC;QAExC,IAAI,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;gBACpB,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC3B,CAAC;YAED,IAAI,CAAC,eAAe,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YAEhD,MAAM,MAAM,GACV,IAAI,CAAC,iBAAiB,GAAG,CAAC;gBACxB,CAAC,CAAC,IAAI,CAAC,SAAS;oBACd,CAAC,CAAC,SAAS;oBACX,CAAC,CAAC,UAAU;gBACd,CAAC,CAAC,WAAW,CAAC;YAElB,OAAO;gBACL,MAAM;gBACN,SAAS,EAAE,IAAI,CAAC,eAAe;gBAC/B,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;gBACtC,UAAU,EAAE,IAAI,CAAC,iBAAiB;aACnC,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACzB,OAAO;gBACL,MAAM,EAAE,WAAW;gBACnB,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACnC,YAAY,EAAE,CAAC,CAAC;gBAChB,UAAU,EAAE,IAAI,CAAC,iBAAiB;aACnC,CAAC;QACJ,CAAC;IACH,CAAC;IAES,KAAK,CAAC,SAAS,CAAC,KAAmB;QAC3C,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC9C,CAAC;QAED,iBAAiB;QACjB,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC1C,CAAC;QAED,iEAAiE;QACjE,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;QAEvD,yFAAyF;QACzF,8BAA8B;QAC9B,oDAAoD;QACpD,IAAI;IACN,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAChB,IAAY,EACZ,KAAa,EACb,IAA6B;QAE7B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAE9B,MAAM,KAAK,GAAiB;YAC1B,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE;gBACJ,IAAI;gBACJ,KAAK;gBACL,IAAI;gBACJ,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;aACtB;YACD,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;SACpC,CAAC;QAEF,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,eAAe,CAAC,IAAY,EAAE,YAAoB,CAAC;QACvD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,GAAG,SAAS,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,GAAG,SAAS,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,IAAY;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CACb,OAAe,EACf,QAAgB,EAChB,YAAqB;QAErB,MAAM,MAAM,GAAG,GAAG,OAAO,IAAI,YAAY,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;QAE9D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE;YACtB,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;YACrB,MAAM,EAAE,QAAQ;SACjB,CAAC,CAAC;QAEH,MAAM,KAAK,GAAiB;YAC1B,IAAI,EAAE,OAAO;YACb,IAAI,EAAE;gBACJ,OAAO;gBACP,MAAM;gBACN,QAAQ;gBACR,YAAY;gBACZ,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;aACtB;YACD,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,IAAI,EAAE;gBACJ,QAAQ,EAAE,MAAM;aACjB;SACF,CAAC;QAEF,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvB,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,MAAc,EAAE,SAAyB,IAAI;QACzD,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACrC,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAC1B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACvB,CAAC;QAED,MAAM,KAAK,GAAiB;YAC1B,IAAI,EAAE,OAAO;YACb,IAAI,EAAE;gBACJ,MAAM;gBACN,MAAM;gBACN,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE;gBACnB,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;aACpD;YACD,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,IAAI,EAAE;gBACJ,QAAQ,EAAE,UAAU;aACrB;SACF,CAAC;QAEF,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAe,EACf,QAAgD,MAAM,EACtD,QAAkC;QAElC,MAAM,KAAK,GAAiB;YAC1B,IAAI,EAAE,KAAK;YACX,IAAI,EAAE;gBACJ,OAAO;gBACP,KAAK;gBACL,QAAQ;aACT;YACD,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,IAAI,EAAE;gBACJ,KAAK;aACN;SACF,CAAC;QAEF,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CACf,KAAa,EACb,IAAY,EACZ,IAA6B,EAC7B,QAAiD;QAEjD,MAAM,KAAK,GAAiB;YAC1B,IAAI,EAAE,OAAO;YACb,IAAI,EAAE;gBACJ,KAAK;gBACL,IAAI;gBACJ,QAAQ;gBACR,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;aACtB;YACD,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,IAAI,EAAE;gBACJ,GAAG,IAAI;gBACP,QAAQ,EAAE,QAAQ,IAAI,QAAQ;aAC/B;SACF,CAAC;QAEF,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,UAAU;QACtB,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACtC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAEhC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAElD,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;YACb,IAAI,CAAC,UAAU,EAAE,CAAC;QACpB,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,0BAA0B,IAAI,UAAU,MAAM,SAAS,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,WAAW;QAMT,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,EAAE;YAChC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,eAAe;YAC7C,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI;YAC/B,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;SAC9B,CAAC;IACJ,CAAC;CACF;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,UAAmB,IAAI;IAC1D,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;IAC3C,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,eAAe,CAAC;IAEzD,IAAI,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;QACvB,OAAO,CAAC,IAAI,CAAC,wEAAwE,CAAC,CAAC;IACzF,CAAC;IAED,OAAO,IAAI,cAAc,CAAC;QACxB,OAAO,EAAE,OAAO,IAAI,CAAC,CAAC,MAAM;QAC5B,MAAM;QACN,QAAQ,EAAE,IAAI;KACf,CAAC,CAAC;AACL,CAAC"}
|
package/dist/doctor.d.ts
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { kitConfig } from "./config.js";
|
|
2
|
+
export type DoctorCheckStatus = "pass" | "warn" | "fail" | "skip";
|
|
3
|
+
export interface DoctorCheck {
|
|
4
|
+
name: string;
|
|
5
|
+
status: DoctorCheckStatus;
|
|
6
|
+
detail: string;
|
|
7
|
+
category: string;
|
|
8
|
+
}
|
|
9
|
+
export interface DoctorResult {
|
|
10
|
+
checks: DoctorCheck[];
|
|
11
|
+
passed: number;
|
|
12
|
+
warnings: number;
|
|
13
|
+
failed: number;
|
|
14
|
+
}
|
|
15
|
+
export declare function runDoctor(config: kitConfig, cwd: string): Promise<DoctorResult>;
|
package/dist/doctor.js
ADDED
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
import { readFile, access } from "node:fs/promises";
|
|
2
|
+
import { join } from "node:path";
|
|
3
|
+
import { execFile } from "node:child_process";
|
|
4
|
+
import { promisify } from "node:util";
|
|
5
|
+
const execFileAsync = promisify(execFile);
|
|
6
|
+
async function checkNodeVersion(cwd) {
|
|
7
|
+
const name = "Node.js version";
|
|
8
|
+
const category = "runtime";
|
|
9
|
+
try {
|
|
10
|
+
const pkgJson = await readFile(join(cwd, "package.json"), "utf-8");
|
|
11
|
+
const pkg = JSON.parse(pkgJson);
|
|
12
|
+
const required = pkg?.engines?.node;
|
|
13
|
+
if (!required) {
|
|
14
|
+
return { name, status: "skip", detail: "No engines.node in package.json", category };
|
|
15
|
+
}
|
|
16
|
+
const current = process.version; // "v22.22.2"
|
|
17
|
+
const currentMajor = parseInt(current.replace("v", "").split(".")[0], 10);
|
|
18
|
+
const match = required.match(/(\d+)/);
|
|
19
|
+
const requiredMajor = match ? parseInt(match[1], 10) : null;
|
|
20
|
+
if (requiredMajor === null) {
|
|
21
|
+
return { name, status: "skip", detail: `Cannot parse engines.node: ${required}`, category };
|
|
22
|
+
}
|
|
23
|
+
if (currentMajor >= requiredMajor) {
|
|
24
|
+
return { name, status: "pass", detail: `${current} (requires ${required})`, category };
|
|
25
|
+
}
|
|
26
|
+
else {
|
|
27
|
+
return { name, status: "fail", detail: `${current} does not satisfy ${required}`, category };
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
catch {
|
|
31
|
+
return { name, status: "skip", detail: "No package.json found", category };
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
async function checkMise() {
|
|
35
|
+
const name = "mise";
|
|
36
|
+
const category = "tooling";
|
|
37
|
+
try {
|
|
38
|
+
const { stdout } = await execFileAsync("mise", ["--version"]);
|
|
39
|
+
const version = stdout.trim();
|
|
40
|
+
return { name, status: "pass", detail: `installed (${version})`, category };
|
|
41
|
+
}
|
|
42
|
+
catch {
|
|
43
|
+
return {
|
|
44
|
+
name,
|
|
45
|
+
status: "warn",
|
|
46
|
+
detail: "mise not found — tool installation will not work",
|
|
47
|
+
category,
|
|
48
|
+
};
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
async function checkEnvLocal(config, cwd) {
|
|
52
|
+
if (!config.secrets)
|
|
53
|
+
return null;
|
|
54
|
+
const name = ".env.local";
|
|
55
|
+
const category = "secrets";
|
|
56
|
+
const envPath = join(cwd, ".env.local");
|
|
57
|
+
try {
|
|
58
|
+
await access(envPath);
|
|
59
|
+
return { name, status: "pass", detail: ".env.local exists", category };
|
|
60
|
+
}
|
|
61
|
+
catch {
|
|
62
|
+
return {
|
|
63
|
+
name,
|
|
64
|
+
status: "warn",
|
|
65
|
+
detail: ".env.local not found (run: kit secrets)",
|
|
66
|
+
category,
|
|
67
|
+
};
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
async function checkToolsInPath(config) {
|
|
71
|
+
if (!config.tools)
|
|
72
|
+
return [];
|
|
73
|
+
const checks = [];
|
|
74
|
+
for (const toolName of Object.keys(config.tools)) {
|
|
75
|
+
const name = `${toolName} in PATH`;
|
|
76
|
+
const category = "tools";
|
|
77
|
+
try {
|
|
78
|
+
const { stdout } = await execFileAsync("which", [toolName]);
|
|
79
|
+
const path = stdout.trim();
|
|
80
|
+
checks.push({ name, status: "pass", detail: path, category });
|
|
81
|
+
}
|
|
82
|
+
catch {
|
|
83
|
+
checks.push({
|
|
84
|
+
name,
|
|
85
|
+
status: "warn",
|
|
86
|
+
detail: "not in PATH (run: kit install, then re-open terminal)",
|
|
87
|
+
category,
|
|
88
|
+
});
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
return checks;
|
|
92
|
+
}
|
|
93
|
+
async function checkGitHooks(config) {
|
|
94
|
+
if (!config.hooks)
|
|
95
|
+
return [];
|
|
96
|
+
const { checkHooks, isGitRepository } = await import("./check-hooks.js");
|
|
97
|
+
if (!isGitRepository()) {
|
|
98
|
+
return [
|
|
99
|
+
{
|
|
100
|
+
name: "git hooks",
|
|
101
|
+
status: "skip",
|
|
102
|
+
detail: "not a git repository",
|
|
103
|
+
category: "hooks",
|
|
104
|
+
},
|
|
105
|
+
];
|
|
106
|
+
}
|
|
107
|
+
const hookResults = await checkHooks(config.hooks);
|
|
108
|
+
return hookResults.map((h) => ({
|
|
109
|
+
name: h.hookName,
|
|
110
|
+
category: "hooks",
|
|
111
|
+
status: (!h.installed ? "fail" : !h.upToDate ? "warn" : "pass"),
|
|
112
|
+
detail: h.detail,
|
|
113
|
+
}));
|
|
114
|
+
}
|
|
115
|
+
export async function runDoctor(config, cwd) {
|
|
116
|
+
const allChecks = [];
|
|
117
|
+
allChecks.push(await checkNodeVersion(cwd));
|
|
118
|
+
allChecks.push(await checkMise());
|
|
119
|
+
const envLocalCheck = await checkEnvLocal(config, cwd);
|
|
120
|
+
if (envLocalCheck)
|
|
121
|
+
allChecks.push(envLocalCheck);
|
|
122
|
+
const toolsInPathChecks = await checkToolsInPath(config);
|
|
123
|
+
allChecks.push(...toolsInPathChecks);
|
|
124
|
+
const hookChecks = await checkGitHooks(config);
|
|
125
|
+
allChecks.push(...hookChecks);
|
|
126
|
+
const passed = allChecks.filter((c) => c.status === "pass").length;
|
|
127
|
+
const warnings = allChecks.filter((c) => c.status === "warn").length;
|
|
128
|
+
const failed = allChecks.filter((c) => c.status === "fail").length;
|
|
129
|
+
return { checks: allChecks, passed, warnings, failed };
|
|
130
|
+
}
|
|
131
|
+
//# sourceMappingURL=doctor.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"doctor.js","sourceRoot":"","sources":["../src/doctor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAGtC,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;AAkB1C,KAAK,UAAU,gBAAgB,CAAC,GAAW;IACzC,MAAM,IAAI,GAAG,iBAAiB,CAAC;IAC/B,MAAM,QAAQ,GAAG,SAAS,CAAC;IAE3B,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,EAAE,OAAO,CAAC,CAAC;QACnE,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAoC,CAAC;QACnE,MAAM,QAAQ,GAAG,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC;QAEpC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,iCAAiC,EAAE,QAAQ,EAAE,CAAC;QACvF,CAAC;QAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,aAAa;QAC9C,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAE1E,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,aAAa,GAAG,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAE5D,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;YAC3B,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,8BAA8B,QAAQ,EAAE,EAAE,QAAQ,EAAE,CAAC;QAC9F,CAAC;QAED,IAAI,YAAY,IAAI,aAAa,EAAE,CAAC;YAClC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,cAAc,QAAQ,GAAG,EAAE,QAAQ,EAAE,CAAC;QACzF,CAAC;aAAM,CAAC;YACN,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,qBAAqB,QAAQ,EAAE,EAAE,QAAQ,EAAE,CAAC;QAC/F,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,uBAAuB,EAAE,QAAQ,EAAE,CAAC;IAC7E,CAAC;AACH,CAAC;AAED,KAAK,UAAU,SAAS;IACtB,MAAM,IAAI,GAAG,MAAM,CAAC;IACpB,MAAM,QAAQ,GAAG,SAAS,CAAC;IAE3B,IAAI,CAAC;QACH,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,aAAa,CAAC,MAAM,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;QAC9D,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;QAC9B,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,OAAO,GAAG,EAAE,QAAQ,EAAE,CAAC;IAC9E,CAAC;IAAC,MAAM,CAAC;QACP,OAAO;YACL,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,kDAAkD;YAC1D,QAAQ;SACT,CAAC;IACJ,CAAC;AACH,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,MAAiB,EAAE,GAAW;IACzD,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAEjC,MAAM,IAAI,GAAG,YAAY,CAAC;IAC1B,MAAM,QAAQ,GAAG,SAAS,CAAC;IAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;IAExC,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC;QACtB,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,QAAQ,EAAE,CAAC;IACzE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO;YACL,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,yCAAyC;YACjD,QAAQ;SACT,CAAC;IACJ,CAAC;AACH,CAAC;AAED,KAAK,UAAU,gBAAgB,CAAC,MAAiB;IAC/C,IAAI,CAAC,MAAM,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC;IAE7B,MAAM,MAAM,GAAkB,EAAE,CAAC;IAEjC,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QACjD,MAAM,IAAI,GAAG,GAAG,QAAQ,UAAU,CAAC;QACnC,MAAM,QAAQ,GAAG,OAAO,CAAC;QAEzB,IAAI,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,aAAa,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC5D,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;YAC3B,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QAChE,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI;gBACJ,MAAM,EAAE,MAAM;gBACd,MAAM,EAAE,uDAAuD;gBAC/D,QAAQ;aACT,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,MAAiB;IAC5C,IAAI,CAAC,MAAM,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC;IAE7B,MAAM,EAAE,UAAU,EAAE,eAAe,EAAE,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,CAAC;IAEzE,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC;QACvB,OAAO;YACL;gBACE,IAAI,EAAE,WAAW;gBACjB,MAAM,EAAE,MAAM;gBACd,MAAM,EAAE,sBAAsB;gBAC9B,QAAQ,EAAE,OAAO;aAClB;SACF,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACnD,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC7B,IAAI,EAAE,CAAC,CAAC,QAAQ;QAChB,QAAQ,EAAE,OAAO;QACjB,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAsB;QACpF,MAAM,EAAE,CAAC,CAAC,MAAM;KACjB,CAAC,CAAC,CAAC;AACN,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,MAAiB,EAAE,GAAW;IAC5D,MAAM,SAAS,GAAkB,EAAE,CAAC;IAEpC,SAAS,CAAC,IAAI,CAAC,MAAM,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5C,SAAS,CAAC,IAAI,CAAC,MAAM,SAAS,EAAE,CAAC,CAAC;IAElC,MAAM,aAAa,GAAG,MAAM,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACvD,IAAI,aAAa;QAAE,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAEjD,MAAM,iBAAiB,GAAG,MAAM,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACzD,SAAS,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,CAAC;IAErC,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,MAAM,CAAC,CAAC;IAC/C,SAAS,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC;IAE9B,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,MAAM,CAAC;IACnE,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,MAAM,CAAC;IACrE,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,MAAM,CAAC;IAEnE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;AACzD,CAAC"}
|
|
@@ -0,0 +1,226 @@
|
|
|
1
|
+
export type DocType = "guide" | "api" | "example" | "tutorial" | "troubleshooting" | "architecture";
|
|
2
|
+
export type DocFormat = "markdown" | "html" | "pdf";
|
|
3
|
+
export interface DocPage {
|
|
4
|
+
id: string;
|
|
5
|
+
title: string;
|
|
6
|
+
slug: string;
|
|
7
|
+
type: DocType;
|
|
8
|
+
content: string;
|
|
9
|
+
format: DocFormat;
|
|
10
|
+
author: string;
|
|
11
|
+
createdAt: string;
|
|
12
|
+
updatedAt: string;
|
|
13
|
+
views: number;
|
|
14
|
+
tags: string[];
|
|
15
|
+
relatedPages: string[];
|
|
16
|
+
toc?: TableOfContents[];
|
|
17
|
+
}
|
|
18
|
+
export interface TableOfContents {
|
|
19
|
+
level: number;
|
|
20
|
+
title: string;
|
|
21
|
+
id: string;
|
|
22
|
+
}
|
|
23
|
+
export interface APIDoc {
|
|
24
|
+
endpoint: string;
|
|
25
|
+
method: "GET" | "POST" | "PATCH" | "DELETE" | "PUT";
|
|
26
|
+
description: string;
|
|
27
|
+
parameters: Array<{
|
|
28
|
+
name: string;
|
|
29
|
+
type: string;
|
|
30
|
+
required: boolean;
|
|
31
|
+
description: string;
|
|
32
|
+
}>;
|
|
33
|
+
response: {
|
|
34
|
+
type: string;
|
|
35
|
+
example: Record<string, unknown>;
|
|
36
|
+
};
|
|
37
|
+
errors: Array<{
|
|
38
|
+
code: number;
|
|
39
|
+
message: string;
|
|
40
|
+
}>;
|
|
41
|
+
}
|
|
42
|
+
export interface Example {
|
|
43
|
+
id: string;
|
|
44
|
+
title: string;
|
|
45
|
+
description: string;
|
|
46
|
+
language: "typescript" | "javascript" | "python" | "bash";
|
|
47
|
+
code: string;
|
|
48
|
+
explanation: string;
|
|
49
|
+
tags: string[];
|
|
50
|
+
difficulty: "beginner" | "intermediate" | "advanced";
|
|
51
|
+
runnable: boolean;
|
|
52
|
+
}
|
|
53
|
+
export interface Tutorial {
|
|
54
|
+
id: string;
|
|
55
|
+
title: string;
|
|
56
|
+
description: string;
|
|
57
|
+
steps: Array<{
|
|
58
|
+
title: string;
|
|
59
|
+
content: string;
|
|
60
|
+
code?: string;
|
|
61
|
+
expectedOutcome: string;
|
|
62
|
+
}>;
|
|
63
|
+
estimatedTime: number;
|
|
64
|
+
difficulty: "beginner" | "intermediate" | "advanced";
|
|
65
|
+
prerequisites: string[];
|
|
66
|
+
relatedDocs: string[];
|
|
67
|
+
}
|
|
68
|
+
export interface DocSearchResult {
|
|
69
|
+
page: DocPage;
|
|
70
|
+
relevance: number;
|
|
71
|
+
snippet: string;
|
|
72
|
+
}
|
|
73
|
+
export interface DocCollection {
|
|
74
|
+
category: string;
|
|
75
|
+
pages: DocPage[];
|
|
76
|
+
description: string;
|
|
77
|
+
order: number;
|
|
78
|
+
}
|
|
79
|
+
export declare class DocumentationGenerator {
|
|
80
|
+
private pages;
|
|
81
|
+
private apiDocs;
|
|
82
|
+
private examples;
|
|
83
|
+
private tutorials;
|
|
84
|
+
private collections;
|
|
85
|
+
private searchIndex;
|
|
86
|
+
/**
|
|
87
|
+
* Create a documentation page.
|
|
88
|
+
*/
|
|
89
|
+
createPage(title: string, content: string, type: DocType, author: string, tags?: string[]): DocPage;
|
|
90
|
+
/**
|
|
91
|
+
* Get a page by ID.
|
|
92
|
+
*/
|
|
93
|
+
getPage(pageId: string): DocPage | null;
|
|
94
|
+
/**
|
|
95
|
+
* Update a page.
|
|
96
|
+
*/
|
|
97
|
+
updatePage(pageId: string, updates: Partial<DocPage>): DocPage | null;
|
|
98
|
+
/**
|
|
99
|
+
* Delete a page.
|
|
100
|
+
*/
|
|
101
|
+
deletePage(pageId: string): boolean;
|
|
102
|
+
/**
|
|
103
|
+
* Generate table of contents from markdown headings.
|
|
104
|
+
*/
|
|
105
|
+
private generateTableOfContents;
|
|
106
|
+
/**
|
|
107
|
+
* Index page content for full-text search.
|
|
108
|
+
*/
|
|
109
|
+
private indexPage;
|
|
110
|
+
/**
|
|
111
|
+
* Extract searchable terms from content.
|
|
112
|
+
*/
|
|
113
|
+
private extractTerms;
|
|
114
|
+
private isStopWord;
|
|
115
|
+
/**
|
|
116
|
+
* Search documentation by keyword.
|
|
117
|
+
*/
|
|
118
|
+
search(query: string, limit?: number): DocSearchResult[];
|
|
119
|
+
/**
|
|
120
|
+
* Extract snippet around query term.
|
|
121
|
+
*/
|
|
122
|
+
private extractSnippet;
|
|
123
|
+
/**
|
|
124
|
+
* Register API endpoint documentation.
|
|
125
|
+
*/
|
|
126
|
+
registerAPIDoc(doc: APIDoc): void;
|
|
127
|
+
/**
|
|
128
|
+
* Get API documentation for an endpoint.
|
|
129
|
+
*/
|
|
130
|
+
getAPIDoc(endpoint: string): APIDoc | null;
|
|
131
|
+
/**
|
|
132
|
+
* Get all API documentation.
|
|
133
|
+
*/
|
|
134
|
+
getAllAPIDocsIndex(): APIDoc[];
|
|
135
|
+
/**
|
|
136
|
+
* Generate OpenAPI spec from registered endpoints.
|
|
137
|
+
*/
|
|
138
|
+
generateOpenAPISpec(version?: string, baseUrl?: string): Record<string, unknown>;
|
|
139
|
+
/**
|
|
140
|
+
* Register a code example.
|
|
141
|
+
*/
|
|
142
|
+
registerExample(example: Example): void;
|
|
143
|
+
/**
|
|
144
|
+
* Get example by ID.
|
|
145
|
+
*/
|
|
146
|
+
getExample(exampleId: string): Example | null;
|
|
147
|
+
/**
|
|
148
|
+
* Get examples by tag.
|
|
149
|
+
*/
|
|
150
|
+
getExamplesByTag(tag: string): Example[];
|
|
151
|
+
/**
|
|
152
|
+
* Get examples by difficulty.
|
|
153
|
+
*/
|
|
154
|
+
getExamplesByDifficulty(difficulty: string): Example[];
|
|
155
|
+
/**
|
|
156
|
+
* Register a tutorial.
|
|
157
|
+
*/
|
|
158
|
+
registerTutorial(tutorial: Tutorial): void;
|
|
159
|
+
/**
|
|
160
|
+
* Get tutorial by ID.
|
|
161
|
+
*/
|
|
162
|
+
getTutorial(tutorialId: string): Tutorial | null;
|
|
163
|
+
/**
|
|
164
|
+
* Get tutorials by difficulty.
|
|
165
|
+
*/
|
|
166
|
+
getTutorialsByDifficulty(difficulty: string): Tutorial[];
|
|
167
|
+
/**
|
|
168
|
+
* Get tutorials for beginners.
|
|
169
|
+
*/
|
|
170
|
+
getBeginnerTutorials(): Tutorial[];
|
|
171
|
+
/**
|
|
172
|
+
* Create a documentation collection (category).
|
|
173
|
+
*/
|
|
174
|
+
createCollection(category: string, description: string, pages: DocPage[], order?: number): DocCollection;
|
|
175
|
+
/**
|
|
176
|
+
* Get collection by category.
|
|
177
|
+
*/
|
|
178
|
+
getCollection(category: string): DocCollection | null;
|
|
179
|
+
/**
|
|
180
|
+
* Get all collections sorted by order.
|
|
181
|
+
*/
|
|
182
|
+
getAllCollections(): DocCollection[];
|
|
183
|
+
/**
|
|
184
|
+
* Generate documentation HTML site structure.
|
|
185
|
+
*/
|
|
186
|
+
generateSiteStructure(): {
|
|
187
|
+
collections: Array<{
|
|
188
|
+
name: string;
|
|
189
|
+
pages: Array<{
|
|
190
|
+
title: string;
|
|
191
|
+
slug: string;
|
|
192
|
+
type: DocType;
|
|
193
|
+
}>;
|
|
194
|
+
}>;
|
|
195
|
+
};
|
|
196
|
+
/**
|
|
197
|
+
* Generate a static site dump (markdown files).
|
|
198
|
+
*/
|
|
199
|
+
generateMarkdownDump(): Record<string, string>;
|
|
200
|
+
/**
|
|
201
|
+
* Generate navigation sidebar structure.
|
|
202
|
+
*/
|
|
203
|
+
generateNavigation(): Array<{
|
|
204
|
+
label: string;
|
|
205
|
+
items: Array<{
|
|
206
|
+
label: string;
|
|
207
|
+
href: string;
|
|
208
|
+
type: DocType;
|
|
209
|
+
}>;
|
|
210
|
+
}>;
|
|
211
|
+
/**
|
|
212
|
+
* Get documentation statistics.
|
|
213
|
+
*/
|
|
214
|
+
getStats(): {
|
|
215
|
+
totalPages: number;
|
|
216
|
+
byType: Record<DocType, number>;
|
|
217
|
+
totalViews: number;
|
|
218
|
+
totalExamples: number;
|
|
219
|
+
totalTutorials: number;
|
|
220
|
+
avgPageLength: number;
|
|
221
|
+
};
|
|
222
|
+
getPagesCache(): Map<string, DocPage>;
|
|
223
|
+
getExamplesCache(): Map<string, Example>;
|
|
224
|
+
getTutorialsCache(): Map<string, Tutorial>;
|
|
225
|
+
getAPIDocsCache(): Map<string, APIDoc>;
|
|
226
|
+
}
|