@contractspec/example.openbanking-powens
v3.7.30
Published
OpenBanking Powens example: OAuth callback + webhook handler patterns (provider + workflows).
Readme
@contractspec/example.openbanking-powens
Website: https://contractspec.io
OpenBanking Powens example: OAuth callback + webhook handler patterns (provider + workflows).
What This Demonstrates
- OAuth callback handler pattern for open banking.
- Webhook handler for asynchronous bank event ingestion.
- Canonical
jobexport viaPowensSyncDispatchJob. - Provider integration via contracts-integrations.
src/docs/contains docblocks and documentation-facing exports.src/handlers/contains handlers or demo adapters wired to contract surfaces.
Running Locally
From packages/examples/openbanking-powens:
bun run devbun run buildbun run testbun run typecheck
Usage
Use @contractspec/example.openbanking-powens as a reference implementation, or import its exported surfaces into a workspace that composes ContractSpec examples and bundles.
Architecture
src/docs/contains docblocks and documentation-facing exports.src/example.tsis the runnable example entrypoint.src/handlers/contains handlers or demo adapters wired to contract surfaces.src/index.tsis the root public barrel and package entrypoint.src/jobs/contains the exported Powens dispatch job spec.src/openbanking-powens.feature.tsdefines a feature entrypoint.
Public Entry Points
- Export
.resolves through./src/index.ts. - Export
./docsresolves through./src/docs/index.ts. - Export
./docs/openbanking-powens.docblockresolves through./src/docs/openbanking-powens.docblock.ts. - Export
./exampleresolves through./src/example.ts. - Export
./handlers/oauth-callbackresolves through./src/handlers/oauth-callback.ts. - Export
./handlers/webhook-handlerresolves through./src/handlers/webhook-handler.ts. - Export
./jobsresolves through./src/jobs/index.ts. - Export
./jobs/powens-sync-dispatch.jobresolves through./src/jobs/powens-sync-dispatch.job.ts. - Export
./openbanking-powens.featureresolves through./src/openbanking-powens.feature.ts. - The package publishes 8 total export subpaths; keep docs aligned with
package.json.
Local Commands
bun run dev— contractspec-bun-build devbun run build— bun run prebuild && bun run build:bundle && bun run build:typesbun run test— bun test --pass-with-no-testsbun run lint— bun lint:fixbun run lint:check— biome check .bun run lint:fix— biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .bun run typecheck— tsc --noEmitbun run publish:pkg— bun publish --tolerate-republish --ignore-scripts --verbosebun run publish:pkg:canary— bun publish:pkg --tag canarybun run clean— rimraf dist .turbobun run build:bundle— contractspec-bun-build transpilebun run build:types— contractspec-bun-build typesbun run prebuild— contractspec-bun-build prebuild
Recent Updates
- Replace eslint+prettier by biomejs to optimize speed.
- Missing contract layers.
Notes
- Works alongside
@contractspec/integration.provider.openbanking,@contractspec/lib.contracts-spec,@contractspec/tool.bun,@contractspec/tool.typescript.
