teableio / teable / 10265336706

import type { RouteConfig } from '@asteasolutions/zod-to-openapi';

import { IdPrefix, fieldVoSchema } from '@teable/core';

import { axios } from '../axios';

import { itemSpaceCollaboratorSchema } from '../space';

import { registerRoute, urlBuilder } from '../utils';

import { z } from '../zod';

export const getRecordHistoryQuerySchema = z.object({

  recordId: z.string().startsWith(IdPrefix.Record).optional(),

  cursor: z.string().nullish(),

});

export const recordHistoryItemStateVoSchema = z.object({

  meta: fieldVoSchema.pick({ name: true, type: true, cellValueType: true }).merge(

    z.object({

      options: z.unknown(),

    })

  ),

  data: z.unknown(),

});

export const recordHistoryItemVoSchema = z.object({

  id: z.string(),

  recordId: z.string(),

  fieldId: z.string(),

  before: recordHistoryItemStateVoSchema,

  after: recordHistoryItemStateVoSchema,

  createdTime: z.string(),

  createdBy: z.string(),

});

export type IGetRecordHistoryQuery = z.infer<typeof getRecordHistoryQuerySchema>;

export type IRecordHistoryItemVo = z.infer<typeof recordHistoryItemVoSchema>;

export const recordHistoryVoSchema = z.object({

  historyList: z.array(recordHistoryItemVoSchema),

  userMap: z.record(

    z.string().startsWith(IdPrefix.User),

    itemSpaceCollaboratorSchema

      .pick({

        email: true,

        avatar: true,

      })

      .merge(

        z.object({

          id: z.string(),

          name: z.string(),

        })

      )

  ),

  nextCursor: z.string().nullish(),

});

export type IRecordHistoryVo = z.infer<typeof recordHistoryVoSchema>;

export const GET_RECORD_HISTORY_URL = '/table/{tableId}/record/history';

export const GetRecordHistoryRoute: RouteConfig = registerRoute({

  method: 'get',

  path: GET_RECORD_HISTORY_URL,

  description: 'Get the history list for a record',

  request: {

    params: z.object({

      tableId: z.string(),

    }),

  },

  responses: {

    200: {

      description: 'Get the history list for a record',

      content: {

        'application/json': {

          schema: recordHistoryVoSchema,

        },

      },

    },

  },

  tags: ['record'],

});

export const getRecordHistory = async (tableId: string, query: IGetRecordHistoryQuery) => {

  return axios.get<IRecordHistoryVo>(

    urlBuilder(GET_RECORD_HISTORY_URL, {

      tableId,

    }),

    { params: query }

  );

};