docorbit 0.1.0 → 0.1.2
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/README.md +29 -15
- package/bin/docorbit.js +2 -2
- package/dist/apps/cli/src/commands/add.d.ts +7 -0
- package/dist/apps/cli/src/commands/add.js +35 -0
- package/dist/apps/cli/src/commands/api.d.ts +2 -0
- package/dist/apps/cli/src/commands/api.js +35 -0
- package/dist/apps/cli/src/commands/context.d.ts +10 -0
- package/dist/apps/cli/src/commands/context.js +36 -0
- package/dist/apps/cli/src/commands/dashboard.d.ts +8 -0
- package/dist/apps/cli/src/commands/dashboard.js +43 -0
- package/dist/apps/cli/src/commands/diff.d.ts +2 -0
- package/dist/apps/cli/src/commands/diff.js +29 -0
- package/dist/apps/cli/src/commands/evaluate.d.ts +11 -0
- package/dist/apps/cli/src/commands/evaluate.js +101 -0
- package/dist/apps/cli/src/commands/examples.d.ts +2 -0
- package/dist/apps/cli/src/commands/examples.js +36 -0
- package/dist/apps/cli/src/commands/export.d.ts +11 -0
- package/dist/apps/cli/src/commands/export.js +72 -0
- package/dist/apps/cli/src/commands/impact.d.ts +2 -0
- package/dist/apps/cli/src/commands/impact.js +30 -0
- package/dist/apps/cli/src/commands/init.d.ts +5 -0
- package/dist/apps/cli/src/commands/init.js +52 -0
- package/dist/apps/cli/src/commands/inspect.d.ts +5 -0
- package/dist/apps/cli/src/commands/inspect.js +24 -0
- package/dist/apps/cli/src/commands/mcp.d.ts +8 -0
- package/dist/apps/cli/src/commands/mcp.js +49 -0
- package/dist/apps/cli/src/commands/pitfalls.d.ts +2 -0
- package/dist/apps/cli/src/commands/pitfalls.js +35 -0
- package/dist/apps/cli/src/commands/recipes.d.ts +2 -0
- package/dist/apps/cli/src/commands/recipes.js +33 -0
- package/dist/apps/cli/src/commands/search.d.ts +11 -0
- package/dist/apps/cli/src/commands/search.js +36 -0
- package/dist/apps/cli/src/commands/update.d.ts +6 -0
- package/dist/apps/cli/src/commands/update.js +53 -0
- package/dist/apps/cli/src/commands/verify.d.ts +2 -0
- package/dist/apps/cli/src/commands/verify.js +44 -0
- package/dist/apps/cli/src/formatters/colors.d.ts +21 -0
- package/dist/apps/cli/src/formatters/colors.js +22 -0
- package/dist/apps/cli/src/formatters/inspection.d.ts +3 -0
- package/dist/apps/cli/src/formatters/inspection.js +88 -0
- package/dist/apps/cli/src/formatters/knowledge.d.ts +5 -0
- package/dist/apps/cli/src/formatters/knowledge.js +229 -0
- package/dist/apps/cli/src/formatters/retrieval.d.ts +3 -0
- package/dist/apps/cli/src/formatters/retrieval.js +61 -0
- package/{apps/cli/src/formatters/terminal.ts → dist/apps/cli/src/formatters/terminal.d.ts} +0 -1
- package/dist/apps/cli/src/formatters/terminal.js +5 -0
- package/dist/apps/cli/src/formatters/verification.d.ts +4 -0
- package/dist/apps/cli/src/formatters/verification.js +102 -0
- package/dist/apps/cli/src/index.d.ts +1 -0
- package/dist/apps/cli/src/index.js +376 -0
- package/dist/packages/core/src/dashboard/server.d.ts +33 -0
- package/dist/packages/core/src/dashboard/server.js +267 -0
- package/dist/packages/core/src/dashboard/ui.d.ts +5 -0
- package/{packages/core/src/dashboard/ui.ts → dist/packages/core/src/dashboard/ui.js} +2 -2
- package/dist/packages/core/src/implementation-service.d.ts +73 -0
- package/dist/packages/core/src/implementation-service.js +325 -0
- package/{packages/core/src/index.ts → dist/packages/core/src/index.d.ts} +0 -1
- package/dist/packages/core/src/index.js +6 -0
- package/dist/packages/core/src/inspector.d.ts +22 -0
- package/dist/packages/core/src/inspector.js +38 -0
- package/dist/packages/core/src/pipeline.d.ts +45 -0
- package/dist/packages/core/src/pipeline.js +246 -0
- package/dist/packages/crawler/src/config.d.ts +2 -0
- package/dist/packages/crawler/src/config.js +10 -0
- package/dist/packages/crawler/src/fetcher.d.ts +31 -0
- package/dist/packages/crawler/src/fetcher.js +139 -0
- package/dist/packages/crawler/src/index.js +2 -0
- package/dist/packages/discovery/src/index.d.ts +11 -0
- package/dist/packages/discovery/src/index.js +29 -0
- package/dist/packages/discovery/src/provider.d.ts +12 -0
- package/dist/packages/discovery/src/provider.js +30 -0
- package/dist/packages/discovery/src/providers/generic.d.ts +7 -0
- package/dist/packages/discovery/src/providers/generic.js +94 -0
- package/dist/packages/discovery/src/providers/github.d.ts +7 -0
- package/dist/packages/discovery/src/providers/github.js +52 -0
- package/dist/packages/discovery/src/providers/llms-txt.d.ts +7 -0
- package/dist/packages/discovery/src/providers/llms-txt.js +60 -0
- package/dist/packages/discovery/src/providers/markdown.d.ts +7 -0
- package/dist/packages/discovery/src/providers/markdown.js +38 -0
- package/dist/packages/discovery/src/providers/openapi.d.ts +7 -0
- package/dist/packages/discovery/src/providers/openapi.js +77 -0
- package/dist/packages/discovery/src/providers/sitemap.d.ts +7 -0
- package/dist/packages/discovery/src/providers/sitemap.js +53 -0
- package/dist/packages/discovery/src/providers/skill.d.ts +7 -0
- package/dist/packages/discovery/src/providers/skill.js +46 -0
- package/dist/packages/discovery/src/ranker.d.ts +6 -0
- package/dist/packages/discovery/src/ranker.js +107 -0
- package/dist/packages/evaluation/src/dataset.d.ts +2 -0
- package/dist/packages/evaluation/src/dataset.js +944 -0
- package/dist/packages/evaluation/src/index.js +8 -0
- package/dist/packages/evaluation/src/runner.d.ts +7 -0
- package/dist/packages/evaluation/src/runner.js +196 -0
- package/dist/packages/evaluation/src/strategies/context7-runner.d.ts +24 -0
- package/dist/packages/evaluation/src/strategies/context7-runner.js +229 -0
- package/dist/packages/evaluation/src/strategies/docorbit-runner.d.ts +5 -0
- package/dist/packages/evaluation/src/strategies/docorbit-runner.js +210 -0
- package/dist/packages/evaluation/src/strategies/firecrawl-runner.d.ts +24 -0
- package/dist/packages/evaluation/src/strategies/firecrawl-runner.js +151 -0
- package/dist/packages/evaluation/src/strategies/web-search-runner.d.ts +32 -0
- package/dist/packages/evaluation/src/strategies/web-search-runner.js +161 -0
- package/dist/packages/evaluation/src/types.d.ts +15 -0
- package/dist/packages/evaluation/src/types.js +1 -0
- package/dist/packages/evaluation/src/version-matcher.d.ts +11 -0
- package/dist/packages/evaluation/src/version-matcher.js +61 -0
- package/dist/packages/export/src/agents-md.d.ts +19 -0
- package/dist/packages/export/src/agents-md.js +170 -0
- package/dist/packages/export/src/claude-md.d.ts +17 -0
- package/dist/packages/export/src/claude-md.js +118 -0
- package/dist/packages/export/src/docs-map.d.ts +14 -0
- package/dist/packages/export/src/docs-map.js +118 -0
- package/dist/packages/export/src/index.js +6 -0
- package/dist/packages/export/src/llms-txt.d.ts +15 -0
- package/dist/packages/export/src/llms-txt.js +73 -0
- package/dist/packages/export/src/service.d.ts +23 -0
- package/dist/packages/export/src/service.js +210 -0
- package/dist/packages/export/src/skill-md.d.ts +14 -0
- package/dist/packages/export/src/skill-md.js +107 -0
- package/{packages/mcp/src/index.ts → dist/packages/mcp/src/index.d.ts} +2 -35
- package/dist/packages/mcp/src/index.js +6 -0
- package/dist/packages/mcp/src/resources/index.d.ts +12 -0
- package/dist/packages/mcp/src/resources/index.js +165 -0
- package/dist/packages/mcp/src/server.d.ts +30 -0
- package/dist/packages/mcp/src/server.js +243 -0
- package/dist/packages/mcp/src/tools/analyze-impact.d.ts +6 -0
- package/dist/packages/mcp/src/tools/analyze-impact.js +64 -0
- package/dist/packages/mcp/src/tools/check-api.d.ts +6 -0
- package/dist/packages/mcp/src/tools/check-api.js +74 -0
- package/dist/packages/mcp/src/tools/diff-docs.d.ts +6 -0
- package/dist/packages/mcp/src/tools/diff-docs.js +58 -0
- package/dist/packages/mcp/src/tools/export-context.d.ts +6 -0
- package/dist/packages/mcp/src/tools/export-context.js +61 -0
- package/dist/packages/mcp/src/tools/find-api.d.ts +6 -0
- package/dist/packages/mcp/src/tools/find-api.js +91 -0
- package/dist/packages/mcp/src/tools/find-example.d.ts +6 -0
- package/dist/packages/mcp/src/tools/find-example.js +92 -0
- package/dist/packages/mcp/src/tools/find-pitfall.d.ts +6 -0
- package/dist/packages/mcp/src/tools/find-pitfall.js +85 -0
- package/dist/packages/mcp/src/tools/find-recipe.d.ts +6 -0
- package/dist/packages/mcp/src/tools/find-recipe.js +89 -0
- package/dist/packages/mcp/src/tools/get-doc.d.ts +6 -0
- package/dist/packages/mcp/src/tools/get-doc.js +118 -0
- package/dist/packages/mcp/src/tools/get-docs-map.d.ts +6 -0
- package/dist/packages/mcp/src/tools/get-docs-map.js +54 -0
- package/dist/packages/mcp/src/tools/get-version.d.ts +6 -0
- package/dist/packages/mcp/src/tools/get-version.js +104 -0
- package/dist/packages/mcp/src/tools/implementation-context.d.ts +6 -0
- package/dist/packages/mcp/src/tools/implementation-context.js +102 -0
- package/dist/packages/mcp/src/tools/index.d.ts +19 -0
- package/dist/packages/mcp/src/tools/index.js +41 -0
- package/dist/packages/mcp/src/tools/ingest-doc.d.ts +6 -0
- package/dist/packages/mcp/src/tools/ingest-doc.js +264 -0
- package/dist/packages/mcp/src/tools/list-sources.d.ts +6 -0
- package/dist/packages/mcp/src/tools/list-sources.js +76 -0
- package/dist/packages/mcp/src/tools/search-docs.d.ts +6 -0
- package/dist/packages/mcp/src/tools/search-docs.js +113 -0
- package/dist/packages/mcp/src/tools/types.d.ts +22 -0
- package/dist/packages/mcp/src/tools/types.js +1 -0
- package/dist/packages/mcp/src/transports/http.d.ts +31 -0
- package/dist/packages/mcp/src/transports/http.js +215 -0
- package/dist/packages/mcp/src/transports/stdio.d.ts +22 -0
- package/dist/packages/mcp/src/transports/stdio.js +86 -0
- package/{packages/mcp/src/transports/types.ts → dist/packages/mcp/src/transports/types.d.ts} +2 -3
- package/dist/packages/mcp/src/transports/types.js +1 -0
- package/dist/packages/mcp/src/types.d.ts +89 -0
- package/dist/packages/mcp/src/types.js +7 -0
- package/dist/packages/normalizer/src/example-indexer.d.ts +5 -0
- package/dist/packages/normalizer/src/example-indexer.js +200 -0
- package/dist/packages/normalizer/src/html.d.ts +13 -0
- package/dist/packages/normalizer/src/html.js +221 -0
- package/{packages/normalizer/src/index.ts → dist/packages/normalizer/src/index.d.ts} +0 -1
- package/dist/packages/normalizer/src/index.js +7 -0
- package/dist/packages/normalizer/src/llms.d.ts +3 -0
- package/dist/packages/normalizer/src/llms.js +71 -0
- package/dist/packages/normalizer/src/openapi/endpoint-parser.d.ts +11 -0
- package/dist/packages/normalizer/src/openapi/endpoint-parser.js +357 -0
- package/dist/packages/normalizer/src/openapi/schema-resolver.d.ts +10 -0
- package/dist/packages/normalizer/src/openapi/schema-resolver.js +82 -0
- package/dist/packages/normalizer/src/openapi.js +2 -0
- package/dist/packages/normalizer/src/page.d.ts +13 -0
- package/dist/packages/normalizer/src/page.js +150 -0
- package/dist/packages/normalizer/src/pitfall-extractor.d.ts +6 -0
- package/dist/packages/normalizer/src/pitfall-extractor.js +153 -0
- package/dist/packages/normalizer/src/slicer.d.ts +30 -0
- package/dist/packages/normalizer/src/slicer.js +360 -0
- package/dist/packages/retrieval/src/engine.d.ts +17 -0
- package/dist/packages/retrieval/src/engine.js +93 -0
- package/{packages/retrieval/src/index.ts → dist/packages/retrieval/src/index.d.ts} +0 -1
- package/dist/packages/retrieval/src/index.js +6 -0
- package/dist/packages/retrieval/src/intent.d.ts +6 -0
- package/dist/packages/retrieval/src/intent.js +39 -0
- package/dist/packages/retrieval/src/packer.d.ts +2 -0
- package/dist/packages/retrieval/src/packer.js +108 -0
- package/dist/packages/retrieval/src/recipe-engine.d.ts +18 -0
- package/dist/packages/retrieval/src/recipe-engine.js +265 -0
- package/dist/packages/retrieval/src/scorer.d.ts +13 -0
- package/dist/packages/retrieval/src/scorer.js +110 -0
- package/dist/packages/retrieval/src/weights.d.ts +3 -0
- package/dist/packages/retrieval/src/weights.js +28 -0
- package/dist/packages/security/src/annotations.d.ts +10 -0
- package/dist/packages/security/src/annotations.js +100 -0
- package/dist/packages/security/src/index.js +2 -0
- package/dist/packages/security/src/ssrf.d.ts +17 -0
- package/dist/packages/security/src/ssrf.js +132 -0
- package/dist/packages/shared/src/errors.d.ts +22 -0
- package/dist/packages/shared/src/errors.js +44 -0
- package/dist/packages/shared/src/hashing.d.ts +3 -0
- package/dist/packages/shared/src/hashing.js +21 -0
- package/dist/packages/shared/src/index.js +3 -0
- package/dist/packages/shared/src/types.d.ts +715 -0
- package/dist/packages/shared/src/types.js +1 -0
- package/dist/packages/storage/src/db.d.ts +11 -0
- package/dist/packages/storage/src/db.js +128 -0
- package/dist/packages/storage/src/index.js +10 -0
- package/dist/packages/storage/src/interfaces.d.ts +83 -0
- package/dist/packages/storage/src/interfaces.js +1 -0
- package/dist/packages/storage/src/repositories/api-repository.d.ts +16 -0
- package/dist/packages/storage/src/repositories/api-repository.js +169 -0
- package/dist/packages/storage/src/repositories/chunk-repository.d.ts +32 -0
- package/dist/packages/storage/src/repositories/chunk-repository.js +250 -0
- package/dist/packages/storage/src/repositories/example-repository.d.ts +16 -0
- package/dist/packages/storage/src/repositories/example-repository.js +158 -0
- package/dist/packages/storage/src/repositories/page-repository.d.ts +16 -0
- package/dist/packages/storage/src/repositories/page-repository.js +161 -0
- package/dist/packages/storage/src/repositories/pitfall-repository.d.ts +15 -0
- package/dist/packages/storage/src/repositories/pitfall-repository.js +144 -0
- package/dist/packages/storage/src/repositories/source-repository.d.ts +33 -0
- package/dist/packages/storage/src/repositories/source-repository.js +153 -0
- package/dist/packages/storage/src/repository.d.ts +92 -0
- package/dist/packages/storage/src/repository.js +157 -0
- package/dist/packages/storage/src/schema.d.ts +2 -0
- package/{packages/storage/src/schema.ts → dist/packages/storage/src/schema.js} +0 -3
- package/dist/packages/storage/src/search-tokens.d.ts +6 -0
- package/dist/packages/storage/src/search-tokens.js +26 -0
- package/dist/packages/verification/src/diff-engine.d.ts +18 -0
- package/dist/packages/verification/src/diff-engine.js +218 -0
- package/dist/packages/verification/src/extractor.d.ts +29 -0
- package/dist/packages/verification/src/extractor.js +302 -0
- package/dist/packages/verification/src/impact-scanner.d.ts +9 -0
- package/dist/packages/verification/src/impact-scanner.js +181 -0
- package/dist/packages/verification/src/index.js +5 -0
- package/dist/packages/verification/src/services.d.ts +55 -0
- package/dist/packages/verification/src/services.js +189 -0
- package/dist/packages/verification/src/verifier.d.ts +15 -0
- package/dist/packages/verification/src/verifier.js +315 -0
- package/dist/packages/workspace/src/detector.d.ts +7 -0
- package/dist/packages/workspace/src/detector.js +117 -0
- package/dist/packages/workspace/src/ecosystems/cargo.d.ts +10 -0
- package/dist/packages/workspace/src/ecosystems/cargo.js +69 -0
- package/dist/packages/workspace/src/ecosystems/composer.d.ts +7 -0
- package/dist/packages/workspace/src/ecosystems/composer.js +40 -0
- package/dist/packages/workspace/src/ecosystems/go.d.ts +7 -0
- package/dist/packages/workspace/src/ecosystems/go.js +49 -0
- package/{packages/workspace/src/ecosystems/index.ts → dist/packages/workspace/src/ecosystems/index.d.ts} +2 -24
- package/dist/packages/workspace/src/ecosystems/index.js +21 -0
- package/dist/packages/workspace/src/ecosystems/maven.d.ts +7 -0
- package/dist/packages/workspace/src/ecosystems/maven.js +28 -0
- package/dist/packages/workspace/src/ecosystems/npm.d.ts +10 -0
- package/dist/packages/workspace/src/ecosystems/npm.js +73 -0
- package/dist/packages/workspace/src/ecosystems/pub.d.ts +7 -0
- package/dist/packages/workspace/src/ecosystems/pub.js +34 -0
- package/dist/packages/workspace/src/ecosystems/pypi.d.ts +9 -0
- package/dist/packages/workspace/src/ecosystems/pypi.js +94 -0
- package/dist/packages/workspace/src/ecosystems/rubygems.d.ts +7 -0
- package/dist/packages/workspace/src/ecosystems/rubygems.js +25 -0
- package/dist/packages/workspace/src/ecosystems/types.d.ts +9 -0
- package/dist/packages/workspace/src/ecosystems/types.js +1 -0
- package/dist/packages/workspace/src/index.js +5 -0
- package/dist/packages/workspace/src/lockfile.d.ts +21 -0
- package/dist/packages/workspace/src/lockfile.js +153 -0
- package/dist/packages/workspace/src/resolver.d.ts +39 -0
- package/dist/packages/workspace/src/resolver.js +164 -0
- package/dist/packages/workspace/src/semver.d.ts +33 -0
- package/dist/packages/workspace/src/semver.js +235 -0
- package/package.json +13 -9
- package/apps/cli/bin/docorbit.js +0 -8
- package/apps/cli/src/commands/add.ts +0 -44
- package/apps/cli/src/commands/api.ts +0 -38
- package/apps/cli/src/commands/context.ts +0 -47
- package/apps/cli/src/commands/dashboard.ts +0 -55
- package/apps/cli/src/commands/diff.ts +0 -30
- package/apps/cli/src/commands/evaluate.ts +0 -133
- package/apps/cli/src/commands/examples.ts +0 -39
- package/apps/cli/src/commands/export.ts +0 -89
- package/apps/cli/src/commands/impact.ts +0 -31
- package/apps/cli/src/commands/init.ts +0 -69
- package/apps/cli/src/commands/inspect.ts +0 -30
- package/apps/cli/src/commands/mcp.ts +0 -72
- package/apps/cli/src/commands/pitfalls.ts +0 -38
- package/apps/cli/src/commands/recipes.ts +0 -35
- package/apps/cli/src/commands/search.ts +0 -48
- package/apps/cli/src/commands/update.ts +0 -73
- package/apps/cli/src/commands/verify.ts +0 -48
- package/apps/cli/src/formatters/colors.ts +0 -23
- package/apps/cli/src/formatters/inspection.ts +0 -102
- package/apps/cli/src/formatters/knowledge.ts +0 -272
- package/apps/cli/src/formatters/retrieval.ts +0 -74
- package/apps/cli/src/formatters/verification.ts +0 -126
- package/apps/cli/src/index.ts +0 -409
- package/packages/core/src/dashboard/server.ts +0 -314
- package/packages/core/src/implementation-service.ts +0 -451
- package/packages/core/src/inspector.ts +0 -71
- package/packages/core/src/pipeline.ts +0 -331
- package/packages/crawler/src/config.ts +0 -12
- package/packages/crawler/src/fetcher.ts +0 -185
- package/packages/discovery/src/index.ts +0 -31
- package/packages/discovery/src/provider.ts +0 -47
- package/packages/discovery/src/providers/generic.ts +0 -98
- package/packages/discovery/src/providers/github.ts +0 -61
- package/packages/discovery/src/providers/llms-txt.ts +0 -73
- package/packages/discovery/src/providers/markdown.ts +0 -48
- package/packages/discovery/src/providers/openapi.ts +0 -91
- package/packages/discovery/src/providers/sitemap.ts +0 -62
- package/packages/discovery/src/providers/skill.ts +0 -54
- package/packages/discovery/src/ranker.ts +0 -123
- package/packages/evaluation/src/dataset.ts +0 -963
- package/packages/evaluation/src/runner.ts +0 -241
- package/packages/evaluation/src/strategies/context7-runner.ts +0 -269
- package/packages/evaluation/src/strategies/docorbit-runner.ts +0 -228
- package/packages/evaluation/src/strategies/firecrawl-runner.ts +0 -172
- package/packages/evaluation/src/strategies/web-search-runner.ts +0 -194
- package/packages/evaluation/src/types.ts +0 -34
- package/packages/evaluation/src/version-matcher.ts +0 -73
- package/packages/export/src/agents-md.ts +0 -200
- package/packages/export/src/claude-md.ts +0 -141
- package/packages/export/src/docs-map.ts +0 -150
- package/packages/export/src/llms-txt.ts +0 -96
- package/packages/export/src/service.ts +0 -250
- package/packages/export/src/skill-md.ts +0 -128
- package/packages/mcp/src/resources/index.ts +0 -189
- package/packages/mcp/src/server.ts +0 -278
- package/packages/mcp/src/tools/analyze-impact.ts +0 -74
- package/packages/mcp/src/tools/check-api.ts +0 -86
- package/packages/mcp/src/tools/diff-docs.ts +0 -68
- package/packages/mcp/src/tools/export-context.ts +0 -73
- package/packages/mcp/src/tools/find-api.ts +0 -99
- package/packages/mcp/src/tools/find-example.ts +0 -100
- package/packages/mcp/src/tools/find-pitfall.ts +0 -94
- package/packages/mcp/src/tools/find-recipe.ts +0 -98
- package/packages/mcp/src/tools/get-doc.ts +0 -130
- package/packages/mcp/src/tools/get-docs-map.ts +0 -64
- package/packages/mcp/src/tools/get-version.ts +0 -118
- package/packages/mcp/src/tools/implementation-context.ts +0 -88
- package/packages/mcp/src/tools/index.ts +0 -59
- package/packages/mcp/src/tools/list-sources.ts +0 -85
- package/packages/mcp/src/tools/search-docs.ts +0 -123
- package/packages/mcp/src/tools/types.ts +0 -28
- package/packages/mcp/src/transports/http.ts +0 -256
- package/packages/mcp/src/transports/stdio.ts +0 -105
- package/packages/mcp/src/types.ts +0 -102
- package/packages/normalizer/src/example-indexer.ts +0 -240
- package/packages/normalizer/src/html.ts +0 -253
- package/packages/normalizer/src/llms.ts +0 -83
- package/packages/normalizer/src/openapi/endpoint-parser.ts +0 -406
- package/packages/normalizer/src/openapi/schema-resolver.ts +0 -111
- package/packages/normalizer/src/page.ts +0 -184
- package/packages/normalizer/src/pitfall-extractor.ts +0 -190
- package/packages/normalizer/src/slicer.ts +0 -455
- package/packages/retrieval/src/engine.ts +0 -120
- package/packages/retrieval/src/intent.ts +0 -43
- package/packages/retrieval/src/packer.ts +0 -145
- package/packages/retrieval/src/recipe-engine.ts +0 -313
- package/packages/retrieval/src/scorer.ts +0 -139
- package/packages/retrieval/src/weights.ts +0 -31
- package/packages/security/src/annotations.ts +0 -112
- package/packages/security/src/ssrf.ts +0 -153
- package/packages/shared/src/errors.ts +0 -53
- package/packages/shared/src/hashing.ts +0 -23
- package/packages/shared/src/types.ts +0 -881
- package/packages/storage/src/db.ts +0 -72
- package/packages/storage/src/interfaces.ts +0 -115
- package/packages/storage/src/repositories/api-repository.ts +0 -219
- package/packages/storage/src/repositories/chunk-repository.ts +0 -316
- package/packages/storage/src/repositories/example-repository.ts +0 -206
- package/packages/storage/src/repositories/page-repository.ts +0 -205
- package/packages/storage/src/repositories/pitfall-repository.ts +0 -188
- package/packages/storage/src/repositories/source-repository.ts +0 -205
- package/packages/storage/src/repository.ts +0 -256
- package/packages/storage/src/search-tokens.ts +0 -28
- package/packages/verification/src/diff-engine.ts +0 -258
- package/packages/verification/src/extractor.ts +0 -339
- package/packages/verification/src/impact-scanner.ts +0 -203
- package/packages/verification/src/services.ts +0 -238
- package/packages/verification/src/verifier.ts +0 -375
- package/packages/workspace/src/detector.ts +0 -143
- package/packages/workspace/src/ecosystems/cargo.ts +0 -84
- package/packages/workspace/src/ecosystems/composer.ts +0 -42
- package/packages/workspace/src/ecosystems/go.ts +0 -54
- package/packages/workspace/src/ecosystems/maven.ts +0 -34
- package/packages/workspace/src/ecosystems/npm.ts +0 -83
- package/packages/workspace/src/ecosystems/pub.ts +0 -40
- package/packages/workspace/src/ecosystems/pypi.ts +0 -100
- package/packages/workspace/src/ecosystems/rubygems.ts +0 -30
- package/packages/workspace/src/ecosystems/types.ts +0 -18
- package/packages/workspace/src/lockfile.ts +0 -194
- package/packages/workspace/src/resolver.ts +0 -234
- package/packages/workspace/src/semver.ts +0 -259
- /package/{packages/crawler/src/index.ts → dist/packages/crawler/src/index.d.ts} +0 -0
- /package/{packages/evaluation/src/index.ts → dist/packages/evaluation/src/index.d.ts} +0 -0
- /package/{packages/export/src/index.ts → dist/packages/export/src/index.d.ts} +0 -0
- /package/{packages/normalizer/src/openapi.ts → dist/packages/normalizer/src/openapi.d.ts} +0 -0
- /package/{packages/security/src/index.ts → dist/packages/security/src/index.d.ts} +0 -0
- /package/{packages/shared/src/index.ts → dist/packages/shared/src/index.d.ts} +0 -0
- /package/{packages/storage/src/index.ts → dist/packages/storage/src/index.d.ts} +0 -0
- /package/{packages/verification/src/index.ts → dist/packages/verification/src/index.d.ts} +0 -0
- /package/{packages/workspace/src/index.ts → dist/packages/workspace/src/index.d.ts} +0 -0
|
@@ -0,0 +1,221 @@
|
|
|
1
|
+
function unescapeHtml(text) {
|
|
2
|
+
return text
|
|
3
|
+
.replace(/&/g, '&')
|
|
4
|
+
.replace(/</g, '<')
|
|
5
|
+
.replace(/>/g, '>')
|
|
6
|
+
.replace(/"/g, '"')
|
|
7
|
+
.replace(/'/g, "'")
|
|
8
|
+
.replace(/'/g, "'")
|
|
9
|
+
.replace(/ /g, ' ')
|
|
10
|
+
.replace(/&#(\d+);/g, (_, code) => String.fromCharCode(Number(code)))
|
|
11
|
+
.replace(/&#x([0-9a-fA-F]+);/g, (_, code) => String.fromCharCode(parseInt(code, 16)));
|
|
12
|
+
}
|
|
13
|
+
function slugify(text) {
|
|
14
|
+
return text
|
|
15
|
+
.toLowerCase()
|
|
16
|
+
.trim()
|
|
17
|
+
.replace(/[^\w\s-]/g, '')
|
|
18
|
+
.replace(/[\s_-]+/g, '-')
|
|
19
|
+
.replace(/^-+|-+$/g, '');
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Deterministically normalizes HTML documentation into clean Markdown,
|
|
23
|
+
* preserving code fences, language tags, headings, tables, callouts, and links.
|
|
24
|
+
*/
|
|
25
|
+
export function normalizeHtmlToMarkdown(html, baseUrl) {
|
|
26
|
+
const headings = [];
|
|
27
|
+
const links = [];
|
|
28
|
+
const codeExamples = [];
|
|
29
|
+
let title = '';
|
|
30
|
+
// 1. Extract title from <title> tag if present
|
|
31
|
+
const titleMatch = html.match(/<title[^>]*>([\s\S]*?)<\/title>/i);
|
|
32
|
+
if (titleMatch) {
|
|
33
|
+
title = unescapeHtml(titleMatch[1]).replace(/\s+/g, ' ').trim();
|
|
34
|
+
title = title.split(/\s+[|–—-]\s+/)[0].trim();
|
|
35
|
+
}
|
|
36
|
+
// 2. Remove non-content / boilerplate tags
|
|
37
|
+
let cleaned = html
|
|
38
|
+
.replace(/<!--[\s\S]*?-->/g, '')
|
|
39
|
+
.replace(/<script\b[^>]*>[\s\S]*?<\/script>/gi, '')
|
|
40
|
+
.replace(/<style\b[^>]*>[\s\S]*?<\/style>/gi, '')
|
|
41
|
+
.replace(/<noscript\b[^>]*>[\s\S]*?<\/noscript>/gi, '')
|
|
42
|
+
.replace(/<svg\b[^>]*>[\s\S]*?<\/svg>/gi, '')
|
|
43
|
+
.replace(/<iframe\b[^>]*>[\s\S]*?<\/iframe>/gi, '')
|
|
44
|
+
.replace(/<nav\b[^>]*>[\s\S]*?<\/nav>/gi, '')
|
|
45
|
+
.replace(/<header\b[^>]*>[\s\S]*?<\/header>/gi, '')
|
|
46
|
+
.replace(/<footer\b[^>]*>[\s\S]*?<\/footer>/gi, '')
|
|
47
|
+
.replace(/<div\b[^>]*(?:class|id)=["'][^"']*\b(?:sidebar|nav|menu|navbar|footer|cookie-banner|breadcrumbs)\b[^"']*["'][^>]*>[\s\S]*?<\/div>/gi, '');
|
|
48
|
+
// 3. Extract and preserve code blocks
|
|
49
|
+
const codeBlockPlaceholders = [];
|
|
50
|
+
cleaned = cleaned.replace(/<pre\b[^>]*>(?:<code\b([^>]*)>)?([\s\S]*?)(?:<\/code>)?<\/pre>/gi, (_, codeAttrs, codeBody) => {
|
|
51
|
+
let lang = '';
|
|
52
|
+
if (codeAttrs) {
|
|
53
|
+
const langMatch = codeAttrs.match(/\b(?:class|data-language)=["'][^"']*\b(?:language-|lang-)?([a-zA-Z0-9_-]+)\b[^"']*["']/i);
|
|
54
|
+
if (langMatch && !['hljs', 'code'].includes(langMatch[1].toLowerCase())) {
|
|
55
|
+
lang = langMatch[1].toLowerCase();
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
const rawCode = unescapeHtml(codeBody.replace(/<[^>]+>/g, '')).trim();
|
|
59
|
+
if (!rawCode)
|
|
60
|
+
return '';
|
|
61
|
+
const exampleId = `code_${codeExamples.length + 1}`;
|
|
62
|
+
codeExamples.push({
|
|
63
|
+
id: exampleId,
|
|
64
|
+
language: lang || 'text',
|
|
65
|
+
code: rawCode,
|
|
66
|
+
});
|
|
67
|
+
const placeholder = `__DOCORBIT_CODE_BLOCK_${codeBlockPlaceholders.length}__`;
|
|
68
|
+
codeBlockPlaceholders.push(`\n\`\`\`${lang}\n${rawCode}\n\`\`\`\n`);
|
|
69
|
+
return placeholder;
|
|
70
|
+
});
|
|
71
|
+
// 4. Extract Headings and build anchors
|
|
72
|
+
cleaned = cleaned.replace(/<h([1-6])\b([^>]*)>([\s\S]*?)<\/h\1>/gi, (_, levelStr, attrs, innerText) => {
|
|
73
|
+
const level = parseInt(levelStr, 10);
|
|
74
|
+
const plainText = unescapeHtml(innerText.replace(/<[^>]+>/g, '')).replace(/\s+/g, ' ').trim();
|
|
75
|
+
if (!plainText)
|
|
76
|
+
return '';
|
|
77
|
+
let anchor = '';
|
|
78
|
+
const idMatch = attrs.match(/\bid=["']([^"']+)["']/i);
|
|
79
|
+
if (idMatch) {
|
|
80
|
+
anchor = idMatch[1];
|
|
81
|
+
}
|
|
82
|
+
else {
|
|
83
|
+
anchor = slugify(plainText);
|
|
84
|
+
}
|
|
85
|
+
headings.push({ level, text: plainText, anchor });
|
|
86
|
+
const hashes = '#'.repeat(level);
|
|
87
|
+
return `\n\n${hashes} ${plainText}\n\n`;
|
|
88
|
+
});
|
|
89
|
+
// Prefer first H1 as title, otherwise fallback to HTML title, then first heading
|
|
90
|
+
const h1 = headings.find(h => h.level === 1);
|
|
91
|
+
if (h1) {
|
|
92
|
+
title = h1.text;
|
|
93
|
+
}
|
|
94
|
+
else if (!title && headings.length > 0) {
|
|
95
|
+
title = headings[0].text;
|
|
96
|
+
}
|
|
97
|
+
if (!title) {
|
|
98
|
+
title = 'Documentation Page';
|
|
99
|
+
}
|
|
100
|
+
// 5. Extract and normalize Links
|
|
101
|
+
cleaned = cleaned.replace(/<a\b[^>]*\bhref=["']([^"']+)["'][^>]*>([\s\S]*?)<\/a>/gi, (_, href, linkText) => {
|
|
102
|
+
const text = unescapeHtml(linkText.replace(/<[^>]+>/g, '')).replace(/\s+/g, ' ').trim();
|
|
103
|
+
if (!text || href.startsWith('#') || href.startsWith('javascript:'))
|
|
104
|
+
return text;
|
|
105
|
+
let absoluteUrl = href;
|
|
106
|
+
let isExternal = false;
|
|
107
|
+
try {
|
|
108
|
+
const resolved = new URL(href, baseUrl);
|
|
109
|
+
absoluteUrl = resolved.href;
|
|
110
|
+
const baseHost = new URL(baseUrl).hostname;
|
|
111
|
+
isExternal = resolved.hostname !== baseHost;
|
|
112
|
+
}
|
|
113
|
+
catch {
|
|
114
|
+
// Keep raw href
|
|
115
|
+
}
|
|
116
|
+
links.push({
|
|
117
|
+
text,
|
|
118
|
+
url: absoluteUrl,
|
|
119
|
+
isExternal,
|
|
120
|
+
});
|
|
121
|
+
return `[${text}](${absoluteUrl})`;
|
|
122
|
+
});
|
|
123
|
+
// 6. Handle Callouts & Blockquotes
|
|
124
|
+
cleaned = cleaned.replace(/<blockquote\b[^>]*>([\s\S]*?)<\/blockquote>/gi, (_, inner) => {
|
|
125
|
+
const blockText = inner
|
|
126
|
+
.replace(/<p\b[^>]*>/gi, '')
|
|
127
|
+
.replace(/<\/p>/gi, '\n')
|
|
128
|
+
.replace(/<br\s*\/?>/gi, '\n')
|
|
129
|
+
.replace(/<[^>]+>/g, '');
|
|
130
|
+
const cleanLines = unescapeHtml(blockText)
|
|
131
|
+
.split('\n')
|
|
132
|
+
.map(l => l.trim())
|
|
133
|
+
.filter(Boolean)
|
|
134
|
+
.map(l => `> ${l}`)
|
|
135
|
+
.join('\n');
|
|
136
|
+
return `\n\n${cleanLines}\n\n`;
|
|
137
|
+
});
|
|
138
|
+
cleaned = cleaned.replace(/<div\b[^>]*\bclass=["'][^"']*\b(?:alert|callout|admonition|tip|warning|note|info)\b[^"']*["'][^>]*>([\s\S]*?)<\/div>/gi, (_, inner) => {
|
|
139
|
+
const alertText = unescapeHtml(inner.replace(/<[^>]+>/g, ' ')).replace(/\s+/g, ' ').trim();
|
|
140
|
+
if (!alertText)
|
|
141
|
+
return '';
|
|
142
|
+
return `\n\n> [!NOTE]\n> ${alertText}\n\n`;
|
|
143
|
+
});
|
|
144
|
+
// 7. Handle Tables
|
|
145
|
+
cleaned = cleaned.replace(/<table\b[^>]*>([\s\S]*?)<\/table>/gi, (_, tableContent) => {
|
|
146
|
+
const rows = [];
|
|
147
|
+
const rowMatches = tableContent.matchAll(/<tr\b[^>]*>([\s\S]*?)<\/tr>/gi);
|
|
148
|
+
for (const rMatch of rowMatches) {
|
|
149
|
+
const rowContent = rMatch[1];
|
|
150
|
+
const cells = [];
|
|
151
|
+
const cellMatches = rowContent.matchAll(/<t[hd]\b[^>]*>([\s\S]*?)<\/t[hd]>/gi);
|
|
152
|
+
for (const cMatch of cellMatches) {
|
|
153
|
+
const cellText = unescapeHtml(cMatch[1].replace(/<[^>]+>/g, '')).replace(/\s+/g, ' ').trim();
|
|
154
|
+
cells.push(cellText);
|
|
155
|
+
}
|
|
156
|
+
if (cells.length > 0) {
|
|
157
|
+
rows.push(cells);
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
if (rows.length === 0)
|
|
161
|
+
return '';
|
|
162
|
+
const colCount = Math.max(...rows.map(r => r.length));
|
|
163
|
+
const headerRow = rows[0].map(c => c || '-');
|
|
164
|
+
while (headerRow.length < colCount)
|
|
165
|
+
headerRow.push('-');
|
|
166
|
+
const delimiterRow = Array(colCount).fill('---');
|
|
167
|
+
const tableLines = [
|
|
168
|
+
`| ${headerRow.join(' | ')} |`,
|
|
169
|
+
`| ${delimiterRow.join(' | ')} |`,
|
|
170
|
+
];
|
|
171
|
+
for (let i = 1; i < rows.length; i++) {
|
|
172
|
+
const dataRow = rows[i].map(c => c || '');
|
|
173
|
+
while (dataRow.length < colCount)
|
|
174
|
+
dataRow.push('');
|
|
175
|
+
tableLines.push(`| ${dataRow.join(' | ')} |`);
|
|
176
|
+
}
|
|
177
|
+
return `\n\n${tableLines.join('\n')}\n\n`;
|
|
178
|
+
});
|
|
179
|
+
// 8. Handle Lists
|
|
180
|
+
cleaned = cleaned
|
|
181
|
+
.replace(/<li\b[^>]*>([\s\S]*?)<\/li>/gi, (_, inner) => {
|
|
182
|
+
const text = unescapeHtml(inner.replace(/<[^>]+>/g, '')).replace(/\s+/g, ' ').trim();
|
|
183
|
+
return `\n- ${text}`;
|
|
184
|
+
})
|
|
185
|
+
.replace(/<\/?(?:ul|ol)\b[^>]*>/gi, '\n');
|
|
186
|
+
// 9. Handle Inline elements
|
|
187
|
+
cleaned = cleaned
|
|
188
|
+
.replace(/<code\b[^>]*>([\s\S]*?)<\/code>/gi, (_, inner) => {
|
|
189
|
+
const text = unescapeHtml(inner.replace(/<[^>]+>/g, '')).trim();
|
|
190
|
+
return text ? `\`${text}\`` : '';
|
|
191
|
+
})
|
|
192
|
+
.replace(/<(?:strong|b)\b[^>]*>([\s\S]*?)<\/(?:strong|b)>/gi, (_, inner) => {
|
|
193
|
+
const text = inner.trim();
|
|
194
|
+
return text ? `**${text}**` : '';
|
|
195
|
+
})
|
|
196
|
+
.replace(/<(?:em|i)\b[^>]*>([\s\S]*?)<\/(?:em|i)>/gi, (_, inner) => {
|
|
197
|
+
const text = inner.trim();
|
|
198
|
+
return text ? `*${text}*` : '';
|
|
199
|
+
})
|
|
200
|
+
.replace(/<br\s*\/?>/gi, '\n')
|
|
201
|
+
.replace(/<\/?(?:p|div|section|article|main)\b[^>]*>/gi, '\n\n');
|
|
202
|
+
// 10. Strip all remaining HTML tags
|
|
203
|
+
cleaned = cleaned.replace(/<[^>]+>/g, '');
|
|
204
|
+
// 11. Restore preserved code blocks
|
|
205
|
+
for (let i = 0; i < codeBlockPlaceholders.length; i++) {
|
|
206
|
+
cleaned = cleaned.replace(`__DOCORBIT_CODE_BLOCK_${i}__`, codeBlockPlaceholders[i]);
|
|
207
|
+
}
|
|
208
|
+
// 12. Normalize whitespace
|
|
209
|
+
cleaned = unescapeHtml(cleaned)
|
|
210
|
+
.replace(/[ \t]+/g, ' ')
|
|
211
|
+
.replace(/\n\s+\n/g, '\n\n')
|
|
212
|
+
.replace(/\n{3,}/g, '\n\n')
|
|
213
|
+
.trim();
|
|
214
|
+
return {
|
|
215
|
+
title,
|
|
216
|
+
markdown: cleaned,
|
|
217
|
+
headings,
|
|
218
|
+
links,
|
|
219
|
+
codeExamples,
|
|
220
|
+
};
|
|
221
|
+
}
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
export function parseLlmsTxt(content, baseUrl) {
|
|
2
|
+
const lines = content.split('\n');
|
|
3
|
+
let title;
|
|
4
|
+
let summary;
|
|
5
|
+
const sections = [];
|
|
6
|
+
let currentSection = { name: 'Overview', links: [] };
|
|
7
|
+
const summaryLines = [];
|
|
8
|
+
for (let i = 0; i < lines.length; i++) {
|
|
9
|
+
const rawLine = lines[i];
|
|
10
|
+
const line = rawLine.trim();
|
|
11
|
+
if (!line)
|
|
12
|
+
continue;
|
|
13
|
+
if (line.startsWith('# ') && !title) {
|
|
14
|
+
title = line.slice(2).trim();
|
|
15
|
+
continue;
|
|
16
|
+
}
|
|
17
|
+
if (line.startsWith('>')) {
|
|
18
|
+
const text = line.replace(/^>\s*/, '').trim();
|
|
19
|
+
if (text)
|
|
20
|
+
summaryLines.push(text);
|
|
21
|
+
continue;
|
|
22
|
+
}
|
|
23
|
+
if (line.startsWith('## ')) {
|
|
24
|
+
if (currentSection.links.length > 0 || currentSection.name !== 'Overview') {
|
|
25
|
+
sections.push(currentSection);
|
|
26
|
+
}
|
|
27
|
+
currentSection = {
|
|
28
|
+
name: line.slice(3).trim(),
|
|
29
|
+
links: [],
|
|
30
|
+
};
|
|
31
|
+
continue;
|
|
32
|
+
}
|
|
33
|
+
const linkMatch = line.match(/^[-*]\s+\[([^\]]+)\]\(([^)]+)\)(?::\s*(.*))?$/);
|
|
34
|
+
if (linkMatch) {
|
|
35
|
+
const linkTitle = linkMatch[1].trim();
|
|
36
|
+
let rawHref = linkMatch[2].trim();
|
|
37
|
+
const description = linkMatch[3] ? linkMatch[3].trim() : undefined;
|
|
38
|
+
try {
|
|
39
|
+
rawHref = new URL(rawHref, baseUrl).href;
|
|
40
|
+
}
|
|
41
|
+
catch {
|
|
42
|
+
// Keep raw
|
|
43
|
+
}
|
|
44
|
+
const linkItem = {
|
|
45
|
+
title: linkTitle,
|
|
46
|
+
url: rawHref,
|
|
47
|
+
...(description ? { description } : {}),
|
|
48
|
+
};
|
|
49
|
+
currentSection.links.push(linkItem);
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
if (currentSection.links.length > 0 || sections.length === 0) {
|
|
53
|
+
sections.push(currentSection);
|
|
54
|
+
}
|
|
55
|
+
if (summaryLines.length > 0) {
|
|
56
|
+
summary = summaryLines.join(' ');
|
|
57
|
+
}
|
|
58
|
+
return {
|
|
59
|
+
title,
|
|
60
|
+
summary,
|
|
61
|
+
sections,
|
|
62
|
+
rawContent: content,
|
|
63
|
+
};
|
|
64
|
+
}
|
|
65
|
+
export function isValidLlmsTxt(content) {
|
|
66
|
+
if (!content || typeof content !== 'string')
|
|
67
|
+
return false;
|
|
68
|
+
const hasH1 = /^#\s+.+/m.test(content);
|
|
69
|
+
const hasLink = /^[-*]\s+\[.+\]\(.+\)/m.test(content);
|
|
70
|
+
return hasH1 && hasLink;
|
|
71
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { OpenApiSummary, ApiEndpoint } from '../../../shared/src/index.ts';
|
|
2
|
+
/**
|
|
3
|
+
* Detects if a document content is an OpenAPI or Swagger specification.
|
|
4
|
+
*/
|
|
5
|
+
export declare function detectOpenApiSpec(content: string, sourceUrl: string): OpenApiSummary | null;
|
|
6
|
+
/**
|
|
7
|
+
* Parses all API endpoints from an OpenAPI 3.x or Swagger 2.0 specification.
|
|
8
|
+
* Fully deterministic with internal $ref resolution, schema normalization,
|
|
9
|
+
* pagination heuristics, and error detection.
|
|
10
|
+
*/
|
|
11
|
+
export declare function parseOpenApiEndpoints(rawSpec: string | Record<string, unknown>, pageId: string, snapshotId: string, sourceUrl?: string, docVersion?: string): ApiEndpoint[];
|
|
@@ -0,0 +1,357 @@
|
|
|
1
|
+
import { createHash } from 'node:crypto';
|
|
2
|
+
import { resolveJsonPointer, normalizeSchema } from "./schema-resolver.js";
|
|
3
|
+
/**
|
|
4
|
+
* Detects if a document content is an OpenAPI or Swagger specification.
|
|
5
|
+
*/
|
|
6
|
+
export function detectOpenApiSpec(content, sourceUrl) {
|
|
7
|
+
if (!content || typeof content !== 'string')
|
|
8
|
+
return null;
|
|
9
|
+
let parsed;
|
|
10
|
+
try {
|
|
11
|
+
parsed = JSON.parse(content);
|
|
12
|
+
}
|
|
13
|
+
catch {
|
|
14
|
+
return null;
|
|
15
|
+
}
|
|
16
|
+
if (typeof parsed !== 'object' || parsed === null)
|
|
17
|
+
return null;
|
|
18
|
+
const openapiVer = typeof parsed.openapi === 'string' ? parsed.openapi : undefined;
|
|
19
|
+
const swaggerVer = typeof parsed.swagger === 'string' ? parsed.swagger : undefined;
|
|
20
|
+
const specVersion = openapiVer || swaggerVer;
|
|
21
|
+
if (!specVersion)
|
|
22
|
+
return null;
|
|
23
|
+
const info = (typeof parsed.info === 'object' && parsed.info !== null)
|
|
24
|
+
? parsed.info
|
|
25
|
+
: {};
|
|
26
|
+
const title = typeof info.title === 'string' ? info.title : 'Untitled API';
|
|
27
|
+
const description = typeof info.description === 'string' ? info.description : undefined;
|
|
28
|
+
const servers = [];
|
|
29
|
+
if (Array.isArray(parsed.servers)) {
|
|
30
|
+
for (const server of parsed.servers) {
|
|
31
|
+
if (server && typeof server === 'object' && typeof server.url === 'string') {
|
|
32
|
+
servers.push(server.url);
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
else if (typeof parsed.host === 'string') {
|
|
37
|
+
const basePath = typeof parsed.basePath === 'string' ? parsed.basePath : '';
|
|
38
|
+
const schemes = Array.isArray(parsed.schemes) ? parsed.schemes : ['https'];
|
|
39
|
+
servers.push(`${schemes[0]}://${parsed.host}${basePath}`);
|
|
40
|
+
}
|
|
41
|
+
let pathCount = 0;
|
|
42
|
+
if (typeof parsed.paths === 'object' && parsed.paths !== null) {
|
|
43
|
+
pathCount = Object.keys(parsed.paths).length;
|
|
44
|
+
}
|
|
45
|
+
return {
|
|
46
|
+
specVersion,
|
|
47
|
+
title,
|
|
48
|
+
description,
|
|
49
|
+
servers,
|
|
50
|
+
pathCount,
|
|
51
|
+
sourceUrl,
|
|
52
|
+
rawJson: parsed,
|
|
53
|
+
};
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Parses all API endpoints from an OpenAPI 3.x or Swagger 2.0 specification.
|
|
57
|
+
* Fully deterministic with internal $ref resolution, schema normalization,
|
|
58
|
+
* pagination heuristics, and error detection.
|
|
59
|
+
*/
|
|
60
|
+
export function parseOpenApiEndpoints(rawSpec, pageId, snapshotId, sourceUrl, docVersion) {
|
|
61
|
+
let root;
|
|
62
|
+
if (typeof rawSpec === 'string') {
|
|
63
|
+
try {
|
|
64
|
+
root = JSON.parse(rawSpec);
|
|
65
|
+
}
|
|
66
|
+
catch {
|
|
67
|
+
return [];
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
else {
|
|
71
|
+
root = rawSpec;
|
|
72
|
+
}
|
|
73
|
+
if (!root || typeof root !== 'object')
|
|
74
|
+
return [];
|
|
75
|
+
const isOpenApi3 = typeof root.openapi === 'string';
|
|
76
|
+
const isSwagger2 = typeof root.swagger === 'string';
|
|
77
|
+
if (!isOpenApi3 && !isSwagger2)
|
|
78
|
+
return [];
|
|
79
|
+
const paths = (typeof root.paths === 'object' && root.paths !== null)
|
|
80
|
+
? root.paths
|
|
81
|
+
: {};
|
|
82
|
+
const endpoints = [];
|
|
83
|
+
const supportedMethods = new Set(['get', 'post', 'put', 'delete', 'patch', 'head', 'options']);
|
|
84
|
+
// Extract root-level security schemes
|
|
85
|
+
const securitySchemesMap = new Map();
|
|
86
|
+
if (isOpenApi3 && root.components && typeof root.components === 'object') {
|
|
87
|
+
const comps = root.components;
|
|
88
|
+
if (typeof comps.securitySchemes === 'object' && comps.securitySchemes !== null) {
|
|
89
|
+
for (const [name, schemeRaw] of Object.entries(comps.securitySchemes)) {
|
|
90
|
+
if (typeof schemeRaw === 'object' && schemeRaw !== null) {
|
|
91
|
+
const s = schemeRaw;
|
|
92
|
+
securitySchemesMap.set(name, {
|
|
93
|
+
type: s.type || 'http',
|
|
94
|
+
name: typeof s.name === 'string' ? s.name : name,
|
|
95
|
+
in: s.in,
|
|
96
|
+
scheme: typeof s.scheme === 'string' ? s.scheme : undefined,
|
|
97
|
+
bearerFormat: typeof s.bearerFormat === 'string' ? s.bearerFormat : undefined,
|
|
98
|
+
description: typeof s.description === 'string' ? s.description : undefined,
|
|
99
|
+
});
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
else if (isSwagger2 && typeof root.securityDefinitions === 'object' && root.securityDefinitions !== null) {
|
|
105
|
+
for (const [name, schemeRaw] of Object.entries(root.securityDefinitions)) {
|
|
106
|
+
if (typeof schemeRaw === 'object' && schemeRaw !== null) {
|
|
107
|
+
const s = schemeRaw;
|
|
108
|
+
const rawType = typeof s.type === 'string' ? s.type : 'apiKey';
|
|
109
|
+
let mappedType = 'apiKey';
|
|
110
|
+
let mappedScheme = undefined;
|
|
111
|
+
if (rawType === 'basic') {
|
|
112
|
+
mappedType = 'http';
|
|
113
|
+
mappedScheme = 'basic';
|
|
114
|
+
}
|
|
115
|
+
else if (rawType === 'oauth2') {
|
|
116
|
+
mappedType = 'oauth2';
|
|
117
|
+
}
|
|
118
|
+
securitySchemesMap.set(name, {
|
|
119
|
+
type: mappedType,
|
|
120
|
+
name: typeof s.name === 'string' ? s.name : name,
|
|
121
|
+
in: s.in,
|
|
122
|
+
scheme: mappedScheme,
|
|
123
|
+
description: typeof s.description === 'string' ? s.description : undefined,
|
|
124
|
+
});
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
// Root security fallback
|
|
129
|
+
const rootSecurityReqs = Array.isArray(root.security)
|
|
130
|
+
? root.security
|
|
131
|
+
: [];
|
|
132
|
+
const nowIso = new Date().toISOString();
|
|
133
|
+
for (const [pathStr, pathItemRaw] of Object.entries(paths)) {
|
|
134
|
+
if (!pathItemRaw || typeof pathItemRaw !== 'object')
|
|
135
|
+
continue;
|
|
136
|
+
const pathItem = pathItemRaw;
|
|
137
|
+
// Common path-level parameters
|
|
138
|
+
const pathCommonParams = Array.isArray(pathItem.parameters) ? pathItem.parameters : [];
|
|
139
|
+
for (const [methodKey, operationRaw] of Object.entries(pathItem)) {
|
|
140
|
+
const method = methodKey.toLowerCase();
|
|
141
|
+
if (!supportedMethods.has(method))
|
|
142
|
+
continue;
|
|
143
|
+
if (!operationRaw || typeof operationRaw !== 'object')
|
|
144
|
+
continue;
|
|
145
|
+
const op = operationRaw;
|
|
146
|
+
// Summary & Description
|
|
147
|
+
const summary = typeof op.summary === 'string' ? op.summary : undefined;
|
|
148
|
+
const description = typeof op.description === 'string' ? op.description : undefined;
|
|
149
|
+
const operationId = typeof op.operationId === 'string' ? op.operationId : undefined;
|
|
150
|
+
const deprecated = Boolean(op.deprecated || pathItem.deprecated);
|
|
151
|
+
// Parameters
|
|
152
|
+
const rawParams = [...pathCommonParams, ...(Array.isArray(op.parameters) ? op.parameters : [])];
|
|
153
|
+
const parameters = [];
|
|
154
|
+
let swaggerBodySchema = undefined;
|
|
155
|
+
for (const pRaw of rawParams) {
|
|
156
|
+
let p = pRaw;
|
|
157
|
+
if (typeof p.$ref === 'string') {
|
|
158
|
+
const resolved = resolveJsonPointer(root, p.$ref);
|
|
159
|
+
if (typeof resolved === 'object' && resolved !== null) {
|
|
160
|
+
p = resolved;
|
|
161
|
+
}
|
|
162
|
+
}
|
|
163
|
+
if (isSwagger2 && p.in === 'body') {
|
|
164
|
+
swaggerBodySchema = p.schema;
|
|
165
|
+
continue;
|
|
166
|
+
}
|
|
167
|
+
const name = typeof p.name === 'string' ? p.name : '';
|
|
168
|
+
const paramIn = (typeof p.in === 'string' ? p.in : 'query');
|
|
169
|
+
const required = paramIn === 'path' ? true : Boolean(p.required);
|
|
170
|
+
const pDesc = typeof p.description === 'string' ? p.description : undefined;
|
|
171
|
+
const pDefault = p.default !== undefined ? p.default : (p.schema && typeof p.schema === 'object' ? p.schema.default : undefined);
|
|
172
|
+
const pExample = p.example !== undefined ? p.example : (p.schema && typeof p.schema === 'object' ? p.schema.example : undefined);
|
|
173
|
+
let pType = typeof p.type === 'string' ? p.type : undefined;
|
|
174
|
+
let pSchema = undefined;
|
|
175
|
+
if (p.schema && typeof p.schema === 'object') {
|
|
176
|
+
pSchema = p.schema;
|
|
177
|
+
if (!pType && typeof pSchema.type === 'string') {
|
|
178
|
+
pType = pSchema.type;
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
parameters.push({
|
|
182
|
+
name,
|
|
183
|
+
in: paramIn,
|
|
184
|
+
required,
|
|
185
|
+
type: pType,
|
|
186
|
+
description: pDesc,
|
|
187
|
+
default: pDefault,
|
|
188
|
+
schema: pSchema,
|
|
189
|
+
example: pExample,
|
|
190
|
+
});
|
|
191
|
+
}
|
|
192
|
+
// Request Body
|
|
193
|
+
let requestSchema = undefined;
|
|
194
|
+
if (isOpenApi3 && op.requestBody && typeof op.requestBody === 'object') {
|
|
195
|
+
let rb = op.requestBody;
|
|
196
|
+
if (typeof rb.$ref === 'string') {
|
|
197
|
+
const resolved = resolveJsonPointer(root, rb.$ref);
|
|
198
|
+
if (typeof resolved === 'object' && resolved !== null) {
|
|
199
|
+
rb = resolved;
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
if (typeof rb.content === 'object' && rb.content !== null) {
|
|
203
|
+
const content = rb.content;
|
|
204
|
+
// Prefer application/json, fallback to first media type
|
|
205
|
+
const mediaTypeObj = (content['application/json'] || Object.values(content)[0]);
|
|
206
|
+
if (mediaTypeObj && mediaTypeObj.schema) {
|
|
207
|
+
requestSchema = normalizeSchema(mediaTypeObj.schema, root);
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
}
|
|
211
|
+
else if (isSwagger2 && swaggerBodySchema) {
|
|
212
|
+
requestSchema = normalizeSchema(swaggerBodySchema, root);
|
|
213
|
+
}
|
|
214
|
+
// Responses & Errors
|
|
215
|
+
const responseSchema = {};
|
|
216
|
+
const errors = [];
|
|
217
|
+
if (typeof op.responses === 'object' && op.responses !== null) {
|
|
218
|
+
for (const [statusCode, resRaw] of Object.entries(op.responses)) {
|
|
219
|
+
let res = resRaw;
|
|
220
|
+
if (typeof res.$ref === 'string') {
|
|
221
|
+
const resolved = resolveJsonPointer(root, res.$ref);
|
|
222
|
+
if (typeof resolved === 'object' && resolved !== null) {
|
|
223
|
+
res = resolved;
|
|
224
|
+
}
|
|
225
|
+
}
|
|
226
|
+
const resDesc = typeof res.description === 'string' ? res.description : '';
|
|
227
|
+
let contentType = undefined;
|
|
228
|
+
let resSchemaObj = undefined;
|
|
229
|
+
let resExample = undefined;
|
|
230
|
+
if (isOpenApi3 && typeof res.content === 'object' && res.content !== null) {
|
|
231
|
+
const content = res.content;
|
|
232
|
+
const ctKey = content['application/json'] ? 'application/json' : Object.keys(content)[0];
|
|
233
|
+
contentType = ctKey;
|
|
234
|
+
const mediaObj = content[ctKey];
|
|
235
|
+
if (mediaObj) {
|
|
236
|
+
resSchemaObj = mediaObj.schema;
|
|
237
|
+
resExample = mediaObj.example || (mediaObj.examples ? Object.values(mediaObj.examples)[0] : undefined);
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
else if (isSwagger2) {
|
|
241
|
+
resSchemaObj = res.schema;
|
|
242
|
+
contentType = 'application/json';
|
|
243
|
+
resExample = res.examples ? Object.values(res.examples)[0] : undefined;
|
|
244
|
+
}
|
|
245
|
+
const normalizedResSchema = normalizeSchema(resSchemaObj, root);
|
|
246
|
+
const apiResponse = {
|
|
247
|
+
statusCode,
|
|
248
|
+
description: resDesc,
|
|
249
|
+
contentType,
|
|
250
|
+
schema: normalizedResSchema,
|
|
251
|
+
example: resExample,
|
|
252
|
+
};
|
|
253
|
+
responseSchema[statusCode] = apiResponse;
|
|
254
|
+
// Detect errors
|
|
255
|
+
const isErrorCode = statusCode.startsWith('4') || statusCode.startsWith('5') || statusCode === 'default';
|
|
256
|
+
if (isErrorCode) {
|
|
257
|
+
errors.push({
|
|
258
|
+
statusCode,
|
|
259
|
+
description: resDesc,
|
|
260
|
+
schema: normalizedResSchema,
|
|
261
|
+
example: resExample,
|
|
262
|
+
});
|
|
263
|
+
}
|
|
264
|
+
}
|
|
265
|
+
}
|
|
266
|
+
// Authentication Schemes
|
|
267
|
+
const auth = [];
|
|
268
|
+
const opSecurityReqs = Array.isArray(op.security)
|
|
269
|
+
? op.security
|
|
270
|
+
: rootSecurityReqs;
|
|
271
|
+
for (const req of opSecurityReqs) {
|
|
272
|
+
if (typeof req !== 'object' || req === null)
|
|
273
|
+
continue;
|
|
274
|
+
for (const schemeName of Object.keys(req)) {
|
|
275
|
+
const found = securitySchemesMap.get(schemeName);
|
|
276
|
+
if (found) {
|
|
277
|
+
// Avoid duplicate schemes
|
|
278
|
+
if (!auth.some(a => a.name === found.name && a.type === found.type)) {
|
|
279
|
+
auth.push(found);
|
|
280
|
+
}
|
|
281
|
+
}
|
|
282
|
+
else {
|
|
283
|
+
auth.push({
|
|
284
|
+
type: 'apiKey',
|
|
285
|
+
name: schemeName,
|
|
286
|
+
});
|
|
287
|
+
}
|
|
288
|
+
}
|
|
289
|
+
}
|
|
290
|
+
// Pagination Heuristics
|
|
291
|
+
let pagination = undefined;
|
|
292
|
+
const paramNames = parameters.map(p => p.name.toLowerCase());
|
|
293
|
+
const cursorParams = paramNames.filter(n => ['starting_after', 'ending_before', 'cursor', 'next_cursor', 'after', 'before'].includes(n));
|
|
294
|
+
const offsetParams = paramNames.filter(n => ['offset', 'skip', 'start'].includes(n));
|
|
295
|
+
const pageParams = paramNames.filter(n => ['page', 'page_number', 'pagenumber'].includes(n));
|
|
296
|
+
const limitParams = paramNames.filter(n => ['limit', 'per_page', 'page_size', 'pagesize', 'count', 'max'].includes(n));
|
|
297
|
+
// Inspect response properties for pagination clues
|
|
298
|
+
const okResponse = responseSchema['200'] || responseSchema['201'];
|
|
299
|
+
const responseProps = okResponse?.schema?.properties ? Object.keys(okResponse.schema.properties) : [];
|
|
300
|
+
const detectedResponseFields = responseProps.filter(prop => ['has_more', 'next_cursor', 'cursor', 'next_page', 'page_info', 'total_count', 'data', 'items', 'results'].includes(prop.toLowerCase()));
|
|
301
|
+
if (cursorParams.length > 0) {
|
|
302
|
+
pagination = {
|
|
303
|
+
type: 'cursor',
|
|
304
|
+
parameters: [...cursorParams, ...limitParams],
|
|
305
|
+
responseFields: detectedResponseFields,
|
|
306
|
+
};
|
|
307
|
+
}
|
|
308
|
+
else if (offsetParams.length > 0) {
|
|
309
|
+
pagination = {
|
|
310
|
+
type: 'offset',
|
|
311
|
+
parameters: [...offsetParams, ...limitParams],
|
|
312
|
+
responseFields: detectedResponseFields,
|
|
313
|
+
};
|
|
314
|
+
}
|
|
315
|
+
else if (pageParams.length > 0) {
|
|
316
|
+
pagination = {
|
|
317
|
+
type: 'page',
|
|
318
|
+
parameters: [...pageParams, ...limitParams],
|
|
319
|
+
responseFields: detectedResponseFields,
|
|
320
|
+
};
|
|
321
|
+
}
|
|
322
|
+
// Deterministic Endpoint ID
|
|
323
|
+
const endpointId = createHash('sha256')
|
|
324
|
+
.update(`${pageId}:${method}:${pathStr}`)
|
|
325
|
+
.digest('hex')
|
|
326
|
+
.substring(0, 16);
|
|
327
|
+
const provenance = sourceUrl
|
|
328
|
+
? {
|
|
329
|
+
sourceUrl,
|
|
330
|
+
retrievedAt: nowIso,
|
|
331
|
+
sourceAuthority: 'official',
|
|
332
|
+
}
|
|
333
|
+
: undefined;
|
|
334
|
+
endpoints.push({
|
|
335
|
+
id: endpointId,
|
|
336
|
+
pageId,
|
|
337
|
+
snapshotId,
|
|
338
|
+
method: method,
|
|
339
|
+
path: pathStr,
|
|
340
|
+
summary,
|
|
341
|
+
description,
|
|
342
|
+
operationId,
|
|
343
|
+
parameters,
|
|
344
|
+
requestSchema,
|
|
345
|
+
responseSchema,
|
|
346
|
+
auth,
|
|
347
|
+
errors,
|
|
348
|
+
pagination,
|
|
349
|
+
deprecated,
|
|
350
|
+
docVersion,
|
|
351
|
+
provenance,
|
|
352
|
+
createdAt: nowIso,
|
|
353
|
+
});
|
|
354
|
+
}
|
|
355
|
+
}
|
|
356
|
+
return endpoints;
|
|
357
|
+
}
|