connector-authoring

Public TypeScript declarations and examples for ConductorOne connector authoring.

Type declarations

The baton directory declares the modules available to authored connectors:

• @baton/runtime defines the connector runtime, resource-type, traversal, and transport APIs.
• @baton/helpers defines helpers for constructing identifiers, annotations, and common connector values.
• @baton/types defines connector resources, entitlements, grants, traits, and related data types.

These files contain declarations only. Runtime implementations are provided by the hosted ConductorOne product; connector source imports the modules but does not bundle their implementations. This repository does not by itself establish compatibility with a particular hosted runtime.

Declarative execution model

config + auth -> registered transport -> node outputs/slots -> walk mappings
              -> resource types (resources, entitlements, grants)

Authored TypeScript declares a graph. http.v1(...) declares a transport, node.run returns an execution descriptor, slots carry returned rows, and walk maps those rows into ConductorOne values. The hosted runtime owns execution and pagination.

Config and authentication values remain opaque references that the hosted runtime resolves. Connector code must not inspect or log secret values. Do not use direct fetch calls or hand-written pagination loops in authored code.

Examples

• examples/static is a neutral, configuration-free sync example backed by hardcoded data. It demonstrates local resource, entitlement, and grant mappings without transport, authentication, or pagination.
• examples/http is a compile-only fictional Directory API example. It demonstrates public and secret config, basic authentication, transport registration, offset pagination, nodes, slots, users, groups, a membership entitlement, and grants. See its documented response contract.

Neither example calls a live service as part of this repository's checks.

Agent skills

The skills directory ships agent skills for the in-app connector authoring funnel: author-in-app-connector (the S0–S11 orchestrator), read-authoring-contract, write-connector-source (the four-file source contract authoring stage), build-and-test, and deploy-and-activate. Each skill's SOURCES.md names the pinned contract sources it was authored against.

Typechecking

Install the pinned development dependency and typecheck the examples against the declarations:

npm ci --ignore-scripts --audit=false --fund=false
npm run typecheck