Skip to content
ContractSpec
Start here

Package manual · examples

·Examples and implementation patterns

example.email-gmail

Gmail integration example: inbound threads and outbound messages.

examplesexamplev5.0.4stableservernode
@lssm-tech/example.email-gmail
bun add @lssm-tech/example.email-gmail
Package source ↗Manifest ↗

Manifest declarations describe the current workspace; they do not verify registry publication or runtime execution.

Package guide

Website: https://contractspec.io

Gmail integration example: inbound threads and outbound messages.

What This Demonstrates

  • OAuth authentication flow for Gmail API.
  • Inbound email thread processing.
  • Outbound message composition and sending.
  • Integration provider pattern with ContractSpec contracts.
  • src/docs/ contains docblocks and documentation-facing exports.
  • src/docs/ contains docblocks and documentation-facing exports.

Running Locally

From examples/email-gmail:

  • bun run dev
  • bun run build
  • bun run test
  • bun run typecheck

Usage

Use @lssm-tech/example.email-gmail as a reference implementation, or import its exported surfaces into a workspace that composes ContractSpec examples and bundles.

Architecture

  • src/auth.ts is part of the package's public or composition surface.
  • src/docs/ contains docblocks and documentation-facing exports.
  • src/email-gmail.feature.ts defines a feature entrypoint.
  • src/example.ts is the runnable example entrypoint.
  • src/inbound.ts is part of the package's public or composition surface.
  • src/index.ts is the root public barrel and package entrypoint.
  • src/outbound.ts is part of the package's public or composition surface.

Public Entry Points

  • Export . resolves through ./src/index.ts.
  • Export ./auth resolves through ./src/auth.ts.
  • Export ./docs resolves through ./src/docs/index.ts.
  • Export ./docs/email-gmail.docblock is an alias of ./docs and resolves through ./src/docs/index.ts.
  • Export ./email-gmail.feature resolves through ./src/email-gmail.feature.ts.
  • Export ./example resolves through ./src/example.ts.
  • Export ./inbound resolves through ./src/inbound.ts.
  • Export ./outbound resolves through ./src/outbound.ts.
  • Export ./run resolves through ./src/run.ts.

Local Commands

  • bun run dev — contractspec-bun-build dev
  • bun run build — contractspec-bun-build build
  • bun run test — bun test --pass-with-no-tests
  • bun run lint — bun lint:fix
  • bun run lint:check — biome check .
  • bun run lint:fix — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
  • bun run typecheck — tsgo --noEmit
  • bun run publish:pkg — bun publish --tolerate-republish --ignore-scripts --verbose
  • bun run publish:pkg:canary — bun publish:pkg --tag canary
  • bun run clean — rimraf dist .turbo
  • bun run build:bundle — contractspec-bun-build transpile
  • bun run build:types — contractspec-bun-build types
  • bun run prebuild — contractspec-bun-build prebuild

Recent Updates

  • Replace eslint+prettier by biomejs to optimize speed.
  • Missing contract layers.

Notes

  • Works alongside @lssm-tech/integration.provider-email, @lssm-tech/lib.contracts-spec, @lssm-tech/tool.bun, @lssm-tech/tool.typescript.

Relationships

THIS PACKAGEexample.email-gmail9 import paths

Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.

3 declarations

Declared capabilities

This manifest does not declare a capability catalogue. Use the guide, import map and source to assess the package.

Scripts

  • publish:pkgbun publish --tolerate-republish --ignore-scripts --verbose
  • publish:pkg:canarybun publish:pkg --tag canary
  • buildcontractspec-bun-build build
  • build:bundlecontractspec-bun-build transpile
  • build:typescontractspec-bun-build types
  • devcontractspec-bun-build dev
  • cleanrimraf dist .turbo
  • lintbun lint:fix
  • lint:fixnode ../../scripts/biome.cjs check --write --unsafe --only=nursery/useSortedClasses . && node ../../scripts/biome.cjs check --write .
  • lint:checknode ../../scripts/biome.cjs check .
  • testbun test --pass-with-no-tests
  • prebuildcontractspec-bun-build prebuild
  • typechecktsgo --noEmit