botpress--botpress/integrations/linear/definitions/schemas.ts

import { z } from '@botpress/sdk'
import { User } from '@linear/sdk'
import { assert, Equals } from 'tsafe/assert'

export const targets = z.object({
  issue: z
    .record(z.string().title('Issue').describe('The issue'))
    .optional()
    .title('Target Issue')
    .describe('The target issue on Linear'),
})

type TransformDatesToStrings<T> = {
  [K in keyof T]: T[K] extends Date | undefined ? string : T[K]
}

type LinearUserProfile = Pick<
  TransformDatesToStrings<User>,
  | 'admin'
  | 'archivedAt'
  | 'avatarUrl'
  | 'createdAt'
  | 'description'
  | 'displayName'
  | 'guest'
  | 'email'
  | 'isMe'
  | 'url'
  | 'timezone'
  | 'name'
> & { linearId: string }

export const userProfileSchema = z.object({
  linearId: z.string().title('User ID').describe('Linear User ID'),
  admin: z.boolean().title('Is Admin?').describe('Indicates if the user is an admin of the organization'),
  archivedAt: z.string().datetime().optional().title('Archival Date').describe('Date when the user was archived'),
  avatarUrl: z.string().url().optional().title('Avatar URL').describe('The URL for the profile picture'),
  createdAt: z.string().datetime().title('Creation Date').describe('Date when the user was created'),
  description: z
    .string()
    .optional()
    .title('Description')
    .describe('A short description of the user, either its title or bio'),
  displayName: z
    .string()
    .title('Display Name')
    .describe("The user's display (nick) name. Unique within each organization"),
  guest: z
    .boolean()
    .title('Is Guest?')
    .describe('Whether the user is a guest in the workspace and limited to accessing a subset of teams'),
  email: z.string().title('Email').describe("The user's email address"),
  isMe: z.boolean().title('Is Self?').describe('Whether the user is the currently authenticated user'),
  url: z.string().title('Profile URL').describe("User's profile URL"),
  timezone: z.string().optional().title('Timezone').describe('The local timezone of the user'),
  name: z.string().title('Full Name').describe("The user's full name"),
})

export const linearIdsSchema = z
  .object({
    creatorId: z
      .string()
      .optional()
      .title("Creator's User ID")
      .describe('The internal Linear User ID of the user who created the issue'),
    labelIds: z
      .array(z.string())
      .optional()
      .title('Label IDs')
      .describe('The internal Linear Label IDs associated with the issue'),
    issueId: z.string().title('Issue ID').describe('The internal Linear Issue ID'),
    teamId: z.string().optional().title('Team ID').describe('The internal Linear Team ID'),
    projectId: z.string().optional().title('Project ID').describe('The internal Linear Project ID'),
    assigneeId: z.string().optional().title('Assignee User ID').describe('The internal Linear Assignee ID'),
    subscriberIds: z
      .array(z.string())
      .optional()
      .title('Subscriber IDs')
      .describe('The internal Linear Subscriber User IDs'),
  })
  .describe('The Linear IDs of the referenced entities')

const commonIssueProperties = {
  title: z.string().title('Title').describe('The issue title on Linear, such as "Fix the bug'),
  number: z.number().title('Number').describe('The issue number on Linear, such as "123" in XXX-123'),
  createdAt: z.string().datetime().title('Created At').describe('The ISO date the issue was created'),
  updatedAt: z.string().datetime().title('Updated At').describe('The ISO date the issue was last updated'),
  identifier: z.string().title('Identifier').describe("Issue's human readable identifier (e.g. XXX-123)"),
  url: z.string().title('Issue URL').describe('The URL of the issue on Linear'),
  priority: z
    .number()
    .title('Priority')
    .describe('Priority of the issue, such as "1" for "Urgent", 0 for "No Priority"'),
  description: z
    .string()
    .optional()
    .title('Description')
    .describe('A markdown description of the issue. Images and videos are inlined using markdown links.'),
}

export const issueSchema = z.object({
  ...commonIssueProperties,
  id: z.string().title('Issue ID').describe('The issue ID on Linear'),
  estimate: z.number().optional().title('Points Estimate').describe('The estimate of the issue in points'),
})

export const issueEventSchema = z.object({
  ...commonIssueProperties,
  teamName: z
    .string()
    .optional()
    .title('Team Name')
    .describe('The name of the Linear team the issue currently belongs to, such as "Customer Support"'),
  teamKey: z
    .string()
    .optional()
    .title('Team Key')
    .describe('The key of the Linear team the issue currently belongs to, such as "XXX" in XXX-123'),
  status: z.string().title('Status').describe('The issue State name (such as "In Progress"'),
  statusColor: z.string().title('Status Color').describe('The issue State color (#000000 format)'),
  statusType: z.string().title('Status Type').describe('The issue State type'),
  labels: z
    .array(z.string().title('Label Name').describe('The name of the label'))
    .optional()
    .title('Applied Labels')
    .describe('Label names'),
  linearIds: linearIdsSchema.title('Linear IDs').describe('The Linear IDs of the referenced entities'),
  userId: z
    .string()
    .optional()
    .title('Botpress User ID')
    .describe(
      'The Botpress User ID of the individual who initiated the issue. If not provided, it indicates the issue was generated by the bot.'
    ),
  conversationId: z.string().title('Botpress Conversation ID').describe('Botpress Conversation ID of the issue'),
})

assert<Equals<z.infer<typeof userProfileSchema>, LinearUserProfile>>()