Skip to content
This repository was archived by the owner on Nov 4, 2026. It is now read-only.

Commit e9d9212

Browse files
os-warrenclaude
andauthored
fix(types): drop stale source-line citations from 6 published describe() strings (complex.zod.ts) (#8835)
* fix(types): drop stale source-line citations from complex.zod.ts describe() strings Remove the `NAME.ext:NNN` address from all 6 published .describe() strings in packages/types/src/zod/complex.zod.ts (#8478) -- the final file of this card's remainder. Per-address editorial disposition, not a uniform treatment: - FilterBuilderSchema.wrapperClass, CarouselSchema.itemClassName, and ChatMessageSchema.avatar / avatarFallback: the cited renderer expression only restated what the prose already says in English, so it moves into a maintainer-facing `//` comment beside the schema (matching this file's own convention of file:line references in maintainer JSDoc) and the published description keeps the author-relevant sentence without the address. - CarouselSchema.opts and CarouselSchema.orientation: the cited expression reveals a real default/policy an author needs (orientation falls back to 'horizontal'; opts is deliberately left open, unnarrowed), so the prose stands on its own with the address dropped and the rest kept. Text only: no accept-set, key, or shape change (Clause-2: no). All 6 addresses were spot-checked against the files they cite and are byte-accurate today -- no drift found, unlike the two prior slices on this card. Refs #8478 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Jmxdo7bmeqCQHLSfmLVX9w * chore: add changeset for complex.zod.ts describe() address removal Refs #8478 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Jmxdo7bmeqCQHLSfmLVX9w --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent 0afc233 commit e9d9212

2 files changed

Lines changed: 30 additions & 10 deletions

File tree

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
'@object-ui/types': patch
3+
---
4+
5+
Remove stale source-line citations (`NAME.ext:NNN`) from all 6 published `.describe()`
6+
schema descriptions in `packages/types/src/zod/complex.zod.ts` (objectstack-ai/objectui#8478)
7+
— the last file of this card's remainder, which the card now closes.
8+
9+
Text only — no accept-set, key, or shape change. Per-address editorial disposition, not a
10+
uniform treatment: three descriptions (`FilterBuilderSchema.wrapperClass`,
11+
`CarouselSchema.itemClassName`, `ChatMessageSchema.avatar` / `avatarFallback`) had their cited
12+
renderer expression relocated into a maintainer-facing `//` comment beside the schema, since
13+
the expression only restated what the author-facing prose already said; two
14+
(`CarouselSchema.opts`, `CarouselSchema.orientation`) kept their expression inline because it
15+
reveals a real default/policy authors need (`orientation` falls back to `'horizontal'`; `opts`
16+
is deliberately left open, unnarrowed).
17+
18+
All 6 addresses were spot-checked against the files they cite and are accurate today — no
19+
drift found, unlike the two prior slices on this card (which found `ObjectKanban.tsx:264`,
20+
`checkbox.tsx:45/:49` and `text.tsx:162,167` all pointing to stale lines).

‎packages/types/src/zod/complex.zod.ts‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -539,8 +539,8 @@ export const FilterBuilderSchema = BaseSchema.extend({
539539
onChange: handlerKeyRefusal('onChange', 'runtime-slot', 'Change handler'),
540540
allowGroups: z.boolean().optional().describe('Allow grouped conditions'),
541541
maxDepth: z.number().optional().describe('Maximum nesting depth'),
542-
wrapperClass: z.string().optional()
543-
.describe("Outer wrapper classes, read at renderers/complex/filter-builder.tsx:37 — `className={schema.wrapperClass || ''}` (objectui#6150)"),
542+
// Applied at renderers/complex/filter-builder.tsx:37 as `className={schema.wrapperClass || ''}`.
543+
wrapperClass: z.string().optional().describe('Outer wrapper classes for the filter builder (objectui#6150)'),
544544
});
545545

546546
/**
@@ -558,11 +558,11 @@ export const CarouselSchema = BaseSchema.extend({
558558
type: z.literal('carousel'),
559559
items: z.array(CarouselItemSchema).describe('Carousel items'),
560560
opts: z.record(z.string(), z.unknown()).optional()
561-
.describe("Embla option bag forwarded verbatim at renderers/complex/carousel.tsx:23 — `opts={schema.opts}`. Left OPEN on purpose: the renderer passes the whole bag through, so narrowing it to the docs' `{loop, align}` pair would refuse authored documents that work today (objectui#6150)"),
561+
.describe("Embla option bag forwarded verbatim (`opts={schema.opts}`). Left OPEN on purpose: the renderer passes the whole bag through, so narrowing it to the docs' `{loop, align}` pair would refuse authored documents that work today (objectui#6150)"),
562562
orientation: z.enum(['horizontal', 'vertical']).optional()
563-
.describe("Scroll axis, read at renderers/complex/carousel.tsx:24 — `orientation={schema.orientation || 'horizontal'}` (objectui#6150)"),
564-
itemClassName: z.string().optional()
565-
.describe('Per-slide Tailwind classes, read at renderers/complex/carousel.tsx:30 — `className={schema.itemClassName}` on every CarouselItem (objectui#6150)'),
563+
.describe("Scroll axis — `orientation={schema.orientation || 'horizontal'}` (objectui#6150)"),
564+
// Applied at renderers/complex/carousel.tsx:30 as `className={schema.itemClassName}` on every CarouselItem.
565+
itemClassName: z.string().optional().describe('Per-slide Tailwind classes, applied to every carousel item (objectui#6150)'),
566566
autoPlay: z.number().optional().describe('Auto-play interval (ms)'),
567567
showArrows: z.boolean().optional().describe('Show navigation arrows'),
568568
showDots: z.boolean().optional().describe('Show navigation dots'),
@@ -615,10 +615,10 @@ export const ChatMessageSchema = z.object({
615615
reasoning: z.string().optional().describe('Chain-of-thought reasoning text'),
616616
sources: z.array(ChatMessageSourceSchema).optional().describe('Citation sources'),
617617
traceId: z.string().optional().describe('Backend trace id (ai_traces.id)'),
618-
avatar: z.string().optional()
619-
.describe('Per-message avatar image URL overriding the chatbot-level userAvatarUrl / assistantAvatarUrl, read at plugin-chatbot/src/index.tsx:173–174 — `message.avatar || userAvatarUrl` (objectui#7295)'),
620-
avatarFallback: z.string().optional()
621-
.describe('Per-message avatar fallback text overriding the chatbot-level userAvatarFallback / assistantAvatarFallback, read at plugin-chatbot/src/index.tsx:177–178 — `message.avatarFallback || userAvatarFallback` (objectui#7295)'),
618+
// Read at plugin-chatbot/src/index.tsx:172-174 as `message.avatar || userAvatarUrl` (or `|| assistantAvatarUrl` on the assistant branch).
619+
avatar: z.string().optional().describe('Per-message avatar image URL overriding the chatbot-level userAvatarUrl / assistantAvatarUrl (objectui#7295)'),
620+
// Read at plugin-chatbot/src/index.tsx:176-178 as `message.avatarFallback || userAvatarFallback` (or `|| assistantAvatarFallback` on the assistant branch).
621+
avatarFallback: z.string().optional().describe('Per-message avatar fallback text overriding the chatbot-level userAvatarFallback / assistantAvatarFallback (objectui#7295)'),
622622
});
623623

624624
/**

0 commit comments

Comments
 (0)