@kelpie/schemas 0.10.0 → 0.12.0

package/src/conversion.ts

@@ -0,0 +1,99 @@
+import { z } from 'zod'
+
+import { PIPELINE_KINDS } from './values.ts'
+import type { PipelineKind } from './values.ts'
+import { idSchema } from './wire.ts'
+
+/** Where a pipeline record was converted to. Set once; read-only on the wire. */
+export interface ConvertedTo {
+  readonly targetType: PipelineKind
+  readonly targetId: string
+}
+
+export const convertedToSchema: z.ZodType<ConvertedTo, unknown> = z
+  .object({
+    target_type: z.enum(PIPELINE_KINDS),
+    target_id: idSchema,
+  })
+  .transform(
+    (wire): ConvertedTo => ({
+      targetType: wire.target_type,
+      targetId: wire.target_id,
+    }),
+  )
+
+export const convertedToWireSchema = z
+  .object({
+    target_type: z.enum(PIPELINE_KINDS),
+    target_id: idSchema,
+  })
+  .nullable()
+
+/** Body for `POST /v1/{pipeline}/:id/convert`. */
+export interface ConvertPipelineRecordInput {
+  readonly targetType: PipelineKind
+  readonly stageId?: string | undefined
+  readonly companyId?: string | undefined
+  readonly kind?: string | undefined
+  readonly name?: string | undefined
+}
+
+export const convertPipelineRecordBody = z.strictObject({
+  target_type: z.enum(PIPELINE_KINDS),
+  stage_id: idSchema.optional(),
+  company_id: idSchema.optional(),
+  kind: z.string().optional(),
+  name: z.string().min(1).optional(),
+})
+
+/** Enquiry convert accepts an empty body and defaults the target to a deal. */
+export const convertEnquiryBody = z.strictObject({
+  target_type: z.enum(PIPELINE_KINDS).default('deal'),
+  stage_id: idSchema.optional(),
+  company_id: idSchema.optional(),
+  kind: z.string().optional(),
+  name: z.string().min(1).optional(),
+})
+
+export function convertPipelineRecordRequest(
+  input: ConvertPipelineRecordInput,
+): Record<string, unknown> {
+  return {
+    target_type: input.targetType,
+    ...(input.stageId === undefined ? {} : { stage_id: input.stageId }),
+    ...(input.companyId === undefined ? {} : { company_id: input.companyId }),
+    ...(input.kind === undefined ? {} : { kind: input.kind }),
+    ...(input.name === undefined ? {} : { name: input.name }),
+  }
+}
+
+/** Builds the wire `converted_to` object from stored columns. */
+export function convertedToForWire(
+  convertedTargetType: string | null,
+  convertedTargetId: string | null,
+): ConvertedTo | null {
+  if (convertedTargetType === null || convertedTargetId === null) {
+    return null
+  }
+
+  return {
+    targetType: convertedTargetType as PipelineKind,
+    targetId: convertedTargetId,
+  }
+}
+
+export function convertedToResponse(
+  convertedTargetType: string | null,
+  convertedTargetId: string | null,
+): Record<string, unknown> | null {
+  const converted = convertedToForWire(convertedTargetType, convertedTargetId)
+
+  if (converted === null) {
+    return null
+  }
+
+  return {
+    target_type: converted.targetType,
+    target_id: converted.targetId,
+  }
+}

package/src/deal.ts

@@ -1,5 +1,7 @@
 import { z } from 'zod'
 
+import { convertedToWireSchema } from './conversion.ts'
+import type { ConvertedTo } from './conversion.ts'
 import { customFieldValuesBody, customFieldValuesSchema } from './customField.ts'
 import type { CustomFieldValue, CustomFieldValues } from './customField.ts'
 import { definedFields, idSchema, recordTimestamps } from './wire.ts'
@@ -24,6 +26,8 @@ export interface Deal extends RecordTimestamps {
   readonly summary: string
   readonly tags: readonly string[]
   readonly externalId: string | null
+  /** Non-null once this record has been converted to another pipeline type. */
+  readonly convertedTo: ConvertedTo | null
   /** Workspace-defined fields, keyed by definition key. Always present (default `{}`). */
   readonly customFields: CustomFieldValues
 }
@@ -45,6 +49,7 @@ export const dealSchema: z.ZodType<Deal, unknown> = z
     summary: z.string(),
     tags: z.array(z.string()),
     external_id: z.string().nullable(),
+    converted_to: convertedToWireSchema,
     custom_fields: customFieldValuesSchema,
     ...recordTimestamps,
   })
@@ -65,6 +70,10 @@ export const dealSchema: z.ZodType<Deal, unknown> = z
       summary: wire.summary,
       tags: wire.tags,
       externalId: wire.external_id,
+      convertedTo:
+        wire.converted_to === null
+          ? null
+          : { targetType: wire.converted_to.target_type, targetId: wire.converted_to.target_id },
       customFields: wire.custom_fields,
       createdAt: wire.created_at,
       updatedAt: wire.updated_at,

package/src/enquiry.ts

@@ -1,5 +1,7 @@
 import { z } from 'zod'
 
+import { convertedToWireSchema } from './conversion.ts'
+import type { ConvertedTo } from './conversion.ts'
 import { customFieldValuesBody, customFieldValuesSchema } from './customField.ts'
 import type { CustomFieldValue, CustomFieldValues } from './customField.ts'
 import { definedFields, idSchema, recordTimestamps } from './wire.ts'
@@ -18,6 +20,8 @@ export interface Enquiry extends RecordTimestamps {
   readonly ownerId: string | null
   /** Non-null once the enquiry has been converted to a Deal; nulled if that deal is deleted. */
   readonly convertedDealId: string | null
+  /** Non-null once this record has been converted to another pipeline type. */
+  readonly convertedTo: ConvertedTo | null
   readonly personIds: readonly string[]
   readonly summary: string
   readonly tags: readonly string[]
@@ -34,6 +38,7 @@ export const enquirySchema: z.ZodType<Enquiry, unknown> = z
     company_id: idSchema.nullable(),
     owner_id: idSchema.nullable(),
     converted_deal_id: idSchema.nullable(),
+    converted_to: convertedToWireSchema,
     person_ids: z.array(idSchema),
     summary: z.string(),
     tags: z.array(z.string()),
@@ -49,6 +54,10 @@ export const enquirySchema: z.ZodType<Enquiry, unknown> = z
       companyId: wire.company_id,
       ownerId: wire.owner_id,
       convertedDealId: wire.converted_deal_id,
+      convertedTo:
+        wire.converted_to === null
+          ? null
+          : { targetType: wire.converted_to.target_type, targetId: wire.converted_to.target_id },
       personIds: wire.person_ids,
       summary: wire.summary,
       tags: wire.tags,

package/src/form.ts

@@ -1,7 +1,6 @@
 import { z } from 'zod'
 
 import {
-  FORM_FIELD_MAP_TARGETS,
   FORM_FIELD_TYPES,
   FORM_OPTION_VALUE_TYPES,
   FORM_STATUSES,
@@ -156,7 +155,7 @@ const formFieldSchema = z
     label: z.string(),
     type: z.enum(FORM_FIELD_TYPES),
     required: z.boolean(),
-    map_to: z.enum(FORM_FIELD_MAP_TARGETS),
+    map_to: z.string().min(1),
     options: z.array(formFieldOptionSchema),
     placeholder: z.string().nullable(),
     statement: z.string().nullable(),