feat(subscriptions): channel mode + reset (PR 7/7) - #519
Open
sarthak688 wants to merge 8 commits into
Open
Conversation
Establishes the notification service module with the inbox listing
endpoint. Routes at the organization level via NOTIFICATION_BASE
(URL-traversal trick to bypass the tenant segment). tenantId is taken
as a positional argument and forwarded via X-UIPATH-Internal-TenantId.
Foundation included for follow-up PRs that add the remaining inbox and
subscription methods on top of this branch:
- @uipath/uipath-typescript/notifications subpath in package.json + rollup
- NOTIFICATION_BASE, NOTIFICATION_ENDPOINTS scaffold
- test infra (NOTIFICATION_TEST_TENANT_ID env var, test-config,
unified-setup registration, notification mock factories, constants)
- oauth-scopes + pagination + mkdocs nav entries
Methods: getAll (paginated OData listing with $top/$skip/$count,
filter, orderby; transformFn drops 8 internal/transport fields).
Tests: 4 unit + 4 integration (skipped when NOTIFICATION_TEST_TENANT_ID
is not set).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…llRead) Adds the three read-state mutation methods on top of the foundation established in feat/notifications-sdk. All three POST to the NotificationEntry.UpdateRead OData action; markAllRead uses the server-side forceAllRead flag. Adds UPDATE_READ endpoint constant and per-method telemetry decorators. Tests: 6 additional unit tests + 2 integration tests (mark/unmark round-trip + markAllRead). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Adds the two delete methods. Both POST to the NotificationEntry.DeleteBulk OData action; deleteAll uses the server-side deleteAll flag. Preserves the API spec's misspelling `notifcationIds` in the request body — the server expects that exact (mistyped) key. Tests: 4 additional unit tests. No integration tests — these destructively mutate the inbox with no SDK-level undo. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Adds the SubscriptionService class alongside the existing NotificationService. Both services live under @uipath/uipath-typescript/notifications as discrete classes (no shared state). Subscription endpoints route through the same notificationservice_ base via the URL-traversal trick. Methods: getAll, getPublishers, getSupportedChannels — the three read-side methods that return user subscription state and tenant channel availability. Mutation methods land in follow-up PRs. Adds SUBSCRIPTION_ENDPOINTS scaffold (3 read URLs), subscription model types (SubscriptionPublisher, SubscriptionTopic, SubscriptionMode, SupportedChannel, AllowedMode, options types), subscription test infrastructure (mock factories), Subscriptions section in oauth-scopes and mkdocs nav, and Subscriptions registration in unified-setup. Tests: 8 unit + 4 integration. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…gory) Adds the two topic/category-scoped subscription writes. Each entry in the payload sets the subscription state for a single (topic, mode) or (category, mode) pair. UPDATE_TOPIC reuses the same URL as GET_ALL — POST vs GET differentiates. Adds TopicSubscriptionUpdate and CategorySubscriptionUpdate types, response types, oauth-scopes entries, and unit + integration tests (updateTopic round-trip; updateCategory unit-only because it needs richer tenant fixtures). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…er, updateTopicGroup) Adds the two broader-scope subscription writes: - updatePublisher: opt-in/out at the publisher level, optionally scoped to specific entities (folders, etc.) - updateTopicGroup: scope a named topic group to a set of entities API spec misspells the publisher key as `publisherID`; the SDK preserves the typo at send time and keeps the public surface clean (`publisherId`). Adds PublisherSubscriptionUpdate + TopicGroupSubscriptionUpdate types, response types, oauth-scopes entries, 5 new unit tests, and an updatePublisher round-trip integration test. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Final two methods completing the Subscriptions service: - updateMode: activate/deactivate a notification channel (Email/Slack/Teams) for a publisher. Check getSupportedChannels first. - reset: restore a publisher's subscriptions to its defaults, returning the post-reset state. Adds UPDATE_MODE + RESET endpoints, SubscriptionUpdateModeResponse type, oauth-scopes entries, 5 new unit tests, and a reset integration test. This completes the 7-PR stack onboarding the Notification + Subscriptions services (15 methods total). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
|
✅ No issues found. Checked for bugs and CLAUDE.md compliance. |
…pes entries Final piece of the @internal treatment across the 7-PR stack. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
|
✅ No issues found. Checked for bugs and CLAUDE.md compliance. |
sarthak688
force-pushed
the
feat/subscriptions-publisher-updates
branch
from
July 22, 2026 06:15
6544536 to
71115d6
Compare
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
1 participant
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.
PR 7/7 — final PR in the Notification SDK stack. Stacked on top of #518. Completes the 15-method onboarding.
Adds the last two Subscriptions methods: channel activation and restore-defaults.
Methods Added
subscriptions.updateMode()updateMode(tenantId: string, publisherId: string, mode: AllowedMode): Promise<SubscriptionUpdateModeResponse>subscriptions.reset()reset(tenantId: string, publisherId: string): Promise<SubscriptionGetResponse>Endpoints Called
updateMode()notificationservice_/usersubscriptionservice/api/v1/UserSubscription/UpdateModeNotificationServicereset()notificationservice_/usersubscriptionservice/api/v1/UserSubscription/ResetNotificationServiceupdateModeactivates/deactivates a single channel (Email/Slack/Teams) for a publisher. Themodeargument is{ name: NotificationMode, isActive: boolean }. Pair withgetSupportedChannelsfirst to avoid activating a channel that's disabled at the tenant level.resetis special among the writes — it returns the publisher's post-reset subscription state (same shape asgetAll), not an empty operation response. Useful for refreshing client state after a reset without an extra round-trip.Example Usage
API Response vs SDK Response
updateMode{ success: true, data: { publisherId, mode } }reset{ publishers: [...] }(same shape asgetAll/getPublishers)Verification
npm run typechecknpm run lintnpm run test:unitnpm run builddist/notifications/index.{mjs,cjs,d.ts}producedIntegration:
resetround-trip — call reset on the first visible publisher, confirm the response includes that publisher.updateModeis unit-only because it needs an active Slack/Teams channel on the test tenant to exercise the full path.Files
src/utils/constants/endpoints/notification.ts(UPDATE_MODE,RESET)src/models/notification/subscriptions.models.ts(SubscriptionUpdateModeResponse+ ServiceModel methods)src/services/notification/subscriptions.tstests/unit/services/notification/subscriptions.test.ts(+5 tests)tests/integration/shared/notification/subscriptions.integration.test.ts(+1 reset test)docs/oauth-scopes.mdEnd-of-Stack Summary
This PR closes the 7-PR stack onboarding the Notifications + Subscriptions services:
feat/notifications-sdkgetAllfeat/notifications-mark-readmarkRead,markUnread,markAllReadfeat/notifications-deletedeleteNotifications,deleteAllfeat/subscriptions-sdkgetAll,getPublishers,getSupportedChannelsfeat/subscriptions-topic-updatesupdateTopic,updateCategoryfeat/subscriptions-publisher-updatesupdatePublisher,updateTopicGroupfeat/subscriptions-mode-reset(this PR)updateMode,resetTotal: 15 methods, 36 unit tests, 11 integration tests across 7 reviewable PRs. Each PR builds on the previous one; merge top-down.
Replaces #500.
🤖 Generated with Claude Code