refactor(api-client, schema): Add workspace's schemas and types in @keyshade/schema

[muntaxir4]

User description

• Modify tsconfig to include strictNullChecks:true in order to fix properties becoming optional.
• Create zod schemas and types for workspace and include additional tests.
• Add extra required schemas: PageRequest, PageResponse, ResponseError and ClientResponse in pagination folder. Additionally create tests for this.
• Add the schema package as a dependency for api-client and update the existing code to replace dependencies on the workspace's types with the new types from the schema package for better compatibility.

Related to #519

Description

The changes aim to improve schema validation, update dependencies, and enhance test coverage for Workspace schemas.

Affected apps: packages/api-client and packages/schema

Dependencies

N/A

Future Improvements

N/A

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

---

Description

• Introduced new Zod schemas for workspace operations, including CRUD, data export, and global search.
• Added extensive test cases to validate the new workspace schemas and ensure proper error handling.
• Updated the api-client to use the new schema package, replacing old workspace types.
• Configured the schema package with necessary dependencies and exports.
• Updated pnpm-lock.yaml to reflect changes in dependencies and package versions.

---

Changes walkthrough 📝

	Relevant files
Tests	workspace.spec.ts Add test cases for workspace schemas validation                    packages/schema/tests/workspace.spec.ts Added extensive test cases for new workspace schemas. Validated input for various workspace-related schemas. Ensured proper error handling for invalid inputs. +394/-1
Enhancement	workspace.ts Define Zod schemas for workspace operations                            packages/schema/src/workspace/workspace.ts Defined new Zod schemas for workspace operations. Included request and response schemas for CRUD operations. Added schemas for data export and global search. +155/-0  index.ts Add pagination and response schemas                                            packages/schema/src/index.ts Introduced pagination and response error schemas. Added client response schema for API responses. Exported new workspace schemas. +52/-2    workspace.types.ts Create TypeScript types for workspace schemas                        packages/schema/src/workspace/workspace.types.ts Created TypeScript types for workspace schemas. Mapped Zod schemas to TypeScript types. +62/-0    workspace.ts Update workspace controller to use new schemas                      packages/api-client/src/controllers/workspace.ts Updated imports to use new schema package. Replaced old workspace types with new schema types. +2/-2
Dependencies	pnpm-lock.yaml Update dependencies for schema integration                              pnpm-lock.yaml Updated dependencies to include new schema package. Adjusted package versions and dependencies. +260/-133 package.json Add schema package dependency                                                        packages/api-client/package.json Added schema package as a dependency. +3/-1
Configuration changes	package.json Configure schema package dependencies and exports                packages/schema/package.json Added Zod as a dependency. Configured exports for the schema package. +6/-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:

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

🧪 PR contains tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Possible Oversight The UpdateWorkspaceRequestSchema extends CreateWorkspaceRequestSchema.partial(), which might allow updating fields that should be immutable after creation. Consider explicitly defining which fields can be updated. Type Safety The ClientResponseSchema uses .nullable() for both error and data fields. This might lead to ambiguous states where both fields are null. Consider using a union type instead to ensure only one is defined at a time. Test Coverage While there are many test cases, some schemas like InviteMemberSchema lack comprehensive tests. Consider adding more test cases to cover all possible scenarios and edge cases.

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Best practice	✅ Use a more appropriate data type for date fields to ensure data integrity Suggestion Impact: The rotateAt field was changed from z.string() to rotateAfterEnum, which suggests an improvement in type safety, similar to the suggestion's intent. code diff: - rotateAt: z.string(), + rotateAt: rotateAfterEnum, The rotateAt field in the secrets array is currently defined as a string. Consider using z.date() instead to ensure it's a valid date. packages/schema/src/workspace/workspace.ts [96] -rotateAt: z.string(), +rotateAt: z.date(), Apply this suggestion Suggestion importance[1-10]: 8 Why: Using z.date() instead of z.string() for date fields is a significant improvement. It ensures proper date validation and can prevent issues related to invalid date formats.	8
Enhancement	Implement stricter validation for color code fields to ensure they are valid hex color codes Consider using a more specific type for the colorCode field in the workspaceRoles array. Instead of using z.string(), you could use a regex pattern to ensure it's a valid hex color code. packages/schema/src/workspace/workspace.ts [73] -colorCode: z.string(), +colorCode: z.string().regex(/^#[0-9A-Fa-f]{6}$/), Apply this suggestion Suggestion importance[1-10]: 7 Why: This suggestion improves data validation by ensuring that color codes are in the correct format. It's a valuable enhancement that can prevent potential issues with invalid color codes.	7
	Add constraints to numeric fields to prevent invalid input values In the PageRequestSchema, consider adding constraints to the page and limit fields to ensure they are positive integers. packages/schema/src/index.ts [4-5] -page: z.number().optional(), -limit: z.number().optional(), +page: z.number().int().positive().optional(), +limit: z.number().int().positive().optional(), Apply this suggestion Suggestion importance[1-10]: 7 Why: Adding constraints to ensure positive integers for page and limit fields is a valuable enhancement. It prevents potential issues with invalid pagination parameters, improving the robustness of the API.	7
	✅ Add TypeScript declaration file specification for improved type support Consider adding a "types" field to specify the TypeScript declaration file for better type support when other packages import this schema package. packages/schema/package.json [4-9] "main": "dist/src/index.js", +"types": "dist/src/index.d.ts", "description": "This package holds the schemas that other applications can use to validate the input data.", "private": true, "exports": { - ".": "./dist/src/index.js" + ".": { + "types": "./dist/src/index.d.ts", + "default": "./dist/src/index.js" + } }, [Suggestion has been applied] Suggestion importance[1-10]: 7 Why: This suggestion improves TypeScript integration by explicitly specifying the types file, enhancing type support for consumers of the schema package.	7
Maintainability	✅ Define enums separately to improve code organization and reusability Suggestion Impact: The accessLevel field was changed to use a separately defined enum, projectAccessLevelEnum, as suggested. code diff: - accessLevel: z.enum(['GLOBAL', 'PRIVATE', 'INTERNAL']), + accessLevel: projectAccessLevelEnum, The accessLevel field in the projects array uses an enum with string literals. Consider defining this enum separately for better reusability and maintainability. packages/schema/src/workspace/workspace.ts [84] -accessLevel: z.enum(['GLOBAL', 'PRIVATE', 'INTERNAL']), +accessLevel: ProjectAccessLevelEnum, Apply this suggestion Suggestion importance[1-10]: 6 Why: Defining enums separately enhances code maintainability and reusability. While it's a good practice, the impact is moderate as it primarily affects code organization rather than functionality.	6

💡 Need additional feedback ? start a PR chat

[rajdip-b]

Think you missed this

[rajdip-b]

I think this looks good. I'll set up this PR locally and test it out

[rajdip-b]

The code looks perfect to me. Once you make the changes, we can merge

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.29%. Comparing base (ce50743) to head (bc3412c).
Report is 213 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #520      +/-   ##
===========================================
+ Coverage    91.71%   96.29%   +4.58%     
===========================================
  Files          111       23      -88     
  Lines         2510      351    -2159     
  Branches       469        8     -461     
===========================================
- Hits          2302      338    -1964     
+ Misses         208       13     -195     

Flag	Coverage Δ
api-client	95.47% <ø> (?)
api-e2e-tests	?
schema	100.00% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[muntaxir4]

The code looks perfect to me. Once you make the changes, we can merge

Okay, removed the enums directory and kept only enums.ts

[rajdip-b]

LGTM