{"_id":"@boringos/connector","_rev":"6-5059926ec01c63511cfae10c84ab4d16","name":"@boringos/connector","dist-tags":{"latest":"0.1.8"},"versions":{"0.1.0":{"name":"@boringos/connector","version":"0.1.0","keywords":["boringos","agentic","ai-agents","framework"],"author":{"name":"BoringOS Contributors"},"license":"MIT","_id":"@boringos/connector@0.1.0","maintainers":[{"name":"paragarora_github","email":"parag.arora@gmail.com"}],"homepage":"https://boringos.dev","bugs":{"url":"https://github.com/BoringOS-dev/boringos/issues"},"dist":{"shasum":"3f7ef3a31e657efe601c2843ef9071b5f27391a7","tarball":"https://registry.npmjs.org/@boringos/connector/-/connector-0.1.0.tgz","fileCount":30,"integrity":"sha512-JfJIX/g1HTnhbelguvpAiVDV/4cSjqAoXimtmq1iqtfXDo/WfdoswttgFh6WIiF2PzdHxslUipUlxUGma66h0g==","signatures":[{"sig":"MEUCIQCVhQklDwBpzANkgcM+y2G5fcOK4fNYZSTQCu0QFg+3uAIgUMb2ietFUCXfTO1BJxcA8Lz3SiqNSf2VRDYf2i76tNE=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":27790},"main":"dist/index.js","type":"module","_from":"file:boringos-connector-0.1.0.tgz","types":"dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"scripts":{"build":"tsc","typecheck":"tsc --noEmit"},"_npmUser":{"name":"paragarora_github","email":"parag.arora@gmail.com"},"_resolved":"/private/var/folders/0n/sxl7t1x95h7_47y142xfgkxc0000gn/T/d7c8868345c8009bb1c504c55e37d8b2/boringos-connector-0.1.0.tgz","_integrity":"sha512-JfJIX/g1HTnhbelguvpAiVDV/4cSjqAoXimtmq1iqtfXDo/WfdoswttgFh6WIiF2PzdHxslUipUlxUGma66h0g==","repository":{"url":"git+https://github.com/BoringOS-dev/boringos.git","type":"git"},"_npmVersion":"10.9.2","description":"Connector SDK — build integrations for any external service","directories":{},"_nodeVersion":"22.16.0","dependencies":{"@boringos/db":"0.1.0","@boringos/shared":"0.1.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.7.3","@types/node":"^22.0.0"},"_npmOperationalInternal":{"tmp":"tmp/connector_0.1.0_1775710372839_0.2740635877028399","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"@boringos/connector","version":"0.1.1","keywords":["boringos","agentic","ai-agents","framework"],"author":{"name":"BoringOS Contributors"},"license":"MIT","_id":"@boringos/connector@0.1.1","maintainers":[{"name":"paragarora_github","email":"parag.arora@gmail.com"}],"homepage":"https://boringos.dev","bugs":{"url":"https://github.com/BoringOS-dev/boringos/issues"},"dist":{"shasum":"709c6b7fb27459d445002ef34af926ae0458ca51","tarball":"https://registry.npmjs.org/@boringos/connector/-/connector-0.1.1.tgz","fileCount":30,"integrity":"sha512-yVEX0SPVucqnVwoFNk0UzoTsrVqA8pIezVUCqtIpWnhxV/ktSMjO/1KDoTCUQ6DsiZsnBHc+q+jDuLHHFNBu7Q==","signatures":[{"sig":"MEUCIQDO1Wm7s12J1eK9qRHaCZmp77eL6wYO4/xPOWaSj/UlHAIgMN4ArwNT368qzP/xIijNZKFcjP8aPhKdxAsimlEi8vU=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":27790},"main":"dist/index.js","type":"module","_from":"file:boringos-connector-0.1.1.tgz","types":"dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"scripts":{"build":"tsc","typecheck":"tsc --noEmit"},"_npmUser":{"name":"paragarora_github","email":"parag.arora@gmail.com"},"_resolved":"/private/var/folders/0n/sxl7t1x95h7_47y142xfgkxc0000gn/T/902c5b2d7f66f9213e67156a50c86994/boringos-connector-0.1.1.tgz","_integrity":"sha512-yVEX0SPVucqnVwoFNk0UzoTsrVqA8pIezVUCqtIpWnhxV/ktSMjO/1KDoTCUQ6DsiZsnBHc+q+jDuLHHFNBu7Q==","repository":{"url":"git+https://github.com/BoringOS-dev/boringos.git","type":"git"},"_npmVersion":"10.9.2","description":"Connector SDK — build integrations for any external service","directories":{},"_nodeVersion":"22.16.0","dependencies":{"@boringos/db":"0.1.2","@boringos/shared":"0.1.1"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.7.3","@types/node":"^22.0.0"},"_npmOperationalInternal":{"tmp":"tmp/connector_0.1.1_1775762536966_0.3603393202996068","host":"s3://npm-registry-packages-npm-production"}},"0.1.2":{"name":"@boringos/connector","version":"0.1.2","keywords":["boringos","agentic","ai-agents","framework"],"author":{"name":"BoringOS Contributors"},"license":"MIT","_id":"@boringos/connector@0.1.2","maintainers":[{"name":"paragarora_github","email":"parag.arora@gmail.com"}],"homepage":"https://boringos.dev","bugs":{"url":"https://github.com/BoringOS-dev/boringos/issues"},"dist":{"shasum":"295e019fa24f78764fc735392d7da67b797838f6","tarball":"https://registry.npmjs.org/@boringos/connector/-/connector-0.1.2.tgz","fileCount":29,"integrity":"sha512-99YJfe5srh2ClSGd3CYjpqF4egdO4JlxbquUgSkyHRqMAA3AKbjKDfy21oXcwHAGnNrcmgzcHGHM1CNlfygmKw==","signatures":[{"sig":"MEQCICQweanBgKxDa63SJs99CGMG+u0VqTlRl5NLOH38k9mDAiARmZX2KfBzZGUwk/1grXRtZr/AlB7qvXGT4uDcqYLIlg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":26725},"main":"dist/index.js","type":"module","types":"dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"gitHead":"5613b0e9130aebf2d4a652dbe7aa3d9da5703edf","scripts":{"build":"tsc","typecheck":"tsc --noEmit"},"_npmUser":{"name":"paragarora_github","email":"parag.arora@gmail.com"},"repository":{"url":"git+https://github.com/BoringOS-dev/boringos.git","type":"git"},"_npmVersion":"10.9.2","description":"Connector SDK — build integrations for any external service","directories":{},"_nodeVersion":"22.16.0","dependencies":{"@boringos/db":"workspace:*","@boringos/shared":"workspace:*"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.7.3","@types/node":"^22.0.0"},"_npmOperationalInternal":{"tmp":"tmp/connector_0.1.2_1775865888778_0.9121574257877063","host":"s3://npm-registry-packages-npm-production"}},"0.1.6":{"name":"@boringos/connector","version":"0.1.6","keywords":["boringos","agentic","ai-agents","framework"],"author":{"name":"BoringOS Contributors"},"license":"MIT","_id":"@boringos/connector@0.1.6","maintainers":[{"name":"paragarora_github","email":"parag.arora@gmail.com"}],"homepage":"https://boringos.dev","bugs":{"url":"https://github.com/BoringOS-dev/boringos/issues"},"dist":{"shasum":"a9c906bbbd66230bcdbcee3cd01e3f1b7a3d29a9","tarball":"https://registry.npmjs.org/@boringos/connector/-/connector-0.1.6.tgz","fileCount":31,"integrity":"sha512-TVEOCzbYsuo0gRGglXVky2ZhDcnCg1fPkZLT7Uq2K0Nfsjn7kikCjdn2584wPhJEc9wz4rpqaVoe/BFnOQy+jA==","signatures":[{"sig":"MEUCIDwZ6CX922KD7oxV7hOJwZ0yDDgwpzFZkvTURmBQz5L3AiEAzjN7jDrQ89eSPG6mR1Ls566OMJqPMXk3vcFIZegLpck=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":30586},"main":"dist/index.js","type":"module","_from":"file:boringos-connector-0.1.6.tgz","types":"dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"scripts":{"build":"tsc","typecheck":"tsc --noEmit"},"_npmUser":{"name":"paragarora_github","email":"parag.arora@gmail.com"},"_resolved":"/tmp/aced6986af525bf2b13ce95498843091/boringos-connector-0.1.6.tgz","_integrity":"sha512-TVEOCzbYsuo0gRGglXVky2ZhDcnCg1fPkZLT7Uq2K0Nfsjn7kikCjdn2584wPhJEc9wz4rpqaVoe/BFnOQy+jA==","repository":{"url":"git+https://github.com/BoringOS-dev/boringos.git","type":"git"},"_npmVersion":"10.9.4","description":"Connector SDK — build integrations for any external service","directories":{},"_nodeVersion":"22.22.1","dependencies":{"@boringos/db":"0.1.6","@boringos/shared":"0.1.6"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.7.3","@types/node":"^22.0.0"},"_npmOperationalInternal":{"tmp":"tmp/connector_0.1.6_1776406976278_0.6050737353884277","host":"s3://npm-registry-packages-npm-production"}},"0.1.7":{"name":"@boringos/connector","version":"0.1.7","keywords":["boringos","agentic","ai-agents","framework"],"author":{"name":"BoringOS Contributors"},"license":"MIT","_id":"@boringos/connector@0.1.7","maintainers":[{"name":"paragarora_github","email":"parag.arora@gmail.com"}],"homepage":"https://boringos.dev","bugs":{"url":"https://github.com/BoringOS-dev/boringos/issues"},"dist":{"shasum":"35802b73fac7db35eed7a170a19b3c209f394e47","tarball":"https://registry.npmjs.org/@boringos/connector/-/connector-0.1.7.tgz","fileCount":30,"integrity":"sha512-dvKw97r6R83Fyhiv0zLarxBFPz1o2z+76GabcHMJwEgc7rd6t9Vm5i+tkNCKo+BEhnDNscVd5OxhIY31uhXptA==","signatures":[{"sig":"MEUCIQCcXcJOp/pwEykZZV5+YYGVcJDkl9T4ucTHgWk19iCR9gIgFxk1fh4bbULv58MiXtZ+u5Z9SkH0pX8EtlDy4sOowfw=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":29521},"main":"dist/index.js","type":"module","types":"dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"gitHead":"5aa5e304f9e2742216029068bd0afb185d8630ae","scripts":{"build":"tsc","typecheck":"tsc --noEmit"},"_npmUser":{"name":"paragarora_github","email":"parag.arora@gmail.com"},"repository":{"url":"git+https://github.com/BoringOS-dev/boringos.git","type":"git"},"_npmVersion":"10.9.4","description":"Connector SDK — build integrations for any external service","directories":{},"_nodeVersion":"22.22.1","dependencies":{"@boringos/db":"workspace:*","@boringos/shared":"workspace:*"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.7.3","@types/node":"^22.0.0"},"_npmOperationalInternal":{"tmp":"tmp/connector_0.1.7_1776621681790_0.8380088122224698","host":"s3://npm-registry-packages-npm-production"}},"0.1.8":{"name":"@boringos/connector","version":"0.1.8","type":"module","main":"dist/index.js","types":"dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"scripts":{"build":"tsc","typecheck":"tsc --noEmit"},"license":"MIT","dependencies":{"@boringos/shared":"workspace:*","@boringos/db":"workspace:*"},"devDependencies":{"@types/node":"^22.0.0","typescript":"^5.7.3"},"description":"Connector SDK — build integrations for any external service","repository":{"type":"git","url":"git+https://github.com/BoringOS-dev/boringos.git"},"homepage":"https://boringos.dev","author":{"name":"BoringOS Contributors"},"keywords":["boringos","agentic","ai-agents","framework"],"_id":"@boringos/connector@0.1.8","gitHead":"bde96e88a0a74fe6dfe6c7b96ca776d7b1b03ffb","bugs":{"url":"https://github.com/BoringOS-dev/boringos/issues"},"_nodeVersion":"22.22.1","_npmVersion":"10.9.4","dist":{"integrity":"sha512-xWZbV6t/ONYZmld3BksF89hBtXCfLnOSaZzP+5fLJY7s2QSCm8gke2dGTlHXny5M3oEhzBwvMQyDUd5tsnxG+Q==","shasum":"b57b325aff9f5693f762fa2f80477b8331fbd149","tarball":"https://registry.npmjs.org/@boringos/connector/-/connector-0.1.8.tgz","fileCount":30,"unpackedSize":29521,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDz2BZevBTp2nLxSSdtEhcIOOc4Kpwoer4tZK6jsLePPgIhANPV3EQ4j/wUBPGKjdFfQoyygYVBtdUXwAPGjuKiN4z/"}]},"_npmUser":{"name":"paragarora_github","email":"parag.arora@gmail.com"},"directories":{},"maintainers":[{"name":"paragarora_github","email":"parag.arora@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/connector_0.1.8_1776829847125_0.5943837417967273"},"_hasShrinkwrap":false}},"time":{"created":"2026-04-09T04:52:52.768Z","modified":"2026-04-22T03:50:47.399Z","0.1.0":"2026-04-09T04:52:52.980Z","0.1.1":"2026-04-09T19:22:17.110Z","0.1.2":"2026-04-11T00:04:48.943Z","0.1.6":"2026-04-17T06:22:56.400Z","0.1.7":"2026-04-19T18:01:21.936Z","0.1.8":"2026-04-22T03:50:47.273Z"},"bugs":{"url":"https://github.com/BoringOS-dev/boringos/issues"},"author":{"name":"BoringOS Contributors"},"license":"MIT","homepage":"https://boringos.dev","keywords":["boringos","agentic","ai-agents","framework"],"repository":{"type":"git","url":"git+https://github.com/BoringOS-dev/boringos.git"},"description":"Connector SDK — build integrations for any external service","maintainers":[{"name":"paragarora_github","email":"parag.arora@gmail.com"}],"readme":"# @boringos/connector\n\nConnector SDK for BoringOS -- interfaces, registry, OAuth, event bus, and action runner for integrating external services.\n\n## Install\n\n```bash\nnpm install @boringos/connector\n```\n\n## Usage\n\n```typescript\nimport {\n  createConnectorRegistry,\n  createOAuthManager,\n  createEventBus,\n  createActionRunner,\n  createConnectorTestHarness,\n} from \"@boringos/connector\";\nimport type { ConnectorDefinition } from \"@boringos/connector\";\n\n// Define a connector\nconst myConnector: ConnectorDefinition = {\n  kind: \"my-service\",\n  name: \"My Service\",\n  oauth: { authorizeUrl: \"...\", tokenUrl: \"...\", scopes: [\"read\"] },\n  events: [{ type: \"item_created\", description: \"New item created\" }],\n  actions: [{ name: \"create_item\", fields: [{ name: \"title\", type: \"string\" }] }],\n  createClient(credentials) { return new MyClient(credentials); },\n  handleWebhook(req) { /* parse and emit events */ },\n  skillMarkdown() { return \"Instructions for agents...\"; },\n};\n\n// Registry\nconst registry = createConnectorRegistry();\nregistry.register(myConnector);\n\n// Event bus\nconst bus = createEventBus();\nbus.on(\"my-service:item_created\", (event) => {\n  console.log(\"New item:\", event.data);\n});\n\n// Action runner (agents invoke actions via callback API)\nconst runner = createActionRunner(registry);\nawait runner.run(\"my-service\", \"create_item\", { title: \"Hello\" });\n\n// Test harness for development\nconst harness = createConnectorTestHarness(myConnector);\nawait harness.simulateWebhook({ body: { type: \"item_created\" } });\n```\n\n## API Reference\n\n### Factories\n\n| Export | Description |\n|---|---|\n| `createConnectorRegistry()` | Register, lookup, and list connectors |\n| `createOAuthManager(config, clientId, secret)` | OAuth authorization, code exchange, token refresh |\n| `createEventBus()` | Typed event bus for connector events |\n| `createActionRunner(registry)` | Execute connector actions |\n| `createConnectorTestHarness(connector)` | Mock OAuth, simulate webhooks, inspect events |\n\n### `ConnectorDefinition` Interface\n\n| Property | Description |\n|---|---|\n| `kind` | Unique identifier (e.g., `\"slack\"`, `\"google\"`) |\n| `name` | Human-readable name |\n| `oauth` | OAuth configuration |\n| `events` | Event definitions this connector can emit |\n| `actions` | Action definitions agents can invoke |\n| `createClient(creds)` | Factory for authenticated API client |\n| `handleWebhook(req)` | Parse incoming webhooks into events |\n| `skillMarkdown()` | Agent-facing instructions |\n\n### Types\n\n`ConnectorDefinition`, `OAuthConfig`, `OAuthTokens`, `ConnectorEvent`, `ActionDefinition`, `ActionRequest`, `ActionResult`, `ConnectorClient`, `WebhookRequest`, `WebhookResponse`, `EventBus`, `ActionRunner`, `OAuthManager`, `ConnectorRegistry`\n\n## Part of [BoringOS](https://github.com/BoringOS-dev/boringos)\n","readmeFilename":"README.md"}