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

…eyshade/schema (#520)

packages/api-client/package.json

@@ -14,5 +14,7 @@
     "lint": "eslint \"{src,tests}/**/*.ts\" --fix",
     "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\""
   },
-  "dependencies": {}
+  "dependencies": {
+    "@keyshade/schema": "workspace:*"
+  }
 }

packages/api-client/src/controllers/workspace.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 {
   CreateWorkspaceRequest,
   CreateWorkspaceResponse,
@@ -17,7 +17,7 @@ import {
   GlobalSearchResponse,
   UpdateWorkspaceRequest,
   UpdateWorkspaceResponse
-} from '@api-client/types/workspace.types'
+} from '@keyshade/schema'
 
 export default class WorkspaceController {
   private apiClient: APIClient

packages/schema/package.json

@@ -4,6 +4,12 @@
   "main": "dist/src/index.js",
   "description": "This package holds the schemas that other applications can use to validate the input data.",
   "private": true,
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "default": "./dist/src/index.js"
+    }
+  },
   "scripts": {
     "build": "tsc && tsc-alias",
     "watch": "tsc -w",
@@ -13,5 +19,7 @@
     "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
     "test": "jest"
   },
-  "dependencies": {}
+  "dependencies": {
+    "zod": "^3.23.6"
+  }
 }

packages/schema/src/api-key.ts

@@ -1,5 +1,5 @@
 import z from 'zod'
-import { expiresAfterEnum } from './enums'
+import { expiresAfterEnum } from '@/enums'
 
 export const CreateApiKeySchema = z.object({
   name: z.string(),

packages/schema/src/index.ts

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

packages/schema/src/integration.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod'
-import { eventTypeEnum, integrationTypeEnum } from './enums'
+import { eventTypeEnum, integrationTypeEnum } from '@/enums'
 
 export const CreateIntegrationSchema = z.object({
   name: z.string(),

packages/schema/src/pagination/pagination.ts

@@ -0,0 +1,46 @@
+import { z } from 'zod'
+
+export const PageRequestSchema = z.object({
+  page: z.number().optional(),
+  limit: z.number().optional(),
+  sort: z.string().optional(),
+  order: z.string().optional(),
+  search: z.string().optional()
+})
+
+export const PageResponseSchema = <T>(itemSchema: z.ZodType<T>) =>
+  z.object({
+    items: z.array(itemSchema),
+    metadata: z.object({
+      page: z.number(),
+      perPage: z.number(),
+      pageCount: z.number(),
+      totalCount: z.number(),
+      links: z.object({
+        self: z.string(),
+        first: z.string(),
+        previous: z.string().nullable(),
+        next: z.string().nullable(),
+        last: z.string()
+      })
+    })
+  })
+
+export const ResponseErrorSchema = z.object({
+  message: z.string(),
+  error: z.string(),
+  statusCode: z.number()
+})
+
+export const ClientResponseSchema = <T>(dataSchema: z.ZodType<T>) =>
+  z
+    .object({
+      success: z.boolean(),
+      error: ResponseErrorSchema.nullable(),
+      data: dataSchema.nullable()
+    })
+    .refine((obj) =>
+      obj.success
+        ? obj.data !== null && obj.error == null
+        : obj.data == null && obj.error !== null
+    )

packages/schema/src/pagination/pagination.types.ts

@@ -0,0 +1,17 @@
+import { z } from 'zod'
+import {
+  ClientResponseSchema,
+  PageRequestSchema,
+  PageResponseSchema,
+  ResponseErrorSchema
+} from './pagination'
+
+export type PageRequest = z.infer<typeof PageRequestSchema>
+
+export type PageResponse<T> = z.infer<ReturnType<typeof PageResponseSchema<T>>>
+
+export type ResponseError = z.infer<typeof ResponseErrorSchema>
+
+export type ClientResponse<T> = z.infer<
+  ReturnType<typeof ClientResponseSchema<T>>
+>

packages/schema/src/project.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod'
-import { projectAccessLevelEnum } from './enums'
+import { projectAccessLevelEnum } from '@/enums'
 import { CreateEnvironmentSchema } from './environment'
 
 export const CreateProjectSchema = z.object({

packages/schema/src/secret.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod'
-import { rotateAfterEnum } from './enums'
+import { rotateAfterEnum } from '@/enums'
 
 export const CreateSecretSchema = z.object({
   name: z.string(),

packages/schema/src/workspace-role.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod'
-import { authorityEnum } from './enums'
+import { authorityEnum } from '@/enums'
 
 export const CreateWorkspaceRoleSchema = z.object({
   name: z.string(),