feat(spec,showcase): lookup record-picker authoring metadata + demo#2125

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
xuyushun441-sys merged 2 commits into from
Jun 21, 2026
Merged

feat(spec,showcase): lookup record-picker authoring metadata + demo #2125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6334f4c
feat(spec,showcase): lookup record-picker authoring metadata + demo
os-zhuang Jun 21, 2026
d7d57ff
chore(spec): classify new lookup picker props in the liveness ledger
os-zhuang Jun 21, 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
12 changes: 12 additions & 0 deletions examples/app-showcase/src/data/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,18 @@ const accounts = defineSeed(Account, {
{ name: 'Northwind', industry: 'retail', annual_revenue: 8_000_000, website: 'https://northwind.example', status: 'active', hq: { lat: 47.6062, lng: -122.3321 }, tax_id: '91-1144442', billing_email: 'ap@northwind.example' },
{ name: 'Contoso', industry: 'technology', annual_revenue: 25_000_000, website: 'https://contoso.example', status: 'active', hq: { lat: 37.7749, lng: -122.4194 }, tax_id: '20-3399881', billing_email: 'billing@contoso.example' },
{ name: 'Fabrikam', industry: 'healthcare', annual_revenue: 12_000_000, website: 'https://fabrikam.example', status: 'prospect', hq: { lat: 40.7128, lng: -74.0060 }, tax_id: '46-7782013', billing_email: 'accounts@fabrikam.example' },
// Extra accounts so the record picker has enough volume to exercise search,
// sorting, pagination and the (non-churned) scoping filter on invoices.
{ name: 'Initech', industry: 'finance', annual_revenue: 5_400_000, website: 'https://initech.example', status: 'active', hq: { lat: 30.2672, lng: -97.7431 }, tax_id: '74-2233110', billing_email: 'ap@initech.example' },
{ name: 'Globex', industry: 'technology', annual_revenue: 42_000_000, website: 'https://globex.example', status: 'active', hq: { lat: 34.0522, lng: -118.2437 }, tax_id: '95-8841200', billing_email: 'billing@globex.example' },
{ name: 'Stark Industries', industry: 'technology', annual_revenue: 180_000_000, website: 'https://stark.example', status: 'active', hq: { lat: 40.7580, lng: -73.9855 }, tax_id: '13-5567421', billing_email: 'ap@stark.example' },
{ name: 'Wayne Enterprises', industry: 'finance', annual_revenue: 210_000_000, website: 'https://wayne.example', status: 'active', hq: { lat: 40.7128, lng: -74.0060 }, tax_id: '22-9087733', billing_email: 'billing@wayne.example' },
{ name: 'Acme Retail', industry: 'retail', annual_revenue: 3_200_000, website: 'https://acme.example', status: 'prospect', hq: { lat: 41.8781, lng: -87.6298 }, tax_id: '36-4471209', billing_email: 'accounts@acme.example' },
{ name: 'Soylent Foods', industry: 'healthcare', annual_revenue: 9_900_000, website: 'https://soylent.example', status: 'prospect', hq: { lat: 37.3382, lng: -121.8863 }, tax_id: '77-1029384', billing_email: 'ap@soylent.example' },
{ name: 'Hooli', industry: 'technology', annual_revenue: 96_000_000, website: 'https://hooli.example', status: 'active', hq: { lat: 37.3861, lng: -122.0839 }, tax_id: '45-7781230', billing_email: 'billing@hooli.example' },
{ name: 'Vandelay Industries', industry: 'finance', annual_revenue: 6_700_000, website: 'https://vandelay.example', status: 'active', hq: { lat: 40.6782, lng: -73.9442 }, tax_id: '11-3344556', billing_email: 'ap@vandelay.example' },
{ name: 'Umbrella Health', industry: 'healthcare', annual_revenue: 33_000_000, website: 'https://umbrella.example', status: 'churned', hq: { lat: 39.9526, lng: -75.1652 }, tax_id: '88-2200117', churn_reason: 'Switched to in-house platform', billing_email: 'accounts@umbrella.example' },
{ name: 'Wonka Brands', industry: 'retail', annual_revenue: 14_500_000, website: 'https://wonka.example', status: 'churned', hq: { lat: 41.4993, lng: -81.6944 }, tax_id: '52-7741093', churn_reason: 'Budget cuts', billing_email: 'ap@wonka.example' },
],
});

