feat(schema, api-client): Migrate secret types and schemas to @keysha…

…de/schema (#539)

Co-authored-by: Rajdip Bhattacharya <[email protected]>

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

@@ -16,7 +16,7 @@ import {
   RollBackSecretResponse,
   UpdateSecretRequest,
   UpdateSecretResponse
-} from '@api-client/types/secret.types'
+} from '@keyshade/schema'
 import { parsePaginationUrl } from '@api-client/core/pagination-parser'
 
 export default class SecretController {

packages/schema/src/index.types.ts

@@ -1,7 +1,6 @@
 import { z } from 'zod'
 import { CreateApiKeySchema, UpdateApiKeySchema } from './api-key'
 import { CreateIntegrationSchema, UpdateIntegrationSchema } from './integration'
-import { CreateSecretSchema, UpdateSecretSchema } from './secret'
 import { CreateVariableSchema, UpdateVariableSchema } from './variable'
 import {
   CreateWorkspaceRoleSchema,
@@ -24,8 +23,7 @@ export type TUpdateIntegration = z.infer<typeof UpdateIntegrationSchema>
 
 export * from './project/index.types'
 
-export type TCreateSecret = z.infer<typeof CreateSecretSchema>
-export type TUpdateSecret = z.infer<typeof UpdateSecretSchema>
+export * from './secret/index.types'
 
 export * from './user/index.types'
 

packages/schema/src/secret/index.ts

@@ -0,0 +1,141 @@
+import { z } from 'zod'
+import { PageRequestSchema, PageResponseSchema } from '@/pagination/pagination'
+import { rotateAfterEnum } from '@/enums'
+
+export const SecretSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  slug: z.string(),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+  rotateAt: z.string().nullable(),
+  note: z.string().nullable(),
+  lastUpdatedById: z.string(),
+  projectId: z.string(),
+  project: z.object({
+    workspaceId: z.string()
+  }),
+  versions: z.array(
+    z.object({
+      id: z.string().optional(),
+      environmentId: z.string(),
+      value: z.string(),
+      environment: z.object({
+        id: z.string(),
+        slug: z.string()
+      })
+    })
+  )
+})
+
+export const CreateSecretRequestSchema = z.object({
+  projectSlug: z.string(),
+  name: z.string(),
+  note: z.string().optional(),
+  rotateAfter: rotateAfterEnum.optional(),
+  entries: z
+    .array(
+      z.object({
+        value: z.string(),
+        environmentSlug: z.string()
+      })
+    )
+    .optional()
+})
+
+export const CreateSecretResponseSchema = SecretSchema
+
+export const UpdateSecretRequestSchema =
+  CreateSecretRequestSchema.partial().extend({
+    secretSlug: z.string()
+  })
+
+export const UpdateSecretResponseSchema = z.object({
+  secret: z.object({
+    id: z.string(),
+    name: z.string(),
+    slug: z.string(),
+    note: z.string().nullable()
+  }),
+  updatedVersions: z.array(
+    z.object({
+      id: z.string().optional(),
+      environmentId: z.string(),
+      environment: z.object({
+        id: z.string(),
+        slug: z.string()
+      }),
+      value: z.string()
+    })
+  )
+})
+
+export const DeleteSecretRequestSchema = z.object({
+  secretSlug: z.string()
+})
+
+export const DeleteSecretResponseSchema = z.void()
+
+export const RollBackSecretRequestSchema = z.object({
+  environmentSlug: z.string(),
+  version: z.number(),
+  secretSlug: z.string()
+})
+
+export const RollBackSecretResponseSchema = z.object({
+  count: z.string()
+})
+
+export const GetAllSecretsOfProjectRequestSchema = PageRequestSchema.extend({
+  projectSlug: z.string()
+})
+
+export const GetAllSecretsOfProjectResponseSchema = PageResponseSchema(
+  z.object({
+    secret: SecretSchema.omit({ versions: true, project: true }).extend({
+      lastUpdatedBy: z.object({
+        id: z.string(),
+        name: z.string()
+      })
+    }),
+    values: z.object({
+      environment: z.object({
+        id: z.string(),
+        name: z.string(),
+        slug: z.string()
+      }),
+      value: z.string(),
+      version: z.number()
+    })
+  })
+)
+
+export const GetAllSecretsOfEnvironmentRequestSchema = z.object({
+  projectSlug: z.string(),
+  environmentSlug: z.string()
+})
+
+export const GetAllSecretsOfEnvironmentResponseSchema = z.array(
+  z.object({
+    name: z.string(),
+    value: z.string(),
+    isPlaintext: z.boolean()
+  })
+)
+
+export const GetRevisionsOfSecretRequestSchema =
+  PageRequestSchema.partial().extend({
+    secretSlug: z.string(),
+    environmentSlug: z.string()
+  })
+
+export const GetRevisionsOfSecretResponseSchema = PageResponseSchema(
+  z.object({
+    id: z.string(),
+    value: z.string(),
+    version: z.number(),
+    createdOn: z.string(),
+    createdById: z.string(),
+    environmentId: z.string()
+  })
+)

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

@@ -0,0 +1,62 @@
+import { z } from 'zod'
+import {
+  SecretSchema,
+  CreateSecretRequestSchema,
+  CreateSecretResponseSchema,
+  UpdateSecretRequestSchema,
+  UpdateSecretResponseSchema,
+  DeleteSecretRequestSchema,
+  DeleteSecretResponseSchema,
+  RollBackSecretRequestSchema,
+  RollBackSecretResponseSchema,
+  GetAllSecretsOfProjectRequestSchema,
+  GetAllSecretsOfProjectResponseSchema,
+  GetAllSecretsOfEnvironmentRequestSchema,
+  GetAllSecretsOfEnvironmentResponseSchema,
+  GetRevisionsOfSecretRequestSchema,
+  GetRevisionsOfSecretResponseSchema
+} from '.'
+
+export type Secret = z.infer<typeof SecretSchema>
+
+export type CreateSecretRequest = z.infer<typeof CreateSecretRequestSchema>
+
+export type CreateSecretResponse = z.infer<typeof CreateSecretResponseSchema>
+
+export type UpdateSecretRequest = z.infer<typeof UpdateSecretRequestSchema>
+
+export type UpdateSecretResponse = z.infer<typeof UpdateSecretResponseSchema>
+
+export type DeleteSecretRequest = z.infer<typeof DeleteSecretRequestSchema>
+
+export type DeleteSecretResponse = z.infer<typeof DeleteSecretResponseSchema>
+
+export type RollBackSecretRequest = z.infer<typeof RollBackSecretRequestSchema>
+
+export type RollBackSecretResponse = z.infer<
+  typeof RollBackSecretResponseSchema
+>
+
+export type GetAllSecretsOfProjectRequest = z.infer<
+  typeof GetAllSecretsOfProjectRequestSchema
+>
+
+export type GetAllSecretsOfProjectResponse = z.infer<
+  typeof GetAllSecretsOfProjectResponseSchema
+>
+
+export type GetAllSecretsOfEnvironmentRequest = z.infer<
+  typeof GetAllSecretsOfEnvironmentRequestSchema
+>
+
+export type GetAllSecretsOfEnvironmentResponse = z.infer<
+  typeof GetAllSecretsOfEnvironmentResponseSchema
+>
+
+export type GetRevisionsOfSecretRequest = z.infer<
+  typeof GetRevisionsOfSecretRequestSchema
+>
+
+export type GetRevisionsOfSecretResponse = z.infer<
+  typeof GetRevisionsOfSecretResponseSchema
+>