Skip to content

fix(examples): link to local SDK source instead of npm registry#96

Merged
zeevdr merged 2 commits into
mainfrom
fix/examples-local-dep
May 25, 2026
Merged

fix(examples): link to local SDK source instead of npm registry#96
zeevdr merged 2 commits into
mainfrom
fix/examples-local-dep

Conversation

@zeevdr
Copy link
Copy Markdown
Member

@zeevdr zeevdr commented May 25, 2026

Summary

  • Examples were resolving @opendecree/sdk from the npm registry (>=0.1.0) instead of local source, so in-progress SDK changes were never exercised by the examples.
  • Switches to file:../ so examples always use the current local version.
  • Regenerates examples/package-lock.json — removes ~330 lines of pulled-in registry metadata now replaced by a single local symlink entry.

Test plan

  • npm run typecheck passes in examples/ with no errors
  • examples/package-lock.json resolves @opendecree/sdk as "resolved": ".." (local link), not an npm registry URL

Closes #64

The examples/package.json previously resolved @opendecree/sdk from npm
(>=0.1.0), meaning examples were always tested against the published
version rather than local source. This switches the dependency to
file:../ so that any in-progress SDK changes are exercised by the
examples.

Closes #64

Co-Authored-By: Claude <noreply@anthropic.com>
@zeevdr zeevdr added this to the Beta Readiness milestone May 25, 2026
@zeevdr zeevdr added size: S Quick win — a few hours or less priority: P2 Nice-to-have labels May 25, 2026
@zeevdr zeevdr enabled auto-merge (squash) May 25, 2026 15:44
@codecov
Copy link
Copy Markdown

codecov Bot commented May 25, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

…k in CI

Two issues caused the Examples CI job to fail after switching to file:../:
- The SDK's dist/ directory is not present in CI until built, so TypeScript
  could not resolve @opendecree/sdk types via the file: link.
- @types/node was previously pulled in transitively from the npm-registry
  version of the SDK (via protobufjs); with file:../ that transitive dep is
  gone, breaking console and other Node globals.

Adds `npm run build` to the examples CI job and declares @types/node
explicitly in examples/package.json devDependencies.

Co-Authored-By: Claude <noreply@anthropic.com>
@zeevdr zeevdr merged commit abbe9a5 into main May 25, 2026
13 checks passed
@zeevdr zeevdr deleted the fix/examples-local-dep branch May 25, 2026 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority: P2 Nice-to-have size: S Quick win — a few hours or less

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Examples should depend on local source, not >=0.1.0 from npm

1 participant