Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .changeset/5867-plaintext-fenced-ts-batch3.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
---
---

Docs only, publishes nothing: seventeen TypeScript snippets across ten
`content/docs/fields/*.mdx` reference pages were fenced ```plaintext, so
`check-doc-snippet-types` — which reads only `ts` / `tsx` fences — never saw
them (objectui#5867, batch 3 of N). Triage's classifier is the one applied: a
plaintext block whose first line starts with `import` / `export` / `interface` /
`type X =` / `const x: T` is code, and those fences are now `ts`; genuinely
prose blocks on the same pages are left alone. Compiling them found two real
documentation defects, now fixed: `image` annotated `ImageFieldSchema.value`
with `FileMetadata`, a name `@object-ui/types` does not export — it was
deliberately renamed to `UploadedFileMetadata` (objectstack#4115) because the
spec's same-named type is the storage layer's file record, a different shape —
and `lookup` referenced `DataSource` without importing it. The gate's
blocks-to-compile count rises from 206 to 223 — exactly the batch — with
diagnostics at 0, no new `FRAGMENT_MARKER` declarations, and the
covered/ungated sets unmoved. The blocks also stop rendering as unstyled
plaintext and pick up TypeScript highlighting, which is reader-visible. Three
further `fields` pages are excluded by measurement with blockers filed:
`auto-number` (an ambient backend `db` handle), `object` (imports `ajv`, not a
workspace dependency) and `location` (one fence welds a JSX element and a bare
metadata object literal, so it parses as neither `ts` nor `tsx`).
4 changes: 2 additions & 2 deletions content/docs/fields/file.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ The File Field component provides a file upload interface with support for multi

## Field Schema

```plaintext
```ts
interface FileFieldSchema {
type: 'file';
name: string; // Field name/ID
Expand DownExpand Up@@ -79,7 +79,7 @@ accept: ['image/*'] // All images

In tables/grids, displays file count:

```plaintext
```ts
import { FileCellRenderer } from '@object-ui/fields';

// Renders: "3 files" or "document.pdf"
Expand Down
4 changes: 2 additions & 2 deletions content/docs/fields/formula.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ The Formula Field component displays computed values calculated from other field

## Field Schema

```plaintext
```ts
interface FormulaFieldSchema {
type: 'formula';
name: string; // Field name/ID
Expand DownExpand Up@@ -70,7 +70,7 @@ formula: 'end_date - start_date'

In tables/grids, displays with monospace font:

```plaintext
```ts
import { FormulaCellRenderer } from '@object-ui/fields';

// Renders computed value in monospace font
Expand Down
2 changes: 1 addition & 1 deletion content/docs/fields/grid.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ The Grid Field component provides an inline table for managing related records o

## Field Schema

```plaintext
```ts
interface GridFieldSchema {
type: 'grid';
name: string; // Field name/ID
Expand Down
8 changes: 5 additions & 3 deletions content/docs/fields/image.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,12 +15,14 @@ The Image Field component provides an image upload interface with thumbnail prev

## Field Schema

```plaintext
```ts
import type { UploadedFileMetadata } from '@object-ui/types';

interface ImageFieldSchema {
type: 'image';
name: string; // Field name/ID
label?: string; // Field label
value?: FileMetadata | FileMetadata[]; // Current image(s)
value?: UploadedFileMetadata | UploadedFileMetadata[]; // Current image(s)
required?: boolean; // Is field required
readonly?: boolean; // Read-only mode
disabled?: boolean; // Disabled state
Expand DownExpand Up@@ -58,7 +60,7 @@ accept: ['image/png', 'image/jpeg', 'image/gif', 'image/webp']

In tables/grids, displays image thumbnails:

```plaintext
```ts
import { ImageCellRenderer } from '@object-ui/fields';

// Shows up to 3 thumbnails plus count if more
Expand Down
6 changes: 4 additions & 2 deletions content/docs/fields/lookup.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,9 @@ The Lookup Field component provides a reference field for creating relationships

## Field Schema

```plaintext
```ts
import type { DataSource } from '@object-ui/types';

interface LookupFieldSchema {
type: 'lookup' | 'master_detail';
name: string; // Field name/ID
Expand DownExpand Up@@ -140,7 +142,7 @@ The Record Picker dialog provides:

In tables/grids, lookup values display the referenced record name:

```plaintext
```ts
import { LookupCellRenderer } from '@object-ui/fields';

// Single value: Display name/label
Expand Down
4 changes: 2 additions & 2 deletions content/docs/fields/rich-text.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ The Rich Text Field component provides a WYSIWYG editor for creating formatted t

## Field Schema

```plaintext
```ts
interface RichTextFieldSchema {
type: 'markdown' | 'html';
name: string; // Field name/ID
Expand DownExpand Up@@ -57,7 +57,7 @@ interface RichTextFieldSchema {

In tables/grids, rich text is shown as plain text:

```plaintext
```ts
import { TextCellRenderer } from '@object-ui/fields';

// Strips formatting, shows plain text only
Expand Down
4 changes: 2 additions & 2 deletions content/docs/fields/select.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -90,7 +90,7 @@ candidate query is filtered server-side and paginated. See

## Field Schema

```plaintext
```ts
interface SelectFieldSchema {
type: 'select';
name: string; // Field name/ID
Expand DownExpand Up@@ -141,7 +141,7 @@ interface SelectOption {

In tables/grids, select values are displayed as colored badges:

```plaintext
```ts
import { SelectCellRenderer } from '@object-ui/fields';

// Single value: Colored badge
Expand Down
2 changes: 1 addition & 1 deletion content/docs/fields/summary.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ The Summary Field component displays aggregated values from related records. Thi

## Field Schema

```plaintext
```ts
interface SummaryFieldSchema {
type: 'summary';
name: string; // Field name/ID
Expand Down
4 changes: 2 additions & 2 deletions content/docs/fields/user.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,7 @@ it display-only.

## Field Schema

```plaintext
```ts
interface UserFieldSchema {
type: 'user';
name: string; // Field name/ID
Expand DownExpand Up@@ -73,7 +73,7 @@ text input. Write `{ type: 'user', name: 'owner' }` instead.

In tables/grids, displays avatar with name:

```plaintext
```ts
import { UserCellRenderer } from '@object-ui/fields';

// Single user: Avatar + name
Expand Down
2 changes: 1 addition & 1 deletion content/docs/fields/vector.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ The Vector Field component displays vector embeddings used in AI/ML applications

## Field Schema

```plaintext
```ts
interface VectorFieldSchema {
type: 'vector';
name: string; // Field name/ID
Expand Down