Spaces:
Running
Running
File size: 5,599 Bytes
aa89cb5 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 | <!-- ephemeral -->
# TypeScript Assist — Query `Order Status`
Use the exact generated `Q.orderStatusesWithMinimalFields()`
entry point. Trusted runtime and policy state comes only from `UserContext`.
```typescript
import { Q } from './Q';
import { OrderStatus } from './models/OrderStatus';
import { SmartList, UserContext } from '../teaql-ts';
export async function queryOrderStatusById(
context: UserContext,
entityId: string,
): Promise<SmartList<OrderStatus>> {
return Q.orderStatusesWithMinimalFields()
.withIdIs(entityId)
.orderByIdAscending()
.limit(20)
.comment('what: load the requested Order Status row')
.purpose('why: serve the authorized Order Status view')
.executeForList(context);
}
```
Compile and execute this source unchanged. Use only generated projection,
predicate, ordering, and relation-selection APIs. Missing or blank intent,
unknown fields, unbounded reads, and trusted-context inputs must fail. Use generated
relation loading rather than handwritten child-query loops; never guess a plural.
## Field-specific Query Assist
Use the canonical KSML field name from this list. Do not substitute a language member name, JSON name, or database column.
| KSML field | Type | Field help |
| --- | --- | --- |
| `platform` | `relation<platform>` | `typescript-assist-query/order_status.platform` |
| `id` | `id` | `typescript-assist-query/order_status.id` |
| `name` | `string` | `typescript-assist-query/order_status.name` |
| `code` | `string` | `typescript-assist-query/order_status.code` |
| `color` | `string` | `typescript-assist-query/order_status.color` |
| `display_order` | `integer` | `typescript-assist-query/order_status.display_order` |
| `version` | `version` | `typescript-assist-query/order_status.version` |
Generated reverse relations are derived from referencing KSML fields. Use their exact generated location for relation selection and access:
| Generated reverse relation | Child entity | Field help |
| --- | --- | --- |
| `customer_order_list` | `customer_order` | `typescript-assist-query/order_status.customer_order_list` |
---
## TeaQL seven-language assist contract
Apply the verified Rust semantic ceiling while using only the exact TYPESCRIPT generated and
runtime APIs. Discover APIs through the generated application AGENTS.md and progressive
model-aware Assist. Do not inspect generated domain-library source.
- Do not create plurals by appending `s` or `es`; use the centralized generated plural.
- Human and non-human entities use different generated predicate vocabularies. Preserve
forms such as “who are active” and “whose email is”; never infer them from English.
- Configure filters, projection, paging, and other query options before `purpose(...)`.
Comment may appear anywhere in the chain. Purpose enters the executable stage; execution
requires both values, but comment does not have to immediately precede purpose.
- Every execute/list/stream and every save accepts exactly one context argument:
`UserContext`. Name that argument `context`, never `runtime`; data services and global
policy are injected when the context is built. Reserve `runtime` for process-level
runtime ownership, provider/pool setup, and module assembly.
- Tenant, merchant, identity, permissions, request policy, purpose policy, hard limit,
and continuous-page cursor policy come only from trusted context, never dynamic JSON or TFP.
- If the required operation is absent after current entity/action and required field
Assist, stop that path and report MISSING_ASSIST. Do not guess an API or search the
generated library as a fallback.
- Create each application-owned source file once. After its first compile attempt,
repair only the smallest block identified by the exact compiler or test diagnostic.
Preserve unrelated code; do not rewrite the complete file as an error-recovery loop.
- Before a repair that would replace more than 25% of an existing application file,
stop and report LARGE_REWRITE_REQUEST with the file, exact diagnostic, reason, and
estimated scope. Initial creation and model-driven regeneration are not repairs.
Capability: `query`.
- Use generated projection, relation, predicate, sort, and aggregate APIs; never
concatenate application SQL or silently ignore an unsupported filter.
- Rows, record count, facets, and aggregates must share the same active filter.
- Add negative tests for missing purpose/comment and forbidden dynamic fields.
### Optional per-parent Top-N optimization
- Configure `topNProbeParentThreshold(threshold)` on the nested child request before its intent/execution
stage. Use the field-specific relation Assist for the exact generated selector.
- Give the child a per-parent limit and deterministic ordering with an ID tie-breaker;
bound the parent query separately. A single-parent detail query is not batch Top-N.
- Server providers default to a window query (`threshold = 0`). A positive threshold
permits bounded probes only when the already-loaded parent count is at or below it;
above it, use the window plan. SQLite uses its internal AlwaysProbe policy by default.
- Measure before opting in. Do not infer a threshold from table size or execute COUNT
or statistics queries to choose a plan. Keep an index on foreign key + sort + ID.
- Inspect selected-plan, parent-count, per-parent-limit and probe-count telemetry.
Runtime-managed probes are not application-owned N+1 loops; neither strategy changes
authorization, loaded-state semantics or the required comment/purpose.
|