Expand Down
17 changes: 16 additions & 1 deletion examples/app-showcase/src/objects/invoice.object.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,22 @@ export const Invoice = ObjectSchema.create({

fields: {
name: Field.text({ label: 'Invoice Number', required: true, searchable: true, maxLength: 60 }),
account: Field.lookup('showcase_account', { label: 'Account', required: true }),
// Forward record-picker config (spec lookup* props). The renderer
// auto-derives columns from the Account schema, but here we curate them and
// — crucially — SCOPE the picker so a rep can't invoice a churned account.
// `lookupFilters` is the structured, picker-honoured form of referenceFilters.
account: Field.lookup('showcase_account', {
label: 'Account',
required: true,
descriptionField: 'industry',
lookupColumns: [
'name',
{ field: 'industry', label: 'Industry', type: 'select' },
{ field: 'status', label: 'Lifecycle', type: 'select' },
{ field: 'annual_revenue', label: 'Annual Revenue', type: 'currency' },
],
lookupFilters: [{ field: 'status', operator: 'ne', value: 'churned' }],
}),
// Owner email — the row-level-security anchor. The `showcase_contributor`
// permission set scopes invoice SELECT to `owner = current_user.email` (email
// is the unique, seedable identifier), so a contributor sees only their own
Expand Down
28 changes: 26 additions & 2 deletions packages/spec/liveness/field.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -151,9 +151,33 @@
},
"referenceFilters": {
"status": "dead",
"evidence": "lookup dialog reads lookup_filters (LookupField.tsx:171) — entirely dead as authored (naming drift)",
"evidence": "lookup dialog reads lookup_filters/lookupFilters (LookupField.tsx) — the string[] referenceFilters form is not read (naming drift)",
"authorWarn": true,
"authorHint": "The lookup dialog reads `lookup_filters`, not `referenceFilters` — as authored this filters nothing. Use the supported lookup-filter key, or remove it to avoid implying a constrained lookup."
"authorHint": "The picker reads the structured `lookupFilters` ({field,operator,value}), not the string[] `referenceFilters` — as authored this filters nothing. Use `lookupFilters`, or remove this to avoid implying a constrained lookup."
},
"displayField": {
"status": "live",
"note": "objectui LookupField/RecordPickerDialog — candidate label field in the record picker (reads displayField || display_field)."
},
"descriptionField": {
"status": "live",
"note": "objectui LookupField — secondary line under each option in the quick-select popover (reads descriptionField || description_field)."
},
"lookupColumns": {
"status": "live",
"note": "objectui RecordPickerDialog — record-picker table columns; renderer auto-derives from the referenced object when omitted (reads lookupColumns || lookup_columns)."
},
"lookupPageSize": {
"status": "live",
"note": "objectui RecordPickerDialog — rows per page in the record-picker dialog (reads lookupPageSize || lookup_page_size)."
},
"lookupFilters": {
"status": "live",
"note": "objectui LookupField + RecordPickerDialog — base scoping filters honoured by BOTH popover and dialog; structured supported form of referenceFilters (reads lookupFilters || lookup_filters)."
},
"dependsOn": {
"status": "live",
"note": "objectui LookupField — dependent/cascading lookup; restricts candidates by another field's value (reads dependsOn || depends_on)."
},
"maxRating": {
"status": "dead",
Expand Down
34 changes: 34 additions & 0 deletions packages/spec/src/data/field.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -296,6 +296,40 @@ describe('FieldSchema', () => {
const result = FieldSchema.parse(lookupField);
expect(result.deleteBehavior).toBe('set_null');
});

it('should preserve forward record-picker config (display/columns/filters/depends)', () => {
const lookupField: Field = {
name: 'account',
label: 'Account',
type: 'lookup',
reference: 'crm_account',
displayField: 'name',
descriptionField: 'industry',
lookupColumns: ['name', { field: 'annual_revenue', label: 'Revenue', type: 'currency' }],
lookupPageSize: 20,
lookupFilters: [{ field: 'status', operator: 'eq', value: 'active' }],
dependsOn: ['region', { field: 'country', param: 'country_code' }],
};

const result = FieldSchema.parse(lookupField);
expect(result.displayField).toBe('name');
expect(result.descriptionField).toBe('industry');
expect(result.lookupColumns).toHaveLength(2);
expect(result.lookupPageSize).toBe(20);
expect(result.lookupFilters?.[0]).toEqual({ field: 'status', operator: 'eq', value: 'active' });
expect(result.dependsOn).toHaveLength(2);
});

it('builds a lookup with picker config via Field.lookup', () => {
const f = Field.lookup('crm_account', {
label: 'Account',
lookupColumns: ['name', 'industry'],
lookupFilters: [{ field: 'status', operator: 'eq', value: 'active' }],
});
const result = FieldSchema.parse({ name: 'account', ...f });
expect(result.lookupColumns).toEqual(['name', 'industry']);
expect(result.lookupFilters?.[0].operator).toBe('eq');
});
});

describe('Calculated Fields', () => {
Expand Down
29 changes: 29 additions & 0 deletions packages/spec/src/data/field.zod.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -445,6 +445,35 @@ export const FieldSchema = lazySchema(() => z.object({
/** Optional explicit columns for the detail-page related list (derived from the child object when omitted). */
relatedListColumns: z.array(z.any()).optional().describe('Explicit columns for the detail-page related list (derived from the child object when omitted)'),

/**
* LOOKUP PICKER (forward) config — how THIS lookup/master_detail field's
* record picker presents and scopes candidate records when the user selects a
* related record. Read-side mirror is relatedList* (the PARENT's detail-page
* list of children); these configure the CHILD-side picker that chooses the
* parent. All optional: the renderer auto-derives a sensible multi-column
* result from the referenced object's schema when omitted (objectui
* packages/fields: LookupField / RecordPickerDialog / deriveLookupColumns,
* which read both these camelCase keys and their snake_case aliases).
*/
displayField: z.string().optional().describe("Field shown as each candidate's label in the picker/popover (defaults to the referenced object's name/title)."),
descriptionField: z.string().optional().describe('Secondary field shown under the label in the quick-select popover.'),
lookupColumns: z.array(z.union([z.string(), z.object({
field: z.string(),
label: z.string().optional(),
width: z.string().optional(),
type: z.string().optional(),
})])).optional().describe('Explicit columns for the record-picker table; auto-derived from the referenced object when omitted.'),
lookupPageSize: z.number().int().positive().optional().describe('Rows per page in the record-picker dialog (default 10).'),
lookupFilters: z.array(z.object({
field: z.string(),
operator: z.enum(['eq', 'ne', 'gt', 'lt', 'gte', 'lte', 'contains', 'in', 'notIn']),
value: z.any(),
})).optional().describe('Base filters restricting which records are selectable (e.g. only active). Structured, picker-honoured form of referenceFilters.'),
dependsOn: z.array(z.union([z.string(), z.object({
field: z.string(),
param: z.string().optional(),
})])).optional().describe('Dependent lookup: restrict candidates by the value of other field(s) on the same record. String = same local/remote key; {field,param} when the remote filter key differs.'),

/** Calculation — CEL formula. Plain string accepted for back-compat; build emits canonical envelope. */
expression: ExpressionInputSchema.optional().describe('Formula expression (CEL). e.g. F`record.amount * 0.1`'),
summaryOperations: z.object({
Expand Down
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
feat(spec,showcase): lookup record-picker authoring metadata + demo#2125

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

xuyushun441-sys
merged 2 commits into

from

Jun 21, 2026
 Merged


feat(spec,showcase): lookup record-picker authoring metadata + demo
#2125
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
6334f4c

feat(spec,showcase): lookup record-picker authoring metadata + demo


os-zhuang Jun 21, 2026
d7d57ff

chore(spec): classify new lookup picker props in the liveness ledger


os-zhuang Jun 21, 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


12 changes: 12 additions & 0 deletions
examples/app-showcase/src/data/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,18 @@ const accounts = defineSeed(Account, {
 { name: 'Northwind', industry: 'retail', annual_revenue: 8_000_000, website: 'https://northwind.example', status: 'active', hq: { lat: 47.6062, lng: -122.3321 }, tax_id: '91-1144442', billing_email: 'ap@northwind.example' },
 { name: 'Contoso', industry: 'technology', annual_revenue: 25_000_000, website: 'https://contoso.example', status: 'active', hq: { lat: 37.7749, lng: -122.4194 }, tax_id: '20-3399881', billing_email: 'billing@contoso.example' },
 { name: 'Fabrikam', industry: 'healthcare', annual_revenue: 12_000_000, website: 'https://fabrikam.example', status: 'prospect', hq: { lat: 40.7128, lng: -74.0060 }, tax_id: '46-7782013', billing_email: 'accounts@fabrikam.example' },
 // Extra accounts so the record picker has enough volume to exercise search,
 // sorting, pagination and the (non-churned) scoping filter on invoices.
 { name: 'Initech', industry: 'finance', annual_revenue: 5_400_000, website: 'https://initech.example', status: 'active', hq: { lat: 30.2672, lng: -97.7431 }, tax_id: '74-2233110', billing_email: 'ap@initech.example' },
 { name: 'Globex', industry: 'technology', annual_revenue: 42_000_000, website: 'https://globex.example', status: 'active', hq: { lat: 34.0522, lng: -118.2437 }, tax_id: '95-8841200', billing_email: 'billing@globex.example' },
 { name: 'Stark Industries', industry: 'technology', annual_revenue: 180_000_000, website: 'https://stark.example', status: 'active', hq: { lat: 40.7580, lng: -73.9855 }, tax_id: '13-5567421', billing_email: 'ap@stark.example' },
 { name: 'Wayne Enterprises', industry: 'finance', annual_revenue: 210_000_000, website: 'https://wayne.example', status: 'active', hq: { lat: 40.7128, lng: -74.0060 }, tax_id: '22-9087733', billing_email: 'billing@wayne.example' },
 { name: 'Acme Retail', industry: 'retail', annual_revenue: 3_200_000, website: 'https://acme.example', status: 'prospect', hq: { lat: 41.8781, lng: -87.6298 }, tax_id: '36-4471209', billing_email: 'accounts@acme.example' },
 { name: 'Soylent Foods', industry: 'healthcare', annual_revenue: 9_900_000, website: 'https://soylent.example', status: 'prospect', hq: { lat: 37.3382, lng: -121.8863 }, tax_id: '77-1029384', billing_email: 'ap@soylent.example' },
 { name: 'Hooli', industry: 'technology', annual_revenue: 96_000_000, website: 'https://hooli.example', status: 'active', hq: { lat: 37.3861, lng: -122.0839 }, tax_id: '45-7781230', billing_email: 'billing@hooli.example' },
 { name: 'Vandelay Industries', industry: 'finance', annual_revenue: 6_700_000, website: 'https://vandelay.example', status: 'active', hq: { lat: 40.6782, lng: -73.9442 }, tax_id: '11-3344556', billing_email: 'ap@vandelay.example' },
 { name: 'Umbrella Health', industry: 'healthcare', annual_revenue: 33_000_000, website: 'https://umbrella.example', status: 'churned', hq: { lat: 39.9526, lng: -75.1652 }, tax_id: '88-2200117', churn_reason: 'Switched to in-house platform', billing_email: 'accounts@umbrella.example' },
 { name: 'Wonka Brands', industry: 'retail', annual_revenue: 14_500_000, website: 'https://wonka.example', status: 'churned', hq: { lat: 41.4993, lng: -81.6944 }, tax_id: '52-7741093', churn_reason: 'Budget cuts', billing_email: 'ap@wonka.example' },
 ],
});

Expand Down

17 changes: 16 additions & 1 deletion
examples/app-showcase/src/objects/invoice.object.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,22 @@ export const Invoice = ObjectSchema.create({

 fields: {
 name: Field.text({ label: 'Invoice Number', required: true, searchable: true, maxLength: 60 }),
 account: Field.lookup('showcase_account', { label: 'Account', required: true }),
 // Forward record-picker config (spec lookup* props). The renderer
 // auto-derives columns from the Account schema, but here we curate them and
 // — crucially — SCOPE the picker so a rep can't invoice a churned account.
 // `lookupFilters` is the structured, picker-honoured form of referenceFilters.
 account: Field.lookup('showcase_account', {
 label: 'Account',
 required: true,
 descriptionField: 'industry',
 lookupColumns: [
 'name',
 { field: 'industry', label: 'Industry', type: 'select' },
 { field: 'status', label: 'Lifecycle', type: 'select' },
 { field: 'annual_revenue', label: 'Annual Revenue', type: 'currency' },
 ],
 lookupFilters: [{ field: 'status', operator: 'ne', value: 'churned' }],
 }),
 // Owner email — the row-level-security anchor. The `showcase_contributor`
 // permission set scopes invoice SELECT to `owner = current_user.email` (email
 // is the unique, seedable identifier), so a contributor sees only their own
Expand Down

28 changes: 26 additions & 2 deletions
packages/spec/liveness/field.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -151,9 +151,33 @@
 },
 "referenceFilters": {
 "status": "dead",
 "evidence": "lookup dialog reads lookup_filters (LookupField.tsx:171) — entirely dead as authored (naming drift)",
 "evidence": "lookup dialog reads lookup_filters/lookupFilters (LookupField.tsx) — the string[] referenceFilters form is not read (naming drift)",
 "authorWarn": true,
 "authorHint": "The lookup dialog reads `lookup_filters`, not `referenceFilters` — as authored this filters nothing. Use the supported lookup-filter key, or remove it to avoid implying a constrained lookup."
 "authorHint": "The picker reads the structured `lookupFilters` ({field,operator,value}), not the string[] `referenceFilters` — as authored this filters nothing. Use `lookupFilters`, or remove this to avoid implying a constrained lookup."
 },
 "displayField": {
 "status": "live",
 "note": "objectui LookupField/RecordPickerDialog — candidate label field in the record picker (reads displayField || display_field)."
 },
 "descriptionField": {
 "status": "live",
 "note": "objectui LookupField — secondary line under each option in the quick-select popover (reads descriptionField || description_field)."
 },
 "lookupColumns": {
 "status": "live",
 "note": "objectui RecordPickerDialog — record-picker table columns; renderer auto-derives from the referenced object when omitted (reads lookupColumns || lookup_columns)."
 },
 "lookupPageSize": {
 "status": "live",
 "note": "objectui RecordPickerDialog — rows per page in the record-picker dialog (reads lookupPageSize || lookup_page_size)."
 },
 "lookupFilters": {
 "status": "live",
 "note": "objectui LookupField + RecordPickerDialog — base scoping filters honoured by BOTH popover and dialog; structured supported form of referenceFilters (reads lookupFilters || lookup_filters)."
 },
 "dependsOn": {
 "status": "live",
 "note": "objectui LookupField — dependent/cascading lookup; restricts candidates by another field's value (reads dependsOn || depends_on)."
 },
 "maxRating": {
 "status": "dead",
Expand Down

34 changes: 34 additions & 0 deletions
packages/spec/src/data/field.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -296,6 +296,40 @@ describe('FieldSchema', () => {
 const result = FieldSchema.parse(lookupField);
 expect(result.deleteBehavior).toBe('set_null');
 });

 it('should preserve forward record-picker config (display/columns/filters/depends)', () => {
 const lookupField: Field = {
 name: 'account',
 label: 'Account',
 type: 'lookup',
 reference: 'crm_account',
 displayField: 'name',
 descriptionField: 'industry',
 lookupColumns: ['name', { field: 'annual_revenue', label: 'Revenue', type: 'currency' }],
 lookupPageSize: 20,
 lookupFilters: [{ field: 'status', operator: 'eq', value: 'active' }],
 dependsOn: ['region', { field: 'country', param: 'country_code' }],
 };

 const result = FieldSchema.parse(lookupField);
 expect(result.displayField).toBe('name');
 expect(result.descriptionField).toBe('industry');
 expect(result.lookupColumns).toHaveLength(2);
 expect(result.lookupPageSize).toBe(20);
 expect(result.lookupFilters?.[0]).toEqual({ field: 'status', operator: 'eq', value: 'active' });
 expect(result.dependsOn).toHaveLength(2);
 });

 it('builds a lookup with picker config via Field.lookup', () => {
 const f = Field.lookup('crm_account', {
 label: 'Account',
 lookupColumns: ['name', 'industry'],
 lookupFilters: [{ field: 'status', operator: 'eq', value: 'active' }],
 });
 const result = FieldSchema.parse({ name: 'account', ...f });
 expect(result.lookupColumns).toEqual(['name', 'industry']);
 expect(result.lookupFilters?.[0].operator).toBe('eq');
 });
 });

 describe('Calculated Fields', () => {
Expand Down

29 changes: 29 additions & 0 deletions
packages/spec/src/data/field.zod.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -445,6 +445,35 @@ export const FieldSchema = lazySchema(() => z.object({
 /** Optional explicit columns for the detail-page related list (derived from the child object when omitted). */
 relatedListColumns: z.array(z.any()).optional().describe('Explicit columns for the detail-page related list (derived from the child object when omitted)'),

 /**
 * LOOKUP PICKER (forward) config — how THIS lookup/master_detail field's
 * record picker presents and scopes candidate records when the user selects a
 * related record. Read-side mirror is relatedList* (the PARENT's detail-page
 * list of children); these configure the CHILD-side picker that chooses the
 * parent. All optional: the renderer auto-derives a sensible multi-column
 * result from the referenced object's schema when omitted (objectui
 * packages/fields: LookupField / RecordPickerDialog / deriveLookupColumns,
 * which read both these camelCase keys and their snake_case aliases).
 */
 displayField: z.string().optional().describe("Field shown as each candidate's label in the picker/popover (defaults to the referenced object's name/title)."),
 descriptionField: z.string().optional().describe('Secondary field shown under the label in the quick-select popover.'),
 lookupColumns: z.array(z.union([z.string(), z.object({
 field: z.string(),
 label: z.string().optional(),
 width: z.string().optional(),
 type: z.string().optional(),
 })])).optional().describe('Explicit columns for the record-picker table; auto-derived from the referenced object when omitted.'),
 lookupPageSize: z.number().int().positive().optional().describe('Rows per page in the record-picker dialog (default 10).'),
 lookupFilters: z.array(z.object({
 field: z.string(),
 operator: z.enum(['eq', 'ne', 'gt', 'lt', 'gte', 'lte', 'contains', 'in', 'notIn']),
 value: z.any(),
 })).optional().describe('Base filters restricting which records are selectable (e.g. only active). Structured, picker-honoured form of referenceFilters.'),
 dependsOn: z.array(z.union([z.string(), z.object({
 field: z.string(),
 param: z.string().optional(),
 })])).optional().describe('Dependent lookup: restrict candidates by the value of other field(s) on the same record. String = same local/remote key; {field,param} when the remote filter key differs.'),

 /** Calculation — CEL formula. Plain string accepted for back-compat; build emits canonical envelope. */
 expression: ExpressionInputSchema.optional().describe('Formula expression (CEL). e.g. F`record.amount * 0.1`'),
 summaryOperations: z.object({
Expand Down
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
feat(spec,showcase): lookup record-picker authoring metadata + demo#2125

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

xuyushun441-sys
merged 2 commits into

from

Jun 21, 2026
 Merged


feat(spec,showcase): lookup record-picker authoring metadata + demo
#2125
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
6334f4c

feat(spec,showcase): lookup record-picker authoring metadata + demo


os-zhuang Jun 21, 2026
d7d57ff

chore(spec): classify new lookup picker props in the liveness ledger


os-zhuang Jun 21, 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


12 changes: 12 additions & 0 deletions
examples/app-showcase/src/data/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,18 @@ const accounts = defineSeed(Account, {
 { name: 'Northwind', industry: 'retail', annual_revenue: 8_000_000, website: 'https://northwind.example', status: 'active', hq: { lat: 47.6062, lng: -122.3321 }, tax_id: '91-1144442', billing_email: 'ap@northwind.example' },
 { name: 'Contoso', industry: 'technology', annual_revenue: 25_000_000, website: 'https://contoso.example', status: 'active', hq: { lat: 37.7749, lng: -122.4194 }, tax_id: '20-3399881', billing_email: 'billing@contoso.example' },
 { name: 'Fabrikam', industry: 'healthcare', annual_revenue: 12_000_000, website: 'https://fabrikam.example', status: 'prospect', hq: { lat: 40.7128, lng: -74.0060 }, tax_id: '46-7782013', billing_email: 'accounts@fabrikam.example' },
 // Extra accounts so the record picker has enough volume to exercise search,
 // sorting, pagination and the (non-churned) scoping filter on invoices.
 { name: 'Initech', industry: 'finance', annual_revenue: 5_400_000, website: 'https://initech.example', status: 'active', hq: { lat: 30.2672, lng: -97.7431 }, tax_id: '74-2233110', billing_email: 'ap@initech.example' },
 { name: 'Globex', industry: 'technology', annual_revenue: 42_000_000, website: 'https://globex.example', status: 'active', hq: { lat: 34.0522, lng: -118.2437 }, tax_id: '95-8841200', billing_email: 'billing@globex.example' },
 { name: 'Stark Industries', industry: 'technology', annual_revenue: 180_000_000, website: 'https://stark.example', status: 'active', hq: { lat: 40.7580, lng: -73.9855 }, tax_id: '13-5567421', billing_email: 'ap@stark.example' },
 { name: 'Wayne Enterprises', industry: 'finance', annual_revenue: 210_000_000, website: 'https://wayne.example', status: 'active', hq: { lat: 40.7128, lng: -74.0060 }, tax_id: '22-9087733', billing_email: 'billing@wayne.example' },
 { name: 'Acme Retail', industry: 'retail', annual_revenue: 3_200_000, website: 'https://acme.example', status: 'prospect', hq: { lat: 41.8781, lng: -87.6298 }, tax_id: '36-4471209', billing_email: 'accounts@acme.example' },
 { name: 'Soylent Foods', industry: 'healthcare', annual_revenue: 9_900_000, website: 'https://soylent.example', status: 'prospect', hq: { lat: 37.3382, lng: -121.8863 }, tax_id: '77-1029384', billing_email: 'ap@soylent.example' },
 { name: 'Hooli', industry: 'technology', annual_revenue: 96_000_000, website: 'https://hooli.example', status: 'active', hq: { lat: 37.3861, lng: -122.0839 }, tax_id: '45-7781230', billing_email: 'billing@hooli.example' },
 { name: 'Vandelay Industries', industry: 'finance', annual_revenue: 6_700_000, website: 'https://vandelay.example', status: 'active', hq: { lat: 40.6782, lng: -73.9442 }, tax_id: '11-3344556', billing_email: 'ap@vandelay.example' },
 { name: 'Umbrella Health', industry: 'healthcare', annual_revenue: 33_000_000, website: 'https://umbrella.example', status: 'churned', hq: { lat: 39.9526, lng: -75.1652 }, tax_id: '88-2200117', churn_reason: 'Switched to in-house platform', billing_email: 'accounts@umbrella.example' },
 { name: 'Wonka Brands', industry: 'retail', annual_revenue: 14_500_000, website: 'https://wonka.example', status: 'churned', hq: { lat: 41.4993, lng: -81.6944 }, tax_id: '52-7741093', churn_reason: 'Budget cuts', billing_email: 'ap@wonka.example' },
 ],
});

Expand Down

17 changes: 16 additions & 1 deletion
examples/app-showcase/src/objects/invoice.object.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,22 @@ export const Invoice = ObjectSchema.create({

 fields: {
 name: Field.text({ label: 'Invoice Number', required: true, searchable: true, maxLength: 60 }),
 account: Field.lookup('showcase_account', { label: 'Account', required: true }),
 // Forward record-picker config (spec lookup* props). The renderer
 // auto-derives columns from the Account schema, but here we curate them and
 // — crucially — SCOPE the picker so a rep can't invoice a churned account.
 // `lookupFilters` is the structured, picker-honoured form of referenceFilters.
 account: Field.lookup('showcase_account', {
 label: 'Account',
 required: true,
 descriptionField: 'industry',
 lookupColumns: [
 'name',
 { field: 'industry', label: 'Industry', type: 'select' },
 { field: 'status', label: 'Lifecycle', type: 'select' },
 { field: 'annual_revenue', label: 'Annual Revenue', type: 'currency' },
 ],
 lookupFilters: [{ field: 'status', operator: 'ne', value: 'churned' }],
 }),
 // Owner email — the row-level-security anchor. The `showcase_contributor`
 // permission set scopes invoice SELECT to `owner = current_user.email` (email
 // is the unique, seedable identifier), so a contributor sees only their own
Expand Down

28 changes: 26 additions & 2 deletions
packages/spec/liveness/field.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -151,9 +151,33 @@
 },
 "referenceFilters": {
 "status": "dead",
 "evidence": "lookup dialog reads lookup_filters (LookupField.tsx:171) — entirely dead as authored (naming drift)",
 "evidence": "lookup dialog reads lookup_filters/lookupFilters (LookupField.tsx) — the string[] referenceFilters form is not read (naming drift)",
 "authorWarn": true,
 "authorHint": "The lookup dialog reads `lookup_filters`, not `referenceFilters` — as authored this filters nothing. Use the supported lookup-filter key, or remove it to avoid implying a constrained lookup."
 "authorHint": "The picker reads the structured `lookupFilters` ({field,operator,value}), not the string[] `referenceFilters` — as authored this filters nothing. Use `lookupFilters`, or remove this to avoid implying a constrained lookup."
 },
 "displayField": {
 "status": "live",
 "note": "objectui LookupField/RecordPickerDialog — candidate label field in the record picker (reads displayField || display_field)."
 },
 "descriptionField": {
 "status": "live",
 "note": "objectui LookupField — secondary line under each option in the quick-select popover (reads descriptionField || description_field)."
 },
 "lookupColumns": {
 "status": "live",
 "note": "objectui RecordPickerDialog — record-picker table columns; renderer auto-derives from the referenced object when omitted (reads lookupColumns || lookup_columns)."
 },
 "lookupPageSize": {
 "status": "live",
 "note": "objectui RecordPickerDialog — rows per page in the record-picker dialog (reads lookupPageSize || lookup_page_size)."
 },
 "lookupFilters": {
 "status": "live",
 "note": "objectui LookupField + RecordPickerDialog — base scoping filters honoured by BOTH popover and dialog; structured supported form of referenceFilters (reads lookupFilters || lookup_filters)."
 },
 "dependsOn": {
 "status": "live",
 "note": "objectui LookupField — dependent/cascading lookup; restricts candidates by another field's value (reads dependsOn || depends_on)."
 },
 "maxRating": {
 "status": "dead",
Expand Down

34 changes: 34 additions & 0 deletions
packages/spec/src/data/field.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -296,6 +296,40 @@ describe('FieldSchema', () => {
 const result = FieldSchema.parse(lookupField);
 expect(result.deleteBehavior).toBe('set_null');
 });

 it('should preserve forward record-picker config (display/columns/filters/depends)', () => {
 const lookupField: Field = {
 name: 'account',
 label: 'Account',
 type: 'lookup',
 reference: 'crm_account',
 displayField: 'name',
 descriptionField: 'industry',
 lookupColumns: ['name', { field: 'annual_revenue', label: 'Revenue', type: 'currency' }],
 lookupPageSize: 20,
 lookupFilters: [{ field: 'status', operator: 'eq', value: 'active' }],
 dependsOn: ['region', { field: 'country', param: 'country_code' }],
 };

 const result = FieldSchema.parse(lookupField);
 expect(result.displayField).toBe('name');
 expect(result.descriptionField).toBe('industry');
 expect(result.lookupColumns).toHaveLength(2);
 expect(result.lookupPageSize).toBe(20);
 expect(result.lookupFilters?.[0]).toEqual({ field: 'status', operator: 'eq', value: 'active' });
 expect(result.dependsOn).toHaveLength(2);
 });

 it('builds a lookup with picker config via Field.lookup', () => {
 const f = Field.lookup('crm_account', {
 label: 'Account',
 lookupColumns: ['name', 'industry'],
 lookupFilters: [{ field: 'status', operator: 'eq', value: 'active' }],
 });
 const result = FieldSchema.parse({ name: 'account', ...f });
 expect(result.lookupColumns).toEqual(['name', 'industry']);
 expect(result.lookupFilters?.[0].operator).toBe('eq');
 });
 });

 describe('Calculated Fields', () => {
Expand Down

29 changes: 29 additions & 0 deletions
packages/spec/src/data/field.zod.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -445,6 +445,35 @@ export const FieldSchema = lazySchema(() => z.object({
 /** Optional explicit columns for the detail-page related list (derived from the child object when omitted). */
 relatedListColumns: z.array(z.any()).optional().describe('Explicit columns for the detail-page related list (derived from the child object when omitted)'),

 /**
 * LOOKUP PICKER (forward) config — how THIS lookup/master_detail field's
 * record picker presents and scopes candidate records when the user selects a
 * related record. Read-side mirror is relatedList* (the PARENT's detail-page
 * list of children); these configure the CHILD-side picker that chooses the
 * parent. All optional: the renderer auto-derives a sensible multi-column
 * result from the referenced object's schema when omitted (objectui
 * packages/fields: LookupField / RecordPickerDialog / deriveLookupColumns,
 * which read both these camelCase keys and their snake_case aliases).
 */
 displayField: z.string().optional().describe("Field shown as each candidate's label in the picker/popover (defaults to the referenced object's name/title)."),
 descriptionField: z.string().optional().describe('Secondary field shown under the label in the quick-select popover.'),
 lookupColumns: z.array(z.union([z.string(), z.object({
 field: z.string(),
 label: z.string().optional(),
 width: z.string().optional(),
 type: z.string().optional(),
 })])).optional().describe('Explicit columns for the record-picker table; auto-derived from the referenced object when omitted.'),
 lookupPageSize: z.number().int().positive().optional().describe('Rows per page in the record-picker dialog (default 10).'),
 lookupFilters: z.array(z.object({
 field: z.string(),
 operator: z.enum(['eq', 'ne', 'gt', 'lt', 'gte', 'lte', 'contains', 'in', 'notIn']),
 value: z.any(),
 })).optional().describe('Base filters restricting which records are selectable (e.g. only active). Structured, picker-honoured form of referenceFilters.'),
 dependsOn: z.array(z.union([z.string(), z.object({
 field: z.string(),
 param: z.string().optional(),
 })])).optional().describe('Dependent lookup: restrict candidates by the value of other field(s) on the same record. String = same local/remote key; {field,param} when the remote filter key differs.'),

 /** Calculation — CEL formula. Plain string accepted for back-compat; build emits canonical envelope. */
 expression: ExpressionInputSchema.optional().describe('Formula expression (CEL). e.g. F`record.amount * 0.1`'),
 summaryOperations: z.object({
Expand Down
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
feat(spec,showcase): lookup record-picker authoring metadata + demo#2125

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

xuyushun441-sys
merged 2 commits into

from

Jun 21, 2026
 Merged


feat(spec,showcase): lookup record-picker authoring metadata + demo
#2125
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
6334f4c

feat(spec,showcase): lookup record-picker authoring metadata + demo


os-zhuang Jun 21, 2026
d7d57ff

chore(spec): classify new lookup picker props in the liveness ledger


os-zhuang Jun 21, 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


12 changes: 12 additions & 0 deletions
examples/app-showcase/src/data/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,18 @@ const accounts = defineSeed(Account, {
 { name: 'Northwind', industry: 'retail', annual_revenue: 8_000_000, website: 'https://northwind.example', status: 'active', hq: { lat: 47.6062, lng: -122.3321 }, tax_id: '91-1144442', billing_email: 'ap@northwind.example' },
 { name: 'Contoso', industry: 'technology', annual_revenue: 25_000_000, website: 'https://contoso.example', status: 'active', hq: { lat: 37.7749, lng: -122.4194 }, tax_id: '20-3399881', billing_email: 'billing@contoso.example' },
 { name: 'Fabrikam', industry: 'healthcare', annual_revenue: 12_000_000, website: 'https://fabrikam.example', status: 'prospect', hq: { lat: 40.7128, lng: -74.0060 }, tax_id: '46-7782013', billing_email: 'accounts@fabrikam.example' },
 // Extra accounts so the record picker has enough volume to exercise search,
 // sorting, pagination and the (non-churned) scoping filter on invoices.
 { name: 'Initech', industry: 'finance', annual_revenue: 5_400_000, website: 'https://initech.example', status: 'active', hq: { lat: 30.2672, lng: -97.7431 }, tax_id: '74-2233110', billing_email: 'ap@initech.example' },
 { name: 'Globex', industry: 'technology', annual_revenue: 42_000_000, website: 'https://globex.example', status: 'active', hq: { lat: 34.0522, lng: -118.2437 }, tax_id: '95-8841200', billing_email: 'billing@globex.example' },
 { name: 'Stark Industries', industry: 'technology', annual_revenue: 180_000_000, website: 'https://stark.example', status: 'active', hq: { lat: 40.7580, lng: -73.9855 }, tax_id: '13-5567421', billing_email: 'ap@stark.example' },
 { name: 'Wayne Enterprises', industry: 'finance', annual_revenue: 210_000_000, website: 'https://wayne.example', status: 'active', hq: { lat: 40.7128, lng: -74.0060 }, tax_id: '22-9087733', billing_email: 'billing@wayne.example' },
 { name: 'Acme Retail', industry: 'retail', annual_revenue: 3_200_000, website: 'https://acme.example', status: 'prospect', hq: { lat: 41.8781, lng: -87.6298 }, tax_id: '36-4471209', billing_email: 'accounts@acme.example' },
 { name: 'Soylent Foods', industry: 'healthcare', annual_revenue: 9_900_000, website: 'https://soylent.example', status: 'prospect', hq: { lat: 37.3382, lng: -121.8863 }, tax_id: '77-1029384', billing_email: 'ap@soylent.example' },
 { name: 'Hooli', industry: 'technology', annual_revenue: 96_000_000, website: 'https://hooli.example', status: 'active', hq: { lat: 37.3861, lng: -122.0839 }, tax_id: '45-7781230', billing_email: 'billing@hooli.example' },
 { name: 'Vandelay Industries', industry: 'finance', annual_revenue: 6_700_000, website: 'https://vandelay.example', status: 'active', hq: { lat: 40.6782, lng: -73.9442 }, tax_id: '11-3344556', billing_email: 'ap@vandelay.example' },
 { name: 'Umbrella Health', industry: 'healthcare', annual_revenue: 33_000_000, website: 'https://umbrella.example', status: 'churned', hq: { lat: 39.9526, lng: -75.1652 }, tax_id: '88-2200117', churn_reason: 'Switched to in-house platform', billing_email: 'accounts@umbrella.example' },
 { name: 'Wonka Brands', industry: 'retail', annual_revenue: 14_500_000, website: 'https://wonka.example', status: 'churned', hq: { lat: 41.4993, lng: -81.6944 }, tax_id: '52-7741093', churn_reason: 'Budget cuts', billing_email: 'ap@wonka.example' },
 ],
});

Expand Down

17 changes: 16 additions & 1 deletion
examples/app-showcase/src/objects/invoice.object.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,22 @@ export const Invoice = ObjectSchema.create({

 fields: {
 name: Field.text({ label: 'Invoice Number', required: true, searchable: true, maxLength: 60 }),
 account: Field.lookup('showcase_account', { label: 'Account', required: true }),
 // Forward record-picker config (spec lookup* props). The renderer
 // auto-derives columns from the Account schema, but here we curate them and
 // — crucially — SCOPE the picker so a rep can't invoice a churned account.
 // `lookupFilters` is the structured, picker-honoured form of referenceFilters.
 account: Field.lookup('showcase_account', {
 label: 'Account',
 required: true,
 descriptionField: 'industry',
 lookupColumns: [
 'name',
 { field: 'industry', label: 'Industry', type: 'select' },
 { field: 'status', label: 'Lifecycle', type: 'select' },
 { field: 'annual_revenue', label: 'Annual Revenue', type: 'currency' },
 ],
 lookupFilters: [{ field: 'status', operator: 'ne', value: 'churned' }],
 }),
 // Owner email — the row-level-security anchor. The `showcase_contributor`
 // permission set scopes invoice SELECT to `owner = current_user.email` (email
 // is the unique, seedable identifier), so a contributor sees only their own
Expand Down

28 changes: 26 additions & 2 deletions
packages/spec/liveness/field.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -151,9 +151,33 @@
 },
 "referenceFilters": {
 "status": "dead",
 "evidence": "lookup dialog reads lookup_filters (LookupField.tsx:171) — entirely dead as authored (naming drift)",
 "evidence": "lookup dialog reads lookup_filters/lookupFilters (LookupField.tsx) — the string[] referenceFilters form is not read (naming drift)",
 "authorWarn": true,
 "authorHint": "The lookup dialog reads `lookup_filters`, not `referenceFilters` — as authored this filters nothing. Use the supported lookup-filter key, or remove it to avoid implying a constrained lookup."
 "authorHint": "The picker reads the structured `lookupFilters` ({field,operator,value}), not the string[] `referenceFilters` — as authored this filters nothing. Use `lookupFilters`, or remove this to avoid implying a constrained lookup."
 },
 "displayField": {
 "status": "live",
 "note": "objectui LookupField/RecordPickerDialog — candidate label field in the record picker (reads displayField || display_field)."
 },
 "descriptionField": {
 "status": "live",
 "note": "objectui LookupField — secondary line under each option in the quick-select popover (reads descriptionField || description_field)."
 },
 "lookupColumns": {
 "status": "live",
 "note": "objectui RecordPickerDialog — record-picker table columns; renderer auto-derives from the referenced object when omitted (reads lookupColumns || lookup_columns)."
 },
 "lookupPageSize": {
 "status": "live",
 "note": "objectui RecordPickerDialog — rows per page in the record-picker dialog (reads lookupPageSize || lookup_page_size)."
 },
 "lookupFilters": {
 "status": "live",
 "note": "objectui LookupField + RecordPickerDialog — base scoping filters honoured by BOTH popover and dialog; structured supported form of referenceFilters (reads lookupFilters || lookup_filters)."
 },
 "dependsOn": {
 "status": "live",
 "note": "objectui LookupField — dependent/cascading lookup; restricts candidates by another field's value (reads dependsOn || depends_on)."
 },
 "maxRating": {
 "status": "dead",
Expand Down

34 changes: 34 additions & 0 deletions
packages/spec/src/data/field.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -296,6 +296,40 @@ describe('FieldSchema', () => {
 const result = FieldSchema.parse(lookupField);
 expect(result.deleteBehavior).toBe('set_null');
 });

 it('should preserve forward record-picker config (display/columns/filters/depends)', () => {
 const lookupField: Field = {
 name: 'account',
 label: 'Account',
 type: 'lookup',
 reference: 'crm_account',
 displayField: 'name',
 descriptionField: 'industry',
 lookupColumns: ['name', { field: 'annual_revenue', label: 'Revenue', type: 'currency' }],
 lookupPageSize: 20,
 lookupFilters: [{ field: 'status', operator: 'eq', value: 'active' }],
 dependsOn: ['region', { field: 'country', param: 'country_code' }],
 };

 const result = FieldSchema.parse(lookupField);
 expect(result.displayField).toBe('name');
 expect(result.descriptionField).toBe('industry');
 expect(result.lookupColumns).toHaveLength(2);
 expect(result.lookupPageSize).toBe(20);
 expect(result.lookupFilters?.[0]).toEqual({ field: 'status', operator: 'eq', value: 'active' });
 expect(result.dependsOn).toHaveLength(2);
 });

 it('builds a lookup with picker config via Field.lookup', () => {
 const f = Field.lookup('crm_account', {
 label: 'Account',
 lookupColumns: ['name', 'industry'],
 lookupFilters: [{ field: 'status', operator: 'eq', value: 'active' }],
 });
 const result = FieldSchema.parse({ name: 'account', ...f });
 expect(result.lookupColumns).toEqual(['name', 'industry']);
 expect(result.lookupFilters?.[0].operator).toBe('eq');
 });
 });

 describe('Calculated Fields', () => {
Expand Down

29 changes: 29 additions & 0 deletions
packages/spec/src/data/field.zod.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -445,6 +445,35 @@ export const FieldSchema = lazySchema(() => z.object({
 /** Optional explicit columns for the detail-page related list (derived from the child object when omitted). */
 relatedListColumns: z.array(z.any()).optional().describe('Explicit columns for the detail-page related list (derived from the child object when omitted)'),

 /**
 * LOOKUP PICKER (forward) config — how THIS lookup/master_detail field's
 * record picker presents and scopes candidate records when the user selects a
 * related record. Read-side mirror is relatedList* (the PARENT's detail-page
 * list of children); these configure the CHILD-side picker that chooses the
 * parent. All optional: the renderer auto-derives a sensible multi-column
 * result from the referenced object's schema when omitted (objectui
 * packages/fields: LookupField / RecordPickerDialog / deriveLookupColumns,
 * which read both these camelCase keys and their snake_case aliases).
 */
 displayField: z.string().optional().describe("Field shown as each candidate's label in the picker/popover (defaults to the referenced object's name/title)."),
 descriptionField: z.string().optional().describe('Secondary field shown under the label in the quick-select popover.'),
 lookupColumns: z.array(z.union([z.string(), z.object({
 field: z.string(),
 label: z.string().optional(),
 width: z.string().optional(),
 type: z.string().optional(),
 })])).optional().describe('Explicit columns for the record-picker table; auto-derived from the referenced object when omitted.'),
 lookupPageSize: z.number().int().positive().optional().describe('Rows per page in the record-picker dialog (default 10).'),
 lookupFilters: z.array(z.object({
 field: z.string(),
 operator: z.enum(['eq', 'ne', 'gt', 'lt', 'gte', 'lte', 'contains', 'in', 'notIn']),
 value: z.any(),
 })).optional().describe('Base filters restricting which records are selectable (e.g. only active). Structured, picker-honoured form of referenceFilters.'),
 dependsOn: z.array(z.union([z.string(), z.object({
 field: z.string(),
 param: z.string().optional(),
 })])).optional().describe('Dependent lookup: restrict candidates by the value of other field(s) on the same record. String = same local/remote key; {field,param} when the remote filter key differs.'),

 /** Calculation — CEL formula. Plain string accepted for back-compat; build emits canonical envelope. */
 expression: ExpressionInputSchema.optional().describe('Formula expression (CEL). e.g. F`record.amount * 0.1`'),
 summaryOperations: z.object({
Expand Down
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
feat(spec,showcase): lookup record-picker authoring metadata + demo#2125

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

xuyushun441-sys
merged 2 commits into

from

Jun 21, 2026
 Merged


feat(spec,showcase): lookup record-picker authoring metadata + demo
#2125
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
6334f4c

feat(spec,showcase): lookup record-picker authoring metadata + demo


os-zhuang Jun 21, 2026
d7d57ff

chore(spec): classify new lookup picker props in the liveness ledger


os-zhuang Jun 21, 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


12 changes: 12 additions & 0 deletions
examples/app-showcase/src/data/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,18 @@ const accounts = defineSeed(Account, {
 { name: 'Northwind', industry: 'retail', annual_revenue: 8_000_000, website: 'https://northwind.example', status: 'active', hq: { lat: 47.6062, lng: -122.3321 }, tax_id: '91-1144442', billing_email: 'ap@northwind.example' },
 { name: 'Contoso', industry: 'technology', annual_revenue: 25_000_000, website: 'https://contoso.example', status: 'active', hq: { lat: 37.7749, lng: -122.4194 }, tax_id: '20-3399881', billing_email: 'billing@contoso.example' },
 { name: 'Fabrikam', industry: 'healthcare', annual_revenue: 12_000_000, website: 'https://fabrikam.example', status: 'prospect', hq: { lat: 40.7128, lng: -74.0060 }, tax_id: '46-7782013', billing_email: 'accounts@fabrikam.example' },
 // Extra accounts so the record picker has enough volume to exercise search,
 // sorting, pagination and the (non-churned) scoping filter on invoices.
 { name: 'Initech', industry: 'finance', annual_revenue: 5_400_000, website: 'https://initech.example', status: 'active', hq: { lat: 30.2672, lng: -97.7431 }, tax_id: '74-2233110', billing_email: 'ap@initech.example' },
 { name: 'Globex', industry: 'technology', annual_revenue: 42_000_000, website: 'https://globex.example', status: 'active', hq: { lat: 34.0522, lng: -118.2437 }, tax_id: '95-8841200', billing_email: 'billing@globex.example' },
 { name: 'Stark Industries', industry: 'technology', annual_revenue: 180_000_000, website: 'https://stark.example', status: 'active', hq: { lat: 40.7580, lng: -73.9855 }, tax_id: '13-5567421', billing_email: 'ap@stark.example' },
 { name: 'Wayne Enterprises', industry: 'finance', annual_revenue: 210_000_000, website: 'https://wayne.example', status: 'active', hq: { lat: 40.7128, lng: -74.0060 }, tax_id: '22-9087733', billing_email: 'billing@wayne.example' },
 { name: 'Acme Retail', industry: 'retail', annual_revenue: 3_200_000, website: 'https://acme.example', status: 'prospect', hq: { lat: 41.8781, lng: -87.6298 }, tax_id: '36-4471209', billing_email: 'accounts@acme.example' },
 { name: 'Soylent Foods', industry: 'healthcare', annual_revenue: 9_900_000, website: 'https://soylent.example', status: 'prospect', hq: { lat: 37.3382, lng: -121.8863 }, tax_id: '77-1029384', billing_email: 'ap@soylent.example' },
 { name: 'Hooli', industry: 'technology', annual_revenue: 96_000_000, website: 'https://hooli.example', status: 'active', hq: { lat: 37.3861, lng: -122.0839 }, tax_id: '45-7781230', billing_email: 'billing@hooli.example' },
 { name: 'Vandelay Industries', industry: 'finance', annual_revenue: 6_700_000, website: 'https://vandelay.example', status: 'active', hq: { lat: 40.6782, lng: -73.9442 }, tax_id: '11-3344556', billing_email: 'ap@vandelay.example' },
 { name: 'Umbrella Health', industry: 'healthcare', annual_revenue: 33_000_000, website: 'https://umbrella.example', status: 'churned', hq: { lat: 39.9526, lng: -75.1652 }, tax_id: '88-2200117', churn_reason: 'Switched to in-house platform', billing_email: 'accounts@umbrella.example' },
 { name: 'Wonka Brands', industry: 'retail', annual_revenue: 14_500_000, website: 'https://wonka.example', status: 'churned', hq: { lat: 41.4993, lng: -81.6944 }, tax_id: '52-7741093', churn_reason: 'Budget cuts', billing_email: 'ap@wonka.example' },
 ],
});

Expand Down

17 changes: 16 additions & 1 deletion
examples/app-showcase/src/objects/invoice.object.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,22 @@ export const Invoice = ObjectSchema.create({

 fields: {
 name: Field.text({ label: 'Invoice Number', required: true, searchable: true, maxLength: 60 }),
 account: Field.lookup('showcase_account', { label: 'Account', required: true }),
 // Forward record-picker config (spec lookup* props). The renderer
 // auto-derives columns from the Account schema, but here we curate them and
 // — crucially — SCOPE the picker so a rep can't invoice a churned account.
 // `lookupFilters` is the structured, picker-honoured form of referenceFilters.
 account: Field.lookup('showcase_account', {
 label: 'Account',
 required: true,
 descriptionField: 'industry',
 lookupColumns: [
 'name',
 { field: 'industry', label: 'Industry', type: 'select' },
 { field: 'status', label: 'Lifecycle', type: 'select' },
 { field: 'annual_revenue', label: 'Annual Revenue', type: 'currency' },
 ],
 lookupFilters: [{ field: 'status', operator: 'ne', value: 'churned' }],
 }),
 // Owner email — the row-level-security anchor. The `showcase_contributor`
 // permission set scopes invoice SELECT to `owner = current_user.email` (email
 // is the unique, seedable identifier), so a contributor sees only their own
Expand Down

28 changes: 26 additions & 2 deletions
packages/spec/liveness/field.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -151,9 +151,33 @@
 },
 "referenceFilters": {
 "status": "dead",
 "evidence": "lookup dialog reads lookup_filters (LookupField.tsx:171) — entirely dead as authored (naming drift)",
 "evidence": "lookup dialog reads lookup_filters/lookupFilters (LookupField.tsx) — the string[] referenceFilters form is not read (naming drift)",
 "authorWarn": true,
 "authorHint": "The lookup dialog reads `lookup_filters`, not `referenceFilters` — as authored this filters nothing. Use the supported lookup-filter key, or remove it to avoid implying a constrained lookup."
 "authorHint": "The picker reads the structured `lookupFilters` ({field,operator,value}), not the string[] `referenceFilters` — as authored this filters nothing. Use `lookupFilters`, or remove this to avoid implying a constrained lookup."
 },
 "displayField": {
 "status": "live",
 "note": "objectui LookupField/RecordPickerDialog — candidate label field in the record picker (reads displayField || display_field)."
 },
 "descriptionField": {
 "status": "live",
 "note": "objectui LookupField — secondary line under each option in the quick-select popover (reads descriptionField || description_field)."
 },
 "lookupColumns": {
 "status": "live",
 "note": "objectui RecordPickerDialog — record-picker table columns; renderer auto-derives from the referenced object when omitted (reads lookupColumns || lookup_columns)."
 },
 "lookupPageSize": {
 "status": "live",
 "note": "objectui RecordPickerDialog — rows per page in the record-picker dialog (reads lookupPageSize || lookup_page_size)."
 },
 "lookupFilters": {
 "status": "live",
 "note": "objectui LookupField + RecordPickerDialog — base scoping filters honoured by BOTH popover and dialog; structured supported form of referenceFilters (reads lookupFilters || lookup_filters)."
 },
 "dependsOn": {
 "status": "live",
 "note": "objectui LookupField — dependent/cascading lookup; restricts candidates by another field's value (reads dependsOn || depends_on)."
 },
 "maxRating": {
 "status": "dead",
Expand Down

34 changes: 34 additions & 0 deletions
packages/spec/src/data/field.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -296,6 +296,40 @@ describe('FieldSchema', () => {
 const result = FieldSchema.parse(lookupField);
 expect(result.deleteBehavior).toBe('set_null');
 });

 it('should preserve forward record-picker config (display/columns/filters/depends)', () => {
 const lookupField: Field = {
 name: 'account',
 label: 'Account',
 type: 'lookup',
 reference: 'crm_account',
 displayField: 'name',
 descriptionField: 'industry',
 lookupColumns: ['name', { field: 'annual_revenue', label: 'Revenue', type: 'currency' }],
 lookupPageSize: 20,
 lookupFilters: [{ field: 'status', operator: 'eq', value: 'active' }],
 dependsOn: ['region', { field: 'country', param: 'country_code' }],
 };

 const result = FieldSchema.parse(lookupField);
 expect(result.displayField).toBe('name');
 expect(result.descriptionField).toBe('industry');
 expect(result.lookupColumns).toHaveLength(2);
 expect(result.lookupPageSize).toBe(20);
 expect(result.lookupFilters?.[0]).toEqual({ field: 'status', operator: 'eq', value: 'active' });
 expect(result.dependsOn).toHaveLength(2);
 });

 it('builds a lookup with picker config via Field.lookup', () => {
 const f = Field.lookup('crm_account', {
 label: 'Account',
 lookupColumns: ['name', 'industry'],
 lookupFilters: [{ field: 'status', operator: 'eq', value: 'active' }],
 });
 const result = FieldSchema.parse({ name: 'account', ...f });
 expect(result.lookupColumns).toEqual(['name', 'industry']);
 expect(result.lookupFilters?.[0].operator).toBe('eq');
 });
 });

 describe('Calculated Fields', () => {
Expand Down

29 changes: 29 additions & 0 deletions
packages/spec/src/data/field.zod.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -445,6 +445,35 @@ export const FieldSchema = lazySchema(() => z.object({
 /** Optional explicit columns for the detail-page related list (derived from the child object when omitted). */
 relatedListColumns: z.array(z.any()).optional().describe('Explicit columns for the detail-page related list (derived from the child object when omitted)'),

 /**
 * LOOKUP PICKER (forward) config — how THIS lookup/master_detail field's
 * record picker presents and scopes candidate records when the user selects a
 * related record. Read-side mirror is relatedList* (the PARENT's detail-page
 * list of children); these configure the CHILD-side picker that chooses the
 * parent. All optional: the renderer auto-derives a sensible multi-column
 * result from the referenced object's schema when omitted (objectui
 * packages/fields: LookupField / RecordPickerDialog / deriveLookupColumns,
 * which read both these camelCase keys and their snake_case aliases).
 */
 displayField: z.string().optional().describe("Field shown as each candidate's label in the picker/popover (defaults to the referenced object's name/title)."),
 descriptionField: z.string().optional().describe('Secondary field shown under the label in the quick-select popover.'),
 lookupColumns: z.array(z.union([z.string(), z.object({
 field: z.string(),
 label: z.string().optional(),
 width: z.string().optional(),
 type: z.string().optional(),
 })])).optional().describe('Explicit columns for the record-picker table; auto-derived from the referenced object when omitted.'),
 lookupPageSize: z.number().int().positive().optional().describe('Rows per page in the record-picker dialog (default 10).'),
 lookupFilters: z.array(z.object({
 field: z.string(),
 operator: z.enum(['eq', 'ne', 'gt', 'lt', 'gte', 'lte', 'contains', 'in', 'notIn']),
 value: z.any(),
 })).optional().describe('Base filters restricting which records are selectable (e.g. only active). Structured, picker-honoured form of referenceFilters.'),
 dependsOn: z.array(z.union([z.string(), z.object({
 field: z.string(),
 param: z.string().optional(),
 })])).optional().describe('Dependent lookup: restrict candidates by the value of other field(s) on the same record. String = same local/remote key; {field,param} when the remote filter key differs.'),

 /** Calculation — CEL formula. Plain string accepted for back-compat; build emits canonical envelope. */
 expression: ExpressionInputSchema.optional().describe('Formula expression (CEL). e.g. F`record.amount * 0.1`'),
 summaryOperations: z.object({
Expand Down
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
feat(spec,showcase): lookup record-picker authoring metadata + demo#2125

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

xuyushun441-sys
merged 2 commits into

from

Jun 21, 2026
 Merged


feat(spec,showcase): lookup record-picker authoring metadata + demo
#2125
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
6334f4c

feat(spec,showcase): lookup record-picker authoring metadata + demo


os-zhuang Jun 21, 2026
d7d57ff

chore(spec): classify new lookup picker props in the liveness ledger


os-zhuang Jun 21, 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


12 changes: 12 additions & 0 deletions
examples/app-showcase/src/data/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,18 @@ const accounts = defineSeed(Account, {
 { name: 'Northwind', industry: 'retail', annual_revenue: 8_000_000, website: 'https://northwind.example', status: 'active', hq: { lat: 47.6062, lng: -122.3321 }, tax_id: '91-1144442', billing_email: 'ap@northwind.example' },
 { name: 'Contoso', industry: 'technology', annual_revenue: 25_000_000, website: 'https://contoso.example', status: 'active', hq: { lat: 37.7749, lng: -122.4194 }, tax_id: '20-3399881', billing_email: 'billing@contoso.example' },
 { name: 'Fabrikam', industry: 'healthcare', annual_revenue: 12_000_000, website: 'https://fabrikam.example', status: 'prospect', hq: { lat: 40.7128, lng: -74.0060 }, tax_id: '46-7782013', billing_email: 'accounts@fabrikam.example' },
 // Extra accounts so the record picker has enough volume to exercise search,
 // sorting, pagination and the (non-churned) scoping filter on invoices.
 { name: 'Initech', industry: 'finance', annual_revenue: 5_400_000, website: 'https://initech.example', status: 'active', hq: { lat: 30.2672, lng: -97.7431 }, tax_id: '74-2233110', billing_email: 'ap@initech.example' },
 { name: 'Globex', industry: 'technology', annual_revenue: 42_000_000, website: 'https://globex.example', status: 'active', hq: { lat: 34.0522, lng: -118.2437 }, tax_id: '95-8841200', billing_email: 'billing@globex.example' },
 { name: 'Stark Industries', industry: 'technology', annual_revenue: 180_000_000, website: 'https://stark.example', status: 'active', hq: { lat: 40.7580, lng: -73.9855 }, tax_id: '13-5567421', billing_email: 'ap@stark.example' },
 { name: 'Wayne Enterprises', industry: 'finance', annual_revenue: 210_000_000, website: 'https://wayne.example', status: 'active', hq: { lat: 40.7128, lng: -74.0060 }, tax_id: '22-9087733', billing_email: 'billing@wayne.example' },
 { name: 'Acme Retail', industry: 'retail', annual_revenue: 3_200_000, website: 'https://acme.example', status: 'prospect', hq: { lat: 41.8781, lng: -87.6298 }, tax_id: '36-4471209', billing_email: 'accounts@acme.example' },
 { name: 'Soylent Foods', industry: 'healthcare', annual_revenue: 9_900_000, website: 'https://soylent.example', status: 'prospect', hq: { lat: 37.3382, lng: -121.8863 }, tax_id: '77-1029384', billing_email: 'ap@soylent.example' },
 { name: 'Hooli', industry: 'technology', annual_revenue: 96_000_000, website: 'https://hooli.example', status: 'active', hq: { lat: 37.3861, lng: -122.0839 }, tax_id: '45-7781230', billing_email: 'billing@hooli.example' },
 { name: 'Vandelay Industries', industry: 'finance', annual_revenue: 6_700_000, website: 'https://vandelay.example', status: 'active', hq: { lat: 40.6782, lng: -73.9442 }, tax_id: '11-3344556', billing_email: 'ap@vandelay.example' },
 { name: 'Umbrella Health', industry: 'healthcare', annual_revenue: 33_000_000, website: 'https://umbrella.example', status: 'churned', hq: { lat: 39.9526, lng: -75.1652 }, tax_id: '88-2200117', churn_reason: 'Switched to in-house platform', billing_email: 'accounts@umbrella.example' },
 { name: 'Wonka Brands', industry: 'retail', annual_revenue: 14_500_000, website: 'https://wonka.example', status: 'churned', hq: { lat: 41.4993, lng: -81.6944 }, tax_id: '52-7741093', churn_reason: 'Budget cuts', billing_email: 'ap@wonka.example' },
 ],
});

Expand Down

17 changes: 16 additions & 1 deletion
examples/app-showcase/src/objects/invoice.object.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,22 @@ export const Invoice = ObjectSchema.create({

 fields: {
 name: Field.text({ label: 'Invoice Number', required: true, searchable: true, maxLength: 60 }),
 account: Field.lookup('showcase_account', { label: 'Account', required: true }),
 // Forward record-picker config (spec lookup* props). The renderer
 // auto-derives columns from the Account schema, but here we curate them and
 // — crucially — SCOPE the picker so a rep can't invoice a churned account.
 // `lookupFilters` is the structured, picker-honoured form of referenceFilters.
 account: Field.lookup('showcase_account', {
 label: 'Account',
 required: true,
 descriptionField: 'industry',
 lookupColumns: [
 'name',
 { field: 'industry', label: 'Industry', type: 'select' },
 { field: 'status', label: 'Lifecycle', type: 'select' },
 { field: 'annual_revenue', label: 'Annual Revenue', type: 'currency' },
 ],
 lookupFilters: [{ field: 'status', operator: 'ne', value: 'churned' }],
 }),
 // Owner email — the row-level-security anchor. The `showcase_contributor`
 // permission set scopes invoice SELECT to `owner = current_user.email` (email
 // is the unique, seedable identifier), so a contributor sees only their own
Expand Down

28 changes: 26 additions & 2 deletions
packages/spec/liveness/field.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -151,9 +151,33 @@
 },
 "referenceFilters": {
 "status": "dead",
 "evidence": "lookup dialog reads lookup_filters (LookupField.tsx:171) — entirely dead as authored (naming drift)",
 "evidence": "lookup dialog reads lookup_filters/lookupFilters (LookupField.tsx) — the string[] referenceFilters form is not read (naming drift)",
 "authorWarn": true,
 "authorHint": "The lookup dialog reads `lookup_filters`, not `referenceFilters` — as authored this filters nothing. Use the supported lookup-filter key, or remove it to avoid implying a constrained lookup."
 "authorHint": "The picker reads the structured `lookupFilters` ({field,operator,value}), not the string[] `referenceFilters` — as authored this filters nothing. Use `lookupFilters`, or remove this to avoid implying a constrained lookup."
 },
 "displayField": {
 "status": "live",
 "note": "objectui LookupField/RecordPickerDialog — candidate label field in the record picker (reads displayField || display_field)."
 },
 "descriptionField": {
 "status": "live",
 "note": "objectui LookupField — secondary line under each option in the quick-select popover (reads descriptionField || description_field)."
 },
 "lookupColumns": {
 "status": "live",
 "note": "objectui RecordPickerDialog — record-picker table columns; renderer auto-derives from the referenced object when omitted (reads lookupColumns || lookup_columns)."
 },
 "lookupPageSize": {
 "status": "live",
 "note": "objectui RecordPickerDialog — rows per page in the record-picker dialog (reads lookupPageSize || lookup_page_size)."
 },
 "lookupFilters": {
 "status": "live",
 "note": "objectui LookupField + RecordPickerDialog — base scoping filters honoured by BOTH popover and dialog; structured supported form of referenceFilters (reads lookupFilters || lookup_filters)."
 },
 "dependsOn": {
 "status": "live",
 "note": "objectui LookupField — dependent/cascading lookup; restricts candidates by another field's value (reads dependsOn || depends_on)."
 },
 "maxRating": {
 "status": "dead",
Expand Down

34 changes: 34 additions & 0 deletions
packages/spec/src/data/field.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -296,6 +296,40 @@ describe('FieldSchema', () => {
 const result = FieldSchema.parse(lookupField);
 expect(result.deleteBehavior).toBe('set_null');
 });

 it('should preserve forward record-picker config (display/columns/filters/depends)', () => {
 const lookupField: Field = {
 name: 'account',
 label: 'Account',
 type: 'lookup',
 reference: 'crm_account',
 displayField: 'name',
 descriptionField: 'industry',
 lookupColumns: ['name', { field: 'annual_revenue', label: 'Revenue', type: 'currency' }],
 lookupPageSize: 20,
 lookupFilters: [{ field: 'status', operator: 'eq', value: 'active' }],
 dependsOn: ['region', { field: 'country', param: 'country_code' }],
 };

 const result = FieldSchema.parse(lookupField);
 expect(result.displayField).toBe('name');
 expect(result.descriptionField).toBe('industry');
 expect(result.lookupColumns).toHaveLength(2);
 expect(result.lookupPageSize).toBe(20);
 expect(result.lookupFilters?.[0]).toEqual({ field: 'status', operator: 'eq', value: 'active' });
 expect(result.dependsOn).toHaveLength(2);
 });

 it('builds a lookup with picker config via Field.lookup', () => {
 const f = Field.lookup('crm_account', {
 label: 'Account',
 lookupColumns: ['name', 'industry'],
 lookupFilters: [{ field: 'status', operator: 'eq', value: 'active' }],
 });
 const result = FieldSchema.parse({ name: 'account', ...f });
 expect(result.lookupColumns).toEqual(['name', 'industry']);
 expect(result.lookupFilters?.[0].operator).toBe('eq');
 });
 });

 describe('Calculated Fields', () => {
Expand Down

29 changes: 29 additions & 0 deletions
packages/spec/src/data/field.zod.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -445,6 +445,35 @@ export const FieldSchema = lazySchema(() => z.object({
 /** Optional explicit columns for the detail-page related list (derived from the child object when omitted). */
 relatedListColumns: z.array(z.any()).optional().describe('Explicit columns for the detail-page related list (derived from the child object when omitted)'),

 /**
 * LOOKUP PICKER (forward) config — how THIS lookup/master_detail field's
 * record picker presents and scopes candidate records when the user selects a
 * related record. Read-side mirror is relatedList* (the PARENT's detail-page
 * list of children); these configure the CHILD-side picker that chooses the
 * parent. All optional: the renderer auto-derives a sensible multi-column
 * result from the referenced object's schema when omitted (objectui
 * packages/fields: LookupField / RecordPickerDialog / deriveLookupColumns,
 * which read both these camelCase keys and their snake_case aliases).
 */
 displayField: z.string().optional().describe("Field shown as each candidate's label in the picker/popover (defaults to the referenced object's name/title)."),
 descriptionField: z.string().optional().describe('Secondary field shown under the label in the quick-select popover.'),
 lookupColumns: z.array(z.union([z.string(), z.object({
 field: z.string(),
 label: z.string().optional(),
 width: z.string().optional(),
 type: z.string().optional(),
 })])).optional().describe('Explicit columns for the record-picker table; auto-derived from the referenced object when omitted.'),
 lookupPageSize: z.number().int().positive().optional().describe('Rows per page in the record-picker dialog (default 10).'),
 lookupFilters: z.array(z.object({
 field: z.string(),
 operator: z.enum(['eq', 'ne', 'gt', 'lt', 'gte', 'lte', 'contains', 'in', 'notIn']),
 value: z.any(),
 })).optional().describe('Base filters restricting which records are selectable (e.g. only active). Structured, picker-honoured form of referenceFilters.'),
 dependsOn: z.array(z.union([z.string(), z.object({
 field: z.string(),
 param: z.string().optional(),
 })])).optional().describe('Dependent lookup: restrict candidates by the value of other field(s) on the same record. String = same local/remote key; {field,param} when the remote filter key differs.'),

 /** Calculation — CEL formula. Plain string accepted for back-compat; build emits canonical envelope. */
 expression: ExpressionInputSchema.optional().describe('Formula expression (CEL). e.g. F`record.amount * 0.1`'),
 summaryOperations: z.object({
Expand Down
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
feat(spec,showcase): lookup record-picker authoring metadata + demo#2125

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

xuyushun441-sys
merged 2 commits into

from

Jun 21, 2026
 Merged


feat(spec,showcase): lookup record-picker authoring metadata + demo
#2125
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
6334f4c

feat(spec,showcase): lookup record-picker authoring metadata + demo


os-zhuang Jun 21, 2026
d7d57ff

chore(spec): classify new lookup picker props in the liveness ledger


os-zhuang Jun 21, 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


12 changes: 12 additions & 0 deletions
examples/app-showcase/src/data/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,18 @@ const accounts = defineSeed(Account, {
 { name: 'Northwind', industry: 'retail', annual_revenue: 8_000_000, website: 'https://northwind.example', status: 'active', hq: { lat: 47.6062, lng: -122.3321 }, tax_id: '91-1144442', billing_email: 'ap@northwind.example' },
 { name: 'Contoso', industry: 'technology', annual_revenue: 25_000_000, website: 'https://contoso.example', status: 'active', hq: { lat: 37.7749, lng: -122.4194 }, tax_id: '20-3399881', billing_email: 'billing@contoso.example' },
 { name: 'Fabrikam', industry: 'healthcare', annual_revenue: 12_000_000, website: 'https://fabrikam.example', status: 'prospect', hq: { lat: 40.7128, lng: -74.0060 }, tax_id: '46-7782013', billing_email: 'accounts@fabrikam.example' },
 // Extra accounts so the record picker has enough volume to exercise search,
 // sorting, pagination and the (non-churned) scoping filter on invoices.
 { name: 'Initech', industry: 'finance', annual_revenue: 5_400_000, website: 'https://initech.example', status: 'active', hq: { lat: 30.2672, lng: -97.7431 }, tax_id: '74-2233110', billing_email: 'ap@initech.example' },
 { name: 'Globex', industry: 'technology', annual_revenue: 42_000_000, website: 'https://globex.example', status: 'active', hq: { lat: 34.0522, lng: -118.2437 }, tax_id: '95-8841200', billing_email: 'billing@globex.example' },
 { name: 'Stark Industries', industry: 'technology', annual_revenue: 180_000_000, website: 'https://stark.example', status: 'active', hq: { lat: 40.7580, lng: -73.9855 }, tax_id: '13-5567421', billing_email: 'ap@stark.example' },
 { name: 'Wayne Enterprises', industry: 'finance', annual_revenue: 210_000_000, website: 'https://wayne.example', status: 'active', hq: { lat: 40.7128, lng: -74.0060 }, tax_id: '22-9087733', billing_email: 'billing@wayne.example' },
 { name: 'Acme Retail', industry: 'retail', annual_revenue: 3_200_000, website: 'https://acme.example', status: 'prospect', hq: { lat: 41.8781, lng: -87.6298 }, tax_id: '36-4471209', billing_email: 'accounts@acme.example' },
 { name: 'Soylent Foods', industry: 'healthcare', annual_revenue: 9_900_000, website: 'https://soylent.example', status: 'prospect', hq: { lat: 37.3382, lng: -121.8863 }, tax_id: '77-1029384', billing_email: 'ap@soylent.example' },
 { name: 'Hooli', industry: 'technology', annual_revenue: 96_000_000, website: 'https://hooli.example', status: 'active', hq: { lat: 37.3861, lng: -122.0839 }, tax_id: '45-7781230', billing_email: 'billing@hooli.example' },
 { name: 'Vandelay Industries', industry: 'finance', annual_revenue: 6_700_000, website: 'https://vandelay.example', status: 'active', hq: { lat: 40.6782, lng: -73.9442 }, tax_id: '11-3344556', billing_email: 'ap@vandelay.example' },
 { name: 'Umbrella Health', industry: 'healthcare', annual_revenue: 33_000_000, website: 'https://umbrella.example', status: 'churned', hq: { lat: 39.9526, lng: -75.1652 }, tax_id: '88-2200117', churn_reason: 'Switched to in-house platform', billing_email: 'accounts@umbrella.example' },
 { name: 'Wonka Brands', industry: 'retail', annual_revenue: 14_500_000, website: 'https://wonka.example', status: 'churned', hq: { lat: 41.4993, lng: -81.6944 }, tax_id: '52-7741093', churn_reason: 'Budget cuts', billing_email: 'ap@wonka.example' },
 ],
});

Expand Down

17 changes: 16 additions & 1 deletion
examples/app-showcase/src/objects/invoice.object.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,22 @@ export const Invoice = ObjectSchema.create({

 fields: {
 name: Field.text({ label: 'Invoice Number', required: true, searchable: true, maxLength: 60 }),
 account: Field.lookup('showcase_account', { label: 'Account', required: true }),
 // Forward record-picker config (spec lookup* props). The renderer
 // auto-derives columns from the Account schema, but here we curate them and
 // — crucially — SCOPE the picker so a rep can't invoice a churned account.
 // `lookupFilters` is the structured, picker-honoured form of referenceFilters.
 account: Field.lookup('showcase_account', {
 label: 'Account',
 required: true,
 descriptionField: 'industry',
 lookupColumns: [
 'name',
 { field: 'industry', label: 'Industry', type: 'select' },
 { field: 'status', label: 'Lifecycle', type: 'select' },
 { field: 'annual_revenue', label: 'Annual Revenue', type: 'currency' },
 ],
 lookupFilters: [{ field: 'status', operator: 'ne', value: 'churned' }],
 }),
 // Owner email — the row-level-security anchor. The `showcase_contributor`
 // permission set scopes invoice SELECT to `owner = current_user.email` (email
 // is the unique, seedable identifier), so a contributor sees only their own
Expand Down

28 changes: 26 additions & 2 deletions
packages/spec/liveness/field.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -151,9 +151,33 @@
 },
 "referenceFilters": {
 "status": "dead",
 "evidence": "lookup dialog reads lookup_filters (LookupField.tsx:171) — entirely dead as authored (naming drift)",
 "evidence": "lookup dialog reads lookup_filters/lookupFilters (LookupField.tsx) — the string[] referenceFilters form is not read (naming drift)",
 "authorWarn": true,
 "authorHint": "The lookup dialog reads `lookup_filters`, not `referenceFilters` — as authored this filters nothing. Use the supported lookup-filter key, or remove it to avoid implying a constrained lookup."
 "authorHint": "The picker reads the structured `lookupFilters` ({field,operator,value}), not the string[] `referenceFilters` — as authored this filters nothing. Use `lookupFilters`, or remove this to avoid implying a constrained lookup."
 },
 "displayField": {
 "status": "live",
 "note": "objectui LookupField/RecordPickerDialog — candidate label field in the record picker (reads displayField || display_field)."
 },
 "descriptionField": {
 "status": "live",
 "note": "objectui LookupField — secondary line under each option in the quick-select popover (reads descriptionField || description_field)."
 },
 "lookupColumns": {
 "status": "live",
 "note": "objectui RecordPickerDialog — record-picker table columns; renderer auto-derives from the referenced object when omitted (reads lookupColumns || lookup_columns)."
 },
 "lookupPageSize": {
 "status": "live",
 "note": "objectui RecordPickerDialog — rows per page in the record-picker dialog (reads lookupPageSize || lookup_page_size)."
 },
 "lookupFilters": {
 "status": "live",
 "note": "objectui LookupField + RecordPickerDialog — base scoping filters honoured by BOTH popover and dialog; structured supported form of referenceFilters (reads lookupFilters || lookup_filters)."
 },
 "dependsOn": {
 "status": "live",
 "note": "objectui LookupField — dependent/cascading lookup; restricts candidates by another field's value (reads dependsOn || depends_on)."
 },
 "maxRating": {
 "status": "dead",
Expand Down

34 changes: 34 additions & 0 deletions
packages/spec/src/data/field.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -296,6 +296,40 @@ describe('FieldSchema', () => {
 const result = FieldSchema.parse(lookupField);
 expect(result.deleteBehavior).toBe('set_null');
 });

 it('should preserve forward record-picker config (display/columns/filters/depends)', () => {
 const lookupField: Field = {
 name: 'account',
 label: 'Account',
 type: 'lookup',
 reference: 'crm_account',
 displayField: 'name',
 descriptionField: 'industry',
 lookupColumns: ['name', { field: 'annual_revenue', label: 'Revenue', type: 'currency' }],
 lookupPageSize: 20,
 lookupFilters: [{ field: 'status', operator: 'eq', value: 'active' }],
 dependsOn: ['region', { field: 'country', param: 'country_code' }],
 };

 const result = FieldSchema.parse(lookupField);
 expect(result.displayField).toBe('name');
 expect(result.descriptionField).toBe('industry');
 expect(result.lookupColumns).toHaveLength(2);
 expect(result.lookupPageSize).toBe(20);
 expect(result.lookupFilters?.[0]).toEqual({ field: 'status', operator: 'eq', value: 'active' });
 expect(result.dependsOn).toHaveLength(2);
 });

 it('builds a lookup with picker config via Field.lookup', () => {
 const f = Field.lookup('crm_account', {
 label: 'Account',
 lookupColumns: ['name', 'industry'],
 lookupFilters: [{ field: 'status', operator: 'eq', value: 'active' }],
 });
 const result = FieldSchema.parse({ name: 'account', ...f });
 expect(result.lookupColumns).toEqual(['name', 'industry']);
 expect(result.lookupFilters?.[0].operator).toBe('eq');
 });
 });

 describe('Calculated Fields', () => {
Expand Down

29 changes: 29 additions & 0 deletions
packages/spec/src/data/field.zod.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -445,6 +445,35 @@ export const FieldSchema = lazySchema(() => z.object({
 /** Optional explicit columns for the detail-page related list (derived from the child object when omitted). */
 relatedListColumns: z.array(z.any()).optional().describe('Explicit columns for the detail-page related list (derived from the child object when omitted)'),

 /**
 * LOOKUP PICKER (forward) config — how THIS lookup/master_detail field's
 * record picker presents and scopes candidate records when the user selects a
 * related record. Read-side mirror is relatedList* (the PARENT's detail-page
 * list of children); these configure the CHILD-side picker that chooses the
 * parent. All optional: the renderer auto-derives a sensible multi-column
 * result from the referenced object's schema when omitted (objectui
 * packages/fields: LookupField / RecordPickerDialog / deriveLookupColumns,
 * which read both these camelCase keys and their snake_case aliases).
 */
 displayField: z.string().optional().describe("Field shown as each candidate's label in the picker/popover (defaults to the referenced object's name/title)."),
 descriptionField: z.string().optional().describe('Secondary field shown under the label in the quick-select popover.'),
 lookupColumns: z.array(z.union([z.string(), z.object({
 field: z.string(),
 label: z.string().optional(),
 width: z.string().optional(),
 type: z.string().optional(),
 })])).optional().describe('Explicit columns for the record-picker table; auto-derived from the referenced object when omitted.'),
 lookupPageSize: z.number().int().positive().optional().describe('Rows per page in the record-picker dialog (default 10).'),
 lookupFilters: z.array(z.object({
 field: z.string(),
 operator: z.enum(['eq', 'ne', 'gt', 'lt', 'gte', 'lte', 'contains', 'in', 'notIn']),
 value: z.any(),
 })).optional().describe('Base filters restricting which records are selectable (e.g. only active). Structured, picker-honoured form of referenceFilters.'),
 dependsOn: z.array(z.union([z.string(), z.object({
 field: z.string(),
 param: z.string().optional(),
 })])).optional().describe('Dependent lookup: restrict candidates by the value of other field(s) on the same record. String = same local/remote key; {field,param} when the remote filter key differs.'),

 /** Calculation — CEL formula. Plain string accepted for back-compat; build emits canonical envelope. */
 expression: ExpressionInputSchema.optional().describe('Formula expression (CEL). e.g. F`record.amount * 0.1`'),
 summaryOperations: z.object({
Expand Down
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
feat(spec,showcase): lookup record-picker authoring metadata + demo#2125

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

xuyushun441-sys
merged 2 commits into

from

Jun 21, 2026
 Merged


feat(spec,showcase): lookup record-picker authoring metadata + demo
#2125
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
6334f4c

feat(spec,showcase): lookup record-picker authoring metadata + demo


os-zhuang Jun 21, 2026
d7d57ff

chore(spec): classify new lookup picker props in the liveness ledger


os-zhuang Jun 21, 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


12 changes: 12 additions & 0 deletions
examples/app-showcase/src/data/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,18 @@ const accounts = defineSeed(Account, {
 { name: 'Northwind', industry: 'retail', annual_revenue: 8_000_000, website: 'https://northwind.example', status: 'active', hq: { lat: 47.6062, lng: -122.3321 }, tax_id: '91-1144442', billing_email: 'ap@northwind.example' },
 { name: 'Contoso', industry: 'technology', annual_revenue: 25_000_000, website: 'https://contoso.example', status: 'active', hq: { lat: 37.7749, lng: -122.4194 }, tax_id: '20-3399881', billing_email: 'billing@contoso.example' },
 { name: 'Fabrikam', industry: 'healthcare', annual_revenue: 12_000_000, website: 'https://fabrikam.example', status: 'prospect', hq: { lat: 40.7128, lng: -74.0060 }, tax_id: '46-7782013', billing_email: 'accounts@fabrikam.example' },
 // Extra accounts so the record picker has enough volume to exercise search,
 // sorting, pagination and the (non-churned) scoping filter on invoices.
 { name: 'Initech', industry: 'finance', annual_revenue: 5_400_000, website: 'https://initech.example', status: 'active', hq: { lat: 30.2672, lng: -97.7431 }, tax_id: '74-2233110', billing_email: 'ap@initech.example' },
 { name: 'Globex', industry: 'technology', annual_revenue: 42_000_000, website: 'https://globex.example', status: 'active', hq: { lat: 34.0522, lng: -118.2437 }, tax_id: '95-8841200', billing_email: 'billing@globex.example' },
 { name: 'Stark Industries', industry: 'technology', annual_revenue: 180_000_000, website: 'https://stark.example', status: 'active', hq: { lat: 40.7580, lng: -73.9855 }, tax_id: '13-5567421', billing_email: 'ap@stark.example' },
 { name: 'Wayne Enterprises', industry: 'finance', annual_revenue: 210_000_000, website: 'https://wayne.example', status: 'active', hq: { lat: 40.7128, lng: -74.0060 }, tax_id: '22-9087733', billing_email: 'billing@wayne.example' },
 { name: 'Acme Retail', industry: 'retail', annual_revenue: 3_200_000, website: 'https://acme.example', status: 'prospect', hq: { lat: 41.8781, lng: -87.6298 }, tax_id: '36-4471209', billing_email: 'accounts@acme.example' },
 { name: 'Soylent Foods', industry: 'healthcare', annual_revenue: 9_900_000, website: 'https://soylent.example', status: 'prospect', hq: { lat: 37.3382, lng: -121.8863 }, tax_id: '77-1029384', billing_email: 'ap@soylent.example' },
 { name: 'Hooli', industry: 'technology', annual_revenue: 96_000_000, website: 'https://hooli.example', status: 'active', hq: { lat: 37.3861, lng: -122.0839 }, tax_id: '45-7781230', billing_email: 'billing@hooli.example' },
 { name: 'Vandelay Industries', industry: 'finance', annual_revenue: 6_700_000, website: 'https://vandelay.example', status: 'active', hq: { lat: 40.6782, lng: -73.9442 }, tax_id: '11-3344556', billing_email: 'ap@vandelay.example' },
 { name: 'Umbrella Health', industry: 'healthcare', annual_revenue: 33_000_000, website: 'https://umbrella.example', status: 'churned', hq: { lat: 39.9526, lng: -75.1652 }, tax_id: '88-2200117', churn_reason: 'Switched to in-house platform', billing_email: 'accounts@umbrella.example' },
 { name: 'Wonka Brands', industry: 'retail', annual_revenue: 14_500_000, website: 'https://wonka.example', status: 'churned', hq: { lat: 41.4993, lng: -81.6944 }, tax_id: '52-7741093', churn_reason: 'Budget cuts', billing_email: 'ap@wonka.example' },
 ],
});

Expand Down

17 changes: 16 additions & 1 deletion
examples/app-showcase/src/objects/invoice.object.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,22 @@ export const Invoice = ObjectSchema.create({

 fields: {
 name: Field.text({ label: 'Invoice Number', required: true, searchable: true, maxLength: 60 }),
 account: Field.lookup('showcase_account', { label: 'Account', required: true }),
 // Forward record-picker config (spec lookup* props). The renderer
 // auto-derives columns from the Account schema, but here we curate them and
 // — crucially — SCOPE the picker so a rep can't invoice a churned account.
 // `lookupFilters` is the structured, picker-honoured form of referenceFilters.
 account: Field.lookup('showcase_account', {
 label: 'Account',
 required: true,
 descriptionField: 'industry',
 lookupColumns: [
 'name',
 { field: 'industry', label: 'Industry', type: 'select' },
 { field: 'status', label: 'Lifecycle', type: 'select' },
 { field: 'annual_revenue', label: 'Annual Revenue', type: 'currency' },
 ],
 lookupFilters: [{ field: 'status', operator: 'ne', value: 'churned' }],
 }),
 // Owner email — the row-level-security anchor. The `showcase_contributor`
 // permission set scopes invoice SELECT to `owner = current_user.email` (email
 // is the unique, seedable identifier), so a contributor sees only their own
Expand Down

28 changes: 26 additions & 2 deletions
packages/spec/liveness/field.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -151,9 +151,33 @@
 },
 "referenceFilters": {
 "status": "dead",
 "evidence": "lookup dialog reads lookup_filters (LookupField.tsx:171) — entirely dead as authored (naming drift)",
 "evidence": "lookup dialog reads lookup_filters/lookupFilters (LookupField.tsx) — the string[] referenceFilters form is not read (naming drift)",
 "authorWarn": true,
 "authorHint": "The lookup dialog reads `lookup_filters`, not `referenceFilters` — as authored this filters nothing. Use the supported lookup-filter key, or remove it to avoid implying a constrained lookup."
 "authorHint": "The picker reads the structured `lookupFilters` ({field,operator,value}), not the string[] `referenceFilters` — as authored this filters nothing. Use `lookupFilters`, or remove this to avoid implying a constrained lookup."
 },
 "displayField": {
 "status": "live",
 "note": "objectui LookupField/RecordPickerDialog — candidate label field in the record picker (reads displayField || display_field)."
 },
 "descriptionField": {
 "status": "live",
 "note": "objectui LookupField — secondary line under each option in the quick-select popover (reads descriptionField || description_field)."
 },
 "lookupColumns": {
 "status": "live",
 "note": "objectui RecordPickerDialog — record-picker table columns; renderer auto-derives from the referenced object when omitted (reads lookupColumns || lookup_columns)."
 },
 "lookupPageSize": {
 "status": "live",
 "note": "objectui RecordPickerDialog — rows per page in the record-picker dialog (reads lookupPageSize || lookup_page_size)."
 },
 "lookupFilters": {
 "status": "live",
 "note": "objectui LookupField + RecordPickerDialog — base scoping filters honoured by BOTH popover and dialog; structured supported form of referenceFilters (reads lookupFilters || lookup_filters)."
 },
 "dependsOn": {
 "status": "live",
 "note": "objectui LookupField — dependent/cascading lookup; restricts candidates by another field's value (reads dependsOn || depends_on)."
 },
 "maxRating": {
 "status": "dead",
Expand Down

34 changes: 34 additions & 0 deletions
packages/spec/src/data/field.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -296,6 +296,40 @@ describe('FieldSchema', () => {
 const result = FieldSchema.parse(lookupField);
 expect(result.deleteBehavior).toBe('set_null');
 });

 it('should preserve forward record-picker config (display/columns/filters/depends)', () => {
 const lookupField: Field = {
 name: 'account',
 label: 'Account',
 type: 'lookup',
 reference: 'crm_account',
 displayField: 'name',
 descriptionField: 'industry',
 lookupColumns: ['name', { field: 'annual_revenue', label: 'Revenue', type: 'currency' }],
 lookupPageSize: 20,
 lookupFilters: [{ field: 'status', operator: 'eq', value: 'active' }],
 dependsOn: ['region', { field: 'country', param: 'country_code' }],
 };

 const result = FieldSchema.parse(lookupField);
 expect(result.displayField).toBe('name');
 expect(result.descriptionField).toBe('industry');
 expect(result.lookupColumns).toHaveLength(2);
 expect(result.lookupPageSize).toBe(20);
 expect(result.lookupFilters?.[0]).toEqual({ field: 'status', operator: 'eq', value: 'active' });
 expect(result.dependsOn).toHaveLength(2);
 });

 it('builds a lookup with picker config via Field.lookup', () => {
 const f = Field.lookup('crm_account', {
 label: 'Account',
 lookupColumns: ['name', 'industry'],
 lookupFilters: [{ field: 'status', operator: 'eq', value: 'active' }],
 });
 const result = FieldSchema.parse({ name: 'account', ...f });
 expect(result.lookupColumns).toEqual(['name', 'industry']);
 expect(result.lookupFilters?.[0].operator).toBe('eq');
 });
 });

 describe('Calculated Fields', () => {
Expand Down

29 changes: 29 additions & 0 deletions
packages/spec/src/data/field.zod.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -445,6 +445,35 @@ export const FieldSchema = lazySchema(() => z.object({
 /** Optional explicit columns for the detail-page related list (derived from the child object when omitted). */
 relatedListColumns: z.array(z.any()).optional().describe('Explicit columns for the detail-page related list (derived from the child object when omitted)'),

 /**
 * LOOKUP PICKER (forward) config — how THIS lookup/master_detail field's
 * record picker presents and scopes candidate records when the user selects a
 * related record. Read-side mirror is relatedList* (the PARENT's detail-page
 * list of children); these configure the CHILD-side picker that chooses the
 * parent. All optional: the renderer auto-derives a sensible multi-column
 * result from the referenced object's schema when omitted (objectui
 * packages/fields: LookupField / RecordPickerDialog / deriveLookupColumns,
 * which read both these camelCase keys and their snake_case aliases).
 */
 displayField: z.string().optional().describe("Field shown as each candidate's label in the picker/popover (defaults to the referenced object's name/title)."),
 descriptionField: z.string().optional().describe('Secondary field shown under the label in the quick-select popover.'),
 lookupColumns: z.array(z.union([z.string(), z.object({
 field: z.string(),
 label: z.string().optional(),
 width: z.string().optional(),
 type: z.string().optional(),
 })])).optional().describe('Explicit columns for the record-picker table; auto-derived from the referenced object when omitted.'),
 lookupPageSize: z.number().int().positive().optional().describe('Rows per page in the record-picker dialog (default 10).'),
 lookupFilters: z.array(z.object({
 field: z.string(),
 operator: z.enum(['eq', 'ne', 'gt', 'lt', 'gte', 'lte', 'contains', 'in', 'notIn']),
 value: z.any(),
 })).optional().describe('Base filters restricting which records are selectable (e.g. only active). Structured, picker-honoured form of referenceFilters.'),
 dependsOn: z.array(z.union([z.string(), z.object({
 field: z.string(),
 param: z.string().optional(),
 })])).optional().describe('Dependent lookup: restrict candidates by the value of other field(s) on the same record. String = same local/remote key; {field,param} when the remote filter key differs.'),

 /** Calculation — CEL formula. Plain string accepted for back-compat; build emits canonical envelope. */
 expression: ExpressionInputSchema.optional().describe('Formula expression (CEL). e.g. F`record.amount * 0.1`'),
 summaryOperations: z.object({
Expand Down
Loading