Skip to content

docs: update advanced-imessage-ts documentation for v0.2.1#6

Closed
photon-action-bot[bot] wants to merge 6 commits intomainfrom
docs/update-advanced-imessage-ts-v0.2.1
Closed

docs: update advanced-imessage-ts documentation for v0.2.1#6
photon-action-bot[bot] wants to merge 6 commits intomainfrom
docs/update-advanced-imessage-ts-v0.2.1

Conversation

@photon-action-bot
Copy link
Copy Markdown
Contributor

Documentation Update: advanced-imessage-ts v0.2.1

This PR updates documentation for advanced-imessage-ts based on the v0.2.1 release.

Release Notes

Bug Fixes

  • Synced the message SDK with the latest server proto so sticker placement now includes width, and old service data is no longer sent by accident (298c8a7).
  • Synced the location SDK with server proto updates and fixed legacy Find My locations to map to "legacy" instead of being mis-labeled as "shallow" (ff742a6).

Improvement

  • Updated location fetching to match server behavior: getFriends() now supports optional friend ID filters and reflects the cached-snapshot + background-refresh flow.
  • Added focused unit tests for messages and locations so these proto-alignment behaviors stay stable over time. ✅

Breaking Changes

  • Removed message transport override support (SendOptions.service, ComposedMessage.service, and MessageBuilder.withService) to match the server schema (298c8a7).
  • Removed LocationsResource.refreshFriends(); use getFriends() instead (optionally with friend IDs) (ff742a6).

Version: 0.2.1


🤖 This PR was auto-generated by Claude Code via the update-docs action in buildspace.

Resolved conflicts:
- docs-src/advanced-kits/imessage/messages.mdx.vel: kept Vellum template syntax from main for SendOptions table (auto-generated from SDK types), replacing PR's hardcoded rows
- advanced-kits/imessage/locations.mdx: moved new PR file to docs-src/advanced-kits/imessage/locations.mdx.vel to follow the new file naming convention from main's rewrite

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

Resolved merge conflicts after merging origin/main into this branch.

docs-src/advanced-kits/imessage/messages.mdx.vel: Main rewrote the file to use Vellum template syntax for the SendOptions table, while this PR had hardcoded rows (including the removal of the 'service' field for v0.2.1). Kept the Vellum template approach from main, which auto-generates the table from SDK types (so the v0.2.1 type changes are reflected automatically).

advanced-kits/imessage/locations.mdx: This new file added by the PR needed to be moved to docs-src/advanced-kits/imessage/locations.mdx.vel to follow main's new directory structure and .vel file extension convention. Content is unchanged.

Verified: pnpm lint and pnpm typecheck:docs both pass.

Resolved conflict in package.json by taking main's updated dependency
versions (@antfu/eslint-config ^4.19.0, @photon-ai/advanced-imessage ^0.4.2).
Regenerated pnpm-lock.yaml to match the resolved package.json.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

Merge conflict resolution

Conflicts found:

  • package.json: Conflict between PR's dependency versions (@antfu/eslint-config ^4.15.1, @photon-ai/advanced-imessage ^0.2.1) and main's updated versions (@antfu/eslint-config ^4.19.0, @photon-ai/advanced-imessage ^0.4.2)

Resolution:

  • package.json: Took main's updated dependency versions, as these are dependency/config updates unrelated to the docs content of this PR
  • pnpm-lock.yaml: Regenerated to match the resolved package.json (original auto-merge left specifier mismatches)

pnpm lint and pnpm typecheck:docs both pass after resolution.

Resolve conflict in pnpm-lock.yaml by accepting main's lockfile
(generated file). package.json auto-merged cleanly with main's
updated dependency versions.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

Resolved merge conflicts between docs/update-advanced-imessage-ts-v0.2.1 and main.

Conflicts found:

pnpm-lock.yaml

  • Accepted main's lockfile in full (generated file)

package.json

  • Auto-merged cleanly (no manual resolution needed); result uses main's updated dependency versions

Resolution strategy: Preferred main's versions for lockfile/generated files. No content files had conflicts.

Verification: pnpm install --frozen-lockfile ✅ | pnpm lint ✅ | pnpm typecheck:docs ✅

Took main's improved structure (TypeTooltip, vellum symbols, Note
component, Accordion) and kept PR's unique `await using` /
`Symbol.asyncDispose` stream example.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

Merge conflict resolved

One conflict in docs-src/advanced-kits/imessage/locations.mdx.vel (add/add — both branches created this file):

  • Section header + intro: Took origin/main's version — it uses the proper vellum/TypeTooltip pattern (symbol(), <TypeTooltip>, <Note>) required by the style guide. The PR had a hand-written interface FindMyFriend { ... } block and a plain prose intro.
  • Real-time code example loop body: Took origin/main's updateMapPin(friend) example (cleaner for docs).
  • await using / Symbol.asyncDispose example: Kept from the PR — this was PR-specific content not present in origin/main. Added it after the TypeTooltip reference for LocationEvent.
  • Location types section: Took origin/main's <Accordion> version (style-guide compliant).

pnpm lint and pnpm typecheck:docs both pass.

@github-actions
Copy link
Copy Markdown
Contributor

Merge conflict resolution

Conflicted file: docs-src/advanced-kits/imessage/locations.mdx.vel (add/add conflict)

How it was resolved:

Both the PR branch and main added this file independently with different content:

  • PR branch introduced v0.2.1 docs: optional friend ID filter for getFriends(), fixed locationType values ("legacy" instead of "shallow"), removed refreshFriends(), and added a Symbol.asyncDispose example.
  • main added the same file with improved structure: TypeTooltip components, a <Note> about cached snapshots, and an <Accordion> for location types.

The merged result keeps main's structure and polish (TypeTooltip, import, Note component, Accordion for locationType) while preserving the PR's unique content (the Symbol.asyncDispose example and the correct locationType values including "legacy").

Additional: Fixed prettier formatting errors in CLAUDE.md (table column alignment and nested code fence backtick count) that were present in the merged-in main content. Also merged two subsequent main commits (tell claude to read .vel files, ci(close-stale-version-prs): add repo input) with no conflicts.

@github-actions
Copy link
Copy Markdown
Contributor

Superseded by #11 which targets a newer version.

@github-actions github-actions bot closed this Apr 16, 2026
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.

0 participants