Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(schema): Add User type inference from UserSchema #574

Merged
merged 1 commit into from
Dec 3, 2024
Merged

feat(schema): Add User type inference from UserSchema #574

merged 1 commit into from
Dec 3, 2024

Conversation

muntaxir4
Copy link
Contributor

@muntaxir4 muntaxir4 commented Dec 3, 2024 •
edited by codiumai-pr-agent-free bot
Loading

User description

Description

@keyshade/schema
Exports User type by inferring it from UserSchema

Fixes #573

Developer's checklist

  • My PR follows the style guidelines of this project
  • I have performed a self-check on my work

If changes are made in the code:

  • I have followed the coding guidelines
  • My changes in code generate no new warnings
  • My changes are breaking another fix/feature of the project
  • I have added test cases to show that my feature works
  • I have added relevant screenshots in my PR
  • There are no UI/UX issues

Documentation Update

  • This PR requires an update to the documentation at docs.keyshade.xyz
  • I have made the necessary updates to the documentation, or no documentation changes are required.

PR Type

enhancement

Description

  • Added a new User type to the @keyshade/schema package by inferring it from the UserSchema.
  • This change enhances the schema package by including the missing User entity definitions.

Changes walkthrough 📝

Relevant files
Enhancement
index.types.ts
Add User type inference from UserSchema                                   

packages/schema/src/user/index.types.ts

  • Added import for UserSchema.
  • Introduced a new type User inferred from UserSchema.
    		•  +3/-0     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    @codiumai-pr-agent-free CodiumAI PR-Agent (Free)
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    🎫 Ticket compliance analysis 🔶

    573 - Partially compliant

    Compliant requirements:

    • Added User type inference from UserSchema in @keyshade/schema package

    Non-compliant requirements:

    • No explicit evidence that types are inferred from schema.prisma of api package
    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Code Organization
    Verify that UserSchema import contains all necessary user fields from schema.prisma

    @codiumai-pr-agent-free CodiumAI PR-Agent (Free)
    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @rajdip-b rajdip-b merged commit 84c1db5 into keyshade-xyz:develop Dec 3, 2024
    6 checks passed
    rajdip-b pushed a commit that referenced this pull request Dec 3, 2024
    @semantic-release-bot
    chore(release): 2.8.0 [skip ci]
    9dbd647 
    ## [2.8.0](v2.7.0...v2.8.0) (2024-12-03)

### 🚀 Features

* **api:** Add workspace removal notification email template ([#476](#476)) ([40b754f](40b754f))
* **cli:** Store `metrics_enabled` key in profile config ([#536](#536)) ([9283b22](9283b22))
* **package, api, cli:** Add api-key schemas and types; Fix schema inconsistencies; Minor fix for CLI build errors  ([#557](#557)) ([126d024](126d024))
* **platform:** Added screen for CREATE NEW PROJECT ([#540](#540)) ([b644633](b644633))
* **platform:** Updated the empty state of dashboard ([#522](#522)) ([28739d9](28739d9))
* **schema, api-client:** Migrate auth types to @keyshade/schema ([#532](#532)) ([d880098](d880098))
* **schema, api-client:** Migrate event schemas and types to @keyshade/schema ([#546](#546)) ([a3267de](a3267de))
* **schema, api-client:** Migrate integration schemas and types to @keyshade/schema ([#547](#547)) ([08868c3](08868c3))
* **schema, api-client:** Migrate project schemas and environment schemas along with their types to @keyshade/schema ([#538](#538)) ([c468af0](c468af0))
* **schema, api-client:** Migrate [secure] types and schemas to @keyshade/schema ([#539](#539)) ([bc3100b](bc3100b))
* **schema, api-client:** Migrate user types and schemas to @keyshade/schema ([#535](#535)) ([c24695e](c24695e))
* **schema, api-client:** Migrate variable schemas and types to @keyshade/schema ([#545](#545)) ([0ee8f9a](0ee8f9a))
* **schema, api-client:** Migrate workspace-membership schemas and types to @keyshade/schema ([#569](#569)) ([4398969](4398969))
* **schema, api-client:** Migrate workspace-role schemas and types to @keyshade/schema ([#568](#568)) ([9efbf2d](9efbf2d))
* **schema:** Add User type inference from UserSchema ([#574](#574)) ([84c1db5](84c1db5))

### 🐛 Bug Fixes

* **api:** Incorrect oauth redirect url ([58d96e5](58d96e5))
* **platform:** Resolve loading SVG blocking input field interaction ([#571](#571)) ([30f4f65](30f4f65))

### 📚 Documentation

* Add pictures to Bruno setup ([#541](#541)) ([210c0fd](210c0fd))
* Migrate to Bruno ([#525](#525)) ([1793d92](1793d92))

### 🔧 Miscellaneous Chores

* **ci:** Add script to validate schema package ([59e4280](59e4280))
* Fixed codecov client version ([a998ae4](a998ae4))
* **package:** Fixed tests and did housekeeping ([#544](#544)) ([40008e3](40008e3))
* Update test coverage settings ([5b27e32](5b27e32))
* Update Turbo to 2.3.1 ([#564](#564)) ([3a63823](3a63823))
* **web:** Update dockerfile ([10d9cc5](10d9cc5))

### 🔨 Code Refactoring

* **api-client, schema:** Add workspace's schemas and types in @keyshade/schema ([#520](#520)) ([7c8ee5d](7c8ee5d))
    @muntaxir4 muntaxir4 deleted the export-userSchema-type branch December 4, 2024 21:52
    muntaxir4 added a commit to muntaxir4/keyshade that referenced this pull request Jan 1, 2025
    @muntaxir4
    feat(schema): Add User type inference from UserSchema (keyshade-xyz#574)
    e619c72
    muntaxir4 pushed a commit to muntaxir4/keyshade that referenced this pull request Jan 1, 2025
    @semantic-release-bot @muntaxir4
    chore(release): 2.8.0 [skip ci]
    ef29602 
    ## [2.8.0](keyshade-xyz/keyshade@v2.7.0...v2.8.0) (2024-12-03)

### 🚀 Features

* **api:** Add workspace removal notification email template ([keyshade-xyz#476](keyshade-xyz#476)) ([40b754f](keyshade-xyz@40b754f))
* **cli:** Store `metrics_enabled` key in profile config ([keyshade-xyz#536](keyshade-xyz#536)) ([9283b22](keyshade-xyz@9283b22))
* **package, api, cli:** Add api-key schemas and types; Fix schema inconsistencies; Minor fix for CLI build errors  ([keyshade-xyz#557](keyshade-xyz#557)) ([126d024](keyshade-xyz@126d024))
* **platform:** Added screen for CREATE NEW PROJECT ([keyshade-xyz#540](keyshade-xyz#540)) ([b644633](keyshade-xyz@b644633))
* **platform:** Updated the empty state of dashboard ([keyshade-xyz#522](keyshade-xyz#522)) ([28739d9](keyshade-xyz@28739d9))
* **schema, api-client:** Migrate auth types to @keyshade/schema ([keyshade-xyz#532](keyshade-xyz#532)) ([d880098](keyshade-xyz@d880098))
* **schema, api-client:** Migrate event schemas and types to @keyshade/schema ([keyshade-xyz#546](keyshade-xyz#546)) ([a3267de](keyshade-xyz@a3267de))
* **schema, api-client:** Migrate integration schemas and types to @keyshade/schema ([keyshade-xyz#547](keyshade-xyz#547)) ([08868c3](keyshade-xyz@08868c3))
* **schema, api-client:** Migrate project schemas and environment schemas along with their types to @keyshade/schema ([keyshade-xyz#538](keyshade-xyz#538)) ([c468af0](keyshade-xyz@c468af0))
* **schema, api-client:** Migrate [secure] types and schemas to @keyshade/schema ([keyshade-xyz#539](keyshade-xyz#539)) ([bc3100b](keyshade-xyz@bc3100b))
* **schema, api-client:** Migrate user types and schemas to @keyshade/schema ([keyshade-xyz#535](keyshade-xyz#535)) ([c24695e](keyshade-xyz@c24695e))
* **schema, api-client:** Migrate variable schemas and types to @keyshade/schema ([keyshade-xyz#545](keyshade-xyz#545)) ([0ee8f9a](keyshade-xyz@0ee8f9a))
* **schema, api-client:** Migrate workspace-membership schemas and types to @keyshade/schema ([keyshade-xyz#569](keyshade-xyz#569)) ([4398969](keyshade-xyz@4398969))
* **schema, api-client:** Migrate workspace-role schemas and types to @keyshade/schema ([keyshade-xyz#568](keyshade-xyz#568)) ([9efbf2d](keyshade-xyz@9efbf2d))
* **schema:** Add User type inference from UserSchema ([keyshade-xyz#574](keyshade-xyz#574)) ([84c1db5](keyshade-xyz@84c1db5))

### 🐛 Bug Fixes

* **api:** Incorrect oauth redirect url ([58d96e5](keyshade-xyz@58d96e5))
* **platform:** Resolve loading SVG blocking input field interaction ([keyshade-xyz#571](keyshade-xyz#571)) ([30f4f65](keyshade-xyz@30f4f65))

### 📚 Documentation

* Add pictures to Bruno setup ([keyshade-xyz#541](keyshade-xyz#541)) ([210c0fd](keyshade-xyz@210c0fd))
* Migrate to Bruno ([keyshade-xyz#525](keyshade-xyz#525)) ([1793d92](keyshade-xyz@1793d92))

### 🔧 Miscellaneous Chores

* **ci:** Add script to validate schema package ([59e4280](keyshade-xyz@59e4280))
* Fixed codecov client version ([a998ae4](keyshade-xyz@a998ae4))
* **package:** Fixed tests and did housekeeping ([keyshade-xyz#544](keyshade-xyz#544)) ([40008e3](keyshade-xyz@40008e3))
* Update test coverage settings ([5b27e32](keyshade-xyz@5b27e32))
* Update Turbo to 2.3.1 ([keyshade-xyz#564](keyshade-xyz#564)) ([3a63823](keyshade-xyz@3a63823))
* **web:** Update dockerfile ([10d9cc5](keyshade-xyz@10d9cc5))

### 🔨 Code Refactoring

* **api-client, schema:** Add workspace's schemas and types in @keyshade/schema ([keyshade-xyz#520](keyshade-xyz#520)) ([7c8ee5d](keyshade-xyz@7c8ee5d))
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @rajdip-b rajdip-b rajdip-b approved these changes

    Assignees
    No one assigned
    Labels
    Review effort [1-5]: 1
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.

    SCHEMA: Add User types
    2 participants
    @muntaxir4 @rajdip-b