refactor: Install rest-typings and migrate helper types

Preparation & Setup
- Install @rocket.chat/[email protected]
- Install @rocket.chat/[email protected] (required dependency)
- Explore and document package structure

Helper Types Migration
- Migrate PaginatedRequest to re-export from @rocket.chat/rest-typings
- Migrate PaginatedResult to re-export from @rocket.chat/rest-typings
- Update helpers/index.ts with TODO for future endpoint migration
- Keep custom ResultFor, Serialized, ErrorResult for SDK compatibility

Author: deepak0x

.gitignore

@@ -83,4 +83,10 @@ e2e/e2e_account.ts
 **/e2e_account.js
 **/e2e_account.ts
 
-*.p8
+*.p8
+
+*MIGRATION*.md
+*PHASE_*.md
+migration.md
+scripts/verify-migration-phase.sh
+app/definitions/rest/COMPATIBILITY_LAYER.md

MIGRATION_CHECKLIST.md

@@ -0,0 +1,288 @@
+# Migration Checklist: REST Typings Migration
+
+Use this checklist to track progress through each phase. Check off items as you complete them.
+
+## Phase 0: Preparation & Setup
+- [ ] Install `@rocket.chat/rest-typings` package
+- [ ] Explore package exports: `npm view @rocket.chat/rest-typings@latest`
+- [ ] Check package structure and available exports
+- [ ] Document package structure and exports
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Create feature branch: `git checkout -b refactor/rest-typings-phase0`
+
+## Phase 1: Helper Types Migration
+- [ ] Check if rest-typings provides PaginatedRequest/PaginatedResult
+- [ ] Review `app/definitions/rest/helpers/index.ts` structure
+- [ ] Create compatibility layer if needed
+- [ ] Update helper types to work with rest-typings
+- [ ] Test type utilities (PathFor, OperationParams, ResultFor)
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Commit changes: `git commit -m "refactor: migrate helper types to rest-typings"`
+
+## Phase 2: Core Infrastructure
+- [ ] Review `app/lib/services/sdk.ts` current implementation
+- [ ] Review `app/lib/hooks/useEndpointData.ts` current implementation
+- [ ] Update SDK imports to use rest-typings
+- [ ] Update useEndpointData hook imports
+- [ ] Create bridge file `app/definitions/rest/v1/index.ts` that re-exports from package
+- [ ] Test SDK type checking
+- [ ] Test useEndpointData hook
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Test basic SDK functionality
+- [ ] Commit changes: `git commit -m "refactor: update core infrastructure for rest-typings"`
+
+## Phase 3: Simple Endpoint Categories
+
+### subscriptions.ts
+- [ ] Remove `app/definitions/rest/v1/subscriptions.ts`
+- [ ] Update imports in `app/lib/services/restApi.ts`
+- [ ] Verify type compatibility
+- [ ] Test subscription functionality
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Commit: `git commit -m "refactor: migrate subscriptions endpoints to rest-typings"`
+
+### push.ts
+- [ ] Remove `app/definitions/rest/v1/push.ts`
+- [ ] Update imports
+- [ ] Verify type compatibility
+- [ ] Test push functionality
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Commit: `git commit -m "refactor: migrate push endpoints to rest-typings"`
+
+### customUserStatus.ts
+- [ ] Remove `app/definitions/rest/v1/customUserStatus.ts`
+- [ ] Update imports
+- [ ] Verify type compatibility
+- [ ] Test custom user status functionality
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Commit: `git commit -m "refactor: migrate customUserStatus endpoints to rest-typings"`
+
+### directory.ts
+- [ ] Remove `app/definitions/rest/v1/directory.ts`
+- [ ] Update imports
+- [ ] Verify type compatibility
+- [ ] Test directory functionality
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Commit: `git commit -m "refactor: migrate directory endpoints to rest-typings"`
+
+### permissions.ts
+- [ ] Remove `app/definitions/rest/v1/permissions.ts`
+- [ ] Update imports
+- [ ] Verify type compatibility
+- [ ] Test permissions functionality
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Commit: `git commit -m "refactor: migrate permissions endpoints to rest-typings"`
+
+### roles.ts
+- [ ] Remove `app/definitions/rest/v1/roles.ts`
+- [ ] Update imports
+- [ ] Verify type compatibility
+- [ ] Test roles functionality
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Commit: `git commit -m "refactor: migrate roles endpoints to rest-typings"`
+
+## Phase 4: Medium Complexity Categories
+
+### commands.ts
+- [ ] Remove `app/definitions/rest/v1/commands.ts`
+- [ ] Update imports
+- [ ] Handle type differences
+- [ ] Test command functionality
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Commit: `git commit -m "refactor: migrate commands endpoints to rest-typings"`
+
+### e2e.ts
+- [ ] Remove `app/definitions/rest/v1/e2e.ts`
+- [ ] Update imports
+- [ ] Handle type differences
+- [ ] Test E2E functionality
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Commit: `git commit -m "refactor: migrate e2e endpoints to rest-typings"`
+
+### settings.ts
+- [ ] Remove `app/definitions/rest/v1/settings.ts`
+- [ ] Update imports
+- [ ] Handle type differences
+- [ ] Test settings functionality
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Commit: `git commit -m "refactor: migrate settings endpoints to rest-typings"`
+
+### autotranslate.ts
+- [ ] Remove `app/definitions/rest/v1/autotranslate.ts`
+- [ ] Update imports
+- [ ] Handle type differences
+- [ ] Test autotranslate functionality
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Commit: `git commit -m "refactor: migrate autotranslate endpoints to rest-typings"`
+
+### moderation.ts
+- [ ] Remove `app/definitions/rest/v1/moderation.ts`
+- [ ] Update imports
+- [ ] Handle type differences
+- [ ] Test moderation functionality
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Commit: `git commit -m "refactor: migrate moderation endpoints to rest-typings"`
+
+### videoConference.ts
+- [ ] Remove `app/definitions/rest/v1/videoConference.ts`
+- [ ] Update imports
+- [ ] Handle type differences
+- [ ] Test video conference functionality
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Commit: `git commit -m "refactor: migrate videoConference endpoints to rest-typings"`
+
+## Phase 5: High Complexity Categories
+
+### users.ts
+- [ ] Remove `app/definitions/rest/v1/users.ts`
+- [ ] Update all imports in `app/lib/services/restApi.ts`
+- [ ] Handle type differences carefully
+- [ ] Test user management functionality thoroughly
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Manual testing of user flows
+- [ ] Commit: `git commit -m "refactor: migrate users endpoints to rest-typings"`
+
+### rooms.ts
+- [ ] Remove `app/definitions/rest/v1/rooms.ts`
+- [ ] Update all imports
+- [ ] Handle type differences carefully
+- [ ] Test room operations thoroughly
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Manual testing of room flows
+- [ ] Commit: `git commit -m "refactor: migrate rooms endpoints to rest-typings"`
+
+### chat.ts
+- [ ] Remove `app/definitions/rest/v1/chat.ts`
+- [ ] Update all imports
+- [ ] Handle type differences carefully
+- [ ] Test chat/messaging functionality thoroughly
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Manual testing of messaging flows
+- [ ] Commit: `git commit -m "refactor: migrate chat endpoints to rest-typings"`
+
+### channels.ts
+- [ ] Remove `app/definitions/rest/v1/channels.ts`
+- [ ] Update all imports
+- [ ] Handle type differences carefully
+- [ ] Test channel operations thoroughly
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Manual testing of channel flows
+- [ ] Commit: `git commit -m "refactor: migrate channels endpoints to rest-typings"`
+
+### groups.ts
+- [ ] Remove `app/definitions/rest/v1/groups.ts`
+- [ ] Update all imports
+- [ ] Handle type differences carefully
+- [ ] Test group operations thoroughly
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Manual testing of group flows
+- [ ] Commit: `git commit -m "refactor: migrate groups endpoints to rest-typings"`
+
+### im.ts
+- [ ] Remove `app/definitions/rest/v1/im.ts`
+- [ ] Update all imports
+- [ ] Handle type differences carefully
+- [ ] Test direct message functionality thoroughly
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Manual testing of DM flows
+- [ ] Commit: `git commit -m "refactor: migrate im endpoints to rest-typings"`
+
+### dm.ts
+- [ ] Remove `app/definitions/rest/v1/dm.ts`
+- [ ] Update all imports
+- [ ] Handle type differences carefully
+- [ ] Test DM operations thoroughly
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Manual testing of DM flows
+- [ ] Commit: `git commit -m "refactor: migrate dm endpoints to rest-typings"`
+
+### teams.ts
+- [ ] Remove `app/definitions/rest/v1/teams.ts`
+- [ ] Update all imports
+- [ ] Handle type differences carefully
+- [ ] Test team operations thoroughly
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Manual testing of team flows
+- [ ] Commit: `git commit -m "refactor: migrate teams endpoints to rest-typings"`
+
+### emojiCustom.ts
+- [ ] Remove `app/definitions/rest/v1/emojiCustom.ts`
+- [ ] Update all imports
+- [ ] Handle type differences carefully
+- [ ] Test custom emoji functionality thoroughly
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Manual testing of emoji flows
+- [ ] Commit: `git commit -m "refactor: migrate emojiCustom endpoints to rest-typings"`
+
+### invites.ts
+- [ ] Remove `app/definitions/rest/v1/invites.ts`
+- [ ] Update all imports
+- [ ] Handle type differences carefully
+- [ ] Test invite functionality thoroughly
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Manual testing of invite flows
+- [ ] Commit: `git commit -m "refactor: migrate invites endpoints to rest-typings"`
+
+### omnichannel.ts
+- [ ] Remove `app/definitions/rest/v1/omnichannel.ts`
+- [ ] Update all imports
+- [ ] Handle type differences carefully (this is complex!)
+- [ ] Test omnichannel functionality thoroughly
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Manual testing of omnichannel flows
+- [ ] Commit: `git commit -m "refactor: migrate omnichannel endpoints to rest-typings"`
+
+## Phase 6: File Upload & Final Cleanup
+- [ ] Update `app/lib/methods/helpers/fileUpload/index.ts`
+- [ ] Update `app/lib/methods/helpers/fileUpload/definitions.ts`
+- [ ] Update `app/lib/methods/helpers/fileUpload/Upload.ts`
+- [ ] Update `app/lib/methods/helpers/fileUpload/Upload.android.ts`
+- [ ] Final cleanup of `app/lib/services/restApi.ts`
+- [ ] Remove any remaining old imports
+- [ ] Test file upload functionality
+- [ ] Run `yarn lint` - must pass with 0 errors
+- [ ] Run `tsc --noEmit` - must pass
+- [ ] Commit: `git commit -m "refactor: update file upload utilities and final cleanup"`
+
+## Phase 7: Verification & Documentation
+- [ ] Run full test suite: `yarn test`
+- [ ] Verify all REST endpoints are typed correctly
+- [ ] Check for any remaining references to old definitions
+- [ ] Update documentation if needed
+- [ ] Remove old definition files (if not done already)
+- [ ] Final `yarn lint` check - must pass with 0 errors
+- [ ] Final `tsc --noEmit` check - must pass
+- [ ] Create migration summary document
+- [ ] Final commit: `git commit -m "refactor: complete migration to rest-typings"`
+
+## Final Steps
+- [ ] Create PR with all changes
+- [ ] Request code review
+- [ ] Address review comments
+- [ ] Merge to main branch
+