feat(users): add user restriction endpoints

[commonly-ts]

Description

Includes all current UserRestriction endpoints according to the cloud API reference.

Type of Change

• ✨ New feature (non-breaking change which adds functionality)
• ✅ Test update
• 📦 Dependency update

Changes Made

• Added listUserRestrictions to users resource
• Added listUserRestrictionLogs to users resource
• Added updateUserRestriction to users resource
• Added getUserRestriction to users resource
• Added relevant typings for the above methods
• Added tests for all the above methods
• Installed the uuid package for generating the idempotency key

Testing

• All existing tests pass (pnpm test)
• Added new tests for new functionality
• Tested manually (describe below)

Manual Testing

With the below code, it calls the Roblox API and confirms data has been returned. It also logged the results for manual review of the response.

Invalid universeId and missing credentials (missing/invalid scopes) return OpenCloudError: Unauthorized: invalid or missing Open Cloud credentials.

describe("Users: UserRestriction Integration", () => {
  const client = new OpenCloud({
    apiKey: "actual-api-key",
    baseUrl
  });

  it("should listUserRestrictions", async () => {
    const result = await client.users.listUserRestrictions("4434277335");
    console.log(result);
    expect(result.userRestrictions).toBeDefined();
  });

  it("should getUserRestriction", async () => {
    const result = await client.users.getUserRestriction("4434277335", "1210019099");
    console.log(result);
    expect(result).toBeDefined();
  });

  it("should updateUserRestriction", async () => {
    const result = await client.users.updateUserRestriction("4434277335", "1210019099", {
      active: true,
      displayReason: "Test ban",
      privateReason: "integration test",
      duration: "3s",
      excludeAltAccounts: false,
    });
    console.log(result);
    expect(result).toBeDefined();
  });

  it("should listUserRestrictionLogs", async () => {
    const result = await client.users.listUserRestrictionLogs("4434277335");
    console.log(result);
    expect(result.logs).toBeDefined();
  });
});

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

Screenshots/Recordings

Additional Context

For some reason Roblox decided to call the user Ids "user_restriction_id," so in this "user_restriction_id" just means a Roblox user Id.

updateUserRestriction does support FieldMasks through its updateMask query parameter, but only game_join_restriction can be passed due to it only being able to be updated atomically.

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]

Along with the uninstallation of the dependency, we might need to look into merging this into #2 as UserRestriction falls under the universes resource (/cloud/v2/universes/)

[marinofranz]

Remove package-lock.json as this codebase uses pnpm

[codecov]

Codecov Report

❌ Patch coverage is 96.15385% with 3 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/resources/users.ts	96.15%	3 Missing ⚠️

📢 Thoughts on this report? Let us know!

[commonly-ts]

Along with the uninstallation of the dependency, we might need to look into merging this into #2 as UserRestriction falls under the universes resource (/cloud/v2/universes/)

Roblox's Cloud API reference does list it under Users and Groups, which is why I put it under users.ts 🤷

[marinofranz]

Along with the uninstallation of the dependency, we might need to look into merging this into #2 as UserRestriction falls under the universes resource (/cloud/v2/universes/)

Roblox's Cloud API reference does list it under Users and Groups, which is why I put it under users.ts 🤷

Yeah, we thought the same but we eventually decided to group resources by URL. We've found a few inaccuracies with the Roblox Open Cloud API documentation such as this, but your changes will still come to use, we just need to move them over to the feature branch for universes.

Let's keep this PR open and I'll squash-merge your changes into the branch for #2 and move the implementation
I'll let you know of any progress 🙂

[commonly-ts]

Along with the uninstallation of the dependency, we might need to look into merging this into #2 as UserRestriction falls under the universes resource (/cloud/v2/universes/)

Roblox's Cloud API reference does list it under Users and Groups, which is why I put it under users.ts 🤷

Yeah, we thought the same but we eventually decided to group resources by URL. We've found a few inaccuracies with the Roblox Open Cloud API documentation such as this, but your changes will still come to use, we just need to move them over to the feature branch for universes.

Let's keep this PR open and I'll squash-merge your changes into the branch for #2 and move the implementation
I'll let you know of any progress 🙂

Just asking, is there a specific way you want me to publish PRs if they're a new resource and/or one like the universe endpoints branch?

[marinofranz]

Along with the uninstallation of the dependency, we might need to look into merging this into #2 as UserRestriction falls under the universes resource (/cloud/v2/universes/)

Roblox's Cloud API reference does list it under Users and Groups, which is why I put it under users.ts 🤷

Yeah, we thought the same but we eventually decided to group resources by URL. We've found a few inaccuracies with the Roblox Open Cloud API documentation such as this, but your changes will still come to use, we just need to move them over to the feature branch for universes.
Let's keep this PR open and I'll squash-merge your changes into the branch for #2 and move the implementation
I'll let you know of any progress 🙂

Just asking, is there a specific way you want me to publish PRs if they're a new resource and/or one like the universe endpoints branch?

Usually you should just send in a PR and it'll get merged into main but in this case, a PR for the creation of this resource had already been created, so it complicated things a little, but we'll sort it out 😄

[marinofranz]

Hey @commonly-ts - got an update for you

I've integrated your changes in this PR to our ongoing Universes API implementation in #2
The core logic and typings you added are now part of PR #2 (with you credited as a co-author in the commit). We just moved the functions to the appropriate files to keep things consistent with the resource layout of the SDK

Thanks again for your contribution 🎉
Once #2 is merged, this PR will effectively be covered, so we'll close it at that point 🙂

[commonly-ts]

Hey @commonly-ts - got an update for you

I've integrated your changes in this PR to our ongoing Universes API implementation in #2 The core logic and typings you added are now part of PR #2 (with you credited as a co-author in the commit). We just moved the functions to the appropriate files to keep things consistent with the resource layout of the SDK

Thanks again for your contribution 🎉 Once #2 is merged, this PR will effectively be covered, so we'll close it at that point 🙂

Cheers. Just one thing, could you remove my email from the commit message, or replace it with my GitHub no-reply email instead? Thanks!

[marinofranz]

Cheers. Just one thing, could you remove my email from the commit message, or replace it with my GitHub no-reply email instead? Thanks!

Not a problem, I've amended the commit and changed the email from the co-author line 😄