feat(schema, api-client): Migrate auth types to @keyshade/schema (#532)

packages/api-client/src/controllers/auth.ts

@@ -1,10 +1,7 @@
-import {
-  ResendOTPResponse,
-  ResendOTPRequest
-} from '@api-client/types/auth.types'
+import { ResendOTPResponse, ResendOTPRequest } from '@keyshade/schema'
 import { APIClient } from '@api-client/core/client'
 import { parseResponse } from '@api-client/core/response-parser'
-import { ClientResponse } from '@api-client/types/index.types'
+import { ClientResponse } from '@keyshade/schema'
 
 export default class AuthController {
   private apiClient: APIClient

packages/api-client/src/controllers/environment.ts

@@ -13,7 +13,7 @@ import {
   UpdateEnvironmentRequest,
   UpdateEnvironmentResponse
 } from '@api-client/types/environment.types'
-import { ClientResponse } from '@api-client/types/index.types'
+import { ClientResponse } from '@keyshade/schema'
 
 export default class EnvironmentController {
   private apiClient: APIClient

packages/api-client/src/controllers/event.ts

@@ -3,7 +3,7 @@ import {
   GetEventsResponse
 } from '@api-client/types/event.types'
 import { APIClient } from '../core/client'
-import { ClientResponse } from '@api-client/types/index.types'
+import { ClientResponse } from '@keyshade/schema'
 import { parseResponse } from '@api-client/core/response-parser'
 
 export default class EventController {

packages/api-client/src/controllers/integration.ts

@@ -11,7 +11,7 @@ import {
   UpdateIntegrationResponse
 } from '@api-client/types/integration.types'
 import { APIClient } from '@api-client/core/client'
-import { ClientResponse } from '@api-client/types/index.types'
+import { ClientResponse } from '@keyshade/schema'
 import { parseResponse } from '@api-client/core/response-parser'
 import { parsePaginationUrl } from '@api-client/core/pagination-parser'
 

packages/api-client/src/controllers/project.ts

@@ -1,4 +1,4 @@
-import { ClientResponse } from '@api-client/types/index.types'
+import { ClientResponse } from '@keyshade/schema'
 import { APIClient } from '@api-client/core/client'
 import {
   CreateProjectRequest,

packages/api-client/src/controllers/secret.ts

@@ -1,5 +1,5 @@
 import { APIClient } from '@api-client/core/client'
-import { ClientResponse } from '@api-client/types/index.types'
+import { ClientResponse } from '@keyshade/schema'
 import { parseResponse } from '@api-client/core/response-parser'
 import {
   CreateSecretRequest,

packages/api-client/src/controllers/user.ts

@@ -1,6 +1,6 @@
 import { APIClient } from '@api-client/core/client'
 import { parseResponse } from '@api-client/core/response-parser'
-import { ClientResponse } from '@api-client/types/index.types'
+import { ClientResponse } from '@keyshade/schema'
 import {
   GetSelfResponse,
   UpdateSelfRequest,

packages/api-client/src/controllers/variable.ts

@@ -1,7 +1,7 @@
 import { APIClient } from '@api-client/core/client'
 import { parsePaginationUrl } from '@api-client/core/pagination-parser'
 import { parseResponse } from '@api-client/core/response-parser'
-import { ClientResponse } from '@api-client/types/index.types'
+import { ClientResponse } from '@keyshade/schema'
 import {
   CreateVariableRequest,
   CreateVariableResponse,

packages/api-client/src/controllers/workspace-membership.ts

@@ -23,7 +23,7 @@ import {
   GetMembersRequest,
   GetMembersResponse
 } from '@api-client/types/workspace-membership.types'
-import { ClientResponse } from '@api-client/types/index.types'
+import { ClientResponse } from '@keyshade/schema'
 
 export default class WorkspaceMembershipController {
   private apiClient: APIClient

packages/api-client/src/controllers/workspace-role.ts

@@ -1,7 +1,7 @@
 import { APIClient } from '@api-client/core/client'
 import { parsePaginationUrl } from '@api-client/core/pagination-parser'
 import { parseResponse } from '@api-client/core/response-parser'
-import { ClientResponse } from '@api-client/types/index.types'
+import { ClientResponse } from '@keyshade/schema'
 import {
   CreateWorkspaceRoleRequest,
   CreateWorkspaceRoleResponse,

packages/api-client/src/core/pagination-parser.ts

@@ -1,4 +1,4 @@
-import { PageRequest } from '@api-client/types/index.types'
+import { PageRequest } from '@keyshade/schema'
 
 /**
  * Constructs a URL by appending the given page request

packages/api-client/src/core/response-parser.ts

@@ -1,4 +1,4 @@
-import { ClientResponse, ResponseError } from '@api-client/types/index.types'
+import { ClientResponse, ResponseError } from '@keyshade/schema'
 
 /**
  * Takes a Response object and parses its contents into a ClientResponse object.

packages/api-client/src/types/environment.types.d.ts

@@ -1,4 +1,4 @@
-import { PageRequest, PageResponse } from './index.types'
+import { PageRequest, PageResponse } from '@keyshade/schema'
 
 export interface Environment {
   id: string

packages/api-client/src/types/event.types.d.ts

@@ -1,4 +1,4 @@
-import { PageResponse } from './index.types'
+import { PageResponse } from '@keyshade/schema'
 
 export enum EventSource {
   SECRET,

packages/api-client/src/types/integration.types.d.ts

@@ -1,4 +1,4 @@
-import { PageRequest, PageResponse } from './index.types'
+import { PageRequest, PageResponse } from '@keyshade/schema'
 
 export enum IntegrationType {
   DISCORD,

packages/api-client/src/types/project.types.d.ts

@@ -1,4 +1,4 @@
-import { PageRequest, PageResponse } from './index.types'
+import { PageRequest, PageResponse } from '@keyshade/schema'
 
 export interface Project {
   id: string

packages/api-client/src/types/secret.types.d.ts

@@ -1,4 +1,4 @@
-import { PageRequest, PageResponse } from './index.types'
+import { PageRequest, PageResponse } from '@keyshade/schema'
 
 export interface Secret {
   id: string

packages/api-client/src/types/user.types.d.ts

@@ -1,4 +1,4 @@
-import { Workspace } from '@api-client/types/workspace.types'
+import { Workspace } from '@keyshade/schema'
 
 export interface GetSelfResponse {
   id: string

packages/api-client/src/types/variable.types.d.ts

@@ -1,4 +1,4 @@
-import { PageRequest, PageResponse } from './index.types'
+import { PageRequest, PageResponse } from '@keyshade/schema'
 
 export interface Variable {
   id: string

packages/api-client/src/types/workspace-role.types.d.ts

@@ -1,4 +1,4 @@
-import { PageRequest, PageResponse } from './index.types'
+import { PageRequest, PageResponse } from '@keyshade/schema'
 
 export interface WorkspaceRole {
   id: string

packages/api-client/tsconfig.json

@@ -7,17 +7,13 @@
       "@api-client/*": ["./src/*"]
     },
     "outDir": "dist",
-    "plugins": [{ "transform": "typescript-transform-paths" }]
+    "plugins": [{ "transform": "typescript-transform-paths" }],
+    "moduleResolution": "Bundler"
   },
   "tsc-alias": {
     "resolveFullPaths": true,
     "verbose": false
   },
-  "include": [
-    "src/**/*.ts",
-    "tests/**/*.ts",
-    "jest.config.ts",
-    ".eslintrc.cjs"
-  ],
+  "include": ["src/**/*.ts", "tests/**/*.ts", "jest.config.ts"],
   "exclude": ["node_modules", "dist"]
 }

packages/schema/package.json

@@ -6,6 +6,10 @@
   "private": true,
   "exports": {
     ".": {
+      "types": "./dist/src/index.types.d.ts",
+      "default": "./dist/src/index.types.js"
+    },
+    "./schemas": {
       "types": "./dist/src/index.d.ts",
       "default": "./dist/src/index.js"
     }

packages/schema/src/auth/auth.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod'
+
+export const ResendOTPRequestSchema = z.object({
+  userEmail: z.string().email()
+})
+
+export const ResendOTPResponseSchema = z.void()

packages/schema/src/auth/auth.types.ts

@@ -0,0 +1,6 @@
+import { z } from 'zod'
+import { ResendOTPRequestSchema, ResendOTPResponseSchema } from './auth'
+
+export type ResendOTPRequest = z.infer<typeof ResendOTPRequestSchema>
+
+export type ResendOTPResponse = z.infer<typeof ResendOTPResponseSchema>

packages/schema/src/index.ts

@@ -1,17 +1,18 @@
 //Export all Schemas and types
 
 export * from './pagination/pagination'
-export * from './pagination/pagination.types'
 
 export * from './api-key'
+
+export * from './auth/auth'
+
 export * from './environment'
 export * from './integration'
 export * from './project'
 export * from './secret'
 export * from './variable'
 
 export * from './workspace/workspace'
-export * from './workspace/workspace.types'
 
 export * from './workspace-role'
 

packages/schema/src/index.types.d.ts → packages/schema/src/index.types.ts

@@ -9,19 +9,20 @@ import {
 } from './project'
 import { CreateSecretSchema, UpdateSecretSchema } from './secret'
 import { CreateVariableSchema, UpdateVariableSchema } from './variable'
-import {
-  CreateWorkspaceSchema,
-  InviteMemberSchema,
-  UpdateWorkspaceSchema
-} from './workspace'
 import {
   CreateWorkspaceRoleSchema,
   UpdateWorkspaceRoleSchema
 } from './workspace-role'
 
+//Export types from pagination.types.ts
+export * from './pagination/pagination.types'
+
 export type TCreateApiKey = z.infer<typeof CreateApiKeySchema>
 export type TUpdateApiKey = z.infer<typeof UpdateApiKeySchema>
 
+// Export types from auth.types.ts
+export * from './auth/auth.types'
+
 export type TCreateEnvironment = z.infer<typeof CreateEnvironmentSchema>
 export type TUpdateEnvironment = z.infer<typeof UpdateEnvironmentSchema>
 
@@ -38,9 +39,8 @@ export type TUpdateSecret = z.infer<typeof UpdateSecretSchema>
 export type TCreateVariable = z.infer<typeof CreateVariableSchema>
 export type TUpdateVariable = z.infer<typeof UpdateVariableSchema>
 
-export type TCreateWorkspace = z.infer<typeof CreateWorkspaceSchema>
-export type TUpdateWorkspace = z.infer<typeof UpdateWorkspaceSchema>
-export type TInviteMember = z.infer<typeof InviteMemberSchema>
+// Export types from workspace.types.ts
+export * from './workspace/workspace.types'
 
 export type TCreateWorkspaceRole = z.infer<typeof CreateWorkspaceRoleSchema>
 export type TUpdateWorkspaceRole = z.infer<typeof UpdateWorkspaceRoleSchema>

packages/schema/src/workspace/workspace.ts

@@ -3,7 +3,7 @@ import { PageRequestSchema, PageResponseSchema } from '@/pagination/pagination'
 import { projectAccessLevelEnum, rotateAfterEnum } from '@/enums'
 
 export const InviteMemberSchema = z.object({
-  email: z.string(),
+  email: z.string().email(),
   roleSlugs: z.array(z.string()).optional()
 })
 
@@ -40,7 +40,7 @@ export const DeleteWorkspaceRequestSchema = z.object({
   workspaceSlug: z.string()
 })
 
-export const DeleteWorkspaceResponseSchema = z.never()
+export const DeleteWorkspaceResponseSchema = z.void()
 
 export const GetWorkspaceRequestSchema = z.object({
   workspaceSlug: z.string()
@@ -120,27 +120,31 @@ export const GlobalSearchRequestSchema = z.object({
 export const GlobalSearchResponseSchema = z.object({
   projects: z.array(
     z.object({
+      id: z.string(),
       slug: z.string(),
       name: z.string(),
       description: z.string()
     })
   ),
   environments: z.array(
     z.object({
+      id: z.string(),
       slug: z.string(),
       name: z.string(),
       description: z.string()
     })
   ),
   secrets: z.array(
     z.object({
+      id: z.string(),
       slug: z.string(),
       name: z.string(),
       note: z.string()
     })
   ),
   variables: z.array(
     z.object({
+      id: z.string(),
       slug: z.string(),
       name: z.string(),
       note: z.string()