Skip to content

Conversation

@marinofranz
Copy link
Member

@marinofranz marinofranz commented Oct 24, 2025

Description

Implements the Universe resource on the Open Cloud API.
Closes #3

Type of Change

  • ✨ New feature (non-breaking change which adds functionality)

Testing

  • All existing tests pass (pnpm test)
  • Added new tests for new functionality

Code Quality

  • My code follows the project's coding style
  • I have run pnpm lint and fixed any issues
  • I have run pnpm format to format my code
  • I have run pnpm typecheck and there are no type errors
  • I have reviewed my own code

Documentation

  • I have updated the relevant documentation (if applicable)
  • I have added/updated JSDoc comments for new/modified code

Breaking Changes

Screenshots/Recordings

Additional Context

Checklist

  • I have read the CONTRIBUTING.md guide
  • My PR title follows the Conventional Commits format
  • I have rebased my branch on the latest main branch
  • I have tested my changes against the Roblox Open Cloud API (if applicable)
  • This PR is ready for review

@marinofranz marinofranz added the enhancement New feature or request label Oct 24, 2025
@codecov
Copy link

codecov bot commented Oct 24, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@marinofranz marinofranz force-pushed the feature/universes branch 2 times, most recently from 6451222 to 8645771 Compare October 31, 2025 12:52
@marinofranz marinofranz requested a review from Copilot November 9, 2025 17:37
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds support for the Roblox Universes API by introducing a new Universes resource class with methods for universe management and user restriction operations. It also adds a utility for generating idempotency keys and comprehensive type definitions.

  • New Universes API resource with CRUD operations for universe information and user restrictions
  • Idempotency key generation utility for safely retrying API requests
  • Type definitions for universe-related entities including social links, user restrictions, and age ratings

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 8 comments.

Show a summary per file
File Description
src/resources/universes.ts Implements the Universes API resource with methods for getting/updating universes and managing user restrictions
src/utils/idempotency.ts Adds utility function to generate unique idempotency keys using timestamp and random values
src/types/universes.ts Defines TypeScript interfaces and types for universe entities and related resources
test/idempotency.test.ts Comprehensive test coverage for the idempotency key generation utility
src/index.ts Registers the new Universes resource with the OpenCloud SDK client
Comments suppressed due to low confidence (1)

src/index.ts:73

  • The Universes class should be exported along with Users and Groups for consistency. Add 'export { Universes } from "./resources/universes";' after line 73.
export { Groups } from "./resources/groups";

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@commonly-ts
Copy link
Contributor

looking to use this resource in my bot, when would this get merged and released?

marinofranz and others added 3 commits November 13, 2025 16:16
- getUserRestriction
- updateUserRestriction
- updateUserRestriction
- listUserRestrictionLogs
- types moved to src/types/universes.ts

Co-authored-by: Commonly <51011212+commonly-ts@users.noreply.github.com>
@marinofranz
Copy link
Member Author

looking to use this resource in my bot, when would this get merged and released?

We can merge a base version of this today and add Instance and Place (which realistically belong to this API) resources to this later

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 8 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@marinofranz marinofranz merged commit b04246d into main Nov 13, 2025
8 checks passed
@marinofranz marinofranz deleted the feature/universes branch November 13, 2025 17:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants