feat(schema, api-client): Migrate workspace-role schemas and types to @keyshade/schema

[muntaxir4]

User description

Description

@keyshade/schema

• Add schemas and types for workspace-role.
• Add tests for workspace-role schemas.
• Export workpsace-role schemas from index and its types from index.types .

@keyshade/api-client

• Remove existing workspace-role.types.d.ts.
• Change imports for workpsace-role types to @keyshade/schema.
  

Also fix lint error by upgrading eslint-config-turbo to 2.3.1

Related to #519

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, tests, other

---

Description

• Migrated workspace-role schemas and types to @keyshade/schema.
• Added comprehensive tests for workspace-role schemas, covering both valid and invalid scenarios.
• Removed old workspace-role.types.d.ts and updated import paths to use new types from @keyshade/schema.
• Updated eslint-config-turbo and turbo package versions, and removed @swc/helpers dependency.
• Adjusted tsconfig base path for api-client.

---

Changes walkthrough 📝

	Relevant files
Tests	2 files workspace-role.spec.ts Add tests for workspace role schemas and validations          packages/schema/tests/workspace-role.spec.ts Added comprehensive tests for various workspace role schemas. Included validation tests for request and response schemas. Ensured tests cover both valid and invalid scenarios. +453/-15 workspace-role.spec.ts Update workspace role type imports in tests                            packages/api-client/tests/workspace-role.spec.ts Updated import paths for workspace role types. Switched to using types from @keyshade/schema. +1/-1
Enhancement	4 files index.ts Define workspace role schemas using zod                                    packages/schema/src/workspace-role/index.ts Introduced multiple schemas for workspace role operations. Defined request and response schemas for CRUD operations. Utilized zod for schema definitions and validations. +77/-0    index.types.ts Add TypeScript types for workspace role schemas                    packages/schema/src/workspace-role/index.types.ts Created TypeScript types inferred from workspace role schemas. Exported types for use in other modules. +67/-0    index.types.ts Update exports for workspace role types                                    packages/schema/src/index.types.ts Removed old workspace role schema types. Exported new workspace role types from updated schema. +1/-9      workspace-role.ts Update imports for workspace role types in controller        packages/api-client/src/controllers/workspace-role.ts Changed import paths for workspace role types. Utilized types from @keyshade/schema. +1/-1
Dependencies	2 files package.json Update eslint-config-turbo version in package.json              packages/eslint-config-custom/package.json Updated eslint-config-turbo dependency version. Ensured package.json formatting consistency. +10/-10  pnpm-lock.yaml Update package versions and remove `@swc/helpers` dependency pnpm-lock.yaml Removed @swc/helpers from various package versions. Updated turbo package versions from 1.13.4 to 2.3.3. Adjusted dependencies to reflect the removal of @swc/helpers. Updated eslint-config-turbo and eslint-plugin-turbo versions. +140/-278
Configuration changes	1 files tsconfig.json Adjust tsconfig base path for api-client                                  packages/api-client/tsconfig.json Modified the path for extending base tsconfig. +1/-1

---

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

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅ 519 - Fully compliant Compliant requirements: Created workspace-role folder in schema with proper structure Added zod schemas in workspace-role.ts Added type exports in workspace-role.types.ts Updated api-client imports to use schema types

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 PR contains tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Code Smell The WorkspaceRoleSchema has nested object structures that could be extracted into separate schemas for better reusability and maintainability

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
General	Add hex color code format validation to prevent invalid color values Add validation for color code format to ensure it's a valid hex color code. Currently the schema accepts any string as a color code. packages/schema/src/workspace-role/index.ts [12] -colorCode: z.string().nullable(), +colorCode: z.string().regex(/^#[0-9A-Fa-f]{6}$/).nullable(), Apply this suggestion Suggestion importance[1-10]: 8 Why: Adding regex validation for hex color codes is important to prevent invalid color values that could cause UI issues or data inconsistency. The current implementation accepts any string format.	8
	Add length constraints to text fields to ensure data quality Add validation for minimum and maximum length constraints on name and description fields to prevent overly long or empty values. packages/schema/src/workspace-role/index.ts [9-11] -name: z.string(), -description: z.string().nullable(), +name: z.string().min(1).max(100), +description: z.string().max(500).nullable(), Apply this suggestion Suggestion importance[1-10]: 7 Why: Adding length constraints to name and description fields is valuable for preventing data quality issues and potential UI/storage problems from overly long or empty values.	7
Possible issue	✅ Fix incorrect path resolution for extending base TypeScript configuration The path to the base tsconfig should be relative to node_modules since tsconfig is a workspace package. Change the extends path to use the package name. packages/api-client/tsconfig.json [2] { - "extends": "tsconfig/base.json", + "extends": "../tsconfig/base.json", "compilerOptions": { "baseUrl": ".", } [Suggestion has been applied] Suggestion importance[1-10]: 8 Why: The suggestion correctly identifies that using "tsconfig/base.json" will fail since TypeScript resolves paths relative to node_modules for workspace packages. Using "../tsconfig/base.json" ensures proper path resolution.	8

💡 Need additional feedback ? start a PR chat