chore: add deprecation notice

[web3skeptic]

I'd also recommend to add the deprecation notice via npm
npm deprecate circles-sdk/sdk "This package is deprecated. Please migrate to @aboutcircles/sdk. See migration guide: https://github.com/aboutcircles/sdk/blob/main/MIGRATION_GUIDE.md"

Summary by CodeRabbit

• New Features

  • Expanded SDK public API with additional avatar, pathfinding and configuration exports for more direct access to functionality.

• Notices

  • One-time deprecation warnings added to the SDK and data packages (shown on first import) directing users to migration guidance.

• Documentation

  • Deprecation notice inserted at the top of the README with migration guidance.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Added one-time deprecation warnings to two package entrypoints and expanded the SDK package's public exports; README received a deprecation notice block. All changes are additive and do not modify existing API signatures.

Changes

Cohort / File(s)	Summary
Deprecation warnings packages/data/src/index.ts, packages/sdk/src/index.ts	Inserted one-time console deprecation warnings that run on first module import. No changes to existing exports or API signatures.
New SDK exports packages/sdk/src/index.ts	Added multiple additive exports: V1Avatar, CirclesConfig, AvatarRow, TrustListRow, TrustRelationRow, AvatarInterface, AvatarInterfaceV2, V1Pathfinder, MaxFlowResponse, TransferPathStep, and circlesConfig.
Docs README.md	Prepended a deprecation notice block and migration guidance to the README; rest of content unchanged.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Small, localized changes: two module-load side-effects, new export lines, and README text.
• Review attention:
  • Ensure the deprecation warnings are truly one-time and not noisy in test runs.
  • Verify the newly exported identifiers exist and their type/signature imports are correct.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'chore: add deprecation notice' accurately reflects the main changes across all modified files: deprecation warnings added to package exports and a deprecation notice inserted into the README.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch chore/add-deprecation-notice

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

packages/data/src/index.ts (1)

1-6: Deprecation side‑effect looks fine; consider guarding for tests/SSR as an optional refinement

The import‑time console.warn is a straightforward way to surface deprecation without touching the exported API. One thing to bear in mind is that this will also fire in tests and SSR/log‑sensitive environments. If it becomes noisy, you could optionally wrap it, for example with an environment check or a logger hook:

if (typeof console !== 'undefined' && process.env.NODE_ENV !== 'test') {
  console.warn(
    '\nDEPRECATION NOTICE:\n' +
    'This version of @circles-sdk/data is deprecated and will no longer be supported.\n' +
    'Please migrate to the new SDK: https://github.com/aboutcircles/sdk\n'
  );
}

Purely optional, not a blocker.

packages/sdk/src/index.ts (1)

1-6: Import‑time deprecation warning achieves the goal; optional guard could reduce noise

The top‑level console.warn cleanly communicates that @circles-sdk/sdk is deprecated and keeps the public API intact. As with the data package, this will also run in tests/SSR contexts. If that proves too noisy later, you could wrap it in a simple environment check:

if (typeof console !== 'undefined' && process.env.NODE_ENV !== 'test') {
  console.warn(
    '\nDEPRECATION NOTICE:\n' +
    'This version of @circles-sdk/sdk is deprecated and will no longer be supported.\n' +
    'Please migrate to the new SDK: https://github.com/aboutcircles/sdk\n'
  );
}

No change required now; just an optional hardening.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between 8e379ac and 5a5dd2c.

📒 Files selected for processing (2)

• packages/data/src/index.ts (1 hunks)
• packages/sdk/src/index.ts (1 hunks)