@mapbox/mcp-docs-server 0.1.0-dev
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 +196 -0
- package/dist/commonjs/config/toolConfig.d.ts +8 -0
- package/dist/commonjs/config/toolConfig.d.ts.map +1 -0
- package/dist/commonjs/config/toolConfig.js +41 -0
- package/dist/commonjs/config/toolConfig.js.map +1 -0
- package/dist/commonjs/constants/mapboxStreetsV8Fields.trimmed.d.ts +306 -0
- package/dist/commonjs/constants/mapboxStreetsV8Fields.trimmed.d.ts.map +1 -0
- package/dist/commonjs/constants/mapboxStreetsV8Fields.trimmed.js +2069 -0
- package/dist/commonjs/constants/mapboxStreetsV8Fields.trimmed.js.map +1 -0
- package/dist/commonjs/index.d.ts +2 -0
- package/dist/commonjs/index.d.ts.map +1 -0
- package/dist/commonjs/index.js +82 -0
- package/dist/commonjs/index.js.map +1 -0
- package/dist/commonjs/package.json +3 -0
- package/dist/commonjs/resources/BaseResource.d.ts +21 -0
- package/dist/commonjs/resources/BaseResource.d.ts.map +1 -0
- package/dist/commonjs/resources/BaseResource.js +21 -0
- package/dist/commonjs/resources/BaseResource.js.map +1 -0
- package/dist/commonjs/resources/index.d.ts +3 -0
- package/dist/commonjs/resources/index.d.ts.map +1 -0
- package/dist/commonjs/resources/index.js +9 -0
- package/dist/commonjs/resources/index.js.map +1 -0
- package/dist/commonjs/resources/mapbox-api-reference-resource/MapboxApiReferenceResource.d.ts +19 -0
- package/dist/commonjs/resources/mapbox-api-reference-resource/MapboxApiReferenceResource.d.ts.map +1 -0
- package/dist/commonjs/resources/mapbox-api-reference-resource/MapboxApiReferenceResource.js +61 -0
- package/dist/commonjs/resources/mapbox-api-reference-resource/MapboxApiReferenceResource.js.map +1 -0
- package/dist/commonjs/resources/mapbox-documentation-resource/MapboxDocumentationResource.d.ts +29 -0
- package/dist/commonjs/resources/mapbox-documentation-resource/MapboxDocumentationResource.d.ts.map +1 -0
- package/dist/commonjs/resources/mapbox-documentation-resource/MapboxDocumentationResource.js +66 -0
- package/dist/commonjs/resources/mapbox-documentation-resource/MapboxDocumentationResource.js.map +1 -0
- package/dist/commonjs/resources/mapbox-examples-resource/MapboxExamplesResource.d.ts +19 -0
- package/dist/commonjs/resources/mapbox-examples-resource/MapboxExamplesResource.d.ts.map +1 -0
- package/dist/commonjs/resources/mapbox-examples-resource/MapboxExamplesResource.js +61 -0
- package/dist/commonjs/resources/mapbox-examples-resource/MapboxExamplesResource.js.map +1 -0
- package/dist/commonjs/resources/mapbox-guides-resource/MapboxGuidesResource.d.ts +19 -0
- package/dist/commonjs/resources/mapbox-guides-resource/MapboxGuidesResource.d.ts.map +1 -0
- package/dist/commonjs/resources/mapbox-guides-resource/MapboxGuidesResource.js +61 -0
- package/dist/commonjs/resources/mapbox-guides-resource/MapboxGuidesResource.js.map +1 -0
- package/dist/commonjs/resources/mapbox-layer-type-mapping-resource/MapboxLayerTypeMappingResource.d.ts +19 -0
- package/dist/commonjs/resources/mapbox-layer-type-mapping-resource/MapboxLayerTypeMappingResource.d.ts.map +1 -0
- package/dist/commonjs/resources/mapbox-layer-type-mapping-resource/MapboxLayerTypeMappingResource.js +170 -0
- package/dist/commonjs/resources/mapbox-layer-type-mapping-resource/MapboxLayerTypeMappingResource.js.map +1 -0
- package/dist/commonjs/resources/mapbox-reference-resource/MapboxReferenceResource.d.ts +19 -0
- package/dist/commonjs/resources/mapbox-reference-resource/MapboxReferenceResource.d.ts.map +1 -0
- package/dist/commonjs/resources/mapbox-reference-resource/MapboxReferenceResource.js +61 -0
- package/dist/commonjs/resources/mapbox-reference-resource/MapboxReferenceResource.js.map +1 -0
- package/dist/commonjs/resources/mapbox-sdk-docs-resource/MapboxSdkDocsResource.d.ts +19 -0
- package/dist/commonjs/resources/mapbox-sdk-docs-resource/MapboxSdkDocsResource.d.ts.map +1 -0
- package/dist/commonjs/resources/mapbox-sdk-docs-resource/MapboxSdkDocsResource.js +61 -0
- package/dist/commonjs/resources/mapbox-sdk-docs-resource/MapboxSdkDocsResource.js.map +1 -0
- package/dist/commonjs/resources/mapbox-streets-v8-fields-resource/MapboxStreetsV8FieldsResource.d.ts +19 -0
- package/dist/commonjs/resources/mapbox-streets-v8-fields-resource/MapboxStreetsV8FieldsResource.d.ts.map +1 -0
- package/dist/commonjs/resources/mapbox-streets-v8-fields-resource/MapboxStreetsV8FieldsResource.js +30 -0
- package/dist/commonjs/resources/mapbox-streets-v8-fields-resource/MapboxStreetsV8FieldsResource.js.map +1 -0
- package/dist/commonjs/resources/mapbox-style-layers-resource/MapboxStyleLayersResource.d.ts +20 -0
- package/dist/commonjs/resources/mapbox-style-layers-resource/MapboxStyleLayersResource.d.ts.map +1 -0
- package/dist/commonjs/resources/mapbox-style-layers-resource/MapboxStyleLayersResource.js +323 -0
- package/dist/commonjs/resources/mapbox-style-layers-resource/MapboxStyleLayersResource.js.map +1 -0
- package/dist/commonjs/resources/mapbox-token-scopes-resource/MapboxTokenScopesResource.d.ts +20 -0
- package/dist/commonjs/resources/mapbox-token-scopes-resource/MapboxTokenScopesResource.d.ts.map +1 -0
- package/dist/commonjs/resources/mapbox-token-scopes-resource/MapboxTokenScopesResource.js +108 -0
- package/dist/commonjs/resources/mapbox-token-scopes-resource/MapboxTokenScopesResource.js.map +1 -0
- package/dist/commonjs/resources/resourceRegistry.d.ts +15 -0
- package/dist/commonjs/resources/resourceRegistry.d.ts.map +1 -0
- package/dist/commonjs/resources/resourceRegistry.js +39 -0
- package/dist/commonjs/resources/resourceRegistry.js.map +1 -0
- package/dist/commonjs/resources/utils/docParser.d.ts +28 -0
- package/dist/commonjs/resources/utils/docParser.d.ts.map +1 -0
- package/dist/commonjs/resources/utils/docParser.js +94 -0
- package/dist/commonjs/resources/utils/docParser.js.map +1 -0
- package/dist/commonjs/tools/BaseTool.d.ts +30 -0
- package/dist/commonjs/tools/BaseTool.d.ts.map +1 -0
- package/dist/commonjs/tools/BaseTool.js +63 -0
- package/dist/commonjs/tools/BaseTool.js.map +1 -0
- package/dist/commonjs/tools/batch-get-documents-tool/BatchGetDocumentsTool.d.ts +21 -0
- package/dist/commonjs/tools/batch-get-documents-tool/BatchGetDocumentsTool.d.ts.map +1 -0
- package/dist/commonjs/tools/batch-get-documents-tool/BatchGetDocumentsTool.input.schema.d.ts +6 -0
- package/dist/commonjs/tools/batch-get-documents-tool/BatchGetDocumentsTool.input.schema.d.ts.map +1 -0
- package/dist/commonjs/tools/batch-get-documents-tool/BatchGetDocumentsTool.input.schema.js +14 -0
- package/dist/commonjs/tools/batch-get-documents-tool/BatchGetDocumentsTool.input.schema.js.map +1 -0
- package/dist/commonjs/tools/batch-get-documents-tool/BatchGetDocumentsTool.js +94 -0
- package/dist/commonjs/tools/batch-get-documents-tool/BatchGetDocumentsTool.js.map +1 -0
- package/dist/commonjs/tools/get-document-tool/GetDocumentTool.d.ts +21 -0
- package/dist/commonjs/tools/get-document-tool/GetDocumentTool.d.ts.map +1 -0
- package/dist/commonjs/tools/get-document-tool/GetDocumentTool.input.schema.d.ts +6 -0
- package/dist/commonjs/tools/get-document-tool/GetDocumentTool.input.schema.d.ts.map +1 -0
- package/dist/commonjs/tools/get-document-tool/GetDocumentTool.input.schema.js +13 -0
- package/dist/commonjs/tools/get-document-tool/GetDocumentTool.input.schema.js.map +1 -0
- package/dist/commonjs/tools/get-document-tool/GetDocumentTool.js +80 -0
- package/dist/commonjs/tools/get-document-tool/GetDocumentTool.js.map +1 -0
- package/dist/commonjs/tools/index.d.ts +3 -0
- package/dist/commonjs/tools/index.d.ts.map +1 -0
- package/dist/commonjs/tools/index.js +10 -0
- package/dist/commonjs/tools/index.js.map +1 -0
- package/dist/commonjs/tools/toolRegistry.d.ts +12 -0
- package/dist/commonjs/tools/toolRegistry.d.ts.map +1 -0
- package/dist/commonjs/tools/toolRegistry.js +29 -0
- package/dist/commonjs/tools/toolRegistry.js.map +1 -0
- package/dist/commonjs/utils/docCache.d.ts +28 -0
- package/dist/commonjs/utils/docCache.d.ts.map +1 -0
- package/dist/commonjs/utils/docCache.js +129 -0
- package/dist/commonjs/utils/docCache.js.map +1 -0
- package/dist/commonjs/utils/httpPipeline.d.ts +39 -0
- package/dist/commonjs/utils/httpPipeline.d.ts.map +1 -0
- package/dist/commonjs/utils/httpPipeline.js +112 -0
- package/dist/commonjs/utils/httpPipeline.js.map +1 -0
- package/dist/commonjs/utils/index.d.ts +4 -0
- package/dist/commonjs/utils/index.d.ts.map +1 -0
- package/dist/commonjs/utils/index.js +12 -0
- package/dist/commonjs/utils/index.js.map +1 -0
- package/dist/commonjs/utils/types.d.ts +7 -0
- package/dist/commonjs/utils/types.d.ts.map +1 -0
- package/dist/commonjs/utils/types.js +5 -0
- package/dist/commonjs/utils/types.js.map +1 -0
- package/dist/commonjs/utils/versionUtils.d.ts +9 -0
- package/dist/commonjs/utils/versionUtils.d.ts.map +1 -0
- package/dist/commonjs/utils/versionUtils.js +34 -0
- package/dist/commonjs/utils/versionUtils.js.map +1 -0
- package/dist/commonjs/version.json +6 -0
- package/dist/esm/config/toolConfig.d.ts +8 -0
- package/dist/esm/config/toolConfig.d.ts.map +1 -0
- package/dist/esm/config/toolConfig.js +37 -0
- package/dist/esm/config/toolConfig.js.map +1 -0
- package/dist/esm/constants/mapboxStreetsV8Fields.trimmed.d.ts +306 -0
- package/dist/esm/constants/mapboxStreetsV8Fields.trimmed.d.ts.map +1 -0
- package/dist/esm/constants/mapboxStreetsV8Fields.trimmed.js +2066 -0
- package/dist/esm/constants/mapboxStreetsV8Fields.trimmed.js.map +1 -0
- package/dist/esm/index.d.ts +2 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +80 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/resources/BaseResource.d.ts +21 -0
- package/dist/esm/resources/BaseResource.d.ts.map +1 -0
- package/dist/esm/resources/BaseResource.js +17 -0
- package/dist/esm/resources/BaseResource.js.map +1 -0
- package/dist/esm/resources/index.d.ts +3 -0
- package/dist/esm/resources/index.d.ts.map +1 -0
- package/dist/esm/resources/index.js +4 -0
- package/dist/esm/resources/index.js.map +1 -0
- package/dist/esm/resources/mapbox-api-reference-resource/MapboxApiReferenceResource.d.ts +19 -0
- package/dist/esm/resources/mapbox-api-reference-resource/MapboxApiReferenceResource.d.ts.map +1 -0
- package/dist/esm/resources/mapbox-api-reference-resource/MapboxApiReferenceResource.js +57 -0
- package/dist/esm/resources/mapbox-api-reference-resource/MapboxApiReferenceResource.js.map +1 -0
- package/dist/esm/resources/mapbox-documentation-resource/MapboxDocumentationResource.d.ts +29 -0
- package/dist/esm/resources/mapbox-documentation-resource/MapboxDocumentationResource.d.ts.map +1 -0
- package/dist/esm/resources/mapbox-documentation-resource/MapboxDocumentationResource.js +62 -0
- package/dist/esm/resources/mapbox-documentation-resource/MapboxDocumentationResource.js.map +1 -0
- package/dist/esm/resources/mapbox-examples-resource/MapboxExamplesResource.d.ts +19 -0
- package/dist/esm/resources/mapbox-examples-resource/MapboxExamplesResource.d.ts.map +1 -0
- package/dist/esm/resources/mapbox-examples-resource/MapboxExamplesResource.js +57 -0
- package/dist/esm/resources/mapbox-examples-resource/MapboxExamplesResource.js.map +1 -0
- package/dist/esm/resources/mapbox-guides-resource/MapboxGuidesResource.d.ts +19 -0
- package/dist/esm/resources/mapbox-guides-resource/MapboxGuidesResource.d.ts.map +1 -0
- package/dist/esm/resources/mapbox-guides-resource/MapboxGuidesResource.js +57 -0
- package/dist/esm/resources/mapbox-guides-resource/MapboxGuidesResource.js.map +1 -0
- package/dist/esm/resources/mapbox-layer-type-mapping-resource/MapboxLayerTypeMappingResource.d.ts +19 -0
- package/dist/esm/resources/mapbox-layer-type-mapping-resource/MapboxLayerTypeMappingResource.d.ts.map +1 -0
- package/dist/esm/resources/mapbox-layer-type-mapping-resource/MapboxLayerTypeMappingResource.js +166 -0
- package/dist/esm/resources/mapbox-layer-type-mapping-resource/MapboxLayerTypeMappingResource.js.map +1 -0
- package/dist/esm/resources/mapbox-reference-resource/MapboxReferenceResource.d.ts +19 -0
- package/dist/esm/resources/mapbox-reference-resource/MapboxReferenceResource.d.ts.map +1 -0
- package/dist/esm/resources/mapbox-reference-resource/MapboxReferenceResource.js +57 -0
- package/dist/esm/resources/mapbox-reference-resource/MapboxReferenceResource.js.map +1 -0
- package/dist/esm/resources/mapbox-sdk-docs-resource/MapboxSdkDocsResource.d.ts +19 -0
- package/dist/esm/resources/mapbox-sdk-docs-resource/MapboxSdkDocsResource.d.ts.map +1 -0
- package/dist/esm/resources/mapbox-sdk-docs-resource/MapboxSdkDocsResource.js +57 -0
- package/dist/esm/resources/mapbox-sdk-docs-resource/MapboxSdkDocsResource.js.map +1 -0
- package/dist/esm/resources/mapbox-streets-v8-fields-resource/MapboxStreetsV8FieldsResource.d.ts +19 -0
- package/dist/esm/resources/mapbox-streets-v8-fields-resource/MapboxStreetsV8FieldsResource.d.ts.map +1 -0
- package/dist/esm/resources/mapbox-streets-v8-fields-resource/MapboxStreetsV8FieldsResource.js +26 -0
- package/dist/esm/resources/mapbox-streets-v8-fields-resource/MapboxStreetsV8FieldsResource.js.map +1 -0
- package/dist/esm/resources/mapbox-style-layers-resource/MapboxStyleLayersResource.d.ts +20 -0
- package/dist/esm/resources/mapbox-style-layers-resource/MapboxStyleLayersResource.d.ts.map +1 -0
- package/dist/esm/resources/mapbox-style-layers-resource/MapboxStyleLayersResource.js +319 -0
- package/dist/esm/resources/mapbox-style-layers-resource/MapboxStyleLayersResource.js.map +1 -0
- package/dist/esm/resources/mapbox-token-scopes-resource/MapboxTokenScopesResource.d.ts +20 -0
- package/dist/esm/resources/mapbox-token-scopes-resource/MapboxTokenScopesResource.d.ts.map +1 -0
- package/dist/esm/resources/mapbox-token-scopes-resource/MapboxTokenScopesResource.js +104 -0
- package/dist/esm/resources/mapbox-token-scopes-resource/MapboxTokenScopesResource.js.map +1 -0
- package/dist/esm/resources/resourceRegistry.d.ts +15 -0
- package/dist/esm/resources/resourceRegistry.d.ts.map +1 -0
- package/dist/esm/resources/resourceRegistry.js +34 -0
- package/dist/esm/resources/resourceRegistry.js.map +1 -0
- package/dist/esm/resources/utils/docParser.d.ts +28 -0
- package/dist/esm/resources/utils/docParser.d.ts.map +1 -0
- package/dist/esm/resources/utils/docParser.js +88 -0
- package/dist/esm/resources/utils/docParser.js.map +1 -0
- package/dist/esm/tools/BaseTool.d.ts +30 -0
- package/dist/esm/tools/BaseTool.d.ts.map +1 -0
- package/dist/esm/tools/BaseTool.js +59 -0
- package/dist/esm/tools/BaseTool.js.map +1 -0
- package/dist/esm/tools/batch-get-documents-tool/BatchGetDocumentsTool.d.ts +21 -0
- package/dist/esm/tools/batch-get-documents-tool/BatchGetDocumentsTool.d.ts.map +1 -0
- package/dist/esm/tools/batch-get-documents-tool/BatchGetDocumentsTool.input.schema.d.ts +6 -0
- package/dist/esm/tools/batch-get-documents-tool/BatchGetDocumentsTool.input.schema.d.ts.map +1 -0
- package/dist/esm/tools/batch-get-documents-tool/BatchGetDocumentsTool.input.schema.js +11 -0
- package/dist/esm/tools/batch-get-documents-tool/BatchGetDocumentsTool.input.schema.js.map +1 -0
- package/dist/esm/tools/batch-get-documents-tool/BatchGetDocumentsTool.js +90 -0
- package/dist/esm/tools/batch-get-documents-tool/BatchGetDocumentsTool.js.map +1 -0
- package/dist/esm/tools/get-document-tool/GetDocumentTool.d.ts +21 -0
- package/dist/esm/tools/get-document-tool/GetDocumentTool.d.ts.map +1 -0
- package/dist/esm/tools/get-document-tool/GetDocumentTool.input.schema.d.ts +6 -0
- package/dist/esm/tools/get-document-tool/GetDocumentTool.input.schema.d.ts.map +1 -0
- package/dist/esm/tools/get-document-tool/GetDocumentTool.input.schema.js +10 -0
- package/dist/esm/tools/get-document-tool/GetDocumentTool.input.schema.js.map +1 -0
- package/dist/esm/tools/get-document-tool/GetDocumentTool.js +76 -0
- package/dist/esm/tools/get-document-tool/GetDocumentTool.js.map +1 -0
- package/dist/esm/tools/index.d.ts +3 -0
- package/dist/esm/tools/index.d.ts.map +1 -0
- package/dist/esm/tools/index.js +4 -0
- package/dist/esm/tools/index.js.map +1 -0
- package/dist/esm/tools/toolRegistry.d.ts +12 -0
- package/dist/esm/tools/toolRegistry.d.ts.map +1 -0
- package/dist/esm/tools/toolRegistry.js +23 -0
- package/dist/esm/tools/toolRegistry.js.map +1 -0
- package/dist/esm/utils/docCache.d.ts +28 -0
- package/dist/esm/utils/docCache.d.ts.map +1 -0
- package/dist/esm/utils/docCache.js +124 -0
- package/dist/esm/utils/docCache.js.map +1 -0
- package/dist/esm/utils/httpPipeline.d.ts +39 -0
- package/dist/esm/utils/httpPipeline.d.ts.map +1 -0
- package/dist/esm/utils/httpPipeline.js +106 -0
- package/dist/esm/utils/httpPipeline.js.map +1 -0
- package/dist/esm/utils/index.d.ts +4 -0
- package/dist/esm/utils/index.d.ts.map +1 -0
- package/dist/esm/utils/index.js +5 -0
- package/dist/esm/utils/index.js.map +1 -0
- package/dist/esm/utils/types.d.ts +7 -0
- package/dist/esm/utils/types.d.ts.map +1 -0
- package/dist/esm/utils/types.js +4 -0
- package/dist/esm/utils/types.js.map +1 -0
- package/dist/esm/utils/versionUtils.d.ts +9 -0
- package/dist/esm/utils/versionUtils.d.ts.map +1 -0
- package/dist/esm/utils/versionUtils.js +28 -0
- package/dist/esm/utils/versionUtils.js.map +1 -0
- package/dist/esm/version.json +6 -0
- package/package.json +132 -0
|
@@ -0,0 +1,323 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// Copyright (c) Mapbox, Inc.
|
|
3
|
+
// Licensed under the MIT License.
|
|
4
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
|
+
exports.MapboxStyleLayersResource = void 0;
|
|
6
|
+
const BaseResource_js_1 = require("../BaseResource.js");
|
|
7
|
+
/**
|
|
8
|
+
* Resource providing Mapbox GL JS style specification guidance
|
|
9
|
+
* to help LLMs understand layer types, properties, and how to use them
|
|
10
|
+
*/
|
|
11
|
+
class MapboxStyleLayersResource extends BaseResource_js_1.BaseResource {
|
|
12
|
+
name = 'Mapbox Style Specification Guide';
|
|
13
|
+
uri = 'resource://mapbox-style-layers';
|
|
14
|
+
description = 'Mapbox GL JS style specification reference for layer types, paint/layout properties, and Streets v8 source layers';
|
|
15
|
+
mimeType = 'text/markdown';
|
|
16
|
+
async readCallback(uri, _extra) {
|
|
17
|
+
// Generate comprehensive markdown documentation
|
|
18
|
+
const markdown = this.generateMarkdown();
|
|
19
|
+
return {
|
|
20
|
+
contents: [
|
|
21
|
+
{
|
|
22
|
+
uri: uri.href,
|
|
23
|
+
mimeType: this.mimeType,
|
|
24
|
+
text: markdown
|
|
25
|
+
}
|
|
26
|
+
]
|
|
27
|
+
};
|
|
28
|
+
}
|
|
29
|
+
generateMarkdown() {
|
|
30
|
+
const sections = [];
|
|
31
|
+
// Header
|
|
32
|
+
sections.push([
|
|
33
|
+
'# Mapbox Style Specification Guide',
|
|
34
|
+
'',
|
|
35
|
+
'This guide provides the Mapbox GL JS style specification for creating custom map styles.',
|
|
36
|
+
'',
|
|
37
|
+
'## Streets v8 Source Layers',
|
|
38
|
+
'',
|
|
39
|
+
'### Source Layer → Geometry Type Mapping',
|
|
40
|
+
'',
|
|
41
|
+
'**Polygon layers:**',
|
|
42
|
+
'- `landuse` - Land use areas (parks, residential, industrial, etc.)',
|
|
43
|
+
'- `water` - Water bodies (oceans, lakes, rivers as polygons)',
|
|
44
|
+
'- `building` - Building footprints with height data',
|
|
45
|
+
'- `landuse_overlay` - Overlay features (wetlands, national parks)',
|
|
46
|
+
'',
|
|
47
|
+
'**LineString layers:**',
|
|
48
|
+
'- `road` - All roads, paths, railways',
|
|
49
|
+
'- `admin` - Administrative boundaries',
|
|
50
|
+
'- `waterway` - Rivers, streams, canals as lines',
|
|
51
|
+
'- `aeroway` - Airport runways and taxiways',
|
|
52
|
+
'- `structure` - Bridges, tunnels, fences',
|
|
53
|
+
'',
|
|
54
|
+
'**Point/Symbol layers:**',
|
|
55
|
+
'- `place_label` - City, state, country labels',
|
|
56
|
+
'- `poi_label` - Points of interest',
|
|
57
|
+
'- `airport_label` - Airport labels',
|
|
58
|
+
'- `transit_stop_label` - Transit stops',
|
|
59
|
+
'- `motorway_junction` - Highway exits',
|
|
60
|
+
'- `housenum_label` - House numbers',
|
|
61
|
+
'- `natural_label` - Natural feature labels (mountains, water bodies, etc.)',
|
|
62
|
+
'',
|
|
63
|
+
'## Layer Types and Properties',
|
|
64
|
+
''
|
|
65
|
+
].join('\n'));
|
|
66
|
+
// Fill layer
|
|
67
|
+
sections.push([
|
|
68
|
+
'### fill',
|
|
69
|
+
'Used for: Polygon features (landuse, water, building, landuse_overlay)',
|
|
70
|
+
'',
|
|
71
|
+
'**Paint properties:**',
|
|
72
|
+
'- `fill-color` - The color of the filled area (default: `#000000`)',
|
|
73
|
+
'- `fill-opacity` - Opacity of the entire fill layer, 0-1 (default: `1`)',
|
|
74
|
+
'- `fill-outline-color` - Color of the outline; requires `fill-antialias: true` (disabled if unset)',
|
|
75
|
+
'- `fill-pattern` - Name of image in sprite to use for fill pattern',
|
|
76
|
+
'- `fill-antialias` - Whether to antialias the fill (default: `true`)',
|
|
77
|
+
'- `fill-translate` - Geometry translation [x, y] in pixels (default: `[0, 0]`)',
|
|
78
|
+
'- `fill-translate-anchor` - Reference for translate: `map` or `viewport` (default: `map`)',
|
|
79
|
+
'',
|
|
80
|
+
'**Layout properties:**',
|
|
81
|
+
'- `visibility` - Whether the layer is shown: `visible` or `none` (default: `visible`)',
|
|
82
|
+
'- `fill-sort-key` - Sort key for ordering fill features within a layer',
|
|
83
|
+
''
|
|
84
|
+
].join('\n'));
|
|
85
|
+
// Line layer
|
|
86
|
+
sections.push([
|
|
87
|
+
'### line',
|
|
88
|
+
'Used for: LineString features (road, admin, waterway, aeroway, structure, natural_label)',
|
|
89
|
+
'',
|
|
90
|
+
'**Paint properties:**',
|
|
91
|
+
'- `line-color` - The color of the line (default: `#000000`)',
|
|
92
|
+
'- `line-width` - Width of the line in pixels (default: `1`)',
|
|
93
|
+
'- `line-opacity` - Opacity of the line, 0-1 (default: `1`)',
|
|
94
|
+
'- `line-blur` - Blur applied to the line in pixels (default: `0`)',
|
|
95
|
+
'- `line-dasharray` - Dash pattern [dash, gap, dash, gap...] (solid if unset)',
|
|
96
|
+
'- `line-gap-width` - Width of inner gap in line (default: `0`)',
|
|
97
|
+
'- `line-offset` - Line offset perpendicular to direction (default: `0`)',
|
|
98
|
+
'- `line-pattern` - Name of image in sprite for line pattern',
|
|
99
|
+
'- `line-gradient` - Gradient along the line (requires `lineMetrics: true` in source)',
|
|
100
|
+
'- `line-translate` - Geometry translation [x, y] in pixels (default: `[0, 0]`)',
|
|
101
|
+
'- `line-translate-anchor` - Reference for translate: `map` or `viewport` (default: `map`)',
|
|
102
|
+
'',
|
|
103
|
+
'**Layout properties:**',
|
|
104
|
+
'- `visibility` - Whether the layer is shown: `visible` or `none` (default: `visible`)',
|
|
105
|
+
'- `line-cap` - Display of line ends: `butt`, `round`, `square` (default: `butt`)',
|
|
106
|
+
'- `line-join` - Display of line joins: `bevel`, `round`, `miter` (default: `miter`)',
|
|
107
|
+
'- `line-miter-limit` - Maximum miter length (default: `2`)',
|
|
108
|
+
'- `line-round-limit` - Maximum round join radius (default: `1.05`)',
|
|
109
|
+
'- `line-sort-key` - Sort key for layer ordering',
|
|
110
|
+
''
|
|
111
|
+
].join('\n'));
|
|
112
|
+
// Symbol layer
|
|
113
|
+
sections.push([
|
|
114
|
+
'### symbol',
|
|
115
|
+
'Used for: Point and LineString labels (all *_label layers, natural_label, motorway_junction)',
|
|
116
|
+
'',
|
|
117
|
+
'**Layout properties (symbol):**',
|
|
118
|
+
'- `visibility` - Whether the layer is shown: `visible` or `none` (default: `visible`)',
|
|
119
|
+
'- `symbol-placement` - Symbol placement: `point`, `line`, `line-center` (default: `point`)',
|
|
120
|
+
'- `symbol-spacing` - Distance between symbols on line (default: `250`)',
|
|
121
|
+
'- `symbol-avoid-edges` - Avoid symbols at tile edges (default: `false`)',
|
|
122
|
+
'- `symbol-sort-key` - Sort key for symbol ordering',
|
|
123
|
+
'- `symbol-z-order` - Z-order: `auto`, `viewport-y`, `source` (default: `auto`)',
|
|
124
|
+
'',
|
|
125
|
+
'**Layout properties (text):**',
|
|
126
|
+
'- `text-field` - Text to display, e.g., `["get", "name"]`',
|
|
127
|
+
'- `text-font` - Font stack array, e.g., `["DIN Pro Regular", "Arial Unicode MS Regular"]` (no spec default; required when text-field is set)',
|
|
128
|
+
'- `text-size` - Font size in pixels (default: `16`)',
|
|
129
|
+
'- `text-max-width` - Maximum text width in ems (default: `10`)',
|
|
130
|
+
'- `text-line-height` - Text line height in ems (default: `1.2`)',
|
|
131
|
+
'- `text-letter-spacing` - Letter spacing in ems (default: `0`)',
|
|
132
|
+
'- `text-justify` - Text justification: `auto`, `left`, `center`, `right` (default: `center`)',
|
|
133
|
+
'- `text-anchor` - Text anchor: `center`, `left`, `right`, `top`, `bottom`, `top-left`, etc.',
|
|
134
|
+
'- `text-max-angle` - Maximum angle for curved text (default: `45`)',
|
|
135
|
+
'- `text-rotate` - Text rotation in degrees (default: `0`)',
|
|
136
|
+
'- `text-padding` - Padding around text for collision (default: `2`)',
|
|
137
|
+
'- `text-keep-upright` - Keep text upright when map rotates (default: `true`)',
|
|
138
|
+
'- `text-transform` - Text case: `none`, `uppercase`, `lowercase` (default: `none`)',
|
|
139
|
+
'- `text-offset` - Text offset [x, y] in ems (default: `[0, 0]`)',
|
|
140
|
+
'- `text-allow-overlap` - Allow text to overlap (default: `false`)',
|
|
141
|
+
'- `text-ignore-placement` - Ignore placement collisions (default: `false`)',
|
|
142
|
+
'- `text-optional` - Hide text if icon collides (default: `false`)',
|
|
143
|
+
'',
|
|
144
|
+
'**Layout properties (icon):**',
|
|
145
|
+
'- `icon-image` - Name of icon in sprite, e.g., `["get", "maki"]`',
|
|
146
|
+
'- `icon-size` - Scale factor for icon (default: `1`)',
|
|
147
|
+
'- `icon-rotate` - Icon rotation in degrees (default: `0`)',
|
|
148
|
+
'- `icon-padding` - Padding around icon for collision (default: `2`)',
|
|
149
|
+
'- `icon-keep-upright` - Keep icon upright (default: `false`)',
|
|
150
|
+
'- `icon-offset` - Icon offset [x, y] in ems (default: `[0, 0]`)',
|
|
151
|
+
'- `icon-anchor` - Icon anchor: `center`, `left`, `right`, `top`, `bottom`, etc.',
|
|
152
|
+
'- `icon-pitch-alignment` - Icon alignment: `map`, `viewport`, `auto` (default: `auto`)',
|
|
153
|
+
'- `icon-text-fit` - Scale icon to text: `none`, `width`, `height`, `both` (default: `none`)',
|
|
154
|
+
'- `icon-text-fit-padding` - Padding for icon-text-fit [top, right, bottom, left]',
|
|
155
|
+
'- `icon-allow-overlap` - Allow icon to overlap (default: `false`)',
|
|
156
|
+
'- `icon-ignore-placement` - Ignore icon collisions (default: `false`)',
|
|
157
|
+
'- `icon-optional` - Hide icon if text collides (default: `false`)',
|
|
158
|
+
'',
|
|
159
|
+
'**Paint properties (text):**',
|
|
160
|
+
'- `text-color` - Color of the text (default: `#000000`)',
|
|
161
|
+
'- `text-halo-color` - Color of the halo around text (default: `rgba(0, 0, 0, 0)`)',
|
|
162
|
+
'- `text-halo-width` - Width of the halo (default: `0`)',
|
|
163
|
+
'- `text-halo-blur` - Blur of the halo (default: `0`)',
|
|
164
|
+
'- `text-opacity` - Opacity of the text, 0-1 (default: `1`)',
|
|
165
|
+
'- `text-translate` - Text translation [x, y] in pixels (default: `[0, 0]`)',
|
|
166
|
+
'- `text-translate-anchor` - Reference for translate: `map` or `viewport` (default: `map`)',
|
|
167
|
+
'',
|
|
168
|
+
'**Paint properties (icon):**',
|
|
169
|
+
'- `icon-color` - Tint color for SDF icons',
|
|
170
|
+
'- `icon-halo-color` - Color of icon halo for SDF icons',
|
|
171
|
+
'- `icon-halo-width` - Width of icon halo (default: `0`)',
|
|
172
|
+
'- `icon-halo-blur` - Blur of icon halo (default: `0`)',
|
|
173
|
+
'- `icon-opacity` - Opacity of the icon, 0-1 (default: `1`)',
|
|
174
|
+
'- `icon-translate` - Icon translation [x, y] in pixels (default: `[0, 0]`)',
|
|
175
|
+
'- `icon-translate-anchor` - Reference for translate: `map` or `viewport` (default: `map`)',
|
|
176
|
+
''
|
|
177
|
+
].join('\n'));
|
|
178
|
+
// Circle layer
|
|
179
|
+
sections.push([
|
|
180
|
+
'### circle',
|
|
181
|
+
'Used for: Point features (can be used with POI or custom point data)',
|
|
182
|
+
'',
|
|
183
|
+
'**Paint properties:**',
|
|
184
|
+
'- `circle-color` - The color of the circle (default: `#000000`)',
|
|
185
|
+
'- `circle-radius` - Circle radius in pixels (default: `5`)',
|
|
186
|
+
'- `circle-opacity` - Opacity of the circle, 0-1 (default: `1`)',
|
|
187
|
+
'- `circle-blur` - Amount to blur the circle (default: `0`)',
|
|
188
|
+
'- `circle-stroke-color` - Color of the circle stroke',
|
|
189
|
+
'- `circle-stroke-width` - Width of the circle stroke (default: `0`)',
|
|
190
|
+
'- `circle-stroke-opacity` - Opacity of the circle stroke, 0-1 (default: `1`)',
|
|
191
|
+
'- `circle-translate` - Circle translation [x, y] in pixels (default: `[0, 0]`)',
|
|
192
|
+
'- `circle-translate-anchor` - Reference for translate: `map` or `viewport` (default: `map`)',
|
|
193
|
+
'- `circle-pitch-scale` - Circle scaling: `map` or `viewport` (default: `map`)',
|
|
194
|
+
'- `circle-pitch-alignment` - Circle alignment: `map` or `viewport` (default: `viewport`)',
|
|
195
|
+
'',
|
|
196
|
+
'**Layout properties:**',
|
|
197
|
+
'- `visibility` - Whether the layer is shown: `visible` or `none` (default: `visible`)',
|
|
198
|
+
'- `circle-sort-key` - Sort key for circle ordering',
|
|
199
|
+
''
|
|
200
|
+
].join('\n'));
|
|
201
|
+
// Fill-extrusion layer
|
|
202
|
+
sections.push([
|
|
203
|
+
'### fill-extrusion',
|
|
204
|
+
'Used for: 3D buildings (building layer with height/min_height attributes)',
|
|
205
|
+
'',
|
|
206
|
+
'**Paint properties:**',
|
|
207
|
+
'- `fill-extrusion-color` - Base color of the extrusion (default: `#000000`)',
|
|
208
|
+
'- `fill-extrusion-height` - Height in meters, e.g., `["get", "height"]` (default: `0`)',
|
|
209
|
+
'- `fill-extrusion-base` - Base height in meters, e.g., `["get", "min_height"]` (default: `0`)',
|
|
210
|
+
'- `fill-extrusion-opacity` - Opacity of the extrusion, 0-1 (default: `1`)',
|
|
211
|
+
'- `fill-extrusion-pattern` - Name of image in sprite for pattern',
|
|
212
|
+
'- `fill-extrusion-translate` - Geometry translation [x, y] in pixels (default: `[0, 0]`)',
|
|
213
|
+
'- `fill-extrusion-translate-anchor` - Reference: `map` or `viewport` (default: `map`)',
|
|
214
|
+
'- `fill-extrusion-vertical-gradient` - Use vertical gradient (default: `true`)',
|
|
215
|
+
'',
|
|
216
|
+
'**Layout properties:**',
|
|
217
|
+
'- `visibility` - Whether the layer is shown: `visible` or `none` (default: `visible`)',
|
|
218
|
+
'- `fill-extrusion-edge-radius` - Radius of extrusion edges for a rounded look, 0-1 (default: `0`)',
|
|
219
|
+
''
|
|
220
|
+
].join('\n'));
|
|
221
|
+
// Common patterns and examples
|
|
222
|
+
sections.push([
|
|
223
|
+
'## Common Patterns',
|
|
224
|
+
'',
|
|
225
|
+
'### Filtering Examples',
|
|
226
|
+
'',
|
|
227
|
+
'**Parks only (not cemeteries or golf courses):**',
|
|
228
|
+
'```json',
|
|
229
|
+
'{',
|
|
230
|
+
' "layer_type": "landuse",',
|
|
231
|
+
' "filter_properties": { "class": "park" }',
|
|
232
|
+
'}',
|
|
233
|
+
'```',
|
|
234
|
+
'',
|
|
235
|
+
'**Major roads:**',
|
|
236
|
+
'```json',
|
|
237
|
+
'{',
|
|
238
|
+
' "layer_type": "road",',
|
|
239
|
+
' "filter_properties": { "class": ["motorway", "trunk", "primary"] }',
|
|
240
|
+
'}',
|
|
241
|
+
'```',
|
|
242
|
+
'',
|
|
243
|
+
'**Country boundaries:**',
|
|
244
|
+
'```json',
|
|
245
|
+
'{',
|
|
246
|
+
' "layer_type": "admin",',
|
|
247
|
+
' "filter_properties": { "admin_level": 0, "maritime": "false" }',
|
|
248
|
+
'}',
|
|
249
|
+
'```',
|
|
250
|
+
'',
|
|
251
|
+
'**3D Buildings:**',
|
|
252
|
+
'```json',
|
|
253
|
+
'{',
|
|
254
|
+
' "layer_type": "building",',
|
|
255
|
+
' "filter_properties": { "extrude": "true" }',
|
|
256
|
+
'}',
|
|
257
|
+
'```',
|
|
258
|
+
''
|
|
259
|
+
].join('\n'));
|
|
260
|
+
// Available fields reference
|
|
261
|
+
sections.push([
|
|
262
|
+
'## Available Filter Fields',
|
|
263
|
+
'',
|
|
264
|
+
'For detailed field values in each source layer, use the style_builder_tool.',
|
|
265
|
+
'The tool will provide specific guidance when a layer is not recognized.',
|
|
266
|
+
'',
|
|
267
|
+
'### Key Fields by Layer:',
|
|
268
|
+
'',
|
|
269
|
+
'**landuse:** class, type',
|
|
270
|
+
'**road:** class, type, structure, toll, oneway',
|
|
271
|
+
'**admin:** admin_level, disputed, maritime',
|
|
272
|
+
'**building:** type, height, min_height, extrude',
|
|
273
|
+
'**water:** (no filter fields - all water features)',
|
|
274
|
+
'**waterway:** class, type',
|
|
275
|
+
'**place_label:** class, type, capital',
|
|
276
|
+
'**poi_label:** maki, class, filterrank',
|
|
277
|
+
'**transit_stop_label:** mode, stop_type, network',
|
|
278
|
+
''
|
|
279
|
+
].join('\n'));
|
|
280
|
+
// Working with styles
|
|
281
|
+
sections.push([
|
|
282
|
+
'## Working with Styles',
|
|
283
|
+
'',
|
|
284
|
+
'### Using style_builder_tool',
|
|
285
|
+
'',
|
|
286
|
+
'The style_builder_tool is the primary way to create Mapbox styles. It:',
|
|
287
|
+
'- Automatically determines the correct geometry type for each source layer',
|
|
288
|
+
'- Applies appropriate paint properties based on the action (color, highlight, hide, show)',
|
|
289
|
+
'- Generates proper filters from filter_properties',
|
|
290
|
+
'- Provides helpful suggestions when layers are not recognized',
|
|
291
|
+
'',
|
|
292
|
+
'### Example Usage',
|
|
293
|
+
'',
|
|
294
|
+
'```',
|
|
295
|
+
'style_builder_tool({',
|
|
296
|
+
' style_name: "Custom Style",',
|
|
297
|
+
' base_style: "standard",',
|
|
298
|
+
' layers: [',
|
|
299
|
+
' {',
|
|
300
|
+
' layer_type: "water",',
|
|
301
|
+
' action: "color",',
|
|
302
|
+
' color: "#0099ff"',
|
|
303
|
+
' },',
|
|
304
|
+
' {',
|
|
305
|
+
' layer_type: "landuse",',
|
|
306
|
+
' filter_properties: { class: "park" },',
|
|
307
|
+
' action: "color",',
|
|
308
|
+
' color: "#00ff00"',
|
|
309
|
+
' },',
|
|
310
|
+
' {',
|
|
311
|
+
' layer_type: "road",',
|
|
312
|
+
' filter_properties: { class: ["motorway", "trunk"] },',
|
|
313
|
+
' action: "highlight"',
|
|
314
|
+
' }',
|
|
315
|
+
' ]',
|
|
316
|
+
'})',
|
|
317
|
+
'```'
|
|
318
|
+
].join('\n'));
|
|
319
|
+
return sections.join('\n');
|
|
320
|
+
}
|
|
321
|
+
}
|
|
322
|
+
exports.MapboxStyleLayersResource = MapboxStyleLayersResource;
|
|
323
|
+
//# sourceMappingURL=MapboxStyleLayersResource.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"MapboxStyleLayersResource.js","sourceRoot":"","sources":["../../../../src/resources/mapbox-style-layers-resource/MapboxStyleLayersResource.ts"],"names":[],"mappings":";AAAA,6BAA6B;AAC7B,kCAAkC;;;AAElC,wDAAkD;AAElD;;;GAGG;AACH,MAAa,yBAA0B,SAAQ,8BAAY;IAChD,IAAI,GAAG,kCAAkC,CAAC;IAC1C,GAAG,GAAG,gCAAgC,CAAC;IACvC,WAAW,GAClB,mHAAmH,CAAC;IAC7G,QAAQ,GAAG,eAAe,CAAC;IAE7B,KAAK,CAAC,YAAY,CAAC,GAAQ,EAAE,MAAe;QACjD,gDAAgD;QAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAEzC,OAAO;YACL,QAAQ,EAAE;gBACR;oBACE,GAAG,EAAE,GAAG,CAAC,IAAI;oBACb,QAAQ,EAAE,IAAI,CAAC,QAAQ;oBACvB,IAAI,EAAE,QAAQ;iBACf;aACF;SACF,CAAC;IACJ,CAAC;IAEO,gBAAgB;QACtB,MAAM,QAAQ,GAAa,EAAE,CAAC;QAE9B,SAAS;QACT,QAAQ,CAAC,IAAI,CACX;YACE,oCAAoC;YACpC,EAAE;YACF,0FAA0F;YAC1F,EAAE;YACF,6BAA6B;YAC7B,EAAE;YACF,0CAA0C;YAC1C,EAAE;YACF,qBAAqB;YACrB,qEAAqE;YACrE,8DAA8D;YAC9D,qDAAqD;YACrD,mEAAmE;YACnE,EAAE;YACF,wBAAwB;YACxB,uCAAuC;YACvC,uCAAuC;YACvC,iDAAiD;YACjD,4CAA4C;YAC5C,0CAA0C;YAC1C,EAAE;YACF,0BAA0B;YAC1B,+CAA+C;YAC/C,oCAAoC;YACpC,oCAAoC;YACpC,wCAAwC;YACxC,uCAAuC;YACvC,oCAAoC;YACpC,4EAA4E;YAC5E,EAAE;YACF,+BAA+B;YAC/B,EAAE;SACH,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QAEF,aAAa;QACb,QAAQ,CAAC,IAAI,CACX;YACE,UAAU;YACV,wEAAwE;YACxE,EAAE;YACF,uBAAuB;YACvB,oEAAoE;YACpE,yEAAyE;YACzE,oGAAoG;YACpG,oEAAoE;YACpE,sEAAsE;YACtE,gFAAgF;YAChF,2FAA2F;YAC3F,EAAE;YACF,wBAAwB;YACxB,uFAAuF;YACvF,wEAAwE;YACxE,EAAE;SACH,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QAEF,aAAa;QACb,QAAQ,CAAC,IAAI,CACX;YACE,UAAU;YACV,0FAA0F;YAC1F,EAAE;YACF,uBAAuB;YACvB,6DAA6D;YAC7D,6DAA6D;YAC7D,4DAA4D;YAC5D,mEAAmE;YACnE,8EAA8E;YAC9E,gEAAgE;YAChE,yEAAyE;YACzE,6DAA6D;YAC7D,sFAAsF;YACtF,gFAAgF;YAChF,2FAA2F;YAC3F,EAAE;YACF,wBAAwB;YACxB,uFAAuF;YACvF,kFAAkF;YAClF,qFAAqF;YACrF,4DAA4D;YAC5D,oEAAoE;YACpE,iDAAiD;YACjD,EAAE;SACH,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QAEF,eAAe;QACf,QAAQ,CAAC,IAAI,CACX;YACE,YAAY;YACZ,8FAA8F;YAC9F,EAAE;YACF,iCAAiC;YACjC,uFAAuF;YACvF,4FAA4F;YAC5F,wEAAwE;YACxE,yEAAyE;YACzE,oDAAoD;YACpD,gFAAgF;YAChF,EAAE;YACF,+BAA+B;YAC/B,2DAA2D;YAC3D,8IAA8I;YAC9I,qDAAqD;YACrD,gEAAgE;YAChE,iEAAiE;YACjE,gEAAgE;YAChE,8FAA8F;YAC9F,6FAA6F;YAC7F,oEAAoE;YACpE,2DAA2D;YAC3D,qEAAqE;YACrE,8EAA8E;YAC9E,oFAAoF;YACpF,iEAAiE;YACjE,mEAAmE;YACnE,4EAA4E;YAC5E,mEAAmE;YACnE,EAAE;YACF,+BAA+B;YAC/B,kEAAkE;YAClE,sDAAsD;YACtD,2DAA2D;YAC3D,qEAAqE;YACrE,8DAA8D;YAC9D,iEAAiE;YACjE,iFAAiF;YACjF,wFAAwF;YACxF,6FAA6F;YAC7F,kFAAkF;YAClF,mEAAmE;YACnE,uEAAuE;YACvE,mEAAmE;YACnE,EAAE;YACF,8BAA8B;YAC9B,yDAAyD;YACzD,mFAAmF;YACnF,wDAAwD;YACxD,sDAAsD;YACtD,4DAA4D;YAC5D,4EAA4E;YAC5E,2FAA2F;YAC3F,EAAE;YACF,8BAA8B;YAC9B,2CAA2C;YAC3C,wDAAwD;YACxD,yDAAyD;YACzD,uDAAuD;YACvD,4DAA4D;YAC5D,4EAA4E;YAC5E,2FAA2F;YAC3F,EAAE;SACH,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QAEF,eAAe;QACf,QAAQ,CAAC,IAAI,CACX;YACE,YAAY;YACZ,sEAAsE;YACtE,EAAE;YACF,uBAAuB;YACvB,iEAAiE;YACjE,4DAA4D;YAC5D,gEAAgE;YAChE,4DAA4D;YAC5D,sDAAsD;YACtD,qEAAqE;YACrE,8EAA8E;YAC9E,gFAAgF;YAChF,6FAA6F;YAC7F,+EAA+E;YAC/E,0FAA0F;YAC1F,EAAE;YACF,wBAAwB;YACxB,uFAAuF;YACvF,oDAAoD;YACpD,EAAE;SACH,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QAEF,uBAAuB;QACvB,QAAQ,CAAC,IAAI,CACX;YACE,oBAAoB;YACpB,2EAA2E;YAC3E,EAAE;YACF,uBAAuB;YACvB,6EAA6E;YAC7E,wFAAwF;YACxF,+FAA+F;YAC/F,2EAA2E;YAC3E,kEAAkE;YAClE,0FAA0F;YAC1F,uFAAuF;YACvF,gFAAgF;YAChF,EAAE;YACF,wBAAwB;YACxB,uFAAuF;YACvF,mGAAmG;YACnG,EAAE;SACH,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QAEF,+BAA+B;QAC/B,QAAQ,CAAC,IAAI,CACX;YACE,oBAAoB;YACpB,EAAE;YACF,wBAAwB;YACxB,EAAE;YACF,kDAAkD;YAClD,SAAS;YACT,GAAG;YACH,4BAA4B;YAC5B,4CAA4C;YAC5C,GAAG;YACH,KAAK;YACL,EAAE;YACF,kBAAkB;YAClB,SAAS;YACT,GAAG;YACH,yBAAyB;YACzB,sEAAsE;YACtE,GAAG;YACH,KAAK;YACL,EAAE;YACF,yBAAyB;YACzB,SAAS;YACT,GAAG;YACH,0BAA0B;YAC1B,kEAAkE;YAClE,GAAG;YACH,KAAK;YACL,EAAE;YACF,mBAAmB;YACnB,SAAS;YACT,GAAG;YACH,6BAA6B;YAC7B,8CAA8C;YAC9C,GAAG;YACH,KAAK;YACL,EAAE;SACH,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QAEF,6BAA6B;QAC7B,QAAQ,CAAC,IAAI,CACX;YACE,4BAA4B;YAC5B,EAAE;YACF,6EAA6E;YAC7E,yEAAyE;YACzE,EAAE;YACF,0BAA0B;YAC1B,EAAE;YACF,0BAA0B;YAC1B,gDAAgD;YAChD,4CAA4C;YAC5C,iDAAiD;YACjD,oDAAoD;YACpD,2BAA2B;YAC3B,uCAAuC;YACvC,wCAAwC;YACxC,kDAAkD;YAClD,EAAE;SACH,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QAEF,sBAAsB;QACtB,QAAQ,CAAC,IAAI,CACX;YACE,wBAAwB;YACxB,EAAE;YACF,8BAA8B;YAC9B,EAAE;YACF,wEAAwE;YACxE,4EAA4E;YAC5E,2FAA2F;YAC3F,mDAAmD;YACnD,+DAA+D;YAC/D,EAAE;YACF,mBAAmB;YACnB,EAAE;YACF,KAAK;YACL,sBAAsB;YACtB,+BAA+B;YAC/B,2BAA2B;YAC3B,aAAa;YACb,OAAO;YACP,4BAA4B;YAC5B,wBAAwB;YACxB,wBAAwB;YACxB,QAAQ;YACR,OAAO;YACP,8BAA8B;YAC9B,6CAA6C;YAC7C,wBAAwB;YACxB,wBAAwB;YACxB,QAAQ;YACR,OAAO;YACP,2BAA2B;YAC3B,4DAA4D;YAC5D,2BAA2B;YAC3B,OAAO;YACP,KAAK;YACL,IAAI;YACJ,KAAK;SACN,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QAEF,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;CACF;AAtVD,8DAsVC"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { BaseResource } from '../BaseResource.js';
|
|
2
|
+
/**
|
|
3
|
+
* Resource providing Mapbox token scope reference documentation
|
|
4
|
+
* Helps users and AI understand what each token scope allows
|
|
5
|
+
*/
|
|
6
|
+
export declare class MapboxTokenScopesResource extends BaseResource {
|
|
7
|
+
readonly name = "Mapbox Token Scopes Reference";
|
|
8
|
+
readonly uri = "resource://mapbox-token-scopes";
|
|
9
|
+
readonly description = "Reference guide for Mapbox access token scopes and their permissions. Use this to understand what each scope allows and which scopes are needed for different operations.";
|
|
10
|
+
readonly mimeType = "text/markdown";
|
|
11
|
+
readCallback(uri: URL, _extra: unknown): Promise<{
|
|
12
|
+
contents: {
|
|
13
|
+
uri: string;
|
|
14
|
+
mimeType: string;
|
|
15
|
+
text: string;
|
|
16
|
+
}[];
|
|
17
|
+
}>;
|
|
18
|
+
private generateMarkdown;
|
|
19
|
+
}
|
|
20
|
+
//# sourceMappingURL=MapboxTokenScopesResource.d.ts.map
|
package/dist/commonjs/resources/mapbox-token-scopes-resource/MapboxTokenScopesResource.d.ts.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"MapboxTokenScopesResource.d.ts","sourceRoot":"","sources":["../../../../src/resources/mapbox-token-scopes-resource/MapboxTokenScopesResource.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD;;;GAGG;AACH,qBAAa,yBAA0B,SAAQ,YAAY;IACzD,QAAQ,CAAC,IAAI,mCAAmC;IAChD,QAAQ,CAAC,GAAG,oCAAoC;IAChD,QAAQ,CAAC,WAAW,+KAC0J;IAC9K,QAAQ,CAAC,QAAQ,mBAAmB;IAEvB,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO;;;;;;;IAcnD,OAAO,CAAC,gBAAgB;CA8EzB"}
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// Copyright (c) Mapbox, Inc.
|
|
3
|
+
// Licensed under the MIT License.
|
|
4
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
|
+
exports.MapboxTokenScopesResource = void 0;
|
|
6
|
+
const BaseResource_js_1 = require("../BaseResource.js");
|
|
7
|
+
/**
|
|
8
|
+
* Resource providing Mapbox token scope reference documentation
|
|
9
|
+
* Helps users and AI understand what each token scope allows
|
|
10
|
+
*/
|
|
11
|
+
class MapboxTokenScopesResource extends BaseResource_js_1.BaseResource {
|
|
12
|
+
name = 'Mapbox Token Scopes Reference';
|
|
13
|
+
uri = 'resource://mapbox-token-scopes';
|
|
14
|
+
description = 'Reference guide for Mapbox access token scopes and their permissions. Use this to understand what each scope allows and which scopes are needed for different operations.';
|
|
15
|
+
mimeType = 'text/markdown';
|
|
16
|
+
async readCallback(uri, _extra) {
|
|
17
|
+
const markdown = this.generateMarkdown();
|
|
18
|
+
return {
|
|
19
|
+
contents: [
|
|
20
|
+
{
|
|
21
|
+
uri: uri.href,
|
|
22
|
+
mimeType: this.mimeType,
|
|
23
|
+
text: markdown
|
|
24
|
+
}
|
|
25
|
+
]
|
|
26
|
+
};
|
|
27
|
+
}
|
|
28
|
+
generateMarkdown() {
|
|
29
|
+
return `# Mapbox Token Scopes Reference
|
|
30
|
+
|
|
31
|
+
Complete reference for Mapbox access token scopes. Source: https://docs.mapbox.com/accounts/guides/tokens/#scopes
|
|
32
|
+
|
|
33
|
+
## Token Types
|
|
34
|
+
|
|
35
|
+
### Public Tokens (\`pk.*\`)
|
|
36
|
+
Used in client-side applications (web browsers, mobile apps). Can only be assigned public scopes.
|
|
37
|
+
|
|
38
|
+
### Secret Tokens (\`sk.*\`)
|
|
39
|
+
Used server-side. Can be assigned any scope including write operations. Never expose in client-side code.
|
|
40
|
+
|
|
41
|
+
## Public Token Scopes
|
|
42
|
+
|
|
43
|
+
| Scope | Purpose |
|
|
44
|
+
|---|---|
|
|
45
|
+
| \`styles:tiles\` | Read style as PNG tiles and static images (Static Images and Static Tiles APIs) |
|
|
46
|
+
| \`styles:read\` | Initialize Mapbox map styles in GL JS and mobile SDKs |
|
|
47
|
+
| \`fonts:read\` | Generate fonts for map styles; retrieve glyphs via Fonts API |
|
|
48
|
+
| \`datasets:read\` | Retrieve dataset information through the Datasets API |
|
|
49
|
+
|
|
50
|
+
## Secret Token Scopes
|
|
51
|
+
|
|
52
|
+
| Scope | Purpose |
|
|
53
|
+
|---|---|
|
|
54
|
+
| \`scopes:list\` | List available scopes via the Tokens API |
|
|
55
|
+
| \`map:read\` | Access tilesets, tilestats, and legacy projects |
|
|
56
|
+
| \`map:write\` | Create and update tilesets and tilestats |
|
|
57
|
+
| \`user:read\` | Retrieve account profile details |
|
|
58
|
+
| \`user:write\` | Modify account information |
|
|
59
|
+
| \`uploads:read\` | Track upload statuses |
|
|
60
|
+
| \`uploads:list\` | Retrieve multiple upload statuses |
|
|
61
|
+
| \`uploads:write\` | Create tileset uploads |
|
|
62
|
+
| \`styles:write\` | Create and update styles |
|
|
63
|
+
| \`styles:list\` | List account styles (metadata only) |
|
|
64
|
+
| \`styles:protect\` | Protect style write access and assets |
|
|
65
|
+
| \`tokens:read\` | List account tokens |
|
|
66
|
+
| \`tokens:write\` | Create, update, and delete tokens |
|
|
67
|
+
| \`datasets:list\` | List account datasets |
|
|
68
|
+
| \`datasets:write\` | Create and update datasets |
|
|
69
|
+
| \`tilesets:list\` | List tilesets and tileset sources |
|
|
70
|
+
| \`tilesets:read\` | Read tilesets via Mapbox Tiling Service |
|
|
71
|
+
| \`tilesets:write\` | Create, publish, and manage tilesets |
|
|
72
|
+
| \`downloads:read\` | Download Maps and Navigation SDKs |
|
|
73
|
+
| \`atlas:read\` | Access Mapbox Atlas data (Atlas accounts only) |
|
|
74
|
+
|
|
75
|
+
## Common Scope Combinations
|
|
76
|
+
|
|
77
|
+
### Minimal map display (public token)
|
|
78
|
+
\`\`\`
|
|
79
|
+
["styles:tiles", "fonts:read"]
|
|
80
|
+
\`\`\`
|
|
81
|
+
|
|
82
|
+
### Map display with custom dataset (public token)
|
|
83
|
+
\`\`\`
|
|
84
|
+
["styles:tiles", "fonts:read", "datasets:read"]
|
|
85
|
+
\`\`\`
|
|
86
|
+
|
|
87
|
+
### Style management (secret token)
|
|
88
|
+
\`\`\`
|
|
89
|
+
["styles:read", "styles:write", "styles:list", "fonts:read"]
|
|
90
|
+
\`\`\`
|
|
91
|
+
|
|
92
|
+
### Full DevKit server (secret token)
|
|
93
|
+
\`\`\`
|
|
94
|
+
["styles:read", "styles:write", "styles:list", "fonts:read",
|
|
95
|
+
"tokens:read", "tokens:write", "tilesets:read", "tilesets:list"]
|
|
96
|
+
\`\`\`
|
|
97
|
+
|
|
98
|
+
## Best Practices
|
|
99
|
+
|
|
100
|
+
- **Minimal scopes**: Do not grant more scopes than necessary to each token
|
|
101
|
+
- **Public tokens in client code**: Never expose secret tokens in browsers or mobile apps
|
|
102
|
+
- **URL restrictions**: Restrict public tokens to specific domains via \`allowedUrls\`
|
|
103
|
+
- **Rotate regularly**: Periodically rotate secret tokens used in production
|
|
104
|
+
`;
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
exports.MapboxTokenScopesResource = MapboxTokenScopesResource;
|
|
108
|
+
//# sourceMappingURL=MapboxTokenScopesResource.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"MapboxTokenScopesResource.js","sourceRoot":"","sources":["../../../../src/resources/mapbox-token-scopes-resource/MapboxTokenScopesResource.ts"],"names":[],"mappings":";AAAA,6BAA6B;AAC7B,kCAAkC;;;AAElC,wDAAkD;AAElD;;;GAGG;AACH,MAAa,yBAA0B,SAAQ,8BAAY;IAChD,IAAI,GAAG,+BAA+B,CAAC;IACvC,GAAG,GAAG,gCAAgC,CAAC;IACvC,WAAW,GAClB,2KAA2K,CAAC;IACrK,QAAQ,GAAG,eAAe,CAAC;IAE7B,KAAK,CAAC,YAAY,CAAC,GAAQ,EAAE,MAAe;QACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAEzC,OAAO;YACL,QAAQ,EAAE;gBACR;oBACE,GAAG,EAAE,GAAG,CAAC,IAAI;oBACb,QAAQ,EAAE,IAAI,CAAC,QAAQ;oBACvB,IAAI,EAAE,QAAQ;iBACf;aACF;SACF,CAAC;IACJ,CAAC;IAEO,gBAAgB;QACtB,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2EV,CAAC;IACA,CAAC;CACF;AAnGD,8DAmGC"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { MapboxStyleLayersResource } from './mapbox-style-layers-resource/MapboxStyleLayersResource.js';
|
|
2
|
+
import { MapboxStreetsV8FieldsResource } from './mapbox-streets-v8-fields-resource/MapboxStreetsV8FieldsResource.js';
|
|
3
|
+
import { MapboxTokenScopesResource } from './mapbox-token-scopes-resource/MapboxTokenScopesResource.js';
|
|
4
|
+
import { MapboxLayerTypeMappingResource } from './mapbox-layer-type-mapping-resource/MapboxLayerTypeMappingResource.js';
|
|
5
|
+
import { MapboxDocumentationResource } from './mapbox-documentation-resource/MapboxDocumentationResource.js';
|
|
6
|
+
import { MapboxApiReferenceResource } from './mapbox-api-reference-resource/MapboxApiReferenceResource.js';
|
|
7
|
+
import { MapboxSdkDocsResource } from './mapbox-sdk-docs-resource/MapboxSdkDocsResource.js';
|
|
8
|
+
import { MapboxGuidesResource } from './mapbox-guides-resource/MapboxGuidesResource.js';
|
|
9
|
+
import { MapboxExamplesResource } from './mapbox-examples-resource/MapboxExamplesResource.js';
|
|
10
|
+
import { MapboxReferenceResource } from './mapbox-reference-resource/MapboxReferenceResource.js';
|
|
11
|
+
export declare const ALL_RESOURCES: readonly [MapboxStyleLayersResource, MapboxStreetsV8FieldsResource, MapboxTokenScopesResource, MapboxLayerTypeMappingResource, MapboxDocumentationResource, MapboxApiReferenceResource, MapboxSdkDocsResource, MapboxGuidesResource, MapboxExamplesResource, MapboxReferenceResource];
|
|
12
|
+
export type ResourceInstance = (typeof ALL_RESOURCES)[number];
|
|
13
|
+
export declare function getAllResources(): readonly ResourceInstance[];
|
|
14
|
+
export declare function getResourceByUri(uri: string): ResourceInstance | undefined;
|
|
15
|
+
//# sourceMappingURL=resourceRegistry.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resourceRegistry.d.ts","sourceRoot":"","sources":["../../../src/resources/resourceRegistry.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,yBAAyB,EAAE,MAAM,6DAA6D,CAAC;AACxG,OAAO,EAAE,6BAA6B,EAAE,MAAM,sEAAsE,CAAC;AACrH,OAAO,EAAE,yBAAyB,EAAE,MAAM,6DAA6D,CAAC;AACxG,OAAO,EAAE,8BAA8B,EAAE,MAAM,wEAAwE,CAAC;AACxH,OAAO,EAAE,2BAA2B,EAAE,MAAM,gEAAgE,CAAC;AAC7G,OAAO,EAAE,0BAA0B,EAAE,MAAM,+DAA+D,CAAC;AAC3G,OAAO,EAAE,qBAAqB,EAAE,MAAM,qDAAqD,CAAC;AAC5F,OAAO,EAAE,oBAAoB,EAAE,MAAM,kDAAkD,CAAC;AACxF,OAAO,EAAE,sBAAsB,EAAE,MAAM,sDAAsD,CAAC;AAC9F,OAAO,EAAE,uBAAuB,EAAE,MAAM,wDAAwD,CAAC;AAIjG,eAAO,MAAM,aAAa,uRAYhB,CAAC;AAEX,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC;AAE9D,wBAAgB,eAAe,IAAI,SAAS,gBAAgB,EAAE,CAE7D;AAED,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAE1E"}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// Copyright (c) Mapbox, Inc.
|
|
3
|
+
// Licensed under the MIT License.
|
|
4
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
|
+
exports.ALL_RESOURCES = void 0;
|
|
6
|
+
exports.getAllResources = getAllResources;
|
|
7
|
+
exports.getResourceByUri = getResourceByUri;
|
|
8
|
+
const MapboxStyleLayersResource_js_1 = require("./mapbox-style-layers-resource/MapboxStyleLayersResource.js");
|
|
9
|
+
const MapboxStreetsV8FieldsResource_js_1 = require("./mapbox-streets-v8-fields-resource/MapboxStreetsV8FieldsResource.js");
|
|
10
|
+
const MapboxTokenScopesResource_js_1 = require("./mapbox-token-scopes-resource/MapboxTokenScopesResource.js");
|
|
11
|
+
const MapboxLayerTypeMappingResource_js_1 = require("./mapbox-layer-type-mapping-resource/MapboxLayerTypeMappingResource.js");
|
|
12
|
+
const MapboxDocumentationResource_js_1 = require("./mapbox-documentation-resource/MapboxDocumentationResource.js");
|
|
13
|
+
const MapboxApiReferenceResource_js_1 = require("./mapbox-api-reference-resource/MapboxApiReferenceResource.js");
|
|
14
|
+
const MapboxSdkDocsResource_js_1 = require("./mapbox-sdk-docs-resource/MapboxSdkDocsResource.js");
|
|
15
|
+
const MapboxGuidesResource_js_1 = require("./mapbox-guides-resource/MapboxGuidesResource.js");
|
|
16
|
+
const MapboxExamplesResource_js_1 = require("./mapbox-examples-resource/MapboxExamplesResource.js");
|
|
17
|
+
const MapboxReferenceResource_js_1 = require("./mapbox-reference-resource/MapboxReferenceResource.js");
|
|
18
|
+
const httpPipeline_js_1 = require("../utils/httpPipeline.js");
|
|
19
|
+
// Central registry of all resources
|
|
20
|
+
exports.ALL_RESOURCES = [
|
|
21
|
+
new MapboxStyleLayersResource_js_1.MapboxStyleLayersResource(),
|
|
22
|
+
new MapboxStreetsV8FieldsResource_js_1.MapboxStreetsV8FieldsResource(),
|
|
23
|
+
new MapboxTokenScopesResource_js_1.MapboxTokenScopesResource(),
|
|
24
|
+
new MapboxLayerTypeMappingResource_js_1.MapboxLayerTypeMappingResource(),
|
|
25
|
+
new MapboxDocumentationResource_js_1.MapboxDocumentationResource({ httpRequest: httpPipeline_js_1.httpRequest }), // Kept for backward compatibility
|
|
26
|
+
// New granular documentation resources
|
|
27
|
+
new MapboxApiReferenceResource_js_1.MapboxApiReferenceResource({ httpRequest: httpPipeline_js_1.httpRequest }),
|
|
28
|
+
new MapboxSdkDocsResource_js_1.MapboxSdkDocsResource({ httpRequest: httpPipeline_js_1.httpRequest }),
|
|
29
|
+
new MapboxGuidesResource_js_1.MapboxGuidesResource({ httpRequest: httpPipeline_js_1.httpRequest }),
|
|
30
|
+
new MapboxExamplesResource_js_1.MapboxExamplesResource({ httpRequest: httpPipeline_js_1.httpRequest }),
|
|
31
|
+
new MapboxReferenceResource_js_1.MapboxReferenceResource({ httpRequest: httpPipeline_js_1.httpRequest })
|
|
32
|
+
];
|
|
33
|
+
function getAllResources() {
|
|
34
|
+
return exports.ALL_RESOURCES;
|
|
35
|
+
}
|
|
36
|
+
function getResourceByUri(uri) {
|
|
37
|
+
return exports.ALL_RESOURCES.find((resource) => resource.uri === uri);
|
|
38
|
+
}
|
|
39
|
+
//# sourceMappingURL=resourceRegistry.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resourceRegistry.js","sourceRoot":"","sources":["../../../src/resources/resourceRegistry.ts"],"names":[],"mappings":";AAAA,6BAA6B;AAC7B,kCAAkC;;;AA+BlC,0CAEC;AAED,4CAEC;AAnCD,8GAAwG;AACxG,2HAAqH;AACrH,8GAAwG;AACxG,8HAAwH;AACxH,mHAA6G;AAC7G,iHAA2G;AAC3G,kGAA4F;AAC5F,8FAAwF;AACxF,oGAA8F;AAC9F,uGAAiG;AACjG,8DAAuD;AAEvD,oCAAoC;AACvB,QAAA,aAAa,GAAG;IAC3B,IAAI,wDAAyB,EAAE;IAC/B,IAAI,gEAA6B,EAAE;IACnC,IAAI,wDAAyB,EAAE;IAC/B,IAAI,kEAA8B,EAAE;IACpC,IAAI,4DAA2B,CAAC,EAAE,WAAW,EAAX,6BAAW,EAAE,CAAC,EAAE,kCAAkC;IACpF,uCAAuC;IACvC,IAAI,0DAA0B,CAAC,EAAE,WAAW,EAAX,6BAAW,EAAE,CAAC;IAC/C,IAAI,gDAAqB,CAAC,EAAE,WAAW,EAAX,6BAAW,EAAE,CAAC;IAC1C,IAAI,8CAAoB,CAAC,EAAE,WAAW,EAAX,6BAAW,EAAE,CAAC;IACzC,IAAI,kDAAsB,CAAC,EAAE,WAAW,EAAX,6BAAW,EAAE,CAAC;IAC3C,IAAI,oDAAuB,CAAC,EAAE,WAAW,EAAX,6BAAW,EAAE,CAAC;CACpC,CAAC;AAIX,SAAgB,eAAe;IAC7B,OAAO,qBAAa,CAAC;AACvB,CAAC;AAED,SAAgB,gBAAgB,CAAC,GAAW;IAC1C,OAAO,qBAAa,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;AAChE,CAAC"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Parsed documentation section
|
|
3
|
+
*/
|
|
4
|
+
export interface DocSection {
|
|
5
|
+
title: string;
|
|
6
|
+
content: string;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* Category type for documentation sections
|
|
10
|
+
*/
|
|
11
|
+
export type DocCategory = 'apis' | 'sdks' | 'guides' | 'examples' | 'reference';
|
|
12
|
+
/**
|
|
13
|
+
* Parse Mapbox documentation into sections
|
|
14
|
+
*/
|
|
15
|
+
export declare function parseDocSections(content: string): DocSection[];
|
|
16
|
+
/**
|
|
17
|
+
* Categorize a section based on its title
|
|
18
|
+
*/
|
|
19
|
+
export declare function categorizeSection(title: string): DocCategory;
|
|
20
|
+
/**
|
|
21
|
+
* Filter sections by category
|
|
22
|
+
*/
|
|
23
|
+
export declare function filterSectionsByCategory(sections: DocSection[], category: DocCategory): DocSection[];
|
|
24
|
+
/**
|
|
25
|
+
* Convert sections back to markdown
|
|
26
|
+
*/
|
|
27
|
+
export declare function sectionsToMarkdown(sections: DocSection[]): string;
|
|
28
|
+
//# sourceMappingURL=docParser.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docParser.d.ts","sourceRoot":"","sources":["../../../../src/resources/utils/docParser.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,WAAW,CAAC;AAEhF;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU,EAAE,CAoC9D;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,CA4C5D;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,UAAU,EAAE,EACtB,QAAQ,EAAE,WAAW,GACpB,UAAU,EAAE,CAId;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,UAAU,EAAE,GAAG,MAAM,CAIjE"}
|