docs(guides,plugins,tooling): clear three .mdx pages off the doc-snippet ledger (#5174 batch 5)#7294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yinlianghui merged 5 commits into from
Sep 2, 2026
Merged

docs(guides,plugins,tooling): clear three .mdx pages off the doc-snippet ledger (#5174 batch 5) #7294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
24dac63
wip: remove three .mdx entries from UNGATED_DOCS
claude Sep 2, 2026
d856f77
wip: plugin-chatbot.mdx blocks compile
claude Sep 2, 2026
533f865
wip: plugin-map.mdx blocks compile or declared
claude Sep 2, 2026
fa68ef1
wip: objectos-integration.mdx blocks compile or declared
claude Sep 2, 2026
fe053c7
Merge remote-tracking branch 'origin/main' into claude/issue-5174-mdx…
claude Sep 2, 2026
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
91 changes: 67 additions & 24 deletions content/docs/guide/objectos-integration.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,8 @@ pnpm add @object-ui/plugin-form @object-ui/plugin-grid

### 2. Set Up ObjectStack Kernel

{/* doc-snippet: fragment — this file belongs to the ObjectStack SERVER project, not to an ObjectUI app. `@objectstack/runtime`, `@objectstack/objectql`, `@objectstack/plugin-app` and `@objectstack/plugin-hono-server` are dependencies of that project and are not declared by any package in this repository, so they do not resolve in this gate's program (measured: TS2307 x4). Correct documentation the gate cannot reach — the authoritative reference is the ObjectStack side, linked in the section below */}

```typescript
// src/kernel.ts
import { Kernel } from '@objectstack/runtime';
Expand DownExpand Up@@ -156,19 +158,28 @@ ReactDOM.createRoot(document.getElementById('root')!).render(

### Multi-Tenancy Support

The adapter's constructor takes no `headers` option. Per-request headers go
through its `fetch` hook, which it uses for every call it makes:

```typescript
// Configure tenant isolation
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
baseUrl: 'http://localhost:3000/api',
headers: {
'X-Tenant-ID': 'tenant-123',
'X-Workspace-ID': 'workspace-456'
fetch: (input, init) => {
const headers = new Headers(init?.headers);
headers.set('X-Tenant-ID', 'tenant-123');
headers.set('X-Workspace-ID', 'workspace-456');
return globalThis.fetch(input, { ...init, headers });
}
});
```

### Role-Based Access Control (RBAC)

{/* doc-snippet: fragment — a SHAPE excerpt of the ObjectStack SERVER's object metadata (the `objects` map of `defineStack()`), not an expression: a bare object literal at statement position parses as a block with labels (measured: TS1005 x4, TS1109 x1, TS1128 x1). This repo declares no type for it — ObjectUI is a pure consumer of what the server publishes */}

```typescript
// Define permissions in object schema
{
Expand DownExpand Up@@ -203,17 +214,26 @@ const adapter = new ObjectStackAdapter({
ObjectOS provides system objects like `sys_user`, `sys_organization`, `sys_role`, etc. Integrate them in your UI:

```typescript
{
import { ObjectStackAdapter } from '@object-ui/data-objectstack';
import type { ObjectViewSchema } from '@object-ui/types';

const objectStackAdapter = new ObjectStackAdapter({
baseUrl: 'http://localhost:3000/api'
});

const sysUserView: ObjectViewSchema = {
type: 'object-view',
objectName: 'sys_user',
dataSource: objectStackAdapter,
viewTypes: ['grid'],
fieldNames: ['username', 'email', 'role', 'status', 'last_login']
}
defaultViewType: 'grid',
columns: ['username', 'email', 'role', 'status', 'last_login']
};
```

### Workflow Integration

{/* doc-snippet: fragment — a SHAPE excerpt of the ObjectStack SERVER's object metadata, not an expression: a bare object literal at statement position parses as a block with labels (measured: TS1005 x4, TS1128 x1). `workflow` is a server-side object concern; this repo declares no type for it */}

```typescript
// Define workflow-enabled object
{
Expand DownExpand Up@@ -277,7 +297,7 @@ go through `useViewData` from `@object-ui/react`, which resolves the adapter
from context and hands back both the rows and the `DataSource` to write with.

```typescript
import { useViewData } from '@object-ui/react';
import { SchemaRenderer, useViewData } from '@object-ui/react';

function ContactList() {
const { data, loading, error, dataSource, refresh } = useViewData({
Expand DownExpand Up@@ -315,6 +335,8 @@ function ContactList() {

Deploy ObjectUI and ObjectStack together in a single Node.js process:

{/* doc-snippet: fragment — `./kernel` and `./console-plugin` are the READER's own project files (the kernel module is the one built in step 2 above), so the relative specifiers resolve nowhere in this gate's program (measured: TS2307 x2) */}

```typescript
// server.ts
import { createKernel } from './kernel';
Expand All@@ -338,6 +360,9 @@ start();
Deploy ObjectUI (frontend) and ObjectStack (backend) separately:

**Backend (ObjectStack API):**

{/* doc-snippet: fragment — `./kernel` is the READER's own project file (the kernel module built in step 2 above), so the relative specifier resolves nowhere in this gate's program (measured: TS2307 x1) */}

```typescript
// backend/server.ts
import { createKernel } from './kernel';
Expand All@@ -351,6 +376,9 @@ start();
```

**Frontend (ObjectUI):**

{/* doc-snippet: fragment — two files in one block, and it is `import.meta.env` that cannot compile here: the `env` member is a Vite ambient declaration carried by the READER's `vite/client` types, which this repository's gate program does not load (measured: TS2339 x1, plus TS2304 x1 for the adapter the second file imports in the reader's own entry point) */}

```typescript
// frontend/src/config.ts
export const config = {
Expand DownExpand Up@@ -424,6 +452,8 @@ spec:

### Custom Component Registration

{/* doc-snippet: fragment — `MyCustomWidget` is the READER's own component, and the block closes with a bare `{ type: 'my-custom-widget' }` SHAPE excerpt showing where the registered name is then used, which at statement position parses as a block with labels (measured: TS1005 x1) */}

```typescript
// Register custom components with ObjectUI
import { ComponentRegistry } from '@object-ui/core';
Expand All@@ -444,6 +474,8 @@ ComponentRegistry.register('my-custom-widget', MyCustomWidget, {

### Event Handling & Callbacks

{/* doc-snippet: fragment — a SHAPE excerpt continuing the "Using ObjectQL for Queries" block above, which is where `dataSource` is constructed: a bare object literal at statement position parses as a block with labels (measured: TS1005 x3) */}

```typescript
{
type: 'object-grid',
Expand All@@ -464,31 +496,38 @@ ComponentRegistry.register('my-custom-widget', MyCustomWidget, {
}
```

### Real-time Updates with WebSockets
### Reacting to Data Changes

⚠️ `@object-ui/data-objectstack` has **no WebSocket transport and no server-push
subscription**. What it offers is `onMutation`: a notification of the writes
*this adapter instance* performed, which is what a view needs to refresh itself
after its own create/update/delete. It returns its own unsubscribe function.

```typescript
// Configure WebSocket connection
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
baseUrl: 'http://localhost:3000/api',
websocket: {
enabled: true,
url: 'ws://localhost:3000/ws'
}
baseUrl: 'http://localhost:3000/api'
});

// Subscribe to real-time updates
adapter.subscribe('contact', (event) => {
// Fires for writes this adapter performed. Filter by `resource` for one object.
const unsubscribe = adapter.onMutation((event) => {
if (event.resource !== 'contact') return;
if (event.type === 'create' || event.type === 'update') {
// Refresh grid
gridRef.current?.refresh();
// Refresh the view holding this object's rows
}
});

// Later, when the view unmounts:
unsubscribe();
```

## Migration from Other Platforms

### From Retool

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison; `dataSource` continues the "Using ObjectQL for Queries" block above, and a bare object literal at statement position parses as a block with labels (measured: TS1005 x4) */}

```typescript
// Retool table → ObjectUI Grid
{
Expand All@@ -503,6 +542,8 @@ adapter.subscribe('contact', (event) => {

### From Appsmith

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison; `dataSource` continues the "Using ObjectQL for Queries" block above, and a bare object literal at statement position parses as a block with labels (measured: TS1005 x4) */}

```typescript
// Appsmith form → ObjectUI form
{
Expand All@@ -519,6 +560,8 @@ adapter.subscribe('contact', (event) => {

### From Mendix

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison, with every slot body elided as a prose comment, so the object literal cannot parse as TypeScript (measured: TS1005 x2, TS1128 x2) */}

```typescript
// Mendix page → ObjectUI page
{
Expand DownExpand Up@@ -555,15 +598,13 @@ await plugins.grid();
### Caching Strategy

```typescript
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
baseUrl: 'http://localhost:3000/api',
cache: {
enabled: true,
ttl: 60000, // 1 minute
strategies: {
'contact': 'stale-while-revalidate',
'sys_user': 'cache-first'
}
maxSize: 500 // entries retained
}
});
```
Expand All@@ -572,6 +613,8 @@ const adapter = new ObjectStackAdapter({

### Unit Tests

{/* doc-snippet: fragment — a test body: `test` / `expect` are the RUNNER's globals (Vitest or Jest, injected by the reader's own test config, not imported here) and `mockDataSource` is the reader's own fixture, so none of the three resolves in this gate's program (measured: TS2593 x1, TS2304 x2) */}

```typescript
import { render } from '@testing-library/react';
import { SchemaRenderer } from '@object-ui/react';
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
docs(guides,plugins,tooling): clear three .mdx pages off the doc-snippet ledger (#5174 batch 5)#7294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

yinlianghui
merged 5 commits into

from

Sep 2, 2026
 Merged


docs(guides,plugins,tooling): clear three .mdx pages off the doc-snippet ledger (#5174 batch 5)
#7294
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
24dac63

wip: remove three .mdx entries from UNGATED_DOCS


claude Sep 2, 2026
d856f77

wip: plugin-chatbot.mdx blocks compile


claude Sep 2, 2026
533f865

wip: plugin-map.mdx blocks compile or declared


claude Sep 2, 2026
fa68ef1

wip: objectos-integration.mdx blocks compile or declared


claude Sep 2, 2026
fe053c7

Merge remote-tracking branch 'origin/main' into claude/issue-5174-mdx…


claude Sep 2, 2026

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


91 changes: 67 additions & 24 deletions
content/docs/guide/objectos-integration.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,8 @@ pnpm add @object-ui/plugin-form @object-ui/plugin-grid

### 2. Set Up ObjectStack Kernel

{/* doc-snippet: fragment — this file belongs to the ObjectStack SERVER project, not to an ObjectUI app. `@objectstack/runtime`, `@objectstack/objectql`, `@objectstack/plugin-app` and `@objectstack/plugin-hono-server` are dependencies of that project and are not declared by any package in this repository, so they do not resolve in this gate's program (measured: TS2307 x4). Correct documentation the gate cannot reach — the authoritative reference is the ObjectStack side, linked in the section below */}

```typescript
// src/kernel.ts
import { Kernel } from '@objectstack/runtime';
Expand DownExpand Up@@ -156,19 +158,28 @@ ReactDOM.createRoot(document.getElementById('root')!).render(

### Multi-Tenancy Support

The adapter's constructor takes no `headers` option. Per-request headers go
through its `fetch` hook, which it uses for every call it makes:

```typescript
// Configure tenant isolation
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api',
 headers: {
 'X-Tenant-ID': 'tenant-123',
 'X-Workspace-ID': 'workspace-456'
 fetch: (input, init) => {
 const headers = new Headers(init?.headers);
 headers.set('X-Tenant-ID', 'tenant-123');
 headers.set('X-Workspace-ID', 'workspace-456');
 return globalThis.fetch(input, { ...init, headers });
 }
});
```

### Role-Based Access Control (RBAC)

{/* doc-snippet: fragment — a SHAPE excerpt of the ObjectStack SERVER's object metadata (the `objects` map of `defineStack()`), not an expression: a bare object literal at statement position parses as a block with labels (measured: TS1005 x4, TS1109 x1, TS1128 x1). This repo declares no type for it — ObjectUI is a pure consumer of what the server publishes */}

```typescript
// Define permissions in object schema
{
Expand DownExpand Up@@ -203,17 +214,26 @@ const adapter = new ObjectStackAdapter({
ObjectOS provides system objects like `sys_user`, `sys_organization`, `sys_role`, etc. Integrate them in your UI:

```typescript
{
import { ObjectStackAdapter } from '@object-ui/data-objectstack';
import type { ObjectViewSchema } from '@object-ui/types';

const objectStackAdapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api'
});

const sysUserView: ObjectViewSchema = {
 type: 'object-view',
 objectName: 'sys_user',
 dataSource: objectStackAdapter,
viewTypes: ['grid'],
fieldNames: ['username', 'email', 'role', 'status', 'last_login']
}
defaultViewType: 'grid',
columns: ['username', 'email', 'role', 'status', 'last_login']
};
```

### Workflow Integration

{/* doc-snippet: fragment — a SHAPE excerpt of the ObjectStack SERVER's object metadata, not an expression: a bare object literal at statement position parses as a block with labels (measured: TS1005 x4, TS1128 x1). `workflow` is a server-side object concern; this repo declares no type for it */}

```typescript
// Define workflow-enabled object
{
Expand DownExpand Up@@ -277,7 +297,7 @@ go through `useViewData` from `@object-ui/react`, which resolves the adapter
from context and hands back both the rows and the `DataSource` to write with.

```typescript
import { useViewData } from '@object-ui/react';
import { SchemaRenderer, useViewData } from '@object-ui/react';

function ContactList() {
 const { data, loading, error, dataSource, refresh } = useViewData({
Expand DownExpand Up@@ -315,6 +335,8 @@ function ContactList() {

Deploy ObjectUI and ObjectStack together in a single Node.js process:

{/* doc-snippet: fragment — `./kernel` and `./console-plugin` are the READER's own project files (the kernel module is the one built in step 2 above), so the relative specifiers resolve nowhere in this gate's program (measured: TS2307 x2) */}

```typescript
// server.ts
import { createKernel } from './kernel';
Expand All@@ -338,6 +360,9 @@ start();
Deploy ObjectUI (frontend) and ObjectStack (backend) separately:

**Backend (ObjectStack API):**

{/* doc-snippet: fragment — `./kernel` is the READER's own project file (the kernel module built in step 2 above), so the relative specifier resolves nowhere in this gate's program (measured: TS2307 x1) */}

```typescript
// backend/server.ts
import { createKernel } from './kernel';
Expand All@@ -351,6 +376,9 @@ start();
```

**Frontend (ObjectUI):**

{/* doc-snippet: fragment — two files in one block, and it is `import.meta.env` that cannot compile here: the `env` member is a Vite ambient declaration carried by the READER's `vite/client` types, which this repository's gate program does not load (measured: TS2339 x1, plus TS2304 x1 for the adapter the second file imports in the reader's own entry point) */}

```typescript
// frontend/src/config.ts
export const config = {
Expand DownExpand Up@@ -424,6 +452,8 @@ spec:

### Custom Component Registration

{/* doc-snippet: fragment — `MyCustomWidget` is the READER's own component, and the block closes with a bare `{ type: 'my-custom-widget' }` SHAPE excerpt showing where the registered name is then used, which at statement position parses as a block with labels (measured: TS1005 x1) */}

```typescript
// Register custom components with ObjectUI
import { ComponentRegistry } from '@object-ui/core';
Expand All@@ -444,6 +474,8 @@ ComponentRegistry.register('my-custom-widget', MyCustomWidget, {

### Event Handling & Callbacks

{/* doc-snippet: fragment — a SHAPE excerpt continuing the "Using ObjectQL for Queries" block above, which is where `dataSource` is constructed: a bare object literal at statement position parses as a block with labels (measured: TS1005 x3) */}

```typescript
{
 type: 'object-grid',
Expand All@@ -464,31 +496,38 @@ ComponentRegistry.register('my-custom-widget', MyCustomWidget, {
}
```

### Real-time Updates with WebSockets
### Reacting to Data Changes

⚠️ `@object-ui/data-objectstack` has **no WebSocket transport and no server-push
subscription**. What it offers is `onMutation`: a notification of the writes
*this adapter instance* performed, which is what a view needs to refresh itself
after its own create/update/delete. It returns its own unsubscribe function.

```typescript
// Configure WebSocket connection
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api',
 websocket: {
 enabled: true,
 url: 'ws://localhost:3000/ws'
 }
 baseUrl: 'http://localhost:3000/api'
});

// Subscribe to real-time updates
adapter.subscribe('contact', (event) => {
// Fires for writes this adapter performed. Filter by `resource` for one object.
const unsubscribe = adapter.onMutation((event) => {
 if (event.resource !== 'contact') return;
 if (event.type === 'create' || event.type === 'update') {
 // Refresh grid
 gridRef.current?.refresh();
 // Refresh the view holding this object's rows
 }
});

// Later, when the view unmounts:
unsubscribe();
```

## Migration from Other Platforms

### From Retool

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison; `dataSource` continues the "Using ObjectQL for Queries" block above, and a bare object literal at statement position parses as a block with labels (measured: TS1005 x4) */}

```typescript
// Retool table → ObjectUI Grid
{
Expand All@@ -503,6 +542,8 @@ adapter.subscribe('contact', (event) => {

### From Appsmith

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison; `dataSource` continues the "Using ObjectQL for Queries" block above, and a bare object literal at statement position parses as a block with labels (measured: TS1005 x4) */}

```typescript
// Appsmith form → ObjectUI form
{
Expand All@@ -519,6 +560,8 @@ adapter.subscribe('contact', (event) => {

### From Mendix

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison, with every slot body elided as a prose comment, so the object literal cannot parse as TypeScript (measured: TS1005 x2, TS1128 x2) */}

```typescript
// Mendix page → ObjectUI page
{
Expand DownExpand Up@@ -555,15 +598,13 @@ await plugins.grid();
### Caching Strategy

```typescript
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api',
 cache: {
 enabled: true,
 ttl: 60000, // 1 minute
 strategies: {
 'contact': 'stale-while-revalidate',
 'sys_user': 'cache-first'
 }
 maxSize: 500 // entries retained
 }
});
```
Expand All@@ -572,6 +613,8 @@ const adapter = new ObjectStackAdapter({

### Unit Tests

{/* doc-snippet: fragment — a test body: `test` / `expect` are the RUNNER's globals (Vitest or Jest, injected by the reader's own test config, not imported here) and `mockDataSource` is the reader's own fixture, so none of the three resolves in this gate's program (measured: TS2593 x1, TS2304 x2) */}

```typescript
import { render } from '@testing-library/react';
import { SchemaRenderer } from '@object-ui/react';
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs(guides,plugins,tooling): clear three .mdx pages off the doc-snippet ledger (#5174 batch 5)#7294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

yinlianghui
merged 5 commits into

from

Sep 2, 2026
 Merged


docs(guides,plugins,tooling): clear three .mdx pages off the doc-snippet ledger (#5174 batch 5)
#7294
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
24dac63

wip: remove three .mdx entries from UNGATED_DOCS


claude Sep 2, 2026
d856f77

wip: plugin-chatbot.mdx blocks compile


claude Sep 2, 2026
533f865

wip: plugin-map.mdx blocks compile or declared


claude Sep 2, 2026
fa68ef1

wip: objectos-integration.mdx blocks compile or declared


claude Sep 2, 2026
fe053c7

Merge remote-tracking branch 'origin/main' into claude/issue-5174-mdx…


claude Sep 2, 2026

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


91 changes: 67 additions & 24 deletions
content/docs/guide/objectos-integration.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,8 @@ pnpm add @object-ui/plugin-form @object-ui/plugin-grid

### 2. Set Up ObjectStack Kernel

{/* doc-snippet: fragment — this file belongs to the ObjectStack SERVER project, not to an ObjectUI app. `@objectstack/runtime`, `@objectstack/objectql`, `@objectstack/plugin-app` and `@objectstack/plugin-hono-server` are dependencies of that project and are not declared by any package in this repository, so they do not resolve in this gate's program (measured: TS2307 x4). Correct documentation the gate cannot reach — the authoritative reference is the ObjectStack side, linked in the section below */}

```typescript
// src/kernel.ts
import { Kernel } from '@objectstack/runtime';
Expand DownExpand Up@@ -156,19 +158,28 @@ ReactDOM.createRoot(document.getElementById('root')!).render(

### Multi-Tenancy Support

The adapter's constructor takes no `headers` option. Per-request headers go
through its `fetch` hook, which it uses for every call it makes:

```typescript
// Configure tenant isolation
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api',
 headers: {
 'X-Tenant-ID': 'tenant-123',
 'X-Workspace-ID': 'workspace-456'
 fetch: (input, init) => {
 const headers = new Headers(init?.headers);
 headers.set('X-Tenant-ID', 'tenant-123');
 headers.set('X-Workspace-ID', 'workspace-456');
 return globalThis.fetch(input, { ...init, headers });
 }
});
```

### Role-Based Access Control (RBAC)

{/* doc-snippet: fragment — a SHAPE excerpt of the ObjectStack SERVER's object metadata (the `objects` map of `defineStack()`), not an expression: a bare object literal at statement position parses as a block with labels (measured: TS1005 x4, TS1109 x1, TS1128 x1). This repo declares no type for it — ObjectUI is a pure consumer of what the server publishes */}

```typescript
// Define permissions in object schema
{
Expand DownExpand Up@@ -203,17 +214,26 @@ const adapter = new ObjectStackAdapter({
ObjectOS provides system objects like `sys_user`, `sys_organization`, `sys_role`, etc. Integrate them in your UI:

```typescript
{
import { ObjectStackAdapter } from '@object-ui/data-objectstack';
import type { ObjectViewSchema } from '@object-ui/types';

const objectStackAdapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api'
});

const sysUserView: ObjectViewSchema = {
 type: 'object-view',
 objectName: 'sys_user',
 dataSource: objectStackAdapter,
viewTypes: ['grid'],
fieldNames: ['username', 'email', 'role', 'status', 'last_login']
}
defaultViewType: 'grid',
columns: ['username', 'email', 'role', 'status', 'last_login']
};
```

### Workflow Integration

{/* doc-snippet: fragment — a SHAPE excerpt of the ObjectStack SERVER's object metadata, not an expression: a bare object literal at statement position parses as a block with labels (measured: TS1005 x4, TS1128 x1). `workflow` is a server-side object concern; this repo declares no type for it */}

```typescript
// Define workflow-enabled object
{
Expand DownExpand Up@@ -277,7 +297,7 @@ go through `useViewData` from `@object-ui/react`, which resolves the adapter
from context and hands back both the rows and the `DataSource` to write with.

```typescript
import { useViewData } from '@object-ui/react';
import { SchemaRenderer, useViewData } from '@object-ui/react';

function ContactList() {
 const { data, loading, error, dataSource, refresh } = useViewData({
Expand DownExpand Up@@ -315,6 +335,8 @@ function ContactList() {

Deploy ObjectUI and ObjectStack together in a single Node.js process:

{/* doc-snippet: fragment — `./kernel` and `./console-plugin` are the READER's own project files (the kernel module is the one built in step 2 above), so the relative specifiers resolve nowhere in this gate's program (measured: TS2307 x2) */}

```typescript
// server.ts
import { createKernel } from './kernel';
Expand All@@ -338,6 +360,9 @@ start();
Deploy ObjectUI (frontend) and ObjectStack (backend) separately:

**Backend (ObjectStack API):**

{/* doc-snippet: fragment — `./kernel` is the READER's own project file (the kernel module built in step 2 above), so the relative specifier resolves nowhere in this gate's program (measured: TS2307 x1) */}

```typescript
// backend/server.ts
import { createKernel } from './kernel';
Expand All@@ -351,6 +376,9 @@ start();
```

**Frontend (ObjectUI):**

{/* doc-snippet: fragment — two files in one block, and it is `import.meta.env` that cannot compile here: the `env` member is a Vite ambient declaration carried by the READER's `vite/client` types, which this repository's gate program does not load (measured: TS2339 x1, plus TS2304 x1 for the adapter the second file imports in the reader's own entry point) */}

```typescript
// frontend/src/config.ts
export const config = {
Expand DownExpand Up@@ -424,6 +452,8 @@ spec:

### Custom Component Registration

{/* doc-snippet: fragment — `MyCustomWidget` is the READER's own component, and the block closes with a bare `{ type: 'my-custom-widget' }` SHAPE excerpt showing where the registered name is then used, which at statement position parses as a block with labels (measured: TS1005 x1) */}

```typescript
// Register custom components with ObjectUI
import { ComponentRegistry } from '@object-ui/core';
Expand All@@ -444,6 +474,8 @@ ComponentRegistry.register('my-custom-widget', MyCustomWidget, {

### Event Handling & Callbacks

{/* doc-snippet: fragment — a SHAPE excerpt continuing the "Using ObjectQL for Queries" block above, which is where `dataSource` is constructed: a bare object literal at statement position parses as a block with labels (measured: TS1005 x3) */}

```typescript
{
 type: 'object-grid',
Expand All@@ -464,31 +496,38 @@ ComponentRegistry.register('my-custom-widget', MyCustomWidget, {
}
```

### Real-time Updates with WebSockets
### Reacting to Data Changes

⚠️ `@object-ui/data-objectstack` has **no WebSocket transport and no server-push
subscription**. What it offers is `onMutation`: a notification of the writes
*this adapter instance* performed, which is what a view needs to refresh itself
after its own create/update/delete. It returns its own unsubscribe function.

```typescript
// Configure WebSocket connection
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api',
 websocket: {
 enabled: true,
 url: 'ws://localhost:3000/ws'
 }
 baseUrl: 'http://localhost:3000/api'
});

// Subscribe to real-time updates
adapter.subscribe('contact', (event) => {
// Fires for writes this adapter performed. Filter by `resource` for one object.
const unsubscribe = adapter.onMutation((event) => {
 if (event.resource !== 'contact') return;
 if (event.type === 'create' || event.type === 'update') {
 // Refresh grid
 gridRef.current?.refresh();
 // Refresh the view holding this object's rows
 }
});

// Later, when the view unmounts:
unsubscribe();
```

## Migration from Other Platforms

### From Retool

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison; `dataSource` continues the "Using ObjectQL for Queries" block above, and a bare object literal at statement position parses as a block with labels (measured: TS1005 x4) */}

```typescript
// Retool table → ObjectUI Grid
{
Expand All@@ -503,6 +542,8 @@ adapter.subscribe('contact', (event) => {

### From Appsmith

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison; `dataSource` continues the "Using ObjectQL for Queries" block above, and a bare object literal at statement position parses as a block with labels (measured: TS1005 x4) */}

```typescript
// Appsmith form → ObjectUI form
{
Expand All@@ -519,6 +560,8 @@ adapter.subscribe('contact', (event) => {

### From Mendix

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison, with every slot body elided as a prose comment, so the object literal cannot parse as TypeScript (measured: TS1005 x2, TS1128 x2) */}

```typescript
// Mendix page → ObjectUI page
{
Expand DownExpand Up@@ -555,15 +598,13 @@ await plugins.grid();
### Caching Strategy

```typescript
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api',
 cache: {
 enabled: true,
 ttl: 60000, // 1 minute
 strategies: {
 'contact': 'stale-while-revalidate',
 'sys_user': 'cache-first'
 }
 maxSize: 500 // entries retained
 }
});
```
Expand All@@ -572,6 +613,8 @@ const adapter = new ObjectStackAdapter({

### Unit Tests

{/* doc-snippet: fragment — a test body: `test` / `expect` are the RUNNER's globals (Vitest or Jest, injected by the reader's own test config, not imported here) and `mockDataSource` is the reader's own fixture, so none of the three resolves in this gate's program (measured: TS2593 x1, TS2304 x2) */}

```typescript
import { render } from '@testing-library/react';
import { SchemaRenderer } from '@object-ui/react';
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs(guides,plugins,tooling): clear three .mdx pages off the doc-snippet ledger (#5174 batch 5)#7294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

yinlianghui
merged 5 commits into

from

Sep 2, 2026
 Merged


docs(guides,plugins,tooling): clear three .mdx pages off the doc-snippet ledger (#5174 batch 5)
#7294
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
24dac63

wip: remove three .mdx entries from UNGATED_DOCS


claude Sep 2, 2026
d856f77

wip: plugin-chatbot.mdx blocks compile


claude Sep 2, 2026
533f865

wip: plugin-map.mdx blocks compile or declared


claude Sep 2, 2026
fa68ef1

wip: objectos-integration.mdx blocks compile or declared


claude Sep 2, 2026
fe053c7

Merge remote-tracking branch 'origin/main' into claude/issue-5174-mdx…


claude Sep 2, 2026

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


91 changes: 67 additions & 24 deletions
content/docs/guide/objectos-integration.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,8 @@ pnpm add @object-ui/plugin-form @object-ui/plugin-grid

### 2. Set Up ObjectStack Kernel

{/* doc-snippet: fragment — this file belongs to the ObjectStack SERVER project, not to an ObjectUI app. `@objectstack/runtime`, `@objectstack/objectql`, `@objectstack/plugin-app` and `@objectstack/plugin-hono-server` are dependencies of that project and are not declared by any package in this repository, so they do not resolve in this gate's program (measured: TS2307 x4). Correct documentation the gate cannot reach — the authoritative reference is the ObjectStack side, linked in the section below */}

```typescript
// src/kernel.ts
import { Kernel } from '@objectstack/runtime';
Expand DownExpand Up@@ -156,19 +158,28 @@ ReactDOM.createRoot(document.getElementById('root')!).render(

### Multi-Tenancy Support

The adapter's constructor takes no `headers` option. Per-request headers go
through its `fetch` hook, which it uses for every call it makes:

```typescript
// Configure tenant isolation
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api',
 headers: {
 'X-Tenant-ID': 'tenant-123',
 'X-Workspace-ID': 'workspace-456'
 fetch: (input, init) => {
 const headers = new Headers(init?.headers);
 headers.set('X-Tenant-ID', 'tenant-123');
 headers.set('X-Workspace-ID', 'workspace-456');
 return globalThis.fetch(input, { ...init, headers });
 }
});
```

### Role-Based Access Control (RBAC)

{/* doc-snippet: fragment — a SHAPE excerpt of the ObjectStack SERVER's object metadata (the `objects` map of `defineStack()`), not an expression: a bare object literal at statement position parses as a block with labels (measured: TS1005 x4, TS1109 x1, TS1128 x1). This repo declares no type for it — ObjectUI is a pure consumer of what the server publishes */}

```typescript
// Define permissions in object schema
{
Expand DownExpand Up@@ -203,17 +214,26 @@ const adapter = new ObjectStackAdapter({
ObjectOS provides system objects like `sys_user`, `sys_organization`, `sys_role`, etc. Integrate them in your UI:

```typescript
{
import { ObjectStackAdapter } from '@object-ui/data-objectstack';
import type { ObjectViewSchema } from '@object-ui/types';

const objectStackAdapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api'
});

const sysUserView: ObjectViewSchema = {
 type: 'object-view',
 objectName: 'sys_user',
 dataSource: objectStackAdapter,
viewTypes: ['grid'],
fieldNames: ['username', 'email', 'role', 'status', 'last_login']
}
defaultViewType: 'grid',
columns: ['username', 'email', 'role', 'status', 'last_login']
};
```

### Workflow Integration

{/* doc-snippet: fragment — a SHAPE excerpt of the ObjectStack SERVER's object metadata, not an expression: a bare object literal at statement position parses as a block with labels (measured: TS1005 x4, TS1128 x1). `workflow` is a server-side object concern; this repo declares no type for it */}

```typescript
// Define workflow-enabled object
{
Expand DownExpand Up@@ -277,7 +297,7 @@ go through `useViewData` from `@object-ui/react`, which resolves the adapter
from context and hands back both the rows and the `DataSource` to write with.

```typescript
import { useViewData } from '@object-ui/react';
import { SchemaRenderer, useViewData } from '@object-ui/react';

function ContactList() {
 const { data, loading, error, dataSource, refresh } = useViewData({
Expand DownExpand Up@@ -315,6 +335,8 @@ function ContactList() {

Deploy ObjectUI and ObjectStack together in a single Node.js process:

{/* doc-snippet: fragment — `./kernel` and `./console-plugin` are the READER's own project files (the kernel module is the one built in step 2 above), so the relative specifiers resolve nowhere in this gate's program (measured: TS2307 x2) */}

```typescript
// server.ts
import { createKernel } from './kernel';
Expand All@@ -338,6 +360,9 @@ start();
Deploy ObjectUI (frontend) and ObjectStack (backend) separately:

**Backend (ObjectStack API):**

{/* doc-snippet: fragment — `./kernel` is the READER's own project file (the kernel module built in step 2 above), so the relative specifier resolves nowhere in this gate's program (measured: TS2307 x1) */}

```typescript
// backend/server.ts
import { createKernel } from './kernel';
Expand All@@ -351,6 +376,9 @@ start();
```

**Frontend (ObjectUI):**

{/* doc-snippet: fragment — two files in one block, and it is `import.meta.env` that cannot compile here: the `env` member is a Vite ambient declaration carried by the READER's `vite/client` types, which this repository's gate program does not load (measured: TS2339 x1, plus TS2304 x1 for the adapter the second file imports in the reader's own entry point) */}

```typescript
// frontend/src/config.ts
export const config = {
Expand DownExpand Up@@ -424,6 +452,8 @@ spec:

### Custom Component Registration

{/* doc-snippet: fragment — `MyCustomWidget` is the READER's own component, and the block closes with a bare `{ type: 'my-custom-widget' }` SHAPE excerpt showing where the registered name is then used, which at statement position parses as a block with labels (measured: TS1005 x1) */}

```typescript
// Register custom components with ObjectUI
import { ComponentRegistry } from '@object-ui/core';
Expand All@@ -444,6 +474,8 @@ ComponentRegistry.register('my-custom-widget', MyCustomWidget, {

### Event Handling & Callbacks

{/* doc-snippet: fragment — a SHAPE excerpt continuing the "Using ObjectQL for Queries" block above, which is where `dataSource` is constructed: a bare object literal at statement position parses as a block with labels (measured: TS1005 x3) */}

```typescript
{
 type: 'object-grid',
Expand All@@ -464,31 +496,38 @@ ComponentRegistry.register('my-custom-widget', MyCustomWidget, {
}
```

### Real-time Updates with WebSockets
### Reacting to Data Changes

⚠️ `@object-ui/data-objectstack` has **no WebSocket transport and no server-push
subscription**. What it offers is `onMutation`: a notification of the writes
*this adapter instance* performed, which is what a view needs to refresh itself
after its own create/update/delete. It returns its own unsubscribe function.

```typescript
// Configure WebSocket connection
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api',
 websocket: {
 enabled: true,
 url: 'ws://localhost:3000/ws'
 }
 baseUrl: 'http://localhost:3000/api'
});

// Subscribe to real-time updates
adapter.subscribe('contact', (event) => {
// Fires for writes this adapter performed. Filter by `resource` for one object.
const unsubscribe = adapter.onMutation((event) => {
 if (event.resource !== 'contact') return;
 if (event.type === 'create' || event.type === 'update') {
 // Refresh grid
 gridRef.current?.refresh();
 // Refresh the view holding this object's rows
 }
});

// Later, when the view unmounts:
unsubscribe();
```

## Migration from Other Platforms

### From Retool

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison; `dataSource` continues the "Using ObjectQL for Queries" block above, and a bare object literal at statement position parses as a block with labels (measured: TS1005 x4) */}

```typescript
// Retool table → ObjectUI Grid
{
Expand All@@ -503,6 +542,8 @@ adapter.subscribe('contact', (event) => {

### From Appsmith

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison; `dataSource` continues the "Using ObjectQL for Queries" block above, and a bare object literal at statement position parses as a block with labels (measured: TS1005 x4) */}

```typescript
// Appsmith form → ObjectUI form
{
Expand All@@ -519,6 +560,8 @@ adapter.subscribe('contact', (event) => {

### From Mendix

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison, with every slot body elided as a prose comment, so the object literal cannot parse as TypeScript (measured: TS1005 x2, TS1128 x2) */}

```typescript
// Mendix page → ObjectUI page
{
Expand DownExpand Up@@ -555,15 +598,13 @@ await plugins.grid();
### Caching Strategy

```typescript
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api',
 cache: {
 enabled: true,
 ttl: 60000, // 1 minute
 strategies: {
 'contact': 'stale-while-revalidate',
 'sys_user': 'cache-first'
 }
 maxSize: 500 // entries retained
 }
});
```
Expand All@@ -572,6 +613,8 @@ const adapter = new ObjectStackAdapter({

### Unit Tests

{/* doc-snippet: fragment — a test body: `test` / `expect` are the RUNNER's globals (Vitest or Jest, injected by the reader's own test config, not imported here) and `mockDataSource` is the reader's own fixture, so none of the three resolves in this gate's program (measured: TS2593 x1, TS2304 x2) */}

```typescript
import { render } from '@testing-library/react';
import { SchemaRenderer } from '@object-ui/react';
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
docs(guides,plugins,tooling): clear three .mdx pages off the doc-snippet ledger (#5174 batch 5)#7294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

yinlianghui
merged 5 commits into

from

Sep 2, 2026
 Merged


docs(guides,plugins,tooling): clear three .mdx pages off the doc-snippet ledger (#5174 batch 5)
#7294
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
24dac63

wip: remove three .mdx entries from UNGATED_DOCS


claude Sep 2, 2026
d856f77

wip: plugin-chatbot.mdx blocks compile


claude Sep 2, 2026
533f865

wip: plugin-map.mdx blocks compile or declared


claude Sep 2, 2026
fa68ef1

wip: objectos-integration.mdx blocks compile or declared


claude Sep 2, 2026
fe053c7

Merge remote-tracking branch 'origin/main' into claude/issue-5174-mdx…


claude Sep 2, 2026

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


91 changes: 67 additions & 24 deletions
content/docs/guide/objectos-integration.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,8 @@ pnpm add @object-ui/plugin-form @object-ui/plugin-grid

### 2. Set Up ObjectStack Kernel

{/* doc-snippet: fragment — this file belongs to the ObjectStack SERVER project, not to an ObjectUI app. `@objectstack/runtime`, `@objectstack/objectql`, `@objectstack/plugin-app` and `@objectstack/plugin-hono-server` are dependencies of that project and are not declared by any package in this repository, so they do not resolve in this gate's program (measured: TS2307 x4). Correct documentation the gate cannot reach — the authoritative reference is the ObjectStack side, linked in the section below */}

```typescript
// src/kernel.ts
import { Kernel } from '@objectstack/runtime';
Expand DownExpand Up@@ -156,19 +158,28 @@ ReactDOM.createRoot(document.getElementById('root')!).render(

### Multi-Tenancy Support

The adapter's constructor takes no `headers` option. Per-request headers go
through its `fetch` hook, which it uses for every call it makes:

```typescript
// Configure tenant isolation
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api',
 headers: {
 'X-Tenant-ID': 'tenant-123',
 'X-Workspace-ID': 'workspace-456'
 fetch: (input, init) => {
 const headers = new Headers(init?.headers);
 headers.set('X-Tenant-ID', 'tenant-123');
 headers.set('X-Workspace-ID', 'workspace-456');
 return globalThis.fetch(input, { ...init, headers });
 }
});
```

### Role-Based Access Control (RBAC)

{/* doc-snippet: fragment — a SHAPE excerpt of the ObjectStack SERVER's object metadata (the `objects` map of `defineStack()`), not an expression: a bare object literal at statement position parses as a block with labels (measured: TS1005 x4, TS1109 x1, TS1128 x1). This repo declares no type for it — ObjectUI is a pure consumer of what the server publishes */}

```typescript
// Define permissions in object schema
{
Expand DownExpand Up@@ -203,17 +214,26 @@ const adapter = new ObjectStackAdapter({
ObjectOS provides system objects like `sys_user`, `sys_organization`, `sys_role`, etc. Integrate them in your UI:

```typescript
{
import { ObjectStackAdapter } from '@object-ui/data-objectstack';
import type { ObjectViewSchema } from '@object-ui/types';

const objectStackAdapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api'
});

const sysUserView: ObjectViewSchema = {
 type: 'object-view',
 objectName: 'sys_user',
 dataSource: objectStackAdapter,
viewTypes: ['grid'],
fieldNames: ['username', 'email', 'role', 'status', 'last_login']
}
defaultViewType: 'grid',
columns: ['username', 'email', 'role', 'status', 'last_login']
};
```

### Workflow Integration

{/* doc-snippet: fragment — a SHAPE excerpt of the ObjectStack SERVER's object metadata, not an expression: a bare object literal at statement position parses as a block with labels (measured: TS1005 x4, TS1128 x1). `workflow` is a server-side object concern; this repo declares no type for it */}

```typescript
// Define workflow-enabled object
{
Expand DownExpand Up@@ -277,7 +297,7 @@ go through `useViewData` from `@object-ui/react`, which resolves the adapter
from context and hands back both the rows and the `DataSource` to write with.

```typescript
import { useViewData } from '@object-ui/react';
import { SchemaRenderer, useViewData } from '@object-ui/react';

function ContactList() {
 const { data, loading, error, dataSource, refresh } = useViewData({
Expand DownExpand Up@@ -315,6 +335,8 @@ function ContactList() {

Deploy ObjectUI and ObjectStack together in a single Node.js process:

{/* doc-snippet: fragment — `./kernel` and `./console-plugin` are the READER's own project files (the kernel module is the one built in step 2 above), so the relative specifiers resolve nowhere in this gate's program (measured: TS2307 x2) */}

```typescript
// server.ts
import { createKernel } from './kernel';
Expand All@@ -338,6 +360,9 @@ start();
Deploy ObjectUI (frontend) and ObjectStack (backend) separately:

**Backend (ObjectStack API):**

{/* doc-snippet: fragment — `./kernel` is the READER's own project file (the kernel module built in step 2 above), so the relative specifier resolves nowhere in this gate's program (measured: TS2307 x1) */}

```typescript
// backend/server.ts
import { createKernel } from './kernel';
Expand All@@ -351,6 +376,9 @@ start();
```

**Frontend (ObjectUI):**

{/* doc-snippet: fragment — two files in one block, and it is `import.meta.env` that cannot compile here: the `env` member is a Vite ambient declaration carried by the READER's `vite/client` types, which this repository's gate program does not load (measured: TS2339 x1, plus TS2304 x1 for the adapter the second file imports in the reader's own entry point) */}

```typescript
// frontend/src/config.ts
export const config = {
Expand DownExpand Up@@ -424,6 +452,8 @@ spec:

### Custom Component Registration

{/* doc-snippet: fragment — `MyCustomWidget` is the READER's own component, and the block closes with a bare `{ type: 'my-custom-widget' }` SHAPE excerpt showing where the registered name is then used, which at statement position parses as a block with labels (measured: TS1005 x1) */}

```typescript
// Register custom components with ObjectUI
import { ComponentRegistry } from '@object-ui/core';
Expand All@@ -444,6 +474,8 @@ ComponentRegistry.register('my-custom-widget', MyCustomWidget, {

### Event Handling & Callbacks

{/* doc-snippet: fragment — a SHAPE excerpt continuing the "Using ObjectQL for Queries" block above, which is where `dataSource` is constructed: a bare object literal at statement position parses as a block with labels (measured: TS1005 x3) */}

```typescript
{
 type: 'object-grid',
Expand All@@ -464,31 +496,38 @@ ComponentRegistry.register('my-custom-widget', MyCustomWidget, {
}
```

### Real-time Updates with WebSockets
### Reacting to Data Changes

⚠️ `@object-ui/data-objectstack` has **no WebSocket transport and no server-push
subscription**. What it offers is `onMutation`: a notification of the writes
*this adapter instance* performed, which is what a view needs to refresh itself
after its own create/update/delete. It returns its own unsubscribe function.

```typescript
// Configure WebSocket connection
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api',
 websocket: {
 enabled: true,
 url: 'ws://localhost:3000/ws'
 }
 baseUrl: 'http://localhost:3000/api'
});

// Subscribe to real-time updates
adapter.subscribe('contact', (event) => {
// Fires for writes this adapter performed. Filter by `resource` for one object.
const unsubscribe = adapter.onMutation((event) => {
 if (event.resource !== 'contact') return;
 if (event.type === 'create' || event.type === 'update') {
 // Refresh grid
 gridRef.current?.refresh();
 // Refresh the view holding this object's rows
 }
});

// Later, when the view unmounts:
unsubscribe();
```

## Migration from Other Platforms

### From Retool

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison; `dataSource` continues the "Using ObjectQL for Queries" block above, and a bare object literal at statement position parses as a block with labels (measured: TS1005 x4) */}

```typescript
// Retool table → ObjectUI Grid
{
Expand All@@ -503,6 +542,8 @@ adapter.subscribe('contact', (event) => {

### From Appsmith

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison; `dataSource` continues the "Using ObjectQL for Queries" block above, and a bare object literal at statement position parses as a block with labels (measured: TS1005 x4) */}

```typescript
// Appsmith form → ObjectUI form
{
Expand All@@ -519,6 +560,8 @@ adapter.subscribe('contact', (event) => {

### From Mendix

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison, with every slot body elided as a prose comment, so the object literal cannot parse as TypeScript (measured: TS1005 x2, TS1128 x2) */}

```typescript
// Mendix page → ObjectUI page
{
Expand DownExpand Up@@ -555,15 +598,13 @@ await plugins.grid();
### Caching Strategy

```typescript
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api',
 cache: {
 enabled: true,
 ttl: 60000, // 1 minute
 strategies: {
 'contact': 'stale-while-revalidate',
 'sys_user': 'cache-first'
 }
 maxSize: 500 // entries retained
 }
});
```
Expand All@@ -572,6 +613,8 @@ const adapter = new ObjectStackAdapter({

### Unit Tests

{/* doc-snippet: fragment — a test body: `test` / `expect` are the RUNNER's globals (Vitest or Jest, injected by the reader's own test config, not imported here) and `mockDataSource` is the reader's own fixture, so none of the three resolves in this gate's program (measured: TS2593 x1, TS2304 x2) */}

```typescript
import { render } from '@testing-library/react';
import { SchemaRenderer } from '@object-ui/react';
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs(guides,plugins,tooling): clear three .mdx pages off the doc-snippet ledger (#5174 batch 5)#7294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

yinlianghui
merged 5 commits into

from

Sep 2, 2026
 Merged


docs(guides,plugins,tooling): clear three .mdx pages off the doc-snippet ledger (#5174 batch 5)
#7294
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
24dac63

wip: remove three .mdx entries from UNGATED_DOCS


claude Sep 2, 2026
d856f77

wip: plugin-chatbot.mdx blocks compile


claude Sep 2, 2026
533f865

wip: plugin-map.mdx blocks compile or declared


claude Sep 2, 2026
fa68ef1

wip: objectos-integration.mdx blocks compile or declared


claude Sep 2, 2026
fe053c7

Merge remote-tracking branch 'origin/main' into claude/issue-5174-mdx…


claude Sep 2, 2026

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


91 changes: 67 additions & 24 deletions
content/docs/guide/objectos-integration.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,8 @@ pnpm add @object-ui/plugin-form @object-ui/plugin-grid

### 2. Set Up ObjectStack Kernel

{/* doc-snippet: fragment — this file belongs to the ObjectStack SERVER project, not to an ObjectUI app. `@objectstack/runtime`, `@objectstack/objectql`, `@objectstack/plugin-app` and `@objectstack/plugin-hono-server` are dependencies of that project and are not declared by any package in this repository, so they do not resolve in this gate's program (measured: TS2307 x4). Correct documentation the gate cannot reach — the authoritative reference is the ObjectStack side, linked in the section below */}

```typescript
// src/kernel.ts
import { Kernel } from '@objectstack/runtime';
Expand DownExpand Up@@ -156,19 +158,28 @@ ReactDOM.createRoot(document.getElementById('root')!).render(

### Multi-Tenancy Support

The adapter's constructor takes no `headers` option. Per-request headers go
through its `fetch` hook, which it uses for every call it makes:

```typescript
// Configure tenant isolation
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api',
 headers: {
 'X-Tenant-ID': 'tenant-123',
 'X-Workspace-ID': 'workspace-456'
 fetch: (input, init) => {
 const headers = new Headers(init?.headers);
 headers.set('X-Tenant-ID', 'tenant-123');
 headers.set('X-Workspace-ID', 'workspace-456');
 return globalThis.fetch(input, { ...init, headers });
 }
});
```

### Role-Based Access Control (RBAC)

{/* doc-snippet: fragment — a SHAPE excerpt of the ObjectStack SERVER's object metadata (the `objects` map of `defineStack()`), not an expression: a bare object literal at statement position parses as a block with labels (measured: TS1005 x4, TS1109 x1, TS1128 x1). This repo declares no type for it — ObjectUI is a pure consumer of what the server publishes */}

```typescript
// Define permissions in object schema
{
Expand DownExpand Up@@ -203,17 +214,26 @@ const adapter = new ObjectStackAdapter({
ObjectOS provides system objects like `sys_user`, `sys_organization`, `sys_role`, etc. Integrate them in your UI:

```typescript
{
import { ObjectStackAdapter } from '@object-ui/data-objectstack';
import type { ObjectViewSchema } from '@object-ui/types';

const objectStackAdapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api'
});

const sysUserView: ObjectViewSchema = {
 type: 'object-view',
 objectName: 'sys_user',
 dataSource: objectStackAdapter,
viewTypes: ['grid'],
fieldNames: ['username', 'email', 'role', 'status', 'last_login']
}
defaultViewType: 'grid',
columns: ['username', 'email', 'role', 'status', 'last_login']
};
```

### Workflow Integration

{/* doc-snippet: fragment — a SHAPE excerpt of the ObjectStack SERVER's object metadata, not an expression: a bare object literal at statement position parses as a block with labels (measured: TS1005 x4, TS1128 x1). `workflow` is a server-side object concern; this repo declares no type for it */}

```typescript
// Define workflow-enabled object
{
Expand DownExpand Up@@ -277,7 +297,7 @@ go through `useViewData` from `@object-ui/react`, which resolves the adapter
from context and hands back both the rows and the `DataSource` to write with.

```typescript
import { useViewData } from '@object-ui/react';
import { SchemaRenderer, useViewData } from '@object-ui/react';

function ContactList() {
 const { data, loading, error, dataSource, refresh } = useViewData({
Expand DownExpand Up@@ -315,6 +335,8 @@ function ContactList() {

Deploy ObjectUI and ObjectStack together in a single Node.js process:

{/* doc-snippet: fragment — `./kernel` and `./console-plugin` are the READER's own project files (the kernel module is the one built in step 2 above), so the relative specifiers resolve nowhere in this gate's program (measured: TS2307 x2) */}

```typescript
// server.ts
import { createKernel } from './kernel';
Expand All@@ -338,6 +360,9 @@ start();
Deploy ObjectUI (frontend) and ObjectStack (backend) separately:

**Backend (ObjectStack API):**

{/* doc-snippet: fragment — `./kernel` is the READER's own project file (the kernel module built in step 2 above), so the relative specifier resolves nowhere in this gate's program (measured: TS2307 x1) */}

```typescript
// backend/server.ts
import { createKernel } from './kernel';
Expand All@@ -351,6 +376,9 @@ start();
```

**Frontend (ObjectUI):**

{/* doc-snippet: fragment — two files in one block, and it is `import.meta.env` that cannot compile here: the `env` member is a Vite ambient declaration carried by the READER's `vite/client` types, which this repository's gate program does not load (measured: TS2339 x1, plus TS2304 x1 for the adapter the second file imports in the reader's own entry point) */}

```typescript
// frontend/src/config.ts
export const config = {
Expand DownExpand Up@@ -424,6 +452,8 @@ spec:

### Custom Component Registration

{/* doc-snippet: fragment — `MyCustomWidget` is the READER's own component, and the block closes with a bare `{ type: 'my-custom-widget' }` SHAPE excerpt showing where the registered name is then used, which at statement position parses as a block with labels (measured: TS1005 x1) */}

```typescript
// Register custom components with ObjectUI
import { ComponentRegistry } from '@object-ui/core';
Expand All@@ -444,6 +474,8 @@ ComponentRegistry.register('my-custom-widget', MyCustomWidget, {

### Event Handling & Callbacks

{/* doc-snippet: fragment — a SHAPE excerpt continuing the "Using ObjectQL for Queries" block above, which is where `dataSource` is constructed: a bare object literal at statement position parses as a block with labels (measured: TS1005 x3) */}

```typescript
{
 type: 'object-grid',
Expand All@@ -464,31 +496,38 @@ ComponentRegistry.register('my-custom-widget', MyCustomWidget, {
}
```

### Real-time Updates with WebSockets
### Reacting to Data Changes

⚠️ `@object-ui/data-objectstack` has **no WebSocket transport and no server-push
subscription**. What it offers is `onMutation`: a notification of the writes
*this adapter instance* performed, which is what a view needs to refresh itself
after its own create/update/delete. It returns its own unsubscribe function.

```typescript
// Configure WebSocket connection
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api',
 websocket: {
 enabled: true,
 url: 'ws://localhost:3000/ws'
 }
 baseUrl: 'http://localhost:3000/api'
});

// Subscribe to real-time updates
adapter.subscribe('contact', (event) => {
// Fires for writes this adapter performed. Filter by `resource` for one object.
const unsubscribe = adapter.onMutation((event) => {
 if (event.resource !== 'contact') return;
 if (event.type === 'create' || event.type === 'update') {
 // Refresh grid
 gridRef.current?.refresh();
 // Refresh the view holding this object's rows
 }
});

// Later, when the view unmounts:
unsubscribe();
```

## Migration from Other Platforms

### From Retool

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison; `dataSource` continues the "Using ObjectQL for Queries" block above, and a bare object literal at statement position parses as a block with labels (measured: TS1005 x4) */}

```typescript
// Retool table → ObjectUI Grid
{
Expand All@@ -503,6 +542,8 @@ adapter.subscribe('contact', (event) => {

### From Appsmith

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison; `dataSource` continues the "Using ObjectQL for Queries" block above, and a bare object literal at statement position parses as a block with labels (measured: TS1005 x4) */}

```typescript
// Appsmith form → ObjectUI form
{
Expand All@@ -519,6 +560,8 @@ adapter.subscribe('contact', (event) => {

### From Mendix

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison, with every slot body elided as a prose comment, so the object literal cannot parse as TypeScript (measured: TS1005 x2, TS1128 x2) */}

```typescript
// Mendix page → ObjectUI page
{
Expand DownExpand Up@@ -555,15 +598,13 @@ await plugins.grid();
### Caching Strategy

```typescript
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api',
 cache: {
 enabled: true,
 ttl: 60000, // 1 minute
 strategies: {
 'contact': 'stale-while-revalidate',
 'sys_user': 'cache-first'
 }
 maxSize: 500 // entries retained
 }
});
```
Expand All@@ -572,6 +613,8 @@ const adapter = new ObjectStackAdapter({

### Unit Tests

{/* doc-snippet: fragment — a test body: `test` / `expect` are the RUNNER's globals (Vitest or Jest, injected by the reader's own test config, not imported here) and `mockDataSource` is the reader's own fixture, so none of the three resolves in this gate's program (measured: TS2593 x1, TS2304 x2) */}

```typescript
import { render } from '@testing-library/react';
import { SchemaRenderer } from '@object-ui/react';
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs(guides,plugins,tooling): clear three .mdx pages off the doc-snippet ledger (#5174 batch 5)#7294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

yinlianghui
merged 5 commits into

from

Sep 2, 2026
 Merged


docs(guides,plugins,tooling): clear three .mdx pages off the doc-snippet ledger (#5174 batch 5)
#7294
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
24dac63

wip: remove three .mdx entries from UNGATED_DOCS


claude Sep 2, 2026
d856f77

wip: plugin-chatbot.mdx blocks compile


claude Sep 2, 2026
533f865

wip: plugin-map.mdx blocks compile or declared


claude Sep 2, 2026
fa68ef1

wip: objectos-integration.mdx blocks compile or declared


claude Sep 2, 2026
fe053c7

Merge remote-tracking branch 'origin/main' into claude/issue-5174-mdx…


claude Sep 2, 2026

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


91 changes: 67 additions & 24 deletions
content/docs/guide/objectos-integration.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,8 @@ pnpm add @object-ui/plugin-form @object-ui/plugin-grid

### 2. Set Up ObjectStack Kernel

{/* doc-snippet: fragment — this file belongs to the ObjectStack SERVER project, not to an ObjectUI app. `@objectstack/runtime`, `@objectstack/objectql`, `@objectstack/plugin-app` and `@objectstack/plugin-hono-server` are dependencies of that project and are not declared by any package in this repository, so they do not resolve in this gate's program (measured: TS2307 x4). Correct documentation the gate cannot reach — the authoritative reference is the ObjectStack side, linked in the section below */}

```typescript
// src/kernel.ts
import { Kernel } from '@objectstack/runtime';
Expand DownExpand Up@@ -156,19 +158,28 @@ ReactDOM.createRoot(document.getElementById('root')!).render(

### Multi-Tenancy Support

The adapter's constructor takes no `headers` option. Per-request headers go
through its `fetch` hook, which it uses for every call it makes:

```typescript
// Configure tenant isolation
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api',
 headers: {
 'X-Tenant-ID': 'tenant-123',
 'X-Workspace-ID': 'workspace-456'
 fetch: (input, init) => {
 const headers = new Headers(init?.headers);
 headers.set('X-Tenant-ID', 'tenant-123');
 headers.set('X-Workspace-ID', 'workspace-456');
 return globalThis.fetch(input, { ...init, headers });
 }
});
```

### Role-Based Access Control (RBAC)

{/* doc-snippet: fragment — a SHAPE excerpt of the ObjectStack SERVER's object metadata (the `objects` map of `defineStack()`), not an expression: a bare object literal at statement position parses as a block with labels (measured: TS1005 x4, TS1109 x1, TS1128 x1). This repo declares no type for it — ObjectUI is a pure consumer of what the server publishes */}

```typescript
// Define permissions in object schema
{
Expand DownExpand Up@@ -203,17 +214,26 @@ const adapter = new ObjectStackAdapter({
ObjectOS provides system objects like `sys_user`, `sys_organization`, `sys_role`, etc. Integrate them in your UI:

```typescript
{
import { ObjectStackAdapter } from '@object-ui/data-objectstack';
import type { ObjectViewSchema } from '@object-ui/types';

const objectStackAdapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api'
});

const sysUserView: ObjectViewSchema = {
 type: 'object-view',
 objectName: 'sys_user',
 dataSource: objectStackAdapter,
viewTypes: ['grid'],
fieldNames: ['username', 'email', 'role', 'status', 'last_login']
}
defaultViewType: 'grid',
columns: ['username', 'email', 'role', 'status', 'last_login']
};
```

### Workflow Integration

{/* doc-snippet: fragment — a SHAPE excerpt of the ObjectStack SERVER's object metadata, not an expression: a bare object literal at statement position parses as a block with labels (measured: TS1005 x4, TS1128 x1). `workflow` is a server-side object concern; this repo declares no type for it */}

```typescript
// Define workflow-enabled object
{
Expand DownExpand Up@@ -277,7 +297,7 @@ go through `useViewData` from `@object-ui/react`, which resolves the adapter
from context and hands back both the rows and the `DataSource` to write with.

```typescript
import { useViewData } from '@object-ui/react';
import { SchemaRenderer, useViewData } from '@object-ui/react';

function ContactList() {
 const { data, loading, error, dataSource, refresh } = useViewData({
Expand DownExpand Up@@ -315,6 +335,8 @@ function ContactList() {

Deploy ObjectUI and ObjectStack together in a single Node.js process:

{/* doc-snippet: fragment — `./kernel` and `./console-plugin` are the READER's own project files (the kernel module is the one built in step 2 above), so the relative specifiers resolve nowhere in this gate's program (measured: TS2307 x2) */}

```typescript
// server.ts
import { createKernel } from './kernel';
Expand All@@ -338,6 +360,9 @@ start();
Deploy ObjectUI (frontend) and ObjectStack (backend) separately:

**Backend (ObjectStack API):**

{/* doc-snippet: fragment — `./kernel` is the READER's own project file (the kernel module built in step 2 above), so the relative specifier resolves nowhere in this gate's program (measured: TS2307 x1) */}

```typescript
// backend/server.ts
import { createKernel } from './kernel';
Expand All@@ -351,6 +376,9 @@ start();
```

**Frontend (ObjectUI):**

{/* doc-snippet: fragment — two files in one block, and it is `import.meta.env` that cannot compile here: the `env` member is a Vite ambient declaration carried by the READER's `vite/client` types, which this repository's gate program does not load (measured: TS2339 x1, plus TS2304 x1 for the adapter the second file imports in the reader's own entry point) */}

```typescript
// frontend/src/config.ts
export const config = {
Expand DownExpand Up@@ -424,6 +452,8 @@ spec:

### Custom Component Registration

{/* doc-snippet: fragment — `MyCustomWidget` is the READER's own component, and the block closes with a bare `{ type: 'my-custom-widget' }` SHAPE excerpt showing where the registered name is then used, which at statement position parses as a block with labels (measured: TS1005 x1) */}

```typescript
// Register custom components with ObjectUI
import { ComponentRegistry } from '@object-ui/core';
Expand All@@ -444,6 +474,8 @@ ComponentRegistry.register('my-custom-widget', MyCustomWidget, {

### Event Handling & Callbacks

{/* doc-snippet: fragment — a SHAPE excerpt continuing the "Using ObjectQL for Queries" block above, which is where `dataSource` is constructed: a bare object literal at statement position parses as a block with labels (measured: TS1005 x3) */}

```typescript
{
 type: 'object-grid',
Expand All@@ -464,31 +496,38 @@ ComponentRegistry.register('my-custom-widget', MyCustomWidget, {
}
```

### Real-time Updates with WebSockets
### Reacting to Data Changes

⚠️ `@object-ui/data-objectstack` has **no WebSocket transport and no server-push
subscription**. What it offers is `onMutation`: a notification of the writes
*this adapter instance* performed, which is what a view needs to refresh itself
after its own create/update/delete. It returns its own unsubscribe function.

```typescript
// Configure WebSocket connection
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api',
 websocket: {
 enabled: true,
 url: 'ws://localhost:3000/ws'
 }
 baseUrl: 'http://localhost:3000/api'
});

// Subscribe to real-time updates
adapter.subscribe('contact', (event) => {
// Fires for writes this adapter performed. Filter by `resource` for one object.
const unsubscribe = adapter.onMutation((event) => {
 if (event.resource !== 'contact') return;
 if (event.type === 'create' || event.type === 'update') {
 // Refresh grid
 gridRef.current?.refresh();
 // Refresh the view holding this object's rows
 }
});

// Later, when the view unmounts:
unsubscribe();
```

## Migration from Other Platforms

### From Retool

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison; `dataSource` continues the "Using ObjectQL for Queries" block above, and a bare object literal at statement position parses as a block with labels (measured: TS1005 x4) */}

```typescript
// Retool table → ObjectUI Grid
{
Expand All@@ -503,6 +542,8 @@ adapter.subscribe('contact', (event) => {

### From Appsmith

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison; `dataSource` continues the "Using ObjectQL for Queries" block above, and a bare object literal at statement position parses as a block with labels (measured: TS1005 x4) */}

```typescript
// Appsmith form → ObjectUI form
{
Expand All@@ -519,6 +560,8 @@ adapter.subscribe('contact', (event) => {

### From Mendix

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison, with every slot body elided as a prose comment, so the object literal cannot parse as TypeScript (measured: TS1005 x2, TS1128 x2) */}

```typescript
// Mendix page → ObjectUI page
{
Expand DownExpand Up@@ -555,15 +598,13 @@ await plugins.grid();
### Caching Strategy

```typescript
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api',
 cache: {
 enabled: true,
 ttl: 60000, // 1 minute
 strategies: {
 'contact': 'stale-while-revalidate',
 'sys_user': 'cache-first'
 }
 maxSize: 500 // entries retained
 }
});
```
Expand All@@ -572,6 +613,8 @@ const adapter = new ObjectStackAdapter({

### Unit Tests

{/* doc-snippet: fragment — a test body: `test` / `expect` are the RUNNER's globals (Vitest or Jest, injected by the reader's own test config, not imported here) and `mockDataSource` is the reader's own fixture, so none of the three resolves in this gate's program (measured: TS2593 x1, TS2304 x2) */}

```typescript
import { render } from '@testing-library/react';
import { SchemaRenderer } from '@object-ui/react';
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
docs(guides,plugins,tooling): clear three .mdx pages off the doc-snippet ledger (#5174 batch 5)#7294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

yinlianghui
merged 5 commits into

from

Sep 2, 2026
 Merged


docs(guides,plugins,tooling): clear three .mdx pages off the doc-snippet ledger (#5174 batch 5)
#7294
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
24dac63

wip: remove three .mdx entries from UNGATED_DOCS


claude Sep 2, 2026
d856f77

wip: plugin-chatbot.mdx blocks compile


claude Sep 2, 2026
533f865

wip: plugin-map.mdx blocks compile or declared


claude Sep 2, 2026
fa68ef1

wip: objectos-integration.mdx blocks compile or declared


claude Sep 2, 2026
fe053c7

Merge remote-tracking branch 'origin/main' into claude/issue-5174-mdx…


claude Sep 2, 2026

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


91 changes: 67 additions & 24 deletions
content/docs/guide/objectos-integration.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,8 @@ pnpm add @object-ui/plugin-form @object-ui/plugin-grid

### 2. Set Up ObjectStack Kernel

{/* doc-snippet: fragment — this file belongs to the ObjectStack SERVER project, not to an ObjectUI app. `@objectstack/runtime`, `@objectstack/objectql`, `@objectstack/plugin-app` and `@objectstack/plugin-hono-server` are dependencies of that project and are not declared by any package in this repository, so they do not resolve in this gate's program (measured: TS2307 x4). Correct documentation the gate cannot reach — the authoritative reference is the ObjectStack side, linked in the section below */}

```typescript
// src/kernel.ts
import { Kernel } from '@objectstack/runtime';
Expand DownExpand Up@@ -156,19 +158,28 @@ ReactDOM.createRoot(document.getElementById('root')!).render(

### Multi-Tenancy Support

The adapter's constructor takes no `headers` option. Per-request headers go
through its `fetch` hook, which it uses for every call it makes:

```typescript
// Configure tenant isolation
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api',
 headers: {
 'X-Tenant-ID': 'tenant-123',
 'X-Workspace-ID': 'workspace-456'
 fetch: (input, init) => {
 const headers = new Headers(init?.headers);
 headers.set('X-Tenant-ID', 'tenant-123');
 headers.set('X-Workspace-ID', 'workspace-456');
 return globalThis.fetch(input, { ...init, headers });
 }
});
```

### Role-Based Access Control (RBAC)

{/* doc-snippet: fragment — a SHAPE excerpt of the ObjectStack SERVER's object metadata (the `objects` map of `defineStack()`), not an expression: a bare object literal at statement position parses as a block with labels (measured: TS1005 x4, TS1109 x1, TS1128 x1). This repo declares no type for it — ObjectUI is a pure consumer of what the server publishes */}

```typescript
// Define permissions in object schema
{
Expand DownExpand Up@@ -203,17 +214,26 @@ const adapter = new ObjectStackAdapter({
ObjectOS provides system objects like `sys_user`, `sys_organization`, `sys_role`, etc. Integrate them in your UI:

```typescript
{
import { ObjectStackAdapter } from '@object-ui/data-objectstack';
import type { ObjectViewSchema } from '@object-ui/types';

const objectStackAdapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api'
});

const sysUserView: ObjectViewSchema = {
 type: 'object-view',
 objectName: 'sys_user',
 dataSource: objectStackAdapter,
viewTypes: ['grid'],
fieldNames: ['username', 'email', 'role', 'status', 'last_login']
}
defaultViewType: 'grid',
columns: ['username', 'email', 'role', 'status', 'last_login']
};
```

### Workflow Integration

{/* doc-snippet: fragment — a SHAPE excerpt of the ObjectStack SERVER's object metadata, not an expression: a bare object literal at statement position parses as a block with labels (measured: TS1005 x4, TS1128 x1). `workflow` is a server-side object concern; this repo declares no type for it */}

```typescript
// Define workflow-enabled object
{
Expand DownExpand Up@@ -277,7 +297,7 @@ go through `useViewData` from `@object-ui/react`, which resolves the adapter
from context and hands back both the rows and the `DataSource` to write with.

```typescript
import { useViewData } from '@object-ui/react';
import { SchemaRenderer, useViewData } from '@object-ui/react';

function ContactList() {
 const { data, loading, error, dataSource, refresh } = useViewData({
Expand DownExpand Up@@ -315,6 +335,8 @@ function ContactList() {

Deploy ObjectUI and ObjectStack together in a single Node.js process:

{/* doc-snippet: fragment — `./kernel` and `./console-plugin` are the READER's own project files (the kernel module is the one built in step 2 above), so the relative specifiers resolve nowhere in this gate's program (measured: TS2307 x2) */}

```typescript
// server.ts
import { createKernel } from './kernel';
Expand All@@ -338,6 +360,9 @@ start();
Deploy ObjectUI (frontend) and ObjectStack (backend) separately:

**Backend (ObjectStack API):**

{/* doc-snippet: fragment — `./kernel` is the READER's own project file (the kernel module built in step 2 above), so the relative specifier resolves nowhere in this gate's program (measured: TS2307 x1) */}

```typescript
// backend/server.ts
import { createKernel } from './kernel';
Expand All@@ -351,6 +376,9 @@ start();
```

**Frontend (ObjectUI):**

{/* doc-snippet: fragment — two files in one block, and it is `import.meta.env` that cannot compile here: the `env` member is a Vite ambient declaration carried by the READER's `vite/client` types, which this repository's gate program does not load (measured: TS2339 x1, plus TS2304 x1 for the adapter the second file imports in the reader's own entry point) */}

```typescript
// frontend/src/config.ts
export const config = {
Expand DownExpand Up@@ -424,6 +452,8 @@ spec:

### Custom Component Registration

{/* doc-snippet: fragment — `MyCustomWidget` is the READER's own component, and the block closes with a bare `{ type: 'my-custom-widget' }` SHAPE excerpt showing where the registered name is then used, which at statement position parses as a block with labels (measured: TS1005 x1) */}

```typescript
// Register custom components with ObjectUI
import { ComponentRegistry } from '@object-ui/core';
Expand All@@ -444,6 +474,8 @@ ComponentRegistry.register('my-custom-widget', MyCustomWidget, {

### Event Handling & Callbacks

{/* doc-snippet: fragment — a SHAPE excerpt continuing the "Using ObjectQL for Queries" block above, which is where `dataSource` is constructed: a bare object literal at statement position parses as a block with labels (measured: TS1005 x3) */}

```typescript
{
 type: 'object-grid',
Expand All@@ -464,31 +496,38 @@ ComponentRegistry.register('my-custom-widget', MyCustomWidget, {
}
```

### Real-time Updates with WebSockets
### Reacting to Data Changes

⚠️ `@object-ui/data-objectstack` has **no WebSocket transport and no server-push
subscription**. What it offers is `onMutation`: a notification of the writes
*this adapter instance* performed, which is what a view needs to refresh itself
after its own create/update/delete. It returns its own unsubscribe function.

```typescript
// Configure WebSocket connection
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api',
 websocket: {
 enabled: true,
 url: 'ws://localhost:3000/ws'
 }
 baseUrl: 'http://localhost:3000/api'
});

// Subscribe to real-time updates
adapter.subscribe('contact', (event) => {
// Fires for writes this adapter performed. Filter by `resource` for one object.
const unsubscribe = adapter.onMutation((event) => {
 if (event.resource !== 'contact') return;
 if (event.type === 'create' || event.type === 'update') {
 // Refresh grid
 gridRef.current?.refresh();
 // Refresh the view holding this object's rows
 }
});

// Later, when the view unmounts:
unsubscribe();
```

## Migration from Other Platforms

### From Retool

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison; `dataSource` continues the "Using ObjectQL for Queries" block above, and a bare object literal at statement position parses as a block with labels (measured: TS1005 x4) */}

```typescript
// Retool table → ObjectUI Grid
{
Expand All@@ -503,6 +542,8 @@ adapter.subscribe('contact', (event) => {

### From Appsmith

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison; `dataSource` continues the "Using ObjectQL for Queries" block above, and a bare object literal at statement position parses as a block with labels (measured: TS1005 x4) */}

```typescript
// Appsmith form → ObjectUI form
{
Expand All@@ -519,6 +560,8 @@ adapter.subscribe('contact', (event) => {

### From Mendix

{/* doc-snippet: fragment — a SHAPE excerpt showing the ObjectUI half of a side-by-side migration comparison, with every slot body elided as a prose comment, so the object literal cannot parse as TypeScript (measured: TS1005 x2, TS1128 x2) */}

```typescript
// Mendix page → ObjectUI page
{
Expand DownExpand Up@@ -555,15 +598,13 @@ await plugins.grid();
### Caching Strategy

```typescript
import { ObjectStackAdapter } from '@object-ui/data-objectstack';

const adapter = new ObjectStackAdapter({
 baseUrl: 'http://localhost:3000/api',
 cache: {
 enabled: true,
 ttl: 60000, // 1 minute
 strategies: {
 'contact': 'stale-while-revalidate',
 'sys_user': 'cache-first'
 }
 maxSize: 500 // entries retained
 }
});
```
Expand All@@ -572,6 +613,8 @@ const adapter = new ObjectStackAdapter({

### Unit Tests

{/* doc-snippet: fragment — a test body: `test` / `expect` are the RUNNER's globals (Vitest or Jest, injected by the reader's own test config, not imported here) and `mockDataSource` is the reader's own fixture, so none of the three resolves in this gate's program (measured: TS2593 x1, TS2304 x2) */}

```typescript
import { render } from '@testing-library/react';
import { SchemaRenderer } from '@object-ui/react';
Expand Down
Loading
Loading