Skip to content

Commit f072cbb

Browse files
os-zhuangclaude
andauthored
docs(field-types): correct type count (48) and fold barcode into qrcode (#24)
The reference claimed "53 built-in field types" but the spec FieldType enum has 48. `barcode` is not a distinct type — `qrcode` covers QR + barcode formats — and the `qrErrorCorrection` / `barcodeFormat` display knobs were pruned as dead surface (no runtime reader). Drop the bogus `barcode` row, fold its use-case (EAN/UPC/Code128) into `qrcode`, and fix the count. English + all six translations (de/es/fr/ja/ko/zh-Hans); apps/docs type-check passes. Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 1caa974 commit f072cbb

7 files changed

Lines changed: 14 additions & 21 deletions

File tree

content/docs/reference/field-types.de.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Jeder Feldtyp, den du auf einem Objekt deklarieren kannst — was e
55

66
# Feldtypen
77

8-
53 integrierte Feldtypen, gruppiert nach Familie. Das vollständige Zod-Schema befindet sich in
8+
48 integrierte Feldtypen, gruppiert nach Familie. Das vollständige Zod-Schema befindet sich in
99
[`packages/spec/src/data/field.zod.ts`](https://github.com/objectstack-ai/framework/blob/main/packages/spec/src/data/field.zod.ts) — diese Seite ist eine praktische Zusammenfassung.
1010

1111
## Kerneigenschaften (jedes Feld)
@@ -166,8 +166,7 @@ fileAttachmentConfig: {
166166
| `rating` | 1–N Sterne — `max`, `icon` |
167167
| `slider` | begrenzte Zahl mit Schieberegler-UI |
168168
| `signature` | gezeichnete Unterschrift, als Bild gespeichert |
169-
| `qrcode` | rendert den Wert als QR-Code — `qrErrorCorrection: 'L' \| 'M' \| 'Q' \| 'H'` |
170-
| `barcode` | EAN/UPC/Code128 — `barcodeFormat` |
169+
| `qrcode` | rendert den Wert als QR-Code oder Barcode (EAN / UPC / Code128) |
171170
| `progress` | abgeleiteter Prozentwert als Balken dargestellt |
172171
| `tags` | frei wählbares Tag-Array mit Autovervollständigung |
173172
| `vector` | Embedding-Spalte — `vectorConfig: { dimensions, distanceMetric: 'cosine' \| 'euclidean', indexed, indexType: 'hnsw' \| 'ivfflat' }` |

content/docs/reference/field-types.es.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Cada tipo de campo que puedes declarar en un objeto — qué almace
55

66
# Tipos de campo
77

8-
53 tipos de campo integrados, agrupados por familia. El esquema Zod completo está en
8+
48 tipos de campo integrados, agrupados por familia. El esquema Zod completo está en
99
[`packages/spec/src/data/field.zod.ts`](https://github.com/objectstack-ai/framework/blob/main/packages/spec/src/data/field.zod.ts) — esta página es un resumen práctico.
1010

1111
## Propiedades fundamentales (cada campo)
@@ -166,8 +166,7 @@ fileAttachmentConfig: {
166166
| `rating` | 1–N estrellas — `max`, `icon` |
167167
| `slider` | número acotado con interfaz de control deslizante |
168168
| `signature` | firma dibujada, almacenada como imagen |
169-
| `qrcode` | renderiza el valor como un código QR — `qrErrorCorrection: 'L' \| 'M' \| 'Q' \| 'H'` |
170-
| `barcode` | EAN/UPC/Code128 — `barcodeFormat` |
169+
| `qrcode` | renderiza el valor como un código QR o de barras (EAN / UPC / Code128) |
171170
| `progress` | porcentaje derivado renderizado como una barra |
172171
| `tags` | arreglo de etiquetas de formato libre con autocompletado |
173172
| `vector` | columna de embedding — `vectorConfig: { dimensions, distanceMetric: 'cosine' \| 'euclidean', indexed, indexType: 'hnsw' \| 'ivfflat' }` |

content/docs/reference/field-types.fr.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Chaque type de champ que vous pouvez déclarer sur un objet — ce
55

66
# Types de champ
77

8-
53 types de champ intégrés, regroupés par famille. Le schéma Zod complet se trouve dans
8+
48 types de champ intégrés, regroupés par famille. Le schéma Zod complet se trouve dans
99
[`packages/spec/src/data/field.zod.ts`](https://github.com/objectstack-ai/framework/blob/main/packages/spec/src/data/field.zod.ts) — cette page en est un résumé pratique.
1010

1111
## Propriétés fondamentales (chaque champ)
@@ -166,8 +166,7 @@ fileAttachmentConfig: {
166166
| `rating` | 1–N étoiles — `max`, `icon` |
167167
| `slider` | nombre borné avec interface à curseur |
168168
| `signature` | signature dessinée, stockée sous forme d'image |
169-
| `qrcode` | affiche la valeur sous forme de QR — `qrErrorCorrection: 'L' \| 'M' \| 'Q' \| 'H'` |
170-
| `barcode` | EAN/UPC/Code128 — `barcodeFormat` |
169+
| `qrcode` | affiche la valeur sous forme de QR ou code-barres (EAN / UPC / Code128) |
171170
| `progress` | pourcentage dérivé affiché sous forme de barre |
172171
| `tags` | tableau de tags libres avec autocomplétion |
173172
| `vector` | colonne d'embedding — `vectorConfig: { dimensions, distanceMetric: 'cosine' \| 'euclidean', indexed, indexType: 'hnsw' \| 'ivfflat' }` |

content/docs/reference/field-types.ja.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: オブジェクトに宣言できるすべてのフィールドタ
55

66
# フィールドタイプ
77

8-
53 個の組み込みフィールドタイプを、ファミリーごとに分類しています。完全な Zod スキーマは
8+
48 個の組み込みフィールドタイプを、ファミリーごとに分類しています。完全な Zod スキーマは
99
[`packages/spec/src/data/field.zod.ts`](https://github.com/objectstack-ai/framework/blob/main/packages/spec/src/data/field.zod.ts) にあります — このページは実用的なサマリーです。
1010

1111
## コアプロパティ(すべてのフィールド)
@@ -166,8 +166,7 @@ fileAttachmentConfig: {
166166
| `rating` | 1〜N 個の星 — `max`, `icon` |
167167
| `slider` | スライダー UI を持つ範囲付き数値 |
168168
| `signature` | 手書き署名。画像として格納 |
169-
| `qrcode` | 値を QR としてレンダリング — `qrErrorCorrection: 'L' \| 'M' \| 'Q' \| 'H'` |
170-
| `barcode` | EAN/UPC/Code128 — `barcodeFormat` |
169+
| `qrcode` | 値を QR またはバーコード(EAN / UPC / Code128)としてレンダリング |
171170
| `progress` | 導出されたパーセントをバーとして表示 |
172171
| `tags` | オートコンプリート付きの自由形式タグ配列 |
173172
| `vector` | 埋め込みカラム — `vectorConfig: { dimensions, distanceMetric: 'cosine' \| 'euclidean', indexed, indexType: 'hnsw' \| 'ivfflat' }` |

content/docs/reference/field-types.ko.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: 객체에 선언할 수 있는 모든 필드 타입 — 저장하
55

66
# 필드 타입
77

8-
패밀리별로 분류된 53가지 기본 제공 필드 타입. 전체 Zod 스키마는
8+
패밀리별로 분류된 48가지 기본 제공 필드 타입. 전체 Zod 스키마는
99
[`packages/spec/src/data/field.zod.ts`](https://github.com/objectstack-ai/framework/blob/main/packages/spec/src/data/field.zod.ts)에 있으며, 이 페이지는 실용적인 요약입니다.
1010

1111
## 핵심 속성 (모든 필드)
@@ -166,8 +166,7 @@ fileAttachmentConfig: {
166166
| `rating` | 1–N 별점 — `max`, `icon` |
167167
| `slider` | 슬라이더 UI를 갖춘 범위 제한 숫자 |
168168
| `signature` | 그려진 서명, 이미지로 저장 |
169-
| `qrcode` | 값을 QR로 렌더링 — `qrErrorCorrection: 'L' \| 'M' \| 'Q' \| 'H'` |
170-
| `barcode` | EAN/UPC/Code128 — `barcodeFormat` |
169+
| `qrcode` | 값을 QR 또는 바코드(EAN / UPC / Code128)로 렌더링 |
171170
| `progress` | 막대로 렌더링되는 파생 백분율 |
172171
| `tags` | 자동 완성이 있는 자유 형식 태그 배열 |
173172
| `vector` | 임베딩 컬럼 — `vectorConfig: { dimensions, distanceMetric: 'cosine' \| 'euclidean', indexed, indexType: 'hnsw' \| 'ivfflat' }` |

content/docs/reference/field-types.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Every field type you can declare on an object — what it stores, w
55

66
# Field Types
77

8-
53 built-in field types, grouped by family. The full Zod schema is in
8+
48 built-in field types, grouped by family. The full Zod schema is in
99
[`packages/spec/src/data/field.zod.ts`](https://github.com/objectstack-ai/framework/blob/main/packages/spec/src/data/field.zod.ts) — this page is a working summary.
1010

1111
## Core properties (every field)
@@ -166,8 +166,7 @@ fileAttachmentConfig: {
166166
| `rating` | 1–N stars — `max`, `icon` |
167167
| `slider` | bounded number with slider UI |
168168
| `signature` | drawn signature, stored as image |
169-
| `qrcode` | renders the value as a QR — `qrErrorCorrection: 'L' \| 'M' \| 'Q' \| 'H'` |
170-
| `barcode` | EAN/UPC/Code128 — `barcodeFormat` |
169+
| `qrcode` | renders the value as a QR or barcode (EAN / UPC / Code128) |
171170
| `progress` | derived percent rendered as a bar |
172171
| `tags` | free-form tag array with autocomplete |
173172
| `vector` | embedding column — `vectorConfig: { dimensions, distanceMetric: 'cosine' \| 'euclidean', indexed, indexType: 'hnsw' \| 'ivfflat' }` |

content/docs/reference/field-types.zh-Hans.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: 你可以在对象上声明的所有字段类型 —— 存储什
55

66
# 字段类型
77

8-
53 个内置字段类型,按家族分组。完整的 Zod schema 在
8+
48 个内置字段类型,按家族分组。完整的 Zod schema 在
99
[`packages/spec/src/data/field.zod.ts`](https://github.com/objectstack-ai/framework/blob/main/packages/spec/src/data/field.zod.ts) —— 本页为工作摘要。
1010

1111
## 核心属性(每个字段都有)
@@ -165,8 +165,7 @@ fileAttachmentConfig: {
165165
| `rating` | 1–N 星 —— `max``icon` |
166166
| `slider` | 带滑块 UI 的有界数字 |
167167
| `signature` | 手绘签名,存为图像 |
168-
| `qrcode` | 将值渲染为 QR —— `qrErrorCorrection: 'L' \| 'M' \| 'Q' \| 'H'` |
169-
| `barcode` | EAN/UPC/Code128 —— `barcodeFormat` |
168+
| `qrcode` | 将值渲染为 QR 或条形码(EAN / UPC / Code128) |
170169
| `progress` | 派生百分比,以进度条渲染 |
171170
| `tags` | 带自动完成的自由标签数组 |
172171
| `vector` | 嵌入列 —— `vectorConfig: { dimensions, distanceMetric: 'cosine' \| 'euclidean', indexed, indexType: 'hnsw' \| 'ivfflat' }` |

0 commit comments

Comments
 (0)