{"_id":"@boringos/connector-sdk","name":"@boringos/connector-sdk","dist-tags":{"alpha":"1.0.0-alpha.0","latest":"1.0.0-alpha.0"},"versions":{"1.0.0-alpha.0":{"name":"@boringos/connector-sdk","version":"1.0.0-alpha.0","type":"module","main":"dist/index.js","types":"dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"license":"MIT","dependencies":{"@boringos/app-sdk":"^1.0.0-alpha.0"},"devDependencies":{"@types/node":"^22.0.0","typescript":"^5.7.3"},"description":"Focused entry point for building BoringOS connectors. Re-exports the connector-relevant subset of @boringos/app-sdk.","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","sdk","connectors","integrations"],"publishConfig":{"access":"public","tag":"alpha"},"scripts":{"build":"tsc","typecheck":"tsc --noEmit"},"_id":"@boringos/connector-sdk@1.0.0-alpha.0","bugs":{"url":"https://github.com/BoringOS-dev/boringos/issues"},"_integrity":"sha512-qATTV6QPI5tqbVpIQqiaB8wWwIlJyCjALoeug03WRI0YPJ41By1+FYNjwNNO0ZSFwWGUT3ReH9Oai0b6gRFhEA==","_resolved":"/private/var/folders/0n/sxl7t1x95h7_47y142xfgkxc0000gn/T/2747c369a9c84a28f773f0934be179cd/boringos-connector-sdk-1.0.0-alpha.0.tgz","_from":"file:boringos-connector-sdk-1.0.0-alpha.0.tgz","_nodeVersion":"22.16.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-qATTV6QPI5tqbVpIQqiaB8wWwIlJyCjALoeug03WRI0YPJ41By1+FYNjwNNO0ZSFwWGUT3ReH9Oai0b6gRFhEA==","shasum":"c0b0ad569cee88314442fdc128c864bdf55ab042","tarball":"https://registry.npmjs.org/@boringos/connector-sdk/-/connector-sdk-1.0.0-alpha.0.tgz","fileCount":7,"unpackedSize":5573,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQC5Mgsi32slBfrNCU+fI9RLhdb/OfApTqrfY9H/N4iWxwIhAKK7njF0b8W0FRNt3G1yW2Nfn0O6BigC04KeJx9t38MI"}]},"_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-sdk_1.0.0-alpha.0_1777882144127_0.7806576047571161"},"_hasShrinkwrap":false}},"time":{"created":"2026-05-04T08:09:04.012Z","1.0.0-alpha.0":"2026-05-04T08:09:04.265Z","modified":"2026-05-04T08:09:04.505Z"},"maintainers":[{"name":"paragarora_github","email":"parag.arora@gmail.com"}],"description":"Focused entry point for building BoringOS connectors. Re-exports the connector-relevant subset of @boringos/app-sdk.","homepage":"https://boringos.dev","keywords":["boringos","agentic","ai-agents","framework","sdk","connectors","integrations"],"repository":{"type":"git","url":"git+https://github.com/BoringOS-dev/boringos.git"},"author":{"name":"BoringOS Contributors"},"bugs":{"url":"https://github.com/BoringOS-dev/boringos/issues"},"license":"MIT","readme":"# @boringos/connector-sdk\n\n> Focused entry point for building [BoringOS](https://boringos.dev) connectors.\n\nThis package re-exports the connector-relevant subset of [`@boringos/app-sdk`](../app-sdk). Use it when you're building an integration (Stripe, HubSpot, Zendesk, etc.) and don't want to see app/UI types.\n\nIf you're building a full domain app (CRM, Accounts, etc.), use `@boringos/app-sdk` directly.\n\n## Quickstart\n\n```ts\nimport { defineConnector } from \"@boringos/connector-sdk\";\n\nexport default defineConnector({\n  kind: \"stripe\",\n  name: \"Stripe\",\n  description: \"Payments and invoices.\",\n  oauth: {\n    authorizationUrl: \"https://connect.stripe.com/oauth/authorize\",\n    tokenUrl: \"https://connect.stripe.com/oauth/token\",\n    scopes: [\"read_write\"],\n  },\n  events: [\n    { type: \"payment_received\", description: \"Stripe payment intent succeeded\" },\n  ],\n  actions: [\n    {\n      name: \"create_invoice\",\n      description: \"Create a new invoice for a customer\",\n      inputs: { customer: { type: \"string\", description: \"Customer id\", required: true } },\n    },\n  ],\n  createClient: (creds) => new StripeClient(creds),\n});\n```\n\nPair the runtime definition above with a `boringos.json` manifest at your repo root for marketplace install. See the [Building Connectors guide](../../../docs/developer/building-connectors.md).\n\n## Status\n\n`1.0.0-alpha.0` — first publishable alpha. The contract may change before `1.0.0` based on what we learn migrating the first connectors (see Phase 1 task D2). Pin to `1.0.0-alpha.0` if you need stability.\n\n## License\n\nMIT — see [LICENSE](./LICENSE).\n","readmeFilename":"README.md","_rev":"1-e339dffc754bacffc7856113adaafa58"}