Repository navigation
Add DataSync API - #264
Merged
Merged
Add DataSync API#264
Conversation
- Add DataSync routers for channels, users, entities, memberships, and relationships - Extend `HTTPRouter` with the `Data Sync` service and DataSync-specific query keys - Add error descriptions for empty DataSync ids, entity/relationship classes, and patch operations - Only set the default `Content-Type` header when the request doesn't already provide one - Add unit test coverage for the new DataSync routers
* Add DataSync PAM token resources and create permission * Wrap DataSync create/replace bodies in data envelope and expose entity_class_level
- Recognize the `e: 5` DataSync wire type, which previously fell back to `.message` and silently surfaced DataSync changes as plain messages - Add `PubNubDataSyncEvent` with entity/relationship created, updated and deleted cases, delivered through the new `onDataSync` closure - Add `PubNubDataSyncEntity` and `PubNubDataSyncRelationship` models, plus `PubNubDataSyncRemovedObject` for delete events that carry identity only - Support both listener generations: `onDataSync` on `EventListenerInterface` and `didReceiveDataSyncEvent` on the legacy `SubscriptionListener` - Parse the level-encoded `className` (`::name`, `:name:`, `name::`) into a name plus `PubNubDataSyncClassLevel` - Decode date-only (`yyyy-MM-dd`) timestamps by adding `iso8601_dateOnly` as a further fallback after the full ISO 8601 and no-milliseconds formatters, so DataSync fields such as `expiresAt` parse correctly - Fix `AnyJSON` dictionary equality, which compared subsets and so was asymmetric and inconsistent with `hash(into:)` - Split `SubscribeRouterTests` into per-feature extensions to stay within the file-length limit - Add the optional `entity_class` filter to the DataSync user and channel list routers, matching `GET /users` and `GET /channels` in `v4-data.yaml`
- `DataSyncAPI`: CRUD for entities, users, channels, relationships, memberships - Models: `PubNubDataSyncEntity`, `User`, `Channel`, `Relationship`, `Membership`, `PubNubDataSyncPage` - JSON Patch (RFC 6902) support for `update*` methods - PubNubConfiguration`: new `originAt:` plist-key parameter - Snippets per DataSync class + 11.0 migration guide section - Unit and integration tests, plus a new `PubNubDataSyncTests` test suite - Deintegrate VSP modules from `Package.swift` while preserving their source code - Add KMP bindings for DataSync Subscribe entities are renamed alongside: - Drop the `Representation` suffix (`Channel`, `ChannelGroup`, `UserMetadata`, `ChannelMetadata`) - Fold `Subscriber` into `Subscribable` - Rename `SubscribableType` to `SubscribeTarget` - Move the `PubNub` factories from `EntityCreator` into `Subscribable+PubNub`.
`entity` now means a DataSync record, so the subscribe API stops using the word and DataSync drops redundant prefixes. **Subscribe** - `Subscription.entity` → internal `target`; `pubnub.subscription(entities:)` → `subscription(targets:)` - `Subscription` / `SubscriptionSet` initializers are no longer public — use the `PubNub` factory methods - `Subscribable` subclasses now provide identifiers through `SubscriptionTopology` - Added DataSync subscribables - Added `PubNub` factories such as `dataSyncUser(_:)` and `dataSyncEntity(_:)` - Data Sync subscribables support `.subscription()` and `.subscription(projection:)` - Base and `default` projection subscriptions use the resource ID as the channel - Custom projections derive `__<projection>__<resource_id>` **DataSync** - `entityClass` / `entityClassVersion` / `entityClassLevel` → `className` / `classVersion` / `classLevel` - `relationshipClass` / `relationshipClassVersion` → `className` / `classVersion` - `className` now precedes `classVersion` on users and channels - `classVersion` follows `className` on relationships - User/Channel APIs now return the shared `PubNubDataSyncEntity` model instead of duplicate user/channel models. - Memberships reveal their `PubNubDataSyncRelationship`, mapping channel and user IDs to entityAId/entityBId - Deleted relationships use `PubNubDataSyncRemovedRelationship` instead of the entity deletion model - `PubNubDataSyncRelationship.classLevel` removed — relationship classes cannot be extended - KMP now mirrors the Swift signatures parameter-for-parameter
- `filter` → `filter_fast` (`filterFast:`), - `filter_advanced` → `filter` (`filter:`) - `expiresAt` becomes non-optional - enable DataSync integration tests - add scripts to show how DataSync classes that integration tests rely on were created
jguz-pubnub
force-pushed
the
feat/data-sync
branch
from
September 7, 2026 09:27
979458d to
73648b0
Compare
marcin-cebo
approved these changes
Oct 12, 2026
jguz-pubnub
force-pushed
the
feat/data-sync
branch
from
October 12, 2026 09:20
34fb367 to
b04499c
Compare
- Restore KMPEntity `name` on the KMP channel, channel group and metadata wrappers - Keep `PAMPermission.crud`/`.all` unchanged; add `.dataSyncCrud`/`.dataSyncAll` for `create` - Accept empty response bodies only for DataSync deletes - Remove the `account` class level and its doc mentions - Remove unused `dataSyncMembership`/`dataSyncRelationship` handles, their KMP references and snippets - Move `DataSyncResource` into tests; decode real models in response tests - Clarify `PAMTokenCategory` docs as App Context permissions
jguz-pubnub
marked this pull request as ready for review
October 12, 2026 12:19
jguz-pubnub
requested review from
kazydek,
parfeon and
techwritermat
as code owners
October 12, 2026 12:19
Contributor
Author
|
@pubnub-release-bot release as 11.0.0 |
jguz-pubnub
force-pushed
the
feat/data-sync
branch
from
October 12, 2026 13:11
4306851 to
b1e5320
Compare
techwritermat
approved these changes
Oct 12, 2026
|
🛑 Build failed. Please check release build for details 🛑 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
feat(data-sync): add DataSync API
Adds the
pubnub.dataSyncnamespace with paged fetch, create, replace, update, and remove operations for entities, users, channels, memberships, and relationships. Object changes are delivered to subscribe listeners asPubNubDataSyncEvent, and DataSync subscribe targets support both base and projection subscriptions.feat(access-manager): add DataSync token resources and create permission
Access Manager tokens now parse DataSync resource permissions and expose the new
createpermission alongside the existing ones.feat(configuration): read the origin from the Info dictionary
PubNubConfiguration.init(bundle:)accepts anoriginAt:plist key, defaulting toPubNubOrigin.refactor(subscribe): free the word "entity" for Data Sync
entitynow means a DataSync record, so the subscribe API usestargetinstead; the subscribe target types drop theRepresentationsuffix, andSubscription/SubscriptionSetare created only through thePubNubfactory methods.refactor(subscribe): unify the legacy listener on PubNubEvent
The legacy
SubscriptionListeneremits the samePubNubEventtype as the modern listener API, and the catch-all event callbacks are deprecated in favor of the granular per-type ones.PubNubEventgains adataSyncChangedcase.refactor(subscribe): make listener configuration immutable
BaseSubscriptionListener.queueandsupressCancellationErrorsare now passed to the initializer, removing a data race when they were mutated on a live listener.refactor(build): deintegrate the VSP modules from Package.swift
PubNubUser,PubNubSpace, andPubNubMembershipare no longer built or distributed via SPM, though their sources remain in the repository.fix(json): decode date-only values
yyyy-MM-ddvalues now decode as dates, as an ISO 8601 fallback.fix(json): correct AnyJSON dictionary equality
Fixes an issue where a dictionary compared equal to any superset of itself, because only the left operand's keys were checked. Key counts are now compared first.
fix(subscribe): drop unrecognized message types
The SDK now skips subscribe messages whose
evalue it does not recognize. Messages that omitepreserve current inference behavior, while malformed entries no longer disrupt delivery of the remaining batch.