Skip to content

fix: align package exports with documentation across the SDK#11

Merged
Polliog merged 1 commit into
mainfrom
fix/export-docs-audit
Jun 30, 2026
Merged

fix: align package exports with documentation across the SDK#11
Polliog merged 1 commit into
mainfrom
fix/export-docs-audit

Conversation

@Polliog

@Polliog Polliog commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Summary

Follow-up to #10. After another "no exported member" report (LogtideErrorBoundary), I audited every package's public exports against the documentation (logtide.dev + READMEs) — one agent per package — and fixed every code-side import/usage mismatch found.

Fixes (code-side)

  • @logtide/browser — export LogtideErrorBoundary (the React error boundary documented for React users at logtide.dev/integrations/react). react is now an optional peer dependency. @logtide/nextjs/client re-exports this single shared implementation instead of keeping its own copy.
  • @logtide/nuxt — implement the documented useLogtide() auto-imported composable; honor tracesSampleRate; support apiUrl + apiKey config (the module previously dropped them and bailed unless a dsn was set).
  • @logtide/cli — accept the documented --path option and --apiKey / --apiUrl aliases for sourcemaps upload (directory can be positional or --path).
  • @logtide/sdk-node README — import middleware from the /middleware subpath (where logTideMiddleware / logTideFastifyPlugin actually live).
  • @logtide/nuxt README — correct documented default service to 'nuxt'.

Audit result for the other packages

nextjs, sveltekit, angular, express, fastify, hono, elysia, core, typesexports clean, every documented import resolves. Remaining issues there are docs-site-only inaccuracies (separate repo) and are listed for the docs team, not fixed here.

Tests (TDD)

New tests: browser/tests/error-boundary.test.ts, cli/tests/cli.test.ts, nuxt/tests/composables.test.ts.

Full monorepo green: build + typecheck + all package test suites pass (browser 49, core 121, node 23, fastify 31, express 28, nextjs 17, sveltekit 20, nuxt 11, cli 15, angular 7, hono 14, elysia 11).

All packages bumped 0.10.0 → 0.11.0.

Audited every package's public exports against the docs (logtide.dev) and
fixed all import/usage mismatches found.

- @logtide/browser: export LogtideErrorBoundary (React error boundary) as
  documented for React users; react is an optional peer dependency.
  @logtide/nextjs/client now re-exports this shared implementation.
- @logtide/nuxt: implement the documented useLogtide() auto-imported
  composable; honor tracesSampleRate and support apiUrl/apiKey config (the
  module previously dropped them and required a dsn).
- @logtide/cli: accept the documented `--path` option and `--apiKey`/`--apiUrl`
  aliases for `sourcemaps upload`.
- @logtide/sdk-node README: import middleware from the /middleware subpath.
- @logtide/nuxt README: correct the default service value to 'nuxt'.

Bump all packages to 0.11.0.
@Polliog Polliog merged commit caeebaa into main Jun 30, 2026
8 checks passed
@Polliog Polliog deleted the fix/export-docs-audit branch June 30, 2026 11:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant