openclaw/plugin-sdk/ के अंतर्गत संकीर्ण सार्वजनिक उप-पथों के सेट के रूप में
उजागर किया गया है। यह पृष्ठ उद्देश्य के अनुसार समूहित आम तौर पर उपयोग किए जाने वाले उप-पथों को सूचीबद्ध करता है।
जनरेट की गई compiler entrypoint inventory
scripts/lib/plugin-sdk-entrypoints.json में रहती है; package exports वे सार्वजनिक subset हैं
जो scripts/lib/plugin-sdk-private-local-only-subpaths.json में सूचीबद्ध repo-local test/internal
उप-पथों को घटाने के बाद बचते हैं। मेंटेनर सार्वजनिक export count को pnpm plugin-sdk:surface से
और सक्रिय reserved helper subpaths को pnpm plugins:boundary-report:summary से audit कर सकते हैं;
unused reserved helper exports सार्वजनिक SDK में dormant compatibility debt के रूप में रहने के बजाय
CI report को fail कर देते हैं।
Plugin authoring guide के लिए, Plugin SDK overview देखें।
Plugin entry
| Subpath | मुख्य exports |
|---|---|
plugin-sdk/plugin-entry | definePluginEntry |
plugin-sdk/core | defineChannelPluginEntry, createChatChannelPlugin, createChannelPluginBase, defineSetupPluginEntry, buildChannelConfigSchema, buildJsonChannelConfigSchema |
plugin-sdk/config-schema | OpenClawSchema |
plugin-sdk/provider-entry | defineSingleProviderPluginEntry |
plugin-sdk/migration | Migration provider item helpers जैसे createMigrationItem, reason constants, item status markers, redaction helpers, और summarizeMigrationItems |
plugin-sdk/migration-runtime | Runtime migration helpers जैसे copyMigrationFileItem, withCachedMigrationConfigRuntime, और writeMigrationReport |
plugin-sdk/health | Bundled health consumers के लिए Doctor health-check registration, detection, repair, selection, severity, और finding types |
Deprecated compatibility और test helpers
Deprecated उप-पथ पुराने plugins के लिए exported रहते हैं, लेकिन नए code को नीचे दिए गए focused SDK subpaths का उपयोग करना चाहिए। Maintained listscripts/lib/plugin-sdk-deprecated-public-subpaths.json है; CI इससे bundled
production imports को reject करता है। compat, config-types,
infra-runtime, text-runtime, और zod जैसे broad barrels केवल compatibility के लिए हैं। zod को
सीधे zod से import करें।
OpenClaw के Vitest-backed test-helper subpaths केवल repo-local हैं और अब
package exports नहीं हैं: agent-runtime-test-contracts,
channel-contract-testing, channel-target-testing, channel-test-helpers,
plugin-test-api, plugin-test-contracts, plugin-test-runtime,
provider-http-test-mocks, provider-test-contracts, test-env,
test-fixtures, test-node-mocks, और testing।
Reserved bundled plugin helper subpaths
ये subpaths अपने owning bundled Plugin के लिए plugin-owned compatibility surfaces हैं, general SDK APIs नहीं:plugin-sdk/codex-mcp-projection और
plugin-sdk/codex-native-task-runtime। Cross-owner extension imports को
package contract guardrails द्वारा blocked किया जाता है।
चैनल उपपथ
चैनल उपपथ
channel-inbound और channel-outbound पर रखना, फिर अगले major SDK cleanup में compatibility subpaths को हटाना। यह पुराने channel message/runtime, channel streaming, direct-DM access, inbound helper splinter, reply-options, और pairing-path families पर लागू होता है।प्रदाता उपपथ
प्रदाता उपपथ
windows रिपोर्ट करते हैं, जिनमें प्रत्येक में
एक label, percent used, और वैकल्पिक reset time होता है। वे प्रदाता जो resettable quota windows के बजाय balance या
account-state text प्रदर्शित करते हैं, उन्हें percentages गढ़ने के बजाय
खाली windows array के साथ summary लौटाना चाहिए।
OpenClaw उस summary text को status output में दिखाता है; error का उपयोग केवल तब करें जब
usage endpoint विफल हो गया हो या उसने कोई उपयोगी usage data न लौटाया हो।Auth और सुरक्षा उपपथ
Auth और सुरक्षा उपपथ
| उपपथ | मुख्य निर्यात |
|---|---|
plugin-sdk/command-auth | resolveControlCommandGate, command registry सहायक जिनमें dynamic argument menu formatting, sender-authorization सहायक शामिल हैं |
plugin-sdk/command-status | buildCommandsMessagePaginated और buildHelpMessage जैसे command/help message बिल्डर |
plugin-sdk/approval-auth-runtime | Approver resolution और same-chat action-auth सहायक |
plugin-sdk/approval-client-runtime | Native exec approval profile/filter सहायक |
plugin-sdk/approval-delivery-runtime | Native approval capability/delivery adapters |
plugin-sdk/approval-gateway-runtime | साझा approval gateway-resolution सहायक |
plugin-sdk/approval-handler-adapter-runtime | hot channel entrypoints के लिए हल्के native approval adapter loading सहायक |
plugin-sdk/approval-handler-runtime | व्यापक approval handler रनटाइम सहायक; जब संकीर्ण adapter/gateway seams पर्याप्त हों तो उन्हें प्राथमिकता दें |
plugin-sdk/approval-native-runtime | Native approval target, account-binding, route-gate, forwarding fallback, और local native exec prompt suppression सहायक |
plugin-sdk/approval-reaction-runtime | Hardcoded approval reaction bindings, reaction prompt payloads, reaction target stores, और local native exec prompt suppression के लिए compatibility निर्यात |
plugin-sdk/approval-reply-runtime | Exec/plugin approval reply payload सहायक |
plugin-sdk/approval-runtime | Exec/plugin approval payload सहायक, native approval routing/runtime सहायक, और formatApprovalDisplayPath जैसे structured approval display सहायक |
plugin-sdk/reply-dedupe | संकीर्ण inbound reply dedupe reset सहायक |
plugin-sdk/channel-contract-testing | व्यापक testing barrel के बिना संकीर्ण channel contract test सहायक |
plugin-sdk/command-auth-native | Native command auth, dynamic argument menu formatting, और native session-target सहायक |
plugin-sdk/command-detection | साझा command detection सहायक |
plugin-sdk/command-primitives-runtime | hot channel paths के लिए हल्के command text predicates |
plugin-sdk/command-surface | Command-body normalization और command-surface सहायक |
plugin-sdk/allow-from | formatAllowFromLowercase |
plugin-sdk/channel-secret-runtime | channel/plugin secret surfaces के लिए संकीर्ण secret-contract collection सहायक |
plugin-sdk/secret-ref-runtime | secret-contract/config parsing के लिए संकीर्ण coerceSecretRef और SecretRef typing सहायक |
plugin-sdk/secret-provider-integration | बाहरी secret provider presets प्रकाशित करने वाले plugins के लिए type-only SecretRef provider integration manifest और preset कॉन्ट्रैक्ट |
plugin-sdk/security-runtime | साझा trust, DM gating, root-bounded file/path सहायक जिनमें create-only writes, sync/async atomic file replacement, sibling temp writes, cross-device move fallback, private file-store सहायक, symlink-parent guards, external-content, sensitive text redaction, constant-time secret comparison, और secret-collection सहायक शामिल हैं |
plugin-sdk/ssrf-policy | Host allowlist और private-network SSRF policy सहायक |
plugin-sdk/ssrf-dispatcher | व्यापक infra runtime surface के बिना संकीर्ण pinned-dispatcher सहायक |
plugin-sdk/ssrf-runtime | Pinned-dispatcher, SSRF-guarded fetch, SSRF error, और SSRF policy सहायक |
plugin-sdk/secret-input | Secret input parsing सहायक |
plugin-sdk/webhook-ingress | Webhook request/target सहायक और raw websocket/body coercion |
plugin-sdk/webhook-request-guards | Request body size/timeout सहायक |
रनटाइम और स्टोरेज उपपथ
रनटाइम और स्टोरेज उपपथ
क्षमता और परीक्षण उपपथ
क्षमता और परीक्षण उपपथ
| उपपथ | मुख्य निर्यात |
|---|---|
plugin-sdk/media-runtime | साझा मीडिया फ़ेच/रूपांतरण/स्टोर सहायक, जिनमें saveRemoteMedia, saveResponseMedia, readRemoteMediaBuffer, और अप्रचलित fetchRemoteMedia शामिल हैं; जब किसी URL को OpenClaw मीडिया बनना हो, तो बफ़र पढ़ने से पहले स्टोर सहायकों को प्राथमिकता दें |
plugin-sdk/media-mime | संकीर्ण MIME सामान्यीकरण, फ़ाइल-एक्सटेंशन मैपिंग, MIME पहचान, और मीडिया-प्रकार सहायक |
plugin-sdk/media-store | संकीर्ण मीडिया स्टोर सहायक जैसे saveMediaBuffer और saveMediaStream |
plugin-sdk/media-generation-runtime | साझा मीडिया-जनरेशन फ़ेलओवर सहायक, उम्मीदवार चयन, और अनुपस्थित-मॉडल संदेश |
plugin-sdk/media-understanding | मीडिया समझ प्रदाता प्रकार और प्रदाता-सामने image/audio/structured-extraction सहायक निर्यात |
plugin-sdk/text-chunking | टेक्स्ट और markdown चंकिंग/रेंडर सहायक, markdown तालिका रूपांतरण, directive-tag हटाना, और सुरक्षित-टेक्स्ट उपयोगिताएँ |
plugin-sdk/text-chunking | आउटबाउंड टेक्स्ट चंकिंग सहायक |
plugin-sdk/speech | स्पीच प्रदाता प्रकार और प्रदाता-सामने directive, registry, validation, OpenAI-संगत TTS builder, और स्पीच सहायक निर्यात |
plugin-sdk/speech-core | साझा स्पीच प्रदाता प्रकार, registry, directive, normalization, और स्पीच सहायक निर्यात |
plugin-sdk/realtime-transcription | रियलटाइम ट्रांसक्रिप्शन प्रदाता प्रकार, registry सहायक, और साझा WebSocket सेशन सहायक |
plugin-sdk/realtime-bootstrap-context | सीमित IDENTITY.md, USER.md, और SOUL.md संदर्भ इंजेक्शन के लिए रियलटाइम प्रोफ़ाइल बूटस्ट्रैप सहायक |
plugin-sdk/realtime-voice | रियलटाइम वॉइस प्रदाता प्रकार, registry सहायक, और साझा रियलटाइम वॉइस व्यवहार सहायक, जिनमें आउटपुट गतिविधि ट्रैकिंग शामिल है |
plugin-sdk/image-generation | इमेज जनरेशन प्रदाता प्रकार और इमेज एसेट/data URL सहायक, तथा OpenAI-संगत इमेज प्रदाता builder |
plugin-sdk/image-generation-core | साझा इमेज-जनरेशन प्रकार, फ़ेलओवर, auth, और registry सहायक |
plugin-sdk/music-generation | संगीत जनरेशन प्रदाता/अनुरोध/परिणाम प्रकार |
plugin-sdk/music-generation-core | साझा संगीत-जनरेशन प्रकार, फ़ेलओवर सहायक, प्रदाता lookup, और model-ref parsing |
plugin-sdk/video-generation | वीडियो जनरेशन प्रदाता/अनुरोध/परिणाम प्रकार |
plugin-sdk/video-generation-core | साझा वीडियो-जनरेशन प्रकार, फ़ेलओवर सहायक, प्रदाता lookup, और model-ref parsing |
plugin-sdk/transcripts | साझा ट्रांसक्रिप्ट स्रोत प्रदाता प्रकार, registry सहायक, सेशन descriptors, और utterance metadata |
plugin-sdk/webhook-targets | Webhook लक्ष्य registry और route-install सहायक |
plugin-sdk/webhook-path | अप्रचलित संगतता alias; plugin-sdk/webhook-ingress का उपयोग करें |
plugin-sdk/web-media | साझा remote/local मीडिया लोडिंग सहायक |
plugin-sdk/zod | अप्रचलित संगतता re-export; zod को सीधे zod से import करें |
plugin-sdk/testing | विरासत OpenClaw परीक्षणों के लिए रेपो-स्थानीय अप्रचलित संगतता barrel। नए रेपो परीक्षणों को इसके बजाय केंद्रित स्थानीय परीक्षण उपपथों जैसे plugin-sdk/agent-runtime-test-contracts, plugin-sdk/plugin-test-runtime, plugin-sdk/channel-test-helpers, plugin-sdk/test-env, या plugin-sdk/test-fixtures से import करना चाहिए |
plugin-sdk/plugin-test-api | रेपो परीक्षण सहायक bridges import किए बिना सीधे Plugin पंजीकरण unit tests के लिए रेपो-स्थानीय न्यूनतम createTestPluginApi सहायक |
plugin-sdk/agent-runtime-test-contracts | auth, delivery, fallback, tool-hook, prompt-overlay, schema, और transcript projection परीक्षणों के लिए रेपो-स्थानीय native agent-runtime adapter contract fixtures |
plugin-sdk/channel-test-helpers | generic actions/setup/status contracts, directory assertions, account startup lifecycle, send-config threading, runtime mocks, status issues, outbound delivery, और hook registration के लिए रेपो-स्थानीय channel-oriented test helpers |
plugin-sdk/channel-target-testing | channel परीक्षणों के लिए रेपो-स्थानीय साझा target-resolution error-case suite |
plugin-sdk/plugin-test-contracts | रेपो-स्थानीय Plugin package, registration, public artifact, direct import, runtime API, और import side-effect contract helpers |
plugin-sdk/provider-test-contracts | रेपो-स्थानीय provider runtime, auth, discovery, onboard, catalog, wizard, media capability, replay policy, realtime STT live-audio, web-search/fetch, और stream contract helpers |
plugin-sdk/provider-http-test-mocks | plugin-sdk/provider-http का अभ्यास करने वाले प्रदाता परीक्षणों के लिए रेपो-स्थानीय opt-in Vitest HTTP/auth mocks |
plugin-sdk/test-fixtures | रेपो-स्थानीय generic CLI runtime capture, sandbox context, skill writer, agent-message, system-event, module reload, bundled plugin path, terminal-text, chunking, auth-token, और typed-case fixtures |
plugin-sdk/test-node-mocks | Vitest vi.mock("node:*") factories के भीतर उपयोग के लिए रेपो-स्थानीय केंद्रित Node builtin mock helpers |
Memory उपपथ
Memory उपपथ
| उपपथ | मुख्य निर्यात |
|---|---|
plugin-sdk/memory-core | manager/config/file/CLI सहायकों के लिए bundled memory-core helper surface |
plugin-sdk/memory-core-engine-runtime | Memory index/search runtime facade |
plugin-sdk/memory-core-host-embedding-registry | हल्के memory embedding provider registry helpers |
plugin-sdk/memory-core-host-engine-foundation | Memory host foundation engine exports |
plugin-sdk/memory-core-host-engine-embeddings | Memory host embedding contracts, registry access, local provider, और generic batch/remote helpers। इस surface पर registerMemoryEmbeddingProvider अप्रचलित है; नए प्रदाताओं के लिए generic embedding provider API का उपयोग करें। |
plugin-sdk/memory-core-host-engine-qmd | Memory host QMD engine exports |
plugin-sdk/memory-core-host-engine-storage | Memory host storage engine exports |
plugin-sdk/memory-core-host-multimodal | Memory host multimodal helpers |
plugin-sdk/memory-core-host-query | Memory host query helpers |
plugin-sdk/memory-core-host-secret | Memory host secret helpers |
plugin-sdk/memory-core-host-events | अप्रचलित संगतता alias; plugin-sdk/memory-host-events का उपयोग करें |
plugin-sdk/memory-core-host-status | Memory host status helpers |
plugin-sdk/memory-core-host-runtime-cli | Memory host CLI runtime helpers |
plugin-sdk/memory-core-host-runtime-core | Memory host core runtime helpers |
plugin-sdk/memory-core-host-runtime-files | Memory host file/runtime helpers |
plugin-sdk/memory-host-core | Memory host core runtime helpers के लिए vendor-neutral alias |
plugin-sdk/memory-host-events | Memory host event journal helpers के लिए vendor-neutral alias |
plugin-sdk/memory-host-files | अप्रचलित संगतता alias; plugin-sdk/memory-core-host-runtime-files का उपयोग करें |
plugin-sdk/memory-host-markdown | memory-adjacent plugins के लिए साझा managed-markdown helpers |
plugin-sdk/memory-host-search | search-manager access के लिए active memory runtime facade |
plugin-sdk/memory-host-status | अप्रचलित संगतता alias; plugin-sdk/memory-core-host-status का उपयोग करें |
आरक्षित bundled-helper उपपथ
आरक्षित bundled-helper उपपथ
आरक्षित bundled-helper SDK उपपथ bundled Plugin कोड के लिए संकीर्ण owner-specific surfaces हैं। उन्हें SDK inventory में track किया जाता है ताकि package builds और aliasing deterministic रहें, लेकिन वे सामान्य Plugin authoring APIs नहीं हैं। नए पुन: उपयोग योग्य host contracts को generic SDK उपपथों जैसे
plugin-sdk/gateway-runtime, plugin-sdk/security-runtime, और plugin-sdk/plugin-config-runtime का उपयोग करना चाहिए।| उपपथ | स्वामी और उद्देश्य |
|---|---|
plugin-sdk/codex-mcp-projection | user MCP server config को Codex app-server thread config में project करने के लिए bundled Codex Plugin helper |
plugin-sdk/codex-native-task-runtime | Codex app-server native subagents को OpenClaw task state में mirror करने के लिए bundled Codex Plugin helper |