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
22 changes: 14 additions & 8 deletions content/docs/core/report-schema.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ complete list.

### Report Fields

```plaintext
```ts
interface ReportField {
name: string; // Field name
label?: string; // Display label
Expand Down Expand Up @@ -164,7 +164,7 @@ rendering — a field with no `type` falls back to plain text.

### Filters

```plaintext
```ts
interface ReportFilter {
field: string;
operator: 'equals' | 'not_equals' | 'contains' | 'greater_than' |
Expand All @@ -176,7 +176,7 @@ interface ReportFilter {

### Group By

```plaintext
```ts
interface ReportGroupBy {
field: string;
label?: string;
Expand All @@ -188,7 +188,9 @@ interface ReportGroupBy {

Define report structure with sections:

```plaintext
```ts
import type { ChartSchema, ReportField, SchemaNode } from '@object-ui/types';

interface ReportSection {
type: 'header' | 'summary' | 'chart' | 'table' | 'text' | 'page-break';
title?: string;
Expand All @@ -202,7 +204,7 @@ interface ReportSection {

## Export Configuration

```plaintext
```ts
interface ReportExportConfig {
format: 'pdf' | 'excel' | 'csv' | 'json' | 'html';
filename?: string;
Expand All @@ -215,8 +217,10 @@ interface ReportExportConfig {

## Scheduling

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

interface ReportScheduleConfig {
enabled?: boolean;
frequency?: 'once' | 'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly';
dayOfWeek?: number; // For weekly (0-6)
Expand All @@ -232,7 +236,9 @@ interface ReportSchedule {

## Complete Example

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

const comprehensiveReport: ReportComponentSchema = {
type: 'report',
title: 'Quarterly Sales Analysis',
Expand Down
2 changes: 1 addition & 1 deletion content/docs/plugins/plugin-calendar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -566,7 +566,7 @@ function MyObjectCalendar({ dataSource }: { dataSource: DataSource }) {

## TypeScript Support

```plaintext
```ts
import type {
CalendarViewSchema,
ObjectCalendarSchema,
Expand Down
4 changes: 2 additions & 2 deletions content/docs/plugins/plugin-chatbot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -668,7 +668,7 @@ Each of the three registrations has its own authoring-face type:
`ChatbotFloatingSchema` (`chatbot-floating`) - see the typed examples under
**Tool Messages** and **`chatbot-floating` panel and trigger keys** above.

```plaintext
```ts
import type { ChatbotSchema, ChatbotEnhancedSchema, ChatbotFloatingSchema, ChatMessage, ChatToolInvocation } from '@object-ui/types'
import { useObjectChat } from '@object-ui/plugin-chatbot'

Expand Down Expand Up @@ -707,7 +707,7 @@ You AUTHOR with `@object-ui/types`' `ChatMessage`. What `useObjectChat` HANDS
BACK — from `messages` and from `onSend(content, messages)` — is
`ObjectChatMessage`, exported from `@object-ui/plugin-chatbot`:

```plaintext
```ts
import type { ObjectChatMessage } from '@object-ui/plugin-chatbot'
```

Expand Down
6 changes: 3 additions & 3 deletions content/docs/plugins/plugin-dashboard.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ the spec rejects it by name, so new documents author `label`. The retired

### Auto-registration (Side-effect Import)

```plaintext
```ts
import '@object-ui/plugin-dashboard';
```

Expand Down Expand Up @@ -142,7 +142,7 @@ The import above needs no follow-up call. What a manual registration is for here
is serving one of this package's exported components under a key of your own —
you register the component, not a map:

```plaintext
```ts
import { ComponentRegistry } from '@object-ui/core';
import { MetricCard } from '@object-ui/plugin-dashboard';

Expand Down Expand Up @@ -366,7 +366,7 @@ from widget `options`. In particular, on a dataset-bound gauge:

## TypeScript Support

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

const widget: DashboardWidgetSchema = {
Expand Down
6 changes: 3 additions & 3 deletions content/docs/plugins/plugin-gantt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -466,8 +466,8 @@ const campaignGantt: ObjectGanttSchema = {

## TypeScript Support

```plaintext
import type { ObjectGridSchema, GanttConfig } from '@object-ui/types'
```ts
import type { ObjectGanttSchema, GanttConfig } from '@object-ui/types'

const ganttConfig: GanttConfig = {
startDateField: 'startDate',
Expand All @@ -477,7 +477,7 @@ const ganttConfig: GanttConfig = {
dependenciesField: 'dependencies'
}

const ganttSchema: ObjectGridSchema = {
const ganttSchema: ObjectGanttSchema = {
type: 'object-gantt',
objectName: 'project_tasks',
gantt: ganttConfig
Expand Down
2 changes: 1 addition & 1 deletion content/docs/plugins/plugin-kanban.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -516,7 +516,7 @@ The kanban board includes:
shapes. Importing all three from the plugin does not resolve — its barrel never
exported the schema type.

```plaintext
```ts
import type { ObjectKanbanSchema } from '@object-ui/types'
import type { KanbanCard, KanbanColumn } from '@object-ui/plugin-kanban'

Expand Down
2 changes: 1 addition & 1 deletion content/docs/plugins/plugin-map.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -537,7 +537,7 @@ Consider using one of the full-featured mapping libraries above.

## TypeScript Support

```plaintext
```ts
import type { ObjectMapSchema, ObjectMapConfig } from '@object-ui/types'

const mapConfig: ObjectMapConfig = {
Expand Down
2 changes: 1 addition & 1 deletion content/docs/plugins/plugin-timeline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,7 @@ const schema: TimelineSchema = {

## TypeScript Support

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

const timelineSchema: TimelineSchema = {
Expand Down
8 changes: 0 additions & 8 deletions scripts/check-doc-fence-languages.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -435,14 +435,6 @@ export const KNOWN_UNHIGHLIGHTED_TS_FENCES = new Map([
['content/docs/components/overlay/popover.mdx', 1],
['content/docs/components/overlay/sheet.mdx', 1],
['content/docs/components/overlay/tooltip.mdx', 1],
['content/docs/core/report-schema.mdx', 7],
['content/docs/plugins/plugin-calendar.mdx', 1],
['content/docs/plugins/plugin-chatbot.mdx', 2],
['content/docs/plugins/plugin-dashboard.mdx', 3],
['content/docs/plugins/plugin-gantt.mdx', 1],
['content/docs/plugins/plugin-kanban.mdx', 1],
['content/docs/plugins/plugin-map.mdx', 1],
['content/docs/plugins/plugin-timeline.mdx', 1],
]);

/** Split observed counts against the baseline. Both directions are failures. */
Expand Down
Loading