278 lines · 7 KBtext/plain; charset=utf-8
The Coline App SDK: apps, tools, file types and surfaces that run inside Coline workspaces, and public websites with Coline Sites. TypeScript, with an in-memory test workspace. MIT.
| type: z.string().trim().min(1).max(120), |
| 5 | payload: z.record(z.string(), z.unknown()).optional(), |
| 6 | }); |
| 7 |
| 8 | export type ColineUiAction = z.infer<typeof uiActionSchema>; |
| 9 |
| 10 | const uiTextNodeSchema = z.object({ |
| 11 | type: z.literal("Text"), |
| 12 | props: z.object({ |
| 13 | value: z.string(), |
| 14 | tone: z.enum(["default", "muted", "positive", "warning", "danger"]).optional(), |
| 15 | }), |
| 16 | }); |
| 17 |
| 18 | const uiHeadingNodeSchema = z.object({ |
| 19 | type: z.literal("Heading"), |
| 20 | props: z.object({ |
| 21 | value: z.string().min(1).max(500), |
| 22 | level: z.int().min(1).max(4).default(2), |
| 23 | }), |
| 24 | }); |
| 25 |
| 26 | const uiBadgeNodeSchema = z.object({ |
| 27 | type: z.literal("Badge"), |
| 28 | props: z.object({ |
| 29 | value: z.string().min(1).max(120), |
| 30 | tone: z.enum(["default", "muted", "positive", "warning", "danger"]).default("default"), |
| 31 | }), |
| 32 | }); |
| 33 |
| 34 | const uiButtonNodeSchema = z.object({ |
| 35 | type: z.literal("Button"), |
| 36 | props: z.object({ |
| 37 | label: z.string().min(1).max(120), |
| 38 | variant: z.enum(["primary", "secondary", "ghost", "danger"]).default("primary"), |
| 39 | action: uiActionSchema, |
| 40 | }), |
| 41 | }); |
| 42 |
| 43 | const uiDividerNodeSchema = z.object({ |
| 44 | type: z.literal("Divider"), |
| 45 | props: z.object({}).default({}), |
| 46 | }); |
| 47 |
| 48 | const uiFileCardNodeSchema = z.object({ |
| 49 | type: z.literal("FileCard"), |
| 50 | props: z.object({ |
| 51 | title: z.string().min(1).max(200), |
| 52 | subtitle: z.string().max(500).optional(), |
| 53 | fileId: z.string().trim().min(1).max(200).optional(), |
| 54 | action: uiActionSchema.optional(), |
| 55 | }), |
| 56 | }); |
| 57 |
| 58 | const uiUserChipNodeSchema = z.object({ |
| 59 | type: z.literal("UserChip"), |
| 60 | props: z.object({ |
| 61 | label: z.string().min(1).max(120), |
| 62 | userId: z.string().trim().min(1).max(200).optional(), |
| 63 | }), |
| 64 | }); |
| 65 |
| 66 | const uiEmptyStateNodeSchema = z.object({ |
| 67 | type: z.literal("EmptyState"), |
| 68 | props: z.object({ |
| 69 | title: z.string().min(1).max(160), |
| 70 | description: z.string().max(1000).optional(), |
| 71 | action: uiActionSchema.optional(), |
| 72 | }), |
| 73 | }); |
| 74 |
| 75 | type ColineUiNodeBase = |
| 76 | | z.infer<typeof uiTextNodeSchema> |
| 77 | | z.infer<typeof uiHeadingNodeSchema> |
| 78 | | z.infer<typeof uiBadgeNodeSchema> |
| 79 | | z.infer<typeof uiButtonNodeSchema> |
| 80 | | z.infer<typeof uiDividerNodeSchema> |
| 81 | | z.infer<typeof uiFileCardNodeSchema> |
| 82 | | z.infer<typeof uiUserChipNodeSchema> |
| 83 | | z.infer<typeof uiEmptyStateNodeSchema>; |
| 84 |
| 85 | export type ColineUiNode = ColineUiNodeBase | ColineUiStackNode; |
| 86 |
| 87 | export interface ColineUiStackNode { |
| 88 | type: "Stack"; |
| 89 | props: { |
| 90 | direction?: "vertical" | "horizontal"; |
| 91 | gap?: "xs" | "sm" | "md" | "lg"; |
| 92 | children: ColineUiNode[]; |
| 93 | }; |
| 94 | } |
| 95 |
| 96 | const uiNodeLazySchema: z.ZodType<ColineUiNode> = z.lazy(() => |
| 97 | z.union([ |
| 98 | uiTextNodeSchema, |
| 99 | uiHeadingNodeSchema, |
| 100 | uiBadgeNodeSchema, |
| 101 | uiButtonNodeSchema, |
| 102 | uiDividerNodeSchema, |
| 103 | uiFileCardNodeSchema, |
| 104 | uiUserChipNodeSchema, |
| 105 | uiEmptyStateNodeSchema, |
| 106 | z.object({ |
| 107 | type: z.literal("Stack"), |
| 108 | props: z.object({ |
| 109 | direction: z.enum(["vertical", "horizontal"]).default("vertical"), |
| 110 | gap: z.enum(["xs", "sm", "md", "lg"]).default("md"), |
| 111 | children: z.array(uiNodeLazySchema), |
| 112 | }), |
| 113 | }), |
| 114 | ]), |
| 115 | ); |
| 116 |
| 117 | export const colineUiNodeSchema = uiNodeLazySchema; |
| 118 | export const colineUiActionSchema = uiActionSchema; |
| 119 |
| 120 | export const actions = { |
| 121 | openFile(fileId: string, payload: Record<string, unknown> = {}): ColineUiAction { |
| 122 | return colineUiActionSchema.parse({ |
| 123 | type: "open_file", |
| 124 | payload: { |
| 125 | fileId, |
| 126 | ...payload, |
| 127 | }, |
| 128 | }); |
| 129 | }, |
| 130 |
| 131 | openAppHome(payload: Record<string, unknown> = {}): ColineUiAction { |
| 132 | return colineUiActionSchema.parse({ |
| 133 | type: "open_app_home", |
| 134 | payload, |
| 135 | }); |
| 136 | }, |
| 137 |
| 138 | custom(type: string, payload: Record<string, unknown> = {}): ColineUiAction { |
| 139 | return colineUiActionSchema.parse({ |
| 140 | type, |
| 141 | payload, |
| 142 | }); |
| 143 | }, |
| 144 | }; |
| 145 |
| 146 | export const ui = { |
| 147 | text( |
| 148 | value: string, |
| 149 | options: { |
| 150 | tone?: "default" | "muted" | "positive" | "warning" | "danger"; |
| 151 | } = {}, |
| 152 | ): ColineUiNode { |
| 153 | return colineUiNodeSchema.parse({ |
| 154 | type: "Text", |
| 155 | props: { |
| 156 | value, |
| 157 | ...(options.tone ? { tone: options.tone } : {}), |
| 158 | }, |
| 159 | }); |
| 160 | }, |
| 161 |
| 162 | heading( |
| 163 | value: string, |
| 164 | options: { |
| 165 | level?: 1 | 2 | 3 | 4; |
| 166 | } = {}, |
| 167 | ): ColineUiNode { |
| 168 | return colineUiNodeSchema.parse({ |
| 169 | type: "Heading", |
| 170 | props: { |
| 171 | value, |
| 172 | ...(options.level ? { level: options.level } : {}), |
| 173 | }, |
| 174 | }); |
| 175 | }, |
| 176 |
| 177 | badge( |
| 178 | value: string, |
| 179 | options: { |
| 180 | tone?: "default" | "muted" | "positive" | "warning" | "danger"; |
| 181 | } = {}, |
| 182 | ): ColineUiNode { |
| 183 | return colineUiNodeSchema.parse({ |
| 184 | type: "Badge", |
| 185 | props: { |
| 186 | value, |
| 187 | ...(options.tone ? { tone: options.tone } : {}), |
| 188 | }, |
| 189 | }); |
| 190 | }, |
| 191 |
| 192 | button( |
| 193 | label: string, |
| 194 | options: { |
| 195 | variant?: "primary" | "secondary" | "ghost" | "danger"; |
| 196 | action: ColineUiAction; |
| 197 | }, |
| 198 | ): ColineUiNode { |
| 199 | return colineUiNodeSchema.parse({ |
| 200 | type: "Button", |
| 201 | props: { |
| 202 | label, |
| 203 | action: options.action, |
| 204 | ...(options.variant ? { variant: options.variant } : {}), |
| 205 | }, |
| 206 | }); |
| 207 | }, |
| 208 |
| 209 | divider(): ColineUiNode { |
| 210 | return colineUiNodeSchema.parse({ |
| 211 | type: "Divider", |
| 212 | props: {}, |
| 213 | }); |
| 214 | }, |
| 215 |
| 216 | fileCard(input: { |
| 217 | title: string; |
| 218 | subtitle?: string; |
| 219 | fileId?: string; |
| 220 | action?: ColineUiAction; |
| 221 | }): ColineUiNode { |
| 222 | return colineUiNodeSchema.parse({ |
| 223 | type: "FileCard", |
| 224 | props: { |
| 225 | title: input.title, |
| 226 | ...(input.subtitle ? { subtitle: input.subtitle } : {}), |
| 227 | ...(input.fileId ? { fileId: input.fileId } : {}), |
| 228 | ...(input.action ? { action: input.action } : {}), |
| 229 | }, |
| 230 | }); |
| 231 | }, |
| 232 |
| 233 | userChip(input: { |
| 234 | label: string; |
| 235 | userId?: string; |
| 236 | }): ColineUiNode { |
| 237 | return colineUiNodeSchema.parse({ |
| 238 | type: "UserChip", |
| 239 | props: { |
| 240 | label: input.label, |
| 241 | ...(input.userId ? { userId: input.userId } : {}), |
| 242 | }, |
| 243 | }); |
| 244 | }, |
| 245 |
| 246 | emptyState(input: { |
| 247 | title: string; |
| 248 | description?: string; |
| 249 | action?: ColineUiAction; |
| 250 | }): ColineUiNode { |
| 251 | return colineUiNodeSchema.parse({ |
| 252 | type: "EmptyState", |
| 253 | props: { |
| 254 | title: input.title, |
| 255 | ...(input.description ? { description: input.description } : {}), |
| 256 | ...(input.action ? { action: input.action } : {}), |
| 257 | }, |
| 258 | }); |
| 259 | }, |
| 260 |
| 261 | stack( |
| 262 | children: ColineUiNode[], |
| 263 | options: { |
| 264 | direction?: "vertical" | "horizontal"; |
| 265 | gap?: "xs" | "sm" | "md" | "lg"; |
| 266 | } = {}, |
| 267 | ): ColineUiNode { |
| 268 | return colineUiNodeSchema.parse({ |
| 269 | type: "Stack", |
| 270 | props: { |
| 271 | children, |
| 272 | ...(options.direction ? { direction: options.direction } : {}), |
| 273 | ...(options.gap ? { gap: options.gap } : {}), |
| 274 | }, |
| 275 | }); |
| 276 | }, |
| 277 | }; |
| 278 |