@signalwire/sdk 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/publish.yml +27 -0
- package/.github/workflows/test.yml +17 -0
- package/CLAUDE.md +112 -0
- package/README.md +254 -0
- package/docs/MIGRATION-2.0.md +81 -0
- package/docs/agent-guide.md +869 -0
- package/docs/agent_guide.md +1026 -0
- package/docs/api-reference.md +2420 -0
- package/docs/api_reference.md +1301 -0
- package/docs/architecture.md +843 -0
- package/docs/cli-guide.md +579 -0
- package/docs/cli_guide.md +448 -0
- package/docs/cloud_functions_guide.md +474 -0
- package/docs/configuration.md +422 -0
- package/docs/contexts-guide.md +787 -0
- package/docs/contexts_guide.md +511 -0
- package/docs/datamap-guide.md +1141 -0
- package/docs/datamap_guide.md +595 -0
- package/docs/llm_parameters.md +239 -0
- package/docs/mcp_gateway_reference.md +648 -0
- package/docs/mcp_integration.md +108 -0
- package/docs/prefabs-guide.md +800 -0
- package/docs/sdk_features.md +477 -0
- package/docs/security.md +436 -0
- package/docs/serverless-guide.md +513 -0
- package/docs/skills-guide.md +857 -0
- package/docs/skills-system.md +301 -0
- package/docs/skills_parameter_schema.md +392 -0
- package/docs/skills_system.md +467 -0
- package/docs/swaig-reference.md +1627 -0
- package/docs/swaig_reference.md +910 -0
- package/docs/swml_service_guide.md +600 -0
- package/docs/third_party_skills.md +533 -0
- package/docs/web_service.md +677 -0
- package/examples/README.md +131 -0
- package/examples/advanced-datamap.ts +100 -0
- package/examples/advanced-dynamic-config.ts +70 -0
- package/examples/auto-vivified.ts +94 -0
- package/examples/call-flow.ts +63 -0
- package/examples/comprehensive-dynamic.ts +125 -0
- package/examples/contexts-steps.ts +65 -0
- package/examples/custom-path.ts +45 -0
- package/examples/datamap-tools.ts +55 -0
- package/examples/datasphere-multi-instance.ts +63 -0
- package/examples/datasphere-serverless-env.ts +68 -0
- package/examples/datasphere-webhook-env.ts +66 -0
- package/examples/datasphere.ts +37 -0
- package/examples/declarative.ts +100 -0
- package/examples/dynamic-config.ts +54 -0
- package/examples/dynamic-info-gatherer.ts +69 -0
- package/examples/dynamic-swml-service.ts +67 -0
- package/examples/gather-info.ts +71 -0
- package/examples/gather-per-question-functions-demo.ts +140 -0
- package/examples/joke-agent.ts +34 -0
- package/examples/kubernetes-agent.ts +45 -0
- package/examples/llm-params.ts +69 -0
- package/examples/mcp-agent.ts +84 -0
- package/examples/mcp-gateway.ts +35 -0
- package/examples/multi-agent.ts +73 -0
- package/examples/multi-endpoint.ts +79 -0
- package/examples/pom-prompt.ts +71 -0
- package/examples/prefab-concierge.ts +47 -0
- package/examples/prefab-faq.ts +54 -0
- package/examples/prefab-info-gatherer.ts +33 -0
- package/examples/prefab-receptionist.ts +36 -0
- package/examples/prefab-survey.ts +68 -0
- package/examples/record-call.ts +67 -0
- package/examples/relay-demo.ts +33 -0
- package/examples/room-and-sip.ts +94 -0
- package/examples/serverless-lambda.ts +35 -0
- package/examples/session-state.ts +83 -0
- package/examples/simple-agent.ts +36 -0
- package/examples/simple-static.ts +29 -0
- package/examples/skills-demo.ts +38 -0
- package/examples/step-function-inheritance-demo.ts +124 -0
- package/examples/swaig-features.ts +187 -0
- package/examples/swml-service-routing.ts +66 -0
- package/examples/swml-service.ts +38 -0
- package/examples/tap.ts +68 -0
- package/examples/verb-methods.ts +45 -0
- package/examples/web-search-multi-instance.ts +72 -0
- package/examples/web-search.ts +38 -0
- package/examples/wikipedia.ts +36 -0
- package/livewire/README.md +140 -0
- package/livewire/docs/migration-guide.md +228 -0
- package/livewire/examples/livewire-basic-agent.ts +74 -0
- package/livewire/examples/livewire-handoff.ts +197 -0
- package/livewire/examples/livewire-multi-tool.ts +117 -0
- package/package.json +38 -0
- package/relay/README.md +70 -0
- package/relay/RELAY_IMPLEMENTATION_GUIDE.md +1257 -0
- package/relay/docs/call-methods.md +474 -0
- package/relay/docs/client-reference.md +142 -0
- package/relay/docs/events.md +134 -0
- package/relay/docs/getting-started.md +134 -0
- package/relay/docs/guide.md +306 -0
- package/relay/docs/messaging.md +182 -0
- package/relay/examples/relay-inbound.ts +66 -0
- package/relay/examples/relay-messaging.ts +71 -0
- package/relay/examples/relay-outbound.ts +76 -0
- package/rest/README.md +95 -0
- package/rest/docs/calling.md +273 -0
- package/rest/docs/client-reference.md +107 -0
- package/rest/docs/compat.md +204 -0
- package/rest/docs/fabric.md +183 -0
- package/rest/docs/getting-started.md +110 -0
- package/rest/docs/guide.md +351 -0
- package/rest/docs/namespaces.md +285 -0
- package/rest/examples/rest-10dlc-registration.ts +161 -0
- package/rest/examples/rest-calling-ivr-and-ai.ts +102 -0
- package/rest/examples/rest-calling-play-and-record.ts +91 -0
- package/rest/examples/rest-client.ts +65 -0
- package/rest/examples/rest-compat-laml.ts +210 -0
- package/rest/examples/rest-datasphere-search.ts +82 -0
- package/rest/examples/rest-fabric-conferences-and-routing.ts +144 -0
- package/rest/examples/rest-fabric-subscribers-and-sip.ts +108 -0
- package/rest/examples/rest-fabric-swml-and-callflows.ts +99 -0
- package/rest/examples/rest-manage-resources.ts +65 -0
- package/rest/examples/rest-phone-number-management.ts +197 -0
- package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
- package/rest/examples/rest-video-rooms.ts +186 -0
- package/src/AgentBase.ts +2489 -0
- package/src/AgentServer.ts +415 -0
- package/src/AuthHandler.ts +256 -0
- package/src/ConfigLoader.ts +447 -0
- package/src/ContextBuilder.ts +1150 -0
- package/src/DataMap.ts +449 -0
- package/src/FunctionResult.ts +866 -0
- package/src/Logger.ts +337 -0
- package/src/PomBuilder.ts +439 -0
- package/src/PromptManager.ts +133 -0
- package/src/SWMLHandler.ts +298 -0
- package/src/SWMLService.ts +717 -0
- package/src/SchemaUtils.ts +361 -0
- package/src/SecurityUtils.ts +153 -0
- package/src/ServerlessAdapter.ts +221 -0
- package/src/SessionManager.ts +311 -0
- package/src/SslConfig.ts +118 -0
- package/src/SwaigFunction.ts +276 -0
- package/src/SwmlBuilder.ts +258 -0
- package/src/SwmlVerbMethods.generated.ts +234 -0
- package/src/TypeInference.ts +181 -0
- package/src/WebService.ts +619 -0
- package/src/cli/agent-loader.ts +166 -0
- package/src/cli/mock-data.ts +111 -0
- package/src/cli/swaig-test.ts +452 -0
- package/src/generateVerbTypes.ts +322 -0
- package/src/index.ts +167 -0
- package/src/livewire/index.ts +950 -0
- package/src/prefabs/ConciergeAgent.ts +287 -0
- package/src/prefabs/FAQBotAgent.ts +384 -0
- package/src/prefabs/InfoGathererAgent.ts +339 -0
- package/src/prefabs/ReceptionistAgent.ts +366 -0
- package/src/prefabs/SurveyAgent.ts +646 -0
- package/src/prefabs/index.ts +27 -0
- package/src/relay/Action.ts +314 -0
- package/src/relay/Call.ts +854 -0
- package/src/relay/Deferred.ts +71 -0
- package/src/relay/Message.ts +148 -0
- package/src/relay/RelayClient.ts +1036 -0
- package/src/relay/RelayError.ts +14 -0
- package/src/relay/RelayEvent.ts +892 -0
- package/src/relay/constants.ts +132 -0
- package/src/relay/index.ts +123 -0
- package/src/relay/types.ts +149 -0
- package/src/rest/HttpClient.ts +103 -0
- package/src/rest/RestError.ts +31 -0
- package/src/rest/base/BaseResource.ts +19 -0
- package/src/rest/base/CrudResource.ts +51 -0
- package/src/rest/base/CrudWithAddresses.ts +26 -0
- package/src/rest/index.ts +200 -0
- package/src/rest/namespaces/addresses.ts +32 -0
- package/src/rest/namespaces/calling.ts +187 -0
- package/src/rest/namespaces/chat.ts +20 -0
- package/src/rest/namespaces/compat.ts +352 -0
- package/src/rest/namespaces/datasphere.ts +45 -0
- package/src/rest/namespaces/fabric.ts +222 -0
- package/src/rest/namespaces/imported-numbers.ts +20 -0
- package/src/rest/namespaces/logs.ts +84 -0
- package/src/rest/namespaces/lookup.ts +21 -0
- package/src/rest/namespaces/mfa.ts +30 -0
- package/src/rest/namespaces/number-groups.ts +38 -0
- package/src/rest/namespaces/phone-numbers.ts +44 -0
- package/src/rest/namespaces/project.ts +36 -0
- package/src/rest/namespaces/pubsub.ts +20 -0
- package/src/rest/namespaces/queues.ts +33 -0
- package/src/rest/namespaces/recordings.ts +28 -0
- package/src/rest/namespaces/registry.ts +101 -0
- package/src/rest/namespaces/short-codes.ts +28 -0
- package/src/rest/namespaces/sip-profile.ts +25 -0
- package/src/rest/namespaces/verified-callers.ts +27 -0
- package/src/rest/namespaces/video.ts +165 -0
- package/src/rest/pagination.ts +84 -0
- package/src/rest/types.ts +61 -0
- package/src/schema.json +12250 -0
- package/src/skills/SkillBase.ts +547 -0
- package/src/skills/SkillManager.ts +415 -0
- package/src/skills/SkillRegistry.ts +367 -0
- package/src/skills/builtin/api_ninjas_trivia.ts +280 -0
- package/src/skills/builtin/ask_claude.ts +241 -0
- package/src/skills/builtin/claude_skills.ts +978 -0
- package/src/skills/builtin/custom_skills.ts +312 -0
- package/src/skills/builtin/datasphere.ts +438 -0
- package/src/skills/builtin/datasphere_serverless.ts +339 -0
- package/src/skills/builtin/datetime.ts +130 -0
- package/src/skills/builtin/google_maps.ts +651 -0
- package/src/skills/builtin/index.ts +88 -0
- package/src/skills/builtin/info_gatherer.ts +405 -0
- package/src/skills/builtin/joke.ts +191 -0
- package/src/skills/builtin/math.ts +142 -0
- package/src/skills/builtin/mcp_gateway.ts +677 -0
- package/src/skills/builtin/native_vector_search.ts +901 -0
- package/src/skills/builtin/play_background_file.ts +358 -0
- package/src/skills/builtin/spider.ts +869 -0
- package/src/skills/builtin/swml_transfer.ts +635 -0
- package/src/skills/builtin/weather_api.ts +248 -0
- package/src/skills/builtin/web_search.ts +1074 -0
- package/src/skills/builtin/wikipedia_search.ts +299 -0
- package/src/skills/index.ts +12 -0
- package/src/types.ts +132 -0
- package/tests/AgentBase.test.ts +1093 -0
- package/tests/AgentServer.test.ts +126 -0
- package/tests/AuthHandler.test.ts +133 -0
- package/tests/ConfigLoader.test.ts +151 -0
- package/tests/ContextBuilder.test.ts +108 -0
- package/tests/DataMap.test.ts +367 -0
- package/tests/EphemeralSkillCopy.test.ts +107 -0
- package/tests/FunctionResult.test.ts +298 -0
- package/tests/GracefulShutdown.test.ts +46 -0
- package/tests/Logger.test.ts +420 -0
- package/tests/PomBuilder.test.ts +228 -0
- package/tests/ProxyDetection.test.ts +228 -0
- package/tests/SWMLService.test.ts +320 -0
- package/tests/SWMLVerbHandler.test.ts +523 -0
- package/tests/SchemaUtils.test.ts +106 -0
- package/tests/SchemaUtils.verb.test.ts +206 -0
- package/tests/SecurityUtils.test.ts +192 -0
- package/tests/ServerlessAdapter.test.ts +222 -0
- package/tests/SessionManager.test.ts +257 -0
- package/tests/SkillBaseFeatures.test.ts +130 -0
- package/tests/SkillMultiInstance.test.ts +102 -0
- package/tests/SkillParameterSchemas.test.ts +134 -0
- package/tests/SkillRegistrySchema.test.ts +84 -0
- package/tests/SslConfig.test.ts +97 -0
- package/tests/SwmlBuilder.test.ts +400 -0
- package/tests/TypeInference.test.ts +165 -0
- package/tests/VerbHandlerRegistry.test.ts +128 -0
- package/tests/cli/mock-data.test.ts +113 -0
- package/tests/cli/swaig-test.test.ts +108 -0
- package/tests/examples.test.ts +194 -0
- package/tests/fixtures/scrape-parity/README.md +53 -0
- package/tests/fixtures/scrape-parity/expected/01_simple_article.json +5 -0
- package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +5 -0
- package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +5 -0
- package/tests/fixtures/scrape-parity/expected/04_bare_body.json +5 -0
- package/tests/fixtures/scrape-parity/expected/05_malformed.json +5 -0
- package/tests/fixtures/scrape-parity/expected/06_multi_class.json +5 -0
- package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +5 -0
- package/tests/fixtures/scrape-parity/expected/08_inline_script.json +5 -0
- package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +5 -0
- package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +5 -0
- package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +5 -0
- package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +5 -0
- package/tests/fixtures/scrape-parity/html/01_simple_article.html +18 -0
- package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +18 -0
- package/tests/fixtures/scrape-parity/html/03_nested_containers.html +13 -0
- package/tests/fixtures/scrape-parity/html/04_bare_body.html +9 -0
- package/tests/fixtures/scrape-parity/html/05_malformed.html +11 -0
- package/tests/fixtures/scrape-parity/html/06_multi_class.html +18 -0
- package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +12 -0
- package/tests/fixtures/scrape-parity/html/08_inline_script.html +17 -0
- package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +21 -0
- package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +10 -0
- package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +13 -0
- package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +24 -0
- package/tests/fixtures/scrape-parity/python_extract.py +109 -0
- package/tests/livewire/livewire.test.ts +780 -0
- package/tests/mcp.test.ts +221 -0
- package/tests/prefabs/prefabs.test.ts +1093 -0
- package/tests/relay/Action.test.ts +392 -0
- package/tests/relay/Call.test.ts +535 -0
- package/tests/relay/Deferred.test.ts +71 -0
- package/tests/relay/Message.test.ts +164 -0
- package/tests/relay/RelayClient.test.ts +779 -0
- package/tests/relay/RelayEvent.test.ts +463 -0
- package/tests/relay/helpers.ts +79 -0
- package/tests/rest/HttpClient.test.ts +274 -0
- package/tests/rest/RestError.test.ts +53 -0
- package/tests/rest/calling.test.ts +156 -0
- package/tests/rest/client.test.ts +197 -0
- package/tests/rest/compat.test.ts +335 -0
- package/tests/rest/datasphere.test.ts +71 -0
- package/tests/rest/fabric.test.ts +186 -0
- package/tests/rest/helpers.ts +95 -0
- package/tests/rest/logs.test.ts +68 -0
- package/tests/rest/pagination.test.ts +133 -0
- package/tests/rest/registry.test.ts +94 -0
- package/tests/rest/relay-rest.test.ts +290 -0
- package/tests/rest/video.test.ts +173 -0
- package/tests/setup.ts +6 -0
- package/tests/skills/SkillBase.test.ts +108 -0
- package/tests/skills/SkillManager.test.ts +268 -0
- package/tests/skills/SkillRegistry.test.ts +176 -0
- package/tests/skills/builtin.test.ts +1472 -0
- package/tests/skills/claude-skills.test.ts +54 -0
- package/tests/skills/custom-skills.test.ts +53 -0
- package/tests/skills/datasphere-serverless.test.ts +70 -0
- package/tests/skills/datasphere.test.ts +107 -0
- package/tests/skills/datetime.test.ts +101 -0
- package/tests/skills/google-maps.test.ts +78 -0
- package/tests/skills/info-gatherer.test.ts +411 -0
- package/tests/skills/joke.test.ts +81 -0
- package/tests/skills/math.test.ts +68 -0
- package/tests/skills/mcp-gateway.test.ts +101 -0
- package/tests/skills/play-background.test.ts +54 -0
- package/tests/skills/spider.test.ts +108 -0
- package/tests/skills/swml-transfer.test.ts +178 -0
- package/tests/skills/trivia.test.ts +54 -0
- package/tests/skills/vector-search.test.ts +135 -0
- package/tests/skills/weather-api.test.ts +77 -0
- package/tests/skills/web-search-parity.test.ts +59 -0
- package/tests/skills/web-search.test.ts +103 -0
- package/tests/skills/wikipedia.test.ts +63 -0
- package/tsconfig.json +18 -0
- package/vitest.config.ts +9 -0
|
@@ -0,0 +1,619 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* WebService - Static file serving service with HTTP API.
|
|
3
|
+
*
|
|
4
|
+
* Provides configurable static file serving with security features including
|
|
5
|
+
* basic auth, extension filtering, directory browsing, file size limits,
|
|
6
|
+
* CORS, and SSL support. Equivalent to the Python SDK's WebService class.
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
import { Hono } from 'hono';
|
|
10
|
+
import { basicAuth } from 'hono/basic-auth';
|
|
11
|
+
import { cors } from 'hono/cors';
|
|
12
|
+
import { readFile, stat, readdir } from 'node:fs/promises';
|
|
13
|
+
import { join, extname, normalize, resolve, basename } from 'node:path';
|
|
14
|
+
import { existsSync, statSync } from 'node:fs';
|
|
15
|
+
import { getLogger } from './Logger.js';
|
|
16
|
+
import { ConfigLoader } from './ConfigLoader.js';
|
|
17
|
+
import { SslConfig } from './SslConfig.js';
|
|
18
|
+
import type { SslOptions } from './SslConfig.js';
|
|
19
|
+
|
|
20
|
+
/** Common MIME types for static file serving. */
|
|
21
|
+
const MIME_TYPES: Record<string, string> = {
|
|
22
|
+
'.html': 'text/html',
|
|
23
|
+
'.htm': 'text/html',
|
|
24
|
+
'.css': 'text/css',
|
|
25
|
+
'.js': 'application/javascript',
|
|
26
|
+
'.mjs': 'application/javascript',
|
|
27
|
+
'.json': 'application/json',
|
|
28
|
+
'.xml': 'application/xml',
|
|
29
|
+
'.txt': 'text/plain',
|
|
30
|
+
'.md': 'text/markdown',
|
|
31
|
+
'.csv': 'text/csv',
|
|
32
|
+
'.png': 'image/png',
|
|
33
|
+
'.jpg': 'image/jpeg',
|
|
34
|
+
'.jpeg': 'image/jpeg',
|
|
35
|
+
'.gif': 'image/gif',
|
|
36
|
+
'.svg': 'image/svg+xml',
|
|
37
|
+
'.ico': 'image/x-icon',
|
|
38
|
+
'.webp': 'image/webp',
|
|
39
|
+
'.woff': 'font/woff',
|
|
40
|
+
'.woff2': 'font/woff2',
|
|
41
|
+
'.ttf': 'font/ttf',
|
|
42
|
+
'.otf': 'font/otf',
|
|
43
|
+
'.mp3': 'audio/mpeg',
|
|
44
|
+
'.wav': 'audio/wav',
|
|
45
|
+
'.mp4': 'video/mp4',
|
|
46
|
+
'.webm': 'video/webm',
|
|
47
|
+
'.pdf': 'application/pdf',
|
|
48
|
+
'.zip': 'application/zip',
|
|
49
|
+
'.gz': 'application/gzip',
|
|
50
|
+
};
|
|
51
|
+
|
|
52
|
+
/** Configuration options for WebService. */
|
|
53
|
+
export interface WebServiceOptions {
|
|
54
|
+
/** Port to bind to. Default: 8002. */
|
|
55
|
+
port?: number;
|
|
56
|
+
/** Map of URL route prefixes to local directory paths. Default: {}. */
|
|
57
|
+
directories?: Record<string, string>;
|
|
58
|
+
/** Basic auth credentials as [username, password]. Default: none. */
|
|
59
|
+
basicAuth?: [string, string];
|
|
60
|
+
/** Path to a JSON config file. Default: none. */
|
|
61
|
+
configFile?: string;
|
|
62
|
+
/** Serve directory listings and fall back to index.html. Default: false. */
|
|
63
|
+
enableDirectoryBrowsing?: boolean;
|
|
64
|
+
/** Allowlist of file extensions (e.g. ['.html', '.css']). Default: all allowed. */
|
|
65
|
+
allowedExtensions?: string[];
|
|
66
|
+
/**
|
|
67
|
+
* Blocklist of file extensions or names.
|
|
68
|
+
* Default: ['.env', '.git', '.gitignore', '.key', '.pem', '.crt', '.pyc', '__pycache__', '.DS_Store', '.swp']
|
|
69
|
+
*/
|
|
70
|
+
blockedExtensions?: string[];
|
|
71
|
+
/** Maximum file size in bytes. Default: 104857600 (100 MB). */
|
|
72
|
+
maxFileSize?: number;
|
|
73
|
+
/** Enable CORS. Default: true. */
|
|
74
|
+
enableCors?: boolean;
|
|
75
|
+
/** SSL/TLS configuration options. */
|
|
76
|
+
ssl?: SslOptions;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
/** Escapes HTML special characters to prevent XSS in directory listings. */
|
|
80
|
+
function escapeHtml(str: string): string {
|
|
81
|
+
return str
|
|
82
|
+
.replace(/&/g, '&')
|
|
83
|
+
.replace(/</g, '<')
|
|
84
|
+
.replace(/>/g, '>')
|
|
85
|
+
.replace(/"/g, '"')
|
|
86
|
+
.replace(/'/g, ''');
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
/** Format a file size in bytes to a human-readable string. */
|
|
90
|
+
function formatSize(bytes: number): string {
|
|
91
|
+
if (bytes < 1024) return `${bytes} B`;
|
|
92
|
+
if (bytes < 1024 * 1024) return `${(bytes / 1024).toFixed(1)} KB`;
|
|
93
|
+
return `${(bytes / (1024 * 1024)).toFixed(1)} MB`;
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
/**
|
|
97
|
+
* Static file serving service with HTTP API.
|
|
98
|
+
*
|
|
99
|
+
* Provides configurable static file hosting with per-route directory mounting,
|
|
100
|
+
* extension filtering, file size limits, HTTP Basic Auth, CORS, directory
|
|
101
|
+
* browsing, and optional SSL/TLS. Mirrors the Python SDK's WebService class.
|
|
102
|
+
*/
|
|
103
|
+
export class WebService {
|
|
104
|
+
/** Port the service binds to. */
|
|
105
|
+
readonly port: number;
|
|
106
|
+
/** Whether directory listings are enabled. */
|
|
107
|
+
readonly enableDirectoryBrowsing: boolean;
|
|
108
|
+
/** Maximum file size in bytes that will be served. */
|
|
109
|
+
readonly maxFileSize: number;
|
|
110
|
+
/** Whether CORS is enabled. */
|
|
111
|
+
readonly enableCors: boolean;
|
|
112
|
+
/** Allowlist of file extensions, or null to allow all (subject to blocklist). */
|
|
113
|
+
readonly allowedExtensions: string[] | null;
|
|
114
|
+
/** Blocklist of file extensions and file names. */
|
|
115
|
+
readonly blockedExtensions: string[];
|
|
116
|
+
/** Map of URL route prefixes to local directory paths. */
|
|
117
|
+
readonly directories: Record<string, string>;
|
|
118
|
+
|
|
119
|
+
private _app: Hono;
|
|
120
|
+
private _basicAuth: [string, string] | null;
|
|
121
|
+
private _ssl: SslConfig;
|
|
122
|
+
private _server: { close?: () => void } | null = null;
|
|
123
|
+
private readonly log = getLogger('WebService');
|
|
124
|
+
|
|
125
|
+
/** Default blocked extensions and file names (security-sensitive files). */
|
|
126
|
+
private static readonly DEFAULT_BLOCKED = [
|
|
127
|
+
'.env', '.git', '.gitignore', '.key', '.pem', '.crt',
|
|
128
|
+
'.pyc', '__pycache__', '.DS_Store', '.swp',
|
|
129
|
+
];
|
|
130
|
+
|
|
131
|
+
/**
|
|
132
|
+
* Create a WebService.
|
|
133
|
+
* @param options - Configuration options for the service.
|
|
134
|
+
*/
|
|
135
|
+
constructor(options?: WebServiceOptions) {
|
|
136
|
+
// Load configuration from file first (if provided), then override with
|
|
137
|
+
// explicit constructor parameters, mirroring the Python SDK's precedence.
|
|
138
|
+
const fileConfig = this._loadConfig(options?.configFile);
|
|
139
|
+
|
|
140
|
+
this.port = options?.port ?? fileConfig.port ?? 8002;
|
|
141
|
+
this.directories = { ...(fileConfig.directories ?? {}), ...(options?.directories ?? {}) };
|
|
142
|
+
this._basicAuth = options?.basicAuth ?? null;
|
|
143
|
+
this.enableDirectoryBrowsing =
|
|
144
|
+
options?.enableDirectoryBrowsing ?? fileConfig.enableDirectoryBrowsing ?? false;
|
|
145
|
+
this.allowedExtensions =
|
|
146
|
+
options?.allowedExtensions ?? fileConfig.allowedExtensions ?? null;
|
|
147
|
+
this.blockedExtensions =
|
|
148
|
+
options?.blockedExtensions ?? fileConfig.blockedExtensions ?? [...WebService.DEFAULT_BLOCKED];
|
|
149
|
+
this.maxFileSize = options?.maxFileSize ?? fileConfig.maxFileSize ?? 100 * 1024 * 1024;
|
|
150
|
+
this.enableCors = options?.enableCors ?? fileConfig.enableCors ?? true;
|
|
151
|
+
this._ssl = new SslConfig(options?.ssl);
|
|
152
|
+
|
|
153
|
+
this._app = new Hono();
|
|
154
|
+
this._setupMiddleware();
|
|
155
|
+
this._setupRoutes();
|
|
156
|
+
this._mountDirectories();
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
// ── Public API ─────────────────────────────────────────────────────
|
|
160
|
+
|
|
161
|
+
/**
|
|
162
|
+
* Add a new directory to serve at a URL route prefix.
|
|
163
|
+
* @param route - URL prefix (e.g. '/docs').
|
|
164
|
+
* @param directory - Local directory path to serve.
|
|
165
|
+
* @throws If the directory does not exist or is not a directory.
|
|
166
|
+
*/
|
|
167
|
+
addDirectory(route: string, directory: string): void {
|
|
168
|
+
const r = route.startsWith('/') ? route : `/${route}`;
|
|
169
|
+
const dirPath = resolve(directory);
|
|
170
|
+
|
|
171
|
+
if (!existsSync(dirPath)) {
|
|
172
|
+
throw new Error(`Directory does not exist: ${directory}`);
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
if (!statSync(dirPath).isDirectory()) {
|
|
176
|
+
throw new Error(`Path is not a directory: ${directory}`);
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
this.directories[r] = directory;
|
|
180
|
+
this._mountSingleDirectory(r, directory);
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
/**
|
|
184
|
+
* Remove a previously added directory route from the bookkeeping map.
|
|
185
|
+
*
|
|
186
|
+
* Note: Hono does not support dynamic route removal; a server restart
|
|
187
|
+
* is required for the route to fully stop responding.
|
|
188
|
+
* @param route - The URL route prefix to remove.
|
|
189
|
+
*/
|
|
190
|
+
removeDirectory(route: string): void {
|
|
191
|
+
const r = route.startsWith('/') ? route : `/${route}`;
|
|
192
|
+
if (r in this.directories) {
|
|
193
|
+
delete this.directories[r];
|
|
194
|
+
}
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* Get the Hono application for mounting or testing.
|
|
199
|
+
* @returns The configured Hono app.
|
|
200
|
+
*/
|
|
201
|
+
getApp(): Hono {
|
|
202
|
+
return this._app;
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
/**
|
|
206
|
+
* The SSL/TLS configuration for this service.
|
|
207
|
+
*
|
|
208
|
+
* Mirrors the Python SDK's `security` attribute (`SecurityConfig`), which
|
|
209
|
+
* exposes SSL settings for post-construction inspection. In the Python SDK
|
|
210
|
+
* `SecurityConfig` also covers CORS origins, HSTS, allowed hosts, and rate
|
|
211
|
+
* limiting; in this SDK those concerns are configured via their own
|
|
212
|
+
* constructor options (`enableCors`, `ssl`, etc.) and Hono middleware rather
|
|
213
|
+
* than a single combined object.
|
|
214
|
+
*
|
|
215
|
+
* @returns The `SslConfig` instance used by this service.
|
|
216
|
+
*/
|
|
217
|
+
get sslConfig(): SslConfig {
|
|
218
|
+
return this._ssl;
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
/**
|
|
222
|
+
* Start the HTTP(S) service.
|
|
223
|
+
* @param host - Bind address. Default: '0.0.0.0'.
|
|
224
|
+
* @param port - Port override. Default: this.port.
|
|
225
|
+
* @param sslCert - Path to SSL certificate file (overrides SslConfig).
|
|
226
|
+
* @param sslKey - Path to SSL key file (overrides SslConfig).
|
|
227
|
+
*/
|
|
228
|
+
async start(
|
|
229
|
+
host?: string,
|
|
230
|
+
port?: number,
|
|
231
|
+
sslCert?: string,
|
|
232
|
+
sslKey?: string,
|
|
233
|
+
): Promise<void> {
|
|
234
|
+
// When loaded by the CLI tool, skip server startup.
|
|
235
|
+
if (process.env['SWAIG_CLI_MODE'] === 'true') return;
|
|
236
|
+
|
|
237
|
+
const h = host ?? '0.0.0.0';
|
|
238
|
+
const p = port ?? this.port;
|
|
239
|
+
|
|
240
|
+
// Determine SSL configuration
|
|
241
|
+
const effectiveSsl = sslCert && sslKey
|
|
242
|
+
? new SslConfig({ enabled: true, certPath: sslCert, keyPath: sslKey })
|
|
243
|
+
: this._ssl;
|
|
244
|
+
|
|
245
|
+
const useHttps = effectiveSsl.isConfigured();
|
|
246
|
+
const scheme = useHttps ? 'https' : 'http';
|
|
247
|
+
|
|
248
|
+
this.log.info(`WebService starting on ${scheme}://${h}:${p}`);
|
|
249
|
+
this.log.info(`Directories: ${Object.keys(this.directories).join(', ') || 'None'}`);
|
|
250
|
+
this.log.info(`Directory Browsing: ${this.enableDirectoryBrowsing ? 'Enabled' : 'Disabled'}`);
|
|
251
|
+
this.log.info(`Basic Auth: ${this._basicAuth ? 'Enabled' : 'Disabled'}`);
|
|
252
|
+
if (useHttps) {
|
|
253
|
+
this.log.info('SSL: Enabled');
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
const { serve } = await import('@hono/node-server');
|
|
257
|
+
|
|
258
|
+
if (useHttps) {
|
|
259
|
+
const serverOpts = effectiveSsl.getServerOptions();
|
|
260
|
+
if (serverOpts) {
|
|
261
|
+
const https = await import('node:https');
|
|
262
|
+
const server = serve({
|
|
263
|
+
fetch: this._app.fetch,
|
|
264
|
+
port: p,
|
|
265
|
+
hostname: h,
|
|
266
|
+
createServer: https.createServer,
|
|
267
|
+
serverOptions: serverOpts,
|
|
268
|
+
});
|
|
269
|
+
this._server = server as unknown as { close?: () => void };
|
|
270
|
+
}
|
|
271
|
+
} else {
|
|
272
|
+
const server = serve({ fetch: this._app.fetch, port: p, hostname: h });
|
|
273
|
+
this._server = server as unknown as { close?: () => void };
|
|
274
|
+
}
|
|
275
|
+
}
|
|
276
|
+
|
|
277
|
+
/**
|
|
278
|
+
* Stop the service and release resources.
|
|
279
|
+
*/
|
|
280
|
+
stop(): void {
|
|
281
|
+
if (this._server && typeof this._server.close === 'function') {
|
|
282
|
+
this._server.close();
|
|
283
|
+
this._server = null;
|
|
284
|
+
this.log.info('WebService stopped');
|
|
285
|
+
}
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
// ── Config loading ─────────────────────────────────────────────────
|
|
289
|
+
|
|
290
|
+
/** Intermediate config shape returned by the file loader. */
|
|
291
|
+
private _loadConfig(configFile?: string): {
|
|
292
|
+
port?: number;
|
|
293
|
+
directories?: Record<string, string>;
|
|
294
|
+
enableDirectoryBrowsing?: boolean;
|
|
295
|
+
allowedExtensions?: string[] | null;
|
|
296
|
+
blockedExtensions?: string[];
|
|
297
|
+
maxFileSize?: number;
|
|
298
|
+
enableCors?: boolean;
|
|
299
|
+
} {
|
|
300
|
+
const result: ReturnType<WebService['_loadConfig']> = {};
|
|
301
|
+
|
|
302
|
+
if (!configFile) {
|
|
303
|
+
// Search standard locations for a web-service config
|
|
304
|
+
const loader = ConfigLoader.search('web_service.json');
|
|
305
|
+
if (!loader) return result;
|
|
306
|
+
return this._extractServiceConfig(loader);
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
try {
|
|
310
|
+
const loader = new ConfigLoader(configFile);
|
|
311
|
+
return this._extractServiceConfig(loader);
|
|
312
|
+
} catch {
|
|
313
|
+
this.log.warn(`Failed to load config file: ${configFile}`);
|
|
314
|
+
return result;
|
|
315
|
+
}
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
private _extractServiceConfig(loader: ConfigLoader): ReturnType<WebService['_loadConfig']> {
|
|
319
|
+
const result: ReturnType<WebService['_loadConfig']> = {};
|
|
320
|
+
|
|
321
|
+
const port = loader.get<number>('service.port');
|
|
322
|
+
if (port !== undefined) result.port = Number(port);
|
|
323
|
+
|
|
324
|
+
const dirs = loader.get<Record<string, string>>('service.directories');
|
|
325
|
+
if (dirs && typeof dirs === 'object') result.directories = dirs;
|
|
326
|
+
|
|
327
|
+
const browsing = loader.get<boolean>('service.enableDirectoryBrowsing');
|
|
328
|
+
if (browsing !== undefined) result.enableDirectoryBrowsing = Boolean(browsing);
|
|
329
|
+
|
|
330
|
+
const maxSize = loader.get<number>('service.maxFileSize');
|
|
331
|
+
if (maxSize !== undefined) result.maxFileSize = Number(maxSize);
|
|
332
|
+
|
|
333
|
+
const allowed = loader.get<string[]>('service.allowedExtensions');
|
|
334
|
+
if (Array.isArray(allowed)) result.allowedExtensions = allowed;
|
|
335
|
+
|
|
336
|
+
const blocked = loader.get<string[]>('service.blockedExtensions');
|
|
337
|
+
if (Array.isArray(blocked)) result.blockedExtensions = blocked;
|
|
338
|
+
|
|
339
|
+
const corsEnabled = loader.get<boolean>('service.enableCors');
|
|
340
|
+
if (corsEnabled !== undefined) result.enableCors = Boolean(corsEnabled);
|
|
341
|
+
|
|
342
|
+
return result;
|
|
343
|
+
}
|
|
344
|
+
|
|
345
|
+
// ── Middleware setup ────────────────────────────────────────────────
|
|
346
|
+
|
|
347
|
+
private _setupMiddleware(): void {
|
|
348
|
+
// Security headers (same set as AgentServer and SWMLService)
|
|
349
|
+
this._app.use('*', async (c, next) => {
|
|
350
|
+
await next();
|
|
351
|
+
c.res.headers.set('X-Content-Type-Options', 'nosniff');
|
|
352
|
+
c.res.headers.set('X-Frame-Options', 'DENY');
|
|
353
|
+
c.res.headers.set('X-XSS-Protection', '1; mode=block');
|
|
354
|
+
c.res.headers.set('Referrer-Policy', 'strict-origin-when-cross-origin');
|
|
355
|
+
c.res.headers.set('Content-Security-Policy', "default-src 'none'; frame-ancestors 'none'");
|
|
356
|
+
c.res.headers.set('Permissions-Policy', 'camera=(), microphone=(), geolocation=()');
|
|
357
|
+
});
|
|
358
|
+
|
|
359
|
+
// CORS
|
|
360
|
+
if (this.enableCors) {
|
|
361
|
+
const corsOrigins = process.env['SWML_CORS_ORIGINS'];
|
|
362
|
+
const corsOrigin = corsOrigins ? corsOrigins.split(',').map((o: string) => o.trim()) : '*';
|
|
363
|
+
const corsCredentials = corsOrigin !== '*';
|
|
364
|
+
this._app.use('*', cors({ origin: corsOrigin, credentials: corsCredentials }));
|
|
365
|
+
}
|
|
366
|
+
|
|
367
|
+
// SSL HSTS middleware
|
|
368
|
+
if (this._ssl.isConfigured()) {
|
|
369
|
+
this._app.use('*', this._ssl.hstsMiddleware());
|
|
370
|
+
}
|
|
371
|
+
|
|
372
|
+
// Basic auth (applied to all routes if configured)
|
|
373
|
+
if (this._basicAuth) {
|
|
374
|
+
const [user, pass] = this._basicAuth;
|
|
375
|
+
this._app.use('*', basicAuth({ username: user, password: pass }));
|
|
376
|
+
}
|
|
377
|
+
}
|
|
378
|
+
|
|
379
|
+
// ── Route setup ────────────────────────────────────────────────────
|
|
380
|
+
|
|
381
|
+
private _setupRoutes(): void {
|
|
382
|
+
// Health endpoint
|
|
383
|
+
this._app.get('/health', (c) =>
|
|
384
|
+
c.json({
|
|
385
|
+
status: 'healthy',
|
|
386
|
+
directories: Object.keys(this.directories),
|
|
387
|
+
sslEnabled: this._ssl.isConfigured(),
|
|
388
|
+
authRequired: Boolean(this._basicAuth),
|
|
389
|
+
directoryBrowsing: this.enableDirectoryBrowsing,
|
|
390
|
+
}),
|
|
391
|
+
);
|
|
392
|
+
|
|
393
|
+
// Root endpoint showing available directories
|
|
394
|
+
this._app.get('/', (c) => {
|
|
395
|
+
const dirEntries = Object.entries(this.directories);
|
|
396
|
+
|
|
397
|
+
if (dirEntries.length === 0) {
|
|
398
|
+
return c.json({
|
|
399
|
+
service: 'SignalWire Web Service',
|
|
400
|
+
directories: [],
|
|
401
|
+
});
|
|
402
|
+
}
|
|
403
|
+
|
|
404
|
+
const items = dirEntries
|
|
405
|
+
.map(
|
|
406
|
+
([route, localPath]) =>
|
|
407
|
+
`<li><a href="${escapeHtml(route)}">${escapeHtml(route)}</a>` +
|
|
408
|
+
` <span class="path">→ ${escapeHtml(localPath)}</span></li>`,
|
|
409
|
+
)
|
|
410
|
+
.join('\n');
|
|
411
|
+
|
|
412
|
+
const html = `<!DOCTYPE html>
|
|
413
|
+
<html>
|
|
414
|
+
<head>
|
|
415
|
+
<title>SignalWire Web Service</title>
|
|
416
|
+
<style>
|
|
417
|
+
body { font-family: sans-serif; margin: 40px; }
|
|
418
|
+
h1 { color: #333; }
|
|
419
|
+
ul { list-style: none; padding: 0; }
|
|
420
|
+
li { padding: 10px 0; }
|
|
421
|
+
a { text-decoration: none; color: #0066cc; font-size: 18px; }
|
|
422
|
+
a:hover { text-decoration: underline; }
|
|
423
|
+
.path { color: #666; font-size: 14px; }
|
|
424
|
+
</style>
|
|
425
|
+
</head>
|
|
426
|
+
<body>
|
|
427
|
+
<h1>SignalWire Web Service</h1>
|
|
428
|
+
<h2>Available Directories:</h2>
|
|
429
|
+
<ul>
|
|
430
|
+
${items}
|
|
431
|
+
</ul>
|
|
432
|
+
</body>
|
|
433
|
+
</html>`;
|
|
434
|
+
c.header('Content-Type', 'text/html');
|
|
435
|
+
return c.body(html);
|
|
436
|
+
});
|
|
437
|
+
}
|
|
438
|
+
|
|
439
|
+
// ── Directory mounting ─────────────────────────────────────────────
|
|
440
|
+
|
|
441
|
+
private _mountDirectories(): void {
|
|
442
|
+
for (const [route, dir] of Object.entries(this.directories)) {
|
|
443
|
+
const dirPath = resolve(dir);
|
|
444
|
+
if (!existsSync(dirPath)) {
|
|
445
|
+
this.log.warn(`Directory does not exist: ${dir}`);
|
|
446
|
+
continue;
|
|
447
|
+
}
|
|
448
|
+
this._mountSingleDirectory(route, dir);
|
|
449
|
+
}
|
|
450
|
+
}
|
|
451
|
+
|
|
452
|
+
private _mountSingleDirectory(route: string, directory: string): void {
|
|
453
|
+
const baseDir = resolve(directory);
|
|
454
|
+
const routePrefix = route.replace(/\/+$/, '') || '/';
|
|
455
|
+
|
|
456
|
+
this._app.get(`${routePrefix}/*`, async (c) => {
|
|
457
|
+
const requestedPath = c.req.path.slice(routePrefix.length);
|
|
458
|
+
|
|
459
|
+
// Path traversal protection: reject any path containing ".."
|
|
460
|
+
if (requestedPath.includes('..')) {
|
|
461
|
+
return c.json({ error: 'Forbidden' }, 403);
|
|
462
|
+
}
|
|
463
|
+
|
|
464
|
+
const normalizedPath = normalize(requestedPath);
|
|
465
|
+
const fullPath = resolve(join(baseDir, normalizedPath));
|
|
466
|
+
|
|
467
|
+
// Double-check the resolved path is within the base directory
|
|
468
|
+
if (!fullPath.startsWith(baseDir)) {
|
|
469
|
+
return c.json({ error: 'Forbidden' }, 403);
|
|
470
|
+
}
|
|
471
|
+
|
|
472
|
+
try {
|
|
473
|
+
const fileStat = await stat(fullPath);
|
|
474
|
+
|
|
475
|
+
// Handle directory requests
|
|
476
|
+
if (fileStat.isDirectory()) {
|
|
477
|
+
if (!this.enableDirectoryBrowsing) {
|
|
478
|
+
// Try index.html fallback
|
|
479
|
+
const indexPath = join(fullPath, 'index.html');
|
|
480
|
+
try {
|
|
481
|
+
const idxStat = await stat(indexPath);
|
|
482
|
+
if (idxStat.isFile() && this._isFileAllowed(indexPath, idxStat.size)) {
|
|
483
|
+
return this._serveFile(c, indexPath);
|
|
484
|
+
}
|
|
485
|
+
} catch {
|
|
486
|
+
// No index.html found
|
|
487
|
+
}
|
|
488
|
+
return c.json({ error: 'Directory browsing disabled' }, 403);
|
|
489
|
+
}
|
|
490
|
+
return this._serveDirectoryListing(c, fullPath, c.req.path);
|
|
491
|
+
}
|
|
492
|
+
|
|
493
|
+
// Regular file
|
|
494
|
+
if (!fileStat.isFile()) {
|
|
495
|
+
return c.json({ error: 'Not found' }, 404);
|
|
496
|
+
}
|
|
497
|
+
|
|
498
|
+
if (!this._isFileAllowed(fullPath, fileStat.size)) {
|
|
499
|
+
return c.json({ error: 'File type not allowed' }, 403);
|
|
500
|
+
}
|
|
501
|
+
|
|
502
|
+
return this._serveFile(c, fullPath);
|
|
503
|
+
} catch {
|
|
504
|
+
return c.json({ error: 'Not found' }, 404);
|
|
505
|
+
}
|
|
506
|
+
});
|
|
507
|
+
|
|
508
|
+
this.log.info(`Serving static files from ${baseDir} at ${routePrefix}/*`);
|
|
509
|
+
}
|
|
510
|
+
|
|
511
|
+
// ── File checks ────────────────────────────────────────────────────
|
|
512
|
+
|
|
513
|
+
private _isFileAllowed(fullPath: string, size: number): boolean {
|
|
514
|
+
// Check file size
|
|
515
|
+
if (size > this.maxFileSize) return false;
|
|
516
|
+
|
|
517
|
+
const ext = extname(fullPath).toLowerCase();
|
|
518
|
+
const name = basename(fullPath);
|
|
519
|
+
|
|
520
|
+
// Check blocked extensions and names
|
|
521
|
+
for (const blocked of this.blockedExtensions) {
|
|
522
|
+
if (blocked.startsWith('.')) {
|
|
523
|
+
// Check both as extension and as full name (for files like .env, .gitignore)
|
|
524
|
+
if (ext === blocked || name === blocked) return false;
|
|
525
|
+
} else {
|
|
526
|
+
// Check as a file name or as a substring of the path
|
|
527
|
+
if (name === blocked || fullPath.includes(blocked)) return false;
|
|
528
|
+
}
|
|
529
|
+
}
|
|
530
|
+
|
|
531
|
+
// If allowedExtensions is set, only allow those
|
|
532
|
+
if (this.allowedExtensions && !this.allowedExtensions.includes(ext)) return false;
|
|
533
|
+
|
|
534
|
+
return true;
|
|
535
|
+
}
|
|
536
|
+
|
|
537
|
+
// ── File serving ───────────────────────────────────────────────────
|
|
538
|
+
|
|
539
|
+
private async _serveFile(c: any, fullPath: string): Promise<Response> {
|
|
540
|
+
const content = await readFile(fullPath);
|
|
541
|
+
const ext = extname(fullPath).toLowerCase();
|
|
542
|
+
const contentType = MIME_TYPES[ext] ?? 'application/octet-stream';
|
|
543
|
+
|
|
544
|
+
c.header('Content-Type', contentType);
|
|
545
|
+
c.header('Cache-Control', 'public, max-age=3600');
|
|
546
|
+
c.header('X-Content-Type-Options', 'nosniff');
|
|
547
|
+
|
|
548
|
+
return c.body(content);
|
|
549
|
+
}
|
|
550
|
+
|
|
551
|
+
// ── Directory listing ──────────────────────────────────────────────
|
|
552
|
+
|
|
553
|
+
private async _serveDirectoryListing(
|
|
554
|
+
c: any,
|
|
555
|
+
dirPath: string,
|
|
556
|
+
urlPath: string,
|
|
557
|
+
): Promise<Response> {
|
|
558
|
+
const entries = await readdir(dirPath, { withFileTypes: true });
|
|
559
|
+
|
|
560
|
+
// Sort entries alphabetically
|
|
561
|
+
const sorted = entries
|
|
562
|
+
.filter((e) => !e.name.startsWith('.'))
|
|
563
|
+
.sort((a, b) => a.name.localeCompare(b.name));
|
|
564
|
+
|
|
565
|
+
const items: string[] = [];
|
|
566
|
+
|
|
567
|
+
// Add parent directory link if not at root
|
|
568
|
+
if (urlPath !== '/') {
|
|
569
|
+
items.push('<li><a href="../">../</a></li>');
|
|
570
|
+
}
|
|
571
|
+
|
|
572
|
+
// List directories first, then files (matching Python SDK behavior)
|
|
573
|
+
for (const entry of sorted) {
|
|
574
|
+
if (entry.isDirectory()) {
|
|
575
|
+
const safeName = escapeHtml(entry.name);
|
|
576
|
+
items.push(`<li><a href="${safeName}/">${safeName}/</a></li>`);
|
|
577
|
+
}
|
|
578
|
+
}
|
|
579
|
+
|
|
580
|
+
for (const entry of sorted) {
|
|
581
|
+
if (entry.isFile()) {
|
|
582
|
+
const entryPath = join(dirPath, entry.name);
|
|
583
|
+
try {
|
|
584
|
+
const entryStat = await stat(entryPath);
|
|
585
|
+
if (this._isFileAllowed(entryPath, entryStat.size)) {
|
|
586
|
+
const safeName = escapeHtml(entry.name);
|
|
587
|
+
const sizeStr = formatSize(entryStat.size);
|
|
588
|
+
items.push(`<li><a href="${safeName}">${safeName}</a> (${sizeStr})</li>`);
|
|
589
|
+
}
|
|
590
|
+
} catch {
|
|
591
|
+
// Skip files we can't stat
|
|
592
|
+
}
|
|
593
|
+
}
|
|
594
|
+
}
|
|
595
|
+
|
|
596
|
+
const html = `<!DOCTYPE html>
|
|
597
|
+
<html>
|
|
598
|
+
<head>
|
|
599
|
+
<title>Directory listing for ${escapeHtml(urlPath)}</title>
|
|
600
|
+
<style>
|
|
601
|
+
body { font-family: sans-serif; margin: 40px; }
|
|
602
|
+
h1 { color: #333; }
|
|
603
|
+
ul { list-style: none; padding: 0; }
|
|
604
|
+
li { padding: 5px 0; }
|
|
605
|
+
a { text-decoration: none; color: #0066cc; }
|
|
606
|
+
a:hover { text-decoration: underline; }
|
|
607
|
+
</style>
|
|
608
|
+
</head>
|
|
609
|
+
<body>
|
|
610
|
+
<h1>Directory listing for ${escapeHtml(urlPath)}</h1>
|
|
611
|
+
<ul>
|
|
612
|
+
${items.join('\n ')}
|
|
613
|
+
</ul>
|
|
614
|
+
</body>
|
|
615
|
+
</html>`;
|
|
616
|
+
c.header('Content-Type', 'text/html');
|
|
617
|
+
return c.body(html);
|
|
618
|
+
}
|
|
619
|
+
}
|